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 enum ath6kl_vif_state
{
391 CLEAR_BSSFILTER_ON_BEACON
,
397 struct wireless_dev wdev
;
398 struct net_device
*ndev
;
402 u8 ssid
[IEEE80211_MAX_SSID_LEN
];
406 u8 prwise_crypto_len
;
415 enum ath6kl_dev_state
{
428 struct net_device
*net_dev
;
430 struct ath6kl_bmi bmi
;
431 const struct ath6kl_hif_ops
*hif_ops
;
433 int tx_pending
[ENDPOINT_MAX
];
434 int total_tx_data_pend
;
435 struct htc_target
*htc_target
;
437 struct ath6kl_vif
*vif
;
439 struct semaphore sem
;
440 struct ath6kl_wep_key wep_key_list
[WMI_MAX_KEY_INDEX
+ 1];
442 u8 req_bssid
[ETH_ALEN
];
447 u8 lrssi_roam_threshold
;
448 struct ath6kl_version version
;
451 struct net_device_stats net_stats
;
452 struct target_stats target_stats
;
453 struct ath6kl_node_mapping node_map
[MAX_NODE_NUM
];
457 struct ath6kl_cookie
*cookie_list
;
459 enum htc_endpoint_id ac2ep_map
[WMM_NUM_AC
];
460 bool ac_stream_active
[WMM_NUM_AC
];
461 u8 ac_stream_pri_map
[WMM_NUM_AC
];
462 u8 hiac_stream_active_pri
;
463 u8 ep2ac_map
[ENDPOINT_MAX
];
464 enum htc_endpoint_id ctrl_ep
;
465 struct htc_credit_state_info credit_state_info
;
466 u32 connect_ctrl_flags
;
469 struct ath6kl_sta sta_list
[AP_MAX_NUM_STA
];
471 struct ath6kl_req_key ap_mode_bkey
;
472 struct sk_buff_head mcastpsq
;
473 spinlock_t mcastpsq_lock
;
475 struct aggr_info
*aggr_cntxt
;
476 struct wmi_ap_mode_stat ap_stats
;
477 u8 ap_country_code
[3];
478 struct list_head amsdu_rx_buffer_queue
;
479 struct timer_list disconnect_timer
;
481 struct wireless_dev
*wdev
;
482 struct cfg80211_scan_request
*scan_req
;
483 struct ath6kl_key keys
[WMI_MAX_KEY_INDEX
+ 1];
484 enum sme_state sme_state
;
485 enum wlan_low_pwr_state wlan_pwr_state
;
486 struct wmi_scan_params_cmd sc_params
;
487 #define AR_MCAST_FILTER_MAC_ADDR_SIZE 4
490 size_t rx_report_len
;
494 u32 dataset_patch_addr
;
496 u32 app_start_override_addr
;
497 u32 board_ext_data_addr
;
498 u32 reserved_ram_size
;
502 wait_queue_head_t event_wq
;
503 struct ath6kl_mbox_info mbox_info
;
505 struct ath6kl_cookie cookie_mem
[MAX_COOKIE_NUM
];
521 unsigned long fw_capabilities
[ATH6KL_CAPABILITY_LEN
];
523 struct workqueue_struct
*ath6kl_wq
;
525 struct dentry
*debugfs_phy
;
528 bool probe_req_report
;
532 u16 assoc_bss_beacon_int
;
533 u8 assoc_bss_dtim_period
;
535 #ifdef CONFIG_ATH6KL_DEBUG
537 struct circ_buf fwlog_buf
;
538 spinlock_t fwlog_lock
;
541 unsigned int dbgfs_diag_reg
;
542 u32 diag_reg_addr_wr
;
546 unsigned int invalid_rate
;
550 unsigned int roam_tbl_len
;
555 #endif /* CONFIG_ATH6KL_DEBUG */
558 static inline void *ath6kl_priv(struct net_device
*dev
)
560 return ((struct ath6kl_vif
*) netdev_priv(dev
))->ar
;
563 static inline void ath6kl_deposit_credit_to_ep(struct htc_credit_state_info
565 struct htc_endpoint_credit_dist
566 *ep_dist
, int credits
)
568 ep_dist
->credits
+= credits
;
569 ep_dist
->cred_assngd
+= credits
;
570 cred_info
->cur_free_credits
-= credits
;
573 static inline u32
ath6kl_get_hi_item_addr(struct ath6kl
*ar
,
578 if (ar
->target_type
== TARGET_TYPE_AR6003
)
579 addr
= ATH6KL_AR6003_HI_START_ADDR
+ item_offset
;
580 else if (ar
->target_type
== TARGET_TYPE_AR6004
)
581 addr
= ATH6KL_AR6004_HI_START_ADDR
+ item_offset
;
586 void ath6kl_destroy(struct net_device
*dev
, unsigned int unregister
);
587 int ath6kl_configure_target(struct ath6kl
*ar
);
588 void ath6kl_detect_error(unsigned long ptr
);
589 void disconnect_timer_handler(unsigned long ptr
);
590 void init_netdev(struct net_device
*dev
);
591 void ath6kl_cookie_init(struct ath6kl
*ar
);
592 void ath6kl_cookie_cleanup(struct ath6kl
*ar
);
593 void ath6kl_rx(struct htc_target
*target
, struct htc_packet
*packet
);
594 void ath6kl_tx_complete(void *context
, struct list_head
*packet_queue
);
595 enum htc_send_full_action
ath6kl_tx_queue_full(struct htc_target
*target
,
596 struct htc_packet
*packet
);
597 void ath6kl_stop_txrx(struct ath6kl
*ar
);
598 void ath6kl_cleanup_amsdu_rxbufs(struct ath6kl
*ar
);
599 int ath6kl_diag_write32(struct ath6kl
*ar
, u32 address
, __le32 value
);
600 int ath6kl_diag_write(struct ath6kl
*ar
, u32 address
, void *data
, u32 length
);
601 int ath6kl_diag_read32(struct ath6kl
*ar
, u32 address
, u32
*value
);
602 int ath6kl_diag_read(struct ath6kl
*ar
, u32 address
, void *data
, u32 length
);
603 int ath6kl_read_fwlogs(struct ath6kl
*ar
);
604 void ath6kl_init_profile_info(struct ath6kl
*ar
);
605 void ath6kl_tx_data_cleanup(struct ath6kl
*ar
);
606 void ath6kl_stop_endpoint(struct net_device
*dev
, bool keep_profile
,
609 struct ath6kl_cookie
*ath6kl_alloc_cookie(struct ath6kl
*ar
);
610 void ath6kl_free_cookie(struct ath6kl
*ar
, struct ath6kl_cookie
*cookie
);
611 int ath6kl_data_tx(struct sk_buff
*skb
, struct net_device
*dev
);
613 struct aggr_info
*aggr_init(struct net_device
*dev
);
614 void ath6kl_rx_refill(struct htc_target
*target
,
615 enum htc_endpoint_id endpoint
);
616 void ath6kl_refill_amsdu_rxbufs(struct ath6kl
*ar
, int count
);
617 struct htc_packet
*ath6kl_alloc_amsdu_rxbuf(struct htc_target
*target
,
618 enum htc_endpoint_id endpoint
,
620 void aggr_module_destroy(struct aggr_info
*aggr_info
);
621 void aggr_reset_state(struct aggr_info
*aggr_info
);
623 struct ath6kl_sta
*ath6kl_find_sta(struct ath6kl
*ar
, u8
* node_addr
);
624 struct ath6kl_sta
*ath6kl_find_sta_by_aid(struct ath6kl
*ar
, u8 aid
);
626 void ath6kl_ready_event(void *devt
, u8
* datap
, u32 sw_ver
, u32 abi_ver
);
627 int ath6kl_control_tx(void *devt
, struct sk_buff
*skb
,
628 enum htc_endpoint_id eid
);
629 void ath6kl_connect_event(struct ath6kl
*ar
, u16 channel
,
630 u8
*bssid
, u16 listen_int
,
631 u16 beacon_int
, enum network_type net_type
,
632 u8 beacon_ie_len
, u8 assoc_req_len
,
633 u8 assoc_resp_len
, u8
*assoc_info
);
634 void ath6kl_connect_ap_mode_bss(struct ath6kl
*ar
, u16 channel
);
635 void ath6kl_connect_ap_mode_sta(struct ath6kl
*ar
, u16 aid
, u8
*mac_addr
,
636 u8 keymgmt
, u8 ucipher
, u8 auth
,
637 u8 assoc_req_len
, u8
*assoc_info
);
638 void ath6kl_disconnect_event(struct ath6kl
*ar
, u8 reason
,
639 u8
*bssid
, u8 assoc_resp_len
,
640 u8
*assoc_info
, u16 prot_reason_status
);
641 void ath6kl_tkip_micerr_event(struct ath6kl
*ar
, u8 keyid
, bool ismcast
);
642 void ath6kl_txpwr_rx_evt(void *devt
, u8 tx_pwr
);
643 void ath6kl_scan_complete_evt(struct ath6kl
*ar
, int status
);
644 void ath6kl_tgt_stats_event(struct ath6kl
*ar
, u8
*ptr
, u32 len
);
645 void ath6kl_indicate_tx_activity(void *devt
, u8 traffic_class
, bool active
);
646 enum htc_endpoint_id
ath6kl_ac2_endpoint_id(void *devt
, u8 ac
);
648 void ath6kl_pspoll_event(struct ath6kl
*ar
, u8 aid
);
650 void ath6kl_dtimexpiry_event(struct ath6kl
*ar
);
651 void ath6kl_disconnect(struct ath6kl
*ar
);
652 void ath6kl_deep_sleep_enable(struct ath6kl
*ar
);
653 void aggr_recv_delba_req_evt(struct ath6kl
*ar
, u8 tid
);
654 void aggr_recv_addba_req_evt(struct ath6kl
*ar
, u8 tid
, u16 seq_no
,
656 void ath6kl_wakeup_event(void *dev
);
657 void ath6kl_target_failure(struct ath6kl
*ar
);
659 void ath6kl_init_control_info(struct ath6kl
*ar
);
660 void ath6kl_deinit_if_data(struct ath6kl_vif
*vif
);
661 void ath6kl_core_free(struct ath6kl
*ar
);