RIOT-OS/RIOT
RIOT-OS/RIOT
1
0
Fork 0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2024-12-29 04:50:03 +01:00
Code Releases Activity

Added the boards folder to the doxygen tree

Browse Source 
- added boards to riot.doxyfile
- fixed group definitions for all boards
This commit is contained in:
Hauke Petersen 2013-11-28 12:57:41 +01:00
parent edcabf7cb6
commit c629229e8d
17 changed files with 281 additions and 181 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
boards/avsextrem/include/board.h
View File

@ -1,23 +1,24 @@
/*
* board.h - Definitions for the AVSEXTREM board configuration.
* Copyright (C) 2013 Zakaria Kasmi <zkasmi@inf.fu-berlin.de>
*
* This source code is licensed under the LGPLv2 license,
* See the file LICENSE for more details.
*
*/
* Copyright (C) 2013 Zakaria Kasmi <zkasmi@inf.fu-berlin.de>
*
* This source code is licensed under the LGPLv2 license,
* See the file LICENSE for more details.
*
*/
/**
* @file
* @defgroup boards_avsextrem Avsextrem
* @ingroup boards
* @brief Boards specific drivers and configuration for the Avsextrem board
* @{
*
* @file board.h
* @brief avsextrem board configuration
*
* @author Freie Universität Berlin, Computer Systems & Telematics
* @author Heiko Will
* @author Zakaria Kasmi
* @version $Revision: 1127 $
*
* @note $Id: board-conf.h 1127 2013-06-13 08:48:29Z kasmi$
*/
@ -63,4 +64,3 @@ typedef uint8_t radio_packet_length_t;
/** @} */
#endif /* BOARDCONF_H_ */

20
boards/chronos/include/board.h
View File

@ -1,3 +1,23 @@
/*
* Copyright (C) 2013 Freie Universität Berlin
*
* This file subject to the terms and conditions of the GNU Lesser General
* Public License. See the file LICENSE in the top level directory for more
* details.
*/
/**
* @defgroup boards_chronos Chronos
* @ingroup boards
* @brief Support for the chronos board
* @{
*
* @file board.h
* @brief Header for the chronos board
*
* @author unknwon
*/
#ifndef _MSB_BOARD_H
#define _MSB_BOARD_H

16
boards/doc.txt Normal file
View File

@ -0,0 +1,16 @@
/*
* Copyright (C) 2013 Freie Universität Berlin
*
* This file subject to the terms and conditions of the GNU Lesser General
* Public License. See the file LICENSE in the top level directory for more
* details.
*/
/**
* @defgroup boards Boards
* @brief Board specific definitions and implementations
*
* The boards module contains all definitions and implementations, that are specific to a certain board. Boards
* generally consist of a fixed configuration of a controller and some external devices as sensors or radios. All
* aspects concerning pin-configurion, mcu clock and driver configuration should go into this module.
*/

20
boards/msb-430-common/include/board-conf.h
View File

@ -1,3 +1,23 @@
/*
* Copyright (C) 2013 Freie Universität Berlin
*
* This file subject to the terms and conditions of the GNU Lesser General
* Public License. See the file LICENSE in the top level directory for more
* details.
*/
/**
* @defgroup boards_msb430-common MSB-430 common
* @ingroup boards
* @brief Common files for all MSB-430 boards
* @{
*
* @file board-config.h
* @brief Common definitions for all msb-430 based boards
*
* @author unknown
*/
#ifndef BOARD_CONF_H
#define BOARD_CONF_H

34
boards/msb-430/include/board.h
View File

@ -1,4 +1,4 @@
/******************************************************************************
/*
Copyright 2009, Freie Universitaet Berlin (FUB). All rights reserved.
These sources were developed at the Freie Universitaet Berlin, Computer Systems
@ -24,30 +24,26 @@ and the mailinglist (subscription via web site)
scatterweb@lists.spline.inf.fu-berlin.de
*******************************************************************************/
#ifndef _MSB_BOARD_H
#define _MSB_BOARD_H
/**
* @defgroup msb_430h ScatterWeb MSB-430H
* @ingroup msp430
* @defgroup boards_msb430 MSB-430
* @ingroup boards
* @brief Support for the msb-430 board
*
<h2>Compontents</h2>
\li MSP430
\li CC1100
* @{
*/
/**
* @file
* @brief MSB-430H Board
* <h2>Compontents</h2>
* \li MSP430
* \li CC1100
*
* @{
*
* @file board.h
* @brief Central defnitions for the ScatterWeb MSB-430 board
*
* @author Freie Universität Berlin, Computer Systems & Telematics, FeuerWhere project
* @version $Revision$
*
* @note $Id$
*/
#ifndef _MSB_BOARD_H
#define _MSB_BOARD_H
#include "board-conf.h"
//MSB430 core

