cbc62904655d61daebd7bd59a77abb5da83252a8
[linux-2.6.git] / drivers / net / wireless / iwlwifi / iwl-debug.h
1 /******************************************************************************
2  *
3  * Copyright(c) 2003 - 2009 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 extern u32 iwl_debug_level;
34
35 #define IWL_ERR(p, f, a...) dev_err(&((p)->pci_dev->dev), f, ## a)
36 #define IWL_WARN(p, f, a...) dev_warn(&((p)->pci_dev->dev), f, ## a)
37 #define IWL_INFO(p, f, a...) dev_info(&((p)->pci_dev->dev), f, ## a)
38 #define IWL_CRIT(p, f, a...) dev_crit(&((p)->pci_dev->dev), f, ## a)
39
40 #define iwl_print_hex_error(priv, p, len)                               \
41 do {                                                                    \
42         print_hex_dump(KERN_ERR, "iwl data: ",                          \
43                        DUMP_PREFIX_OFFSET, 16, 1, p, len, 1);           \
44 } while (0)
45
46 #ifdef CONFIG_IWLWIFI_DEBUG
47 #define IWL_DEBUG(__priv, level, fmt, args...)                          \
48 do {                                                                    \
49         if (iwl_get_debug_level(__priv) & (level))                                      \
50                 dev_printk(KERN_ERR, &(__priv->hw->wiphy->dev),         \
51                          "%c %s " fmt, in_interrupt() ? 'I' : 'U',      \
52                         __func__ , ## args);                            \
53 } while (0)
54
55 #define IWL_DEBUG_LIMIT(__priv, level, fmt, args...)                    \
56 do {                                                                    \
57         if ((iwl_get_debug_level(__priv) & (level)) && net_ratelimit())         \
58                 dev_printk(KERN_ERR, &(__priv->hw->wiphy->dev),         \
59                         "%c %s " fmt, in_interrupt() ? 'I' : 'U',       \
60                          __func__ , ## args);                           \
61 } while (0)
62
63 #define iwl_print_hex_dump(priv, level, p, len)                         \
64 do {                                                                    \
65         if (iwl_get_debug_level(priv) & level)                          \
66                 print_hex_dump(KERN_DEBUG, "iwl data: ",                \
67                                DUMP_PREFIX_OFFSET, 16, 1, p, len, 1);   \
68 } while (0)
69
70 #ifdef CONFIG_IWLWIFI_DEBUGFS
71 struct iwl_debugfs {
72         const char *name;
73         struct dentry *dir_drv;
74         struct dentry *dir_data;
75         struct dentry *dir_debug;
76         struct dentry *dir_rf;
77         struct dir_data_files {
78                 struct dentry *file_sram;
79                 struct dentry *file_nvm;
80                 struct dentry *file_stations;
81                 struct dentry *file_log_event;
82                 struct dentry *file_channels;
83                 struct dentry *file_status;
84                 struct dentry *file_interrupt;
85                 struct dentry *file_qos;
86                 struct dentry *file_thermal_throttling;
87 #ifdef CONFIG_IWLWIFI_LEDS
88                 struct dentry *file_led;
89 #endif
90                 struct dentry *file_disable_ht40;
91                 struct dentry *file_sleep_level_override;
92                 struct dentry *file_current_sleep_command;
93         } dbgfs_data_files;
94         struct dir_rf_files {
95                 struct dentry *file_disable_sensitivity;
96                 struct dentry *file_disable_chain_noise;
97                 struct dentry *file_disable_tx_power;
98         } dbgfs_rf_files;
99         struct dir_debug_files {
100                 struct dentry *file_rx_statistics;
101                 struct dentry *file_tx_statistics;
102                 struct dentry *file_traffic_log;
103                 struct dentry *file_rx_queue;
104                 struct dentry *file_tx_queue;
105                 struct dentry *file_ucode_rx_stats;
106                 struct dentry *file_ucode_tx_stats;
107                 struct dentry *file_ucode_general_stats;
108                 struct dentry *file_sensitivity;
109                 struct dentry *file_chain_noise;
110                 struct dentry *file_tx_power;
111         } dbgfs_debug_files;
112         u32 sram_offset;
113         u32 sram_len;
114 };
115
116 int iwl_dbgfs_register(struct iwl_priv *priv, const char *name);
117 void iwl_dbgfs_unregister(struct iwl_priv *priv);
118 #endif
119
120 #else
121 #define IWL_DEBUG(__priv, level, fmt, args...)
122 #define IWL_DEBUG_LIMIT(__priv, level, fmt, args...)
123 static inline void iwl_print_hex_dump(struct iwl_priv *priv, int level,
124                                       void *p, u32 len)
125 {}
126 #endif                          /* CONFIG_IWLWIFI_DEBUG */
127
128
129
130 #ifndef CONFIG_IWLWIFI_DEBUGFS
131 static inline int iwl_dbgfs_register(struct iwl_priv *priv, const char *name)
132 {
133         return 0;
134 }
135 static inline void iwl_dbgfs_unregister(struct iwl_priv *priv)
136 {
137 }
138 #endif                          /* CONFIG_IWLWIFI_DEBUGFS */
139
140 /*
141  * To use the debug system:
142  *
143  * If you are defining a new debug classification, simply add it to the #define
144  * list here in the form of
145  *
146  * #define IWL_DL_xxxx VALUE
147  *
148  * where xxxx should be the name of the classification (for example, WEP).
149  *
150  * You then need to either add a IWL_xxxx_DEBUG() macro definition for your
151  * classification, or use IWL_DEBUG(IWL_DL_xxxx, ...) whenever you want
152  * to send output to that classification.
153  *
154  * The active debug levels can be accessed via files
155  *
156  *      /sys/module/iwlagn/parameters/debug{50}
157  *      /sys/class/net/wlan0/device/debug_level
158  *
159  * when CONFIG_IWLWIFI_DEBUG=y.
160  */
161
162 /* 0x0000000F - 0x00000001 */
163 #define IWL_DL_INFO             (1 << 0)
164 #define IWL_DL_MAC80211         (1 << 1)
165 #define IWL_DL_HCMD             (1 << 2)
166 #define IWL_DL_STATE            (1 << 3)
167 /* 0x000000F0 - 0x00000010 */
168 #define IWL_DL_MACDUMP          (1 << 4)
169 #define IWL_DL_HCMD_DUMP        (1 << 5)
170 #define IWL_DL_RADIO            (1 << 7)
171 /* 0x00000F00 - 0x00000100 */
172 #define IWL_DL_POWER            (1 << 8)
173 #define IWL_DL_TEMP             (1 << 9)
174 #define IWL_DL_NOTIF            (1 << 10)
175 #define IWL_DL_SCAN             (1 << 11)
176 /* 0x0000F000 - 0x00001000 */
177 #define IWL_DL_ASSOC            (1 << 12)
178 #define IWL_DL_DROP             (1 << 13)
179 #define IWL_DL_TXPOWER          (1 << 14)
180 #define IWL_DL_AP               (1 << 15)
181 /* 0x000F0000 - 0x00010000 */
182 #define IWL_DL_FW               (1 << 16)
183 #define IWL_DL_RF_KILL          (1 << 17)
184 #define IWL_DL_FW_ERRORS        (1 << 18)
185 #define IWL_DL_LED              (1 << 19)
186 /* 0x00F00000 - 0x00100000 */
187 #define IWL_DL_RATE             (1 << 20)
188 #define IWL_DL_CALIB            (1 << 21)
189 #define IWL_DL_WEP              (1 << 22)
190 #define IWL_DL_TX               (1 << 23)
191 /* 0x0F000000 - 0x01000000 */
192 #define IWL_DL_RX               (1 << 24)
193 #define IWL_DL_ISR              (1 << 25)
194 #define IWL_DL_HT               (1 << 26)
195 #define IWL_DL_IO               (1 << 27)
196 /* 0xF0000000 - 0x10000000 */
197 #define IWL_DL_11H              (1 << 28)
198 #define IWL_DL_STATS            (1 << 29)
199 #define IWL_DL_TX_REPLY         (1 << 30)
200 #define IWL_DL_QOS              (1 << 31)
201
202 #define IWL_DEBUG_INFO(p, f, a...)      IWL_DEBUG(p, IWL_DL_INFO, f, ## a)
203 #define IWL_DEBUG_MAC80211(p, f, a...)  IWL_DEBUG(p, IWL_DL_MAC80211, f, ## a)
204 #define IWL_DEBUG_MACDUMP(p, f, a...)   IWL_DEBUG(p, IWL_DL_MACDUMP, f, ## a)
205 #define IWL_DEBUG_TEMP(p, f, a...)      IWL_DEBUG(p, IWL_DL_TEMP, f, ## a)
206 #define IWL_DEBUG_SCAN(p, f, a...)      IWL_DEBUG(p, IWL_DL_SCAN, f, ## a)
207 #define IWL_DEBUG_RX(p, f, a...)        IWL_DEBUG(p, IWL_DL_RX, f, ## a)
208 #define IWL_DEBUG_TX(p, f, a...)        IWL_DEBUG(p, IWL_DL_TX, f, ## a)
209 #define IWL_DEBUG_ISR(p, f, a...)       IWL_DEBUG(p, IWL_DL_ISR, f, ## a)
210 #define IWL_DEBUG_LED(p, f, a...)       IWL_DEBUG(p, IWL_DL_LED, f, ## a)
211 #define IWL_DEBUG_WEP(p, f, a...)       IWL_DEBUG(p, IWL_DL_WEP, f, ## a)
212 #define IWL_DEBUG_HC(p, f, a...)        IWL_DEBUG(p, IWL_DL_HCMD, f, ## a)
213 #define IWL_DEBUG_HC_DUMP(p, f, a...)   IWL_DEBUG(p, IWL_DL_HCMD_DUMP, f, ## a)
214 #define IWL_DEBUG_CALIB(p, f, a...)     IWL_DEBUG(p, IWL_DL_CALIB, f, ## a)
215 #define IWL_DEBUG_FW(p, f, a...)        IWL_DEBUG(p, IWL_DL_FW, f, ## a)
216 #define IWL_DEBUG_RF_KILL(p, f, a...)   IWL_DEBUG(p, IWL_DL_RF_KILL, f, ## a)
217 #define IWL_DEBUG_DROP(p, f, a...)      IWL_DEBUG(p, IWL_DL_DROP, f, ## a)
218 #define IWL_DEBUG_DROP_LIMIT(p, f, a...)        \
219                 IWL_DEBUG_LIMIT(p, IWL_DL_DROP, f, ## a)
220 #define IWL_DEBUG_AP(p, f, a...)        IWL_DEBUG(p, IWL_DL_AP, f, ## a)
221 #define IWL_DEBUG_TXPOWER(p, f, a...)   IWL_DEBUG(p, IWL_DL_TXPOWER, f, ## a)
222 #define IWL_DEBUG_IO(p, f, a...)        IWL_DEBUG(p, IWL_DL_IO, f, ## a)
223 #define IWL_DEBUG_RATE(p, f, a...)      IWL_DEBUG(p, IWL_DL_RATE, f, ## a)
224 #define IWL_DEBUG_RATE_LIMIT(p, f, a...)        \
225                 IWL_DEBUG_LIMIT(p, IWL_DL_RATE, f, ## a)
226 #define IWL_DEBUG_NOTIF(p, f, a...)     IWL_DEBUG(p, IWL_DL_NOTIF, f, ## a)
227 #define IWL_DEBUG_ASSOC(p, f, a...)     \
228                 IWL_DEBUG(p, IWL_DL_ASSOC | IWL_DL_INFO, f, ## a)
229 #define IWL_DEBUG_ASSOC_LIMIT(p, f, a...)       \
230                 IWL_DEBUG_LIMIT(p, IWL_DL_ASSOC | IWL_DL_INFO, f, ## a)
231 #define IWL_DEBUG_HT(p, f, a...)        IWL_DEBUG(p, IWL_DL_HT, f, ## a)
232 #define IWL_DEBUG_STATS(p, f, a...)     IWL_DEBUG(p, IWL_DL_STATS, f, ## a)
233 #define IWL_DEBUG_STATS_LIMIT(p, f, a...)       \
234                 IWL_DEBUG_LIMIT(p, IWL_DL_STATS, f, ## a)
235 #define IWL_DEBUG_TX_REPLY(p, f, a...)  IWL_DEBUG(p, IWL_DL_TX_REPLY, f, ## a)
236 #define IWL_DEBUG_TX_REPLY_LIMIT(p, f, a...) \
237                 IWL_DEBUG_LIMIT(p, IWL_DL_TX_REPLY, f, ## a)
238 #define IWL_DEBUG_QOS(p, f, a...)       IWL_DEBUG(p, IWL_DL_QOS, f, ## a)
239 #define IWL_DEBUG_RADIO(p, f, a...)     IWL_DEBUG(p, IWL_DL_RADIO, f, ## a)
240 #define IWL_DEBUG_POWER(p, f, a...)     IWL_DEBUG(p, IWL_DL_POWER, f, ## a)
241 #define IWL_DEBUG_11H(p, f, a...)       IWL_DEBUG(p, IWL_DL_11H, f, ## a)
242
243 #endif