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,
75 enum ath6kl_fw_capability {
76 ATH6KL_FW_CAPABILITY_HOST_P2P = 0,
78 /* this needs to be last */
79 ATH6KL_FW_CAPABILITY_MAX,
82 #define ATH6KL_CAPABILITY_LEN (ALIGN(ATH6KL_FW_CAPABILITY_MAX, 32) / 32)
90 /* AR6003 1.0 definitions */
91 #define AR6003_REV1_VERSION 0x300002ba
93 /* AR6003 2.0 definitions */
94 #define AR6003_REV2_VERSION 0x30000384
95 #define AR6003_REV2_PATCH_DOWNLOAD_ADDRESS 0x57e910
96 #define AR6003_REV2_OTP_FILE "ath6k/AR6003/hw2.0/otp.bin.z77"
97 #define AR6003_REV2_FIRMWARE_FILE "ath6k/AR6003/hw2.0/athwlan.bin.z77"
98 #define AR6003_REV2_TCMD_FIRMWARE_FILE "ath6k/AR6003/hw2.0/athtcmd_ram.bin"
99 #define AR6003_REV2_PATCH_FILE "ath6k/AR6003/hw2.0/data.patch.bin"
100 #define AR6003_REV2_FIRMWARE_2_FILE "ath6k/AR6003/hw2.0/fw-2.bin"
101 #define AR6003_REV2_BOARD_DATA_FILE "ath6k/AR6003/hw2.0/bdata.bin"
102 #define AR6003_REV2_DEFAULT_BOARD_DATA_FILE "ath6k/AR6003/hw2.0/bdata.SD31.bin"
104 /* AR6003 3.0 definitions */
105 #define AR6003_REV3_VERSION 0x30000582
106 #define AR6003_REV3_OTP_FILE "ath6k/AR6003/hw2.1.1/otp.bin"
107 #define AR6003_REV3_FIRMWARE_FILE "ath6k/AR6003/hw2.1.1/athwlan.bin"
108 #define AR6003_REV3_TCMD_FIRMWARE_FILE "ath6k/AR6003/hw2.1.1/athtcmd_ram.bin"
109 #define AR6003_REV3_PATCH_FILE "ath6k/AR6003/hw2.1.1/data.patch.bin"
110 #define AR6003_REV3_FIRMWARE_2_FILE "ath6k/AR6003/hw2.1.1/fw-2.bin"
111 #define AR6003_REV3_BOARD_DATA_FILE "ath6k/AR6003/hw2.1.1/bdata.bin"
112 #define AR6003_REV3_DEFAULT_BOARD_DATA_FILE \
113 "ath6k/AR6003/hw2.1.1/bdata.SD31.bin"
115 /* AR6004 1.0 definitions */
116 #define AR6004_REV1_VERSION 0x30000623
117 #define AR6004_REV1_FIRMWARE_FILE "ath6k/AR6004/hw6.1/fw.ram.bin"
118 #define AR6004_REV1_FIRMWARE_2_FILE "ath6k/AR6004/hw6.1/fw-2.bin"
119 #define AR6004_REV1_BOARD_DATA_FILE "ath6k/AR6004/hw6.1/bdata.bin"
120 #define AR6004_REV1_DEFAULT_BOARD_DATA_FILE "ath6k/AR6004/hw6.1/bdata.DB132.bin"
121 #define AR6004_REV1_EPPING_FIRMWARE_FILE "ath6k/AR6004/hw6.1/endpointping.bin"
123 /* Per STA data, used in AP mode */
124 #define STA_PS_AWAKE BIT(0)
125 #define STA_PS_SLEEP BIT(1)
126 #define STA_PS_POLLED BIT(2)
128 /* HTC TX packet tagging definitions */
129 #define ATH6KL_CONTROL_PKT_TAG HTC_TX_PACKET_TAG_USER_DEFINED
130 #define ATH6KL_DATA_PKT_TAG (ATH6KL_CONTROL_PKT_TAG + 1)
132 #define AR6003_CUST_DATA_SIZE 16
134 #define AGGR_WIN_IDX(x, y) ((x) % (y))
135 #define AGGR_INCR_IDX(x, y) AGGR_WIN_IDX(((x) + 1), (y))
136 #define AGGR_DCRM_IDX(x, y) AGGR_WIN_IDX(((x) - 1), (y))
137 #define ATH6KL_MAX_SEQ_NO 0xFFF
138 #define ATH6KL_NEXT_SEQ_NO(x) (((x) + 1) & ATH6KL_MAX_SEQ_NO)
140 #define NUM_OF_TIDS 8
141 #define AGGR_SZ_DEFAULT 8
143 #define AGGR_WIN_SZ_MIN 2
144 #define AGGR_WIN_SZ_MAX 8
146 #define TID_WINDOW_SZ(_x) ((_x) << 1)
148 #define AGGR_NUM_OF_FREE_NETBUFS 16
150 #define AGGR_RX_TIMEOUT 400 /* in ms */
152 #define WMI_TIMEOUT (2 * HZ)
154 #define MBOX_YIELD_LIMIT 99
156 /* configuration lags */
158 * ATH6KL_CONF_IGNORE_ERP_BARKER: Ignore the barker premable in
159 * ERP IE of beacon to determine the short premable support when
160 * sending (Re)Assoc req.
161 * ATH6KL_CONF_IGNORE_PS_FAIL_EVT_IN_SCAN: Don't send the power
162 * module state transition failure events which happen during
165 #define ATH6KL_CONF_IGNORE_ERP_BARKER BIT(0)
166 #define ATH6KL_CONF_IGNORE_PS_FAIL_EVT_IN_SCAN BIT(1)
167 #define ATH6KL_CONF_ENABLE_11N BIT(2)
168 #define ATH6KL_CONF_ENABLE_TX_BURST BIT(3)
170 enum wlan_low_pwr_state {
172 WLAN_POWER_STATE_CUT_PWR,
173 WLAN_POWER_STATE_DEEP_SLEEP,
196 struct skb_hold_q *hold_q;
197 struct sk_buff_head q;
216 struct timer_list timer;
217 struct net_device *dev;
218 struct rxtid rx_tid[NUM_OF_TIDS];
219 struct sk_buff_head free_q;
220 struct rxtid_stats stat[NUM_OF_TIDS];
223 struct ath6kl_wep_key {
229 #define ATH6KL_KEY_SEQ_LEN 8
232 u8 key[WLAN_MAX_KEY_LEN];
234 u8 seq[ATH6KL_KEY_SEQ_LEN];
239 struct ath6kl_node_mapping {
240 u8 mac_addr[ETH_ALEN];
245 struct ath6kl_cookie {
248 struct htc_packet htc_pkt;
249 struct ath6kl_cookie *arc_list_next;
259 u8 wpa_ie[ATH6KL_MAX_IE];
260 struct sk_buff_head psq;
264 struct ath6kl_version {
276 struct target_stats {
285 u64 tx_rts_success_cnt;
286 u64 tx_pkt_per_ac[4];
291 u64 tx_mult_retry_cnt;
306 u64 rx_key_cache_miss;
310 u64 tkip_local_mic_fail;
311 u64 tkip_cnter_measures_invoked;
317 u64 pwr_save_fail_cnt;
330 u16 wow_evt_discarded;
332 s16 noise_floor_calib;
334 s16 cs_ave_beacon_rssi;
335 u8 cs_ave_beacon_snr;
336 u8 cs_last_roam_msec;
339 u8 wow_host_pkt_wakeups;
340 u8 wow_host_evt_wakeups;
347 struct ath6kl_mbox_info {
360 * 802.11i defines an extended IV for use with non-WEP ciphers.
361 * When the EXTIV bit is set in the key id byte an additional
362 * 4 bytes immediately follow the IV for TKIP. For CCMP the
363 * EXTIV bit is likewise set but the 8 bytes represent the
364 * CCMP header rather than IV+extended-IV.
367 #define ATH6KL_KEYBUF_SIZE 16
368 #define ATH6KL_MICBUF_SIZE (8+8) /* space for both tx and rx */
370 #define ATH6KL_KEY_XMIT 0x01
371 #define ATH6KL_KEY_RECV 0x02
372 #define ATH6KL_KEY_DEFAULT 0x80 /* default xmit key */
374 /* Initial group key for AP mode */
375 struct ath6kl_req_key {
379 u8 key[WLAN_MAX_KEY_LEN];
384 #define WMI_ENABLED 0
387 #define STATS_UPDATE_PEND 3
388 #define CONNECT_PEND 4
389 #define WMM_ENABLED 5
390 #define NETQ_STOPPED 6
391 #define WMI_CTRL_EP_FULL 7
392 #define DTIM_EXPIRED 8
393 #define DESTROY_IN_PROGRESS 9
394 #define NETDEV_REGISTERED 10
396 #define WLAN_ENABLED 12
398 #define CLEAR_BSSFILTER_ON_BEACON 14
399 #define DTIM_PERIOD_AVAIL 15
403 struct net_device *net_dev;
404 struct ath6kl_bmi bmi;
405 const struct ath6kl_hif_ops *hif_ops;
407 int tx_pending[ENDPOINT_MAX];
408 int total_tx_data_pend;
409 struct htc_target *htc_target;
412 struct semaphore sem;
414 u8 ssid[IEEE80211_MAX_SSID_LEN];
420 u8 prwise_crypto_len;
424 struct ath6kl_wep_key wep_key_list[WMI_MAX_KEY_INDEX + 1];
426 u8 req_bssid[ETH_ALEN];
431 u8 lrssi_roam_threshold;
432 struct ath6kl_version version;
435 struct net_device_stats net_stats;
436 struct target_stats target_stats;
437 struct ath6kl_node_mapping node_map[MAX_NODE_NUM];
441 struct ath6kl_cookie *cookie_list;
443 enum htc_endpoint_id ac2ep_map[WMM_NUM_AC];
444 bool ac_stream_active[WMM_NUM_AC];
445 u8 ac_stream_pri_map[WMM_NUM_AC];
446 u8 hiac_stream_active_pri;
447 u8 ep2ac_map[ENDPOINT_MAX];
448 enum htc_endpoint_id ctrl_ep;
449 struct htc_credit_state_info credit_state_info;
450 u32 connect_ctrl_flags;
453 struct ath6kl_sta sta_list[AP_MAX_NUM_STA];
455 struct ath6kl_req_key ap_mode_bkey;
456 struct sk_buff_head mcastpsq;
457 spinlock_t mcastpsq_lock;
459 struct aggr_info *aggr_cntxt;
460 struct wmi_ap_mode_stat ap_stats;
461 u8 ap_country_code[3];
462 struct list_head amsdu_rx_buffer_queue;
463 struct timer_list disconnect_timer;
465 struct wireless_dev *wdev;
466 struct cfg80211_scan_request *scan_req;
467 struct ath6kl_key keys[WMI_MAX_KEY_INDEX + 1];
468 enum sme_state sme_state;
469 enum wlan_low_pwr_state wlan_pwr_state;
470 struct wmi_scan_params_cmd sc_params;
471 #define AR_MCAST_FILTER_MAC_ADDR_SIZE 4
474 size_t rx_report_len;
478 u32 dataset_patch_addr;
480 u32 app_start_override_addr;
481 u32 board_ext_data_addr;
482 u32 reserved_ram_size;
486 wait_queue_head_t event_wq;
487 struct ath6kl_mbox_info mbox_info;
489 struct ath6kl_cookie cookie_mem[MAX_COOKIE_NUM];
505 unsigned long fw_capabilities[ATH6KL_CAPABILITY_LEN];
507 struct workqueue_struct *ath6kl_wq;
509 struct dentry *debugfs_phy;
512 bool probe_req_report;
516 u16 assoc_bss_beacon_int;
517 u8 assoc_bss_dtim_period;
519 #ifdef CONFIG_ATH6KL_DEBUG
521 struct circ_buf fwlog_buf;
522 spinlock_t fwlog_lock;
525 unsigned int dbgfs_diag_reg;
526 u32 diag_reg_addr_wr;
530 unsigned int invalid_rate;
533 #endif /* CONFIG_ATH6KL_DEBUG */
536 static inline void *ath6kl_priv(struct net_device *dev)
538 return wdev_priv(dev->ieee80211_ptr);
541 static inline void ath6kl_deposit_credit_to_ep(struct htc_credit_state_info
543 struct htc_endpoint_credit_dist
544 *ep_dist, int credits)
546 ep_dist->credits += credits;
547 ep_dist->cred_assngd += credits;
548 cred_info->cur_free_credits -= credits;
551 static inline u32 ath6kl_get_hi_item_addr(struct ath6kl *ar,
556 if (ar->target_type == TARGET_TYPE_AR6003)
557 addr = ATH6KL_AR6003_HI_START_ADDR + item_offset;
558 else if (ar->target_type == TARGET_TYPE_AR6004)
559 addr = ATH6KL_AR6004_HI_START_ADDR + item_offset;
564 void ath6kl_destroy(struct net_device *dev, unsigned int unregister);
565 int ath6kl_configure_target(struct ath6kl *ar);
566 void ath6kl_detect_error(unsigned long ptr);
567 void disconnect_timer_handler(unsigned long ptr);
568 void init_netdev(struct net_device *dev);
569 void ath6kl_cookie_init(struct ath6kl *ar);
570 void ath6kl_cookie_cleanup(struct ath6kl *ar);
571 void ath6kl_rx(struct htc_target *target, struct htc_packet *packet);
572 void ath6kl_tx_complete(void *context, struct list_head *packet_queue);
573 enum htc_send_full_action ath6kl_tx_queue_full(struct htc_target *target,
574 struct htc_packet *packet);
575 void ath6kl_stop_txrx(struct ath6kl *ar);
576 void ath6kl_cleanup_amsdu_rxbufs(struct ath6kl *ar);
577 int ath6kl_diag_write32(struct ath6kl *ar, u32 address, __le32 value);
578 int ath6kl_diag_write(struct ath6kl *ar, u32 address, void *data, u32 length);
579 int ath6kl_diag_read32(struct ath6kl *ar, u32 address, u32 *value);
580 int ath6kl_diag_read(struct ath6kl *ar, u32 address, void *data, u32 length);
581 int ath6kl_read_fwlogs(struct ath6kl *ar);
582 void ath6kl_init_profile_info(struct ath6kl *ar);
583 void ath6kl_tx_data_cleanup(struct ath6kl *ar);
584 void ath6kl_stop_endpoint(struct net_device *dev, bool keep_profile,
587 struct ath6kl_cookie *ath6kl_alloc_cookie(struct ath6kl *ar);
588 void ath6kl_free_cookie(struct ath6kl *ar, struct ath6kl_cookie *cookie);
589 int ath6kl_data_tx(struct sk_buff *skb, struct net_device *dev);
591 struct aggr_info *aggr_init(struct net_device *dev);
592 void ath6kl_rx_refill(struct htc_target *target,
593 enum htc_endpoint_id endpoint);
594 void ath6kl_refill_amsdu_rxbufs(struct ath6kl *ar, int count);
595 struct htc_packet *ath6kl_alloc_amsdu_rxbuf(struct htc_target *target,
596 enum htc_endpoint_id endpoint,
598 void aggr_module_destroy(struct aggr_info *aggr_info);
599 void aggr_reset_state(struct aggr_info *aggr_info);
601 struct ath6kl_sta *ath6kl_find_sta(struct ath6kl *ar, u8 * node_addr);
602 struct ath6kl_sta *ath6kl_find_sta_by_aid(struct ath6kl *ar, u8 aid);
604 void ath6kl_ready_event(void *devt, u8 * datap, u32 sw_ver, u32 abi_ver);
605 int ath6kl_control_tx(void *devt, struct sk_buff *skb,
606 enum htc_endpoint_id eid);
607 void ath6kl_connect_event(struct ath6kl *ar, u16 channel,
608 u8 *bssid, u16 listen_int,
609 u16 beacon_int, enum network_type net_type,
610 u8 beacon_ie_len, u8 assoc_req_len,
611 u8 assoc_resp_len, u8 *assoc_info);
612 void ath6kl_connect_ap_mode_bss(struct ath6kl *ar, u16 channel);
613 void ath6kl_connect_ap_mode_sta(struct ath6kl *ar, u16 aid, u8 *mac_addr,
614 u8 keymgmt, u8 ucipher, u8 auth,
615 u8 assoc_req_len, u8 *assoc_info);
616 void ath6kl_disconnect_event(struct ath6kl *ar, u8 reason,
617 u8 *bssid, u8 assoc_resp_len,
618 u8 *assoc_info, u16 prot_reason_status);
619 void ath6kl_tkip_micerr_event(struct ath6kl *ar, u8 keyid, bool ismcast);
620 void ath6kl_txpwr_rx_evt(void *devt, u8 tx_pwr);
621 void ath6kl_scan_complete_evt(struct ath6kl *ar, int status);
622 void ath6kl_tgt_stats_event(struct ath6kl *ar, u8 *ptr, u32 len);
623 void ath6kl_indicate_tx_activity(void *devt, u8 traffic_class, bool active);
624 enum htc_endpoint_id ath6kl_ac2_endpoint_id(void *devt, u8 ac);
626 void ath6kl_pspoll_event(struct ath6kl *ar, u8 aid);
628 void ath6kl_dtimexpiry_event(struct ath6kl *ar);
629 void ath6kl_disconnect(struct ath6kl *ar);
630 void ath6kl_deep_sleep_enable(struct ath6kl *ar);
631 void aggr_recv_delba_req_evt(struct ath6kl *ar, u8 tid);
632 void aggr_recv_addba_req_evt(struct ath6kl *ar, u8 tid, u16 seq_no,
634 void ath6kl_wakeup_event(void *dev);
635 void ath6kl_target_failure(struct ath6kl *ar);