Skip to content

variants: Introduce a digital-pins array to define digital pin #60

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Nov 13, 2022
Merged

variants: Introduce a digital-pins array to define digital pin #60

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
657308f
variants: Introduce a `digital-pin-gpios` array to define digital pin
soburi Sep 24, 2022
1bacdbb
variants: Add a check for duplicated pin in digital-pin-gpios
soburi Oct 10, 2022
42a9e30
documentation: Update about `digital-pin-gpios`
soburi Oct 10, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 13 additions & 12 deletions documentation/variants.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ variants/
### DeviceTree Overlay files for Arduino boards

This module requires that your Arduino header pins be mapped in the DeviceTree
to a `zephyr,user` node using the `d0_gpios` format for each pin. Follow the
to 'digital-pin-gpios' array that child of a `zephyr,user` node. Follow the
examples in the variants directory to create an overlay file and a header file
for your board.

Expand All @@ -68,17 +68,18 @@ uses [the Arduino header definitions](https://github.com/zephyrproject-rtos/zeph
```
/ {
zephyr,user {
d0_gpios = <&arduino_header 6 0>; /* Digital */
d1_gpios = <&arduino_header 7 0>;
...
d13_gpios = <&arduino_header 19 0>;
d14_gpios = <&arduino_header 0 0>; /* Analog */
d15_gpios = <&arduino_header 1 0>;
...
d19_gpios = <&arduino_header 5 0>;
d20_gpios = <&arduino_header 20 0>; /* SDA */
d21_gpios = <&arduino_header 21 0>; /* SCL */
d22_gpios = <&gpio0 13 GPIO_ACTIVE_LOW>; /* LED0 */
digital-pin-gpios = <&arduino_header 6 0>, /* Digital */
<&arduino_header 7 0>;
...
<&arduino_header 19 0>;
<&arduino_header 0 0>; /* Analog */
<&arduino_header 1 0>;
...
<&arduino_header 5 0>;
<&arduino_header 20 0>; /* SDA */
<&arduino_header 21 0>; /* SCL */
<&gpio0 13 GPIO_ACTIVE_LOW>; /* LED0 */
};
};
};
```
Expand Down
44 changes: 22 additions & 22 deletions variants/arduino_mkrzero/arduino_mkrzero.overlay
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,28 +8,28 @@

/ {
zephyr,user {
d0_gpios = <&arduino_mkr_header 0 0>;
d1_gpios = <&arduino_mkr_header 1 0>;
d2_gpios = <&arduino_mkr_header 2 0>;
d3_gpios = <&arduino_mkr_header 3 0>;
d4_gpios = <&arduino_mkr_header 4 0>;
d5_gpios = <&arduino_mkr_header 5 0>;
d6_gpios = <&arduino_mkr_header 6 0>;
d7_gpios = <&arduino_mkr_header 7 0>;
d8_gpios = <&arduino_mkr_header 8 0>;
d9_gpios = <&arduino_mkr_header 9 0>;
d10_gpios = <&arduino_mkr_header 10 0>;
d11_gpios = <&arduino_mkr_header 11 0>;
d12_gpios = <&arduino_mkr_header 12 0>;
d13_gpios = <&arduino_mkr_header 13 0>;
d14_gpios = <&arduino_mkr_header 14 0>; /* D14 / A0 */
d15_gpios = <&arduino_mkr_header 15 0>;
d16_gpios = <&arduino_mkr_header 16 0>;
d17_gpios = <&arduino_mkr_header 17 0>;
d18_gpios = <&arduino_mkr_header 18 0>; /* D18 / A4 / I2C-SDA */
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>;
digital-pin-gpios = <&arduino_mkr_header 0 0>,
<&arduino_mkr_header 1 0>,
<&arduino_mkr_header 2 0>,
<&arduino_mkr_header 3 0>,
<&arduino_mkr_header 4 0>,
<&arduino_mkr_header 5 0>,
<&arduino_mkr_header 6 0>,
<&arduino_mkr_header 7 0>,
<&arduino_mkr_header 8 0>,
<&arduino_mkr_header 9 0>,
<&arduino_mkr_header 10 0>,
<&arduino_mkr_header 11 0>,
<&arduino_mkr_header 12 0>,
<&arduino_mkr_header 13 0>,
<&arduino_mkr_header 14 0>, /* D14 / A0 */
<&arduino_mkr_header 15 0>,
<&arduino_mkr_header 16 0>,
<&arduino_mkr_header 17 0>,
<&arduino_mkr_header 18 0>, /* D18 / A4 / I2C-SDA */
<&arduino_mkr_header 19 0>, /* D19 / A5 / I2C-SCL */
<&arduino_mkr_header 20 0>,
<&arduino_mkr_header 21 0>;

pwms = <&tcc0 2 255>,
<&tcc0 3 255>;
Expand Down
44 changes: 22 additions & 22 deletions variants/arduino_nano_33_ble/arduino_nano_33_ble.overlay
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,27 +1,27 @@
/ {
zephyr,user {
d0_gpios = <&arduino_nano_header 0 0>;
d1_gpios = <&arduino_nano_header 1 0>;
d2_gpios = <&arduino_nano_header 2 0>;
d3_gpios = <&arduino_nano_header 3 0>;
d4_gpios = <&arduino_nano_header 4 0>;
d5_gpios = <&arduino_nano_header 5 0>;
d6_gpios = <&arduino_nano_header 6 0>;
d7_gpios = <&arduino_nano_header 7 0>;
d8_gpios = <&arduino_nano_header 8 0>;
d9_gpios = <&arduino_nano_header 9 0>;
d10_gpios = <&arduino_nano_header 10 0>;
d11_gpios = <&arduino_nano_header 11 0>;
d12_gpios = <&arduino_nano_header 12 0>;
d13_gpios = <&arduino_nano_header 13 0>;
d14_gpios = <&arduino_nano_header 14 0>; /* D14 / A0 */
d15_gpios = <&arduino_nano_header 15 0>;
d16_gpios = <&arduino_nano_header 16 0>;
d17_gpios = <&arduino_nano_header 17 0>;
d18_gpios = <&arduino_nano_header 18 0>; /* D18 / A4 / I2C-SDA */
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>;
digital-pin-gpios = <&arduino_nano_header 0 0>,
<&arduino_nano_header 1 0>,
<&arduino_nano_header 2 0>,
<&arduino_nano_header 3 0>,
<&arduino_nano_header 4 0>,
<&arduino_nano_header 5 0>,
<&arduino_nano_header 6 0>,
<&arduino_nano_header 7 0>,
<&arduino_nano_header 8 0>,
<&arduino_nano_header 9 0>,
<&arduino_nano_header 10 0>,
<&arduino_nano_header 11 0>,
<&arduino_nano_header 12 0>,
<&arduino_nano_header 13 0>,
<&arduino_nano_header 14 0>, /* D14 / A0 */
<&arduino_nano_header 15 0>,
<&arduino_nano_header 16 0>,
<&arduino_nano_header 17 0>,
<&arduino_nano_header 18 0>, /* D18 / A4 / I2C-SDA */
<&arduino_nano_header 19 0>, /* D19 / A5 / I2C-SCL */
<&arduino_nano_header 20 0>,
<&arduino_nano_header 21 0>;

pwms = <&pwm1 1 255 PWM_POLARITY_NORMAL>,
<&pwm1 2 255 PWM_POLARITY_NORMAL>,
Expand Down
44 changes: 22 additions & 22 deletions variants/arduino_nano_33_ble_sense/arduino_nano_33_ble_sense.overlay
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,27 +1,27 @@
/ {
zephyr,user {
d0_gpios = <&arduino_nano_header 0 0>;
d1_gpios = <&arduino_nano_header 1 0>;
d2_gpios = <&arduino_nano_header 2 0>;
d3_gpios = <&arduino_nano_header 3 0>;
d4_gpios = <&arduino_nano_header 4 0>;
d5_gpios = <&arduino_nano_header 5 0>;
d6_gpios = <&arduino_nano_header 6 0>;
d7_gpios = <&arduino_nano_header 7 0>;
d8_gpios = <&arduino_nano_header 8 0>;
d9_gpios = <&arduino_nano_header 9 0>;
d10_gpios = <&arduino_nano_header 10 0>;
d11_gpios = <&arduino_nano_header 11 0>;
d12_gpios = <&arduino_nano_header 12 0>;
d13_gpios = <&arduino_nano_header 13 0>;
d14_gpios = <&arduino_nano_header 14 0>; /* D14 / A0 */
d15_gpios = <&arduino_nano_header 15 0>;
d16_gpios = <&arduino_nano_header 16 0>;
d17_gpios = <&arduino_nano_header 17 0>;
d18_gpios = <&arduino_nano_header 18 0>; /* D18 / A4 / I2C-SDA */
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>;
digital-pin-gpios = <&arduino_nano_header 0 0>,
<&arduino_nano_header 1 0>,
<&arduino_nano_header 2 0>,
<&arduino_nano_header 3 0>,
<&arduino_nano_header 4 0>,
<&arduino_nano_header 5 0>,
<&arduino_nano_header 6 0>,
<&arduino_nano_header 7 0>,
<&arduino_nano_header 8 0>,
<&arduino_nano_header 9 0>,
<&arduino_nano_header 10 0>,
<&arduino_nano_header 11 0>,
<&arduino_nano_header 12 0>,
<&arduino_nano_header 13 0>,
<&arduino_nano_header 14 0>, /* D14 / A0 */
<&arduino_nano_header 15 0>,
<&arduino_nano_header 16 0>,
<&arduino_nano_header 17 0>,
<&arduino_nano_header 18 0>, /* D18 / A4 / I2C-SDA */
<&arduino_nano_header 19 0>, /* D19 / A5 / I2C-SCL */
<&arduino_nano_header 20 0>,
<&arduino_nano_header 21 0>;

pwms = <&pwm1 1 255 PWM_POLARITY_NORMAL>,
<&pwm1 2 255 PWM_POLARITY_NORMAL>,
Expand Down
44 changes: 22 additions & 22 deletions variants/arduino_nano_33_iot/arduino_nano_33_iot.overlay
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,28 +2,28 @@

/ {
zephyr,user {
d0_gpios = <&arduino_nano_header 0 0>;
d1_gpios = <&arduino_nano_header 1 0>;
d2_gpios = <&arduino_nano_header 2 0>;
d3_gpios = <&arduino_nano_header 3 0>;
d4_gpios = <&arduino_nano_header 4 0>;
d5_gpios = <&arduino_nano_header 5 0>;
d6_gpios = <&arduino_nano_header 6 0>;
d7_gpios = <&arduino_nano_header 7 0>;
d8_gpios = <&arduino_nano_header 8 0>;
d9_gpios = <&arduino_nano_header 9 0>;
d10_gpios = <&arduino_nano_header 10 0>;
d11_gpios = <&arduino_nano_header 11 0>;
d12_gpios = <&arduino_nano_header 12 0>;
d13_gpios = <&arduino_nano_header 13 0>;
d14_gpios = <&arduino_nano_header 14 0>; /* D14 / A0 */
d15_gpios = <&arduino_nano_header 15 0>;
d16_gpios = <&arduino_nano_header 16 0>;
d17_gpios = <&arduino_nano_header 17 0>;
d18_gpios = <&arduino_nano_header 18 0>; /* D18 / A4 / I2C-SDA */
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>;
digital-pin-gpios = <&arduino_nano_header 0 0>,
<&arduino_nano_header 1 0>,
<&arduino_nano_header 2 0>,
<&arduino_nano_header 3 0>,
<&arduino_nano_header 4 0>,
<&arduino_nano_header 5 0>,
<&arduino_nano_header 6 0>,
<&arduino_nano_header 7 0>,
<&arduino_nano_header 8 0>,
<&arduino_nano_header 9 0>,
<&arduino_nano_header 10 0>,
<&arduino_nano_header 11 0>,
<&arduino_nano_header 12 0>,
<&arduino_nano_header 13 0>,
<&arduino_nano_header 14 0>, /* D14 / A0 */
<&arduino_nano_header 15 0>,
<&arduino_nano_header 16 0>,
<&arduino_nano_header 17 0>,
<&arduino_nano_header 18 0>, /* D18 / A4 / I2C-SDA */
<&arduino_nano_header 19 0>, /* D19 / A5 / I2C-SCL */
<&arduino_nano_header 20 0>,
<&arduino_nano_header 21 0>;

pwms = <&tcc0 0 255>,
<&tcc0 1 255>,
Expand Down
46 changes: 23 additions & 23 deletions variants/nrf52840dk_nrf52840/nrf52840dk_nrf52840.overlay
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,28 +1,28 @@
/ {
zephyr,user {
d0_gpios = <&arduino_header 6 0>; /* Digital */
d1_gpios = <&arduino_header 7 0>;
d2_gpios = <&arduino_header 8 0>;
d3_gpios = <&arduino_header 9 0>;
d4_gpios = <&arduino_header 10 0>;
d5_gpios = <&arduino_header 11 0>;
d6_gpios = <&arduino_header 12 0>;
d7_gpios = <&arduino_header 13 0>;
d8_gpios = <&arduino_header 14 0>;
d9_gpios = <&arduino_header 15 0>;
d10_gpios = <&arduino_header 16 0>;
d11_gpios = <&arduino_header 17 0>;
d12_gpios = <&arduino_header 18 0>;
d13_gpios = <&arduino_header 19 0>;
d14_gpios = <&arduino_header 20 0>;
d15_gpios = <&arduino_header 21 0>;
d16_gpios = <&arduino_header 0 0>; /* Analog */
d17_gpios = <&arduino_header 1 0>;
d18_gpios = <&arduino_header 2 0>;
d19_gpios = <&arduino_header 3 0>;
d20_gpios = <&arduino_header 4 0>;
d21_gpios = <&arduino_header 5 0>;
d22_gpios = <&gpio0 13 GPIO_ACTIVE_LOW>;
digital-pin-gpios = <&arduino_header 6 0>, /* Digital */
<&arduino_header 7 0>,
<&arduino_header 8 0>,
<&arduino_header 9 0>,
<&arduino_header 10 0>,
<&arduino_header 11 0>,
<&arduino_header 12 0>,
<&arduino_header 13 0>,
<&arduino_header 14 0>,
<&arduino_header 15 0>,
<&arduino_header 16 0>,
<&arduino_header 17 0>,
<&arduino_header 18 0>,
<&arduino_header 19 0>,
<&arduino_header 20 0>,
<&arduino_header 21 0>,
<&arduino_header 0 0>, /* Analog */
<&arduino_header 1 0>,
<&arduino_header 2 0>,
<&arduino_header 3 0>,
<&arduino_header 4 0>,
<&arduino_header 5 0>,
<&gpio0 13 GPIO_ACTIVE_LOW>;

pwms = <&pwm0 1 255 PWM_POLARITY_NORMAL>,
<&pwm0 2 255 PWM_POLARITY_NORMAL>,
Expand Down
42 changes: 24 additions & 18 deletions variants/variants.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,33 +18,39 @@
#include "arduino_mkrzero_pinmap.h"
#endif // CONFIG_BOARD_ARDUINO_MKRZERO

#define MAX_DIGITAL_PINS 255
#define DIGITAL_PIN_EXISTS(n, p, i, dev, num) \
(((dev == DT_REG_ADDR(DT_PHANDLE_BY_IDX(n, p, i))) && \
(num == DT_PHA_BY_IDX(n, p, i, pin))) \
? 1 \
: 0)

/* Check all pins are defined only once */
#define DIGITAL_PIN_CHECK_UNIQUE(i, _) \
((DT_FOREACH_PROP_ELEM_SEP_VARGS( \
DT_PATH(zephyr_user), digital_pin_gpios, DIGITAL_PIN_EXISTS, (+), \
DT_REG_ADDR(DT_PHANDLE_BY_IDX(DT_PATH(zephyr_user), digital_pin_gpios, i)), \
DT_PHA_BY_IDX(DT_PATH(zephyr_user), digital_pin_gpios, i, pin))) == 1)

#if !LISTIFY(DT_PROP_LEN(DT_PATH(zephyr_user), digital_pin_gpios), DIGITAL_PIN_CHECK_UNIQUE, (&&))
#error "digital_pin_gpios has duplicate definition"
#endif

#define DN_ENUMS(n, _) COND_CODE_1(DT_NODE_HAS_PROP(DT_PATH(zephyr_user), \
d ## n ## _gpios), (D ## n ,), ())
#undef DIGITAL_PIN_CHECK_UNIQUE

#define LABEL_UPPER_TOKEN_COMMA(nodeid) DT_STRING_UPPER_TOKEN(nodeid, label),
#define DN_ENUMS(n, p, i) D##i = i

/*
* expand as
* enum digitalPins { D0, D1, ... LED... NUM_OF_DIGITAL_PINS };
*/
enum digitalPins { LISTIFY(MAX_DIGITAL_PINS, DN_ENUMS, ())
DT_FOREACH_CHILD(DT_PATH(leds), LABEL_UPPER_TOKEN_COMMA)
NUM_OF_DIGITAL_PINS };


#define NUMBERED_GPIO_DT_SPEC(n, _) \
COND_CODE_1(DT_NODE_HAS_PROP(DT_PATH(zephyr_user), d ## n ## _gpios), \
(GPIO_DT_SPEC_GET(DT_PATH(zephyr_user), d ## n ## _gpios),), ())

#define LABELED_GPIO_DT_SPEC(nodeid) GPIO_DT_SPEC_GET_BY_IDX(nodeid, gpios, 0),

static struct gpio_dt_spec arduino_pins[NUM_OF_DIGITAL_PINS] = {
LISTIFY(MAX_DIGITAL_PINS, NUMBERED_GPIO_DT_SPEC, ())
DT_FOREACH_CHILD(DT_PATH(leds), LABELED_GPIO_DT_SPEC)
enum digitalPins {
DT_FOREACH_PROP_ELEM_SEP(DT_PATH(zephyr_user), digital_pin_gpios, DN_ENUMS, (, )),
NUM_OF_DIGITAL_PINS
};

const struct gpio_dt_spec arduino_pins[] = {DT_FOREACH_PROP_ELEM_SEP(
DT_PATH(zephyr_user), digital_pin_gpios, GPIO_DT_SPEC_GET_BY_IDX, (, ))};

#ifdef CONFIG_ADC

#define AN_ENUMS(n, p, i) A ## i = DT_PROP_BY_IDX(n, p, i),
Expand Down