1 /******************************************************************************
2  *
3  * Copyright(c) 2003 - 2011 Intel Corporation. All rights reserved.
4  *
5  * This program is free software; you can redistribute it and/or modify it
6  * under the terms of version 2 of the GNU General Public License as
7  * published by the Free Software Foundation.
8  *
9  * This program is distributed in the hope that it will be useful, but WITHOUT
10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
12  * more details.
13  *
14  * You should have received a copy of the GNU General Public License along with
15  * this program; if not, write to the Free Software Foundation, Inc.,
16  * 51 Franklin Street, Fifth Floor, Boston, MA 02110, USA
17  *
18  * The full GNU General Public License is included in this distribution in the
19  * file called LICENSE.
20  *
21  * Contact Information:
22  *  Intel Linux Wireless <ilw@linux.intel.com>
23  * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
24  *
25  *****************************************************************************/
26 /*
27  * Please use this file (iwl-dev.h) for driver implementation definitions.
28  * Please use iwl-commands.h for uCode API definitions.
29  */
30 
31 #ifndef __iwl_dev_h__
32 #define __iwl_dev_h__
33 
34 #include <linux/interrupt.h>
35 #include <linux/kernel.h>
36 #include <linux/wait.h>
37 #include <linux/leds.h>
38 #include <linux/slab.h>
39 #include <net/ieee80211_radiotap.h>
40 
41 #include "iwl-eeprom.h"
42 #include "iwl-csr.h"
43 #include "iwl-prph.h"
44 #include "iwl-debug.h"
45 #include "iwl-agn-hw.h"
46 #include "iwl-led.h"
47 #include "iwl-power.h"
48 #include "iwl-agn-rs.h"
49 #include "iwl-agn-tt.h"
50 #include "iwl-bus.h"
51 #include "iwl-trans.h"
52 #include "iwl-shared.h"
53 
54 struct iwl_tx_queue;
55 
56 /* CT-KILL constants */
57 #define CT_KILL_THRESHOLD_LEGACY   110 /* in Celsius */
58 #define CT_KILL_THRESHOLD	   114 /* in Celsius */
59 #define CT_KILL_EXIT_THRESHOLD     95  /* in Celsius */
60 
61 /* Default noise level to report when noise measurement is not available.
62  *   This may be because we're:
63  *   1)  Not associated  no beacon statistics being sent to driver)
64  *   2)  Scanning (noise measurement does not apply to associated channel)
65  * Use default noise value of -127 ... this is below the range of measurable
66  *   Rx dBm for all agn devices, so it can indicate "unmeasurable" to user.
67  *   Also, -127 works better than 0 when averaging frames with/without
68  *   noise info (e.g. averaging might be done in app); measured dBm values are
69  *   always negative ... using a negative value as the default keeps all
70  *   averages within an s8's (used in some apps) range of negative values. */
71 #define IWL_NOISE_MEAS_NOT_AVAILABLE (-127)
72 
73 /*
74  * RTS threshold here is total size [2347] minus 4 FCS bytes
75  * Per spec:
76  *   a value of 0 means RTS on all data/management packets
77  *   a value > max MSDU size means no RTS
78  * else RTS for data/management frames where MPDU is larger
79  *   than RTS value.
80  */
81 #define DEFAULT_RTS_THRESHOLD     2347U
82 #define MIN_RTS_THRESHOLD         0U
83 #define MAX_RTS_THRESHOLD         2347U
84 #define MAX_MSDU_SIZE		  2304U
85 #define MAX_MPDU_SIZE		  2346U
86 #define DEFAULT_BEACON_INTERVAL   200U
87 #define	DEFAULT_SHORT_RETRY_LIMIT 7U
88 #define	DEFAULT_LONG_RETRY_LIMIT  4U
89 
90 #define IWL_NUM_SCAN_RATES         (2)
91 
92 /*
93  * One for each channel, holds all channel setup data
94  * Some of the fields (e.g. eeprom and flags/max_power_avg) are redundant
95  *     with one another!
96  */
97 struct iwl_channel_info {
98 	struct iwl_eeprom_channel eeprom;	/* EEPROM regulatory limit */
99 	struct iwl_eeprom_channel ht40_eeprom;	/* EEPROM regulatory limit for
100 						 * HT40 channel */
101 
102 	u8 channel;	  /* channel number */
103 	u8 flags;	  /* flags copied from EEPROM */
104 	s8 max_power_avg; /* (dBm) regul. eeprom, normal Tx, any rate */
105 	s8 curr_txpow;	  /* (dBm) regulatory/spectrum/user (not h/w) limit */
106 	s8 min_power;	  /* always 0 */
107 	s8 scan_power;	  /* (dBm) regul. eeprom, direct scans, any rate */
108 
109 	u8 group_index;	  /* 0-4, maps channel to group1/2/3/4/5 */
110 	u8 band_index;	  /* 0-4, maps channel to band1/2/3/4/5 */
111 	enum ieee80211_band band;
112 
113 	/* HT40 channel info */
114 	s8 ht40_max_power_avg;	/* (dBm) regul. eeprom, normal Tx, any rate */
115 	u8 ht40_flags;		/* flags copied from EEPROM */
116 	u8 ht40_extension_channel; /* HT_IE_EXT_CHANNEL_* */
117 };
118 
119 /*
120  * Minimum number of queues. MAX_NUM is defined in hw specific files.
121  * Set the minimum to accommodate
122  *  - 4 standard TX queues
123  *  - the command queue
124  *  - 4 PAN TX queues
125  *  - the PAN multicast queue, and
126  *  - the AUX (TX during scan dwell) queue.
127  */
128 #define IWL_MIN_NUM_QUEUES	11
129 
130 /*
131  * Command queue depends on iPAN support.
132  */
133 #define IWL_DEFAULT_CMD_QUEUE_NUM	4
134 #define IWL_IPAN_CMD_QUEUE_NUM		9
135 
136 #define IEEE80211_DATA_LEN              2304
137 #define IEEE80211_4ADDR_LEN             30
138 #define IEEE80211_HLEN                  (IEEE80211_4ADDR_LEN)
139 #define IEEE80211_FRAME_LEN             (IEEE80211_DATA_LEN + IEEE80211_HLEN)
140 
141 #define SUP_RATE_11A_MAX_NUM_CHANNELS  8
142 #define SUP_RATE_11B_MAX_NUM_CHANNELS  4
143 #define SUP_RATE_11G_MAX_NUM_CHANNELS  12
144 
145 #define IWL_SUPPORTED_RATES_IE_LEN         8
146 
147 #define IWL_INVALID_RATE     0xFF
148 #define IWL_INVALID_VALUE    -1
149 
150 union iwl_ht_rate_supp {
151 	u16 rates;
152 	struct {
153 		u8 siso_rate;
154 		u8 mimo_rate;
155 	};
156 };
157 
158 #define CFG_HT_RX_AMPDU_FACTOR_8K   (0x0)
159 #define CFG_HT_RX_AMPDU_FACTOR_16K  (0x1)
160 #define CFG_HT_RX_AMPDU_FACTOR_32K  (0x2)
161 #define CFG_HT_RX_AMPDU_FACTOR_64K  (0x3)
162 #define CFG_HT_RX_AMPDU_FACTOR_DEF  CFG_HT_RX_AMPDU_FACTOR_64K
163 #define CFG_HT_RX_AMPDU_FACTOR_MAX  CFG_HT_RX_AMPDU_FACTOR_64K
164 #define CFG_HT_RX_AMPDU_FACTOR_MIN  CFG_HT_RX_AMPDU_FACTOR_8K
165 
166 /*
167  * Maximal MPDU density for TX aggregation
168  * 4 - 2us density
169  * 5 - 4us density
170  * 6 - 8us density
171  * 7 - 16us density
172  */
173 #define CFG_HT_MPDU_DENSITY_2USEC   (0x4)
174 #define CFG_HT_MPDU_DENSITY_4USEC   (0x5)
175 #define CFG_HT_MPDU_DENSITY_8USEC   (0x6)
176 #define CFG_HT_MPDU_DENSITY_16USEC  (0x7)
177 #define CFG_HT_MPDU_DENSITY_DEF CFG_HT_MPDU_DENSITY_4USEC
178 #define CFG_HT_MPDU_DENSITY_MAX CFG_HT_MPDU_DENSITY_16USEC
179 #define CFG_HT_MPDU_DENSITY_MIN     (0x1)
180 
181 struct iwl_ht_config {
182 	bool single_chain_sufficient;
183 	enum ieee80211_smps_mode smps; /* current smps mode */
184 };
185 
186 /* QoS structures */
187 struct iwl_qos_info {
188 	int qos_active;
189 	struct iwl_qosparam_cmd def_qos_parm;
190 };
191 
192 /**
193  * enum iwl_agg_state
194  *
195  * The state machine of the BA agreement establishment / tear down.
196  * These states relate to a specific RA / TID.
197  *
198  * @IWL_AGG_OFF: aggregation is not used
199  * @IWL_AGG_ON: aggregation session is up
200  * @IWL_EMPTYING_HW_QUEUE_ADDBA: establishing a BA session - waiting for the
201  *	HW queue to be empty from packets for this RA /TID.
202  * @IWL_EMPTYING_HW_QUEUE_DELBA: tearing down a BA session - waiting for the
203  *	HW queue to be empty from packets for this RA /TID.
204  */
205 enum iwl_agg_state {
206 	IWL_AGG_OFF = 0,
207 	IWL_AGG_ON,
208 	IWL_EMPTYING_HW_QUEUE_ADDBA,
209 	IWL_EMPTYING_HW_QUEUE_DELBA,
210 };
211 
212 /**
213  * struct iwl_ht_agg - aggregation state machine
214 
215  * This structs holds the states for the BA agreement establishment and tear
216  * down. It also holds the state during the BA session itself. This struct is
217  * duplicated for each RA / TID.
218 
219  * @rate_n_flags: Rate at which Tx was attempted. Holds the data between the
220  *	Tx response (REPLY_TX), and the block ack notification
221  *	(REPLY_COMPRESSED_BA).
222  * @state: state of the BA agreement establishment / tear down.
223  * @txq_id: Tx queue used by the BA session - used by the transport layer.
224  *	Needed by the upper layer for debugfs only.
225  * @ssn: the first packet to be sent in AGG HW queue in Tx AGG start flow, or
226  *	the first packet to be sent in legacy HW queue in Tx AGG stop flow.
227  *	Basically when next_reclaimed reaches ssn, we can tell mac80211 that
228  *	we are ready to finish the Tx AGG stop / start flow.
229  * @wait_for_ba: Expect block-ack before next Tx reply
230  */
231 struct iwl_ht_agg {
232 	u32 rate_n_flags;
233 	enum iwl_agg_state state;
234 	u16 txq_id;
235 	u16 ssn;
236 	bool wait_for_ba;
237 };
238 
239 /**
240  * struct iwl_tid_data - one for each RA / TID
241 
242  * This structs holds the states for each RA / TID.
243 
244  * @seq_number: the next WiFi sequence number to use
245  * @next_reclaimed: the WiFi sequence number of the next packet to be acked.
246  *	This is basically (last acked packet++).
247  * @agg: aggregation state machine
248  */
249 struct iwl_tid_data {
250 	u16 seq_number;
251 	u16 next_reclaimed;
252 	struct iwl_ht_agg agg;
253 };
254 
255 /*
256  * Structure should be accessed with sta_lock held. When station addition
257  * is in progress (IWL_STA_UCODE_INPROGRESS) it is possible to access only
258  * the commands (iwl_addsta_cmd and iwl_link_quality_cmd) without sta_lock
259  * held.
260  */
261 struct iwl_station_entry {
262 	struct iwl_addsta_cmd sta;
263 	u8 used, ctxid;
264 	struct iwl_link_quality_cmd *lq;
265 };
266 
267 /*
268  * iwl_station_priv: Driver's private station information
269  *
270  * When mac80211 creates a station it reserves some space (hw->sta_data_size)
271  * in the structure for use by driver. This structure is places in that
272  * space.
273  */
274 struct iwl_station_priv {
275 	struct iwl_rxon_context *ctx;
276 	struct iwl_lq_sta lq_sta;
277 	atomic_t pending_frames;
278 	bool client;
279 	bool asleep;
280 	u8 max_agg_bufsize;
281 	u8 sta_id;
282 };
283 
284 /**
285  * struct iwl_vif_priv - driver's private per-interface information
286  *
287  * When mac80211 allocates a virtual interface, it can allocate
288  * space for us to put data into.
289  */
290 struct iwl_vif_priv {
291 	struct iwl_rxon_context *ctx;
292 	u8 ibss_bssid_sta_id;
293 };
294 
295 /* v1/v2 uCode file layout */
296 struct iwl_ucode_header {
297 	__le32 ver;	/* major/minor/API/serial */
298 	union {
299 		struct {
300 			__le32 inst_size;	/* bytes of runtime code */
301 			__le32 data_size;	/* bytes of runtime data */
302 			__le32 init_size;	/* bytes of init code */
303 			__le32 init_data_size;	/* bytes of init data */
304 			__le32 boot_size;	/* bytes of bootstrap code */
305 			u8 data[0];		/* in same order as sizes */
306 		} v1;
307 		struct {
308 			__le32 build;		/* build number */
309 			__le32 inst_size;	/* bytes of runtime code */
310 			__le32 data_size;	/* bytes of runtime data */
311 			__le32 init_size;	/* bytes of init code */
312 			__le32 init_data_size;	/* bytes of init data */
313 			__le32 boot_size;	/* bytes of bootstrap code */
314 			u8 data[0];		/* in same order as sizes */
315 		} v2;
316 	} u;
317 };
318 
319 /*
320  * new TLV uCode file layout
321  *
322  * The new TLV file format contains TLVs, that each specify
323  * some piece of data. To facilitate "groups", for example
324  * different instruction image with different capabilities,
325  * bundled with the same init image, an alternative mechanism
326  * is provided:
327  * When the alternative field is 0, that means that the item
328  * is always valid. When it is non-zero, then it is only
329  * valid in conjunction with items of the same alternative,
330  * in which case the driver (user) selects one alternative
331  * to use.
332  */
333 
334 enum iwl_ucode_tlv_type {
335 	IWL_UCODE_TLV_INVALID		= 0, /* unused */
336 	IWL_UCODE_TLV_INST		= 1,
337 	IWL_UCODE_TLV_DATA		= 2,
338 	IWL_UCODE_TLV_INIT		= 3,
339 	IWL_UCODE_TLV_INIT_DATA		= 4,
340 	IWL_UCODE_TLV_BOOT		= 5,
341 	IWL_UCODE_TLV_PROBE_MAX_LEN	= 6, /* a u32 value */
342 	IWL_UCODE_TLV_PAN		= 7,
343 	IWL_UCODE_TLV_RUNT_EVTLOG_PTR	= 8,
344 	IWL_UCODE_TLV_RUNT_EVTLOG_SIZE	= 9,
345 	IWL_UCODE_TLV_RUNT_ERRLOG_PTR	= 10,
346 	IWL_UCODE_TLV_INIT_EVTLOG_PTR	= 11,
347 	IWL_UCODE_TLV_INIT_EVTLOG_SIZE	= 12,
348 	IWL_UCODE_TLV_INIT_ERRLOG_PTR	= 13,
349 	IWL_UCODE_TLV_ENHANCE_SENS_TBL	= 14,
350 	IWL_UCODE_TLV_PHY_CALIBRATION_SIZE = 15,
351 	IWL_UCODE_TLV_WOWLAN_INST	= 16,
352 	IWL_UCODE_TLV_WOWLAN_DATA	= 17,
353 	IWL_UCODE_TLV_FLAGS		= 18,
354 };
355 
356 /**
357  * enum iwl_ucode_tlv_flag - ucode API flags
358  * @IWL_UCODE_TLV_FLAGS_PAN: This is PAN capable microcode; this previously
359  *	was a separate TLV but moved here to save space.
360  * @IWL_UCODE_TLV_FLAGS_NEWSCAN: new uCode scan behaviour on hidden SSID,
361  *	treats good CRC threshold as a boolean
362  * @IWL_UCODE_TLV_FLAGS_MFP: This uCode image supports MFP (802.11w).
363  * @IWL_UCODE_TLV_FLAGS_P2P: This uCode image supports P2P.
364  */
365 enum iwl_ucode_tlv_flag {
366 	IWL_UCODE_TLV_FLAGS_PAN		= BIT(0),
367 	IWL_UCODE_TLV_FLAGS_NEWSCAN	= BIT(1),
368 	IWL_UCODE_TLV_FLAGS_MFP		= BIT(2),
369 	IWL_UCODE_TLV_FLAGS_P2P		= BIT(3),
370 };
371 
372 struct iwl_ucode_tlv {
373 	__le16 type;		/* see above */
374 	__le16 alternative;	/* see comment */
375 	__le32 length;		/* not including type/length fields */
376 	u8 data[0];
377 } __packed;
378 
379 #define IWL_TLV_UCODE_MAGIC	0x0a4c5749
380 
381 struct iwl_tlv_ucode_header {
382 	/*
383 	 * The TLV style ucode header is distinguished from
384 	 * the v1/v2 style header by first four bytes being
385 	 * zero, as such is an invalid combination of
386 	 * major/minor/API/serial versions.
387 	 */
388 	__le32 zero;
389 	__le32 magic;
390 	u8 human_readable[64];
391 	__le32 ver;		/* major/minor/API/serial */
392 	__le32 build;
393 	__le64 alternatives;	/* bitmask of valid alternatives */
394 	/*
395 	 * The data contained herein has a TLV layout,
396 	 * see above for the TLV header and types.
397 	 * Note that each TLV is padded to a length
398 	 * that is a multiple of 4 for alignment.
399 	 */
400 	u8 data[0];
401 };
402 
403 struct iwl_sensitivity_ranges {
404 	u16 min_nrg_cck;
405 	u16 max_nrg_cck;
406 
407 	u16 nrg_th_cck;
408 	u16 nrg_th_ofdm;
409 
410 	u16 auto_corr_min_ofdm;
411 	u16 auto_corr_min_ofdm_mrc;
412 	u16 auto_corr_min_ofdm_x1;
413 	u16 auto_corr_min_ofdm_mrc_x1;
414 
415 	u16 auto_corr_max_ofdm;
416 	u16 auto_corr_max_ofdm_mrc;
417 	u16 auto_corr_max_ofdm_x1;
418 	u16 auto_corr_max_ofdm_mrc_x1;
419 
420 	u16 auto_corr_max_cck;
421 	u16 auto_corr_max_cck_mrc;
422 	u16 auto_corr_min_cck;
423 	u16 auto_corr_min_cck_mrc;
424 
425 	u16 barker_corr_th_min;
426 	u16 barker_corr_th_min_mrc;
427 	u16 nrg_th_cca;
428 };
429 
430 
431 #define KELVIN_TO_CELSIUS(x) ((x)-273)
432 #define CELSIUS_TO_KELVIN(x) ((x)+273)
433 
434 
435 /******************************************************************************
436  *
437  * Functions implemented in core module which are forward declared here
438  * for use by iwl-[4-5].c
439  *
440  * NOTE:  The implementation of these functions are not hardware specific
441  * which is why they are in the core module files.
442  *
443  * Naming convention --
444  * iwl_         <-- Is part of iwlwifi
445  * iwlXXXX_     <-- Hardware specific (implemented in iwl-XXXX.c for XXXX)
446  *
447  ****************************************************************************/
448 extern void iwl_update_chain_flags(struct iwl_priv *priv);
449 extern const u8 iwl_bcast_addr[ETH_ALEN];
450 
451 #define IWL_OPERATION_MODE_AUTO     0
452 #define IWL_OPERATION_MODE_HT_ONLY  1
453 #define IWL_OPERATION_MODE_MIXED    2
454 #define IWL_OPERATION_MODE_20MHZ    3
455 
456 #define TX_POWER_IWL_ILLEGAL_VOLTAGE -10000
457 
458 /* Sensitivity and chain noise calibration */
459 #define INITIALIZATION_VALUE		0xFFFF
460 #define IWL_CAL_NUM_BEACONS		16
461 #define MAXIMUM_ALLOWED_PATHLOSS	15
462 
463 #define CHAIN_NOISE_MAX_DELTA_GAIN_CODE 3
464 
465 #define MAX_FA_OFDM  50
466 #define MIN_FA_OFDM  5
467 #define MAX_FA_CCK   50
468 #define MIN_FA_CCK   5
469 
470 #define AUTO_CORR_STEP_OFDM       1
471 
472 #define AUTO_CORR_STEP_CCK     3
473 #define AUTO_CORR_MAX_TH_CCK   160
474 
475 #define NRG_DIFF               2
476 #define NRG_STEP_CCK           2
477 #define NRG_MARGIN             8
478 #define MAX_NUMBER_CCK_NO_FA 100
479 
480 #define AUTO_CORR_CCK_MIN_VAL_DEF    (125)
481 
482 #define CHAIN_A             0
483 #define CHAIN_B             1
484 #define CHAIN_C             2
485 #define CHAIN_NOISE_DELTA_GAIN_INIT_VAL 4
486 #define ALL_BAND_FILTER			0xFF00
487 #define IN_BAND_FILTER			0xFF
488 #define MIN_AVERAGE_NOISE_MAX_VALUE	0xFFFFFFFF
489 
490 #define NRG_NUM_PREV_STAT_L     20
491 #define NUM_RX_CHAINS           3
492 
493 enum iwlagn_false_alarm_state {
494 	IWL_FA_TOO_MANY = 0,
495 	IWL_FA_TOO_FEW = 1,
496 	IWL_FA_GOOD_RANGE = 2,
497 };
498 
499 enum iwlagn_chain_noise_state {
500 	IWL_CHAIN_NOISE_ALIVE = 0,  /* must be 0 */
501 	IWL_CHAIN_NOISE_ACCUMULATE,
502 	IWL_CHAIN_NOISE_CALIBRATED,
503 	IWL_CHAIN_NOISE_DONE,
504 };
505 
506 /* Sensitivity calib data */
507 struct iwl_sensitivity_data {
508 	u32 auto_corr_ofdm;
509 	u32 auto_corr_ofdm_mrc;
510 	u32 auto_corr_ofdm_x1;
511 	u32 auto_corr_ofdm_mrc_x1;
512 	u32 auto_corr_cck;
513 	u32 auto_corr_cck_mrc;
514 
515 	u32 last_bad_plcp_cnt_ofdm;
516 	u32 last_fa_cnt_ofdm;
517 	u32 last_bad_plcp_cnt_cck;
518 	u32 last_fa_cnt_cck;
519 
520 	u32 nrg_curr_state;
521 	u32 nrg_prev_state;
522 	u32 nrg_value[10];
523 	u8  nrg_silence_rssi[NRG_NUM_PREV_STAT_L];
524 	u32 nrg_silence_ref;
525 	u32 nrg_energy_idx;
526 	u32 nrg_silence_idx;
527 	u32 nrg_th_cck;
528 	s32 nrg_auto_corr_silence_diff;
529 	u32 num_in_cck_no_fa;
530 	u32 nrg_th_ofdm;
531 
532 	u16 barker_corr_th_min;
533 	u16 barker_corr_th_min_mrc;
534 	u16 nrg_th_cca;
535 };
536 
537 /* Chain noise (differential Rx gain) calib data */
538 struct iwl_chain_noise_data {
539 	u32 active_chains;
540 	u32 chain_noise_a;
541 	u32 chain_noise_b;
542 	u32 chain_noise_c;
543 	u32 chain_signal_a;
544 	u32 chain_signal_b;
545 	u32 chain_signal_c;
546 	u16 beacon_count;
547 	u8 disconn_array[NUM_RX_CHAINS];
548 	u8 delta_gain_code[NUM_RX_CHAINS];
549 	u8 radio_write;
550 	u8 state;
551 };
552 
553 #define	EEPROM_SEM_TIMEOUT 10		/* milliseconds */
554 #define EEPROM_SEM_RETRY_LIMIT 1000	/* number of attempts (not time) */
555 
556 enum {
557 	MEASUREMENT_READY = (1 << 0),
558 	MEASUREMENT_ACTIVE = (1 << 1),
559 };
560 
561 enum iwl_nvm_type {
562 	NVM_DEVICE_TYPE_EEPROM = 0,
563 	NVM_DEVICE_TYPE_OTP,
564 };
565 
566 /*
567  * Two types of OTP memory access modes
568  *   IWL_OTP_ACCESS_ABSOLUTE - absolute address mode,
569  * 			        based on physical memory addressing
570  *   IWL_OTP_ACCESS_RELATIVE - relative address mode,
571  * 			       based on logical memory addressing
572  */
573 enum iwl_access_mode {
574 	IWL_OTP_ACCESS_ABSOLUTE,
575 	IWL_OTP_ACCESS_RELATIVE,
576 };
577 
578 /* reply_tx_statistics (for _agn devices) */
579 struct reply_tx_error_statistics {
580 	u32 pp_delay;
581 	u32 pp_few_bytes;
582 	u32 pp_bt_prio;
583 	u32 pp_quiet_period;
584 	u32 pp_calc_ttak;
585 	u32 int_crossed_retry;
586 	u32 short_limit;
587 	u32 long_limit;
588 	u32 fifo_underrun;
589 	u32 drain_flow;
590 	u32 rfkill_flush;
591 	u32 life_expire;
592 	u32 dest_ps;
593 	u32 host_abort;
594 	u32 bt_retry;
595 	u32 sta_invalid;
596 	u32 frag_drop;
597 	u32 tid_disable;
598 	u32 fifo_flush;
599 	u32 insuff_cf_poll;
600 	u32 fail_hw_drop;
601 	u32 sta_color_mismatch;
602 	u32 unknown;
603 };
604 
605 /* reply_agg_tx_statistics (for _agn devices) */
606 struct reply_agg_tx_error_statistics {
607 	u32 underrun;
608 	u32 bt_prio;
609 	u32 few_bytes;
610 	u32 abort;
611 	u32 last_sent_ttl;
612 	u32 last_sent_try;
613 	u32 last_sent_bt_kill;
614 	u32 scd_query;
615 	u32 bad_crc32;
616 	u32 response;
617 	u32 dump_tx;
618 	u32 delay_tx;
619 	u32 unknown;
620 };
621 
622 /* management statistics */
623 enum iwl_mgmt_stats {
624 	MANAGEMENT_ASSOC_REQ = 0,
625 	MANAGEMENT_ASSOC_RESP,
626 	MANAGEMENT_REASSOC_REQ,
627 	MANAGEMENT_REASSOC_RESP,
628 	MANAGEMENT_PROBE_REQ,
629 	MANAGEMENT_PROBE_RESP,
630 	MANAGEMENT_BEACON,
631 	MANAGEMENT_ATIM,
632 	MANAGEMENT_DISASSOC,
633 	MANAGEMENT_AUTH,
634 	MANAGEMENT_DEAUTH,
635 	MANAGEMENT_ACTION,
636 	MANAGEMENT_MAX,
637 };
638 /* control statistics */
639 enum iwl_ctrl_stats {
640 	CONTROL_BACK_REQ =  0,
641 	CONTROL_BACK,
642 	CONTROL_PSPOLL,
643 	CONTROL_RTS,
644 	CONTROL_CTS,
645 	CONTROL_ACK,
646 	CONTROL_CFEND,
647 	CONTROL_CFENDACK,
648 	CONTROL_MAX,
649 };
650 
651 struct traffic_stats {
652 #ifdef CONFIG_IWLWIFI_DEBUGFS
653 	u32 mgmt[MANAGEMENT_MAX];
654 	u32 ctrl[CONTROL_MAX];
655 	u32 data_cnt;
656 	u64 data_bytes;
657 #endif
658 };
659 
660 /*
661  * schedule the timer to wake up every UCODE_TRACE_PERIOD milliseconds
662  * to perform continuous uCode event logging operation if enabled
663  */
664 #define UCODE_TRACE_PERIOD (100)
665 
666 /*
667  * iwl_event_log: current uCode event log position
668  *
669  * @ucode_trace: enable/disable ucode continuous trace timer
670  * @num_wraps: how many times the event buffer wraps
671  * @next_entry:  the entry just before the next one that uCode would fill
672  * @non_wraps_count: counter for no wrap detected when dump ucode events
673  * @wraps_once_count: counter for wrap once detected when dump ucode events
674  * @wraps_more_count: counter for wrap more than once detected
675  *		      when dump ucode events
676  */
677 struct iwl_event_log {
678 	bool ucode_trace;
679 	u32 num_wraps;
680 	u32 next_entry;
681 	int non_wraps_count;
682 	int wraps_once_count;
683 	int wraps_more_count;
684 };
685 
686 /*
687  * This is the threshold value of plcp error rate per 100mSecs.  It is
688  * used to set and check for the validity of plcp_delta.
689  */
690 #define IWL_MAX_PLCP_ERR_THRESHOLD_MIN	(1)
691 #define IWL_MAX_PLCP_ERR_THRESHOLD_DEF	(50)
692 #define IWL_MAX_PLCP_ERR_LONG_THRESHOLD_DEF	(100)
693 #define IWL_MAX_PLCP_ERR_EXT_LONG_THRESHOLD_DEF	(200)
694 #define IWL_MAX_PLCP_ERR_THRESHOLD_MAX	(255)
695 #define IWL_MAX_PLCP_ERR_THRESHOLD_DISABLE	(0)
696 
697 #define IWL_DELAY_NEXT_FORCE_RF_RESET  (HZ*3)
698 #define IWL_DELAY_NEXT_FORCE_FW_RELOAD (HZ*5)
699 
700 /* TX queue watchdog timeouts in mSecs */
701 #define IWL_DEF_WD_TIMEOUT	(2000)
702 #define IWL_LONG_WD_TIMEOUT	(10000)
703 #define IWL_MAX_WD_TIMEOUT	(120000)
704 
705 /* BT Antenna Coupling Threshold (dB) */
706 #define IWL_BT_ANTENNA_COUPLING_THRESHOLD	(35)
707 
708 /* Firmware reload counter and Timestamp */
709 #define IWL_MIN_RELOAD_DURATION		1000 /* 1000 ms */
710 #define IWL_MAX_CONTINUE_RELOAD_CNT	4
711 
712 
713 enum iwl_reset {
714 	IWL_RF_RESET = 0,
715 	IWL_FW_RESET,
716 	IWL_MAX_FORCE_RESET,
717 };
718 
719 struct iwl_force_reset {
720 	int reset_request_count;
721 	int reset_success_count;
722 	int reset_reject_count;
723 	unsigned long reset_duration;
724 	unsigned long last_force_reset_jiffies;
725 };
726 
727 /* extend beacon time format bit shifting  */
728 /*
729  * for _agn devices
730  * bits 31:22 - extended
731  * bits 21:0  - interval
732  */
733 #define IWLAGN_EXT_BEACON_TIME_POS	22
734 
735 struct iwl_rxon_context {
736 	struct ieee80211_vif *vif;
737 
738 	/*
739 	 * We could use the vif to indicate active, but we
740 	 * also need it to be active during disabling when
741 	 * we already removed the vif for type setting.
742 	 */
743 	bool always_active, is_active;
744 
745 	bool ht_need_multiple_chains;
746 
747 	enum iwl_rxon_context_id ctxid;
748 
749 	u32 interface_modes, exclusive_interface_modes;
750 	u8 unused_devtype, ap_devtype, ibss_devtype, station_devtype;
751 
752 	/*
753 	 * We declare this const so it can only be
754 	 * changed via explicit cast within the
755 	 * routines that actually update the physical
756 	 * hardware.
757 	 */
758 	const struct iwl_rxon_cmd active;
759 	struct iwl_rxon_cmd staging;
760 
761 	struct iwl_rxon_time_cmd timing;
762 
763 	struct iwl_qos_info qos_data;
764 
765 	u8 bcast_sta_id, ap_sta_id;
766 
767 	u8 rxon_cmd, rxon_assoc_cmd, rxon_timing_cmd;
768 	u8 qos_cmd;
769 	u8 wep_key_cmd;
770 
771 	struct iwl_wep_key wep_keys[WEP_KEYS_MAX];
772 	u8 key_mapping_keys;
773 
774 	__le32 station_flags;
775 
776 	int beacon_int;
777 
778 	struct {
779 		bool non_gf_sta_present;
780 		u8 protection;
781 		bool enabled, is_40mhz;
782 		u8 extension_chan_offset;
783 	} ht;
784 
785 	u8 bssid[ETH_ALEN];
786 	bool preauth_bssid;
787 
788 	bool last_tx_rejected;
789 };
790 
791 enum iwl_scan_type {
792 	IWL_SCAN_NORMAL,
793 	IWL_SCAN_RADIO_RESET,
794 	IWL_SCAN_ROC,
795 };
796 
797 #ifdef CONFIG_IWLWIFI_DEVICE_TESTMODE
798 struct iwl_testmode_trace {
799 	u32 buff_size;
800 	u32 total_size;
801 	u32 num_chunks;
802 	u8 *cpu_addr;
803 	u8 *trace_addr;
804 	dma_addr_t dma_addr;
805 	bool trace_enabled;
806 };
807 struct iwl_testmode_sram {
808 	u32 buff_size;
809 	u32 num_chunks;
810 	u8 *buff_addr;
811 	bool sram_readed;
812 };
813 #endif
814 
815 struct iwl_wipan_noa_data {
816 	struct rcu_head rcu_head;
817 	u32 length;
818 	u8 data[];
819 };
820 
821 struct iwl_priv {
822 
823 	/*data shared among all the driver's layers */
824 	struct iwl_shared _shrd;
825 	struct iwl_shared *shrd;
826 
827 	/* ieee device used by generic ieee processing code */
828 	struct ieee80211_hw *hw;
829 	struct ieee80211_channel *ieee_channels;
830 	struct ieee80211_rate *ieee_rates;
831 	struct kmem_cache *tx_cmd_pool;
832 
833 	enum ieee80211_band band;
834 
835 	void (*pre_rx_handler)(struct iwl_priv *priv,
836 			       struct iwl_rx_mem_buffer *rxb);
837 	int (*rx_handlers[REPLY_MAX])(struct iwl_priv *priv,
838 				       struct iwl_rx_mem_buffer *rxb,
839 				       struct iwl_device_cmd *cmd);
840 
841 	struct ieee80211_supported_band bands[IEEE80211_NUM_BANDS];
842 
843 	/* spectrum measurement report caching */
844 	struct iwl_spectrum_notification measure_report;
845 	u8 measurement_status;
846 
847 	/* ucode beacon time */
848 	u32 ucode_beacon_time;
849 	int missed_beacon_threshold;
850 
851 	/* track IBSS manager (last beacon) status */
852 	u32 ibss_manager;
853 
854 	/* jiffies when last recovery from statistics was performed */
855 	unsigned long rx_statistics_jiffies;
856 
857 	/*counters */
858 	u32 rx_handlers_stats[REPLY_MAX];
859 
860 	/* force reset */
861 	struct iwl_force_reset force_reset[IWL_MAX_FORCE_RESET];
862 
863 	/* firmware reload counter and timestamp */
864 	unsigned long reload_jiffies;
865 	int reload_count;
866 
867 	/* we allocate array of iwl_channel_info for NIC's valid channels.
868 	 *    Access via channel # using indirect index array */
869 	struct iwl_channel_info *channel_info;	/* channel info array */
870 	u8 channel_count;	/* # of channels */
871 
872 	/* thermal calibration */
873 	s32 temperature;	/* Celsius */
874 	s32 last_temperature;
875 
876 	struct iwl_wipan_noa_data __rcu *noa_data;
877 
878 	/* Scan related variables */
879 	unsigned long scan_start;
880 	unsigned long scan_start_tsf;
881 	void *scan_cmd;
882 	enum ieee80211_band scan_band;
883 	struct cfg80211_scan_request *scan_request;
884 	struct ieee80211_vif *scan_vif;
885 	enum iwl_scan_type scan_type;
886 	u8 scan_tx_ant[IEEE80211_NUM_BANDS];
887 	u8 mgmt_tx_ant;
888 
889 	/* max number of station keys */
890 	u8 sta_key_max_num;
891 
892 	bool new_scan_threshold_behaviour;
893 
894 	/* EEPROM MAC addresses */
895 	struct mac_address addresses[2];
896 
897 	/* uCode images, save to reload in case of failure */
898 	int fw_index;			/* firmware we're trying to load */
899 	u32 ucode_ver;			/* version of ucode, copy of
900 					   iwl_ucode.ver */
901 
902 	char firmware_name[25];
903 
904 	struct iwl_rxon_context contexts[NUM_IWL_RXON_CTX];
905 
906 	__le16 switch_channel;
907 
908 	u16 active_rate;
909 
910 	u8 start_calib;
911 	struct iwl_sensitivity_data sensitivity_data;
912 	struct iwl_chain_noise_data chain_noise_data;
913 	bool enhance_sensitivity_table;
914 	__le16 sensitivity_tbl[HD_TABLE_SIZE];
915 	__le16 enhance_sensitivity_tbl[ENHANCE_HD_TABLE_ENTRIES];
916 
917 	struct iwl_ht_config current_ht_config;
918 
919 	/* Rate scaling data */
920 	u8 retry_rate;
921 
922 	int activity_timer_active;
923 
924 	/* counts mgmt, ctl, and data packets */
925 	struct traffic_stats tx_stats;
926 	struct traffic_stats rx_stats;
927 
928 	struct iwl_power_mgr power_data;
929 	struct iwl_tt_mgmt thermal_throttle;
930 
931 	/* station table variables */
932 	int num_stations;
933 	struct iwl_station_entry stations[IWLAGN_STATION_COUNT];
934 	unsigned long ucode_key_table;
935 	struct iwl_tid_data tid_data[IWLAGN_STATION_COUNT][IWL_MAX_TID_COUNT];
936 
937 	u8 mac80211_registered;
938 
939 	/* Indication if ieee80211_ops->open has been called */
940 	u8 is_open;
941 
942 	enum nl80211_iftype iw_mode;
943 
944 	/* Last Rx'd beacon timestamp */
945 	u64 timestamp;
946 
947 	struct {
948 		__le32 flag;
949 		struct statistics_general_common common;
950 		struct statistics_rx_non_phy rx_non_phy;
951 		struct statistics_rx_phy rx_ofdm;
952 		struct statistics_rx_ht_phy rx_ofdm_ht;
953 		struct statistics_rx_phy rx_cck;
954 		struct statistics_tx tx;
955 #ifdef CONFIG_IWLWIFI_DEBUGFS
956 		struct statistics_bt_activity bt_activity;
957 		__le32 num_bt_kills, accum_num_bt_kills;
958 #endif
959 	} statistics;
960 #ifdef CONFIG_IWLWIFI_DEBUGFS
961 	struct {
962 		struct statistics_general_common common;
963 		struct statistics_rx_non_phy rx_non_phy;
964 		struct statistics_rx_phy rx_ofdm;
965 		struct statistics_rx_ht_phy rx_ofdm_ht;
966 		struct statistics_rx_phy rx_cck;
967 		struct statistics_tx tx;
968 		struct statistics_bt_activity bt_activity;
969 	} accum_stats, delta_stats, max_delta_stats;
970 #endif
971 
972 	/*
973 	 * reporting the number of tids has AGG on. 0 means
974 	 * no AGGREGATION
975 	 */
976 	u8 agg_tids_count;
977 
978 	struct iwl_rx_phy_res last_phy_res;
979 	bool last_phy_res_valid;
980 
981 	struct completion firmware_loading_complete;
982 
983 	u32 init_evtlog_ptr, init_evtlog_size, init_errlog_ptr;
984 	u32 inst_evtlog_ptr, inst_evtlog_size, inst_errlog_ptr;
985 
986 	/*
987 	 * chain noise reset and gain commands are the
988 	 * two extra calibration commands follows the standard
989 	 * phy calibration commands
990 	 */
991 	u8 phy_calib_chain_noise_reset_cmd;
992 	u8 phy_calib_chain_noise_gain_cmd;
993 
994 	/* counts reply_tx error */
995 	struct reply_tx_error_statistics reply_tx_stats;
996 	struct reply_agg_tx_error_statistics reply_agg_tx_stats;
997 
998 	/* remain-on-channel offload support */
999 	struct ieee80211_channel *hw_roc_channel;
1000 	struct delayed_work hw_roc_disable_work;
1001 	enum nl80211_channel_type hw_roc_chantype;
1002 	int hw_roc_duration;
1003 	bool hw_roc_setup, hw_roc_start_notified;
1004 
1005 	/* bt coex */
1006 	u8 bt_enable_flag;
1007 	u8 bt_status;
1008 	u8 bt_traffic_load, last_bt_traffic_load;
1009 	bool bt_ch_announce;
1010 	bool bt_full_concurrent;
1011 	bool bt_ant_couple_ok;
1012 	__le32 kill_ack_mask;
1013 	__le32 kill_cts_mask;
1014 	__le16 bt_valid;
1015 	u16 bt_on_thresh;
1016 	u16 bt_duration;
1017 	u16 dynamic_frag_thresh;
1018 	u8 bt_ci_compliance;
1019 	struct work_struct bt_traffic_change_work;
1020 	bool bt_enable_pspoll;
1021 	struct iwl_rxon_context *cur_rssi_ctx;
1022 	bool bt_is_sco;
1023 
1024 	struct work_struct restart;
1025 	struct work_struct scan_completed;
1026 	struct work_struct abort_scan;
1027 
1028 	struct work_struct beacon_update;
1029 	struct iwl_rxon_context *beacon_ctx;
1030 	struct sk_buff *beacon_skb;
1031 	void *beacon_cmd;
1032 
1033 	struct work_struct tt_work;
1034 	struct work_struct ct_enter;
1035 	struct work_struct ct_exit;
1036 	struct work_struct start_internal_scan;
1037 	struct work_struct tx_flush;
1038 	struct work_struct bt_full_concurrency;
1039 	struct work_struct bt_runtime_config;
1040 
1041 	struct delayed_work scan_check;
1042 
1043 	/* TX Power */
1044 	s8 tx_power_user_lmt;
1045 	s8 tx_power_device_lmt;
1046 	s8 tx_power_lmt_in_half_dbm; /* max tx power in half-dBm format */
1047 	s8 tx_power_next;
1048 
1049 #ifdef CONFIG_IWLWIFI_DEBUGFS
1050 	/* debugfs */
1051 	u16 tx_traffic_idx;
1052 	u16 rx_traffic_idx;
1053 	u8 *tx_traffic;
1054 	u8 *rx_traffic;
1055 	struct dentry *debugfs_dir;
1056 	u32 dbgfs_sram_offset, dbgfs_sram_len;
1057 	bool disable_ht40;
1058 	void *wowlan_sram;
1059 #endif /* CONFIG_IWLWIFI_DEBUGFS */
1060 
1061 	struct work_struct txpower_work;
1062 	u32 disable_sens_cal;
1063 	u32 disable_chain_noise_cal;
1064 	struct work_struct run_time_calib_work;
1065 	struct timer_list statistics_periodic;
1066 	struct timer_list ucode_trace;
1067 	struct timer_list watchdog;
1068 
1069 	struct iwl_event_log event_log;
1070 
1071 	struct led_classdev led;
1072 	unsigned long blink_on, blink_off;
1073 	bool led_registered;
1074 #ifdef CONFIG_IWLWIFI_DEVICE_TESTMODE
1075 	struct iwl_testmode_trace testmode_trace;
1076 	struct iwl_testmode_sram testmode_sram;
1077 	u32 tm_fixed_rate;
1078 #endif
1079 
1080 	/* WoWLAN GTK rekey data */
1081 	u8 kck[NL80211_KCK_LEN], kek[NL80211_KEK_LEN];
1082 	__le64 replay_ctr;
1083 	__le16 last_seq_ctl;
1084 	bool have_rekey_data;
1085 }; /*iwl_priv */
1086 
1087 extern struct iwl_mod_params iwlagn_mod_params;
1088 
1089 static inline struct iwl_rxon_context *
iwl_rxon_ctx_from_vif(struct ieee80211_vif * vif)1090 iwl_rxon_ctx_from_vif(struct ieee80211_vif *vif)
1091 {
1092 	struct iwl_vif_priv *vif_priv = (void *)vif->drv_priv;
1093 
1094 	return vif_priv->ctx;
1095 }
1096 
1097 #define for_each_context(priv, ctx)				\
1098 	for (ctx = &priv->contexts[IWL_RXON_CTX_BSS];		\
1099 	     ctx < &priv->contexts[NUM_IWL_RXON_CTX]; ctx++)	\
1100 		if (priv->shrd->valid_contexts & BIT(ctx->ctxid))
1101 
iwl_is_associated_ctx(struct iwl_rxon_context * ctx)1102 static inline int iwl_is_associated_ctx(struct iwl_rxon_context *ctx)
1103 {
1104 	return (ctx->active.filter_flags & RXON_FILTER_ASSOC_MSK) ? 1 : 0;
1105 }
1106 
iwl_is_associated(struct iwl_priv * priv,enum iwl_rxon_context_id ctxid)1107 static inline int iwl_is_associated(struct iwl_priv *priv,
1108 				    enum iwl_rxon_context_id ctxid)
1109 {
1110 	return iwl_is_associated_ctx(&priv->contexts[ctxid]);
1111 }
1112 
iwl_is_any_associated(struct iwl_priv * priv)1113 static inline int iwl_is_any_associated(struct iwl_priv *priv)
1114 {
1115 	struct iwl_rxon_context *ctx;
1116 	for_each_context(priv, ctx)
1117 		if (iwl_is_associated_ctx(ctx))
1118 			return true;
1119 	return false;
1120 }
1121 
is_channel_valid(const struct iwl_channel_info * ch_info)1122 static inline int is_channel_valid(const struct iwl_channel_info *ch_info)
1123 {
1124 	if (ch_info == NULL)
1125 		return 0;
1126 	return (ch_info->flags & EEPROM_CHANNEL_VALID) ? 1 : 0;
1127 }
1128 
is_channel_radar(const struct iwl_channel_info * ch_info)1129 static inline int is_channel_radar(const struct iwl_channel_info *ch_info)
1130 {
1131 	return (ch_info->flags & EEPROM_CHANNEL_RADAR) ? 1 : 0;
1132 }
1133 
is_channel_a_band(const struct iwl_channel_info * ch_info)1134 static inline u8 is_channel_a_band(const struct iwl_channel_info *ch_info)
1135 {
1136 	return ch_info->band == IEEE80211_BAND_5GHZ;
1137 }
1138 
is_channel_bg_band(const struct iwl_channel_info * ch_info)1139 static inline u8 is_channel_bg_band(const struct iwl_channel_info *ch_info)
1140 {
1141 	return ch_info->band == IEEE80211_BAND_2GHZ;
1142 }
1143 
is_channel_passive(const struct iwl_channel_info * ch)1144 static inline int is_channel_passive(const struct iwl_channel_info *ch)
1145 {
1146 	return (!(ch->flags & EEPROM_CHANNEL_ACTIVE)) ? 1 : 0;
1147 }
1148 
is_channel_ibss(const struct iwl_channel_info * ch)1149 static inline int is_channel_ibss(const struct iwl_channel_info *ch)
1150 {
1151 	return ((ch->flags & EEPROM_CHANNEL_IBSS)) ? 1 : 0;
1152 }
1153 
1154 #endif				/* __iwl_dev_h__ */
1155