[thirdparty/kernel/linux.git] / drivers / net / wireless / marvell / libertas / defs.h

/* SPDX-License-Identifier: GPL-2.0 */
/*
 * This header file contains global constant/enum definitions,
 * global variable declaration.
 */
#ifndef _LBS_DEFS_H_
#define _LBS_DEFS_H_

#include <linux/spinlock.h>

#ifdef CONFIG_LIBERTAS_DEBUG
#define DEBUG
#define PROC_DEBUG
#endif

#ifndef DRV_NAME
#define DRV_NAME "libertas"
#endif


#define LBS_DEB_ENTER	0x00000001
#define LBS_DEB_LEAVE	0x00000002
#define LBS_DEB_MAIN	0x00000004
#define LBS_DEB_NET	0x00000008
#define LBS_DEB_MESH	0x00000010
#define LBS_DEB_WEXT	0x00000020
#define LBS_DEB_IOCTL	0x00000040
#define LBS_DEB_SCAN	0x00000080
#define LBS_DEB_ASSOC	0x00000100
#define LBS_DEB_JOIN	0x00000200
#define LBS_DEB_11D	0x00000400
#define LBS_DEB_DEBUGFS	0x00000800
#define LBS_DEB_ETHTOOL	0x00001000
#define LBS_DEB_HOST	0x00002000
#define LBS_DEB_CMD	0x00004000
#define LBS_DEB_RX	0x00008000
#define LBS_DEB_TX	0x00010000
#define LBS_DEB_USB	0x00020000
#define LBS_DEB_CS	0x00040000
#define LBS_DEB_FW	0x00080000
#define LBS_DEB_THREAD	0x00100000
#define LBS_DEB_HEX	0x00200000
#define LBS_DEB_SDIO	0x00400000
#define LBS_DEB_SYSFS	0x00800000
#define LBS_DEB_SPI	0x01000000
#define LBS_DEB_CFG80211 0x02000000

extern unsigned int lbs_debug;

