:orphan:
.. raw:: html
.. dtcompatible:: arduino-mkr-header
.. _dtbinding_arduino_mkr_header:
arduino-mkr-header
##################
Vendor: :ref:`Generic or vendor-independent `
Description
***********
.. code-block:: none
GPIO pins exposing on Arduino MKR headers.
The Arduino MKR layout provides two headers on both edges of the board.
* One side of the 14-pin header is analog inputs and digital signals.
A1 to A6 is Analog input. The outside pin is AREF.
A0 that is next to AREF used as a DAC output pin too.
D0-D5 is a digital output.
* The other side 14-pin header is power supplies and peripheral interface.
There are 5V and VCC power supply, GND, and RESET pin. UART, I2C,
and SPI peripheral pins are also there. The end 2 pins are simple GPIO pins.
This binding provides a nexus mapping for 22 pins where parent pins 0
through 14 correspond to D0 through D21, and parent pins 15 through 21
correspond to A0 through A6, as depicted below.
- AREF 5V -
15 A0/D15/DAC0 VIN -
16 A1/D16 VCC -
17 A2/D17 GND -
18 A3/D18 RESET -
19 A4/D19 D14/TX 14
20 A5/D20 D13/RX 13
21 A6/D21 D12/SCL 12
0 D0 D11/SDA 11
1 D1 D10/CPIO 10
2 D2 D9/SCK 9
3 D3 D8/COPI 8
4 D4 D7 7
5 D5 D6 6
Properties
**********
.. tabs::
.. group-tab:: Node specific properties
Properties not inherited from the base binding file.
.. list-table::
:widths: 1 1 4
:header-rows: 1
* - Name
- Type
- Details
* - ``gpio-map``
- ``compound``
- This property is **required**.
* - ``gpio-map-mask``
- ``compound``
-
* - ``gpio-map-pass-thru``
- ``compound``
-
* - ``#gpio-cells``
- ``int``
- .. code-block:: none
Number of items to expect in a GPIO specifier
This property is **required**.
.. group-tab:: Deprecated node specific properties
Deprecated properties not inherited from the base binding file.
(None)
.. group-tab:: Base properties
Properties inherited from the base binding file, which defines
common properties that may be set on many nodes. Not all of these
may apply to the "arduino-mkr-header" compatible.
.. list-table::
:widths: 1 1 4
:header-rows: 1
* - Name
- Type
- Details
* - ``status``
- ``string``
- .. code-block:: none
indicates the operational status of a device
Legal values: ``'ok'``, ``'okay'``, ``'disabled'``, ``'reserved'``, ``'fail'``, ``'fail-sss'``
See :ref:`dt-important-props` for more information.
* - ``compatible``
- ``string-array``
- .. code-block:: none
compatible strings
This property is **required**.
See :ref:`dt-important-props` for more information.
* - ``reg``
- ``array``
- .. code-block:: none
register space
See :ref:`dt-important-props` for more information.
* - ``reg-names``
- ``string-array``
- .. code-block:: none
name of each register space
* - ``interrupts``
- ``array``
- .. code-block:: none
interrupts for device
See :ref:`dt-important-props` for more information.
* - ``interrupts-extended``
- ``compound``
- .. code-block:: none
extended interrupt specifier for device
* - ``interrupt-names``
- ``string-array``
- .. code-block:: none
name of each interrupt
* - ``interrupt-parent``
- ``phandle``
- .. code-block:: none
phandle to interrupt controller node
* - ``label``
- ``string``
- .. code-block:: none
Human readable string describing the device (used as device_get_binding() argument)
See :ref:`dt-important-props` for more information.
This property is **deprecated**.
* - ``clocks``
- ``phandle-array``
- .. code-block:: none
Clock gate information
* - ``clock-names``
- ``string-array``
- .. code-block:: none
name of each clock
* - ``#address-cells``
- ``int``
- .. code-block:: none
number of address cells in reg property
* - ``#size-cells``
- ``int``
- .. code-block:: none
number of size cells in reg property
* - ``dmas``
- ``phandle-array``
- .. code-block:: none
DMA channels specifiers
* - ``dma-names``
- ``string-array``
- .. code-block:: none
Provided names of DMA channel specifiers
* - ``io-channels``
- ``phandle-array``
- .. code-block:: none
IO channels specifiers
* - ``io-channel-names``
- ``string-array``
- .. code-block:: none
Provided names of IO channel specifiers
* - ``mboxes``
- ``phandle-array``
- .. code-block:: none
mailbox / IPM channels specifiers
* - ``mbox-names``
- ``string-array``
- .. code-block:: none
Provided names of mailbox / IPM channel specifiers
* - ``wakeup-source``
- ``boolean``
- .. code-block:: none
Property to identify that a device can be used as wake up source.
When this property is provided a specific flag is set into the
device that tells the system that the device is capable of
wake up the system.
Wake up capable devices are disabled (interruptions will not wake up
the system) by default but they can be enabled at runtime if necessary.
* - ``power-domain``
- ``phandle``
- .. code-block:: none
Power domain the device belongs to.
The device will be notified when the power domain it belongs to is either
suspended or resumed.
* - ``zephyr,pm-device-runtime-auto``
- ``boolean``
- .. code-block:: none
Automatically configure the device for runtime power management after the
init function runs.