Merge branch 'master'
[linux-2.6] / drivers / net / wireless / ipw2100.h
1 /******************************************************************************
2
3   Copyright(c) 2003 - 2004 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 #ifndef _IPW2100_H
27 #define _IPW2100_H
28
29 #include <linux/sched.h>
30 #include <linux/interrupt.h>
31 #include <linux/netdevice.h>
32 #include <linux/etherdevice.h>
33 #include <linux/list.h>
34 #include <linux/delay.h>
35 #include <linux/skbuff.h>
36 #include <asm/io.h>
37 #include <linux/socket.h>
38 #include <linux/if_arp.h>
39 #include <linux/wireless.h>
40 #include <net/iw_handler.h>     // new driver API
41
42 #include <net/ieee80211.h>
43
44 #include <linux/workqueue.h>
45
46 struct ipw2100_priv;
47 struct ipw2100_tx_packet;
48 struct ipw2100_rx_packet;
49
50 #define IPW_DL_UNINIT    0x80000000
51 #define IPW_DL_NONE      0x00000000
52 #define IPW_DL_ALL       0x7FFFFFFF
53
54 /*
55  * To use the debug system;
56  *
57  * If you are defining a new debug classification, simply add it to the #define
58  * list here in the form of:
59  *
60  * #define IPW_DL_xxxx VALUE
61  *
62  * shifting value to the left one bit from the previous entry.  xxxx should be
63  * the name of the classification (for example, WEP)
64  *
65  * You then need to either add a IPW2100_xxxx_DEBUG() macro definition for your
66  * classification, or use IPW_DEBUG(IPW_DL_xxxx, ...) whenever you want
67  * to send output to that classification.
68  *
69  * To add your debug level to the list of levels seen when you perform
70  *
71  * % cat /proc/net/ipw2100/debug_level
72  *
73  * you simply need to add your entry to the ipw2100_debug_levels array.
74  *
75  * If you do not see debug_level in /proc/net/ipw2100 then you do not have
76  * CONFIG_IPW2100_DEBUG defined in your kernel configuration
77  *
78  */
79
80 #define IPW_DL_ERROR         (1<<0)
81 #define IPW_DL_WARNING       (1<<1)
82 #define IPW_DL_INFO          (1<<2)
83 #define IPW_DL_WX            (1<<3)
84 #define IPW_DL_HC            (1<<5)
85 #define IPW_DL_STATE         (1<<6)
86
87 #define IPW_DL_NOTIF         (1<<10)
88 #define IPW_DL_SCAN          (1<<11)
89 #define IPW_DL_ASSOC         (1<<12)
90 #define IPW_DL_DROP          (1<<13)
91
92 #define IPW_DL_IOCTL         (1<<14)
93 #define IPW_DL_RF_KILL       (1<<17)
94
95 #define IPW_DL_MANAGE        (1<<15)
96 #define IPW_DL_FW            (1<<16)
97
98 #define IPW_DL_FRAG          (1<<21)
99 #define IPW_DL_WEP           (1<<22)
100 #define IPW_DL_TX            (1<<23)
101 #define IPW_DL_RX            (1<<24)
102 #define IPW_DL_ISR           (1<<25)
103 #define IPW_DL_IO            (1<<26)
104 #define IPW_DL_TRACE         (1<<28)
105
106 #define IPW_DEBUG_ERROR(f, a...) printk(KERN_ERR DRV_NAME ": " f, ## a)
107 #define IPW_DEBUG_WARNING(f, a...) printk(KERN_WARNING DRV_NAME ": " f, ## a)
108 #define IPW_DEBUG_INFO(f...)    IPW_DEBUG(IPW_DL_INFO, ## f)
109 #define IPW_DEBUG_WX(f...)     IPW_DEBUG(IPW_DL_WX, ## f)
110 #define IPW_DEBUG_SCAN(f...)   IPW_DEBUG(IPW_DL_SCAN, ## f)
111 #define IPW_DEBUG_NOTIF(f...) IPW_DEBUG(IPW_DL_NOTIF, ## f)
112 #define IPW_DEBUG_TRACE(f...)  IPW_DEBUG(IPW_DL_TRACE, ## f)
113 #define IPW_DEBUG_RX(f...)     IPW_DEBUG(IPW_DL_RX, ## f)
114 #define IPW_DEBUG_TX(f...)     IPW_DEBUG(IPW_DL_TX, ## f)
115 #define IPW_DEBUG_ISR(f...)    IPW_DEBUG(IPW_DL_ISR, ## f)
116 #define IPW_DEBUG_MANAGEMENT(f...) IPW_DEBUG(IPW_DL_MANAGE, ## f)
117 #define IPW_DEBUG_WEP(f...)    IPW_DEBUG(IPW_DL_WEP, ## f)
118 #define IPW_DEBUG_HC(f...) IPW_DEBUG(IPW_DL_HC, ## f)
119 #define IPW_DEBUG_FRAG(f...) IPW_DEBUG(IPW_DL_FRAG, ## f)
120 #define IPW_DEBUG_FW(f...) IPW_DEBUG(IPW_DL_FW, ## f)
121 #define IPW_DEBUG_RF_KILL(f...) IPW_DEBUG(IPW_DL_RF_KILL, ## f)
122 #define IPW_DEBUG_DROP(f...) IPW_DEBUG(IPW_DL_DROP, ## f)
123 #define IPW_DEBUG_IO(f...) IPW_DEBUG(IPW_DL_IO, ## f)
124 #define IPW_DEBUG_IOCTL(f...) IPW_DEBUG(IPW_DL_IOCTL, ## f)
125 #define IPW_DEBUG_STATE(f, a...) IPW_DEBUG(IPW_DL_STATE | IPW_DL_ASSOC | IPW_DL_INFO, f, ## a)
126 #define IPW_DEBUG_ASSOC(f, a...) IPW_DEBUG(IPW_DL_ASSOC | IPW_DL_INFO, f, ## a)
127
128 enum {
129         IPW_HW_STATE_DISABLED = 1,
130         IPW_HW_STATE_ENABLED = 0
131 };
132
133 struct ssid_context {
134         char ssid[IW_ESSID_MAX_SIZE + 1];
135         int ssid_len;
136         unsigned char bssid[ETH_ALEN];
137         int port_type;
138         int channel;
139
140 };
141
142 extern const char *port_type_str[];
143 extern const char *band_str[];
144
145 #define NUMBER_OF_BD_PER_COMMAND_PACKET         1
146 #define NUMBER_OF_BD_PER_DATA_PACKET            2
147
148 #define IPW_MAX_BDS 6
149 #define NUMBER_OF_OVERHEAD_BDS_PER_PACKETR      2
150 #define NUMBER_OF_BDS_TO_LEAVE_FOR_COMMANDS     1
151
152 #define REQUIRED_SPACE_IN_RING_FOR_COMMAND_PACKET \
153     (IPW_BD_QUEUE_W_R_MIN_SPARE + NUMBER_OF_BD_PER_COMMAND_PACKET)
154
155 struct bd_status {
156         union {
157                 struct {
158                         u8 nlf:1, txType:2, intEnabled:1, reserved:4;
159                 } fields;
160                 u8 field;
161         } info;
162 } __attribute__ ((packed));
163
164 struct ipw2100_bd {
165         u32 host_addr;
166         u32 buf_length;
167         struct bd_status status;
168         /* number of fragments for frame (should be set only for
169          * 1st TBD) */
170         u8 num_fragments;
171         u8 reserved[6];
172 } __attribute__ ((packed));
173
174 #define IPW_BD_QUEUE_LENGTH(n) (1<<n)
175 #define IPW_BD_ALIGNMENT(L)    (L*sizeof(struct ipw2100_bd))
176
177 #define IPW_BD_STATUS_TX_FRAME_802_3             0x00
178 #define IPW_BD_STATUS_TX_FRAME_NOT_LAST_FRAGMENT 0x01
179 #define IPW_BD_STATUS_TX_FRAME_COMMAND           0x02
180 #define IPW_BD_STATUS_TX_FRAME_802_11            0x04
181 #define IPW_BD_STATUS_TX_INTERRUPT_ENABLE        0x08
182
183 struct ipw2100_bd_queue {
184         /* driver (virtual) pointer to queue */
185         struct ipw2100_bd *drv;
186
187         /* firmware (physical) pointer to queue */
188         dma_addr_t nic;
189
190         /* Length of phy memory allocated for BDs */
191         u32 size;
192
193         /* Number of BDs in queue (and in array) */
194         u32 entries;
195
196         /* Number of available BDs (invalid for NIC BDs) */
197         u32 available;
198
199         /* Offset of oldest used BD in array (next one to
200          * check for completion) */
201         u32 oldest;
202
203         /* Offset of next available (unused) BD */
204         u32 next;
205 };
206
207 #define RX_QUEUE_LENGTH 256
208 #define TX_QUEUE_LENGTH 256
209 #define HW_QUEUE_LENGTH 256
210
211 #define TX_PENDED_QUEUE_LENGTH (TX_QUEUE_LENGTH / NUMBER_OF_BD_PER_DATA_PACKET)
212
213 #define STATUS_TYPE_MASK        0x0000000f
214 #define COMMAND_STATUS_VAL      0
215 #define STATUS_CHANGE_VAL       1
216 #define P80211_DATA_VAL         2
217 #define P8023_DATA_VAL          3
218 #define HOST_NOTIFICATION_VAL   4
219
220 #define IPW2100_RSSI_TO_DBM (-98)
221
222 struct ipw2100_status {
223         u32 frame_size;
224         u16 status_fields;
225         u8 flags;
226 #define IPW_STATUS_FLAG_DECRYPTED       (1<<0)
227 #define IPW_STATUS_FLAG_WEP_ENCRYPTED   (1<<1)
228 #define IPW_STATUS_FLAG_CRC_ERROR       (1<<2)
229         u8 rssi;
230 } __attribute__ ((packed));
231
232 struct ipw2100_status_queue {
233         /* driver (virtual) pointer to queue */
234         struct ipw2100_status *drv;
235
236         /* firmware (physical) pointer to queue */
237         dma_addr_t nic;
238
239         /* Length of phy memory allocated for BDs */
240         u32 size;
241 };
242
243 #define HOST_COMMAND_PARAMS_REG_LEN     100
244 #define CMD_STATUS_PARAMS_REG_LEN       3
245
246 #define IPW_WPA_CAPABILITIES   0x1
247 #define IPW_WPA_LISTENINTERVAL 0x2
248 #define IPW_WPA_AP_ADDRESS     0x4
249
250 #define IPW_MAX_VAR_IE_LEN ((HOST_COMMAND_PARAMS_REG_LEN - 4) * sizeof(u32))
251
252 struct ipw2100_wpa_assoc_frame {
253         u16 fixed_ie_mask;
254         struct {
255                 u16 capab_info;
256                 u16 listen_interval;
257                 u8 current_ap[ETH_ALEN];
258         } fixed_ies;
259         u32 var_ie_len;
260         u8 var_ie[IPW_MAX_VAR_IE_LEN];
261 };
262
263 #define IPW_BSS     1
264 #define IPW_MONITOR 2
265 #define IPW_IBSS    3
266
267 /**
268  * @struct _tx_cmd - HWCommand
269  * @brief H/W command structure.
270  */
271 struct ipw2100_cmd_header {
272         u32 host_command_reg;
273         u32 host_command_reg1;
274         u32 sequence;
275         u32 host_command_len_reg;
276         u32 host_command_params_reg[HOST_COMMAND_PARAMS_REG_LEN];
277         u32 cmd_status_reg;
278         u32 cmd_status_params_reg[CMD_STATUS_PARAMS_REG_LEN];
279         u32 rxq_base_ptr;
280         u32 rxq_next_ptr;
281         u32 rxq_host_ptr;
282         u32 txq_base_ptr;
283         u32 txq_next_ptr;
284         u32 txq_host_ptr;
285         u32 tx_status_reg;
286         u32 reserved;
287         u32 status_change_reg;
288         u32 reserved1[3];
289         u32 *ordinal1_ptr;
290         u32 *ordinal2_ptr;
291 } __attribute__ ((packed));
292
293 struct ipw2100_data_header {
294         u32 host_command_reg;
295         u32 host_command_reg1;
296         u8 encrypted;           // BOOLEAN in win! TRUE if frame is enc by driver
297         u8 needs_encryption;    // BOOLEAN in win! TRUE if frma need to be enc in NIC
298         u8 wep_index;           // 0 no key, 1-4 key index, 0xff immediate key
299         u8 key_size;            // 0 no imm key, 0x5 64bit encr, 0xd 128bit encr, 0x10 128bit encr and 128bit IV
300         u8 key[16];
301         u8 reserved[10];        // f/w reserved
302         u8 src_addr[ETH_ALEN];
303         u8 dst_addr[ETH_ALEN];
304         u16 fragment_size;
305 } __attribute__ ((packed));
306
307 /* Host command data structure */
308 struct host_command {
309         u32 host_command;       // COMMAND ID
310         u32 host_command1;      // COMMAND ID
311         u32 host_command_sequence;      // UNIQUE COMMAND NUMBER (ID)
312         u32 host_command_length;        // LENGTH
313         u32 host_command_parameters[HOST_COMMAND_PARAMS_REG_LEN];       // COMMAND PARAMETERS
314 } __attribute__ ((packed));
315
316 typedef enum {
317         POWER_ON_RESET,
318         EXIT_POWER_DOWN_RESET,
319         SW_RESET,
320         EEPROM_RW,
321         SW_RE_INIT
322 } ipw2100_reset_event;
323
324 enum {
325         COMMAND = 0xCAFE,
326         DATA,
327         RX
328 };
329
330 struct ipw2100_tx_packet {
331         int type;
332         int index;
333         union {
334                 struct {        /* COMMAND */
335                         struct ipw2100_cmd_header *cmd;
336                         dma_addr_t cmd_phys;
337                 } c_struct;
338                 struct {        /* DATA */
339                         struct ipw2100_data_header *data;
340                         dma_addr_t data_phys;
341                         struct ieee80211_txb *txb;
342                 } d_struct;
343         } info;
344         int jiffy_start;
345
346         struct list_head list;
347 };
348
349 struct ipw2100_rx_packet {
350         struct ipw2100_rx *rxp;
351         dma_addr_t dma_addr;
352         int jiffy_start;
353         struct sk_buff *skb;
354         struct list_head list;
355 };
356
357 #define FRAG_DISABLED             (1<<31)
358 #define RTS_DISABLED              (1<<31)
359 #define MAX_RTS_THRESHOLD         2304U
360 #define MIN_RTS_THRESHOLD         1U
361 #define DEFAULT_RTS_THRESHOLD     1000U
362
363 #define DEFAULT_BEACON_INTERVAL   100U
364 #define DEFAULT_SHORT_RETRY_LIMIT 7U
365 #define DEFAULT_LONG_RETRY_LIMIT  4U
366
367 struct ipw2100_ordinals {
368         u32 table1_addr;
369         u32 table2_addr;
370         u32 table1_size;
371         u32 table2_size;
372 };
373
374 /* Host Notification header */
375 struct ipw2100_notification {
376         u32 hnhdr_subtype;      /* type of host notification */
377         u32 hnhdr_size;         /* size in bytes of data
378                                    or number of entries, if table.
379                                    Does NOT include header */
380 } __attribute__ ((packed));
381
382 #define MAX_KEY_SIZE    16
383 #define MAX_KEYS        8
384
385 #define IPW2100_WEP_ENABLE     (1<<1)
386 #define IPW2100_WEP_DROP_CLEAR (1<<2)
387
388 #define IPW_NONE_CIPHER   (1<<0)
389 #define IPW_WEP40_CIPHER  (1<<1)
390 #define IPW_TKIP_CIPHER   (1<<2)
391 #define IPW_CCMP_CIPHER   (1<<4)
392 #define IPW_WEP104_CIPHER (1<<5)
393 #define IPW_CKIP_CIPHER   (1<<6)
394
395 #define IPW_AUTH_OPEN           0
396 #define IPW_AUTH_SHARED         1
397 #define IPW_AUTH_LEAP           2
398 #define IPW_AUTH_LEAP_CISCO_ID  0x80
399
400 struct statistic {
401         int value;
402         int hi;
403         int lo;
404 };
405
406 #define INIT_STAT(x) do {  \
407   (x)->value = (x)->hi = 0; \
408   (x)->lo = 0x7fffffff; \
409 } while (0)
410 #define SET_STAT(x,y) do { \
411   (x)->value = y; \
412   if ((x)->value > (x)->hi) (x)->hi = (x)->value; \
413   if ((x)->value < (x)->lo) (x)->lo = (x)->value; \
414 } while (0)
415 #define INC_STAT(x) do { if (++(x)->value > (x)->hi) (x)->hi = (x)->value; } \
416 while (0)
417 #define DEC_STAT(x) do { if (--(x)->value < (x)->lo) (x)->lo = (x)->value; } \
418 while (0)
419
420 #define IPW2100_ERROR_QUEUE 5
421
422 /* Power management code: enable or disable? */
423 enum {
424 #ifdef CONFIG_PM
425         IPW2100_PM_DISABLED = 0,
426         PM_STATE_SIZE = 16,
427 #else
428         IPW2100_PM_DISABLED = 1,
429         PM_STATE_SIZE = 0,
430 #endif
431 };
432
433 #define STATUS_POWERED          (1<<0)
434 #define STATUS_CMD_ACTIVE       (1<<1)  /**< host command in progress */
435 #define STATUS_RUNNING          (1<<2)  /* Card initialized, but not enabled */
436 #define STATUS_ENABLED          (1<<3)  /* Card enabled -- can scan,Tx,Rx */
437 #define STATUS_STOPPING         (1<<4)  /* Card is in shutdown phase */
438 #define STATUS_INITIALIZED      (1<<5)  /* Card is ready for external calls */
439 #define STATUS_ASSOCIATING      (1<<9)  /* Associated, but no BSSID yet */
440 #define STATUS_ASSOCIATED       (1<<10) /* Associated and BSSID valid */
441 #define STATUS_INT_ENABLED      (1<<11)
442 #define STATUS_RF_KILL_HW       (1<<12)
443 #define STATUS_RF_KILL_SW       (1<<13)
444 #define STATUS_RF_KILL_MASK     (STATUS_RF_KILL_HW | STATUS_RF_KILL_SW)
445 #define STATUS_EXIT_PENDING     (1<<14)
446
447 #define STATUS_SCAN_PENDING     (1<<23)
448 #define STATUS_SCANNING         (1<<24)
449 #define STATUS_SCAN_ABORTING    (1<<25)
450 #define STATUS_SCAN_COMPLETE    (1<<26)
451 #define STATUS_WX_EVENT_PENDING (1<<27)
452 #define STATUS_RESET_PENDING    (1<<29)
453 #define STATUS_SECURITY_UPDATED (1<<30) /* Security sync needed */
454
455 /* Internal NIC states */
456 #define IPW_STATE_INITIALIZED   (1<<0)
457 #define IPW_STATE_COUNTRY_FOUND (1<<1)
458 #define IPW_STATE_ASSOCIATED    (1<<2)
459 #define IPW_STATE_ASSN_LOST     (1<<3)
460 #define IPW_STATE_ASSN_CHANGED  (1<<4)
461 #define IPW_STATE_SCAN_COMPLETE (1<<5)
462 #define IPW_STATE_ENTERED_PSP   (1<<6)
463 #define IPW_STATE_LEFT_PSP      (1<<7)
464 #define IPW_STATE_RF_KILL       (1<<8)
465 #define IPW_STATE_DISABLED      (1<<9)
466 #define IPW_STATE_POWER_DOWN    (1<<10)
467 #define IPW_STATE_SCANNING      (1<<11)
468
469 #define CFG_STATIC_CHANNEL      (1<<0)  /* Restrict assoc. to single channel */
470 #define CFG_STATIC_ESSID        (1<<1)  /* Restrict assoc. to single SSID */
471 #define CFG_STATIC_BSSID        (1<<2)  /* Restrict assoc. to single BSSID */
472 #define CFG_CUSTOM_MAC          (1<<3)
473 #define CFG_LONG_PREAMBLE       (1<<4)
474 #define CFG_ASSOCIATE           (1<<6)
475 #define CFG_FIXED_RATE          (1<<7)
476 #define CFG_ADHOC_CREATE        (1<<8)
477 #define CFG_C3_DISABLED         (1<<9)
478 #define CFG_PASSIVE_SCAN        (1<<10)
479 #ifdef CONFIG_IPW2100_MONITOR
480 #define CFG_CRC_CHECK           (1<<11)
481 #endif
482
483 #define CAP_SHARED_KEY          (1<<0)  /* Off = OPEN */
484 #define CAP_PRIVACY_ON          (1<<1)  /* Off = No privacy */
485
486 struct ipw2100_priv {
487
488         int stop_hang_check;    /* Set 1 when shutting down to kill hang_check */
489         int stop_rf_kill;       /* Set 1 when shutting down to kill rf_kill */
490
491         struct ieee80211_device *ieee;
492         unsigned long status;
493         unsigned long config;
494         unsigned long capability;
495
496         /* Statistics */
497         int resets;
498         int reset_backoff;
499
500         /* Context */
501         u8 essid[IW_ESSID_MAX_SIZE];
502         u8 essid_len;
503         u8 bssid[ETH_ALEN];
504         u8 channel;
505         int last_mode;
506         int cstate_limit;
507
508         unsigned long connect_start;
509         unsigned long last_reset;
510
511         u32 channel_mask;
512         u32 fatal_error;
513         u32 fatal_errors[IPW2100_ERROR_QUEUE];
514         u32 fatal_index;
515         int eeprom_version;
516         int firmware_version;
517         unsigned long hw_features;
518         int hangs;
519         u32 last_rtc;
520         int dump_raw;           /* 1 to dump raw bytes in /sys/.../memory */
521         u8 *snapshot[0x30];
522
523         u8 mandatory_bssid_mac[ETH_ALEN];
524         u8 mac_addr[ETH_ALEN];
525
526         int power_mode;
527
528         int messages_sent;
529
530         int short_retry_limit;
531         int long_retry_limit;
532
533         u32 rts_threshold;
534         u32 frag_threshold;
535
536         int in_isr;
537
538         u32 tx_rates;
539         int tx_power;
540         u32 beacon_interval;
541
542         char nick[IW_ESSID_MAX_SIZE + 1];
543
544         struct ipw2100_status_queue status_queue;
545
546         struct statistic txq_stat;
547         struct statistic rxq_stat;
548         struct ipw2100_bd_queue rx_queue;
549         struct ipw2100_bd_queue tx_queue;
550         struct ipw2100_rx_packet *rx_buffers;
551
552         struct statistic fw_pend_stat;
553         struct list_head fw_pend_list;
554
555         struct statistic msg_free_stat;
556         struct statistic msg_pend_stat;
557         struct list_head msg_free_list;
558         struct list_head msg_pend_list;
559         struct ipw2100_tx_packet *msg_buffers;
560
561         struct statistic tx_free_stat;
562         struct statistic tx_pend_stat;
563         struct list_head tx_free_list;
564         struct list_head tx_pend_list;
565         struct ipw2100_tx_packet *tx_buffers;
566
567         struct ipw2100_ordinals ordinals;
568
569         struct pci_dev *pci_dev;
570
571         struct proc_dir_entry *dir_dev;
572
573         struct net_device *net_dev;
574         struct iw_statistics wstats;
575
576         struct iw_public_data wireless_data;
577
578         struct tasklet_struct irq_tasklet;
579
580         struct workqueue_struct *workqueue;
581         struct work_struct reset_work;
582         struct work_struct security_work;
583         struct work_struct wx_event_work;
584         struct work_struct hang_check;
585         struct work_struct rf_kill;
586
587         u32 interrupts;
588         int tx_interrupts;
589         int rx_interrupts;
590         int inta_other;
591
592         spinlock_t low_lock;
593         struct semaphore action_sem;
594         struct semaphore adapter_sem;
595
596         wait_queue_head_t wait_command_queue;
597 };
598
599 /*********************************************************
600  * Host Command -> From Driver to FW
601  *********************************************************/
602
603 /**
604  * Host command identifiers
605  */
606 #define HOST_COMPLETE           2
607 #define SYSTEM_CONFIG           6
608 #define SSID                    8
609 #define MANDATORY_BSSID         9
610 #define AUTHENTICATION_TYPE    10
611 #define ADAPTER_ADDRESS        11
612 #define PORT_TYPE              12
613 #define INTERNATIONAL_MODE     13
614 #define CHANNEL                14
615 #define RTS_THRESHOLD          15
616 #define FRAG_THRESHOLD         16
617 #define POWER_MODE             17
618 #define TX_RATES               18
619 #define BASIC_TX_RATES         19
620 #define WEP_KEY_INFO           20
621 #define WEP_KEY_INDEX          25
622 #define WEP_FLAGS              26
623 #define ADD_MULTICAST          27
624 #define CLEAR_ALL_MULTICAST    28
625 #define BEACON_INTERVAL        29
626 #define ATIM_WINDOW            30
627 #define CLEAR_STATISTICS       31
628 #define SEND                   33
629 #define TX_POWER_INDEX         36
630 #define BROADCAST_SCAN         43
631 #define CARD_DISABLE           44
632 #define PREFERRED_BSSID        45
633 #define SET_SCAN_OPTIONS       46
634 #define SCAN_DWELL_TIME        47
635 #define SWEEP_TABLE            48
636 #define AP_OR_STATION_TABLE    49
637 #define GROUP_ORDINALS         50
638 #define SHORT_RETRY_LIMIT      51
639 #define LONG_RETRY_LIMIT       52
640
641 #define HOST_PRE_POWER_DOWN    58
642 #define CARD_DISABLE_PHY_OFF   61
643 #define MSDU_TX_RATES          62
644
645 /* Rogue AP Detection */
646 #define SET_STATION_STAT_BITS      64
647 #define CLEAR_STATIONS_STAT_BITS   65
648 #define LEAP_ROGUE_MODE            66   //TODO tbw replaced by CFG_LEAP_ROGUE_AP
649 #define SET_SECURITY_INFORMATION   67
650 #define DISASSOCIATION_BSSID       68
651 #define SET_WPA_IE                 69
652
653 /* system configuration bit mask: */
654 #define IPW_CFG_MONITOR               0x00004
655 #define IPW_CFG_PREAMBLE_AUTO        0x00010
656 #define IPW_CFG_IBSS_AUTO_START     0x00020
657 #define IPW_CFG_LOOPBACK            0x00100
658 #define IPW_CFG_ANSWER_BCSSID_PROBE 0x00800
659 #define IPW_CFG_BT_SIDEBAND_SIGNAL      0x02000
660 #define IPW_CFG_802_1x_ENABLE       0x04000
661 #define IPW_CFG_BSS_MASK                0x08000
662 #define IPW_CFG_IBSS_MASK               0x10000
663
664 #define IPW_SCAN_NOASSOCIATE (1<<0)
665 #define IPW_SCAN_MIXED_CELL (1<<1)
666 /* RESERVED (1<<2) */
667 #define IPW_SCAN_PASSIVE (1<<3)
668
669 #define IPW_NIC_FATAL_ERROR 0x2A7F0
670 #define IPW_ERROR_ADDR(x) (x & 0x3FFFF)
671 #define IPW_ERROR_CODE(x) ((x & 0xFF000000) >> 24)
672 #define IPW2100_ERR_C3_CORRUPTION (0x10 << 24)
673 #define IPW2100_ERR_MSG_TIMEOUT   (0x11 << 24)
674 #define IPW2100_ERR_FW_LOAD       (0x12 << 24)
675
676 #define IPW_MEM_SRAM_HOST_SHARED_LOWER_BOUND                    0x200
677 #define IPW_MEM_SRAM_HOST_INTERRUPT_AREA_LOWER_BOUND    IPW_MEM_SRAM_HOST_SHARED_LOWER_BOUND + 0x0D80
678
679 #define IPW_MEM_HOST_SHARED_RX_BD_BASE                  (IPW_MEM_SRAM_HOST_SHARED_LOWER_BOUND + 0x40)
680 #define IPW_MEM_HOST_SHARED_RX_STATUS_BASE              (IPW_MEM_SRAM_HOST_SHARED_LOWER_BOUND + 0x44)
681 #define IPW_MEM_HOST_SHARED_RX_BD_SIZE                  (IPW_MEM_SRAM_HOST_SHARED_LOWER_BOUND + 0x48)
682 #define IPW_MEM_HOST_SHARED_RX_READ_INDEX               (IPW_MEM_SRAM_HOST_SHARED_LOWER_BOUND + 0xa0)
683
684 #define IPW_MEM_HOST_SHARED_TX_QUEUE_BD_BASE          (IPW_MEM_SRAM_HOST_SHARED_LOWER_BOUND + 0x00)
685 #define IPW_MEM_HOST_SHARED_TX_QUEUE_BD_SIZE          (IPW_MEM_SRAM_HOST_SHARED_LOWER_BOUND + 0x04)
686 #define IPW_MEM_HOST_SHARED_TX_QUEUE_READ_INDEX       (IPW_MEM_SRAM_HOST_SHARED_LOWER_BOUND + 0x80)
687
688 #define IPW_MEM_HOST_SHARED_RX_WRITE_INDEX \
689     (IPW_MEM_SRAM_HOST_INTERRUPT_AREA_LOWER_BOUND + 0x20)
690
691 #define IPW_MEM_HOST_SHARED_TX_QUEUE_WRITE_INDEX \
692     (IPW_MEM_SRAM_HOST_INTERRUPT_AREA_LOWER_BOUND)
693
694 #define IPW_MEM_HOST_SHARED_ORDINALS_TABLE_1   (IPW_MEM_SRAM_HOST_SHARED_LOWER_BOUND + 0x180)
695 #define IPW_MEM_HOST_SHARED_ORDINALS_TABLE_2   (IPW_MEM_SRAM_HOST_SHARED_LOWER_BOUND + 0x184)
696
697 #define IPW2100_INTA_TX_TRANSFER               (0x00000001)     // Bit 0 (LSB)
698 #define IPW2100_INTA_RX_TRANSFER               (0x00000002)     // Bit 1
699 #define IPW2100_INTA_TX_COMPLETE               (0x00000004)     // Bit 2
700 #define IPW2100_INTA_EVENT_INTERRUPT           (0x00000008)     // Bit 3
701 #define IPW2100_INTA_STATUS_CHANGE             (0x00000010)     // Bit 4
702 #define IPW2100_INTA_BEACON_PERIOD_EXPIRED     (0x00000020)     // Bit 5
703 #define IPW2100_INTA_SLAVE_MODE_HOST_COMMAND_DONE  (0x00010000) // Bit 16
704 #define IPW2100_INTA_FW_INIT_DONE              (0x01000000)     // Bit 24
705 #define IPW2100_INTA_FW_CALIBRATION_CALC       (0x02000000)     // Bit 25
706 #define IPW2100_INTA_FATAL_ERROR               (0x40000000)     // Bit 30
707 #define IPW2100_INTA_PARITY_ERROR              (0x80000000)     // Bit 31 (MSB)
708
709 #define IPW_AUX_HOST_RESET_REG_PRINCETON_RESET              (0x00000001)
710 #define IPW_AUX_HOST_RESET_REG_FORCE_NMI                    (0x00000002)
711 #define IPW_AUX_HOST_RESET_REG_PCI_HOST_CLUSTER_FATAL_NMI   (0x00000004)
712 #define IPW_AUX_HOST_RESET_REG_CORE_FATAL_NMI               (0x00000008)
713 #define IPW_AUX_HOST_RESET_REG_SW_RESET                     (0x00000080)
714 #define IPW_AUX_HOST_RESET_REG_MASTER_DISABLED              (0x00000100)
715 #define IPW_AUX_HOST_RESET_REG_STOP_MASTER                  (0x00000200)
716
717 #define IPW_AUX_HOST_GP_CNTRL_BIT_CLOCK_READY           (0x00000001)    // Bit 0 (LSB)
718 #define IPW_AUX_HOST_GP_CNTRL_BIT_HOST_ALLOWS_STANDBY   (0x00000002)    // Bit 1
719 #define IPW_AUX_HOST_GP_CNTRL_BIT_INIT_DONE             (0x00000004)    // Bit 2
720 #define IPW_AUX_HOST_GP_CNTRL_BITS_SYS_CONFIG           (0x000007c0)    // Bits 6-10
721 #define IPW_AUX_HOST_GP_CNTRL_BIT_BUS_TYPE              (0x00000200)    // Bit 9
722 #define IPW_AUX_HOST_GP_CNTRL_BIT_BAR0_BLOCK_SIZE       (0x00000400)    // Bit 10
723 #define IPW_AUX_HOST_GP_CNTRL_BIT_USB_MODE              (0x20000000)    // Bit 29
724 #define IPW_AUX_HOST_GP_CNTRL_BIT_HOST_FORCES_SYS_CLK   (0x40000000)    // Bit 30
725 #define IPW_AUX_HOST_GP_CNTRL_BIT_FW_FORCES_SYS_CLK     (0x80000000)    // Bit 31 (MSB)
726
727 #define IPW_BIT_GPIO_GPIO1_MASK         0x0000000C
728 #define IPW_BIT_GPIO_GPIO3_MASK         0x000000C0
729 #define IPW_BIT_GPIO_GPIO1_ENABLE       0x00000008
730 #define IPW_BIT_GPIO_RF_KILL            0x00010000
731
732 #define IPW_BIT_GPIO_LED_OFF            0x00002000      // Bit 13 = 1
733
734 #define IPW_REG_DOMAIN_0_OFFSET         0x0000
735 #define IPW_REG_DOMAIN_1_OFFSET         IPW_MEM_SRAM_HOST_SHARED_LOWER_BOUND
736
737 #define IPW_REG_INTA                    IPW_REG_DOMAIN_0_OFFSET + 0x0008
738 #define IPW_REG_INTA_MASK               IPW_REG_DOMAIN_0_OFFSET + 0x000C
739 #define IPW_REG_INDIRECT_ACCESS_ADDRESS IPW_REG_DOMAIN_0_OFFSET + 0x0010
740 #define IPW_REG_INDIRECT_ACCESS_DATA    IPW_REG_DOMAIN_0_OFFSET + 0x0014
741 #define IPW_REG_AUTOINCREMENT_ADDRESS   IPW_REG_DOMAIN_0_OFFSET + 0x0018
742 #define IPW_REG_AUTOINCREMENT_DATA      IPW_REG_DOMAIN_0_OFFSET + 0x001C
743 #define IPW_REG_RESET_REG               IPW_REG_DOMAIN_0_OFFSET + 0x0020
744 #define IPW_REG_GP_CNTRL                IPW_REG_DOMAIN_0_OFFSET + 0x0024
745 #define IPW_REG_GPIO                    IPW_REG_DOMAIN_0_OFFSET + 0x0030
746 #define IPW_REG_FW_TYPE                 IPW_REG_DOMAIN_1_OFFSET + 0x0188
747 #define IPW_REG_FW_VERSION              IPW_REG_DOMAIN_1_OFFSET + 0x018C
748 #define IPW_REG_FW_COMPATABILITY_VERSION IPW_REG_DOMAIN_1_OFFSET + 0x0190
749
750 #define IPW_REG_INDIRECT_ADDR_MASK      0x00FFFFFC
751
752 #define IPW_INTERRUPT_MASK              0xC1010013
753
754 #define IPW2100_CONTROL_REG             0x220000
755 #define IPW2100_CONTROL_PHY_OFF         0x8
756
757 #define IPW2100_COMMAND                 0x00300004
758 #define IPW2100_COMMAND_PHY_ON          0x0
759 #define IPW2100_COMMAND_PHY_OFF         0x1
760
761 /* in DEBUG_AREA, values of memory always 0xd55555d5 */
762 #define IPW_REG_DOA_DEBUG_AREA_START    IPW_REG_DOMAIN_0_OFFSET + 0x0090
763 #define IPW_REG_DOA_DEBUG_AREA_END      IPW_REG_DOMAIN_0_OFFSET + 0x00FF
764 #define IPW_DATA_DOA_DEBUG_VALUE        0xd55555d5
765
766 #define IPW_INTERNAL_REGISTER_HALT_AND_RESET    0x003000e0
767
768 #define IPW_WAIT_CLOCK_STABILIZATION_DELAY          50  // micro seconds
769 #define IPW_WAIT_RESET_ARC_COMPLETE_DELAY           10  // micro seconds
770 #define IPW_WAIT_RESET_MASTER_ASSERT_COMPLETE_DELAY 10  // micro seconds
771
772 // BD ring queue read/write difference
773 #define IPW_BD_QUEUE_W_R_MIN_SPARE 2
774
775 #define IPW_CACHE_LINE_LENGTH_DEFAULT               0x80
776
777 #define IPW_CARD_DISABLE_PHY_OFF_COMPLETE_WAIT      100 // 100 milli
778 #define IPW_PREPARE_POWER_DOWN_COMPLETE_WAIT        100 // 100 milli
779
780 #define IPW_HEADER_802_11_SIZE           sizeof(struct ieee80211_hdr_3addr)
781 #define IPW_MAX_80211_PAYLOAD_SIZE              2304U
782 #define IPW_MAX_802_11_PAYLOAD_LENGTH           2312
783 #define IPW_MAX_ACCEPTABLE_TX_FRAME_LENGTH      1536
784 #define IPW_MIN_ACCEPTABLE_RX_FRAME_LENGTH      60
785 #define IPW_MAX_ACCEPTABLE_RX_FRAME_LENGTH \
786         (IPW_MAX_ACCEPTABLE_TX_FRAME_LENGTH + IPW_HEADER_802_11_SIZE - \
787         sizeof(struct ethhdr))
788
789 #define IPW_802_11_FCS_LENGTH 4
790 #define IPW_RX_NIC_BUFFER_LENGTH \
791         (IPW_MAX_802_11_PAYLOAD_LENGTH + IPW_HEADER_802_11_SIZE + \
792                 IPW_802_11_FCS_LENGTH)
793
794 #define IPW_802_11_PAYLOAD_OFFSET \
795         (sizeof(struct ieee80211_hdr_3addr) + \
796          sizeof(struct ieee80211_snap_hdr))
797
798 struct ipw2100_rx {
799         union {
800                 unsigned char payload[IPW_RX_NIC_BUFFER_LENGTH];
801                 struct ieee80211_hdr_4addr header;
802                 u32 status;
803                 struct ipw2100_notification notification;
804                 struct ipw2100_cmd_header command;
805         } rx_data;
806 } __attribute__ ((packed));
807
808 /* Bit 0-7 are for 802.11b tx rates - .  Bit 5-7 are reserved */
809 #define TX_RATE_1_MBIT              0x0001
810 #define TX_RATE_2_MBIT              0x0002
811 #define TX_RATE_5_5_MBIT            0x0004
812 #define TX_RATE_11_MBIT             0x0008
813 #define TX_RATE_MASK                0x000F
814 #define DEFAULT_TX_RATES            0x000F
815
816 #define IPW_POWER_MODE_CAM           0x00       //(always on)
817 #define IPW_POWER_INDEX_1            0x01
818 #define IPW_POWER_INDEX_2            0x02
819 #define IPW_POWER_INDEX_3            0x03
820 #define IPW_POWER_INDEX_4            0x04
821 #define IPW_POWER_INDEX_5            0x05
822 #define IPW_POWER_AUTO               0x06
823 #define IPW_POWER_MASK               0x0F
824 #define IPW_POWER_ENABLED            0x10
825 #define IPW_POWER_LEVEL(x)           ((x) & IPW_POWER_MASK)
826
827 #define IPW_TX_POWER_AUTO            0
828 #define IPW_TX_POWER_ENHANCED        1
829
830 #define IPW_TX_POWER_DEFAULT         32
831 #define IPW_TX_POWER_MIN             0
832 #define IPW_TX_POWER_MAX             16
833 #define IPW_TX_POWER_MIN_DBM         (-12)
834 #define IPW_TX_POWER_MAX_DBM         16
835
836 #define FW_SCAN_DONOT_ASSOCIATE     0x0001      // Dont Attempt to Associate after Scan
837 #define FW_SCAN_PASSIVE             0x0008      // Force PASSSIVE Scan
838
839 #define REG_MIN_CHANNEL             0
840 #define REG_MAX_CHANNEL             14
841
842 #define REG_CHANNEL_MASK            0x00003FFF
843 #define IPW_IBSS_11B_DEFAULT_MASK   0x87ff
844
845 #define DIVERSITY_EITHER            0   // Use both antennas
846 #define DIVERSITY_ANTENNA_A         1   // Use antenna A
847 #define DIVERSITY_ANTENNA_B         2   // Use antenna B
848
849 #define HOST_COMMAND_WAIT 0
850 #define HOST_COMMAND_NO_WAIT 1
851
852 #define LOCK_NONE 0
853 #define LOCK_DRIVER 1
854 #define LOCK_FW 2
855
856 #define TYPE_SWEEP_ORD                  0x000D
857 #define TYPE_IBSS_STTN_ORD              0x000E
858 #define TYPE_BSS_AP_ORD                 0x000F
859 #define TYPE_RAW_BEACON_ENTRY           0x0010
860 #define TYPE_CALIBRATION_DATA           0x0011
861 #define TYPE_ROGUE_AP_DATA              0x0012
862 #define TYPE_ASSOCIATION_REQUEST        0x0013
863 #define TYPE_REASSOCIATION_REQUEST      0x0014
864
865 #define HW_FEATURE_RFKILL 0x0001
866 #define RF_KILLSWITCH_OFF 1
867 #define RF_KILLSWITCH_ON  0
868
869 #define IPW_COMMAND_POOL_SIZE        40
870
871 #define IPW_START_ORD_TAB_1                     1
872 #define IPW_START_ORD_TAB_2                     1000
873
874 #define IPW_ORD_TAB_1_ENTRY_SIZE                sizeof(u32)
875
876 #define IS_ORDINAL_TABLE_ONE(mgr,id) \
877     ((id >= IPW_START_ORD_TAB_1) && (id < mgr->table1_size))
878 #define IS_ORDINAL_TABLE_TWO(mgr,id) \
879     ((id >= IPW_START_ORD_TAB_2) && (id < (mgr->table2_size + IPW_START_ORD_TAB_2)))
880
881 #define BSS_ID_LENGTH               6
882
883 // Fixed size data: Ordinal Table 1
884 typedef enum _ORDINAL_TABLE_1 { // NS - means Not Supported by FW
885 // Transmit statistics
886         IPW_ORD_STAT_TX_HOST_REQUESTS = 1,      // # of requested Host Tx's (MSDU)
887         IPW_ORD_STAT_TX_HOST_COMPLETE,  // # of successful Host Tx's (MSDU)
888         IPW_ORD_STAT_TX_DIR_DATA,       // # of successful Directed Tx's (MSDU)
889
890         IPW_ORD_STAT_TX_DIR_DATA1 = 4,  // # of successful Directed Tx's (MSDU) @ 1MB
891         IPW_ORD_STAT_TX_DIR_DATA2,      // # of successful Directed Tx's (MSDU) @ 2MB
892         IPW_ORD_STAT_TX_DIR_DATA5_5,    // # of successful Directed Tx's (MSDU) @ 5_5MB
893         IPW_ORD_STAT_TX_DIR_DATA11,     // # of successful Directed Tx's (MSDU) @ 11MB
894         IPW_ORD_STAT_TX_DIR_DATA22,     // # of successful Directed Tx's (MSDU) @ 22MB
895
896         IPW_ORD_STAT_TX_NODIR_DATA1 = 13,       // # of successful Non_Directed Tx's (MSDU) @ 1MB
897         IPW_ORD_STAT_TX_NODIR_DATA2,    // # of successful Non_Directed Tx's (MSDU) @ 2MB
898         IPW_ORD_STAT_TX_NODIR_DATA5_5,  // # of successful Non_Directed Tx's (MSDU) @ 5.5MB
899         IPW_ORD_STAT_TX_NODIR_DATA11,   // # of successful Non_Directed Tx's (MSDU) @ 11MB
900
901         IPW_ORD_STAT_NULL_DATA = 21,    // # of successful NULL data Tx's
902         IPW_ORD_STAT_TX_RTS,    // # of successful Tx RTS
903         IPW_ORD_STAT_TX_CTS,    // # of successful Tx CTS
904         IPW_ORD_STAT_TX_ACK,    // # of successful Tx ACK
905         IPW_ORD_STAT_TX_ASSN,   // # of successful Association Tx's
906         IPW_ORD_STAT_TX_ASSN_RESP,      // # of successful Association response Tx's
907         IPW_ORD_STAT_TX_REASSN, // # of successful Reassociation Tx's
908         IPW_ORD_STAT_TX_REASSN_RESP,    // # of successful Reassociation response Tx's
909         IPW_ORD_STAT_TX_PROBE,  // # of probes successfully transmitted
910         IPW_ORD_STAT_TX_PROBE_RESP,     // # of probe responses successfully transmitted
911         IPW_ORD_STAT_TX_BEACON, // # of tx beacon
912         IPW_ORD_STAT_TX_ATIM,   // # of Tx ATIM
913         IPW_ORD_STAT_TX_DISASSN,        // # of successful Disassociation TX
914         IPW_ORD_STAT_TX_AUTH,   // # of successful Authentication Tx
915         IPW_ORD_STAT_TX_DEAUTH, // # of successful Deauthentication TX
916
917         IPW_ORD_STAT_TX_TOTAL_BYTES = 41,       // Total successful Tx data bytes
918         IPW_ORD_STAT_TX_RETRIES,        // # of Tx retries
919         IPW_ORD_STAT_TX_RETRY1, // # of Tx retries at 1MBPS
920         IPW_ORD_STAT_TX_RETRY2, // # of Tx retries at 2MBPS
921         IPW_ORD_STAT_TX_RETRY5_5,       // # of Tx retries at 5.5MBPS
922         IPW_ORD_STAT_TX_RETRY11,        // # of Tx retries at 11MBPS
923
924         IPW_ORD_STAT_TX_FAILURES = 51,  // # of Tx Failures
925         IPW_ORD_STAT_TX_ABORT_AT_HOP,   //NS // # of Tx's aborted at hop time
926         IPW_ORD_STAT_TX_MAX_TRIES_IN_HOP,       // # of times max tries in a hop failed
927         IPW_ORD_STAT_TX_ABORT_LATE_DMA, //NS // # of times tx aborted due to late dma setup
928         IPW_ORD_STAT_TX_ABORT_STX,      //NS // # of times backoff aborted
929         IPW_ORD_STAT_TX_DISASSN_FAIL,   // # of times disassociation failed
930         IPW_ORD_STAT_TX_ERR_CTS,        // # of missed/bad CTS frames
931         IPW_ORD_STAT_TX_BPDU,   //NS // # of spanning tree BPDUs sent
932         IPW_ORD_STAT_TX_ERR_ACK,        // # of tx err due to acks
933
934         // Receive statistics
935         IPW_ORD_STAT_RX_HOST = 61,      // # of packets passed to host
936         IPW_ORD_STAT_RX_DIR_DATA,       // # of directed packets
937         IPW_ORD_STAT_RX_DIR_DATA1,      // # of directed packets at 1MB
938         IPW_ORD_STAT_RX_DIR_DATA2,      // # of directed packets at 2MB
939         IPW_ORD_STAT_RX_DIR_DATA5_5,    // # of directed packets at 5.5MB
940         IPW_ORD_STAT_RX_DIR_DATA11,     // # of directed packets at 11MB
941         IPW_ORD_STAT_RX_DIR_DATA22,     // # of directed packets at 22MB
942
943         IPW_ORD_STAT_RX_NODIR_DATA = 71,        // # of nondirected packets
944         IPW_ORD_STAT_RX_NODIR_DATA1,    // # of nondirected packets at 1MB
945         IPW_ORD_STAT_RX_NODIR_DATA2,    // # of nondirected packets at 2MB
946         IPW_ORD_STAT_RX_NODIR_DATA5_5,  // # of nondirected packets at 5.5MB
947         IPW_ORD_STAT_RX_NODIR_DATA11,   // # of nondirected packets at 11MB
948
949         IPW_ORD_STAT_RX_NULL_DATA = 80, // # of null data rx's
950         IPW_ORD_STAT_RX_POLL,   //NS // # of poll rx
951         IPW_ORD_STAT_RX_RTS,    // # of Rx RTS
952         IPW_ORD_STAT_RX_CTS,    // # of Rx CTS
953         IPW_ORD_STAT_RX_ACK,    // # of Rx ACK
954         IPW_ORD_STAT_RX_CFEND,  // # of Rx CF End
955         IPW_ORD_STAT_RX_CFEND_ACK,      // # of Rx CF End + CF Ack
956         IPW_ORD_STAT_RX_ASSN,   // # of Association Rx's
957         IPW_ORD_STAT_RX_ASSN_RESP,      // # of Association response Rx's
958         IPW_ORD_STAT_RX_REASSN, // # of Reassociation Rx's
959         IPW_ORD_STAT_RX_REASSN_RESP,    // # of Reassociation response Rx's
960         IPW_ORD_STAT_RX_PROBE,  // # of probe Rx's
961         IPW_ORD_STAT_RX_PROBE_RESP,     // # of probe response Rx's
962         IPW_ORD_STAT_RX_BEACON, // # of Rx beacon
963         IPW_ORD_STAT_RX_ATIM,   // # of Rx ATIM
964         IPW_ORD_STAT_RX_DISASSN,        // # of disassociation Rx
965         IPW_ORD_STAT_RX_AUTH,   // # of authentication Rx
966         IPW_ORD_STAT_RX_DEAUTH, // # of deauthentication Rx
967
968         IPW_ORD_STAT_RX_TOTAL_BYTES = 101,      // Total rx data bytes received
969         IPW_ORD_STAT_RX_ERR_CRC,        // # of packets with Rx CRC error
970         IPW_ORD_STAT_RX_ERR_CRC1,       // # of Rx CRC errors at 1MB
971         IPW_ORD_STAT_RX_ERR_CRC2,       // # of Rx CRC errors at 2MB
972         IPW_ORD_STAT_RX_ERR_CRC5_5,     // # of Rx CRC errors at 5.5MB
973         IPW_ORD_STAT_RX_ERR_CRC11,      // # of Rx CRC errors at 11MB
974
975         IPW_ORD_STAT_RX_DUPLICATE1 = 112,       // # of duplicate rx packets at 1MB
976         IPW_ORD_STAT_RX_DUPLICATE2,     // # of duplicate rx packets at 2MB
977         IPW_ORD_STAT_RX_DUPLICATE5_5,   // # of duplicate rx packets at 5.5MB
978         IPW_ORD_STAT_RX_DUPLICATE11,    // # of duplicate rx packets at 11MB
979         IPW_ORD_STAT_RX_DUPLICATE = 119,        // # of duplicate rx packets
980
981         IPW_ORD_PERS_DB_LOCK = 120,     // # locking fw permanent  db
982         IPW_ORD_PERS_DB_SIZE,   // # size of fw permanent  db
983         IPW_ORD_PERS_DB_ADDR,   // # address of fw permanent  db
984         IPW_ORD_STAT_RX_INVALID_PROTOCOL,       // # of rx frames with invalid protocol
985         IPW_ORD_SYS_BOOT_TIME,  // # Boot time
986         IPW_ORD_STAT_RX_NO_BUFFER,      // # of rx frames rejected due to no buffer
987         IPW_ORD_STAT_RX_ABORT_LATE_DMA, //NS // # of rx frames rejected due to dma setup too late
988         IPW_ORD_STAT_RX_ABORT_AT_HOP,   //NS // # of rx frames aborted due to hop
989         IPW_ORD_STAT_RX_MISSING_FRAG,   // # of rx frames dropped due to missing fragment
990         IPW_ORD_STAT_RX_ORPHAN_FRAG,    // # of rx frames dropped due to non-sequential fragment
991         IPW_ORD_STAT_RX_ORPHAN_FRAME,   // # of rx frames dropped due to unmatched 1st frame
992         IPW_ORD_STAT_RX_FRAG_AGEOUT,    // # of rx frames dropped due to uncompleted frame
993         IPW_ORD_STAT_RX_BAD_SSID,       //NS // Bad SSID (unused)
994         IPW_ORD_STAT_RX_ICV_ERRORS,     // # of ICV errors during decryption
995
996 // PSP Statistics
997         IPW_ORD_STAT_PSP_SUSPENSION = 137,      // # of times adapter suspended
998         IPW_ORD_STAT_PSP_BCN_TIMEOUT,   // # of beacon timeout
999         IPW_ORD_STAT_PSP_POLL_TIMEOUT,  // # of poll response timeouts
1000         IPW_ORD_STAT_PSP_NONDIR_TIMEOUT,        // # of timeouts waiting for last broadcast/muticast pkt
1001         IPW_ORD_STAT_PSP_RX_DTIMS,      // # of PSP DTIMs received
1002         IPW_ORD_STAT_PSP_RX_TIMS,       // # of PSP TIMs received
1003         IPW_ORD_STAT_PSP_STATION_ID,    // PSP Station ID
1004
1005 // Association and roaming
1006         IPW_ORD_LAST_ASSN_TIME = 147,   // RTC time of last association
1007         IPW_ORD_STAT_PERCENT_MISSED_BCNS,       // current calculation of % missed beacons
1008         IPW_ORD_STAT_PERCENT_RETRIES,   // current calculation of % missed tx retries
1009         IPW_ORD_ASSOCIATED_AP_PTR,      // If associated, this is ptr to the associated
1010         // AP table entry. set to 0 if not associated
1011         IPW_ORD_AVAILABLE_AP_CNT,       // # of AP's decsribed in the AP table
1012         IPW_ORD_AP_LIST_PTR,    // Ptr to list of available APs
1013         IPW_ORD_STAT_AP_ASSNS,  // # of associations
1014         IPW_ORD_STAT_ASSN_FAIL, // # of association failures
1015         IPW_ORD_STAT_ASSN_RESP_FAIL,    // # of failuresdue to response fail
1016         IPW_ORD_STAT_FULL_SCANS,        // # of full scans
1017
1018         IPW_ORD_CARD_DISABLED,  // # Card Disabled
1019         IPW_ORD_STAT_ROAM_INHIBIT,      // # of times roaming was inhibited due to ongoing activity
1020         IPW_FILLER_40,
1021         IPW_ORD_RSSI_AT_ASSN = 160,     // RSSI of associated AP at time of association
1022         IPW_ORD_STAT_ASSN_CAUSE1,       // # of reassociations due to no tx from AP in last N
1023         // hops or no prob_ responses in last 3 minutes
1024         IPW_ORD_STAT_ASSN_CAUSE2,       // # of reassociations due to poor tx/rx quality
1025         IPW_ORD_STAT_ASSN_CAUSE3,       // # of reassociations due to tx/rx quality with excessive
1026         // load at the AP
1027         IPW_ORD_STAT_ASSN_CAUSE4,       // # of reassociations due to AP RSSI level fell below
1028         // eligible group
1029         IPW_ORD_STAT_ASSN_CAUSE5,       // # of reassociations due to load leveling
1030         IPW_ORD_STAT_ASSN_CAUSE6,       //NS // # of reassociations due to dropped by Ap
1031         IPW_FILLER_41,
1032         IPW_FILLER_42,
1033         IPW_FILLER_43,
1034         IPW_ORD_STAT_AUTH_FAIL, // # of times authentication failed
1035         IPW_ORD_STAT_AUTH_RESP_FAIL,    // # of times authentication response failed
1036         IPW_ORD_STATION_TABLE_CNT,      // # of entries in association table
1037
1038 // Other statistics
1039         IPW_ORD_RSSI_AVG_CURR = 173,    // Current avg RSSI
1040         IPW_ORD_STEST_RESULTS_CURR,     //NS // Current self test results word
1041         IPW_ORD_STEST_RESULTS_CUM,      //NS // Cummulative self test results word
1042         IPW_ORD_SELF_TEST_STATUS,       //NS //
1043         IPW_ORD_POWER_MGMT_MODE,        // Power mode - 0=CAM, 1=PSP
1044         IPW_ORD_POWER_MGMT_INDEX,       //NS //
1045         IPW_ORD_COUNTRY_CODE,   // IEEE country code as recv'd from beacon
1046         IPW_ORD_COUNTRY_CHANNELS,       // channels suported by country
1047 // IPW_ORD_COUNTRY_CHANNELS:
1048 // For 11b the lower 2-byte are used for channels from 1-14
1049 //   and the higher 2-byte are not used.
1050         IPW_ORD_RESET_CNT,      // # of adapter resets (warm)
1051         IPW_ORD_BEACON_INTERVAL,        // Beacon interval
1052
1053         IPW_ORD_PRINCETON_VERSION = 184,        //NS // Princeton Version
1054         IPW_ORD_ANTENNA_DIVERSITY,      // TRUE if antenna diversity is disabled
1055         IPW_ORD_CCA_RSSI,       //NS // CCA RSSI value (factory programmed)
1056         IPW_ORD_STAT_EEPROM_UPDATE,     //NS // # of times config EEPROM updated
1057         IPW_ORD_DTIM_PERIOD,    // # of beacon intervals between DTIMs
1058         IPW_ORD_OUR_FREQ,       // current radio freq lower digits - channel ID
1059
1060         IPW_ORD_RTC_TIME = 190, // current RTC time
1061         IPW_ORD_PORT_TYPE,      // operating mode
1062         IPW_ORD_CURRENT_TX_RATE,        // current tx rate
1063         IPW_ORD_SUPPORTED_RATES,        // Bitmap of supported tx rates
1064         IPW_ORD_ATIM_WINDOW,    // current ATIM Window
1065         IPW_ORD_BASIC_RATES,    // bitmap of basic tx rates
1066         IPW_ORD_NIC_HIGHEST_RATE,       // bitmap of basic tx rates
1067         IPW_ORD_AP_HIGHEST_RATE,        // bitmap of basic tx rates
1068         IPW_ORD_CAPABILITIES,   // Management frame capability field
1069         IPW_ORD_AUTH_TYPE,      // Type of authentication
1070         IPW_ORD_RADIO_TYPE,     // Adapter card platform type
1071         IPW_ORD_RTS_THRESHOLD = 201,    // Min length of packet after which RTS handshaking is used
1072         IPW_ORD_INT_MODE,       // International mode
1073         IPW_ORD_FRAGMENTATION_THRESHOLD,        // protocol frag threshold
1074         IPW_ORD_EEPROM_SRAM_DB_BLOCK_START_ADDRESS,     // EEPROM offset in SRAM
1075         IPW_ORD_EEPROM_SRAM_DB_BLOCK_SIZE,      // EEPROM size in SRAM
1076         IPW_ORD_EEPROM_SKU_CAPABILITY,  // EEPROM SKU Capability    206 =
1077         IPW_ORD_EEPROM_IBSS_11B_CHANNELS,       // EEPROM IBSS 11b channel set
1078
1079         IPW_ORD_MAC_VERSION = 209,      // MAC Version
1080         IPW_ORD_MAC_REVISION,   // MAC Revision
1081         IPW_ORD_RADIO_VERSION,  // Radio Version
1082         IPW_ORD_NIC_MANF_DATE_TIME,     // MANF Date/Time STAMP
1083         IPW_ORD_UCODE_VERSION,  // Ucode Version
1084         IPW_ORD_HW_RF_SWITCH_STATE = 214,       // HW RF Kill Switch State
1085 } ORDINALTABLE1;
1086
1087 // ordinal table 2
1088 // Variable length data:
1089 #define IPW_FIRST_VARIABLE_LENGTH_ORDINAL   1001
1090
1091 typedef enum _ORDINAL_TABLE_2 { // NS - means Not Supported by FW
1092         IPW_ORD_STAT_BASE = 1000,       // contains number of variable ORDs
1093         IPW_ORD_STAT_ADAPTER_MAC = 1001,        // 6 bytes: our adapter MAC address
1094         IPW_ORD_STAT_PREFERRED_BSSID = 1002,    // 6 bytes: BSSID of the preferred AP
1095         IPW_ORD_STAT_MANDATORY_BSSID = 1003,    // 6 bytes: BSSID of the mandatory AP
1096         IPW_FILL_1,             //NS //
1097         IPW_ORD_STAT_COUNTRY_TEXT = 1005,       // 36 bytes: Country name text, First two bytes are Country code
1098         IPW_ORD_STAT_ASSN_SSID = 1006,  // 32 bytes: ESSID String
1099         IPW_ORD_STATION_TABLE = 1007,   // ? bytes: Station/AP table (via Direct SSID Scans)
1100         IPW_ORD_STAT_SWEEP_TABLE = 1008,        // ? bytes: Sweep/Host Table table (via Broadcast Scans)
1101         IPW_ORD_STAT_ROAM_LOG = 1009,   // ? bytes: Roaming log
1102         IPW_ORD_STAT_RATE_LOG = 1010,   //NS // 0 bytes: Rate log
1103         IPW_ORD_STAT_FIFO = 1011,       //NS // 0 bytes: Fifo buffer data structures
1104         IPW_ORD_STAT_FW_VER_NUM = 1012, // 14 bytes: fw version ID string as in (a.bb.ccc; "0.08.011")
1105         IPW_ORD_STAT_FW_DATE = 1013,    // 14 bytes: fw date string (mmm dd yyyy; "Mar 13 2002")
1106         IPW_ORD_STAT_ASSN_AP_BSSID = 1014,      // 6 bytes: MAC address of associated AP
1107         IPW_ORD_STAT_DEBUG = 1015,      //NS // ? bytes:
1108         IPW_ORD_STAT_NIC_BPA_NUM = 1016,        // 11 bytes: NIC BPA number in ASCII
1109         IPW_ORD_STAT_UCODE_DATE = 1017, // 5 bytes: uCode date
1110         IPW_ORD_SECURITY_NGOTIATION_RESULT = 1018,
1111 } ORDINALTABLE2;                // NS - means Not Supported by FW
1112
1113 #define IPW_LAST_VARIABLE_LENGTH_ORDINAL   1018
1114
1115 #ifndef WIRELESS_SPY
1116 #define WIRELESS_SPY            // enable iwspy support
1117 #endif
1118
1119 #define IPW_HOST_FW_SHARED_AREA0        0x0002f200
1120 #define IPW_HOST_FW_SHARED_AREA0_END    0x0002f510      // 0x310 bytes
1121
1122 #define IPW_HOST_FW_SHARED_AREA1        0x0002f610
1123 #define IPW_HOST_FW_SHARED_AREA1_END    0x0002f630      // 0x20 bytes
1124
1125 #define IPW_HOST_FW_SHARED_AREA2        0x0002fa00
1126 #define IPW_HOST_FW_SHARED_AREA2_END    0x0002fa20      // 0x20 bytes
1127
1128 #define IPW_HOST_FW_SHARED_AREA3        0x0002fc00
1129 #define IPW_HOST_FW_SHARED_AREA3_END    0x0002fc10      // 0x10 bytes
1130
1131 #define IPW_HOST_FW_INTERRUPT_AREA      0x0002ff80
1132 #define IPW_HOST_FW_INTERRUPT_AREA_END  0x00030000      // 0x80 bytes
1133
1134 struct ipw2100_fw_chunk {
1135         unsigned char *buf;
1136         long len;
1137         long pos;
1138         struct list_head list;
1139 };
1140
1141 struct ipw2100_fw_chunk_set {
1142         const void *data;
1143         unsigned long size;
1144 };
1145
1146 struct ipw2100_fw {
1147         int version;
1148         struct ipw2100_fw_chunk_set fw;
1149         struct ipw2100_fw_chunk_set uc;
1150         const struct firmware *fw_entry;
1151 };
1152
1153 #define MAX_FW_VERSION_LEN 14
1154
1155 #endif                          /* _IPW2100_H */