diff options
| author | Soby Mathew <soby.mathew@arm.com> | 2019-09-13 15:22:23 +0000 |
|---|---|---|
| committer | TrustedFirmware Code Review <review@review.trustedfirmware.org> | 2019-09-13 15:22:23 +0000 |
| commit | 6129e9a643274e658a0e6f5428ad976676c7bb7a (patch) | |
| tree | 04ab176ebe7086290e4f788566d3d25b647a086f /docs | |
| parent | 2cb662f3d0676099d469478be17e5889014677e6 (diff) | |
| parent | ed108b56051de5da8024568a06781ce287e86c78 (diff) | |
Merge "Refactor ARMv8.3 Pointer Authentication support code" into integration
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/getting_started/porting-guide.rst | 12 | ||||
| -rw-r--r-- | docs/getting_started/user-guide.rst | 6 |
2 files changed, 9 insertions, 9 deletions
diff --git a/docs/getting_started/porting-guide.rst b/docs/getting_started/porting-guide.rst index b327f6ee..5786dd38 100644 --- a/docs/getting_started/porting-guide.rst +++ b/docs/getting_started/porting-guide.rst @@ -1796,21 +1796,21 @@ defined by the translation library, and can be found in the file On DynamIQ systems, this function must not use stack while enabling MMU, which is how the function in xlat table library version 2 is implemented. -Function : plat_init_apiakey [optional] -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Function : plat_init_apkey [optional] +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ :: Argument : void - Return : uint64_t * + Return : uint128_t -This function populates the ``plat_apiakey`` array that contains the values used -to set the ``APIAKey{Hi,Lo}_EL1`` registers. It returns a pointer to this array. +This function returns the 128-bit value which can be used to program ARMv8.3 +pointer authentication keys. The value should be obtained from a reliable source of randomness. This function is only needed if ARMv8.3 pointer authentication is used in the -Trusted Firmware by building with ``ENABLE_PAUTH=1``. +Trusted Firmware by building with ``BRANCH_PROTECTION`` option set to non-zero. Function : plat_get_syscnt_freq2() [mandatory] ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/docs/getting_started/user-guide.rst b/docs/getting_started/user-guide.rst index 015de9a6..44bfb7a3 100644 --- a/docs/getting_started/user-guide.rst +++ b/docs/getting_started/user-guide.rst @@ -324,8 +324,9 @@ Common build options - ``BRANCH_PROTECTION``: Numeric value to enable ARMv8.3 Pointer Authentication and ARMv8.5 Branch Target Identification support for TF-A BL images themselves. - If enabled, it is needed to use a compiler that supports the option - ``-mbranch-protection``. Selects the branch protection features to use: + If enabled, it is needed to use a compiler (e.g GCC 9.1 and later versions) that + supports the option ``-mbranch-protection``. + Selects the branch protection features to use: - 0: Default value turns off all types of branch protection - 1: Enables all types of branch protection features - 2: Return address signing to its standard level @@ -836,7 +837,6 @@ Common build options cluster platforms). If this option is enabled, then warm boot path enables D-caches immediately after enabling MMU. This option defaults to 0. - Arm development platform specific build options ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |