diff options
| author | Antonio Nino Diaz <antonio.ninodiaz@arm.com> | 2019-02-28 13:35:21 +0000 |
|---|---|---|
| committer | Antonio Nino Diaz <antonio.ninodiaz@arm.com> | 2019-02-28 13:35:21 +0000 |
| commit | 73308618fee8afc4518c592956b31864e57e48e7 (patch) | |
| tree | d3aa4921ae1a58dc4f15c4fd311cdf2b58093cbb /docs/user-guide.rst | |
| parent | 1baa28bb2dc79f23c550d67604324afd222221c3 (diff) | |
| download | platform_external_arm-trusted-firmware-73308618fee8afc4518c592956b31864e57e48e7.tar.gz platform_external_arm-trusted-firmware-73308618fee8afc4518c592956b31864e57e48e7.tar.bz2 platform_external_arm-trusted-firmware-73308618fee8afc4518c592956b31864e57e48e7.zip | |
Minor changes to documentation and comments
Fix some typos and clarify some sentences.
Change-Id: Id276d1ced9a991b4eddc5c47ad9a825e6b29ef74
Signed-off-by: Antonio Nino Diaz <antonio.ninodiaz@arm.com>
Diffstat (limited to 'docs/user-guide.rst')
| -rw-r--r-- | docs/user-guide.rst | 26 |
1 files changed, 13 insertions, 13 deletions
diff --git a/docs/user-guide.rst b/docs/user-guide.rst index b42012757..b602956aa 100644 --- a/docs/user-guide.rst +++ b/docs/user-guide.rst @@ -548,13 +548,13 @@ Common build options - ``KEY_ALG``: This build flag enables the user to select the algorithm to be used for generating the PKCS keys and subsequent signing of the certificate. - It accepts 3 values viz. ``rsa``, ``rsa_1_5``, ``ecdsa``. The ``rsa_1_5`` is - the legacy PKCS#1 RSA 1.5 algorithm which is not TBBR compliant and is - retained only for compatibility. The default value of this flag is ``rsa`` - which is the TBBR compliant PKCS#1 RSA 2.1 scheme. + It accepts 3 values: ``rsa``, ``rsa_1_5`` and ``ecdsa``. The option + ``rsa_1_5`` is the legacy PKCS#1 RSA 1.5 algorithm which is not TBBR + compliant and is retained only for compatibility. The default value of this + flag is ``rsa`` which is the TBBR compliant PKCS#1 RSA 2.1 scheme. - ``HASH_ALG``: This build flag enables the user to select the secure hash - algorithm. It accepts 3 values viz. ``sha256``, ``sha384``, ``sha512``. + algorithm. It accepts 3 values: ``sha256``, ``sha384`` and ``sha512``. The default value of this flag is ``sha256``. - ``LDFLAGS``: Extra user options appended to the linkers' command line in @@ -619,14 +619,14 @@ Common build options does not need to be implemented in this case. - ``PSCI_EXTENDED_STATE_ID``: As per PSCI1.0 Specification, there are 2 formats - possible for the PSCI power-state parameter viz original and extended - State-ID formats. This flag if set to 1, configures the generic PSCI layer - to use the extended format. The default value of this flag is 0, which - means by default the original power-state format is used by the PSCI - implementation. This flag should be specified by the platform makefile - and it governs the return value of PSCI_FEATURES API for CPU_SUSPEND - smc function id. When this option is enabled on Arm platforms, the - option ``ARM_RECOM_STATE_ID_ENC`` needs to be set to 1 as well. + possible for the PSCI power-state parameter: original and extended State-ID + formats. This flag if set to 1, configures the generic PSCI layer to use the + extended format. The default value of this flag is 0, which means by default + the original power-state format is used by the PSCI implementation. This flag + should be specified by the platform makefile and it governs the return value + of PSCI_FEATURES API for CPU_SUSPEND smc function id. When this option is + enabled on Arm platforms, the option ``ARM_RECOM_STATE_ID_ENC`` needs to be + set to 1 as well. - ``RAS_EXTENSION``: When set to ``1``, enable Armv8.2 RAS features. RAS features are an optional extension for pre-Armv8.2 CPUs, but are mandatory for Armv8.2 |