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 "hif.h"
21 
22 enum ATH6K_DEBUG_MASK {
23 	ATH6KL_DBG_CREDIT	= BIT(0),
24 	/* hole */
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		= BIT(5),
29 	ATH6KL_DBG_HIF		= BIT(6),
30 	ATH6KL_DBG_IRQ		= BIT(7),     /* interrupt processing */
31 	/* hole */
32 	/* hole */
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 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_WMI_DUMP	= BIT(19),
43 	ATH6KL_DBG_SUSPEND	= BIT(20),
44 	ATH6KL_DBG_ANY	        = 0xffffffff  /* enable all logs */
45 };
46 
47 extern unsigned int debug_mask;
48 extern __printf(2, 3)
49 int ath6kl_printk(const char *level, const char *fmt, ...);
50 
51 #define ath6kl_info(fmt, ...)				\
52 	ath6kl_printk(KERN_INFO, fmt, ##__VA_ARGS__)
53 #define ath6kl_err(fmt, ...)					\
54 	ath6kl_printk(KERN_ERR, fmt, ##__VA_ARGS__)
55 #define ath6kl_warn(fmt, ...)					\
56 	ath6kl_printk(KERN_WARNING, fmt, ##__VA_ARGS__)
57 
58 #define AR_DBG_LVL_CHECK(mask)	(debug_mask & mask)
59 
60 enum ath6kl_war {
61 	ATH6KL_WAR_INVALID_RATE,
62 };
63 
64 #ifdef CONFIG_ATH6KL_DEBUG
65 #define ath6kl_dbg(mask, fmt, ...)					\
66 	({								\
67 	 int rtn;							\
68 	 if (debug_mask & mask)						\
69 		rtn = ath6kl_printk(KERN_DEBUG, fmt, ##__VA_ARGS__);	\
70 	 else								\
71 		rtn = 0;						\
72 									\
73 	 rtn;								\
74 	 })
75 
76 static inline void ath6kl_dbg_dump(enum ATH6K_DEBUG_MASK mask,
77 				   const char *msg, const char *prefix,
78 				   const void *buf, size_t len)
79 {
80 	if (debug_mask & mask) {
81 		if (msg)
82 			ath6kl_dbg(mask, "%s\n", msg);
83 
84 		print_hex_dump_bytes(prefix, DUMP_PREFIX_OFFSET, buf, len);
85 	}
86 }
87 
88 void ath6kl_dump_registers(struct ath6kl_device *dev,
89 			   struct ath6kl_irq_proc_registers *irq_proc_reg,
90 			   struct ath6kl_irq_enable_reg *irq_en_reg);
91 void dump_cred_dist_stats(struct htc_target *target);
92 void ath6kl_debug_fwlog_event(struct ath6kl *ar, const void *buf, size_t len);
93 void ath6kl_debug_war(struct ath6kl *ar, enum ath6kl_war war);
94 int ath6kl_debug_roam_tbl_event(struct ath6kl *ar, const void *buf,
95 				size_t len);
96 void ath6kl_debug_set_keepalive(struct ath6kl *ar, u8 keepalive);
97 void ath6kl_debug_set_disconnect_timeout(struct ath6kl *ar, u8 timeout);
98 int ath6kl_debug_init(struct ath6kl *ar);
99 void ath6kl_debug_cleanup(struct ath6kl *ar);
100 
101 #else
102 static inline int ath6kl_dbg(enum ATH6K_DEBUG_MASK dbg_mask,
103 			     const char *fmt, ...)
104 {
105 	return 0;
106 }
107 
108 static inline void ath6kl_dbg_dump(enum ATH6K_DEBUG_MASK mask,
109 				   const char *msg, const char *prefix,
110 				   const void *buf, size_t len)
111 {
112 }
113 
114 static inline void ath6kl_dump_registers(struct ath6kl_device *dev,
115 		struct ath6kl_irq_proc_registers *irq_proc_reg,
116 		struct ath6kl_irq_enable_reg *irq_en_reg)
117 {
118 
119 }
120 static inline void dump_cred_dist_stats(struct htc_target *target)
121 {
122 }
123 
124 static inline void ath6kl_debug_fwlog_event(struct ath6kl *ar,
125 					    const void *buf, size_t len)
126 {
127 }
128 
129 static inline void ath6kl_debug_war(struct ath6kl *ar, enum ath6kl_war war)
130 {
131 }
132 
133 static inline int ath6kl_debug_roam_tbl_event(struct ath6kl *ar,
134 					      const void *buf, size_t len)
135 {
136 	return 0;
137 }
138 
139 static inline void ath6kl_debug_set_keepalive(struct ath6kl *ar, u8 keepalive)
140 {
141 }
142 
143 static inline void ath6kl_debug_set_disconnect_timeout(struct ath6kl *ar,
144 						       u8 timeout)
145 {
146 }
147 
148 static inline int ath6kl_debug_init(struct ath6kl *ar)
149 {
150 	return 0;
151 }
152 
153 static inline void ath6kl_debug_cleanup(struct ath6kl *ar)
154 {
155 }
156 
157 #endif
158 #endif
159