Merge branch 'gpioIntFix' of github.com:dailab/RIOT into gpioIntFix

drivers/bmp180/include/bmp180_internals.h

@@ -7,8 +7,7 @@
  */
 
 /**
- * @defgroup    drivers_bmp180 BMP180
- * @ingroup     drivers_sensors
+ * @ingroup     drivers_bmp180
  * @brief       Internal addresses, registers, constants for the BMP180 sensor.
  * @{
  *

drivers/include/adcxx1c.h

@@ -10,13 +10,13 @@
  * @defgroup   drivers_adcxx1x ADCXX1C ADC device driver
  * @ingroup    drivers_sensors
  * @brief      I2C Analog-to-Digital Converter device driver
+ *
+ *             This driver works with adc081c, adc101c and adc121c versions.
  * @{
  *
  * @file
  * @brief      ADCXX1C ADC device driver
  *
- *             This driver works with adc081c, adc101c and adc121c versions.
- *
  * @author     Vincent Dupont <[email protected]>
  */
 

drivers/include/bmp180.h

@@ -7,9 +7,9 @@
  */
 
 /**
- * @defgroup    drivers_bmp180 BMP180
+ * @defgroup    drivers_bmp180 BMP180 temperature and pressure sensor
  * @ingroup     drivers_sensors
- * @brief       Device driver interface for the BMP180 sensor
+ * @brief       Device driver interface for the BMP180 sensor.
  * @{
  *
  * @file

drivers/include/bmx280.h

@@ -8,9 +8,16 @@
  */
 
 /**
- * @defgroup    drivers_bmx280 BMX280
+ * @defgroup    drivers_bmx280 BMP280/BME280 temperature, pressure and humidity sensor
  * @ingroup     drivers_sensors
- * @brief       Device driver interface for the BMX280 sensors (BMP280 and BME280).
+ * @brief       Device driver interface for the Bosch BMP280 and BME280 sensors.
+ *
+ * BMP280 and BME280 measure temperature in centi °C and pressure in Pa. BME280
+ * can also measure relative humidity in %.
+ *
+ * For more information, see the datasheets:
+ * * [BMP280](https://ae-bst.resource.bosch.com/media/_tech/media/datasheets/BST-BMP280-DS001-18.pdf)
+ * * [BME280](https://ae-bst.resource.bosch.com/media/_tech/media/datasheets/BST-BME280_DS001-11.pdf)
  *
  * @{
  * @file

drivers/include/cc110x.h

@@ -8,9 +8,9 @@
  */
 
 /**
- * @defgroup    drivers_cc110x CC110x
+ * @defgroup    drivers_cc110x CC1100/CC1101 radio driver
  * @ingroup     drivers_netdev
- * @brief       TI CC110x
+ * @brief       Driver for TI CC1100/CC1101 radios
  * @{
  * @file
  * @brief       Public interface for cc110x driver

drivers/include/cc2420.h

@@ -7,7 +7,7 @@
  */
 
 /**
- * @defgroup    drivers_cc2420 CC2420 driver
+ * @defgroup    drivers_cc2420 CC2420 radio driver
  * @ingroup     drivers_netdev
  * @{
  *

drivers/include/io1_xplained.h

@@ -7,13 +7,30 @@
  */
 
 /**
- * @defgroup    drivers_io1_xplained IO1_XPLAINED
+ * @defgroup    drivers_io1_xplained Atmel IO1 Xplained Extension board
  * @ingroup     drivers_sensors
- * @brief       Device driver interface for the IO1 Xplained extension.
+ * @brief       Device driver interface for the Atmel IO1 Xplained extension.
+ *
+ * This board contains several sensors and actuators:
+ * * @ref drivers_at30tse75x
+ * * TEMT6000 Light sensor (not yet supported by this driver)
+ * * microSD card connector (not yet supported by this driver)
+ * * one yellow LED
+ * * 2 GPIO pins
+ *
+ * This board can be used with the following Atmel evaluation boards:
+ * * @ref boards_samr21-xpro
+ * * @ref boards_samd21-xpro
+ * * @ref boards_saml21-xpro
+ *
+ * See the [datasheet]
+ * (http://www.atmel.com/images/atmel-42078-io1-xplained-pro_user-guide.pdf)
+ * for more information
+ *
  * @{
  *
  * @file
- * @brief       Device driver interface for the IO1 Xplained extention.
+ * @brief       Device driver interface for the Atmel IO1 Xplained extention.
  *
  * @author      Alexandre Abadie <[email protected]>
  */

