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