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,
95 * IWL_LED_DEFAULT: use device default
96 * IWL_LED_RF_STATE: turn LED on/off based on RF state
99 * IWL_LED_BLINK: adjust led blink rate based on blink table
100 * IWL_LED_DISABLE: led disabled
110 * This is the threshold value of plcp error rate per 100mSecs. It is
111 * used to set and check for the validity of plcp_delta.
113 #define IWL_MAX_PLCP_ERR_THRESHOLD_MIN 1
114 #define IWL_MAX_PLCP_ERR_THRESHOLD_DEF 50
115 #define IWL_MAX_PLCP_ERR_LONG_THRESHOLD_DEF 100
116 #define IWL_MAX_PLCP_ERR_EXT_LONG_THRESHOLD_DEF 200
117 #define IWL_MAX_PLCP_ERR_THRESHOLD_MAX 255
118 #define IWL_MAX_PLCP_ERR_THRESHOLD_DISABLE 0
120 /* TX queue watchdog timeouts in mSecs */
121 #define IWL_WATCHDOG_DISABLED 0
122 #define IWL_DEF_WD_TIMEOUT 2500
123 #define IWL_LONG_WD_TIMEOUT 10000
124 #define IWL_MAX_WD_TIMEOUT 120000
126 #define IWL_DEFAULT_MAX_TX_POWER 22
127 #define IWL_TX_CSUM_NETIF_FLAGS (NETIF_F_IPV6_CSUM | NETIF_F_IP_CSUM |\
128 NETIF_F_TSO | NETIF_F_TSO6)
130 /* Antenna presence definitions */
135 #define ANT_AB (ANT_A | ANT_B)
136 #define ANT_AC (ANT_A | ANT_C)
137 #define ANT_BC (ANT_B | ANT_C)
138 #define ANT_ABC (ANT_A | ANT_B | ANT_C)
140 static inline u8 num_of_ant(u8 mask)
142 return !!((mask) & ANT_A) +
148 * @max_ll_items: max number of OTP blocks
149 * @shadow_ram_support: shadow support for OTP memory
150 * @led_compensation: compensate on the led on/off time per HW according
151 * to the deviation to achieve the desired led frequency.
152 * The detail algorithm is described in iwl-led.c
153 * @wd_timeout: TX queues watchdog timeout
154 * @max_event_log_size: size of event log buffer size for ucode event logging
155 * @shadow_reg_enable: HW shadow register support
156 * @apmg_wake_up_wa: should the MAC access REQ be asserted when a command
157 * is in flight. This is due to a HW bug in 7260, 3160 and 7265.
158 * @scd_chain_ext_wa: should the chain extension feature in SCD be disabled.
160 struct iwl_base_params {
161 unsigned int wd_timeout;
164 u16 max_event_log_size;
166 u8 pll_cfg:1, /* for iwl_pcie_apm_init() */
167 shadow_ram_support:1,
173 u16 num_of_queues; /* def: HW dependent */
180 * @stbc: support Tx STBC and 1*SS Rx STBC
181 * @ldpc: support Tx/Rx with LDPC
182 * @use_rts_for_aggregation: use rts/cts protection for HT traffic
183 * @ht40_bands: bitmap of bands (using %NL80211_BAND_*) that support HT40
185 struct iwl_ht_params {
186 u8 ht_greenfield_support:1,
189 use_rts_for_aggregation:1;
194 * Tx-backoff threshold
195 * @temperature: The threshold in Celsius
196 * @backoff: The tx-backoff in uSec
198 struct iwl_tt_tx_backoff {
203 #define TT_TX_BACKOFF_SIZE 6
206 * struct iwl_tt_params - thermal throttling parameters
207 * @ct_kill_entry: CT Kill entry threshold
208 * @ct_kill_exit: CT Kill exit threshold
209 * @ct_kill_duration: The time intervals (in uSec) in which the driver needs
210 * to checks whether to exit CT Kill.
211 * @dynamic_smps_entry: Dynamic SMPS entry threshold
212 * @dynamic_smps_exit: Dynamic SMPS exit threshold
213 * @tx_protection_entry: TX protection entry threshold
214 * @tx_protection_exit: TX protection exit threshold
215 * @tx_backoff: Array of thresholds for tx-backoff , in ascending order.
216 * @support_ct_kill: Support CT Kill?
217 * @support_dynamic_smps: Support dynamic SMPS?
218 * @support_tx_protection: Support tx protection?
219 * @support_tx_backoff: Support tx-backoff?
221 struct iwl_tt_params {
224 u32 ct_kill_duration;
225 u32 dynamic_smps_entry;
226 u32 dynamic_smps_exit;
227 u32 tx_protection_entry;
228 u32 tx_protection_exit;
229 struct iwl_tt_tx_backoff tx_backoff[TT_TX_BACKOFF_SIZE];
230 u8 support_ct_kill:1,
231 support_dynamic_smps:1,
232 support_tx_protection:1,
233 support_tx_backoff:1;
237 * information on how to parse the EEPROM
239 #define EEPROM_REG_BAND_1_CHANNELS 0x08
240 #define EEPROM_REG_BAND_2_CHANNELS 0x26
241 #define EEPROM_REG_BAND_3_CHANNELS 0x42
242 #define EEPROM_REG_BAND_4_CHANNELS 0x5C
243 #define EEPROM_REG_BAND_5_CHANNELS 0x74
244 #define EEPROM_REG_BAND_24_HT40_CHANNELS 0x82
245 #define EEPROM_REG_BAND_52_HT40_CHANNELS 0x92
246 #define EEPROM_6000_REG_BAND_24_HT40_CHANNELS 0x80
247 #define EEPROM_REGULATORY_BAND_NO_HT40 0
249 /* lower blocks contain EEPROM image and calibration data */
250 #define OTP_LOW_IMAGE_SIZE (2 * 512 * sizeof(u16)) /* 2 KB */
251 #define OTP_LOW_IMAGE_SIZE_FAMILY_7000 (16 * 512 * sizeof(u16)) /* 16 KB */
252 #define OTP_LOW_IMAGE_SIZE_FAMILY_8000 (32 * 512 * sizeof(u16)) /* 32 KB */
253 #define OTP_LOW_IMAGE_SIZE_FAMILY_9000 OTP_LOW_IMAGE_SIZE_FAMILY_8000
254 #define OTP_LOW_IMAGE_SIZE_FAMILY_A000 OTP_LOW_IMAGE_SIZE_FAMILY_9000
256 struct iwl_eeprom_params {
257 const u8 regulatory_bands[7];
258 bool enhanced_txpower;
261 /* Tx-backoff power threshold
262 * @pwr: The power limit in mw
263 * @backoff: The tx-backoff in uSec
265 struct iwl_pwr_tx_backoff {
272 * @name: Official name of the device
273 * @fw_name_pre: Firmware filename prefix. The api version and extension
274 * (.ucode) will be added to filename before loading from disk. The
275 * filename is constructed as fw_name_pre<api>.ucode.
276 * @fw_name_pre_next_step: same as @fw_name_pre, only for next step
278 * @ucode_api_max: Highest version of uCode API supported by driver.
279 * @ucode_api_min: Lowest version of uCode API supported by driver.
280 * @max_inst_size: The maximal length of the fw inst section
281 * @max_data_size: The maximal length of the fw data section
282 * @valid_tx_ant: valid transmit antenna
283 * @valid_rx_ant: valid receive antenna
284 * @non_shared_ant: the antenna that is for WiFi only
285 * @nvm_ver: NVM version
286 * @nvm_calib_ver: NVM calibration version
287 * @lib: pointer to the lib ops
288 * @base_params: pointer to basic parameters
289 * @ht_params: point to ht parameters
290 * @led_mode: 0=blinking, 1=On(RF On)/Off(RF Off)
291 * @rx_with_siso_diversity: 1x1 device with rx antenna diversity
292 * @internal_wimax_coex: internal wifi/wimax combo device
293 * @high_temp: Is this NIC is designated to be in high temperature.
294 * @host_interrupt_operation_mode: device needs host interrupt operation
296 * @nvm_hw_section_num: the ID of the HW NVM section
297 * @mac_addr_from_csr: read HW address from CSR registers
298 * @features: hw features, any combination of feature_whitelist
299 * @pwr_tx_backoffs: translation table between power limits and backoffs
300 * @max_rx_agg_size: max RX aggregation size of the ADDBA request/response
301 * @max_tx_agg_size: max TX aggregation size of the ADDBA request/response
302 * @max_ht_ampdu_factor: the exponent of the max length of A-MPDU that the
303 * station can receive in HT
304 * @max_vht_ampdu_exponent: the exponent of the max length of A-MPDU that the
305 * station can receive in VHT
306 * @dccm_offset: offset from which DCCM begins
307 * @dccm_len: length of DCCM (including runtime stack CCM)
308 * @dccm2_offset: offset from which the second DCCM begins
309 * @dccm2_len: length of the second DCCM
310 * @smem_offset: offset from which the SMEM begins
311 * @smem_len: the length of SMEM
312 * @mq_rx_supported: multi-queue rx support
313 * @vht_mu_mimo_supported: VHT MU-MIMO support
314 * @rf_id: need to read rf_id to determine the firmware image
315 * @integrated: discrete or integrated
316 * @gen2: a000 and on transport operation
319 * We enable the driver to be backward compatible wrt. hardware features.
320 * API differences in uCode shouldn't be handled here but through TLVs
321 * and/or the uCode API version instead.
324 /* params specific to an individual device within a device family */
326 const char *fw_name_pre;
327 const char *fw_name_pre_next_step;
328 /* params not likely to change within a device family */
329 const struct iwl_base_params *base_params;
330 /* params likely to change within a device family */
331 const struct iwl_ht_params *ht_params;
332 const struct iwl_eeprom_params *eeprom_params;
333 const struct iwl_pwr_tx_backoff *pwr_tx_backoffs;
334 const char *default_nvm_file_B_step;
335 const char *default_nvm_file_C_step;
336 const struct iwl_tt_params *thermal_params;
337 enum iwl_device_family device_family;
338 enum iwl_led_mode led_mode;
341 netdev_features_t features;
350 u16 rx_with_siso_diversity:1,
351 bt_shared_single_ant:1,
352 internal_wimax_coex:1,
353 host_interrupt_operation_mode:1,
356 lp_xtal_workaround:1,
357 disable_dummy_notification:1,
358 apmg_not_supported:1,
360 vht_mu_mimo_supported:1,
369 u8 nvm_hw_section_num;
372 u8 max_ht_ampdu_exponent;
373 u8 max_vht_ampdu_exponent;
379 * This list declares the config structures for all devices.
381 #if IS_ENABLED(CONFIG_IWLDVM)
382 extern const struct iwl_cfg iwl5300_agn_cfg;
383 extern const struct iwl_cfg iwl5100_agn_cfg;
384 extern const struct iwl_cfg iwl5350_agn_cfg;
385 extern const struct iwl_cfg iwl5100_bgn_cfg;
386 extern const struct iwl_cfg iwl5100_abg_cfg;
387 extern const struct iwl_cfg iwl5150_agn_cfg;
388 extern const struct iwl_cfg iwl5150_abg_cfg;
389 extern const struct iwl_cfg iwl6005_2agn_cfg;
390 extern const struct iwl_cfg iwl6005_2abg_cfg;
391 extern const struct iwl_cfg iwl6005_2bg_cfg;
392 extern const struct iwl_cfg iwl6005_2agn_sff_cfg;
393 extern const struct iwl_cfg iwl6005_2agn_d_cfg;
394 extern const struct iwl_cfg iwl6005_2agn_mow1_cfg;
395 extern const struct iwl_cfg iwl6005_2agn_mow2_cfg;
396 extern const struct iwl_cfg iwl1030_bgn_cfg;
397 extern const struct iwl_cfg iwl1030_bg_cfg;
398 extern const struct iwl_cfg iwl6030_2agn_cfg;
399 extern const struct iwl_cfg iwl6030_2abg_cfg;
400 extern const struct iwl_cfg iwl6030_2bgn_cfg;
401 extern const struct iwl_cfg iwl6030_2bg_cfg;
402 extern const struct iwl_cfg iwl6000i_2agn_cfg;
403 extern const struct iwl_cfg iwl6000i_2abg_cfg;
404 extern const struct iwl_cfg iwl6000i_2bg_cfg;
405 extern const struct iwl_cfg iwl6000_3agn_cfg;
406 extern const struct iwl_cfg iwl6050_2agn_cfg;
407 extern const struct iwl_cfg iwl6050_2abg_cfg;
408 extern const struct iwl_cfg iwl6150_bgn_cfg;
409 extern const struct iwl_cfg iwl6150_bg_cfg;
410 extern const struct iwl_cfg iwl1000_bgn_cfg;
411 extern const struct iwl_cfg iwl1000_bg_cfg;
412 extern const struct iwl_cfg iwl100_bgn_cfg;
413 extern const struct iwl_cfg iwl100_bg_cfg;
414 extern const struct iwl_cfg iwl130_bgn_cfg;
415 extern const struct iwl_cfg iwl130_bg_cfg;
416 extern const struct iwl_cfg iwl2000_2bgn_cfg;
417 extern const struct iwl_cfg iwl2000_2bgn_d_cfg;
418 extern const struct iwl_cfg iwl2030_2bgn_cfg;
419 extern const struct iwl_cfg iwl6035_2agn_cfg;
420 extern const struct iwl_cfg iwl6035_2agn_sff_cfg;
421 extern const struct iwl_cfg iwl105_bgn_cfg;
422 extern const struct iwl_cfg iwl105_bgn_d_cfg;
423 extern const struct iwl_cfg iwl135_bgn_cfg;
424 #endif /* CONFIG_IWLDVM */
425 #if IS_ENABLED(CONFIG_IWLMVM)
426 extern const struct iwl_cfg iwl7260_2ac_cfg;
427 extern const struct iwl_cfg iwl7260_2ac_cfg_high_temp;
428 extern const struct iwl_cfg iwl7260_2n_cfg;
429 extern const struct iwl_cfg iwl7260_n_cfg;
430 extern const struct iwl_cfg iwl3160_2ac_cfg;
431 extern const struct iwl_cfg iwl3160_2n_cfg;
432 extern const struct iwl_cfg iwl3160_n_cfg;
433 extern const struct iwl_cfg iwl3165_2ac_cfg;
434 extern const struct iwl_cfg iwl3168_2ac_cfg;
435 extern const struct iwl_cfg iwl7265_2ac_cfg;
436 extern const struct iwl_cfg iwl7265_2n_cfg;
437 extern const struct iwl_cfg iwl7265_n_cfg;
438 extern const struct iwl_cfg iwl7265d_2ac_cfg;
439 extern const struct iwl_cfg iwl7265d_2n_cfg;
440 extern const struct iwl_cfg iwl7265d_n_cfg;
441 extern const struct iwl_cfg iwl8260_2n_cfg;
442 extern const struct iwl_cfg iwl8260_2ac_cfg;
443 extern const struct iwl_cfg iwl8265_2ac_cfg;
444 extern const struct iwl_cfg iwl8275_2ac_cfg;
445 extern const struct iwl_cfg iwl4165_2ac_cfg;
446 extern const struct iwl_cfg iwl8260_2ac_sdio_cfg;
447 extern const struct iwl_cfg iwl8265_2ac_sdio_cfg;
448 extern const struct iwl_cfg iwl4165_2ac_sdio_cfg;
449 extern const struct iwl_cfg iwl9160_2ac_cfg;
450 extern const struct iwl_cfg iwl9260_2ac_cfg;
451 extern const struct iwl_cfg iwl9270_2ac_cfg;
452 extern const struct iwl_cfg iwl9460_2ac_cfg;
453 extern const struct iwl_cfg iwl9560_2ac_cfg;
454 extern const struct iwl_cfg iwla000_2ac_cfg_hr;
455 extern const struct iwl_cfg iwla000_2ac_cfg_hr_cdb;
456 extern const struct iwl_cfg iwla000_2ac_cfg_jf;
457 #endif /* CONFIG_IWLMVM */
459 #endif /* __IWL_CONFIG_H__ */