From 98eb7e78b6f57b2085d415038d2045f13ed9521f Mon Sep 17 00:00:00 2001 From: Daniel Ramirez Date: Mon, 25 Nov 2013 18:14:28 -0600 Subject: raspberrypi doxygen refactoring --- c/src/lib/libbsp/arm/raspberrypi/clock/clockdrv.c | 8 ++++ .../arm/raspberrypi/console/console-config.c | 8 ++++ c/src/lib/libbsp/arm/raspberrypi/console/usart.c | 8 ++++ c/src/lib/libbsp/arm/raspberrypi/include/bsp.h | 9 ++++ c/src/lib/libbsp/arm/raspberrypi/include/irq.h | 12 ++++- c/src/lib/libbsp/arm/raspberrypi/include/mmu.h | 2 +- .../libbsp/arm/raspberrypi/include/raspberrypi.h | 14 ++++-- c/src/lib/libbsp/arm/raspberrypi/include/usart.h | 17 +++++++ c/src/lib/libbsp/arm/raspberrypi/irq/irq.c | 2 +- .../lib/libbsp/arm/raspberrypi/startup/bspreset.c | 4 +- .../lib/libbsp/arm/raspberrypi/startup/bspstart.c | 4 +- .../libbsp/arm/raspberrypi/startup/bspstarthooks.c | 4 +- c/src/lib/libbsp/arm/raspberrypi/startup/linkcmds | 10 ++-- .../arm/raspberrypi/startup/mm_config_table.c | 8 ++++ c/src/lib/libbsp/arm/shared/include/start.h | 18 +++++-- c/src/lib/libbsp/shared/clockdrv_shell.h | 55 ++++++++++++---------- 16 files changed, 135 insertions(+), 48 deletions(-) diff --git a/c/src/lib/libbsp/arm/raspberrypi/clock/clockdrv.c b/c/src/lib/libbsp/arm/raspberrypi/clock/clockdrv.c index d50ae32d1e..7d93ba702e 100644 --- a/c/src/lib/libbsp/arm/raspberrypi/clock/clockdrv.c +++ b/c/src/lib/libbsp/arm/raspberrypi/clock/clockdrv.c @@ -1,3 +1,11 @@ +/** + * @file + * + * @ingroup bsp_clock + * + * @brief Raspberry Pi clock support. + */ + /* * BCM2835 Clock driver * diff --git a/c/src/lib/libbsp/arm/raspberrypi/console/console-config.c b/c/src/lib/libbsp/arm/raspberrypi/console/console-config.c index ee4061d0ca..4af0bfc1d7 100644 --- a/c/src/lib/libbsp/arm/raspberrypi/console/console-config.c +++ b/c/src/lib/libbsp/arm/raspberrypi/console/console-config.c @@ -1,3 +1,11 @@ +/** + * @file + * + * @ingroup raspberrypi_usart + * + * @brief Console Configuration. + */ + /* * Copyright (c) 2013 Alan Cudmore * diff --git a/c/src/lib/libbsp/arm/raspberrypi/console/usart.c b/c/src/lib/libbsp/arm/raspberrypi/console/usart.c index 8c64b5fca6..8c2bba494e 100644 --- a/c/src/lib/libbsp/arm/raspberrypi/console/usart.c +++ b/c/src/lib/libbsp/arm/raspberrypi/console/usart.c @@ -1,3 +1,11 @@ +/** + * @file + * + * @ingroup raspberrypi_usart + * + * @brief USART support. + */ + /* * Copyright (c) 2013 Alan Cudmore * diff --git a/c/src/lib/libbsp/arm/raspberrypi/include/bsp.h b/c/src/lib/libbsp/arm/raspberrypi/include/bsp.h index cb34bd3331..fa8c016674 100644 --- a/c/src/lib/libbsp/arm/raspberrypi/include/bsp.h +++ b/c/src/lib/libbsp/arm/raspberrypi/include/bsp.h @@ -36,3 +36,12 @@ extern "C" { #endif /* __cplusplus */ #endif /* LIBBSP_ARM_RASPBERRYPI_BSP_H */ + +/** + * @defgroup arm_raspberrypi Raspberry Pi Support + * + * @ingroup bsp_arm + * + * @brief Raspberry Pi support package + * + */ diff --git a/c/src/lib/libbsp/arm/raspberrypi/include/irq.h b/c/src/lib/libbsp/arm/raspberrypi/include/irq.h index 0e3769c07f..32b74b26ec 100644 --- a/c/src/lib/libbsp/arm/raspberrypi/include/irq.h +++ b/c/src/lib/libbsp/arm/raspberrypi/include/irq.h @@ -1,12 +1,12 @@ /** * @file * - * @ingroup bsp_interrupt + * @ingroup raspberrypi_interrupt * * @brief Interrupt definitions. */ -/* +/** * Copyright (c) 2013 Alan Cudmore * * The license and distribution terms for this file may be @@ -25,6 +25,14 @@ #include #include +/** + * @defgroup raspberrypi_interrupt Interrrupt Support + * + * @ingroup arm_raspberrypi + * + * @brief Interrupt support. + */ + #define BCM2835_INTC_TOTAL_IRQ 64 + 8 diff --git a/c/src/lib/libbsp/arm/raspberrypi/include/mmu.h b/c/src/lib/libbsp/arm/raspberrypi/include/mmu.h index 50e9180dcc..755ae25f99 100644 --- a/c/src/lib/libbsp/arm/raspberrypi/include/mmu.h +++ b/c/src/lib/libbsp/arm/raspberrypi/include/mmu.h @@ -35,7 +35,7 @@ extern "C" { /** * @defgroup raspberrypi_mmu MMU Support * - * @ingroup raspberrypi + * @ingroup arm_raspberrypi * * @brief MMU support. * diff --git a/c/src/lib/libbsp/arm/raspberrypi/include/raspberrypi.h b/c/src/lib/libbsp/arm/raspberrypi/include/raspberrypi.h index 44a105ad4b..f806a53f07 100644 --- a/c/src/lib/libbsp/arm/raspberrypi/include/raspberrypi.h +++ b/c/src/lib/libbsp/arm/raspberrypi/include/raspberrypi.h @@ -1,7 +1,13 @@ -/* - * raspberrypi.h +/** + * @file * + * @ingroup raspberrypi_reg + * + * @brief Register definitions. + */ + +/* * Copyright (c) 2013 Alan Cudmore. * * The license and distribution terms for this file may be @@ -20,9 +26,9 @@ /** * @defgroup raspberrypi_reg Register Definitions * - * @ingroup raspberrypi + * @ingroup arm_raspberrypi * - * @brief Register definitions. + * @brief Register Definitions * * @{ */ diff --git a/c/src/lib/libbsp/arm/raspberrypi/include/usart.h b/c/src/lib/libbsp/arm/raspberrypi/include/usart.h index 26b44161da..502320c77a 100644 --- a/c/src/lib/libbsp/arm/raspberrypi/include/usart.h +++ b/c/src/lib/libbsp/arm/raspberrypi/include/usart.h @@ -1,3 +1,20 @@ +/** + * @file + * + * @ingroup raspberrypi_usart + * + * @brief USART support. + */ + + +/** + * @defgroup raspberrypi_usart USART Support + * + * @ingroup arm_raspberrypi + * + * @brief Universal Synchronous/Asynchronous Receiver/Transmitter (USART) Support + */ + /* * Copyright (c) 2013 Alan Cudmore. * diff --git a/c/src/lib/libbsp/arm/raspberrypi/irq/irq.c b/c/src/lib/libbsp/arm/raspberrypi/irq/irq.c index fc0b74a92e..2770d8dbdf 100644 --- a/c/src/lib/libbsp/arm/raspberrypi/irq/irq.c +++ b/c/src/lib/libbsp/arm/raspberrypi/irq/irq.c @@ -1,7 +1,7 @@ /** * @file * - * @ingroup bsp_interrupt + * @ingroup raspberrypi_interrupt * * @brief Interrupt support. */ diff --git a/c/src/lib/libbsp/arm/raspberrypi/startup/bspreset.c b/c/src/lib/libbsp/arm/raspberrypi/startup/bspreset.c index 588a33ec09..6fad17f68d 100644 --- a/c/src/lib/libbsp/arm/raspberrypi/startup/bspreset.c +++ b/c/src/lib/libbsp/arm/raspberrypi/startup/bspreset.c @@ -1,9 +1,9 @@ /** * @file * - * @ingroup raspberrypi + * @ingroup arm_start * - * @brief Reset code. + * @brief Raspberry Pi reset code. */ /* diff --git a/c/src/lib/libbsp/arm/raspberrypi/startup/bspstart.c b/c/src/lib/libbsp/arm/raspberrypi/startup/bspstart.c index e48dd532a4..8d6c9d3dbf 100644 --- a/c/src/lib/libbsp/arm/raspberrypi/startup/bspstart.c +++ b/c/src/lib/libbsp/arm/raspberrypi/startup/bspstart.c @@ -1,9 +1,9 @@ /** * @file * - * @ingroup raspberrypi + * @ingroup arm_start * - * @brief Startup code. + * @brief Raspberry pi startup code. */ /* diff --git a/c/src/lib/libbsp/arm/raspberrypi/startup/bspstarthooks.c b/c/src/lib/libbsp/arm/raspberrypi/startup/bspstarthooks.c index 71b2ff1a44..2501f33abc 100644 --- a/c/src/lib/libbsp/arm/raspberrypi/startup/bspstarthooks.c +++ b/c/src/lib/libbsp/arm/raspberrypi/startup/bspstarthooks.c @@ -1,9 +1,9 @@ /** * @file * - * @ingroup raspberrypi + * @ingroup arm_start * - * @brief Startup code. + * @brief Rasberry Pi startup code. */ /* diff --git a/c/src/lib/libbsp/arm/raspberrypi/startup/linkcmds b/c/src/lib/libbsp/arm/raspberrypi/startup/linkcmds index c12b348cf5..7b21235eaa 100644 --- a/c/src/lib/libbsp/arm/raspberrypi/startup/linkcmds +++ b/c/src/lib/libbsp/arm/raspberrypi/startup/linkcmds @@ -1,18 +1,20 @@ /** * @file * - * @ingroup raspberry_pi + * @ingroup raspberrypi_linker * - * @brief Memory map. + * @brief Memory map */ /** - * @defgroup raspberry_pi Memory Map + * @defgroup raspberrypi_linker Raspberry Pi Memory Map * * @ingroup bsp_linker * * @brief Raspberry Pi memory map. - * + */ + +/** * * * diff --git a/c/src/lib/libbsp/arm/raspberrypi/startup/mm_config_table.c b/c/src/lib/libbsp/arm/raspberrypi/startup/mm_config_table.c index 6e46cb1be3..6b3ea6735c 100644 --- a/c/src/lib/libbsp/arm/raspberrypi/startup/mm_config_table.c +++ b/c/src/lib/libbsp/arm/raspberrypi/startup/mm_config_table.c @@ -1,3 +1,11 @@ +/** + * @file + * + * @ingroup arm_start + * + * @brief Raspberry Pi low level start + */ + /* * Copyright (c) 2013 embedded brains GmbH. All rights reserved. * diff --git a/c/src/lib/libbsp/arm/shared/include/start.h b/c/src/lib/libbsp/arm/shared/include/start.h index ec3d435522..99fa774663 100644 --- a/c/src/lib/libbsp/arm/shared/include/start.h +++ b/c/src/lib/libbsp/arm/shared/include/start.h @@ -1,9 +1,9 @@ /** * @file * - * @ingroup bsp_start + * @ingroup arm_start * - * @brief System low level start. + * @brief ARM system low level start. */ /* @@ -32,11 +32,11 @@ extern "C" { #endif /* __cplusplus */ /** - * @defgroup bsp_start System Start + * @defgroup arm_start System Start * - * @ingroup bsp_kit + * @ingroup bsp_arm * - * @brief System low level start. + * @brief ARM system low level start. * * @{ */ @@ -140,3 +140,11 @@ BSP_START_TEXT_SECTION static inline void bsp_start_clear_bss(void) #endif /* __cplusplus */ #endif /* LIBBSP_ARM_SHARED_START_H */ + +/** + * @defgroup bsp_arm ARM + * + * @ingroup bsp_kit + * + * @brief ARM Board Support Packages. + */ diff --git a/c/src/lib/libbsp/shared/clockdrv_shell.h b/c/src/lib/libbsp/shared/clockdrv_shell.h index a2dc7f52ff..1fa5564bc9 100644 --- a/c/src/lib/libbsp/shared/clockdrv_shell.h +++ b/c/src/lib/libbsp/shared/clockdrv_shell.h @@ -1,7 +1,9 @@ /** - * @file + * @file * - * Clock Tick Device Driver Shell + * @ingroup bsp_clock + * + * @brief Clock Tick Device Driver Shell */ /* @@ -17,38 +19,45 @@ #include +/** + * @defgroup bsp_clock Clock Support + * + * @ingroup bsp_kit + * + * @brief Clock support + * + */ #if CLOCK_DRIVER_USE_FAST_IDLE && CLOCK_DRIVER_ISRS_PER_TICK #error "clockdrv_shell.h: Fast Idle PLUS n ISRs per tick is not supported" #endif -/* - * This method is rarely used so default it. +/** + * @brief This method is rarely used so default it. */ #ifndef Clock_driver_support_find_timer #define Clock_driver_support_find_timer() #endif -/* - * ISRs until next clock tick +/** + * @brief ISRs until next clock tick */ #if CLOCK_DRIVER_ISRS_PER_TICK volatile uint32_t Clock_driver_isrs; #endif -/* - * Clock ticks since initialization +/** + * @brief Clock ticks since initialization */ volatile uint32_t Clock_driver_ticks; void Clock_exit( void ); -/* - * Clock_isr +/** + * @brief Clock_isr * * This is the clock tick interrupt handler. * - * Input parameters: - * vector - vector number + * @param vector Vector number. * * Output parameters: NONE * @@ -108,8 +117,8 @@ rtems_isr Clock_isr( #endif } -/* - * Clock_exit +/** + * @brief Clock_exit * * This routine allows the clock driver to exit by masking the interrupt and * disabling the clock's counter. @@ -129,20 +138,16 @@ void Clock_exit( void ) /* do not restore old vector */ } -/* - * Clock_initialize - * - * This routine initializes the clock driver. +/** + * @brief Clock_initialize * - * Input parameters: - * major - clock device major number - * minor - clock device minor number - * parg - pointer to optional device driver arguments + * This routine initializes the clock driver. * - * Output parameters: NONE + * @param[in] major Clock device major number. + * @param[in] minor Clock device minor number. + * @param[in] parg Pointer to optional device driver arguments * - * Return values: - * rtems_device_driver status code + * @retval rtems_device_driver status code */ rtems_device_driver Clock_initialize( -- cgit v1.2.3
Region NameRegion BeginRegion Size
VECTOR_RAM0x080000008k