blob: 8171c701e4e15e53610a0068e8d79bfeb72c0ec2 [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 */
113#define EEPROM_SKU_CAP_SW_RF_KILL_ENABLE (1 << 0)
114#define EEPROM_SKU_CAP_HW_RF_KILL_ENABLE (1 << 1)
115
116/* *regulatory* channel data format in eeprom, one for each channel.
Wey-Yi Guy7aafef12009-08-07 15:41:38 -0700117 * There are separate entries for HT40 (40 MHz) vs. normal (20 MHz) channels. */
Tomas Winkler073d3f52008-04-21 15:41:52 -0700118struct iwl_eeprom_channel {
Assaf Krauss34cf6ff2008-03-06 10:40:20 -0800119 u8 flags; /* EEPROM_CHANNEL_* flags copied from EEPROM */
120 s8 max_power_avg; /* max power (dBm) on this chnl, limit 31 */
121} __attribute__ ((packed));
122
Wey-Yi Guyab9fd1b2009-08-21 13:34:23 -0700123/**
124 * iwl_eeprom_enhanced_txpwr structure
125 * This structure presents the enhanced regulatory tx power limit layout
126 * in eeprom image
127 * Enhanced regulatory tx power portion of eeprom image can be broken down
128 * into individual structures; each one is 8 bytes in size and contain the
129 * following information
Wey-Yi Guy85f0d9e2009-11-13 11:56:23 -0800130 * @common: (desc + channel) not used by driver, should _NOT_ be "zero"
Wey-Yi Guyab9fd1b2009-08-21 13:34:23 -0700131 * @chain_a_max_pwr: chain a max power in 1/2 dBm
132 * @chain_b_max_pwr: chain b max power in 1/2 dBm
133 * @chain_c_max_pwr: chain c max power in 1/2 dBm
Wey-Yi Guy85f0d9e2009-11-13 11:56:23 -0800134 * @reserved: not used, should be "zero"
Wey-Yi Guyab9fd1b2009-08-21 13:34:23 -0700135 * @mimo2_max_pwr: mimo2 max power in 1/2 dBm
136 * @mimo3_max_pwr: mimo3 max power in 1/2 dBm
137 *
138 */
139struct iwl_eeprom_enhanced_txpwr {
Johannes Bergb7bb1752009-12-14 14:12:09 -0800140 __le16 common;
Wey-Yi Guyab9fd1b2009-08-21 13:34:23 -0700141 s8 chain_a_max;
142 s8 chain_b_max;
143 s8 chain_c_max;
Wey-Yi Guy85f0d9e2009-11-13 11:56:23 -0800144 s8 reserved;
Wey-Yi Guyab9fd1b2009-08-21 13:34:23 -0700145 s8 mimo2_max;
146 s8 mimo3_max;
147} __attribute__ ((packed));
148
Samuel Ortize6148912009-01-23 13:45:15 -0800149/* 3945 Specific */
150#define EEPROM_3945_EEPROM_VERSION (0x2f)
151
Assaf Krauss34cf6ff2008-03-06 10:40:20 -0800152/* 4965 has two radio transmitters (and 3 radio receivers) */
153#define EEPROM_TX_POWER_TX_CHAINS (2)
154
155/* 4965 has room for up to 8 sets of txpower calibration data */
156#define EEPROM_TX_POWER_BANDS (8)
157
158/* 4965 factory calibration measures txpower gain settings for
159 * each of 3 target output levels */
160#define EEPROM_TX_POWER_MEASUREMENTS (3)
161
Tomas Winkler073d3f52008-04-21 15:41:52 -0700162/* 4965 Specific */
163/* 4965 driver does not work with txpower calibration version < 5 */
164#define EEPROM_4965_TX_POWER_VERSION (5)
Tomas Winkler8614f362008-04-23 17:14:55 -0700165#define EEPROM_4965_EEPROM_VERSION (0x2f)
Tomas Winkler073d3f52008-04-21 15:41:52 -0700166#define EEPROM_4965_CALIB_VERSION_OFFSET (2*0xB6) /* 2 bytes */
167#define EEPROM_4965_CALIB_TXPOWER_OFFSET (2*0xE8) /* 48 bytes */
168#define EEPROM_4965_BOARD_REVISION (2*0x4F) /* 2 bytes */
169#define EEPROM_4965_BOARD_PBA (2*0x56+1) /* 9 bytes */
Assaf Krauss34cf6ff2008-03-06 10:40:20 -0800170
Tomas Winklerf1f69412008-04-24 11:55:35 -0700171/* 5000 Specific */
172#define EEPROM_5000_TX_POWER_VERSION (4)
173#define EEPROM_5000_EEPROM_VERSION (0x11A)
174
Tomas Winkler25ae3982008-04-24 11:55:27 -0700175/*5000 calibrations */
176#define EEPROM_5000_CALIB_ALL (INDIRECT_ADDRESS | INDIRECT_CALIBRATION)
Tomas Winkler7c616cb2008-05-29 16:35:05 +0800177#define EEPROM_5000_XTAL ((2*0x128) | EEPROM_5000_CALIB_ALL)
Tomas Winkler339afc82008-12-01 16:32:20 -0800178#define EEPROM_5000_TEMPERATURE ((2*0x12A) | EEPROM_5000_CALIB_ALL)
Tomas Winkler25ae3982008-04-24 11:55:27 -0700179
180/* 5000 links */
181#define EEPROM_5000_LINK_HOST (2*0x64)
182#define EEPROM_5000_LINK_GENERAL (2*0x65)
183#define EEPROM_5000_LINK_REGULATORY (2*0x66)
184#define EEPROM_5000_LINK_CALIBRATION (2*0x67)
185#define EEPROM_5000_LINK_PROCESS_ADJST (2*0x68)
186#define EEPROM_5000_LINK_OTHERS (2*0x69)
187
188/* 5000 regulatory - indirect access */
189#define EEPROM_5000_REG_SKU_ID ((0x02)\
190 | INDIRECT_ADDRESS | INDIRECT_REGULATORY) /* 4 bytes */
191#define EEPROM_5000_REG_BAND_1_CHANNELS ((0x08)\
192 | INDIRECT_ADDRESS | INDIRECT_REGULATORY) /* 28 bytes */
193#define EEPROM_5000_REG_BAND_2_CHANNELS ((0x26)\
194 | INDIRECT_ADDRESS | INDIRECT_REGULATORY) /* 26 bytes */
195#define EEPROM_5000_REG_BAND_3_CHANNELS ((0x42)\
196 | INDIRECT_ADDRESS | INDIRECT_REGULATORY) /* 24 bytes */
197#define EEPROM_5000_REG_BAND_4_CHANNELS ((0x5C)\
198 | INDIRECT_ADDRESS | INDIRECT_REGULATORY) /* 22 bytes */
199#define EEPROM_5000_REG_BAND_5_CHANNELS ((0x74)\
200 | INDIRECT_ADDRESS | INDIRECT_REGULATORY) /* 12 bytes */
Wey-Yi Guy7aafef12009-08-07 15:41:38 -0700201#define EEPROM_5000_REG_BAND_24_HT40_CHANNELS ((0x82)\
Tomas Winkler25ae3982008-04-24 11:55:27 -0700202 | INDIRECT_ADDRESS | INDIRECT_REGULATORY) /* 14 bytes */
Wey-Yi Guy7aafef12009-08-07 15:41:38 -0700203#define EEPROM_5000_REG_BAND_52_HT40_CHANNELS ((0x92)\
Tomas Winkler25ae3982008-04-24 11:55:27 -0700204 | INDIRECT_ADDRESS | INDIRECT_REGULATORY) /* 22 bytes */
205
Shanyu Zhaof2fa1b02010-04-07 18:37:52 -0700206/* 6000 regulatory - indirect access */
207#define EEPROM_6000_REG_BAND_24_HT40_CHANNELS ((0x80)\
208 | INDIRECT_ADDRESS | INDIRECT_REGULATORY) /* 14 bytes */
209
Wey-Yi Guyab9fd1b2009-08-21 13:34:23 -0700210/* 6000 and up regulatory tx power - indirect access */
211/* max. elements per section */
212#define EEPROM_MAX_TXPOWER_SECTION_ELEMENTS (8)
213#define EEPROM_TXPOWER_COMMON_HT40_INDEX (2)
214
215/**
216 * Partition the enhanced tx power portion of eeprom image into
217 * 10 sections based on band, modulation, frequency and channel
218 *
219 * Section 1: all CCK channels
220 * Section 2: all 2.4 GHz OFDM (Legacy, HT and HT40 ) channels
221 * Section 3: all 5.2 GHz OFDM (Legacy, HT and HT40) channels
222 * Section 4: 2.4 GHz 20MHz channels: 1, 2, 10, 11. Both Legacy and HT
223 * Section 5: 2.4 GHz 40MHz channels: 1, 2, 6, 7, 9, (_above_)
224 * Section 6: 5.2 GHz 20MHz channels: 36, 64, 100, both Legacy and HT
225 * Section 7: 5.2 GHz 40MHz channels: 36, 60, 100 (_above_)
226 * Section 8: 2.4 GHz channel 13, Both Legacy and HT
227 * Section 9: 2.4 GHz channel 140, Both Legacy and HT
228 * Section 10: 2.4 GHz 40MHz channels: 132, 44 (_above_)
229 */
230/* 2.4 GHz band: CCK */
Wey-Yi Guy722d9b12009-10-02 13:43:56 -0700231#define EEPROM_LB_CCK_20_COMMON ((0xA8)\
Wey-Yi Guyab9fd1b2009-08-21 13:34:23 -0700232 | INDIRECT_ADDRESS | INDIRECT_REGULATORY) /* 8 bytes */
233/* 2.4 GHz band: 20MHz-Legacy, 20MHz-HT, 40MHz-HT */
Wey-Yi Guy722d9b12009-10-02 13:43:56 -0700234#define EEPROM_LB_OFDM_COMMON ((0xB0)\
Wey-Yi Guyab9fd1b2009-08-21 13:34:23 -0700235 | INDIRECT_ADDRESS | INDIRECT_REGULATORY) /* 24 bytes */
236/* 5.2 GHz band: 20MHz-Legacy, 20MHz-HT, 40MHz-HT */
Wey-Yi Guy722d9b12009-10-02 13:43:56 -0700237#define EEPROM_HB_OFDM_COMMON ((0xC8)\
Wey-Yi Guyab9fd1b2009-08-21 13:34:23 -0700238 | INDIRECT_ADDRESS | INDIRECT_REGULATORY) /* 24 bytes */
239/* 2.4GHz band channels:
240 * 1Legacy, 1HT, 2Legacy, 2HT, 10Legacy, 10HT, 11Legacy, 11HT */
Wey-Yi Guy722d9b12009-10-02 13:43:56 -0700241#define EEPROM_LB_OFDM_20_BAND ((0xE0)\
Wey-Yi Guyab9fd1b2009-08-21 13:34:23 -0700242 | INDIRECT_ADDRESS | INDIRECT_REGULATORY) /* 64 bytes */
243/* 2.4 GHz band HT40 channels: (1,+1) (2,+1) (6,+1) (7,+1) (9,+1) */
Wey-Yi Guy722d9b12009-10-02 13:43:56 -0700244#define EEPROM_LB_OFDM_HT40_BAND ((0x120)\
Wey-Yi Guyab9fd1b2009-08-21 13:34:23 -0700245 | INDIRECT_ADDRESS | INDIRECT_REGULATORY) /* 40 bytes */
246/* 5.2GHz band channels: 36Legacy, 36HT, 64Legacy, 64HT, 100Legacy, 100HT */
Wey-Yi Guy722d9b12009-10-02 13:43:56 -0700247#define EEPROM_HB_OFDM_20_BAND ((0x148)\
Wey-Yi Guyab9fd1b2009-08-21 13:34:23 -0700248 | INDIRECT_ADDRESS | INDIRECT_REGULATORY) /* 48 bytes */
249/* 5.2 GHz band HT40 channels: (36,+1) (60,+1) (100,+1) */
Wey-Yi Guy722d9b12009-10-02 13:43:56 -0700250#define EEPROM_HB_OFDM_HT40_BAND ((0x178)\
Wey-Yi Guyab9fd1b2009-08-21 13:34:23 -0700251 | INDIRECT_ADDRESS | INDIRECT_REGULATORY) /* 24 bytes */
252/* 2.4 GHz band, channnel 13: Legacy, HT */
Wey-Yi Guy722d9b12009-10-02 13:43:56 -0700253#define EEPROM_LB_OFDM_20_CHANNEL_13 ((0x190)\
Wey-Yi Guyab9fd1b2009-08-21 13:34:23 -0700254 | INDIRECT_ADDRESS | INDIRECT_REGULATORY) /* 16 bytes */
255/* 5.2 GHz band, channnel 140: Legacy, HT */
Wey-Yi Guy722d9b12009-10-02 13:43:56 -0700256#define EEPROM_HB_OFDM_20_CHANNEL_140 ((0x1A0)\
Wey-Yi Guyab9fd1b2009-08-21 13:34:23 -0700257 | INDIRECT_ADDRESS | INDIRECT_REGULATORY) /* 16 bytes */
258/* 5.2 GHz band, HT40 channnels (132,+1) (44,+1) */
Wey-Yi Guy722d9b12009-10-02 13:43:56 -0700259#define EEPROM_HB_OFDM_HT40_BAND_1 ((0x1B0)\
Wey-Yi Guyab9fd1b2009-08-21 13:34:23 -0700260 | INDIRECT_ADDRESS | INDIRECT_REGULATORY) /* 16 bytes */
261
262
Tomas Winkler0ef2ca62008-10-23 23:48:51 -0700263/* 5050 Specific */
264#define EEPROM_5050_TX_POWER_VERSION (4)
265#define EEPROM_5050_EEPROM_VERSION (0x21E)
Tomas Winkler25ae3982008-04-24 11:55:27 -0700266
Wey-Yi Guy1f4b9662009-09-17 10:43:46 -0700267/* 1000 Specific */
Wey-Yi Guy72f0ebd2009-10-02 13:43:59 -0700268#define EEPROM_1000_EEPROM_VERSION (0x15C)
Wey-Yi Guy1f4b9662009-09-17 10:43:46 -0700269
Wey-Yi Guy32b7e242009-10-16 14:25:51 -0700270/* 6x00 Specific */
Wey-Yi Guy1f4b9662009-09-17 10:43:46 -0700271#define EEPROM_6000_EEPROM_VERSION (0x434)
272
Wey-Yi Guy32b7e242009-10-16 14:25:51 -0700273/* 6x50 Specific */
274#define EEPROM_6050_EEPROM_VERSION (0x532)
275
Wey-Yi Guy0848e292009-05-22 11:01:46 -0700276/* OTP */
Wey-Yi Guy415e4992009-08-13 13:30:54 -0700277/* lower blocks contain EEPROM image and calibration data */
278#define OTP_LOW_IMAGE_SIZE (2 * 512 * sizeof(u16)) /* 2 KB */
279/* high blocks contain PAPD data */
280#define OTP_HIGH_IMAGE_SIZE_6x00 (6 * 512 * sizeof(u16)) /* 6 KB */
281#define OTP_HIGH_IMAGE_SIZE_1000 (0x200 * sizeof(u16)) /* 1024 bytes */
282#define OTP_MAX_LL_ITEMS_1000 (3) /* OTP blocks for 1000 */
283#define OTP_MAX_LL_ITEMS_6x00 (4) /* OTP blocks for 6x00 */
284#define OTP_MAX_LL_ITEMS_6x50 (7) /* OTP blocks for 6x50 */
Wey-Yi Guy0848e292009-05-22 11:01:46 -0700285
Assaf Kraussbf85ea42008-03-14 10:38:49 -0700286/* 2.4 GHz */
287extern const u8 iwl_eeprom_band_1[14];
Assaf Krauss34cf6ff2008-03-06 10:40:20 -0800288
289/*
Tomas Winkler073d3f52008-04-21 15:41:52 -0700290 * factory calibration data for one txpower level, on one channel,
Assaf Krauss34cf6ff2008-03-06 10:40:20 -0800291 * measured on one of the 2 tx chains (radio transmitter and associated
292 * antenna). EEPROM contains:
293 *
294 * 1) Temperature (degrees Celsius) of device when measurement was made.
295 *
296 * 2) Gain table index used to achieve the target measurement power.
297 * This refers to the "well-known" gain tables (see iwl-4965-hw.h).
298 *
299 * 3) Actual measured output power, in half-dBm ("34" = 17 dBm).
300 *
301 * 4) RF power amplifier detector level measurement (not used).
302 */
Tomas Winkler073d3f52008-04-21 15:41:52 -0700303struct iwl_eeprom_calib_measure {
Assaf Krauss34cf6ff2008-03-06 10:40:20 -0800304 u8 temperature; /* Device temperature (Celsius) */
305 u8 gain_idx; /* Index into gain table */
306 u8 actual_pow; /* Measured RF output power, half-dBm */
307 s8 pa_det; /* Power amp detector level (not used) */
308} __attribute__ ((packed));
309
310
311/*
Tomas Winkler073d3f52008-04-21 15:41:52 -0700312 * measurement set for one channel. EEPROM contains:
Assaf Krauss34cf6ff2008-03-06 10:40:20 -0800313 *
314 * 1) Channel number measured
315 *
316 * 2) Measurements for each of 3 power levels for each of 2 radio transmitters
317 * (a.k.a. "tx chains") (6 measurements altogether)
318 */
Tomas Winkler073d3f52008-04-21 15:41:52 -0700319struct iwl_eeprom_calib_ch_info {
Assaf Krauss34cf6ff2008-03-06 10:40:20 -0800320 u8 ch_num;
Tomas Winkler073d3f52008-04-21 15:41:52 -0700321 struct iwl_eeprom_calib_measure
Assaf Krauss34cf6ff2008-03-06 10:40:20 -0800322 measurements[EEPROM_TX_POWER_TX_CHAINS]
323 [EEPROM_TX_POWER_MEASUREMENTS];
324} __attribute__ ((packed));
325
326/*
Tomas Winkler073d3f52008-04-21 15:41:52 -0700327 * txpower subband info.
Assaf Krauss34cf6ff2008-03-06 10:40:20 -0800328 *
329 * For each frequency subband, EEPROM contains the following:
330 *
331 * 1) First and last channels within range of the subband. "0" values
332 * indicate that this sample set is not being used.
333 *
334 * 2) Sample measurement sets for 2 channels close to the range endpoints.
335 */
Tomas Winkler073d3f52008-04-21 15:41:52 -0700336struct iwl_eeprom_calib_subband_info {
Assaf Krauss34cf6ff2008-03-06 10:40:20 -0800337 u8 ch_from; /* channel number of lowest channel in subband */
338 u8 ch_to; /* channel number of highest channel in subband */
Tomas Winkler073d3f52008-04-21 15:41:52 -0700339 struct iwl_eeprom_calib_ch_info ch1;
340 struct iwl_eeprom_calib_ch_info ch2;
Assaf Krauss34cf6ff2008-03-06 10:40:20 -0800341} __attribute__ ((packed));
342
343
344/*
Tomas Winkler073d3f52008-04-21 15:41:52 -0700345 * txpower calibration info. EEPROM contains:
Assaf Krauss34cf6ff2008-03-06 10:40:20 -0800346 *
347 * 1) Factory-measured saturation power levels (maximum levels at which
348 * tx power amplifier can output a signal without too much distortion).
349 * There is one level for 2.4 GHz band and one for 5 GHz band. These
350 * values apply to all channels within each of the bands.
351 *
352 * 2) Factory-measured power supply voltage level. This is assumed to be
353 * constant (i.e. same value applies to all channels/bands) while the
354 * factory measurements are being made.
355 *
356 * 3) Up to 8 sets of factory-measured txpower calibration values.
357 * These are for different frequency ranges, since txpower gain
358 * characteristics of the analog radio circuitry vary with frequency.
359 *
360 * Not all sets need to be filled with data;
Tomas Winkler073d3f52008-04-21 15:41:52 -0700361 * struct iwl_eeprom_calib_subband_info contains range of channels
Assaf Krauss34cf6ff2008-03-06 10:40:20 -0800362 * (0 if unused) for each set of data.
363 */
Tomas Winkler073d3f52008-04-21 15:41:52 -0700364struct iwl_eeprom_calib_info {
Assaf Krauss34cf6ff2008-03-06 10:40:20 -0800365 u8 saturation_power24; /* half-dBm (e.g. "34" = 17 dBm) */
366 u8 saturation_power52; /* half-dBm */
Johannes Bergb7bb1752009-12-14 14:12:09 -0800367 __le16 voltage; /* signed */
Tomas Winkler073d3f52008-04-21 15:41:52 -0700368 struct iwl_eeprom_calib_subband_info
Assaf Krauss34cf6ff2008-03-06 10:40:20 -0800369 band_info[EEPROM_TX_POWER_BANDS];
370} __attribute__ ((packed));
371
372
Tomas Winkler073d3f52008-04-21 15:41:52 -0700373#define ADDRESS_MSK 0x0000FFFF
374#define INDIRECT_TYPE_MSK 0x000F0000
375#define INDIRECT_HOST 0x00010000
376#define INDIRECT_GENERAL 0x00020000
377#define INDIRECT_REGULATORY 0x00030000
378#define INDIRECT_CALIBRATION 0x00040000
379#define INDIRECT_PROCESS_ADJST 0x00050000
380#define INDIRECT_OTHERS 0x00060000
381#define INDIRECT_ADDRESS 0x00100000
Assaf Krauss34cf6ff2008-03-06 10:40:20 -0800382
Tomas Winkler073d3f52008-04-21 15:41:52 -0700383/* General */
384#define EEPROM_DEVICE_ID (2*0x08) /* 2 bytes */
385#define EEPROM_MAC_ADDRESS (2*0x15) /* 6 bytes */
386#define EEPROM_BOARD_REVISION (2*0x35) /* 2 bytes */
387#define EEPROM_BOARD_PBA_NUMBER (2*0x3B+1) /* 9 bytes */
388#define EEPROM_VERSION (2*0x44) /* 2 bytes */
389#define EEPROM_SKU_CAP (2*0x45) /* 1 bytes */
Tomas Winkler073d3f52008-04-21 15:41:52 -0700390#define EEPROM_OEM_MODE (2*0x46) /* 2 bytes */
391#define EEPROM_WOWLAN_MODE (2*0x47) /* 2 bytes */
Tomas Winkler694cc562008-04-24 11:55:22 -0700392#define EEPROM_RADIO_CONFIG (2*0x48) /* 2 bytes */
Tomas Winkler073d3f52008-04-21 15:41:52 -0700393#define EEPROM_3945_M_VERSION (2*0x4A) /* 1 bytes */
Assaf Krauss34cf6ff2008-03-06 10:40:20 -0800394
Tomas Winkler694cc562008-04-24 11:55:22 -0700395/* The following masks are to be applied on EEPROM_RADIO_CONFIG */
396#define EEPROM_RF_CFG_TYPE_MSK(x) (x & 0x3) /* bits 0-1 */
397#define EEPROM_RF_CFG_STEP_MSK(x) ((x >> 2) & 0x3) /* bits 2-3 */
398#define EEPROM_RF_CFG_DASH_MSK(x) ((x >> 4) & 0x3) /* bits 4-5 */
399#define EEPROM_RF_CFG_PNUM_MSK(x) ((x >> 6) & 0x3) /* bits 6-7 */
400#define EEPROM_RF_CFG_TX_ANT_MSK(x) ((x >> 8) & 0xF) /* bits 8-11 */
401#define EEPROM_RF_CFG_RX_ANT_MSK(x) ((x >> 12) & 0xF) /* bits 12-15 */
402
403#define EEPROM_3945_RF_CFG_TYPE_MAX 0x0
404#define EEPROM_4965_RF_CFG_TYPE_MAX 0x1
Wey-Yi Guy9371d4e2009-09-11 10:38:10 -0700405
406/* Radio Config for 5000 and up */
407#define EEPROM_RF_CONFIG_TYPE_R3x3 0x0
408#define EEPROM_RF_CONFIG_TYPE_R2x2 0x1
409#define EEPROM_RF_CONFIG_TYPE_R1x2 0x2
410#define EEPROM_RF_CONFIG_TYPE_MAX 0x3
Tomas Winkler694cc562008-04-24 11:55:22 -0700411
Assaf Krauss34cf6ff2008-03-06 10:40:20 -0800412/*
413 * Per-channel regulatory data.
414 *
Tomas Winkler073d3f52008-04-21 15:41:52 -0700415 * Each channel that *might* be supported by iwl has a fixed location
Assaf Krauss34cf6ff2008-03-06 10:40:20 -0800416 * in EEPROM containing EEPROM_CHANNEL_* usage flags (LSB) and max regulatory
417 * txpower (MSB).
418 *
Wey-Yi Guy7aafef12009-08-07 15:41:38 -0700419 * Entries immediately below are for 20 MHz channel width. HT40 (40 MHz)
Assaf Krauss34cf6ff2008-03-06 10:40:20 -0800420 * channels (only for 4965, not supported by 3945) appear later in the EEPROM.
421 *
422 * 2.4 GHz channels 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14
423 */
Tomas Winkler073d3f52008-04-21 15:41:52 -0700424#define EEPROM_REGULATORY_SKU_ID (2*0x60) /* 4 bytes */
425#define EEPROM_REGULATORY_BAND_1 (2*0x62) /* 2 bytes */
426#define EEPROM_REGULATORY_BAND_1_CHANNELS (2*0x63) /* 28 bytes */
Assaf Krauss34cf6ff2008-03-06 10:40:20 -0800427
428/*
429 * 4.9 GHz channels 183, 184, 185, 187, 188, 189, 192, 196,
430 * 5.0 GHz channels 7, 8, 11, 12, 16
431 * (4915-5080MHz) (none of these is ever supported)
432 */
Tomas Winkler073d3f52008-04-21 15:41:52 -0700433#define EEPROM_REGULATORY_BAND_2 (2*0x71) /* 2 bytes */
434#define EEPROM_REGULATORY_BAND_2_CHANNELS (2*0x72) /* 26 bytes */
Assaf Krauss34cf6ff2008-03-06 10:40:20 -0800435
436/*
437 * 5.2 GHz channels 34, 36, 38, 40, 42, 44, 46, 48, 52, 56, 60, 64
438 * (5170-5320MHz)
439 */
Tomas Winkler073d3f52008-04-21 15:41:52 -0700440#define EEPROM_REGULATORY_BAND_3 (2*0x7F) /* 2 bytes */
441#define EEPROM_REGULATORY_BAND_3_CHANNELS (2*0x80) /* 24 bytes */
Assaf Krauss34cf6ff2008-03-06 10:40:20 -0800442
443/*
444 * 5.5 GHz channels 100, 104, 108, 112, 116, 120, 124, 128, 132, 136, 140
445 * (5500-5700MHz)
446 */
Tomas Winkler073d3f52008-04-21 15:41:52 -0700447#define EEPROM_REGULATORY_BAND_4 (2*0x8C) /* 2 bytes */
448#define EEPROM_REGULATORY_BAND_4_CHANNELS (2*0x8D) /* 22 bytes */
Assaf Krauss34cf6ff2008-03-06 10:40:20 -0800449
450/*
451 * 5.7 GHz channels 145, 149, 153, 157, 161, 165
452 * (5725-5825MHz)
453 */
Tomas Winkler073d3f52008-04-21 15:41:52 -0700454#define EEPROM_REGULATORY_BAND_5 (2*0x98) /* 2 bytes */
455#define EEPROM_REGULATORY_BAND_5_CHANNELS (2*0x99) /* 12 bytes */
Assaf Krauss34cf6ff2008-03-06 10:40:20 -0800456
457/*
Wey-Yi Guy7aafef12009-08-07 15:41:38 -0700458 * 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 -0800459 *
460 * The channel listed is the center of the lower 20 MHz half of the channel.
461 * The overall center frequency is actually 2 channels (10 MHz) above that,
Wey-Yi Guy7aafef12009-08-07 15:41:38 -0700462 * and the upper half of each HT40 channel is centered 4 channels (20 MHz) away
463 * from the lower half; e.g. the upper half of HT40 channel 1 is channel 5,
464 * and the overall HT40 channel width centers on channel 3.
Assaf Krauss34cf6ff2008-03-06 10:40:20 -0800465 *
466 * NOTE: The RXON command uses 20 MHz channel numbers to specify the
467 * control channel to which to tune. RXON also specifies whether the
Wey-Yi Guy7aafef12009-08-07 15:41:38 -0700468 * control channel is the upper or lower half of a HT40 channel.
Assaf Krauss34cf6ff2008-03-06 10:40:20 -0800469 *
Wey-Yi Guy7aafef12009-08-07 15:41:38 -0700470 * NOTE: 4965 does not support HT40 channels on 2.4 GHz.
Assaf Krauss34cf6ff2008-03-06 10:40:20 -0800471 */
Wey-Yi Guy7aafef12009-08-07 15:41:38 -0700472#define EEPROM_4965_REGULATORY_BAND_24_HT40_CHANNELS (2*0xA0) /* 14 bytes */
Assaf Krauss34cf6ff2008-03-06 10:40:20 -0800473
474/*
Wey-Yi Guy7aafef12009-08-07 15:41:38 -0700475 * 5.2 GHz HT40 channels 36 (40), 44 (48), 52 (56), 60 (64),
Assaf Krauss34cf6ff2008-03-06 10:40:20 -0800476 * 100 (104), 108 (112), 116 (120), 124 (128), 132 (136), 149 (153), 157 (161)
477 */
Wey-Yi Guy7aafef12009-08-07 15:41:38 -0700478#define EEPROM_4965_REGULATORY_BAND_52_HT40_CHANNELS (2*0xA8) /* 22 bytes */
Assaf Krauss34cf6ff2008-03-06 10:40:20 -0800479
Wey-Yi Guy7aafef12009-08-07 15:41:38 -0700480#define EEPROM_REGULATORY_BAND_NO_HT40 (0)
Reinette Chatrea89d03c2009-02-10 15:19:04 -0800481
Assaf Krauss34cf6ff2008-03-06 10:40:20 -0800482struct iwl_eeprom_ops {
Tomas Winkler073d3f52008-04-21 15:41:52 -0700483 const u32 regulatory_bands[7];
Tomas Winklerc79dd5b2008-03-12 16:58:50 -0700484 int (*verify_signature) (struct iwl_priv *priv);
485 int (*acquire_semaphore) (struct iwl_priv *priv);
486 void (*release_semaphore) (struct iwl_priv *priv);
Tomas Winkler0ef2ca62008-10-23 23:48:51 -0700487 u16 (*calib_version) (struct iwl_priv *priv);
Tomas Winkler073d3f52008-04-21 15:41:52 -0700488 const u8* (*query_addr) (const struct iwl_priv *priv, size_t offset);
Wey-Yi Guyab9fd1b2009-08-21 13:34:23 -0700489 void (*update_enhanced_txpower) (struct iwl_priv *priv);
Assaf Krauss34cf6ff2008-03-06 10:40:20 -0800490};
491
492
Tomas Winklerc79dd5b2008-03-12 16:58:50 -0700493void iwl_eeprom_get_mac(const struct iwl_priv *priv, u8 *mac);
494int iwl_eeprom_init(struct iwl_priv *priv);
Tomas Winkler073d3f52008-04-21 15:41:52 -0700495void iwl_eeprom_free(struct iwl_priv *priv);
Tomas Winkler8614f362008-04-23 17:14:55 -0700496int iwl_eeprom_check_version(struct iwl_priv *priv);
Tomas Winkler073d3f52008-04-21 15:41:52 -0700497const u8 *iwl_eeprom_query_addr(const struct iwl_priv *priv, size_t offset);
498u16 iwl_eeprom_query16(const struct iwl_priv *priv, size_t offset);
Assaf Krauss34cf6ff2008-03-06 10:40:20 -0800499
Tomas Winklerc79dd5b2008-03-12 16:58:50 -0700500int iwlcore_eeprom_verify_signature(struct iwl_priv *priv);
501int iwlcore_eeprom_acquire_semaphore(struct iwl_priv *priv);
502void iwlcore_eeprom_release_semaphore(struct iwl_priv *priv);
Tomas Winkler073d3f52008-04-21 15:41:52 -0700503const u8 *iwlcore_eeprom_query_addr(const struct iwl_priv *priv, size_t offset);
Wey-Yi Guyab9fd1b2009-08-21 13:34:23 -0700504void iwlcore_eeprom_enhanced_txpower(struct iwl_priv *priv);
Assaf Kraussbf85ea42008-03-14 10:38:49 -0700505int iwl_init_channel_map(struct iwl_priv *priv);
506void iwl_free_channel_map(struct iwl_priv *priv);
Assaf Krauss8622e702008-03-21 13:53:43 -0700507const struct iwl_channel_info *iwl_get_channel_info(
Assaf Kraussbf85ea42008-03-14 10:38:49 -0700508 const struct iwl_priv *priv,
509 enum ieee80211_band band, u16 channel);
510
Assaf Krauss34cf6ff2008-03-06 10:40:20 -0800511#endif /* __iwl_eeprom_h__ */