Fixed a lot of comments by removing tabs and correcting format.

This commit is contained in:
Hauke Petersen 2013-11-27 17:54:30 +01:00
parent 3785fe956b
commit edcabf7cb6
64 changed files with 734 additions and 765 deletions

View File

@ -9,10 +9,15 @@
/** /**
* @ingroup core_util * @ingroup core_util
* @{ * @{
<<<<<<< HEAD
* *
* @file bitarithm.c * @file bitarithm.c
* @brief Bit arithmetic helper functions implementation * @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 <kaspar.schleiser@fu-berlin.de> * @author Kaspar Schleiser <kaspar.schleiser@fu-berlin.de>
* @author Martin Lenders <mlenders@inf.fu-berlin.de> * @author Martin Lenders <mlenders@inf.fu-berlin.de>
* *

View File

@ -13,9 +13,9 @@
* @file config.h * @file config.h
* @brief Kernel configuration interface * @brief Kernel configuration interface
* *
* @author unknown
*/ */
#ifndef CONFIG_H #ifndef CONFIG_H
#define CONFIG_H #define CONFIG_H

View File

@ -122,12 +122,9 @@ void hwtimer_spin(unsigned long ticks);
int hwtimer_active(void); int hwtimer_active(void);
/** /** @} */
* @}
*/
/* internal */ /* internal */
/** /**
* @brief TODO * @brief TODO
* @internal * @internal

View File

@ -13,6 +13,7 @@
* @file lifo.h * @file lifo.h
* @brief LIFO buffer API * @brief LIFO buffer API
* *
* @author unknwon
*/ */
#ifndef __LIFO_H #ifndef __LIFO_H

View File

@ -13,8 +13,6 @@
* @file queue.h * @file queue.h
* @brief A simple queue implementation * @brief A simple queue implementation
* *
* TODO document functions and datastructures
*
* @author Freie Universität Berlin, Computer Systems & Telematics * @author Freie Universität Berlin, Computer Systems & Telematics
* @author Kaspar Schleiser <kaspar@schleiser.de> * @author Kaspar Schleiser <kaspar@schleiser.de>
*/ */

View File

@ -13,6 +13,9 @@
* @file lifo.c * @file lifo.c
* @brief LIFO buffer implementation * @brief LIFO buffer implementation
* *
* @file lifo.c
* @brief LIFO buffer implementation
* @author unknown
* @} * @}
*/ */

View File

@ -17,10 +17,10 @@
* @author Kaspar Schleiser <kaspar.schleiser@fu-berlin.de> * @author Kaspar Schleiser <kaspar.schleiser@fu-berlin.de>
* *
* @} * @}
*
* TODO: setup dependency from SCHEDSTATISTICS to MODULE_HWTIMER
*/ */
/* TODO: setup dependency from SCHEDSTATISTICS to MODULE_HWTIMER */
#include <stdint.h> #include <stdint.h>
#include <sched.h> #include <sched.h>
#include <kernel.h> #include <kernel.h>

View File

@ -15,11 +15,6 @@
* @author Heiko Will <heiko.will@fu-berlin.de> * @author Heiko Will <heiko.will@fu-berlin.de>
* @} * @}
*/ */
/**
*
*
*
*/
#include <stdio.h> #include <stdio.h>
#include "arm_cpu.h" #include "arm_cpu.h"

View File

@ -132,4 +132,3 @@ void msp430_cpu_init(void);
/** @} */ /** @} */
#endif // _CPU_H #endif // _CPU_H

View File

@ -1,8 +1,8 @@
/****************************************************************************** /*
* Copyright 2008, Freie Universitaet Berlin (FUB). All rights reserved. * Copyright 2008, Freie Universitaet Berlin (FUB). All rights reserved.
* *
* These sources were developed at the Freie Universitaet Berlin, Computer Systems * 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. * This file is part of RIOT.
* *
@ -20,20 +20,14 @@ and Telematics group (http://cst.mi.fu-berlin.de).
* <h3>Quick links</h3> * <h3>Quick links</h3>
* \li \ref cc1100_packet_layer0_t MAC packet format * \li \ref cc1100_packet_layer0_t MAC packet format
* *
* <hr>
* @{ * @{
*/ *
/**
* @file * @file
* @brief TI Chipcon CC110x radio driver * @brief TI Chipcon CC110x radio driver
* *
* @author Freie Universität Berlin, Computer Systems & Telematics * @author Freie Universität Berlin, Computer Systems & Telematics
* @author Thomas Hillebrandt <hillebra@inf.fu-berlin.de> * @author Thomas Hillebrandt <hillebra@inf.fu-berlin.de>
* @author Heiko Will <hwill@inf.fu-berlin.de> * @author Heiko Will <hwill@inf.fu-berlin.de>
* @version $Revision: 2128 $
*
* @note $Id: cc1100.h 2128 2010-05-12 12:07:59Z hillebra $
*/ */
#ifndef CC1100_H #ifndef CC1100_H
@ -332,5 +326,4 @@ void cc1100_reset_statistic(void);
/** @} */ /** @} */
/** @} */ /** @} */
#endif #endif

