From 3785fe956b649820aff9787f5500f337b216ccf9 Mon Sep 17 00:00:00 2001 From: Hauke Petersen Date: Wed, 27 Nov 2013 16:28:31 +0100 Subject: [PATCH 1/4] Fixed doxygen comments, focused on file headers and group definitions --- core/bitarithm.c | 21 +++++--- core/cib.c | 18 +++++++ core/clist.c | 18 ++++--- core/doc.txt | 27 ++++++++++ core/hwtimer.c | 16 +++--- core/include/atomic.h | 23 ++++---- core/include/bitarithm.h | 54 +++++++++---------- core/include/cib.h | 18 +++++++ core/include/clist.h | 25 +++++---- core/include/config.h | 19 +++++++ core/include/debug.h | 32 ++++++----- core/include/flags.h | 30 +++++------ core/include/hwtimer.h | 36 ++++++++----- core/include/hwtimer_arch.h | 28 +++++----- core/include/io.h | 20 +++++-- core/include/irq.h | 27 +++++----- core/include/kernel.h | 34 ++++-------- core/include/kernel_internal.h | 23 +++++++- core/include/lifo.h | 18 +++++++ core/include/lpm.h | 27 +++++----- core/include/msg.h | 36 ++++++++----- core/include/mutex.h | 20 ++++--- core/include/oneway_malloc.h | 15 +++++- core/include/queue.h | 19 +++++-- core/include/sched.h | 15 +++++- core/include/tcb.h | 45 +++++++++------- core/include/thread.h | 28 ++++++---- core/kernel_init.c | 18 ++++--- core/lifo.c | 18 +++++++ core/msg.c | 20 ++++--- core/mutex.c | 19 ++++--- core/oneway_malloc.c | 18 ++++--- core/queue.c | 18 ++++--- core/sched.c | 22 ++++---- core/thread.c | 19 ++++--- cpu/arm_common/arm_cpu.c | 2 +- cpu/cc430/doc.txt | 13 +++++ cpu/doc.txt | 16 ++++++ cpu/lpc2387/gpioint/lpc2387-gpioint.c | 1 - cpu/lpc2387/include/cpu.h | 1 + cpu/lpc_common/doc.txt | 13 +++++ cpu/mc1322x/include/cpu.h | 6 +++ cpu/msp430-common/include/cpu.h | 1 + cpu/native/include/cpu.h | 2 + cpu/native/include/nativenet.h | 3 +- drivers/cc110x/cc1100.h | 5 +- drivers/cc110x_ng/cc110x-defaultSettings.c | 10 ++-- drivers/cc110x_ng/cc110x-rx.c | 16 +++--- drivers/cc110x_ng/cc110x-tx.c | 16 +++--- drivers/cc110x_ng/cc110x.c | 16 +++--- drivers/cc110x_ng/include/cc110x-arch.h | 13 +++-- drivers/cc110x_ng/include/cc110x-config.h | 9 ++-- .../include/cc110x-defaultSettings.h | 8 +-- drivers/cc110x_ng/include/cc110x-internal.h | 31 ++++------- drivers/cc110x_ng/include/cc110x-reg.h | 28 ++++++---- drivers/cc110x_ng/include/cc110x_ng.h | 20 ++++--- drivers/cc110x_ng/include/cc110x_spi.h | 3 +- drivers/cc110x_ng/spi/cc110x_spi.c | 3 +- drivers/doc.txt | 14 +++++ drivers/include/adc.h | 7 +++ drivers/include/diskio.h | 8 +++ drivers/include/flashrom.h | 9 ++++ drivers/include/gpioint.h | 7 ++- drivers/include/lm75a-temp-sensor.h | 8 +++ drivers/include/ltc4150_arch.h | 3 +- drivers/include/rtc.h | 5 +- drivers/include/sht11.h | 2 +- drivers/include/srf02-ultrasonic-sensor.h | 8 +++ drivers/include/srf08-ultrasonic-sensor.h | 8 +++ drivers/sht11/sht11.c | 4 +- sys/doc.txt | 12 +++++ sys/include/auto_init.h | 7 +++ sys/include/bloom.h | 7 +++ sys/include/board_uart0.h | 7 +++ sys/include/chardev_thread.h | 7 +++ sys/include/hashes.h | 6 +++ sys/include/ping.h | 7 +++ sys/include/posix_io.h | 8 +-- sys/include/ps.h | 7 +++ sys/include/random.h | 7 +++ sys/include/sha256.h | 7 +++ sys/include/shell.h | 11 ++-- sys/include/timex.h | 7 +++ sys/include/transceiver.h | 7 +++ sys/include/vtimer.h | 2 +- sys/net/doc.txt | 13 +++++ sys/net/include/ieee802154_frame.h | 2 + sys/net/include/net_help.h | 6 +++ sys/net/include/protocol-multiplex.h | 4 +- sys/net/rpl/rpl.h | 4 +- sys/net/sixlowpan/lowpan.h | 4 +- 91 files changed, 908 insertions(+), 397 deletions(-) create mode 100644 core/doc.txt create mode 100644 cpu/cc430/doc.txt create mode 100644 cpu/doc.txt create mode 100644 cpu/lpc_common/doc.txt create mode 100644 drivers/doc.txt create mode 100644 sys/doc.txt create mode 100644 sys/net/doc.txt diff --git a/core/bitarithm.c b/core/bitarithm.c index cda4b6e28038..398c85f81510 100644 --- a/core/bitarithm.c +++ b/core/bitarithm.c @@ -1,17 +1,22 @@ -/** - * bit arithmetic helper functions - * +/* * Copyright (C) 2013 Freie Universität Berlin * * This file is 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. + */ + +/** + * @ingroup core_util + * @{ + * + * @file bitarithm.c + * @brief Bit arithmetic helper functions implementation + * + * @author Kaspar Schleiser + * @author Martin Lenders * - * \ingroup bitarithm - * \{ - * \file - * \author Kaspar Schleiser - * \} + * @} */ #include diff --git a/core/cib.c b/core/cib.c index 054dd028c456..e58bfda06a6e 100644 --- a/core/cib.c +++ b/core/cib.c @@ -1,3 +1,21 @@ +/* + * 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. + */ + + /** + * @ingroup core_util + * @{ + * + * @file cib.c + * @brief Circular integer buffer implementation + * + * @} + */ + #include void cib_init(cib_t *cib, unsigned int size) diff --git a/core/clist.c b/core/clist.c index 58b40336f7cf..c65b1e5a434e 100644 --- a/core/clist.c +++ b/core/clist.c @@ -1,16 +1,20 @@ -/** - * simple circular linked list - * +/* * Copyright (C) 2013 Freie Universität Berlin * * This file is 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. - * - * @ingroup kernel + */ + +/** + * @ingroup core_util * @{ - * @file - * @author Kaspar Schleiser + * + * @file clist.c + * @brief Circular linked list implementation + * + * @author Kaspar Schleiser + * * @} */ diff --git a/core/doc.txt b/core/doc.txt new file mode 100644 index 000000000000..7a8118c38f64 --- /dev/null +++ b/core/doc.txt @@ -0,0 +1,27 @@ +/* + * 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 core Kernel + * @brief The RIOT micro-kernel containing the core functionality + * + * The kernel module contains only the basic OS functionality such as the sheduler, threading, synchronization + * and IRQ-handling. The only exception is the integration of the hardware timer into this module. + */ + +/** + * @defgroup core_util Kernel utilities + * @ingroup core + * @brief Utilies and data structures used by the kernel + */ + +/** + * @defgroup core_internal Startup and Configuration + * @ingroup core + * @brief Configuration data and startup code for the kernel + */ diff --git a/core/hwtimer.c b/core/hwtimer.c index 5d2729fa3479..a18c114369e7 100644 --- a/core/hwtimer.c +++ b/core/hwtimer.c @@ -1,19 +1,23 @@ -/** - * hardware timer abstraction - * +/* * Copyright (C) 2013 Freie Universität Berlin * * This file is 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. - * - * @ingroup kernel + */ + +/** + * @ingroup core_hwtimer * @{ - * @file + * + * @file hwtimer.c + * @brief Hardware timer abstraction implementation + * * @author Heiko Will * @author Thomas Hillebrandt * @author Kaspar Schleiser * @author Oliver Hahm + * * @} */ diff --git a/core/include/atomic.h b/core/include/atomic.h index 3ae48d714e91..cc4a41eb8245 100644 --- a/core/include/atomic.h +++ b/core/include/atomic.h @@ -1,17 +1,20 @@ -/** - * atomic function declarations - * +/* * Copyright (C) 2013 Freie Universität Berlin * * This file is 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. - * - * @ingroup kernel + */ + +/** + * @addtogroup core_util * @{ - * @file - * @author Freie Universität Berlin, Computer Systems & Telematics - * @author Kaspar Schleiser + * + * @file atomic.h + * @brief Atomic function declarations + * + * @author Freie Universität Berlin, Computer Systems & Telematics + * @author Kaspar Schleiser */ #ifndef _ATOMIC_H @@ -23,7 +26,5 @@ extern unsigned int atomic_set_return(unsigned int *val, unsigned int set); -/** - * @} - */ +/** @} */ #endif /* _ATOMIC_H */ diff --git a/core/include/bitarithm.h b/core/include/bitarithm.h index 6f38b2839774..cf7126ce42d2 100644 --- a/core/include/bitarithm.h +++ b/core/include/bitarithm.h @@ -1,30 +1,33 @@ -/** - * Helper functions for bit arithmetic - * +/* * Copyright (C) 2013 Freie Universität Berlin * * This file is 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 bitarithm Bit Arithmetic - * @ingroup lib + */ + +/** + * @addtogroup core_util * @{ - * @file - * @author Freie Universität Berlin, Computer Systems & Telematics - * @author Kaspar Schleiser + * + * @file bitarithm.h + * @brief Helper functions for bit arithmetic + * + * @author Freie Universität Berlin, Computer Systems & Telematics + * @author Kaspar Schleiser + * @author Martin Lenders */ #ifndef BITARITHM_H_ #define BITARITHM_H_ -#define BS(val, bit) ((val) & (bit)) -#define BS_COND(condition, target, mask) (target) ^= ( (-(condition) ^ (target)) & (mask) ) -#define SETBIT(val, bit) val |= (bit) -#define CLRBIT(val, bit) val &= (~(bit)) +#define BS(val, bit) ((val) & (bit)) +#define BS_COND(condition, target, mask) (target) ^= ( (-(condition) ^ (target)) & (mask) ) +#define SETBIT(val, bit) val |= (bit) +#define CLRBIT(val, bit) val &= (~(bit)) /** - * @name Single Bit Defines + * @name Single Bit Defines * @{ */ #ifndef BIT0 @@ -68,35 +71,32 @@ #define ARCH_32_BIT (__INT_MAX__ == 2147483647) /** - * @brief Returns the number of the highest '1' bit in a value - * @param[in] v Input value - * @return Bit Number + * @brief Returns the number of the highest '1' bit in a value + * @param[in] v Input value + * @return Bit Number * * Source: http://graphics.stanford.edu/~seander/bithacks.html#IntegerLogObvious */ unsigned number_of_highest_bit(unsigned v); /** - * @brief Returns the number of the lowest '1' bit in a value - * @param[in] v Input value - must be unequal to '0', otherwise the + * @brief Returns the number of the lowest '1' bit in a value + * @param[in] v Input value - must be unequal to '0', otherwise the * function will produce an infinite loop - * @return Bit Number + * @return Bit Number * * Source: http://graphics.stanford.edu/~seander/bithacks.html#IntegerLogObvious */ unsigned number_of_lowest_bit(register unsigned v); /** - * @brief Returns the number of bits set in a value - * @param[in] v Input value - * @return Number of set bits + * @brief Returns the number of bits set in a value + * @param[in] v Input value + * @return Number of set bits * * Source: http://graphics.stanford.edu/~seander/bithacks.html#IntegerLogObvious */ unsigned number_of_bits_set(unsigned v); -/** - * @} - */ - +/** @} */ #endif /* BITARITHM_H_ */ diff --git a/core/include/cib.h b/core/include/cib.h index ed7b0e4d4fdd..3de2d253e0c1 100644 --- a/core/include/cib.h +++ b/core/include/cib.h @@ -1,3 +1,20 @@ +/* + * 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. + */ + + /** + * @addtogroup core_util + * @{ + * + * @file cib.h + * @brief Circular integer buffer interface + * + */ + #ifndef __CIB_H #define __CIB_H @@ -12,4 +29,5 @@ int cib_get(cib_t *cib); int cib_put(cib_t *cib); int cib_avail(cib_t *cib); +/** @} */ #endif /* __CIB_H */ diff --git a/core/include/clist.h b/core/include/clist.h index 6d1914948e63..72be66870ce2 100644 --- a/core/include/clist.h +++ b/core/include/clist.h @@ -1,19 +1,20 @@ -/** - * Circular linked list implementation - * - * Used by the scheduler - * +/* * Copyright (C) 2013 Freie Universität Berlin * * This file is 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. - * - * @ingroup lib + */ + +/** + * @addtogroup core_util * @{ - * @file - * @author Freie Universität Berlin, Computer Systems & Telematics - * @author Kaspar Schleiser + * + * @file clist.h + * @brief Circular linkes list + * + * @author Freie Universität Berlin, Computer Systems & Telematics + * @author Kaspar Schleiser */ #ifndef __CLIST_H @@ -43,8 +44,6 @@ static inline void clist_advance(clist_node_t **list) void clist_print(clist_node_t *clist); #endif -/** - * @} - */ +/** @} */ #endif // __CLIST_H diff --git a/core/include/config.h b/core/include/config.h index 37a68f64c7ff..332d43ff94f7 100644 --- a/core/include/config.h +++ b/core/include/config.h @@ -1,3 +1,21 @@ +/* + * 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. + */ + +/** + * @addtogroup core_internal + * @{ + * + * @file config.h + * @brief Kernel configuration interface + * + */ + + #ifndef CONFIG_H #define CONFIG_H @@ -36,4 +54,5 @@ uint8_t config_save(void); */ void config_load(void); +/** @} */ #endif /* CONFIG_H */ diff --git a/core/include/debug.h b/core/include/debug.h index 5c928883dc33..7df33ce409b4 100644 --- a/core/include/debug.h +++ b/core/include/debug.h @@ -1,23 +1,27 @@ -/** - * Debug-Header. - * - * #define ENABLE_DEBUG, include this and then use DEBUG as printf you can toggle. - * +/* * Copyright (C) 2013 Freie Universität Berlin * * This file is 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. - * - * @ingroup kernel + */ + +/** + * @addtogroup core_util * @{ - * @file - * @author Freie Universität Berlin, Computer Systems & Telematics - * @author Kaspar Schleiser - * @} + * + * @file debug.h + * @brief Debug-header + * + * #define ENABLE_DEBUG, include this and then use DEBUG as printf you can toggle. + * + * @author Freie Universität Berlin, Computer Systems & Telematics + * @author Kaspar Schleiser */ - - + +#ifndef __DEBUG_H +#define __DEBUG_H + #include #if ENABLE_DEBUG @@ -27,3 +31,5 @@ #define DEBUG(...) #endif +/** @} */ +#endif /* __DEBUG_H */ diff --git a/core/include/flags.h b/core/include/flags.h index ddf61d06ba16..26873d11166a 100644 --- a/core/include/flags.h +++ b/core/include/flags.h @@ -1,28 +1,28 @@ -/** - * (misc flag definitions) - * +/* * Copyright (C) 2013 Freie Universität Berlin * * This file is 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. - * - * @ingroup kernel + */ + +/** + * @addtogroup core_internal * @{ - * @file - * @author Kaspar Schleiser + * + * @file flags.h + * @brief Misc flag definitions + * + * @author Kaspar Schleiser */ #ifndef _FLAGS_H #define _FLAGS_H -#define CREATE_SLEEPING (1) -#define AUTO_FREE (2) -#define CREATE_WOUT_YIELD (4) -#define CREATE_STACKTEST (8) +#define CREATE_SLEEPING (1) +#define AUTO_FREE (2) +#define CREATE_WOUT_YIELD (4) +#define CREATE_STACKTEST (8) -/** - * @} - */ +/** @} */ #endif // _FLAGS_H - diff --git a/core/include/hwtimer.h b/core/include/hwtimer.h index 309afbb1da98..cfc25804c450 100644 --- a/core/include/hwtimer.h +++ b/core/include/hwtimer.h @@ -1,5 +1,15 @@ +/* + * 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. + */ + /** - * Hardware timer interface + * @defgroup core_hwtimer Hardware timer + * @ingroup core + * @brief Hardware timer interface * * The Hardware timers are directly mapped to hardware timers with minimum * latency. They are intended for short intervals and to be used in time @@ -7,24 +17,18 @@ * interrupt context and must use the shortest possible execution time (e.g. * set a flag and trigger a worker thread). * - * hwtimer must not be used within applications, use \ref vtimer + * The hardware timer must not be used within applications, use \ref vtimer * instead. * - * @defgroup hwtimer Hardware timer - * @ingroup kernel * @{ - * @file * - * @author Freie Universität Berlin, Computer Systems & Telematics - * @author Heiko Will - * @author Kaspar Schleiser - * @author Michael Baar + * @file hwtimer.h + * @brief HW-timer abstraction * - * Copyright (C) 2013 Freie Universität Berlin - * - * This file is 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. + * @author Freie Universität Berlin, Computer Systems & Telematics + * @author Heiko Will + * @author Kaspar Schleiser + * @author Michael Baar */ #ifndef __HWTIMER_H @@ -118,6 +122,10 @@ void hwtimer_spin(unsigned long ticks); int hwtimer_active(void); +/** + * @} + */ + /* internal */ /** diff --git a/core/include/hwtimer_arch.h b/core/include/hwtimer_arch.h index e3cd785f0519..a935fd3c8d4c 100644 --- a/core/include/hwtimer_arch.h +++ b/core/include/hwtimer_arch.h @@ -1,20 +1,24 @@ -/** - * Hardware timer abstraction - * +/* * Copyright (C) 2013 Freie Universität Berlin * * This file is 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. - * - * @ingroup kernel + */ + +/** + * @addtogroup core_hwtimer * @{ - * @file - * @author Freie Universität Berlin, Computer Systems & Telematics - * @author Thomas Hillebrandt - * @author Heiko Will - * @author Kaspar Schleiser + * + * @file hwtimer_arch.h + * @brief Architecture specific hwtimer API + * + * @author Freie Universität Berlin, Computer Systems & Telematics + * @author Thomas Hillebrandt + * @author Heiko Will + * @author Kaspar Schleiser */ + #ifndef HWTIMER_ARCH_H_ #define HWTIMER_ARCH_H_ @@ -56,7 +60,5 @@ void hwtimer_arch_unset(short timer); */ unsigned long hwtimer_arch_now(void); -/** - * @} - */ +/** @} */ #endif /* HWTIMER_ARCH_H_ */ diff --git a/core/include/io.h b/core/include/io.h index 6569cd452a56..a51eeee17ca9 100644 --- a/core/include/io.h +++ b/core/include/io.h @@ -1,10 +1,22 @@ +/* + * 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. + */ + /** - * @ingroup kernel + * @defgroup core_io IO Interface + * @brief Interface to system io functions + * @ingroup core * @{ + * * @file io.h - * @brief prototypes for system io functions + * @brief Prototypes for system io functions + * * @author INRIA - * @author Oliver Hahm + * @author Oliver Hahm */ #ifndef IO_H @@ -12,5 +24,5 @@ int fw_puts(char *data, int count); -/** @} */ +/** @} */ #endif /* IO_H */ diff --git a/core/include/irq.h b/core/include/irq.h index dd7efa2d2cb7..d072aabb653c 100644 --- a/core/include/irq.h +++ b/core/include/irq.h @@ -1,23 +1,26 @@ -#ifndef IRQ_H_ -#define IRQ_H_ - -/** - * @defgroup irq IRQ Handling - * @ingroup kernel - * - * Provides an API to control interrupt processing. +/* + * 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. */ /** - * @file + * @defgroup core_irq IRQ Handling + * @ingroup core + * @brief Provides an API to control interrupt processing + * @{ + * + * @file irq.h * @brief IRQ driver interface * * @author Freie Universität Berlin, Computer Systems & Telematics - * */ +#ifndef IRQ_H_ +#define IRQ_H_ + #include /** @@ -54,5 +57,5 @@ void restoreIRQ(unsigned state); */ int inISR(void); -/** @} */ // end of group dev_irq +/** @} */ #endif /* IRQ_H_ */ diff --git a/core/include/kernel.h b/core/include/kernel.h index 4a30e97b1a69..47d578558e72 100644 --- a/core/include/kernel.h +++ b/core/include/kernel.h @@ -1,27 +1,25 @@ -/** - * Kernel compile time configuration - * +/* * Copyright (C) 2013 Freie Universität Berlin * * This file is 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. - * - * @ingroup kernel - * @{ - * @file - * @author Freie Universität Berlin, Computer Systems & Telematics - * @author Kaspar Schleiser */ -#ifndef KERNEL_H_ -#define KERNEL_H_ - /** - * @defgroup kernel Kernel + * @addtogroup core_internal * @{ + * + * @file kernel.h + * @brief Kernel compile time configuration + * + * @author Freie Universität Berlin, Computer Systems & Telematics + * @author Kaspar Schleiser */ +#ifndef KERNEL_H_ +#define KERNEL_H_ + #include #include "config.h" #include "tcb.h" @@ -30,15 +28,8 @@ #include "sched.h" #include "cpu-conf.h" -/* ------------------------------------------------------------------------- */ -/** - * @name Kernel Compile-Time Configuration - * @{ - */ - /** * @def KERNEL_CONF_STACKSIZE_DEFAULT - * @ingroup conf * @brief A reasonable default stack size that will suffice most smaller tasks */ #ifndef KERNEL_CONF_STACKSIZE_DEFAULT @@ -47,7 +38,6 @@ /** * @def KERNEL_CONF_STACKSIZE_IDLE - * @ingroup conf * @brief Size of the idle task's stack in bytes */ #ifndef KERNEL_CONF_STACKSIZE_IDLE @@ -65,14 +55,12 @@ /** * @def KERNEL_CONF_STACKSIZE_MAIN - * @ingroup conf * @brief Size of the main task's stack in bytes */ #ifndef KERNEL_CONF_STACKSIZE_MAIN #define KERNEL_CONF_STACKSIZE_MAIN (KERNEL_CONF_STACKSIZE_DEFAULT + KERNEL_CONF_STACKSIZE_PRINTF) #endif -/** @} */ /* ------------------------------------------------------------------------- */ diff --git a/core/include/kernel_internal.h b/core/include/kernel_internal.h index 05723cf6ac12..9bf8965e43aa 100644 --- a/core/include/kernel_internal.h +++ b/core/include/kernel_internal.h @@ -1,10 +1,20 @@ +/* + * 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. + */ + /** - * @ingroup kernel + * @addtogroup core_internal * @{ + * * @file kernel_internal.h * @brief prototypes for kernel internal functions + * * @author INRIA - * @author Oliver Hahm + * @author Oliver Hahm */ #ifndef KERNEL_INTERNAL_H_ @@ -41,5 +51,14 @@ void sched_task_exit(void); */ void thread_print_stack(void); +/** + * @brief Calculates stack usage if thread was created using CREATE_STACKTEST + * + * @param[in] stack The thread's stack + * + * @return The current usage (overwritten addresses) of the thread's stack + */ +int thread_measure_stack_usage(char *stack); + /** @} */ #endif /* KERNEL_INTERNAL_H_ */ diff --git a/core/include/lifo.h b/core/include/lifo.h index 83663d5ccf87..2db4c7c7dec7 100644 --- a/core/include/lifo.h +++ b/core/include/lifo.h @@ -1,3 +1,20 @@ +/* + * 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. + */ + +/** + * @addtogroup core_util + * @{ + * + * @file lifo.h + * @brief LIFO buffer API + * + */ + #ifndef __LIFO_H #define __LIFO_H @@ -6,4 +23,5 @@ void lifo_init(int *array, int n); void lifo_insert(int *array, int i); int lifo_get(int *array); +/** @} */ #endif /* __LIFO_H */ diff --git a/core/include/lpm.h b/core/include/lpm.h index a10ded35466a..7cb8a6325d4d 100644 --- a/core/include/lpm.h +++ b/core/include/lpm.h @@ -1,24 +1,27 @@ -#ifndef LPM_H_ -#define LPM_H_ - -/** - * @defgroup lpm Power Management - * @ingroup kernel - * @{ +/* + * 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. */ /** - * @file - * @brief Power Management Interface + * @defgroup core_lpm Power Management + * @ingroup core + * @brief The kernels power management interface + * @{ * - * @author Freie Universität Berlin, Computer Systems & Telematics - * @version $Revision$ + * @file lpm.h + * @brief Power management interface * * This interface needs to be implemented for each platform. * - * @note $Id$ + * @author Freie Universität Berlin, Computer Systems & Telematics */ +#ifndef LPM_H_ +#define LPM_H_ /** * @brief Available power modes diff --git a/core/include/msg.h b/core/include/msg.h index 0d96e3003613..206e745a2dfc 100644 --- a/core/include/msg.h +++ b/core/include/msg.h @@ -1,19 +1,29 @@ -/** - * There are two ways to use the IPC Messaging system of RIOT. The default is synchronous - * messaging. In this manner, messages are either dropped when the receiver is not waiting and the - * message was sent non-blocking, or will be delivered immediately when the receiver calls - * msg_receive(msg_t* m). To use asynchronous messaging any thread can create its own queue by - * calling msg_init_queue(msg_t* array, int num). Messages sent to a thread with a non full message - * queue are never dropped and the sending never blocks. Threads with a full message queue behaves - * like in synchronous mode. - * - * @defgroup kernel_msg Messaging / IPC - * @ingroup kernel - * @{ +/* + * 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. */ /** - * @file + * @defgroup core_msg Messaging / IPC + * @ingroup core + * @brief Messaging API for inter process communication + * + * There are two ways to use the IPC Messaging system of RIOT. The default is synchronous + * messaging. In this manner, messages are either dropped when the receiver is not waiting and the + * message was sent non-blocking, or will be delivered immediately when the receiver calls + * msg_receive(msg_t* m). To use asynchronous messaging any thread can create its own queue by + * calling msg_init_queue(msg_t* array, int num). Messages sent to a thread with a non full message + * queue are never dropped and the sending never blocks. Threads with a full message queue behaves + * like in synchronous mode. + * + * @{ + * + * @file msg.h + * @brief Messaging API for inter process communication + * * @author Freie Universität Berlin, Computer Systems & Telematics * @author Kaspar Schleiser */ diff --git a/core/include/mutex.h b/core/include/mutex.h index bcf72395b45c..d59d04953980 100644 --- a/core/include/mutex.h +++ b/core/include/mutex.h @@ -1,11 +1,20 @@ -/** - * @defgroup mutex Mutexes / Synchronization - * @ingroup kernel - * @{ +/* + * 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. */ /** - * @file + * @defgroup core_sync Synchronization + * @brief Mutex for thread synchronization + * @ingroup core + * @{ + * + * @file mutex.h + * @brief RIOT synchronization API + * * @author Freie Universität Berlin, Computer Systems & Telematics * @author Kaspar Schleiser */ @@ -74,4 +83,3 @@ void mutex_wait(struct mutex_t *mutex); /** @} */ #endif /* _MUTEX_H */ - diff --git a/core/include/oneway_malloc.h b/core/include/oneway_malloc.h index 76946dfd04db..715c915c71f9 100644 --- a/core/include/oneway_malloc.h +++ b/core/include/oneway_malloc.h @@ -1,7 +1,18 @@ +/* + * 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. + */ + /** - * @ingroup kernel + * @addtogroup core_util * @{ - * @file + * + * @file oneway_malloc.h + * @brief Malloc interface + * * @author Freie Universität Berlin, Computer Systems & Telematics * @author Kaspar Schleiser */ diff --git a/core/include/queue.h b/core/include/queue.h index c2eef138f2ed..13ff782846be 100644 --- a/core/include/queue.h +++ b/core/include/queue.h @@ -1,7 +1,20 @@ +/* + * 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. + */ + /** - * @ingroup kernel + * @addtogroup core_util * @{ - * @file + * + * @file queue.h + * @brief A simple queue implementation + * + * TODO document functions and datastructures + * * @author Freie Universität Berlin, Computer Systems & Telematics * @author Kaspar Schleiser */ @@ -37,4 +50,4 @@ void queue_print_node(queue_node_t *node); #endif /** @} */ -#endif // __QUEUE_H +#endif /* __QUEUE_H */ diff --git a/core/include/sched.h b/core/include/sched.h index 1249bc81b224..8d97bf16cb64 100644 --- a/core/include/sched.h +++ b/core/include/sched.h @@ -1,7 +1,20 @@ +/* + * 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. + */ + /** - * @ingroup kernel + * @defgroup core_sched Scheduler + * @ingroup core + * @brief The RIOT scheduler * @{ + * * @file sched.h + * @brief Scheduler API definion + * * @author Freie Universität Berlin, Computer Systems & Telematics * @author Kaspar Schleiser */ diff --git a/core/include/tcb.h b/core/include/tcb.h index 018150db2c6a..7655b56d7b15 100644 --- a/core/include/tcb.h +++ b/core/include/tcb.h @@ -1,18 +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. + */ + /** - * @ingroup kernel + * @addtogroup core_thread * @{ - * @file + * + * @file tcb.h + * @brief Thread context block definition + * * @author Freie Universität Berlin, Computer Systems & Telematics + * @author Heiko Will * @author Kaspar Schleiser */ -/* - * tcb.h - * - * Created on: 19.08.2008 - * Author: heiko, kaspar - */ - #ifndef TCB_H_ #define TCB_H_ @@ -23,17 +28,17 @@ #include /* uneven means has to be on runqueue */ -#define STATUS_NOT_FOUND (0x0000) -#define STATUS_ON_RUNQUEUE (0x0001) -#define STATUS_RUNNING (0x0002 + STATUS_ON_RUNQUEUE) -#define STATUS_PENDING (0x0004 + STATUS_ON_RUNQUEUE) -#define STATUS_STOPPED (0x0008) -#define STATUS_SLEEPING (0x0010) -#define STATUS_MUTEX_BLOCKED (0x0020) -#define STATUS_RECEIVE_BLOCKED (0x0040) -#define STATUS_SEND_BLOCKED (0x0080) -#define STATUS_REPLY_BLOCKED (0x0100) -#define STATUS_TIMER_WAITING (0x0200) +#define STATUS_NOT_FOUND (0x0000) +#define STATUS_ON_RUNQUEUE (0x0001) +#define STATUS_RUNNING (0x0002 + STATUS_ON_RUNQUEUE) +#define STATUS_PENDING (0x0004 + STATUS_ON_RUNQUEUE) +#define STATUS_STOPPED (0x0008) +#define STATUS_SLEEPING (0x0010) +#define STATUS_MUTEX_BLOCKED (0x0020) +#define STATUS_RECEIVE_BLOCKED (0x0040) +#define STATUS_SEND_BLOCKED (0x0080) +#define STATUS_REPLY_BLOCKED (0x0100) +#define STATUS_TIMER_WAITING (0x0200) typedef struct tcb_t { char *sp; diff --git a/core/include/thread.h b/core/include/thread.h index 8fc747dbfaf7..a6e56d684e62 100644 --- a/core/include/thread.h +++ b/core/include/thread.h @@ -1,24 +1,34 @@ -#ifndef __THREAD_H -#define __THREAD_H - -/** - * @defgroup thread Threading - * @ingroup kernel - * @{ +/* + * 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. */ /** - * @file + * @defgroup core_thread Threading + * @ingroup core + * @brief Support for multi-threading + * @{ + * + * @file thread.h + * @brief Threading API + * * @author Freie Universität Berlin, Computer Systems & Telematics * @author Kaspar Schleiser */ +#ifndef __THREAD_H +#define __THREAD_H + + #include #include /** Minimum stack size */ #ifndef MINIMUM_STACK_SIZE -#define MINIMUM_STACK_SIZE (sizeof(tcb_t)) +#define MINIMUM_STACK_SIZE (sizeof(tcb_t)) #endif /** diff --git a/core/kernel_init.c b/core/kernel_init.c index 70174e0a9240..3ee1381ebc4e 100644 --- a/core/kernel_init.c +++ b/core/kernel_init.c @@ -1,16 +1,20 @@ -/** - * platform-independent kernel initialization - * +/* * Copyright (C) 2013 Freie Universität Berlin * * This file is 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. - * - * @ingroup kernel + */ + +/** + * @ingroup core_internal * @{ - * @file - * @author Kaspar Schleiser + * + * @file kernel_init.c + * @brief Platform-independent kernel initilization + * + * @author Kaspar Schleiser + * * @} */ diff --git a/core/lifo.c b/core/lifo.c index b916546af754..e66d89b0d552 100644 --- a/core/lifo.c +++ b/core/lifo.c @@ -1,3 +1,21 @@ +/* + * 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. + */ + +/** + * @ingroup core_util + * @{ + * + * @file lifo.c + * @brief LIFO buffer implementation + * + * @} + */ + #include int lifo_empty(int *array) diff --git a/core/msg.c b/core/msg.c index 046e1c9831bc..f73bdec5f619 100644 --- a/core/msg.c +++ b/core/msg.c @@ -1,18 +1,22 @@ -/** - * kernel messaging implementation - * +/* * Copyright (C) 2013 Freie Universität Berlin * * This file is 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. - * - * @ingroup kernel_msg + */ + +/** + * @ingroup core_msg * @{ + * * @file - * @author Freie Universität Berlin, Computer Systems & Telematics, FeuerWhere project - * @author Kaspar Schleiser - * @author Oliver Hahm + * @brief Kernel messaging implementation + * + * @author Freie Universität Berlin, Computer Systems & Telematics, FeuerWhere project + * @author Kaspar Schleiser + * @author Oliver Hahm + * * @} */ diff --git a/core/mutex.c b/core/mutex.c index fed10252dee8..1de584196315 100644 --- a/core/mutex.c +++ b/core/mutex.c @@ -1,16 +1,20 @@ -/** - * kernel mutex implementation - * +/* * Copyright (C) 2013 Freie Universität Berlin * * This file is 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. - * - * @ingroup kernel + */ + +/** + * @ingroup core_sync * @{ - * @file - * @author Kaspar Schleiser + * + * @file mutex.c + * @brief Kernel mutex implementation + * + * @author Kaspar Schleiser + * * @} */ @@ -113,4 +117,3 @@ void mutex_unlock(struct mutex_t *mutex) restoreIRQ(irqstate); } - diff --git a/core/oneway_malloc.c b/core/oneway_malloc.c index 2a3d7b3c9ea4..fb4e952a9699 100644 --- a/core/oneway_malloc.c +++ b/core/oneway_malloc.c @@ -1,4 +1,4 @@ -/** +/* * simple malloc wrapper for sbrk * * Needed on platforms without malloc in libc, e.g. msb430 @@ -8,11 +8,18 @@ * This file is 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. - * - * @ingroup kernel + +/** + * @ingroup core_util * @{ - * @file - * @author Kaspar Schleiser + * + * @file oneway_malloc.c + * @brief Simple malloc wrapper for SBRK + * + * Simple malloc implementation for plattforms without malloc in libc. + * + * @author Kaspar Schleiser + * * @} */ @@ -63,4 +70,3 @@ void _free(void *ptr) DEBUG("_free(): block at 0x%X lost.\n", (unsigned int)ptr); } - diff --git a/core/queue.c b/core/queue.c index 0da47c1c9fb7..44e857d66fdb 100644 --- a/core/queue.c +++ b/core/queue.c @@ -1,16 +1,20 @@ -/** - * simple queue implementation - * +/* * Copyright (C) 2013 Freie Universität Berlin * * This file is 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. - * - * @ingroup kernel + */ + +/** + * @ingroup core_util * @{ - * @file - * @author Kaspar Schleiser + * + * @file queue.c + * @brief A simple queue implementation + * + * @author Freie Universität Berlin, Computer Systems & Telematics + * @author Kaspar Schleiser * @} */ diff --git a/core/sched.c b/core/sched.c index c391e72f3036..da27f02f5da5 100644 --- a/core/sched.c +++ b/core/sched.c @@ -1,21 +1,26 @@ -/** - * The RIOT scheduler implementation - * +/* * Copyright (C) 2013 Freie Universität Berlin * * This file is 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. + */ + +/** + * @ingroup core_shed + * @{ * - * TODO: setup dependency from SCHEDSTATISTICS to MODULE_HWTIMER + * @file shed.c + * @brief Scheduler implementation + * + * @author Freie Universität Berlin, Computer Systems & Telematics + * @author Kaspar Schleiser * - * @ingroup kernel - * @{ - * @file - * @author Kaspar Schleiser * @} */ +/* TODO: setup dependency from SCHEDSTATISTICS to MODULE_HWTIMER */ + #include #include #include @@ -215,4 +220,3 @@ void sched_task_exit(void) active_thread = NULL; cpu_switch_context_exit(); } - diff --git a/core/thread.c b/core/thread.c index c2c85edd7996..339d25030696 100644 --- a/core/thread.c +++ b/core/thread.c @@ -1,16 +1,20 @@ -/** - * thread functions - * +/* * Copyright (C) 2013 Freie Universität Berlin * * This file is 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. - * - * @ingroup kernel + */ + +/** + * @ingroup core_thread * @{ - * @file - * @author Kaspar Schleiser + * + * @file thread.c + * @brief Threading implementation + * + * @author Kaspar Schleiser + * * @} */ @@ -233,4 +237,3 @@ int thread_create(char *stack, int stacksize, char priority, int flags, void (*f return pid; } - diff --git a/cpu/arm_common/arm_cpu.c b/cpu/arm_common/arm_cpu.c index c70273e6e8b5..429088f83621 100644 --- a/cpu/arm_common/arm_cpu.c +++ b/cpu/arm_common/arm_cpu.c @@ -8,7 +8,7 @@ * Public License. See the file LICENSE in the top level directory for more * details. * - * @ingroup arch + * @ingroup arm_common * @{ * @file * @author Kaspar Schleiser diff --git a/cpu/cc430/doc.txt b/cpu/cc430/doc.txt new file mode 100644 index 000000000000..5e21f3547bc2 --- /dev/null +++ b/cpu/cc430/doc.txt @@ -0,0 +1,13 @@ +/* + * 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 cc430 TI CC430 + * @brief Texas Instruments CC430 specific code + * @ingroup cpu + */ diff --git a/cpu/doc.txt b/cpu/doc.txt new file mode 100644 index 000000000000..8f884e59b132 --- /dev/null +++ b/cpu/doc.txt @@ -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 cpu CPU + * @brief CPU specific implementations + * + * This module contains all CPU specific source files. In case of multiple CPUs + * sharing the same architecture, the implementation is split in a cpu specific + * and a architecture specific part (eg. arm-common and lpc2387). + */ diff --git a/cpu/lpc2387/gpioint/lpc2387-gpioint.c b/cpu/lpc2387/gpioint/lpc2387-gpioint.c index 2d34c673c7c9..965409230867 100644 --- a/cpu/lpc2387/gpioint/lpc2387-gpioint.c +++ b/cpu/lpc2387/gpioint/lpc2387-gpioint.c @@ -12,7 +12,6 @@ See the file LICENSE in the top level directory for more details. /** * @ingroup lpc2387 - * @addtogroup dev_gpioint * @{ */ diff --git a/cpu/lpc2387/include/cpu.h b/cpu/lpc2387/include/cpu.h index 54806fd25765..55d8f6ffefcb 100644 --- a/cpu/lpc2387/include/cpu.h +++ b/cpu/lpc2387/include/cpu.h @@ -16,6 +16,7 @@ See the file LICENSE in the top level directory for more details. /** * @defgroup lpc2387 NXP LPC2387 * @ingroup cpu + * @brief NXP LPC2387 specific code * @{ */ diff --git a/cpu/lpc_common/doc.txt b/cpu/lpc_common/doc.txt new file mode 100644 index 000000000000..f0cae381845f --- /dev/null +++ b/cpu/lpc_common/doc.txt @@ -0,0 +1,13 @@ +/* + * 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 lpc_common LPC common + * @brief Common code for all arm-based LPC controllers + * @ingroup cpu + */ diff --git a/cpu/mc1322x/include/cpu.h b/cpu/mc1322x/include/cpu.h index eb57ca9f798c..7ba2c7980b2c 100644 --- a/cpu/mc1322x/include/cpu.h +++ b/cpu/mc1322x/include/cpu.h @@ -5,6 +5,12 @@ * This source code is licensed under the GNU Lesser General Public License, * Version 2. See the file LICENSE for more details. */ + +/** + * @defgroup mc1322x Freescale MC1322x + * @ingroup cpu + * @brief Freescale MC1322x specific code + */ #ifndef CPU_H #define CPU_H diff --git a/cpu/msp430-common/include/cpu.h b/cpu/msp430-common/include/cpu.h index 9e5c7fe28241..562de619e4ef 100644 --- a/cpu/msp430-common/include/cpu.h +++ b/cpu/msp430-common/include/cpu.h @@ -16,6 +16,7 @@ See the file LICENSE in the top level directory for more details. /** * @defgroup msp430 TI MSP430 * @ingroup cpu + * @brief Texas Instruments MSP430 specific code