drivers/include/led.h

@@ -8,7 +8,7 @@
 
 /**
  * @defgroup    drivers_led Control on-board LEDs
- * @ingroup     drivers
+ * @ingroup     drivers_actuators
  * @brief       Access macros to control the on-board LEDs
  *
  * This header contains a set of macros for controlling the on-board LEDs of

drivers/include/lsm6dsl.h

@@ -13,10 +13,13 @@
  * @brief       Device driver for the LSM6DSL 3D accelerometer/gyroscope
  *
  * @{
+ *
  * @file
  * @brief       Device driver interface for the LSM6DSL 3D accelerometer/gyroscope.
  *
  * @author      Vincent Dupont <[email protected]>
+ * @author      Sebastian Meiling <[email protected]>
+ *
  */
 
 #ifndef LSM6DSL_H
@@ -28,7 +31,9 @@ extern "C" {
 
 #include "periph/i2c.h"
 
-/** Data rate */
+/**
+ * @brief Data rate settings
+ */
 enum {
     LSM6DSL_DATA_RATE_POWER_DOWN = 0x0,
     LSM6DSL_DATA_RATE_1_6HZ      = 0xB,
@@ -44,35 +49,45 @@ enum {
     LSM6DSL_DATA_RATE_6_66KHZ    = 0xa,
 };
 
-/** Decimation */
+/**
+ * @brief Decimation settings
+ */
 enum {
     LSM6DSL_DECIMATION_NOT_IN_FIFO = 0,
-    LSM6DSL_DECIMATION_NO          = 1,
-    LSM6DSL_DECIMATION_2           = 2,
-    LSM6DSL_DECIMATION_3           = 3,
-    LSM6DSL_DECIMATION_4           = 4,
-    LSM6DSL_DECIMATION_8           = 5,
-    LSM6DSL_DECIMATION_16          = 6,
-    LSM6DSL_DECIMATION_32          = 7,
+    LSM6DSL_DECIMATION_NO,
+    LSM6DSL_DECIMATION_2,
+    LSM6DSL_DECIMATION_3,
+    LSM6DSL_DECIMATION_4,
+    LSM6DSL_DECIMATION_8,
+    LSM6DSL_DECIMATION_16,
+    LSM6DSL_DECIMATION_32,
 };
 
-/** Accelerometer full scale */
+/**
+ * @brief Accelerometer full scale
+ */
 enum {
     LSM6DSL_ACC_FS_2G  = 0,
-    LSM6DSL_ACC_FS_4G  = 2,
-    LSM6DSL_ACC_FS_8G  = 3,
-    LSM6DSL_ACC_FS_16G = 1,
+    LSM6DSL_ACC_FS_16G,
+    LSM6DSL_ACC_FS_4G,
+    LSM6DSL_ACC_FS_8G,
+    LSM6DSL_ACC_FS_MAX,
 };
 
-/** Gyroscope full scale */
+/**
+ * @brief Gyroscope full scale
+ */
 enum {
     LSM6DSL_GYRO_FS_245DPS    = 0,
-    LSM6DSL_GYRO_FS_500DPS    = 1,
-    LSM6DSL_GYRO_FS_1000DPS   = 2,
-    LSM6DSL_GYRO_FS_2000DPS   = 3,
+    LSM6DSL_GYRO_FS_500DPS,
+    LSM6DSL_GYRO_FS_1000DPS,
+    LSM6DSL_GYRO_FS_2000DPS,
+    LSM6DSL_GYRO_FS_MAX,
 };
 
-/** LSM6DSL driver parameters */
+/**
+ * @brief LSM6DSL driver parameters
+ */
 typedef struct {
     i2c_t i2c;                  /**< i2c bus */
     uint8_t addr;               /**< i2c address */
@@ -84,25 +99,39 @@ typedef struct {
     uint8_t gyro_decimation;    /**< gyroscope decimation */
 } lsm6dsl_params_t;
 
-/** LSM6DSL device descriptor */
+/**
+ * @brief LSM6DSL device descriptor
+ */
 typedef struct {
     lsm6dsl_params_t params; /**< driver parameters */
 } lsm6dsl_t;
 
-/** 3D output data */
+/**
+ * @brief 3D output data
+ */
 typedef struct {
     int16_t x;  /**< X axis */
     int16_t y;  /**< Y axis */
     int16_t z;  /**< Z axis */
 } lsm6dsl_3d_data_t;
 
+/**
+ * @brief Named return values
+ */
+enum {
+    LSM6DSL_OK = 0,             /**< all good */
+    LSM6DSL_ERROR_BUS,          /**< I2C bus error */
+    LSM6DSL_ERROR_CNF,          /**< Config error */
+    LSM6DSL_ERROR_DEV,          /**< device error */
+};
+
 /**
  * @brief Initialize a LSM6DSL device
  *
- * @param[in] dev     device to initialize
+ * @param[out] dev     device to initialize
  * @param[in] params  driver parameters
  *
- * @return 0 on success
+ * @return LSM6DSL_OK on success
  * @return < 0 on error
  */
 int lsm6dsl_init(lsm6dsl_t *dev, const lsm6dsl_params_t *params);
@@ -113,7 +142,7 @@ int lsm6dsl_init(lsm6dsl_t *dev, const lsm6dsl_params_t *params);
  * @param[in] dev    device to read
  * @param[out] data  accelerometer values
  *
- * @return 0 on success
+ * @return LSM6DSL_OK on success
  * @return < 0 on error
  */
 int lsm6dsl_read_acc(const lsm6dsl_t *dev, lsm6dsl_3d_data_t *data);
@@ -124,18 +153,22 @@ int lsm6dsl_read_acc(const lsm6dsl_t *dev, lsm6dsl_3d_data_t *data);
  * @param[in] dev    device to read
  * @param[out] data  gyroscope values
  *
- * @return 0 on success
+ * @return LSM6DSL_OK on success
  * @return < 0 on error
  */
 int lsm6dsl_read_gyro(const lsm6dsl_t *dev, lsm6dsl_3d_data_t *data);
 
 /**
  * @brief Read temperature data
  *
+ * @note To avoid floating point data types but still provide high resolution
+ *       for temperature readings, resulting values are scale by factor 100.
+ *
+ *
  * @param[in] dev    device to read
- * @param[out] data  temperature value
+ * @param[out] data  temperature value, in °C x 100
  *
- * @return 0 on success
+ * @return LSM6DSL_OK on success
  * @return < 0 on error
  */
 int lsm6dsl_read_temp(const lsm6dsl_t *dev, int16_t *data);

drivers/include/mpu9150.h

@@ -7,7 +7,7 @@
  */
 
 /**
- * @defgroup    drivers_mpu9150 MPU-9150
+ * @defgroup    drivers_mpu9150 MPU-9150 accelerometer/magnetometer/gyroscope
  * @ingroup     drivers_sensors
  * @brief       Device driver interface for the MPU-9150
  * @{

drivers/include/sht11.h

@@ -10,7 +10,7 @@
 #define SHT11_H
 
 /**
- * @defgroup    drivers_sht11   SHT11
+ * @defgroup    drivers_sht11 SHT11 Humidity and Temperature Sensor
  * @ingroup     drivers_sensors
  * @brief       Driver for Sensirion SHT11 Humidity and Temperature Sensor
  * @{

drivers/include/si70xx.h

@@ -7,7 +7,7 @@
  */
 
 /**
- * @defgroup    driver_si70xx Si70xx
+ * @defgroup    driver_si70xx Si7006/13/20/21 temperature and humidity sensors
  * @ingroup     drivers_sensors
  * @brief       Driver for the Si7006/13/20/21 temperature and humidity sensor.
  * @{

drivers/include/srf02.h

@@ -8,7 +8,7 @@
  */
 
 /**
- * @defgroup    driver_srf02 SRF02
+ * @defgroup    driver_srf02 SRF02 ultrasonic range sensor
  * @ingroup     drivers_sensors
  * @brief       Driver for the SRF02 ultrasonic range sensor
  * @{

drivers/include/sx127x.h

@@ -8,21 +8,21 @@
  */
 
 /**
- * @defgroup    drivers_sx127x SX127X
+ * @defgroup    drivers_sx127x Semtech SX1272 and SX1276 radios driver
  * @ingroup     drivers_netdev
- * @brief       Semtech SX127X driver (SX1272 and SX1276)
+ * @brief       Driver for Semtech SX1272 and SX1276 radios.
  *
  * This module contains the driver for radio devices of the Semtech SX127x
  * series (SX1272 and SX1276).
  * Only LoRa long range modem is supported at the moment.
  *
- * SX127x modules are designed to be used in the ISM RF band. This RF band
- * depends on different regional regulatory worldwide.
+ * SX127x modules are designed to be used in the ISM radio frequency (RF) band.
+ * This RF band depends on different regional regulations worldwide.
  * Be careful to configure the device to use a RF frequency allowed in your
  * region.
- * sHere is the list of allowed frequencies for your region (see
+ * Here is the list of allowed frequencies for your region (see
  * [LoRaWAN regional parameters document available online]
- * (https://www.lora-alliance.org/Contact/RequestSpecificationForm.aspx))
+ * (https://www.lora-alliance.org/for-developers)):
  * - Europe has 2 allowed bands (ETSI):
  *   - EU863-870
  *   - EU433 (from 433.175MHZ to 434.665MHZ exactly)
@@ -261,10 +261,10 @@ typedef struct {
 typedef uint8_t sx127x_flags_t;
 
 /**
- * @brief   SX127X device.
+ * @brief   SX127X device descriptor.
  * @extends netdev_t
  */
-typedef struct sx127x_s {
+typedef struct {
     netdev_t netdev;                   /**< Netdev parent struct */
     sx127x_radio_settings_t settings;  /**< Radio settings */
     sx127x_params_t params;            /**< Device driver parameters */
@@ -421,7 +421,7 @@ void sx127x_set_channel(sx127x_t *dev, uint32_t freq);
 /**
  * @brief   Computes the packet time on air in milliseconds.
  *
- * @pre     Can only be called once sx127x_init_radio_settings have already
+ * @pre     Can only be called if sx127x_init_radio_settings has already
  *          been called.
  *
  * @param[in] dev                      The sx127x device descriptor

drivers/include/tsl2561.h

@@ -7,9 +7,9 @@
  */
 
 /**
- * @defgroup    drivers_tsl2561 TSL2561
+ * @defgroup    drivers_tsl2561 TSL2561 illuminance sensor
  * @ingroup     drivers_sensors
- * @brief       Device driver interface for the illuminance  TSL2561 sensor
+ * @brief       Device driver interface for the illuminance TSL2561 sensor
  * @{
  *
  * @file

drivers/include/veml6070.h

@@ -7,7 +7,7 @@
  */
 
 /**
- * @defgroup    drivers_veml6070 VEML6070
+ * @defgroup    drivers_veml6070 VEML6070 UV sensor
  * @ingroup     drivers_sensors
  * @brief       Device driver interface for the VEML6070 UV sensor
  * @{