Docs: Fix some document build warnings
Fix some duplicated labels warnings and code block language warnings.
Change-Id: Ic25be83273fb8eac3a3ff4c2b98182ff268cb3dd
Signed-off-by: David Hu <david.hu@arm.com>
diff --git a/docs/technical_references/tfm_fwu_service.rst b/docs/technical_references/tfm_fwu_service.rst
index 6d90de4..8577841 100644
--- a/docs/technical_references/tfm_fwu_service.rst
+++ b/docs/technical_references/tfm_fwu_service.rst
@@ -66,7 +66,7 @@
***********************
Service API description
***********************
-This service follows the `Firmware Update API <https://developer.arm.com/documentation/ihi0093/0000/>`_ spec of version 0.7.
+This service follows the PSA Firmware Update API spec of version 0.7 [1]_.
It implements the mandatory interface functions listed in section 5.1 and the
optional interface ``psa_fwu_accept()``. Please refer to Firmware Update spec
for the detailed description.
@@ -108,26 +108,25 @@
fwu_bootloader_staging_area_init(function)
------------------------------------------
-Prototype
-^^^^^^^^^
+**Prototype**
+
.. code-block:: c
psa_status_t fwu_bootloader_staging_area_init(bl_image_id_t bootloader_image_id);
-Description
-^^^^^^^^^^^
+**Description**
+
Prepare the staging area of the image with the given ID for image download.
For example, initialize the staging area, open the flash area, and so on.
The image will be written into the staging area later.
-Parameters
-^^^^^^^^^^
+**Parameters**
+
- ``bootloader_image_id``: The identifier of the target image in bootloader.
fwu_bootloader_load_image(function)
-----------------------------------
-Prototype
-^^^^^^^^^
+**Prototype**
.. code-block:: c
@@ -136,12 +135,12 @@
const void *block,
size_t block_size);
-Description
-^^^^^^^^^^^
+**Description**
+
Load the image to its staging area.
-Parameters
-^^^^^^^^^^
+**Parameters**
+
- ``bootloader_image_id``: The identifier of the target image in bootloader.
- ``image_offset``: The offset of the image being passed into block, in bytes.
- ``block``: A buffer containing a block of image data. This might be a complete image or a subset.
@@ -149,78 +148,78 @@
fwu_bootloader_install_image(function)
---------------------------------------------
-Prototype
-^^^^^^^^^
+**Prototype**
+
.. code-block:: c
psa_status_t fwu_bootloader_install_image(bl_image_id_t bootloader_image_id,
bl_image_id_t *dependency,
psa_image_version_t *dependency_version);
-Description
-^^^^^^^^^^^
+**Description**
+
Check the authenticity and integrity of the image. If a reboot is required to
complete the check, then mark this image as a candidate so that the next time
bootloader runs it will take this image as a candidate one to bootup. Return
the error code PSA_SUCCESS_REBOOT.
-Parameters
-^^^^^^^^^^
+**Parameters**
+
- ``bootloader_image_id``: The identifier of the target image in bootloader.
- ``dependency``: Bootloader image ID of dependency if needed.
- ``dependency_version``: Bootloader image version of dependency if needed.
fwu_bootloader_mark_image_accepted(function)
--------------------------------------------
-Prototype
-^^^^^^^^^
+**Prototype**
+
.. code-block:: c
psa_status_t fwu_bootloader_mark_image_accepted(void);
-Description
-^^^^^^^^^^^
+**Description**
+
Call this API to mark the running images as permanent/accepted to avoid
revert when next time bootup. Usually, this API is called after the running
images have been verified as valid.
-Parameters
-^^^^^^^^^^
+**Parameters**
+
N/A
fwu_bootloader_abort(function)
------------------------------
-Prototype
-^^^^^^^^^
+**Prototype**
+
.. code-block:: c
psa_status_t fwu_bootloader_abort(void);
-Description
-^^^^^^^^^^^
+**Description**
+
Abort the current image download process.
-Parameters
-^^^^^^^^^^
+**Parameters**
+
N/A
fwu_bootloader_get_image_info(function)
---------------------------------------
-Prototype
-^^^^^^^^^
+**Prototype**
+
.. code-block:: c
psa_status_t fwu_bootloader_get_image_info(bl_image_id_t bootloader_image_id,
bool staging_area,
tfm_image_info_t *info);
-Description
-^^^^^^^^^^^
+**Description**
+
Get the image information of the given bootloader_image_id in the staging area
or the running area.
-Parameters
-^^^^^^^^^^
+**Parameters**
+
- ``bootloader_image_id``: The identifier of the target image in bootloader.
- ``active_image``: Indicates image location.
@@ -271,9 +270,9 @@
Implement the FWU functionality in the non-secure side
======================================================
-The Firmware Update APIs listed in `User interfaces`_ can also be implemented
-in the non-secure side. The library model implementation can be referred to for
-the non-secure side implementation.
+The APIs listed in PSA Firmware Update API spec [1]_ can also be implemented in
+the non-secure side. The library model implementation can be referred to for the
+non-secure side implementation.
Pros and Cons for Implementing FWU APIs in Secure Side
======================================================
@@ -310,4 +309,12 @@
the Firmware Update APIs in the non-secure side based on the pros and cons
analysis above.
+*********
+Reference
+*********
+
+.. [1] `PSA Firwmare Update API <https://developer.arm.com/documentation/ihi0093/0000/>`_
+
+--------------
+
*Copyright (c) 2021, Arm Limited. All rights reserved.*