xref: /openbmc/linux/drivers/net/wireless/ath/ath9k/debug.h (revision 840ef8b7cc584a23c4f9d05352f4dbaf8e56e5ab)
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 "rc.h"
22 #include "dfs_debug.h"
23 
24 struct ath_txq;
25 struct ath_buf;
26 struct fft_sample_tlv;
27 
28 #ifdef CONFIG_ATH9K_DEBUGFS
29 #define TX_STAT_INC(q, c) sc->debug.stats.txstats[q].c++
30 #define RESET_STAT_INC(sc, type) sc->debug.stats.reset[type]++
31 #else
32 #define TX_STAT_INC(q, c) do { } while (0)
33 #define RESET_STAT_INC(sc, type) do { } while (0)
34 #endif
35 
36 enum ath_reset_type {
37 	RESET_TYPE_BB_HANG,
38 	RESET_TYPE_BB_WATCHDOG,
39 	RESET_TYPE_FATAL_INT,
40 	RESET_TYPE_TX_ERROR,
41 	RESET_TYPE_TX_HANG,
42 	RESET_TYPE_PLL_HANG,
43 	RESET_TYPE_MAC_HANG,
44 	RESET_TYPE_BEACON_STUCK,
45 	RESET_TYPE_MCI,
46 	__RESET_TYPE_MAX
47 };
48 
49 #ifdef CONFIG_ATH9K_DEBUGFS
50 
51 /**
52  * struct ath_interrupt_stats - Contains statistics about interrupts
53  * @total: Total no. of interrupts generated so far
54  * @rxok: RX with no errors
55  * @rxlp: RX with low priority RX
56  * @rxhp: RX with high priority, uapsd only
57  * @rxeol: RX with no more RXDESC available
58  * @rxorn: RX FIFO overrun
59  * @txok: TX completed at the requested rate
60  * @txurn: TX FIFO underrun
61  * @mib: MIB regs reaching its threshold
62  * @rxphyerr: RX with phy errors
63  * @rx_keycache_miss: RX with key cache misses
64  * @swba: Software Beacon Alert
65  * @bmiss: Beacon Miss
66  * @bnr: Beacon Not Ready
67  * @cst: Carrier Sense TImeout
68  * @gtt: Global TX Timeout
69  * @tim: RX beacon TIM occurrence
70  * @cabend: RX End of CAB traffic
71  * @dtimsync: DTIM sync lossage
72  * @dtim: RX Beacon with DTIM
73  * @bb_watchdog: Baseband watchdog
74  * @tsfoor: TSF out of range, indicates that the corrected TSF received
75  * from a beacon differs from the PCU's internal TSF by more than a
76  * (programmable) threshold
77  * @local_timeout: Internal bus timeout.
78  * @mci: MCI interrupt, specific to MCI based BTCOEX chipsets
79  * @gen_timer: Generic hardware timer interrupt
80  */
81 struct ath_interrupt_stats {
82 	u32 total;
83 	u32 rxok;
84 	u32 rxlp;
85 	u32 rxhp;
86 	u32 rxeol;
87 	u32 rxorn;
88 	u32 txok;
89 	u32 txeol;
90 	u32 txurn;
91 	u32 mib;
92 	u32 rxphyerr;
93 	u32 rx_keycache_miss;
94 	u32 swba;
95 	u32 bmiss;
96 	u32 bnr;
97 	u32 cst;
98 	u32 gtt;
99 	u32 tim;
100 	u32 cabend;
101 	u32 dtimsync;
102 	u32 dtim;
103 	u32 bb_watchdog;
104 	u32 tsfoor;
105 	u32 mci;
106 	u32 gen_timer;
107 
108 	/* Sync-cause stats */
109 	u32 sync_cause_all;
110 	u32 sync_rtc_irq;
111 	u32 sync_mac_irq;
112 	u32 eeprom_illegal_access;
113 	u32 apb_timeout;
114 	u32 pci_mode_conflict;
115 	u32 host1_fatal;
116 	u32 host1_perr;
117 	u32 trcv_fifo_perr;
118 	u32 radm_cpl_ep;
119 	u32 radm_cpl_dllp_abort;
120 	u32 radm_cpl_tlp_abort;
121 	u32 radm_cpl_ecrc_err;
122 	u32 radm_cpl_timeout;
123 	u32 local_timeout;
124 	u32 pm_access;
125 	u32 mac_awake;
126 	u32 mac_asleep;
127 	u32 mac_sleep_access;
128 };
129 
130 
131 /**
132  * struct ath_tx_stats - Statistics about TX
133  * @tx_pkts_all:  No. of total frames transmitted, including ones that
134 	may have had errors.
135  * @tx_bytes_all:  No. of total bytes transmitted, including ones that
136 	may have had errors.
137  * @queued: Total MPDUs (non-aggr) queued
138  * @completed: Total MPDUs (non-aggr) completed
139  * @a_aggr: Total no. of aggregates queued
140  * @a_queued_hw: Total AMPDUs queued to hardware
141  * @a_queued_sw: Total AMPDUs queued to software queues
142  * @a_completed: Total AMPDUs completed
143  * @a_retries: No. of AMPDUs retried (SW)
144  * @a_xretries: No. of AMPDUs dropped due to xretries
145  * @fifo_underrun: FIFO underrun occurrences
146 	Valid only for:
147 		- non-aggregate condition.
148 		- first packet of aggregate.
149  * @xtxop: No. of frames filtered because of TXOP limit
150  * @timer_exp: Transmit timer expiry
151  * @desc_cfg_err: Descriptor configuration errors
152  * @data_urn: TX data underrun errors
153  * @delim_urn: TX delimiter underrun errors
154  * @puttxbuf: Number of times hardware was given txbuf to write.
155  * @txstart:  Number of times hardware was told to start tx.
156  * @txprocdesc:  Number of times tx descriptor was processed
157  * @txfailed:  Out-of-memory or other errors in xmit path.
158  */
159 struct ath_tx_stats {
160 	u32 tx_pkts_all;
161 	u32 tx_bytes_all;
162 	u32 queued;
163 	u32 completed;
164 	u32 xretries;
165 	u32 a_aggr;
166 	u32 a_queued_hw;
167 	u32 a_queued_sw;
168 	u32 a_completed;
169 	u32 a_retries;
170 	u32 a_xretries;
171 	u32 fifo_underrun;
172 	u32 xtxop;
173 	u32 timer_exp;
174 	u32 desc_cfg_err;
175 	u32 data_underrun;
176 	u32 delim_underrun;
177 	u32 puttxbuf;
178 	u32 txstart;
179 	u32 txprocdesc;
180 	u32 txfailed;
181 };
182 
183 /*
184  * Various utility macros to print TX/Queue counters.
185  */
186 #define PR_QNUM(_n) sc->tx.txq_map[_n]->axq_qnum
187 #define TXSTATS sc->debug.stats.txstats
188 #define PR(str, elem)							\
189 	do {								\
190 		len += snprintf(buf + len, size - len,			\
191 				"%s%13u%11u%10u%10u\n", str,		\
192 				TXSTATS[PR_QNUM(IEEE80211_AC_BE)].elem,	\
193 				TXSTATS[PR_QNUM(IEEE80211_AC_BK)].elem,	\
194 				TXSTATS[PR_QNUM(IEEE80211_AC_VI)].elem,	\
195 				TXSTATS[PR_QNUM(IEEE80211_AC_VO)].elem); \
196 	} while(0)
197 
198 #define RX_STAT_INC(c) (sc->debug.stats.rxstats.c++)
199 
200 /**
201  * struct ath_rx_stats - RX Statistics
202  * @rx_pkts_all:  No. of total frames received, including ones that
203 	may have had errors.
204  * @rx_bytes_all:  No. of total bytes received, including ones that
205 	may have had errors.
206  * @crc_err: No. of frames with incorrect CRC value
207  * @decrypt_crc_err: No. of frames whose CRC check failed after
208 	decryption process completed
209  * @phy_err: No. of frames whose reception failed because the PHY
210 	encountered an error
211  * @mic_err: No. of frames with incorrect TKIP MIC verification failure
212  * @pre_delim_crc_err: Pre-Frame delimiter CRC error detections
213  * @post_delim_crc_err: Post-Frame delimiter CRC error detections
214  * @decrypt_busy_err: Decryption interruptions counter
215  * @phy_err_stats: Individual PHY error statistics
216  * @rx_len_err:  No. of frames discarded due to bad length.
217  * @rx_oom_err:  No. of frames dropped due to OOM issues.
218  * @rx_rate_err:  No. of frames dropped due to rate errors.
219  * @rx_too_many_frags_err:  Frames dropped due to too-many-frags received.
220  * @rx_beacons:  No. of beacons received.
221  * @rx_frags:  No. of rx-fragements received.
222  * @rx_spectral: No of spectral packets received.
223  */
224 struct ath_rx_stats {
225 	u32 rx_pkts_all;
226 	u32 rx_bytes_all;
227 	u32 crc_err;
228 	u32 decrypt_crc_err;
229 	u32 phy_err;
230 	u32 mic_err;
231 	u32 pre_delim_crc_err;
232 	u32 post_delim_crc_err;
233 	u32 decrypt_busy_err;
234 	u32 phy_err_stats[ATH9K_PHYERR_MAX];
235 	u32 rx_len_err;
236 	u32 rx_oom_err;
237 	u32 rx_rate_err;
238 	u32 rx_too_many_frags_err;
239 	u32 rx_beacons;
240 	u32 rx_frags;
241 	u32 rx_spectral;
242 };
243 
244 struct ath_stats {
245 	struct ath_interrupt_stats istats;
246 	struct ath_tx_stats txstats[ATH9K_NUM_TX_QUEUES];
247 	struct ath_rx_stats rxstats;
248 	struct ath_dfs_stats dfs_stats;
249 	u32 reset[__RESET_TYPE_MAX];
250 };
251 
252 #define ATH_DBG_MAX_SAMPLES	10
253 struct ath_dbg_bb_mac_samp {
254 	u32 dma_dbg_reg_vals[ATH9K_NUM_DMA_DEBUG_REGS];
255 	u32 pcu_obs, pcu_cr, noise;
256 	struct {
257 		u64 jiffies;
258 		int8_t rssi_ctl0;
259 		int8_t rssi_ctl1;
260 		int8_t rssi_ctl2;
261 		int8_t rssi_ext0;
262 		int8_t rssi_ext1;
263 		int8_t rssi_ext2;
264 		int8_t rssi;
265 		bool isok;
266 		u8 rts_fail_cnt;
267 		u8 data_fail_cnt;
268 		u8 rateindex;
269 		u8 qid;
270 		u8 tid;
271 		u32 ba_low;
272 		u32 ba_high;
273 	} ts[ATH_DBG_MAX_SAMPLES];
274 	struct {
275 		u64 jiffies;
276 		int8_t rssi_ctl0;
277 		int8_t rssi_ctl1;
278 		int8_t rssi_ctl2;
279 		int8_t rssi_ext0;
280 		int8_t rssi_ext1;
281 		int8_t rssi_ext2;
282 		int8_t rssi;
283 		bool is_mybeacon;
284 		u8 antenna;
285 		u8 rate;
286 	} rs[ATH_DBG_MAX_SAMPLES];
287 	struct ath_cycle_counters cc;
288 	struct ath9k_nfcal_hist nfCalHist[NUM_NF_READINGS];
289 };
290 
291 struct ath9k_debug {
292 	struct dentry *debugfs_phy;
293 	u32 regidx;
294 	struct ath_stats stats;
295 #ifdef CONFIG_ATH9K_MAC_DEBUG
296 	spinlock_t samp_lock;
297 	struct ath_dbg_bb_mac_samp bb_mac_samp[ATH_DBG_MAX_SAMPLES];
298 	u8 sampidx;
299 	u8 tsidx;
300 	u8 rsidx;
301 #endif
302 };
303 
304 int ath9k_init_debug(struct ath_hw *ah);
305 
306 void ath_debug_stat_interrupt(struct ath_softc *sc, enum ath9k_int status);
307 void ath_debug_stat_tx(struct ath_softc *sc, struct ath_buf *bf,
308 		       struct ath_tx_status *ts, struct ath_txq *txq,
309 		       unsigned int flags);
310 void ath_debug_stat_rx(struct ath_softc *sc, struct ath_rx_status *rs);
311 int ath9k_get_et_sset_count(struct ieee80211_hw *hw,
312 			    struct ieee80211_vif *vif, int sset);
313 void ath9k_get_et_stats(struct ieee80211_hw *hw,
314 			struct ieee80211_vif *vif,
315 			struct ethtool_stats *stats, u64 *data);
316 void ath9k_get_et_strings(struct ieee80211_hw *hw,
317 			  struct ieee80211_vif *vif,
318 			  u32 sset, u8 *data);
319 void ath9k_sta_add_debugfs(struct ieee80211_hw *hw,
320 			   struct ieee80211_vif *vif,
321 			   struct ieee80211_sta *sta,
322 			   struct dentry *dir);
323 void ath9k_sta_remove_debugfs(struct ieee80211_hw *hw,
324 			      struct ieee80211_vif *vif,
325 			      struct ieee80211_sta *sta,
326 			      struct dentry *dir);
327 
328 void ath_debug_send_fft_sample(struct ath_softc *sc,
329 			       struct fft_sample_tlv *fft_sample);
330 
331 #else
332 
333 #define RX_STAT_INC(c) /* NOP */
334 
335 static inline int ath9k_init_debug(struct ath_hw *ah)
336 {
337 	return 0;
338 }
339 
340 static inline void ath_debug_stat_interrupt(struct ath_softc *sc,
341 					    enum ath9k_int status)
342 {
343 }
344 
345 static inline void ath_debug_stat_tx(struct ath_softc *sc,
346 				     struct ath_buf *bf,
347 				     struct ath_tx_status *ts,
348 				     struct ath_txq *txq,
349 				     unsigned int flags)
350 {
351 }
352 
353 static inline void ath_debug_stat_rx(struct ath_softc *sc,
354 				     struct ath_rx_status *rs)
355 {
356 }
357 
358 #endif /* CONFIG_ATH9K_DEBUGFS */
359 
360 #ifdef CONFIG_ATH9K_MAC_DEBUG
361 
362 void ath9k_debug_samp_bb_mac(struct ath_softc *sc);
363 
364 #else
365 
366 static inline void ath9k_debug_samp_bb_mac(struct ath_softc *sc)
367 {
368 }
369 
370 #endif
371 
372 
373 #endif /* DEBUG_H */
374