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 - 2013 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 - 2013 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 };
  88
  89 /*
  90  * LED mode
  91  *    IWL_LED_DEFAULT:  use device default
  92  *    IWL_LED_RF_STATE: turn LED on/off based on RF state
  93  *                      LED ON  = RF ON
  94  *                      LED OFF = RF OFF
  95  *    IWL_LED_BLINK:    adjust led blink rate based on blink table
  96  *    IWL_LED_DISABLE:  led disabled
  97  */
  98 enum iwl_led_mode {
  99         IWL_LED_DEFAULT,
 100         IWL_LED_RF_STATE,
 101         IWL_LED_BLINK,
 102         IWL_LED_DISABLE,
 103 };
 104
 105 /*
 106  * This is the threshold value of plcp error rate per 100mSecs.  It is
 107  * used to set and check for the validity of plcp_delta.
 108  */
 109 #define IWL_MAX_PLCP_ERR_THRESHOLD_MIN          1
 110 #define IWL_MAX_PLCP_ERR_THRESHOLD_DEF          50
 111 #define IWL_MAX_PLCP_ERR_LONG_THRESHOLD_DEF     100
 112 #define IWL_MAX_PLCP_ERR_EXT_LONG_THRESHOLD_DEF 200
 113 #define IWL_MAX_PLCP_ERR_THRESHOLD_MAX          255
 114 #define IWL_MAX_PLCP_ERR_THRESHOLD_DISABLE      0
 115
 116 /* TX queue watchdog timeouts in mSecs */
 117 #define IWL_WATCHDOG_DISABLED   0
 118 #define IWL_DEF_WD_TIMEOUT      2000
 119 #define IWL_LONG_WD_TIMEOUT     10000
 120 #define IWL_MAX_WD_TIMEOUT      120000
 121
 122 /* Antenna presence definitions */
 123 #define ANT_NONE        0x0
 124 #define ANT_A           BIT(0)
 125 #define ANT_B           BIT(1)
 126 #define ANT_C           BIT(2)
 127 #define ANT_AB          (ANT_A | ANT_B)
 128 #define ANT_AC          (ANT_A | ANT_C)
 129 #define ANT_BC          (ANT_B | ANT_C)
 130 #define ANT_ABC         (ANT_A | ANT_B | ANT_C)
 131
 132
 133 /*
 134  * @max_ll_items: max number of OTP blocks
 135  * @shadow_ram_support: shadow support for OTP memory
 136  * @led_compensation: compensate on the led on/off time per HW according
 137  *      to the deviation to achieve the desired led frequency.
 138  *      The detail algorithm is described in iwl-led.c
 139  * @chain_noise_num_beacons: number of beacons used to compute chain noise
 140  * @adv_thermal_throttle: support advance thermal throttle
 141  * @support_ct_kill_exit: support ct kill exit condition
 142  * @plcp_delta_threshold: plcp error rate threshold used to trigger
 143  *      radio tuning when there is a high receiving plcp error rate
 144  * @chain_noise_scale: default chain noise scale used for gain computation
 145  * @wd_timeout: TX queues watchdog timeout
 146  * @max_event_log_size: size of event log buffer size for ucode event logging
 147  * @shadow_reg_enable: HW shadow register support
 148  * @hd_v2: v2 of enhanced sensitivity value, used for 2000 series and up
 149  * @no_idle_support: do not support idle mode
 150  */
 151 struct iwl_base_params {
 152         int eeprom_size;
 153         int num_of_queues;      /* def: HW dependent */
 154         /* for iwl_pcie_apm_init() */
 155         u32 pll_cfg_val;
 156
 157         const u16 max_ll_items;
 158         const bool shadow_ram_support;
 159         u16 led_compensation;
 160         bool adv_thermal_throttle;
 161         bool support_ct_kill_exit;
 162         u8 plcp_delta_threshold;
 163         s32 chain_noise_scale;
 164         unsigned int wd_timeout;
 165         u32 max_event_log_size;
 166         const bool shadow_reg_enable;
 167         const bool hd_v2;
 168         const bool no_idle_support;
 169 };
 170
 171 /*
 172  * @advanced_bt_coexist: support advanced bt coexist
 173  * @bt_init_traffic_load: specify initial bt traffic load
 174  * @bt_prio_boost: default bt priority boost value
 175  * @agg_time_limit: maximum number of uSec in aggregation
 176  * @bt_sco_disable: uCode should not response to BT in SCO/ESCO mode
 177  */
 178 struct iwl_bt_params {
 179         bool advanced_bt_coexist;
 180         u8 bt_init_traffic_load;
 181         u32 bt_prio_boost;
 182         u16 agg_time_limit;
 183         bool bt_sco_disable;
 184         bool bt_session_2;
 185 };
 186
 187 /*
 188  * @use_rts_for_aggregation: use rts/cts protection for HT traffic
 189  * @ht40_bands: bitmap of bands (using %IEEE80211_BAND_*) that support HT40
 190  */
 191 struct iwl_ht_params {
 192         enum ieee80211_smps_mode smps_mode;
 193         const bool ht_greenfield_support; /* if used set to true */
 194         bool use_rts_for_aggregation;
 195         u8 ht40_bands;
 196 };
 197
 198 /*
 199  * information on how to parse the EEPROM
 200  */
 201 #define EEPROM_REG_BAND_1_CHANNELS              0x08
 202 #define EEPROM_REG_BAND_2_CHANNELS              0x26
 203 #define EEPROM_REG_BAND_3_CHANNELS              0x42
 204 #define EEPROM_REG_BAND_4_CHANNELS              0x5C
 205 #define EEPROM_REG_BAND_5_CHANNELS              0x74
 206 #define EEPROM_REG_BAND_24_HT40_CHANNELS        0x82
 207 #define EEPROM_REG_BAND_52_HT40_CHANNELS        0x92
 208 #define EEPROM_6000_REG_BAND_24_HT40_CHANNELS   0x80
 209 #define EEPROM_REGULATORY_BAND_NO_HT40          0
 210
 211 struct iwl_eeprom_params {
 212         const u8 regulatory_bands[7];
 213         bool enhanced_txpower;
 214 };
 215
 216 /**
 217  * struct iwl_cfg
 218  * @name: Offical name of the device
 219  * @fw_name_pre: Firmware filename prefix. The api version and extension
 220  *      (.ucode) will be added to filename before loading from disk. The
 221  *      filename is constructed as fw_name_pre<api>.ucode.
 222  * @ucode_api_max: Highest version of uCode API supported by driver.
 223  * @ucode_api_ok: oldest version of the uCode API that is OK to load
 224  *      without a warning, for use in transitions
 225  * @ucode_api_min: Lowest version of uCode API supported by driver.
 226  * @max_inst_size: The maximal length of the fw inst section
 227  * @max_data_size: The maximal length of the fw data section
 228  * @valid_tx_ant: valid transmit antenna
 229  * @valid_rx_ant: valid receive antenna
 230  * @nvm_ver: NVM version
 231  * @nvm_calib_ver: NVM calibration version
 232  * @lib: pointer to the lib ops
 233  * @base_params: pointer to basic parameters
 234  * @ht_params: point to ht patameters
 235  * @bt_params: pointer to bt parameters
 236  * @need_temp_offset_calib: need to perform temperature offset calibration
 237  * @no_xtal_calib: some devices do not need crystal calibration data,
 238  *      don't send it to those
 239  * @led_mode: 0=blinking, 1=On(RF On)/Off(RF Off)
 240  * @adv_pm: advance power management
 241  * @rx_with_siso_diversity: 1x1 device with rx antenna diversity
 242  * @internal_wimax_coex: internal wifi/wimax combo device
 243  * @temp_offset_v2: support v2 of temperature offset calibration
 244  *
 245  * We enable the driver to be backward compatible wrt. hardware features.
 246  * API differences in uCode shouldn't be handled here but through TLVs
 247  * and/or the uCode API version instead.
 248  */
 249 struct iwl_cfg {
 250         /* params specific to an individual device within a device family */
 251         const char *name;
 252         const char *fw_name_pre;
 253         const unsigned int ucode_api_max;
 254         const unsigned int ucode_api_ok;
 255         const unsigned int ucode_api_min;
 256         const enum iwl_device_family device_family;
 257         const u32 max_data_size;
 258         const u32 max_inst_size;
 259         u8   valid_tx_ant;
 260         u8   valid_rx_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_bt_params *bt_params;
 268         const struct iwl_eeprom_params *eeprom_params;
 269         const bool need_temp_offset_calib; /* if used set to true */
 270         const bool no_xtal_calib;
 271         enum iwl_led_mode led_mode;
 272         const bool adv_pm;
 273         const bool rx_with_siso_diversity;
 274         const bool internal_wimax_coex;
 275         const bool temp_offset_v2;
 276 };
 277
 278 /*
 279  * This list declares the config structures for all devices.
 280  */
 281 extern const struct iwl_cfg iwl5300_agn_cfg;
 282 extern const struct iwl_cfg iwl5100_agn_cfg;
 283 extern const struct iwl_cfg iwl5350_agn_cfg;
 284 extern const struct iwl_cfg iwl5100_bgn_cfg;
 285 extern const struct iwl_cfg iwl5100_abg_cfg;
 286 extern const struct iwl_cfg iwl5150_agn_cfg;
 287 extern const struct iwl_cfg iwl5150_abg_cfg;
 288 extern const struct iwl_cfg iwl6005_2agn_cfg;
 289 extern const struct iwl_cfg iwl6005_2abg_cfg;
 290 extern const struct iwl_cfg iwl6005_2bg_cfg;
 291 extern const struct iwl_cfg iwl6005_2agn_sff_cfg;
 292 extern const struct iwl_cfg iwl6005_2agn_d_cfg;
 293 extern const struct iwl_cfg iwl6005_2agn_mow1_cfg;
 294 extern const struct iwl_cfg iwl6005_2agn_mow2_cfg;
 295 extern const struct iwl_cfg iwl1030_bgn_cfg;
 296 extern const struct iwl_cfg iwl1030_bg_cfg;
 297 extern const struct iwl_cfg iwl6030_2agn_cfg;
 298 extern const struct iwl_cfg iwl6030_2abg_cfg;
 299 extern const struct iwl_cfg iwl6030_2bgn_cfg;
 300 extern const struct iwl_cfg iwl6030_2bg_cfg;
 301 extern const struct iwl_cfg iwl6000i_2agn_cfg;
 302 extern const struct iwl_cfg iwl6000i_2abg_cfg;
 303 extern const struct iwl_cfg iwl6000i_2bg_cfg;
 304 extern const struct iwl_cfg iwl6000_3agn_cfg;
 305 extern const struct iwl_cfg iwl6050_2agn_cfg;
 306 extern const struct iwl_cfg iwl6050_2abg_cfg;
 307 extern const struct iwl_cfg iwl6150_bgn_cfg;
 308 extern const struct iwl_cfg iwl6150_bg_cfg;
 309 extern const struct iwl_cfg iwl1000_bgn_cfg;
 310 extern const struct iwl_cfg iwl1000_bg_cfg;
 311 extern const struct iwl_cfg iwl100_bgn_cfg;
 312 extern const struct iwl_cfg iwl100_bg_cfg;
 313 extern const struct iwl_cfg iwl130_bgn_cfg;
 314 extern const struct iwl_cfg iwl130_bg_cfg;
 315 extern const struct iwl_cfg iwl2000_2bgn_cfg;
 316 extern const struct iwl_cfg iwl2000_2bgn_d_cfg;
 317 extern const struct iwl_cfg iwl2030_2bgn_cfg;
 318 extern const struct iwl_cfg iwl6035_2agn_cfg;
 319 extern const struct iwl_cfg iwl105_bgn_cfg;
 320 extern const struct iwl_cfg iwl105_bgn_d_cfg;
 321 extern const struct iwl_cfg iwl135_bgn_cfg;
 322 extern const struct iwl_cfg iwl7260_2ac_cfg;
 323 extern const struct iwl_cfg iwl3160_ac_cfg;
 324
 325 #endif /* __IWL_CONFIG_H__ */