iwl-debug.h 8.0 KB

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