xref: /openbmc/linux/drivers/net/wireless/ath/ath10k/debug.h (revision 9dae47aba0a055f761176d9297371d5bb24289ec)
1 /*
2  * Copyright (c) 2005-2011 Atheros Communications Inc.
3  * Copyright (c) 2011-2013 Qualcomm Atheros, Inc.
4  *
5  * Permission to use, copy, modify, and/or distribute this software for any
6  * purpose with or without fee is hereby granted, provided that the above
7  * copyright notice and this permission notice appear in all copies.
8  *
9  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16  */
17 
18 #ifndef _DEBUG_H_
19 #define _DEBUG_H_
20 
21 #include <linux/types.h>
22 #include "trace.h"
23 
24 enum ath10k_debug_mask {
25 	ATH10K_DBG_PCI		= 0x00000001,
26 	ATH10K_DBG_WMI		= 0x00000002,
27 	ATH10K_DBG_HTC		= 0x00000004,
28 	ATH10K_DBG_HTT		= 0x00000008,
29 	ATH10K_DBG_MAC		= 0x00000010,
30 	ATH10K_DBG_BOOT		= 0x00000020,
31 	ATH10K_DBG_PCI_DUMP	= 0x00000040,
32 	ATH10K_DBG_HTT_DUMP	= 0x00000080,
33 	ATH10K_DBG_MGMT		= 0x00000100,
34 	ATH10K_DBG_DATA		= 0x00000200,
35 	ATH10K_DBG_BMI		= 0x00000400,
36 	ATH10K_DBG_REGULATORY	= 0x00000800,
37 	ATH10K_DBG_TESTMODE	= 0x00001000,
38 	ATH10K_DBG_WMI_PRINT	= 0x00002000,
39 	ATH10K_DBG_PCI_PS	= 0x00004000,
40 	ATH10K_DBG_AHB		= 0x00008000,
41 	ATH10K_DBG_SDIO		= 0x00010000,
42 	ATH10K_DBG_SDIO_DUMP	= 0x00020000,
43 	ATH10K_DBG_USB		= 0x00040000,
44 	ATH10K_DBG_USB_BULK	= 0x00080000,
45 	ATH10K_DBG_ANY		= 0xffffffff,
46 };
47 
48 enum ath10k_pktlog_filter {
49 	ATH10K_PKTLOG_RX         = 0x000000001,
50 	ATH10K_PKTLOG_TX         = 0x000000002,
51 	ATH10K_PKTLOG_RCFIND     = 0x000000004,
52 	ATH10K_PKTLOG_RCUPDATE   = 0x000000008,
53 	ATH10K_PKTLOG_DBG_PRINT  = 0x000000010,
54 	ATH10K_PKTLOG_PEER_STATS = 0x000000040,
55 	ATH10K_PKTLOG_ANY        = 0x00000005f,
56 };
57 
58 enum ath10k_dbg_aggr_mode {
59 	ATH10K_DBG_AGGR_MODE_AUTO,
60 	ATH10K_DBG_AGGR_MODE_MANUAL,
61 	ATH10K_DBG_AGGR_MODE_MAX,
62 };
63 
64 /* Types of packet log events */
65 enum ath_pktlog_type {
66 	ATH_PKTLOG_TYPE_TX_CTRL = 1,
67 	ATH_PKTLOG_TYPE_TX_STAT,
68 };
69 
70 struct ath10k_pktlog_hdr {
71 	__le16 flags;
72 	__le16 missed_cnt;
73 	__le16 log_type; /* Type of log information foll this header */
74 	__le16 size; /* Size of variable length log information in bytes */
75 	__le32 timestamp;
76 	u8 payload[0];
77 } __packed;
78 
79 /* FIXME: How to calculate the buffer size sanely? */
80 #define ATH10K_FW_STATS_BUF_SIZE (1024 * 1024)
81 
82 extern unsigned int ath10k_debug_mask;
83 
84 __printf(2, 3) void ath10k_info(struct ath10k *ar, const char *fmt, ...);
85 __printf(2, 3) void ath10k_err(struct ath10k *ar, const char *fmt, ...);
86 __printf(2, 3) void ath10k_warn(struct ath10k *ar, const char *fmt, ...);
87 
88 void ath10k_debug_print_hwfw_info(struct ath10k *ar);
89 void ath10k_debug_print_board_info(struct ath10k *ar);
90 void ath10k_debug_print_boot_info(struct ath10k *ar);
91 void ath10k_print_driver_info(struct ath10k *ar);
92 
93 #ifdef CONFIG_ATH10K_DEBUGFS
94 int ath10k_debug_start(struct ath10k *ar);
95 void ath10k_debug_stop(struct ath10k *ar);
96 int ath10k_debug_create(struct ath10k *ar);
97 void ath10k_debug_destroy(struct ath10k *ar);
98 int ath10k_debug_register(struct ath10k *ar);
99 void ath10k_debug_unregister(struct ath10k *ar);
100 void ath10k_debug_fw_stats_process(struct ath10k *ar, struct sk_buff *skb);
101 void ath10k_debug_tpc_stats_process(struct ath10k *ar,
102 				    struct ath10k_tpc_stats *tpc_stats);
103 struct ath10k_fw_crash_data *
104 ath10k_debug_get_new_fw_crash_data(struct ath10k *ar);
105 
106 void ath10k_debug_dbglog_add(struct ath10k *ar, u8 *buffer, int len);
107 
108 int ath10k_debug_fw_devcoredump(struct ath10k *ar);
109 
110 #define ATH10K_DFS_STAT_INC(ar, c) (ar->debug.dfs_stats.c++)
111 
112 void ath10k_debug_get_et_strings(struct ieee80211_hw *hw,
113 				 struct ieee80211_vif *vif,
114 				 u32 sset, u8 *data);
115 int ath10k_debug_get_et_sset_count(struct ieee80211_hw *hw,
116 				   struct ieee80211_vif *vif, int sset);
117 void ath10k_debug_get_et_stats(struct ieee80211_hw *hw,
118 			       struct ieee80211_vif *vif,
119 			       struct ethtool_stats *stats, u64 *data);
120 
121 static inline u64 ath10k_debug_get_fw_dbglog_mask(struct ath10k *ar)
122 {
123 	return ar->debug.fw_dbglog_mask;
124 }
125 
126 static inline u32 ath10k_debug_get_fw_dbglog_level(struct ath10k *ar)
127 {
128 	return ar->debug.fw_dbglog_level;
129 }
130 
131 #else
132 
133 static inline int ath10k_debug_start(struct ath10k *ar)
134 {
135 	return 0;
136 }
137 
138 static inline void ath10k_debug_stop(struct ath10k *ar)
139 {
140 }
141 
142 static inline int ath10k_debug_create(struct ath10k *ar)
143 {
144 	return 0;
145 }
146 
147 static inline void ath10k_debug_destroy(struct ath10k *ar)
148 {
149 }
150 
151 static inline int ath10k_debug_register(struct ath10k *ar)
152 {
153 	return 0;
154 }
155 
156 static inline void ath10k_debug_unregister(struct ath10k *ar)
157 {
158 }
159 
160 static inline void ath10k_debug_fw_stats_process(struct ath10k *ar,
161 						 struct sk_buff *skb)
162 {
163 }
164 
165 static inline void ath10k_debug_tpc_stats_process(struct ath10k *ar,
166 						  struct ath10k_tpc_stats *tpc_stats)
167 {
168 	kfree(tpc_stats);
169 }
170 
171 static inline void ath10k_debug_dbglog_add(struct ath10k *ar, u8 *buffer,
172 					   int len)
173 {
174 }
175 
176 static inline struct ath10k_fw_crash_data *
177 ath10k_debug_get_new_fw_crash_data(struct ath10k *ar)
178 {
179 	return NULL;
180 }
181 
182 static inline u64 ath10k_debug_get_fw_dbglog_mask(struct ath10k *ar)
183 {
184 	return 0;
185 }
186 
187 static inline u32 ath10k_debug_get_fw_dbglog_level(struct ath10k *ar)
188 {
189 	return 0;
190 }
191 
192 static inline int ath10k_debug_fw_devcoredump(struct ath10k *ar)
193 {
194 	return 0;
195 }
196 
197 #define ATH10K_DFS_STAT_INC(ar, c) do { } while (0)
198 
199 #define ath10k_debug_get_et_strings NULL
200 #define ath10k_debug_get_et_sset_count NULL
201 #define ath10k_debug_get_et_stats NULL
202 
203 #endif /* CONFIG_ATH10K_DEBUGFS */
204 #ifdef CONFIG_MAC80211_DEBUGFS
205 void ath10k_sta_add_debugfs(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
206 			    struct ieee80211_sta *sta, struct dentry *dir);
207 void ath10k_sta_update_rx_duration(struct ath10k *ar,
208 				   struct ath10k_fw_stats *stats);
209 #else
210 static inline
211 void ath10k_sta_update_rx_duration(struct ath10k *ar,
212 				   struct ath10k_fw_stats *stats)
213 {
214 }
215 #endif /* CONFIG_MAC80211_DEBUGFS */
216 
217 #ifdef CONFIG_ATH10K_DEBUG
218 __printf(3, 4) void ath10k_dbg(struct ath10k *ar,
219 			       enum ath10k_debug_mask mask,
220 			       const char *fmt, ...);
221 void ath10k_dbg_dump(struct ath10k *ar,
222 		     enum ath10k_debug_mask mask,
223 		     const char *msg, const char *prefix,
224 		     const void *buf, size_t len);
225 #else /* CONFIG_ATH10K_DEBUG */
226 
227 static inline int ath10k_dbg(struct ath10k *ar,
228 			     enum ath10k_debug_mask dbg_mask,
229 			     const char *fmt, ...)
230 {
231 	return 0;
232 }
233 
234 static inline void ath10k_dbg_dump(struct ath10k *ar,
235 				   enum ath10k_debug_mask mask,
236 				   const char *msg, const char *prefix,
237 				   const void *buf, size_t len)
238 {
239 }
240 #endif /* CONFIG_ATH10K_DEBUG */
241 #endif /* _DEBUG_H_ */
242