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