[rtems commit] bsps/irq: Clarify interrupt vector operations
Sebastian Huber
sebh at rtems.org
Fri Feb 10 14:58:07 UTC 2023
Module: rtems
Branch: master
Commit: 519e288a9615ccea12f528c9b49e633baab24c1e
Changeset: http://git.rtems.org/rtems/commit/?id=519e288a9615ccea12f528c9b49e633baab24c1e
Author: Sebastian Huber <sebastian.huber at embedded-brains.de>
Date: Fri Feb 10 08:43:25 2023 +0100
bsps/irq: Clarify interrupt vector operations
Clarify that the presence of error conditions is
implementation-defined.
Close #4843.
---
bsps/include/bsp/irq-generic.h | 27 +++++++++++++++++++++------
1 file changed, 21 insertions(+), 6 deletions(-)
diff --git a/bsps/include/bsp/irq-generic.h b/bsps/include/bsp/irq-generic.h
index bbfb1979f4..abbf96edb6 100644
--- a/bsps/include/bsp/irq-generic.h
+++ b/bsps/include/bsp/irq-generic.h
@@ -259,7 +259,10 @@ rtems_status_code bsp_interrupt_vector_is_enabled(
* @retval ::RTEMS_SUCCESSFUL The requested operation was successful.
*
* @retval ::RTEMS_UNSATISFIED The request to enable the interrupt vector has
- * not been satisfied.
+ * not been satisfied. The presence of this error condition is
+ * implementation-defined. The interrupt vector attributes obtained by
+ * rtems_interrupt_get_attributes() should indicate if it is possible to
+ * enable a particular interrupt vector.
*/
rtems_status_code bsp_interrupt_vector_enable( rtems_vector_number vector );
@@ -280,7 +283,10 @@ rtems_status_code bsp_interrupt_vector_enable( rtems_vector_number vector );
* @retval ::RTEMS_SUCCESSFUL The requested operation was successful.
*
* @retval ::RTEMS_UNSATISFIED The request to disable the interrupt vector has
- * not been satisfied.
+ * not been satisfied. The presence of this error condition is
+ * implementation-defined. The interrupt vector attributes obtained by
+ * rtems_interrupt_get_attributes() should indicate if it is possible to
+ * disable a particular interrupt vector.
*/
rtems_status_code bsp_interrupt_vector_disable( rtems_vector_number vector );
@@ -318,8 +324,11 @@ rtems_status_code bsp_interrupt_is_pending(
*
* @retval ::RTEMS_SUCCESSFUL The requested operation was successful.
*
- * @retval ::RTEMS_UNSATISFIED The request to cause the interrupt vector has
- * not been satisfied.
+ * @retval ::RTEMS_UNSATISFIED The request to raise the interrupt vector has
+ * not been satisfied. The presence of this error condition is
+ * implementation-defined. The interrupt vector attributes obtained by
+ * rtems_interrupt_get_attributes() should indicate if it is possible to
+ * raise a particular interrupt vector.
*/
rtems_status_code bsp_interrupt_raise( rtems_vector_number vector );
@@ -336,7 +345,10 @@ rtems_status_code bsp_interrupt_raise( rtems_vector_number vector );
* @retval ::RTEMS_SUCCESSFUL The requested operation was successful.
*
* @retval ::RTEMS_UNSATISFIED The request to cause the interrupt vector has
- * not been satisfied.
+ * not been satisfied. The presence of this error condition is
+ * implementation-defined. The interrupt vector attributes obtained by
+ * rtems_interrupt_get_attributes() should indicate if it is possible to
+ * raise a particular interrupt vector on a specific processor.
*/
rtems_status_code bsp_interrupt_raise_on(
rtems_vector_number vector,
@@ -353,7 +365,10 @@ rtems_status_code bsp_interrupt_raise_on(
* @retval ::RTEMS_SUCCESSFUL The requested operation was successful.
*
* @retval ::RTEMS_UNSATISFIED The request to cause the interrupt vector has
- * not been satisfied.
+ * not been satisfied. The presence of this error condition is
+ * implementation-defined. The interrupt vector attributes obtained by
+ * rtems_interrupt_get_attributes() should indicate if it is possible to
+ * clear a particular interrupt vector.
*/
rtems_status_code bsp_interrupt_clear( rtems_vector_number vector );
More information about the vc
mailing list