doc(ff-a): add HOB list boot info descriptor
Add support for Hand-off Block (HOB) list boot information descriptor
and how an SP can subsribe to HOB list boot information in its manifest.
Signed-off-by: Kathleen Capella <kathleen.capella@arm.com>
Change-Id: Ic644c90b6462f94612e994e38989b94ae102a5f3
diff --git a/docs/secure-partition-manager/secure-partition-manager.rst b/docs/secure-partition-manager/secure-partition-manager.rst
index f4fb4e8..61d76e9 100644
--- a/docs/secure-partition-manager/secure-partition-manager.rst
+++ b/docs/secure-partition-manager/secure-partition-manager.rst
@@ -576,8 +576,8 @@
the boot information blob, and is passed to a Partition as a contiguous memory
region.
-Currently, the SPM implementation supports the FDT type which is used to pass the
-partition's DTB manifest.
+Currently, the SPM implementation supports the FDT type, which is used to pass the
+partition's DTB manifest, and the Hand-off Block (HOB) list type.
The region for the boot information blob is allocated through the SP package.
@@ -588,6 +588,9 @@
the manifest offset. If no offset is provided the manifest offset defaults to 0x1000,
which is the page size in the Hafnium SPMC.
+Currently, the SPM implementation does not yet support specifying the offset for the
+HOB list in the json description of the SP. A default value of 0x2000 is used.
+
The configuration of the boot protocol is done in the SPs manifest. As defined by
the specification, the manifest field 'gp-register-num' configures the GP register
which shall be used to pass the address to the partitions boot information blob when
@@ -602,11 +605,18 @@
ffa_manifest;
};
+.. code:: shell
+
+ boot-info {
+ compatible = "arm,ffa-manifest-boot-info";
+ hob_list;
+ };
+
The whole secure partition package image (see `Secure Partition packages`_) is
mapped to the SP secure EL1&0 Stage-2 translation regime. As such, the SP can
retrieve the address for the boot information blob in the designated GP register,
process the boot information header and descriptors, access its own manifest
-DTB blob and extract its partition manifest properties.
+DTB blob or HOB list and extract its properties.
SPMC Runtime
============