Skip to contentSkip to conversation

platform/x86: Add Slim Bootloader firmware update support

PATCH New Jithu Joseph 1 participant 2 messages Apr 27, 2020 x86 platform drivers

lore
Share & tools
lore
#0 lore raw

v3 cover platform/x86: Add Slim Bootloader firmware update support

v3 addresses review comment from Andy Shevchenko to v2.

Changes in v3
- Renamed the driver file to intel-wmi-sbl-fw-update.c. This resulted in various changes like:
- renaming, reordering the driver entry in Makefile and Kconfig
- renaming, reordering the MAINTAINERS file entry
- renamed the ABI file
- renaming few data structures and wmi_driver entries to reflect the new name

v2 Upstream submission is available here:
https://lore.kernel.org/lkml/[email protected]

From v2 submission:

v1 Upstream submission is available here:
https://lore.kernel.org/lkml/[email protected]

v2 primarily addresses review comments from Andy Shevchenko to v1.

Changes in v2
- Rebased on top of tag: v5.7-rc2
- Added ABI documentation file
- Changed the ordering of SBL entry in Makefile and Kconfig
- Replaced kstrtobool() with kstrtouint() for user input processing
- Added DocLink: tag to annottate weblink in commit message
- Minor edits to commit message in p1/1
- Style related changes

From v1 submission:

Slim Bootloader(SBL) [see link below] is a small open-source boot firmware, designed for running on certain Intel platforms. SBL can be thought-of as fulfilling the role of a minimal BIOS implementation, i.e initializing the hardware and booting Operating System.

This driver creates sysfs interfaces which allows user space entities to trigger update of SBL firmware.

Acknowledgment: Initial draft of the driver code was authored by Maurice Ma <[email protected]>

DocLink: https://slimbootloader.github.io

Jithu Joseph (1):
platform/x86: Add Slim Bootloader firmware update signaling driver

 .../sysfs-platform-intel-wmi-sbl-fw-update    |  12 ++
 MAINTAINERS                                   |   7 +
 drivers/platform/x86/Kconfig                  |  10 ++
 drivers/platform/x86/Makefile                 |   1 +
 .../platform/x86/intel-wmi-sbl-fw-update.c    | 145 ++++++++++++++++++
 5 files changed, 175 insertions(+)
 create mode 100644 Documentation/ABI/testing/sysfs-platform-intel-wmi-sbl-fw-update
 create mode 100644 drivers/platform/x86/intel-wmi-sbl-fw-update.c

base-commit: ae83d0b416db002fe95601e7f97f64b59514d936

Signature · 1 line
2.17.1
#1 lore raw

PATCH v3 1/1 platform/x86: Add Slim Bootloader firmware update signaling driver

Slim Bootloader(SBL) is a small open-source boot firmware, designed for running on certain Intel platforms. SBL can be thought-of as fulfilling the role of a minimal BIOS implementation, i.e initializing the hardware and booting Operating System.

Since SBL is not UEFI compliant, firmware update cannot be triggered using standard UEFI runtime services. Further considering performance impact, SBL doesn't look for a firmware update image on every reset and does so only when firmware update signal is asserted.

SBL exposes an ACPI-WMI device which comes up in sysfs as /sys/bus/wmi/44FADEB1xxx and this driver adds a "firmware_update_request" device attribute. This attribute normally has a value of 0 and userspace can signal SBL to update firmware, on next reboot, by writing a value of 1 like:

echo 1 > /sys/bus/wmi/devices/44FADEB1xxx/firmware_update_request

This driver only implements a signaling mechanism, the actual firmware update process and various details like firmware update image format, firmware image location etc are defined by SBL and are not in the scope of this driver.

DocLink: https://slimbootloader.github.io/security/firmware-update.html

