diff --git a/native/board_config.c b/native/board_config.c index 317cdbb79e..dafdf747aa 100644 --- a/native/board_config.c +++ b/native/board_config.c @@ -1,12 +1,14 @@ /** * Native Board config.h implementation * + * No functionality implemented at the moment. + * * Copyright (C) 2013 Ludwig Ortmann * * This file subject to the terms and conditions of the GNU General Public * License. See the file LICENSE in the top level directory for more details. * - * @ingroup native + * @ingroup native_board * @{ * @file * @author Ludwig Ortmann @@ -18,12 +20,18 @@ #include +/** + * XXX: loading not implemented + */ void config_load(void) { printf("XXX: config_load(): not implemented\n"); return; } +/** + * XXX: storing not implemented + */ uint8_t config_save(void) { printf("XXX: config_save(): not implemented - your config will vanish on process termination\n"); diff --git a/native/board_init.c b/native/board_init.c index 9a3266703e..d6f4c4ba31 100644 --- a/native/board_init.c +++ b/native/board_init.c @@ -6,7 +6,7 @@ * This file subject to the terms and conditions of the GNU General Public * License. See the file LICENSE in the top level directory for more details. * - * @ingroup native + * @ingroup native_board * @{ * @file * @author Ludwig Ortmann @@ -15,6 +15,10 @@ #include "board.h" +/** + * Nothing to initialize at the moment. + * Turns the red LED on and the green LED off. + */ void board_init() { LED_GREEN_OFF(); diff --git a/native/include/board.h b/native/include/board.h index 71afb726ce..457289a566 100644 --- a/native/include/board.h +++ b/native/include/board.h @@ -1,12 +1,14 @@ /** * Native Board interface * + * The native board uses call level hardware simulation. + * * Copyright (C) 2013 Ludwig Ortmann * * This file subject to the terms and conditions of the GNU General Public * License. See the file LICENSE in the top level directory for more details. * - * @ingroup native + * @defgroup native_board * @{ * @file * @author Ludwig Ortmann diff --git a/native/native-led.c b/native/native-led.c index 2ee9d4979b..f2091c9a37 100644 --- a/native/native-led.c +++ b/native/native-led.c @@ -1,12 +1,14 @@ /** * Native Board LED implementation * + * Only prints function calls at the moment. + * * Copyright (C) 2013 Ludwig Ortmann * * This file subject to the terms and conditions of the GNU General Public * License. See the file LICENSE in the top level directory for more details. * - * @ingroup native + * @ingroup native_board * @{ * @file * @author Ludwig Ortmann diff --git a/native/native-ltc4150.c b/native/native-ltc4150.c index e18dee912d..99b4d0a3e5 100644 --- a/native/native-ltc4150.c +++ b/native/native-ltc4150.c @@ -1,16 +1,19 @@ /** * Native Board ltc4150_arch.h implementation * + * Only measures time at the moment. Uses POSIX real-time extension + * timer to generate periodic signal/interrupt. + * * Copyright (C) 2013 Ludwig Ortmann * * This file subject to the terms and conditions of the GNU General Public * License. See the file LICENSE in the top level directory for more details. * - * @ingroup native + * @ingroup native_board + * @ingroup ltc4150 * @{ * @file * @author Ludwig Ortmann - * @} */ #include @@ -29,24 +32,36 @@ static timer_t native_ltc4150_timer; static struct itimerspec native_ltc4150_timer_time; +/** + * unregister signal handler + */ void ltc4150_disable_int(void) { DEBUG("ltc4150_disable_int()\n"); unregister_interrupt(_SIG_LTC4150); } +/** + * register signal handler + */ void ltc4150_enable_int(void) { DEBUG("ltc4150_enable_int()\n"); register_interrupt(_SIG_LTC4150, ltc4150_interrupt); } +/** + * elaborate nop + */ void ltc4150_sync_blocking(void) { DEBUG("ltc4150_sync_blocking()\n"); for(int i = native_ltc4150_startup_delay; i>0; i--); } +/** + * set up posix real-time timer to simulate coloumb counter ticks + */ void ltc4150_arch_init(void) { struct sigevent sev; @@ -74,3 +89,4 @@ void ltc4150_arch_init(void) puts("Native LTC4150 initialized."); } +/** @} */