Changeset 98eb7e78 in rtems


Ignore:
Timestamp:
Nov 26, 2013, 12:14:28 AM (6 years ago)
Author:
Daniel Ramirez <javamonn@…>
Branches:
4.11, master
Children:
db08c38
Parents:
ea3e6928
git-author:
Daniel Ramirez <javamonn@…> (11/26/13 00:14:28)
git-committer:
Gedare Bloom <gedare@…> (11/27/13 14:53:52)
Message:

raspberrypi doxygen refactoring

Location:
c/src/lib/libbsp
Files:
16 edited

Legend:

Unmodified
Added
Removed
  • c/src/lib/libbsp/arm/raspberrypi/clock/clockdrv.c

    rea3e6928 r98eb7e78  
     1/**
     2 * @file
     3 *
     4 * @ingroup bsp_clock
     5 *
     6 * @brief Raspberry Pi clock support.
     7 */
     8
    19/*
    210 * BCM2835 Clock driver
  • c/src/lib/libbsp/arm/raspberrypi/console/console-config.c

    rea3e6928 r98eb7e78  
     1/**
     2 * @file
     3 *
     4 * @ingroup raspberrypi_usart
     5 *
     6 * @brief Console Configuration.
     7 */
     8
    19/*
    210 * Copyright (c) 2013 Alan Cudmore
  • c/src/lib/libbsp/arm/raspberrypi/console/usart.c

    rea3e6928 r98eb7e78  
     1/**
     2 * @file
     3 *
     4 * @ingroup raspberrypi_usart
     5 *
     6 * @brief USART support.
     7 */
     8
    19/*
    210 * Copyright (c) 2013 Alan Cudmore
  • c/src/lib/libbsp/arm/raspberrypi/include/bsp.h

    rea3e6928 r98eb7e78  
    3737
    3838#endif /* LIBBSP_ARM_RASPBERRYPI_BSP_H */
     39
     40/**
     41 * @defgroup arm_raspberrypi Raspberry Pi Support
     42 *
     43 * @ingroup bsp_arm
     44 *
     45 * @brief Raspberry Pi support package
     46 *
     47 */
  • c/src/lib/libbsp/arm/raspberrypi/include/irq.h

    rea3e6928 r98eb7e78  
    22 * @file
    33 *
    4  * @ingroup bsp_interrupt
     4 * @ingroup raspberrypi_interrupt
    55 *
    66 * @brief Interrupt definitions.
    77 */
    88
    9 /*
     9/**
    1010 * Copyright (c) 2013 Alan Cudmore
    1111 *
     
    2525#include <rtems/irq.h>
    2626#include <rtems/irq-extension.h>
     27
     28/**
     29 * @defgroup raspberrypi_interrupt Interrrupt Support
     30 *
     31 * @ingroup arm_raspberrypi
     32 *
     33 * @brief Interrupt support.
     34 */
    2735
    2836#define BCM2835_INTC_TOTAL_IRQ       64 + 8
  • c/src/lib/libbsp/arm/raspberrypi/include/mmu.h

    rea3e6928 r98eb7e78  
    3636 * @defgroup raspberrypi_mmu MMU Support
    3737 *
    38  * @ingroup raspberrypi
     38 * @ingroup arm_raspberrypi
    3939 *
    4040 * @brief MMU support.
  • c/src/lib/libbsp/arm/raspberrypi/include/raspberrypi.h

    rea3e6928 r98eb7e78  
     1
     2/**
     3 * @file
     4 *
     5 * @ingroup raspberrypi_reg
     6 *
     7 * @brief Register definitions.
     8 */
    19
    210/*
    3  * raspberrypi.h
    4  *
    511 * Copyright (c) 2013 Alan Cudmore.
    612 *
     
    2127 * @defgroup raspberrypi_reg Register Definitions
    2228 *
    23  * @ingroup raspberrypi
    24  *
    25  * @brief Register definitions.
     29 * @ingroup arm_raspberrypi
     30 *
     31 * @brief Register Definitions
    2632 *
    2733 * @{
  • c/src/lib/libbsp/arm/raspberrypi/include/usart.h

    rea3e6928 r98eb7e78  
     1/**
     2 * @file
     3 *
     4 * @ingroup raspberrypi_usart
     5 *
     6 * @brief USART support.
     7 */
     8
     9
     10/**
     11 * @defgroup raspberrypi_usart USART Support
     12 *
     13 * @ingroup arm_raspberrypi
     14 *
     15 * @brief Universal Synchronous/Asynchronous Receiver/Transmitter (USART) Support
     16 */
     17
    118/*
    219 * Copyright (c) 2013 Alan Cudmore.
  • c/src/lib/libbsp/arm/raspberrypi/irq/irq.c

    rea3e6928 r98eb7e78  
    22 * @file
    33 *
    4  * @ingroup bsp_interrupt
     4 * @ingroup raspberrypi_interrupt
    55 *
    66 * @brief Interrupt support.
  • c/src/lib/libbsp/arm/raspberrypi/startup/bspreset.c

    rea3e6928 r98eb7e78  
    22 * @file
    33 *
    4  * @ingroup raspberrypi
     4 * @ingroup arm_start
    55 *
    6  * @brief Reset code.
     6 * @brief Raspberry Pi reset code.
    77 */
    88
  • c/src/lib/libbsp/arm/raspberrypi/startup/bspstart.c

    rea3e6928 r98eb7e78  
    22 * @file
    33 *
    4  * @ingroup raspberrypi
     4 * @ingroup arm_start
    55 *
    6  * @brief Startup code.
     6 * @brief Raspberry pi startup code.
    77 */
    88
  • c/src/lib/libbsp/arm/raspberrypi/startup/bspstarthooks.c

    rea3e6928 r98eb7e78  
    22 * @file
    33 *
    4  * @ingroup raspberrypi
     4 * @ingroup arm_start
    55 *
    6  * @brief Startup code.
     6 * @brief Rasberry Pi startup code.
    77 */
    88
  • c/src/lib/libbsp/arm/raspberrypi/startup/linkcmds

    rea3e6928 r98eb7e78  
    22 * @file
    33 *
    4  * @ingroup raspberry_pi
     4 * @ingroup raspberrypi_linker
    55 *
    6  * @brief Memory map.
     6 * @brief Memory map
    77 */
    88
    99/**
    10  * @defgroup raspberry_pi Memory Map
     10 * @defgroup raspberrypi_linker Raspberry Pi Memory Map
    1111 *
    1212 * @ingroup bsp_linker
    1313 *
    1414 * @brief Raspberry Pi memory map.
    15  *
     15 */
     16
     17/**
    1618 * <table>
    1719 *   <tr><th>Region Name</th><th>Region Begin</th><th>Region Size</th></tr>
  • c/src/lib/libbsp/arm/raspberrypi/startup/mm_config_table.c

    rea3e6928 r98eb7e78  
     1/**
     2 * @file
     3 *
     4 * @ingroup arm_start
     5 *
     6 * @brief Raspberry Pi low level start
     7 */
     8
    19/*
    210 * Copyright (c) 2013 embedded brains GmbH.  All rights reserved.
  • c/src/lib/libbsp/arm/shared/include/start.h

    rea3e6928 r98eb7e78  
    22 * @file
    33 *
    4  * @ingroup bsp_start
     4 * @ingroup arm_start
    55 *
    6  * @brief System low level start.
     6 * @brief ARM system low level start.
    77 */
    88
     
    3333
    3434/**
    35  * @defgroup bsp_start System Start
     35 * @defgroup arm_start System Start
    3636 *
    37  * @ingroup bsp_kit
     37 * @ingroup bsp_arm
    3838 *
    39  * @brief System low level start.
     39 * @brief ARM system low level start.
    4040 *
    4141 * @{
     
    141141
    142142#endif /* LIBBSP_ARM_SHARED_START_H */
     143
     144/**
     145 * @defgroup bsp_arm ARM
     146 *
     147 * @ingroup bsp_kit
     148 *
     149 * @brief ARM Board Support Packages.
     150 */
  • c/src/lib/libbsp/shared/clockdrv_shell.h

    rea3e6928 r98eb7e78  
    11/**
    2  *  @file
     2 * @file
    33 *
    4  *  Clock Tick Device Driver Shell
     4 * @ingroup bsp_clock
     5 *
     6 * @brief Clock Tick Device Driver Shell
    57 */
    68
     
    1820#include <bsp.h>
    1921
     22/**
     23 * @defgroup bsp_clock Clock Support
     24 *
     25 * @ingroup bsp_kit
     26 *
     27 * @brief Clock support
     28 *
     29 */
    2030#if CLOCK_DRIVER_USE_FAST_IDLE && CLOCK_DRIVER_ISRS_PER_TICK
    2131#error "clockdrv_shell.h: Fast Idle PLUS n ISRs per tick is not supported"
    2232#endif
    2333
    24 /*
    25  * This method is rarely used so default it.
     34/**
     35 * @brief This method is rarely used so default it.
    2636 */
    2737#ifndef Clock_driver_support_find_timer
     
    2939#endif
    3040
    31 /*
    32  * ISRs until next clock tick
     41/**
     42 * @brief ISRs until next clock tick
    3343 */
    3444#if CLOCK_DRIVER_ISRS_PER_TICK
     
    3646#endif
    3747
    38 /*
    39  * Clock ticks since initialization
     48/**
     49 * @brief Clock ticks since initialization
    4050 */
    4151volatile uint32_t    Clock_driver_ticks;
     
    4353void Clock_exit( void );
    4454
    45 /*
    46  *  Clock_isr
     55/**
     56 *  @brief Clock_isr
    4757 *
    4858 *  This is the clock tick interrupt handler.
    4959 *
    50  *  Input parameters:
    51  *    vector - vector number
     60 *  @param vector Vector number.
    5261 *
    5362 *  Output parameters:  NONE
     
    109118}
    110119
    111 /*
    112  *  Clock_exit
     120/**
     121 *  @brief Clock_exit
    113122 *
    114123 *  This routine allows the clock driver to exit by masking the interrupt and
     
    130139}
    131140
    132 /*
    133  * Clock_initialize
     141/**
     142 * @brief Clock_initialize
    134143 *
    135  *  This routine initializes the clock driver.
     144 * This routine initializes the clock driver.
    136145 *
    137  *  Input parameters:
    138  *    major - clock device major number
    139  *    minor - clock device minor number
    140  *    parg  - pointer to optional device driver arguments
     146 * @param[in] major Clock device major number.
     147 * @param[in] minor Clock device minor number.
     148 * @param[in] parg  Pointer to optional device driver arguments
    141149 *
    142  *  Output parameters:  NONE
    143  *
    144  *  Return values:
    145  *    rtems_device_driver status code
     150 * @retval rtems_device_driver status code
    146151 */
    147152
Note: See TracChangeset for help on using the changeset viewer.