wifi: rtw89: support more formats of firmware file
Ping-Ke Shih
maintainercover wifi: rtw89: support more formats of firmware file
Initially, firmware file contains stuff related to WiFi CPU, and normally it contains two firmwares with normal and WoWLAN types.
To reduce firmware size, we split debug formatted text into an individual part (*1), and driver can decide to use it optionally. When we want to debug firmware, turn on firmware log via debugfs, and then firmware sends C2H events with log text ID that driver looks up the corresponding format text and print out. Add this by patches 1/8 and 8/2.
+===========================================+ <------------------------+
| WiFi CPU multi-firmware header | |
+-------------------------------------------+ |
| WiFi CPU firmware (normal type *2) --|----------------------+ |
+-------------------------------------------+ | |
| WiFi CPU firmware (WoWLAN type) | | |
+-------------------------------------------+ | |
| log formatted text (*1) | | |
+===========================================+ | |
| |
The detail of a Wifi CPU firmware (*2 in above figure) like below. | |
The format is also used new hardware component named BB MCU, so we | |
need more fields to record the information, and then firmware header | |
format v1 is introduced by patches 3/8 and 4/8. | |
| |
+---------------------------------------+ <---------------------+ |
| Header | |
+---------------------------------------+ |
| Section header 1 | |
| Section header 2 | |
| Section header 3 | |
| ... | |
+---------------------------------------+ |
| Dynamic header (variable length) | |
+---------------------------------------+ |
| Data used & pointed by section | |
| ... | |
+---------------------------------------+ |
|
In order to move static const tables from driver into firmware file, we |
introduce `firmware elements` followed by WiFi CPU multi-firmware. |
Since the header of WiFi CPU multi-firmware explicitly points out start |
address and length, old driver will still access expected range. |
We introduce the infrastructure by patch 6/8. |
|
+===========================================+ |
| WiFi CPU multi-firmware -----------|---------------------------+
| +-------------+
| | padding |
+===========================================+
| elm ID 1 | elm size | other header data |
+----------+----------+ |
| |
+-------------------------------------------+
| content (variable length) |
| +-------------+
| | padding |
+===========================================+
| elm ID 2 | elm size | other header data |
+----------+----------+ |
| |
+-------------------------------------------+
| content (variable length) |
| +-----------------------+
| |
+===================+Chin-Yen Lee (2):
Wifi: rtw89: recognize log format from firmware file
wifi: rtw89: support firmware log with formatted text
Ping-Ke Shih (6):
wifi: rtw89: introduce v1 format of firmware header
wifi: rtw89: add firmware parser for v1 format
wifi: rtw89: add firmware suit for BB MCU 0/1
wifi: rtw89: introduce infrastructure of firmware elements
wifi: rtw89: add to parse firmware elements of BB and RF tables
wifi: rtw89: return failure if needed firmware elements are not
recognized
drivers/net/wireless/realtek/rtw89/core.c | 8 +- drivers/net/wireless/realtek/rtw89/core.h | 41 +- drivers/net/wireless/realtek/rtw89/debug.c | 14 +- drivers/net/wireless/realtek/rtw89/fw.c | 537 +++++++++++++++++- drivers/net/wireless/realtek/rtw89/fw.h | 121 +++- drivers/net/wireless/realtek/rtw89/mac.c | 3 +- drivers/net/wireless/realtek/rtw89/phy.c | 15 +- drivers/net/wireless/realtek/rtw89/rtw8851b.c | 1 + drivers/net/wireless/realtek/rtw89/rtw8852a.c | 1 + drivers/net/wireless/realtek/rtw89/rtw8852b.c | 1 + drivers/net/wireless/realtek/rtw89/rtw8852c.c | 1 + 11 files changed, 696 insertions(+), 47 deletions(-)
Signature · 1 line
2.25.1
Ping-Ke Shih
maintainerPATCH 1/8 Wifi: rtw89: recognize log format from firmware file
From: Chin-Yen Lee <[email protected]>
Firmware log format is an element of multi-firmware file and used for firmware to provide log with formatted text. Driver needs to recognize it in advance if it exists.
--- drivers/net/wireless/realtek/rtw89/core.h | 4 ++++ drivers/net/wireless/realtek/rtw89/fw.c | 25 +++++++++++++++-------- 2 files changed, 21 insertions(+), 8 deletions(-)
drivers/net/wireless/realtek/rtw89/core.h +4 -0
@@ -3347,6 +3347,7 @@ enum rtw89_fw_type {RTW89_FW_NORMAL =1 ,RTW89_FW_WOWLAN =3 ,RTW89_FW_NORMAL_CE =5 , + RTW89_FW_LOGFMT = 255, }; enum rtw89_fw_feature {
@@ -3406,6 +3407,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;u32 feature_map; };
@@ -4942,6 +4944,8 @@ 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->normal; }
drivers/net/wireless/realtek/rtw89/fw.c +17 -8
@@ -178,19 +178,22 @@ int rtw89_mfw_recognize(struct rtw89_dev *rtwdev, enum rtw89_fw_type type,for (i =0 ; i < mfw_hdr->fw_nr; i++) { mfw_info = &mfw_hdr->info[i]; -if (mfw_info->cv != rtwdev->hal.cv || - mfw_info->type != type || - mfw_info->mp) -continue ; - - fw_suit->data = mfw +le32_to_cpu (mfw_info->shift); - fw_suit->size =le32_to_cpu (mfw_info->size); -return 0 ; +if (mfw_info->type == type) { +if (mfw_info->cv == rtwdev->hal.cv && !mfw_info->mp) + goto found; +if (type ==RTW89_FW_LOGFMT ) + goto found; + } }if (!nowarn)rtw89_err (rtwdev,"no suitable firmware found\n" );return -ENOENT ; + +found: + fw_suit->data = mfw +le32_to_cpu (mfw_info->shift); + fw_suit->size =le32_to_cpu (mfw_info->size); +return 0 ; } static void rtw89_fw_update_ver(struct rtw89_dev *rtwdev,
@@ -199,6 +202,9 @@ static void rtw89_fw_update_ver(struct rtw89_dev *rtwdev, {const struct rtw89_fw_hdr *hdr = (const struct rtw89_fw_hdr *)fw_suit->data; +if (type ==RTW89_FW_LOGFMT ) +return ; + fw_suit->major_ver =le32_get_bits (hdr->w1,FW_HDR_W1_MAJOR_VERSION ); fw_suit->minor_ver =le32_get_bits (hdr->w1,FW_HDR_W1_MINOR_VERSION ); fw_suit->sub_ver =le32_get_bits (hdr->w1,FW_HDR_W1_SUBVERSION );
@@ -386,6 +392,9 @@ int rtw89_fw_recognize(struct rtw89_dev *rtwdev)/* It still works if wowlan firmware isn't existing. */ __rtw89_fw_recognize (rtwdev,RTW89_FW_WOWLAN , false); +/* It still works if log format file isn't existing. */ +__rtw89_fw_recognize (rtwdev,RTW89_FW_LOGFMT , true); +rtw89_fw_recognize_features (rtwdev);rtw89_coex_recognize_ver (rtwdev);
Signature · 1 line
2.25.1
Re: [1/8] wifi: rtw89: recognize log format from firmware file
Quoted 8 lines · Ping-Ke Shih
From: Chin-Yen Lee <[email protected]>
Firmware log format is an element of multi-firmware file and used for firmware to provide log with formatted text. Driver needs to recognize it in advance if it exists.
Signed-off-by Chin-Yen Lee <[email protected]>Signed-off-by Ping-Ke Shih <[email protected]>
8 patches applied to wireless-next.git, thanks.
0520841960de wifi: rtw89: recognize log format from firmware file cad2bd8a136c wifi: rtw89: support firmware log with formatted text 1b073b350d24 wifi: rtw89: introduce v1 format of firmware header 12b1a12548eb wifi: rtw89: add firmware parser for v1 format7d112665982b wifi: rtw89: add firmware suit for BB MCU 0/1a337d4331fd6 wifi: rtw89: introduce infrastructure of firmware elements 894747206893 wifi: rtw89: add to parse firmware elements of BB and RF tables dd59c6a32b71 wifi: rtw89: return failure if needed firmware elements are not recognized
Signature · 3 lines
https://patchwork.kernel.org/project/linux-wireless/patch/[email protected]/ https://wireless.wiki.kernel.org/en/developers/documentation/submittingpatches
Ping-Ke Shih
maintainerPATCH 2/8 wifi: rtw89: support firmware log with formatted text
In reply to Ping-Ke ShihFrom: Chin-Yen Lee <[email protected]>
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.
--- drivers/net/wireless/realtek/rtw89/core.c | 2 +- drivers/net/wireless/realtek/rtw89/core.h | 14 +- drivers/net/wireless/realtek/rtw89/debug.c | 14 +- drivers/net/wireless/realtek/rtw89/fw.c | 146 ++++++++++++++++++++- drivers/net/wireless/realtek/rtw89/fw.h | 31 ++++- drivers/net/wireless/realtek/rtw89/mac.c | 3 +- 6 files changed, 194 insertions(+), 16 deletions(-)
drivers/net/wireless/realtek/rtw89/core.c +1 -1
@@ -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
@@ -3398,6 +3398,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;
@@ -3407,8 +3416,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; };
@@ -4945,7 +4953,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
@@ -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, -const char __user *user_buf, -size_t count,loff_t *loff) +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:
@@ -3571,7 +3573,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
158 lines not on this page · raw message
drivers/net/wireless/realtek/rtw89/fw.h +28 -3
@@ -3232,9 +3232,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;
@@ -3256,6 +3253,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;
@@ -3426,6 +3443,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;
@@ -3616,6 +3639,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);
drivers/net/wireless/realtek/rtw89/mac.c +1 -2
@@ -4437,8 +4437,7 @@ rtw89_mac_c2h_done_ack(struct rtw89_dev *rtwdev, struct sk_buff *skb_c2h, u32 lestatic void rtw89_mac_c2h_log (struct rtw89_dev *rtwdev,struct sk_buff *c2h,u32 len) { -rtw89_info (rtwdev,"%*s" ,RTW89_GET_C2H_LOG_LEN (len), -RTW89_GET_C2H_LOG_SRT_PRT (c2h->data)); +rtw89_fw_log_dump (rtwdev, c2h->data, len); } static void
Signature · 1 line
2.25.1
Ping-Ke Shih
maintainerPATCH 3/8 wifi: rtw89: introduce v1 format of firmware header
In reply to Ping-Ke ShihNew firmware header is used by upcoming WiFi 7 chips to have more information, so use common field w3[31:24] to determine header version, and then use corresponding function to read firmware version and commit ID:
rtw89_8852be 0000:03:00.0: Firmware version 0.29.29.1 (799134c3), cmd version 1, type 5 rtw89_8852be 0000:03:00.0: Firmware version 0.29.29.1 (799134c3), cmd version 1, type 3
--- drivers/net/wireless/realtek/rtw89/core.h | 3 ++ drivers/net/wireless/realtek/rtw89/fw.c | 66 ++++++++++++++++++----- drivers/net/wireless/realtek/rtw89/fw.h | 33 ++++++++++++ 3 files changed, 89 insertions(+), 13 deletions(-)
drivers/net/wireless/realtek/rtw89/core.h +3 -0
@@ -3362,6 +3362,7 @@ enum rtw89_fw_feature { };struct rtw89_fw_suit { +enum rtw89_fw_type type;const u8 *data;u32 size;u8 major_ver;
@@ -3374,6 +3375,8 @@ struct rtw89_fw_suit {u16 build_hour;u16 build_min;u8 cmd_ver; +u8 hdr_ver; +u32 commitid; };#define RTW89_FW_VER_CODE (major, minor, sub, idx) \
drivers/net/wireless/realtek/rtw89/fw.c +53 -13
92 lines not on this page · raw message
drivers/net/wireless/realtek/rtw89/fw.h +33 -0
@@ -571,7 +571,9 @@ struct rtw89_fw_hdr {#define FW_HDR_W1_MINOR_VERSION GENMASK(15, 8)#define FW_HDR_W1_SUBVERSION GENMASK(23, 16)#define FW_HDR_W1_SUBINDEX GENMASK(31, 24) +#define FW_HDR_W2_COMMITID GENMASK(31, 0)#define FW_HDR_W3_LEN GENMASK(23, 16) +#define FW_HDR_W3_HDR_VER GENMASK(31, 24)#define FW_HDR_W4_MONTH GENMASK(7, 0)#define FW_HDR_W4_DATE GENMASK(15, 8)#define FW_HDR_W4_HOUR GENMASK(23, 16)
@@ -581,6 +583,37 @@ struct rtw89_fw_hdr {#define FW_HDR_W7_DYN_HDR BIT(16)#define FW_HDR_W7_CMD_VERSERION GENMASK(31, 24) +struct rtw89_fw_hdr_v1 { +__le32 w0; +__le32 w1; +__le32 w2; +__le32 w3; +__le32 w4; +__le32 w5; +__le32 w6; +__le32 w7; +__le32 w8; +__le32 w9; +__le32 w10; +__le32 w11; +} __packed; + +#define FW_HDR_V1_W1_MAJOR_VERSION GENMASK(7, 0) +#define FW_HDR_V1_W1_MINOR_VERSION GENMASK(15, 8) +#define FW_HDR_V1_W1_SUBVERSION GENMASK(23, 16) +#define FW_HDR_V1_W1_SUBINDEX GENMASK(31, 24) +#define FW_HDR_V1_W2_COMMITID GENMASK(31, 0) +#define FW_HDR_V1_W3_CMD_VERSERION GENMASK(23, 16) +#define FW_HDR_V1_W3_HDR_VER GENMASK(31, 24) +#define FW_HDR_V1_W4_MONTH GENMASK(7, 0) +#define FW_HDR_V1_W4_DATE GENMASK(15, 8) +#define FW_HDR_V1_W4_HOUR GENMASK(23, 16) +#define FW_HDR_V1_W4_MIN GENMASK(31, 24) +#define FW_HDR_V1_W5_YEAR GENMASK(15, 0) +#define FW_HDR_V1_W5_HDR_SIZE GENMASK(31, 16) +#define FW_HDR_V1_W6_SEC_NUM GENMASK(15, 8) +#define FW_HDR_V1_W7_DYN_HDR BIT(16) +static inline void SET_FW_HDR_PART_SIZE (void *fwhdr,u32 val) {le32p_replace_bits ((__le32 *)fwhdr +7 , val,GENMASK (15 ,0 ));
Signature · 1 line
2.25.1
Ping-Ke Shih
maintainerPATCH 4/8 wifi: rtw89: add firmware parser for v1 format
In reply to Ping-Ke ShihA firmware with v1 format contains many sections to download. Add parser to read section type, target address, length, checksum and so on, and then download the section to WiFi CPU with proper location.
The additional dynamic header length named dynamic_hdr_len is used to skip content of dynamic header containing compiler flags of firmware, which can help to determine variant firmware build, but currently rtw89 only use single one variant. So, just skip the content.
The layout of a WiFi CPU firmware with v1 format looks like:
+---------------------------------------+ | Header (12 words) | +---------------------------------------+ | Section header 1 (4 words) | | Section header 2 (4 words) | | Section header 3 (4 words) | | ... | +---------------------------------------+ | Dynamic header (variable length) | +---------------------------------------+ | Data used & pointed by section | | ... | +---------------------------------------+
--- drivers/net/wireless/realtek/rtw89/fw.c | 106 +++++++++++++++++++++--- drivers/net/wireless/realtek/rtw89/fw.h | 17 ++++ 2 files changed, 111 insertions(+), 12 deletions(-)
drivers/net/wireless/realtek/rtw89/fw.c +94 -12
@@ -86,8 +86,8 @@ int rtw89_fw_check_rdy(struct rtw89_dev *rtwdev)return 0 ; } -static int rtw89_fw_hdr_parser (struct rtw89_dev *rtwdev,const u8 *fw,u32 len, -struct rtw89_fw_bin_info *info) +static int rtw89_fw_hdr_parser_v0 (struct rtw89_dev *rtwdev,const u8 *fw,u32 len, +struct rtw89_fw_bin_info *info) {const struct rtw89_fw_hdr *fw_hdr = (const struct rtw89_fw_hdr *)fw;struct rtw89_fw_hdr_section_info *section_info;
@@ -154,6 +154,94 @@ static int rtw89_fw_hdr_parser(struct rtw89_dev *rtwdev, const u8 *fw, u32 len,return 0 ; } +static int rtw89_fw_hdr_parser_v1 (struct rtw89_dev *rtwdev,const u8 *fw,u32 len, +struct rtw89_fw_bin_info *info) +{ +const struct rtw89_fw_hdr_v1 *fw_hdr = (const struct rtw89_fw_hdr_v1 *)fw; +struct rtw89_fw_hdr_section_info *section_info; +const struct rtw89_fw_dynhdr_hdr *fwdynhdr; +const struct rtw89_fw_hdr_section_v1 *section; +const u8 *fw_end = fw + len; +const u8 *bin; +u32 base_hdr_len; +u32 mssc_len =0 ; +u32 i; + + info->section_num =le32_get_bits (fw_hdr->w6,FW_HDR_V1_W6_SEC_NUM ); + base_hdr_len =struct_size (fw_hdr, sections, info->section_num); + info->dynamic_hdr_en =le32_get_bits (fw_hdr->w7,FW_HDR_V1_W7_DYN_HDR ); + +if (info->dynamic_hdr_en) { + info->hdr_len =le32_get_bits (fw_hdr->w5,FW_HDR_V1_W5_HDR_SIZE ); + info->dynamic_hdr_len = info->hdr_len - base_hdr_len; + fwdynhdr = (const struct rtw89_fw_dynhdr_hdr *)(fw + base_hdr_len); +if (le32_to_cpu (fwdynhdr->hdr_len) != info->dynamic_hdr_len) { +rtw89_err (rtwdev,"[ERR]invalid fw dynamic header len\n" ); +return -EINVAL ; + } + }else { + info->hdr_len = base_hdr_len; + info->dynamic_hdr_len =0 ; + } + + bin = fw + info->hdr_len; + +/* jump to section header */ + section_info = info->section_info; +for (i =0 ; i < info->section_num; i++) { + section = &fw_hdr->sections[i]; + section_info->type = +le32_get_bits (section->w1,FWSECTION_HDR_V1_W1_SECTIONTYPE ); +if (section_info->type ==FWDL_SECURITY_SECTION_TYPE ) { + section_info->mssc = +le32_get_bits (section->w2,FWSECTION_HDR_V1_W2_MSSC ); + mssc_len += section_info->mssc *FWDL_SECURITY_SIGLEN ; + }else { + section_info->mssc =0 ; + } + + section_info->len = +le32_get_bits (section->w1,FWSECTION_HDR_V1_W1_SEC_SIZE ); +if (le32_get_bits (section->w1,FWSECTION_HDR_V1_W1_CHECKSUM )) + section_info->len +=FWDL_SECTION_CHKSUM_LEN ; + section_info->redl =le32_get_bits (section->w1,FWSECTION_HDR_V1_W1_REDL ); + section_info->dladdr = +le32_get_bits (section->w0,FWSECTION_HDR_V1_W0_DL_ADDR ); + section_info->addr = bin; + bin += section_info->len; + section_info++; + } + +if (fw_end != bin + mssc_len) { +rtw89_err (rtwdev,"[ERR]fw bin size\n" ); +return -EINVAL ; + } + +return 0 ; +} + +static int rtw89_fw_hdr_parser (struct rtw89_dev *rtwdev, +const struct rtw89_fw_suit *fw_suit, +struct rtw89_fw_bin_info *info) +{ +const u8 *fw = fw_suit->data; +u32 len = fw_suit->size; + +if (!fw || !len) { +rtw89_err (rtwdev,"fw type %d isn't recognized\n" , fw_suit->type); +return -ENOENT ; + } + +switch (fw_suit->hdr_ver) { +case 0 : +return rtw89_fw_hdr_parser_v0 (rtwdev, fw, len, info); +case 1 : +return rtw89_fw_hdr_parser_v1 (rtwdev, fw, len, info); +default : +return -ENOENT ; + } +} +static int rtw89_mfw_recognize (struct rtw89_dev *rtwdev,enum rtw89_fw_type type,struct rtw89_fw_suit *fw_suit,bool nowarn)
@@ -642,8 +730,6 @@ int rtw89_fw_download(struct rtw89_dev *rtwdev, enum rtw89_fw_type type)struct rtw89_fw_info *fw_info = &rtwdev->fw;struct rtw89_fw_suit *fw_suit =rtw89_fw_suit_get (rtwdev, type);struct rtw89_fw_bin_info info; -const u8 *fw = fw_suit->data; -u32 len = fw_suit->size;u8 val;int ret;
@@ -652,12 +738,7 @@ int rtw89_fw_download(struct rtw89_dev *rtwdev, enum rtw89_fw_type type)if (ret)return ret; -if (!fw || !len) { -rtw89_err (rtwdev,"fw type %d isn't recognized\n" , type); -return -ENOENT ; - } - - ret =rtw89_fw_hdr_parser (rtwdev, fw, len, &info); + ret =rtw89_fw_hdr_parser (rtwdev, fw_suit, &info);if (ret) {rtw89_err (rtwdev,"parse fw header fail\n" ); goto fwdl_err;
@@ -671,13 +752,14 @@ int rtw89_fw_download(struct rtw89_dev *rtwdev, enum rtw89_fw_type type) goto fwdl_err; } - ret =rtw89_fw_download_hdr (rtwdev, fw, info.hdr_len - info.dynamic_hdr_len); + ret =rtw89_fw_download_hdr (rtwdev, fw_suit->data, info.hdr_len - + info.dynamic_hdr_len);if (ret) { ret = -EBUSY ; goto fwdl_err; } - ret =rtw89_fw_download_main (rtwdev, fw, &info); + ret =rtw89_fw_download_main (rtwdev, fw_suit->data, &info);if (ret) { ret = -EBUSY ; goto fwdl_err;
drivers/net/wireless/realtek/rtw89/fw.h +17 -0
@@ -583,6 +583,22 @@ struct rtw89_fw_hdr {#define FW_HDR_W7_DYN_HDR BIT(16)#define FW_HDR_W7_CMD_VERSERION GENMASK(31, 24) +struct rtw89_fw_hdr_section_v1 { +__le32 w0; +__le32 w1; +__le32 w2; +__le32 w3; +} __packed; + +#define FWSECTION_HDR_V1_W0_DL_ADDR GENMASK(31, 0) +#define FWSECTION_HDR_V1_W1_METADATA GENMASK(31, 24) +#define FWSECTION_HDR_V1_W1_SECTIONTYPE GENMASK(27, 24) +#define FWSECTION_HDR_V1_W1_SEC_SIZE GENMASK(23, 0) +#define FWSECTION_HDR_V1_W1_CHECKSUM BIT(28) +#define FWSECTION_HDR_V1_W1_REDL BIT(29) +#define FWSECTION_HDR_V1_W2_MSSC GENMASK(7, 0) +#define FWSECTION_HDR_V1_W2_BBMCU_IDX GENMASK(27, 24) +struct rtw89_fw_hdr_v1 {__le32 w0;__le32 w1;
@@ -596,6 +612,7 @@ struct rtw89_fw_hdr_v1 {__le32 w9;__le32 w10;__le32 w11; +struct rtw89_fw_hdr_section_v1 sections[]; } __packed;#define FW_HDR_V1_W1_MAJOR_VERSION GENMASK(7, 0)
Signature · 1 line
2.25.1
Ping-Ke Shih
maintainerPATCH 5/8 wifi: rtw89: add firmware suit for BB MCU 0/1
In reply to Ping-Ke ShihFor existing chips, firmware is only for WiFi CPU, but WiFi 7 chips add new hardware component BB MCU that needs firmware as well. The firmwares of BB MCU 0/1 are also downloaded via the same path like WiFi CPU firmware, and use the same firmware header format, so add firmware suits to access them commonly.
--- drivers/net/wireless/realtek/rtw89/core.h | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-)
drivers/net/wireless/realtek/rtw89/core.h +15 -2
@@ -3347,6 +3347,8 @@ enum rtw89_fw_type {RTW89_FW_NORMAL =1 ,RTW89_FW_WOWLAN =3 ,RTW89_FW_NORMAL_CE =5 , +RTW89_FW_BBMCU0 =64 , +RTW89_FW_BBMCU1 =65 , RTW89_FW_LOGFMT = 255, };
@@ -3419,6 +3421,8 @@ struct rtw89_fw_info {u8 c2h_counter;struct rtw89_fw_suit normal;struct rtw89_fw_suit wowlan; +struct rtw89_fw_suit bbmcu0; +struct rtw89_fw_suit bbmcu1;struct rtw89_fw_log log;u32 feature_map; };
@@ -4953,10 +4957,19 @@ static inline struct rtw89_fw_suit *rtw89_fw_suit_get(struct rtw89_dev *rtwdev, {struct rtw89_fw_info *fw_info = &rtwdev->fw; -if (type ==RTW89_FW_WOWLAN ) +switch (type) { +case RTW89_FW_WOWLAN :return &fw_info->wowlan; -else if (type ==RTW89_FW_LOGFMT ) +case RTW89_FW_LOGFMT :return &fw_info->log.suit; +case RTW89_FW_BBMCU0 : +return &fw_info->bbmcu0; +case RTW89_FW_BBMCU1 : +return &fw_info->bbmcu1; +default : +break ; + } +return &fw_info->normal; }
Signature · 1 line
2.25.1
Ping-Ke Shih
maintainerPATCH 6/8 wifi: rtw89: introduce infrastructure of firmware elements
In reply to Ping-Ke ShihIn order to pack more data into firmware file, we introduce firmware elements and append BB_MCU firmware first. The first part of new firmware file is still unchanged firmware of WiFi CPU, so the new firmware format can be backward compatible to old format. The new elements part consists of ID and size basically, which can append more elements simply. To avoid unaligned access in certain platform and be easy to read, headers of all elements start at 16-byte aligned address.
+===========================================+ | original firmware | | +-------------+ | | padding | +===========================================+ | elm ID 1 | elm size | other header data | +----------+----------+ | | | +-------------------------------------------+ | content (variable length) | | +-------------+ | | padding | +===========================================+ | elm ID 2 | elm size | other header data | +----------+----------+ | | | +-------------------------------------------+ | content (variable length) | | +-----------------------+ | | (no padding for the last one) +===================+
More detail of element header is shown below. The additional fields 'version' and 'element_priv[]' are meta data of elements, so that we can know element version easily, and element_priv[] provide specific fields for certain element, such as RF path index for RF parameter tables.
+===========================================+ | elm ID | elm size | version | rsvd0 | +----------+----------+----------+----------+ | rsvd1/2 | element_priv[] | +-------------------------------------------+
--- drivers/net/wireless/realtek/rtw89/core.c | 6 ++ drivers/net/wireless/realtek/rtw89/fw.c | 98 +++++++++++++++++++++++ drivers/net/wireless/realtek/rtw89/fw.h | 31 +++++++ 3 files changed, 135 insertions(+)
drivers/net/wireless/realtek/rtw89/core.c +6 -0
@@ -3779,6 +3779,12 @@ int rtw89_chip_info_setup(struct rtw89_dev *rtwdev)return ret; } + ret =rtw89_fw_recognize_elements (rtwdev); +if (ret) { +rtw89_err (rtwdev,"failed to recognize firmware elements\n" ); +return ret; + } + ret =rtw89_chip_efuse_info_setup (rtwdev);if (ret)return ret;
drivers/net/wireless/realtek/rtw89/fw.c +98 -0
116 lines not on this page · raw message
drivers/net/wireless/realtek/rtw89/fw.h +31 -0
@@ -3499,6 +3499,36 @@ struct rtw89_fw_logsuit_hdr {__le32 ids[]; } __packed; +#define RTW89_FW_ELEMENT_ALIGN 16 + +enum rtw89_fw_element_id { +RTW89_FW_ELEMENT_ID_BBMCU0 =0 , +RTW89_FW_ELEMENT_ID_BBMCU1 =1 , +}; + +struct rtw89_fw_element_hdr { +__le32 id;/* enum rtw89_fw_element_id */ +__le32 size;/* exclude header size */ +u8 ver[4 ]; +__le32 rsvd0; +__le32 rsvd1; +__le32 rsvd2; +union { +struct { +u8 priv[8 ]; +u8 contents[]; + } __packed common; +struct { +u8 idx; +u8 rsvd[7 ]; +struct { +__le32 addr; +__le32 data; + } __packed regs[]; + } __packed reg2; + } __packed u; +} __packed; +struct fwcmd_hdr {__le32 hdr0;__le32 hdr1;
@@ -3680,6 +3710,7 @@ struct rtw89_fw_h2c_rf_get_mccch {int rtw89_fw_check_rdy (struct rtw89_dev *rtwdev);int rtw89_fw_recognize (struct rtw89_dev *rtwdev); +int rtw89_fw_recognize_elements (struct rtw89_dev *rtwdev);const struct firmware * rtw89_early_fw_feature_recognize(struct device *device, const struct rtw89_chip_info *chip,
Signature · 1 line
2.25.1
Ping-Ke Shih
maintainerPATCH 7/8 wifi: rtw89: add to parse firmware elements of BB and RF tables
In reply to Ping-Ke ShihThe tables of BB and RF parameters are pairs of {addr, value}. Load them and convert from little-endian to CPU order, and show the version to clear which version we are using.
rtw89_8922ae 0000:03:00.0: Firmware element BB version: 00 04 00 00 rtw89_8922ae 0000:03:00.0: Firmware element radio A version: 00 13 00 00 rtw89_8922ae 0000:03:00.0: Firmware element NCTL version: 00 05 00 00
We use tables defined in firmware elements with higher priority than original static const tables defined in driver, because WiFi 7 chips will not define the tables in driver, and existing chips can possibly migrate to the new design one by one.
--- drivers/net/wireless/realtek/rtw89/core.h | 8 ++ drivers/net/wireless/realtek/rtw89/fw.c | 95 +++++++++++++++++++++++ drivers/net/wireless/realtek/rtw89/fw.h | 7 ++ drivers/net/wireless/realtek/rtw89/phy.c | 15 +++- 4 files changed, 121 insertions(+), 4 deletions(-)
drivers/net/wireless/realtek/rtw89/core.h +8 -0
@@ -3412,6 +3412,13 @@ struct rtw89_fw_log {const char *(*fmts)[]; }; +struct rtw89_fw_elm_info { +struct rtw89_phy_table *bb_tbl; +struct rtw89_phy_table *bb_gain; +struct rtw89_phy_table *rf_radio[RF_PATH_MAX ]; +struct rtw89_phy_table *rf_nctl; +}; +struct rtw89_fw_info {struct rtw89_fw_req_info req;int fw_format;
@@ -3425,6 +3432,7 @@ struct rtw89_fw_info {struct rtw89_fw_suit bbmcu1;struct rtw89_fw_log log;u32 feature_map; +struct rtw89_fw_elm_info elm_info; };#define RTW89_CHK_FW_FEATURE (_feat, _fw) \
drivers/net/wireless/realtek/rtw89/fw.c +95 -0
119 lines not on this page · raw message
drivers/net/wireless/realtek/rtw89/fw.h +7 -0
@@ -3504,6 +3504,13 @@ struct rtw89_fw_logsuit_hdr {enum rtw89_fw_element_id {RTW89_FW_ELEMENT_ID_BBMCU0 =0 ,RTW89_FW_ELEMENT_ID_BBMCU1 =1 , +RTW89_FW_ELEMENT_ID_BB_REG =2 , +RTW89_FW_ELEMENT_ID_BB_GAIN =3 , +RTW89_FW_ELEMENT_ID_RADIO_A =4 , +RTW89_FW_ELEMENT_ID_RADIO_B =5 , +RTW89_FW_ELEMENT_ID_RADIO_C =6 , +RTW89_FW_ELEMENT_ID_RADIO_D =7 , +RTW89_FW_ELEMENT_ID_RF_NCTL =8 , };struct rtw89_fw_element_hdr {
drivers/net/wireless/realtek/rtw89/phy.c +11 -4
@@ -1342,12 +1342,16 @@ static void rtw89_phy_init_reg(struct rtw89_dev *rtwdev,void rtw89_phy_init_bb_reg (struct rtw89_dev *rtwdev) { +struct rtw89_fw_elm_info *elm_info = &rtwdev->fw.elm_info;const struct rtw89_chip_info *chip = rtwdev->chip; -const struct rtw89_phy_table *bb_table = chip->bb_table; -const struct rtw89_phy_table *bb_gain_table = chip->bb_gain_table; +const struct rtw89_phy_table *bb_table; +const struct rtw89_phy_table *bb_gain_table; + bb_table = elm_info->bb_tbl ? elm_info->bb_tbl : chip->bb_table;rtw89_phy_init_reg (rtwdev, bb_table, rtw89_phy_config_bb_reg,NULL );rtw89_chip_init_txpwr_unit (rtwdev,RTW89_PHY_0 ); + + bb_gain_table = elm_info->bb_gain ? elm_info->bb_gain : chip->bb_gain_table;if (bb_gain_table)rtw89_phy_init_reg (rtwdev, bb_gain_table, rtw89_phy_config_bb_gain,NULL );
@@ -1365,6 +1369,7 @@ void rtw89_phy_init_rf_reg(struct rtw89_dev *rtwdev, bool noio) {void (*config)(struct rtw89_dev *rtwdev,const struct rtw89_reg2_def *reg,enum rtw89_rf_path rf_path,void *data); +struct rtw89_fw_elm_info *elm_info = &rtwdev->fw.elm_info;const struct rtw89_chip_info *chip = rtwdev->chip;const struct rtw89_phy_table *rf_table;struct rtw89_fw_h2c_rf_reg_info *rf_reg_info;
@@ -1375,7 +1380,8 @@ void rtw89_phy_init_rf_reg(struct rtw89_dev *rtwdev, bool noio)return ;for (path =RF_PATH_A ; path < chip->rf_path_num; path++) { - rf_table = chip->rf_table[path]; + rf_table = elm_info->rf_radio[path] ? + elm_info->rf_radio[path] : chip->rf_table[path]; rf_reg_info->rf_path = rf_table->rf_path;if (noio) config = rtw89_phy_config_rf_reg_noio;
@@ -1392,6 +1398,7 @@ void rtw89_phy_init_rf_reg(struct rtw89_dev *rtwdev, bool noio)static void rtw89_phy_init_rf_nctl (struct rtw89_dev *rtwdev) { +struct rtw89_fw_elm_info *elm_info = &rtwdev->fw.elm_info;const struct rtw89_chip_info *chip = rtwdev->chip;const struct rtw89_phy_table *nctl_table;u32 val;
@@ -1414,7 +1421,7 @@ static void rtw89_phy_init_rf_nctl(struct rtw89_dev *rtwdev)if (ret)rtw89_err (rtwdev,"failed to poll nctl block\n" ); - nctl_table = chip->nctl_table; + nctl_table = elm_info->rf_nctl ? elm_info->rf_nctl : chip->nctl_table;rtw89_phy_init_reg (rtwdev, nctl_table, rtw89_phy_config_bb_reg,NULL );if (chip->nctl_post_table)
Signature · 1 line
2.25.1
Ping-Ke Shih
maintainerPATCH 8/8 wifi: rtw89: return failure if needed firmware elements are not recognized
In reply to Ping-Ke ShihWiFi 7 chips doesn't have static const tables defined in driver. If tables aren't loaded properly from firmware file, driver can get NULL pointer access exception. One way is to add the checking statements when trying to access these tables, but I choose to check them right after loading firmware elements from firmware file, so I don't need to add error handlers everywhere.
Currently, the needed firmware elements of WiFi 6 chips are all zero, and coming WiFi 7 chip will need at least BB MCU, parameters of BB and RF. We will add them after 8922AE is verified.
--- drivers/net/wireless/realtek/rtw89/core.h | 1 + drivers/net/wireless/realtek/rtw89/fw.c | 11 +++++++++++ drivers/net/wireless/realtek/rtw89/fw.h | 2 ++ drivers/net/wireless/realtek/rtw89/rtw8851b.c | 1 + drivers/net/wireless/realtek/rtw89/rtw8852a.c | 1 + drivers/net/wireless/realtek/rtw89/rtw8852b.c | 1 + drivers/net/wireless/realtek/rtw89/rtw8852c.c | 1 + 7 files changed, 18 insertions(+)
drivers/net/wireless/realtek/rtw89/core.h +1 -0
@@ -3181,6 +3181,7 @@ struct rtw89_chip_info {const char *fw_basename;u8 fw_format_max;bool try_ce_fw; +u32 needed_fw_elms;u32 fifo_size;bool small_fifo_size;u32 dle_scc_rsvd_size;
drivers/net/wireless/realtek/rtw89/fw.c +11 -0
@@ -656,6 +656,8 @@ int rtw89_fw_recognize_elements(struct rtw89_dev *rtwdev) {struct rtw89_fw_info *fw_info = &rtwdev->fw;const struct firmware *firmware = fw_info->req.firmware; +const struct rtw89_chip_info *chip = rtwdev->chip; +u32 unrecognized_elements = chip->needed_fw_elms;const struct rtw89_fw_element_handler *handler;const struct rtw89_fw_element_hdr *hdr;u32 elm_size;
@@ -663,6 +665,8 @@ int rtw89_fw_recognize_elements(struct rtw89_dev *rtwdev)u32 offset;int ret; +BUILD_BUG_ON (sizeof (chip->needed_fw_elms) *8 <RTW89_FW_ELEMENT_ID_NUM ); + offset =rtw89_mfw_get_size (rtwdev); offset =ALIGN (offset,RTW89_FW_ELEMENT_ALIGN );if (offset ==0 )
@@ -693,11 +697,18 @@ int rtw89_fw_recognize_elements(struct rtw89_dev *rtwdev)rtw89_info (rtwdev,"Firmware element %s version: %4ph\n" , handler->name, hdr->ver); + unrecognized_elements &= ~BIT (elem_id); next: offset +=sizeof (*hdr) + elm_size; offset =ALIGN (offset,RTW89_FW_ELEMENT_ALIGN ); } +if (unrecognized_elements) { +rtw89_err (rtwdev,"Firmware elements 0x%08x are unrecognized\n" , + unrecognized_elements); +return -ENOENT ; + } +return 0 ; }
drivers/net/wireless/realtek/rtw89/fw.h +2 -0
@@ -3511,6 +3511,8 @@ enum rtw89_fw_element_id {RTW89_FW_ELEMENT_ID_RADIO_C =6 ,RTW89_FW_ELEMENT_ID_RADIO_D =7 ,RTW89_FW_ELEMENT_ID_RF_NCTL =8 , + + RTW89_FW_ELEMENT_ID_NUM, }; struct rtw89_fw_element_hdr {
drivers/net/wireless/realtek/rtw89/rtw8851b.c +1 -0
@@ -2338,6 +2338,7 @@ const struct rtw89_chip_info rtw8851b_chip_info = { .fw_basename = RTW8851B_FW_BASENAME, .fw_format_max = RTW8851B_FW_FORMAT_MAX, .try_ce_fw = true, + .needed_fw_elms = 0, .fifo_size = 196608, .small_fifo_size = true, .dle_scc_rsvd_size = 98304,
drivers/net/wireless/realtek/rtw89/rtw8852a.c +1 -0
@@ -2075,6 +2075,7 @@ const struct rtw89_chip_info rtw8852a_chip_info = { .fw_basename = RTW8852A_FW_BASENAME, .fw_format_max = RTW8852A_FW_FORMAT_MAX, .try_ce_fw = false, + .needed_fw_elms = 0, .fifo_size = 458752, .small_fifo_size = false, .dle_scc_rsvd_size = 0,
drivers/net/wireless/realtek/rtw89/rtw8852b.c +1 -0
@@ -2507,6 +2507,7 @@ const struct rtw89_chip_info rtw8852b_chip_info = { .fw_basename = RTW8852B_FW_BASENAME, .fw_format_max = RTW8852B_FW_FORMAT_MAX, .try_ce_fw = true, + .needed_fw_elms = 0, .fifo_size = 196608, .small_fifo_size = true, .dle_scc_rsvd_size = 98304,
drivers/net/wireless/realtek/rtw89/rtw8852c.c +1 -0
@@ -2806,6 +2806,7 @@ const struct rtw89_chip_info rtw8852c_chip_info = { .fw_basename = RTW8852C_FW_BASENAME, .fw_format_max = RTW8852C_FW_FORMAT_MAX, .try_ce_fw = false, + .needed_fw_elms = 0, .fifo_size = 458752, .small_fifo_size = false, .dle_scc_rsvd_size = 0,
Signature · 1 line
2.25.1