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/gfp.h>
69 #include <net/mac80211.h>
71 #include "iwl-commands.h"
75 * DOC: shared area - role and goal
77 * The shared area contains all the data exported by the upper layer to the
78 * other layers. Since the bus and transport layer shouldn't dereference
79 * iwl_priv, all the data needed by the upper layer and the transport / bus
81 * The shared area also holds pointer to all the other layers. This allows a
82 * layer to call a function from another layer.
84 * NOTE: All the layers hold a pointer to the shared area which must be shrd.
85 * A few macros assume that (_m)->shrd points to the shared area no matter
88 * gets notifications about enumeration, suspend, resume.
89 * For the moment, the bus layer is not a linux kernel module as itself, and
90 * the module_init function of the driver must call the bus specific
91 * registration functions. These functions are listed at the end of this file.
92 * For the moment, there is only one implementation of this interface: PCI-e.
93 * This implementation is iwl-pci.c
98 struct iwl_sensitivity_ranges
;
101 #define DRV_NAME "iwlwifi"
102 #define IWLWIFI_VERSION "in-tree:"
103 #define DRV_COPYRIGHT "Copyright(c) 2003-2012 Intel Corporation"
104 #define DRV_AUTHOR "<ilw@linux.intel.com>"
106 extern struct iwl_mod_params iwlagn_mod_params
;
108 #define IWL_DISABLE_HT_ALL BIT(0)
109 #define IWL_DISABLE_HT_TXAGG BIT(1)
110 #define IWL_DISABLE_HT_RXAGG BIT(2)
113 * struct iwl_mod_params
115 * Holds the module parameters
117 * @sw_crypto: using hardware encryption, default = 0
118 * @disable_11n: disable 11n capabilities, default = 0,
119 * use IWL_DISABLE_HT_* constants
120 * @amsdu_size_8K: enable 8K amsdu size, default = 1
121 * @antenna: both antennas (use diversity), default = 0
122 * @restart_fw: restart firmware, default = 1
123 * @plcp_check: enable plcp health check, default = true
124 * @ack_check: disable ack health check, default = false
125 * @wd_disable: enable stuck queue check, default = 0
126 * @bt_coex_active: enable bt coex, default = true
127 * @led_mode: system default, default = 0
128 * @no_sleep_autoadjust: disable autoadjust, default = true
129 * @power_save: disable power save, default = false
130 * @power_level: power level, default = 1
131 * @debug_level: levels are IWL_DL_*
132 * @ant_coupling: antenna coupling in dB, default = 0
133 * @bt_ch_announce: BT channel inhibition, default = enable
134 * @wanted_ucode_alternative: ucode alternative to use, default = 1
135 * @auto_agg: enable agg. without check, default = true
137 struct iwl_mod_params
{
139 unsigned int disable_11n
;
148 bool no_sleep_autoadjust
;
154 int wanted_ucode_alternative
;
159 * struct iwl_hw_params
161 * Holds the module parameters
163 * @max_txq_num: Max # Tx queues supported
164 * @num_ampdu_queues: num of ampdu queues
165 * @tx_chains_num: Number of TX chains
166 * @rx_chains_num: Number of RX chains
167 * @valid_tx_ant: usable antennas for TX
168 * @valid_rx_ant: usable antennas for RX
169 * @ht40_channel: is 40MHz width possible: BIT(IEEE80211_BAND_XXX)
170 * @sku: sku read from EEPROM
171 * @rx_page_order: Rx buffer page order
172 * @ct_kill_threshold: temperature threshold - in hw dependent unit
173 * @ct_kill_exit_threshold: when to reeable the device - in hw dependent unit
174 * relevant for 1000, 6000 and up
175 * @wd_timeout: TX queues watchdog timeout
176 * @struct iwl_sensitivity_ranges: range of sensitivity values
178 struct iwl_hw_params
{
188 u32 ct_kill_threshold
;
189 u32 ct_kill_exit_threshold
;
190 unsigned int wd_timeout
;
192 const struct iwl_sensitivity_ranges
*sens
;
196 * enum iwl_ucode_type
198 * The type of ucode currently loaded on the hardware.
200 * @IWL_UCODE_NONE: No ucode loaded
201 * @IWL_UCODE_REGULAR: Normal runtime ucode
202 * @IWL_UCODE_INIT: Initial ucode
203 * @IWL_UCODE_WOWLAN: Wake on Wireless enabled ucode
205 enum iwl_ucode_type
{
213 * struct iwl_notification_wait - notification wait entry
214 * @list: list head for global list
215 * @fn: function called with the notification
218 * This structure is not used directly, to wait for a
219 * notification declare it on the stack, and call
220 * iwlagn_init_notification_wait() with appropriate
221 * parameters. Then do whatever will cause the ucode
222 * to notify the driver, and to wait for that then
223 * call iwlagn_wait_notification().
225 * Each notification is one-shot. If at some point we
226 * need to support multi-shot notifications (which
227 * can't be allocated on the stack) we need to modify
230 struct iwl_notification_wait
{
231 struct list_head list
;
233 void (*fn
)(struct iwl_priv
*priv
, struct iwl_rx_packet
*pkt
,
238 bool triggered
, aborted
;
242 * enum iwl_pa_type - Power Amplifier type
243 * @IWL_PA_SYSTEM: based on uCode configuration
244 * @IWL_PA_INTERNAL: use Internal only
253 * IWL_LED_DEFAULT: use device default
254 * IWL_LED_RF_STATE: turn LED on/off based on RF state
257 * IWL_LED_BLINK: adjust led blink rate based on blink table
258 * IWL_LED_DISABLE: led disabled
268 * @max_ll_items: max number of OTP blocks
269 * @shadow_ram_support: shadow support for OTP memory
270 * @led_compensation: compensate on the led on/off time per HW according
271 * to the deviation to achieve the desired led frequency.
272 * The detail algorithm is described in iwl-led.c
273 * @chain_noise_num_beacons: number of beacons used to compute chain noise
274 * @adv_thermal_throttle: support advance thermal throttle
275 * @support_ct_kill_exit: support ct kill exit condition
276 * @support_wimax_coexist: support wimax/wifi co-exist
277 * @plcp_delta_threshold: plcp error rate threshold used to trigger
278 * radio tuning when there is a high receiving plcp error rate
279 * @chain_noise_scale: default chain noise scale used for gain computation
280 * @wd_timeout: TX queues watchdog timeout
281 * @max_event_log_size: size of event log buffer size for ucode event logging
282 * @shadow_reg_enable: HW shadhow register bit
283 * @hd_v2: v2 of enhanced sensitivity value, used for 2000 series and up
284 * @no_idle_support: do not support idle mode
285 * wd_disable: disable watchdog timer
287 struct iwl_base_params
{
289 int num_of_queues
; /* def: HW dependent */
290 int num_of_ampdu_queues
;/* def: HW dependent */
291 /* for iwl_apm_init() */
294 const u16 max_ll_items
;
295 const bool shadow_ram_support
;
296 u16 led_compensation
;
297 bool adv_thermal_throttle
;
298 bool support_ct_kill_exit
;
299 const bool support_wimax_coexist
;
300 u8 plcp_delta_threshold
;
301 s32 chain_noise_scale
;
302 unsigned int wd_timeout
;
303 u32 max_event_log_size
;
304 const bool shadow_reg_enable
;
306 const bool no_idle_support
;
307 const bool wd_disable
;
312 * @name: Offical name of the device
313 * @fw_name_pre: Firmware filename prefix. The api version and extension
314 * (.ucode) will be added to filename before loading from disk. The
315 * filename is constructed as fw_name_pre<api>.ucode.
316 * @ucode_api_max: Highest version of uCode API supported by driver.
317 * @ucode_api_ok: oldest version of the uCode API that is OK to load
318 * without a warning, for use in transitions
319 * @ucode_api_min: Lowest version of uCode API supported by driver.
320 * @max_inst_size: The maximal length of the fw inst section
321 * @max_data_size: The maximal length of the fw data section
322 * @valid_tx_ant: valid transmit antenna
323 * @valid_rx_ant: valid receive antenna
324 * @eeprom_ver: EEPROM version
325 * @eeprom_calib_ver: EEPROM calibration version
326 * @lib: pointer to the lib ops
327 * @additional_nic_config: additional nic configuration
328 * @base_params: pointer to basic parameters
329 * @ht_params: point to ht patameters
330 * @bt_params: pointer to bt parameters
331 * @pa_type: used by 6000 series only to identify the type of Power Amplifier
332 * @need_temp_offset_calib: need to perform temperature offset calibration
333 * @no_xtal_calib: some devices do not need crystal calibration data,
334 * don't send it to those
335 * @scan_rx_antennas: available antenna for scan operation
336 * @led_mode: 0=blinking, 1=On(RF On)/Off(RF Off)
337 * @adv_pm: advance power management
338 * @rx_with_siso_diversity: 1x1 device with rx antenna diversity
339 * @internal_wimax_coex: internal wifi/wimax combo device
340 * @iq_invert: I/Q inversion
341 * @temp_offset_v2: support v2 of temperature offset calibration
343 * We enable the driver to be backward compatible wrt API version. The
344 * driver specifies which APIs it supports (with @ucode_api_max being the
345 * highest and @ucode_api_min the lowest). Firmware will only be loaded if
346 * it has a supported API version.
348 * The ideal usage of this infrastructure is to treat a new ucode API
349 * release as a new hardware revision.
352 /* params specific to an individual device within a device family */
354 const char *fw_name_pre
;
355 const unsigned int ucode_api_max
;
356 const unsigned int ucode_api_ok
;
357 const unsigned int ucode_api_min
;
358 const u32 max_data_size
;
359 const u32 max_inst_size
;
363 u16 eeprom_calib_ver
;
364 const struct iwl_lib_ops
*lib
;
365 void (*additional_nic_config
)(struct iwl_priv
*priv
);
366 /* params not likely to change within a device family */
367 struct iwl_base_params
*base_params
;
368 /* params likely to change within a device family */
369 struct iwl_ht_params
*ht_params
;
370 struct iwl_bt_params
*bt_params
;
371 enum iwl_pa_type pa_type
; /* if used set to IWL_PA_SYSTEM */
372 const bool need_temp_offset_calib
; /* if used set to true */
373 const bool no_xtal_calib
;
374 u8 scan_rx_antennas
[IEEE80211_NUM_BANDS
];
375 enum iwl_led_mode led_mode
;
377 const bool rx_with_siso_diversity
;
378 const bool internal_wimax_coex
;
379 const bool iq_invert
;
380 const bool temp_offset_v2
;
384 * struct iwl_shared - shared fields for all the layers of the driver
386 * @ucode_owner: IWL_OWNERSHIP_*
387 * @cmd_queue: command queue number
389 * @wowlan: are we running wowlan uCode
390 * @valid_contexts: microcode/device supports multiple contexts
391 * @bus: pointer to the bus layer data
392 * @cfg: see struct iwl_cfg
393 * @priv: pointer to the upper layer data
394 * @trans: pointer to the transport layer data
395 * @nic: pointer to the nic data
396 * @hw_params: see struct iwl_hw_params
397 * @lock: protect general shared data
398 * @wait_command_queue: the wait_queue for SYNC host command nad uCode load
399 * @eeprom: pointer to the eeprom/OTP image
400 * @ucode_type: indicator of loaded ucode image
401 * @notif_waits: things waiting for notification
402 * @notif_wait_lock: lock protecting notification
403 * @notif_waitq: head of notification wait queue
404 * @device_pointers: pointers to ucode event tables
407 #define IWL_OWNERSHIP_DRIVER 0
408 #define IWL_OWNERSHIP_TM 1
411 unsigned long status
;
414 const struct iwl_cfg
*cfg
;
415 struct iwl_priv
*priv
;
416 struct iwl_trans
*trans
;
418 struct iwl_hw_params hw_params
;
419 const struct iwl_fw
*fw
;
421 wait_queue_head_t wait_command_queue
;
423 /* eeprom -- this is in the card's little endian byte order */
426 /* ucode related variables */
427 enum iwl_ucode_type ucode_type
;
429 /* notification wait support */
430 struct list_head notif_waits
;
431 spinlock_t notif_wait_lock
;
432 wait_queue_head_t notif_waitq
;
435 u32 error_event_table
;
441 /*Whatever _m is (iwl_trans, iwl_priv, these macros will work */
442 #define priv(_m) ((_m)->shrd->priv)
443 #define cfg(_m) ((_m)->shrd->cfg)
444 #define trans(_m) ((_m)->shrd->trans)
445 #define hw_params(_m) ((_m)->shrd->hw_params)
447 static inline bool iwl_have_debug_level(u32 level
)
449 return iwlagn_mod_params
.debug_level
& level
;
452 enum iwl_rxon_context_id
{
459 int iwlagn_hw_valid_rtc_data_addr(u32 addr
);
460 void iwl_nic_config(struct iwl_priv
*priv
);
461 const char *get_cmd_string(u8 cmd
);
463 /* notification wait support */
464 void iwl_abort_notification_waits(struct iwl_shared
*shrd
);
465 void __acquires(wait_entry
)
466 iwl_init_notification_wait(struct iwl_shared
*shrd
,
467 struct iwl_notification_wait
*wait_entry
,
469 void (*fn
)(struct iwl_priv
*priv
,
470 struct iwl_rx_packet
*pkt
,
473 int __must_check
__releases(wait_entry
)
474 iwl_wait_notification(struct iwl_shared
*shrd
,
475 struct iwl_notification_wait
*wait_entry
,
476 unsigned long timeout
);
477 void __releases(wait_entry
)
478 iwl_remove_notification(struct iwl_shared
*shrd
,
479 struct iwl_notification_wait
*wait_entry
);
481 #define IWL_CMD(x) case x: return #x
483 /*****************************************************
484 * DRIVER STATUS FUNCTIONS
485 ******************************************************/
486 #define STATUS_HCMD_ACTIVE 0 /* host command in progress */
487 /* 1 is unused (used to be STATUS_HCMD_SYNC_ACTIVE) */
488 #define STATUS_INT_ENABLED 2
489 #define STATUS_RF_KILL_HW 3
490 #define STATUS_CT_KILL 4
491 #define STATUS_INIT 5
492 #define STATUS_ALIVE 6
493 #define STATUS_READY 7
494 #define STATUS_TEMPERATURE 8
495 #define STATUS_GEO_CONFIGURED 9
496 #define STATUS_EXIT_PENDING 10
497 #define STATUS_STATISTICS 12
498 #define STATUS_SCANNING 13
499 #define STATUS_SCAN_ABORTING 14
500 #define STATUS_SCAN_HW 15
501 #define STATUS_POWER_PMI 16
502 #define STATUS_FW_ERROR 17
503 #define STATUS_DEVICE_ENABLED 18
504 #define STATUS_CHANNEL_SWITCH_PENDING 19
505 #define STATUS_SCAN_COMPLETE 20
507 #endif /* #__iwl_shared_h__ */