Commit cad2bd8a authored by Chin-Yen Lee's avatar Chin-Yen Lee Committed by Kalle Valo
Browse files

wifi: rtw89: support firmware log with formatted text 



Original firmware log which is sent via C2H message bloats
code size of firmware and is also length-limited. So we put
some common log into format file, and firmware could use a
log ID and some variables in C2H message to map a formatted
text via pre-designed rule.

Signed-off-by: default avatarChin-Yen Lee <timlee@realtek.com>
Signed-off-by: default avatarPing-Ke Shih <pkshih@realtek.com>
Signed-off-by: default avatarKalle Valo <kvalo@kernel.org>
Link: https://lore.kernel.org/r/20230801021127.15919-3-pkshih@realtek.com
parent 05208419

drivers/net/wireless/realtek/rtw89/core.c

+1 −1
Original line number Diff line number Diff line
@@ -3508,7 +3508,7 @@ int rtw89_core_start(struct rtw89_dev *rtwdev) 
	set_bit(RTW89_FLAG_RUNNING, rtwdev->flags);



	rtw89_btc_ntfy_radio_state(rtwdev, BTC_RFCTRL_WL_ON);

	rtw89_fw_h2c_fw_log(rtwdev, rtwdev->fw.fw_log_enable);

	rtw89_fw_h2c_fw_log(rtwdev, rtwdev->fw.log.enable);

	rtw89_fw_h2c_init_ba_cam(rtwdev);



	return 0;

drivers/net/wireless/realtek/rtw89/core.h

+11 −3
Original line number Diff line number Diff line
@@ -3599,6 +3599,15 @@ struct rtw89_fw_req_info { 
	struct completion completion;

};



struct rtw89_fw_log {

	struct rtw89_fw_suit suit;

	bool enable;

	u32 last_fmt_id;

	u32 fmt_count;

	const __le32 *fmt_ids;

	const char *(*fmts)[];

};



struct rtw89_fw_info {

	struct rtw89_fw_req_info req;

