iwlwifi: add more comments to IWL_DL_xx
[safe/jmp/linux-2.6] / drivers / net / wireless / iwlwifi / iwl-debug.h
1 /******************************************************************************
2  *
3  * Copyright(c) 2003 - 2008 Intel Corporation. All rights reserved.
4  *
5  * Portions of this file are derived from the ipw3945 project.
6  *
7  * This program is free software; you can redistribute it and/or modify it
8  * under the terms of version 2 of the GNU General Public License as
9  * published by the Free Software Foundation.
10  *
11  * This program is distributed in the hope that it will be useful, but WITHOUT
12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
14  * more details.
15  *
16  * You should have received a copy of the GNU General Public License along with
17  * this program; if not, write to the Free Software Foundation, Inc.,
18  * 51 Franklin Street, Fifth Floor, Boston, MA 02110, USA
19  *
20  * The full GNU General Public License is included in this distribution in the
21  * file called LICENSE.
22  *
23  * Contact Information:
24  *  Intel Linux Wireless <ilw@linux.intel.com>
25  * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
26  *
27  *****************************************************************************/
28
29 #ifndef __iwl_debug_h__
30 #define __iwl_debug_h__
31
32 struct iwl_priv;
33
34 #ifdef CONFIG_IWLWIFI_DEBUG
35 #define IWL_DEBUG(level, fmt, args...)                                      \
36 do {                                                                        \
37         if (priv->debug_level & (level))                                    \
38                 dev_printk(KERN_ERR, &(priv->hw->wiphy->dev), "%c %s " fmt, \
39                            in_interrupt() ? 'I' : 'U', __func__ , ## args); \
40 } while (0)
41
42 #define IWL_DEBUG_LIMIT(level, fmt, args...)                                \
43 do {                                                                        \
44         if ((priv->debug_level & (level)) && net_ratelimit())               \
45                 dev_printk(KERN_ERR, &(priv->hw->wiphy->dev), "%c %s " fmt, \
46                            in_interrupt() ? 'I' : 'U', __func__ , ## args); \
47 } while (0)
48
49 #define iwl_print_hex_dump(priv, level, p, len)                         \
50 do {                                                                    \
51         if (priv->debug_level & level)                                  \
52                 print_hex_dump(KERN_DEBUG, "iwl data: ",                \
53                                DUMP_PREFIX_OFFSET, 16, 1, p, len, 1);   \
54 } while (0)
55
56 #ifdef CONFIG_IWLWIFI_DEBUGFS
57 struct iwl_debugfs {
58         const char *name;
59         struct dentry *dir_drv;
60         struct dentry *dir_data;
61         struct dentry *dir_rf;
62         struct dir_data_files {
63                 struct dentry *file_sram;
64                 struct dentry *file_eeprom;
65                 struct dentry *file_stations;
66                 struct dentry *file_rx_statistics;
67                 struct dentry *file_tx_statistics;
68                 struct dentry *file_log_event;
69                 struct dentry *file_channels;
70                 struct dentry *file_status;
71         } dbgfs_data_files;
72         struct dir_rf_files {
73                 struct dentry *file_disable_sensitivity;
74                 struct dentry *file_disable_chain_noise;
75                 struct dentry *file_disable_tx_power;
76         } dbgfs_rf_files;
77         u32 sram_offset;
78         u32 sram_len;
79 };
80
81 int iwl_dbgfs_register(struct iwl_priv *priv, const char *name);
82 void iwl_dbgfs_unregister(struct iwl_priv *priv);
83 #endif
84
85 #else
86 #define IWL_DEBUG(level, fmt, args...)
87 #define IWL_DEBUG_LIMIT(level, fmt, args...)
88 static inline void iwl_print_hex_dump(struct iwl_priv *priv, int level,
89                                       void *p, u32 len)
90 {}
91 #endif                          /* CONFIG_IWLWIFI_DEBUG */
92
93
94
95 #ifndef CONFIG_IWLWIFI_DEBUGFS
96 static inline int iwl_dbgfs_register(struct iwl_priv *priv, const char *name)
97 {
98         return 0;
99 }
100 static inline void iwl_dbgfs_unregister(struct iwl_priv *priv)
101 {
102 }
103 #endif                          /* CONFIG_IWLWIFI_DEBUGFS */
104
105 /*
106  * To use the debug system:
107  *
108  * If you are defining a new debug classification, simply add it to the #define
109  * list here in the form of
110  *
111  * #define IWL_DL_xxxx VALUE
112  *
113  * where xxxx should be the name of the classification (for example, WEP).
114  *
115  * You then need to either add a IWL_xxxx_DEBUG() macro definition for your
116  * classification, or use IWL_DEBUG(IWL_DL_xxxx, ...) whenever you want
117  * to send output to that classification.
118  *
119  * The active debug levels can be accessed via files
120  *
121  *      /sys/module/iwlagn/parameters/debug{50}
122  *      /sys/class/net/wlan0/device/debug_level
123  *
124  * when CONFIG_IWLWIFI_DEBUG=y.
125  */
126
127 /* 0x0000000F - 0x00000001 */
128 #define IWL_DL_INFO             (1 << 0)
129 #define IWL_DL_MAC80211         (1 << 1)
130 #define IWL_DL_HCMD             (1 << 2)
131 #define IWL_DL_STATE            (1 << 3)
132 /* 0x000000F0 - 0x00000010 */
133 #define IWL_DL_MACDUMP          (1 << 4)
134 #define IWL_DL_HCMD_DUMP        (1 << 5)
135 #define IWL_DL_RADIO            (1 << 7)
136 /* 0x00000F00 - 0x00000100 */
137 #define IWL_DL_POWER            (1 << 8)
138 #define IWL_DL_TEMP             (1 << 9)
139 #define IWL_DL_NOTIF            (1 << 10)
140 #define IWL_DL_SCAN             (1 << 11)
141 /* 0x0000F000 - 0x00001000 */
142 #define IWL_DL_ASSOC            (1 << 12)
143 #define IWL_DL_DROP             (1 << 13)
144 #define IWL_DL_TXPOWER          (1 << 14)
145 #define IWL_DL_AP               (1 << 15)
146 /* 0x000F0000 - 0x00010000 */
147 #define IWL_DL_FW               (1 << 16)
148 #define IWL_DL_RF_KILL          (1 << 17)
149 #define IWL_DL_FW_ERRORS        (1 << 18)
150 #define IWL_DL_LED              (1 << 19)
151 /* 0x00F00000 - 0x00100000 */
152 #define IWL_DL_RATE             (1 << 20)
153 #define IWL_DL_CALIB            (1 << 21)
154 #define IWL_DL_WEP              (1 << 22)
155 #define IWL_DL_TX               (1 << 23)
156 /* 0x0F000000 - 0x01000000 */
157 #define IWL_DL_RX               (1 << 24)
158 #define IWL_DL_ISR              (1 << 25)
159 #define IWL_DL_HT               (1 << 26)
160 #define IWL_DL_IO               (1 << 27)
161 /* 0xF0000000 - 0x10000000 */
162 #define IWL_DL_11H              (1 << 28)
163 #define IWL_DL_STATS            (1 << 29)
164 #define IWL_DL_TX_REPLY         (1 << 30)
165 #define IWL_DL_QOS              (1 << 31)
166
167 #define IWL_ERROR(f, a...)              \
168                 dev_printk(KERN_ERR, &(priv->hw->wiphy->dev), f, ## a)
169 #define IWL_WARNING(f, a...)            \
170                 dev_printk(KERN_WARNING, &(priv->hw->wiphy->dev), f, ## a)
171
172 #define IWL_DEBUG_INFO(f, a...)         IWL_DEBUG(IWL_DL_INFO, f, ## a)
173 #define IWL_DEBUG_MAC80211(f, a...)     IWL_DEBUG(IWL_DL_MAC80211, f, ## a)
174 #define IWL_DEBUG_MACDUMP(f, a...)      IWL_DEBUG(IWL_DL_MACDUMP, f, ## a)
175 #define IWL_DEBUG_TEMP(f, a...)         IWL_DEBUG(IWL_DL_TEMP, f, ## a)
176 #define IWL_DEBUG_SCAN(f, a...)         IWL_DEBUG(IWL_DL_SCAN, f, ## a)
177 #define IWL_DEBUG_RX(f, a...)           IWL_DEBUG(IWL_DL_RX, f, ## a)
178 #define IWL_DEBUG_TX(f, a...)           IWL_DEBUG(IWL_DL_TX, f, ## a)
179 #define IWL_DEBUG_ISR(f, a...)          IWL_DEBUG(IWL_DL_ISR, f, ## a)
180 #define IWL_DEBUG_LED(f, a...)          IWL_DEBUG(IWL_DL_LED, f, ## a)
181 #define IWL_DEBUG_WEP(f, a...)          IWL_DEBUG(IWL_DL_WEP, f, ## a)
182 #define IWL_DEBUG_HC(f, a...)           IWL_DEBUG(IWL_DL_HCMD, f, ## a)
183 #define IWL_DEBUG_HC_DUMP(f, a...)      IWL_DEBUG(IWL_DL_HCMD_DUMP, f, ## a)
184 #define IWL_DEBUG_CALIB(f, a...)        IWL_DEBUG(IWL_DL_CALIB, f, ## a)
185 #define IWL_DEBUG_FW(f, a...)           IWL_DEBUG(IWL_DL_FW, f, ## a)
186 #define IWL_DEBUG_RF_KILL(f, a...)      IWL_DEBUG(IWL_DL_RF_KILL, f, ## a)
187 #define IWL_DEBUG_DROP(f, a...)         IWL_DEBUG(IWL_DL_DROP, f, ## a)
188 #define IWL_DEBUG_DROP_LIMIT(f, a...)   IWL_DEBUG_LIMIT(IWL_DL_DROP, f, ## a)
189 #define IWL_DEBUG_AP(f, a...)           IWL_DEBUG(IWL_DL_AP, f, ## a)
190 #define IWL_DEBUG_TXPOWER(f, a...)      IWL_DEBUG(IWL_DL_TXPOWER, f, ## a)
191 #define IWL_DEBUG_IO(f, a...)           IWL_DEBUG(IWL_DL_IO, f, ## a)
192 #define IWL_DEBUG_RATE(f, a...)         IWL_DEBUG(IWL_DL_RATE, f, ## a)
193 #define IWL_DEBUG_RATE_LIMIT(f, a...)   IWL_DEBUG_LIMIT(IWL_DL_RATE, f, ## a)
194 #define IWL_DEBUG_NOTIF(f, a...)        IWL_DEBUG(IWL_DL_NOTIF, f, ## a)
195 #define IWL_DEBUG_ASSOC(f, a...)        \
196                 IWL_DEBUG(IWL_DL_ASSOC | IWL_DL_INFO, f, ## a)
197 #define IWL_DEBUG_ASSOC_LIMIT(f, a...)  \
198                 IWL_DEBUG_LIMIT(IWL_DL_ASSOC | IWL_DL_INFO, f, ## a)
199 #define IWL_DEBUG_HT(f, a...)           IWL_DEBUG(IWL_DL_HT, f, ## a)
200 #define IWL_DEBUG_STATS(f, a...)        IWL_DEBUG(IWL_DL_STATS, f, ## a)
201 #define IWL_DEBUG_STATS_LIMIT(f, a...)  IWL_DEBUG_LIMIT(IWL_DL_STATS, f, ## a)
202 #define IWL_DEBUG_TX_REPLY(f, a...)     IWL_DEBUG(IWL_DL_TX_REPLY, f, ## a)
203 #define IWL_DEBUG_TX_REPLY_LIMIT(f, a...) \
204                 IWL_DEBUG_LIMIT(IWL_DL_TX_REPLY, f, ## a)
205 #define IWL_DEBUG_QOS(f, a...)          IWL_DEBUG(IWL_DL_QOS, f, ## a)
206 #define IWL_DEBUG_RADIO(f, a...)        IWL_DEBUG(IWL_DL_RADIO, f, ## a)
207 #define IWL_DEBUG_POWER(f, a...)        IWL_DEBUG(IWL_DL_POWER, f, ## a)
208 #define IWL_DEBUG_11H(f, a...)          IWL_DEBUG(IWL_DL_11H, f, ## a)
209
210 #endif