Linux-libre 3.16.85-gnu
[librecmc/linux-libre.git] / drivers / net / wireless / ath / ath9k / debug.h
1 /*
2  * Copyright (c) 2008-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 DEBUG_H
18 #define DEBUG_H
19
20 #include "hw.h"
21 #include "dfs_debug.h"
22
23 struct ath_txq;
24 struct ath_buf;
25 struct fft_sample_tlv;
26
27 #ifdef CONFIG_ATH9K_DEBUGFS
28 #define TX_STAT_INC(q, c) sc->debug.stats.txstats[q].c++
29 #define RX_STAT_INC(c) (sc->debug.stats.rxstats.c++)
30 #define RESET_STAT_INC(sc, type) sc->debug.stats.reset[type]++
31 #define ANT_STAT_INC(i, c) sc->debug.stats.ant_stats[i].c++
32 #define ANT_LNA_INC(i, c) sc->debug.stats.ant_stats[i].lna_recv_cnt[c]++;
33 #else
34 #define TX_STAT_INC(q, c) do { } while (0)
35 #define RX_STAT_INC(c)
36 #define RESET_STAT_INC(sc, type) do { } while (0)
37 #define ANT_STAT_INC(i, c) do { } while (0)
38 #define ANT_LNA_INC(i, c) do { } while (0)
39 #endif
40
41 enum ath_reset_type {
42         RESET_TYPE_BB_HANG,
43         RESET_TYPE_BB_WATCHDOG,
44         RESET_TYPE_FATAL_INT,
45         RESET_TYPE_TX_ERROR,
46         RESET_TYPE_TX_GTT,
47         RESET_TYPE_TX_HANG,
48         RESET_TYPE_PLL_HANG,
49         RESET_TYPE_MAC_HANG,
50         RESET_TYPE_BEACON_STUCK,
51         RESET_TYPE_MCI,
52         __RESET_TYPE_MAX
53 };
54
55 #ifdef CONFIG_ATH9K_DEBUGFS
56
57 /**
58  * struct ath_interrupt_stats - Contains statistics about interrupts
59  * @total: Total no. of interrupts generated so far
60  * @rxok: RX with no errors
61  * @rxlp: RX with low priority RX
62  * @rxhp: RX with high priority, uapsd only
63  * @rxeol: RX with no more RXDESC available
64  * @rxorn: RX FIFO overrun
65  * @txok: TX completed at the requested rate
66  * @txurn: TX FIFO underrun
67  * @mib: MIB regs reaching its threshold
68  * @rxphyerr: RX with phy errors
69  * @rx_keycache_miss: RX with key cache misses
70  * @swba: Software Beacon Alert
71  * @bmiss: Beacon Miss
72  * @bnr: Beacon Not Ready
73  * @cst: Carrier Sense TImeout
74  * @gtt: Global TX Timeout
75  * @tim: RX beacon TIM occurrence
76  * @cabend: RX End of CAB traffic
77  * @dtimsync: DTIM sync lossage
78  * @dtim: RX Beacon with DTIM
79  * @bb_watchdog: Baseband watchdog
80  * @tsfoor: TSF out of range, indicates that the corrected TSF received
81  * from a beacon differs from the PCU's internal TSF by more than a
82  * (programmable) threshold
83  * @local_timeout: Internal bus timeout.
84  * @mci: MCI interrupt, specific to MCI based BTCOEX chipsets
85  * @gen_timer: Generic hardware timer interrupt
86  */
87 struct ath_interrupt_stats {
88         u32 total;
89         u32 rxok;
90         u32 rxlp;
91         u32 rxhp;
92         u32 rxeol;
93         u32 rxorn;
94         u32 txok;
95         u32 txeol;
96         u32 txurn;
97         u32 mib;
98         u32 rxphyerr;
99         u32 rx_keycache_miss;
100         u32 swba;
101         u32 bmiss;
102         u32 bnr;
103         u32 cst;
104         u32 gtt;
105         u32 tim;
106         u32 cabend;
107         u32 dtimsync;
108         u32 dtim;
109         u32 bb_watchdog;
110         u32 tsfoor;
111         u32 mci;
112         u32 gen_timer;
113
114         /* Sync-cause stats */
115         u32 sync_cause_all;
116         u32 sync_rtc_irq;
117         u32 sync_mac_irq;
118         u32 eeprom_illegal_access;
119         u32 apb_timeout;
120         u32 pci_mode_conflict;
121         u32 host1_fatal;
122         u32 host1_perr;
123         u32 trcv_fifo_perr;
124         u32 radm_cpl_ep;
125         u32 radm_cpl_dllp_abort;
126         u32 radm_cpl_tlp_abort;
127         u32 radm_cpl_ecrc_err;
128         u32 radm_cpl_timeout;
129         u32 local_timeout;
130         u32 pm_access;
131         u32 mac_awake;
132         u32 mac_asleep;
133         u32 mac_sleep_access;
134 };
135
136
137 /**
138  * struct ath_tx_stats - Statistics about TX
139  * @tx_pkts_all:  No. of total frames transmitted, including ones that
140         may have had errors.
141  * @tx_bytes_all:  No. of total bytes transmitted, including ones that
142         may have had errors.
143  * @queued: Total MPDUs (non-aggr) queued
144  * @completed: Total MPDUs (non-aggr) completed
145  * @a_aggr: Total no. of aggregates queued
146  * @a_queued_hw: Total AMPDUs queued to hardware
147  * @a_queued_sw: Total AMPDUs queued to software queues
148  * @a_completed: Total AMPDUs completed
149  * @a_retries: No. of AMPDUs retried (SW)
150  * @a_xretries: No. of AMPDUs dropped due to xretries
151  * @txerr_filtered: No. of frames with TXERR_FILT flag set.
152  * @fifo_underrun: FIFO underrun occurrences
153         Valid only for:
154                 - non-aggregate condition.
155                 - first packet of aggregate.
156  * @xtxop: No. of frames filtered because of TXOP limit
157  * @timer_exp: Transmit timer expiry
158  * @desc_cfg_err: Descriptor configuration errors
159  * @data_urn: TX data underrun errors
160  * @delim_urn: TX delimiter underrun errors
161  * @puttxbuf: Number of times hardware was given txbuf to write.
162  * @txstart:  Number of times hardware was told to start tx.
163  * @txprocdesc:  Number of times tx descriptor was processed
164  * @txfailed:  Out-of-memory or other errors in xmit path.
165  */
166 struct ath_tx_stats {
167         u32 tx_pkts_all;
168         u32 tx_bytes_all;
169         u32 queued;
170         u32 completed;
171         u32 xretries;
172         u32 a_aggr;
173         u32 a_queued_hw;
174         u32 a_queued_sw;
175         u32 a_completed;
176         u32 a_retries;
177         u32 a_xretries;
178         u32 txerr_filtered;
179         u32 fifo_underrun;
180         u32 xtxop;
181         u32 timer_exp;
182         u32 desc_cfg_err;
183         u32 data_underrun;
184         u32 delim_underrun;
185         u32 puttxbuf;
186         u32 txstart;
187         u32 txprocdesc;
188         u32 txfailed;
189 };
190
191 /*
192  * Various utility macros to print TX/Queue counters.
193  */
194 #define PR_QNUM(_n) sc->tx.txq_map[_n]->axq_qnum
195 #define TXSTATS sc->debug.stats.txstats
196 #define PR(str, elem)                                                   \
197         do {                                                            \
198                 len += scnprintf(buf + len, size - len,                 \
199                                  "%s%13u%11u%10u%10u\n", str,           \
200                                  TXSTATS[PR_QNUM(IEEE80211_AC_BE)].elem,\
201                                  TXSTATS[PR_QNUM(IEEE80211_AC_BK)].elem,\
202                                  TXSTATS[PR_QNUM(IEEE80211_AC_VI)].elem,\
203                                  TXSTATS[PR_QNUM(IEEE80211_AC_VO)].elem); \
204         } while(0)
205
206 struct ath_rx_rate_stats {
207         struct {
208                 u32 ht20_cnt;
209                 u32 ht40_cnt;
210                 u32 sgi_cnt;
211                 u32 lgi_cnt;
212         } ht_stats[24];
213
214         struct {
215                 u32 ofdm_cnt;
216         } ofdm_stats[8];
217
218         struct {
219                 u32 cck_lp_cnt;
220                 u32 cck_sp_cnt;
221         } cck_stats[4];
222 };
223
224 #define ANT_MAIN 0
225 #define ANT_ALT  1
226
227 struct ath_antenna_stats {
228         u32 recv_cnt;
229         u32 rssi_avg;
230         u32 lna_recv_cnt[4];
231         u32 lna_attempt_cnt[4];
232 };
233
234 struct ath_stats {
235         struct ath_interrupt_stats istats;
236         struct ath_tx_stats txstats[ATH9K_NUM_TX_QUEUES];
237         struct ath_rx_stats rxstats;
238         struct ath_dfs_stats dfs_stats;
239         struct ath_antenna_stats ant_stats[2];
240         u32 reset[__RESET_TYPE_MAX];
241 };
242
243 struct ath9k_debug {
244         struct dentry *debugfs_phy;
245         u32 regidx;
246         struct ath_stats stats;
247 };
248
249 int ath9k_init_debug(struct ath_hw *ah);
250 void ath9k_deinit_debug(struct ath_softc *sc);
251
252 void ath_debug_stat_interrupt(struct ath_softc *sc, enum ath9k_int status);
253 void ath_debug_stat_tx(struct ath_softc *sc, struct ath_buf *bf,
254                        struct ath_tx_status *ts, struct ath_txq *txq,
255                        unsigned int flags);
256 void ath_debug_stat_rx(struct ath_softc *sc, struct ath_rx_status *rs);
257 int ath9k_get_et_sset_count(struct ieee80211_hw *hw,
258                             struct ieee80211_vif *vif, int sset);
259 void ath9k_get_et_stats(struct ieee80211_hw *hw,
260                         struct ieee80211_vif *vif,
261                         struct ethtool_stats *stats, u64 *data);
262 void ath9k_get_et_strings(struct ieee80211_hw *hw,
263                           struct ieee80211_vif *vif,
264                           u32 sset, u8 *data);
265 void ath9k_sta_add_debugfs(struct ieee80211_hw *hw,
266                            struct ieee80211_vif *vif,
267                            struct ieee80211_sta *sta,
268                            struct dentry *dir);
269 void ath9k_debug_stat_ant(struct ath_softc *sc,
270                           struct ath_hw_antcomb_conf *div_ant_conf,
271                           int main_rssi_avg, int alt_rssi_avg);
272 void ath9k_debug_sync_cause(struct ath_softc *sc, u32 sync_cause);
273
274 #else
275
276 static inline int ath9k_init_debug(struct ath_hw *ah)
277 {
278         return 0;
279 }
280
281 static inline void ath9k_deinit_debug(struct ath_softc *sc)
282 {
283 }
284 static inline void ath_debug_stat_interrupt(struct ath_softc *sc,
285                                             enum ath9k_int status)
286 {
287 }
288 static inline void ath_debug_stat_tx(struct ath_softc *sc,
289                                      struct ath_buf *bf,
290                                      struct ath_tx_status *ts,
291                                      struct ath_txq *txq,
292                                      unsigned int flags)
293 {
294 }
295 static inline void ath_debug_stat_rx(struct ath_softc *sc,
296                                      struct ath_rx_status *rs)
297 {
298 }
299 static inline void ath9k_debug_stat_ant(struct ath_softc *sc,
300                                         struct ath_hw_antcomb_conf *div_ant_conf,
301                                         int main_rssi_avg, int alt_rssi_avg)
302 {
303
304 }
305
306 static inline void
307 ath9k_debug_sync_cause(struct ath_softc *sc, u32 sync_cause)
308 {
309 }
310
311 #endif /* CONFIG_ATH9K_DEBUGFS */
312
313 #ifdef CONFIG_ATH9K_STATION_STATISTICS
314 void ath_debug_rate_stats(struct ath_softc *sc,
315                           struct ath_rx_status *rs,
316                           struct sk_buff *skb);
317 #else
318 static inline void ath_debug_rate_stats(struct ath_softc *sc,
319                                         struct ath_rx_status *rs,
320                                         struct sk_buff *skb)
321 {
322 }
323 #endif /* CONFIG_ATH9K_STATION_STATISTICS */
324
325 #endif /* DEBUG_H */