efi_loader: add capsule update support
v5 cover efi_loader: add capsule update support
Summary
=======
'UpdateCapsule' is one of runtime services defined in UEFI specification and its aim is to allow a caller (OS) to pass information to the firmware, i.e. U-Boot. This is mostly used to update firmware binary on devices by instructions from OS.
While 'UpdateCapsule' is a runtime services function, it is, at least initially, supported only before exiting boot services alike other runtime functions, [Get/]SetVariable. This is because modifying storage which may be shared with OS must be carefully designed and there is no general assumption that we can do it.
Therefore, we practically support only "capsule on disk"; any capsule can be handed over to UEFI subsystem as a file on a specific file system.
In this patch series, all the related definitions and structures are given as UEFI specification describes, and basic framework for capsule support is provided. Currently supported is
* firmware update (Firmware Management Protocol or simply FMP)
Most of functionality of firmware update is provided by FMP driver and it can be, by nature, system/platform-specific. So you can and should implement your own FMP driver(s) based on your system requirements. Under the current implementation, we provide two basic but generic drivers with two formats:
* FIT image format (as used in TFTP update and dfu)
* raw image format
It's totally up to users which one, or both, should be used on users' system depending on user requirements.
Quick usage
===========
1. You can create a capsule file with the following host command:
$ mkeficapsule [--fit <fit image> | --raw <raw image>] <output file>
2. Put the file under:
/EFI/UpdateCapsule of UEFI system partition
3. Specify firmware storage to be updated in "dfu_alt_info" variable (Please follow README.dfu for details.)
==> env set dfu_alt_info '...'
4. After setting up UEFI's OsIndications variable, reboot U-Boot:
OsIndications <= EFI_OS_INDICATIONS_FILE_CAPSULE_DELIVERY_SUPPORTED
Patch structure
===============
Patch#1-#4,#12: preparatory patches
Patch#5-#11,#13: main part of implementation
Patch#14-#15: utilities
Patch#16-#17: pytests
[1] https://git.linaro.org/people/takahiro.akashi/u-boot.git efi/capsule
Prerequisite patches
====================
dfu change by Heinrich[2]
[2] https://lists.denx.de/pipermail/u-boot/2020-July/420950.html
Test
====
* passed all the pytests which are included in this patch series on sandbox build locally.
Please note that the capsule pytest itself won't be run in the CI partly because some specific configuration for sandbox build is required and partly because there is a problem with virt-make-fs. See test_efi_capsule_firmware.py.
Issues
======
* Timing of executing capsules-on-disk
Currently, processing a capsule is triggered only as part of UEFI subsystem initialization. This means that, for example, firmware update, may not take place@system booting time and will potentially be delayed until a first call of any UEFI functions.
=> See patch#5 for my proposal
* A bunch of warnings like
WARNING: Use 'if (IS_ENABLED(CONFIG...))' instead of '#if or #ifdef' where possible
I don't think that fixing those improves anything.
* Add a document in uefi.rst
TODO's
======
(Won't be addressed in this series.)
* capsule authentication
* capsule dependency (dependency expression instruction set)
* loading drivers in a capsule
* handling RESET flag in a capsule and QeuryCapsuleCaps
* full semantics of ESRT (EFI System Resource Table)
* enabling capsule API at runtime
* json capsule
* recovery from update failure
Changes
=======
v5 (August 3, 2020)
* removed superfluous type conversion at dfu_write_from_mem_addr() (Patch#2)
* introduced a common helper function, efi_create_indexed_name() (Patch#6,#7,#8)
* use efi_[get|set]_variable_int(), if necessary, with READ_ONLY (Patch#7,#8)
* return EFI_UNSUPPORTED at Patch#7
* changed the word, number, to 'index' (Patch#7,#8)
* removed 'ifdef CONFIG_EFI_CAPSULE_ON_DISK' from a header (Patch#8)
* initialize 'CapsuleLast' in efi_init_obj_list() (Patch#7,#8)
* added 'const' qualifier for filename argument at efi_capsule_[read|delete]_file() (Patch#8)
v4 (July 22, 2020)
* rebased to Heinrich's current efi-2020-10
* rework dfu-related code to align with Heinrich's change (Patch#1,#3)
* change a type of 'addr' argument from int to 'void *' per Sughosh's comment (Patch#2-#3,#11-#12)
* rework/simplify pytests (Patch#15-#16)
- utilize virt-make-fs
- drop Test Case 1 (updating U-Boot environment data)
- remove useless definitions (MNT_PNT, EFI_CAPSULE_IMAGE_NAME)
- apply autopep8
v3 (July 10, 2020)
* rebased to Heinrich's current efi-2020-10-rc1
* refactor efi_firmware_[fit|raw]_get_image_info() (patch#11,#13)
v2 (June 17, 2020)
* rebased to v2020.07-rc4
* add preparatory patches for dfu (Patch#1-#5, #12)
* rework FIT capsule driver to utilize dfu_alt_info instead of CONFIG_xxx (patch#11)
* extend get_image_info() to correspond to dfu_alt_info (patch#11)
* add a 'raw binary' capsule support
(patch#13, #17)
* allow multiple capsule formats (with different GUIDs) to be installed (patch#11, #13)
* extend mkeficapsule command to accept additional parameters, like version/index/hardware instance for a capsule header info. (patch#15)
* mkeficapsule can now also generate raw-binary capsule (patch#16)
* add function descriptions
* apply autopep8 to pytests and fix more against pylint
v1 (April 27, 2020)
* rebased to v2020.07-rc
* removed already-merged patches (RFC's #1 to #4)
* dropped 'variable update' capsule support (RFC's patch#10)
* dropped 'variable configuration table' support (RFC's patch#11) (Those two should be discussed separately.)
* add preparatory patches (patch#1/#2)
* fix several build errors
* rename some Kconfig options to be aligned with UEFI specification's terms (patch#3,4,6,7)
* enforce UpdateCapsule API to be disabled after ExitBootServices (patch#3)
* use config table, runtime_services_supported, instead of variable (patch#3)
* make EFI_CAPSULE_ON_DISK buildable even if UpdateCapsule API is disabled (patch4)
* support OsIndications, invoking capsule-on-disk only if the variable indicates so (patch#4)
* introduced EFI_CAPSULE_ON_DISK_EARLY to invoke capsule-on-disk in U-Boot initialization (patch#4)
* detect capsule files only if they are on EFI system partition (patch#4)
* use printf, rather than EFI_PRINT, in error cases (patch#4)
* use 'header_size' field to retrieve capsule data, adding sanity checks against capsule size (patch#6)
* call fmpt driver interfaces with EFI_CALL (patch#6)
* remove 'variable update capsule'-related code form mkeficapsule (patch#9)
* add a test case of OsIndications not being set properly (patch#10)
* adjust test scenario for EFI_CAPSULE_ON_DISK_EARLY (patch#10)
* revise pytest scripts (patch#10)
Initial release as RFC (March 17, 2020)
AKASHI Takahiro (17):
dfu: rename dfu_tftp_write() to dfu_write_by_name()
dfu: modify an argument type for an address
common: update: add a generic interface for FIT image
dfu: export dfu_list
efi_loader: add option to initialise EFI subsystem early
efi_loader: add efi_create_indexed_name()
efi_loader: define UpdateCapsule api
efi_loader: capsule: add capsule_on_disk support
efi_loader: capsule: add memory range capsule definitions
efi_loader: capsule: support firmware update
efi_loader: add firmware management protocol for FIT image
dfu: add dfu_write_by_alt()
efi_loader: add firmware management protocol for raw image
cmd: add "efidebug capsule" command
tools: add mkeficapsule command for UEFI capsule update test/py: add a test for uefi firmware update capsule of FIT image test/py: add a test for uefi firmware update capsule of raw image
cmd/efidebug.c | 235 +++++ common/Kconfig | 14 + common/Makefile | 3 +- common/board_r.c | 6 + common/main.c | 4 + common/update.c | 77 +- drivers/dfu/Kconfig | 6 + drivers/dfu/Makefile | 2 +- drivers/dfu/dfu.c | 2 +- drivers/dfu/dfu_alt.c | 125 +++ drivers/dfu/dfu_tftp.c | 65 -- include/dfu.h | 57 +- include/efi_api.h | 160 +++ include/efi_loader.h | 30 + include/image.h | 12 + lib/efi_loader/Kconfig | 72 ++ lib/efi_loader/Makefile | 2 + lib/efi_loader/efi_capsule.c | 910 ++++++++++++++++++ lib/efi_loader/efi_firmware.c | 398 ++++++++ lib/efi_loader/efi_runtime.c | 104 +- lib/efi_loader/efi_setup.c | 106 +- test/py/tests/test_efi_capsule/conftest.py | 72 ++ test/py/tests/test_efi_capsule/defs.py | 12 + .../test_efi_capsule/test_capsule_firmware.py | 241 +++++ .../tests/test_efi_capsule/uboot_bin_env.its | 36 + tools/Makefile | 3 + tools/mkeficapsule.c | 237 +++++ 27 files changed, 2851 insertions(+), 140 deletions(-) create mode 100644 drivers/dfu/dfu_alt.c delete mode 100644 drivers/dfu/dfu_tftp.c create mode 100644 lib/efi_loader/efi_capsule.c create mode 100644 lib/efi_loader/efi_firmware.c create mode 100644 test/py/tests/test_efi_capsule/conftest.py create mode 100644 test/py/tests/test_efi_capsule/defs.py create mode 100644 test/py/tests/test_efi_capsule/test_capsule_firmware.py create mode 100644 test/py/tests/test_efi_capsule/uboot_bin_env.its create mode 100644 tools/mkeficapsule.c
Signature · 1 line
2.27.0
PATCH v5 1/17 dfu: rename dfu_tftp_write() to dfu_write_by_name()
This function is essentially independent from tffp, and will also be utilised in implementing UEFI capsule update in a later commit. So just give it a more generic name.
In addition, a new configuration option, CONFIG_DFU_ALT, was introduced so that the file will be compiled with different options, particularly one added in a later commit.
---
common/update.c | 5 +++--
drivers/dfu/Kconfig | 5 +++++
drivers/dfu/Makefile | 2 +-
drivers/dfu/{dfu_tftp.c => dfu_alt.c} | 17 ++++++++++++--
include/dfu.h | 32 +++++++++++++--------------
5 files changed, 40 insertions(+), 21 deletions(-)
rename drivers/dfu/{dfu_tftp.c => dfu_alt.c} (67%)common/update.c +3 -2
@@ -181,8 +181,9 @@ got_update_file: }if (fit_image_check_type (fit, noffset,IH_TYPE_FIRMWARE )) { - ret =dfu_tftp_write (fit_image_name, update_addr, - update_size, interface, devstring); + ret =dfu_write_by_name (fit_image_name, update_addr, + update_size, interface, + devstring);if (ret)return ret; }
drivers/dfu/Kconfig +5 -0
@@ -14,8 +14,13 @@ config DFU_OVER_TFTP depends on NET if DFU +config DFU_ALT + bool + default n + config DFU_TFTP bool "DFU via TFTP" + select DFU_ALT select DFU_OVER_TFTP help This option allows performing update of DFU-managed medium with data
drivers/dfu/Makefile +1 -1
@@ -9,5 +9,5 @@ obj-$(CONFIG_$(SPL_)DFU_MTD) += dfu_mtd.o obj-$(CONFIG_$(SPL_)DFU_NAND) += dfu_nand.o obj-$(CONFIG_$(SPL_)DFU_RAM) += dfu_ram.o obj-$(CONFIG_$(SPL_)DFU_SF) += dfu_sf.o -obj-$(CONFIG_$(SPL_)DFU_TFTP) += dfu_tftp.o +obj-$(CONFIG_$(SPL_)DFU_ALT) += dfu_alt.o obj-$(CONFIG_$(SPL_)DFU_VIRT) += dfu_virt.o
drivers/dfu/dfu_alt.c renamed from drivers/dfu/dfu_tftp.c +15 -2
@@ -10,8 +10,21 @@#include <errno.h> #include <dfu.h> -int dfu_tftp_write (char *dfu_entity_name,unsigned int addr,unsigned int len, -char *interface,char *devstring) +/** +* dfu_write_by_name() - write data to DFU medium +* @dfu_entity_name: Name of DFU entity to write +* @addr: Address of data buffer to write +* @len: Number of bytes +* @interface: Destination DFU medium (e.g. "mmc") +* @devstring: Instance number of destination DFU medium (e.g. "1") +* +* This function is storing data received on DFU supported medium which +* is specified by @dfu_entity_name. +* +* Return: 0 - on success, error code - otherwise +*/ +int dfu_write_by_name (char *dfu_entity_name,unsigned int addr, +unsigned int len,char *interface,char *devstring) {char *s, *sb;int alt_setting_num, ret;
include/dfu.h +16 -16
@@ -494,27 +494,27 @@ static inline int dfu_fill_entity_virt(struct dfu_entity *dfu, char *devstr,#endif /** -* dfu_tftp_write() - write TFTP data to DFU medium +* dfu_write_by_name() - write data to DFU medium +* @dfu_entity_name: Name of DFU entity to write +* @addr: Address of data buffer to write +* @len: Number of bytes +* @interface: Destination DFU medium (e.g. "mmc") +* @devstring: Instance number of destination DFU medium (e.g. "1") * -* This function is storing data received via TFTP on DFU supported medium. +* This function is storing data received on DFU supported medium which +* is specified by @dfu_entity_name. * -* @dfu_entity_name: name of DFU entity to write -* @addr: address of data buffer to write -* @len: number of bytes -* @interface: destination DFU medium (e.g. "mmc") -* @devstring: instance number of destination DFU medium (e.g. "1") -* -* Return: 0 on success, otherwise error code +* Return: 0 - on success, error code - otherwise */ -#if CONFIG_IS_ENABLED (DFU_TFTP ) -int dfu_tftp_write (char *dfu_entity_name,unsigned int addr,unsigned int len, -char *interface,char *devstring); +#if CONFIG_IS_ENABLED (DFU_ALT ) +int dfu_write_by_name (char *dfu_entity_name,unsigned int addr, +unsigned int len,char *interface,char *devstring);#else -static inline int dfu_tftp_write (char *dfu_entity_name,unsigned int addr, -unsigned int len,char *interface, -char *devstring) +static inline int dfu_write_by_name (char *dfu_entity_name,unsigned int addr, +unsigned int len,char *interface, +char *devstring) { -puts ("TFTP write support for DFU not available!\n" ); +puts ("write support for DFU not available!\n" );return -ENOSYS ; }#endif
Signature · 1 line
2.27.0
PATCH v5 2/17 dfu: modify an argument type for an address
In reply to AKASHI TakahiroThe range of an addressable pointer can go beyond 'integer'. So change the argument type to a void pointer.
--- common/update.c | 3 ++- drivers/dfu/dfu_alt.c | 6 +++--- include/dfu.h | 4 ++-- 3 files changed, 7 insertions(+), 6 deletions(-)
common/update.c +2 -1
@@ -181,7 +181,8 @@ got_update_file: }if (fit_image_check_type (fit, noffset,IH_TYPE_FIRMWARE )) { - ret =dfu_write_by_name (fit_image_name, update_addr, + ret =dfu_write_by_name (fit_image_name, + (void *)update_addr, update_size, interface, devstring);if (ret)
drivers/dfu/dfu_alt.c +3 -3
@@ -23,14 +23,14 @@* * Return: 0 - on success, error code - otherwise */ -int dfu_write_by_name (char *dfu_entity_name,unsigned int addr, +int dfu_write_by_name (char *dfu_entity_name,void *addr,unsigned int len,char *interface,char *devstring) {char *s, *sb;int alt_setting_num, ret;struct dfu_entity *dfu; -debug ("%s: name: %s addr: 0x%x len: %d device: %s:%s\n" , __func__, +debug ("%s: name: %s addr: 0x%p len: %d device: %s:%s\n" , __func__, dfu_entity_name, addr, len, interface, devstring); ret =dfu_init_env_entities (interface, devstring);
@@ -69,7 +69,7 @@ int dfu_write_by_name(char *dfu_entity_name, unsigned int addr, goto done; } - ret =dfu_write_from_mem_addr (dfu, (void *)(uintptr_t )addr, len); + ret =dfu_write_from_mem_addr (dfu, (void *)addr, len); done:dfu_free_entities ();
include/dfu.h +2 -2
@@ -507,10 +507,10 @@ static inline int dfu_fill_entity_virt(struct dfu_entity *dfu, char *devstr,* Return: 0 - on success, error code - otherwise */ #if CONFIG_IS_ENABLED (DFU_ALT ) -int dfu_write_by_name (char *dfu_entity_name,unsigned int addr, +int dfu_write_by_name (char *dfu_entity_name,void *addr,unsigned int len,char *interface,char *devstring);#else -static inline int dfu_write_by_name (char *dfu_entity_name,unsigned int addr, +static inline int dfu_write_by_name (char *dfu_entity_name,void *addr,unsigned int len,char *interface,char *devstring) {
Signature · 1 line
2.27.0
PATCH v5 3/17 common: update: add a generic interface for FIT image
In reply to AKASHI TakahiroThe main purpose of this patch is to separate a generic interface for updating firmware using DFU drivers from "auto-update" via tftp.
This function will also be used in implementing UEFI capsule update in a later commit.
--- common/Kconfig | 14 +++++++++ common/Makefile | 3 +- common/update.c | 71 +++++++++++++++++++++++++++++++++++++++++++++ drivers/dfu/Kconfig | 1 + include/image.h | 12 ++++++++ 5 files changed, 99 insertions(+), 2 deletions(-)
common/Kconfig +14 -0
@@ -1014,6 +1014,20 @@ endmenu menu "Update support" +config UPDATE_COMMON + bool + default n + select DFU_ALT + +config UPDATE_FIT + bool "Firmware update using fitImage" + depends on FIT + depends on DFU + select UPDATE_COMMON + help + This option allows performing update of DFU-capable storage with + data in fitImage. + config ANDROID_AB bool "Android A/B updates" default n
common/Makefile +1 -2
@@ -53,8 +53,7 @@ obj-$(CONFIG_LCD_ROTATION) += lcd_console_rotation.o obj-$(CONFIG_LCD_DT_SIMPLEFB) += lcd_simplefb.o obj-$(CONFIG_LYNXKDI) += lynxkdi.o obj-$(CONFIG_MENU) += menu.o -obj-$(CONFIG_UPDATE_TFTP) += update.o -obj-$(CONFIG_DFU_TFTP) += update.o +obj-$(CONFIG_UPDATE_COMMON) += update.o obj-$(CONFIG_USB_KEYBOARD) += usb_kbd.o obj-$(CONFIG_CMDLINE) += cli_readline.o cli_simple.o
common/update.c +71 -0
92 lines not on this page · raw message
drivers/dfu/Kconfig +1 -0
@@ -22,6 +22,7 @@ config DFU_TFTP bool "DFU via TFTP" select DFU_ALT select DFU_OVER_TFTP + select UPDATE_COMMON help This option allows performing update of DFU-managed medium with data sent via TFTP boot.
include/image.h +12 -0
@@ -1592,4 +1592,16 @@ struct fit_loadable_tbl { .handler = _handler, \ } +/** +* fit_update - update storage with FIT image +* @fit: Pointer to FIT image +* +* Update firmware on storage using FIT image as input. +* The storage area to be update will be identified by the name +* in FIT and matching it to "dfu_alt_info" variable. +* +* Return: 0 on success, non-zero otherwise +*/ +int fit_update (const void *fit); +#endif /* __IMAGE_H__ */
Signature · 1 line
2.27.0
PATCH v5 4/17 dfu: export dfu_list
In reply to AKASHI TakahiroThis variable will be utilized to enumerate all dfu entities for UEFI capsule firmware update in a later commit.
--- drivers/dfu/dfu.c | 2 +- include/dfu.h | 3 +++ 2 files changed, 4 insertions(+), 1 deletion(-)
drivers/dfu/dfu.c +1 -1
@@ -18,7 +18,7 @@#include <linux/list.h> #include <linux/compiler.h> -static LIST_HEAD (dfu_list); +LIST_HEAD (dfu_list);static int dfu_alt_num;static int alt_num_cnt;static struct hash_algo *dfu_hash_algo;
include/dfu.h +3 -0
@@ -158,6 +158,9 @@ struct dfu_entity { unsigned int inited:1; }; +struct list_head ; +extern struct list_head dfu_list; +#ifdef CONFIG_SET_DFU_ALT_INFO /** * set_dfu_alt_info() - set dfu_alt_info environment variable
Signature · 1 line
2.27.0
PATCH v5 5/17 efi_loader: add option to initialise EFI subsystem early
In reply to AKASHI TakahiroIf this option, CONFIG_EFI_SETUP_EARLY, is enabled, the initialisation of UEFI subsystem will be done as part of U-Boot initialisation.
Please note that this option won't be enabled explicitly by users, instead, should be enabled implicitly by other configuration options.
Specifically, this feature will be utilised in implementing capsule-on-disk feature.
--- common/board_r.c | 6 ++++++ lib/efi_loader/Kconfig | 4 ++++ 2 files changed, 10 insertions(+)
common/board_r.c +6 -0
@@ -68,6 +68,9 @@#if defined(CONFIG_GPIO_HOG )#include <asm/gpio.h> #endif +#ifdef CONFIG_EFI_SETUP_EARLY +#include <efi_loader.h> +#endif DECLARE_GLOBAL_DATA_PTR ;
@@ -844,6 +847,9 @@ static init_fnc_t init_sequence_r[] = {#endif #if defined(CONFIG_M68K ) && defined(CONFIG_BLOCK_CACHE ) blkcache_init, +#endif +#ifdef CONFIG_EFI_SETUP_EARLY + (init_fnc_t )efi_init_obj_list, #endif run_main_loop, };
lib/efi_loader/Kconfig +4 -0
@@ -27,6 +27,10 @@ config EFI_LOADER if EFI_LOADER +config EFI_SETUP_EARLY + bool + default n + choice prompt "Store for non-volatile UEFI variables" default EFI_VARIABLE_FILE_STORE
Signature · 1 line
2.27.0
PATCH v5 6/17 efi_loader: add efi_create_indexed_name()
In reply to AKASHI TakahiroThis function will be used from several places in UEFI subsystem to generate some specific form of utf-16 variable name. For example, L"Capsule0001"
--- include/efi_loader.h | 3 +++ lib/efi_loader/efi_setup.c | 30 ++++++++++++++++++++++++++++++ 2 files changed, 33 insertions(+)
include/efi_loader.h +3 -0
@@ -795,6 +795,9 @@ bool efi_image_parse(void *efi, size_t len, struct efi_image_regions **regp,/* runtime implementation of memcpy() */ void efi_memcpy_runtime (void *dest,const void *src,size_t n); +/* commonly used helper function */ +u16 *efi_create_indexed_name (u16 *buffer,const u16 *name,unsigned int index); +#else /* CONFIG_IS_ENABLED(EFI_LOADER) */ /* Without CONFIG_EFI_LOADER we don't have a runtime section, stub it out */
lib/efi_loader/efi_setup.c +30 -0
@@ -6,6 +6,7 @@*/ #include <common.h> +#include <charset.h> #include <bootm.h> #include <efi_loader.h> #include <efi_variable.h>
@@ -230,3 +231,32 @@ out: efi_obj_list_initialized = ret;return ret; } + +/** +* efi_create_indexed_name - create a string name with an index +* @buffer: Buffer +* @name: Name string +* @index: Index +* +* Create a utf-16 string with @name, appending @index. +* For example, L"Capsule0001" +* This function is expected to be called only from several places +* in EFI subsystem. A caller should ensure that the buffer have +* enough space for a resulting string, including L"\0". +* No strict check against the length will be done here. +* +* Return: A pointer to the next position after the created string +* in @buffer, or NULL otherwise +*/ +u16 *efi_create_indexed_name (u16 *buffer,const u16 *name,unsigned int index) +{ +u16 *p; +char index_buf[5 ]; + +u16_strcpy (buffer, name); + p = buffer +utf16_strnlen (name,SIZE_MAX ); +sprintf (index_buf,"%04X" , index); +utf8_utf16_strcpy (&p, index_buf); + +return p; +}
Signature · 1 line
2.27.0
PATCH v5 7/17 efi_loader: define UpdateCapsule api
In reply to AKASHI TakahiroIn this commit, skeleton functions for capsule-related API's are added under CONFIG_EFI_UPDATE_CAPSULE configuration. Detailed implementation for a specific capsule type will be added in the succeeding patches.
--- include/efi_api.h | 12 +++ include/efi_loader.h | 13 +++ lib/efi_loader/Kconfig | 11 +++ lib/efi_loader/Makefile | 1 + lib/efi_loader/efi_capsule.c | 165 +++++++++++++++++++++++++++++++++++ lib/efi_loader/efi_runtime.c | 104 ++++++++++++---------- lib/efi_loader/efi_setup.c | 64 +++++++++++--- 7 files changed, 316 insertions(+), 54 deletions(-) create mode 100644 lib/efi_loader/efi_capsule.c
include/efi_api.h +12 -0
@@ -217,6 +217,10 @@ enum efi_reset_type {#define CAPSULE_FLAGS_POPULATE_SYSTEM_TABLE 0x00020000#define CAPSULE_FLAGS_INITIATE_RESET 0x00040000 +#define EFI_CAPSULE_REPORT_GUID \ + EFI_GUID(0x39b68c46, 0xf7fb, 0x441b, 0xb6, 0xec, \ + 0x16, 0xb0, 0xf6, 0x98, 0x21, 0xf3) +struct efi_capsule_header {efi_guid_t capsule_guid;u32 header_size;
@@ -224,6 +228,14 @@ struct efi_capsule_header {u32 capsule_image_size; } __packed; +struct efi_capsule_result_variable_header { +u32 variable_total_size; +u32 reserved; +efi_guid_t capsule_guid; +struct efi_time capsule_processed; +efi_status_t capsule_status; +} __packed; +#define EFI_RT_SUPPORTED_GET_TIME 0x0001#define EFI_RT_SUPPORTED_SET_TIME 0x0002#define EFI_RT_SUPPORTED_GET_WAKEUP_TIME 0x0004
include/efi_loader.h +13 -0
@@ -208,6 +208,8 @@ extern const efi_guid_t efi_guid_cert_type_pkcs7;/* GUID of RNG protocol */ extern const efi_guid_t efi_guid_rng_protocol; +/* GUID of capsule update result */ +extern const efi_guid_t efi_guid_capsule_report;extern unsigned int __efi_runtime_start, __efi_runtime_stop;extern unsigned int __efi_runtime_rel_start, __efi_runtime_rel_stop;
@@ -798,6 +800,17 @@ void efi_memcpy_runtime(void *dest, const void *src, size_t n);/* commonly used helper function */ u16 *efi_create_indexed_name (u16 *buffer,const u16 *name,unsigned int index); +/* Capsule update */ +efi_status_t EFIAPI efi_update_capsule( +struct efi_capsule_header **capsule_header_array, +efi_uintn_t capsule_count, +u64 scatter_gather_list); +efi_status_t EFIAPI efi_query_capsule_caps( +struct efi_capsule_header **capsule_header_array, +efi_uintn_t capsule_count, +u64 *maximum_capsule_size, +u32 *reset_type); +#else /* CONFIG_IS_ENABLED(EFI_LOADER) */ /* Without CONFIG_EFI_LOADER we don't have a runtime section, stub it out */
lib/efi_loader/Kconfig +11 -0
@@ -93,6 +93,17 @@ config EFI_SET_TIME Provide the SetTime() runtime service at boottime. This service can be used by an EFI application to adjust the real time clock. +config EFI_HAVE_CAPSULE_SUPPORT + bool + +config EFI_RUNTIME_UPDATE_CAPSULE + bool "UpdateCapsule() runtime service" + default n + select EFI_HAVE_CAPSULE_SUPPORT + help + Select this option if you want to use UpdateCapsule and + QueryCapsuleCapabilities API's. + config EFI_DEVICE_PATH_TO_TEXT bool "Device path to text protocol" default y
lib/efi_loader/Makefile +1 -0
@@ -23,6 +23,7 @@ endif obj-$(CONFIG_CMD_BOOTEFI_HELLO) += helloworld_efi.o obj-y += efi_bootmgr.o obj-y += efi_boottime.o +obj-$(CONFIG_EFI_HAVE_CAPSULE_SUPPORT) += efi_capsule.o obj-y += efi_console.o obj-y += efi_device_path.o obj-$(CONFIG_EFI_DEVICE_PATH_TO_TEXT) += efi_device_path_to_text.o
lib/efi_loader/efi_capsule.c new file +165 -0
165 lines not on this page · raw message
lib/efi_loader/efi_runtime.c +60 -44
135 lines not on this page · raw message
lib/efi_loader/efi_setup.c +54 -10
95 lines not on this page · raw message
Signature · 1 line
2.27.0
PATCH v5 8/17 efi_loader: capsule: add capsule_on_disk support
In reply to AKASHI TakahiroCapsule data can be loaded into the system either via UpdateCapsule runtime service or files on a file system (of boot device). The latter case is called "capsules on disk", and actual updates will take place at the next boot time.
In this commit, we will support capsule on disk mechanism.
Please note that U-Boot itself has no notion of "boot device" and all the capsule files to be executed will be detected only if they are located in a specific directory, \EFI\UpdateCapsule, on a device that is identified as a boot device by "BootXXXX" variables.
--- common/main.c | 4 + include/efi_loader.h | 9 + lib/efi_loader/Kconfig | 22 ++ lib/efi_loader/efi_capsule.c | 498 +++++++++++++++++++++++++++++++++++ lib/efi_loader/efi_setup.c | 8 + 5 files changed, 541 insertions(+)
common/main.c +4 -0
@@ -16,6 +16,7 @@#include <init.h> #include <net.h> #include <version.h> +#include <efi_loader.h> static void run_preboot_environment_command (void ) {
@@ -50,6 +51,9 @@ void main_loop(void)if (IS_ENABLED (CONFIG_USE_PREBOOT ))run_preboot_environment_command (); +if (IS_ENABLED (CONFIG_EFI_CAPSULE_ON_DISK_EARLY )) +efi_launch_capsules (); + s =bootdelay_process ();if (cli_process_fdt (&s))cli_secure_boot_cmd (s);
include/efi_loader.h +9 -0
@@ -811,6 +811,11 @@ efi_status_t EFIAPI efi_query_capsule_caps( u64 *maximum_capsule_size, u32 *reset_type); +#define EFI_CAPSULE_DIR L"\\EFI\\UpdateCapsule\\" + +/* Hook at initialization */ +efi_status_t efi_launch_capsules (void ); +#else /* CONFIG_IS_ENABLED(EFI_LOADER) */ /* Without CONFIG_EFI_LOADER we don't have a runtime section, stub it out */
@@ -827,6 +832,10 @@ static inline void efi_set_bootdev(const char *dev, const char *devnr, const char *path) { }static inline void efi_net_set_dhcp_ack (void *pkt,int len) { }static inline void efi_print_image_infos (void *pc) { } +static inline efi_status_t efi_launch_capsules (void ) +{ +return EFI_SUCCESS ; +}#endif /* CONFIG_IS_ENABLED(EFI_LOADER) */
lib/efi_loader/Kconfig +22 -0
@@ -104,6 +104,28 @@ config EFI_RUNTIME_UPDATE_CAPSULE Select this option if you want to use UpdateCapsule and QueryCapsuleCapabilities API's. +config EFI_CAPSULE_ON_DISK + bool "Enable capsule-on-disk support" + select EFI_HAVE_CAPSULE_SUPPORT + default n + help + Select this option if you want to use capsule-on-disk feature, + that is, capsules can be fetched and executed from files + under a specific directory on UEFI system partition instead of + via UpdateCapsule API. + +config EFI_CAPSULE_ON_DISK_EARLY + bool "Initiate capsule-on-disk at U-Boot boottime" + depends on EFI_CAPSULE_ON_DISK + default y + select EFI_SETUP_EARLY + help + Normally, without this option enabled, capsules will be + executed only at the first time of invoking one of efi command. + If this option is enabled, capsules will be enforced to be + executed as part of U-Boot initialisation so that they will + surely take place whatever is set to distro_bootcmd. + config EFI_DEVICE_PATH_TO_TEXT bool "Device path to text protocol" default y
lib/efi_loader/efi_capsule.c +498 -0
511 lines not on this page · raw message
lib/efi_loader/efi_setup.c +8 -0
@@ -156,6 +156,10 @@ static efi_status_t efi_init_os_indications(void) os_indications_supported |=EFI_OS_INDICATIONS_CAPSULE_RESULT_VAR_SUPPORTED ; +if (IS_ENABLED (CONFIG_EFI_CAPSULE_ON_DISK )) + os_indications_supported |= +EFI_OS_INDICATIONS_FILE_CAPSULE_DELIVERY_SUPPORTED ; + return efi_set_variable_int(L"OsIndicationsSupported", &efi_global_variable_guid, EFI_VARIABLE_BOOTSERVICE_ACCESS |
@@ -271,6 +275,10 @@ efi_status_t efi_init_obj_list(void)if (ret !=EFI_SUCCESS ) goto out; +/* Execute capsules after reboot */ +if (IS_ENABLED (CONFIG_EFI_CAPSULE_ON_DISK ) && + !IS_ENABLED (CONFIG_EFI_CAPSULE_ON_DISK_EARLY )) + ret =efi_launch_capsules (); out: efi_obj_list_initialized = ret;return ret;
Signature · 1 line
2.27.0
PATCH v5 9/17 efi_loader: capsule: add memory range capsule definitions
In reply to AKASHI TakahiroMemory range capsule gives us a way to notify that some memory regions should be left untouched across the next reset.
See UEFI specification, section 8.5.3.
Since how we should handle this kind of capsule is totally up to the system, no implementation will be added in this commit.
--- include/efi_api.h | 17 +++++++++++++++++ 1 file changed, 17 insertions(+)
include/efi_api.h +17 -0
@@ -221,6 +221,10 @@ enum efi_reset_type {EFI_GUID (0x39b68c46 ,0xf7fb ,0x441b ,0xb6 ,0xec , \ 0x16, 0xb0, 0xf6, 0x98, 0x21, 0xf3) +#define EFI_MEMORY_RANGE_CAPSULE_GUID \ + EFI_GUID(0xde9f0ec, 0x88b6, 0x428f, 0x97, 0x7a, \ + 0x25, 0x8f, 0x1d, 0xe, 0x5e, 0x72) +struct efi_capsule_header {efi_guid_t capsule_guid;u32 header_size;
@@ -236,6 +240,19 @@ struct efi_capsule_result_variable_header {efi_status_t capsule_status; } __packed; +struct efi_memory_range { +efi_physical_addr_t address; +u64 length; +}; + +struct efi_memory_range_capsule { +struct efi_capsule_header *header; +/* EFI_MEMORY_TYPE: 0x80000000-0xFFFFFFFF */ +enum efi_mem_type os_requested_memory_type; +u64 number_of_memory_ranges; +struct efi_memory_range memory_ranges[]; +} __packed; +#define EFI_RT_SUPPORTED_GET_TIME 0x0001#define EFI_RT_SUPPORTED_SET_TIME 0x0002#define EFI_RT_SUPPORTED_GET_WAKEUP_TIME 0x0004
Signature · 1 line
2.27.0
PATCH v5 10/17 efi_loader: capsule: support firmware update
In reply to AKASHI TakahiroA capsule tagged with the guid, EFI_FIRMWARE_MANAGEMENT_CAPSULE_ID_GUID, is handled as a firmware update object.
What efi_update_capsule() basically does is to load any firmware management protocol (or fmp) drivers contained in a capsule, find out an appropriate fmp driver and then invoke its set_image() interface against each binary in a capsule.
In this commit, however, loading drivers is not supported.
The result of applying a capsule is set to be stored in "CapsuleXXXX" variable, but its implementation is deferred to a fmp driver.
--- include/efi_api.h | 123 +++++++++++++++++++ include/efi_loader.h | 2 + lib/efi_loader/Kconfig | 8 ++ lib/efi_loader/efi_capsule.c | 231 ++++++++++++++++++++++++++++++++++- lib/efi_loader/efi_setup.c | 4 + 5 files changed, 367 insertions(+), 1 deletion(-)
include/efi_api.h +123 -0
@@ -225,6 +225,10 @@ enum efi_reset_type {EFI_GUID (0xde9f0ec ,0x88b6 ,0x428f ,0x97 ,0x7a , \ 0x25, 0x8f, 0x1d, 0xe, 0x5e, 0x72) +#define EFI_FIRMWARE_MANAGEMENT_CAPSULE_ID_GUID \ + EFI_GUID(0x6dcbd5ed, 0xe82d, 0x4c44, 0xbd, 0xa1, \ + 0x71, 0x94, 0x19, 0x9a, 0xd9, 0x2a) +struct efi_capsule_header {efi_guid_t capsule_guid;u32 header_size;
@@ -253,6 +257,32 @@ struct efi_memory_range_capsule {struct efi_memory_range memory_ranges[]; } __packed; +struct efi_firmware_management_capsule_header { +u32 version; +u16 embedded_driver_count; +u16 payload_item_count; +u64 item_offset_list[]; +} __packed; + +struct efi_firmware_management_capsule_image_header { +u32 version; +efi_guid_t update_image_type_id; +u8 update_image_index; +u8 reserved[3 ]; +u32 update_image_size; +u32 update_vendor_code_size; +u64 update_hardware_instance; +} __packed; + +struct efi_capsule_result_variable_fmp { +u16 version; +u8 payload_index; +u8 update_image_index; +efi_guid_t update_image_type_id; +// u16 capsule_file_name[]; +// u16 capsule_target[]; +} __packed; +#define EFI_RT_SUPPORTED_GET_TIME 0x0001#define EFI_RT_SUPPORTED_SET_TIME 0x0002#define EFI_RT_SUPPORTED_GET_WAKEUP_TIME 0x0004
@@ -1808,4 +1838,97 @@ struct efi_signature_list {/* struct efi_signature_data signatures[...][signature_size]; */ } __attribute__((__packed__)); +/* +* Firmware management protocol +*/ +#define EFI_FIRMWARE_MANAGEMENT_PROTOCOL_GUID \ + EFI_GUID(0x86c77a67, 0x0b97, 0x4633, 0xa1, 0x87, \ + 0x49, 0x10, 0x4d, 0x06, 0x85, 0xc7) + +#define EFI_IMAGE_ATTRIBUTE_IMAGE_UPDATABLE 0x1 +#define EFI_IMAGE_ATTRIBUTE_RESET_REQUIRED 0x2 +#define EFI_IMAGE_ATTRIBUTE_AUTHENTICATION_REQUIRED 0x4 +#define EFI_IMAGE_ATTRIBUTE_IN_USE 0x8 +#define EFI_IMAGE_ATTRIBUTE_UEFI_IMAGE 0x10 + +#define EFI_IMAGE_COMPATIBILITY_CHECK_SUPPORTED 0x1 +#define EFI_FIRMWARE_IMAGE_DESCRIPTOR_VERSION 4 + +#define EFI_IMAGE_UPDATABLE_VALID 0x1 +#define EFI_IMAGE_UPDATABLE_INVALID 0x2 +#define EFI_IMAGE_UPDATABLE_INVALID_TYPE 0x4 +#define EFI_IMAGE_UPDATABLE_INVALID_OLLD 0x8 +#define EFI_IMAGE_UPDATABLE_VALID_WITH_VENDOR_CODE 0x10 + +#define EFI_PACKAGE_ATTRIBUTE_VERSION_UPDATABLE 0x1 +#define EFI_PACKAGE_ATTRIBUTE_RESET_REQUIRED 0x2 +#define EFI_PACKAGE_ATTRIBUTE_AUTHENTICATION_REQUIRED 0x4 + +typedef struct efi_firmware_image_dependencies { +u8 dependencies[0 ]; +}efi_fmp_dep_t ; + +struct efi_firmware_image_descriptor { +u8 image_index; +efi_guid_t image_type_id; +u64 image_id; +u16 *image_id_name; +u32 version; +u16 *version_name; +efi_uintn_t size; +u64 attributes_supported; +u64 attributes_setting; +u64 compatibilities; +u32 lowest_supported_image_version; +u32 last_attempt_version; +u32 last_attempt_status; +u64 hardware_instance; +efi_fmp_dep_t *dependencies; +}; + +struct efi_firmware_management_protocol { + efi_status_t (EFIAPI *get_image_info)( + struct efi_firmware_management_protocol *this, + efi_uintn_t *image_info_size, + struct efi_firmware_image_descriptor *image_info, + u32 *descriptor_version, + u8 *descriptor_count, + efi_uintn_t *descriptor_size, + u32 *package_version, + u16 **package_version_name); + efi_status_t (EFIAPI *get_image)( + struct efi_firmware_management_protocol *this, + u8 image_index, + void *image, + efi_uintn_t *image_size); + efi_status_t (EFIAPI *set_image)( + struct efi_firmware_management_protocol *this, + u8 image_index, + const void *image, + efi_uintn_t image_size, + const void *vendor_code, + efi_status_t (*progress)(efi_uintn_t completion), + u16 **abort_reason); + efi_status_t (EFIAPI *check_image)( + struct efi_firmware_management_protocol *this, + u8 image_index, + const void *image, + efi_uintn_t *image_size, + u32 *image_updatable); + efi_status_t (EFIAPI *get_package_info)( + struct efi_firmware_management_protocol *this, + u32 *package_version, + u16 **package_version_name, + u32 *package_version_name_maxlen, + u64 *attributes_supported, + u64 *attributes_setting); + efi_status_t (EFIAPI *set_package_info)( + struct efi_firmware_management_protocol *this, + const void *image, + efi_uintn_t *image_size, + const void *vendor_code, + u32 package_version, + const u16 *package_version_name); +}; +#endif
include/efi_loader.h +2 -0
@@ -210,6 +210,8 @@ extern const efi_guid_t efi_guid_cert_type_pkcs7;extern const efi_guid_t efi_guid_rng_protocol;/* GUID of capsule update result */ extern const efi_guid_t efi_guid_capsule_report; +/* GUID of firmware management protocol */ +extern const efi_guid_t efi_guid_firmware_management_protocol;extern unsigned int __efi_runtime_start, __efi_runtime_stop;extern unsigned int __efi_runtime_rel_start, __efi_runtime_rel_stop;
lib/efi_loader/Kconfig +8 -0
@@ -126,6 +126,14 @@ config EFI_CAPSULE_ON_DISK_EARLY executed as part of U-Boot initialisation so that they will surely take place whatever is set to distro_bootcmd. +config EFI_CAPSULE_FIRMWARE_MANAGEMENT + bool "Capsule: Firmware Management Protocol" + depends on EFI_HAVE_CAPSULE_SUPPORT + default y + help + Select this option if you want to enable capsule-based + firmware update using Firmware Management Protocol. + config EFI_DEVICE_PATH_TO_TEXT bool "Device path to text protocol" default y
lib/efi_loader/efi_capsule.c +230 -1
251 lines not on this page · raw message
lib/efi_loader/efi_setup.c +4 -0
@@ -160,6 +160,10 @@ static efi_status_t efi_init_os_indications(void) os_indications_supported |=EFI_OS_INDICATIONS_FILE_CAPSULE_DELIVERY_SUPPORTED ; +if (IS_ENABLED (CONFIG_EFI_CAPSULE_FIRMWARE_MANAGEMENT )) + os_indications_supported |= +EFI_OS_INDICATIONS_FMP_CAPSULE_SUPPORTED ; + return efi_set_variable_int(L"OsIndicationsSupported", &efi_global_variable_guid, EFI_VARIABLE_BOOTSERVICE_ACCESS |
Signature · 1 line
2.27.0
PATCH v5 11/17 efi_loader: add firmware management protocol for FIT image
In reply to AKASHI TakahiroIn this commit, a very simple firmware management protocol driver is implemented. It will take a common FIT image firmware in a capsule file and apply the data using dfu backend storage drivers via update_fit() interface.
So "dfu_alt_info" variable should be properly set to specify a device and location to be updated. Please read README.dfu.
Fit image is a common file format for firmware update on U-Boot, and this protocol works neatly just as a wrapper for one.
--- include/efi_api.h | 4 + include/efi_loader.h | 2 + lib/efi_loader/Kconfig | 11 ++ lib/efi_loader/Makefile | 1 + lib/efi_loader/efi_capsule.c | 12 +- lib/efi_loader/efi_firmware.c | 291 ++++++++++++++++++++++++++++++++++ 6 files changed, 320 insertions(+), 1 deletion(-) create mode 100644 lib/efi_loader/efi_firmware.c
include/efi_api.h +4 -0
@@ -1845,6 +1845,10 @@ struct efi_signature_list {EFI_GUID (0x86c77a67 ,0x0b97 ,0x4633 ,0xa1 ,0x87 , \ 0x49, 0x10, 0x4d, 0x06, 0x85, 0xc7) +#define EFI_FIRMWARE_IMAGE_TYPE_UBOOT_FIT_GUID \ + EFI_GUID(0xae13ff2d, 0x9ad4, 0x4e25, 0x9a, 0xc8, \ + 0x6d, 0x80, 0xb3, 0xb2, 0x21, 0x47) +#define EFI_IMAGE_ATTRIBUTE_IMAGE_UPDATABLE 0x1#define EFI_IMAGE_ATTRIBUTE_RESET_REQUIRED 0x2#define EFI_IMAGE_ATTRIBUTE_AUTHENTICATION_REQUIRED 0x4
include/efi_loader.h +2 -0
@@ -802,6 +802,8 @@ void efi_memcpy_runtime(void *dest, const void *src, size_t n);/* commonly used helper function */ u16 *efi_create_indexed_name (u16 *buffer,const u16 *name,unsigned int index); +extern const struct efi_firmware_management_protocol efi_fmp_fit; +/* Capsule update */ efi_status_t EFIAPI efi_update_capsule( struct efi_capsule_header **capsule_header_array,
lib/efi_loader/Kconfig +11 -0
@@ -134,6 +134,17 @@ config EFI_CAPSULE_FIRMWARE_MANAGEMENT Select this option if you want to enable capsule-based firmware update using Firmware Management Protocol. +config EFI_CAPSULE_FIRMWARE_FIT + bool "FMP driver for FIT image" + depends on EFI_CAPSULE_FIRMWARE_MANAGEMENT + depends on FIT + select UPDATE_FIT + select DFU + default n + help + Select this option if you want to enable firmware management protocol + driver for FIT image + config EFI_DEVICE_PATH_TO_TEXT bool "Device path to text protocol" default y
lib/efi_loader/Makefile +1 -0
@@ -24,6 +24,7 @@ obj-$(CONFIG_CMD_BOOTEFI_HELLO) += helloworld_efi.o obj-y += efi_bootmgr.o obj-y += efi_boottime.o obj-$(CONFIG_EFI_HAVE_CAPSULE_SUPPORT) += efi_capsule.o +obj-$(CONFIG_EFI_CAPSULE_FIRMWARE_FIT) += efi_firmware.o obj-y += efi_console.o obj-y += efi_device_path.o obj-$(CONFIG_EFI_DEVICE_PATH_TO_TEXT) += efi_device_path_to_text.o
lib/efi_loader/efi_capsule.c +11 -1
@@ -797,7 +797,17 @@ static void efi_capsule_scan_done(void)*/ efi_status_t __weak arch_efi_load_capsule_drivers (void ) { -return EFI_SUCCESS ; +__maybe_unused efi_handle_t handle; +efi_status_t ret =EFI_SUCCESS ; + +if (IS_ENABLED (CONFIG_EFI_CAPSULE_FIRMWARE_FIT )) { + handle =NULL ; + ret =EFI_CALL (efi_install_multiple_protocol_interfaces ( + &handle, &efi_guid_firmware_management_protocol, + &efi_fmp_fit,NULL )); + } + +return ret; }/**
lib/efi_loader/efi_firmware.c new file +291 -0
291 lines not on this page · raw message
Signature · 1 line
2.27.0
PATCH v5 12/17 dfu: add dfu_write_by_alt()
In reply to AKASHI TakahiroThis function is a variant of dfu_write_by_name() and takes a DFU alt setting number for dfu configuration.
It will be utilised to implement UEFI capsule management protocol for raw image in a later commit.
--- drivers/dfu/dfu_alt.c | 47 +++++++++++++++++++++++++++++++++++++++++++ include/dfu.h | 26 +++++++++++++++++++++++- 2 files changed, 72 insertions(+), 1 deletion(-)
drivers/dfu/dfu_alt.c +47 -0
@@ -76,3 +76,50 @@ done:return ret; } + +/** +* dfu_write_by_alt() - write data to DFU medium +* @dfu_alt_num: DFU alt setting number +* @addr: Address of data buffer to write +* @len: Number of bytes +* @interface: Destination DFU medium (e.g. "mmc") +* @devstring: Instance number of destination DFU medium (e.g. "1") +* +* This function is storing data received on DFU supported medium which +* is specified by @dfu_alt_name. +* +* Return: 0 - on success, error code - otherwise +*/ +int dfu_write_by_alt (int dfu_alt_num,void *addr,unsigned int len, +char *interface,char *devstring) +{ +struct dfu_entity *dfu; +int ret; + +debug ("%s: alt: %d addr: 0x%p len: %d device: %s:%s\n" , __func__, + dfu_alt_num, addr, len, interface, devstring); + + ret =dfu_init_env_entities (interface, devstring); +if (ret) + goto done; + +if (dfu_alt_num <0 ) { +pr_err ("Invalid alt number: %d" , dfu_alt_num); + ret = -ENODEV ; + goto done; + } + + dfu =dfu_get_entity (dfu_alt_num); +if (!dfu) { +pr_err ("DFU entity for alt: %d not found!" , dfu_alt_num); + ret = -ENODEV ; + goto done; + } + + ret =dfu_write_from_mem_addr (dfu, (void *)(uintptr_t )addr, len); + +done: +dfu_free_entities (); + +return ret; +}
include/dfu.h +25 -1
@@ -496,6 +496,7 @@ static inline int dfu_fill_entity_virt(struct dfu_entity *dfu, char *devstr, }#endif +#if CONFIG_IS_ENABLED (DFU_ALT )/** * dfu_write_by_name() - write data to DFU medium * @dfu_entity_name: Name of DFU entity to write
@@ -509,9 +510,24 @@ static inline int dfu_fill_entity_virt(struct dfu_entity *dfu, char *devstr,* * Return: 0 - on success, error code - otherwise */ -#if CONFIG_IS_ENABLED (DFU_ALT )int dfu_write_by_name (char *dfu_entity_name,void *addr,unsigned int len,char *interface,char *devstring); + +/** +* dfu_write_by_alt() - write data to DFU medium +* @dfu_alt_num: DFU alt setting number +* @addr: Address of data buffer to write +* @len: Number of bytes +* @interface: Destination DFU medium (e.g. "mmc") +* @devstring: Instance number of destination DFU medium (e.g. "1") +* +* This function is storing data received on DFU supported medium which +* is specified by @dfu_alt_name. +* +* Return: 0 - on success, error code - otherwise +*/ +int dfu_write_by_alt (int dfu_alt_num,void *addr,unsigned int len, +char *interface,char *devstring);#else static inline int dfu_write_by_name(char *dfu_entity_name, void *addr, unsigned int len, char *interface,
@@ -520,6 +536,14 @@ static inline int dfu_write_by_name(char *dfu_entity_name, void *addr,puts ("write support for DFU not available!\n" ); return -ENOSYS; } + +static inline int dfu_write_by_alt (int dfu_alt_num,void *addr, +unsigned int len,char *interface, +char *devstring) +{ +puts ("write support for DFU not available!\n" ); +return -ENOSYS ; +}#endif int dfu_add (struct usb_configuration *c);
Signature · 1 line
2.27.0
PATCH v5 13/17 efi_loader: add firmware management protocol for raw image
In reply to AKASHI TakahiroIn this commit, a very simple firmware management protocol driver is implemented. It will take a binary image in a capsule file and apply the data using dfu backend storage drivers via dfu_write_by_alt() interface.
So "dfu_alt_info" variable should be properly set to specify a device and location to be updated. Please read README.dfu.
--- include/efi_api.h | 4 + include/efi_loader.h | 1 + lib/efi_loader/Kconfig | 16 +++ lib/efi_loader/Makefile | 2 +- lib/efi_loader/efi_capsule.c | 8 ++ lib/efi_loader/efi_firmware.c | 221 +++++++++++++++++++++++++--------- 6 files changed, 194 insertions(+), 58 deletions(-)
include/efi_api.h +4 -0
@@ -1849,6 +1849,10 @@ struct efi_signature_list {EFI_GUID (0xae13ff2d ,0x9ad4 ,0x4e25 ,0x9a ,0xc8 , \ 0x6d, 0x80, 0xb3, 0xb2, 0x21, 0x47) +#define EFI_FIRMWARE_IMAGE_TYPE_UBOOT_RAW_GUID \ + EFI_GUID(0xe2bb9c06, 0x70e9, 0x4b14, 0x97, 0xa3, \ + 0x5a, 0x79, 0x13, 0x17, 0x6e, 0x3f) +#define EFI_IMAGE_ATTRIBUTE_IMAGE_UPDATABLE 0x1#define EFI_IMAGE_ATTRIBUTE_RESET_REQUIRED 0x2#define EFI_IMAGE_ATTRIBUTE_AUTHENTICATION_REQUIRED 0x4
include/efi_loader.h +1 -0
@@ -803,6 +803,7 @@ void efi_memcpy_runtime(void *dest, const void *src, size_t n);u16 *efi_create_indexed_name (u16 *buffer,const u16 *name,unsigned int index);extern const struct efi_firmware_management_protocol efi_fmp_fit; +extern const struct efi_firmware_management_protocol efi_fmp_raw;/* Capsule update */ efi_status_t EFIAPI efi_update_capsule(
lib/efi_loader/Kconfig +16 -0
@@ -126,6 +126,10 @@ config EFI_CAPSULE_ON_DISK_EARLY executed as part of U-Boot initialisation so that they will surely take place whatever is set to distro_bootcmd. +config EFI_CAPSULE_FIRMWARE + bool + default n + config EFI_CAPSULE_FIRMWARE_MANAGEMENT bool "Capsule: Firmware Management Protocol" depends on EFI_HAVE_CAPSULE_SUPPORT
@@ -140,11 +144,23 @@ config EFI_CAPSULE_FIRMWARE_FIT depends on FIT select UPDATE_FIT select DFU + select EFI_CAPSULE_FIRMWARE default n help Select this option if you want to enable firmware management protocol driver for FIT image +config EFI_CAPSULE_FIRMWARE_RAW + bool "FMP driver for raw image" + depends on EFI_CAPSULE_FIRMWARE_MANAGEMENT + select DFU + select DFU_ALT + select EFI_CAPSULE_FIRMWARE + default n + help + Select this option if you want to enable firmware management protocol + driver for raw image + config EFI_DEVICE_PATH_TO_TEXT bool "Device path to text protocol" default y
lib/efi_loader/Makefile +1 -1
@@ -24,7 +24,7 @@ obj-$(CONFIG_CMD_BOOTEFI_HELLO) += helloworld_efi.o obj-y += efi_bootmgr.o obj-y += efi_boottime.o obj-$(CONFIG_EFI_HAVE_CAPSULE_SUPPORT) += efi_capsule.o -obj-$(CONFIG_EFI_CAPSULE_FIRMWARE_FIT) += efi_firmware.o +obj-$(CONFIG_EFI_CAPSULE_FIRMWARE) += efi_firmware.o obj-y += efi_console.o obj-y += efi_device_path.o obj-$(CONFIG_EFI_DEVICE_PATH_TO_TEXT) += efi_device_path_to_text.o
lib/efi_loader/efi_capsule.c +8 -0
@@ -807,6 +807,14 @@ efi_status_t __weak arch_efi_load_capsule_drivers(void) &efi_fmp_fit, NULL)); } +if (IS_ENABLED (CONFIG_EFI_CAPSULE_FIRMWARE_RAW )) { + handle =NULL ; + ret =EFI_CALL (efi_install_multiple_protocol_interfaces ( + &efi_root, + &efi_guid_firmware_management_protocol, + &efi_fmp_raw,NULL )); + } +return ret; }
lib/efi_loader/efi_firmware.c +164 -57
264 lines not on this page · raw message
Signature · 1 line
2.27.0
PATCH v5 14/17 cmd: add "efidebug capsule" command
In reply to AKASHI Takahiro"efidebug capsule" is more or less a debugging utility.
efidebug capsule update: invoke UpdateCapsule against data on memory efidebug capsule show: show a capsule header
efidebug capsule result: dump a capsule result variable
--- cmd/efidebug.c | 235 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 235 insertions(+)
cmd/efidebug.c +235 -0
@@ -18,6 +18,228 @@#include <linux/ctype.h> #define BS systab.boottime +#define RT systab.runtime + +#ifdef CONFIG_EFI_HAVE_CAPSULE_SUPPORT +/** +* do_efi_capsule_update() - process a capsule update +* +* @cmdtp: Command table +* @flag: Command flag +* @argc: Number of arguments +* @argv: Argument array +* Return: CMD_RET_SUCCESS on success, CMD_RET_RET_FAILURE on failure +* +* Implement efidebug "capsule update" sub-command. +* process a capsule update. +* +* efidebug capsule update [-v] <capsule address> +*/ +static int do_efi_capsule_update (struct cmd_tbl *cmdtp,int flag, +int argc,char *const argv[]) +{ +struct efi_capsule_header *capsule; +int verbose =0 ; +char *endp; +efi_status_t ret; + +if (argc !=2 && argc !=3 ) +return CMD_RET_USAGE ; + +if (argc ==3 ) { +if (strcmp (argv[1 ],"-v" )) +return CMD_RET_USAGE ; + + verbose =1 ; + argc--; + argv++; + } + + capsule = (typeof (capsule ))simple_strtoul (argv[1 ], &endp,16 ); +if (endp == argv[1 ]) { +printf ("Invalid address: %s" , argv[1 ]); +return CMD_RET_FAILURE ; + } + +if (verbose) { +printf ("Capsule guid: %pUl\n" , &capsule->capsule_guid); +printf ("Capsule flags: 0x%x\n" , capsule->flags); +printf ("Capsule header size: 0x%x\n" , capsule->header_size); +printf ("Capsule image size: 0x%x\n" , + capsule->capsule_image_size); + } + + ret =EFI_CALL (RT ->update_capsule (&capsule,1 , (u64 )NULL )); +if (ret) { +printf ("Cannot handle a capsule at %p" , capsule); +return CMD_RET_FAILURE ; + } + +return CMD_RET_SUCCESS ; +} + +/** +* do_efi_capsule_show() - show capsule information +* +* @cmdtp: Command table +* @flag: Command flag +* @argc: Number of arguments +* @argv: Argument array +* Return: CMD_RET_SUCCESS on success, CMD_RET_RET_FAILURE on failure +* +* Implement efidebug "capsule show" sub-command. +* show capsule information. +* +* efidebug capsule show <capsule address> +*/ +static int do_efi_capsule_show (struct cmd_tbl *cmdtp,int flag, +int argc,char *const argv[]) +{ +struct efi_capsule_header *capsule; +char *endp; + +if (argc !=2 ) +return CMD_RET_USAGE ; + + capsule = (typeof (capsule ))simple_strtoul (argv[1 ], &endp,16 ); +if (endp == argv[1 ]) { +printf ("Invalid address: %s" , argv[1 ]); +return CMD_RET_FAILURE ; + } + +printf ("Capsule guid: %pUl\n" , &capsule->capsule_guid); +printf ("Capsule flags: 0x%x\n" , capsule->flags); +printf ("Capsule header size: 0x%x\n" , capsule->header_size); +printf ("Capsule image size: 0x%x\n" , + capsule->capsule_image_size); + +return CMD_RET_SUCCESS ; +} + +/** +* do_efi_capsule_res() - show a capsule update result +* +* @cmdtp: Command table +* @flag: Command flag +* @argc: Number of arguments +* @argv: Argument array +* Return: CMD_RET_SUCCESS on success, CMD_RET_RET_FAILURE on failure +* +* Implement efidebug "capsule result" sub-command. +* show a capsule update result. +* If result number is not specified, CapsuleLast will be shown. +* +* efidebug capsule result [<capsule result number>] +*/ +static int do_efi_capsule_res (struct cmd_tbl *cmdtp,int flag, +int argc,char *const argv[]) +{ +int capsule_id; +char *endp; +char var_name[12 ]; +u16 var_name16[12 ], *p; +efi_guid_t guid; +struct efi_capsule_result_variable_header *result =NULL ; +efi_uintn_t size; +efi_status_t ret; + +if (argc !=1 && argc !=2 ) +return CMD_RET_USAGE ; + + guid = efi_guid_capsule_report; +if (argc ==1 ) { + size =sizeof (var_name16); + ret =EFI_CALL (RT ->get_variable (L"CapsuleLast" , &guid,NULL , + &size, var_name16)); +if (ret !=EFI_SUCCESS ) { +if (ret ==EFI_NOT_FOUND ) +printf ("CapsuleLast doesn't exist\n" ); +else +printf ("Failed to get CapsuleLast\n" ); + +return CMD_RET_FAILURE ; + } +printf ("CapsuleLast is %ls\n" , var_name16); + }else { + argc--; + argv++; + + capsule_id =simple_strtoul (argv[0 ], &endp,16 ); +if (capsule_id <0 || capsule_id >0xffff ) +return CMD_RET_USAGE ; + +sprintf (var_name,"Capsule%04X" , capsule_id); + p = var_name16; +utf8_utf16_strncpy (&p, var_name,9 ); + } + + size =0 ; + ret =EFI_CALL (RT ->get_variable (var_name16, &guid,NULL , &size,NULL )); +if (ret ==EFI_BUFFER_TOO_SMALL ) { + result =malloc (size); + ret =EFI_CALL (RT ->get_variable (var_name16, &guid,NULL , &size, + result)); +if (ret !=EFI_SUCCESS ) { +free (result); +printf ("Failed to get %ls\n" , var_name16); + +return CMD_RET_FAILURE ; + } + } + +printf ("Result total size: 0x%x\n" , result->variable_total_size); +printf ("Capsule guid: %pUl\n" , &result->capsule_guid); +printf ("Time processed: %04d-%02d-%02d %02d:%02d:%02d\n" , + result->capsule_processed.year, result->capsule_processed.month, + result->capsule_processed.day, result->capsule_processed.hour, + result->capsule_processed.minute, + result->capsule_processed.second); +printf ("Capsule status: 0x%lx\n" , result->capsule_status); + +free (result); + +return CMD_RET_SUCCESS ; +} + +static struct cmd_tbl cmd_efidebug_capsule_sub[] = { +U_BOOT_CMD_MKENT (update,CONFIG_SYS_MAXARGS ,1 , do_efi_capsule_update, +"" ,"" ), +U_BOOT_CMD_MKENT (show,CONFIG_SYS_MAXARGS ,1 , do_efi_capsule_show, +"" ,"" ), +U_BOOT_CMD_MKENT (result,CONFIG_SYS_MAXARGS ,1 , do_efi_capsule_res, +"" ,"" ), +}; + +/** +* do_efi_capsule() - manage UEFI capsules +* +* @cmdtp: Command table +* @flag: Command flag +* @argc: Number of arguments +* @argv: Argument array +* Return: CMD_RET_SUCCESS on success, +* CMD_RET_USAGE or CMD_RET_RET_FAILURE on failure +* +* Implement efidebug "capsule" sub-command. +*/ +static int do_efi_capsule (struct cmd_tbl *cmdtp,int flag, +int argc,char *const argv[]) +{ +struct cmd_tbl *cp; + +if (argc <2 ) +return CMD_RET_USAGE ; + + argc--; argv++; + + cp =find_cmd_tbl (argv[0 ], cmd_efidebug_capsule_sub, +ARRAY_SIZE (cmd_efidebug_capsule_sub)); +if (!cp) +return CMD_RET_USAGE ; + +return cp->cmd (cmdtp, flag, argc, argv); +} +#endif /* CONFIG_EFI_HAVE_CAPSULE_SUPPORT */ /** * efi_get_device_handle_info() - get information of UEFI device
@@ -1230,6 +1452,10 @@ static int do_efi_query_info(struct cmd_tbl *cmdtp, int flag,static struct cmd_tbl cmd_efidebug_sub[] = {U_BOOT_CMD_MKENT (boot,CONFIG_SYS_MAXARGS ,1 , do_efi_boot_opt,"" ,"" ), +#ifdef CONFIG_EFI_HAVE_CAPSULE_SUPPORT +U_BOOT_CMD_MKENT (capsule,CONFIG_SYS_MAXARGS ,1 , do_efi_capsule, +"" ,"" ), +#endifU_BOOT_CMD_MKENT (devices,CONFIG_SYS_MAXARGS ,1 , do_efi_show_devices,"" ,"" ), U_BOOT_CMD_MKENT(drivers, CONFIG_SYS_MAXARGS, 1, do_efi_show_drivers,
@@ -1304,6 +1530,15 @@ static char efidebug_help_text[] = "efidebug boot order [<bootid#1> [<bootid#2> [<bootid#3> [...]]]]\n" " - set/show UEFI boot order\n" "\n" +#ifdef CONFIG_EFI_HAVE_CAPSULE_SUPPORT + "efidebug capsule update [-v] <capsule address>\n" + " - process a capsule\n" + "efidebug capsule show <capsule address>\n" + " - show capsule information\n" + "efidebug capsule result [<capsule result var>]\n" + " - show a capsule update result\n" + "\n" +#endif"efidebug devices\n" " - show UEFI devices\n" "efidebug drivers\n"
Signature · 1 line
2.27.0
PATCH v5 15/17 tools: add mkeficapsule command for UEFI capsule update
In reply to AKASHI TakahiroThis is a utility mainly for test purpose.
mkeficapsule -f: create a test capsule file for FIT image firmware
Having said that, you will be able to customize the code to fit your specific requirements for your platform.
--- tools/Makefile | 3 + tools/mkeficapsule.c | 237 +++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 240 insertions(+) create mode 100644 tools/mkeficapsule.c
tools/Makefile +3 -0
@@ -218,6 +218,9 @@ hostprogs-$(CONFIG_MIPS) += mips-relocs hostprogs-$(CONFIG_ASN1_COMPILER) += asn1_compiler HOSTCFLAGS_asn1_compiler.o = -idirafter $(srctree)/include +# TODO: only build this for capsule pytest +hostprogs-$(CONFIG_EFI_HAVE_CAPSULE_SUPPORT) += mkeficapsule + # We build some files with extra pedantic flags to try to minimize things # that won't build on some weird host compiler -- though there are lots of # exceptions for files that aren't complaint.
tools/mkeficapsule.c new file +237 -0
237 lines not on this page · raw message
Signature · 1 line
2.27.0
PATCH v5 15/17 tools: add mkeficapsule command for UEFI capsule update
Quoted 18 lines · AKASHI Takahiro
This is a utility mainly for test purpose.
mkeficapsule -f: create a test capsule file for FIT image firmwareHaving said that, you will be able to customize the code to fit your specific requirements for your platform.
Signed-off-by AKASHI Takahiro <[email protected]>--- tools/Makefile | 3 + tools/mkeficapsule.c | 237 +++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 240 insertions(+) create mode 100644 tools/mkeficapsule.ctools/Makefile +0
-0
tools/Makefile hostprogs-$(CONFIG_MIPS) += mips-relocs · line 221
Quoted 4 lines
tools/Makefile +1
-0@@ -218,6 +218,9 @@ hostprogs-$(CONFIG_MIPS) += mips-relocs hostprogs-$(CONFIG_ASN1_COMPILER) += asn1_compiler HOSTCFLAGS_asn1_compiler.o = -idirafter $(srctree)/include +# TODO: only build this for capsule pytest
Wouldn't the user need the mkeficapsule tool for developing capsules anyway? So why would you want to restrict this to testing?
Quoted 105 lines
tools/Makefile +2
-0+hostprogs-$(CONFIG_EFI_HAVE_CAPSULE_SUPPORT) += mkeficapsule + # We build some files with extra pedantic flags to try to minimize things # that won't build on some weird host compiler -- though there are lots of # exceptions for files that aren't complaint.tools/mkeficapsule.c new file +94
-0@@ -0,0 +1,237 @@ +// SPDX-License-Identifier: GPL-2.0 +/* +* Copyright 2018 Linaro Limited +* Author: AKASHI Takahiro +*/ + +#include <getopt.h> +#include <malloc.h> +#include <stdbool.h> +#include <stdio.h> +#include <stdlib.h> +#include <string.h> +#include <linux/types.h> +#include <sys/stat.h> +#include <sys/types.h> + +typedef __u8 u8 ; +typedef __u16 u16 ; +typedef __u32 u32 ; +typedef __u64 u64 ; +typedef __s16 s16 ; +typedef __s32 s32 ; + +#define aligned_u64 __aligned_u64 + +#ifndef __packed +#define __packed __attribute__((packed)) +#endif + +#include <efi.h> +#include <efi_api.h> + +static const char *tool_name ="mkeficapsule" ; + +efi_guid_t efi_guid_fm_capsule =EFI_FIRMWARE_MANAGEMENT_CAPSULE_ID_GUID ; +efi_guid_t efi_guid_image_type_uboot_fit = +EFI_FIRMWARE_IMAGE_TYPE_UBOOT_FIT_GUID ; +efi_guid_t efi_guid_image_type_uboot_raw = +EFI_FIRMWARE_IMAGE_TYPE_UBOOT_RAW_GUID ; + +static struct option options[] = { + {"fit" , required_argument,NULL ,'f' }, + {"raw" , required_argument,NULL ,'r' }, + {"index" , required_argument,NULL ,'i' }, + {"instance" , required_argument,NULL ,'I' }, + {"version" , required_argument,NULL ,'v' }, + {"help" , no_argument,NULL ,'h' }, + {NULL ,0 ,NULL ,0 }, +}; + +static void print_usage (void ) +{ +printf ("Usage: %s [options] <output file>\n" +"Options:\n" +"\t--fit <fit image> new FIT image file\n" +"\t--raw <raw image> new raw image file\n" +"\t--index <index> update image index\n" +"\t--instance <instance> update hardware instance\n" +"\t--version <version> firmware version\n" +"\t--help print a help message\n" , + tool_name); +} + +static int create_fwbin (char *path,char *bin,efi_guid_t *guid, +unsigned long version,unsigned long index, +unsigned long instance) +{ +struct efi_capsule_header header; +struct efi_firmware_management_capsule_header capsule; +struct efi_firmware_management_capsule_image_header image; +FILE *f, *g; +struct stat bin_stat; +u8 *data; +size_t size; + +#ifdef DEBUG +printf ("For output: %s\n" , path); +printf ("\tbin: %s\n\ttype: %pUl\n" bin, guid); +printf ("\tversion: %ld\n\tindex: %ld\n\tinstance: %ld\n" , + version, index, instance); +#endif + + g =fopen (bin,"r" ); +if (!g) { +printf ("cannot open %s\n" , bin); +return -1 ; + } +if (stat (bin, &bin_stat) <0 ) { +printf ("cannot determine the size of %s\n" , bin); + goto err_1; + } + data =malloc (bin_stat.st_size); +if (!data) { +printf ("cannot allocate memory: %lx\n" , bin_stat.st_size);
tools/mkeficapsule.c line 104
Quoted 10 lines
tools/mkeficapsule.c new file +10
-0+ goto err_1; + } + f =fopen (path,"w" ); +if (!f) { +printf ("cannot open %s\n" , path); + goto err_2; + } + header.capsule_guid = efi_guid_fm_capsule; + header.header_size =sizeof (header); + header.flags =CAPSULE_FLAGS_PERSIST_ACROSS_RESET ;/* TODO */
This TODO needs some description in the comment.
Best regards
Heinrich
Quoted 134 lines
tools/mkeficapsule.c new file +133
-0+ header.capsule_image_size =sizeof (header) + +sizeof (capsule) +sizeof (u64) + +sizeof (image) + + bin_stat.st_size; + + size =fwrite (&header,1 ,sizeof (header), f); +if (size <sizeof (header)) { +printf ("write failed (%lx)\n" , size); + goto err_3; + } + + capsule.version =0x00000001 ; + capsule.embedded_driver_count =0 ; + capsule.payload_item_count =1 ; + capsule.item_offset_list[0 ] =sizeof (capsule) +sizeof (u64); + size =fwrite (&capsule,1 ,sizeof (capsule) +sizeof (u64), f); +if (size < (sizeof (capsule) +sizeof (u64))) { +printf ("write failed (%lx)\n" , size); + goto err_3; + } + + image.version = version; +memcpy (&image.update_image_type_id, guid,sizeof (*guid)); + image.update_image_index = index; + image.update_image_size = bin_stat.st_size; + image.update_vendor_code_size =0 ;/* none */ + image.update_hardware_instance = instance; + + size =fwrite (&image,1 ,sizeof (image), f); +if (size <sizeof (image)) { +printf ("write failed (%lx)\n" , size); + goto err_3; + } + size =fread (data,1 , bin_stat.st_size, g); +if (size < bin_stat.st_size) { +printf ("read failed (%lx)\n" , size); + goto err_3; + } + size =fwrite (data,1 , bin_stat.st_size, f); +if (size < bin_stat.st_size) { +printf ("write failed (%lx)\n" , size); + goto err_3; + } + +fclose (f); +fclose (g); +free (data); + +return 0 ; + +err_3: +fclose (f); +err_2: +free (data); +err_1: +fclose (g); + +return -1 ; +} + +/* +* Usage: +* $ mkeficapsule -f <firmware binary> <output file> +*/ +int main (int argc,char **argv) +{ +char *file; +efi_guid_t *guid; +unsigned long index, instance, version; +int c, idx; + + file =NULL ; + guid =NULL ; + index =0 ; + instance =0 ; + version =0 ; +for (;;) { + c =getopt_long (argc, argv,"f:r:i:I:v:h" , options, &idx); +if (c ==-1 ) +break ; + +switch (c) { +case 'f' : +if (file) { +printf ("Image already specified\n" ); +return -1 ; + } + file = optarg; + guid = &efi_guid_image_type_uboot_fit; +break ; +case 'r' : +if (file) { +printf ("Image already specified\n" ); +return -1 ; + } + file = optarg; + guid = &efi_guid_image_type_uboot_raw; +break ; +case 'i' : + index =strtoul (optarg,NULL ,0 ); +break ; +case 'I' : + instance =strtoul (optarg,NULL ,0 ); +break ; +case 'v' : + version =strtoul (optarg,NULL ,0 ); +break ; +case 'h' : +print_usage (); +return 0 ; + } + } + +/* need a output file */ +if (argc != optind +1 ) { +print_usage (); +return -1 ; + } + +/* need a fit image file or raw image file */ +if (!file) { +print_usage (); +return -1 ; + } + +if (create_fwbin (argv[optind], file, guid, version, index, instance) + <0 ) { +printf ("Creating firmware capsule failed\n" ); +return -1 ; + } + +return 0 ; +}
PATCH v5 15/17 tools: add mkeficapsule command for UEFI capsule update
Quoted 22 lines · Heinrich Schuchardt
Quoted 21 lines · AKASHI Takahiro
This is a utility mainly for test purpose.
mkeficapsule -f: create a test capsule file for FIT image firmwareHaving said that, you will be able to customize the code to fit your specific requirements for your platform.
Signed-off-by AKASHI Takahiro <[email protected]>--- tools/Makefile | 3 + tools/mkeficapsule.c | 237 +++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 240 insertions(+) create mode 100644 tools/mkeficapsule.ctools/Makefile +0
-0@@ -218,6 +218,9 @@ hostprogs-$(CONFIG_MIPS) += mips-relocs hostprogs-$(CONFIG_ASN1_COMPILER) += asn1_compiler HOSTCFLAGS_asn1_compiler.o = -idirafter $(srctree)/include
Quoted 4 lines
tools/Makefile hostprogs-$(CONFIG_MIPS) += mips-relocs · line 221
Quoted 1 line
tools/Makefile +1
-0+# TODO: only build this for capsule pytestWouldn't the user need the mkeficapsule tool for developing capsules anyway? So why would you want to restrict this to testing?
Indeed.
Originally, this command was intended to be used in testing capsule update for 'variables' and had bunch of test-specific features.
I will drop this line.
Quoted 109 lines
Quoted 109 lines
tools/Makefile +2
-0+hostprogs-$(CONFIG_EFI_HAVE_CAPSULE_SUPPORT) += mkeficapsule + # We build some files with extra pedantic flags to try to minimize things # that won't build on some weird host compiler -- though there are lots of # exceptions for files that aren't complaint.tools/mkeficapsule.c new file +98
-0@@ -0,0 +1,237 @@ +// SPDX-License-Identifier: GPL-2.0 +/* +* Copyright 2018 Linaro Limited +* Author: AKASHI Takahiro +*/ + +#include <getopt.h> +#include <malloc.h> +#include <stdbool.h> +#include <stdio.h> +#include <stdlib.h> +#include <string.h> +#include <linux/types.h> +#include <sys/stat.h> +#include <sys/types.h> + +typedef __u8 u8 ; +typedef __u16 u16 ; +typedef __u32 u32 ; +typedef __u64 u64 ; +typedef __s16 s16 ; +typedef __s32 s32 ; + +#define aligned_u64 __aligned_u64 + +#ifndef __packed +#define __packed __attribute__((packed)) +#endif + +#include <efi.h> +#include <efi_api.h> + +static const char *tool_name ="mkeficapsule" ; + +efi_guid_t efi_guid_fm_capsule =EFI_FIRMWARE_MANAGEMENT_CAPSULE_ID_GUID ; +efi_guid_t efi_guid_image_type_uboot_fit = +EFI_FIRMWARE_IMAGE_TYPE_UBOOT_FIT_GUID ; +efi_guid_t efi_guid_image_type_uboot_raw = +EFI_FIRMWARE_IMAGE_TYPE_UBOOT_RAW_GUID ; + +static struct option options[] = { + {"fit" , required_argument,NULL ,'f' }, + {"raw" , required_argument,NULL ,'r' }, + {"index" , required_argument,NULL ,'i' }, + {"instance" , required_argument,NULL ,'I' }, + {"version" , required_argument,NULL ,'v' }, + {"help" , no_argument,NULL ,'h' }, + {NULL ,0 ,NULL ,0 }, +}; + +static void print_usage (void ) +{ +printf ("Usage: %s [options] <output file>\n" +"Options:\n" +"\t--fit <fit image> new FIT image file\n" +"\t--raw <raw image> new raw image file\n" +"\t--index <index> update image index\n" +"\t--instance <instance> update hardware instance\n" +"\t--version <version> firmware version\n" +"\t--help print a help message\n" , + tool_name); +} + +static int create_fwbin (char *path,char *bin,efi_guid_t *guid, +unsigned long version,unsigned long index, +unsigned long instance) +{ +struct efi_capsule_header header; +struct efi_firmware_management_capsule_header capsule; +struct efi_firmware_management_capsule_image_header image; +FILE *f, *g; +struct stat bin_stat; +u8 *data; +size_t size; + +#ifdef DEBUG +printf ("For output: %s\n" , path); +printf ("\tbin: %s\n\ttype: %pUl\n" bin, guid); +printf ("\tversion: %ld\n\tindex: %ld\n\tinstance: %ld\n" , + version, index, instance); +#endif + + g =fopen (bin,"r" ); +if (!g) { +printf ("cannot open %s\n" , bin); +return -1 ; + } +if (stat (bin, &bin_stat) <0 ) { +printf ("cannot determine the size of %s\n" , bin); + goto err_1; + } + data =malloc (bin_stat.st_size); +if (!data) { +printf ("cannot allocate memory: %lx\n" , bin_stat.st_size); + goto err_1; + } + f =fopen (path,"w" ); +if (!f) {
Quoted 8 lines
tools/mkeficapsule.c line 104
Quoted 6 lines
tools/mkeficapsule.c new file +6
-0+printf ("cannot open %s\n" , path); + goto err_2; + } + header.capsule_guid = efi_guid_fm_capsule; + header.header_size =sizeof (header); + header.flags =CAPSULE_FLAGS_PERSIST_ACROSS_RESET ;/* TODO */ This TODO needs some description in the comment.
Sure.
The intent here was that any values in flags would be ignored under the current implementation (as mentioned in TODO in the cover letter).
-Takahiro Akashi
Quoted 140 lines
Best regards
Heinrich
Quoted 134 lines
tools/mkeficapsule.c new file +133
-0+ header.capsule_image_size =sizeof (header) + +sizeof (capsule) +sizeof (u64) + +sizeof (image) + + bin_stat.st_size; + + size =fwrite (&header,1 ,sizeof (header), f); +if (size <sizeof (header)) { +printf ("write failed (%lx)\n" , size); + goto err_3; + } + + capsule.version =0x00000001 ; + capsule.embedded_driver_count =0 ; + capsule.payload_item_count =1 ; + capsule.item_offset_list[0 ] =sizeof (capsule) +sizeof (u64); + size =fwrite (&capsule,1 ,sizeof (capsule) +sizeof (u64), f); +if (size < (sizeof (capsule) +sizeof (u64))) { +printf ("write failed (%lx)\n" , size); + goto err_3; + } + + image.version = version; +memcpy (&image.update_image_type_id, guid,sizeof (*guid)); + image.update_image_index = index; + image.update_image_size = bin_stat.st_size; + image.update_vendor_code_size =0 ;/* none */ + image.update_hardware_instance = instance; + + size =fwrite (&image,1 ,sizeof (image), f); +if (size <sizeof (image)) { +printf ("write failed (%lx)\n" , size); + goto err_3; + } + size =fread (data,1 , bin_stat.st_size, g); +if (size < bin_stat.st_size) { +printf ("read failed (%lx)\n" , size); + goto err_3; + } + size =fwrite (data,1 , bin_stat.st_size, f); +if (size < bin_stat.st_size) { +printf ("write failed (%lx)\n" , size); + goto err_3; + } + +fclose (f); +fclose (g); +free (data); + +return 0 ; + +err_3: +fclose (f); +err_2: +free (data); +err_1: +fclose (g); + +return -1 ; +} + +/* +* Usage: +* $ mkeficapsule -f <firmware binary> <output file> +*/ +int main (int argc,char **argv) +{ +char *file; +efi_guid_t *guid; +unsigned long index, instance, version; +int c, idx; + + file =NULL ; + guid =NULL ; + index =0 ; + instance =0 ; + version =0 ; +for (;;) { + c =getopt_long (argc, argv,"f:r:i:I:v:h" , options, &idx); +if (c ==-1 ) +break ; + +switch (c) { +case 'f' : +if (file) { +printf ("Image already specified\n" ); +return -1 ; + } + file = optarg; + guid = &efi_guid_image_type_uboot_fit; +break ; +case 'r' : +if (file) { +printf ("Image already specified\n" ); +return -1 ; + } + file = optarg; + guid = &efi_guid_image_type_uboot_raw; +break ; +case 'i' : + index =strtoul (optarg,NULL ,0 ); +break ; +case 'I' : + instance =strtoul (optarg,NULL ,0 ); +break ; +case 'v' : + version =strtoul (optarg,NULL ,0 ); +break ; +case 'h' : +print_usage (); +return 0 ; + } + } + +/* need a output file */ +if (argc != optind +1 ) { +print_usage (); +return -1 ; + } + +/* need a fit image file or raw image file */ +if (!file) { +print_usage (); +return -1 ; + } + +if (create_fwbin (argv[optind], file, guid, version, index, instance) + <0 ) { +printf ("Creating firmware capsule failed\n" ); +return -1 ; + } + +return 0 ; +}
PATCH v5 16/17 test/py: add a test for uefi firmware update capsule of FIT image
In reply to AKASHI TakahiroThe test can run on sandbox build and it attempts to execute a firmware update via a capsule-on-disk, using a FIT image capsule, CONFIG_EFI_CAPSULE_FIT.
To run this test successfully, you need configure U-Boot specifically; See test_capsule_firmware.py for requirements, and hence it won't run on Travis CI.
--- test/py/tests/test_efi_capsule/conftest.py | 69 +++++++ test/py/tests/test_efi_capsule/defs.py | 12 ++ .../test_efi_capsule/test_capsule_firmware.py | 178 ++++++++++++++++++ .../tests/test_efi_capsule/uboot_bin_env.its | 36 ++++ 4 files changed, 295 insertions(+) create mode 100644 test/py/tests/test_efi_capsule/conftest.py create mode 100644 test/py/tests/test_efi_capsule/defs.py create mode 100644 test/py/tests/test_efi_capsule/test_capsule_firmware.py create mode 100644 test/py/tests/test_efi_capsule/uboot_bin_env.its
test/py/tests/test_efi_capsule/conftest.py new file +69 -0
@@ -0,0 +1,69 @@ +# SPDX-License-Identifier: GPL-2.0+ +# Copyright (c) 2020, Linaro Limited +# Author: AKASHI Takahiro <[email protected]> + +import os +import os.path +import re +from subprocess import call, check_call, check_output, CalledProcessError +import pytest +from defs import * + +# +# Fixture for UEFI secure boot test +# + + + at pytest.fixture(scope='session') +def efi_capsule_data(request, u_boot_config): + """Set up a file system to be used in UEFI capsule test. + + Args: + request: Pytest request object. + u_boot_config: U-boot configuration. + + Return: + A path to disk image to be used for testing + """ + mnt_point = u_boot_config.persistent_data_dir + '/test_efi_capsule' + data_dir = mnt_point + CAPSULE_DATA_DIR + install_dir = mnt_point + CAPSULE_INSTALL_DIR + image_path = u_boot_config.persistent_data_dir + '/test_efi_capsule.img' + + try: + # Create a target device + check_call('dd if=/dev/zero of=./spi.bin bs=1MiB count=16', shell=True) + + check_call('rm -rf %s' % mnt_point, shell=True) + check_call('mkdir -p %s' % data_dir, shell=True) + check_call('mkdir -p %s' % install_dir, shell=True) + + # Create capsule files + # two regions: one for u-boot.bin and the other for u-boot.env + check_call('cd %s; echo -n u-boot:Old > u-boot.bin.old; echo -n u-boot:New > u-boot.bin.new; echo -n u-boot-env:Old -> u-boot.env.old; echo -n u-boot-env:New > u-boot.env.new' % data_dir, + shell=True) + check_call('sed -e \"s?BINFILE1?u-boot.bin.new?\" -e \"s?BINFILE2?u-boot.env.new?\" %s/test/py/tests/test_efi_capsule/uboot_bin_env.its > %s/uboot_bin_env.its' % + (u_boot_config.source_dir, data_dir), + shell=True) + check_call('cd %s; %s/tools/mkimage -f uboot_bin_env.its uboot_bin_env.itb' % + (data_dir, u_boot_config.build_dir), + shell=True) + check_call('cd %s; %s/tools/mkeficapsule --fit uboot_bin_env.itb --version 1 --index 1 Test01' % + (data_dir, u_boot_config.build_dir), + shell=True) + + # Create a disk image with EFI system partition + check_call('virt-make-fs --partition=gpt --size=+1M --type=vfat %s %s' % + (mnt_point, image_path), shell=True) + check_call('sgdisk %s -A 1:set:0 -t 1:C12A7328-F81F-11D2-BA4B-00A0C93EC93B' % + image_path, shell=True) + + except CalledProcessError as exception: + pytest.skip('Setup failed: %s' % exception.cmd) + return + else: + yield image_path + finally: + call('rm -rf %s' % mnt_point, shell=True) + call('rm -f %s' % image_path, shell=True) + call('rm -f ./spi.bin', shell=True)
test/py/tests/test_efi_capsule/defs.py new file +12 -0
@@ -0,0 +1,12 @@ +# SPDX-License-Identifier: GPL-2.0+ + +# Size in MiB +EFI_BOOTDEV_IMAGE_SIZE = 16 +EFI_BOOTDEV_PART_SIZE = 8 + +# Owner guid +GUID = '11111111-2222-3333-4444-123456789abc' + +# Directories +CAPSULE_DATA_DIR = '/EFI/CapsuleTestData' +CAPSULE_INSTALL_DIR = '/EFI/UpdateCapsule'
test/py/tests/test_efi_capsule/test_capsule_firmware.py new file +178 -0
178 lines not on this page · raw message
test/py/tests/test_efi_capsule/uboot_bin_env.its new file +36 -0
@@ -0,0 +1,36 @@ +/* + * Automatic software update for U-Boot + * Make sure the flashing addresses ('load' prop) is correct for your board! + */ + +/dts-v1/; + +/ { + description = "Automatic U-Boot environment update"; + #address-cells = <2>; + + images { + u-boot-bin at 100000 { + description = "U-Boot binary on SPI Flash"; + data = /incbin/("BINFILE1"); + compression = "none"; + type = "firmware"; + arch = "sandbox"; + load = <0>; + hash-1 { + algo = "sha1"; + }; + }; + u-boot-env at 150000 { + description = "U-Boot environment on SPI Flash"; + data = /incbin/("BINFILE2"); + compression = "none"; + type = "firmware"; + arch = "sandbox"; + load = <0>; + hash-1 { + algo = "sha1"; + }; + }; + }; +};
Signature · 1 line
2.27.0
PATCH v5 16/17 test/py: add a test for uefi firmware update capsule of FIT image
Quoted 156 lines · AKASHI Takahiro
The test can run on sandbox build and it attempts to execute a firmware update via a capsule-on-disk, using a FIT image capsule,
CONFIG_EFI_CAPSULE_FIT.To run this test successfully, you need configure U-Boot specifically; See
test_capsule_firmware.pyfor requirements, and hence it won't run on Travis CI.Signed-off-by AKASHI Takahiro <[email protected]>--- test/py/tests/test_efi_capsule/conftest.py | 69 +++++++ test/py/tests/test_efi_capsule/defs.py | 12 ++ .../test_efi_capsule/test_capsule_firmware.py | 178 ++++++++++++++++++ .../tests/test_efi_capsule/uboot_bin_env.its | 36 ++++ 4 files changed, 295 insertions(+) create mode 100644 test/py/tests/test_efi_capsule/conftest.py create mode 100644 test/py/tests/test_efi_capsule/defs.py create mode 100644 test/py/tests/test_efi_capsule/test_capsule_firmware.py create mode 100644 test/py/tests/test_efi_capsule/uboot_bin_env.itstest/py/tests/test_efi_capsule/conftest.py new file +69
-0@@ -0,0 +1,69 @@ +# SPDX-License-Identifier: GPL-2.0+ +# Copyright (c) 2020, Linaro Limited +# Author: AKASHI Takahiro <[email protected]> + +import os +import os.path +import re +from subprocess import call, check_call, check_output, CalledProcessError +import pytest +from defs import * + +# +# Fixture for UEFI secure boot test +# + + + at pytest.fixture(scope='session') +def efi_capsule_data(request, u_boot_config): + """Set up a file system to be used in UEFI capsule test. + + Args: + request: Pytest request object. + u_boot_config: U-boot configuration. + + Return: + A path to disk image to be used for testing + """ + mnt_point = u_boot_config.persistent_data_dir + '/test_efi_capsule' + data_dir = mnt_point + CAPSULE_DATA_DIR + install_dir = mnt_point + CAPSULE_INSTALL_DIR + image_path = u_boot_config.persistent_data_dir + '/test_efi_capsule.img' + + try: + # Create a target device + check_call('dd if=/dev/zero of=./spi.bin bs=1MiB count=16', shell=True) + + check_call('rm -rf %s' % mnt_point, shell=True) + check_call('mkdir -p %s' % data_dir, shell=True) + check_call('mkdir -p %s' % install_dir, shell=True) + + # Create capsule files + # two regions: one for u-boot.bin and the other for u-boot.env + check_call('cd %s; echo -n u-boot:Old > u-boot.bin.old; echo -n u-boot:New > u-boot.bin.new; echo -n u-boot-env:Old -> u-boot.env.old; echo -n u-boot-env:New > u-boot.env.new' % data_dir, + shell=True) + check_call('sed -e \"s?BINFILE1?u-boot.bin.new?\" -e \"s?BINFILE2?u-boot.env.new?\" %s/test/py/tests/test_efi_capsule/uboot_bin_env.its > %s/uboot_bin_env.its' % + (u_boot_config.source_dir, data_dir), + shell=True) + check_call('cd %s; %s/tools/mkimage -f uboot_bin_env.its uboot_bin_env.itb' % + (data_dir, u_boot_config.build_dir), + shell=True) + check_call('cd %s; %s/tools/mkeficapsule --fit uboot_bin_env.itb --version 1 --index 1 Test01' % + (data_dir, u_boot_config.build_dir), + shell=True) + + # Create a disk image with EFI system partition + check_call('virt-make-fs --partition=gpt --size=+1M --type=vfat %s %s' % + (mnt_point, image_path), shell=True) + check_call('sgdisk %s -A 1:set:0 -t 1:C12A7328-F81F-11D2-BA4B-00A0C93EC93B' % + image_path, shell=True) + + except CalledProcessError as exception: + pytest.skip('Setup failed: %s' % exception.cmd) + return + else: + yield image_path + finally: + call('rm -rf %s' % mnt_point, shell=True) + call('rm -f %s' % image_path, shell=True) + call('rm -f ./spi.bin', shell=True)test/py/tests/test_efi_capsule/defs.py new file +12
-0@@ -0,0 +1,12 @@ +# SPDX-License-Identifier: GPL-2.0+ + +# Size in MiB +EFI_BOOTDEV_IMAGE_SIZE = 16 +EFI_BOOTDEV_PART_SIZE = 8 + +# Owner guid +GUID = '11111111-2222-3333-4444-123456789abc' + +# Directories +CAPSULE_DATA_DIR = '/EFI/CapsuleTestData' +CAPSULE_INSTALL_DIR = '/EFI/UpdateCapsule'test/py/tests/test_efi_capsule/test_capsule_firmware.py new file +37
-0@@ -0,0 +1,178 @@ +# SPDX-License-Identifier: GPL-2.0+ +# Copyright (c) 2020, Linaro Limited +# Author: AKASHI Takahiro <[email protected]> +# +# U-Boot UEFI: Firmware Update Test + +""" +This test verifies capsule-on-disk firmware update +""" + +from subprocess import check_call, check_output, CalledProcessError +import pytest +from defs import * + + + at pytest.mark.boardspec('sandbox') + at pytest.mark.buildconfigspec('efi_capsule_firmware_fit') + at pytest.mark.buildconfigspec('efi_capsule_on_disk') + at pytest.mark.buildconfigspec('dfu') + at pytest.mark.buildconfigspec('dfu_sf') + at pytest.mark.buildconfigspec('cmd_efidebug') + at pytest.mark.buildconfigspec('cmd_fat') + at pytest.mark.buildconfigspec('cmd_memory') + at pytest.mark.buildconfigspec('cmd_nvedit_efi') + at pytest.mark.buildconfigspec('cmd_sf') + at pytest.mark.slow +class TestEfiCapsuleFirmwareFit(object): + def test_efi_capsule_fw1( + self, u_boot_config, u_boot_console, efi_capsule_data): + """ + Test Case 1 - Update U-Boot and U-Boot environment on SPI Flash + but with OsIndications unset + No update should happen + 0x100000-0x150000: U-Boot binary (but dummy) + 0x150000-0x200000: U-Boot environment (but dummy) + """ + # "-T" (or "-D") is required to enable spi flash on sandbox
test/py/tests/test_efi_capsule/test_capsule_firmware.py line 47
Quoted 10 lines
test/py/tests/test_efi_capsule/test_capsule_firmware.py new file +10
-0+ u_boot_console.restart_uboot_with_flags('-T') + + disk_img = efi_capsule_data + with u_boot_console.log.section('Test Case 1-a, before reboot'): + output = u_boot_console.run_command_list([ + 'host bind 0 %s' % disk_img, + 'efidebug boot add 1 TEST host 0:1 /helloworld.efi ""', + 'efidebug boot order 1', + 'env set -e OsIndications', + 'env set dfu_alt_info sf 0:0=u-boot-bin raw 0x100000 0x50000\;u-boot-env raw 0x150000 0x200000',
This results in a warning:
DeprecationWarning: invalid escape sequence \;
The test is never executed on Gitlab:
https://gitlab.denx.de/u-boot/custodians/u-boot-efi/-/jobs/144884test/py/tests/test_efi_capsule/test_capsule_firmware.py sss
Quoted 65 lines
test/py/tests/test_efi_capsule/test_capsule_firmware.py new file +65
-0+ 'env save']) + + # initialize contents + output = u_boot_console.run_command_list([ + 'sf probe 0:0', + 'fatload host 0:1 4000000 %s/u-boot.bin.old' % CAPSULE_DATA_DIR, + 'sf write 4000000 100000 10', + 'sf read 5000000 100000 10', + 'md.b 5000000 10']) + assert 'Old' in ''.join(output) + output = u_boot_console.run_command_list([ + 'sf probe 0:0', + 'fatload host 0:1 4000000 %s/u-boot.env.old' % CAPSULE_DATA_DIR, + 'sf write 4000000 150000 10', + 'sf read 5000000 150000 10', + 'md.b 5000000 10']) + assert 'Old' in ''.join(output) + + # place a capsule file + output = u_boot_console.run_command_list([ + 'fatload host 0:1 4000000 %s/Test01' % CAPSULE_DATA_DIR, + 'fatwrite host 0:1 4000000 %s/Test01 $filesize' % CAPSULE_INSTALL_DIR, + 'fatls host 0:1 %s' % CAPSULE_INSTALL_DIR]) + assert 'Test01' in ''.join(output) + + # reboot + u_boot_console.restart_uboot_with_flags('-T') + + capsule_early = u_boot_config.buildconfig.get( + 'config_efi_capsule_on_disk_early') + with u_boot_console.log.section('Test Case 1-b, after reboot'): + if not capsule_early: + output = u_boot_console.run_command_list([ + 'host bind 0 %s' % disk_img, + 'fatls host 0:1 %s' % CAPSULE_INSTALL_DIR]) + assert 'Test01' in ''.join(output) + + # need to run uefi command to initiate capsule handling + output = u_boot_console.run_command( + 'env print -e -all Capsule0000') + + output = u_boot_console.run_command_list([ + 'host bind 0 %s' % disk_img, + 'fatls host 0:1 %s' % CAPSULE_INSTALL_DIR]) + assert 'Test01' in ''.join(output) + + output = u_boot_console.run_command_list([ + 'sf probe 0:0', + 'sf read 4000000 100000 10', + 'md.b 4000000 10']) + assert 'u-boot:Old' in ''.join(output) + + output = u_boot_console.run_command_list([ + 'sf read 4000000 150000 10', + 'md.b 4000000 10']) + assert 'u-boot-env:Old' in ''.join(output) + + def test_efi_capsule_fw2( + self, u_boot_config, u_boot_console, efi_capsule_data): + """ + Test Case 2 - Update U-Boot and U-Boot environment on SPI Flash + 0x100000-0x150000: U-Boot binary (but dummy) + 0x150000-0x200000: U-Boot environment (but dummy) + """ + # "-T" (or "-D") is required to enable spi flash on sandbox
test/py/tests/test_efi_capsule/test_capsule_firmware.py line 122
Quoted 10 lines
test/py/tests/test_efi_capsule/test_capsule_firmware.py new file +10
-0+ u_boot_console.restart_uboot_with_flags('-T') + + disk_img = efi_capsule_data + with u_boot_console.log.section('Test Case 2-a, before reboot'): + output = u_boot_console.run_command_list([ + 'host bind 0 %s' % disk_img, + 'efidebug boot add 1 TEST host 0:1 /helloworld.efi ""', + 'efidebug boot order 1', + 'env set -e -nv -bs -rt OsIndications =0x0000000000000004', + 'env set dfu_alt_info sf 0:0=u-boot-bin raw 0x100000 0x50000\;u-boot-env raw 0x150000 0x200000',
Invalid escape sequence \;
Best regards
Heinrich
Quoted 99 lines
test/py/tests/test_efi_capsule/test_capsule_firmware.py new file +56
-0+ 'env save']) + + # initialize contents + output = u_boot_console.run_command_list([ + 'sf probe 0:0', + 'fatload host 0:1 4000000 %s/u-boot.bin.old' % CAPSULE_DATA_DIR, + 'sf write 4000000 100000 10', + 'sf read 5000000 100000 10', + 'md.b 5000000 10']) + assert 'Old' in ''.join(output) + output = u_boot_console.run_command_list([ + 'sf probe 0:0', + 'fatload host 0:1 4000000 %s/u-boot.env.old' % CAPSULE_DATA_DIR, + 'sf write 4000000 150000 10', + 'sf read 5000000 150000 10', + 'md.b 5000000 10']) + assert 'Old' in ''.join(output) + + # place a capsule file + output = u_boot_console.run_command_list([ + 'fatload host 0:1 4000000 %s/Test01' % CAPSULE_DATA_DIR, + 'fatwrite host 0:1 4000000 %s/Test01 $filesize' % CAPSULE_INSTALL_DIR, + 'fatls host 0:1 %s' % CAPSULE_INSTALL_DIR]) + assert 'Test01' in ''.join(output) + + # reboot + u_boot_console.restart_uboot_with_flags('-T') + + capsule_early = u_boot_config.buildconfig.get( + 'config_efi_capsule_on_disk_early') + with u_boot_console.log.section('Test Case 2-b, after reboot'): + if not capsule_early: + output = u_boot_console.run_command_list([ + 'host bind 0 %s' % disk_img, + 'fatls host 0:1 %s' % CAPSULE_INSTALL_DIR]) + assert 'Test01' in ''.join(output) + + # need to run uefi command to initiate capsule handling + output = u_boot_console.run_command( + 'env print -e -all Capsule0000') + + output = u_boot_console.run_command_list([ + 'host bind 0 %s' % disk_img, + 'fatls host 0:1 %s' % CAPSULE_INSTALL_DIR]) + assert 'Test01' not in ''.join(output) + + output = u_boot_console.run_command_list([ + 'sf probe 0:0', + 'sf read 4000000 100000 10', + 'md.b 4000000 10']) + assert 'u-boot:New' in ''.join(output) + + output = u_boot_console.run_command_list([ + 'sf read 4000000 150000 10', + 'md.b 4000000 10']) + assert 'u-boot-env:New' in ''.join(output)test/py/tests/test_efi_capsule/uboot_bin_env.its new file +36
-0@@ -0,0 +1,36 @@ +/* + * Automatic software update for U-Boot + * Make sure the flashing addresses ('load' prop) is correct for your board! + */ + +/dts-v1/; + +/ { + description = "Automatic U-Boot environment update"; + #address-cells = <2>; + + images { + u-boot-bin at 100000 { + description = "U-Boot binary on SPI Flash"; + data = /incbin/("BINFILE1"); + compression = "none"; + type = "firmware"; + arch = "sandbox"; + load = <0>; + hash-1 { + algo = "sha1"; + }; + }; + u-boot-env at 150000 { + description = "U-Boot environment on SPI Flash"; + data = /incbin/("BINFILE2"); + compression = "none"; + type = "firmware"; + arch = "sandbox"; + load = <0>; + hash-1 { + algo = "sha1"; + }; + }; + }; +};
PATCH v5 16/17 test/py: add a test for uefi firmware update capsule of FIT image
Heinrich,
Quoted 170 lines · Heinrich Schuchardt
Quoted 156 lines · AKASHI Takahiro
The test can run on sandbox build and it attempts to execute a firmware update via a capsule-on-disk, using a FIT image capsule,
CONFIG_EFI_CAPSULE_FIT.To run this test successfully, you need configure U-Boot specifically; See
test_capsule_firmware.pyfor requirements, and hence it won't run on Travis CI.Signed-off-by AKASHI Takahiro <[email protected]>--- test/py/tests/test_efi_capsule/conftest.py | 69 +++++++ test/py/tests/test_efi_capsule/defs.py | 12 ++ .../test_efi_capsule/test_capsule_firmware.py | 178 ++++++++++++++++++ .../tests/test_efi_capsule/uboot_bin_env.its | 36 ++++ 4 files changed, 295 insertions(+) create mode 100644 test/py/tests/test_efi_capsule/conftest.py create mode 100644 test/py/tests/test_efi_capsule/defs.py create mode 100644 test/py/tests/test_efi_capsule/test_capsule_firmware.py create mode 100644 test/py/tests/test_efi_capsule/uboot_bin_env.itstest/py/tests/test_efi_capsule/conftest.py new file +69
-0@@ -0,0 +1,69 @@ +# SPDX-License-Identifier: GPL-2.0+ +# Copyright (c) 2020, Linaro Limited +# Author: AKASHI Takahiro <[email protected]> + +import os +import os.path +import re +from subprocess import call, check_call, check_output, CalledProcessError +import pytest +from defs import * + +# +# Fixture for UEFI secure boot test +# + + + at pytest.fixture(scope='session') +def efi_capsule_data(request, u_boot_config): + """Set up a file system to be used in UEFI capsule test. + + Args: + request: Pytest request object. + u_boot_config: U-boot configuration. + + Return: + A path to disk image to be used for testing + """ + mnt_point = u_boot_config.persistent_data_dir + '/test_efi_capsule' + data_dir = mnt_point + CAPSULE_DATA_DIR + install_dir = mnt_point + CAPSULE_INSTALL_DIR + image_path = u_boot_config.persistent_data_dir + '/test_efi_capsule.img' + + try: + # Create a target device + check_call('dd if=/dev/zero of=./spi.bin bs=1MiB count=16', shell=True) + + check_call('rm -rf %s' % mnt_point, shell=True) + check_call('mkdir -p %s' % data_dir, shell=True) + check_call('mkdir -p %s' % install_dir, shell=True) + + # Create capsule files + # two regions: one for u-boot.bin and the other for u-boot.env + check_call('cd %s; echo -n u-boot:Old > u-boot.bin.old; echo -n u-boot:New > u-boot.bin.new; echo -n u-boot-env:Old -> u-boot.env.old; echo -n u-boot-env:New > u-boot.env.new' % data_dir, + shell=True) + check_call('sed -e \"s?BINFILE1?u-boot.bin.new?\" -e \"s?BINFILE2?u-boot.env.new?\" %s/test/py/tests/test_efi_capsule/uboot_bin_env.its > %s/uboot_bin_env.its' % + (u_boot_config.source_dir, data_dir), + shell=True) + check_call('cd %s; %s/tools/mkimage -f uboot_bin_env.its uboot_bin_env.itb' % + (data_dir, u_boot_config.build_dir), + shell=True) + check_call('cd %s; %s/tools/mkeficapsule --fit uboot_bin_env.itb --version 1 --index 1 Test01' % + (data_dir, u_boot_config.build_dir), + shell=True) + + # Create a disk image with EFI system partition + check_call('virt-make-fs --partition=gpt --size=+1M --type=vfat %s %s' % + (mnt_point, image_path), shell=True) + check_call('sgdisk %s -A 1:set:0 -t 1:C12A7328-F81F-11D2-BA4B-00A0C93EC93B' % + image_path, shell=True) + + except CalledProcessError as exception: + pytest.skip('Setup failed: %s' % exception.cmd) + return + else: + yield image_path + finally: + call('rm -rf %s' % mnt_point, shell=True) + call('rm -f %s' % image_path, shell=True) + call('rm -f ./spi.bin', shell=True)test/py/tests/test_efi_capsule/defs.py new file +12
-0@@ -0,0 +1,12 @@ +# SPDX-License-Identifier: GPL-2.0+ + +# Size in MiB +EFI_BOOTDEV_IMAGE_SIZE = 16 +EFI_BOOTDEV_PART_SIZE = 8 + +# Owner guid +GUID = '11111111-2222-3333-4444-123456789abc' + +# Directories +CAPSULE_DATA_DIR = '/EFI/CapsuleTestData' +CAPSULE_INSTALL_DIR = '/EFI/UpdateCapsule'test/py/tests/test_efi_capsule/test_capsule_firmware.py new file +37
-0@@ -0,0 +1,178 @@ +# SPDX-License-Identifier: GPL-2.0+ +# Copyright (c) 2020, Linaro Limited +# Author: AKASHI Takahiro <[email protected]> +# +# U-Boot UEFI: Firmware Update Test + +""" +This test verifies capsule-on-disk firmware update +""" + +from subprocess import check_call, check_output, CalledProcessError +import pytest +from defs import * + + + at pytest.mark.boardspec('sandbox') + at pytest.mark.buildconfigspec('efi_capsule_firmware_fit') + at pytest.mark.buildconfigspec('efi_capsule_on_disk') + at pytest.mark.buildconfigspec('dfu') + at pytest.mark.buildconfigspec('dfu_sf') + at pytest.mark.buildconfigspec('cmd_efidebug') + at pytest.mark.buildconfigspec('cmd_fat') + at pytest.mark.buildconfigspec('cmd_memory') + at pytest.mark.buildconfigspec('cmd_nvedit_efi') + at pytest.mark.buildconfigspec('cmd_sf') + at pytest.mark.slow +class TestEfiCapsuleFirmwareFit(object): + def test_efi_capsule_fw1( + self, u_boot_config, u_boot_console, efi_capsule_data): + """ + Test Case 1 - Update U-Boot and U-Boot environment on SPI Flash + but with OsIndications unset + No update should happen + 0x100000-0x150000: U-Boot binary (but dummy) + 0x150000-0x200000: U-Boot environment (but dummy) + """ + # "-T" (or "-D") is required to enable spi flash on sandboxtest/py/tests/test_efi_capsule/test_capsule_firmware.py line 47
Quoted 10 lines
test/py/tests/test_efi_capsule/test_capsule_firmware.py new file +10
-0+ u_boot_console.restart_uboot_with_flags('-T') + + disk_img = efi_capsule_data + with u_boot_console.log.section('Test Case 1-a, before reboot'): + output = u_boot_console.run_command_list([ + 'host bind 0 %s' % disk_img, + 'efidebug boot add 1 TEST host 0:1 /helloworld.efi ""', + 'efidebug boot order 1', + 'env set -e OsIndications', + 'env set dfu_alt_info sf 0:0=u-boot-bin raw 0x100000 0x50000\;u-boot-env raw 0x150000 0x200000',This results in a warning:
Quoted 1 line
DeprecationWarning: invalid escape sequence \;
I don't think that such a warning eventually prevent running tests, but will fix them anyway in the next version.
Quoted 4 lines
The test is never executed on Gitlab:
https://gitlab.denx.de/u-boot/custodians/u-boot-efi/-/jobs/144884
test/py/tests/test_efi_capsule/test_capsule_firmware.pysss
This is because, as I mentioned briefly in the cover letter, some specific configurations, i.e. CONFIG_DFU and CONFIG_DFU_SF, are mandatory to run tests successfully.
I'm not sure whether we should add them to sandbox*_defconfig just for this purpose.
# We have another issue on virt-make-fs.
## Same comment on patch#17.
-Takahiro Akashi
Quoted 184 lines
Quoted 67 lines
test/py/tests/test_efi_capsule/test_capsule_firmware.py new file +65
-0+ 'env save']) + + # initialize contents + output = u_boot_console.run_command_list([ + 'sf probe 0:0', + 'fatload host 0:1 4000000 %s/u-boot.bin.old' % CAPSULE_DATA_DIR, + 'sf write 4000000 100000 10', + 'sf read 5000000 100000 10', + 'md.b 5000000 10']) + assert 'Old' in ''.join(output) + output = u_boot_console.run_command_list([ + 'sf probe 0:0', + 'fatload host 0:1 4000000 %s/u-boot.env.old' % CAPSULE_DATA_DIR, + 'sf write 4000000 150000 10', + 'sf read 5000000 150000 10', + 'md.b 5000000 10']) + assert 'Old' in ''.join(output) + + # place a capsule file + output = u_boot_console.run_command_list([ + 'fatload host 0:1 4000000 %s/Test01' % CAPSULE_DATA_DIR, + 'fatwrite host 0:1 4000000 %s/Test01 $filesize' % CAPSULE_INSTALL_DIR, + 'fatls host 0:1 %s' % CAPSULE_INSTALL_DIR]) + assert 'Test01' in ''.join(output) + + # reboot + u_boot_console.restart_uboot_with_flags('-T') + + capsule_early = u_boot_config.buildconfig.get( + 'config_efi_capsule_on_disk_early') + with u_boot_console.log.section('Test Case 1-b, after reboot'): + if not capsule_early: + output = u_boot_console.run_command_list([ + 'host bind 0 %s' % disk_img, + 'fatls host 0:1 %s' % CAPSULE_INSTALL_DIR]) + assert 'Test01' in ''.join(output) + + # need to run uefi command to initiate capsule handling + output = u_boot_console.run_command( + 'env print -e -all Capsule0000') + + output = u_boot_console.run_command_list([ + 'host bind 0 %s' % disk_img, + 'fatls host 0:1 %s' % CAPSULE_INSTALL_DIR]) + assert 'Test01' in ''.join(output) + + output = u_boot_console.run_command_list([ + 'sf probe 0:0', + 'sf read 4000000 100000 10', + 'md.b 4000000 10']) + assert 'u-boot:Old' in ''.join(output) + + output = u_boot_console.run_command_list([ + 'sf read 4000000 150000 10', + 'md.b 4000000 10']) + assert 'u-boot-env:Old' in ''.join(output) + + def test_efi_capsule_fw2( + self, u_boot_config, u_boot_console, efi_capsule_data): + """ + Test Case 2 - Update U-Boot and U-Boot environment on SPI Flash + 0x100000-0x150000: U-Boot binary (but dummy) + 0x150000-0x200000: U-Boot environment (but dummy) + """ + # "-T" (or "-D") is required to enable spi flash on sandboxtest/py/tests/test_efi_capsule/test_capsule_firmware.py line 122
Quoted 10 lines
test/py/tests/test_efi_capsule/test_capsule_firmware.py new file +10
-0+ u_boot_console.restart_uboot_with_flags('-T') + + disk_img = efi_capsule_data + with u_boot_console.log.section('Test Case 2-a, before reboot'): + output = u_boot_console.run_command_list([ + 'host bind 0 %s' % disk_img, + 'efidebug boot add 1 TEST host 0:1 /helloworld.efi ""', + 'efidebug boot order 1', + 'env set -e -nv -bs -rt OsIndications =0x0000000000000004', + 'env set dfu_alt_info sf 0:0=u-boot-bin raw 0x100000 0x50000\;u-boot-env raw 0x150000 0x200000',Invalid escape sequence \;
Best regards
Heinrich
Quoted 99 lines
test/py/tests/test_efi_capsule/test_capsule_firmware.py new file +56
-0+ 'env save']) + + # initialize contents + output = u_boot_console.run_command_list([ + 'sf probe 0:0', + 'fatload host 0:1 4000000 %s/u-boot.bin.old' % CAPSULE_DATA_DIR, + 'sf write 4000000 100000 10', + 'sf read 5000000 100000 10', + 'md.b 5000000 10']) + assert 'Old' in ''.join(output) + output = u_boot_console.run_command_list([ + 'sf probe 0:0', + 'fatload host 0:1 4000000 %s/u-boot.env.old' % CAPSULE_DATA_DIR, + 'sf write 4000000 150000 10', + 'sf read 5000000 150000 10', + 'md.b 5000000 10']) + assert 'Old' in ''.join(output) + + # place a capsule file + output = u_boot_console.run_command_list([ + 'fatload host 0:1 4000000 %s/Test01' % CAPSULE_DATA_DIR, + 'fatwrite host 0:1 4000000 %s/Test01 $filesize' % CAPSULE_INSTALL_DIR, + 'fatls host 0:1 %s' % CAPSULE_INSTALL_DIR]) + assert 'Test01' in ''.join(output) + + # reboot + u_boot_console.restart_uboot_with_flags('-T') + + capsule_early = u_boot_config.buildconfig.get( + 'config_efi_capsule_on_disk_early') + with u_boot_console.log.section('Test Case 2-b, after reboot'): + if not capsule_early: + output = u_boot_console.run_command_list([ + 'host bind 0 %s' % disk_img, + 'fatls host 0:1 %s' % CAPSULE_INSTALL_DIR]) + assert 'Test01' in ''.join(output) + + # need to run uefi command to initiate capsule handling + output = u_boot_console.run_command( + 'env print -e -all Capsule0000') + + output = u_boot_console.run_command_list([ + 'host bind 0 %s' % disk_img, + 'fatls host 0:1 %s' % CAPSULE_INSTALL_DIR]) + assert 'Test01' not in ''.join(output) + + output = u_boot_console.run_command_list([ + 'sf probe 0:0', + 'sf read 4000000 100000 10', + 'md.b 4000000 10']) + assert 'u-boot:New' in ''.join(output) + + output = u_boot_console.run_command_list([ + 'sf read 4000000 150000 10', + 'md.b 4000000 10']) + assert 'u-boot-env:New' in ''.join(output)test/py/tests/test_efi_capsule/uboot_bin_env.its new file +36
-0@@ -0,0 +1,36 @@ +/* + * Automatic software update for U-Boot + * Make sure the flashing addresses ('load' prop) is correct for your board! + */ + +/dts-v1/; + +/ { + description = "Automatic U-Boot environment update"; + #address-cells = <2>; + + images { + u-boot-bin at 100000 { + description = "U-Boot binary on SPI Flash"; + data = /incbin/("BINFILE1"); + compression = "none"; + type = "firmware"; + arch = "sandbox"; + load = <0>; + hash-1 { + algo = "sha1"; + }; + }; + u-boot-env at 150000 { + description = "U-Boot environment on SPI Flash"; + data = /incbin/("BINFILE2"); + compression = "none"; + type = "firmware"; + arch = "sandbox"; + load = <0>; + hash-1 { + algo = "sha1"; + }; + }; + }; +};
PATCH v5 17/17 test/py: add a test for uefi firmware update capsule of raw image
In reply to AKASHI TakahiroThe test can run on sandbox build and it attempts to execute a firmware update via a capsule-on-disk, using a raw image capsule, CONFIG_EFI_CAPSULE_RAW.
To run this test successfully, you need configure U-Boot specifically; See test_capsule_firmware.py for requirements, and hence it won't run on Travis CI.
--- test/py/tests/test_efi_capsule/conftest.py | 3 + .../test_efi_capsule/test_capsule_firmware.py | 63 +++++++++++++++++++ 2 files changed, 66 insertions(+)
test/py/tests/test_efi_capsule/conftest.py +3 -0
@@ -51,6 +51,9 @@ def efi_capsule_data(request, u_boot_config): check_call('cd %s; %s/tools/mkeficapsule --fit uboot_bin_env.itb --version 1 --index 1 Test01' % (data_dir, u_boot_config.build_dir), shell=True) + check_call('cd %s; %s/tools/mkeficapsule --raw u-boot.bin.new --version 1 --index 1 Test02' % + (data_dir, u_boot_config.build_dir), + shell=True) # Create a disk image with EFI system partition check_call('virt-make-fs --partition=gpt --size=+1M --type=vfat %s %s' %
test/py/tests/test_efi_capsule/test_capsule_firmware.py +63 -0
72 lines not on this page · raw message
Signature · 1 line
2.27.0
PATCH v5 17/17 test/py: add a test for uefi firmware update capsule of raw image
Quoted 8 lines · AKASHI Takahiro
The test can run on sandbox build and it attempts to execute a firmware update via a capsule-on-disk, using a raw image capsule,
CONFIG_EFI_CAPSULE_RAW.To run this test successfully, you need configure U-Boot specifically; See
test_capsule_firmware.pyfor requirements, and hence it won't run on Travis CI.
git format-patch results in the same filename for patch 16 and 17.
You subject lines are simply too long. How about:
"test/py: test for raw image capsule"
Best regards
Heinrich
Quoted 99 lines
Signed-off-by AKASHI Takahiro <[email protected]>--- test/py/tests/test_efi_capsule/conftest.py | 3 + .../test_efi_capsule/test_capsule_firmware.py | 63 +++++++++++++++++++ 2 files changed, 66 insertions(+)test/py/tests/test_efi_capsule/conftest.py +3
-0@@ -51,6 +51,9 @@ def efi_capsule_data(request, u_boot_config): check_call('cd %s; %s/tools/mkeficapsule --fit uboot_bin_env.itb --version 1 --index 1 Test01' % (data_dir, u_boot_config.build_dir), shell=True) + check_call('cd %s; %s/tools/mkeficapsule --raw u-boot.bin.new --version 1 --index 1 Test02' % + (data_dir, u_boot_config.build_dir), + shell=True) # Create a disk image with EFI system partition check_call('virt-make-fs --partition=gpt --size=+1M --type=vfat %s %s' %test/py/tests/test_efi_capsule/test_capsule_firmware.py +63
-0@@ -15,6 +15,7 @@ from defs import * @pytest.mark.boardspec('sandbox') @pytest.mark.buildconfigspec('efi_capsule_firmware_fit') + at pytest.mark.buildconfigspec('efi_capsule_firmware_raw') @pytest.mark.buildconfigspec('efi_capsule_on_disk') @pytest.mark.buildconfigspec('dfu') @pytest.mark.buildconfigspec('dfu_sf')@@ -176,3 +177,65 @@ class TestEfiCapsuleFirmwareFit(object): 'sf read 4000000 150000 10', 'md.b 4000000 10']) assert 'u-boot-env:New' in ''.join(output) + + def test_efi_capsule_fw3( + self, u_boot_config, u_boot_console, efi_capsule_data): + """ + Test Case 3 - Update U-Boot on SPI Flash, raw image format + 0x100000-0x150000: U-Boot binary (but dummy) + """ + # "-T" (or "-D") is required to enable spi flash on sandbox + u_boot_console.restart_uboot_with_flags('-T') + + disk_img = efi_capsule_data + with u_boot_console.log.section('Test Case 3-a, before reboot'): + output = u_boot_console.run_command_list([ + 'host bind 0 %s' % disk_img, + 'efidebug boot add 1 TEST host 0:1 /helloworld.efi ""', + 'efidebug boot order 1', + 'env set -e -nv -bs -rt OsIndications =0x0000000000000004', + 'env set dfu_alt_info sf 0:0=u-boot-bin raw 0x100000 0x50000\;u-boot-env raw 0x150000 0x200000', + 'env save']) + + # initialize content + output = u_boot_console.run_command_list([ + 'sf probe 0:0', + 'fatload host 0:1 4000000 %s/u-boot.bin.old' % CAPSULE_DATA_DIR, + 'sf write 4000000 100000 10', + 'sf read 5000000 100000 10', + 'md.b 5000000 10']) + assert 'Old' in ''.join(output) + + # place a capsule file + output = u_boot_console.run_command_list([ + 'fatload host 0:1 4000000 %s/Test02' % CAPSULE_DATA_DIR, + 'fatwrite host 0:1 4000000 %s/Test02 $filesize' % CAPSULE_INSTALL_DIR, + 'fatls host 0:1 %s' % CAPSULE_INSTALL_DIR]) + assert 'Test02' in ''.join(output) + + # reboot + u_boot_console.restart_uboot_with_flags('-T') + + capsule_early = u_boot_config.buildconfig.get( + 'config_efi_capsule_on_disk_early') + with u_boot_console.log.section('Test Case 3-b, after reboot'): + if not capsule_early: + output = u_boot_console.run_command_list([ + 'host bind 0 %s' % disk_img, + 'fatls host 0:1 %s' % CAPSULE_INSTALL_DIR]) + assert 'Test02' in ''.join(output) + + # need to run uefi command to initiate capsule handling + output = u_boot_console.run_command( + 'env print -e -all Capsule0000') + + output = u_boot_console.run_command_list([ + 'host bind 0 %s' % disk_img, + 'fatls host 0:1 %s' % CAPSULE_INSTALL_DIR]) + assert 'Test02' not in ''.join(output) + + output = u_boot_console.run_command_list([ + 'sf probe 0:0', + 'sf read 4000000 100000 10', + 'md.b 4000000 10']) + assert 'u-boot:New' in ''.join(output)
PATCH v5 17/17 test/py: add a test for uefi firmware update capsule of raw image
Quoted 11 lines · Heinrich Schuchardt
Quoted 8 lines · AKASHI Takahiro
The test can run on sandbox build and it attempts to execute a firmware update via a capsule-on-disk, using a raw image capsule,
CONFIG_EFI_CAPSULE_RAW.To run this test successfully, you need configure U-Boot specifically; See
test_capsule_firmware.pyfor requirements, and hence it won't run on Travis CI.git format-patch results in the same filename for patch 16 and 17.
Indeed, though the preceding index number will make them distinguishable.
Quoted 3 lines
You subject lines are simply too long. How about:
"test/py: test for raw image capsule"
Okay, something like that.
-Takahiro Akashi
Quoted 104 lines
Best regards
Heinrich
Quoted 99 lines
Signed-off-by AKASHI Takahiro <[email protected]>--- test/py/tests/test_efi_capsule/conftest.py | 3 + .../test_efi_capsule/test_capsule_firmware.py | 63 +++++++++++++++++++ 2 files changed, 66 insertions(+)test/py/tests/test_efi_capsule/conftest.py +3
-0@@ -51,6 +51,9 @@ def efi_capsule_data(request, u_boot_config): check_call('cd %s; %s/tools/mkeficapsule --fit uboot_bin_env.itb --version 1 --index 1 Test01' % (data_dir, u_boot_config.build_dir), shell=True) + check_call('cd %s; %s/tools/mkeficapsule --raw u-boot.bin.new --version 1 --index 1 Test02' % + (data_dir, u_boot_config.build_dir), + shell=True) # Create a disk image with EFI system partition check_call('virt-make-fs --partition=gpt --size=+1M --type=vfat %s %s' %test/py/tests/test_efi_capsule/test_capsule_firmware.py +63
-0@@ -15,6 +15,7 @@ from defs import * @pytest.mark.boardspec('sandbox') @pytest.mark.buildconfigspec('efi_capsule_firmware_fit') + at pytest.mark.buildconfigspec('efi_capsule_firmware_raw') @pytest.mark.buildconfigspec('efi_capsule_on_disk') @pytest.mark.buildconfigspec('dfu') @pytest.mark.buildconfigspec('dfu_sf')@@ -176,3 +177,65 @@ class TestEfiCapsuleFirmwareFit(object): 'sf read 4000000 150000 10', 'md.b 4000000 10']) assert 'u-boot-env:New' in ''.join(output) + + def test_efi_capsule_fw3( + self, u_boot_config, u_boot_console, efi_capsule_data): + """ + Test Case 3 - Update U-Boot on SPI Flash, raw image format + 0x100000-0x150000: U-Boot binary (but dummy) + """ + # "-T" (or "-D") is required to enable spi flash on sandbox + u_boot_console.restart_uboot_with_flags('-T') + + disk_img = efi_capsule_data + with u_boot_console.log.section('Test Case 3-a, before reboot'): + output = u_boot_console.run_command_list([ + 'host bind 0 %s' % disk_img, + 'efidebug boot add 1 TEST host 0:1 /helloworld.efi ""', + 'efidebug boot order 1', + 'env set -e -nv -bs -rt OsIndications =0x0000000000000004', + 'env set dfu_alt_info sf 0:0=u-boot-bin raw 0x100000 0x50000\;u-boot-env raw 0x150000 0x200000', + 'env save']) + + # initialize content + output = u_boot_console.run_command_list([ + 'sf probe 0:0', + 'fatload host 0:1 4000000 %s/u-boot.bin.old' % CAPSULE_DATA_DIR, + 'sf write 4000000 100000 10', + 'sf read 5000000 100000 10', + 'md.b 5000000 10']) + assert 'Old' in ''.join(output) + + # place a capsule file + output = u_boot_console.run_command_list([ + 'fatload host 0:1 4000000 %s/Test02' % CAPSULE_DATA_DIR, + 'fatwrite host 0:1 4000000 %s/Test02 $filesize' % CAPSULE_INSTALL_DIR, + 'fatls host 0:1 %s' % CAPSULE_INSTALL_DIR]) + assert 'Test02' in ''.join(output) + + # reboot + u_boot_console.restart_uboot_with_flags('-T') + + capsule_early = u_boot_config.buildconfig.get( + 'config_efi_capsule_on_disk_early') + with u_boot_console.log.section('Test Case 3-b, after reboot'): + if not capsule_early: + output = u_boot_console.run_command_list([ + 'host bind 0 %s' % disk_img, + 'fatls host 0:1 %s' % CAPSULE_INSTALL_DIR]) + assert 'Test02' in ''.join(output) + + # need to run uefi command to initiate capsule handling + output = u_boot_console.run_command( + 'env print -e -all Capsule0000') + + output = u_boot_console.run_command_list([ + 'host bind 0 %s' % disk_img, + 'fatls host 0:1 %s' % CAPSULE_INSTALL_DIR]) + assert 'Test02' not in ''.join(output) + + output = u_boot_console.run_command_list([ + 'sf probe 0:0', + 'sf read 4000000 100000 10', + 'md.b 4000000 10']) + assert 'u-boot:New' in ''.join(output)
PATCH v5 17/17 test/py: add a test for uefi firmware update capsule of raw image
In reply to Heinrich SchuchardtQuoted 66 lines · Heinrich Schuchardt
Quoted 8 lines · AKASHI Takahiro
The test can run on sandbox build and it attempts to execute a firmware update via a capsule-on-disk, using a raw image capsule,
CONFIG_EFI_CAPSULE_RAW.To run this test successfully, you need configure U-Boot specifically; See
test_capsule_firmware.pyfor requirements, and hence it won't run on Travis CI.git format-patch results in the same filename for patch 16 and 17.
You subject lines are simply too long. How about:
"test/py: test for raw image capsule"
Best regards
Heinrich
Quoted 46 lines
Signed-off-by AKASHI Takahiro <[email protected]>--- test/py/tests/test_efi_capsule/conftest.py | 3 + .../test_efi_capsule/test_capsule_firmware.py | 63 +++++++++++++++++++ 2 files changed, 66 insertions(+)test/py/tests/test_efi_capsule/conftest.py +3
-0@@ -51,6 +51,9 @@ def efi_capsule_data(request, u_boot_config): check_call('cd %s; %s/tools/mkeficapsule --fit uboot_bin_env.itb --version 1 --index 1 Test01' % (data_dir, u_boot_config.build_dir), shell=True) + check_call('cd %s; %s/tools/mkeficapsule --raw u-boot.bin.new --version 1 --index 1 Test02' % + (data_dir, u_boot_config.build_dir), + shell=True) # Create a disk image with EFI system partition check_call('virt-make-fs --partition=gpt --size=+1M --type=vfat %s %s' %test/py/tests/test_efi_capsule/test_capsule_firmware.py +11
-0@@ -15,6 +15,7 @@ from defs import * @pytest.mark.boardspec('sandbox') @pytest.mark.buildconfigspec('efi_capsule_firmware_fit') + at pytest.mark.buildconfigspec('efi_capsule_firmware_raw') @pytest.mark.buildconfigspec('efi_capsule_on_disk') @pytest.mark.buildconfigspec('dfu') @pytest.mark.buildconfigspec('dfu_sf')@@ -176,3 +177,65 @@ class TestEfiCapsuleFirmwareFit(object): 'sf read 4000000 150000 10', 'md.b 4000000 10']) assert 'u-boot-env:New' in ''.join(output) + + def test_efi_capsule_fw3( + self, u_boot_config, u_boot_console, efi_capsule_data): + """ + Test Case 3 - Update U-Boot on SPI Flash, raw image format + 0x100000-0x150000: U-Boot binary (but dummy) + """ + # "-T" (or "-D") is required to enable spi flash on sandbox + u_boot_console.restart_uboot_with_flags('-T') +
Quoted 8 lines
test/py/tests/test_efi_capsule/test_capsule_firmware.py class TestEfiCapsuleFirmwareFit(object): · line 197
Quoted 8 lines
test/py/tests/test_efi_capsule/test_capsule_firmware.py +8
-0+ disk_img = efi_capsule_data + with u_boot_console.log.section('Test Case 3-a, before reboot'): + output = u_boot_console.run_command_list([ + 'host bind 0 %s' % disk_img, + 'efidebug boot add 1 TEST host 0:1 /helloworld.efi ""', + 'efidebug boot order 1', + 'env set -e -nv -bs -rt OsIndications =0x0000000000000004', + 'env set dfu_alt_info sf 0:0=u-boot-bin raw 0x100000 0x50000\;u-boot-env raw 0x150000 0x200000',
Invalid escape sequence \;
Best regards
Heinrich
Quoted 46 lines
Quoted 45 lines
test/py/tests/test_efi_capsule/test_capsule_firmware.py +44
-0+ 'env save']) + + # initialize content + output = u_boot_console.run_command_list([ + 'sf probe 0:0', + 'fatload host 0:1 4000000 %s/u-boot.bin.old' % CAPSULE_DATA_DIR, + 'sf write 4000000 100000 10', + 'sf read 5000000 100000 10', + 'md.b 5000000 10']) + assert 'Old' in ''.join(output) + + # place a capsule file + output = u_boot_console.run_command_list([ + 'fatload host 0:1 4000000 %s/Test02' % CAPSULE_DATA_DIR, + 'fatwrite host 0:1 4000000 %s/Test02 $filesize' % CAPSULE_INSTALL_DIR, + 'fatls host 0:1 %s' % CAPSULE_INSTALL_DIR]) + assert 'Test02' in ''.join(output) + + # reboot + u_boot_console.restart_uboot_with_flags('-T') + + capsule_early = u_boot_config.buildconfig.get( + 'config_efi_capsule_on_disk_early') + with u_boot_console.log.section('Test Case 3-b, after reboot'): + if not capsule_early: + output = u_boot_console.run_command_list([ + 'host bind 0 %s' % disk_img, + 'fatls host 0:1 %s' % CAPSULE_INSTALL_DIR]) + assert 'Test02' in ''.join(output) + + # need to run uefi command to initiate capsule handling + output = u_boot_console.run_command( + 'env print -e -all Capsule0000') + + output = u_boot_console.run_command_list([ + 'host bind 0 %s' % disk_img, + 'fatls host 0:1 %s' % CAPSULE_INSTALL_DIR]) + assert 'Test02' not in ''.join(output) + + output = u_boot_console.run_command_list([ + 'sf probe 0:0', + 'sf read 4000000 100000 10', + 'md.b 4000000 10']) + assert 'u-boot:New' in ''.join(output)
v5 cover efi_loader: add capsule update support
In reply to AKASHI TakahiroQuoted 173 lines · AKASHI Takahiro
Summary
=======
'UpdateCapsule' is one of runtime services defined in UEFI specification and its aim is to allow a caller (OS) to pass information to the firmware, i.e. U-Boot. This is mostly used to update firmware binary on devices by instructions from OS.While 'UpdateCapsule' is a runtime services function, it is, at least initially, supported only before exiting boot services alike other runtime functions, [Get/]SetVariable. This is because modifying storage which may be shared with OS must be carefully designed and there is no general assumption that we can do it.
Therefore, we practically support only "capsule on disk"; any capsule can be handed over to UEFI subsystem as a file on a specific file system.
In this patch series, all the related definitions and structures are given as UEFI specification describes, and basic framework for capsule support is provided. Currently supported is
* firmware update (Firmware Management Protocol or simply FMP)Most of functionality of firmware update is provided by FMP driver and it can be, by nature, system/platform-specific. So you can and should implement your own FMP driver(s) based on your system requirements. Under the current implementation, we provide two basic but generic drivers with two formats:
* FIT image format (as used in TFTP update and dfu)
* raw image formatIt's totally up to users which one, or both, should be used on users' system depending on user requirements.
Quick usage
===========
1. You can create a capsule file with the following host command:$ mkeficapsule [--fit <fit image> | --raw <raw image>] <output file>2. Put the file under:
/EFI/UpdateCapsule of UEFI system partition
3. Specify firmware storage to be updated in "
dfu_alt_info" variable (Please follow README.dfu for details.)==> env set
dfu_alt_info'...'4. After setting up UEFI's OsIndications variable, reboot U-Boot:
OsIndications <=
EFI_OS_INDICATIONS_FILE_CAPSULE_DELIVERY_SUPPORTEDPatch structure
===============
Patch#1-#4,#12: preparatory patches
Patch#5-#11,#13: main part of implementation
Patch#14-#15: utilities
Patch#16-#17: pytests[1] https://git.linaro.org/people/takahiro.akashi/u-boot.git efi/capsule
Prerequisite patches
====================
dfu change by Heinrich[2][2] https://lists.denx.de/pipermail/u-boot/2020-July/420950.html
Test
====
* passed all the pytests which are included in this patch series on sandbox build locally.Please note that the capsule pytest itself won't be run in the CI partly because some specific configuration for sandbox build is required and partly because there is a problem with virt-make-fs. See
test_efi_capsule_firmware.py.Issues
======
* Timing of executing capsules-on-disk
Currently, processing a capsule is triggered only as part of UEFI subsystem initialization. This means that, for example, firmware update, may not take place at system booting time and will potentially be delayed until a first call of any UEFI functions.
=> See patch#5 for my proposal
* A bunch of warnings like
WARNING: Use 'if (IS_ENABLED(CONFIG...))' instead of '#if or #ifdef' where possible
I don't think that fixing those improves anything.
* Add a document inuefi.rstTODO's
======
(Won't be addressed in this series.)
* capsule authentication
* capsule dependency (dependency expression instruction set)
* loading drivers in a capsule
* handling RESET flag in a capsule and QeuryCapsuleCaps
* full semantics of ESRT (EFI System Resource Table)
* enabling capsule API at runtime
* json capsule
* recovery from update failureChanges
=======
v5 (August 3, 2020)
* removed superfluous type conversion atdfu_write_from_mem_addr()(Patch#2)
* introduced a common helper function,efi_create_indexed_name()(Patch#6,#7,#8)
* use efi_[get|set]_variable_int(), if necessary, withREAD_ONLY(Patch#7,#8)
* returnEFI_UNSUPPORTEDat Patch#7
* changed the word, number, to 'index' (Patch#7,#8)
* removed 'ifdefCONFIG_EFI_CAPSULE_ON_DISK' from a header (Patch#8)
* initialize 'CapsuleLast' inefi_init_obj_list()(Patch#7,#8)
* added 'const' qualifier for filename argument at efi_capsule_[read|delete]_file() (Patch#8)v4 (July 22, 2020)
* rebased to Heinrich's current efi-2020-10
* rework dfu-related code to align with Heinrich's change (Patch#1,#3)
* change a type of 'addr' argument from int to 'void *' per Sughosh's comment (Patch#2-#3,#11-#12)
* rework/simplify pytests (Patch#15-#16)
- utilize virt-make-fs
- drop Test Case 1 (updating U-Boot environment data)
- remove useless definitions (MNT_PNT,EFI_CAPSULE_IMAGE_NAME)
- apply autopep8v3 (July 10, 2020)
* rebased to Heinrich's current efi-2020-10-rc1
* refactor efi_firmware_[fit|raw]_get_image_info() (patch#11,#13)v2 (June 17, 2020)
* rebased to v2020.07-rc4
* add preparatory patches for dfu (Patch#1-#5, #12)
* rework FIT capsule driver to utilizedfu_alt_infoinstead ofCONFIG_xxx(patch#11)
* extendget_image_info()to correspond todfu_alt_info(patch#11)
* add a 'raw binary' capsule support
(patch#13, #17)
* allow multiple capsule formats (with different GUIDs) to be installed (patch#11, #13)
* extend mkeficapsule command to accept additional parameters, like version/index/hardware instance for a capsule header info. (patch#15)
* mkeficapsule can now also generate raw-binary capsule (patch#16)
* add function descriptions
* apply autopep8 to pytests and fix more against pylintv1 (April 27, 2020)
* rebased to v2020.07-rc
* removed already-merged patches (RFC's #1 to #4)
* dropped 'variable update' capsule support (RFC's patch#10)
* dropped 'variable configuration table' support (RFC's patch#11) (Those two should be discussed separately.)
* add preparatory patches (patch#1/#2)
* fix several build errors
* rename someKconfigoptions to be aligned with UEFI specification's terms (patch#3,4,6,7)
* enforce UpdateCapsule API to be disabled after ExitBootServices (patch#3)
* use config table,runtime_services_supported, instead of variable (patch#3)
* makeEFI_CAPSULE_ON_DISKbuildable even if UpdateCapsule API is disabled (patch4)
* support OsIndications, invoking capsule-on-disk only if the variable indicates so (patch#4)
* introducedEFI_CAPSULE_ON_DISK_EARLYto invoke capsule-on-disk in U-Boot initialization (patch#4)
* detect capsule files only if they are on EFI system partition (patch#4)
Quoted 9 lines
* use printf, rather than
EFI_PRINT, in error cases (patch#4)
* use 'header_size' field to retrieve capsule data, adding sanity checks against capsule size (patch#6)
* call fmpt driver interfaces withEFI_CALL(patch#6)
* remove 'variable update capsule'-related code form mkeficapsule (patch#9)
* add a test case of OsIndications not being set properly (patch#10)
* adjust test scenario forEFI_CAPSULE_ON_DISK_EARLY(patch#10)
* revise pytest scripts (patch#10)
Hello Lukasz,
most of this patch series are DFU changes.
Could you, please, give us some feedback.
Best regards
Heinrich
Quoted 59 lines
Initial release as RFC (March 17, 2020)
AKASHI Takahiro (17):
dfu: renamedfu_tftp_write()todfu_write_by_name()
dfu: modify an argument type for an address
common: update: add a generic interface for FIT image
dfu: exportdfu_list
efi_loader: add option to initialise EFI subsystem early
efi_loader: addefi_create_indexed_name()
efi_loader: define UpdateCapsule api
efi_loader: capsule: addcapsule_on_disksupport
efi_loader: capsule: add memory range capsule definitions
efi_loader: capsule: support firmware update
efi_loader: add firmware management protocol for FIT image
dfu: adddfu_write_by_alt()
efi_loader: add firmware management protocol for raw image
cmd: add "efidebug capsule" command
tools: add mkeficapsule command for UEFI capsule update test/py: add a test for uefi firmware update capsule of FIT image test/py: add a test for uefi firmware update capsule of raw imagecmd/efidebug.c | 235 +++++ common/Kconfig | 14 + common/Makefile | 3 +- common/board_r.c | 6 + common/main.c | 4 + common/update.c | 77 +- drivers/dfu/Kconfig | 6 + drivers/dfu/Makefile | 2 +- drivers/dfu/dfu.c | 2 +- drivers/dfu/dfu_alt.c | 125 +++ drivers/dfu/dfu_tftp.c | 65 -- include/dfu.h | 57 +- include/efi_api.h | 160 +++ include/efi_loader.h | 30 + include/image.h | 12 + lib/efi_loader/Kconfig | 72 ++ lib/efi_loader/Makefile | 2 + lib/efi_loader/efi_capsule.c | 910 ++++++++++++++++++ lib/efi_loader/efi_firmware.c | 398 ++++++++ lib/efi_loader/efi_runtime.c | 104 +- lib/efi_loader/efi_setup.c | 106 +- test/py/tests/test_efi_capsule/conftest.py | 72 ++ test/py/tests/test_efi_capsule/defs.py | 12 + .../test_efi_capsule/test_capsule_firmware.py | 241 +++++ .../tests/test_efi_capsule/uboot_bin_env.its | 36 + tools/Makefile | 3 + tools/mkeficapsule.c | 237 +++++ 27 files changed, 2851 insertions(+), 140 deletions(-) create mode 100644 drivers/dfu/dfu_alt.c delete mode 100644 drivers/dfu/dfu_tftp.c create mode 100644 lib/efi_loader/efi_capsule.c create mode 100644 lib/efi_loader/efi_firmware.c create mode 100644 test/py/tests/test_efi_capsule/conftest.py create mode 100644 test/py/tests/test_efi_capsule/defs.py create mode 100644 test/py/tests/test_efi_capsule/test_capsule_firmware.py create mode 100644 test/py/tests/test_efi_capsule/uboot_bin_env.its create mode 100644 tools/mkeficapsule.c
v5 cover efi_loader: add capsule update support
In reply to AKASHI TakahiroLukasz,
Could you take the time to review my patches, especially patch#1 to #4 and #12, please?
They are crucial as UEFI capsule update support relies on new features introduced by them.
# I don't think I would re-post this patch series as no changes have been made yet.
Thanks,
-Takahiro Akashi
Quoted 244 lines · AKASHI Takahiro
Summary
=======
'UpdateCapsule' is one of runtime services defined in UEFI specification and its aim is to allow a caller (OS) to pass information to the firmware, i.e. U-Boot. This is mostly used to update firmware binary on devices by instructions from OS.While 'UpdateCapsule' is a runtime services function, it is, at least initially, supported only before exiting boot services alike other runtime functions, [Get/]SetVariable. This is because modifying storage which may be shared with OS must be carefully designed and there is no general assumption that we can do it.
Therefore, we practically support only "capsule on disk"; any capsule can be handed over to UEFI subsystem as a file on a specific file system.
In this patch series, all the related definitions and structures are given as UEFI specification describes, and basic framework for capsule support is provided. Currently supported is
* firmware update (Firmware Management Protocol or simply FMP)Most of functionality of firmware update is provided by FMP driver and it can be, by nature, system/platform-specific. So you can and should implement your own FMP driver(s) based on your system requirements. Under the current implementation, we provide two basic but generic drivers with two formats:
* FIT image format (as used in TFTP update and dfu)
* raw image formatIt's totally up to users which one, or both, should be used on users' system depending on user requirements.
Quick usage
===========
1. You can create a capsule file with the following host command:$ mkeficapsule [--fit <fit image> | --raw <raw image>] <output file>2. Put the file under:
/EFI/UpdateCapsule of UEFI system partition
3. Specify firmware storage to be updated in "
dfu_alt_info" variable (Please follow README.dfu for details.)==> env set
dfu_alt_info'...'4. After setting up UEFI's OsIndications variable, reboot U-Boot:
OsIndications <=
EFI_OS_INDICATIONS_FILE_CAPSULE_DELIVERY_SUPPORTEDPatch structure
===============
Patch#1-#4,#12: preparatory patches
Patch#5-#11,#13: main part of implementation
Patch#14-#15: utilities
Patch#16-#17: pytests[1] https://git.linaro.org/people/takahiro.akashi/u-boot.git efi/capsule
Prerequisite patches
====================
dfu change by Heinrich[2][2] https://lists.denx.de/pipermail/u-boot/2020-July/420950.html
Test
====
* passed all the pytests which are included in this patch series on sandbox build locally.Please note that the capsule pytest itself won't be run in the CI partly because some specific configuration for sandbox build is required and partly because there is a problem with virt-make-fs. See
test_efi_capsule_firmware.py.Issues
======
* Timing of executing capsules-on-disk
Currently, processing a capsule is triggered only as part of UEFI subsystem initialization. This means that, for example, firmware update, may not take place at system booting time and will potentially be delayed until a first call of any UEFI functions.
=> See patch#5 for my proposal
* A bunch of warnings like
WARNING: Use 'if (IS_ENABLED(CONFIG...))' instead of '#if or #ifdef' where possible
I don't think that fixing those improves anything.
* Add a document inuefi.rstTODO's
======
(Won't be addressed in this series.)
* capsule authentication
* capsule dependency (dependency expression instruction set)
* loading drivers in a capsule
* handling RESET flag in a capsule and QeuryCapsuleCaps
* full semantics of ESRT (EFI System Resource Table)
* enabling capsule API at runtime
* json capsule
* recovery from update failureChanges
=======
v5 (August 3, 2020)
* removed superfluous type conversion atdfu_write_from_mem_addr()(Patch#2)
* introduced a common helper function,efi_create_indexed_name()(Patch#6,#7,#8)
* use efi_[get|set]_variable_int(), if necessary, withREAD_ONLY(Patch#7,#8)
* returnEFI_UNSUPPORTEDat Patch#7
* changed the word, number, to 'index' (Patch#7,#8)
* removed 'ifdefCONFIG_EFI_CAPSULE_ON_DISK' from a header (Patch#8)
* initialize 'CapsuleLast' inefi_init_obj_list()(Patch#7,#8)
* added 'const' qualifier for filename argument at efi_capsule_[read|delete]_file() (Patch#8)v4 (July 22, 2020)
* rebased to Heinrich's current efi-2020-10
* rework dfu-related code to align with Heinrich's change (Patch#1,#3)
* change a type of 'addr' argument from int to 'void *' per Sughosh's comment (Patch#2-#3,#11-#12)
* rework/simplify pytests (Patch#15-#16)
- utilize virt-make-fs
- drop Test Case 1 (updating U-Boot environment data)
- remove useless definitions (MNT_PNT,EFI_CAPSULE_IMAGE_NAME)
- apply autopep8v3 (July 10, 2020)
* rebased to Heinrich's current efi-2020-10-rc1
* refactor efi_firmware_[fit|raw]_get_image_info() (patch#11,#13)v2 (June 17, 2020)
* rebased to v2020.07-rc4
* add preparatory patches for dfu (Patch#1-#5, #12)
* rework FIT capsule driver to utilizedfu_alt_infoinstead ofCONFIG_xxx(patch#11)
* extendget_image_info()to correspond todfu_alt_info(patch#11)
* add a 'raw binary' capsule support
(patch#13, #17)
* allow multiple capsule formats (with different GUIDs) to be installed (patch#11, #13)
* extend mkeficapsule command to accept additional parameters, like version/index/hardware instance for a capsule header info. (patch#15)
* mkeficapsule can now also generate raw-binary capsule (patch#16)
* add function descriptions
* apply autopep8 to pytests and fix more against pylintv1 (April 27, 2020)
* rebased to v2020.07-rc
* removed already-merged patches (RFC's #1 to #4)
* dropped 'variable update' capsule support (RFC's patch#10)
* dropped 'variable configuration table' support (RFC's patch#11) (Those two should be discussed separately.)
* add preparatory patches (patch#1/#2)
* fix several build errors
* rename someKconfigoptions to be aligned with UEFI specification's terms (patch#3,4,6,7)
* enforce UpdateCapsule API to be disabled after ExitBootServices (patch#3)
* use config table,runtime_services_supported, instead of variable (patch#3)
* makeEFI_CAPSULE_ON_DISKbuildable even if UpdateCapsule API is disabled (patch4)
* support OsIndications, invoking capsule-on-disk only if the variable indicates so (patch#4)
* introducedEFI_CAPSULE_ON_DISK_EARLYto invoke capsule-on-disk in U-Boot initialization (patch#4)
* detect capsule files only if they are on EFI system partition (patch#4)
* use printf, rather thanEFI_PRINT, in error cases (patch#4)
* use 'header_size' field to retrieve capsule data, adding sanity checks against capsule size (patch#6)
* call fmpt driver interfaces withEFI_CALL(patch#6)
* remove 'variable update capsule'-related code form mkeficapsule (patch#9)
* add a test case of OsIndications not being set properly (patch#10)
* adjust test scenario forEFI_CAPSULE_ON_DISK_EARLY(patch#10)
* revise pytest scripts (patch#10)Initial release as RFC (March 17, 2020)
AKASHI Takahiro (17):
dfu: renamedfu_tftp_write()todfu_write_by_name()
dfu: modify an argument type for an address
common: update: add a generic interface for FIT image
dfu: exportdfu_list
efi_loader: add option to initialise EFI subsystem early
efi_loader: addefi_create_indexed_name()
efi_loader: define UpdateCapsule api
efi_loader: capsule: addcapsule_on_disksupport
efi_loader: capsule: add memory range capsule definitions
efi_loader: capsule: support firmware update
efi_loader: add firmware management protocol for FIT image
dfu: adddfu_write_by_alt()
efi_loader: add firmware management protocol for raw image
cmd: add "efidebug capsule" command
tools: add mkeficapsule command for UEFI capsule update test/py: add a test for uefi firmware update capsule of FIT image test/py: add a test for uefi firmware update capsule of raw imagecmd/efidebug.c | 235 +++++ common/Kconfig | 14 + common/Makefile | 3 +- common/board_r.c | 6 + common/main.c | 4 + common/update.c | 77 +- drivers/dfu/Kconfig | 6 + drivers/dfu/Makefile | 2 +- drivers/dfu/dfu.c | 2 +- drivers/dfu/dfu_alt.c | 125 +++ drivers/dfu/dfu_tftp.c | 65 -- include/dfu.h | 57 +- include/efi_api.h | 160 +++ include/efi_loader.h | 30 + include/image.h | 12 + lib/efi_loader/Kconfig | 72 ++ lib/efi_loader/Makefile | 2 + lib/efi_loader/efi_capsule.c | 910 ++++++++++++++++++ lib/efi_loader/efi_firmware.c | 398 ++++++++ lib/efi_loader/efi_runtime.c | 104 +- lib/efi_loader/efi_setup.c | 106 +- test/py/tests/test_efi_capsule/conftest.py | 72 ++ test/py/tests/test_efi_capsule/defs.py | 12 + .../test_efi_capsule/test_capsule_firmware.py | 241 +++++ .../tests/test_efi_capsule/uboot_bin_env.its | 36 + tools/Makefile | 3 + tools/mkeficapsule.c | 237 +++++ 27 files changed, 2851 insertions(+), 140 deletions(-) create mode 100644 drivers/dfu/dfu_alt.c delete mode 100644 drivers/dfu/dfu_tftp.c create mode 100644 lib/efi_loader/efi_capsule.c create mode 100644 lib/efi_loader/efi_firmware.c create mode 100644 test/py/tests/test_efi_capsule/conftest.py create mode 100644 test/py/tests/test_efi_capsule/defs.py create mode 100644 test/py/tests/test_efi_capsule/test_capsule_firmware.py create mode 100644 test/py/tests/test_efi_capsule/uboot_bin_env.its create mode 100644 tools/mkeficapsule.cSignature · 1 line
2.27.0
v5 cover efi_loader: add capsule update support
Lukasz,
Quoted 4 lines · AKASHI Takahiro
Lukasz,
Could you take the time to review my patches, especially patch#1 to #4 and #12, please?
A gentle ping.
My patch series are stranded, waiting for your review.
The discussion[1] about UPDATE_TFTP has some impact, particularly, on patch#4, my changes on DFU are essentially independent.
[1] https://lists.denx.de/pipermail/u-boot/2020-August/424716.html
-Takahiro Akashi
Quoted 254 lines
They are crucial as UEFI capsule update support relies on new features introduced by them.
# I don't think I would re-post this patch series as no changes have been made yet.
Thanks,
-Takahiro AkashiQuoted 244 lines · AKASHI Takahiro
Summary
=======
'UpdateCapsule' is one of runtime services defined in UEFI specification and its aim is to allow a caller (OS) to pass information to the firmware, i.e. U-Boot. This is mostly used to update firmware binary on devices by instructions from OS.While 'UpdateCapsule' is a runtime services function, it is, at least initially, supported only before exiting boot services alike other runtime functions, [Get/]SetVariable. This is because modifying storage which may be shared with OS must be carefully designed and there is no general assumption that we can do it.
Therefore, we practically support only "capsule on disk"; any capsule can be handed over to UEFI subsystem as a file on a specific file system.
In this patch series, all the related definitions and structures are given as UEFI specification describes, and basic framework for capsule support is provided. Currently supported is
* firmware update (Firmware Management Protocol or simply FMP)Most of functionality of firmware update is provided by FMP driver and it can be, by nature, system/platform-specific. So you can and should implement your own FMP driver(s) based on your system requirements. Under the current implementation, we provide two basic but generic drivers with two formats:
* FIT image format (as used in TFTP update and dfu)
* raw image formatIt's totally up to users which one, or both, should be used on users' system depending on user requirements.
Quick usage
===========
1. You can create a capsule file with the following host command:$ mkeficapsule [--fit <fit image> | --raw <raw image>] <output file>2. Put the file under:
/EFI/UpdateCapsule of UEFI system partition
3. Specify firmware storage to be updated in "
dfu_alt_info" variable (Please follow README.dfu for details.)==> env set
dfu_alt_info'...'4. After setting up UEFI's OsIndications variable, reboot U-Boot:
OsIndications <=
EFI_OS_INDICATIONS_FILE_CAPSULE_DELIVERY_SUPPORTEDPatch structure
===============
Patch#1-#4,#12: preparatory patches
Patch#5-#11,#13: main part of implementation
Patch#14-#15: utilities
Patch#16-#17: pytests[1] https://git.linaro.org/people/takahiro.akashi/u-boot.git efi/capsule
Prerequisite patches
====================
dfu change by Heinrich[2][2] https://lists.denx.de/pipermail/u-boot/2020-July/420950.html
Test
====
* passed all the pytests which are included in this patch series on sandbox build locally.Please note that the capsule pytest itself won't be run in the CI partly because some specific configuration for sandbox build is required and partly because there is a problem with virt-make-fs. See
test_efi_capsule_firmware.py.Issues
======
* Timing of executing capsules-on-disk
Currently, processing a capsule is triggered only as part of UEFI subsystem initialization. This means that, for example, firmware update, may not take place at system booting time and will potentially be delayed until a first call of any UEFI functions.
=> See patch#5 for my proposal
* A bunch of warnings like
WARNING: Use 'if (IS_ENABLED(CONFIG...))' instead of '#if or #ifdef' where possible
I don't think that fixing those improves anything.
* Add a document inuefi.rstTODO's
======
(Won't be addressed in this series.)
* capsule authentication
* capsule dependency (dependency expression instruction set)
* loading drivers in a capsule
* handling RESET flag in a capsule and QeuryCapsuleCaps
* full semantics of ESRT (EFI System Resource Table)
* enabling capsule API at runtime
* json capsule
* recovery from update failureChanges
=======
v5 (August 3, 2020)
* removed superfluous type conversion atdfu_write_from_mem_addr()(Patch#2)
* introduced a common helper function,efi_create_indexed_name()(Patch#6,#7,#8)
* use efi_[get|set]_variable_int(), if necessary, withREAD_ONLY(Patch#7,#8)
* returnEFI_UNSUPPORTEDat Patch#7
* changed the word, number, to 'index' (Patch#7,#8)
* removed 'ifdefCONFIG_EFI_CAPSULE_ON_DISK' from a header (Patch#8)
* initialize 'CapsuleLast' inefi_init_obj_list()(Patch#7,#8)
* added 'const' qualifier for filename argument at efi_capsule_[read|delete]_file() (Patch#8)v4 (July 22, 2020)
* rebased to Heinrich's current efi-2020-10
* rework dfu-related code to align with Heinrich's change (Patch#1,#3)
* change a type of 'addr' argument from int to 'void *' per Sughosh's comment (Patch#2-#3,#11-#12)
* rework/simplify pytests (Patch#15-#16)
- utilize virt-make-fs
- drop Test Case 1 (updating U-Boot environment data)
- remove useless definitions (MNT_PNT,EFI_CAPSULE_IMAGE_NAME)
- apply autopep8v3 (July 10, 2020)
* rebased to Heinrich's current efi-2020-10-rc1
* refactor efi_firmware_[fit|raw]_get_image_info() (patch#11,#13)v2 (June 17, 2020)
* rebased to v2020.07-rc4
* add preparatory patches for dfu (Patch#1-#5, #12)
* rework FIT capsule driver to utilizedfu_alt_infoinstead ofCONFIG_xxx(patch#11)
* extendget_image_info()to correspond todfu_alt_info(patch#11)
* add a 'raw binary' capsule support
(patch#13, #17)
* allow multiple capsule formats (with different GUIDs) to be installed (patch#11, #13)
* extend mkeficapsule command to accept additional parameters, like version/index/hardware instance for a capsule header info. (patch#15)
* mkeficapsule can now also generate raw-binary capsule (patch#16)
* add function descriptions
* apply autopep8 to pytests and fix more against pylintv1 (April 27, 2020)
* rebased to v2020.07-rc
* removed already-merged patches (RFC's #1 to #4)
* dropped 'variable update' capsule support (RFC's patch#10)
* dropped 'variable configuration table' support (RFC's patch#11) (Those two should be discussed separately.)
* add preparatory patches (patch#1/#2)
* fix several build errors
* rename someKconfigoptions to be aligned with UEFI specification's terms (patch#3,4,6,7)
* enforce UpdateCapsule API to be disabled after ExitBootServices (patch#3)
* use config table,runtime_services_supported, instead of variable (patch#3)
* makeEFI_CAPSULE_ON_DISKbuildable even if UpdateCapsule API is disabled (patch4)
* support OsIndications, invoking capsule-on-disk only if the variable indicates so (patch#4)
* introducedEFI_CAPSULE_ON_DISK_EARLYto invoke capsule-on-disk in U-Boot initialization (patch#4)
* detect capsule files only if they are on EFI system partition (patch#4)
* use printf, rather thanEFI_PRINT, in error cases (patch#4)
* use 'header_size' field to retrieve capsule data, adding sanity checks against capsule size (patch#6)
* call fmpt driver interfaces withEFI_CALL(patch#6)
* remove 'variable update capsule'-related code form mkeficapsule (patch#9)
* add a test case of OsIndications not being set properly (patch#10)
* adjust test scenario forEFI_CAPSULE_ON_DISK_EARLY(patch#10)
* revise pytest scripts (patch#10)Initial release as RFC (March 17, 2020)
AKASHI Takahiro (17):
dfu: renamedfu_tftp_write()todfu_write_by_name()
dfu: modify an argument type for an address
common: update: add a generic interface for FIT image
dfu: exportdfu_list
efi_loader: add option to initialise EFI subsystem early
efi_loader: addefi_create_indexed_name()
efi_loader: define UpdateCapsule api
efi_loader: capsule: addcapsule_on_disksupport
efi_loader: capsule: add memory range capsule definitions
efi_loader: capsule: support firmware update
efi_loader: add firmware management protocol for FIT image
dfu: adddfu_write_by_alt()
efi_loader: add firmware management protocol for raw image
cmd: add "efidebug capsule" command
tools: add mkeficapsule command for UEFI capsule update test/py: add a test for uefi firmware update capsule of FIT image test/py: add a test for uefi firmware update capsule of raw imagecmd/efidebug.c | 235 +++++ common/Kconfig | 14 + common/Makefile | 3 +- common/board_r.c | 6 + common/main.c | 4 + common/update.c | 77 +- drivers/dfu/Kconfig | 6 + drivers/dfu/Makefile | 2 +- drivers/dfu/dfu.c | 2 +- drivers/dfu/dfu_alt.c | 125 +++ drivers/dfu/dfu_tftp.c | 65 -- include/dfu.h | 57 +- include/efi_api.h | 160 +++ include/efi_loader.h | 30 + include/image.h | 12 + lib/efi_loader/Kconfig | 72 ++ lib/efi_loader/Makefile | 2 + lib/efi_loader/efi_capsule.c | 910 ++++++++++++++++++ lib/efi_loader/efi_firmware.c | 398 ++++++++ lib/efi_loader/efi_runtime.c | 104 +- lib/efi_loader/efi_setup.c | 106 +- test/py/tests/test_efi_capsule/conftest.py | 72 ++ test/py/tests/test_efi_capsule/defs.py | 12 + .../test_efi_capsule/test_capsule_firmware.py | 241 +++++ .../tests/test_efi_capsule/uboot_bin_env.its | 36 + tools/Makefile | 3 + tools/mkeficapsule.c | 237 +++++ 27 files changed, 2851 insertions(+), 140 deletions(-) create mode 100644 drivers/dfu/dfu_alt.c delete mode 100644 drivers/dfu/dfu_tftp.c create mode 100644 lib/efi_loader/efi_capsule.c create mode 100644 lib/efi_loader/efi_firmware.c create mode 100644 test/py/tests/test_efi_capsule/conftest.py create mode 100644 test/py/tests/test_efi_capsule/defs.py create mode 100644 test/py/tests/test_efi_capsule/test_capsule_firmware.py create mode 100644 test/py/tests/test_efi_capsule/uboot_bin_env.its create mode 100644 tools/mkeficapsule.cSignature · 1 line
2.27.0
v5 cover efi_loader: add capsule update support
Quoted 8 lines · AKASHI Takahiro
Lukasz,
Quoted 4 lines · AKASHI Takahiro
Lukasz,
Could you take the time to review my patches, especially patch#1 to #4 and #12, please?
Quoted 7 lines
A gentle ping.
My patch series are stranded, waiting for your review.The discussion[1] about
UPDATE_TFTPhas some impact, particularly, on patch#4, my changes on DFU are essentially independent.[1] https://lists.denx.de/pipermail/u-boot/2020-August/424716.html
Do you have time for this review yet Lukasz? While it's too late for this release it would really be good to have this ready to go for when -next opens if possible, or certainly in to -next by the time v2020.10 is released and this can then be merged in. Thanks!
Signature · 8 lines
Tom -------------- next part -------------- A non-text attachment was scrubbed... Name: signature.asc Type: application/pgp-signature Size: 659 bytes Desc: not available URL: <https://lists.denx.de/pipermail/u-boot/attachments/20200831/f18d54b2/attachment.sig>