diff options
| author | Bipin Ravi <bipin.ravi@arm.com> | 2023-02-23 23:38:26 +0100 |
|---|---|---|
| committer | TrustedFirmware Code Review <review@review.trustedfirmware.org> | 2023-02-23 23:38:26 +0100 |
| commit | dc2b8e8028c73a4c7a72d138caa26dc447a1d79a (patch) | |
| tree | 4b7eafb290878679a495f3817b51207a86dd8e7a /docs/getting_started | |
| parent | 66a387d43786cf06f1b437327a7a5e475aa301c7 (diff) | |
| parent | 17d07a552b396a282eed52bfd6bac01052a1a978 (diff) | |
| download | arm-trusted-firmware-dc2b8e8028c73a4c7a72d138caa26dc447a1d79a.tar.gz | |
Merge changes from topic "panic_cleanup" into integration
* changes:
refactor(bl31): use elx_panic for sysreg_handler64
refactor(aarch64): rename do_panic and el3_panic
refactor(aarch64): remove weak links to el3_panic
refactor(aarch64): refactor usage of elx_panic
refactor(aarch64): cleanup HANDLE_EA_EL3_FIRST_NS usage
Diffstat (limited to 'docs/getting_started')
| -rw-r--r-- | docs/getting_started/porting-guide.rst | 22 |
1 files changed, 16 insertions, 6 deletions
diff --git a/docs/getting_started/porting-guide.rst b/docs/getting_started/porting-guide.rst index ec0a4689c..0e4d1e31c 100644 --- a/docs/getting_started/porting-guide.rst +++ b/docs/getting_started/porting-guide.rst @@ -3204,9 +3204,20 @@ as Group 0 secure interrupt, Group 1 secure interrupt or Group 1 NS interrupt. Common helper functions ----------------------- +Function : elx_panic() +~~~~~~~~~~~~~~~~~~~~~~ -Function : do_panic() -~~~~~~~~~~~~~~~~~~~~~ +:: + + Argument : void + Return : void + +This API is called from assembly files when reporting a critical failure +that has occured in lower EL and is been trapped in EL3. This call +**must not** return. + +Function : el3_panic() +~~~~~~~~~~~~~~~~~~~~~~ :: @@ -3214,9 +3225,8 @@ Function : do_panic() Return : void This API is called from assembly files when encountering a critical failure that -cannot be recovered from. It also invokes elx_panic() which allows to report a -crash from lower exception level. This function assumes that it is invoked from -a C runtime environment i.e. valid stack exists. This call **must not** return. +cannot be recovered from. This function assumes that it is invoked from a C +runtime environment i.e. valid stack exists. This call **must not** return. Function : panic() ~~~~~~~~~~~~~~~~~~ @@ -3228,7 +3238,7 @@ Function : panic() This API called from C files when encountering a critical failure that cannot be recovered from. This function in turn prints backtrace (if enabled) and calls -do_panic(). This call **must not** return. +el3_panic(). This call **must not** return. Crash Reporting mechanism (in BL31) ----------------------------------- |