Back to home page

OSCL-LXR

 
 

    


0001 /* SPDX-License-Identifier: GPL-2.0-only */
0002 /******************************************************************************
0003 
0004   Copyright(c) 2003 - 2006 Intel Corporation. All rights reserved.
0005 
0006 
0007   Contact Information:
0008   Intel Linux Wireless <ilw@linux.intel.com>
0009   Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
0010 
0011 ******************************************************************************/
0012 
0013 #ifndef __ipw2200_h__
0014 #define __ipw2200_h__
0015 
0016 #include <linux/module.h>
0017 #include <linux/moduleparam.h>
0018 #include <linux/interrupt.h>
0019 #include <linux/mutex.h>
0020 
0021 #include <linux/pci.h>
0022 #include <linux/netdevice.h>
0023 #include <linux/ethtool.h>
0024 #include <linux/skbuff.h>
0025 #include <linux/etherdevice.h>
0026 #include <linux/delay.h>
0027 #include <linux/random.h>
0028 #include <linux/dma-mapping.h>
0029 
0030 #include <linux/firmware.h>
0031 #include <linux/wireless.h>
0032 #include <linux/jiffies.h>
0033 #include <asm/io.h>
0034 
0035 #include <net/lib80211.h>
0036 #include <net/ieee80211_radiotap.h>
0037 
0038 #define DRV_NAME    "ipw2200"
0039 
0040 #include <linux/workqueue.h>
0041 
0042 #include "libipw.h"
0043 
0044 /* Authentication  and Association States */
0045 enum connection_manager_assoc_states {
0046     CMAS_INIT = 0,
0047     CMAS_TX_AUTH_SEQ_1,
0048     CMAS_RX_AUTH_SEQ_2,
0049     CMAS_AUTH_SEQ_1_PASS,
0050     CMAS_AUTH_SEQ_1_FAIL,
0051     CMAS_TX_AUTH_SEQ_3,
0052     CMAS_RX_AUTH_SEQ_4,
0053     CMAS_AUTH_SEQ_2_PASS,
0054     CMAS_AUTH_SEQ_2_FAIL,
0055     CMAS_AUTHENTICATED,
0056     CMAS_TX_ASSOC,
0057     CMAS_RX_ASSOC_RESP,
0058     CMAS_ASSOCIATED,
0059     CMAS_LAST
0060 };
0061 
0062 #define IPW_WAIT                     (1<<0)
0063 #define IPW_QUIET                    (1<<1)
0064 #define IPW_ROAMING                  (1<<2)
0065 
0066 #define IPW_POWER_MODE_CAM           0x00   //(always on)
0067 #define IPW_POWER_INDEX_1            0x01
0068 #define IPW_POWER_INDEX_2            0x02
0069 #define IPW_POWER_INDEX_3            0x03
0070 #define IPW_POWER_INDEX_4            0x04
0071 #define IPW_POWER_INDEX_5            0x05
0072 #define IPW_POWER_AC                 0x06
0073 #define IPW_POWER_BATTERY            0x07
0074 #define IPW_POWER_LIMIT              0x07
0075 #define IPW_POWER_MASK               0x0F
0076 #define IPW_POWER_ENABLED            0x10
0077 #define IPW_POWER_LEVEL(x)           ((x) & IPW_POWER_MASK)
0078 
0079 #define IPW_CMD_HOST_COMPLETE                 2
0080 #define IPW_CMD_POWER_DOWN                    4
0081 #define IPW_CMD_SYSTEM_CONFIG                 6
0082 #define IPW_CMD_MULTICAST_ADDRESS             7
0083 #define IPW_CMD_SSID                          8
0084 #define IPW_CMD_ADAPTER_ADDRESS              11
0085 #define IPW_CMD_PORT_TYPE                    12
0086 #define IPW_CMD_RTS_THRESHOLD                15
0087 #define IPW_CMD_FRAG_THRESHOLD               16
0088 #define IPW_CMD_POWER_MODE                   17
0089 #define IPW_CMD_WEP_KEY                      18
0090 #define IPW_CMD_TGI_TX_KEY                   19
0091 #define IPW_CMD_SCAN_REQUEST                 20
0092 #define IPW_CMD_ASSOCIATE                    21
0093 #define IPW_CMD_SUPPORTED_RATES              22
0094 #define IPW_CMD_SCAN_ABORT                   23
0095 #define IPW_CMD_TX_FLUSH                     24
0096 #define IPW_CMD_QOS_PARAMETERS               25
0097 #define IPW_CMD_SCAN_REQUEST_EXT             26
0098 #define IPW_CMD_DINO_CONFIG                  30
0099 #define IPW_CMD_RSN_CAPABILITIES             31
0100 #define IPW_CMD_RX_KEY                       32
0101 #define IPW_CMD_CARD_DISABLE                 33
0102 #define IPW_CMD_SEED_NUMBER                  34
0103 #define IPW_CMD_TX_POWER                     35
0104 #define IPW_CMD_COUNTRY_INFO                 36
0105 #define IPW_CMD_AIRONET_INFO                 37
0106 #define IPW_CMD_AP_TX_POWER                  38
0107 #define IPW_CMD_CCKM_INFO                    39
0108 #define IPW_CMD_CCX_VER_INFO                 40
0109 #define IPW_CMD_SET_CALIBRATION              41
0110 #define IPW_CMD_SENSITIVITY_CALIB            42
0111 #define IPW_CMD_RETRY_LIMIT                  51
0112 #define IPW_CMD_IPW_PRE_POWER_DOWN           58
0113 #define IPW_CMD_VAP_BEACON_TEMPLATE          60
0114 #define IPW_CMD_VAP_DTIM_PERIOD              61
0115 #define IPW_CMD_EXT_SUPPORTED_RATES          62
0116 #define IPW_CMD_VAP_LOCAL_TX_PWR_CONSTRAINT  63
0117 #define IPW_CMD_VAP_QUIET_INTERVALS          64
0118 #define IPW_CMD_VAP_CHANNEL_SWITCH           65
0119 #define IPW_CMD_VAP_MANDATORY_CHANNELS       66
0120 #define IPW_CMD_VAP_CELL_PWR_LIMIT           67
0121 #define IPW_CMD_VAP_CF_PARAM_SET             68
0122 #define IPW_CMD_VAP_SET_BEACONING_STATE      69
0123 #define IPW_CMD_MEASUREMENT                  80
0124 #define IPW_CMD_POWER_CAPABILITY             81
0125 #define IPW_CMD_SUPPORTED_CHANNELS           82
0126 #define IPW_CMD_TPC_REPORT                   83
0127 #define IPW_CMD_WME_INFO                     84
0128 #define IPW_CMD_PRODUCTION_COMMAND       85
0129 #define IPW_CMD_LINKSYS_EOU_INFO             90
0130 
0131 #define RFD_SIZE                              4
0132 #define NUM_TFD_CHUNKS                        6
0133 
0134 #define TX_QUEUE_SIZE                        32
0135 #define RX_QUEUE_SIZE                        32
0136 
0137 #define DINO_CMD_WEP_KEY                   0x08
0138 #define DINO_CMD_TX                        0x0B
0139 #define DCT_ANTENNA_A                      0x01
0140 #define DCT_ANTENNA_B                      0x02
0141 
0142 #define IPW_A_MODE                         0
0143 #define IPW_B_MODE                         1
0144 #define IPW_G_MODE                         2
0145 
0146 /*
0147  * TX Queue Flag Definitions
0148  */
0149 
0150 /* tx wep key definition */
0151 #define DCT_WEP_KEY_NOT_IMMIDIATE   0x00
0152 #define DCT_WEP_KEY_64Bit       0x40
0153 #define DCT_WEP_KEY_128Bit      0x80
0154 #define DCT_WEP_KEY_128bitIV        0xC0
0155 #define DCT_WEP_KEY_SIZE_MASK       0xC0
0156 
0157 #define DCT_WEP_KEY_INDEX_MASK      0x0F
0158 #define DCT_WEP_INDEX_USE_IMMEDIATE 0x20
0159 
0160 /* abort attempt if mgmt frame is rx'd */
0161 #define DCT_FLAG_ABORT_MGMT                0x01
0162 
0163 /* require CTS */
0164 #define DCT_FLAG_CTS_REQUIRED              0x02
0165 
0166 /* use short preamble */
0167 #define DCT_FLAG_LONG_PREAMBLE             0x00
0168 #define DCT_FLAG_SHORT_PREAMBLE            0x04
0169 
0170 /* RTS/CTS first */
0171 #define DCT_FLAG_RTS_REQD                  0x08
0172 
0173 /* dont calculate duration field */
0174 #define DCT_FLAG_DUR_SET                   0x10
0175 
0176 /* even if MAC WEP set (allows pre-encrypt) */
0177 #define DCT_FLAG_NO_WEP              0x20
0178 
0179 /* overwrite TSF field */
0180 #define DCT_FLAG_TSF_REQD                  0x40
0181 
0182 /* ACK rx is expected to follow */
0183 #define DCT_FLAG_ACK_REQD                  0x80
0184 
0185 /* TX flags extension */
0186 #define DCT_FLAG_EXT_MODE_CCK  0x01
0187 #define DCT_FLAG_EXT_MODE_OFDM 0x00
0188 
0189 #define DCT_FLAG_EXT_SECURITY_WEP     0x00
0190 #define DCT_FLAG_EXT_SECURITY_NO      DCT_FLAG_EXT_SECURITY_WEP
0191 #define DCT_FLAG_EXT_SECURITY_CKIP    0x04
0192 #define DCT_FLAG_EXT_SECURITY_CCM     0x08
0193 #define DCT_FLAG_EXT_SECURITY_TKIP    0x0C
0194 #define DCT_FLAG_EXT_SECURITY_MASK    0x0C
0195 
0196 #define DCT_FLAG_EXT_QOS_ENABLED      0x10
0197 
0198 #define DCT_FLAG_EXT_HC_NO_SIFS_PIFS  0x00
0199 #define DCT_FLAG_EXT_HC_SIFS          0x20
0200 #define DCT_FLAG_EXT_HC_PIFS          0x40
0201 
0202 #define TX_RX_TYPE_MASK                    0xFF
0203 #define TX_FRAME_TYPE                      0x00
0204 #define TX_HOST_COMMAND_TYPE               0x01
0205 #define RX_FRAME_TYPE                      0x09
0206 #define RX_HOST_NOTIFICATION_TYPE          0x03
0207 #define RX_HOST_CMD_RESPONSE_TYPE          0x04
0208 #define RX_TX_FRAME_RESPONSE_TYPE          0x05
0209 #define TFD_NEED_IRQ_MASK                  0x04
0210 
0211 #define HOST_CMD_DINO_CONFIG               30
0212 
0213 #define HOST_NOTIFICATION_STATUS_ASSOCIATED             10
0214 #define HOST_NOTIFICATION_STATUS_AUTHENTICATE           11
0215 #define HOST_NOTIFICATION_STATUS_SCAN_CHANNEL_RESULT    12
0216 #define HOST_NOTIFICATION_STATUS_SCAN_COMPLETED         13
0217 #define HOST_NOTIFICATION_STATUS_FRAG_LENGTH            14
0218 #define HOST_NOTIFICATION_STATUS_LINK_DETERIORATION     15
0219 #define HOST_NOTIFICATION_DINO_CONFIG_RESPONSE          16
0220 #define HOST_NOTIFICATION_STATUS_BEACON_STATE           17
0221 #define HOST_NOTIFICATION_STATUS_TGI_TX_KEY             18
0222 #define HOST_NOTIFICATION_TX_STATUS                     19
0223 #define HOST_NOTIFICATION_CALIB_KEEP_RESULTS            20
0224 #define HOST_NOTIFICATION_MEASUREMENT_STARTED           21
0225 #define HOST_NOTIFICATION_MEASUREMENT_ENDED             22
0226 #define HOST_NOTIFICATION_CHANNEL_SWITCHED              23
0227 #define HOST_NOTIFICATION_RX_DURING_QUIET_PERIOD        24
0228 #define HOST_NOTIFICATION_NOISE_STATS           25
0229 #define HOST_NOTIFICATION_S36_MEASUREMENT_ACCEPTED      30
0230 #define HOST_NOTIFICATION_S36_MEASUREMENT_REFUSED       31
0231 
0232 #define HOST_NOTIFICATION_STATUS_BEACON_MISSING         1
0233 #define IPW_MB_SCAN_CANCEL_THRESHOLD                    3
0234 #define IPW_MB_ROAMING_THRESHOLD_MIN                    1
0235 #define IPW_MB_ROAMING_THRESHOLD_DEFAULT                8
0236 #define IPW_MB_ROAMING_THRESHOLD_MAX                    30
0237 #define IPW_MB_DISASSOCIATE_THRESHOLD_DEFAULT           3*IPW_MB_ROAMING_THRESHOLD_DEFAULT
0238 #define IPW_REAL_RATE_RX_PACKET_THRESHOLD               300
0239 
0240 #define MACADRR_BYTE_LEN                     6
0241 
0242 #define DCR_TYPE_AP                       0x01
0243 #define DCR_TYPE_WLAP                     0x02
0244 #define DCR_TYPE_MU_ESS                   0x03
0245 #define DCR_TYPE_MU_IBSS                  0x04
0246 #define DCR_TYPE_MU_PIBSS                 0x05
0247 #define DCR_TYPE_SNIFFER                  0x06
0248 #define DCR_TYPE_MU_BSS        DCR_TYPE_MU_ESS
0249 
0250 /* QoS  definitions */
0251 
0252 #define CW_MIN_OFDM          15
0253 #define CW_MAX_OFDM          1023
0254 #define CW_MIN_CCK           31
0255 #define CW_MAX_CCK           1023
0256 
0257 #define QOS_TX0_CW_MIN_OFDM      cpu_to_le16(CW_MIN_OFDM)
0258 #define QOS_TX1_CW_MIN_OFDM      cpu_to_le16(CW_MIN_OFDM)
0259 #define QOS_TX2_CW_MIN_OFDM      cpu_to_le16((CW_MIN_OFDM + 1)/2 - 1)
0260 #define QOS_TX3_CW_MIN_OFDM      cpu_to_le16((CW_MIN_OFDM + 1)/4 - 1)
0261 
0262 #define QOS_TX0_CW_MIN_CCK       cpu_to_le16(CW_MIN_CCK)
0263 #define QOS_TX1_CW_MIN_CCK       cpu_to_le16(CW_MIN_CCK)
0264 #define QOS_TX2_CW_MIN_CCK       cpu_to_le16((CW_MIN_CCK + 1)/2 - 1)
0265 #define QOS_TX3_CW_MIN_CCK       cpu_to_le16((CW_MIN_CCK + 1)/4 - 1)
0266 
0267 #define QOS_TX0_CW_MAX_OFDM      cpu_to_le16(CW_MAX_OFDM)
0268 #define QOS_TX1_CW_MAX_OFDM      cpu_to_le16(CW_MAX_OFDM)
0269 #define QOS_TX2_CW_MAX_OFDM      cpu_to_le16(CW_MIN_OFDM)
0270 #define QOS_TX3_CW_MAX_OFDM      cpu_to_le16((CW_MIN_OFDM + 1)/2 - 1)
0271 
0272 #define QOS_TX0_CW_MAX_CCK       cpu_to_le16(CW_MAX_CCK)
0273 #define QOS_TX1_CW_MAX_CCK       cpu_to_le16(CW_MAX_CCK)
0274 #define QOS_TX2_CW_MAX_CCK       cpu_to_le16(CW_MIN_CCK)
0275 #define QOS_TX3_CW_MAX_CCK       cpu_to_le16((CW_MIN_CCK + 1)/2 - 1)
0276 
0277 #define QOS_TX0_AIFS            (3 - QOS_AIFSN_MIN_VALUE)
0278 #define QOS_TX1_AIFS            (7 - QOS_AIFSN_MIN_VALUE)
0279 #define QOS_TX2_AIFS            (2 - QOS_AIFSN_MIN_VALUE)
0280 #define QOS_TX3_AIFS            (2 - QOS_AIFSN_MIN_VALUE)
0281 
0282 #define QOS_TX0_ACM             0
0283 #define QOS_TX1_ACM             0
0284 #define QOS_TX2_ACM             0
0285 #define QOS_TX3_ACM             0
0286 
0287 #define QOS_TX0_TXOP_LIMIT_CCK          0
0288 #define QOS_TX1_TXOP_LIMIT_CCK          0
0289 #define QOS_TX2_TXOP_LIMIT_CCK          cpu_to_le16(6016)
0290 #define QOS_TX3_TXOP_LIMIT_CCK          cpu_to_le16(3264)
0291 
0292 #define QOS_TX0_TXOP_LIMIT_OFDM      0
0293 #define QOS_TX1_TXOP_LIMIT_OFDM      0
0294 #define QOS_TX2_TXOP_LIMIT_OFDM      cpu_to_le16(3008)
0295 #define QOS_TX3_TXOP_LIMIT_OFDM      cpu_to_le16(1504)
0296 
0297 #define DEF_TX0_CW_MIN_OFDM      cpu_to_le16(CW_MIN_OFDM)
0298 #define DEF_TX1_CW_MIN_OFDM      cpu_to_le16(CW_MIN_OFDM)
0299 #define DEF_TX2_CW_MIN_OFDM      cpu_to_le16(CW_MIN_OFDM)
0300 #define DEF_TX3_CW_MIN_OFDM      cpu_to_le16(CW_MIN_OFDM)
0301 
0302 #define DEF_TX0_CW_MIN_CCK       cpu_to_le16(CW_MIN_CCK)
0303 #define DEF_TX1_CW_MIN_CCK       cpu_to_le16(CW_MIN_CCK)
0304 #define DEF_TX2_CW_MIN_CCK       cpu_to_le16(CW_MIN_CCK)
0305 #define DEF_TX3_CW_MIN_CCK       cpu_to_le16(CW_MIN_CCK)
0306 
0307 #define DEF_TX0_CW_MAX_OFDM      cpu_to_le16(CW_MAX_OFDM)
0308 #define DEF_TX1_CW_MAX_OFDM      cpu_to_le16(CW_MAX_OFDM)
0309 #define DEF_TX2_CW_MAX_OFDM      cpu_to_le16(CW_MAX_OFDM)
0310 #define DEF_TX3_CW_MAX_OFDM      cpu_to_le16(CW_MAX_OFDM)
0311 
0312 #define DEF_TX0_CW_MAX_CCK       cpu_to_le16(CW_MAX_CCK)
0313 #define DEF_TX1_CW_MAX_CCK       cpu_to_le16(CW_MAX_CCK)
0314 #define DEF_TX2_CW_MAX_CCK       cpu_to_le16(CW_MAX_CCK)
0315 #define DEF_TX3_CW_MAX_CCK       cpu_to_le16(CW_MAX_CCK)
0316 
0317 #define DEF_TX0_AIFS            0
0318 #define DEF_TX1_AIFS            0
0319 #define DEF_TX2_AIFS            0
0320 #define DEF_TX3_AIFS            0
0321 
0322 #define DEF_TX0_ACM             0
0323 #define DEF_TX1_ACM             0
0324 #define DEF_TX2_ACM             0
0325 #define DEF_TX3_ACM             0
0326 
0327 #define DEF_TX0_TXOP_LIMIT_CCK        0
0328 #define DEF_TX1_TXOP_LIMIT_CCK        0
0329 #define DEF_TX2_TXOP_LIMIT_CCK        0
0330 #define DEF_TX3_TXOP_LIMIT_CCK        0
0331 
0332 #define DEF_TX0_TXOP_LIMIT_OFDM       0
0333 #define DEF_TX1_TXOP_LIMIT_OFDM       0
0334 #define DEF_TX2_TXOP_LIMIT_OFDM       0
0335 #define DEF_TX3_TXOP_LIMIT_OFDM       0
0336 
0337 #define QOS_QOS_SETS                  3
0338 #define QOS_PARAM_SET_ACTIVE          0
0339 #define QOS_PARAM_SET_DEF_CCK         1
0340 #define QOS_PARAM_SET_DEF_OFDM        2
0341 
0342 #define CTRL_QOS_NO_ACK               (0x0020)
0343 
0344 #define IPW_TX_QUEUE_1        1
0345 #define IPW_TX_QUEUE_2        2
0346 #define IPW_TX_QUEUE_3        3
0347 #define IPW_TX_QUEUE_4        4
0348 
0349 /* QoS sturctures */
0350 struct ipw_qos_info {
0351     int qos_enable;
0352     struct libipw_qos_parameters *def_qos_parm_OFDM;
0353     struct libipw_qos_parameters *def_qos_parm_CCK;
0354     u32 burst_duration_CCK;
0355     u32 burst_duration_OFDM;
0356     u16 qos_no_ack_mask;
0357     int burst_enable;
0358 };
0359 
0360 /**************************************************************/
0361 /**
0362  * Generic queue structure
0363  *
0364  * Contains common data for Rx and Tx queues
0365  */
0366 struct clx2_queue {
0367     int n_bd;              /**< number of BDs in this queue */
0368     int first_empty;           /**< 1-st empty entry (index) */
0369     int last_used;             /**< last used entry (index) */
0370     u32 reg_w;           /**< 'write' reg (queue head), addr in domain 1 */
0371     u32 reg_r;           /**< 'read' reg (queue tail), addr in domain 1 */
0372     dma_addr_t dma_addr;        /**< physical addr for BD's */
0373     int low_mark;              /**< low watermark, resume queue if free space more than this */
0374     int high_mark;             /**< high watermark, stop queue if free space less than this */
0375 } __packed; /* XXX */
0376 
0377 struct machdr32 {
0378     __le16 frame_ctl;
0379     __le16 duration;        // watch out for endians!
0380     u8 addr1[MACADRR_BYTE_LEN];
0381     u8 addr2[MACADRR_BYTE_LEN];
0382     u8 addr3[MACADRR_BYTE_LEN];
0383     __le16 seq_ctrl;        // more endians!
0384     u8 addr4[MACADRR_BYTE_LEN];
0385     __le16 qos_ctrl;
0386 } __packed;
0387 
0388 struct machdr30 {
0389     __le16 frame_ctl;
0390     __le16 duration;        // watch out for endians!
0391     u8 addr1[MACADRR_BYTE_LEN];
0392     u8 addr2[MACADRR_BYTE_LEN];
0393     u8 addr3[MACADRR_BYTE_LEN];
0394     __le16 seq_ctrl;        // more endians!
0395     u8 addr4[MACADRR_BYTE_LEN];
0396 } __packed;
0397 
0398 struct machdr26 {
0399     __le16 frame_ctl;
0400     __le16 duration;        // watch out for endians!
0401     u8 addr1[MACADRR_BYTE_LEN];
0402     u8 addr2[MACADRR_BYTE_LEN];
0403     u8 addr3[MACADRR_BYTE_LEN];
0404     __le16 seq_ctrl;        // more endians!
0405     __le16 qos_ctrl;
0406 } __packed;
0407 
0408 struct machdr24 {
0409     __le16 frame_ctl;
0410     __le16 duration;        // watch out for endians!
0411     u8 addr1[MACADRR_BYTE_LEN];
0412     u8 addr2[MACADRR_BYTE_LEN];
0413     u8 addr3[MACADRR_BYTE_LEN];
0414     __le16 seq_ctrl;        // more endians!
0415 } __packed;
0416 
0417 // TX TFD with 32 byte MAC Header
0418 struct tx_tfd_32 {
0419     struct machdr32 mchdr;  // 32
0420     __le32 uivplaceholder[2];   // 8
0421 } __packed;
0422 
0423 // TX TFD with 30 byte MAC Header
0424 struct tx_tfd_30 {
0425     struct machdr30 mchdr;  // 30
0426     u8 reserved[2];     // 2
0427     __le32 uivplaceholder[2];   // 8
0428 } __packed;
0429 
0430 // tx tfd with 26 byte mac header
0431 struct tx_tfd_26 {
0432     struct machdr26 mchdr;  // 26
0433     u8 reserved1[2];    // 2
0434     __le32 uivplaceholder[2];   // 8
0435     u8 reserved2[4];    // 4
0436 } __packed;
0437 
0438 // tx tfd with 24 byte mac header
0439 struct tx_tfd_24 {
0440     struct machdr24 mchdr;  // 24
0441     __le32 uivplaceholder[2];   // 8
0442     u8 reserved[8];     // 8
0443 } __packed;
0444 
0445 #define DCT_WEP_KEY_FIELD_LENGTH 16
0446 
0447 struct tfd_command {
0448     u8 index;
0449     u8 length;
0450     __le16 reserved;
0451     u8 payload[];
0452 } __packed;
0453 
0454 struct tfd_data {
0455     /* Header */
0456     __le32 work_area_ptr;
0457     u8 station_number;  /* 0 for BSS */
0458     u8 reserved1;
0459     __le16 reserved2;
0460 
0461     /* Tx Parameters */
0462     u8 cmd_id;
0463     u8 seq_num;
0464     __le16 len;
0465     u8 priority;
0466     u8 tx_flags;
0467     u8 tx_flags_ext;
0468     u8 key_index;
0469     u8 wepkey[DCT_WEP_KEY_FIELD_LENGTH];
0470     u8 rate;
0471     u8 antenna;
0472     __le16 next_packet_duration;
0473     __le16 next_frag_len;
0474     __le16 back_off_counter;    //////txop;
0475     u8 retrylimit;
0476     __le16 cwcurrent;
0477     u8 reserved3;
0478 
0479     /* 802.11 MAC Header */
0480     union {
0481         struct tx_tfd_24 tfd_24;
0482         struct tx_tfd_26 tfd_26;
0483         struct tx_tfd_30 tfd_30;
0484         struct tx_tfd_32 tfd_32;
0485     } tfd;
0486 
0487     /* Payload DMA info */
0488     __le32 num_chunks;
0489     __le32 chunk_ptr[NUM_TFD_CHUNKS];
0490     __le16 chunk_len[NUM_TFD_CHUNKS];
0491 } __packed;
0492 
0493 struct txrx_control_flags {
0494     u8 message_type;
0495     u8 rx_seq_num;
0496     u8 control_bits;
0497     u8 reserved;
0498 } __packed;
0499 
0500 #define  TFD_SIZE                           128
0501 #define  TFD_CMD_IMMEDIATE_PAYLOAD_LENGTH   (TFD_SIZE - sizeof(struct txrx_control_flags))
0502 
0503 struct tfd_frame {
0504     struct txrx_control_flags control_flags;
0505     union {
0506         struct tfd_data data;
0507         struct tfd_command cmd;
0508         u8 raw[TFD_CMD_IMMEDIATE_PAYLOAD_LENGTH];
0509     } u;
0510 } __packed;
0511 
0512 typedef void destructor_func(const void *);
0513 
0514 /**
0515  * Tx Queue for DMA. Queue consists of circular buffer of
0516  * BD's and required locking structures.
0517  */
0518 struct clx2_tx_queue {
0519     struct clx2_queue q;
0520     struct tfd_frame *bd;
0521     struct libipw_txb **txb;
0522 };
0523 
0524 /*
0525  * RX related structures and functions
0526  */
0527 #define RX_FREE_BUFFERS 32
0528 #define RX_LOW_WATERMARK 8
0529 
0530 #define SUP_RATE_11A_MAX_NUM_CHANNELS  8
0531 #define SUP_RATE_11B_MAX_NUM_CHANNELS  4
0532 #define SUP_RATE_11G_MAX_NUM_CHANNELS  12
0533 
0534 // Used for passing to driver number of successes and failures per rate
0535 struct rate_histogram {
0536     union {
0537         __le32 a[SUP_RATE_11A_MAX_NUM_CHANNELS];
0538         __le32 b[SUP_RATE_11B_MAX_NUM_CHANNELS];
0539         __le32 g[SUP_RATE_11G_MAX_NUM_CHANNELS];
0540     } success;
0541     union {
0542         __le32 a[SUP_RATE_11A_MAX_NUM_CHANNELS];
0543         __le32 b[SUP_RATE_11B_MAX_NUM_CHANNELS];
0544         __le32 g[SUP_RATE_11G_MAX_NUM_CHANNELS];
0545     } failed;
0546 } __packed;
0547 
0548 /* statistics command response */
0549 struct ipw_cmd_stats {
0550     u8 cmd_id;
0551     u8 seq_num;
0552     __le16 good_sfd;
0553     __le16 bad_plcp;
0554     __le16 wrong_bssid;
0555     __le16 valid_mpdu;
0556     __le16 bad_mac_header;
0557     __le16 reserved_frame_types;
0558     __le16 rx_ina;
0559     __le16 bad_crc32;
0560     __le16 invalid_cts;
0561     __le16 invalid_acks;
0562     __le16 long_distance_ina_fina;
0563     __le16 dsp_silence_unreachable;
0564     __le16 accumulated_rssi;
0565     __le16 rx_ovfl_frame_tossed;
0566     __le16 rssi_silence_threshold;
0567     __le16 rx_ovfl_frame_supplied;
0568     __le16 last_rx_frame_signal;
0569     __le16 last_rx_frame_noise;
0570     __le16 rx_autodetec_no_ofdm;
0571     __le16 rx_autodetec_no_barker;
0572     __le16 reserved;
0573 } __packed;
0574 
0575 struct notif_channel_result {
0576     u8 channel_num;
0577     struct ipw_cmd_stats stats;
0578     u8 uReserved;
0579 } __packed;
0580 
0581 #define SCAN_COMPLETED_STATUS_COMPLETE  1
0582 #define SCAN_COMPLETED_STATUS_ABORTED   2
0583 
0584 struct notif_scan_complete {
0585     u8 scan_type;
0586     u8 num_channels;
0587     u8 status;
0588     u8 reserved;
0589 } __packed;
0590 
0591 struct notif_frag_length {
0592     __le16 frag_length;
0593     __le16 reserved;
0594 } __packed;
0595 
0596 struct notif_beacon_state {
0597     __le32 state;
0598     __le32 number;
0599 } __packed;
0600 
0601 struct notif_tgi_tx_key {
0602     u8 key_state;
0603     u8 security_type;
0604     u8 station_index;
0605     u8 reserved;
0606 } __packed;
0607 
0608 #define SILENCE_OVER_THRESH (1)
0609 #define SILENCE_UNDER_THRESH (2)
0610 
0611 struct notif_link_deterioration {
0612     struct ipw_cmd_stats stats;
0613     u8 rate;
0614     u8 modulation;
0615     struct rate_histogram histogram;
0616     u8 silence_notification_type;   /* SILENCE_OVER/UNDER_THRESH */
0617     __le16 silence_count;
0618 } __packed;
0619 
0620 struct notif_association {
0621     u8 state;
0622 } __packed;
0623 
0624 struct notif_authenticate {
0625     u8 state;
0626     struct machdr24 addr;
0627     __le16 status;
0628 } __packed;
0629 
0630 struct notif_calibration {
0631     u8 data[104];
0632 } __packed;
0633 
0634 struct notif_noise {
0635     __le32 value;
0636 } __packed;
0637 
0638 struct ipw_rx_notification {
0639     u8 reserved[8];
0640     u8 subtype;
0641     u8 flags;
0642     __le16 size;
0643     union {
0644         struct notif_association assoc;
0645         struct notif_authenticate auth;
0646         struct notif_channel_result channel_result;
0647         struct notif_scan_complete scan_complete;
0648         struct notif_frag_length frag_len;
0649         struct notif_beacon_state beacon_state;
0650         struct notif_tgi_tx_key tgi_tx_key;
0651         struct notif_link_deterioration link_deterioration;
0652         struct notif_calibration calibration;
0653         struct notif_noise noise;
0654         u8 raw[0];
0655     } u;
0656 } __packed;
0657 
0658 struct ipw_rx_frame {
0659     __le32 reserved1;
0660     u8 parent_tsf[4];   // fw_use[0] is boolean for OUR_TSF_IS_GREATER
0661     u8 received_channel;    // The channel that this frame was received on.
0662     // Note that for .11b this does not have to be
0663     // the same as the channel that it was sent.
0664     // Filled by LMAC
0665     u8 frameStatus;
0666     u8 rate;
0667     u8 rssi;
0668     u8 agc;
0669     u8 rssi_dbm;
0670     __le16 signal;
0671     __le16 noise;
0672     u8 antennaAndPhy;
0673     u8 control;     // control bit should be on in bg
0674     u8 rtscts_rate;     // rate of rts or cts (in rts cts sequence rate
0675     // is identical)
0676     u8 rtscts_seen;     // 0x1 RTS seen ; 0x2 CTS seen
0677     __le16 length;
0678     u8 data[];
0679 } __packed;
0680 
0681 struct ipw_rx_header {
0682     u8 message_type;
0683     u8 rx_seq_num;
0684     u8 control_bits;
0685     u8 reserved;
0686 } __packed;
0687 
0688 struct ipw_rx_packet {
0689     struct ipw_rx_header header;
0690     union {
0691         struct ipw_rx_frame frame;
0692         struct ipw_rx_notification notification;
0693     } u;
0694 } __packed;
0695 
0696 #define IPW_RX_NOTIFICATION_SIZE sizeof(struct ipw_rx_header) + 12
0697 #define IPW_RX_FRAME_SIZE        (unsigned int)(sizeof(struct ipw_rx_header) + \
0698                                  sizeof(struct ipw_rx_frame))
0699 
0700 struct ipw_rx_mem_buffer {
0701     dma_addr_t dma_addr;
0702     struct sk_buff *skb;
0703     struct list_head list;
0704 };              /* Not transferred over network, so not  __packed */
0705 
0706 struct ipw_rx_queue {
0707     struct ipw_rx_mem_buffer pool[RX_QUEUE_SIZE + RX_FREE_BUFFERS];
0708     struct ipw_rx_mem_buffer *queue[RX_QUEUE_SIZE];
0709     u32 processed;      /* Internal index to last handled Rx packet */
0710     u32 read;       /* Shared index to newest available Rx buffer */
0711     u32 write;      /* Shared index to oldest written Rx packet */
0712     u32 free_count;     /* Number of pre-allocated buffers in rx_free */
0713     /* Each of these lists is used as a FIFO for ipw_rx_mem_buffers */
0714     struct list_head rx_free;   /* Own an SKBs */
0715     struct list_head rx_used;   /* No SKB allocated */
0716     spinlock_t lock;
0717 };              /* Not transferred over network, so not  __packed */
0718 
0719 struct alive_command_responce {
0720     u8 alive_command;
0721     u8 sequence_number;
0722     __le16 software_revision;
0723     u8 device_identifier;
0724     u8 reserved1[5];
0725     __le16 reserved2;
0726     __le16 reserved3;
0727     __le16 clock_settle_time;
0728     __le16 powerup_settle_time;
0729     __le16 reserved4;
0730     u8 time_stamp[5];   /* month, day, year, hours, minutes */
0731     u8 ucode_valid;
0732 } __packed;
0733 
0734 #define IPW_MAX_RATES 12
0735 
0736 struct ipw_rates {
0737     u8 num_rates;
0738     u8 rates[IPW_MAX_RATES];
0739 } __packed;
0740 
0741 struct command_block {
0742     unsigned int control;
0743     u32 source_addr;
0744     u32 dest_addr;
0745     unsigned int status;
0746 } __packed;
0747 
0748 #define CB_NUMBER_OF_ELEMENTS_SMALL 64
0749 struct fw_image_desc {
0750     unsigned long last_cb_index;
0751     unsigned long current_cb_index;
0752     struct command_block cb_list[CB_NUMBER_OF_ELEMENTS_SMALL];
0753     void *v_addr;
0754     unsigned long p_addr;
0755     unsigned long len;
0756 };
0757 
0758 struct ipw_sys_config {
0759     u8 bt_coexistence;
0760     u8 reserved1;
0761     u8 answer_broadcast_ssid_probe;
0762     u8 accept_all_data_frames;
0763     u8 accept_non_directed_frames;
0764     u8 exclude_unicast_unencrypted;
0765     u8 disable_unicast_decryption;
0766     u8 exclude_multicast_unencrypted;
0767     u8 disable_multicast_decryption;
0768     u8 antenna_diversity;
0769     u8 pass_crc_to_host;
0770     u8 dot11g_auto_detection;
0771     u8 enable_cts_to_self;
0772     u8 enable_multicast_filtering;
0773     u8 bt_coexist_collision_thr;
0774     u8 silence_threshold;
0775     u8 accept_all_mgmt_bcpr;
0776     u8 accept_all_mgmt_frames;
0777     u8 pass_noise_stats_to_host;
0778     u8 reserved3;
0779 } __packed;
0780 
0781 struct ipw_multicast_addr {
0782     u8 num_of_multicast_addresses;
0783     u8 reserved[3];
0784     u8 mac1[6];
0785     u8 mac2[6];
0786     u8 mac3[6];
0787     u8 mac4[6];
0788 } __packed;
0789 
0790 #define DCW_WEP_KEY_INDEX_MASK      0x03    /* bits [0:1] */
0791 #define DCW_WEP_KEY_SEC_TYPE_MASK   0x30    /* bits [4:5] */
0792 
0793 #define DCW_WEP_KEY_SEC_TYPE_WEP    0x00
0794 #define DCW_WEP_KEY_SEC_TYPE_CCM    0x20
0795 #define DCW_WEP_KEY_SEC_TYPE_TKIP   0x30
0796 
0797 #define DCW_WEP_KEY_INVALID_SIZE    0x00    /* 0 = Invalid key */
0798 #define DCW_WEP_KEY64Bit_SIZE       0x05    /* 64-bit encryption */
0799 #define DCW_WEP_KEY128Bit_SIZE      0x0D    /* 128-bit encryption */
0800 #define DCW_CCM_KEY128Bit_SIZE      0x10    /* 128-bit key */
0801 //#define DCW_WEP_KEY128BitIV_SIZE      0x10    /* 128-bit key and 128-bit IV */
0802 
0803 struct ipw_wep_key {
0804     u8 cmd_id;
0805     u8 seq_num;
0806     u8 key_index;
0807     u8 key_size;
0808     u8 key[16];
0809 } __packed;
0810 
0811 struct ipw_tgi_tx_key {
0812     u8 key_id;
0813     u8 security_type;
0814     u8 station_index;
0815     u8 flags;
0816     u8 key[16];
0817     __le32 tx_counter[2];
0818 } __packed;
0819 
0820 #define IPW_SCAN_CHANNELS 54
0821 
0822 struct ipw_scan_request {
0823     u8 scan_type;
0824     __le16 dwell_time;
0825     u8 channels_list[IPW_SCAN_CHANNELS];
0826     u8 channels_reserved[3];
0827 } __packed;
0828 
0829 enum {
0830     IPW_SCAN_PASSIVE_TILL_FIRST_BEACON_SCAN = 0,
0831     IPW_SCAN_PASSIVE_FULL_DWELL_SCAN,
0832     IPW_SCAN_ACTIVE_DIRECT_SCAN,
0833     IPW_SCAN_ACTIVE_BROADCAST_SCAN,
0834     IPW_SCAN_ACTIVE_BROADCAST_AND_DIRECT_SCAN,
0835     IPW_SCAN_TYPES
0836 };
0837 
0838 struct ipw_scan_request_ext {
0839     __le32 full_scan_index;
0840     u8 channels_list[IPW_SCAN_CHANNELS];
0841     u8 scan_type[IPW_SCAN_CHANNELS / 2];
0842     u8 reserved;
0843     __le16 dwell_time[IPW_SCAN_TYPES];
0844 } __packed;
0845 
0846 static inline u8 ipw_get_scan_type(struct ipw_scan_request_ext *scan, u8 index)
0847 {
0848     if (index % 2)
0849         return scan->scan_type[index / 2] & 0x0F;
0850     else
0851         return (scan->scan_type[index / 2] & 0xF0) >> 4;
0852 }
0853 
0854 static inline void ipw_set_scan_type(struct ipw_scan_request_ext *scan,
0855                      u8 index, u8 scan_type)
0856 {
0857     if (index % 2)
0858         scan->scan_type[index / 2] =
0859             (scan->scan_type[index / 2] & 0xF0) | (scan_type & 0x0F);
0860     else
0861         scan->scan_type[index / 2] =
0862             (scan->scan_type[index / 2] & 0x0F) |
0863             ((scan_type & 0x0F) << 4);
0864 }
0865 
0866 struct ipw_associate {
0867     u8 channel;
0868 #ifdef __LITTLE_ENDIAN_BITFIELD
0869     u8 auth_type:4, auth_key:4;
0870 #else
0871     u8 auth_key:4, auth_type:4;
0872 #endif
0873     u8 assoc_type;
0874     u8 reserved;
0875     __le16 policy_support;
0876     u8 preamble_length;
0877     u8 ieee_mode;
0878     u8 bssid[ETH_ALEN];
0879     __le32 assoc_tsf_msw;
0880     __le32 assoc_tsf_lsw;
0881     __le16 capability;
0882     __le16 listen_interval;
0883     __le16 beacon_interval;
0884     u8 dest[ETH_ALEN];
0885     __le16 atim_window;
0886     u8 smr;
0887     u8 reserved1;
0888     __le16 reserved2;
0889 } __packed;
0890 
0891 struct ipw_supported_rates {
0892     u8 ieee_mode;
0893     u8 num_rates;
0894     u8 purpose;
0895     u8 reserved;
0896     u8 supported_rates[IPW_MAX_RATES];
0897 } __packed;
0898 
0899 struct ipw_rts_threshold {
0900     __le16 rts_threshold;
0901     __le16 reserved;
0902 } __packed;
0903 
0904 struct ipw_frag_threshold {
0905     __le16 frag_threshold;
0906     __le16 reserved;
0907 } __packed;
0908 
0909 struct ipw_retry_limit {
0910     u8 short_retry_limit;
0911     u8 long_retry_limit;
0912     __le16 reserved;
0913 } __packed;
0914 
0915 struct ipw_dino_config {
0916     __le32 dino_config_addr;
0917     __le16 dino_config_size;
0918     u8 dino_response;
0919     u8 reserved;
0920 } __packed;
0921 
0922 struct ipw_aironet_info {
0923     u8 id;
0924     u8 length;
0925     __le16 reserved;
0926 } __packed;
0927 
0928 struct ipw_rx_key {
0929     u8 station_index;
0930     u8 key_type;
0931     u8 key_id;
0932     u8 key_flag;
0933     u8 key[16];
0934     u8 station_address[6];
0935     u8 key_index;
0936     u8 reserved;
0937 } __packed;
0938 
0939 struct ipw_country_channel_info {
0940     u8 first_channel;
0941     u8 no_channels;
0942     s8 max_tx_power;
0943 } __packed;
0944 
0945 struct ipw_country_info {
0946     u8 id;
0947     u8 length;
0948     u8 country_str[IEEE80211_COUNTRY_STRING_LEN];
0949     struct ipw_country_channel_info groups[7];
0950 } __packed;
0951 
0952 struct ipw_channel_tx_power {
0953     u8 channel_number;
0954     s8 tx_power;
0955 } __packed;
0956 
0957 #define SCAN_ASSOCIATED_INTERVAL (HZ)
0958 #define SCAN_INTERVAL (HZ / 10)
0959 #define MAX_A_CHANNELS  37
0960 #define MAX_B_CHANNELS  14
0961 
0962 struct ipw_tx_power {
0963     u8 num_channels;
0964     u8 ieee_mode;
0965     struct ipw_channel_tx_power channels_tx_power[MAX_A_CHANNELS];
0966 } __packed;
0967 
0968 struct ipw_rsn_capabilities {
0969     u8 id;
0970     u8 length;
0971     __le16 version;
0972 } __packed;
0973 
0974 struct ipw_sensitivity_calib {
0975     __le16 beacon_rssi_raw;
0976     __le16 reserved;
0977 } __packed;
0978 
0979 /**
0980  * Host command structure.
0981  *
0982  * On input, the following fields should be filled:
0983  * - cmd
0984  * - len
0985  * - status_len
0986  * - param (if needed)
0987  *
0988  * On output,
0989  * - \a status contains status;
0990  * - \a param filled with status parameters.
0991  */
0992 struct ipw_cmd {     /* XXX */
0993     u32 cmd;   /**< Host command */
0994     u32 status;/**< Status */
0995     u32 status_len;
0996            /**< How many 32 bit parameters in the status */
0997     u32 len;   /**< incoming parameters length, bytes */
0998   /**
0999    * command parameters.
1000    * There should be enough space for incoming and
1001    * outcoming parameters.
1002    * Incoming parameters listed 1-st, followed by outcoming params.
1003    * nParams=(len+3)/4+status_len
1004    */
1005     u32 param[];
1006 } __packed;
1007 
1008 #define STATUS_HCMD_ACTIVE      (1<<0)  /**< host command in progress */
1009 
1010 #define STATUS_INT_ENABLED      (1<<1)
1011 #define STATUS_RF_KILL_HW       (1<<2)
1012 #define STATUS_RF_KILL_SW       (1<<3)
1013 #define STATUS_RF_KILL_MASK     (STATUS_RF_KILL_HW | STATUS_RF_KILL_SW)
1014 
1015 #define STATUS_INIT             (1<<5)
1016 #define STATUS_AUTH             (1<<6)
1017 #define STATUS_ASSOCIATED       (1<<7)
1018 #define STATUS_STATE_MASK       (STATUS_INIT | STATUS_AUTH | STATUS_ASSOCIATED)
1019 
1020 #define STATUS_ASSOCIATING      (1<<8)
1021 #define STATUS_DISASSOCIATING   (1<<9)
1022 #define STATUS_ROAMING          (1<<10)
1023 #define STATUS_EXIT_PENDING     (1<<11)
1024 #define STATUS_DISASSOC_PENDING (1<<12)
1025 #define STATUS_STATE_PENDING    (1<<13)
1026 
1027 #define STATUS_DIRECT_SCAN_PENDING (1<<19)
1028 #define STATUS_SCAN_PENDING     (1<<20)
1029 #define STATUS_SCANNING         (1<<21)
1030 #define STATUS_SCAN_ABORTING    (1<<22)
1031 #define STATUS_SCAN_FORCED      (1<<23)
1032 
1033 #define STATUS_LED_LINK_ON      (1<<24)
1034 #define STATUS_LED_ACT_ON       (1<<25)
1035 
1036 #define STATUS_INDIRECT_BYTE    (1<<28) /* sysfs entry configured for access */
1037 #define STATUS_INDIRECT_DWORD   (1<<29) /* sysfs entry configured for access */
1038 #define STATUS_DIRECT_DWORD     (1<<30) /* sysfs entry configured for access */
1039 
1040 #define STATUS_SECURITY_UPDATED (1<<31) /* Security sync needed */
1041 
1042 #define CFG_STATIC_CHANNEL      (1<<0)  /* Restrict assoc. to single channel */
1043 #define CFG_STATIC_ESSID        (1<<1)  /* Restrict assoc. to single SSID */
1044 #define CFG_STATIC_BSSID        (1<<2)  /* Restrict assoc. to single BSSID */
1045 #define CFG_CUSTOM_MAC          (1<<3)
1046 #define CFG_PREAMBLE_LONG       (1<<4)
1047 #define CFG_ADHOC_PERSIST       (1<<5)
1048 #define CFG_ASSOCIATE           (1<<6)
1049 #define CFG_FIXED_RATE          (1<<7)
1050 #define CFG_ADHOC_CREATE        (1<<8)
1051 #define CFG_NO_LED              (1<<9)
1052 #define CFG_BACKGROUND_SCAN     (1<<10)
1053 #define CFG_SPEED_SCAN          (1<<11)
1054 #define CFG_NET_STATS           (1<<12)
1055 
1056 #define CAP_SHARED_KEY          (1<<0)  /* Off = OPEN */
1057 #define CAP_PRIVACY_ON          (1<<1)  /* Off = No privacy */
1058 
1059 #define MAX_STATIONS            32
1060 #define IPW_INVALID_STATION     (0xff)
1061 
1062 struct ipw_station_entry {
1063     u8 mac_addr[ETH_ALEN];
1064     u8 reserved;
1065     u8 support_mode;
1066 };
1067 
1068 #define AVG_ENTRIES 8
1069 struct average {
1070     s16 entries[AVG_ENTRIES];
1071     u8 pos;
1072     u8 init;
1073     s32 sum;
1074 };
1075 
1076 #define MAX_SPEED_SCAN 100
1077 #define IPW_IBSS_MAC_HASH_SIZE 31
1078 
1079 struct ipw_ibss_seq {
1080     u8 mac[ETH_ALEN];
1081     u16 seq_num;
1082     u16 frag_num;
1083     unsigned long packet_time;
1084     struct list_head list;
1085 };
1086 
1087 struct ipw_error_elem {  /* XXX */
1088     u32 desc;
1089     u32 time;
1090     u32 blink1;
1091     u32 blink2;
1092     u32 link1;
1093     u32 link2;
1094     u32 data;
1095 };
1096 
1097 struct ipw_event {   /* XXX */
1098     u32 event;
1099     u32 time;
1100     u32 data;
1101 } __packed;
1102 
1103 struct ipw_fw_error {    /* XXX */
1104     unsigned long jiffies;
1105     u32 status;
1106     u32 config;
1107     u32 elem_len;
1108     u32 log_len;
1109     struct ipw_error_elem *elem;
1110     struct ipw_event *log;
1111     u8 payload[];
1112 } __packed;
1113 
1114 #ifdef CONFIG_IPW2200_PROMISCUOUS
1115 
1116 enum ipw_prom_filter {
1117     IPW_PROM_CTL_HEADER_ONLY = (1 << 0),
1118     IPW_PROM_MGMT_HEADER_ONLY = (1 << 1),
1119     IPW_PROM_DATA_HEADER_ONLY = (1 << 2),
1120     IPW_PROM_ALL_HEADER_ONLY = 0xf, /* bits 0..3 */
1121     IPW_PROM_NO_TX = (1 << 4),
1122     IPW_PROM_NO_RX = (1 << 5),
1123     IPW_PROM_NO_CTL = (1 << 6),
1124     IPW_PROM_NO_MGMT = (1 << 7),
1125     IPW_PROM_NO_DATA = (1 << 8),
1126 };
1127 
1128 struct ipw_priv;
1129 struct ipw_prom_priv {
1130     struct ipw_priv *priv;
1131     struct libipw_device *ieee;
1132     enum ipw_prom_filter filter;
1133     int tx_packets;
1134     int rx_packets;
1135 };
1136 #endif
1137 
1138 #if defined(CONFIG_IPW2200_RADIOTAP) || defined(CONFIG_IPW2200_PROMISCUOUS)
1139 /* Magic struct that slots into the radiotap header -- no reason
1140  * to build this manually element by element, we can write it much
1141  * more efficiently than we can parse it. ORDER MATTERS HERE
1142  *
1143  * When sent to us via the simulated Rx interface in sysfs, the entire
1144  * structure is provided regardless of any bits unset.
1145  */
1146 struct ipw_rt_hdr {
1147     struct ieee80211_radiotap_header rt_hdr;
1148     u64 rt_tsf;      /* TSF */  /* XXX */
1149     u8 rt_flags;    /* radiotap packet flags */
1150     u8 rt_rate; /* rate in 500kb/s */
1151     __le16 rt_channel;  /* channel in mhz */
1152     __le16 rt_chbitmask;    /* channel bitfield */
1153     s8 rt_dbmsignal;    /* signal in dbM, kluged to signed */
1154     s8 rt_dbmnoise;
1155     u8 rt_antenna;  /* antenna number */
1156     u8 payload[];  /* payload... */
1157 } __packed;
1158 #endif
1159 
1160 struct ipw_priv {
1161     /* ieee device used by generic ieee processing code */
1162     struct libipw_device *ieee;
1163 
1164     spinlock_t lock;
1165     spinlock_t irq_lock;
1166     struct mutex mutex;
1167 
1168     /* basic pci-network driver stuff */
1169     struct pci_dev *pci_dev;
1170     struct net_device *net_dev;
1171 
1172 #ifdef CONFIG_IPW2200_PROMISCUOUS
1173     /* Promiscuous mode */
1174     struct ipw_prom_priv *prom_priv;
1175     struct net_device *prom_net_dev;
1176 #endif
1177 
1178     /* pci hardware address support */
1179     void __iomem *hw_base;
1180     unsigned long hw_len;
1181 
1182     struct fw_image_desc sram_desc;
1183 
1184     /* result of ucode download */
1185     struct alive_command_responce dino_alive;
1186 
1187     wait_queue_head_t wait_command_queue;
1188     wait_queue_head_t wait_state;
1189 
1190     /* Rx and Tx DMA processing queues */
1191     struct ipw_rx_queue *rxq;
1192     struct clx2_tx_queue txq_cmd;
1193     struct clx2_tx_queue txq[4];
1194     u32 status;
1195     u32 config;
1196     u32 capability;
1197 
1198     struct average average_missed_beacons;
1199     s16 exp_avg_rssi;
1200     s16 exp_avg_noise;
1201     u32 port_type;
1202     int rx_bufs_min;      /**< minimum number of bufs in Rx queue */
1203     int rx_pend_max;      /**< maximum pending buffers for one IRQ */
1204     u32 hcmd_seq;         /**< sequence number for hcmd */
1205     u32 disassociate_threshold;
1206     u32 roaming_threshold;
1207 
1208     struct ipw_associate assoc_request;
1209     struct libipw_network *assoc_network;
1210 
1211     unsigned long ts_scan_abort;
1212     struct ipw_supported_rates rates;
1213     struct ipw_rates phy[3];       /**< PHY restrictions, per band */
1214     struct ipw_rates supp;         /**< software defined */
1215     struct ipw_rates extended;     /**< use for corresp. IE, AP only */
1216 
1217     struct notif_link_deterioration last_link_deterioration; /** for statistics */
1218     struct ipw_cmd *hcmd; /**< host command currently executed */
1219 
1220     wait_queue_head_t hcmd_wq;     /**< host command waits for execution */
1221     u32 tsf_bcn[2];          /**< TSF from latest beacon */
1222 
1223     struct notif_calibration calib; /**< last calibration */
1224 
1225     /* ordinal interface with firmware */
1226     u32 table0_addr;
1227     u32 table0_len;
1228     u32 table1_addr;
1229     u32 table1_len;
1230     u32 table2_addr;
1231     u32 table2_len;
1232 
1233     /* context information */
1234     u8 essid[IW_ESSID_MAX_SIZE];
1235     u8 essid_len;
1236     u8 nick[IW_ESSID_MAX_SIZE];
1237     u16 rates_mask;
1238     u8 channel;
1239     struct ipw_sys_config sys_config;
1240     u32 power_mode;
1241     u8 bssid[ETH_ALEN];
1242     u16 rts_threshold;
1243     u8 mac_addr[ETH_ALEN];
1244     u8 num_stations;
1245     u8 stations[MAX_STATIONS][ETH_ALEN];
1246     u8 short_retry_limit;
1247     u8 long_retry_limit;
1248 
1249     u32 notif_missed_beacons;
1250 
1251     /* Statistics and counters normalized with each association */
1252     u32 last_missed_beacons;
1253     u32 last_tx_packets;
1254     u32 last_rx_packets;
1255     u32 last_tx_failures;
1256     u32 last_rx_err;
1257     u32 last_rate;
1258 
1259     u32 missed_adhoc_beacons;
1260     u32 missed_beacons;
1261     u32 rx_packets;
1262     u32 tx_packets;
1263     u32 quality;
1264 
1265     u8 speed_scan[MAX_SPEED_SCAN];
1266     u8 speed_scan_pos;
1267 
1268     u16 last_seq_num;
1269     u16 last_frag_num;
1270     unsigned long last_packet_time;
1271     struct list_head ibss_mac_hash[IPW_IBSS_MAC_HASH_SIZE];
1272 
1273     /* eeprom */
1274     u8 eeprom[0x100];   /* 256 bytes of eeprom */
1275     u8 country[4];
1276     int eeprom_delay;
1277 
1278     struct iw_statistics wstats;
1279 
1280     struct iw_public_data wireless_data;
1281 
1282     int user_requested_scan;
1283     u8 direct_scan_ssid[IW_ESSID_MAX_SIZE];
1284     u8 direct_scan_ssid_len;
1285 
1286     struct delayed_work adhoc_check;
1287     struct work_struct associate;
1288     struct work_struct disassociate;
1289     struct work_struct system_config;
1290     struct work_struct rx_replenish;
1291     struct delayed_work request_scan;
1292     struct delayed_work request_direct_scan;
1293     struct delayed_work request_passive_scan;
1294     struct delayed_work scan_event;
1295     struct work_struct adapter_restart;
1296     struct delayed_work rf_kill;
1297     struct work_struct up;
1298     struct work_struct down;
1299     struct delayed_work gather_stats;
1300     struct work_struct abort_scan;
1301     struct work_struct roam;
1302     struct delayed_work scan_check;
1303     struct work_struct link_up;
1304     struct work_struct link_down;
1305 
1306     struct tasklet_struct irq_tasklet;
1307 
1308     /* LED related variables and work_struct */
1309     u8 nic_type;
1310     u32 led_activity_on;
1311     u32 led_activity_off;
1312     u32 led_association_on;
1313     u32 led_association_off;
1314     u32 led_ofdm_on;
1315     u32 led_ofdm_off;
1316 
1317     struct delayed_work led_link_on;
1318     struct delayed_work led_link_off;
1319     struct delayed_work led_act_off;
1320     struct work_struct merge_networks;
1321 
1322     struct ipw_cmd_log *cmdlog;
1323     int cmdlog_len;
1324     int cmdlog_pos;
1325 
1326 #define IPW_2200BG  1
1327 #define IPW_2915ABG 2
1328     u8 adapter;
1329 
1330     s8 tx_power;
1331 
1332     /* Track time in suspend using CLOCK_BOOTTIME */
1333     time64_t suspend_at;
1334     time64_t suspend_time;
1335 
1336 #ifdef CONFIG_PM
1337     u32 pm_state[16];
1338 #endif
1339 
1340     struct ipw_fw_error *error;
1341 
1342     /* network state */
1343 
1344     /* Used to pass the current INTA value from ISR to Tasklet */
1345     u32 isr_inta;
1346 
1347     /* QoS */
1348     struct ipw_qos_info qos_data;
1349     struct work_struct qos_activate;
1350     /*********************************/
1351 
1352     /* debugging info */
1353     u32 indirect_dword;
1354     u32 direct_dword;
1355     u32 indirect_byte;
1356 };              /*ipw_priv */
1357 
1358 /* debug macros */
1359 
1360 /* Debug and printf string expansion helpers for printing bitfields */
1361 #define BIT_FMT8 "%c%c%c%c-%c%c%c%c"
1362 #define BIT_FMT16 BIT_FMT8 ":" BIT_FMT8
1363 #define BIT_FMT32 BIT_FMT16 " " BIT_FMT16
1364 
1365 #define BITC(x,y) (((x>>y)&1)?'1':'0')
1366 #define BIT_ARG8(x) \
1367 BITC(x,7),BITC(x,6),BITC(x,5),BITC(x,4),\
1368 BITC(x,3),BITC(x,2),BITC(x,1),BITC(x,0)
1369 
1370 #define BIT_ARG16(x) \
1371 BITC(x,15),BITC(x,14),BITC(x,13),BITC(x,12),\
1372 BITC(x,11),BITC(x,10),BITC(x,9),BITC(x,8),\
1373 BIT_ARG8(x)
1374 
1375 #define BIT_ARG32(x) \
1376 BITC(x,31),BITC(x,30),BITC(x,29),BITC(x,28),\
1377 BITC(x,27),BITC(x,26),BITC(x,25),BITC(x,24),\
1378 BITC(x,23),BITC(x,22),BITC(x,21),BITC(x,20),\
1379 BITC(x,19),BITC(x,18),BITC(x,17),BITC(x,16),\
1380 BIT_ARG16(x)
1381 
1382 
1383 #define IPW_DEBUG(level, fmt, args...) \
1384 do { if (ipw_debug_level & (level)) \
1385   printk(KERN_DEBUG DRV_NAME": %s " fmt, __func__ , ## args); } while (0)
1386 
1387 #ifdef CONFIG_IPW2200_DEBUG
1388 #define IPW_LL_DEBUG(level, fmt, args...) \
1389 do { if (ipw_debug_level & (level)) \
1390   printk(KERN_DEBUG DRV_NAME": %s " fmt, __func__ , ## args); } while (0)
1391 #else
1392 #define IPW_LL_DEBUG(level, fmt, args...) do {} while (0)
1393 #endif              /* CONFIG_IPW2200_DEBUG */
1394 
1395 /*
1396  * To use the debug system;
1397  *
1398  * If you are defining a new debug classification, simply add it to the #define
1399  * list here in the form of:
1400  *
1401  * #define IPW_DL_xxxx VALUE
1402  *
1403  * shifting value to the left one bit from the previous entry.  xxxx should be
1404  * the name of the classification (for example, WEP)
1405  *
1406  * You then need to either add a IPW_xxxx_DEBUG() macro definition for your
1407  * classification, or use IPW_DEBUG(IPW_DL_xxxx, ...) whenever you want
1408  * to send output to that classification.
1409  *
1410  * To add your debug level to the list of levels seen when you perform
1411  *
1412  * % cat /proc/net/ipw/debug_level
1413  *
1414  * you simply need to add your entry to the ipw_debug_levels array.
1415  *
1416  * If you do not see debug_level in /proc/net/ipw then you do not have
1417  * CONFIG_IPW2200_DEBUG defined in your kernel configuration
1418  *
1419  */
1420 
1421 #define IPW_DL_ERROR         (1<<0)
1422 #define IPW_DL_WARNING       (1<<1)
1423 #define IPW_DL_INFO          (1<<2)
1424 #define IPW_DL_WX            (1<<3)
1425 #define IPW_DL_HOST_COMMAND  (1<<5)
1426 #define IPW_DL_STATE         (1<<6)
1427 
1428 #define IPW_DL_NOTIF         (1<<10)
1429 #define IPW_DL_SCAN          (1<<11)
1430 #define IPW_DL_ASSOC         (1<<12)
1431 #define IPW_DL_DROP          (1<<13)
1432 #define IPW_DL_IOCTL         (1<<14)
1433 
1434 #define IPW_DL_MANAGE        (1<<15)
1435 #define IPW_DL_FW            (1<<16)
1436 #define IPW_DL_RF_KILL       (1<<17)
1437 #define IPW_DL_FW_ERRORS     (1<<18)
1438 
1439 #define IPW_DL_LED           (1<<19)
1440 
1441 #define IPW_DL_ORD           (1<<20)
1442 
1443 #define IPW_DL_FRAG          (1<<21)
1444 #define IPW_DL_WEP           (1<<22)
1445 #define IPW_DL_TX            (1<<23)
1446 #define IPW_DL_RX            (1<<24)
1447 #define IPW_DL_ISR           (1<<25)
1448 #define IPW_DL_FW_INFO       (1<<26)
1449 #define IPW_DL_IO            (1<<27)
1450 #define IPW_DL_TRACE         (1<<28)
1451 
1452 #define IPW_DL_STATS         (1<<29)
1453 #define IPW_DL_MERGE         (1<<30)
1454 #define IPW_DL_QOS           (1<<31)
1455 
1456 #define IPW_ERROR(f, a...) printk(KERN_ERR DRV_NAME ": " f, ## a)
1457 #define IPW_WARNING(f, a...) printk(KERN_WARNING DRV_NAME ": " f, ## a)
1458 #define IPW_DEBUG_INFO(f, a...)    IPW_DEBUG(IPW_DL_INFO, f, ## a)
1459 
1460 #define IPW_DEBUG_WX(f, a...)     IPW_DEBUG(IPW_DL_WX, f, ## a)
1461 #define IPW_DEBUG_SCAN(f, a...)   IPW_DEBUG(IPW_DL_SCAN, f, ## a)
1462 #define IPW_DEBUG_TRACE(f, a...)  IPW_LL_DEBUG(IPW_DL_TRACE, f, ## a)
1463 #define IPW_DEBUG_RX(f, a...)     IPW_LL_DEBUG(IPW_DL_RX, f, ## a)
1464 #define IPW_DEBUG_TX(f, a...)     IPW_LL_DEBUG(IPW_DL_TX, f, ## a)
1465 #define IPW_DEBUG_ISR(f, a...)    IPW_LL_DEBUG(IPW_DL_ISR, f, ## a)
1466 #define IPW_DEBUG_MANAGEMENT(f, a...) IPW_DEBUG(IPW_DL_MANAGE, f, ## a)
1467 #define IPW_DEBUG_LED(f, a...) IPW_LL_DEBUG(IPW_DL_LED, f, ## a)
1468 #define IPW_DEBUG_WEP(f, a...)    IPW_LL_DEBUG(IPW_DL_WEP, f, ## a)
1469 #define IPW_DEBUG_HC(f, a...) IPW_LL_DEBUG(IPW_DL_HOST_COMMAND, f, ## a)
1470 #define IPW_DEBUG_FRAG(f, a...) IPW_LL_DEBUG(IPW_DL_FRAG, f, ## a)
1471 #define IPW_DEBUG_FW(f, a...) IPW_LL_DEBUG(IPW_DL_FW, f, ## a)
1472 #define IPW_DEBUG_RF_KILL(f, a...) IPW_DEBUG(IPW_DL_RF_KILL, f, ## a)
1473 #define IPW_DEBUG_DROP(f, a...) IPW_DEBUG(IPW_DL_DROP, f, ## a)
1474 #define IPW_DEBUG_IO(f, a...) IPW_LL_DEBUG(IPW_DL_IO, f, ## a)
1475 #define IPW_DEBUG_ORD(f, a...) IPW_LL_DEBUG(IPW_DL_ORD, f, ## a)
1476 #define IPW_DEBUG_FW_INFO(f, a...) IPW_LL_DEBUG(IPW_DL_FW_INFO, f, ## a)
1477 #define IPW_DEBUG_NOTIF(f, a...) IPW_DEBUG(IPW_DL_NOTIF, f, ## a)
1478 #define IPW_DEBUG_STATE(f, a...) IPW_DEBUG(IPW_DL_STATE | IPW_DL_ASSOC | IPW_DL_INFO, f, ## a)
1479 #define IPW_DEBUG_ASSOC(f, a...) IPW_DEBUG(IPW_DL_ASSOC | IPW_DL_INFO, f, ## a)
1480 #define IPW_DEBUG_STATS(f, a...) IPW_LL_DEBUG(IPW_DL_STATS, f, ## a)
1481 #define IPW_DEBUG_MERGE(f, a...) IPW_LL_DEBUG(IPW_DL_MERGE, f, ## a)
1482 #define IPW_DEBUG_QOS(f, a...)   IPW_LL_DEBUG(IPW_DL_QOS, f, ## a)
1483 
1484 #include <linux/ctype.h>
1485 
1486 /*
1487 * Register bit definitions
1488 */
1489 
1490 #define IPW_INTA_RW       0x00000008
1491 #define IPW_INTA_MASK_R   0x0000000C
1492 #define IPW_INDIRECT_ADDR 0x00000010
1493 #define IPW_INDIRECT_DATA 0x00000014
1494 #define IPW_AUTOINC_ADDR  0x00000018
1495 #define IPW_AUTOINC_DATA  0x0000001C
1496 #define IPW_RESET_REG     0x00000020
1497 #define IPW_GP_CNTRL_RW   0x00000024
1498 
1499 #define IPW_READ_INT_REGISTER 0xFF4
1500 
1501 #define IPW_GP_CNTRL_BIT_INIT_DONE  0x00000004
1502 
1503 #define IPW_REGISTER_DOMAIN1_END        0x00001000
1504 #define IPW_SRAM_READ_INT_REGISTER  0x00000ff4
1505 
1506 #define IPW_SHARED_LOWER_BOUND          0x00000200
1507 #define IPW_INTERRUPT_AREA_LOWER_BOUND  0x00000f80
1508 
1509 #define IPW_NIC_SRAM_LOWER_BOUND        0x00000000
1510 #define IPW_NIC_SRAM_UPPER_BOUND        0x00030000
1511 
1512 #define IPW_BIT_INT_HOST_SRAM_READ_INT_REGISTER (1 << 29)
1513 #define IPW_GP_CNTRL_BIT_CLOCK_READY    0x00000001
1514 #define IPW_GP_CNTRL_BIT_HOST_ALLOWS_STANDBY 0x00000002
1515 
1516 /*
1517  * RESET Register Bit Indexes
1518  */
1519 #define CBD_RESET_REG_PRINCETON_RESET (1<<0)
1520 #define IPW_START_STANDBY             (1<<2)
1521 #define IPW_ACTIVITY_LED              (1<<4)
1522 #define IPW_ASSOCIATED_LED            (1<<5)
1523 #define IPW_OFDM_LED                  (1<<6)
1524 #define IPW_RESET_REG_SW_RESET        (1<<7)
1525 #define IPW_RESET_REG_MASTER_DISABLED (1<<8)
1526 #define IPW_RESET_REG_STOP_MASTER     (1<<9)
1527 #define IPW_GATE_ODMA                 (1<<25)
1528 #define IPW_GATE_IDMA                 (1<<26)
1529 #define IPW_ARC_KESHET_CONFIG         (1<<27)
1530 #define IPW_GATE_ADMA                 (1<<29)
1531 
1532 #define IPW_CSR_CIS_UPPER_BOUND 0x00000200
1533 #define IPW_DOMAIN_0_END 0x1000
1534 #define CLX_MEM_BAR_SIZE 0x1000
1535 
1536 /* Dino/baseband control registers bits */
1537 
1538 #define DINO_ENABLE_SYSTEM 0x80 /* 1 = baseband processor on, 0 = reset */
1539 #define DINO_ENABLE_CS     0x40 /* 1 = enable ucode load */
1540 #define DINO_RXFIFO_DATA   0x01 /* 1 = data available */
1541 #define IPW_BASEBAND_CONTROL_STATUS 0X00200000
1542 #define IPW_BASEBAND_TX_FIFO_WRITE  0X00200004
1543 #define IPW_BASEBAND_RX_FIFO_READ   0X00200004
1544 #define IPW_BASEBAND_CONTROL_STORE  0X00200010
1545 
1546 #define IPW_INTERNAL_CMD_EVENT  0X00300004
1547 #define IPW_BASEBAND_POWER_DOWN 0x00000001
1548 
1549 #define IPW_MEM_HALT_AND_RESET  0x003000e0
1550 
1551 /* defgroup bits_halt_reset MEM_HALT_AND_RESET register bits */
1552 #define IPW_BIT_HALT_RESET_ON   0x80000000
1553 #define IPW_BIT_HALT_RESET_OFF  0x00000000
1554 
1555 #define CB_LAST_VALID     0x20000000
1556 #define CB_INT_ENABLED    0x40000000
1557 #define CB_VALID          0x80000000
1558 #define CB_SRC_LE         0x08000000
1559 #define CB_DEST_LE        0x04000000
1560 #define CB_SRC_AUTOINC    0x00800000
1561 #define CB_SRC_IO_GATED   0x00400000
1562 #define CB_DEST_AUTOINC   0x00080000
1563 #define CB_SRC_SIZE_LONG  0x00200000
1564 #define CB_DEST_SIZE_LONG 0x00020000
1565 
1566 /* DMA DEFINES */
1567 
1568 #define DMA_CONTROL_SMALL_CB_CONST_VALUE 0x00540000
1569 #define DMA_CB_STOP_AND_ABORT            0x00000C00
1570 #define DMA_CB_START                     0x00000100
1571 
1572 #define IPW_SHARED_SRAM_SIZE               0x00030000
1573 #define IPW_SHARED_SRAM_DMA_CONTROL        0x00027000
1574 #define CB_MAX_LENGTH                      0x1FFF
1575 
1576 #define IPW_HOST_EEPROM_DATA_SRAM_SIZE 0xA18
1577 #define IPW_EEPROM_IMAGE_SIZE          0x100
1578 
1579 /* DMA defs */
1580 #define IPW_DMA_I_CURRENT_CB  0x003000D0
1581 #define IPW_DMA_O_CURRENT_CB  0x003000D4
1582 #define IPW_DMA_I_DMA_CONTROL 0x003000A4
1583 #define IPW_DMA_I_CB_BASE     0x003000A0
1584 
1585 #define IPW_TX_CMD_QUEUE_BD_BASE        0x00000200
1586 #define IPW_TX_CMD_QUEUE_BD_SIZE        0x00000204
1587 #define IPW_TX_QUEUE_0_BD_BASE          0x00000208
1588 #define IPW_TX_QUEUE_0_BD_SIZE          (0x0000020C)
1589 #define IPW_TX_QUEUE_1_BD_BASE          0x00000210
1590 #define IPW_TX_QUEUE_1_BD_SIZE          0x00000214
1591 #define IPW_TX_QUEUE_2_BD_BASE          0x00000218
1592 #define IPW_TX_QUEUE_2_BD_SIZE          (0x0000021C)
1593 #define IPW_TX_QUEUE_3_BD_BASE          0x00000220
1594 #define IPW_TX_QUEUE_3_BD_SIZE          0x00000224
1595 #define IPW_RX_BD_BASE                  0x00000240
1596 #define IPW_RX_BD_SIZE                  0x00000244
1597 #define IPW_RFDS_TABLE_LOWER            0x00000500
1598 
1599 #define IPW_TX_CMD_QUEUE_READ_INDEX     0x00000280
1600 #define IPW_TX_QUEUE_0_READ_INDEX       0x00000284
1601 #define IPW_TX_QUEUE_1_READ_INDEX       0x00000288
1602 #define IPW_TX_QUEUE_2_READ_INDEX       (0x0000028C)
1603 #define IPW_TX_QUEUE_3_READ_INDEX       0x00000290
1604 #define IPW_RX_READ_INDEX               (0x000002A0)
1605 
1606 #define IPW_TX_CMD_QUEUE_WRITE_INDEX    (0x00000F80)
1607 #define IPW_TX_QUEUE_0_WRITE_INDEX      (0x00000F84)
1608 #define IPW_TX_QUEUE_1_WRITE_INDEX      (0x00000F88)
1609 #define IPW_TX_QUEUE_2_WRITE_INDEX      (0x00000F8C)
1610 #define IPW_TX_QUEUE_3_WRITE_INDEX      (0x00000F90)
1611 #define IPW_RX_WRITE_INDEX              (0x00000FA0)
1612 
1613 /*
1614  * EEPROM Related Definitions
1615  */
1616 
1617 #define IPW_EEPROM_DATA_SRAM_ADDRESS (IPW_SHARED_LOWER_BOUND + 0x814)
1618 #define IPW_EEPROM_DATA_SRAM_SIZE    (IPW_SHARED_LOWER_BOUND + 0x818)
1619 #define IPW_EEPROM_LOAD_DISABLE      (IPW_SHARED_LOWER_BOUND + 0x81C)
1620 #define IPW_EEPROM_DATA              (IPW_SHARED_LOWER_BOUND + 0x820)
1621 #define IPW_EEPROM_UPPER_ADDRESS     (IPW_SHARED_LOWER_BOUND + 0x9E0)
1622 
1623 #define IPW_STATION_TABLE_LOWER      (IPW_SHARED_LOWER_BOUND + 0xA0C)
1624 #define IPW_STATION_TABLE_UPPER      (IPW_SHARED_LOWER_BOUND + 0xB0C)
1625 #define IPW_REQUEST_ATIM             (IPW_SHARED_LOWER_BOUND + 0xB0C)
1626 #define IPW_ATIM_SENT                (IPW_SHARED_LOWER_BOUND + 0xB10)
1627 #define IPW_WHO_IS_AWAKE             (IPW_SHARED_LOWER_BOUND + 0xB14)
1628 #define IPW_DURING_ATIM_WINDOW       (IPW_SHARED_LOWER_BOUND + 0xB18)
1629 
1630 #define MSB                             1
1631 #define LSB                             0
1632 #define WORD_TO_BYTE(_word)             ((_word) * sizeof(u16))
1633 
1634 #define GET_EEPROM_ADDR(_wordoffset,_byteoffset) \
1635     ( WORD_TO_BYTE(_wordoffset) + (_byteoffset) )
1636 
1637 /* EEPROM access by BYTE */
1638 #define EEPROM_PME_CAPABILITY   (GET_EEPROM_ADDR(0x09,MSB)) /* 1 byte   */
1639 #define EEPROM_MAC_ADDRESS      (GET_EEPROM_ADDR(0x21,LSB)) /* 6 byte   */
1640 #define EEPROM_VERSION          (GET_EEPROM_ADDR(0x24,MSB)) /* 1 byte   */
1641 #define EEPROM_NIC_TYPE         (GET_EEPROM_ADDR(0x25,LSB)) /* 1 byte   */
1642 #define EEPROM_SKU_CAPABILITY   (GET_EEPROM_ADDR(0x25,MSB)) /* 1 byte   */
1643 #define EEPROM_COUNTRY_CODE     (GET_EEPROM_ADDR(0x26,LSB)) /* 3 bytes  */
1644 #define EEPROM_IBSS_CHANNELS_BG (GET_EEPROM_ADDR(0x28,LSB)) /* 2 bytes  */
1645 #define EEPROM_IBSS_CHANNELS_A  (GET_EEPROM_ADDR(0x29,MSB)) /* 5 bytes  */
1646 #define EEPROM_BSS_CHANNELS_BG  (GET_EEPROM_ADDR(0x2c,LSB)) /* 2 bytes  */
1647 #define EEPROM_HW_VERSION       (GET_EEPROM_ADDR(0x72,LSB)) /* 2 bytes  */
1648 
1649 /* NIC type as found in the one byte EEPROM_NIC_TYPE offset */
1650 #define EEPROM_NIC_TYPE_0 0
1651 #define EEPROM_NIC_TYPE_1 1
1652 #define EEPROM_NIC_TYPE_2 2
1653 #define EEPROM_NIC_TYPE_3 3
1654 #define EEPROM_NIC_TYPE_4 4
1655 
1656 /* Bluetooth Coexistence capabilities as found in EEPROM_SKU_CAPABILITY */
1657 #define EEPROM_SKU_CAP_BT_CHANNEL_SIG  0x01 /* we can tell BT our channel # */
1658 #define EEPROM_SKU_CAP_BT_PRIORITY     0x02 /* BT can take priority over us */
1659 #define EEPROM_SKU_CAP_BT_OOB          0x04 /* we can signal BT out-of-band */
1660 
1661 #define FW_MEM_REG_LOWER_BOUND          0x00300000
1662 #define FW_MEM_REG_EEPROM_ACCESS        (FW_MEM_REG_LOWER_BOUND + 0x40)
1663 #define IPW_EVENT_REG                   (FW_MEM_REG_LOWER_BOUND + 0x04)
1664 #define EEPROM_BIT_SK                   (1<<0)
1665 #define EEPROM_BIT_CS                   (1<<1)
1666 #define EEPROM_BIT_DI                   (1<<2)
1667 #define EEPROM_BIT_DO                   (1<<4)
1668 
1669 #define EEPROM_CMD_READ                 0x2
1670 
1671 /* Interrupts masks */
1672 #define IPW_INTA_NONE   0x00000000
1673 
1674 #define IPW_INTA_BIT_RX_TRANSFER                   0x00000002
1675 #define IPW_INTA_BIT_STATUS_CHANGE                 0x00000010
1676 #define IPW_INTA_BIT_BEACON_PERIOD_EXPIRED         0x00000020
1677 
1678 //Inta Bits for CF
1679 #define IPW_INTA_BIT_TX_CMD_QUEUE                  0x00000800
1680 #define IPW_INTA_BIT_TX_QUEUE_1                    0x00001000
1681 #define IPW_INTA_BIT_TX_QUEUE_2                    0x00002000
1682 #define IPW_INTA_BIT_TX_QUEUE_3                    0x00004000
1683 #define IPW_INTA_BIT_TX_QUEUE_4                    0x00008000
1684 
1685 #define IPW_INTA_BIT_SLAVE_MODE_HOST_CMD_DONE      0x00010000
1686 
1687 #define IPW_INTA_BIT_PREPARE_FOR_POWER_DOWN        0x00100000
1688 #define IPW_INTA_BIT_POWER_DOWN                    0x00200000
1689 
1690 #define IPW_INTA_BIT_FW_INITIALIZATION_DONE        0x01000000
1691 #define IPW_INTA_BIT_FW_CARD_DISABLE_PHY_OFF_DONE  0x02000000
1692 #define IPW_INTA_BIT_RF_KILL_DONE                  0x04000000
1693 #define IPW_INTA_BIT_FATAL_ERROR             0x40000000
1694 #define IPW_INTA_BIT_PARITY_ERROR            0x80000000
1695 
1696 /* Interrupts enabled at init time. */
1697 #define IPW_INTA_MASK_ALL                        \
1698         (IPW_INTA_BIT_TX_QUEUE_1               | \
1699      IPW_INTA_BIT_TX_QUEUE_2               | \
1700      IPW_INTA_BIT_TX_QUEUE_3               | \
1701      IPW_INTA_BIT_TX_QUEUE_4               | \
1702      IPW_INTA_BIT_TX_CMD_QUEUE             | \
1703      IPW_INTA_BIT_RX_TRANSFER              | \
1704      IPW_INTA_BIT_FATAL_ERROR              | \
1705      IPW_INTA_BIT_PARITY_ERROR             | \
1706      IPW_INTA_BIT_STATUS_CHANGE            | \
1707      IPW_INTA_BIT_FW_INITIALIZATION_DONE   | \
1708      IPW_INTA_BIT_BEACON_PERIOD_EXPIRED    | \
1709      IPW_INTA_BIT_SLAVE_MODE_HOST_CMD_DONE | \
1710      IPW_INTA_BIT_PREPARE_FOR_POWER_DOWN   | \
1711      IPW_INTA_BIT_POWER_DOWN               | \
1712          IPW_INTA_BIT_RF_KILL_DONE )
1713 
1714 /* FW event log definitions */
1715 #define EVENT_ELEM_SIZE     (3 * sizeof(u32))
1716 #define EVENT_START_OFFSET  (1 * sizeof(u32) + 2 * sizeof(u16))
1717 
1718 /* FW error log definitions */
1719 #define ERROR_ELEM_SIZE     (7 * sizeof(u32))
1720 #define ERROR_START_OFFSET  (1 * sizeof(u32))
1721 
1722 /* TX power level (dbm) */
1723 #define IPW_TX_POWER_MIN    -12
1724 #define IPW_TX_POWER_MAX    20
1725 #define IPW_TX_POWER_DEFAULT    IPW_TX_POWER_MAX
1726 
1727 enum {
1728     IPW_FW_ERROR_OK = 0,
1729     IPW_FW_ERROR_FAIL,
1730     IPW_FW_ERROR_MEMORY_UNDERFLOW,
1731     IPW_FW_ERROR_MEMORY_OVERFLOW,
1732     IPW_FW_ERROR_BAD_PARAM,
1733     IPW_FW_ERROR_BAD_CHECKSUM,
1734     IPW_FW_ERROR_NMI_INTERRUPT,
1735     IPW_FW_ERROR_BAD_DATABASE,
1736     IPW_FW_ERROR_ALLOC_FAIL,
1737     IPW_FW_ERROR_DMA_UNDERRUN,
1738     IPW_FW_ERROR_DMA_STATUS,
1739     IPW_FW_ERROR_DINO_ERROR,
1740     IPW_FW_ERROR_EEPROM_ERROR,
1741     IPW_FW_ERROR_SYSASSERT,
1742     IPW_FW_ERROR_FATAL_ERROR
1743 };
1744 
1745 #define AUTH_OPEN   0
1746 #define AUTH_SHARED_KEY 1
1747 #define AUTH_LEAP   2
1748 #define AUTH_IGNORE 3
1749 
1750 #define HC_ASSOCIATE      0
1751 #define HC_REASSOCIATE    1
1752 #define HC_DISASSOCIATE   2
1753 #define HC_IBSS_START     3
1754 #define HC_IBSS_RECONF    4
1755 #define HC_DISASSOC_QUIET 5
1756 
1757 #define HC_QOS_SUPPORT_ASSOC  cpu_to_le16(0x01)
1758 
1759 #define IPW_RATE_CAPABILITIES 1
1760 #define IPW_RATE_CONNECT      0
1761 
1762 /*
1763  * Rate values and masks
1764  */
1765 #define IPW_TX_RATE_1MB  0x0A
1766 #define IPW_TX_RATE_2MB  0x14
1767 #define IPW_TX_RATE_5MB  0x37
1768 #define IPW_TX_RATE_6MB  0x0D
1769 #define IPW_TX_RATE_9MB  0x0F
1770 #define IPW_TX_RATE_11MB 0x6E
1771 #define IPW_TX_RATE_12MB 0x05
1772 #define IPW_TX_RATE_18MB 0x07
1773 #define IPW_TX_RATE_24MB 0x09
1774 #define IPW_TX_RATE_36MB 0x0B
1775 #define IPW_TX_RATE_48MB 0x01
1776 #define IPW_TX_RATE_54MB 0x03
1777 
1778 #define IPW_ORD_TABLE_ID_MASK             0x0000FF00
1779 #define IPW_ORD_TABLE_VALUE_MASK          0x000000FF
1780 
1781 #define IPW_ORD_TABLE_0_MASK              0x0000F000
1782 #define IPW_ORD_TABLE_1_MASK              0x0000F100
1783 #define IPW_ORD_TABLE_2_MASK              0x0000F200
1784 #define IPW_ORD_TABLE_3_MASK              0x0000F300
1785 #define IPW_ORD_TABLE_4_MASK              0x0000F400
1786 #define IPW_ORD_TABLE_5_MASK              0x0000F500
1787 #define IPW_ORD_TABLE_6_MASK              0x0000F600
1788 #define IPW_ORD_TABLE_7_MASK              0x0000F700
1789 
1790 /*
1791  * Table 0 Entries (all entries are 32 bits)
1792  */
1793 enum {
1794     IPW_ORD_STAT_TX_CURR_RATE = IPW_ORD_TABLE_0_MASK + 1,
1795     IPW_ORD_STAT_FRAG_TRESHOLD,
1796     IPW_ORD_STAT_RTS_THRESHOLD,
1797     IPW_ORD_STAT_TX_HOST_REQUESTS,
1798     IPW_ORD_STAT_TX_HOST_COMPLETE,
1799     IPW_ORD_STAT_TX_DIR_DATA,
1800     IPW_ORD_STAT_TX_DIR_DATA_B_1,
1801     IPW_ORD_STAT_TX_DIR_DATA_B_2,
1802     IPW_ORD_STAT_TX_DIR_DATA_B_5_5,
1803     IPW_ORD_STAT_TX_DIR_DATA_B_11,
1804     /* Hole */
1805 
1806     IPW_ORD_STAT_TX_DIR_DATA_G_1 = IPW_ORD_TABLE_0_MASK + 19,
1807     IPW_ORD_STAT_TX_DIR_DATA_G_2,
1808     IPW_ORD_STAT_TX_DIR_DATA_G_5_5,
1809     IPW_ORD_STAT_TX_DIR_DATA_G_6,
1810     IPW_ORD_STAT_TX_DIR_DATA_G_9,
1811     IPW_ORD_STAT_TX_DIR_DATA_G_11,
1812     IPW_ORD_STAT_TX_DIR_DATA_G_12,
1813     IPW_ORD_STAT_TX_DIR_DATA_G_18,
1814     IPW_ORD_STAT_TX_DIR_DATA_G_24,
1815     IPW_ORD_STAT_TX_DIR_DATA_G_36,
1816     IPW_ORD_STAT_TX_DIR_DATA_G_48,
1817     IPW_ORD_STAT_TX_DIR_DATA_G_54,
1818     IPW_ORD_STAT_TX_NON_DIR_DATA,
1819     IPW_ORD_STAT_TX_NON_DIR_DATA_B_1,
1820     IPW_ORD_STAT_TX_NON_DIR_DATA_B_2,
1821     IPW_ORD_STAT_TX_NON_DIR_DATA_B_5_5,
1822     IPW_ORD_STAT_TX_NON_DIR_DATA_B_11,
1823     /* Hole */
1824 
1825     IPW_ORD_STAT_TX_NON_DIR_DATA_G_1 = IPW_ORD_TABLE_0_MASK + 44,
1826     IPW_ORD_STAT_TX_NON_DIR_DATA_G_2,
1827     IPW_ORD_STAT_TX_NON_DIR_DATA_G_5_5,
1828     IPW_ORD_STAT_TX_NON_DIR_DATA_G_6,
1829     IPW_ORD_STAT_TX_NON_DIR_DATA_G_9,
1830     IPW_ORD_STAT_TX_NON_DIR_DATA_G_11,
1831     IPW_ORD_STAT_TX_NON_DIR_DATA_G_12,
1832     IPW_ORD_STAT_TX_NON_DIR_DATA_G_18,
1833     IPW_ORD_STAT_TX_NON_DIR_DATA_G_24,
1834     IPW_ORD_STAT_TX_NON_DIR_DATA_G_36,
1835     IPW_ORD_STAT_TX_NON_DIR_DATA_G_48,
1836     IPW_ORD_STAT_TX_NON_DIR_DATA_G_54,
1837     IPW_ORD_STAT_TX_RETRY,
1838     IPW_ORD_STAT_TX_FAILURE,
1839     IPW_ORD_STAT_RX_ERR_CRC,
1840     IPW_ORD_STAT_RX_ERR_ICV,
1841     IPW_ORD_STAT_RX_NO_BUFFER,
1842     IPW_ORD_STAT_FULL_SCANS,
1843     IPW_ORD_STAT_PARTIAL_SCANS,
1844     IPW_ORD_STAT_TGH_ABORTED_SCANS,
1845     IPW_ORD_STAT_TX_TOTAL_BYTES,
1846     IPW_ORD_STAT_CURR_RSSI_RAW,
1847     IPW_ORD_STAT_RX_BEACON,
1848     IPW_ORD_STAT_MISSED_BEACONS,
1849     IPW_ORD_TABLE_0_LAST
1850 };
1851 
1852 #define IPW_RSSI_TO_DBM 112
1853 
1854 /* Table 1 Entries
1855  */
1856 enum {
1857     IPW_ORD_TABLE_1_LAST = IPW_ORD_TABLE_1_MASK | 1,
1858 };
1859 
1860 /*
1861  * Table 2 Entries
1862  *
1863  * FW_VERSION:    16 byte string
1864  * FW_DATE:       16 byte string (only 14 bytes used)
1865  * UCODE_VERSION: 4 byte version code
1866  * UCODE_DATE:    5 bytes code code
1867  * ADDAPTER_MAC:  6 byte MAC address
1868  * RTC:           4 byte clock
1869  */
1870 enum {
1871     IPW_ORD_STAT_FW_VERSION = IPW_ORD_TABLE_2_MASK | 1,
1872     IPW_ORD_STAT_FW_DATE,
1873     IPW_ORD_STAT_UCODE_VERSION,
1874     IPW_ORD_STAT_UCODE_DATE,
1875     IPW_ORD_STAT_ADAPTER_MAC,
1876     IPW_ORD_STAT_RTC,
1877     IPW_ORD_TABLE_2_LAST
1878 };
1879 
1880 /* Table 3 */
1881 enum {
1882     IPW_ORD_STAT_TX_PACKET = IPW_ORD_TABLE_3_MASK | 0,
1883     IPW_ORD_STAT_TX_PACKET_FAILURE,
1884     IPW_ORD_STAT_TX_PACKET_SUCCESS,
1885     IPW_ORD_STAT_TX_PACKET_ABORTED,
1886     IPW_ORD_TABLE_3_LAST
1887 };
1888 
1889 /* Table 4 */
1890 enum {
1891     IPW_ORD_TABLE_4_LAST = IPW_ORD_TABLE_4_MASK
1892 };
1893 
1894 /* Table 5 */
1895 enum {
1896     IPW_ORD_STAT_AVAILABLE_AP_COUNT = IPW_ORD_TABLE_5_MASK,
1897     IPW_ORD_STAT_AP_ASSNS,
1898     IPW_ORD_STAT_ROAM,
1899     IPW_ORD_STAT_ROAM_CAUSE_MISSED_BEACONS,
1900     IPW_ORD_STAT_ROAM_CAUSE_UNASSOC,
1901     IPW_ORD_STAT_ROAM_CAUSE_RSSI,
1902     IPW_ORD_STAT_ROAM_CAUSE_LINK_QUALITY,
1903     IPW_ORD_STAT_ROAM_CAUSE_AP_LOAD_BALANCE,
1904     IPW_ORD_STAT_ROAM_CAUSE_AP_NO_TX,
1905     IPW_ORD_STAT_LINK_UP,
1906     IPW_ORD_STAT_LINK_DOWN,
1907     IPW_ORD_ANTENNA_DIVERSITY,
1908     IPW_ORD_CURR_FREQ,
1909     IPW_ORD_TABLE_5_LAST
1910 };
1911 
1912 /* Table 6 */
1913 enum {
1914     IPW_ORD_COUNTRY_CODE = IPW_ORD_TABLE_6_MASK,
1915     IPW_ORD_CURR_BSSID,
1916     IPW_ORD_CURR_SSID,
1917     IPW_ORD_TABLE_6_LAST
1918 };
1919 
1920 /* Table 7 */
1921 enum {
1922     IPW_ORD_STAT_PERCENT_MISSED_BEACONS = IPW_ORD_TABLE_7_MASK,
1923     IPW_ORD_STAT_PERCENT_TX_RETRIES,
1924     IPW_ORD_STAT_PERCENT_LINK_QUALITY,
1925     IPW_ORD_STAT_CURR_RSSI_DBM,
1926     IPW_ORD_TABLE_7_LAST
1927 };
1928 
1929 #define IPW_ERROR_LOG     (IPW_SHARED_LOWER_BOUND + 0x410)
1930 #define IPW_EVENT_LOG     (IPW_SHARED_LOWER_BOUND + 0x414)
1931 #define IPW_ORDINALS_TABLE_LOWER        (IPW_SHARED_LOWER_BOUND + 0x500)
1932 #define IPW_ORDINALS_TABLE_0            (IPW_SHARED_LOWER_BOUND + 0x180)
1933 #define IPW_ORDINALS_TABLE_1            (IPW_SHARED_LOWER_BOUND + 0x184)
1934 #define IPW_ORDINALS_TABLE_2            (IPW_SHARED_LOWER_BOUND + 0x188)
1935 #define IPW_MEM_FIXED_OVERRIDE          (IPW_SHARED_LOWER_BOUND + 0x41C)
1936 
1937 struct ipw_fixed_rate {
1938     __le16 tx_rates;
1939     __le16 reserved;
1940 } __packed;
1941 
1942 #define IPW_INDIRECT_ADDR_MASK (~0x3ul)
1943 
1944 struct host_cmd {
1945     u8 cmd;
1946     u8 len;
1947     u16 reserved;
1948     const u32 *param;
1949 } __packed; /* XXX */
1950 
1951 struct cmdlog_host_cmd {
1952     u8 cmd;
1953     u8 len;
1954     __le16 reserved;
1955     char param[124];
1956 } __packed;
1957 
1958 struct ipw_cmd_log {
1959     unsigned long jiffies;
1960     int retcode;
1961     struct cmdlog_host_cmd cmd;
1962 };
1963 
1964 /* SysConfig command parameters ... */
1965 /* bt_coexistence param */
1966 #define CFG_BT_COEXISTENCE_SIGNAL_CHNL  0x01    /* tell BT our chnl # */
1967 #define CFG_BT_COEXISTENCE_DEFER        0x02    /* defer our Tx if BT traffic */
1968 #define CFG_BT_COEXISTENCE_KILL         0x04    /* kill our Tx if BT traffic */
1969 #define CFG_BT_COEXISTENCE_WME_OVER_BT  0x08    /* multimedia extensions */
1970 #define CFG_BT_COEXISTENCE_OOB          0x10    /* signal BT via out-of-band */
1971 
1972 /* clear-to-send to self param */
1973 #define CFG_CTS_TO_ITSELF_ENABLED_MIN   0x00
1974 #define CFG_CTS_TO_ITSELF_ENABLED_MAX   0x01
1975 #define CFG_CTS_TO_ITSELF_ENABLED_DEF   CFG_CTS_TO_ITSELF_ENABLED_MIN
1976 
1977 /* Antenna diversity param (h/w can select best antenna, based on signal) */
1978 #define CFG_SYS_ANTENNA_BOTH            0x00    /* NIC selects best antenna */
1979 #define CFG_SYS_ANTENNA_A               0x01    /* force antenna A */
1980 #define CFG_SYS_ANTENNA_B               0x03    /* force antenna B */
1981 #define CFG_SYS_ANTENNA_SLOW_DIV        0x02    /* consider background noise */
1982 
1983 #define IPW_MAX_CONFIG_RETRIES 10
1984 
1985 #endif              /* __ipw2200_h__ */