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