First steps

\li See the manual for toolchain and ide setup diff --git a/cpu/native/include/cpu.h b/cpu/native/include/cpu.h index 2b4e59654a24..60e2f3c0fee0 100644 --- a/cpu/native/include/cpu.h +++ b/cpu/native/include/cpu.h @@ -13,6 +13,8 @@ /** * @ingroup arch * @defgroup native_cpu Native CPU + * @ingroup cpu + * @brief CPU abstraction for the native port * @{ * @author Ludwig Ortmann */ diff --git a/cpu/native/include/nativenet.h b/cpu/native/include/nativenet.h index 184604002f6c..9e5a75b3b18b 100644 --- a/cpu/native/include/nativenet.h +++ b/cpu/native/include/nativenet.h @@ -16,7 +16,8 @@ */ /** - * @defgroup native_net + * @defgroup native_net + * @ingroup native_cpu * @{ * @author Ludwig Ortmann */ diff --git a/drivers/cc110x/cc1100.h b/drivers/cc110x/cc1100.h index 4fac1cbf00ab..3b7975233b25 100644 --- a/drivers/cc110x/cc1100.h +++ b/drivers/cc110x/cc1100.h @@ -13,8 +13,9 @@ and Telematics group (http://cst.mi.fu-berlin.de). *******************************************************************************/ /** - * @defgroup dev_cc110x TI Chipcon CC110x radio driver - * @ingroup dev + * @defgroup drivers_cc110x CC110x + * @ingroup drivers + * @brief Texas Instruments CC110x driver * *

Quick links

* \li \ref cc1100_packet_layer0_t MAC packet format diff --git a/drivers/cc110x_ng/cc110x-defaultSettings.c b/drivers/cc110x_ng/cc110x-defaultSettings.c index 3de2bf35b210..a5dc73a846a4 100644 --- a/drivers/cc110x_ng/cc110x-defaultSettings.c +++ b/drivers/cc110x_ng/cc110x-defaultSettings.c @@ -9,11 +9,9 @@ */ /** - * @ingroup dev_cc110x + * @ingroup drivers_cc110x_ng * @{ - */ - -/** + * * @file * @brief TI Chipcon CC110x default settings * @@ -24,6 +22,7 @@ * @author Oliver Hahm * * @note $Id: cc110x-defaultSettings.c 2058 2010-03-31 08:59:31Z hillebra $ + * @} */ #include "cc110x-defaultSettings.h" @@ -121,6 +120,3 @@ uint8_t pa_table[] = { ///< PATABLE with available output powers 0xC6, ///< + 9 dBm 0xC3 ///< +10 dBm }; // If PATABLE is changed in size, adjust MAX_OUTPUT_POWER definition in CC1100 interface! - - -/** @} */ diff --git a/drivers/cc110x_ng/cc110x-rx.c b/drivers/cc110x_ng/cc110x-rx.c index c9127571bda1..0492ca9bc41f 100644 --- a/drivers/cc110x_ng/cc110x-rx.c +++ b/drivers/cc110x_ng/cc110x-rx.c @@ -1,20 +1,20 @@ -/** - * Functions for packet reception on cc110x - * +/* * Copyright (C) 2009 Freie Universität Berlin * Copyright (C) 2013 INRIA * * This file is 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. - * - * @ingroup dev_cc110x_ng + */ + +/** + * @ingroup drivers_cc110x_ng * @{ - * @file - * @author Oliver Hahm + * @file cc110x-rx.c + * @brief Functions for packet reception on cc110x + * @author Oliver Hahm * @} */ - #include #include #include diff --git a/drivers/cc110x_ng/cc110x-tx.c b/drivers/cc110x_ng/cc110x-tx.c index a4ba933f994f..62c1e68cced5 100644 --- a/drivers/cc110x_ng/cc110x-tx.c +++ b/drivers/cc110x_ng/cc110x-tx.c @@ -1,20 +1,20 @@ -/** - * Functions for packet transmission on cc110x - * +/* * Copyright (C) 2009 Freie Universität Berlin * Copyright (C) 2013 INRIA * * This file is 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. - * - * @ingroup dev_cc110x_ng + */ + +/** + * @ingroup drivers_cc110x_ng * @{ - * @file - * @author Oliver Hahm + * @file cc110x-tx.c + * @brief Functions for packet transmission on cc110x + * @author Oliver Hahm * @} */ - #include #include diff --git a/drivers/cc110x_ng/cc110x.c b/drivers/cc110x_ng/cc110x.c index 53f75b99d8fe..bf7e14964136 100644 --- a/drivers/cc110x_ng/cc110x.c +++ b/drivers/cc110x_ng/cc110x.c @@ -1,17 +1,19 @@ -/** - * Basic functionality of cc110x driver - * +/* * Copyright (C) 2013 Freie Universität Berlin * Copyright (C) 2013 INRIA * * This file is 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. - * - * @ingroup dev_cc110x_ng + */ + +/** + * @ingroup drivers_cc110x_ng * @{ - * @file - * @author Oliver Hahm + * + * @file cc110x.c + * @brief Basic functionality of cc110x driver + * @author Oliver Hahm * @} */ #include diff --git a/drivers/cc110x_ng/include/cc110x-arch.h b/drivers/cc110x_ng/include/cc110x-arch.h index 78a22acad60a..62865999a37a 100644 --- a/drivers/cc110x_ng/include/cc110x-arch.h +++ b/drivers/cc110x_ng/include/cc110x-arch.h @@ -13,9 +13,11 @@ and Telematics group (http://cst.mi.fu-berlin.de). *******************************************************************************/ /** - * @file - * @ingroup LPC2387 - * @brief CC1100 LPC2387 dependend functions + * @ingroup drivers_cc110x_ng + * @{ + * + * @file cc110x-arch.h + * @brief CC1100 architecture dependent functions * * @author Freie Universität Berlin, Computer Systems & Telematics * @author Heiko Will @@ -23,6 +25,8 @@ and Telematics group (http://cst.mi.fu-berlin.de). * * @note $Id: arch_cc110x.h 1775 2010-01-26 09:37:03Z hillebra $ */ +#ifndef __CC1100_ARCH_H +#define __CC1100_ARCH_H #include @@ -36,3 +40,6 @@ void cc110x_init_interrupts(void); void cc110x_before_send(void); void cc110x_after_send(void); + +/** @} */ +#endif /* __CC1100_ARCH_H */ diff --git a/drivers/cc110x_ng/include/cc110x-config.h b/drivers/cc110x_ng/include/cc110x-config.h index adad57b9b4ff..ddd53f839c97 100644 --- a/drivers/cc110x_ng/include/cc110x-config.h +++ b/drivers/cc110x_ng/include/cc110x-config.h @@ -8,11 +8,11 @@ * Public License. See the file LICENSE in the top level directory for more * details. * - * @ingroup dev_cc110x_ng + * @ingroup drivers_cc110x_ng * @{ - * @file + * + * @file cc110x-config.h * @author Oliver Hahm - * @} */ #ifndef CC1100_CONFIG_H #define CC1100_CONFIG_H @@ -108,4 +108,5 @@ typedef struct cc110x_statistic { uint32_t watch_dog_resets; } cc110x_statistic_t; -#endif +/** @} */ +#endif /* __CC110X_CONFIG_H */ diff --git a/drivers/cc110x_ng/include/cc110x-defaultSettings.h b/drivers/cc110x_ng/include/cc110x-defaultSettings.h index 80d021309695..37057830d425 100644 --- a/drivers/cc110x_ng/include/cc110x-defaultSettings.h +++ b/drivers/cc110x_ng/include/cc110x-defaultSettings.h @@ -12,11 +12,11 @@ and Telematics group (http://cst.mi.fu-berlin.de). * *******************************************************************************/ -#ifndef CC1100_DEFAULTSETTINGS_H -#define CC1100_DEFAULTSETTINGS_H +#ifndef __CC1100_DEFAULTSETTINGS_H +#define __CC1100_DEFAULTSETTINGS_H /** - * @ingroup dev_cc110x + * @ingroup drivers_cc110x_ng * @{ */ @@ -95,4 +95,4 @@ and Telematics group (http://cst.mi.fu-berlin.de). /** @} */ -#endif +#endif /* __CC110X_DEFAULTSETTINGS_H */ diff --git a/drivers/cc110x_ng/include/cc110x-internal.h b/drivers/cc110x_ng/include/cc110x-internal.h index 98bfeb4f8430..20a7279270bc 100644 --- a/drivers/cc110x_ng/include/cc110x-internal.h +++ b/drivers/cc110x_ng/include/cc110x-internal.h @@ -1,40 +1,27 @@ -/** - * Driver internal constants for 110x chip configuration - * +/* * Copyright (C) 2008 Freie Universität Berlin * Copyright (C) 2013 INRIA * * This file is 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. - * - * @ingroup dev_cc110x_ng - * @{ - * @file - * @author Oliver Hahm - * @} */ -#ifndef CC1100_INTERNAL_H -#define CC1100_INTERNAL_H - /** - * @ingroup dev_cc110x + * @ingroup drivers_cc110x_ng * @{ - */ - -/** + * * @file - * @internal - * @brief TI Chipcon CC110x internal hardware constants + * @brief Driver internal constants for 110x chip configuration * * @author Freie Universität Berlin, Computer Systems & Telematics * @author Thomas Hillebrandt * @author Heiko Will - * @version $Revision: 1231 $ - * - * @note $Id: cc110x-internal.h 1231 2009-08-20 08:31:32Z baar $ + * @author Oliver Hahm */ +#ifndef CC1100_INTERNAL_H +#define CC1100_INTERNAL_H + #define FIXED_PKTLEN (0x00) ///< Fixed length packets, length configured in PKTLEN register. #define VARIABLE_PKTLEN (0x01) ///< Variable length packets, packet length configured by the first @@ -203,7 +190,7 @@ #define CC1100_PATABLE (0x3E) #define CC1100_TXFIFO (0x3F) ///< TX FIFO: Write operations write to the TX FIFO (SB: +0x00; BURST: +0x40) #define CC1100_RXFIFO (0x3F) ///< RX FIFO: Read operations read from the RX FIFO (SB: +0x80; BURST: +0xC0) - /** @} */ +/** @} */ #endif diff --git a/drivers/cc110x_ng/include/cc110x-reg.h b/drivers/cc110x_ng/include/cc110x-reg.h index f34d1f1cc10b..df5318774b5a 100644 --- a/drivers/cc110x_ng/include/cc110x-reg.h +++ b/drivers/cc110x_ng/include/cc110x-reg.h @@ -1,15 +1,24 @@ +/* + * Copyright (C) 2008 Freie Universität Berlin + * Copyright (C) 2013 INRIA + * + * 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. + */ + /** - * @file cc110x-reg.h - * @ingroup dev_cc110x_ng - * @brief Access to CC110X registers + * @ingroup drivers_cc110x_ng + * @{ * - * @author INRIA - * @author Oliver Hahm + * @file cc110x-reg.h + * @brief Access to CC110X registers * + * @author INRIA + * @author Oliver Hahm */ - -#ifndef CC110X_REG_H -#define CC110X_REG_H +#ifndef __CC110X_REG_H +#define __CC110X_REG_H #include @@ -79,4 +88,5 @@ uint8_t cc110x_read_status(uint8_t addr); */ uint8_t cc110x_strobe(uint8_t c); -#endif +/** @} */ +#endif /* __CC110X_REG_H */ diff --git a/drivers/cc110x_ng/include/cc110x_ng.h b/drivers/cc110x_ng/include/cc110x_ng.h index e49c91159095..be0558ee89ba 100644 --- a/drivers/cc110x_ng/include/cc110x_ng.h +++ b/drivers/cc110x_ng/include/cc110x_ng.h @@ -1,18 +1,20 @@ -/** - * Data structures and variables for the cc110x driver interface - * +/* * Copyright (C) 2009 Freie Universität Berlin * Copyright (C) 2013 INRIA * * This file is 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. - * - * @ingroup dev_cc110x_ng + */ + +/** + * @defgroup drivers_cc110x_ng CC110x_ng + * @brief Next generation version of the TI CC110x driver + * @ingroup drivers * @{ - * @file + * @file cc110x_ng.h + * @brief Data structures and variables for the cc110x driver interface * @author Oliver Hahm - * @} */ #ifndef CC1100_H #define CC1100_H @@ -166,6 +168,8 @@ void cc110x_init_ignore(void); uint8_t cc110x_add_ignored(radio_address_t addr); #endif - +/** + * @} + */ #endif diff --git a/drivers/cc110x_ng/include/cc110x_spi.h b/drivers/cc110x_ng/include/cc110x_spi.h index 78bfa47a1ce7..08554f853139 100644 --- a/drivers/cc110x_ng/include/cc110x_spi.h +++ b/drivers/cc110x_ng/include/cc110x_spi.h @@ -13,13 +13,12 @@ and Telematics group (http://cst.mi.fu-berlin.de). *******************************************************************************/ /** - * @ingroup dev_cc110x + * @ingroup drivers_cc110x_ng * @{ */ /** * @file - * @internal * @brief TI Chipcon CC1100 SPI driver * * @author Freie Universität Berlin, Computer Systems & Telematics diff --git a/drivers/cc110x_ng/spi/cc110x_spi.c b/drivers/cc110x_ng/spi/cc110x_spi.c index bf4bb949d90a..fb5f8bd3b642 100644 --- a/drivers/cc110x_ng/spi/cc110x_spi.c +++ b/drivers/cc110x_ng/spi/cc110x_spi.c @@ -13,13 +13,12 @@ and Telematics group (http://cst.mi.fu-berlin.de). *******************************************************************************/ /** - * @ingroup dev_cc110x + * @ingroup drivers_cc110x_ng * @{ */ /** * @file - * @internal * @brief TI Chipcon CC1100 SPI driver * * @author Freie Universität Berlin, Computer Systems & Telematics diff --git a/drivers/doc.txt b/drivers/doc.txt new file mode 100644 index 000000000000..f93b8894d591 --- /dev/null +++ b/drivers/doc.txt @@ -0,0 +1,14 @@ +/* + * 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 drivers Drivers + * @brief Drivers for external devices as radios, sensors, memory etc. + * + * The module contains all kind of drivers for specific devices. + */ diff --git a/drivers/include/adc.h b/drivers/include/adc.h index 51ed971ef500..4136b1225882 100644 --- a/drivers/include/adc.h +++ b/drivers/include/adc.h @@ -3,6 +3,13 @@ #include + +/** + * @defgroup drivers_adc ADC + * @ingroup drivers + * @brief Generic ADC driver + */ + /** * @brief Initialize ADC. */ diff --git a/drivers/include/diskio.h b/drivers/include/diskio.h index 0ed8b2b914a7..e83c80d95663 100644 --- a/drivers/include/diskio.h +++ b/drivers/include/diskio.h @@ -2,6 +2,14 @@ / Low level disk interface modlue include file (C)ChaN, 2010 /-----------------------------------------------------------------------*/ +/** + * @defgroup diskio Disk IO Driver + * @ingroup drivers + * @brief Low level disk interface + * + * The connection between the MCU and the SRF08 is based on the i2c-interface. + */ + #ifndef DEF_DISKIO #define DEF_DISKIO diff --git a/drivers/include/flashrom.h b/drivers/include/flashrom.h index dd798423dea6..c7f78ce2cc56 100644 --- a/drivers/include/flashrom.h +++ b/drivers/include/flashrom.h @@ -1,3 +1,12 @@ + + + +/** + * @defgroup flashrom Flash memory driver + * @ingroup drivers + * @brief Generic flash memory driver + */ + #ifndef FLASHROM_H #define FLASHROM_H diff --git a/drivers/include/gpioint.h b/drivers/include/gpioint.h index 17aa629ecaee..b4fc89903e34 100644 --- a/drivers/include/gpioint.h +++ b/drivers/include/gpioint.h @@ -16,10 +16,9 @@ and Telematics group (http://cst.mi.fu-berlin.de). #define GPIOINT_H_ /** - * @defgroup dev_gpioint GPIO IRQ Multiplexer - * @ingroup dev - * - * Provides an API to implement interrupt handlers on IO pins. + * @defgroup drivers_gpioint GPIO IRQ Multiplexer + * @ingroup drivers + * @brief Provides an API to implement interrupt handlers on IO pins. * * Multiplexer and interrupt handling must be implemented platform specific. * diff --git a/drivers/include/lm75a-temp-sensor.h b/drivers/include/lm75a-temp-sensor.h index 6ce77ca61156..5fccab68b756 100644 --- a/drivers/include/lm75a-temp-sensor.h +++ b/drivers/include/lm75a-temp-sensor.h @@ -7,6 +7,14 @@ * This source code is licensed under the LGPLv2 license, * See the file LICENSE for more details. */ + +/** + * @defgroup lm75a LM75A + * @ingroup drivers + * @brief Driver for the LM75A digital temperature sensor and thermal watchdog + * + * The connection between the MCU and the LM75A is based on the i2c-interface. + */ /** * @file diff --git a/drivers/include/ltc4150_arch.h b/drivers/include/ltc4150_arch.h index 3aded5112926..db6c799dfe0b 100644 --- a/drivers/include/ltc4150_arch.h +++ b/drivers/include/ltc4150_arch.h @@ -16,8 +16,9 @@ and Telematics group (http://cst.mi.fu-berlin.de). #define __LTC4150_ARCH_H /** - * @defgroup ltc4150 LTC4150 Coulomb Counter + * @defgroup ltc4150 LTC4150 * @ingroup drivers + * @brief Driver for the Linear Technology LTC4150 Coulomb Counter * @{ */ diff --git a/drivers/include/rtc.h b/drivers/include/rtc.h index 6b9f6a530235..6799f0789c13 100644 --- a/drivers/include/rtc.h +++ b/drivers/include/rtc.h @@ -13,8 +13,9 @@ and Telematics group (http://cst.mi.fu-berlin.de). *******************************************************************************/ /** - * @defgroup rtc Realtime Clock - * @ingroup drivers + * @defgroup rtc Realtime Clock + * @ingroup drivers + * @brief Generic real time clock driver * @{ */ diff --git a/drivers/include/sht11.h b/drivers/include/sht11.h index 9d05bc71bb7f..aa1f9e3aa3fe 100644 --- a/drivers/include/sht11.h +++ b/drivers/include/sht11.h @@ -16,7 +16,7 @@ and Telematics group (http://cst.mi.fu-berlin.de). #define SHT11_H_ /** - * @defgroup sht11 Sensirion SHT11 Driver + * @defgroup sht11 SHT11 * @ingroup drivers * @{ */ diff --git a/drivers/include/srf02-ultrasonic-sensor.h b/drivers/include/srf02-ultrasonic-sensor.h index f27895a72611..c7c144e61d2e 100644 --- a/drivers/include/srf02-ultrasonic-sensor.h +++ b/drivers/include/srf02-ultrasonic-sensor.h @@ -6,6 +6,14 @@ * * This source code is licensed under the LGPLv2 license, * See the file LICENSE for more details. + */ + +/** + * @defgroup srf02 SRF02 + * @ingroup drivers + * @brief Driver for the SRF02 ultrasonic range sensor + * + * The connection between the MCU and the SRF08 is based on the i2c-interface. */ /** diff --git a/drivers/include/srf08-ultrasonic-sensor.h b/drivers/include/srf08-ultrasonic-sensor.h index 8d78f46d9e70..7749fafaca58 100644 --- a/drivers/include/srf08-ultrasonic-sensor.h +++ b/drivers/include/srf08-ultrasonic-sensor.h @@ -6,6 +6,14 @@ * This source code is licensed under the LGPLv2 license, * See the file LICENSE for more details. */ + +/** + * @defgroup srf08 SRF08 + * @ingroup drivers + * @brief Driver for the SRF08 ultrasonic range sensor + * + * The connection between the MCU and the SRF08 is based on the i2c-interface. + */ /** * @file diff --git a/drivers/sht11/sht11.c b/drivers/sht11/sht11.c index 08e9f4032565..bd3699da39da 100644 --- a/drivers/sht11/sht11.c +++ b/drivers/sht11/sht11.c @@ -13,7 +13,9 @@ and Telematics group (http://cst.mi.fu-berlin.de). *******************************************************************************/ /** - * @ingroup sht11 + * @defgroup sht11 SHT11 + * @ingroup drivers + * @brief Driver for the Sensirion SHT11 humidity and temperature sensor * @{ */ diff --git a/sys/doc.txt b/sys/doc.txt new file mode 100644 index 000000000000..0dcd8b3a555e --- /dev/null +++ b/sys/doc.txt @@ -0,0 +1,12 @@ +/* + * 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 sys System + * @brief System library contains tools and utilities that make RIOT an actual operating system + */ diff --git a/sys/include/auto_init.h b/sys/include/auto_init.h index a8d1b61d8dfe..86876fcc326e 100644 --- a/sys/include/auto_init.h +++ b/sys/include/auto_init.h @@ -1,3 +1,10 @@ + +/** + * @defgroup sys_autoinit Auto-init + * @ingroup sys + * @brief Autoconfigure libraries + */ + #ifndef AUTO_INIT_H #define AUTO_INIT_H diff --git a/sys/include/bloom.h b/sys/include/bloom.h index e149a625ec60..02628d85dd59 100644 --- a/sys/include/bloom.h +++ b/sys/include/bloom.h @@ -1,3 +1,10 @@ + +/** + * @defgroup sys_bloom Bloom filter + * @ingroup sys + * @brief Bloom filter library + */ + /** * bloom.c * diff --git a/sys/include/board_uart0.h b/sys/include/board_uart0.h index 1fa131d2f9f7..7b6de7af7ecb 100644 --- a/sys/include/board_uart0.h +++ b/sys/include/board_uart0.h @@ -1,3 +1,10 @@ + +/** + * @defgroup sys_uart0 UART0 + * @ingroup sys + * @brief UART0 interface abstraction + */ + #ifndef __BOARD_UART0_H #define __BOARD_UART0_H diff --git a/sys/include/chardev_thread.h b/sys/include/chardev_thread.h index 7615abfe9ea8..1d2b8a5cd345 100644 --- a/sys/include/chardev_thread.h +++ b/sys/include/chardev_thread.h @@ -1,3 +1,10 @@ + +/** + * @defgroup sys_chardevthread Chardev Thread + * @ingroup sys + * @brief Chardev thread + */ + #ifndef __CHARDEV_THREAD_H #define __CHARDEV_THREAD_H diff --git a/sys/include/hashes.h b/sys/include/hashes.h index 881d1fbe94f5..636c726a01f2 100644 --- a/sys/include/hashes.h +++ b/sys/include/hashes.h @@ -8,6 +8,12 @@ * details. */ +/** + * @defgroup sys_hashes Hashes + * @ingroup sys + * @brief Hash function library + */ + /** * @file * @autor Jason Linehan diff --git a/sys/include/ping.h b/sys/include/ping.h index 7f51fd666663..d671d8aee612 100644 --- a/sys/include/ping.h +++ b/sys/include/ping.h @@ -1,3 +1,10 @@ + +/** + * @defgroup sys_ping Ping + * @ingroup sys + * @brief Ping + */ + #include "radio/radio.h" void init_payload(void); diff --git a/sys/include/posix_io.h b/sys/include/posix_io.h index 9f880b82da4d..df11cff33771 100644 --- a/sys/include/posix_io.h +++ b/sys/include/posix_io.h @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2013 INRIA. * * This file is subject to the terms and conditions of the GNU Lesser General @@ -6,8 +6,10 @@ * details. */ -/** - * @addtogroup posix +/** + * @defgroup sys_posixio Posix IO + * @ingroup sys + * @brief Posix compatible IO * @{ * @file * @brief POSIX-like IO diff --git a/sys/include/ps.h b/sys/include/ps.h index 12093cbf5574..010272a30040 100644 --- a/sys/include/ps.h +++ b/sys/include/ps.h @@ -1,3 +1,10 @@ + +/** + * @defgroup sys_ps PS + * @ingroup sys + * @brief Show list with all threads + */ + #ifndef __PS_H #define __PS_H diff --git a/sys/include/random.h b/sys/include/random.h index 3ae032cc42be..e4295b3f5a9f 100644 --- a/sys/include/random.h +++ b/sys/include/random.h @@ -1,3 +1,10 @@ + +/** + * @defgroup sys_random Random + * @ingroup sys + * @brief Random number generator + */ + #include #ifndef PRNG_FLOAT diff --git a/sys/include/sha256.h b/sys/include/sha256.h index 288bb2d7e63e..aa9f30e59bc5 100644 --- a/sys/include/sha256.h +++ b/sys/include/sha256.h @@ -26,6 +26,13 @@ * * $FreeBSD: src/lib/libmd/sha256.h,v 1.1.2.1 2005/06/24 13:32:25 cperciva Exp $ */ + + +/** + * @defgroup sys_sha256 SHA264 + * @ingroup sys + * @brief SHA264 hash generator + */ #ifndef _SHA256_H_ #define _SHA256_H_ diff --git a/sys/include/shell.h b/sys/include/shell.h index 64a9b45751aa..ad1750918083 100644 --- a/sys/include/shell.h +++ b/sys/include/shell.h @@ -12,14 +12,15 @@ * *******************************************************************************/ -#ifndef __SHELL_H -#define __SHELL_H - /** - * @defgroup shell Simple Shell Interpreter - * @ingroup feuerware + * @defgroup sys_shell Shell + * @ingroup sys + * @brief Simple shell interpreter */ +#ifndef __SHELL_H +#define __SHELL_H + typedef struct shell_command_t { char *name; char *desc; diff --git a/sys/include/timex.h b/sys/include/timex.h index 817b22bf8cfe..e0b9a99b6927 100644 --- a/sys/include/timex.h +++ b/sys/include/timex.h @@ -1,3 +1,10 @@ + +/** + * @defgroup sys_timex Timex + * @ingroup sys + * @brief Utility library for comparing and computing timestamps + */ + #ifndef __TIMEX_H #define __TIMEX_H diff --git a/sys/include/transceiver.h b/sys/include/transceiver.h index 80d6e6211888..b9c818faf542 100644 --- a/sys/include/transceiver.h +++ b/sys/include/transceiver.h @@ -1,3 +1,10 @@ + +/** + * @defgroup sys_transceiver Transceiver + * @ingroup sys + * @brief Transceiver library + */ + #ifndef TRANSCEIVER_H #define TRANSCEIVER_H diff --git a/sys/include/vtimer.h b/sys/include/vtimer.h index 2793ade53591..e1d5e09e3912 100644 --- a/sys/include/vtimer.h +++ b/sys/include/vtimer.h @@ -1,4 +1,4 @@ -/** \addtogroup system +/** \addtogroup sys * @{ */ /** diff --git a/sys/net/doc.txt b/sys/net/doc.txt new file mode 100644 index 000000000000..810b73ffef5f --- /dev/null +++ b/sys/net/doc.txt @@ -0,0 +1,13 @@ +/* + * 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 net Net + * @ingroup sys + * @brief Networking libraries + */ diff --git a/sys/net/include/ieee802154_frame.h b/sys/net/include/ieee802154_frame.h index 224684a5b1f4..d75056e8bc92 100644 --- a/sys/net/include/ieee802154_frame.h +++ b/sys/net/include/ieee802154_frame.h @@ -7,7 +7,9 @@ * Public License. See the file LICENSE in the top level directory for more * details. * + * @defgroup net_ieee802154 IEEE802.15.4 * @ingroup net + * @brief IEEE802.15.4 adapaption layer * @{ * @file ieee802154/ieee802154_frame.h * @brief IEEE 802.14.4 framing data structs and prototypes diff --git a/sys/net/include/net_help.h b/sys/net/include/net_help.h index 8db17e7d5426..8ef9c5994f2c 100644 --- a/sys/net/include/net_help.h +++ b/sys/net/include/net_help.h @@ -5,6 +5,12 @@ * Author: Oliver */ +/** + * @defgroup net_help Net help + * @ingroup net + * @brief Helper functions for networking as byte order conversions and checksum calculations + */ + #ifndef COMMON_H_ #define COMMON_H_ #include diff --git a/sys/net/include/protocol-multiplex.h b/sys/net/include/protocol-multiplex.h index f9929916db7b..d8ff545364e5 100644 --- a/sys/net/include/protocol-multiplex.h +++ b/sys/net/include/protocol-multiplex.h @@ -16,7 +16,9 @@ and Telematics group (http://cst.mi.fu-berlin.de). #define PROTOCOLMULTIPLEX_H_ /** - * @addtogroup net + * @defgroup net_mmstack Protocol multiplex + * @ingroup net + * @brief Protocol handler multiplexing * @{ */ diff --git a/sys/net/rpl/rpl.h b/sys/net/rpl/rpl.h index 6c2e8a8ecf83..cc10affc67c0 100644 --- a/sys/net/rpl/rpl.h +++ b/sys/net/rpl/rpl.h @@ -7,7 +7,9 @@ * Public License. See the file LICENSE in the top level directory for more * details. * - * @ingroup rpl + * @defgroup net_rpl RPL + * @ingroup net + * @brief Routing Protocol for Low power and Lossy Networks * @{ * @file rpl.h * @brief RPL header diff --git a/sys/net/sixlowpan/lowpan.h b/sys/net/sixlowpan/lowpan.h index ebf4ea44cc10..1299559e8c4c 100644 --- a/sys/net/sixlowpan/lowpan.h +++ b/sys/net/sixlowpan/lowpan.h @@ -7,7 +7,9 @@ * Public License. See the file LICENSE in the top level directory for more * details. * - * @ingroup sixlowpan + * @defgroup net_sixlowpan 6LoWPAN + * @ingroup net + * @brief Riots 6LowPAN implementation * @{ * @file sixlowpan.h * @brief 6lowpan header From edcabf7cb6b08675c56bae4e85cffaa0d2652d84 Mon Sep 17 00:00:00 2001 From: Hauke Petersen Date: Wed, 27 Nov 2013 17:54:30 +0100 Subject: [PATCH 2/4] Fixed a lot of comments by removing tabs and correcting format. --- core/bitarithm.c | 5 + core/include/config.h | 2 +- core/include/hwtimer.h | 5 +- core/include/io.h | 2 +- core/include/irq.h | 2 +- core/include/lifo.h | 1 + core/include/msg.h | 2 +- core/include/queue.h | 2 - core/lifo.c | 3 + core/sched.c | 4 +- cpu/arm_common/arm_cpu.c | 5 - cpu/cc430/doc.txt | 6 +- cpu/lpc2387/gpioint/lpc2387-gpioint.c | 64 +++--- cpu/lpc2387/include/cpu.h | 8 +- cpu/lpc_common/doc.txt | 6 +- cpu/mc1322x/include/cpu.h | 8 +- cpu/msp430-common/include/cpu.h | 11 +- cpu/native/include/cpu.h | 4 +- cpu/native/include/nativenet.h | 4 +- drivers/cc110x/cc1100.h | 209 +++++++++--------- drivers/cc110x_ng/cc110x-defaultSettings.c | 48 ++-- drivers/cc110x_ng/cc110x-rx.c | 24 +- drivers/cc110x_ng/cc110x-tx.c | 9 +- drivers/cc110x_ng/cc110x.c | 26 +-- drivers/cc110x_ng/include/cc110x-arch.h | 16 +- drivers/cc110x_ng/include/cc110x-config.h | 76 +++---- .../include/cc110x-defaultSettings.h | 53 ++--- drivers/cc110x_ng/include/cc110x-internal.h | 109 ++++----- drivers/cc110x_ng/include/cc110x-reg.h | 11 +- drivers/cc110x_ng/include/cc110x_ng.h | 100 ++++----- drivers/cc110x_ng/include/cc110x_spi.h | 15 +- drivers/cc110x_ng/spi/cc110x_spi.c | 26 +-- drivers/doc.txt | 4 +- drivers/include/adc.h | 23 +- drivers/include/diskio.h | 82 +++---- drivers/include/flashrom.h | 22 +- drivers/include/gpioint.h | 49 ++-- drivers/include/lm75a-temp-sensor.h | 22 +- drivers/include/ltc4150_arch.h | 11 +- drivers/include/rtc.h | 22 +- drivers/include/sht11.h | 43 ++-- drivers/include/srf02-ultrasonic-sensor.h | 27 +-- drivers/include/srf08-ultrasonic-sensor.h | 23 +- sys/doc.txt | 4 +- sys/include/auto_init.h | 12 +- sys/include/bloom.h | 21 +- sys/include/board_uart0.h | 11 +- sys/include/chardev_thread.h | 6 +- sys/include/hashes.h | 25 ++- sys/include/ping.h | 6 +- sys/include/posix_io.h | 6 +- sys/include/ps.h | 6 +- sys/include/random.h | 6 +- sys/include/sha256.h | 6 +- sys/include/shell.h | 6 +- sys/include/timex.h | 6 +- sys/include/transceiver.h | 6 +- sys/include/vtimer.h | 18 +- sys/net/doc.txt | 6 +- sys/net/include/ieee802154_frame.h | 19 +- sys/net/include/net_help.h | 24 +- sys/net/include/protocol-multiplex.h | 42 ++-- sys/net/rpl/rpl.h | 29 ++- sys/net/sixlowpan/lowpan.h | 30 +-- 64 files changed, 729 insertions(+), 760 deletions(-) diff --git a/core/bitarithm.c b/core/bitarithm.c index 398c85f81510..265362fcf953 100644 --- a/core/bitarithm.c +++ b/core/bitarithm.c @@ -9,10 +9,15 @@ /** * @ingroup core_util * @{ +<<<<<<< HEAD * * @file bitarithm.c * @brief Bit arithmetic helper functions implementation * +======= + * @file bitarithm.c + * @brief Bit arithmetic helper functions implementation +>>>>>>> 94fedda... Fixed a lot of comments by removing tabs and correcting format. * @author Kaspar Schleiser * @author Martin Lenders * diff --git a/core/include/config.h b/core/include/config.h index 332d43ff94f7..7492a57a4797 100644 --- a/core/include/config.h +++ b/core/include/config.h @@ -13,9 +13,9 @@ * @file config.h * @brief Kernel configuration interface * + * @author unknown */ - #ifndef CONFIG_H #define CONFIG_H diff --git a/core/include/hwtimer.h b/core/include/hwtimer.h index cfc25804c450..c916dc63cf6c 100644 --- a/core/include/hwtimer.h +++ b/core/include/hwtimer.h @@ -122,12 +122,9 @@ void hwtimer_spin(unsigned long ticks); int hwtimer_active(void); -/** - * @} - */ +/** @} */ /* internal */ - /** * @brief TODO * @internal diff --git a/core/include/io.h b/core/include/io.h index a51eeee17ca9..dcc2d62bb07f 100644 --- a/core/include/io.h +++ b/core/include/io.h @@ -24,5 +24,5 @@ int fw_puts(char *data, int count); -/** @} */ +/** @} */ #endif /* IO_H */ diff --git a/core/include/irq.h b/core/include/irq.h index d072aabb653c..82f4fe79ac05 100644 --- a/core/include/irq.h +++ b/core/include/irq.h @@ -57,5 +57,5 @@ void restoreIRQ(unsigned state); */ int inISR(void); -/** @} */ +/** @} */ #endif /* IRQ_H_ */ diff --git a/core/include/lifo.h b/core/include/lifo.h index 2db4c7c7dec7..1fb99b16642c 100644 --- a/core/include/lifo.h +++ b/core/include/lifo.h @@ -13,6 +13,7 @@ * @file lifo.h * @brief LIFO buffer API * + * @author unknwon */ #ifndef __LIFO_H diff --git a/core/include/msg.h b/core/include/msg.h index 206e745a2dfc..38199c819770 100644 --- a/core/include/msg.h +++ b/core/include/msg.h @@ -19,7 +19,7 @@ * queue are never dropped and the sending never blocks. Threads with a full message queue behaves * like in synchronous mode. * - * @{ + * @{ * * @file msg.h * @brief Messaging API for inter process communication diff --git a/core/include/queue.h b/core/include/queue.h index 13ff782846be..6da8f66aa09c 100644 --- a/core/include/queue.h +++ b/core/include/queue.h @@ -13,8 +13,6 @@ * @file queue.h * @brief A simple queue implementation * - * TODO document functions and datastructures - * * @author Freie Universität Berlin, Computer Systems & Telematics * @author Kaspar Schleiser */ diff --git a/core/lifo.c b/core/lifo.c index e66d89b0d552..33b7e71bf0d4 100644 --- a/core/lifo.c +++ b/core/lifo.c @@ -13,6 +13,9 @@ * @file lifo.c * @brief LIFO buffer implementation * + * @file lifo.c + * @brief LIFO buffer implementation + * @author unknown * @} */ diff --git a/core/sched.c b/core/sched.c index da27f02f5da5..528acc31cf34 100644 --- a/core/sched.c +++ b/core/sched.c @@ -17,10 +17,10 @@ * @author Kaspar Schleiser * * @} + * + * TODO: setup dependency from SCHEDSTATISTICS to MODULE_HWTIMER */ -/* TODO: setup dependency from SCHEDSTATISTICS to MODULE_HWTIMER */ - #include #include #include diff --git a/cpu/arm_common/arm_cpu.c b/cpu/arm_common/arm_cpu.c index 429088f83621..032b42020dc1 100644 --- a/cpu/arm_common/arm_cpu.c +++ b/cpu/arm_common/arm_cpu.c @@ -15,11 +15,6 @@ * @author Heiko Will * @} */ -/** - * - * - * - */ #include #include "arm_cpu.h" diff --git a/cpu/cc430/doc.txt b/cpu/cc430/doc.txt index 5e21f3547bc2..8987b573cb95 100644 --- a/cpu/cc430/doc.txt +++ b/cpu/cc430/doc.txt @@ -7,7 +7,7 @@ */ /** - * @defgroup cc430 TI CC430 - * @brief Texas Instruments CC430 specific code - * @ingroup cpu + * @defgroup cc430 TI CC430 + * @brief Texas Instruments CC430 specific code + * @ingroup cpu */ diff --git a/cpu/lpc2387/gpioint/lpc2387-gpioint.c b/cpu/lpc2387/gpioint/lpc2387-gpioint.c index 965409230867..836f50e70812 100644 --- a/cpu/lpc2387/gpioint/lpc2387-gpioint.c +++ b/cpu/lpc2387/gpioint/lpc2387-gpioint.c @@ -11,20 +11,20 @@ See the file LICENSE in the top level directory for more details. *******************************************************************************/ /** - * @ingroup lpc2387 + * @ingroup lpc2387 * @{ */ /** * @file - * @brief LPC2387 GPIO Interrupt Multiplexer implementation + * @brief LPC2387 GPIO Interrupt Multiplexer implementation * * @author Freie Universität Berlin, Computer Systems & Telematics - * @author Michael Baar + * @author Michael Baar * @version $Revision: 1508 $ * - * @note $Id: lpc2387-gpioint.c 1508 2009-10-26 15:10:02Z baar $ - * @see dev_gpioint + * @note $Id: lpc2387-gpioint.c 1508 2009-10-26 15:10:02Z baar $ + * @see dev_gpioint */ #include @@ -34,7 +34,7 @@ See the file LICENSE in the top level directory for more details. #include struct irq_callback_t { - fp_irqcb callback; + fp_irqcb callback; }; static struct irq_callback_t gpioint0[32]; @@ -54,50 +54,50 @@ void gpioint_init(void) bool gpioint_set(int port, uint32_t bitmask, int flags, fp_irqcb callback) { - struct irq_callback_t *cbdata; + struct irq_callback_t *cbdata; unsigned long bit; volatile unsigned long *en_f; volatile unsigned long *en_r; volatile unsigned long *en_clr; /* lookup registers */ - bit = number_of_highest_bit(bitmask); /* get irq mapping table index */ + bit = number_of_highest_bit(bitmask); /* get irq mapping table index */ switch(port) { - case 0: /* PORT0 */ + case 0: /* PORT0 */ cbdata = gpioint0; en_f = &IO0_INT_EN_F; en_r = &IO0_INT_EN_R; en_clr = &IO0_INT_CLR; break; - case 2: /* PORT2 */ + case 2: /* PORT2 */ cbdata = gpioint2; en_f = &IO2_INT_EN_F; en_r = &IO2_INT_EN_R; en_clr = &IO2_INT_CLR; break; - default: /* unsupported */ - return false; /* fail */ + default: /* unsupported */ + return false; /* fail */ } /* reconfigure irq */ unsigned long cpsr = disableIRQ(); - *en_clr |= bitmask; /* clear interrupt */ + *en_clr |= bitmask; /* clear interrupt */ if ((flags & GPIOINT_FALLING_EDGE) != 0) { - *en_f |= bitmask; /* enable falling edge */ + *en_f |= bitmask; /* enable falling edge */ } else { - *en_f &= ~bitmask; /* disable falling edge */ + *en_f &= ~bitmask; /* disable falling edge */ } if ((flags & GPIOINT_RISING_EDGE) != 0) { - *en_r |= bitmask; /* enable rising edge */ + *en_r |= bitmask; /* enable rising edge */ } else { - *en_r &= ~bitmask; /* disable rising edge */ + *en_r &= ~bitmask; /* disable rising edge */ } if (((flags & (GPIOINT_FALLING_EDGE | GPIOINT_RISING_EDGE)) != 0)) { @@ -105,12 +105,12 @@ gpioint_set(int port, uint32_t bitmask, int flags, fp_irqcb callback) } else { - cbdata[bit].callback = NULL; /* remove from interrupt mapping table */ + cbdata[bit].callback = NULL; /* remove from interrupt mapping table */ } restoreIRQ(cpsr); - return true; /* success */ + return true; /* success */ } /*---------------------------------------------------------------------------*/ static void __attribute__((__no_instrument_function__)) test_irq(int port, unsigned long f_mask, unsigned long r_mask, struct irq_callback_t *pcb) @@ -122,7 +122,7 @@ static void __attribute__((__no_instrument_function__)) test_irq(int port, unsig do { if ((pcb->callback != NULL)) { if ((r_mask & 1) | (f_mask & 1)) { - pcb->callback(); /* pass to handler */ + pcb->callback(); /* pass to handler */ } } @@ -135,7 +135,7 @@ static void __attribute__((__no_instrument_function__)) test_irq(int port, unsig /*---------------------------------------------------------------------------*/ void GPIO_IRQHandler(void) __attribute__((interrupt("IRQ"))); /** - * @brief GPIO Interrupt handler function + * @brief GPIO Interrupt handler function * @internal * * Invoked whenever an activated gpio interrupt is triggered by a rising @@ -143,27 +143,27 @@ void GPIO_IRQHandler(void) __attribute__((interrupt("IRQ"))); */ void __attribute__((__no_instrument_function__)) GPIO_IRQHandler(void) { - if (IO_INT_STAT & BIT0) { /* interrupt(s) on PORT0 pending */ - unsigned long int_stat_f = IO0_INT_STAT_F; /* save content */ - unsigned long int_stat_r = IO0_INT_STAT_R; /* save content */ + if (IO_INT_STAT & BIT0) { /* interrupt(s) on PORT0 pending */ + unsigned long int_stat_f = IO0_INT_STAT_F; /* save content */ + unsigned long int_stat_r = IO0_INT_STAT_R; /* save content */ - IO0_INT_CLR = int_stat_f; /* clear flags of fallen pins */ - IO0_INT_CLR = int_stat_r; /* clear flags of risen pins */ + IO0_INT_CLR = int_stat_f; /* clear flags of fallen pins */ + IO0_INT_CLR = int_stat_r; /* clear flags of risen pins */ test_irq(0, int_stat_f, int_stat_r, gpioint0); } - if (IO_INT_STAT & BIT2) { /* interrupt(s) on PORT2 pending */ - unsigned long int_stat_f = IO2_INT_STAT_F; /* save content */ - unsigned long int_stat_r = IO2_INT_STAT_R; /* save content */ + if (IO_INT_STAT & BIT2) { /* interrupt(s) on PORT2 pending */ + unsigned long int_stat_f = IO2_INT_STAT_F; /* save content */ + unsigned long int_stat_r = IO2_INT_STAT_R; /* save content */ - IO2_INT_CLR = int_stat_f; /* clear flags of fallen pins */ - IO2_INT_CLR = int_stat_r; /* clear flags of risen pins */ + IO2_INT_CLR = int_stat_f; /* clear flags of fallen pins */ + IO2_INT_CLR = int_stat_r; /* clear flags of risen pins */ test_irq(2, int_stat_f, int_stat_r, gpioint2); } - VICVectAddr = 0; /* Acknowledge Interrupt */ + VICVectAddr = 0; /* Acknowledge Interrupt */ } /*---------------------------------------------------------------------------*/ /** @} */ diff --git a/cpu/lpc2387/include/cpu.h b/cpu/lpc2387/include/cpu.h index 55d8f6ffefcb..acc85673f0ee 100644 --- a/cpu/lpc2387/include/cpu.h +++ b/cpu/lpc2387/include/cpu.h @@ -14,9 +14,9 @@ See the file LICENSE in the top level directory for more details. #define __CPU_H /** - * @defgroup lpc2387 NXP LPC2387 - * @ingroup cpu - * @brief NXP LPC2387 specific code + * @defgroup lpc2387 NXP LPC2387 + * @ingroup cpu + * @brief NXP LPC2387 specific code * @{ */ @@ -24,7 +24,7 @@ See the file LICENSE in the top level directory for more details. #include "lpc2387.h" #include "arm_cpu.h" -extern uintptr_t __stack_start; ///< end of user stack memory space +extern uintptr_t __stack_start; ///< end of user stack memory space void lpc2387_pclk_scale(uint32_t source, uint32_t target, uint32_t *pclksel, uint32_t *prescale); bool install_irq(int IntNumber, void (*HandlerAddr)(void), int Priority); diff --git a/cpu/lpc_common/doc.txt b/cpu/lpc_common/doc.txt index f0cae381845f..ed2a6b60c47b 100644 --- a/cpu/lpc_common/doc.txt +++ b/cpu/lpc_common/doc.txt @@ -7,7 +7,7 @@ */ /** - * @defgroup lpc_common LPC common - * @brief Common code for all arm-based LPC controllers - * @ingroup cpu + * @defgroup lpc_common LPC common + * @brief Common code for all arm-based LPC controllers + * @ingroup cpu */ diff --git a/cpu/mc1322x/include/cpu.h b/cpu/mc1322x/include/cpu.h index 7ba2c7980b2c..f37db452d5b9 100644 --- a/cpu/mc1322x/include/cpu.h +++ b/cpu/mc1322x/include/cpu.h @@ -7,9 +7,9 @@ */ /** - * @defgroup mc1322x Freescale MC1322x - * @ingroup cpu - * @brief Freescale MC1322x specific code + * @defgroup mc1322x Freescale MC1322x + * @ingroup cpu + * @brief Freescale MC1322x specific code */ #ifndef CPU_H @@ -19,6 +19,6 @@ #include "arm_cpu.h" #include "mc1322x.h" -extern uintptr_t __stack_start; ///< end of user stack memory space +extern uintptr_t __stack_start; ///< end of user stack memory space #endif /* CPU_H */ diff --git a/cpu/msp430-common/include/cpu.h b/cpu/msp430-common/include/cpu.h index 562de619e4ef..2c2aac0e9dcd 100644 --- a/cpu/msp430-common/include/cpu.h +++ b/cpu/msp430-common/include/cpu.h @@ -14,12 +14,12 @@ See the file LICENSE in the top level directory for more details. #define _CPU_H /** - * @defgroup msp430 TI MSP430 - * @ingroup cpu - * @brief Texas Instruments MSP430 specific code + * @defgroup msp430 TI MSP430 + * @ingroup cpu + * @brief Texas Instruments MSP430 specific code

First steps

-\li See the manual for toolchain and ide setup +\li See the manual for toolchain and ide setup * @{ */ @@ -34,7 +34,7 @@ See the file LICENSE in the top level directory for more details. /* CPU speed */ #define F_CPU (2457600ul) -#define F_RC_OSCILLATOR (32768) ///< Frequency of internal RC oscillator +#define F_RC_OSCILLATOR (32768) ///< Frequency of internal RC oscillator extern volatile int __inISR; extern char __isr_stack[MSP430_ISR_STACK_SIZE]; @@ -132,4 +132,3 @@ void msp430_cpu_init(void); /** @} */ #endif // _CPU_H - diff --git a/cpu/native/include/cpu.h b/cpu/native/include/cpu.h index 60e2f3c0fee0..c0bb9069fd06 100644 --- a/cpu/native/include/cpu.h +++ b/cpu/native/include/cpu.h @@ -13,8 +13,8 @@ /** * @ingroup arch * @defgroup native_cpu Native CPU - * @ingroup cpu - * @brief CPU abstraction for the native port + * @ingroup cpu + * @brief CPU abstraction for the native port * @{ * @author Ludwig Ortmann */ diff --git a/cpu/native/include/nativenet.h b/cpu/native/include/nativenet.h index 9e5a75b3b18b..963bf1f0d6f6 100644 --- a/cpu/native/include/nativenet.h +++ b/cpu/native/include/nativenet.h @@ -16,8 +16,8 @@ */ /** - * @defgroup native_net - * @ingroup native_cpu + * @defgroup native_net + * @ingroup native_cpu * @{ * @author Ludwig Ortmann */ diff --git a/drivers/cc110x/cc1100.h b/drivers/cc110x/cc1100.h index 3b7975233b25..265127f839b5 100644 --- a/drivers/cc110x/cc1100.h +++ b/drivers/cc110x/cc1100.h @@ -1,8 +1,8 @@ -/****************************************************************************** +/* * Copyright 2008, Freie Universitaet Berlin (FUB). All rights reserved. * * These sources were developed at the Freie Universitaet Berlin, Computer Systems -and Telematics group (http://cst.mi.fu-berlin.de). + * and Telematics group (http://cst.mi.fu-berlin.de). * ---------------------------------------------------------------------------- * This file is part of RIOT. * @@ -13,27 +13,21 @@ and Telematics group (http://cst.mi.fu-berlin.de). *******************************************************************************/ /** - * @defgroup drivers_cc110x CC110x - * @ingroup drivers - * @brief Texas Instruments CC110x driver + * @defgroup drivers_cc110x CC110x + * @ingroup drivers + * @brief Texas Instruments CC110x driver * *

Quick links

- * \li \ref cc1100_packet_layer0_t MAC packet format + * \li \ref cc1100_packet_layer0_t MAC packet format * - *
* @{ - */ - -/** + * * @file - * @brief TI Chipcon CC110x radio driver + * @brief TI Chipcon CC110x radio driver * * @author Freie Universität Berlin, Computer Systems & Telematics - * @author Thomas Hillebrandt - * @author Heiko Will - * @version $Revision: 2128 $ - * - * @note $Id: cc1100.h 2128 2010-05-12 12:07:59Z hillebra $ + * @author Thomas Hillebrandt + * @author Heiko Will */ #ifndef CC1100_H @@ -43,17 +37,17 @@ and Telematics group (http://cst.mi.fu-berlin.de). #include "cc1100-interface.h" /** - * @name Defines used as state values for state machine + * @name Defines used as state values for state machine * @{ */ -#define RADIO_UNKNOWN (0) -#define RADIO_AIR_FREE_WAITING (1) -#define RADIO_WOR (2) -#define RADIO_IDLE (3) -#define RADIO_SEND_BURST (4) -#define RADIO_RX (5) -#define RADIO_SEND_ACK (6) -#define RADIO_PWD (7) +#define RADIO_UNKNOWN (0) +#define RADIO_AIR_FREE_WAITING (1) +#define RADIO_WOR (2) +#define RADIO_IDLE (3) +#define RADIO_SEND_BURST (4) +#define RADIO_RX (5) +#define RADIO_SEND_ACK (6) +#define RADIO_PWD (7) /** @} */ @@ -102,73 +96,73 @@ typedef struct cc1100_reg { /** CC1100 radio configuration */ typedef struct cc1100_cfg_t { - cc1100_reg_t reg_cfg; ///< CC1100 register configuration - uint8_t pa_power; ///< Output power setting + cc1100_reg_t reg_cfg; ///< CC1100 register configuration + uint8_t pa_power; ///< Output power setting } cc1100_cfg_t; /** - * @brief Radio Control Flags + * @brief Radio Control Flags */ typedef struct cc1100_flags { - uint32_t TOF; ///< Time of flight of the last packet and last ACK - uint32_t TCP; ///< Time to compute packet - unsigned RPS : 16; ///< Raw packets sent to transmit last packet - unsigned RETC : 8; ///< Retransmission count of last send packet - unsigned RSSI : 8; ///< The RSSI value of last received packet - unsigned RSSI_SEND : 8; ///< The RSSI value of the last send unicast packet of this node - unsigned LQI : 8; ///< The LQI value of the last received packet - unsigned LL_ACK : 1; ///< Is set if Link-Level ACK is received, otherwise 0 (reset on new burst) - unsigned CAA : 1; ///< The status of the air (1 = air free, 0 = air not free) - unsigned CRC_STATE : 1; ///< The CRC status of last received packet (1 = OK, 0 = not OK) - unsigned SEQ : 1; ///< Sequence number (toggles between 0 and 1) - unsigned MAN_WOR : 1; ///< Manual WOR set (for randomized WOR times => no synch) - unsigned KT_RES_ERR : 1; ///< A hwtimer resource error has occurred (no free timers available) - unsigned TX : 1; ///< State machine TX lock, only ACKs will be received - unsigned WOR_RST : 1; ///< Reset CC1100 real time clock (WOR) on next WOR strobe + uint32_t TOF; ///< Time of flight of the last packet and last ACK + uint32_t TCP; ///< Time to compute packet + unsigned RPS : 16; ///< Raw packets sent to transmit last packet + unsigned RETC : 8; ///< Retransmission count of last send packet + unsigned RSSI : 8; ///< The RSSI value of last received packet + unsigned RSSI_SEND : 8; ///< The RSSI value of the last send unicast packet of this node + unsigned LQI : 8; ///< The LQI value of the last received packet + unsigned LL_ACK : 1; ///< Is set if Link-Level ACK is received, otherwise 0 (reset on new burst) + unsigned CAA : 1; ///< The status of the air (1 = air free, 0 = air not free) + unsigned CRC_STATE : 1; ///< The CRC status of last received packet (1 = OK, 0 = not OK) + unsigned SEQ : 1; ///< Sequence number (toggles between 0 and 1) + unsigned MAN_WOR : 1; ///< Manual WOR set (for randomized WOR times => no synch) + unsigned KT_RES_ERR : 1; ///< A hwtimer resource error has occurred (no free timers available) + unsigned TX : 1; ///< State machine TX lock, only ACKs will be received + unsigned WOR_RST : 1; ///< Reset CC1100 real time clock (WOR) on next WOR strobe } cc1100_flags; /** - * @brief Statistic interface for debugging + * @brief Statistic interface for debugging */ typedef struct cc1100_statistic { - uint32_t packets_in; - uint32_t packets_in_crc_fail; - uint32_t packets_in_while_tx; - uint32_t packets_in_dups; - uint32_t packets_in_up; - uint32_t packets_out; - uint32_t packets_out_acked; - uint32_t packets_out_broadcast; - uint32_t raw_packets_out; - uint32_t raw_packets_out_acked; - uint32_t acks_send; - uint32_t rx_buffer_max; - uint32_t watch_dog_resets; + uint32_t packets_in; + uint32_t packets_in_crc_fail; + uint32_t packets_in_while_tx; + uint32_t packets_in_dups; + uint32_t packets_in_up; + uint32_t packets_out; + uint32_t packets_out_acked; + uint32_t packets_out_broadcast; + uint32_t raw_packets_out; + uint32_t raw_packets_out_acked; + uint32_t acks_send; + uint32_t rx_buffer_max; + uint32_t watch_dog_resets; } cc1100_statistic_t; enum radio_mode { - RADIO_MODE_GET = -1, ///< leave mode unchanged - RADIO_MODE_OFF = 0, ///< turn radio off - RADIO_MODE_ON = 1 ///< turn radio on + RADIO_MODE_GET = -1, ///< leave mode unchanged + RADIO_MODE_OFF = 0, ///< turn radio off + RADIO_MODE_ON = 1 ///< turn radio on }; enum radio_result { - RADIO_PAYLOAD_TOO_LONG = -1, ///< payload too long - RADIO_WRONG_MODE = -2, ///< operation not supported in current mode - RADIO_ADDR_OUT_OF_RANGE = -3, ///< address out of range - RADIO_OP_FAILED = -4, ///< operation failed - RADIO_CS_TIMEOUT = -5, ///< Carrier Sense timeout: air was never free - RADIO_INVALID_PARAM = -6 ///< Invalid parameters passed to radio + RADIO_PAYLOAD_TOO_LONG = -1, ///< payload too long + RADIO_WRONG_MODE = -2, ///< operation not supported in current mode + RADIO_ADDR_OUT_OF_RANGE = -3, ///< address out of range + RADIO_OP_FAILED = -4, ///< operation failed + RADIO_CS_TIMEOUT = -5, ///< Carrier Sense timeout: air was never free + RADIO_INVALID_PARAM = -6 ///< Invalid parameters passed to radio }; /* ------------------------------------------------------------------------- */ -// Variable declarations (also used in other files) +// Variable declarations (also used in other files) /* ------------------------------------------------------------------------- */ -extern volatile cc1100_flags rflags; ///< Radio flags +extern volatile cc1100_flags rflags; ///< Radio flags -extern volatile uint8_t radio_mode; ///< Radio mode -extern volatile uint8_t radio_state; ///< Radio state +extern volatile uint8_t radio_mode; ///< Radio mode +extern volatile uint8_t radio_state; ///< Radio state /** Mode callback functions */ typedef void (*cc1100_mode_callback_t)(void); @@ -177,85 +171,85 @@ extern volatile cc1100_mode_callback_t cc1100_go_receive; extern volatile cc1100_mode_callback_t cc1100_go_after_tx; extern volatile cc1100_mode_callback_t cc1100_setup_mode; -extern volatile int wor_hwtimer_id; ///< WOR hwtimer identifier +extern volatile int wor_hwtimer_id; ///< WOR hwtimer identifier /* ------------------------------------------------------------------------- */ -// CC1100 radio driver API +// CC1100 radio driver API /* ------------------------------------------------------------------------- */ /** - * @brief Set chip and state machine to IDLE mode. + * @brief Set chip and state machine to IDLE mode. */ void cc1100_set_idle(void); /** - * @brief Convert radio mode to textual representation. + * @brief Convert radio mode to textual representation. * - * @param mode The radio mode to convert. + * @param mode The radio mode to convert. * - * @return Textual representation of radio mode. + * @return Textual representation of radio mode. */ char *cc1100_mode_to_text(uint8_t mode); /** - * @brief Convert radio state to textual representation. + * @brief Convert radio state to textual representation. * - * @param mode The radio state to convert. + * @param mode The radio state to convert. * - * @return Textual representation of radio state. + * @return Textual representation of radio state. */ char *cc1100_state_to_text(uint8_t state); /** - * @brief Convert current output power to textual representation. + * @brief Convert current output power to textual representation. * - * @return Textual representation of current output power in dBm. + * @return Textual representation of current output power in dBm. */ char *cc1100_get_output_power(char *buf); /** - * @brief Read out main radio control FSM state. + * @brief Read out main radio control FSM state. * - * @return Textual representation of current main radio control FSM state. + * @return Textual representation of current main radio control FSM state. */ char *cc1100_get_marc_state(void); /** - * @brief hwtimer wrapper function. + * @brief hwtimer wrapper function. * * This wrapper function puts the radio to receive mode. * - * @param ptr Optional data (only to match hwtimer interface). + * @param ptr Optional data (only to match hwtimer interface). */ void cc1100_hwtimer_go_receive_wrapper(void *ptr); /** - * @brief GDO0 interrupt handler. + * @brief GDO0 interrupt handler. */ void cc1100_gdo0_irq(void); /** - * @brief GDO2 interrupt handler. + * @brief GDO2 interrupt handler. * - * @note Wakes up MCU on packet reception. + * @note Wakes up MCU on packet reception. */ void cc1100_gdo2_irq(void); /** - * @brief Transfer packet from CC1100 RX FIFO. + * @brief Transfer packet from CC1100 RX FIFO. * * Transfers a packet from CC1100 RX FIFO into a buffer. * - * @param rxBuffer The buffer in which to transfer the packet. - * @param length The size of the buffer in which to transfer the packet. + * @param rxBuffer The buffer in which to transfer the packet. + * @param length The size of the buffer in which to transfer the packet. * - * @return true if operation succeeded; false otherwise (e.g. no data + * @return true if operation succeeded; false otherwise (e.g. no data * available, buffer to small or CRC check failed). */ bool cc1100_spi_receive_packet(uint8_t *rxBuffer, uint8_t length); /** - * @brief Sends raw data. + * @brief Sends raw data. * * Sends the data of the given buffer. The first two bytes of the * buffer must match the CC1100 packet format (so address interpretation @@ -264,8 +258,8 @@ bool cc1100_spi_receive_packet(uint8_t *rxBuffer, uint8_t length); * This function is not mode safe!The radio must be woke up before * sending and has to be put back manually to receive mode. * - * @param tx_buffer Data source buffer. - * @param size The size of the data source buffer (maximum: 62 bytes). + * @param tx_buffer Data source buffer. + * @param size The size of the data source buffer (maximum: 62 bytes). */ void cc1100_send_raw(uint8_t *tx_buffer, uint8_t size); @@ -275,62 +269,61 @@ void cc1100_send_raw(uint8_t *tx_buffer, uint8_t size); */ /** - * @brief Initialize radio for carrier sense detection. + * @brief Initialize radio for carrier sense detection. */ void cc1100_cs_init(void); /** - * @brief Enable or disable carrier sense detections. + * @brief Enable or disable carrier sense detections. * * Turns interrupts for carrier sense on or off. * - * @param enabled true if carrier sense detection should + * @param enabled true if carrier sense detection should * be enabled; false otherwise. */ void cc1100_cs_set_enabled(bool enabled); /** - * @brief Read carrier sense signal. + * @brief Read carrier sense signal. * - * @return High (1) if air is not free; low (0) if air is + * @return High (1) if air is not free; low (0) if air is * currently free. */ int cc1100_cs_read(void); /** - * @brief Reads the CCA (Clear Channel Assessment) flag. + * @brief Reads the CCA (Clear Channel Assessment) flag. * * The CCA flag is set by an interrupt service routine, after * carrier sense detection is enabled. So the status of the * carrier sense signal can be evaluated in a non blocking * manner. * - * @return The current value of the CCA flag (High: air is free, - * low: air is not free). + * @return The current value of the CCA flag (High: air is free, + * low: air is not free). */ int cc1100_cs_read_cca(void); /** - * @brief Sets the CCA flag. + * @brief Sets the CCA flag. * - * @param cca The new value for the CCA flag. + * @param cca The new value for the CCA flag. */ void cc1100_cs_write_cca(const int cca); /** @} */ /** - * @name Statistic interface + * @name Statistic interface * @{ */ /** - * @brief Reset radio statistics. + * @brief Reset radio statistics. */ void cc1100_reset_statistic(void); /** @} */ /** @} */ - #endif diff --git a/drivers/cc110x_ng/cc110x-defaultSettings.c b/drivers/cc110x_ng/cc110x-defaultSettings.c index a5dc73a846a4..98ae2fa3f001 100644 --- a/drivers/cc110x_ng/cc110x-defaultSettings.c +++ b/drivers/cc110x_ng/cc110x-defaultSettings.c @@ -1,6 +1,4 @@ -/** - * Default configuration for the cc110x chip - * +/* * Copyright (C) 2013 INRIA * * This file is subject to the terms and conditions of the GNU Lesser General @@ -9,19 +7,17 @@ */ /** - * @ingroup drivers_cc110x_ng + * @ingroup drivers_cc110x_ng * @{ * * @file - * @brief TI Chipcon CC110x default settings + * @brief TI Chipcon CC110x default settings * * @author Freie Universität Berlin, Computer Systems & Telematics * @author INRIA - * @author Thomas Hillebrandt - * @author Heiko Will + * @author Thomas Hillebrandt + * @author Heiko Will * @author Oliver Hahm - * - * @note $Id: cc110x-defaultSettings.c 2058 2010-03-31 08:59:31Z hillebra $ * @} */ @@ -35,7 +31,7 @@ * ----------------------------------------- * 0 | 0 | 869.525 * 1 | 10 | 871.61 - * 2 | 20 | 873.58 ~ seems to be bad (hang-ups with this channel) + * 2 | 20 | 873.58 ~ seems to be bad (hang-ups with this channel) * 3 | 30 | 875.61 * 4 | 40 | 877.58 * 5 | 50 | 879.61 @@ -68,9 +64,9 @@ char cc110x_conf[] = { 0x0F, // FIFOTHR 0x9B, // SYNC1 0xAD, // SYNC0 - 0x3D, // PKTLEN (maximum value of packet length byte = 61) + 0x3D, // PKTLEN (maximum value of packet length byte = 61) 0x06, // PKTCTRL1 - 0x45, // PKTCTRL0 (variable packet length) + 0x45, // PKTCTRL0 (variable packet length) 0xFF, // ADDR CC1100_DEFAULT_CHANNR * 10, // CHANNR 0x0B, // FSCTRL1 @@ -105,18 +101,18 @@ char cc110x_conf[] = { 0x00 // padding to 4 bytes }; -uint8_t pa_table_index = PATABLE; ///< Current PATABLE Index -uint8_t pa_table[] = { ///< PATABLE with available output powers - 0x00, ///< -52 dBm - 0x03, ///< -30 dBm - 0x0D, ///< -20 dBm - 0x1C, ///< -15 dBm - 0x34, ///< -10 dBm - 0x57, ///< - 5 dBm - 0x3F, ///< - 1 dBm - 0x8E, ///< 0 dBm - 0x85, ///< + 5 dBm - 0xCC, ///< + 7 dBm - 0xC6, ///< + 9 dBm - 0xC3 ///< +10 dBm +uint8_t pa_table_index = PATABLE; ///< Current PATABLE Index +uint8_t pa_table[] = { ///< PATABLE with available output powers + 0x00, ///< -52 dBm + 0x03, ///< -30 dBm + 0x0D, ///< -20 dBm + 0x1C, ///< -15 dBm + 0x34, ///< -10 dBm + 0x57, ///< - 5 dBm + 0x3F, ///< - 1 dBm + 0x8E, ///< 0 dBm + 0x85, ///< + 5 dBm + 0xCC, ///< + 7 dBm + 0xC6, ///< + 9 dBm + 0xC3 ///< +10 dBm }; // If PATABLE is changed in size, adjust MAX_OUTPUT_POWER definition in CC1100 interface! diff --git a/drivers/cc110x_ng/cc110x-rx.c b/drivers/cc110x_ng/cc110x-rx.c index 0492ca9bc41f..ed00c10f5058 100644 --- a/drivers/cc110x_ng/cc110x-rx.c +++ b/drivers/cc110x_ng/cc110x-rx.c @@ -8,13 +8,15 @@ */ /** - * @ingroup drivers_cc110x_ng + * @ingroup drivers_cc110x_ng * @{ - * @file cc110x-rx.c - * @brief Functions for packet reception on cc110x - * @author Oliver Hahm + * @file cc110x-rx.c + * @brief Functions for packet reception on cc110x + * + * @author Oliver Hahm * @} */ + #include #include #include @@ -41,8 +43,8 @@ static uint8_t is_ignored(radio_address_t addr); static uint8_t receive_packet_variable(uint8_t *rxBuffer, uint8_t length); static uint8_t receive_packet(uint8_t *rxBuffer, uint8_t length); -rx_buffer_t cc110x_rx_buffer[RX_BUF_SIZE]; ///< RX buffer -volatile uint8_t rx_buffer_next; ///< Next packet in RX queue +rx_buffer_t cc110x_rx_buffer[RX_BUF_SIZE]; ///< RX buffer +volatile uint8_t rx_buffer_next; ///< Next packet in RX queue void cc110x_rx_handler(void) { @@ -66,13 +68,13 @@ void cc110x_rx_handler(void) cc110x_rx_buffer[rx_buffer_next].rssi = rflags._RSSI; cc110x_rx_buffer[rx_buffer_next].lqi = rflags._LQI; - cc110x_strobe(CC1100_SFRX); /* ...for flushing the RX FIFO */ + cc110x_strobe(CC1100_SFRX); /* ...for flushing the RX FIFO */ /* Valid packet. After a wake-up, the radio should be in IDLE. * So put CC1100 to RX for WOR_TIMEOUT (have to manually put * the radio back to sleep/WOR). */ - //cc110x_spi_write_reg(CC1100_MCSM0, 0x08); /* Turn off FS-Autocal */ - cc110x_write_reg(CC1100_MCSM2, 0x07); /* Configure RX_TIME (until end of packet) */ + //cc110x_spi_write_reg(CC1100_MCSM0, 0x08); /* Turn off FS-Autocal */ + cc110x_write_reg(CC1100_MCSM2, 0x07); /* Configure RX_TIME (until end of packet) */ cc110x_strobe(CC1100_SRX); hwtimer_wait(IDLE_TO_RX_TIME); radio_state = RADIO_RX; @@ -106,8 +108,8 @@ void cc110x_rx_handler(void) rflags.TOF = 0; /* CRC false or RX buffer full -> clear RX FIFO in both cases */ - cc110x_strobe(CC1100_SIDLE); /* Switch to IDLE (should already be)... */ - cc110x_strobe(CC1100_SFRX); /* ...for flushing the RX FIFO */ + cc110x_strobe(CC1100_SIDLE); /* Switch to IDLE (should already be)... */ + cc110x_strobe(CC1100_SFRX); /* ...for flushing the RX FIFO */ /* If packet interrupted this nodes send call, * don't change anything after this point. */ diff --git a/drivers/cc110x_ng/cc110x-tx.c b/drivers/cc110x_ng/cc110x-tx.c index 62c1e68cced5..792c73bc5181 100644 --- a/drivers/cc110x_ng/cc110x-tx.c +++ b/drivers/cc110x_ng/cc110x-tx.c @@ -8,11 +8,12 @@ */ /** - * @ingroup drivers_cc110x_ng + * @ingroup drivers_cc110x_ng * @{ - * @file cc110x-tx.c - * @brief Functions for packet transmission on cc110x - * @author Oliver Hahm + * @file cc110x-tx.c + * @brief Functions for packet transmission on cc110x + * + * @author Oliver Hahm * @} */ #include diff --git a/drivers/cc110x_ng/cc110x.c b/drivers/cc110x_ng/cc110x.c index bf7e14964136..717e1c9a59c7 100644 --- a/drivers/cc110x_ng/cc110x.c +++ b/drivers/cc110x_ng/cc110x.c @@ -8,12 +8,12 @@ */ /** - * @ingroup drivers_cc110x_ng + * @ingroup drivers_cc110x_ng * @{ + * @file cc110x.c + * @brief Basic functionality of cc110x driver * - * @file cc110x.c - * @brief Basic functionality of cc110x driver - * @author Oliver Hahm + * @author Oliver Hahm * @} */ #include @@ -32,15 +32,15 @@ #include /* some externals */ -extern uint8_t pa_table[]; ///< PATABLE with available output powers +extern uint8_t pa_table[]; ///< PATABLE with available output powers extern uint8_t pa_table_index; ///< Current PATABLE Index /* global variables */ cc110x_statistic_t cc110x_statistic; -volatile cc110x_flags rflags; ///< Radio control flags -volatile uint8_t radio_state = RADIO_UNKNOWN; ///< Radio state +volatile cc110x_flags rflags; ///< Radio control flags +volatile uint8_t radio_state = RADIO_UNKNOWN; ///< Radio state static radio_address_t radio_address; ///< Radio address static uint8_t radio_channel; ///< Radio channel @@ -54,7 +54,7 @@ static void power_up_reset(void); static void write_register(uint8_t r, uint8_t value); /*---------------------------------------------------------------------------* - * Radio Driver API * + * Radio Driver API * *---------------------------------------------------------------------------*/ void cc110x_init(int tpid) { @@ -353,7 +353,7 @@ int16_t cc110x_get_channel(void) /*--------------------------------------------------------------------------- - * CC1100 reset functionality + * CC1100 reset functionality *---------------------------------------------------------------------------*/ static void reset(void) @@ -409,13 +409,13 @@ static int rd_set_mode(int mode) switch(mode) { case RADIO_MODE_ON: DEBUG("Enabling rx mode\n"); - cc110x_init_interrupts(); /* Enable interrupts */ - cc110x_setup_rx_mode(); /* Set chip to desired mode */ + cc110x_init_interrupts(); /* Enable interrupts */ + cc110x_setup_rx_mode(); /* Set chip to desired mode */ break; case RADIO_MODE_OFF: - cc110x_disable_interrupts(); /* Disable interrupts */ - cc110x_switch_to_pwd(); /* Set chip to power down mode */ + cc110x_disable_interrupts(); /* Disable interrupts */ + cc110x_switch_to_pwd(); /* Set chip to power down mode */ break; case RADIO_MODE_GET: diff --git a/drivers/cc110x_ng/include/cc110x-arch.h b/drivers/cc110x_ng/include/cc110x-arch.h index 62865999a37a..e32417bad035 100644 --- a/drivers/cc110x_ng/include/cc110x-arch.h +++ b/drivers/cc110x_ng/include/cc110x-arch.h @@ -1,8 +1,8 @@ -/****************************************************************************** +/* * Copyright 2008, Freie Universitaet Berlin (FUB). All rights reserved. * * These sources were developed at the Freie Universitaet Berlin, Computer Systems -and Telematics group (http://cst.mi.fu-berlin.de). + * and Telematics group (http://cst.mi.fu-berlin.de). * ---------------------------------------------------------------------------- * This file is part of RIOT. * @@ -13,18 +13,16 @@ and Telematics group (http://cst.mi.fu-berlin.de). *******************************************************************************/ /** - * @ingroup drivers_cc110x_ng + * @ingroup drivers_cc110x_ng * @{ * - * @file cc110x-arch.h - * @brief CC1100 architecture dependent functions + * @file cc110x-arch.h + * @brief CC1100 architecture dependent functions * * @author Freie Universität Berlin, Computer Systems & Telematics - * @author Heiko Will - * @version $Revision: 1775 $ - * - * @note $Id: arch_cc110x.h 1775 2010-01-26 09:37:03Z hillebra $ + * @author Heiko Will */ + #ifndef __CC1100_ARCH_H #define __CC1100_ARCH_H diff --git a/drivers/cc110x_ng/include/cc110x-config.h b/drivers/cc110x_ng/include/cc110x-config.h index ddd53f839c97..a054f1c3c6fa 100644 --- a/drivers/cc110x_ng/include/cc110x-config.h +++ b/drivers/cc110x_ng/include/cc110x-config.h @@ -1,18 +1,20 @@ -/** - * Configuration parameters for the cc110x radio chip - * +/* * Copyright (C) 2009 Freie Universität Berlin * Copyright (C) 2013 INRIA * * This file is 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. - * - * @ingroup drivers_cc110x_ng + */ + +/** + * @ingroup drivers_cc110x_ng * @{ * - * @file cc110x-config.h - * @author Oliver Hahm + * @file cc110x-config.h + * @brief Configuration parameters for the cc110x radio chip + * + * @author Oliver Hahm */ #ifndef CC1100_CONFIG_H #define CC1100_CONFIG_H @@ -65,47 +67,47 @@ typedef struct { /** CC1100 radio configuration */ typedef struct { - cc110x_reg_t reg_cfg; ///< CC1100 register configuration - uint8_t pa_power; ///< Output power setting + cc110x_reg_t reg_cfg; ///< CC1100 register configuration + uint8_t pa_power; ///< Output power setting } cc110x_cfg_t; /** - * @brief Radio Control Flags + * @brief Radio Control Flags */ typedef struct { - uint32_t TOF; ///< Time of flight of the last packet and last ACK + uint32_t TOF; ///< Time of flight of the last packet and last ACK timex_t TOA; ///< Time of packet arriveal - uint32_t TCP; ///< Time to compute packet - unsigned RPS : 16; ///< Raw packets sent to transmit last packet - unsigned RETC : 8; ///< Retransmission count of last send packet - unsigned _RSSI : 8; ///< The RSSI value of last received packet - unsigned RSSI_SEND : 8; ///< The RSSI value of the last send unicast packet of this node - unsigned _LQI : 8; ///< The LQI value of the last received packet - unsigned LL_ACK : 1; ///< Is set if Link-Level ACK is received, otherwise 0 (reset on new burst) - unsigned CAA : 1; ///< The status of the air (1 = air free, 0 = air not free) - unsigned CRC_STATE : 1; ///< The CRC status of last received packet (1 = OK, 0 = not OK) - unsigned SEQ : 1; ///< Sequence number (toggles between 0 and 1) - unsigned MAN_WOR : 1; ///< Manual WOR set (for randomized WOR times => no synch) - unsigned KT_RES_ERR : 1; ///< A hwtimer resource error has occurred (no free timers available) - unsigned TX : 1; ///< State machine TX lock, only ACKs will be received - unsigned WOR_RST : 1; ///< Reset CC1100 real time clock (WOR) on next WOR strobe + uint32_t TCP; ///< Time to compute packet + unsigned RPS : 16; ///< Raw packets sent to transmit last packet + unsigned RETC : 8; ///< Retransmission count of last send packet + unsigned _RSSI : 8; ///< The RSSI value of last received packet + unsigned RSSI_SEND : 8; ///< The RSSI value of the last send unicast packet of this node + unsigned _LQI : 8; ///< The LQI value of the last received packet + unsigned LL_ACK : 1; ///< Is set if Link-Level ACK is received, otherwise 0 (reset on new burst) + unsigned CAA : 1; ///< The status of the air (1 = air free, 0 = air not free) + unsigned CRC_STATE : 1; ///< The CRC status of last received packet (1 = OK, 0 = not OK) + unsigned SEQ : 1; ///< Sequence number (toggles between 0 and 1) + unsigned MAN_WOR : 1; ///< Manual WOR set (for randomized WOR times => no synch) + unsigned KT_RES_ERR : 1; ///< A hwtimer resource error has occurred (no free timers available) + unsigned TX : 1; ///< State machine TX lock, only ACKs will be received + unsigned WOR_RST : 1; ///< Reset CC1100 real time clock (WOR) on next WOR strobe } cc110x_flags; /** - * @brief Statistic interface for debugging + * @brief Statistic interface for debugging */ typedef struct cc110x_statistic { - uint32_t packets_in; - uint32_t packets_in_crc_fail; - uint32_t packets_in_while_tx; - uint32_t packets_in_dups; - uint32_t packets_in_up; - uint32_t packets_out; - uint32_t packets_out_broadcast; - uint32_t raw_packets_out; - uint32_t acks_send; - uint32_t rx_buffer_max; - uint32_t watch_dog_resets; + uint32_t packets_in; + uint32_t packets_in_crc_fail; + uint32_t packets_in_while_tx; + uint32_t packets_in_dups; + uint32_t packets_in_up; + uint32_t packets_out; + uint32_t packets_out_broadcast; + uint32_t raw_packets_out; + uint32_t acks_send; + uint32_t rx_buffer_max; + uint32_t watch_dog_resets; } cc110x_statistic_t; /** @} */ diff --git a/drivers/cc110x_ng/include/cc110x-defaultSettings.h b/drivers/cc110x_ng/include/cc110x-defaultSettings.h index 37057830d425..7c08835f5232 100644 --- a/drivers/cc110x_ng/include/cc110x-defaultSettings.h +++ b/drivers/cc110x_ng/include/cc110x-defaultSettings.h @@ -16,20 +16,15 @@ and Telematics group (http://cst.mi.fu-berlin.de). #define __CC1100_DEFAULTSETTINGS_H /** - * @ingroup drivers_cc110x_ng + * @ingroup drivers_cc110x_ng * @{ - */ - -/** + * * @file - * @brief TI Chipcon CC110x default settings + * @brief TI Chipcon CC110x default settings * * @author Freie Universität Berlin, Computer Systems & Telematics - * @author Thomas Hillebrandt - * @author Heiko Will - * @version $Revision: 2139 $ - * - * @note $Id: cc110x-defaultSettings.h 2139 2010-05-26 08:04:04Z hillebra $ + * @author Thomas Hillebrandt + * @author Heiko Will */ #include @@ -37,61 +32,61 @@ and Telematics group (http://cst.mi.fu-berlin.de). // returns hwtimer ticks per us #define RTIMER_TICKS(us) HWTIMER_TICKS(us) -#define TIMER_TICK_USEC_RES (122) +#define TIMER_TICK_USEC_RES (122) // Default PA table index (output power) -#define PATABLE (11) +#define PATABLE (11) // Watchdog cycle time in seconds, set 0 to disable watchdog -#define CC1100_WATCHDOG_PERIOD (5) +#define CC1100_WATCHDOG_PERIOD (5) // Number of transmission retries for unicast packets (constant RX mode) -#define TRANSMISSION_RETRIES_CRX_UC (5) +#define TRANSMISSION_RETRIES_CRX_UC (5) // Number of transmission retries for unicast packets (WOR mode) -#define TRANSMISSION_RETRIES_WOR_UC (1) +#define TRANSMISSION_RETRIES_WOR_UC (1) // Number of transmission retries for broadcast packets (constant RX mode) -#define TRANSMISSION_RETRIES_CRX_BC (0) +#define TRANSMISSION_RETRIES_CRX_BC (0) // Number of transmission retries for broadcast packets (WOR mode) -#define TRANSMISSION_RETRIES_WOR_BC (0) +#define TRANSMISSION_RETRIES_WOR_BC (0) // Time before chip goes back to RX (= stays in PWD after incoming packet) -#define WOR_TIMEOUT_1 (3200) // ~ 32 milliseconds +#define WOR_TIMEOUT_1 (3200) // ~ 32 milliseconds // Time before chip goes back to WOR (= stays in RX after elapsed WOR_TIMEOUT_1) -#define WOR_TIMEOUT_2 (800) // ~ 8 milliseconds +#define WOR_TIMEOUT_2 (800) // ~ 8 milliseconds // XOSC startup + FS calibration (300 + 809 us ~ 1.38 ms) -#define FS_CAL_TIME RTIMER_TICKS(12 * TIMER_TICK_USEC_RES) +#define FS_CAL_TIME RTIMER_TICKS(12 * TIMER_TICK_USEC_RES) // Manual FS calibration (721 us) -#define MANUAL_FS_CAL_TIME RTIMER_TICKS(7 * TIMER_TICK_USEC_RES) +#define MANUAL_FS_CAL_TIME RTIMER_TICKS(7 * TIMER_TICK_USEC_RES) // Reset wait time (in reset procedure) -#define RESET_WAIT_TIME RTIMER_TICKS(4 * TIMER_TICK_USEC_RES) +#define RESET_WAIT_TIME RTIMER_TICKS(4 * TIMER_TICK_USEC_RES) // Time chip needs to go to RX -#define IDLE_TO_RX_TIME RTIMER_TICKS(1 * TIMER_TICK_USEC_RES) +#define IDLE_TO_RX_TIME RTIMER_TICKS(1 * TIMER_TICK_USEC_RES) // Time chip needs to go to RX and CS signal is ready -#define CS_READY_TIME RTIMER_TICKS(3 * TIMER_TICK_USEC_RES) +#define CS_READY_TIME RTIMER_TICKS(3 * TIMER_TICK_USEC_RES) // Default RX interval for WOR in milliseconds -#define T_RX_INTERVAL (542) +#define T_RX_INTERVAL (542) // Time of packet interval in microseconds (at 400 kbps) -#define T_PACKET_INTERVAL (3800) +#define T_PACKET_INTERVAL (3800) // The size of the configuration array for CC1100 in bytes -#define CC1100_CONF_SIZE (39) +#define CC1100_CONF_SIZE (39) // The default channel number (0-24) for CC1100 -#define CC1100_DEFAULT_CHANNR (0) +#define CC1100_DEFAULT_CHANNR (0) // Burst retry to TX switch time (measured ~ 230 us) -#define BURST_RETRY_TX_SWITCH_TIME (23) +#define BURST_RETRY_TX_SWITCH_TIME (23) /** @} */ diff --git a/drivers/cc110x_ng/include/cc110x-internal.h b/drivers/cc110x_ng/include/cc110x-internal.h index 20a7279270bc..1c3154567686 100644 --- a/drivers/cc110x_ng/include/cc110x-internal.h +++ b/drivers/cc110x_ng/include/cc110x-internal.h @@ -8,32 +8,33 @@ */ /** - * @ingroup drivers_cc110x_ng + * @ingroup drivers_cc110x_ng * @{ * - * @file - * @brief Driver internal constants for 110x chip configuration + * @file cc110x-internal.h + * @brief Driver internal constants for 110x chip configuration * * @author Freie Universität Berlin, Computer Systems & Telematics - * @author Thomas Hillebrandt - * @author Heiko Will - * @author Oliver Hahm + * @author Thomas Hillebrandt + * @author Heiko Will + * @author Oliver Hahm */ + #ifndef CC1100_INTERNAL_H #define CC1100_INTERNAL_H -#define FIXED_PKTLEN (0x00) ///< Fixed length packets, length configured in PKTLEN register. -#define VARIABLE_PKTLEN (0x01) ///< Variable length packets, packet length configured by the first - ///< byte after synch word. +#define FIXED_PKTLEN (0x00) ///< Fixed length packets, length configured in PKTLEN register. +#define VARIABLE_PKTLEN (0x01) ///< Variable length packets, packet length configured by the first + ///< byte after synch word. /** - * @name Bitmasks for reading out status register values + * @name Bitmasks for reading out status register values * @{ */ /** - * @brief Bitmask (=10000000) for reading CRC_OK. + * @brief Bitmask (=10000000) for reading CRC_OK. * * If CRC_OK == 1: CRC for received data OK (or CRC disabled). * If CRC_OK == 0: CRC error in received data. @@ -44,42 +45,42 @@ * * The Link Quality Indicator estimates how easily a received signal can be demodulated. */ -#define LQI_EST (0x7F) -#define I_RSSI (0x00) ///< Index 0 contains RSSI information (from optionally appended packet status bytes). -#define I_LQI (0x01) ///< Index 1 contains LQI & CRC_OK information (from optionally appended packet status bytes). -#define MARC_STATE (0x1F) ///< Bitmask (=00011111) for reading MARC_STATE in MARCSTATE status register. -#define CS (0x40) ///< Bitmask (=01000000) for reading CS (Carrier Sense) in PKTSTATUS status register. -#define PQT_REACHED (0x20) ///< Bitmask (=00100000) for reading PQT_REACHED (Preamble Quality reached) in PKTSTATUS status register. -#define CCA (0x10) ///< Bitmask (=00010000) for reading CCA (clear channel assessment) in PKTSTATUS status register. -#define SFD (0x08) ///< Bitmask (=00001000) for reading SFD (Sync word found) in PKTSTATUS status register. -#define GDO2 (0x04) ///< Bitmask (=00000100) for reading GDO2 (current value on GDO2 pin) in PKTSTATUS status register. -#define GDO1 (0x02) ///< Bitmask (=00000010) for reading GDO1 (current value on GDO1 pin) in PKTSTATUS status register. -#define GDO0 (0x01) ///< Bitmask (=00000001) for reading GDO0 (current value on GDO0 pin) in PKTSTATUS status register. -#define TXFIFO_UNDERFLOW (0x80) ///< Bitmask (=10000000) for reading TXFIFO_UNDERFLOW in TXBYTES status register. -#define BYTES_IN_TXFIFO (0x7F) ///< Bitmask (=01111111) for reading NUM_TXBYTES in TXBYTES status register. -#define RXFIFO_OVERFLOW (0xBF) ///< Bitmask (=10000000) for reading RXFIFO_OVERFLOW in RXBYTES status register. -#define BYTES_IN_RXFIFO (0xFF) ///< Bitmask (=01111111) for reading NUM_RXBYTES in RXBYTES status register. +#define LQI_EST (0x7F) +#define I_RSSI (0x00) ///< Index 0 contains RSSI information (from optionally appended packet status bytes). +#define I_LQI (0x01) ///< Index 1 contains LQI & CRC_OK information (from optionally appended packet status bytes). +#define MARC_STATE (0x1F) ///< Bitmask (=00011111) for reading MARC_STATE in MARCSTATE status register. +#define CS (0x40) ///< Bitmask (=01000000) for reading CS (Carrier Sense) in PKTSTATUS status register. +#define PQT_REACHED (0x20) ///< Bitmask (=00100000) for reading PQT_REACHED (Preamble Quality reached) in PKTSTATUS status register. +#define CCA (0x10) ///< Bitmask (=00010000) for reading CCA (clear channel assessment) in PKTSTATUS status register. +#define SFD (0x08) ///< Bitmask (=00001000) for reading SFD (Sync word found) in PKTSTATUS status register. +#define GDO2 (0x04) ///< Bitmask (=00000100) for reading GDO2 (current value on GDO2 pin) in PKTSTATUS status register. +#define GDO1 (0x02) ///< Bitmask (=00000010) for reading GDO1 (current value on GDO1 pin) in PKTSTATUS status register. +#define GDO0 (0x01) ///< Bitmask (=00000001) for reading GDO0 (current value on GDO0 pin) in PKTSTATUS status register. +#define TXFIFO_UNDERFLOW (0x80) ///< Bitmask (=10000000) for reading TXFIFO_UNDERFLOW in TXBYTES status register. +#define BYTES_IN_TXFIFO (0x7F) ///< Bitmask (=01111111) for reading NUM_TXBYTES in TXBYTES status register. +#define RXFIFO_OVERFLOW (0xBF) ///< Bitmask (=10000000) for reading RXFIFO_OVERFLOW in RXBYTES status register. +#define BYTES_IN_RXFIFO (0xFF) ///< Bitmask (=01111111) for reading NUM_RXBYTES in RXBYTES status register. /** @} */ /** - * @name Bitmasks for reading out configuration register values + * @name Bitmasks for reading out configuration register values * @{ */ -#define PKT_LENGTH_CONFIG (0x03) ///< Bitmask (=00000011) for reading LENGTH_CONFIG in PKTCTRL0 configuration register. +#define PKT_LENGTH_CONFIG (0x03) ///< Bitmask (=00000011) for reading LENGTH_CONFIG in PKTCTRL0 configuration register. /** @} */ /** - * @name Definitions to support burst/single access + * @name Definitions to support burst/single access * @{ */ -#define CC1100_WRITE_BURST (0x40) ///< Offset for burst write. -#define CC1100_READ_SINGLE (0x80) ///< Offset for read single byte. -#define CC1100_READ_BURST (0xC0) ///< Offset for read burst. -#define CC1100_NOBYTE (0xFF) ///< No command (for reading). +#define CC1100_WRITE_BURST (0x40) ///< Offset for burst write. +#define CC1100_READ_SINGLE (0x80) ///< Offset for read single byte. +#define CC1100_READ_BURST (0xC0) ///< Offset for read burst. +#define CC1100_NOBYTE (0xFF) ///< No command (for reading). /** @} */ /** - * @name Configuration Registers (47x) + * @name Configuration Registers (47x) * @{ */ #define CC1100_IOCFG2 (0x00) ///< GDO2 output pin configuration @@ -132,12 +133,12 @@ /** @} */ /** - * @name Strobe commands (14x) + * @name Strobe commands (14x) * @{ */ -#define CC1100_SRES (0x30) ///< Reset chip. +#define CC1100_SRES (0x30) ///< Reset chip. /** - * @brief Enable and calibrate frequency synthesizer (if MCSM0.FS_AUTOCAL=1). + * @brief Enable and calibrate frequency synthesizer (if MCSM0.FS_AUTOCAL=1). * * If in RX/TX: Go to a wait state where only the synthesizer is running (for quick RX / TX turnaround). */ @@ -161,35 +162,35 @@ /** @} */ /** - * @name Status registers (12x) + * @name Status registers (12x) * @{ */ -#define CC1100_PARTNUM (0x30) ///< Part number of CC1100. -#define CC1100_VERSION (0x31) ///< Current version number. -#define CC1100_FREQEST (0x32) ///< Frequency Offset Estimate. -#define CC1100_LQI (0x33) ///< Demodulator estimate for Link Quality. -#define CC1100_RSSI (0x34) ///< Received signal strength indication. -#define CC1100_MARCSTATE (0x35) ///< Control state machine state. -#define CC1100_WORTIME1 (0x36) ///< High byte of WOR timer. -#define CC1100_WORTIME0 (0x37) ///< Low byte of WOR timer. -#define CC1100_PKTSTATUS (0x38) ///< Current GDOx status and packet status. -#define CC1100_VCO_VC_DAC (0x39) ///< Current setting from PLL calibration module. -#define CC1100_TXBYTES (0x3A) ///< Underflow and number of bytes in the TX FIFO. -#define CC1100_RXBYTES (0x3B) ///< Overflow and number of bytes in the RX FIFO. +#define CC1100_PARTNUM (0x30) ///< Part number of CC1100. +#define CC1100_VERSION (0x31) ///< Current version number. +#define CC1100_FREQEST (0x32) ///< Frequency Offset Estimate. +#define CC1100_LQI (0x33) ///< Demodulator estimate for Link Quality. +#define CC1100_RSSI (0x34) ///< Received signal strength indication. +#define CC1100_MARCSTATE (0x35) ///< Control state machine state. +#define CC1100_WORTIME1 (0x36) ///< High byte of WOR timer. +#define CC1100_WORTIME0 (0x37) ///< Low byte of WOR timer. +#define CC1100_PKTSTATUS (0x38) ///< Current GDOx status and packet status. +#define CC1100_VCO_VC_DAC (0x39) ///< Current setting from PLL calibration module. +#define CC1100_TXBYTES (0x3A) ///< Underflow and number of bytes in the TX FIFO. +#define CC1100_RXBYTES (0x3B) ///< Overflow and number of bytes in the RX FIFO. /** @} */ /** - * @name Multi byte registers + * @name Multi byte registers * @{ */ /** - * @brief Register for eight user selected output power settings. + * @brief Register for eight user selected output power settings. * * 3-bit FREND0.PA_POWER value selects the PATABLE entry to use. */ #define CC1100_PATABLE (0x3E) -#define CC1100_TXFIFO (0x3F) ///< TX FIFO: Write operations write to the TX FIFO (SB: +0x00; BURST: +0x40) -#define CC1100_RXFIFO (0x3F) ///< RX FIFO: Read operations read from the RX FIFO (SB: +0x80; BURST: +0xC0) +#define CC1100_TXFIFO (0x3F) ///< TX FIFO: Write operations write to the TX FIFO (SB: +0x00; BURST: +0x40) +#define CC1100_RXFIFO (0x3F) ///< RX FIFO: Read operations read from the RX FIFO (SB: +0x80; BURST: +0xC0) /** @} */ /** @} */ diff --git a/drivers/cc110x_ng/include/cc110x-reg.h b/drivers/cc110x_ng/include/cc110x-reg.h index df5318774b5a..2e0ea37f1813 100644 --- a/drivers/cc110x_ng/include/cc110x-reg.h +++ b/drivers/cc110x_ng/include/cc110x-reg.h @@ -8,15 +8,16 @@ */ /** - * @ingroup drivers_cc110x_ng + * @ingroup drivers_cc110x_ng * @{ * - * @file cc110x-reg.h - * @brief Access to CC110X registers + * @file cc110x-reg.h + * @brief Access to CC110X registers * - * @author INRIA - * @author Oliver Hahm + * @author INRIA + * @author Oliver Hahm */ + #ifndef __CC110X_REG_H #define __CC110X_REG_H diff --git a/drivers/cc110x_ng/include/cc110x_ng.h b/drivers/cc110x_ng/include/cc110x_ng.h index be0558ee89ba..af6a414a9d7b 100644 --- a/drivers/cc110x_ng/include/cc110x_ng.h +++ b/drivers/cc110x_ng/include/cc110x_ng.h @@ -8,14 +8,17 @@ */ /** - * @defgroup drivers_cc110x_ng CC110x_ng - * @brief Next generation version of the TI CC110x driver - * @ingroup drivers + * @defgroup drivers_cc110x_ng CC110x_ng + * @brief Next generation version of the TI CC110x driver + * @ingroup drivers * @{ - * @file cc110x_ng.h - * @brief Data structures and variables for the cc110x driver interface - * @author Oliver Hahm + * + * @file cc110x_ng.h + * @brief Data structures and variables for the cc110x driver interface + * + * @author Oliver Hahm */ + #ifndef CC1100_H #define CC1100_H @@ -28,40 +31,40 @@ #define CC1100_HEADER_LENGTH (3) ///< Header covers SRC, DST and FLAGS -#define CC1100_BROADCAST_ADDRESS (0x00) ///< CC1100 broadcast address +#define CC1100_BROADCAST_ADDRESS (0x00) ///< CC1100 broadcast address -#define MAX_UID (0xFF) ///< Maximum UID of a node is 255 -#define MIN_UID (0x01) ///< Minimum UID of a node is 1 +#define MAX_UID (0xFF) ///< Maximum UID of a node is 255 +#define MIN_UID (0x01) ///< Minimum UID of a node is 1 -#define MIN_CHANNR (0) ///< Minimum channel number -#define MAX_CHANNR (24) ///< Maximum channel number +#define MIN_CHANNR (0) ///< Minimum channel number +#define MAX_CHANNR (24) ///< Maximum channel number -#define MIN_OUTPUT_POWER (0) ///< Minimum output power value -#define MAX_OUTPUT_POWER (11) ///< Maximum output power value +#define MIN_OUTPUT_POWER (0) ///< Minimum output power value +#define MAX_OUTPUT_POWER (11) ///< Maximum output power value -#define PACKET_LENGTH (0x3E) ///< Packet length = 62 Bytes. -#define CC1100_SYNC_WORD_TX_TIME (90000) // loop count (max. timeout ~ 15 ms) to wait for - // sync word to be transmitted (GDO2 from low to high) +#define PACKET_LENGTH (0x3E) ///< Packet length = 62 Bytes. +#define CC1100_SYNC_WORD_TX_TIME (90000) // loop count (max. timeout ~ 15 ms) to wait for + // sync word to be transmitted (GDO2 from low to high) /** - * @name Defines used as state values for state machine + * @name Defines used as state values for state machine * @{ */ -#define RADIO_UNKNOWN (0) -#define RADIO_AIR_FREE_WAITING (1) -#define RADIO_WOR (2) -#define RADIO_IDLE (3) -#define RADIO_SEND_BURST (4) -#define RADIO_RX (5) -#define RADIO_SEND_ACK (6) -#define RADIO_PWD (7) +#define RADIO_UNKNOWN (0) +#define RADIO_AIR_FREE_WAITING (1) +#define RADIO_WOR (2) +#define RADIO_IDLE (3) +#define RADIO_SEND_BURST (4) +#define RADIO_RX (5) +#define RADIO_SEND_ACK (6) +#define RADIO_PWD (7) /** @} */ -extern volatile cc110x_flags rflags; ///< Radio flags +extern volatile cc110x_flags rflags; ///< Radio flags extern char cc110x_conf[]; /** - * @brief CC1100 layer 0 protocol + * @brief CC1100 layer 0 protocol * * 
 ---------------------------------------------------
@@ -72,24 +75,24 @@ extern char cc110x_conf[];
   1 byte   1 byte    1 byte   1 byte   <= 58 bytes
 
 Flags:
-		Bit | Meaning
-		--------------------
-		7:4	| -
-		3:1 | Protocol
-		  0 | Identification
+        Bit | Meaning
+        --------------------
+        7:4 | -
+        3:1 | Protocol
+          0 | Identification
Notes: \li length & address are given by CC1100 \li Identification is increased is used to scan duplicates. It must be increased - for each new packet and kept for packet retransmissions. + for each new packet and kept for packet retransmissions. */ typedef struct __attribute__((packed)) { - uint8_t length; ///< Length of the packet (without length byte) - uint8_t address; ///< Destination address - uint8_t phy_src; ///< Source address (physical source) - uint8_t flags; ///< Flags - uint8_t data[CC1100_MAX_DATA_LENGTH]; ///< Data (high layer protocol) + uint8_t length; ///< Length of the packet (without length byte) + uint8_t address; ///< Destination address + uint8_t phy_src; ///< Source address (physical source) + uint8_t flags; ///< Flags + uint8_t data[CC1100_MAX_DATA_LENGTH]; ///< Data (high layer protocol) } cc110x_packet_t; @@ -100,16 +103,16 @@ typedef struct { } rx_buffer_t; enum radio_mode { - RADIO_MODE_GET = -1, ///< leave mode unchanged - RADIO_MODE_OFF = 0, ///< turn radio off - RADIO_MODE_ON = 1 ///< turn radio on + RADIO_MODE_GET = -1, ///< leave mode unchanged + RADIO_MODE_OFF = 0, ///< turn radio off + RADIO_MODE_ON = 1 ///< turn radio on }; extern rx_buffer_t cc110x_rx_buffer[]; -extern volatile uint8_t rx_buffer_next; ///< Next packet in RX queue +extern volatile uint8_t rx_buffer_next; ///< Next packet in RX queue -extern volatile uint8_t radio_state; ///< Radio state +extern volatile uint8_t radio_state; ///< Radio state extern cc110x_statistic_t cc110x_statistic; int transceiver_pid; ///< the transceiver thread pid @@ -140,14 +143,14 @@ void cc110x_set_monitor(uint8_t mode); void cc110x_print_config(void); /** - * @brief GDO0 interrupt handler. + * @brief GDO0 interrupt handler. */ void cc110x_gdo0_irq(void); /** - * @brief GDO2 interrupt handler. + * @brief GDO2 interrupt handler. * - * @note Wakes up MCU on packet reception. + * @note Wakes up MCU on packet reception. */ void cc110x_gdo2_irq(void); @@ -168,8 +171,5 @@ void cc110x_init_ignore(void); uint8_t cc110x_add_ignored(radio_address_t addr); #endif -/** - * @} - */ - +/** @} */ #endif diff --git a/drivers/cc110x_ng/include/cc110x_spi.h b/drivers/cc110x_ng/include/cc110x_spi.h index 08554f853139..65643fa21786 100644 --- a/drivers/cc110x_ng/include/cc110x_spi.h +++ b/drivers/cc110x_ng/include/cc110x_spi.h @@ -13,20 +13,15 @@ and Telematics group (http://cst.mi.fu-berlin.de). *******************************************************************************/ /** - * @ingroup drivers_cc110x_ng + * @ingroup drivers_cc110x_ng * @{ - */ - -/** + * * @file - * @brief TI Chipcon CC1100 SPI driver + * @brief TI Chipcon CC1100 SPI driver * * @author Freie Universität Berlin, Computer Systems & Telematics - * @author Thomas Hillebrandt - * @author Heiko Will - * @version $Revision: 1775 $ - * - * @note $Id: cc110x_spi.h 1775 2010-01-26 09:37:03Z hillebra $ + * @author Thomas Hillebrandt + * @author Heiko Will */ #ifndef CC1100_SPI_H_ diff --git a/drivers/cc110x_ng/spi/cc110x_spi.c b/drivers/cc110x_ng/spi/cc110x_spi.c index fb5f8bd3b642..379b870c4264 100644 --- a/drivers/cc110x_ng/spi/cc110x_spi.c +++ b/drivers/cc110x_ng/spi/cc110x_spi.c @@ -1,8 +1,8 @@ -/****************************************************************************** +/* * Copyright 2008, Freie Universitaet Berlin (FUB). All rights reserved. * * These sources were developed at the Freie Universitaet Berlin, Computer Systems -and Telematics group (http://cst.mi.fu-berlin.de). + * and Telematics group (http://cst.mi.fu-berlin.de). * ---------------------------------------------------------------------------- * This file is part of RIOT. * @@ -13,20 +13,16 @@ and Telematics group (http://cst.mi.fu-berlin.de). *******************************************************************************/ /** - * @ingroup drivers_cc110x_ng + * @ingroup drivers_cc110x_ng * @{ - */ - -/** - * @file - * @brief TI Chipcon CC1100 SPI driver * - * @author Freie Universität Berlin, Computer Systems & Telematics - * @author Thomas Hillebrandt - * @author Heiko Will - * @version $Revision: 1775 $ + * @file cc110x_spi.c + * @brief TI Chipcon CC1100 SPI driver * - * @note $Id: cc110x_spi.c 1775 2010-01-26 09:37:03Z hillebra $ + * @author Freie Universität Berlin, Computer Systems & Telematics + * @author Thomas Hillebrandt + * @author Heiko Will + * @} */ #include @@ -40,7 +36,7 @@ and Telematics group (http://cst.mi.fu-berlin.de). #include "irq.h" /*---------------------------------------------------------------------------*/ -// CC1100 SPI access +// CC1100 SPI access /*---------------------------------------------------------------------------*/ uint8_t cc110x_writeburst_reg(uint8_t addr, char *src, uint8_t count) @@ -125,5 +121,3 @@ uint8_t cc110x_strobe(uint8_t c) restoreIRQ(cpsr); return result; } - -/** @} */ diff --git a/drivers/doc.txt b/drivers/doc.txt index f93b8894d591..dc1878227aba 100644 --- a/drivers/doc.txt +++ b/drivers/doc.txt @@ -7,8 +7,8 @@ */ /** - * @defgroup drivers Drivers - * @brief Drivers for external devices as radios, sensors, memory etc. + * @defgroup drivers Drivers + * @brief Drivers for external devices as radios, sensors, memory etc. * * The module contains all kind of drivers for specific devices. */ diff --git a/drivers/include/adc.h b/drivers/include/adc.h index 4136b1225882..f7a09689ca2e 100644 --- a/drivers/include/adc.h +++ b/drivers/include/adc.h @@ -1,27 +1,30 @@ +/** + * @defgroup drivers_adc ADC + * @ingroup drivers + * @brief Generic ADC driver + * @{ + * + * @file adc.h + */ + #ifndef ADC_H #define ADC_H #include - -/** - * @defgroup drivers_adc ADC - * @ingroup drivers - * @brief Generic ADC driver - */ - /** - * @brief Initialize ADC. + * @brief Initialize ADC. */ void adc_init(void); /** - * @brief Read ADC value of selected channel. + * @brief Read ADC value of selected channel. * * Valid channel numbers are from 0 to 2. * - * @return ADC value of selected channel. + * @return ADC value of selected channel. */ uint16_t adc_read(uint8_t channel); +/** @} */ #endif /* ADC_H */ diff --git a/drivers/include/diskio.h b/drivers/include/diskio.h index e83c80d95663..5ef1001fd883 100644 --- a/drivers/include/diskio.h +++ b/drivers/include/diskio.h @@ -3,11 +3,17 @@ /-----------------------------------------------------------------------*/ /** - * @defgroup diskio Disk IO Driver - * @ingroup drivers - * @brief Low level disk interface + * @defgroup diskio Disk IO Driver + * @ingroup drivers + * @brief Low level disk interface * * The connection between the MCU and the SRF08 is based on the i2c-interface. + * + * @{ + * + * @file diskio.h + * + * @author unknown */ #ifndef DEF_DISKIO @@ -15,33 +21,33 @@ #include -#define DN_MCI 0 /* Physical drive number for MCI */ -#define DN_NAND 1 /* Physical drive number for NAND flash */ +#define DN_MCI 0 /* Physical drive number for MCI */ +#define DN_NAND 1 /* Physical drive number for NAND flash */ /** - * @def MCI_PWRSAVE - * @ingroup conf - * @brief Powerdown mode to use between mci operations + * @def MCI_PWRSAVE + * @ingroup conf + * @brief Powerdown mode to use between mci operations */ #ifndef MCI_PWRSAVE -#define MCI_PWRSAVE 0 +#define MCI_PWRSAVE 0 #endif /* These functions are defined in asmfunc.S */ -void Copy_al2un(unsigned char *dst, const unsigned long *src, int count); /* Copy aligned to unaligned. */ -void Copy_un2al(unsigned long *dst, const unsigned char *src, int count); /* Copy unaligned to aligned. */ +void Copy_al2un(unsigned char *dst, const unsigned long *src, int count); /* Copy aligned to unaligned. */ +void Copy_un2al(unsigned long *dst, const unsigned char *src, int count); /* Copy unaligned to aligned. */ /* Status of Disk Functions */ -typedef unsigned char DSTATUS; +typedef unsigned char DSTATUS; /* Results of Disk Functions */ typedef enum { - RES_OK = 0, /* 0: Successful */ - RES_ERROR, /* 1: R/W Error */ - RES_WRPRT, /* 2: Write Protected */ - RES_NOTRDY, /* 3: Not Ready */ - RES_PARERR /* 4: Invalid Parameter */ + RES_OK = 0, /* 0: Successful */ + RES_ERROR, /* 1: R/W Error */ + RES_WRPRT, /* 2: Write Protected */ + RES_NOTRDY, /* 3: Not Ready */ + RES_PARERR /* 4: Invalid Parameter */ } DRESULT; @@ -58,39 +64,39 @@ DRESULT disk_ioctl(unsigned char, unsigned char, void *); /* Disk Status Bits (DSTATUS) */ -#define STA_NOINIT 0x01 /* Drive not initialized */ -#define STA_NODISK 0x02 /* No medium in the drive */ -#define STA_PROTECT 0x04 /* Write protected */ +#define STA_NOINIT 0x01 /* Drive not initialized */ +#define STA_NODISK 0x02 /* No medium in the drive */ +#define STA_PROTECT 0x04 /* Write protected */ /* Command code for disk_ioctrl fucntion */ /* Generic ioctl command (defined for FatFs) */ -#define CTRL_SYNC 0 /* Flush disk cache (for write functions) */ -#define GET_SECTOR_COUNT 1 /* Get media size (for only f_mkfs()) */ -#define GET_SECTOR_SIZE 2 /* Get sector size (for multiple sector size (_MAX_SS >= 1024)) */ -#define GET_BLOCK_SIZE 3 /* Get erase block size (for only f_mkfs()) */ -#define CTRL_ERASE_SECTOR 4 /* Force erased a block of sectors (for only _USE_ERASE) */ +#define CTRL_SYNC 0 /* Flush disk cache (for write functions) */ +#define GET_SECTOR_COUNT 1 /* Get media size (for only f_mkfs()) */ +#define GET_SECTOR_SIZE 2 /* Get sector size (for multiple sector size (_MAX_SS >= 1024)) */ +#define GET_BLOCK_SIZE 3 /* Get erase block size (for only f_mkfs()) */ +#define CTRL_ERASE_SECTOR 4 /* Force erased a block of sectors (for only _USE_ERASE) */ /* Generic ioctl command */ -#define CTRL_POWER 5 /* Get/Set power status */ -#define CTRL_LOCK 6 /* Lock/Unlock media removal */ -#define CTRL_EJECT 7 /* Eject media */ +#define CTRL_POWER 5 /* Get/Set power status */ +#define CTRL_LOCK 6 /* Lock/Unlock media removal */ +#define CTRL_EJECT 7 /* Eject media */ /* MMC/SDC specific ioctl command */ -#define MMC_GET_TYPE 10 /* Get card type */ -#define MMC_GET_CSD 11 /* Get CSD */ -#define MMC_GET_CID 12 /* Get CID */ -#define MMC_GET_OCR 13 /* Get OCR */ -#define MMC_GET_SDSTAT 14 /* Get SD status */ +#define MMC_GET_TYPE 10 /* Get card type */ +#define MMC_GET_CSD 11 /* Get CSD */ +#define MMC_GET_CID 12 /* Get CID */ +#define MMC_GET_OCR 13 /* Get OCR */ +#define MMC_GET_SDSTAT 14 /* Get SD status */ /* ATA/CF specific ioctl command */ -#define ATA_GET_REV 20 /* Get F/W revision */ -#define ATA_GET_MODEL 21 /* Get model name */ -#define ATA_GET_SN 22 /* Get serial number */ +#define ATA_GET_REV 20 /* Get F/W revision */ +#define ATA_GET_MODEL 21 /* Get model name */ +#define ATA_GET_SN 22 /* Get serial number */ /* NAND specific ioctl command */ -#define NAND_FORMAT 30 /* Create physical format */ +#define NAND_FORMAT 30 /* Create physical format */ @@ -111,5 +117,5 @@ DRESULT MCI_write(const unsigned char *, unsigned long, unsigned char); DRESULT MCI_ioctl(unsigned char, void *); void MCI_timerproc(void); - +/** @} */ #endif diff --git a/drivers/include/flashrom.h b/drivers/include/flashrom.h index c7f78ce2cc56..59ce1ee5288b 100644 --- a/drivers/include/flashrom.h +++ b/drivers/include/flashrom.h @@ -1,10 +1,12 @@ - - - -/** - * @defgroup flashrom Flash memory driver - * @ingroup drivers - * @brief Generic flash memory driver +/* + * @defgroup flashrom Flash memory driver + * @ingroup drivers + * @brief Generic flash memory driver + * @{ + * + * @file flashrom.h + * + * @author unknown */ #ifndef FLASHROM_H @@ -20,7 +22,7 @@ * * @return 1 on success, 0 otherwise */ -uint8_t flashrom_erase(uint8_t *addr); +uint8_t flashrom_erase(uint8_t *addr); /* @brief Write buffer from ram to flash * @@ -30,7 +32,7 @@ uint8_t flashrom_erase(uint8_t *addr); * * @return 1 on success, 0 otherwise */ -uint8_t flashrom_write(uint8_t *dst, char *src, size_t size); - +uint8_t flashrom_write(uint8_t *dst, char *src, size_t size); +/** @} */ #endif /* FLASHROM_H */ diff --git a/drivers/include/gpioint.h b/drivers/include/gpioint.h index b4fc89903e34..26421b0157fc 100644 --- a/drivers/include/gpioint.h +++ b/drivers/include/gpioint.h @@ -1,4 +1,4 @@ -/****************************************************************************** +/* * Copyright 2009, Freie Universitaet Berlin (FUB). All rights reserved. * * These sources were developed at the Freie Universitaet Berlin, Computer Systems @@ -16,32 +16,25 @@ and Telematics group (http://cst.mi.fu-berlin.de). #define GPIOINT_H_ /** - * @defgroup drivers_gpioint GPIO IRQ Multiplexer - * @ingroup drivers - * @brief Provides an API to implement interrupt handlers on IO pins. + * @defgroup drivers_gpioint GPIO IRQ Multiplexer + * @ingroup drivers + * @brief Provides an API to implement interrupt handlers on IO pins. * * Multiplexer and interrupt handling must be implemented platform specific. * * See gpioint-example.c for an example of how to use gpioint. * * @{ - */ - -/** + * * @example gpioint-example.c * This example shows how to setup an interrupt handler for a GPIO pin * without using the HAL. - */ - -/** + * * @file - * @brief GPIO IRQ Multiplexer interface + * @brief GPIO IRQ Multiplexer interface * * @author Freie Universität Berlin, Computer Systems & Telematics - * @author Michael Baar - * @version $Revision: 1508 $ - * - * @note $Id: gpioint.h 1508 2009-10-26 15:10:02Z baar $ + * @author Michael Baar */ #include @@ -52,26 +45,26 @@ and Telematics group (http://cst.mi.fu-berlin.de). * Note: - We rely on the exact values for the edges. * - These flags are extended in hal/drivers/device-gpio.h */ -#define GPIOINT_DISABLE 0x00 -#define GPIOINT_RISING_EDGE 0x01 ///< interrupt is generated on rising edge -#define GPIOINT_FALLING_EDGE 0x02 ///< interrupt is generated on falling edge +#define GPIOINT_DISABLE 0x00 +#define GPIOINT_RISING_EDGE 0x01 ///< interrupt is generated on rising edge +#define GPIOINT_FALLING_EDGE 0x02 ///< interrupt is generated on falling edge #define GPIOINT_DEBOUNCE 0x04 ///< debounce this interrupt /** - * @brief GPIO IRQ callback function type - * @param[in] data User defined callback data passed through gpioint_set - * @param[in] edge A combination of GPIOINT_RISING_EDGE and GPIOINT_FALLING_EDGE + * @brief GPIO IRQ callback function type + * @param[in] data User defined callback data passed through gpioint_set + * @param[in] edge A combination of GPIOINT_RISING_EDGE and GPIOINT_FALLING_EDGE */ typedef void(*fp_irqcb)(void); /** - * @brief GPIO IRQ handler setup - * @param[in] port CPU specific port number (starting at 0) - * @param[in] bitmask One or more bits for which to set the handler - * @param[in] flags A combination of #GPIOINT_RISING_EDGE and #GPIOINT_FALLING_EDGE - * @param[in] callback A pointer to a handler function - * @retval true successful - * @retval false failed + * @brief GPIO IRQ handler setup + * @param[in] port CPU specific port number (starting at 0) + * @param[in] bitmask One or more bits for which to set the handler + * @param[in] flags A combination of #GPIOINT_RISING_EDGE and #GPIOINT_FALLING_EDGE + * @param[in] callback A pointer to a handler function + * @retval true successful + * @retval false failed * * To enable interrupt handling for a pin flags and callback must be non-zero. To disable interrupt * handling flags and callback shall be zero. diff --git a/drivers/include/lm75a-temp-sensor.h b/drivers/include/lm75a-temp-sensor.h index 5fccab68b756..fbf803959165 100644 --- a/drivers/include/lm75a-temp-sensor.h +++ b/drivers/include/lm75a-temp-sensor.h @@ -1,7 +1,4 @@ /* - - * lm75a-temp-sensor.h - Definitions of the LM75A temperature sensor driver. - * * Copyright (C) 2013 Zakaria Kasmi * * This source code is licensed under the LGPLv2 license, @@ -9,26 +6,22 @@ */ /** - * @defgroup lm75a LM75A - * @ingroup drivers - * @brief Driver for the LM75A digital temperature sensor and thermal watchdog + * @defgroup lm75a LM75A + * @ingroup drivers + * @brief Driver for the LM75A digital temperature sensor and thermal watchdog * * The connection between the MCU and the LM75A is based on the i2c-interface. - */ - -/** + * + * @{ + * * @file * @internal * @brief Definitions of the LM75A temperature sensor driver. * - * The connection between the LM75A and the MCU is based - * on the I2C-interface. + * The connection between the LM75A and the MCU is based on the I2C-interface. * * @author Freie Universität Berlin, Computer Systems & Telematics * @author Zakaria Kasmi - * @version $Revision: 3859 $ - * - * @note $Id: lm75a-temp-sensor.h 3854 2013-09-2 15:35:21 kasmi $ */ #ifndef LM75A_H_ @@ -260,4 +253,5 @@ bool lm75A_external_interrupt_register(void *handler); */ void lm75A_set_in_alarm(bool b); +/** @} */ #endif /* LM75A_H_ */ diff --git a/drivers/include/ltc4150_arch.h b/drivers/include/ltc4150_arch.h index db6c799dfe0b..a45963093589 100644 --- a/drivers/include/ltc4150_arch.h +++ b/drivers/include/ltc4150_arch.h @@ -18,19 +18,14 @@ and Telematics group (http://cst.mi.fu-berlin.de). /** * @defgroup ltc4150 LTC4150 * @ingroup drivers - * @brief Driver for the Linear Technology LTC4150 Coulomb Counter + * @brief Driver for the Linear Technology LTC4150 Coulomb Counter * @{ - */ - -/** - * @file + * + * @file ltc4150_arch.h * @brief LTC4150 Coulomb Counter * * @author Freie Universität Berlin, Computer Systems & Telematics * @author Heiko Will - * @version $Revision: 1203 $ - * - * @note $Id: ltc4150_arch.h 1203 2009-07-07 10:23:18Z baar $ */ #define _GFH (double)32.631375 diff --git a/drivers/include/rtc.h b/drivers/include/rtc.h index 6799f0789c13..5517df60761c 100644 --- a/drivers/include/rtc.h +++ b/drivers/include/rtc.h @@ -1,4 +1,4 @@ -/****************************************************************************** +/* * Copyright 2010, Freie Universitaet Berlin (FUB). All rights reserved. * * These sources were developed at the Freie Universitaet Berlin, Computer Systems @@ -13,9 +13,9 @@ and Telematics group (http://cst.mi.fu-berlin.de). *******************************************************************************/ /** - * @defgroup rtc Realtime Clock - * @ingroup drivers - * @brief Generic real time clock driver + * @defgroup rtc Realtime Clock + * @ingroup drivers + * @brief Generic real time clock driver * @{ */ @@ -47,24 +47,24 @@ void rtc_enable(void); void rtc_disable(void); /** - * @brief Sets the current time in broken down format directly from to RTC - * @param[in] localt Pointer to structure with time to set + * @brief Sets the current time in broken down format directly from to RTC + * @param[in] localt Pointer to structure with time to set */ void rtc_set_localtime(struct tm *localt); /** - * @brief Returns the current time in broken down format directly from the RTC - * @param[out] localt Pointer to structure to receive time + * @brief Returns the current time in broken down format directly from the RTC + * @param[out] localt Pointer to structure to receive time */ void rtc_get_localtime(struct tm *localt); /** - * @brief Get the current time as a struct timeval - * @param[out] time Pointer to structure to receive time + * @brief Get the current time as a struct timeval + * @param[out] time Pointer to structure to receive time */ time_t rtc_time(struct timeval *time); extern int rtc_second_pid; -#endif /** @} */ +#endif diff --git a/drivers/include/sht11.h b/drivers/include/sht11.h index aa1f9e3aa3fe..575b60310b02 100644 --- a/drivers/include/sht11.h +++ b/drivers/include/sht11.h @@ -16,30 +16,26 @@ and Telematics group (http://cst.mi.fu-berlin.de). #define SHT11_H_ /** - * @defgroup sht11 SHT11 - * @ingroup drivers + * @defgroup sht11 SHT11 + * @ingroup drivers * @{ - */ - -/** - * @file - * @brief SHT11 Device Driver * - * @author Freie Universität Berlin, Computer Systems & Telematics - * @version $Revision: 667 $ + * @file sht11.h + * @brief SHT11 Device Driver * - * @note $Id: sht11.h 667 2009-02-19 15:06:38Z baar $ + * @author Freie Universität Berlin, Computer Systems & Telematics */ + #include -#define SHT11_NO_ACK (0) -#define SHT11_ACK (1) +#define SHT11_NO_ACK (0) +#define SHT11_ACK (1) //adr command r/w -#define SHT11_STATUS_REG_W (0x06) //000 0011 0 -#define SHT11_STATUS_REG_R (0x07) //000 0011 1 -#define SHT11_MEASURE_TEMP (0x03) //000 0001 1 -#define SHT11_MEASURE_HUMI (0x05) //000 0010 1 -#define SHT11_RESET (0x1E) //000 1111 0 +#define SHT11_STATUS_REG_W (0x06) //000 0011 0 +#define SHT11_STATUS_REG_R (0x07) //000 0011 1 +#define SHT11_MEASURE_TEMP (0x03) //000 0001 1 +#define SHT11_MEASURE_HUMI (0x05) //000 0010 1 +#define SHT11_RESET (0x1E) //000 1111 0 /* time to wait after toggling the data line */ #define SHT11_DATA_WAIT (HWTIMER_TICKS(1)) @@ -53,13 +49,13 @@ and Telematics group (http://cst.mi.fu-berlin.de). * @brief sht11 measureable data */ typedef struct { - float temperature; /**< temperature value */ - float relhum; /**< linear relative humidity */ - float relhum_temp; /**< temperature compensated relative humidity */ + float temperature; /**< temperature value */ + float relhum; /**< linear relative humidity */ + float relhum_temp; /**< temperature compensated relative humidity */ } sht11_val_t; /** - * @brief SHT11 modes that can be measured + * @brief SHT11 modes that can be measured */ typedef enum { TEMPERATURE = 1, @@ -67,12 +63,12 @@ typedef enum { } sht11_mode_t; /** - * @brief Initialize SHT11 ports + * @brief Initialize SHT11 ports */ void sht11_init(void); /** - * @brief Read sensor + * @brief Read sensor * * @param value The struct to be filled with measured values * @param mode Specifies type of data to be read @@ -107,4 +103,3 @@ uint8_t sht11_read_status(uint8_t *p_value, uint8_t *p_checksum); /** @} */ #endif /*SHT11_H_*/ - diff --git a/drivers/include/srf02-ultrasonic-sensor.h b/drivers/include/srf02-ultrasonic-sensor.h index c7c144e61d2e..95ab003a0b7e 100644 --- a/drivers/include/srf02-ultrasonic-sensor.h +++ b/drivers/include/srf02-ultrasonic-sensor.h @@ -1,7 +1,4 @@ /* - * srf02-ultrasonic-sensor.h - Definitions for the SRF02 ultrasonic ranger - * driver. - * * Copyright (C) 2013 Zakaria Kasmi * * This source code is licensed under the LGPLv2 license, @@ -9,26 +6,21 @@ */ /** - * @defgroup srf02 SRF02 - * @ingroup drivers - * @brief Driver for the SRF02 ultrasonic range sensor + * @defgroup srf02 SRF02 + * @ingroup drivers + * @brief Driver for the SRF02 ultrasonic range sensor * * The connection between the MCU and the SRF08 is based on the i2c-interface. - */ - -/** - * @file - * @internal + * + * @{ + * + * @file srf02-ultrasonic-sensor.h * @brief Driver definitions for the SRF02 ultrasonic ranger. - * The connection between the SRF02 and the MCU is based on - * the i2c interface. + * + * The connection between the SRF02 and the MCU is based on the i2c interface. * * @author Freie Universität Berlin, Computer Systems & Telematics * @author Zakaria Kasmi - * @version $Revision: 3857 $ - * - * @note $Id: srf02-ultrasonic-sensor.h 3854 2013-09-03 13:55:30 kasmi $ - * */ #ifndef SRF02_ULTRASONIC_SENSOR_I2C_H_ @@ -102,4 +94,5 @@ uint32_t srf02_get_distance(uint8_t ranging_mode); */ void srf02_start_ranging(uint16_t ranging_mode); +/** @} */ #endif /* SRF02_ULTRASONIC_SENSOR_I2C_H_ */ diff --git a/drivers/include/srf08-ultrasonic-sensor.h b/drivers/include/srf08-ultrasonic-sensor.h index 7749fafaca58..eab68fd2ab69 100644 --- a/drivers/include/srf08-ultrasonic-sensor.h +++ b/drivers/include/srf08-ultrasonic-sensor.h @@ -1,6 +1,4 @@ /* - * srf08-ultrasonic-sensor.h - Definitions for the SRF08 ultrasonic ranger. - * * Copyright (C) 2013 Zakaria Kasmi * * This source code is licensed under the LGPLv2 license, @@ -8,26 +6,22 @@ */ /** - * @defgroup srf08 SRF08 - * @ingroup drivers - * @brief Driver for the SRF08 ultrasonic range sensor + * @defgroup srf08 SRF08 + * @ingroup drivers + * @brief Driver for the SRF08 ultrasonic range sensor * * The connection between the MCU and the SRF08 is based on the i2c-interface. - */ - -/** + * + * @{ + * * @file * @internal * @brief Driver definitions for the SRF08 ultrasonic. - * The communication between the MCU and SRF08 is via the i2c - * interface. + * + * The communication between the MCU and SRF08 is via the i2c interface. * * @author Freie Universität Berlin, Computer Systems & Telematics * @author Zakaria Kasmi - * @version $Revision: 3857 $ - * - * @note $Id: srf08-ultrasonic-sensor.h 3854 2013-09-03 16:26:13 kasmi $ - * */ #ifndef SRF08_ULTRASONIC_SENSOR_I2C_H_ @@ -134,4 +128,5 @@ uint8_t srf08_get_gain(void); */ int32_t srf08_get_distances(uint32_t *range_array, uint8_t ranging_mode); +/** @} */ #endif /* SRF08_ULTRASONIC_SENSOR_I2C_H_ */ diff --git a/sys/doc.txt b/sys/doc.txt index 0dcd8b3a555e..5f185b0e1dd0 100644 --- a/sys/doc.txt +++ b/sys/doc.txt @@ -7,6 +7,6 @@ */ /** - * @defgroup sys System - * @brief System library contains tools and utilities that make RIOT an actual operating system + * @defgroup sys System + * @brief System library contains tools and utilities that make RIOT an actual operating system */ diff --git a/sys/include/auto_init.h b/sys/include/auto_init.h index 86876fcc326e..44116cb02ac8 100644 --- a/sys/include/auto_init.h +++ b/sys/include/auto_init.h @@ -1,8 +1,11 @@ /** - * @defgroup sys_autoinit Auto-init - * @ingroup sys - * @brief Autoconfigure libraries + * @defgroup sys_autoinit Auto-init + * @ingroup sys + * @brief Autoconfigure libraries + * @{ + * + * @file auto_init.h */ #ifndef AUTO_INIT_H @@ -30,4 +33,5 @@ void auto_init(void); -#endif +/** @} */ +#endif /* AUTO_INIT_H */ diff --git a/sys/include/bloom.h b/sys/include/bloom.h index 02628d85dd59..9579eca3a145 100644 --- a/sys/include/bloom.h +++ b/sys/include/bloom.h @@ -1,11 +1,4 @@ - -/** - * @defgroup sys_bloom Bloom filter - * @ingroup sys - * @brief Bloom filter library - */ - -/** +/* * bloom.c * * Bloom filters @@ -108,7 +101,14 @@ */ /** - * @file + * @defgroup sys_bloom Bloom filter + * @ingroup sys + * @brief Bloom filter library + * @{ + * + * @file bloom.h + * @brief Bloom filter API + * * @autor Christian Mehlis * @autor Freie Universität Berlin, Computer Systems & Telematics */ @@ -208,4 +208,5 @@ void bloom_add(struct bloom_t *bloom, const uint8_t *buf, size_t len); */ bool bloom_check(struct bloom_t *bloom, const uint8_t *buf, size_t len); -#endif +/** @} */ +#endif /* _BLOOM_FILTER_H */ diff --git a/sys/include/board_uart0.h b/sys/include/board_uart0.h index 7b6de7af7ecb..734950da059d 100644 --- a/sys/include/board_uart0.h +++ b/sys/include/board_uart0.h @@ -1,8 +1,12 @@ /** - * @defgroup sys_uart0 UART0 - * @ingroup sys - * @brief UART0 interface abstraction + * @defgroup sys_uart0 UART0 + * @ingroup sys + * @brief UART0 interface abstraction + * @{ + * + * @file board_uart0.h + * @brief Interface definitions for the UART0 abstraction */ #ifndef __BOARD_UART0_H @@ -17,4 +21,5 @@ void uart0_notify_thread(void); int uart0_readc(void); void uart0_putc(int c); +/** @} */ #endif /* __BOARD_UART0_H */ diff --git a/sys/include/chardev_thread.h b/sys/include/chardev_thread.h index 1d2b8a5cd345..439354b81d17 100644 --- a/sys/include/chardev_thread.h +++ b/sys/include/chardev_thread.h @@ -1,8 +1,8 @@ /** - * @defgroup sys_chardevthread Chardev Thread - * @ingroup sys - * @brief Chardev thread + * @defgroup sys_chardevthread Chardev Thread + * @ingroup sys + * @brief Chardev thread */ #ifndef __CHARDEV_THREAD_H diff --git a/sys/include/hashes.h b/sys/include/hashes.h index 636c726a01f2..95aa46c9a889 100644 --- a/sys/include/hashes.h +++ b/sys/include/hashes.h @@ -1,6 +1,4 @@ -/** - * This file contains some simple hash function - * +/* * Copyright (C) 2013 Freie Universität Berlin * * This file is subject to the terms and conditions of the GNU Lesser General @@ -9,18 +7,22 @@ */ /** - * @defgroup sys_hashes Hashes - * @ingroup sys - * @brief Hash function library - */ - -/** - * @file + * @defgroup sys_hashes Hashes + * @ingroup sys + * @brief Hash function library + * @{ + * + * @file hashes.h + * @brief Hash function API + * * @autor Jason Linehan * @author Freie Universität Berlin, Computer Systems & Telematics * @author Christian Mehlis */ +#ifndef __HASHES_H +#define __HASHES_H + #include #include @@ -153,3 +155,6 @@ uint32_t rotating_hash(const uint8_t *buf, size_t len); * @return 32 bit sized hash */ uint32_t one_at_a_time_hash(const uint8_t *buf, size_t len); + +/** @} */ +#endif /* __HASHES_H */ \ No newline at end of file diff --git a/sys/include/ping.h b/sys/include/ping.h index d671d8aee612..6e9d392227c6 100644 --- a/sys/include/ping.h +++ b/sys/include/ping.h @@ -1,8 +1,8 @@ /** - * @defgroup sys_ping Ping - * @ingroup sys - * @brief Ping + * @defgroup sys_ping Ping + * @ingroup sys + * @brief Ping */ #include "radio/radio.h" diff --git a/sys/include/posix_io.h b/sys/include/posix_io.h index df11cff33771..cddba17396d2 100644 --- a/sys/include/posix_io.h +++ b/sys/include/posix_io.h @@ -7,9 +7,9 @@ */ /** - * @defgroup sys_posixio Posix IO - * @ingroup sys - * @brief Posix compatible IO + * @defgroup sys_posixio Posix IO + * @ingroup sys + * @brief Posix compatible IO * @{ * @file * @brief POSIX-like IO diff --git a/sys/include/ps.h b/sys/include/ps.h index 010272a30040..824bd9949bd2 100644 --- a/sys/include/ps.h +++ b/sys/include/ps.h @@ -1,8 +1,8 @@ /** - * @defgroup sys_ps PS - * @ingroup sys - * @brief Show list with all threads + * @defgroup sys_ps PS + * @ingroup sys + * @brief Show list with all threads */ #ifndef __PS_H diff --git a/sys/include/random.h b/sys/include/random.h index e4295b3f5a9f..6bebda748daa 100644 --- a/sys/include/random.h +++ b/sys/include/random.h @@ -1,8 +1,8 @@ /** - * @defgroup sys_random Random - * @ingroup sys - * @brief Random number generator + * @defgroup sys_random Random + * @ingroup sys + * @brief Random number generator */ #include diff --git a/sys/include/sha256.h b/sys/include/sha256.h index aa9f30e59bc5..852dad4fcf9a 100644 --- a/sys/include/sha256.h +++ b/sys/include/sha256.h @@ -29,9 +29,9 @@ /** - * @defgroup sys_sha256 SHA264 - * @ingroup sys - * @brief SHA264 hash generator + * @defgroup sys_sha256 SHA264 + * @ingroup sys + * @brief SHA264 hash generator */ #ifndef _SHA256_H_ diff --git a/sys/include/shell.h b/sys/include/shell.h index ad1750918083..0b3cf13aee6e 100644 --- a/sys/include/shell.h +++ b/sys/include/shell.h @@ -13,9 +13,9 @@ *******************************************************************************/ /** - * @defgroup sys_shell Shell - * @ingroup sys - * @brief Simple shell interpreter + * @defgroup sys_shell Shell + * @ingroup sys + * @brief Simple shell interpreter */ #ifndef __SHELL_H diff --git a/sys/include/timex.h b/sys/include/timex.h index e0b9a99b6927..ee866ebc4ed8 100644 --- a/sys/include/timex.h +++ b/sys/include/timex.h @@ -1,8 +1,8 @@ /** - * @defgroup sys_timex Timex - * @ingroup sys - * @brief Utility library for comparing and computing timestamps + * @defgroup sys_timex Timex + * @ingroup sys + * @brief Utility library for comparing and computing timestamps */ #ifndef __TIMEX_H diff --git a/sys/include/transceiver.h b/sys/include/transceiver.h index b9c818faf542..73159f477015 100644 --- a/sys/include/transceiver.h +++ b/sys/include/transceiver.h @@ -1,8 +1,8 @@ /** - * @defgroup sys_transceiver Transceiver - * @ingroup sys - * @brief Transceiver library + * @defgroup sys_transceiver Transceiver + * @ingroup sys + * @brief Transceiver library */ #ifndef TRANSCEIVER_H diff --git a/sys/include/vtimer.h b/sys/include/vtimer.h index e1d5e09e3912..d256a4612ea2 100644 --- a/sys/include/vtimer.h +++ b/sys/include/vtimer.h @@ -1,21 +1,20 @@ -/** \addtogroup sys - * @{ */ - /** - * \defgroup vtimer Virtual (Software) Timer library + * @defgroup sys_vtimer Virtual (Software) Timer library + * @addtogroup sys + * @brief Virtual software timer for general timer functionality in applications + * @{ + * + * @file vtimer.h + * @brief VTimer API * * The vtimer library provides functions for setting, resetting and restarting * software timers, and for checking if a vtimer has expired. * * (As of now, not resetting, restarting, removing and checking are not implemented) * - * @{ + * @author unknown */ -/** - * \file - * Timer library header file. - */ #ifndef __VTIMER_H #define __VTIMER_H @@ -120,4 +119,5 @@ void vtimer_print_long_queue(void); #endif +/** @} */ #endif /* __VTIMER_H */ diff --git a/sys/net/doc.txt b/sys/net/doc.txt index 810b73ffef5f..e142fe7d1c6c 100644 --- a/sys/net/doc.txt +++ b/sys/net/doc.txt @@ -7,7 +7,7 @@ */ /** - * @defgroup net Net - * @ingroup sys - * @brief Networking libraries + * @defgroup net Net + * @ingroup sys + * @brief Networking libraries */ diff --git a/sys/net/include/ieee802154_frame.h b/sys/net/include/ieee802154_frame.h index d75056e8bc92..5e2088d4fc7f 100644 --- a/sys/net/include/ieee802154_frame.h +++ b/sys/net/include/ieee802154_frame.h @@ -1,21 +1,22 @@ -/** - * Data struct and prototypes for the IEEE 802.15.4 frame format - * +/* * Copyright (C) 2013 INRIA. * * This file is 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 net_ieee802154 IEEE802.15.4 + */ + +/** + * @defgroup net_ieee802154 IEEE802.15.4 * @ingroup net - * @brief IEEE802.15.4 adapaption layer + * @brief IEEE802.15.4 adapaption layer * @{ + * * @file ieee802154/ieee802154_frame.h * @brief IEEE 802.14.4 framing data structs and prototypes + * * @author Stephan Zeisberg * @author Oliver Hahm - * @} */ #ifndef IEEE802154_IEEE802154_FRAME @@ -63,8 +64,8 @@ typedef struct __attribute__((packed)) { uint8_t ieee802154_frame_init(ieee802154_frame_t *frame, uint8_t *buf); uint8_t ieee802154_frame_get_hdr_len(ieee802154_frame_t *frame); -uint8_t ieee802154_frame_read(uint8_t *buf, ieee802154_frame_t *frame, - uint8_t len); +uint8_t ieee802154_frame_read(uint8_t *buf, ieee802154_frame_t *frame, uint8_t len); void ieee802154_frame_print_fcf_frame(ieee802154_frame_t *frame); +/** @} */ #endif /* IEEE802154_IEEE802154_FRAME */ diff --git a/sys/net/include/net_help.h b/sys/net/include/net_help.h index 8ef9c5994f2c..6dd566efa141 100644 --- a/sys/net/include/net_help.h +++ b/sys/net/include/net_help.h @@ -1,18 +1,17 @@ -/* - * common.h +/** + * @defgroup net_help Net help + * @ingroup net + * @brief Helper functions for networking as byte order conversions and checksum calculations + * @{ + * + * @file net_help.h * - * Created on: 05.10.2011 - * Author: Oliver + * @author Oliver */ -/** - * @defgroup net_help Net help - * @ingroup net - * @brief Helper functions for networking as byte order conversions and checksum calculations - */ +#ifndef __NET_HELP_H +#define __NET_HELP_H -#ifndef COMMON_H_ -#define COMMON_H_ #include #include @@ -30,4 +29,5 @@ uint16_t csum(uint16_t sum, uint8_t *buf, uint16_t len); void printArrayRange(uint8_t *array, uint16_t len, char *str); -#endif /* COMMON_H_ */ +/** @} */ +#endif /* __NET_HELP_H */ diff --git a/sys/net/include/protocol-multiplex.h b/sys/net/include/protocol-multiplex.h index d8ff545364e5..157d3004715f 100644 --- a/sys/net/include/protocol-multiplex.h +++ b/sys/net/include/protocol-multiplex.h @@ -1,8 +1,8 @@ -/****************************************************************************** +/* * Copyright 2009, Freie Universitaet Berlin (FUB). All rights reserved. * * These sources were developed at the Freie Universitaet Berlin, Computer Systems -and Telematics group (http://cst.mi.fu-berlin.de). + * and Telematics group (http://cst.mi.fu-berlin.de). * ---------------------------------------------------------------------------- * This file is part of RIOT. * @@ -12,40 +12,35 @@ and Telematics group (http://cst.mi.fu-berlin.de). * *******************************************************************************/ -#ifndef PROTOCOLMULTIPLEX_H_ -#define PROTOCOLMULTIPLEX_H_ - /** - * @defgroup net_mmstack Protocol multiplex - * @ingroup net - * @brief Protocol handler multiplexing + * @defgroup net_mmstack Protocol multiplex + * @ingroup net + * @brief Protocol handler multiplexing * @{ - */ - -/** + * * @file - * @internal - * @brief Protocol handler multiplexing + * @brief Protocol handler multiplexing * * @author Freie Universität Berlin, Computer Systems & Telematics - * @author Thomas Hillebrandt - * @author Heiko Will - * @author Michael Baar - * @version $Revision: 1526 $ - * - * @note $Id: protocol-multiplex.h 1526 2009-10-30 13:40:20Z hillebra $ + * @author Thomas Hillebrandt + * @author Heiko Will + * @author Michael Baar */ +#ifndef PROTOCOLMULTIPLEX_H_ +#define PROTOCOLMULTIPLEX_H_ + + #include "radio/types.h" typedef struct { - packet_handler_t handler; - protocol_t protocol; + packet_handler_t handler; + protocol_t protocol; } handler_entry_t; typedef struct { - uint8_t size; - handler_entry_t *handler; + uint8_t size; + handler_entry_t *handler; } pm_table_t; void pm_init_table(pm_table_t *table, uint8_t size, handler_entry_t *handler); @@ -55,5 +50,4 @@ void pm_remove_handler(const pm_table_t *table, protocol_t protocol, packet_hand int pm_invoke(const pm_table_t *table, protocol_t protocol, void *payload, int payload_size, packet_info_t *packet_info); /** @} */ - #endif /* PROTOCOLMULTIPLEX_H_ */ diff --git a/sys/net/rpl/rpl.h b/sys/net/rpl/rpl.h index cc10affc67c0..e64bc362d32d 100644 --- a/sys/net/rpl/rpl.h +++ b/sys/net/rpl/rpl.h @@ -1,22 +1,26 @@ -/** - * RPL constants and prototypes - * +/* * Copyright (C) 2013 INRIA. * * This file is 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 net_rpl RPL - * @ingroup net - * @brief Routing Protocol for Low power and Lossy Networks + */ + +/** + * @defgroup net_rpl RPL + * @ingroup net + * @brief Routing Protocol for Low power and Lossy Networks * @{ - * @file rpl.h - * @brief RPL header - * @author Eric Engel - * @} + * + * @file rpl.h + * @brief RPL header + * + * @author Eric Engel */ +#ifndef __RPL_H +#define __RPL_H + #include #include #include @@ -51,3 +55,6 @@ void rpl_del_routing_entry(ipv6_addr_t *addr); rpl_routing_entry_t *rpl_find_routing_entry(ipv6_addr_t *addr); void rpl_clear_routing_table(void); rpl_routing_entry_t *rpl_get_routing_table(void); + +/** @} */ +#endif /* __RPL_H */ diff --git a/sys/net/sixlowpan/lowpan.h b/sys/net/sixlowpan/lowpan.h index 1299559e8c4c..873c1dadf8a2 100644 --- a/sys/net/sixlowpan/lowpan.h +++ b/sys/net/sixlowpan/lowpan.h @@ -1,22 +1,24 @@ /* - * 6LoWPAN constants, data structs, and prototypes - * * Copyright (C) 2013 INRIA. * * This file is 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 net_sixlowpan 6LoWPAN - * @ingroup net - * @brief Riots 6LowPAN implementation + */ + +/** + * @defgroup net_sixlowpan 6LoWPAN + * @ingroup net + * @brief Riots 6LowPAN implementation * @{ - * @file sixlowpan.h - * @brief 6lowpan header - * @author Stephan Zeisberg - * @author Martin Lenders - * @author Oliver Gesch - * @author Eric Engel + * + * @file sixlowpan.h + * @brief 6lowpan header + * + * @author Stephan Zeisberg + * @author Martin Lenders + * @author Oliver Gesch + * @author Eric Engel */ #ifndef _SIXLOWPAN_LOWPAN_H @@ -49,7 +51,5 @@ lowpan_context_t *lowpan_context_update(uint8_t num, lowpan_context_t *lowpan_context_get(void); lowpan_context_t *lowpan_context_num_lookup(uint8_t num); -/** - * @} - */ +/** @} */ #endif /* _SIXLOWPAN_LOWPAN_H */ From c629229e8d3ed982b37f1fa75cd454b3505a20dc Mon Sep 17 00:00:00 2001 From: Hauke Petersen Date: Thu, 28 Nov 2013 12:57:41 +0100 Subject: [PATCH 3/4] Added the boards folder to the doxygen tree - added boards to riot.doxyfile - fixed group definitions for all boards --- boards/avsextrem/include/board.h | 24 ++++++------ boards/chronos/include/board.h | 20 ++++++++++ boards/doc.txt | 16 ++++++++ boards/msb-430-common/include/board-conf.h | 20 ++++++++++ boards/msb-430/include/board.h | 34 ++++++++-------- boards/msb-430h/include/board.h | 29 +++++--------- boards/msba2-common/include/msba2_common.h | 25 ++++++------ boards/msba2/include/board.h | 20 ++++++++++ boards/native/include/board.h | 31 +++++++++------ boards/olimex_lpc2148/include/board.h | 26 +++++++++++++ boards/pttu/include/board.h | 25 ++++++------ boards/redbee-econotag/include/board.h | 24 +++++++++--- boards/telosb/include/board.h | 43 ++++++++++----------- boards/wsn430-common/include/board-conf.h | 21 +++++++--- boards/wsn430-v1_3b/include/board.h | 45 ++++++++++------------ boards/wsn430-v1_4/include/board.h | 45 ++++++++++------------ doc/doxygen/riot.doxyfile | 2 +- 17 files changed, 275 insertions(+), 175 deletions(-) create mode 100644 boards/doc.txt diff --git a/boards/avsextrem/include/board.h b/boards/avsextrem/include/board.h index 43703829425a..cd9d86cb45b0 100644 --- a/boards/avsextrem/include/board.h +++ b/boards/avsextrem/include/board.h @@ -1,23 +1,24 @@ /* -* board.h - Definitions for the AVSEXTREM board configuration. -* Copyright (C) 2013 Zakaria Kasmi -* -* This source code is licensed under the LGPLv2 license, -* See the file LICENSE for more details. -* -*/ + * Copyright (C) 2013 Zakaria Kasmi + * + * 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_ */ - diff --git a/boards/chronos/include/board.h b/boards/chronos/include/board.h index c07dd4f00e67..b89b2069dcfe 100644 --- a/boards/chronos/include/board.h +++ b/boards/chronos/include/board.h @@ -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 diff --git a/boards/doc.txt b/boards/doc.txt new file mode 100644 index 000000000000..a2ee0479428d --- /dev/null +++ b/boards/doc.txt @@ -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. + */ diff --git a/boards/msb-430-common/include/board-conf.h b/boards/msb-430-common/include/board-conf.h index 5a9d5b1dd0a5..c8dcdcfaac6e 100644 --- a/boards/msb-430-common/include/board-conf.h +++ b/boards/msb-430-common/include/board-conf.h @@ -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 diff --git a/boards/msb-430/include/board.h b/boards/msb-430/include/board.h index e7968f4499b1..1254cbde8180 100644 --- a/boards/msb-430/include/board.h +++ b/boards/msb-430/include/board.h @@ -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 * -

Compontents

-\li MSP430 -\li CC1100 - -* @{ -*/ - -/** - * @file - * @brief MSB-430H Board + *

Compontents

+ * \li MSP430 + * \li CC1100 + * + * @{ * - * @author Freie Universität Berlin, Computer Systems & Telematics, FeuerWhere project - * @version $Revision$ + * @file board.h + * @brief Central defnitions for the ScatterWeb MSB-430 board * - * @note $Id$ + * @author Freie Universität Berlin, Computer Systems & Telematics, FeuerWhere project */ +#ifndef _MSB_BOARD_H +#define _MSB_BOARD_H + #include "board-conf.h" //MSB430 core diff --git a/boards/msb-430h/include/board.h b/boards/msb-430h/include/board.h index fc086d53cb29..aa4e5f6179fe 100644 --- a/boards/msb-430h/include/board.h +++ b/boards/msb-430h/include/board.h @@ -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 + * @{ * -

Compontents

-\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 diff --git a/boards/msba2-common/include/msba2_common.h b/boards/msba2-common/include/msba2_common.h index 4e56c82ab758..147b924c4884 100644 --- a/boards/msba2-common/include/msba2_common.h +++ b/boards/msba2-common/include/msba2_common.h @@ -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 *******************************************************************************/ -#ifndef __MSBA2_COMMON_H -#define __MSBA2_COMMON_H - /** - * @ingroup msb_a2 + * @defgroup boards_msba2-common MSB-A2 common + * @ingroup boards + * @brief Common files for all MSB-A2 based boards * @{ - */ - -/** - * @file - * @brief MSB-A2 Common Board Definitions * - * @author Freie Universität Berlin, Computer Systems & Telematics, FeuerWhere project - * @author Kaspar Schleiser - * @version $Revision$ + * @files msba2-common.h + * @brief MSB-A2 Common Board Definitions * - * @note $Id$ + * @author Freie Universität Berlin, Computer Systems & Telematics, FeuerWhere project + * @author Kaspar Schleiser */ +#ifndef __MSBA2_COMMON_H +#define __MSBA2_COMMON_H + #include #include "lpc2387.h" diff --git a/boards/msba2/include/board.h b/boards/msba2/include/board.h index 829715b3c250..00cf16181c81 100644 --- a/boards/msba2/include/board.h +++ b/boards/msba2/include/board.h @@ -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 diff --git a/boards/native/include/board.h b/boards/native/include/board.h index 7c2c31daaeb9..4e3df1cdc0eb 100644 --- a/boards/native/include/board.h +++ b/boards/native/include/board.h @@ -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 boards_native Native Board + * @ingroup boards + * @brief Board emulation for the native port + * + * The native board uses call level hardware simulation * - * @defgroup native_board * @{ - * @file - * @author Ludwig Ortmann - * @} + * + * @file board.h + * @brief Basic definitions for the native board + * + * @author Ludwig Ortmann */ +#ifndef BOARD_H +#define BOARD_H + #include 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 */ diff --git a/boards/olimex_lpc2148/include/board.h b/boards/olimex_lpc2148/include/board.h index ff961ea36689..e7bee9b5f6f6 100644 --- a/boards/olimex_lpc2148/include/board.h +++ b/boards/olimex_lpc2148/include/board.h @@ -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 #include "lpc2148.h" typedef uint8_t radio_packet_length_t; + +/** @} */ +#endif /* __OLIMEX_LPC2148_H */ diff --git a/boards/pttu/include/board.h b/boards/pttu/include/board.h index ba7b3f42bfed..2ee3308f991d 100644 --- a/boards/pttu/include/board.h +++ b/boards/pttu/include/board.h @@ -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 * - * @author Freie Universität Berlin, Computer Systems & Telematics, FeuerWhere project - * @author Kaspar Schleiser - * @version $Revision$ + * @file board.h + * @brief Basic definitions for the PTTU board * - * @note $Id: board.h 664 2009-02-19 10:54:44Z baar $ + * @author Freie Universität Berlin, Computer Systems & Telematics, FeuerWhere project + * @author Kaspar Schleiser */ +#ifndef __BOARD_H +#define __BOARD_H + #include #include diff --git a/boards/redbee-econotag/include/board.h b/boards/redbee-econotag/include/board.h index bbcb2b07d329..95db044fef00 100644 --- a/boards/redbee-econotag/include/board.h +++ b/boards/redbee-econotag/include/board.h @@ -1,10 +1,22 @@ +/* + * Copyright (C) 2013 Thomas Eichinger + * + * 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 - * - * 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 + */ #ifndef REDBEE_ECONOTAG_BOARD_H #define REDBEE_ECONOTAG_BOARD_H diff --git a/boards/telosb/include/board.h b/boards/telosb/include/board.h index 55fd2a35b47d..d0d16bac46b0 100644 --- a/boards/telosb/include/board.h +++ b/boards/telosb/include/board.h @@ -1,33 +1,30 @@ -/** - * 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. - */ - -#ifndef _TELOSB_BOARD_H -#define _TELOSB_BOARD_H - -/** - * @defgroup TelosB - * @ingroup TelosB +/* + * Copyright (C) 2013 INRIA * -

Compontents

-\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 TelosB Board + * @defgroup boards_telosb TelosB + * @ingroup boards + * @brief Support for the TelosB board * - * @author Oliver Hahm + *

Compontents

+ * \li MSP430 + * \li CC2420 + * + * @{ * + * @file board.h + * @brief Basic definitions for the TelosB board + * + * @author Oliver Hahm */ +#ifndef _TELOSB_BOARD_H +#define _TELOSB_BOARD_H + //MSB430 core #define MSP430_INITIAL_CPU_SPEED 8000000uL #define MSP430_HAS_DCOR 0 diff --git a/boards/wsn430-common/include/board-conf.h b/boards/wsn430-common/include/board-conf.h index e54b3d58ebbc..aedd1542a961 100644 --- a/boards/wsn430-common/include/board-conf.h +++ b/boards/wsn430-common/include/board-conf.h @@ -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 */ diff --git a/boards/wsn430-v1_3b/include/board.h b/boards/wsn430-v1_3b/include/board.h index 9a23fdf8d7ae..5c32458ef6fa 100644 --- a/boards/wsn430-v1_3b/include/board.h +++ b/boards/wsn430-v1_3b/include/board.h @@ -1,36 +1,31 @@ -/** - * board.h - wsn430-v1_3b Board. - * Copyright (C) 2013 Milan Babel - * - * 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 * -

Compontents

-\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 + * + *

Compontents

+ * \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 - * @version $Revision$ - * - * @note $Id$ */ +#ifndef _WSN_BOARD_H +#define _WSN_BOARD_H + #include "board-conf.h" //MSB430 core diff --git a/boards/wsn430-v1_4/include/board.h b/boards/wsn430-v1_4/include/board.h index 092bc76998d9..8041896a8aaa 100644 --- a/boards/wsn430-v1_4/include/board.h +++ b/boards/wsn430-v1_4/include/board.h @@ -1,36 +1,31 @@ -/** - * board.h - wsn430-v1_4 Board. - * Copyright (C) 2013 Milan Babel - * - * 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 * -

Compontents

-\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 + * + *

Compontents

+ * \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 - * @version $Revision$ - * - * @note $Id$ */ +#ifndef _WSN_BOARD_H +#define _WSN_BOARD_H + #include "board-conf.h" //MSB430 core diff --git a/doc/doxygen/riot.doxyfile b/doc/doxygen/riot.doxyfile index 12277c9db088..ad4dc35dcd1d 100644 --- a/doc/doxygen/riot.doxyfile +++ b/doc/doxygen/riot.doxyfile @@ -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 From 2df82017a83c1e99c9954dcc4b93795fecec8ea9 Mon Sep 17 00:00:00 2001 From: Hauke Petersen Date: Thu, 28 Nov 2013 13:25:33 +0100 Subject: [PATCH 4/4] Fixed doxygen inconsistensies in sys --- core/bitarithm.c | 5 ----- core/oneway_malloc.c | 1 + sys/include/posix_io.h | 23 ++++++++++------------- sys/include/vtimer.h | 2 +- sys/net/include/sixlowpan.h | 28 +++++++++++++--------------- sys/net/include/sixlowpan/error.h | 21 ++++++++++----------- sys/net/include/sixlowpan/icmp.h | 29 ++++++++++++++--------------- sys/net/include/sixlowpan/ip.h | 30 +++++++++++++++--------------- sys/net/include/sixlowpan/lowpan.h | 29 ++++++++++++++--------------- sys/net/include/sixlowpan/mac.h | 28 ++++++++++++++-------------- sys/net/include/sixlowpan/ndp.h | 29 ++++++++++++++--------------- sys/net/include/sixlowpan/types.h | 28 ++++++++++++++-------------- sys/net/sixlowpan/lowpan.h | 4 ++-- sys/posix/doc.txt | 4 ++-- sys/posix/include/strings.h | 8 +++----- sys/posix/posix_io.c | 2 +- 16 files changed, 128 insertions(+), 143 deletions(-) diff --git a/core/bitarithm.c b/core/bitarithm.c index 265362fcf953..398c85f81510 100644 --- a/core/bitarithm.c +++ b/core/bitarithm.c @@ -9,15 +9,10 @@ /** * @ingroup core_util * @{ -<<<<<<< HEAD * * @file bitarithm.c * @brief Bit arithmetic helper functions implementation * -======= - * @file bitarithm.c - * @brief Bit arithmetic helper functions implementation ->>>>>>> 94fedda... Fixed a lot of comments by removing tabs and correcting format. * @author Kaspar Schleiser * @author Martin Lenders * diff --git a/core/oneway_malloc.c b/core/oneway_malloc.c index fb4e952a9699..e8bb8092c6af 100644 --- a/core/oneway_malloc.c +++ b/core/oneway_malloc.c @@ -8,6 +8,7 @@ * This file is 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. + */ /** * @ingroup core_util diff --git a/sys/include/posix_io.h b/sys/include/posix_io.h index cddba17396d2..3395c3f836e3 100644 --- a/sys/include/posix_io.h +++ b/sys/include/posix_io.h @@ -7,18 +7,16 @@ */ /** - * @defgroup sys_posixio Posix IO - * @ingroup sys - * @brief Posix compatible IO + * @ingroup sys_posix * @{ - * @file - * @brief POSIX-like IO + * @file posix_io.h + * @brief POSIX-like IO * - * @author Freie Universität Berlin - * @author Kaspar Schleiser - * @author Stephan Zeisberg - * @author Oliver Hahm - * @author Martin Lenders + * @author Freie Universität Berlin + * @author Kaspar Schleiser + * @author Stephan Zeisberg + * @author Oliver Hahm + * @author Martin Lenders */ #ifndef __READ_H #define __READ_H @@ -37,7 +35,6 @@ int posix_open(int pid, int flags); int posix_close(int pid); int posix_read(int pid, char *buffer, int bufsize); int posix_write(int pid, char *buffer, int bufsize); -/** - * @} - */ + +/** @} */ #endif /* __READ_H */ diff --git a/sys/include/vtimer.h b/sys/include/vtimer.h index d256a4612ea2..27e705b1139e 100644 --- a/sys/include/vtimer.h +++ b/sys/include/vtimer.h @@ -1,6 +1,6 @@ /** * @defgroup sys_vtimer Virtual (Software) Timer library - * @addtogroup sys + * @ingroup sys * @brief Virtual software timer for general timer functionality in applications * @{ * diff --git a/sys/net/include/sixlowpan.h b/sys/net/include/sixlowpan.h index 8c9dd92e724e..fafead8da556 100644 --- a/sys/net/include/sixlowpan.h +++ b/sys/net/include/sixlowpan.h @@ -1,7 +1,4 @@ -/** - * sixlowpan.h - Wraps all API types, constants and functions - * of 6LoWPAN concerning layers under 3. - * +/* * Copyright (C) 2013 INRIA. * * This file is subject to the terms and conditions of the GNU Lesser General @@ -10,11 +7,12 @@ */ /** - * @defgroup sixlowpan 6LoWPAN - * @ingroup net - * @brief 6LoWPAN module implements (parts of) the 6LoWPAN adaption layer - * for IPv6 over Low Power Wireless Personal Area Networks - * (6LoWPANs) + * @defgroup net_sixlowpan 6LoWPAN + * @ingroup net + * @brief 6LoWPAN module implements (parts of) the 6LoWPAN adaption layer + * for IPv6 over Low Power Wireless Personal Area Networks + * (6LoWPANs) + * * @see * RFC 4919 - IPv6 over Low-Power Wireless Personal Area * Networks (6LoWPANs): Overview, Assumptions, Problem @@ -34,9 +32,11 @@ * (6LoWPANs) * * @{ - * @file - * @brief 6lowpan link layer and lowpan functions - * @author Martin Lenders + * + * @file sixlowpan.h + * @brief 6lowpan link layer and lowpan functions + * + * @author Martin Lenders */ #ifndef SIXLOWPAN_H #define SIXLOWPAN_H @@ -46,7 +46,5 @@ #include "sixlowpan/lowpan.h" #include "sixlowpan/mac.h" -/** - * @} - */ +/** @} */ #endif /* SIXLOWPAN_H */ diff --git a/sys/net/include/sixlowpan/error.h b/sys/net/include/sixlowpan/error.h index e6dc9ecbe90f..16e6645ca375 100644 --- a/sys/net/include/sixlowpan/error.h +++ b/sys/net/include/sixlowpan/error.h @@ -1,18 +1,19 @@ -/** - * sixlowpan/error.h - 6LoWPAN error codes - * +/* * Copyright (C) 2013 INRIA. * * This file is 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. - * - * @ingroup sixlowpan + */ + +/** + * @ingroup net_sixlowpan * @{ - * @file - * @brief 6LoWPAN error codes + * + * @file sixlowpan/error.h + * @brief 6LoWPAN error codes + * * @author Martin Lenders - * @} */ #ifndef SIXLOWPAN_ERROR_H @@ -94,7 +95,5 @@ */ #define SIXLOWERROR_CSUM (141) -/** - * @} - */ +/** @} */ #endif /* SIXLOWPAN_ERROR_H */ diff --git a/sys/net/include/sixlowpan/icmp.h b/sys/net/include/sixlowpan/icmp.h index 391f314268b2..6aa417c66c5e 100644 --- a/sys/net/include/sixlowpan/icmp.h +++ b/sys/net/include/sixlowpan/icmp.h @@ -1,21 +1,22 @@ -/** - * sixlowpan/icmp.h - 6LoWPAN constants, data structs, and prototypes - * related to ICMP - * +/* * Copyright (C) 2013 INRIA. * * This file is 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. - * - * @ingroup sixlowpan + */ + +/** + * @ingroup net_sixlowpan * @{ - * @file - * @brief 6LoWPAN ICMP related header - * @author Stephan Zeisberg - * @author Martin Lenders - * @author Eric Engel - * @author Oliver Gesch + * + * @file sixlowpan/icmp.h + * @brief 6LoWPAN ICMP related header + * + * @author Stephan Zeisberg + * @author Martin Lenders + * @author Eric Engel + * @author Oliver Gesch */ #ifndef SIXLOWPAN_ICMP_H @@ -231,7 +232,5 @@ void icmpv6_send_neighbor_adv(ipv6_addr_t *src, ipv6_addr_t *dst, ipv6_addr_t *tgt, uint8_t rso, uint8_t sllao, uint8_t aro); -/** - * @} - */ +/** @} */ #endif /* SIXLOWPAN_ICMP_H */ diff --git a/sys/net/include/sixlowpan/ip.h b/sys/net/include/sixlowpan/ip.h index 16032b7a9ab8..56ac1c180f7d 100644 --- a/sys/net/include/sixlowpan/ip.h +++ b/sys/net/include/sixlowpan/ip.h @@ -1,21 +1,22 @@ -/** - * sixlowpan/ip.h - 6LoWPAN constants, data structs, and prototypes - * for network layer - * +/* * Copyright (C) 2013 INRIA. * * This file is 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. - * - * @ingroup sixlowpan + */ + +/** + * @ingroup net_sixlowpan * @{ - * @file - * @brief 6LoWPAN network layer header - * @author Stephan Zeisberg - * @author Martin Lenders - * @author Eric Engel - * @author Oliver Gesch + * + * @file sixlowpan/ip.h + * @brief 6LoWPAN constants, data structs, and prototypes for network layer + * + * @author Stephan Zeisberg + * @author Martin Lenders + * @author Eric Engel + * @author Oliver Gesch */ #ifndef SIXLOWPAN_IP_H @@ -384,7 +385,6 @@ void ipv6_iface_set_routing_provider(ipv6_addr_t *(*next_hop)(ipv6_addr_t* dest) * @return The IPv6 upper-layer checksum. */ uint16_t ipv6_csum(ipv6_hdr_t *ipv6_header, uint8_t *buf, uint16_t len, uint8_t proto); -/** - * @} - */ + +/** @} */ #endif /* SIXLOWPAN_IP_H */ diff --git a/sys/net/include/sixlowpan/lowpan.h b/sys/net/include/sixlowpan/lowpan.h index 13ea471f0c89..bc0a1bdac124 100644 --- a/sys/net/include/sixlowpan/lowpan.h +++ b/sys/net/include/sixlowpan/lowpan.h @@ -1,21 +1,22 @@ -/** - * sixlowpan/lowpan.h - 6LoWPAN constants, data structs, and - * prototypes for 6LoWPAN layer - * +/* * Copyright (C) 2013 INRIA. * * This file is 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. - * - * @ingroup sixlowpan + */ + +/** + * @ingroup net_sixlowpan * @{ - * @file - * @brief 6LoWPAN LoWPAN layer header - * @author Stephan Zeisberg - * @author Martin Lenders - * @author Eric Engel - * @author Oliver Gesch + * + * @file sixlowpan/lowpan.h + * @brief 6LoWPAN LoWPAN layer header + * + * @author Stephan Zeisberg + * @author Martin Lenders + * @author Eric Engel + * @author Oliver Gesch */ #ifndef SIXLOWPAN_LOWPAN_H @@ -271,7 +272,5 @@ void sixlowpan_lowpan_print_fifo_buffers(void); void sixlowpan_lowpan_print_reassembly_buffers(void); #endif -/** - * @} - */ +/** @} */ #endif /* SIXLOWPAN_LOWPAN_H */ diff --git a/sys/net/include/sixlowpan/mac.h b/sys/net/include/sixlowpan/mac.h index 690bd5999f2b..a09960d788f0 100644 --- a/sys/net/include/sixlowpan/mac.h +++ b/sys/net/include/sixlowpan/mac.h @@ -1,20 +1,22 @@ -/** - * sixlowpan/mac.h - 6LoWPAN data structs, and prototypes for MAC layer - * +/* * Copyright (C) 2013 INRIA. * * This file is 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. - * - * @ingroup sixlowpan + */ + +/** + * @ingroup net_sixlowpan * @{ - * @file - * @brief 6LoWPAN MAC layer header - * @author Stephan Zeisberg - * @author Martin Lenders - * @author Eric Engel - * @author Oliver Gesch + * + * @file sixlowpan/mac.h + * @brief 6LoWPAN data structs, and prototypes for MAC layer + * + * @author Stephan Zeisberg + * @author Martin Lenders + * @author Eric Engel + * @author Oliver Gesch */ #ifndef SIXLOWPAN_MAC_H @@ -105,7 +107,5 @@ void sixlowpan_mac_init(transceiver_type_t type); */ char *sixlowpan_mac_802154_long_addr_to_str(char *addr_str, const ieee_802154_long_t *laddr); -/** - * @} - */ +/** @} */ #endif /* SIXLOWPAN_MAC_H */ diff --git a/sys/net/include/sixlowpan/ndp.h b/sys/net/include/sixlowpan/ndp.h index 5cb7aca2fc1e..939844fa53bd 100644 --- a/sys/net/include/sixlowpan/ndp.h +++ b/sys/net/include/sixlowpan/ndp.h @@ -1,21 +1,22 @@ -/** - * sixlowpan/ndp.h - 6LoWPAN constants, data structs, and prototypes - * related to NDP - * +/* * Copyright (C) 2013 INRIA. * * This file is 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. - * - * @ingroup sixlowpan + */ + +/** + * @ingroup net_sixlowpan * @{ - * @file - * @brief 6LoWPAN NDP related header - * @author Stephan Zeisberg - * @author Martin Lenders - * @author Eric Engel - * @author Oliver Gesch + * + * @file sixlowpan/ndp.h + * @brief 6LoWPAN constants, data structs, and prototypes related to NDP + * + * @author Stephan Zeisberg + * @author Martin Lenders + * @author Eric Engel + * @author Oliver Gesch */ #ifndef SIXLOWPAN_NDP_H @@ -123,7 +124,5 @@ uint8_t ndp_prefix_list_search(ipv6_addr_t *addr); ndp_a6br_cache_t *ndp_a6br_cache_get_most_current(void); ndp_a6br_cache_t *ndp_a6br_cache_get_oldest(void); -/** - * @} - */ +/** @} */ #endif /* SIXLOWPAN_NDP_H */ diff --git a/sys/net/include/sixlowpan/types.h b/sys/net/include/sixlowpan/types.h index 8d9cd9724dde..879d8e5d1d22 100644 --- a/sys/net/include/sixlowpan/types.h +++ b/sys/net/include/sixlowpan/types.h @@ -1,20 +1,22 @@ -/** - * 6LoWPAN data types - * +/* * Copyright (C) 2013 INRIA. * * This file is 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. - * - * @ingroup sixlowpan + */ + +/** + * @ingroup net_sixlowpan * @{ - * @file sixlowpan/types.h - * @brief 6LoWPAN data types - * @author Stephan Zeisberg - * @author Martin Lenders - * @author Eric Engel - * @author Oliver Gesch + * + * @file sixlowpan/types.h + * @brief 6LoWPAN data types + * + * @author Stephan Zeisberg + * @author Martin Lenders + * @author Eric Engel + * @author Oliver Gesch */ #ifndef SIXLOWPAN_TYPES_H @@ -394,7 +396,5 @@ typedef enum __attribute__((packed)) { NDP_ADDR_STATE_ANY ///< addresses of this state are always permitted. } ndp_addr_state_t; -/** - * @} - */ +/** @} */ #endif /* SIXLOWPAN_TYPES_H */ diff --git a/sys/net/sixlowpan/lowpan.h b/sys/net/sixlowpan/lowpan.h index 873c1dadf8a2..d4bd59e7d8b0 100644 --- a/sys/net/sixlowpan/lowpan.h +++ b/sys/net/sixlowpan/lowpan.h @@ -9,10 +9,10 @@ /** * @defgroup net_sixlowpan 6LoWPAN * @ingroup net - * @brief Riots 6LowPAN implementation + * @brief RIOTs 6LowPAN implementation * @{ * - * @file sixlowpan.h + * @file lowpan.h * @brief 6lowpan header * * @author Stephan Zeisberg diff --git a/sys/posix/doc.txt b/sys/posix/doc.txt index 60e41b850de3..a2040a1b93cd 100644 --- a/sys/posix/doc.txt +++ b/sys/posix/doc.txt @@ -7,10 +7,10 @@ */ /** - * @defgroup posix POSIX wrapper of RIOT + * @defgroup sys_posix POSIX wrapper for RIOT * @brief POSIX header files * @see * The Open Group Specifications Issue 7 * - * @ingroup posix + * @ingroup sys */ diff --git a/sys/posix/include/strings.h b/sys/posix/include/strings.h index 7f08ea30a006..c1dc2095fdc9 100644 --- a/sys/posix/include/strings.h +++ b/sys/posix/include/strings.h @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2013 INRIA. * * This file is subject to the terms and conditions of the GNU Lesser General @@ -7,11 +7,9 @@ */ /** - * @addtogroup posix + * @ingroup sys_posix * @{ - */ - -/** + * * @file strings.h * @brief string operations * diff --git a/sys/posix/posix_io.c b/sys/posix/posix_io.c index efc731c9f091..4e78f54c5d2d 100644 --- a/sys/posix/posix_io.c +++ b/sys/posix/posix_io.c @@ -7,7 +7,7 @@ * Public License. See the file LICENSE in the top level directory for more * details. * - * @ingroup posix + * @ingroup sys_posix * @{ * @file posix_io.c * @brief Implementation of basic POSIX IO functionality.