zephyrCommon: add gpio-ports property

To determine which gpio ports to use with the Arduino-API,
introduce `gpio-ports` to the overlay.

Signed-off-by: TOKITA Hiroshi <tokita.hiroshi@gmail.com>

Author: soburi

cores/arduino/zephyrCommon.cpp

@@ -12,6 +12,69 @@ static const struct gpio_dt_spec arduino_pins[] = {DT_FOREACH_PROP_ELEM_SEP(
 
 namespace {
 
+#define DEVICE_GPIO(n, p, i) DEVICE_DT_GET(DT_PROP_BY_IDX(n, p, i))
+constexpr const struct device *gpios[] = {
+  DT_FOREACH_PROP_ELEM_SEP(DT_PATH(zephyr_user), gpio_ports, DEVICE_GPIO, (,))
+};
+
+#define PROP_NGPIOS(n, p, i) DT_PROP(DT_PROP_BY_IDX(n, p, i), ngpios)
+constexpr uint32_t pins[] = {
+  DT_FOREACH_PROP_ELEM_SEP(DT_PATH(zephyr_user), gpio_ports, PROP_NGPIOS, (,))
+};
+
+constexpr inline const struct device *local_gpio_port_r(pin_size_t pin,
+                                                        const struct device *const *ctrl,
+                                                        const uint32_t accum,
+							const uint32_t *end, size_t n) {
+  return (n == 0)                 ? nullptr
+         : (pin < accum + end[0]) ? ctrl[0]
+                                  : local_gpio_port_r(pin, ctrl + 1, accum + end[0], end + 1, n - 1);
+}
+
+constexpr inline size_t port_index_r(const struct device *target,
+                                     const struct device *const *table, pin_size_t idx, size_t n) {
+  return (n == 0)               ? size_t(-1)
+         : (target == table[0]) ? idx
+                                : port_index_r(target, table + 1, idx + 1, n - 1);
+}
+
+constexpr inline const struct device *local_gpio_port(pin_size_t gpin) {
+  return local_gpio_port_r(gpin, gpios, 0, pins, ARRAY_SIZE(gpios));
+}
+
+constexpr inline pin_size_t port_idx(pin_size_t gpin) {
+  return port_index_r(local_gpio_port(gpin), gpios, 0, ARRAY_SIZE(gpios));
+}
+
+constexpr inline pin_size_t end_accum_r(const uint32_t accum, const uint32_t *end, size_t n) {
+  return (n == 0) ? accum : end_accum_r(accum + end[0], end + 1, n - 1);
+}
+
+constexpr inline pin_size_t end_accum(size_t n) {
+  return end_accum_r(0, pins, n);
+}
+
+constexpr inline pin_size_t local_gpio_pin(pin_size_t gpin) {
+  return port_idx(gpin) == pin_size_t(-1) ? pin_size_t(-1) : gpin - end_accum(port_idx(gpin));
+}
+
+constexpr inline pin_size_t global_gpio_pin_(size_t port_idx, pin_size_t lpin) {
+  return port_idx == size_t(-1) ? size_t(-1) : end_accum(port_idx) + lpin;
+}
+
+constexpr inline pin_size_t global_gpio_pin(const struct device *lport, pin_size_t lpin) {
+  return global_gpio_pin_(port_index_r(lport, gpios, 0, ARRAY_SIZE(gpios)), lpin);
+}
+
+inline int global_gpio_pin_get(pin_size_t pinNumber) {
+  return gpio_pin_get(local_gpio_port(pinNumber), local_gpio_pin(pinNumber));
+}
+
+inline int global_gpio_pin_configure(pin_size_t pinNumber, int flags) {
+  return gpio_pin_configure(local_gpio_port(pinNumber), local_gpio_pin(pinNumber), flags);
+}
+
+
 /*
  * Calculate GPIO ports/pins number statically from devicetree configuration
  */
@@ -67,6 +130,8 @@ const int port_num =
 #define GPIO_NGPIOS(n, p, i) DT_PROP(DT_GPIO_CTLR_BY_IDX(n, p, i), ngpios)
 const int max_ngpios = max_in_list(
   0, DT_FOREACH_PROP_ELEM_SEP(DT_PATH(zephyr_user), digital_pin_gpios, GPIO_NGPIOS, (, )));
+const int sum_ngpios = sum_of_list(
+  0, DT_FOREACH_PROP_ELEM_SEP(DT_PATH(zephyr_user), digital_pin_gpios, GPIO_NGPIOS, (, )));
 
 /*
  * GPIO callback implementation

documentation/variants.md

@@ -90,6 +90,20 @@ uses [the Arduino header definitions](https://github.com/zephyrproject-rtos/zeph
 };
 ```
 
+### Configure GPIO devices
+
+The `gpios` node lists the GPIO ports to use.
+Pin numbers will be assigned sequentially starting from 0 to the GPIOs of the ports specified here.
+For example, if gpio0 and gpio1, each with 16 outputs, are specified, pin 1 of gpio1 will be assigned 17.
+
+```
+/ {
+       zephyr,user {
+               gpios = <&gpio0>, <&gpio1>;
+       };
+};
+```
+
 ### Configure Serial devices
 
 The `serials` node defines the Serial devices to use.

variants/arduino_mkrzero/arduino_mkrzero.overlay

@@ -54,6 +54,7 @@
 				<&adc 6>,
 				<&adc 7>;
 
+		gpio-ports = <&porta>, <&portb>;
 		serials = <&sercom5>;
 		i2cs = <&sercom0>;
 	};

variants/arduino_nano_33_ble/arduino_nano_33_ble.overlay

@@ -59,6 +59,7 @@
 				<&adc 4>,
 				<&adc 1>;
 
+		gpio-ports = <&gpio0>, <&gpio1>;
 		serials = <&uart0>;
 		i2cs = <&arduino_nano_i2c>;
 	};

variants/arduino_nano_33_ble_sense/arduino_nano_33_ble_sense.overlay

@@ -59,6 +59,7 @@
 				<&adc 4>,
 				<&adc 1>;
 
+		gpio-ports = <&gpio0>, <&gpio1>;
 		serials = <&uart0>;
 		i2cs = <&arduino_nano_i2c>;
 	};

variants/arduino_nano_33_iot/arduino_nano_33_iot.overlay

@@ -60,6 +60,7 @@
 				<&adc 6>,
 				<&adc 7>;
 
+		gpio-ports = <&porta>, <&portb>;
 		serials = <&sercom5>;
 		i2cs = <&arduino_nano_i2c>;
 	};

variants/beagleconnect_freedom/beagleconnect_freedom.overlay

@@ -58,6 +58,8 @@
  			    <&gpio0 28 GPIO_ACTIVE_HIGH>; /* D3  - MB1 CS - A5 */
 
  	builtin-led-gpios = <&gpio0 18 GPIO_ACTIVE_HIGH>;	/*  2.4GHz TX/RX  */
+
+	gpio-ports = <&gpio0>;
  	serials = <&uart0 &uart1>;
  	i2cs = <&i2c0>;
 	spis = <&spi0>;

variants/cc3220sf_launchxl/cc3220sf_launchxl.overlay

@@ -30,6 +30,8 @@
 				<&boosterpack_header 31 0>,	/* GPIO_24 */
 				<&boosterpack_header 32 0>;	/* GPIO_23 */
 		builtin-led-gpios = <&boosterpack_header 10 0>;	/*  GREEN_LED  */
+
+		gpio-ports = <&gpioa0>, <&gpioa1>, <&gpioa2>, <&gpioa3>;
 		serials = <&boosterpack_serial>;
 		i2cs = <&boosterpack_i2c>;
 	};

variants/nrf52840dk_nrf52840/nrf52840dk_nrf52840.overlay

@@ -52,6 +52,8 @@
 				<&arduino_adc 3>,
 				<&arduino_adc 4>,
 				<&arduino_adc 5>;
+
+		gpio-ports = <&gpio0>, <&gpio1>;
 	};
 };
 

variants/nrf9160dk_nrf9160/nrf9160dk_nrf9160.overlay

@@ -57,6 +57,8 @@
 			<&arduino_adc 3>,
 			<&arduino_adc 4>,
 			<&arduino_adc 5>;
+
+		gpio-ports = <&gpio0>;
 	};
 };