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