2 * Copyright (c) 2007 Bruno Randolf <bruno@thinktube.com>
4 * This file is free software: you may copy, redistribute and/or modify it
5 * under the terms of the GNU General Public License as published by the
6 * Free Software Foundation, either version 2 of the License, or (at your
7 * option) any later version.
9 * This file is distributed in the hope that it will be useful, but
10 * WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program. If not, see <http://www.gnu.org/licenses/>.
18 * This file incorporates work covered by the following copyright and
21 * Copyright (c) 2002-2005 Sam Leffler, Errno Consulting
22 * Copyright (c) 2004-2005 Atheros Communications, Inc.
23 * Copyright (c) 2006 Devicescape Software, Inc.
24 * Copyright (c) 2007 Jiri Slaby <jirislaby@gmail.com>
25 * Copyright (c) 2007 Luis R. Rodriguez <mcgrof@winlab.rutgers.edu>
27 * All rights reserved.
29 * Redistribution and use in source and binary forms, with or without
30 * modification, are permitted provided that the following conditions
32 * 1. Redistributions of source code must retain the above copyright
33 * notice, this list of conditions and the following disclaimer,
34 * without modification.
35 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
36 * similar to the "NO WARRANTY" disclaimer below ("Disclaimer") and any
37 * redistribution must be conditioned upon including a substantially
38 * similar Disclaimer requirement for further binary redistribution.
39 * 3. Neither the names of the above-listed copyright holders nor the names
40 * of any contributors may be used to endorse or promote products derived
41 * from this software without specific prior written permission.
43 * Alternatively, this software may be distributed under the terms of the
44 * GNU General Public License ("GPL") version 2 as published by the Free
45 * Software Foundation.
48 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
49 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
50 * LIMITED TO, THE IMPLIED WARRANTIES OF NONINFRINGEMENT, MERCHANTIBILITY
51 * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
52 * THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY,
53 * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
54 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
55 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
56 * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
57 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
58 * THE POSSIBILITY OF SUCH DAMAGES.
61 #ifndef _ATH5K_DEBUG_H
62 #define _ATH5K_DEBUG_H
69 struct ath5k_dbg_info {
70 unsigned int level; /* debug level */
72 struct dentry *debugfs_phydir;
73 struct dentry *debugfs_debug;
74 struct dentry *debugfs_registers;
75 struct dentry *debugfs_beacon;
76 struct dentry *debugfs_reset;
77 struct dentry *debugfs_antenna;
78 struct dentry *debugfs_frameerrors;
79 struct dentry *debugfs_ani;
80 struct dentry *debugfs_queue;
84 * enum ath5k_debug_level - ath5k debug level
86 * @ATH5K_DEBUG_RESET: reset processing
87 * @ATH5K_DEBUG_INTR: interrupt handling
88 * @ATH5K_DEBUG_MODE: mode init/setup
89 * @ATH5K_DEBUG_XMIT: basic xmit operation
90 * @ATH5K_DEBUG_BEACON: beacon handling
91 * @ATH5K_DEBUG_CALIBRATE: periodic calibration
92 * @ATH5K_DEBUG_TXPOWER: transmit power setting
93 * @ATH5K_DEBUG_LED: led management
94 * @ATH5K_DEBUG_DUMP_RX: print received skb content
95 * @ATH5K_DEBUG_DUMP_TX: print transmit skb content
96 * @ATH5K_DEBUG_DUMPBANDS: dump bands
97 * @ATH5K_DEBUG_TRACE: trace function calls
98 * @ATH5K_DEBUG_ANY: show at any debug level
100 * The debug level is used to control the amount and type of debugging output
101 * we want to see. The debug level is given in calls to ATH5K_DBG to specify
102 * where the message should appear, and the user can control the debugging
103 * messages he wants to see, either by the module parameter 'debug' on module
104 * load, or dynamically by using debugfs 'ath5k/phyX/debug'. these levels can
105 * be combined together by bitwise OR.
107 enum ath5k_debug_level {
108 ATH5K_DEBUG_RESET = 0x00000001,
109 ATH5K_DEBUG_INTR = 0x00000002,
110 ATH5K_DEBUG_MODE = 0x00000004,
111 ATH5K_DEBUG_XMIT = 0x00000008,
112 ATH5K_DEBUG_BEACON = 0x00000010,
113 ATH5K_DEBUG_CALIBRATE = 0x00000020,
114 ATH5K_DEBUG_TXPOWER = 0x00000040,
115 ATH5K_DEBUG_LED = 0x00000080,
116 ATH5K_DEBUG_DUMP_RX = 0x00000100,
117 ATH5K_DEBUG_DUMP_TX = 0x00000200,
118 ATH5K_DEBUG_DUMPBANDS = 0x00000400,
119 ATH5K_DEBUG_ANI = 0x00002000,
120 ATH5K_DEBUG_ANY = 0xffffffff
123 #ifdef CONFIG_ATH5K_DEBUG
125 #define ATH5K_DBG(_sc, _m, _fmt, ...) do { \
126 if (unlikely((_sc)->debug.level & (_m) && net_ratelimit())) \
127 ATH5K_PRINTK(_sc, KERN_DEBUG, "(%s:%d): " _fmt, \
128 __func__, __LINE__, ##__VA_ARGS__); \
131 #define ATH5K_DBG_UNLIMIT(_sc, _m, _fmt, ...) do { \
132 if (unlikely((_sc)->debug.level & (_m))) \
133 ATH5K_PRINTK(_sc, KERN_DEBUG, "(%s:%d): " _fmt, \
134 __func__, __LINE__, ##__VA_ARGS__); \
138 ath5k_debug_init(void);
141 ath5k_debug_init_device(struct ath5k_softc *sc);
144 ath5k_debug_finish(void);
147 ath5k_debug_finish_device(struct ath5k_softc *sc);
150 ath5k_debug_printrxbuffs(struct ath5k_softc *sc, struct ath5k_hw *ah);
153 ath5k_debug_dump_bands(struct ath5k_softc *sc);
156 ath5k_debug_dump_skb(struct ath5k_softc *sc,
157 struct sk_buff *skb, const char *prefix, int tx);
160 ath5k_debug_printtxbuf(struct ath5k_softc *sc, struct ath5k_buf *bf);
162 #else /* no debugging */
164 #include <linux/compiler.h>
166 static inline void __attribute__ ((format (printf, 3, 4)))
167 ATH5K_DBG(struct ath5k_softc *sc, unsigned int m, const char *fmt, ...) {}
169 static inline void __attribute__ ((format (printf, 3, 4)))
170 ATH5K_DBG_UNLIMIT(struct ath5k_softc *sc, unsigned int m, const char *fmt, ...)
174 ath5k_debug_init(void) {}
177 ath5k_debug_init_device(struct ath5k_softc *sc) {}
180 ath5k_debug_finish(void) {}
183 ath5k_debug_finish_device(struct ath5k_softc *sc) {}
186 ath5k_debug_printrxbuffs(struct ath5k_softc *sc, struct ath5k_hw *ah) {}
189 ath5k_debug_dump_bands(struct ath5k_softc *sc) {}
192 ath5k_debug_dump_skb(struct ath5k_softc *sc,
193 struct sk_buff *skb, const char *prefix, int tx) {}
196 ath5k_debug_printtxbuf(struct ath5k_softc *sc, struct ath5k_buf *bf) {}
198 #endif /* ifdef CONFIG_ATH5K_DEBUG */
200 #endif /* ifndef _ATH5K_DEBUG_H */