summaryrefslogtreecommitdiff
path: root/doc/develop
diff options
context:
space:
mode:
authorJonathan Humphreys <j-humphreys@ti.com>2024-06-14 11:35:28 -0500
committerTom Rini <trini@konsulko.com>2024-06-18 10:43:29 -0600
commitcedad0670e5160f82d282e06503f5013f8012424 (patch)
treef398c81ad625f3a5cf09824e2803c9410ed3e0b5 /doc/develop
parent2c92ec69d162c1ac1a6b6ab25324c0e53b4a6ffe (diff)
downloadu-boot-cedad0670e5160f82d282e06503f5013f8012424.tar.gz
u-boot-cedad0670e5160f82d282e06503f5013f8012424.tar.bz2
u-boot-cedad0670e5160f82d282e06503f5013f8012424.zip
doc: uefi: capsules: Add Capsule Update porting section
Created a capsule update porting section in the documentation that outlines the steps a board developer must do when porting from an existing reference board implementation. In particular, added a big warning that new capsule GUID's need to be defined. Signed-off-by: Jonathan Humphreys <j-humphreys@ti.com> Acked-by: Ilias Apalodimas <ilias.apalodimas@linaro.org> Reviewed-by: Ilias Apalodimas <ilias.apalodimas@linaro.org>
Diffstat (limited to 'doc/develop')
-rw-r--r--doc/develop/uefi/uefi.rst12
1 files changed, 12 insertions, 0 deletions
diff --git a/doc/develop/uefi/uefi.rst b/doc/develop/uefi/uefi.rst
index 0389b269c0..36ac75278f 100644
--- a/doc/develop/uefi/uefi.rst
+++ b/doc/develop/uefi/uefi.rst
@@ -631,6 +631,18 @@ where version.dtso looks like::
The properties of image-type-id and image-index must match the value
defined in the efi_fw_image array as image_type_id and image_index.
+Porting Capsule Updates to new boards
+*************************************
+
+It is important, when using a reference board as a starting point for a custom
+board, that certain steps are taken to properly support Capsule Updates.
+
+Capsule GUIDs need to be unique for each firmware and board. That is, if two
+firmwares are built from the same source but result in different binaries
+because they are built for different boards, they should have different GUIDs.
+Therefore it is important when creating support for a new board, new GUIDs are
+defined in the board's header file. *DO NOT* reuse capsule GUIDs.
+
Executing the boot manager
~~~~~~~~~~~~~~~~~~~~~~~~~~