drivers/net/wireless/libertas/defs.h

   1 /**
   2   * This header file contains global constant/enum definitions,
   3   * global variable declaration.
   4   */
   5 #ifndef _WLAN_DEFS_H_
   6 #define _WLAN_DEFS_H_
   7
   8 #include <linux/spinlock.h>
   9
  10 #ifdef CONFIG_LIBERTAS_DEBUG
  11 #define DEBUG
  12 #define PROC_DEBUG
  13 #endif
  14
  15 #ifndef DRV_NAME
  16 #define DRV_NAME "libertas"
  17 #endif
  18
  19
  20 #define LBS_DEB_ENTER   0x00000001
  21 #define LBS_DEB_LEAVE   0x00000002
  22 #define LBS_DEB_MAIN    0x00000004
  23 #define LBS_DEB_NET     0x00000008
  24 #define LBS_DEB_MESH    0x00000010
  25 #define LBS_DEB_WEXT    0x00000020
  26 #define LBS_DEB_IOCTL   0x00000040
  27 #define LBS_DEB_SCAN    0x00000080
  28 #define LBS_DEB_ASSOC   0x00000100
  29 #define LBS_DEB_JOIN    0x00000200
  30 #define LBS_DEB_11D     0x00000400
  31 #define LBS_DEB_DEBUGFS 0x00000800
  32 #define LBS_DEB_ETHTOOL 0x00001000
  33 #define LBS_DEB_HOST    0x00002000
  34 #define LBS_DEB_CMD     0x00004000
  35 #define LBS_DEB_RX      0x00008000
  36 #define LBS_DEB_TX      0x00010000
  37 #define LBS_DEB_USB     0x00020000
  38 #define LBS_DEB_CS      0x00040000
  39 #define LBS_DEB_FW      0x00080000
  40 #define LBS_DEB_THREAD  0x00100000
  41 #define LBS_DEB_HEX     0x00200000
  42
  43 extern unsigned int libertas_debug;
  44
  45 #ifdef DEBUG
  46 #define LBS_DEB_LL(grp, fmt, args...) \
  47 do { if ((libertas_debug & (grp)) == (grp)) \
  48   printk(KERN_DEBUG DRV_NAME "%s: " fmt, \
  49          in_interrupt() ? " (INT)" : "", ## args); } while (0)
  50 #else
  51 #define LBS_DEB_LL(grp, fmt, args...) do {} while (0)
  52 #endif
  53
  54 #define lbs_deb_enter(grp) \
  55   LBS_DEB_LL(grp | LBS_DEB_ENTER, "%s():%d enter\n", __FUNCTION__, __LINE__);
  56 #define lbs_deb_enter_args(grp, fmt, args...) \
  57   LBS_DEB_LL(grp | LBS_DEB_ENTER, "%s(" fmt "):%d\n", __FUNCTION__, ## args, __LINE__);
  58 #define lbs_deb_leave(grp) \
  59   LBS_DEB_LL(grp | LBS_DEB_LEAVE, "%s():%d leave\n", __FUNCTION__, __LINE__);
  60 #define lbs_deb_leave_args(grp, fmt, args...) \
  61   LBS_DEB_LL(grp | LBS_DEB_LEAVE, "%s():%d leave, " fmt "\n", \
  62   __FUNCTION__, __LINE__, ##args);
  63 #define lbs_deb_main(fmt, args...)      LBS_DEB_LL(LBS_DEB_MAIN, fmt, ##args)
  64 #define lbs_deb_net(fmt, args...)       LBS_DEB_LL(LBS_DEB_NET, fmt, ##args)
  65 #define lbs_deb_mesh(fmt, args...)      LBS_DEB_LL(LBS_DEB_MESH, fmt, ##args)
  66 #define lbs_deb_wext(fmt, args...)      LBS_DEB_LL(LBS_DEB_WEXT, fmt, ##args)
  67 #define lbs_deb_ioctl(fmt, args...)     LBS_DEB_LL(LBS_DEB_IOCTL, fmt, ##args)
  68 #define lbs_deb_scan(fmt, args...)      LBS_DEB_LL(LBS_DEB_SCAN, fmt, ##args)
  69 #define lbs_deb_assoc(fmt, args...)     LBS_DEB_LL(LBS_DEB_ASSOC, fmt, ##args)
  70 #define lbs_deb_join(fmt, args...)      LBS_DEB_LL(LBS_DEB_JOIN, fmt, ##args)
  71 #define lbs_deb_11d(fmt, args...)       LBS_DEB_LL(LBS_DEB_11D, fmt, ##args)
  72 #define lbs_deb_debugfs(fmt, args...)   LBS_DEB_LL(LBS_DEB_DEBUGFS, fmt, ##args)
  73 #define lbs_deb_ethtool(fmt, args...)   LBS_DEB_LL(LBS_DEB_ETHTOOL, fmt, ##args)
  74 #define lbs_deb_host(fmt, args...)      LBS_DEB_LL(LBS_DEB_HOST, fmt, ##args)
  75 #define lbs_deb_cmd(fmt, args...)       LBS_DEB_LL(LBS_DEB_CMD, fmt, ##args)
  76 #define lbs_deb_rx(fmt, args...)        LBS_DEB_LL(LBS_DEB_RX, fmt, ##args)
  77 #define lbs_deb_tx(fmt, args...)        LBS_DEB_LL(LBS_DEB_TX, fmt, ##args)
  78 #define lbs_deb_fw(fmt, args...)        LBS_DEB_LL(LBS_DEB_FW, fmt, ##args)
  79 #define lbs_deb_usb(fmt, args...)       LBS_DEB_LL(LBS_DEB_USB, fmt, ##args)
  80 #define lbs_deb_usbd(dev, fmt, args...) LBS_DEB_LL(LBS_DEB_USB, "%s:" fmt, (dev)->bus_id, ##args)
  81 #define lbs_deb_cs(fmt, args...)        LBS_DEB_LL(LBS_DEB_CS, fmt, ##args)
  82 #define lbs_deb_thread(fmt, args...)    LBS_DEB_LL(LBS_DEB_THREAD, fmt, ##args)
  83
  84 #define lbs_pr_info(format, args...) \
  85         printk(KERN_INFO DRV_NAME": " format, ## args)
  86 #define lbs_pr_err(format, args...) \
  87         printk(KERN_ERR DRV_NAME": " format, ## args)
  88 #define lbs_pr_alert(format, args...) \
  89         printk(KERN_ALERT DRV_NAME": " format, ## args)
  90
  91 #ifdef DEBUG
  92 static inline void lbs_dbg_hex(char *prompt, u8 * buf, int len)
  93 {
  94         int i = 0;
  95
  96         if (!(libertas_debug & LBS_DEB_HEX))
  97                 return;
  98
  99         printk(KERN_DEBUG "%s: ", prompt);
 100         for (i = 1; i <= len; i++) {
 101                 printk("%02x ", (u8) * buf);
 102                 buf++;
 103         }
 104         printk("\n");
 105 }
 106 #else
 107 #define lbs_dbg_hex(x,y,z)                              do {} while (0)
 108 #endif
 109
 110
 111
 112 /** Buffer Constants */
 113
 114 /*      The size of SQ memory PPA, DPA are 8 DWORDs, that keep the physical
 115 *       addresses of TxPD buffers. Station has only 8 TxPD available, Whereas
 116 *       driver has more local TxPDs. Each TxPD on the host memory is associated
 117 *       with a Tx control node. The driver maintains 8 RxPD descriptors for
 118 *       station firmware to store Rx packet information.
 119 *
 120 *       Current version of MAC has a 32x6 multicast address buffer.
 121 *
 122 *       802.11b can have up to  14 channels, the driver keeps the
 123 *       BSSID(MAC address) of each APs or Ad hoc stations it has sensed.
 124 */
 125
 126 #define MRVDRV_MAX_MULTICAST_LIST_SIZE  32
 127 #define MRVDRV_NUM_OF_CMD_BUFFER        10
 128 #define MRVDRV_SIZE_OF_CMD_BUFFER       (2 * 1024)
 129 #define MRVDRV_MAX_CHANNEL_SIZE         14
 130 #define MRVDRV_ASSOCIATION_TIME_OUT     255
 131 #define MRVDRV_SNAP_HEADER_LEN          8
 132
 133 #define WLAN_UPLD_SIZE                  2312
 134 #define DEV_NAME_LEN                    32
 135
 136 /** Misc constants */
 137 /* This section defines 802.11 specific contants */
 138
 139 #define MRVDRV_MAX_BSS_DESCRIPTS                16
 140 #define MRVDRV_MAX_REGION_CODE                  6
 141
 142 #define MRVDRV_IGNORE_MULTIPLE_DTIM             0xfffe
 143 #define MRVDRV_MIN_MULTIPLE_DTIM                1
 144 #define MRVDRV_MAX_MULTIPLE_DTIM                5
 145 #define MRVDRV_DEFAULT_MULTIPLE_DTIM            1
 146
 147 #define MRVDRV_DEFAULT_LISTEN_INTERVAL          10
 148
 149 #define MRVDRV_CHANNELS_PER_SCAN                4
 150 #define MRVDRV_MAX_CHANNELS_PER_SCAN            14
 151
 152 #define MRVDRV_DEBUG_RX_PATH            0x00000001
 153 #define MRVDRV_DEBUG_TX_PATH            0x00000002
 154
 155 #define MRVDRV_MIN_BEACON_INTERVAL              20
 156 #define MRVDRV_MAX_BEACON_INTERVAL              1000
 157 #define MRVDRV_BEACON_INTERVAL                  100
 158
 159 #define MARVELL_MESH_IE_LENGTH          9
 160
 161 /** INT status Bit Definition*/
 162 #define his_cmddnldrdy                  0x01
 163 #define his_cardevent                   0x02
 164 #define his_cmdupldrdy                  0x04
 165
 166 #define SBI_EVENT_CAUSE_SHIFT           3
 167
 168 /** TxPD status */
 169
 170 /*      Station firmware use TxPD status field to report final Tx transmit
 171 *       result, Bit masks are used to present combined situations.
 172 */
 173
 174 #define MRVDRV_TxPD_POWER_MGMT_NULL_PACKET 0x01
 175 #define MRVDRV_TxPD_POWER_MGMT_LAST_PACKET 0x08
 176
 177 /** Tx mesh flag */
 178 /* Currently we are using normal WDS flag as mesh flag.
 179  * TODO: change to proper mesh flag when MAC understands it.
 180  */
 181 #define TxPD_CONTROL_WDS_FRAME (1<<17)
 182 #define TxPD_MESH_FRAME TxPD_CONTROL_WDS_FRAME
 183
 184 /** RxPD status */
 185
 186 #define MRVDRV_RXPD_STATUS_OK                0x0001
 187
 188 /** RxPD status - Received packet types */
 189 /** Rx mesh flag */
 190 /* Currently we are using normal WDS flag as mesh flag.
 191  * TODO: change to proper mesh flag when MAC understands it.
 192  */
 193 #define RxPD_CONTROL_WDS_FRAME (0x40)
 194 #define RxPD_MESH_FRAME RxPD_CONTROL_WDS_FRAME
 195
 196 /** RSSI-related defines */
 197 /*      RSSI constants are used to implement 802.11 RSSI threshold
 198 *       indication. if the Rx packet signal got too weak for 5 consecutive
 199 *       times, miniport driver (driver) will report this event to wrapper
 200 */
 201
 202 #define MRVDRV_NF_DEFAULT_SCAN_VALUE            (-96)
 203
 204 /** RTS/FRAG related defines */
 205 #define MRVDRV_RTS_MIN_VALUE            0
 206 #define MRVDRV_RTS_MAX_VALUE            2347
 207 #define MRVDRV_FRAG_MIN_VALUE           256
 208 #define MRVDRV_FRAG_MAX_VALUE           2346
 209
 210 /* This is for firmware specific length */
 211 #define EXTRA_LEN       36
 212
 213 #define MRVDRV_ETH_TX_PACKET_BUFFER_SIZE \
 214         (ETH_FRAME_LEN + sizeof(struct txpd) + EXTRA_LEN)
 215
 216 #define MRVDRV_ETH_RX_PACKET_BUFFER_SIZE \
 217         (ETH_FRAME_LEN + sizeof(struct rxpd) \
 218          + MRVDRV_SNAP_HEADER_LEN + EXTRA_LEN)
 219
 220 #define CMD_F_HOSTCMD           (1 << 0)
 221 #define FW_CAPINFO_WPA          (1 << 0)
 222
 223 #define KEY_LEN_WPA_AES                 16
 224 #define KEY_LEN_WPA_TKIP                32
 225 #define KEY_LEN_WEP_104                 13
 226 #define KEY_LEN_WEP_40                  5
 227
 228 #define RF_ANTENNA_1            0x1
 229 #define RF_ANTENNA_2            0x2
 230 #define RF_ANTENNA_AUTO         0xFFFF
 231
 232 #define BAND_B                  (0x01)
 233 #define BAND_G                  (0x02)
 234 #define ALL_802_11_BANDS        (BAND_B | BAND_G)
 235
 236 /** MACRO DEFINITIONS */
 237 #define CAL_NF(NF)                      ((s32)(-(s32)(NF)))
 238 #define CAL_RSSI(SNR, NF)               ((s32)((s32)(SNR) + CAL_NF(NF)))
 239 #define SCAN_RSSI(RSSI)                 (0x100 - ((u8)(RSSI)))
 240
 241 #define DEFAULT_BCN_AVG_FACTOR          8
 242 #define DEFAULT_DATA_AVG_FACTOR         8
 243 #define AVG_SCALE                       100
 244 #define CAL_AVG_SNR_NF(AVG, SNRNF, N)         \
 245                         (((AVG) == 0) ? ((u16)(SNRNF) * AVG_SCALE) : \
 246                         ((((int)(AVG) * (N -1)) + ((u16)(SNRNF) * \
 247                         AVG_SCALE))  / N))
 248
 249 #define MAX_RATES                       14
 250
 251 #define MAX_LEDS                        8
 252
 253 #define IS_MESH_FRAME(x) (x->cb[6])
 254 #define SET_MESH_FRAME(x) (x->cb[6]=1)
 255 #define UNSET_MESH_FRAME(x) (x->cb[6]=0)
 256
 257 /** Global Variable Declaration */
 258 typedef struct _wlan_private wlan_private;
 259 typedef struct _wlan_adapter wlan_adapter;
 260 extern const char libertas_driver_version[];
 261 extern u16 libertas_region_code_to_index[MRVDRV_MAX_REGION_CODE];
 262
 263 extern u8 libertas_bg_rates[MAX_RATES];
 264
 265 /** ENUM definition*/
 266 /** SNRNF_TYPE */
 267 enum SNRNF_TYPE {
 268         TYPE_BEACON = 0,
 269         TYPE_RXPD,
 270         MAX_TYPE_B
 271 };
 272
 273 /** SNRNF_DATA*/
 274 enum SNRNF_DATA {
 275         TYPE_NOAVG = 0,
 276         TYPE_AVG,
 277         MAX_TYPE_AVG
 278 };
 279
 280 /** WLAN_802_11_POWER_MODE */
 281 enum WLAN_802_11_POWER_MODE {
 282         WLAN802_11POWERMODECAM,
 283         WLAN802_11POWERMODEMAX_PSP,
 284         WLAN802_11POWERMODEFAST_PSP,
 285         /*not a real mode, defined as an upper bound */
 286         WLAN802_11POWEMODEMAX
 287 };
 288
 289 /** PS_STATE */
 290 enum PS_STATE {
 291         PS_STATE_FULL_POWER,
 292         PS_STATE_AWAKE,
 293         PS_STATE_PRE_SLEEP,
 294         PS_STATE_SLEEP
 295 };
 296
 297 /** DNLD_STATE */
 298 enum DNLD_STATE {
 299         DNLD_RES_RECEIVED,
 300         DNLD_DATA_SENT,
 301         DNLD_CMD_SENT
 302 };
 303
 304 /** WLAN_MEDIA_STATE */
 305 enum WLAN_MEDIA_STATE {
 306         LIBERTAS_CONNECTED,
 307         LIBERTAS_DISCONNECTED
 308 };
 309
 310 /** WLAN_802_11_PRIVACY_FILTER */
 311 enum WLAN_802_11_PRIVACY_FILTER {
 312         WLAN802_11PRIVFILTERACCEPTALL,
 313         WLAN802_11PRIVFILTER8021XWEP
 314 };
 315
 316 /** mv_ms_type */
 317 enum mv_ms_type {
 318         MVMS_DAT = 0,
 319         MVMS_CMD = 1,
 320         MVMS_TXDONE = 2,
 321         MVMS_EVENT
 322 };
 323
 324 /** SNMP_MIB_INDEX_e */
 325 enum SNMP_MIB_INDEX_e {
 326         DESIRED_BSSTYPE_I = 0,
 327         OP_RATESET_I,
 328         BCNPERIOD_I,
 329         DTIMPERIOD_I,
 330         ASSOCRSP_TIMEOUT_I,
 331         RTSTHRESH_I,
 332         SHORT_RETRYLIM_I,
 333         LONG_RETRYLIM_I,
 334         FRAGTHRESH_I,
 335         DOT11D_I,
 336         DOT11H_I,
 337         MANUFID_I,
 338         PRODID_I,
 339         MANUF_OUI_I,
 340         MANUF_NAME_I,
 341         MANUF_PRODNAME_I,
 342         MANUF_PRODVER_I,
 343 };
 344
 345 /** KEY_TYPE_ID */
 346 enum KEY_TYPE_ID {
 347         KEY_TYPE_ID_WEP = 0,
 348         KEY_TYPE_ID_TKIP,
 349         KEY_TYPE_ID_AES
 350 };
 351
 352 /** KEY_INFO_WPA (applies to both TKIP and AES/CCMP) */
 353 enum KEY_INFO_WPA {
 354         KEY_INFO_WPA_MCAST = 0x01,
 355         KEY_INFO_WPA_UNICAST = 0x02,
 356         KEY_INFO_WPA_ENABLED = 0x04
 357 };
 358
 359 /** SNMP_MIB_VALUE_e */
 360 enum SNMP_MIB_VALUE_e {
 361         SNMP_MIB_VALUE_INFRA = 1,
 362         SNMP_MIB_VALUE_ADHOC
 363 };
 364
 365 /* Default values for fwt commands. */
 366 #define FWT_DEFAULT_METRIC 0
 367 #define FWT_DEFAULT_DIR 1
 368 /* Default Rate, 11Mbps */
 369 #define FWT_DEFAULT_RATE 3
 370 #define FWT_DEFAULT_SSN 0xffffffff
 371 #define FWT_DEFAULT_DSN 0
 372 #define FWT_DEFAULT_HOPCOUNT 0
 373 #define FWT_DEFAULT_TTL 0
 374 #define FWT_DEFAULT_EXPIRATION 0
 375 #define FWT_DEFAULT_SLEEPMODE 0
 376 #define FWT_DEFAULT_SNR 0
 377
 378 #endif                          /* _WLAN_DEFS_H_ */