Browse Source

drivers: various doxygen fixes

- fixed group naming scheme to 'drivers_xx'
- introduced a group for actuators (analog to the sensors)
- added missing doxygen to ltc4150 driver
cc430
Hauke Petersen 7 years ago
parent
commit
f0b0db8f06
  1. 9
      drivers/doc.txt
  2. 14
      drivers/include/adc_legacy.h
  3. 4
      drivers/include/at30tse75x.h
  4. 2
      drivers/include/dht.h
  5. 2
      drivers/include/diskio.h
  6. 2
      drivers/include/encx24j600.h
  7. 2
      drivers/include/flashrom.h
  8. 29
      drivers/include/gpioint.h
  9. 2
      drivers/include/hih6130.h
  10. 2
      drivers/include/ina220.h
  11. 2
      drivers/include/isl29020.h
  12. 2
      drivers/include/isl29125.h
  13. 2
      drivers/include/l3g4200d.h
  14. 2
      drivers/include/lis3dh.h
  15. 2
      drivers/include/lm75a-temp-sensor.h
  16. 2
      drivers/include/lps331ap.h
  17. 2
      drivers/include/lsm303dlhc.h
  18. 64
      drivers/include/ltc4150.h
  19. 49
      drivers/include/ltc4150_arch.h
  20. 2
      drivers/include/nvram-spi.h
  21. 2
      drivers/include/nvram.h
  22. 2
      drivers/include/pcd8544.h
  23. 2
      drivers/include/rgbled.h
  24. 2
      drivers/include/servo.h
  25. 4
      drivers/include/sht11.h
  26. 3
      drivers/include/tcs37727.h

9
drivers/doc.txt

@ -28,3 +28,12 @@
* Most of these drivers will be connected over some bus or serial connection
* to the MCU.
*/
/**
* @defgroup drivers_actuators Actuator Device Drivers
* @ingroup drivers
* @brief Drivers for actuating devices
*
* The group of actuators includes all kind of devices that can actively
* interact with the physical world, as e.g. motors, lights, sound devices, etc.
*/

14
drivers/include/adc_legacy.h

@ -10,17 +10,19 @@
* @defgroup drivers_adc ADC
* @ingroup drivers
* @brief Generic interface for ADC drivers
*
* @deprecated This interface is obsolete. Use the @ref drivers_periph_adc
* interface in @ref drivers_periph instead.
*
* @author Oliver Hahm <oliver.hahm@inria.fr>
*
* @{
*
* @file
* @brief Legacy ADC driver interface
*
* @author Oliver Hahm <oliver.hahm@inria.fr>
*/
#ifndef ADC_H
#define ADC_H
#ifndef ADC_LEGACY_H
#define ADC_LEGACY_H
#include <stdint.h>
@ -46,5 +48,5 @@ uint16_t adc_read(uint8_t channel);
}
#endif
#endif /* ADC_LEGACY_H */
/** @} */
#endif /* ADC_H */

4
drivers/include/at30tse75x.h

