aboutsummaryrefslogtreecommitdiffstats
path: root/drivers/net/wireless/iwlwifi/iwl-eeprom.h
diff options
context:
space:
mode:
Diffstat (limited to 'drivers/net/wireless/iwlwifi/iwl-eeprom.h')
-rw-r--r--drivers/net/wireless/iwlwifi/iwl-eeprom.h375
1 files changed, 375 insertions, 0 deletions
diff --git a/drivers/net/wireless/iwlwifi/iwl-eeprom.h b/drivers/net/wireless/iwlwifi/iwl-eeprom.h
new file mode 100644
index 000000000000..bd0a042ca77f
--- /dev/null
+++ b/drivers/net/wireless/iwlwifi/iwl-eeprom.h
@@ -0,0 +1,375 @@
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
66struct 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
102enum {
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 EEPROM_CHANNEL_NARROW = (1 << 6), /* 10 MHz channel (not used) */
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. */
119struct iwl4965_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#define EEPROM_4965_TX_POWER_VERSION (2)
135
136/* 4965 driver does not work with txpower calibration version < 5.
137 * Look for this in calib_version member of struct iwl4965_eeprom. */
138#define EEPROM_TX_POWER_VERSION_NEW (5)
139
140/* 2.4 GHz */
141extern const u8 iwl_eeprom_band_1[14];
142
143/*
144 * 4965 factory calibration data for one txpower level, on one channel,
145 * measured on one of the 2 tx chains (radio transmitter and associated
146 * antenna). EEPROM contains:
147 *
148 * 1) Temperature (degrees Celsius) of device when measurement was made.
149 *
150 * 2) Gain table index used to achieve the target measurement power.
151 * This refers to the "well-known" gain tables (see iwl-4965-hw.h).
152 *
153 * 3) Actual measured output power, in half-dBm ("34" = 17 dBm).
154 *
155 * 4) RF power amplifier detector level measurement (not used).
156 */
157struct iwl4965_eeprom_calib_measure {
158 u8 temperature; /* Device temperature (Celsius) */
159 u8 gain_idx; /* Index into gain table */
160 u8 actual_pow; /* Measured RF output power, half-dBm */
161 s8 pa_det; /* Power amp detector level (not used) */
162} __attribute__ ((packed));
163
164
165/*
166 * 4965 measurement set for one channel. EEPROM contains:
167 *
168 * 1) Channel number measured
169 *
170 * 2) Measurements for each of 3 power levels for each of 2 radio transmitters
171 * (a.k.a. "tx chains") (6 measurements altogether)
172 */
173struct iwl4965_eeprom_calib_ch_info {
174 u8 ch_num;
175 struct iwl4965_eeprom_calib_measure
176 measurements[EEPROM_TX_POWER_TX_CHAINS]
177 [EEPROM_TX_POWER_MEASUREMENTS];
178} __attribute__ ((packed));
179
180/*
181 * 4965 txpower subband info.
182 *
183 * For each frequency subband, EEPROM contains the following:
184 *
185 * 1) First and last channels within range of the subband. "0" values
186 * indicate that this sample set is not being used.
187 *
188 * 2) Sample measurement sets for 2 channels close to the range endpoints.
189 */
190struct iwl4965_eeprom_calib_subband_info {
191 u8 ch_from; /* channel number of lowest channel in subband */
192 u8 ch_to; /* channel number of highest channel in subband */
193 struct iwl4965_eeprom_calib_ch_info ch1;
194 struct iwl4965_eeprom_calib_ch_info ch2;
195} __attribute__ ((packed));
196
197
198/*
199 * 4965 txpower calibration info. EEPROM contains:
200 *
201 * 1) Factory-measured saturation power levels (maximum levels at which
202 * tx power amplifier can output a signal without too much distortion).
203 * There is one level for 2.4 GHz band and one for 5 GHz band. These
204 * values apply to all channels within each of the bands.
205 *
206 * 2) Factory-measured power supply voltage level. This is assumed to be
207 * constant (i.e. same value applies to all channels/bands) while the
208 * factory measurements are being made.
209 *
210 * 3) Up to 8 sets of factory-measured txpower calibration values.
211 * These are for different frequency ranges, since txpower gain
212 * characteristics of the analog radio circuitry vary with frequency.
213 *
214 * Not all sets need to be filled with data;
215 * struct iwl4965_eeprom_calib_subband_info contains range of channels
216 * (0 if unused) for each set of data.
217 */
218struct iwl4965_eeprom_calib_info {
219 u8 saturation_power24; /* half-dBm (e.g. "34" = 17 dBm) */
220 u8 saturation_power52; /* half-dBm */
221 s16 voltage; /* signed */
222 struct iwl4965_eeprom_calib_subband_info
223 band_info[EEPROM_TX_POWER_BANDS];
224} __attribute__ ((packed));
225
226
227
228/*
229 * 4965 EEPROM map
230 */
231struct iwl4965_eeprom {
232 u8 reserved0[16];
233 u16 device_id; /* abs.ofs: 16 */
234 u8 reserved1[2];
235 u16 pmc; /* abs.ofs: 20 */
236 u8 reserved2[20];
237 u8 mac_address[6]; /* abs.ofs: 42 */
238 u8 reserved3[58];
239 u16 board_revision; /* abs.ofs: 106 */
240 u8 reserved4[11];
241 u8 board_pba_number[9]; /* abs.ofs: 119 */
242 u8 reserved5[8];
243 u16 version; /* abs.ofs: 136 */
244 u8 sku_cap; /* abs.ofs: 138 */
245 u8 leds_mode; /* abs.ofs: 139 */
246 u16 oem_mode;
247 u16 wowlan_mode; /* abs.ofs: 142 */
248 u16 leds_time_interval; /* abs.ofs: 144 */
249 u8 leds_off_time; /* abs.ofs: 146 */
250 u8 leds_on_time; /* abs.ofs: 147 */
251 u8 almgor_m_version; /* abs.ofs: 148 */
252 u8 antenna_switch_type; /* abs.ofs: 149 */
253 u8 reserved6[8];
254 u16 board_revision_4965; /* abs.ofs: 158 */
255 u8 reserved7[13];
256 u8 board_pba_number_4965[9]; /* abs.ofs: 173 */
257 u8 reserved8[10];
258 u8 sku_id[4]; /* abs.ofs: 192 */
259
260/*
261 * Per-channel regulatory data.
262 *
263 * Each channel that *might* be supported by 3945 or 4965 has a fixed location
264 * in EEPROM containing EEPROM_CHANNEL_* usage flags (LSB) and max regulatory
265 * txpower (MSB).
266 *
267 * Entries immediately below are for 20 MHz channel width. FAT (40 MHz)
268 * channels (only for 4965, not supported by 3945) appear later in the EEPROM.
269 *
270 * 2.4 GHz channels 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14
271 */
272 u16 band_1_count; /* abs.ofs: 196 */
273 struct iwl4965_eeprom_channel band_1_channels[14]; /* abs.ofs: 196 */
274
275/*
276 * 4.9 GHz channels 183, 184, 185, 187, 188, 189, 192, 196,
277 * 5.0 GHz channels 7, 8, 11, 12, 16
278 * (4915-5080MHz) (none of these is ever supported)
279 */
280 u16 band_2_count; /* abs.ofs: 226 */
281 struct iwl4965_eeprom_channel band_2_channels[13]; /* abs.ofs: 228 */
282
283/*
284 * 5.2 GHz channels 34, 36, 38, 40, 42, 44, 46, 48, 52, 56, 60, 64
285 * (5170-5320MHz)
286 */
287 u16 band_3_count; /* abs.ofs: 254 */
288 struct iwl4965_eeprom_channel band_3_channels[12]; /* abs.ofs: 256 */
289
290/*
291 * 5.5 GHz channels 100, 104, 108, 112, 116, 120, 124, 128, 132, 136, 140
292 * (5500-5700MHz)
293 */
294 u16 band_4_count; /* abs.ofs: 280 */
295 struct iwl4965_eeprom_channel band_4_channels[11]; /* abs.ofs: 282 */
296
297/*
298 * 5.7 GHz channels 145, 149, 153, 157, 161, 165
299 * (5725-5825MHz)
300 */
301 u16 band_5_count; /* abs.ofs: 304 */
302 struct iwl4965_eeprom_channel band_5_channels[6]; /* abs.ofs: 306 */
303
304 u8 reserved10[2];
305
306
307/*
308 * 2.4 GHz FAT channels 1 (5), 2 (6), 3 (7), 4 (8), 5 (9), 6 (10), 7 (11)
309 *
310 * The channel listed is the center of the lower 20 MHz half of the channel.
311 * The overall center frequency is actually 2 channels (10 MHz) above that,
312 * and the upper half of each FAT channel is centered 4 channels (20 MHz) away
313 * from the lower half; e.g. the upper half of FAT channel 1 is channel 5,
314 * and the overall FAT channel width centers on channel 3.
315 *
316 * NOTE: The RXON command uses 20 MHz channel numbers to specify the
317 * control channel to which to tune. RXON also specifies whether the
318 * control channel is the upper or lower half of a FAT channel.
319 *
320 * NOTE: 4965 does not support FAT channels on 2.4 GHz.
321 */
322 struct iwl4965_eeprom_channel band_24_channels[7]; /* abs.ofs: 320 */
323 u8 reserved11[2];
324
325/*
326 * 5.2 GHz FAT channels 36 (40), 44 (48), 52 (56), 60 (64),
327 * 100 (104), 108 (112), 116 (120), 124 (128), 132 (136), 149 (153), 157 (161)
328 */
329 struct iwl4965_eeprom_channel band_52_channels[11]; /* abs.ofs: 336 */
330 u8 reserved12[6];
331
332/*
333 * 4965 driver requires txpower calibration format version 5 or greater.
334 * Driver does not work with txpower calibration version < 5.
335 * This value is simply a 16-bit number, no major/minor versions here.
336 */
337 u16 calib_version; /* abs.ofs: 364 */
338 u8 reserved13[2];
339 u8 reserved14[96]; /* abs.ofs: 368 */
340
341/*
342 * 4965 Txpower calibration data.
343 */
344 struct iwl4965_eeprom_calib_info calib_info; /* abs.ofs: 464 */
345
346 u8 reserved16[140]; /* fill out to full 1024 byte block */
347
348
349} __attribute__ ((packed));
350
351#define IWL_EEPROM_IMAGE_SIZE 1024
352
353/* End of EEPROM */
354
355struct iwl_eeprom_ops {
356 int (*verify_signature) (struct iwl_priv *priv);
357 int (*acquire_semaphore) (struct iwl_priv *priv);
358 void (*release_semaphore) (struct iwl_priv *priv);
359};
360
361
362void iwl_eeprom_get_mac(const struct iwl_priv *priv, u8 *mac);
363int iwl_eeprom_init(struct iwl_priv *priv);
364
365int iwlcore_eeprom_verify_signature(struct iwl_priv *priv);
366int iwlcore_eeprom_acquire_semaphore(struct iwl_priv *priv);
367void iwlcore_eeprom_release_semaphore(struct iwl_priv *priv);
368
369int iwl_init_channel_map(struct iwl_priv *priv);
370void iwl_free_channel_map(struct iwl_priv *priv);
371const struct iwl_channel_info *iwl_get_channel_info(
372 const struct iwl_priv *priv,
373 enum ieee80211_band band, u16 channel);
374
375#endif /* __iwl_eeprom_h__ */