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 <net/cfg80211.h>
30 #define ATH6KL_MAX_RX_BUFFERS 16
31 #define ATH6KL_BUFFER_SIZE 1664
32 #define ATH6KL_MAX_AMSDU_RX_BUFFERS 4
33 #define ATH6KL_AMSDU_REFILL_THRESHOLD 3
34 #define ATH6KL_AMSDU_BUFFER_SIZE (WMI_MAX_AMSDU_RX_DATA_FRAME_LENGTH + 128)
35 #define MAX_MSDU_SUBFRAME_PAYLOAD_LEN 1508
36 #define MIN_MSDU_SUBFRAME_PAYLOAD_LEN 46
38 #define USER_SAVEDKEYS_STAT_INIT 0
39 #define USER_SAVEDKEYS_STAT_RUN 1
41 #define ATH6KL_TX_TIMEOUT 10
42 #define ATH6KL_MAX_ENDPOINTS 4
43 #define MAX_NODE_NUM 15
45 /* Extra bytes for htc header alignment */
46 #define ATH6KL_HTC_ALIGN_BYTES 3
48 /* MAX_HI_COOKIE_NUM are reserved for high priority traffic */
49 #define MAX_DEF_COOKIE_NUM 180
50 #define MAX_HI_COOKIE_NUM 18 /* 10% of MAX_COOKIE_NUM */
51 #define MAX_COOKIE_NUM (MAX_DEF_COOKIE_NUM + MAX_HI_COOKIE_NUM)
53 #define MAX_DEFAULT_SEND_QUEUE_DEPTH (MAX_DEF_COOKIE_NUM / WMM_NUM_AC)
55 #define DISCON_TIMER_INTVAL 10000 /* in msec */
56 #define A_DEFAULT_LISTEN_INTERVAL 100
57 #define A_MAX_WOW_LISTEN_INTERVAL 1000
59 /* AR6003 1.0 definitions */
60 #define AR6003_REV1_VERSION 0x300002ba
62 /* AR6003 2.0 definitions */
63 #define AR6003_REV2_VERSION 0x30000384
64 #define AR6003_REV2_PATCH_DOWNLOAD_ADDRESS 0x57e910
65 #define AR6003_REV2_OTP_FILE "ath6k/AR6003/hw2.0/otp.bin.z77"
66 #define AR6003_REV2_FIRMWARE_FILE "ath6k/AR6003/hw2.0/athwlan.bin.z77"
67 #define AR6003_REV2_PATCH_FILE "ath6k/AR6003/hw2.0/data.patch.bin"
68 #define AR6003_REV2_BOARD_DATA_FILE "ath6k/AR6003/hw2.0/bdata.bin"
69 #define AR6003_REV2_DEFAULT_BOARD_DATA_FILE "ath6k/AR6003/hw2.0/bdata.SD31.bin"
71 /* AR6003 3.0 definitions */
72 #define AR6003_REV3_VERSION 0x30000582
73 #define AR6003_REV3_OTP_FILE "ath6k/AR6003/hw2.1.1/otp.bin"
74 #define AR6003_REV3_FIRMWARE_FILE "ath6k/AR6003/hw2.1.1/athwlan.bin"
75 #define AR6003_REV3_PATCH_FILE "ath6k/AR6003/hw2.1.1/data.patch.bin"
76 #define AR6003_REV3_BOARD_DATA_FILE "ath6k/AR6003/hw2.1.1/bdata.bin"
77 #define AR6003_REV3_DEFAULT_BOARD_DATA_FILE \
78 "ath6k/AR6003/hw2.1.1/bdata.SD31.bin"
80 /* AR6004 1.0 definitions */
81 #define AR6004_REV1_VERSION 0x30000623
82 #define AR6004_REV1_FIRMWARE_FILE "ath6k/AR6004/hw6.1/fw.ram.bin"
83 #define AR6004_REV1_BOARD_DATA_FILE "ath6k/AR6004/hw6.1/bdata.bin"
84 #define AR6004_REV1_DEFAULT_BOARD_DATA_FILE "ath6k/AR6004/hw6.1/bdata.DB132.bin"
85 #define AR6004_REV1_EPPING_FIRMWARE_FILE "ath6k/AR6004/hw6.1/endpointping.bin"
87 /* Per STA data, used in AP mode */
88 #define STA_PS_AWAKE BIT(0)
89 #define STA_PS_SLEEP BIT(1)
90 #define STA_PS_POLLED BIT(2)
92 /* HTC TX packet tagging definitions */
93 #define ATH6KL_CONTROL_PKT_TAG HTC_TX_PACKET_TAG_USER_DEFINED
94 #define ATH6KL_DATA_PKT_TAG (ATH6KL_CONTROL_PKT_TAG + 1)
96 #define AR6003_CUST_DATA_SIZE 16
98 #define AGGR_WIN_IDX(x, y) ((x) % (y))
99 #define AGGR_INCR_IDX(x, y) AGGR_WIN_IDX(((x) + 1), (y))
100 #define AGGR_DCRM_IDX(x, y) AGGR_WIN_IDX(((x) - 1), (y))
101 #define ATH6KL_MAX_SEQ_NO 0xFFF
102 #define ATH6KL_NEXT_SEQ_NO(x) (((x) + 1) & ATH6KL_MAX_SEQ_NO)
104 #define NUM_OF_TIDS 8
105 #define AGGR_SZ_DEFAULT 8
107 #define AGGR_WIN_SZ_MIN 2
108 #define AGGR_WIN_SZ_MAX 8
110 #define TID_WINDOW_SZ(_x) ((_x) << 1)
112 #define AGGR_NUM_OF_FREE_NETBUFS 16
114 #define AGGR_RX_TIMEOUT 400 /* in ms */
116 #define WMI_TIMEOUT (2 * HZ)
118 #define MBOX_YIELD_LIMIT 99
120 /* configuration lags */
122 * ATH6KL_CONF_IGNORE_ERP_BARKER: Ignore the barker premable in
123 * ERP IE of beacon to determine the short premable support when
124 * sending (Re)Assoc req.
125 * ATH6KL_CONF_IGNORE_PS_FAIL_EVT_IN_SCAN: Don't send the power
126 * module state transition failure events which happen during
129 #define ATH6KL_CONF_IGNORE_ERP_BARKER BIT(0)
130 #define ATH6KL_CONF_IGNORE_PS_FAIL_EVT_IN_SCAN BIT(1)
131 #define ATH6KL_CONF_ENABLE_11N BIT(2)
132 #define ATH6KL_CONF_ENABLE_TX_BURST BIT(3)
134 enum wlan_low_pwr_state
{
136 WLAN_POWER_STATE_CUT_PWR
,
137 WLAN_POWER_STATE_DEEP_SLEEP
,
160 struct skb_hold_q
*hold_q
;
161 struct sk_buff_head q
;
180 struct timer_list timer
;
181 struct net_device
*dev
;
182 struct rxtid rx_tid
[NUM_OF_TIDS
];
183 struct sk_buff_head free_q
;
184 struct rxtid_stats stat
[NUM_OF_TIDS
];
187 struct ath6kl_wep_key
{
193 #define ATH6KL_KEY_SEQ_LEN 8
196 u8 key
[WLAN_MAX_KEY_LEN
];
198 u8 seq
[ATH6KL_KEY_SEQ_LEN
];
203 struct ath6kl_node_mapping
{
204 u8 mac_addr
[ETH_ALEN
];
209 struct ath6kl_cookie
{
212 struct htc_packet htc_pkt
;
213 struct ath6kl_cookie
*arc_list_next
;
223 u8 wpa_ie
[ATH6KL_MAX_IE
];
224 struct sk_buff_head psq
;
228 struct ath6kl_version
{
240 struct target_stats
{
249 u64 tx_rts_success_cnt
;
250 u64 tx_pkt_per_ac
[4];
255 u64 tx_mult_retry_cnt
;
270 u64 rx_key_cache_miss
;
274 u64 tkip_local_mic_fail
;
275 u64 tkip_cnter_measures_invoked
;
281 u64 pwr_save_fail_cnt
;
294 u16 wow_evt_discarded
;
296 s16 noise_floor_calib
;
298 s16 cs_ave_beacon_rssi
;
299 u8 cs_ave_beacon_snr
;
300 u8 cs_last_roam_msec
;
303 u8 wow_host_pkt_wakeups
;
304 u8 wow_host_evt_wakeups
;
311 struct ath6kl_mbox_info
{
324 * 802.11i defines an extended IV for use with non-WEP ciphers.
325 * When the EXTIV bit is set in the key id byte an additional
326 * 4 bytes immediately follow the IV for TKIP. For CCMP the
327 * EXTIV bit is likewise set but the 8 bytes represent the
328 * CCMP header rather than IV+extended-IV.
331 #define ATH6KL_KEYBUF_SIZE 16
332 #define ATH6KL_MICBUF_SIZE (8+8) /* space for both tx and rx */
334 #define ATH6KL_KEY_XMIT 0x01
335 #define ATH6KL_KEY_RECV 0x02
336 #define ATH6KL_KEY_DEFAULT 0x80 /* default xmit key */
339 * WPA/RSN get/set key request. Specify the key/cipher
340 * type and whether the key is to be used for sending and/or
341 * receiving. The key index should be set only when working
342 * with global keys (use IEEE80211_KEYIX_NONE for ``no index'').
343 * Otherwise a unicast/pairwise key is specified by the bssid
344 * (on a station) or mac address (on an ap). They key length
345 * must include any MIC key data; otherwise it should be no
346 * more than ATH6KL_KEYBUF_SIZE.
348 struct ath6kl_req_key
{
349 u8 ik_type
; /* key/cipher type */
351 u16 ik_keyix
; /* key index */
352 u8 ik_keylen
; /* key length in bytes */
354 u8 ik_macaddr
[ETH_ALEN
];
355 u64 ik_keyrsc
; /* key receive sequence counter */
356 u64 ik_keytsc
; /* key transmit sequence counter */
357 u8 ik_keydata
[ATH6KL_KEYBUF_SIZE
+ ATH6KL_MICBUF_SIZE
];
361 #define WMI_ENABLED 0
364 #define STATS_UPDATE_PEND 3
365 #define CONNECT_PEND 4
366 #define WMM_ENABLED 5
367 #define NETQ_STOPPED 6
368 #define WMI_CTRL_EP_FULL 7
369 #define DTIM_EXPIRED 8
370 #define DESTROY_IN_PROGRESS 9
371 #define NETDEV_REGISTERED 10
373 #define WLAN_ENABLED 12
377 struct net_device
*net_dev
;
378 struct ath6kl_bmi bmi
;
379 const struct ath6kl_hif_ops
*hif_ops
;
381 int tx_pending
[ENDPOINT_MAX
];
382 int total_tx_data_pend
;
383 struct htc_target
*htc_target
;
386 struct semaphore sem
;
388 u8 ssid
[IEEE80211_MAX_SSID_LEN
];
394 u8 prwise_crypto_len
;
398 struct ath6kl_wep_key wep_key_list
[WMI_MAX_KEY_INDEX
+ 1];
400 u8 req_bssid
[ETH_ALEN
];
405 struct ath6kl_version version
;
408 struct net_device_stats net_stats
;
409 struct target_stats target_stats
;
410 struct ath6kl_node_mapping node_map
[MAX_NODE_NUM
];
414 struct ath6kl_cookie
*cookie_list
;
416 enum htc_endpoint_id ac2ep_map
[WMM_NUM_AC
];
417 bool ac_stream_active
[WMM_NUM_AC
];
418 u8 ac_stream_pri_map
[WMM_NUM_AC
];
419 u8 hiac_stream_active_pri
;
420 u8 ep2ac_map
[ENDPOINT_MAX
];
421 enum htc_endpoint_id ctrl_ep
;
422 struct htc_credit_state_info credit_state_info
;
423 u32 connect_ctrl_flags
;
426 struct ath6kl_sta sta_list
[AP_MAX_NUM_STA
];
428 struct ath6kl_req_key ap_mode_bkey
;
429 struct sk_buff_head mcastpsq
;
430 spinlock_t mcastpsq_lock
;
432 struct aggr_info
*aggr_cntxt
;
433 struct wmi_ap_mode_stat ap_stats
;
434 u8 ap_country_code
[3];
435 struct list_head amsdu_rx_buffer_queue
;
436 struct timer_list disconnect_timer
;
438 struct wireless_dev
*wdev
;
439 struct cfg80211_scan_request
*scan_req
;
440 struct ath6kl_key keys
[WMI_MAX_KEY_INDEX
+ 1];
441 enum sme_state sme_state
;
442 enum wlan_low_pwr_state wlan_pwr_state
;
443 struct wmi_scan_params_cmd sc_params
;
444 #define AR_MCAST_FILTER_MAC_ADDR_SIZE 4
448 wait_queue_head_t event_wq
;
449 struct ath6kl_mbox_info mbox_info
;
451 struct ath6kl_cookie cookie_mem
[MAX_COOKIE_NUM
];
467 struct workqueue_struct
*ath6kl_wq
;
469 struct ath6kl_node_table scan_table
;
472 static inline void *ath6kl_priv(struct net_device
*dev
)
474 return wdev_priv(dev
->ieee80211_ptr
);
477 static inline void ath6kl_deposit_credit_to_ep(struct htc_credit_state_info
479 struct htc_endpoint_credit_dist
480 *ep_dist
, int credits
)
482 ep_dist
->credits
+= credits
;
483 ep_dist
->cred_assngd
+= credits
;
484 cred_info
->cur_free_credits
-= credits
;
487 void ath6kl_destroy(struct net_device
*dev
, unsigned int unregister
);
488 int ath6kl_configure_target(struct ath6kl
*ar
);
489 void ath6kl_detect_error(unsigned long ptr
);
490 void disconnect_timer_handler(unsigned long ptr
);
491 void init_netdev(struct net_device
*dev
);
492 void ath6kl_cookie_init(struct ath6kl
*ar
);
493 void ath6kl_cookie_cleanup(struct ath6kl
*ar
);
494 void ath6kl_rx(struct htc_target
*target
, struct htc_packet
*packet
);
495 void ath6kl_tx_complete(void *context
, struct list_head
*packet_queue
);
496 enum htc_send_full_action
ath6kl_tx_queue_full(struct htc_target
*target
,
497 struct htc_packet
*packet
);
498 void ath6kl_stop_txrx(struct ath6kl
*ar
);
499 void ath6kl_cleanup_amsdu_rxbufs(struct ath6kl
*ar
);
500 int ath6kl_access_datadiag(struct ath6kl
*ar
, u32 address
,
501 u8
*data
, u32 length
, bool read
);
502 int ath6kl_read_reg_diag(struct ath6kl
*ar
, u32
*address
, u32
*data
);
503 void ath6kl_init_profile_info(struct ath6kl
*ar
);
504 void ath6kl_tx_data_cleanup(struct ath6kl
*ar
);
505 void ath6kl_stop_endpoint(struct net_device
*dev
, bool keep_profile
,
508 struct ath6kl_cookie
*ath6kl_alloc_cookie(struct ath6kl
*ar
);
509 void ath6kl_free_cookie(struct ath6kl
*ar
, struct ath6kl_cookie
*cookie
);
510 int ath6kl_data_tx(struct sk_buff
*skb
, struct net_device
*dev
);
512 struct aggr_info
*aggr_init(struct net_device
*dev
);
513 void ath6kl_rx_refill(struct htc_target
*target
,
514 enum htc_endpoint_id endpoint
);
515 void ath6kl_refill_amsdu_rxbufs(struct ath6kl
*ar
, int count
);
516 struct htc_packet
*ath6kl_alloc_amsdu_rxbuf(struct htc_target
*target
,
517 enum htc_endpoint_id endpoint
,
519 void aggr_module_destroy(struct aggr_info
*aggr_info
);
520 void aggr_reset_state(struct aggr_info
*aggr_info
);
522 struct ath6kl_sta
*ath6kl_find_sta(struct ath6kl
*ar
, u8
* node_addr
);
523 struct ath6kl_sta
*ath6kl_find_sta_by_aid(struct ath6kl
*ar
, u8 aid
);
525 void ath6kl_ready_event(void *devt
, u8
* datap
, u32 sw_ver
, u32 abi_ver
);
526 int ath6kl_control_tx(void *devt
, struct sk_buff
*skb
,
527 enum htc_endpoint_id eid
);
528 void ath6kl_connect_event(struct ath6kl
*ar
, u16 channel
,
529 u8
*bssid
, u16 listen_int
,
530 u16 beacon_int
, enum network_type net_type
,
531 u8 beacon_ie_len
, u8 assoc_req_len
,
532 u8 assoc_resp_len
, u8
*assoc_info
);
533 void ath6kl_disconnect_event(struct ath6kl
*ar
, u8 reason
,
534 u8
*bssid
, u8 assoc_resp_len
,
535 u8
*assoc_info
, u16 prot_reason_status
);
536 void ath6kl_tkip_micerr_event(struct ath6kl
*ar
, u8 keyid
, bool ismcast
);
537 void ath6kl_txpwr_rx_evt(void *devt
, u8 tx_pwr
);
538 void ath6kl_scan_complete_evt(struct ath6kl
*ar
, int status
);
539 void ath6kl_tgt_stats_event(struct ath6kl
*ar
, u8
*ptr
, u32 len
);
540 void ath6kl_indicate_tx_activity(void *devt
, u8 traffic_class
, bool active
);
541 enum htc_endpoint_id
ath6kl_ac2_endpoint_id(void *devt
, u8 ac
);
543 void ath6kl_pspoll_event(struct ath6kl
*ar
, u8 aid
);
545 void ath6kl_dtimexpiry_event(struct ath6kl
*ar
);
546 void ath6kl_disconnect(struct ath6kl
*ar
);
547 void aggr_recv_delba_req_evt(struct ath6kl
*ar
, u8 tid
);
548 void aggr_recv_addba_req_evt(struct ath6kl
*ar
, u8 tid
, u16 seq_no
,
550 void ath6kl_wakeup_event(void *dev
);
551 void ath6kl_target_failure(struct ath6kl
*ar
);
553 void ath6kl_cfg80211_scan_node(struct wiphy
*wiphy
, struct bss
*ni
);