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