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 - 2012 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 LICENSE.GPL.
  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 - 2012 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 };
  87
  88 /*
  89  * LED mode
  90  *    IWL_LED_DEFAULT:  use device default
  91  *    IWL_LED_RF_STATE: turn LED on/off based on RF state
  92  *                      LED ON  = RF ON
  93  *                      LED OFF = RF OFF
  94  *    IWL_LED_BLINK:    adjust led blink rate based on blink table
  95  *    IWL_LED_DISABLE:  led disabled
  96  */
  97 enum iwl_led_mode {
  98         IWL_LED_DEFAULT,
  99         IWL_LED_RF_STATE,
 100         IWL_LED_BLINK,
 101         IWL_LED_DISABLE,
 102 };
 103
 104 /*
 105  * This is the threshold value of plcp error rate per 100mSecs.  It is
 106  * used to set and check for the validity of plcp_delta.
 107  */
 108 #define IWL_MAX_PLCP_ERR_THRESHOLD_MIN          1
 109 #define IWL_MAX_PLCP_ERR_THRESHOLD_DEF          50
 110 #define IWL_MAX_PLCP_ERR_LONG_THRESHOLD_DEF     100
 111 #define IWL_MAX_PLCP_ERR_EXT_LONG_THRESHOLD_DEF 200
 112 #define IWL_MAX_PLCP_ERR_THRESHOLD_MAX          255
 113 #define IWL_MAX_PLCP_ERR_THRESHOLD_DISABLE      0
 114
 115 /* TX queue watchdog timeouts in mSecs */
 116 #define IWL_WATCHDOG_DISABLED   0
 117 #define IWL_DEF_WD_TIMEOUT      2000
 118 #define IWL_LONG_WD_TIMEOUT     10000
 119 #define IWL_MAX_WD_TIMEOUT      120000
 120
 121 /* Antenna presence definitions */
 122 #define ANT_NONE        0x0
 123 #define ANT_A           BIT(0)
 124 #define ANT_B           BIT(1)
 125 #define ANT_C           BIT(2)
 126 #define ANT_AB          (ANT_A | ANT_B)
 127 #define ANT_AC          (ANT_A | ANT_C)
 128 #define ANT_BC          (ANT_B | ANT_C)
 129 #define ANT_ABC         (ANT_A | ANT_B | ANT_C)
 130
 131
 132 /*
 133  * @max_ll_items: max number of OTP blocks
 134  * @shadow_ram_support: shadow support for OTP memory
 135  * @led_compensation: compensate on the led on/off time per HW according
 136  *      to the deviation to achieve the desired led frequency.
 137  *      The detail algorithm is described in iwl-led.c
 138  * @chain_noise_num_beacons: number of beacons used to compute chain noise
 139  * @adv_thermal_throttle: support advance thermal throttle
 140  * @support_ct_kill_exit: support ct kill exit condition
 141  * @plcp_delta_threshold: plcp error rate threshold used to trigger
 142  *      radio tuning when there is a high receiving plcp error rate
 143  * @chain_noise_scale: default chain noise scale used for gain computation
 144  * @wd_timeout: TX queues watchdog timeout
 145  * @max_event_log_size: size of event log buffer size for ucode event logging
 146  * @shadow_reg_enable: HW shadow register support
 147  * @hd_v2: v2 of enhanced sensitivity value, used for 2000 series and up
 148  * @no_idle_support: do not support idle mode
 149  */
 150 struct iwl_base_params {
 151         int eeprom_size;
 152         int num_of_queues;      /* def: HW dependent */
 153         /* for iwl_apm_init() */
 154         u32 pll_cfg_val;
 155
 156         const u16 max_ll_items;
 157         const bool shadow_ram_support;
 158         u16 led_compensation;
 159         bool adv_thermal_throttle;
 160         bool support_ct_kill_exit;
 161         u8 plcp_delta_threshold;
 162         s32 chain_noise_scale;
 163         unsigned int wd_timeout;
 164         u32 max_event_log_size;
 165         const bool shadow_reg_enable;
 166         const bool hd_v2;
 167         const bool no_idle_support;
 168 };
 169
 170 /*
 171  * @advanced_bt_coexist: support advanced bt coexist
 172  * @bt_init_traffic_load: specify initial bt traffic load
 173  * @bt_prio_boost: default bt priority boost value
 174  * @agg_time_limit: maximum number of uSec in aggregation
 175  * @bt_sco_disable: uCode should not response to BT in SCO/ESCO mode
 176  */
 177 struct iwl_bt_params {
 178         bool advanced_bt_coexist;
 179         u8 bt_init_traffic_load;
 180         u32 bt_prio_boost;
 181         u16 agg_time_limit;
 182         bool bt_sco_disable;
 183         bool bt_session_2;
 184 };
 185
 186 /*
 187  * @use_rts_for_aggregation: use rts/cts protection for HT traffic
 188  * @ht40_bands: bitmap of bands (using %IEEE80211_BAND_*) that support HT40
 189  */
 190 struct iwl_ht_params {
 191         enum ieee80211_smps_mode smps_mode;
 192         const bool ht_greenfield_support; /* if used set to true */
 193         bool use_rts_for_aggregation;
 194         u8 ht40_bands;
 195 };
 196
 197 /*
 198  * information on how to parse the EEPROM
 199  */
 200 #define EEPROM_REG_BAND_1_CHANNELS              0x08
 201 #define EEPROM_REG_BAND_2_CHANNELS              0x26
 202 #define EEPROM_REG_BAND_3_CHANNELS              0x42
 203 #define EEPROM_REG_BAND_4_CHANNELS              0x5C
 204 #define EEPROM_REG_BAND_5_CHANNELS              0x74
 205 #define EEPROM_REG_BAND_24_HT40_CHANNELS        0x82
 206 #define EEPROM_REG_BAND_52_HT40_CHANNELS        0x92
 207 #define EEPROM_6000_REG_BAND_24_HT40_CHANNELS   0x80
 208 #define EEPROM_REGULATORY_BAND_NO_HT40          0
 209
 210 struct iwl_eeprom_params {
 211         const u8 regulatory_bands[7];
 212         bool enhanced_txpower;
 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  * @eeprom_ver: EEPROM version
 230  * @eeprom_calib_ver: EEPROM calibration version
 231  * @lib: pointer to the lib ops
 232  * @base_params: pointer to basic parameters
 233  * @ht_params: point to ht patameters
 234  * @bt_params: pointer to bt parameters
 235  * @need_temp_offset_calib: need to perform temperature offset calibration
 236  * @no_xtal_calib: some devices do not need crystal calibration data,
 237  *      don't send it to those
 238  * @led_mode: 0=blinking, 1=On(RF On)/Off(RF Off)
 239  * @adv_pm: advance power management
 240  * @rx_with_siso_diversity: 1x1 device with rx antenna diversity
 241  * @internal_wimax_coex: internal wifi/wimax combo device
 242  * @temp_offset_v2: support v2 of temperature offset calibration
 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         u16  eeprom_ver;
 261         u16  eeprom_calib_ver;
 262         /* params not likely to change within a device family */
 263         const struct iwl_base_params *base_params;
 264         /* params likely to change within a device family */
 265         const struct iwl_ht_params *ht_params;
 266         const struct iwl_bt_params *bt_params;
 267         const struct iwl_eeprom_params *eeprom_params;
 268         const bool need_temp_offset_calib; /* if used set to true */
 269         const bool no_xtal_calib;
 270         enum iwl_led_mode led_mode;
 271         const bool adv_pm;
 272         const bool rx_with_siso_diversity;
 273         const bool internal_wimax_coex;
 274         const bool temp_offset_v2;
 275 };
 276
 277 #endif /* __IWL_CONFIG_H__ */