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