Commit 5e2f673b authored by Marc Rothmann's avatar Marc Rothmann
Browse files

Doxygen file documentation.

parent 59c28372
/*
AMiRo-OS is an operating system designed for the Autonomous Mini Robot (AMiRo) platform.
Copyright (C) 2016..2018 Thomas Schöpping et al.
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
/**
* @defgroup periphery AMiRo-LLD
* @details AMiRo Low Level Driver Documentation
* @ingroup amiroos
*/
/**
* @defgroup lld_motor A3906 (Motor Driver)
* @details Motor Driver Documentation
* @ingroup periphery
*/
/**
* @defgroup lld_eeprom At24c01bn-sh-b (EEPROM)
* @details EEPROM Documentation
* @ingroup periphery
*/
/**
* @defgroup lld_charger Bq24103a (Battery Charger)
* @details Battery Charger Documentation
* @ingroup periphery
*/
/**
* @defgroup lld_gauge Bq27500 (Fuel Gauge)
* @details Fuel Gauge Documentation
* @ingroup periphery
*/
/**
* @defgroup lld_compass Hmc5883l (Compass)
* @details Compass Documentation
* @ingroup periphery
*/
/**
* @defgroup lld_power Ina219 (Power Monitor)
* @details Power Monitor Documentation
* @ingroup periphery
*/
/**
* @defgroup lld_gyroscope L3g4200d (Gyroscope)
* @details Gyroscope Documentation
* @ingroup periphery
*/
/**
* @defgroup lld_led Led
* @details Led Documentation
* @ingroup periphery
*/
/**
* @defgroup lld_accel Lis331dlh (Accelerometer)
* @details Accelerometer Documentation
* @ingroup periphery
*/
/**
* @defgroup lld_powerpath Ltc4412 (PowerPath Controller)
* @details PowerPath Controller Documentation
* @ingroup periphery
*/
/**
* @defgroup lld_touch Mpr121 (Touch Sensor)
* @details Touch Sensor Documentation
* @ingroup periphery
*/
/**
* @defgroup lld_multi Pca9544a (I2C Multiplexer)
* @details I2C Multiplexer Documentation
* @ingroup periphery
*/
/**
* @defgroup lld_buzzer Pklcs1212e4001 (Buzzer)
* @details Buzzer Documentation
* @ingroup periphery
*/
/**
* @defgroup lld_leddriver Tlc5947 (LED Driver)
* @details LED Driver Documentation
* @ingroup periphery
*/
/**
* @defgroup lld_switch Tps2051bdbv (Power-Distribution Switch)
* @details Power-Distribution Switch Documentation
* @ingroup periphery
*/
/**
* @defgroup lld_stepdown Tps62113 (Step-Down Converter)
* @details Step-Down Converter Documentation
* @ingroup periphery
*/
/**
* @defgroup lld_proximity Vcnl4020 (Proximity Sensor)
* @details Proximity Sensor Documentation
* @ingroup periphery
*/
......@@ -16,6 +16,14 @@ You should have received a copy of the GNU Lesser General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
/**
* @file alld_a3906.h
* @brief Motor driver macros and structures.
*
* @addtogroup lld_motor
* @{
*/
#ifndef _AMIROLLD_A3906_H_
#define _AMIROLLD_A3906_H_
......@@ -57,3 +65,5 @@ extern "C" {
#endif /* defined(AMIROLLD_CFG_USE_A3906) */
#endif /* _AMIROLLD_A3906_H_ */
/** @} */
......@@ -16,6 +16,14 @@ You should have received a copy of the GNU Lesser General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
/**
* @file alld_at24c01bn-sh-b.h
* @brief EEPROM macros and structures.
*
* @addtogroup lld_eeprom
* @{
*/
#ifndef _AMIROLLD_AT24C01BN_H_
#define _AMIROLLD_AT24C01BN_H_
......@@ -89,3 +97,4 @@ extern "C" {
#endif /* _AMIROLLD_AT24C01BN_H_ */
/** @} */
......@@ -16,6 +16,14 @@ You should have received a copy of the GNU Lesser General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
/**
* @file alld_bq24103a.h
* @brief Battery charger constants and driver structure.
*
* @addtogroup lld_charger
* @{
*/
#ifndef _AMIROLLD_BQ24103A_H_
#define _AMIROLLD_BQ24103A_H_
......@@ -70,4 +78,5 @@ extern "C" {
#endif /* defined(AMIROLLD_CFG_USE_BQ24103A) */
/** @} */
#endif /* _AMIROLLD_BQ24103A_H_ */
......@@ -16,6 +16,14 @@ You should have received a copy of the GNU Lesser General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
/**
* @file alld_bq27500.h
* @brief Fuel Gauge constants and structures.
*
* @addtogroup lld_gauge
* @{
*/
#ifndef _AMIROLLD_BQ27500_H_
#define _AMIROLLD_BQ27500_H_
......@@ -239,3 +247,5 @@ extern "C" {
#endif /* defined(AMIROLLD_CFG_USE_BQ27500) */
#endif /* _AMIROLLD_BQ27500_H_ */
/** @} */
......@@ -16,6 +16,14 @@ You should have received a copy of the GNU Lesser General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
/**
* @file alld_hmc5883l.h
* @brief Compass macros and structures.
*
* @addtogroup lld_compass
* @{
*/
#ifndef _AMIROLLD_HMC5883L_H_
#define _AMIROLLD_HMC5883L_H_
......@@ -184,3 +192,5 @@ extern "C" {
#endif /* defined(AMIROLLD_CFG_USE_HMC5883L) */
#endif /* _AMIROLLD_HMC5883L_H_ */
/** @} */
......@@ -16,6 +16,14 @@ You should have received a copy of the GNU Lesser General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
/**
* @file alld_ina219.h
* @brief Power Monitor macros and structures.
*
* @addtogroup lld_power
* @{
*/
#ifndef _AMIROLLD_INA219_H_
#define _AMIROLLD_INA219_H_
......@@ -167,3 +175,5 @@ extern "C" {
#endif /* defined(AMIROLLD_CFG_USE_INA219) */
#endif /* _AMIROLLD_INA219_H_ */
/** @} */
......@@ -16,6 +16,14 @@ You should have received a copy of the GNU Lesser General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
/**
* @file alld_l3g4200d.h
* @brief Gyroscope macros and structures.
*
* @addtogroup lld_gyroscope
* @{
*/
#ifndef _AMIROLLD_L3G4200D_H_
#define _AMIROLLD_L3G4200D_H_
......@@ -314,3 +322,5 @@ extern "C" {
#endif /* defined(AMIROLLD_CFG_USE_L3G4200D) */
#endif /* _AMIROLLD_L3G4200D_H_ */
/** @} */
......@@ -16,6 +16,14 @@ You should have received a copy of the GNU Lesser General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
/**
* @file alld_led.h
* @brief Led macros and structures.
*
* @addtogroup lld_led
* @{
*/
#ifndef _AMIROLLD_LED_H_
#define _AMIROLLD_LED_H_
......@@ -56,3 +64,5 @@ extern "C" {
#endif /* defined(AMIROLLD_CFG_USE_LED) */
#endif /* _AMIROLLD_LED_H_ */
/** @} */
......@@ -16,6 +16,14 @@ You should have received a copy of the GNU Lesser General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
/**
* @file alld_lis331dlh.h
* @brief Accelerometer macros and structures.
*
* @addtogroup lld_accel
* @{
*/
#ifndef _AMIROLLD_LIS331DLH_H_
#define _AMIROLLD_LIS331DLH_H_
......@@ -254,3 +262,5 @@ extern "C" {
#endif /* defined(AMIROLLD_CFG_USE_LIS331DLH) */
#endif /* _AMIROLLD_LIS331DLH_H_ */
/** @} */
......@@ -16,6 +16,14 @@ You should have received a copy of the GNU Lesser General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
/**
* @file alld_ltc4412.h
* @brief PowerPath Controller macros and structures.
*
* @addtogroup lld_powerpath
* @{
*/
#ifndef _AMIROLLD_LTC4412_H_
#define _AMIROLLD_LTC4412_H_
......@@ -64,3 +72,5 @@ extern "C" {
#endif /* defined(AMIROLLD_CFG_USE_LTC4412) */
#endif /* _AMIROLLD_LTC4412_H_ */
/** @} */
......@@ -16,6 +16,14 @@ You should have received a copy of the GNU Lesser General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
/**
* @file alld_mpr121.h
* @brief Touch Sensor macros and structures.
*
* @addtogroup lld_touch
* @{
*/
#ifndef _AMIROLLD_MPR121_H_
#define _AMIROLLD_MPR121_H_
......@@ -219,3 +227,5 @@ extern "C" {
#endif /* defined(AMIROLLD_CFG_USE_MPR121) */
#endif /* _AMIROLLD_MPR121_H_ */
/** @} */
......@@ -16,6 +16,14 @@ You should have received a copy of the GNU Lesser General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
/**
* @file alld_pca9544a.h
* @brief I2C Multiplexer macros and structures.
*
* @addtogroup lld_multi
* @{
*/
#ifndef _AMIROLLD_PCA9544A_H_
#define _AMIROLLD_PCA9544A_H_
......@@ -101,3 +109,5 @@ extern "C" {
#endif /* defined(AMIROLLD_CFG_USE_PCA9544A) */
#endif /* _AMIROLLD_PCA9544A_H_ */
/** @} */
......@@ -16,6 +16,14 @@ You should have received a copy of the GNU Lesser General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
/**
* @file alld_pklcs1212e4001.h
* @brief Buzzer macros.
*
* @addtogroup lld_buzzer
* @{
*/
#ifndef _AMIROLLD_PKLCS1212E4001_H_
#define _AMIROLLD_PKLCS1212E4001_H_
......@@ -50,3 +58,5 @@ extern "C" {
#endif /* defined(AMIROLLD_CFG_USE_PKLCS1212E4001) */
#endif /* _AMIROLLD_PKLCS1212E4001_H_ */
/** @} */
......@@ -16,6 +16,14 @@ You should have received a copy of the GNU Lesser General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
/**
* @file alld_tlc5947.h
* @brief LED Driver macros and structures.
*
* @addtogroup lld_leddriver
* @{
*/
#ifndef _AMIROLLD_TLC5947_H_
#define _AMIROLLD_TLC5947_H_
......@@ -89,3 +97,5 @@ extern "C" {
#endif /* defined(AMIROLLD_CFG_USE_TLC5947) */
#endif /* _AMIROLLD_TLC5947_H_ */
/** @} */
......@@ -16,6 +16,14 @@ You should have received a copy of the GNU Lesser General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
/**
* @file alld_tps2051bdbv.h
* @brief Power-Distribution Switch macros and structures.
*
* @addtogroup lld_switch
* @{
*/
#ifndef _AMIROLLD_TPS2051B_H_
#define _AMIROLLD_TPS2051B_H_
......@@ -70,3 +78,5 @@ extern "C" {
#endif /* defined(AMIROLLD_CFG_USE_TPS2051BDBV) */
#endif /* _AMIROLLD_TPS2051B_H_ */
/** @} */
......@@ -16,6 +16,14 @@ You should have received a copy of the GNU Lesser General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
/**
* @file alld_tps62113.h
* @brief Step-Down Converter macros and structures.
*
* @addtogroup lld_stepdown
* @{
*/
#ifndef _AMIROLLD_TPS62113_H_
#define _AMIROLLD_TPS62113_H_
......@@ -55,3 +63,5 @@ extern "C" {
#endif /* defined(AMIROLLD_CFG_USE_TPS62113) */
#endif /* _AMIROLLD_TPS62113_H_ */
/** @} */
......@@ -16,6 +16,14 @@ You should have received a copy of the GNU Lesser General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
/**
* @file alld_vcnl4020.h
* @brief Proximity Sensor macros and structures.
*
* @addtogroup lld_proximity
* @{
*/
#ifndef _AMIROLLD_VCNL4020_H_
#define _AMIROLLD_VCNL4020_H_
......@@ -239,3 +247,4 @@ extern "C" {
#endif /* _AMIROLLD_VCNL4020_H_ */
/** @} */
......@@ -16,6 +16,14 @@ You should have received a copy of the GNU Lesser General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
/**
* @file alld_a3906.c
* @brief Motor driver functions.
*
* @addtogroup lld_motor
* @{
*/
#include <alld_a3906.h>
#if defined(AMIROLLD_CFG_USE_A3906) || defined(__DOXYGEN__)
......@@ -75,3 +83,5 @@ a3906_lld_set_pwm(apalPWMDriver_t* pwm, const apalPWMchannel_t channel, const ap
}
#endif /* defined(AMIROLLD_CFG_USE_A3906) */
/** @} */
......@@ -16,6 +16,14 @@ You should have received a copy of the GNU Lesser General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
/**
* @file alld_at24c01bn-sh-b.c
* @brief EEPROM function implementations.
*
* @addtogroup lld_eeprom
* @{
*/
#include <alld_at24c01bn-sh-b.h>
#if defined(AMIROLLD_CFG_USE_AT24C01BN) || defined(__DOXYGEN__)
......@@ -122,3 +130,5 @@ at24c01bn_lld_write_page(const AT24C01BNDriver* const at24c01bn, const uint8_t a
}
#endif /* defined(AMIROLLD_CFG_USE_AT24C01BN) */
/** @} */
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment