Merge branch 'akpm'
[linux-2.6/next.git] / drivers / net / wireless / ath / ath6kl / core.h
blob74170229523f0d350900e71da9d43bb7e777ddbe
1 /*
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.
17 #ifndef CORE_H
18 #define CORE_H
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>
25 #include "htc.h"
26 #include "wmi.h"
27 #include "bmi.h"
29 #define MAX_ATH6KL 1
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 /* MAX_HI_COOKIE_NUM are reserved for high priority traffic */
46 #define MAX_DEF_COOKIE_NUM 180
47 #define MAX_HI_COOKIE_NUM 18 /* 10% of MAX_COOKIE_NUM */
48 #define MAX_COOKIE_NUM (MAX_DEF_COOKIE_NUM + MAX_HI_COOKIE_NUM)
50 #define MAX_DEFAULT_SEND_QUEUE_DEPTH (MAX_DEF_COOKIE_NUM / WMM_NUM_AC)
52 #define DISCON_TIMER_INTVAL 10000 /* in msec */
53 #define A_DEFAULT_LISTEN_INTERVAL 100
54 #define A_MAX_WOW_LISTEN_INTERVAL 1000
56 /* AR6003 1.0 definitions */
57 #define AR6003_REV1_VERSION 0x300002ba
59 /* AR6003 2.0 definitions */
60 #define AR6003_REV2_VERSION 0x30000384
61 #define AR6003_REV2_PATCH_DOWNLOAD_ADDRESS 0x57e910
62 #define AR6003_REV2_OTP_FILE "ath6k/AR6003/hw2.0/otp.bin.z77"
63 #define AR6003_REV2_FIRMWARE_FILE "ath6k/AR6003/hw2.0/athwlan.bin.z77"
64 #define AR6003_REV2_PATCH_FILE "ath6k/AR6003/hw2.0/data.patch.bin"
65 #define AR6003_REV2_BOARD_DATA_FILE "ath6k/AR6003/hw2.0/bdata.bin"
66 #define AR6003_REV2_DEFAULT_BOARD_DATA_FILE "ath6k/AR6003/hw2.0/bdata.SD31.bin"
68 /* AR6003 3.0 definitions */
69 #define AR6003_REV3_VERSION 0x30000582
70 #define AR6003_REV3_OTP_FILE "ath6k/AR6003/hw2.1.1/otp.bin"
71 #define AR6003_REV3_FIRMWARE_FILE "ath6k/AR6003/hw2.1.1/athwlan.bin"
72 #define AR6003_REV3_PATCH_FILE "ath6k/AR6003/hw2.1.1/data.patch.bin"
73 #define AR6003_REV3_BOARD_DATA_FILE "ath6k/AR6003/hw2.1.1/bdata.bin"
74 #define AR6003_REV3_DEFAULT_BOARD_DATA_FILE \
75 "ath6k/AR6003/hw2.1.1/bdata.SD31.bin"
77 /* Per STA data, used in AP mode */
78 #define STA_PS_AWAKE BIT(0)
79 #define STA_PS_SLEEP BIT(1)
80 #define STA_PS_POLLED BIT(2)
82 /* HTC TX packet tagging definitions */
83 #define ATH6KL_CONTROL_PKT_TAG HTC_TX_PACKET_TAG_USER_DEFINED
84 #define ATH6KL_DATA_PKT_TAG (ATH6KL_CONTROL_PKT_TAG + 1)
86 #define AR6003_CUST_DATA_SIZE 16
88 #define AGGR_WIN_IDX(x, y) ((x) % (y))
89 #define AGGR_INCR_IDX(x, y) AGGR_WIN_IDX(((x) + 1), (y))
90 #define AGGR_DCRM_IDX(x, y) AGGR_WIN_IDX(((x) - 1), (y))
91 #define ATH6KL_MAX_SEQ_NO 0xFFF
92 #define ATH6KL_NEXT_SEQ_NO(x) (((x) + 1) & ATH6KL_MAX_SEQ_NO)
94 #define NUM_OF_TIDS 8
95 #define AGGR_SZ_DEFAULT 8
97 #define AGGR_WIN_SZ_MIN 2
98 #define AGGR_WIN_SZ_MAX 8
100 #define TID_WINDOW_SZ(_x) ((_x) << 1)
102 #define AGGR_NUM_OF_FREE_NETBUFS 16
104 #define AGGR_RX_TIMEOUT 400 /* in ms */
106 #define WMI_TIMEOUT (2 * HZ)
108 #define MBOX_YIELD_LIMIT 99
110 /* configuration lags */
112 * ATH6KL_CONF_IGNORE_ERP_BARKER: Ignore the barker premable in
113 * ERP IE of beacon to determine the short premable support when
114 * sending (Re)Assoc req.
115 * ATH6KL_CONF_IGNORE_PS_FAIL_EVT_IN_SCAN: Don't send the power
116 * module state transition failure events which happen during
117 * scan, to the host.
119 #define ATH6KL_CONF_IGNORE_ERP_BARKER BIT(0)
120 #define ATH6KL_CONF_IGNORE_PS_FAIL_EVT_IN_SCAN BIT(1)
121 #define ATH6KL_CONF_ENABLE_11N BIT(2)
122 #define ATH6KL_CONF_ENABLE_TX_BURST BIT(3)
124 enum wlan_low_pwr_state {
125 WLAN_POWER_STATE_ON,
126 WLAN_POWER_STATE_CUT_PWR,
127 WLAN_POWER_STATE_DEEP_SLEEP,
128 WLAN_POWER_STATE_WOW
131 enum sme_state {
132 SME_DISCONNECTED,
133 SME_CONNECTING,
134 SME_CONNECTED
137 struct skb_hold_q {
138 struct sk_buff *skb;
139 bool is_amsdu;
140 u16 seq_no;
143 struct rxtid {
144 bool aggr;
145 bool progress;
146 bool timer_mon;
147 u16 win_sz;
148 u16 seq_next;
149 u32 hold_q_sz;
150 struct skb_hold_q *hold_q;
151 struct sk_buff_head q;
152 spinlock_t lock;
155 struct rxtid_stats {
156 u32 num_into_aggr;
157 u32 num_dups;
158 u32 num_oow;
159 u32 num_mpdu;
160 u32 num_amsdu;
161 u32 num_delivered;
162 u32 num_timeouts;
163 u32 num_hole;
164 u32 num_bar;
167 struct aggr_info {
168 u8 aggr_sz;
169 u8 timer_scheduled;
170 struct timer_list timer;
171 struct net_device *dev;
172 struct rxtid rx_tid[NUM_OF_TIDS];
173 struct sk_buff_head free_q;
174 struct rxtid_stats stat[NUM_OF_TIDS];
177 struct ath6kl_wep_key {
178 u8 key_index;
179 u8 key_len;
180 u8 key[64];
183 #define ATH6KL_KEY_SEQ_LEN 8
185 struct ath6kl_key {
186 u8 key[WLAN_MAX_KEY_LEN];
187 u8 key_len;
188 u8 seq[ATH6KL_KEY_SEQ_LEN];
189 u8 seq_len;
190 u32 cipher;
193 struct ath6kl_node_mapping {
194 u8 mac_addr[ETH_ALEN];
195 u8 ep_id;
196 u8 tx_pend;
199 struct ath6kl_cookie {
200 struct sk_buff *skb;
201 u32 map_no;
202 struct htc_packet htc_pkt;
203 struct ath6kl_cookie *arc_list_next;
206 struct ath6kl_sta {
207 u16 sta_flags;
208 u8 mac[ETH_ALEN];
209 u8 aid;
210 u8 keymgmt;
211 u8 ucipher;
212 u8 auth;
213 u8 wpa_ie[ATH6KL_MAX_IE];
214 struct sk_buff_head psq;
215 spinlock_t psq_lock;
218 struct ath6kl_version {
219 u32 target_ver;
220 u32 wlan_ver;
221 u32 abi_ver;
224 struct ath6kl_bmi {
225 u32 cmd_credits;
226 bool done_sent;
227 u8 *cmd_buf;
230 struct target_stats {
231 u64 tx_pkt;
232 u64 tx_byte;
233 u64 tx_ucast_pkt;
234 u64 tx_ucast_byte;
235 u64 tx_mcast_pkt;
236 u64 tx_mcast_byte;
237 u64 tx_bcast_pkt;
238 u64 tx_bcast_byte;
239 u64 tx_rts_success_cnt;
240 u64 tx_pkt_per_ac[4];
242 u64 tx_err;
243 u64 tx_fail_cnt;
244 u64 tx_retry_cnt;
245 u64 tx_mult_retry_cnt;
246 u64 tx_rts_fail_cnt;
248 u64 rx_pkt;
249 u64 rx_byte;
250 u64 rx_ucast_pkt;
251 u64 rx_ucast_byte;
252 u64 rx_mcast_pkt;
253 u64 rx_mcast_byte;
254 u64 rx_bcast_pkt;
255 u64 rx_bcast_byte;
256 u64 rx_frgment_pkt;
258 u64 rx_err;
259 u64 rx_crc_err;
260 u64 rx_key_cache_miss;
261 u64 rx_decrypt_err;
262 u64 rx_dupl_frame;
264 u64 tkip_local_mic_fail;
265 u64 tkip_cnter_measures_invoked;
266 u64 tkip_replays;
267 u64 tkip_fmt_err;
268 u64 ccmp_fmt_err;
269 u64 ccmp_replays;
271 u64 pwr_save_fail_cnt;
273 u64 cs_bmiss_cnt;
274 u64 cs_low_rssi_cnt;
275 u64 cs_connect_cnt;
276 u64 cs_discon_cnt;
278 s32 tx_ucast_rate;
279 s32 rx_ucast_rate;
281 u32 lq_val;
283 u32 wow_pkt_dropped;
284 u16 wow_evt_discarded;
286 s16 noise_floor_calib;
287 s16 cs_rssi;
288 s16 cs_ave_beacon_rssi;
289 u8 cs_ave_beacon_snr;
290 u8 cs_last_roam_msec;
291 u8 cs_snr;
293 u8 wow_host_pkt_wakeups;
294 u8 wow_host_evt_wakeups;
296 u32 arp_received;
297 u32 arp_matched;
298 u32 arp_replied;
301 struct ath6kl_mbox_info {
302 u32 htc_addr;
303 u32 htc_ext_addr;
304 u32 htc_ext_sz;
306 u32 block_size;
308 u32 gmbox_addr;
310 u32 gmbox_sz;
314 * 802.11i defines an extended IV for use with non-WEP ciphers.
315 * When the EXTIV bit is set in the key id byte an additional
316 * 4 bytes immediately follow the IV for TKIP. For CCMP the
317 * EXTIV bit is likewise set but the 8 bytes represent the
318 * CCMP header rather than IV+extended-IV.
321 #define ATH6KL_KEYBUF_SIZE 16
322 #define ATH6KL_MICBUF_SIZE (8+8) /* space for both tx and rx */
324 #define ATH6KL_KEY_XMIT 0x01
325 #define ATH6KL_KEY_RECV 0x02
326 #define ATH6KL_KEY_DEFAULT 0x80 /* default xmit key */
329 * WPA/RSN get/set key request. Specify the key/cipher
330 * type and whether the key is to be used for sending and/or
331 * receiving. The key index should be set only when working
332 * with global keys (use IEEE80211_KEYIX_NONE for ``no index'').
333 * Otherwise a unicast/pairwise key is specified by the bssid
334 * (on a station) or mac address (on an ap). They key length
335 * must include any MIC key data; otherwise it should be no
336 * more than ATH6KL_KEYBUF_SIZE.
338 struct ath6kl_req_key {
339 u8 ik_type; /* key/cipher type */
340 u8 ik_pad;
341 u16 ik_keyix; /* key index */
342 u8 ik_keylen; /* key length in bytes */
343 u8 ik_flags;
344 u8 ik_macaddr[ETH_ALEN];
345 u64 ik_keyrsc; /* key receive sequence counter */
346 u64 ik_keytsc; /* key transmit sequence counter */
347 u8 ik_keydata[ATH6KL_KEYBUF_SIZE + ATH6KL_MICBUF_SIZE];
350 /* Flag info */
351 #define WMI_ENABLED 0
352 #define WMI_READY 1
353 #define CONNECTED 2
354 #define STATS_UPDATE_PEND 3
355 #define CONNECT_PEND 4
356 #define WMM_ENABLED 5
357 #define NETQ_STOPPED 6
358 #define WMI_CTRL_EP_FULL 7
359 #define DTIM_EXPIRED 8
360 #define DESTROY_IN_PROGRESS 9
361 #define NETDEV_REGISTERED 10
362 #define SKIP_SCAN 11
363 #define WLAN_ENABLED 12
365 struct ath6kl {
366 struct device *dev;
367 struct net_device *net_dev;
368 struct ath6kl_bmi bmi;
369 const struct ath6kl_hif_ops *hif_ops;
370 struct wmi *wmi;
371 int tx_pending[ENDPOINT_MAX];
372 int total_tx_data_pend;
373 struct htc_target *htc_target;
374 void *hif_priv;
375 spinlock_t lock;
376 struct semaphore sem;
377 int ssid_len;
378 u8 ssid[IEEE80211_MAX_SSID_LEN];
379 u8 next_mode;
380 u8 nw_type;
381 u8 dot11_auth_mode;
382 u8 auth_mode;
383 u8 prwise_crypto;
384 u8 prwise_crypto_len;
385 u8 grp_crypto;
386 u8 grp_crpto_len;
387 u8 def_txkey_index;
388 struct ath6kl_wep_key wep_key_list[WMI_MAX_KEY_INDEX + 1];
389 u8 bssid[ETH_ALEN];
390 u8 req_bssid[ETH_ALEN];
391 u16 ch_hint;
392 u16 bss_ch;
393 u16 listen_intvl_b;
394 u16 listen_intvl_t;
395 struct ath6kl_version version;
396 u32 target_type;
397 u8 tx_pwr;
398 struct net_device_stats net_stats;
399 struct target_stats target_stats;
400 struct ath6kl_node_mapping node_map[MAX_NODE_NUM];
401 u8 ibss_ps_enable;
402 u8 node_num;
403 u8 next_ep_id;
404 struct ath6kl_cookie *cookie_list;
405 u32 cookie_count;
406 enum htc_endpoint_id ac2ep_map[WMM_NUM_AC];
407 bool ac_stream_active[WMM_NUM_AC];
408 u8 ac_stream_pri_map[WMM_NUM_AC];
409 u8 hiac_stream_active_pri;
410 u8 ep2ac_map[ENDPOINT_MAX];
411 enum htc_endpoint_id ctrl_ep;
412 struct htc_credit_state_info credit_state_info;
413 u32 connect_ctrl_flags;
414 u32 user_key_ctrl;
415 u8 usr_bss_filter;
416 struct ath6kl_sta sta_list[AP_MAX_NUM_STA];
417 u8 sta_list_index;
418 struct ath6kl_req_key ap_mode_bkey;
419 struct sk_buff_head mcastpsq;
420 spinlock_t mcastpsq_lock;
421 u8 intra_bss;
422 struct aggr_info *aggr_cntxt;
423 struct wmi_ap_mode_stat ap_stats;
424 u8 ap_country_code[3];
425 struct list_head amsdu_rx_buffer_queue;
426 struct timer_list disconnect_timer;
427 u8 rx_meta_ver;
428 struct wireless_dev *wdev;
429 struct cfg80211_scan_request *scan_req;
430 struct ath6kl_key keys[WMI_MAX_KEY_INDEX + 1];
431 enum sme_state sme_state;
432 enum wlan_low_pwr_state wlan_pwr_state;
433 struct wmi_scan_params_cmd sc_params;
434 #define AR_MCAST_FILTER_MAC_ADDR_SIZE 4
435 u8 auto_auth_stage;
437 u16 conf_flags;
438 wait_queue_head_t event_wq;
439 struct ath6kl_mbox_info mbox_info;
441 struct ath6kl_cookie cookie_mem[MAX_COOKIE_NUM];
442 int reconnect_flag;
443 unsigned long flag;
445 u8 *fw_board;
446 size_t fw_board_len;
448 u8 *fw_otp;
449 size_t fw_otp_len;
451 u8 *fw;
452 size_t fw_len;
454 u8 *fw_patch;
455 size_t fw_patch_len;
457 struct workqueue_struct *ath6kl_wq;
459 struct ath6kl_node_table scan_table;
462 static inline void *ath6kl_priv(struct net_device *dev)
464 return wdev_priv(dev->ieee80211_ptr);
467 static inline void ath6kl_deposit_credit_to_ep(struct htc_credit_state_info
468 *cred_info,
469 struct htc_endpoint_credit_dist
470 *ep_dist, int credits)
472 ep_dist->credits += credits;
473 ep_dist->cred_assngd += credits;
474 cred_info->cur_free_credits -= credits;
477 void ath6kl_destroy(struct net_device *dev, unsigned int unregister);
478 int ath6kl_configure_target(struct ath6kl *ar);
479 void ath6kl_detect_error(unsigned long ptr);
480 void disconnect_timer_handler(unsigned long ptr);
481 void init_netdev(struct net_device *dev);
482 void ath6kl_cookie_init(struct ath6kl *ar);
483 void ath6kl_cookie_cleanup(struct ath6kl *ar);
484 void ath6kl_rx(struct htc_target *target, struct htc_packet *packet);
485 void ath6kl_tx_complete(void *context, struct list_head *packet_queue);
486 enum htc_send_full_action ath6kl_tx_queue_full(struct htc_target *target,
487 struct htc_packet *packet);
488 void ath6kl_stop_txrx(struct ath6kl *ar);
489 void ath6kl_cleanup_amsdu_rxbufs(struct ath6kl *ar);
490 int ath6kl_access_datadiag(struct ath6kl *ar, u32 address,
491 u8 *data, u32 length, bool read);
492 int ath6kl_read_reg_diag(struct ath6kl *ar, u32 *address, u32 *data);
493 void ath6kl_init_profile_info(struct ath6kl *ar);
494 void ath6kl_tx_data_cleanup(struct ath6kl *ar);
495 void ath6kl_stop_endpoint(struct net_device *dev, bool keep_profile,
496 bool get_dbglogs);
498 struct ath6kl_cookie *ath6kl_alloc_cookie(struct ath6kl *ar);
499 void ath6kl_free_cookie(struct ath6kl *ar, struct ath6kl_cookie *cookie);
500 int ath6kl_data_tx(struct sk_buff *skb, struct net_device *dev);
502 struct aggr_info *aggr_init(struct net_device *dev);
503 void ath6kl_rx_refill(struct htc_target *target,
504 enum htc_endpoint_id endpoint);
505 void ath6kl_refill_amsdu_rxbufs(struct ath6kl *ar, int count);
506 struct htc_packet *ath6kl_alloc_amsdu_rxbuf(struct htc_target *target,
507 enum htc_endpoint_id endpoint,
508 int len);
509 void aggr_module_destroy(struct aggr_info *aggr_info);
510 void aggr_reset_state(struct aggr_info *aggr_info);
512 struct ath6kl_sta *ath6kl_find_sta(struct ath6kl *ar, u8 * node_addr);
513 struct ath6kl_sta *ath6kl_find_sta_by_aid(struct ath6kl *ar, u8 aid);
515 void ath6kl_ready_event(void *devt, u8 * datap, u32 sw_ver, u32 abi_ver);
516 int ath6kl_control_tx(void *devt, struct sk_buff *skb,
517 enum htc_endpoint_id eid);
518 void ath6kl_connect_event(struct ath6kl *ar, u16 channel,
519 u8 *bssid, u16 listen_int,
520 u16 beacon_int, enum network_type net_type,
521 u8 beacon_ie_len, u8 assoc_req_len,
522 u8 assoc_resp_len, u8 *assoc_info);
523 void ath6kl_disconnect_event(struct ath6kl *ar, u8 reason,
524 u8 *bssid, u8 assoc_resp_len,
525 u8 *assoc_info, u16 prot_reason_status);
526 void ath6kl_tkip_micerr_event(struct ath6kl *ar, u8 keyid, bool ismcast);
527 void ath6kl_txpwr_rx_evt(void *devt, u8 tx_pwr);
528 void ath6kl_scan_complete_evt(struct ath6kl *ar, int status);
529 void ath6kl_tgt_stats_event(struct ath6kl *ar, u8 *ptr, u32 len);
530 void ath6kl_indicate_tx_activity(void *devt, u8 traffic_class, bool active);
531 enum htc_endpoint_id ath6kl_ac2_endpoint_id(void *devt, u8 ac);
533 void ath6kl_pspoll_event(struct ath6kl *ar, u8 aid);
535 void ath6kl_dtimexpiry_event(struct ath6kl *ar);
536 void ath6kl_disconnect(struct ath6kl *ar);
537 void aggr_recv_delba_req_evt(struct ath6kl *ar, u8 tid);
538 void aggr_recv_addba_req_evt(struct ath6kl *ar, u8 tid, u16 seq_no,
539 u8 win_sz);
540 void ath6kl_wakeup_event(void *dev);
541 void ath6kl_target_failure(struct ath6kl *ar);
543 void ath6kl_cfg80211_scan_node(struct wiphy *wiphy, struct bss *ni);
544 #endif /* CORE_H */