ath10k: switch to use SPDX license identifiers
[platform/kernel/linux-rpi.git] / drivers / net / wireless / ath / ath10k / debug.h
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
14 enum 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
40 enum 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
50 enum 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 */
57 enum ath_pktlog_type {
58         ATH_PKTLOG_TYPE_TX_CTRL = 1,
59         ATH_PKTLOG_TYPE_TX_STAT,
60 };
61
62 struct 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[0];
69 } __packed;
70
71 /* FIXME: How to calculate the buffer size sanely? */
72 #define ATH10K_FW_STATS_BUF_SIZE (1024 * 1024)
73
74 extern unsigned int ath10k_debug_mask;
75
76 __printf(2, 3) void ath10k_info(struct ath10k *ar, const char *fmt, ...);
77 __printf(2, 3) void ath10k_err(struct ath10k *ar, const char *fmt, ...);
78 __printf(2, 3) void ath10k_warn(struct ath10k *ar, const char *fmt, ...);
79
80 void ath10k_debug_print_hwfw_info(struct ath10k *ar);
81 void ath10k_debug_print_board_info(struct ath10k *ar);
82 void ath10k_debug_print_boot_info(struct ath10k *ar);
83 void ath10k_print_driver_info(struct ath10k *ar);
84
85 #ifdef CONFIG_ATH10K_DEBUGFS
86 int ath10k_debug_start(struct ath10k *ar);
87 void ath10k_debug_stop(struct ath10k *ar);
88 int ath10k_debug_create(struct ath10k *ar);
89 void ath10k_debug_destroy(struct ath10k *ar);
90 int ath10k_debug_register(struct ath10k *ar);
91 void ath10k_debug_unregister(struct ath10k *ar);
92 void ath10k_debug_fw_stats_process(struct ath10k *ar, struct sk_buff *skb);
93 void ath10k_debug_tpc_stats_process(struct ath10k *ar,
94                                     struct ath10k_tpc_stats *tpc_stats);
95 void
96 ath10k_debug_tpc_stats_final_process(struct ath10k *ar,
97                                      struct ath10k_tpc_stats_final *tpc_stats);
98 void ath10k_debug_dbglog_add(struct ath10k *ar, u8 *buffer, int len);
99
100 #define ATH10K_DFS_STAT_INC(ar, c) (ar->debug.dfs_stats.c++)
101
102 void ath10k_debug_get_et_strings(struct ieee80211_hw *hw,
103                                  struct ieee80211_vif *vif,
104                                  u32 sset, u8 *data);
105 int ath10k_debug_get_et_sset_count(struct ieee80211_hw *hw,
106                                    struct ieee80211_vif *vif, int sset);
107 void ath10k_debug_get_et_stats(struct ieee80211_hw *hw,
108                                struct ieee80211_vif *vif,
109                                struct ethtool_stats *stats, u64 *data);
110
111 static inline u64 ath10k_debug_get_fw_dbglog_mask(struct ath10k *ar)
112 {
113         return ar->debug.fw_dbglog_mask;
114 }
115
116 static inline u32 ath10k_debug_get_fw_dbglog_level(struct ath10k *ar)
117 {
118         return ar->debug.fw_dbglog_level;
119 }
120
121 static inline int ath10k_debug_is_extd_tx_stats_enabled(struct ath10k *ar)
122 {
123         return ar->debug.enable_extd_tx_stats;
124 }
125 #else
126
127 static inline int ath10k_debug_start(struct ath10k *ar)
128 {
129         return 0;
130 }
131
132 static inline void ath10k_debug_stop(struct ath10k *ar)
133 {
134 }
135
136 static inline int ath10k_debug_create(struct ath10k *ar)
137 {
138         return 0;
139 }
140
141 static inline void ath10k_debug_destroy(struct ath10k *ar)
142 {
143 }
144
145 static inline int ath10k_debug_register(struct ath10k *ar)
146 {
147         return 0;
148 }
149
150 static inline void ath10k_debug_unregister(struct ath10k *ar)
151 {
152 }
153
154 static inline void ath10k_debug_fw_stats_process(struct ath10k *ar,
155                                                  struct sk_buff *skb)
156 {
157 }
158
159 static inline void ath10k_debug_tpc_stats_process(struct ath10k *ar,
160                                                   struct ath10k_tpc_stats *tpc_stats)
161 {
162         kfree(tpc_stats);
163 }
164
165 static inline void
166 ath10k_debug_tpc_stats_final_process(struct ath10k *ar,
167                                      struct ath10k_tpc_stats_final *tpc_stats)
168 {
169         kfree(tpc_stats);
170 }
171
172 static inline void ath10k_debug_dbglog_add(struct ath10k *ar, u8 *buffer,
173                                            int len)
174 {
175 }
176
177 static inline u64 ath10k_debug_get_fw_dbglog_mask(struct ath10k *ar)
178 {
179         return 0;
180 }
181
182 static inline u32 ath10k_debug_get_fw_dbglog_level(struct ath10k *ar)
183 {
184         return 0;
185 }
186
187 static inline int ath10k_debug_is_extd_tx_stats_enabled(struct ath10k *ar)
188 {
189         return 0;
190 }
191
192 #define ATH10K_DFS_STAT_INC(ar, c) do { } while (0)
193
194 #define ath10k_debug_get_et_strings NULL
195 #define ath10k_debug_get_et_sset_count NULL
196 #define ath10k_debug_get_et_stats NULL
197
198 #endif /* CONFIG_ATH10K_DEBUGFS */
199 #ifdef CONFIG_MAC80211_DEBUGFS
200 void ath10k_sta_add_debugfs(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
201                             struct ieee80211_sta *sta, struct dentry *dir);
202 void ath10k_sta_update_rx_duration(struct ath10k *ar,
203                                    struct ath10k_fw_stats *stats);
204 void ath10k_sta_update_rx_tid_stats(struct ath10k *ar, u8 *first_hdr,
205                                     unsigned long num_msdus,
206                                     enum ath10k_pkt_rx_err err,
207                                     unsigned long unchain_cnt,
208                                     unsigned long drop_cnt,
209                                     unsigned long drop_cnt_filter,
210                                     unsigned long queued_msdus);
211 void ath10k_sta_update_rx_tid_stats_ampdu(struct ath10k *ar,
212                                           u16 peer_id, u8 tid,
213                                           struct htt_rx_indication_mpdu_range *ranges,
214                                           int num_ranges);
215 #else
216 static inline
217 void ath10k_sta_update_rx_duration(struct ath10k *ar,
218                                    struct ath10k_fw_stats *stats)
219 {
220 }
221
222 static inline
223 void ath10k_sta_update_rx_tid_stats(struct ath10k *ar, u8 *first_hdr,
224                                     unsigned long num_msdus,
225                                     enum ath10k_pkt_rx_err err,
226                                     unsigned long unchain_cnt,
227                                     unsigned long drop_cnt,
228                                     unsigned long drop_cnt_filter,
229                                     unsigned long queued_msdus)
230 {
231 }
232
233 static inline
234 void ath10k_sta_update_rx_tid_stats_ampdu(struct ath10k *ar,
235                                           u16 peer_id, u8 tid,
236                                           struct htt_rx_indication_mpdu_range *ranges,
237                                           int num_ranges)
238 {
239 }
240 #endif /* CONFIG_MAC80211_DEBUGFS */
241
242 #ifdef CONFIG_ATH10K_DEBUG
243 __printf(3, 4) void ath10k_dbg(struct ath10k *ar,
244                                enum ath10k_debug_mask mask,
245                                const char *fmt, ...);
246 void ath10k_dbg_dump(struct ath10k *ar,
247                      enum ath10k_debug_mask mask,
248                      const char *msg, const char *prefix,
249                      const void *buf, size_t len);
250 #else /* CONFIG_ATH10K_DEBUG */
251
252 static inline int ath10k_dbg(struct ath10k *ar,
253                              enum ath10k_debug_mask dbg_mask,
254                              const char *fmt, ...)
255 {
256         return 0;
257 }
258
259 static inline void ath10k_dbg_dump(struct ath10k *ar,
260                                    enum ath10k_debug_mask mask,
261                                    const char *msg, const char *prefix,
262                                    const void *buf, size_t len)
263 {
264 }
265 #endif /* CONFIG_ATH10K_DEBUG */
266 #endif /* _DEBUG_H_ */