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