sfc: Don't use enums as a bitmask.
[zen-stable.git] / drivers / net / wireless / ath / ath9k / htc.h
blobdfc7a982fc7eb265e263e524926603ba631574fc
1 /*
2 * Copyright (c) 2010 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 HTC_H
18 #define HTC_H
20 #include <linux/module.h>
21 #include <linux/usb.h>
22 #include <linux/firmware.h>
23 #include <linux/skbuff.h>
24 #include <linux/netdevice.h>
25 #include <linux/leds.h>
26 #include <linux/slab.h>
27 #include <net/mac80211.h>
29 #include "common.h"
30 #include "htc_hst.h"
31 #include "hif_usb.h"
32 #include "wmi.h"
34 #define ATH_STA_SHORT_CALINTERVAL 1000 /* 1 second */
35 #define ATH_AP_SHORT_CALINTERVAL 100 /* 100 ms */
36 #define ATH_ANI_POLLINTERVAL 100 /* 100 ms */
37 #define ATH_LONG_CALINTERVAL 30000 /* 30 seconds */
38 #define ATH_RESTART_CALINTERVAL 1200000 /* 20 minutes */
40 #define ATH_DEFAULT_BMISS_LIMIT 10
41 #define IEEE80211_MS_TO_TU(x) (((x) * 1000) / 1024)
42 #define TSF_TO_TU(_h, _l) \
43 ((((u32)(_h)) << 22) | (((u32)(_l)) >> 10))
45 extern struct ieee80211_ops ath9k_htc_ops;
46 extern int htc_modparam_nohwcrypt;
48 enum htc_phymode {
49 HTC_MODE_AUTO = 0,
50 HTC_MODE_11A = 1,
51 HTC_MODE_11B = 2,
52 HTC_MODE_11G = 3,
53 HTC_MODE_FH = 4,
54 HTC_MODE_TURBO_A = 5,
55 HTC_MODE_TURBO_G = 6,
56 HTC_MODE_11NA = 7,
57 HTC_MODE_11NG = 8
60 enum htc_opmode {
61 HTC_M_STA = 1,
62 HTC_M_IBSS = 0,
63 HTC_M_AHDEMO = 3,
64 HTC_M_HOSTAP = 6,
65 HTC_M_MONITOR = 8,
66 HTC_M_WDS = 2
69 #define ATH9K_HTC_AMPDU 1
70 #define ATH9K_HTC_NORMAL 2
71 #define ATH9K_HTC_BEACON 3
72 #define ATH9K_HTC_MGMT 4
74 #define ATH9K_HTC_TX_CTSONLY 0x1
75 #define ATH9K_HTC_TX_RTSCTS 0x2
77 struct tx_frame_hdr {
78 u8 data_type;
79 u8 node_idx;
80 u8 vif_idx;
81 u8 tidno;
82 __be32 flags; /* ATH9K_HTC_TX_* */
83 u8 key_type;
84 u8 keyix;
85 u8 cookie;
86 u8 pad;
87 } __packed;
89 struct tx_mgmt_hdr {
90 u8 node_idx;
91 u8 vif_idx;
92 u8 tidno;
93 u8 flags;
94 u8 key_type;
95 u8 keyix;
96 u8 cookie;
97 u8 pad;
98 } __packed;
100 struct tx_beacon_header {
101 u8 vif_index;
102 u8 len_changed;
103 u16 rev;
104 } __packed;
106 #define MAX_TX_AMPDU_SUBFRAMES_9271 17
107 #define MAX_TX_AMPDU_SUBFRAMES_7010 22
109 struct ath9k_htc_cap_target {
110 __be32 ampdu_limit;
111 u8 ampdu_subframes;
112 u8 enable_coex;
113 u8 tx_chainmask;
114 u8 pad;
115 } __packed;
117 struct ath9k_htc_target_vif {
118 u8 index;
119 u8 opmode;
120 u8 myaddr[ETH_ALEN];
121 u8 ath_cap;
122 __be16 rtsthreshold;
123 u8 pad;
124 } __packed;
126 #define ATH_HTC_STA_AUTH 0x0001
127 #define ATH_HTC_STA_QOS 0x0002
128 #define ATH_HTC_STA_ERP 0x0004
129 #define ATH_HTC_STA_HT 0x0008
131 struct ath9k_htc_target_sta {
132 u8 macaddr[ETH_ALEN];
133 u8 bssid[ETH_ALEN];
134 u8 sta_index;
135 u8 vif_index;
136 u8 is_vif_sta;
137 __be16 flags; /* ATH_HTC_STA_* */
138 __be16 htcap;
139 __be16 maxampdu;
140 u8 pad;
141 } __packed;
143 struct ath9k_htc_target_aggr {
144 u8 sta_index;
145 u8 tidno;
146 u8 aggr_enable;
147 u8 padding;
148 } __packed;
150 #define ATH_HTC_RATE_MAX 30
152 #define WLAN_RC_DS_FLAG 0x01
153 #define WLAN_RC_40_FLAG 0x02
154 #define WLAN_RC_SGI_FLAG 0x04
155 #define WLAN_RC_HT_FLAG 0x08
157 struct ath9k_htc_rateset {
158 u8 rs_nrates;
159 u8 rs_rates[ATH_HTC_RATE_MAX];
162 struct ath9k_htc_rate {
163 struct ath9k_htc_rateset legacy_rates;
164 struct ath9k_htc_rateset ht_rates;
165 } __packed;
167 struct ath9k_htc_target_rate {
168 u8 sta_index;
169 u8 isnew;
170 __be32 capflags;
171 struct ath9k_htc_rate rates;
174 struct ath9k_htc_target_rate_mask {
175 u8 vif_index;
176 u8 band;
177 __be32 mask;
178 u16 pad;
179 } __packed;
181 struct ath9k_htc_target_int_stats {
182 __be32 rx;
183 __be32 rxorn;
184 __be32 rxeol;
185 __be32 txurn;
186 __be32 txto;
187 __be32 cst;
188 } __packed;
190 struct ath9k_htc_target_tx_stats {
191 __be32 xretries;
192 __be32 fifoerr;
193 __be32 filtered;
194 __be32 timer_exp;
195 __be32 shortretries;
196 __be32 longretries;
197 __be32 qnull;
198 __be32 encap_fail;
199 __be32 nobuf;
200 } __packed;
202 struct ath9k_htc_target_rx_stats {
203 __be32 nobuf;
204 __be32 host_send;
205 __be32 host_done;
206 } __packed;
208 #define ATH9K_HTC_MAX_VIF 2
209 #define ATH9K_HTC_MAX_BCN_VIF 2
211 #define INC_VIF(_priv, _type) do { \
212 switch (_type) { \
213 case NL80211_IFTYPE_STATION: \
214 _priv->num_sta_vif++; \
215 break; \
216 case NL80211_IFTYPE_ADHOC: \
217 _priv->num_ibss_vif++; \
218 break; \
219 case NL80211_IFTYPE_AP: \
220 _priv->num_ap_vif++; \
221 break; \
222 default: \
223 break; \
225 } while (0)
227 #define DEC_VIF(_priv, _type) do { \
228 switch (_type) { \
229 case NL80211_IFTYPE_STATION: \
230 _priv->num_sta_vif--; \
231 break; \
232 case NL80211_IFTYPE_ADHOC: \
233 _priv->num_ibss_vif--; \
234 break; \
235 case NL80211_IFTYPE_AP: \
236 _priv->num_ap_vif--; \
237 break; \
238 default: \
239 break; \
241 } while (0)
243 struct ath9k_htc_vif {
244 u8 index;
245 u16 seq_no;
246 bool beacon_configured;
247 int bslot;
248 __le64 tsfadjust;
251 struct ath9k_vif_iter_data {
252 const u8 *hw_macaddr;
253 u8 mask[ETH_ALEN];
256 #define ATH9K_HTC_MAX_STA 8
257 #define ATH9K_HTC_MAX_TID 8
259 enum tid_aggr_state {
260 AGGR_STOP = 0,
261 AGGR_PROGRESS,
262 AGGR_START,
263 AGGR_OPERATIONAL
266 struct ath9k_htc_sta {
267 u8 index;
268 enum tid_aggr_state tid_state[ATH9K_HTC_MAX_TID];
271 #define ATH9K_HTC_RXBUF 256
272 #define HTC_RX_FRAME_HEADER_SIZE 40
274 struct ath9k_htc_rxbuf {
275 bool in_process;
276 struct sk_buff *skb;
277 struct ath_htc_rx_status rxstatus;
278 struct list_head list;
281 struct ath9k_htc_rx {
282 int last_rssi; /* FIXME: per-STA */
283 struct list_head rxbuf;
284 spinlock_t rxbuflock;
287 #define ATH9K_HTC_TX_CLEANUP_INTERVAL 50 /* ms */
288 #define ATH9K_HTC_TX_TIMEOUT_INTERVAL 2500 /* ms */
289 #define ATH9K_HTC_TX_RESERVE 10
290 #define ATH9K_HTC_TX_TIMEOUT_COUNT 20
291 #define ATH9K_HTC_TX_THRESHOLD (MAX_TX_BUF_NUM - ATH9K_HTC_TX_RESERVE)
293 #define ATH9K_HTC_OP_TX_QUEUES_STOP BIT(0)
294 #define ATH9K_HTC_OP_TX_DRAIN BIT(1)
296 struct ath9k_htc_tx {
297 u8 flags;
298 int queued_cnt;
299 struct sk_buff_head mgmt_ep_queue;
300 struct sk_buff_head cab_ep_queue;
301 struct sk_buff_head data_be_queue;
302 struct sk_buff_head data_bk_queue;
303 struct sk_buff_head data_vi_queue;
304 struct sk_buff_head data_vo_queue;
305 struct sk_buff_head tx_failed;
306 DECLARE_BITMAP(tx_slot, MAX_TX_BUF_NUM);
307 struct timer_list cleanup_timer;
308 spinlock_t tx_lock;
311 struct ath9k_htc_tx_ctl {
312 u8 type; /* ATH9K_HTC_* */
313 u8 epid;
314 u8 txok;
315 u8 sta_idx;
316 unsigned long timestamp;
319 static inline struct ath9k_htc_tx_ctl *HTC_SKB_CB(struct sk_buff *skb)
321 struct ieee80211_tx_info *tx_info = IEEE80211_SKB_CB(skb);
323 BUILD_BUG_ON(sizeof(struct ath9k_htc_tx_ctl) >
324 IEEE80211_TX_INFO_DRIVER_DATA_SIZE);
325 return (struct ath9k_htc_tx_ctl *) &tx_info->driver_data;
328 #ifdef CONFIG_ATH9K_HTC_DEBUGFS
330 #define TX_STAT_INC(c) (hif_dev->htc_handle->drv_priv->debug.tx_stats.c++)
331 #define RX_STAT_INC(c) (hif_dev->htc_handle->drv_priv->debug.rx_stats.c++)
332 #define CAB_STAT_INC priv->debug.tx_stats.cab_queued++
334 #define TX_QSTAT_INC(q) (priv->debug.tx_stats.queue_stats[q]++)
336 void ath9k_htc_err_stat_rx(struct ath9k_htc_priv *priv,
337 struct ath_htc_rx_status *rxs);
339 struct ath_tx_stats {
340 u32 buf_queued;
341 u32 buf_completed;
342 u32 skb_queued;
343 u32 skb_success;
344 u32 skb_failed;
345 u32 cab_queued;
346 u32 queue_stats[WME_NUM_AC];
349 struct ath_rx_stats {
350 u32 skb_allocated;
351 u32 skb_completed;
352 u32 skb_dropped;
353 u32 err_crc;
354 u32 err_decrypt_crc;
355 u32 err_mic;
356 u32 err_pre_delim;
357 u32 err_post_delim;
358 u32 err_decrypt_busy;
359 u32 err_phy;
360 u32 err_phy_stats[ATH9K_PHYERR_MAX];
363 struct ath9k_debug {
364 struct dentry *debugfs_phy;
365 struct ath_tx_stats tx_stats;
366 struct ath_rx_stats rx_stats;
369 #else
371 #define TX_STAT_INC(c) do { } while (0)
372 #define RX_STAT_INC(c) do { } while (0)
373 #define CAB_STAT_INC do { } while (0)
375 #define TX_QSTAT_INC(c) do { } while (0)
377 static inline void ath9k_htc_err_stat_rx(struct ath9k_htc_priv *priv,
378 struct ath_htc_rx_status *rxs)
382 #endif /* CONFIG_ATH9K_HTC_DEBUGFS */
384 #define ATH_LED_PIN_DEF 1
385 #define ATH_LED_PIN_9287 10
386 #define ATH_LED_PIN_9271 15
387 #define ATH_LED_PIN_7010 12
389 #define BSTUCK_THRESHOLD 10
392 * Adjust these when the max. no of beaconing interfaces is
393 * increased.
395 #define DEFAULT_SWBA_RESPONSE 40 /* in TUs */
396 #define MIN_SWBA_RESPONSE 10 /* in TUs */
398 struct htc_beacon_config {
399 struct ieee80211_vif *bslot[ATH9K_HTC_MAX_BCN_VIF];
400 u16 beacon_interval;
401 u16 dtim_period;
402 u16 bmiss_timeout;
403 u32 bmiss_cnt;
406 struct ath_btcoex {
407 u32 bt_priority_cnt;
408 unsigned long bt_priority_time;
409 int bt_stomp_type; /* Types of BT stomping */
410 u32 btcoex_no_stomp;
411 u32 btcoex_period;
412 u32 btscan_no_stomp;
415 void ath_htc_init_btcoex_work(struct ath9k_htc_priv *priv);
416 void ath_htc_resume_btcoex_work(struct ath9k_htc_priv *priv);
417 void ath_htc_cancel_btcoex_work(struct ath9k_htc_priv *priv);
419 #define OP_INVALID BIT(0)
420 #define OP_SCANNING BIT(1)
421 #define OP_ENABLE_BEACON BIT(2)
422 #define OP_BT_PRIORITY_DETECTED BIT(3)
423 #define OP_BT_SCAN BIT(4)
424 #define OP_ANI_RUNNING BIT(5)
425 #define OP_TSF_RESET BIT(6)
427 struct ath9k_htc_priv {
428 struct device *dev;
429 struct ieee80211_hw *hw;
430 struct ath_hw *ah;
431 struct htc_target *htc;
432 struct wmi *wmi;
434 u16 fw_version_major;
435 u16 fw_version_minor;
437 enum htc_endpoint_id wmi_cmd_ep;
438 enum htc_endpoint_id beacon_ep;
439 enum htc_endpoint_id cab_ep;
440 enum htc_endpoint_id uapsd_ep;
441 enum htc_endpoint_id mgmt_ep;
442 enum htc_endpoint_id data_be_ep;
443 enum htc_endpoint_id data_bk_ep;
444 enum htc_endpoint_id data_vi_ep;
445 enum htc_endpoint_id data_vo_ep;
447 u8 vif_slot;
448 u8 mon_vif_idx;
449 u8 sta_slot;
450 u8 vif_sta_pos[ATH9K_HTC_MAX_VIF];
451 u8 num_ibss_vif;
452 u8 num_sta_vif;
453 u8 num_ap_vif;
455 u16 op_flags;
456 u16 curtxpow;
457 u16 txpowlimit;
458 u16 nvifs;
459 u16 nstations;
460 bool rearm_ani;
461 bool reconfig_beacon;
462 unsigned int rxfilter;
464 struct ath9k_hw_cal_data caldata;
465 struct ieee80211_supported_band sbands[IEEE80211_NUM_BANDS];
467 spinlock_t beacon_lock;
468 struct htc_beacon_config cur_beacon_conf;
470 struct ath9k_htc_rx rx;
471 struct ath9k_htc_tx tx;
473 struct tasklet_struct swba_tasklet;
474 struct tasklet_struct rx_tasklet;
475 struct delayed_work ani_work;
476 struct tasklet_struct tx_failed_tasklet;
477 struct work_struct ps_work;
478 struct work_struct fatal_work;
480 struct mutex htc_pm_lock;
481 unsigned long ps_usecount;
482 bool ps_enabled;
483 bool ps_idle;
485 #ifdef CONFIG_MAC80211_LEDS
486 enum led_brightness brightness;
487 bool led_registered;
488 char led_name[32];
489 struct led_classdev led_cdev;
490 struct work_struct led_work;
491 #endif
493 int beaconq;
494 int cabq;
495 int hwq_map[WME_NUM_AC];
497 struct ath_btcoex btcoex;
498 struct delayed_work coex_period_work;
499 struct delayed_work duty_cycle_work;
500 #ifdef CONFIG_ATH9K_HTC_DEBUGFS
501 struct ath9k_debug debug;
502 #endif
503 struct mutex mutex;
506 static inline void ath_read_cachesize(struct ath_common *common, int *csz)
508 common->bus_ops->read_cachesize(common, csz);
511 void ath9k_htc_reset(struct ath9k_htc_priv *priv);
513 void ath9k_htc_assign_bslot(struct ath9k_htc_priv *priv,
514 struct ieee80211_vif *vif);
515 void ath9k_htc_remove_bslot(struct ath9k_htc_priv *priv,
516 struct ieee80211_vif *vif);
517 void ath9k_htc_set_tsfadjust(struct ath9k_htc_priv *priv,
518 struct ieee80211_vif *vif);
519 void ath9k_htc_beaconq_config(struct ath9k_htc_priv *priv);
520 void ath9k_htc_beacon_config(struct ath9k_htc_priv *priv,
521 struct ieee80211_vif *vif);
522 void ath9k_htc_beacon_reconfig(struct ath9k_htc_priv *priv);
523 void ath9k_htc_swba(struct ath9k_htc_priv *priv,
524 struct wmi_event_swba *swba);
526 void ath9k_htc_rxep(void *priv, struct sk_buff *skb,
527 enum htc_endpoint_id ep_id);
528 void ath9k_htc_txep(void *priv, struct sk_buff *skb, enum htc_endpoint_id ep_id,
529 bool txok);
530 void ath9k_htc_beaconep(void *drv_priv, struct sk_buff *skb,
531 enum htc_endpoint_id ep_id, bool txok);
533 int ath9k_htc_update_cap_target(struct ath9k_htc_priv *priv,
534 u8 enable_coex);
535 void ath9k_htc_station_work(struct work_struct *work);
536 void ath9k_htc_aggr_work(struct work_struct *work);
537 void ath9k_htc_ani_work(struct work_struct *work);
538 void ath9k_htc_start_ani(struct ath9k_htc_priv *priv);
539 void ath9k_htc_stop_ani(struct ath9k_htc_priv *priv);
541 int ath9k_tx_init(struct ath9k_htc_priv *priv);
542 int ath9k_htc_tx_start(struct ath9k_htc_priv *priv,
543 struct sk_buff *skb, u8 slot, bool is_cab);
544 void ath9k_tx_cleanup(struct ath9k_htc_priv *priv);
545 bool ath9k_htc_txq_setup(struct ath9k_htc_priv *priv, int subtype);
546 int ath9k_htc_cabq_setup(struct ath9k_htc_priv *priv);
547 int get_hw_qnum(u16 queue, int *hwq_map);
548 int ath_htc_txq_update(struct ath9k_htc_priv *priv, int qnum,
549 struct ath9k_tx_queue_info *qinfo);
550 void ath9k_htc_check_stop_queues(struct ath9k_htc_priv *priv);
551 void ath9k_htc_check_wake_queues(struct ath9k_htc_priv *priv);
552 int ath9k_htc_tx_get_slot(struct ath9k_htc_priv *priv);
553 void ath9k_htc_tx_clear_slot(struct ath9k_htc_priv *priv, int slot);
554 void ath9k_htc_tx_drain(struct ath9k_htc_priv *priv);
555 void ath9k_htc_txstatus(struct ath9k_htc_priv *priv, void *wmi_event);
556 void ath9k_htc_tx_failed(struct ath9k_htc_priv *priv);
557 void ath9k_tx_failed_tasklet(unsigned long data);
558 void ath9k_htc_tx_cleanup_timer(unsigned long data);
560 int ath9k_rx_init(struct ath9k_htc_priv *priv);
561 void ath9k_rx_cleanup(struct ath9k_htc_priv *priv);
562 void ath9k_host_rx_init(struct ath9k_htc_priv *priv);
563 void ath9k_rx_tasklet(unsigned long data);
564 u32 ath9k_htc_calcrxfilter(struct ath9k_htc_priv *priv);
566 void ath9k_htc_ps_wakeup(struct ath9k_htc_priv *priv);
567 void ath9k_htc_ps_restore(struct ath9k_htc_priv *priv);
568 void ath9k_ps_work(struct work_struct *work);
569 bool ath9k_htc_setpower(struct ath9k_htc_priv *priv,
570 enum ath9k_power_mode mode);
572 void ath9k_start_rfkill_poll(struct ath9k_htc_priv *priv);
573 void ath9k_htc_rfkill_poll_state(struct ieee80211_hw *hw);
574 void ath9k_htc_radio_enable(struct ieee80211_hw *hw);
575 void ath9k_htc_radio_disable(struct ieee80211_hw *hw);
577 #ifdef CONFIG_MAC80211_LEDS
578 void ath9k_init_leds(struct ath9k_htc_priv *priv);
579 void ath9k_deinit_leds(struct ath9k_htc_priv *priv);
580 void ath9k_led_work(struct work_struct *work);
581 #else
582 static inline void ath9k_init_leds(struct ath9k_htc_priv *priv)
586 static inline void ath9k_deinit_leds(struct ath9k_htc_priv *priv)
590 static inline void ath9k_led_work(struct work_struct *work)
593 #endif
595 int ath9k_htc_probe_device(struct htc_target *htc_handle, struct device *dev,
596 u16 devid, char *product, u32 drv_info);
597 void ath9k_htc_disconnect_device(struct htc_target *htc_handle, bool hotunplug);
598 #ifdef CONFIG_PM
599 void ath9k_htc_suspend(struct htc_target *htc_handle);
600 int ath9k_htc_resume(struct htc_target *htc_handle);
601 #endif
602 #ifdef CONFIG_ATH9K_HTC_DEBUGFS
603 int ath9k_htc_init_debug(struct ath_hw *ah);
604 #else
605 static inline int ath9k_htc_init_debug(struct ath_hw *ah) { return 0; };
606 #endif /* CONFIG_ATH9K_HTC_DEBUGFS */
608 #endif /* HTC_H */