2 * Copyright (c) 2010-2011 Atheros Communications Inc.
4 * Permission to use, copy, modify, and/or distribute this software for any
5 * purpose with or without fee is hereby granted, provided that the above
6 * copyright notice and this permission notice appear in all copies.
8 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
20 #include <linux/etherdevice.h>
21 #include <linux/rtnetlink.h>
22 #include <linux/firmware.h>
23 #include <linux/sched.h>
24 #include <linux/circ_buf.h>
25 #include <net/cfg80211.h>
32 #define ATH6KL_MAX_RX_BUFFERS 16
33 #define ATH6KL_BUFFER_SIZE 1664
34 #define ATH6KL_MAX_AMSDU_RX_BUFFERS 4
35 #define ATH6KL_AMSDU_REFILL_THRESHOLD 3
36 #define ATH6KL_AMSDU_BUFFER_SIZE (WMI_MAX_AMSDU_RX_DATA_FRAME_LENGTH + 128)
37 #define MAX_MSDU_SUBFRAME_PAYLOAD_LEN 1508
38 #define MIN_MSDU_SUBFRAME_PAYLOAD_LEN 46
40 #define USER_SAVEDKEYS_STAT_INIT 0
41 #define USER_SAVEDKEYS_STAT_RUN 1
43 #define ATH6KL_TX_TIMEOUT 10
44 #define ATH6KL_MAX_ENDPOINTS 4
45 #define MAX_NODE_NUM 15
47 /* Extra bytes for htc header alignment */
48 #define ATH6KL_HTC_ALIGN_BYTES 3
50 /* MAX_HI_COOKIE_NUM are reserved for high priority traffic */
51 #define MAX_DEF_COOKIE_NUM 180
52 #define MAX_HI_COOKIE_NUM 18 /* 10% of MAX_COOKIE_NUM */
53 #define MAX_COOKIE_NUM (MAX_DEF_COOKIE_NUM + MAX_HI_COOKIE_NUM)
55 #define MAX_DEFAULT_SEND_QUEUE_DEPTH (MAX_DEF_COOKIE_NUM / WMM_NUM_AC)
57 #define DISCON_TIMER_INTVAL 10000 /* in msec */
58 #define A_DEFAULT_LISTEN_INTERVAL 100
59 #define A_MAX_WOW_LISTEN_INTERVAL 1000
61 /* includes also the null byte */
62 #define ATH6KL_FIRMWARE_MAGIC "QCA-ATH6KL"
64 enum ath6kl_fw_ie_type {
65 ATH6KL_FW_IE_FW_VERSION = 0,
66 ATH6KL_FW_IE_TIMESTAMP = 1,
67 ATH6KL_FW_IE_OTP_IMAGE = 2,
68 ATH6KL_FW_IE_FW_IMAGE = 3,
69 ATH6KL_FW_IE_PATCH_IMAGE = 4,
70 ATH6KL_FW_IE_RESERVED_RAM_SIZE = 5,
71 ATH6KL_FW_IE_CAPABILITIES = 6,
72 ATH6KL_FW_IE_PATCH_ADDR = 7,
73 ATH6KL_FW_IE_BOARD_ADDR = 8,
74 ATH6KL_FW_IE_VIF_MAX = 9,
77 enum ath6kl_fw_capability {
78 ATH6KL_FW_CAPABILITY_HOST_P2P = 0,
80 /* this needs to be last */
81 ATH6KL_FW_CAPABILITY_MAX,
84 #define ATH6KL_CAPABILITY_LEN (ALIGN(ATH6KL_FW_CAPABILITY_MAX, 32) / 32)
92 /* AR6003 1.0 definitions */
93 #define AR6003_HW_1_0_VERSION 0x300002ba
95 /* AR6003 2.0 definitions */
96 #define AR6003_HW_2_0_VERSION 0x30000384
97 #define AR6003_HW_2_0_PATCH_DOWNLOAD_ADDRESS 0x57e910
98 #define AR6003_HW_2_0_OTP_FILE "ath6k/AR6003/hw2.0/otp.bin.z77"
99 #define AR6003_HW_2_0_FIRMWARE_FILE "ath6k/AR6003/hw2.0/athwlan.bin.z77"
100 #define AR6003_HW_2_0_TCMD_FIRMWARE_FILE "ath6k/AR6003/hw2.0/athtcmd_ram.bin"
101 #define AR6003_HW_2_0_PATCH_FILE "ath6k/AR6003/hw2.0/data.patch.bin"
102 #define AR6003_HW_2_0_FIRMWARE_2_FILE "ath6k/AR6003/hw2.0/fw-2.bin"
103 #define AR6003_HW_2_0_BOARD_DATA_FILE "ath6k/AR6003/hw2.0/bdata.bin"
104 #define AR6003_HW_2_0_DEFAULT_BOARD_DATA_FILE \
105 "ath6k/AR6003/hw2.0/bdata.SD31.bin"
107 /* AR6003 3.0 definitions */
108 #define AR6003_HW_2_1_1_VERSION 0x30000582
109 #define AR6003_HW_2_1_1_OTP_FILE "ath6k/AR6003/hw2.1.1/otp.bin"
110 #define AR6003_HW_2_1_1_FIRMWARE_FILE "ath6k/AR6003/hw2.1.1/athwlan.bin"
111 #define AR6003_HW_2_1_1_TCMD_FIRMWARE_FILE \
112 "ath6k/AR6003/hw2.1.1/athtcmd_ram.bin"
113 #define AR6003_HW_2_1_1_PATCH_FILE "ath6k/AR6003/hw2.1.1/data.patch.bin"
114 #define AR6003_HW_2_1_1_FIRMWARE_2_FILE "ath6k/AR6003/hw2.1.1/fw-2.bin"
115 #define AR6003_HW_2_1_1_BOARD_DATA_FILE "ath6k/AR6003/hw2.1.1/bdata.bin"
116 #define AR6003_HW_2_1_1_DEFAULT_BOARD_DATA_FILE \
117 "ath6k/AR6003/hw2.1.1/bdata.SD31.bin"
119 /* AR6004 1.0 definitions */
120 #define AR6004_HW_1_0_VERSION 0x30000623
121 #define AR6004_HW_1_0_FIRMWARE_2_FILE "ath6k/AR6004/hw1.0/fw-2.bin"
122 #define AR6004_HW_1_0_FIRMWARE_FILE "ath6k/AR6004/hw1.0/fw.ram.bin"
123 #define AR6004_HW_1_0_BOARD_DATA_FILE "ath6k/AR6004/hw1.0/bdata.bin"
124 #define AR6004_HW_1_0_DEFAULT_BOARD_DATA_FILE \
125 "ath6k/AR6004/hw1.0/bdata.DB132.bin"
127 /* AR6004 1.1 definitions */
128 #define AR6004_HW_1_1_VERSION 0x30000001
129 #define AR6004_HW_1_1_FIRMWARE_2_FILE "ath6k/AR6004/hw1.1/fw-2.bin"
130 #define AR6004_HW_1_1_FIRMWARE_FILE "ath6k/AR6004/hw1.1/fw.ram.bin"
131 #define AR6004_HW_1_1_BOARD_DATA_FILE "ath6k/AR6004/hw1.1/bdata.bin"
132 #define AR6004_HW_1_1_DEFAULT_BOARD_DATA_FILE \
133 "ath6k/AR6004/hw1.1/bdata.DB132.bin"
135 /* Per STA data, used in AP mode */
136 #define STA_PS_AWAKE BIT(0)
137 #define STA_PS_SLEEP BIT(1)
138 #define STA_PS_POLLED BIT(2)
140 /* HTC TX packet tagging definitions */
141 #define ATH6KL_CONTROL_PKT_TAG HTC_TX_PACKET_TAG_USER_DEFINED
142 #define ATH6KL_DATA_PKT_TAG (ATH6KL_CONTROL_PKT_TAG + 1)
144 #define AR6003_CUST_DATA_SIZE 16
146 #define AGGR_WIN_IDX(x, y) ((x) % (y))
147 #define AGGR_INCR_IDX(x, y) AGGR_WIN_IDX(((x) + 1), (y))
148 #define AGGR_DCRM_IDX(x, y) AGGR_WIN_IDX(((x) - 1), (y))
149 #define ATH6KL_MAX_SEQ_NO 0xFFF
150 #define ATH6KL_NEXT_SEQ_NO(x) (((x) + 1) & ATH6KL_MAX_SEQ_NO)
152 #define NUM_OF_TIDS 8
153 #define AGGR_SZ_DEFAULT 8
155 #define AGGR_WIN_SZ_MIN 2
156 #define AGGR_WIN_SZ_MAX 8
158 #define TID_WINDOW_SZ(_x) ((_x) << 1)
160 #define AGGR_NUM_OF_FREE_NETBUFS 16
162 #define AGGR_RX_TIMEOUT 400 /* in ms */
164 #define WMI_TIMEOUT (2 * HZ)
166 #define MBOX_YIELD_LIMIT 99
168 /* configuration lags */
170 * ATH6KL_CONF_IGNORE_ERP_BARKER: Ignore the barker premable in
171 * ERP IE of beacon to determine the short premable support when
172 * sending (Re)Assoc req.
173 * ATH6KL_CONF_IGNORE_PS_FAIL_EVT_IN_SCAN: Don't send the power
174 * module state transition failure events which happen during
177 #define ATH6KL_CONF_IGNORE_ERP_BARKER BIT(0)
178 #define ATH6KL_CONF_IGNORE_PS_FAIL_EVT_IN_SCAN BIT(1)
179 #define ATH6KL_CONF_ENABLE_11N BIT(2)
180 #define ATH6KL_CONF_ENABLE_TX_BURST BIT(3)
181 #define ATH6KL_CONF_SUSPEND_CUTPOWER BIT(4)
183 enum wlan_low_pwr_state {
185 WLAN_POWER_STATE_CUT_PWR,
186 WLAN_POWER_STATE_DEEP_SLEEP,
209 struct skb_hold_q *hold_q;
210 struct sk_buff_head q;
229 struct timer_list timer;
230 struct net_device *dev;
231 struct rxtid rx_tid[NUM_OF_TIDS];
232 struct sk_buff_head free_q;
233 struct rxtid_stats stat[NUM_OF_TIDS];
236 struct ath6kl_wep_key {
242 #define ATH6KL_KEY_SEQ_LEN 8
245 u8 key[WLAN_MAX_KEY_LEN];
247 u8 seq[ATH6KL_KEY_SEQ_LEN];
252 struct ath6kl_node_mapping {
253 u8 mac_addr[ETH_ALEN];
258 struct ath6kl_cookie {
261 struct htc_packet htc_pkt;
262 struct ath6kl_cookie *arc_list_next;
272 u8 wpa_ie[ATH6KL_MAX_IE];
273 struct sk_buff_head psq;
277 struct ath6kl_version {
291 struct target_stats {
300 u64 tx_rts_success_cnt;
301 u64 tx_pkt_per_ac[4];
306 u64 tx_mult_retry_cnt;
321 u64 rx_key_cache_miss;
325 u64 tkip_local_mic_fail;
326 u64 tkip_cnter_measures_invoked;
332 u64 pwr_save_fail_cnt;
345 u16 wow_evt_discarded;
347 s16 noise_floor_calib;
349 s16 cs_ave_beacon_rssi;
350 u8 cs_ave_beacon_snr;
351 u8 cs_last_roam_msec;
354 u8 wow_host_pkt_wakeups;
355 u8 wow_host_evt_wakeups;
362 struct ath6kl_mbox_info {
375 * 802.11i defines an extended IV for use with non-WEP ciphers.
376 * When the EXTIV bit is set in the key id byte an additional
377 * 4 bytes immediately follow the IV for TKIP. For CCMP the
378 * EXTIV bit is likewise set but the 8 bytes represent the
379 * CCMP header rather than IV+extended-IV.
382 #define ATH6KL_KEYBUF_SIZE 16
383 #define ATH6KL_MICBUF_SIZE (8+8) /* space for both tx and rx */
385 #define ATH6KL_KEY_XMIT 0x01
386 #define ATH6KL_KEY_RECV 0x02
387 #define ATH6KL_KEY_DEFAULT 0x80 /* default xmit key */
389 /* Initial group key for AP mode */
390 struct ath6kl_req_key {
394 u8 key[WLAN_MAX_KEY_LEN];
398 enum ath6kl_hif_type {
399 ATH6KL_HIF_TYPE_SDIO,
404 * Driver's maximum limit, note that some firmwares support only one vif
405 * and the runtime (current) limit must be checked from ar->vif_max.
407 #define ATH6KL_VIF_MAX 3
410 enum ath6kl_vif_state {
417 CLEAR_BSSFILTER_ON_BEACON,
424 struct list_head list;
425 struct wireless_dev wdev;
426 struct net_device *ndev;
428 /* Lock to protect vif specific net_stats and flags */
433 u8 ssid[IEEE80211_MAX_SSID_LEN];
437 u8 prwise_crypto_len;
444 u8 req_bssid[ETH_ALEN];
447 struct ath6kl_wep_key wep_key_list[WMI_MAX_KEY_INDEX + 1];
448 struct ath6kl_key keys[WMI_MAX_KEY_INDEX + 1];
449 struct aggr_info *aggr_cntxt;
450 struct timer_list disconnect_timer;
451 struct cfg80211_scan_request *scan_req;
452 enum sme_state sme_state;
455 u32 last_cancel_roc_id;
457 bool probe_req_report;
459 u16 assoc_bss_beacon_int;
460 u8 assoc_bss_dtim_period;
461 struct net_device_stats net_stats;
462 struct target_stats target_stats;
465 #define WOW_LIST_ID 0
466 #define WOW_HOST_REQ_DELAY 500 /* ms */
469 enum ath6kl_dev_state {
483 ATH6KL_STATE_DEEPSLEEP,
484 ATH6KL_STATE_CUTPOWER,
492 enum ath6kl_state state;
494 struct ath6kl_bmi bmi;
495 const struct ath6kl_hif_ops *hif_ops;
497 int tx_pending[ENDPOINT_MAX];
498 int total_tx_data_pend;
499 struct htc_target *htc_target;
500 enum ath6kl_hif_type hif_type;
502 struct list_head vif_list;
503 /* Lock to avoid race in vif_list entries among add/del/traverse */
504 spinlock_t list_lock;
506 unsigned int vif_max;
510 struct semaphore sem;
513 u8 lrssi_roam_threshold;
514 struct ath6kl_version version;
517 struct ath6kl_node_mapping node_map[MAX_NODE_NUM];
522 struct ath6kl_cookie *cookie_list;
524 enum htc_endpoint_id ac2ep_map[WMM_NUM_AC];
525 bool ac_stream_active[WMM_NUM_AC];
526 u8 ac_stream_pri_map[WMM_NUM_AC];
527 u8 hiac_stream_active_pri;
528 u8 ep2ac_map[ENDPOINT_MAX];
529 enum htc_endpoint_id ctrl_ep;
530 struct ath6kl_htc_credit_info credit_state_info;
531 u32 connect_ctrl_flags;
534 struct ath6kl_sta sta_list[AP_MAX_NUM_STA];
536 struct ath6kl_req_key ap_mode_bkey;
537 struct sk_buff_head mcastpsq;
538 spinlock_t mcastpsq_lock;
540 struct wmi_ap_mode_stat ap_stats;
541 u8 ap_country_code[3];
542 struct list_head amsdu_rx_buffer_queue;
544 enum wlan_low_pwr_state wlan_pwr_state;
545 u8 mac_addr[ETH_ALEN];
546 #define AR_MCAST_FILTER_MAC_ADDR_SIZE 4
549 size_t rx_report_len;
555 u32 dataset_patch_addr;
557 u32 app_start_override_addr;
558 u32 board_ext_data_addr;
559 u32 reserved_ram_size;
565 const char *fw_patch;
567 const char *fw_board;
568 const char *fw_default_board;
572 wait_queue_head_t event_wq;
573 struct ath6kl_mbox_info mbox_info;
575 struct ath6kl_cookie cookie_mem[MAX_COOKIE_NUM];
590 unsigned long fw_capabilities[ATH6KL_CAPABILITY_LEN];
592 struct workqueue_struct *ath6kl_wq;
594 struct dentry *debugfs_phy;
598 #ifdef CONFIG_ATH6KL_DEBUG
600 struct circ_buf fwlog_buf;
601 spinlock_t fwlog_lock;
604 unsigned int dbgfs_diag_reg;
605 u32 diag_reg_addr_wr;
609 unsigned int invalid_rate;
613 unsigned int roam_tbl_len;
618 #endif /* CONFIG_ATH6KL_DEBUG */
621 static inline struct ath6kl *ath6kl_priv(struct net_device *dev)
623 return ((struct ath6kl_vif *) netdev_priv(dev))->ar;
626 static inline u32 ath6kl_get_hi_item_addr(struct ath6kl *ar,
631 if (ar->target_type == TARGET_TYPE_AR6003)
632 addr = ATH6KL_AR6003_HI_START_ADDR + item_offset;
633 else if (ar->target_type == TARGET_TYPE_AR6004)
634 addr = ATH6KL_AR6004_HI_START_ADDR + item_offset;
639 int ath6kl_configure_target(struct ath6kl *ar);
640 void ath6kl_detect_error(unsigned long ptr);
641 void disconnect_timer_handler(unsigned long ptr);
642 void init_netdev(struct net_device *dev);
643 void ath6kl_cookie_init(struct ath6kl *ar);
644 void ath6kl_cookie_cleanup(struct ath6kl *ar);
645 void ath6kl_rx(struct htc_target *target, struct htc_packet *packet);
646 void ath6kl_tx_complete(void *context, struct list_head *packet_queue);
647 enum htc_send_full_action ath6kl_tx_queue_full(struct htc_target *target,
648 struct htc_packet *packet);
649 void ath6kl_stop_txrx(struct ath6kl *ar);
650 void ath6kl_cleanup_amsdu_rxbufs(struct ath6kl *ar);
651 int ath6kl_diag_write32(struct ath6kl *ar, u32 address, __le32 value);
652 int ath6kl_diag_write(struct ath6kl *ar, u32 address, void *data, u32 length);
653 int ath6kl_diag_read32(struct ath6kl *ar, u32 address, u32 *value);
654 int ath6kl_diag_read(struct ath6kl *ar, u32 address, void *data, u32 length);
655 int ath6kl_read_fwlogs(struct ath6kl *ar);
656 void ath6kl_init_profile_info(struct ath6kl_vif *vif);
657 void ath6kl_tx_data_cleanup(struct ath6kl *ar);
659 struct ath6kl_cookie *ath6kl_alloc_cookie(struct ath6kl *ar);
660 void ath6kl_free_cookie(struct ath6kl *ar, struct ath6kl_cookie *cookie);
661 int ath6kl_data_tx(struct sk_buff *skb, struct net_device *dev);
663 struct aggr_info *aggr_init(struct net_device *dev);
664 void ath6kl_rx_refill(struct htc_target *target,
665 enum htc_endpoint_id endpoint);
666 void ath6kl_refill_amsdu_rxbufs(struct ath6kl *ar, int count);
667 struct htc_packet *ath6kl_alloc_amsdu_rxbuf(struct htc_target *target,
668 enum htc_endpoint_id endpoint,
670 void aggr_module_destroy(struct aggr_info *aggr_info);
671 void aggr_reset_state(struct aggr_info *aggr_info);
673 struct ath6kl_sta *ath6kl_find_sta(struct ath6kl_vif *vif, u8 * node_addr);
674 struct ath6kl_sta *ath6kl_find_sta_by_aid(struct ath6kl *ar, u8 aid);
676 void ath6kl_ready_event(void *devt, u8 * datap, u32 sw_ver, u32 abi_ver);
677 int ath6kl_control_tx(void *devt, struct sk_buff *skb,
678 enum htc_endpoint_id eid);
679 void ath6kl_connect_event(struct ath6kl_vif *vif, u16 channel,
680 u8 *bssid, u16 listen_int,
681 u16 beacon_int, enum network_type net_type,
682 u8 beacon_ie_len, u8 assoc_req_len,
683 u8 assoc_resp_len, u8 *assoc_info);
684 void ath6kl_connect_ap_mode_bss(struct ath6kl_vif *vif, u16 channel);
685 void ath6kl_connect_ap_mode_sta(struct ath6kl_vif *vif, u16 aid, u8 *mac_addr,
686 u8 keymgmt, u8 ucipher, u8 auth,
687 u8 assoc_req_len, u8 *assoc_info);
688 void ath6kl_disconnect_event(struct ath6kl_vif *vif, u8 reason,
689 u8 *bssid, u8 assoc_resp_len,
690 u8 *assoc_info, u16 prot_reason_status);
691 void ath6kl_tkip_micerr_event(struct ath6kl_vif *vif, u8 keyid, bool ismcast);
692 void ath6kl_txpwr_rx_evt(void *devt, u8 tx_pwr);
693 void ath6kl_scan_complete_evt(struct ath6kl_vif *vif, int status);
694 void ath6kl_tgt_stats_event(struct ath6kl_vif *vif, u8 *ptr, u32 len);
695 void ath6kl_indicate_tx_activity(void *devt, u8 traffic_class, bool active);
696 enum htc_endpoint_id ath6kl_ac2_endpoint_id(void *devt, u8 ac);
698 void ath6kl_pspoll_event(struct ath6kl_vif *vif, u8 aid);
700 void ath6kl_dtimexpiry_event(struct ath6kl_vif *vif);
701 void ath6kl_disconnect(struct ath6kl_vif *vif);
702 void aggr_recv_delba_req_evt(struct ath6kl_vif *vif, u8 tid);
703 void aggr_recv_addba_req_evt(struct ath6kl_vif *vif, u8 tid, u16 seq_no,
705 void ath6kl_wakeup_event(void *dev);
707 void ath6kl_reset_device(struct ath6kl *ar, u32 target_type,
708 bool wait_fot_compltn, bool cold_reset);
709 void ath6kl_init_control_info(struct ath6kl_vif *vif);
710 void ath6kl_deinit_if_data(struct ath6kl_vif *vif);
711 void ath6kl_core_free(struct ath6kl *ar);
712 struct ath6kl_vif *ath6kl_vif_first(struct ath6kl *ar);
713 void ath6kl_cleanup_vif(struct ath6kl_vif *vif, bool wmi_ready);
714 int ath6kl_init_hw_start(struct ath6kl *ar);
715 int ath6kl_init_hw_stop(struct ath6kl *ar);
716 void ath6kl_check_wow_status(struct ath6kl *ar);