1 /******************************************************************************
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.
8 * Copyright(c) 2008 Intel Corporation. All rights reserved.
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.
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.
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,
24 * The full GNU General Public License is included in this distribution
25 * in the file called LICENSE.GPL.
27 * Contact Information:
28 * Intel Linux Wireless <ilw@linux.intel.com>
29 * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
33 * Copyright(c) 2005 - 2008 Intel Corporation. All rights reserved.
34 * All rights reserved.
36 * Redistribution and use in source and binary forms, with or without
37 * modification, are permitted provided that the following conditions
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
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.
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 *****************************************************************************/
64 #include <linux/kernel.h>
65 #include <linux/module.h>
66 #include <linux/init.h>
68 #include <net/mac80211.h>
70 #include "iwl-commands.h"
73 #include "iwl-debug.h"
74 #include "iwl-eeprom.h"
77 /************************** EEPROM BANDS ****************************
79 * The iwl_eeprom_band definitions below provide the mapping from the
80 * EEPROM contents to the specific channel number supported for each
83 * For example, iwl_priv->eeprom.band_3_channels[4] from the band_3
84 * definition below maps to physical channel 42 in the 5.2GHz spectrum.
85 * The specific geography and calibration information for that channel
86 * is contained in the eeprom map itself.
88 * During init, we copy the eeprom information and channel map
89 * information into priv->channel_info_24/52 and priv->channel_map_24/52
91 * channel_map_24/52 provides the index in the channel_info array for a
92 * given channel. We have to have two separate maps as there is channel
93 * overlap with the 2.4GHz and 5.2GHz spectrum as seen in band_1 and
96 * A value of 0xff stored in the channel_map indicates that the channel
97 * is not supported by the hardware at all.
99 * A value of 0xfe in the channel_map indicates that the channel is not
100 * valid for Tx with the current hardware. This means that
101 * while the system can tune and receive on a given channel, it may not
102 * be able to associate or transmit any frames on that
103 * channel. There is no corresponding channel information for that
106 *********************************************************************/
109 const u8 iwl_eeprom_band_1[14] = {
110 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14
114 static const u8 iwl_eeprom_band_2[] = { /* 4915-5080MHz */
115 183, 184, 185, 187, 188, 189, 192, 196, 7, 8, 11, 12, 16
118 static const u8 iwl_eeprom_band_3[] = { /* 5170-5320MHz */
119 34, 36, 38, 40, 42, 44, 46, 48, 52, 56, 60, 64
122 static const u8 iwl_eeprom_band_4[] = { /* 5500-5700MHz */
123 100, 104, 108, 112, 116, 120, 124, 128, 132, 136, 140
126 static const u8 iwl_eeprom_band_5[] = { /* 5725-5825MHz */
127 145, 149, 153, 157, 161, 165
130 static const u8 iwl_eeprom_band_6[] = { /* 2.4 FAT channel */
134 static const u8 iwl_eeprom_band_7[] = { /* 5.2 FAT channel */
135 36, 44, 52, 60, 100, 108, 116, 124, 132, 149, 157
138 /******************************************************************************
140 * EEPROM related functions
142 ******************************************************************************/
144 int iwlcore_eeprom_verify_signature(struct iwl_priv *priv)
146 u32 gp = iwl_read32(priv, CSR_EEPROM_GP);
147 if ((gp & CSR_EEPROM_GP_VALID_MSK) == CSR_EEPROM_GP_BAD_SIGNATURE) {
148 IWL_ERROR("EEPROM not found, EEPROM_GP=0x%08x\n", gp);
153 EXPORT_SYMBOL(iwlcore_eeprom_verify_signature);
156 * The device's EEPROM semaphore prevents conflicts between driver and uCode
157 * when accessing the EEPROM; each access is a series of pulses to/from the
158 * EEPROM chip, not a single event, so even reads could conflict if they
159 * weren't arbitrated by the semaphore.
161 int iwlcore_eeprom_acquire_semaphore(struct iwl_priv *priv)
166 for (count = 0; count < EEPROM_SEM_RETRY_LIMIT; count++) {
167 /* Request semaphore */
168 iwl_set_bit(priv, CSR_HW_IF_CONFIG_REG,
169 CSR_HW_IF_CONFIG_REG_BIT_EEPROM_OWN_SEM);
171 /* See if we got it */
172 ret = iwl_poll_direct_bit(priv, CSR_HW_IF_CONFIG_REG,
173 CSR_HW_IF_CONFIG_REG_BIT_EEPROM_OWN_SEM,
176 IWL_DEBUG_IO("Acquired semaphore after %d tries.\n",
184 EXPORT_SYMBOL(iwlcore_eeprom_acquire_semaphore);
186 void iwlcore_eeprom_release_semaphore(struct iwl_priv *priv)
188 iwl_clear_bit(priv, CSR_HW_IF_CONFIG_REG,
189 CSR_HW_IF_CONFIG_REG_BIT_EEPROM_OWN_SEM);
192 EXPORT_SYMBOL(iwlcore_eeprom_release_semaphore);
194 const u8 *iwlcore_eeprom_query_addr(const struct iwl_priv *priv, size_t offset)
196 BUG_ON(offset >= priv->cfg->eeprom_size);
197 return &priv->eeprom[offset];
199 EXPORT_SYMBOL(iwlcore_eeprom_query_addr);
202 * iwl_eeprom_init - read EEPROM contents
204 * Load the EEPROM contents from adapter into priv->eeprom
206 * NOTE: This routine uses the non-debug IO access functions.
208 int iwl_eeprom_init(struct iwl_priv *priv)
211 u32 gp = iwl_read32(priv, CSR_EEPROM_GP);
212 int sz = priv->cfg->eeprom_size;
216 /* allocate eeprom */
217 priv->eeprom = kzalloc(sz, GFP_KERNEL);
222 e = (u16 *)priv->eeprom;
224 ret = priv->cfg->ops->lib->eeprom_ops.verify_signature(priv);
226 IWL_ERROR("EEPROM not found, EEPROM_GP=0x%08x\n", gp);
231 /* Make sure driver (instead of uCode) is allowed to read EEPROM */
232 ret = priv->cfg->ops->lib->eeprom_ops.acquire_semaphore(priv);
234 IWL_ERROR("Failed to acquire EEPROM semaphore.\n");
239 /* eeprom is an array of 16bit values */
240 for (addr = 0; addr < sz; addr += sizeof(u16)) {
243 _iwl_write32(priv, CSR_EEPROM_REG,
244 CSR_EEPROM_REG_MSK_ADDR & (addr << 1));
246 ret = iwl_poll_direct_bit(priv, CSR_EEPROM_REG,
247 CSR_EEPROM_REG_READ_VALID_MSK,
248 IWL_EEPROM_ACCESS_TIMEOUT);
250 IWL_ERROR("Time out reading EEPROM[%d]\n", addr);
253 r = _iwl_read_direct32(priv, CSR_EEPROM_REG);
254 e[addr / 2] = le16_to_cpu((__force __le16)(r >> 16));
258 priv->cfg->ops->lib->eeprom_ops.release_semaphore(priv);
265 EXPORT_SYMBOL(iwl_eeprom_init);
267 void iwl_eeprom_free(struct iwl_priv *priv)
272 EXPORT_SYMBOL(iwl_eeprom_free);
274 int iwl_eeprom_check_version(struct iwl_priv *priv)
279 eeprom_ver = iwl_eeprom_query16(priv, EEPROM_VERSION);
280 calib_ver = priv->cfg->ops->lib->eeprom_ops.calib_version(priv);
282 if (eeprom_ver < priv->cfg->eeprom_ver ||
283 calib_ver < priv->cfg->eeprom_calib_ver)
288 IWL_ERROR("Unsupported EEPROM VER=0x%x < 0x%x CALIB=0x%x < 0x%x\n",
289 eeprom_ver, priv->cfg->eeprom_ver,
290 calib_ver, priv->cfg->eeprom_calib_ver);
294 EXPORT_SYMBOL(iwl_eeprom_check_version);
296 const u8 *iwl_eeprom_query_addr(const struct iwl_priv *priv, size_t offset)
298 return priv->cfg->ops->lib->eeprom_ops.query_addr(priv, offset);
300 EXPORT_SYMBOL(iwl_eeprom_query_addr);
302 u16 iwl_eeprom_query16(const struct iwl_priv *priv, size_t offset)
304 return (u16)priv->eeprom[offset] | ((u16)priv->eeprom[offset + 1] << 8);
306 EXPORT_SYMBOL(iwl_eeprom_query16);
308 void iwl_eeprom_get_mac(const struct iwl_priv *priv, u8 *mac)
310 const u8 *addr = priv->cfg->ops->lib->eeprom_ops.query_addr(priv,
312 memcpy(mac, addr, ETH_ALEN);
314 EXPORT_SYMBOL(iwl_eeprom_get_mac);
316 static void iwl_init_band_reference(const struct iwl_priv *priv,
317 int eep_band, int *eeprom_ch_count,
318 const struct iwl_eeprom_channel **eeprom_ch_info,
319 const u8 **eeprom_ch_index)
321 u32 offset = priv->cfg->ops->lib->
322 eeprom_ops.regulatory_bands[eep_band - 1];
324 case 1: /* 2.4GHz band */
325 *eeprom_ch_count = ARRAY_SIZE(iwl_eeprom_band_1);
326 *eeprom_ch_info = (struct iwl_eeprom_channel *)
327 iwl_eeprom_query_addr(priv, offset);
328 *eeprom_ch_index = iwl_eeprom_band_1;
330 case 2: /* 4.9GHz band */
331 *eeprom_ch_count = ARRAY_SIZE(iwl_eeprom_band_2);
332 *eeprom_ch_info = (struct iwl_eeprom_channel *)
333 iwl_eeprom_query_addr(priv, offset);
334 *eeprom_ch_index = iwl_eeprom_band_2;
336 case 3: /* 5.2GHz band */
337 *eeprom_ch_count = ARRAY_SIZE(iwl_eeprom_band_3);
338 *eeprom_ch_info = (struct iwl_eeprom_channel *)
339 iwl_eeprom_query_addr(priv, offset);
340 *eeprom_ch_index = iwl_eeprom_band_3;
342 case 4: /* 5.5GHz band */
343 *eeprom_ch_count = ARRAY_SIZE(iwl_eeprom_band_4);
344 *eeprom_ch_info = (struct iwl_eeprom_channel *)
345 iwl_eeprom_query_addr(priv, offset);
346 *eeprom_ch_index = iwl_eeprom_band_4;
348 case 5: /* 5.7GHz band */
349 *eeprom_ch_count = ARRAY_SIZE(iwl_eeprom_band_5);
350 *eeprom_ch_info = (struct iwl_eeprom_channel *)
351 iwl_eeprom_query_addr(priv, offset);
352 *eeprom_ch_index = iwl_eeprom_band_5;
354 case 6: /* 2.4GHz FAT channels */
355 *eeprom_ch_count = ARRAY_SIZE(iwl_eeprom_band_6);
356 *eeprom_ch_info = (struct iwl_eeprom_channel *)
357 iwl_eeprom_query_addr(priv, offset);
358 *eeprom_ch_index = iwl_eeprom_band_6;
360 case 7: /* 5 GHz FAT channels */
361 *eeprom_ch_count = ARRAY_SIZE(iwl_eeprom_band_7);
362 *eeprom_ch_info = (struct iwl_eeprom_channel *)
363 iwl_eeprom_query_addr(priv, offset);
364 *eeprom_ch_index = iwl_eeprom_band_7;
372 #define CHECK_AND_PRINT(x) ((eeprom_ch->flags & EEPROM_CHANNEL_##x) \
376 * iwl_set_fat_chan_info - Copy fat channel info into driver's priv.
378 * Does not set up a command, or touch hardware.
380 static int iwl_set_fat_chan_info(struct iwl_priv *priv,
381 enum ieee80211_band band, u16 channel,
382 const struct iwl_eeprom_channel *eeprom_ch,
383 u8 fat_extension_channel)
385 struct iwl_channel_info *ch_info;
387 ch_info = (struct iwl_channel_info *)
388 iwl_get_channel_info(priv, band, channel);
390 if (!is_channel_valid(ch_info))
393 IWL_DEBUG_INFO("FAT Ch. %d [%sGHz] %s%s%s%s%s(0x%02x %ddBm):"
394 " Ad-Hoc %ssupported\n",
396 is_channel_a_band(ch_info) ?
398 CHECK_AND_PRINT(IBSS),
399 CHECK_AND_PRINT(ACTIVE),
400 CHECK_AND_PRINT(RADAR),
401 CHECK_AND_PRINT(WIDE),
402 CHECK_AND_PRINT(DFS),
404 eeprom_ch->max_power_avg,
405 ((eeprom_ch->flags & EEPROM_CHANNEL_IBSS)
406 && !(eeprom_ch->flags & EEPROM_CHANNEL_RADAR)) ?
409 ch_info->fat_eeprom = *eeprom_ch;
410 ch_info->fat_max_power_avg = eeprom_ch->max_power_avg;
411 ch_info->fat_curr_txpow = eeprom_ch->max_power_avg;
412 ch_info->fat_min_power = 0;
413 ch_info->fat_scan_power = eeprom_ch->max_power_avg;
414 ch_info->fat_flags = eeprom_ch->flags;
415 ch_info->fat_extension_channel = fat_extension_channel;
420 #define CHECK_AND_PRINT_I(x) ((eeprom_ch_info[ch].flags & EEPROM_CHANNEL_##x) \
424 * iwl_init_channel_map - Set up driver's info for all possible channels
426 int iwl_init_channel_map(struct iwl_priv *priv)
428 int eeprom_ch_count = 0;
429 const u8 *eeprom_ch_index = NULL;
430 const struct iwl_eeprom_channel *eeprom_ch_info = NULL;
432 struct iwl_channel_info *ch_info;
434 if (priv->channel_count) {
435 IWL_DEBUG_INFO("Channel map already initialized.\n");
439 IWL_DEBUG_INFO("Initializing regulatory info from EEPROM\n");
441 priv->channel_count =
442 ARRAY_SIZE(iwl_eeprom_band_1) +
443 ARRAY_SIZE(iwl_eeprom_band_2) +
444 ARRAY_SIZE(iwl_eeprom_band_3) +
445 ARRAY_SIZE(iwl_eeprom_band_4) +
446 ARRAY_SIZE(iwl_eeprom_band_5);
448 IWL_DEBUG_INFO("Parsing data for %d channels.\n", priv->channel_count);
450 priv->channel_info = kzalloc(sizeof(struct iwl_channel_info) *
451 priv->channel_count, GFP_KERNEL);
452 if (!priv->channel_info) {
453 IWL_ERROR("Could not allocate channel_info\n");
454 priv->channel_count = 0;
458 ch_info = priv->channel_info;
460 /* Loop through the 5 EEPROM bands adding them in order to the
461 * channel map we maintain (that contains additional information than
462 * what just in the EEPROM) */
463 for (band = 1; band <= 5; band++) {
465 iwl_init_band_reference(priv, band, &eeprom_ch_count,
466 &eeprom_ch_info, &eeprom_ch_index);
468 /* Loop through each band adding each of the channels */
469 for (ch = 0; ch < eeprom_ch_count; ch++) {
470 ch_info->channel = eeprom_ch_index[ch];
471 ch_info->band = (band == 1) ? IEEE80211_BAND_2GHZ :
474 /* permanently store EEPROM's channel regulatory flags
475 * and max power in channel info database. */
476 ch_info->eeprom = eeprom_ch_info[ch];
478 /* Copy the run-time flags so they are there even on
479 * invalid channels */
480 ch_info->flags = eeprom_ch_info[ch].flags;
481 /* First write that fat is not enabled, and then enable
483 ch_info->fat_extension_channel =
484 (IEEE80211_CHAN_NO_FAT_ABOVE |
485 IEEE80211_CHAN_NO_FAT_BELOW);
487 if (!(is_channel_valid(ch_info))) {
488 IWL_DEBUG_INFO("Ch. %d Flags %x [%sGHz] - "
492 is_channel_a_band(ch_info) ?
498 /* Initialize regulatory-based run-time data */
499 ch_info->max_power_avg = ch_info->curr_txpow =
500 eeprom_ch_info[ch].max_power_avg;
501 ch_info->scan_power = eeprom_ch_info[ch].max_power_avg;
502 ch_info->min_power = 0;
504 IWL_DEBUG_INFO("Ch. %d [%sGHz] %s%s%s%s%s%s(0x%02x %ddBm):"
505 " Ad-Hoc %ssupported\n",
507 is_channel_a_band(ch_info) ?
509 CHECK_AND_PRINT_I(VALID),
510 CHECK_AND_PRINT_I(IBSS),
511 CHECK_AND_PRINT_I(ACTIVE),
512 CHECK_AND_PRINT_I(RADAR),
513 CHECK_AND_PRINT_I(WIDE),
514 CHECK_AND_PRINT_I(DFS),
515 eeprom_ch_info[ch].flags,
516 eeprom_ch_info[ch].max_power_avg,
517 ((eeprom_ch_info[ch].
518 flags & EEPROM_CHANNEL_IBSS)
519 && !(eeprom_ch_info[ch].
520 flags & EEPROM_CHANNEL_RADAR))
523 /* Set the user_txpower_limit to the highest power
524 * supported by any channel */
525 if (eeprom_ch_info[ch].max_power_avg >
526 priv->tx_power_user_lmt)
527 priv->tx_power_user_lmt =
528 eeprom_ch_info[ch].max_power_avg;
534 /* Two additional EEPROM bands for 2.4 and 5 GHz FAT channels */
535 for (band = 6; band <= 7; band++) {
536 enum ieee80211_band ieeeband;
537 u8 fat_extension_chan;
539 iwl_init_band_reference(priv, band, &eeprom_ch_count,
540 &eeprom_ch_info, &eeprom_ch_index);
542 /* EEPROM band 6 is 2.4, band 7 is 5 GHz */
544 (band == 6) ? IEEE80211_BAND_2GHZ : IEEE80211_BAND_5GHZ;
546 /* Loop through each band adding each of the channels */
547 for (ch = 0; ch < eeprom_ch_count; ch++) {
550 ((eeprom_ch_index[ch] == 5) ||
551 (eeprom_ch_index[ch] == 6) ||
552 (eeprom_ch_index[ch] == 7)))
553 /* both are allowed: above and below */
554 fat_extension_chan = 0;
557 IEEE80211_CHAN_NO_FAT_BELOW;
559 /* Set up driver's info for lower half */
560 iwl_set_fat_chan_info(priv, ieeeband,
562 &(eeprom_ch_info[ch]),
565 /* Set up driver's info for upper half */
566 iwl_set_fat_chan_info(priv, ieeeband,
567 (eeprom_ch_index[ch] + 4),
568 &(eeprom_ch_info[ch]),
569 IEEE80211_CHAN_NO_FAT_ABOVE);
575 EXPORT_SYMBOL(iwl_init_channel_map);
578 * iwl_free_channel_map - undo allocations in iwl_init_channel_map
580 void iwl_free_channel_map(struct iwl_priv *priv)
582 kfree(priv->channel_info);
583 priv->channel_count = 0;
587 * iwl_get_channel_info - Find driver's private channel info
589 * Based on band and channel number.
591 const struct iwl_channel_info *iwl_get_channel_info(const struct iwl_priv *priv,
592 enum ieee80211_band band, u16 channel)
597 case IEEE80211_BAND_5GHZ:
598 for (i = 14; i < priv->channel_count; i++) {
599 if (priv->channel_info[i].channel == channel)
600 return &priv->channel_info[i];
603 case IEEE80211_BAND_2GHZ:
604 if (channel >= 1 && channel <= 14)
605 return &priv->channel_info[channel - 1];
613 EXPORT_SYMBOL(iwl_get_channel_info);