Commit ba789770 authored by Sandrine Bailleux's avatar Sandrine Bailleux
Browse files

Porting guide: Improve bl1_plat_mem_check() doc



This patch fixes the type of the return value of bl1_plat_mem_check()
in the porting guide. It also specifies the expected return value.

Change-Id: I7c437342b8bfb1e621d74b2edf0aaf97b913216a
Signed-off-by: default avatarSandrine Bailleux <sandrine.bailleux@arm.com>
parent 9c4c18fa
...@@ -1087,13 +1087,15 @@ The default implementation spins forever. ...@@ -1087,13 +1087,15 @@ The default implementation spins forever.
Argument : uintptr_t mem_base, unsigned int mem_size, Argument : uintptr_t mem_base, unsigned int mem_size,
unsigned int flags unsigned int flags
Return : void Return : int
BL1 calls this function while handling FWU copy and authenticate SMCs. The BL1 calls this function while handling FWU copy and authenticate SMCs. The
platform must ensure that the provided `mem_base` and `mem_size` are mapped into platform must ensure that the provided `mem_base` and `mem_size` are mapped into
BL1, and that this memory corresponds to either a secure or non-secure memory BL1, and that this memory corresponds to either a secure or non-secure memory
region as indicated by the security state of the `flags` argument. region as indicated by the security state of the `flags` argument.
This function must return 0 on success, a non-null error code otherwise.
The default implementation of this function asserts therefore platforms must The default implementation of this function asserts therefore platforms must
override it when using the FWU feature. override it when using the FWU feature.
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment