forked from ~ljy/RK356X_SDK_RELEASE
blame | history | patch | commit | commitdiff
hc
2023-12-11 d2ccde1c8e90d38cee87a1b0309ad2827f3fd30d 
 kernel/drivers/net/wireless/rockchip_wlan/cywdhd/bcmdhd/dhd_dbg.h
....@@ -1,15 +1,16 @@
1
-/* SPDX-License-Identifier: GPL-2.0 */
21 /*
32  * Debug/trace/assert driver definitions for Dongle Host Driver.
43  *
5
- * Copyright (C) 1999-2019, Broadcom Corporation
6
- * 
4
+ * Portions of this code are copyright (c) 2022 Cypress Semiconductor Corporation
5
+ *
6
+ * Copyright (C) 1999-2017, Broadcom Corporation
7
+ *
78  *      Unless you and Broadcom execute a separate written software license
89  * agreement governing use of this software, this software is licensed to you
910  * under the terms of the GNU General Public License version 2 (the "GPL"),
1011  * available at http://www.broadcom.com/licenses/GPLv2.php, with the
1112  * following added to such license:
12
- * 
13
+ *
1314  *      As a special exception, the copyright holders of this software give you
1415  * permission to link this software with independent modules, and to copy and
1516  * distribute the resulting executable under terms of your choice, provided that
....@@ -17,7 +18,7 @@
1718  * the license of that module.  An independent module is a module which is not
1819  * derived from this software.  The special exception does not apply to any
1920  * modifications of the software.
20
- * 
21
+ *
2122  *      Notwithstanding the above, under no circumstances may you combine this
2223  * software in any way with any other Broadcom software provided under a license
2324  * other than the GPL, without Broadcom's express prior written consent.
....@@ -25,20 +26,160 @@
2526  *
2627  * <<Broadcom-WL-IPTag/Open:>>
2728  *
28
- * $Id: dhd_dbg.h 586164 2015-09-14 18:09:12Z $
29
+ * $Id: dhd_dbg.h 700979 2017-05-23 05:31:00Z $
2930  */
3031 
3132 #ifndef _dhd_dbg_
3233 #define _dhd_dbg_
3334 
34
-#define USE_NET_RATELIMIT		1
35
+#ifdef DHD_LOG_DUMP
36
+extern char *dhd_log_dump_get_timestamp(void);
37
+extern void dhd_log_dump_write(int type, char *binary_data,
38
+		int binary_len, const char *fmt, ...);
39
+#ifndef _DHD_LOG_DUMP_DEFINITIONS_
40
+#define _DHD_LOG_DUMP_DEFINITIONS_
41
+#define GENERAL_LOG_HDR "\n-------------------- General log ---------------------------\n"
42
+#define PRESERVE_LOG_HDR "\n-------------------- Preserve log ---------------------------\n"
43
+#define SPECIAL_LOG_HDR "\n-------------------- Special log ---------------------------\n"
44
+#define DHD_DUMP_LOG_HDR "\n-------------------- 'dhd dump' log -----------------------\n"
45
+#define EXT_TRAP_LOG_HDR "\n-------------------- Extended trap data -------------------\n"
46
+#define HEALTH_CHK_LOG_HDR "\n-------------------- Health check data --------------------\n"
47
+#ifdef DHD_DUMP_PCIE_RINGS
48
+#define FLOWRING_DUMP_HDR "\n-------------------- Flowring dump --------------------\n"
49
+#endif /* DHD_DUMP_PCIE_RINGS */
50
+#define DHD_LOG_DUMP_WRITE(fmt, ...) \
51
+	dhd_log_dump_write(DLD_BUF_TYPE_GENERAL, NULL, 0, fmt, ##__VA_ARGS__)
52
+#define DHD_LOG_DUMP_WRITE_EX(fmt, ...) \
53
+	dhd_log_dump_write(DLD_BUF_TYPE_SPECIAL, NULL, 0, fmt, ##__VA_ARGS__)
54
+#define DHD_LOG_DUMP_WRITE_PRSRV(fmt, ...) \
55
+	dhd_log_dump_write(DLD_BUF_TYPE_PRESERVE, NULL, 0, fmt, ##__VA_ARGS__)
56
+#endif /* !_DHD_LOG_DUMP_DEFINITIONS_ */
57
+#define CONCISE_DUMP_BUFLEN 16 * 1024
58
+#define ECNTRS_LOG_HDR "\n-------------------- Ecounters log --------------------------\n"
59
+#ifdef DHD_STATUS_LOGGING
60
+#define STATUS_LOG_HDR "\n-------------------- Status log -----------------------\n"
61
+#endif /* DHD_STATUS_LOGGING */
62
+#define RTT_LOG_HDR "\n-------------------- RTT log --------------------------\n"
63
+#define COOKIE_LOG_HDR "\n-------------------- Cookie List ----------------------------\n"
64
+#endif /* DHD_LOG_DUMP */
3565 
3666 #if defined(DHD_DEBUG)
3767 
38
-#define DHD_ERROR(args)		do {if ((dhd_msg_level & DHD_ERROR_VAL) && USE_NET_RATELIMIT) \
39
-								printf args;} while (0)
40
-#define DHD_TRACE(args)		do {if (dhd_msg_level & DHD_TRACE_VAL) printf args;} while (0)
68
+/* NON-NDIS cases */
69
+#ifdef DHD_LOG_DUMP
70
+/* Common case for EFI and non EFI */
71
+#define DHD_ERROR(args)	\
72
+do {	\
73
+	if (dhd_msg_level & DHD_ERROR_VAL) {	\
74
+		printf args;	\
75
+		DHD_LOG_DUMP_WRITE("[%s]: ", dhd_log_dump_get_timestamp());	\
76
+		DHD_LOG_DUMP_WRITE args;	\
77
+	}	\
78
+} while (0)
79
+
80
+/* !defined(DHD_EFI) and defined(DHD_LOG_DUMP) */
4181 #define DHD_INFO(args)		do {if (dhd_msg_level & DHD_INFO_VAL) printf args;} while (0)
82
+#else /* DHD_LOG_DUMP */
83
+/* !defined(DHD_LOG_DUMP cases) */
84
+#define DHD_ERROR(args)		do {if (dhd_msg_level & DHD_ERROR_VAL) printf args;} while (0)
85
+#define DHD_INFO(args)		do {if (dhd_msg_level & DHD_INFO_VAL) printf args;} while (0)
86
+#endif /* DHD_LOG_DUMP */
87
+
88
+#define DHD_TRACE(args)		do {if (dhd_msg_level & DHD_TRACE_VAL) printf args;} while (0)
89
+
90
+#ifdef DHD_LOG_DUMP
91
+/* LOG_DUMP defines common to EFI and NON-EFI */
92
+#define DHD_ERROR_MEM(args) \
93
+do {	\
94
+	if (dhd_msg_level & DHD_ERROR_VAL) {	\
95
+		if (dhd_msg_level & DHD_ERROR_MEM_VAL) {	\
96
+			printf args; \
97
+		}	\
98
+		DHD_LOG_DUMP_WRITE("[%s]: ", dhd_log_dump_get_timestamp());	\
99
+		DHD_LOG_DUMP_WRITE args;	\
100
+	}	\
101
+} while (0)
102
+#define DHD_IOVAR_MEM(args) \
103
+do {	\
104
+	if (dhd_msg_level & DHD_ERROR_VAL) {	\
105
+		if (dhd_msg_level & DHD_IOVAR_MEM_VAL) {	\
106
+			printf args; \
107
+		}	\
108
+		DHD_LOG_DUMP_WRITE("[%s]: ", dhd_log_dump_get_timestamp());	\
109
+		DHD_LOG_DUMP_WRITE args;	\
110
+	}	\
111
+} while (0)
112
+#define DHD_LOG_MEM(args) \
113
+do {	\
114
+	if (dhd_msg_level & DHD_ERROR_VAL) {	\
115
+		DHD_LOG_DUMP_WRITE("[%s]: ", dhd_log_dump_get_timestamp());	\
116
+		DHD_LOG_DUMP_WRITE args;	\
117
+	}	\
118
+} while (0)
119
+/* NON-EFI builds with LOG DUMP enabled */
120
+#define DHD_EVENT(args) \
121
+do {	\
122
+	if (dhd_msg_level & DHD_EVENT_VAL) {	\
123
+		printf args; \
124
+		DHD_LOG_DUMP_WRITE("[%s]: ", dhd_log_dump_get_timestamp());	\
125
+		DHD_LOG_DUMP_WRITE args;	\
126
+	}	\
127
+} while (0)
128
+#define DHD_PRSRV_MEM(args) \
129
+do {	\
130
+	if (dhd_msg_level & DHD_EVENT_VAL) {	\
131
+		if (dhd_msg_level & DHD_PRSRV_MEM_VAL) \
132
+			printf args; \
133
+		DHD_LOG_DUMP_WRITE_PRSRV("[%s]: ", dhd_log_dump_get_timestamp()); \
134
+		DHD_LOG_DUMP_WRITE_PRSRV args;	\
135
+	}	\
136
+} while (0)
137
+
138
+/* Re-using 'DHD_MSGTRACE_VAL' for controlling printing of ecounter binary event
139
+* logs to console and debug dump -- need to cleanup in the future to use separate
140
+* 'DHD_ECNTR_VAL' bitmap flag. 'DHD_MSGTRACE_VAL' will be defined only
141
+* for non-android builds.
142
+*/
143
+#define DHD_ECNTR_LOG(args) \
144
+do {	\
145
+	if (dhd_msg_level & DHD_EVENT_VAL) {	\
146
+		if (dhd_msg_level & DHD_MSGTRACE_VAL) {	\
147
+			printf args; \
148
+			DHD_LOG_DUMP_WRITE("[%s]: ", dhd_log_dump_get_timestamp()); \
149
+			DHD_LOG_DUMP_WRITE args;	\
150
+		}	\
151
+	}	\
152
+} while (0)
153
+
154
+#define DHD_ERROR_EX(args)					\
155
+do {										\
156
+	if (dhd_msg_level & DHD_ERROR_VAL) {    \
157
+		printf args;	\
158
+		DHD_LOG_DUMP_WRITE_EX("[%s]: ", dhd_log_dump_get_timestamp());	\
159
+		DHD_LOG_DUMP_WRITE_EX args;	\
160
+	}	\
161
+} while (0)
162
+
163
+#define DHD_MSGTRACE_LOG(args)	\
164
+do {	\
165
+	if (dhd_msg_level & DHD_MSGTRACE_VAL) {	\
166
+		printf args;	\
167
+	}	\
168
+	DHD_LOG_DUMP_WRITE("[%s]: ", dhd_log_dump_get_timestamp());	\
169
+	DHD_LOG_DUMP_WRITE args;	\
170
+} while (0)
171
+#else /* DHD_LOG_DUMP */
172
+/* !DHD_LOG_DUMP */
173
+#define DHD_MSGTRACE_LOG(args)  do {if (dhd_msg_level & DHD_MSGTRACE_VAL) printf args;} while (0)
174
+#define DHD_ERROR_MEM(args)	DHD_ERROR(args)
175
+#define DHD_IOVAR_MEM(args)	DHD_ERROR(args)
176
+#define DHD_LOG_MEM(args)	DHD_ERROR(args)
177
+#define DHD_EVENT(args)		do {if (dhd_msg_level & DHD_EVENT_VAL) printf args;} while (0)
178
+#define DHD_ECNTR_LOG(args)	DHD_EVENT(args)
179
+#define DHD_PRSRV_MEM(args)	DHD_EVENT(args)
180
+#define DHD_ERROR_EX(args)	DHD_ERROR(args)
181
+#endif /* DHD_LOG_DUMP */
182
+
42183 #define DHD_DATA(args)		do {if (dhd_msg_level & DHD_DATA_VAL) printf args;} while (0)
43184 #define DHD_CTL(args)		do {if (dhd_msg_level & DHD_CTL_VAL) printf args;} while (0)
44185 #define DHD_TIMER(args)		do {if (dhd_msg_level & DHD_TIMER_VAL) printf args;} while (0)
....@@ -46,22 +187,52 @@
46187 #define DHD_BYTES(args)		do {if (dhd_msg_level & DHD_BYTES_VAL) printf args;} while (0)
47188 #define DHD_INTR(args)		do {if (dhd_msg_level & DHD_INTR_VAL) printf args;} while (0)
48189 #define DHD_GLOM(args)		do {if (dhd_msg_level & DHD_GLOM_VAL) printf args;} while (0)
49
-#define DHD_EVENT(args)		do {if (dhd_msg_level & DHD_EVENT_VAL) printf args;} while (0)
50190 #define DHD_BTA(args)		do {if (dhd_msg_level & DHD_BTA_VAL) printf args;} while (0)
51191 #define DHD_ISCAN(args)		do {if (dhd_msg_level & DHD_ISCAN_VAL) printf args;} while (0)
52192 #define DHD_ARPOE(args)		do {if (dhd_msg_level & DHD_ARPOE_VAL) printf args;} while (0)
53193 #define DHD_REORDER(args)	do {if (dhd_msg_level & DHD_REORDER_VAL) printf args;} while (0)
54194 #define DHD_PNO(args)		do {if (dhd_msg_level & DHD_PNO_VAL) printf args;} while (0)
55
-#define DHD_MSGTRACE_LOG(args)  do {if (dhd_msg_level & DHD_MSGTRACE_VAL) printf args;} while (0)
56
-#define DHD_FWLOG(args)		do {if (dhd_msg_level & DHD_FWLOG_VAL) printf args;} while (0)
57195 #define DHD_RTT(args)		do {if (dhd_msg_level & DHD_RTT_VAL) printf args;} while (0)
196
+#define DHD_PKT_MON(args)	do {if (dhd_msg_level & DHD_PKT_MON_VAL) printf args;} while (0)
197
+
198
+#if defined(DHD_LOG_DUMP)
199
+#if defined(DHD_LOG_PRINT_RATE_LIMIT)
200
+#define DHD_FWLOG(args)	\
201
+	do { \
202
+		if (dhd_msg_level & DHD_FWLOG_VAL) { \
203
+			if (!log_print_threshold) \
204
+				printf args; \
205
+			DHD_LOG_DUMP_WRITE args; \
206
+		} \
207
+	} while (0)
208
+#else
209
+#define DHD_FWLOG(args)	\
210
+	do { \
211
+		if (dhd_msg_level & DHD_FWLOG_VAL) { \
212
+			printf args; \
213
+			DHD_LOG_DUMP_WRITE args; \
214
+		} \
215
+	} while (0)
216
+#endif // endif
217
+#else /* DHD_LOG_DUMP */
218
+#define DHD_FWLOG(args)		do {if (dhd_msg_level & DHD_FWLOG_VAL) printf args;} while (0)
219
+#endif /* DHD_LOG_DUMP */
220
+
58221 #define DHD_DBGIF(args)		do {if (dhd_msg_level & DHD_DBGIF_VAL) printf args;} while (0)
59222 
60
-/* To dump MAC registers in case of fatal errors */
61
-#define DHD_DUMP	DHD_ERROR
223
+#ifdef DHD_PCIE_NATIVE_RUNTIMEPM
224
+#define DHD_RPM(args)		do {if (dhd_msg_level & DHD_RPM_VAL) printf args;} while (0)
225
+#endif /* DHD_PCIE_NATIVE_RUNTIMEPM */
62226 
227
+#ifdef CUSTOMER_HW4_DEBUG
228
+#define DHD_TRACE_HW4	DHD_ERROR
229
+#define DHD_INFO_HW4	DHD_ERROR
230
+#define DHD_ERROR_NO_HW4	DHD_INFO
231
+#else
63232 #define DHD_TRACE_HW4	DHD_TRACE
64233 #define DHD_INFO_HW4	DHD_INFO
234
+#define DHD_ERROR_NO_HW4	DHD_ERROR
235
+#endif /* CUSTOMER_HW4_DEBUG */
65236 
66237 #define DHD_ERROR_ON()		(dhd_msg_level & DHD_ERROR_VAL)
67238 #define DHD_TRACE_ON()		(dhd_msg_level & DHD_TRACE_VAL)
....@@ -80,16 +251,23 @@
80251 #define DHD_REORDER_ON()	(dhd_msg_level & DHD_REORDER_VAL)
81252 #define DHD_NOCHECKDIED_ON()	(dhd_msg_level & DHD_NOCHECKDIED_VAL)
82253 #define DHD_PNO_ON()		(dhd_msg_level & DHD_PNO_VAL)
254
+#define DHD_RTT_ON()		(dhd_msg_level & DHD_RTT_VAL)
255
+#define DHD_MSGTRACE_ON()	(dhd_msg_level & DHD_MSGTRACE_VAL)
83256 #define DHD_FWLOG_ON()		(dhd_msg_level & DHD_FWLOG_VAL)
84257 #define DHD_DBGIF_ON()		(dhd_msg_level & DHD_DBGIF_VAL)
85
-#define DHD_RTT_ON()		(dhd_msg_level & DHD_RTT_VAL)
86
-#define DHD_DBG_BCNRX_ON()	(dhd_msg_level & DHD_DBG_BCNRX_VAL)
258
+#define DHD_PKT_MON_ON()	(dhd_msg_level & DHD_PKT_MON_VAL)
259
+#define DHD_PKT_MON_DUMP_ON()	(dhd_msg_level & DHD_PKT_MON_DUMP_VAL)
260
+#ifdef DHD_PCIE_NATIVE_RUNTIMEPM
261
+#define DHD_RPM_ON()		(dhd_msg_level & DHD_RPM_VAL)
262
+#endif /* DHD_PCIE_NATIVE_RUNTIMEPM */
87263 
88264 #else /* defined(BCMDBG) || defined(DHD_DEBUG) */
89265 
90
-#define DHD_ERROR(args)		do {if (USE_NET_RATELIMIT) printf args;} while (0)
266
+#define DHD_ERROR(args)		do {if (dhd_msg_level & DHD_ERROR_VAL) \
267
+								printf args;} while (0)
91268 #define DHD_TRACE(args)
92269 #define DHD_INFO(args)
270
+
93271 #define DHD_DATA(args)
94272 #define DHD_CTL(args)
95273 #define DHD_TIMER(args)
....@@ -97,19 +275,39 @@
97275 #define DHD_BYTES(args)
98276 #define DHD_INTR(args)
99277 #define DHD_GLOM(args)
278
+
100279 #define DHD_EVENT(args)
280
+#define DHD_ECNTR_LOG(args)	DHD_EVENT(args)
281
+
282
+#define DHD_PRSRV_MEM(args)	DHD_EVENT(args)
283
+
101284 #define DHD_BTA(args)
102285 #define DHD_ISCAN(args)
103286 #define DHD_ARPOE(args)
104287 #define DHD_REORDER(args)
105288 #define DHD_PNO(args)
289
+#define DHD_RTT(args)
290
+#define DHD_PKT_MON(args)
291
+
106292 #define DHD_MSGTRACE_LOG(args)
107293 #define DHD_FWLOG(args)
108
-#define DHD_RTT(args)
294
+
109295 #define DHD_DBGIF(args)
110296 
297
+#define DHD_ERROR_MEM(args)	DHD_ERROR(args)
298
+#define DHD_IOVAR_MEM(args)	DHD_ERROR(args)
299
+#define DHD_LOG_MEM(args)	DHD_ERROR(args)
300
+#define DHD_ERROR_EX(args)	DHD_ERROR(args)
301
+
302
+#ifdef CUSTOMER_HW4_DEBUG
303
+#define DHD_TRACE_HW4	DHD_ERROR
304
+#define DHD_INFO_HW4	DHD_ERROR
305
+#define DHD_ERROR_NO_HW4	DHD_INFO
306
+#else
111307 #define DHD_TRACE_HW4	DHD_TRACE
112308 #define DHD_INFO_HW4	DHD_INFO
309
+#define DHD_ERROR_NO_HW4	DHD_ERROR
310
+#endif /* CUSTOMER_HW4_DEBUG */
113311 
114312 #define DHD_ERROR_ON()		0
115313 #define DHD_TRACE_ON()		0
....@@ -128,11 +326,40 @@
128326 #define DHD_REORDER_ON()	0
129327 #define DHD_NOCHECKDIED_ON()	0
130328 #define DHD_PNO_ON()		0
329
+#define DHD_RTT_ON()		0
330
+#define DHD_PKT_MON_ON()	0
331
+#define DHD_PKT_MON_DUMP_ON()	0
332
+#define DHD_MSGTRACE_ON()	0
131333 #define DHD_FWLOG_ON()		0
132334 #define DHD_DBGIF_ON()		0
133
-#define DHD_RTT_ON()		0
134
-#define DHD_DBG_BCNRX_ON()	0
135
-#endif 
335
+#ifdef DHD_PCIE_NATIVE_RUNTIMEPM
336
+#define DHD_RPM_ON()		0
337
+#endif /* DHD_PCIE_NATIVE_RUNTIMEPM */
338
+#endif // endif
339
+
340
+#define PRINT_RATE_LIMIT_PERIOD 5000000u /* 5s in units of us */
341
+#define DHD_ERROR_RLMT(args) \
342
+do {	\
343
+	if (dhd_msg_level & DHD_ERROR_VAL) {	\
344
+		static uint64 __err_ts = 0; \
345
+		static uint32 __err_cnt = 0; \
346
+		uint64 __cur_ts = 0; \
347
+		__cur_ts = OSL_SYSUPTIME_US(); \
348
+		if (__err_ts == 0 || (__cur_ts > __err_ts && \
349
+		(__cur_ts - __err_ts > PRINT_RATE_LIMIT_PERIOD))) { \
350
+			__err_ts = __cur_ts; \
351
+			DHD_ERROR(args);	\
352
+			DHD_ERROR(("[Repeats %u times]\n", __err_cnt)); \
353
+			__err_cnt = 0; \
354
+		} else { \
355
+			++__err_cnt; \
356
+		} \
357
+	}	\
358
+} while (0)
359
+
360
+/* even in non-BCMDBG builds, logging of dongle iovars should be available */
361
+#define DHD_DNGL_IOVAR_SET(args) \
362
+	do {if (dhd_msg_level & DHD_DNGL_IOVAR_SET_VAL) printf args;} while (0)
136363 
137364 #define DHD_LOG(args)
138365 
....@@ -140,6 +367,12 @@
140367 
141368 #define DHD_NONE(args)
142369 extern int dhd_msg_level;
370
+#ifdef DHD_LOG_PRINT_RATE_LIMIT
371
+extern int log_print_threshold;
372
+#endif /* DHD_LOG_PRINT_RATE_LIMIT */
373
+
374
+#define DHD_RTT_MEM(args) DHD_LOG_MEM(args)
375
+#define DHD_RTT_ERR(args) DHD_ERROR(args)
143376 
144377 /* Defines msg bits */
145378 #include <dhdioctl.h>