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
177 * @use_rts_for_aggregation: use rts/cts protection for HT traffic
179 struct iwl_hw_params {
187 bool use_rts_for_aggregation;
190 u32 ct_kill_threshold;
191 u32 ct_kill_exit_threshold;
192 unsigned int wd_timeout;
194 const struct iwl_sensitivity_ranges *sens;
198 * enum iwl_ucode_type
200 * The type of ucode currently loaded on the hardware.
202 * @IWL_UCODE_NONE: No ucode loaded
203 * @IWL_UCODE_REGULAR: Normal runtime ucode
204 * @IWL_UCODE_INIT: Initial ucode
205 * @IWL_UCODE_WOWLAN: Wake on Wireless enabled ucode
207 enum iwl_ucode_type {
215 * enum iwl_pa_type - Power Amplifier type
216 * @IWL_PA_SYSTEM: based on uCode configuration
217 * @IWL_PA_INTERNAL: use Internal only
226 * IWL_LED_DEFAULT: use device default
227 * IWL_LED_RF_STATE: turn LED on/off based on RF state
230 * IWL_LED_BLINK: adjust led blink rate based on blink table
231 * IWL_LED_DISABLE: led disabled
241 * @max_ll_items: max number of OTP blocks
242 * @shadow_ram_support: shadow support for OTP memory
243 * @led_compensation: compensate on the led on/off time per HW according
244 * to the deviation to achieve the desired led frequency.
245 * The detail algorithm is described in iwl-led.c
246 * @chain_noise_num_beacons: number of beacons used to compute chain noise
247 * @adv_thermal_throttle: support advance thermal throttle
248 * @support_ct_kill_exit: support ct kill exit condition
249 * @support_wimax_coexist: support wimax/wifi co-exist
250 * @plcp_delta_threshold: plcp error rate threshold used to trigger
251 * radio tuning when there is a high receiving plcp error rate
252 * @chain_noise_scale: default chain noise scale used for gain computation
253 * @wd_timeout: TX queues watchdog timeout
254 * @max_event_log_size: size of event log buffer size for ucode event logging
255 * @shadow_reg_enable: HW shadhow register bit
256 * @hd_v2: v2 of enhanced sensitivity value, used for 2000 series and up
257 * @no_idle_support: do not support idle mode
258 * wd_disable: disable watchdog timer
260 struct iwl_base_params {
262 int num_of_queues; /* def: HW dependent */
263 int num_of_ampdu_queues;/* def: HW dependent */
264 /* for iwl_apm_init() */
267 const u16 max_ll_items;
268 const bool shadow_ram_support;
269 u16 led_compensation;
270 bool adv_thermal_throttle;
271 bool support_ct_kill_exit;
272 const bool support_wimax_coexist;
273 u8 plcp_delta_threshold;
274 s32 chain_noise_scale;
275 unsigned int wd_timeout;
276 u32 max_event_log_size;
277 const bool shadow_reg_enable;
279 const bool no_idle_support;
280 const bool wd_disable;
285 * @name: Offical name of the device
286 * @fw_name_pre: Firmware filename prefix. The api version and extension
287 * (.ucode) will be added to filename before loading from disk. The
288 * filename is constructed as fw_name_pre<api>.ucode.
289 * @ucode_api_max: Highest version of uCode API supported by driver.
290 * @ucode_api_ok: oldest version of the uCode API that is OK to load
291 * without a warning, for use in transitions
292 * @ucode_api_min: Lowest version of uCode API supported by driver.
293 * @max_inst_size: The maximal length of the fw inst section
294 * @max_data_size: The maximal length of the fw data section
295 * @valid_tx_ant: valid transmit antenna
296 * @valid_rx_ant: valid receive antenna
297 * @eeprom_ver: EEPROM version
298 * @eeprom_calib_ver: EEPROM calibration version
299 * @lib: pointer to the lib ops
300 * @additional_nic_config: additional nic configuration
301 * @base_params: pointer to basic parameters
302 * @ht_params: point to ht patameters
303 * @bt_params: pointer to bt parameters
304 * @pa_type: used by 6000 series only to identify the type of Power Amplifier
305 * @need_temp_offset_calib: need to perform temperature offset calibration
306 * @no_xtal_calib: some devices do not need crystal calibration data,
307 * don't send it to those
308 * @scan_rx_antennas: available antenna for scan operation
309 * @led_mode: 0=blinking, 1=On(RF On)/Off(RF Off)
310 * @adv_pm: advance power management
311 * @rx_with_siso_diversity: 1x1 device with rx antenna diversity
312 * @internal_wimax_coex: internal wifi/wimax combo device
313 * @iq_invert: I/Q inversion
314 * @temp_offset_v2: support v2 of temperature offset calibration
316 * We enable the driver to be backward compatible wrt API version. The
317 * driver specifies which APIs it supports (with @ucode_api_max being the
318 * highest and @ucode_api_min the lowest). Firmware will only be loaded if
319 * it has a supported API version.
321 * The ideal usage of this infrastructure is to treat a new ucode API
322 * release as a new hardware revision.
325 /* params specific to an individual device within a device family */
327 const char *fw_name_pre;
328 const unsigned int ucode_api_max;
329 const unsigned int ucode_api_ok;
330 const unsigned int ucode_api_min;
331 const u32 max_data_size;
332 const u32 max_inst_size;
336 u16 eeprom_calib_ver;
337 const struct iwl_lib_ops *lib;
338 void (*additional_nic_config)(struct iwl_priv *priv);
339 /* params not likely to change within a device family */
340 const struct iwl_base_params *base_params;
341 /* params likely to change within a device family */
342 const struct iwl_ht_params *ht_params;
343 const struct iwl_bt_params *bt_params;
344 enum iwl_pa_type pa_type; /* if used set to IWL_PA_SYSTEM */
345 const bool need_temp_offset_calib; /* if used set to true */
346 const bool no_xtal_calib;
347 u8 scan_rx_antennas[IEEE80211_NUM_BANDS];
348 enum iwl_led_mode led_mode;
350 const bool rx_with_siso_diversity;
351 const bool internal_wimax_coex;
352 const bool iq_invert;
353 const bool temp_offset_v2;
357 * struct iwl_shared - shared fields for all the layers of the driver
359 * @cmd_queue: command queue number
361 * @wowlan: are we running wowlan uCode
362 * @valid_contexts: microcode/device supports multiple contexts
363 * @bus: pointer to the bus layer data
364 * @cfg: see struct iwl_cfg
365 * @priv: pointer to the upper layer data
366 * @trans: pointer to the transport layer data
367 * @nic: pointer to the nic data
368 * @hw_params: see struct iwl_hw_params
369 * @lock: protect general shared data
370 * @wait_command_queue: the wait_queue for SYNC host commands
371 * @eeprom: pointer to the eeprom/OTP image
372 * @ucode_type: indicator of loaded ucode image
373 * @device_pointers: pointers to ucode event tables
377 unsigned long status;
380 const struct iwl_cfg *cfg;
381 struct iwl_trans *trans;
383 struct iwl_hw_params hw_params;
384 const struct iwl_fw *fw;
386 wait_queue_head_t wait_command_queue;
388 /* eeprom -- this is in the card's little endian byte order */
391 /* ucode related variables */
392 enum iwl_ucode_type ucode_type;
395 u32 error_event_table;
401 /*Whatever _m is (iwl_trans, iwl_priv, these macros will work */
402 #define cfg(_m) ((_m)->shrd->cfg)
403 #define trans(_m) ((_m)->shrd->trans)
404 #define hw_params(_m) ((_m)->shrd->hw_params)
406 static inline bool iwl_have_debug_level(u32 level)
408 return iwlagn_mod_params.debug_level & level;
411 enum iwl_rxon_context_id {
418 int iwlagn_hw_valid_rtc_data_addr(u32 addr);
419 const char *get_cmd_string(u8 cmd);
421 #define IWL_CMD(x) case x: return #x
423 /*****************************************************
424 * DRIVER STATUS FUNCTIONS
425 ******************************************************/
426 #define STATUS_HCMD_ACTIVE 0 /* host command in progress */
427 /* 1 is unused (used to be STATUS_HCMD_SYNC_ACTIVE) */
428 #define STATUS_INT_ENABLED 2
429 #define STATUS_RF_KILL_HW 3
430 #define STATUS_CT_KILL 4
431 #define STATUS_INIT 5
432 #define STATUS_ALIVE 6
433 #define STATUS_READY 7
434 #define STATUS_TEMPERATURE 8
435 #define STATUS_GEO_CONFIGURED 9
436 #define STATUS_EXIT_PENDING 10
437 #define STATUS_STATISTICS 12
438 #define STATUS_SCANNING 13
439 #define STATUS_SCAN_ABORTING 14
440 #define STATUS_SCAN_HW 15
441 #define STATUS_POWER_PMI 16
442 #define STATUS_FW_ERROR 17
443 #define STATUS_DEVICE_ENABLED 18
444 #define STATUS_CHANNEL_SWITCH_PENDING 19
445 #define STATUS_SCAN_COMPLETE 20
447 #endif /* #__iwl_shared_h__ */