1 /******************************************************************************
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.
8 * Copyright(c) 2007 - 2012 Intel Corporation. All rights reserved.
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.
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.
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,
24 * The full GNU General Public License is included in this distribution
25 * in the file called LICENSE.GPL.
27 * Contact Information:
28 * Intel Linux Wireless <ilw@linux.intel.com>
29 * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
33 * Copyright(c) 2005 - 2012 Intel Corporation. All rights reserved.
34 * All rights reserved.
36 * Redistribution and use in source and binary forms, with or without
37 * modification, are permitted provided that the following conditions
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
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.
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.
62 *****************************************************************************/
63 #ifndef __iwl_shared_h__
64 #define __iwl_shared_h__
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>
73 #include "iwl-commands.h"
76 * DOC: shared area - role and goal
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
82 * The shared area also holds pointer to all the other layers. This allows a
83 * layer to call a function from another layer.
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
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
99 struct iwl_sensitivity_ranges
;
100 struct iwl_trans_ops
;
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>"
107 extern struct iwl_mod_params iwlagn_mod_params
;
109 #define IWL_DISABLE_HT_ALL BIT(0)
110 #define IWL_DISABLE_HT_TXAGG BIT(1)
111 #define IWL_DISABLE_HT_RXAGG BIT(2)
114 * struct iwl_mod_params
116 * Holds the module parameters
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
139 struct iwl_mod_params
{
142 unsigned int disable_11n
;
151 bool no_sleep_autoadjust
;
157 int wanted_ucode_alternative
;
162 * struct iwl_hw_params
164 * Holds the module parameters
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
181 struct iwl_hw_params
{
189 bool shadow_reg_enable
;
192 u32 ct_kill_threshold
;
193 u32 ct_kill_exit_threshold
;
194 unsigned int wd_timeout
;
196 const struct iwl_sensitivity_ranges
*sens
;
200 * enum iwl_ucode_type
202 * The type of ucode currently loaded on the hardware.
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
209 enum iwl_ucode_type
{
217 * struct iwl_notification_wait - notification wait entry
218 * @list: list head for global list
219 * @fn: function called with the notification
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().
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
234 struct iwl_notification_wait
{
235 struct list_head list
;
237 void (*fn
)(struct iwl_trans
*trans
, struct iwl_rx_packet
*pkt
,
242 bool triggered
, aborted
;
246 * enum iwl_pa_type - Power Amplifier type
247 * @IWL_PA_SYSTEM: based on uCode configuration
248 * @IWL_PA_INTERNAL: use Internal only
257 * IWL_LED_DEFAULT: use device default
258 * IWL_LED_RF_STATE: turn LED on/off based on RF state
261 * IWL_LED_BLINK: adjust led blink rate based on blink table
262 * IWL_LED_DISABLE: led disabled
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
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.
310 * The ideal usage of this infrastructure is to treat a new ucode API
311 * release as a new hardware revision.
314 /* params specific to an individual device within a device family */
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
;
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
;
340 const bool rx_with_siso_diversity
;
341 const bool internal_wimax_coex
;
342 const bool iq_invert
;
343 const bool temp_offset_v2
;
347 * struct iwl_shared - shared fields for all the layers of the driver
349 * @dbg_level_dev: dbg level set per device. Prevails on
350 * iwlagn_mod_params.debug_level if set (!= 0)
351 * @ucode_owner: IWL_OWNERSHIP_*
352 * @cmd_queue: command queue number
354 * @wowlan: are we running wowlan uCode
355 * @valid_contexts: microcode/device supports multiple contexts
356 * @bus: pointer to the bus layer data
357 * @cfg: see struct iwl_cfg
358 * @priv: pointer to the upper layer data
359 * @trans: pointer to the transport layer data
360 * @nic: pointer to the nic data
361 * @hw_params: see struct iwl_hw_params
362 * @lock: protect general shared data
363 * @sta_lock: protects the station table.
364 * If lock and sta_lock are needed, lock must be acquired first.
366 * @wait_command_queue: the wait_queue for SYNC host command nad uCode load
367 * @eeprom: pointer to the eeprom/OTP image
368 * @ucode_type: indicator of loaded ucode image
369 * @notif_waits: things waiting for notification
370 * @notif_wait_lock: lock protecting notification
371 * @notif_waitq: head of notification wait queue
372 * @device_pointers: pointers to ucode event tables
375 #ifdef CONFIG_IWLWIFI_DEBUG
377 #endif /* CONFIG_IWLWIFI_DEBUG */
379 #define IWL_OWNERSHIP_DRIVER 0
380 #define IWL_OWNERSHIP_TM 1
383 unsigned long status
;
388 struct iwl_priv
*priv
;
389 struct iwl_trans
*trans
;
391 struct iwl_hw_params hw_params
;
397 wait_queue_head_t wait_command_queue
;
399 /* eeprom -- this is in the card's little endian byte order */
402 /* ucode related variables */
403 enum iwl_ucode_type ucode_type
;
405 /* notification wait support */
406 struct list_head notif_waits
;
407 spinlock_t notif_wait_lock
;
408 wait_queue_head_t notif_waitq
;
411 u32 error_event_table
;
417 /*Whatever _m is (iwl_trans, iwl_priv, these macros will work */
418 #define priv(_m) ((_m)->shrd->priv)
419 #define cfg(_m) ((_m)->shrd->cfg)
420 #define nic(_m) ((_m)->shrd->nic)
421 #define trans(_m) ((_m)->shrd->trans)
422 #define hw_params(_m) ((_m)->shrd->hw_params)
424 #ifdef CONFIG_IWLWIFI_DEBUG
426 * iwl_get_debug_level: Return active debug level for device
428 * Using sysfs it is possible to set per device debug level. This debug
429 * level will be used if set, otherwise the global debug level which can be
430 * set via module parameter is used.
432 static inline u32
iwl_get_debug_level(struct iwl_shared
*shrd
)
434 if (shrd
->dbg_level_dev
)
435 return shrd
->dbg_level_dev
;
437 return iwlagn_mod_params
.debug_level
;
440 static inline u32
iwl_get_debug_level(struct iwl_shared
*shrd
)
442 return iwlagn_mod_params
.debug_level
;
446 static inline void iwl_free_pages(struct iwl_shared
*shrd
, unsigned long page
)
448 free_pages(page
, shrd
->hw_params
.rx_page_order
);
452 * iwl_queue_inc_wrap - increment queue index, wrap back to beginning
453 * @index -- current index
454 * @n_bd -- total number of entries in queue (must be power of 2)
456 static inline int iwl_queue_inc_wrap(int index
, int n_bd
)
458 return ++index
& (n_bd
- 1);
462 * iwl_queue_dec_wrap - decrement queue index, wrap back to end
463 * @index -- current index
464 * @n_bd -- total number of entries in queue (must be power of 2)
466 static inline int iwl_queue_dec_wrap(int index
, int n_bd
)
468 return --index
& (n_bd
- 1);
471 struct iwl_rx_mem_buffer
{
474 struct list_head list
;
477 #define rxb_addr(r) page_address(r->page)
480 * mac80211 queues, ACs, hardware queues, FIFOs.
482 * Cf. http://wireless.kernel.org/en/developers/Documentation/mac80211/queues
484 * Mac80211 uses the following numbers, which we get as from it
485 * by way of skb_get_queue_mapping(skb):
493 * Regular (not A-MPDU) frames are put into hardware queues corresponding
494 * to the FIFOs, see comments in iwl-prph.h. Aggregated frames get their
495 * own queue per aggregation session (RA/TID combination), such queues are
496 * set up to map into FIFOs too, for which we need an AC->FIFO mapping. In
497 * order to map frames to the right queue, we also need an AC->hw queue
498 * mapping. This is implemented here.
500 * Due to the way hw queues are set up (by the hw specific modules like
501 * iwl-4965.c, iwl-5000.c etc.), the AC->hw queue mapping is the identity
505 static const u8 tid_to_ac
[] = {
516 static inline int get_ac_from_tid(u16 tid
)
518 if (likely(tid
< ARRAY_SIZE(tid_to_ac
)))
519 return tid_to_ac
[tid
];
521 /* no support for TIDs 8-15 yet */
525 enum iwl_rxon_context_id
{
532 int iwlagn_hw_valid_rtc_data_addr(u32 addr
);
533 void iwl_nic_config(struct iwl_priv
*priv
);
534 const char *get_cmd_string(u8 cmd
);
535 bool iwl_check_for_ct_kill(struct iwl_priv
*priv
);
538 /* notification wait support */
539 void iwl_abort_notification_waits(struct iwl_shared
*shrd
);
540 void __acquires(wait_entry
)
541 iwl_init_notification_wait(struct iwl_shared
*shrd
,
542 struct iwl_notification_wait
*wait_entry
,
544 void (*fn
)(struct iwl_trans
*trans
,
545 struct iwl_rx_packet
*pkt
,
548 int __must_check
__releases(wait_entry
)
549 iwl_wait_notification(struct iwl_shared
*shrd
,
550 struct iwl_notification_wait
*wait_entry
,
551 unsigned long timeout
);
552 void __releases(wait_entry
)
553 iwl_remove_notification(struct iwl_shared
*shrd
,
554 struct iwl_notification_wait
*wait_entry
);
556 #define IWL_CMD(x) case x: return #x
557 #define IWL_MASK(lo, hi) ((1 << (hi)) | ((1 << (hi)) - (1 << (lo))))
559 #define IWL_TRAFFIC_ENTRIES (256)
560 #define IWL_TRAFFIC_ENTRY_SIZE (64)
562 /*****************************************************
563 * DRIVER STATUS FUNCTIONS
564 ******************************************************/
565 #define STATUS_HCMD_ACTIVE 0 /* host command in progress */
566 /* 1 is unused (used to be STATUS_HCMD_SYNC_ACTIVE) */
567 #define STATUS_INT_ENABLED 2
568 #define STATUS_RF_KILL_HW 3
569 #define STATUS_CT_KILL 4
570 #define STATUS_INIT 5
571 #define STATUS_ALIVE 6
572 #define STATUS_READY 7
573 #define STATUS_TEMPERATURE 8
574 #define STATUS_GEO_CONFIGURED 9
575 #define STATUS_EXIT_PENDING 10
576 #define STATUS_STATISTICS 12
577 #define STATUS_SCANNING 13
578 #define STATUS_SCAN_ABORTING 14
579 #define STATUS_SCAN_HW 15
580 #define STATUS_POWER_PMI 16
581 #define STATUS_FW_ERROR 17
582 #define STATUS_DEVICE_ENABLED 18
583 #define STATUS_CHANNEL_SWITCH_PENDING 19
584 #define STATUS_SCAN_COMPLETE 20
586 static inline int iwl_is_ready(struct iwl_shared
*shrd
)
588 /* The adapter is 'ready' if READY and GEO_CONFIGURED bits are
589 * set but EXIT_PENDING is not */
590 return test_bit(STATUS_READY
, &shrd
->status
) &&
591 test_bit(STATUS_GEO_CONFIGURED
, &shrd
->status
) &&
592 !test_bit(STATUS_EXIT_PENDING
, &shrd
->status
);
595 static inline int iwl_is_alive(struct iwl_shared
*shrd
)
597 return test_bit(STATUS_ALIVE
, &shrd
->status
);
600 static inline int iwl_is_init(struct iwl_shared
*shrd
)
602 return test_bit(STATUS_INIT
, &shrd
->status
);
605 static inline int iwl_is_rfkill_hw(struct iwl_shared
*shrd
)
607 return test_bit(STATUS_RF_KILL_HW
, &shrd
->status
);
610 static inline int iwl_is_rfkill(struct iwl_shared
*shrd
)
612 return iwl_is_rfkill_hw(shrd
);
615 static inline int iwl_is_ctkill(struct iwl_shared
*shrd
)
617 return test_bit(STATUS_CT_KILL
, &shrd
->status
);
620 static inline int iwl_is_ready_rf(struct iwl_shared
*shrd
)
622 if (iwl_is_rfkill(shrd
))
625 return iwl_is_ready(shrd
);
628 #endif /* #__iwl_shared_h__ */