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  ************************/
  69 struct iwl_host_cmd;
  70 struct iwl_cmd;
  71
  72
  73 #define IWLWIFI_VERSION "1.2.26k"
  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 };
  97
  98 struct iwl_lib_ops {
  99         /* set hw dependant perameters */
 100         int (*set_hw_params)(struct iwl_priv *priv);
 101         /* ucode shared memory */
 102         int (*alloc_shared_mem)(struct iwl_priv *priv);
 103         void (*free_shared_mem)(struct iwl_priv *priv);
 104         int (*shared_mem_rx_idx)(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         /* rfkill */
 132         int (*radio_kill_sw)(struct iwl_priv *priv, int disable_radio);
 133          /* power management */
 134         struct {
 135                 int (*init)(struct iwl_priv *priv);
 136                 int (*reset)(struct iwl_priv *priv);
 137                 void (*stop)(struct iwl_priv *priv);
 138                 void (*config)(struct iwl_priv *priv);
 139                 int (*set_pwr_src)(struct iwl_priv *priv, enum iwl_pwr_src src);
 140         } apm_ops;
 141         /* power */
 142         int (*set_power)(struct iwl_priv *priv, void *cmd);
 143         int (*send_tx_power) (struct iwl_priv *priv);
 144         void (*update_chain_flags)(struct iwl_priv *priv);
 145         /* eeprom operations (as defined in iwl-eeprom.h) */
 146         struct iwl_eeprom_ops eeprom_ops;
 147 };
 148
 149 struct iwl_ops {
 150         const struct iwl_lib_ops *lib;
 151         const struct iwl_hcmd_ops *hcmd;
 152         const struct iwl_hcmd_utils_ops *utils;
 153 };
 154
 155 struct iwl_mod_params {
 156         int disable;            /* def: 0 = enable radio */
 157         int sw_crypto;          /* def: 0 = using hardware encryption */
 158         int debug;              /* def: 0 = minimal debug log messages */
 159         int disable_hw_scan;    /* def: 0 = use h/w scan */
 160         int num_of_queues;      /* def: HW dependent */
 161         int enable_qos;         /* def: 1 = use quality of service */
 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 struct iwl_cfg {
 168         const char *name;
 169         const char *fw_name;
 170         unsigned int sku;
 171         int eeprom_size;
 172         const struct iwl_ops *ops;
 173         const struct iwl_mod_params *mod_params;
 174 };
 175
 176 /***************************
 177  *   L i b                 *
 178  ***************************/
 179
 180 struct ieee80211_hw *iwl_alloc_all(struct iwl_cfg *cfg,
 181                 struct ieee80211_ops *hw_ops);
 182 void iwl_hw_detect(struct iwl_priv *priv);
 183
 184 void iwlcore_clear_stations_table(struct iwl_priv *priv);
 185 void iwl_free_calib_results(struct iwl_priv *priv);
 186 void iwl_reset_qos(struct iwl_priv *priv);
 187 void iwl_set_rxon_chain(struct iwl_priv *priv);
 188 int iwl_set_rxon_channel(struct iwl_priv *priv,
 189                                 enum ieee80211_band band,
 190                                 u16 channel);
 191 void iwl_set_rxon_ht(struct iwl_priv *priv, struct iwl_ht_info *ht_info);
 192 u8 iwl_is_fat_tx_allowed(struct iwl_priv *priv,
 193                          struct ieee80211_ht_info *sta_ht_inf);
 194 int iwl_hw_nic_init(struct iwl_priv *priv);
 195 int iwl_setup_mac(struct iwl_priv *priv);
 196 int iwl_init_drv(struct iwl_priv *priv);
 197 void iwl_uninit_drv(struct iwl_priv *priv);
 198 /* "keep warm" functions */
 199 int iwl_kw_init(struct iwl_priv *priv);
 200 int iwl_kw_alloc(struct iwl_priv *priv);
 201 void iwl_kw_free(struct iwl_priv *priv);
 202
 203 /*****************************************************
 204 * RX
 205 ******************************************************/
 206 void iwl_rx_queue_free(struct iwl_priv *priv, struct iwl_rx_queue *rxq);
 207 int iwl_rx_queue_alloc(struct iwl_priv *priv);
 208 void iwl_rx_handle(struct iwl_priv *priv);
 209 int iwl_rx_queue_update_write_ptr(struct iwl_priv *priv,
 210                                   struct iwl_rx_queue *q);
 211 void iwl_rx_queue_reset(struct iwl_priv *priv, struct iwl_rx_queue *rxq);
 212 void iwl_rx_replenish(struct iwl_priv *priv);
 213 int iwl_rx_init(struct iwl_priv *priv, struct iwl_rx_queue *rxq);
 214 /* FIXME: remove when TX is moved to iwl core */
 215 int iwl_rx_queue_restock(struct iwl_priv *priv);
 216 int iwl_rx_queue_space(const struct iwl_rx_queue *q);
 217 void iwl_rx_allocate(struct iwl_priv *priv);
 218 void iwl_tx_cmd_complete(struct iwl_priv *priv, struct iwl_rx_mem_buffer *rxb);
 219 int iwl_tx_queue_reclaim(struct iwl_priv *priv, int txq_id, int index);
 220 /* Handlers */
 221 void iwl_rx_missed_beacon_notif(struct iwl_priv *priv,
 222                                struct iwl_rx_mem_buffer *rxb);
 223
 224 /* TX helpers */
 225
 226 /*****************************************************
 227 * TX
 228 ******************************************************/
 229 int iwl_txq_ctx_reset(struct iwl_priv *priv);
 230 int iwl_tx_skb(struct iwl_priv *priv, struct sk_buff *skb);
 231 /* FIXME: remove when free Tx is fully merged into iwlcore */
 232 int iwl_hw_txq_free_tfd(struct iwl_priv *priv, struct iwl_tx_queue *txq);
 233 void iwl_hw_txq_ctx_free(struct iwl_priv *priv);
 234 int iwl_hw_txq_attach_buf_to_tfd(struct iwl_priv *priv, void *tfd,
 235                                         dma_addr_t addr, u16 len);
 236 int iwl_txq_update_write_ptr(struct iwl_priv *priv, struct iwl_tx_queue *txq);
 237 int iwl_tx_agg_start(struct iwl_priv *priv, const u8 *ra, u16 tid, u16 *ssn);
 238 int iwl_tx_agg_stop(struct iwl_priv *priv , const u8 *ra, u16 tid);
 239 int iwl_txq_check_empty(struct iwl_priv *priv, int sta_id, u8 tid, int txq_id);
 240
 241 /*****************************************************
 242  * TX power
 243  ****************************************************/
 244 int iwl_set_tx_power(struct iwl_priv *priv, s8 tx_power, bool force);
 245
 246 /*******************************************************************************
 247  * Scanning
 248  ******************************************************************************/
 249 int iwl_scan_cancel(struct iwl_priv *priv);
 250 int iwl_scan_cancel_timeout(struct iwl_priv *priv, unsigned long ms);
 251 const char *iwl_escape_essid(const char *essid, u8 essid_len);
 252 int iwl_scan_initiate(struct iwl_priv *priv);
 253 void iwl_setup_rx_scan_handlers(struct iwl_priv *priv);
 254 void iwl_setup_scan_deferred_work(struct iwl_priv *priv);
 255
 256 /*****************************************************
 257  *   S e n d i n g     H o s t     C o m m a n d s   *
 258  *****************************************************/
 259
 260 const char *get_cmd_string(u8 cmd);
 261 int __must_check iwl_send_cmd_sync(struct iwl_priv *priv,
 262                                    struct iwl_host_cmd *cmd);
 263 int iwl_send_cmd(struct iwl_priv *priv, struct iwl_host_cmd *cmd);
 264 int __must_check iwl_send_cmd_pdu(struct iwl_priv *priv, u8 id,
 265                                   u16 len, const void *data);
 266 int iwl_send_cmd_pdu_async(struct iwl_priv *priv, u8 id, u16 len,
 267                            const void *data,
 268                            int (*callback)(struct iwl_priv *priv,
 269                                            struct iwl_cmd *cmd,
 270                                            struct sk_buff *skb));
 271
 272 int iwl_enqueue_hcmd(struct iwl_priv *priv, struct iwl_host_cmd *cmd);
 273
 274 /*****************************************************
 275 *  Error Handling Debugging
 276 ******************************************************/
 277 void iwl_print_event_log(struct iwl_priv *priv, u32 start_idx,
 278                          u32 num_events, u32 mode);
 279 void iwl_dump_nic_error_log(struct iwl_priv *priv);
 280 void iwl_dump_nic_event_log(struct iwl_priv *priv);
 281
 282 /*************** DRIVER STATUS FUNCTIONS   *****/
 283
 284 #define STATUS_HCMD_ACTIVE      0       /* host command in progress */
 285 #define STATUS_HCMD_SYNC_ACTIVE 1       /* sync host command in progress */
 286 #define STATUS_INT_ENABLED      2
 287 #define STATUS_RF_KILL_HW       3
 288 #define STATUS_RF_KILL_SW       4
 289 #define STATUS_INIT             5
 290 #define STATUS_ALIVE            6
 291 #define STATUS_READY            7
 292 #define STATUS_TEMPERATURE      8
 293 #define STATUS_GEO_CONFIGURED   9
 294 #define STATUS_EXIT_PENDING     10
 295 #define STATUS_IN_SUSPEND       11
 296 #define STATUS_STATISTICS       12
 297 #define STATUS_SCANNING         13
 298 #define STATUS_SCAN_ABORTING    14
 299 #define STATUS_SCAN_HW          15
 300 #define STATUS_POWER_PMI        16
 301 #define STATUS_FW_ERROR         17
 302 #define STATUS_CONF_PENDING     18
 303 #define STATUS_MODE_PENDING     19
 304
 305
 306 static inline int iwl_is_ready(struct iwl_priv *priv)
 307 {
 308         /* The adapter is 'ready' if READY and GEO_CONFIGURED bits are
 309          * set but EXIT_PENDING is not */
 310         return test_bit(STATUS_READY, &priv->status) &&
 311                test_bit(STATUS_GEO_CONFIGURED, &priv->status) &&
 312                !test_bit(STATUS_EXIT_PENDING, &priv->status);
 313 }
 314
 315 static inline int iwl_is_alive(struct iwl_priv *priv)
 316 {
 317         return test_bit(STATUS_ALIVE, &priv->status);
 318 }
 319
 320 static inline int iwl_is_init(struct iwl_priv *priv)
 321 {
 322         return test_bit(STATUS_INIT, &priv->status);
 323 }
 324
 325 static inline int iwl_is_rfkill(struct iwl_priv *priv)
 326 {
 327         return test_bit(STATUS_RF_KILL_HW, &priv->status) ||
 328                test_bit(STATUS_RF_KILL_SW, &priv->status);
 329 }
 330
 331 static inline int iwl_is_ready_rf(struct iwl_priv *priv)
 332 {
 333
 334         if (iwl_is_rfkill(priv))
 335                 return 0;
 336
 337         return iwl_is_ready(priv);
 338 }
 339
 340
 341 enum iwlcore_card_notify {
 342         IWLCORE_INIT_EVT = 0,
 343         IWLCORE_START_EVT = 1,
 344         IWLCORE_STOP_EVT = 2,
 345         IWLCORE_REMOVE_EVT = 3,
 346 };
 347
 348 int iwlcore_low_level_notify(struct iwl_priv *priv,
 349                              enum iwlcore_card_notify notify);
 350 extern int iwl_send_statistics_request(struct iwl_priv *priv, u8 flags);
 351 extern int iwl_verify_ucode(struct iwl_priv *priv);
 352 int iwl_send_lq_cmd(struct iwl_priv *priv,
 353                     struct iwl_link_quality_cmd *lq, u8 flags);
 354
 355 static inline int iwl_send_rxon_assoc(struct iwl_priv *priv)
 356 {
 357         return priv->cfg->ops->hcmd->rxon_assoc(priv);
 358 }
 359
 360 static inline const struct ieee80211_supported_band *iwl_get_hw_mode(
 361                         struct iwl_priv *priv, enum ieee80211_band band)
 362 {
 363         return priv->hw->wiphy->bands[band];
 364 }
 365
 366 #endif /* __iwl_core_h__ */