Changeset c541862e in rtems


Ignore:
Timestamp:
Dec 23, 2013, 4:44:42 PM (5 years ago)
Author:
Chirayu Desai <cdesai@…>
Branches:
4.11, master
Children:
9dc999a
Parents:
8224d2af
git-author:
Chirayu Desai <cdesai@…> (12/23/13 16:44:42)
git-committer:
Gedare Bloom <gedare@…> (12/23/13 17:21:32)
Message:

lm32: Add doxygen

Location:
c/src/lib/libbsp/lm32/shared
Files:
1 added
20 edited

Legend:

Unmodified
Added
Removed
  • c/src/lib/libbsp/lm32/shared/clock/clock.h

    r8224d2af rc541862e  
     1/**
     2 * @file
     3 * @ingroup lm32_clock
     4 * @brief LatticeMico32 Timer (Clock) definitions
     5 */
     6
    17/*
    28 *  This file contains definitions for LatticeMico32 Timer (Clock)
     
    1319 */
    1420
     21/**
     22 * @defgroup lm32_clock LM32 Clock
     23 * @ingroup lm32_shared
     24 * @brief LatticeMico32 Timer (Clock) definitions.
     25 * @{
     26 */
     27
    1528#ifndef _BSPCLOCK_H
    1629#define _BSPCLOCK_H
    1730
    18 /* Status Register */
     31/** @brief Status Register */
    1932
    2033#define LM32_CLOCK_SR       (0x0000)
     
    2235#define LM32_CLOCK_SR_RUN   (0x0002)
    2336
    24 /* Control Register */
     37/** @brief Control Register */
    2538
    2639#define LM32_CLOCK_CR       (0x0004)
     
    3043#define LM32_CLOCK_CR_STOP  (0x0008)
    3144
    32 /* Period Register */
     45/** @brief Period Register */
    3346
    3447#define LM32_CLOCK_PERIOD   (0x0008)
    3548
    36 /* Snapshot Register */
     49/** @brief Snapshot Register */
    3750
    3851#define LM32_CLOCK_SNAPSHOT (0x000C)
    3952
    4053#endif /* _BSPCLOCK_H */
     54
     55/** @} */
  • c/src/lib/libbsp/lm32/shared/gdbstub/gdb_if.h

    r8224d2af rc541862e  
     1/**
     2 * @file
     3 * @ingroup lm32_gdb
     4 * @brief definition of the interface between the stub and gdb
     5 */
     6
    17/*
    28 * gdb_if.h - definition of the interface between the stub and gdb
     
    1319 */
    1420
     21/**
     22 * @defgroup lm32_gdb LM32 GDB Interface
     23 * @ingroup lm32_shared
     24 * @brief Definition of the interface between the stub and gdb,
     25 * @{
     26 */
     27
    1528#ifndef _GDB_IF_H
    1629#define _GDB_IF_H
    1730
    18 /* Max number of threads in qM response */
     31/** @brief Max number of threads in qM response */
    1932#define QM_MAX_THREADS (20)
    2033
     
    7184);
    7285
    73 /* Exception IDs */
     86/** @brief Exception IDs */
    7487#define LM32_EXCEPTION_RESET                  0x0
    7588#define LM32_EXCEPTION_INST_BREAKPOINT        0x1
     
    8194#define LM32_EXCEPTION_SYSTEM_CALL            0x7
    8295
    83 /* Breakpoint instruction */
     96/** @brief Breakpoint instruction */
    8497#define LM32_BREAK                            0xac000002UL
    8598
    86 /* This numbering must be consistant with GDBs numbering in gdb/lm32-tdep.c */
     99/** @brief This numbering must be consistant with GDBs numbering in gdb/lm32-tdep.c */
    87100enum lm32_regnames {
    88101  LM32_REG_R0, LM32_REG_R1, LM32_REG_R2, LM32_REG_R3, LM32_REG_R4, LM32_REG_R5,
     
    109122
    110123#endif /* _GDB_IF_H */
     124
     125/** @} */
  • c/src/lib/libbsp/lm32/shared/milkymist_ac97/milkymist_ac97.h

    r8224d2af rc541862e  
     1/**
     2 * @file
     3 * @ingroup lm32_milkymist_ac97 lm32_milkymist_shared
     4 * @brief Milkymist AC97 driver
     5 */
     6
    17/*  milkymist_ac97.h
    28 *
     
    814 *
    915 *  COPYRIGHT (c) 2010 Sebastien Bourdeauducq
     16 */
     17
     18/**
     19 * @defgroup lm32_milkymist_ac97 Milkymist AC97
     20 * @ingroup lm32_milkymist_shared
     21 * @brief Milkymist AC97 driver
     22 * @{
    1023 */
    1124
     
    5568ac97_open, NULL, NULL, NULL, ac97_control}
    5669
     70/** @} */
     71
    5772#ifdef __cplusplus
    5873}
  • c/src/lib/libbsp/lm32/shared/milkymist_buttons/milkymist_buttons.h

    r8224d2af rc541862e  
     1/**
     2 * @file
     3 * @ingroup lm32_milkymist_buttons lm32_milkymist_shared
     4 * @brief Milkymist buttons driver
     5 */
     6
    17/*  milkymist_buttons.h
    28 *
     
    814 *
    915 *  COPYRIGHT (c) 2011 Sebastien Bourdeauducq
     16 */
     17
     18/**
     19 * @defgroup lm32_milkymist_buttons Milkymist buttons
     20 * @ingroup lm32_milkymist_shared
     21 * @brief Milkymist buttons driver
     22 * @{
    1023 */
    1124
     
    3851buttons_open, NULL, buttons_read, NULL, NULL}
    3952
     53/** @} */
     54
    4055#ifdef __cplusplus
    4156}
  • c/src/lib/libbsp/lm32/shared/milkymist_clock/clock.h

    r8224d2af rc541862e  
     1/**
     2 * @file
     3 * @ingroup lm32_clock lm32_milkymist_shared
     4 * @brief LatticeMico32 Timer (Clock) definitions
     5 */
     6
    17/*
    28 *  This file contains definitions for LatticeMico32 Timer (Clock)
  • c/src/lib/libbsp/lm32/shared/milkymist_console/uart.h

    r8224d2af rc541862e  
     1/**
     2 * @file
     3 * @ingroup lm32_milkymist_uart lm32_milkymist_shared
     4 * @brief Milkymist UART definitions
     5 */
     6
    17/*
    28 *  This file contains definitions for the Milkymist UART
     
    511 *  found in the file LICENSE in this distribution or at
    612 *  http://www.rtems.com/license/LICENSE.
     13 */
     14
     15/**
     16 * @defgroup lm32_milkymist_uart Milkymist UART
     17 * @ingroup lm32_milkymist_shared
     18 * @brief Milkymist UART definitions
     19 * @{
    720 */
    821
     
    1528
    1629#endif /* _BSPUART_H */
     30
     31/** @} */
  • c/src/lib/libbsp/lm32/shared/milkymist_dmx/milkymist_dmx.h

    r8224d2af rc541862e  
     1/**
     2 * @file
     3 * @ingroup lm32_milkymist_dmx lm32_milkymist_shared
     4 * @brief Milkymist DMX512 driver
     5 */
     6
    17/*  milkymist_dmx.h
    28 *
     
    814 *
    915 *  COPYRIGHT (c) 2010 Sebastien Bourdeauducq
     16 */
     17
     18/**
     19 * @defgroup lm32_milkymist_dmx Milkymist DMX512
     20 * @ingroup lm32_milkymist_shared
     21 * @brief Milkymist DMX512 driver
     22 * @{
    1023 */
    1124
     
    4760NULL, NULL, dmx_read, dmx_write, dmx_control}
    4861
     62/** @} */
     63
    4964#ifdef __cplusplus
    5065}
  • c/src/lib/libbsp/lm32/shared/milkymist_gpio/milkymist_gpio.h

    r8224d2af rc541862e  
     1/**
     2 * @file
     3 * @ingroup lm32_milkymist_gpio lm32_milkymist_shared
     4 * @brief Milkymist GPIO driver
     5 */
     6
    17/*  milkymist_gpio.h
    28 *
     
    814 *
    915 *  COPYRIGHT (c) 2010 Sebastien Bourdeauducq
     16 */
     17
     18/**
     19 * @defgroup lm32_milkymist_gpio Milkymist GPIO
     20 * @ingroup lm32_milkymist_shared
     21 * @brief Milkymist GPIO driver
     22 * @{
    1023 */
    1124
     
    3851NULL, NULL, gpio_read, gpio_write, NULL}
    3952
     53/** @} */
     54
    4055#ifdef __cplusplus
    4156}
  • c/src/lib/libbsp/lm32/shared/milkymist_ir/milkymist_ir.h

    r8224d2af rc541862e  
     1/**
     2 * @file
     3 * @ingroup lm32_milkymist_ir lm32_milkymist_shared
     4 * @brief Milkymist RC5 IR driver
     5 */
     6
    17/*  milkymist_ir.h
    28 *
     
    814 *
    915 *  COPYRIGHT (c) 2010 Sebastien Bourdeauducq
     16 */
     17
     18/**
     19 * @defgroup lm32_milkymist_ir Milkymist IR
     20 * @ingroup lm32_milkymist_shared
     21 * @brief Milkymist RC5 IR driver
     22 * @{
    1023 */
    1124
     
    3851ir_open, NULL, ir_read, NULL, NULL}
    3952
     53/** @} */
     54
    4055#ifdef __cplusplus
    4156}
  • c/src/lib/libbsp/lm32/shared/milkymist_memcard/milkymist_memcard.h

    r8224d2af rc541862e  
     1/**
     2 * @file
     3 * @ingroup lm32_milkymist_memcard lm32_milkymist_shared
     4 * @brief Milkymist memory card driver
     5 */
     6
    17/*  milkymist_memcard.h
    28 *
     
    1016 */
    1117
     18/**
     19 * @defgroup lm32_milkymist_memcard Milkymist memory card
     20 * @ingroup lm32_milkymist_shared
     21 * @brief Milkymist memory card driver
     22 * @{
     23 */
     24
    1225#ifndef __MILKYMIST_MEMCARD_H_
    1326#define __MILKYMIST_MEMCARD_H_
     
    1629
    1730#endif /* __MILKYMIST_MEMCARD_H_ */
     31
     32/** @} */
  • c/src/lib/libbsp/lm32/shared/milkymist_midi/milkymist_midi.h

    r8224d2af rc541862e  
     1/**
     2 * @file
     3 * @ingroup lm32_milkymist_midi lm32_milkymist_shared
     4 * @brief Milkymist MIDI driver
     5 */
     6
    17/*  milkymist_midi.h
    28 *
     
    814 *
    915 *  COPYRIGHT (c) 2010 Sebastien Bourdeauducq
     16 */
     17
     18/**
     19 * @defgroup lm32_milkymist_midi Milkymist MIDI
     20 * @ingroup lm32_milkymist_shared
     21 * @brief Milkymist MIDI driver
     22 * @{
    1023 */
    1124
     
    3851midi_open, NULL, midi_read, NULL, NULL}
    3952
     53/** @} */
     54
    4055#ifdef __cplusplus
    4156}
  • c/src/lib/libbsp/lm32/shared/milkymist_networking/network.h

    r8224d2af rc541862e  
     1/**
     2 * @file
     3 * @ingroup lm32_milkymist_network lm32_milkymist_shared
     4 * @brief Driver for Minimac ethernet
     5 */
     6
    17/*  network.h
    28 *
     
    1117 */
    1218
     19/**
     20 * @defgroup lm32_milkymist_network Minimac ethernet driver
     21 * @ingroup lm32_milkymist_shared
     22 * @brief Driver for Minimac ethernet IP-core of Milkymist SoC
     23 * @{
     24 */
    1325
    1426#ifndef __MILKYMIST_NETWORKING_H_
  • c/src/lib/libbsp/lm32/shared/milkymist_pfpu/milkymist_pfpu.h

    r8224d2af rc541862e  
     1/**
     2 * @file
     3 * @ingroup lm32_milkymist_pfpu lm32_milkymist_shared
     4 * @brief Milkymist PFPU driver
     5 */
     6
    17/*  milkymist_pfpu.h
    28 *
     
    814 *
    915 *  COPYRIGHT (c) 2010 Sebastien Bourdeauducq
     16 */
     17
     18/**
     19 * @defgroup lm32_milkymist_pfpu Milkymist PFPU
     20 * @ingroup lm32_milkymist_shared
     21 * @brief Milkymist PFPU driver
     22 * @{
    1023 */
    1124
     
    3043        unsigned int progsize;
    3144        float *registers;
    32         bool update; /* < shall we update the "registers" array after completion */
    33         bool invalidate; /* < shall we invalidate L1 data cache after completion */
     45        /** @brief shall we update the "registers" array after completion */
     46        bool update;
     47        /** @brief shall we invalidate L1 data cache after completion */
     48        bool invalidate;
    3449};
    3550
     
    4964NULL, NULL, NULL, NULL, pfpu_control}
    5065
     66/** @} */
     67
    5168#ifdef __cplusplus
    5269}
  • c/src/lib/libbsp/lm32/shared/milkymist_tmu/milkymist_tmu.h

    r8224d2af rc541862e  
     1/**
     2 * @file
     3 * @ingroup lm32_milkymist_tmu lm32_milkymist_shared
     4 * @brief Milkymist TMU driver
     5 */
     6
    17/*  milkymist_tmu.h
    28 *
     
    814 *
    915 *  COPYRIGHT (c) 2010 Sebastien Bourdeauducq
     16 */
     17
     18/**
     19 * @defgroup lm32_milkymist_tmu Milkymist TMU
     20 * @ingroup lm32_milkymist_shared
     21 * @brief Milkymist TMU driver
     22 * @{
    1023 */
    1124
     
    7790NULL, NULL, NULL, NULL, tmu_control}
    7891
     92/** @} */
     93
    7994#ifdef __cplusplus
    8095}
  • c/src/lib/libbsp/lm32/shared/milkymist_usbinput/comloc.h

    r8224d2af rc541862e  
     1/**
     2 * @file
     3 * @ingroup lm32_milkymist_usbinput lm32_milkymist_shared
     4 * @brief Milkymist USB input devices driver
     5 */
     6
    17/*  comloc.h
    28 *
  • c/src/lib/libbsp/lm32/shared/milkymist_usbinput/milkymist_usbinput.h

    r8224d2af rc541862e  
     1/**
     2 * @file
     3 * @ingroup lm32_milkymist_usbinput lm32_milkymist_shared
     4 * @brief Milkymist USB input devices driver
     5 */
     6
    17/*  milkymist_usbinput.h
    28 *
     
    814 *
    915 *  COPYRIGHT (c) 2010, 2012 Sebastien Bourdeauducq
     16 */
     17
     18/**
     19 * @defgroup lm32_milkymist_usbinput Milkymist USB input devices
     20 * @ingroup lm32_milkymist_shared
     21 * @brief Milkymist USB input devices driver
     22 * @{
    1023 */
    1124
  • c/src/lib/libbsp/lm32/shared/milkymist_versions/milkymist_versions.h

    r8224d2af rc541862e  
     1/**
     2 * @file
     3 * @ingroup lm32_milkymist_versions lm32_milkymist_shared
     4 * @brief Milkymist versioning driver
     5 */
     6
    17/*  milkymist_versions.h
    28 *
     
    814 *
    915 *  COPYRIGHT (c) 2010 Sebastien Bourdeauducq
     16 */
     17
     18/**
     19 * @defgroup lm32_milkymist_versions Milkymist versioning
     20 * @ingroup lm32_milkymist_shared
     21 * @brief Milkymist versioning driver
     22 * @{
    1023 */
    1124
     
    3245NULL, NULL, versions_read, NULL, NULL}
    3346
     47/** @} */
     48
    3449#ifdef __cplusplus
    3550}
  • c/src/lib/libbsp/lm32/shared/milkymist_video/milkymist_video.h

    r8224d2af rc541862e  
     1/**
     2 * @file
     3 * @ingroup lm32_milkymist_video lm32_milkymist_shared
     4 * @brief Milkymist video input driver
     5 */
     6
    17/*  milkymist_video.h
    28 *
     
    814 *
    915 *  COPYRIGHT (c) 2010, 2011 Sebastien Bourdeauducq
     16 */
     17
     18/**
     19 * @defgroup lm32_milkymist_video Milkymist Video
     20 * @ingroup lm32_milkymist_shared
     21 * @brief Milkymist video input driver
     22 * @{
    1023 */
    1124
     
    6982video_open, video_close, NULL, NULL, video_control}
    7083
     84/** @} */
     85
    7186#ifdef __cplusplus
    7287}
  • c/src/lib/libbsp/lm32/shared/tsmac/dp83848phy.h

    r8224d2af rc541862e  
     1/**
     2 * @file
     3 * @ingroup lm32_tsmac
     4 * @brief LatticeMico32 TSMAC (Tri-Speed MAC) definitions
     5 */
     6
    17/*
    28 *  This file contains definitions for LatticeMico32 TSMAC (Tri-Speed MAC)
  • c/src/lib/libbsp/lm32/shared/tsmac/tsmac.h

    r8224d2af rc541862e  
     1/**
     2 * @file
     3 * @ingroup lm32_tsmac
     4 * @brief LatticeMico32 TSMAC (Tri-Speed MAC) definitions.
     5 */
     6
    17/*
    28 *  This file contains definitions for LatticeMico32 TSMAC (Tri-Speed MAC)
     
    1117 *  Jukka Pietarinen <jukka.pietarinen@mrf.fi>, 2008,
    1218 *  Micro-Research Finland Oy
     19 */
     20
     21/**
     22 * @defgroup lm32_tsmac LM32 TSMAC
     23 * @ingroup lm32_shared
     24 * @brief LatticeMico32 TSMAC (Tri-Speed MAC) definitions.
     25 * @{
    1326 */
    1427
     
    157170
    158171#endif /* _BSPTSMAC_H */
     172/** @} */
Note: See TracChangeset for help on using the changeset viewer.