1 /******************************************************************************
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.
8 * Copyright(c) 2007 - 2014 Intel Corporation. All rights reserved.
9 * Copyright (C) 2016 - 2017 Intel Deutschland GmbH
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.
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.
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,
25 * The full GNU General Public License is included in this distribution
26 * in the file called COPYING.
28 * Contact Information:
29 * Intel Linux Wireless <linuxwifi@intel.com>
30 * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
34 * Copyright(c) 2005 - 2014 Intel Corporation. All rights reserved.
35 * Copyright (C) 2016 - 2017 Intel Deutschland GmbH
36 * All rights reserved.
38 * Redistribution and use in source and binary forms, with or without
39 * modification, are permitted provided that the following conditions
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
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.
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.
64 *****************************************************************************/
65 #ifndef __IWL_CONFIG_H__
66 #define __IWL_CONFIG_H__
68 #include <linux/types.h>
69 #include <linux/netdevice.h>
70 #include <linux/ieee80211.h>
71 #include <linux/nl80211.h>
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 IWL_DEVICE_FAMILY_9000
,
92 IWL_DEVICE_FAMILY_22000
,
97 * IWL_LED_DEFAULT: use device default
98 * IWL_LED_RF_STATE: turn LED on/off based on RF state
101 * IWL_LED_BLINK: adjust led blink rate based on blink table
102 * IWL_LED_DISABLE: led disabled
112 * enum iwl_nvm_type - nvm formats
113 * @IWL_NVM: the regular format
114 * @IWL_NVM_EXT: extended NVM format
115 * @IWL_NVM_SDP: NVM format used by 3168 series
124 * This is the threshold value of plcp error rate per 100mSecs. It is
125 * used to set and check for the validity of plcp_delta.
127 #define IWL_MAX_PLCP_ERR_THRESHOLD_MIN 1
128 #define IWL_MAX_PLCP_ERR_THRESHOLD_DEF 50
129 #define IWL_MAX_PLCP_ERR_LONG_THRESHOLD_DEF 100
130 #define IWL_MAX_PLCP_ERR_EXT_LONG_THRESHOLD_DEF 200
131 #define IWL_MAX_PLCP_ERR_THRESHOLD_MAX 255
132 #define IWL_MAX_PLCP_ERR_THRESHOLD_DISABLE 0
134 /* TX queue watchdog timeouts in mSecs */
135 #define IWL_WATCHDOG_DISABLED 0
136 #define IWL_DEF_WD_TIMEOUT 2500
137 #define IWL_LONG_WD_TIMEOUT 10000
138 #define IWL_MAX_WD_TIMEOUT 120000
140 #define IWL_DEFAULT_MAX_TX_POWER 22
141 #define IWL_TX_CSUM_NETIF_FLAGS (NETIF_F_IPV6_CSUM | NETIF_F_IP_CSUM |\
142 NETIF_F_TSO | NETIF_F_TSO6)
144 /* Antenna presence definitions */
146 #define ANT_INVALID 0xff
150 #define ANT_AB (ANT_A | ANT_B)
151 #define ANT_AC (ANT_A | ANT_C)
152 #define ANT_BC (ANT_B | ANT_C)
153 #define ANT_ABC (ANT_A | ANT_B | ANT_C)
155 static inline u8
num_of_ant(u8 mask
)
157 return !!((mask
) & ANT_A
) +
163 * @max_ll_items: max number of OTP blocks
164 * @shadow_ram_support: shadow support for OTP memory
165 * @led_compensation: compensate on the led on/off time per HW according
166 * to the deviation to achieve the desired led frequency.
167 * The detail algorithm is described in iwl-led.c
168 * @wd_timeout: TX queues watchdog timeout
169 * @max_event_log_size: size of event log buffer size for ucode event logging
170 * @shadow_reg_enable: HW shadow register support
171 * @apmg_wake_up_wa: should the MAC access REQ be asserted when a command
172 * is in flight. This is due to a HW bug in 7260, 3160 and 7265.
173 * @scd_chain_ext_wa: should the chain extension feature in SCD be disabled.
175 struct iwl_base_params
{
176 unsigned int wd_timeout
;
179 u16 max_event_log_size
;
181 u8 pll_cfg
:1, /* for iwl_pcie_apm_init() */
182 shadow_ram_support
:1,
188 u16 num_of_queues
; /* def: HW dependent */
195 * @stbc: support Tx STBC and 1*SS Rx STBC
196 * @ldpc: support Tx/Rx with LDPC
197 * @use_rts_for_aggregation: use rts/cts protection for HT traffic
198 * @ht40_bands: bitmap of bands (using %NL80211_BAND_*) that support HT40
200 struct iwl_ht_params
{
201 u8 ht_greenfield_support
:1,
204 use_rts_for_aggregation
:1;
209 * Tx-backoff threshold
210 * @temperature: The threshold in Celsius
211 * @backoff: The tx-backoff in uSec
213 struct iwl_tt_tx_backoff
{
218 #define TT_TX_BACKOFF_SIZE 6
221 * struct iwl_tt_params - thermal throttling parameters
222 * @ct_kill_entry: CT Kill entry threshold
223 * @ct_kill_exit: CT Kill exit threshold
224 * @ct_kill_duration: The time intervals (in uSec) in which the driver needs
225 * to checks whether to exit CT Kill.
226 * @dynamic_smps_entry: Dynamic SMPS entry threshold
227 * @dynamic_smps_exit: Dynamic SMPS exit threshold
228 * @tx_protection_entry: TX protection entry threshold
229 * @tx_protection_exit: TX protection exit threshold
230 * @tx_backoff: Array of thresholds for tx-backoff , in ascending order.
231 * @support_ct_kill: Support CT Kill?
232 * @support_dynamic_smps: Support dynamic SMPS?
233 * @support_tx_protection: Support tx protection?
234 * @support_tx_backoff: Support tx-backoff?
236 struct iwl_tt_params
{
239 u32 ct_kill_duration
;
240 u32 dynamic_smps_entry
;
241 u32 dynamic_smps_exit
;
242 u32 tx_protection_entry
;
243 u32 tx_protection_exit
;
244 struct iwl_tt_tx_backoff tx_backoff
[TT_TX_BACKOFF_SIZE
];
245 u8 support_ct_kill
:1,
246 support_dynamic_smps
:1,
247 support_tx_protection
:1,
248 support_tx_backoff
:1;
252 * information on how to parse the EEPROM
254 #define EEPROM_REG_BAND_1_CHANNELS 0x08
255 #define EEPROM_REG_BAND_2_CHANNELS 0x26
256 #define EEPROM_REG_BAND_3_CHANNELS 0x42
257 #define EEPROM_REG_BAND_4_CHANNELS 0x5C
258 #define EEPROM_REG_BAND_5_CHANNELS 0x74
259 #define EEPROM_REG_BAND_24_HT40_CHANNELS 0x82
260 #define EEPROM_REG_BAND_52_HT40_CHANNELS 0x92
261 #define EEPROM_6000_REG_BAND_24_HT40_CHANNELS 0x80
262 #define EEPROM_REGULATORY_BAND_NO_HT40 0
264 /* lower blocks contain EEPROM image and calibration data */
265 #define OTP_LOW_IMAGE_SIZE (2 * 512 * sizeof(u16)) /* 2 KB */
266 #define OTP_LOW_IMAGE_SIZE_FAMILY_7000 (16 * 512 * sizeof(u16)) /* 16 KB */
267 #define OTP_LOW_IMAGE_SIZE_FAMILY_8000 (32 * 512 * sizeof(u16)) /* 32 KB */
268 #define OTP_LOW_IMAGE_SIZE_FAMILY_9000 OTP_LOW_IMAGE_SIZE_FAMILY_8000
269 #define OTP_LOW_IMAGE_SIZE_FAMILY_22000 OTP_LOW_IMAGE_SIZE_FAMILY_9000
271 struct iwl_eeprom_params
{
272 const u8 regulatory_bands
[7];
273 bool enhanced_txpower
;
276 /* Tx-backoff power threshold
277 * @pwr: The power limit in mw
278 * @backoff: The tx-backoff in uSec
280 struct iwl_pwr_tx_backoff
{
287 * @name: Official name of the device
288 * @fw_name_pre: Firmware filename prefix. The api version and extension
289 * (.ucode) will be added to filename before loading from disk. The
290 * filename is constructed as fw_name_pre<api>.ucode.
291 * @fw_name_pre_b_or_c_step: same as @fw_name_pre, only for b or c steps
293 * @fw_name_pre_rf_next_step: same as @fw_name_pre_b_or_c_step, only for rf
294 * next step. Supported only in integrated solutions.
295 * @ucode_api_max: Highest version of uCode API supported by driver.
296 * @ucode_api_min: Lowest version of uCode API supported by driver.
297 * @max_inst_size: The maximal length of the fw inst section
298 * @max_data_size: The maximal length of the fw data section
299 * @valid_tx_ant: valid transmit antenna
300 * @valid_rx_ant: valid receive antenna
301 * @non_shared_ant: the antenna that is for WiFi only
302 * @nvm_ver: NVM version
303 * @nvm_calib_ver: NVM calibration version
304 * @lib: pointer to the lib ops
305 * @base_params: pointer to basic parameters
306 * @ht_params: point to ht parameters
307 * @led_mode: 0=blinking, 1=On(RF On)/Off(RF Off)
308 * @rx_with_siso_diversity: 1x1 device with rx antenna diversity
309 * @internal_wimax_coex: internal wifi/wimax combo device
310 * @high_temp: Is this NIC is designated to be in high temperature.
311 * @host_interrupt_operation_mode: device needs host interrupt operation
313 * @nvm_hw_section_num: the ID of the HW NVM section
314 * @mac_addr_from_csr: read HW address from CSR registers
315 * @features: hw features, any combination of feature_whitelist
316 * @pwr_tx_backoffs: translation table between power limits and backoffs
317 * @max_rx_agg_size: max RX aggregation size of the ADDBA request/response
318 * @max_tx_agg_size: max TX aggregation size of the ADDBA request/response
319 * @max_ht_ampdu_factor: the exponent of the max length of A-MPDU that the
320 * station can receive in HT
321 * @max_vht_ampdu_exponent: the exponent of the max length of A-MPDU that the
322 * station can receive in VHT
323 * @dccm_offset: offset from which DCCM begins
324 * @dccm_len: length of DCCM (including runtime stack CCM)
325 * @dccm2_offset: offset from which the second DCCM begins
326 * @dccm2_len: length of the second DCCM
327 * @smem_offset: offset from which the SMEM begins
328 * @smem_len: the length of SMEM
329 * @mq_rx_supported: multi-queue rx support
330 * @vht_mu_mimo_supported: VHT MU-MIMO support
331 * @rf_id: need to read rf_id to determine the firmware image
332 * @integrated: discrete or integrated
333 * @gen2: 22000 and on transport operation
335 * @nvm_type: see &enum iwl_nvm_type
336 * @tx_cmd_queue_size: size of the cmd queue. If zero, use the same value as
339 * We enable the driver to be backward compatible wrt. hardware features.
340 * API differences in uCode shouldn't be handled here but through TLVs
341 * and/or the uCode API version instead.
344 /* params specific to an individual device within a device family */
346 const char *fw_name_pre
;
347 const char *fw_name_pre_b_or_c_step
;
348 const char *fw_name_pre_rf_next_step
;
349 /* params not likely to change within a device family */
350 const struct iwl_base_params
*base_params
;
351 /* params likely to change within a device family */
352 const struct iwl_ht_params
*ht_params
;
353 const struct iwl_eeprom_params
*eeprom_params
;
354 const struct iwl_pwr_tx_backoff
*pwr_tx_backoffs
;
355 const char *default_nvm_file_C_step
;
356 const struct iwl_tt_params
*thermal_params
;
357 enum iwl_device_family device_family
;
358 enum iwl_led_mode led_mode
;
359 enum iwl_nvm_type nvm_type
;
362 netdev_features_t features
;
372 u16 rx_with_siso_diversity
:1,
373 bt_shared_single_ant
:1,
374 internal_wimax_coex
:1,
375 host_interrupt_operation_mode
:1,
378 lp_xtal_workaround
:1,
379 disable_dummy_notification
:1,
380 apmg_not_supported
:1,
382 vht_mu_mimo_supported
:1,
389 u16 tx_cmd_queue_size
;
393 u8 nvm_hw_section_num
;
396 u8 max_ht_ampdu_exponent
;
397 u8 max_vht_ampdu_exponent
;
400 u32 min_umac_error_event_table
;
404 * This list declares the config structures for all devices.
406 #if IS_ENABLED(CONFIG_IWLDVM)
407 extern const struct iwl_cfg iwl5300_agn_cfg
;
408 extern const struct iwl_cfg iwl5100_agn_cfg
;
409 extern const struct iwl_cfg iwl5350_agn_cfg
;
410 extern const struct iwl_cfg iwl5100_bgn_cfg
;
411 extern const struct iwl_cfg iwl5100_abg_cfg
;
412 extern const struct iwl_cfg iwl5150_agn_cfg
;
413 extern const struct iwl_cfg iwl5150_abg_cfg
;
414 extern const struct iwl_cfg iwl6005_2agn_cfg
;
415 extern const struct iwl_cfg iwl6005_2abg_cfg
;
416 extern const struct iwl_cfg iwl6005_2bg_cfg
;
417 extern const struct iwl_cfg iwl6005_2agn_sff_cfg
;
418 extern const struct iwl_cfg iwl6005_2agn_d_cfg
;
419 extern const struct iwl_cfg iwl6005_2agn_mow1_cfg
;
420 extern const struct iwl_cfg iwl6005_2agn_mow2_cfg
;
421 extern const struct iwl_cfg iwl1030_bgn_cfg
;
422 extern const struct iwl_cfg iwl1030_bg_cfg
;
423 extern const struct iwl_cfg iwl6030_2agn_cfg
;
424 extern const struct iwl_cfg iwl6030_2abg_cfg
;
425 extern const struct iwl_cfg iwl6030_2bgn_cfg
;
426 extern const struct iwl_cfg iwl6030_2bg_cfg
;
427 extern const struct iwl_cfg iwl6000i_2agn_cfg
;
428 extern const struct iwl_cfg iwl6000i_2abg_cfg
;
429 extern const struct iwl_cfg iwl6000i_2bg_cfg
;
430 extern const struct iwl_cfg iwl6000_3agn_cfg
;
431 extern const struct iwl_cfg iwl6050_2agn_cfg
;
432 extern const struct iwl_cfg iwl6050_2abg_cfg
;
433 extern const struct iwl_cfg iwl6150_bgn_cfg
;
434 extern const struct iwl_cfg iwl6150_bg_cfg
;
435 extern const struct iwl_cfg iwl1000_bgn_cfg
;
436 extern const struct iwl_cfg iwl1000_bg_cfg
;
437 extern const struct iwl_cfg iwl100_bgn_cfg
;
438 extern const struct iwl_cfg iwl100_bg_cfg
;
439 extern const struct iwl_cfg iwl130_bgn_cfg
;
440 extern const struct iwl_cfg iwl130_bg_cfg
;
441 extern const struct iwl_cfg iwl2000_2bgn_cfg
;
442 extern const struct iwl_cfg iwl2000_2bgn_d_cfg
;
443 extern const struct iwl_cfg iwl2030_2bgn_cfg
;
444 extern const struct iwl_cfg iwl6035_2agn_cfg
;
445 extern const struct iwl_cfg iwl6035_2agn_sff_cfg
;
446 extern const struct iwl_cfg iwl105_bgn_cfg
;
447 extern const struct iwl_cfg iwl105_bgn_d_cfg
;
448 extern const struct iwl_cfg iwl135_bgn_cfg
;
449 #endif /* CONFIG_IWLDVM */
450 #if IS_ENABLED(CONFIG_IWLMVM)
451 extern const struct iwl_cfg iwl7260_2ac_cfg
;
452 extern const struct iwl_cfg iwl7260_2ac_cfg_high_temp
;
453 extern const struct iwl_cfg iwl7260_2n_cfg
;
454 extern const struct iwl_cfg iwl7260_n_cfg
;
455 extern const struct iwl_cfg iwl3160_2ac_cfg
;
456 extern const struct iwl_cfg iwl3160_2n_cfg
;
457 extern const struct iwl_cfg iwl3160_n_cfg
;
458 extern const struct iwl_cfg iwl3165_2ac_cfg
;
459 extern const struct iwl_cfg iwl3168_2ac_cfg
;
460 extern const struct iwl_cfg iwl7265_2ac_cfg
;
461 extern const struct iwl_cfg iwl7265_2n_cfg
;
462 extern const struct iwl_cfg iwl7265_n_cfg
;
463 extern const struct iwl_cfg iwl7265d_2ac_cfg
;
464 extern const struct iwl_cfg iwl7265d_2n_cfg
;
465 extern const struct iwl_cfg iwl7265d_n_cfg
;
466 extern const struct iwl_cfg iwl8260_2n_cfg
;
467 extern const struct iwl_cfg iwl8260_2ac_cfg
;
468 extern const struct iwl_cfg iwl8265_2ac_cfg
;
469 extern const struct iwl_cfg iwl8275_2ac_cfg
;
470 extern const struct iwl_cfg iwl4165_2ac_cfg
;
471 extern const struct iwl_cfg iwl9160_2ac_cfg
;
472 extern const struct iwl_cfg iwl9260_2ac_cfg
;
473 extern const struct iwl_cfg iwl9270_2ac_cfg
;
474 extern const struct iwl_cfg iwl9460_2ac_cfg
;
475 extern const struct iwl_cfg iwl9560_2ac_cfg
;
476 extern const struct iwl_cfg iwl9460_2ac_cfg_soc
;
477 extern const struct iwl_cfg iwl9461_2ac_cfg_soc
;
478 extern const struct iwl_cfg iwl9462_2ac_cfg_soc
;
479 extern const struct iwl_cfg iwl9560_2ac_cfg_soc
;
480 extern const struct iwl_cfg iwl22000_2ac_cfg_hr
;
481 extern const struct iwl_cfg iwl22000_2ac_cfg_hr_cdb
;
482 extern const struct iwl_cfg iwl22000_2ac_cfg_jf
;
483 extern const struct iwl_cfg iwl22000_2ax_cfg_hr
;
484 extern const struct iwl_cfg iwl22000_2ax_cfg_qnj_hr_f0
;
485 extern const struct iwl_cfg iwl22000_2ax_cfg_qnj_jf_b0
;
486 extern const struct iwl_cfg iwl22000_2ax_cfg_qnj_hr_a0
;
487 #endif /* CONFIG_IWLMVM */
489 #endif /* __IWL_CONFIG_H__ */