Skip to content

Extend FW framework for user FW uploads

Russ Weight lkml 6 versions – In review

Get series with b4
b4 am [email protected]

Versions newest first · linked by author and title

  1. v5 Latest8 patches 2 repliesIn review
  2. v48 patches 3 repliesSuperseded
  3. v38 patches 1 replySuperseded
Earlier versions · 3
VersionPostedPatchesRepliesStatus
v28 patches1 replySuperseded
v1 posting 2/28 patches8 repliesSuperseded
v1 posting 1/28 patches4 repliesSuperseded

Changes in v5 from the cover letter

- Added Tested-by tag
- More cleanup for "#ifdef CONFIG_FW_LOADER_USER_HELPER". Error reported by the kernel test robot <[email protected]>.

Patches in v5 No applies recorded yet

#Subject and filesSizeRepliesApplied
1/8firmware_loader: Clear data and size in fw_free_paged_bufdrivers/base/firmware_loader/main.c+2 -00 replies
2/8firmware_loader: Check fw_state_is_done in loading_storedrivers/base/firmware_loader/fallback.c drivers/base/firmware_loader/firmware.h+18 -200 replies
3/8firmware_loader: Split sysfs support from fallbackdrivers/base/firmware_loader/Kconfig drivers/base/firmware_loader/Makefile drivers/base/firmware_loader/fallback.c +3 more+503 -4630 replies
4/8firmware_loader: Add firmware-upload supportDocumentation/ABI/testing/sysfs-class-firmware Documentation/driver-api/firmware/fw_upload.rst Documentation/driver-api/firmware/index.rst +9 more+595 -120 replies
5/8firmware_loader: Add sysfs nodes to monitor fw_uploadDocumentation/ABI/testing/sysfs-class-firmware Documentation/driver-api/firmware/fw_upload.rst drivers/base/firmware_loader/sysfs.c +2 more+201 -20 replies
6/8test_firmware: Add test support for firmware uploadlib/test_firmware.c+261 -00 replies
7/8test_firmware: Error injection for firmware uploadlib/test_firmware.c+122 -50 replies
8/8selftests: firmware: Add firmware upload selfteststools/testing/selftests/firmware/Makefile tools/testing/selftests/firmware/config tools/testing/selftests/firmware/fw_lib.sh +2 more+227 -12 replies

Reviews trailers per patch

All 8 patches have a Reviewed-by or Acked-by.

PatchLuis ChamberlainTianfei zhangMatthew Gerlach
1/8R-b R-b T-b
2/8R-b R-b T-b
3/8R-b R-b T-b
4/8R-b R-b T-b
5/8R-b R-b T-b
6/8R-b R-b T-b
7/8R-b R-b T-b
8/8R-b R-b T-b

Trailers given in replies are filled; those carried in the patches from earlier versions are outlined with dashes. Scroll the table sideways for all 3 reviewers.

Read the v5 thread

Cover letter [PATCH v5 0/8] Extend FW framework for user FW uploads

Extend the firmware loader subsystem to support a persistent sysfs interface that userspace may use to initiate a firmware update. For example, FPGA based PCIe cards automatically load firmware and FPGA images from local FLASH when the card boots. The images in FLASH may be updated with new images that are uploaded by the user.

