1/* 2 * Copyright (c) 2007 Bruno Randolf <bruno@thinktube.com> 3 * 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. 8 * 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. 13 * 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/>. 16 * 17 * 18 * This file incorporates work covered by the following copyright and 19 * permission notice: 20 * 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> 26 * 27 * All rights reserved. 28 * 29 * Redistribution and use in source and binary forms, with or without 30 * modification, are permitted provided that the following conditions 31 * are met: 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. 42 * 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. 46 * 47 * NO WARRANTY 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. 59 */ 60 61#ifndef _ATH5K_DEBUG_H 62#define _ATH5K_DEBUG_H 63 64struct ath5k_softc; 65struct ath5k_hw; 66struct sk_buff; 67struct ath5k_buf; 68 69struct ath5k_dbg_info { 70 unsigned int level; /* debug level */ 71 /* debugfs entries */ 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}; 78 79/** 80 * enum ath5k_debug_level - ath5k debug level 81 * 82 * @ATH5K_DEBUG_RESET: reset processing 83 * @ATH5K_DEBUG_INTR: interrupt handling 84 * @ATH5K_DEBUG_MODE: mode init/setup 85 * @ATH5K_DEBUG_XMIT: basic xmit operation 86 * @ATH5K_DEBUG_BEACON: beacon handling 87 * @ATH5K_DEBUG_CALIBRATE: periodic calibration 88 * @ATH5K_DEBUG_TXPOWER: transmit power setting 89 * @ATH5K_DEBUG_LED: led management 90 * @ATH5K_DEBUG_DUMP_RX: print received skb content 91 * @ATH5K_DEBUG_DUMP_TX: print transmit skb content 92 * @ATH5K_DEBUG_DUMPBANDS: dump bands 93 * @ATH5K_DEBUG_TRACE: trace function calls 94 * @ATH5K_DEBUG_ANY: show at any debug level 95 * 96 * The debug level is used to control the amount and type of debugging output 97 * we want to see. The debug level is given in calls to ATH5K_DBG to specify 98 * where the message should appear, and the user can control the debugging 99 * messages he wants to see, either by the module parameter 'debug' on module 100 * load, or dynamically by using debugfs 'ath5k/phyX/debug'. these levels can 101 * be combined together by bitwise OR. 102 */ 103enum ath5k_debug_level { 104 ATH5K_DEBUG_RESET = 0x00000001, 105 ATH5K_DEBUG_INTR = 0x00000002, 106 ATH5K_DEBUG_MODE = 0x00000004, 107 ATH5K_DEBUG_XMIT = 0x00000008, 108 ATH5K_DEBUG_BEACON = 0x00000010, 109 ATH5K_DEBUG_CALIBRATE = 0x00000020, 110 ATH5K_DEBUG_TXPOWER = 0x00000040, 111 ATH5K_DEBUG_LED = 0x00000080, 112 ATH5K_DEBUG_DUMP_RX = 0x00000100, 113 ATH5K_DEBUG_DUMP_TX = 0x00000200, 114 ATH5K_DEBUG_DUMPBANDS = 0x00000400, 115 ATH5K_DEBUG_TRACE = 0x00001000, 116 ATH5K_DEBUG_ANY = 0xffffffff 117}; 118 119#ifdef CONFIG_ATH5K_DEBUG 120 121#define ATH5K_TRACE(_sc) do { \ 122 if (unlikely((_sc)->debug.level & ATH5K_DEBUG_TRACE)) \ 123 printk(KERN_DEBUG "ath5k trace %s:%d\n", __func__, __LINE__); \ 124 } while (0) 125 126#define ATH5K_DBG(_sc, _m, _fmt, ...) do { \ 127 if (unlikely((_sc)->debug.level & (_m) && net_ratelimit())) \ 128 ATH5K_PRINTK(_sc, KERN_DEBUG, "(%s:%d): " _fmt, \ 129 __func__, __LINE__, ##__VA_ARGS__); \ 130 } while (0) 131 132#define ATH5K_DBG_UNLIMIT(_sc, _m, _fmt, ...) do { \ 133 if (unlikely((_sc)->debug.level & (_m))) \ 134 ATH5K_PRINTK(_sc, KERN_DEBUG, "(%s:%d): " _fmt, \ 135 __func__, __LINE__, ##__VA_ARGS__); \ 136 } while (0) 137 138void 139ath5k_debug_init(void); 140 141void 142ath5k_debug_init_device(struct ath5k_softc *sc); 143 144void 145ath5k_debug_finish(void); 146 147void 148ath5k_debug_finish_device(struct ath5k_softc *sc); 149 150void 151ath5k_debug_printrxbuffs(struct ath5k_softc *sc, struct ath5k_hw *ah); 152 153void 154ath5k_debug_dump_bands(struct ath5k_softc *sc); 155 156void 157ath5k_debug_dump_skb(struct ath5k_softc *sc, 158 struct sk_buff *skb, const char *prefix, int tx); 159 160void 161ath5k_debug_printtxbuf(struct ath5k_softc *sc, struct ath5k_buf *bf); 162 163#else /* no debugging */ 164 165#include <linux/compiler.h> 166 167#define ATH5K_TRACE(_sc) typecheck(struct ath5k_softc *, (_sc)) 168 169static inline void __attribute__ ((format (printf, 3, 4))) 170ATH5K_DBG(struct ath5k_softc *sc, unsigned int m, const char *fmt, ...) {} 171 172static inline void __attribute__ ((format (printf, 3, 4))) 173ATH5K_DBG_UNLIMIT(struct ath5k_softc *sc, unsigned int m, const char *fmt, ...) 174{} 175 176static inline void 177ath5k_debug_init(void) {} 178 179static inline void 180ath5k_debug_init_device(struct ath5k_softc *sc) {} 181 182static inline void 183ath5k_debug_finish(void) {} 184 185static inline void 186ath5k_debug_finish_device(struct ath5k_softc *sc) {} 187 188static inline void 189ath5k_debug_printrxbuffs(struct ath5k_softc *sc, struct ath5k_hw *ah) {} 190 191static inline void 192ath5k_debug_dump_bands(struct ath5k_softc *sc) {} 193 194static inline void 195ath5k_debug_dump_skb(struct ath5k_softc *sc, 196 struct sk_buff *skb, const char *prefix, int tx) {} 197 198static inline void 199ath5k_debug_printtxbuf(struct ath5k_softc *sc, struct ath5k_buf *bf) {} 200 201#endif /* ifdef CONFIG_ATH5K_DEBUG */ 202 203#endif /* ifndef _ATH5K_DEBUG_H */ 204