	int fw_format;
@@ -3608,8 +3617,7 @@ struct rtw89_fw_info { 
	u8 c2h_counter;

	struct rtw89_fw_suit normal;

	struct rtw89_fw_suit wowlan;

	struct rtw89_fw_suit logfmt;

	bool fw_log_enable;

	struct rtw89_fw_log log;

	u32 feature_map;

};
@@ -5146,7 +5154,7 @@ static inline struct rtw89_fw_suit *rtw89_fw_suit_get(struct rtw89_dev *rtwdev, 
	if (type == RTW89_FW_WOWLAN)

		return &fw_info->wowlan;

	else if (type == RTW89_FW_LOGFMT)

		return &fw_info->logfmt;

		return &fw_info->log.suit;

	return &fw_info->normal;

}

drivers/net/wireless/realtek/rtw89/debug.c

+8 −6
Original line number Diff line number Diff line
@@ -3204,20 +3204,22 @@ static ssize_t rtw89_debug_priv_btc_manual_set(struct file *filp, 
	return count;

}



static ssize_t rtw89_debug_fw_log_btc_manual_set(struct file *filp,

static ssize_t rtw89_debug_fw_log_manual_set(struct file *filp,

					     const char __user *user_buf,

					     size_t count, loff_t *loff)

{

	struct rtw89_debugfs_priv *debugfs_priv = filp->private_data;

	struct rtw89_dev *rtwdev = debugfs_priv->rtwdev;

	struct rtw89_fw_info *fw_info = &rtwdev->fw;

	struct rtw89_fw_log *log = &rtwdev->fw.log;

	bool fw_log_manual;



	if (kstrtobool_from_user(user_buf, count, &fw_log_manual))

		goto out;



	mutex_lock(&rtwdev->mutex);

	fw_info->fw_log_enable = fw_log_manual;

	log->enable = fw_log_manual;

	if (log->enable)

		rtw89_fw_log_prepare(rtwdev);

	rtw89_fw_h2c_fw_log(rtwdev, fw_log_manual);

	mutex_unlock(&rtwdev->mutex);

out:
@@ -3584,7 +3586,7 @@ static struct rtw89_debugfs_priv rtw89_debug_priv_btc_manual = { 
};



static struct rtw89_debugfs_priv rtw89_debug_priv_fw_log_manual = {

	.cb_write = rtw89_debug_fw_log_btc_manual_set,

	.cb_write = rtw89_debug_fw_log_manual_set,

};



static struct rtw89_debugfs_priv rtw89_debug_priv_phy_info = {

drivers/net/wireless/realtek/rtw89/fw.c

+145 −1
Original line number Diff line number Diff line
@@ -697,6 +697,150 @@ void rtw89_unload_firmware(struct rtw89_dev *rtwdev) 
		 */

		fw->req.firmware = NULL;

	}



	kfree(fw->log.fmts);

}



static u32 rtw89_fw_log_get_fmt_idx(struct rtw89_dev *rtwdev, u32 fmt_id)

{

	struct rtw89_fw_log *fw_log = &rtwdev->fw.log;

	u32 i;



	if (fmt_id > fw_log->last_fmt_id)

		return 0;



	for (i = 0; i < fw_log->fmt_count; i++) {

		if (le32_to_cpu(fw_log->fmt_ids[i]) == fmt_id)

			return i;

	}

	return 0;

}



static int rtw89_fw_log_create_fmts_dict(struct rtw89_dev *rtwdev)

{

	struct rtw89_fw_log *log = &rtwdev->fw.log;

	const struct rtw89_fw_logsuit_hdr *suit_hdr;

	struct rtw89_fw_suit *suit = &log->suit;

	const void *fmts_ptr, *fmts_end_ptr;

	u32 fmt_count;

	int i;



	suit_hdr = (const struct rtw89_fw_logsuit_hdr *)suit->data;

	fmt_count = le32_to_cpu(suit_hdr->count);

	log->fmt_ids = suit_hdr->ids;

	fmts_ptr = &suit_hdr->ids[fmt_count];

	fmts_end_ptr = suit->data + suit->size;

	log->fmts = kcalloc(fmt_count, sizeof(char *), GFP_KERNEL);

	if (!log->fmts)

		return -ENOMEM;



	for (i = 0; i < fmt_count; i++) {

		fmts_ptr = memchr_inv(fmts_ptr, 0, fmts_end_ptr - fmts_ptr);

		if (!fmts_ptr)

			break;



		(*log->fmts)[i] = fmts_ptr;

		log->last_fmt_id = le32_to_cpu(log->fmt_ids[i]);

		log->fmt_count++;

		fmts_ptr += strlen(fmts_ptr);

	}



	return 0;

}



int rtw89_fw_log_prepare(struct rtw89_dev *rtwdev)

{

	struct rtw89_fw_log *log = &rtwdev->fw.log;

	struct rtw89_fw_suit *suit = &log->suit;



	if (!suit || !suit->data) {

		rtw89_debug(rtwdev, RTW89_DBG_FW, "no log format file\n");

		return -EINVAL;

	}

	if (log->fmts)

		return 0;



	return rtw89_fw_log_create_fmts_dict(rtwdev);

}



static void rtw89_fw_log_dump_data(struct rtw89_dev *rtwdev,

				   const struct rtw89_fw_c2h_log_fmt *log_fmt,

				   u32 fmt_idx, u8 para_int, bool raw_data)

{

	const char *(*fmts)[] = rtwdev->fw.log.fmts;

	char str_buf[RTW89_C2H_FW_LOG_STR_BUF_SIZE];

	u32 args[RTW89_C2H_FW_LOG_MAX_PARA_NUM] = {0};

	int i;



	if (log_fmt->argc > RTW89_C2H_FW_LOG_MAX_PARA_NUM) {

		rtw89_warn(rtwdev, "C2H log: Arg count is unexpected %d\n",

			   log_fmt->argc);

		return;

	}



	if (para_int)

		for (i = 0 ; i < log_fmt->argc; i++)

			args[i] = le32_to_cpu(log_fmt->u.argv[i]);



	if (raw_data) {

		if (para_int)

			snprintf(str_buf, RTW89_C2H_FW_LOG_STR_BUF_SIZE,

				 "fw_enc(%d, %d, %d) %*ph", le32_to_cpu(log_fmt->fmt_id),

				 para_int, log_fmt->argc, (int)sizeof(args), args);

		else

			snprintf(str_buf, RTW89_C2H_FW_LOG_STR_BUF_SIZE,

				 "fw_enc(%d, %d, %d, %s)", le32_to_cpu(log_fmt->fmt_id),

				 para_int, log_fmt->argc, log_fmt->u.raw);

	} else {

		snprintf(str_buf, RTW89_C2H_FW_LOG_STR_BUF_SIZE, (*fmts)[fmt_idx],

			 args[0x0], args[0x1], args[0x2], args[0x3], args[0x4],

			 args[0x5], args[0x6], args[0x7], args[0x8], args[0x9],

			 args[0xa], args[0xb], args[0xc], args[0xd], args[0xe],

			 args[0xf]);

	}



	rtw89_info(rtwdev, "C2H log: %s", str_buf);

}



void rtw89_fw_log_dump(struct rtw89_dev *rtwdev, u8 *buf, u32 len)

{

	const struct rtw89_fw_c2h_log_fmt *log_fmt;

	u8 para_int;

	u32 fmt_idx;



	if (len < RTW89_C2H_HEADER_LEN) {

		rtw89_err(rtwdev, "c2h log length is wrong!\n");

		return;

	}



	buf += RTW89_C2H_HEADER_LEN;

	len -= RTW89_C2H_HEADER_LEN;

	log_fmt = (const struct rtw89_fw_c2h_log_fmt *)buf;



	if (len < RTW89_C2H_FW_FORMATTED_LOG_MIN_LEN)

		goto plain_log;



	if (log_fmt->signature != cpu_to_le16(RTW89_C2H_FW_LOG_SIGNATURE))

		goto plain_log;



	if (!rtwdev->fw.log.fmts)

		return;



	para_int = u8_get_bits(log_fmt->feature, RTW89_C2H_FW_LOG_FEATURE_PARA_INT);

	fmt_idx = rtw89_fw_log_get_fmt_idx(rtwdev, le32_to_cpu(log_fmt->fmt_id));



	if (!para_int && log_fmt->argc != 0 && fmt_idx != 0)

		rtw89_info(rtwdev, "C2H log: %s%s",

			   (*rtwdev->fw.log.fmts)[fmt_idx], log_fmt->u.raw);

	else if (fmt_idx != 0 && para_int)

		rtw89_fw_log_dump_data(rtwdev, log_fmt, fmt_idx, para_int, false);

	else

		rtw89_fw_log_dump_data(rtwdev, log_fmt, fmt_idx, para_int, true);

	return;



plain_log:

	rtw89_info(rtwdev, "C2H log: %*s", len, buf);



}



#define H2C_CAM_LEN 60
@@ -910,7 +1054,7 @@ int rtw89_fw_h2c_fw_log(struct rtw89_dev *rtwdev, bool enable) 
	}



