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  *
  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.
  13  *
  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.
  18  *
  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,
  22  * USA
  23  *
  24  * The full GNU General Public License is included in this distribution
  25  * in the file called COPYING.
  26  *
  27  * Contact Information:
  28  *  Intel Linux Wireless <linuxwifi@intel.com>
  29  * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
  30  *
  31  * BSD LICENSE
  32  *
  33  * Copyright(c) 2005 - 2014 Intel Corporation. All rights reserved.
  34  * All rights reserved.
  35  *
  36  * Redistribution and use in source and binary forms, with or without
  37  * modification, are permitted provided that the following conditions
  38  * are met:
  39  *
  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
  45  *    distribution.
  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.
  49  *
  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.
  61  *
  62  *****************************************************************************/
  63 #ifndef __IWL_CONFIG_H__
  64 #define __IWL_CONFIG_H__
  65
  66 #include <linux/types.h>
  67 #include <net/mac80211.h>
  68
  69
  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,
  88 };
  89
  90 static inline bool iwl_has_secure_boot(u32 hw_rev,
  91                                        enum iwl_device_family family)
  92 {
  93         /* return 1 only for family 8000 B0 */
  94         if ((family == IWL_DEVICE_FAMILY_8000) && (hw_rev & 0xC))
  95                 return true;
  96
  97         return false;
  98 }
  99
 100 /*
 101  * LED mode
 102  *    IWL_LED_DEFAULT:  use device default
 103  *    IWL_LED_RF_STATE: turn LED on/off based on RF state
 104  *                      LED ON  = RF ON
 105  *                      LED OFF = RF OFF
 106  *    IWL_LED_BLINK:    adjust led blink rate based on blink table
 107  *    IWL_LED_DISABLE:  led disabled
 108  */
 109 enum iwl_led_mode {
 110         IWL_LED_DEFAULT,
 111         IWL_LED_RF_STATE,
 112         IWL_LED_BLINK,
 113         IWL_LED_DISABLE,
 114 };
 115
 116 /*
 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.
 119  */
 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
 126
 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
 132
 133 #define IWL_DEFAULT_MAX_TX_POWER 22
 134
 135 /* Antenna presence definitions */
 136 #define ANT_NONE        0x0
 137 #define ANT_A           BIT(0)
 138 #define ANT_B           BIT(1)
 139 #define ANT_C           BIT(2)
 140 #define ANT_AB          (ANT_A | ANT_B)
 141 #define ANT_AC          (ANT_A | ANT_C)
 142 #define ANT_BC          (ANT_B | ANT_C)
 143 #define ANT_ABC         (ANT_A | ANT_B | ANT_C)
 144
 145 static inline u8 num_of_ant(u8 mask)
 146 {
 147         return  !!((mask) & ANT_A) +
 148                 !!((mask) & ANT_B) +
 149                 !!((mask) & ANT_C);
 150 }
 151
 152 /*
 153  * @max_ll_items: max number of OTP blocks
 154  * @shadow_ram_support: shadow support for OTP memory
 155  * @led_compensation: compensate on the led on/off time per HW according
 156  *      to the deviation to achieve the desired led frequency.
 157  *      The detail algorithm is described in iwl-led.c
 158  * @wd_timeout: TX queues watchdog timeout
 159  * @max_event_log_size: size of event log buffer size for ucode event logging
 160  * @shadow_reg_enable: HW shadow register support
 161  * @apmg_wake_up_wa: should the MAC access REQ be asserted when a command
 162  *      is in flight. This is due to a HW bug in 7260, 3160 and 7265.
 163  * @scd_chain_ext_wa: should the chain extension feature in SCD be disabled.
 164  */
 165 struct iwl_base_params {
 166         int eeprom_size;
 167         int num_of_queues;      /* def: HW dependent */
 168         /* for iwl_pcie_apm_init() */
 169         u32 pll_cfg_val;
 170
 171         const u16 max_ll_items;
 172         const bool shadow_ram_support;
 173         u16 led_compensation;
 174         unsigned int wd_timeout;
 175         u32 max_event_log_size;
 176         const bool shadow_reg_enable;
 177         const bool pcie_l1_allowed;
 178         const bool apmg_wake_up_wa;
 179         const bool scd_chain_ext_wa;
 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 %IEEE80211_BAND_*) that support HT40
 187  */
 188 struct iwl_ht_params {
 189         enum ieee80211_smps_mode smps_mode;
 190         const bool ht_greenfield_support; /* if used set to true */
 191         const bool stbc;
 192         const bool ldpc;
 193         bool use_rts_for_aggregation;
 194         u8 ht40_bands;
 195 };
 196
 197 /*
 198  * Tx-backoff threshold
 199  * @temperature: The threshold in Celsius
 200  * @backoff: The tx-backoff in uSec
 201  */
 202 struct iwl_tt_tx_backoff {
 203         s32 temperature;
 204         u32 backoff;
 205 };
 206
 207 #define TT_TX_BACKOFF_SIZE 6
 208
 209 /**
 210  * struct iwl_tt_params - thermal throttling parameters
 211  * @ct_kill_entry: CT Kill entry threshold
 212  * @ct_kill_exit: CT Kill exit threshold
 213  * @ct_kill_duration: The time  intervals (in uSec) in which the driver needs
 214  *      to checks whether to exit CT Kill.
 215  * @dynamic_smps_entry: Dynamic SMPS entry threshold
 216  * @dynamic_smps_exit: Dynamic SMPS exit threshold
 217  * @tx_protection_entry: TX protection entry threshold
 218  * @tx_protection_exit: TX protection exit threshold
 219  * @tx_backoff: Array of thresholds for tx-backoff , in ascending order.
 220  * @support_ct_kill: Support CT Kill?
 221  * @support_dynamic_smps: Support dynamic SMPS?
 222  * @support_tx_protection: Support tx protection?
 223  * @support_tx_backoff: Support tx-backoff?
 224  */
 225 struct iwl_tt_params {
 226         u32 ct_kill_entry;
 227         u32 ct_kill_exit;
 228         u32 ct_kill_duration;
 229         u32 dynamic_smps_entry;
 230         u32 dynamic_smps_exit;
 231         u32 tx_protection_entry;
 232         u32 tx_protection_exit;
 233         struct iwl_tt_tx_backoff tx_backoff[TT_TX_BACKOFF_SIZE];
 234         bool support_ct_kill;
 235         bool support_dynamic_smps;
 236         bool support_tx_protection;
 237         bool support_tx_backoff;
 238 };
 239
 240 /*
 241  * information on how to parse the EEPROM
 242  */
 243 #define EEPROM_REG_BAND_1_CHANNELS              0x08
 244 #define EEPROM_REG_BAND_2_CHANNELS              0x26
 245 #define EEPROM_REG_BAND_3_CHANNELS              0x42
 246 #define EEPROM_REG_BAND_4_CHANNELS              0x5C
 247 #define EEPROM_REG_BAND_5_CHANNELS              0x74
 248 #define EEPROM_REG_BAND_24_HT40_CHANNELS        0x82
 249 #define EEPROM_REG_BAND_52_HT40_CHANNELS        0x92
 250 #define EEPROM_6000_REG_BAND_24_HT40_CHANNELS   0x80
 251 #define EEPROM_REGULATORY_BAND_NO_HT40          0
 252
 253 /* lower blocks contain EEPROM image and calibration data */
 254 #define OTP_LOW_IMAGE_SIZE              (2 * 512 * sizeof(u16)) /* 2 KB */
 255 #define OTP_LOW_IMAGE_SIZE_FAMILY_7000  (16 * 512 * sizeof(u16)) /* 16 KB */
 256 #define OTP_LOW_IMAGE_SIZE_FAMILY_8000  (32 * 512 * sizeof(u16)) /* 32 KB */
 257 #define OTP_LOW_IMAGE_SIZE_FAMILY_9000  OTP_LOW_IMAGE_SIZE_FAMILY_8000
 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  * @ucode_api_max: Highest version of uCode API supported by driver.
 280  * @ucode_api_ok: oldest version of the uCode API that is OK to load
 281  *      without a warning, for use in transitions
 282  * @ucode_api_min: Lowest version of uCode API supported by driver.
 283  * @max_inst_size: The maximal length of the fw inst section
 284  * @max_data_size: The maximal length of the fw data section
 285  * @valid_tx_ant: valid transmit antenna
 286  * @valid_rx_ant: valid receive antenna
 287  * @non_shared_ant: the antenna that is for WiFi only
 288  * @nvm_ver: NVM version
 289  * @nvm_calib_ver: NVM calibration version
 290  * @lib: pointer to the lib ops
 291  * @base_params: pointer to basic parameters
 292  * @ht_params: point to ht parameters
 293  * @led_mode: 0=blinking, 1=On(RF On)/Off(RF Off)
 294  * @rx_with_siso_diversity: 1x1 device with rx antenna diversity
 295  * @internal_wimax_coex: internal wifi/wimax combo device
 296  * @high_temp: Is this NIC is designated to be in high temperature.
 297  * @host_interrupt_operation_mode: device needs host interrupt operation
 298  *      mode set
 299  * @nvm_hw_section_num: the ID of the HW NVM section
 300  * @features: hw features, any combination of feature_whitelist
 301  * @pwr_tx_backoffs: translation table between power limits and backoffs
 302  * @max_rx_agg_size: max RX aggregation size of the ADDBA request/response
 303  * @max_tx_agg_size: max TX aggregation size of the ADDBA request/response
 304  * @max_ht_ampdu_factor: the exponent of the max length of A-MPDU that the
 305  *      station can receive in HT
 306  * @max_vht_ampdu_exponent: the exponent of the max length of A-MPDU that the
 307  *      station can receive in VHT
 308  * @dccm_offset: offset from which DCCM begins
 309  * @dccm_len: length of DCCM (including runtime stack CCM)
 310  * @dccm2_offset: offset from which the second DCCM begins
 311  * @dccm2_len: length of the second DCCM
 312  * @smem_offset: offset from which the SMEM begins
 313  * @smem_len: the length of SMEM
 314  * @mq_rx_supported: multi-queue rx support
 315  * @vht_mu_mimo_supported: VHT MU-MIMO support
 316  *
 317  * We enable the driver to be backward compatible wrt. hardware features.
 318  * API differences in uCode shouldn't be handled here but through TLVs
 319  * and/or the uCode API version instead.
 320  */
 321 struct iwl_cfg {
 322         /* params specific to an individual device within a device family */
 323         const char *name;
 324         const char *fw_name_pre;
 325         const unsigned int ucode_api_max;
 326         const unsigned int ucode_api_ok;
 327         const unsigned int ucode_api_min;
 328         const enum iwl_device_family device_family;
 329         const u32 max_data_size;
 330         const u32 max_inst_size;
 331         u8   valid_tx_ant;
 332         u8   valid_rx_ant;
 333         u8   non_shared_ant;
 334         bool bt_shared_single_ant;
 335         u16  nvm_ver;
 336         u16  nvm_calib_ver;
 337         /* params not likely to change within a device family */
 338         const struct iwl_base_params *base_params;
 339         /* params likely to change within a device family */
 340         const struct iwl_ht_params *ht_params;
 341         const struct iwl_eeprom_params *eeprom_params;
 342         enum iwl_led_mode led_mode;
 343         const bool rx_with_siso_diversity;
 344         const bool internal_wimax_coex;
 345         const bool host_interrupt_operation_mode;
 346         bool high_temp;
 347         u8   nvm_hw_section_num;
 348         bool lp_xtal_workaround;
 349         const struct iwl_pwr_tx_backoff *pwr_tx_backoffs;
 350         bool no_power_up_nic_in_init;
 351         const char *default_nvm_file_B_step;
 352         const char *default_nvm_file_C_step;
 353         netdev_features_t features;
 354         unsigned int max_rx_agg_size;
 355         bool disable_dummy_notification;
 356         unsigned int max_tx_agg_size;
 357         unsigned int max_ht_ampdu_exponent;
 358         unsigned int max_vht_ampdu_exponent;
 359         const u32 dccm_offset;
 360         const u32 dccm_len;
 361         const u32 dccm2_offset;
 362         const u32 dccm2_len;
 363         const u32 smem_offset;
 364         const u32 smem_len;
 365         const struct iwl_tt_params *thermal_params;
 366         bool apmg_not_supported;
 367         bool mq_rx_supported;
 368         bool vht_mu_mimo_supported;
 369 };
 370
 371 /*
 372  * This list declares the config structures for all devices.
 373  */
 374 #if IS_ENABLED(CONFIG_IWLDVM)
 375 extern const struct iwl_cfg iwl5300_agn_cfg;
 376 extern const struct iwl_cfg iwl5100_agn_cfg;
 377 extern const struct iwl_cfg iwl5350_agn_cfg;
 378 extern const struct iwl_cfg iwl5100_bgn_cfg;
 379 extern const struct iwl_cfg iwl5100_abg_cfg;
 380 extern const struct iwl_cfg iwl5150_agn_cfg;
 381 extern const struct iwl_cfg iwl5150_abg_cfg;
 382 extern const struct iwl_cfg iwl6005_2agn_cfg;
 383 extern const struct iwl_cfg iwl6005_2abg_cfg;
 384 extern const struct iwl_cfg iwl6005_2bg_cfg;
 385 extern const struct iwl_cfg iwl6005_2agn_sff_cfg;
 386 extern const struct iwl_cfg iwl6005_2agn_d_cfg;
 387 extern const struct iwl_cfg iwl6005_2agn_mow1_cfg;
 388 extern const struct iwl_cfg iwl6005_2agn_mow2_cfg;
 389 extern const struct iwl_cfg iwl1030_bgn_cfg;
 390 extern const struct iwl_cfg iwl1030_bg_cfg;
 391 extern const struct iwl_cfg iwl6030_2agn_cfg;
 392 extern const struct iwl_cfg iwl6030_2abg_cfg;
 393 extern const struct iwl_cfg iwl6030_2bgn_cfg;
 394 extern const struct iwl_cfg iwl6030_2bg_cfg;
 395 extern const struct iwl_cfg iwl6000i_2agn_cfg;
 396 extern const struct iwl_cfg iwl6000i_2abg_cfg;
 397 extern const struct iwl_cfg iwl6000i_2bg_cfg;
 398 extern const struct iwl_cfg iwl6000_3agn_cfg;
 399 extern const struct iwl_cfg iwl6050_2agn_cfg;
 400 extern const struct iwl_cfg iwl6050_2abg_cfg;
 401 extern const struct iwl_cfg iwl6150_bgn_cfg;
 402 extern const struct iwl_cfg iwl6150_bg_cfg;
 403 extern const struct iwl_cfg iwl1000_bgn_cfg;
 404 extern const struct iwl_cfg iwl1000_bg_cfg;
 405 extern const struct iwl_cfg iwl100_bgn_cfg;
 406 extern const struct iwl_cfg iwl100_bg_cfg;
 407 extern const struct iwl_cfg iwl130_bgn_cfg;
 408 extern const struct iwl_cfg iwl130_bg_cfg;
 409 extern const struct iwl_cfg iwl2000_2bgn_cfg;
 410 extern const struct iwl_cfg iwl2000_2bgn_d_cfg;
 411 extern const struct iwl_cfg iwl2030_2bgn_cfg;
 412 extern const struct iwl_cfg iwl6035_2agn_cfg;
 413 extern const struct iwl_cfg iwl6035_2agn_sff_cfg;
 414 extern const struct iwl_cfg iwl105_bgn_cfg;
 415 extern const struct iwl_cfg iwl105_bgn_d_cfg;
 416 extern const struct iwl_cfg iwl135_bgn_cfg;
 417 #endif /* CONFIG_IWLDVM */
 418 #if IS_ENABLED(CONFIG_IWLMVM)
 419 extern const struct iwl_cfg iwl7260_2ac_cfg;
 420 extern const struct iwl_cfg iwl7260_2ac_cfg_high_temp;
 421 extern const struct iwl_cfg iwl7260_2n_cfg;
 422 extern const struct iwl_cfg iwl7260_n_cfg;
 423 extern const struct iwl_cfg iwl3160_2ac_cfg;
 424 extern const struct iwl_cfg iwl3160_2n_cfg;
 425 extern const struct iwl_cfg iwl3160_n_cfg;
 426 extern const struct iwl_cfg iwl3165_2ac_cfg;
 427 extern const struct iwl_cfg iwl3168_2ac_cfg;
 428 extern const struct iwl_cfg iwl7265_2ac_cfg;
 429 extern const struct iwl_cfg iwl7265_2n_cfg;
 430 extern const struct iwl_cfg iwl7265_n_cfg;
 431 extern const struct iwl_cfg iwl7265d_2ac_cfg;
 432 extern const struct iwl_cfg iwl7265d_2n_cfg;
 433 extern const struct iwl_cfg iwl7265d_n_cfg;
 434 extern const struct iwl_cfg iwl8260_2n_cfg;
 435 extern const struct iwl_cfg iwl8260_2ac_cfg;
 436 extern const struct iwl_cfg iwl8265_2ac_cfg;
 437 extern const struct iwl_cfg iwl4165_2ac_cfg;
 438 extern const struct iwl_cfg iwl8260_2ac_sdio_cfg;
 439 extern const struct iwl_cfg iwl4165_2ac_sdio_cfg;
 440 extern const struct iwl_cfg iwl9260_2ac_cfg;
 441 extern const struct iwl_cfg iwl5165_2ac_cfg;
 442 #endif /* CONFIG_IWLMVM */
 443
 444 #endif /* __IWL_CONFIG_H__ */