diff options
| author | Manish Pandey <manish.pandey2@arm.com> | 2022-11-02 16:30:09 +0000 |
|---|---|---|
| committer | Manish Pandey <manish.pandey2@arm.com> | 2022-11-08 14:09:33 +0000 |
| commit | 5988a807673c861ea2b14dbedfc9e25e0a9a6d4a (patch) | |
| tree | 6cdcd05b3f234d5a9b0409179a3c1b3590e6ff11 /docs/getting_started/psci-lib-integration-guide.rst | |
| parent | 46cc41d5592a16f702f7f0c0c41f8948a3e11cda (diff) | |
| download | arm-trusted-firmware-5988a807673c861ea2b14dbedfc9e25e0a9a6d4a.tar.gz | |
docs: document do_panic() and panic() helper functions
panic() and do_panic() are widely used helper functions called when
encountering a critical failure that cannot be recovered from.
Document them in porting guide. Also, remove panic() documentation
from PSCI guide(where it is unused anyways).
Signed-off-by: Manish Pandey <manish.pandey2@arm.com>
Change-Id: Ib0965cce56c03d0de5ac0d05d5714a6942793ede
Diffstat (limited to 'docs/getting_started/psci-lib-integration-guide.rst')
| -rw-r--r-- | docs/getting_started/psci-lib-integration-guide.rst | 10 |
1 files changed, 0 insertions, 10 deletions
diff --git a/docs/getting_started/psci-lib-integration-guide.rst b/docs/getting_started/psci-lib-integration-guide.rst index 37352659d..4d690a978 100644 --- a/docs/getting_started/psci-lib-integration-guide.rst +++ b/docs/getting_started/psci-lib-integration-guide.rst @@ -337,16 +337,6 @@ at address ``addr`` (first argument) address and of size ``size`` (second argume This function invalidates (flushes) the data cache for memory at address ``addr`` (first argument) address and of size ``size`` (second argument). -**Function : do_panic()** - -:: - - Argument : void - Return : void - -This function will be called by the PSCI library on encountering a critical -failure that cannot be recovered from. This function **must not** return. - CPU Context management API ~~~~~~~~~~~~~~~~~~~~~~~~~~ |