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