xref: /openbmc/linux/drivers/net/wireless/ath/ath6kl/debug.h (revision 6bc364315aac6ab256ce3cdc00aa90cb57279a1f)
1 /*
2  * Copyright (c) 2011 Atheros Communications Inc.
3  *
4  * Permission to use, copy, modify, and/or distribute this software for any
5  * purpose with or without fee is hereby granted, provided that the above
6  * copyright notice and this permission notice appear in all copies.
7  *
8  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
15  */
16 
17 #ifndef DEBUG_H
18 #define DEBUG_H
19 
20 #include "htc_hif.h"
21 
22 enum ATH6K_DEBUG_MASK {
23 	ATH6KL_DBG_WLAN_CONNECT = BIT(0),     /* wlan connect */
24 	ATH6KL_DBG_WLAN_SCAN    = BIT(1),     /* wlan scan */
25 	ATH6KL_DBG_WLAN_TX      = BIT(2),     /* wlan tx */
26 	ATH6KL_DBG_WLAN_RX      = BIT(3),     /* wlan rx */
27 	ATH6KL_DBG_BMI		= BIT(4),     /* bmi tracing */
28 	ATH6KL_DBG_HTC_SEND     = BIT(5),     /* htc send */
29 	ATH6KL_DBG_HTC_RECV     = BIT(6),     /* htc recv */
30 	ATH6KL_DBG_IRQ		= BIT(7),     /* interrupt processing */
31 	ATH6KL_DBG_PM           = BIT(8),     /* power management */
32 	ATH6KL_DBG_WLAN_NODE    = BIT(9),     /* general wlan node tracing */
33 	ATH6KL_DBG_WMI          = BIT(10),    /* wmi tracing */
34 	ATH6KL_DBG_TRC	        = BIT(11),    /* generic func tracing */
35 	ATH6KL_DBG_SCATTER	= BIT(12),    /* hif scatter tracing */
36 	ATH6KL_DBG_WLAN_CFG     = BIT(13),    /* cfg80211 i/f file tracing */
37 	ATH6KL_DBG_RAW_BYTES    = BIT(14),    /* dump tx/rx and wmi frames */
38 	ATH6KL_DBG_AGGR		= BIT(15),    /* aggregation */
39 	ATH6KL_DBG_SDIO		= BIT(16),
40 	ATH6KL_DBG_SDIO_DUMP	= BIT(17),
41 	ATH6KL_DBG_BOOT		= BIT(18),    /* driver init and fw boot */
42 	ATH6KL_DBG_ANY	        = 0xffffffff  /* enable all logs */
43 };
44 
45 extern unsigned int debug_mask;
46 extern int ath6kl_printk(const char *level, const char *fmt, ...)
47 	__attribute__ ((format (printf, 2, 3)));
48 
49 #define ath6kl_info(fmt, ...)				\
50 	ath6kl_printk(KERN_INFO, fmt, ##__VA_ARGS__)
51 #define ath6kl_err(fmt, ...)					\
52 	ath6kl_printk(KERN_ERR, fmt, ##__VA_ARGS__)
53 #define ath6kl_warn(fmt, ...)					\
54 	ath6kl_printk(KERN_WARNING, fmt, ##__VA_ARGS__)
55 
56 #define AR_DBG_LVL_CHECK(mask)	(debug_mask & mask)
57 
58 enum ath6kl_war {
59 	ATH6KL_WAR_INVALID_RATE,
60 };
61 
62 #ifdef CONFIG_ATH6KL_DEBUG
63 #define ath6kl_dbg(mask, fmt, ...)					\
64 	({								\
65 	 int rtn;							\
66 	 if (debug_mask & mask)						\
67 		rtn = ath6kl_printk(KERN_DEBUG, fmt, ##__VA_ARGS__);	\
68 	 else								\
69 		rtn = 0;						\
70 									\
71 	 rtn;								\
72 	 })
73 
74 static inline void ath6kl_dbg_dump(enum ATH6K_DEBUG_MASK mask,
75 				   const char *msg, const char *prefix,
76 				   const void *buf, size_t len)
77 {
78 	if (debug_mask & mask) {
79 		if (msg)
80 			ath6kl_dbg(mask, "%s\n", msg);
81 
82 		print_hex_dump_bytes(prefix, DUMP_PREFIX_OFFSET, buf, len);
83 	}
84 }
85 
86 void ath6kl_dump_registers(struct ath6kl_device *dev,
87 			   struct ath6kl_irq_proc_registers *irq_proc_reg,
88 			   struct ath6kl_irq_enable_reg *irq_en_reg);
89 void dump_cred_dist_stats(struct htc_target *target);
90 void ath6kl_debug_fwlog_event(struct ath6kl *ar, const void *buf, size_t len);
91 void ath6kl_debug_war(struct ath6kl *ar, enum ath6kl_war war);
92 int ath6kl_debug_init(struct ath6kl *ar);
93 void ath6kl_debug_cleanup(struct ath6kl *ar);
94 
95 #else
96 static inline int ath6kl_dbg(enum ATH6K_DEBUG_MASK dbg_mask,
97 			     const char *fmt, ...)
98 {
99 	return 0;
100 }
101 
102 static inline void ath6kl_dbg_dump(enum ATH6K_DEBUG_MASK mask,
103 				   const char *msg, const char *prefix,
104 				   const void *buf, size_t len)
105 {
106 }
107 
108 static inline void ath6kl_dump_registers(struct ath6kl_device *dev,
109 		struct ath6kl_irq_proc_registers *irq_proc_reg,
110 		struct ath6kl_irq_enable_reg *irq_en_reg)
111 {
112 
113 }
114 static inline void dump_cred_dist_stats(struct htc_target *target)
115 {
116 }
117 
118 static inline void ath6kl_debug_fwlog_event(struct ath6kl *ar,
119 					    const void *buf, size_t len)
120 {
121 }
122 
123 static inline void ath6kl_debug_war(struct ath6kl *ar, enum ath6kl_war war)
124 {
125 }
126 
127 static inline int ath6kl_debug_init(struct ath6kl *ar)
128 {
129 	return 0;
130 }
131 
132 static inline void ath6kl_debug_cleanup(struct ath6kl *ar)
133 {
134 }
135 
136 #endif
137 #endif
138