andrius
/
arm-trusted-firmware
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

doc: Fix plat_sdei_validate_entry_point() documentation 

Document the second argument of the function.
Minor rewording.

Change-Id: I190794b8cc74c99db4cfe6efc225217c32dd0774
Signed-off-by: Sandrine Bailleux <sandrine.bailleux@arm.com>
This commit is contained in:
Sandrine Bailleux 2020-05-15 12:05:51 +02:00
parent beff491075
commit b62a5313ef
1 changed files with 14 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
docs/getting_started/porting-guide.rst
View File

@ -1956,23 +1956,27 @@ be higher than Normal |SDEI| priority.
Functions Functions
......... .........
Function: int plat_sdei_validate_entry_point(uintptr_t ep) [optional] Function: int plat_sdei_validate_entry_point() [optional]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
:: ::
Argument: uintptr_t Argument: uintptr_t ep, unsigned int client_mode
Return: int Return: int
This function validates the address of client entry points provided for both This function validates the entry point address of the event handler provided by
event registration and *Complete and Resume* |SDEI| calls. The function the client for both event registration and *Complete and Resume* |SDEI| calls.
takes one argument, which is the address of the handler the |SDEI| client The function ensures that the address is valid in the client translation regime.
requested to register. The function must return ``0`` for successful validation,
or ``-1`` upon failure. The second argument is the exception level that the client is executing in. It
can be Non-Secure EL1 or Non-Secure EL2.
The function must return ``0`` for successful validation, or ``-1`` upon failure.
The default implementation always returns ``0``. On Arm platforms, this function The default implementation always returns ``0``. On Arm platforms, this function
is implemented to translate the entry point to physical address, and further to translates the entry point address within the client translation regime and
ensure that the address is located in Non-secure DRAM. further ensures that the resulting physical address is located in Non-secure
DRAM.
Function: void plat_sdei_handle_masked_trigger(uint64_t mpidr, unsigned int intr) [optional] Function: void plat_sdei_handle_masked_trigger(uint64_t mpidr, unsigned int intr) [optional]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^