From 8d830fae236dc04bc8f38498bafb3ff5cc615a89 Mon Sep 17 00:00:00 2001 From: Radu Date: Mon, 2 Dec 2013 14:07:35 -0600 Subject: leon2_doxygen_1 --- c/src/lib/libbsp/sparc/leon2/clock/ckinit.c | 6 ++++++ c/src/lib/libbsp/sparc/leon2/console/console.c | 6 ++++++ c/src/lib/libbsp/sparc/leon2/console/debugputs.c | 6 ++++++ c/src/lib/libbsp/sparc/leon2/gnatsupp/gnatsupp.c | 6 ++++++ c/src/lib/libbsp/sparc/leon2/include/bsp.h | 7 +++++++ c/src/lib/libbsp/sparc/leon2/include/bsp/irq.h | 6 ++++++ c/src/lib/libbsp/sparc/leon2/include/cchip.h | 7 +++++++ c/src/lib/libbsp/sparc/leon2/include/leon.h | 7 +++++++ c/src/lib/libbsp/sparc/leon2/include/rasta.h | 7 +++++++ c/src/lib/libbsp/sparc/leon2/include/tm27.h | 6 ++++++ c/src/lib/libbsp/sparc/leon2/leon_smc91111/leon_smc91111.c | 6 ++++++ c/src/lib/libbsp/sparc/leon2/pci/pci.c | 6 ++++++ c/src/lib/libbsp/sparc/leon2/rasta/rasta.c | 6 ++++++ c/src/lib/libbsp/sparc/leon2/startup/bspdelay.c | 6 +++--- c/src/lib/libbsp/sparc/leon2/startup/bspidle.c | 6 ++++++ c/src/lib/libbsp/sparc/leon2/startup/bsppredriver.c | 6 ++++++ c/src/lib/libbsp/sparc/leon2/startup/bspstart.c | 6 ++++++ c/src/lib/libbsp/sparc/leon2/startup/setvec.c | 6 ++++++ c/src/lib/libbsp/sparc/leon2/startup/spurious.c | 6 ++++++ c/src/lib/libbsp/sparc/leon2/timer/timer.c | 6 ++++++ 20 files changed, 121 insertions(+), 3 deletions(-) diff --git a/c/src/lib/libbsp/sparc/leon2/clock/ckinit.c b/c/src/lib/libbsp/sparc/leon2/clock/ckinit.c index d2d883ce61..b830bfdcc0 100644 --- a/c/src/lib/libbsp/sparc/leon2/clock/ckinit.c +++ b/c/src/lib/libbsp/sparc/leon2/clock/ckinit.c @@ -1,3 +1,9 @@ +/** + * @file + * @ingroup sparc_leon2 + * @brief Clock Tick Device Driver + */ + /* * Clock Tick Device Driver * diff --git a/c/src/lib/libbsp/sparc/leon2/console/console.c b/c/src/lib/libbsp/sparc/leon2/console/console.c index e10fae82c4..6adefa122d 100644 --- a/c/src/lib/libbsp/sparc/leon2/console/console.c +++ b/c/src/lib/libbsp/sparc/leon2/console/console.c @@ -1,3 +1,9 @@ +/** + * @file + * @ingroup sparc_leon2 + * @brief TTY driver driver for the serial ports on the LEON console + */ + /* * This file contains the TTY driver for the serial ports on the LEON. * diff --git a/c/src/lib/libbsp/sparc/leon2/console/debugputs.c b/c/src/lib/libbsp/sparc/leon2/console/debugputs.c index 452cf0a6b9..1e3f511101 100644 --- a/c/src/lib/libbsp/sparc/leon2/console/debugputs.c +++ b/c/src/lib/libbsp/sparc/leon2/console/debugputs.c @@ -1,3 +1,9 @@ +/** + * @file + * @ingroup sparc_leon2 + * @brief TTY driver for the serial ports on the LEON + */ + /* * This file contains the TTY driver for the serial ports on the LEON. * diff --git a/c/src/lib/libbsp/sparc/leon2/gnatsupp/gnatsupp.c b/c/src/lib/libbsp/sparc/leon2/gnatsupp/gnatsupp.c index 4fe9320cff..b3a7c18fc0 100644 --- a/c/src/lib/libbsp/sparc/leon2/gnatsupp/gnatsupp.c +++ b/c/src/lib/libbsp/sparc/leon2/gnatsupp/gnatsupp.c @@ -1,3 +1,9 @@ +/** + * @file + * @ingroup sparc_leon2 + * @brief Support for gnat/rtems iterrupts and exception handling + */ + /* * * Support for gnat/rtems interrupts and exception handling. diff --git a/c/src/lib/libbsp/sparc/leon2/include/bsp.h b/c/src/lib/libbsp/sparc/leon2/include/bsp.h index 19fc48786f..db8baca756 100644 --- a/c/src/lib/libbsp/sparc/leon2/include/bsp.h +++ b/c/src/lib/libbsp/sparc/leon2/include/bsp.h @@ -1,3 +1,10 @@ +/** + * @file + * @defgroup sparc_leon2 Sparc Leon2 Handler + * @ingroup bsp_kit + * @brief Handles Sparc Leon2 simulator + */ + /* bsp.h * * This include file contains all SPARC simulator definitions. diff --git a/c/src/lib/libbsp/sparc/leon2/include/bsp/irq.h b/c/src/lib/libbsp/sparc/leon2/include/bsp/irq.h index 709b5631aa..acf1f7bcdb 100644 --- a/c/src/lib/libbsp/sparc/leon2/include/bsp/irq.h +++ b/c/src/lib/libbsp/sparc/leon2/include/bsp/irq.h @@ -1,3 +1,9 @@ +/** + * @file + * @ingroup sparc_leon2 + * @brief Interrupts definitions + */ + /* LEON2 generic shared IRQ setup * * Based on libbsp/shared/include/irq.h. diff --git a/c/src/lib/libbsp/sparc/leon2/include/cchip.h b/c/src/lib/libbsp/sparc/leon2/include/cchip.h index 216d3fb939..beb9f74917 100644 --- a/c/src/lib/libbsp/sparc/leon2/include/cchip.h +++ b/c/src/lib/libbsp/sparc/leon2/include/cchip.h @@ -1,3 +1,10 @@ +/** + * @file + * @defgroup cchip Companion Chip handler + * @ingroup sparc_leon2 + * @brief Register all drivers supported by the Companion Chip board + */ + #ifndef __CCHIP_H__ #define __CCHIP_H__ diff --git a/c/src/lib/libbsp/sparc/leon2/include/leon.h b/c/src/lib/libbsp/sparc/leon2/include/leon.h index 8aab12d036..e3d39dc307 100644 --- a/c/src/lib/libbsp/sparc/leon2/include/leon.h +++ b/c/src/lib/libbsp/sparc/leon2/include/leon.h @@ -1,3 +1,10 @@ +/** + * @file + * @defgroup leon1 Leon-1 Handler + * @ingroup sparc_leon2 + * @brief Handlers Leon-1 + */ + /* erc32.h * * This include file contains information pertaining to the LEON-1. diff --git a/c/src/lib/libbsp/sparc/leon2/include/rasta.h b/c/src/lib/libbsp/sparc/leon2/include/rasta.h index 123cb22579..0073ad7bac 100644 --- a/c/src/lib/libbsp/sparc/leon2/include/rasta.h +++ b/c/src/lib/libbsp/sparc/leon2/include/rasta.h @@ -1,3 +1,10 @@ +/** + * @file + * @defgroup leon2_rasta Rasta Handler + * @ingroup sparc_leon2 + * @brief Handles Rasta + */ + #ifndef __RASTA_H__ #define __RASTA_H__ diff --git a/c/src/lib/libbsp/sparc/leon2/include/tm27.h b/c/src/lib/libbsp/sparc/leon2/include/tm27.h index 8e8e43c19b..09b393709c 100644 --- a/c/src/lib/libbsp/sparc/leon2/include/tm27.h +++ b/c/src/lib/libbsp/sparc/leon2/include/tm27.h @@ -1,3 +1,9 @@ +/** + * @file + * @ingroup sparc_leon2 + * @brief Implementations for interrupt mechanisms for Time Test 27 + */ + /* * tm27.h * diff --git a/c/src/lib/libbsp/sparc/leon2/leon_smc91111/leon_smc91111.c b/c/src/lib/libbsp/sparc/leon2/leon_smc91111/leon_smc91111.c index bbdd07279a..ad74c9a52b 100644 --- a/c/src/lib/libbsp/sparc/leon2/leon_smc91111/leon_smc91111.c +++ b/c/src/lib/libbsp/sparc/leon2/leon_smc91111/leon_smc91111.c @@ -1,3 +1,9 @@ +/** + * @file + * @ingroup sparc_leon2 + * @brief SMC91111 Driver + */ + #include #include diff --git a/c/src/lib/libbsp/sparc/leon2/pci/pci.c b/c/src/lib/libbsp/sparc/leon2/pci/pci.c index 7f48b1ea08..2fdacd1052 100644 --- a/c/src/lib/libbsp/sparc/leon2/pci/pci.c +++ b/c/src/lib/libbsp/sparc/leon2/pci/pci.c @@ -1,3 +1,9 @@ +/** + * @file + * @ingroup sparc_leon2 + * @brief Basic PCI Io functions + */ + /* * pci.c : this file contains basic PCI Io functions. * diff --git a/c/src/lib/libbsp/sparc/leon2/rasta/rasta.c b/c/src/lib/libbsp/sparc/leon2/rasta/rasta.c index 087f9bec45..754a6ff70d 100644 --- a/c/src/lib/libbsp/sparc/leon2/rasta/rasta.c +++ b/c/src/lib/libbsp/sparc/leon2/rasta/rasta.c @@ -1,3 +1,9 @@ +/** + * @file + * @ingroup leon2_rasta + * @brief GR-RASTA-IO PCI board driver + */ + /* * GR-RASTA-IO PCI board driver * diff --git a/c/src/lib/libbsp/sparc/leon2/startup/bspdelay.c b/c/src/lib/libbsp/sparc/leon2/startup/bspdelay.c index cca9377a56..341b0c12c0 100644 --- a/c/src/lib/libbsp/sparc/leon2/startup/bspdelay.c +++ b/c/src/lib/libbsp/sparc/leon2/startup/bspdelay.c @@ -1,7 +1,7 @@ /** - * @file - * - * LEON2 BSP Delay Method + * @file + * @ingroup sparc_leon2 + * @brief LEON2 BSP Delay Method */ /* diff --git a/c/src/lib/libbsp/sparc/leon2/startup/bspidle.c b/c/src/lib/libbsp/sparc/leon2/startup/bspidle.c index 54108c3020..552dea412d 100644 --- a/c/src/lib/libbsp/sparc/leon2/startup/bspidle.c +++ b/c/src/lib/libbsp/sparc/leon2/startup/bspidle.c @@ -1,3 +1,9 @@ +/** + * @file + * @ingroup sparc_leon2 + * @brief LEON2 Idle Thread + */ + /* * LEON2 Idle Thread with power-down function * diff --git a/c/src/lib/libbsp/sparc/leon2/startup/bsppredriver.c b/c/src/lib/libbsp/sparc/leon2/startup/bsppredriver.c index 4084b5ca97..7a12c8fb1d 100644 --- a/c/src/lib/libbsp/sparc/leon2/startup/bsppredriver.c +++ b/c/src/lib/libbsp/sparc/leon2/startup/bsppredriver.c @@ -1,3 +1,9 @@ +/** + * @file + * @ingroup sparc_leon2 + * @brief Installs BSP pre-driver hook + */ + /* Installs the BSP pre-driver hook * * COPYRIGHT (c) 2011 diff --git a/c/src/lib/libbsp/sparc/leon2/startup/bspstart.c b/c/src/lib/libbsp/sparc/leon2/startup/bspstart.c index 0fbb969ea5..eadf658e21 100644 --- a/c/src/lib/libbsp/sparc/leon2/startup/bspstart.c +++ b/c/src/lib/libbsp/sparc/leon2/startup/bspstart.c @@ -1,3 +1,9 @@ +/** + * @file + * @ingroup sparc_leon2 + * @brief LEON2 Cache Snooping Support + */ + /* * LEON2 Cache Snooping Support * diff --git a/c/src/lib/libbsp/sparc/leon2/startup/setvec.c b/c/src/lib/libbsp/sparc/leon2/startup/setvec.c index d5f69ee0b6..8513380dca 100644 --- a/c/src/lib/libbsp/sparc/leon2/startup/setvec.c +++ b/c/src/lib/libbsp/sparc/leon2/startup/setvec.c @@ -1,3 +1,9 @@ +/** + * @file + * @ingroup sparc_leon2 + * @brief Installs an interrupt vector on the SPARC simulator + */ + /* set_vector * * This routine installs an interrupt vector on the SPARC simulator. diff --git a/c/src/lib/libbsp/sparc/leon2/startup/spurious.c b/c/src/lib/libbsp/sparc/leon2/startup/spurious.c index c0500c770d..0aa6826ef6 100644 --- a/c/src/lib/libbsp/sparc/leon2/startup/spurious.c +++ b/c/src/lib/libbsp/sparc/leon2/startup/spurious.c @@ -1,3 +1,9 @@ +/** + * @file + * @ingroup sparc_leon2 + * @brief LEON Spurious Trap Handler + */ + /* * LEON Spurious Trap Handler * diff --git a/c/src/lib/libbsp/sparc/leon2/timer/timer.c b/c/src/lib/libbsp/sparc/leon2/timer/timer.c index 999b21e741..3fdb3222be 100644 --- a/c/src/lib/libbsp/sparc/leon2/timer/timer.c +++ b/c/src/lib/libbsp/sparc/leon2/timer/timer.c @@ -1,3 +1,9 @@ +/** + * @file + * @ingroup sparc_leon2 + * @brief Implement a benchmark timer using timer 2 + */ + /* timer.c * * This file implements a benchmark timer using timer 2. -- cgit v1.2.3