drivers/net/wireless/ipw2200.h

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