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 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 - 2008 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 /************************
  67  * forward declarations *
  68  ************************/
  69 struct iwl_host_cmd;
  70 struct iwl_cmd;
  71
  72
  73 #define IWLWIFI_VERSION "1.3.27k"
  74 #define DRV_COPYRIGHT   "Copyright(c) 2003-2008 Intel Corporation"
  75 #define DRV_AUTHOR     "<ilw@linux.intel.com>"
  76
  77 #define IWL_PCI_DEVICE(dev, subdev, cfg) \
  78         .vendor = PCI_VENDOR_ID_INTEL,  .device = (dev), \
  79         .subvendor = PCI_ANY_ID, .subdevice = (subdev), \
  80         .driver_data = (kernel_ulong_t)&(cfg)
  81
  82 #define IWL_SKU_G       0x1
  83 #define IWL_SKU_A       0x2
  84 #define IWL_SKU_N       0x8
  85
  86 struct iwl_hcmd_ops {
  87         int (*rxon_assoc)(struct iwl_priv *priv);
  88 };
  89 struct iwl_hcmd_utils_ops {
  90         u16 (*get_hcmd_size)(u8 cmd_id, u16 len);
  91         u16 (*build_addsta_hcmd)(const struct iwl_addsta_cmd *cmd, u8 *data);
  92         void (*gain_computation)(struct iwl_priv *priv,
  93                         u32 *average_noise,
  94                         u16 min_average_noise_antennat_i,
  95                         u32 min_average_noise);
  96         void (*chain_noise_reset)(struct iwl_priv *priv);
  97         void (*rts_tx_cmd_flag)(struct ieee80211_tx_info *info,
  98                         __le32 *tx_flags);
  99         int  (*calc_rssi)(struct iwl_priv *priv,
 100                           struct iwl_rx_phy_res *rx_resp);
 101 };
 102
 103 struct iwl_lib_ops {
 104         /* set hw dependent parameters */
 105         int (*set_hw_params)(struct iwl_priv *priv);
 106         /* Handling TX */
 107         void (*txq_update_byte_cnt_tbl)(struct iwl_priv *priv,
 108                                         struct iwl_tx_queue *txq,
 109                                         u16 byte_cnt);
 110         void (*txq_inval_byte_cnt_tbl)(struct iwl_priv *priv,
 111                                        struct iwl_tx_queue *txq);
 112         void (*txq_set_sched)(struct iwl_priv *priv, u32 mask);
 113         /* aggregations */
 114         int (*txq_agg_enable)(struct iwl_priv *priv, int txq_id, int tx_fifo,
 115                               int sta_id, int tid, u16 ssn_idx);
 116         int (*txq_agg_disable)(struct iwl_priv *priv, u16 txq_id, u16 ssn_idx,
 117                                u8 tx_fifo);
 118         /* setup Rx handler */
 119         void (*rx_handler_setup)(struct iwl_priv *priv);
 120         /* setup deferred work */
 121         void (*setup_deferred_work)(struct iwl_priv *priv);
 122         /* cancel deferred work */
 123         void (*cancel_deferred_work)(struct iwl_priv *priv);
 124         /* alive notification after init uCode load */
 125         void (*init_alive_start)(struct iwl_priv *priv);
 126         /* alive notification */
 127         int (*alive_notify)(struct iwl_priv *priv);
 128         /* check validity of rtc data address */
 129         int (*is_valid_rtc_data_addr)(u32 addr);
 130         /* 1st ucode load */
 131         int (*load_ucode)(struct iwl_priv *priv);
 132          /* power management */
 133         struct {
 134                 int (*init)(struct iwl_priv *priv);
 135                 int (*reset)(struct iwl_priv *priv);
 136                 void (*stop)(struct iwl_priv *priv);
 137                 void (*config)(struct iwl_priv *priv);
 138                 int (*set_pwr_src)(struct iwl_priv *priv, enum iwl_pwr_src src);
 139         } apm_ops;
 140         /* power */
 141         int (*send_tx_power) (struct iwl_priv *priv);
 142         void (*update_chain_flags)(struct iwl_priv *priv);
 143         void (*temperature) (struct iwl_priv *priv);
 144         /* eeprom operations (as defined in iwl-eeprom.h) */
 145         struct iwl_eeprom_ops eeprom_ops;
 146 };
 147
 148 struct iwl_ops {
 149         const struct iwl_lib_ops *lib;
 150         const struct iwl_hcmd_ops *hcmd;
 151         const struct iwl_hcmd_utils_ops *utils;
 152 };
 153
 154 struct iwl_mod_params {
 155         int disable;            /* def: 0 = enable radio */
 156         int sw_crypto;          /* def: 0 = using hardware encryption */
 157         u32 debug;              /* def: 0 = minimal debug log messages */
 158         int disable_hw_scan;    /* def: 0 = use h/w scan */
 159         int num_of_queues;      /* def: HW dependent */
 160         int num_of_ampdu_queues;/* def: HW dependent */
 161         int disable_11n;        /* def: 0 = disable 11n capabilities */
 162         int amsdu_size_8K;      /* def: 1 = enable 8K amsdu size */
 163         int antenna;            /* def: 0 = both antennas (use diversity) */
 164         int restart_fw;         /* def: 1 = restart firmware */
 165 };
 166
 167 /**
 168  * struct iwl_cfg
 169  * @fw_name_pre: Firmware filename prefix. The api version and extension
 170  *      (.ucode) will be added to filename before loading from disk. The
 171  *      filename is constructed as fw_name_pre<api>.ucode.
 172  * @ucode_api_max: Highest version of uCode API supported by driver.
 173  * @ucode_api_min: Lowest version of uCode API supported by driver.
 174  *
 175  * We enable the driver to be backward compatible wrt API version. The
 176  * driver specifies which APIs it supports (with @ucode_api_max being the
 177  * highest and @ucode_api_min the lowest). Firmware will only be loaded if
 178  * it has a supported API version. The firmware's API version will be
 179  * stored in @iwl_priv, enabling the driver to make runtime changes based
 180  * on firmware version used.
 181  *
 182  * For example,
 183  * if (IWL_UCODE_API(priv->ucode_ver) >= 2) {
 184  *      Driver interacts with Firmware API version >= 2.
 185  * } else {
 186  *      Driver interacts with Firmware API version 1.
 187  * }
 188  *
 189  * The ideal usage of this infrastructure is to treat a new ucode API
 190  * release as a new hardware revision. That is, through utilizing the
 191  * iwl_hcmd_utils_ops etc. we accommodate different command structures
 192  * and flows between hardware versions (4965/5000) as well as their API
 193  * versions.
 194  */
 195 struct iwl_cfg {
 196         const char *name;
 197         const char *fw_name_pre;
 198         const unsigned int ucode_api_max;
 199         const unsigned int ucode_api_min;
 200         unsigned int sku;
 201         int eeprom_size;
 202         u16  eeprom_ver;
 203         u16  eeprom_calib_ver;
 204         const struct iwl_ops *ops;
 205         const struct iwl_mod_params *mod_params;
 206 };
 207
 208 /**
 209  * struct iwl_3945_cfg
 210  * @fw_name_pre: Firmware filename prefix. The api version and extension
 211  *      (.ucode) will be added to filename before loading from disk. The
 212  *      filename is constructed as fw_name_pre<api>.ucode.
 213  * @ucode_api_max: Highest version of uCode API supported by driver.
 214  * @ucode_api_min: Lowest version of uCode API supported by driver.
 215  *
 216  * We enable the driver to be backward compatible wrt API version. The
 217  * driver specifies which APIs it supports (with @ucode_api_max being the
 218  * highest and @ucode_api_min the lowest). Firmware will only be loaded if
 219  * it has a supported API version. The firmware's API version will be
 220  * stored in @iwl_priv, enabling the driver to make runtime changes based
 221  * on firmware version used.
 222  *
 223  * For example,
 224  * if (IWL_UCODE_API(priv->ucode_ver) >= 2) {
 225  *      Driver interacts with Firmware API version >= 2.
 226  * } else {
 227  *      Driver interacts with Firmware API version 1.
 228  * }
 229  */
 230 struct iwl_3945_cfg {
 231         const char *name;
 232         const char *fw_name_pre;
 233         const unsigned int ucode_api_max;
 234         const unsigned int ucode_api_min;
 235         unsigned int sku;
 236 };
 237
 238 /***************************
 239  *   L i b                 *
 240  ***************************/
 241
 242 struct ieee80211_hw *iwl_alloc_all(struct iwl_cfg *cfg,
 243                 struct ieee80211_ops *hw_ops);
 244 void iwl_hw_detect(struct iwl_priv *priv);
 245 void iwl_reset_qos(struct iwl_priv *priv);
 246 void iwl_set_rxon_chain(struct iwl_priv *priv);
 247 int iwl_set_rxon_channel(struct iwl_priv *priv, struct ieee80211_channel *ch);
 248 void iwl_set_rxon_ht(struct iwl_priv *priv, struct iwl_ht_info *ht_info);
 249 u8 iwl_is_fat_tx_allowed(struct iwl_priv *priv,
 250                          struct ieee80211_sta_ht_cap *sta_ht_inf);
 251 int iwl_hw_nic_init(struct iwl_priv *priv);
 252 int iwl_setup_mac(struct iwl_priv *priv);
 253 int iwl_set_hw_params(struct iwl_priv *priv);
 254 int iwl_init_drv(struct iwl_priv *priv);
 255 void iwl_uninit_drv(struct iwl_priv *priv);
 256
 257 /*****************************************************
 258 * RX
 259 ******************************************************/
 260 void iwl_rx_queue_free(struct iwl_priv *priv, struct iwl_rx_queue *rxq);
 261 int iwl_rx_queue_alloc(struct iwl_priv *priv);
 262 void iwl_rx_handle(struct iwl_priv *priv);
 263 int iwl_rx_queue_update_write_ptr(struct iwl_priv *priv,
 264                                   struct iwl_rx_queue *q);
 265 void iwl_rx_queue_reset(struct iwl_priv *priv, struct iwl_rx_queue *rxq);
 266 void iwl_rx_replenish(struct iwl_priv *priv);
 267 int iwl_rx_init(struct iwl_priv *priv, struct iwl_rx_queue *rxq);
 268 int iwl_rx_queue_restock(struct iwl_priv *priv);
 269 int iwl_rx_queue_space(const struct iwl_rx_queue *q);
 270 void iwl_rx_allocate(struct iwl_priv *priv);
 271 void iwl_tx_cmd_complete(struct iwl_priv *priv, struct iwl_rx_mem_buffer *rxb);
 272 int iwl_tx_queue_reclaim(struct iwl_priv *priv, int txq_id, int index);
 273 /* Handlers */
 274 void iwl_rx_missed_beacon_notif(struct iwl_priv *priv,
 275                                struct iwl_rx_mem_buffer *rxb);
 276 void iwl_rx_statistics(struct iwl_priv *priv,
 277                               struct iwl_rx_mem_buffer *rxb);
 278
 279 /* TX helpers */
 280
 281 /*****************************************************
 282 * TX
 283 ******************************************************/
 284 int iwl_txq_ctx_reset(struct iwl_priv *priv);
 285 int iwl_tx_skb(struct iwl_priv *priv, struct sk_buff *skb);
 286 void iwl_hw_txq_ctx_free(struct iwl_priv *priv);
 287 int iwl_txq_update_write_ptr(struct iwl_priv *priv, struct iwl_tx_queue *txq);
 288 int iwl_tx_agg_start(struct iwl_priv *priv, const u8 *ra, u16 tid, u16 *ssn);
 289 int iwl_tx_agg_stop(struct iwl_priv *priv , const u8 *ra, u16 tid);
 290 int iwl_txq_check_empty(struct iwl_priv *priv, int sta_id, u8 tid, int txq_id);
 291 /*****************************************************
 292  * TX power
 293  ****************************************************/
 294 int iwl_set_tx_power(struct iwl_priv *priv, s8 tx_power, bool force);
 295
 296 /*****************************************************
 297  * RF -Kill - here and not in iwl-rfkill.h to be available when
 298  * RF-kill subsystem is not compiled.
 299  ****************************************************/
 300 void iwl_rf_kill(struct iwl_priv *priv);
 301 void iwl_radio_kill_sw_disable_radio(struct iwl_priv *priv);
 302 int iwl_radio_kill_sw_enable_radio(struct iwl_priv *priv);
 303
 304 /*******************************************************************************
 305  * Rate
 306  ******************************************************************************/
 307
 308 void iwl_hwrate_to_tx_control(struct iwl_priv *priv, u32 rate_n_flags,
 309                               struct ieee80211_tx_info *info);
 310 int iwl_hwrate_to_plcp_idx(u32 rate_n_flags);
 311
 312 u8 iwl_toggle_tx_ant(struct iwl_priv *priv, u8 ant_idx);
 313
 314 static inline u32 iwl_ant_idx_to_flags(u8 ant_idx)
 315 {
 316         return BIT(ant_idx) << RATE_MCS_ANT_POS;
 317 }
 318
 319 static inline u8 iwl_hw_get_rate(__le32 rate_n_flags)
 320 {
 321         return le32_to_cpu(rate_n_flags) & 0xFF;
 322 }
 323 static inline u32 iwl_hw_get_rate_n_flags(__le32 rate_n_flags)
 324 {
 325         return le32_to_cpu(rate_n_flags) & 0x1FFFF;
 326 }
 327 static inline __le32 iwl_hw_set_rate_n_flags(u8 rate, u32 flags)
 328 {
 329         return cpu_to_le32(flags|(u32)rate);
 330 }
 331
 332 /*******************************************************************************
 333  * Scanning
 334  ******************************************************************************/
 335 void iwl_init_scan_params(struct iwl_priv *priv);
 336 int iwl_scan_cancel(struct iwl_priv *priv);
 337 int iwl_scan_cancel_timeout(struct iwl_priv *priv, unsigned long ms);
 338 int iwl_scan_initiate(struct iwl_priv *priv);
 339 void iwl_setup_rx_scan_handlers(struct iwl_priv *priv);
 340 void iwl_setup_scan_deferred_work(struct iwl_priv *priv);
 341
 342 /*******************************************************************************
 343  * Calibrations - implemented in iwl-calib.c
 344  ******************************************************************************/
 345 int iwl_send_calib_results(struct iwl_priv *priv);
 346 int iwl_calib_set(struct iwl_calib_result *res, const u8 *buf, int len);
 347 void iwl_calib_free_results(struct iwl_priv *priv);
 348
 349 /*******************************************************************************
 350  * Spectrum Measureemtns in  iwl-spectrum.c
 351  ******************************************************************************/
 352 #ifdef CONFIG_IWLAGN_SPECTRUM_MEASUREMENT
 353 void iwl_setup_spectrum_handlers(struct iwl_priv *priv);
 354 #else
 355 static inline void iwl_setup_spectrum_handlers(struct iwl_priv *priv) {}
 356 #endif
 357 /*****************************************************
 358  *   S e n d i n g     H o s t     C o m m a n d s   *
 359  *****************************************************/
 360
 361 const char *get_cmd_string(u8 cmd);
 362 int __must_check iwl_send_cmd_sync(struct iwl_priv *priv,
 363                                    struct iwl_host_cmd *cmd);
 364 int iwl_send_cmd(struct iwl_priv *priv, struct iwl_host_cmd *cmd);
 365 int __must_check iwl_send_cmd_pdu(struct iwl_priv *priv, u8 id,
 366                                   u16 len, const void *data);
 367 int iwl_send_cmd_pdu_async(struct iwl_priv *priv, u8 id, u16 len,
 368                            const void *data,
 369                            int (*callback)(struct iwl_priv *priv,
 370                                            struct iwl_cmd *cmd,
 371                                            struct sk_buff *skb));
 372
 373 int iwl_enqueue_hcmd(struct iwl_priv *priv, struct iwl_host_cmd *cmd);
 374
 375 /*****************************************************
 376  * PCI                                               *
 377  *****************************************************/
 378 void iwl_disable_interrupts(struct iwl_priv *priv);
 379 void iwl_enable_interrupts(struct iwl_priv *priv);
 380
 381 /*****************************************************
 382 *  Error Handling Debugging
 383 ******************************************************/
 384 void iwl_dump_nic_error_log(struct iwl_priv *priv);
 385 void iwl_dump_nic_event_log(struct iwl_priv *priv);
 386
 387
 388 /*************** DRIVER STATUS FUNCTIONS   *****/
 389
 390 #define STATUS_HCMD_ACTIVE      0       /* host command in progress */
 391 #define STATUS_HCMD_SYNC_ACTIVE 1       /* sync host command in progress */
 392 #define STATUS_INT_ENABLED      2
 393 #define STATUS_RF_KILL_HW       3
 394 #define STATUS_RF_KILL_SW       4
 395 #define STATUS_INIT             5
 396 #define STATUS_ALIVE            6
 397 #define STATUS_READY            7
 398 #define STATUS_TEMPERATURE      8
 399 #define STATUS_GEO_CONFIGURED   9
 400 #define STATUS_EXIT_PENDING     10
 401 #define STATUS_IN_SUSPEND       11
 402 #define STATUS_STATISTICS       12
 403 #define STATUS_SCANNING         13
 404 #define STATUS_SCAN_ABORTING    14
 405 #define STATUS_SCAN_HW          15
 406 #define STATUS_POWER_PMI        16
 407 #define STATUS_FW_ERROR         17
 408 #define STATUS_MODE_PENDING     18
 409
 410
 411 static inline int iwl_is_ready(struct iwl_priv *priv)
 412 {
 413         /* The adapter is 'ready' if READY and GEO_CONFIGURED bits are
 414          * set but EXIT_PENDING is not */
 415         return test_bit(STATUS_READY, &priv->status) &&
 416                test_bit(STATUS_GEO_CONFIGURED, &priv->status) &&
 417                !test_bit(STATUS_EXIT_PENDING, &priv->status);
 418 }
 419
 420 static inline int iwl_is_alive(struct iwl_priv *priv)
 421 {
 422         return test_bit(STATUS_ALIVE, &priv->status);
 423 }
 424
 425 static inline int iwl_is_init(struct iwl_priv *priv)
 426 {
 427         return test_bit(STATUS_INIT, &priv->status);
 428 }
 429
 430 static inline int iwl_is_rfkill_sw(struct iwl_priv *priv)
 431 {
 432         return test_bit(STATUS_RF_KILL_SW, &priv->status);
 433 }
 434
 435 static inline int iwl_is_rfkill_hw(struct iwl_priv *priv)
 436 {
 437         return test_bit(STATUS_RF_KILL_HW, &priv->status);
 438 }
 439
 440 static inline int iwl_is_rfkill(struct iwl_priv *priv)
 441 {
 442         return iwl_is_rfkill_hw(priv) || iwl_is_rfkill_sw(priv);
 443 }
 444
 445 static inline int iwl_is_ready_rf(struct iwl_priv *priv)
 446 {
 447
 448         if (iwl_is_rfkill(priv))
 449                 return 0;
 450
 451         return iwl_is_ready(priv);
 452 }
 453
 454 extern void iwl_rf_kill_ct_config(struct iwl_priv *priv);
 455 extern int iwl_send_statistics_request(struct iwl_priv *priv, u8 flags);
 456 extern int iwl_verify_ucode(struct iwl_priv *priv);
 457 extern int iwl_send_lq_cmd(struct iwl_priv *priv,
 458                 struct iwl_link_quality_cmd *lq, u8 flags);
 459 extern void iwl_rx_reply_rx(struct iwl_priv *priv,
 460                 struct iwl_rx_mem_buffer *rxb);
 461 extern void iwl_rx_reply_rx_phy(struct iwl_priv *priv,
 462                                     struct iwl_rx_mem_buffer *rxb);
 463 void iwl_rx_reply_compressed_ba(struct iwl_priv *priv,
 464                                            struct iwl_rx_mem_buffer *rxb);
 465
 466 static inline int iwl_send_rxon_assoc(struct iwl_priv *priv)
 467 {
 468         return priv->cfg->ops->hcmd->rxon_assoc(priv);
 469 }
 470
 471 static inline const struct ieee80211_supported_band *iwl_get_hw_mode(
 472                         struct iwl_priv *priv, enum ieee80211_band band)
 473 {
 474         return priv->hw->wiphy->bands[band];
 475 }
 476
 477 #endif /* __iwl_core_h__ */