29
boards/msb-430h/include/board.h
View File

@ -1,4 +1,4 @@
/******************************************************************************
/*
Copyright 2009, Freie Universitaet Berlin (FUB). All rights reserved.
These sources were developed at the Freie Universitaet Berlin, Computer Systems
@ -24,30 +24,21 @@ and the mailinglist (subscription via web site)
scatterweb@lists.spline.inf.fu-berlin.de
*******************************************************************************/
#ifndef _MSB_BOARD_H
#define _MSB_BOARD_H
/**
* @defgroup msb_430h ScatterWeb MSB-430H
* @ingroup msp430
* @defgroup boards_msb430h MSB-430H
* @ingroup boards
* @brief Support for the ScatterWeb MSB-430H board
* @{
*
<h2>Compontents</h2>
\li MSP430
\li CC1100
* @{
*/
/**
* @file
* @brief MSB-430H Board
* @file board.h
* @brief Basic definitions for the MSB-430H board
*
* @author Freie Universität Berlin, Computer Systems & Telematics, FeuerWhere project
* @version $Revision$
*
* @note $Id$
*/
#ifndef _MSB_BOARD_H
#define _MSB_BOARD_H
//MSB430 core
#define MSP430_INITIAL_CPU_SPEED 7372800uL
#define MSP430_HAS_DCOR 1

29
boards/msba2-common/include/msba2_common.h
View File

@ -1,4 +1,4 @@
/******************************************************************************
/*
Copyright 2008, Freie Universitaet Berlin (FUB). All rights reserved.
These sources were developed at the Freie Universitaet Berlin, Computer Systems
@ -24,24 +24,21 @@ and the mailinglist (subscription via web site)
scatterweb@lists.spline.inf.fu-berlin.de
*******************************************************************************/
/**
* @defgroup boards_msba2-common MSB-A2 common
* @ingroup boards
* @brief Common files for all MSB-A2 based boards
* @{
*
* @files msba2-common.h
* @brief MSB-A2 Common Board Definitions
*
* @author Freie Universität Berlin, Computer Systems & Telematics, FeuerWhere project
* @author Kaspar Schleiser <kaspar@schleiser.de>
*/
#ifndef __MSBA2_COMMON_H
#define __MSBA2_COMMON_H
/**
* @ingroup msb_a2
* @{
*/
/**
* @file
* @brief MSB-A2 Common Board Definitions
*
* @author Freie Universität Berlin, Computer Systems & Telematics, FeuerWhere project
* @author Kaspar Schleiser <kaspar@schleiser.de>
* @version $Revision$
*
* @note $Id$
*/
#include <stdint.h>
#include "lpc2387.h"

20
boards/msba2/include/board.h
View File

@ -1,3 +1,23 @@
/*
* Copyright (C) 2013 Freie Universität Berlin
*
* This file subject to the terms and conditions of the GNU Lesser General
* Public License. See the file LICENSE in the top level directory for more
* details.
*/
/**
* @defgroup boards_msba2 MSB-A2
* @ingroup boards
* @brief Support for the MSB-A2 board
* @{
*
* @file board.h
* @brief Basic definitions for the MSB-A2 board
*
* @author unknown
*/
#ifndef __BOARD_H
#define __BOARD_H

35
boards/native/include/board.h
View File

@ -1,23 +1,28 @@
#ifndef BOARD_H
#define BOARD_H
/**
* Native Board interface
*
* The native board uses call level hardware simulation.
*
/*
* Copyright (C) 2013 Ludwig Ortmann
*
* This file is subject to the terms and conditions of the LGPLv2. See
* the file LICENSE in the top level directory for more details.
*
* @defgroup native_board
* @{
* @file
* @author Ludwig Ortmann <ludwig.ortmann@fu-berlin.de>
* @}
*/
/**
* @defgroup boards_native Native Board
* @ingroup boards
* @brief Board emulation for the native port
*
* The native board uses call level hardware simulation
*
* @{
*
* @file board.h
* @brief Basic definitions for the native board
*
* @author Ludwig Ortmann <ludwig.ortmann@fu-berlin.de>
*/
#ifndef BOARD_H
#define BOARD_H
#include <stdint.h>
void _native_LED_GREEN_OFF(void);
@ -34,4 +39,6 @@ void _native_LED_RED_TOGGLE(void);
#define LED_RED_TOGGLE (_native_LED_RED_TOGGLE())
typedef uint16_t radio_packet_length_t;
/** @} */
#endif /* BOARD_H */

