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