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