iwlwifi: Add comments to some driver data structures
[linux-2.6.git] / drivers / net / wireless / iwlwifi / iwl-3945.h
1 /******************************************************************************
2  *
3  * Copyright(c) 2003 - 2007 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 #ifndef __iwl_3945_h__
28 #define __iwl_3945_h__
29
30 #include <linux/pci.h> /* for struct pci_device_id */
31 #include <linux/kernel.h>
32 #include <net/ieee80211_radiotap.h>
33
34 struct iwl3945_priv;
35
36 /* Hardware specific file defines the PCI IDs table for that hardware module */
37 extern struct pci_device_id iwl3945_hw_card_ids[];
38
39 #define DRV_NAME        "iwl3945"
40 #include "iwl-3945-hw.h"
41 #include "iwl-prph.h"
42 #include "iwl-3945-debug.h"
43
44 /* Default noise level to report when noise measurement is not available.
45  *   This may be because we're:
46  *   1)  Not associated (4965, no beacon statistics being sent to driver)
47  *   2)  Scanning (noise measurement does not apply to associated channel)
48  *   3)  Receiving CCK (3945 delivers noise info only for OFDM frames)
49  * Use default noise value of -127 ... this is below the range of measurable
50  *   Rx dBm for either 3945 or 4965, so it can indicate "unmeasurable" to user.
51  *   Also, -127 works better than 0 when averaging frames with/without
52  *   noise info (e.g. averaging might be done in app); measured dBm values are
53  *   always negative ... using a negative value as the default keeps all
54  *   averages within an s8's (used in some apps) range of negative values. */
55 #define IWL_NOISE_MEAS_NOT_AVAILABLE (-127)
56
57 /* Module parameters accessible from iwl-*.c */
58 extern int iwl3945_param_hwcrypto;
59 extern int iwl3945_param_queues_num;
60
61 enum iwl3945_antenna {
62         IWL_ANTENNA_DIVERSITY,
63         IWL_ANTENNA_MAIN,
64         IWL_ANTENNA_AUX
65 };
66
67 /*
68  * RTS threshold here is total size [2347] minus 4 FCS bytes
69  * Per spec:
70  *   a value of 0 means RTS on all data/management packets
71  *   a value > max MSDU size means no RTS
72  * else RTS for data/management frames where MPDU is larger
73  *   than RTS value.
74  */
75 #define DEFAULT_RTS_THRESHOLD     2347U
76 #define MIN_RTS_THRESHOLD         0U
77 #define MAX_RTS_THRESHOLD         2347U
78 #define MAX_MSDU_SIZE             2304U
79 #define MAX_MPDU_SIZE             2346U
80 #define DEFAULT_BEACON_INTERVAL   100U
81 #define DEFAULT_SHORT_RETRY_LIMIT 7U
82 #define DEFAULT_LONG_RETRY_LIMIT  4U
83
84 struct iwl3945_rx_mem_buffer {
85         dma_addr_t dma_addr;
86         struct sk_buff *skb;
87         struct list_head list;
88 };
89
90 struct iwl3945_rt_rx_hdr {
91         struct ieee80211_radiotap_header rt_hdr;
92         __le64 rt_tsf;          /* TSF */
93         u8 rt_flags;            /* radiotap packet flags */
94         u8 rt_rate;             /* rate in 500kb/s */
95         __le16 rt_channelMHz;   /* channel in MHz */
96         __le16 rt_chbitmask;    /* channel bitfield */
97         s8 rt_dbmsignal;        /* signal in dBm, kluged to signed */
98         s8 rt_dbmnoise;
99         u8 rt_antenna;          /* antenna number */
100         u8 payload[0];          /* payload... */
101 } __attribute__ ((packed));
102
103 struct iwl3945_rt_tx_hdr {
104         struct ieee80211_radiotap_header rt_hdr;
105         u8 rt_rate;             /* rate in 500kb/s */
106         __le16 rt_channel;      /* channel in mHz */
107         __le16 rt_chbitmask;    /* channel bitfield */
108         s8 rt_dbmsignal;        /* signal in dBm, kluged to signed */
109         u8 rt_antenna;          /* antenna number */
110         u8 payload[0];          /* payload... */
111 } __attribute__ ((packed));
112
113 /*
114  * Generic queue structure
115  *
116  * Contains common data for Rx and Tx queues
117  */
118 struct iwl3945_queue {
119         int n_bd;              /* number of BDs in this queue */
120         int write_ptr;       /* 1-st empty entry (index) host_w*/
121         int read_ptr;         /* last used entry (index) host_r*/
122         dma_addr_t dma_addr;   /* physical addr for BD's */
123         int n_window;          /* safe queue window */
124         u32 id;
125         int low_mark;          /* low watermark, resume queue if free
126                                 * space more than this */
127         int high_mark;         /* high watermark, stop queue if free
128                                 * space less than this */
129 } __attribute__ ((packed));
130
131 #define MAX_NUM_OF_TBS          (20)
132
133 /* One for each TFD */
134 struct iwl3945_tx_info {
135         struct ieee80211_tx_status status;
136         struct sk_buff *skb[MAX_NUM_OF_TBS];
137 };
138
139 /**
140  * struct iwl3945_tx_queue - Tx Queue for DMA
141  * @q: generic Rx/Tx queue descriptor
142  * @bd: base of circular buffer of TFDs
143  * @cmd: array of command/Tx buffers
144  * @dma_addr_cmd: physical address of cmd/tx buffer array
145  * @txb: array of per-TFD driver data
146  * @need_update: indicates need to update read/write index
147  *
148  * A Tx queue consists of circular buffer of BDs (a.k.a. TFDs, transmit frame
149  * descriptors) and required locking structures.
150  */
151 struct iwl3945_tx_queue {
152         struct iwl3945_queue q;
153         struct iwl3945_tfd_frame *bd;
154         struct iwl3945_cmd *cmd;
155         dma_addr_t dma_addr_cmd;
156         struct iwl3945_tx_info *txb;
157         int need_update;
158         int active;
159 };
160
161 #define IWL_NUM_SCAN_RATES         (2)
162
163 struct iwl3945_channel_tgd_info {
164         u8 type;
165         s8 max_power;
166 };
167
168 struct iwl3945_channel_tgh_info {
169         s64 last_radar_time;
170 };
171
172 /* current Tx power values to use, one for each rate for each channel.
173  * requested power is limited by:
174  * -- regulatory EEPROM limits for this channel
175  * -- hardware capabilities (clip-powers)
176  * -- spectrum management
177  * -- user preference (e.g. iwconfig)
178  * when requested power is set, base power index must also be set. */
179 struct iwl3945_channel_power_info {
180         struct iwl3945_tx_power tpc;    /* actual radio and DSP gain settings */
181         s8 power_table_index;   /* actual (compenst'd) index into gain table */
182         s8 base_power_index;    /* gain index for power at factory temp. */
183         s8 requested_power;     /* power (dBm) requested for this chnl/rate */
184 };
185
186 /* current scan Tx power values to use, one for each scan rate for each
187  * channel. */
188 struct iwl3945_scan_power_info {
189         struct iwl3945_tx_power tpc;    /* actual radio and DSP gain settings */
190         s8 power_table_index;   /* actual (compenst'd) index into gain table */
191         s8 requested_power;     /* scan pwr (dBm) requested for chnl/rate */
192 };
193
194 /* Channel unlock period is 15 seconds. If no beacon or probe response
195  * has been received within 15 seconds on a locked channel then the channel
196  * remains locked. */
197 #define TX_UNLOCK_PERIOD 15
198
199 /* CSA lock period is 15 seconds.  If a CSA has been received on a channel in
200  * the last 15 seconds, the channel is locked */
201 #define CSA_LOCK_PERIOD 15
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 #define IWL4965_MAX_RATE (33)
208
209 struct iwl3945_channel_info {
210         struct iwl3945_channel_tgd_info tgd;
211         struct iwl3945_channel_tgh_info tgh;
212         struct iwl3945_eeprom_channel eeprom;   /* EEPROM regulatory limit */
213         struct iwl3945_eeprom_channel fat_eeprom;       /* EEPROM regulatory limit for
214                                                  * FAT channel */
215
216         u8 channel;       /* channel number */
217         u8 flags;         /* flags copied from EEPROM */
218         s8 max_power_avg; /* (dBm) regul. eeprom, normal Tx, any rate */
219         s8 curr_txpow;    /* (dBm) regulatory/spectrum/user (not h/w) */
220         s8 min_power;     /* always 0 */
221         s8 scan_power;    /* (dBm) regul. eeprom, direct scans, any rate */
222
223         u8 group_index;   /* 0-4, maps channel to group1/2/3/4/5 */
224         u8 band_index;    /* 0-4, maps channel to band1/2/3/4/5 */
225         u8 phymode;       /* MODE_IEEE80211{A,B,G} */
226
227         /* Radio/DSP gain settings for each "normal" data Tx rate.
228          * These include, in addition to RF and DSP gain, a few fields for
229          *   remembering/modifying gain settings (indexes). */
230         struct iwl3945_channel_power_info power_info[IWL4965_MAX_RATE];
231
232         /* Radio/DSP gain settings for each scan rate, for directed scans. */
233         struct iwl3945_scan_power_info scan_pwr_info[IWL_NUM_SCAN_RATES];
234 };
235
236 struct iwl3945_clip_group {
237         /* maximum power level to prevent clipping for each rate, derived by
238          *   us from this band's saturation power in EEPROM */
239         const s8 clip_powers[IWL_MAX_RATES];
240 };
241
242 #include "iwl-3945-rs.h"
243
244 #define IWL_TX_FIFO_AC0 0
245 #define IWL_TX_FIFO_AC1 1
246 #define IWL_TX_FIFO_AC2 2
247 #define IWL_TX_FIFO_AC3 3
248 #define IWL_TX_FIFO_HCCA_1      5
249 #define IWL_TX_FIFO_HCCA_2      6
250 #define IWL_TX_FIFO_NONE        7
251
252 /* Minimum number of queues. MAX_NUM is defined in hw specific files */
253 #define IWL_MIN_NUM_QUEUES      4
254
255 /* Power management (not Tx power) structures */
256
257 struct iwl3945_power_vec_entry {
258         struct iwl3945_powertable_cmd cmd;
259         u8 no_dtim;
260 };
261 #define IWL_POWER_RANGE_0  (0)
262 #define IWL_POWER_RANGE_1  (1)
263
264 #define IWL_POWER_MODE_CAM      0x00    /* Continuously Aware Mode, always on */
265 #define IWL_POWER_INDEX_3       0x03
266 #define IWL_POWER_INDEX_5       0x05
267 #define IWL_POWER_AC            0x06
268 #define IWL_POWER_BATTERY       0x07
269 #define IWL_POWER_LIMIT         0x07
270 #define IWL_POWER_MASK          0x0F
271 #define IWL_POWER_ENABLED       0x10
272 #define IWL_POWER_LEVEL(x)      ((x) & IWL_POWER_MASK)
273
274 struct iwl3945_power_mgr {
275         spinlock_t lock;
276         struct iwl3945_power_vec_entry pwr_range_0[IWL_POWER_AC];
277         struct iwl3945_power_vec_entry pwr_range_1[IWL_POWER_AC];
278         u8 active_index;
279         u32 dtim_val;
280 };
281
282 #define IEEE80211_DATA_LEN              2304
283 #define IEEE80211_4ADDR_LEN             30
284 #define IEEE80211_HLEN                  (IEEE80211_4ADDR_LEN)
285 #define IEEE80211_FRAME_LEN             (IEEE80211_DATA_LEN + IEEE80211_HLEN)
286
287 struct iwl3945_frame {
288         union {
289                 struct ieee80211_hdr frame;
290                 struct iwl3945_tx_beacon_cmd beacon;
291                 u8 raw[IEEE80211_FRAME_LEN];
292                 u8 cmd[360];
293         } u;
294         struct list_head list;
295 };
296
297 #define SEQ_TO_QUEUE(x)  ((x >> 8) & 0xbf)
298 #define QUEUE_TO_SEQ(x)  ((x & 0xbf) << 8)
299 #define SEQ_TO_INDEX(x) (x & 0xff)
300 #define INDEX_TO_SEQ(x) (x & 0xff)
301 #define SEQ_HUGE_FRAME  (0x4000)
302 #define SEQ_RX_FRAME    __constant_cpu_to_le16(0x8000)
303 #define SEQ_TO_SN(seq) (((seq) & IEEE80211_SCTL_SEQ) >> 4)
304 #define SN_TO_SEQ(ssn) (((ssn) << 4) & IEEE80211_SCTL_SEQ)
305 #define MAX_SN ((IEEE80211_SCTL_SEQ) >> 4)
306
307 enum {
308         /* CMD_SIZE_NORMAL = 0, */
309         CMD_SIZE_HUGE = (1 << 0),
310         /* CMD_SYNC = 0, */
311         CMD_ASYNC = (1 << 1),
312         /* CMD_NO_SKB = 0, */
313         CMD_WANT_SKB = (1 << 2),
314 };
315
316 struct iwl3945_cmd;
317 struct iwl3945_priv;
318
319 struct iwl3945_cmd_meta {
320         struct iwl3945_cmd_meta *source;
321         union {
322                 struct sk_buff *skb;
323                 int (*callback)(struct iwl3945_priv *priv,
324                                 struct iwl3945_cmd *cmd, struct sk_buff *skb);
325         } __attribute__ ((packed)) u;
326
327         /* The CMD_SIZE_HUGE flag bit indicates that the command
328          * structure is stored at the end of the shared queue memory. */
329         u32 flags;
330
331 } __attribute__ ((packed));
332
333 /**
334  * struct iwl3945_cmd
335  *
336  * For allocation of the command and tx queues, this establishes the overall
337  * size of the largest command we send to uCode, except for a scan command
338  * (which is relatively huge; space is allocated separately).
339  */
340 struct iwl3945_cmd {
341         struct iwl3945_cmd_meta meta;
342         struct iwl3945_cmd_header hdr;
343         union {
344                 struct iwl3945_addsta_cmd addsta;
345                 struct iwl3945_led_cmd led;
346                 u32 flags;
347                 u8 val8;
348                 u16 val16;
349                 u32 val32;
350                 struct iwl3945_bt_cmd bt;
351                 struct iwl3945_rxon_time_cmd rxon_time;
352                 struct iwl3945_powertable_cmd powertable;
353                 struct iwl3945_qosparam_cmd qosparam;
354                 struct iwl3945_tx_cmd tx;
355                 struct iwl3945_tx_beacon_cmd tx_beacon;
356                 struct iwl3945_rxon_assoc_cmd rxon_assoc;
357                 u8 *indirect;
358                 u8 payload[360];
359         } __attribute__ ((packed)) cmd;
360 } __attribute__ ((packed));
361
362 struct iwl3945_host_cmd {
363         u8 id;
364         u16 len;
365         struct iwl3945_cmd_meta meta;
366         const void *data;
367 };
368
369 #define TFD_MAX_PAYLOAD_SIZE (sizeof(struct iwl3945_cmd) - \
370                               sizeof(struct iwl3945_cmd_meta))
371
372 /*
373  * RX related structures and functions
374  */
375 #define RX_FREE_BUFFERS 64
376 #define RX_LOW_WATERMARK 8
377
378 #define SUP_RATE_11A_MAX_NUM_CHANNELS  8
379 #define SUP_RATE_11B_MAX_NUM_CHANNELS  4
380 #define SUP_RATE_11G_MAX_NUM_CHANNELS  12
381
382 /**
383  * struct iwl3945_rx_queue - Rx queue
384  * @processed: Internal index to last handled Rx packet
385  * @read: Shared index to newest available Rx buffer
386  * @write: Shared index to oldest written Rx packet
387  * @free_count: Number of pre-allocated buffers in rx_free
388  * @rx_free: list of free SKBs for use
389  * @rx_used: List of Rx buffers with no SKB
390  * @need_update: flag to indicate we need to update read/write index
391  *
392  * NOTE:  rx_free and rx_used are used as a FIFO for iwl3945_rx_mem_buffers
393  */
394 struct iwl3945_rx_queue {
395         __le32 *bd;
396         dma_addr_t dma_addr;
397         struct iwl3945_rx_mem_buffer pool[RX_QUEUE_SIZE + RX_FREE_BUFFERS];
398         struct iwl3945_rx_mem_buffer *queue[RX_QUEUE_SIZE];
399         u32 processed;
400         u32 read;
401         u32 write;
402         u32 free_count;
403         struct list_head rx_free;
404         struct list_head rx_used;
405         int need_update;
406         spinlock_t lock;
407 };
408
409 #define IWL_SUPPORTED_RATES_IE_LEN         8
410
411 #define SCAN_INTERVAL 100
412
413 #define MAX_A_CHANNELS  252
414 #define MIN_A_CHANNELS  7
415
416 #define MAX_B_CHANNELS  14
417 #define MIN_B_CHANNELS  1
418
419 #define STATUS_HCMD_ACTIVE      0       /* host command in progress */
420 #define STATUS_INT_ENABLED      1
421 #define STATUS_RF_KILL_HW       2
422 #define STATUS_RF_KILL_SW       3
423 #define STATUS_INIT             4
424 #define STATUS_ALIVE            5
425 #define STATUS_READY            6
426 #define STATUS_TEMPERATURE      7
427 #define STATUS_GEO_CONFIGURED   8
428 #define STATUS_EXIT_PENDING     9
429 #define STATUS_IN_SUSPEND       10
430 #define STATUS_STATISTICS       11
431 #define STATUS_SCANNING         12
432 #define STATUS_SCAN_ABORTING    13
433 #define STATUS_SCAN_HW          14
434 #define STATUS_POWER_PMI        15
435 #define STATUS_FW_ERROR         16
436
437 #define MAX_TID_COUNT        9
438
439 #define IWL_INVALID_RATE     0xFF
440 #define IWL_INVALID_VALUE    -1
441
442 struct iwl3945_tid_data {
443         u16 seq_number;
444 };
445
446 struct iwl3945_hw_key {
447         enum ieee80211_key_alg alg;
448         int keylen;
449         u8 key[32];
450 };
451
452 union iwl3945_ht_rate_supp {
453         u16 rates;
454         struct {
455                 u8 siso_rate;
456                 u8 mimo_rate;
457         };
458 };
459
460 #ifdef CONFIG_IWL3945_QOS
461
462 union iwl3945_qos_capabity {
463         struct {
464                 u8 edca_count:4;        /* bit 0-3 */
465                 u8 q_ack:1;             /* bit 4 */
466                 u8 queue_request:1;     /* bit 5 */
467                 u8 txop_request:1;      /* bit 6 */
468                 u8 reserved:1;          /* bit 7 */
469         } q_AP;
470         struct {
471                 u8 acvo_APSD:1;         /* bit 0 */
472                 u8 acvi_APSD:1;         /* bit 1 */
473                 u8 ac_bk_APSD:1;        /* bit 2 */
474                 u8 ac_be_APSD:1;        /* bit 3 */
475                 u8 q_ack:1;             /* bit 4 */
476                 u8 max_len:2;           /* bit 5-6 */
477                 u8 more_data_ack:1;     /* bit 7 */
478         } q_STA;
479         u8 val;
480 };
481
482 /* QoS structures */
483 struct iwl3945_qos_info {
484         int qos_enable;
485         int qos_active;
486         union iwl3945_qos_capabity qos_cap;
487         struct iwl3945_qosparam_cmd def_qos_parm;
488 };
489 #endif /*CONFIG_IWL3945_QOS */
490
491 #define STA_PS_STATUS_WAKE             0
492 #define STA_PS_STATUS_SLEEP            1
493
494 struct iwl3945_station_entry {
495         struct iwl3945_addsta_cmd sta;
496         struct iwl3945_tid_data tid[MAX_TID_COUNT];
497         union {
498                 struct {
499                         u8 rate;
500                         u8 flags;
501                 } s;
502                 u16 rate_n_flags;
503         } current_rate;
504         u8 used;
505         u8 ps_status;
506         struct iwl3945_hw_key keyinfo;
507 };
508
509 /* one for each uCode image (inst/data, boot/init/runtime) */
510 struct fw_desc {
511         void *v_addr;           /* access by driver */
512         dma_addr_t p_addr;      /* access by card's busmaster DMA */
513         u32 len;                /* bytes */
514 };
515
516 /* uCode file layout */
517 struct iwl3945_ucode {
518         __le32 ver;             /* major/minor/subminor */
519         __le32 inst_size;       /* bytes of runtime instructions */
520         __le32 data_size;       /* bytes of runtime data */
521         __le32 init_size;       /* bytes of initialization instructions */
522         __le32 init_data_size;  /* bytes of initialization data */
523         __le32 boot_size;       /* bytes of bootstrap instructions */
524         u8 data[0];             /* data in same order as "size" elements */
525 };
526
527 #define IWL_IBSS_MAC_HASH_SIZE 32
528
529 struct iwl3945_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 /**
538  * struct iwl4965_driver_hw_info
539  * @max_txq_num: Max # Tx queues supported
540  * @ac_queue_count: # Tx queues for EDCA Access Categories (AC)
541  * @tx_cmd_len: Size of Tx command (but not including frame itself)
542  * @max_rxq_size: Max # Rx frames in Rx queue (must be power-of-2)
543  * @rx_buffer_size:
544  * @max_rxq_log: Log-base-2 of max_rxq_size
545  * @max_stations:
546  * @bcast_sta_id:
547  * @shared_virt: Pointer to driver/uCode shared Tx Byte Counts and Rx status
548  * @shared_phys: Physical Pointer to Tx Byte Counts and Rx status
549  */
550 struct iwl3945_driver_hw_info {
551         u16 max_txq_num;
552         u16 ac_queue_count;
553         u16 tx_cmd_len;
554         u16 max_rxq_size;
555         u32 rx_buffer_size;
556         u16 max_rxq_log;
557         u8  max_stations;
558         u8  bcast_sta_id;
559         void *shared_virt;
560         dma_addr_t shared_phys;
561 };
562
563
564 #define STA_FLG_RTS_MIMO_PROT_MSK       __constant_cpu_to_le32(1 << 17)
565 #define STA_FLG_AGG_MPDU_8US_MSK        __constant_cpu_to_le32(1 << 18)
566 #define STA_FLG_MAX_AGG_SIZE_POS        (19)
567 #define STA_FLG_MAX_AGG_SIZE_MSK        __constant_cpu_to_le32(3 << 19)
568 #define STA_FLG_FAT_EN_MSK              __constant_cpu_to_le32(1 << 21)
569 #define STA_FLG_MIMO_DIS_MSK            __constant_cpu_to_le32(1 << 22)
570 #define STA_FLG_AGG_MPDU_DENSITY_POS    (23)
571 #define STA_FLG_AGG_MPDU_DENSITY_MSK    __constant_cpu_to_le32(7 << 23)
572 #define HT_SHORT_GI_20MHZ_ONLY          (1 << 0)
573 #define HT_SHORT_GI_40MHZ_ONLY          (1 << 1)
574
575
576 #define IWL_RX_HDR(x) ((struct iwl3945_rx_frame_hdr *)(\
577                        x->u.rx_frame.stats.payload + \
578                        x->u.rx_frame.stats.phy_count))
579 #define IWL_RX_END(x) ((struct iwl3945_rx_frame_end *)(\
580                        IWL_RX_HDR(x)->payload + \
581                        le16_to_cpu(IWL_RX_HDR(x)->len)))
582 #define IWL_RX_STATS(x) (&x->u.rx_frame.stats)
583 #define IWL_RX_DATA(x) (IWL_RX_HDR(x)->payload)
584
585
586 /******************************************************************************
587  *
588  * Functions implemented in iwl-base.c which are forward declared here
589  * for use by iwl-*.c
590  *
591  *****************************************************************************/
592 struct iwl3945_addsta_cmd;
593 extern int iwl3945_send_add_station(struct iwl3945_priv *priv,
594                                 struct iwl3945_addsta_cmd *sta, u8 flags);
595 extern u8 iwl3945_add_station(struct iwl3945_priv *priv, const u8 *bssid,
596                           int is_ap, u8 flags);
597 extern int iwl3945_is_network_packet(struct iwl3945_priv *priv,
598                                  struct ieee80211_hdr *header);
599 extern int iwl3945_power_init_handle(struct iwl3945_priv *priv);
600 extern int iwl3945_eeprom_init(struct iwl3945_priv *priv);
601 #ifdef CONFIG_IWL3945_DEBUG
602 extern void iwl3945_report_frame(struct iwl3945_priv *priv,
603                              struct iwl3945_rx_packet *pkt,
604                              struct ieee80211_hdr *header, int group100);
605 #else
606 static inline void iwl3945_report_frame(struct iwl3945_priv *priv,
607                                     struct iwl3945_rx_packet *pkt,
608                                     struct ieee80211_hdr *header,
609                                     int group100) {}
610 #endif
611 extern void iwl3945_handle_data_packet_monitor(struct iwl3945_priv *priv,
612                                            struct iwl3945_rx_mem_buffer *rxb,
613                                            void *data, short len,
614                                            struct ieee80211_rx_status *stats,
615                                            u16 phy_flags);
616 extern int iwl3945_is_duplicate_packet(struct iwl3945_priv *priv,
617                                        struct ieee80211_hdr *header);
618 extern int iwl3945_rx_queue_alloc(struct iwl3945_priv *priv);
619 extern void iwl3945_rx_queue_reset(struct iwl3945_priv *priv,
620                                struct iwl3945_rx_queue *rxq);
621 extern int iwl3945_calc_db_from_ratio(int sig_ratio);
622 extern int iwl3945_calc_sig_qual(int rssi_dbm, int noise_dbm);
623 extern int iwl3945_tx_queue_init(struct iwl3945_priv *priv,
624                              struct iwl3945_tx_queue *txq, int count, u32 id);
625 extern void iwl3945_rx_replenish(void *data);
626 extern void iwl3945_tx_queue_free(struct iwl3945_priv *priv, struct iwl3945_tx_queue *txq);
627 extern int iwl3945_send_cmd_pdu(struct iwl3945_priv *priv, u8 id, u16 len,
628                             const void *data);
629 extern int __must_check iwl3945_send_cmd(struct iwl3945_priv *priv,
630                 struct iwl3945_host_cmd *cmd);
631 extern unsigned int iwl3945_fill_beacon_frame(struct iwl3945_priv *priv,
632                                         struct ieee80211_hdr *hdr,
633                                         const u8 *dest, int left);
634 extern int iwl3945_rx_queue_update_write_ptr(struct iwl3945_priv *priv,
635                                          struct iwl3945_rx_queue *q);
636 extern int iwl3945_send_statistics_request(struct iwl3945_priv *priv);
637 extern void iwl3945_set_decrypted_flag(struct iwl3945_priv *priv, struct sk_buff *skb,
638                                    u32 decrypt_res,
639                                    struct ieee80211_rx_status *stats);
640 extern const u8 iwl3945_broadcast_addr[ETH_ALEN];
641
642 /*
643  * Currently used by iwl-3945-rs... look at restructuring so that it doesn't
644  * call this... todo... fix that.
645 */
646 extern u8 iwl3945_sync_station(struct iwl3945_priv *priv, int sta_id,
647                            u16 tx_rate, u8 flags);
648
649 /******************************************************************************
650  *
651  * Functions implemented in iwl-[34]*.c which are forward declared here
652  * for use by iwl-base.c
653  *
654  * NOTE:  The implementation of these functions are hardware specific
655  * which is why they are in the hardware specific files (vs. iwl-base.c)
656  *
657  * Naming convention --
658  * iwl3945_         <-- Its part of iwlwifi (should be changed to iwl3945_)
659  * iwl3945_hw_      <-- Hardware specific (implemented in iwl-XXXX.c by all HW)
660  * iwlXXXX_     <-- Hardware specific (implemented in iwl-XXXX.c for XXXX)
661  * iwl3945_bg_      <-- Called from work queue context
662  * iwl3945_mac_     <-- mac80211 callback
663  *
664  ****************************************************************************/
665 extern void iwl3945_hw_rx_handler_setup(struct iwl3945_priv *priv);
666 extern void iwl3945_hw_setup_deferred_work(struct iwl3945_priv *priv);
667 extern void iwl3945_hw_cancel_deferred_work(struct iwl3945_priv *priv);
668 extern int iwl3945_hw_rxq_stop(struct iwl3945_priv *priv);
669 extern int iwl3945_hw_set_hw_setting(struct iwl3945_priv *priv);
670 extern int iwl3945_hw_nic_init(struct iwl3945_priv *priv);
671 extern int iwl3945_hw_nic_stop_master(struct iwl3945_priv *priv);
672 extern void iwl3945_hw_txq_ctx_free(struct iwl3945_priv *priv);
673 extern void iwl3945_hw_txq_ctx_stop(struct iwl3945_priv *priv);
674 extern int iwl3945_hw_nic_reset(struct iwl3945_priv *priv);
675 extern int iwl3945_hw_txq_attach_buf_to_tfd(struct iwl3945_priv *priv, void *tfd,
676                                         dma_addr_t addr, u16 len);
677 extern int iwl3945_hw_txq_free_tfd(struct iwl3945_priv *priv, struct iwl3945_tx_queue *txq);
678 extern int iwl3945_hw_get_temperature(struct iwl3945_priv *priv);
679 extern int iwl3945_hw_tx_queue_init(struct iwl3945_priv *priv,
680                                 struct iwl3945_tx_queue *txq);
681 extern unsigned int iwl3945_hw_get_beacon_cmd(struct iwl3945_priv *priv,
682                                  struct iwl3945_frame *frame, u8 rate);
683 extern int iwl3945_hw_get_rx_read(struct iwl3945_priv *priv);
684 extern void iwl3945_hw_build_tx_cmd_rate(struct iwl3945_priv *priv,
685                                      struct iwl3945_cmd *cmd,
686                                      struct ieee80211_tx_control *ctrl,
687                                      struct ieee80211_hdr *hdr,
688                                      int sta_id, int tx_id);
689 extern int iwl3945_hw_reg_send_txpower(struct iwl3945_priv *priv);
690 extern int iwl3945_hw_reg_set_txpower(struct iwl3945_priv *priv, s8 power);
691 extern void iwl3945_hw_rx_statistics(struct iwl3945_priv *priv,
692                                  struct iwl3945_rx_mem_buffer *rxb);
693 extern void iwl3945_disable_events(struct iwl3945_priv *priv);
694 extern int iwl4965_get_temperature(const struct iwl3945_priv *priv);
695
696 /**
697  * iwl3945_hw_find_station - Find station id for a given BSSID
698  * @bssid: MAC address of station ID to find
699  *
700  * NOTE:  This should not be hardware specific but the code has
701  * not yet been merged into a single common layer for managing the
702  * station tables.
703  */
704 extern u8 iwl3945_hw_find_station(struct iwl3945_priv *priv, const u8 *bssid);
705
706 extern int iwl3945_hw_channel_switch(struct iwl3945_priv *priv, u16 channel);
707
708 /*
709  * Forward declare iwl-3945.c functions for iwl-base.c
710  */
711 extern int iwl3945_eeprom_acquire_semaphore(struct iwl3945_priv *priv);
712 extern __le32 iwl3945_get_antenna_flags(const struct iwl3945_priv *priv);
713 extern int iwl3945_init_hw_rate_table(struct iwl3945_priv *priv);
714 extern void iwl3945_reg_txpower_periodic(struct iwl3945_priv *priv);
715 extern int iwl3945_txpower_set_from_eeprom(struct iwl3945_priv *priv);
716 extern u8 iwl3945_sync_sta(struct iwl3945_priv *priv, int sta_id,
717                  u16 tx_rate, u8 flags);
718
719
720 #ifdef CONFIG_IWL3945_SPECTRUM_MEASUREMENT
721
722 enum {
723         MEASUREMENT_READY = (1 << 0),
724         MEASUREMENT_ACTIVE = (1 << 1),
725 };
726
727 #endif
728
729 struct iwl3945_priv {
730
731         /* ieee device used by generic ieee processing code */
732         struct ieee80211_hw *hw;
733         struct ieee80211_channel *ieee_channels;
734         struct ieee80211_rate *ieee_rates;
735
736         /* temporary frame storage list */
737         struct list_head free_frames;
738         int frames_count;
739
740         u8 phymode;
741         int alloc_rxb_skb;
742
743         void (*rx_handlers[REPLY_MAX])(struct iwl3945_priv *priv,
744                                        struct iwl3945_rx_mem_buffer *rxb);
745
746         const struct ieee80211_hw_mode *modes;
747
748 #ifdef CONFIG_IWL3945_SPECTRUM_MEASUREMENT
749         /* spectrum measurement report caching */
750         struct iwl3945_spectrum_notification measure_report;
751         u8 measurement_status;
752 #endif
753         /* ucode beacon time */
754         u32 ucode_beacon_time;
755
756         /* we allocate array of iwl3945_channel_info for NIC's valid channels.
757          *    Access via channel # using indirect index array */
758         struct iwl3945_channel_info *channel_info;      /* channel info array */
759         u8 channel_count;       /* # of channels */
760
761         /* each calibration channel group in the EEPROM has a derived
762          * clip setting for each rate. */
763         const struct iwl3945_clip_group clip_groups[5];
764
765         /* thermal calibration */
766         s32 temperature;        /* degrees Kelvin */
767         s32 last_temperature;
768
769         /* Scan related variables */
770         unsigned long last_scan_jiffies;
771         unsigned long scan_start;
772         unsigned long scan_pass_start;
773         unsigned long scan_start_tsf;
774         int scan_bands;
775         int one_direct_scan;
776         u8 direct_ssid_len;
777         u8 direct_ssid[IW_ESSID_MAX_SIZE];
778         struct iwl3945_scan_cmd *scan;
779         u8 only_active_channel;
780
781         /* spinlock */
782         spinlock_t lock;        /* protect general shared data */
783         spinlock_t hcmd_lock;   /* protect hcmd */
784         struct mutex mutex;
785
786         /* basic pci-network driver stuff */
787         struct pci_dev *pci_dev;
788
789         /* pci hardware address support */
790         void __iomem *hw_base;
791
792         /* uCode images, save to reload in case of failure */
793         struct fw_desc ucode_code;      /* runtime inst */
794         struct fw_desc ucode_data;      /* runtime data original */
795         struct fw_desc ucode_data_backup;       /* runtime data save/restore */
796         struct fw_desc ucode_init;      /* initialization inst */
797         struct fw_desc ucode_init_data; /* initialization data */
798         struct fw_desc ucode_boot;      /* bootstrap inst */
799
800
801         struct iwl3945_rxon_time_cmd rxon_timing;
802
803         /* We declare this const so it can only be
804          * changed via explicit cast within the
805          * routines that actually update the physical
806          * hardware */
807         const struct iwl3945_rxon_cmd active_rxon;
808         struct iwl3945_rxon_cmd staging_rxon;
809
810         int error_recovering;
811         struct iwl3945_rxon_cmd recovery_rxon;
812
813         /* 1st responses from initialize and runtime uCode images.
814          * 4965's initialize alive response contains some calibration data. */
815         struct iwl3945_init_alive_resp card_alive_init;
816         struct iwl3945_alive_resp card_alive;
817
818 #ifdef LED
819         /* LED related variables */
820         struct iwl3945_activity_blink activity;
821         unsigned long led_packets;
822         int led_state;
823 #endif
824
825         u16 active_rate;
826         u16 active_rate_basic;
827
828         u8 call_post_assoc_from_beacon;
829         u8 assoc_station_added;
830         /* Rate scaling data */
831         s8 data_retry_limit;
832         u8 retry_rate;
833
834         wait_queue_head_t wait_command_queue;
835
836         int activity_timer_active;
837
838         /* Rx and Tx DMA processing queues */
839         struct iwl3945_rx_queue rxq;
840         struct iwl3945_tx_queue txq[IWL_MAX_NUM_QUEUES];
841
842         unsigned long status;
843         u32 config;
844
845         int last_rx_rssi;       /* From Rx packet statisitics */
846         int last_rx_noise;      /* From beacon statistics */
847
848         struct iwl3945_power_mgr power_data;
849
850         struct iwl3945_notif_statistics statistics;
851         unsigned long last_statistics_time;
852
853         /* context information */
854         u8 essid[IW_ESSID_MAX_SIZE];
855         u8 essid_len;
856         u16 rates_mask;
857
858         u32 power_mode;
859         u32 antenna;
860         u8 bssid[ETH_ALEN];
861         u16 rts_threshold;
862         u8 mac_addr[ETH_ALEN];
863
864         /*station table variables */
865         spinlock_t sta_lock;
866         int num_stations;
867         struct iwl3945_station_entry stations[IWL_STATION_COUNT];
868
869         /* Indication if ieee80211_ops->open has been called */
870         int is_open;
871
872         u8 mac80211_registered;
873         int is_abg;
874
875         u32 notif_missed_beacons;
876
877         /* Rx'd packet timing information */
878         u32 last_beacon_time;
879         u64 last_tsf;
880
881         /* Duplicate packet detection */
882         u16 last_seq_num;
883         u16 last_frag_num;
884         unsigned long last_packet_time;
885
886         /* Hash table for finding stations in IBSS network */
887         struct list_head ibss_mac_hash[IWL_IBSS_MAC_HASH_SIZE];
888
889         /* eeprom */
890         struct iwl3945_eeprom eeprom;
891
892         int iw_mode;
893
894         struct sk_buff *ibss_beacon;
895
896         /* Last Rx'd beacon timestamp */
897         u32 timestamp0;
898         u32 timestamp1;
899         u16 beacon_int;
900         struct iwl3945_driver_hw_info hw_setting;
901         int interface_id;
902
903         /* Current association information needed to configure the
904          * hardware */
905         u16 assoc_id;
906         u16 assoc_capability;
907         u8 ps_mode;
908
909 #ifdef CONFIG_IWL3945_QOS
910         struct iwl3945_qos_info qos_data;
911 #endif /*CONFIG_IWL3945_QOS */
912
913         struct workqueue_struct *workqueue;
914
915         struct work_struct up;
916         struct work_struct restart;
917         struct work_struct calibrated_work;
918         struct work_struct scan_completed;
919         struct work_struct rx_replenish;
920         struct work_struct rf_kill;
921         struct work_struct abort_scan;
922         struct work_struct update_link_led;
923         struct work_struct auth_work;
924         struct work_struct report_work;
925         struct work_struct request_scan;
926         struct work_struct beacon_update;
927
928         struct tasklet_struct irq_tasklet;
929
930         struct delayed_work init_alive_start;
931         struct delayed_work alive_start;
932         struct delayed_work activity_timer;
933         struct delayed_work thermal_periodic;
934         struct delayed_work gather_stats;
935         struct delayed_work scan_check;
936         struct delayed_work post_associate;
937
938 #define IWL_DEFAULT_TX_POWER 0x0F
939         s8 user_txpower_limit;
940         s8 max_channel_txpower_limit;
941
942 #ifdef CONFIG_PM
943         u32 pm_state[16];
944 #endif
945
946 #ifdef CONFIG_IWL3945_DEBUG
947         /* debugging info */
948         u32 framecnt_to_us;
949         atomic_t restrict_refcnt;
950 #endif
951 };                              /*iwl3945_priv */
952
953 static inline int iwl3945_is_associated(struct iwl3945_priv *priv)
954 {
955         return (priv->active_rxon.filter_flags & RXON_FILTER_ASSOC_MSK) ? 1 : 0;
956 }
957
958 static inline int is_channel_valid(const struct iwl3945_channel_info *ch_info)
959 {
960         if (ch_info == NULL)
961                 return 0;
962         return (ch_info->flags & EEPROM_CHANNEL_VALID) ? 1 : 0;
963 }
964
965 static inline int is_channel_narrow(const struct iwl3945_channel_info *ch_info)
966 {
967         return (ch_info->flags & EEPROM_CHANNEL_NARROW) ? 1 : 0;
968 }
969
970 static inline int is_channel_radar(const struct iwl3945_channel_info *ch_info)
971 {
972         return (ch_info->flags & EEPROM_CHANNEL_RADAR) ? 1 : 0;
973 }
974
975 static inline u8 is_channel_a_band(const struct iwl3945_channel_info *ch_info)
976 {
977         return ch_info->phymode == MODE_IEEE80211A;
978 }
979
980 static inline u8 is_channel_bg_band(const struct iwl3945_channel_info *ch_info)
981 {
982         return ((ch_info->phymode == MODE_IEEE80211B) ||
983                 (ch_info->phymode == MODE_IEEE80211G));
984 }
985
986 static inline int is_channel_passive(const struct iwl3945_channel_info *ch)
987 {
988         return (!(ch->flags & EEPROM_CHANNEL_ACTIVE)) ? 1 : 0;
989 }
990
991 static inline int is_channel_ibss(const struct iwl3945_channel_info *ch)
992 {
993         return ((ch->flags & EEPROM_CHANNEL_IBSS)) ? 1 : 0;
994 }
995
996 extern const struct iwl3945_channel_info *iwl3945_get_channel_info(
997         const struct iwl3945_priv *priv, int phymode, u16 channel);
998
999 /* Requires full declaration of iwl3945_priv before including */
1000 #include "iwl-3945-io.h"
1001
1002 #endif