]> git.ipfire.org Git - thirdparty/linux.git/commitdiff
sfc: document devlink flash support
authorEdward Cree <ecree.xilinx@gmail.com>
Mon, 10 Feb 2025 11:25:45 +0000 (11:25 +0000)
committerJakub Kicinski <kuba@kernel.org>
Wed, 12 Feb 2025 01:12:17 +0000 (17:12 -0800)
Update the information in sfc's devlink documentation including
 support for firmware update with devlink flash.
Also update the help text for CONFIG_SFC_MTD, as it is no longer
 strictly required for firmware updates.

Signed-off-by: Edward Cree <ecree.xilinx@gmail.com>
Link: https://patch.msgid.link/3476b0ef04a0944f03e0b771ec8ed1a9c70db4dc.1739186253.git.ecree.xilinx@gmail.com
Signed-off-by: Jakub Kicinski <kuba@kernel.org>
Documentation/networking/devlink/sfc.rst
drivers/net/ethernet/sfc/Kconfig

index db64a1bd9733620f6c9e725eb4fa02e23b9ad118..0398d59ea18485ec242d64be42dcbfc306b27ed7 100644 (file)
@@ -5,7 +5,7 @@ sfc devlink support
 ===================
 
 This document describes the devlink features implemented by the ``sfc``
-device driver for the ef100 device.
+device driver for the ef10 and ef100 devices.
 
 Info versions
 =============
@@ -18,6 +18,10 @@ The ``sfc`` driver reports the following versions
    * - Name
      - Type
      - Description
+   * - ``fw.bundle_id``
+     - stored
+     - Version of the firmware "bundle" image that was last used to update
+       multiple components.
    * - ``fw.mgmt.suc``
      - running
      - For boards where the management function is split between multiple
@@ -55,3 +59,13 @@ The ``sfc`` driver reports the following versions
    * - ``fw.uefi``
      - running
      - UEFI driver version (No UNDI support).
+
+Flash Update
+============
+
+The ``sfc`` driver implements support for flash update using the
+``devlink-flash`` interface. It supports updating the device flash using a
+combined flash image ("bundle") that contains multiple components (on ef10,
+typically ``fw.mgmt``, ``fw.app``, ``fw.exprom`` and ``fw.uefi``).
+
+The driver does not support any overwrite mask flags.
index 3eb55dcfa8a61e731b68f289299dcd3719f3ce51..c4c43434f314347a0af64e3c46b7feb58795a760 100644 (file)
@@ -38,8 +38,9 @@ config SFC_MTD
        default y
        help
          This exposes the on-board flash and/or EEPROM as MTD devices
-         (e.g. /dev/mtd1).  This is required to update the firmware or
-         the boot configuration under Linux.
+         (e.g. /dev/mtd1).  This is required to update the boot
+         configuration under Linux, or use some older userland tools to
+         update the firmware.
 config SFC_MCDI_MON
        bool "Solarflare SFC9100-family hwmon support"
        depends on SFC && HWMON && !(SFC=y && HWMON=m)