iwl-dev.h revision c8ac61cf6e53fefb3b439fc58390fb65d2730e63
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/pci.h> /* for struct pci_device_id */
35#include <linux/kernel.h>
36#include <linux/wait.h>
37#include <linux/leds.h>
38#include <net/ieee80211_radiotap.h>
39
40#include "iwl-eeprom.h"
41#include "iwl-csr.h"
42#include "iwl-prph.h"
43#include "iwl-fh.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
53#define DRV_NAME        "iwlagn"
54
55struct iwl_tx_queue;
56
57/* CT-KILL constants */
58#define CT_KILL_THRESHOLD_LEGACY   110 /* in Celsius */
59#define CT_KILL_THRESHOLD	   114 /* in Celsius */
60#define CT_KILL_EXIT_THRESHOLD     95  /* in Celsius */
61
62/* Default noise level to report when noise measurement is not available.
63 *   This may be because we're:
64 *   1)  Not associated (4965, no beacon statistics being sent to driver)
65 *   2)  Scanning (noise measurement does not apply to associated channel)
66 *   3)  Receiving CCK (3945 delivers noise info only for OFDM frames)
67 * Use default noise value of -127 ... this is below the range of measurable
68 *   Rx dBm for either 3945 or 4965, so it can indicate "unmeasurable" to user.
69 *   Also, -127 works better than 0 when averaging frames with/without
70 *   noise info (e.g. averaging might be done in app); measured dBm values are
71 *   always negative ... using a negative value as the default keeps all
72 *   averages within an s8's (used in some apps) range of negative values. */
73#define IWL_NOISE_MEAS_NOT_AVAILABLE (-127)
74
75/*
76 * RTS threshold here is total size [2347] minus 4 FCS bytes
77 * Per spec:
78 *   a value of 0 means RTS on all data/management packets
79 *   a value > max MSDU size means no RTS
80 * else RTS for data/management frames where MPDU is larger
81 *   than RTS value.
82 */
83#define DEFAULT_RTS_THRESHOLD     2347U
84#define MIN_RTS_THRESHOLD         0U
85#define MAX_RTS_THRESHOLD         2347U
86#define MAX_MSDU_SIZE		  2304U
87#define MAX_MPDU_SIZE		  2346U
88#define DEFAULT_BEACON_INTERVAL   200U
89#define	DEFAULT_SHORT_RETRY_LIMIT 7U
90#define	DEFAULT_LONG_RETRY_LIMIT  4U
91
92struct iwl_rx_mem_buffer {
93	dma_addr_t page_dma;
94	struct page *page;
95	struct list_head list;
96};
97
98#define rxb_addr(r) page_address(r->page)
99
100/* defined below */
101struct iwl_device_cmd;
102
103struct iwl_cmd_meta {
104	/* only for SYNC commands, iff the reply skb is wanted */
105	struct iwl_host_cmd *source;
106	/*
107	 * only for ASYNC commands
108	 * (which is somewhat stupid -- look at iwl-sta.c for instance
109	 * which duplicates a bunch of code because the callback isn't
110	 * invoked for SYNC commands, if it were and its result passed
111	 * through it would be simpler...)
112	 */
113	void (*callback)(struct iwl_priv *priv,
114			 struct iwl_device_cmd *cmd,
115			 struct iwl_rx_packet *pkt);
116
117	u32 flags;
118
119	DEFINE_DMA_UNMAP_ADDR(mapping);
120	DEFINE_DMA_UNMAP_LEN(len);
121};
122
123/*
124 * Generic queue structure
125 *
126 * Contains common data for Rx and Tx queues.
127 *
128 * Note the difference between n_bd and n_window: the hardware
129 * always assumes 256 descriptors, so n_bd is always 256 (unless
130 * there might be HW changes in the future). For the normal TX
131 * queues, n_window, which is the size of the software queue data
132 * is also 256; however, for the command queue, n_window is only
133 * 32 since we don't need so many commands pending. Since the HW
134 * still uses 256 BDs for DMA though, n_bd stays 256. As a result,
135 * the software buffers (in the variables @meta, @txb in struct
136 * iwl_tx_queue) only have 32 entries, while the HW buffers (@tfds
137 * in the same struct) have 256.
138 * This means that we end up with the following:
139 *  HW entries: | 0 | ... | N * 32 | ... | N * 32 + 31 | ... | 255 |
140 *  SW entries:           | 0      | ... | 31          |
141 * where N is a number between 0 and 7. This means that the SW
142 * data is a window overlayed over the HW queue.
143 */
144struct iwl_queue {
145	int n_bd;              /* number of BDs in this queue */
146	int write_ptr;       /* 1-st empty entry (index) host_w*/
147	int read_ptr;         /* last used entry (index) host_r*/
148	/* use for monitoring and recovering the stuck queue */
149	dma_addr_t dma_addr;   /* physical addr for BD's */
150	int n_window;	       /* safe queue window */
151	u32 id;
152	int low_mark;	       /* low watermark, resume queue if free
153				* space more than this */
154	int high_mark;         /* high watermark, stop queue if free
155				* space less than this */
156};
157
158/* One for each TFD */
159struct iwl_tx_info {
160	struct sk_buff *skb;
161	struct iwl_rxon_context *ctx;
162};
163
164/**
165 * struct iwl_tx_queue - Tx Queue for DMA
166 * @q: generic Rx/Tx queue descriptor
167 * @bd: base of circular buffer of TFDs
168 * @cmd: array of command/TX buffer pointers
169 * @meta: array of meta data for each command/tx buffer
170 * @dma_addr_cmd: physical address of cmd/tx buffer array
171 * @txb: array of per-TFD driver data
172 * @time_stamp: time (in jiffies) of last read_ptr change
173 * @need_update: indicates need to update read/write index
174 * @sched_retry: indicates queue is high-throughput aggregation (HT AGG) enabled
175 *
176 * A Tx queue consists of circular buffer of BDs (a.k.a. TFDs, transmit frame
177 * descriptors) and required locking structures.
178 */
179#define TFD_TX_CMD_SLOTS 256
180#define TFD_CMD_SLOTS 32
181
182struct iwl_tx_queue {
183	struct iwl_queue q;
184	struct iwl_tfd *tfds;
185	struct iwl_device_cmd **cmd;
186	struct iwl_cmd_meta *meta;
187	struct iwl_tx_info *txb;
188	unsigned long time_stamp;
189	u8 need_update;
190	u8 sched_retry;
191	u8 active;
192	u8 swq_id;
193};
194
195#define IWL_NUM_SCAN_RATES         (2)
196
197/*
198 * One for each channel, holds all channel setup data
199 * Some of the fields (e.g. eeprom and flags/max_power_avg) are redundant
200 *     with one another!
201 */
202struct iwl_channel_info {
203	struct iwl_eeprom_channel eeprom;	/* EEPROM regulatory limit */
204	struct iwl_eeprom_channel ht40_eeprom;	/* EEPROM regulatory limit for
205						 * HT40 channel */
206
207	u8 channel;	  /* channel number */
208	u8 flags;	  /* flags copied from EEPROM */
209	s8 max_power_avg; /* (dBm) regul. eeprom, normal Tx, any rate */
210	s8 curr_txpow;	  /* (dBm) regulatory/spectrum/user (not h/w) limit */
211	s8 min_power;	  /* always 0 */
212	s8 scan_power;	  /* (dBm) regul. eeprom, direct scans, any rate */
213
214	u8 group_index;	  /* 0-4, maps channel to group1/2/3/4/5 */
215	u8 band_index;	  /* 0-4, maps channel to band1/2/3/4/5 */
216	enum ieee80211_band band;
217
218	/* HT40 channel info */
219	s8 ht40_max_power_avg;	/* (dBm) regul. eeprom, normal Tx, any rate */
220	u8 ht40_flags;		/* flags copied from EEPROM */
221	u8 ht40_extension_channel; /* HT_IE_EXT_CHANNEL_* */
222};
223
224#define IWL_TX_FIFO_BK		0	/* shared */
225#define IWL_TX_FIFO_BE		1
226#define IWL_TX_FIFO_VI		2	/* shared */
227#define IWL_TX_FIFO_VO		3
228#define IWL_TX_FIFO_BK_IPAN	IWL_TX_FIFO_BK
229#define IWL_TX_FIFO_BE_IPAN	4
230#define IWL_TX_FIFO_VI_IPAN	IWL_TX_FIFO_VI
231#define IWL_TX_FIFO_VO_IPAN	5
232#define IWL_TX_FIFO_UNUSED	-1
233
234/* Minimum number of queues. MAX_NUM is defined in hw specific files.
235 * Set the minimum to accommodate the 4 standard TX queues, 1 command
236 * queue, 2 (unused) HCCA queues, and 4 HT queues (one for each AC) */
237#define IWL_MIN_NUM_QUEUES	10
238
239/*
240 * Command queue depends on iPAN support.
241 */
242#define IWL_DEFAULT_CMD_QUEUE_NUM	4
243#define IWL_IPAN_CMD_QUEUE_NUM		9
244
245/*
246 * This queue number is required for proper operation
247 * because the ucode will stop/start the scheduler as
248 * required.
249 */
250#define IWL_IPAN_MCAST_QUEUE		8
251
252#define IEEE80211_DATA_LEN              2304
253#define IEEE80211_4ADDR_LEN             30
254#define IEEE80211_HLEN                  (IEEE80211_4ADDR_LEN)
255#define IEEE80211_FRAME_LEN             (IEEE80211_DATA_LEN + IEEE80211_HLEN)
256
257
258#define SEQ_TO_SN(seq) (((seq) & IEEE80211_SCTL_SEQ) >> 4)
259#define SN_TO_SEQ(ssn) (((ssn) << 4) & IEEE80211_SCTL_SEQ)
260#define MAX_SN ((IEEE80211_SCTL_SEQ) >> 4)
261
262enum {
263	CMD_SYNC = 0,
264	CMD_ASYNC = BIT(0),
265	CMD_WANT_SKB = BIT(1),
266	CMD_ON_DEMAND = BIT(2),
267};
268
269#define DEF_CMD_PAYLOAD_SIZE 320
270
271/**
272 * struct iwl_device_cmd
273 *
274 * For allocation of the command and tx queues, this establishes the overall
275 * size of the largest command we send to uCode, except for commands that
276 * aren't fully copied and use other TFD space.
277 */
278struct iwl_device_cmd {
279	struct iwl_cmd_header hdr;	/* uCode API */
280	union {
281		u32 flags;
282		u8 val8;
283		u16 val16;
284		u32 val32;
285		struct iwl_tx_cmd tx;
286		struct iwl6000_channel_switch_cmd chswitch;
287		u8 payload[DEF_CMD_PAYLOAD_SIZE];
288	} __packed cmd;
289} __packed;
290
291#define TFD_MAX_PAYLOAD_SIZE (sizeof(struct iwl_device_cmd))
292
293#define IWL_MAX_CMD_TFDS	2
294
295enum iwl_hcmd_dataflag {
296	IWL_HCMD_DFL_NOCOPY	= BIT(0),
297};
298
299/**
300 * struct iwl_host_cmd - Host command to the uCode
301 * @data: array of chunks that composes the data of the host command
302 * @reply_page: pointer to the page that holds the response to the host command
303 * @callback:
304 * @flags: can be CMD_* note CMD_WANT_SKB is incompatible withe CMD_ASYNC
305 * @len: array of the lenths of the chunks in data
306 * @dataflags:
307 * @id: id of the host command
308 */
309struct iwl_host_cmd {
310	const void *data[IWL_MAX_CMD_TFDS];
311	unsigned long reply_page;
312	void (*callback)(struct iwl_priv *priv,
313			 struct iwl_device_cmd *cmd,
314			 struct iwl_rx_packet *pkt);
315	u32 flags;
316	u16 len[IWL_MAX_CMD_TFDS];
317	u8 dataflags[IWL_MAX_CMD_TFDS];
318	u8 id;
319};
320
321#define SUP_RATE_11A_MAX_NUM_CHANNELS  8
322#define SUP_RATE_11B_MAX_NUM_CHANNELS  4
323#define SUP_RATE_11G_MAX_NUM_CHANNELS  12
324
325/**
326 * struct iwl_rx_queue - Rx queue
327 * @bd: driver's pointer to buffer of receive buffer descriptors (rbd)
328 * @bd_dma: bus address of buffer of receive buffer descriptors (rbd)
329 * @read: Shared index to newest available Rx buffer
330 * @write: Shared index to oldest written Rx packet
331 * @free_count: Number of pre-allocated buffers in rx_free
332 * @rx_free: list of free SKBs for use
333 * @rx_used: List of Rx buffers with no SKB
334 * @need_update: flag to indicate we need to update read/write index
335 * @rb_stts: driver's pointer to receive buffer status
336 * @rb_stts_dma: bus address of receive buffer status
337 *
338 * NOTE:  rx_free and rx_used are used as a FIFO for iwl_rx_mem_buffers
339 */
340struct iwl_rx_queue {
341	__le32 *bd;
342	dma_addr_t bd_dma;
343	struct iwl_rx_mem_buffer pool[RX_QUEUE_SIZE + RX_FREE_BUFFERS];
344	struct iwl_rx_mem_buffer *queue[RX_QUEUE_SIZE];
345	u32 read;
346	u32 write;
347	u32 free_count;
348	u32 write_actual;
349	struct list_head rx_free;
350	struct list_head rx_used;
351	int need_update;
352	struct iwl_rb_status *rb_stts;
353	dma_addr_t rb_stts_dma;
354	spinlock_t lock;
355};
356
357#define IWL_SUPPORTED_RATES_IE_LEN         8
358
359#define MAX_TID_COUNT        9
360
361#define IWL_INVALID_RATE     0xFF
362#define IWL_INVALID_VALUE    -1
363
364/**
365 * struct iwl_ht_agg -- aggregation status while waiting for block-ack
366 * @txq_id: Tx queue used for Tx attempt
367 * @frame_count: # frames attempted by Tx command
368 * @wait_for_ba: Expect block-ack before next Tx reply
369 * @start_idx: Index of 1st Transmit Frame Descriptor (TFD) in Tx window
370 * @bitmap0: Low order bitmap, one bit for each frame pending ACK in Tx window
371 * @bitmap1: High order, one bit for each frame pending ACK in Tx window
372 * @rate_n_flags: Rate at which Tx was attempted
373 *
374 * If REPLY_TX indicates that aggregation was attempted, driver must wait
375 * for block ack (REPLY_COMPRESSED_BA).  This struct stores tx reply info
376 * until block ack arrives.
377 */
378struct iwl_ht_agg {
379	u16 txq_id;
380	u16 frame_count;
381	u16 wait_for_ba;
382	u16 start_idx;
383	u64 bitmap;
384	u32 rate_n_flags;
385#define IWL_AGG_OFF 0
386#define IWL_AGG_ON 1
387#define IWL_EMPTYING_HW_QUEUE_ADDBA 2
388#define IWL_EMPTYING_HW_QUEUE_DELBA 3
389	u8 state;
390	u8 tx_fifo;
391};
392
393
394struct iwl_tid_data {
395	u16 seq_number; /* agn only */
396	u16 tfds_in_queue;
397	struct iwl_ht_agg agg;
398};
399
400union iwl_ht_rate_supp {
401	u16 rates;
402	struct {
403		u8 siso_rate;
404		u8 mimo_rate;
405	};
406};
407
408#define CFG_HT_RX_AMPDU_FACTOR_8K   (0x0)
409#define CFG_HT_RX_AMPDU_FACTOR_16K  (0x1)
410#define CFG_HT_RX_AMPDU_FACTOR_32K  (0x2)
411#define CFG_HT_RX_AMPDU_FACTOR_64K  (0x3)
412#define CFG_HT_RX_AMPDU_FACTOR_DEF  CFG_HT_RX_AMPDU_FACTOR_64K
413#define CFG_HT_RX_AMPDU_FACTOR_MAX  CFG_HT_RX_AMPDU_FACTOR_64K
414#define CFG_HT_RX_AMPDU_FACTOR_MIN  CFG_HT_RX_AMPDU_FACTOR_8K
415
416/*
417 * Maximal MPDU density for TX aggregation
418 * 4 - 2us density
419 * 5 - 4us density
420 * 6 - 8us density
421 * 7 - 16us density
422 */
423#define CFG_HT_MPDU_DENSITY_2USEC   (0x4)
424#define CFG_HT_MPDU_DENSITY_4USEC   (0x5)
425#define CFG_HT_MPDU_DENSITY_8USEC   (0x6)
426#define CFG_HT_MPDU_DENSITY_16USEC  (0x7)
427#define CFG_HT_MPDU_DENSITY_DEF CFG_HT_MPDU_DENSITY_4USEC
428#define CFG_HT_MPDU_DENSITY_MAX CFG_HT_MPDU_DENSITY_16USEC
429#define CFG_HT_MPDU_DENSITY_MIN     (0x1)
430
431struct iwl_ht_config {
432	bool single_chain_sufficient;
433	enum ieee80211_smps_mode smps; /* current smps mode */
434};
435
436/* QoS structures */
437struct iwl_qos_info {
438	int qos_active;
439	struct iwl_qosparam_cmd def_qos_parm;
440};
441
442/*
443 * Structure should be accessed with sta_lock held. When station addition
444 * is in progress (IWL_STA_UCODE_INPROGRESS) it is possible to access only
445 * the commands (iwl_addsta_cmd and iwl_link_quality_cmd) without sta_lock
446 * held.
447 */
448struct iwl_station_entry {
449	struct iwl_addsta_cmd sta;
450	struct iwl_tid_data tid[MAX_TID_COUNT];
451	u8 used, ctxid;
452	struct iwl_link_quality_cmd *lq;
453};
454
455struct iwl_station_priv_common {
456	struct iwl_rxon_context *ctx;
457	u8 sta_id;
458};
459
460/*
461 * iwl_station_priv: Driver's private station information
462 *
463 * When mac80211 creates a station it reserves some space (hw->sta_data_size)
464 * in the structure for use by driver. This structure is places in that
465 * space.
466 */
467struct iwl_station_priv {
468	struct iwl_station_priv_common common;
469	struct iwl_lq_sta lq_sta;
470	atomic_t pending_frames;
471	bool client;
472	bool asleep;
473	u8 max_agg_bufsize;
474};
475
476/**
477 * struct iwl_vif_priv - driver's private per-interface information
478 *
479 * When mac80211 allocates a virtual interface, it can allocate
480 * space for us to put data into.
481 */
482struct iwl_vif_priv {
483	struct iwl_rxon_context *ctx;
484	u8 ibss_bssid_sta_id;
485};
486
487/* one for each uCode image (inst/data, boot/init/runtime) */
488struct fw_desc {
489	void *v_addr;		/* access by driver */
490	dma_addr_t p_addr;	/* access by card's busmaster DMA */
491	u32 len;		/* bytes */
492};
493
494struct fw_img {
495	struct fw_desc code, data;
496};
497
498/* v1/v2 uCode file layout */
499struct iwl_ucode_header {
500	__le32 ver;	/* major/minor/API/serial */
501	union {
502		struct {
503			__le32 inst_size;	/* bytes of runtime code */
504			__le32 data_size;	/* bytes of runtime data */
505			__le32 init_size;	/* bytes of init code */
506			__le32 init_data_size;	/* bytes of init data */
507			__le32 boot_size;	/* bytes of bootstrap code */
508			u8 data[0];		/* in same order as sizes */
509		} v1;
510		struct {
511			__le32 build;		/* build number */
512			__le32 inst_size;	/* bytes of runtime code */
513			__le32 data_size;	/* bytes of runtime data */
514			__le32 init_size;	/* bytes of init code */
515			__le32 init_data_size;	/* bytes of init data */
516			__le32 boot_size;	/* bytes of bootstrap code */
517			u8 data[0];		/* in same order as sizes */
518		} v2;
519	} u;
520};
521
522/*
523 * new TLV uCode file layout
524 *
525 * The new TLV file format contains TLVs, that each specify
526 * some piece of data. To facilitate "groups", for example
527 * different instruction image with different capabilities,
528 * bundled with the same init image, an alternative mechanism
529 * is provided:
530 * When the alternative field is 0, that means that the item
531 * is always valid. When it is non-zero, then it is only
532 * valid in conjunction with items of the same alternative,
533 * in which case the driver (user) selects one alternative
534 * to use.
535 */
536
537enum iwl_ucode_tlv_type {
538	IWL_UCODE_TLV_INVALID		= 0, /* unused */
539	IWL_UCODE_TLV_INST		= 1,
540	IWL_UCODE_TLV_DATA		= 2,
541	IWL_UCODE_TLV_INIT		= 3,
542	IWL_UCODE_TLV_INIT_DATA		= 4,
543	IWL_UCODE_TLV_BOOT		= 5,
544	IWL_UCODE_TLV_PROBE_MAX_LEN	= 6, /* a u32 value */
545	IWL_UCODE_TLV_PAN		= 7,
546	IWL_UCODE_TLV_RUNT_EVTLOG_PTR	= 8,
547	IWL_UCODE_TLV_RUNT_EVTLOG_SIZE	= 9,
548	IWL_UCODE_TLV_RUNT_ERRLOG_PTR	= 10,
549	IWL_UCODE_TLV_INIT_EVTLOG_PTR	= 11,
550	IWL_UCODE_TLV_INIT_EVTLOG_SIZE	= 12,
551	IWL_UCODE_TLV_INIT_ERRLOG_PTR	= 13,
552	IWL_UCODE_TLV_ENHANCE_SENS_TBL	= 14,
553	IWL_UCODE_TLV_PHY_CALIBRATION_SIZE = 15,
554	IWL_UCODE_TLV_WOWLAN_INST	= 16,
555	IWL_UCODE_TLV_WOWLAN_DATA	= 17,
556	IWL_UCODE_TLV_FLAGS		= 18,
557};
558
559/**
560 * enum iwl_ucode_tlv_flag - ucode API flags
561 * @IWL_UCODE_TLV_FLAGS_PAN: This is PAN capable microcode; this previously
562 *	was a separate TLV but moved here to save space.
563 * @IWL_UCODE_TLV_FLAGS_NEWSCAN: new uCode scan behaviour on hidden SSID,
564 *	treats good CRC threshold as a boolean
565 * @IWL_UCODE_TLV_FLAGS_MFP: This uCode image supports MFP (802.11w).
566 */
567enum iwl_ucode_tlv_flag {
568	IWL_UCODE_TLV_FLAGS_PAN		= BIT(0),
569	IWL_UCODE_TLV_FLAGS_NEWSCAN	= BIT(1),
570	IWL_UCODE_TLV_FLAGS_MFP		= BIT(2),
571};
572
573struct iwl_ucode_tlv {
574	__le16 type;		/* see above */
575	__le16 alternative;	/* see comment */
576	__le32 length;		/* not including type/length fields */
577	u8 data[0];
578} __packed;
579
580#define IWL_TLV_UCODE_MAGIC	0x0a4c5749
581
582struct iwl_tlv_ucode_header {
583	/*
584	 * The TLV style ucode header is distinguished from
585	 * the v1/v2 style header by first four bytes being
586	 * zero, as such is an invalid combination of
587	 * major/minor/API/serial versions.
588	 */
589	__le32 zero;
590	__le32 magic;
591	u8 human_readable[64];
592	__le32 ver;		/* major/minor/API/serial */
593	__le32 build;
594	__le64 alternatives;	/* bitmask of valid alternatives */
595	/*
596	 * The data contained herein has a TLV layout,
597	 * see above for the TLV header and types.
598	 * Note that each TLV is padded to a length
599	 * that is a multiple of 4 for alignment.
600	 */
601	u8 data[0];
602};
603
604struct iwl_sensitivity_ranges {
605	u16 min_nrg_cck;
606	u16 max_nrg_cck;
607
608	u16 nrg_th_cck;
609	u16 nrg_th_ofdm;
610
611	u16 auto_corr_min_ofdm;
612	u16 auto_corr_min_ofdm_mrc;
613	u16 auto_corr_min_ofdm_x1;
614	u16 auto_corr_min_ofdm_mrc_x1;
615
616	u16 auto_corr_max_ofdm;
617	u16 auto_corr_max_ofdm_mrc;
618	u16 auto_corr_max_ofdm_x1;
619	u16 auto_corr_max_ofdm_mrc_x1;
620
621	u16 auto_corr_max_cck;
622	u16 auto_corr_max_cck_mrc;
623	u16 auto_corr_min_cck;
624	u16 auto_corr_min_cck_mrc;
625
626	u16 barker_corr_th_min;
627	u16 barker_corr_th_min_mrc;
628	u16 nrg_th_cca;
629};
630
631
632#define KELVIN_TO_CELSIUS(x) ((x)-273)
633#define CELSIUS_TO_KELVIN(x) ((x)+273)
634
635
636/**
637 * struct iwl_hw_params
638 * @max_txq_num: Max # Tx queues supported
639 * @scd_bc_tbls_size: size of scheduler byte count tables
640 * @tfd_size: TFD size
641 * @tx/rx_chains_num: Number of TX/RX chains
642 * @valid_tx/rx_ant: usable antennas
643 * @max_rxq_size: Max # Rx frames in Rx queue (must be power-of-2)
644 * @max_rxq_log: Log-base-2 of max_rxq_size
645 * @rx_page_order: Rx buffer page order
646 * @rx_wrt_ptr_reg: FH{39}_RSCSR_CHNL0_WPTR
647 * @max_stations:
648 * @ht40_channel: is 40MHz width possible in band 2.4
649 * BIT(IEEE80211_BAND_5GHZ) BIT(IEEE80211_BAND_5GHZ)
650 * @sw_crypto: 0 for hw, 1 for sw
651 * @max_xxx_size: for ucode uses
652 * @ct_kill_threshold: temperature threshold
653 * @beacon_time_tsf_bits: number of valid tsf bits for beacon time
654 * @calib_init_cfg: setup initial calibrations for the hw
655 * @calib_rt_cfg: setup runtime calibrations for the hw
656 * @struct iwl_sensitivity_ranges: range of sensitivity values
657 */
658struct iwl_hw_params {
659	u8 max_txq_num;
660	u16 scd_bc_tbls_size;
661	u32 tfd_size;
662	u8  tx_chains_num;
663	u8  rx_chains_num;
664	u8  valid_tx_ant;
665	u8  valid_rx_ant;
666	u16 max_rxq_size;
667	u16 max_rxq_log;
668	u32 rx_page_order;
669	u8  max_stations;
670	u8  ht40_channel;
671	u8  max_beacon_itrvl;	/* in 1024 ms */
672	u32 max_inst_size;
673	u32 max_data_size;
674	u32 ct_kill_threshold; /* value in hw-dependent units */
675	u32 ct_kill_exit_threshold; /* value in hw-dependent units */
676				    /* for 1000, 6000 series and up */
677	u16 beacon_time_tsf_bits;
678	u32 calib_init_cfg;
679	u32 calib_rt_cfg;
680	const struct iwl_sensitivity_ranges *sens;
681};
682
683
684/******************************************************************************
685 *
686 * Functions implemented in core module which are forward declared here
687 * for use by iwl-[4-5].c
688 *
689 * NOTE:  The implementation of these functions are not hardware specific
690 * which is why they are in the core module files.
691 *
692 * Naming convention --
693 * iwl_         <-- Is part of iwlwifi
694 * iwlXXXX_     <-- Hardware specific (implemented in iwl-XXXX.c for XXXX)
695 *
696 ****************************************************************************/
697extern void iwl_update_chain_flags(struct iwl_priv *priv);
698extern const u8 iwl_bcast_addr[ETH_ALEN];
699extern int iwl_queue_space(const struct iwl_queue *q);
700static inline int iwl_queue_used(const struct iwl_queue *q, int i)
701{
702	return q->write_ptr >= q->read_ptr ?
703		(i >= q->read_ptr && i < q->write_ptr) :
704		!(i < q->read_ptr && i >= q->write_ptr);
705}
706
707
708static inline u8 get_cmd_index(struct iwl_queue *q, u32 index)
709{
710	return index & (q->n_window - 1);
711}
712
713
714struct iwl_dma_ptr {
715	dma_addr_t dma;
716	void *addr;
717	size_t size;
718};
719
720#define IWL_OPERATION_MODE_AUTO     0
721#define IWL_OPERATION_MODE_HT_ONLY  1
722#define IWL_OPERATION_MODE_MIXED    2
723#define IWL_OPERATION_MODE_20MHZ    3
724
725#define IWL_TX_CRC_SIZE 4
726#define IWL_TX_DELIMITER_SIZE 4
727
728#define TX_POWER_IWL_ILLEGAL_VOLTAGE -10000
729
730/* Sensitivity and chain noise calibration */
731#define INITIALIZATION_VALUE		0xFFFF
732#define IWL_CAL_NUM_BEACONS		16
733#define MAXIMUM_ALLOWED_PATHLOSS	15
734
735#define CHAIN_NOISE_MAX_DELTA_GAIN_CODE 3
736
737#define MAX_FA_OFDM  50
738#define MIN_FA_OFDM  5
739#define MAX_FA_CCK   50
740#define MIN_FA_CCK   5
741
742#define AUTO_CORR_STEP_OFDM       1
743
744#define AUTO_CORR_STEP_CCK     3
745#define AUTO_CORR_MAX_TH_CCK   160
746
747#define NRG_DIFF               2
748#define NRG_STEP_CCK           2
749#define NRG_MARGIN             8
750#define MAX_NUMBER_CCK_NO_FA 100
751
752#define AUTO_CORR_CCK_MIN_VAL_DEF    (125)
753
754#define CHAIN_A             0
755#define CHAIN_B             1
756#define CHAIN_C             2
757#define CHAIN_NOISE_DELTA_GAIN_INIT_VAL 4
758#define ALL_BAND_FILTER			0xFF00
759#define IN_BAND_FILTER			0xFF
760#define MIN_AVERAGE_NOISE_MAX_VALUE	0xFFFFFFFF
761
762#define NRG_NUM_PREV_STAT_L     20
763#define NUM_RX_CHAINS           3
764
765enum iwlagn_false_alarm_state {
766	IWL_FA_TOO_MANY = 0,
767	IWL_FA_TOO_FEW = 1,
768	IWL_FA_GOOD_RANGE = 2,
769};
770
771enum iwlagn_chain_noise_state {
772	IWL_CHAIN_NOISE_ALIVE = 0,  /* must be 0 */
773	IWL_CHAIN_NOISE_ACCUMULATE,
774	IWL_CHAIN_NOISE_CALIBRATED,
775	IWL_CHAIN_NOISE_DONE,
776};
777
778
779/*
780 * enum iwl_calib
781 * defines the order in which results of initial calibrations
782 * should be sent to the runtime uCode
783 */
784enum iwl_calib {
785	IWL_CALIB_XTAL,
786	IWL_CALIB_DC,
787	IWL_CALIB_LO,
788	IWL_CALIB_TX_IQ,
789	IWL_CALIB_TX_IQ_PERD,
790	IWL_CALIB_BASE_BAND,
791	IWL_CALIB_TEMP_OFFSET,
792	IWL_CALIB_MAX
793};
794
795/* Opaque calibration results */
796struct iwl_calib_result {
797	void *buf;
798	size_t buf_len;
799};
800
801/* Sensitivity calib data */
802struct iwl_sensitivity_data {
803	u32 auto_corr_ofdm;
804	u32 auto_corr_ofdm_mrc;
805	u32 auto_corr_ofdm_x1;
806	u32 auto_corr_ofdm_mrc_x1;
807	u32 auto_corr_cck;
808	u32 auto_corr_cck_mrc;
809
810	u32 last_bad_plcp_cnt_ofdm;
811	u32 last_fa_cnt_ofdm;
812	u32 last_bad_plcp_cnt_cck;
813	u32 last_fa_cnt_cck;
814
815	u32 nrg_curr_state;
816	u32 nrg_prev_state;
817	u32 nrg_value[10];
818	u8  nrg_silence_rssi[NRG_NUM_PREV_STAT_L];
819	u32 nrg_silence_ref;
820	u32 nrg_energy_idx;
821	u32 nrg_silence_idx;
822	u32 nrg_th_cck;
823	s32 nrg_auto_corr_silence_diff;
824	u32 num_in_cck_no_fa;
825	u32 nrg_th_ofdm;
826
827	u16 barker_corr_th_min;
828	u16 barker_corr_th_min_mrc;
829	u16 nrg_th_cca;
830};
831
832/* Chain noise (differential Rx gain) calib data */
833struct iwl_chain_noise_data {
834	u32 active_chains;
835	u32 chain_noise_a;
836	u32 chain_noise_b;
837	u32 chain_noise_c;
838	u32 chain_signal_a;
839	u32 chain_signal_b;
840	u32 chain_signal_c;
841	u16 beacon_count;
842	u8 disconn_array[NUM_RX_CHAINS];
843	u8 delta_gain_code[NUM_RX_CHAINS];
844	u8 radio_write;
845	u8 state;
846};
847
848#define	EEPROM_SEM_TIMEOUT 10		/* milliseconds */
849#define EEPROM_SEM_RETRY_LIMIT 1000	/* number of attempts (not time) */
850
851#define IWL_TRAFFIC_ENTRIES	(256)
852#define IWL_TRAFFIC_ENTRY_SIZE  (64)
853
854enum {
855	MEASUREMENT_READY = (1 << 0),
856	MEASUREMENT_ACTIVE = (1 << 1),
857};
858
859enum iwl_nvm_type {
860	NVM_DEVICE_TYPE_EEPROM = 0,
861	NVM_DEVICE_TYPE_OTP,
862};
863
864/*
865 * Two types of OTP memory access modes
866 *   IWL_OTP_ACCESS_ABSOLUTE - absolute address mode,
867 * 			        based on physical memory addressing
868 *   IWL_OTP_ACCESS_RELATIVE - relative address mode,
869 * 			       based on logical memory addressing
870 */
871enum iwl_access_mode {
872	IWL_OTP_ACCESS_ABSOLUTE,
873	IWL_OTP_ACCESS_RELATIVE,
874};
875
876/**
877 * enum iwl_pa_type - Power Amplifier type
878 * @IWL_PA_SYSTEM:  based on uCode configuration
879 * @IWL_PA_INTERNAL: use Internal only
880 */
881enum iwl_pa_type {
882	IWL_PA_SYSTEM = 0,
883	IWL_PA_INTERNAL = 1,
884};
885
886/* interrupt statistics */
887struct isr_statistics {
888	u32 hw;
889	u32 sw;
890	u32 err_code;
891	u32 sch;
892	u32 alive;
893	u32 rfkill;
894	u32 ctkill;
895	u32 wakeup;
896	u32 rx;
897	u32 rx_handlers[REPLY_MAX];
898	u32 tx;
899	u32 unhandled;
900};
901
902/* reply_tx_statistics (for _agn devices) */
903struct reply_tx_error_statistics {
904	u32 pp_delay;
905	u32 pp_few_bytes;
906	u32 pp_bt_prio;
907	u32 pp_quiet_period;
908	u32 pp_calc_ttak;
909	u32 int_crossed_retry;
910	u32 short_limit;
911	u32 long_limit;
912	u32 fifo_underrun;
913	u32 drain_flow;
914	u32 rfkill_flush;
915	u32 life_expire;
916	u32 dest_ps;
917	u32 host_abort;
918	u32 bt_retry;
919	u32 sta_invalid;
920	u32 frag_drop;
921	u32 tid_disable;
922	u32 fifo_flush;
923	u32 insuff_cf_poll;
924	u32 fail_hw_drop;
925	u32 sta_color_mismatch;
926	u32 unknown;
927};
928
929/* reply_agg_tx_statistics (for _agn devices) */
930struct reply_agg_tx_error_statistics {
931	u32 underrun;
932	u32 bt_prio;
933	u32 few_bytes;
934	u32 abort;
935	u32 last_sent_ttl;
936	u32 last_sent_try;
937	u32 last_sent_bt_kill;
938	u32 scd_query;
939	u32 bad_crc32;
940	u32 response;
941	u32 dump_tx;
942	u32 delay_tx;
943	u32 unknown;
944};
945
946/* management statistics */
947enum iwl_mgmt_stats {
948	MANAGEMENT_ASSOC_REQ = 0,
949	MANAGEMENT_ASSOC_RESP,
950	MANAGEMENT_REASSOC_REQ,
951	MANAGEMENT_REASSOC_RESP,
952	MANAGEMENT_PROBE_REQ,
953	MANAGEMENT_PROBE_RESP,
954	MANAGEMENT_BEACON,
955	MANAGEMENT_ATIM,
956	MANAGEMENT_DISASSOC,
957	MANAGEMENT_AUTH,
958	MANAGEMENT_DEAUTH,
959	MANAGEMENT_ACTION,
960	MANAGEMENT_MAX,
961};
962/* control statistics */
963enum iwl_ctrl_stats {
964	CONTROL_BACK_REQ =  0,
965	CONTROL_BACK,
966	CONTROL_PSPOLL,
967	CONTROL_RTS,
968	CONTROL_CTS,
969	CONTROL_ACK,
970	CONTROL_CFEND,
971	CONTROL_CFENDACK,
972	CONTROL_MAX,
973};
974
975struct traffic_stats {
976#ifdef CONFIG_IWLWIFI_DEBUGFS
977	u32 mgmt[MANAGEMENT_MAX];
978	u32 ctrl[CONTROL_MAX];
979	u32 data_cnt;
980	u64 data_bytes;
981#endif
982};
983
984/*
985 * schedule the timer to wake up every UCODE_TRACE_PERIOD milliseconds
986 * to perform continuous uCode event logging operation if enabled
987 */
988#define UCODE_TRACE_PERIOD (100)
989
990/*
991 * iwl_event_log: current uCode event log position
992 *
993 * @ucode_trace: enable/disable ucode continuous trace timer
994 * @num_wraps: how many times the event buffer wraps
995 * @next_entry:  the entry just before the next one that uCode would fill
996 * @non_wraps_count: counter for no wrap detected when dump ucode events
997 * @wraps_once_count: counter for wrap once detected when dump ucode events
998 * @wraps_more_count: counter for wrap more than once detected
999 *		      when dump ucode events
1000 */
1001struct iwl_event_log {
1002	bool ucode_trace;
1003	u32 num_wraps;
1004	u32 next_entry;
1005	int non_wraps_count;
1006	int wraps_once_count;
1007	int wraps_more_count;
1008};
1009
1010/*
1011 * host interrupt timeout value
1012 * used with setting interrupt coalescing timer
1013 * the CSR_INT_COALESCING is an 8 bit register in 32-usec unit
1014 *
1015 * default interrupt coalescing timer is 64 x 32 = 2048 usecs
1016 * default interrupt coalescing calibration timer is 16 x 32 = 512 usecs
1017 */
1018#define IWL_HOST_INT_TIMEOUT_MAX	(0xFF)
1019#define IWL_HOST_INT_TIMEOUT_DEF	(0x40)
1020#define IWL_HOST_INT_TIMEOUT_MIN	(0x0)
1021#define IWL_HOST_INT_CALIB_TIMEOUT_MAX	(0xFF)
1022#define IWL_HOST_INT_CALIB_TIMEOUT_DEF	(0x10)
1023#define IWL_HOST_INT_CALIB_TIMEOUT_MIN	(0x0)
1024
1025/*
1026 * This is the threshold value of plcp error rate per 100mSecs.  It is
1027 * used to set and check for the validity of plcp_delta.
1028 */
1029#define IWL_MAX_PLCP_ERR_THRESHOLD_MIN	(1)
1030#define IWL_MAX_PLCP_ERR_THRESHOLD_DEF	(50)
1031#define IWL_MAX_PLCP_ERR_LONG_THRESHOLD_DEF	(100)
1032#define IWL_MAX_PLCP_ERR_EXT_LONG_THRESHOLD_DEF	(200)
1033#define IWL_MAX_PLCP_ERR_THRESHOLD_MAX	(255)
1034#define IWL_MAX_PLCP_ERR_THRESHOLD_DISABLE	(0)
1035
1036#define IWL_DELAY_NEXT_FORCE_RF_RESET  (HZ*3)
1037#define IWL_DELAY_NEXT_FORCE_FW_RELOAD (HZ*5)
1038
1039/* TX queue watchdog timeouts in mSecs */
1040#define IWL_DEF_WD_TIMEOUT	(2000)
1041#define IWL_LONG_WD_TIMEOUT	(10000)
1042#define IWL_MAX_WD_TIMEOUT	(120000)
1043
1044/* BT Antenna Coupling Threshold (dB) */
1045#define IWL_BT_ANTENNA_COUPLING_THRESHOLD	(35)
1046
1047/* Firmware reload counter and Timestamp */
1048#define IWL_MIN_RELOAD_DURATION		1000 /* 1000 ms */
1049#define IWL_MAX_CONTINUE_RELOAD_CNT	4
1050
1051
1052enum iwl_reset {
1053	IWL_RF_RESET = 0,
1054	IWL_FW_RESET,
1055	IWL_MAX_FORCE_RESET,
1056};
1057
1058struct iwl_force_reset {
1059	int reset_request_count;
1060	int reset_success_count;
1061	int reset_reject_count;
1062	unsigned long reset_duration;
1063	unsigned long last_force_reset_jiffies;
1064};
1065
1066/* extend beacon time format bit shifting  */
1067/*
1068 * for _agn devices
1069 * bits 31:22 - extended
1070 * bits 21:0  - interval
1071 */
1072#define IWLAGN_EXT_BEACON_TIME_POS	22
1073
1074/**
1075 * struct iwl_notification_wait - notification wait entry
1076 * @list: list head for global list
1077 * @fn: function called with the notification
1078 * @cmd: command ID
1079 *
1080 * This structure is not used directly, to wait for a
1081 * notification declare it on the stack, and call
1082 * iwlagn_init_notification_wait() with appropriate
1083 * parameters. Then do whatever will cause the ucode
1084 * to notify the driver, and to wait for that then
1085 * call iwlagn_wait_notification().
1086 *
1087 * Each notification is one-shot. If at some point we
1088 * need to support multi-shot notifications (which
1089 * can't be allocated on the stack) we need to modify
1090 * the code for them.
1091 */
1092struct iwl_notification_wait {
1093	struct list_head list;
1094
1095	void (*fn)(struct iwl_priv *priv, struct iwl_rx_packet *pkt,
1096		   void *data);
1097	void *fn_data;
1098
1099	u8 cmd;
1100	bool triggered, aborted;
1101};
1102
1103enum iwl_rxon_context_id {
1104	IWL_RXON_CTX_BSS,
1105	IWL_RXON_CTX_PAN,
1106
1107	NUM_IWL_RXON_CTX
1108};
1109
1110struct iwl_rxon_context {
1111	struct ieee80211_vif *vif;
1112
1113	const u8 *ac_to_fifo;
1114	const u8 *ac_to_queue;
1115	u8 mcast_queue;
1116
1117	/*
1118	 * We could use the vif to indicate active, but we
1119	 * also need it to be active during disabling when
1120	 * we already removed the vif for type setting.
1121	 */
1122	bool always_active, is_active;
1123
1124	bool ht_need_multiple_chains;
1125
1126	enum iwl_rxon_context_id ctxid;
1127
1128	u32 interface_modes, exclusive_interface_modes;
1129	u8 unused_devtype, ap_devtype, ibss_devtype, station_devtype;
1130
1131	/*
1132	 * We declare this const so it can only be
1133	 * changed via explicit cast within the
1134	 * routines that actually update the physical
1135	 * hardware.
1136	 */
1137	const struct iwl_rxon_cmd active;
1138	struct iwl_rxon_cmd staging;
1139
1140	struct iwl_rxon_time_cmd timing;
1141
1142	struct iwl_qos_info qos_data;
1143
1144	u8 bcast_sta_id, ap_sta_id;
1145
1146	u8 rxon_cmd, rxon_assoc_cmd, rxon_timing_cmd;
1147	u8 qos_cmd;
1148	u8 wep_key_cmd;
1149
1150	struct iwl_wep_key wep_keys[WEP_KEYS_MAX];
1151	u8 key_mapping_keys;
1152
1153	__le32 station_flags;
1154
1155	struct {
1156		bool non_gf_sta_present;
1157		u8 protection;
1158		bool enabled, is_40mhz;
1159		u8 extension_chan_offset;
1160	} ht;
1161
1162	bool last_tx_rejected;
1163};
1164
1165enum iwl_scan_type {
1166	IWL_SCAN_NORMAL,
1167	IWL_SCAN_RADIO_RESET,
1168	IWL_SCAN_OFFCH_TX,
1169};
1170
1171enum iwlagn_ucode_type {
1172	IWL_UCODE_NONE,
1173	IWL_UCODE_REGULAR,
1174	IWL_UCODE_INIT,
1175	IWL_UCODE_WOWLAN,
1176};
1177
1178#ifdef CONFIG_IWLWIFI_DEVICE_SVTOOL
1179struct iwl_testmode_trace {
1180	u32 buff_size;
1181	u32 total_size;
1182	u32 num_chunks;
1183	u8 *cpu_addr;
1184	u8 *trace_addr;
1185	dma_addr_t dma_addr;
1186	bool trace_enabled;
1187};
1188#endif
1189
1190/* uCode ownership */
1191#define IWL_OWNERSHIP_DRIVER	0
1192#define IWL_OWNERSHIP_TM	1
1193
1194struct iwl_priv {
1195
1196	/* ieee device used by generic ieee processing code */
1197	struct ieee80211_hw *hw;
1198	struct ieee80211_channel *ieee_channels;
1199	struct ieee80211_rate *ieee_rates;
1200	struct iwl_cfg *cfg;
1201
1202	enum ieee80211_band band;
1203
1204	void (*pre_rx_handler)(struct iwl_priv *priv,
1205			       struct iwl_rx_mem_buffer *rxb);
1206	void (*rx_handlers[REPLY_MAX])(struct iwl_priv *priv,
1207				       struct iwl_rx_mem_buffer *rxb);
1208
1209	struct ieee80211_supported_band bands[IEEE80211_NUM_BANDS];
1210
1211	/* spectrum measurement report caching */
1212	struct iwl_spectrum_notification measure_report;
1213	u8 measurement_status;
1214
1215	/* ucode beacon time */
1216	u32 ucode_beacon_time;
1217	int missed_beacon_threshold;
1218
1219	/* track IBSS manager (last beacon) status */
1220	u32 ibss_manager;
1221
1222	/* jiffies when last recovery from statistics was performed */
1223	unsigned long rx_statistics_jiffies;
1224
1225	/* force reset */
1226	struct iwl_force_reset force_reset[IWL_MAX_FORCE_RESET];
1227
1228	/* firmware reload counter and timestamp */
1229	unsigned long reload_jiffies;
1230	int reload_count;
1231
1232	/* we allocate array of iwl_channel_info for NIC's valid channels.
1233	 *    Access via channel # using indirect index array */
1234	struct iwl_channel_info *channel_info;	/* channel info array */
1235	u8 channel_count;	/* # of channels */
1236
1237	/* thermal calibration */
1238	s32 temperature;	/* degrees Kelvin */
1239	s32 last_temperature;
1240
1241	/* init calibration results */
1242	struct iwl_calib_result calib_results[IWL_CALIB_MAX];
1243
1244	/* Scan related variables */
1245	unsigned long scan_start;
1246	unsigned long scan_start_tsf;
1247	void *scan_cmd;
1248	enum ieee80211_band scan_band;
1249	struct cfg80211_scan_request *scan_request;
1250	struct ieee80211_vif *scan_vif;
1251	enum iwl_scan_type scan_type;
1252	u8 scan_tx_ant[IEEE80211_NUM_BANDS];
1253	u8 mgmt_tx_ant;
1254
1255	/* spinlock */
1256	spinlock_t lock;	/* protect general shared data */
1257	spinlock_t hcmd_lock;	/* protect hcmd */
1258	spinlock_t reg_lock;	/* protect hw register access */
1259	struct mutex mutex;
1260
1261	struct iwl_bus *bus;	/* bus specific data */
1262	struct iwl_trans trans;
1263
1264	/* microcode/device supports multiple contexts */
1265	u8 valid_contexts;
1266
1267	/* command queue number */
1268	u8 cmd_queue;
1269
1270	/* max number of station keys */
1271	u8 sta_key_max_num;
1272
1273	bool new_scan_threshold_behaviour;
1274
1275	/* EEPROM MAC addresses */
1276	struct mac_address addresses[2];
1277
1278	/* uCode images, save to reload in case of failure */
1279	int fw_index;			/* firmware we're trying to load */
1280	u32 ucode_ver;			/* version of ucode, copy of
1281					   iwl_ucode.ver */
1282
1283	/* uCode owner: default: IWL_OWNERSHIP_DRIVER */
1284	u8 ucode_owner;
1285
1286	struct fw_img ucode_rt;
1287	struct fw_img ucode_init;
1288	struct fw_img ucode_wowlan;
1289
1290	enum iwlagn_ucode_type ucode_type;
1291	u8 ucode_write_complete;	/* the image write is complete */
1292	char firmware_name[25];
1293
1294	struct iwl_rxon_context contexts[NUM_IWL_RXON_CTX];
1295
1296	__le16 switch_channel;
1297
1298	struct {
1299		u32 error_event_table;
1300		u32 log_event_table;
1301	} device_pointers;
1302
1303	u16 active_rate;
1304
1305	u8 start_calib;
1306	struct iwl_sensitivity_data sensitivity_data;
1307	struct iwl_chain_noise_data chain_noise_data;
1308	bool enhance_sensitivity_table;
1309	__le16 sensitivity_tbl[HD_TABLE_SIZE];
1310	__le16 enhance_sensitivity_tbl[ENHANCE_HD_TABLE_ENTRIES];
1311
1312	struct iwl_ht_config current_ht_config;
1313
1314	/* Rate scaling data */
1315	u8 retry_rate;
1316
1317	wait_queue_head_t wait_command_queue;
1318
1319	int activity_timer_active;
1320
1321	/* Rx and Tx DMA processing queues */
1322	struct iwl_rx_queue rxq;
1323	struct iwl_tx_queue *txq;
1324	unsigned long txq_ctx_active_msk;
1325	struct iwl_dma_ptr  kw;	/* keep warm address */
1326	struct iwl_dma_ptr  scd_bc_tbls;
1327
1328	u32 scd_base_addr;	/* scheduler sram base address */
1329
1330	unsigned long status;
1331
1332	/* counts mgmt, ctl, and data packets */
1333	struct traffic_stats tx_stats;
1334	struct traffic_stats rx_stats;
1335
1336	/* counts interrupts */
1337	struct isr_statistics isr_stats;
1338
1339	struct iwl_power_mgr power_data;
1340	struct iwl_tt_mgmt thermal_throttle;
1341
1342	/* station table variables */
1343
1344	/* Note: if lock and sta_lock are needed, lock must be acquired first */
1345	spinlock_t sta_lock;
1346	int num_stations;
1347	struct iwl_station_entry stations[IWLAGN_STATION_COUNT];
1348	unsigned long ucode_key_table;
1349
1350	/* queue refcounts */
1351#define IWL_MAX_HW_QUEUES	32
1352	unsigned long queue_stopped[BITS_TO_LONGS(IWL_MAX_HW_QUEUES)];
1353	/* for each AC */
1354	atomic_t queue_stop_count[4];
1355
1356	/* Indication if ieee80211_ops->open has been called */
1357	u8 is_open;
1358
1359	u8 mac80211_registered;
1360
1361	bool wowlan;
1362
1363	/* eeprom -- this is in the card's little endian byte order */
1364	u8 *eeprom;
1365	int    nvm_device_type;
1366	struct iwl_eeprom_calib_info *calib_info;
1367
1368	enum nl80211_iftype iw_mode;
1369
1370	/* Last Rx'd beacon timestamp */
1371	u64 timestamp;
1372
1373	struct {
1374		__le32 flag;
1375		struct statistics_general_common common;
1376		struct statistics_rx_non_phy rx_non_phy;
1377		struct statistics_rx_phy rx_ofdm;
1378		struct statistics_rx_ht_phy rx_ofdm_ht;
1379		struct statistics_rx_phy rx_cck;
1380		struct statistics_tx tx;
1381#ifdef CONFIG_IWLWIFI_DEBUGFS
1382		struct statistics_bt_activity bt_activity;
1383		__le32 num_bt_kills, accum_num_bt_kills;
1384#endif
1385	} statistics;
1386#ifdef CONFIG_IWLWIFI_DEBUGFS
1387	struct {
1388		struct statistics_general_common common;
1389		struct statistics_rx_non_phy rx_non_phy;
1390		struct statistics_rx_phy rx_ofdm;
1391		struct statistics_rx_ht_phy rx_ofdm_ht;
1392		struct statistics_rx_phy rx_cck;
1393		struct statistics_tx tx;
1394		struct statistics_bt_activity bt_activity;
1395	} accum_stats, delta_stats, max_delta_stats;
1396#endif
1397
1398	/* INT ICT Table */
1399	__le32 *ict_tbl;
1400	void *ict_tbl_vir;
1401	dma_addr_t ict_tbl_dma;
1402	dma_addr_t aligned_ict_tbl_dma;
1403	int ict_index;
1404	u32 inta;
1405	bool use_ict;
1406	/*
1407	 * reporting the number of tids has AGG on. 0 means
1408	 * no AGGREGATION
1409	 */
1410	u8 agg_tids_count;
1411
1412	struct iwl_rx_phy_res last_phy_res;
1413	bool last_phy_res_valid;
1414
1415	struct completion firmware_loading_complete;
1416
1417	u32 init_evtlog_ptr, init_evtlog_size, init_errlog_ptr;
1418	u32 inst_evtlog_ptr, inst_evtlog_size, inst_errlog_ptr;
1419
1420	/*
1421	 * chain noise reset and gain commands are the
1422	 * two extra calibration commands follows the standard
1423	 * phy calibration commands
1424	 */
1425	u8 phy_calib_chain_noise_reset_cmd;
1426	u8 phy_calib_chain_noise_gain_cmd;
1427
1428	/* counts reply_tx error */
1429	struct reply_tx_error_statistics reply_tx_stats;
1430	struct reply_agg_tx_error_statistics reply_agg_tx_stats;
1431	/* notification wait support */
1432	struct list_head notif_waits;
1433	spinlock_t notif_wait_lock;
1434	wait_queue_head_t notif_waitq;
1435
1436	/* remain-on-channel offload support */
1437	struct ieee80211_channel *hw_roc_channel;
1438	struct delayed_work hw_roc_work;
1439	enum nl80211_channel_type hw_roc_chantype;
1440	int hw_roc_duration;
1441	bool hw_roc_setup;
1442
1443	struct sk_buff *offchan_tx_skb;
1444	int offchan_tx_timeout;
1445	struct ieee80211_channel *offchan_tx_chan;
1446
1447	/* bt coex */
1448	u8 bt_enable_flag;
1449	u8 bt_status;
1450	u8 bt_traffic_load, last_bt_traffic_load;
1451	bool bt_ch_announce;
1452	bool bt_full_concurrent;
1453	bool bt_ant_couple_ok;
1454	__le32 kill_ack_mask;
1455	__le32 kill_cts_mask;
1456	__le16 bt_valid;
1457	u16 bt_on_thresh;
1458	u16 bt_duration;
1459	u16 dynamic_frag_thresh;
1460	u8 bt_ci_compliance;
1461	struct work_struct bt_traffic_change_work;
1462	bool bt_enable_pspoll;
1463	struct iwl_rxon_context *cur_rssi_ctx;
1464	bool bt_is_sco;
1465
1466	struct iwl_hw_params hw_params;
1467
1468	u32 inta_mask;
1469
1470	struct workqueue_struct *workqueue;
1471
1472	struct work_struct restart;
1473	struct work_struct scan_completed;
1474	struct work_struct rx_replenish;
1475	struct work_struct abort_scan;
1476
1477	struct work_struct beacon_update;
1478	struct iwl_rxon_context *beacon_ctx;
1479	struct sk_buff *beacon_skb;
1480	void *beacon_cmd;
1481
1482	struct work_struct tt_work;
1483	struct work_struct ct_enter;
1484	struct work_struct ct_exit;
1485	struct work_struct start_internal_scan;
1486	struct work_struct tx_flush;
1487	struct work_struct bt_full_concurrency;
1488	struct work_struct bt_runtime_config;
1489
1490	struct tasklet_struct irq_tasklet;
1491
1492	struct delayed_work scan_check;
1493
1494	/* TX Power */
1495	s8 tx_power_user_lmt;
1496	s8 tx_power_device_lmt;
1497	s8 tx_power_lmt_in_half_dbm; /* max tx power in half-dBm format */
1498	s8 tx_power_next;
1499
1500
1501#ifdef CONFIG_IWLWIFI_DEBUG
1502	/* debugging info */
1503	u32 debug_level; /* per device debugging will override global
1504			    iwl_debug_level if set */
1505#endif /* CONFIG_IWLWIFI_DEBUG */
1506#ifdef CONFIG_IWLWIFI_DEBUGFS
1507	/* debugfs */
1508	u16 tx_traffic_idx;
1509	u16 rx_traffic_idx;
1510	u8 *tx_traffic;
1511	u8 *rx_traffic;
1512	struct dentry *debugfs_dir;
1513	u32 dbgfs_sram_offset, dbgfs_sram_len;
1514	bool disable_ht40;
1515	void *wowlan_sram;
1516#endif /* CONFIG_IWLWIFI_DEBUGFS */
1517
1518	struct work_struct txpower_work;
1519	u32 disable_sens_cal;
1520	u32 disable_chain_noise_cal;
1521	struct work_struct run_time_calib_work;
1522	struct timer_list statistics_periodic;
1523	struct timer_list ucode_trace;
1524	struct timer_list watchdog;
1525
1526	struct iwl_event_log event_log;
1527
1528	struct led_classdev led;
1529	unsigned long blink_on, blink_off;
1530	bool led_registered;
1531#ifdef CONFIG_IWLWIFI_DEVICE_SVTOOL
1532	struct iwl_testmode_trace testmode_trace;
1533	u32 tm_fixed_rate;
1534#endif
1535
1536	/* WoWLAN GTK rekey data */
1537	u8 kck[NL80211_KCK_LEN], kek[NL80211_KEK_LEN];
1538	__le64 replay_ctr;
1539	__le16 last_seq_ctl;
1540	bool have_rekey_data;
1541}; /*iwl_priv */
1542
1543static inline void iwl_txq_ctx_activate(struct iwl_priv *priv, int txq_id)
1544{
1545	set_bit(txq_id, &priv->txq_ctx_active_msk);
1546}
1547
1548static inline void iwl_txq_ctx_deactivate(struct iwl_priv *priv, int txq_id)
1549{
1550	clear_bit(txq_id, &priv->txq_ctx_active_msk);
1551}
1552
1553#ifdef CONFIG_IWLWIFI_DEBUG
1554/*
1555 * iwl_get_debug_level: Return active debug level for device
1556 *
1557 * Using sysfs it is possible to set per device debug level. This debug
1558 * level will be used if set, otherwise the global debug level which can be
1559 * set via module parameter is used.
1560 */
1561static inline u32 iwl_get_debug_level(struct iwl_priv *priv)
1562{
1563	if (priv->debug_level)
1564		return priv->debug_level;
1565	else
1566		return iwl_debug_level;
1567}
1568#else
1569static inline u32 iwl_get_debug_level(struct iwl_priv *priv)
1570{
1571	return iwl_debug_level;
1572}
1573#endif
1574
1575
1576static inline struct ieee80211_hdr *iwl_tx_queue_get_hdr(struct iwl_priv *priv,
1577							 int txq_id, int idx)
1578{
1579	if (priv->txq[txq_id].txb[idx].skb)
1580		return (struct ieee80211_hdr *)priv->txq[txq_id].
1581				txb[idx].skb->data;
1582	return NULL;
1583}
1584
1585static inline struct iwl_rxon_context *
1586iwl_rxon_ctx_from_vif(struct ieee80211_vif *vif)
1587{
1588	struct iwl_vif_priv *vif_priv = (void *)vif->drv_priv;
1589
1590	return vif_priv->ctx;
1591}
1592
1593#define for_each_context(priv, ctx)				\
1594	for (ctx = &priv->contexts[IWL_RXON_CTX_BSS];		\
1595	     ctx < &priv->contexts[NUM_IWL_RXON_CTX]; ctx++)	\
1596		if (priv->valid_contexts & BIT(ctx->ctxid))
1597
1598static inline int iwl_is_associated_ctx(struct iwl_rxon_context *ctx)
1599{
1600	return (ctx->active.filter_flags & RXON_FILTER_ASSOC_MSK) ? 1 : 0;
1601}
1602
1603static inline int iwl_is_associated(struct iwl_priv *priv,
1604				    enum iwl_rxon_context_id ctxid)
1605{
1606	return iwl_is_associated_ctx(&priv->contexts[ctxid]);
1607}
1608
1609static inline int iwl_is_any_associated(struct iwl_priv *priv)
1610{
1611	struct iwl_rxon_context *ctx;
1612	for_each_context(priv, ctx)
1613		if (iwl_is_associated_ctx(ctx))
1614			return true;
1615	return false;
1616}
1617
1618static inline int is_channel_valid(const struct iwl_channel_info *ch_info)
1619{
1620	if (ch_info == NULL)
1621		return 0;
1622	return (ch_info->flags & EEPROM_CHANNEL_VALID) ? 1 : 0;
1623}
1624
1625static inline int is_channel_radar(const struct iwl_channel_info *ch_info)
1626{
1627	return (ch_info->flags & EEPROM_CHANNEL_RADAR) ? 1 : 0;
1628}
1629
1630static inline u8 is_channel_a_band(const struct iwl_channel_info *ch_info)
1631{
1632	return ch_info->band == IEEE80211_BAND_5GHZ;
1633}
1634
1635static inline u8 is_channel_bg_band(const struct iwl_channel_info *ch_info)
1636{
1637	return ch_info->band == IEEE80211_BAND_2GHZ;
1638}
1639
1640static inline int is_channel_passive(const struct iwl_channel_info *ch)
1641{
1642	return (!(ch->flags & EEPROM_CHANNEL_ACTIVE)) ? 1 : 0;
1643}
1644
1645static inline int is_channel_ibss(const struct iwl_channel_info *ch)
1646{
1647	return ((ch->flags & EEPROM_CHANNEL_IBSS)) ? 1 : 0;
1648}
1649
1650static inline void __iwl_free_pages(struct iwl_priv *priv, struct page *page)
1651{
1652	__free_pages(page, priv->hw_params.rx_page_order);
1653}
1654
1655static inline void iwl_free_pages(struct iwl_priv *priv, unsigned long page)
1656{
1657	free_pages(page, priv->hw_params.rx_page_order);
1658}
1659#endif				/* __iwl_dev_h__ */
1660