drivers/net/wireless/ipw2100.h

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