package/libertas/src/defs.h

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