2 * This header file contains global constant/enum definitions,
3 * global variable declaration.
8 #include <linux/spinlock.h>
10 #ifdef CONFIG_LIBERTAS_DEBUG
16 #define DRV_NAME "libertas"
20 * Really nasty hack to avoid stuffing compat.diff with tons of ifdefs,
21 * we could add this to a compat header file but too lazy to check ml_priv
22 * is not used anywhere else
24 #if (LINUX_VERSION_CODE < KERNEL_VERSION(2,6,26))
28 #define LBS_DEB_ENTER 0x00000001
29 #define LBS_DEB_LEAVE 0x00000002
30 #define LBS_DEB_MAIN 0x00000004
31 #define LBS_DEB_NET 0x00000008
32 #define LBS_DEB_MESH 0x00000010
33 #define LBS_DEB_WEXT 0x00000020
34 #define LBS_DEB_IOCTL 0x00000040
35 #define LBS_DEB_SCAN 0x00000080
36 #define LBS_DEB_ASSOC 0x00000100
37 #define LBS_DEB_JOIN 0x00000200
38 #define LBS_DEB_11D 0x00000400
39 #define LBS_DEB_DEBUGFS 0x00000800
40 #define LBS_DEB_ETHTOOL 0x00001000
41 #define LBS_DEB_HOST 0x00002000
42 #define LBS_DEB_CMD 0x00004000
43 #define LBS_DEB_RX 0x00008000
44 #define LBS_DEB_TX 0x00010000
45 #define LBS_DEB_USB 0x00020000
46 #define LBS_DEB_CS 0x00040000
47 #define LBS_DEB_FW 0x00080000
48 #define LBS_DEB_THREAD 0x00100000
49 #define LBS_DEB_HEX 0x00200000
50 #define LBS_DEB_SDIO 0x00400000
51 #define LBS_DEB_SYSFS 0x00800000
52 #define LBS_DEB_SPI 0x01000000
53 #define LBS_DEB_CFG80211 0x02000000
55 extern unsigned int lbs_debug;
58 #define LBS_DEB_LL(grp, grpnam, fmt, args...) \
59 do { if ((lbs_debug & (grp)) == (grp)) \
60 printk(KERN_DEBUG DRV_NAME grpnam "%s: " fmt, \
61 in_interrupt() ? " (INT)" : "", ## args); } while (0)
63 #define LBS_DEB_LL(grp, grpnam, fmt, args...) do {} while (0)
66 #define lbs_deb_enter(grp) \
67 LBS_DEB_LL(grp | LBS_DEB_ENTER, " enter", "%s()\n", __func__);
68 #define lbs_deb_enter_args(grp, fmt, args...) \
69 LBS_DEB_LL(grp | LBS_DEB_ENTER, " enter", "%s(" fmt ")\n", __func__, ## args);
70 #define lbs_deb_leave(grp) \
71 LBS_DEB_LL(grp | LBS_DEB_LEAVE, " leave", "%s()\n", __func__);
72 #define lbs_deb_leave_args(grp, fmt, args...) \
73 LBS_DEB_LL(grp | LBS_DEB_LEAVE, " leave", "%s(), " fmt "\n", \
75 #define lbs_deb_main(fmt, args...) LBS_DEB_LL(LBS_DEB_MAIN, " main", fmt, ##args)
76 #define lbs_deb_net(fmt, args...) LBS_DEB_LL(LBS_DEB_NET, " net", fmt, ##args)
77 #define lbs_deb_mesh(fmt, args...) LBS_DEB_LL(LBS_DEB_MESH, " mesh", fmt, ##args)
78 #define lbs_deb_wext(fmt, args...) LBS_DEB_LL(LBS_DEB_WEXT, " wext", fmt, ##args)
79 #define lbs_deb_ioctl(fmt, args...) LBS_DEB_LL(LBS_DEB_IOCTL, " ioctl", fmt, ##args)
80 #define lbs_deb_scan(fmt, args...) LBS_DEB_LL(LBS_DEB_SCAN, " scan", fmt, ##args)
81 #define lbs_deb_assoc(fmt, args...) LBS_DEB_LL(LBS_DEB_ASSOC, " assoc", fmt, ##args)
82 #define lbs_deb_join(fmt, args...) LBS_DEB_LL(LBS_DEB_JOIN, " join", fmt, ##args)
83 #define lbs_deb_11d(fmt, args...) LBS_DEB_LL(LBS_DEB_11D, " 11d", fmt, ##args)
84 #define lbs_deb_debugfs(fmt, args...) LBS_DEB_LL(LBS_DEB_DEBUGFS, " debugfs", fmt, ##args)
85 #define lbs_deb_ethtool(fmt, args...) LBS_DEB_LL(LBS_DEB_ETHTOOL, " ethtool", fmt, ##args)
86 #define lbs_deb_host(fmt, args...) LBS_DEB_LL(LBS_DEB_HOST, " host", fmt, ##args)
87 #define lbs_deb_cmd(fmt, args...) LBS_DEB_LL(LBS_DEB_CMD, " cmd", fmt, ##args)
88 #define lbs_deb_rx(fmt, args...) LBS_DEB_LL(LBS_DEB_RX, " rx", fmt, ##args)
89 #define lbs_deb_tx(fmt, args...) LBS_DEB_LL(LBS_DEB_TX, " tx", fmt, ##args)
90 #define lbs_deb_fw(fmt, args...) LBS_DEB_LL(LBS_DEB_FW, " fw", fmt, ##args)
91 #define lbs_deb_usb(fmt, args...) LBS_DEB_LL(LBS_DEB_USB, " usb", fmt, ##args)
92 #define lbs_deb_usbd(dev, fmt, args...) LBS_DEB_LL(LBS_DEB_USB, " usbd", "%s:" fmt, dev_name(dev), ##args)
93 #define lbs_deb_cs(fmt, args...) LBS_DEB_LL(LBS_DEB_CS, " cs", fmt, ##args)
94 #define lbs_deb_thread(fmt, args...) LBS_DEB_LL(LBS_DEB_THREAD, " thread", fmt, ##args)
95 #define lbs_deb_sdio(fmt, args...) LBS_DEB_LL(LBS_DEB_SDIO, " sdio", fmt, ##args)
96 #define lbs_deb_sysfs(fmt, args...) LBS_DEB_LL(LBS_DEB_SYSFS, " sysfs", fmt, ##args)
97 #define lbs_deb_spi(fmt, args...) LBS_DEB_LL(LBS_DEB_SPI, " spi", fmt, ##args)
98 #define lbs_deb_cfg80211(fmt, args...) LBS_DEB_LL(LBS_DEB_CFG80211, " cfg80211", fmt, ##args)
100 #define lbs_pr_info(format, args...) \
101 printk(KERN_INFO DRV_NAME": " format, ## args)
102 #define lbs_pr_err(format, args...) \
103 printk(KERN_ERR DRV_NAME": " format, ## args)
104 #define lbs_pr_alert(format, args...) \
105 printk(KERN_ALERT DRV_NAME": " format, ## args)
108 static inline void lbs_deb_hex(unsigned int grp, const char *prompt, u8 *buf, int len)
113 (lbs_debug & LBS_DEB_HEX) &&
116 for (i = 1; i <= len; i++) {
117 if ((i & 0xf) == 1) {
120 printk(DRV_NAME " %s: ", prompt);
122 printk("%02x ", (u8) * buf);
129 #define lbs_deb_hex(grp,prompt,buf,len) do {} while (0)
134 /** Buffer Constants */
136 /* The size of SQ memory PPA, DPA are 8 DWORDs, that keep the physical
137 * addresses of TxPD buffers. Station has only 8 TxPD available, Whereas
138 * driver has more local TxPDs. Each TxPD on the host memory is associated
139 * with a Tx control node. The driver maintains 8 RxPD descriptors for
140 * station firmware to store Rx packet information.
142 * Current version of MAC has a 32x6 multicast address buffer.
144 * 802.11b can have up to 14 channels, the driver keeps the
145 * BSSID(MAC address) of each APs or Ad hoc stations it has sensed.
148 #define MRVDRV_MAX_MULTICAST_LIST_SIZE 32
149 #define LBS_NUM_CMD_BUFFERS 10
150 #define LBS_CMD_BUFFER_SIZE (2 * 1024)
151 #define MRVDRV_MAX_CHANNEL_SIZE 14
152 #define MRVDRV_ASSOCIATION_TIME_OUT 255
153 #define MRVDRV_SNAP_HEADER_LEN 8
155 #define LBS_UPLD_SIZE 2312
156 #define DEV_NAME_LEN 32
158 /* Wake criteria for HOST_SLEEP_CFG command */
159 #define EHS_WAKE_ON_BROADCAST_DATA 0x0001
160 #define EHS_WAKE_ON_UNICAST_DATA 0x0002
161 #define EHS_WAKE_ON_MAC_EVENT 0x0004
162 #define EHS_WAKE_ON_MULTICAST_DATA 0x0008
163 #define EHS_REMOVE_WAKEUP 0xFFFFFFFF
164 /* Wake rules for Host_Sleep_CFG command */
165 #define WOL_RULE_NET_TYPE_INFRA_OR_IBSS 0x00
166 #define WOL_RULE_NET_TYPE_MESH 0x10
167 #define WOL_RULE_ADDR_TYPE_BCAST 0x01
168 #define WOL_RULE_ADDR_TYPE_MCAST 0x08
169 #define WOL_RULE_ADDR_TYPE_UCAST 0x02
170 #define WOL_RULE_OP_AND 0x01
171 #define WOL_RULE_OP_OR 0x02
172 #define WOL_RULE_OP_INVALID 0xFF
173 #define WOL_RESULT_VALID_CMD 0
174 #define WOL_RESULT_NOSPC_ERR 1
175 #define WOL_RESULT_EEXIST_ERR 2
177 /** Misc constants */
178 /* This section defines 802.11 specific contants */
180 #define MRVDRV_MAX_BSS_DESCRIPTS 16
181 #define MRVDRV_MAX_REGION_CODE 6
183 #define MRVDRV_IGNORE_MULTIPLE_DTIM 0xfffe
184 #define MRVDRV_MIN_MULTIPLE_DTIM 1
185 #define MRVDRV_MAX_MULTIPLE_DTIM 5
186 #define MRVDRV_DEFAULT_MULTIPLE_DTIM 1
188 #define MRVDRV_DEFAULT_LISTEN_INTERVAL 10
190 #define MRVDRV_CHANNELS_PER_SCAN 4
191 #define MRVDRV_MAX_CHANNELS_PER_SCAN 14
193 #define MRVDRV_MIN_BEACON_INTERVAL 20
194 #define MRVDRV_MAX_BEACON_INTERVAL 1000
195 #define MRVDRV_BEACON_INTERVAL 100
197 #define MARVELL_MESH_IE_LENGTH 9
199 /* Values used to populate the struct mrvl_mesh_ie. The only time you need this
200 * is when enabling the mesh using CMD_MESH_CONFIG.
202 #define MARVELL_MESH_IE_TYPE 4
203 #define MARVELL_MESH_IE_SUBTYPE 0
204 #define MARVELL_MESH_IE_VERSION 0
205 #define MARVELL_MESH_PROTO_ID_HWMP 0
206 #define MARVELL_MESH_METRIC_ID 0
207 #define MARVELL_MESH_CAPABILITY 0
209 /** INT status Bit Definition*/
210 #define MRVDRV_TX_DNLD_RDY 0x0001
211 #define MRVDRV_RX_UPLD_RDY 0x0002
212 #define MRVDRV_CMD_DNLD_RDY 0x0004
213 #define MRVDRV_CMD_UPLD_RDY 0x0008
214 #define MRVDRV_CARDEVENT 0x0010
216 /* Automatic TX control default levels */
217 #define POW_ADAPT_DEFAULT_P0 13
218 #define POW_ADAPT_DEFAULT_P1 15
219 #define POW_ADAPT_DEFAULT_P2 18
220 #define TPC_DEFAULT_P0 5
221 #define TPC_DEFAULT_P1 10
222 #define TPC_DEFAULT_P2 13
226 /* Station firmware use TxPD status field to report final Tx transmit
227 * result, Bit masks are used to present combined situations.
230 #define MRVDRV_TxPD_POWER_MGMT_NULL_PACKET 0x01
231 #define MRVDRV_TxPD_POWER_MGMT_LAST_PACKET 0x08
234 /* Currently we are using normal WDS flag as mesh flag.
235 * TODO: change to proper mesh flag when MAC understands it.
237 #define TxPD_CONTROL_WDS_FRAME (1<<17)
238 #define TxPD_MESH_FRAME TxPD_CONTROL_WDS_FRAME
240 /** Mesh interface ID */
241 #define MESH_IFACE_ID 0x0001
242 /** Mesh id should be in bits 14-13-12 */
243 #define MESH_IFACE_BIT_OFFSET 0x000c
244 /** Mesh enable bit in FW capability */
245 #define MESH_CAPINFO_ENABLE_MASK (1<<16)
247 /** FW definition from Marvell v4 */
248 #define MRVL_FW_V4 (0x04)
249 /** FW definition from Marvell v5 */
250 #define MRVL_FW_V5 (0x05)
251 /** FW definition from Marvell v10 */
252 #define MRVL_FW_V10 (0x0a)
253 /** FW major revision definition */
254 #define MRVL_FW_MAJOR_REV(x) ((x)>>24)
258 #define MRVDRV_RXPD_STATUS_OK 0x0001
260 /** RxPD status - Received packet types */
262 /* Currently we are using normal WDS flag as mesh flag.
263 * TODO: change to proper mesh flag when MAC understands it.
265 #define RxPD_CONTROL_WDS_FRAME (0x40)
266 #define RxPD_MESH_FRAME RxPD_CONTROL_WDS_FRAME
268 /** RSSI-related defines */
269 /* RSSI constants are used to implement 802.11 RSSI threshold
270 * indication. if the Rx packet signal got too weak for 5 consecutive
271 * times, miniport driver (driver) will report this event to wrapper
274 #define MRVDRV_NF_DEFAULT_SCAN_VALUE (-96)
276 /** RTS/FRAG related defines */
277 #define MRVDRV_RTS_MIN_VALUE 0
278 #define MRVDRV_RTS_MAX_VALUE 2347
279 #define MRVDRV_FRAG_MIN_VALUE 256
280 #define MRVDRV_FRAG_MAX_VALUE 2346
282 /* This is for firmware specific length */
285 #define MRVDRV_ETH_TX_PACKET_BUFFER_SIZE \
286 (ETH_FRAME_LEN + sizeof(struct txpd) + EXTRA_LEN)
288 #define MRVDRV_ETH_RX_PACKET_BUFFER_SIZE \
289 (ETH_FRAME_LEN + sizeof(struct rxpd) \
290 + MRVDRV_SNAP_HEADER_LEN + EXTRA_LEN)
292 #define CMD_F_HOSTCMD (1 << 0)
293 #define FW_CAPINFO_WPA (1 << 0)
294 #define FW_CAPINFO_PS (1 << 1)
295 #define FW_CAPINFO_FIRMWARE_UPGRADE (1 << 13)
296 #define FW_CAPINFO_BOOT2_UPGRADE (1<<14)
297 #define FW_CAPINFO_PERSISTENT_CONFIG (1<<15)
299 #define KEY_LEN_WPA_AES 16
300 #define KEY_LEN_WPA_TKIP 32
301 #define KEY_LEN_WEP_104 13
302 #define KEY_LEN_WEP_40 5
304 #define RF_ANTENNA_1 0x1
305 #define RF_ANTENNA_2 0x2
306 #define RF_ANTENNA_AUTO 0xFFFF
308 #define BAND_B (0x01)
309 #define BAND_G (0x02)
310 #define ALL_802_11_BANDS (BAND_B | BAND_G)
312 /** MACRO DEFINITIONS */
313 #define CAL_NF(NF) ((s32)(-(s32)(NF)))
314 #define CAL_RSSI(SNR, NF) ((s32)((s32)(SNR) + CAL_NF(NF)))
315 #define SCAN_RSSI(RSSI) (0x100 - ((u8)(RSSI)))
317 #define DEFAULT_BCN_AVG_FACTOR 8
318 #define DEFAULT_DATA_AVG_FACTOR 8
319 #define AVG_SCALE 100
320 #define CAL_AVG_SNR_NF(AVG, SNRNF, N) \
321 (((AVG) == 0) ? ((u16)(SNRNF) * AVG_SCALE) : \
322 ((((int)(AVG) * (N -1)) + ((u16)(SNRNF) * \
329 /** Global Variable Declaration */
330 extern const char lbs_driver_version[];
331 extern u16 lbs_region_code_to_index[MRVDRV_MAX_REGION_CODE];
334 /** ENUM definition*/
349 /** LBS_802_11_POWER_MODE */
350 enum LBS_802_11_POWER_MODE {
351 LBS802_11POWERMODECAM,
352 LBS802_11POWERMODEMAX_PSP,
353 LBS802_11POWERMODEFAST_PSP,
354 /*not a real mode, defined as an upper bound */
374 /** LBS_MEDIA_STATE */
375 enum LBS_MEDIA_STATE {
380 /** LBS_802_11_PRIVACY_FILTER */
381 enum LBS_802_11_PRIVACY_FILTER {
382 LBS802_11PRIVFILTERACCEPTALL,
383 LBS802_11PRIVFILTER8021XWEP
401 /** KEY_INFO_WPA (applies to both TKIP and AES/CCMP) */
403 KEY_INFO_WPA_MCAST = 0x01,
404 KEY_INFO_WPA_UNICAST = 0x02,
405 KEY_INFO_WPA_ENABLED = 0x04
408 /* Default values for fwt commands. */
409 #define FWT_DEFAULT_METRIC 0
410 #define FWT_DEFAULT_DIR 1
411 /* Default Rate, 11Mbps */
412 #define FWT_DEFAULT_RATE 3
413 #define FWT_DEFAULT_SSN 0xffffffff
414 #define FWT_DEFAULT_DSN 0
415 #define FWT_DEFAULT_HOPCOUNT 0
416 #define FWT_DEFAULT_TTL 0
417 #define FWT_DEFAULT_EXPIRATION 0
418 #define FWT_DEFAULT_SLEEPMODE 0
419 #define FWT_DEFAULT_SNR 0