drivers/net/wireless/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 <ilw@linux.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 /*
  91  * LED mode
  92  *    IWL_LED_DEFAULT:  use device default
  93  *    IWL_LED_RF_STATE: turn LED on/off based on RF state
  94  *                      LED ON  = RF ON
  95  *                      LED OFF = RF OFF
  96  *    IWL_LED_BLINK:    adjust led blink rate based on blink table
  97  *    IWL_LED_DISABLE:  led disabled
  98  */
  99 enum iwl_led_mode {
 100         IWL_LED_DEFAULT,
 101         IWL_LED_RF_STATE,
 102         IWL_LED_BLINK,
 103         IWL_LED_DISABLE,
 104 };
 105
 106 /*
 107  * This is the threshold value of plcp error rate per 100mSecs.  It is
 108  * used to set and check for the validity of plcp_delta.
 109  */
 110 #define IWL_MAX_PLCP_ERR_THRESHOLD_MIN          1
 111 #define IWL_MAX_PLCP_ERR_THRESHOLD_DEF          50
 112 #define IWL_MAX_PLCP_ERR_LONG_THRESHOLD_DEF     100
 113 #define IWL_MAX_PLCP_ERR_EXT_LONG_THRESHOLD_DEF 200
 114 #define IWL_MAX_PLCP_ERR_THRESHOLD_MAX          255
 115 #define IWL_MAX_PLCP_ERR_THRESHOLD_DISABLE      0
 116
 117 /* TX queue watchdog timeouts in mSecs */
 118 #define IWL_WATCHDOG_DISABLED   0
 119 #define IWL_DEF_WD_TIMEOUT      2000
 120 #define IWL_LONG_WD_TIMEOUT     10000
 121 #define IWL_MAX_WD_TIMEOUT      120000
 122
 123 /* Antenna presence definitions */
 124 #define ANT_NONE        0x0
 125 #define ANT_A           BIT(0)
 126 #define ANT_B           BIT(1)
 127 #define ANT_C           BIT(2)
 128 #define ANT_AB          (ANT_A | ANT_B)
 129 #define ANT_AC          (ANT_A | ANT_C)
 130 #define ANT_BC          (ANT_B | ANT_C)
 131 #define ANT_ABC         (ANT_A | ANT_B | ANT_C)
 132
 133 static inline u8 num_of_ant(u8 mask)
 134 {
 135         return  !!((mask) & ANT_A) +
 136                 !!((mask) & ANT_B) +
 137                 !!((mask) & ANT_C);
 138 }
 139
 140 /*
 141  * @max_ll_items: max number of OTP blocks
 142  * @shadow_ram_support: shadow support for OTP memory
 143  * @led_compensation: compensate on the led on/off time per HW according
 144  *      to the deviation to achieve the desired led frequency.
 145  *      The detail algorithm is described in iwl-led.c
 146  * @wd_timeout: TX queues watchdog timeout
 147  * @max_event_log_size: size of event log buffer size for ucode event logging
 148  * @shadow_reg_enable: HW shadow register support
 149  * @apmg_wake_up_wa: should the MAC access REQ be asserted when a command
 150  *      is in flight. This is due to a HW bug in 7260, 3160 and 7265.
 151  * @scd_chain_ext_wa: should the chain extension feature in SCD be disabled.
 152  */
 153 struct iwl_base_params {
 154         int eeprom_size;
 155         int num_of_queues;      /* def: HW dependent */
 156         /* for iwl_pcie_apm_init() */
 157         u32 pll_cfg_val;
 158
 159         const u16 max_ll_items;
 160         const bool shadow_ram_support;
 161         u16 led_compensation;
 162         unsigned int wd_timeout;
 163         u32 max_event_log_size;
 164         const bool shadow_reg_enable;
 165         const bool pcie_l1_allowed;
 166         const bool apmg_wake_up_wa;
 167         const bool scd_chain_ext_wa;
 168 };
 169
 170 /*
 171  * @stbc: support Tx STBC and 1*SS Rx STBC
 172  * @use_rts_for_aggregation: use rts/cts protection for HT traffic
 173  * @ht40_bands: bitmap of bands (using %IEEE80211_BAND_*) that support HT40
 174  */
 175 struct iwl_ht_params {
 176         enum ieee80211_smps_mode smps_mode;
 177         const bool ht_greenfield_support; /* if used set to true */
 178         const bool stbc;
 179         bool use_rts_for_aggregation;
 180         u8 ht40_bands;
 181 };
 182
 183 /*
 184  * information on how to parse the EEPROM
 185  */
 186 #define EEPROM_REG_BAND_1_CHANNELS              0x08
 187 #define EEPROM_REG_BAND_2_CHANNELS              0x26
 188 #define EEPROM_REG_BAND_3_CHANNELS              0x42
 189 #define EEPROM_REG_BAND_4_CHANNELS              0x5C
 190 #define EEPROM_REG_BAND_5_CHANNELS              0x74
 191 #define EEPROM_REG_BAND_24_HT40_CHANNELS        0x82
 192 #define EEPROM_REG_BAND_52_HT40_CHANNELS        0x92
 193 #define EEPROM_6000_REG_BAND_24_HT40_CHANNELS   0x80
 194 #define EEPROM_REGULATORY_BAND_NO_HT40          0
 195
 196 /* lower blocks contain EEPROM image and calibration data */
 197 #define OTP_LOW_IMAGE_SIZE              (2 * 512 * sizeof(u16)) /* 2 KB */
 198 #define OTP_LOW_IMAGE_SIZE_FAMILY_7000  (16 * 512 * sizeof(u16)) /* 16 KB */
 199 #define OTP_LOW_IMAGE_SIZE_FAMILY_8000  (32 * 512 * sizeof(u16)) /* 32 KB */
 200
 201 struct iwl_eeprom_params {
 202         const u8 regulatory_bands[7];
 203         bool enhanced_txpower;
 204 };
 205
 206 /* Tx-backoff power threshold
 207  * @pwr: The power limit in mw
 208  * @backoff: The tx-backoff in uSec
 209  */
 210 struct iwl_pwr_tx_backoff {
 211         u32 pwr;
 212         u32 backoff;
 213 };
 214
 215 /**
 216  * struct iwl_cfg
 217  * @name: Offical name of the device
 218  * @fw_name_pre: Firmware filename prefix. The api version and extension
 219  *      (.ucode) will be added to filename before loading from disk. The
 220  *      filename is constructed as fw_name_pre<api>.ucode.
 221  * @ucode_api_max: Highest version of uCode API supported by driver.
 222  * @ucode_api_ok: oldest version of the uCode API that is OK to load
 223  *      without a warning, for use in transitions
 224  * @ucode_api_min: Lowest version of uCode API supported by driver.
 225  * @max_inst_size: The maximal length of the fw inst section
 226  * @max_data_size: The maximal length of the fw data section
 227  * @valid_tx_ant: valid transmit antenna
 228  * @valid_rx_ant: valid receive antenna
 229  * @nvm_ver: NVM version
 230  * @nvm_calib_ver: NVM calibration version
 231  * @lib: pointer to the lib ops
 232  * @base_params: pointer to basic parameters
 233  * @ht_params: point to ht parameters
 234  * @led_mode: 0=blinking, 1=On(RF On)/Off(RF Off)
 235  * @rx_with_siso_diversity: 1x1 device with rx antenna diversity
 236  * @internal_wimax_coex: internal wifi/wimax combo device
 237  * @high_temp: Is this NIC is designated to be in high temperature.
 238  * @host_interrupt_operation_mode: device needs host interrupt operation
 239  *      mode set
 240  * @d0i3: device uses d0i3 instead of d3
 241  * @nvm_hw_section_num: the ID of the HW NVM section
 242  * @pwr_tx_backoffs: translation table between power limits and backoffs
 243  *
 244  * We enable the driver to be backward compatible wrt. hardware features.
 245  * API differences in uCode shouldn't be handled here but through TLVs
 246  * and/or the uCode API version instead.
 247  */
 248 struct iwl_cfg {
 249         /* params specific to an individual device within a device family */
 250         const char *name;
 251         const char *fw_name_pre;
 252         const unsigned int ucode_api_max;
 253         const unsigned int ucode_api_ok;
 254         const unsigned int ucode_api_min;
 255         const enum iwl_device_family device_family;
 256         const u32 max_data_size;
 257         const u32 max_inst_size;
 258         u8   valid_tx_ant;
 259         u8   valid_rx_ant;
 260         bool bt_shared_single_ant;
 261         u16  nvm_ver;
 262         u16  nvm_calib_ver;
 263         /* params not likely to change within a device family */
 264         const struct iwl_base_params *base_params;
 265         /* params likely to change within a device family */
 266         const struct iwl_ht_params *ht_params;
 267         const struct iwl_eeprom_params *eeprom_params;
 268         enum iwl_led_mode led_mode;
 269         const bool rx_with_siso_diversity;
 270         const bool internal_wimax_coex;
 271         const bool host_interrupt_operation_mode;
 272         bool high_temp;
 273         bool d0i3;
 274         u8   nvm_hw_section_num;
 275         bool lp_xtal_workaround;
 276         const struct iwl_pwr_tx_backoff *pwr_tx_backoffs;
 277         bool no_power_up_nic_in_init;
 278         const char *default_nvm_file;
 279 };
 280
 281 /*
 282  * This list declares the config structures for all devices.
 283  */
 284 #if IS_ENABLED(CONFIG_IWLDVM)
 285 extern const struct iwl_cfg iwl5300_agn_cfg;
 286 extern const struct iwl_cfg iwl5100_agn_cfg;
 287 extern const struct iwl_cfg iwl5350_agn_cfg;
 288 extern const struct iwl_cfg iwl5100_bgn_cfg;
 289 extern const struct iwl_cfg iwl5100_abg_cfg;
 290 extern const struct iwl_cfg iwl5150_agn_cfg;
 291 extern const struct iwl_cfg iwl5150_abg_cfg;
 292 extern const struct iwl_cfg iwl6005_2agn_cfg;
 293 extern const struct iwl_cfg iwl6005_2abg_cfg;
 294 extern const struct iwl_cfg iwl6005_2bg_cfg;
 295 extern const struct iwl_cfg iwl6005_2agn_sff_cfg;
 296 extern const struct iwl_cfg iwl6005_2agn_d_cfg;
 297 extern const struct iwl_cfg iwl6005_2agn_mow1_cfg;
 298 extern const struct iwl_cfg iwl6005_2agn_mow2_cfg;
 299 extern const struct iwl_cfg iwl1030_bgn_cfg;
 300 extern const struct iwl_cfg iwl1030_bg_cfg;
 301 extern const struct iwl_cfg iwl6030_2agn_cfg;
 302 extern const struct iwl_cfg iwl6030_2abg_cfg;
 303 extern const struct iwl_cfg iwl6030_2bgn_cfg;
 304 extern const struct iwl_cfg iwl6030_2bg_cfg;
 305 extern const struct iwl_cfg iwl6000i_2agn_cfg;
 306 extern const struct iwl_cfg iwl6000i_2abg_cfg;
 307 extern const struct iwl_cfg iwl6000i_2bg_cfg;
 308 extern const struct iwl_cfg iwl6000_3agn_cfg;
 309 extern const struct iwl_cfg iwl6050_2agn_cfg;
 310 extern const struct iwl_cfg iwl6050_2abg_cfg;
 311 extern const struct iwl_cfg iwl6150_bgn_cfg;
 312 extern const struct iwl_cfg iwl6150_bg_cfg;
 313 extern const struct iwl_cfg iwl1000_bgn_cfg;
 314 extern const struct iwl_cfg iwl1000_bg_cfg;
 315 extern const struct iwl_cfg iwl100_bgn_cfg;
 316 extern const struct iwl_cfg iwl100_bg_cfg;
 317 extern const struct iwl_cfg iwl130_bgn_cfg;
 318 extern const struct iwl_cfg iwl130_bg_cfg;
 319 extern const struct iwl_cfg iwl2000_2bgn_cfg;
 320 extern const struct iwl_cfg iwl2000_2bgn_d_cfg;
 321 extern const struct iwl_cfg iwl2030_2bgn_cfg;
 322 extern const struct iwl_cfg iwl6035_2agn_cfg;
 323 extern const struct iwl_cfg iwl6035_2agn_sff_cfg;
 324 extern const struct iwl_cfg iwl105_bgn_cfg;
 325 extern const struct iwl_cfg iwl105_bgn_d_cfg;
 326 extern const struct iwl_cfg iwl135_bgn_cfg;
 327 #endif /* CONFIG_IWLDVM */
 328 #if IS_ENABLED(CONFIG_IWLMVM)
 329 extern const struct iwl_cfg iwl7260_2ac_cfg;
 330 extern const struct iwl_cfg iwl7260_2ac_cfg_high_temp;
 331 extern const struct iwl_cfg iwl7260_2n_cfg;
 332 extern const struct iwl_cfg iwl7260_n_cfg;
 333 extern const struct iwl_cfg iwl3160_2ac_cfg;
 334 extern const struct iwl_cfg iwl3160_2n_cfg;
 335 extern const struct iwl_cfg iwl3160_n_cfg;
 336 extern const struct iwl_cfg iwl7265_2ac_cfg;
 337 extern const struct iwl_cfg iwl7265_2n_cfg;
 338 extern const struct iwl_cfg iwl7265_n_cfg;
 339 extern const struct iwl_cfg iwl8260_2ac_cfg;
 340 extern const struct iwl_cfg iwl8260_n_cfg;
 341 #endif /* CONFIG_IWLMVM */
 342
 343 #endif /* __IWL_CONFIG_H__ */