Skip to content

Add ability to flash modules' firmware

Danielle Ratson linux-doc lkml netdev 1 version In review

Get series with b4
b4 am [email protected]

Versions newest first

  1. v1 Latest10 patches 5 repliesIn review

Patches in v1 No applies recorded yet

#Subject and filesSizeRepliesApplied
1/10ethtool: Add ethtool operation to write to a transceiver module EEPROMinclude/linux/ethtool.h+12 -80 replies
2/10mlxsw: Implement ethtool operation to write to a transceiver module EEPROMdrivers/net/ethernet/mellanox/mlxsw/core_env.c drivers/net/ethernet/mellanox/mlxsw/core_env.h drivers/net/ethernet/mellanox/mlxsw/minimal.c +1 more+93 -00 replies
3/10ethtool: Add an interface for flashing transceiver modules' firmwareDocumentation/netlink/specs/ethtool.yaml Documentation/networking/ethtool-netlink.rst include/uapi/linux/ethtool.h +1 more+163 -00 replies
4/10ethtool: Add flashing transceiver modules' firmware notifications abilitynet/ethtool/module.c net/ethtool/module_fw.h+93 -00 replies
5/10include: netdevice: Add module firmware flashing in progress flag to net_deviceinclude/linux/netdevice.h+3 -10 replies
6/10net: sfp: Add more extended compliance codesinclude/linux/sfp.h+6 -00 replies
7/10ethtool: cmis_cdb: Add a layer for supporting CDB commandsnet/ethtool/Makefile net/ethtool/cmis.h net/ethtool/cmis_cdb.c +1 more+674 -15 replies
8/10ethtool: cmis_fw_update: add a layer for supporting firmware update using CDBnet/ethtool/Makefile net/ethtool/cmis.h net/ethtool/cmis_fw_update.c +1 more+417 -10 replies
9/10ethtool: Add ability to flash transceiver modules' firmwarenet/ethtool/module.c net/ethtool/netlink.c net/ethtool/netlink.h+183 -00 replies
10/10ethtool: Veto some operations during firmware flashing processnet/ethtool/eeprom.c net/ethtool/ioctl.c net/ethtool/module.c +1 more+76 -10 replies

Reviews trailers per patch

3 of 10 patches have a Reviewed-by or Acked-by.

PatchPetr MachataRussell King (Oracle)
1/10
2/10R-b
3/10
4/10
5/10R-b
6/10R-b R-b
7/10
8/10
9/10
10/10

Trailers given in replies are filled; those carried in the patches from earlier versions are outlined with dashes.

Read the v1 thread

Cover letter [PATCH net-next 00/10] 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.

According to the CMIS standard, the firmware update process is done using a CDB commands sequence.

CDB (Command Data Block Message Communication) reads and writes are performed on memory map pages 9Fh-AFh according to the CMIS standard, section 8.12 of revision 4.0.

Add a pair of new ethtool messages that allow:

* User space to trigger firmware update of transceiver modules

* The kernel to notify user space about the progress of the process

The user interface is designed to be asynchronous in order to avoid RTNL being held for too long and to allow several modules to be updated simultaneously. The interface is designed with CMIS compliant modules in mind, but kept generic enough to accommodate future use cases, if these arise.

The kernel interface that will implement the firmware update using CDB command will include 2 layers that will be added under ethtool:

* The upper layer that will be triggered from the module layer, is cmis_ fw_update.
* The lower one is cmis_cdb.

In the future there might be more operations to implement using CDB commands. Therefore, the idea is to keep the cmis_cdb interface clean and the cmis_fw_update specific to the cdb commands handling it.

The communication between the kernel and the driver will be done using two ethtool operations that enable reading and writing the transceiver module EEPROM.
The operation ethtool_ops::get_module_eeprom_by_page, that is already implemented, will be used for reading from the EEPROM the CDB reply, e.g. reading module setting, state, etc.
The operation ethtool_ops::set_module_eeprom_by_page, that is added in the current patchset, will be used for writing to the EEPROM the CDB command such as start firmware image, run firmware image, etc.

Therefore in order for a driver to implement module flashing, that driver needs to implement the two functions mentioned above.

Patchset overview:
Patch #1-#2: Implement the EEPROM writing in mlxsw. Patch #3: Define the interface between the kernel and user space. Patch #4: Add ability to notify the flashing firmware progress. Patch #5: Add firmware flashing in progress flag.
Patch #6: Add extended compliance codes.
Patch #7: Add the cdb layer.
Patch #8: Add the fw_update layer.
Patch #9: Add ability to flash transceiver modules' firmware. Patch #10: Veto problematic scenarios.

Danielle Ratson (8):
ethtool: Add an interface for flashing transceiver modules' firmware
ethtool: Add flashing transceiver modules' firmware notifications
ability
include: netdevice: Add module firmware flashing in progress flag to
net_device
net: sfp: Add more extended compliance codes
ethtool: cmis_cdb: Add a layer for supporting CDB commands
ethtool: cmis_fw_update: add a layer for supporting firmware update
using CDB
ethtool: Add ability to flash transceiver modules' firmware
ethtool: Veto some operations during firmware flashing process

Ido Schimmel (2):
ethtool: Add ethtool operation to write to a transceiver module EEPROM
mlxsw: Implement ethtool operation to write to a transceiver module
EEPROM

 Documentation/netlink/specs/ethtool.yaml      |  63 ++
 Documentation/networking/ethtool-netlink.rst  |  62 ++
 .../net/ethernet/mellanox/mlxsw/core_env.c    |  57 ++
 .../net/ethernet/mellanox/mlxsw/core_env.h    |   6 +
 drivers/net/ethernet/mellanox/mlxsw/minimal.c |  15 +
 .../mellanox/mlxsw/spectrum_ethtool.c         |  15 +
 include/linux/ethtool.h                       |  20 +-
 include/linux/netdevice.h                     |   4 +-
 include/linux/sfp.h                           |   6 +
 include/uapi/linux/ethtool.h                  |  18 +
 include/uapi/linux/ethtool_netlink.h          |  20 +
 net/ethtool/Makefile                          |   2 +-
 net/ethtool/cmis.h                            | 121 ++++
 net/ethtool/cmis_cdb.c                        | 549 ++++++++++++++++++
 net/ethtool/cmis_fw_update.c                  | 391 +++++++++++++
 net/ethtool/eeprom.c                          |   6 +
 net/ethtool/ioctl.c                           |  12 +
 net/ethtool/module.c                          | 286 +++++++++
 net/ethtool/module_fw.h                       |  38 ++
 net/ethtool/netlink.c                         |  37 +-
 net/ethtool/netlink.h                         |   2 +
 21 files changed, 1719 insertions(+), 11 deletions(-)
 create mode 100644 net/ethtool/cmis.h
 create mode 100644 net/ethtool/cmis_cdb.c
 create mode 100644 net/ethtool/cmis_fw_update.c
 create mode 100644 net/ethtool/module_fw.h
Signature · 1 line
2.43.0