	skb_put(skb, H2C_LOG_CFG_LEN);

	SET_LOG_CFG_LEVEL(skb->data, RTW89_FW_LOG_LEVEL_SER);

	SET_LOG_CFG_LEVEL(skb->data, RTW89_FW_LOG_LEVEL_LOUD);

	SET_LOG_CFG_PATH(skb->data, BIT(RTW89_FW_LOG_LEVEL_C2H));

	SET_LOG_CFG_COMP(skb->data, comp);

	SET_LOG_CFG_COMP_EXT(skb->data, 0);

drivers/net/wireless/realtek/rtw89/fw.h

+28 −3
Original line number Diff line number Diff line
@@ -3125,9 +3125,6 @@ static inline struct rtw89_fw_c2h_attr *RTW89_SKB_C2H_CB(struct sk_buff *skb) 
	return (struct rtw89_fw_c2h_attr *)skb->cb;

}



#define RTW89_GET_C2H_LOG_SRT_PRT(c2h) (char *)((__le32 *)(c2h) + 2)

#define RTW89_GET_C2H_LOG_LEN(len) ((len) - RTW89_C2H_HEADER_LEN)



struct rtw89_c2h_done_ack {

	__le32 w0;

	__le32 w1;
@@ -3149,6 +3146,26 @@ struct rtw89_c2h_done_ack { 
#define RTW89_GET_MAC_C2H_REV_ACK_H2C_SEQ(c2h) \

	le32_get_bits(*((const __le32 *)(c2h) + 2), GENMASK(23, 16))



struct rtw89_fw_c2h_log_fmt {

	__le16 signature;

	u8 feature;

	u8 syntax;

	__le32 fmt_id;

	u8 file_num;

	__le16 line_num;

	u8 argc;

	union {

		DECLARE_FLEX_ARRAY(u8, raw);

		DECLARE_FLEX_ARRAY(__le32, argv);

	} __packed u;

} __packed;



#define RTW89_C2H_FW_FORMATTED_LOG_MIN_LEN 11

#define RTW89_C2H_FW_LOG_FEATURE_PARA_INT BIT(2)

#define RTW89_C2H_FW_LOG_MAX_PARA_NUM 16

#define RTW89_C2H_FW_LOG_SIGNATURE 0xA5A5

#define RTW89_C2H_FW_LOG_STR_BUF_SIZE 512



struct rtw89_c2h_mac_bcnfltr_rpt {

	__le32 w0;

	__le32 w1;
@@ -3327,6 +3344,12 @@ struct rtw89_mfw_hdr { 
	struct rtw89_mfw_info info[];

} __packed;



struct rtw89_fw_logsuit_hdr {

	__le32 rsvd;

	__le32 count;

	__le32 ids[];

} __packed;



struct fwcmd_hdr {

	__le32 hdr0;

	__le32 hdr1;
@@ -3517,6 +3540,8 @@ int rtw89_fw_download(struct rtw89_dev *rtwdev, enum rtw89_fw_type type); 
void rtw89_load_firmware_work(struct work_struct *work);

void rtw89_unload_firmware(struct rtw89_dev *rtwdev);

int rtw89_wait_firmware_completion(struct rtw89_dev *rtwdev);

int rtw89_fw_log_prepare(struct rtw89_dev *rtwdev);

void rtw89_fw_log_dump(struct rtw89_dev *rtwdev, u8 *buf, u32 len);

void rtw89_h2c_pkt_set_hdr(struct rtw89_dev *rtwdev, struct sk_buff *skb,

			   u8 type, u8 cat, u8 class, u8 func,

			   bool rack, bool dack, u32 len);