/* SPDX-License-Identifier: ISC */
/*
 * Copyright (c) 2005-2011 Atheros Communications Inc.
 * Copyright (c) 2011-2017 Qualcomm Atheros, Inc.
 * Copyright (c) 2018, The Linux Foundation. All rights reserved.
 */

#ifndef _DEBUG_H_
#define _DEBUG_H_

#include <linux/types.h>
#include "trace.h"

enum ath10k_debug_mask {
        ATH10K_DBG_PCI          = 0x00000001,
        ATH10K_DBG_WMI          = 0x00000002,
        ATH10K_DBG_HTC          = 0x00000004,
        ATH10K_DBG_HTT          = 0x00000008,
        ATH10K_DBG_MAC          = 0x00000010,
        ATH10K_DBG_BOOT         = 0x00000020,
        ATH10K_DBG_PCI_DUMP     = 0x00000040,
        ATH10K_DBG_HTT_DUMP     = 0x00000080,
        ATH10K_DBG_MGMT         = 0x00000100,
        ATH10K_DBG_DATA         = 0x00000200,
        ATH10K_DBG_BMI          = 0x00000400,
        ATH10K_DBG_REGULATORY   = 0x00000800,
        ATH10K_DBG_TESTMODE     = 0x00001000,
        ATH10K_DBG_WMI_PRINT    = 0x00002000,
        ATH10K_DBG_PCI_PS       = 0x00004000,
        ATH10K_DBG_AHB          = 0x00008000,
        ATH10K_DBG_SDIO         = 0x00010000,
        ATH10K_DBG_SDIO_DUMP    = 0x00020000,
        ATH10K_DBG_USB          = 0x00040000,
        ATH10K_DBG_USB_BULK     = 0x00080000,
        ATH10K_DBG_SNOC         = 0x00100000,
        ATH10K_DBG_QMI          = 0x00200000,
        ATH10K_DBG_STA          = 0x00400000,
        ATH10K_DBG_ANY          = 0xffffffff,
};

enum ath10k_pktlog_filter {
        ATH10K_PKTLOG_RX         = 0x000000001,
        ATH10K_PKTLOG_TX         = 0x000000002,
        ATH10K_PKTLOG_RCFIND     = 0x000000004,
        ATH10K_PKTLOG_RCUPDATE   = 0x000000008,
        ATH10K_PKTLOG_DBG_PRINT  = 0x000000010,
        ATH10K_PKTLOG_PEER_STATS = 0x000000040,
        ATH10K_PKTLOG_ANY        = 0x00000005f,
};

enum ath10k_dbg_aggr_mode {
        ATH10K_DBG_AGGR_MODE_AUTO,
        ATH10K_DBG_AGGR_MODE_MANUAL,
        ATH10K_DBG_AGGR_MODE_MAX,
};

/* Types of packet log events */
enum ath_pktlog_type {
        ATH_PKTLOG_TYPE_TX_CTRL = 1,
        ATH_PKTLOG_TYPE_TX_STAT,
};

struct ath10k_pktlog_hdr {
        __le16 flags;
        __le16 missed_cnt;
        __le16 log_type; /* Type of log information foll this header */
        __le16 size; /* Size of variable length log information in bytes */
        __le32 timestamp;
        u8 payload[];
} __packed;

/* FIXME: How to calculate the buffer size sanely? */
#define ATH10K_FW_STATS_BUF_SIZE (1024 * 1024)

#define ATH10K_TX_POWER_MAX_VAL 70
#define ATH10K_TX_POWER_MIN_VAL 0

extern unsigned int ath10k_debug_mask;

__printf(2, 3) void ath10k_info(struct ath10k *ar, const char *fmt, ...);
__printf(2, 3) void ath10k_err(struct ath10k *ar, const char *fmt, ...);
__printf(2, 3) void ath10k_warn(struct ath10k *ar, const char *fmt, ...);

void ath10k_debug_print_hwfw_info(struct ath10k *ar);
void ath10k_debug_print_board_info(struct ath10k *ar);
void ath10k_debug_print_boot_info(struct ath10k *ar);
void ath10k_print_driver_info(struct ath10k *ar);

#ifdef CONFIG_ATH10K_DEBUGFS
int ath10k_debug_start(struct ath10k *ar);
void ath10k_debug_stop(struct ath10k *ar);
int ath10k_debug_create(struct ath10k *ar);
void ath10k_debug_destroy(struct ath10k *ar);
int ath10k_debug_register(struct ath10k *ar);
void ath10k_debug_unregister(struct ath10k *ar);
void ath10k_debug_fw_stats_process(struct ath10k *ar, struct sk_buff *skb);
void ath10k_debug_tpc_stats_process(struct ath10k *ar,
                                    struct ath10k_tpc_stats *tpc_stats);
void
ath10k_debug_tpc_stats_final_process(struct ath10k *ar,
                                     struct ath10k_tpc_stats_final *tpc_stats);
void ath10k_debug_dbglog_add(struct ath10k *ar, u8 *buffer, int len);

#define ATH10K_DFS_STAT_INC(ar, c) (ar->debug.dfs_stats.c++)

void ath10k_debug_get_et_strings(struct ieee80211_hw *hw,
                                 struct ieee80211_vif *vif,
                                 u32 sset, u8 *data);
int ath10k_debug_get_et_sset_count(struct ieee80211_hw *hw,
                                   struct ieee80211_vif *vif, int sset);
void ath10k_debug_get_et_stats(struct ieee80211_hw *hw,
                               struct ieee80211_vif *vif,
                               struct ethtool_stats *stats, u64 *data);

