Linux Audio

Check our new training course

Loading...
Note: File does not exist in v5.4.
  1/******************************************************************************
  2 *
  3 * This file is provided under a dual BSD/GPLv2 license.  When using or
  4 * redistributing this file, you may do so under either license.
  5 *
  6 * GPL LICENSE SUMMARY
  7 *
  8 * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
  9 *
 10 * This program is free software; you can redistribute it and/or modify
 11 * it under the terms of version 2 of the GNU General Public License as
 12 * published by the Free Software Foundation.
 13 *
 14 * This program is distributed in the hope that it will be useful, but
 15 * WITHOUT ANY WARRANTY; without even the implied warranty of
 16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 17 * General Public License for more details.
 18 *
 19 * You should have received a copy of the GNU General Public License
 20 * along with this program; if not, write to the Free Software
 21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110,
 22 * USA
 23 *
 24 * The full GNU General Public License is included in this distribution
 25 * in the file called LICENSE.GPL.
 26 *
 27 * Contact Information:
 28 *  Intel Linux Wireless <ilw@linux.intel.com>
 29 * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
 30 *
 31 * BSD LICENSE
 32 *
 33 * Copyright(c) 2005 - 2011 Intel Corporation. All rights reserved.
 34 * All rights reserved.
 35 *
 36 * Redistribution and use in source and binary forms, with or without
 37 * modification, are permitted provided that the following conditions
 38 * are met:
 39 *
 40 *  * Redistributions of source code must retain the above copyright
 41 *    notice, this list of conditions and the following disclaimer.
 42 *  * Redistributions in binary form must reproduce the above copyright
 43 *    notice, this list of conditions and the following disclaimer in
 44 *    the documentation and/or other materials provided with the
 45 *    distribution.
 46 *  * Neither the name Intel Corporation nor the names of its
 47 *    contributors may be used to endorse or promote products derived
 48 *    from this software without specific prior written permission.
 49 *
 50 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 51 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 52 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 53 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 54 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 55 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 56 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 57 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 58 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 59 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 60 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 61 *****************************************************************************/
 62
 63
 64#include <linux/kernel.h>
 65#include <linux/module.h>
 66#include <linux/slab.h>
 67#include <linux/init.h>
 68
 69#include <net/mac80211.h>
 70
 71#include "iwl-commands.h"
 72#include "iwl-dev.h"
 73#include "iwl-core.h"
 74#include "iwl-debug.h"
 75#include "iwl-eeprom.h"
 76#include "iwl-io.h"
 77
 78/************************** EEPROM BANDS ****************************
 79 *
 80 * The iwlegacy_eeprom_band definitions below provide the mapping from the
 81 * EEPROM contents to the specific channel number supported for each
 82 * band.
 83 *
 84 * For example, iwl_priv->eeprom.band_3_channels[4] from the band_3
 85 * definition below maps to physical channel 42 in the 5.2GHz spectrum.
 86 * The specific geography and calibration information for that channel
 87 * is contained in the eeprom map itself.
 88 *
 89 * During init, we copy the eeprom information and channel map
 90 * information into priv->channel_info_24/52 and priv->channel_map_24/52
 91 *
 92 * channel_map_24/52 provides the index in the channel_info array for a
 93 * given channel.  We have to have two separate maps as there is channel
 94 * overlap with the 2.4GHz and 5.2GHz spectrum as seen in band_1 and
 95 * band_2
 96 *
 97 * A value of 0xff stored in the channel_map indicates that the channel
 98 * is not supported by the hardware at all.
 99 *
100 * A value of 0xfe in the channel_map indicates that the channel is not
101 * valid for Tx with the current hardware.  This means that
102 * while the system can tune and receive on a given channel, it may not
103 * be able to associate or transmit any frames on that
104 * channel.  There is no corresponding channel information for that
105 * entry.
106 *
107 *********************************************************************/
108
109/* 2.4 GHz */
110const u8 iwlegacy_eeprom_band_1[14] = {
111	1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14
112};
113
114/* 5.2 GHz bands */
115static const u8 iwlegacy_eeprom_band_2[] = {	/* 4915-5080MHz */
116	183, 184, 185, 187, 188, 189, 192, 196, 7, 8, 11, 12, 16
117};
118
119static const u8 iwlegacy_eeprom_band_3[] = {	/* 5170-5320MHz */
120	34, 36, 38, 40, 42, 44, 46, 48, 52, 56, 60, 64
121};
122
123static const u8 iwlegacy_eeprom_band_4[] = {	/* 5500-5700MHz */
124	100, 104, 108, 112, 116, 120, 124, 128, 132, 136, 140
125};
126
127static const u8 iwlegacy_eeprom_band_5[] = {	/* 5725-5825MHz */
128	145, 149, 153, 157, 161, 165
129};
130
131static const u8 iwlegacy_eeprom_band_6[] = {       /* 2.4 ht40 channel */
132	1, 2, 3, 4, 5, 6, 7
133};
134
135static const u8 iwlegacy_eeprom_band_7[] = {       /* 5.2 ht40 channel */
136	36, 44, 52, 60, 100, 108, 116, 124, 132, 149, 157
137};
138
139/******************************************************************************
140 *
141 * EEPROM related functions
142 *
143******************************************************************************/
144
145static int iwl_legacy_eeprom_verify_signature(struct iwl_priv *priv)
146{
147	u32 gp = iwl_read32(priv, CSR_EEPROM_GP) & CSR_EEPROM_GP_VALID_MSK;
148	int ret = 0;
149
150	IWL_DEBUG_EEPROM(priv, "EEPROM signature=0x%08x\n", gp);
151	switch (gp) {
152	case CSR_EEPROM_GP_GOOD_SIG_EEP_LESS_THAN_4K:
153	case CSR_EEPROM_GP_GOOD_SIG_EEP_MORE_THAN_4K:
154		break;
155	default:
156		IWL_ERR(priv, "bad EEPROM signature,"
157			"EEPROM_GP=0x%08x\n", gp);
158		ret = -ENOENT;
159		break;
160	}
161	return ret;
162}
163
164const u8
165*iwl_legacy_eeprom_query_addr(const struct iwl_priv *priv, size_t offset)
166{
167	BUG_ON(offset >= priv->cfg->base_params->eeprom_size);
168	return &priv->eeprom[offset];
169}
170EXPORT_SYMBOL(iwl_legacy_eeprom_query_addr);
171
172u16 iwl_legacy_eeprom_query16(const struct iwl_priv *priv, size_t offset)
173{
174	if (!priv->eeprom)
175		return 0;
176	return (u16)priv->eeprom[offset] | ((u16)priv->eeprom[offset + 1] << 8);
177}
178EXPORT_SYMBOL(iwl_legacy_eeprom_query16);
179
180/**
181 * iwl_legacy_eeprom_init - read EEPROM contents
182 *
183 * Load the EEPROM contents from adapter into priv->eeprom
184 *
185 * NOTE:  This routine uses the non-debug IO access functions.
186 */
187int iwl_legacy_eeprom_init(struct iwl_priv *priv)
188{
189	__le16 *e;
190	u32 gp = iwl_read32(priv, CSR_EEPROM_GP);
191	int sz;
192	int ret;
193	u16 addr;
194
195	/* allocate eeprom */
196	sz = priv->cfg->base_params->eeprom_size;
197	IWL_DEBUG_EEPROM(priv, "NVM size = %d\n", sz);
198	priv->eeprom = kzalloc(sz, GFP_KERNEL);
199	if (!priv->eeprom) {
200		ret = -ENOMEM;
201		goto alloc_err;
202	}
203	e = (__le16 *)priv->eeprom;
204
205	priv->cfg->ops->lib->apm_ops.init(priv);
206
207	ret = iwl_legacy_eeprom_verify_signature(priv);
208	if (ret < 0) {
209		IWL_ERR(priv, "EEPROM not found, EEPROM_GP=0x%08x\n", gp);
210		ret = -ENOENT;
211		goto err;
212	}
213
214	/* Make sure driver (instead of uCode) is allowed to read EEPROM */
215	ret = priv->cfg->ops->lib->eeprom_ops.acquire_semaphore(priv);
216	if (ret < 0) {
217		IWL_ERR(priv, "Failed to acquire EEPROM semaphore.\n");
218		ret = -ENOENT;
219		goto err;
220	}
221
222	/* eeprom is an array of 16bit values */
223	for (addr = 0; addr < sz; addr += sizeof(u16)) {
224		u32 r;
225
226		_iwl_legacy_write32(priv, CSR_EEPROM_REG,
227			     CSR_EEPROM_REG_MSK_ADDR & (addr << 1));
228
229		ret = iwl_poll_bit(priv, CSR_EEPROM_REG,
230					  CSR_EEPROM_REG_READ_VALID_MSK,
231					  CSR_EEPROM_REG_READ_VALID_MSK,
232					  IWL_EEPROM_ACCESS_TIMEOUT);
233		if (ret < 0) {
234			IWL_ERR(priv, "Time out reading EEPROM[%d]\n",
235							addr);
236			goto done;
237		}
238		r = _iwl_legacy_read_direct32(priv, CSR_EEPROM_REG);
239		e[addr / 2] = cpu_to_le16(r >> 16);
240	}
241
242	IWL_DEBUG_EEPROM(priv, "NVM Type: %s, version: 0x%x\n",
243		       "EEPROM",
244		       iwl_legacy_eeprom_query16(priv, EEPROM_VERSION));
245
246	ret = 0;
247done:
248	priv->cfg->ops->lib->eeprom_ops.release_semaphore(priv);
249
250err:
251	if (ret)
252		iwl_legacy_eeprom_free(priv);
253	/* Reset chip to save power until we load uCode during "up". */
254	iwl_legacy_apm_stop(priv);
255alloc_err:
256	return ret;
257}
258EXPORT_SYMBOL(iwl_legacy_eeprom_init);
259
260void iwl_legacy_eeprom_free(struct iwl_priv *priv)
261{
262	kfree(priv->eeprom);
263	priv->eeprom = NULL;
264}
265EXPORT_SYMBOL(iwl_legacy_eeprom_free);
266
267static void iwl_legacy_init_band_reference(const struct iwl_priv *priv,
268			int eep_band, int *eeprom_ch_count,
269			const struct iwl_eeprom_channel **eeprom_ch_info,
270			const u8 **eeprom_ch_index)
271{
272	u32 offset = priv->cfg->ops->lib->
273			eeprom_ops.regulatory_bands[eep_band - 1];
274	switch (eep_band) {
275	case 1:		/* 2.4GHz band */
276		*eeprom_ch_count = ARRAY_SIZE(iwlegacy_eeprom_band_1);
277		*eeprom_ch_info = (struct iwl_eeprom_channel *)
278				iwl_legacy_eeprom_query_addr(priv, offset);
279		*eeprom_ch_index = iwlegacy_eeprom_band_1;
280		break;
281	case 2:		/* 4.9GHz band */
282		*eeprom_ch_count = ARRAY_SIZE(iwlegacy_eeprom_band_2);
283		*eeprom_ch_info = (struct iwl_eeprom_channel *)
284				iwl_legacy_eeprom_query_addr(priv, offset);
285		*eeprom_ch_index = iwlegacy_eeprom_band_2;
286		break;
287	case 3:		/* 5.2GHz band */
288		*eeprom_ch_count = ARRAY_SIZE(iwlegacy_eeprom_band_3);
289		*eeprom_ch_info = (struct iwl_eeprom_channel *)
290				iwl_legacy_eeprom_query_addr(priv, offset);
291		*eeprom_ch_index = iwlegacy_eeprom_band_3;
292		break;
293	case 4:		/* 5.5GHz band */
294		*eeprom_ch_count = ARRAY_SIZE(iwlegacy_eeprom_band_4);
295		*eeprom_ch_info = (struct iwl_eeprom_channel *)
296				iwl_legacy_eeprom_query_addr(priv, offset);
297		*eeprom_ch_index = iwlegacy_eeprom_band_4;
298		break;
299	case 5:		/* 5.7GHz band */
300		*eeprom_ch_count = ARRAY_SIZE(iwlegacy_eeprom_band_5);
301		*eeprom_ch_info = (struct iwl_eeprom_channel *)
302				iwl_legacy_eeprom_query_addr(priv, offset);
303		*eeprom_ch_index = iwlegacy_eeprom_band_5;
304		break;
305	case 6:		/* 2.4GHz ht40 channels */
306		*eeprom_ch_count = ARRAY_SIZE(iwlegacy_eeprom_band_6);
307		*eeprom_ch_info = (struct iwl_eeprom_channel *)
308				iwl_legacy_eeprom_query_addr(priv, offset);
309		*eeprom_ch_index = iwlegacy_eeprom_band_6;
310		break;
311	case 7:		/* 5 GHz ht40 channels */
312		*eeprom_ch_count = ARRAY_SIZE(iwlegacy_eeprom_band_7);
313		*eeprom_ch_info = (struct iwl_eeprom_channel *)
314				iwl_legacy_eeprom_query_addr(priv, offset);
315		*eeprom_ch_index = iwlegacy_eeprom_band_7;
316		break;
317	default:
318		BUG();
319	}
320}
321
322#define CHECK_AND_PRINT(x) ((eeprom_ch->flags & EEPROM_CHANNEL_##x) \
323			    ? # x " " : "")
324/**
325 * iwl_legacy_mod_ht40_chan_info - Copy ht40 channel info into driver's priv.
326 *
327 * Does not set up a command, or touch hardware.
328 */
329static int iwl_legacy_mod_ht40_chan_info(struct iwl_priv *priv,
330			      enum ieee80211_band band, u16 channel,
331			      const struct iwl_eeprom_channel *eeprom_ch,
332			      u8 clear_ht40_extension_channel)
333{
334	struct iwl_channel_info *ch_info;
335
336	ch_info = (struct iwl_channel_info *)
337			iwl_legacy_get_channel_info(priv, band, channel);
338
339	if (!iwl_legacy_is_channel_valid(ch_info))
340		return -1;
341
342	IWL_DEBUG_EEPROM(priv, "HT40 Ch. %d [%sGHz] %s%s%s%s%s(0x%02x %ddBm):"
343			" Ad-Hoc %ssupported\n",
344			ch_info->channel,
345			iwl_legacy_is_channel_a_band(ch_info) ?
346			"5.2" : "2.4",
347			CHECK_AND_PRINT(IBSS),
348			CHECK_AND_PRINT(ACTIVE),
349			CHECK_AND_PRINT(RADAR),
350			CHECK_AND_PRINT(WIDE),
351			CHECK_AND_PRINT(DFS),
352			eeprom_ch->flags,
353			eeprom_ch->max_power_avg,
354			((eeprom_ch->flags & EEPROM_CHANNEL_IBSS)
355			 && !(eeprom_ch->flags & EEPROM_CHANNEL_RADAR)) ?
356			"" : "not ");
357
358	ch_info->ht40_eeprom = *eeprom_ch;
359	ch_info->ht40_max_power_avg = eeprom_ch->max_power_avg;
360	ch_info->ht40_flags = eeprom_ch->flags;
361	if (eeprom_ch->flags & EEPROM_CHANNEL_VALID)
362		ch_info->ht40_extension_channel &=
363					~clear_ht40_extension_channel;
364
365	return 0;
366}
367
368#define CHECK_AND_PRINT_I(x) ((eeprom_ch_info[ch].flags & EEPROM_CHANNEL_##x) \
369			    ? # x " " : "")
370
371/**
372 * iwl_legacy_init_channel_map - Set up driver's info for all possible channels
373 */
374int iwl_legacy_init_channel_map(struct iwl_priv *priv)
375{
376	int eeprom_ch_count = 0;
377	const u8 *eeprom_ch_index = NULL;
378	const struct iwl_eeprom_channel *eeprom_ch_info = NULL;
379	int band, ch;
380	struct iwl_channel_info *ch_info;
381
382	if (priv->channel_count) {
383		IWL_DEBUG_EEPROM(priv, "Channel map already initialized.\n");
384		return 0;
385	}
386
387	IWL_DEBUG_EEPROM(priv, "Initializing regulatory info from EEPROM\n");
388
389	priv->channel_count =
390	    ARRAY_SIZE(iwlegacy_eeprom_band_1) +
391	    ARRAY_SIZE(iwlegacy_eeprom_band_2) +
392	    ARRAY_SIZE(iwlegacy_eeprom_band_3) +
393	    ARRAY_SIZE(iwlegacy_eeprom_band_4) +
394	    ARRAY_SIZE(iwlegacy_eeprom_band_5);
395
396	IWL_DEBUG_EEPROM(priv, "Parsing data for %d channels.\n",
397			priv->channel_count);
398
399	priv->channel_info = kzalloc(sizeof(struct iwl_channel_info) *
400				     priv->channel_count, GFP_KERNEL);
401	if (!priv->channel_info) {
402		IWL_ERR(priv, "Could not allocate channel_info\n");
403		priv->channel_count = 0;
404		return -ENOMEM;
405	}
406
407	ch_info = priv->channel_info;
408
409	/* Loop through the 5 EEPROM bands adding them in order to the
410	 * channel map we maintain (that contains additional information than
411	 * what just in the EEPROM) */
412	for (band = 1; band <= 5; band++) {
413
414		iwl_legacy_init_band_reference(priv, band, &eeprom_ch_count,
415					&eeprom_ch_info, &eeprom_ch_index);
416
417		/* Loop through each band adding each of the channels */
418		for (ch = 0; ch < eeprom_ch_count; ch++) {
419			ch_info->channel = eeprom_ch_index[ch];
420			ch_info->band = (band == 1) ? IEEE80211_BAND_2GHZ :
421			    IEEE80211_BAND_5GHZ;
422
423			/* permanently store EEPROM's channel regulatory flags
424			 *   and max power in channel info database. */
425			ch_info->eeprom = eeprom_ch_info[ch];
426
427			/* Copy the run-time flags so they are there even on
428			 * invalid channels */
429			ch_info->flags = eeprom_ch_info[ch].flags;
430			/* First write that ht40 is not enabled, and then enable
431			 * one by one */
432			ch_info->ht40_extension_channel =
433					IEEE80211_CHAN_NO_HT40;
434
435			if (!(iwl_legacy_is_channel_valid(ch_info))) {
436				IWL_DEBUG_EEPROM(priv,
437					       "Ch. %d Flags %x [%sGHz] - "
438					       "No traffic\n",
439					       ch_info->channel,
440					       ch_info->flags,
441					       iwl_legacy_is_channel_a_band(ch_info) ?
442					       "5.2" : "2.4");
443				ch_info++;
444				continue;
445			}
446
447			/* Initialize regulatory-based run-time data */
448			ch_info->max_power_avg = ch_info->curr_txpow =
449			    eeprom_ch_info[ch].max_power_avg;
450			ch_info->scan_power = eeprom_ch_info[ch].max_power_avg;
451			ch_info->min_power = 0;
452
453			IWL_DEBUG_EEPROM(priv, "Ch. %d [%sGHz] "
454				       "%s%s%s%s%s%s(0x%02x %ddBm):"
455				       " Ad-Hoc %ssupported\n",
456				       ch_info->channel,
457				       iwl_legacy_is_channel_a_band(ch_info) ?
458				       "5.2" : "2.4",
459				       CHECK_AND_PRINT_I(VALID),
460				       CHECK_AND_PRINT_I(IBSS),
461				       CHECK_AND_PRINT_I(ACTIVE),
462				       CHECK_AND_PRINT_I(RADAR),
463				       CHECK_AND_PRINT_I(WIDE),
464				       CHECK_AND_PRINT_I(DFS),
465				       eeprom_ch_info[ch].flags,
466				       eeprom_ch_info[ch].max_power_avg,
467				       ((eeprom_ch_info[ch].
468					 flags & EEPROM_CHANNEL_IBSS)
469					&& !(eeprom_ch_info[ch].
470					     flags & EEPROM_CHANNEL_RADAR))
471				       ? "" : "not ");
472
473			ch_info++;
474		}
475	}
476
477	/* Check if we do have HT40 channels */
478	if (priv->cfg->ops->lib->eeprom_ops.regulatory_bands[5] ==
479	    EEPROM_REGULATORY_BAND_NO_HT40 &&
480	    priv->cfg->ops->lib->eeprom_ops.regulatory_bands[6] ==
481	    EEPROM_REGULATORY_BAND_NO_HT40)
482		return 0;
483
484	/* Two additional EEPROM bands for 2.4 and 5 GHz HT40 channels */
485	for (band = 6; band <= 7; band++) {
486		enum ieee80211_band ieeeband;
487
488		iwl_legacy_init_band_reference(priv, band, &eeprom_ch_count,
489					&eeprom_ch_info, &eeprom_ch_index);
490
491		/* EEPROM band 6 is 2.4, band 7 is 5 GHz */
492		ieeeband =
493			(band == 6) ? IEEE80211_BAND_2GHZ : IEEE80211_BAND_5GHZ;
494
495		/* Loop through each band adding each of the channels */
496		for (ch = 0; ch < eeprom_ch_count; ch++) {
497			/* Set up driver's info for lower half */
498			iwl_legacy_mod_ht40_chan_info(priv, ieeeband,
499						eeprom_ch_index[ch],
500						&eeprom_ch_info[ch],
501						IEEE80211_CHAN_NO_HT40PLUS);
502
503			/* Set up driver's info for upper half */
504			iwl_legacy_mod_ht40_chan_info(priv, ieeeband,
505						eeprom_ch_index[ch] + 4,
506						&eeprom_ch_info[ch],
507						IEEE80211_CHAN_NO_HT40MINUS);
508		}
509	}
510
511	return 0;
512}
513EXPORT_SYMBOL(iwl_legacy_init_channel_map);
514
515/*
516 * iwl_legacy_free_channel_map - undo allocations in iwl_legacy_init_channel_map
517 */
518void iwl_legacy_free_channel_map(struct iwl_priv *priv)
519{
520	kfree(priv->channel_info);
521	priv->channel_count = 0;
522}
523EXPORT_SYMBOL(iwl_legacy_free_channel_map);
524
525/**
526 * iwl_legacy_get_channel_info - Find driver's private channel info
527 *
528 * Based on band and channel number.
529 */
530const struct
531iwl_channel_info *iwl_legacy_get_channel_info(const struct iwl_priv *priv,
532					enum ieee80211_band band, u16 channel)
533{
534	int i;
535
536	switch (band) {
537	case IEEE80211_BAND_5GHZ:
538		for (i = 14; i < priv->channel_count; i++) {
539			if (priv->channel_info[i].channel == channel)
540				return &priv->channel_info[i];
541		}
542		break;
543	case IEEE80211_BAND_2GHZ:
544		if (channel >= 1 && channel <= 14)
545			return &priv->channel_info[channel - 1];
546		break;
547	default:
548		BUG();
549	}
550
551	return NULL;
552}
553EXPORT_SYMBOL(iwl_legacy_get_channel_info);