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,
79 ATH6KL_FW_CAPABILITY_SCHED_SCAN
= 1,
82 * Firmware is capable of supporting P2P mgmt operations on a
83 * station interface. After group formation, the station
84 * interface will become a P2P client/GO interface as the case may be
86 ATH6KL_FW_CAPABILITY_STA_P2PDEV_DUPLEX
,
88 /* this needs to be last */
89 ATH6KL_FW_CAPABILITY_MAX
,
92 #define ATH6KL_CAPABILITY_LEN (ALIGN(ATH6KL_FW_CAPABILITY_MAX, 32) / 32)
100 /* AR6003 1.0 definitions */
101 #define AR6003_HW_1_0_VERSION 0x300002ba
103 /* AR6003 2.0 definitions */
104 #define AR6003_HW_2_0_VERSION 0x30000384
105 #define AR6003_HW_2_0_PATCH_DOWNLOAD_ADDRESS 0x57e910
106 #define AR6003_HW_2_0_OTP_FILE "ath6k/AR6003/hw2.0/otp.bin.z77"
107 #define AR6003_HW_2_0_FIRMWARE_FILE "ath6k/AR6003/hw2.0/athwlan.bin.z77"
108 #define AR6003_HW_2_0_TCMD_FIRMWARE_FILE "ath6k/AR6003/hw2.0/athtcmd_ram.bin"
109 #define AR6003_HW_2_0_PATCH_FILE "ath6k/AR6003/hw2.0/data.patch.bin"
110 #define AR6003_HW_2_0_FIRMWARE_2_FILE "ath6k/AR6003/hw2.0/fw-2.bin"
111 #define AR6003_HW_2_0_BOARD_DATA_FILE "ath6k/AR6003/hw2.0/bdata.bin"
112 #define AR6003_HW_2_0_DEFAULT_BOARD_DATA_FILE \
113 "ath6k/AR6003/hw2.0/bdata.SD31.bin"
115 /* AR6003 3.0 definitions */
116 #define AR6003_HW_2_1_1_VERSION 0x30000582
117 #define AR6003_HW_2_1_1_OTP_FILE "ath6k/AR6003/hw2.1.1/otp.bin"
118 #define AR6003_HW_2_1_1_FIRMWARE_FILE "ath6k/AR6003/hw2.1.1/athwlan.bin"
119 #define AR6003_HW_2_1_1_TCMD_FIRMWARE_FILE \
120 "ath6k/AR6003/hw2.1.1/athtcmd_ram.bin"
121 #define AR6003_HW_2_1_1_PATCH_FILE "ath6k/AR6003/hw2.1.1/data.patch.bin"
122 #define AR6003_HW_2_1_1_FIRMWARE_2_FILE "ath6k/AR6003/hw2.1.1/fw-2.bin"
123 #define AR6003_HW_2_1_1_BOARD_DATA_FILE "ath6k/AR6003/hw2.1.1/bdata.bin"
124 #define AR6003_HW_2_1_1_DEFAULT_BOARD_DATA_FILE \
125 "ath6k/AR6003/hw2.1.1/bdata.SD31.bin"
127 /* AR6004 1.0 definitions */
128 #define AR6004_HW_1_0_VERSION 0x30000623
129 #define AR6004_HW_1_0_FIRMWARE_2_FILE "ath6k/AR6004/hw1.0/fw-2.bin"
130 #define AR6004_HW_1_0_FIRMWARE_FILE "ath6k/AR6004/hw1.0/fw.ram.bin"
131 #define AR6004_HW_1_0_BOARD_DATA_FILE "ath6k/AR6004/hw1.0/bdata.bin"
132 #define AR6004_HW_1_0_DEFAULT_BOARD_DATA_FILE \
133 "ath6k/AR6004/hw1.0/bdata.DB132.bin"
135 /* AR6004 1.1 definitions */
136 #define AR6004_HW_1_1_VERSION 0x30000001
137 #define AR6004_HW_1_1_FIRMWARE_2_FILE "ath6k/AR6004/hw1.1/fw-2.bin"
138 #define AR6004_HW_1_1_FIRMWARE_FILE "ath6k/AR6004/hw1.1/fw.ram.bin"
139 #define AR6004_HW_1_1_BOARD_DATA_FILE "ath6k/AR6004/hw1.1/bdata.bin"
140 #define AR6004_HW_1_1_DEFAULT_BOARD_DATA_FILE \
141 "ath6k/AR6004/hw1.1/bdata.DB132.bin"
143 /* Per STA data, used in AP mode */
144 #define STA_PS_AWAKE BIT(0)
145 #define STA_PS_SLEEP BIT(1)
146 #define STA_PS_POLLED BIT(2)
148 /* HTC TX packet tagging definitions */
149 #define ATH6KL_CONTROL_PKT_TAG HTC_TX_PACKET_TAG_USER_DEFINED
150 #define ATH6KL_DATA_PKT_TAG (ATH6KL_CONTROL_PKT_TAG + 1)
152 #define AR6003_CUST_DATA_SIZE 16
154 #define AGGR_WIN_IDX(x, y) ((x) % (y))
155 #define AGGR_INCR_IDX(x, y) AGGR_WIN_IDX(((x) + 1), (y))
156 #define AGGR_DCRM_IDX(x, y) AGGR_WIN_IDX(((x) - 1), (y))
157 #define ATH6KL_MAX_SEQ_NO 0xFFF
158 #define ATH6KL_NEXT_SEQ_NO(x) (((x) + 1) & ATH6KL_MAX_SEQ_NO)
160 #define NUM_OF_TIDS 8
161 #define AGGR_SZ_DEFAULT 8
163 #define AGGR_WIN_SZ_MIN 2
164 #define AGGR_WIN_SZ_MAX 8
166 #define TID_WINDOW_SZ(_x) ((_x) << 1)
168 #define AGGR_NUM_OF_FREE_NETBUFS 16
170 #define AGGR_RX_TIMEOUT 400 /* in ms */
172 #define WMI_TIMEOUT (2 * HZ)
174 #define MBOX_YIELD_LIMIT 99
176 /* configuration lags */
178 * ATH6KL_CONF_IGNORE_ERP_BARKER: Ignore the barker premable in
179 * ERP IE of beacon to determine the short premable support when
180 * sending (Re)Assoc req.
181 * ATH6KL_CONF_IGNORE_PS_FAIL_EVT_IN_SCAN: Don't send the power
182 * module state transition failure events which happen during
185 #define ATH6KL_CONF_IGNORE_ERP_BARKER BIT(0)
186 #define ATH6KL_CONF_IGNORE_PS_FAIL_EVT_IN_SCAN BIT(1)
187 #define ATH6KL_CONF_ENABLE_11N BIT(2)
188 #define ATH6KL_CONF_ENABLE_TX_BURST BIT(3)
189 #define ATH6KL_CONF_SUSPEND_CUTPOWER BIT(4)
191 enum wlan_low_pwr_state
{
193 WLAN_POWER_STATE_CUT_PWR
,
194 WLAN_POWER_STATE_DEEP_SLEEP
,
217 struct skb_hold_q
*hold_q
;
218 struct sk_buff_head q
;
237 struct timer_list timer
;
238 struct net_device
*dev
;
239 struct rxtid rx_tid
[NUM_OF_TIDS
];
240 struct sk_buff_head free_q
;
241 struct rxtid_stats stat
[NUM_OF_TIDS
];
244 struct ath6kl_wep_key
{
250 #define ATH6KL_KEY_SEQ_LEN 8
253 u8 key
[WLAN_MAX_KEY_LEN
];
255 u8 seq
[ATH6KL_KEY_SEQ_LEN
];
260 struct ath6kl_node_mapping
{
261 u8 mac_addr
[ETH_ALEN
];
266 struct ath6kl_cookie
{
269 struct htc_packet htc_pkt
;
270 struct ath6kl_cookie
*arc_list_next
;
280 u8 wpa_ie
[ATH6KL_MAX_IE
];
281 struct sk_buff_head psq
;
285 struct ath6kl_version
{
299 struct target_stats
{
308 u64 tx_rts_success_cnt
;
309 u64 tx_pkt_per_ac
[4];
314 u64 tx_mult_retry_cnt
;
329 u64 rx_key_cache_miss
;
333 u64 tkip_local_mic_fail
;
334 u64 tkip_cnter_measures_invoked
;
340 u64 pwr_save_fail_cnt
;
353 u16 wow_evt_discarded
;
355 s16 noise_floor_calib
;
357 s16 cs_ave_beacon_rssi
;
358 u8 cs_ave_beacon_snr
;
359 u8 cs_last_roam_msec
;
362 u8 wow_host_pkt_wakeups
;
363 u8 wow_host_evt_wakeups
;
370 struct ath6kl_mbox_info
{
383 * 802.11i defines an extended IV for use with non-WEP ciphers.
384 * When the EXTIV bit is set in the key id byte an additional
385 * 4 bytes immediately follow the IV for TKIP. For CCMP the
386 * EXTIV bit is likewise set but the 8 bytes represent the
387 * CCMP header rather than IV+extended-IV.
390 #define ATH6KL_KEYBUF_SIZE 16
391 #define ATH6KL_MICBUF_SIZE (8+8) /* space for both tx and rx */
393 #define ATH6KL_KEY_XMIT 0x01
394 #define ATH6KL_KEY_RECV 0x02
395 #define ATH6KL_KEY_DEFAULT 0x80 /* default xmit key */
397 /* Initial group key for AP mode */
398 struct ath6kl_req_key
{
402 u8 key
[WLAN_MAX_KEY_LEN
];
406 enum ath6kl_hif_type
{
407 ATH6KL_HIF_TYPE_SDIO
,
412 * Driver's maximum limit, note that some firmwares support only one vif
413 * and the runtime (current) limit must be checked from ar->vif_max.
415 #define ATH6KL_VIF_MAX 3
418 enum ath6kl_vif_state
{
425 CLEAR_BSSFILTER_ON_BEACON
,
432 struct list_head list
;
433 struct wireless_dev wdev
;
434 struct net_device
*ndev
;
436 /* Lock to protect vif specific net_stats and flags */
441 u8 ssid
[IEEE80211_MAX_SSID_LEN
];
445 u8 prwise_crypto_len
;
452 u8 req_bssid
[ETH_ALEN
];
455 struct ath6kl_wep_key wep_key_list
[WMI_MAX_KEY_INDEX
+ 1];
456 struct ath6kl_key keys
[WMI_MAX_KEY_INDEX
+ 1];
457 struct aggr_info
*aggr_cntxt
;
459 struct timer_list disconnect_timer
;
460 struct timer_list sched_scan_timer
;
462 struct cfg80211_scan_request
*scan_req
;
463 enum sme_state sme_state
;
466 u32 last_cancel_roc_id
;
468 bool probe_req_report
;
470 u16 assoc_bss_beacon_int
;
471 u8 assoc_bss_dtim_period
;
472 struct net_device_stats net_stats
;
473 struct target_stats target_stats
;
476 #define WOW_LIST_ID 0
477 #define WOW_HOST_REQ_DELAY 500 /* ms */
479 #define ATH6KL_SCHED_SCAN_RESULT_DELAY 5000 /* ms */
482 enum ath6kl_dev_state
{
496 ATH6KL_STATE_DEEPSLEEP
,
497 ATH6KL_STATE_CUTPOWER
,
499 ATH6KL_STATE_SCHED_SCAN
,
506 enum ath6kl_state state
;
508 struct ath6kl_bmi bmi
;
509 const struct ath6kl_hif_ops
*hif_ops
;
511 int tx_pending
[ENDPOINT_MAX
];
512 int total_tx_data_pend
;
513 struct htc_target
*htc_target
;
514 enum ath6kl_hif_type hif_type
;
516 struct list_head vif_list
;
517 /* Lock to avoid race in vif_list entries among add/del/traverse */
518 spinlock_t list_lock
;
520 unsigned int vif_max
;
524 struct semaphore sem
;
527 u8 lrssi_roam_threshold
;
528 struct ath6kl_version version
;
531 struct ath6kl_node_mapping node_map
[MAX_NODE_NUM
];
536 struct ath6kl_cookie
*cookie_list
;
538 enum htc_endpoint_id ac2ep_map
[WMM_NUM_AC
];
539 bool ac_stream_active
[WMM_NUM_AC
];
540 u8 ac_stream_pri_map
[WMM_NUM_AC
];
541 u8 hiac_stream_active_pri
;
542 u8 ep2ac_map
[ENDPOINT_MAX
];
543 enum htc_endpoint_id ctrl_ep
;
544 struct ath6kl_htc_credit_info credit_state_info
;
545 u32 connect_ctrl_flags
;
548 struct ath6kl_sta sta_list
[AP_MAX_NUM_STA
];
550 struct ath6kl_req_key ap_mode_bkey
;
551 struct sk_buff_head mcastpsq
;
552 spinlock_t mcastpsq_lock
;
554 struct wmi_ap_mode_stat ap_stats
;
555 u8 ap_country_code
[3];
556 struct list_head amsdu_rx_buffer_queue
;
558 enum wlan_low_pwr_state wlan_pwr_state
;
559 u8 mac_addr
[ETH_ALEN
];
560 #define AR_MCAST_FILTER_MAC_ADDR_SIZE 4
563 size_t rx_report_len
;
569 u32 dataset_patch_addr
;
571 u32 app_start_override_addr
;
572 u32 board_ext_data_addr
;
573 u32 reserved_ram_size
;
581 const char *fw_patch
;
583 const char *fw_board
;
584 const char *fw_default_board
;
588 wait_queue_head_t event_wq
;
589 struct ath6kl_mbox_info mbox_info
;
591 struct ath6kl_cookie cookie_mem
[MAX_COOKIE_NUM
];
606 unsigned long fw_capabilities
[ATH6KL_CAPABILITY_LEN
];
608 struct workqueue_struct
*ath6kl_wq
;
610 struct dentry
*debugfs_phy
;
614 #ifdef CONFIG_ATH6KL_DEBUG
616 struct circ_buf fwlog_buf
;
617 spinlock_t fwlog_lock
;
620 unsigned int dbgfs_diag_reg
;
621 u32 diag_reg_addr_wr
;
625 unsigned int invalid_rate
;
629 unsigned int roam_tbl_len
;
634 #endif /* CONFIG_ATH6KL_DEBUG */
637 static inline struct ath6kl
*ath6kl_priv(struct net_device
*dev
)
639 return ((struct ath6kl_vif
*) netdev_priv(dev
))->ar
;
642 static inline u32
ath6kl_get_hi_item_addr(struct ath6kl
*ar
,
647 if (ar
->target_type
== TARGET_TYPE_AR6003
)
648 addr
= ATH6KL_AR6003_HI_START_ADDR
+ item_offset
;
649 else if (ar
->target_type
== TARGET_TYPE_AR6004
)
650 addr
= ATH6KL_AR6004_HI_START_ADDR
+ item_offset
;
655 int ath6kl_configure_target(struct ath6kl
*ar
);
656 void ath6kl_detect_error(unsigned long ptr
);
657 void disconnect_timer_handler(unsigned long ptr
);
658 void init_netdev(struct net_device
*dev
);
659 void ath6kl_cookie_init(struct ath6kl
*ar
);
660 void ath6kl_cookie_cleanup(struct ath6kl
*ar
);
661 void ath6kl_rx(struct htc_target
*target
, struct htc_packet
*packet
);
662 void ath6kl_tx_complete(void *context
, struct list_head
*packet_queue
);
663 enum htc_send_full_action
ath6kl_tx_queue_full(struct htc_target
*target
,
664 struct htc_packet
*packet
);
665 void ath6kl_stop_txrx(struct ath6kl
*ar
);
666 void ath6kl_cleanup_amsdu_rxbufs(struct ath6kl
*ar
);
667 int ath6kl_diag_write32(struct ath6kl
*ar
, u32 address
, __le32 value
);
668 int ath6kl_diag_write(struct ath6kl
*ar
, u32 address
, void *data
, u32 length
);
669 int ath6kl_diag_read32(struct ath6kl
*ar
, u32 address
, u32
*value
);
670 int ath6kl_diag_read(struct ath6kl
*ar
, u32 address
, void *data
, u32 length
);
671 int ath6kl_read_fwlogs(struct ath6kl
*ar
);
672 void ath6kl_init_profile_info(struct ath6kl_vif
*vif
);
673 void ath6kl_tx_data_cleanup(struct ath6kl
*ar
);
675 struct ath6kl_cookie
*ath6kl_alloc_cookie(struct ath6kl
*ar
);
676 void ath6kl_free_cookie(struct ath6kl
*ar
, struct ath6kl_cookie
*cookie
);
677 int ath6kl_data_tx(struct sk_buff
*skb
, struct net_device
*dev
);
679 struct aggr_info
*aggr_init(struct net_device
*dev
);
680 void ath6kl_rx_refill(struct htc_target
*target
,
681 enum htc_endpoint_id endpoint
);
682 void ath6kl_refill_amsdu_rxbufs(struct ath6kl
*ar
, int count
);
683 struct htc_packet
*ath6kl_alloc_amsdu_rxbuf(struct htc_target
*target
,
684 enum htc_endpoint_id endpoint
,
686 void aggr_module_destroy(struct aggr_info
*aggr_info
);
687 void aggr_reset_state(struct aggr_info
*aggr_info
);
689 struct ath6kl_sta
*ath6kl_find_sta(struct ath6kl_vif
*vif
, u8
* node_addr
);
690 struct ath6kl_sta
*ath6kl_find_sta_by_aid(struct ath6kl
*ar
, u8 aid
);
692 void ath6kl_ready_event(void *devt
, u8
* datap
, u32 sw_ver
, u32 abi_ver
);
693 int ath6kl_control_tx(void *devt
, struct sk_buff
*skb
,
694 enum htc_endpoint_id eid
);
695 void ath6kl_connect_event(struct ath6kl_vif
*vif
, u16 channel
,
696 u8
*bssid
, u16 listen_int
,
697 u16 beacon_int
, enum network_type net_type
,
698 u8 beacon_ie_len
, u8 assoc_req_len
,
699 u8 assoc_resp_len
, u8
*assoc_info
);
700 void ath6kl_connect_ap_mode_bss(struct ath6kl_vif
*vif
, u16 channel
);
701 void ath6kl_connect_ap_mode_sta(struct ath6kl_vif
*vif
, u16 aid
, u8
*mac_addr
,
702 u8 keymgmt
, u8 ucipher
, u8 auth
,
703 u8 assoc_req_len
, u8
*assoc_info
);
704 void ath6kl_disconnect_event(struct ath6kl_vif
*vif
, u8 reason
,
705 u8
*bssid
, u8 assoc_resp_len
,
706 u8
*assoc_info
, u16 prot_reason_status
);
707 void ath6kl_tkip_micerr_event(struct ath6kl_vif
*vif
, u8 keyid
, bool ismcast
);
708 void ath6kl_txpwr_rx_evt(void *devt
, u8 tx_pwr
);
709 void ath6kl_scan_complete_evt(struct ath6kl_vif
*vif
, int status
);
710 void ath6kl_tgt_stats_event(struct ath6kl_vif
*vif
, u8
*ptr
, u32 len
);
711 void ath6kl_indicate_tx_activity(void *devt
, u8 traffic_class
, bool active
);
712 enum htc_endpoint_id
ath6kl_ac2_endpoint_id(void *devt
, u8 ac
);
714 void ath6kl_pspoll_event(struct ath6kl_vif
*vif
, u8 aid
);
716 void ath6kl_dtimexpiry_event(struct ath6kl_vif
*vif
);
717 void ath6kl_disconnect(struct ath6kl_vif
*vif
);
718 void aggr_recv_delba_req_evt(struct ath6kl_vif
*vif
, u8 tid
);
719 void aggr_recv_addba_req_evt(struct ath6kl_vif
*vif
, u8 tid
, u16 seq_no
,
721 void ath6kl_wakeup_event(void *dev
);
723 void ath6kl_reset_device(struct ath6kl
*ar
, u32 target_type
,
724 bool wait_fot_compltn
, bool cold_reset
);
725 void ath6kl_init_control_info(struct ath6kl_vif
*vif
);
726 void ath6kl_deinit_if_data(struct ath6kl_vif
*vif
);
727 void ath6kl_core_free(struct ath6kl
*ar
);
728 struct ath6kl_vif
*ath6kl_vif_first(struct ath6kl
*ar
);
729 void ath6kl_cleanup_vif(struct ath6kl_vif
*vif
, bool wmi_ready
);
730 int ath6kl_init_hw_start(struct ath6kl
*ar
);
731 int ath6kl_init_hw_stop(struct ath6kl
*ar
);
732 void ath6kl_check_wow_status(struct ath6kl
*ar
);