ipw2100, ipw2200: select LIB80211
[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
15dbaac0 43#define LBS_DEB_SYSFS 0x00800000
a46c6410 44
10078321 45extern unsigned int lbs_debug;
9012b28a
HS
46
47#ifdef DEBUG
ece56191 48#define LBS_DEB_LL(grp, grpnam, fmt, args...) \
10078321 49do { if ((lbs_debug & (grp)) == (grp)) \
ece56191 50 printk(KERN_DEBUG DRV_NAME grpnam "%s: " fmt, \
9012b28a
HS
51 in_interrupt() ? " (INT)" : "", ## args); } while (0)
52#else
ece56191 53#define LBS_DEB_LL(grp, grpnam, fmt, args...) do {} while (0)
9012b28a
HS
54#endif
55
56#define lbs_deb_enter(grp) \
e5225b39 57 LBS_DEB_LL(grp | LBS_DEB_ENTER, " enter", "%s()\n", __func__);
9012b28a 58#define lbs_deb_enter_args(grp, fmt, args...) \
e5225b39 59 LBS_DEB_LL(grp | LBS_DEB_ENTER, " enter", "%s(" fmt ")\n", __func__, ## args);
9012b28a 60#define lbs_deb_leave(grp) \
e5225b39 61 LBS_DEB_LL(grp | LBS_DEB_LEAVE, " leave", "%s()\n", __func__);
9012b28a 62#define lbs_deb_leave_args(grp, fmt, args...) \
e5225b39
HS
63 LBS_DEB_LL(grp | LBS_DEB_LEAVE, " leave", "%s(), " fmt "\n", \
64 __func__, ##args);
ece56191
HS
65#define lbs_deb_main(fmt, args...) LBS_DEB_LL(LBS_DEB_MAIN, " main", fmt, ##args)
66#define lbs_deb_net(fmt, args...) LBS_DEB_LL(LBS_DEB_NET, " net", fmt, ##args)
67#define lbs_deb_mesh(fmt, args...) LBS_DEB_LL(LBS_DEB_MESH, " mesh", fmt, ##args)
68#define lbs_deb_wext(fmt, args...) LBS_DEB_LL(LBS_DEB_WEXT, " wext", fmt, ##args)
69#define lbs_deb_ioctl(fmt, args...) LBS_DEB_LL(LBS_DEB_IOCTL, " ioctl", fmt, ##args)
70#define lbs_deb_scan(fmt, args...) LBS_DEB_LL(LBS_DEB_SCAN, " scan", fmt, ##args)
71#define lbs_deb_assoc(fmt, args...) LBS_DEB_LL(LBS_DEB_ASSOC, " assoc", fmt, ##args)
72#define lbs_deb_join(fmt, args...) LBS_DEB_LL(LBS_DEB_JOIN, " join", fmt, ##args)
73#define lbs_deb_11d(fmt, args...) LBS_DEB_LL(LBS_DEB_11D, " 11d", fmt, ##args)
74#define lbs_deb_debugfs(fmt, args...) LBS_DEB_LL(LBS_DEB_DEBUGFS, " debugfs", fmt, ##args)
75#define lbs_deb_ethtool(fmt, args...) LBS_DEB_LL(LBS_DEB_ETHTOOL, " ethtool", fmt, ##args)
76#define lbs_deb_host(fmt, args...) LBS_DEB_LL(LBS_DEB_HOST, " host", fmt, ##args)
77#define lbs_deb_cmd(fmt, args...) LBS_DEB_LL(LBS_DEB_CMD, " cmd", fmt, ##args)
78#define lbs_deb_rx(fmt, args...) LBS_DEB_LL(LBS_DEB_RX, " rx", fmt, ##args)
79#define lbs_deb_tx(fmt, args...) LBS_DEB_LL(LBS_DEB_TX, " tx", fmt, ##args)
80#define lbs_deb_fw(fmt, args...) LBS_DEB_LL(LBS_DEB_FW, " fw", fmt, ##args)
81#define lbs_deb_usb(fmt, args...) LBS_DEB_LL(LBS_DEB_USB, " usb", fmt, ##args)
fb28ad35 82#define lbs_deb_usbd(dev, fmt, args...) LBS_DEB_LL(LBS_DEB_USB, " usbd", "%s:" fmt, dev_name(dev), ##args)
ece56191
HS
83#define lbs_deb_cs(fmt, args...) LBS_DEB_LL(LBS_DEB_CS, " cs", fmt, ##args)
84#define lbs_deb_thread(fmt, args...) LBS_DEB_LL(LBS_DEB_THREAD, " thread", fmt, ##args)
15dbaac0
JC
85#define lbs_deb_sdio(fmt, args...) LBS_DEB_LL(LBS_DEB_SDIO, " sdio", fmt, ##args)
86#define lbs_deb_sysfs(fmt, args...) LBS_DEB_LL(LBS_DEB_SYSFS, " sysfs", fmt, ##args)
876c9d3a
MT
87
88#define lbs_pr_info(format, args...) \
89 printk(KERN_INFO DRV_NAME": " format, ## args)
90#define lbs_pr_err(format, args...) \
91 printk(KERN_ERR DRV_NAME": " format, ## args)
92#define lbs_pr_alert(format, args...) \
93 printk(KERN_ALERT DRV_NAME": " format, ## args)
94
95#ifdef DEBUG
ece56191 96static inline void lbs_deb_hex(unsigned int grp, const char *prompt, u8 *buf, int len)
876c9d3a
MT
97{
98 int i = 0;
99
ece56191 100 if (len &&
10078321
HS
101 (lbs_debug & LBS_DEB_HEX) &&
102 (lbs_debug & grp))
ece56191
HS
103 {
104 for (i = 1; i <= len; i++) {
105 if ((i & 0xf) == 1) {
106 if (i != 1)
107 printk("\n");
108 printk(DRV_NAME " %s: ", prompt);
109 }
110 printk("%02x ", (u8) * buf);
111 buf++;
112 }
113 printk("\n");
876c9d3a 114 }
876c9d3a
MT
115}
116#else
ece56191 117#define lbs_deb_hex(grp,prompt,buf,len) do {} while (0)
876c9d3a
MT
118#endif
119
9012b28a 120
876c9d3a
MT
121
122/** Buffer Constants */
123
124/* The size of SQ memory PPA, DPA are 8 DWORDs, that keep the physical
125* addresses of TxPD buffers. Station has only 8 TxPD available, Whereas
126* driver has more local TxPDs. Each TxPD on the host memory is associated
127* with a Tx control node. The driver maintains 8 RxPD descriptors for
128* station firmware to store Rx packet information.
129*
130* Current version of MAC has a 32x6 multicast address buffer.
131*
132* 802.11b can have up to 14 channels, the driver keeps the
133* BSSID(MAC address) of each APs or Ad hoc stations it has sensed.
134*/
135
136#define MRVDRV_MAX_MULTICAST_LIST_SIZE 32
ddac4526
DW
137#define LBS_NUM_CMD_BUFFERS 10
138#define LBS_CMD_BUFFER_SIZE (2 * 1024)
876c9d3a 139#define MRVDRV_MAX_CHANNEL_SIZE 14
876c9d3a
MT
140#define MRVDRV_ASSOCIATION_TIME_OUT 255
141#define MRVDRV_SNAP_HEADER_LEN 8
142
10078321 143#define LBS_UPLD_SIZE 2312
876c9d3a
MT
144#define DEV_NAME_LEN 32
145
6ce4fd2a
DW
146/* Wake criteria for HOST_SLEEP_CFG command */
147#define EHS_WAKE_ON_BROADCAST_DATA 0x0001
148#define EHS_WAKE_ON_UNICAST_DATA 0x0002
149#define EHS_WAKE_ON_MAC_EVENT 0x0004
150#define EHS_WAKE_ON_MULTICAST_DATA 0x0008
151#define EHS_REMOVE_WAKEUP 0xFFFFFFFF
152
876c9d3a
MT
153/** Misc constants */
154/* This section defines 802.11 specific contants */
155
156#define MRVDRV_MAX_BSS_DESCRIPTS 16
157#define MRVDRV_MAX_REGION_CODE 6
158
159#define MRVDRV_IGNORE_MULTIPLE_DTIM 0xfffe
160#define MRVDRV_MIN_MULTIPLE_DTIM 1
161#define MRVDRV_MAX_MULTIPLE_DTIM 5
162#define MRVDRV_DEFAULT_MULTIPLE_DTIM 1
163
164#define MRVDRV_DEFAULT_LISTEN_INTERVAL 10
165
166#define MRVDRV_CHANNELS_PER_SCAN 4
167#define MRVDRV_MAX_CHANNELS_PER_SCAN 14
168
876c9d3a
MT
169#define MRVDRV_MIN_BEACON_INTERVAL 20
170#define MRVDRV_MAX_BEACON_INTERVAL 1000
171#define MRVDRV_BEACON_INTERVAL 100
172
1e838bf3
LCC
173#define MARVELL_MESH_IE_LENGTH 9
174
edaea5ce
JC
175/* Values used to populate the struct mrvl_mesh_ie. The only time you need this
176 * is when enabling the mesh using CMD_MESH_CONFIG.
177 */
178#define MARVELL_MESH_IE_TYPE 4
179#define MARVELL_MESH_IE_SUBTYPE 0
180#define MARVELL_MESH_IE_VERSION 0
181#define MARVELL_MESH_PROTO_ID_HWMP 0
182#define MARVELL_MESH_METRIC_ID 0
183#define MARVELL_MESH_CAPABILITY 0
184
208fdd2f 185/** INT status Bit Definition*/
c95c7f93
HS
186#define MRVDRV_TX_DNLD_RDY 0x0001
187#define MRVDRV_RX_UPLD_RDY 0x0002
188#define MRVDRV_CMD_DNLD_RDY 0x0004
189#define MRVDRV_CMD_UPLD_RDY 0x0008
190#define MRVDRV_CARDEVENT 0x0010
208fdd2f 191
0112c9e9
AN
192/* Automatic TX control default levels */
193#define POW_ADAPT_DEFAULT_P0 13
194#define POW_ADAPT_DEFAULT_P1 15
195#define POW_ADAPT_DEFAULT_P2 18
196#define TPC_DEFAULT_P0 5
197#define TPC_DEFAULT_P1 10
198#define TPC_DEFAULT_P2 13
199
876c9d3a
MT
200/** TxPD status */
201
202/* Station firmware use TxPD status field to report final Tx transmit
203* result, Bit masks are used to present combined situations.
204*/
205
206#define MRVDRV_TxPD_POWER_MGMT_NULL_PACKET 0x01
207#define MRVDRV_TxPD_POWER_MGMT_LAST_PACKET 0x08
208
209/** Tx mesh flag */
210/* Currently we are using normal WDS flag as mesh flag.
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
216/** RxPD status */
217
218#define MRVDRV_RXPD_STATUS_OK 0x0001
219
220/** RxPD status - Received packet types */
221/** Rx mesh flag */
222/* Currently we are using normal WDS flag as mesh flag.
223 * TODO: change to proper mesh flag when MAC understands it.
224 */
225#define RxPD_CONTROL_WDS_FRAME (0x40)
226#define RxPD_MESH_FRAME RxPD_CONTROL_WDS_FRAME
227
228/** RSSI-related defines */
229/* RSSI constants are used to implement 802.11 RSSI threshold
230* indication. if the Rx packet signal got too weak for 5 consecutive
231* times, miniport driver (driver) will report this event to wrapper
232*/
233
234#define MRVDRV_NF_DEFAULT_SCAN_VALUE (-96)
235
236/** RTS/FRAG related defines */
237#define MRVDRV_RTS_MIN_VALUE 0
238#define MRVDRV_RTS_MAX_VALUE 2347
239#define MRVDRV_FRAG_MIN_VALUE 256
240#define MRVDRV_FRAG_MAX_VALUE 2346
241
242/* This is for firmware specific length */
243#define EXTRA_LEN 36
244
245#define MRVDRV_ETH_TX_PACKET_BUFFER_SIZE \
246 (ETH_FRAME_LEN + sizeof(struct txpd) + EXTRA_LEN)
247
248#define MRVDRV_ETH_RX_PACKET_BUFFER_SIZE \
249 (ETH_FRAME_LEN + sizeof(struct rxpd) \
250 + MRVDRV_SNAP_HEADER_LEN + EXTRA_LEN)
251
252#define CMD_F_HOSTCMD (1 << 0)
253#define FW_CAPINFO_WPA (1 << 0)
1556c0f2
BC
254#define FW_CAPINFO_FIRMWARE_UPGRADE (1 << 13)
255#define FW_CAPINFO_BOOT2_UPGRADE (1<<14)
256#define FW_CAPINFO_PERSISTENT_CONFIG (1<<15)
876c9d3a 257
876c9d3a
MT
258#define KEY_LEN_WPA_AES 16
259#define KEY_LEN_WPA_TKIP 32
260#define KEY_LEN_WEP_104 13
261#define KEY_LEN_WEP_40 5
262
263#define RF_ANTENNA_1 0x1
264#define RF_ANTENNA_2 0x2
265#define RF_ANTENNA_AUTO 0xFFFF
266
267#define BAND_B (0x01)
268#define BAND_G (0x02)
269#define ALL_802_11_BANDS (BAND_B | BAND_G)
270
271/** MACRO DEFINITIONS */
272#define CAL_NF(NF) ((s32)(-(s32)(NF)))
273#define CAL_RSSI(SNR, NF) ((s32)((s32)(SNR) + CAL_NF(NF)))
274#define SCAN_RSSI(RSSI) (0x100 - ((u8)(RSSI)))
275
276#define DEFAULT_BCN_AVG_FACTOR 8
277#define DEFAULT_DATA_AVG_FACTOR 8
278#define AVG_SCALE 100
279#define CAL_AVG_SNR_NF(AVG, SNRNF, N) \
280 (((AVG) == 0) ? ((u16)(SNRNF) * AVG_SCALE) : \
281 ((((int)(AVG) * (N -1)) + ((u16)(SNRNF) * \
282 AVG_SCALE)) / N))
283
8c512765 284#define MAX_RATES 14
876c9d3a
MT
285
286#define MAX_LEDS 8
287
876c9d3a 288/** Global Variable Declaration */
10078321
HS
289extern const char lbs_driver_version[];
290extern u16 lbs_region_code_to_index[MRVDRV_MAX_REGION_CODE];
876c9d3a 291
10078321 292extern u8 lbs_bg_rates[MAX_RATES];
876c9d3a
MT
293
294/** ENUM definition*/
295/** SNRNF_TYPE */
296enum SNRNF_TYPE {
297 TYPE_BEACON = 0,
298 TYPE_RXPD,
299 MAX_TYPE_B
300};
301
302/** SNRNF_DATA*/
303enum SNRNF_DATA {
304 TYPE_NOAVG = 0,
305 TYPE_AVG,
306 MAX_TYPE_AVG
307};
308
10078321
HS
309/** LBS_802_11_POWER_MODE */
310enum LBS_802_11_POWER_MODE {
311 LBS802_11POWERMODECAM,
312 LBS802_11POWERMODEMAX_PSP,
313 LBS802_11POWERMODEFAST_PSP,
876c9d3a 314 /*not a real mode, defined as an upper bound */
10078321 315 LBS802_11POWEMODEMAX
876c9d3a
MT
316};
317
318/** PS_STATE */
319enum PS_STATE {
320 PS_STATE_FULL_POWER,
321 PS_STATE_AWAKE,
322 PS_STATE_PRE_SLEEP,
323 PS_STATE_SLEEP
324};
325
326/** DNLD_STATE */
327enum DNLD_STATE {
328 DNLD_RES_RECEIVED,
329 DNLD_DATA_SENT,
1556c0f2
BC
330 DNLD_CMD_SENT,
331 DNLD_BOOTCMD_SENT,
876c9d3a
MT
332};
333
10078321
HS
334/** LBS_MEDIA_STATE */
335enum LBS_MEDIA_STATE {
336 LBS_CONNECTED,
337 LBS_DISCONNECTED
876c9d3a
MT
338};
339
10078321
HS
340/** LBS_802_11_PRIVACY_FILTER */
341enum LBS_802_11_PRIVACY_FILTER {
342 LBS802_11PRIVFILTERACCEPTALL,
343 LBS802_11PRIVFILTER8021XWEP
876c9d3a
MT
344};
345
346/** mv_ms_type */
347enum mv_ms_type {
348 MVMS_DAT = 0,
349 MVMS_CMD = 1,
350 MVMS_TXDONE = 2,
351 MVMS_EVENT
352};
876c9d3a 353
876c9d3a
MT
354/** KEY_TYPE_ID */
355enum KEY_TYPE_ID {
356 KEY_TYPE_ID_WEP = 0,
357 KEY_TYPE_ID_TKIP,
358 KEY_TYPE_ID_AES
359};
360
361/** KEY_INFO_WPA (applies to both TKIP and AES/CCMP) */
362enum KEY_INFO_WPA {
363 KEY_INFO_WPA_MCAST = 0x01,
364 KEY_INFO_WPA_UNICAST = 0x02,
365 KEY_INFO_WPA_ENABLED = 0x04
366};
367
876c9d3a
MT
368/* Default values for fwt commands. */
369#define FWT_DEFAULT_METRIC 0
370#define FWT_DEFAULT_DIR 1
90e8eafc
LCC
371/* Default Rate, 11Mbps */
372#define FWT_DEFAULT_RATE 3
876c9d3a
MT
373#define FWT_DEFAULT_SSN 0xffffffff
374#define FWT_DEFAULT_DSN 0
375#define FWT_DEFAULT_HOPCOUNT 0
376#define FWT_DEFAULT_TTL 0
377#define FWT_DEFAULT_EXPIRATION 0
378#define FWT_DEFAULT_SLEEPMODE 0
379#define FWT_DEFAULT_SNR 0
380
10078321 381#endif
This page took 0.318545 seconds and 5 git commands to generate.