drivers/net/wireless/intel/iwlwifi/iwl-config.h

   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 - 2017 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 - 2017 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         IWL_DEVICE_FAMILY_9000,
  92         IWL_DEVICE_FAMILY_A000,
  93 };
  94
  95 /*
  96  * LED mode
  97  *    IWL_LED_DEFAULT:  use device default
  98  *    IWL_LED_RF_STATE: turn LED on/off based on RF state
  99  *                      LED ON  = RF ON
 100  *                      LED OFF = RF OFF
 101  *    IWL_LED_BLINK:    adjust led blink rate based on blink table
 102  *    IWL_LED_DISABLE:  led disabled
 103  */
 104 enum iwl_led_mode {
 105         IWL_LED_DEFAULT,
 106         IWL_LED_RF_STATE,
 107         IWL_LED_BLINK,
 108         IWL_LED_DISABLE,
 109 };
 110
 111 /*
 112  * This is the threshold value of plcp error rate per 100mSecs.  It is
 113  * used to set and check for the validity of plcp_delta.
 114  */
 115 #define IWL_MAX_PLCP_ERR_THRESHOLD_MIN          1
 116 #define IWL_MAX_PLCP_ERR_THRESHOLD_DEF          50
 117 #define IWL_MAX_PLCP_ERR_LONG_THRESHOLD_DEF     100
 118 #define IWL_MAX_PLCP_ERR_EXT_LONG_THRESHOLD_DEF 200
 119 #define IWL_MAX_PLCP_ERR_THRESHOLD_MAX          255
 120 #define IWL_MAX_PLCP_ERR_THRESHOLD_DISABLE      0
 121
 122 /* TX queue watchdog timeouts in mSecs */
 123 #define IWL_WATCHDOG_DISABLED   0
 124 #define IWL_DEF_WD_TIMEOUT      2500
 125 #define IWL_LONG_WD_TIMEOUT     10000
 126 #define IWL_MAX_WD_TIMEOUT      120000
 127
 128 #define IWL_DEFAULT_MAX_TX_POWER 22
 129 #define IWL_TX_CSUM_NETIF_FLAGS (NETIF_F_IPV6_CSUM | NETIF_F_IP_CSUM |\
 130                                  NETIF_F_TSO | NETIF_F_TSO6)
 131
 132 /* Antenna presence definitions */
 133 #define ANT_NONE        0x0
 134 #define ANT_INVALID     0xff
 135 #define ANT_A           BIT(0)
 136 #define ANT_B           BIT(1)
 137 #define ANT_C           BIT(2)
 138 #define ANT_AB          (ANT_A | ANT_B)
 139 #define ANT_AC          (ANT_A | ANT_C)
 140 #define ANT_BC          (ANT_B | ANT_C)
 141 #define ANT_ABC         (ANT_A | ANT_B | ANT_C)
 142
 143 static inline u8 num_of_ant(u8 mask)
 144 {
 145         return  !!((mask) & ANT_A) +
 146                 !!((mask) & ANT_B) +
 147                 !!((mask) & ANT_C);
 148 }
 149
 150 /*
 151  * @max_ll_items: max number of OTP blocks
 152  * @shadow_ram_support: shadow support for OTP memory
 153  * @led_compensation: compensate on the led on/off time per HW according
 154  *      to the deviation to achieve the desired led frequency.
 155  *      The detail algorithm is described in iwl-led.c
 156  * @wd_timeout: TX queues watchdog timeout
 157  * @max_event_log_size: size of event log buffer size for ucode event logging
 158  * @shadow_reg_enable: HW shadow register support
 159  * @apmg_wake_up_wa: should the MAC access REQ be asserted when a command
 160  *      is in flight. This is due to a HW bug in 7260, 3160 and 7265.
 161  * @scd_chain_ext_wa: should the chain extension feature in SCD be disabled.
 162  */
 163 struct iwl_base_params {
 164         unsigned int wd_timeout;
 165
 166         u16 eeprom_size;
 167         u16 max_event_log_size;
 168
 169         u8 pll_cfg:1, /* for iwl_pcie_apm_init() */
 170            shadow_ram_support:1,
 171            shadow_reg_enable:1,
 172            pcie_l1_allowed:1,
 173            apmg_wake_up_wa:1,
 174            scd_chain_ext_wa:1;
 175
 176         u16 num_of_queues;      /* def: HW dependent */
 177
 178         u8 max_ll_items;
 179         u8 led_compensation;
 180 };
 181
 182 /*
 183  * @stbc: support Tx STBC and 1*SS Rx STBC
 184  * @ldpc: support Tx/Rx with LDPC
 185  * @use_rts_for_aggregation: use rts/cts protection for HT traffic
 186  * @ht40_bands: bitmap of bands (using %NL80211_BAND_*) that support HT40
 187  */
 188 struct iwl_ht_params {
 189         u8 ht_greenfield_support:1,
 190            stbc:1,
 191            ldpc:1,
 192            use_rts_for_aggregation:1;
 193         u8 ht40_bands;
 194 };
 195
 196 /*
 197  * Tx-backoff threshold
 198  * @temperature: The threshold in Celsius
 199  * @backoff: The tx-backoff in uSec
 200  */
 201 struct iwl_tt_tx_backoff {
 202         s32 temperature;
 203         u32 backoff;
 204 };
 205
 206 #define TT_TX_BACKOFF_SIZE 6
 207
 208 /**
 209  * struct iwl_tt_params - thermal throttling parameters
 210  * @ct_kill_entry: CT Kill entry threshold
 211  * @ct_kill_exit: CT Kill exit threshold
 212  * @ct_kill_duration: The time  intervals (in uSec) in which the driver needs
 213  *      to checks whether to exit CT Kill.
 214  * @dynamic_smps_entry: Dynamic SMPS entry threshold
 215  * @dynamic_smps_exit: Dynamic SMPS exit threshold
 216  * @tx_protection_entry: TX protection entry threshold
 217  * @tx_protection_exit: TX protection exit threshold
 218  * @tx_backoff: Array of thresholds for tx-backoff , in ascending order.
 219  * @support_ct_kill: Support CT Kill?
 220  * @support_dynamic_smps: Support dynamic SMPS?
 221  * @support_tx_protection: Support tx protection?
 222  * @support_tx_backoff: Support tx-backoff?
 223  */
 224 struct iwl_tt_params {
 225         u32 ct_kill_entry;
 226         u32 ct_kill_exit;
 227         u32 ct_kill_duration;
 228         u32 dynamic_smps_entry;
 229         u32 dynamic_smps_exit;
 230         u32 tx_protection_entry;
 231         u32 tx_protection_exit;
 232         struct iwl_tt_tx_backoff tx_backoff[TT_TX_BACKOFF_SIZE];
 233         u8 support_ct_kill:1,
 234            support_dynamic_smps:1,
 235            support_tx_protection:1,
 236            support_tx_backoff:1;
 237 };
 238
 239 /*
 240  * information on how to parse the EEPROM
 241  */
 242 #define EEPROM_REG_BAND_1_CHANNELS              0x08
 243 #define EEPROM_REG_BAND_2_CHANNELS              0x26
 244 #define EEPROM_REG_BAND_3_CHANNELS              0x42
 245 #define EEPROM_REG_BAND_4_CHANNELS              0x5C
 246 #define EEPROM_REG_BAND_5_CHANNELS              0x74
 247 #define EEPROM_REG_BAND_24_HT40_CHANNELS        0x82
 248 #define EEPROM_REG_BAND_52_HT40_CHANNELS        0x92
 249 #define EEPROM_6000_REG_BAND_24_HT40_CHANNELS   0x80
 250 #define EEPROM_REGULATORY_BAND_NO_HT40          0
 251
 252 /* lower blocks contain EEPROM image and calibration data */
 253 #define OTP_LOW_IMAGE_SIZE              (2 * 512 * sizeof(u16)) /* 2 KB */
 254 #define OTP_LOW_IMAGE_SIZE_FAMILY_7000  (16 * 512 * sizeof(u16)) /* 16 KB */
 255 #define OTP_LOW_IMAGE_SIZE_FAMILY_8000  (32 * 512 * sizeof(u16)) /* 32 KB */
 256 #define OTP_LOW_IMAGE_SIZE_FAMILY_9000  OTP_LOW_IMAGE_SIZE_FAMILY_8000
 257 #define OTP_LOW_IMAGE_SIZE_FAMILY_A000  OTP_LOW_IMAGE_SIZE_FAMILY_9000
 258
 259 struct iwl_eeprom_params {
 260         const u8 regulatory_bands[7];
 261         bool enhanced_txpower;
 262 };
 263
 264 /* Tx-backoff power threshold
 265  * @pwr: The power limit in mw
 266  * @backoff: The tx-backoff in uSec
 267  */
 268 struct iwl_pwr_tx_backoff {
 269         u32 pwr;
 270         u32 backoff;
 271 };
 272
 273 /**
 274  * struct iwl_cfg
 275  * @name: Official name of the device
 276  * @fw_name_pre: Firmware filename prefix. The api version and extension
 277  *      (.ucode) will be added to filename before loading from disk. The
 278  *      filename is constructed as fw_name_pre<api>.ucode.
 279  * @fw_name_pre_next_step: same as @fw_name_pre, only for next step
 280  *      (if supported)
 281  * @fw_name_pre_rf_next_step: same as @fw_name_pre_next_step, only for rf next
 282  *      step. Supported only in integrated solutions.
 283  * @ucode_api_max: Highest version of uCode API supported by driver.
 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
 300  *      mode set
 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
 319  * @rf_id: need to read rf_id to determine the firmware image
 320  * @integrated: discrete or integrated
 321  * @gen2: a000 and on transport operation
 322  * @cdb: CDB support
 323  * @ext_nvm: extended NVM format
 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         const char *fw_name_pre_next_step;
 334         const char *fw_name_pre_rf_next_step;
 335         /* params not likely to change within a device family */
 336         const struct iwl_base_params *base_params;
 337         /* params likely to change within a device family */
 338         const struct iwl_ht_params *ht_params;
 339         const struct iwl_eeprom_params *eeprom_params;
 340         const struct iwl_pwr_tx_backoff *pwr_tx_backoffs;
 341         const char *default_nvm_file_C_step;
 342         const struct iwl_tt_params *thermal_params;
 343         enum iwl_device_family device_family;
 344         enum iwl_led_mode led_mode;
 345         u32 max_data_size;
 346         u32 max_inst_size;
 347         netdev_features_t features;
 348         u32 dccm_offset;
 349         u32 dccm_len;
 350         u32 dccm2_offset;
 351         u32 dccm2_len;
 352         u32 smem_offset;
 353         u32 smem_len;
 354         u16 nvm_ver;
 355         u16 nvm_calib_ver;
 356         u16 rx_with_siso_diversity:1,
 357             bt_shared_single_ant:1,
 358             internal_wimax_coex:1,
 359             host_interrupt_operation_mode:1,
 360             high_temp:1,
 361             mac_addr_from_csr:1,
 362             lp_xtal_workaround:1,
 363             disable_dummy_notification:1,
 364             apmg_not_supported:1,
 365             mq_rx_supported:1,
 366             vht_mu_mimo_supported:1,
 367             rf_id:1,
 368             integrated:1,
 369             use_tfh:1,
 370             gen2:1,
 371             cdb:1,
 372             ext_nvm:1,
 373             dbgc_supported:1;
 374         u8 valid_tx_ant;
 375         u8 valid_rx_ant;
 376         u8 non_shared_ant;
 377         u8 nvm_hw_section_num;
 378         u8 max_rx_agg_size;
 379         u8 max_tx_agg_size;
 380         u8 max_ht_ampdu_exponent;
 381         u8 max_vht_ampdu_exponent;
 382         u8 ucode_api_max;
 383         u8 ucode_api_min;
 384 };
 385
 386 /*
 387  * This list declares the config structures for all devices.
 388  */
 389 #if IS_ENABLED(CONFIG_IWLDVM)
 390 extern const struct iwl_cfg iwl5300_agn_cfg;
 391 extern const struct iwl_cfg iwl5100_agn_cfg;
 392 extern const struct iwl_cfg iwl5350_agn_cfg;
 393 extern const struct iwl_cfg iwl5100_bgn_cfg;
 394 extern const struct iwl_cfg iwl5100_abg_cfg;
 395 extern const struct iwl_cfg iwl5150_agn_cfg;
 396 extern const struct iwl_cfg iwl5150_abg_cfg;
 397 extern const struct iwl_cfg iwl6005_2agn_cfg;
 398 extern const struct iwl_cfg iwl6005_2abg_cfg;
 399 extern const struct iwl_cfg iwl6005_2bg_cfg;
 400 extern const struct iwl_cfg iwl6005_2agn_sff_cfg;
 401 extern const struct iwl_cfg iwl6005_2agn_d_cfg;
 402 extern const struct iwl_cfg iwl6005_2agn_mow1_cfg;
 403 extern const struct iwl_cfg iwl6005_2agn_mow2_cfg;
 404 extern const struct iwl_cfg iwl1030_bgn_cfg;
 405 extern const struct iwl_cfg iwl1030_bg_cfg;
 406 extern const struct iwl_cfg iwl6030_2agn_cfg;
 407 extern const struct iwl_cfg iwl6030_2abg_cfg;
 408 extern const struct iwl_cfg iwl6030_2bgn_cfg;
 409 extern const struct iwl_cfg iwl6030_2bg_cfg;
 410 extern const struct iwl_cfg iwl6000i_2agn_cfg;
 411 extern const struct iwl_cfg iwl6000i_2abg_cfg;
 412 extern const struct iwl_cfg iwl6000i_2bg_cfg;
 413 extern const struct iwl_cfg iwl6000_3agn_cfg;
 414 extern const struct iwl_cfg iwl6050_2agn_cfg;
 415 extern const struct iwl_cfg iwl6050_2abg_cfg;
 416 extern const struct iwl_cfg iwl6150_bgn_cfg;
 417 extern const struct iwl_cfg iwl6150_bg_cfg;
 418 extern const struct iwl_cfg iwl1000_bgn_cfg;
 419 extern const struct iwl_cfg iwl1000_bg_cfg;
 420 extern const struct iwl_cfg iwl100_bgn_cfg;
 421 extern const struct iwl_cfg iwl100_bg_cfg;
 422 extern const struct iwl_cfg iwl130_bgn_cfg;
 423 extern const struct iwl_cfg iwl130_bg_cfg;
 424 extern const struct iwl_cfg iwl2000_2bgn_cfg;
 425 extern const struct iwl_cfg iwl2000_2bgn_d_cfg;
 426 extern const struct iwl_cfg iwl2030_2bgn_cfg;
 427 extern const struct iwl_cfg iwl6035_2agn_cfg;
 428 extern const struct iwl_cfg iwl6035_2agn_sff_cfg;
 429 extern const struct iwl_cfg iwl105_bgn_cfg;
 430 extern const struct iwl_cfg iwl105_bgn_d_cfg;
 431 extern const struct iwl_cfg iwl135_bgn_cfg;
 432 #endif /* CONFIG_IWLDVM */
 433 #if IS_ENABLED(CONFIG_IWLMVM)
 434 extern const struct iwl_cfg iwl7260_2ac_cfg;
 435 extern const struct iwl_cfg iwl7260_2ac_cfg_high_temp;
 436 extern const struct iwl_cfg iwl7260_2n_cfg;
 437 extern const struct iwl_cfg iwl7260_n_cfg;
 438 extern const struct iwl_cfg iwl3160_2ac_cfg;
 439 extern const struct iwl_cfg iwl3160_2n_cfg;
 440 extern const struct iwl_cfg iwl3160_n_cfg;
 441 extern const struct iwl_cfg iwl3165_2ac_cfg;
 442 extern const struct iwl_cfg iwl3168_2ac_cfg;
 443 extern const struct iwl_cfg iwl7265_2ac_cfg;
 444 extern const struct iwl_cfg iwl7265_2n_cfg;
 445 extern const struct iwl_cfg iwl7265_n_cfg;
 446 extern const struct iwl_cfg iwl7265d_2ac_cfg;
 447 extern const struct iwl_cfg iwl7265d_2n_cfg;
 448 extern const struct iwl_cfg iwl7265d_n_cfg;
 449 extern const struct iwl_cfg iwl8260_2n_cfg;
 450 extern const struct iwl_cfg iwl8260_2ac_cfg;
 451 extern const struct iwl_cfg iwl8265_2ac_cfg;
 452 extern const struct iwl_cfg iwl8275_2ac_cfg;
 453 extern const struct iwl_cfg iwl4165_2ac_cfg;
 454 extern const struct iwl_cfg iwl8260_2ac_sdio_cfg;
 455 extern const struct iwl_cfg iwl8265_2ac_sdio_cfg;
 456 extern const struct iwl_cfg iwl4165_2ac_sdio_cfg;
 457 extern const struct iwl_cfg iwl9160_2ac_cfg;
 458 extern const struct iwl_cfg iwl9260_2ac_cfg;
 459 extern const struct iwl_cfg iwl9270_2ac_cfg;
 460 extern const struct iwl_cfg iwl9460_2ac_cfg;
 461 extern const struct iwl_cfg iwl9560_2ac_cfg;
 462 extern const struct iwl_cfg iwla000_2ac_cfg_hr;
 463 extern const struct iwl_cfg iwla000_2ac_cfg_hr_cdb;
 464 extern const struct iwl_cfg iwla000_2ac_cfg_jf;
 465 extern const struct iwl_cfg iwla000_2ax_cfg_hr;
 466 #endif /* CONFIG_IWLMVM */
 467
 468 #endif /* __IWL_CONFIG_H__ */