From 43997d2257422c0f05c9adf4d5a14dae5e59ef5b Mon Sep 17 00:00:00 2001 From: Manish V Badarkhe Date: Thu, 21 Oct 2021 09:06:18 +0100 Subject: [PATCH] docs(measured-boot): add a platform function for critical data Added a platform function to measure the critical data and record its measurement. Also, corrected a return value of 'plat_mboot_measure_image' function in the documentation. Signed-off-by: Manish V Badarkhe Change-Id: I576676f654e517c2010ca1d5a87a1f7277d581c3 --- docs/getting_started/porting-guide.rst | 22 ++++++++++++++++++++-- 1 file changed, 20 insertions(+), 2 deletions(-) diff --git a/docs/getting_started/porting-guide.rst b/docs/getting_started/porting-guide.rst index 92ff39fdd..24af13e76 100644 --- a/docs/getting_started/porting-guide.rst +++ b/docs/getting_started/porting-guide.rst @@ -1195,7 +1195,7 @@ Function : plat_mboot_measure_image() :: Argument : unsigned int, image_info_t * - Return : void + Return : int When the MEASURED_BOOT flag is enabled: @@ -1204,7 +1204,25 @@ When the MEASURED_BOOT flag is enabled: - 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 negative error code otherwise. +- 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.