A device driver may call firmware_upload_register() to expose persistent "loading" and "data" sysfs files at /sys/class/firmware/<NAME>/*. These files are used in the same way as the fallback sysfs "loading" and "data" files. However, when 0 is written to "loading" to complete the write of firmware data, the data is also transferred to the lower-level driver using pre-registered call-back functions. The data transfer is done in the context of a kernel worker thread.

Additional sysfs nodes are added in the same location as "loading" and "data" to monitor the transfer of the image data to the device using callback functions provided by the lower-level device driver and to allow the data transfer to be cancelled.

Example usage:

$ pwd
/sys/class/firmware/secure-update.1
$ ls
cancel  device  loading  remaining_size  subsystem
data    error   power    status          uevent
$ echo 1 > loading
$ cat /tmp/firmware.bin > data
$ echo 0 > loading
$ while :; do cat status; cat remaining_size ; sleep 3; done
preparing
44590080
<--snip-->
transferring
44459008
transferring
44311552
<--snip-->
transferring
173056
<--snip-->
programming
0
<--snip-->
idle
0
^C
$ cat error

The first two patches in this set make minor changes to enable the fw_priv data structure and the sysfs interfaces to be used multiple times during the existence of the device driver instance. The third patch is mostly a reorganization of existing code in preparation for sharing common code with the firmware-upload support. The fourth and fifth patches provide the code for user-initiated firmware uploads. The final 3 patches extend selftest support to test firmware-upload functionality.

The first driver to use firmware-upload is being submitted _soon_ under the title of "Intel MAX10 BMC Secure Update Driver".

Changelog v4 -> v5:
- Added Tested-by tag
- More cleanup for "#ifdef CONFIG_FW_LOADER_USER_HELPER". Error reported by the kernel test robot <[email protected]>.

Changelog v3 -> v4:
- Added Reviewed-by tag
- Fixed errors reported by the kernel test robot <[email protected]> by adjusting the functions that are bound by
"#ifdef CONFIG_FW_LOADER_USER_HELPER".

Changelog v2 -> v3:
- Added Reviewed-by tag
- Added kdoc support for enum fw_upload_prog progress codes

Changelog v1 -> v2:
- Rebased to 5.18-rc2.
- It was discovered that the new function in v1, fw_state_is_done(), is equivalent to the existing fw_sysfs_done() function. Renamed fw_sysfs_done() and fw_sysfs_loading() to fw_state_is_done() and fw_state_is_loading() respectively, and placed them along side companion functions in drivers/base/firmware_loader/firmware.h.
- Removed the "if !fw_sysfs_done(fw_priv))" condition in switch case 1 of firmware_loading_store(). It is rendered unnecessary by other changes to the function.
- Updated documentation Date and KernelVersion fields to July 2022

    and 5.19.
  - Unconditionally set fw_priv->is_paged_buf to true in
    firmware_upload_register();

Changelog RFC -> v1:
- Renamed files fw_sysfs.c and fw_sysfs.h to sysfs.c and sysfs.h
- Moved "MODULE_IMPORT_NS(FIRMWARE_LOADER_PRIVATE);" from sysfs.c to sysfs.h to address an error identified by the kernel test robot <[email protected]>
- renamed fw_upload_register() and fw_upload_unregister() to firmware_upload_register() and fw_upload_unregister().
- Moved ifdef'd section of code out of firmware_loading_store() in sysfs.c into a new function, fw_upload_start(), in sysfs_upload.c.
- Changed #defines to enums for error codes and progress states
- Added additional kernel-doc supported symbols into the documentation. Some rewording in documentation as well.
- Added module reference counting for the parent module in the firmware_upload_register() and firmware_upload_unregister() functions to fix problems found when testing with test_firmware module.
- Removed unnecessary module reference counting for THIS_MODULE.
- Added a new patch to modify the test_firmware module to support testing of the firmware upload mechanism.
- Added a new patch to modify the test_firmware module to support error injection for firmware upload.
- Added a new patch to extend the existing firmware selftests to cover firmware upload.

Russ Weight (8):
firmware_loader: Clear data and size in fw_free_paged_buf
firmware_loader: Check fw_state_is_done in loading_store
firmware_loader: Split sysfs support from fallback
firmware_loader: Add firmware-upload support
firmware_loader: Add sysfs nodes to monitor fw_upload
test_firmware: Add test support for firmware upload
test_firmware: Error injection for firmware upload
selftests: firmware: Add firmware upload selftests

 .../ABI/testing/sysfs-class-firmware          |  77 ++++
 .../driver-api/firmware/fw_upload.rst         | 126 +++++
 Documentation/driver-api/firmware/index.rst   |   1 +
 drivers/base/firmware_loader/Kconfig          |  18 +
 drivers/base/firmware_loader/Makefile         |   2 +
 drivers/base/firmware_loader/fallback.c       | 430 ------------------
 drivers/base/firmware_loader/fallback.h       |  46 +-
 drivers/base/firmware_loader/firmware.h       |  16 +
 drivers/base/firmware_loader/main.c           |  18 +-
 drivers/base/firmware_loader/sysfs.c          | 425 +++++++++++++++++
 drivers/base/firmware_loader/sysfs.h          | 100 ++++
 drivers/base/firmware_loader/sysfs_upload.c   | 397 ++++++++++++++++
 drivers/base/firmware_loader/sysfs_upload.h   |  54 +++
 include/linux/firmware.h                      |  82 ++++
 lib/test_firmware.c                           | 378 +++++++++++++++
 tools/testing/selftests/firmware/Makefile     |   2 +-
 tools/testing/selftests/firmware/config       |   1 +
 tools/testing/selftests/firmware/fw_lib.sh    |   7 +
 .../selftests/firmware/fw_run_tests.sh        |   4 +
 tools/testing/selftests/firmware/fw_upload.sh | 214 +++++++++
 20 files changed, 1912 insertions(+), 486 deletions(-)
 create mode 100644 Documentation/ABI/testing/sysfs-class-firmware
 create mode 100644 Documentation/driver-api/firmware/fw_upload.rst
 create mode 100644 drivers/base/firmware_loader/sysfs.c
 create mode 100644 drivers/base/firmware_loader/sysfs.h
 create mode 100644 drivers/base/firmware_loader/sysfs_upload.c
 create mode 100644 drivers/base/firmware_loader/sysfs_upload.h
 create mode 100755 tools/testing/selftests/firmware/fw_upload.sh
Signature · 1 line
2.25.1