blob: 98aa8af01192bbe561b1bbf97d208dd3bdd5a54f [file] [log] [blame]
Assaf Krauss34cf6ff2008-03-06 10:40:20 -08001/******************************************************************************
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 *
Reinette Chatre1f447802010-01-15 13:43:41 -08008 * Copyright(c) 2008 - 2010 Intel Corporation. All rights reserved.
Assaf Krauss34cf6ff2008-03-06 10:40:20 -08009 *
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:
Winkler, Tomas759ef892008-12-09 11:28:58 -080028 * Intel Linux Wireless <ilw@linux.intel.com>
Assaf Krauss34cf6ff2008-03-06 10:40:20 -080029 * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
30 *
31 * BSD LICENSE
32 *
Reinette Chatre1f447802010-01-15 13:43:41 -080033 * Copyright(c) 2005 - 2010 Intel Corporation. All rights reserved.
Assaf Krauss34cf6ff2008-03-06 10:40:20 -080034 * 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
Johannes Bergbe1a71a2009-10-02 13:44:02 -070066#include <net/mac80211.h>
67
Tomas Winklerc79dd5b2008-03-12 16:58:50 -070068struct iwl_priv;
Assaf Krauss34cf6ff2008-03-06 10:40:20 -080069
70/*
71 * EEPROM access time values:
72 *
Zhu, Yi3d5717a2008-12-11 10:33:36 -080073 * Driver initiates EEPROM read by writing byte address << 1 to CSR_EEPROM_REG.
Assaf Krauss34cf6ff2008-03-06 10:40:20 -080074 * 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 */
Assaf Krauss34cf6ff2008-03-06 10:40:20 -080079
Zhu, Yi3d5717a2008-12-11 10:33:36 -080080#define IWL_EEPROM_SEM_TIMEOUT 10 /* microseconds */
Assaf Krauss34cf6ff2008-03-06 10:40:20 -080081#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 *
Wey-Yi Guy7aafef12009-08-07 15:41:38 -070093 * 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
Assaf Krauss34cf6ff2008-03-06 10:40:20 -080095 * usage is indicated by a separate set of regulatory flags for each
Wey-Yi Guy7aafef12009-08-07 15:41:38 -070096 * HT40 channel pair.
Assaf Krauss34cf6ff2008-03-06 10:40:20 -080097 *
98 * NOTE: Using a channel inappropriately will result in a uCode error!
99 */
100#define IWL_NUM_TX_CALIB_GROUPS 5
101enum {
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 */
Guy Cohenfe7c4042008-04-21 15:41:56 -0700108 /* Bit 6 Reserved (was Narrow Channel) */
Assaf Krauss34cf6ff2008-03-06 10:40:20 -0800109 EEPROM_CHANNEL_DFS = (1 << 7), /* dynamic freq selection candidate */
110};
111
112/* SKU Capabilities */
Wey-Yi Guy21a5b3c2010-11-10 13:32:59 -0800113/* 3945 only */
Assaf Krauss34cf6ff2008-03-06 10:40:20 -0800114#define EEPROM_SKU_CAP_SW_RF_KILL_ENABLE (1 << 0)
115#define EEPROM_SKU_CAP_HW_RF_KILL_ENABLE (1 << 1)
116
Wey-Yi Guy21a5b3c2010-11-10 13:32:59 -0800117/* 5000 and up */
118#define EEPROM_SKU_CAP_BAND_POS (4)
119#define EEPROM_SKU_CAP_BAND_SELECTION \
120 (3 << EEPROM_SKU_CAP_BAND_POS)
121#define EEPROM_SKU_CAP_11N_ENABLE (1 << 6)
122#define EEPROM_SKU_CAP_AMT_ENABLE (1 << 7)
123#define EEPROM_SKU_CAP_IPAN_ENABLE (1 << 8)
124
Assaf Krauss34cf6ff2008-03-06 10:40:20 -0800125/* *regulatory* channel data format in eeprom, one for each channel.
Wey-Yi Guy7aafef12009-08-07 15:41:38 -0700126 * There are separate entries for HT40 (40 MHz) vs. normal (20 MHz) channels. */
Tomas Winkler073d3f52008-04-21 15:41:52 -0700127struct iwl_eeprom_channel {
Assaf Krauss34cf6ff2008-03-06 10:40:20 -0800128 u8 flags; /* EEPROM_CHANNEL_* flags copied from EEPROM */
129 s8 max_power_avg; /* max power (dBm) on this chnl, limit 31 */
Eric Dumazetba2d3582010-06-02 18:10:09 +0000130} __packed;
Assaf Krauss34cf6ff2008-03-06 10:40:20 -0800131
Johannes Berg8d6748c2010-12-09 09:30:14 -0800132enum iwl_eeprom_enhanced_txpwr_flags {
133 IWL_EEPROM_ENH_TXP_FL_VALID = BIT(0),
134 IWL_EEPROM_ENH_TXP_FL_BAND_52G = BIT(1),
135 IWL_EEPROM_ENH_TXP_FL_OFDM = BIT(2),
136 IWL_EEPROM_ENH_TXP_FL_40MHZ = BIT(3),
137 IWL_EEPROM_ENH_TXP_FL_HT_AP = BIT(4),
138 IWL_EEPROM_ENH_TXP_FL_RES1 = BIT(5),
139 IWL_EEPROM_ENH_TXP_FL_RES2 = BIT(6),
140 IWL_EEPROM_ENH_TXP_FL_COMMON_TYPE = BIT(7),
141};
142
Wey-Yi Guyab9fd1b2009-08-21 13:34:23 -0700143/**
144 * iwl_eeprom_enhanced_txpwr structure
145 * This structure presents the enhanced regulatory tx power limit layout
146 * in eeprom image
147 * Enhanced regulatory tx power portion of eeprom image can be broken down
148 * into individual structures; each one is 8 bytes in size and contain the
149 * following information
Johannes Berge7362a02010-11-30 11:03:44 -0800150 * @flags: entry flags
151 * @channel: channel number
Wey-Yi Guyab9fd1b2009-08-21 13:34:23 -0700152 * @chain_a_max_pwr: chain a max power in 1/2 dBm
153 * @chain_b_max_pwr: chain b max power in 1/2 dBm
154 * @chain_c_max_pwr: chain c max power in 1/2 dBm
Johannes Berge7362a02010-11-30 11:03:44 -0800155 * @delta_20_in_40: 20-in-40 deltas (hi/lo)
Wey-Yi Guyab9fd1b2009-08-21 13:34:23 -0700156 * @mimo2_max_pwr: mimo2 max power in 1/2 dBm
157 * @mimo3_max_pwr: mimo3 max power in 1/2 dBm
158 *
159 */
160struct iwl_eeprom_enhanced_txpwr {
Johannes Berge7362a02010-11-30 11:03:44 -0800161 u8 flags;
162 u8 channel;
Wey-Yi Guyab9fd1b2009-08-21 13:34:23 -0700163 s8 chain_a_max;
164 s8 chain_b_max;
165 s8 chain_c_max;
Johannes Berge7362a02010-11-30 11:03:44 -0800166 u8 delta_20_in_40;
Wey-Yi Guyab9fd1b2009-08-21 13:34:23 -0700167 s8 mimo2_max;
168 s8 mimo3_max;
Eric Dumazetba2d3582010-06-02 18:10:09 +0000169} __packed;
Wey-Yi Guyab9fd1b2009-08-21 13:34:23 -0700170
Samuel Ortize6148912009-01-23 13:45:15 -0800171/* 3945 Specific */
172#define EEPROM_3945_EEPROM_VERSION (0x2f)
173
Assaf Krauss34cf6ff2008-03-06 10:40:20 -0800174/* 4965 has two radio transmitters (and 3 radio receivers) */
175#define EEPROM_TX_POWER_TX_CHAINS (2)
176
177/* 4965 has room for up to 8 sets of txpower calibration data */
178#define EEPROM_TX_POWER_BANDS (8)
179
180/* 4965 factory calibration measures txpower gain settings for
181 * each of 3 target output levels */
182#define EEPROM_TX_POWER_MEASUREMENTS (3)
183
Tomas Winkler073d3f52008-04-21 15:41:52 -0700184/* 4965 Specific */
185/* 4965 driver does not work with txpower calibration version < 5 */
186#define EEPROM_4965_TX_POWER_VERSION (5)
Tomas Winkler8614f362008-04-23 17:14:55 -0700187#define EEPROM_4965_EEPROM_VERSION (0x2f)
Tomas Winkler073d3f52008-04-21 15:41:52 -0700188#define EEPROM_4965_CALIB_VERSION_OFFSET (2*0xB6) /* 2 bytes */
189#define EEPROM_4965_CALIB_TXPOWER_OFFSET (2*0xE8) /* 48 bytes */
190#define EEPROM_4965_BOARD_REVISION (2*0x4F) /* 2 bytes */
191#define EEPROM_4965_BOARD_PBA (2*0x56+1) /* 9 bytes */
Assaf Krauss34cf6ff2008-03-06 10:40:20 -0800192
Tomas Winklerf1f69412008-04-24 11:55:35 -0700193/* 5000 Specific */
194#define EEPROM_5000_TX_POWER_VERSION (4)
195#define EEPROM_5000_EEPROM_VERSION (0x11A)
196
Wey-Yi Guy7944f8e2010-04-06 21:10:33 -0700197/* 5000 and up calibration */
198#define EEPROM_CALIB_ALL (INDIRECT_ADDRESS | INDIRECT_CALIBRATION)
199#define EEPROM_XTAL ((2*0x128) | EEPROM_CALIB_ALL)
Tomas Winkler25ae3982008-04-24 11:55:27 -0700200
Wey-Yi Guy7944f8e2010-04-06 21:10:33 -0700201/* 5000 temperature */
202#define EEPROM_5000_TEMPERATURE ((2*0x12A) | EEPROM_CALIB_ALL)
Tomas Winkler25ae3982008-04-24 11:55:27 -0700203
Wey-Yi Guy7944f8e2010-04-06 21:10:33 -0700204/* agn links */
205#define EEPROM_LINK_HOST (2*0x64)
206#define EEPROM_LINK_GENERAL (2*0x65)
207#define EEPROM_LINK_REGULATORY (2*0x66)
208#define EEPROM_LINK_CALIBRATION (2*0x67)
209#define EEPROM_LINK_PROCESS_ADJST (2*0x68)
210#define EEPROM_LINK_OTHERS (2*0x69)
Johannes Berg8d6748c2010-12-09 09:30:14 -0800211#define EEPROM_LINK_TXP_LIMIT (2*0x6a)
212#define EEPROM_LINK_TXP_LIMIT_SIZE (2*0x6b)
Wey-Yi Guy7944f8e2010-04-06 21:10:33 -0700213
214/* agn regulatory - indirect access */
Wey-Yi Guye04ed0a2010-03-16 17:47:58 -0700215#define EEPROM_REG_BAND_1_CHANNELS ((0x08)\
Tomas Winkler25ae3982008-04-24 11:55:27 -0700216 | INDIRECT_ADDRESS | INDIRECT_REGULATORY) /* 28 bytes */
Wey-Yi Guye04ed0a2010-03-16 17:47:58 -0700217#define EEPROM_REG_BAND_2_CHANNELS ((0x26)\
Tomas Winkler25ae3982008-04-24 11:55:27 -0700218 | INDIRECT_ADDRESS | INDIRECT_REGULATORY) /* 26 bytes */
Wey-Yi Guye04ed0a2010-03-16 17:47:58 -0700219#define EEPROM_REG_BAND_3_CHANNELS ((0x42)\
Tomas Winkler25ae3982008-04-24 11:55:27 -0700220 | INDIRECT_ADDRESS | INDIRECT_REGULATORY) /* 24 bytes */
Wey-Yi Guye04ed0a2010-03-16 17:47:58 -0700221#define EEPROM_REG_BAND_4_CHANNELS ((0x5C)\
Tomas Winkler25ae3982008-04-24 11:55:27 -0700222 | INDIRECT_ADDRESS | INDIRECT_REGULATORY) /* 22 bytes */
Wey-Yi Guye04ed0a2010-03-16 17:47:58 -0700223#define EEPROM_REG_BAND_5_CHANNELS ((0x74)\
Tomas Winkler25ae3982008-04-24 11:55:27 -0700224 | INDIRECT_ADDRESS | INDIRECT_REGULATORY) /* 12 bytes */
Wey-Yi Guye04ed0a2010-03-16 17:47:58 -0700225#define EEPROM_REG_BAND_24_HT40_CHANNELS ((0x82)\
Tomas Winkler25ae3982008-04-24 11:55:27 -0700226 | INDIRECT_ADDRESS | INDIRECT_REGULATORY) /* 14 bytes */
Wey-Yi Guye04ed0a2010-03-16 17:47:58 -0700227#define EEPROM_REG_BAND_52_HT40_CHANNELS ((0x92)\
Tomas Winkler25ae3982008-04-24 11:55:27 -0700228 | INDIRECT_ADDRESS | INDIRECT_REGULATORY) /* 22 bytes */
229
Shanyu Zhaof2fa1b02010-04-07 18:37:52 -0700230/* 6000 regulatory - indirect access */
231#define EEPROM_6000_REG_BAND_24_HT40_CHANNELS ((0x80)\
232 | INDIRECT_ADDRESS | INDIRECT_REGULATORY) /* 14 bytes */
233
Tomas Winkler0ef2ca62008-10-23 23:48:51 -0700234/* 5050 Specific */
235#define EEPROM_5050_TX_POWER_VERSION (4)
236#define EEPROM_5050_EEPROM_VERSION (0x21E)
Tomas Winkler25ae3982008-04-24 11:55:27 -0700237
Wey-Yi Guy1f4b9662009-09-17 10:43:46 -0700238/* 1000 Specific */
Wey-Yi Guy00e70592010-03-16 12:37:26 -0700239#define EEPROM_1000_TX_POWER_VERSION (4)
Wey-Yi Guy72f0ebd2009-10-02 13:43:59 -0700240#define EEPROM_1000_EEPROM_VERSION (0x15C)
Wey-Yi Guy1f4b9662009-09-17 10:43:46 -0700241
Wey-Yi Guy32b7e242009-10-16 14:25:51 -0700242/* 6x00 Specific */
Wey-Yi Guy00e70592010-03-16 12:37:26 -0700243#define EEPROM_6000_TX_POWER_VERSION (4)
Wey-Yi Guy1f4b9662009-09-17 10:43:46 -0700244#define EEPROM_6000_EEPROM_VERSION (0x434)
245
Wey-Yi Guy32b7e242009-10-16 14:25:51 -0700246/* 6x50 Specific */
Wey-Yi Guy00e70592010-03-16 12:37:26 -0700247#define EEPROM_6050_TX_POWER_VERSION (4)
Wey-Yi Guy32b7e242009-10-16 14:25:51 -0700248#define EEPROM_6050_EEPROM_VERSION (0x532)
249
Wey-Yi Guy1956e1a2011-01-08 10:25:14 -0800250/* 6150 Specific */
251#define EEPROM_6150_TX_POWER_VERSION (6)
252#define EEPROM_6150_EEPROM_VERSION (0x553)
Shanyu Zhao03264332010-06-29 17:27:27 -0700253
Wey-Yi Guy1956e1a2011-01-08 10:25:14 -0800254/* 6x05 Specific */
255#define EEPROM_6005_TX_POWER_VERSION (6)
256#define EEPROM_6005_EEPROM_VERSION (0x709)
257
258/* 6x30 Specific */
259#define EEPROM_6030_TX_POWER_VERSION (6)
260#define EEPROM_6030_EEPROM_VERSION (0x709)
Shanyu Zhao4b3e8062010-04-07 18:06:36 -0700261
Wey-Yi Guyfa579802011-01-08 11:47:54 -0800262/* 2x00 Specific */
263#define EEPROM_2000_TX_POWER_VERSION (6)
264#define EEPROM_2000_EEPROM_VERSION (0x805)
265
266/* 6x35 Specific */
267#define EEPROM_6035_TX_POWER_VERSION (6)
268#define EEPROM_6035_EEPROM_VERSION (0x753)
269
270
Wey-Yi Guy0848e292009-05-22 11:01:46 -0700271/* OTP */
Wey-Yi Guy415e4992009-08-13 13:30:54 -0700272/* lower blocks contain EEPROM image and calibration data */
273#define OTP_LOW_IMAGE_SIZE (2 * 512 * sizeof(u16)) /* 2 KB */
274/* high blocks contain PAPD data */
275#define OTP_HIGH_IMAGE_SIZE_6x00 (6 * 512 * sizeof(u16)) /* 6 KB */
276#define OTP_HIGH_IMAGE_SIZE_1000 (0x200 * sizeof(u16)) /* 1024 bytes */
277#define OTP_MAX_LL_ITEMS_1000 (3) /* OTP blocks for 1000 */
278#define OTP_MAX_LL_ITEMS_6x00 (4) /* OTP blocks for 6x00 */
279#define OTP_MAX_LL_ITEMS_6x50 (7) /* OTP blocks for 6x50 */
Wey-Yi Guyfa579802011-01-08 11:47:54 -0800280#define OTP_MAX_LL_ITEMS_2x00 (4) /* OTP blocks for 2x00 */
Wey-Yi Guy0848e292009-05-22 11:01:46 -0700281
Assaf Kraussbf85ea42008-03-14 10:38:49 -0700282/* 2.4 GHz */
283extern const u8 iwl_eeprom_band_1[14];
Assaf Krauss34cf6ff2008-03-06 10:40:20 -0800284
285/*
Tomas Winkler073d3f52008-04-21 15:41:52 -0700286 * factory calibration data for one txpower level, on one channel,
Assaf Krauss34cf6ff2008-03-06 10:40:20 -0800287 * measured on one of the 2 tx chains (radio transmitter and associated
288 * antenna). EEPROM contains:
289 *
290 * 1) Temperature (degrees Celsius) of device when measurement was made.
291 *
292 * 2) Gain table index used to achieve the target measurement power.
293 * This refers to the "well-known" gain tables (see iwl-4965-hw.h).
294 *
295 * 3) Actual measured output power, in half-dBm ("34" = 17 dBm).
296 *
297 * 4) RF power amplifier detector level measurement (not used).
298 */
Tomas Winkler073d3f52008-04-21 15:41:52 -0700299struct iwl_eeprom_calib_measure {
Assaf Krauss34cf6ff2008-03-06 10:40:20 -0800300 u8 temperature; /* Device temperature (Celsius) */
301 u8 gain_idx; /* Index into gain table */
302 u8 actual_pow; /* Measured RF output power, half-dBm */
303 s8 pa_det; /* Power amp detector level (not used) */
Eric Dumazetba2d3582010-06-02 18:10:09 +0000304} __packed;
Assaf Krauss34cf6ff2008-03-06 10:40:20 -0800305
306
307/*
Tomas Winkler073d3f52008-04-21 15:41:52 -0700308 * measurement set for one channel. EEPROM contains:
Assaf Krauss34cf6ff2008-03-06 10:40:20 -0800309 *
310 * 1) Channel number measured
311 *
312 * 2) Measurements for each of 3 power levels for each of 2 radio transmitters
313 * (a.k.a. "tx chains") (6 measurements altogether)
314 */
Tomas Winkler073d3f52008-04-21 15:41:52 -0700315struct iwl_eeprom_calib_ch_info {
Assaf Krauss34cf6ff2008-03-06 10:40:20 -0800316 u8 ch_num;
Tomas Winkler073d3f52008-04-21 15:41:52 -0700317 struct iwl_eeprom_calib_measure
Assaf Krauss34cf6ff2008-03-06 10:40:20 -0800318 measurements[EEPROM_TX_POWER_TX_CHAINS]
319 [EEPROM_TX_POWER_MEASUREMENTS];
Eric Dumazetba2d3582010-06-02 18:10:09 +0000320} __packed;
Assaf Krauss34cf6ff2008-03-06 10:40:20 -0800321
322/*
Tomas Winkler073d3f52008-04-21 15:41:52 -0700323 * txpower subband info.
Assaf Krauss34cf6ff2008-03-06 10:40:20 -0800324 *
325 * For each frequency subband, EEPROM contains the following:
326 *
327 * 1) First and last channels within range of the subband. "0" values
328 * indicate that this sample set is not being used.
329 *
330 * 2) Sample measurement sets for 2 channels close to the range endpoints.
331 */
Tomas Winkler073d3f52008-04-21 15:41:52 -0700332struct iwl_eeprom_calib_subband_info {
Assaf Krauss34cf6ff2008-03-06 10:40:20 -0800333 u8 ch_from; /* channel number of lowest channel in subband */
334 u8 ch_to; /* channel number of highest channel in subband */
Tomas Winkler073d3f52008-04-21 15:41:52 -0700335 struct iwl_eeprom_calib_ch_info ch1;
336 struct iwl_eeprom_calib_ch_info ch2;
Eric Dumazetba2d3582010-06-02 18:10:09 +0000337} __packed;
Assaf Krauss34cf6ff2008-03-06 10:40:20 -0800338
339
340/*
Tomas Winkler073d3f52008-04-21 15:41:52 -0700341 * txpower calibration info. EEPROM contains:
Assaf Krauss34cf6ff2008-03-06 10:40:20 -0800342 *
343 * 1) Factory-measured saturation power levels (maximum levels at which
344 * tx power amplifier can output a signal without too much distortion).
345 * There is one level for 2.4 GHz band and one for 5 GHz band. These
346 * values apply to all channels within each of the bands.
347 *
348 * 2) Factory-measured power supply voltage level. This is assumed to be
349 * constant (i.e. same value applies to all channels/bands) while the
350 * factory measurements are being made.
351 *
352 * 3) Up to 8 sets of factory-measured txpower calibration values.
353 * These are for different frequency ranges, since txpower gain
354 * characteristics of the analog radio circuitry vary with frequency.
355 *
356 * Not all sets need to be filled with data;
Tomas Winkler073d3f52008-04-21 15:41:52 -0700357 * struct iwl_eeprom_calib_subband_info contains range of channels
Assaf Krauss34cf6ff2008-03-06 10:40:20 -0800358 * (0 if unused) for each set of data.
359 */
Tomas Winkler073d3f52008-04-21 15:41:52 -0700360struct iwl_eeprom_calib_info {
Assaf Krauss34cf6ff2008-03-06 10:40:20 -0800361 u8 saturation_power24; /* half-dBm (e.g. "34" = 17 dBm) */
362 u8 saturation_power52; /* half-dBm */
Johannes Bergb7bb1752009-12-14 14:12:09 -0800363 __le16 voltage; /* signed */
Tomas Winkler073d3f52008-04-21 15:41:52 -0700364 struct iwl_eeprom_calib_subband_info
Assaf Krauss34cf6ff2008-03-06 10:40:20 -0800365 band_info[EEPROM_TX_POWER_BANDS];
Eric Dumazetba2d3582010-06-02 18:10:09 +0000366} __packed;
Assaf Krauss34cf6ff2008-03-06 10:40:20 -0800367
368
Tomas Winkler073d3f52008-04-21 15:41:52 -0700369#define ADDRESS_MSK 0x0000FFFF
370#define INDIRECT_TYPE_MSK 0x000F0000
371#define INDIRECT_HOST 0x00010000
372#define INDIRECT_GENERAL 0x00020000
373#define INDIRECT_REGULATORY 0x00030000
374#define INDIRECT_CALIBRATION 0x00040000
375#define INDIRECT_PROCESS_ADJST 0x00050000
376#define INDIRECT_OTHERS 0x00060000
Johannes Berg8d6748c2010-12-09 09:30:14 -0800377#define INDIRECT_TXP_LIMIT 0x00070000
378#define INDIRECT_TXP_LIMIT_SIZE 0x00080000
Tomas Winkler073d3f52008-04-21 15:41:52 -0700379#define INDIRECT_ADDRESS 0x00100000
Assaf Krauss34cf6ff2008-03-06 10:40:20 -0800380
Tomas Winkler073d3f52008-04-21 15:41:52 -0700381/* General */
382#define EEPROM_DEVICE_ID (2*0x08) /* 2 bytes */
383#define EEPROM_MAC_ADDRESS (2*0x15) /* 6 bytes */
384#define EEPROM_BOARD_REVISION (2*0x35) /* 2 bytes */
385#define EEPROM_BOARD_PBA_NUMBER (2*0x3B+1) /* 9 bytes */
386#define EEPROM_VERSION (2*0x44) /* 2 bytes */
Wey-Yi Guy21a5b3c2010-11-10 13:32:59 -0800387#define EEPROM_SKU_CAP (2*0x45) /* 2 bytes */
Tomas Winkler073d3f52008-04-21 15:41:52 -0700388#define EEPROM_OEM_MODE (2*0x46) /* 2 bytes */
389#define EEPROM_WOWLAN_MODE (2*0x47) /* 2 bytes */
Tomas Winkler694cc562008-04-24 11:55:22 -0700390#define EEPROM_RADIO_CONFIG (2*0x48) /* 2 bytes */
Wey-Yi Guyc6fa17e2010-07-15 05:58:30 -0700391#define EEPROM_NUM_MAC_ADDRESS (2*0x4C) /* 2 bytes */
Assaf Krauss34cf6ff2008-03-06 10:40:20 -0800392
Tomas Winkler694cc562008-04-24 11:55:22 -0700393/* The following masks are to be applied on EEPROM_RADIO_CONFIG */
394#define EEPROM_RF_CFG_TYPE_MSK(x) (x & 0x3) /* bits 0-1 */
395#define EEPROM_RF_CFG_STEP_MSK(x) ((x >> 2) & 0x3) /* bits 2-3 */
396#define EEPROM_RF_CFG_DASH_MSK(x) ((x >> 4) & 0x3) /* bits 4-5 */
397#define EEPROM_RF_CFG_PNUM_MSK(x) ((x >> 6) & 0x3) /* bits 6-7 */
398#define EEPROM_RF_CFG_TX_ANT_MSK(x) ((x >> 8) & 0xF) /* bits 8-11 */
399#define EEPROM_RF_CFG_RX_ANT_MSK(x) ((x >> 12) & 0xF) /* bits 12-15 */
400
401#define EEPROM_3945_RF_CFG_TYPE_MAX 0x0
402#define EEPROM_4965_RF_CFG_TYPE_MAX 0x1
Wey-Yi Guy9371d4e2009-09-11 10:38:10 -0700403
404/* Radio Config for 5000 and up */
405#define EEPROM_RF_CONFIG_TYPE_R3x3 0x0
406#define EEPROM_RF_CONFIG_TYPE_R2x2 0x1
407#define EEPROM_RF_CONFIG_TYPE_R1x2 0x2
408#define EEPROM_RF_CONFIG_TYPE_MAX 0x3
Tomas Winkler694cc562008-04-24 11:55:22 -0700409
Assaf Krauss34cf6ff2008-03-06 10:40:20 -0800410/*
411 * Per-channel regulatory data.
412 *
Tomas Winkler073d3f52008-04-21 15:41:52 -0700413 * Each channel that *might* be supported by iwl has a fixed location
Assaf Krauss34cf6ff2008-03-06 10:40:20 -0800414 * in EEPROM containing EEPROM_CHANNEL_* usage flags (LSB) and max regulatory
415 * txpower (MSB).
416 *
Wey-Yi Guy7aafef12009-08-07 15:41:38 -0700417 * Entries immediately below are for 20 MHz channel width. HT40 (40 MHz)
Assaf Krauss34cf6ff2008-03-06 10:40:20 -0800418 * channels (only for 4965, not supported by 3945) appear later in the EEPROM.
419 *
420 * 2.4 GHz channels 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14
421 */
Tomas Winkler073d3f52008-04-21 15:41:52 -0700422#define EEPROM_REGULATORY_SKU_ID (2*0x60) /* 4 bytes */
423#define EEPROM_REGULATORY_BAND_1 (2*0x62) /* 2 bytes */
424#define EEPROM_REGULATORY_BAND_1_CHANNELS (2*0x63) /* 28 bytes */
Assaf Krauss34cf6ff2008-03-06 10:40:20 -0800425
426/*
427 * 4.9 GHz channels 183, 184, 185, 187, 188, 189, 192, 196,
428 * 5.0 GHz channels 7, 8, 11, 12, 16
429 * (4915-5080MHz) (none of these is ever supported)
430 */
Tomas Winkler073d3f52008-04-21 15:41:52 -0700431#define EEPROM_REGULATORY_BAND_2 (2*0x71) /* 2 bytes */
432#define EEPROM_REGULATORY_BAND_2_CHANNELS (2*0x72) /* 26 bytes */
Assaf Krauss34cf6ff2008-03-06 10:40:20 -0800433
434/*
435 * 5.2 GHz channels 34, 36, 38, 40, 42, 44, 46, 48, 52, 56, 60, 64
436 * (5170-5320MHz)
437 */
Tomas Winkler073d3f52008-04-21 15:41:52 -0700438#define EEPROM_REGULATORY_BAND_3 (2*0x7F) /* 2 bytes */
439#define EEPROM_REGULATORY_BAND_3_CHANNELS (2*0x80) /* 24 bytes */
Assaf Krauss34cf6ff2008-03-06 10:40:20 -0800440
441/*
442 * 5.5 GHz channels 100, 104, 108, 112, 116, 120, 124, 128, 132, 136, 140
443 * (5500-5700MHz)
444 */
Tomas Winkler073d3f52008-04-21 15:41:52 -0700445#define EEPROM_REGULATORY_BAND_4 (2*0x8C) /* 2 bytes */
446#define EEPROM_REGULATORY_BAND_4_CHANNELS (2*0x8D) /* 22 bytes */
Assaf Krauss34cf6ff2008-03-06 10:40:20 -0800447
448/*
449 * 5.7 GHz channels 145, 149, 153, 157, 161, 165
450 * (5725-5825MHz)
451 */
Tomas Winkler073d3f52008-04-21 15:41:52 -0700452#define EEPROM_REGULATORY_BAND_5 (2*0x98) /* 2 bytes */
453#define EEPROM_REGULATORY_BAND_5_CHANNELS (2*0x99) /* 12 bytes */
Assaf Krauss34cf6ff2008-03-06 10:40:20 -0800454
455/*
Wey-Yi Guy7aafef12009-08-07 15:41:38 -0700456 * 2.4 GHz HT40 channels 1 (5), 2 (6), 3 (7), 4 (8), 5 (9), 6 (10), 7 (11)
Assaf Krauss34cf6ff2008-03-06 10:40:20 -0800457 *
458 * The channel listed is the center of the lower 20 MHz half of the channel.
459 * The overall center frequency is actually 2 channels (10 MHz) above that,
Wey-Yi Guy7aafef12009-08-07 15:41:38 -0700460 * and the upper half of each HT40 channel is centered 4 channels (20 MHz) away
461 * from the lower half; e.g. the upper half of HT40 channel 1 is channel 5,
462 * and the overall HT40 channel width centers on channel 3.
Assaf Krauss34cf6ff2008-03-06 10:40:20 -0800463 *
464 * NOTE: The RXON command uses 20 MHz channel numbers to specify the
465 * control channel to which to tune. RXON also specifies whether the
Wey-Yi Guy7aafef12009-08-07 15:41:38 -0700466 * control channel is the upper or lower half of a HT40 channel.
Assaf Krauss34cf6ff2008-03-06 10:40:20 -0800467 *
Wey-Yi Guy7aafef12009-08-07 15:41:38 -0700468 * NOTE: 4965 does not support HT40 channels on 2.4 GHz.
Assaf Krauss34cf6ff2008-03-06 10:40:20 -0800469 */
Wey-Yi Guy7aafef12009-08-07 15:41:38 -0700470#define EEPROM_4965_REGULATORY_BAND_24_HT40_CHANNELS (2*0xA0) /* 14 bytes */
Assaf Krauss34cf6ff2008-03-06 10:40:20 -0800471
472/*
Wey-Yi Guy7aafef12009-08-07 15:41:38 -0700473 * 5.2 GHz HT40 channels 36 (40), 44 (48), 52 (56), 60 (64),
Assaf Krauss34cf6ff2008-03-06 10:40:20 -0800474 * 100 (104), 108 (112), 116 (120), 124 (128), 132 (136), 149 (153), 157 (161)
475 */
Wey-Yi Guy7aafef12009-08-07 15:41:38 -0700476#define EEPROM_4965_REGULATORY_BAND_52_HT40_CHANNELS (2*0xA8) /* 22 bytes */
Assaf Krauss34cf6ff2008-03-06 10:40:20 -0800477
Wey-Yi Guy7aafef12009-08-07 15:41:38 -0700478#define EEPROM_REGULATORY_BAND_NO_HT40 (0)
Reinette Chatrea89d03c2009-02-10 15:19:04 -0800479
Assaf Krauss34cf6ff2008-03-06 10:40:20 -0800480struct iwl_eeprom_ops {
Tomas Winkler073d3f52008-04-21 15:41:52 -0700481 const u32 regulatory_bands[7];
Tomas Winklerc79dd5b2008-03-12 16:58:50 -0700482 int (*acquire_semaphore) (struct iwl_priv *priv);
483 void (*release_semaphore) (struct iwl_priv *priv);
Tomas Winkler0ef2ca62008-10-23 23:48:51 -0700484 u16 (*calib_version) (struct iwl_priv *priv);
Tomas Winkler073d3f52008-04-21 15:41:52 -0700485 const u8* (*query_addr) (const struct iwl_priv *priv, size_t offset);
Wey-Yi Guyab9fd1b2009-08-21 13:34:23 -0700486 void (*update_enhanced_txpower) (struct iwl_priv *priv);
Assaf Krauss34cf6ff2008-03-06 10:40:20 -0800487};
488
489
Tomas Winklerc79dd5b2008-03-12 16:58:50 -0700490int iwl_eeprom_init(struct iwl_priv *priv);
Tomas Winkler073d3f52008-04-21 15:41:52 -0700491void iwl_eeprom_free(struct iwl_priv *priv);
Tomas Winkler8614f362008-04-23 17:14:55 -0700492int iwl_eeprom_check_version(struct iwl_priv *priv);
Wey-Yi Guy21a5b3c2010-11-10 13:32:59 -0800493int iwl_eeprom_check_sku(struct iwl_priv *priv);
Tomas Winkler073d3f52008-04-21 15:41:52 -0700494const u8 *iwl_eeprom_query_addr(const struct iwl_priv *priv, size_t offset);
Tomas Winklerc79dd5b2008-03-12 16:58:50 -0700495int iwlcore_eeprom_verify_signature(struct iwl_priv *priv);
Wey-Yi Guy3be63ff2010-10-08 16:05:19 -0700496u16 iwl_eeprom_query16(const struct iwl_priv *priv, size_t offset);
Tomas Winkler073d3f52008-04-21 15:41:52 -0700497const u8 *iwlcore_eeprom_query_addr(const struct iwl_priv *priv, size_t offset);
Assaf Kraussbf85ea42008-03-14 10:38:49 -0700498int iwl_init_channel_map(struct iwl_priv *priv);
499void iwl_free_channel_map(struct iwl_priv *priv);
Assaf Krauss8622e702008-03-21 13:53:43 -0700500const struct iwl_channel_info *iwl_get_channel_info(
Assaf Kraussbf85ea42008-03-14 10:38:49 -0700501 const struct iwl_priv *priv,
502 enum ieee80211_band band, u16 channel);
503
Assaf Krauss34cf6ff2008-03-06 10:40:20 -0800504#endif /* __iwl_eeprom_h__ */