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

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