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