LXR linux/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 * Tomas Winkler <tomas.winkler@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 ************************/
  69struct iwl_host_cmd;
  70struct 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
  85struct iwl_hcmd_ops {
  86        int (*rxon_assoc)(struct iwl_priv *priv);
  87};
  88struct 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
 102struct iwl_lib_ops {
 103        /* set hw dependant perameters */
 104        int (*set_hw_params)(struct iwl_priv *priv);
 105        /* ucode shared memory */
 106        int (*alloc_shared_mem)(struct iwl_priv *priv);
 107        void (*free_shared_mem)(struct iwl_priv *priv);
 108        int (*shared_mem_rx_idx)(struct iwl_priv *priv);
 109        /* Handling TX */
 110        void (*txq_update_byte_cnt_tbl)(struct iwl_priv *priv,
 111                                        struct iwl_tx_queue *txq,
 112                                        u16 byte_cnt);
 113        void (*txq_inval_byte_cnt_tbl)(struct iwl_priv *priv,
 114                                       struct iwl_tx_queue *txq);
 115        void (*txq_set_sched)(struct iwl_priv *priv, u32 mask);
 116        /* aggregations */
 117        int (*txq_agg_enable)(struct iwl_priv *priv, int txq_id, int tx_fifo,
 118                              int sta_id, int tid, u16 ssn_idx);
 119        int (*txq_agg_disable)(struct iwl_priv *priv, u16 txq_id, u16 ssn_idx,
 120                               u8 tx_fifo);
 121        /* setup Rx handler */
 122        void (*rx_handler_setup)(struct iwl_priv *priv);
 123        /* setup deferred work */
 124        void (*setup_deferred_work)(struct iwl_priv *priv);
 125        /* cancel deferred work */
 126        void (*cancel_deferred_work)(struct iwl_priv *priv);
 127        /* alive notification after init uCode load */
 128        void (*init_alive_start)(struct iwl_priv *priv);
 129        /* alive notification */
 130        int (*alive_notify)(struct iwl_priv *priv);
 131        /* check validity of rtc data address */
 132        int (*is_valid_rtc_data_addr)(u32 addr);
 133        /* 1st ucode load */
 134        int (*load_ucode)(struct iwl_priv *priv);
 135         /* power management */
 136        struct {
 137                int (*init)(struct iwl_priv *priv);
 138                int (*reset)(struct iwl_priv *priv);
 139                void (*stop)(struct iwl_priv *priv);
 140                void (*config)(struct iwl_priv *priv);
 141                int (*set_pwr_src)(struct iwl_priv *priv, enum iwl_pwr_src src);
 142        } apm_ops;
 143        /* power */
 144        int (*send_tx_power) (struct iwl_priv *priv);
 145        void (*update_chain_flags)(struct iwl_priv *priv);
 146        void (*temperature) (struct iwl_priv *priv);
 147        /* eeprom operations (as defined in iwl-eeprom.h) */
 148        struct iwl_eeprom_ops eeprom_ops;
 149};
 150
 151struct iwl_ops {
 152        const struct iwl_lib_ops *lib;
 153        const struct iwl_hcmd_ops *hcmd;
 154        const struct iwl_hcmd_utils_ops *utils;
 155};
 156
 157struct iwl_mod_params {
 158        int disable;            /* def: 0 = enable radio */
 159        int sw_crypto;          /* def: 0 = using hardware encryption */
 160        int debug;              /* def: 0 = minimal debug log messages */
 161        int disable_hw_scan;    /* def: 0 = use h/w scan */
 162        int num_of_queues;      /* def: HW dependent */
 163        int num_of_ampdu_queues;/* def: HW dependent */
 164        int enable_qos;         /* def: 1 = use quality of service */
 165        int disable_11n;        /* def: 0 = disable 11n capabilities */
 166        int amsdu_size_8K;      /* def: 1 = enable 8K amsdu size */
 167        int antenna;            /* def: 0 = both antennas (use diversity) */
 168        int restart_fw;         /* def: 1 = restart firmware */
 169};
 170
 171struct iwl_cfg {
 172        const char *name;
 173        const char *fw_name;
 174        unsigned int sku;
 175        int eeprom_size;
 176        const struct iwl_ops *ops;
 177        const struct iwl_mod_params *mod_params;
 178};
 179
 180/***************************
 181 *   L i b                 *
 182 ***************************/
 183
 184struct ieee80211_hw *iwl_alloc_all(struct iwl_cfg *cfg,
 185                struct ieee80211_ops *hw_ops);
 186void iwl_hw_detect(struct iwl_priv *priv);
 187void iwl_clear_stations_table(struct iwl_priv *priv);
 188void iwl_reset_qos(struct iwl_priv *priv);
 189void iwl_set_rxon_chain(struct iwl_priv *priv);
 190int iwl_set_rxon_channel(struct iwl_priv *priv, struct ieee80211_channel *ch);
 191void iwl_set_rxon_ht(struct iwl_priv *priv, struct iwl_ht_info *ht_info);
 192u8 iwl_is_fat_tx_allowed(struct iwl_priv *priv,
 193                         struct ieee80211_ht_info *sta_ht_inf);
 194int iwl_hw_nic_init(struct iwl_priv *priv);
 195int iwl_setup_mac(struct iwl_priv *priv);
 196int iwl_set_hw_params(struct iwl_priv *priv);
 197int iwl_init_drv(struct iwl_priv *priv);
 198void iwl_uninit_drv(struct iwl_priv *priv);
 199/* "keep warm" functions */
 200int iwl_kw_init(struct iwl_priv *priv);
 201int iwl_kw_alloc(struct iwl_priv *priv);
 202void iwl_kw_free(struct iwl_priv *priv);
 203
 204/*****************************************************
 205* RX
 206******************************************************/
 207void iwl_rx_queue_free(struct iwl_priv *priv, struct iwl_rx_queue *rxq);
 208int iwl_rx_queue_alloc(struct iwl_priv *priv);
 209void iwl_rx_handle(struct iwl_priv *priv);
 210int iwl_rx_queue_update_write_ptr(struct iwl_priv *priv,
 211                                  struct iwl_rx_queue *q);
 212void iwl_rx_queue_reset(struct iwl_priv *priv, struct iwl_rx_queue *rxq);
 213void iwl_rx_replenish(struct iwl_priv *priv);
 214int iwl_rx_init(struct iwl_priv *priv, struct iwl_rx_queue *rxq);
 215int iwl_rx_agg_start(struct iwl_priv *priv, const u8 *addr, int tid, u16 ssn);
 216int iwl_rx_agg_stop(struct iwl_priv *priv, const u8 *addr, int tid);
 217int iwl_rx_queue_restock(struct iwl_priv *priv);
 218int iwl_rx_queue_space(const struct iwl_rx_queue *q);
 219void iwl_rx_allocate(struct iwl_priv *priv);
 220void iwl_tx_cmd_complete(struct iwl_priv *priv, struct iwl_rx_mem_buffer *rxb);
 221int iwl_tx_queue_reclaim(struct iwl_priv *priv, int txq_id, int index);
 222/* Handlers */
 223void iwl_rx_missed_beacon_notif(struct iwl_priv *priv,
 224                               struct iwl_rx_mem_buffer *rxb);
 225void iwl_rx_statistics(struct iwl_priv *priv,
 226                              struct iwl_rx_mem_buffer *rxb);
 227
 228/* TX helpers */
 229
 230/*****************************************************
 231* TX
 232******************************************************/
 233int iwl_txq_ctx_reset(struct iwl_priv *priv);
 234int iwl_tx_skb(struct iwl_priv *priv, struct sk_buff *skb);
 235void iwl_hw_txq_ctx_free(struct iwl_priv *priv);
 236int iwl_txq_update_write_ptr(struct iwl_priv *priv, struct iwl_tx_queue *txq);
 237int iwl_tx_agg_start(struct iwl_priv *priv, const u8 *ra, u16 tid, u16 *ssn);
 238int iwl_tx_agg_stop(struct iwl_priv *priv , const u8 *ra, u16 tid);
 239int iwl_txq_check_empty(struct iwl_priv *priv, int sta_id, u8 tid, int txq_id);
 240
 241/*****************************************************
 242 * TX power
 243 ****************************************************/
 244int iwl_set_tx_power(struct iwl_priv *priv, s8 tx_power, bool force);
 245
 246/*****************************************************
 247 * RF -Kill - here and not in iwl-rfkill.h to be available when
 248 * RF-kill subsystem is not compiled.
 249 ****************************************************/
 250void iwl_rf_kill(struct iwl_priv *priv);
 251void iwl_radio_kill_sw_disable_radio(struct iwl_priv *priv);
 252int iwl_radio_kill_sw_enable_radio(struct iwl_priv *priv);
 253
 254/*******************************************************************************
 255 * Rate
 256 ******************************************************************************/
 257
 258void iwl_hwrate_to_tx_control(struct iwl_priv *priv, u32 rate_n_flags,
 259                              struct ieee80211_tx_info *info);
 260int iwl_hwrate_to_plcp_idx(u32 rate_n_flags);
 261
 262static inline u8 iwl_hw_get_rate(__le32 rate_n_flags)
 263{
 264        return le32_to_cpu(rate_n_flags) & 0xFF;
 265}
 266static inline u32 iwl_hw_get_rate_n_flags(__le32 rate_n_flags)
 267{
 268        return le32_to_cpu(rate_n_flags) & 0x1FFFF;
 269}
 270static inline __le32 iwl_hw_set_rate_n_flags(u8 rate, u32 flags)
 271{
 272        return cpu_to_le32(flags|(u32)rate);
 273}
 274
 275/*******************************************************************************
 276 * Scanning
 277 ******************************************************************************/
 278void iwl_init_scan_params(struct iwl_priv *priv);
 279int iwl_scan_cancel(struct iwl_priv *priv);
 280int iwl_scan_cancel_timeout(struct iwl_priv *priv, unsigned long ms);
 281int iwl_scan_initiate(struct iwl_priv *priv);
 282void iwl_setup_rx_scan_handlers(struct iwl_priv *priv);
 283void iwl_setup_scan_deferred_work(struct iwl_priv *priv);
 284
 285/*******************************************************************************
 286 * Calibrations - implemented in iwl-calib.c
 287 ******************************************************************************/
 288int iwl_send_calib_results(struct iwl_priv *priv);
 289int iwl_calib_set(struct iwl_calib_result *res, const u8 *buf, int len);
 290void iwl_calib_free_results(struct iwl_priv *priv);
 291
 292/*****************************************************
 293 *   S e n d i n g     H o s t     C o m m a n d s   *
 294 *****************************************************/
 295
 296const char *get_cmd_string(u8 cmd);
 297int __must_check iwl_send_cmd_sync(struct iwl_priv *priv,
 298                                   struct iwl_host_cmd *cmd);
 299int iwl_send_cmd(struct iwl_priv *priv, struct iwl_host_cmd *cmd);
 300int __must_check iwl_send_cmd_pdu(struct iwl_priv *priv, u8 id,
 301                                  u16 len, const void *data);
 302int iwl_send_cmd_pdu_async(struct iwl_priv *priv, u8 id, u16 len,
 303                           const void *data,
 304                           int (*callback)(struct iwl_priv *priv,
 305                                           struct iwl_cmd *cmd,
 306                                           struct sk_buff *skb));
 307
 308int iwl_enqueue_hcmd(struct iwl_priv *priv, struct iwl_host_cmd *cmd);
 309
 310/*****************************************************
 311*  Error Handling Debugging
 312******************************************************/
 313void iwl_dump_nic_error_log(struct iwl_priv *priv);
 314void iwl_dump_nic_event_log(struct iwl_priv *priv);
 315
 316/*************** DRIVER STATUS FUNCTIONS   *****/
 317
 318#define STATUS_HCMD_ACTIVE      0       /* host command in progress */
 319#define STATUS_HCMD_SYNC_ACTIVE 1       /* sync host command in progress */
 320#define STATUS_INT_ENABLED      2
 321#define STATUS_RF_KILL_HW       3
 322#define STATUS_RF_KILL_SW       4
 323#define STATUS_INIT             5
 324#define STATUS_ALIVE            6
 325#define STATUS_READY            7
 326#define STATUS_TEMPERATURE      8
 327#define STATUS_GEO_CONFIGURED   9
 328#define STATUS_EXIT_PENDING     10
 329#define STATUS_IN_SUSPEND       11
 330#define STATUS_STATISTICS       12
 331#define STATUS_SCANNING         13
 332#define STATUS_SCAN_ABORTING    14
 333#define STATUS_SCAN_HW          15
 334#define STATUS_POWER_PMI        16
 335#define STATUS_FW_ERROR         17
 336#define STATUS_MODE_PENDING     18
 337
 338
 339static inline int iwl_is_ready(struct iwl_priv *priv)
 340{
 341        /* The adapter is 'ready' if READY and GEO_CONFIGURED bits are
 342         * set but EXIT_PENDING is not */
 343        return test_bit(STATUS_READY, &priv->status) &&
 344               test_bit(STATUS_GEO_CONFIGURED, &priv->status) &&
 345               !test_bit(STATUS_EXIT_PENDING, &priv->status);
 346}
 347
 348static inline int iwl_is_alive(struct iwl_priv *priv)
 349{
 350        return test_bit(STATUS_ALIVE, &priv->status);
 351}
 352
 353static inline int iwl_is_init(struct iwl_priv *priv)
 354{
 355        return test_bit(STATUS_INIT, &priv->status);
 356}
 357
 358static inline int iwl_is_rfkill_sw(struct iwl_priv *priv)
 359{
 360        return test_bit(STATUS_RF_KILL_SW, &priv->status);
 361}
 362
 363static inline int iwl_is_rfkill_hw(struct iwl_priv *priv)
 364{
 365        return test_bit(STATUS_RF_KILL_HW, &priv->status);
 366}
 367
 368static inline int iwl_is_rfkill(struct iwl_priv *priv)
 369{
 370        return iwl_is_rfkill_hw(priv) || iwl_is_rfkill_sw(priv);
 371}
 372
 373static inline int iwl_is_ready_rf(struct iwl_priv *priv)
 374{
 375
 376        if (iwl_is_rfkill(priv))
 377                return 0;
 378
 379        return iwl_is_ready(priv);
 380}
 381
 382extern void iwl_rf_kill_ct_config(struct iwl_priv *priv);
 383extern int iwl_send_statistics_request(struct iwl_priv *priv, u8 flags);
 384extern int iwl_verify_ucode(struct iwl_priv *priv);
 385extern int iwl_send_lq_cmd(struct iwl_priv *priv,
 386                struct iwl_link_quality_cmd *lq, u8 flags);
 387extern void iwl_rx_reply_rx(struct iwl_priv *priv,
 388                struct iwl_rx_mem_buffer *rxb);
 389extern void iwl_rx_reply_rx_phy(struct iwl_priv *priv,
 390                                    struct iwl_rx_mem_buffer *rxb);
 391void iwl_rx_reply_compressed_ba(struct iwl_priv *priv,
 392                                           struct iwl_rx_mem_buffer *rxb);
 393
 394static inline int iwl_send_rxon_assoc(struct iwl_priv *priv)
 395{
 396        return priv->cfg->ops->hcmd->rxon_assoc(priv);
 397}
 398
 399static inline const struct ieee80211_supported_band *iwl_get_hw_mode(
 400                        struct iwl_priv *priv, enum ieee80211_band band)
 401{
 402        return priv->hw->wiphy->bands[band];
 403}
 404
 405#endif /* __iwl_core_h__ */
 406