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