From f15e4793887b94dda0b47cc10cef08c4b58abfc8 Mon Sep 17 00:00:00 2001 From: Akshai M Date: Mon, 6 Apr 2020 12:20:49 +0530 Subject: [PATCH 01/30] drivers/doc.txt : Add sub-groups Added Compile Config subgroups for sensors, netdev, actuators, storage,soft_periph and misc to Doxygen --- drivers/doc.txt | 44 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 44 insertions(+) diff --git a/drivers/doc.txt b/drivers/doc.txt index f7d904ab69..87ff35a23b 100644 --- a/drivers/doc.txt +++ b/drivers/doc.txt @@ -72,3 +72,47 @@ * @brief Drivers for different kinds of devices that do not match any * other category */ + +/** + * @defgroup config_drivers_netdev Network Device Configurations + * @ingroup config + * @brief Compile time configurations for external network devices + */ + +/** + * @defgroup config_drivers_sensors Sensor Device Configurations + * @ingroup config + * @brief Compile time configurations for Sensors + */ + +/** + * @defgroup config_drivers_actuators Actuator Device Configurations + * @ingroup config + * @brief Compile time configurations for actuating devices + */ + +/** + * @defgroup config_drivers_storage Storage Device Configurations + * @ingroup config + * @brief Compile time configurations for storage devices + */ + + /** + * @defgroup config_drivers_display Display Device Configurations + * @ingroup config + * @brief Compile time configurations for display devices + */ + +/** + * @defgroup config_drivers_soft_periph Soft Peripheral Configurations + * @ingroup config + * @brief Compile time configurations for Software emulated + * @ref drivers_periph for UART, SPI, etc + */ + +/** + * @defgroup config_drivers_misc Miscellaneous Device Configurations + * @ingroup config + * @brief Compile time configurations for different kinds of + * devices that do not match any other category + */ \ No newline at end of file From 013c161e1c42154689dc0b001626d92a347fc30f Mon Sep 17 00:00:00 2001 From: Akshai M Date: Mon, 6 Apr 2020 12:21:05 +0530 Subject: [PATCH 02/30] drivers/include/hdc1000.h : Compile Configs --- drivers/include/hdc1000.h | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/drivers/include/hdc1000.h b/drivers/include/hdc1000.h index 5003644e70..a5c48b7441 100644 --- a/drivers/include/hdc1000.h +++ b/drivers/include/hdc1000.h @@ -51,8 +51,16 @@ extern "C" { #endif +/** + * @defgroup drivers_hdc1000_config HDC1000 Humidity and Temperature Sensor driver compile configuration + * @ingroup config_drivers_sensors + * @{ + */ /** * @brief Default I2C bus address of HDC1000 devices + * + * The address value depends on the state of ADR0 and ADR1 Pins + * For more details refer Section 8.5.1 of datasheet */ #ifndef HDC1000_I2C_ADDRESS #define HDC1000_I2C_ADDRESS (0x43) @@ -68,6 +76,7 @@ extern "C" #ifndef HDC1000_CONVERSION_TIME #define HDC1000_CONVERSION_TIME (26000) #endif +/** @} */ /** * @brief HDC1000 specific return values From dba177c8aa991c8303da3233629597afa2cca0b8 Mon Sep 17 00:00:00 2001 From: Akshai M Date: Mon, 6 Apr 2020 12:21:12 +0530 Subject: [PATCH 03/30] drivers/include/ili9341.h : Compile Configs --- drivers/include/ili9341.h | 35 ++++++++++++++++++++--------------- 1 file changed, 20 insertions(+), 15 deletions(-) diff --git a/drivers/include/ili9341.h b/drivers/include/ili9341.h index ab2c083d32..638ca8a4a1 100644 --- a/drivers/include/ili9341.h +++ b/drivers/include/ili9341.h @@ -44,43 +44,48 @@ extern "C" { #endif -#ifndef ILI9341_GVDD /** - * @brief ili9341 gvdd level. + * @defgroup drivers_ili9341_config ILI9341 display driver compile configuration + * @ingroup config_drivers_display + * @{ + */ +/** + * @brief ILI9341 gvdd level. * * Default GVDD voltage of 4.8V */ +#ifndef ILI9341_GVDD #define ILI9341_GVDD 4800 +#endif -#endif /* ILI9341_GVDD */ - -#ifndef ILI9341_VCOMH /** - * @brief ili9341 VCOMH voltage level. + * @brief ILI9341 VCOMH voltage level. * * Default VCOMH voltage of 4.25V */ +#ifndef ILI9341_VCOMH #define ILI9341_VCOMH 4250 +#endif -#endif /* ILI9341_VCOMH */ - -#ifndef ILI9341_VCOML /** - * @brief ili9341 VCOML voltage level. + * @brief ILI9341 VCOML voltage level. * * Default VCOMH voltage of -2V */ +#ifndef ILI9341_VCOML #define ILI9341_VCOML -2000 +#endif -#endif /* ILI9341_VCOML */ - -#ifndef ILI9341_LE_MODE /** - * @brief Compile time switch to change the driver to convert little endian - * colors to big endian. + * @brief Convert little endian colors to big endian. + * + * Compile time switch to change the driver to convert little endian + * colors to big endian. */ +#ifndef ILI9341_LE_MODE #define ILI9341_LE_MODE (0) #endif +/** @} */ /** * @brief Device initialization parameters From 4f31c405265a944beaaac709442f2d685811b327 Mon Sep 17 00:00:00 2001 From: Akshai M Date: Mon, 6 Apr 2020 12:21:18 +0530 Subject: [PATCH 04/30] drivers/include/kw2xrf.h : Compile Configs --- drivers/include/kw2xrf.h | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/drivers/include/kw2xrf.h b/drivers/include/kw2xrf.h index 9058fba367..69901def61 100644 --- a/drivers/include/kw2xrf.h +++ b/drivers/include/kw2xrf.h @@ -43,10 +43,13 @@ extern "C" { #define KW2XRF_MAX_PKT_LENGTH (IEEE802154_FRAME_LEN_MAX) /** - * @name Default channel used after initialization - * + * @defgroup drivers_kw2xrf_config CR20A and KW2xD radio driver compile configuration + * @ingroup config_drivers_netdev * @{ */ +/** + * @brief Default channel used after initialization. + */ #ifndef KW2XRF_DEFAULT_CHANNEL #define KW2XRF_DEFAULT_CHANNEL (CONFIG_IEEE802154_DEFAULT_CHANNEL) #endif From 5e2478b3c54a3f3af97d934e21037e4c80b983f6 Mon Sep 17 00:00:00 2001 From: Akshai M Date: Mon, 6 Apr 2020 12:21:27 +0530 Subject: [PATCH 05/30] drivers/include/kw41zrf.h : Compile Configs --- drivers/include/kw41zrf.h | 13 +++++-------- 1 file changed, 5 insertions(+), 8 deletions(-) diff --git a/drivers/include/kw41zrf.h b/drivers/include/kw41zrf.h index 1d96b4ad2c..582d7665ec 100644 --- a/drivers/include/kw41zrf.h +++ b/drivers/include/kw41zrf.h @@ -39,29 +39,26 @@ extern "C" { #define KW41ZRF_MAX_PKT_LENGTH (IEEE802154_FRAME_LEN_MAX) /** - * @brief Default channel used after initialization - * + * @defgroup drivers_kw41zrf_config KW41Z, KW21Z in-cpu transceiver driver compile configuration + * @ingroup config_drivers_netdev * @{ */ +/** + * @brief Default channel used after initialization + */ #ifndef KW41ZRF_DEFAULT_CHANNEL #define KW41ZRF_DEFAULT_CHANNEL (CONFIG_IEEE802154_DEFAULT_CHANNEL) #endif -/** @} */ /** * @brief Default CCA threshold - * - * @{ */ #ifndef KW41ZRF_DEFAULT_CCA_THRESHOLD #define KW41ZRF_DEFAULT_CCA_THRESHOLD (-60) #endif -/** @} */ /** * @brief Default LQI compensation - * - * @{ */ #ifndef KW41ZRF_DEFAULT_LQI_COMPENSATION #define KW41ZRF_DEFAULT_LQI_COMPENSATION (102) From 56cb11344bb069be65e0ff1a4c8d02317dc8cc79 Mon Sep 17 00:00:00 2001 From: Akshai M Date: Mon, 6 Apr 2020 12:21:30 +0530 Subject: [PATCH 06/30] drivers/include/mag3110.h : Compile Configs --- drivers/include/mag3110.h | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/drivers/include/mag3110.h b/drivers/include/mag3110.h index 6e6e2de8cb..034f629089 100644 --- a/drivers/include/mag3110.h +++ b/drivers/include/mag3110.h @@ -54,9 +54,21 @@ enum { MAG3110_ERROR_CNF, /**< Device configuration failed */ }; +/** + * @defgroup drivers_mag3110_config MAG3110 Magnetometer driver compile configuration + * @ingroup config_drivers_sensors + * @{ + */ +/** + * @brief Magnetometer default address + * + * The address depends on part number of MAG3110. + * For more information on SerialBus Address, refer Table 1 in Technical datasheet(MAG3110). + */ #ifndef MAG3110_I2C_ADDRESS -#define MAG3110_I2C_ADDRESS 0x0E /**< Magnetometer Default Address */ +#define MAG3110_I2C_ADDRESS 0x0E #endif +/** @} */ /** * @name Output data rate macros From b812772e403dbb2f9697d112080d31a0bdaf7c38 Mon Sep 17 00:00:00 2001 From: Akshai M Date: Mon, 6 Apr 2020 12:21:34 +0530 Subject: [PATCH 07/30] drivers/include/motor_driver.h : Compile Configs --- drivers/include/motor_driver.h | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/drivers/include/motor_driver.h b/drivers/include/motor_driver.h index 943f3d7cc7..a51f602c88 100644 --- a/drivers/include/motor_driver.h +++ b/drivers/include/motor_driver.h @@ -91,12 +91,18 @@ extern "C" { #endif +/** + * @defgroup drivers_motor_driver_config Motor_Driver driver compile configuration + * @ingroup config_drivers_actuators + * @{ + */ /** * @brief Maximum number of motors by motor driver */ #ifndef MOTOR_DRIVER_MAX #define MOTOR_DRIVER_MAX (2) -#endif /* MOTOR_DRIVER_MAX */ +#endif +/** @} */ /** * @brief Macro to return motor driver id From 2405ca3721644283734599318400bce24f95e8c5 Mon Sep 17 00:00:00 2001 From: Akshai M Date: Mon, 6 Apr 2020 12:21:39 +0530 Subject: [PATCH 08/30] drivers/include/mpl3115a2.h : Compile Configs --- drivers/include/mpl3115a2.h | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/drivers/include/mpl3115a2.h b/drivers/include/mpl3115a2.h index 6678d4a6fd..1ab7f08141 100644 --- a/drivers/include/mpl3115a2.h +++ b/drivers/include/mpl3115a2.h @@ -74,14 +74,20 @@ enum { #define MPL3115A2_OS_RATIO_DEFAULT MPL3115A2_OS_RATIO_16 /**< Default Ratio */ /** @} */ -#ifndef MPL3115A2_CONVERSION_TIME +/** + * @defgroup drivers_mpl3115a2_config MPL3115A2 Pressure Sensor driver compile configuration + * @ingroup config_drivers_sensors + * @{ + */ /** * @brief Maximum Conversion Time in microseconds [us] * * @note Conversion time is: ((oversampling ratio * 4) + 2) * 1000 us */ +#ifndef MPL3115A2_CONVERSION_TIME #define MPL3115A2_CONVERSION_TIME (514000UL) #endif +/** @} */ /** * @brief Configuration parameters From 4744401bb51537ce4336f02f5fc7e261063866ea Mon Sep 17 00:00:00 2001 From: Akshai M Date: Mon, 6 Apr 2020 12:21:42 +0530 Subject: [PATCH 09/30] drivers/include/mtd_sdcard.h : Compile Configs --- drivers/include/mtd_sdcard.h | 17 ++++++++++++----- 1 file changed, 12 insertions(+), 5 deletions(-) diff --git a/drivers/include/mtd_sdcard.h b/drivers/include/mtd_sdcard.h index bc59aec946..5f6881aee8 100644 --- a/drivers/include/mtd_sdcard.h +++ b/drivers/include/mtd_sdcard.h @@ -43,16 +43,23 @@ typedef struct { const sdcard_spi_params_t *params; /**< params for sdcard_spi init */ } mtd_sdcard_t; - /** - * @brief sdcards handle sector erase internally so it's possible to directly - * write to the card without erasing the sector first. - * Attention: an erase call will therefore NOT touch the content, - * so disable this feature to ensure overriding the data. + * @defgroup drivers_mtd_sdcard_config SDCard driver compile configuration + * @ingroup config_drivers_storage + * @{ + */ +/** + * @brief Enable Skip SDCard Erase + * @note SDCards handle sector erase internally so it's + * possible to directly write to the card without erasing + * the sector first. + * Attention: an erase call will therefore NOT touch the content, + * so disable this feature to ensure overriding the data. */ #ifndef MTD_SDCARD_SKIP_ERASE #define MTD_SDCARD_SKIP_ERASE (1) #endif +/** @} */ /** * @brief sdcard device operations table for mtd From f39b320b5df64f8267ff5bd6a65a2a683245db68 Mon Sep 17 00:00:00 2001 From: Akshai M Date: Mon, 6 Apr 2020 12:21:45 +0530 Subject: [PATCH 10/30] drivers/include/opt3001.h : Compile Configs --- drivers/include/opt3001.h | 24 ++++++++++++++++-------- 1 file changed, 16 insertions(+), 8 deletions(-) diff --git a/drivers/include/opt3001.h b/drivers/include/opt3001.h index ed89010c3b..16264f6ada 100644 --- a/drivers/include/opt3001.h +++ b/drivers/include/opt3001.h @@ -49,14 +49,6 @@ extern "C" { #endif -/** - * @brief OPT3001 Default Address - * - * If set to 0x44 the corresponding ADDR PIN is GND. - */ -#ifndef OPT3001_I2C_ADDRESS -#define OPT3001_I2C_ADDRESS (0x45) -#endif /** * @name Conversion time @@ -66,6 +58,21 @@ extern "C" { #define OPT3001_CONVERSION_TIME_800_MS (0x0800) /**< Conversion time of 800ms */ /** @} */ +/** + * @defgroup drivers_opt3001_config OPT3001 Ambient Light Sensor driver compile configuration + * @ingroup config_drivers_sensors + * @{ + */ +/** + * @brief OPT3001 Default Address + * + * If set to 0x45 the ADDR PIN should be connected to VDD. + * For more information on SerialBus Address, refer section 7.3.4.1 in datasheet. + */ +#ifndef OPT3001_I2C_ADDRESS +#define OPT3001_I2C_ADDRESS (0x45) +#endif + /** * @brief OPT3001 Default conversion time * @@ -75,6 +82,7 @@ extern "C" { #ifndef OPT3001_CONVERSION_TIME #define OPT3001_CONVERSION_TIME OPT3001_CONVERSION_TIME_800_MS #endif +/** @} */ /** * @brief Parameters needed for device initialization From 4c4c9f0c2b468022d5ea8c6512122fad9c2a92bc Mon Sep 17 00:00:00 2001 From: Akshai M Date: Mon, 6 Apr 2020 12:21:47 +0530 Subject: [PATCH 11/30] drivers/include/pir.h : Compile Configs --- drivers/include/pir.h | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/drivers/include/pir.h b/drivers/include/pir.h index e0be71234d..5e2db9102f 100644 --- a/drivers/include/pir.h +++ b/drivers/include/pir.h @@ -62,11 +62,17 @@ typedef struct { } pir_t; /** - * @brief value to configure sensitivity of sensore + * @defgroup drivers_pir_config PIR Motion Sensor driver compile configuration + * @ingroup config_drivers_sensors + * @{ + */ +/** + * @brief Sensitivity of sensor */ #ifndef PIR_MSG_T_STATUS_START #define PIR_MSG_T_STATUS_START 150 #endif +/** @} */ /** * @brief event type for a PIR sensor From 1d3c2c4320d18f6692c47de1176812c8ad49b497 Mon Sep 17 00:00:00 2001 From: Akshai M Date: Mon, 6 Apr 2020 12:21:50 +0530 Subject: [PATCH 12/30] drivers/include/pn532.h : Compile Configs --- drivers/include/pn532.h | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/drivers/include/pn532.h b/drivers/include/pn532.h index 1130854601..4f591374b8 100644 --- a/drivers/include/pn532.h +++ b/drivers/include/pn532.h @@ -72,16 +72,22 @@ typedef struct { mutex_t trap; /**< Mutex to wait for chip response */ } pn532_t; +/** + * @defgroup drivers_pn532_config PN532 NFC Radio driver compile configuration + * @ingroup config_drivers_netdev + * @{ + */ /** * @brief Internal buffer size * - * A small buffer size is enough for most applications, however if large NDEF + * @note A small buffer size is enough for most applications, however if large NDEF * files are to be written this size shall be increased. Otherwise the files * can be written in chunks. */ #ifndef PN532_BUFFER_LEN #define PN532_BUFFER_LEN (64) #endif +/** @} */ /** * @name Helpers to extract firmware information from word From 4333a9f29967a671ae3974cf9debdb9556cec24e Mon Sep 17 00:00:00 2001 From: Akshai M Date: Mon, 6 Apr 2020 12:21:55 +0530 Subject: [PATCH 13/30] drivers/include/rn2xx3.h : Compile Configs --- drivers/include/rn2xx3.h | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/drivers/include/rn2xx3.h b/drivers/include/rn2xx3.h index b54c2e401a..7f0f24cadf 100644 --- a/drivers/include/rn2xx3.h +++ b/drivers/include/rn2xx3.h @@ -56,12 +56,18 @@ extern "C" { */ #define RN2XX3_SLEEP_MIN (100U) +/** + * @defgroup drivers_rn2xx3_config RN2483/RN2903 Radio driver compile configuration + * @ingroup config_drivers_netdev + * @{ + */ /** * @brief Default sleep duration (in ms) */ #ifndef RN2XX3_DEFAULT_SLEEP #define RN2XX3_DEFAULT_SLEEP (5000U) #endif +/** @} */ #if defined(MODULE_RN2903) #define RN2XX3_FREQ_BAND (915U) From c63bdca3ab9ba088b918647c6480bce467236e5e Mon Sep 17 00:00:00 2001 From: Akshai M Date: Mon, 6 Apr 2020 12:21:58 +0530 Subject: [PATCH 14/30] drivers/include/slipdev.h : Compile Configs --- drivers/include/slipdev.h | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/drivers/include/slipdev.h b/drivers/include/slipdev.h index 435c8703bd..dcaa8b18e2 100644 --- a/drivers/include/slipdev.h +++ b/drivers/include/slipdev.h @@ -32,6 +32,11 @@ extern "C" { #endif +/** + * @defgroup drivers_slipdev_config SLIP Network driver compile configuration + * @ingroup config_drivers_netdev + * @{ + */ /** * @brief UART buffer size used for TX and RX buffers * @@ -43,6 +48,7 @@ extern "C" { #ifndef SLIPDEV_BUFSIZE #define SLIPDEV_BUFSIZE (2048U) #endif +/** @} */ /** * @name Device state definitions From 462e321ec02be1031d6433c86c45404f4c432736 Mon Sep 17 00:00:00 2001 From: Akshai M Date: Mon, 6 Apr 2020 12:22:00 +0530 Subject: [PATCH 15/30] drivers/include/soft_spi.h : Compile Configs --- drivers/include/soft_spi.h | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/drivers/include/soft_spi.h b/drivers/include/soft_spi.h index 456bd754bd..4ba55d87e8 100644 --- a/drivers/include/soft_spi.h +++ b/drivers/include/soft_spi.h @@ -36,6 +36,11 @@ extern "C" { #endif +/** + * @defgroup drivers_softspi_config Software SPI driver compile configuration + * @ingroup config_drivers_soft_periph + * @{ + */ /** * @brief Default SPI device access macro */ @@ -56,6 +61,7 @@ extern "C" { #ifndef SOFT_SPI_CS_UNDEF #define SOFT_SPI_CS_UNDEF (GPIO_UNDEF) #endif +/** @} */ /** * @brief Default type for SPI devices From 0ac93bfb07c562c9bc2b9b0a0c5bed557ecac194 Mon Sep 17 00:00:00 2001 From: Akshai M Date: Mon, 6 Apr 2020 12:22:03 +0530 Subject: [PATCH 16/30] drivers/include/sps30.h : Compile Configs --- drivers/include/sps30.h | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/drivers/include/sps30.h b/drivers/include/sps30.h index 821d12b56c..f9ca3a6cc2 100644 --- a/drivers/include/sps30.h +++ b/drivers/include/sps30.h @@ -127,6 +127,11 @@ typedef enum { */ #define SPS30_DEFAULT_ACI_S (604800UL) +/** + * @defgroup drivers_SPS30_config SPS30 PM Sensor driver compile configuration + * @ingroup config_drivers_sensors + * @{ + */ /** * @brief Maximum number of automatic retries on communication errors * @@ -142,6 +147,7 @@ typedef enum { #ifndef SPS30_ERROR_RETRY #define SPS30_ERROR_RETRY (500U) #endif +/** @} */ /** * @brief Initialize SPS30 sensor driver. From a6d7eab027efd44071232d2be63a78015176ba03 Mon Sep 17 00:00:00 2001 From: Akshai M Date: Mon, 6 Apr 2020 12:22:08 +0530 Subject: [PATCH 17/30] drivers/include/tcs37727.h : Compile Configs --- drivers/include/tcs37727.h | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/drivers/include/tcs37727.h b/drivers/include/tcs37727.h index 3e2e66a5aa..b0f444291a 100644 --- a/drivers/include/tcs37727.h +++ b/drivers/include/tcs37727.h @@ -40,9 +40,18 @@ extern "C" #define TCS37727_I2C_ADDRESS 0x29 /**< Default Device Address */ #endif +/** + * @defgroup drivers_tcs37727_config TCS37727 RGB Light Sensor driver compile configuration + * @ingroup config_drivers_sensors + * @{ + */ +/** + * @brief Default RGBC integration time. + */ #ifndef TCS37727_ATIME_DEFAULT -#define TCS37727_ATIME_DEFAULT 200000 /**< Default RGBC integration time */ +#define TCS37727_ATIME_DEFAULT 200000 #endif +/** @} */ /** * @brief Struct for storing TCS37727 sensor data From 10d6b7a976e9b1acfdd99fbd1f476d682b0da9c1 Mon Sep 17 00:00:00 2001 From: Akshai M Date: Mon, 6 Apr 2020 12:22:16 +0530 Subject: [PATCH 18/30] drivers/include/tmp00x.h : Compile Configs --- drivers/include/tmp00x.h | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/drivers/include/tmp00x.h b/drivers/include/tmp00x.h index bdc336474d..e7a73529f3 100644 --- a/drivers/include/tmp00x.h +++ b/drivers/include/tmp00x.h @@ -93,7 +93,15 @@ extern "C" #define ADDR (dev->p.addr) /**< ADDR */ /** - * @brief TMP00X Default Address + * @defgroup drivers_tmp00x_config TMP006/TMP007 Infrared Thermopile Sensor driver compile configuration + * @ingroup config_drivers_sensors + * @{ + */ +/** + * @brief Default Address + * + * I2C Address depends on the state of ADR0 and ADR1 Pins + * For more information, please refer to section 7.3.6.2 of TMP007 datasheet (SBOS685B). */ #ifndef TMP00X_I2C_ADDRESS #define TMP00X_I2C_ADDRESS (0x40) @@ -127,6 +135,7 @@ extern "C" #ifndef TMP00X_USE_RAW_VALUES #define TMP00X_USE_RAW_VALUES (0) #endif +/** @} */ /** * @name Conversion rate and AVG sampling configuration From bc65ffdcded689c34663d363d1a17d1412315d3f Mon Sep 17 00:00:00 2001 From: Akshai M Date: Mon, 6 Apr 2020 12:22:23 +0530 Subject: [PATCH 19/30] drivers/include/ethos.h : Compile Configs --- drivers/include/ethos.h | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/drivers/include/ethos.h b/drivers/include/ethos.h index fdc4408d39..efc3489c9a 100644 --- a/drivers/include/ethos.h +++ b/drivers/include/ethos.h @@ -28,20 +28,34 @@ #include "net/netdev.h" #include "tsrb.h" #include "mutex.h" +#include "kernel_defines.h" #ifdef __cplusplus extern "C" { #endif /* if using ethos + stdio, use STDIO_UART values unless overridden */ -#ifdef MODULE_STDIO_ETHOS +#if IS_USED(MODULE_STDIO_ETHOS) || defined(DOXYGEN) #include "stdio_uart.h" +/** + * @defgroup drivers_ethos_config Ethernet-over-serial driver driver compile configuration + * @ingroup config_drivers_netdev + * @{ + */ +/** + * @brief Set the default UART Interface. + */ #ifndef ETHOS_UART #define ETHOS_UART STDIO_UART_DEV #endif + +/** + * @brief Set the default baudrate. + */ #ifndef ETHOS_BAUDRATE #define ETHOS_BAUDRATE STDIO_UART_BAUDRATE #endif +/** @} */ #endif /** From 80c6374cc4017a6c1de1f98c131b567d7eb6c59b Mon Sep 17 00:00:00 2001 From: Akshai M Date: Mon, 6 Apr 2020 16:01:18 +0530 Subject: [PATCH 20/30] drivers/include/mrf24j40.h : Modify group Add to config_netdev group to Doxygen --- drivers/include/mrf24j40.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/drivers/include/mrf24j40.h b/drivers/include/mrf24j40.h index c3244422fe..22ef45d69b 100644 --- a/drivers/include/mrf24j40.h +++ b/drivers/include/mrf24j40.h @@ -118,7 +118,7 @@ extern "C" { /** * @defgroup drivers_mrf24j40_config mrf24j40 driver compile configuration * @ingroup drivers_mrf24j40 - * @ingroup config + * @ingroup config_drivers_netdev * @{ */ From 497a967a23e75366bdd837c0b1507dac10df7073 Mon Sep 17 00:00:00 2001 From: Akshai M Date: Mon, 6 Apr 2020 16:02:19 +0530 Subject: [PATCH 21/30] drivers/include/sx127x.h : Add group Add to config_netdev group to Doxygen --- drivers/include/sx127x.h | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/drivers/include/sx127x.h b/drivers/include/sx127x.h index 76408c4f0a..717f448fdb 100644 --- a/drivers/include/sx127x.h +++ b/drivers/include/sx127x.h @@ -96,12 +96,11 @@ extern "C" { /** * @defgroup drivers_sx127x_config Semtech SX1272 and SX1276 driver compile configuration - * @ingroup config + * @ingroup config_drivers_netdev * @{ */ - /** - * @brief GPIO mode of DIOx Pins. + * @brief GPIO mode of DIOx Pins. */ #ifndef SX127X_DIO_PULL_MODE #define SX127X_DIO_PULL_MODE (GPIO_IN_PD) From 358d7eb616997795adceff278df547a426c3cd80 Mon Sep 17 00:00:00 2001 From: Akshai M Date: Thu, 9 Apr 2020 19:10:11 +0530 Subject: [PATCH 22/30] drivers/adcxx1c_params.h : Add Group Add CT Params to sensors group in Config for Doxygen --- drivers/adcxx1c/include/adcxx1c_params.h | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/drivers/adcxx1c/include/adcxx1c_params.h b/drivers/adcxx1c/include/adcxx1c_params.h index ce5937c507..b4680ff5f0 100644 --- a/drivers/adcxx1c/include/adcxx1c_params.h +++ b/drivers/adcxx1c/include/adcxx1c_params.h @@ -29,9 +29,9 @@ extern "C" { #endif /** - * @defgroup drivers_adcxx1c_conf ADCXX1C driver compile configurations + * @defgroup drivers_adcxx1c_config ADCXX1C driver compile configurations * @ingroup drivers_adcxx1c - * @ingroup config + * @ingroup config_drivers_sensors * @{ */ From 007cd5bb26d96255e27369bbce07bb846f1eba20 Mon Sep 17 00:00:00 2001 From: Akshai M Date: Thu, 9 Apr 2020 19:11:31 +0530 Subject: [PATCH 23/30] drivers/include/at.h : Add Group Add CT Params to misc group in Config for Doxygen --- drivers/include/at.h | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/drivers/include/at.h b/drivers/include/at.h index 20c0dc34e2..4493a794e8 100644 --- a/drivers/include/at.h +++ b/drivers/include/at.h @@ -47,10 +47,9 @@ extern "C" { /** * @defgroup drivers_at_config AT driver compile configuration - * @ingroup config + * @ingroup config_drivers_misc * @{ */ - /** * @brief End of line character to send after the AT command. */ From 11c2803bcf02c9ded3c963216f567bd8992a186f Mon Sep 17 00:00:00 2001 From: Akshai M Date: Thu, 9 Apr 2020 19:14:14 +0530 Subject: [PATCH 24/30] drivers/include/at86rf215.h : Add Group Add CT Params to netdev group in Config for Doxygen --- drivers/include/at86rf215.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/drivers/include/at86rf215.h b/drivers/include/at86rf215.h index 23632424da..22bcf24a94 100644 --- a/drivers/include/at86rf215.h +++ b/drivers/include/at86rf215.h @@ -63,7 +63,7 @@ typedef void (*at86rf215_batmon_cb_t)(void *arg); /** * @defgroup drivers_at86rf215_config AT86RF215 driver compile configuration - * @ingroup config + * @ingroup config_drivers_netdev * @{ */ /** From 642fe168072b5d022184159a57d927fe89500984 Mon Sep 17 00:00:00 2001 From: Akshai M Date: Thu, 9 Apr 2020 19:21:56 +0530 Subject: [PATCH 25/30] cpu/nrf52/include/nrf802154.h : Add Group Add CT Params to netdev group in Config for Doxygen --- cpu/nrf52/include/nrf802154.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/cpu/nrf52/include/nrf802154.h b/cpu/nrf52/include/nrf802154.h index 89181e00ea..077c6027db 100644 --- a/cpu/nrf52/include/nrf802154.h +++ b/cpu/nrf52/include/nrf802154.h @@ -45,7 +45,7 @@ extern "C" { /** * @defgroup drivers_nrf52_802154_conf nrf802154 driver compile configuration * @ingroup drivers_nrf52_802154 - * @ingroup config + * @ingroup config_drivers_netdev * @{ */ From eb3456ee1dd0ad049493014343582d952c77c988 Mon Sep 17 00:00:00 2001 From: Akshai M Date: Fri, 10 Apr 2020 15:44:15 +0530 Subject: [PATCH 26/30] drivers/include/dose.h : Add group Add compile parameters to config_drivers_netdev group to Doxygen --- drivers/include/dose.h | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/drivers/include/dose.h b/drivers/include/dose.h index aefd5abae4..21c724f5bc 100644 --- a/drivers/include/dose.h +++ b/drivers/include/dose.h @@ -126,10 +126,9 @@ typedef enum { /** * @defgroup drivers_dose_config Differentially Operated Serial Ethernet (DOSE) driver compile configuration - * @ingroup config + * @ingroup config_drivers_netdev * @{ */ - /** * @brief Timeout that brings the driver back into idle state. * From 32c4fe3cd4222aeb7d52d281ef51ab12281a9937 Mon Sep 17 00:00:00 2001 From: Akshai M Date: Fri, 10 Apr 2020 15:47:43 +0530 Subject: [PATCH 27/30] drivers/include/ds1307.h : Add group Add compile parameters to config_drivers_sensors group to Doxygen --- drivers/include/ds1307.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/drivers/include/ds1307.h b/drivers/include/ds1307.h index 70e19fb557..f3b578358f 100644 --- a/drivers/include/ds1307.h +++ b/drivers/include/ds1307.h @@ -40,7 +40,7 @@ extern "C" { /** * @defgroup drivers_ds1307_config DS1307 RTC driver compile configuration - * @ingroup config + * @ingroup config_drivers_sensors * @{ */ From b36b3b98191f38f97453be3872dc262221db5d73 Mon Sep 17 00:00:00 2001 From: Akshai M Date: Fri, 10 Apr 2020 15:50:41 +0530 Subject: [PATCH 28/30] drivers/include/fxos8700.h : Add group Add compile parameters to config_drivers_sensors group to Doxygen --- drivers/include/fxos8700.h | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/drivers/include/fxos8700.h b/drivers/include/fxos8700.h index 922553c36f..55c4922190 100644 --- a/drivers/include/fxos8700.h +++ b/drivers/include/fxos8700.h @@ -38,10 +38,9 @@ extern "C" { /** * @defgroup drivers_fxos8700_config FXOS8700 accelerometer/magnetometer driver compile configuration - * @ingroup config + * @ingroup config_drivers_sensors * @{ */ - /** * @brief Default raw value mode for accelerator * @@ -52,6 +51,7 @@ extern "C" { #define FXOS8700_USE_ACC_RAW_VALUES (0) #endif /** @} */ + /** * @brief FXOS8700 specific return values */ From b9f71610d7459d28d4faa01f0eca81bc2f03da93 Mon Sep 17 00:00:00 2001 From: Akshai M Date: Mon, 13 Apr 2020 12:07:46 +0530 Subject: [PATCH 29/30] drivers/include/ads101x.h : Add Group Add CT Params to sensors group in Config for Doxygen --- drivers/include/ads101x.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/drivers/include/ads101x.h b/drivers/include/ads101x.h index 292da78991..76c38f043c 100644 --- a/drivers/include/ads101x.h +++ b/drivers/include/ads101x.h @@ -40,7 +40,7 @@ extern "C" { /** * @defgroup drivers_ads101x_config ADS101 driver compile configuration - * @ingroup config + * @ingroup config_drivers_sensors * @{ */ From aa7e84a6d78e38254485569609fd4ebc60f6c603 Mon Sep 17 00:00:00 2001 From: Akshai M Date: Tue, 14 Apr 2020 14:13:52 +0530 Subject: [PATCH 30/30] drivers/mma8x5x.h : Compile Configs Add CT Params to sensors group in Config for Doxygen --- drivers/include/mma8x5x.h | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/drivers/include/mma8x5x.h b/drivers/include/mma8x5x.h index a7b56be4ac..4bbd38d446 100644 --- a/drivers/include/mma8x5x.h +++ b/drivers/include/mma8x5x.h @@ -40,9 +40,21 @@ extern "C" { #endif +/** + * @defgroup drivers_mma8x5x_config MMA8x5x Accelerometer driver compile configuration + * @ingroup config_drivers_sensors + * @{ + */ +/** + * @brief Accelerometer Default Address + * + * The address value depends on the state of SA0 Address Pin in the case of MMA845x series. + * For more details refer Table 1 in datasheet (MMA8451Q/MMA8452Q/MMA8453Q) + */ #ifndef MMA8X5X_I2C_ADDRESS -#define MMA8X5X_I2C_ADDRESS 0x1D /**< Accelerometer Default Address */ +#define MMA8X5X_I2C_ADDRESS 0x1D #endif +/** @} */ /** * @brief Devices supported by this driver