libertas: move to uniform lbs_/LBS_ namespace
[deliverable/linux.git] / drivers / net / wireless / libertas / defs.h
CommitLineData
876c9d3a
MT
1/**
2 * This header file contains global constant/enum definitions,
3 * global variable declaration.
4 */
10078321
HS
5#ifndef _LBS_DEFS_H_
6#define _LBS_DEFS_H_
876c9d3a
MT
7
8#include <linux/spinlock.h>
9
3a8b9a4a
DW
10#ifdef CONFIG_LIBERTAS_DEBUG
11#define DEBUG
12#define PROC_DEBUG
13#endif
14
ec3eef28
HS
15#ifndef DRV_NAME
16#define DRV_NAME "libertas"
17#endif
9012b28a
HS
18
19
a46c6410
HS
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
727c26ed 42#define LBS_DEB_SDIO 0x00400000
a46c6410 43
10078321 44extern unsigned int lbs_debug;
9012b28a
HS
45
46#ifdef DEBUG
ece56191 47#define LBS_DEB_LL(grp, grpnam, fmt, args...) \
10078321 48do { if ((lbs_debug & (grp)) == (grp)) \
ece56191 49 printk(KERN_DEBUG DRV_NAME grpnam "%s: " fmt, \
9012b28a
HS
50 in_interrupt() ? " (INT)" : "", ## args); } while (0)
51#else
ece56191 52#define LBS_DEB_LL(grp, grpnam, fmt, args...) do {} while (0)
9012b28a
HS
53#endif
54
55#define lbs_deb_enter(grp) \
ece56191 56 LBS_DEB_LL(grp | LBS_DEB_ENTER, " enter", "%s():%d\n", __FUNCTION__, __LINE__);
9012b28a 57#define lbs_deb_enter_args(grp, fmt, args...) \
ece56191 58 LBS_DEB_LL(grp | LBS_DEB_ENTER, " enter", "%s(" fmt "):%d\n", __FUNCTION__, ## args, __LINE__);
9012b28a 59#define lbs_deb_leave(grp) \
ece56191 60 LBS_DEB_LL(grp | LBS_DEB_LEAVE, " leave", "%s():%d\n", __FUNCTION__, __LINE__);
9012b28a 61#define lbs_deb_leave_args(grp, fmt, args...) \
ece56191 62 LBS_DEB_LL(grp | LBS_DEB_LEAVE, " leave", "%s():%d, " fmt "\n", \
9012b28a 63 __FUNCTION__, __LINE__, ##args);
ece56191
HS
64#define lbs_deb_main(fmt, args...) LBS_DEB_LL(LBS_DEB_MAIN, " main", fmt, ##args)
65#define lbs_deb_net(fmt, args...) LBS_DEB_LL(LBS_DEB_NET, " net", fmt, ##args)
66#define lbs_deb_mesh(fmt, args...) LBS_DEB_LL(LBS_DEB_MESH, " mesh", fmt, ##args)
67#define lbs_deb_wext(fmt, args...) LBS_DEB_LL(LBS_DEB_WEXT, " wext", fmt, ##args)
68#define lbs_deb_ioctl(fmt, args...) LBS_DEB_LL(LBS_DEB_IOCTL, " ioctl", fmt, ##args)
69#define lbs_deb_scan(fmt, args...) LBS_DEB_LL(LBS_DEB_SCAN, " scan", fmt, ##args)
70#define lbs_deb_assoc(fmt, args...) LBS_DEB_LL(LBS_DEB_ASSOC, " assoc", fmt, ##args)
71#define lbs_deb_join(fmt, args...) LBS_DEB_LL(LBS_DEB_JOIN, " join", fmt, ##args)
72#define lbs_deb_11d(fmt, args...) LBS_DEB_LL(LBS_DEB_11D, " 11d", fmt, ##args)
73#define lbs_deb_debugfs(fmt, args...) LBS_DEB_LL(LBS_DEB_DEBUGFS, " debugfs", fmt, ##args)
74#define lbs_deb_ethtool(fmt, args...) LBS_DEB_LL(LBS_DEB_ETHTOOL, " ethtool", fmt, ##args)
75#define lbs_deb_host(fmt, args...) LBS_DEB_LL(LBS_DEB_HOST, " host", fmt, ##args)
76#define lbs_deb_cmd(fmt, args...) LBS_DEB_LL(LBS_DEB_CMD, " cmd", fmt, ##args)
77#define lbs_deb_rx(fmt, args...) LBS_DEB_LL(LBS_DEB_RX, " rx", fmt, ##args)
78#define lbs_deb_tx(fmt, args...) LBS_DEB_LL(LBS_DEB_TX, " tx", fmt, ##args)
79#define lbs_deb_fw(fmt, args...) LBS_DEB_LL(LBS_DEB_FW, " fw", fmt, ##args)
80#define lbs_deb_usb(fmt, args...) LBS_DEB_LL(LBS_DEB_USB, " usb", fmt, ##args)
81#define lbs_deb_usbd(dev, fmt, args...) LBS_DEB_LL(LBS_DEB_USB, " usbd", "%s:" fmt, (dev)->bus_id, ##args)
82#define lbs_deb_cs(fmt, args...) LBS_DEB_LL(LBS_DEB_CS, " cs", fmt, ##args)
83#define lbs_deb_thread(fmt, args...) LBS_DEB_LL(LBS_DEB_THREAD, " thread", fmt, ##args)
727c26ed 84#define lbs_deb_sdio(fmt, args...) LBS_DEB_LL(LBS_DEB_SDIO, " thread", fmt, ##args)
876c9d3a
MT
85
86#define lbs_pr_info(format, args...) \
87 printk(KERN_INFO DRV_NAME": " format, ## args)
88#define lbs_pr_err(format, args...) \
89 printk(KERN_ERR DRV_NAME": " format, ## args)
90#define lbs_pr_alert(format, args...) \
91 printk(KERN_ALERT DRV_NAME": " format, ## args)
92
93#ifdef DEBUG
ece56191 94static inline void lbs_deb_hex(unsigned int grp, const char *prompt, u8 *buf, int len)
876c9d3a
MT
95{
96 int i = 0;
97
ece56191 98 if (len &&
10078321
HS
99 (lbs_debug & LBS_DEB_HEX) &&
100 (lbs_debug & grp))
ece56191
HS
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");
876c9d3a 112 }
876c9d3a
MT
113}
114#else
ece56191 115#define lbs_deb_hex(grp,prompt,buf,len) do {} while (0)
876c9d3a
MT
116#endif
117
9012b28a 118
876c9d3a
MT
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 MRVDRV_NUM_OF_CMD_BUFFER 10
136#define MRVDRV_SIZE_OF_CMD_BUFFER (2 * 1024)
137#define MRVDRV_MAX_CHANNEL_SIZE 14
876c9d3a
MT
138#define MRVDRV_ASSOCIATION_TIME_OUT 255
139#define MRVDRV_SNAP_HEADER_LEN 8
140
10078321 141#define LBS_UPLD_SIZE 2312
876c9d3a
MT
142#define DEV_NAME_LEN 32
143
144/** Misc constants */
145/* This section defines 802.11 specific contants */
146
147#define MRVDRV_MAX_BSS_DESCRIPTS 16
148#define MRVDRV_MAX_REGION_CODE 6
149
150#define MRVDRV_IGNORE_MULTIPLE_DTIM 0xfffe
151#define MRVDRV_MIN_MULTIPLE_DTIM 1
152#define MRVDRV_MAX_MULTIPLE_DTIM 5
153#define MRVDRV_DEFAULT_MULTIPLE_DTIM 1
154
155#define MRVDRV_DEFAULT_LISTEN_INTERVAL 10
156
157#define MRVDRV_CHANNELS_PER_SCAN 4
158#define MRVDRV_MAX_CHANNELS_PER_SCAN 14
159
876c9d3a
MT
160#define MRVDRV_MIN_BEACON_INTERVAL 20
161#define MRVDRV_MAX_BEACON_INTERVAL 1000
162#define MRVDRV_BEACON_INTERVAL 100
163
1e838bf3
LCC
164#define MARVELL_MESH_IE_LENGTH 9
165
208fdd2f 166/** INT status Bit Definition*/
c95c7f93
HS
167#define MRVDRV_TX_DNLD_RDY 0x0001
168#define MRVDRV_RX_UPLD_RDY 0x0002
169#define MRVDRV_CMD_DNLD_RDY 0x0004
170#define MRVDRV_CMD_UPLD_RDY 0x0008
171#define MRVDRV_CARDEVENT 0x0010
208fdd2f
HS
172
173#define SBI_EVENT_CAUSE_SHIFT 3
174
876c9d3a
MT
175/** TxPD status */
176
177/* Station firmware use TxPD status field to report final Tx transmit
178* result, Bit masks are used to present combined situations.
179*/
180
181#define MRVDRV_TxPD_POWER_MGMT_NULL_PACKET 0x01
182#define MRVDRV_TxPD_POWER_MGMT_LAST_PACKET 0x08
183
184/** Tx mesh flag */
185/* Currently we are using normal WDS flag as mesh flag.
186 * TODO: change to proper mesh flag when MAC understands it.
187 */
188#define TxPD_CONTROL_WDS_FRAME (1<<17)
189#define TxPD_MESH_FRAME TxPD_CONTROL_WDS_FRAME
190
191/** RxPD status */
192
193#define MRVDRV_RXPD_STATUS_OK 0x0001
194
195/** RxPD status - Received packet types */
196/** Rx mesh flag */
197/* Currently we are using normal WDS flag as mesh flag.
198 * TODO: change to proper mesh flag when MAC understands it.
199 */
200#define RxPD_CONTROL_WDS_FRAME (0x40)
201#define RxPD_MESH_FRAME RxPD_CONTROL_WDS_FRAME
202
203/** RSSI-related defines */
204/* RSSI constants are used to implement 802.11 RSSI threshold
205* indication. if the Rx packet signal got too weak for 5 consecutive
206* times, miniport driver (driver) will report this event to wrapper
207*/
208
209#define MRVDRV_NF_DEFAULT_SCAN_VALUE (-96)
210
211/** RTS/FRAG related defines */
212#define MRVDRV_RTS_MIN_VALUE 0
213#define MRVDRV_RTS_MAX_VALUE 2347
214#define MRVDRV_FRAG_MIN_VALUE 256
215#define MRVDRV_FRAG_MAX_VALUE 2346
216
217/* This is for firmware specific length */
218#define EXTRA_LEN 36
219
220#define MRVDRV_ETH_TX_PACKET_BUFFER_SIZE \
221 (ETH_FRAME_LEN + sizeof(struct txpd) + EXTRA_LEN)
222
223#define MRVDRV_ETH_RX_PACKET_BUFFER_SIZE \
224 (ETH_FRAME_LEN + sizeof(struct rxpd) \
225 + MRVDRV_SNAP_HEADER_LEN + EXTRA_LEN)
226
227#define CMD_F_HOSTCMD (1 << 0)
228#define FW_CAPINFO_WPA (1 << 0)
229
876c9d3a
MT
230#define KEY_LEN_WPA_AES 16
231#define KEY_LEN_WPA_TKIP 32
232#define KEY_LEN_WEP_104 13
233#define KEY_LEN_WEP_40 5
234
235#define RF_ANTENNA_1 0x1
236#define RF_ANTENNA_2 0x2
237#define RF_ANTENNA_AUTO 0xFFFF
238
239#define BAND_B (0x01)
240#define BAND_G (0x02)
241#define ALL_802_11_BANDS (BAND_B | BAND_G)
242
243/** MACRO DEFINITIONS */
244#define CAL_NF(NF) ((s32)(-(s32)(NF)))
245#define CAL_RSSI(SNR, NF) ((s32)((s32)(SNR) + CAL_NF(NF)))
246#define SCAN_RSSI(RSSI) (0x100 - ((u8)(RSSI)))
247
248#define DEFAULT_BCN_AVG_FACTOR 8
249#define DEFAULT_DATA_AVG_FACTOR 8
250#define AVG_SCALE 100
251#define CAL_AVG_SNR_NF(AVG, SNRNF, N) \
252 (((AVG) == 0) ? ((u16)(SNRNF) * AVG_SCALE) : \
253 ((((int)(AVG) * (N -1)) + ((u16)(SNRNF) * \
254 AVG_SCALE)) / N))
255
8c512765 256#define MAX_RATES 14
876c9d3a
MT
257
258#define MAX_LEDS 8
259
260#define IS_MESH_FRAME(x) (x->cb[6])
261#define SET_MESH_FRAME(x) (x->cb[6]=1)
262#define UNSET_MESH_FRAME(x) (x->cb[6]=0)
263
264/** Global Variable Declaration */
10078321
HS
265typedef struct _lbs_private lbs_private;
266typedef struct _lbs_adapter lbs_adapter;
267extern const char lbs_driver_version[];
268extern u16 lbs_region_code_to_index[MRVDRV_MAX_REGION_CODE];
876c9d3a 269
10078321 270extern u8 lbs_bg_rates[MAX_RATES];
876c9d3a
MT
271
272/** ENUM definition*/
273/** SNRNF_TYPE */
274enum SNRNF_TYPE {
275 TYPE_BEACON = 0,
276 TYPE_RXPD,
277 MAX_TYPE_B
278};
279
280/** SNRNF_DATA*/
281enum SNRNF_DATA {
282 TYPE_NOAVG = 0,
283 TYPE_AVG,
284 MAX_TYPE_AVG
285};
286
10078321
HS
287/** LBS_802_11_POWER_MODE */
288enum LBS_802_11_POWER_MODE {
289 LBS802_11POWERMODECAM,
290 LBS802_11POWERMODEMAX_PSP,
291 LBS802_11POWERMODEFAST_PSP,
876c9d3a 292 /*not a real mode, defined as an upper bound */
10078321 293 LBS802_11POWEMODEMAX
876c9d3a
MT
294};
295
296/** PS_STATE */
297enum PS_STATE {
298 PS_STATE_FULL_POWER,
299 PS_STATE_AWAKE,
300 PS_STATE_PRE_SLEEP,
301 PS_STATE_SLEEP
302};
303
304/** DNLD_STATE */
305enum DNLD_STATE {
306 DNLD_RES_RECEIVED,
307 DNLD_DATA_SENT,
308 DNLD_CMD_SENT
309};
310
10078321
HS
311/** LBS_MEDIA_STATE */
312enum LBS_MEDIA_STATE {
313 LBS_CONNECTED,
314 LBS_DISCONNECTED
876c9d3a
MT
315};
316
10078321
HS
317/** LBS_802_11_PRIVACY_FILTER */
318enum LBS_802_11_PRIVACY_FILTER {
319 LBS802_11PRIVFILTERACCEPTALL,
320 LBS802_11PRIVFILTER8021XWEP
876c9d3a
MT
321};
322
323/** mv_ms_type */
324enum mv_ms_type {
325 MVMS_DAT = 0,
326 MVMS_CMD = 1,
327 MVMS_TXDONE = 2,
328 MVMS_EVENT
329};
876c9d3a
MT
330
331/** SNMP_MIB_INDEX_e */
332enum SNMP_MIB_INDEX_e {
0aef64d7
DW
333 DESIRED_BSSTYPE_I = 0,
334 OP_RATESET_I,
335 BCNPERIOD_I,
336 DTIMPERIOD_I,
337 ASSOCRSP_TIMEOUT_I,
338 RTSTHRESH_I,
339 SHORT_RETRYLIM_I,
340 LONG_RETRYLIM_I,
341 FRAGTHRESH_I,
342 DOT11D_I,
343 DOT11H_I,
344 MANUFID_I,
345 PRODID_I,
346 MANUF_OUI_I,
347 MANUF_NAME_I,
348 MANUF_PRODNAME_I,
349 MANUF_PRODVER_I,
876c9d3a
MT
350};
351
352/** KEY_TYPE_ID */
353enum KEY_TYPE_ID {
354 KEY_TYPE_ID_WEP = 0,
355 KEY_TYPE_ID_TKIP,
356 KEY_TYPE_ID_AES
357};
358
359/** KEY_INFO_WPA (applies to both TKIP and AES/CCMP) */
360enum KEY_INFO_WPA {
361 KEY_INFO_WPA_MCAST = 0x01,
362 KEY_INFO_WPA_UNICAST = 0x02,
363 KEY_INFO_WPA_ENABLED = 0x04
364};
365
366/** SNMP_MIB_VALUE_e */
367enum SNMP_MIB_VALUE_e {
368 SNMP_MIB_VALUE_INFRA = 1,
369 SNMP_MIB_VALUE_ADHOC
370};
371
372/* Default values for fwt commands. */
373#define FWT_DEFAULT_METRIC 0
374#define FWT_DEFAULT_DIR 1
90e8eafc
LCC
375/* Default Rate, 11Mbps */
376#define FWT_DEFAULT_RATE 3
876c9d3a
MT
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
10078321 385#endif
This page took 0.273154 seconds and 5 git commands to generate.