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