]> git.karo-electronics.de Git - karo-tx-linux.git/blob - drivers/net/wireless/ipw2200.h
Merge branch 'viro'
[karo-tx-linux.git] / drivers / net / wireless / ipw2200.h
1 /******************************************************************************
2
3   Copyright(c) 2003 - 2005 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., 59
16   Temple Place - Suite 330, Boston, MA  02111-1307, 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 __ipw2200_h__
28 #define __ipw2200_h__
29
30 #define WEXT_USECHANNELS 1
31
32 #include <linux/module.h>
33 #include <linux/moduleparam.h>
34 #include <linux/config.h>
35 #include <linux/init.h>
36 #include <linux/mutex.h>
37
38 #include <linux/pci.h>
39 #include <linux/netdevice.h>
40 #include <linux/ethtool.h>
41 #include <linux/skbuff.h>
42 #include <linux/etherdevice.h>
43 #include <linux/delay.h>
44 #include <linux/random.h>
45 #include <linux/dma-mapping.h>
46
47 #include <linux/firmware.h>
48 #include <linux/wireless.h>
49 #include <linux/dma-mapping.h>
50 #include <linux/jiffies.h>
51 #include <asm/io.h>
52
53 #include <net/ieee80211.h>
54 #include <net/ieee80211_radiotap.h>
55
56 #define DRV_NAME        "ipw2200"
57
58 #include <linux/workqueue.h>
59
60 /* Authentication  and Association States */
61 enum connection_manager_assoc_states {
62         CMAS_INIT = 0,
63         CMAS_TX_AUTH_SEQ_1,
64         CMAS_RX_AUTH_SEQ_2,
65         CMAS_AUTH_SEQ_1_PASS,
66         CMAS_AUTH_SEQ_1_FAIL,
67         CMAS_TX_AUTH_SEQ_3,
68         CMAS_RX_AUTH_SEQ_4,
69         CMAS_AUTH_SEQ_2_PASS,
70         CMAS_AUTH_SEQ_2_FAIL,
71         CMAS_AUTHENTICATED,
72         CMAS_TX_ASSOC,
73         CMAS_RX_ASSOC_RESP,
74         CMAS_ASSOCIATED,
75         CMAS_LAST
76 };
77
78 #define IPW_WAIT                     (1<<0)
79 #define IPW_QUIET                    (1<<1)
80 #define IPW_ROAMING                  (1<<2)
81
82 #define IPW_POWER_MODE_CAM           0x00       //(always on)
83 #define IPW_POWER_INDEX_1            0x01
84 #define IPW_POWER_INDEX_2            0x02
85 #define IPW_POWER_INDEX_3            0x03
86 #define IPW_POWER_INDEX_4            0x04
87 #define IPW_POWER_INDEX_5            0x05
88 #define IPW_POWER_AC                 0x06
89 #define IPW_POWER_BATTERY            0x07
90 #define IPW_POWER_LIMIT              0x07
91 #define IPW_POWER_MASK               0x0F
92 #define IPW_POWER_ENABLED            0x10
93 #define IPW_POWER_LEVEL(x)           ((x) & IPW_POWER_MASK)
94
95 #define IPW_CMD_HOST_COMPLETE                 2
96 #define IPW_CMD_POWER_DOWN                    4
97 #define IPW_CMD_SYSTEM_CONFIG                 6
98 #define IPW_CMD_MULTICAST_ADDRESS             7
99 #define IPW_CMD_SSID                          8
100 #define IPW_CMD_ADAPTER_ADDRESS              11
101 #define IPW_CMD_PORT_TYPE                    12
102 #define IPW_CMD_RTS_THRESHOLD                15
103 #define IPW_CMD_FRAG_THRESHOLD               16
104 #define IPW_CMD_POWER_MODE                   17
105 #define IPW_CMD_WEP_KEY                      18
106 #define IPW_CMD_TGI_TX_KEY                   19
107 #define IPW_CMD_SCAN_REQUEST                 20
108 #define IPW_CMD_ASSOCIATE                    21
109 #define IPW_CMD_SUPPORTED_RATES              22
110 #define IPW_CMD_SCAN_ABORT                   23
111 #define IPW_CMD_TX_FLUSH                     24
112 #define IPW_CMD_QOS_PARAMETERS               25
113 #define IPW_CMD_SCAN_REQUEST_EXT             26
114 #define IPW_CMD_DINO_CONFIG                  30
115 #define IPW_CMD_RSN_CAPABILITIES             31
116 #define IPW_CMD_RX_KEY                       32
117 #define IPW_CMD_CARD_DISABLE                 33
118 #define IPW_CMD_SEED_NUMBER                  34
119 #define IPW_CMD_TX_POWER                     35
120 #define IPW_CMD_COUNTRY_INFO                 36
121 #define IPW_CMD_AIRONET_INFO                 37
122 #define IPW_CMD_AP_TX_POWER                  38
123 #define IPW_CMD_CCKM_INFO                    39
124 #define IPW_CMD_CCX_VER_INFO                 40
125 #define IPW_CMD_SET_CALIBRATION              41
126 #define IPW_CMD_SENSITIVITY_CALIB            42
127 #define IPW_CMD_RETRY_LIMIT                  51
128 #define IPW_CMD_IPW_PRE_POWER_DOWN           58
129 #define IPW_CMD_VAP_BEACON_TEMPLATE          60
130 #define IPW_CMD_VAP_DTIM_PERIOD              61
131 #define IPW_CMD_EXT_SUPPORTED_RATES          62
132 #define IPW_CMD_VAP_LOCAL_TX_PWR_CONSTRAINT  63
133 #define IPW_CMD_VAP_QUIET_INTERVALS          64
134 #define IPW_CMD_VAP_CHANNEL_SWITCH           65
135 #define IPW_CMD_VAP_MANDATORY_CHANNELS       66
136 #define IPW_CMD_VAP_CELL_PWR_LIMIT           67
137 #define IPW_CMD_VAP_CF_PARAM_SET             68
138 #define IPW_CMD_VAP_SET_BEACONING_STATE      69
139 #define IPW_CMD_MEASUREMENT                  80
140 #define IPW_CMD_POWER_CAPABILITY             81
141 #define IPW_CMD_SUPPORTED_CHANNELS           82
142 #define IPW_CMD_TPC_REPORT                   83
143 #define IPW_CMD_WME_INFO                     84
144 #define IPW_CMD_PRODUCTION_COMMAND           85
145 #define IPW_CMD_LINKSYS_EOU_INFO             90
146
147 #define RFD_SIZE                              4
148 #define NUM_TFD_CHUNKS                        6
149
150 #define TX_QUEUE_SIZE                        32
151 #define RX_QUEUE_SIZE                        32
152
153 #define DINO_CMD_WEP_KEY                   0x08
154 #define DINO_CMD_TX                        0x0B
155 #define DCT_ANTENNA_A                      0x01
156 #define DCT_ANTENNA_B                      0x02
157
158 #define IPW_A_MODE                         0
159 #define IPW_B_MODE                         1
160 #define IPW_G_MODE                         2
161
162 /*
163  * TX Queue Flag Definitions
164  */
165
166 /* tx wep key definition */
167 #define DCT_WEP_KEY_NOT_IMMIDIATE       0x00
168 #define DCT_WEP_KEY_64Bit               0x40
169 #define DCT_WEP_KEY_128Bit              0x80
170 #define DCT_WEP_KEY_128bitIV            0xC0
171 #define DCT_WEP_KEY_SIZE_MASK           0xC0
172
173 #define DCT_WEP_KEY_INDEX_MASK          0x0F
174 #define DCT_WEP_INDEX_USE_IMMEDIATE     0x20
175
176 /* abort attempt if mgmt frame is rx'd */
177 #define DCT_FLAG_ABORT_MGMT                0x01
178
179 /* require CTS */
180 #define DCT_FLAG_CTS_REQUIRED              0x02
181
182 /* use short preamble */
183 #define DCT_FLAG_LONG_PREAMBLE             0x00
184 #define DCT_FLAG_SHORT_PREAMBLE            0x04
185
186 /* RTS/CTS first */
187 #define DCT_FLAG_RTS_REQD                  0x08
188
189 /* dont calculate duration field */
190 #define DCT_FLAG_DUR_SET                   0x10
191
192 /* even if MAC WEP set (allows pre-encrypt) */
193 #define DCT_FLAG_NO_WEP              0x20
194
195 /* overwrite TSF field */
196 #define DCT_FLAG_TSF_REQD                  0x40
197
198 /* ACK rx is expected to follow */
199 #define DCT_FLAG_ACK_REQD                  0x80
200
201 /* TX flags extension */
202 #define DCT_FLAG_EXT_MODE_CCK  0x01
203 #define DCT_FLAG_EXT_MODE_OFDM 0x00
204
205 #define DCT_FLAG_EXT_SECURITY_WEP     0x00
206 #define DCT_FLAG_EXT_SECURITY_NO      DCT_FLAG_EXT_SECURITY_WEP
207 #define DCT_FLAG_EXT_SECURITY_CKIP    0x04
208 #define DCT_FLAG_EXT_SECURITY_CCM     0x08
209 #define DCT_FLAG_EXT_SECURITY_TKIP    0x0C
210 #define DCT_FLAG_EXT_SECURITY_MASK    0x0C
211
212 #define DCT_FLAG_EXT_QOS_ENABLED      0x10
213
214 #define DCT_FLAG_EXT_HC_NO_SIFS_PIFS  0x00
215 #define DCT_FLAG_EXT_HC_SIFS          0x20
216 #define DCT_FLAG_EXT_HC_PIFS          0x40
217
218 #define TX_RX_TYPE_MASK                    0xFF
219 #define TX_FRAME_TYPE                      0x00
220 #define TX_HOST_COMMAND_TYPE               0x01
221 #define RX_FRAME_TYPE                      0x09
222 #define RX_HOST_NOTIFICATION_TYPE          0x03
223 #define RX_HOST_CMD_RESPONSE_TYPE          0x04
224 #define RX_TX_FRAME_RESPONSE_TYPE          0x05
225 #define TFD_NEED_IRQ_MASK                  0x04
226
227 #define HOST_CMD_DINO_CONFIG               30
228
229 #define HOST_NOTIFICATION_STATUS_ASSOCIATED             10
230 #define HOST_NOTIFICATION_STATUS_AUTHENTICATE           11
231 #define HOST_NOTIFICATION_STATUS_SCAN_CHANNEL_RESULT    12
232 #define HOST_NOTIFICATION_STATUS_SCAN_COMPLETED         13
233 #define HOST_NOTIFICATION_STATUS_FRAG_LENGTH            14
234 #define HOST_NOTIFICATION_STATUS_LINK_DETERIORATION     15
235 #define HOST_NOTIFICATION_DINO_CONFIG_RESPONSE          16
236 #define HOST_NOTIFICATION_STATUS_BEACON_STATE           17
237 #define HOST_NOTIFICATION_STATUS_TGI_TX_KEY             18
238 #define HOST_NOTIFICATION_TX_STATUS                     19
239 #define HOST_NOTIFICATION_CALIB_KEEP_RESULTS            20
240 #define HOST_NOTIFICATION_MEASUREMENT_STARTED           21
241 #define HOST_NOTIFICATION_MEASUREMENT_ENDED             22
242 #define HOST_NOTIFICATION_CHANNEL_SWITCHED              23
243 #define HOST_NOTIFICATION_RX_DURING_QUIET_PERIOD        24
244 #define HOST_NOTIFICATION_NOISE_STATS                   25
245 #define HOST_NOTIFICATION_S36_MEASUREMENT_ACCEPTED      30
246 #define HOST_NOTIFICATION_S36_MEASUREMENT_REFUSED       31
247
248 #define HOST_NOTIFICATION_STATUS_BEACON_MISSING         1
249 #define IPW_MB_DISASSOCIATE_THRESHOLD_DEFAULT           24
250 #define IPW_MB_ROAMING_THRESHOLD_DEFAULT                8
251 #define IPW_REAL_RATE_RX_PACKET_THRESHOLD               300
252
253 #define MACADRR_BYTE_LEN                     6
254
255 #define DCR_TYPE_AP                       0x01
256 #define DCR_TYPE_WLAP                     0x02
257 #define DCR_TYPE_MU_ESS                   0x03
258 #define DCR_TYPE_MU_IBSS                  0x04
259 #define DCR_TYPE_MU_PIBSS                 0x05
260 #define DCR_TYPE_SNIFFER                  0x06
261 #define DCR_TYPE_MU_BSS        DCR_TYPE_MU_ESS
262
263 /* QoS  definitions */
264
265 #define CW_MIN_OFDM          15
266 #define CW_MAX_OFDM          1023
267 #define CW_MIN_CCK           31
268 #define CW_MAX_CCK           1023
269
270 #define QOS_TX0_CW_MIN_OFDM      CW_MIN_OFDM
271 #define QOS_TX1_CW_MIN_OFDM      CW_MIN_OFDM
272 #define QOS_TX2_CW_MIN_OFDM      ( (CW_MIN_OFDM + 1) / 2 - 1 )
273 #define QOS_TX3_CW_MIN_OFDM      ( (CW_MIN_OFDM + 1) / 4 - 1 )
274
275 #define QOS_TX0_CW_MIN_CCK       CW_MIN_CCK
276 #define QOS_TX1_CW_MIN_CCK       CW_MIN_CCK
277 #define QOS_TX2_CW_MIN_CCK       ( (CW_MIN_CCK + 1) / 2 - 1 )
278 #define QOS_TX3_CW_MIN_CCK       ( (CW_MIN_CCK + 1) / 4 - 1 )
279
280 #define QOS_TX0_CW_MAX_OFDM      CW_MAX_OFDM
281 #define QOS_TX1_CW_MAX_OFDM      CW_MAX_OFDM
282 #define QOS_TX2_CW_MAX_OFDM      CW_MIN_OFDM
283 #define QOS_TX3_CW_MAX_OFDM      ( (CW_MIN_OFDM + 1) / 2 - 1 )
284
285 #define QOS_TX0_CW_MAX_CCK       CW_MAX_CCK
286 #define QOS_TX1_CW_MAX_CCK       CW_MAX_CCK
287 #define QOS_TX2_CW_MAX_CCK       CW_MIN_CCK
288 #define QOS_TX3_CW_MAX_CCK       ( (CW_MIN_CCK + 1) / 2 - 1 )
289
290 #define QOS_TX0_AIFS            (3 - QOS_AIFSN_MIN_VALUE)
291 #define QOS_TX1_AIFS            (7 - QOS_AIFSN_MIN_VALUE)
292 #define QOS_TX2_AIFS            (2 - QOS_AIFSN_MIN_VALUE)
293 #define QOS_TX3_AIFS            (2 - QOS_AIFSN_MIN_VALUE)
294
295 #define QOS_TX0_ACM             0
296 #define QOS_TX1_ACM             0
297 #define QOS_TX2_ACM             0
298 #define QOS_TX3_ACM             0
299
300 #define QOS_TX0_TXOP_LIMIT_CCK          0
301 #define QOS_TX1_TXOP_LIMIT_CCK          0
302 #define QOS_TX2_TXOP_LIMIT_CCK          6016
303 #define QOS_TX3_TXOP_LIMIT_CCK          3264
304
305 #define QOS_TX0_TXOP_LIMIT_OFDM      0
306 #define QOS_TX1_TXOP_LIMIT_OFDM      0
307 #define QOS_TX2_TXOP_LIMIT_OFDM      3008
308 #define QOS_TX3_TXOP_LIMIT_OFDM      1504
309
310 #define DEF_TX0_CW_MIN_OFDM      CW_MIN_OFDM
311 #define DEF_TX1_CW_MIN_OFDM      CW_MIN_OFDM
312 #define DEF_TX2_CW_MIN_OFDM      CW_MIN_OFDM
313 #define DEF_TX3_CW_MIN_OFDM      CW_MIN_OFDM
314
315 #define DEF_TX0_CW_MIN_CCK       CW_MIN_CCK
316 #define DEF_TX1_CW_MIN_CCK       CW_MIN_CCK
317 #define DEF_TX2_CW_MIN_CCK       CW_MIN_CCK
318 #define DEF_TX3_CW_MIN_CCK       CW_MIN_CCK
319
320 #define DEF_TX0_CW_MAX_OFDM      CW_MAX_OFDM
321 #define DEF_TX1_CW_MAX_OFDM      CW_MAX_OFDM
322 #define DEF_TX2_CW_MAX_OFDM      CW_MAX_OFDM
323 #define DEF_TX3_CW_MAX_OFDM      CW_MAX_OFDM
324
325 #define DEF_TX0_CW_MAX_CCK       CW_MAX_CCK
326 #define DEF_TX1_CW_MAX_CCK       CW_MAX_CCK
327 #define DEF_TX2_CW_MAX_CCK       CW_MAX_CCK
328 #define DEF_TX3_CW_MAX_CCK       CW_MAX_CCK
329
330 #define DEF_TX0_AIFS            0
331 #define DEF_TX1_AIFS            0
332 #define DEF_TX2_AIFS            0
333 #define DEF_TX3_AIFS            0
334
335 #define DEF_TX0_ACM             0
336 #define DEF_TX1_ACM             0
337 #define DEF_TX2_ACM             0
338 #define DEF_TX3_ACM             0
339
340 #define DEF_TX0_TXOP_LIMIT_CCK        0
341 #define DEF_TX1_TXOP_LIMIT_CCK        0
342 #define DEF_TX2_TXOP_LIMIT_CCK        0
343 #define DEF_TX3_TXOP_LIMIT_CCK        0
344
345 #define DEF_TX0_TXOP_LIMIT_OFDM       0
346 #define DEF_TX1_TXOP_LIMIT_OFDM       0
347 #define DEF_TX2_TXOP_LIMIT_OFDM       0
348 #define DEF_TX3_TXOP_LIMIT_OFDM       0
349
350 #define QOS_QOS_SETS                  3
351 #define QOS_PARAM_SET_ACTIVE          0
352 #define QOS_PARAM_SET_DEF_CCK         1
353 #define QOS_PARAM_SET_DEF_OFDM        2
354
355 #define CTRL_QOS_NO_ACK               (0x0020)
356
357 #define IPW_TX_QUEUE_1        1
358 #define IPW_TX_QUEUE_2        2
359 #define IPW_TX_QUEUE_3        3
360 #define IPW_TX_QUEUE_4        4
361
362 /* QoS sturctures */
363 struct ipw_qos_info {
364         int qos_enable;
365         struct ieee80211_qos_parameters *def_qos_parm_OFDM;
366         struct ieee80211_qos_parameters *def_qos_parm_CCK;
367         u32 burst_duration_CCK;
368         u32 burst_duration_OFDM;
369         u16 qos_no_ack_mask;
370         int burst_enable;
371 };
372
373 /**************************************************************/
374 /**
375  * Generic queue structure
376  *
377  * Contains common data for Rx and Tx queues
378  */
379 struct clx2_queue {
380         int n_bd;                      /**< number of BDs in this queue */
381         int first_empty;               /**< 1-st empty entry (index) */
382         int last_used;                 /**< last used entry (index) */
383         u32 reg_w;                   /**< 'write' reg (queue head), addr in domain 1 */
384         u32 reg_r;                   /**< 'read' reg (queue tail), addr in domain 1 */
385         dma_addr_t dma_addr;            /**< physical addr for BD's */
386         int low_mark;                  /**< low watermark, resume queue if free space more than this */
387         int high_mark;                 /**< high watermark, stop queue if free space less than this */
388 } __attribute__ ((packed));
389
390 struct machdr32 {
391         u16 frame_ctl;
392         u16 duration;           // watch out for endians!
393         u8 addr1[MACADRR_BYTE_LEN];
394         u8 addr2[MACADRR_BYTE_LEN];
395         u8 addr3[MACADRR_BYTE_LEN];
396         u16 seq_ctrl;           // more endians!
397         u8 addr4[MACADRR_BYTE_LEN];
398         u16 qos_ctrl;
399 } __attribute__ ((packed));
400
401 struct machdr30 {
402         u16 frame_ctl;
403         u16 duration;           // watch out for endians!
404         u8 addr1[MACADRR_BYTE_LEN];
405         u8 addr2[MACADRR_BYTE_LEN];
406         u8 addr3[MACADRR_BYTE_LEN];
407         u16 seq_ctrl;           // more endians!
408         u8 addr4[MACADRR_BYTE_LEN];
409 } __attribute__ ((packed));
410
411 struct machdr26 {
412         u16 frame_ctl;
413         u16 duration;           // watch out for endians!
414         u8 addr1[MACADRR_BYTE_LEN];
415         u8 addr2[MACADRR_BYTE_LEN];
416         u8 addr3[MACADRR_BYTE_LEN];
417         u16 seq_ctrl;           // more endians!
418         u16 qos_ctrl;
419 } __attribute__ ((packed));
420
421 struct machdr24 {
422         u16 frame_ctl;
423         u16 duration;           // watch out for endians!
424         u8 addr1[MACADRR_BYTE_LEN];
425         u8 addr2[MACADRR_BYTE_LEN];
426         u8 addr3[MACADRR_BYTE_LEN];
427         u16 seq_ctrl;           // more endians!
428 } __attribute__ ((packed));
429
430 // TX TFD with 32 byte MAC Header
431 struct tx_tfd_32 {
432         struct machdr32 mchdr;  // 32
433         u32 uivplaceholder[2];  // 8
434 } __attribute__ ((packed));
435
436 // TX TFD with 30 byte MAC Header
437 struct tx_tfd_30 {
438         struct machdr30 mchdr;  // 30
439         u8 reserved[2];         // 2
440         u32 uivplaceholder[2];  // 8
441 } __attribute__ ((packed));
442
443 // tx tfd with 26 byte mac header
444 struct tx_tfd_26 {
445         struct machdr26 mchdr;  // 26
446         u8 reserved1[2];        // 2
447         u32 uivplaceholder[2];  // 8
448         u8 reserved2[4];        // 4
449 } __attribute__ ((packed));
450
451 // tx tfd with 24 byte mac header
452 struct tx_tfd_24 {
453         struct machdr24 mchdr;  // 24
454         u32 uivplaceholder[2];  // 8
455         u8 reserved[8];         // 8
456 } __attribute__ ((packed));
457
458 #define DCT_WEP_KEY_FIELD_LENGTH 16
459
460 struct tfd_command {
461         u8 index;
462         u8 length;
463         u16 reserved;
464         u8 payload[0];
465 } __attribute__ ((packed));
466
467 struct tfd_data {
468         /* Header */
469         u32 work_area_ptr;
470         u8 station_number;      /* 0 for BSS */
471         u8 reserved1;
472         u16 reserved2;
473
474         /* Tx Parameters */
475         u8 cmd_id;
476         u8 seq_num;
477         u16 len;
478         u8 priority;
479         u8 tx_flags;
480         u8 tx_flags_ext;
481         u8 key_index;
482         u8 wepkey[DCT_WEP_KEY_FIELD_LENGTH];
483         u8 rate;
484         u8 antenna;
485         u16 next_packet_duration;
486         u16 next_frag_len;
487         u16 back_off_counter;   //////txop;
488         u8 retrylimit;
489         u16 cwcurrent;
490         u8 reserved3;
491
492         /* 802.11 MAC Header */
493         union {
494                 struct tx_tfd_24 tfd_24;
495                 struct tx_tfd_26 tfd_26;
496                 struct tx_tfd_30 tfd_30;
497                 struct tx_tfd_32 tfd_32;
498         } tfd;
499
500         /* Payload DMA info */
501         u32 num_chunks;
502         u32 chunk_ptr[NUM_TFD_CHUNKS];
503         u16 chunk_len[NUM_TFD_CHUNKS];
504 } __attribute__ ((packed));
505
506 struct txrx_control_flags {
507         u8 message_type;
508         u8 rx_seq_num;
509         u8 control_bits;
510         u8 reserved;
511 } __attribute__ ((packed));
512
513 #define  TFD_SIZE                           128
514 #define  TFD_CMD_IMMEDIATE_PAYLOAD_LENGTH   (TFD_SIZE - sizeof(struct txrx_control_flags))
515
516 struct tfd_frame {
517         struct txrx_control_flags control_flags;
518         union {
519                 struct tfd_data data;
520                 struct tfd_command cmd;
521                 u8 raw[TFD_CMD_IMMEDIATE_PAYLOAD_LENGTH];
522         } u;
523 } __attribute__ ((packed));
524
525 typedef void destructor_func(const void *);
526
527 /**
528  * Tx Queue for DMA. Queue consists of circular buffer of
529  * BD's and required locking structures.
530  */
531 struct clx2_tx_queue {
532         struct clx2_queue q;
533         struct tfd_frame *bd;
534         struct ieee80211_txb **txb;
535 };
536
537 /*
538  * RX related structures and functions
539  */
540 #define RX_FREE_BUFFERS 32
541 #define RX_LOW_WATERMARK 8
542
543 #define SUP_RATE_11A_MAX_NUM_CHANNELS  8
544 #define SUP_RATE_11B_MAX_NUM_CHANNELS  4
545 #define SUP_RATE_11G_MAX_NUM_CHANNELS  12
546
547 // Used for passing to driver number of successes and failures per rate
548 struct rate_histogram {
549         union {
550                 u32 a[SUP_RATE_11A_MAX_NUM_CHANNELS];
551                 u32 b[SUP_RATE_11B_MAX_NUM_CHANNELS];
552                 u32 g[SUP_RATE_11G_MAX_NUM_CHANNELS];
553         } success;
554         union {
555                 u32 a[SUP_RATE_11A_MAX_NUM_CHANNELS];
556                 u32 b[SUP_RATE_11B_MAX_NUM_CHANNELS];
557                 u32 g[SUP_RATE_11G_MAX_NUM_CHANNELS];
558         } failed;
559 } __attribute__ ((packed));
560
561 /* statistics command response */
562 struct ipw_cmd_stats {
563         u8 cmd_id;
564         u8 seq_num;
565         u16 good_sfd;
566         u16 bad_plcp;
567         u16 wrong_bssid;
568         u16 valid_mpdu;
569         u16 bad_mac_header;
570         u16 reserved_frame_types;
571         u16 rx_ina;
572         u16 bad_crc32;
573         u16 invalid_cts;
574         u16 invalid_acks;
575         u16 long_distance_ina_fina;
576         u16 dsp_silence_unreachable;
577         u16 accumulated_rssi;
578         u16 rx_ovfl_frame_tossed;
579         u16 rssi_silence_threshold;
580         u16 rx_ovfl_frame_supplied;
581         u16 last_rx_frame_signal;
582         u16 last_rx_frame_noise;
583         u16 rx_autodetec_no_ofdm;
584         u16 rx_autodetec_no_barker;
585         u16 reserved;
586 } __attribute__ ((packed));
587
588 struct notif_channel_result {
589         u8 channel_num;
590         struct ipw_cmd_stats stats;
591         u8 uReserved;
592 } __attribute__ ((packed));
593
594 #define SCAN_COMPLETED_STATUS_COMPLETE  1
595 #define SCAN_COMPLETED_STATUS_ABORTED   2
596
597 struct notif_scan_complete {
598         u8 scan_type;
599         u8 num_channels;
600         u8 status;
601         u8 reserved;
602 } __attribute__ ((packed));
603
604 struct notif_frag_length {
605         u16 frag_length;
606         u16 reserved;
607 } __attribute__ ((packed));
608
609 struct notif_beacon_state {
610         u32 state;
611         u32 number;
612 } __attribute__ ((packed));
613
614 struct notif_tgi_tx_key {
615         u8 key_state;
616         u8 security_type;
617         u8 station_index;
618         u8 reserved;
619 } __attribute__ ((packed));
620
621 struct notif_link_deterioration {
622         struct ipw_cmd_stats stats;
623         u8 rate;
624         u8 modulation;
625         struct rate_histogram histogram;
626         u8 reserved1;
627         u16 reserved2;
628 } __attribute__ ((packed));
629
630 struct notif_association {
631         u8 state;
632 } __attribute__ ((packed));
633
634 struct notif_authenticate {
635         u8 state;
636         struct machdr24 addr;
637         u16 status;
638 } __attribute__ ((packed));
639
640 struct notif_calibration {
641         u8 data[104];
642 } __attribute__ ((packed));
643
644 struct notif_noise {
645         u32 value;
646 } __attribute__ ((packed));
647
648 struct ipw_rx_notification {
649         u8 reserved[8];
650         u8 subtype;
651         u8 flags;
652         u16 size;
653         union {
654                 struct notif_association assoc;
655                 struct notif_authenticate auth;
656                 struct notif_channel_result channel_result;
657                 struct notif_scan_complete scan_complete;
658                 struct notif_frag_length frag_len;
659                 struct notif_beacon_state beacon_state;
660                 struct notif_tgi_tx_key tgi_tx_key;
661                 struct notif_link_deterioration link_deterioration;
662                 struct notif_calibration calibration;
663                 struct notif_noise noise;
664                 u8 raw[0];
665         } u;
666 } __attribute__ ((packed));
667
668 struct ipw_rx_frame {
669         u32 reserved1;
670         u8 parent_tsf[4];       // fw_use[0] is boolean for OUR_TSF_IS_GREATER
671         u8 received_channel;    // The channel that this frame was received on.
672         // Note that for .11b this does not have to be
673         // the same as the channel that it was sent.
674         // Filled by LMAC
675         u8 frameStatus;
676         u8 rate;
677         u8 rssi;
678         u8 agc;
679         u8 rssi_dbm;
680         u16 signal;
681         u16 noise;
682         u8 antennaAndPhy;
683         u8 control;             // control bit should be on in bg
684         u8 rtscts_rate;         // rate of rts or cts (in rts cts sequence rate
685         // is identical)
686         u8 rtscts_seen;         // 0x1 RTS seen ; 0x2 CTS seen
687         u16 length;
688         u8 data[0];
689 } __attribute__ ((packed));
690
691 struct ipw_rx_header {
692         u8 message_type;
693         u8 rx_seq_num;
694         u8 control_bits;
695         u8 reserved;
696 } __attribute__ ((packed));
697
698 struct ipw_rx_packet {
699         struct ipw_rx_header header;
700         union {
701                 struct ipw_rx_frame frame;
702                 struct ipw_rx_notification notification;
703         } u;
704 } __attribute__ ((packed));
705
706 #define IPW_RX_NOTIFICATION_SIZE sizeof(struct ipw_rx_header) + 12
707 #define IPW_RX_FRAME_SIZE        (unsigned int)(sizeof(struct ipw_rx_header) + \
708                                  sizeof(struct ipw_rx_frame))
709
710 struct ipw_rx_mem_buffer {
711         dma_addr_t dma_addr;
712         struct ipw_rx_buffer *rxb;
713         struct sk_buff *skb;
714         struct list_head list;
715 };                              /* Not transferred over network, so not  __attribute__ ((packed)) */
716
717 struct ipw_rx_queue {
718         struct ipw_rx_mem_buffer pool[RX_QUEUE_SIZE + RX_FREE_BUFFERS];
719         struct ipw_rx_mem_buffer *queue[RX_QUEUE_SIZE];
720         u32 processed;          /* Internal index to last handled Rx packet */
721         u32 read;               /* Shared index to newest available Rx buffer */
722         u32 write;              /* Shared index to oldest written Rx packet */
723         u32 free_count;         /* Number of pre-allocated buffers in rx_free */
724         /* Each of these lists is used as a FIFO for ipw_rx_mem_buffers */
725         struct list_head rx_free;       /* Own an SKBs */
726         struct list_head rx_used;       /* No SKB allocated */
727         spinlock_t lock;
728 };                              /* Not transferred over network, so not  __attribute__ ((packed)) */
729
730 struct alive_command_responce {
731         u8 alive_command;
732         u8 sequence_number;
733         u16 software_revision;
734         u8 device_identifier;
735         u8 reserved1[5];
736         u16 reserved2;
737         u16 reserved3;
738         u16 clock_settle_time;
739         u16 powerup_settle_time;
740         u16 reserved4;
741         u8 time_stamp[5];       /* month, day, year, hours, minutes */
742         u8 ucode_valid;
743 } __attribute__ ((packed));
744
745 #define IPW_MAX_RATES 12
746
747 struct ipw_rates {
748         u8 num_rates;
749         u8 rates[IPW_MAX_RATES];
750 } __attribute__ ((packed));
751
752 struct command_block {
753         unsigned int control;
754         u32 source_addr;
755         u32 dest_addr;
756         unsigned int status;
757 } __attribute__ ((packed));
758
759 #define CB_NUMBER_OF_ELEMENTS_SMALL 64
760 struct fw_image_desc {
761         unsigned long last_cb_index;
762         unsigned long current_cb_index;
763         struct command_block cb_list[CB_NUMBER_OF_ELEMENTS_SMALL];
764         void *v_addr;
765         unsigned long p_addr;
766         unsigned long len;
767 };
768
769 struct ipw_sys_config {
770         u8 bt_coexistence;
771         u8 reserved1;
772         u8 answer_broadcast_ssid_probe;
773         u8 accept_all_data_frames;
774         u8 accept_non_directed_frames;
775         u8 exclude_unicast_unencrypted;
776         u8 disable_unicast_decryption;
777         u8 exclude_multicast_unencrypted;
778         u8 disable_multicast_decryption;
779         u8 antenna_diversity;
780         u8 pass_crc_to_host;
781         u8 dot11g_auto_detection;
782         u8 enable_cts_to_self;
783         u8 enable_multicast_filtering;
784         u8 bt_coexist_collision_thr;
785         u8 reserved2;
786         u8 accept_all_mgmt_bcpr;
787         u8 accept_all_mgtm_frames;
788         u8 pass_noise_stats_to_host;
789         u8 reserved3;
790 } __attribute__ ((packed));
791
792 struct ipw_multicast_addr {
793         u8 num_of_multicast_addresses;
794         u8 reserved[3];
795         u8 mac1[6];
796         u8 mac2[6];
797         u8 mac3[6];
798         u8 mac4[6];
799 } __attribute__ ((packed));
800
801 #define DCW_WEP_KEY_INDEX_MASK          0x03    /* bits [0:1] */
802 #define DCW_WEP_KEY_SEC_TYPE_MASK       0x30    /* bits [4:5] */
803
804 #define DCW_WEP_KEY_SEC_TYPE_WEP        0x00
805 #define DCW_WEP_KEY_SEC_TYPE_CCM        0x20
806 #define DCW_WEP_KEY_SEC_TYPE_TKIP       0x30
807
808 #define DCW_WEP_KEY_INVALID_SIZE        0x00    /* 0 = Invalid key */
809 #define DCW_WEP_KEY64Bit_SIZE           0x05    /* 64-bit encryption */
810 #define DCW_WEP_KEY128Bit_SIZE          0x0D    /* 128-bit encryption */
811 #define DCW_CCM_KEY128Bit_SIZE          0x10    /* 128-bit key */
812 //#define DCW_WEP_KEY128BitIV_SIZE      0x10    /* 128-bit key and 128-bit IV */
813
814 struct ipw_wep_key {
815         u8 cmd_id;
816         u8 seq_num;
817         u8 key_index;
818         u8 key_size;
819         u8 key[16];
820 } __attribute__ ((packed));
821
822 struct ipw_tgi_tx_key {
823         u8 key_id;
824         u8 security_type;
825         u8 station_index;
826         u8 flags;
827         u8 key[16];
828         u32 tx_counter[2];
829 } __attribute__ ((packed));
830
831 #define IPW_SCAN_CHANNELS 54
832
833 struct ipw_scan_request {
834         u8 scan_type;
835         u16 dwell_time;
836         u8 channels_list[IPW_SCAN_CHANNELS];
837         u8 channels_reserved[3];
838 } __attribute__ ((packed));
839
840 enum {
841         IPW_SCAN_PASSIVE_TILL_FIRST_BEACON_SCAN = 0,
842         IPW_SCAN_PASSIVE_FULL_DWELL_SCAN,
843         IPW_SCAN_ACTIVE_DIRECT_SCAN,
844         IPW_SCAN_ACTIVE_BROADCAST_SCAN,
845         IPW_SCAN_ACTIVE_BROADCAST_AND_DIRECT_SCAN,
846         IPW_SCAN_TYPES
847 };
848
849 struct ipw_scan_request_ext {
850         u32 full_scan_index;
851         u8 channels_list[IPW_SCAN_CHANNELS];
852         u8 scan_type[IPW_SCAN_CHANNELS / 2];
853         u8 reserved;
854         u16 dwell_time[IPW_SCAN_TYPES];
855 } __attribute__ ((packed));
856
857 static inline u8 ipw_get_scan_type(struct ipw_scan_request_ext *scan, u8 index)
858 {
859         if (index % 2)
860                 return scan->scan_type[index / 2] & 0x0F;
861         else
862                 return (scan->scan_type[index / 2] & 0xF0) >> 4;
863 }
864
865 static inline void ipw_set_scan_type(struct ipw_scan_request_ext *scan,
866                                      u8 index, u8 scan_type)
867 {
868         if (index % 2)
869                 scan->scan_type[index / 2] =
870                     (scan->scan_type[index / 2] & 0xF0) | (scan_type & 0x0F);
871         else
872                 scan->scan_type[index / 2] =
873                     (scan->scan_type[index / 2] & 0x0F) |
874                     ((scan_type & 0x0F) << 4);
875 }
876
877 struct ipw_associate {
878         u8 channel;
879         u8 auth_type:4, auth_key:4;
880         u8 assoc_type;
881         u8 reserved;
882         u16 policy_support;
883         u8 preamble_length;
884         u8 ieee_mode;
885         u8 bssid[ETH_ALEN];
886         u32 assoc_tsf_msw;
887         u32 assoc_tsf_lsw;
888         u16 capability;
889         u16 listen_interval;
890         u16 beacon_interval;
891         u8 dest[ETH_ALEN];
892         u16 atim_window;
893         u8 smr;
894         u8 reserved1;
895         u16 reserved2;
896 } __attribute__ ((packed));
897
898 struct ipw_supported_rates {
899         u8 ieee_mode;
900         u8 num_rates;
901         u8 purpose;
902         u8 reserved;
903         u8 supported_rates[IPW_MAX_RATES];
904 } __attribute__ ((packed));
905
906 struct ipw_rts_threshold {
907         u16 rts_threshold;
908         u16 reserved;
909 } __attribute__ ((packed));
910
911 struct ipw_frag_threshold {
912         u16 frag_threshold;
913         u16 reserved;
914 } __attribute__ ((packed));
915
916 struct ipw_retry_limit {
917         u8 short_retry_limit;
918         u8 long_retry_limit;
919         u16 reserved;
920 } __attribute__ ((packed));
921
922 struct ipw_dino_config {
923         u32 dino_config_addr;
924         u16 dino_config_size;
925         u8 dino_response;
926         u8 reserved;
927 } __attribute__ ((packed));
928
929 struct ipw_aironet_info {
930         u8 id;
931         u8 length;
932         u16 reserved;
933 } __attribute__ ((packed));
934
935 struct ipw_rx_key {
936         u8 station_index;
937         u8 key_type;
938         u8 key_id;
939         u8 key_flag;
940         u8 key[16];
941         u8 station_address[6];
942         u8 key_index;
943         u8 reserved;
944 } __attribute__ ((packed));
945
946 struct ipw_country_channel_info {
947         u8 first_channel;
948         u8 no_channels;
949         s8 max_tx_power;
950 } __attribute__ ((packed));
951
952 struct ipw_country_info {
953         u8 id;
954         u8 length;
955         u8 country_str[3];
956         struct ipw_country_channel_info groups[7];
957 } __attribute__ ((packed));
958
959 struct ipw_channel_tx_power {
960         u8 channel_number;
961         s8 tx_power;
962 } __attribute__ ((packed));
963
964 #define SCAN_ASSOCIATED_INTERVAL (HZ)
965 #define SCAN_INTERVAL (HZ / 10)
966 #define MAX_A_CHANNELS  37
967 #define MAX_B_CHANNELS  14
968
969 struct ipw_tx_power {
970         u8 num_channels;
971         u8 ieee_mode;
972         struct ipw_channel_tx_power channels_tx_power[MAX_A_CHANNELS];
973 } __attribute__ ((packed));
974
975 struct ipw_rsn_capabilities {
976         u8 id;
977         u8 length;
978         u16 version;
979 } __attribute__ ((packed));
980
981 struct ipw_sensitivity_calib {
982         u16 beacon_rssi_raw;
983         u16 reserved;
984 } __attribute__ ((packed));
985
986 /**
987  * Host command structure.
988  *
989  * On input, the following fields should be filled:
990  * - cmd
991  * - len
992  * - status_len
993  * - param (if needed)
994  *
995  * On output,
996  * - \a status contains status;
997  * - \a param filled with status parameters.
998  */
999 struct ipw_cmd {
1000         u32 cmd;   /**< Host command */
1001         u32 status;/**< Status */
1002         u32 status_len;
1003                    /**< How many 32 bit parameters in the status */
1004         u32 len;   /**< incoming parameters length, bytes */
1005   /**
1006    * command parameters.
1007    * There should be enough space for incoming and
1008    * outcoming parameters.
1009    * Incoming parameters listed 1-st, followed by outcoming params.
1010    * nParams=(len+3)/4+status_len
1011    */
1012         u32 param[0];
1013 } __attribute__ ((packed));
1014
1015 #define STATUS_HCMD_ACTIVE      (1<<0)  /**< host command in progress */
1016
1017 #define STATUS_INT_ENABLED      (1<<1)
1018 #define STATUS_RF_KILL_HW       (1<<2)
1019 #define STATUS_RF_KILL_SW       (1<<3)
1020 #define STATUS_RF_KILL_MASK     (STATUS_RF_KILL_HW | STATUS_RF_KILL_SW)
1021
1022 #define STATUS_INIT             (1<<5)
1023 #define STATUS_AUTH             (1<<6)
1024 #define STATUS_ASSOCIATED       (1<<7)
1025 #define STATUS_STATE_MASK       (STATUS_INIT | STATUS_AUTH | STATUS_ASSOCIATED)
1026
1027 #define STATUS_ASSOCIATING      (1<<8)
1028 #define STATUS_DISASSOCIATING   (1<<9)
1029 #define STATUS_ROAMING          (1<<10)
1030 #define STATUS_EXIT_PENDING     (1<<11)
1031 #define STATUS_DISASSOC_PENDING (1<<12)
1032 #define STATUS_STATE_PENDING    (1<<13)
1033
1034 #define STATUS_SCAN_PENDING     (1<<20)
1035 #define STATUS_SCANNING         (1<<21)
1036 #define STATUS_SCAN_ABORTING    (1<<22)
1037 #define STATUS_SCAN_FORCED      (1<<23)
1038
1039 #define STATUS_LED_LINK_ON      (1<<24)
1040 #define STATUS_LED_ACT_ON       (1<<25)
1041
1042 #define STATUS_INDIRECT_BYTE    (1<<28) /* sysfs entry configured for access */
1043 #define STATUS_INDIRECT_DWORD   (1<<29) /* sysfs entry configured for access */
1044 #define STATUS_DIRECT_DWORD     (1<<30) /* sysfs entry configured for access */
1045
1046 #define STATUS_SECURITY_UPDATED (1<<31) /* Security sync needed */
1047
1048 #define CFG_STATIC_CHANNEL      (1<<0)  /* Restrict assoc. to single channel */
1049 #define CFG_STATIC_ESSID        (1<<1)  /* Restrict assoc. to single SSID */
1050 #define CFG_STATIC_BSSID        (1<<2)  /* Restrict assoc. to single BSSID */
1051 #define CFG_CUSTOM_MAC          (1<<3)
1052 #define CFG_PREAMBLE_LONG       (1<<4)
1053 #define CFG_ADHOC_PERSIST       (1<<5)
1054 #define CFG_ASSOCIATE           (1<<6)
1055 #define CFG_FIXED_RATE          (1<<7)
1056 #define CFG_ADHOC_CREATE        (1<<8)
1057 #define CFG_NO_LED              (1<<9)
1058 #define CFG_BACKGROUND_SCAN     (1<<10)
1059 #define CFG_SPEED_SCAN          (1<<11)
1060 #define CFG_NET_STATS           (1<<12)
1061
1062 #define CAP_SHARED_KEY          (1<<0)  /* Off = OPEN */
1063 #define CAP_PRIVACY_ON          (1<<1)  /* Off = No privacy */
1064
1065 #define MAX_STATIONS            32
1066 #define IPW_INVALID_STATION     (0xff)
1067
1068 struct ipw_station_entry {
1069         u8 mac_addr[ETH_ALEN];
1070         u8 reserved;
1071         u8 support_mode;
1072 };
1073
1074 #define AVG_ENTRIES 8
1075 struct average {
1076         s16 entries[AVG_ENTRIES];
1077         u8 pos;
1078         u8 init;
1079         s32 sum;
1080 };
1081
1082 #define MAX_SPEED_SCAN 100
1083 #define IPW_IBSS_MAC_HASH_SIZE 31
1084
1085 struct ipw_ibss_seq {
1086         u8 mac[ETH_ALEN];
1087         u16 seq_num;
1088         u16 frag_num;
1089         unsigned long packet_time;
1090         struct list_head list;
1091 };
1092
1093 struct ipw_error_elem {
1094         u32 desc;
1095         u32 time;
1096         u32 blink1;
1097         u32 blink2;
1098         u32 link1;
1099         u32 link2;
1100         u32 data;
1101 };
1102
1103 struct ipw_event {
1104         u32 event;
1105         u32 time;
1106         u32 data;
1107 } __attribute__ ((packed));
1108
1109 struct ipw_fw_error {
1110         unsigned long jiffies;
1111         u32 status;
1112         u32 config;
1113         u32 elem_len;
1114         u32 log_len;
1115         struct ipw_error_elem *elem;
1116         struct ipw_event *log;
1117         u8 payload[0];
1118 } __attribute__ ((packed));
1119
1120 struct ipw_priv {
1121         /* ieee device used by generic ieee processing code */
1122         struct ieee80211_device *ieee;
1123
1124         spinlock_t lock;
1125         struct mutex mutex;
1126
1127         /* basic pci-network driver stuff */
1128         struct pci_dev *pci_dev;
1129         struct net_device *net_dev;
1130
1131         /* pci hardware address support */
1132         void __iomem *hw_base;
1133         unsigned long hw_len;
1134
1135         struct fw_image_desc sram_desc;
1136
1137         /* result of ucode download */
1138         struct alive_command_responce dino_alive;
1139
1140         wait_queue_head_t wait_command_queue;
1141         wait_queue_head_t wait_state;
1142
1143         /* Rx and Tx DMA processing queues */
1144         struct ipw_rx_queue *rxq;
1145         struct clx2_tx_queue txq_cmd;
1146         struct clx2_tx_queue txq[4];
1147         u32 status;
1148         u32 config;
1149         u32 capability;
1150
1151         u8 last_rx_rssi;
1152         u8 last_noise;
1153         struct average average_missed_beacons;
1154         struct average average_rssi;
1155         struct average average_noise;
1156         u32 port_type;
1157         int rx_bufs_min;          /**< minimum number of bufs in Rx queue */
1158         int rx_pend_max;          /**< maximum pending buffers for one IRQ */
1159         u32 hcmd_seq;             /**< sequence number for hcmd */
1160         u32 disassociate_threshold;
1161         u32 roaming_threshold;
1162
1163         struct ipw_associate assoc_request;
1164         struct ieee80211_network *assoc_network;
1165
1166         unsigned long ts_scan_abort;
1167         struct ipw_supported_rates rates;
1168         struct ipw_rates phy[3];           /**< PHY restrictions, per band */
1169         struct ipw_rates supp;             /**< software defined */
1170         struct ipw_rates extended;         /**< use for corresp. IE, AP only */
1171
1172         struct notif_link_deterioration last_link_deterioration; /** for statistics */
1173         struct ipw_cmd *hcmd; /**< host command currently executed */
1174
1175         wait_queue_head_t hcmd_wq;     /**< host command waits for execution */
1176         u32 tsf_bcn[2];              /**< TSF from latest beacon */
1177
1178         struct notif_calibration calib; /**< last calibration */
1179
1180         /* ordinal interface with firmware */
1181         u32 table0_addr;
1182         u32 table0_len;
1183         u32 table1_addr;
1184         u32 table1_len;
1185         u32 table2_addr;
1186         u32 table2_len;
1187
1188         /* context information */
1189         u8 essid[IW_ESSID_MAX_SIZE];
1190         u8 essid_len;
1191         u8 nick[IW_ESSID_MAX_SIZE];
1192         u16 rates_mask;
1193         u8 channel;
1194         struct ipw_sys_config sys_config;
1195         u32 power_mode;
1196         u8 bssid[ETH_ALEN];
1197         u16 rts_threshold;
1198         u8 mac_addr[ETH_ALEN];
1199         u8 num_stations;
1200         u8 stations[MAX_STATIONS][ETH_ALEN];
1201         u8 short_retry_limit;
1202         u8 long_retry_limit;
1203
1204         u32 notif_missed_beacons;
1205
1206         /* Statistics and counters normalized with each association */
1207         u32 last_missed_beacons;
1208         u32 last_tx_packets;
1209         u32 last_rx_packets;
1210         u32 last_tx_failures;
1211         u32 last_rx_err;
1212         u32 last_rate;
1213
1214         u32 missed_adhoc_beacons;
1215         u32 missed_beacons;
1216         u32 rx_packets;
1217         u32 tx_packets;
1218         u32 quality;
1219
1220         u8 speed_scan[MAX_SPEED_SCAN];
1221         u8 speed_scan_pos;
1222
1223         u16 last_seq_num;
1224         u16 last_frag_num;
1225         unsigned long last_packet_time;
1226         struct list_head ibss_mac_hash[IPW_IBSS_MAC_HASH_SIZE];
1227
1228         /* eeprom */
1229         u8 eeprom[0x100];       /* 256 bytes of eeprom */
1230         u8 country[4];
1231         int eeprom_delay;
1232
1233         struct iw_statistics wstats;
1234
1235         struct iw_public_data wireless_data;
1236
1237         struct workqueue_struct *workqueue;
1238
1239         struct work_struct adhoc_check;
1240         struct work_struct associate;
1241         struct work_struct disassociate;
1242         struct work_struct system_config;
1243         struct work_struct rx_replenish;
1244         struct work_struct request_scan;
1245         struct work_struct adapter_restart;
1246         struct work_struct rf_kill;
1247         struct work_struct up;
1248         struct work_struct down;
1249         struct work_struct gather_stats;
1250         struct work_struct abort_scan;
1251         struct work_struct roam;
1252         struct work_struct scan_check;
1253         struct work_struct link_up;
1254         struct work_struct link_down;
1255
1256         struct tasklet_struct irq_tasklet;
1257
1258         /* LED related variables and work_struct */
1259         u8 nic_type;
1260         u32 led_activity_on;
1261         u32 led_activity_off;
1262         u32 led_association_on;
1263         u32 led_association_off;
1264         u32 led_ofdm_on;
1265         u32 led_ofdm_off;
1266
1267         struct work_struct led_link_on;
1268         struct work_struct led_link_off;
1269         struct work_struct led_act_off;
1270         struct work_struct merge_networks;
1271
1272         struct ipw_cmd_log *cmdlog;
1273         int cmdlog_len;
1274         int cmdlog_pos;
1275
1276 #define IPW_2200BG  1
1277 #define IPW_2915ABG 2
1278         u8 adapter;
1279
1280         s8 tx_power;
1281
1282 #ifdef CONFIG_PM
1283         u32 pm_state[16];
1284 #endif
1285
1286         struct ipw_fw_error *error;
1287
1288         /* network state */
1289
1290         /* Used to pass the current INTA value from ISR to Tasklet */
1291         u32 isr_inta;
1292
1293         /* QoS */
1294         struct ipw_qos_info qos_data;
1295         struct work_struct qos_activate;
1296         /*********************************/
1297
1298         /* debugging info */
1299         u32 indirect_dword;
1300         u32 direct_dword;
1301         u32 indirect_byte;
1302 };                              /*ipw_priv */
1303
1304 /* debug macros */
1305
1306 #ifdef CONFIG_IPW2200_DEBUG
1307 #define IPW_DEBUG(level, fmt, args...) \
1308 do { if (ipw_debug_level & (level)) \
1309   printk(KERN_DEBUG DRV_NAME": %c %s " fmt, \
1310          in_interrupt() ? 'I' : 'U', __FUNCTION__ , ## args); } while (0)
1311 #else
1312 #define IPW_DEBUG(level, fmt, args...) do {} while (0)
1313 #endif                          /* CONFIG_IPW2200_DEBUG */
1314
1315 /*
1316  * To use the debug system;
1317  *
1318  * If you are defining a new debug classification, simply add it to the #define
1319  * list here in the form of:
1320  *
1321  * #define IPW_DL_xxxx VALUE
1322  *
1323  * shifting value to the left one bit from the previous entry.  xxxx should be
1324  * the name of the classification (for example, WEP)
1325  *
1326  * You then need to either add a IPW_xxxx_DEBUG() macro definition for your
1327  * classification, or use IPW_DEBUG(IPW_DL_xxxx, ...) whenever you want
1328  * to send output to that classification.
1329  *
1330  * To add your debug level to the list of levels seen when you perform
1331  *
1332  * % cat /proc/net/ipw/debug_level
1333  *
1334  * you simply need to add your entry to the ipw_debug_levels array.
1335  *
1336  * If you do not see debug_level in /proc/net/ipw then you do not have
1337  * CONFIG_IPW2200_DEBUG defined in your kernel configuration
1338  *
1339  */
1340
1341 #define IPW_DL_ERROR         (1<<0)
1342 #define IPW_DL_WARNING       (1<<1)
1343 #define IPW_DL_INFO          (1<<2)
1344 #define IPW_DL_WX            (1<<3)
1345 #define IPW_DL_HOST_COMMAND  (1<<5)
1346 #define IPW_DL_STATE         (1<<6)
1347
1348 #define IPW_DL_NOTIF         (1<<10)
1349 #define IPW_DL_SCAN          (1<<11)
1350 #define IPW_DL_ASSOC         (1<<12)
1351 #define IPW_DL_DROP          (1<<13)
1352 #define IPW_DL_IOCTL         (1<<14)
1353
1354 #define IPW_DL_MANAGE        (1<<15)
1355 #define IPW_DL_FW            (1<<16)
1356 #define IPW_DL_RF_KILL       (1<<17)
1357 #define IPW_DL_FW_ERRORS     (1<<18)
1358
1359 #define IPW_DL_LED           (1<<19)
1360
1361 #define IPW_DL_ORD           (1<<20)
1362
1363 #define IPW_DL_FRAG          (1<<21)
1364 #define IPW_DL_WEP           (1<<22)
1365 #define IPW_DL_TX            (1<<23)
1366 #define IPW_DL_RX            (1<<24)
1367 #define IPW_DL_ISR           (1<<25)
1368 #define IPW_DL_FW_INFO       (1<<26)
1369 #define IPW_DL_IO            (1<<27)
1370 #define IPW_DL_TRACE         (1<<28)
1371
1372 #define IPW_DL_STATS         (1<<29)
1373 #define IPW_DL_MERGE         (1<<30)
1374 #define IPW_DL_QOS           (1<<31)
1375
1376 #define IPW_ERROR(f, a...) printk(KERN_ERR DRV_NAME ": " f, ## a)
1377 #define IPW_WARNING(f, a...) printk(KERN_WARNING DRV_NAME ": " f, ## a)
1378 #define IPW_DEBUG_INFO(f, a...)    IPW_DEBUG(IPW_DL_INFO, f, ## a)
1379
1380 #define IPW_DEBUG_WX(f, a...)     IPW_DEBUG(IPW_DL_WX, f, ## a)
1381 #define IPW_DEBUG_SCAN(f, a...)   IPW_DEBUG(IPW_DL_SCAN, f, ## a)
1382 #define IPW_DEBUG_STATUS(f, a...) IPW_DEBUG(IPW_DL_STATUS, f, ## a)
1383 #define IPW_DEBUG_TRACE(f, a...)  IPW_DEBUG(IPW_DL_TRACE, f, ## a)
1384 #define IPW_DEBUG_RX(f, a...)     IPW_DEBUG(IPW_DL_RX, f, ## a)
1385 #define IPW_DEBUG_TX(f, a...)     IPW_DEBUG(IPW_DL_TX, f, ## a)
1386 #define IPW_DEBUG_ISR(f, a...)    IPW_DEBUG(IPW_DL_ISR, f, ## a)
1387 #define IPW_DEBUG_MANAGEMENT(f, a...) IPW_DEBUG(IPW_DL_MANAGE, f, ## a)
1388 #define IPW_DEBUG_LED(f, a...) IPW_DEBUG(IPW_DL_LED, f, ## a)
1389 #define IPW_DEBUG_WEP(f, a...)    IPW_DEBUG(IPW_DL_WEP, f, ## a)
1390 #define IPW_DEBUG_HC(f, a...) IPW_DEBUG(IPW_DL_HOST_COMMAND, f, ## a)
1391 #define IPW_DEBUG_FRAG(f, a...) IPW_DEBUG(IPW_DL_FRAG, f, ## a)
1392 #define IPW_DEBUG_FW(f, a...) IPW_DEBUG(IPW_DL_FW, f, ## a)
1393 #define IPW_DEBUG_RF_KILL(f, a...) IPW_DEBUG(IPW_DL_RF_KILL, f, ## a)
1394 #define IPW_DEBUG_DROP(f, a...) IPW_DEBUG(IPW_DL_DROP, f, ## a)
1395 #define IPW_DEBUG_IO(f, a...) IPW_DEBUG(IPW_DL_IO, f, ## a)
1396 #define IPW_DEBUG_ORD(f, a...) IPW_DEBUG(IPW_DL_ORD, f, ## a)
1397 #define IPW_DEBUG_FW_INFO(f, a...) IPW_DEBUG(IPW_DL_FW_INFO, f, ## a)
1398 #define IPW_DEBUG_NOTIF(f, a...) IPW_DEBUG(IPW_DL_NOTIF, f, ## a)
1399 #define IPW_DEBUG_STATE(f, a...) IPW_DEBUG(IPW_DL_STATE | IPW_DL_ASSOC | IPW_DL_INFO, f, ## a)
1400 #define IPW_DEBUG_ASSOC(f, a...) IPW_DEBUG(IPW_DL_ASSOC | IPW_DL_INFO, f, ## a)
1401 #define IPW_DEBUG_STATS(f, a...) IPW_DEBUG(IPW_DL_STATS, f, ## a)
1402 #define IPW_DEBUG_MERGE(f, a...) IPW_DEBUG(IPW_DL_MERGE, f, ## a)
1403 #define IPW_DEBUG_QOS(f, a...)   IPW_DEBUG(IPW_DL_QOS, f, ## a)
1404
1405 #include <linux/ctype.h>
1406
1407 /*
1408 * Register bit definitions
1409 */
1410
1411 #define IPW_INTA_RW       0x00000008
1412 #define IPW_INTA_MASK_R   0x0000000C
1413 #define IPW_INDIRECT_ADDR 0x00000010
1414 #define IPW_INDIRECT_DATA 0x00000014
1415 #define IPW_AUTOINC_ADDR  0x00000018
1416 #define IPW_AUTOINC_DATA  0x0000001C
1417 #define IPW_RESET_REG     0x00000020
1418 #define IPW_GP_CNTRL_RW   0x00000024
1419
1420 #define IPW_READ_INT_REGISTER 0xFF4
1421
1422 #define IPW_GP_CNTRL_BIT_INIT_DONE      0x00000004
1423
1424 #define IPW_REGISTER_DOMAIN1_END        0x00001000
1425 #define IPW_SRAM_READ_INT_REGISTER      0x00000ff4
1426
1427 #define IPW_SHARED_LOWER_BOUND          0x00000200
1428 #define IPW_INTERRUPT_AREA_LOWER_BOUND  0x00000f80
1429
1430 #define IPW_NIC_SRAM_LOWER_BOUND        0x00000000
1431 #define IPW_NIC_SRAM_UPPER_BOUND        0x00030000
1432
1433 #define IPW_BIT_INT_HOST_SRAM_READ_INT_REGISTER (1 << 29)
1434 #define IPW_GP_CNTRL_BIT_CLOCK_READY    0x00000001
1435 #define IPW_GP_CNTRL_BIT_HOST_ALLOWS_STANDBY 0x00000002
1436
1437 /*
1438  * RESET Register Bit Indexes
1439  */
1440 #define CBD_RESET_REG_PRINCETON_RESET (1<<0)
1441 #define IPW_START_STANDBY             (1<<2)
1442 #define IPW_ACTIVITY_LED              (1<<4)
1443 #define IPW_ASSOCIATED_LED            (1<<5)
1444 #define IPW_OFDM_LED                  (1<<6)
1445 #define IPW_RESET_REG_SW_RESET        (1<<7)
1446 #define IPW_RESET_REG_MASTER_DISABLED (1<<8)
1447 #define IPW_RESET_REG_STOP_MASTER     (1<<9)
1448 #define IPW_GATE_ODMA                 (1<<25)
1449 #define IPW_GATE_IDMA                 (1<<26)
1450 #define IPW_ARC_KESHET_CONFIG         (1<<27)
1451 #define IPW_GATE_ADMA                 (1<<29)
1452
1453 #define IPW_CSR_CIS_UPPER_BOUND 0x00000200
1454 #define IPW_DOMAIN_0_END 0x1000
1455 #define CLX_MEM_BAR_SIZE 0x1000
1456
1457 /* Dino/baseband control registers bits */
1458
1459 #define DINO_ENABLE_SYSTEM 0x80 /* 1 = baseband processor on, 0 = reset */
1460 #define DINO_ENABLE_CS     0x40 /* 1 = enable ucode load */
1461 #define DINO_RXFIFO_DATA   0x01 /* 1 = data available */
1462 #define IPW_BASEBAND_CONTROL_STATUS     0X00200000
1463 #define IPW_BASEBAND_TX_FIFO_WRITE      0X00200004
1464 #define IPW_BASEBAND_RX_FIFO_READ       0X00200004
1465 #define IPW_BASEBAND_CONTROL_STORE      0X00200010
1466
1467 #define IPW_INTERNAL_CMD_EVENT  0X00300004
1468 #define IPW_BASEBAND_POWER_DOWN 0x00000001
1469
1470 #define IPW_MEM_HALT_AND_RESET  0x003000e0
1471
1472 /* defgroup bits_halt_reset MEM_HALT_AND_RESET register bits */
1473 #define IPW_BIT_HALT_RESET_ON   0x80000000
1474 #define IPW_BIT_HALT_RESET_OFF  0x00000000
1475
1476 #define CB_LAST_VALID     0x20000000
1477 #define CB_INT_ENABLED    0x40000000
1478 #define CB_VALID          0x80000000
1479 #define CB_SRC_LE         0x08000000
1480 #define CB_DEST_LE        0x04000000
1481 #define CB_SRC_AUTOINC    0x00800000
1482 #define CB_SRC_IO_GATED   0x00400000
1483 #define CB_DEST_AUTOINC   0x00080000
1484 #define CB_SRC_SIZE_LONG  0x00200000
1485 #define CB_DEST_SIZE_LONG 0x00020000
1486
1487 /* DMA DEFINES */
1488
1489 #define DMA_CONTROL_SMALL_CB_CONST_VALUE 0x00540000
1490 #define DMA_CB_STOP_AND_ABORT            0x00000C00
1491 #define DMA_CB_START                     0x00000100
1492
1493 #define IPW_SHARED_SRAM_SIZE               0x00030000
1494 #define IPW_SHARED_SRAM_DMA_CONTROL        0x00027000
1495 #define CB_MAX_LENGTH                      0x1FFF
1496
1497 #define IPW_HOST_EEPROM_DATA_SRAM_SIZE 0xA18
1498 #define IPW_EEPROM_IMAGE_SIZE          0x100
1499
1500 /* DMA defs */
1501 #define IPW_DMA_I_CURRENT_CB  0x003000D0
1502 #define IPW_DMA_O_CURRENT_CB  0x003000D4
1503 #define IPW_DMA_I_DMA_CONTROL 0x003000A4
1504 #define IPW_DMA_I_CB_BASE     0x003000A0
1505
1506 #define IPW_TX_CMD_QUEUE_BD_BASE        0x00000200
1507 #define IPW_TX_CMD_QUEUE_BD_SIZE        0x00000204
1508 #define IPW_TX_QUEUE_0_BD_BASE          0x00000208
1509 #define IPW_TX_QUEUE_0_BD_SIZE          (0x0000020C)
1510 #define IPW_TX_QUEUE_1_BD_BASE          0x00000210
1511 #define IPW_TX_QUEUE_1_BD_SIZE          0x00000214
1512 #define IPW_TX_QUEUE_2_BD_BASE          0x00000218
1513 #define IPW_TX_QUEUE_2_BD_SIZE          (0x0000021C)
1514 #define IPW_TX_QUEUE_3_BD_BASE          0x00000220
1515 #define IPW_TX_QUEUE_3_BD_SIZE          0x00000224
1516 #define IPW_RX_BD_BASE                  0x00000240
1517 #define IPW_RX_BD_SIZE                  0x00000244
1518 #define IPW_RFDS_TABLE_LOWER            0x00000500
1519
1520 #define IPW_TX_CMD_QUEUE_READ_INDEX     0x00000280
1521 #define IPW_TX_QUEUE_0_READ_INDEX       0x00000284
1522 #define IPW_TX_QUEUE_1_READ_INDEX       0x00000288
1523 #define IPW_TX_QUEUE_2_READ_INDEX       (0x0000028C)
1524 #define IPW_TX_QUEUE_3_READ_INDEX       0x00000290
1525 #define IPW_RX_READ_INDEX               (0x000002A0)
1526
1527 #define IPW_TX_CMD_QUEUE_WRITE_INDEX    (0x00000F80)
1528 #define IPW_TX_QUEUE_0_WRITE_INDEX      (0x00000F84)
1529 #define IPW_TX_QUEUE_1_WRITE_INDEX      (0x00000F88)
1530 #define IPW_TX_QUEUE_2_WRITE_INDEX      (0x00000F8C)
1531 #define IPW_TX_QUEUE_3_WRITE_INDEX      (0x00000F90)
1532 #define IPW_RX_WRITE_INDEX              (0x00000FA0)
1533
1534 /*
1535  * EEPROM Related Definitions
1536  */
1537
1538 #define IPW_EEPROM_DATA_SRAM_ADDRESS (IPW_SHARED_LOWER_BOUND + 0x814)
1539 #define IPW_EEPROM_DATA_SRAM_SIZE    (IPW_SHARED_LOWER_BOUND + 0x818)
1540 #define IPW_EEPROM_LOAD_DISABLE      (IPW_SHARED_LOWER_BOUND + 0x81C)
1541 #define IPW_EEPROM_DATA              (IPW_SHARED_LOWER_BOUND + 0x820)
1542 #define IPW_EEPROM_UPPER_ADDRESS     (IPW_SHARED_LOWER_BOUND + 0x9E0)
1543
1544 #define IPW_STATION_TABLE_LOWER      (IPW_SHARED_LOWER_BOUND + 0xA0C)
1545 #define IPW_STATION_TABLE_UPPER      (IPW_SHARED_LOWER_BOUND + 0xB0C)
1546 #define IPW_REQUEST_ATIM             (IPW_SHARED_LOWER_BOUND + 0xB0C)
1547 #define IPW_ATIM_SENT                (IPW_SHARED_LOWER_BOUND + 0xB10)
1548 #define IPW_WHO_IS_AWAKE             (IPW_SHARED_LOWER_BOUND + 0xB14)
1549 #define IPW_DURING_ATIM_WINDOW       (IPW_SHARED_LOWER_BOUND + 0xB18)
1550
1551 #define MSB                             1
1552 #define LSB                             0
1553 #define WORD_TO_BYTE(_word)             ((_word) * sizeof(u16))
1554
1555 #define GET_EEPROM_ADDR(_wordoffset,_byteoffset) \
1556     ( WORD_TO_BYTE(_wordoffset) + (_byteoffset) )
1557
1558 /* EEPROM access by BYTE */
1559 #define EEPROM_PME_CAPABILITY   (GET_EEPROM_ADDR(0x09,MSB))     /* 1 byte   */
1560 #define EEPROM_MAC_ADDRESS      (GET_EEPROM_ADDR(0x21,LSB))     /* 6 byte   */
1561 #define EEPROM_VERSION          (GET_EEPROM_ADDR(0x24,MSB))     /* 1 byte   */
1562 #define EEPROM_NIC_TYPE         (GET_EEPROM_ADDR(0x25,LSB))     /* 1 byte   */
1563 #define EEPROM_SKU_CAPABILITY   (GET_EEPROM_ADDR(0x25,MSB))     /* 1 byte   */
1564 #define EEPROM_COUNTRY_CODE     (GET_EEPROM_ADDR(0x26,LSB))     /* 3 bytes  */
1565 #define EEPROM_IBSS_CHANNELS_BG (GET_EEPROM_ADDR(0x28,LSB))     /* 2 bytes  */
1566 #define EEPROM_IBSS_CHANNELS_A  (GET_EEPROM_ADDR(0x29,MSB))     /* 5 bytes  */
1567 #define EEPROM_BSS_CHANNELS_BG  (GET_EEPROM_ADDR(0x2c,LSB))     /* 2 bytes  */
1568 #define EEPROM_HW_VERSION       (GET_EEPROM_ADDR(0x72,LSB))     /* 2 bytes  */
1569
1570 /* NIC type as found in the one byte EEPROM_NIC_TYPE offset */
1571 #define EEPROM_NIC_TYPE_0 0
1572 #define EEPROM_NIC_TYPE_1 1
1573 #define EEPROM_NIC_TYPE_2 2
1574 #define EEPROM_NIC_TYPE_3 3
1575 #define EEPROM_NIC_TYPE_4 4
1576
1577 /* Bluetooth Coexistence capabilities as found in EEPROM_SKU_CAPABILITY */
1578 #define EEPROM_SKU_CAP_BT_CHANNEL_SIG  0x01     /* we can tell BT our channel # */
1579 #define EEPROM_SKU_CAP_BT_PRIORITY     0x02     /* BT can take priority over us */
1580 #define EEPROM_SKU_CAP_BT_OOB          0x04     /* we can signal BT out-of-band */
1581
1582 #define FW_MEM_REG_LOWER_BOUND          0x00300000
1583 #define FW_MEM_REG_EEPROM_ACCESS        (FW_MEM_REG_LOWER_BOUND + 0x40)
1584 #define IPW_EVENT_REG                   (FW_MEM_REG_LOWER_BOUND + 0x04)
1585 #define EEPROM_BIT_SK                   (1<<0)
1586 #define EEPROM_BIT_CS                   (1<<1)
1587 #define EEPROM_BIT_DI                   (1<<2)
1588 #define EEPROM_BIT_DO                   (1<<4)
1589
1590 #define EEPROM_CMD_READ                 0x2
1591
1592 /* Interrupts masks */
1593 #define IPW_INTA_NONE   0x00000000
1594
1595 #define IPW_INTA_BIT_RX_TRANSFER                   0x00000002
1596 #define IPW_INTA_BIT_STATUS_CHANGE                 0x00000010
1597 #define IPW_INTA_BIT_BEACON_PERIOD_EXPIRED         0x00000020
1598
1599 //Inta Bits for CF
1600 #define IPW_INTA_BIT_TX_CMD_QUEUE                  0x00000800
1601 #define IPW_INTA_BIT_TX_QUEUE_1                    0x00001000
1602 #define IPW_INTA_BIT_TX_QUEUE_2                    0x00002000
1603 #define IPW_INTA_BIT_TX_QUEUE_3                    0x00004000
1604 #define IPW_INTA_BIT_TX_QUEUE_4                    0x00008000
1605
1606 #define IPW_INTA_BIT_SLAVE_MODE_HOST_CMD_DONE      0x00010000
1607
1608 #define IPW_INTA_BIT_PREPARE_FOR_POWER_DOWN        0x00100000
1609 #define IPW_INTA_BIT_POWER_DOWN                    0x00200000
1610
1611 #define IPW_INTA_BIT_FW_INITIALIZATION_DONE        0x01000000
1612 #define IPW_INTA_BIT_FW_CARD_DISABLE_PHY_OFF_DONE  0x02000000
1613 #define IPW_INTA_BIT_RF_KILL_DONE                  0x04000000
1614 #define IPW_INTA_BIT_FATAL_ERROR             0x40000000
1615 #define IPW_INTA_BIT_PARITY_ERROR            0x80000000
1616
1617 /* Interrupts enabled at init time. */
1618 #define IPW_INTA_MASK_ALL                        \
1619         (IPW_INTA_BIT_TX_QUEUE_1               | \
1620          IPW_INTA_BIT_TX_QUEUE_2               | \
1621          IPW_INTA_BIT_TX_QUEUE_3               | \
1622          IPW_INTA_BIT_TX_QUEUE_4               | \
1623          IPW_INTA_BIT_TX_CMD_QUEUE             | \
1624          IPW_INTA_BIT_RX_TRANSFER              | \
1625          IPW_INTA_BIT_FATAL_ERROR              | \
1626          IPW_INTA_BIT_PARITY_ERROR             | \
1627          IPW_INTA_BIT_STATUS_CHANGE            | \
1628          IPW_INTA_BIT_FW_INITIALIZATION_DONE   | \
1629          IPW_INTA_BIT_BEACON_PERIOD_EXPIRED    | \
1630          IPW_INTA_BIT_SLAVE_MODE_HOST_CMD_DONE | \
1631          IPW_INTA_BIT_PREPARE_FOR_POWER_DOWN   | \
1632          IPW_INTA_BIT_POWER_DOWN               | \
1633          IPW_INTA_BIT_RF_KILL_DONE )
1634
1635 /* FW event log definitions */
1636 #define EVENT_ELEM_SIZE     (3 * sizeof(u32))
1637 #define EVENT_START_OFFSET  (1 * sizeof(u32) + 2 * sizeof(u16))
1638
1639 /* FW error log definitions */
1640 #define ERROR_ELEM_SIZE     (7 * sizeof(u32))
1641 #define ERROR_START_OFFSET  (1 * sizeof(u32))
1642
1643 /* TX power level (dbm) */
1644 #define IPW_TX_POWER_MIN        -12
1645 #define IPW_TX_POWER_MAX        20
1646 #define IPW_TX_POWER_DEFAULT    IPW_TX_POWER_MAX
1647
1648 enum {
1649         IPW_FW_ERROR_OK = 0,
1650         IPW_FW_ERROR_FAIL,
1651         IPW_FW_ERROR_MEMORY_UNDERFLOW,
1652         IPW_FW_ERROR_MEMORY_OVERFLOW,
1653         IPW_FW_ERROR_BAD_PARAM,
1654         IPW_FW_ERROR_BAD_CHECKSUM,
1655         IPW_FW_ERROR_NMI_INTERRUPT,
1656         IPW_FW_ERROR_BAD_DATABASE,
1657         IPW_FW_ERROR_ALLOC_FAIL,
1658         IPW_FW_ERROR_DMA_UNDERRUN,
1659         IPW_FW_ERROR_DMA_STATUS,
1660         IPW_FW_ERROR_DINO_ERROR,
1661         IPW_FW_ERROR_EEPROM_ERROR,
1662         IPW_FW_ERROR_SYSASSERT,
1663         IPW_FW_ERROR_FATAL_ERROR
1664 };
1665
1666 #define AUTH_OPEN       0
1667 #define AUTH_SHARED_KEY 1
1668 #define AUTH_LEAP       2
1669 #define AUTH_IGNORE     3
1670
1671 #define HC_ASSOCIATE      0
1672 #define HC_REASSOCIATE    1
1673 #define HC_DISASSOCIATE   2
1674 #define HC_IBSS_START     3
1675 #define HC_IBSS_RECONF    4
1676 #define HC_DISASSOC_QUIET 5
1677
1678 #define HC_QOS_SUPPORT_ASSOC  0x01
1679
1680 #define IPW_RATE_CAPABILITIES 1
1681 #define IPW_RATE_CONNECT      0
1682
1683 /*
1684  * Rate values and masks
1685  */
1686 #define IPW_TX_RATE_1MB  0x0A
1687 #define IPW_TX_RATE_2MB  0x14
1688 #define IPW_TX_RATE_5MB  0x37
1689 #define IPW_TX_RATE_6MB  0x0D
1690 #define IPW_TX_RATE_9MB  0x0F
1691 #define IPW_TX_RATE_11MB 0x6E
1692 #define IPW_TX_RATE_12MB 0x05
1693 #define IPW_TX_RATE_18MB 0x07
1694 #define IPW_TX_RATE_24MB 0x09
1695 #define IPW_TX_RATE_36MB 0x0B
1696 #define IPW_TX_RATE_48MB 0x01
1697 #define IPW_TX_RATE_54MB 0x03
1698
1699 #define IPW_ORD_TABLE_ID_MASK             0x0000FF00
1700 #define IPW_ORD_TABLE_VALUE_MASK          0x000000FF
1701
1702 #define IPW_ORD_TABLE_0_MASK              0x0000F000
1703 #define IPW_ORD_TABLE_1_MASK              0x0000F100
1704 #define IPW_ORD_TABLE_2_MASK              0x0000F200
1705 #define IPW_ORD_TABLE_3_MASK              0x0000F300
1706 #define IPW_ORD_TABLE_4_MASK              0x0000F400
1707 #define IPW_ORD_TABLE_5_MASK              0x0000F500
1708 #define IPW_ORD_TABLE_6_MASK              0x0000F600
1709 #define IPW_ORD_TABLE_7_MASK              0x0000F700
1710
1711 /*
1712  * Table 0 Entries (all entries are 32 bits)
1713  */
1714 enum {
1715         IPW_ORD_STAT_TX_CURR_RATE = IPW_ORD_TABLE_0_MASK + 1,
1716         IPW_ORD_STAT_FRAG_TRESHOLD,
1717         IPW_ORD_STAT_RTS_THRESHOLD,
1718         IPW_ORD_STAT_TX_HOST_REQUESTS,
1719         IPW_ORD_STAT_TX_HOST_COMPLETE,
1720         IPW_ORD_STAT_TX_DIR_DATA,
1721         IPW_ORD_STAT_TX_DIR_DATA_B_1,
1722         IPW_ORD_STAT_TX_DIR_DATA_B_2,
1723         IPW_ORD_STAT_TX_DIR_DATA_B_5_5,
1724         IPW_ORD_STAT_TX_DIR_DATA_B_11,
1725         /* Hole */
1726
1727         IPW_ORD_STAT_TX_DIR_DATA_G_1 = IPW_ORD_TABLE_0_MASK + 19,
1728         IPW_ORD_STAT_TX_DIR_DATA_G_2,
1729         IPW_ORD_STAT_TX_DIR_DATA_G_5_5,
1730         IPW_ORD_STAT_TX_DIR_DATA_G_6,
1731         IPW_ORD_STAT_TX_DIR_DATA_G_9,
1732         IPW_ORD_STAT_TX_DIR_DATA_G_11,
1733         IPW_ORD_STAT_TX_DIR_DATA_G_12,
1734         IPW_ORD_STAT_TX_DIR_DATA_G_18,
1735         IPW_ORD_STAT_TX_DIR_DATA_G_24,
1736         IPW_ORD_STAT_TX_DIR_DATA_G_36,
1737         IPW_ORD_STAT_TX_DIR_DATA_G_48,
1738         IPW_ORD_STAT_TX_DIR_DATA_G_54,
1739         IPW_ORD_STAT_TX_NON_DIR_DATA,
1740         IPW_ORD_STAT_TX_NON_DIR_DATA_B_1,
1741         IPW_ORD_STAT_TX_NON_DIR_DATA_B_2,
1742         IPW_ORD_STAT_TX_NON_DIR_DATA_B_5_5,
1743         IPW_ORD_STAT_TX_NON_DIR_DATA_B_11,
1744         /* Hole */
1745
1746         IPW_ORD_STAT_TX_NON_DIR_DATA_G_1 = IPW_ORD_TABLE_0_MASK + 44,
1747         IPW_ORD_STAT_TX_NON_DIR_DATA_G_2,
1748         IPW_ORD_STAT_TX_NON_DIR_DATA_G_5_5,
1749         IPW_ORD_STAT_TX_NON_DIR_DATA_G_6,
1750         IPW_ORD_STAT_TX_NON_DIR_DATA_G_9,
1751         IPW_ORD_STAT_TX_NON_DIR_DATA_G_11,
1752         IPW_ORD_STAT_TX_NON_DIR_DATA_G_12,
1753         IPW_ORD_STAT_TX_NON_DIR_DATA_G_18,
1754         IPW_ORD_STAT_TX_NON_DIR_DATA_G_24,
1755         IPW_ORD_STAT_TX_NON_DIR_DATA_G_36,
1756         IPW_ORD_STAT_TX_NON_DIR_DATA_G_48,
1757         IPW_ORD_STAT_TX_NON_DIR_DATA_G_54,
1758         IPW_ORD_STAT_TX_RETRY,
1759         IPW_ORD_STAT_TX_FAILURE,
1760         IPW_ORD_STAT_RX_ERR_CRC,
1761         IPW_ORD_STAT_RX_ERR_ICV,
1762         IPW_ORD_STAT_RX_NO_BUFFER,
1763         IPW_ORD_STAT_FULL_SCANS,
1764         IPW_ORD_STAT_PARTIAL_SCANS,
1765         IPW_ORD_STAT_TGH_ABORTED_SCANS,
1766         IPW_ORD_STAT_TX_TOTAL_BYTES,
1767         IPW_ORD_STAT_CURR_RSSI_RAW,
1768         IPW_ORD_STAT_RX_BEACON,
1769         IPW_ORD_STAT_MISSED_BEACONS,
1770         IPW_ORD_TABLE_0_LAST
1771 };
1772
1773 #define IPW_RSSI_TO_DBM 112
1774
1775 /* Table 1 Entries
1776  */
1777 enum {
1778         IPW_ORD_TABLE_1_LAST = IPW_ORD_TABLE_1_MASK | 1,
1779 };
1780
1781 /*
1782  * Table 2 Entries
1783  *
1784  * FW_VERSION:    16 byte string
1785  * FW_DATE:       16 byte string (only 14 bytes used)
1786  * UCODE_VERSION: 4 byte version code
1787  * UCODE_DATE:    5 bytes code code
1788  * ADDAPTER_MAC:  6 byte MAC address
1789  * RTC:           4 byte clock
1790  */
1791 enum {
1792         IPW_ORD_STAT_FW_VERSION = IPW_ORD_TABLE_2_MASK | 1,
1793         IPW_ORD_STAT_FW_DATE,
1794         IPW_ORD_STAT_UCODE_VERSION,
1795         IPW_ORD_STAT_UCODE_DATE,
1796         IPW_ORD_STAT_ADAPTER_MAC,
1797         IPW_ORD_STAT_RTC,
1798         IPW_ORD_TABLE_2_LAST
1799 };
1800
1801 /* Table 3 */
1802 enum {
1803         IPW_ORD_STAT_TX_PACKET = IPW_ORD_TABLE_3_MASK | 0,
1804         IPW_ORD_STAT_TX_PACKET_FAILURE,
1805         IPW_ORD_STAT_TX_PACKET_SUCCESS,
1806         IPW_ORD_STAT_TX_PACKET_ABORTED,
1807         IPW_ORD_TABLE_3_LAST
1808 };
1809
1810 /* Table 4 */
1811 enum {
1812         IPW_ORD_TABLE_4_LAST = IPW_ORD_TABLE_4_MASK
1813 };
1814
1815 /* Table 5 */
1816 enum {
1817         IPW_ORD_STAT_AVAILABLE_AP_COUNT = IPW_ORD_TABLE_5_MASK,
1818         IPW_ORD_STAT_AP_ASSNS,
1819         IPW_ORD_STAT_ROAM,
1820         IPW_ORD_STAT_ROAM_CAUSE_MISSED_BEACONS,
1821         IPW_ORD_STAT_ROAM_CAUSE_UNASSOC,
1822         IPW_ORD_STAT_ROAM_CAUSE_RSSI,
1823         IPW_ORD_STAT_ROAM_CAUSE_LINK_QUALITY,
1824         IPW_ORD_STAT_ROAM_CAUSE_AP_LOAD_BALANCE,
1825         IPW_ORD_STAT_ROAM_CAUSE_AP_NO_TX,
1826         IPW_ORD_STAT_LINK_UP,
1827         IPW_ORD_STAT_LINK_DOWN,
1828         IPW_ORD_ANTENNA_DIVERSITY,
1829         IPW_ORD_CURR_FREQ,
1830         IPW_ORD_TABLE_5_LAST
1831 };
1832
1833 /* Table 6 */
1834 enum {
1835         IPW_ORD_COUNTRY_CODE = IPW_ORD_TABLE_6_MASK,
1836         IPW_ORD_CURR_BSSID,
1837         IPW_ORD_CURR_SSID,
1838         IPW_ORD_TABLE_6_LAST
1839 };
1840
1841 /* Table 7 */
1842 enum {
1843         IPW_ORD_STAT_PERCENT_MISSED_BEACONS = IPW_ORD_TABLE_7_MASK,
1844         IPW_ORD_STAT_PERCENT_TX_RETRIES,
1845         IPW_ORD_STAT_PERCENT_LINK_QUALITY,
1846         IPW_ORD_STAT_CURR_RSSI_DBM,
1847         IPW_ORD_TABLE_7_LAST
1848 };
1849
1850 #define IPW_ERROR_LOG     (IPW_SHARED_LOWER_BOUND + 0x410)
1851 #define IPW_EVENT_LOG     (IPW_SHARED_LOWER_BOUND + 0x414)
1852 #define IPW_ORDINALS_TABLE_LOWER        (IPW_SHARED_LOWER_BOUND + 0x500)
1853 #define IPW_ORDINALS_TABLE_0            (IPW_SHARED_LOWER_BOUND + 0x180)
1854 #define IPW_ORDINALS_TABLE_1            (IPW_SHARED_LOWER_BOUND + 0x184)
1855 #define IPW_ORDINALS_TABLE_2            (IPW_SHARED_LOWER_BOUND + 0x188)
1856 #define IPW_MEM_FIXED_OVERRIDE          (IPW_SHARED_LOWER_BOUND + 0x41C)
1857
1858 struct ipw_fixed_rate {
1859         u16 tx_rates;
1860         u16 reserved;
1861 } __attribute__ ((packed));
1862
1863 #define IPW_INDIRECT_ADDR_MASK (~0x3ul)
1864
1865 struct host_cmd {
1866         u8 cmd;
1867         u8 len;
1868         u16 reserved;
1869         u32 *param;
1870 } __attribute__ ((packed));
1871
1872 struct ipw_cmd_log {
1873         unsigned long jiffies;
1874         int retcode;
1875         struct host_cmd cmd;
1876 };
1877
1878 /* SysConfig command parameters ... */
1879 /* bt_coexistence param */
1880 #define CFG_BT_COEXISTENCE_SIGNAL_CHNL  0x01    /* tell BT our chnl # */
1881 #define CFG_BT_COEXISTENCE_DEFER        0x02    /* defer our Tx if BT traffic */
1882 #define CFG_BT_COEXISTENCE_KILL         0x04    /* kill our Tx if BT traffic */
1883 #define CFG_BT_COEXISTENCE_WME_OVER_BT  0x08    /* multimedia extensions */
1884 #define CFG_BT_COEXISTENCE_OOB          0x10    /* signal BT via out-of-band */
1885
1886 /* clear-to-send to self param */
1887 #define CFG_CTS_TO_ITSELF_ENABLED_MIN   0x00
1888 #define CFG_CTS_TO_ITSELF_ENABLED_MAX   0x01
1889 #define CFG_CTS_TO_ITSELF_ENABLED_DEF   CFG_CTS_TO_ITSELF_ENABLED_MIN
1890
1891 /* Antenna diversity param (h/w can select best antenna, based on signal) */
1892 #define CFG_SYS_ANTENNA_BOTH            0x00    /* NIC selects best antenna */
1893 #define CFG_SYS_ANTENNA_A               0x01    /* force antenna A */
1894 #define CFG_SYS_ANTENNA_B               0x03    /* force antenna B */
1895
1896 /*
1897  * The definitions below were lifted off the ipw2100 driver, which only
1898  * supports 'b' mode, so I'm sure these are not exactly correct.
1899  *
1900  * Somebody fix these!!
1901  */
1902 #define REG_MIN_CHANNEL             0
1903 #define REG_MAX_CHANNEL             14
1904
1905 #define REG_CHANNEL_MASK            0x00003FFF
1906 #define IPW_IBSS_11B_DEFAULT_MASK   0x87ff
1907
1908 #define IPW_MAX_CONFIG_RETRIES 10
1909
1910 static inline u32 frame_hdr_len(struct ieee80211_hdr_4addr *hdr)
1911 {
1912         u32 retval;
1913         u16 fc;
1914
1915         retval = sizeof(struct ieee80211_hdr_3addr);
1916         fc = le16_to_cpu(hdr->frame_ctl);
1917
1918         /*
1919          * Function     ToDS    FromDS
1920          * IBSS         0       0
1921          * To AP        1       0
1922          * From AP      0       1
1923          * WDS (bridge) 1       1
1924          *
1925          * Only WDS frames use Address4 among them. --YZ
1926          */
1927         if (!(fc & IEEE80211_FCTL_TODS) || !(fc & IEEE80211_FCTL_FROMDS))
1928                 retval -= ETH_ALEN;
1929
1930         return retval;
1931 }
1932
1933 #endif                          /* __ipw2200_h__ */