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_ANY		= 0xffffffff,
48 };
49 
50 enum ath10k_pktlog_filter {
51 	ATH10K_PKTLOG_RX         = 0x000000001,
52 	ATH10K_PKTLOG_TX         = 0x000000002,
53 	ATH10K_PKTLOG_RCFIND     = 0x000000004,
54 	ATH10K_PKTLOG_RCUPDATE   = 0x000000008,
55 	ATH10K_PKTLOG_DBG_PRINT  = 0x000000010,
56 	ATH10K_PKTLOG_PEER_STATS = 0x000000040,
57 	ATH10K_PKTLOG_ANY        = 0x00000005f,
58 };
59 
60 enum ath10k_dbg_aggr_mode {
61 	ATH10K_DBG_AGGR_MODE_AUTO,
62 	ATH10K_DBG_AGGR_MODE_MANUAL,
63 	ATH10K_DBG_AGGR_MODE_MAX,
64 };
65 
66 /* Types of packet log events */
67 enum ath_pktlog_type {
68 	ATH_PKTLOG_TYPE_TX_CTRL = 1,
69 	ATH_PKTLOG_TYPE_TX_STAT,
70 };
71 
72 struct ath10k_pktlog_hdr {
73 	__le16 flags;
74 	__le16 missed_cnt;
75 	__le16 log_type; /* Type of log information foll this header */
76 	__le16 size; /* Size of variable length log information in bytes */
77 	__le32 timestamp;
78 	u8 payload[0];
79 } __packed;
80 
81 /* FIXME: How to calculate the buffer size sanely? */
82 #define ATH10K_FW_STATS_BUF_SIZE (1024 * 1024)
83 
84 extern unsigned int ath10k_debug_mask;
85 
86 __printf(2, 3) void ath10k_info(struct ath10k *ar, const char *fmt, ...);
87 __printf(2, 3) void ath10k_err(struct ath10k *ar, const char *fmt, ...);
88 __printf(2, 3) void ath10k_warn(struct ath10k *ar, const char *fmt, ...);
89 
90 void ath10k_debug_print_hwfw_info(struct ath10k *ar);
91 void ath10k_debug_print_board_info(struct ath10k *ar);
92 void ath10k_debug_print_boot_info(struct ath10k *ar);
93 void ath10k_print_driver_info(struct ath10k *ar);
94 
95 #ifdef CONFIG_ATH10K_DEBUGFS
96 int ath10k_debug_start(struct ath10k *ar);
97 void ath10k_debug_stop(struct ath10k *ar);
98 int ath10k_debug_create(struct ath10k *ar);
99 void ath10k_debug_destroy(struct ath10k *ar);
100 int ath10k_debug_register(struct ath10k *ar);
101 void ath10k_debug_unregister(struct ath10k *ar);
102 void ath10k_debug_fw_stats_process(struct ath10k *ar, struct sk_buff *skb);
103 void ath10k_debug_tpc_stats_process(struct ath10k *ar,
104 				    struct ath10k_tpc_stats *tpc_stats);
105 void
106 ath10k_debug_tpc_stats_final_process(struct ath10k *ar,
107 				     struct ath10k_tpc_stats_final *tpc_stats);
108 void ath10k_debug_dbglog_add(struct ath10k *ar, u8 *buffer, int len);
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 
ath10k_debug_get_fw_dbglog_mask(struct ath10k * ar)121 static inline u64 ath10k_debug_get_fw_dbglog_mask(struct ath10k *ar)
122 {
123 	return ar->debug.fw_dbglog_mask;
124 }
125 
ath10k_debug_get_fw_dbglog_level(struct ath10k * ar)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 
ath10k_debug_start(struct ath10k * ar)133 static inline int ath10k_debug_start(struct ath10k *ar)
134 {
135 	return 0;
136 }
137 
ath10k_debug_stop(struct ath10k * ar)138 static inline void ath10k_debug_stop(struct ath10k *ar)
139 {
140 }
141 
ath10k_debug_create(struct ath10k * ar)142 static inline int ath10k_debug_create(struct ath10k *ar)
143 {
144 	return 0;
145 }
146 
ath10k_debug_destroy(struct ath10k * ar)147 static inline void ath10k_debug_destroy(struct ath10k *ar)
148 {
149 }
150 
ath10k_debug_register(struct ath10k * ar)151 static inline int ath10k_debug_register(struct ath10k *ar)
152 {
153 	return 0;
154 }
155 
ath10k_debug_unregister(struct ath10k * ar)156 static inline void ath10k_debug_unregister(struct ath10k *ar)
157 {
158 }
159 
ath10k_debug_fw_stats_process(struct ath10k * ar,struct sk_buff * skb)160 static inline void ath10k_debug_fw_stats_process(struct ath10k *ar,
161 						 struct sk_buff *skb)
162 {
163 }
164 
ath10k_debug_tpc_stats_process(struct ath10k * ar,struct ath10k_tpc_stats * tpc_stats)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_tpc_stats_final_process(struct ath10k * ar,struct ath10k_tpc_stats_final * tpc_stats)172 ath10k_debug_tpc_stats_final_process(struct ath10k *ar,
173 				     struct ath10k_tpc_stats_final *tpc_stats)
174 {
175 	kfree(tpc_stats);
176 }
177 
ath10k_debug_dbglog_add(struct ath10k * ar,u8 * buffer,int len)178 static inline void ath10k_debug_dbglog_add(struct ath10k *ar, u8 *buffer,
179 					   int len)
180 {
181 }
182 
ath10k_debug_get_fw_dbglog_mask(struct ath10k * ar)183 static inline u64 ath10k_debug_get_fw_dbglog_mask(struct ath10k *ar)
184 {
185 	return 0;
186 }
187 
ath10k_debug_get_fw_dbglog_level(struct ath10k * ar)188 static inline u32 ath10k_debug_get_fw_dbglog_level(struct ath10k *ar)
189 {
190 	return 0;
191 }
192 
193 #define ATH10K_DFS_STAT_INC(ar, c) do { } while (0)
194 
195 #define ath10k_debug_get_et_strings NULL
196 #define ath10k_debug_get_et_sset_count NULL
197 #define ath10k_debug_get_et_stats NULL
198 
199 #endif /* CONFIG_ATH10K_DEBUGFS */
200 #ifdef CONFIG_MAC80211_DEBUGFS
201 void ath10k_sta_add_debugfs(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
202 			    struct ieee80211_sta *sta, struct dentry *dir);
203 void ath10k_sta_update_rx_duration(struct ath10k *ar,
204 				   struct ath10k_fw_stats *stats);
205 void ath10k_sta_update_rx_tid_stats(struct ath10k *ar, u8 *first_hdr,
206 				    unsigned long int num_msdus,
207 				    enum ath10k_pkt_rx_err err,
208 				    unsigned long int unchain_cnt,
209 				    unsigned long int drop_cnt,
210 				    unsigned long int drop_cnt_filter,
211 				    unsigned long int queued_msdus);
212 void ath10k_sta_update_rx_tid_stats_ampdu(struct ath10k *ar,
213 					  u16 peer_id, u8 tid,
214 					  struct htt_rx_indication_mpdu_range *ranges,
215 					  int num_ranges);
216 #else
217 static inline
ath10k_sta_update_rx_duration(struct ath10k * ar,struct ath10k_fw_stats * stats)218 void ath10k_sta_update_rx_duration(struct ath10k *ar,
219 				   struct ath10k_fw_stats *stats)
220 {
221 }
222 
223 static inline
ath10k_sta_update_rx_tid_stats(struct ath10k * ar,u8 * first_hdr,unsigned long int num_msdus,enum ath10k_pkt_rx_err err,unsigned long int unchain_cnt,unsigned long int drop_cnt,unsigned long int drop_cnt_filter,unsigned long int queued_msdus)224 void ath10k_sta_update_rx_tid_stats(struct ath10k *ar, u8 *first_hdr,
225 				    unsigned long int num_msdus,
226 				    enum ath10k_pkt_rx_err err,
227 				    unsigned long int unchain_cnt,
228 				    unsigned long int drop_cnt,
229 				    unsigned long int drop_cnt_filter,
230 				    unsigned long int queued_msdus)
231 {
232 }
233 
234 static inline
ath10k_sta_update_rx_tid_stats_ampdu(struct ath10k * ar,u16 peer_id,u8 tid,struct htt_rx_indication_mpdu_range * ranges,int num_ranges)235 void ath10k_sta_update_rx_tid_stats_ampdu(struct ath10k *ar,
236 					  u16 peer_id, u8 tid,
237 					  struct htt_rx_indication_mpdu_range *ranges,
238 					  int num_ranges)
239 {
240 }
241 #endif /* CONFIG_MAC80211_DEBUGFS */
242 
243 #ifdef CONFIG_ATH10K_DEBUG
244 __printf(3, 4) void ath10k_dbg(struct ath10k *ar,
245 			       enum ath10k_debug_mask mask,
246 			       const char *fmt, ...);
247 void ath10k_dbg_dump(struct ath10k *ar,
248 		     enum ath10k_debug_mask mask,
249 		     const char *msg, const char *prefix,
250 		     const void *buf, size_t len);
251 #else /* CONFIG_ATH10K_DEBUG */
252 
ath10k_dbg(struct ath10k * ar,enum ath10k_debug_mask dbg_mask,const char * fmt,...)253 static inline int ath10k_dbg(struct ath10k *ar,
254 			     enum ath10k_debug_mask dbg_mask,
255 			     const char *fmt, ...)
256 {
257 	return 0;
258 }
259 
ath10k_dbg_dump(struct ath10k * ar,enum ath10k_debug_mask mask,const char * msg,const char * prefix,const void * buf,size_t len)260 static inline void ath10k_dbg_dump(struct ath10k *ar,
261 				   enum ath10k_debug_mask mask,
262 				   const char *msg, const char *prefix,
263 				   const void *buf, size_t len)
264 {
265 }
266 #endif /* CONFIG_ATH10K_DEBUG */
267 #endif /* _DEBUG_H_ */
268