drivers/net/wireless/ath/ath10k/debug.h

   1 /*
   2  * Copyright (c) 2005-2011 Atheros Communications Inc.
   3  * Copyright (c) 2011-2017 Qualcomm Atheros, Inc.
   4  *
   5  * Permission to use, copy, modify, and/or distribute this software for any
   6  * purpose with or without fee is hereby granted, provided that the above
   7  * copyright notice and this permission notice appear in all copies.
   8  *
   9  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  10  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  11  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  12  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  13  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  14  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  15  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  16  */
  17
  18 #ifndef _DEBUG_H_
  19 #define _DEBUG_H_
  20
  21 #include <linux/types.h>
  22 #include "trace.h"
  23
  24 enum ath10k_debug_mask {
  25         ATH10K_DBG_PCI          = 0x00000001,
  26         ATH10K_DBG_WMI          = 0x00000002,
  27         ATH10K_DBG_HTC          = 0x00000004,
  28         ATH10K_DBG_HTT          = 0x00000008,
  29         ATH10K_DBG_MAC          = 0x00000010,
  30         ATH10K_DBG_BOOT         = 0x00000020,
  31         ATH10K_DBG_PCI_DUMP     = 0x00000040,
  32         ATH10K_DBG_HTT_DUMP     = 0x00000080,
  33         ATH10K_DBG_MGMT         = 0x00000100,
  34         ATH10K_DBG_DATA         = 0x00000200,
  35         ATH10K_DBG_BMI          = 0x00000400,
  36         ATH10K_DBG_REGULATORY   = 0x00000800,
  37         ATH10K_DBG_TESTMODE     = 0x00001000,
  38         ATH10K_DBG_WMI_PRINT    = 0x00002000,
  39         ATH10K_DBG_PCI_PS       = 0x00004000,
  40         ATH10K_DBG_AHB          = 0x00008000,
  41         ATH10K_DBG_SDIO         = 0x00010000,
  42         ATH10K_DBG_SDIO_DUMP    = 0x00020000,
  43         ATH10K_DBG_USB          = 0x00040000,
  44         ATH10K_DBG_USB_BULK     = 0x00080000,
  45         ATH10K_DBG_SNOC         = 0x00100000,
  46         ATH10K_DBG_ANY          = 0xffffffff,
  47 };
  48
  49 enum ath10k_pktlog_filter {
  50         ATH10K_PKTLOG_RX         = 0x000000001,
  51         ATH10K_PKTLOG_TX         = 0x000000002,
  52         ATH10K_PKTLOG_RCFIND     = 0x000000004,
  53         ATH10K_PKTLOG_RCUPDATE   = 0x000000008,
  54         ATH10K_PKTLOG_DBG_PRINT  = 0x000000010,
  55         ATH10K_PKTLOG_PEER_STATS = 0x000000040,
  56         ATH10K_PKTLOG_ANY        = 0x00000005f,
  57 };
  58
  59 enum ath10k_dbg_aggr_mode {
  60         ATH10K_DBG_AGGR_MODE_AUTO,
  61         ATH10K_DBG_AGGR_MODE_MANUAL,
  62         ATH10K_DBG_AGGR_MODE_MAX,
  63 };
  64
  65 /* Types of packet log events */
  66 enum ath_pktlog_type {
  67         ATH_PKTLOG_TYPE_TX_CTRL = 1,
  68         ATH_PKTLOG_TYPE_TX_STAT,
  69 };
  70
  71 struct ath10k_pktlog_hdr {
  72         __le16 flags;
  73         __le16 missed_cnt;
  74         __le16 log_type; /* Type of log information foll this header */
  75         __le16 size; /* Size of variable length log information in bytes */
  76         __le32 timestamp;
  77         u8 payload[0];
  78 } __packed;
  79
  80 /* FIXME: How to calculate the buffer size sanely? */
  81 #define ATH10K_FW_STATS_BUF_SIZE (1024 * 1024)
  82
  83 extern unsigned int ath10k_debug_mask;
  84
  85 __printf(2, 3) void ath10k_info(struct ath10k *ar, const char *fmt, ...);
  86 __printf(2, 3) void ath10k_err(struct ath10k *ar, const char *fmt, ...);
  87 __printf(2, 3) void ath10k_warn(struct ath10k *ar, const char *fmt, ...);
  88
  89 void ath10k_debug_print_hwfw_info(struct ath10k *ar);
  90 void ath10k_debug_print_board_info(struct ath10k *ar);
  91 void ath10k_debug_print_boot_info(struct ath10k *ar);
  92 void ath10k_print_driver_info(struct ath10k *ar);
  93
  94 #ifdef CONFIG_ATH10K_DEBUGFS
  95 int ath10k_debug_start(struct ath10k *ar);
  96 void ath10k_debug_stop(struct ath10k *ar);
  97 int ath10k_debug_create(struct ath10k *ar);
  98 void ath10k_debug_destroy(struct ath10k *ar);
  99 int ath10k_debug_register(struct ath10k *ar);
 100 void ath10k_debug_unregister(struct ath10k *ar);
 101 void ath10k_debug_fw_stats_process(struct ath10k *ar, struct sk_buff *skb);
 102 void ath10k_debug_tpc_stats_process(struct ath10k *ar,
 103                                     struct ath10k_tpc_stats *tpc_stats);
 104 void ath10k_debug_dbglog_add(struct ath10k *ar, u8 *buffer, int len);
 105
 106 #define ATH10K_DFS_STAT_INC(ar, c) (ar->debug.dfs_stats.c++)
 107
 108 void ath10k_debug_get_et_strings(struct ieee80211_hw *hw,
 109                                  struct ieee80211_vif *vif,
 110                                  u32 sset, u8 *data);
 111 int ath10k_debug_get_et_sset_count(struct ieee80211_hw *hw,
 112                                    struct ieee80211_vif *vif, int sset);
 113 void ath10k_debug_get_et_stats(struct ieee80211_hw *hw,
 114                                struct ieee80211_vif *vif,
 115                                struct ethtool_stats *stats, u64 *data);
 116
 117 static inline u64 ath10k_debug_get_fw_dbglog_mask(struct ath10k *ar)
 118 {
 119         return ar->debug.fw_dbglog_mask;
 120 }
 121
 122 static inline u32 ath10k_debug_get_fw_dbglog_level(struct ath10k *ar)
 123 {
 124         return ar->debug.fw_dbglog_level;
 125 }
 126
 127 #else
 128
 129 static inline int ath10k_debug_start(struct ath10k *ar)
 130 {
 131         return 0;
 132 }
 133
 134 static inline void ath10k_debug_stop(struct ath10k *ar)
 135 {
 136 }
 137
 138 static inline int ath10k_debug_create(struct ath10k *ar)
 139 {
 140         return 0;
 141 }
 142
 143 static inline void ath10k_debug_destroy(struct ath10k *ar)
 144 {
 145 }
 146
 147 static inline int ath10k_debug_register(struct ath10k *ar)
 148 {
 149         return 0;
 150 }
 151
 152 static inline void ath10k_debug_unregister(struct ath10k *ar)
 153 {
 154 }
 155
 156 static inline void ath10k_debug_fw_stats_process(struct ath10k *ar,
 157                                                  struct sk_buff *skb)
 158 {
 159 }
 160
 161 static inline void ath10k_debug_tpc_stats_process(struct ath10k *ar,
 162                                                   struct ath10k_tpc_stats *tpc_stats)
 163 {
 164         kfree(tpc_stats);
 165 }
 166
 167 static inline void ath10k_debug_dbglog_add(struct ath10k *ar, u8 *buffer,
 168                                            int len)
 169 {
 170 }
 171
 172 static inline u64 ath10k_debug_get_fw_dbglog_mask(struct ath10k *ar)
 173 {
 174         return 0;
 175 }
 176
 177 static inline u32 ath10k_debug_get_fw_dbglog_level(struct ath10k *ar)
 178 {
 179         return 0;
 180 }
 181
 182 #define ATH10K_DFS_STAT_INC(ar, c) do { } while (0)
 183
 184 #define ath10k_debug_get_et_strings NULL
 185 #define ath10k_debug_get_et_sset_count NULL
 186 #define ath10k_debug_get_et_stats NULL
 187
 188 #endif /* CONFIG_ATH10K_DEBUGFS */
 189 #ifdef CONFIG_MAC80211_DEBUGFS
 190 void ath10k_sta_add_debugfs(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
 191                             struct ieee80211_sta *sta, struct dentry *dir);
 192 void ath10k_sta_update_rx_duration(struct ath10k *ar,
 193                                    struct ath10k_fw_stats *stats);
 194 #else
 195 static inline
 196 void ath10k_sta_update_rx_duration(struct ath10k *ar,
 197                                    struct ath10k_fw_stats *stats)
 198 {
 199 }
 200 #endif /* CONFIG_MAC80211_DEBUGFS */
 201
 202 #ifdef CONFIG_ATH10K_DEBUG
 203 __printf(3, 4) void ath10k_dbg(struct ath10k *ar,
 204                                enum ath10k_debug_mask mask,
 205                                const char *fmt, ...);
 206 void ath10k_dbg_dump(struct ath10k *ar,
 207                      enum ath10k_debug_mask mask,
 208                      const char *msg, const char *prefix,
 209                      const void *buf, size_t len);
 210 #else /* CONFIG_ATH10K_DEBUG */
 211
 212 static inline int ath10k_dbg(struct ath10k *ar,
 213                              enum ath10k_debug_mask dbg_mask,
 214                              const char *fmt, ...)
 215 {
 216         return 0;
 217 }
 218
 219 static inline void ath10k_dbg_dump(struct ath10k *ar,
 220                                    enum ath10k_debug_mask mask,
 221                                    const char *msg, const char *prefix,
 222                                    const void *buf, size_t len)
 223 {
 224 }
 225 #endif /* CONFIG_ATH10K_DEBUG */
 226 #endif /* _DEBUG_H_ */