drivers/net/wireless/iwlwifi/iwl-core.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) 2008 - 2011 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 - 2011 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_core_h__
  64 #define __iwl_core_h__
  65
  66 #include "iwl-dev.h"
  67
  68 /************************
  69  * forward declarations *
  70  ************************/
  71 struct iwl_host_cmd;
  72 struct iwl_cmd;
  73
  74 #define TIME_UNIT               1024
  75
  76 #define IWL_CMD(x) case x: return #x
  77
  78 struct iwl_lib_ops {
  79         /* set hw dependent parameters */
  80         int (*set_hw_params)(struct iwl_priv *priv);
  81         /* setup BT Rx handler */
  82         void (*bt_rx_handler_setup)(struct iwl_priv *priv);
  83         /* setup BT related deferred work */
  84         void (*bt_setup_deferred_work)(struct iwl_priv *priv);
  85         /* cancel deferred work */
  86         void (*cancel_deferred_work)(struct iwl_priv *priv);
  87         int (*set_channel_switch)(struct iwl_priv *priv,
  88                                   struct ieee80211_channel_switch *ch_switch);
  89         /* device specific configuration */
  90         void (*nic_config)(struct iwl_priv *priv);
  91
  92         /* eeprom operations (as defined in iwl-eeprom.h) */
  93         struct iwl_eeprom_ops eeprom_ops;
  94
  95         /* temperature */
  96         void (*temperature)(struct iwl_priv *priv);
  97 };
  98
  99 /*
 100  * @max_ll_items: max number of OTP blocks
 101  * @shadow_ram_support: shadow support for OTP memory
 102  * @led_compensation: compensate on the led on/off time per HW according
 103  *      to the deviation to achieve the desired led frequency.
 104  *      The detail algorithm is described in iwl-led.c
 105  * @chain_noise_num_beacons: number of beacons used to compute chain noise
 106  * @adv_thermal_throttle: support advance thermal throttle
 107  * @support_ct_kill_exit: support ct kill exit condition
 108  * @support_wimax_coexist: support wimax/wifi co-exist
 109  * @plcp_delta_threshold: plcp error rate threshold used to trigger
 110  *      radio tuning when there is a high receiving plcp error rate
 111  * @chain_noise_scale: default chain noise scale used for gain computation
 112  * @wd_timeout: TX queues watchdog timeout
 113  * @temperature_kelvin: temperature report by uCode in kelvin
 114  * @max_event_log_size: size of event log buffer size for ucode event logging
 115  * @shadow_reg_enable: HW shadhow register bit
 116  * @no_idle_support: do not support idle mode
 117  * @hd_v2: v2 of enhanced sensitivity value, used for 2000 series and up
 118  */
 119 struct iwl_base_params {
 120         int eeprom_size;
 121         int num_of_queues;      /* def: HW dependent */
 122         int num_of_ampdu_queues;/* def: HW dependent */
 123         /* for iwl_apm_init() */
 124         u32 pll_cfg_val;
 125
 126         const u16 max_ll_items;
 127         const bool shadow_ram_support;
 128         u16 led_compensation;
 129         int chain_noise_num_beacons;
 130         bool adv_thermal_throttle;
 131         bool support_ct_kill_exit;
 132         const bool support_wimax_coexist;
 133         u8 plcp_delta_threshold;
 134         s32 chain_noise_scale;
 135         unsigned int wd_timeout;
 136         bool temperature_kelvin;
 137         u32 max_event_log_size;
 138         const bool shadow_reg_enable;
 139         const bool no_idle_support;
 140         const bool hd_v2;
 141 };
 142 /*
 143  * @advanced_bt_coexist: support advanced bt coexist
 144  * @bt_init_traffic_load: specify initial bt traffic load
 145  * @bt_prio_boost: default bt priority boost value
 146  * @agg_time_limit: maximum number of uSec in aggregation
 147  * @ampdu_factor: Maximum A-MPDU length factor
 148  * @ampdu_density: Minimum A-MPDU spacing
 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         u8 ampdu_factor;
 157         u8 ampdu_density;
 158         bool bt_sco_disable;
 159         bool bt_session_2;
 160 };
 161 /*
 162  * @use_rts_for_aggregation: use rts/cts protection for HT traffic
 163  */
 164 struct iwl_ht_params {
 165         const bool ht_greenfield_support; /* if used set to true */
 166         bool use_rts_for_aggregation;
 167         enum ieee80211_smps_mode smps_mode;
 168 };
 169
 170 /**
 171  * struct iwl_cfg
 172  * @name: Offical name of the device
 173  * @fw_name_pre: Firmware filename prefix. The api version and extension
 174  *      (.ucode) will be added to filename before loading from disk. The
 175  *      filename is constructed as fw_name_pre<api>.ucode.
 176  * @ucode_api_max: Highest version of uCode API supported by driver.
 177  * @ucode_api_ok: oldest version of the uCode API that is OK to load
 178  *      without a warning, for use in transitions
 179  * @ucode_api_min: Lowest version of uCode API supported by driver.
 180  * @valid_tx_ant: valid transmit antenna
 181  * @valid_rx_ant: valid receive antenna
 182  * @sku: sku information from EEPROM
 183  * @eeprom_ver: EEPROM version
 184  * @eeprom_calib_ver: EEPROM calibration version
 185  * @lib: pointer to the lib ops
 186  * @additional_nic_config: additional nic configuration
 187  * @base_params: pointer to basic parameters
 188  * @ht_params: point to ht patameters
 189  * @bt_params: pointer to bt parameters
 190  * @pa_type: used by 6000 series only to identify the type of Power Amplifier
 191  * @need_dc_calib: need to perform init dc calibration
 192  * @need_temp_offset_calib: need to perform temperature offset calibration
 193  * @scan_antennas: available antenna for scan operation
 194  * @led_mode: 0=blinking, 1=On(RF On)/Off(RF Off)
 195  * @adv_pm: advance power management
 196  * @rx_with_siso_diversity: 1x1 device with rx antenna diversity
 197  * @internal_wimax_coex: internal wifi/wimax combo device
 198  * @iq_invert: I/Q inversion
 199  *
 200  * We enable the driver to be backward compatible wrt API version. The
 201  * driver specifies which APIs it supports (with @ucode_api_max being the
 202  * highest and @ucode_api_min the lowest). Firmware will only be loaded if
 203  * it has a supported API version.
 204  *
 205  * The ideal usage of this infrastructure is to treat a new ucode API
 206  * release as a new hardware revision.
 207  */
 208 struct iwl_cfg {
 209         /* params specific to an individual device within a device family */
 210         const char *name;
 211         const char *fw_name_pre;
 212         const unsigned int ucode_api_max;
 213         const unsigned int ucode_api_ok;
 214         const unsigned int ucode_api_min;
 215         u8   valid_tx_ant;
 216         u8   valid_rx_ant;
 217         u16  sku;
 218         u16  eeprom_ver;
 219         u16  eeprom_calib_ver;
 220         const struct iwl_lib_ops *lib;
 221         void (*additional_nic_config)(struct iwl_priv *priv);
 222         /* params not likely to change within a device family */
 223         struct iwl_base_params *base_params;
 224         /* params likely to change within a device family */
 225         struct iwl_ht_params *ht_params;
 226         struct iwl_bt_params *bt_params;
 227         enum iwl_pa_type pa_type;         /* if used set to IWL_PA_SYSTEM */
 228         const bool need_dc_calib;         /* if used set to true */
 229         const bool need_temp_offset_calib; /* if used set to true */
 230         u8 scan_rx_antennas[IEEE80211_NUM_BANDS];
 231         enum iwl_led_mode led_mode;
 232         const bool adv_pm;
 233         const bool rx_with_siso_diversity;
 234         const bool internal_wimax_coex;
 235         const bool iq_invert;
 236 };
 237
 238 /***************************
 239  *   L i b                 *
 240  ***************************/
 241
 242 int iwl_mac_conf_tx(struct ieee80211_hw *hw, u16 queue,
 243                     const struct ieee80211_tx_queue_params *params);
 244 int iwl_mac_tx_last_beacon(struct ieee80211_hw *hw);
 245 void iwl_set_rxon_hwcrypto(struct iwl_priv *priv, struct iwl_rxon_context *ctx,
 246                            int hw_decrypt);
 247 int iwl_check_rxon_cmd(struct iwl_priv *priv, struct iwl_rxon_context *ctx);
 248 int iwl_full_rxon_required(struct iwl_priv *priv, struct iwl_rxon_context *ctx);
 249 int iwl_set_rxon_channel(struct iwl_priv *priv, struct ieee80211_channel *ch,
 250                          struct iwl_rxon_context *ctx);
 251 void iwl_set_flags_for_band(struct iwl_priv *priv,
 252                             struct iwl_rxon_context *ctx,
 253                             enum ieee80211_band band,
 254                             struct ieee80211_vif *vif);
 255 u8 iwl_get_single_channel_number(struct iwl_priv *priv,
 256                                   enum ieee80211_band band);
 257 void iwl_set_rxon_ht(struct iwl_priv *priv, struct iwl_ht_config *ht_conf);
 258 bool iwl_is_ht40_tx_allowed(struct iwl_priv *priv,
 259                             struct iwl_rxon_context *ctx,
 260                             struct ieee80211_sta_ht_cap *ht_cap);
 261 void iwl_connection_init_rx_config(struct iwl_priv *priv,
 262                                    struct iwl_rxon_context *ctx);
 263 void iwl_set_rate(struct iwl_priv *priv);
 264 int iwl_mac_add_interface(struct ieee80211_hw *hw,
 265                           struct ieee80211_vif *vif);
 266 void iwl_mac_remove_interface(struct ieee80211_hw *hw,
 267                               struct ieee80211_vif *vif);
 268 int iwl_mac_change_interface(struct ieee80211_hw *hw,
 269                              struct ieee80211_vif *vif,
 270                              enum nl80211_iftype newtype, bool newp2p);
 271 #ifdef CONFIG_IWLWIFI_DEBUGFS
 272 int iwl_alloc_traffic_mem(struct iwl_priv *priv);
 273 void iwl_free_traffic_mem(struct iwl_priv *priv);
 274 void iwl_reset_traffic_log(struct iwl_priv *priv);
 275 void iwl_dbg_log_tx_data_frame(struct iwl_priv *priv,
 276                                 u16 length, struct ieee80211_hdr *header);
 277 void iwl_dbg_log_rx_data_frame(struct iwl_priv *priv,
 278                                 u16 length, struct ieee80211_hdr *header);
 279 const char *get_mgmt_string(int cmd);
 280 const char *get_ctrl_string(int cmd);
 281 void iwl_clear_traffic_stats(struct iwl_priv *priv);
 282 void iwl_update_stats(struct iwl_priv *priv, bool is_tx, __le16 fc,
 283                       u16 len);
 284 #else
 285 static inline int iwl_alloc_traffic_mem(struct iwl_priv *priv)
 286 {
 287         return 0;
 288 }
 289 static inline void iwl_free_traffic_mem(struct iwl_priv *priv)
 290 {
 291 }
 292 static inline void iwl_reset_traffic_log(struct iwl_priv *priv)
 293 {
 294 }
 295 static inline void iwl_dbg_log_tx_data_frame(struct iwl_priv *priv,
 296                       u16 length, struct ieee80211_hdr *header)
 297 {
 298 }
 299 static inline void iwl_dbg_log_rx_data_frame(struct iwl_priv *priv,
 300                       u16 length, struct ieee80211_hdr *header)
 301 {
 302 }
 303 static inline void iwl_update_stats(struct iwl_priv *priv, bool is_tx,
 304                                     __le16 fc, u16 len)
 305 {
 306 }
 307 #endif
 308
 309 /*****************************************************
 310 * RX
 311 ******************************************************/
 312 void iwl_chswitch_done(struct iwl_priv *priv, bool is_success);
 313
 314 void iwl_setup_watchdog(struct iwl_priv *priv);
 315 /*****************************************************
 316  * TX power
 317  ****************************************************/
 318 int iwl_set_tx_power(struct iwl_priv *priv, s8 tx_power, bool force);
 319
 320 /*******************************************************************************
 321  * Scanning
 322  ******************************************************************************/
 323 void iwl_init_scan_params(struct iwl_priv *priv);
 324 int iwl_scan_cancel(struct iwl_priv *priv);
 325 int iwl_scan_cancel_timeout(struct iwl_priv *priv, unsigned long ms);
 326 void iwl_force_scan_end(struct iwl_priv *priv);
 327 int iwl_mac_hw_scan(struct ieee80211_hw *hw,
 328                     struct ieee80211_vif *vif,
 329                     struct cfg80211_scan_request *req);
 330 void iwl_internal_short_hw_scan(struct iwl_priv *priv);
 331 int iwl_force_reset(struct iwl_priv *priv, int mode, bool external);
 332 u16 iwl_fill_probe_req(struct iwl_priv *priv, struct ieee80211_mgmt *frame,
 333                        const u8 *ta, const u8 *ie, int ie_len, int left);
 334 void iwl_setup_rx_scan_handlers(struct iwl_priv *priv);
 335 u16 iwl_get_active_dwell_time(struct iwl_priv *priv,
 336                               enum ieee80211_band band,
 337                               u8 n_probes);
 338 u16 iwl_get_passive_dwell_time(struct iwl_priv *priv,
 339                                enum ieee80211_band band,
 340                                struct ieee80211_vif *vif);
 341 void iwl_setup_scan_deferred_work(struct iwl_priv *priv);
 342 void iwl_cancel_scan_deferred_work(struct iwl_priv *priv);
 343 int __must_check iwl_scan_initiate(struct iwl_priv *priv,
 344                                    struct ieee80211_vif *vif,
 345                                    enum iwl_scan_type scan_type,
 346                                    enum ieee80211_band band);
 347
 348 /* For faster active scanning, scan will move to the next channel if fewer than
 349  * PLCP_QUIET_THRESH packets are heard on this channel within
 350  * ACTIVE_QUIET_TIME after sending probe request.  This shortens the dwell
 351  * time if it's a quiet channel (nothing responded to our probe, and there's
 352  * no other traffic).
 353  * Disable "quiet" feature by setting PLCP_QUIET_THRESH to 0. */
 354 #define IWL_ACTIVE_QUIET_TIME       cpu_to_le16(10)  /* msec */
 355 #define IWL_PLCP_QUIET_THRESH       cpu_to_le16(1)  /* packets */
 356
 357 #define IWL_SCAN_CHECK_WATCHDOG         (HZ * 7)
 358
 359 /*****************************************************
 360  *   S e n d i n g     H o s t     C o m m a n d s   *
 361  *****************************************************/
 362
 363 const char *get_cmd_string(u8 cmd);
 364 void iwl_bg_watchdog(unsigned long data);
 365 u32 iwl_usecs_to_beacons(struct iwl_priv *priv, u32 usec, u32 beacon_interval);
 366 __le32 iwl_add_beacon_time(struct iwl_priv *priv, u32 base,
 367                            u32 addon, u32 beacon_interval);
 368
 369
 370 /*****************************************************
 371 *  Error Handling Debugging
 372 ******************************************************/
 373 #ifdef CONFIG_IWLWIFI_DEBUG
 374 void iwl_print_rx_config_cmd(struct iwl_priv *priv,
 375                              struct iwl_rxon_context *ctx);
 376 #else
 377 static inline void iwl_print_rx_config_cmd(struct iwl_priv *priv,
 378                                            struct iwl_rxon_context *ctx)
 379 {
 380 }
 381 #endif
 382
 383 /*****************************************************
 384 *  GEOS
 385 ******************************************************/
 386 int iwl_init_geos(struct iwl_priv *priv);
 387 void iwl_free_geos(struct iwl_priv *priv);
 388
 389 extern void iwl_send_bt_config(struct iwl_priv *priv);
 390 extern int iwl_send_statistics_request(struct iwl_priv *priv,
 391                                        u8 flags, bool clear);
 392 void iwl_apm_stop(struct iwl_priv *priv);
 393 int iwl_apm_init(struct iwl_priv *priv);
 394
 395 int iwl_send_rxon_timing(struct iwl_priv *priv, struct iwl_rxon_context *ctx);
 396
 397 static inline const struct ieee80211_supported_band *iwl_get_hw_mode(
 398                         struct iwl_priv *priv, enum ieee80211_band band)
 399 {
 400         return priv->hw->wiphy->bands[band];
 401 }
 402
 403 static inline bool iwl_advanced_bt_coexist(struct iwl_priv *priv)
 404 {
 405         return priv->cfg->bt_params &&
 406                priv->cfg->bt_params->advanced_bt_coexist;
 407 }
 408
 409 extern bool bt_siso_mode;
 410
 411
 412 void iwlagn_fw_error(struct iwl_priv *priv, bool ondemand);
 413
 414 #endif /* __iwl_core_h__ */