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