Revision 5e2f673b
docs/periphery-lld.dox | ||
---|---|---|
1 |
/* |
|
2 |
AMiRo-OS is an operating system designed for the Autonomous Mini Robot (AMiRo) platform. |
|
3 |
Copyright (C) 2016..2018 Thomas Schöpping et al. |
|
4 |
|
|
5 |
This program is free software: you can redistribute it and/or modify |
|
6 |
it under the terms of the GNU General Public License as published by |
|
7 |
the Free Software Foundation, either version 3 of the License, or |
|
8 |
(at your option) any later version. |
|
9 |
|
|
10 |
This program is distributed in the hope that it will be useful, |
|
11 |
but WITHOUT ANY WARRANTY; without even the implied warranty of |
|
12 |
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
|
13 |
GNU General Public License for more details. |
|
14 |
|
|
15 |
You should have received a copy of the GNU General Public License |
|
16 |
along with this program. If not, see <http://www.gnu.org/licenses/>. |
|
17 |
*/ |
|
18 |
|
|
19 |
/** |
|
20 |
* @defgroup periphery AMiRo-LLD |
|
21 |
* @details AMiRo Low Level Driver Documentation |
|
22 |
* @ingroup amiroos |
|
23 |
*/ |
|
24 |
|
|
25 |
/** |
|
26 |
* @defgroup lld_motor A3906 (Motor Driver) |
|
27 |
* @details Motor Driver Documentation |
|
28 |
* @ingroup periphery |
|
29 |
*/ |
|
30 |
|
|
31 |
/** |
|
32 |
* @defgroup lld_eeprom At24c01bn-sh-b (EEPROM) |
|
33 |
* @details EEPROM Documentation |
|
34 |
* @ingroup periphery |
|
35 |
*/ |
|
36 |
|
|
37 |
/** |
|
38 |
* @defgroup lld_charger Bq24103a (Battery Charger) |
|
39 |
* @details Battery Charger Documentation |
|
40 |
* @ingroup periphery |
|
41 |
*/ |
|
42 |
|
|
43 |
/** |
|
44 |
* @defgroup lld_gauge Bq27500 (Fuel Gauge) |
|
45 |
* @details Fuel Gauge Documentation |
|
46 |
* @ingroup periphery |
|
47 |
*/ |
|
48 |
|
|
49 |
/** |
|
50 |
* @defgroup lld_compass Hmc5883l (Compass) |
|
51 |
* @details Compass Documentation |
|
52 |
* @ingroup periphery |
|
53 |
*/ |
|
54 |
|
|
55 |
/** |
|
56 |
* @defgroup lld_power Ina219 (Power Monitor) |
|
57 |
* @details Power Monitor Documentation |
|
58 |
* @ingroup periphery |
|
59 |
*/ |
|
60 |
|
|
61 |
/** |
|
62 |
* @defgroup lld_gyroscope L3g4200d (Gyroscope) |
|
63 |
* @details Gyroscope Documentation |
|
64 |
* @ingroup periphery |
|
65 |
*/ |
|
66 |
|
|
67 |
/** |
|
68 |
* @defgroup lld_led Led |
|
69 |
* @details Led Documentation |
|
70 |
* @ingroup periphery |
|
71 |
*/ |
|
72 |
|
|
73 |
/** |
|
74 |
* @defgroup lld_accel Lis331dlh (Accelerometer) |
|
75 |
* @details Accelerometer Documentation |
|
76 |
* @ingroup periphery |
|
77 |
*/ |
|
78 |
|
|
79 |
/** |
|
80 |
* @defgroup lld_powerpath Ltc4412 (PowerPath Controller) |
|
81 |
* @details PowerPath Controller Documentation |
|
82 |
* @ingroup periphery |
|
83 |
*/ |
|
84 |
|
|
85 |
/** |
|
86 |
* @defgroup lld_touch Mpr121 (Touch Sensor) |
|
87 |
* @details Touch Sensor Documentation |
|
88 |
* @ingroup periphery |
|
89 |
*/ |
|
90 |
|
|
91 |
/** |
|
92 |
* @defgroup lld_multi Pca9544a (I2C Multiplexer) |
|
93 |
* @details I2C Multiplexer Documentation |
|
94 |
* @ingroup periphery |
|
95 |
*/ |
|
96 |
|
|
97 |
/** |
|
98 |
* @defgroup lld_buzzer Pklcs1212e4001 (Buzzer) |
|
99 |
* @details Buzzer Documentation |
|
100 |
* @ingroup periphery |
|
101 |
*/ |
|
102 |
|
|
103 |
/** |
|
104 |
* @defgroup lld_leddriver Tlc5947 (LED Driver) |
|
105 |
* @details LED Driver Documentation |
|
106 |
* @ingroup periphery |
|
107 |
*/ |
|
108 |
|
|
109 |
/** |
|
110 |
* @defgroup lld_switch Tps2051bdbv (Power-Distribution Switch) |
|
111 |
* @details Power-Distribution Switch Documentation |
|
112 |
* @ingroup periphery |
|
113 |
*/ |
|
114 |
|
|
115 |
/** |
|
116 |
* @defgroup lld_stepdown Tps62113 (Step-Down Converter) |
|
117 |
* @details Step-Down Converter Documentation |
|
118 |
* @ingroup periphery |
|
119 |
*/ |
|
120 |
|
|
121 |
/** |
|
122 |
* @defgroup lld_proximity Vcnl4020 (Proximity Sensor) |
|
123 |
* @details Proximity Sensor Documentation |
|
124 |
* @ingroup periphery |
|
125 |
*/ |
include/alld_a3906.h | ||
---|---|---|
16 | 16 |
along with this program. If not, see <http://www.gnu.org/licenses/>. |
17 | 17 |
*/ |
18 | 18 |
|
19 |
/** |
|
20 |
* @file alld_a3906.h |
|
21 |
* @brief Motor driver macros and structures. |
|
22 |
* |
|
23 |
* @addtogroup lld_motor |
|
24 |
* @{ |
|
25 |
*/ |
|
26 |
|
|
19 | 27 |
#ifndef _AMIROLLD_A3906_H_ |
20 | 28 |
#define _AMIROLLD_A3906_H_ |
21 | 29 |
|
... | ... | |
57 | 65 |
#endif /* defined(AMIROLLD_CFG_USE_A3906) */ |
58 | 66 |
|
59 | 67 |
#endif /* _AMIROLLD_A3906_H_ */ |
68 |
|
|
69 |
/** @} */ |
include/alld_at24c01bn-sh-b.h | ||
---|---|---|
16 | 16 |
along with this program. If not, see <http://www.gnu.org/licenses/>. |
17 | 17 |
*/ |
18 | 18 |
|
19 |
/** |
|
20 |
* @file alld_at24c01bn-sh-b.h |
|
21 |
* @brief EEPROM macros and structures. |
|
22 |
* |
|
23 |
* @addtogroup lld_eeprom |
|
24 |
* @{ |
|
25 |
*/ |
|
26 |
|
|
19 | 27 |
#ifndef _AMIROLLD_AT24C01BN_H_ |
20 | 28 |
#define _AMIROLLD_AT24C01BN_H_ |
21 | 29 |
|
... | ... | |
89 | 97 |
|
90 | 98 |
#endif /* _AMIROLLD_AT24C01BN_H_ */ |
91 | 99 |
|
100 |
/** @} */ |
include/alld_bq24103a.h | ||
---|---|---|
16 | 16 |
along with this program. If not, see <http://www.gnu.org/licenses/>. |
17 | 17 |
*/ |
18 | 18 |
|
19 |
/** |
|
20 |
* @file alld_bq24103a.h |
|
21 |
* @brief Battery charger constants and driver structure. |
|
22 |
* |
|
23 |
* @addtogroup lld_charger |
|
24 |
* @{ |
|
25 |
*/ |
|
26 |
|
|
19 | 27 |
#ifndef _AMIROLLD_BQ24103A_H_ |
20 | 28 |
#define _AMIROLLD_BQ24103A_H_ |
21 | 29 |
|
... | ... | |
70 | 78 |
|
71 | 79 |
#endif /* defined(AMIROLLD_CFG_USE_BQ24103A) */ |
72 | 80 |
|
81 |
/** @} */ |
|
73 | 82 |
#endif /* _AMIROLLD_BQ24103A_H_ */ |
include/alld_bq27500.h | ||
---|---|---|
16 | 16 |
along with this program. If not, see <http://www.gnu.org/licenses/>. |
17 | 17 |
*/ |
18 | 18 |
|
19 |
/** |
|
20 |
* @file alld_bq27500.h |
|
21 |
* @brief Fuel Gauge constants and structures. |
|
22 |
* |
|
23 |
* @addtogroup lld_gauge |
|
24 |
* @{ |
|
25 |
*/ |
|
26 |
|
|
19 | 27 |
#ifndef _AMIROLLD_BQ27500_H_ |
20 | 28 |
#define _AMIROLLD_BQ27500_H_ |
21 | 29 |
|
... | ... | |
239 | 247 |
#endif /* defined(AMIROLLD_CFG_USE_BQ27500) */ |
240 | 248 |
|
241 | 249 |
#endif /* _AMIROLLD_BQ27500_H_ */ |
250 |
|
|
251 |
/** @} */ |
include/alld_hmc5883l.h | ||
---|---|---|
16 | 16 |
along with this program. If not, see <http://www.gnu.org/licenses/>. |
17 | 17 |
*/ |
18 | 18 |
|
19 |
/** |
|
20 |
* @file alld_hmc5883l.h |
|
21 |
* @brief Compass macros and structures. |
|
22 |
* |
|
23 |
* @addtogroup lld_compass |
|
24 |
* @{ |
|
25 |
*/ |
|
26 |
|
|
19 | 27 |
#ifndef _AMIROLLD_HMC5883L_H_ |
20 | 28 |
#define _AMIROLLD_HMC5883L_H_ |
21 | 29 |
|
... | ... | |
184 | 192 |
#endif /* defined(AMIROLLD_CFG_USE_HMC5883L) */ |
185 | 193 |
|
186 | 194 |
#endif /* _AMIROLLD_HMC5883L_H_ */ |
195 |
|
|
196 |
/** @} */ |
include/alld_ina219.h | ||
---|---|---|
16 | 16 |
along with this program. If not, see <http://www.gnu.org/licenses/>. |
17 | 17 |
*/ |
18 | 18 |
|
19 |
/** |
|
20 |
* @file alld_ina219.h |
|
21 |
* @brief Power Monitor macros and structures. |
|
22 |
* |
|
23 |
* @addtogroup lld_power |
|
24 |
* @{ |
|
25 |
*/ |
|
26 |
|
|
19 | 27 |
#ifndef _AMIROLLD_INA219_H_ |
20 | 28 |
#define _AMIROLLD_INA219_H_ |
21 | 29 |
|
... | ... | |
167 | 175 |
#endif /* defined(AMIROLLD_CFG_USE_INA219) */ |
168 | 176 |
|
169 | 177 |
#endif /* _AMIROLLD_INA219_H_ */ |
178 |
|
|
179 |
/** @} */ |
include/alld_l3g4200d.h | ||
---|---|---|
16 | 16 |
along with this program. If not, see <http://www.gnu.org/licenses/>. |
17 | 17 |
*/ |
18 | 18 |
|
19 |
/** |
|
20 |
* @file alld_l3g4200d.h |
|
21 |
* @brief Gyroscope macros and structures. |
|
22 |
* |
|
23 |
* @addtogroup lld_gyroscope |
|
24 |
* @{ |
|
25 |
*/ |
|
26 |
|
|
19 | 27 |
#ifndef _AMIROLLD_L3G4200D_H_ |
20 | 28 |
#define _AMIROLLD_L3G4200D_H_ |
21 | 29 |
|
... | ... | |
314 | 322 |
#endif /* defined(AMIROLLD_CFG_USE_L3G4200D) */ |
315 | 323 |
|
316 | 324 |
#endif /* _AMIROLLD_L3G4200D_H_ */ |
325 |
|
|
326 |
/** @} */ |
include/alld_led.h | ||
---|---|---|
16 | 16 |
along with this program. If not, see <http://www.gnu.org/licenses/>. |
17 | 17 |
*/ |
18 | 18 |
|
19 |
/** |
|
20 |
* @file alld_led.h |
|
21 |
* @brief Led macros and structures. |
|
22 |
* |
|
23 |
* @addtogroup lld_led |
|
24 |
* @{ |
|
25 |
*/ |
|
26 |
|
|
19 | 27 |
#ifndef _AMIROLLD_LED_H_ |
20 | 28 |
#define _AMIROLLD_LED_H_ |
21 | 29 |
|
... | ... | |
56 | 64 |
#endif /* defined(AMIROLLD_CFG_USE_LED) */ |
57 | 65 |
|
58 | 66 |
#endif /* _AMIROLLD_LED_H_ */ |
67 |
|
|
68 |
/** @} */ |
include/alld_lis331dlh.h | ||
---|---|---|
16 | 16 |
along with this program. If not, see <http://www.gnu.org/licenses/>. |
17 | 17 |
*/ |
18 | 18 |
|
19 |
/** |
|
20 |
* @file alld_lis331dlh.h |
|
21 |
* @brief Accelerometer macros and structures. |
|
22 |
* |
|
23 |
* @addtogroup lld_accel |
|
24 |
* @{ |
|
25 |
*/ |
|
26 |
|
|
19 | 27 |
#ifndef _AMIROLLD_LIS331DLH_H_ |
20 | 28 |
#define _AMIROLLD_LIS331DLH_H_ |
21 | 29 |
|
... | ... | |
254 | 262 |
#endif /* defined(AMIROLLD_CFG_USE_LIS331DLH) */ |
255 | 263 |
|
256 | 264 |
#endif /* _AMIROLLD_LIS331DLH_H_ */ |
265 |
|
|
266 |
/** @} */ |
include/alld_ltc4412.h | ||
---|---|---|
16 | 16 |
along with this program. If not, see <http://www.gnu.org/licenses/>. |
17 | 17 |
*/ |
18 | 18 |
|
19 |
/** |
|
20 |
* @file alld_ltc4412.h |
|
21 |
* @brief PowerPath Controller macros and structures. |
|
22 |
* |
|
23 |
* @addtogroup lld_powerpath |
|
24 |
* @{ |
|
25 |
*/ |
|
26 |
|
|
19 | 27 |
#ifndef _AMIROLLD_LTC4412_H_ |
20 | 28 |
#define _AMIROLLD_LTC4412_H_ |
21 | 29 |
|
... | ... | |
64 | 72 |
#endif /* defined(AMIROLLD_CFG_USE_LTC4412) */ |
65 | 73 |
|
66 | 74 |
#endif /* _AMIROLLD_LTC4412_H_ */ |
75 |
|
|
76 |
/** @} */ |
include/alld_mpr121.h | ||
---|---|---|
16 | 16 |
along with this program. If not, see <http://www.gnu.org/licenses/>. |
17 | 17 |
*/ |
18 | 18 |
|
19 |
/** |
|
20 |
* @file alld_mpr121.h |
|
21 |
* @brief Touch Sensor macros and structures. |
|
22 |
* |
|
23 |
* @addtogroup lld_touch |
|
24 |
* @{ |
|
25 |
*/ |
|
26 |
|
|
19 | 27 |
#ifndef _AMIROLLD_MPR121_H_ |
20 | 28 |
#define _AMIROLLD_MPR121_H_ |
21 | 29 |
|
... | ... | |
219 | 227 |
#endif /* defined(AMIROLLD_CFG_USE_MPR121) */ |
220 | 228 |
|
221 | 229 |
#endif /* _AMIROLLD_MPR121_H_ */ |
230 |
|
|
231 |
/** @} */ |
include/alld_pca9544a.h | ||
---|---|---|
16 | 16 |
along with this program. If not, see <http://www.gnu.org/licenses/>. |
17 | 17 |
*/ |
18 | 18 |
|
19 |
/** |
|
20 |
* @file alld_pca9544a.h |
|
21 |
* @brief I2C Multiplexer macros and structures. |
|
22 |
* |
|
23 |
* @addtogroup lld_multi |
|
24 |
* @{ |
|
25 |
*/ |
|
26 |
|
|
19 | 27 |
#ifndef _AMIROLLD_PCA9544A_H_ |
20 | 28 |
#define _AMIROLLD_PCA9544A_H_ |
21 | 29 |
|
... | ... | |
101 | 109 |
#endif /* defined(AMIROLLD_CFG_USE_PCA9544A) */ |
102 | 110 |
|
103 | 111 |
#endif /* _AMIROLLD_PCA9544A_H_ */ |
112 |
|
|
113 |
/** @} */ |
include/alld_pklcs1212e4001.h | ||
---|---|---|
16 | 16 |
along with this program. If not, see <http://www.gnu.org/licenses/>. |
17 | 17 |
*/ |
18 | 18 |
|
19 |
/** |
|
20 |
* @file alld_pklcs1212e4001.h |
|
21 |
* @brief Buzzer macros. |
|
22 |
* |
|
23 |
* @addtogroup lld_buzzer |
|
24 |
* @{ |
|
25 |
*/ |
|
26 |
|
|
19 | 27 |
#ifndef _AMIROLLD_PKLCS1212E4001_H_ |
20 | 28 |
#define _AMIROLLD_PKLCS1212E4001_H_ |
21 | 29 |
|
... | ... | |
50 | 58 |
#endif /* defined(AMIROLLD_CFG_USE_PKLCS1212E4001) */ |
51 | 59 |
|
52 | 60 |
#endif /* _AMIROLLD_PKLCS1212E4001_H_ */ |
61 |
|
|
62 |
/** @} */ |
include/alld_tlc5947.h | ||
---|---|---|
16 | 16 |
along with this program. If not, see <http://www.gnu.org/licenses/>. |
17 | 17 |
*/ |
18 | 18 |
|
19 |
/** |
|
20 |
* @file alld_tlc5947.h |
|
21 |
* @brief LED Driver macros and structures. |
|
22 |
* |
|
23 |
* @addtogroup lld_leddriver |
|
24 |
* @{ |
|
25 |
*/ |
|
26 |
|
|
19 | 27 |
#ifndef _AMIROLLD_TLC5947_H_ |
20 | 28 |
#define _AMIROLLD_TLC5947_H_ |
21 | 29 |
|
... | ... | |
89 | 97 |
#endif /* defined(AMIROLLD_CFG_USE_TLC5947) */ |
90 | 98 |
|
91 | 99 |
#endif /* _AMIROLLD_TLC5947_H_ */ |
100 |
|
|
101 |
/** @} */ |
include/alld_tps2051bdbv.h | ||
---|---|---|
16 | 16 |
along with this program. If not, see <http://www.gnu.org/licenses/>. |
17 | 17 |
*/ |
18 | 18 |
|
19 |
/** |
|
20 |
* @file alld_tps2051bdbv.h |
|
21 |
* @brief Power-Distribution Switch macros and structures. |
|
22 |
* |
|
23 |
* @addtogroup lld_switch |
|
24 |
* @{ |
|
25 |
*/ |
|
26 |
|
|
19 | 27 |
#ifndef _AMIROLLD_TPS2051B_H_ |
20 | 28 |
#define _AMIROLLD_TPS2051B_H_ |
21 | 29 |
|
... | ... | |
70 | 78 |
#endif /* defined(AMIROLLD_CFG_USE_TPS2051BDBV) */ |
71 | 79 |
|
72 | 80 |
#endif /* _AMIROLLD_TPS2051B_H_ */ |
81 |
|
|
82 |
/** @} */ |
include/alld_tps62113.h | ||
---|---|---|
16 | 16 |
along with this program. If not, see <http://www.gnu.org/licenses/>. |
17 | 17 |
*/ |
18 | 18 |
|
19 |
/** |
|
20 |
* @file alld_tps62113.h |
|
21 |
* @brief Step-Down Converter macros and structures. |
|
22 |
* |
|
23 |
* @addtogroup lld_stepdown |
|
24 |
* @{ |
|
25 |
*/ |
|
26 |
|
|
19 | 27 |
#ifndef _AMIROLLD_TPS62113_H_ |
20 | 28 |
#define _AMIROLLD_TPS62113_H_ |
21 | 29 |
|
... | ... | |
55 | 63 |
#endif /* defined(AMIROLLD_CFG_USE_TPS62113) */ |
56 | 64 |
|
57 | 65 |
#endif /* _AMIROLLD_TPS62113_H_ */ |
66 |
|
|
67 |
/** @} */ |
include/alld_vcnl4020.h | ||
---|---|---|
16 | 16 |
along with this program. If not, see <http://www.gnu.org/licenses/>. |
17 | 17 |
*/ |
18 | 18 |
|
19 |
/** |
|
20 |
* @file alld_vcnl4020.h |
|
21 |
* @brief Proximity Sensor macros and structures. |
|
22 |
* |
|
23 |
* @addtogroup lld_proximity |
|
24 |
* @{ |
|
25 |
*/ |
|
26 |
|
|
19 | 27 |
#ifndef _AMIROLLD_VCNL4020_H_ |
20 | 28 |
#define _AMIROLLD_VCNL4020_H_ |
21 | 29 |
|
... | ... | |
239 | 247 |
|
240 | 248 |
#endif /* _AMIROLLD_VCNL4020_H_ */ |
241 | 249 |
|
250 |
/** @} */ |
source/alld_a3906.c | ||
---|---|---|
16 | 16 |
along with this program. If not, see <http://www.gnu.org/licenses/>. |
17 | 17 |
*/ |
18 | 18 |
|
19 |
/** |
|
20 |
* @file alld_a3906.c |
|
21 |
* @brief Motor driver functions. |
|
22 |
* |
|
23 |
* @addtogroup lld_motor |
|
24 |
* @{ |
|
25 |
*/ |
|
26 |
|
|
19 | 27 |
#include <alld_a3906.h> |
20 | 28 |
|
21 | 29 |
#if defined(AMIROLLD_CFG_USE_A3906) || defined(__DOXYGEN__) |
... | ... | |
75 | 83 |
} |
76 | 84 |
|
77 | 85 |
#endif /* defined(AMIROLLD_CFG_USE_A3906) */ |
86 |
|
|
87 |
/** @} */ |
source/alld_at24c01bn-sh-b.c | ||
---|---|---|
16 | 16 |
along with this program. If not, see <http://www.gnu.org/licenses/>. |
17 | 17 |
*/ |
18 | 18 |
|
19 |
/** |
|
20 |
* @file alld_at24c01bn-sh-b.c |
|
21 |
* @brief EEPROM function implementations. |
|
22 |
* |
|
23 |
* @addtogroup lld_eeprom |
|
24 |
* @{ |
|
25 |
*/ |
|
26 |
|
|
19 | 27 |
#include <alld_at24c01bn-sh-b.h> |
20 | 28 |
|
21 | 29 |
#if defined(AMIROLLD_CFG_USE_AT24C01BN) || defined(__DOXYGEN__) |
... | ... | |
122 | 130 |
} |
123 | 131 |
|
124 | 132 |
#endif /* defined(AMIROLLD_CFG_USE_AT24C01BN) */ |
133 |
|
|
134 |
/** @} */ |
source/alld_bq24103a.c | ||
---|---|---|
16 | 16 |
along with this program. If not, see <http://www.gnu.org/licenses/>. |
17 | 17 |
*/ |
18 | 18 |
|
19 |
/** |
|
20 |
* @file alld_bq24103a.c |
|
21 |
* @brief Battery charger function implementations. |
|
22 |
* |
|
23 |
* @addtogroup lld_charger |
|
24 |
* @{ |
|
25 |
*/ |
|
19 | 26 |
#include <alld_bq24103a.h> |
20 | 27 |
|
21 | 28 |
#if defined(AMIROLLD_CFG_USE_BQ24103A) || defined(__DOXYGEN__) |
... | ... | |
71 | 78 |
} |
72 | 79 |
|
73 | 80 |
#endif /* defined(AMIROLLD_CFG_USE_BQ24103A) */ |
81 |
|
|
82 |
/** @} */ |
source/alld_bq27500.c | ||
---|---|---|
16 | 16 |
along with this program. If not, see <http://www.gnu.org/licenses/>. |
17 | 17 |
*/ |
18 | 18 |
|
19 |
/** |
|
20 |
* @file alld_bq27500.c |
|
21 |
* @brief Fuel Gauge function implementations. |
|
22 |
* |
|
23 |
* @addtogroup lld_gauge |
|
24 |
* @{ |
|
25 |
*/ |
|
26 |
|
|
19 | 27 |
#include <alld_bq27500.h> |
20 | 28 |
|
21 | 29 |
#if defined(AMIROLLD_CFG_USE_BQ27500) || defined(__DOXYGEN__) |
... | ... | |
185 | 193 |
} |
186 | 194 |
|
187 | 195 |
#endif /* defined(AMIROLLD_CFG_USE_BQ27500) */ |
196 |
|
|
197 |
/** @} */ |
source/alld_hmc5883l.c | ||
---|---|---|
16 | 16 |
along with this program. If not, see <http://www.gnu.org/licenses/>. |
17 | 17 |
*/ |
18 | 18 |
|
19 |
/** |
|
20 |
* @file |
|
21 |
* @brief Compass function implementations. |
|
22 |
* |
|
23 |
* @addtogroup lld_compass |
|
24 |
* @{ |
|
25 |
*/ |
|
26 |
|
|
19 | 27 |
#include <alld_hmc5883l.h> |
20 | 28 |
|
21 | 29 |
#if defined(AMIROLLD_CFG_USE_HMC5883L) || defined(__DOXYGEN__) |
... | ... | |
223 | 231 |
} |
224 | 232 |
|
225 | 233 |
#endif /* defined(AMIROLLD_CFG_USE_HMC5883L) */ |
234 |
|
|
235 |
/** @} */ |
source/alld_ina219.c | ||
---|---|---|
16 | 16 |
along with this program. If not, see <http://www.gnu.org/licenses/>. |
17 | 17 |
*/ |
18 | 18 |
|
19 |
/** |
|
20 |
* @file alld_ina219.c |
|
21 |
* @brief Power Monitor function implementations |
|
22 |
* |
|
23 |
* @addtogroup lld_power |
|
24 |
* @{ |
|
25 |
*/ |
|
26 |
|
|
19 | 27 |
#include <alld_ina219.h> |
20 | 28 |
|
21 | 29 |
#if defined(AMIROLLD_CFG_USE_INA219) || defined(__DOXYGEN__) |
... | ... | |
329 | 337 |
} |
330 | 338 |
|
331 | 339 |
#endif /* defined(AMIROLLD_CFG_USE_INA219) */ |
340 |
|
|
341 |
/** @} */ |
source/alld_l3g4200d.c | ||
---|---|---|
16 | 16 |
along with this program. If not, see <http://www.gnu.org/licenses/>. |
17 | 17 |
*/ |
18 | 18 |
|
19 |
/** |
|
20 |
* @file alld_l3g4200d.c |
|
21 |
* @brief Gyroscope function implementations. |
|
22 |
* |
|
23 |
* @addtogroup lld_gyroscope |
|
24 |
* @{ |
|
25 |
*/ |
|
26 |
|
|
19 | 27 |
#include<alld_l3g4200d.h> |
20 | 28 |
|
21 | 29 |
#if defined(AMIROLLD_CFG_USE_L3G4200D) || defined(__DOXYGEN__) |
... | ... | |
266 | 274 |
} |
267 | 275 |
|
268 | 276 |
#endif /* defined(AMIROLLD_CFG_USE_L3G4200D) */ |
277 |
|
|
278 |
/** @} */ |
source/alld_led.c | ||
---|---|---|
16 | 16 |
along with this program. If not, see <http://www.gnu.org/licenses/>. |
17 | 17 |
*/ |
18 | 18 |
|
19 |
/** |
|
20 |
* @file alld_led.c |
|
21 |
* @brief Led function implementations. |
|
22 |
* |
|
23 |
* @addtogroup lld_led |
|
24 |
* @{ |
|
25 |
*/ |
|
26 |
|
|
19 | 27 |
#include <alld_led.h> |
20 | 28 |
|
21 | 29 |
#if defined(AMIROLLD_CFG_USE_LED) || defined(__DOXYGEN__) |
... | ... | |
66 | 74 |
} |
67 | 75 |
|
68 | 76 |
#endif /* defined(AMIROLLD_CFG_USE_LED) */ |
77 |
|
|
78 |
/** @} */ |
source/alld_lis331dlh.c | ||
---|---|---|
16 | 16 |
along with this program. If not, see <http://www.gnu.org/licenses/>. |
17 | 17 |
*/ |
18 | 18 |
|
19 |
/** |
|
20 |
* @file alld_lis331dlh.c |
|
21 |
* @brief Accelerometer function implementations. |
|
22 |
* |
|
23 |
* @addtogroup lld_accel |
|
24 |
* @{ |
|
25 |
*/ |
|
26 |
|
|
19 | 27 |
#include <alld_lis331dlh.h> |
20 | 28 |
|
21 | 29 |
#if defined(AMIROLLD_CFG_USE_LIS331DLH) || defined(__DOXYGEN__) |
... | ... | |
247 | 255 |
} |
248 | 256 |
|
249 | 257 |
#endif /* defined(AMIROLLD_CFG_USE_LIS331DLH) */ |
258 |
|
|
259 |
/** @} */ |
source/alld_ltc4412.c | ||
---|---|---|
16 | 16 |
along with this program. If not, see <http://www.gnu.org/licenses/>. |
17 | 17 |
*/ |
18 | 18 |
|
19 |
/** |
|
20 |
* @file alld_ltc4412.c |
|
21 |
* @brief PowerPath Controller function implementations |
|
22 |
* |
|
23 |
* @addtogroup lld_powerpath |
|
24 |
* @{ |
|
25 |
*/ |
|
26 |
|
|
19 | 27 |
#include <alld_ltc4412.h> |
20 | 28 |
|
21 | 29 |
#if defined(AMIROLLD_CFG_USE_LTC4412) || defined(__DOXYGEN__) |
... | ... | |
71 | 79 |
} |
72 | 80 |
|
73 | 81 |
#endif /* defined(AMIROLLD_CFG_USE_LTC4412) */ |
82 |
|
|
83 |
/** @} */ |
source/alld_mpr121.c | ||
---|---|---|
16 | 16 |
along with this program. If not, see <http://www.gnu.org/licenses/>. |
17 | 17 |
*/ |
18 | 18 |
|
19 |
/** |
|
20 |
* @file alld_mpr121.c |
|
21 |
* @brief Touch Sensor function implementations. |
|
22 |
* |
|
23 |
* @addtogroup lld_touch |
|
24 |
* @{ |
|
25 |
*/ |
|
26 |
|
|
19 | 27 |
#include <alld_mpr121.h> |
20 | 28 |
|
21 | 29 |
#if defined(AMIROLLD_CFG_USE_MPR121) || defined(__DOXYGEN__) |
... | ... | |
176 | 184 |
} |
177 | 185 |
|
178 | 186 |
#endif /* defined(AMIROLLD_CFG_USE_MPR121) */ |
187 |
|
|
188 |
/** @} */ |
source/alld_pca9544a.c | ||
---|---|---|
16 | 16 |
along with this program. If not, see <http://www.gnu.org/licenses/>. |
17 | 17 |
*/ |
18 | 18 |
|
19 |
/** |
|
20 |
* @file alld_pca9544a.c |
|
21 |
* @brief I2C Multiplexer function implementations. |
|
22 |
* |
|
23 |
* @addtogroup lld_multi |
|
24 |
* @{ |
|
25 |
*/ |
|
26 |
|
|
19 | 27 |
#include <alld_pca9544a.h> |
20 | 28 |
|
21 | 29 |
#if defined(AMIROLLD_CFG_USE_PCA9544A) || defined(__DOXYGEN__) |
... | ... | |
120 | 128 |
} |
121 | 129 |
|
122 | 130 |
#endif /* defined(AMIROLLD_CFG_USE_PCA9544A) */ |
131 |
|
|
132 |
/** @} */ |
source/alld_pklcs1212e4001.c | ||
---|---|---|
16 | 16 |
along with this program. If not, see <http://www.gnu.org/licenses/>. |
17 | 17 |
*/ |
18 | 18 |
|
19 |
/** |
|
20 |
* @file alld_pklcs1212e4001.c |
|
21 |
* @brief Buzzer function implementations. |
|
22 |
* |
|
23 |
* @addtogroup lld_buzzer |
|
24 |
* @{ |
|
25 |
*/ |
|
26 |
|
|
19 | 27 |
#include <alld_pklcs1212e4001.h> |
20 | 28 |
|
21 | 29 |
#if defined(AMIROLLD_CFG_USE_PKLCS1212E4001) || defined(__DOXYGEN__) |
... | ... | |
69 | 77 |
} |
70 | 78 |
|
71 | 79 |
#endif /* defined(AMIROLLD_CFG_USE_PKLCS1212E4001) */ |
80 |
|
|
81 |
/** @} */ |
source/alld_tlc5947.c | ||
---|---|---|
16 | 16 |
along with this program. If not, see <http://www.gnu.org/licenses/>. |
17 | 17 |
*/ |
18 | 18 |
|
19 |
/** |
|
20 |
* @file alld_tlc5947.c |
|
21 |
* @brief LED Driver function implementations. |
|
22 |
* |
|
23 |
* @addtogroup lld_leddriver |
|
24 |
* @{ |
|
25 |
*/ |
|
26 |
|
|
19 | 27 |
#include <alld_tlc5947.h> |
20 | 28 |
|
21 | 29 |
#if defined(AMIROLLD_CFG_USE_TLC5947) || defined(__DOXYGEN__) |
... | ... | |
142 | 150 |
} |
143 | 151 |
|
144 | 152 |
#endif /* defined(AMIROLLD_CFG_USE_TLC5947) */ |
153 |
|
|
154 |
/** @} */ |
source/alld_tps2051bdbv.c | ||
---|---|---|
16 | 16 |
along with this program. If not, see <http://www.gnu.org/licenses/>. |
17 | 17 |
*/ |
18 | 18 |
|
19 |
/** |
|
20 |
* @file alld_tps2051bdbv.c |
|
21 |
* @brief Power-Distribution function implementations. |
|
22 |
* |
|
23 |
* @addtogroup lld_switch |
|
24 |
* @{ |
|
25 |
*/ |
|
26 |
|
|
19 | 27 |
#include <alld_tps2051bdbv.h> |
20 | 28 |
|
21 | 29 |
#if defined(AMIROLLD_CFG_USE_TPS2051BDBV) || defined(__DOXYGEN__) |
... | ... | |
71 | 79 |
} |
72 | 80 |
|
73 | 81 |
#endif /* defined(AMIROLLD_CFG_USE_TPS2051BDBV) */ |
82 |
|
|
83 |
/** @} */ |
source/alld_tps62113.c | ||
---|---|---|
16 | 16 |
along with this program. If not, see <http://www.gnu.org/licenses/>. |
17 | 17 |
*/ |
18 | 18 |
|
19 |
/** |
|
20 |
* @file alld_tps62113.c |
|
21 |
* @brief Step-Down Converter function implementations. |
|
22 |
* |
|
23 |
* @addtogroup lld_stepdown |
|
24 |
* @{ |
|
25 |
*/ |
|
26 |
|
|
19 | 27 |
#include <alld_tps62113.h> |
20 | 28 |
|
21 | 29 |
#if defined(AMIROLLD_CFG_USE_TPS62113) || defined(__DOXYGEN__) |
... | ... | |
53 | 61 |
} |
54 | 62 |
|
55 | 63 |
#endif /* defined(AMIROLLD_CFG_USE_TPS62113) */ |
64 |
|
|
65 |
/** @} */ |
source/alld_vcnl4020.c | ||
---|---|---|
16 | 16 |
along with this program. If not, see <http://www.gnu.org/licenses/>. |
17 | 17 |
*/ |
18 | 18 |
|
19 |
/** |
|
20 |
* @file alld_vcnl4020.c |
|
21 |
* @brief Proximity Sensor function implementations. |
|
22 |
* |
|
23 |
* @addtogroup lld_proximity |
|
24 |
* @{ |
|
25 |
*/ |
|
26 |
|
|
19 | 27 |
#include <alld_vcnl4020.h> |
20 | 28 |
|
21 | 29 |
#if defined(AMIROLLD_CFG_USE_VCNL4020) || defined(__DOXYGEN__) |
... | ... | |
262 | 270 |
} |
263 | 271 |
|
264 | 272 |
#endif /* defined(AMIROLLD_CFG_USE_VCNL4020) */ |
273 |
|
|
274 |
/** @} */ |
Also available in: Unified diff