/* SPDX-License-Identifier: GPL-2.0 */
/* Copyright(c) 2007 - 2017 Realtek Corporation */
#ifndef __ODM_DBG_H__
#define __ODM_DBG_H__
#define DEBUG_VERSION "1.4" /*2017.03.13 Dino*/
/* -----------------------------------------------------------------------------
* Define the debug levels
*
* 1. DBG_TRACE and DBG_LOUD are used for normal cases.
* So that, they can help SW engineer to develope or trace states changed
* and also help HW enginner to trace every operation to and from HW,
* e.g IO, Tx, Rx.
*
* 2. DBG_WARNNING and DBG_SERIOUS are used for unusual or error cases,
* which help us to debug SW or HW.
*
* -----------------------------------------------------------------------------
*
* Never used in a call to ODM_RT_TRACE()!
* */
#define ODM_DBG_OFF 1
/*
* Fatal bug.
* For example, Tx/Rx/IO locked up, OS hangs, memory access violation,
* resource allocation failed, unexpected HW behavior, HW BUG and so on.
* */
#define ODM_DBG_SERIOUS 2
/*
* Abnormal, rare, or unexpeted cases.
* For example, IRP/Packet/OID canceled, device suprisely unremoved and so on.
* */
#define ODM_DBG_WARNING 3
/*
* Normal case with useful information about current SW or HW state.
* For example, Tx/Rx descriptor to fill, Tx/Rx descriptor completed status,
* SW protocol state change, dynamic mechanism state change and so on.
* */
#define ODM_DBG_LOUD 4
/*
* Normal case with detail execution flow or information.
* */
#define ODM_DBG_TRACE 5
/*FW DBG MSG*/
#define RATE_DECISION BIT(0)
#define INIT_RA_TABLE BIT(1)
#define RATE_UP BIT(2)
#define RATE_DOWN BIT(3)
#define TRY_DONE BIT(4)
#define RA_H2C BIT(5)
#define F_RATE_AP_RPT BIT(7)
/* -----------------------------------------------------------------------------
* Define the tracing components
*
* -----------------------------------------------------------------------------
*BB FW Functions*/
#define PHYDM_FW_COMP_RA BIT(0)
#define PHYDM_FW_COMP_MU BIT(1)
#define PHYDM_FW_COMP_PATH_DIV BIT(2)
#define PHYDM_FW_COMP_PT BIT(3)
/*------------------------Export Marco Definition---------------------------*/
#define config_phydm_read_txagc_check(data) (data != INVALID_TXAGC_DATA)
#define dbg_print printk
#define RT_PRINTK(fmt, args...) dbg_print(fmt, ## args)
#define RT_DISP(dbgtype, dbgflag, printstr)
#ifndef ASSERT
#define ASSERT(expr)
#endif
#if DBG
#define PHYDM_DBG(p_dm, comp, fmt) \
do { \
if ((comp) & (p_dm->debug_components)) { \
dbg_print("[PHYDM] "); \
RT_PRINTK fmt; \
} \
} while (0)
#define PHYDM_DBG_F(p_dm, comp, fmt) do {\
if ((comp) & p_dm->debug_components) { \
RT_PRINTK fmt; \
} \
} while (0)
#define PHYDM_PRINT_ADDR(p_dm, comp, title_str, ptr) do {\
if ((comp) & p_dm->debug_components) { \
int __i; \
u8 *__ptr = (u8 *)ptr; \
dbg_print("[PHYDM] "); \
dbg_print(title_str); \
dbg_print(" "); \
for (__i = 0; __i < 6; __i++) \
dbg_print("%02X%s", __ptr[__i], (__i == 5) ? "" : "-"); \
dbg_print("\n"); \
} \
} while (0)
#define ODM_RT_TRACE(p_dm, comp, level, fmt) \
do { \
if (((comp) & p_dm->debug_components) && (level <= p_dm->debug_level || level == ODM_DBG_SERIOUS)) { \
if (p_dm->support_ic_type == ODM_RTL8188E) \
dbg_print("[PhyDM-8188E] "); \
else if (p_dm->support_ic_type == ODM_RTL8192E) \
dbg_print("[PhyDM-8192E] "); \
else if (p_dm->support_ic_type == ODM_RTL8812) \
dbg_print("[PhyDM-8812A] "); \
else if (p_dm->support_ic_type == ODM_RTL8821) \
dbg_print("[PhyDM-8821A] "); \
else if (p_dm->support_ic_type == ODM_RTL8814A) \
dbg_print("[PhyDM-8814A] "); \
else if (p_dm->support_ic_type == ODM_RTL8703B) \
dbg_print("[PhyDM-8703B] "); \
else if (p_dm->support_ic_type == ODM_RTL8822B) \
dbg_print("[PhyDM-8822B] "); \
else if (p_dm->support_ic_type == ODM_RTL8188F) \
dbg_print("[PhyDM-8188F] "); \
RT_PRINTK fmt; \
} \
} while (0)
#else
#define PHYDM_DBG(p_dm, comp, fmt)
#define PHYDM_DBG_F(p_dm, comp, fmt)
#define PHYDM_PRINT_ADDR(p_dm, comp, title_str, ptr)
#define ODM_RT_TRACE(p_dm, comp, level, fmt)
#endif
#define BB_DBGPORT_PRIORITY_3 3 /*Debug function (the highest priority)*/
#define BB_DBGPORT_PRIORITY_2 2 /*Check hang function & Strong function*/
#define BB_DBGPORT_PRIORITY_1 1 /*Watch dog function*/
#define BB_DBGPORT_RELEASE 0 /*Init value (the lowest priority)*/
#define PHYDM_DBGPRINT 0
#define MAX_ARGC 20
#define MAX_ARGV 16
#define DCMD_DECIMAL "%d"
#define DCMD_CHAR "%c"
#define DCMD_HEX "%x"
#define PHYDM_SSCANF(x, y, z) sscanf(x, y, z)
#define PHYDM_VAST_INFO_SNPRINTF(msg)\
do {\
snprintf msg;\
dbg_print(output);\
} while (0)
#if (PHYDM_DBGPRINT == 1)
#define PHYDM_SNPRINTF(msg)\
do {\
snprintf msg;\
dbg_print(output);\
} while (0)
#else
#define PHYDM_SNPRINTF(msg)\
do {\
if (out_len > used)\
used += snprintf msg;\
} while (0)
#endif
void
phydm_init_debug_setting(
struct PHY_DM_STRUCT *p_dm
);
void
phydm_bb_dbg_port_header_sel(
void *p_dm_void,
u32 header_idx
);
u8
phydm_set_bb_dbg_port(
void *p_dm_void,
u8 curr_dbg_priority,
u32 debug_port
);
void
phydm_release_bb_dbg_port(
void *p_dm_void
);
u32
phydm_get_bb_dbg_port_value(
void *p_dm_void
);
void
phydm_reset_rx_rate_distribution(
struct PHY_DM_STRUCT *p_dm_odm
);
void
phydm_rx_rate_distribution
(
void *p_dm_void
);
void
phydm_get_avg_phystatus_val
(
void *p_dm_void
);
void
phydm_get_phy_statistic(
void *p_dm_void
);
void
phydm_basic_dbg_message(
void *p_dm_void
);
void
phydm_basic_profile(
void *p_dm_void,
u32 *_used,
char *output,
u32 *_out_len
);
s32
phydm_cmd(
struct PHY_DM_STRUCT *p_dm,
char *input,
u32 in_len,
u8 flag,
char *output,
u32 out_len
);
void
phydm_cmd_parser(
struct PHY_DM_STRUCT *p_dm,
char input[][16],
u32 input_num,
u8 flag,
char *output,
u32 out_len
);
void
phydm_fw_trace_en_h2c(
void *p_dm_void,
bool enable,
u32 fw_debug_component,
u32 monitor_mode,
u32 macid
);
void
phydm_fw_trace_handler(
void *p_dm_void,
u8 *cmd_buf,
u8 cmd_len
);
void
phydm_fw_trace_handler_code(
void *p_dm_void,
u8 *buffer,
u8 cmd_len
);
void
phydm_fw_trace_handler_8051(
void *p_dm_void,
u8 *cmd_buf,
u8 cmd_len
);
#endif /* __ODM_DBG_H__ */