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_ANY	        = 0xffffffff  /* enable all logs */
40 };
41 
42 extern unsigned int debug_mask;
43 extern int ath6kl_printk(const char *level, const char *fmt, ...)
44 	__attribute__ ((format (printf, 2, 3)));
45 
46 #define ath6kl_info(fmt, ...)				\
47 	ath6kl_printk(KERN_INFO, fmt, ##__VA_ARGS__)
48 #define ath6kl_err(fmt, ...)					\
49 	ath6kl_printk(KERN_ERR, fmt, ##__VA_ARGS__)
50 #define ath6kl_warn(fmt, ...)					\
51 	ath6kl_printk(KERN_WARNING, fmt, ##__VA_ARGS__)
52 
53 #define AR_DBG_LVL_CHECK(mask)	(debug_mask & mask)
54 
55 #ifdef CONFIG_ATH6KL_DEBUG
56 #define ath6kl_dbg(mask, fmt, ...)					\
57 	({								\
58 	 int rtn;							\
59 	 if (debug_mask & mask)						\
60 		rtn = ath6kl_printk(KERN_DEBUG, fmt, ##__VA_ARGS__);	\
61 	 else								\
62 		rtn = 0;						\
63 									\
64 	 rtn;								\
65 	 })
66 
67 static inline void ath6kl_dbg_dump(enum ATH6K_DEBUG_MASK mask,
68 				   const char *msg, const void *buf,
69 				   size_t len)
70 {
71 	if (debug_mask & mask) {
72 		ath6kl_dbg(mask, "%s\n", msg);
73 		print_hex_dump_bytes("", DUMP_PREFIX_OFFSET, buf, len);
74 	}
75 }
76 
77 void ath6kl_dump_registers(struct ath6kl_device *dev,
78 			   struct ath6kl_irq_proc_registers *irq_proc_reg,
79 			   struct ath6kl_irq_enable_reg *irq_en_reg);
80 void dump_cred_dist_stats(struct htc_target *target);
81 void ath6kl_debug_fwlog_event(struct ath6kl *ar, const void *buf, size_t len);
82 int ath6kl_debug_init(struct ath6kl *ar);
83 void ath6kl_debug_cleanup(struct ath6kl *ar);
84 
85 #else
86 static inline int ath6kl_dbg(enum ATH6K_DEBUG_MASK dbg_mask,
87 			     const char *fmt, ...)
88 {
89 	return 0;
90 }
91 
92 static inline void ath6kl_dbg_dump(enum ATH6K_DEBUG_MASK mask,
93 				   const char *msg, const void *buf,
94 				   size_t len)
95 {
96 }
97 
98 static inline void ath6kl_dump_registers(struct ath6kl_device *dev,
99 		struct ath6kl_irq_proc_registers *irq_proc_reg,
100 		struct ath6kl_irq_enable_reg *irq_en_reg)
101 {
102 
103 }
104 static inline void dump_cred_dist_stats(struct htc_target *target)
105 {
106 }
107 
108 static inline void ath6kl_debug_fwlog_event(struct ath6kl *ar,
109 					    const void *buf, size_t len)
110 {
111 }
112 
113 static inline int ath6kl_debug_init(struct ath6kl *ar)
114 {
115 	return 0;
116 }
117 
118 static inline void ath6kl_debug_cleanup(struct ath6kl *ar)
119 {
120 }
121 
122 #endif
123 #endif
124