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