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