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 * Tomas Winkler <tomas.winkler@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 *****************************************************************************/
63 #ifndef __iwl_eeprom_h__
64 #define __iwl_eeprom_h__
69 * EEPROM access time values:
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.
78 #define IWL_EEPROM_ACCESS_TIMEOUT 5000 /* uSec */
79 #define IWL_EEPROM_ACCESS_DELAY 10 /* uSec */
81 #define IWL_EEPROM_SEM_TIMEOUT 10 /* milliseconds */
82 #define IWL_EEPROM_SEM_RETRY_LIMIT 1000 /* number of attempts (not time) */
86 * Regulatory channel usage flags in EEPROM struct iwl4965_eeprom_channel.flags.
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.
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
99 * NOTE: Using a channel inappropriately will result in a uCode error!
101 #define IWL_NUM_TX_CALIB_GROUPS 5
103 EEPROM_CHANNEL_VALID
= (1 << 0), /* usable for this SKU/geo */
104 EEPROM_CHANNEL_IBSS
= (1 << 1), /* usable as an IBSS channel */
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 */
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)
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
));
124 /* 4965 has two radio transmitters (and 3 radio receivers) */
125 #define EEPROM_TX_POWER_TX_CHAINS (2)
127 /* 4965 has room for up to 8 sets of txpower calibration data */
128 #define EEPROM_TX_POWER_BANDS (8)
130 /* 4965 factory calibration measures txpower gain settings for
131 * each of 3 target output levels */
132 #define EEPROM_TX_POWER_MEASUREMENTS (3)
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 */
144 #define EEPROM_5000_TX_POWER_VERSION (4)
145 #define EEPROM_5000_EEPROM_VERSION (0x11A)
147 /*5000 calibrations */
148 #define EEPROM_5000_CALIB_ALL (INDIRECT_ADDRESS | INDIRECT_CALIBRATION)
149 #define EEPROM_5000_XTAL ((2*0x128) | EEPROM_5000_CALIB_ALL)
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)
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 */
178 #define EEPROM_5050_TX_POWER_VERSION (4)
179 #define EEPROM_5050_EEPROM_VERSION (0x21E)
182 extern const u8 iwl_eeprom_band_1
[14];
185 * factory calibration data for one txpower level, on one channel,
186 * measured on one of the 2 tx chains (radio transmitter and associated
187 * antenna). EEPROM contains:
189 * 1) Temperature (degrees Celsius) of device when measurement was made.
191 * 2) Gain table index used to achieve the target measurement power.
192 * This refers to the "well-known" gain tables (see iwl-4965-hw.h).
194 * 3) Actual measured output power, in half-dBm ("34" = 17 dBm).
196 * 4) RF power amplifier detector level measurement (not used).
198 struct iwl_eeprom_calib_measure
{
199 u8 temperature
; /* Device temperature (Celsius) */
200 u8 gain_idx
; /* Index into gain table */
201 u8 actual_pow
; /* Measured RF output power, half-dBm */
202 s8 pa_det
; /* Power amp detector level (not used) */
203 } __attribute__ ((packed
));
207 * measurement set for one channel. EEPROM contains:
209 * 1) Channel number measured
211 * 2) Measurements for each of 3 power levels for each of 2 radio transmitters
212 * (a.k.a. "tx chains") (6 measurements altogether)
214 struct iwl_eeprom_calib_ch_info
{
216 struct iwl_eeprom_calib_measure
217 measurements
[EEPROM_TX_POWER_TX_CHAINS
]
218 [EEPROM_TX_POWER_MEASUREMENTS
];
219 } __attribute__ ((packed
));
222 * txpower subband info.
224 * For each frequency subband, EEPROM contains the following:
226 * 1) First and last channels within range of the subband. "0" values
227 * indicate that this sample set is not being used.
229 * 2) Sample measurement sets for 2 channels close to the range endpoints.
231 struct iwl_eeprom_calib_subband_info
{
232 u8 ch_from
; /* channel number of lowest channel in subband */
233 u8 ch_to
; /* channel number of highest channel in subband */
234 struct iwl_eeprom_calib_ch_info ch1
;
235 struct iwl_eeprom_calib_ch_info ch2
;
236 } __attribute__ ((packed
));
240 * txpower calibration info. EEPROM contains:
242 * 1) Factory-measured saturation power levels (maximum levels at which
243 * tx power amplifier can output a signal without too much distortion).
244 * There is one level for 2.4 GHz band and one for 5 GHz band. These
245 * values apply to all channels within each of the bands.
247 * 2) Factory-measured power supply voltage level. This is assumed to be
248 * constant (i.e. same value applies to all channels/bands) while the
249 * factory measurements are being made.
251 * 3) Up to 8 sets of factory-measured txpower calibration values.
252 * These are for different frequency ranges, since txpower gain
253 * characteristics of the analog radio circuitry vary with frequency.
255 * Not all sets need to be filled with data;
256 * struct iwl_eeprom_calib_subband_info contains range of channels
257 * (0 if unused) for each set of data.
259 struct iwl_eeprom_calib_info
{
260 u8 saturation_power24
; /* half-dBm (e.g. "34" = 17 dBm) */
261 u8 saturation_power52
; /* half-dBm */
262 s16 voltage
; /* signed */
263 struct iwl_eeprom_calib_subband_info
264 band_info
[EEPROM_TX_POWER_BANDS
];
265 } __attribute__ ((packed
));
268 #define ADDRESS_MSK 0x0000FFFF
269 #define INDIRECT_TYPE_MSK 0x000F0000
270 #define INDIRECT_HOST 0x00010000
271 #define INDIRECT_GENERAL 0x00020000
272 #define INDIRECT_REGULATORY 0x00030000
273 #define INDIRECT_CALIBRATION 0x00040000
274 #define INDIRECT_PROCESS_ADJST 0x00050000
275 #define INDIRECT_OTHERS 0x00060000
276 #define INDIRECT_ADDRESS 0x00100000
279 #define EEPROM_DEVICE_ID (2*0x08) /* 2 bytes */
280 #define EEPROM_MAC_ADDRESS (2*0x15) /* 6 bytes */
281 #define EEPROM_BOARD_REVISION (2*0x35) /* 2 bytes */
282 #define EEPROM_BOARD_PBA_NUMBER (2*0x3B+1) /* 9 bytes */
283 #define EEPROM_VERSION (2*0x44) /* 2 bytes */
284 #define EEPROM_SKU_CAP (2*0x45) /* 1 bytes */
285 #define EEPROM_LEDS_MODE (2*0x45+1) /* 1 bytes */
286 #define EEPROM_OEM_MODE (2*0x46) /* 2 bytes */
287 #define EEPROM_WOWLAN_MODE (2*0x47) /* 2 bytes */
288 #define EEPROM_RADIO_CONFIG (2*0x48) /* 2 bytes */
289 #define EEPROM_3945_M_VERSION (2*0x4A) /* 1 bytes */
290 #define EEPROM_ANTENNA_SWITCH_TYPE (2*0x4A+1) /* 1 bytes */
292 /* The following masks are to be applied on EEPROM_RADIO_CONFIG */
293 #define EEPROM_RF_CFG_TYPE_MSK(x) (x & 0x3) /* bits 0-1 */
294 #define EEPROM_RF_CFG_STEP_MSK(x) ((x >> 2) & 0x3) /* bits 2-3 */
295 #define EEPROM_RF_CFG_DASH_MSK(x) ((x >> 4) & 0x3) /* bits 4-5 */
296 #define EEPROM_RF_CFG_PNUM_MSK(x) ((x >> 6) & 0x3) /* bits 6-7 */
297 #define EEPROM_RF_CFG_TX_ANT_MSK(x) ((x >> 8) & 0xF) /* bits 8-11 */
298 #define EEPROM_RF_CFG_RX_ANT_MSK(x) ((x >> 12) & 0xF) /* bits 12-15 */
300 #define EEPROM_3945_RF_CFG_TYPE_MAX 0x0
301 #define EEPROM_4965_RF_CFG_TYPE_MAX 0x1
302 #define EEPROM_5000_RF_CFG_TYPE_MAX 0x3
305 * Per-channel regulatory data.
307 * Each channel that *might* be supported by iwl has a fixed location
308 * in EEPROM containing EEPROM_CHANNEL_* usage flags (LSB) and max regulatory
311 * Entries immediately below are for 20 MHz channel width. FAT (40 MHz)
312 * channels (only for 4965, not supported by 3945) appear later in the EEPROM.
314 * 2.4 GHz channels 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14
316 #define EEPROM_REGULATORY_SKU_ID (2*0x60) /* 4 bytes */
317 #define EEPROM_REGULATORY_BAND_1 (2*0x62) /* 2 bytes */
318 #define EEPROM_REGULATORY_BAND_1_CHANNELS (2*0x63) /* 28 bytes */
321 * 4.9 GHz channels 183, 184, 185, 187, 188, 189, 192, 196,
322 * 5.0 GHz channels 7, 8, 11, 12, 16
323 * (4915-5080MHz) (none of these is ever supported)
325 #define EEPROM_REGULATORY_BAND_2 (2*0x71) /* 2 bytes */
326 #define EEPROM_REGULATORY_BAND_2_CHANNELS (2*0x72) /* 26 bytes */
329 * 5.2 GHz channels 34, 36, 38, 40, 42, 44, 46, 48, 52, 56, 60, 64
332 #define EEPROM_REGULATORY_BAND_3 (2*0x7F) /* 2 bytes */
333 #define EEPROM_REGULATORY_BAND_3_CHANNELS (2*0x80) /* 24 bytes */
336 * 5.5 GHz channels 100, 104, 108, 112, 116, 120, 124, 128, 132, 136, 140
339 #define EEPROM_REGULATORY_BAND_4 (2*0x8C) /* 2 bytes */
340 #define EEPROM_REGULATORY_BAND_4_CHANNELS (2*0x8D) /* 22 bytes */
343 * 5.7 GHz channels 145, 149, 153, 157, 161, 165
346 #define EEPROM_REGULATORY_BAND_5 (2*0x98) /* 2 bytes */
347 #define EEPROM_REGULATORY_BAND_5_CHANNELS (2*0x99) /* 12 bytes */
350 * 2.4 GHz FAT channels 1 (5), 2 (6), 3 (7), 4 (8), 5 (9), 6 (10), 7 (11)
352 * The channel listed is the center of the lower 20 MHz half of the channel.
353 * The overall center frequency is actually 2 channels (10 MHz) above that,
354 * and the upper half of each FAT channel is centered 4 channels (20 MHz) away
355 * from the lower half; e.g. the upper half of FAT channel 1 is channel 5,
356 * and the overall FAT channel width centers on channel 3.
358 * NOTE: The RXON command uses 20 MHz channel numbers to specify the
359 * control channel to which to tune. RXON also specifies whether the
360 * control channel is the upper or lower half of a FAT channel.
362 * NOTE: 4965 does not support FAT channels on 2.4 GHz.
364 #define EEPROM_4965_REGULATORY_BAND_24_FAT_CHANNELS (2*0xA0) /* 14 bytes */
367 * 5.2 GHz FAT channels 36 (40), 44 (48), 52 (56), 60 (64),
368 * 100 (104), 108 (112), 116 (120), 124 (128), 132 (136), 149 (153), 157 (161)
370 #define EEPROM_4965_REGULATORY_BAND_52_FAT_CHANNELS (2*0xA8) /* 22 bytes */
372 struct iwl_eeprom_ops
{
373 const u32 regulatory_bands
[7];
374 int (*verify_signature
) (struct iwl_priv
*priv
);
375 int (*acquire_semaphore
) (struct iwl_priv
*priv
);
376 void (*release_semaphore
) (struct iwl_priv
*priv
);
377 u16 (*calib_version
) (struct iwl_priv
*priv
);
378 const u8
* (*query_addr
) (const struct iwl_priv
*priv
, size_t offset
);
382 void iwl_eeprom_get_mac(const struct iwl_priv
*priv
, u8
*mac
);
383 int iwl_eeprom_init(struct iwl_priv
*priv
);
384 void iwl_eeprom_free(struct iwl_priv
*priv
);
385 int iwl_eeprom_check_version(struct iwl_priv
*priv
);
386 const u8
*iwl_eeprom_query_addr(const struct iwl_priv
*priv
, size_t offset
);
387 u16
iwl_eeprom_query16(const struct iwl_priv
*priv
, size_t offset
);
389 int iwlcore_eeprom_verify_signature(struct iwl_priv
*priv
);
390 int iwlcore_eeprom_acquire_semaphore(struct iwl_priv
*priv
);
391 void iwlcore_eeprom_release_semaphore(struct iwl_priv
*priv
);
392 const u8
*iwlcore_eeprom_query_addr(const struct iwl_priv
*priv
, size_t offset
);
394 int iwl_init_channel_map(struct iwl_priv
*priv
);
395 void iwl_free_channel_map(struct iwl_priv
*priv
);
396 const struct iwl_channel_info
*iwl_get_channel_info(
397 const struct iwl_priv
*priv
,
398 enum ieee80211_band band
, u16 channel
);
400 #endif /* __iwl_eeprom_h__ */