26
boards/olimex_lpc2148/include/board.h
View File

@ -1,4 +1,30 @@
/*
* Copyright (C) 2013 Freie Universität Berlin
*
* This file subject to the terms and conditions of the GNU Lesser General
* Public License. See the file LICENSE in the top level directory for more
* details.
*/
/**
* @defgroup boards_olimex_lpc2148 Olimex LPC2148
* @ingroup boards
* @brief Support for the Olimex LPC2148 board
* @{
*
* @file board.h
* @brief Basic definitions for the Olimex LPC2148 board
*
* @author unknown
*/
#ifndef __OLIMEX_LPC2148_H
#define __OLIMEX_LPC2148_H
#include <stdint.h>
#include "lpc2148.h"
typedef uint8_t radio_packet_length_t;
/** @} */
#endif /* __OLIMEX_LPC2148_H */

25
boards/pttu/include/board.h
View File

@ -1,4 +1,4 @@
/******************************************************************************
/*
Copyright 2008-2009, Freie Universitaet Berlin (FUB). All rights reserved.
These sources were developed at the Freie Universitaet Berlin, Computer Systems
@ -24,25 +24,22 @@ and the mailinglist (subscription via web site)
scatterweb@lists.spline.inf.fu-berlin.de
*******************************************************************************/
#ifndef __BOARD_H
#define __BOARD_H
/**
* @ingroup pttu
* @defgroup boards_pttu PTTU
* @ingroup boards
* @brief Support for the PTTU board
* @{
*/
/**
* @file
* @brief PTTU Board
*
* @file board.h
* @brief Basic definitions for the PTTU board
*
* @author Freie Universität Berlin, Computer Systems & Telematics, FeuerWhere project
* @author Kaspar Schleiser <kaspar@schleiser.de>
* @version $Revision$
*
* @note $Id: board.h 664 2009-02-19 10:54:44Z baar $
* @author Kaspar Schleiser <kaspar@schleiser.de>
*/
#ifndef __BOARD_H
#define __BOARD_H
#include <lpc2387.h>
#include <cpu-conf.h>

24
boards/redbee-econotag/include/board.h
View File

