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