Merge branch 'wl12xx-next' into for-linville
[profile/ivi/kernel-adaptation-intel-automotive.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 - 2011 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 - 2011 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_cfg;
98 struct iwl_bus;
99 struct iwl_priv;
100 struct iwl_sensitivity_ranges;
101 struct iwl_trans_ops;
102
103 #define DRV_NAME        "iwlwifi"
104 #define IWLWIFI_VERSION "in-tree:"
105 #define DRV_COPYRIGHT   "Copyright(c) 2003-2011 Intel Corporation"
106 #define DRV_AUTHOR     "<ilw@linux.intel.com>"
107
108 extern struct iwl_mod_params iwlagn_mod_params;
109
110 /**
111  * struct iwl_mod_params
112  *
113  * Holds the module parameters
114  *
115  * @sw_crypto: using hardware encryption, default = 0
116  * @num_of_queues: number of tx queue, HW dependent
117  * @disable_11n: 11n capabilities enabled, default = 0
118  * @amsdu_size_8K: enable 8K amsdu size, default = 1
119  * @antenna: both antennas (use diversity), default = 0
120  * @restart_fw: restart firmware, default = 1
121  * @plcp_check: enable plcp health check, default = true
122  * @ack_check: disable ack health check, default = false
123  * @wd_disable: enable stuck queue check, default = 0
124  * @bt_coex_active: enable bt coex, default = true
125  * @led_mode: system default, default = 0
126  * @no_sleep_autoadjust: disable autoadjust, default = true
127  * @power_save: disable power save, default = false
128  * @power_level: power level, default = 1
129  * @debug_level: levels are IWL_DL_*
130  * @ant_coupling: antenna coupling in dB, default = 0
131  * @bt_ch_announce: BT channel inhibition, default = enable
132  * @wanted_ucode_alternative: ucode alternative to use, default = 1
133  * @auto_agg: enable agg. without check, default = true
134  */
135 struct iwl_mod_params {
136         int sw_crypto;
137         int num_of_queues;
138         int disable_11n;
139         int amsdu_size_8K;
140         int antenna;
141         int restart_fw;
142         bool plcp_check;
143         bool ack_check;
144         int  wd_disable;
145         bool bt_coex_active;
146         int led_mode;
147         bool no_sleep_autoadjust;
148         bool power_save;
149         int power_level;
150         u32 debug_level;
151         int ant_coupling;
152         bool bt_ch_announce;
153         int wanted_ucode_alternative;
154         bool auto_agg;
155 };
156
157 /**
158  * struct iwl_hw_params
159  *
160  * Holds the module parameters
161  *
162  * @max_txq_num: Max # Tx queues supported
163  * @num_ampdu_queues: num of ampdu queues
164  * @tx_chains_num: Number of TX chains
165  * @rx_chains_num: Number of RX chains
166  * @valid_tx_ant: usable antennas for TX
167  * @valid_rx_ant: usable antennas for RX
168  * @ht40_channel: is 40MHz width possible: BIT(IEEE80211_BAND_XXX)
169  * @sku: sku read from EEPROM
170  * @rx_page_order: Rx buffer page order
171  * @max_inst_size: for ucode use
172  * @max_data_size: for ucode use
173  * @ct_kill_threshold: temperature threshold - in hw dependent unit
174  * @ct_kill_exit_threshold: when to reeable the device - in hw dependent unit
175  *      relevant for 1000, 6000 and up
176  * @wd_timeout: TX queues watchdog timeout
177  * @calib_rt_cfg: setup runtime calibrations for the hw
178  * @struct iwl_sensitivity_ranges: range of sensitivity values
179  */
180 struct iwl_hw_params {
181         u8  max_txq_num;
182         u8  num_ampdu_queues;
183         u8  tx_chains_num;
184         u8  rx_chains_num;
185         u8  valid_tx_ant;
186         u8  valid_rx_ant;
187         u8  ht40_channel;
188         bool shadow_reg_enable;
189         u16 sku;
190         u32 rx_page_order;
191         u32 max_inst_size;
192         u32 max_data_size;
193         u32 ct_kill_threshold;
194         u32 ct_kill_exit_threshold;
195         unsigned int wd_timeout;
196
197         u32 calib_rt_cfg;
198         const struct iwl_sensitivity_ranges *sens;
199 };
200
201 /**
202  * enum iwl_agg_state
203  *
204  * The state machine of the BA agreement establishment / tear down.
205  * These states relate to a specific RA / TID.
206  *
207  * @IWL_AGG_OFF: aggregation is not used
208  * @IWL_AGG_ON: aggregation session is up
209  * @IWL_EMPTYING_HW_QUEUE_ADDBA: establishing a BA session - waiting for the
210  *      HW queue to be empty from packets for this RA /TID.
211  * @IWL_EMPTYING_HW_QUEUE_DELBA: tearing down a BA session - waiting for the
212  *      HW queue to be empty from packets for this RA /TID.
213  */
214 enum iwl_agg_state {
215         IWL_AGG_OFF = 0,
216         IWL_AGG_ON,
217         IWL_EMPTYING_HW_QUEUE_ADDBA,
218         IWL_EMPTYING_HW_QUEUE_DELBA,
219 };
220
221 /**
222  * struct iwl_ht_agg - aggregation state machine
223
224  * This structs holds the states for the BA agreement establishment and tear
225  * down. It also holds the state during the BA session itself. This struct is
226  * duplicated for each RA / TID.
227
228  * @rate_n_flags: Rate at which Tx was attempted. Holds the data between the
229  *      Tx response (REPLY_TX), and the block ack notification
230  *      (REPLY_COMPRESSED_BA).
231  * @state: state of the BA agreement establishment / tear down.
232  * @txq_id: Tx queue used by the BA session - used by the transport layer.
233  *      Needed by the upper layer for debugfs only.
234  * @wait_for_ba: Expect block-ack before next Tx reply
235  */
236 struct iwl_ht_agg {
237         u32 rate_n_flags;
238         enum iwl_agg_state state;
239         u16 txq_id;
240         bool wait_for_ba;
241 };
242
243 /**
244  * struct iwl_tid_data - one for each RA / TID
245
246  * This structs holds the states for each RA / TID.
247
248  * @seq_number: the next WiFi sequence number to use
249  * @tfds_in_queue: number of packets sent to the HW queues.
250  *      Exported for debugfs only
251  * @agg: aggregation state machine
252  */
253 struct iwl_tid_data {
254         u16 seq_number;
255         u16 tfds_in_queue;
256         struct iwl_ht_agg agg;
257 };
258
259 /**
260  * enum iwl_ucode_type
261  *
262  * The type of ucode currently loaded on the hardware.
263  *
264  * @IWL_UCODE_NONE: No ucode loaded
265  * @IWL_UCODE_REGULAR: Normal runtime ucode
266  * @IWL_UCODE_INIT: Initial ucode
267  * @IWL_UCODE_WOWLAN: Wake on Wireless enabled ucode
268  */
269 enum iwl_ucode_type {
270         IWL_UCODE_NONE,
271         IWL_UCODE_REGULAR,
272         IWL_UCODE_INIT,
273         IWL_UCODE_WOWLAN,
274 };
275
276 /**
277  * struct iwl_notification_wait - notification wait entry
278  * @list: list head for global list
279  * @fn: function called with the notification
280  * @cmd: command ID
281  *
282  * This structure is not used directly, to wait for a
283  * notification declare it on the stack, and call
284  * iwlagn_init_notification_wait() with appropriate
285  * parameters. Then do whatever will cause the ucode
286  * to notify the driver, and to wait for that then
287  * call iwlagn_wait_notification().
288  *
289  * Each notification is one-shot. If at some point we
290  * need to support multi-shot notifications (which
291  * can't be allocated on the stack) we need to modify
292  * the code for them.
293  */
294 struct iwl_notification_wait {
295         struct list_head list;
296
297         void (*fn)(struct iwl_priv *priv, struct iwl_rx_packet *pkt,
298                    void *data);
299         void *fn_data;
300
301         u8 cmd;
302         bool triggered, aborted;
303 };
304
305 /**
306  * struct iwl_shared - shared fields for all the layers of the driver
307  *
308  * @dbg_level_dev: dbg level set per device. Prevails on
309  *      iwlagn_mod_params.debug_level if set (!= 0)
310  * @ucode_owner: IWL_OWNERSHIP_*
311  * @cmd_queue: command queue number
312  * @status: STATUS_*
313  * @valid_contexts: microcode/device supports multiple contexts
314  * @bus: pointer to the bus layer data
315  * @priv: pointer to the upper layer data
316  * @hw_params: see struct iwl_hw_params
317  * @workqueue: the workqueue used by all the layers of the driver
318  * @lock: protect general shared data
319  * @sta_lock: protects the station table.
320  *      If lock and sta_lock are needed, lock must be acquired first.
321  * @mutex:
322  * @ucode_type: indicator of loaded ucode image
323  * @notif_waits: things waiting for notification
324  * @notif_wait_lock: lock protecting notification
325  * @notif_waitq: head of notification wait queue
326  */
327 struct iwl_shared {
328 #ifdef CONFIG_IWLWIFI_DEBUG
329         u32 dbg_level_dev;
330 #endif /* CONFIG_IWLWIFI_DEBUG */
331
332 #define IWL_OWNERSHIP_DRIVER    0
333 #define IWL_OWNERSHIP_TM        1
334         u8 ucode_owner;
335         u8 cmd_queue;
336         unsigned long status;
337         bool wowlan;
338         u8 valid_contexts;
339
340         struct iwl_bus *bus;
341         struct iwl_priv *priv;
342         struct iwl_trans *trans;
343         struct iwl_hw_params hw_params;
344
345         struct workqueue_struct *workqueue;
346         spinlock_t lock;
347         spinlock_t sta_lock;
348         struct mutex mutex;
349
350         struct iwl_tid_data tid_data[IWLAGN_STATION_COUNT][IWL_MAX_TID_COUNT];
351
352         wait_queue_head_t wait_command_queue;
353
354         /* ucode related variables */
355         enum iwl_ucode_type ucode_type;
356
357         /* notification wait support */
358         struct list_head notif_waits;
359         spinlock_t notif_wait_lock;
360         wait_queue_head_t notif_waitq;
361 };
362
363 /*Whatever _m is (iwl_trans, iwl_priv, iwl_bus, these macros will work */
364 #define priv(_m)        ((_m)->shrd->priv)
365 #define bus(_m)         ((_m)->shrd->bus)
366 #define trans(_m)       ((_m)->shrd->trans)
367 #define hw_params(_m)   ((_m)->shrd->hw_params)
368
369 #ifdef CONFIG_IWLWIFI_DEBUG
370 /*
371  * iwl_get_debug_level: Return active debug level for device
372  *
373  * Using sysfs it is possible to set per device debug level. This debug
374  * level will be used if set, otherwise the global debug level which can be
375  * set via module parameter is used.
376  */
377 static inline u32 iwl_get_debug_level(struct iwl_shared *shrd)
378 {
379         if (shrd->dbg_level_dev)
380                 return shrd->dbg_level_dev;
381         else
382                 return iwlagn_mod_params.debug_level;
383 }
384 #else
385 static inline u32 iwl_get_debug_level(struct iwl_shared *shrd)
386 {
387         return iwlagn_mod_params.debug_level;
388 }
389 #endif
390
391 static inline void iwl_free_pages(struct iwl_shared *shrd, unsigned long page)
392 {
393         free_pages(page, shrd->hw_params.rx_page_order);
394 }
395
396 /**
397  * iwl_queue_inc_wrap - increment queue index, wrap back to beginning
398  * @index -- current index
399  * @n_bd -- total number of entries in queue (must be power of 2)
400  */
401 static inline int iwl_queue_inc_wrap(int index, int n_bd)
402 {
403         return ++index & (n_bd - 1);
404 }
405
406 /**
407  * iwl_queue_dec_wrap - decrement queue index, wrap back to end
408  * @index -- current index
409  * @n_bd -- total number of entries in queue (must be power of 2)
410  */
411 static inline int iwl_queue_dec_wrap(int index, int n_bd)
412 {
413         return --index & (n_bd - 1);
414 }
415
416 struct iwl_rx_mem_buffer {
417         dma_addr_t page_dma;
418         struct page *page;
419         struct list_head list;
420 };
421
422 #define rxb_addr(r) page_address(r->page)
423
424 /*
425  * mac80211 queues, ACs, hardware queues, FIFOs.
426  *
427  * Cf. http://wireless.kernel.org/en/developers/Documentation/mac80211/queues
428  *
429  * Mac80211 uses the following numbers, which we get as from it
430  * by way of skb_get_queue_mapping(skb):
431  *
432  *      VO      0
433  *      VI      1
434  *      BE      2
435  *      BK      3
436  *
437  *
438  * Regular (not A-MPDU) frames are put into hardware queues corresponding
439  * to the FIFOs, see comments in iwl-prph.h. Aggregated frames get their
440  * own queue per aggregation session (RA/TID combination), such queues are
441  * set up to map into FIFOs too, for which we need an AC->FIFO mapping. In
442  * order to map frames to the right queue, we also need an AC->hw queue
443  * mapping. This is implemented here.
444  *
445  * Due to the way hw queues are set up (by the hw specific modules like
446  * iwl-4965.c, iwl-5000.c etc.), the AC->hw queue mapping is the identity
447  * mapping.
448  */
449
450 static const u8 tid_to_ac[] = {
451         IEEE80211_AC_BE,
452         IEEE80211_AC_BK,
453         IEEE80211_AC_BK,
454         IEEE80211_AC_BE,
455         IEEE80211_AC_VI,
456         IEEE80211_AC_VI,
457         IEEE80211_AC_VO,
458         IEEE80211_AC_VO
459 };
460
461 static inline int get_ac_from_tid(u16 tid)
462 {
463         if (likely(tid < ARRAY_SIZE(tid_to_ac)))
464                 return tid_to_ac[tid];
465
466         /* no support for TIDs 8-15 yet */
467         return -EINVAL;
468 }
469
470 enum iwl_rxon_context_id {
471         IWL_RXON_CTX_BSS,
472         IWL_RXON_CTX_PAN,
473
474         NUM_IWL_RXON_CTX
475 };
476
477 int iwl_probe(struct iwl_bus *bus, const struct iwl_trans_ops *trans_ops,
478                 struct iwl_cfg *cfg);
479 void __devexit iwl_remove(struct iwl_priv * priv);
480 struct iwl_device_cmd;
481 int __must_check iwl_rx_dispatch(struct iwl_priv *priv,
482                                  struct iwl_rx_mem_buffer *rxb,
483                                  struct iwl_device_cmd *cmd);
484
485 int iwlagn_hw_valid_rtc_data_addr(u32 addr);
486 void iwl_start_tx_ba_trans_ready(struct iwl_priv *priv,
487                                  enum iwl_rxon_context_id ctx,
488                                  u8 sta_id, u8 tid);
489 void iwl_stop_tx_ba_trans_ready(struct iwl_priv *priv,
490                                 enum iwl_rxon_context_id ctx,
491                                 u8 sta_id, u8 tid);
492 void iwl_set_hw_rfkill_state(struct iwl_priv *priv, bool state);
493 void iwl_nic_config(struct iwl_priv *priv);
494 void iwl_free_skb(struct iwl_priv *priv, struct sk_buff *skb);
495 void iwl_apm_stop(struct iwl_priv *priv);
496 int iwl_apm_init(struct iwl_priv *priv);
497 void iwlagn_fw_error(struct iwl_priv *priv, bool ondemand);
498 const char *get_cmd_string(u8 cmd);
499 bool iwl_check_for_ct_kill(struct iwl_priv *priv);
500
501 void iwl_stop_sw_queue(struct iwl_priv *priv, u8 ac);
502 void iwl_wake_sw_queue(struct iwl_priv *priv, u8 ac);
503
504 /* notification wait support */
505 void iwl_abort_notification_waits(struct iwl_shared *shrd);
506 void __acquires(wait_entry)
507 iwl_init_notification_wait(struct iwl_shared *shrd,
508                               struct iwl_notification_wait *wait_entry,
509                               u8 cmd,
510                               void (*fn)(struct iwl_priv *priv,
511                                          struct iwl_rx_packet *pkt,
512                                          void *data),
513                               void *fn_data);
514 int __must_check __releases(wait_entry)
515 iwl_wait_notification(struct iwl_shared *shrd,
516                          struct iwl_notification_wait *wait_entry,
517                          unsigned long timeout);
518 void __releases(wait_entry)
519 iwl_remove_notification(struct iwl_shared *shrd,
520                            struct iwl_notification_wait *wait_entry);
521
522 #ifdef CONFIG_IWLWIFI_DEBUGFS
523 void iwl_reset_traffic_log(struct iwl_priv *priv);
524 #endif /* CONFIG_IWLWIFI_DEBUGFS */
525
526 #ifdef CONFIG_IWLWIFI_DEBUG
527 void iwl_print_rx_config_cmd(struct iwl_priv *priv,
528                              enum iwl_rxon_context_id ctxid);
529 #else
530 static inline void iwl_print_rx_config_cmd(struct iwl_priv *priv,
531                                            enum iwl_rxon_context_id ctxid)
532 {
533 }
534 #endif
535
536 #define IWL_CMD(x) case x: return #x
537 #define IWL_MASK(lo, hi) ((1 << (hi)) | ((1 << (hi)) - (1 << (lo))))
538
539 #define IWL_TRAFFIC_ENTRIES     (256)
540 #define IWL_TRAFFIC_ENTRY_SIZE  (64)
541
542 /*****************************************************
543 * DRIVER STATUS FUNCTIONS
544 ******************************************************/
545 #define STATUS_HCMD_ACTIVE      0       /* host command in progress */
546 /* 1 is unused (used to be STATUS_HCMD_SYNC_ACTIVE) */
547 #define STATUS_INT_ENABLED      2
548 #define STATUS_RF_KILL_HW       3
549 #define STATUS_CT_KILL          4
550 #define STATUS_INIT             5
551 #define STATUS_ALIVE            6
552 #define STATUS_READY            7
553 #define STATUS_TEMPERATURE      8
554 #define STATUS_GEO_CONFIGURED   9
555 #define STATUS_EXIT_PENDING     10
556 #define STATUS_STATISTICS       12
557 #define STATUS_SCANNING         13
558 #define STATUS_SCAN_ABORTING    14
559 #define STATUS_SCAN_HW          15
560 #define STATUS_POWER_PMI        16
561 #define STATUS_FW_ERROR         17
562 #define STATUS_DEVICE_ENABLED   18
563 #define STATUS_CHANNEL_SWITCH_PENDING 19
564 #define STATUS_SCAN_COMPLETE    20
565
566 static inline int iwl_is_ready(struct iwl_shared *shrd)
567 {
568         /* The adapter is 'ready' if READY and GEO_CONFIGURED bits are
569          * set but EXIT_PENDING is not */
570         return test_bit(STATUS_READY, &shrd->status) &&
571                test_bit(STATUS_GEO_CONFIGURED, &shrd->status) &&
572                !test_bit(STATUS_EXIT_PENDING, &shrd->status);
573 }
574
575 static inline int iwl_is_alive(struct iwl_shared *shrd)
576 {
577         return test_bit(STATUS_ALIVE, &shrd->status);
578 }
579
580 static inline int iwl_is_init(struct iwl_shared *shrd)
581 {
582         return test_bit(STATUS_INIT, &shrd->status);
583 }
584
585 static inline int iwl_is_rfkill_hw(struct iwl_shared *shrd)
586 {
587         return test_bit(STATUS_RF_KILL_HW, &shrd->status);
588 }
589
590 static inline int iwl_is_rfkill(struct iwl_shared *shrd)
591 {
592         return iwl_is_rfkill_hw(shrd);
593 }
594
595 static inline int iwl_is_ctkill(struct iwl_shared *shrd)
596 {
597         return test_bit(STATUS_CT_KILL, &shrd->status);
598 }
599
600 static inline int iwl_is_ready_rf(struct iwl_shared *shrd)
601 {
602         if (iwl_is_rfkill(shrd))
603                 return 0;
604
605         return iwl_is_ready(shrd);
606 }
607
608 #endif /* #__iwl_shared_h__ */