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