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