static inline u64 ath10k_debug_get_fw_dbglog_mask(struct ath10k *ar)
{
        return ar->debug.fw_dbglog_mask;
}

static inline u32 ath10k_debug_get_fw_dbglog_level(struct ath10k *ar)
{
        return ar->debug.fw_dbglog_level;
}

static inline int ath10k_debug_is_extd_tx_stats_enabled(struct ath10k *ar)
{
        return ar->debug.enable_extd_tx_stats;
}

int ath10k_debug_fw_stats_request(struct ath10k *ar);

#else

static inline int ath10k_debug_start(struct ath10k *ar)
{
        return 0;
}

static inline void ath10k_debug_stop(struct ath10k *ar)
{
}

static inline int ath10k_debug_create(struct ath10k *ar)
{
        return 0;
}

static inline void ath10k_debug_destroy(struct ath10k *ar)
{
}

static inline int ath10k_debug_register(struct ath10k *ar)
{
        return 0;
}

static inline void ath10k_debug_unregister(struct ath10k *ar)
{
}

static inline void ath10k_debug_fw_stats_process(struct ath10k *ar,
                                                 struct sk_buff *skb)
{
}

static inline void ath10k_debug_tpc_stats_process(struct ath10k *ar,
                                                  struct ath10k_tpc_stats *tpc_stats)
{
        kfree(tpc_stats);
}

static inline void
ath10k_debug_tpc_stats_final_process(struct ath10k *ar,
                                     struct ath10k_tpc_stats_final *tpc_stats)
{
        kfree(tpc_stats);
}

static inline void ath10k_debug_dbglog_add(struct ath10k *ar, u8 *buffer,
                                           int len)
{
}

static inline u64 ath10k_debug_get_fw_dbglog_mask(struct ath10k *ar)
{
        return 0;
}

static inline u32 ath10k_debug_get_fw_dbglog_level(struct ath10k *ar)
{
        return 0;
}

static inline int ath10k_debug_is_extd_tx_stats_enabled(struct ath10k *ar)
{
        return 0;
}

static inline int ath10k_debug_fw_stats_request(struct ath10k *ar)
{
        return 0;
}

#define ATH10K_DFS_STAT_INC(ar, c) do { } while (0)

#define ath10k_debug_get_et_strings NULL
#define ath10k_debug_get_et_sset_count NULL
#define ath10k_debug_get_et_stats NULL

#endif /* CONFIG_ATH10K_DEBUGFS */
#ifdef CONFIG_MAC80211_DEBUGFS
void ath10k_sta_add_debugfs(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
                            struct ieee80211_sta *sta, struct dentry *dir);
void ath10k_sta_update_rx_duration(struct ath10k *ar,
                                   struct ath10k_fw_stats *stats);
void ath10k_sta_update_rx_tid_stats(struct ath10k *ar, u8 *first_hdr,
                                    unsigned long num_msdus,
                                    enum ath10k_pkt_rx_err err,
                                    unsigned long unchain_cnt,
                                    unsigned long drop_cnt,
                                    unsigned long drop_cnt_filter,
                                    unsigned long queued_msdus);
void ath10k_sta_update_rx_tid_stats_ampdu(struct ath10k *ar,
                                          u16 peer_id, u8 tid,
                                          struct htt_rx_indication_mpdu_range *ranges,
                                          int num_ranges);
#else
static inline
void ath10k_sta_update_rx_duration(struct ath10k *ar,
                                   struct ath10k_fw_stats *stats)
{
}

static inline
void ath10k_sta_update_rx_tid_stats(struct ath10k *ar, u8 *first_hdr,
                                    unsigned long num_msdus,
                                    enum ath10k_pkt_rx_err err,
                                    unsigned long unchain_cnt,
                                    unsigned long drop_cnt,
                                    unsigned long drop_cnt_filter,
                                    unsigned long queued_msdus)
{
}

static inline
void ath10k_sta_update_rx_tid_stats_ampdu(struct ath10k *ar,
                                          u16 peer_id, u8 tid,
                                          struct htt_rx_indication_mpdu_range *ranges,
                                          int num_ranges)
{
}
#endif /* CONFIG_MAC80211_DEBUGFS */

#ifdef CONFIG_ATH10K_DEBUG
__printf(3, 4) void __ath10k_dbg(struct ath10k *ar,
                                 enum ath10k_debug_mask mask,
                                 const char *fmt, ...);
void ath10k_dbg_dump(struct ath10k *ar,
                     enum ath10k_debug_mask mask,
                     const char *msg, const char *prefix,
                     const void *buf, size_t len);
#else /* CONFIG_ATH10K_DEBUG */

static inline int __ath10k_dbg(struct ath10k *ar,
                               enum ath10k_debug_mask dbg_mask,
                               const char *fmt, ...)
{
        return 0;
}

static inline void ath10k_dbg_dump(struct ath10k *ar,
                                   enum ath10k_debug_mask mask,
                                   const char *msg, const char *prefix,
                                   const void *buf, size_t len)
{
}
#endif /* CONFIG_ATH10K_DEBUG */

/* Avoid calling __ath10k_dbg() if debug_mask is not set and tracing
 * disabled.
 */
#define ath10k_dbg(ar, dbg_mask, fmt, ...)                      \
do {                                                            \
        if ((ath10k_debug_mask & dbg_mask) ||                   \
            trace_ath10k_log_dbg_enabled())                     \
                __ath10k_dbg(ar, dbg_mask, fmt, ##__VA_ARGS__); \
} while (0)
#endif /* _DEBUG_H_ */