drivers/net/wireless/iwlwifi/iwl-eeprom.h

   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 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  * Tomas Winkler <tomas.winkler@intel.com>
  29  * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
  30  *
  31  * BSD LICENSE
  32  *
  33  * Copyright(c) 2005 - 2008 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 #ifndef __iwl_eeprom_h__
  64 #define __iwl_eeprom_h__
  65
  66 struct iwl_priv;
  67
  68 /*
  69  * EEPROM access time values:
  70  *
  71  * Driver initiates EEPROM read by writing byte address << 1 to CSR_EEPROM_REG,
  72  *   then clearing (with subsequent read/modify/write) CSR_EEPROM_REG bit
  73  *   CSR_EEPROM_REG_BIT_CMD (0x2).
  74  * Driver then polls CSR_EEPROM_REG for CSR_EEPROM_REG_READ_VALID_MSK (0x1).
  75  * When polling, wait 10 uSec between polling loops, up to a maximum 5000 uSec.
  76  * Driver reads 16-bit value from bits 31-16 of CSR_EEPROM_REG.
  77  */
  78 #define IWL_EEPROM_ACCESS_TIMEOUT       5000 /* uSec */
  79 #define IWL_EEPROM_ACCESS_DELAY         10   /* uSec */
  80
  81 #define IWL_EEPROM_SEM_TIMEOUT          10   /* milliseconds */
  82 #define IWL_EEPROM_SEM_RETRY_LIMIT      1000 /* number of attempts (not time) */
  83
  84
  85 /*
  86  * Regulatory channel usage flags in EEPROM struct iwl4965_eeprom_channel.flags.
  87  *
  88  * IBSS and/or AP operation is allowed *only* on those channels with
  89  * (VALID && IBSS && ACTIVE && !RADAR).  This restriction is in place because
  90  * RADAR detection is not supported by the 4965 driver, but is a
  91  * requirement for establishing a new network for legal operation on channels
  92  * requiring RADAR detection or restricting ACTIVE scanning.
  93  *
  94  * NOTE:  "WIDE" flag does not indicate anything about "FAT" 40 MHz channels.
  95  *        It only indicates that 20 MHz channel use is supported; FAT channel
  96  *        usage is indicated by a separate set of regulatory flags for each
  97  *        FAT channel pair.
  98  *
  99  * NOTE:  Using a channel inappropriately will result in a uCode error!
 100  */
 101 #define IWL_NUM_TX_CALIB_GROUPS 5
 102 enum {
 103         EEPROM_CHANNEL_VALID = (1 << 0),        /* usable for this SKU/geo */
 104         EEPROM_CHANNEL_IBSS = (1 << 1),         /* usable as an IBSS channel */
 105         /* Bit 2 Reserved */
 106         EEPROM_CHANNEL_ACTIVE = (1 << 3),       /* active scanning allowed */
 107         EEPROM_CHANNEL_RADAR = (1 << 4),        /* radar detection required */
 108         EEPROM_CHANNEL_WIDE = (1 << 5),         /* 20 MHz channel okay */
 109         /* Bit 6 Reserved (was Narrow Channel) */
 110         EEPROM_CHANNEL_DFS = (1 << 7),  /* dynamic freq selection candidate */
 111 };
 112
 113 /* SKU Capabilities */
 114 #define EEPROM_SKU_CAP_SW_RF_KILL_ENABLE                (1 << 0)
 115 #define EEPROM_SKU_CAP_HW_RF_KILL_ENABLE                (1 << 1)
 116
 117 /* *regulatory* channel data format in eeprom, one for each channel.
 118  * There are separate entries for FAT (40 MHz) vs. normal (20 MHz) channels. */
 119 struct iwl_eeprom_channel {
 120         u8 flags;               /* EEPROM_CHANNEL_* flags copied from EEPROM */
 121         s8 max_power_avg;       /* max power (dBm) on this chnl, limit 31 */
 122 } __attribute__ ((packed));
 123
 124 /* 4965 has two radio transmitters (and 3 radio receivers) */
 125 #define EEPROM_TX_POWER_TX_CHAINS      (2)
 126
 127 /* 4965 has room for up to 8 sets of txpower calibration data */
 128 #define EEPROM_TX_POWER_BANDS          (8)
 129
 130 /* 4965 factory calibration measures txpower gain settings for
 131  * each of 3 target output levels */
 132 #define EEPROM_TX_POWER_MEASUREMENTS   (3)
 133
 134 /* 4965 Specific */
 135 /* 4965 driver does not work with txpower calibration version < 5 */
 136 #define EEPROM_4965_TX_POWER_VERSION    (5)
 137 #define EEPROM_4965_EEPROM_VERSION      (0x2f)
 138 #define EEPROM_4965_CALIB_VERSION_OFFSET       (2*0xB6) /* 2 bytes */
 139 #define EEPROM_4965_CALIB_TXPOWER_OFFSET       (2*0xE8) /* 48  bytes */
 140 #define EEPROM_4965_BOARD_REVISION             (2*0x4F) /* 2 bytes */
 141 #define EEPROM_4965_BOARD_PBA                  (2*0x56+1) /* 9 bytes */
 142
 143 /* 5000 Specific */
 144 #define EEPROM_5000_TX_POWER_VERSION    (4)
 145 #define EEPROM_5000_EEPROM_VERSION      (0x11A)
 146
 147 /*5000 calibrations */
 148 #define EEPROM_5000_CALIB_ALL   (INDIRECT_ADDRESS | INDIRECT_CALIBRATION)
 149 #define EEPROM_5000_XTAL        ((2*0x128) | EEPROM_5000_CALIB_ALL)
 150
 151 /* 5000 links */
 152 #define EEPROM_5000_LINK_HOST             (2*0x64)
 153 #define EEPROM_5000_LINK_GENERAL          (2*0x65)
 154 #define EEPROM_5000_LINK_REGULATORY       (2*0x66)
 155 #define EEPROM_5000_LINK_CALIBRATION      (2*0x67)
 156 #define EEPROM_5000_LINK_PROCESS_ADJST    (2*0x68)
 157 #define EEPROM_5000_LINK_OTHERS           (2*0x69)
 158
 159 /* 5000 regulatory - indirect access */
 160 #define EEPROM_5000_REG_SKU_ID ((0x02)\
 161                 | INDIRECT_ADDRESS | INDIRECT_REGULATORY)   /* 4  bytes */
 162 #define EEPROM_5000_REG_BAND_1_CHANNELS       ((0x08)\
 163                 | INDIRECT_ADDRESS | INDIRECT_REGULATORY)   /* 28 bytes */
 164 #define EEPROM_5000_REG_BAND_2_CHANNELS       ((0x26)\
 165                 | INDIRECT_ADDRESS | INDIRECT_REGULATORY)   /* 26 bytes */
 166 #define EEPROM_5000_REG_BAND_3_CHANNELS       ((0x42)\
 167                 | INDIRECT_ADDRESS | INDIRECT_REGULATORY)   /* 24 bytes */
 168 #define EEPROM_5000_REG_BAND_4_CHANNELS       ((0x5C)\
 169                 | INDIRECT_ADDRESS | INDIRECT_REGULATORY)   /* 22 bytes */
 170 #define EEPROM_5000_REG_BAND_5_CHANNELS       ((0x74)\
 171                 | INDIRECT_ADDRESS | INDIRECT_REGULATORY)   /* 12 bytes */
 172 #define EEPROM_5000_REG_BAND_24_FAT_CHANNELS  ((0x82)\
 173                 | INDIRECT_ADDRESS | INDIRECT_REGULATORY)   /* 14  bytes */
 174 #define EEPROM_5000_REG_BAND_52_FAT_CHANNELS  ((0x92)\
 175                 | INDIRECT_ADDRESS | INDIRECT_REGULATORY)   /* 22  bytes */
 176
 177
 178 /* 2.4 GHz */
 179 extern const u8 iwl_eeprom_band_1[14];
 180
 181 /*
 182  * factory calibration data for one txpower level, on one channel,
 183  * measured on one of the 2 tx chains (radio transmitter and associated
 184  * antenna).  EEPROM contains:
 185  *
 186  * 1)  Temperature (degrees Celsius) of device when measurement was made.
 187  *
 188  * 2)  Gain table index used to achieve the target measurement power.
 189  *     This refers to the "well-known" gain tables (see iwl-4965-hw.h).
 190  *
 191  * 3)  Actual measured output power, in half-dBm ("34" = 17 dBm).
 192  *
 193  * 4)  RF power amplifier detector level measurement (not used).
 194  */
 195 struct iwl_eeprom_calib_measure {
 196         u8 temperature;         /* Device temperature (Celsius) */
 197         u8 gain_idx;            /* Index into gain table */
 198         u8 actual_pow;          /* Measured RF output power, half-dBm */
 199         s8 pa_det;              /* Power amp detector level (not used) */
 200 } __attribute__ ((packed));
 201
 202
 203 /*
 204  * measurement set for one channel.  EEPROM contains:
 205  *
 206  * 1)  Channel number measured
 207  *
 208  * 2)  Measurements for each of 3 power levels for each of 2 radio transmitters
 209  *     (a.k.a. "tx chains") (6 measurements altogether)
 210  */
 211 struct iwl_eeprom_calib_ch_info {
 212         u8 ch_num;
 213         struct iwl_eeprom_calib_measure
 214                 measurements[EEPROM_TX_POWER_TX_CHAINS]
 215                         [EEPROM_TX_POWER_MEASUREMENTS];
 216 } __attribute__ ((packed));
 217
 218 /*
 219  * txpower subband info.
 220  *
 221  * For each frequency subband, EEPROM contains the following:
 222  *
 223  * 1)  First and last channels within range of the subband.  "0" values
 224  *     indicate that this sample set is not being used.
 225  *
 226  * 2)  Sample measurement sets for 2 channels close to the range endpoints.
 227  */
 228 struct iwl_eeprom_calib_subband_info {
 229         u8 ch_from;     /* channel number of lowest channel in subband */
 230         u8 ch_to;       /* channel number of highest channel in subband */
 231         struct iwl_eeprom_calib_ch_info ch1;
 232         struct iwl_eeprom_calib_ch_info ch2;
 233 } __attribute__ ((packed));
 234
 235
 236 /*
 237  * txpower calibration info.  EEPROM contains:
 238  *
 239  * 1)  Factory-measured saturation power levels (maximum levels at which
 240  *     tx power amplifier can output a signal without too much distortion).
 241  *     There is one level for 2.4 GHz band and one for 5 GHz band.  These
 242  *     values apply to all channels within each of the bands.
 243  *
 244  * 2)  Factory-measured power supply voltage level.  This is assumed to be
 245  *     constant (i.e. same value applies to all channels/bands) while the
 246  *     factory measurements are being made.
 247  *
 248  * 3)  Up to 8 sets of factory-measured txpower calibration values.
 249  *     These are for different frequency ranges, since txpower gain
 250  *     characteristics of the analog radio circuitry vary with frequency.
 251  *
 252  *     Not all sets need to be filled with data;
 253  *     struct iwl_eeprom_calib_subband_info contains range of channels
 254  *     (0 if unused) for each set of data.
 255  */
 256 struct iwl_eeprom_calib_info {
 257         u8 saturation_power24;  /* half-dBm (e.g. "34" = 17 dBm) */
 258         u8 saturation_power52;  /* half-dBm */
 259         s16 voltage;            /* signed */
 260         struct iwl_eeprom_calib_subband_info
 261                 band_info[EEPROM_TX_POWER_BANDS];
 262 } __attribute__ ((packed));
 263
 264
 265 #define ADDRESS_MSK                 0x0000FFFF
 266 #define INDIRECT_TYPE_MSK           0x000F0000
 267 #define INDIRECT_HOST               0x00010000
 268 #define INDIRECT_GENERAL            0x00020000
 269 #define INDIRECT_REGULATORY         0x00030000
 270 #define INDIRECT_CALIBRATION        0x00040000
 271 #define INDIRECT_PROCESS_ADJST      0x00050000
 272 #define INDIRECT_OTHERS             0x00060000
 273 #define INDIRECT_ADDRESS            0x00100000
 274
 275 /* General */
 276 #define EEPROM_DEVICE_ID                    (2*0x08)    /* 2 bytes */
 277 #define EEPROM_MAC_ADDRESS                  (2*0x15)    /* 6  bytes */
 278 #define EEPROM_BOARD_REVISION               (2*0x35)    /* 2  bytes */
 279 #define EEPROM_BOARD_PBA_NUMBER             (2*0x3B+1)  /* 9  bytes */
 280 #define EEPROM_VERSION                      (2*0x44)    /* 2  bytes */
 281 #define EEPROM_SKU_CAP                      (2*0x45)    /* 1  bytes */
 282 #define EEPROM_LEDS_MODE                    (2*0x45+1)  /* 1  bytes */
 283 #define EEPROM_OEM_MODE                     (2*0x46)    /* 2  bytes */
 284 #define EEPROM_WOWLAN_MODE                  (2*0x47)    /* 2  bytes */
 285 #define EEPROM_RADIO_CONFIG                 (2*0x48)    /* 2  bytes */
 286 #define EEPROM_3945_M_VERSION               (2*0x4A)    /* 1  bytes */
 287 #define EEPROM_ANTENNA_SWITCH_TYPE          (2*0x4A+1)  /* 1  bytes */
 288
 289 /* The following masks are to be applied on EEPROM_RADIO_CONFIG */
 290 #define EEPROM_RF_CFG_TYPE_MSK(x)   (x & 0x3)         /* bits 0-1   */
 291 #define EEPROM_RF_CFG_STEP_MSK(x)   ((x >> 2)  & 0x3) /* bits 2-3   */
 292 #define EEPROM_RF_CFG_DASH_MSK(x)   ((x >> 4)  & 0x3) /* bits 4-5   */
 293 #define EEPROM_RF_CFG_PNUM_MSK(x)   ((x >> 6)  & 0x3) /* bits 6-7   */
 294 #define EEPROM_RF_CFG_TX_ANT_MSK(x) ((x >> 8)  & 0xF) /* bits 8-11  */
 295 #define EEPROM_RF_CFG_RX_ANT_MSK(x) ((x >> 12) & 0xF) /* bits 12-15 */
 296
 297 #define EEPROM_3945_RF_CFG_TYPE_MAX  0x0
 298 #define EEPROM_4965_RF_CFG_TYPE_MAX  0x1
 299 #define EEPROM_5000_RF_CFG_TYPE_MAX  0x3
 300
 301 /*
 302  * Per-channel regulatory data.
 303  *
 304  * Each channel that *might* be supported by iwl has a fixed location
 305  * in EEPROM containing EEPROM_CHANNEL_* usage flags (LSB) and max regulatory
 306  * txpower (MSB).
 307  *
 308  * Entries immediately below are for 20 MHz channel width.  FAT (40 MHz)
 309  * channels (only for 4965, not supported by 3945) appear later in the EEPROM.
 310  *
 311  * 2.4 GHz channels 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14
 312  */
 313 #define EEPROM_REGULATORY_SKU_ID            (2*0x60)    /* 4  bytes */
 314 #define EEPROM_REGULATORY_BAND_1            (2*0x62)    /* 2  bytes */
 315 #define EEPROM_REGULATORY_BAND_1_CHANNELS   (2*0x63)    /* 28 bytes */
 316
 317 /*
 318  * 4.9 GHz channels 183, 184, 185, 187, 188, 189, 192, 196,
 319  * 5.0 GHz channels 7, 8, 11, 12, 16
 320  * (4915-5080MHz) (none of these is ever supported)
 321  */
 322 #define EEPROM_REGULATORY_BAND_2            (2*0x71)    /* 2  bytes */
 323 #define EEPROM_REGULATORY_BAND_2_CHANNELS   (2*0x72)    /* 26 bytes */
 324
 325 /*
 326  * 5.2 GHz channels 34, 36, 38, 40, 42, 44, 46, 48, 52, 56, 60, 64
 327  * (5170-5320MHz)
 328  */
 329 #define EEPROM_REGULATORY_BAND_3            (2*0x7F)    /* 2  bytes */
 330 #define EEPROM_REGULATORY_BAND_3_CHANNELS   (2*0x80)    /* 24 bytes */
 331
 332 /*
 333  * 5.5 GHz channels 100, 104, 108, 112, 116, 120, 124, 128, 132, 136, 140
 334  * (5500-5700MHz)
 335  */
 336 #define EEPROM_REGULATORY_BAND_4            (2*0x8C)    /* 2  bytes */
 337 #define EEPROM_REGULATORY_BAND_4_CHANNELS   (2*0x8D)    /* 22 bytes */
 338
 339 /*
 340  * 5.7 GHz channels 145, 149, 153, 157, 161, 165
 341  * (5725-5825MHz)
 342  */
 343 #define EEPROM_REGULATORY_BAND_5            (2*0x98)    /* 2  bytes */
 344 #define EEPROM_REGULATORY_BAND_5_CHANNELS   (2*0x99)    /* 12 bytes */
 345
 346 /*
 347  * 2.4 GHz FAT channels 1 (5), 2 (6), 3 (7), 4 (8), 5 (9), 6 (10), 7 (11)
 348  *
 349  * The channel listed is the center of the lower 20 MHz half of the channel.
 350  * The overall center frequency is actually 2 channels (10 MHz) above that,
 351  * and the upper half of each FAT channel is centered 4 channels (20 MHz) away
 352  * from the lower half; e.g. the upper half of FAT channel 1 is channel 5,
 353  * and the overall FAT channel width centers on channel 3.
 354  *
 355  * NOTE:  The RXON command uses 20 MHz channel numbers to specify the
 356  *        control channel to which to tune.  RXON also specifies whether the
 357  *        control channel is the upper or lower half of a FAT channel.
 358  *
 359  * NOTE:  4965 does not support FAT channels on 2.4 GHz.
 360  */
 361 #define EEPROM_4965_REGULATORY_BAND_24_FAT_CHANNELS (2*0xA0)    /* 14 bytes */
 362
 363 /*
 364  * 5.2 GHz FAT channels 36 (40), 44 (48), 52 (56), 60 (64),
 365  * 100 (104), 108 (112), 116 (120), 124 (128), 132 (136), 149 (153), 157 (161)
 366  */
 367 #define EEPROM_4965_REGULATORY_BAND_52_FAT_CHANNELS (2*0xA8)    /* 22 bytes */
 368
 369 struct iwl_eeprom_ops {
 370         const u32 regulatory_bands[7];
 371         int (*verify_signature) (struct iwl_priv *priv);
 372         int (*acquire_semaphore) (struct iwl_priv *priv);
 373         void (*release_semaphore) (struct iwl_priv *priv);
 374         int (*check_version) (struct iwl_priv *priv);
 375         const u8* (*query_addr) (const struct iwl_priv *priv, size_t offset);
 376 };
 377
 378
 379 void iwl_eeprom_get_mac(const struct iwl_priv *priv, u8 *mac);
 380 int iwl_eeprom_init(struct iwl_priv *priv);
 381 void iwl_eeprom_free(struct iwl_priv *priv);
 382 int  iwl_eeprom_check_version(struct iwl_priv *priv);
 383 const u8 *iwl_eeprom_query_addr(const struct iwl_priv *priv, size_t offset);
 384 u16 iwl_eeprom_query16(const struct iwl_priv *priv, size_t offset);
 385
 386 int iwlcore_eeprom_verify_signature(struct iwl_priv *priv);
 387 int iwlcore_eeprom_acquire_semaphore(struct iwl_priv *priv);
 388 void iwlcore_eeprom_release_semaphore(struct iwl_priv *priv);
 389 const u8 *iwlcore_eeprom_query_addr(const struct iwl_priv *priv, size_t offset);
 390
 391 int iwl_init_channel_map(struct iwl_priv *priv);
 392 void iwl_free_channel_map(struct iwl_priv *priv);
 393 const struct iwl_channel_info *iwl_get_channel_info(
 394                 const struct iwl_priv *priv,
 395                 enum ieee80211_band band, u16 channel);
 396
 397 #endif  /* __iwl_eeprom_h__ */