1/* SPDX-License-Identifier: ISC */
2/*
3 * Copyright (c) 2005-2011 Atheros Communications Inc.
4 * Copyright (c) 2011-2017 Qualcomm Atheros, Inc.
5 * Copyright (c) 2018, The Linux Foundation. All rights reserved.
6 */
7
8#ifndef _DEBUG_H_
9#define _DEBUG_H_
10
11#include <linux/types.h>
12#include "trace.h"
13
14enum ath10k_debug_mask {
15	ATH10K_DBG_PCI		= 0x00000001,
16	ATH10K_DBG_WMI		= 0x00000002,
17	ATH10K_DBG_HTC		= 0x00000004,
18	ATH10K_DBG_HTT		= 0x00000008,
19	ATH10K_DBG_MAC		= 0x00000010,
20	ATH10K_DBG_BOOT		= 0x00000020,
21	ATH10K_DBG_PCI_DUMP	= 0x00000040,
22	ATH10K_DBG_HTT_DUMP	= 0x00000080,
23	ATH10K_DBG_MGMT		= 0x00000100,
24	ATH10K_DBG_DATA		= 0x00000200,
25	ATH10K_DBG_BMI		= 0x00000400,
26	ATH10K_DBG_REGULATORY	= 0x00000800,
27	ATH10K_DBG_TESTMODE	= 0x00001000,
28	ATH10K_DBG_WMI_PRINT	= 0x00002000,
29	ATH10K_DBG_PCI_PS	= 0x00004000,
30	ATH10K_DBG_AHB		= 0x00008000,
31	ATH10K_DBG_SDIO		= 0x00010000,
32	ATH10K_DBG_SDIO_DUMP	= 0x00020000,
33	ATH10K_DBG_USB		= 0x00040000,
34	ATH10K_DBG_USB_BULK	= 0x00080000,
35	ATH10K_DBG_SNOC		= 0x00100000,
36	ATH10K_DBG_QMI		= 0x00200000,
37	ATH10K_DBG_ANY		= 0xffffffff,
38};
39
40enum ath10k_pktlog_filter {
41	ATH10K_PKTLOG_RX         = 0x000000001,
42	ATH10K_PKTLOG_TX         = 0x000000002,
43	ATH10K_PKTLOG_RCFIND     = 0x000000004,
44	ATH10K_PKTLOG_RCUPDATE   = 0x000000008,
45	ATH10K_PKTLOG_DBG_PRINT  = 0x000000010,
46	ATH10K_PKTLOG_PEER_STATS = 0x000000040,
47	ATH10K_PKTLOG_ANY        = 0x00000005f,
48};
49
50enum ath10k_dbg_aggr_mode {
51	ATH10K_DBG_AGGR_MODE_AUTO,
52	ATH10K_DBG_AGGR_MODE_MANUAL,
53	ATH10K_DBG_AGGR_MODE_MAX,
54};
55
56/* Types of packet log events */
57enum ath_pktlog_type {
58	ATH_PKTLOG_TYPE_TX_CTRL = 1,
59	ATH_PKTLOG_TYPE_TX_STAT,
60};
61
62struct ath10k_pktlog_hdr {
63	__le16 flags;
64	__le16 missed_cnt;
65	__le16 log_type; /* Type of log information foll this header */
66	__le16 size; /* Size of variable length log information in bytes */
67	__le32 timestamp;
68	u8 payload[];
69} __packed;
70
71/* FIXME: How to calculate the buffer size sanely? */
72#define ATH10K_FW_STATS_BUF_SIZE (1024 * 1024)
73
74#define ATH10K_TX_POWER_MAX_VAL 70
75#define ATH10K_TX_POWER_MIN_VAL 0
76
77extern unsigned int ath10k_debug_mask;
78
79__printf(2, 3) void ath10k_info(struct ath10k *ar, const char *fmt, ...);
80__printf(2, 3) void ath10k_err(struct ath10k *ar, const char *fmt, ...);
81__printf(2, 3) void ath10k_warn(struct ath10k *ar, const char *fmt, ...);
82
83void ath10k_debug_print_hwfw_info(struct ath10k *ar);
84void ath10k_debug_print_board_info(struct ath10k *ar);
85void ath10k_debug_print_boot_info(struct ath10k *ar);
86void ath10k_print_driver_info(struct ath10k *ar);
87
88#ifdef CONFIG_ATH10K_DEBUGFS
89int ath10k_debug_start(struct ath10k *ar);
90void ath10k_debug_stop(struct ath10k *ar);
91int ath10k_debug_create(struct ath10k *ar);
92void ath10k_debug_destroy(struct ath10k *ar);
93int ath10k_debug_register(struct ath10k *ar);
94void ath10k_debug_unregister(struct ath10k *ar);
95void ath10k_debug_fw_stats_process(struct ath10k *ar, struct sk_buff *skb);
96void ath10k_debug_tpc_stats_process(struct ath10k *ar,
97				    struct ath10k_tpc_stats *tpc_stats);
98void
99ath10k_debug_tpc_stats_final_process(struct ath10k *ar,
100				     struct ath10k_tpc_stats_final *tpc_stats);
101void ath10k_debug_dbglog_add(struct ath10k *ar, u8 *buffer, int len);
102
103#define ATH10K_DFS_STAT_INC(ar, c) (ar->debug.dfs_stats.c++)
104
105void ath10k_debug_get_et_strings(struct ieee80211_hw *hw,
106				 struct ieee80211_vif *vif,
107				 u32 sset, u8 *data);
108int ath10k_debug_get_et_sset_count(struct ieee80211_hw *hw,
109				   struct ieee80211_vif *vif, int sset);
110void ath10k_debug_get_et_stats(struct ieee80211_hw *hw,
111			       struct ieee80211_vif *vif,
112			       struct ethtool_stats *stats, u64 *data);
113
114static inline u64 ath10k_debug_get_fw_dbglog_mask(struct ath10k *ar)
115{
116	return ar->debug.fw_dbglog_mask;
117}
118
119static inline u32 ath10k_debug_get_fw_dbglog_level(struct ath10k *ar)
120{
121	return ar->debug.fw_dbglog_level;
122}
123
124static inline int ath10k_debug_is_extd_tx_stats_enabled(struct ath10k *ar)
125{
126	return ar->debug.enable_extd_tx_stats;
127}
128
129int ath10k_debug_fw_stats_request(struct ath10k *ar);
130
131#else
132
133static inline int ath10k_debug_start(struct ath10k *ar)
134{
135	return 0;
136}
137
138static inline void ath10k_debug_stop(struct ath10k *ar)
139{
140}
141
142static inline int ath10k_debug_create(struct ath10k *ar)
143{
144	return 0;
145}
146
147static inline void ath10k_debug_destroy(struct ath10k *ar)
148{
149}
150
151static inline int ath10k_debug_register(struct ath10k *ar)
152{
153	return 0;
154}
155
156static inline void ath10k_debug_unregister(struct ath10k *ar)
157{
158}
159
160static inline void ath10k_debug_fw_stats_process(struct ath10k *ar,
161						 struct sk_buff *skb)
162{
163}
164
165static inline void ath10k_debug_tpc_stats_process(struct ath10k *ar,
166						  struct ath10k_tpc_stats *tpc_stats)
167{
168	kfree(tpc_stats);
169}
170
171static inline void
172ath10k_debug_tpc_stats_final_process(struct ath10k *ar,
173				     struct ath10k_tpc_stats_final *tpc_stats)
174{
175	kfree(tpc_stats);
176}
177
178static inline void ath10k_debug_dbglog_add(struct ath10k *ar, u8 *buffer,
179					   int len)
180{
181}
182
183static inline u64 ath10k_debug_get_fw_dbglog_mask(struct ath10k *ar)
184{
185	return 0;
186}
187
188static inline u32 ath10k_debug_get_fw_dbglog_level(struct ath10k *ar)
189{
190	return 0;
191}
192
193static inline int ath10k_debug_is_extd_tx_stats_enabled(struct ath10k *ar)
194{
195	return 0;
196}
197
198static inline int ath10k_debug_fw_stats_request(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
211void ath10k_sta_add_debugfs(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
212			    struct ieee80211_sta *sta, struct dentry *dir);
213void ath10k_sta_update_rx_duration(struct ath10k *ar,
214				   struct ath10k_fw_stats *stats);
215void ath10k_sta_update_rx_tid_stats(struct ath10k *ar, u8 *first_hdr,
216				    unsigned long num_msdus,
217				    enum ath10k_pkt_rx_err err,
218				    unsigned long unchain_cnt,
219				    unsigned long drop_cnt,
220				    unsigned long drop_cnt_filter,
221				    unsigned long queued_msdus);
222void 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
227static inline
228void ath10k_sta_update_rx_duration(struct ath10k *ar,
229				   struct ath10k_fw_stats *stats)
230{
231}
232
233static inline
234void ath10k_sta_update_rx_tid_stats(struct ath10k *ar, u8 *first_hdr,
235				    unsigned long num_msdus,
236				    enum ath10k_pkt_rx_err err,
237				    unsigned long unchain_cnt,
238				    unsigned long drop_cnt,
239				    unsigned long drop_cnt_filter,
240				    unsigned long queued_msdus)
241{
242}
243
244static inline
245void 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, ...);
257void 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
263static inline int __ath10k_dbg(struct ath10k *ar,
264			       enum ath10k_debug_mask dbg_mask,
265			       const char *fmt, ...)
266{
267	return 0;
268}
269
270static 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
278/* Avoid calling __ath10k_dbg() if debug_mask is not set and tracing
279 * disabled.
280 */
281#define ath10k_dbg(ar, dbg_mask, fmt, ...)			\
282do {								\
283	if ((ath10k_debug_mask & dbg_mask) ||			\
284	    trace_ath10k_log_dbg_enabled())			\
285		__ath10k_dbg(ar, dbg_mask, fmt, ##__VA_ARGS__); \
286} while (0)
287#endif /* _DEBUG_H_ */
288