From a5bb389a8292a6d8e14c1b38ef83414165fbbcf1 Mon Sep 17 00:00:00 2001 From: Louis Mayencourt Date: Fri, 27 Mar 2020 11:49:20 +0000 Subject: [PATCH] doc: Fix "unexpected indentation" warning. Signed-off-by: Louis Mayencourt Change-Id: I521eed6466fdfef18a92f5237912cb402441044a --- docs/change-log.rst | 4 +++- docs/components/fconf.rst | 3 +++ docs/components/index.rst | 1 + docs/components/spci-manifest-binding.rst | 14 ++++++++++++++ 4 files changed, 21 insertions(+), 1 deletion(-) diff --git a/docs/change-log.rst b/docs/change-log.rst index cf5b57ac6..7e072a930 100644 --- a/docs/change-log.rst +++ b/docs/change-log.rst @@ -17,6 +17,7 @@ New Features - Enable Memory Tagging Extension (MTE) support in both secure and non-secure worlds + - Adds support for the new Memory Tagging Extension arriving in ARMv8.5. MTE support is now enabled by default on systems that support it at EL0. @@ -84,6 +85,7 @@ New Features - gicv3: Enabled multi-socket GIC redistributor frame discovery and migrated ARM platforms to the new API + - Adds ``gicv3_rdistif_probe`` function that delegates the responsibility of discovering the corresponding redistributor base frame to each CPU itself. @@ -2841,7 +2843,7 @@ releases of TF-A. -------------- -*Copyright (c) 2013-2019, Arm Limited and Contributors. All rights reserved.* +*Copyright (c) 2013-2020, Arm Limited and Contributors. All rights reserved.* .. _SDEI Specification: http://infocenter.arm.com/help/topic/com.arm.doc.den0054a/ARM_DEN0054A_Software_Delegated_Exception_Interface.pdf .. _tf-issue#501: https://github.com/ARM-software/tf-issues/issues/501 diff --git a/docs/components/fconf.rst b/docs/components/fconf.rst index 385660083..7352ac37a 100644 --- a/docs/components/fconf.rst +++ b/docs/components/fconf.rst @@ -107,6 +107,7 @@ As mentioned above, properties are logically grouped around namespaces and sub-namespaces. The following concepts should be considered when adding new properties/namespaces. The framework differentiates two types of properties: + - Properties used inside common code. - Properties used inside platform specific code. @@ -114,6 +115,7 @@ The first category applies to properties being part of the firmware and shared across multiple platforms. They should be globally accessible and defined inside the ``lib/fconf`` directory. The namespace must be chosen to reflect the feature/data abstracted. + Example: - |TBBR| related properties: tbbr.cot.bl2_id - Dynamic configuration information: dyn_cfg.dtb_info.hw_config_id @@ -123,6 +125,7 @@ within the framework: Platform specific properties. They must be accessed only within the platform API and are defined only inside the platform scope. The namespace must contain the platform name under which the properties defined belong. + Example: - Arm io framework: arm.io_policies.bl31_id diff --git a/docs/components/index.rst b/docs/components/index.rst index ae78b2bd1..49986ca00 100644 --- a/docs/components/index.rst +++ b/docs/components/index.rst @@ -17,4 +17,5 @@ Components romlib-design sdei secure-partition-manager-design + spci-manifest-binding xlat-tables-lib-v2-design diff --git a/docs/components/spci-manifest-binding.rst b/docs/components/spci-manifest-binding.rst index 66cca643b..584816911 100644 --- a/docs/components/spci-manifest-binding.rst +++ b/docs/components/spci-manifest-binding.rst @@ -16,6 +16,7 @@ spci-manifest-partition minor versions fo the device tree binding for the SPCI manifest represented by this node. The minor number is incremented if the binding changes in a backwards compatible manner. + - X is an integer representing the major version number of this document. - Y is an integer representing the minor version number of this document. @@ -23,6 +24,7 @@ spci-manifest-partition - value type: - Must be two 16 bits values (X, Y), concatenated as 31:16 -> X, 15:0 -> Y, where: + - X is the major version of PSA-FF-A expected by the partition at the SPCI instance it will execute. - Y is the minor version of PSA-FF-A expected by the partition at the SPCI @@ -34,10 +36,12 @@ spci-manifest-partition implemented by this partition. The UUID format is described in RFC 4122. UUID can be shared by multiple instances of partitions that offer the same service For example: + - If there are multiple instances of a Trusted OS, then the UUID can be shared by all instances. - The TEE driver in the HLOS can use the UUID with the SPCI_PARTITION_INFO_GET interface to determine the: + - Number of Trusted OSs - The partition ID of each instance of the Trusted OS @@ -56,6 +60,7 @@ spci-manifest-partition - execution-ctx-count [mandatory] - value type: - Number of vCPUs that a VM or SP wants to instantiate. + - In the absence of virtualization, this is the number of execution contexts that a partition implements. - If value of this field = 1 and number of PEs > 1 then the partition is @@ -66,6 +71,7 @@ spci-manifest-partition - exception-level [mandatory] - value type: - The target exception level for the partition: + - 0x0: EL1 - 0x1: S_EL0 - 0x2: S_EL1 @@ -76,6 +82,7 @@ spci-manifest-partition - execution-state [mandatory] - value type: - The target execution state of the partition: + - 0: AArch64 - 1: AArch32 @@ -94,6 +101,7 @@ spci-manifest-partition - xlat-granule [mandatory] - value type: - Translation granule used with the partition: + - 0x0: 4k - 0x1: 16k - 0x2: 32k @@ -113,6 +121,7 @@ spci-manifest-partition - messaging-method [mandatory] - value type: - Specifies which messaging methods are supported by the partition: + - 0x0: direct messaging method - 0x1: indirect messaging method - 0x2: both direct and indirect messaging methods @@ -125,6 +134,7 @@ spci-manifest-partition - run-time-model - value type: - Run time model that the SPM must enforce for this SP: + - 0x0: Run to completion - 0x1: Preemptible @@ -195,6 +205,7 @@ device-regions - reg [mandatory] - value type: - A (address, num-pages) pair describing the device, where: + - address: The physical base address value of the device MMIO region. - num-pages: The number of pages of the region. The total size of @@ -214,15 +225,18 @@ device-regions - stream-ids [mandatory] - value type: - A list of (id, mem-manage) pair, where: + - id: A unique value amongst all devices assigned to the partition. - mem-manage: A value used in memory management operations. - interrupts [mandatory] - value type: - A list of (id, attributes) pair describing the device interrupts, where: + - id: The interrupt IDs. - attributes: A ?? TO DEFINE value, containing the attributes for each interrupt ID: + - Interrupt type: SPI, PPI, SGI - Interrupt configuration: Edge triggered, Level triggered - Interrupt security state: Secure, Non-secure