Commit | Line | Data |
---|---|---|
876c9d3a MT |
1 | /** |
2 | * This header file contains global constant/enum definitions, | |
3 | * global variable declaration. | |
4 | */ | |
5 | #ifndef _WLAN_DEFS_H_ | |
6 | #define _WLAN_DEFS_H_ | |
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 | |
42 | ||
43 | extern unsigned int libertas_debug; | |
9012b28a HS |
44 | |
45 | #ifdef DEBUG | |
46 | #define LBS_DEB_LL(grp, fmt, args...) \ | |
a46c6410 | 47 | do { if ((libertas_debug & (grp)) == (grp)) \ |
9012b28a HS |
48 | printk(KERN_DEBUG DRV_NAME "%s: " fmt, \ |
49 | in_interrupt() ? " (INT)" : "", ## args); } while (0) | |
50 | #else | |
51 | #define LBS_DEB_LL(grp, fmt, args...) do {} while (0) | |
52 | #endif | |
53 | ||
54 | #define lbs_deb_enter(grp) \ | |
ed37b516 | 55 | LBS_DEB_LL(grp | LBS_DEB_ENTER, "%s():%d enter\n", __FUNCTION__, __LINE__); |
9012b28a HS |
56 | #define lbs_deb_enter_args(grp, fmt, args...) \ |
57 | LBS_DEB_LL(grp | LBS_DEB_ENTER, "%s(" fmt "):%d\n", __FUNCTION__, ## args, __LINE__); | |
58 | #define lbs_deb_leave(grp) \ | |
59 | LBS_DEB_LL(grp | LBS_DEB_LEAVE, "%s():%d leave\n", __FUNCTION__, __LINE__); | |
60 | #define lbs_deb_leave_args(grp, fmt, args...) \ | |
61 | LBS_DEB_LL(grp | LBS_DEB_LEAVE, "%s():%d leave, " fmt "\n", \ | |
62 | __FUNCTION__, __LINE__, ##args); | |
63 | #define lbs_deb_main(fmt, args...) LBS_DEB_LL(LBS_DEB_MAIN, fmt, ##args) | |
64 | #define lbs_deb_net(fmt, args...) LBS_DEB_LL(LBS_DEB_NET, fmt, ##args) | |
65 | #define lbs_deb_mesh(fmt, args...) LBS_DEB_LL(LBS_DEB_MESH, fmt, ##args) | |
66 | #define lbs_deb_wext(fmt, args...) LBS_DEB_LL(LBS_DEB_WEXT, fmt, ##args) | |
67 | #define lbs_deb_ioctl(fmt, args...) LBS_DEB_LL(LBS_DEB_IOCTL, fmt, ##args) | |
68 | #define lbs_deb_scan(fmt, args...) LBS_DEB_LL(LBS_DEB_SCAN, fmt, ##args) | |
69 | #define lbs_deb_assoc(fmt, args...) LBS_DEB_LL(LBS_DEB_ASSOC, fmt, ##args) | |
70 | #define lbs_deb_join(fmt, args...) LBS_DEB_LL(LBS_DEB_JOIN, fmt, ##args) | |
71 | #define lbs_deb_11d(fmt, args...) LBS_DEB_LL(LBS_DEB_11D, fmt, ##args) | |
72 | #define lbs_deb_debugfs(fmt, args...) LBS_DEB_LL(LBS_DEB_DEBUGFS, fmt, ##args) | |
73 | #define lbs_deb_ethtool(fmt, args...) LBS_DEB_LL(LBS_DEB_ETHTOOL, fmt, ##args) | |
74 | #define lbs_deb_host(fmt, args...) LBS_DEB_LL(LBS_DEB_HOST, fmt, ##args) | |
75 | #define lbs_deb_cmd(fmt, args...) LBS_DEB_LL(LBS_DEB_CMD, fmt, ##args) | |
76 | #define lbs_deb_rx(fmt, args...) LBS_DEB_LL(LBS_DEB_RX, fmt, ##args) | |
77 | #define lbs_deb_tx(fmt, args...) LBS_DEB_LL(LBS_DEB_TX, fmt, ##args) | |
78 | #define lbs_deb_fw(fmt, args...) LBS_DEB_LL(LBS_DEB_FW, fmt, ##args) | |
79 | #define lbs_deb_usb(fmt, args...) LBS_DEB_LL(LBS_DEB_USB, fmt, ##args) | |
80 | #define lbs_deb_usbd(dev, fmt, args...) LBS_DEB_LL(LBS_DEB_USB, "%s:" fmt, (dev)->bus_id, ##args) | |
81 | #define lbs_deb_cs(fmt, args...) LBS_DEB_LL(LBS_DEB_CS, fmt, ##args) | |
82 | #define lbs_deb_thread(fmt, args...) LBS_DEB_LL(LBS_DEB_THREAD, fmt, ##args) | |
876c9d3a MT |
83 | |
84 | #define lbs_pr_info(format, args...) \ | |
85 | printk(KERN_INFO DRV_NAME": " format, ## args) | |
86 | #define lbs_pr_err(format, args...) \ | |
87 | printk(KERN_ERR DRV_NAME": " format, ## args) | |
88 | #define lbs_pr_alert(format, args...) \ | |
89 | printk(KERN_ALERT DRV_NAME": " format, ## args) | |
90 | ||
91 | #ifdef DEBUG | |
876c9d3a MT |
92 | static inline void lbs_dbg_hex(char *prompt, u8 * buf, int len) |
93 | { | |
94 | int i = 0; | |
95 | ||
a46c6410 | 96 | if (!(libertas_debug & LBS_DEB_HEX)) |
876c9d3a MT |
97 | return; |
98 | ||
99 | printk(KERN_DEBUG "%s: ", prompt); | |
100 | for (i = 1; i <= len; i++) { | |
9012b28a | 101 | printk("%02x ", (u8) * buf); |
876c9d3a MT |
102 | buf++; |
103 | } | |
104 | printk("\n"); | |
105 | } | |
106 | #else | |
876c9d3a MT |
107 | #define lbs_dbg_hex(x,y,z) do {} while (0) |
108 | #endif | |
109 | ||
9012b28a | 110 | |
876c9d3a MT |
111 | |
112 | /** Buffer Constants */ | |
113 | ||
114 | /* The size of SQ memory PPA, DPA are 8 DWORDs, that keep the physical | |
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 | */ | |
125 | ||
126 | #define MRVDRV_MAX_MULTICAST_LIST_SIZE 32 | |
127 | #define MRVDRV_NUM_OF_CMD_BUFFER 10 | |
128 | #define MRVDRV_SIZE_OF_CMD_BUFFER (2 * 1024) | |
129 | #define MRVDRV_MAX_CHANNEL_SIZE 14 | |
130 | #define MRVDRV_MAX_BSSID_LIST 64 | |
131 | #define MRVDRV_ASSOCIATION_TIME_OUT 255 | |
132 | #define MRVDRV_SNAP_HEADER_LEN 8 | |
133 | ||
134 | #define WLAN_UPLD_SIZE 2312 | |
135 | #define DEV_NAME_LEN 32 | |
136 | ||
137 | /** Misc constants */ | |
138 | /* This section defines 802.11 specific contants */ | |
139 | ||
140 | #define MRVDRV_MAX_BSS_DESCRIPTS 16 | |
141 | #define MRVDRV_MAX_REGION_CODE 6 | |
142 | ||
143 | #define MRVDRV_IGNORE_MULTIPLE_DTIM 0xfffe | |
144 | #define MRVDRV_MIN_MULTIPLE_DTIM 1 | |
145 | #define MRVDRV_MAX_MULTIPLE_DTIM 5 | |
146 | #define MRVDRV_DEFAULT_MULTIPLE_DTIM 1 | |
147 | ||
148 | #define MRVDRV_DEFAULT_LISTEN_INTERVAL 10 | |
149 | ||
150 | #define MRVDRV_CHANNELS_PER_SCAN 4 | |
151 | #define MRVDRV_MAX_CHANNELS_PER_SCAN 14 | |
152 | ||
153 | #define MRVDRV_DEBUG_RX_PATH 0x00000001 | |
154 | #define MRVDRV_DEBUG_TX_PATH 0x00000002 | |
155 | ||
156 | #define MRVDRV_MIN_BEACON_INTERVAL 20 | |
157 | #define MRVDRV_MAX_BEACON_INTERVAL 1000 | |
158 | #define MRVDRV_BEACON_INTERVAL 100 | |
159 | ||
208fdd2f HS |
160 | /** INT status Bit Definition*/ |
161 | #define his_cmddnldrdy 0x01 | |
162 | #define his_cardevent 0x02 | |
163 | #define his_cmdupldrdy 0x04 | |
164 | ||
165 | #define SBI_EVENT_CAUSE_SHIFT 3 | |
166 | ||
876c9d3a MT |
167 | /** TxPD status */ |
168 | ||
169 | /* Station firmware use TxPD status field to report final Tx transmit | |
170 | * result, Bit masks are used to present combined situations. | |
171 | */ | |
172 | ||
173 | #define MRVDRV_TxPD_POWER_MGMT_NULL_PACKET 0x01 | |
174 | #define MRVDRV_TxPD_POWER_MGMT_LAST_PACKET 0x08 | |
175 | ||
176 | /** Tx mesh flag */ | |
177 | /* Currently we are using normal WDS flag as mesh flag. | |
178 | * TODO: change to proper mesh flag when MAC understands it. | |
179 | */ | |
180 | #define TxPD_CONTROL_WDS_FRAME (1<<17) | |
181 | #define TxPD_MESH_FRAME TxPD_CONTROL_WDS_FRAME | |
182 | ||
183 | /** RxPD status */ | |
184 | ||
185 | #define MRVDRV_RXPD_STATUS_OK 0x0001 | |
186 | ||
187 | /** RxPD status - Received packet types */ | |
188 | /** Rx mesh flag */ | |
189 | /* Currently we are using normal WDS flag as mesh flag. | |
190 | * TODO: change to proper mesh flag when MAC understands it. | |
191 | */ | |
192 | #define RxPD_CONTROL_WDS_FRAME (0x40) | |
193 | #define RxPD_MESH_FRAME RxPD_CONTROL_WDS_FRAME | |
194 | ||
195 | /** RSSI-related defines */ | |
196 | /* RSSI constants are used to implement 802.11 RSSI threshold | |
197 | * indication. if the Rx packet signal got too weak for 5 consecutive | |
198 | * times, miniport driver (driver) will report this event to wrapper | |
199 | */ | |
200 | ||
201 | #define MRVDRV_NF_DEFAULT_SCAN_VALUE (-96) | |
202 | ||
203 | /** RTS/FRAG related defines */ | |
204 | #define MRVDRV_RTS_MIN_VALUE 0 | |
205 | #define MRVDRV_RTS_MAX_VALUE 2347 | |
206 | #define MRVDRV_FRAG_MIN_VALUE 256 | |
207 | #define MRVDRV_FRAG_MAX_VALUE 2346 | |
208 | ||
209 | /* This is for firmware specific length */ | |
210 | #define EXTRA_LEN 36 | |
211 | ||
212 | #define MRVDRV_ETH_TX_PACKET_BUFFER_SIZE \ | |
213 | (ETH_FRAME_LEN + sizeof(struct txpd) + EXTRA_LEN) | |
214 | ||
215 | #define MRVDRV_ETH_RX_PACKET_BUFFER_SIZE \ | |
216 | (ETH_FRAME_LEN + sizeof(struct rxpd) \ | |
217 | + MRVDRV_SNAP_HEADER_LEN + EXTRA_LEN) | |
218 | ||
219 | #define CMD_F_HOSTCMD (1 << 0) | |
220 | #define FW_CAPINFO_WPA (1 << 0) | |
221 | ||
222 | /** WPA key LENGTH*/ | |
223 | #define MRVL_MAX_KEY_WPA_KEY_LENGTH 32 | |
224 | ||
225 | #define KEY_LEN_WPA_AES 16 | |
226 | #define KEY_LEN_WPA_TKIP 32 | |
227 | #define KEY_LEN_WEP_104 13 | |
228 | #define KEY_LEN_WEP_40 5 | |
229 | ||
230 | #define RF_ANTENNA_1 0x1 | |
231 | #define RF_ANTENNA_2 0x2 | |
232 | #define RF_ANTENNA_AUTO 0xFFFF | |
233 | ||
234 | #define BAND_B (0x01) | |
235 | #define BAND_G (0x02) | |
236 | #define ALL_802_11_BANDS (BAND_B | BAND_G) | |
237 | ||
238 | /** MACRO DEFINITIONS */ | |
239 | #define CAL_NF(NF) ((s32)(-(s32)(NF))) | |
240 | #define CAL_RSSI(SNR, NF) ((s32)((s32)(SNR) + CAL_NF(NF))) | |
241 | #define SCAN_RSSI(RSSI) (0x100 - ((u8)(RSSI))) | |
242 | ||
243 | #define DEFAULT_BCN_AVG_FACTOR 8 | |
244 | #define DEFAULT_DATA_AVG_FACTOR 8 | |
245 | #define AVG_SCALE 100 | |
246 | #define CAL_AVG_SNR_NF(AVG, SNRNF, N) \ | |
247 | (((AVG) == 0) ? ((u16)(SNRNF) * AVG_SCALE) : \ | |
248 | ((((int)(AVG) * (N -1)) + ((u16)(SNRNF) * \ | |
249 | AVG_SCALE)) / N)) | |
250 | ||
251 | #define B_SUPPORTED_RATES 8 | |
252 | #define G_SUPPORTED_RATES 14 | |
253 | ||
254 | #define WLAN_SUPPORTED_RATES 14 | |
255 | ||
256 | #define MAX_LEDS 8 | |
257 | ||
258 | #define IS_MESH_FRAME(x) (x->cb[6]) | |
259 | #define SET_MESH_FRAME(x) (x->cb[6]=1) | |
260 | #define UNSET_MESH_FRAME(x) (x->cb[6]=0) | |
261 | ||
262 | /** Global Variable Declaration */ | |
263 | typedef struct _wlan_private wlan_private; | |
264 | typedef struct _wlan_adapter wlan_adapter; | |
265 | extern const char libertas_driver_version[]; | |
266 | extern u16 libertas_region_code_to_index[MRVDRV_MAX_REGION_CODE]; | |
267 | ||
876c9d3a MT |
268 | extern u8 libertas_supported_rates[G_SUPPORTED_RATES]; |
269 | ||
270 | extern u8 libertas_adhoc_rates_g[G_SUPPORTED_RATES]; | |
271 | ||
272 | extern u8 libertas_adhoc_rates_b[4]; | |
273 | ||
274 | /** ENUM definition*/ | |
275 | /** SNRNF_TYPE */ | |
276 | enum SNRNF_TYPE { | |
277 | TYPE_BEACON = 0, | |
278 | TYPE_RXPD, | |
279 | MAX_TYPE_B | |
280 | }; | |
281 | ||
282 | /** SNRNF_DATA*/ | |
283 | enum SNRNF_DATA { | |
284 | TYPE_NOAVG = 0, | |
285 | TYPE_AVG, | |
286 | MAX_TYPE_AVG | |
287 | }; | |
288 | ||
876c9d3a MT |
289 | /** WLAN_802_11_POWER_MODE */ |
290 | enum WLAN_802_11_POWER_MODE { | |
291 | wlan802_11powermodecam, | |
292 | wlan802_11powermodemax_psp, | |
293 | wlan802_11Powermodefast_psp, | |
294 | /*not a real mode, defined as an upper bound */ | |
295 | wlan802_11powemodemax | |
296 | }; | |
297 | ||
298 | /** PS_STATE */ | |
299 | enum PS_STATE { | |
300 | PS_STATE_FULL_POWER, | |
301 | PS_STATE_AWAKE, | |
302 | PS_STATE_PRE_SLEEP, | |
303 | PS_STATE_SLEEP | |
304 | }; | |
305 | ||
306 | /** DNLD_STATE */ | |
307 | enum DNLD_STATE { | |
308 | DNLD_RES_RECEIVED, | |
309 | DNLD_DATA_SENT, | |
310 | DNLD_CMD_SENT | |
311 | }; | |
312 | ||
313 | /** WLAN_MEDIA_STATE */ | |
314 | enum WLAN_MEDIA_STATE { | |
315 | libertas_connected, | |
316 | libertas_disconnected | |
317 | }; | |
318 | ||
319 | /** WLAN_802_11_PRIVACY_FILTER */ | |
320 | enum WLAN_802_11_PRIVACY_FILTER { | |
321 | wlan802_11privfilteracceptall, | |
322 | wlan802_11privfilter8021xWEP | |
323 | }; | |
324 | ||
325 | /** mv_ms_type */ | |
326 | enum mv_ms_type { | |
327 | MVMS_DAT = 0, | |
328 | MVMS_CMD = 1, | |
329 | MVMS_TXDONE = 2, | |
330 | MVMS_EVENT | |
331 | }; | |
876c9d3a MT |
332 | |
333 | /** SNMP_MIB_INDEX_e */ | |
334 | enum SNMP_MIB_INDEX_e { | |
335 | desired_bsstype_i = 0, | |
336 | op_rateset_i, | |
337 | bcnperiod_i, | |
338 | dtimperiod_i, | |
339 | assocrsp_timeout_i, | |
340 | rtsthresh_i, | |
341 | short_retrylim_i, | |
342 | long_retrylim_i, | |
343 | fragthresh_i, | |
344 | dot11d_i, | |
345 | dot11h_i, | |
346 | manufid_i, | |
347 | prodID_i, | |
348 | manuf_oui_i, | |
349 | manuf_name_i, | |
350 | manuf_prodname_i, | |
351 | manuf_prodver_i, | |
352 | }; | |
353 | ||
354 | /** KEY_TYPE_ID */ | |
355 | enum 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) */ | |
362 | enum KEY_INFO_WPA { | |
363 | KEY_INFO_WPA_MCAST = 0x01, | |
364 | KEY_INFO_WPA_UNICAST = 0x02, | |
365 | KEY_INFO_WPA_ENABLED = 0x04 | |
366 | }; | |
367 | ||
368 | /** SNMP_MIB_VALUE_e */ | |
369 | enum SNMP_MIB_VALUE_e { | |
370 | SNMP_MIB_VALUE_INFRA = 1, | |
371 | SNMP_MIB_VALUE_ADHOC | |
372 | }; | |
373 | ||
374 | /* Default values for fwt commands. */ | |
375 | #define FWT_DEFAULT_METRIC 0 | |
376 | #define FWT_DEFAULT_DIR 1 | |
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 /* _WLAN_DEFS_H_ */ |