diff options
author | Jeenu Viswambharan <jeenu.viswambharan@arm.com> | 2017-09-22 08:32:09 +0100 |
---|---|---|
committer | Jeenu Viswambharan <jeenu.viswambharan@arm.com> | 2017-10-16 16:50:01 +0100 |
commit | cbd3f3706d4217ee3669deeb52b158e84eb97f56 (patch) | |
tree | dd37e90333a8626cf970cee0951dd90503ca9cef /docs | |
parent | ca43b55d22f3a48f408d16d4bedbf677cbdf8f48 (diff) | |
download | platform_external_arm-trusted-firmware-cbd3f3706d4217ee3669deeb52b158e84eb97f56.tar.gz platform_external_arm-trusted-firmware-cbd3f3706d4217ee3669deeb52b158e84eb97f56.tar.bz2 platform_external_arm-trusted-firmware-cbd3f3706d4217ee3669deeb52b158e84eb97f56.zip |
GIC: Add API to get interrupt active status
API documentation updated.
Change-Id: I6d61785af0d5330930c709de971a904dc7c3516c
Co-authored-by: Yousuf A <yousuf.sait@arm.com>
Signed-off-by: Jeenu Viswambharan <jeenu.viswambharan@arm.com>
Diffstat (limited to 'docs')
-rw-r--r-- | docs/platform-interrupt-controller-API.rst | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/docs/platform-interrupt-controller-API.rst b/docs/platform-interrupt-controller-API.rst index a94a90c75..d0a2ad276 100644 --- a/docs/platform-interrupt-controller-API.rst +++ b/docs/platform-interrupt-controller-API.rst @@ -66,6 +66,21 @@ as a Software Generated Interrupt. Software Generated Interrupts are raised by explicit programming by software, and are typically used in inter-PE communication. Secure SGIs are reserved for use by Secure world software. +Function: unsigned int plat_ic_get_interrupt_active(unsigned int id); [optional] +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +:: + + Argument : unsigned int + Return : int + +This API should return the *active* status of the interrupt ID specified by the +first parameter, ``id``. + +In case of ARM standard platforms using GIC, the implementation of the API reads +the GIC *Set Active Register* to read and return the active status of the +interrupt. + ---- *Copyright (c) 2017, ARM Limited and Contributors. All rights reserved.* |