View File

@ -1,6 +1,4 @@
/** /*
* Default configuration for the cc110x chip
*
* Copyright (C) 2013 INRIA * Copyright (C) 2013 INRIA
* *
* This file is subject to the terms and conditions of the GNU Lesser General * This file is subject to the terms and conditions of the GNU Lesser General
@ -20,8 +18,6 @@
* @author Thomas Hillebrandt <hillebra@inf.fu-berlin.de> * @author Thomas Hillebrandt <hillebra@inf.fu-berlin.de>
* @author Heiko Will <hwill@inf.fu-berlin.de> * @author Heiko Will <hwill@inf.fu-berlin.de>
* @author Oliver Hahm <oliver.hahm@inria.fr> * @author Oliver Hahm <oliver.hahm@inria.fr>
*
* @note $Id: cc110x-defaultSettings.c 2058 2010-03-31 08:59:31Z hillebra $
* @} * @}
*/ */

View File

@ -12,9 +12,11 @@
* @{ * @{
* @file cc110x-rx.c * @file cc110x-rx.c
* @brief Functions for packet reception on cc110x * @brief Functions for packet reception on cc110x
*
* @author Oliver Hahm <oliver.hahm@inria.fr> * @author Oliver Hahm <oliver.hahm@inria.fr>
* @} * @}
*/ */
#include <cc110x_ng.h> #include <cc110x_ng.h>
#include <cc110x-internal.h> #include <cc110x-internal.h>
#include <cc110x-config.h> #include <cc110x-config.h>

View File

@ -12,6 +12,7 @@
* @{ * @{
* @file cc110x-tx.c * @file cc110x-tx.c
* @brief Functions for packet transmission on cc110x * @brief Functions for packet transmission on cc110x
*
* @author Oliver Hahm <oliver.hahm@inria.fr> * @author Oliver Hahm <oliver.hahm@inria.fr>
* @} * @}
*/ */

View File

@ -10,9 +10,9 @@
/** /**
* @ingroup drivers_cc110x_ng * @ingroup drivers_cc110x_ng
* @{ * @{
*
* @file cc110x.c * @file cc110x.c
* @brief Basic functionality of cc110x driver * @brief Basic functionality of cc110x driver
*
* @author Oliver Hahm <oliver.hahm@inria.fr> * @author Oliver Hahm <oliver.hahm@inria.fr>
* @} * @}
*/ */

View File

@ -1,8 +1,8 @@
/****************************************************************************** /*
* Copyright 2008, Freie Universitaet Berlin (FUB). All rights reserved. * Copyright 2008, Freie Universitaet Berlin (FUB). All rights reserved.
* *
* These sources were developed at the Freie Universitaet Berlin, Computer Systems * 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. * This file is part of RIOT.
* *
@ -21,10 +21,8 @@ and Telematics group (http://cst.mi.fu-berlin.de).
* *
* @author Freie Universität Berlin, Computer Systems & Telematics * @author Freie Universität Berlin, Computer Systems & Telematics
* @author Heiko Will <hwill@inf.fu-berlin.de> * @author Heiko Will <hwill@inf.fu-berlin.de>
* @version $Revision: 1775 $
*
* @note $Id: arch_cc110x.h 1775 2010-01-26 09:37:03Z hillebra $
*/ */
#ifndef __CC1100_ARCH_H #ifndef __CC1100_ARCH_H
#define __CC1100_ARCH_H #define __CC1100_ARCH_H

View File

@ -1,17 +1,19 @@
/** /*
* Configuration parameters for the cc110x radio chip
*
* Copyright (C) 2009 Freie Universität Berlin * Copyright (C) 2009 Freie Universität Berlin
* Copyright (C) 2013 INRIA * Copyright (C) 2013 INRIA
* *
* This file is subject to the terms and conditions of the GNU Lesser General * 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 * Public License. See the file LICENSE in the top level directory for more
* details. * details.
* */
/**
* @ingroup drivers_cc110x_ng * @ingroup drivers_cc110x_ng
* @{ * @{
* *
* @file cc110x-config.h * @file cc110x-config.h
* @brief Configuration parameters for the cc110x radio chip
*
* @author Oliver Hahm <oliver.hahm@inria.fr> * @author Oliver Hahm <oliver.hahm@inria.fr>
*/ */
#ifndef CC1100_CONFIG_H #ifndef CC1100_CONFIG_H

View File

