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