zephyrCommon: Implement analogRead()/analogReference()

The 'io-channels' node under the 'zephyr,user' defines
available ADC channels.

The 'io-channel-pins' defines the mapping of ADC channels
to pin numbers.  API looks up the 'io-channel-pins' when
querying the ADC channel by digital pin number.
So it should be in the same order as 'io-channels' node.

For original Arduino API compatibility, adc resolution
should configure as 10-bit.

ADC that is on MCU supported by Zephyr exists
only 16-bit resolution currently.
So it supports resolutions up to 16-bit.

Signed-off-by: TOKITA Hiroshi <[email protected]>

Author: soburi

Diff for: cores/arduino/Arduino.h

@@ -8,6 +8,7 @@
 
 #include <zephyr/drivers/gpio.h>
 #include <zephyr/drivers/pwm.h>
+#include <zephyr/drivers/adc.h>
 #include <zephyr/kernel.h>
 
 #include <variants.h>

Diff for: cores/arduino/zephyrCommon.cpp

@@ -6,13 +6,13 @@
 
 #include <Arduino.h>
 
-#define PWM_DT_SPEC(n,p,i) PWM_DT_SPEC_GET_BY_IDX(n, i),
-#define PWM_PINS(n,p,i) DT_PROP_BY_IDX(n, p, i),
-
 namespace {
 
 #ifdef CONFIG_PWM
 
+#define PWM_DT_SPEC(n,p,i) PWM_DT_SPEC_GET_BY_IDX(n, i),
+#define PWM_PINS(n,p,i) DT_PROP_BY_IDX(n, p, i),
+
 const struct pwm_dt_spec arduino_pwm[] =
 	{ DT_FOREACH_PROP_ELEM(DT_PATH(zephyr_user), pwms, PWM_DT_SPEC) };
 
@@ -31,6 +31,33 @@ size_t pwm_pin_index(pin_size_t pinNumber) {
 
 #endif //CONFIG_PWM
 
+#ifdef CONFIG_ADC
+
+#define ADC_DT_SPEC(n,p,i) ADC_DT_SPEC_GET_BY_IDX(n, i),
+#define ADC_PINS(n,p,i) DT_PROP_BY_IDX(n, p, i),
+#define ADC_CH_CFG(n,p,i) arduino_adc[i].channel_cfg,
+
+const struct adc_dt_spec arduino_adc[] =
+  { DT_FOREACH_PROP_ELEM(DT_PATH(zephyr_user), io_channels, ADC_DT_SPEC) };
+
+/* io-channel-pins node provides a mapping digital pin numbers to adc channels */
+const pin_size_t arduino_analog_pins[] =
+  { DT_FOREACH_PROP_ELEM(DT_PATH(zephyr_user), io_channel_pins, ADC_PINS) };
+
+struct adc_channel_cfg channel_cfg[ARRAY_SIZE(arduino_analog_pins)] =
+  { DT_FOREACH_PROP_ELEM(DT_PATH(zephyr_user), io_channels, ADC_CH_CFG) };
+
+size_t analog_pin_index(pin_size_t pinNumber) {
+  for(size_t i=0; i<ARRAY_SIZE(arduino_analog_pins); i++) {
+    if (arduino_analog_pins[i] == pinNumber) {
+      return i;
+    }
+  }
+  return (size_t)-1;
+}
+
+#endif //CONFIG_ADC
+
 }
 
 void yield(void) {
@@ -101,3 +128,56 @@ void analogWrite(pin_size_t pinNumber, int value)
 }
 
 #endif
+
+#ifdef CONFIG_ADC
+
+void analogReference(uint8_t mode)
+{
+  /*
+   * The Arduino API not clearly defined what means of
+   * the mode argument of analogReference().
+   * Treat the value as equivalent to zephyr's adc_reference.
+   */
+  size_t idx;
+  for (size_t i=0; i<ARRAY_SIZE(channel_cfg); i++) {
+    channel_cfg[i].reference = static_cast<adc_reference>(mode);
+  }
+}
+
+int analogRead(pin_size_t pinNumber)
+{
+  int err;
+  int16_t buf;
+  struct adc_sequence seq = { .buffer = &buf, .buffer_size = sizeof(buf) };
+  size_t idx = analog_pin_index(pinNumber);
+
+  if (idx >= ARRAY_SIZE(arduino_adc) ) {
+    return -EINVAL;
+  }
+
+  /*
+   * ADC that is on MCU supported by Zephyr exists
+   * only 16bit resolution, currently.
+   */
+  if (arduino_adc[idx].resolution > 16) {
+    return -ENOTSUP;
+  }
+
+  err = adc_channel_setup(arduino_adc[idx].dev, &arduino_adc[idx].channel_cfg);
+  if (err < 0) {
+    return err;
+  }
+
+  seq.channels = BIT(arduino_adc[idx].channel_id);
+  seq.resolution = arduino_adc[idx].resolution;
+  seq.oversampling = arduino_adc[idx].oversampling;
+
+  err = adc_read(arduino_adc[idx].dev, &seq);
+  if (err < 0) {
+    return err;
+  }
+
+  return buf;
+}
+
+#endif

Diff for: variants/arduino_mkrzero/arduino_mkrzero.overlay

@@ -3,6 +3,9 @@
  *
  * SPDX-License-Identifier: Apache-2.0
  */
+
+#include <zephyr/dt-bindings/adc/adc.h>
+
 / {
 	zephyr,user {
 		d0_gpios = <&arduino_mkr_header 0 0>;
@@ -27,27 +30,121 @@
 		d19_gpios = <&arduino_mkr_header 19 0>; /* D19 / A5 / I2C-SCL */
 		d20_gpios = <&arduino_mkr_header 20 0>;
 		d21_gpios = <&arduino_mkr_header 21 0>;
+
 		pwms =	<&tcc0 2 255>,
 			<&tcc0 3 255>;
 		pwm-pins = <2 3>;
+
+		io-channels =	<&adc 0>,
+				<&adc 10>,
+				<&adc 11>,
+				<&adc 4>,
+				<&adc 5>,
+				<&adc 6>,
+				<&adc 7>;
+		io-channel-pins = <15 16 17 18 19 20 21>;
 	};
 };
 
 &pinctrl {
-        pwm_default: pwm_default {
-                group1 {
-                        pinmux = <PA10F_TCC0_WO2>,
-                                 <PA11F_TCC0_WO3>;
-                };
-        };
+	pwm_default: pwm_default {
+		group1 {
+			pinmux = <PA10F_TCC0_WO2>,
+				 <PA11F_TCC0_WO3>;
+		};
+	};
+
+	adc_default: adc_default {
+		group1 {
+			pinmux = <PA2B_ADC_AIN0>,
+				 <PB2B_ADC_AIN10>,
+				 <PB3B_ADC_AIN11>,
+				 <PA4B_ADC_AIN4>,
+				 <PA5B_ADC_AIN5>,
+				 <PA6B_ADC_AIN6>,
+				 <PA7B_ADC_AIN7>;
+		};
+	};
 };
 
 &tcc0 {
-        status = "okay";
-        compatible = "atmel,sam0-tcc-pwm";
-        prescaler = <2>;
-        #pwm-cells = <2>;
+	status = "okay";
+	compatible = "atmel,sam0-tcc-pwm";
+	prescaler = <2>;
+	#pwm-cells = <2>;
+
+	pinctrl-0 = <&pwm_default>;
+	pinctrl-names = "default";
+};
+
+&adc {
+	status = "okay";
+	pinctrl-0 = <&adc_default>;
+	pinctrl-names = "default";
+
+	#address-cells = <1>;
+	#size-cells = <0>;
+
+	channel@0 {
+		reg = <0>;
+		zephyr,gain = "ADC_GAIN_1";
+		zephyr,reference = "ADC_REF_INTERNAL";
+		zephyr,acquisition-time = <ADC_ACQ_TIME_DEFAULT>;
+		zephyr,resolution = <10>;
+		zephyr,input-positive = <0>;
+	};
+
+	channel@4 {
+		reg = <4>;
+		zephyr,gain = "ADC_GAIN_1";
+		zephyr,reference = "ADC_REF_INTERNAL";
+		zephyr,acquisition-time = <ADC_ACQ_TIME_DEFAULT>;
+		zephyr,resolution = <10>;
+		zephyr,input-positive = <4>;
+	};
+
+	channel@5 {
+		reg = <5>;
+		zephyr,gain = "ADC_GAIN_1";
+		zephyr,reference = "ADC_REF_INTERNAL";
+		zephyr,acquisition-time = <ADC_ACQ_TIME_DEFAULT>;
+		zephyr,resolution = <10>;
+		zephyr,input-positive = <5>;
+	};
+
+	channel@6 {
+		reg = <6>;
+		zephyr,gain = "ADC_GAIN_1";
+		zephyr,reference = "ADC_REF_INTERNAL";
+		zephyr,acquisition-time = <ADC_ACQ_TIME_DEFAULT>;
+		zephyr,resolution = <10>;
+		zephyr,input-positive = <6>;
+	};
+
+	channel@7 {
+		reg = <7>;
+		zephyr,gain = "ADC_GAIN_1";
+		zephyr,reference = "ADC_REF_INTERNAL";
+		zephyr,acquisition-time = <ADC_ACQ_TIME_DEFAULT>;
+		zephyr,resolution = <10>;
+		zephyr,input-positive = <7>;
+	};
 
-        pinctrl-0 = <&pwm_default>;
-        pinctrl-names = "default";
+	channel@10 {
+		reg = <10>;
+		zephyr,gain = "ADC_GAIN_1";
+		zephyr,reference = "ADC_REF_INTERNAL";
+		zephyr,acquisition-time = <ADC_ACQ_TIME_DEFAULT>;
+		zephyr,resolution = <10>;
+		zephyr,input-positive = <10>;
+	};
+
+	channel@11 {
+		reg = <11>;
+		zephyr,gain = "ADC_GAIN_1";
+		zephyr,reference = "ADC_REF_INTERNAL";
+		zephyr,acquisition-time = <ADC_ACQ_TIME_DEFAULT>;
+		zephyr,resolution = <10>;
+		zephyr,input-positive = <11>;
+	};
 };

Diff for: variants/arduino_nano_33_ble/arduino_nano_33_ble.overlay

@@ -22,6 +22,7 @@
 		d19_gpios = <&arduino_nano_header 19 0>; /* D19 / A5 / I2C-SCL */
 		d20_gpios = <&arduino_nano_header 20 0>;
 		d21_gpios = <&arduino_nano_header 21 0>;
+
 		pwms =	<&pwm1 1 255 PWM_POLARITY_NORMAL>,
 			<&pwm1 2 255 PWM_POLARITY_NORMAL>,
 			<&pwm1 3 255 PWM_POLARITY_NORMAL>,
@@ -30,6 +31,93 @@
 			<&pwm2 2 255 PWM_POLARITY_NORMAL>,
 			<&pwm2 3 255 PWM_POLARITY_NORMAL>;
 		pwm-pins = <3 5 6 13 9 10 11>;
+
+		io-channels =	<&adc 2>,
+				<&adc 3>,
+				<&adc 6>,
+				<&adc 5>,
+				<&adc 7>,
+				<&adc 0>,
+				<&adc 4>,
+				<&adc 1>;
+		io-channel-pins = <14 15 16 17 18 19 20 21>;
+	};
+};
+
+&adc {
+	#address-cells = <1>;
+	#size-cells = <0>;
+
+	channel@0 {
+		reg = <0>;
+		zephyr,gain = "ADC_GAIN_1_6";
+		zephyr,reference = "ADC_REF_INTERNAL";
+		zephyr,acquisition-time = <ADC_ACQ_TIME_DEFAULT>;
+		zephyr,input-positive = <NRF_SAADC_AIN0>; /* P0.02 */
+		zephyr,resolution = <10>;
+	};
+
+	channel@1 {
+		reg = <1>;
+		zephyr,gain = "ADC_GAIN_1_6";
+		zephyr,reference = "ADC_REF_INTERNAL";
+		zephyr,acquisition-time = <ADC_ACQ_TIME_DEFAULT>;
+		zephyr,input-positive = <NRF_SAADC_AIN1>; /* P0.03 */
+		zephyr,resolution = <10>;
+	};
+
+	channel@2 {
+		reg = <2>;
+		zephyr,gain = "ADC_GAIN_1_6";
+		zephyr,reference = "ADC_REF_INTERNAL";
+		zephyr,acquisition-time = <ADC_ACQ_TIME_DEFAULT>;
+		zephyr,input-positive = <NRF_SAADC_AIN2>; /* P0.04 */
+		zephyr,resolution = <10>;
+	};
+
+	channel@3 {
+		reg = <3>;
+		zephyr,gain = "ADC_GAIN_1_6";
+		zephyr,reference = "ADC_REF_INTERNAL";
+		zephyr,acquisition-time = <ADC_ACQ_TIME_DEFAULT>;
+		zephyr,input-positive = <NRF_SAADC_AIN3>; /* P0.05 */
+		zephyr,resolution = <10>;
+	};
+
+	channel@4 {
+		reg = <4>;
+		zephyr,gain = "ADC_GAIN_1_6";
+		zephyr,reference = "ADC_REF_INTERNAL";
+		zephyr,acquisition-time = <ADC_ACQ_TIME_DEFAULT>;
+		zephyr,input-positive = <NRF_SAADC_AIN4>; /* P0.28 */
+		zephyr,resolution = <10>;
+	};
+
+	channel@5 {
+		reg = <5>;
+		zephyr,gain = "ADC_GAIN_1_6";
+		zephyr,reference = "ADC_REF_INTERNAL";
+		zephyr,acquisition-time = <ADC_ACQ_TIME_DEFAULT>;
+		zephyr,input-positive = <NRF_SAADC_AIN5>; /* P0.29 */
+		zephyr,resolution = <10>;
+	};
+
+	channel@6 {
+		reg = <6>;
+		zephyr,gain = "ADC_GAIN_1_6";
+		zephyr,reference = "ADC_REF_INTERNAL";
+		zephyr,acquisition-time = <ADC_ACQ_TIME_DEFAULT>;
+		zephyr,input-positive = <NRF_SAADC_AIN6>; /* P0.30 */
+		zephyr,resolution = <10>;
+	};
+
+	channel@7 {
+		reg = <7>;
+		zephyr,gain = "ADC_GAIN_1_6";
+		zephyr,reference = "ADC_REF_INTERNAL";
+		zephyr,acquisition-time = <ADC_ACQ_TIME_DEFAULT>;
+		zephyr,input-positive = <NRF_SAADC_AIN7>; /* P0.31 */
+		zephyr,resolution = <10>;
 	};
 };