iwlwifi: remove per-device debug level
[deliverable/linux.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 * @sku: sku information from EEPROM
286 * @eeprom_ver: EEPROM version
287 * @eeprom_calib_ver: EEPROM calibration version
288 * @lib: pointer to the lib ops
289 * @additional_nic_config: additional nic configuration
290 * @base_params: pointer to basic parameters
291 * @ht_params: point to ht patameters
292 * @bt_params: pointer to bt parameters
293 * @pa_type: used by 6000 series only to identify the type of Power Amplifier
294 * @need_temp_offset_calib: need to perform temperature offset calibration
295 * @no_xtal_calib: some devices do not need crystal calibration data,
296 * don't send it to those
297 * @scan_rx_antennas: available antenna for scan operation
298 * @led_mode: 0=blinking, 1=On(RF On)/Off(RF Off)
299 * @adv_pm: advance power management
300 * @rx_with_siso_diversity: 1x1 device with rx antenna diversity
301 * @internal_wimax_coex: internal wifi/wimax combo device
302 * @iq_invert: I/Q inversion
303 * @temp_offset_v2: support v2 of temperature offset calibration
304 *
305 * We enable the driver to be backward compatible wrt API version. The
306 * driver specifies which APIs it supports (with @ucode_api_max being the
307 * highest and @ucode_api_min the lowest). Firmware will only be loaded if
308 * it has a supported API version.
309 *
310 * The ideal usage of this infrastructure is to treat a new ucode API
311 * release as a new hardware revision.
312 */
313 struct iwl_cfg {
314 /* params specific to an individual device within a device family */
315 const char *name;
316 const char *fw_name_pre;
317 const unsigned int ucode_api_max;
318 const unsigned int ucode_api_ok;
319 const unsigned int ucode_api_min;
320 const u32 max_data_size;
321 const u32 max_inst_size;
322 u8 valid_tx_ant;
323 u8 valid_rx_ant;
324 u16 sku;
325 u16 eeprom_ver;
326 u16 eeprom_calib_ver;
327 const struct iwl_lib_ops *lib;
328 void (*additional_nic_config)(struct iwl_priv *priv);
329 /* params not likely to change within a device family */
330 struct iwl_base_params *base_params;
331 /* params likely to change within a device family */
332 struct iwl_ht_params *ht_params;
333 struct iwl_bt_params *bt_params;
334 enum iwl_pa_type pa_type; /* if used set to IWL_PA_SYSTEM */
335 const bool need_temp_offset_calib; /* if used set to true */
336 const bool no_xtal_calib;
337 u8 scan_rx_antennas[IEEE80211_NUM_BANDS];
338 enum iwl_led_mode led_mode;
339 const bool adv_pm;
340 const bool rx_with_siso_diversity;
341 const bool internal_wimax_coex;
342 const bool iq_invert;
343 const bool temp_offset_v2;
344 };
345
346 /**
347 * struct iwl_shared - shared fields for all the layers of the driver
348 *
349 * @ucode_owner: IWL_OWNERSHIP_*
350 * @cmd_queue: command queue number
351 * @status: STATUS_*
352 * @wowlan: are we running wowlan uCode
353 * @valid_contexts: microcode/device supports multiple contexts
354 * @bus: pointer to the bus layer data
355 * @cfg: see struct iwl_cfg
356 * @priv: pointer to the upper layer data
357 * @trans: pointer to the transport layer data
358 * @nic: pointer to the nic data
359 * @hw_params: see struct iwl_hw_params
360 * @lock: protect general shared data
361 * @mutex:
362 * @wait_command_queue: the wait_queue for SYNC host command nad uCode load
363 * @eeprom: pointer to the eeprom/OTP image
364 * @ucode_type: indicator of loaded ucode image
365 * @notif_waits: things waiting for notification
366 * @notif_wait_lock: lock protecting notification
367 * @notif_waitq: head of notification wait queue
368 * @device_pointers: pointers to ucode event tables
369 */
370 struct iwl_shared {
371 #define IWL_OWNERSHIP_DRIVER 0
372 #define IWL_OWNERSHIP_TM 1
373 u8 ucode_owner;
374 u8 cmd_queue;
375 unsigned long status;
376 bool wowlan;
377 u8 valid_contexts;
378
379 struct iwl_cfg *cfg;
380 struct iwl_priv *priv;
381 struct iwl_trans *trans;
382 struct iwl_nic *nic;
383 struct iwl_hw_params hw_params;
384
385 struct mutex mutex;
386
387 wait_queue_head_t wait_command_queue;
388
389 /* eeprom -- this is in the card's little endian byte order */
390 u8 *eeprom;
391
392 /* ucode related variables */
393 enum iwl_ucode_type ucode_type;
394
395 /* notification wait support */
396 struct list_head notif_waits;
397 spinlock_t notif_wait_lock;
398 wait_queue_head_t notif_waitq;
399
400 struct {
401 u32 error_event_table;
402 u32 log_event_table;
403 } device_pointers;
404
405 };
406
407 /*Whatever _m is (iwl_trans, iwl_priv, these macros will work */
408 #define priv(_m) ((_m)->shrd->priv)
409 #define cfg(_m) ((_m)->shrd->cfg)
410 #define nic(_m) ((_m)->shrd->nic)
411 #define trans(_m) ((_m)->shrd->trans)
412 #define hw_params(_m) ((_m)->shrd->hw_params)
413
414 static inline bool iwl_have_debug_level(u32 level)
415 {
416 return iwlagn_mod_params.debug_level & level;
417 }
418
419 static inline void iwl_free_pages(struct iwl_shared *shrd, unsigned long page)
420 {
421 free_pages(page, shrd->hw_params.rx_page_order);
422 }
423
424 /**
425 * iwl_queue_inc_wrap - increment queue index, wrap back to beginning
426 * @index -- current index
427 * @n_bd -- total number of entries in queue (must be power of 2)
428 */
429 static inline int iwl_queue_inc_wrap(int index, int n_bd)
430 {
431 return ++index & (n_bd - 1);
432 }
433
434 /**
435 * iwl_queue_dec_wrap - decrement queue index, wrap back to end
436 * @index -- current index
437 * @n_bd -- total number of entries in queue (must be power of 2)
438 */
439 static inline int iwl_queue_dec_wrap(int index, int n_bd)
440 {
441 return --index & (n_bd - 1);
442 }
443
444 struct iwl_rx_mem_buffer {
445 dma_addr_t page_dma;
446 struct page *page;
447 struct list_head list;
448 };
449
450 #define rxb_addr(r) page_address(r->page)
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__ */
This page took 0.04648 seconds and 5 git commands to generate.