@ -7,8 +7,8 @@
*/
/**
* @defgroup at30tse75x AT30TSE75x temperature sensor with EEPROM
* @ingroup drivers
* @defgroup drivers_at30tse75x AT30TSE75x temperature sensor with EEPROM
* @ingroup drivers_sensors
*
* The connection between the MCU and the AT30TSE75x is based on the
* I2C-interface. There are 3 versions of this IC, with either 2/4/8 Kb of

2
drivers/include/dht.h

@ -7,7 +7,7 @@
*/
/**
* @defgroup driver_dht DHT Family of Humidity and Temperature Sensors
* @defgroup drivers_dht DHT Family of Humidity and Temperature Sensors
* @ingroup drivers_sensors
* @brief Device driver for the DHT Family of humidity
* and temperature sensors

2
drivers/include/diskio.h

@ -7,7 +7,7 @@
*/
/**
* @defgroup diskio Disk IO Driver
* @defgroup drivers_diskio Disk IO Driver
* @ingroup drivers
* @brief Low level disk interface
*

2
drivers/include/encx24j600.h

@ -7,7 +7,7 @@
*/
/**
* @defgroup driver_encx24j600 ENCX24J600
* @defgroup drivers_encx24j600 ENCX24J600
* @ingroup drivers_netdev
* @brief Driver for the ENCX24J600 Ethernet Adapter
* @{

2
drivers/include/flashrom.h

@ -7,7 +7,7 @@
*/
/**
* @defgroup flashrom Flash memory driver
* @defgroup drivers_flashrom Flash memory driver
* @ingroup drivers
* @brief Generic flash memory driver
* @{

29
drivers/include/gpioint.h

@ -6,9 +6,6 @@
* directory for more details.
*/
#ifndef GPIOINT_H_
#define GPIOINT_H_
/**
* @defgroup drivers_gpioint GPIO IRQ Multiplexer
* @ingroup drivers
@ -24,6 +21,9 @@
* @author Michael Baar <michael.baar@fu-berlin.de>
*/
#ifndef GPIOINT_H_
#define GPIOINT_H_
#include <stdint.h>
#include <stdbool.h>
@ -32,19 +32,21 @@ extern "C" {
#endif
/*
* gpioint_flags:
* Note: - We rely on the exact values for the edges.
* - These flags are extended in hal/drivers/device-gpio.h
* @brief GPIO IRQ multiplexer flags
*
* @note We rely on the exact values for the edges.
* @note 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_DEBOUNCE 0x04 ///< debounce this interrupt
#define GPIOINT_DISABLE 0x00 /**< disable interrupt */
#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
*/
typedef void(*fp_irqcb)(void);
@ -62,6 +64,9 @@ typedef void(*fp_irqcb)(void);
*/
bool gpioint_set(int port, uint32_t bitmask, int flags, fp_irqcb callback);
/**
* @brief Initialize the multiplexer
*/
void gpioint_init(void);
#ifdef __cplusplus

2
drivers/include/hih6130.h

@ -7,7 +7,7 @@
*/
/**
* @defgroup driver_hih6130 HIH6130 humidity and temperature sensor
* @defgroup drivers_hih6130 HIH6130 humidity and temperature sensor
* @ingroup drivers_sensors
* @brief Device driver for Honeywell HumidIcon Digital
* Humidity/Temperature Sensors: HIH-6130/6131 Series

2
drivers/include/ina220.h

@ -7,7 +7,7 @@
*/
/**
* @defgroup driver_ina220 INA220 current/power monitor
* @defgroup drivers_ina220 INA220 current/power monitor
* @ingroup drivers_sensors
* @brief Device driver for Texas Instruments INA220 High or Low Side,
* Bi-Directional CURRENT/POWER MONITOR with Two-Wire Interface

2
drivers/include/isl29020.h

@ -7,7 +7,7 @@
*/
/**
* @defgroup driver_isl29020 ISL29020 light sensor
* @defgroup drivers_isl29020 ISL29020 light sensor
* @ingroup drivers_sensors
* @brief Device driver for the ISL29020 light sensor
* @{

2
drivers/include/isl29125.h

@ -7,7 +7,7 @@
*/
/**
* @defgroup driver_isl29125 ISL29125 RGB light sensor
* @defgroup drivers_isl29125 ISL29125 RGB light sensor
* @ingroup drivers_sensors
* @brief Device driver for the ISL29125 RGB light sensor
*

2
drivers/include/l3g4200d.h

@ -7,7 +7,7 @@
*/
/**
* @defgroup driver_l3g4200d L3G4200D gyroscope
* @defgroup drivers_l3g4200d L3G4200D gyroscope
* @ingroup drivers_sensors
* @brief Device driver for the L3G4200D gyroscope
* @{

2
drivers/include/lis3dh.h

@ -7,7 +7,7 @@
*/
/**
* @defgroup driver_lis3dh LIS3DH accelerometer
* @defgroup drivers_lis3dh LIS3DH accelerometer
* @ingroup drivers_sensors
* @brief Device driver for the LIS3DH accelerometer
* @{

2
drivers/include/lm75a-temp-sensor.h

@ -7,7 +7,7 @@
*/
/**
* @defgroup lm75a LM75A
* @defgroup drivers_lm75a LM75A
* @ingroup drivers_sensors
* @brief Driver for the LM75A digital temperature sensor and thermal watchdog
*

2
drivers/include/lps331ap.h

@ -7,7 +7,7 @@
*/
/**
* @defgroup driver_lps331ap LPS331AP Pressure Sensor Driver
* @defgroup drivers_lps331ap LPS331AP Pressure Sensor Driver
* @ingroup drivers_sensors
* @brief Device driver for the LPS331AP pressure sensor
* @{

2
drivers/include/lsm303dlhc.h

@ -7,7 +7,7 @@
*/
/**
* @defgroup driver_lsm303dlhc LSM303DLHC 3D accelerometer/magnetometer
* @defgroup drivers_lsm303dlhc LSM303DLHC 3D accelerometer/magnetometer
* @ingroup drivers_sensors
* @brief Device driver for the LSM303DLHC 3D accelerometer/magnetometer
* @{

64
drivers/include/ltc4150.h

@ -6,6 +6,23 @@
* directory for more details.
*/
/**
* @defgroup drivers_ltc4150 LTC4150 Coulomb Counter
* @ingroup drivers_sensors
* @brief Device driver for LTC4150 coulomb counters
*
* @deprecated This driver should be ported to the peripheral driver interface
* (@ref drivers_periph)
*
* @{
*
* @file
* @brief Driver interface for the LTC4150 driver
*
* @author Heiko Will <heiko.will@fu-berlin.de>
*/
#ifndef LTC4150_H
#define LTC4150_H
@ -15,15 +32,61 @@
extern "C" {
#endif
/**
* @brief Initialize the counter
*/
void ltc4150_init(void);
/**
* @brief Start a measurement
*/
void ltc4150_start(void);
/**
* @brief End the ongoing measurement
*/
void ltc4150_stop(void);
/**
* @brief Get the current electrical current
*
* @return electrical current in mA
*/
double ltc4150_get_current_mA(void);
/**
* @brief Get the total power used since @p ltc4150_start was called
*
* @return power used in mAh
*/
double ltc4150_get_total_mAh(void);
/**
* @brief Get the total energy used since @p ltc4150_start was called
*
* @return energy used in Joule
*/
double ltc4150_get_total_Joule(void);
/**
* @brief Get the average electrical current sine @p ltc4150_start was called
*
* @return average current in mA
*/
double ltc4150_get_avg_mA(void);
/**
* @brief Get the time the current measurement is going on
*
* @return time
*/
int ltc4150_get_interval(void);
/**
* @brief Get the number of samples taken
*
* @return number of samples in the current interval
*/
long ltc4150_get_intcount(void);
#ifdef __cplusplus
@ -31,3 +94,4 @@ long ltc4150_get_intcount(void);
#endif
#endif /* LTC4150_H */
/** @} */

49
drivers/include/ltc4150_arch.h

@ -6,15 +6,8 @@
* directory for more details.
*/
#ifndef LTC4150_ARCH_H
#define LTC4150_ARCH_H
#ifdef __cplusplus
extern "C" {
#endif
/**
* @defgroup ltc4150 LTC4150
* @defgroup drivers_ltc4150 LTC4150
* @ingroup drivers_sensors
* @brief Driver for the Linear Technology LTC4150 Coulomb Counter
* @{
@ -22,26 +15,50 @@ extern "C" {
* @file
* @brief LTC4150 Coulomb Counter
*
* @author Heiko Will
* @author Heiko Will <heiko.will@fu-berlin.de>
*/
#ifndef LTC4150_ARCH_H
#define LTC4150_ARCH_H
#ifdef __cplusplus
extern "C" {
#endif
/**
* @brief Constants used by the driver
* @{
*/
#define _GFH (double)32.631375
#define _R_SENSE (double)0.330
#define SUPPLY_VOLTAGE (5)
/** @} */
/** board specific ltc4150 interrupt disable */
/**
* @brief Board specific ltc4150 interrupt disable
**/
void ltc4150_disable_int(void);
/** board specific ltc4150 interrupt enable */
/**
* @brief Board specific ltc4150 interrupt enable
**/
void ltc4150_enable_int(void);
/** board specific synchronization of ltc4150 */
/**
* @brief Board specific synchronization of ltc4150
**/
void ltc4150_sync_blocking(void);
/** board specific ltc4150 initialization */
/**
* @brief Board specific ltc4150 initialization
**/
void ltc4150_arch_init(void);
/**
* ltc4150 interrupt handler,
* shall be called on ltc4150 interrupt,
* implemented in driver
* @brief Ltc4150 interrupt handler
*
* This handler shall be called on ltc4150 interrupt, it is implemented in the
* driver.
*/
void ltc4150_interrupt(void);

2
drivers/include/nvram-spi.h

@ -7,7 +7,7 @@
*/
/**
* @ingroup nvram
* @ingroup drivers_nvram
* @{
*
* @file

2
drivers/include/nvram.h

@ -7,7 +7,7 @@
*/
/**
* @defgroup nvram Non-volatile RAM
* @defgroup drivers_nvram Non-volatile RAM
* @ingroup drivers
* @brief Non-volatile RAM interface
*

2
drivers/include/pcd8544.h

@ -8,7 +8,7 @@
/**
* @defgroup driver_pcd8544 PCD8544 LCD driver
* @ingroup drivers
* @ingroup drivers_actuators
* @brief Driver for PCD8544 LCD displays
*
* @{

2
drivers/include/rgbled.h

@ -8,7 +8,7 @@
/**
* @defgroup driver_rgbled RGB-LED driver
* @ingroup drivers
* @ingroup drivers_actuators
* @brief High-level driver for RGB-LEDs
* @{
*

2
drivers/include/servo.h

@ -9,7 +9,7 @@
/**
* @defgroup driver_servo Servo Motor Driver
* @ingroup drivers
* @ingroup drivers_actuators
* @brief High-level driver for servo motors
* @{
*

4
drivers/include/sht11.h

@ -10,9 +10,9 @@
#define SHT11_H_
/**
* @defgroup sht11 SHT11
* @brief Driver for Sensirion SHT11 Humidity and Temperature Sensor
* @defgroup drivers_sht11 SHT11
* @ingroup drivers_sensors
* @brief Driver for Sensirion SHT11 Humidity and Temperature Sensor
* @{
*
* @file

3
drivers/include/tcs37727.h

@ -8,8 +8,7 @@
/**
* @defgroup drivers_tcs37727 TCS37727 Light-To-Digital Converter
*
* @ingroup drivers
* @ingroup drivers_sensors
* @brief Driver for the AMS TCS37727 Color Light-To-Digital Converter
*
*

Loading…
Cancel
Save