[PATCH] bsps/irq: Clarify interrupt vector operations
Gedare Bloom
gedare at rtems.org
Fri Feb 10 15:08:24 UTC 2023
Minor nit, I think "implementation-defined" as used in programming
language standards is better but "implementation-specific" as used
here is acceptable.
On Fri, Feb 10, 2023 at 12:45 AM Sebastian Huber
<sebastian.huber at embedded-brains.de> wrote:
>
> Clarify that the presence of error conditions is
> implementation-specific.
>
> 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..2d330d8d83 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-specific. 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-specific. 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-specific. 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-specific. 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-specific. 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 );
>
> --
> 2.35.3
>
> _______________________________________________
> devel mailing list
> devel at rtems.org
> http://lists.rtems.org/mailman/listinfo/devel
More information about the devel
mailing list