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