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