@ -18,18 +18,13 @@ and Telematics group (http://cst.mi.fu-berlin.de).
/** /**
* @ingroup drivers_cc110x_ng * @ingroup drivers_cc110x_ng
* @{ * @{
*/ *
/**
* @file * @file
* @brief TI Chipcon CC110x default settings * @brief TI Chipcon CC110x default settings
* *
* @author Freie Universität Berlin, Computer Systems & Telematics * @author Freie Universität Berlin, Computer Systems & Telematics
* @author Thomas Hillebrandt <hillebra@inf.fu-berlin.de> * @author Thomas Hillebrandt <hillebra@inf.fu-berlin.de>
* @author Heiko Will <hwill@inf.fu-berlin.de> * @author Heiko Will <hwill@inf.fu-berlin.de>
* @version $Revision: 2139 $
*
* @note $Id: cc110x-defaultSettings.h 2139 2010-05-26 08:04:04Z hillebra $
*/ */
#include <stdint.h> #include <stdint.h>

View File

@ -11,7 +11,7 @@
* @ingroup drivers_cc110x_ng * @ingroup drivers_cc110x_ng
* @{ * @{
* *
* @file * @file cc110x-internal.h
* @brief Driver internal constants for 110x chip configuration * @brief Driver internal constants for 110x chip configuration
* *
* @author Freie Universität Berlin, Computer Systems & Telematics * @author Freie Universität Berlin, Computer Systems & Telematics
@ -19,6 +19,7 @@
* @author Heiko Will <hwill@inf.fu-berlin.de> * @author Heiko Will <hwill@inf.fu-berlin.de>
* @author Oliver Hahm <oliver.hahm@inria.fr> * @author Oliver Hahm <oliver.hahm@inria.fr>
*/ */
#ifndef CC1100_INTERNAL_H #ifndef CC1100_INTERNAL_H
#define CC1100_INTERNAL_H #define CC1100_INTERNAL_H

View File

@ -17,6 +17,7 @@
* @author INRIA * @author INRIA
* @author Oliver Hahm <oliver.hahm@inria.fr> * @author Oliver Hahm <oliver.hahm@inria.fr>
*/ */
#ifndef __CC110X_REG_H #ifndef __CC110X_REG_H
#define __CC110X_REG_H #define __CC110X_REG_H

View File

@ -12,10 +12,13 @@
* @brief Next generation version of the TI CC110x driver * @brief Next generation version of the TI CC110x driver
* @ingroup drivers * @ingroup drivers
* @{ * @{
*
* @file cc110x_ng.h * @file cc110x_ng.h
* @brief Data structures and variables for the cc110x driver interface * @brief Data structures and variables for the cc110x driver interface
*
* @author Oliver Hahm <oliver.hahm@inria.fr> * @author Oliver Hahm <oliver.hahm@inria.fr>
*/ */
#ifndef CC1100_H #ifndef CC1100_H
#define CC1100_H #define CC1100_H
@ -168,8 +171,5 @@ void cc110x_init_ignore(void);
uint8_t cc110x_add_ignored(radio_address_t addr); uint8_t cc110x_add_ignored(radio_address_t addr);
#endif #endif
/** /** @} */
* @}
*/
#endif #endif

View File

@ -15,18 +15,13 @@ and Telematics group (http://cst.mi.fu-berlin.de).
/** /**
* @ingroup drivers_cc110x_ng * @ingroup drivers_cc110x_ng
* @{ * @{
*/ *
/**
* @file * @file
* @brief TI Chipcon CC1100 SPI driver * @brief TI Chipcon CC1100 SPI driver
* *
* @author Freie Universität Berlin, Computer Systems & Telematics * @author Freie Universität Berlin, Computer Systems & Telematics
* @author Thomas Hillebrandt <hillebra@inf.fu-berlin.de> * @author Thomas Hillebrandt <hillebra@inf.fu-berlin.de>
* @author Heiko Will <hwill@inf.fu-berlin.de> * @author Heiko Will <hwill@inf.fu-berlin.de>
* @version $Revision: 1775 $
*
* @note $Id: cc110x_spi.h 1775 2010-01-26 09:37:03Z hillebra $
*/ */
#ifndef CC1100_SPI_H_ #ifndef CC1100_SPI_H_

View File

@ -1,8 +1,8 @@
/****************************************************************************** /*
* Copyright 2008, Freie Universitaet Berlin (FUB). All rights reserved. * Copyright 2008, Freie Universitaet Berlin (FUB). All rights reserved.
* *
* These sources were developed at the Freie Universitaet Berlin, Computer Systems * 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. * This file is part of RIOT.
* *
@ -15,18 +15,14 @@ and Telematics group (http://cst.mi.fu-berlin.de).
/** /**
* @ingroup drivers_cc110x_ng * @ingroup drivers_cc110x_ng
* @{ * @{
*/ *
* @file cc110x_spi.c
/**
* @file
* @brief TI Chipcon CC1100 SPI driver * @brief TI Chipcon CC1100 SPI driver
* *
* @author Freie Universität Berlin, Computer Systems & Telematics * @author Freie Universität Berlin, Computer Systems & Telematics
* @author Thomas Hillebrandt <hillebra@inf.fu-berlin.de> * @author Thomas Hillebrandt <hillebra@inf.fu-berlin.de>
* @author Heiko Will <hwill@inf.fu-berlin.de> * @author Heiko Will <hwill@inf.fu-berlin.de>
* @version $Revision: 1775 $ * @}
*
* @note $Id: cc110x_spi.c 1775 2010-01-26 09:37:03Z hillebra $
*/ */
#include <stdio.h> #include <stdio.h>
@ -125,5 +121,3 @@ uint8_t cc110x_strobe(uint8_t c)
restoreIRQ(cpsr); restoreIRQ(cpsr);
return result; return result;
} }
/** @} */

View File

@ -1,15 +1,17 @@
#ifndef ADC_H
#define ADC_H
#include <stdint.h>
/** /**
* @defgroup drivers_adc ADC * @defgroup drivers_adc ADC
* @ingroup drivers * @ingroup drivers
* @brief Generic ADC driver * @brief Generic ADC driver
* @{
*
* @file adc.h
*/ */
#ifndef ADC_H
#define ADC_H
#include <stdint.h>
/** /**
* @brief Initialize ADC. * @brief Initialize ADC.
*/ */
@ -24,4 +26,5 @@ void adc_init(void);
*/ */
uint16_t adc_read(uint8_t channel); uint16_t adc_read(uint8_t channel);
/** @} */
#endif /* ADC_H */ #endif /* ADC_H */

View File

@ -8,6 +8,12 @@
* @brief Low level disk interface * @brief Low level disk interface
* *
* The connection between the MCU and the SRF08 is based on the i2c-interface. * The connection between the MCU and the SRF08 is based on the i2c-interface.
*
* @{
*
* @file diskio.h
*
* @author unknown
*/ */
#ifndef DEF_DISKIO #ifndef DEF_DISKIO
@ -111,5 +117,5 @@ DRESULT MCI_write(const unsigned char *, unsigned long, unsigned char);
DRESULT MCI_ioctl(unsigned char, void *); DRESULT MCI_ioctl(unsigned char, void *);
void MCI_timerproc(void); void MCI_timerproc(void);
/** @} */
#endif #endif

View File

@ -1,10 +1,12 @@
/*
/**
* @defgroup flashrom Flash memory driver * @defgroup flashrom Flash memory driver
* @ingroup drivers * @ingroup drivers
* @brief Generic flash memory driver * @brief Generic flash memory driver
* @{
*
* @file flashrom.h
*
* @author unknown
*/ */
#ifndef FLASHROM_H #ifndef FLASHROM_H
@ -32,5 +34,5 @@ uint8_t flashrom_erase(uint8_t *addr);
*/ */
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 */ #endif /* FLASHROM_H */

View File

@ -1,4 +1,4 @@
/****************************************************************************** /*
* Copyright 2009, Freie Universitaet Berlin (FUB). All rights reserved. * Copyright 2009, Freie Universitaet Berlin (FUB). All rights reserved.
* *
* These sources were developed at the Freie Universitaet Berlin, Computer Systems * These sources were developed at the Freie Universitaet Berlin, Computer Systems
@ -25,23 +25,16 @@ and Telematics group (http://cst.mi.fu-berlin.de).
* See gpioint-example.c for an example of how to use gpioint. * See gpioint-example.c for an example of how to use gpioint.
* *
* @{ * @{
*/ *
/**
* @example gpioint-example.c * @example gpioint-example.c
* This example shows how to setup an interrupt handler for a GPIO pin * This example shows how to setup an interrupt handler for a GPIO pin
* without using the HAL. * without using the HAL.
*/ *
/**
* @file * @file
* @brief GPIO IRQ Multiplexer interface * @brief GPIO IRQ Multiplexer interface
* *
* @author Freie Universität Berlin, Computer Systems & Telematics * @author Freie Universität Berlin, Computer Systems & Telematics
* @author Michael Baar <michael.baar@fu-berlin.de> * @author Michael Baar <michael.baar@fu-berlin.de>
* @version $Revision: 1508 $
*
* @note $Id: gpioint.h 1508 2009-10-26 15:10:02Z baar $
*/ */
#include <stdint.h> #include <stdint.h>

View File

@ -1,7 +1,4 @@
/* /*
* lm75a-temp-sensor.h - Definitions of the LM75A temperature sensor driver.
*
* Copyright (C) 2013 Zakaria Kasmi <zkasmi@inf.fu-berlin.de> * Copyright (C) 2013 Zakaria Kasmi <zkasmi@inf.fu-berlin.de>
* *
* This source code is licensed under the LGPLv2 license, * This source code is licensed under the LGPLv2 license,
@ -14,21 +11,17 @@
* @brief Driver for the LM75A digital temperature sensor and thermal watchdog * @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. * The connection between the MCU and the LM75A is based on the i2c-interface.
*/ *
* @{
/** *
* @file * @file
* @internal * @internal
* @brief Definitions of the LM75A temperature sensor driver. * @brief Definitions of the LM75A temperature sensor driver.
* *
* The connection between the LM75A and the MCU is based * The connection between the LM75A and the MCU is based on the I2C-interface.
* on the I2C-interface.
* *
* @author Freie Universität Berlin, Computer Systems & Telematics * @author Freie Universität Berlin, Computer Systems & Telematics
* @author Zakaria Kasmi <zkasmi@inf.fu-berlin.de> * @author Zakaria Kasmi <zkasmi@inf.fu-berlin.de>
* @version $Revision: 3859 $
*
* @note $Id: lm75a-temp-sensor.h 3854 2013-09-2 15:35:21 kasmi $
*/ */
#ifndef LM75A_H_ #ifndef LM75A_H_
@ -260,4 +253,5 @@ bool lm75A_external_interrupt_register(void *handler);
*/ */
void lm75A_set_in_alarm(bool b); void lm75A_set_in_alarm(bool b);
/** @} */
#endif /* LM75A_H_ */ #endif /* LM75A_H_ */

View File

@ -20,17 +20,12 @@ and Telematics group (http://cst.mi.fu-berlin.de).
* @ingroup drivers * @ingroup drivers
* @brief Driver for the Linear Technology LTC4150 Coulomb Counter * @brief Driver for the Linear Technology LTC4150 Coulomb Counter
* @{ * @{
*/ *
* @file ltc4150_arch.h
/**
* @file
* @brief LTC4150 Coulomb Counter * @brief LTC4150 Coulomb Counter
* *
* @author Freie Universität Berlin, Computer Systems & Telematics * @author Freie Universität Berlin, Computer Systems & Telematics
* @author Heiko Will * @author Heiko Will
* @version $Revision: 1203 $
*
* @note $Id: ltc4150_arch.h 1203 2009-07-07 10:23:18Z baar $
*/ */
#define _GFH (double)32.631375 #define _GFH (double)32.631375

View File

@ -1,4 +1,4 @@
/****************************************************************************** /*
* Copyright 2010, Freie Universitaet Berlin (FUB). All rights reserved. * Copyright 2010, Freie Universitaet Berlin (FUB). All rights reserved.
* *
* These sources were developed at the Freie Universitaet Berlin, Computer Systems * These sources were developed at the Freie Universitaet Berlin, Computer Systems
@ -66,5 +66,5 @@ time_t rtc_time(struct timeval *time);
extern int rtc_second_pid; extern int rtc_second_pid;
#endif
/** @} */ /** @} */
#endif

View File

@ -19,17 +19,13 @@ and Telematics group (http://cst.mi.fu-berlin.de).
* @defgroup sht11 SHT11 * @defgroup sht11 SHT11
* @ingroup drivers * @ingroup drivers
* @{ * @{
*/ *
* @file sht11.h
/**
* @file
* @brief SHT11 Device Driver * @brief SHT11 Device Driver
* *
* @author Freie Universität Berlin, Computer Systems & Telematics * @author Freie Universität Berlin, Computer Systems & Telematics
* @version $Revision: 667 $
*
* @note $Id: sht11.h 667 2009-02-19 15:06:38Z baar $
*/ */
#include <stdint.h> #include <stdint.h>
#define SHT11_NO_ACK (0) #define SHT11_NO_ACK (0)
@ -107,4 +103,3 @@ uint8_t sht11_read_status(uint8_t *p_value, uint8_t *p_checksum);
/** @} */ /** @} */
#endif /*SHT11_H_*/ #endif /*SHT11_H_*/

View File

@ -1,7 +1,4 @@
/* /*
* srf02-ultrasonic-sensor.h - Definitions for the SRF02 ultrasonic ranger
* driver.
*
* Copyright (C) 2013 Zakaria Kasmi <zkasmi@inf.fu-berlin.de> * Copyright (C) 2013 Zakaria Kasmi <zkasmi@inf.fu-berlin.de>
* *
* This source code is licensed under the LGPLv2 license, * This source code is licensed under the LGPLv2 license,
@ -14,21 +11,16 @@
* @brief Driver for the SRF02 ultrasonic range sensor * @brief Driver for the SRF02 ultrasonic range sensor
* *
* The connection between the MCU and the SRF08 is based on the i2c-interface. * The connection between the MCU and the SRF08 is based on the i2c-interface.
*/ *
* @{
/** *
* @file * @file srf02-ultrasonic-sensor.h
* @internal
* @brief Driver definitions for the SRF02 ultrasonic ranger. * @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 Freie Universität Berlin, Computer Systems & Telematics
* @author Zakaria Kasmi <zkasmi@inf.fu-berlin.de> * @author Zakaria Kasmi <zkasmi@inf.fu-berlin.de>
* @version $Revision: 3857 $
*
* @note $Id: srf02-ultrasonic-sensor.h 3854 2013-09-03 13:55:30 kasmi $
*
*/ */
#ifndef SRF02_ULTRASONIC_SENSOR_I2C_H_ #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); void srf02_start_ranging(uint16_t ranging_mode);
/** @} */
#endif /* SRF02_ULTRASONIC_SENSOR_I2C_H_ */ #endif /* SRF02_ULTRASONIC_SENSOR_I2C_H_ */

View File

@ -1,6 +1,4 @@
/* /*
* srf08-ultrasonic-sensor.h - Definitions for the SRF08 ultrasonic ranger.
*
* Copyright (C) 2013 Zakaria Kasmi <zkasmi@inf.fu-berlin.de> * Copyright (C) 2013 Zakaria Kasmi <zkasmi@inf.fu-berlin.de>
* *
* This source code is licensed under the LGPLv2 license, * This source code is licensed under the LGPLv2 license,
@ -13,21 +11,17 @@
* @brief Driver for the SRF08 ultrasonic range sensor * @brief Driver for the SRF08 ultrasonic range sensor
* *
* The connection between the MCU and the SRF08 is based on the i2c-interface. * The connection between the MCU and the SRF08 is based on the i2c-interface.
*/ *
* @{
/** *
* @file * @file
* @internal * @internal
* @brief Driver definitions for the SRF08 ultrasonic. * @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 Freie Universität Berlin, Computer Systems & Telematics
* @author Zakaria Kasmi <zkasmi@inf.fu-berlin.de> * @author Zakaria Kasmi <zkasmi@inf.fu-berlin.de>
* @version $Revision: 3857 $
*
* @note $Id: srf08-ultrasonic-sensor.h 3854 2013-09-03 16:26:13 kasmi $
*
*/ */
#ifndef SRF08_ULTRASONIC_SENSOR_I2C_H_ #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); int32_t srf08_get_distances(uint32_t *range_array, uint8_t ranging_mode);
/** @} */
#endif /* SRF08_ULTRASONIC_SENSOR_I2C_H_ */ #endif /* SRF08_ULTRASONIC_SENSOR_I2C_H_ */

View File

@ -3,6 +3,9 @@
* @defgroup sys_autoinit Auto-init * @defgroup sys_autoinit Auto-init
* @ingroup sys * @ingroup sys
* @brief Autoconfigure libraries * @brief Autoconfigure libraries
* @{
*
* @file auto_init.h
*/ */
#ifndef AUTO_INIT_H #ifndef AUTO_INIT_H
@ -30,4 +33,5 @@
void auto_init(void); void auto_init(void);
#endif /** @} */
#endif /* AUTO_INIT_H */

View File

@ -1,11 +1,4 @@
/*
/**
* @defgroup sys_bloom Bloom filter
* @ingroup sys
* @brief Bloom filter library
*/
/**
* bloom.c * bloom.c
* *
* Bloom filters * 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 <mehlis@inf.fu-berlin.de> * @autor Christian Mehlis <mehlis@inf.fu-berlin.de>
* @autor Freie Universität Berlin, Computer Systems & Telematics * @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); bool bloom_check(struct bloom_t *bloom, const uint8_t *buf, size_t len);
#endif /** @} */
#endif /* _BLOOM_FILTER_H */

View File

@ -3,6 +3,10 @@
* @defgroup sys_uart0 UART0 * @defgroup sys_uart0 UART0
* @ingroup sys * @ingroup sys
* @brief UART0 interface abstraction * @brief UART0 interface abstraction
* @{
*
* @file board_uart0.h
* @brief Interface definitions for the UART0 abstraction
*/ */
#ifndef __BOARD_UART0_H #ifndef __BOARD_UART0_H
@ -17,4 +21,5 @@ void uart0_notify_thread(void);
int uart0_readc(void); int uart0_readc(void);
void uart0_putc(int c); void uart0_putc(int c);
/** @} */
#endif /* __BOARD_UART0_H */ #endif /* __BOARD_UART0_H */

View File

@ -1,6 +1,4 @@
/** /*
* This file contains some simple hash function
*
* Copyright (C) 2013 Freie Universität Berlin * Copyright (C) 2013 Freie Universität Berlin
* *
* This file is subject to the terms and conditions of the GNU Lesser General * This file is subject to the terms and conditions of the GNU Lesser General
@ -12,15 +10,19 @@
* @defgroup sys_hashes Hashes * @defgroup sys_hashes Hashes
* @ingroup sys * @ingroup sys
* @brief Hash function library * @brief Hash function library
*/ * @{
*
/** * @file hashes.h
* @file * @brief Hash function API
*
* @autor Jason Linehan <patientulysses@gmail.com> * @autor Jason Linehan <patientulysses@gmail.com>
* @author Freie Universität Berlin, Computer Systems & Telematics * @author Freie Universität Berlin, Computer Systems & Telematics
* @author Christian Mehlis <mehlis@inf.fu-berlin.de> * @author Christian Mehlis <mehlis@inf.fu-berlin.de>
*/ */
#ifndef __HASHES_H
#define __HASHES_H
#include <stddef.h> #include <stddef.h>
#include <inttypes.h> #include <inttypes.h>
@ -153,3 +155,6 @@ uint32_t rotating_hash(const uint8_t *buf, size_t len);
* @return 32 bit sized hash * @return 32 bit sized hash
*/ */
uint32_t one_at_a_time_hash(const uint8_t *buf, size_t len); uint32_t one_at_a_time_hash(const uint8_t *buf, size_t len);
/** @} */
#endif /* __HASHES_H */

View File

@ -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 * The vtimer library provides functions for setting, resetting and restarting
* software timers, and for checking if a vtimer has expired. * software timers, and for checking if a vtimer has expired.
* *
* (As of now, not resetting, restarting, removing and checking are not implemented) * (As of now, not resetting, restarting, removing and checking are not implemented)
* *
* @{ * @author unknown
*/ */
/**
* \file
* Timer library header file.
*/
#ifndef __VTIMER_H #ifndef __VTIMER_H
#define __VTIMER_H #define __VTIMER_H
@ -120,4 +119,5 @@ void vtimer_print_long_queue(void);
#endif #endif
/** @} */
#endif /* __VTIMER_H */ #endif /* __VTIMER_H */

View File

@ -1,21 +1,22 @@
/** /*
* Data struct and prototypes for the IEEE 802.15.4 frame format
*
* Copyright (C) 2013 INRIA. * Copyright (C) 2013 INRIA.
* *
* This file is subject to the terms and conditions of the GNU Lesser General * 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 * Public License. See the file LICENSE in the top level directory for more
* details. * details.
* */
/**
* @defgroup net_ieee802154 IEEE802.15.4 * @defgroup net_ieee802154 IEEE802.15.4
* @ingroup net * @ingroup net
* @brief IEEE802.15.4 adapaption layer * @brief IEEE802.15.4 adapaption layer
* @{ * @{
*
* @file ieee802154/ieee802154_frame.h * @file ieee802154/ieee802154_frame.h
* @brief IEEE 802.14.4 framing data structs and prototypes * @brief IEEE 802.14.4 framing data structs and prototypes
*
* @author Stephan Zeisberg <zeisberg@mi.fu-berlin.de> * @author Stephan Zeisberg <zeisberg@mi.fu-berlin.de>
* @author Oliver Hahm <oliver.hahm@inria.fr> * @author Oliver Hahm <oliver.hahm@inria.fr>
* @}
*/ */
#ifndef IEEE802154_IEEE802154_FRAME #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_init(ieee802154_frame_t *frame, uint8_t *buf);
uint8_t ieee802154_frame_get_hdr_len(ieee802154_frame_t *frame); 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 ieee802154_frame_read(uint8_t *buf, ieee802154_frame_t *frame, uint8_t len);
uint8_t len);
void ieee802154_frame_print_fcf_frame(ieee802154_frame_t *frame); void ieee802154_frame_print_fcf_frame(ieee802154_frame_t *frame);
/** @} */
#endif /* IEEE802154_IEEE802154_FRAME */ #endif /* IEEE802154_IEEE802154_FRAME */

View File

@ -1,18 +1,17 @@
/*
* common.h
*
* Created on: 05.10.2011
* Author: Oliver
*/
/** /**
* @defgroup net_help Net help * @defgroup net_help Net help
* @ingroup net * @ingroup net
* @brief Helper functions for networking as byte order conversions and checksum calculations * @brief Helper functions for networking as byte order conversions and checksum calculations
* @{
*
* @file net_help.h
*
* @author Oliver
*/ */
#ifndef COMMON_H_ #ifndef __NET_HELP_H
#define COMMON_H_ #define __NET_HELP_H
#include <string.h> #include <string.h>
#include <stdint.h> #include <stdint.h>
@ -30,4 +29,5 @@
uint16_t csum(uint16_t sum, uint8_t *buf, uint16_t len); uint16_t csum(uint16_t sum, uint8_t *buf, uint16_t len);
void printArrayRange(uint8_t *array, uint16_t len, char *str); void printArrayRange(uint8_t *array, uint16_t len, char *str);
#endif /* COMMON_H_ */ /** @} */
#endif /* __NET_HELP_H */

View File

@ -1,8 +1,8 @@
/****************************************************************************** /*
* Copyright 2009, Freie Universitaet Berlin (FUB). All rights reserved. * Copyright 2009, Freie Universitaet Berlin (FUB). All rights reserved.
* *
* These sources were developed at the Freie Universitaet Berlin, Computer Systems * 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. * This file is part of RIOT.
* *
@ -12,30 +12,25 @@ and Telematics group (http://cst.mi.fu-berlin.de).
* *
*******************************************************************************/ *******************************************************************************/
#ifndef PROTOCOLMULTIPLEX_H_
#define PROTOCOLMULTIPLEX_H_
/** /**
* @defgroup net_mmstack Protocol multiplex * @defgroup net_mmstack Protocol multiplex
* @ingroup net * @ingroup net
* @brief Protocol handler multiplexing * @brief Protocol handler multiplexing
* @{ * @{
*/ *
/**
* @file * @file
* @internal
* @brief Protocol handler multiplexing * @brief Protocol handler multiplexing
* *
* @author Freie Universität Berlin, Computer Systems & Telematics * @author Freie Universität Berlin, Computer Systems & Telematics
* @author Thomas Hillebrandt <hillebra@inf.fu-berlin.de> * @author Thomas Hillebrandt <hillebra@inf.fu-berlin.de>
* @author Heiko Will <hwill@inf.fu-berlin.de> * @author Heiko Will <hwill@inf.fu-berlin.de>
* @author Michael Baar <baar@inf.fu-berlin.de> * @author Michael Baar <baar@inf.fu-berlin.de>
* @version $Revision: 1526 $
*
* @note $Id: protocol-multiplex.h 1526 2009-10-30 13:40:20Z hillebra $
*/ */
#ifndef PROTOCOLMULTIPLEX_H_
#define PROTOCOLMULTIPLEX_H_
#include "radio/types.h" #include "radio/types.h"
typedef struct { typedef struct {
@ -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); int pm_invoke(const pm_table_t *table, protocol_t protocol, void *payload, int payload_size, packet_info_t *packet_info);
/** @} */ /** @} */
#endif /* PROTOCOLMULTIPLEX_H_ */ #endif /* PROTOCOLMULTIPLEX_H_ */

View File

@ -1,22 +1,26 @@
/** /*
* RPL constants and prototypes
*
* Copyright (C) 2013 INRIA. * Copyright (C) 2013 INRIA.
* *
* This file is subject to the terms and conditions of the GNU Lesser General * 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 * Public License. See the file LICENSE in the top level directory for more
* details. * details.
* */
/**
* @defgroup net_rpl RPL * @defgroup net_rpl RPL
* @ingroup net * @ingroup net
* @brief Routing Protocol for Low power and Lossy Networks * @brief Routing Protocol for Low power and Lossy Networks
* @{ * @{
*
* @file rpl.h * @file rpl.h
* @brief RPL header * @brief RPL header
*
* @author Eric Engel <eric.engel@fu-berlin.de> * @author Eric Engel <eric.engel@fu-berlin.de>
* @}
*/ */
#ifndef __RPL_H
#define __RPL_H
#include <string.h> #include <string.h>
#include <stdint.h> #include <stdint.h>
#include <vtimer.h> #include <vtimer.h>
@ -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); rpl_routing_entry_t *rpl_find_routing_entry(ipv6_addr_t *addr);
void rpl_clear_routing_table(void); void rpl_clear_routing_table(void);
rpl_routing_entry_t *rpl_get_routing_table(void); rpl_routing_entry_t *rpl_get_routing_table(void);
/** @} */
#endif /* __RPL_H */

View File

@ -1,18 +1,20 @@
/* /*
* 6LoWPAN constants, data structs, and prototypes
*
* Copyright (C) 2013 INRIA. * Copyright (C) 2013 INRIA.
* *
* This file is subject to the terms and conditions of the GNU Lesser General * 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 * Public License. See the file LICENSE in the top level directory for more
* details. * details.
* */
/**
* @defgroup net_sixlowpan 6LoWPAN * @defgroup net_sixlowpan 6LoWPAN
* @ingroup net * @ingroup net
* @brief Riots 6LowPAN implementation * @brief Riots 6LowPAN implementation
* @{ * @{
*
* @file sixlowpan.h * @file sixlowpan.h
* @brief 6lowpan header * @brief 6lowpan header
*
* @author Stephan Zeisberg <zeisberg@mi.fu-berlin.de> * @author Stephan Zeisberg <zeisberg@mi.fu-berlin.de>
* @author Martin Lenders <mlenders@inf.fu-berlin.de> * @author Martin Lenders <mlenders@inf.fu-berlin.de>
* @author Oliver Gesch <oliver.gesch@googlemail.com> * @author Oliver Gesch <oliver.gesch@googlemail.com>
@ -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_get(void);
lowpan_context_t *lowpan_context_num_lookup(uint8_t num); lowpan_context_t *lowpan_context_num_lookup(uint8_t num);
/** /** @} */
* @}
*/
#endif /* _SIXLOWPAN_LOWPAN_H */ #endif /* _SIXLOWPAN_LOWPAN_H */