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