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) 2007 - 2014 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 COPYING.
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 - 2014 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_CONFIG_H__
64 #define __IWL_CONFIG_H__
65
66 #include <linux/types.h>
67 #include <net/mac80211.h>
68
69
70 enum iwl_device_family {
71 IWL_DEVICE_FAMILY_UNDEFINED,
72 IWL_DEVICE_FAMILY_1000,
73 IWL_DEVICE_FAMILY_100,
74 IWL_DEVICE_FAMILY_2000,
75 IWL_DEVICE_FAMILY_2030,
76 IWL_DEVICE_FAMILY_105,
77 IWL_DEVICE_FAMILY_135,
78 IWL_DEVICE_FAMILY_5000,
79 IWL_DEVICE_FAMILY_5150,
80 IWL_DEVICE_FAMILY_6000,
81 IWL_DEVICE_FAMILY_6000i,
82 IWL_DEVICE_FAMILY_6005,
83 IWL_DEVICE_FAMILY_6030,
84 IWL_DEVICE_FAMILY_6050,
85 IWL_DEVICE_FAMILY_6150,
86 IWL_DEVICE_FAMILY_7000,
87 IWL_DEVICE_FAMILY_8000,
88 };
89
90 /*
91 * LED mode
92 * IWL_LED_DEFAULT: use device default
93 * IWL_LED_RF_STATE: turn LED on/off based on RF state
94 * LED ON = RF ON
95 * LED OFF = RF OFF
96 * IWL_LED_BLINK: adjust led blink rate based on blink table
97 * IWL_LED_DISABLE: led disabled
98 */
99 enum iwl_led_mode {
100 IWL_LED_DEFAULT,
101 IWL_LED_RF_STATE,
102 IWL_LED_BLINK,
103 IWL_LED_DISABLE,
104 };
105
106 /*
107 * This is the threshold value of plcp error rate per 100mSecs. It is
108 * used to set and check for the validity of plcp_delta.
109 */
110 #define IWL_MAX_PLCP_ERR_THRESHOLD_MIN 1
111 #define IWL_MAX_PLCP_ERR_THRESHOLD_DEF 50
112 #define IWL_MAX_PLCP_ERR_LONG_THRESHOLD_DEF 100
113 #define IWL_MAX_PLCP_ERR_EXT_LONG_THRESHOLD_DEF 200
114 #define IWL_MAX_PLCP_ERR_THRESHOLD_MAX 255
115 #define IWL_MAX_PLCP_ERR_THRESHOLD_DISABLE 0
116
117 /* TX queue watchdog timeouts in mSecs */
118 #define IWL_WATCHDOG_DISABLED 0
119 #define IWL_DEF_WD_TIMEOUT 2000
120 #define IWL_LONG_WD_TIMEOUT 10000
121 #define IWL_MAX_WD_TIMEOUT 120000
122
123 #define IWL_DEFAULT_MAX_TX_POWER 22
124
125 /* Antenna presence definitions */
126 #define ANT_NONE 0x0
127 #define ANT_A BIT(0)
128 #define ANT_B BIT(1)
129 #define ANT_C BIT(2)
130 #define ANT_AB (ANT_A | ANT_B)
131 #define ANT_AC (ANT_A | ANT_C)
132 #define ANT_BC (ANT_B | ANT_C)
133 #define ANT_ABC (ANT_A | ANT_B | ANT_C)
134
num_of_ant(u8 mask)135 static inline u8 num_of_ant(u8 mask)
136 {
137 return !!((mask) & ANT_A) +
138 !!((mask) & ANT_B) +
139 !!((mask) & ANT_C);
140 }
141
142 /*
143 * @max_ll_items: max number of OTP blocks
144 * @shadow_ram_support: shadow support for OTP memory
145 * @led_compensation: compensate on the led on/off time per HW according
146 * to the deviation to achieve the desired led frequency.
147 * The detail algorithm is described in iwl-led.c
148 * @wd_timeout: TX queues watchdog timeout
149 * @max_event_log_size: size of event log buffer size for ucode event logging
150 * @shadow_reg_enable: HW shadow register support
151 * @apmg_wake_up_wa: should the MAC access REQ be asserted when a command
152 * is in flight. This is due to a HW bug in 7260, 3160 and 7265.
153 * @scd_chain_ext_wa: should the chain extension feature in SCD be disabled.
154 */
155 struct iwl_base_params {
156 int eeprom_size;
157 int num_of_queues; /* def: HW dependent */
158 /* for iwl_pcie_apm_init() */
159 u32 pll_cfg_val;
160
161 const u16 max_ll_items;
162 const bool shadow_ram_support;
163 u16 led_compensation;
164 unsigned int wd_timeout;
165 u32 max_event_log_size;
166 const bool shadow_reg_enable;
167 const bool pcie_l1_allowed;
168 const bool apmg_wake_up_wa;
169 const bool scd_chain_ext_wa;
170 };
171
172 /*
173 * @stbc: support Tx STBC and 1*SS Rx STBC
174 * @ldpc: support Tx/Rx with LDPC
175 * @use_rts_for_aggregation: use rts/cts protection for HT traffic
176 * @ht40_bands: bitmap of bands (using %IEEE80211_BAND_*) that support HT40
177 */
178 struct iwl_ht_params {
179 enum ieee80211_smps_mode smps_mode;
180 const bool ht_greenfield_support; /* if used set to true */
181 const bool stbc;
182 const bool ldpc;
183 bool use_rts_for_aggregation;
184 u8 ht40_bands;
185 };
186
187 /*
188 * information on how to parse the EEPROM
189 */
190 #define EEPROM_REG_BAND_1_CHANNELS 0x08
191 #define EEPROM_REG_BAND_2_CHANNELS 0x26
192 #define EEPROM_REG_BAND_3_CHANNELS 0x42
193 #define EEPROM_REG_BAND_4_CHANNELS 0x5C
194 #define EEPROM_REG_BAND_5_CHANNELS 0x74
195 #define EEPROM_REG_BAND_24_HT40_CHANNELS 0x82
196 #define EEPROM_REG_BAND_52_HT40_CHANNELS 0x92
197 #define EEPROM_6000_REG_BAND_24_HT40_CHANNELS 0x80
198 #define EEPROM_REGULATORY_BAND_NO_HT40 0
199
200 /* lower blocks contain EEPROM image and calibration data */
201 #define OTP_LOW_IMAGE_SIZE (2 * 512 * sizeof(u16)) /* 2 KB */
202 #define OTP_LOW_IMAGE_SIZE_FAMILY_7000 (16 * 512 * sizeof(u16)) /* 16 KB */
203 #define OTP_LOW_IMAGE_SIZE_FAMILY_8000 (32 * 512 * sizeof(u16)) /* 32 KB */
204
205 struct iwl_eeprom_params {
206 const u8 regulatory_bands[7];
207 bool enhanced_txpower;
208 };
209
210 /* Tx-backoff power threshold
211 * @pwr: The power limit in mw
212 * @backoff: The tx-backoff in uSec
213 */
214 struct iwl_pwr_tx_backoff {
215 u32 pwr;
216 u32 backoff;
217 };
218
219 /**
220 * struct iwl_cfg
221 * @name: Offical name of the device
222 * @fw_name_pre: Firmware filename prefix. The api version and extension
223 * (.ucode) will be added to filename before loading from disk. The
224 * filename is constructed as fw_name_pre<api>.ucode.
225 * @ucode_api_max: Highest version of uCode API supported by driver.
226 * @ucode_api_ok: oldest version of the uCode API that is OK to load
227 * without a warning, for use in transitions
228 * @ucode_api_min: Lowest version of uCode API supported by driver.
229 * @max_inst_size: The maximal length of the fw inst section
230 * @max_data_size: The maximal length of the fw data section
231 * @valid_tx_ant: valid transmit antenna
232 * @valid_rx_ant: valid receive antenna
233 * @non_shared_ant: the antenna that is for WiFi only
234 * @nvm_ver: NVM version
235 * @nvm_calib_ver: NVM calibration version
236 * @lib: pointer to the lib ops
237 * @base_params: pointer to basic parameters
238 * @ht_params: point to ht parameters
239 * @led_mode: 0=blinking, 1=On(RF On)/Off(RF Off)
240 * @rx_with_siso_diversity: 1x1 device with rx antenna diversity
241 * @internal_wimax_coex: internal wifi/wimax combo device
242 * @high_temp: Is this NIC is designated to be in high temperature.
243 * @host_interrupt_operation_mode: device needs host interrupt operation
244 * mode set
245 * @d0i3: device uses d0i3 instead of d3
246 * @nvm_hw_section_num: the ID of the HW NVM section
247 * @pwr_tx_backoffs: translation table between power limits and backoffs
248 * @max_rx_agg_size: max RX aggregation size of the ADDBA request/response
249 *
250 * We enable the driver to be backward compatible wrt. hardware features.
251 * API differences in uCode shouldn't be handled here but through TLVs
252 * and/or the uCode API version instead.
253 */
254 struct iwl_cfg {
255 /* params specific to an individual device within a device family */
256 const char *name;
257 const char *fw_name_pre;
258 const unsigned int ucode_api_max;
259 const unsigned int ucode_api_ok;
260 const unsigned int ucode_api_min;
261 const enum iwl_device_family device_family;
262 const u32 max_data_size;
263 const u32 max_inst_size;
264 u8 valid_tx_ant;
265 u8 valid_rx_ant;
266 u8 non_shared_ant;
267 bool bt_shared_single_ant;
268 u16 nvm_ver;
269 u16 nvm_calib_ver;
270 /* params not likely to change within a device family */
271 const struct iwl_base_params *base_params;
272 /* params likely to change within a device family */
273 const struct iwl_ht_params *ht_params;
274 const struct iwl_eeprom_params *eeprom_params;
275 enum iwl_led_mode led_mode;
276 const bool rx_with_siso_diversity;
277 const bool internal_wimax_coex;
278 const bool host_interrupt_operation_mode;
279 bool high_temp;
280 bool d0i3;
281 u8 nvm_hw_section_num;
282 bool lp_xtal_workaround;
283 const struct iwl_pwr_tx_backoff *pwr_tx_backoffs;
284 bool no_power_up_nic_in_init;
285 const char *default_nvm_file;
286 unsigned int max_rx_agg_size;
287 bool disable_dummy_notification;
288 };
289
290 /*
291 * This list declares the config structures for all devices.
292 */
293 #if IS_ENABLED(CONFIG_IWLDVM)
294 extern const struct iwl_cfg iwl5300_agn_cfg;
295 extern const struct iwl_cfg iwl5100_agn_cfg;
296 extern const struct iwl_cfg iwl5350_agn_cfg;
297 extern const struct iwl_cfg iwl5100_bgn_cfg;
298 extern const struct iwl_cfg iwl5100_abg_cfg;
299 extern const struct iwl_cfg iwl5150_agn_cfg;
300 extern const struct iwl_cfg iwl5150_abg_cfg;
301 extern const struct iwl_cfg iwl6005_2agn_cfg;
302 extern const struct iwl_cfg iwl6005_2abg_cfg;
303 extern const struct iwl_cfg iwl6005_2bg_cfg;
304 extern const struct iwl_cfg iwl6005_2agn_sff_cfg;
305 extern const struct iwl_cfg iwl6005_2agn_d_cfg;
306 extern const struct iwl_cfg iwl6005_2agn_mow1_cfg;
307 extern const struct iwl_cfg iwl6005_2agn_mow2_cfg;
308 extern const struct iwl_cfg iwl1030_bgn_cfg;
309 extern const struct iwl_cfg iwl1030_bg_cfg;
310 extern const struct iwl_cfg iwl6030_2agn_cfg;
311 extern const struct iwl_cfg iwl6030_2abg_cfg;
312 extern const struct iwl_cfg iwl6030_2bgn_cfg;
313 extern const struct iwl_cfg iwl6030_2bg_cfg;
314 extern const struct iwl_cfg iwl6000i_2agn_cfg;
315 extern const struct iwl_cfg iwl6000i_2abg_cfg;
316 extern const struct iwl_cfg iwl6000i_2bg_cfg;
317 extern const struct iwl_cfg iwl6000_3agn_cfg;
318 extern const struct iwl_cfg iwl6050_2agn_cfg;
319 extern const struct iwl_cfg iwl6050_2abg_cfg;
320 extern const struct iwl_cfg iwl6150_bgn_cfg;
321 extern const struct iwl_cfg iwl6150_bg_cfg;
322 extern const struct iwl_cfg iwl1000_bgn_cfg;
323 extern const struct iwl_cfg iwl1000_bg_cfg;
324 extern const struct iwl_cfg iwl100_bgn_cfg;
325 extern const struct iwl_cfg iwl100_bg_cfg;
326 extern const struct iwl_cfg iwl130_bgn_cfg;
327 extern const struct iwl_cfg iwl130_bg_cfg;
328 extern const struct iwl_cfg iwl2000_2bgn_cfg;
329 extern const struct iwl_cfg iwl2000_2bgn_d_cfg;
330 extern const struct iwl_cfg iwl2030_2bgn_cfg;
331 extern const struct iwl_cfg iwl6035_2agn_cfg;
332 extern const struct iwl_cfg iwl6035_2agn_sff_cfg;
333 extern const struct iwl_cfg iwl105_bgn_cfg;
334 extern const struct iwl_cfg iwl105_bgn_d_cfg;
335 extern const struct iwl_cfg iwl135_bgn_cfg;
336 #endif /* CONFIG_IWLDVM */
337 #if IS_ENABLED(CONFIG_IWLMVM)
338 extern const struct iwl_cfg iwl7260_2ac_cfg;
339 extern const struct iwl_cfg iwl7260_2ac_cfg_high_temp;
340 extern const struct iwl_cfg iwl7260_2n_cfg;
341 extern const struct iwl_cfg iwl7260_n_cfg;
342 extern const struct iwl_cfg iwl3160_2ac_cfg;
343 extern const struct iwl_cfg iwl3160_2n_cfg;
344 extern const struct iwl_cfg iwl3160_n_cfg;
345 extern const struct iwl_cfg iwl3165_2ac_cfg;
346 extern const struct iwl_cfg iwl7265_2ac_cfg;
347 extern const struct iwl_cfg iwl7265_2n_cfg;
348 extern const struct iwl_cfg iwl7265_n_cfg;
349 extern const struct iwl_cfg iwl7265d_2ac_cfg;
350 extern const struct iwl_cfg iwl7265d_2n_cfg;
351 extern const struct iwl_cfg iwl7265d_n_cfg;
352 extern const struct iwl_cfg iwl8260_2n_cfg;
353 extern const struct iwl_cfg iwl8260_2ac_cfg;
354 extern const struct iwl_cfg iwl8260_2ac_sdio_cfg;
355 #endif /* CONFIG_IWLMVM */
356
357 #endif /* __IWL_CONFIG_H__ */
358