iwl-dev.h revision 65fdbb48eb43e33e94239677a75422ddc6f5eb75
1/******************************************************************************
2 *
3 * Copyright(c) 2003 - 2008 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 * James P. Ketrenos <ipw2100-admin@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 * Please use iwl-4965-hw.h for hardware-related definitions.
30 */
31
32#ifndef __iwl_dev_h__
33#define __iwl_dev_h__
34
35#include <linux/pci.h> /* for struct pci_device_id */
36#include <linux/kernel.h>
37#include <net/ieee80211_radiotap.h>
38
39#define DRV_NAME        "iwl4965"
40#include "iwl-rfkill.h"
41#include "iwl-eeprom.h"
42#include "iwl-4965-hw.h"
43#include "iwl-csr.h"
44#include "iwl-prph.h"
45#include "iwl-debug.h"
46#include "iwl-led.h"
47#include "iwl-power.h"
48
49/* configuration for the iwl4965 */
50extern struct iwl_cfg iwl4965_agn_cfg;
51extern struct iwl_cfg iwl5300_agn_cfg;
52extern struct iwl_cfg iwl5100_agn_cfg;
53extern struct iwl_cfg iwl5350_agn_cfg;
54extern struct iwl_cfg iwl5100_bg_cfg;
55extern struct iwl_cfg iwl5100_abg_cfg;
56
57/* Change firmware file name, using "-" and incrementing number,
58 *   *only* when uCode interface or architecture changes so that it
59 *   is not compatible with earlier drivers.
60 * This number will also appear in << 8 position of 1st dword of uCode file */
61#define IWL4965_UCODE_API "-1"
62
63/* CT-KILL constants */
64#define CT_KILL_THRESHOLD	110 /* in Celsius */
65
66/* Default noise level to report when noise measurement is not available.
67 *   This may be because we're:
68 *   1)  Not associated (4965, no beacon statistics being sent to driver)
69 *   2)  Scanning (noise measurement does not apply to associated channel)
70 *   3)  Receiving CCK (3945 delivers noise info only for OFDM frames)
71 * Use default noise value of -127 ... this is below the range of measurable
72 *   Rx dBm for either 3945 or 4965, so it can indicate "unmeasurable" to user.
73 *   Also, -127 works better than 0 when averaging frames with/without
74 *   noise info (e.g. averaging might be done in app); measured dBm values are
75 *   always negative ... using a negative value as the default keeps all
76 *   averages within an s8's (used in some apps) range of negative values. */
77#define IWL_NOISE_MEAS_NOT_AVAILABLE (-127)
78
79/*
80 * RTS threshold here is total size [2347] minus 4 FCS bytes
81 * Per spec:
82 *   a value of 0 means RTS on all data/management packets
83 *   a value > max MSDU size means no RTS
84 * else RTS for data/management frames where MPDU is larger
85 *   than RTS value.
86 */
87#define DEFAULT_RTS_THRESHOLD     2347U
88#define MIN_RTS_THRESHOLD         0U
89#define MAX_RTS_THRESHOLD         2347U
90#define MAX_MSDU_SIZE		  2304U
91#define MAX_MPDU_SIZE		  2346U
92#define DEFAULT_BEACON_INTERVAL   100U
93#define	DEFAULT_SHORT_RETRY_LIMIT 7U
94#define	DEFAULT_LONG_RETRY_LIMIT  4U
95
96struct iwl_rx_mem_buffer {
97	dma_addr_t dma_addr;
98	struct sk_buff *skb;
99	struct list_head list;
100};
101
102/*
103 * Generic queue structure
104 *
105 * Contains common data for Rx and Tx queues
106 */
107struct iwl_queue {
108	int n_bd;              /* number of BDs in this queue */
109	int write_ptr;       /* 1-st empty entry (index) host_w*/
110	int read_ptr;         /* last used entry (index) host_r*/
111	dma_addr_t dma_addr;   /* physical addr for BD's */
112	int n_window;	       /* safe queue window */
113	u32 id;
114	int low_mark;	       /* low watermark, resume queue if free
115				* space more than this */
116	int high_mark;         /* high watermark, stop queue if free
117				* space less than this */
118} __attribute__ ((packed));
119
120#define MAX_NUM_OF_TBS          (20)
121
122/* One for each TFD */
123struct iwl_tx_info {
124	struct sk_buff *skb[MAX_NUM_OF_TBS];
125};
126
127/**
128 * struct iwl_tx_queue - Tx Queue for DMA
129 * @q: generic Rx/Tx queue descriptor
130 * @bd: base of circular buffer of TFDs
131 * @cmd: array of command/Tx buffers
132 * @dma_addr_cmd: physical address of cmd/tx buffer array
133 * @txb: array of per-TFD driver data
134 * @need_update: indicates need to update read/write index
135 * @sched_retry: indicates queue is high-throughput aggregation (HT AGG) enabled
136 *
137 * A Tx queue consists of circular buffer of BDs (a.k.a. TFDs, transmit frame
138 * descriptors) and required locking structures.
139 */
140struct iwl_tx_queue {
141	struct iwl_queue q;
142	struct iwl_tfd_frame *bd;
143	struct iwl_cmd *cmd;
144	dma_addr_t dma_addr_cmd;
145	struct iwl_tx_info *txb;
146	int need_update;
147	int sched_retry;
148	int active;
149};
150
151#define IWL_NUM_SCAN_RATES         (2)
152
153struct iwl4965_channel_tgd_info {
154	u8 type;
155	s8 max_power;
156};
157
158struct iwl4965_channel_tgh_info {
159	s64 last_radar_time;
160};
161
162/*
163 * One for each channel, holds all channel setup data
164 * Some of the fields (e.g. eeprom and flags/max_power_avg) are redundant
165 *     with one another!
166 */
167struct iwl_channel_info {
168	struct iwl4965_channel_tgd_info tgd;
169	struct iwl4965_channel_tgh_info tgh;
170	struct iwl_eeprom_channel eeprom;	/* EEPROM regulatory limit */
171	struct iwl_eeprom_channel fat_eeprom;	/* EEPROM regulatory limit for
172						 * FAT channel */
173
174	u8 channel;	  /* channel number */
175	u8 flags;	  /* flags copied from EEPROM */
176	s8 max_power_avg; /* (dBm) regul. eeprom, normal Tx, any rate */
177	s8 curr_txpow;	  /* (dBm) regulatory/spectrum/user (not h/w) limit */
178	s8 min_power;	  /* always 0 */
179	s8 scan_power;	  /* (dBm) regul. eeprom, direct scans, any rate */
180
181	u8 group_index;	  /* 0-4, maps channel to group1/2/3/4/5 */
182	u8 band_index;	  /* 0-4, maps channel to band1/2/3/4/5 */
183	enum ieee80211_band band;
184
185	/* FAT channel info */
186	s8 fat_max_power_avg;	/* (dBm) regul. eeprom, normal Tx, any rate */
187	s8 fat_curr_txpow;	/* (dBm) regulatory/spectrum/user (not h/w) */
188	s8 fat_min_power;	/* always 0 */
189	s8 fat_scan_power;	/* (dBm) eeprom, direct scans, any rate */
190	u8 fat_flags;		/* flags copied from EEPROM */
191	u8 fat_extension_channel; /* HT_IE_EXT_CHANNEL_* */
192};
193
194struct iwl4965_clip_group {
195	/* maximum power level to prevent clipping for each rate, derived by
196	 *   us from this band's saturation power in EEPROM */
197	const s8 clip_powers[IWL_MAX_RATES];
198};
199
200#include "iwl-4965-rs.h"
201
202#define IWL_TX_FIFO_AC0	0
203#define IWL_TX_FIFO_AC1	1
204#define IWL_TX_FIFO_AC2	2
205#define IWL_TX_FIFO_AC3	3
206#define IWL_TX_FIFO_HCCA_1	5
207#define IWL_TX_FIFO_HCCA_2	6
208#define IWL_TX_FIFO_NONE	7
209
210/* Minimum number of queues. MAX_NUM is defined in hw specific files */
211#define IWL_MIN_NUM_QUEUES	4
212
213/* Power management (not Tx power) structures */
214
215enum iwl_pwr_src {
216	IWL_PWR_SRC_VMAIN,
217	IWL_PWR_SRC_VAUX,
218};
219
220#define IEEE80211_DATA_LEN              2304
221#define IEEE80211_4ADDR_LEN             30
222#define IEEE80211_HLEN                  (IEEE80211_4ADDR_LEN)
223#define IEEE80211_FRAME_LEN             (IEEE80211_DATA_LEN + IEEE80211_HLEN)
224
225struct iwl_frame {
226	union {
227		struct ieee80211_hdr frame;
228		struct iwl4965_tx_beacon_cmd beacon;
229		u8 raw[IEEE80211_FRAME_LEN];
230		u8 cmd[360];
231	} u;
232	struct list_head list;
233};
234
235#define SEQ_TO_QUEUE(x)  ((x >> 8) & 0xbf)
236#define QUEUE_TO_SEQ(x)  ((x & 0xbf) << 8)
237#define SEQ_TO_INDEX(x) ((u8)(x & 0xff))
238#define INDEX_TO_SEQ(x) ((u8)(x & 0xff))
239#define SEQ_HUGE_FRAME  (0x4000)
240#define SEQ_RX_FRAME    __constant_cpu_to_le16(0x8000)
241#define SEQ_TO_SN(seq) (((seq) & IEEE80211_SCTL_SEQ) >> 4)
242#define SN_TO_SEQ(ssn) (((ssn) << 4) & IEEE80211_SCTL_SEQ)
243#define MAX_SN ((IEEE80211_SCTL_SEQ) >> 4)
244
245enum {
246	/* CMD_SIZE_NORMAL = 0, */
247	CMD_SIZE_HUGE = (1 << 0),
248	/* CMD_SYNC = 0, */
249	CMD_ASYNC = (1 << 1),
250	/* CMD_NO_SKB = 0, */
251	CMD_WANT_SKB = (1 << 2),
252};
253
254struct iwl_cmd;
255struct iwl_priv;
256
257struct iwl_cmd_meta {
258	struct iwl_cmd_meta *source;
259	union {
260		struct sk_buff *skb;
261		int (*callback)(struct iwl_priv *priv,
262				struct iwl_cmd *cmd, struct sk_buff *skb);
263	} __attribute__ ((packed)) u;
264
265	/* The CMD_SIZE_HUGE flag bit indicates that the command
266	 * structure is stored at the end of the shared queue memory. */
267	u32 flags;
268
269} __attribute__ ((packed));
270
271#define IWL_CMD_MAX_PAYLOAD 320
272
273/**
274 * struct iwl_cmd
275 *
276 * For allocation of the command and tx queues, this establishes the overall
277 * size of the largest command we send to uCode, except for a scan command
278 * (which is relatively huge; space is allocated separately).
279 */
280struct iwl_cmd {
281	struct iwl_cmd_meta meta;	/* driver data */
282	struct iwl_cmd_header hdr;	/* uCode API */
283	union {
284		struct iwl_addsta_cmd addsta;
285		struct iwl4965_led_cmd led;
286		u32 flags;
287		u8 val8;
288		u16 val16;
289		u32 val32;
290		struct iwl4965_bt_cmd bt;
291		struct iwl4965_rxon_time_cmd rxon_time;
292		struct iwl4965_powertable_cmd powertable;
293		struct iwl4965_qosparam_cmd qosparam;
294		struct iwl_tx_cmd tx;
295		struct iwl4965_tx_beacon_cmd tx_beacon;
296		struct iwl4965_rxon_assoc_cmd rxon_assoc;
297		struct iwl_rem_sta_cmd rm_sta;
298		u8 *indirect;
299		u8 payload[IWL_CMD_MAX_PAYLOAD];
300	} __attribute__ ((packed)) cmd;
301} __attribute__ ((packed));
302
303struct iwl_host_cmd {
304	u8 id;
305	u16 len;
306	struct iwl_cmd_meta meta;
307	const void *data;
308};
309
310#define TFD_MAX_PAYLOAD_SIZE (sizeof(struct iwl_cmd) - \
311			      sizeof(struct iwl_cmd_meta))
312
313/*
314 * RX related structures and functions
315 */
316#define RX_FREE_BUFFERS 64
317#define RX_LOW_WATERMARK 8
318
319#define SUP_RATE_11A_MAX_NUM_CHANNELS  8
320#define SUP_RATE_11B_MAX_NUM_CHANNELS  4
321#define SUP_RATE_11G_MAX_NUM_CHANNELS  12
322
323/**
324 * struct iwl_rx_queue - Rx queue
325 * @processed: Internal index to last handled Rx packet
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 *
333 * NOTE:  rx_free and rx_used are used as a FIFO for iwl_rx_mem_buffers
334 */
335struct iwl_rx_queue {
336	__le32 *bd;
337	dma_addr_t dma_addr;
338	struct iwl_rx_mem_buffer pool[RX_QUEUE_SIZE + RX_FREE_BUFFERS];
339	struct iwl_rx_mem_buffer *queue[RX_QUEUE_SIZE];
340	u32 processed;
341	u32 read;
342	u32 write;
343	u32 free_count;
344	struct list_head rx_free;
345	struct list_head rx_used;
346	int need_update;
347	spinlock_t lock;
348};
349
350#define IWL_SUPPORTED_RATES_IE_LEN         8
351
352#define SCAN_INTERVAL 100
353
354#define MAX_A_CHANNELS  252
355#define MIN_A_CHANNELS  7
356
357#define MAX_B_CHANNELS  14
358#define MIN_B_CHANNELS  1
359
360#define MAX_TID_COUNT        9
361
362#define IWL_INVALID_RATE     0xFF
363#define IWL_INVALID_VALUE    -1
364
365/**
366 * struct iwl_ht_agg -- aggregation status while waiting for block-ack
367 * @txq_id: Tx queue used for Tx attempt
368 * @frame_count: # frames attempted by Tx command
369 * @wait_for_ba: Expect block-ack before next Tx reply
370 * @start_idx: Index of 1st Transmit Frame Descriptor (TFD) in Tx window
371 * @bitmap0: Low order bitmap, one bit for each frame pending ACK in Tx window
372 * @bitmap1: High order, one bit for each frame pending ACK in Tx window
373 * @rate_n_flags: Rate at which Tx was attempted
374 *
375 * If REPLY_TX indicates that aggregation was attempted, driver must wait
376 * for block ack (REPLY_COMPRESSED_BA).  This struct stores tx reply info
377 * until block ack arrives.
378 */
379struct iwl_ht_agg {
380	u16 txq_id;
381	u16 frame_count;
382	u16 wait_for_ba;
383	u16 start_idx;
384	u64 bitmap;
385	u32 rate_n_flags;
386#define IWL_AGG_OFF 0
387#define IWL_AGG_ON 1
388#define IWL_EMPTYING_HW_QUEUE_ADDBA 2
389#define IWL_EMPTYING_HW_QUEUE_DELBA 3
390	u8 state;
391};
392
393
394struct iwl_tid_data {
395	u16 seq_number;
396	u16 tfds_in_queue;
397	struct iwl_ht_agg agg;
398};
399
400struct iwl_hw_key {
401	enum ieee80211_key_alg alg;
402	int keylen;
403	u8 keyidx;
404	u8 key[32];
405};
406
407union iwl4965_ht_rate_supp {
408	u16 rates;
409	struct {
410		u8 siso_rate;
411		u8 mimo_rate;
412	};
413};
414
415#define CFG_HT_RX_AMPDU_FACTOR_DEF  (0x3)
416#define CFG_HT_MPDU_DENSITY_2USEC   (0x5)
417#define CFG_HT_MPDU_DENSITY_DEF CFG_HT_MPDU_DENSITY_2USEC
418
419struct iwl_ht_info {
420	/* self configuration data */
421	u8 is_ht;
422	u8 supported_chan_width;
423	u16 tx_mimo_ps_mode;
424	u8 is_green_field;
425	u8 sgf;			/* HT_SHORT_GI_* short guard interval */
426	u8 max_amsdu_size;
427	u8 ampdu_factor;
428	u8 mpdu_density;
429	u8 supp_mcs_set[16];
430	/* BSS related data */
431	u8 control_channel;
432	u8 extension_chan_offset;
433	u8 tx_chan_width;
434	u8 ht_protection;
435	u8 non_GF_STA_present;
436};
437
438union iwl4965_qos_capabity {
439	struct {
440		u8 edca_count:4;	/* bit 0-3 */
441		u8 q_ack:1;		/* bit 4 */
442		u8 queue_request:1;	/* bit 5 */
443		u8 txop_request:1;	/* bit 6 */
444		u8 reserved:1;		/* bit 7 */
445	} q_AP;
446	struct {
447		u8 acvo_APSD:1;		/* bit 0 */
448		u8 acvi_APSD:1;		/* bit 1 */
449		u8 ac_bk_APSD:1;	/* bit 2 */
450		u8 ac_be_APSD:1;	/* bit 3 */
451		u8 q_ack:1;		/* bit 4 */
452		u8 max_len:2;		/* bit 5-6 */
453		u8 more_data_ack:1;	/* bit 7 */
454	} q_STA;
455	u8 val;
456};
457
458/* QoS structures */
459struct iwl4965_qos_info {
460	int qos_enable;
461	int qos_active;
462	union iwl4965_qos_capabity qos_cap;
463	struct iwl4965_qosparam_cmd def_qos_parm;
464};
465
466#define STA_PS_STATUS_WAKE             0
467#define STA_PS_STATUS_SLEEP            1
468
469struct iwl_station_entry {
470	struct iwl_addsta_cmd sta;
471	struct iwl_tid_data tid[MAX_TID_COUNT];
472	u8 used;
473	u8 ps_status;
474	struct iwl_hw_key keyinfo;
475};
476
477/* one for each uCode image (inst/data, boot/init/runtime) */
478struct fw_desc {
479	void *v_addr;		/* access by driver */
480	dma_addr_t p_addr;	/* access by card's busmaster DMA */
481	u32 len;		/* bytes */
482};
483
484/* uCode file layout */
485struct iwl_ucode {
486	__le32 ver;		/* major/minor/subminor */
487	__le32 inst_size;	/* bytes of runtime instructions */
488	__le32 data_size;	/* bytes of runtime data */
489	__le32 init_size;	/* bytes of initialization instructions */
490	__le32 init_data_size;	/* bytes of initialization data */
491	__le32 boot_size;	/* bytes of bootstrap instructions */
492	u8 data[0];		/* data in same order as "size" elements */
493};
494
495struct iwl4965_ibss_seq {
496	u8 mac[ETH_ALEN];
497	u16 seq_num;
498	u16 frag_num;
499	unsigned long packet_time;
500	struct list_head list;
501};
502
503struct iwl_sensitivity_ranges {
504	u16 min_nrg_cck;
505	u16 max_nrg_cck;
506
507	u16 nrg_th_cck;
508	u16 nrg_th_ofdm;
509
510	u16 auto_corr_min_ofdm;
511	u16 auto_corr_min_ofdm_mrc;
512	u16 auto_corr_min_ofdm_x1;
513	u16 auto_corr_min_ofdm_mrc_x1;
514
515	u16 auto_corr_max_ofdm;
516	u16 auto_corr_max_ofdm_mrc;
517	u16 auto_corr_max_ofdm_x1;
518	u16 auto_corr_max_ofdm_mrc_x1;
519
520	u16 auto_corr_max_cck;
521	u16 auto_corr_max_cck_mrc;
522	u16 auto_corr_min_cck;
523	u16 auto_corr_min_cck_mrc;
524};
525
526
527#define IWL_FAT_CHANNEL_52 BIT(IEEE80211_BAND_5GHZ)
528
529/**
530 * struct iwl_hw_params
531 * @max_txq_num: Max # Tx queues supported
532 * @tx/rx_chains_num: Number of TX/RX chains
533 * @valid_tx/rx_ant: usable antennas
534 * @max_rxq_size: Max # Rx frames in Rx queue (must be power-of-2)
535 * @max_rxq_log: Log-base-2 of max_rxq_size
536 * @rx_buf_size: Rx buffer size
537 * @max_stations:
538 * @bcast_sta_id:
539 * @fat_channel: is 40MHz width possible in band 2.4
540 * BIT(IEEE80211_BAND_5GHZ) BIT(IEEE80211_BAND_5GHZ)
541 * @sw_crypto: 0 for hw, 1 for sw
542 * @max_xxx_size: for ucode uses
543 * @ct_kill_threshold: temperature threshold
544 * @struct iwl_sensitivity_ranges: range of sensitivity values
545 * @first_ampdu_q: first HW queue available for ampdu
546 */
547struct iwl_hw_params {
548	u16 max_txq_num;
549	u8  tx_chains_num;
550	u8  rx_chains_num;
551	u8  valid_tx_ant;
552	u8  valid_rx_ant;
553	u16 max_rxq_size;
554	u16 max_rxq_log;
555	u32 rx_buf_size;
556	u32 max_pkt_size;
557	u8  max_stations;
558	u8  bcast_sta_id;
559	u8 fat_channel;
560	u8 sw_crypto;
561	u32 max_inst_size;
562	u32 max_data_size;
563	u32 max_bsm_size;
564	u32 ct_kill_threshold; /* value in hw-dependent units */
565	const struct iwl_sensitivity_ranges *sens;
566	u8 first_ampdu_q;
567};
568
569#define HT_SHORT_GI_20MHZ	(1 << 0)
570#define HT_SHORT_GI_40MHZ	(1 << 1)
571
572
573#define IWL_RX_HDR(x) ((struct iwl4965_rx_frame_hdr *)(\
574		       x->u.rx_frame.stats.payload + \
575		       x->u.rx_frame.stats.phy_count))
576#define IWL_RX_END(x) ((struct iwl4965_rx_frame_end *)(\
577		       IWL_RX_HDR(x)->payload + \
578		       le16_to_cpu(IWL_RX_HDR(x)->len)))
579#define IWL_RX_STATS(x) (&x->u.rx_frame.stats)
580#define IWL_RX_DATA(x) (IWL_RX_HDR(x)->payload)
581
582
583/******************************************************************************
584 *
585 * Functions implemented in iwl-base.c which are forward declared here
586 * for use by iwl-*.c
587 *
588 *****************************************************************************/
589struct iwl_addsta_cmd;
590extern int iwl_send_add_sta(struct iwl_priv *priv,
591			    struct iwl_addsta_cmd *sta, u8 flags);
592u8 iwl_add_station_flags(struct iwl_priv *priv, const u8 *addr, int is_ap,
593			 u8 flags, struct ieee80211_ht_info *ht_info);
594extern unsigned int iwl4965_fill_beacon_frame(struct iwl_priv *priv,
595					struct ieee80211_hdr *hdr,
596					const u8 *dest, int left);
597extern void iwl4965_update_chain_flags(struct iwl_priv *priv);
598int iwl4965_set_pwr_src(struct iwl_priv *priv, enum iwl_pwr_src src);
599
600extern const u8 iwl_bcast_addr[ETH_ALEN];
601
602/******************************************************************************
603 *
604 * Functions implemented in iwl-[34]*.c which are forward declared here
605 * for use by iwl-base.c
606 *
607 * NOTE:  The implementation of these functions are hardware specific
608 * which is why they are in the hardware specific files (vs. iwl-base.c)
609 *
610 * Naming convention --
611 * iwl4965_         <-- Its part of iwlwifi (should be changed to iwl4965_)
612 * iwl4965_hw_      <-- Hardware specific (implemented in iwl-XXXX.c by all HW)
613 * iwlXXXX_     <-- Hardware specific (implemented in iwl-XXXX.c for XXXX)
614 * iwl4965_bg_      <-- Called from work queue context
615 * iwl4965_mac_     <-- mac80211 callback
616 *
617 ****************************************************************************/
618extern int iwl_rxq_stop(struct iwl_priv *priv);
619extern void iwl_txq_ctx_stop(struct iwl_priv *priv);
620extern unsigned int iwl4965_hw_get_beacon_cmd(struct iwl_priv *priv,
621				 struct iwl_frame *frame, u8 rate);
622extern void iwl4965_disable_events(struct iwl_priv *priv);
623
624extern int iwl4965_hw_channel_switch(struct iwl_priv *priv, u16 channel);
625extern int iwl_queue_space(const struct iwl_queue *q);
626static inline int iwl_queue_used(const struct iwl_queue *q, int i)
627{
628	return q->write_ptr > q->read_ptr ?
629		(i >= q->read_ptr && i < q->write_ptr) :
630		!(i < q->read_ptr && i >= q->write_ptr);
631}
632
633
634static inline u8 get_cmd_index(struct iwl_queue *q, u32 index, int is_huge)
635{
636	/* This is for scan command, the big buffer at end of command array */
637	if (is_huge)
638		return q->n_window;	/* must be power of 2 */
639
640	/* Otherwise, use normal size buffers */
641	return index & (q->n_window - 1);
642}
643
644
645struct iwl_priv;
646
647/*
648 * Forward declare iwl-4965.c functions for iwl-base.c
649 */
650extern void iwl4965_rf_kill_ct_config(struct iwl_priv *priv);
651
652int iwl4965_mac_ampdu_action(struct ieee80211_hw *hw,
653				    enum ieee80211_ampdu_mlme_action action,
654				    const u8 *addr, u16 tid, u16 *ssn);
655int iwl4965_check_empty_hw_queue(struct iwl_priv *priv, int sta_id,
656					u8 tid, int txq_id);
657
658/* Structures, enum, and defines specific to the 4965 */
659
660#define IWL_KW_SIZE 0x1000	/*4k */
661
662struct iwl_kw {
663	dma_addr_t dma_addr;
664	void *v_addr;
665	size_t size;
666};
667
668#define IWL_CHANNEL_WIDTH_20MHZ   0
669#define IWL_CHANNEL_WIDTH_40MHZ   1
670
671#define IWL_MIMO_PS_STATIC        0
672#define IWL_MIMO_PS_NONE          3
673#define IWL_MIMO_PS_DYNAMIC       1
674#define IWL_MIMO_PS_INVALID       2
675
676#define IWL_OPERATION_MODE_AUTO     0
677#define IWL_OPERATION_MODE_HT_ONLY  1
678#define IWL_OPERATION_MODE_MIXED    2
679#define IWL_OPERATION_MODE_20MHZ    3
680
681#define IWL_TX_CRC_SIZE 4
682#define IWL_TX_DELIMITER_SIZE 4
683
684#define TX_POWER_IWL_ILLEGAL_VOLTAGE -10000
685
686struct iwl4965_lq_mngr {
687	spinlock_t lock;
688	s32 max_window_size;
689	s32 *expected_tpt;
690	u8 *next_higher_rate;
691	u8 *next_lower_rate;
692	unsigned long stamp;
693	unsigned long stamp_last;
694	u32 flush_time;
695	u32 tx_packets;
696};
697
698/* Sensitivity and chain noise calibration */
699#define INTERFERENCE_DATA_AVAILABLE	__constant_cpu_to_le32(1)
700#define INITIALIZATION_VALUE		0xFFFF
701#define CAL_NUM_OF_BEACONS		20
702#define MAXIMUM_ALLOWED_PATHLOSS	15
703
704#define CHAIN_NOISE_MAX_DELTA_GAIN_CODE 3
705
706#define MAX_FA_OFDM  50
707#define MIN_FA_OFDM  5
708#define MAX_FA_CCK   50
709#define MIN_FA_CCK   5
710
711#define AUTO_CORR_STEP_OFDM       1
712
713#define AUTO_CORR_STEP_CCK     3
714#define AUTO_CORR_MAX_TH_CCK   160
715
716#define NRG_DIFF               2
717#define NRG_STEP_CCK           2
718#define NRG_MARGIN             8
719#define MAX_NUMBER_CCK_NO_FA 100
720
721#define AUTO_CORR_CCK_MIN_VAL_DEF    (125)
722
723#define CHAIN_A             0
724#define CHAIN_B             1
725#define CHAIN_C             2
726#define CHAIN_NOISE_DELTA_GAIN_INIT_VAL 4
727#define ALL_BAND_FILTER			0xFF00
728#define IN_BAND_FILTER			0xFF
729#define MIN_AVERAGE_NOISE_MAX_VALUE	0xFFFFFFFF
730
731#define NRG_NUM_PREV_STAT_L     20
732#define NUM_RX_CHAINS           3
733
734enum iwl4965_false_alarm_state {
735	IWL_FA_TOO_MANY = 0,
736	IWL_FA_TOO_FEW = 1,
737	IWL_FA_GOOD_RANGE = 2,
738};
739
740enum iwl4965_chain_noise_state {
741	IWL_CHAIN_NOISE_ALIVE = 0,  /* must be 0 */
742	IWL_CHAIN_NOISE_ACCUMULATE = 1,
743	IWL_CHAIN_NOISE_CALIBRATED = 2,
744};
745
746enum iwl4965_calib_enabled_state {
747	IWL_CALIB_DISABLED = 0,  /* must be 0 */
748	IWL_CALIB_ENABLED = 1,
749};
750
751struct statistics_general_data {
752	u32 beacon_silence_rssi_a;
753	u32 beacon_silence_rssi_b;
754	u32 beacon_silence_rssi_c;
755	u32 beacon_energy_a;
756	u32 beacon_energy_b;
757	u32 beacon_energy_c;
758};
759
760struct iwl_calib_results {
761	void *tx_iq_res;
762	void *tx_iq_perd_res;
763	void *lo_res;
764	u32 tx_iq_res_len;
765	u32 tx_iq_perd_res_len;
766	u32 lo_res_len;
767};
768
769enum ucode_type {
770	UCODE_NONE = 0,
771	UCODE_INIT,
772	UCODE_RT
773};
774
775/* Sensitivity calib data */
776struct iwl_sensitivity_data {
777	u32 auto_corr_ofdm;
778	u32 auto_corr_ofdm_mrc;
779	u32 auto_corr_ofdm_x1;
780	u32 auto_corr_ofdm_mrc_x1;
781	u32 auto_corr_cck;
782	u32 auto_corr_cck_mrc;
783
784	u32 last_bad_plcp_cnt_ofdm;
785	u32 last_fa_cnt_ofdm;
786	u32 last_bad_plcp_cnt_cck;
787	u32 last_fa_cnt_cck;
788
789	u32 nrg_curr_state;
790	u32 nrg_prev_state;
791	u32 nrg_value[10];
792	u8  nrg_silence_rssi[NRG_NUM_PREV_STAT_L];
793	u32 nrg_silence_ref;
794	u32 nrg_energy_idx;
795	u32 nrg_silence_idx;
796	u32 nrg_th_cck;
797	s32 nrg_auto_corr_silence_diff;
798	u32 num_in_cck_no_fa;
799	u32 nrg_th_ofdm;
800};
801
802/* Chain noise (differential Rx gain) calib data */
803struct iwl_chain_noise_data {
804	u8 state;
805	u16 beacon_count;
806	u32 chain_noise_a;
807	u32 chain_noise_b;
808	u32 chain_noise_c;
809	u32 chain_signal_a;
810	u32 chain_signal_b;
811	u32 chain_signal_c;
812	u8 disconn_array[NUM_RX_CHAINS];
813	u8 delta_gain_code[NUM_RX_CHAINS];
814	u8 radio_write;
815};
816
817#define	EEPROM_SEM_TIMEOUT 10		/* milliseconds */
818#define EEPROM_SEM_RETRY_LIMIT 1000	/* number of attempts (not time) */
819
820
821#ifdef CONFIG_IWL4965_SPECTRUM_MEASUREMENT
822
823enum {
824	MEASUREMENT_READY = (1 << 0),
825	MEASUREMENT_ACTIVE = (1 << 1),
826};
827
828#endif
829
830#define IWL_MAX_NUM_QUEUES	20 /* FIXME: do dynamic allocation */
831
832struct iwl_priv {
833
834	/* ieee device used by generic ieee processing code */
835	struct ieee80211_hw *hw;
836	struct ieee80211_channel *ieee_channels;
837	struct ieee80211_rate *ieee_rates;
838	struct iwl_cfg *cfg;
839
840	/* temporary frame storage list */
841	struct list_head free_frames;
842	int frames_count;
843
844	enum ieee80211_band band;
845	int alloc_rxb_skb;
846	bool add_radiotap;
847
848	void (*rx_handlers[REPLY_MAX])(struct iwl_priv *priv,
849				       struct iwl_rx_mem_buffer *rxb);
850
851	struct ieee80211_supported_band bands[IEEE80211_NUM_BANDS];
852
853#ifdef CONFIG_IWL4965_SPECTRUM_MEASUREMENT
854	/* spectrum measurement report caching */
855	struct iwl4965_spectrum_notification measure_report;
856	u8 measurement_status;
857#endif
858	/* ucode beacon time */
859	u32 ucode_beacon_time;
860
861	/* we allocate array of iwl4965_channel_info for NIC's valid channels.
862	 *    Access via channel # using indirect index array */
863	struct iwl_channel_info *channel_info;	/* channel info array */
864	u8 channel_count;	/* # of channels */
865
866	/* each calibration channel group in the EEPROM has a derived
867	 * clip setting for each rate. */
868	const struct iwl4965_clip_group clip_groups[5];
869
870	/* thermal calibration */
871	s32 temperature;	/* degrees Kelvin */
872	s32 last_temperature;
873
874	/* init calibration results */
875	struct iwl_calib_results calib_results;
876
877	/* Scan related variables */
878	unsigned long last_scan_jiffies;
879	unsigned long next_scan_jiffies;
880	unsigned long scan_start;
881	unsigned long scan_pass_start;
882	unsigned long scan_start_tsf;
883	int scan_bands;
884	int one_direct_scan;
885	u8 direct_ssid_len;
886	u8 direct_ssid[IW_ESSID_MAX_SIZE];
887	struct iwl_scan_cmd *scan;
888	u32 scan_tx_ant[IEEE80211_NUM_BANDS];
889
890	/* spinlock */
891	spinlock_t lock;	/* protect general shared data */
892	spinlock_t hcmd_lock;	/* protect hcmd */
893	struct mutex mutex;
894
895	/* basic pci-network driver stuff */
896	struct pci_dev *pci_dev;
897
898	/* pci hardware address support */
899	void __iomem *hw_base;
900	u32  hw_rev;
901	u32  hw_wa_rev;
902	u8   rev_id;
903
904	/* uCode images, save to reload in case of failure */
905	struct fw_desc ucode_code;	/* runtime inst */
906	struct fw_desc ucode_data;	/* runtime data original */
907	struct fw_desc ucode_data_backup;	/* runtime data save/restore */
908	struct fw_desc ucode_init;	/* initialization inst */
909	struct fw_desc ucode_init_data;	/* initialization data */
910	struct fw_desc ucode_boot;	/* bootstrap inst */
911	enum ucode_type ucode_type;
912	u8 ucode_write_complete;	/* the image write is complete */
913
914
915	struct iwl4965_rxon_time_cmd rxon_timing;
916
917	/* We declare this const so it can only be
918	 * changed via explicit cast within the
919	 * routines that actually update the physical
920	 * hardware */
921	const struct iwl_rxon_cmd active_rxon;
922	struct iwl_rxon_cmd staging_rxon;
923
924	int error_recovering;
925	struct iwl_rxon_cmd recovery_rxon;
926
927	/* 1st responses from initialize and runtime uCode images.
928	 * 4965's initialize alive response contains some calibration data. */
929	struct iwl_init_alive_resp card_alive_init;
930	struct iwl_alive_resp card_alive;
931#ifdef CONFIG_IWLWIFI_RFKILL
932	struct rfkill *rfkill;
933#endif
934
935#ifdef CONFIG_IWLWIFI_LEDS
936	struct iwl4965_led led[IWL_LED_TRG_MAX];
937	unsigned long last_blink_time;
938	u8 last_blink_rate;
939	u8 allow_blinking;
940	u64 led_tpt;
941#endif
942
943	u16 active_rate;
944	u16 active_rate_basic;
945
946	u8 assoc_station_added;
947	u8 use_ant_b_for_management_frame;	/* Tx antenna selection */
948	u8 start_calib;
949	struct iwl_sensitivity_data sensitivity_data;
950	struct iwl_chain_noise_data chain_noise_data;
951	__le16 sensitivity_tbl[HD_TABLE_SIZE];
952
953	struct iwl_ht_info current_ht_config;
954	u8 last_phy_res[100];
955
956	/* Rate scaling data */
957	struct iwl4965_lq_mngr lq_mngr;
958
959	/* Rate scaling data */
960	s8 data_retry_limit;
961	u8 retry_rate;
962
963	wait_queue_head_t wait_command_queue;
964
965	int activity_timer_active;
966
967	/* Rx and Tx DMA processing queues */
968	struct iwl_rx_queue rxq;
969	struct iwl_tx_queue txq[IWL_MAX_NUM_QUEUES];
970	unsigned long txq_ctx_active_msk;
971	struct iwl_kw kw;	/* keep warm address */
972	u32 scd_base_addr;	/* scheduler sram base address */
973
974	unsigned long status;
975
976	int last_rx_rssi;	/* From Rx packet statisitics */
977	int last_rx_noise;	/* From beacon statistics */
978
979	/* counts mgmt, ctl, and data packets */
980	struct traffic_stats {
981		u32 cnt;
982		u64 bytes;
983	} tx_stats[3], rx_stats[3];
984
985	struct iwl_power_mgr power_data;
986
987	struct iwl_notif_statistics statistics;
988	unsigned long last_statistics_time;
989
990	/* context information */
991	u8 essid[IW_ESSID_MAX_SIZE];
992	u8 essid_len;
993	u16 rates_mask;
994
995	u32 power_mode;
996	u32 antenna;
997	u8 bssid[ETH_ALEN];
998	u16 rts_threshold;
999	u8 mac_addr[ETH_ALEN];
1000
1001	/*station table variables */
1002	spinlock_t sta_lock;
1003	int num_stations;
1004	struct iwl_station_entry stations[IWL_STATION_COUNT];
1005	struct iwl_wep_key wep_keys[WEP_KEYS_MAX];
1006	u8 default_wep_key;
1007	u8 key_mapping_key;
1008	unsigned long ucode_key_table;
1009
1010	/* Indication if ieee80211_ops->open has been called */
1011	u8 is_open;
1012
1013	u8 mac80211_registered;
1014
1015	/* Rx'd packet timing information */
1016	u32 last_beacon_time;
1017	u64 last_tsf;
1018
1019	/* eeprom */
1020	u8 *eeprom;
1021	struct iwl_eeprom_calib_info *calib_info;
1022
1023	enum ieee80211_if_types iw_mode;
1024
1025	struct sk_buff *ibss_beacon;
1026
1027	/* Last Rx'd beacon timestamp */
1028	u64 timestamp;
1029	u16 beacon_int;
1030	struct ieee80211_vif *vif;
1031
1032	struct iwl_hw_params hw_params;
1033	/* driver/uCode shared Tx Byte Counts and Rx status */
1034	void *shared_virt;
1035	int rb_closed_offset;
1036	/* Physical Pointer to Tx Byte Counts and Rx status */
1037	dma_addr_t shared_phys;
1038
1039	/* Current association information needed to configure the
1040	 * hardware */
1041	u16 assoc_id;
1042	u16 assoc_capability;
1043	u8 ps_mode;
1044
1045	struct iwl4965_qos_info qos_data;
1046
1047	struct workqueue_struct *workqueue;
1048
1049	struct work_struct up;
1050	struct work_struct restart;
1051	struct work_struct calibrated_work;
1052	struct work_struct scan_completed;
1053	struct work_struct rx_replenish;
1054	struct work_struct rf_kill;
1055	struct work_struct abort_scan;
1056	struct work_struct update_link_led;
1057	struct work_struct auth_work;
1058	struct work_struct report_work;
1059	struct work_struct request_scan;
1060	struct work_struct beacon_update;
1061	struct work_struct set_monitor;
1062
1063	struct tasklet_struct irq_tasklet;
1064
1065	struct delayed_work init_alive_start;
1066	struct delayed_work alive_start;
1067	struct delayed_work scan_check;
1068	/* TX Power */
1069	s8 tx_power_user_lmt;
1070	s8 tx_power_channel_lmt;
1071
1072#ifdef CONFIG_PM
1073	u32 pm_state[16];
1074#endif
1075
1076#ifdef CONFIG_IWLWIFI_DEBUG
1077	/* debugging info */
1078	u32 debug_level;
1079	u32 framecnt_to_us;
1080	atomic_t restrict_refcnt;
1081#ifdef CONFIG_IWLWIFI_DEBUGFS
1082	/* debugfs */
1083	struct iwl_debugfs *dbgfs;
1084#endif /* CONFIG_IWLWIFI_DEBUGFS */
1085#endif /* CONFIG_IWLWIFI_DEBUG */
1086
1087	struct work_struct txpower_work;
1088	u32 disable_sens_cal;
1089	u32 disable_chain_noise_cal;
1090	u32 disable_tx_power_cal;
1091	struct work_struct run_time_calib_work;
1092	struct timer_list statistics_periodic;
1093}; /*iwl_priv */
1094
1095static inline void iwl_txq_ctx_activate(struct iwl_priv *priv, int txq_id)
1096{
1097	set_bit(txq_id, &priv->txq_ctx_active_msk);
1098}
1099
1100static inline void iwl_txq_ctx_deactivate(struct iwl_priv *priv, int txq_id)
1101{
1102	clear_bit(txq_id, &priv->txq_ctx_active_msk);
1103}
1104
1105#ifdef CONFIG_IWLWIFI_DEBUG
1106const char *iwl_get_tx_fail_reason(u32 status);
1107#else
1108static inline const char *iwl_get_tx_fail_reason(u32 status) { return ""; }
1109#endif
1110
1111
1112static inline struct ieee80211_hdr *iwl_tx_queue_get_hdr(struct iwl_priv *priv,
1113							 int txq_id, int idx)
1114{
1115	if (priv->txq[txq_id].txb[idx].skb[0])
1116		return (struct ieee80211_hdr *)priv->txq[txq_id].
1117				txb[idx].skb[0]->data;
1118	return NULL;
1119}
1120
1121
1122static inline int iwl_is_associated(struct iwl_priv *priv)
1123{
1124	return (priv->active_rxon.filter_flags & RXON_FILTER_ASSOC_MSK) ? 1 : 0;
1125}
1126
1127static inline int is_channel_valid(const struct iwl_channel_info *ch_info)
1128{
1129	if (ch_info == NULL)
1130		return 0;
1131	return (ch_info->flags & EEPROM_CHANNEL_VALID) ? 1 : 0;
1132}
1133
1134static inline int is_channel_radar(const struct iwl_channel_info *ch_info)
1135{
1136	return (ch_info->flags & EEPROM_CHANNEL_RADAR) ? 1 : 0;
1137}
1138
1139static inline u8 is_channel_a_band(const struct iwl_channel_info *ch_info)
1140{
1141	return ch_info->band == IEEE80211_BAND_5GHZ;
1142}
1143
1144static inline u8 is_channel_bg_band(const struct iwl_channel_info *ch_info)
1145{
1146	return ch_info->band == IEEE80211_BAND_2GHZ;
1147}
1148
1149static inline int is_channel_passive(const struct iwl_channel_info *ch)
1150{
1151	return (!(ch->flags & EEPROM_CHANNEL_ACTIVE)) ? 1 : 0;
1152}
1153
1154static inline int is_channel_ibss(const struct iwl_channel_info *ch)
1155{
1156	return ((ch->flags & EEPROM_CHANNEL_IBSS)) ? 1 : 0;
1157}
1158
1159#ifdef CONFIG_IWLWIFI_DEBUG
1160static inline void iwl_print_hex_dump(struct iwl_priv *priv, int level,
1161				      void *p, u32 len)
1162{
1163	if (!(priv->debug_level & level))
1164		return;
1165
1166	print_hex_dump(KERN_DEBUG, "iwl data: ", DUMP_PREFIX_OFFSET, 16, 1,
1167			p, len, 1);
1168}
1169#else
1170static inline void iwl_print_hex_dump(struct iwl_priv *priv, int level,
1171				      void *p, u32 len)
1172{
1173}
1174#endif
1175
1176extern const struct iwl_channel_info *iwl_get_channel_info(
1177	const struct iwl_priv *priv, enum ieee80211_band band, u16 channel);
1178
1179/* Requires full declaration of iwl_priv before including */
1180
1181#endif				/* __iwl_dev_h__ */
1182