drivers/net/wireless/iwlwifi/iwl-debug.h

   1 /******************************************************************************
   2  *
   3  * Copyright(c) 2003 - 2012 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 #include "iwl-bus.h"
  33 #include "iwl-shared.h"
  34 #include "iwl-devtrace.h"
  35
  36 struct iwl_priv;
  37
  38 void __iwl_err(struct device *dev, bool rfkill_prefix, bool only_trace,
  39                 const char *fmt, ...);
  40 void __iwl_warn(struct device *dev, const char *fmt, ...);
  41 void __iwl_info(struct device *dev, const char *fmt, ...);
  42 void __iwl_crit(struct device *dev, const char *fmt, ...);
  43
  44 /* No matter what is m (priv, bus, trans), this will work */
  45 #define IWL_ERR(m, f, a...) __iwl_err(trans(m)->dev, false, false, f, ## a)
  46 #define IWL_WARN(m, f, a...) __iwl_warn(trans(m)->dev, f, ## a)
  47 #define IWL_INFO(m, f, a...) __iwl_info(trans(m)->dev, f, ## a)
  48 #define IWL_CRIT(m, f, a...) __iwl_crit(trans(m)->dev, f, ## a)
  49
  50 #if defined(CONFIG_IWLWIFI_DEBUG) || defined(CONFIG_IWLWIFI_DEVICE_TRACING)
  51 void __iwl_dbg(struct iwl_shared *shared, struct device *dev,
  52                u32 level, bool limit, const char *function,
  53                const char *fmt, ...);
  54 #else
  55 static inline void
  56 __iwl_dbg(struct iwl_shared *shared, struct device *dev,
  57           u32 level, bool limit, const char *function,
  58           const char *fmt, ...)
  59 {}
  60 #endif
  61
  62 #define iwl_print_hex_error(m, p, len)                                  \
  63 do {                                                                    \
  64         print_hex_dump(KERN_ERR, "iwl data: ",                          \
  65                        DUMP_PREFIX_OFFSET, 16, 1, p, len, 1);           \
  66 } while (0)
  67
  68 #define IWL_DEBUG(m, level, fmt, args...)                               \
  69         __iwl_dbg((m)->shrd, trans(m)->dev, level, false, __func__, fmt, ##args)
  70 #define IWL_DEBUG_LIMIT(m, level, fmt, args...)                         \
  71         __iwl_dbg((m)->shrd, trans(m)->dev, level, true, __func__, fmt, ##args)
  72
  73 #ifdef CONFIG_IWLWIFI_DEBUG
  74 #define iwl_print_hex_dump(m, level, p, len)                            \
  75 do {                                                                    \
  76         if (iwl_get_debug_level((m)->shrd) & level)                     \
  77                 print_hex_dump(KERN_DEBUG, "iwl data: ",                \
  78                                DUMP_PREFIX_OFFSET, 16, 1, p, len, 1);   \
  79 } while (0)
  80 #define IWL_DEBUG_QUIET_RFKILL(m, fmt, args...) \
  81 do {                                                                    \
  82         if (!iwl_is_rfkill((m)->shrd))                                  \
  83                 IWL_ERR(m, fmt, ##args);                                \
  84         else                                                            \
  85                 __iwl_err(trans(m)->dev, true,                          \
  86                           !(iwl_get_debug_level((m)->shrd) & IWL_DL_RADIO),\
  87                           fmt, ##args);                                 \
  88 } while (0)
  89 #else
  90 #define iwl_print_hex_dump(m, level, p, len)
  91 #define IWL_DEBUG_QUIET_RFKILL(m, fmt, args...) \
  92 do {                                                                    \
  93         if (!iwl_is_rfkill((m)->shrd))                                  \
  94                 IWL_ERR(m, fmt, ##args);                                \
  95         else                                                            \
  96                 __iwl_err(trans(m)->dev, true, true, fmt, ##args);      \
  97 } while (0)
  98 #endif                          /* CONFIG_IWLWIFI_DEBUG */
  99
 100 #ifdef CONFIG_IWLWIFI_DEBUGFS
 101 int iwl_dbgfs_register(struct iwl_priv *priv, const char *name);
 102 void iwl_dbgfs_unregister(struct iwl_priv *priv);
 103 #else
 104 static inline int iwl_dbgfs_register(struct iwl_priv *priv, const char *name)
 105 {
 106         return 0;
 107 }
 108 static inline void iwl_dbgfs_unregister(struct iwl_priv *priv)
 109 {
 110 }
 111 #endif                          /* CONFIG_IWLWIFI_DEBUGFS */
 112
 113 /*
 114  * To use the debug system:
 115  *
 116  * If you are defining a new debug classification, simply add it to the #define
 117  * list here in the form of
 118  *
 119  * #define IWL_DL_xxxx VALUE
 120  *
 121  * where xxxx should be the name of the classification (for example, WEP).
 122  *
 123  * You then need to either add a IWL_xxxx_DEBUG() macro definition for your
 124  * classification, or use IWL_DEBUG(IWL_DL_xxxx, ...) whenever you want
 125  * to send output to that classification.
 126  *
 127  * The active debug levels can be accessed via files
 128  *
 129  *      /sys/module/iwlwifi/parameters/debug
 130  * when CONFIG_IWLWIFI_DEBUG=y.
 131  *
 132  *      /sys/kernel/debug/phy0/iwlwifi/debug/debug_level
 133  * when CONFIG_IWLWIFI_DEBUGFS=y.
 134  *
 135  */
 136
 137 /* 0x0000000F - 0x00000001 */
 138 #define IWL_DL_INFO             0x00000001
 139 #define IWL_DL_MAC80211         0x00000002
 140 #define IWL_DL_HCMD             0x00000004
 141 #define IWL_DL_STATE            0x00000008
 142 /* 0x000000F0 - 0x00000010 */
 143 #define IWL_DL_EEPROM           0x00000040
 144 #define IWL_DL_RADIO            0x00000080
 145 /* 0x00000F00 - 0x00000100 */
 146 #define IWL_DL_POWER            0x00000100
 147 #define IWL_DL_TEMP             0x00000200
 148 #define IWL_DL_SCAN             0x00000800
 149 /* 0x0000F000 - 0x00001000 */
 150 #define IWL_DL_ASSOC            0x00001000
 151 #define IWL_DL_DROP             0x00002000
 152 #define IWL_DL_COEX             0x00008000
 153 /* 0x000F0000 - 0x00010000 */
 154 #define IWL_DL_FW               0x00010000
 155 #define IWL_DL_RF_KILL          0x00020000
 156 #define IWL_DL_FW_ERRORS        0x00040000
 157 #define IWL_DL_LED              0x00080000
 158 /* 0x00F00000 - 0x00100000 */
 159 #define IWL_DL_RATE             0x00100000
 160 #define IWL_DL_CALIB            0x00200000
 161 #define IWL_DL_WEP              0x00400000
 162 #define IWL_DL_TX               0x00800000
 163 /* 0x0F000000 - 0x01000000 */
 164 #define IWL_DL_RX               0x01000000
 165 #define IWL_DL_ISR              0x02000000
 166 #define IWL_DL_HT               0x04000000
 167 /* 0xF0000000 - 0x10000000 */
 168 #define IWL_DL_11H              0x10000000
 169 #define IWL_DL_STATS            0x20000000
 170 #define IWL_DL_TX_REPLY         0x40000000
 171 #define IWL_DL_TX_QUEUES        0x80000000
 172
 173 #define IWL_DEBUG_INFO(p, f, a...)      IWL_DEBUG(p, IWL_DL_INFO, f, ## a)
 174 #define IWL_DEBUG_MAC80211(p, f, a...)  IWL_DEBUG(p, IWL_DL_MAC80211, f, ## a)
 175 #define IWL_DEBUG_TEMP(p, f, a...)      IWL_DEBUG(p, IWL_DL_TEMP, f, ## a)
 176 #define IWL_DEBUG_SCAN(p, f, a...)      IWL_DEBUG(p, IWL_DL_SCAN, f, ## a)
 177 #define IWL_DEBUG_RX(p, f, a...)        IWL_DEBUG(p, IWL_DL_RX, f, ## a)
 178 #define IWL_DEBUG_TX(p, f, a...)        IWL_DEBUG(p, IWL_DL_TX, f, ## a)
 179 #define IWL_DEBUG_ISR(p, f, a...)       IWL_DEBUG(p, IWL_DL_ISR, f, ## a)
 180 #define IWL_DEBUG_LED(p, f, a...)       IWL_DEBUG(p, IWL_DL_LED, f, ## a)
 181 #define IWL_DEBUG_WEP(p, f, a...)       IWL_DEBUG(p, IWL_DL_WEP, f, ## a)
 182 #define IWL_DEBUG_HC(p, f, a...)        IWL_DEBUG(p, IWL_DL_HCMD, f, ## a)
 183 #define IWL_DEBUG_EEPROM(p, f, a...)    IWL_DEBUG(p, IWL_DL_EEPROM, f, ## a)
 184 #define IWL_DEBUG_CALIB(p, f, a...)     IWL_DEBUG(p, IWL_DL_CALIB, f, ## a)
 185 #define IWL_DEBUG_FW(p, f, a...)        IWL_DEBUG(p, IWL_DL_FW, f, ## a)
 186 #define IWL_DEBUG_RF_KILL(p, f, a...)   IWL_DEBUG(p, IWL_DL_RF_KILL, f, ## a)
 187 #define IWL_DEBUG_FW_ERRORS(p, f, a...) IWL_DEBUG(p, IWL_DL_FW_ERRORS, f, ## a)
 188 #define IWL_DEBUG_DROP(p, f, a...)      IWL_DEBUG(p, IWL_DL_DROP, f, ## a)
 189 #define IWL_DEBUG_DROP_LIMIT(p, f, a...)        \
 190                 IWL_DEBUG_LIMIT(p, IWL_DL_DROP, f, ## a)
 191 #define IWL_DEBUG_COEX(p, f, a...)      IWL_DEBUG(p, IWL_DL_COEX, f, ## a)
 192 #define IWL_DEBUG_RATE(p, f, a...)      IWL_DEBUG(p, IWL_DL_RATE, f, ## a)
 193 #define IWL_DEBUG_RATE_LIMIT(p, f, a...)        \
 194                 IWL_DEBUG_LIMIT(p, IWL_DL_RATE, f, ## a)
 195 #define IWL_DEBUG_ASSOC(p, f, a...)     \
 196                 IWL_DEBUG(p, IWL_DL_ASSOC | IWL_DL_INFO, f, ## a)
 197 #define IWL_DEBUG_ASSOC_LIMIT(p, f, a...)       \
 198                 IWL_DEBUG_LIMIT(p, IWL_DL_ASSOC | IWL_DL_INFO, f, ## a)
 199 #define IWL_DEBUG_HT(p, f, a...)        IWL_DEBUG(p, IWL_DL_HT, f, ## a)
 200 #define IWL_DEBUG_STATS(p, f, a...)     IWL_DEBUG(p, IWL_DL_STATS, f, ## a)
 201 #define IWL_DEBUG_STATS_LIMIT(p, f, a...)       \
 202                 IWL_DEBUG_LIMIT(p, IWL_DL_STATS, f, ## a)
 203 #define IWL_DEBUG_TX_REPLY(p, f, a...)  IWL_DEBUG(p, IWL_DL_TX_REPLY, f, ## a)
 204 #define IWL_DEBUG_TX_QUEUES(p, f, a...) IWL_DEBUG(p, IWL_DL_TX_QUEUES, f, ## a)
 205 #define IWL_DEBUG_RADIO(p, f, a...)     IWL_DEBUG(p, IWL_DL_RADIO, f, ## a)
 206 #define IWL_DEBUG_POWER(p, f, a...)     IWL_DEBUG(p, IWL_DL_POWER, f, ## a)
 207 #define IWL_DEBUG_11H(p, f, a...)       IWL_DEBUG(p, IWL_DL_11H, f, ## a)
 208
 209 #endif