Merge pull request #21022 from miri64/saul_bat_voltage/enh/feather-m0-config

feather-m0: add support for saul_bat_voltage

Author: crasbe

boards/adafruit-feather-nrf52840-express/include/bat_voltage_params.h

@@ -26,7 +26,7 @@ extern "C" {
  *
  * @param[in] adc_sample    The raw ADC sample.
  *
- * @return Voltage value for phydat.
+ * @return Voltage value in mV for phydat.
  */
 int16_t saul_bat_voltage_convert(int32_t adc_sample);
 

boards/adafruit-feather-nrf52840-sense/include/bat_voltage_params.h

@@ -26,7 +26,7 @@ extern "C" {
  *
  * @param[in] adc_sample    The raw ADC sample.
  *
- * @return Voltage value for phydat.
+ * @return Voltage value in mV for phydat.
  */
 int16_t saul_bat_voltage_convert(int32_t adc_sample);
 

boards/common/particle-mesh/include/bat_voltage_params.h

@@ -26,7 +26,7 @@ extern "C" {
  *
  * @param[in] adc_sample    The raw ADC sample.
  *
- * @return Voltage value for phydat.
+ * @return Voltage value in mV for phydat.
  */
 int16_t saul_bat_voltage_convert(int32_t adc_sample);
 

boards/feather-m0/Makefile.dep

@@ -1,5 +1,6 @@
 ifneq (,$(filter saul_default,$(USEMODULE)))
   USEMODULE += saul_gpio
+  USEMODULE += saul_bat_voltage
 endif
 
 # setup the samd21 arduino bootloader related dependencies

boards/feather-m0/Makefile.features

@@ -15,5 +15,6 @@ FEATURES_PROVIDED += periph_usbdev
 # Put other features for this board (in alphabetical order)
 FEATURES_PROVIDED += arduino_analog
 FEATURES_PROVIDED += arduino_pins
+FEATURES_PROVIDED += board_bat_voltage
 FEATURES_PROVIDED += feather_shield
 FEATURES_PROVIDED += highlevel_stdio

boards/feather-m0/bat_voltage.c

@@ -0,0 +1,32 @@
+/*
+ * SPDX-FileCopyrightText: 2024 TU Dresden
+ * SPDX-License-Identifier: LGPL-2.1-only
+ */
+
+/**
+ * @ingroup     boards_feather-m0
+ * @ingroup     saul_bat_voltage
+ * @{
+ * @file
+ * @brief       Implementation of battery voltage convert function
+ *
+ * @author      Martine S. Lenders <[email protected]>
+ *
+ * @}
+ */
+
+#ifdef MODULE_SAUL_BAT_VOLTAGE
+#include "saul/bat_voltage.h"
+
+int16_t saul_bat_voltage_convert(int32_t adc_sample)
+{
+    /* See
+     * https://learn.adafruit.com/adafruit-feather-m0-basic-proto/power-management
+     *
+     * we return in millivolt so we set the reference voltage to 3300
+     * instead of 3.3
+     */
+    return (int16_t)((adc_sample * 2L * 3300L) / 1024L);
+}
+
+#endif /* MODULE_SAUL_BAT_VOLTAGE */

boards/feather-m0/include/bat_voltage_params.h

@@ -0,0 +1,51 @@
+/*
+ * SPDX-FileCopyrightText: 2024 TU Dresden
+ * SPDX-License-Identifier: LGPL-2.1-only
+ */
+
+#pragma once
+
+/**
+ * @ingroup     boards_feather-m0
+ * @{
+ *
+ * @file
+ * @brief       Configuration of SAUL mapped battery voltage information
+ *
+ * @author      Martine S. Lenders <[email protected]>
+ */
+
+#include "saul/bat_voltage.h"
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/**
+ * @brief  Conversion function to convert ADC sample to battery voltage
+ *
+ * @param[in] adc_sample    The raw ADC sample.
+ *
+ * @return Voltage value in mV for phydat.
+ */
+int16_t saul_bat_voltage_convert(int32_t adc_sample);
+
+/**
+ * @brief   Battery voltage configuration
+ */
+static const saul_bat_voltage_params_t saul_bat_voltage_params[] =
+{
+    {
+        .name = "BAT",
+        .phydat_scale = -3,
+        .line = ADC_LINE(6),
+        .res = ADC_RES_10BIT,
+        .convert = saul_bat_voltage_convert,
+    },
+};
+
+#ifdef __cplusplus
+}
+#endif
+
+/** @} */

drivers/include/saul/bat_voltage.h

@@ -39,7 +39,7 @@ typedef struct {
      *
      * @param[in] adc_sample    The raw ADC sample.
      *
-     * @return Voltage value for phydat.
+     * @return Voltage value in 10^phydat_scale*V for phydat.
      */
     int16_t (*convert)(int32_t adc_sample);
 } saul_bat_voltage_params_t;