/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
 47extern unsigned int lbs_debug;
 48
 49#ifdef DEBUG
 50#define LBS_DEB_LL(grp, grpnam, fmt, args...) \
 51do { 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
 93static inline void lbs_deb_hex(unsigned int grp, const char *prompt, u8 *buf, int len)
 94{
 95	int i = 0;
 96
 97	if (len &&
 98	    (lbs_debug & LBS_DEB_HEX) &&
 99	    (lbs_debug & grp))
100	{
101		for (i = 1; i <= len; i++) {
102			if ((i & 0xf) == 1) {
103				if (i != 1)
104					printk("\n");
105				printk(DRV_NAME " %s: ", prompt);
106			}
107			printk("%02x ", (u8) * buf);
108			buf++;
109		}
110		printk("\n");
111	}
112}
113#else
114#define lbs_deb_hex(grp,prompt,buf,len)	do {} while (0)
115#endif
116
117
118
119/* Buffer Constants */
120
121/*	The size of SQ memory PPA, DPA are 8 DWORDs, that keep the physical
122 *	addresses of TxPD buffers. Station has only 8 TxPD available, Whereas
123 *	driver has more local TxPDs. Each TxPD on the host memory is associated
124 *	with a Tx control node. The driver maintains 8 RxPD descriptors for
125 *	station firmware to store Rx packet information.
126 *
127 *	Current version of MAC has a 32x6 multicast address buffer.
128 *
129 *	802.11b can have up to  14 channels, the driver keeps the
130 *	BSSID(MAC address) of each APs or Ad hoc stations it has sensed.
131 */
132
133#define MRVDRV_MAX_MULTICAST_LIST_SIZE	32
134#define LBS_NUM_CMD_BUFFERS             10
135#define LBS_CMD_BUFFER_SIZE             (2 * 1024)
136#define MRVDRV_MAX_CHANNEL_SIZE		14
137#define MRVDRV_ASSOCIATION_TIME_OUT	255
138#define MRVDRV_SNAP_HEADER_LEN          8
139
140#define	LBS_UPLD_SIZE			2312
141#define DEV_NAME_LEN			32
142
143/* Wake criteria for HOST_SLEEP_CFG command */
144#define EHS_WAKE_ON_BROADCAST_DATA	0x0001
145#define EHS_WAKE_ON_UNICAST_DATA	0x0002
146#define EHS_WAKE_ON_MAC_EVENT		0x0004
147#define EHS_WAKE_ON_MULTICAST_DATA	0x0008
148#define EHS_REMOVE_WAKEUP		0xFFFFFFFF
149/* Wake rules for Host_Sleep_CFG command */
150#define WOL_RULE_NET_TYPE_INFRA_OR_IBSS	0x00
151#define WOL_RULE_NET_TYPE_MESH		0x10
152#define WOL_RULE_ADDR_TYPE_BCAST	0x01
153#define WOL_RULE_ADDR_TYPE_MCAST	0x08
154#define WOL_RULE_ADDR_TYPE_UCAST	0x02
155#define WOL_RULE_OP_AND			0x01
156#define WOL_RULE_OP_OR			0x02
157#define WOL_RULE_OP_INVALID		0xFF
158#define WOL_RESULT_VALID_CMD		0
159#define WOL_RESULT_NOSPC_ERR		1
160#define WOL_RESULT_EEXIST_ERR		2
161
162/* Misc constants */
163/* This section defines 802.11 specific contants */
164
165#define MRVDRV_MAX_BSS_DESCRIPTS		16
166#define MRVDRV_MAX_REGION_CODE			6
167
168#define MRVDRV_DEFAULT_LISTEN_INTERVAL		10
169
170#define	MRVDRV_CHANNELS_PER_SCAN		4
171#define	MRVDRV_MAX_CHANNELS_PER_SCAN		14
172
173#define MRVDRV_MIN_BEACON_INTERVAL		20
174#define MRVDRV_MAX_BEACON_INTERVAL		1000
175#define MRVDRV_BEACON_INTERVAL			100
176
177#define MARVELL_MESH_IE_LENGTH		9
178
179/*
180 * Values used to populate the struct mrvl_mesh_ie.  The only time you need this
181 * is when enabling the mesh using CMD_MESH_CONFIG.
182 */
183#define MARVELL_MESH_IE_TYPE		4
184#define MARVELL_MESH_IE_SUBTYPE		0
185#define MARVELL_MESH_IE_VERSION		0
186#define MARVELL_MESH_PROTO_ID_HWMP	0
187#define MARVELL_MESH_METRIC_ID		0
188#define MARVELL_MESH_CAPABILITY		0
189
190/* INT status Bit Definition */
191#define MRVDRV_TX_DNLD_RDY		0x0001
192#define MRVDRV_RX_UPLD_RDY		0x0002
193#define MRVDRV_CMD_DNLD_RDY		0x0004
194#define MRVDRV_CMD_UPLD_RDY		0x0008
195#define MRVDRV_CARDEVENT		0x0010
196
197/* Automatic TX control default levels */
198#define POW_ADAPT_DEFAULT_P0 13
199#define POW_ADAPT_DEFAULT_P1 15
200#define POW_ADAPT_DEFAULT_P2 18
201#define TPC_DEFAULT_P0 5
202#define TPC_DEFAULT_P1 10
203#define TPC_DEFAULT_P2 13
204
205/* TxPD status */
206
207/*
208 *	Station firmware use TxPD status field to report final Tx transmit
209 *	result, Bit masks are used to present combined situations.
210 */
211
212#define MRVDRV_TxPD_POWER_MGMT_NULL_PACKET 0x01
213#define MRVDRV_TxPD_POWER_MGMT_LAST_PACKET 0x08
214
215/* Tx mesh flag */
216/*
217 * Currently we are using normal WDS flag as mesh flag.
218 * TODO: change to proper mesh flag when MAC understands it.
219 */
220#define TxPD_CONTROL_WDS_FRAME (1<<17)
221#define TxPD_MESH_FRAME TxPD_CONTROL_WDS_FRAME
222
223/* Mesh interface ID */
224#define MESH_IFACE_ID					0x0001
225/* Mesh id should be in bits 14-13-12 */
226#define MESH_IFACE_BIT_OFFSET				0x000c
227/* Mesh enable bit in FW capability */
228#define MESH_CAPINFO_ENABLE_MASK			(1<<16)
229
230/* FW definition from Marvell v4 */
231#define MRVL_FW_V4					(0x04)
232/* FW definition from Marvell v5 */
233#define MRVL_FW_V5					(0x05)
234/* FW definition from Marvell v10 */
235#define MRVL_FW_V10					(0x0a)
236/* FW major revision definition */
237#define MRVL_FW_MAJOR_REV(x)				((x)>>24)
238
239/* RxPD status */
240
241#define MRVDRV_RXPD_STATUS_OK                0x0001
242
243/* RxPD status - Received packet types */
244/* Rx mesh flag */
245/*
246 * Currently we are using normal WDS flag as mesh flag.
247 * TODO: change to proper mesh flag when MAC understands it.
248 */
249#define RxPD_CONTROL_WDS_FRAME (0x40)
250#define RxPD_MESH_FRAME RxPD_CONTROL_WDS_FRAME
251
252/* RSSI-related defines */
253/*
254 *	RSSI constants are used to implement 802.11 RSSI threshold
255 *	indication. if the Rx packet signal got too weak for 5 consecutive
256 *	times, miniport driver (driver) will report this event to wrapper
257 */
258
259#define MRVDRV_NF_DEFAULT_SCAN_VALUE		(-96)
260
261/* RTS/FRAG related defines */
262#define MRVDRV_RTS_MIN_VALUE		0
263#define MRVDRV_RTS_MAX_VALUE		2347
264#define MRVDRV_FRAG_MIN_VALUE		256
265#define MRVDRV_FRAG_MAX_VALUE		2346
266
267/* This is for firmware specific length */
268#define EXTRA_LEN	36
269
270#define MRVDRV_ETH_TX_PACKET_BUFFER_SIZE \
271	(ETH_FRAME_LEN + sizeof(struct txpd) + EXTRA_LEN)
272
273#define MRVDRV_ETH_RX_PACKET_BUFFER_SIZE \
274	(ETH_FRAME_LEN + sizeof(struct rxpd) \
275	 + MRVDRV_SNAP_HEADER_LEN + EXTRA_LEN)
276
277#define	CMD_F_HOSTCMD		(1 << 0)
278#define FW_CAPINFO_WPA  	(1 << 0)
279#define FW_CAPINFO_PS  		(1 << 1)
280#define FW_CAPINFO_FIRMWARE_UPGRADE	(1 << 13)
281#define FW_CAPINFO_BOOT2_UPGRADE	(1<<14)
282#define FW_CAPINFO_PERSISTENT_CONFIG	(1<<15)
283
284#define KEY_LEN_WPA_AES			16
285#define KEY_LEN_WPA_TKIP		32
286#define KEY_LEN_WEP_104			13
287#define KEY_LEN_WEP_40			5
288
289#define RF_ANTENNA_1		0x1
290#define RF_ANTENNA_2		0x2
291#define RF_ANTENNA_AUTO		0xFFFF
292
293#define	BAND_B			(0x01)
294#define	BAND_G			(0x02)
295#define ALL_802_11_BANDS	(BAND_B | BAND_G)
296
297#define MAX_RATES			14
298
299#define	MAX_LEDS			8
300
301/* Global Variable Declaration */
302extern const char lbs_driver_version[];
303extern u16 lbs_region_code_to_index[MRVDRV_MAX_REGION_CODE];
304
305
306/* ENUM definition */
307/* SNRNF_TYPE */
308enum SNRNF_TYPE {
309	TYPE_BEACON = 0,
310	TYPE_RXPD,
311	MAX_TYPE_B
312};
313
314/* SNRNF_DATA */
315enum SNRNF_DATA {
316	TYPE_NOAVG = 0,
317	TYPE_AVG,
318	MAX_TYPE_AVG
319};
320
321/* LBS_802_11_POWER_MODE */
322enum LBS_802_11_POWER_MODE {
323	LBS802_11POWERMODECAM,
324	LBS802_11POWERMODEMAX_PSP,
325	LBS802_11POWERMODEFAST_PSP,
326	/* not a real mode, defined as an upper bound */
327	LBS802_11POWEMODEMAX
328};
329
330/* PS_STATE */
331enum PS_STATE {
332	PS_STATE_FULL_POWER,
333	PS_STATE_AWAKE,
334	PS_STATE_PRE_SLEEP,
335	PS_STATE_SLEEP
336};
337
338/* DNLD_STATE */
339enum DNLD_STATE {
340	DNLD_RES_RECEIVED,
341	DNLD_DATA_SENT,
342	DNLD_CMD_SENT,
343	DNLD_BOOTCMD_SENT,
344};
345
346/* LBS_MEDIA_STATE */
347enum LBS_MEDIA_STATE {
348	LBS_CONNECTED,
349	LBS_DISCONNECTED
350};
351
352/* LBS_802_11_PRIVACY_FILTER */
353enum LBS_802_11_PRIVACY_FILTER {
354	LBS802_11PRIVFILTERACCEPTALL,
355	LBS802_11PRIVFILTER8021XWEP
356};
357
358/* mv_ms_type */
359enum mv_ms_type {
360	MVMS_DAT = 0,
361	MVMS_CMD = 1,
362	MVMS_TXDONE = 2,
363	MVMS_EVENT
364};
365
366/* KEY_TYPE_ID */
367enum KEY_TYPE_ID {
368	KEY_TYPE_ID_WEP = 0,
369	KEY_TYPE_ID_TKIP,
370	KEY_TYPE_ID_AES
371};
372
373/* KEY_INFO_WPA (applies to both TKIP and AES/CCMP) */
374enum KEY_INFO_WPA {
375	KEY_INFO_WPA_MCAST = 0x01,
376	KEY_INFO_WPA_UNICAST = 0x02,
377	KEY_INFO_WPA_ENABLED = 0x04
378};
379
380/* Default values for fwt commands. */
381#define FWT_DEFAULT_METRIC 0
382#define FWT_DEFAULT_DIR 1
383/* Default Rate, 11Mbps */
384#define FWT_DEFAULT_RATE 3
385#define FWT_DEFAULT_SSN 0xffffffff
386#define FWT_DEFAULT_DSN 0
387#define FWT_DEFAULT_HOPCOUNT 0
388#define FWT_DEFAULT_TTL 0
389#define FWT_DEFAULT_EXPIRATION 0
390#define FWT_DEFAULT_SLEEPMODE 0
391#define FWT_DEFAULT_SNR 0
392
393#endif