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