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 struct iwl_lib_ops;
  70
  71
  72 enum iwl_device_family {
  73         IWL_DEVICE_FAMILY_UNDEFINED,
  74         IWL_DEVICE_FAMILY_1000,
  75         IWL_DEVICE_FAMILY_100,
  76         IWL_DEVICE_FAMILY_2000,
  77         IWL_DEVICE_FAMILY_2030,
  78         IWL_DEVICE_FAMILY_105,
  79         IWL_DEVICE_FAMILY_135,
  80         IWL_DEVICE_FAMILY_5000,
  81         IWL_DEVICE_FAMILY_5150,
  82         IWL_DEVICE_FAMILY_6000,
  83         IWL_DEVICE_FAMILY_6000i,
  84         IWL_DEVICE_FAMILY_6005,
  85         IWL_DEVICE_FAMILY_6030,
  86         IWL_DEVICE_FAMILY_6050,
  87         IWL_DEVICE_FAMILY_6150,
  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  * @max_ll_items: max number of OTP blocks
 108  * @shadow_ram_support: shadow support for OTP memory
 109  * @led_compensation: compensate on the led on/off time per HW according
 110  *      to the deviation to achieve the desired led frequency.
 111  *      The detail algorithm is described in iwl-led.c
 112  * @chain_noise_num_beacons: number of beacons used to compute chain noise
 113  * @adv_thermal_throttle: support advance thermal throttle
 114  * @support_ct_kill_exit: support ct kill exit condition
 115  * @plcp_delta_threshold: plcp error rate threshold used to trigger
 116  *      radio tuning when there is a high receiving plcp error rate
 117  * @chain_noise_scale: default chain noise scale used for gain computation
 118  * @wd_timeout: TX queues watchdog timeout
 119  * @max_event_log_size: size of event log buffer size for ucode event logging
 120  * @shadow_reg_enable: HW shadhow register bit
 121  * @hd_v2: v2 of enhanced sensitivity value, used for 2000 series and up
 122  * @no_idle_support: do not support idle mode
 123  */
 124 struct iwl_base_params {
 125         int eeprom_size;
 126         int num_of_queues;      /* def: HW dependent */
 127         /* for iwl_apm_init() */
 128         u32 pll_cfg_val;
 129
 130         const u16 max_ll_items;
 131         const bool shadow_ram_support;
 132         u16 led_compensation;
 133         bool adv_thermal_throttle;
 134         bool support_ct_kill_exit;
 135         u8 plcp_delta_threshold;
 136         s32 chain_noise_scale;
 137         unsigned int wd_timeout;
 138         u32 max_event_log_size;
 139         const bool shadow_reg_enable;
 140         const bool hd_v2;
 141         const bool no_idle_support;
 142 };
 143
 144 /*
 145  * @advanced_bt_coexist: support advanced bt coexist
 146  * @bt_init_traffic_load: specify initial bt traffic load
 147  * @bt_prio_boost: default bt priority boost value
 148  * @agg_time_limit: maximum number of uSec in aggregation
 149  * @bt_sco_disable: uCode should not response to BT in SCO/ESCO mode
 150  */
 151 struct iwl_bt_params {
 152         bool advanced_bt_coexist;
 153         u8 bt_init_traffic_load;
 154         u8 bt_prio_boost;
 155         u16 agg_time_limit;
 156         bool bt_sco_disable;
 157         bool bt_session_2;
 158 };
 159 /*
 160  * @use_rts_for_aggregation: use rts/cts protection for HT traffic
 161  */
 162 struct iwl_ht_params {
 163         const bool ht_greenfield_support; /* if used set to true */
 164         bool use_rts_for_aggregation;
 165         enum ieee80211_smps_mode smps_mode;
 166 };
 167
 168 /**
 169  * struct iwl_cfg
 170  * @name: Offical name of the device
 171  * @fw_name_pre: Firmware filename prefix. The api version and extension
 172  *      (.ucode) will be added to filename before loading from disk. The
 173  *      filename is constructed as fw_name_pre<api>.ucode.
 174  * @ucode_api_max: Highest version of uCode API supported by driver.
 175  * @ucode_api_ok: oldest version of the uCode API that is OK to load
 176  *      without a warning, for use in transitions
 177  * @ucode_api_min: Lowest version of uCode API supported by driver.
 178  * @max_inst_size: The maximal length of the fw inst section
 179  * @max_data_size: The maximal length of the fw data section
 180  * @valid_tx_ant: valid transmit antenna
 181  * @valid_rx_ant: valid receive antenna
 182  * @eeprom_ver: EEPROM version
 183  * @eeprom_calib_ver: EEPROM calibration version
 184  * @lib: pointer to the lib ops
 185  * @base_params: pointer to basic parameters
 186  * @ht_params: point to ht patameters
 187  * @bt_params: pointer to bt parameters
 188  * @need_temp_offset_calib: need to perform temperature offset calibration
 189  * @no_xtal_calib: some devices do not need crystal calibration data,
 190  *      don't send it to those
 191  * @led_mode: 0=blinking, 1=On(RF On)/Off(RF Off)
 192  * @adv_pm: advance power management
 193  * @rx_with_siso_diversity: 1x1 device with rx antenna diversity
 194  * @internal_wimax_coex: internal wifi/wimax combo device
 195  * @temp_offset_v2: support v2 of temperature offset calibration
 196  *
 197  * We enable the driver to be backward compatible wrt. hardware features.
 198  * API differences in uCode shouldn't be handled here but through TLVs
 199  * and/or the uCode API version instead.
 200  */
 201 struct iwl_cfg {
 202         /* params specific to an individual device within a device family */
 203         const char *name;
 204         const char *fw_name_pre;
 205         const unsigned int ucode_api_max;
 206         const unsigned int ucode_api_ok;
 207         const unsigned int ucode_api_min;
 208         const enum iwl_device_family device_family;
 209         const u32 max_data_size;
 210         const u32 max_inst_size;
 211         u8   valid_tx_ant;
 212         u8   valid_rx_ant;
 213         u16  eeprom_ver;
 214         u16  eeprom_calib_ver;
 215         const struct iwl_lib_ops *lib;
 216         /* params not likely to change within a device family */
 217         const struct iwl_base_params *base_params;
 218         /* params likely to change within a device family */
 219         const struct iwl_ht_params *ht_params;
 220         const struct iwl_bt_params *bt_params;
 221         const bool need_temp_offset_calib; /* if used set to true */
 222         const bool no_xtal_calib;
 223         enum iwl_led_mode led_mode;
 224         const bool adv_pm;
 225         const bool rx_with_siso_diversity;
 226         const bool internal_wimax_coex;
 227         const bool temp_offset_v2;
 228 };
 229
 230 #endif /* __IWL_CONFIG_H__ */