Skip to content

Commit 0bae8e1

Browse files
soburiDhruvaG2000
authored andcommitted
documentation: Update document about pin mapping nodes
Update the document about `digital-pin-gpios` and add description for `pwm-pin-gpios` and `adc-pin-gpios` Signed-off-by: TOKITA Hiroshi <[email protected]>
1 parent b061645 commit 0bae8e1

File tree

1 file changed

+9
-4
lines changed

1 file changed

+9
-4
lines changed

Diff for: documentation/variants.md

+9-4
Original file line numberDiff line numberDiff line change
@@ -49,10 +49,15 @@ variants/
4949

5050
### DeviceTree Overlay files for Arduino boards
5151

52-
This module requires that your Arduino header pins be mapped in the DeviceTree
53-
to 'digital-pin-gpios' array that child of a `zephyr,user` node. Follow the
54-
examples in the variants directory to create an overlay file and a header file
55-
for your board.
52+
The Arduino API requires pin mapping definitions to use Arduino-style pin numbers
53+
(pin numbers printed on the board, not GPIO numbers).
54+
The pin-mapping node is under the `zephyr,user` node of DTS.
55+
`digital-pin-gpios` defines digital input/output pins that is D0, D1, ..,
56+
`adc-pin-gpios` defines analog input pins that is A0, A1, ... .
57+
`pwm-pin-gpios` defines PWM pins.
58+
Each pin specifies in the form of a GPIO cell.
59+
Usually, it is in the form of `<[port] [pin-number] [flag]>`.
60+
You can also use the Arduino header node definition here.
5661

5762
### Overlays using previously-defined Arduino headers
5863

0 commit comments

Comments
 (0)