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.
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.
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.
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,
24 * The full GNU General Public License is included in this distribution
25 * in the file called COPYING.
27 * Contact Information:
28 * Intel Linux Wireless <linuxwifi@intel.com>
29 * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
33 * Copyright(c) 2005 - 2014 Intel Corporation. All rights reserved.
34 * All rights reserved.
36 * Redistribution and use in source and binary forms, with or without
37 * modification, are permitted provided that the following conditions
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
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.
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.
62 *****************************************************************************/
63 #ifndef __IWL_CONFIG_H__
64 #define __IWL_CONFIG_H__
66 #include <linux/types.h>
67 #include <net/mac80211.h>
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,
90 static inline bool iwl_has_secure_boot(u32 hw_rev,
91 enum iwl_device_family family)
93 /* return 1 only for family 8000 B0 */
94 if ((family == IWL_DEVICE_FAMILY_8000) && (hw_rev & 0xC))
102 * IWL_LED_DEFAULT: use device default
103 * IWL_LED_RF_STATE: turn LED on/off based on RF state
106 * IWL_LED_BLINK: adjust led blink rate based on blink table
107 * IWL_LED_DISABLE: led disabled
117 * This is the threshold value of plcp error rate per 100mSecs. It is
118 * used to set and check for the validity of plcp_delta.
120 #define IWL_MAX_PLCP_ERR_THRESHOLD_MIN 1
121 #define IWL_MAX_PLCP_ERR_THRESHOLD_DEF 50
122 #define IWL_MAX_PLCP_ERR_LONG_THRESHOLD_DEF 100
123 #define IWL_MAX_PLCP_ERR_EXT_LONG_THRESHOLD_DEF 200
124 #define IWL_MAX_PLCP_ERR_THRESHOLD_MAX 255
125 #define IWL_MAX_PLCP_ERR_THRESHOLD_DISABLE 0
127 /* TX queue watchdog timeouts in mSecs */
128 #define IWL_WATCHDOG_DISABLED 0
129 #define IWL_DEF_WD_TIMEOUT 2500
130 #define IWL_LONG_WD_TIMEOUT 10000
131 #define IWL_MAX_WD_TIMEOUT 120000
133 #define IWL_DEFAULT_MAX_TX_POWER 22
134 #define IWL_TX_CSUM_NETIF_FLAGS (NETIF_F_IPV6_CSUM | NETIF_F_IP_CSUM |\
135 NETIF_F_TSO | NETIF_F_TSO6)
137 /* Antenna presence definitions */
142 #define ANT_AB (ANT_A | ANT_B)
143 #define ANT_AC (ANT_A | ANT_C)
144 #define ANT_BC (ANT_B | ANT_C)
145 #define ANT_ABC (ANT_A | ANT_B | ANT_C)
147 static inline u8 num_of_ant(u8 mask)
149 return !!((mask) & ANT_A) +
155 * @max_ll_items: max number of OTP blocks
156 * @shadow_ram_support: shadow support for OTP memory
157 * @led_compensation: compensate on the led on/off time per HW according
158 * to the deviation to achieve the desired led frequency.
159 * The detail algorithm is described in iwl-led.c
160 * @wd_timeout: TX queues watchdog timeout
161 * @max_event_log_size: size of event log buffer size for ucode event logging
162 * @shadow_reg_enable: HW shadow register support
163 * @apmg_wake_up_wa: should the MAC access REQ be asserted when a command
164 * is in flight. This is due to a HW bug in 7260, 3160 and 7265.
165 * @scd_chain_ext_wa: should the chain extension feature in SCD be disabled.
167 struct iwl_base_params {
169 int num_of_queues; /* def: HW dependent */
170 /* for iwl_pcie_apm_init() */
173 const u16 max_ll_items;
174 const bool shadow_ram_support;
175 u16 led_compensation;
176 unsigned int wd_timeout;
177 u32 max_event_log_size;
178 const bool shadow_reg_enable;
179 const bool pcie_l1_allowed;
180 const bool apmg_wake_up_wa;
181 const bool scd_chain_ext_wa;
185 * @stbc: support Tx STBC and 1*SS Rx STBC
186 * @ldpc: support Tx/Rx with LDPC
187 * @use_rts_for_aggregation: use rts/cts protection for HT traffic
188 * @ht40_bands: bitmap of bands (using %IEEE80211_BAND_*) that support HT40
190 struct iwl_ht_params {
191 enum ieee80211_smps_mode smps_mode;
192 const bool ht_greenfield_support; /* if used set to true */
195 bool use_rts_for_aggregation;
200 * Tx-backoff threshold
201 * @temperature: The threshold in Celsius
202 * @backoff: The tx-backoff in uSec
204 struct iwl_tt_tx_backoff {
209 #define TT_TX_BACKOFF_SIZE 6
212 * struct iwl_tt_params - thermal throttling parameters
213 * @ct_kill_entry: CT Kill entry threshold
214 * @ct_kill_exit: CT Kill exit threshold
215 * @ct_kill_duration: The time intervals (in uSec) in which the driver needs
216 * to checks whether to exit CT Kill.
217 * @dynamic_smps_entry: Dynamic SMPS entry threshold
218 * @dynamic_smps_exit: Dynamic SMPS exit threshold
219 * @tx_protection_entry: TX protection entry threshold
220 * @tx_protection_exit: TX protection exit threshold
221 * @tx_backoff: Array of thresholds for tx-backoff , in ascending order.
222 * @support_ct_kill: Support CT Kill?
223 * @support_dynamic_smps: Support dynamic SMPS?
224 * @support_tx_protection: Support tx protection?
225 * @support_tx_backoff: Support tx-backoff?
227 struct iwl_tt_params {
230 u32 ct_kill_duration;
231 u32 dynamic_smps_entry;
232 u32 dynamic_smps_exit;
233 u32 tx_protection_entry;
234 u32 tx_protection_exit;
235 struct iwl_tt_tx_backoff tx_backoff[TT_TX_BACKOFF_SIZE];
236 bool support_ct_kill;
237 bool support_dynamic_smps;
238 bool support_tx_protection;
239 bool support_tx_backoff;
243 * information on how to parse the EEPROM
245 #define EEPROM_REG_BAND_1_CHANNELS 0x08
246 #define EEPROM_REG_BAND_2_CHANNELS 0x26
247 #define EEPROM_REG_BAND_3_CHANNELS 0x42
248 #define EEPROM_REG_BAND_4_CHANNELS 0x5C
249 #define EEPROM_REG_BAND_5_CHANNELS 0x74
250 #define EEPROM_REG_BAND_24_HT40_CHANNELS 0x82
251 #define EEPROM_REG_BAND_52_HT40_CHANNELS 0x92
252 #define EEPROM_6000_REG_BAND_24_HT40_CHANNELS 0x80
253 #define EEPROM_REGULATORY_BAND_NO_HT40 0
255 /* lower blocks contain EEPROM image and calibration data */
256 #define OTP_LOW_IMAGE_SIZE (2 * 512 * sizeof(u16)) /* 2 KB */
257 #define OTP_LOW_IMAGE_SIZE_FAMILY_7000 (16 * 512 * sizeof(u16)) /* 16 KB */
258 #define OTP_LOW_IMAGE_SIZE_FAMILY_8000 (32 * 512 * sizeof(u16)) /* 32 KB */
259 #define OTP_LOW_IMAGE_SIZE_FAMILY_9000 OTP_LOW_IMAGE_SIZE_FAMILY_8000
261 struct iwl_eeprom_params {
262 const u8 regulatory_bands[7];
263 bool enhanced_txpower;
266 /* Tx-backoff power threshold
267 * @pwr: The power limit in mw
268 * @backoff: The tx-backoff in uSec
270 struct iwl_pwr_tx_backoff {
277 * @name: Official name of the device
278 * @fw_name_pre: Firmware filename prefix. The api version and extension
279 * (.ucode) will be added to filename before loading from disk. The
280 * filename is constructed as fw_name_pre<api>.ucode.
281 * @ucode_api_max: Highest version of uCode API supported by driver.
282 * @ucode_api_ok: oldest version of the uCode API that is OK to load
283 * without a warning, for use in transitions
284 * @ucode_api_min: Lowest version of uCode API supported by driver.
285 * @max_inst_size: The maximal length of the fw inst section
286 * @max_data_size: The maximal length of the fw data section
287 * @valid_tx_ant: valid transmit antenna
288 * @valid_rx_ant: valid receive antenna
289 * @non_shared_ant: the antenna that is for WiFi only
290 * @nvm_ver: NVM version
291 * @nvm_calib_ver: NVM calibration version
292 * @lib: pointer to the lib ops
293 * @base_params: pointer to basic parameters
294 * @ht_params: point to ht parameters
295 * @led_mode: 0=blinking, 1=On(RF On)/Off(RF Off)
296 * @rx_with_siso_diversity: 1x1 device with rx antenna diversity
297 * @internal_wimax_coex: internal wifi/wimax combo device
298 * @high_temp: Is this NIC is designated to be in high temperature.
299 * @host_interrupt_operation_mode: device needs host interrupt operation
301 * @nvm_hw_section_num: the ID of the HW NVM section
302 * @mac_addr_from_csr: read HW address from CSR registers
303 * @features: hw features, any combination of feature_whitelist
304 * @pwr_tx_backoffs: translation table between power limits and backoffs
305 * @max_rx_agg_size: max RX aggregation size of the ADDBA request/response
306 * @max_tx_agg_size: max TX aggregation size of the ADDBA request/response
307 * @max_ht_ampdu_factor: the exponent of the max length of A-MPDU that the
308 * station can receive in HT
309 * @max_vht_ampdu_exponent: the exponent of the max length of A-MPDU that the
310 * station can receive in VHT
311 * @dccm_offset: offset from which DCCM begins
312 * @dccm_len: length of DCCM (including runtime stack CCM)
313 * @dccm2_offset: offset from which the second DCCM begins
314 * @dccm2_len: length of the second DCCM
315 * @smem_offset: offset from which the SMEM begins
316 * @smem_len: the length of SMEM
317 * @mq_rx_supported: multi-queue rx support
318 * @vht_mu_mimo_supported: VHT MU-MIMO support
320 * We enable the driver to be backward compatible wrt. hardware features.
321 * API differences in uCode shouldn't be handled here but through TLVs
322 * and/or the uCode API version instead.
325 /* params specific to an individual device within a device family */
327 const char *fw_name_pre;
328 const unsigned int ucode_api_max;
329 const unsigned int ucode_api_ok;
330 const unsigned int ucode_api_min;
331 const enum iwl_device_family device_family;
332 const u32 max_data_size;
333 const u32 max_inst_size;
337 bool bt_shared_single_ant;
340 /* params not likely to change within a device family */
341 const struct iwl_base_params *base_params;
342 /* params likely to change within a device family */
343 const struct iwl_ht_params *ht_params;
344 const struct iwl_eeprom_params *eeprom_params;
345 enum iwl_led_mode led_mode;
346 const bool rx_with_siso_diversity;
347 const bool internal_wimax_coex;
348 const bool host_interrupt_operation_mode;
350 u8 nvm_hw_section_num;
351 bool mac_addr_from_csr;
352 bool lp_xtal_workaround;
353 const struct iwl_pwr_tx_backoff *pwr_tx_backoffs;
354 bool no_power_up_nic_in_init;
355 const char *default_nvm_file_B_step;
356 const char *default_nvm_file_C_step;
357 netdev_features_t features;
358 unsigned int max_rx_agg_size;
359 bool disable_dummy_notification;
360 unsigned int max_tx_agg_size;
361 unsigned int max_ht_ampdu_exponent;
362 unsigned int max_vht_ampdu_exponent;
363 const u32 dccm_offset;
365 const u32 dccm2_offset;
367 const u32 smem_offset;
369 const struct iwl_tt_params *thermal_params;
370 bool apmg_not_supported;
371 bool mq_rx_supported;
372 bool vht_mu_mimo_supported;
376 * This list declares the config structures for all devices.
378 #if IS_ENABLED(CONFIG_IWLDVM)
379 extern const struct iwl_cfg iwl5300_agn_cfg;
380 extern const struct iwl_cfg iwl5100_agn_cfg;
381 extern const struct iwl_cfg iwl5350_agn_cfg;
382 extern const struct iwl_cfg iwl5100_bgn_cfg;
383 extern const struct iwl_cfg iwl5100_abg_cfg;
384 extern const struct iwl_cfg iwl5150_agn_cfg;
385 extern const struct iwl_cfg iwl5150_abg_cfg;
386 extern const struct iwl_cfg iwl6005_2agn_cfg;
387 extern const struct iwl_cfg iwl6005_2abg_cfg;
388 extern const struct iwl_cfg iwl6005_2bg_cfg;
389 extern const struct iwl_cfg iwl6005_2agn_sff_cfg;
390 extern const struct iwl_cfg iwl6005_2agn_d_cfg;
391 extern const struct iwl_cfg iwl6005_2agn_mow1_cfg;
392 extern const struct iwl_cfg iwl6005_2agn_mow2_cfg;
393 extern const struct iwl_cfg iwl1030_bgn_cfg;
394 extern const struct iwl_cfg iwl1030_bg_cfg;
395 extern const struct iwl_cfg iwl6030_2agn_cfg;
396 extern const struct iwl_cfg iwl6030_2abg_cfg;
397 extern const struct iwl_cfg iwl6030_2bgn_cfg;
398 extern const struct iwl_cfg iwl6030_2bg_cfg;
399 extern const struct iwl_cfg iwl6000i_2agn_cfg;
400 extern const struct iwl_cfg iwl6000i_2abg_cfg;
401 extern const struct iwl_cfg iwl6000i_2bg_cfg;
402 extern const struct iwl_cfg iwl6000_3agn_cfg;
403 extern const struct iwl_cfg iwl6050_2agn_cfg;
404 extern const struct iwl_cfg iwl6050_2abg_cfg;
405 extern const struct iwl_cfg iwl6150_bgn_cfg;
406 extern const struct iwl_cfg iwl6150_bg_cfg;
407 extern const struct iwl_cfg iwl1000_bgn_cfg;
408 extern const struct iwl_cfg iwl1000_bg_cfg;
409 extern const struct iwl_cfg iwl100_bgn_cfg;
410 extern const struct iwl_cfg iwl100_bg_cfg;
411 extern const struct iwl_cfg iwl130_bgn_cfg;
412 extern const struct iwl_cfg iwl130_bg_cfg;
413 extern const struct iwl_cfg iwl2000_2bgn_cfg;
414 extern const struct iwl_cfg iwl2000_2bgn_d_cfg;
415 extern const struct iwl_cfg iwl2030_2bgn_cfg;
416 extern const struct iwl_cfg iwl6035_2agn_cfg;
417 extern const struct iwl_cfg iwl6035_2agn_sff_cfg;
418 extern const struct iwl_cfg iwl105_bgn_cfg;
419 extern const struct iwl_cfg iwl105_bgn_d_cfg;
420 extern const struct iwl_cfg iwl135_bgn_cfg;
421 #endif /* CONFIG_IWLDVM */
422 #if IS_ENABLED(CONFIG_IWLMVM)
423 extern const struct iwl_cfg iwl7260_2ac_cfg;
424 extern const struct iwl_cfg iwl7260_2ac_cfg_high_temp;
425 extern const struct iwl_cfg iwl7260_2n_cfg;
426 extern const struct iwl_cfg iwl7260_n_cfg;
427 extern const struct iwl_cfg iwl3160_2ac_cfg;
428 extern const struct iwl_cfg iwl3160_2n_cfg;
429 extern const struct iwl_cfg iwl3160_n_cfg;
430 extern const struct iwl_cfg iwl3165_2ac_cfg;
431 extern const struct iwl_cfg iwl3168_2ac_cfg;
432 extern const struct iwl_cfg iwl7265_2ac_cfg;
433 extern const struct iwl_cfg iwl7265_2n_cfg;
434 extern const struct iwl_cfg iwl7265_n_cfg;
435 extern const struct iwl_cfg iwl7265d_2ac_cfg;
436 extern const struct iwl_cfg iwl7265d_2n_cfg;
437 extern const struct iwl_cfg iwl7265d_n_cfg;
438 extern const struct iwl_cfg iwl8260_2n_cfg;
439 extern const struct iwl_cfg iwl8260_2ac_cfg;
440 extern const struct iwl_cfg iwl8265_2ac_cfg;
441 extern const struct iwl_cfg iwl4165_2ac_cfg;
442 extern const struct iwl_cfg iwl8260_2ac_sdio_cfg;
443 extern const struct iwl_cfg iwl4165_2ac_sdio_cfg;
444 extern const struct iwl_cfg iwl9560_2ac_cfg;
445 extern const struct iwl_cfg iwl5165_2ac_cfg;
446 #endif /* CONFIG_IWLMVM */
448 #endif /* __IWL_CONFIG_H__ */