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 #define LBS_DEB_CFG80211 0x02000000
  46
  47 extern unsigned int lbs_debug;
  48
  49 #ifdef DEBUG
  50 #define LBS_DEB_LL(grp, grpnam, fmt, args...) \
  51 do { if ((lbs_debug & (grp)) == (grp)) \
  52   printk(KERN_DEBUG DRV_NAME grpnam "%s: " fmt, \
  53          in_interrupt() ? " (INT)" : "", ## args); } while (0)
  54 #else
  55 #define LBS_DEB_LL(grp, grpnam, fmt, args...) do {} while (0)
  56 #endif
  57
  58 #define lbs_deb_enter(grp) \
  59   LBS_DEB_LL(grp | LBS_DEB_ENTER, " enter", "%s()\n", __func__);
  60 #define lbs_deb_enter_args(grp, fmt, args...) \
  61   LBS_DEB_LL(grp | LBS_DEB_ENTER, " enter", "%s(" fmt ")\n", __func__, ## args);
  62 #define lbs_deb_leave(grp) \
  63   LBS_DEB_LL(grp | LBS_DEB_LEAVE, " leave", "%s()\n", __func__);
  64 #define lbs_deb_leave_args(grp, fmt, args...) \
  65   LBS_DEB_LL(grp | LBS_DEB_LEAVE, " leave", "%s(), " fmt "\n", \
  66   __func__, ##args);
  67 #define lbs_deb_main(fmt, args...)      LBS_DEB_LL(LBS_DEB_MAIN, " main", fmt, ##args)
  68 #define lbs_deb_net(fmt, args...)       LBS_DEB_LL(LBS_DEB_NET, " net", fmt, ##args)
  69 #define lbs_deb_mesh(fmt, args...)      LBS_DEB_LL(LBS_DEB_MESH, " mesh", fmt, ##args)
  70 #define lbs_deb_wext(fmt, args...)      LBS_DEB_LL(LBS_DEB_WEXT, " wext", fmt, ##args)
  71 #define lbs_deb_ioctl(fmt, args...)     LBS_DEB_LL(LBS_DEB_IOCTL, " ioctl", fmt, ##args)
  72 #define lbs_deb_scan(fmt, args...)      LBS_DEB_LL(LBS_DEB_SCAN, " scan", fmt, ##args)
  73 #define lbs_deb_assoc(fmt, args...)     LBS_DEB_LL(LBS_DEB_ASSOC, " assoc", fmt, ##args)
  74 #define lbs_deb_join(fmt, args...)      LBS_DEB_LL(LBS_DEB_JOIN, " join", fmt, ##args)
  75 #define lbs_deb_11d(fmt, args...)       LBS_DEB_LL(LBS_DEB_11D, " 11d", fmt, ##args)
  76 #define lbs_deb_debugfs(fmt, args...)   LBS_DEB_LL(LBS_DEB_DEBUGFS, " debugfs", fmt, ##args)
  77 #define lbs_deb_ethtool(fmt, args...)   LBS_DEB_LL(LBS_DEB_ETHTOOL, " ethtool", fmt, ##args)
  78 #define lbs_deb_host(fmt, args...)      LBS_DEB_LL(LBS_DEB_HOST, " host", fmt, ##args)
  79 #define lbs_deb_cmd(fmt, args...)       LBS_DEB_LL(LBS_DEB_CMD, " cmd", fmt, ##args)
  80 #define lbs_deb_rx(fmt, args...)        LBS_DEB_LL(LBS_DEB_RX, " rx", fmt, ##args)
  81 #define lbs_deb_tx(fmt, args...)        LBS_DEB_LL(LBS_DEB_TX, " tx", fmt, ##args)
  82 #define lbs_deb_fw(fmt, args...)        LBS_DEB_LL(LBS_DEB_FW, " fw", fmt, ##args)
  83 #define lbs_deb_usb(fmt, args...)       LBS_DEB_LL(LBS_DEB_USB, " usb", fmt, ##args)
  84 #define lbs_deb_usbd(dev, fmt, args...) LBS_DEB_LL(LBS_DEB_USB, " usbd", "%s:" fmt, dev_name(dev), ##args)
  85 #define lbs_deb_cs(fmt, args...)        LBS_DEB_LL(LBS_DEB_CS, " cs", fmt, ##args)
  86 #define lbs_deb_thread(fmt, args...)    LBS_DEB_LL(LBS_DEB_THREAD, " thread", fmt, ##args)
  87 #define lbs_deb_sdio(fmt, args...)      LBS_DEB_LL(LBS_DEB_SDIO, " sdio", fmt, ##args)
  88 #define lbs_deb_sysfs(fmt, args...)     LBS_DEB_LL(LBS_DEB_SYSFS, " sysfs", fmt, ##args)
  89 #define lbs_deb_spi(fmt, args...)       LBS_DEB_LL(LBS_DEB_SPI, " spi", fmt, ##args)
  90 #define lbs_deb_cfg80211(fmt, args...)  LBS_DEB_LL(LBS_DEB_CFG80211, " cfg80211", fmt, ##args)
  91
  92 #ifdef DEBUG
  93 static inline void lbs_deb_hex(unsigned int grp, const char *prompt,
  94                                const 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 /* Wake rules for Host_Sleep_CFG command */
 151 #define WOL_RULE_NET_TYPE_INFRA_OR_IBSS 0x00
 152 #define WOL_RULE_NET_TYPE_MESH          0x10
 153 #define WOL_RULE_ADDR_TYPE_BCAST        0x01
 154 #define WOL_RULE_ADDR_TYPE_MCAST        0x08
 155 #define WOL_RULE_ADDR_TYPE_UCAST        0x02
 156 #define WOL_RULE_OP_AND                 0x01
 157 #define WOL_RULE_OP_OR                  0x02
 158 #define WOL_RULE_OP_INVALID             0xFF
 159 #define WOL_RESULT_VALID_CMD            0
 160 #define WOL_RESULT_NOSPC_ERR            1
 161 #define WOL_RESULT_EEXIST_ERR           2
 162
 163 /* Misc constants */
 164 /* This section defines 802.11 specific contants */
 165
 166 #define MRVDRV_MAX_BSS_DESCRIPTS                16
 167 #define MRVDRV_MAX_REGION_CODE                  6
 168
 169 #define MRVDRV_DEFAULT_LISTEN_INTERVAL          10
 170
 171 #define MRVDRV_CHANNELS_PER_SCAN                4
 172 #define MRVDRV_MAX_CHANNELS_PER_SCAN            14
 173
 174 #define MRVDRV_MIN_BEACON_INTERVAL              20
 175 #define MRVDRV_MAX_BEACON_INTERVAL              1000
 176 #define MRVDRV_BEACON_INTERVAL                  100
 177
 178 #define MARVELL_MESH_IE_LENGTH          9
 179
 180 /*
 181  * Values used to populate the struct mrvl_mesh_ie.  The only time you need this
 182  * is when enabling the mesh using CMD_MESH_CONFIG.
 183  */
 184 #define MARVELL_MESH_IE_TYPE            4
 185 #define MARVELL_MESH_IE_SUBTYPE         0
 186 #define MARVELL_MESH_IE_VERSION         0
 187 #define MARVELL_MESH_PROTO_ID_HWMP      0
 188 #define MARVELL_MESH_METRIC_ID          0
 189 #define MARVELL_MESH_CAPABILITY         0
 190
 191 /* INT status Bit Definition */
 192 #define MRVDRV_TX_DNLD_RDY              0x0001
 193 #define MRVDRV_RX_UPLD_RDY              0x0002
 194 #define MRVDRV_CMD_DNLD_RDY             0x0004
 195 #define MRVDRV_CMD_UPLD_RDY             0x0008
 196 #define MRVDRV_CARDEVENT                0x0010
 197
 198 /* Automatic TX control default levels */
 199 #define POW_ADAPT_DEFAULT_P0 13
 200 #define POW_ADAPT_DEFAULT_P1 15
 201 #define POW_ADAPT_DEFAULT_P2 18
 202 #define TPC_DEFAULT_P0 5
 203 #define TPC_DEFAULT_P1 10
 204 #define TPC_DEFAULT_P2 13
 205
 206 /* TxPD status */
 207
 208 /*
 209  *      Station firmware use TxPD status field to report final Tx transmit
 210  *      result, Bit masks are used to present combined situations.
 211  */
 212
 213 #define MRVDRV_TxPD_POWER_MGMT_NULL_PACKET 0x01
 214 #define MRVDRV_TxPD_POWER_MGMT_LAST_PACKET 0x08
 215
 216 /* Tx mesh flag */
 217 /*
 218  * Currently we are using normal WDS flag as mesh flag.
 219  * TODO: change to proper mesh flag when MAC understands it.
 220  */
 221 #define TxPD_CONTROL_WDS_FRAME (1<<17)
 222 #define TxPD_MESH_FRAME TxPD_CONTROL_WDS_FRAME
 223
 224 /* Mesh interface ID */
 225 #define MESH_IFACE_ID                                   0x0001
 226 /* Mesh id should be in bits 14-13-12 */
 227 #define MESH_IFACE_BIT_OFFSET                           0x000c
 228 /* Mesh enable bit in FW capability */
 229 #define MESH_CAPINFO_ENABLE_MASK                        (1<<16)
 230
 231 /* FW definition from Marvell v4 */
 232 #define MRVL_FW_V4                                      (0x04)
 233 /* FW definition from Marvell v5 */
 234 #define MRVL_FW_V5                                      (0x05)
 235 /* FW definition from Marvell v10 */
 236 #define MRVL_FW_V10                                     (0x0a)
 237 /* FW major revision definition */
 238 #define MRVL_FW_MAJOR_REV(x)                            ((x)>>24)
 239
 240 /* RxPD status */
 241
 242 #define MRVDRV_RXPD_STATUS_OK                0x0001
 243
 244 /* RxPD status - Received packet types */
 245 /* Rx mesh flag */
 246 /*
 247  * Currently we are using normal WDS flag as mesh flag.
 248  * TODO: change to proper mesh flag when MAC understands it.
 249  */
 250 #define RxPD_CONTROL_WDS_FRAME (0x40)
 251 #define RxPD_MESH_FRAME RxPD_CONTROL_WDS_FRAME
 252
 253 /* RSSI-related defines */
 254 /*
 255  *      RSSI constants are used to implement 802.11 RSSI threshold
 256  *      indication. if the Rx packet signal got too weak for 5 consecutive
 257  *      times, miniport driver (driver) will report this event to wrapper
 258  */
 259
 260 #define MRVDRV_NF_DEFAULT_SCAN_VALUE            (-96)
 261
 262 /* RTS/FRAG related defines */
 263 #define MRVDRV_RTS_MIN_VALUE            0
 264 #define MRVDRV_RTS_MAX_VALUE            2347
 265 #define MRVDRV_FRAG_MIN_VALUE           256
 266 #define MRVDRV_FRAG_MAX_VALUE           2346
 267
 268 /* This is for firmware specific length */
 269 #define EXTRA_LEN       36
 270
 271 #define MRVDRV_ETH_TX_PACKET_BUFFER_SIZE \
 272         (ETH_FRAME_LEN + sizeof(struct txpd) + EXTRA_LEN)
 273
 274 #define MRVDRV_ETH_RX_PACKET_BUFFER_SIZE \
 275         (ETH_FRAME_LEN + sizeof(struct rxpd) \
 276          + MRVDRV_SNAP_HEADER_LEN + EXTRA_LEN)
 277
 278 #define CMD_F_HOSTCMD           (1 << 0)
 279 #define FW_CAPINFO_WPA          (1 << 0)
 280 #define FW_CAPINFO_PS           (1 << 1)
 281 #define FW_CAPINFO_FIRMWARE_UPGRADE     (1 << 13)
 282 #define FW_CAPINFO_BOOT2_UPGRADE        (1<<14)
 283 #define FW_CAPINFO_PERSISTENT_CONFIG    (1<<15)
 284
 285 #define KEY_LEN_WPA_AES                 16
 286 #define KEY_LEN_WPA_TKIP                32
 287 #define KEY_LEN_WEP_104                 13
 288 #define KEY_LEN_WEP_40                  5
 289
 290 #define RF_ANTENNA_1            0x1
 291 #define RF_ANTENNA_2            0x2
 292 #define RF_ANTENNA_AUTO         0xFFFF
 293
 294 #define BAND_B                  (0x01)
 295 #define BAND_G                  (0x02)
 296 #define ALL_802_11_BANDS        (BAND_B | BAND_G)
 297
 298 #define MAX_RATES                       14
 299
 300 #define MAX_LEDS                        8
 301
 302 /* Global Variable Declaration */
 303 extern const char lbs_driver_version[];
 304 extern u16 lbs_region_code_to_index[MRVDRV_MAX_REGION_CODE];
 305
 306
 307 /* ENUM definition */
 308 /* SNRNF_TYPE */
 309 enum SNRNF_TYPE {
 310         TYPE_BEACON = 0,
 311         TYPE_RXPD,
 312         MAX_TYPE_B
 313 };
 314
 315 /* SNRNF_DATA */
 316 enum SNRNF_DATA {
 317         TYPE_NOAVG = 0,
 318         TYPE_AVG,
 319         MAX_TYPE_AVG
 320 };
 321
 322 /* LBS_802_11_POWER_MODE */
 323 enum LBS_802_11_POWER_MODE {
 324         LBS802_11POWERMODECAM,
 325         LBS802_11POWERMODEMAX_PSP,
 326         LBS802_11POWERMODEFAST_PSP,
 327         /* not a real mode, defined as an upper bound */
 328         LBS802_11POWEMODEMAX
 329 };
 330
 331 /* PS_STATE */
 332 enum PS_STATE {
 333         PS_STATE_FULL_POWER,
 334         PS_STATE_AWAKE,
 335         PS_STATE_PRE_SLEEP,
 336         PS_STATE_SLEEP
 337 };
 338
 339 /* DNLD_STATE */
 340 enum DNLD_STATE {
 341         DNLD_RES_RECEIVED,
 342         DNLD_DATA_SENT,
 343         DNLD_CMD_SENT,
 344         DNLD_BOOTCMD_SENT,
 345 };
 346
 347 /* LBS_MEDIA_STATE */
 348 enum LBS_MEDIA_STATE {
 349         LBS_CONNECTED,
 350         LBS_DISCONNECTED
 351 };
 352
 353 /* LBS_802_11_PRIVACY_FILTER */
 354 enum LBS_802_11_PRIVACY_FILTER {
 355         LBS802_11PRIVFILTERACCEPTALL,
 356         LBS802_11PRIVFILTER8021XWEP
 357 };
 358
 359 /* mv_ms_type */
 360 enum mv_ms_type {
 361         MVMS_DAT = 0,
 362         MVMS_CMD = 1,
 363         MVMS_TXDONE = 2,
 364         MVMS_EVENT
 365 };
 366
 367 /* KEY_TYPE_ID */
 368 enum KEY_TYPE_ID {
 369         KEY_TYPE_ID_WEP = 0,
 370         KEY_TYPE_ID_TKIP,
 371         KEY_TYPE_ID_AES
 372 };
 373
 374 /* KEY_INFO_WPA (applies to both TKIP and AES/CCMP) */
 375 enum KEY_INFO_WPA {
 376         KEY_INFO_WPA_MCAST = 0x01,
 377         KEY_INFO_WPA_UNICAST = 0x02,
 378         KEY_INFO_WPA_ENABLED = 0x04
 379 };
 380
 381 /* Default values for fwt commands. */
 382 #define FWT_DEFAULT_METRIC 0
 383 #define FWT_DEFAULT_DIR 1
 384 /* Default Rate, 11Mbps */
 385 #define FWT_DEFAULT_RATE 3
 386 #define FWT_DEFAULT_SSN 0xffffffff
 387 #define FWT_DEFAULT_DSN 0
 388 #define FWT_DEFAULT_HOPCOUNT 0
 389 #define FWT_DEFAULT_TTL 0
 390 #define FWT_DEFAULT_EXPIRATION 0
 391 #define FWT_DEFAULT_SLEEPMODE 0
 392 #define FWT_DEFAULT_SNR 0
 393
 394 #endif