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 * Copyright (C) 2016 Intel Deutschland GmbH
10 *
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of version 2 of the GNU General Public License as
13 * published by the Free Software Foundation.
14 *
15 * This program is distributed in the hope that it will be useful, but
16 * WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 * General Public License for more details.
19 *
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110,
23 * USA
24 *
25 * The full GNU General Public License is included in this distribution
26 * in the file called COPYING.
27 *
28 * Contact Information:
29 * Intel Linux Wireless <linuxwifi@intel.com>
30 * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
31 *
32 * BSD LICENSE
33 *
34 * Copyright(c) 2005 - 2014 Intel Corporation. All rights reserved.
35 * Copyright (C) 2016 Intel Deutschland GmbH
36 * All rights reserved.
37 *
38 * Redistribution and use in source and binary forms, with or without
39 * modification, are permitted provided that the following conditions
40 * are met:
41 *
42 * * Redistributions of source code must retain the above copyright
43 * notice, this list of conditions and the following disclaimer.
44 * * Redistributions in binary form must reproduce the above copyright
45 * notice, this list of conditions and the following disclaimer in
46 * the documentation and/or other materials provided with the
47 * distribution.
48 * * Neither the name Intel Corporation nor the names of its
49 * contributors may be used to endorse or promote products derived
50 * from this software without specific prior written permission.
51 *
52 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
53 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
54 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
55 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
56 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
57 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
58 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
59 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
60 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
61 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
62 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
63 *
64 *****************************************************************************/
65 #ifndef __IWL_CONFIG_H__
66 #define __IWL_CONFIG_H__
67
68 #include <linux/types.h>
69 #include <linux/netdevice.h>
70 #include <linux/ieee80211.h>
71 #include <linux/nl80211.h>
72
73 enum iwl_device_family {
74 IWL_DEVICE_FAMILY_UNDEFINED,
75 IWL_DEVICE_FAMILY_1000,
76 IWL_DEVICE_FAMILY_100,
77 IWL_DEVICE_FAMILY_2000,
78 IWL_DEVICE_FAMILY_2030,
79 IWL_DEVICE_FAMILY_105,
80 IWL_DEVICE_FAMILY_135,
81 IWL_DEVICE_FAMILY_5000,
82 IWL_DEVICE_FAMILY_5150,
83 IWL_DEVICE_FAMILY_6000,
84 IWL_DEVICE_FAMILY_6000i,
85 IWL_DEVICE_FAMILY_6005,
86 IWL_DEVICE_FAMILY_6030,
87 IWL_DEVICE_FAMILY_6050,
88 IWL_DEVICE_FAMILY_6150,
89 IWL_DEVICE_FAMILY_7000,
90 IWL_DEVICE_FAMILY_8000,
91 };
92
iwl_has_secure_boot(u32 hw_rev,enum iwl_device_family family)93 static inline bool iwl_has_secure_boot(u32 hw_rev,
94 enum iwl_device_family family)
95 {
96 /* return 1 only for family 8000 B0 */
97 if ((family == IWL_DEVICE_FAMILY_8000) && (hw_rev & 0xC))
98 return true;
99
100 return false;
101 }
102
103 /*
104 * LED mode
105 * IWL_LED_DEFAULT: use device default
106 * IWL_LED_RF_STATE: turn LED on/off based on RF state
107 * LED ON = RF ON
108 * LED OFF = RF OFF
109 * IWL_LED_BLINK: adjust led blink rate based on blink table
110 * IWL_LED_DISABLE: led disabled
111 */
112 enum iwl_led_mode {
113 IWL_LED_DEFAULT,
114 IWL_LED_RF_STATE,
115 IWL_LED_BLINK,
116 IWL_LED_DISABLE,
117 };
118
119 /*
120 * This is the threshold value of plcp error rate per 100mSecs. It is
121 * used to set and check for the validity of plcp_delta.
122 */
123 #define IWL_MAX_PLCP_ERR_THRESHOLD_MIN 1
124 #define IWL_MAX_PLCP_ERR_THRESHOLD_DEF 50
125 #define IWL_MAX_PLCP_ERR_LONG_THRESHOLD_DEF 100
126 #define IWL_MAX_PLCP_ERR_EXT_LONG_THRESHOLD_DEF 200
127 #define IWL_MAX_PLCP_ERR_THRESHOLD_MAX 255
128 #define IWL_MAX_PLCP_ERR_THRESHOLD_DISABLE 0
129
130 /* TX queue watchdog timeouts in mSecs */
131 #define IWL_WATCHDOG_DISABLED 0
132 #define IWL_DEF_WD_TIMEOUT 2500
133 #define IWL_LONG_WD_TIMEOUT 10000
134 #define IWL_MAX_WD_TIMEOUT 120000
135
136 #define IWL_DEFAULT_MAX_TX_POWER 22
137 #define IWL_TX_CSUM_NETIF_FLAGS (NETIF_F_IPV6_CSUM | NETIF_F_IP_CSUM |\
138 NETIF_F_TSO | NETIF_F_TSO6)
139
140 /* Antenna presence definitions */
141 #define ANT_NONE 0x0
142 #define ANT_A BIT(0)
143 #define ANT_B BIT(1)
144 #define ANT_C BIT(2)
145 #define ANT_AB (ANT_A | ANT_B)
146 #define ANT_AC (ANT_A | ANT_C)
147 #define ANT_BC (ANT_B | ANT_C)
148 #define ANT_ABC (ANT_A | ANT_B | ANT_C)
149
num_of_ant(u8 mask)150 static inline u8 num_of_ant(u8 mask)
151 {
152 return !!((mask) & ANT_A) +
153 !!((mask) & ANT_B) +
154 !!((mask) & ANT_C);
155 }
156
157 /*
158 * @max_ll_items: max number of OTP blocks
159 * @shadow_ram_support: shadow support for OTP memory
160 * @led_compensation: compensate on the led on/off time per HW according
161 * to the deviation to achieve the desired led frequency.
162 * The detail algorithm is described in iwl-led.c
163 * @wd_timeout: TX queues watchdog timeout
164 * @max_event_log_size: size of event log buffer size for ucode event logging
165 * @shadow_reg_enable: HW shadow register support
166 * @apmg_wake_up_wa: should the MAC access REQ be asserted when a command
167 * is in flight. This is due to a HW bug in 7260, 3160 and 7265.
168 * @scd_chain_ext_wa: should the chain extension feature in SCD be disabled.
169 */
170 struct iwl_base_params {
171 unsigned int wd_timeout;
172
173 u16 eeprom_size;
174 u16 max_event_log_size;
175
176 u8 pll_cfg:1, /* for iwl_pcie_apm_init() */
177 shadow_ram_support:1,
178 shadow_reg_enable:1,
179 pcie_l1_allowed:1,
180 apmg_wake_up_wa:1,
181 scd_chain_ext_wa:1;
182
183 u8 num_of_queues; /* def: HW dependent */
184
185 u8 max_ll_items;
186 u8 led_compensation;
187 };
188
189 /*
190 * @stbc: support Tx STBC and 1*SS Rx STBC
191 * @ldpc: support Tx/Rx with LDPC
192 * @use_rts_for_aggregation: use rts/cts protection for HT traffic
193 * @ht40_bands: bitmap of bands (using %NL80211_BAND_*) that support HT40
194 */
195 struct iwl_ht_params {
196 u8 ht_greenfield_support:1,
197 stbc:1,
198 ldpc:1,
199 use_rts_for_aggregation:1;
200 u8 ht40_bands;
201 };
202
203 /*
204 * Tx-backoff threshold
205 * @temperature: The threshold in Celsius
206 * @backoff: The tx-backoff in uSec
207 */
208 struct iwl_tt_tx_backoff {
209 s32 temperature;
210 u32 backoff;
211 };
212
213 #define TT_TX_BACKOFF_SIZE 6
214
215 /**
216 * struct iwl_tt_params - thermal throttling parameters
217 * @ct_kill_entry: CT Kill entry threshold
218 * @ct_kill_exit: CT Kill exit threshold
219 * @ct_kill_duration: The time intervals (in uSec) in which the driver needs
220 * to checks whether to exit CT Kill.
221 * @dynamic_smps_entry: Dynamic SMPS entry threshold
222 * @dynamic_smps_exit: Dynamic SMPS exit threshold
223 * @tx_protection_entry: TX protection entry threshold
224 * @tx_protection_exit: TX protection exit threshold
225 * @tx_backoff: Array of thresholds for tx-backoff , in ascending order.
226 * @support_ct_kill: Support CT Kill?
227 * @support_dynamic_smps: Support dynamic SMPS?
228 * @support_tx_protection: Support tx protection?
229 * @support_tx_backoff: Support tx-backoff?
230 */
231 struct iwl_tt_params {
232 u32 ct_kill_entry;
233 u32 ct_kill_exit;
234 u32 ct_kill_duration;
235 u32 dynamic_smps_entry;
236 u32 dynamic_smps_exit;
237 u32 tx_protection_entry;
238 u32 tx_protection_exit;
239 struct iwl_tt_tx_backoff tx_backoff[TT_TX_BACKOFF_SIZE];
240 u8 support_ct_kill:1,
241 support_dynamic_smps:1,
242 support_tx_protection:1,
243 support_tx_backoff:1;
244 };
245
246 /*
247 * information on how to parse the EEPROM
248 */
249 #define EEPROM_REG_BAND_1_CHANNELS 0x08
250 #define EEPROM_REG_BAND_2_CHANNELS 0x26
251 #define EEPROM_REG_BAND_3_CHANNELS 0x42
252 #define EEPROM_REG_BAND_4_CHANNELS 0x5C
253 #define EEPROM_REG_BAND_5_CHANNELS 0x74
254 #define EEPROM_REG_BAND_24_HT40_CHANNELS 0x82
255 #define EEPROM_REG_BAND_52_HT40_CHANNELS 0x92
256 #define EEPROM_6000_REG_BAND_24_HT40_CHANNELS 0x80
257 #define EEPROM_REGULATORY_BAND_NO_HT40 0
258
259 /* lower blocks contain EEPROM image and calibration data */
260 #define OTP_LOW_IMAGE_SIZE (2 * 512 * sizeof(u16)) /* 2 KB */
261 #define OTP_LOW_IMAGE_SIZE_FAMILY_7000 (16 * 512 * sizeof(u16)) /* 16 KB */
262 #define OTP_LOW_IMAGE_SIZE_FAMILY_8000 (32 * 512 * sizeof(u16)) /* 32 KB */
263 #define OTP_LOW_IMAGE_SIZE_FAMILY_9000 OTP_LOW_IMAGE_SIZE_FAMILY_8000
264 #define OTP_LOW_IMAGE_SIZE_FAMILY_A000 OTP_LOW_IMAGE_SIZE_FAMILY_9000
265
266 struct iwl_eeprom_params {
267 const u8 regulatory_bands[7];
268 bool enhanced_txpower;
269 };
270
271 /* Tx-backoff power threshold
272 * @pwr: The power limit in mw
273 * @backoff: The tx-backoff in uSec
274 */
275 struct iwl_pwr_tx_backoff {
276 u32 pwr;
277 u32 backoff;
278 };
279
280 /**
281 * struct iwl_cfg
282 * @name: Official name of the device
283 * @fw_name_pre: Firmware filename prefix. The api version and extension
284 * (.ucode) will be added to filename before loading from disk. The
285 * filename is constructed as fw_name_pre<api>.ucode.
286 * @ucode_api_max: Highest version of uCode API supported by driver.
287 * @ucode_api_min: Lowest version of uCode API supported by driver.
288 * @max_inst_size: The maximal length of the fw inst section
289 * @max_data_size: The maximal length of the fw data section
290 * @valid_tx_ant: valid transmit antenna
291 * @valid_rx_ant: valid receive antenna
292 * @non_shared_ant: the antenna that is for WiFi only
293 * @nvm_ver: NVM version
294 * @nvm_calib_ver: NVM calibration version
295 * @lib: pointer to the lib ops
296 * @base_params: pointer to basic parameters
297 * @ht_params: point to ht parameters
298 * @led_mode: 0=blinking, 1=On(RF On)/Off(RF Off)
299 * @rx_with_siso_diversity: 1x1 device with rx antenna diversity
300 * @internal_wimax_coex: internal wifi/wimax combo device
301 * @high_temp: Is this NIC is designated to be in high temperature.
302 * @host_interrupt_operation_mode: device needs host interrupt operation
303 * mode set
304 * @nvm_hw_section_num: the ID of the HW NVM section
305 * @mac_addr_from_csr: read HW address from CSR registers
306 * @features: hw features, any combination of feature_whitelist
307 * @pwr_tx_backoffs: translation table between power limits and backoffs
308 * @max_rx_agg_size: max RX aggregation size of the ADDBA request/response
309 * @max_tx_agg_size: max TX aggregation size of the ADDBA request/response
310 * @max_ht_ampdu_factor: the exponent of the max length of A-MPDU that the
311 * station can receive in HT
312 * @max_vht_ampdu_exponent: the exponent of the max length of A-MPDU that the
313 * station can receive in VHT
314 * @dccm_offset: offset from which DCCM begins
315 * @dccm_len: length of DCCM (including runtime stack CCM)
316 * @dccm2_offset: offset from which the second DCCM begins
317 * @dccm2_len: length of the second DCCM
318 * @smem_offset: offset from which the SMEM begins
319 * @smem_len: the length of SMEM
320 * @mq_rx_supported: multi-queue rx support
321 * @vht_mu_mimo_supported: VHT MU-MIMO support
322 * @rf_id: need to read rf_id to determine the firmware image
323 * @integrated: discrete or integrated
324 *
325 * We enable the driver to be backward compatible wrt. hardware features.
326 * API differences in uCode shouldn't be handled here but through TLVs
327 * and/or the uCode API version instead.
328 */
329 struct iwl_cfg {
330 /* params specific to an individual device within a device family */
331 const char *name;
332 const char *fw_name_pre;
333 /* params not likely to change within a device family */
334 const struct iwl_base_params *base_params;
335 /* params likely to change within a device family */
336 const struct iwl_ht_params *ht_params;
337 const struct iwl_eeprom_params *eeprom_params;
338 const struct iwl_pwr_tx_backoff *pwr_tx_backoffs;
339 const char *default_nvm_file_B_step;
340 const char *default_nvm_file_C_step;
341 const struct iwl_tt_params *thermal_params;
342 enum iwl_device_family device_family;
343 enum iwl_led_mode led_mode;
344 u32 max_data_size;
345 u32 max_inst_size;
346 netdev_features_t features;
347 u32 dccm_offset;
348 u32 dccm_len;
349 u32 dccm2_offset;
350 u32 dccm2_len;
351 u32 smem_offset;
352 u32 smem_len;
353 u16 nvm_ver;
354 u16 nvm_calib_ver;
355 u16 rx_with_siso_diversity:1,
356 bt_shared_single_ant:1,
357 internal_wimax_coex:1,
358 host_interrupt_operation_mode:1,
359 high_temp:1,
360 mac_addr_from_csr:1,
361 lp_xtal_workaround:1,
362 disable_dummy_notification:1,
363 apmg_not_supported:1,
364 mq_rx_supported:1,
365 vht_mu_mimo_supported:1,
366 rf_id:1,
367 integrated:1,
368 use_tfh:1;
369 u8 valid_tx_ant;
370 u8 valid_rx_ant;
371 u8 non_shared_ant;
372 u8 nvm_hw_section_num;
373 u8 max_rx_agg_size;
374 u8 max_tx_agg_size;
375 u8 max_ht_ampdu_exponent;
376 u8 max_vht_ampdu_exponent;
377 u8 ucode_api_max;
378 u8 ucode_api_min;
379 };
380
381 /*
382 * This list declares the config structures for all devices.
383 */
384 #if IS_ENABLED(CONFIG_IWLDVM)
385 extern const struct iwl_cfg iwl5300_agn_cfg;
386 extern const struct iwl_cfg iwl5100_agn_cfg;
387 extern const struct iwl_cfg iwl5350_agn_cfg;
388 extern const struct iwl_cfg iwl5100_bgn_cfg;
389 extern const struct iwl_cfg iwl5100_abg_cfg;
390 extern const struct iwl_cfg iwl5150_agn_cfg;
391 extern const struct iwl_cfg iwl5150_abg_cfg;
392 extern const struct iwl_cfg iwl6005_2agn_cfg;
393 extern const struct iwl_cfg iwl6005_2abg_cfg;
394 extern const struct iwl_cfg iwl6005_2bg_cfg;
395 extern const struct iwl_cfg iwl6005_2agn_sff_cfg;
396 extern const struct iwl_cfg iwl6005_2agn_d_cfg;
397 extern const struct iwl_cfg iwl6005_2agn_mow1_cfg;
398 extern const struct iwl_cfg iwl6005_2agn_mow2_cfg;
399 extern const struct iwl_cfg iwl1030_bgn_cfg;
400 extern const struct iwl_cfg iwl1030_bg_cfg;
401 extern const struct iwl_cfg iwl6030_2agn_cfg;
402 extern const struct iwl_cfg iwl6030_2abg_cfg;
403 extern const struct iwl_cfg iwl6030_2bgn_cfg;
404 extern const struct iwl_cfg iwl6030_2bg_cfg;
405 extern const struct iwl_cfg iwl6000i_2agn_cfg;
406 extern const struct iwl_cfg iwl6000i_2abg_cfg;
407 extern const struct iwl_cfg iwl6000i_2bg_cfg;
408 extern const struct iwl_cfg iwl6000_3agn_cfg;
409 extern const struct iwl_cfg iwl6050_2agn_cfg;
410 extern const struct iwl_cfg iwl6050_2abg_cfg;
411 extern const struct iwl_cfg iwl6150_bgn_cfg;
412 extern const struct iwl_cfg iwl6150_bg_cfg;
413 extern const struct iwl_cfg iwl1000_bgn_cfg;
414 extern const struct iwl_cfg iwl1000_bg_cfg;
415 extern const struct iwl_cfg iwl100_bgn_cfg;
416 extern const struct iwl_cfg iwl100_bg_cfg;
417 extern const struct iwl_cfg iwl130_bgn_cfg;
418 extern const struct iwl_cfg iwl130_bg_cfg;
419 extern const struct iwl_cfg iwl2000_2bgn_cfg;
420 extern const struct iwl_cfg iwl2000_2bgn_d_cfg;
421 extern const struct iwl_cfg iwl2030_2bgn_cfg;
422 extern const struct iwl_cfg iwl6035_2agn_cfg;
423 extern const struct iwl_cfg iwl6035_2agn_sff_cfg;
424 extern const struct iwl_cfg iwl105_bgn_cfg;
425 extern const struct iwl_cfg iwl105_bgn_d_cfg;
426 extern const struct iwl_cfg iwl135_bgn_cfg;
427 #endif /* CONFIG_IWLDVM */
428 #if IS_ENABLED(CONFIG_IWLMVM)
429 extern const struct iwl_cfg iwl7260_2ac_cfg;
430 extern const struct iwl_cfg iwl7260_2ac_cfg_high_temp;
431 extern const struct iwl_cfg iwl7260_2n_cfg;
432 extern const struct iwl_cfg iwl7260_n_cfg;
433 extern const struct iwl_cfg iwl3160_2ac_cfg;
434 extern const struct iwl_cfg iwl3160_2n_cfg;
435 extern const struct iwl_cfg iwl3160_n_cfg;
436 extern const struct iwl_cfg iwl3165_2ac_cfg;
437 extern const struct iwl_cfg iwl3168_2ac_cfg;
438 extern const struct iwl_cfg iwl7265_2ac_cfg;
439 extern const struct iwl_cfg iwl7265_2n_cfg;
440 extern const struct iwl_cfg iwl7265_n_cfg;
441 extern const struct iwl_cfg iwl7265d_2ac_cfg;
442 extern const struct iwl_cfg iwl7265d_2n_cfg;
443 extern const struct iwl_cfg iwl7265d_n_cfg;
444 extern const struct iwl_cfg iwl8260_2n_cfg;
445 extern const struct iwl_cfg iwl8260_2ac_cfg;
446 extern const struct iwl_cfg iwl8265_2ac_cfg;
447 extern const struct iwl_cfg iwl8275_2ac_cfg;
448 extern const struct iwl_cfg iwl4165_2ac_cfg;
449 extern const struct iwl_cfg iwl8260_2ac_sdio_cfg;
450 extern const struct iwl_cfg iwl8265_2ac_sdio_cfg;
451 extern const struct iwl_cfg iwl4165_2ac_sdio_cfg;
452 extern const struct iwl_cfg iwl9000lc_2ac_cfg;
453 extern const struct iwl_cfg iwl9160_2ac_cfg;
454 extern const struct iwl_cfg iwl9260_2ac_cfg;
455 extern const struct iwl_cfg iwl9270_2ac_cfg;
456 extern const struct iwl_cfg iwl9460_2ac_cfg;
457 extern const struct iwl_cfg iwl9560_2ac_cfg;
458 extern const struct iwl_cfg iwla000_2ac_cfg;
459 #endif /* CONFIG_IWLMVM */
460
461 #endif /* __IWL_CONFIG_H__ */
462