#ifdef DEBUG
#define LBS_DEB_LL(grp, grpnam, fmt, args...) \
do { if ((lbs_debug & (grp)) == (grp)) \
  printk(KERN_DEBUG DRV_NAME grpnam "%s: " fmt, \
         in_interrupt() ? " (INT)" : "", ## args); } while (0)
#else
#define LBS_DEB_LL(grp, grpnam, fmt, args...) do {} while (0)
#endif

#define lbs_deb_main(fmt, args...)      LBS_DEB_LL(LBS_DEB_MAIN, " main", fmt, ##args)
#define lbs_deb_net(fmt, args...)       LBS_DEB_LL(LBS_DEB_NET, " net", fmt, ##args)
#define lbs_deb_mesh(fmt, args...)      LBS_DEB_LL(LBS_DEB_MESH, " mesh", fmt, ##args)
#define lbs_deb_wext(fmt, args...)      LBS_DEB_LL(LBS_DEB_WEXT, " wext", fmt, ##args)
#define lbs_deb_ioctl(fmt, args...)     LBS_DEB_LL(LBS_DEB_IOCTL, " ioctl", fmt, ##args)
#define lbs_deb_scan(fmt, args...)      LBS_DEB_LL(LBS_DEB_SCAN, " scan", fmt, ##args)
#define lbs_deb_assoc(fmt, args...)     LBS_DEB_LL(LBS_DEB_ASSOC, " assoc", fmt, ##args)
#define lbs_deb_join(fmt, args...)      LBS_DEB_LL(LBS_DEB_JOIN, " join", fmt, ##args)
#define lbs_deb_11d(fmt, args...)       LBS_DEB_LL(LBS_DEB_11D, " 11d", fmt, ##args)
#define lbs_deb_debugfs(fmt, args...)   LBS_DEB_LL(LBS_DEB_DEBUGFS, " debugfs", fmt, ##args)
#define lbs_deb_ethtool(fmt, args...)   LBS_DEB_LL(LBS_DEB_ETHTOOL, " ethtool", fmt, ##args)
#define lbs_deb_host(fmt, args...)      LBS_DEB_LL(LBS_DEB_HOST, " host", fmt, ##args)
#define lbs_deb_cmd(fmt, args...)       LBS_DEB_LL(LBS_DEB_CMD, " cmd", fmt, ##args)
#define lbs_deb_rx(fmt, args...)        LBS_DEB_LL(LBS_DEB_RX, " rx", fmt, ##args)
#define lbs_deb_tx(fmt, args...)        LBS_DEB_LL(LBS_DEB_TX, " tx", fmt, ##args)
#define lbs_deb_fw(fmt, args...)        LBS_DEB_LL(LBS_DEB_FW, " fw", fmt, ##args)
#define lbs_deb_usb(fmt, args...)       LBS_DEB_LL(LBS_DEB_USB, " usb", fmt, ##args)
#define lbs_deb_usbd(dev, fmt, args...) LBS_DEB_LL(LBS_DEB_USB, " usbd", "%s:" fmt, dev_name(dev), ##args)
#define lbs_deb_cs(fmt, args...)        LBS_DEB_LL(LBS_DEB_CS, " cs", fmt, ##args)
#define lbs_deb_thread(fmt, args...)    LBS_DEB_LL(LBS_DEB_THREAD, " thread", fmt, ##args)
#define lbs_deb_sdio(fmt, args...)      LBS_DEB_LL(LBS_DEB_SDIO, " sdio", fmt, ##args)
#define lbs_deb_sysfs(fmt, args...)     LBS_DEB_LL(LBS_DEB_SYSFS, " sysfs", fmt, ##args)
#define lbs_deb_spi(fmt, args...)       LBS_DEB_LL(LBS_DEB_SPI, " spi", fmt, ##args)
#define lbs_deb_cfg80211(fmt, args...)  LBS_DEB_LL(LBS_DEB_CFG80211, " cfg80211", fmt, ##args)

#ifdef DEBUG
static inline void lbs_deb_hex(unsigned int grp, const char *prompt,
			       const u8 *buf, int len)
{
	int i = 0;

	if (len &&
	    (lbs_debug & LBS_DEB_HEX) &&
	    (lbs_debug & grp))
	{
		for (i = 1; i <= len; i++) {
			if ((i & 0xf) == 1) {
				if (i != 1)
					printk("\n");
				printk(DRV_NAME " %s: ", prompt);
			}
			printk("%02x ", (u8) * buf);
			buf++;
		}
		printk("\n");
	}
}
#else
#define lbs_deb_hex(grp,prompt,buf,len)	do {} while (0)
#endif


/* Buffer Constants */

/*	The size of SQ memory PPA, DPA are 8 DWORDs, that keep the physical
 *	addresses of TxPD buffers. Station has only 8 TxPD available, Whereas
 *	driver has more local TxPDs. Each TxPD on the host memory is associated
 *	with a Tx control node. The driver maintains 8 RxPD descriptors for
 *	station firmware to store Rx packet information.
 *
 *	Current version of MAC has a 32x6 multicast address buffer.
 *
 *	802.11b can have up to  14 channels, the driver keeps the
 *	BSSID(MAC address) of each APs or Ad hoc stations it has sensed.
 */

#define MRVDRV_MAX_MULTICAST_LIST_SIZE	32
#define LBS_NUM_CMD_BUFFERS             10
#define LBS_CMD_BUFFER_SIZE             (2 * 1024)
#define MRVDRV_MAX_CHANNEL_SIZE		14
#define MRVDRV_ASSOCIATION_TIME_OUT	255
#define MRVDRV_SNAP_HEADER_LEN          8

#define	LBS_UPLD_SIZE			2312
#define DEV_NAME_LEN			32

/* Wake criteria for HOST_SLEEP_CFG command */
#define EHS_WAKE_ON_BROADCAST_DATA	0x0001
#define EHS_WAKE_ON_UNICAST_DATA	0x0002
#define EHS_WAKE_ON_MAC_EVENT		0x0004
#define EHS_WAKE_ON_MULTICAST_DATA	0x0008
#define EHS_REMOVE_WAKEUP		0xFFFFFFFF
/* Wake rules for Host_Sleep_CFG command */
#define WOL_RULE_NET_TYPE_INFRA_OR_IBSS	0x00
#define WOL_RULE_NET_TYPE_MESH		0x10
#define WOL_RULE_ADDR_TYPE_BCAST	0x01
#define WOL_RULE_ADDR_TYPE_MCAST	0x08
#define WOL_RULE_ADDR_TYPE_UCAST	0x02
#define WOL_RULE_OP_AND			0x01
#define WOL_RULE_OP_OR			0x02
#define WOL_RULE_OP_INVALID		0xFF
#define WOL_RESULT_VALID_CMD		0
#define WOL_RESULT_NOSPC_ERR		1
#define WOL_RESULT_EEXIST_ERR		2

/* Misc constants */
/* This section defines 802.11 specific contants */

#define MRVDRV_MAX_BSS_DESCRIPTS		16
#define MRVDRV_MAX_REGION_CODE			6

#define MRVDRV_DEFAULT_LISTEN_INTERVAL		10

#define	MRVDRV_CHANNELS_PER_SCAN		4
#define	MRVDRV_MAX_CHANNELS_PER_SCAN		14

#define MRVDRV_MIN_BEACON_INTERVAL		20
#define MRVDRV_MAX_BEACON_INTERVAL		1000
#define MRVDRV_BEACON_INTERVAL			100

#define MARVELL_MESH_IE_LENGTH		9

/*
 * Values used to populate the struct mrvl_mesh_ie.  The only time you need this
 * is when enabling the mesh using CMD_MESH_CONFIG.
 */
#define MARVELL_MESH_IE_TYPE		4
#define MARVELL_MESH_IE_SUBTYPE		0
#define MARVELL_MESH_IE_VERSION		0
#define MARVELL_MESH_PROTO_ID_HWMP	0
#define MARVELL_MESH_METRIC_ID		0
#define MARVELL_MESH_CAPABILITY		0

/* INT status Bit Definition */
#define MRVDRV_TX_DNLD_RDY		0x0001
#define MRVDRV_RX_UPLD_RDY		0x0002
#define MRVDRV_CMD_DNLD_RDY		0x0004
#define MRVDRV_CMD_UPLD_RDY		0x0008
#define MRVDRV_CARDEVENT		0x0010

/* Automatic TX control default levels */
#define POW_ADAPT_DEFAULT_P0 13
#define POW_ADAPT_DEFAULT_P1 15
#define POW_ADAPT_DEFAULT_P2 18
#define TPC_DEFAULT_P0 5
#define TPC_DEFAULT_P1 10
#define TPC_DEFAULT_P2 13

/* TxPD status */

/*
 *	Station firmware use TxPD status field to report final Tx transmit
 *	result, Bit masks are used to present combined situations.
 */

#define MRVDRV_TxPD_POWER_MGMT_NULL_PACKET 0x01
#define MRVDRV_TxPD_POWER_MGMT_LAST_PACKET 0x08

/* Tx mesh flag */
/*
 * Currently we are using normal WDS flag as mesh flag.
 * TODO: change to proper mesh flag when MAC understands it.
 */
#define TxPD_CONTROL_WDS_FRAME (1<<17)
#define TxPD_MESH_FRAME TxPD_CONTROL_WDS_FRAME

/* Mesh interface ID */
#define MESH_IFACE_ID					0x0001
/* Mesh id should be in bits 14-13-12 */
#define MESH_IFACE_BIT_OFFSET				0x000c
/* Mesh enable bit in FW capability */
#define MESH_CAPINFO_ENABLE_MASK			(1<<16)

/* FW definition from Marvell v4 */
#define MRVL_FW_V4					(0x04)
/* FW definition from Marvell v5 */
#define MRVL_FW_V5					(0x05)
/* FW definition from Marvell v10 */
#define MRVL_FW_V10					(0x0a)
/* FW major revision definition */
#define MRVL_FW_MAJOR_REV(x)				((x)>>24)

/* RxPD status */

#define MRVDRV_RXPD_STATUS_OK                0x0001

/* RxPD status - Received packet types */
/* Rx mesh flag */
/*
 * Currently we are using normal WDS flag as mesh flag.
 * TODO: change to proper mesh flag when MAC understands it.
 */
#define RxPD_CONTROL_WDS_FRAME (0x40)
#define RxPD_MESH_FRAME RxPD_CONTROL_WDS_FRAME

/* RSSI-related defines */
/*
 *	RSSI constants are used to implement 802.11 RSSI threshold
 *	indication. if the Rx packet signal got too weak for 5 consecutive
 *	times, miniport driver (driver) will report this event to wrapper
 */

#define MRVDRV_NF_DEFAULT_SCAN_VALUE		(-96)

/* RTS/FRAG related defines */
#define MRVDRV_RTS_MIN_VALUE		0
#define MRVDRV_RTS_MAX_VALUE		2347
#define MRVDRV_FRAG_MIN_VALUE		256
#define MRVDRV_FRAG_MAX_VALUE		2346

/* This is for firmware specific length */
#define EXTRA_LEN	36

#define MRVDRV_ETH_TX_PACKET_BUFFER_SIZE \
	(ETH_FRAME_LEN + sizeof(struct txpd) + EXTRA_LEN)

#define MRVDRV_ETH_RX_PACKET_BUFFER_SIZE \
	(ETH_FRAME_LEN + sizeof(struct rxpd) \
	 + MRVDRV_SNAP_HEADER_LEN + EXTRA_LEN)

#define	CMD_F_HOSTCMD		(1 << 0)
#define FW_CAPINFO_WPA  	(1 << 0)
#define FW_CAPINFO_PS  		(1 << 1)
#define FW_CAPINFO_FIRMWARE_UPGRADE	(1 << 13)
#define FW_CAPINFO_BOOT2_UPGRADE	(1<<14)
#define FW_CAPINFO_PERSISTENT_CONFIG	(1<<15)

#define KEY_LEN_WPA_AES			16
#define KEY_LEN_WPA_TKIP		32
#define KEY_LEN_WEP_104			13
#define KEY_LEN_WEP_40			5

#define RF_ANTENNA_1		0x1
#define RF_ANTENNA_2		0x2
#define RF_ANTENNA_AUTO		0xFFFF

#define	BAND_B			(0x01)
#define	BAND_G			(0x02)
#define ALL_802_11_BANDS	(BAND_B | BAND_G)

#define MAX_RATES			14

#define	MAX_LEDS			8

/* Global Variable Declaration */
extern const char lbs_driver_version[];
extern u16 lbs_region_code_to_index[MRVDRV_MAX_REGION_CODE];


/* ENUM definition */
/* SNRNF_TYPE */
enum SNRNF_TYPE {
	TYPE_BEACON = 0,
	TYPE_RXPD,
	MAX_TYPE_B
};

/* SNRNF_DATA */
enum SNRNF_DATA {
	TYPE_NOAVG = 0,
	TYPE_AVG,
	MAX_TYPE_AVG
};

/* LBS_802_11_POWER_MODE */
enum LBS_802_11_POWER_MODE {
	LBS802_11POWERMODECAM,
	LBS802_11POWERMODEMAX_PSP,
	LBS802_11POWERMODEFAST_PSP,
	/* not a real mode, defined as an upper bound */
	LBS802_11POWEMODEMAX
};

/* PS_STATE */
enum PS_STATE {
	PS_STATE_FULL_POWER,
	PS_STATE_AWAKE,
	PS_STATE_PRE_SLEEP,
	PS_STATE_SLEEP
};

/* DNLD_STATE */
enum DNLD_STATE {
	DNLD_RES_RECEIVED,
	DNLD_DATA_SENT,
	DNLD_CMD_SENT,
	DNLD_BOOTCMD_SENT,
};

/* LBS_MEDIA_STATE */
enum LBS_MEDIA_STATE {
	LBS_CONNECTED,
	LBS_DISCONNECTED
};

/* LBS_802_11_PRIVACY_FILTER */
enum LBS_802_11_PRIVACY_FILTER {
	LBS802_11PRIVFILTERACCEPTALL,
	LBS802_11PRIVFILTER8021XWEP
};

/* mv_ms_type */
enum mv_ms_type {
	MVMS_DAT = 0,
	MVMS_CMD = 1,
	MVMS_TXDONE = 2,
	MVMS_EVENT
};

/* KEY_TYPE_ID */
enum KEY_TYPE_ID {
	KEY_TYPE_ID_WEP = 0,
	KEY_TYPE_ID_TKIP,
	KEY_TYPE_ID_AES
};

/* KEY_INFO_WPA (applies to both TKIP and AES/CCMP) */
enum KEY_INFO_WPA {
	KEY_INFO_WPA_MCAST = 0x01,
	KEY_INFO_WPA_UNICAST = 0x02,
	KEY_INFO_WPA_ENABLED = 0x04
};

/* Default values for fwt commands. */
#define FWT_DEFAULT_METRIC 0
#define FWT_DEFAULT_DIR 1
/* Default Rate, 11Mbps */
#define FWT_DEFAULT_RATE 3
#define FWT_DEFAULT_SSN 0xffffffff
#define FWT_DEFAULT_DSN 0
#define FWT_DEFAULT_HOPCOUNT 0
#define FWT_DEFAULT_TTL 0
#define FWT_DEFAULT_EXPIRATION 0
#define FWT_DEFAULT_SLEEPMODE 0
#define FWT_DEFAULT_SNR 0

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