xref: /freebsd/sys/contrib/dev/rtw89/debug.h (revision a466cc55373fc3cf86837f09da729535b57e69a1)
1 /* SPDX-License-Identifier: GPL-2.0 OR BSD-3-Clause */
2 /* Copyright(c) 2019-2020  Realtek Corporation
3  */
4 
5 #ifndef __RTW89_DEBUG_H__
6 #define __RTW89_DEBUG_H__
7 
8 #include "core.h"
9 
10 #if defined(__FreeBSD__)
11 #include <linux/printk.h>
12 #ifndef	DUMP_PREFIX_OFFSET
13 #define	DUMP_PREFIX_OFFSET	0
14 #endif
15 #endif
16 
17 enum rtw89_debug_mask {
18 	RTW89_DBG_TXRX = BIT(0),
19 	RTW89_DBG_RFK = BIT(1),
20 	RTW89_DBG_RFK_TRACK = BIT(2),
21 	RTW89_DBG_CFO = BIT(3),
22 	RTW89_DBG_TSSI = BIT(4),
23 	RTW89_DBG_TXPWR = BIT(5),
24 	RTW89_DBG_HCI = BIT(6),
25 	RTW89_DBG_RA = BIT(7),
26 	RTW89_DBG_REGD = BIT(8),
27 	RTW89_DBG_PHY_TRACK = BIT(9),
28 	RTW89_DBG_DIG = BIT(10),
29 	RTW89_DBG_SER = BIT(11),
30 	RTW89_DBG_FW = BIT(12),
31 	RTW89_DBG_BTC = BIT(13),
32 	RTW89_DBG_BF = BIT(14),
33 	RTW89_DBG_HW_SCAN = BIT(15),
34 	RTW89_DBG_SAR = BIT(16),
35 
36 #if defined(__FreeBSD__)
37 	RTW89_DBG_IO_RW = BIT(30),
38 #endif
39 	RTW89_DBG_UNEXP = BIT(31),
40 };
41 
42 enum rtw89_debug_mac_reg_sel {
43 	RTW89_DBG_SEL_MAC_00,
44 	RTW89_DBG_SEL_MAC_30,
45 	RTW89_DBG_SEL_MAC_40,
46 	RTW89_DBG_SEL_MAC_80,
47 	RTW89_DBG_SEL_MAC_C0,
48 	RTW89_DBG_SEL_MAC_E0,
49 	RTW89_DBG_SEL_BB,
50 	RTW89_DBG_SEL_IQK,
51 	RTW89_DBG_SEL_RFC,
52 };
53 
54 #ifdef CONFIG_RTW89_DEBUGFS
55 void rtw89_debugfs_init(struct rtw89_dev *rtwdev);
56 #else
57 static inline void rtw89_debugfs_init(struct rtw89_dev *rtwdev) {}
58 #endif
59 
60 #define rtw89_info(rtwdev, a...) dev_info((rtwdev)->dev, ##a)
61 #define rtw89_warn(rtwdev, a...) dev_warn((rtwdev)->dev, ##a)
62 #define rtw89_err(rtwdev, a...) dev_err((rtwdev)->dev, ##a)
63 
64 #ifdef CONFIG_RTW89_DEBUGMSG
65 extern unsigned int rtw89_debug_mask;
66 #define rtw89_debug(rtwdev, a...) __rtw89_debug(rtwdev, ##a)
67 
68 __printf(3, 4)
69 void __rtw89_debug(struct rtw89_dev *rtwdev,
70 		   enum rtw89_debug_mask mask,
71 		   const char *fmt, ...);
72 static inline void rtw89_hex_dump(struct rtw89_dev *rtwdev,
73 				  enum rtw89_debug_mask mask,
74 				  const char *prefix_str,
75 				  const void *buf, size_t len)
76 {
77 	if (!(rtw89_debug_mask & mask))
78 		return;
79 
80 	print_hex_dump_bytes(prefix_str, DUMP_PREFIX_OFFSET, buf, len);
81 }
82 #else
83 static inline void rtw89_debug(struct rtw89_dev *rtwdev,
84 			       enum rtw89_debug_mask mask,
85 			       const char *fmt, ...) {}
86 static inline void rtw89_hex_dump(struct rtw89_dev *rtwdev,
87 				  enum rtw89_debug_mask mask,
88 				  const char *prefix_str,
89 				  const void *buf, size_t len) {}
90 #endif
91 
92 #endif
93