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 #include "trace.h"
23 
24 enum ATH6K_DEBUG_MASK {
25 	ATH6KL_DBG_CREDIT	= BIT(0),
26 	/* hole */
27 	ATH6KL_DBG_WLAN_TX      = BIT(2),     /* wlan tx */
28 	ATH6KL_DBG_WLAN_RX      = BIT(3),     /* wlan rx */
29 	ATH6KL_DBG_BMI		= BIT(4),     /* bmi tracing */
30 	ATH6KL_DBG_HTC		= BIT(5),
31 	ATH6KL_DBG_HIF		= BIT(6),
32 	ATH6KL_DBG_IRQ		= BIT(7),     /* interrupt processing */
33 	/* hole */
34 	/* hole */
35 	ATH6KL_DBG_WMI          = BIT(10),    /* wmi tracing */
36 	ATH6KL_DBG_TRC	        = BIT(11),    /* generic func tracing */
37 	ATH6KL_DBG_SCATTER	= BIT(12),    /* hif scatter tracing */
38 	ATH6KL_DBG_WLAN_CFG     = BIT(13),    /* cfg80211 i/f file tracing */
39 	ATH6KL_DBG_RAW_BYTES    = BIT(14),    /* dump tx/rx frames */
40 	ATH6KL_DBG_AGGR		= BIT(15),    /* aggregation */
41 	ATH6KL_DBG_SDIO		= BIT(16),
42 	ATH6KL_DBG_SDIO_DUMP	= BIT(17),
43 	ATH6KL_DBG_BOOT		= BIT(18),    /* driver init and fw boot */
44 	ATH6KL_DBG_WMI_DUMP	= BIT(19),
45 	ATH6KL_DBG_SUSPEND	= BIT(20),
46 	ATH6KL_DBG_USB		= BIT(21),
47 	ATH6KL_DBG_USB_BULK	= BIT(22),
48 	ATH6KL_DBG_RECOVERY	= BIT(23),
49 	ATH6KL_DBG_ANY	        = 0xffffffff  /* enable all logs */
50 };
51 
52 extern unsigned int debug_mask;
53 __printf(2, 3) int ath6kl_printk(const char *level, const char *fmt, ...);
54 __printf(1, 2) int ath6kl_info(const char *fmt, ...);
55 __printf(1, 2) int ath6kl_err(const char *fmt, ...);
56 __printf(1, 2) int ath6kl_warn(const char *fmt, ...);
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 void ath6kl_debug_init(struct ath6kl *ar);
80 int ath6kl_debug_init_fs(struct ath6kl *ar);
81 void ath6kl_debug_cleanup(struct ath6kl *ar);
82 
83 #else
84 static inline int ath6kl_dbg(enum ATH6K_DEBUG_MASK dbg_mask,
85 			     const char *fmt, ...)
86 {
87 	return 0;
88 }
89 
90 static inline void ath6kl_dbg_dump(enum ATH6K_DEBUG_MASK mask,
91 				   const char *msg, const char *prefix,
92 				   const void *buf, size_t len)
93 {
94 }
95 
96 static inline void ath6kl_dump_registers(struct ath6kl_device *dev,
97 		struct ath6kl_irq_proc_registers *irq_proc_reg,
98 		struct ath6kl_irq_enable_reg *irq_en_reg)
99 {
100 }
101 
102 static inline void dump_cred_dist_stats(struct htc_target *target)
103 {
104 }
105 
106 static inline void ath6kl_debug_fwlog_event(struct ath6kl *ar,
107 					    const void *buf, size_t len)
108 {
109 }
110 
111 static inline void ath6kl_debug_war(struct ath6kl *ar, enum ath6kl_war war)
112 {
113 }
114 
115 static inline int ath6kl_debug_roam_tbl_event(struct ath6kl *ar,
116 					      const void *buf, size_t len)
117 {
118 	return 0;
119 }
120 
121 static inline void ath6kl_debug_set_keepalive(struct ath6kl *ar, u8 keepalive)
122 {
123 }
124 
125 static inline void ath6kl_debug_set_disconnect_timeout(struct ath6kl *ar,
126 						       u8 timeout)
127 {
128 }
129 
130 static inline void ath6kl_debug_init(struct ath6kl *ar)
131 {
132 }
133 
134 static inline int ath6kl_debug_init_fs(struct ath6kl *ar)
135 {
136 	return 0;
137 }
138 
139 static inline void ath6kl_debug_cleanup(struct ath6kl *ar)
140 {
141 }
142 
143 #endif
144 #endif
145