From a1c93550bc728d3cbd20e323aefc8d2d08e93011 Mon Sep 17 00:00:00 2001 From: Manish V Badarkhe Date: Thu, 15 Jun 2023 10:34:05 +0100 Subject: [PATCH] docs: remove redundant Measured Boot interface info A separate design document for Measured Boot covers the porting guidelines for the Measured Boot interfaces. As a result, the Measured Boot interfaces have been removed from the porting guide and a link to the Measured Boot design document has been provided. Change-Id: Ia6bd2620d830aea6aececab4af7e10a6d737f025 Signed-off-by: Manish V Badarkhe --- docs/porting-guide.rst | 115 +++-------------------------------------- 1 file changed, 6 insertions(+), 109 deletions(-) diff --git a/docs/porting-guide.rst b/docs/porting-guide.rst index b557a1695..f07402189 100644 --- a/docs/porting-guide.rst +++ b/docs/porting-guide.rst @@ -1509,43 +1509,6 @@ This function returns SMC_ARCH_CALL_SUCCESS if the platform supports the SMCCC function specified in the argument; otherwise returns SMC_ARCH_CALL_NOT_SUPPORTED. -Function : plat_mboot_measure_image() -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -:: - - Argument : unsigned int, image_info_t * - Return : int - -When the MEASURED_BOOT flag is enabled: - -- This function measures the given image and records its measurement using - the measured boot backend driver. -- On the Arm FVP port, this function measures the given image using its - passed id and information and then records that measurement in the - Event Log buffer. -- This function must return 0 on success, a signed integer error code - otherwise. - -When the MEASURED_BOOT flag is disabled, this function doesn't do anything. - -Function : plat_mboot_measure_critical_data() -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -:: - - Argument : unsigned int, const void *, size_t - Return : int - -When the MEASURED_BOOT flag is enabled: - -- This function measures the given critical data structure and records its - measurement using the measured boot backend driver. -- This function must return 0 on success, a signed integer error code - otherwise. - -When the MEASURED_BOOT flag is disabled, this function doesn't do anything. - Function : plat_can_cmo() ~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -1813,42 +1776,6 @@ This function must return 0 on success, a non-null error code otherwise. The default implementation of this function asserts therefore platforms must override it when using the FWU feature. -Function : bl1_plat_mboot_init() [optional] -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -:: - - Argument : void - Return : void - -When the MEASURED_BOOT flag is enabled: - -- This function is used to initialize the backend driver(s) of measured boot. -- On the Arm FVP port, this function is used to initialize the Event Log - backend driver, and also to write header information in the Event Log buffer. - -When the MEASURED_BOOT flag is disabled, this function doesn't do anything. - -Function : bl1_plat_mboot_finish() [optional] -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -:: - - Argument : void - Return : void - -When the MEASURED_BOOT flag is enabled: - -- This function is used to finalize the measured boot backend driver(s), - and also, set the information for the next bootloader component to - extend the measurement if needed. -- On the Arm FVP port, this function is used to pass the base address of - the Event Log buffer and its size to BL2 via tb_fw_config to extend the - Event Log buffer with the measurement of various images loaded by BL2. - It results in panic on error. - -When the MEASURED_BOOT flag is disabled, this function doesn't do anything. - Boot Loader Stage 2 (BL2) ------------------------- @@ -1980,42 +1907,6 @@ element in the boot sequence. If there are no more boot sources then it must return 0, otherwise it must return 1. The default implementation of this always returns 0. -Function : bl2_plat_mboot_init() [optional] -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -:: - - Argument : void - Return : void - -When the MEASURED_BOOT flag is enabled: - -- This function is used to initialize the backend driver(s) of measured boot. -- On the Arm FVP port, this function is used to initialize the Event Log - backend driver with the Event Log buffer information (base address and - size) received from BL1. It results in panic on error. - -When the MEASURED_BOOT flag is disabled, this function doesn't do anything. - -Function : bl2_plat_mboot_finish() [optional] -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -:: - - Argument : void - Return : void - -When the MEASURED_BOOT flag is enabled: - -- This function is used to finalize the measured boot backend driver(s), - and also, set the information for the next bootloader component to extend - the measurement if needed. -- On the Arm FVP port, this function is used to pass the Event Log buffer - information (base address and size) to non-secure(BL33) and trusted OS(BL32) - via nt_fw and tos_fw config respectively. It results in panic on error. - -When the MEASURED_BOOT flag is disabled, this function doesn't do anything. - Boot Loader Stage 2 (BL2) at EL3 -------------------------------- @@ -3664,6 +3555,12 @@ by the drivers and callers, as the system does not yet provide a means of dynamically allocating memory. This may also have the affect of limiting the amount of open resources per driver. +Measured Boot Platform Interface +-------------------------------- + +Enabling the MEASURED_BOOT flag adds extra platform requirements. Please refer +to :ref:`Measured Boot Design` for more details. + -------------- *Copyright (c) 2013-2023, Arm Limited and Contributors. All rights reserved.*