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