1 /*
2  * Copyright (c) 2010-2011 Atheros Communications Inc.
3  * Copyright (c) 2011-2012 Qualcomm Atheros, Inc.
4  *
5  * Permission to use, copy, modify, and/or distribute this software for any
6  * purpose with or without fee is hereby granted, provided that the above
7  * copyright notice and this permission notice appear in all copies.
8  *
9  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16  */
17 
18 #ifndef CORE_H
19 #define CORE_H
20 
21 #include <linux/etherdevice.h>
22 #include <linux/rtnetlink.h>
23 #include <linux/firmware.h>
24 #include <linux/sched.h>
25 #include <linux/circ_buf.h>
26 #include <net/cfg80211.h>
27 #include "htc.h"
28 #include "wmi.h"
29 #include "bmi.h"
30 #include "target.h"
31 
32 #define MAX_ATH6KL                        1
33 #define ATH6KL_MAX_RX_BUFFERS             16
34 #define ATH6KL_BUFFER_SIZE                1664
35 #define ATH6KL_MAX_AMSDU_RX_BUFFERS       4
36 #define ATH6KL_AMSDU_REFILL_THRESHOLD     3
37 #define ATH6KL_AMSDU_BUFFER_SIZE     (WMI_MAX_AMSDU_RX_DATA_FRAME_LENGTH + 128)
38 #define MAX_MSDU_SUBFRAME_PAYLOAD_LEN	1508
39 #define MIN_MSDU_SUBFRAME_PAYLOAD_LEN	46
40 
41 #define USER_SAVEDKEYS_STAT_INIT     0
42 #define USER_SAVEDKEYS_STAT_RUN      1
43 
44 #define ATH6KL_TX_TIMEOUT      10
45 #define ATH6KL_MAX_ENDPOINTS   4
46 #define MAX_NODE_NUM           15
47 
48 #define ATH6KL_APSD_ALL_FRAME		0xFFFF
49 #define ATH6KL_APSD_NUM_OF_AC		0x4
50 #define ATH6KL_APSD_FRAME_MASK		0xF
51 
52 /* Extra bytes for htc header alignment */
53 #define ATH6KL_HTC_ALIGN_BYTES 3
54 
55 /* MAX_HI_COOKIE_NUM are reserved for high priority traffic */
56 #define MAX_DEF_COOKIE_NUM                180
57 #define MAX_HI_COOKIE_NUM                 18	/* 10% of MAX_COOKIE_NUM */
58 #define MAX_COOKIE_NUM                 (MAX_DEF_COOKIE_NUM + MAX_HI_COOKIE_NUM)
59 
60 #define MAX_DEFAULT_SEND_QUEUE_DEPTH      (MAX_DEF_COOKIE_NUM / WMM_NUM_AC)
61 
62 #define DISCON_TIMER_INTVAL               10000  /* in msec */
63 
64 /* Channel dwell time in fg scan */
65 #define ATH6KL_FG_SCAN_INTERVAL		50 /* in ms */
66 
67 /* includes also the null byte */
68 #define ATH6KL_FIRMWARE_MAGIC               "QCA-ATH6KL"
69 
70 enum ath6kl_fw_ie_type {
71 	ATH6KL_FW_IE_FW_VERSION = 0,
72 	ATH6KL_FW_IE_TIMESTAMP = 1,
73 	ATH6KL_FW_IE_OTP_IMAGE = 2,
74 	ATH6KL_FW_IE_FW_IMAGE = 3,
75 	ATH6KL_FW_IE_PATCH_IMAGE = 4,
76 	ATH6KL_FW_IE_RESERVED_RAM_SIZE = 5,
77 	ATH6KL_FW_IE_CAPABILITIES = 6,
78 	ATH6KL_FW_IE_PATCH_ADDR = 7,
79 	ATH6KL_FW_IE_BOARD_ADDR = 8,
80 	ATH6KL_FW_IE_VIF_MAX = 9,
81 };
82 
83 enum ath6kl_fw_capability {
84 	ATH6KL_FW_CAPABILITY_HOST_P2P = 0,
85 	ATH6KL_FW_CAPABILITY_SCHED_SCAN = 1,
86 
87 	/*
88 	 * Firmware is capable of supporting P2P mgmt operations on a
89 	 * station interface. After group formation, the station
90 	 * interface will become a P2P client/GO interface as the case may be
91 	 */
92 	ATH6KL_FW_CAPABILITY_STA_P2PDEV_DUPLEX,
93 
94 	/*
95 	 * Firmware has support to cleanup inactive stations
96 	 * in AP mode.
97 	 */
98 	ATH6KL_FW_CAPABILITY_INACTIVITY_TIMEOUT,
99 
100 	/* Firmware has support to override rsn cap of rsn ie */
101 	ATH6KL_FW_CAPABILITY_RSN_CAP_OVERRIDE,
102 
103 	/*
104 	 * Multicast support in WOW and host awake mode.
105 	 * Allow all multicast in host awake mode.
106 	 * Apply multicast filter in WOW mode.
107 	 */
108 	ATH6KL_FW_CAPABILITY_WOW_MULTICAST_FILTER,
109 
110 	/* Firmware supports enhanced bmiss detection */
111 	ATH6KL_FW_CAPABILITY_BMISS_ENHANCE,
112 
113 	/*
114 	 * FW supports matching of ssid in schedule scan
115 	 */
116 	ATH6KL_FW_CAPABILITY_SCHED_SCAN_MATCH_LIST,
117 
118 	/* Firmware supports filtering BSS results by RSSI */
119 	ATH6KL_FW_CAPABILITY_RSSI_SCAN_THOLD,
120 
121 	/* FW sets mac_addr[4] ^= 0x80 for newly created interfaces */
122 	ATH6KL_FW_CAPABILITY_CUSTOM_MAC_ADDR,
123 
124 	/* Firmware supports TX error rate notification */
125 	ATH6KL_FW_CAPABILITY_TX_ERR_NOTIFY,
126 
127 	/* supports WMI_SET_REGDOMAIN_CMDID command */
128 	ATH6KL_FW_CAPABILITY_REGDOMAIN,
129 
130 	/* Firmware supports sched scan decoupled from host sleep */
131 	ATH6KL_FW_CAPABILITY_SCHED_SCAN_V2,
132 
133 	/* this needs to be last */
134 	ATH6KL_FW_CAPABILITY_MAX,
135 };
136 
137 #define ATH6KL_CAPABILITY_LEN (ALIGN(ATH6KL_FW_CAPABILITY_MAX, 32) / 32)
138 
139 struct ath6kl_fw_ie {
140 	__le32 id;
141 	__le32 len;
142 	u8 data[0];
143 };
144 
145 enum ath6kl_hw_flags {
146 	ATH6KL_HW_FLAG_64BIT_RATES	= BIT(0),
147 };
148 
149 #define ATH6KL_FW_API2_FILE "fw-2.bin"
150 #define ATH6KL_FW_API3_FILE "fw-3.bin"
151 #define ATH6KL_FW_API4_FILE "fw-4.bin"
152 
153 /* AR6003 1.0 definitions */
154 #define AR6003_HW_1_0_VERSION                 0x300002ba
155 
156 /* AR6003 2.0 definitions */
157 #define AR6003_HW_2_0_VERSION                 0x30000384
158 #define AR6003_HW_2_0_PATCH_DOWNLOAD_ADDRESS  0x57e910
159 #define AR6003_HW_2_0_FW_DIR			"ath6k/AR6003/hw2.0"
160 #define AR6003_HW_2_0_OTP_FILE			"otp.bin.z77"
161 #define AR6003_HW_2_0_FIRMWARE_FILE		"athwlan.bin.z77"
162 #define AR6003_HW_2_0_TCMD_FIRMWARE_FILE	"athtcmd_ram.bin"
163 #define AR6003_HW_2_0_PATCH_FILE		"data.patch.bin"
164 #define AR6003_HW_2_0_BOARD_DATA_FILE AR6003_HW_2_0_FW_DIR "/bdata.bin"
165 #define AR6003_HW_2_0_DEFAULT_BOARD_DATA_FILE \
166 			AR6003_HW_2_0_FW_DIR "/bdata.SD31.bin"
167 
168 /* AR6003 3.0 definitions */
169 #define AR6003_HW_2_1_1_VERSION                 0x30000582
170 #define AR6003_HW_2_1_1_FW_DIR			"ath6k/AR6003/hw2.1.1"
171 #define AR6003_HW_2_1_1_OTP_FILE		"otp.bin"
172 #define AR6003_HW_2_1_1_FIRMWARE_FILE		"athwlan.bin"
173 #define AR6003_HW_2_1_1_TCMD_FIRMWARE_FILE	"athtcmd_ram.bin"
174 #define AR6003_HW_2_1_1_UTF_FIRMWARE_FILE	"utf.bin"
175 #define AR6003_HW_2_1_1_TESTSCRIPT_FILE	"nullTestFlow.bin"
176 #define AR6003_HW_2_1_1_PATCH_FILE		"data.patch.bin"
177 #define AR6003_HW_2_1_1_BOARD_DATA_FILE AR6003_HW_2_1_1_FW_DIR "/bdata.bin"
178 #define AR6003_HW_2_1_1_DEFAULT_BOARD_DATA_FILE	\
179 			AR6003_HW_2_1_1_FW_DIR "/bdata.SD31.bin"
180 
181 /* AR6004 1.0 definitions */
182 #define AR6004_HW_1_0_VERSION                 0x30000623
183 #define AR6004_HW_1_0_FW_DIR			"ath6k/AR6004/hw1.0"
184 #define AR6004_HW_1_0_FIRMWARE_FILE		"fw.ram.bin"
185 #define AR6004_HW_1_0_BOARD_DATA_FILE         AR6004_HW_1_0_FW_DIR "/bdata.bin"
186 #define AR6004_HW_1_0_DEFAULT_BOARD_DATA_FILE \
187 	AR6004_HW_1_0_FW_DIR "/bdata.DB132.bin"
188 
189 /* AR6004 1.1 definitions */
190 #define AR6004_HW_1_1_VERSION                 0x30000001
191 #define AR6004_HW_1_1_FW_DIR			"ath6k/AR6004/hw1.1"
192 #define AR6004_HW_1_1_FIRMWARE_FILE		"fw.ram.bin"
193 #define AR6004_HW_1_1_BOARD_DATA_FILE         AR6004_HW_1_1_FW_DIR "/bdata.bin"
194 #define AR6004_HW_1_1_DEFAULT_BOARD_DATA_FILE \
195 	AR6004_HW_1_1_FW_DIR "/bdata.DB132.bin"
196 
197 /* AR6004 1.2 definitions */
198 #define AR6004_HW_1_2_VERSION                 0x300007e8
199 #define AR6004_HW_1_2_FW_DIR			"ath6k/AR6004/hw1.2"
200 #define AR6004_HW_1_2_FIRMWARE_FILE           "fw.ram.bin"
201 #define AR6004_HW_1_2_BOARD_DATA_FILE         AR6004_HW_1_2_FW_DIR "/bdata.bin"
202 #define AR6004_HW_1_2_DEFAULT_BOARD_DATA_FILE \
203 	AR6004_HW_1_2_FW_DIR "/bdata.bin"
204 
205 /* AR6004 1.3 definitions */
206 #define AR6004_HW_1_3_VERSION			0x31c8088a
207 #define AR6004_HW_1_3_FW_DIR			"ath6k/AR6004/hw1.3"
208 #define AR6004_HW_1_3_FIRMWARE_FILE		"fw.ram.bin"
209 #define AR6004_HW_1_3_BOARD_DATA_FILE		"ath6k/AR6004/hw1.3/bdata.bin"
210 #define AR6004_HW_1_3_DEFAULT_BOARD_DATA_FILE	"ath6k/AR6004/hw1.3/bdata.bin"
211 
212 /* Per STA data, used in AP mode */
213 #define STA_PS_AWAKE		BIT(0)
214 #define	STA_PS_SLEEP		BIT(1)
215 #define	STA_PS_POLLED		BIT(2)
216 #define STA_PS_APSD_TRIGGER     BIT(3)
217 #define STA_PS_APSD_EOSP        BIT(4)
218 
219 /* HTC TX packet tagging definitions */
220 #define ATH6KL_CONTROL_PKT_TAG    HTC_TX_PACKET_TAG_USER_DEFINED
221 #define ATH6KL_DATA_PKT_TAG       (ATH6KL_CONTROL_PKT_TAG + 1)
222 
223 #define AR6003_CUST_DATA_SIZE 16
224 
225 #define AGGR_WIN_IDX(x, y)          ((x) % (y))
226 #define AGGR_INCR_IDX(x, y)         AGGR_WIN_IDX(((x) + 1), (y))
227 #define AGGR_DCRM_IDX(x, y)         AGGR_WIN_IDX(((x) - 1), (y))
228 #define ATH6KL_MAX_SEQ_NO		0xFFF
229 #define ATH6KL_NEXT_SEQ_NO(x)		(((x) + 1) & ATH6KL_MAX_SEQ_NO)
230 
231 #define NUM_OF_TIDS         8
232 #define AGGR_SZ_DEFAULT     8
233 
234 #define AGGR_WIN_SZ_MIN     2
235 #define AGGR_WIN_SZ_MAX     8
236 
237 #define TID_WINDOW_SZ(_x)   ((_x) << 1)
238 
239 #define AGGR_NUM_OF_FREE_NETBUFS    16
240 
241 #define AGGR_RX_TIMEOUT     100	/* in ms */
242 
243 #define WMI_TIMEOUT (2 * HZ)
244 
245 #define MBOX_YIELD_LIMIT 99
246 
247 #define ATH6KL_DEFAULT_LISTEN_INTVAL	100 /* in TUs */
248 #define ATH6KL_DEFAULT_BMISS_TIME	1500
249 #define ATH6KL_MAX_WOW_LISTEN_INTL	300 /* in TUs */
250 #define ATH6KL_MAX_BMISS_TIME		5000
251 
252 /* configuration lags */
253 /*
254  * ATH6KL_CONF_IGNORE_ERP_BARKER: Ignore the barker premable in
255  * ERP IE of beacon to determine the short premable support when
256  * sending (Re)Assoc req.
257  * ATH6KL_CONF_IGNORE_PS_FAIL_EVT_IN_SCAN: Don't send the power
258  * module state transition failure events which happen during
259  * scan, to the host.
260  */
261 #define ATH6KL_CONF_IGNORE_ERP_BARKER		BIT(0)
262 #define ATH6KL_CONF_IGNORE_PS_FAIL_EVT_IN_SCAN  BIT(1)
263 #define ATH6KL_CONF_ENABLE_11N			BIT(2)
264 #define ATH6KL_CONF_ENABLE_TX_BURST		BIT(3)
265 #define ATH6KL_CONF_UART_DEBUG			BIT(4)
266 
267 #define P2P_WILDCARD_SSID_LEN			7 /* DIRECT- */
268 
269 enum wlan_low_pwr_state {
270 	WLAN_POWER_STATE_ON,
271 	WLAN_POWER_STATE_CUT_PWR,
272 	WLAN_POWER_STATE_DEEP_SLEEP,
273 	WLAN_POWER_STATE_WOW
274 };
275 
276 enum sme_state {
277 	SME_DISCONNECTED,
278 	SME_CONNECTING,
279 	SME_CONNECTED
280 };
281 
282 struct skb_hold_q {
283 	struct sk_buff *skb;
284 	bool is_amsdu;
285 	u16 seq_no;
286 };
287 
288 struct rxtid {
289 	bool aggr;
290 	bool timer_mon;
291 	u16 win_sz;
292 	u16 seq_next;
293 	u32 hold_q_sz;
294 	struct skb_hold_q *hold_q;
295 	struct sk_buff_head q;
296 
297 	/*
298 	 * lock mainly protects seq_next and hold_q. Movement of seq_next
299 	 * needs to be protected between aggr_timeout() and
300 	 * aggr_process_recv_frm(). hold_q will be holding the pending
301 	 * reorder frames and it's access should also be protected.
302 	 * Some of the other fields like hold_q_sz, win_sz and aggr are
303 	 * initialized/reset when receiving addba/delba req, also while
304 	 * deleting aggr state all the pending buffers are flushed before
305 	 * resetting these fields, so there should not be any race in accessing
306 	 * these fields.
307 	 */
308 	spinlock_t lock;
309 };
310 
311 struct rxtid_stats {
312 	u32 num_into_aggr;
313 	u32 num_dups;
314 	u32 num_oow;
315 	u32 num_mpdu;
316 	u32 num_amsdu;
317 	u32 num_delivered;
318 	u32 num_timeouts;
319 	u32 num_hole;
320 	u32 num_bar;
321 };
322 
323 struct aggr_info_conn {
324 	u8 aggr_sz;
325 	u8 timer_scheduled;
326 	struct timer_list timer;
327 	struct net_device *dev;
328 	struct rxtid rx_tid[NUM_OF_TIDS];
329 	struct rxtid_stats stat[NUM_OF_TIDS];
330 	struct aggr_info *aggr_info;
331 };
332 
333 struct aggr_info {
334 	struct aggr_info_conn *aggr_conn;
335 	struct sk_buff_head rx_amsdu_freeq;
336 };
337 
338 struct ath6kl_wep_key {
339 	u8 key_index;
340 	u8 key_len;
341 	u8 key[64];
342 };
343 
344 #define ATH6KL_KEY_SEQ_LEN 8
345 
346 struct ath6kl_key {
347 	u8 key[WLAN_MAX_KEY_LEN];
348 	u8 key_len;
349 	u8 seq[ATH6KL_KEY_SEQ_LEN];
350 	u8 seq_len;
351 	u32 cipher;
352 };
353 
354 struct ath6kl_node_mapping {
355 	u8 mac_addr[ETH_ALEN];
356 	u8 ep_id;
357 	u8 tx_pend;
358 };
359 
360 struct ath6kl_cookie {
361 	struct sk_buff *skb;
362 	u32 map_no;
363 	struct htc_packet htc_pkt;
364 	struct ath6kl_cookie *arc_list_next;
365 };
366 
367 struct ath6kl_mgmt_buff {
368 	struct list_head list;
369 	u32 freq;
370 	u32 wait;
371 	u32 id;
372 	bool no_cck;
373 	size_t len;
374 	u8 buf[0];
375 };
376 
377 struct ath6kl_sta {
378 	u16 sta_flags;
379 	u8 mac[ETH_ALEN];
380 	u8 aid;
381 	u8 keymgmt;
382 	u8 ucipher;
383 	u8 auth;
384 	u8 wpa_ie[ATH6KL_MAX_IE];
385 	struct sk_buff_head psq;
386 
387 	/* protects psq, mgmt_psq, apsdq, and mgmt_psq_len fields */
388 	spinlock_t psq_lock;
389 
390 	struct list_head mgmt_psq;
391 	size_t mgmt_psq_len;
392 	u8 apsd_info;
393 	struct sk_buff_head apsdq;
394 	struct aggr_info_conn *aggr_conn;
395 };
396 
397 struct ath6kl_version {
398 	u32 target_ver;
399 	u32 wlan_ver;
400 	u32 abi_ver;
401 };
402 
403 struct ath6kl_bmi {
404 	u32 cmd_credits;
405 	bool done_sent;
406 	u8 *cmd_buf;
407 	u32 max_data_size;
408 	u32 max_cmd_size;
409 };
410 
411 struct target_stats {
412 	u64 tx_pkt;
413 	u64 tx_byte;
414 	u64 tx_ucast_pkt;
415 	u64 tx_ucast_byte;
416 	u64 tx_mcast_pkt;
417 	u64 tx_mcast_byte;
418 	u64 tx_bcast_pkt;
419 	u64 tx_bcast_byte;
420 	u64 tx_rts_success_cnt;
421 	u64 tx_pkt_per_ac[4];
422 
423 	u64 tx_err;
424 	u64 tx_fail_cnt;
425 	u64 tx_retry_cnt;
426 	u64 tx_mult_retry_cnt;
427 	u64 tx_rts_fail_cnt;
428 
429 	u64 rx_pkt;
430 	u64 rx_byte;
431 	u64 rx_ucast_pkt;
432 	u64 rx_ucast_byte;
433 	u64 rx_mcast_pkt;
434 	u64 rx_mcast_byte;
435 	u64 rx_bcast_pkt;
436 	u64 rx_bcast_byte;
437 	u64 rx_frgment_pkt;
438 
439 	u64 rx_err;
440 	u64 rx_crc_err;
441 	u64 rx_key_cache_miss;
442 	u64 rx_decrypt_err;
443 	u64 rx_dupl_frame;
444 
445 	u64 tkip_local_mic_fail;
446 	u64 tkip_cnter_measures_invoked;
447 	u64 tkip_replays;
448 	u64 tkip_fmt_err;
449 	u64 ccmp_fmt_err;
450 	u64 ccmp_replays;
451 
452 	u64 pwr_save_fail_cnt;
453 
454 	u64 cs_bmiss_cnt;
455 	u64 cs_low_rssi_cnt;
456 	u64 cs_connect_cnt;
457 	u64 cs_discon_cnt;
458 
459 	s32 tx_ucast_rate;
460 	s32 rx_ucast_rate;
461 
462 	u32 lq_val;
463 
464 	u32 wow_pkt_dropped;
465 	u16 wow_evt_discarded;
466 
467 	s16 noise_floor_calib;
468 	s16 cs_rssi;
469 	s16 cs_ave_beacon_rssi;
470 	u8 cs_ave_beacon_snr;
471 	u8 cs_last_roam_msec;
472 	u8 cs_snr;
473 
474 	u8 wow_host_pkt_wakeups;
475 	u8 wow_host_evt_wakeups;
476 
477 	u32 arp_received;
478 	u32 arp_matched;
479 	u32 arp_replied;
480 };
481 
482 struct ath6kl_mbox_info {
483 	u32 htc_addr;
484 	u32 htc_ext_addr;
485 	u32 htc_ext_sz;
486 
487 	u32 block_size;
488 
489 	u32 gmbox_addr;
490 
491 	u32 gmbox_sz;
492 };
493 
494 /*
495  * 802.11i defines an extended IV for use with non-WEP ciphers.
496  * When the EXTIV bit is set in the key id byte an additional
497  * 4 bytes immediately follow the IV for TKIP.  For CCMP the
498  * EXTIV bit is likewise set but the 8 bytes represent the
499  * CCMP header rather than IV+extended-IV.
500  */
501 
502 #define ATH6KL_KEYBUF_SIZE 16
503 #define ATH6KL_MICBUF_SIZE (8+8)	/* space for both tx and rx */
504 
505 #define ATH6KL_KEY_XMIT  0x01
506 #define ATH6KL_KEY_RECV  0x02
507 #define ATH6KL_KEY_DEFAULT   0x80	/* default xmit key */
508 
509 /* Initial group key for AP mode */
510 struct ath6kl_req_key {
511 	bool valid;
512 	u8 key_index;
513 	int key_type;
514 	u8 key[WLAN_MAX_KEY_LEN];
515 	u8 key_len;
516 };
517 
518 enum ath6kl_hif_type {
519 	ATH6KL_HIF_TYPE_SDIO,
520 	ATH6KL_HIF_TYPE_USB,
521 };
522 
523 enum ath6kl_htc_type {
524 	ATH6KL_HTC_TYPE_MBOX,
525 	ATH6KL_HTC_TYPE_PIPE,
526 };
527 
528 /* Max number of filters that hw supports */
529 #define ATH6K_MAX_MC_FILTERS_PER_LIST 7
530 struct ath6kl_mc_filter {
531 	struct list_head list;
532 	char hw_addr[ATH6KL_MCAST_FILTER_MAC_ADDR_SIZE];
533 };
534 
535 struct ath6kl_htcap {
536 	bool ht_enable;
537 	u8 ampdu_factor;
538 	unsigned short cap_info;
539 };
540 
541 /*
542  * Driver's maximum limit, note that some firmwares support only one vif
543  * and the runtime (current) limit must be checked from ar->vif_max.
544  */
545 #define ATH6KL_VIF_MAX	3
546 
547 /* vif flags info */
548 enum ath6kl_vif_state {
549 	CONNECTED,
550 	CONNECT_PEND,
551 	WMM_ENABLED,
552 	NETQ_STOPPED,
553 	DTIM_EXPIRED,
554 	NETDEV_REGISTERED,
555 	CLEAR_BSSFILTER_ON_BEACON,
556 	DTIM_PERIOD_AVAIL,
557 	WLAN_ENABLED,
558 	STATS_UPDATE_PEND,
559 	HOST_SLEEP_MODE_CMD_PROCESSED,
560 	NETDEV_MCAST_ALL_ON,
561 	NETDEV_MCAST_ALL_OFF,
562 	SCHED_SCANNING,
563 };
564 
565 struct ath6kl_vif {
566 	struct list_head list;
567 	struct wireless_dev wdev;
568 	struct net_device *ndev;
569 	struct ath6kl *ar;
570 	/* Lock to protect vif specific net_stats and flags */
571 	spinlock_t if_lock;
572 	u8 fw_vif_idx;
573 	unsigned long flags;
574 	int ssid_len;
575 	u8 ssid[IEEE80211_MAX_SSID_LEN];
576 	u8 dot11_auth_mode;
577 	u8 auth_mode;
578 	u8 prwise_crypto;
579 	u8 prwise_crypto_len;
580 	u8 grp_crypto;
581 	u8 grp_crypto_len;
582 	u8 def_txkey_index;
583 	u8 next_mode;
584 	u8 nw_type;
585 	u8 bssid[ETH_ALEN];
586 	u8 req_bssid[ETH_ALEN];
587 	u16 ch_hint;
588 	u16 bss_ch;
589 	struct ath6kl_wep_key wep_key_list[WMI_MAX_KEY_INDEX + 1];
590 	struct ath6kl_key keys[WMI_MAX_KEY_INDEX + 1];
591 	struct aggr_info *aggr_cntxt;
592 	struct ath6kl_htcap htcap[IEEE80211_NUM_BANDS];
593 
594 	struct timer_list disconnect_timer;
595 	struct timer_list sched_scan_timer;
596 
597 	struct cfg80211_scan_request *scan_req;
598 	enum sme_state sme_state;
599 	int reconnect_flag;
600 	u32 last_roc_id;
601 	u32 last_cancel_roc_id;
602 	u32 send_action_id;
603 	bool probe_req_report;
604 	u16 assoc_bss_beacon_int;
605 	u16 listen_intvl_t;
606 	u16 bmiss_time_t;
607 	u32 txe_intvl;
608 	u16 bg_scan_period;
609 	u8 assoc_bss_dtim_period;
610 	struct net_device_stats net_stats;
611 	struct target_stats target_stats;
612 	struct wmi_connect_cmd profile;
613 	u16 rsn_capab;
614 
615 	struct list_head mc_filter;
616 };
617 
618 static inline struct ath6kl_vif *ath6kl_vif_from_wdev(struct wireless_dev *wdev)
619 {
620 	return container_of(wdev, struct ath6kl_vif, wdev);
621 }
622 
623 #define WOW_LIST_ID		0
624 #define WOW_HOST_REQ_DELAY	500 /* ms */
625 
626 #define ATH6KL_SCHED_SCAN_RESULT_DELAY 5000 /* ms */
627 
628 /* Flag info */
629 enum ath6kl_dev_state {
630 	WMI_ENABLED,
631 	WMI_READY,
632 	WMI_CTRL_EP_FULL,
633 	TESTMODE,
634 	DESTROY_IN_PROGRESS,
635 	SKIP_SCAN,
636 	ROAM_TBL_PEND,
637 	FIRST_BOOT,
638 };
639 
640 enum ath6kl_state {
641 	ATH6KL_STATE_OFF,
642 	ATH6KL_STATE_ON,
643 	ATH6KL_STATE_SUSPENDING,
644 	ATH6KL_STATE_RESUMING,
645 	ATH6KL_STATE_DEEPSLEEP,
646 	ATH6KL_STATE_CUTPOWER,
647 	ATH6KL_STATE_WOW,
648 	ATH6KL_STATE_RECOVERY,
649 };
650 
651 /* Fw error recovery */
652 enum ath6kl_fw_err {
653 	ATH6KL_FW_ASSERT,
654 };
655 
656 struct ath6kl {
657 	struct device *dev;
658 	struct wiphy *wiphy;
659 
660 	enum ath6kl_state state;
661 	unsigned int testmode;
662 
663 	struct ath6kl_bmi bmi;
664 	const struct ath6kl_hif_ops *hif_ops;
665 	const struct ath6kl_htc_ops *htc_ops;
666 	struct wmi *wmi;
667 	int tx_pending[ENDPOINT_MAX];
668 	int total_tx_data_pend;
669 	struct htc_target *htc_target;
670 	enum ath6kl_hif_type hif_type;
671 	void *hif_priv;
672 	struct list_head vif_list;
673 	/* Lock to avoid race in vif_list entries among add/del/traverse */
674 	spinlock_t list_lock;
675 	u8 num_vif;
676 	unsigned int vif_max;
677 	u8 max_norm_iface;
678 	u8 avail_idx_map;
679 
680 	/*
681 	 * Protects at least amsdu_rx_buffer_queue, ath6kl_alloc_cookie()
682 	 * calls, tx_pending and total_tx_data_pend.
683 	 */
684 	spinlock_t lock;
685 
686 	struct semaphore sem;
687 	u8 lrssi_roam_threshold;
688 	struct ath6kl_version version;
689 	u32 target_type;
690 	u8 tx_pwr;
691 	struct ath6kl_node_mapping node_map[MAX_NODE_NUM];
692 	u8 ibss_ps_enable;
693 	bool ibss_if_active;
694 	u8 node_num;
695 	u8 next_ep_id;
696 	struct ath6kl_cookie *cookie_list;
697 	u32 cookie_count;
698 	enum htc_endpoint_id ac2ep_map[WMM_NUM_AC];
699 	bool ac_stream_active[WMM_NUM_AC];
700 	u8 ac_stream_pri_map[WMM_NUM_AC];
701 	u8 hiac_stream_active_pri;
702 	u8 ep2ac_map[ENDPOINT_MAX];
703 	enum htc_endpoint_id ctrl_ep;
704 	struct ath6kl_htc_credit_info credit_state_info;
705 	u32 connect_ctrl_flags;
706 	u32 user_key_ctrl;
707 	u8 usr_bss_filter;
708 	struct ath6kl_sta sta_list[AP_MAX_NUM_STA];
709 	u8 sta_list_index;
710 	struct ath6kl_req_key ap_mode_bkey;
711 	struct sk_buff_head mcastpsq;
712 	u32 want_ch_switch;
713 	u16 last_ch;
714 
715 	/*
716 	 * FIXME: protects access to mcastpsq but is actually useless as
717 	 * all skbe_queue_*() functions provide serialisation themselves
718 	 */
719 	spinlock_t mcastpsq_lock;
720 
721 	u8 intra_bss;
722 	struct wmi_ap_mode_stat ap_stats;
723 	u8 ap_country_code[3];
724 	struct list_head amsdu_rx_buffer_queue;
725 	u8 rx_meta_ver;
726 	enum wlan_low_pwr_state wlan_pwr_state;
727 	u8 mac_addr[ETH_ALEN];
728 #define AR_MCAST_FILTER_MAC_ADDR_SIZE  4
729 	struct {
730 		void *rx_report;
731 		size_t rx_report_len;
732 	} tm;
733 
734 	struct ath6kl_hw {
735 		u32 id;
736 		const char *name;
737 		u32 dataset_patch_addr;
738 		u32 app_load_addr;
739 		u32 app_start_override_addr;
740 		u32 board_ext_data_addr;
741 		u32 reserved_ram_size;
742 		u32 board_addr;
743 		u32 refclk_hz;
744 		u32 uarttx_pin;
745 		u32 testscript_addr;
746 		enum wmi_phy_cap cap;
747 
748 		u32 flags;
749 
750 		struct ath6kl_hw_fw {
751 			const char *dir;
752 			const char *otp;
753 			const char *fw;
754 			const char *tcmd;
755 			const char *patch;
756 			const char *utf;
757 			const char *testscript;
758 		} fw;
759 
760 		const char *fw_board;
761 		const char *fw_default_board;
762 	} hw;
763 
764 	u16 conf_flags;
765 	u16 suspend_mode;
766 	u16 wow_suspend_mode;
767 	wait_queue_head_t event_wq;
768 	struct ath6kl_mbox_info mbox_info;
769 
770 	struct ath6kl_cookie cookie_mem[MAX_COOKIE_NUM];
771 	unsigned long flag;
772 
773 	u8 *fw_board;
774 	size_t fw_board_len;
775 
776 	u8 *fw_otp;
777 	size_t fw_otp_len;
778 
779 	u8 *fw;
780 	size_t fw_len;
781 
782 	u8 *fw_patch;
783 	size_t fw_patch_len;
784 
785 	u8 *fw_testscript;
786 	size_t fw_testscript_len;
787 
788 	unsigned int fw_api;
789 	unsigned long fw_capabilities[ATH6KL_CAPABILITY_LEN];
790 
791 	struct workqueue_struct *ath6kl_wq;
792 
793 	struct dentry *debugfs_phy;
794 
795 	bool p2p;
796 
797 	bool wiphy_registered;
798 
799 	struct ath6kl_fw_recovery {
800 		bool enable;
801 		struct work_struct recovery_work;
802 		unsigned long err_reason;
803 	} fw_recovery;
804 
805 #ifdef CONFIG_ATH6KL_DEBUG
806 	struct {
807 		struct sk_buff_head fwlog_queue;
808 		struct completion fwlog_completion;
809 		bool fwlog_open;
810 
811 		u32 fwlog_mask;
812 
813 		unsigned int dbgfs_diag_reg;
814 		u32 diag_reg_addr_wr;
815 		u32 diag_reg_val_wr;
816 
817 		struct {
818 			unsigned int invalid_rate;
819 		} war_stats;
820 
821 		u8 *roam_tbl;
822 		unsigned int roam_tbl_len;
823 
824 		u8 keepalive;
825 		u8 disc_timeout;
826 	} debug;
827 #endif /* CONFIG_ATH6KL_DEBUG */
828 };
829 
830 static inline struct ath6kl *ath6kl_priv(struct net_device *dev)
831 {
832 	return ((struct ath6kl_vif *) netdev_priv(dev))->ar;
833 }
834 
835 static inline u32 ath6kl_get_hi_item_addr(struct ath6kl *ar,
836 					  u32 item_offset)
837 {
838 	u32 addr = 0;
839 
840 	if (ar->target_type == TARGET_TYPE_AR6003)
841 		addr = ATH6KL_AR6003_HI_START_ADDR + item_offset;
842 	else if (ar->target_type == TARGET_TYPE_AR6004)
843 		addr = ATH6KL_AR6004_HI_START_ADDR + item_offset;
844 
845 	return addr;
846 }
847 
848 int ath6kl_configure_target(struct ath6kl *ar);
849 void ath6kl_detect_error(unsigned long ptr);
850 void disconnect_timer_handler(unsigned long ptr);
851 void init_netdev(struct net_device *dev);
852 void ath6kl_cookie_init(struct ath6kl *ar);
853 void ath6kl_cookie_cleanup(struct ath6kl *ar);
854 void ath6kl_rx(struct htc_target *target, struct htc_packet *packet);
855 void ath6kl_tx_complete(struct htc_target *context,
856 			struct list_head *packet_queue);
857 enum htc_send_full_action ath6kl_tx_queue_full(struct htc_target *target,
858 					       struct htc_packet *packet);
859 void ath6kl_stop_txrx(struct ath6kl *ar);
860 void ath6kl_cleanup_amsdu_rxbufs(struct ath6kl *ar);
861 int ath6kl_diag_write32(struct ath6kl *ar, u32 address, __le32 value);
862 int ath6kl_diag_write(struct ath6kl *ar, u32 address, void *data, u32 length);
863 int ath6kl_diag_read32(struct ath6kl *ar, u32 address, u32 *value);
864 int ath6kl_diag_read(struct ath6kl *ar, u32 address, void *data, u32 length);
865 int ath6kl_read_fwlogs(struct ath6kl *ar);
866 void ath6kl_init_profile_info(struct ath6kl_vif *vif);
867 void ath6kl_tx_data_cleanup(struct ath6kl *ar);
868 
869 struct ath6kl_cookie *ath6kl_alloc_cookie(struct ath6kl *ar);
870 void ath6kl_free_cookie(struct ath6kl *ar, struct ath6kl_cookie *cookie);
871 int ath6kl_data_tx(struct sk_buff *skb, struct net_device *dev);
872 
873 struct aggr_info *aggr_init(struct ath6kl_vif *vif);
874 void aggr_conn_init(struct ath6kl_vif *vif, struct aggr_info *aggr_info,
875 		    struct aggr_info_conn *aggr_conn);
876 void ath6kl_rx_refill(struct htc_target *target,
877 		      enum htc_endpoint_id endpoint);
878 void ath6kl_refill_amsdu_rxbufs(struct ath6kl *ar, int count);
879 struct htc_packet *ath6kl_alloc_amsdu_rxbuf(struct htc_target *target,
880 					    enum htc_endpoint_id endpoint,
881 					    int len);
882 void aggr_module_destroy(struct aggr_info *aggr_info);
883 void aggr_reset_state(struct aggr_info_conn *aggr_conn);
884 
885 struct ath6kl_sta *ath6kl_find_sta(struct ath6kl_vif *vif, u8 *node_addr);
886 struct ath6kl_sta *ath6kl_find_sta_by_aid(struct ath6kl *ar, u8 aid);
887 
888 void ath6kl_ready_event(void *devt, u8 *datap, u32 sw_ver, u32 abi_ver,
889 			enum wmi_phy_cap cap);
890 int ath6kl_control_tx(void *devt, struct sk_buff *skb,
891 		      enum htc_endpoint_id eid);
892 void ath6kl_connect_event(struct ath6kl_vif *vif, u16 channel,
893 			  u8 *bssid, u16 listen_int,
894 			  u16 beacon_int, enum network_type net_type,
895 			  u8 beacon_ie_len, u8 assoc_req_len,
896 			  u8 assoc_resp_len, u8 *assoc_info);
897 void ath6kl_connect_ap_mode_bss(struct ath6kl_vif *vif, u16 channel);
898 void ath6kl_connect_ap_mode_sta(struct ath6kl_vif *vif, u16 aid, u8 *mac_addr,
899 				u8 keymgmt, u8 ucipher, u8 auth,
900 				u8 assoc_req_len, u8 *assoc_info, u8 apsd_info);
901 void ath6kl_disconnect_event(struct ath6kl_vif *vif, u8 reason,
902 			     u8 *bssid, u8 assoc_resp_len,
903 			     u8 *assoc_info, u16 prot_reason_status);
904 void ath6kl_tkip_micerr_event(struct ath6kl_vif *vif, u8 keyid, bool ismcast);
905 void ath6kl_txpwr_rx_evt(void *devt, u8 tx_pwr);
906 void ath6kl_scan_complete_evt(struct ath6kl_vif *vif, int status);
907 void ath6kl_tgt_stats_event(struct ath6kl_vif *vif, u8 *ptr, u32 len);
908 void ath6kl_indicate_tx_activity(void *devt, u8 traffic_class, bool active);
909 enum htc_endpoint_id ath6kl_ac2_endpoint_id(void *devt, u8 ac);
910 
911 void ath6kl_pspoll_event(struct ath6kl_vif *vif, u8 aid);
912 
913 void ath6kl_dtimexpiry_event(struct ath6kl_vif *vif);
914 void ath6kl_disconnect(struct ath6kl_vif *vif);
915 void aggr_recv_delba_req_evt(struct ath6kl_vif *vif, u8 tid);
916 void aggr_recv_addba_req_evt(struct ath6kl_vif *vif, u8 tid, u16 seq_no,
917 			     u8 win_sz);
918 void ath6kl_wakeup_event(void *dev);
919 
920 void ath6kl_reset_device(struct ath6kl *ar, u32 target_type,
921 			 bool wait_fot_compltn, bool cold_reset);
922 void ath6kl_init_control_info(struct ath6kl_vif *vif);
923 struct ath6kl_vif *ath6kl_vif_first(struct ath6kl *ar);
924 void ath6kl_cleanup_vif(struct ath6kl_vif *vif, bool wmi_ready);
925 int ath6kl_init_hw_start(struct ath6kl *ar);
926 int ath6kl_init_hw_stop(struct ath6kl *ar);
927 int ath6kl_init_fetch_firmwares(struct ath6kl *ar);
928 int ath6kl_init_hw_params(struct ath6kl *ar);
929 
930 void ath6kl_check_wow_status(struct ath6kl *ar);
931 
932 void ath6kl_core_tx_complete(struct ath6kl *ar, struct sk_buff *skb);
933 void ath6kl_core_rx_complete(struct ath6kl *ar, struct sk_buff *skb, u8 pipe);
934 
935 struct ath6kl *ath6kl_core_create(struct device *dev);
936 int ath6kl_core_init(struct ath6kl *ar, enum ath6kl_htc_type htc_type);
937 void ath6kl_core_cleanup(struct ath6kl *ar);
938 void ath6kl_core_destroy(struct ath6kl *ar);
939 
940 /* Fw error recovery */
941 void ath6kl_init_hw_restart(struct ath6kl *ar);
942 void ath6kl_recovery_err_notify(struct ath6kl *ar, enum ath6kl_fw_err reason);
943 void ath6kl_recovery_init(struct ath6kl *ar);
944 void ath6kl_recovery_cleanup(struct ath6kl *ar);
945 void ath6kl_recovery_suspend(struct ath6kl *ar);
946 #endif /* CORE_H */
947