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