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