@ -1,10 +1,22 @@
/*
* Copyright (C) 2013 Thomas Eichinger <thomas.eichinger@fu-berlin.de>
*
* This file subject to the terms and conditions of the GNU Lesser General
* Public License. See the file LICENSE in the top level directory for more
* details.
*/
/**
* board.h - redbee-econotag Board.
* Copyright (C) 2013 Thomas Eichinger <thomas.eichinger@fu-berlin.de>
*
* This source code is licensed under the GNU Lesser General Public License,
* Version 2. See the file LICENSE for more details.
*/
* @defgroup boards_redbee-econotag Redbee Econotag
* @ingroup boards
* @brief Support for the Redbee Econotag board
* @{
*
* @file board.h
* @brief Basic definitions for the Redbee Econotag board
*
* @author Thomas Eichinger <thomas.eichinger@fu-berlin.de>
*/
#ifndef REDBEE_ECONOTAG_BOARD_H
#define REDBEE_ECONOTAG_BOARD_H

47
boards/telosb/include/board.h
View File

@ -1,33 +1,30 @@
/*
* Copyright (C) 2013 INRIA
*
* This source code is licensed under the GNU Lesser General Public License,
* Version 2. See the file LICENSE for more details.
*/
/**
* board.h - TelosB Board.
* Copyright (C) 2013 INRIA
*
* This source code is licensed under the GNU Lesser General Public License,
* Version 2. See the file LICENSE for more details.
*/
* @defgroup boards_telosb TelosB
* @ingroup boards
* @brief Support for the TelosB board
*
* <h2>Compontents</h2>
* \li MSP430
* \li CC2420
*
* @{
*
* @file board.h
* @brief Basic definitions for the TelosB board
*
* @author Oliver Hahm <oliver.hahm@inria.fr>
*/
#ifndef _TELOSB_BOARD_H
#define _TELOSB_BOARD_H
/**
* @defgroup TelosB
* @ingroup TelosB
*
<h2>Compontents</h2>
\li MSP430
\li CC2420
* @{
*/
/**
* @file
* @brief TelosB Board
*
* @author Oliver Hahm <oliver.hahm@inria.fr>
*
*/
//MSB430 core
#define MSP430_INITIAL_CPU_SPEED 8000000uL
#define MSP430_HAS_DCOR 0

21
boards/wsn430-common/include/board-conf.h
View File

@ -1,9 +1,19 @@
/*
* This source code is licensed under the GNU Lesser General Public License,
* Version 2. See the file LICENSE for more details.
*/
/**
* board-conf.h.
*
* This source code is licensed under the GNU Lesser General Public License,
* Version 2. See the file LICENSE for more details.
*/
* @defgroup boards_wsn430-common WSN430 common
* @ingroup boards
* @brief Common files for WSN430 based boards
* @{
*
* @file board.h
* @brief Common definitions for WSN430 based boards
*
* @author unknown
*/
#ifndef BOARD_CONF_H
#define BOARD_CONF_H
@ -12,4 +22,5 @@
#define INFOMEM (0x1000)
/** @} */
#endif /* BOARD-CONF_H */

45
boards/wsn430-v1_3b/include/board.h
View File

@ -1,36 +1,31 @@
/**
* board.h - wsn430-v1_3b Board.
* Copyright (C) 2013 Milan Babel <babel@inf.fu-berlin.de>
*
* This source code is licensed under the GNU Lesser General Public License,
* Version 2. See the file LICENSE for more details.
*/
#ifndef _WSN_BOARD_H
#define _WSN_BOARD_H
/**
* @defgroup wsn430-v1_3b Senslab WSN430 v1.3b
* @ingroup wsn430
/*
* Copyright (C) 2013 Milan Babel <babel@inf.fu-berlin.de>
*
<h2>Compontents</h2>
\li MSP430
\li CC1100
* @{
*/
* This source code is licensed under the GNU Lesser General Public License,
* Version 2. See the file LICENSE for more details.
*/
/**
* @file
* @brief wsn430-v1_3b Board
* @defgroup boards_wsn430-v1_3b WSN430 v1.3b
* @ingroup boards
* @brief Support for the Senslab WSN430 v1.3b board
*
* <h2>Compontents</h2>
* \li MSP430
* \li CC1100
*
* @{
*
* @file board.h
* @brief Basic definitions for the Senslab WSN430 v1.3b board
*
* @author Freie Universität Berlin, Computer Systems & Telematics, FeuerWhere project
* @author Milan Babel <babel@inf.fu-berlin.de>
* @version $Revision$
*
* @note $Id$
*/
#ifndef _WSN_BOARD_H
#define _WSN_BOARD_H
#include "board-conf.h"
//MSB430 core

45
boards/wsn430-v1_4/include/board.h
View File

@ -1,36 +1,31 @@
/**
* board.h - wsn430-v1_4 Board.
* Copyright (C) 2013 Milan Babel <babel@inf.fu-berlin.de>
*
* This source code is licensed under the GNU Lesser General Public License,
* Version 2. See the file LICENSE for more details.
*/
#ifndef _WSN_BOARD_H
#define _WSN_BOARD_H
/**
* @defgroup wsn430-v1_4 Senslab WSN430 v1.4
* @ingroup wsn430
/*
* Copyright (C) 2013 Milan Babel <babel@inf.fu-berlin.de>
*
<h2>Compontents</h2>
\li MSP430
\li CC2420
* @{
*/
* This source code is licensed under the GNU Lesser General Public License,
* Version 2. See the file LICENSE for more details.
*/
/**
* @file
* @brief wsn430-v1_4 Board
* @defgroup boards_wsn430-v1_4 WSN430 v1.4
* @ingroup boards
* @brief Support for the Senslab WSN430 v1.4 board
*
* <h2>Compontents</h2>
* \li MSP430
* \li CC2420
*
* @{
*
* @file board.h
* @brief Basic definitions for the Senslab WSN430 v1.4 board
*
* @author Freie Universität Berlin, Computer Systems & Telematics, FeuerWhere project
* @author Milan Babel <babel@inf.fu-berlin.de>
* @version $Revision$
*
* @note $Id$
*/
#ifndef _WSN_BOARD_H
#define _WSN_BOARD_H
#include "board-conf.h"
//MSB430 core

2
doc/doxygen/riot.doxyfile
View File

@ -85,7 +85,7 @@ WARN_LOGFILE =
#---------------------------------------------------------------------------
# configuration options related to the input files
#---------------------------------------------------------------------------
INPUT = ../../core ../../cpu ../../../boards ../../sys src/ ../../drivers
INPUT = ../../core ../../cpu ../../boards ../../sys src/ ../../drivers
INPUT_ENCODING = UTF-8
FILE_PATTERNS = *.txt *.c *.h
RECURSIVE = YES