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,
76 enum ath6kl_fw_capability {
77 ATH6KL_FW_CAPABILITY_HOST_P2P = 0,
79 /* this needs to be last */
80 ATH6KL_FW_CAPABILITY_MAX,
83 #define ATH6KL_CAPABILITY_LEN (ALIGN(ATH6KL_FW_CAPABILITY_MAX, 32) / 32)
91 /* AR6003 1.0 definitions */
92 #define AR6003_HW_1_0_VERSION 0x300002ba
94 /* AR6003 2.0 definitions */
95 #define AR6003_HW_2_0_VERSION 0x30000384
96 #define AR6003_HW_2_0_PATCH_DOWNLOAD_ADDRESS 0x57e910
97 #define AR6003_HW_2_0_OTP_FILE "ath6k/AR6003/hw2.0/otp.bin.z77"
98 #define AR6003_HW_2_0_FIRMWARE_FILE "ath6k/AR6003/hw2.0/athwlan.bin.z77"
99 #define AR6003_HW_2_0_TCMD_FIRMWARE_FILE "ath6k/AR6003/hw2.0/athtcmd_ram.bin"
100 #define AR6003_HW_2_0_PATCH_FILE "ath6k/AR6003/hw2.0/data.patch.bin"
101 #define AR6003_HW_2_0_FIRMWARE_2_FILE "ath6k/AR6003/hw2.0/fw-2.bin"
102 #define AR6003_HW_2_0_BOARD_DATA_FILE "ath6k/AR6003/hw2.0/bdata.bin"
103 #define AR6003_HW_2_0_DEFAULT_BOARD_DATA_FILE \
104 "ath6k/AR6003/hw2.0/bdata.SD31.bin"
106 /* AR6003 3.0 definitions */
107 #define AR6003_HW_2_1_1_VERSION 0x30000582
108 #define AR6003_HW_2_1_1_OTP_FILE "ath6k/AR6003/hw2.1.1/otp.bin"
109 #define AR6003_HW_2_1_1_FIRMWARE_FILE "ath6k/AR6003/hw2.1.1/athwlan.bin"
110 #define AR6003_HW_2_1_1_TCMD_FIRMWARE_FILE \
111 "ath6k/AR6003/hw2.1.1/athtcmd_ram.bin"
112 #define AR6003_HW_2_1_1_PATCH_FILE "ath6k/AR6003/hw2.1.1/data.patch.bin"
113 #define AR6003_HW_2_1_1_FIRMWARE_2_FILE "ath6k/AR6003/hw2.1.1/fw-2.bin"
114 #define AR6003_HW_2_1_1_BOARD_DATA_FILE "ath6k/AR6003/hw2.1.1/bdata.bin"
115 #define AR6003_HW_2_1_1_DEFAULT_BOARD_DATA_FILE \
116 "ath6k/AR6003/hw2.1.1/bdata.SD31.bin"
118 /* AR6004 1.0 definitions */
119 #define AR6004_HW_1_0_VERSION 0x30000623
120 #define AR6004_HW_1_0_FIRMWARE_2_FILE "ath6k/AR6004/hw1.0/fw-2.bin"
121 #define AR6004_HW_1_0_FIRMWARE_FILE "ath6k/AR6004/hw1.0/fw.ram.bin"
122 #define AR6004_HW_1_0_BOARD_DATA_FILE "ath6k/AR6004/hw1.0/bdata.bin"
123 #define AR6004_HW_1_0_DEFAULT_BOARD_DATA_FILE \
124 "ath6k/AR6004/hw1.0/bdata.DB132.bin"
126 /* AR6004 1.1 definitions */
127 #define AR6004_HW_1_1_VERSION 0x30000001
128 #define AR6004_HW_1_1_FIRMWARE_2_FILE "ath6k/AR6004/hw1.1/fw-2.bin"
129 #define AR6004_HW_1_1_FIRMWARE_FILE "ath6k/AR6004/hw1.1/fw.ram.bin"
130 #define AR6004_HW_1_1_BOARD_DATA_FILE "ath6k/AR6004/hw1.1/bdata.bin"
131 #define AR6004_HW_1_1_DEFAULT_BOARD_DATA_FILE \
132 "ath6k/AR6004/hw1.1/bdata.DB132.bin"
134 /* Per STA data, used in AP mode */
135 #define STA_PS_AWAKE BIT(0)
136 #define STA_PS_SLEEP BIT(1)
137 #define STA_PS_POLLED BIT(2)
139 /* HTC TX packet tagging definitions */
140 #define ATH6KL_CONTROL_PKT_TAG HTC_TX_PACKET_TAG_USER_DEFINED
141 #define ATH6KL_DATA_PKT_TAG (ATH6KL_CONTROL_PKT_TAG + 1)
143 #define AR6003_CUST_DATA_SIZE 16
145 #define AGGR_WIN_IDX(x, y) ((x) % (y))
146 #define AGGR_INCR_IDX(x, y) AGGR_WIN_IDX(((x) + 1), (y))
147 #define AGGR_DCRM_IDX(x, y) AGGR_WIN_IDX(((x) - 1), (y))
148 #define ATH6KL_MAX_SEQ_NO 0xFFF
149 #define ATH6KL_NEXT_SEQ_NO(x) (((x) + 1) & ATH6KL_MAX_SEQ_NO)
151 #define NUM_OF_TIDS 8
152 #define AGGR_SZ_DEFAULT 8
154 #define AGGR_WIN_SZ_MIN 2
155 #define AGGR_WIN_SZ_MAX 8
157 #define TID_WINDOW_SZ(_x) ((_x) << 1)
159 #define AGGR_NUM_OF_FREE_NETBUFS 16
161 #define AGGR_RX_TIMEOUT 400 /* in ms */
163 #define WMI_TIMEOUT (2 * HZ)
165 #define MBOX_YIELD_LIMIT 99
167 /* configuration lags */
169 * ATH6KL_CONF_IGNORE_ERP_BARKER: Ignore the barker premable in
170 * ERP IE of beacon to determine the short premable support when
171 * sending (Re)Assoc req.
172 * ATH6KL_CONF_IGNORE_PS_FAIL_EVT_IN_SCAN: Don't send the power
173 * module state transition failure events which happen during
176 #define ATH6KL_CONF_IGNORE_ERP_BARKER BIT(0)
177 #define ATH6KL_CONF_IGNORE_PS_FAIL_EVT_IN_SCAN BIT(1)
178 #define ATH6KL_CONF_ENABLE_11N BIT(2)
179 #define ATH6KL_CONF_ENABLE_TX_BURST BIT(3)
180 #define ATH6KL_CONF_SUSPEND_CUTPOWER BIT(4)
182 enum wlan_low_pwr_state {
184 WLAN_POWER_STATE_CUT_PWR,
185 WLAN_POWER_STATE_DEEP_SLEEP,
208 struct skb_hold_q *hold_q;
209 struct sk_buff_head q;
228 struct timer_list timer;
229 struct net_device *dev;
230 struct rxtid rx_tid[NUM_OF_TIDS];
231 struct sk_buff_head free_q;
232 struct rxtid_stats stat[NUM_OF_TIDS];
235 struct ath6kl_wep_key {
241 #define ATH6KL_KEY_SEQ_LEN 8
244 u8 key[WLAN_MAX_KEY_LEN];
246 u8 seq[ATH6KL_KEY_SEQ_LEN];
251 struct ath6kl_node_mapping {
252 u8 mac_addr[ETH_ALEN];
257 struct ath6kl_cookie {
260 struct htc_packet htc_pkt;
261 struct ath6kl_cookie *arc_list_next;
271 u8 wpa_ie[ATH6KL_MAX_IE];
272 struct sk_buff_head psq;
276 struct ath6kl_version {
290 struct target_stats {
299 u64 tx_rts_success_cnt;
300 u64 tx_pkt_per_ac[4];
305 u64 tx_mult_retry_cnt;
320 u64 rx_key_cache_miss;
324 u64 tkip_local_mic_fail;
325 u64 tkip_cnter_measures_invoked;
331 u64 pwr_save_fail_cnt;
344 u16 wow_evt_discarded;
346 s16 noise_floor_calib;
348 s16 cs_ave_beacon_rssi;
349 u8 cs_ave_beacon_snr;
350 u8 cs_last_roam_msec;
353 u8 wow_host_pkt_wakeups;
354 u8 wow_host_evt_wakeups;
361 struct ath6kl_mbox_info {
374 * 802.11i defines an extended IV for use with non-WEP ciphers.
375 * When the EXTIV bit is set in the key id byte an additional
376 * 4 bytes immediately follow the IV for TKIP. For CCMP the
377 * EXTIV bit is likewise set but the 8 bytes represent the
378 * CCMP header rather than IV+extended-IV.
381 #define ATH6KL_KEYBUF_SIZE 16
382 #define ATH6KL_MICBUF_SIZE (8+8) /* space for both tx and rx */
384 #define ATH6KL_KEY_XMIT 0x01
385 #define ATH6KL_KEY_RECV 0x02
386 #define ATH6KL_KEY_DEFAULT 0x80 /* default xmit key */
388 /* Initial group key for AP mode */
389 struct ath6kl_req_key {
393 u8 key[WLAN_MAX_KEY_LEN];
397 enum ath6kl_hif_type {
398 ATH6KL_HIF_TYPE_SDIO,
402 #define MAX_NUM_VIF 1
405 enum ath6kl_vif_state {
412 CLEAR_BSSFILTER_ON_BEACON,
419 struct list_head list;
420 struct wireless_dev wdev;
421 struct net_device *ndev;
423 /* Lock to protect vif specific net_stats and flags */
428 u8 ssid[IEEE80211_MAX_SSID_LEN];
432 u8 prwise_crypto_len;
439 u8 req_bssid[ETH_ALEN];
442 struct ath6kl_wep_key wep_key_list[WMI_MAX_KEY_INDEX + 1];
443 struct ath6kl_key keys[WMI_MAX_KEY_INDEX + 1];
444 struct aggr_info *aggr_cntxt;
445 struct timer_list disconnect_timer;
446 struct cfg80211_scan_request *scan_req;
447 enum sme_state sme_state;
450 u32 last_cancel_roc_id;
452 bool probe_req_report;
454 u16 assoc_bss_beacon_int;
455 u8 assoc_bss_dtim_period;
456 struct net_device_stats net_stats;
457 struct target_stats target_stats;
460 #define WOW_LIST_ID 0
461 #define WOW_HOST_REQ_DELAY 500 /* ms */
464 enum ath6kl_dev_state {
478 ATH6KL_STATE_DEEPSLEEP,
479 ATH6KL_STATE_CUTPOWER,
487 enum ath6kl_state state;
489 struct ath6kl_bmi bmi;
490 const struct ath6kl_hif_ops *hif_ops;
492 int tx_pending[ENDPOINT_MAX];
493 int total_tx_data_pend;
494 struct htc_target *htc_target;
495 enum ath6kl_hif_type hif_type;
497 struct list_head vif_list;
498 /* Lock to avoid race in vif_list entries among add/del/traverse */
499 spinlock_t list_lock;
504 struct semaphore sem;
507 u8 lrssi_roam_threshold;
508 struct ath6kl_version version;
511 struct ath6kl_node_mapping node_map[MAX_NODE_NUM];
516 struct ath6kl_cookie *cookie_list;
518 enum htc_endpoint_id ac2ep_map[WMM_NUM_AC];
519 bool ac_stream_active[WMM_NUM_AC];
520 u8 ac_stream_pri_map[WMM_NUM_AC];
521 u8 hiac_stream_active_pri;
522 u8 ep2ac_map[ENDPOINT_MAX];
523 enum htc_endpoint_id ctrl_ep;
524 struct ath6kl_htc_credit_info credit_state_info;
525 u32 connect_ctrl_flags;
528 struct ath6kl_sta sta_list[AP_MAX_NUM_STA];
530 struct ath6kl_req_key ap_mode_bkey;
531 struct sk_buff_head mcastpsq;
532 spinlock_t mcastpsq_lock;
534 struct wmi_ap_mode_stat ap_stats;
535 u8 ap_country_code[3];
536 struct list_head amsdu_rx_buffer_queue;
538 enum wlan_low_pwr_state wlan_pwr_state;
539 struct wmi_scan_params_cmd sc_params;
540 u8 mac_addr[ETH_ALEN];
541 #define AR_MCAST_FILTER_MAC_ADDR_SIZE 4
544 size_t rx_report_len;
550 u32 dataset_patch_addr;
552 u32 app_start_override_addr;
553 u32 board_ext_data_addr;
554 u32 reserved_ram_size;
559 wait_queue_head_t event_wq;
560 struct ath6kl_mbox_info mbox_info;
562 struct ath6kl_cookie cookie_mem[MAX_COOKIE_NUM];
577 unsigned long fw_capabilities[ATH6KL_CAPABILITY_LEN];
579 struct workqueue_struct *ath6kl_wq;
581 struct dentry *debugfs_phy;
585 #ifdef CONFIG_ATH6KL_DEBUG
587 struct circ_buf fwlog_buf;
588 spinlock_t fwlog_lock;
591 unsigned int dbgfs_diag_reg;
592 u32 diag_reg_addr_wr;
596 unsigned int invalid_rate;
600 unsigned int roam_tbl_len;
605 #endif /* CONFIG_ATH6KL_DEBUG */
608 static inline void *ath6kl_priv(struct net_device *dev)
610 return ((struct ath6kl_vif *) netdev_priv(dev))->ar;
613 static inline u32 ath6kl_get_hi_item_addr(struct ath6kl *ar,
618 if (ar->target_type == TARGET_TYPE_AR6003)
619 addr = ATH6KL_AR6003_HI_START_ADDR + item_offset;
620 else if (ar->target_type == TARGET_TYPE_AR6004)
621 addr = ATH6KL_AR6004_HI_START_ADDR + item_offset;
626 int ath6kl_configure_target(struct ath6kl *ar);
627 void ath6kl_detect_error(unsigned long ptr);
628 void disconnect_timer_handler(unsigned long ptr);
629 void init_netdev(struct net_device *dev);
630 void ath6kl_cookie_init(struct ath6kl *ar);
631 void ath6kl_cookie_cleanup(struct ath6kl *ar);
632 void ath6kl_rx(struct htc_target *target, struct htc_packet *packet);
633 void ath6kl_tx_complete(void *context, struct list_head *packet_queue);
634 enum htc_send_full_action ath6kl_tx_queue_full(struct htc_target *target,
635 struct htc_packet *packet);
636 void ath6kl_stop_txrx(struct ath6kl *ar);
637 void ath6kl_cleanup_amsdu_rxbufs(struct ath6kl *ar);
638 int ath6kl_diag_write32(struct ath6kl *ar, u32 address, __le32 value);
639 int ath6kl_diag_write(struct ath6kl *ar, u32 address, void *data, u32 length);
640 int ath6kl_diag_read32(struct ath6kl *ar, u32 address, u32 *value);
641 int ath6kl_diag_read(struct ath6kl *ar, u32 address, void *data, u32 length);
642 int ath6kl_read_fwlogs(struct ath6kl *ar);
643 void ath6kl_init_profile_info(struct ath6kl_vif *vif);
644 void ath6kl_tx_data_cleanup(struct ath6kl *ar);
646 struct ath6kl_cookie *ath6kl_alloc_cookie(struct ath6kl *ar);
647 void ath6kl_free_cookie(struct ath6kl *ar, struct ath6kl_cookie *cookie);
648 int ath6kl_data_tx(struct sk_buff *skb, struct net_device *dev);
650 struct aggr_info *aggr_init(struct net_device *dev);
651 void ath6kl_rx_refill(struct htc_target *target,
652 enum htc_endpoint_id endpoint);
653 void ath6kl_refill_amsdu_rxbufs(struct ath6kl *ar, int count);
654 struct htc_packet *ath6kl_alloc_amsdu_rxbuf(struct htc_target *target,
655 enum htc_endpoint_id endpoint,
657 void aggr_module_destroy(struct aggr_info *aggr_info);
658 void aggr_reset_state(struct aggr_info *aggr_info);
660 struct ath6kl_sta *ath6kl_find_sta(struct ath6kl_vif *vif, u8 * node_addr);
661 struct ath6kl_sta *ath6kl_find_sta_by_aid(struct ath6kl *ar, u8 aid);
663 void ath6kl_ready_event(void *devt, u8 * datap, u32 sw_ver, u32 abi_ver);
664 int ath6kl_control_tx(void *devt, struct sk_buff *skb,
665 enum htc_endpoint_id eid);
666 void ath6kl_connect_event(struct ath6kl_vif *vif, u16 channel,
667 u8 *bssid, u16 listen_int,
668 u16 beacon_int, enum network_type net_type,
669 u8 beacon_ie_len, u8 assoc_req_len,
670 u8 assoc_resp_len, u8 *assoc_info);
671 void ath6kl_connect_ap_mode_bss(struct ath6kl_vif *vif, u16 channel);
672 void ath6kl_connect_ap_mode_sta(struct ath6kl_vif *vif, u16 aid, u8 *mac_addr,
673 u8 keymgmt, u8 ucipher, u8 auth,
674 u8 assoc_req_len, u8 *assoc_info);
675 void ath6kl_disconnect_event(struct ath6kl_vif *vif, u8 reason,
676 u8 *bssid, u8 assoc_resp_len,
677 u8 *assoc_info, u16 prot_reason_status);
678 void ath6kl_tkip_micerr_event(struct ath6kl_vif *vif, u8 keyid, bool ismcast);
679 void ath6kl_txpwr_rx_evt(void *devt, u8 tx_pwr);
680 void ath6kl_scan_complete_evt(struct ath6kl_vif *vif, int status);
681 void ath6kl_tgt_stats_event(struct ath6kl_vif *vif, u8 *ptr, u32 len);
682 void ath6kl_indicate_tx_activity(void *devt, u8 traffic_class, bool active);
683 enum htc_endpoint_id ath6kl_ac2_endpoint_id(void *devt, u8 ac);
685 void ath6kl_pspoll_event(struct ath6kl_vif *vif, u8 aid);
687 void ath6kl_dtimexpiry_event(struct ath6kl_vif *vif);
688 void ath6kl_disconnect(struct ath6kl_vif *vif);
689 void aggr_recv_delba_req_evt(struct ath6kl_vif *vif, u8 tid);
690 void aggr_recv_addba_req_evt(struct ath6kl_vif *vif, u8 tid, u16 seq_no,
692 void ath6kl_wakeup_event(void *dev);
694 void ath6kl_reset_device(struct ath6kl *ar, u32 target_type,
695 bool wait_fot_compltn, bool cold_reset);
696 void ath6kl_init_control_info(struct ath6kl_vif *vif);
697 void ath6kl_deinit_if_data(struct ath6kl_vif *vif);
698 void ath6kl_core_free(struct ath6kl *ar);
699 struct ath6kl_vif *ath6kl_vif_first(struct ath6kl *ar);
700 void ath6kl_cleanup_vif(struct ath6kl_vif *vif, bool wmi_ready);
701 int ath6kl_init_hw_start(struct ath6kl *ar);
702 int ath6kl_init_hw_stop(struct ath6kl *ar);
703 void ath6kl_check_wow_status(struct ath6kl *ar);