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