---
 .../sysfs-platform-intel-wmi-sbl-fw-update    |  12 ++
 MAINTAINERS                                   |   7 +
 drivers/platform/x86/Kconfig                  |  10 ++
 drivers/platform/x86/Makefile                 |   1 +
 .../platform/x86/intel-wmi-sbl-fw-update.c    | 145 ++++++++++++++++++
 5 files changed, 175 insertions(+)
 create mode 100644 Documentation/ABI/testing/sysfs-platform-intel-wmi-sbl-fw-update
 create mode 100644 drivers/platform/x86/intel-wmi-sbl-fw-update.c
Documentation/ABI/testing/sysfs-platform-intel-wmi-sbl-fw-update new file +12 -0
new file mode 100644
index 000000000000..5aa618987cad
@@ -0,0 +1,12 @@
+What:		/sys/bus/wmi/devices/44FADEB1-B204-40F2-8581-394BBDC1B651/firmware_update_request
+Date:		April 2020
+KernelVersion:	5.7
+Contact:	"Jithu Joseph" <[email protected]>
+Description:
+		Allow user space entities to trigger update of Slim
+		Bootloader (SBL). This attribute normally has a value
+		of 0 and userspace can signal SBL to update firmware,
+		on next reboot, by writing a value of 1.
+		There are two available states:
+		    * 0 -> Skip firmware update while rebooting
+		    * 1 -> Attempt firmware update on next reboot
MAINTAINERS +7 -0
index b816a453b10e..7f1355cb406b 100644
@@ -8826,6 +8826,13 @@ F:	Documentation/admin-guide/wimax/i2400m.rst
 F:	drivers/net/wimax/i2400m/
 F:	include/uapi/linux/wimax/i2400m.h
 
+INTEL WMI SLIM BOOTLOADER (SBL) FIRMWARE UPDATE DRIVER
+M:	Jithu Joseph <[email protected]>
+R:	Maurice Ma <[email protected]>
+S:	Maintained
+W:	https://slimbootloader.github.io/security/firmware-update.html
+F:	drivers/platform/x86/intel-wmi-sbl-fw-update.c
+
 INTEL WMI THUNDERBOLT FORCE POWER DRIVER
 M:	Mario Limonciello <[email protected]>
 S:	Maintained
drivers/platform/x86/Kconfig +10 -0
index 0ad7ad8cf8e1..68851f47b84a 100644
@@ -78,6 +78,16 @@ config HUAWEI_WMI
 	  To compile this driver as a module, choose M here: the module
 	  will be called huawei-wmi.
 
+config INTEL_WMI_SBL_FW_UPDATE
+	tristate "Intel WMI Slim Bootloader firmware update signaling driver"
+	depends on ACPI_WMI
+	help
+	  Say Y here if you want to be able to use the WMI interface to signal
+	  Slim Bootloader to trigger update on next reboot.
+
+	  To compile this driver as a module, choose M here: the module will
+	  be called intel-wmi-sbl-fw-update.
+
 config INTEL_WMI_THUNDERBOLT
 	tristate "Intel WMI thunderbolt force power driver"
 	depends on ACPI_WMI
drivers/platform/x86/Makefile +1 -0
index 53408d965874..1fa47d5cbed5 100644
@@ -11,6 +11,7 @@ obj-$(CONFIG_WMI_BMOF)		+= wmi-bmof.o
 # WMI drivers
 obj-$(CONFIG_ALIENWARE_WMI)		+= alienware-wmi.o
 obj-$(CONFIG_HUAWEI_WMI)		+= huawei-wmi.o
+obj-$(CONFIG_INTEL_WMI_SBL_FW_UPDATE)	+= intel-wmi-sbl-fw-update.o
 obj-$(CONFIG_INTEL_WMI_THUNDERBOLT)	+= intel-wmi-thunderbolt.o
 obj-$(CONFIG_MXM_WMI)			+= mxm-wmi.o
 obj-$(CONFIG_PEAQ_WMI)			+= peaq-wmi.o
drivers/platform/x86/intel-wmi-sbl-fw-update.c new file +145 -0

145 lines not on this page · raw message

Signature · 1 line
2.17.1