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 enum ath6kl_war {
59 	ATH6KL_WAR_INVALID_RATE,
60 };
61 
62 #ifdef CONFIG_ATH6KL_DEBUG
63 
64 void ath6kl_dbg(enum ATH6K_DEBUG_MASK mask, const char *fmt, ...);
65 void ath6kl_dbg_dump(enum ATH6K_DEBUG_MASK mask,
66 		     const char *msg, const char *prefix,
67 		     const void *buf, size_t len);
68 
69 void ath6kl_dump_registers(struct ath6kl_device *dev,
70 			   struct ath6kl_irq_proc_registers *irq_proc_reg,
71 			   struct ath6kl_irq_enable_reg *irq_en_reg);
72 void dump_cred_dist_stats(struct htc_target *target);
73 void ath6kl_debug_fwlog_event(struct ath6kl *ar, const void *buf, size_t len);
74 void ath6kl_debug_war(struct ath6kl *ar, enum ath6kl_war war);
75 int ath6kl_debug_roam_tbl_event(struct ath6kl *ar, const void *buf,
76 				size_t len);
77 void ath6kl_debug_set_keepalive(struct ath6kl *ar, u8 keepalive);
78 void ath6kl_debug_set_disconnect_timeout(struct ath6kl *ar, u8 timeout);
79 int ath6kl_debug_init(struct ath6kl *ar);
80 void ath6kl_debug_cleanup(struct ath6kl *ar);
81 
82 #else
83 static inline int ath6kl_dbg(enum ATH6K_DEBUG_MASK dbg_mask,
84 			     const char *fmt, ...)
85 {
86 	return 0;
87 }
88 
89 static inline void ath6kl_dbg_dump(enum ATH6K_DEBUG_MASK mask,
90 				   const char *msg, const char *prefix,
91 				   const void *buf, size_t len)
92 {
93 }
94 
95 static inline void ath6kl_dump_registers(struct ath6kl_device *dev,
96 		struct ath6kl_irq_proc_registers *irq_proc_reg,
97 		struct ath6kl_irq_enable_reg *irq_en_reg)
98 {
99 
100 }
101 static inline void dump_cred_dist_stats(struct htc_target *target)
102 {
103 }
104 
105 static inline void ath6kl_debug_fwlog_event(struct ath6kl *ar,
106 					    const void *buf, size_t len)
107 {
108 }
109 
110 static inline void ath6kl_debug_war(struct ath6kl *ar, enum ath6kl_war war)
111 {
112 }
113 
114 static inline int ath6kl_debug_roam_tbl_event(struct ath6kl *ar,
115 					      const void *buf, size_t len)
116 {
117 	return 0;
118 }
119 
120 static inline void ath6kl_debug_set_keepalive(struct ath6kl *ar, u8 keepalive)
121 {
122 }
123 
124 static inline void ath6kl_debug_set_disconnect_timeout(struct ath6kl *ar,
125 						       u8 timeout)
126 {
127 }
128 
129 static inline int ath6kl_debug_init(struct ath6kl *ar)
130 {
131 	return 0;
132 }
133 
134 static inline void ath6kl_debug_cleanup(struct ath6kl *ar)
135 {
136 }
137 
138 #endif
139 #endif
140