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