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