1*5113495bSYour Name /* 2*5113495bSYour Name * Copyright (c) 2018-2019 The Linux Foundation. All rights reserved. 3*5113495bSYour Name * Copyright (c) 2022 Qualcomm Innovation Center, Inc. All rights reserved. 4*5113495bSYour Name * 5*5113495bSYour Name * Permission to use, copy, modify, and/or distribute this software for 6*5113495bSYour Name * any purpose with or without fee is hereby granted, provided that the 7*5113495bSYour Name * above copyright notice and this permission notice appear in all 8*5113495bSYour Name * copies. 9*5113495bSYour Name * 10*5113495bSYour Name * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL 11*5113495bSYour Name * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED 12*5113495bSYour Name * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE 13*5113495bSYour Name * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL 14*5113495bSYour Name * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR 15*5113495bSYour Name * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER 16*5113495bSYour Name * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR 17*5113495bSYour Name * PERFORMANCE OF THIS SOFTWARE. 18*5113495bSYour Name */ 19*5113495bSYour Name 20*5113495bSYour Name #ifndef _FW_DBGLOG_API_H_ 21*5113495bSYour Name #define _FW_DBGLOG_API_H_ 22*5113495bSYour Name 23*5113495bSYour Name #include "target_if.h" 24*5113495bSYour Name 25*5113495bSYour Name /** 26*5113495bSYour Name * fwdbg_set_log_lvl() - API to set debug log level 27*5113495bSYour Name * @dbg_handle: Debug module handle 28*5113495bSYour Name * @scn: scn handle 29*5113495bSYour Name * @log_lvl: value of log level 30*5113495bSYour Name * 31*5113495bSYour Name * Send wmi configuration command to set debug log level. 32*5113495bSYour Name * 33*5113495bSYour Name * Return: None 34*5113495bSYour Name */ 35*5113495bSYour Name void fwdbg_set_log_lvl(struct common_dbglog_handle *dbg_handle, ol_scn_t scn, 36*5113495bSYour Name uint32_t log_lvl); 37*5113495bSYour Name 38*5113495bSYour Name /** 39*5113495bSYour Name * fwdbg_fw_handler() - Firmware handler interface 40*5113495bSYour Name * @dbg_handle: Debug module handle 41*5113495bSYour Name * @sc: soc handle 42*5113495bSYour Name * @data: Reference to command data 43*5113495bSYour Name * @datalen: length of data 44*5113495bSYour Name * 45*5113495bSYour Name * Return: 0 success 46*5113495bSYour Name */ 47*5113495bSYour Name int fwdbg_fw_handler(struct common_dbglog_handle *dbg_handle, ol_scn_t sc, 48*5113495bSYour Name uint8_t *data, uint32_t datalen); 49*5113495bSYour Name 50*5113495bSYour Name /** 51*5113495bSYour Name * fwdbg_parse_debug_logs() - API to parse firmware debug logs 52*5113495bSYour Name * @dbg_handle: Debug module handle 53*5113495bSYour Name * @soc: soc handle 54*5113495bSYour Name * @datap: Reference to log data 55*5113495bSYour Name * @len: length of data 56*5113495bSYour Name * @context: log context 57*5113495bSYour Name * 58*5113495bSYour Name * API parse firmware debug log messages and prints to console. 59*5113495bSYour Name * 60*5113495bSYour Name * Return: 0 success 61*5113495bSYour Name */ 62*5113495bSYour Name int fwdbg_parse_debug_logs(struct common_dbglog_handle *dbg_handle, 63*5113495bSYour Name ol_scn_t soc, uint8_t *datap, 64*5113495bSYour Name uint16_t len, void *context); 65*5113495bSYour Name 66*5113495bSYour Name /** 67*5113495bSYour Name * fwdbg_ratelimit_set() - API to set rate limit 68*5113495bSYour Name * @dbg_handle: Debug module handle 69*5113495bSYour Name * @burst_limit: burst limit 70*5113495bSYour Name * 71*5113495bSYour Name * Return: None 72*5113495bSYour Name */ 73*5113495bSYour Name void fwdbg_ratelimit_set(struct common_dbglog_handle *dbg_handle, 74*5113495bSYour Name uint32_t burst_limit); 75*5113495bSYour Name 76*5113495bSYour Name /** 77*5113495bSYour Name * fwdbg_vap_log_enable() - API to Enable/Disable the logging for VAP 78*5113495bSYour Name * @dbg_handle: Debug module handle 79*5113495bSYour Name * @scn: scn handle 80*5113495bSYour Name * @vap_id: VAP id 81*5113495bSYour Name * @isenable: Enable/disable 82*5113495bSYour Name * 83*5113495bSYour Name * API allows to enable or disable debuglogs at VAP level. It encodes wmi 84*5113495bSYour Name * config command based on VAP id and sends wmi command to firmware to 85*5113495bSYour Name * enable/disable debuglog. 86*5113495bSYour Name * 87*5113495bSYour Name * Return: None 88*5113495bSYour Name */ 89*5113495bSYour Name void fwdbg_vap_log_enable(struct common_dbglog_handle *dbg_handle, ol_scn_t scn, 90*5113495bSYour Name uint16_t vap_id, bool isenable); 91*5113495bSYour Name 92*5113495bSYour Name /** 93*5113495bSYour Name * fwdbg_set_timestamp_resolution - Set the resolution for time stamp 94*5113495bSYour Name * @dbg_handle: Debug module handle 95*5113495bSYour Name * @scn: scn handle 96*5113495bSYour Name * @tsr: time stamp resolution 97*5113495bSYour Name * 98*5113495bSYour Name * Set the resolution for time stamp in debug logs. It encodes wmi 99*5113495bSYour Name * config command to desired timestamp resolution and sends wmi command to 100*5113495bSYour Name * firmware. 101*5113495bSYour Name * 102*5113495bSYour Name * Return: None 103*5113495bSYour Name */ 104*5113495bSYour Name void fwdbg_set_timestamp_resolution(struct common_dbglog_handle *dbg_handle, 105*5113495bSYour Name ol_scn_t scn, uint16_t tsr); 106*5113495bSYour Name 107*5113495bSYour Name /** 108*5113495bSYour Name * fwdbg_reporting_enable() - Enable reporting. 109*5113495bSYour Name * @dbg_handle: Debug module handle 110*5113495bSYour Name * @scn: scn handle 111*5113495bSYour Name * @isenable: Enable/disable 112*5113495bSYour Name * 113*5113495bSYour Name * API to enable debug information reporting. It encodes wmi config command 114*5113495bSYour Name * to enable reporting. If set to false then Target won't deliver any debug 115*5113495bSYour Name * information. 116*5113495bSYour Name * 117*5113495bSYour Name * Return: None 118*5113495bSYour Name */ 119*5113495bSYour Name void fwdbg_reporting_enable(struct common_dbglog_handle *dbg_handle, 120*5113495bSYour Name ol_scn_t scn, bool isenable); 121*5113495bSYour Name 122*5113495bSYour Name /** 123*5113495bSYour Name * fwdbg_module_log_enable() - Enable/Disable logging for Module. 124*5113495bSYour Name * @dbg_handle: Debug module handle 125*5113495bSYour Name * @scn: scn handle 126*5113495bSYour Name * @mod_id: Module id 127*5113495bSYour Name * @isenable: Enable/disable 128*5113495bSYour Name * 129*5113495bSYour Name * API allows to enable or disable debuglogs per module. It encodes wmi 130*5113495bSYour Name * config command based on module id and sends wmi command to firmware to 131*5113495bSYour Name * enable/disable debuglog for that module. 132*5113495bSYour Name * 133*5113495bSYour Name * Return: None 134*5113495bSYour Name */ 135*5113495bSYour Name void fwdbg_module_log_enable(struct common_dbglog_handle *dbg_handle, 136*5113495bSYour Name ol_scn_t scn, uint32_t mod_id, bool isenable); 137*5113495bSYour Name 138*5113495bSYour Name /** 139*5113495bSYour Name * fwdbg_init() - Initialize debuglog. 140*5113495bSYour Name * @dbg_handle: Debug module handle 141*5113495bSYour Name * @soc: soc handle 142*5113495bSYour Name * 143*5113495bSYour Name * It initializes debuglog print function for set of modules and 144*5113495bSYour Name * initializes WMI event handler for debuglog message event. 145*5113495bSYour Name * 146*5113495bSYour Name * Return: None 147*5113495bSYour Name */ 148*5113495bSYour Name void fwdbg_init(struct common_dbglog_handle *dbg_handle, void *soc); 149*5113495bSYour Name 150*5113495bSYour Name /** 151*5113495bSYour Name * fwdbg_free() - Free debug handler. 152*5113495bSYour Name * @dbg_handle: Debug module handle 153*5113495bSYour Name * @soc: soc handle 154*5113495bSYour Name * 155*5113495bSYour Name * Return: None 156*5113495bSYour Name */ 157*5113495bSYour Name void fwdbg_free(struct common_dbglog_handle *dbg_handle, void *soc); 158*5113495bSYour Name 159*5113495bSYour Name /** 160*5113495bSYour Name * fwdbg_set_report_size() - set the size of the report size 161*5113495bSYour Name * @dbg_handle: Debug module handle 162*5113495bSYour Name * @scn: soc handler 163*5113495bSYour Name * @size: Report size 164*5113495bSYour Name * 165*5113495bSYour Name * Set the debug log report size. It encodes wmi config command to 166*5113495bSYour Name * desired report size and sends wmi command to firmware. 167*5113495bSYour Name * 168*5113495bSYour Name * Return: None 169*5113495bSYour Name */ 170*5113495bSYour Name void fwdbg_set_report_size(struct common_dbglog_handle *dbg_handle, 171*5113495bSYour Name ol_scn_t scn, uint16_t size); 172*5113495bSYour Name 173*5113495bSYour Name /** 174*5113495bSYour Name * fwdbg_smartlog_init() - initialize smart logging feature 175*5113495bSYour Name * @dbg_handle: Debug module handle 176*5113495bSYour Name * @ic: ic handler 177*5113495bSYour Name * 178*5113495bSYour Name * Return: 0 Success 179*5113495bSYour Name */ 180*5113495bSYour Name int fwdbg_smartlog_init(struct common_dbglog_handle *dbg_handle, void *icp); 181*5113495bSYour Name 182*5113495bSYour Name /** 183*5113495bSYour Name * fwdbg_smartlog_deinit() - uninitializes smart logging feature 184*5113495bSYour Name * @dbg_handle: Debug module handle 185*5113495bSYour Name * @sc: sc handler 186*5113495bSYour Name * 187*5113495bSYour Name * Return: None 188*5113495bSYour Name */ 189*5113495bSYour Name void fwdbg_smartlog_deinit(struct common_dbglog_handle *dbg_handle, void *sc); 190*5113495bSYour Name 191*5113495bSYour Name /** 192*5113495bSYour Name * fwdbg_smartlog_dump() - dumps smart logs 193*5113495bSYour Name * @dev: dev handler 194*5113495bSYour Name * @dbg_handle: Debug module handle 195*5113495bSYour Name * @attr: dev handler attributes 196*5113495bSYour Name * @buf: destination buffer to dump smart logs 197*5113495bSYour Name * 198*5113495bSYour Name * Return: 0 success 199*5113495bSYour Name */ 200*5113495bSYour Name ssize_t fwdbg_smartlog_dump(struct common_dbglog_handle *dbg_handle, 201*5113495bSYour Name struct device *dev, 202*5113495bSYour Name struct device_attribute *attr, char *buf); 203*5113495bSYour Name #endif /* _FW_DBGLOG_API_H_ */ 204