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