1 /*
2  * Copyright (c) 2011 Atheros Communications Inc.
3  * Copyright (c) 2011-2012 Qualcomm Atheros, Inc.
4  *
5  * Permission to use, copy, modify, and/or distribute this software for any
6  * purpose with or without fee is hereby granted, provided that the above
7  * copyright notice and this permission notice appear in all copies.
8  *
9  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16  */
17 
18 #ifndef DEBUG_H
19 #define DEBUG_H
20 
21 #include "hif.h"
22 
23 enum ATH6K_DEBUG_MASK {
24 	ATH6KL_DBG_CREDIT	= BIT(0),
25 	/* hole */
26 	ATH6KL_DBG_WLAN_TX      = BIT(2),     /* wlan tx */
27 	ATH6KL_DBG_WLAN_RX      = BIT(3),     /* wlan rx */
28 	ATH6KL_DBG_BMI		= BIT(4),     /* bmi tracing */
29 	ATH6KL_DBG_HTC		= BIT(5),
30 	ATH6KL_DBG_HIF		= BIT(6),
31 	ATH6KL_DBG_IRQ		= BIT(7),     /* interrupt processing */
32 	/* hole */
33 	/* hole */
34 	ATH6KL_DBG_WMI          = BIT(10),    /* wmi tracing */
35 	ATH6KL_DBG_TRC	        = BIT(11),    /* generic func tracing */
36 	ATH6KL_DBG_SCATTER	= BIT(12),    /* hif scatter tracing */
37 	ATH6KL_DBG_WLAN_CFG     = BIT(13),    /* cfg80211 i/f file tracing */
38 	ATH6KL_DBG_RAW_BYTES    = BIT(14),    /* dump tx/rx frames */
39 	ATH6KL_DBG_AGGR		= BIT(15),    /* aggregation */
40 	ATH6KL_DBG_SDIO		= BIT(16),
41 	ATH6KL_DBG_SDIO_DUMP	= BIT(17),
42 	ATH6KL_DBG_BOOT		= BIT(18),    /* driver init and fw boot */
43 	ATH6KL_DBG_WMI_DUMP	= BIT(19),
44 	ATH6KL_DBG_SUSPEND	= BIT(20),
45 	ATH6KL_DBG_USB		= BIT(21),
46 	ATH6KL_DBG_ANY	        = 0xffffffff  /* enable all logs */
47 };
48 
49 extern unsigned int debug_mask;
50 extern __printf(2, 3)
51 int ath6kl_printk(const char *level, const char *fmt, ...);
52 
53 #define ath6kl_info(fmt, ...)				\
54 	ath6kl_printk(KERN_INFO, fmt, ##__VA_ARGS__)
55 #define ath6kl_err(fmt, ...)					\
56 	ath6kl_printk(KERN_ERR, fmt, ##__VA_ARGS__)
57 #define ath6kl_warn(fmt, ...)					\
58 	ath6kl_printk(KERN_WARNING, fmt, ##__VA_ARGS__)
59 
60 enum ath6kl_war {
61 	ATH6KL_WAR_INVALID_RATE,
62 };
63 
64 #ifdef CONFIG_ATH6KL_DEBUG
65 
66 void ath6kl_dbg(enum ATH6K_DEBUG_MASK mask, const char *fmt, ...);
67 void ath6kl_dbg_dump(enum ATH6K_DEBUG_MASK mask,
68 		     const char *msg, const char *prefix,
69 		     const void *buf, size_t len);
70 
71 void ath6kl_dump_registers(struct ath6kl_device *dev,
72 			   struct ath6kl_irq_proc_registers *irq_proc_reg,
73 			   struct ath6kl_irq_enable_reg *irq_en_reg);
74 void dump_cred_dist_stats(struct htc_target *target);
75 void ath6kl_debug_fwlog_event(struct ath6kl *ar, const void *buf, size_t len);
76 void ath6kl_debug_war(struct ath6kl *ar, enum ath6kl_war war);
77 int ath6kl_debug_roam_tbl_event(struct ath6kl *ar, const void *buf,
78 				size_t len);
79 void ath6kl_debug_set_keepalive(struct ath6kl *ar, u8 keepalive);
80 void ath6kl_debug_set_disconnect_timeout(struct ath6kl *ar, u8 timeout);
81 void ath6kl_debug_init(struct ath6kl *ar);
82 int ath6kl_debug_init_fs(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 char *prefix,
94 				   const void *buf, 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 void ath6kl_debug_war(struct ath6kl *ar, enum ath6kl_war war)
114 {
115 }
116 
117 static inline int ath6kl_debug_roam_tbl_event(struct ath6kl *ar,
118 					      const void *buf, size_t len)
119 {
120 	return 0;
121 }
122 
123 static inline void ath6kl_debug_set_keepalive(struct ath6kl *ar, u8 keepalive)
124 {
125 }
126 
127 static inline void ath6kl_debug_set_disconnect_timeout(struct ath6kl *ar,
128 						       u8 timeout)
129 {
130 }
131 
132 static inline void ath6kl_debug_init(struct ath6kl *ar)
133 {
134 }
135 
136 static inline int ath6kl_debug_init_fs(struct ath6kl *ar)
137 {
138 	return 0;
139 }
140 
141 static inline void ath6kl_debug_cleanup(struct ath6kl *ar)
142 {
143 }
144 
145 #endif
146 #endif
147