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