raspberrypi doxygen refactoring

2026-09-20 11:27:42 +08:00 · 2013-11-27 09:53:52 -05:00
parent ea3e6928ba
commit 98eb7e78b6
16 changed files with 135 additions and 48 deletions
@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * @ingroup bsp_clock
+ *
+ * @brief Raspberry Pi clock support.
+ */
+
 /*
 * BCM2835 Clock driver
 *
@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * @ingroup raspberrypi_usart
+ *
+ * @brief Console Configuration.
+ */
+
 /*
 * Copyright (c) 2013 Alan Cudmore
 *
@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * @ingroup raspberrypi_usart
+ *
+ * @brief USART support.
+ */
+
 /*
 * Copyright (c) 2013 Alan Cudmore
 *
@@ -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
+ *
+ */
@@ -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 <rtems/irq.h>
 #include <rtems/irq-extension.h>

+/**
+ * @defgroup raspberrypi_interrupt Interrrupt Support
+ *
+ * @ingroup arm_raspberrypi
+ *
+ * @brief Interrupt support.
+ */
+
 #define BCM2835_INTC_TOTAL_IRQ       64 + 8


@@ -35,7 +35,7 @@ extern "C" {
 /**
 * @defgroup raspberrypi_mmu MMU Support
 *
- * @ingroup raspberrypi
+ * @ingroup arm_raspberrypi
 *
 * @brief MMU support.
 *
@@ -1,7 +1,13 @@

+/**
+ * @file
+ *
+ * @ingroup raspberrypi_reg
+ *
+ * @brief Register definitions.
+ */
+
 /*
- * raspberrypi.h
- *
 * 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
 *
 * @{
 */
@@ -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.
 *
@@ -1,7 +1,7 @@
 /**
 * @file
 *
- * @ingroup bsp_interrupt
+ * @ingroup raspberrypi_interrupt
 *
 * @brief Interrupt support.
 */
@@ -1,9 +1,9 @@
 /**
 * @file
 *
- * @ingroup raspberrypi
+ * @ingroup arm_start
 *
- * @brief Reset code.
+ * @brief Raspberry Pi reset code.
 */

 /*
@@ -1,9 +1,9 @@
 /**
 * @file
 *
- * @ingroup raspberrypi
+ * @ingroup arm_start
 *
- * @brief Startup code.
+ * @brief Raspberry pi startup code.
 */

 /*
@@ -1,9 +1,9 @@
 /**
 * @file
 *
- * @ingroup raspberrypi
+ * @ingroup arm_start
 *
- * @brief Startup code.
+ * @brief Rasberry Pi startup code.
 */

 /*
@@ -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.
- *
+ */
+
+/**
 * <table>
 *   <tr><th>Region Name</th><th>Region Begin</th><th>Region Size</th></tr>
 * <tr><td>VECTOR_RAM</td><td>0x08000000</td><td>8k</td></tr>
@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * @ingroup arm_start
+ *
+ * @brief Raspberry Pi low level start
+ */
+
 /*
 * Copyright (c) 2013 embedded brains GmbH.  All rights reserved.
 *
@@ -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.
+ */
@@ -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 <bsp.h>

+/**
+ * @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
+/**
+ * @brief Clock_initialize
 *
- *  This routine initializes the clock driver.
+ * This routine initializes the clock driver.
 *
- *  Input parameters:
- *    major - clock device major number
- *    minor - clock device minor number
- *    parg  - pointer to optional device driver arguments
+ * @param[in] major Clock device major number.
+ * @param[in] minor Clock device minor number.
+ * @param[in] parg  Pointer to optional device driver arguments
 *
- *  Output parameters:  NONE
- *
- *  Return values:
- *    rtems_device_driver status code
+ * @retval rtems_device_driver status code
 */

 rtems_device_driver Clock_initialize(