diff options
Diffstat (limited to 'drivers/net/wireless/iwlegacy/iwl-eeprom.h')
-rw-r--r-- | drivers/net/wireless/iwlegacy/iwl-eeprom.h | 344 |
1 files changed, 344 insertions, 0 deletions
diff --git a/drivers/net/wireless/iwlegacy/iwl-eeprom.h b/drivers/net/wireless/iwlegacy/iwl-eeprom.h new file mode 100644 index 00000000000..c59c8100202 --- /dev/null +++ b/drivers/net/wireless/iwlegacy/iwl-eeprom.h | |||
@@ -0,0 +1,344 @@ | |||
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 | #ifndef __iwl_legacy_eeprom_h__ | ||
64 | #define __iwl_legacy_eeprom_h__ | ||
65 | |||
66 | #include <net/mac80211.h> | ||
67 | |||
68 | struct iwl_priv; | ||
69 | |||
70 | /* | ||
71 | * EEPROM access time values: | ||
72 | * | ||
73 | * Driver initiates EEPROM read by writing byte address << 1 to CSR_EEPROM_REG. | ||
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 | |||
80 | #define IWL_EEPROM_SEM_TIMEOUT 10 /* microseconds */ | ||
81 | #define IWL_EEPROM_SEM_RETRY_LIMIT 1000 /* number of attempts (not time) */ | ||
82 | |||
83 | |||
84 | /* | ||
85 | * Regulatory channel usage flags in EEPROM struct iwl4965_eeprom_channel.flags. | ||
86 | * | ||
87 | * IBSS and/or AP operation is allowed *only* on those channels with | ||
88 | * (VALID && IBSS && ACTIVE && !RADAR). This restriction is in place because | ||
89 | * RADAR detection is not supported by the 4965 driver, but is a | ||
90 | * requirement for establishing a new network for legal operation on channels | ||
91 | * requiring RADAR detection or restricting ACTIVE scanning. | ||
92 | * | ||
93 | * NOTE: "WIDE" flag does not indicate anything about "HT40" 40 MHz channels. | ||
94 | * It only indicates that 20 MHz channel use is supported; HT40 channel | ||
95 | * usage is indicated by a separate set of regulatory flags for each | ||
96 | * HT40 channel pair. | ||
97 | * | ||
98 | * NOTE: Using a channel inappropriately will result in a uCode error! | ||
99 | */ | ||
100 | #define IWL_NUM_TX_CALIB_GROUPS 5 | ||
101 | enum { | ||
102 | EEPROM_CHANNEL_VALID = (1 << 0), /* usable for this SKU/geo */ | ||
103 | EEPROM_CHANNEL_IBSS = (1 << 1), /* usable as an IBSS channel */ | ||
104 | /* Bit 2 Reserved */ | ||
105 | EEPROM_CHANNEL_ACTIVE = (1 << 3), /* active scanning allowed */ | ||
106 | EEPROM_CHANNEL_RADAR = (1 << 4), /* radar detection required */ | ||
107 | EEPROM_CHANNEL_WIDE = (1 << 5), /* 20 MHz channel okay */ | ||
108 | /* Bit 6 Reserved (was Narrow Channel) */ | ||
109 | EEPROM_CHANNEL_DFS = (1 << 7), /* dynamic freq selection candidate */ | ||
110 | }; | ||
111 | |||
112 | /* SKU Capabilities */ | ||
113 | /* 3945 only */ | ||
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 HT40 (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 | } __packed; | ||
123 | |||
124 | /* 3945 Specific */ | ||
125 | #define EEPROM_3945_EEPROM_VERSION (0x2f) | ||
126 | |||
127 | /* 4965 has two radio transmitters (and 3 radio receivers) */ | ||
128 | #define EEPROM_TX_POWER_TX_CHAINS (2) | ||
129 | |||
130 | /* 4965 has room for up to 8 sets of txpower calibration data */ | ||
131 | #define EEPROM_TX_POWER_BANDS (8) | ||
132 | |||
133 | /* 4965 factory calibration measures txpower gain settings for | ||
134 | * each of 3 target output levels */ | ||
135 | #define EEPROM_TX_POWER_MEASUREMENTS (3) | ||
136 | |||
137 | /* 4965 Specific */ | ||
138 | /* 4965 driver does not work with txpower calibration version < 5 */ | ||
139 | #define EEPROM_4965_TX_POWER_VERSION (5) | ||
140 | #define EEPROM_4965_EEPROM_VERSION (0x2f) | ||
141 | #define EEPROM_4965_CALIB_VERSION_OFFSET (2*0xB6) /* 2 bytes */ | ||
142 | #define EEPROM_4965_CALIB_TXPOWER_OFFSET (2*0xE8) /* 48 bytes */ | ||
143 | #define EEPROM_4965_BOARD_REVISION (2*0x4F) /* 2 bytes */ | ||
144 | #define EEPROM_4965_BOARD_PBA (2*0x56+1) /* 9 bytes */ | ||
145 | |||
146 | /* 2.4 GHz */ | ||
147 | extern const u8 iwlegacy_eeprom_band_1[14]; | ||
148 | |||
149 | /* | ||
150 | * factory calibration data for one txpower level, on one channel, | ||
151 | * measured on one of the 2 tx chains (radio transmitter and associated | ||
152 | * antenna). EEPROM contains: | ||
153 | * | ||
154 | * 1) Temperature (degrees Celsius) of device when measurement was made. | ||
155 | * | ||
156 | * 2) Gain table index used to achieve the target measurement power. | ||
157 | * This refers to the "well-known" gain tables (see iwl-4965-hw.h). | ||
158 | * | ||
159 | * 3) Actual measured output power, in half-dBm ("34" = 17 dBm). | ||
160 | * | ||
161 | * 4) RF power amplifier detector level measurement (not used). | ||
162 | */ | ||
163 | struct iwl_eeprom_calib_measure { | ||
164 | u8 temperature; /* Device temperature (Celsius) */ | ||
165 | u8 gain_idx; /* Index into gain table */ | ||
166 | u8 actual_pow; /* Measured RF output power, half-dBm */ | ||
167 | s8 pa_det; /* Power amp detector level (not used) */ | ||
168 | } __packed; | ||
169 | |||
170 | |||
171 | /* | ||
172 | * measurement set for one channel. EEPROM contains: | ||
173 | * | ||
174 | * 1) Channel number measured | ||
175 | * | ||
176 | * 2) Measurements for each of 3 power levels for each of 2 radio transmitters | ||
177 | * (a.k.a. "tx chains") (6 measurements altogether) | ||
178 | */ | ||
179 | struct iwl_eeprom_calib_ch_info { | ||
180 | u8 ch_num; | ||
181 | struct iwl_eeprom_calib_measure | ||
182 | measurements[EEPROM_TX_POWER_TX_CHAINS] | ||
183 | [EEPROM_TX_POWER_MEASUREMENTS]; | ||
184 | } __packed; | ||
185 | |||
186 | /* | ||
187 | * txpower subband info. | ||
188 | * | ||
189 | * For each frequency subband, EEPROM contains the following: | ||
190 | * | ||
191 | * 1) First and last channels within range of the subband. "0" values | ||
192 | * indicate that this sample set is not being used. | ||
193 | * | ||
194 | * 2) Sample measurement sets for 2 channels close to the range endpoints. | ||
195 | */ | ||
196 | struct iwl_eeprom_calib_subband_info { | ||
197 | u8 ch_from; /* channel number of lowest channel in subband */ | ||
198 | u8 ch_to; /* channel number of highest channel in subband */ | ||
199 | struct iwl_eeprom_calib_ch_info ch1; | ||
200 | struct iwl_eeprom_calib_ch_info ch2; | ||
201 | } __packed; | ||
202 | |||
203 | |||
204 | /* | ||
205 | * txpower calibration info. EEPROM contains: | ||
206 | * | ||
207 | * 1) Factory-measured saturation power levels (maximum levels at which | ||
208 | * tx power amplifier can output a signal without too much distortion). | ||
209 | * There is one level for 2.4 GHz band and one for 5 GHz band. These | ||
210 | * values apply to all channels within each of the bands. | ||
211 | * | ||
212 | * 2) Factory-measured power supply voltage level. This is assumed to be | ||
213 | * constant (i.e. same value applies to all channels/bands) while the | ||
214 | * factory measurements are being made. | ||
215 | * | ||
216 | * 3) Up to 8 sets of factory-measured txpower calibration values. | ||
217 | * These are for different frequency ranges, since txpower gain | ||
218 | * characteristics of the analog radio circuitry vary with frequency. | ||
219 | * | ||
220 | * Not all sets need to be filled with data; | ||
221 | * struct iwl_eeprom_calib_subband_info contains range of channels | ||
222 | * (0 if unused) for each set of data. | ||
223 | */ | ||
224 | struct iwl_eeprom_calib_info { | ||
225 | u8 saturation_power24; /* half-dBm (e.g. "34" = 17 dBm) */ | ||
226 | u8 saturation_power52; /* half-dBm */ | ||
227 | __le16 voltage; /* signed */ | ||
228 | struct iwl_eeprom_calib_subband_info | ||
229 | band_info[EEPROM_TX_POWER_BANDS]; | ||
230 | } __packed; | ||
231 | |||
232 | |||
233 | /* General */ | ||
234 | #define EEPROM_DEVICE_ID (2*0x08) /* 2 bytes */ | ||
235 | #define EEPROM_MAC_ADDRESS (2*0x15) /* 6 bytes */ | ||
236 | #define EEPROM_BOARD_REVISION (2*0x35) /* 2 bytes */ | ||
237 | #define EEPROM_BOARD_PBA_NUMBER (2*0x3B+1) /* 9 bytes */ | ||
238 | #define EEPROM_VERSION (2*0x44) /* 2 bytes */ | ||
239 | #define EEPROM_SKU_CAP (2*0x45) /* 2 bytes */ | ||
240 | #define EEPROM_OEM_MODE (2*0x46) /* 2 bytes */ | ||
241 | #define EEPROM_WOWLAN_MODE (2*0x47) /* 2 bytes */ | ||
242 | #define EEPROM_RADIO_CONFIG (2*0x48) /* 2 bytes */ | ||
243 | #define EEPROM_NUM_MAC_ADDRESS (2*0x4C) /* 2 bytes */ | ||
244 | |||
245 | /* The following masks are to be applied on EEPROM_RADIO_CONFIG */ | ||
246 | #define EEPROM_RF_CFG_TYPE_MSK(x) (x & 0x3) /* bits 0-1 */ | ||
247 | #define EEPROM_RF_CFG_STEP_MSK(x) ((x >> 2) & 0x3) /* bits 2-3 */ | ||
248 | #define EEPROM_RF_CFG_DASH_MSK(x) ((x >> 4) & 0x3) /* bits 4-5 */ | ||
249 | #define EEPROM_RF_CFG_PNUM_MSK(x) ((x >> 6) & 0x3) /* bits 6-7 */ | ||
250 | #define EEPROM_RF_CFG_TX_ANT_MSK(x) ((x >> 8) & 0xF) /* bits 8-11 */ | ||
251 | #define EEPROM_RF_CFG_RX_ANT_MSK(x) ((x >> 12) & 0xF) /* bits 12-15 */ | ||
252 | |||
253 | #define EEPROM_3945_RF_CFG_TYPE_MAX 0x0 | ||
254 | #define EEPROM_4965_RF_CFG_TYPE_MAX 0x1 | ||
255 | |||
256 | /* | ||
257 | * Per-channel regulatory data. | ||
258 | * | ||
259 | * Each channel that *might* be supported by iwl has a fixed location | ||
260 | * in EEPROM containing EEPROM_CHANNEL_* usage flags (LSB) and max regulatory | ||
261 | * txpower (MSB). | ||
262 | * | ||
263 | * Entries immediately below are for 20 MHz channel width. HT40 (40 MHz) | ||
264 | * channels (only for 4965, not supported by 3945) appear later in the EEPROM. | ||
265 | * | ||
266 | * 2.4 GHz channels 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14 | ||
267 | */ | ||
268 | #define EEPROM_REGULATORY_SKU_ID (2*0x60) /* 4 bytes */ | ||
269 | #define EEPROM_REGULATORY_BAND_1 (2*0x62) /* 2 bytes */ | ||
270 | #define EEPROM_REGULATORY_BAND_1_CHANNELS (2*0x63) /* 28 bytes */ | ||
271 | |||
272 | /* | ||
273 | * 4.9 GHz channels 183, 184, 185, 187, 188, 189, 192, 196, | ||
274 | * 5.0 GHz channels 7, 8, 11, 12, 16 | ||
275 | * (4915-5080MHz) (none of these is ever supported) | ||
276 | */ | ||
277 | #define EEPROM_REGULATORY_BAND_2 (2*0x71) /* 2 bytes */ | ||
278 | #define EEPROM_REGULATORY_BAND_2_CHANNELS (2*0x72) /* 26 bytes */ | ||
279 | |||
280 | /* | ||
281 | * 5.2 GHz channels 34, 36, 38, 40, 42, 44, 46, 48, 52, 56, 60, 64 | ||
282 | * (5170-5320MHz) | ||
283 | */ | ||
284 | #define EEPROM_REGULATORY_BAND_3 (2*0x7F) /* 2 bytes */ | ||
285 | #define EEPROM_REGULATORY_BAND_3_CHANNELS (2*0x80) /* 24 bytes */ | ||
286 | |||
287 | /* | ||
288 | * 5.5 GHz channels 100, 104, 108, 112, 116, 120, 124, 128, 132, 136, 140 | ||
289 | * (5500-5700MHz) | ||
290 | */ | ||
291 | #define EEPROM_REGULATORY_BAND_4 (2*0x8C) /* 2 bytes */ | ||
292 | #define EEPROM_REGULATORY_BAND_4_CHANNELS (2*0x8D) /* 22 bytes */ | ||
293 | |||
294 | /* | ||
295 | * 5.7 GHz channels 145, 149, 153, 157, 161, 165 | ||
296 | * (5725-5825MHz) | ||
297 | */ | ||
298 | #define EEPROM_REGULATORY_BAND_5 (2*0x98) /* 2 bytes */ | ||
299 | #define EEPROM_REGULATORY_BAND_5_CHANNELS (2*0x99) /* 12 bytes */ | ||
300 | |||
301 | /* | ||
302 | * 2.4 GHz HT40 channels 1 (5), 2 (6), 3 (7), 4 (8), 5 (9), 6 (10), 7 (11) | ||
303 | * | ||
304 | * The channel listed is the center of the lower 20 MHz half of the channel. | ||
305 | * The overall center frequency is actually 2 channels (10 MHz) above that, | ||
306 | * and the upper half of each HT40 channel is centered 4 channels (20 MHz) away | ||
307 | * from the lower half; e.g. the upper half of HT40 channel 1 is channel 5, | ||
308 | * and the overall HT40 channel width centers on channel 3. | ||
309 | * | ||
310 | * NOTE: The RXON command uses 20 MHz channel numbers to specify the | ||
311 | * control channel to which to tune. RXON also specifies whether the | ||
312 | * control channel is the upper or lower half of a HT40 channel. | ||
313 | * | ||
314 | * NOTE: 4965 does not support HT40 channels on 2.4 GHz. | ||
315 | */ | ||
316 | #define EEPROM_4965_REGULATORY_BAND_24_HT40_CHANNELS (2*0xA0) /* 14 bytes */ | ||
317 | |||
318 | /* | ||
319 | * 5.2 GHz HT40 channels 36 (40), 44 (48), 52 (56), 60 (64), | ||
320 | * 100 (104), 108 (112), 116 (120), 124 (128), 132 (136), 149 (153), 157 (161) | ||
321 | */ | ||
322 | #define EEPROM_4965_REGULATORY_BAND_52_HT40_CHANNELS (2*0xA8) /* 22 bytes */ | ||
323 | |||
324 | #define EEPROM_REGULATORY_BAND_NO_HT40 (0) | ||
325 | |||
326 | struct iwl_eeprom_ops { | ||
327 | const u32 regulatory_bands[7]; | ||
328 | int (*acquire_semaphore) (struct iwl_priv *priv); | ||
329 | void (*release_semaphore) (struct iwl_priv *priv); | ||
330 | }; | ||
331 | |||
332 | |||
333 | int iwl_legacy_eeprom_init(struct iwl_priv *priv); | ||
334 | void iwl_legacy_eeprom_free(struct iwl_priv *priv); | ||
335 | const u8 *iwl_legacy_eeprom_query_addr(const struct iwl_priv *priv, | ||
336 | size_t offset); | ||
337 | u16 iwl_legacy_eeprom_query16(const struct iwl_priv *priv, size_t offset); | ||
338 | int iwl_legacy_init_channel_map(struct iwl_priv *priv); | ||
339 | void iwl_legacy_free_channel_map(struct iwl_priv *priv); | ||
340 | const struct iwl_channel_info *iwl_legacy_get_channel_info( | ||
341 | const struct iwl_priv *priv, | ||
342 | enum ieee80211_band band, u16 channel); | ||
343 | |||
344 | #endif /* __iwl_legacy_eeprom_h__ */ | ||