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/gfp.h>
69 #include <net/mac80211.h>
70
71 #include "iwl-commands.h"
72 #include "iwl-fw.h"
73
74 /**
75 * DOC: shared area - role and goal
76 *
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
80 * layer must be here.
81 * The shared area also holds pointer to all the other layers. This allows a
82 * layer to call a function from another layer.
83 *
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
86 * what _m is.
87 *
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
94 */
95
96 struct iwl_priv;
97 struct iwl_trans;
98 struct iwl_sensitivity_ranges;
99 struct iwl_trans_ops;
100
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>"
105
106 extern struct iwl_mod_params iwlagn_mod_params;
107
108 #define IWL_DISABLE_HT_ALL BIT(0)
109 #define IWL_DISABLE_HT_TXAGG BIT(1)
110 #define IWL_DISABLE_HT_RXAGG BIT(2)
111
112 /**
113 * struct iwl_mod_params
114 *
115 * Holds the module parameters
116 *
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
136 */
137 struct iwl_mod_params {
138 int sw_crypto;
139 unsigned int disable_11n;
140 int amsdu_size_8K;
141 int antenna;
142 int restart_fw;
143 bool plcp_check;
144 bool ack_check;
145 int wd_disable;
146 bool bt_coex_active;
147 int led_mode;
148 bool no_sleep_autoadjust;
149 bool power_save;
150 int power_level;
151 u32 debug_level;
152 int ant_coupling;
153 bool bt_ch_announce;
154 int wanted_ucode_alternative;
155 bool auto_agg;
156 };
157
158 /**
159 * struct iwl_hw_params
160 *
161 * Holds the module parameters
162 *
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 * @ct_kill_threshold: temperature threshold - in hw dependent unit
172 * @ct_kill_exit_threshold: when to reeable the device - in hw dependent unit
173 * relevant for 1000, 6000 and up
174 * @wd_timeout: TX queues watchdog timeout
175 * @struct iwl_sensitivity_ranges: range of sensitivity values
176 * @use_rts_for_aggregation: use rts/cts protection for HT traffic
177 */
178 struct iwl_hw_params {
179 u8 num_ampdu_queues;
180 u8 tx_chains_num;
181 u8 rx_chains_num;
182 u8 valid_tx_ant;
183 u8 valid_rx_ant;
184 u8 ht40_channel;
185 bool use_rts_for_aggregation;
186 u16 sku;
187 u32 rx_page_order;
188 u32 ct_kill_threshold;
189 u32 ct_kill_exit_threshold;
190 unsigned int wd_timeout;
191
192 const struct iwl_sensitivity_ranges *sens;
193 };
194
195 /*
196 * LED mode
197 * IWL_LED_DEFAULT: use device default
198 * IWL_LED_RF_STATE: turn LED on/off based on RF state
199 * LED ON = RF ON
200 * LED OFF = RF OFF
201 * IWL_LED_BLINK: adjust led blink rate based on blink table
202 * IWL_LED_DISABLE: led disabled
203 */
204 enum iwl_led_mode {
205 IWL_LED_DEFAULT,
206 IWL_LED_RF_STATE,
207 IWL_LED_BLINK,
208 IWL_LED_DISABLE,
209 };
210
211 /*
212 * @max_ll_items: max number of OTP blocks
213 * @shadow_ram_support: shadow support for OTP memory
214 * @led_compensation: compensate on the led on/off time per HW according
215 * to the deviation to achieve the desired led frequency.
216 * The detail algorithm is described in iwl-led.c
217 * @chain_noise_num_beacons: number of beacons used to compute chain noise
218 * @adv_thermal_throttle: support advance thermal throttle
219 * @support_ct_kill_exit: support ct kill exit condition
220 * @support_wimax_coexist: support wimax/wifi co-exist
221 * @plcp_delta_threshold: plcp error rate threshold used to trigger
222 * radio tuning when there is a high receiving plcp error rate
223 * @chain_noise_scale: default chain noise scale used for gain computation
224 * @wd_timeout: TX queues watchdog timeout
225 * @max_event_log_size: size of event log buffer size for ucode event logging
226 * @shadow_reg_enable: HW shadhow register bit
227 * @hd_v2: v2 of enhanced sensitivity value, used for 2000 series and up
228 * @no_idle_support: do not support idle mode
229 * wd_disable: disable watchdog timer
230 */
231 struct iwl_base_params {
232 int eeprom_size;
233 int num_of_queues; /* def: HW dependent */
234 int num_of_ampdu_queues;/* def: HW dependent */
235 /* for iwl_apm_init() */
236 u32 pll_cfg_val;
237
238 const u16 max_ll_items;
239 const bool shadow_ram_support;
240 u16 led_compensation;
241 bool adv_thermal_throttle;
242 bool support_ct_kill_exit;
243 const bool support_wimax_coexist;
244 u8 plcp_delta_threshold;
245 s32 chain_noise_scale;
246 unsigned int wd_timeout;
247 u32 max_event_log_size;
248 const bool shadow_reg_enable;
249 const bool hd_v2;
250 const bool no_idle_support;
251 const bool wd_disable;
252 };
253
254 /*
255 * @advanced_bt_coexist: support advanced bt coexist
256 * @bt_init_traffic_load: specify initial bt traffic load
257 * @bt_prio_boost: default bt priority boost value
258 * @agg_time_limit: maximum number of uSec in aggregation
259 * @bt_sco_disable: uCode should not response to BT in SCO/ESCO mode
260 */
261 struct iwl_bt_params {
262 bool advanced_bt_coexist;
263 u8 bt_init_traffic_load;
264 u8 bt_prio_boost;
265 u16 agg_time_limit;
266 bool bt_sco_disable;
267 bool bt_session_2;
268 };
269 /*
270 * @use_rts_for_aggregation: use rts/cts protection for HT traffic
271 */
272 struct iwl_ht_params {
273 const bool ht_greenfield_support; /* if used set to true */
274 bool use_rts_for_aggregation;
275 enum ieee80211_smps_mode smps_mode;
276 };
277
278 /**
279 * struct iwl_cfg
280 * @name: Offical name of the device
281 * @fw_name_pre: Firmware filename prefix. The api version and extension
282 * (.ucode) will be added to filename before loading from disk. The
283 * filename is constructed as fw_name_pre<api>.ucode.
284 * @ucode_api_max: Highest version of uCode API supported by driver.
285 * @ucode_api_ok: oldest version of the uCode API that is OK to load
286 * without a warning, for use in transitions
287 * @ucode_api_min: Lowest version of uCode API supported by driver.
288 * @max_inst_size: The maximal length of the fw inst section
289 * @max_data_size: The maximal length of the fw data section
290 * @valid_tx_ant: valid transmit antenna
291 * @valid_rx_ant: valid receive antenna
292 * @eeprom_ver: EEPROM version
293 * @eeprom_calib_ver: EEPROM calibration version
294 * @lib: pointer to the lib ops
295 * @additional_nic_config: additional nic configuration
296 * @base_params: pointer to basic parameters
297 * @ht_params: point to ht patameters
298 * @bt_params: pointer to bt parameters
299 * @need_temp_offset_calib: need to perform temperature offset calibration
300 * @no_xtal_calib: some devices do not need crystal calibration data,
301 * don't send it to those
302 * @scan_rx_antennas: available antenna for scan operation
303 * @led_mode: 0=blinking, 1=On(RF On)/Off(RF Off)
304 * @adv_pm: advance power management
305 * @rx_with_siso_diversity: 1x1 device with rx antenna diversity
306 * @internal_wimax_coex: internal wifi/wimax combo device
307 * @iq_invert: I/Q inversion
308 * @temp_offset_v2: support v2 of temperature offset calibration
309 *
310 * We enable the driver to be backward compatible wrt API version. The
311 * driver specifies which APIs it supports (with @ucode_api_max being the
312 * highest and @ucode_api_min the lowest). Firmware will only be loaded if
313 * it has a supported API version.
314 *
315 * The ideal usage of this infrastructure is to treat a new ucode API
316 * release as a new hardware revision.
317 */
318 struct iwl_cfg {
319 /* params specific to an individual device within a device family */
320 const char *name;
321 const char *fw_name_pre;
322 const unsigned int ucode_api_max;
323 const unsigned int ucode_api_ok;
324 const unsigned int ucode_api_min;
325 const u32 max_data_size;
326 const u32 max_inst_size;
327 u8 valid_tx_ant;
328 u8 valid_rx_ant;
329 u16 eeprom_ver;
330 u16 eeprom_calib_ver;
331 const struct iwl_lib_ops *lib;
332 void (*additional_nic_config)(struct iwl_priv *priv);
333 /* params not likely to change within a device family */
334 const struct iwl_base_params *base_params;
335 /* params likely to change within a device family */
336 const struct iwl_ht_params *ht_params;
337 const struct iwl_bt_params *bt_params;
338 const bool need_temp_offset_calib; /* if used set to true */
339 const bool no_xtal_calib;
340 u8 scan_rx_antennas[IEEE80211_NUM_BANDS];
341 enum iwl_led_mode led_mode;
342 const bool adv_pm;
343 const bool rx_with_siso_diversity;
344 const bool internal_wimax_coex;
345 const bool iq_invert;
346 const bool temp_offset_v2;
347 };
348
349 /**
350 * struct iwl_shared - shared fields for all the layers of the driver
351 *
352 * @status: STATUS_*
353 * @wowlan: are we running wowlan uCode
354 * @valid_contexts: microcode/device supports multiple contexts
355 * @bus: pointer to the bus layer data
356 * @cfg: see struct iwl_cfg
357 * @priv: pointer to the upper layer data
358 * @trans: pointer to the transport layer data
359 * @nic: pointer to the nic data
360 * @hw_params: see struct iwl_hw_params
361 * @lock: protect general shared data
362 * @eeprom: pointer to the eeprom/OTP image
363 * @ucode_type: indicator of loaded ucode image
364 * @device_pointers: pointers to ucode event tables
365 */
366 struct iwl_shared {
367 unsigned long status;
368 u8 valid_contexts;
369
370 const struct iwl_cfg *cfg;
371 struct iwl_trans *trans;
372 void *drv;
373 struct iwl_hw_params hw_params;
374 const struct iwl_fw *fw;
375
376 /* eeprom -- this is in the card's little endian byte order */
377 u8 *eeprom;
378
379 /* ucode related variables */
380 enum iwl_ucode_type ucode_type;
381
382 struct {
383 u32 error_event_table;
384 u32 log_event_table;
385 } device_pointers;
386
387 };
388
389 /*Whatever _m is (iwl_trans, iwl_priv, these macros will work */
390 #define cfg(_m) ((_m)->shrd->cfg)
391 #define trans(_m) ((_m)->shrd->trans)
392 #define hw_params(_m) ((_m)->shrd->hw_params)
393
iwl_have_debug_level(u32 level)394 static inline bool iwl_have_debug_level(u32 level)
395 {
396 return iwlagn_mod_params.debug_level & level;
397 }
398
399 enum iwl_rxon_context_id {
400 IWL_RXON_CTX_BSS,
401 IWL_RXON_CTX_PAN,
402
403 NUM_IWL_RXON_CTX
404 };
405
406 int iwlagn_hw_valid_rtc_data_addr(u32 addr);
407 const char *get_cmd_string(u8 cmd);
408
409 #define IWL_CMD(x) case x: return #x
410
411 /*****************************************************
412 * DRIVER STATUS FUNCTIONS
413 ******************************************************/
414 #define STATUS_HCMD_ACTIVE 0 /* host command in progress */
415 /* 1 is unused (used to be STATUS_HCMD_SYNC_ACTIVE) */
416 #define STATUS_INT_ENABLED 2
417 #define STATUS_RF_KILL_HW 3
418 #define STATUS_CT_KILL 4
419 #define STATUS_INIT 5
420 #define STATUS_ALIVE 6
421 #define STATUS_READY 7
422 #define STATUS_TEMPERATURE 8
423 #define STATUS_GEO_CONFIGURED 9
424 #define STATUS_EXIT_PENDING 10
425 #define STATUS_STATISTICS 12
426 #define STATUS_SCANNING 13
427 #define STATUS_SCAN_ABORTING 14
428 #define STATUS_SCAN_HW 15
429 #define STATUS_POWER_PMI 16
430 #define STATUS_FW_ERROR 17
431 #define STATUS_DEVICE_ENABLED 18
432 #define STATUS_CHANNEL_SWITCH_PENDING 19
433 #define STATUS_SCAN_COMPLETE 20
434
435 #endif /* #__iwl_shared_h__ */
436