From d36070fec8758a745a0b33f1ffa9f8192fceec51 Mon Sep 17 00:00:00 2001 From: Sebastian Huber Date: Mon, 23 Jan 2023 15:48:48 +0100 Subject: intr: Add Interrupt Manager implementation group The shared BSP interrupt controller support code actually implements parts of the Interrupt Manager. Update #3706. --- bsps/arm/altera-cyclone-v/include/bsp/irq.h | 2 +- bsps/arm/beagle/irq/irq.c | 2 +- bsps/arm/lpc176x/include/bsp/irq.h | 4 ++-- bsps/arm/lpc176x/irq/irq.c | 2 +- bsps/arm/lpc24xx/include/bsp/irq.h | 4 ++-- bsps/arm/lpc24xx/irq/irq-dispatch.c | 2 +- bsps/arm/lpc24xx/irq/irq.c | 2 +- bsps/arm/lpc32xx/include/bsp/irq.h | 2 +- bsps/include/bsp/irq-generic.h | 32 ++++++++++++++--------------- bsps/include/bsp/irq-info.h | 2 +- bsps/lm32/include/bsp/irq.h | 4 ++-- bsps/mips/csb350/include/bsp/irq.h | 4 ++-- bsps/mips/hurricane/include/bsp/irq.h | 4 ++-- bsps/mips/jmr3904/include/bsp/irq.h | 4 ++-- bsps/mips/malta/include/bsp/irq.h | 4 ++-- bsps/mips/rbtx4925/include/bsp/irq.h | 4 ++-- bsps/mips/rbtx4938/include/bsp/irq.h | 4 ++-- bsps/mips/shared/irq/irq.c | 2 +- bsps/powerpc/mpc55xxevb/include/bsp/irq.h | 2 +- bsps/shared/irq/irq-affinity.c | 2 +- bsps/shared/irq/irq-default-handler.c | 2 +- bsps/shared/irq/irq-default.c | 2 +- bsps/shared/irq/irq-enable-disable.c | 2 +- bsps/shared/irq/irq-entry-remove.c | 2 +- bsps/shared/irq/irq-generic.c | 2 +- bsps/shared/irq/irq-handler-install.c | 2 +- bsps/shared/irq/irq-handler-iterate.c | 2 +- bsps/shared/irq/irq-handler-remove.c | 2 +- bsps/shared/irq/irq-info.c | 2 +- bsps/shared/irq/irq-legacy.c | 2 +- bsps/shared/irq/irq-lock.c | 2 +- bsps/shared/irq/irq-raise-clear.c | 2 +- bsps/shared/irq/irq-record.c | 2 +- bsps/shared/irq/irq-server.c | 2 +- bsps/shared/irq/irq-shell.c | 2 +- 35 files changed, 59 insertions(+), 59 deletions(-) (limited to 'bsps') diff --git a/bsps/arm/altera-cyclone-v/include/bsp/irq.h b/bsps/arm/altera-cyclone-v/include/bsp/irq.h index 15d05ec632..d06bfa92f0 100644 --- a/bsps/arm/altera-cyclone-v/include/bsp/irq.h +++ b/bsps/arm/altera-cyclone-v/include/bsp/irq.h @@ -52,7 +52,7 @@ extern "C" { * * @ingroup RTEMSBSPsARMCycV * - * @ingroup bsp_interrupt + * @ingroup RTEMSImplClassicIntr * * @brief Intel Cyclone V Interrupt Support. * diff --git a/bsps/arm/beagle/irq/irq.c b/bsps/arm/beagle/irq/irq.c index 29a4e391e8..0ae82aa95e 100644 --- a/bsps/arm/beagle/irq/irq.c +++ b/bsps/arm/beagle/irq/irq.c @@ -1,7 +1,7 @@ /** * @file * - * @ingroup bsp_interrupt + * @ingroup RTEMSImplClassicIntr * @ingroup arm_beagle * * @brief Interrupt support. diff --git a/bsps/arm/lpc176x/include/bsp/irq.h b/bsps/arm/lpc176x/include/bsp/irq.h index 19f8601771..8ec55e8b84 100644 --- a/bsps/arm/lpc176x/include/bsp/irq.h +++ b/bsps/arm/lpc176x/include/bsp/irq.h @@ -3,7 +3,7 @@ /** * @file * - * @ingroup bsp_interrupt + * @ingroup RTEMSImplClassicIntr * * @brief LPC176X interrupt definitions. */ @@ -43,7 +43,7 @@ #endif /** - * @addtogroup bsp_interrupt + * @addtogroup RTEMSImplClassicIntr * * @{ */ diff --git a/bsps/arm/lpc176x/irq/irq.c b/bsps/arm/lpc176x/irq/irq.c index 005002a647..dad212dfeb 100644 --- a/bsps/arm/lpc176x/irq/irq.c +++ b/bsps/arm/lpc176x/irq/irq.c @@ -3,7 +3,7 @@ /** * @file * - * @ingroup bsp_interrupt + * @ingroup RTEMSImplClassicIntr * * @brief LPC176X interrupt support. */ diff --git a/bsps/arm/lpc24xx/include/bsp/irq.h b/bsps/arm/lpc24xx/include/bsp/irq.h index 524a7f1f51..ff1135e48c 100644 --- a/bsps/arm/lpc24xx/include/bsp/irq.h +++ b/bsps/arm/lpc24xx/include/bsp/irq.h @@ -3,7 +3,7 @@ /** * @file * - * @ingroup bsp_interrupt + * @ingroup RTEMSImplClassicIntr * * @brief LPC24XX interrupt definitions. */ @@ -43,7 +43,7 @@ #endif /** - * @addtogroup bsp_interrupt + * @addtogroup RTEMSImplClassicIntr * * @{ */ diff --git a/bsps/arm/lpc24xx/irq/irq-dispatch.c b/bsps/arm/lpc24xx/irq/irq-dispatch.c index b244b97b8a..3f12c88c5e 100644 --- a/bsps/arm/lpc24xx/irq/irq-dispatch.c +++ b/bsps/arm/lpc24xx/irq/irq-dispatch.c @@ -3,7 +3,7 @@ /** * @file * - * @ingroup bsp_interrupt + * @ingroup RTEMSImplClassicIntr * * @brief LPC24XX interrupt support. */ diff --git a/bsps/arm/lpc24xx/irq/irq.c b/bsps/arm/lpc24xx/irq/irq.c index a92763131a..025123addb 100644 --- a/bsps/arm/lpc24xx/irq/irq.c +++ b/bsps/arm/lpc24xx/irq/irq.c @@ -3,7 +3,7 @@ /** * @file * - * @ingroup bsp_interrupt + * @ingroup RTEMSImplClassicIntr * * @brief LPC24XX interrupt support. */ diff --git a/bsps/arm/lpc32xx/include/bsp/irq.h b/bsps/arm/lpc32xx/include/bsp/irq.h index ea3c116a58..582bcb9568 100644 --- a/bsps/arm/lpc32xx/include/bsp/irq.h +++ b/bsps/arm/lpc32xx/include/bsp/irq.h @@ -51,7 +51,7 @@ extern "C" { * * @ingroup RTEMSBSPsARMLPC32XX * - * @ingroup bsp_interrupt + * @ingroup RTEMSImplClassicIntr * * @{ */ diff --git a/bsps/include/bsp/irq-generic.h b/bsps/include/bsp/irq-generic.h index 1ff84ee7cd..bbfb1979f4 100644 --- a/bsps/include/bsp/irq-generic.h +++ b/bsps/include/bsp/irq-generic.h @@ -3,10 +3,10 @@ /** * @file * - * @ingroup bsp_interrupt + * @ingroup RTEMSImplClassicIntr * - * @brief This header file provides interfaces of the generic interrupt - * controller support. + * @brief This header file provides interfaces of the Interrupt Manager + * implementation. */ /* @@ -101,29 +101,29 @@ static inline rtems_vector_number bsp_interrupt_dispatch_index( } /** - * @defgroup bsp_interrupt BSP Interrupt Support + * @defgroup RTEMSImplClassicIntr Interrupt Manager * - * @ingroup RTEMSBSPsShared + * @ingroup RTEMSImplClassic * - * @brief Generic BSP Interrupt Support + * @brief This group contains the Interrupt Manager implementation. * - * The BSP interrupt support manages a sequence of interrupt vector numbers - * greater than or equal to zero and less than @ref BSP_INTERRUPT_VECTOR_COUNT - * It provides methods to install, remove, and @ref - * bsp_interrupt_handler_dispatch() "dispatch" interrupt entries for each - * vector number. It implements parts of the RTEMS interrupt manager. + * The Interrupt Manager implementation manages a sequence of interrupt vector + * numbers greater than or equal to zero and less than + * ``BSP_INTERRUPT_VECTOR_COUNT``. It provides methods to install, remove, and + * dispatch interrupt entries for each vector number, see + * bsp_interrupt_dispatch_entries(). * * The entry points to a list of interrupt entries are stored in a table * (= dispatch table). * - * You have to configure the BSP interrupt support in the file + * You have to configure the Interrupt Manager implementation in the file * for each BSP. For a minimum configuration you have to provide - * @ref BSP_INTERRUPT_VECTOR_COUNT. + * ``BSP_INTERRUPT_VECTOR_COUNT``. * * For boards with small memory requirements you can define - * @ref BSP_INTERRUPT_USE_INDEX_TABLE. With an enabled index table the + * ``BSP_INTERRUPT_USE_INDEX_TABLE``. With an enabled index table the * dispatch table will be accessed via a small index table. You can define the - * size of the dispatch table with @ref BSP_INTERRUPT_DISPATCH_TABLE_SIZE. + * size of the dispatch table with ``BSP_INTERRUPT_DISPATCH_TABLE_SIZE``. * * You have to provide some special routines in your BSP (follow the links for * the details): @@ -175,7 +175,7 @@ static inline rtems_vector_number bsp_interrupt_dispatch_index( void bsp_interrupt_handler_default(rtems_vector_number vector); /** - * @brief Initialize BSP interrupt support. + * @brief Initialize Interrupt Manager implementation. * * You must call this function before you can install, remove and dispatch * interrupt entries. There is no protection against concurrent diff --git a/bsps/include/bsp/irq-info.h b/bsps/include/bsp/irq-info.h index 25f05a9f69..c00f5c5daf 100644 --- a/bsps/include/bsp/irq-info.h +++ b/bsps/include/bsp/irq-info.h @@ -3,7 +3,7 @@ /** * @file * - * @ingroup bsp_interrupt + * @ingroup RTEMSImplClassicIntr * * @brief This header file provides interfaces of the generic interrupt * controller support for the RTEMS Shell. diff --git a/bsps/lm32/include/bsp/irq.h b/bsps/lm32/include/bsp/irq.h index 709538d192..9b06fd5d7d 100644 --- a/bsps/lm32/include/bsp/irq.h +++ b/bsps/lm32/include/bsp/irq.h @@ -3,7 +3,7 @@ /** * @file * - * @ingroup bsp_interrupt + * @ingroup RTEMSImplClassicIntr * * @brief BSP interrupt support for LM32. */ @@ -41,7 +41,7 @@ #include /** - * @addtogroup bsp_interrupt + * @addtogroup RTEMSImplClassicIntr * * @{ */ diff --git a/bsps/mips/csb350/include/bsp/irq.h b/bsps/mips/csb350/include/bsp/irq.h index c98ad71803..c2f55c49e3 100644 --- a/bsps/mips/csb350/include/bsp/irq.h +++ b/bsps/mips/csb350/include/bsp/irq.h @@ -3,7 +3,7 @@ /** * @file * - * @ingroup bsp_interrupt + * @ingroup RTEMSImplClassicIntr * * @brief interrupt definitions. */ @@ -45,7 +45,7 @@ #endif /** - * @addtogroup bsp_interrupt + * @addtogroup RTEMSImplClassicIntr * * @{ */ diff --git a/bsps/mips/hurricane/include/bsp/irq.h b/bsps/mips/hurricane/include/bsp/irq.h index 83af94bc4a..af6a1aa1ee 100644 --- a/bsps/mips/hurricane/include/bsp/irq.h +++ b/bsps/mips/hurricane/include/bsp/irq.h @@ -3,7 +3,7 @@ /** * @file * - * @ingroup bsp_interrupt + * @ingroup RTEMSImplClassicIntr * * @brief interrupt definitions. */ @@ -45,7 +45,7 @@ #endif /** - * @addtogroup bsp_interrupt + * @addtogroup RTEMSImplClassicIntr * * @{ */ diff --git a/bsps/mips/jmr3904/include/bsp/irq.h b/bsps/mips/jmr3904/include/bsp/irq.h index 6f0aa32618..1f80a1dc7a 100644 --- a/bsps/mips/jmr3904/include/bsp/irq.h +++ b/bsps/mips/jmr3904/include/bsp/irq.h @@ -3,7 +3,7 @@ /** * @file * - * @ingroup bsp_interrupt + * @ingroup RTEMSImplClassicIntr * * @brief jmr3904 interrupt definitions. */ @@ -45,7 +45,7 @@ #endif /** - * @addtogroup bsp_interrupt + * @addtogroup RTEMSImplClassicIntr * * @{ */ diff --git a/bsps/mips/malta/include/bsp/irq.h b/bsps/mips/malta/include/bsp/irq.h index f151ff2fe7..553fa523ee 100644 --- a/bsps/mips/malta/include/bsp/irq.h +++ b/bsps/mips/malta/include/bsp/irq.h @@ -3,7 +3,7 @@ /** * @file * - * @ingroup bsp_interrupt + * @ingroup RTEMSImplClassicIntr * * @brief Malta Interrupt Definitions */ @@ -45,7 +45,7 @@ #endif /** - * @addtogroup bsp_interrupt + * @addtogroup RTEMSImplClassicIntr * * @{ */ diff --git a/bsps/mips/rbtx4925/include/bsp/irq.h b/bsps/mips/rbtx4925/include/bsp/irq.h index 0fd181aef4..b255ddb464 100644 --- a/bsps/mips/rbtx4925/include/bsp/irq.h +++ b/bsps/mips/rbtx4925/include/bsp/irq.h @@ -3,7 +3,7 @@ /** * @file * - * @ingroup bsp_interrupt + * @ingroup RTEMSImplClassicIntr * * @brief interrupt definitions. */ @@ -45,7 +45,7 @@ #endif /** - * @addtogroup bsp_interrupt + * @addtogroup RTEMSImplClassicIntr * * @{ */ diff --git a/bsps/mips/rbtx4938/include/bsp/irq.h b/bsps/mips/rbtx4938/include/bsp/irq.h index dfb488a0c3..5de3e20de8 100644 --- a/bsps/mips/rbtx4938/include/bsp/irq.h +++ b/bsps/mips/rbtx4938/include/bsp/irq.h @@ -3,7 +3,7 @@ /** * @file * - * @ingroup bsp_interrupt + * @ingroup RTEMSImplClassicIntr * * @brief interrupt definitions. */ @@ -45,7 +45,7 @@ #endif /** - * @addtogroup bsp_interrupt + * @addtogroup RTEMSImplClassicIntr * * @{ */ diff --git a/bsps/mips/shared/irq/irq.c b/bsps/mips/shared/irq/irq.c index 57816bd971..460da7a3f8 100644 --- a/bsps/mips/shared/irq/irq.c +++ b/bsps/mips/shared/irq/irq.c @@ -1,7 +1,7 @@ /** * @file * - * @ingroup bsp_interrupt + * @ingroup RTEMSImplClassicIntr * * @brief Interrupt support. */ diff --git a/bsps/powerpc/mpc55xxevb/include/bsp/irq.h b/bsps/powerpc/mpc55xxevb/include/bsp/irq.h index 1bedd3a65a..84a2b12358 100644 --- a/bsps/powerpc/mpc55xxevb/include/bsp/irq.h +++ b/bsps/powerpc/mpc55xxevb/include/bsp/irq.h @@ -485,7 +485,7 @@ rtems_status_code mpc55xx_intc_raise_software_irq(rtems_vector_number vector); rtems_status_code mpc55xx_intc_clear_software_irq(rtems_vector_number vector); /** - * @addtogroup bsp_interrupt + * @addtogroup RTEMSImplClassicIntr * * @{ */ diff --git a/bsps/shared/irq/irq-affinity.c b/bsps/shared/irq/irq-affinity.c index c21468077b..dc105639c3 100644 --- a/bsps/shared/irq/irq-affinity.c +++ b/bsps/shared/irq/irq-affinity.c @@ -3,7 +3,7 @@ /** * @file * - * @ingroup bsp_interrupt + * @ingroup RTEMSImplClassicIntr * * @brief This source file contains the implementation of * rtems_interrupt_get_affinity() and rtems_interrupt_set_affinity(). diff --git a/bsps/shared/irq/irq-default-handler.c b/bsps/shared/irq/irq-default-handler.c index 666d48aaa8..1458ceae40 100644 --- a/bsps/shared/irq/irq-default-handler.c +++ b/bsps/shared/irq/irq-default-handler.c @@ -3,7 +3,7 @@ /** * @file * - * @ingroup bsp_interrupt + * @ingroup RTEMSImplClassicIntr * * @brief This source file contains the default implementation of * bsp_interrupt_handler_default(). diff --git a/bsps/shared/irq/irq-default.c b/bsps/shared/irq/irq-default.c index bd93bd72c6..39ee11118c 100644 --- a/bsps/shared/irq/irq-default.c +++ b/bsps/shared/irq/irq-default.c @@ -3,7 +3,7 @@ /** * @file * - * @ingroup bsp_interrupt + * @ingroup RTEMSImplClassicIntr * * @brief This source file contains the default implementation of * bsp_interrupt_vector_enable(), bsp_interrupt_vector_disable(), and diff --git a/bsps/shared/irq/irq-enable-disable.c b/bsps/shared/irq/irq-enable-disable.c index 75d3d5ec46..c9602de398 100644 --- a/bsps/shared/irq/irq-enable-disable.c +++ b/bsps/shared/irq/irq-enable-disable.c @@ -3,7 +3,7 @@ /** * @file * - * @ingroup bsp_interrupt + * @ingroup RTEMSImplClassicIntr * * @brief This source file contains the implementation of * rtems_interrupt_get_attributes(), rtems_interrupt_vector_is_enabled(), diff --git a/bsps/shared/irq/irq-entry-remove.c b/bsps/shared/irq/irq-entry-remove.c index 6b43134a0c..6f603359fd 100644 --- a/bsps/shared/irq/irq-entry-remove.c +++ b/bsps/shared/irq/irq-entry-remove.c @@ -3,7 +3,7 @@ /** * @file * - * @ingroup bsp_interrupt + * @ingroup RTEMSImplClassicIntr * * @brief This source file contains the implementation of * rtems_interrupt_entry_remove() and bsp_interrupt_entry_remove(). diff --git a/bsps/shared/irq/irq-generic.c b/bsps/shared/irq/irq-generic.c index e899731a54..cf99b7207d 100644 --- a/bsps/shared/irq/irq-generic.c +++ b/bsps/shared/irq/irq-generic.c @@ -3,7 +3,7 @@ /** * @file * - * @ingroup bsp_interrupt + * @ingroup RTEMSImplClassicIntr * * @brief This source file contains the generic interrupt controller support * implementation. diff --git a/bsps/shared/irq/irq-handler-install.c b/bsps/shared/irq/irq-handler-install.c index 2474d792e6..75cd2c9822 100644 --- a/bsps/shared/irq/irq-handler-install.c +++ b/bsps/shared/irq/irq-handler-install.c @@ -3,7 +3,7 @@ /** * @file * - * @ingroup bsp_interrupt + * @ingroup RTEMSImplClassicIntr * * @brief This source file contains the rtems_interrupt_handler_install() * implementation. diff --git a/bsps/shared/irq/irq-handler-iterate.c b/bsps/shared/irq/irq-handler-iterate.c index 7437e8a43e..f7af6ee356 100644 --- a/bsps/shared/irq/irq-handler-iterate.c +++ b/bsps/shared/irq/irq-handler-iterate.c @@ -3,7 +3,7 @@ /** * @file * - * @ingroup bsp_interrupt + * @ingroup RTEMSImplClassicIntr * * @brief This source file contains the implementation of * rtems_interrupt_handler_iterate(). diff --git a/bsps/shared/irq/irq-handler-remove.c b/bsps/shared/irq/irq-handler-remove.c index cb32ba3b7c..ab46c67ab1 100644 --- a/bsps/shared/irq/irq-handler-remove.c +++ b/bsps/shared/irq/irq-handler-remove.c @@ -3,7 +3,7 @@ /** * @file * - * @ingroup bsp_interrupt + * @ingroup RTEMSImplClassicIntr * * @brief This source file contains the implementation of * rtems_interrupt_handler_remove(). diff --git a/bsps/shared/irq/irq-info.c b/bsps/shared/irq/irq-info.c index a52465ef09..8738771a43 100644 --- a/bsps/shared/irq/irq-info.c +++ b/bsps/shared/irq/irq-info.c @@ -3,7 +3,7 @@ /** * @file * - * @ingroup bsp_interrupt + * @ingroup RTEMSImplClassicIntr * * @brief This source file contains the implementation of * bsp_interrupt_report() and bsp_interrupt_report_with_plugin(). diff --git a/bsps/shared/irq/irq-legacy.c b/bsps/shared/irq/irq-legacy.c index 649b850095..6181b0c994 100644 --- a/bsps/shared/irq/irq-legacy.c +++ b/bsps/shared/irq/irq-legacy.c @@ -3,7 +3,7 @@ /** * @file * - * @ingroup bsp_interrupt + * @ingroup RTEMSImplClassicIntr * * @brief This source file contains the legacy interrupt controller support * implementation. diff --git a/bsps/shared/irq/irq-lock.c b/bsps/shared/irq/irq-lock.c index 58b7020a3b..568443718a 100644 --- a/bsps/shared/irq/irq-lock.c +++ b/bsps/shared/irq/irq-lock.c @@ -3,7 +3,7 @@ /** * @file * - * @ingroup bsp_interrupt + * @ingroup RTEMSImplClassicIntr * * @brief This source file contains the implementation of * bsp_interrupt_lock() and bsp_interrupt_unlock(). diff --git a/bsps/shared/irq/irq-raise-clear.c b/bsps/shared/irq/irq-raise-clear.c index 93e414b2d1..042c1a2b7a 100644 --- a/bsps/shared/irq/irq-raise-clear.c +++ b/bsps/shared/irq/irq-raise-clear.c @@ -3,7 +3,7 @@ /** * @file * - * @ingroup bsp_interrupt + * @ingroup RTEMSImplClassicIntr * * @brief This source file contains the implementation of * rtems_interrupt_clear(). diff --git a/bsps/shared/irq/irq-record.c b/bsps/shared/irq/irq-record.c index 9f0a008d84..f48c0c732c 100644 --- a/bsps/shared/irq/irq-record.c +++ b/bsps/shared/irq/irq-record.c @@ -3,7 +3,7 @@ /** * @file * - * @ingroup bsp_interrupt + * @ingroup RTEMSImplClassicIntr * * @brief This source file contains the implementation of the interrupt event * recording support. diff --git a/bsps/shared/irq/irq-server.c b/bsps/shared/irq/irq-server.c index 8b9d82eb29..d099c6ff05 100644 --- a/bsps/shared/irq/irq-server.c +++ b/bsps/shared/irq/irq-server.c @@ -3,7 +3,7 @@ /** * @file * - * @ingroup bsp_interrupt + * @ingroup RTEMSImplClassicIntr * * @brief This source file contains the interrupt server implementation. */ diff --git a/bsps/shared/irq/irq-shell.c b/bsps/shared/irq/irq-shell.c index cf70f2ce1b..2667924076 100644 --- a/bsps/shared/irq/irq-shell.c +++ b/bsps/shared/irq/irq-shell.c @@ -3,7 +3,7 @@ /** * @file * - * @ingroup bsp_interrupt + * @ingroup RTEMSImplClassicIntr * * @brief This source file contains the definition of * ::bsp_interrupt_shell_command. -- cgit v1.2.3