From c991eeeccc21901011ddd9ecc626c4d164fe2041 Mon Sep 17 00:00:00 2001 From: Sebastian Huber Date: Mon, 4 Mar 2019 15:32:15 +0100 Subject: bsps: Adjust bsp.h Doxygen groups Update #3706. --- bsps/arm/lpc24xx/console/console-config.c | 2 +- bsps/arm/lpc24xx/console/uart-probe-1.c | 2 +- bsps/arm/lpc24xx/console/uart-probe-2.c | 2 +- bsps/arm/lpc24xx/console/uart-probe-3.c | 2 +- bsps/arm/lpc24xx/fb/lcd.c | 2 +- bsps/arm/lpc24xx/i2c/i2c-config.c | 2 +- bsps/arm/lpc24xx/i2c/i2c.c | 2 +- bsps/arm/lpc24xx/include/bsp.h | 26 +++++++++++----------- bsps/arm/lpc24xx/include/bsp/dma.h | 4 ++-- bsps/arm/lpc24xx/include/bsp/i2c.h | 4 ++-- bsps/arm/lpc24xx/include/bsp/io.h | 4 ++-- bsps/arm/lpc24xx/include/bsp/lcd.h | 4 ++-- bsps/arm/lpc24xx/include/bsp/lpc-clock-config.h | 2 +- bsps/arm/lpc24xx/include/bsp/lpc-ethernet-config.h | 2 +- bsps/arm/lpc24xx/include/bsp/lpc17xx.h | 2 +- bsps/arm/lpc24xx/include/bsp/lpc24xx.h | 4 ++-- bsps/arm/lpc24xx/include/bsp/ssp.h | 4 ++-- bsps/arm/lpc24xx/include/bsp/start-config.h | 2 +- bsps/arm/lpc24xx/include/bsp/system-clocks.h | 4 ++-- bsps/arm/lpc24xx/rtc/rtc-config.c | 2 +- bsps/arm/lpc24xx/spi/ssp.c | 2 +- bsps/arm/lpc24xx/start/bspidle.c | 2 +- bsps/arm/lpc24xx/start/bspreset-armv4.c | 2 +- bsps/arm/lpc24xx/start/bspstart.c | 2 +- bsps/arm/lpc24xx/start/bspstarthooks.c | 2 +- bsps/arm/lpc24xx/start/dma-copy.c | 2 +- bsps/arm/lpc24xx/start/dma.c | 2 +- bsps/arm/lpc24xx/start/io.c | 2 +- bsps/arm/lpc24xx/start/restart.c | 2 +- bsps/arm/lpc24xx/start/start-config-emc-dynamic.c | 2 +- bsps/arm/lpc24xx/start/start-config-emc-static.c | 2 +- bsps/arm/lpc24xx/start/start-config-mpu.c | 2 +- bsps/arm/lpc24xx/start/start-config-pinsel.c | 2 +- bsps/arm/lpc24xx/start/system-clocks.c | 2 +- bsps/arm/lpc24xx/start/timer.c | 2 +- 35 files changed, 54 insertions(+), 54 deletions(-) (limited to 'bsps/arm/lpc24xx') diff --git a/bsps/arm/lpc24xx/console/console-config.c b/bsps/arm/lpc24xx/console/console-config.c index de94552c27..987df35e3d 100644 --- a/bsps/arm/lpc24xx/console/console-config.c +++ b/bsps/arm/lpc24xx/console/console-config.c @@ -1,7 +1,7 @@ /** * @file * - * @ingroup lpc24xx + * @ingroup RTEMSBSPsARMLPC24XX * * @brief Console configuration. */ diff --git a/bsps/arm/lpc24xx/console/uart-probe-1.c b/bsps/arm/lpc24xx/console/uart-probe-1.c index 3b5f08059f..f452b3b333 100644 --- a/bsps/arm/lpc24xx/console/uart-probe-1.c +++ b/bsps/arm/lpc24xx/console/uart-probe-1.c @@ -1,7 +1,7 @@ /** * @file * - * @ingroup lpc24xx + * @ingroup RTEMSBSPsARMLPC24XX * * @brief UART 1 probe. */ diff --git a/bsps/arm/lpc24xx/console/uart-probe-2.c b/bsps/arm/lpc24xx/console/uart-probe-2.c index d45dbb755b..4715c0b2e8 100644 --- a/bsps/arm/lpc24xx/console/uart-probe-2.c +++ b/bsps/arm/lpc24xx/console/uart-probe-2.c @@ -1,7 +1,7 @@ /** * @file * - * @ingroup lpc24xx + * @ingroup RTEMSBSPsARMLPC24XX * * @brief UART 2 probe. */ diff --git a/bsps/arm/lpc24xx/console/uart-probe-3.c b/bsps/arm/lpc24xx/console/uart-probe-3.c index fad932ef9e..a2a86f77d9 100644 --- a/bsps/arm/lpc24xx/console/uart-probe-3.c +++ b/bsps/arm/lpc24xx/console/uart-probe-3.c @@ -1,7 +1,7 @@ /** * @file * - * @ingroup lpc24xx + * @ingroup RTEMSBSPsARMLPC24XX * * @brief UART 3 probe. */ diff --git a/bsps/arm/lpc24xx/fb/lcd.c b/bsps/arm/lpc24xx/fb/lcd.c index 9474eec18a..39addf5847 100644 --- a/bsps/arm/lpc24xx/fb/lcd.c +++ b/bsps/arm/lpc24xx/fb/lcd.c @@ -1,7 +1,7 @@ /** * @file * - * @ingroup lpc24xx_lcd + * @ingroup RTEMSBSPsARMLPC24XX_lcd * * @brief LCD support. */ diff --git a/bsps/arm/lpc24xx/i2c/i2c-config.c b/bsps/arm/lpc24xx/i2c/i2c-config.c index 5ba16ae874..c1251a1c3e 100644 --- a/bsps/arm/lpc24xx/i2c/i2c-config.c +++ b/bsps/arm/lpc24xx/i2c/i2c-config.c @@ -1,7 +1,7 @@ /** * @file * - * @ingroup lpc24xx_libi2c + * @ingroup RTEMSBSPsARMLPC24XX_libi2c * * @brief LibI2C bus driver for the I2C modules. */ diff --git a/bsps/arm/lpc24xx/i2c/i2c.c b/bsps/arm/lpc24xx/i2c/i2c.c index ef638e69b9..5a6303b106 100644 --- a/bsps/arm/lpc24xx/i2c/i2c.c +++ b/bsps/arm/lpc24xx/i2c/i2c.c @@ -1,7 +1,7 @@ /** * @file * - * @ingroup lpc24xx_libi2c + * @ingroup RTEMSBSPsARMLPC24XX_libi2c * * @brief LibI2C bus driver for the I2C modules. */ diff --git a/bsps/arm/lpc24xx/include/bsp.h b/bsps/arm/lpc24xx/include/bsp.h index ac59a2a887..96834bb252 100644 --- a/bsps/arm/lpc24xx/include/bsp.h +++ b/bsps/arm/lpc24xx/include/bsp.h @@ -1,7 +1,7 @@ /** * @file * - * @ingroup lpc24xx + * @ingroup RTEMSBSPsARMLPC24XX * * @brief Global BSP definitions. */ @@ -23,6 +23,16 @@ #ifndef LIBBSP_ARM_LPC24XX_BSP_H #define LIBBSP_ARM_LPC24XX_BSP_H +/** + * @defgroup RTEMSBSPsARMLPC24XX NXP LPC17XX, LPC23XX, LPC24XX and LPC40XX + * + * @ingroup RTEMSBSPsARM + * + * @brief NXP LPC17XX, LPC23XX, LPC24XX and LPC40XX Board Support Package. + * + * @{ + */ + #include #define BSP_FEATURE_IRQ_EXTENSION @@ -53,16 +63,6 @@ struct rtems_bsdnet_ifconfig; struct rtems_termios_device_context; -/** - * @defgroup lpc24xx LPC24XX Support - * - * @ingroup RTEMSBSPsARM - * - * @brief LPC24XX support package. - * - * @{ - */ - /** * @brief Network driver attach and detach function. */ @@ -117,12 +117,12 @@ bool lpc24xx_uart_probe_2(struct rtems_termios_device_context *context); bool lpc24xx_uart_probe_3(struct rtems_termios_device_context *context); -/** @} */ - #ifdef __cplusplus } #endif /* __cplusplus */ #endif /* ASM */ +/** @} */ + #endif /* LIBBSP_ARM_LPC24XX_BSP_H */ diff --git a/bsps/arm/lpc24xx/include/bsp/dma.h b/bsps/arm/lpc24xx/include/bsp/dma.h index b2e6c3e665..3d5089b16b 100644 --- a/bsps/arm/lpc24xx/include/bsp/dma.h +++ b/bsps/arm/lpc24xx/include/bsp/dma.h @@ -1,7 +1,7 @@ /** * @file * - * @ingroup lpc24xx_dma + * @ingroup RTEMSBSPsARMLPC24XX_dma * * @brief Direct memory access (DMA) support. */ @@ -31,7 +31,7 @@ extern "C" { /** * @defgroup lpc24xx_dma DMA Support * - * @ingroup lpc24xx + * @ingroup RTEMSBSPsARMLPC24XX * * @brief Direct memory access (DMA) support. * diff --git a/bsps/arm/lpc24xx/include/bsp/i2c.h b/bsps/arm/lpc24xx/include/bsp/i2c.h index 42836ddfa8..3c29468c4e 100644 --- a/bsps/arm/lpc24xx/include/bsp/i2c.h +++ b/bsps/arm/lpc24xx/include/bsp/i2c.h @@ -1,7 +1,7 @@ /** * @file * - * @ingroup lpc24xx_libi2c + * @ingroup RTEMSBSPsARMLPC24XX_libi2c * * @brief LibI2C bus driver for the I2C modules. */ @@ -36,7 +36,7 @@ extern "C" { /** * @defgroup lpc24xx_libi2c LPC24XX Bus Drivers * - * @ingroup libi2c + * @ingroup RTEMSBSPsARMLPC24XX * * @brief LibI2C bus drivers for LPC24XX. * diff --git a/bsps/arm/lpc24xx/include/bsp/io.h b/bsps/arm/lpc24xx/include/bsp/io.h index 9f58ee8efb..c6fa4f47a1 100644 --- a/bsps/arm/lpc24xx/include/bsp/io.h +++ b/bsps/arm/lpc24xx/include/bsp/io.h @@ -1,7 +1,7 @@ /** * @file * - * @ingroup lpc24xx_io + * @ingroup RTEMSBSPsARMLPC24XX_io * * @brief Input and output module. */ @@ -34,7 +34,7 @@ extern "C" { /** * @defgroup lpc24xx_io IO Support and Configuration * - * @ingroup lpc24xx + * @ingroup RTEMSBSPsARMLPC24XX * * @brief Input and output module. * diff --git a/bsps/arm/lpc24xx/include/bsp/lcd.h b/bsps/arm/lpc24xx/include/bsp/lcd.h index c415074bd4..b0b6643316 100644 --- a/bsps/arm/lpc24xx/include/bsp/lcd.h +++ b/bsps/arm/lpc24xx/include/bsp/lcd.h @@ -1,7 +1,7 @@ /** * @file * - * @ingroup lpc24xx_lcd + * @ingroup RTEMSBSPsARMLPC24XX_lcd * * @brief LCD support. */ @@ -34,7 +34,7 @@ extern "C" { /** * @defgroup lpc_dma LCD Support * - * @ingroup lpc24xx + * @ingroup RTEMSBSPsARMLPC24XX * * @brief LCD support. * diff --git a/bsps/arm/lpc24xx/include/bsp/lpc-clock-config.h b/bsps/arm/lpc24xx/include/bsp/lpc-clock-config.h index 5e6b469e0f..35ae923d50 100644 --- a/bsps/arm/lpc24xx/include/bsp/lpc-clock-config.h +++ b/bsps/arm/lpc24xx/include/bsp/lpc-clock-config.h @@ -1,7 +1,7 @@ /** * @file * - * @ingroup lpc24xx + * @ingroup RTEMSBSPsARMLPC24XX * * @brief Clock driver configuration. */ diff --git a/bsps/arm/lpc24xx/include/bsp/lpc-ethernet-config.h b/bsps/arm/lpc24xx/include/bsp/lpc-ethernet-config.h index d24f132567..255a90d7b1 100644 --- a/bsps/arm/lpc24xx/include/bsp/lpc-ethernet-config.h +++ b/bsps/arm/lpc24xx/include/bsp/lpc-ethernet-config.h @@ -1,7 +1,7 @@ /** * @file * - * @ingroup lpc24xx + * @ingroup RTEMSBSPsARMLPC24XX * * @brief Ethernet driver configuration. */ diff --git a/bsps/arm/lpc24xx/include/bsp/lpc17xx.h b/bsps/arm/lpc24xx/include/bsp/lpc17xx.h index 9c35102e98..382227a724 100644 --- a/bsps/arm/lpc24xx/include/bsp/lpc17xx.h +++ b/bsps/arm/lpc24xx/include/bsp/lpc17xx.h @@ -1,7 +1,7 @@ /** * @file * - * @ingroup lpc24xx_regs + * @ingroup RTEMSBSPsARMLPC24XX_regs * * @brief Register definitions. */ diff --git a/bsps/arm/lpc24xx/include/bsp/lpc24xx.h b/bsps/arm/lpc24xx/include/bsp/lpc24xx.h index 64a910c041..15e20e2f27 100644 --- a/bsps/arm/lpc24xx/include/bsp/lpc24xx.h +++ b/bsps/arm/lpc24xx/include/bsp/lpc24xx.h @@ -1,7 +1,7 @@ /** * @file * - * @ingroup lpc24xx_regs + * @ingroup RTEMSBSPsARMLPC24XX_regs * * @brief Register definitions. */ @@ -34,7 +34,7 @@ /** * @defgroup lpc24xx_regs Register Definitions * - * @ingroup lpc24xx + * @ingroup RTEMSBSPsARMLPC24XX * * @brief Register definitions. * diff --git a/bsps/arm/lpc24xx/include/bsp/ssp.h b/bsps/arm/lpc24xx/include/bsp/ssp.h index 1a77219d0e..c8ec97de75 100644 --- a/bsps/arm/lpc24xx/include/bsp/ssp.h +++ b/bsps/arm/lpc24xx/include/bsp/ssp.h @@ -1,7 +1,7 @@ /** * @file * - * @ingroup lpc24xx_libi2c + * @ingroup RTEMSBSPsARMLPC24XX_libi2c * * @brief LibI2C bus driver for the Synchronous Serial Port (SSP). */ @@ -29,7 +29,7 @@ extern "C" { #endif /* __cplusplus */ /** - * @ingroup lpc24xx_libi2c + * @ingroup RTEMSBSPsARMLPC24XX_libi2c * * @{ */ diff --git a/bsps/arm/lpc24xx/include/bsp/start-config.h b/bsps/arm/lpc24xx/include/bsp/start-config.h index 4476cbdebe..ea981ebc55 100644 --- a/bsps/arm/lpc24xx/include/bsp/start-config.h +++ b/bsps/arm/lpc24xx/include/bsp/start-config.h @@ -1,7 +1,7 @@ /** * @file * - * @ingroup lpc24xx + * @ingroup RTEMSBSPsARMLPC24XX * * @brief BSP start configuration. */ diff --git a/bsps/arm/lpc24xx/include/bsp/system-clocks.h b/bsps/arm/lpc24xx/include/bsp/system-clocks.h index 564d12ec10..7bbc40164d 100644 --- a/bsps/arm/lpc24xx/include/bsp/system-clocks.h +++ b/bsps/arm/lpc24xx/include/bsp/system-clocks.h @@ -1,7 +1,7 @@ /** * @file * - * @ingroup lpc24xx_clocks + * @ingroup RTEMSBSPsARMLPC24XX_clocks * * @brief System clocks. */ @@ -31,7 +31,7 @@ extern "C" { /** * @defgroup lpc24xx_clock System Clocks * - * @ingroup lpc24xx + * @ingroup RTEMSBSPsARMLPC24XX * * @brief System clocks. * diff --git a/bsps/arm/lpc24xx/rtc/rtc-config.c b/bsps/arm/lpc24xx/rtc/rtc-config.c index c154a98196..1c1bb65c77 100644 --- a/bsps/arm/lpc24xx/rtc/rtc-config.c +++ b/bsps/arm/lpc24xx/rtc/rtc-config.c @@ -1,7 +1,7 @@ /** * @file * - * @ingroup lpc24xx + * @ingroup RTEMSBSPsARMLPC24XX * * @brief RTC configuration. */ diff --git a/bsps/arm/lpc24xx/spi/ssp.c b/bsps/arm/lpc24xx/spi/ssp.c index 6563d047b2..743276afd7 100644 --- a/bsps/arm/lpc24xx/spi/ssp.c +++ b/bsps/arm/lpc24xx/spi/ssp.c @@ -1,7 +1,7 @@ /** * @file * - * @ingroup lpc24xx_libi2c + * @ingroup RTEMSBSPsARMLPC24XX_libi2c * * @brief LibI2C bus driver for the Synchronous Serial Port (SSP). */ diff --git a/bsps/arm/lpc24xx/start/bspidle.c b/bsps/arm/lpc24xx/start/bspidle.c index 42a3e106f3..7286412559 100644 --- a/bsps/arm/lpc24xx/start/bspidle.c +++ b/bsps/arm/lpc24xx/start/bspidle.c @@ -1,7 +1,7 @@ /** * @file * - * @ingroup lpc24xx + * @ingroup RTEMSBSPsARMLPC24XX * * @brief Idle task. */ diff --git a/bsps/arm/lpc24xx/start/bspreset-armv4.c b/bsps/arm/lpc24xx/start/bspreset-armv4.c index c53b4e2447..b82fd88972 100644 --- a/bsps/arm/lpc24xx/start/bspreset-armv4.c +++ b/bsps/arm/lpc24xx/start/bspreset-armv4.c @@ -1,7 +1,7 @@ /** * @file * - * @ingroup lpc24xx + * @ingroup RTEMSBSPsARMLPC24XX * * @brief Reset code. */ diff --git a/bsps/arm/lpc24xx/start/bspstart.c b/bsps/arm/lpc24xx/start/bspstart.c index 6f00f35f99..de0efa9d6a 100644 --- a/bsps/arm/lpc24xx/start/bspstart.c +++ b/bsps/arm/lpc24xx/start/bspstart.c @@ -1,7 +1,7 @@ /** * @file * - * @ingroup lpc24xx + * @ingroup RTEMSBSPsARMLPC24XX * * @brief Startup code. */ diff --git a/bsps/arm/lpc24xx/start/bspstarthooks.c b/bsps/arm/lpc24xx/start/bspstarthooks.c index 6ceb066935..efae394e42 100644 --- a/bsps/arm/lpc24xx/start/bspstarthooks.c +++ b/bsps/arm/lpc24xx/start/bspstarthooks.c @@ -1,7 +1,7 @@ /** * @file * - * @ingroup lpc24xx + * @ingroup RTEMSBSPsARMLPC24XX * * @brief Startup code. */ diff --git a/bsps/arm/lpc24xx/start/dma-copy.c b/bsps/arm/lpc24xx/start/dma-copy.c index 73a8cdc3ab..7168947a2c 100644 --- a/bsps/arm/lpc24xx/start/dma-copy.c +++ b/bsps/arm/lpc24xx/start/dma-copy.c @@ -1,7 +1,7 @@ /** * @file * - * @ingroup lpc24xx_dma + * @ingroup RTEMSBSPsARMLPC24XX_dma * * @brief Direct memory access (DMA) support. */ diff --git a/bsps/arm/lpc24xx/start/dma.c b/bsps/arm/lpc24xx/start/dma.c index a67760ad3e..6e7c1c5157 100644 --- a/bsps/arm/lpc24xx/start/dma.c +++ b/bsps/arm/lpc24xx/start/dma.c @@ -1,7 +1,7 @@ /** * @file * - * @ingroup lpc24xx_dma + * @ingroup RTEMSBSPsARMLPC24XX_dma * * @brief Direct memory access (DMA) support. */ diff --git a/bsps/arm/lpc24xx/start/io.c b/bsps/arm/lpc24xx/start/io.c index c28b5182f0..dafd3aa8f5 100644 --- a/bsps/arm/lpc24xx/start/io.c +++ b/bsps/arm/lpc24xx/start/io.c @@ -1,7 +1,7 @@ /** * @file * - * @ingroup lpc24xx_io + * @ingroup RTEMSBSPsARMLPC24XX_io * * @brief Input and output module. */ diff --git a/bsps/arm/lpc24xx/start/restart.c b/bsps/arm/lpc24xx/start/restart.c index 627f79d19d..f5a107d4fa 100644 --- a/bsps/arm/lpc24xx/start/restart.c +++ b/bsps/arm/lpc24xx/start/restart.c @@ -1,7 +1,7 @@ /** * @file * - * @ingroup lpc24xx + * @ingroup RTEMSBSPsARMLPC24XX * * @brief Restart implementation. */ diff --git a/bsps/arm/lpc24xx/start/start-config-emc-dynamic.c b/bsps/arm/lpc24xx/start/start-config-emc-dynamic.c index 3a08f0b49d..720fc46aee 100644 --- a/bsps/arm/lpc24xx/start/start-config-emc-dynamic.c +++ b/bsps/arm/lpc24xx/start/start-config-emc-dynamic.c @@ -1,7 +1,7 @@ /** * @file * - * @ingroup lpc24xx + * @ingroup RTEMSBSPsARMLPC24XX * * @brief BSP start EMC dynamic memory configuration. */ diff --git a/bsps/arm/lpc24xx/start/start-config-emc-static.c b/bsps/arm/lpc24xx/start/start-config-emc-static.c index 4a427664f6..8545d86159 100644 --- a/bsps/arm/lpc24xx/start/start-config-emc-static.c +++ b/bsps/arm/lpc24xx/start/start-config-emc-static.c @@ -1,7 +1,7 @@ /** * @file * - * @ingroup lpc24xx + * @ingroup RTEMSBSPsARMLPC24XX * * @brief BSP start EMC static memory configuration. */ diff --git a/bsps/arm/lpc24xx/start/start-config-mpu.c b/bsps/arm/lpc24xx/start/start-config-mpu.c index 9d9846c69a..3dc3c48e4d 100644 --- a/bsps/arm/lpc24xx/start/start-config-mpu.c +++ b/bsps/arm/lpc24xx/start/start-config-mpu.c @@ -1,7 +1,7 @@ /** * @file * - * @ingroup lpc24xx + * @ingroup RTEMSBSPsARMLPC24XX * * @brief BSP start MPU configuration. */ diff --git a/bsps/arm/lpc24xx/start/start-config-pinsel.c b/bsps/arm/lpc24xx/start/start-config-pinsel.c index db44099664..cfd56124b6 100644 --- a/bsps/arm/lpc24xx/start/start-config-pinsel.c +++ b/bsps/arm/lpc24xx/start/start-config-pinsel.c @@ -1,7 +1,7 @@ /** * @file * - * @ingroup lpc24xx + * @ingroup RTEMSBSPsARMLPC24XX * * @brief BSP start pin selection configuration. */ diff --git a/bsps/arm/lpc24xx/start/system-clocks.c b/bsps/arm/lpc24xx/start/system-clocks.c index 8a2f62b4b0..19b040809f 100644 --- a/bsps/arm/lpc24xx/start/system-clocks.c +++ b/bsps/arm/lpc24xx/start/system-clocks.c @@ -1,7 +1,7 @@ /** * @file * - * @ingroup lpc24xx_clocks + * @ingroup RTEMSBSPsARMLPC24XX_clocks * * @brief System clocks. */ diff --git a/bsps/arm/lpc24xx/start/timer.c b/bsps/arm/lpc24xx/start/timer.c index c700d04566..46dbb21a04 100644 --- a/bsps/arm/lpc24xx/start/timer.c +++ b/bsps/arm/lpc24xx/start/timer.c @@ -1,7 +1,7 @@ /** * @file * - * @ingroup lpc24xx + * @ingroup RTEMSBSPsARMLPC24XX * * @brief Benchmark timer support. */ -- cgit v1.2.3