Add ability to flash modules' firmware
Subsystems (2)
v2 cover Add ability to flash modules' firmware
CMIS compliant modules such as QSFP-DD might be running a firmware that can be updated in a vendor-neutral way by exchanging messages between the host and the module as described in section 7.2.2 of revision 4.0 of the CMIS standard.
Add ability to flash transceiver modules' firmware over netlink.
Example output:
# ethtool --flash-module-firmware eth0 file test.img
Transceiver module firmware flashing started for device swp23 Transceiver module firmware flashing in progress for device swp23
Progress: 99%
Transceiver module firmware flashing completed for device swp23
In addition, add some firmware and CDB messaging information to ethtool's output for observability.
Patchset overview:
Patches #1-#2: adds firmware info to ethtool's output. Patch #3: adds ability to flash modules' firmware.
v2:
* Remove patch #3 of updating header, since it was already done.
* s/ETHTOOL_A_MODULE_FW_FLASH_PASS/ETHTOOL_A_MODULE_FW_FLASH_PASSWORD
Danielle Ratson (1):
ethtool: Add ability to flash transceiver modules' firmware
Ido Schimmel (2):
cmis: Print active and inactive firmware versions
cmis: Print CDB messaging support advertisement
cmis.c | 125 +++++++++++++++++++++++ cmis.h | 19 ++++ ethtool.8.in | 29 ++++++ ethtool.c | 7 ++ netlink/desc-ethtool.c | 13 +++ netlink/extapi.h | 2 + netlink/module.c | 183 ++++++++++++++++++++++++++++++++++ netlink/netlink.h | 16 +++ netlink/prettymsg.c | 5 + netlink/prettymsg.h | 2 + shell-completion/bash/ethtool | 27 +++++ 11 files changed, 428 insertions(+)
Signature · 1 line
2.45.0
PATCH v2 1/3 cmis: Print active and inactive firmware versions
From: Ido Schimmel <[email protected]>
Parse and print the active and inactive firmware versions from the CMIS EEPROM dump. Example output:
# ethtool -m swp23 Identifier : 0x18 (QSFP-DD Double Density 8X Pluggable Transceiver (INF-8628)) [...] Active firmware version : 2.6 Inactive firmware version : 2.7
--- cmis.c | 45 +++++++++++++++++++++++++++++++++++++++++++++ cmis.h | 8 ++++++++ 2 files changed, 53 insertions(+)
cmis.c +45 -0
@@ -884,6 +884,50 @@ static void cmis_show_dom(const struct cmis_memory_map *map)sff_show_thresholds (sd); } +/* Print active and inactive firmware versions. Relevant documents: +* [1] CMIS Rev. 5, page 115, section 8.2.9, Table 8-14 +* [2] CMIS Rev. 5, page 127, section 8.4.1, Table 8-37 +*/ +static void cmis_show_fw_version_common (const char *name,__u8 major, +__u8 minor) +{ +if (major ==0 && minor ==0 ) { +return ; + }else if (major ==0xFF && minor ==0xFF ) { +printf ("\t%-41s : Invalid\n" , name); +return ; + } + +printf ("\t%-41s : %d.%d\n" , name, major, minor); +} + +static void cmis_show_fw_active_version (const struct cmis_memory_map *map) +{ +__u8 major = map->lower_memory[CMIS_MODULE_ACTIVE_FW_MAJOR_OFFSET ]; +__u8 minor = map->lower_memory[CMIS_MODULE_ACTIVE_FW_MINOR_OFFSET ]; + +cmis_show_fw_version_common ("Active firmware version" , major, minor); +} + +static void cmis_show_fw_inactive_version (const struct cmis_memory_map *map) +{ +__u8 major; +__u8 minor; + +if (!map->page_01h) +return ; + + major = map->page_01h[CMIS_MODULE_INACTIVE_FW_MAJOR_OFFSET ]; + minor = map->page_01h[CMIS_MODULE_INACTIVE_FW_MINOR_OFFSET ]; +cmis_show_fw_version_common ("Inactive firmware version" , major, minor); +} + +static void cmis_show_fw_version (const struct cmis_memory_map *map) +{ +cmis_show_fw_active_version (map); +cmis_show_fw_inactive_version (map); +} +static void cmis_show_all_common (const struct cmis_memory_map *map) {cmis_show_identifier (map);
@@ -900,6 +944,7 @@ static void cmis_show_all_common(const struct cmis_memory_map *map)cmis_show_mod_fault_cause (map);cmis_show_mod_lvl_controls (map);cmis_show_dom (map); +cmis_show_fw_version (map); } static void cmis_memory_map_init_buf(struct cmis_memory_map *map,
cmis.h +8 -0
@@ -41,6 +41,10 @@#define CMIS_LOW_PWR_ALLOW_REQUEST_HW_MASK 0x40#define CMIS_LOW_PWR_REQUEST_SW_MASK 0x10 +/* Module Active Firmware Version (Page 0) */ +#define CMIS_MODULE_ACTIVE_FW_MAJOR_OFFSET 0x27 +#define CMIS_MODULE_ACTIVE_FW_MINOR_OFFSET 0x28 +/* Module Fault Information (Page 0) */ #define CMIS_MODULE_FAULT_OFFSET 0x29#define CMIS_MODULE_FAULT_NO_FAULT 0x00
@@ -134,6 +138,10 @@* GlobalOffset = 2 * 0x80 + LocalOffset */ +/* Module Inactive Firmware Version (Page 1) */ +#define CMIS_MODULE_INACTIVE_FW_MAJOR_OFFSET 0x80 +#define CMIS_MODULE_INACTIVE_FW_MINOR_OFFSET 0x81 +/* Supported Link Length (Page 1) */ #define CMIS_SMF_LEN_OFFSET 0x84#define CMIS_OM5_LEN_OFFSET 0x85
Signature · 1 line
2.45.0
PATCH v2 2/3 cmis: Print CDB messaging support advertisement
In reply to Danielle RatsonFrom: Ido Schimmel <[email protected]>
Parse and print CDB messaging support advertisement information to aid in debugging CDB related problems. Example output:
# ethtool -m swp23 Identifier : 0x18 (QSFP-DD Double Density 8X Pluggable Transceiver (INF-8628)) [...] CDB instances : 1 CDB background mode : Supported CDB EPL pages : 0 CDB Maximum EPL RW length : 128 CDB Maximum LPL RW length : 128 CDB trigger method : Single write
Fields that are not used by the CDB code in the kernel are not printed, but can be added in the future, when needed.
--- cmis.c | 80 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ cmis.h | 11 ++++++++ 2 files changed, 91 insertions(+)
cmis.c +80 -0
@@ -928,6 +928,85 @@ static void cmis_show_fw_version(const struct cmis_memory_map *map)cmis_show_fw_inactive_version (map); } +static u8 cmis_cdb_instances_get (const struct cmis_memory_map *map) +{ +return (map->page_01h[CMIS_CDB_ADVER_OFFSET ] & +CMIS_CDB_ADVER_INSTANCES_MASK ) >>6 ; +} + +static bool cmis_cdb_is_supported (const struct cmis_memory_map *map) +{ +__u8 cdb_instances =cmis_cdb_instances_get (map); + +/* Up to two CDB instances are supported. */ +return cdb_instances ==1 || cdb_instances ==2 ; +} + +static void cmis_show_cdb_instances (const struct cmis_memory_map *map) +{ +__u8 cdb_instances =cmis_cdb_instances_get (map); + +printf ("\t%-41s : %u\n" ,"CDB instances" , cdb_instances); +} + +static void cmis_show_cdb_mode (const struct cmis_memory_map *map) +{ +__u8 mode = map->page_01h[CMIS_CDB_ADVER_OFFSET ] & +CMIS_CDB_ADVER_MODE_MASK ; + +printf ("\t%-41s : %s\n" ,"CDB background mode" , + mode ?"Supported" :"Not supported" ); +} + +static void cmis_show_cdb_epl_pages (const struct cmis_memory_map *map) +{ +__u8 epl_pages = map->page_01h[CMIS_CDB_ADVER_OFFSET ] & +CMIS_CDB_ADVER_EPL_MASK ; + +printf ("\t%-41s : %u\n" ,"CDB EPL pages" , epl_pages); +} + +static void cmis_show_cdb_rw_len (const struct cmis_memory_map *map) +{ +__u16 rw_len = map->page_01h[CMIS_CDB_ADVER_RW_LEN_OFFSET ]; + +/* Maximum read / write length for CDB EPL pages and the LPL page in +* units of 8 bytes, in addition to the minimum 8 bytes. +*/ + rw_len = (rw_len +1 ) *8 ; +printf ("\t%-41s : %u\n" ,"CDB Maximum EPL RW length" , rw_len); +printf ("\t%-41s : %u\n" ,"CDB Maximum LPL RW length" , + rw_len >CMIS_PAGE_SIZE ?CMIS_PAGE_SIZE : rw_len); +} + +static void cmis_show_cdb_trigger (const struct cmis_memory_map *map) +{ +__u8 trigger = map->page_01h[CMIS_CDB_ADVER_TRIGGER_OFFSET ] & +CMIS_CDB_ADVER_TRIGGER_MASK ; + +/* Whether a CDB command can be triggered in a single write to the LPL +* page, or by multiple writes ending with the writing of the CDB +* Command Code (CMDID). +*/ +printf ("\t%-41s : %s\n" ,"CDB trigger method" , + trigger ?"Single write" :"Multiple writes" ); +} + +/* Print CDB messaging support advertisement. Relevant documents: +* [1] CMIS Rev. 5, page 133, section 8.4.11 +*/ +static void cmis_show_cdb_adver (const struct cmis_memory_map *map) +{ +if (!map->page_01h || !cmis_cdb_is_supported (map)) +return ; + +cmis_show_cdb_instances (map); +cmis_show_cdb_mode (map); +cmis_show_cdb_epl_pages (map); +cmis_show_cdb_rw_len (map); +cmis_show_cdb_trigger (map); +} +static void cmis_show_all_common (const struct cmis_memory_map *map) {cmis_show_identifier (map);
@@ -945,6 +1024,7 @@ static void cmis_show_all_common(const struct cmis_memory_map *map)cmis_show_mod_lvl_controls (map);cmis_show_dom (map);cmis_show_fw_version (map); +cmis_show_cdb_adver (map); } static void cmis_memory_map_init_buf(struct cmis_memory_map *map,
cmis.h +11 -0
@@ -191,6 +191,17 @@#define CMIS_SIG_INTEG_TX_OFFSET 0xA1#define CMIS_SIG_INTEG_RX_OFFSET 0xA2 +/* CDB Messaging Support Advertisement */ +#define CMIS_CDB_ADVER_OFFSET 0xA3 +#define CMIS_CDB_ADVER_INSTANCES_MASK 0xC0 +#define CMIS_CDB_ADVER_MODE_MASK 0x20 +#define CMIS_CDB_ADVER_EPL_MASK 0x0F + +#define CMIS_CDB_ADVER_RW_LEN_OFFSET 0xA4 + +#define CMIS_CDB_ADVER_TRIGGER_OFFSET 0xA5 +#define CMIS_CDB_ADVER_TRIGGER_MASK 0x80 +/*----------------------------------------------------------------------- * Upper Memory Page 0x02: Optional Page that informs about module-defined * thresholds for module-level and lane-specific threshold crossing monitors.
Signature · 1 line
2.45.0
PATCH v2 3/3 ethtool: Add ability to flash transceiver modules' firmware
In reply to Danielle RatsonAdd ability to flash transceiver modules' firmware over netlink.
Example output:
# ethtool --flash-module-firmware eth0 file test.img
Transceiver module firmware flashing started for device swp23 Transceiver module firmware flashing in progress for device swp23
Progress: 99%
Transceiver module firmware flashing completed for device swp23
---
Notes:
v2:
* s/ETHTOOL_A_MODULE_FW_FLASH_PASS/ETHTOOL_A_MODULE_FW_FLASH_PASSWORD
ethtool.8.in | 29 ++++++ ethtool.c | 7 ++ netlink/desc-ethtool.c | 13 +++ netlink/extapi.h | 2 + netlink/module.c | 183 ++++++++++++++++++++++++++++++++++ netlink/netlink.h | 16 +++ netlink/prettymsg.c | 5 + netlink/prettymsg.h | 2 + shell-completion/bash/ethtool | 27 +++++ 9 files changed, 284 insertions(+)
ethtool.8.in +29 -0
@@ -536,6 +536,13 @@ ethtool \- query or control network driver and hardware settings .I devname .RB [ podl\-pse\-admin\-control .BR enable | disable ] +.HP +.B ethtool \-\-flash\-module\-firmware +.I devname +.BI file +.IR FILE +.RB [ pass +.IR PASS ] . .\" Adjust lines (i.e. full justification) and hyphenate. .ad
@@ -1772,6 +1779,28 @@ Set Power Sourcing Equipment (PSE) parameters. This parameter manages PoDL PSE Admin operations in accordance with the IEEE 802.3-2018 30.15.1.2.1 (acPoDLPSEAdminControl) specification. +.RE +.TP +.B \-\-flash\-module\-firmware +Flash the transceiver module's firmware. The firmware update process is +composed from three logical steps. Downloading a firmware image to the +transceiver module, running the image and committing the image so that it is +run upon reset. When flash command is given, the firmware update process is +performed in its entirety in that order. +.RS 4 +.TP +.BI file \ FILE +Specifies the filename of the transceiver module firmware image. The firmware +must first be installed in one of the directories where the kernel firmware +loader or firmware agent will look, such as /lib/firmware. The firmware image +is downloaded to the transceiver module, validated, run and committed. +.RE +.RS 4 +.TP +.BI pass \ PASS +Optional transceiver module password that might be required as part of the +transceiver module firmware update process. + .SH BUGS Not supported (in part or whole) on all network drivers. .SH AUTHOR
ethtool.c +7 -0
@@ -6236,6 +6236,13 @@ static const struct option args[] = { .xhelp = " [ podl-pse-admin-control enable|disable ]\n"" [ c33-pse-admin-control enable|disable ]\n" }, + { + .opts = "--flash-module-firmware", + .nlfunc = nl_flash_module_fw, + .help = "Flash transceiver module firmware", + .xhelp =" file FILE\n" +" [ pass PASS ]\n" + }, { .opts = "-h|--help", .no_dev = true,
netlink/desc-ethtool.c +13 -0
@@ -496,6 +496,17 @@ static const struct pretty_nla_desc __mm_desc[] = { NLATTR_DESC_NESTED(ETHTOOL_A_MM_STATS, mm_stat), }; +static const struct pretty_nla_desc __module_fw_flash_desc[] = { +NLATTR_DESC_INVALID (ETHTOOL_A_MODULE_FW_FLASH_UNSPEC ), +NLATTR_DESC_NESTED (ETHTOOL_A_MODULE_FW_FLASH_HEADER , header), +NLATTR_DESC_STRING (ETHTOOL_A_MODULE_FW_FLASH_FILE_NAME ), +NLATTR_DESC_U32 (ETHTOOL_A_MODULE_FW_FLASH_PASSWORD ), +NLATTR_DESC_U32 (ETHTOOL_A_MODULE_FW_FLASH_STATUS ), +NLATTR_DESC_STRING (ETHTOOL_A_MODULE_FW_FLASH_STATUS_MSG ), +NLATTR_DESC_UINT (ETHTOOL_A_MODULE_FW_FLASH_DONE ), +NLATTR_DESC_UINT (ETHTOOL_A_MODULE_FW_FLASH_TOTAL ), +}; +const struct pretty_nlmsg_desc ethnl_umsg_desc[] = {NLMSG_DESC_INVALID (ETHTOOL_MSG_USER_NONE ),NLMSG_DESC (ETHTOOL_MSG_STRSET_GET , strset),
@@ -541,6 +552,7 @@ const struct pretty_nlmsg_desc ethnl_umsg_desc[] = {NLMSG_DESC (ETHTOOL_MSG_PLCA_GET_STATUS , plca),NLMSG_DESC (ETHTOOL_MSG_MM_GET , mm),NLMSG_DESC (ETHTOOL_MSG_MM_SET , mm), + NLMSG_DESC(ETHTOOL_MSG_MODULE_FW_FLASH_ACT, module_fw_flash), };const unsigned int ethnl_umsg_n_desc =ARRAY_SIZE (ethnl_umsg_desc);
@@ -590,6 +602,7 @@ const struct pretty_nlmsg_desc ethnl_kmsg_desc[] = {NLMSG_DESC (ETHTOOL_MSG_PLCA_NTF , plca),NLMSG_DESC (ETHTOOL_MSG_MM_GET_REPLY , mm),NLMSG_DESC (ETHTOOL_MSG_MM_NTF , mm), + NLMSG_DESC(ETHTOOL_MSG_MODULE_FW_FLASH_NTF, module_fw_flash), };const unsigned int ethnl_kmsg_n_desc =ARRAY_SIZE (ethnl_kmsg_desc);
netlink/extapi.h +2 -0
@@ -55,6 +55,7 @@ int nl_get_mm(struct cmd_context *ctx);int nl_set_mm (struct cmd_context *ctx);int nl_gpse (struct cmd_context *ctx);int nl_spse (struct cmd_context *ctx); +int nl_flash_module_fw (struct cmd_context *ctx);void nl_monitor_usage (void );
@@ -130,6 +131,7 @@ nl_get_eeprom_page(struct cmd_context *ctx __maybe_unused,#define nl_set_mm NULL#define nl_gpse NULL#define nl_spse NULL +#define nl_flash_module_fw NULL#endif /* ETHTOOL_ENABLE_NETLINK */
netlink/module.c +183 -0
192 lines not on this page · raw message
netlink/netlink.h +16 -0
@@ -175,4 +175,20 @@ static inline int netlink_init_rtnl_socket(struct nl_context *nlctx) return nlsock_init(nlctx, &nlctx->rtnl_socket, NETLINK_ROUTE); } +static inline uint64_t attr_get_uint (const struct nlattr *attr) +{ +switch (mnl_attr_get_payload_len (attr)) { +case sizeof (uint8_t ): +return mnl_attr_get_u8 (attr); +case sizeof (uint16_t ): +return mnl_attr_get_u16 (attr); +case sizeof (uint32_t ): +return mnl_attr_get_u32 (attr); +case sizeof (uint64_t ): +return mnl_attr_get_u64 (attr); + } + +return -1ULL ; +} +#endif /* ETHTOOL_NETLINK_INT_H__ */
netlink/prettymsg.c +5 -0
@@ -15,6 +15,8 @@#include <linux/if_link.h> #include <libmnl/libmnl.h> +#include "../internal.h" +#include "netlink.h" #include "prettymsg.h" #define __INDENT 4
@@ -114,6 +116,9 @@ static int pretty_print_attr(const struct nlattr *attr,case NLA_U64 :printf ("%" PRIu64,mnl_attr_get_u64 (attr));break ; +case NLA_UINT : +printf ("%" PRIu64,attr_get_uint (attr)); +break ;case NLA_X8 :printf ("0x%02x" ,mnl_attr_get_u8 (attr));break ;
netlink/prettymsg.h +2 -0
@@ -18,6 +18,7 @@ enum pretty_nla_format {NLA_U16 ,NLA_U32 ,NLA_U64 , +NLA_UINT ,NLA_X8 ,NLA_X16 , NLA_X32,
@@ -67,6 +68,7 @@ struct pretty_nlmsg_desc {#define NLATTR_DESC_U16 (_name) NLATTR_DESC(_name, NLA_U16)#define NLATTR_DESC_U32 (_name) NLATTR_DESC(_name, NLA_U32)#define NLATTR_DESC_U64 (_name) NLATTR_DESC(_name, NLA_U64) +#define NLATTR_DESC_UINT (_name) NLATTR_DESC(_name, NLA_UINT)#define NLATTR_DESC_X8 (_name) NLATTR_DESC(_name, NLA_X8)#define NLATTR_DESC_X16 (_name) NLATTR_DESC(_name, NLA_X16)#define NLATTR_DESC_X32 (_name) NLATTR_DESC(_name, NLA_X32)
shell-completion/bash/ethtool +27 -0
@@ -1164,6 +1164,32 @@ _ethtool_set_module() COMPREPLY=( $( compgen -W "${!settings[*]}" -- "$cur" ) ) } +# Completion for ethtool --flash-module-firmware +_ethtool_flash_module_firmware() +{ + local -A settings=( + [file]=1 + [pass]=1 + ) + + case "$prev" in + file) + _ethtool_firmware + return ;; + pass) + # Number + return ;; + esac + + # Remove settings which have been seen + local word + for word in "${words[@]:3:${#words[@]}-4}"; do + unset "settings[$word]" + done + + COMPREPLY=( $( compgen -W "${!settings[*]}" -- "$cur" ) ) +} + # Complete any ethtool command _ethtool() {
@@ -1217,6 +1243,7 @@ _ethtool() [--test]=test [--set-module]=set_module [--show-module]=devname + [--flash-module-firmware]=flash_module_firmware ) local -A other_funcs=( [--config-ntuple]=config_nfc
Signature · 1 line
2.45.0