ed1811d43550d5525140eb9e9238a2af6a5d610e
[pandora-kernel.git] / drivers / net / wireless / iwlwifi / iwl-shared.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) 2007 - 2012 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 - 2012 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_shared_h__
64 #define __iwl_shared_h__
65
66 #include <linux/types.h>
67 #include <linux/spinlock.h>
68 #include <linux/mutex.h>
69 #include <linux/gfp.h>
70 #include <linux/mm.h> /* for page_address */
71 #include <net/mac80211.h>
72
73 #include "iwl-commands.h"
74
75 /**
76  * DOC: shared area - role and goal
77  *
78  * The shared area contains all the data exported by the upper layer to the
79  * other layers. Since the bus and transport layer shouldn't dereference
80  * iwl_priv, all the data needed by the upper layer and the transport / bus
81  * layer must be here.
82  * The shared area also holds pointer to all the other layers. This allows a
83  * layer to call a function from another layer.
84  *
85  * NOTE: All the layers hold a pointer to the shared area which must be shrd.
86  *      A few macros assume that (_m)->shrd points to the shared area no matter
87  *      what _m is.
88  *
89  * gets notifications about enumeration, suspend, resume.
90  * For the moment, the bus layer is not a linux kernel module as itself, and
91  * the module_init function of the driver must call the bus specific
92  * registration functions. These functions are listed at the end of this file.
93  * For the moment, there is only one implementation of this interface: PCI-e.
94  * This implementation is iwl-pci.c
95  */
96
97 struct iwl_priv;
98 struct iwl_trans;
99 struct iwl_sensitivity_ranges;
100 struct iwl_trans_ops;
101
102 #define DRV_NAME        "iwlwifi"
103 #define IWLWIFI_VERSION "in-tree:"
104 #define DRV_COPYRIGHT   "Copyright(c) 2003-2012 Intel Corporation"
105 #define DRV_AUTHOR     "<ilw@linux.intel.com>"
106
107 extern struct iwl_mod_params iwlagn_mod_params;
108
109 #define IWL_DISABLE_HT_ALL      BIT(0)
110 #define IWL_DISABLE_HT_TXAGG    BIT(1)
111 #define IWL_DISABLE_HT_RXAGG    BIT(2)
112
113 /**
114  * struct iwl_mod_params
115  *
116  * Holds the module parameters
117  *
118  * @sw_crypto: using hardware encryption, default = 0
119  * @num_of_queues: number of tx queue, HW dependent
120  * @disable_11n: disable 11n capabilities, default = 0,
121  *      use IWL_DISABLE_HT_* constants
122  * @amsdu_size_8K: enable 8K amsdu size, default = 1
123  * @antenna: both antennas (use diversity), default = 0
124  * @restart_fw: restart firmware, default = 1
125  * @plcp_check: enable plcp health check, default = true
126  * @ack_check: disable ack health check, default = false
127  * @wd_disable: enable stuck queue check, default = 0
128  * @bt_coex_active: enable bt coex, default = true
129  * @led_mode: system default, default = 0
130  * @no_sleep_autoadjust: disable autoadjust, default = true
131  * @power_save: disable power save, default = false
132  * @power_level: power level, default = 1
133  * @debug_level: levels are IWL_DL_*
134  * @ant_coupling: antenna coupling in dB, default = 0
135  * @bt_ch_announce: BT channel inhibition, default = enable
136  * @wanted_ucode_alternative: ucode alternative to use, default = 1
137  * @auto_agg: enable agg. without check, default = true
138  */
139 struct iwl_mod_params {
140         int sw_crypto;
141         int num_of_queues;
142         unsigned int disable_11n;
143         int amsdu_size_8K;
144         int antenna;
145         int restart_fw;
146         bool plcp_check;
147         bool ack_check;
148         int  wd_disable;
149         bool bt_coex_active;
150         int led_mode;
151         bool no_sleep_autoadjust;
152         bool power_save;
153         int power_level;
154         u32 debug_level;
155         int ant_coupling;
156         bool bt_ch_announce;
157         int wanted_ucode_alternative;
158         bool auto_agg;
159 };
160
161 /**
162  * struct iwl_hw_params
163  *
164  * Holds the module parameters
165  *
166  * @max_txq_num: Max # Tx queues supported
167  * @num_ampdu_queues: num of ampdu queues
168  * @tx_chains_num: Number of TX chains
169  * @rx_chains_num: Number of RX chains
170  * @valid_tx_ant: usable antennas for TX
171  * @valid_rx_ant: usable antennas for RX
172  * @ht40_channel: is 40MHz width possible: BIT(IEEE80211_BAND_XXX)
173  * @sku: sku read from EEPROM
174  * @rx_page_order: Rx buffer page order
175  * @ct_kill_threshold: temperature threshold - in hw dependent unit
176  * @ct_kill_exit_threshold: when to reeable the device - in hw dependent unit
177  *      relevant for 1000, 6000 and up
178  * @wd_timeout: TX queues watchdog timeout
179  * @struct iwl_sensitivity_ranges: range of sensitivity values
180  */
181 struct iwl_hw_params {
182         u8  max_txq_num;
183         u8  num_ampdu_queues;
184         u8  tx_chains_num;
185         u8  rx_chains_num;
186         u8  valid_tx_ant;
187         u8  valid_rx_ant;
188         u8  ht40_channel;
189         bool shadow_reg_enable;
190         u16 sku;
191         u32 rx_page_order;
192         u32 ct_kill_threshold;
193         u32 ct_kill_exit_threshold;
194         unsigned int wd_timeout;
195
196         const struct iwl_sensitivity_ranges *sens;
197 };
198
199 /**
200  * enum iwl_ucode_type
201  *
202  * The type of ucode currently loaded on the hardware.
203  *
204  * @IWL_UCODE_NONE: No ucode loaded
205  * @IWL_UCODE_REGULAR: Normal runtime ucode
206  * @IWL_UCODE_INIT: Initial ucode
207  * @IWL_UCODE_WOWLAN: Wake on Wireless enabled ucode
208  */
209 enum iwl_ucode_type {
210         IWL_UCODE_NONE,
211         IWL_UCODE_REGULAR,
212         IWL_UCODE_INIT,
213         IWL_UCODE_WOWLAN,
214 };
215
216 /**
217  * struct iwl_notification_wait - notification wait entry
218  * @list: list head for global list
219  * @fn: function called with the notification
220  * @cmd: command ID
221  *
222  * This structure is not used directly, to wait for a
223  * notification declare it on the stack, and call
224  * iwlagn_init_notification_wait() with appropriate
225  * parameters. Then do whatever will cause the ucode
226  * to notify the driver, and to wait for that then
227  * call iwlagn_wait_notification().
228  *
229  * Each notification is one-shot. If at some point we
230  * need to support multi-shot notifications (which
231  * can't be allocated on the stack) we need to modify
232  * the code for them.
233  */
234 struct iwl_notification_wait {
235         struct list_head list;
236
237         void (*fn)(struct iwl_trans *trans, struct iwl_rx_packet *pkt,
238                    void *data);
239         void *fn_data;
240
241         u8 cmd;
242         bool triggered, aborted;
243 };
244
245 /**
246  * enum iwl_pa_type - Power Amplifier type
247  * @IWL_PA_SYSTEM:  based on uCode configuration
248  * @IWL_PA_INTERNAL: use Internal only
249  */
250 enum iwl_pa_type {
251         IWL_PA_SYSTEM = 0,
252         IWL_PA_INTERNAL = 1,
253 };
254
255 /*
256  * LED mode
257  *    IWL_LED_DEFAULT:  use device default
258  *    IWL_LED_RF_STATE: turn LED on/off based on RF state
259  *                      LED ON  = RF ON
260  *                      LED OFF = RF OFF
261  *    IWL_LED_BLINK:    adjust led blink rate based on blink table
262  *    IWL_LED_DISABLE:  led disabled
263  */
264 enum iwl_led_mode {
265         IWL_LED_DEFAULT,
266         IWL_LED_RF_STATE,
267         IWL_LED_BLINK,
268         IWL_LED_DISABLE,
269 };
270
271 /**
272  * struct iwl_cfg
273  * @name: Offical name of the device
274  * @fw_name_pre: Firmware filename prefix. The api version and extension
275  *      (.ucode) will be added to filename before loading from disk. The
276  *      filename is constructed as fw_name_pre<api>.ucode.
277  * @ucode_api_max: Highest version of uCode API supported by driver.
278  * @ucode_api_ok: oldest version of the uCode API that is OK to load
279  *      without a warning, for use in transitions
280  * @ucode_api_min: Lowest version of uCode API supported by driver.
281  * @max_inst_size: The maximal length of the fw inst section
282  * @max_data_size: The maximal length of the fw data section
283  * @valid_tx_ant: valid transmit antenna
284  * @valid_rx_ant: valid receive antenna
285  * @eeprom_ver: EEPROM version
286  * @eeprom_calib_ver: EEPROM calibration version
287  * @lib: pointer to the lib ops
288  * @additional_nic_config: additional nic configuration
289  * @base_params: pointer to basic parameters
290  * @ht_params: point to ht patameters
291  * @bt_params: pointer to bt parameters
292  * @pa_type: used by 6000 series only to identify the type of Power Amplifier
293  * @need_temp_offset_calib: need to perform temperature offset calibration
294  * @no_xtal_calib: some devices do not need crystal calibration data,
295  *      don't send it to those
296  * @scan_rx_antennas: available antenna for scan operation
297  * @led_mode: 0=blinking, 1=On(RF On)/Off(RF Off)
298  * @adv_pm: advance power management
299  * @rx_with_siso_diversity: 1x1 device with rx antenna diversity
300  * @internal_wimax_coex: internal wifi/wimax combo device
301  * @iq_invert: I/Q inversion
302  * @temp_offset_v2: support v2 of temperature offset calibration
303  *
304  * We enable the driver to be backward compatible wrt API version. The
305  * driver specifies which APIs it supports (with @ucode_api_max being the
306  * highest and @ucode_api_min the lowest). Firmware will only be loaded if
307  * it has a supported API version.
308  *
309  * The ideal usage of this infrastructure is to treat a new ucode API
310  * release as a new hardware revision.
311  */
312 struct iwl_cfg {
313         /* params specific to an individual device within a device family */
314         const char *name;
315         const char *fw_name_pre;
316         const unsigned int ucode_api_max;
317         const unsigned int ucode_api_ok;
318         const unsigned int ucode_api_min;
319         const u32 max_data_size;
320         const u32 max_inst_size;
321         u8   valid_tx_ant;
322         u8   valid_rx_ant;
323         u16  eeprom_ver;
324         u16  eeprom_calib_ver;
325         const struct iwl_lib_ops *lib;
326         void (*additional_nic_config)(struct iwl_priv *priv);
327         /* params not likely to change within a device family */
328         struct iwl_base_params *base_params;
329         /* params likely to change within a device family */
330         struct iwl_ht_params *ht_params;
331         struct iwl_bt_params *bt_params;
332         enum iwl_pa_type pa_type;         /* if used set to IWL_PA_SYSTEM */
333         const bool need_temp_offset_calib; /* if used set to true */
334         const bool no_xtal_calib;
335         u8 scan_rx_antennas[IEEE80211_NUM_BANDS];
336         enum iwl_led_mode led_mode;
337         const bool adv_pm;
338         const bool rx_with_siso_diversity;
339         const bool internal_wimax_coex;
340         const bool iq_invert;
341         const bool temp_offset_v2;
342 };
343
344 /**
345  * struct iwl_shared - shared fields for all the layers of the driver
346  *
347  * @ucode_owner: IWL_OWNERSHIP_*
348  * @cmd_queue: command queue number
349  * @status: STATUS_*
350  * @wowlan: are we running wowlan uCode
351  * @valid_contexts: microcode/device supports multiple contexts
352  * @bus: pointer to the bus layer data
353  * @cfg: see struct iwl_cfg
354  * @priv: pointer to the upper layer data
355  * @trans: pointer to the transport layer data
356  * @nic: pointer to the nic data
357  * @hw_params: see struct iwl_hw_params
358  * @lock: protect general shared data
359  * @mutex:
360  * @wait_command_queue: the wait_queue for SYNC host command nad uCode load
361  * @eeprom: pointer to the eeprom/OTP image
362  * @ucode_type: indicator of loaded ucode image
363  * @notif_waits: things waiting for notification
364  * @notif_wait_lock: lock protecting notification
365  * @notif_waitq: head of notification wait queue
366  * @device_pointers: pointers to ucode event tables
367  */
368 struct iwl_shared {
369 #define IWL_OWNERSHIP_DRIVER    0
370 #define IWL_OWNERSHIP_TM        1
371         u8 ucode_owner;
372         u8 cmd_queue;
373         unsigned long status;
374         u8 valid_contexts;
375
376         const struct iwl_cfg *cfg;
377         struct iwl_priv *priv;
378         struct iwl_trans *trans;
379         struct iwl_nic *nic;
380         struct iwl_hw_params hw_params;
381
382         struct mutex mutex;
383
384         wait_queue_head_t wait_command_queue;
385
386         /* eeprom -- this is in the card's little endian byte order */
387         u8 *eeprom;
388
389         /* ucode related variables */
390         enum iwl_ucode_type ucode_type;
391
392         /* notification wait support */
393         struct list_head notif_waits;
394         spinlock_t notif_wait_lock;
395         wait_queue_head_t notif_waitq;
396
397         struct {
398                 u32 error_event_table;
399                 u32 log_event_table;
400         } device_pointers;
401
402 };
403
404 /*Whatever _m is (iwl_trans, iwl_priv, these macros will work */
405 #define priv(_m)        ((_m)->shrd->priv)
406 #define cfg(_m)         ((_m)->shrd->cfg)
407 #define nic(_m)         ((_m)->shrd->nic)
408 #define trans(_m)       ((_m)->shrd->trans)
409 #define hw_params(_m)   ((_m)->shrd->hw_params)
410
411 static inline bool iwl_have_debug_level(u32 level)
412 {
413         return iwlagn_mod_params.debug_level & level;
414 }
415
416 /**
417  * iwl_queue_inc_wrap - increment queue index, wrap back to beginning
418  * @index -- current index
419  * @n_bd -- total number of entries in queue (must be power of 2)
420  */
421 static inline int iwl_queue_inc_wrap(int index, int n_bd)
422 {
423         return ++index & (n_bd - 1);
424 }
425
426 /**
427  * iwl_queue_dec_wrap - decrement queue index, wrap back to end
428  * @index -- current index
429  * @n_bd -- total number of entries in queue (must be power of 2)
430  */
431 static inline int iwl_queue_dec_wrap(int index, int n_bd)
432 {
433         return --index & (n_bd - 1);
434 }
435
436 struct iwl_rx_cmd_buffer {
437         struct page *_page;
438 };
439
440 static inline void *rxb_addr(struct iwl_rx_cmd_buffer *r)
441 {
442         return page_address(r->_page);
443 }
444
445 static inline struct page *rxb_steal_page(struct iwl_rx_cmd_buffer *r)
446 {
447         struct page *p = r->_page;
448         r->_page = NULL;
449         return p;
450 }
451
452 /*
453  * mac80211 queues, ACs, hardware queues, FIFOs.
454  *
455  * Cf. http://wireless.kernel.org/en/developers/Documentation/mac80211/queues
456  *
457  * Mac80211 uses the following numbers, which we get as from it
458  * by way of skb_get_queue_mapping(skb):
459  *
460  *      VO      0
461  *      VI      1
462  *      BE      2
463  *      BK      3
464  *
465  *
466  * Regular (not A-MPDU) frames are put into hardware queues corresponding
467  * to the FIFOs, see comments in iwl-prph.h. Aggregated frames get their
468  * own queue per aggregation session (RA/TID combination), such queues are
469  * set up to map into FIFOs too, for which we need an AC->FIFO mapping. In
470  * order to map frames to the right queue, we also need an AC->hw queue
471  * mapping. This is implemented here.
472  *
473  * Due to the way hw queues are set up (by the hw specific modules like
474  * iwl-4965.c, iwl-5000.c etc.), the AC->hw queue mapping is the identity
475  * mapping.
476  */
477
478 static const u8 tid_to_ac[] = {
479         IEEE80211_AC_BE,
480         IEEE80211_AC_BK,
481         IEEE80211_AC_BK,
482         IEEE80211_AC_BE,
483         IEEE80211_AC_VI,
484         IEEE80211_AC_VI,
485         IEEE80211_AC_VO,
486         IEEE80211_AC_VO
487 };
488
489 static inline int get_ac_from_tid(u16 tid)
490 {
491         if (likely(tid < ARRAY_SIZE(tid_to_ac)))
492                 return tid_to_ac[tid];
493
494         /* no support for TIDs 8-15 yet */
495         return -EINVAL;
496 }
497
498 enum iwl_rxon_context_id {
499         IWL_RXON_CTX_BSS,
500         IWL_RXON_CTX_PAN,
501
502         NUM_IWL_RXON_CTX
503 };
504
505 int iwlagn_hw_valid_rtc_data_addr(u32 addr);
506 void iwl_nic_config(struct iwl_priv *priv);
507 const char *get_cmd_string(u8 cmd);
508 bool iwl_check_for_ct_kill(struct iwl_priv *priv);
509
510
511 /* notification wait support */
512 void iwl_abort_notification_waits(struct iwl_shared *shrd);
513 void __acquires(wait_entry)
514 iwl_init_notification_wait(struct iwl_shared *shrd,
515                               struct iwl_notification_wait *wait_entry,
516                               u8 cmd,
517                               void (*fn)(struct iwl_trans *trans,
518                                          struct iwl_rx_packet *pkt,
519                                          void *data),
520                               void *fn_data);
521 int __must_check __releases(wait_entry)
522 iwl_wait_notification(struct iwl_shared *shrd,
523                          struct iwl_notification_wait *wait_entry,
524                          unsigned long timeout);
525 void __releases(wait_entry)
526 iwl_remove_notification(struct iwl_shared *shrd,
527                            struct iwl_notification_wait *wait_entry);
528
529 #define IWL_CMD(x) case x: return #x
530 #define IWL_MASK(lo, hi) ((1 << (hi)) | ((1 << (hi)) - (1 << (lo))))
531
532 #define IWL_TRAFFIC_ENTRIES     (256)
533 #define IWL_TRAFFIC_ENTRY_SIZE  (64)
534
535 /*****************************************************
536 * DRIVER STATUS FUNCTIONS
537 ******************************************************/
538 #define STATUS_HCMD_ACTIVE      0       /* host command in progress */
539 /* 1 is unused (used to be STATUS_HCMD_SYNC_ACTIVE) */
540 #define STATUS_INT_ENABLED      2
541 #define STATUS_RF_KILL_HW       3
542 #define STATUS_CT_KILL          4
543 #define STATUS_INIT             5
544 #define STATUS_ALIVE            6
545 #define STATUS_READY            7
546 #define STATUS_TEMPERATURE      8
547 #define STATUS_GEO_CONFIGURED   9
548 #define STATUS_EXIT_PENDING     10
549 #define STATUS_STATISTICS       12
550 #define STATUS_SCANNING         13
551 #define STATUS_SCAN_ABORTING    14
552 #define STATUS_SCAN_HW          15
553 #define STATUS_POWER_PMI        16
554 #define STATUS_FW_ERROR         17
555 #define STATUS_DEVICE_ENABLED   18
556 #define STATUS_CHANNEL_SWITCH_PENDING 19
557 #define STATUS_SCAN_COMPLETE    20
558
559 static inline int iwl_is_ready(struct iwl_shared *shrd)
560 {
561         /* The adapter is 'ready' if READY and GEO_CONFIGURED bits are
562          * set but EXIT_PENDING is not */
563         return test_bit(STATUS_READY, &shrd->status) &&
564                test_bit(STATUS_GEO_CONFIGURED, &shrd->status) &&
565                !test_bit(STATUS_EXIT_PENDING, &shrd->status);
566 }
567
568 static inline int iwl_is_alive(struct iwl_shared *shrd)
569 {
570         return test_bit(STATUS_ALIVE, &shrd->status);
571 }
572
573 static inline int iwl_is_init(struct iwl_shared *shrd)
574 {
575         return test_bit(STATUS_INIT, &shrd->status);
576 }
577
578 static inline int iwl_is_rfkill_hw(struct iwl_shared *shrd)
579 {
580         return test_bit(STATUS_RF_KILL_HW, &shrd->status);
581 }
582
583 static inline int iwl_is_rfkill(struct iwl_shared *shrd)
584 {
585         return iwl_is_rfkill_hw(shrd);
586 }
587
588 static inline int iwl_is_ctkill(struct iwl_shared *shrd)
589 {
590         return test_bit(STATUS_CT_KILL, &shrd->status);
591 }
592
593 static inline int iwl_is_ready_rf(struct iwl_shared *shrd)
594 {
595         if (iwl_is_rfkill(shrd))
596                 return 0;
597
598         return iwl_is_ready(shrd);
599 }
600
601 #endif /* #__iwl_shared_h__ */