2 * This header file contains global constant/enum definitions,
3 * global variable declaration.
8 #include <linux/spinlock.h>
10 #ifdef CONFIG_LIBERTAS_DEBUG
15 #define DRV_NAME "usb8xxx"
18 #define LBS_DEB_ENTER (1<<0)
19 #define LBS_DEB_LEAVE (1<<1)
20 #define LBS_DEB_MAIN (1<<2)
21 #define LBS_DEB_NET (1<<3)
22 #define LBS_DEB_MESH (1<<4)
23 #define LBS_DEB_WEXT (1<<5)
24 #define LBS_DEB_IOCTL (1<<6)
25 #define LBS_DEB_SCAN (1<<7)
26 #define LBS_DEB_ASSOC (1<<8)
27 #define LBS_DEB_JOIN (1<<9)
28 #define LBS_DEB_11D (1<<10)
29 #define LBS_DEB_DEBUGFS (1<<11)
30 #define LBS_DEB_ETHTOOL (1<<12)
31 #define LBS_DEB_HOST (1<<13)
32 #define LBS_DEB_CMD (1<<14)
33 #define LBS_DEB_RX (1<<15)
34 #define LBS_DEB_TX (1<<16)
35 #define LBS_DEB_FW (1<<17)
36 #define LBS_DEB_USB (1<<18)
37 #define LBS_DEB_CS (1<<19)
38 #define LBS_DEB_THREAD (1<<20)
39 #define LBS_DEB_HEX (1<<21)
41 extern unsigned int libertas_debug_flags;
44 #define LBS_DEB_LL(grp, fmt, args...) \
45 do { if ((libertas_debug_flags & (grp)) == (grp)) \
46 printk(KERN_DEBUG DRV_NAME "%s: " fmt, \
47 in_interrupt() ? " (INT)" : "", ## args); } while (0)
49 #define LBS_DEB_LL(grp, fmt, args...) do {} while (0)
52 #define lbs_deb_enter(grp) \
53 LBS_DEB_LL(grp | LBS_DEB_ENTER, "%s() %d enter\n", __FUNCTION__, __LINE__);
54 #define lbs_deb_enter_args(grp, fmt, args...) \
55 LBS_DEB_LL(grp | LBS_DEB_ENTER, "%s(" fmt "):%d\n", __FUNCTION__, ## args, __LINE__);
56 #define lbs_deb_leave(grp) \
57 LBS_DEB_LL(grp | LBS_DEB_LEAVE, "%s():%d leave\n", __FUNCTION__, __LINE__);
58 #define lbs_deb_leave_args(grp, fmt, args...) \
59 LBS_DEB_LL(grp | LBS_DEB_LEAVE, "%s():%d leave, " fmt "\n", \
60 __FUNCTION__, __LINE__, ##args);
61 #define lbs_deb_main(fmt, args...) LBS_DEB_LL(LBS_DEB_MAIN, fmt, ##args)
62 #define lbs_deb_net(fmt, args...) LBS_DEB_LL(LBS_DEB_NET, fmt, ##args)
63 #define lbs_deb_mesh(fmt, args...) LBS_DEB_LL(LBS_DEB_MESH, fmt, ##args)
64 #define lbs_deb_wext(fmt, args...) LBS_DEB_LL(LBS_DEB_WEXT, fmt, ##args)
65 #define lbs_deb_ioctl(fmt, args...) LBS_DEB_LL(LBS_DEB_IOCTL, fmt, ##args)
66 #define lbs_deb_scan(fmt, args...) LBS_DEB_LL(LBS_DEB_SCAN, fmt, ##args)
67 #define lbs_deb_assoc(fmt, args...) LBS_DEB_LL(LBS_DEB_ASSOC, fmt, ##args)
68 #define lbs_deb_join(fmt, args...) LBS_DEB_LL(LBS_DEB_JOIN, fmt, ##args)
69 #define lbs_deb_11d(fmt, args...) LBS_DEB_LL(LBS_DEB_11D, fmt, ##args)
70 #define lbs_deb_debugfs(fmt, args...) LBS_DEB_LL(LBS_DEB_DEBUGFS, fmt, ##args)
71 #define lbs_deb_ethtool(fmt, args...) LBS_DEB_LL(LBS_DEB_ETHTOOL, fmt, ##args)
72 #define lbs_deb_host(fmt, args...) LBS_DEB_LL(LBS_DEB_HOST, fmt, ##args)
73 #define lbs_deb_cmd(fmt, args...) LBS_DEB_LL(LBS_DEB_CMD, fmt, ##args)
74 #define lbs_deb_rx(fmt, args...) LBS_DEB_LL(LBS_DEB_RX, fmt, ##args)
75 #define lbs_deb_tx(fmt, args...) LBS_DEB_LL(LBS_DEB_TX, fmt, ##args)
76 #define lbs_deb_fw(fmt, args...) LBS_DEB_LL(LBS_DEB_FW, fmt, ##args)
77 #define lbs_deb_usb(fmt, args...) LBS_DEB_LL(LBS_DEB_USB, fmt, ##args)
78 #define lbs_deb_usbd(dev, fmt, args...) LBS_DEB_LL(LBS_DEB_USB, "%s:" fmt, (dev)->bus_id, ##args)
79 #define lbs_deb_cs(fmt, args...) LBS_DEB_LL(LBS_DEB_CS, fmt, ##args)
80 #define lbs_deb_thread(fmt, args...) LBS_DEB_LL(LBS_DEB_THREAD, fmt, ##args)
82 #define lbs_pr_info(format, args...) \
83 printk(KERN_INFO DRV_NAME": " format, ## args)
84 #define lbs_pr_err(format, args...) \
85 printk(KERN_ERR DRV_NAME": " format, ## args)
86 #define lbs_pr_alert(format, args...) \
87 printk(KERN_ALERT DRV_NAME": " format, ## args)
90 static inline void lbs_dbg_hex(char *prompt, u8 * buf, int len)
94 if (!(libertas_debug_flags & LBS_DEB_HEX))
97 printk(KERN_DEBUG "%s: ", prompt);
98 for (i = 1; i <= len; i++) {
99 printk("%02x ", (u8) * buf);
105 #define lbs_dbg_hex(x,y,z) do {} while (0)
110 /** Buffer Constants */
112 /* The size of SQ memory PPA, DPA are 8 DWORDs, that keep the physical
113 * addresses of TxPD buffers. Station has only 8 TxPD available, Whereas
114 * driver has more local TxPDs. Each TxPD on the host memory is associated
115 * with a Tx control node. The driver maintains 8 RxPD descriptors for
116 * station firmware to store Rx packet information.
118 * Current version of MAC has a 32x6 multicast address buffer.
120 * 802.11b can have up to 14 channels, the driver keeps the
121 * BSSID(MAC address) of each APs or Ad hoc stations it has sensed.
124 #define MRVDRV_MAX_MULTICAST_LIST_SIZE 32
125 #define MRVDRV_NUM_OF_CMD_BUFFER 10
126 #define MRVDRV_SIZE_OF_CMD_BUFFER (2 * 1024)
127 #define MRVDRV_MAX_CHANNEL_SIZE 14
128 #define MRVDRV_MAX_BSSID_LIST 64
129 #define MRVDRV_ASSOCIATION_TIME_OUT 255
130 #define MRVDRV_SNAP_HEADER_LEN 8
132 #define WLAN_UPLD_SIZE 2312
133 #define DEV_NAME_LEN 32
135 /** Misc constants */
136 /* This section defines 802.11 specific contants */
138 #define MRVDRV_MAX_BSS_DESCRIPTS 16
139 #define MRVDRV_MAX_REGION_CODE 6
141 #define MRVDRV_IGNORE_MULTIPLE_DTIM 0xfffe
142 #define MRVDRV_MIN_MULTIPLE_DTIM 1
143 #define MRVDRV_MAX_MULTIPLE_DTIM 5
144 #define MRVDRV_DEFAULT_MULTIPLE_DTIM 1
146 #define MRVDRV_DEFAULT_LISTEN_INTERVAL 10
148 #define MRVDRV_CHANNELS_PER_SCAN 4
149 #define MRVDRV_MAX_CHANNELS_PER_SCAN 14
151 #define MRVDRV_DEBUG_RX_PATH 0x00000001
152 #define MRVDRV_DEBUG_TX_PATH 0x00000002
154 #define MRVDRV_MIN_BEACON_INTERVAL 20
155 #define MRVDRV_MAX_BEACON_INTERVAL 1000
156 #define MRVDRV_BEACON_INTERVAL 100
160 /* Station firmware use TxPD status field to report final Tx transmit
161 * result, Bit masks are used to present combined situations.
164 #define MRVDRV_TxPD_POWER_MGMT_NULL_PACKET 0x01
165 #define MRVDRV_TxPD_POWER_MGMT_LAST_PACKET 0x08
168 /* Currently we are using normal WDS flag as mesh flag.
169 * TODO: change to proper mesh flag when MAC understands it.
171 #define TxPD_CONTROL_WDS_FRAME (1<<17)
172 #define TxPD_MESH_FRAME TxPD_CONTROL_WDS_FRAME
176 #define MRVDRV_RXPD_STATUS_OK 0x0001
178 /** RxPD status - Received packet types */
180 /* Currently we are using normal WDS flag as mesh flag.
181 * TODO: change to proper mesh flag when MAC understands it.
183 #define RxPD_CONTROL_WDS_FRAME (0x40)
184 #define RxPD_MESH_FRAME RxPD_CONTROL_WDS_FRAME
186 /** RSSI-related defines */
187 /* RSSI constants are used to implement 802.11 RSSI threshold
188 * indication. if the Rx packet signal got too weak for 5 consecutive
189 * times, miniport driver (driver) will report this event to wrapper
192 #define MRVDRV_NF_DEFAULT_SCAN_VALUE (-96)
194 /** RTS/FRAG related defines */
195 #define MRVDRV_RTS_MIN_VALUE 0
196 #define MRVDRV_RTS_MAX_VALUE 2347
197 #define MRVDRV_FRAG_MIN_VALUE 256
198 #define MRVDRV_FRAG_MAX_VALUE 2346
200 /* This is for firmware specific length */
203 #define MRVDRV_ETH_TX_PACKET_BUFFER_SIZE \
204 (ETH_FRAME_LEN + sizeof(struct txpd) + EXTRA_LEN)
206 #define MRVDRV_ETH_RX_PACKET_BUFFER_SIZE \
207 (ETH_FRAME_LEN + sizeof(struct rxpd) \
208 + MRVDRV_SNAP_HEADER_LEN + EXTRA_LEN)
210 #define CMD_F_HOSTCMD (1 << 0)
211 #define FW_CAPINFO_WPA (1 << 0)
214 #define MRVL_MAX_KEY_WPA_KEY_LENGTH 32
216 #define KEY_LEN_WPA_AES 16
217 #define KEY_LEN_WPA_TKIP 32
218 #define KEY_LEN_WEP_104 13
219 #define KEY_LEN_WEP_40 5
221 #define RF_ANTENNA_1 0x1
222 #define RF_ANTENNA_2 0x2
223 #define RF_ANTENNA_AUTO 0xFFFF
225 #define BAND_B (0x01)
226 #define BAND_G (0x02)
227 #define ALL_802_11_BANDS (BAND_B | BAND_G)
229 /** MACRO DEFINITIONS */
230 #define CAL_NF(NF) ((s32)(-(s32)(NF)))
231 #define CAL_RSSI(SNR, NF) ((s32)((s32)(SNR) + CAL_NF(NF)))
232 #define SCAN_RSSI(RSSI) (0x100 - ((u8)(RSSI)))
234 #define DEFAULT_BCN_AVG_FACTOR 8
235 #define DEFAULT_DATA_AVG_FACTOR 8
236 #define AVG_SCALE 100
237 #define CAL_AVG_SNR_NF(AVG, SNRNF, N) \
238 (((AVG) == 0) ? ((u16)(SNRNF) * AVG_SCALE) : \
239 ((((int)(AVG) * (N -1)) + ((u16)(SNRNF) * \
242 #define B_SUPPORTED_RATES 8
243 #define G_SUPPORTED_RATES 14
245 #define WLAN_SUPPORTED_RATES 14
249 #define IS_MESH_FRAME(x) (x->cb[6])
250 #define SET_MESH_FRAME(x) (x->cb[6]=1)
251 #define UNSET_MESH_FRAME(x) (x->cb[6]=0)
253 /** Global Variable Declaration */
254 typedef struct _wlan_private wlan_private;
255 typedef struct _wlan_adapter wlan_adapter;
256 extern const char libertas_driver_version[];
257 extern u16 libertas_region_code_to_index[MRVDRV_MAX_REGION_CODE];
259 extern u8 libertas_supported_rates[G_SUPPORTED_RATES];
261 extern u8 libertas_adhoc_rates_g[G_SUPPORTED_RATES];
263 extern u8 libertas_adhoc_rates_b[4];
265 /** ENUM definition*/
280 /** WLAN_802_11_POWER_MODE */
281 enum WLAN_802_11_POWER_MODE {
282 wlan802_11powermodecam,
283 wlan802_11powermodemax_psp,
284 wlan802_11Powermodefast_psp,
285 /*not a real mode, defined as an upper bound */
286 wlan802_11powemodemax
304 /** WLAN_MEDIA_STATE */
305 enum WLAN_MEDIA_STATE {
307 libertas_disconnected
310 /** WLAN_802_11_PRIVACY_FILTER */
311 enum WLAN_802_11_PRIVACY_FILTER {
312 wlan802_11privfilteracceptall,
313 wlan802_11privfilter8021xWEP
324 /** SNMP_MIB_INDEX_e */
325 enum SNMP_MIB_INDEX_e {
326 desired_bsstype_i = 0,
352 /** KEY_INFO_WPA (applies to both TKIP and AES/CCMP) */
354 KEY_INFO_WPA_MCAST = 0x01,
355 KEY_INFO_WPA_UNICAST = 0x02,
356 KEY_INFO_WPA_ENABLED = 0x04
359 /** SNMP_MIB_VALUE_e */
360 enum SNMP_MIB_VALUE_e {
361 SNMP_MIB_VALUE_INFRA = 1,
365 /* Default values for fwt commands. */
366 #define FWT_DEFAULT_METRIC 0
367 #define FWT_DEFAULT_DIR 1
368 #define FWT_DEFAULT_SSN 0xffffffff
369 #define FWT_DEFAULT_DSN 0
370 #define FWT_DEFAULT_HOPCOUNT 0
371 #define FWT_DEFAULT_TTL 0
372 #define FWT_DEFAULT_EXPIRATION 0
373 #define FWT_DEFAULT_SLEEPMODE 0
374 #define FWT_DEFAULT_SNR 0
376 #endif /* _WLAN_DEFS_H_ */