:orphan:
.. raw:: html
.. dtcompatible:: atmel,sam0-uart
.. _dtbinding_atmel_sam0_uart:
atmel,sam0-uart
###############
Vendor: :ref:`Atmel Corporation `
Description
***********
These nodes are "uart" bus nodes.
.. code-block:: none
Atmel SAM0 SERCOM UART driver
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
* - ``rxpo``
- ``int``
- .. code-block:: none
Receive Data Pinout. An enumeration with the following values:
+-------+---------------+
| Value | RX Pin |
+-------+---------------+
| 0 | SERCOM_PAD[0] |
+-------+---------------+
| 1 | SERCOM_PAD[1] |
+-------+---------------+
| 2 | SERCOM_PAD[2] |
+-------+---------------+
| 3 | SERCOM_PAD[3] |
+-------+---------------+
This property is **required**.
* - ``txpo``
- ``int``
- .. code-block:: none
Transmit Data Pinout. An enumeration with values that depend on the
hardware being used. This controls both the transmit pins and if
hardware flow control is used.
SAMD20:
+-------+---------------+
| Value | TX Pin |
+-------+---------------+
| 0 | SERCOM_PAD[0] |
+-------+---------------+
| 1 | SERCOM_PAD[2] |
+-------+---------------+
SAMD21/DA21/R21:
+-------+---------------+---------------+---------------+
| Value | TX Pin | RTS | CTS |
+-------+---------------+---------------+---------------+
| 0 | SERCOM_PAD[0] | N/A | N/A |
+-------+---------------+---------------+---------------+
| 1 | SERCOM_PAD[2] | N/A | N/A |
+-------+---------------+---------------+---------------+
| 2 | SERCOM_PAD[0] | SERCOM_PAD[2] | SERCOM_PAD[3] |
+-------+---------------+---------------+---------------+
| 3 | Reserved |
+-------+-----------------------------------------------+
SAML2x/C2x:
+-------+----------------+---------------+--------------+
| Value | TX Pin | RTS | CTS |
+-------+---------------+---------------+---------------+
| 0 | SERCOM_PAD[0] | N/A | N/A |
+-------+---------------+---------------+---------------+
| 1 | SERCOM_PAD[2] | N/A | N/A |
+-------+---------------+---------------+---------------+
| 2 | SERCOM_PAD[0] | SERCOM_PAD[2] | SERCOM_PAD[3] |
+-------+---------------+---------------+---------------+
| 3 | SERCOM_PAD[0] | SERCOM_PAD[2] | N/A |
+-------+---------------+---------------+---------------+
SAMD5/E5:
+-------+---------------+---------------+---------------+
| Value | TX Pin | RTS | CTS |
+-------+---------------+---------------+---------------+
| 0 | SERCOM_PAD[0] | N/A | N/A |
+-------+---------------+---------------+---------------+
| 1 | Reserved |
+-------+---------------+---------------+---------------+
| 2 | SERCOM_PAD[0] | SERCOM_PAD[2] | SERCOM_PAD[3] |
+-------+---------------+---------------+---------------+
| 3 | SERCOM_PAD[0] | SERCOM_PAD[2] | N/A |
+-------+---------------+---------------+---------------+
This property is **required**.
* - ``collision-detection``
- ``boolean``
- .. code-block:: none
Enable collision detection for half-duplex mode.
* - ``clock-frequency``
- ``int``
- .. code-block:: none
Clock frequency information for UART operation
* - ``current-speed``
- ``int``
- .. code-block:: none
Initial baud rate setting for UART
* - ``hw-flow-control``
- ``boolean``
- .. code-block:: none
Set to enable RTS/CTS flow control at boot time
* - ``parity``
- ``string``
- .. code-block:: none
Configures the parity of the adapter. Enumeration id 0 for none, 1 for odd
and 2 for even parity. Default to none if not specified.
Legal values: ``'none'``, ``'odd'``, ``'even'``
* - ``stop-bits``
- ``string``
- .. code-block:: none
Sets the number of stop bits.
Legal values: ``'0_5'``, ``'1'``, ``'1_5'``, ``'2'``
* - ``data-bits``
- ``int``
- .. code-block:: none
Sets the number of data bits.
Legal values: ``5``, ``6``, ``7``, ``8``, ``9``
* - ``pinctrl-0``
- ``phandles``
- .. code-block:: none
Pin configuration/s for the first state. Content is specific to the
selected pin controller driver implementation.
* - ``pinctrl-1``
- ``phandles``
- .. code-block:: none
Pin configuration/s for the second state. See pinctrl-0.
* - ``pinctrl-2``
- ``phandles``
- .. code-block:: none
Pin configuration/s for the third state. See pinctrl-0.
* - ``pinctrl-3``
- ``phandles``
- .. code-block:: none
Pin configuration/s for the fourth state. See pinctrl-0.
* - ``pinctrl-4``
- ``phandles``
- .. code-block:: none
Pin configuration/s for the fifth state. See pinctrl-0.
* - ``pinctrl-names``
- ``string-array``
- .. code-block:: none
Names for the provided states. The number of names needs to match the
number of states.
.. 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 "atmel,sam0-uart" compatible.
.. list-table::
:widths: 1 1 4
:header-rows: 1
* - Name
- Type
- Details
* - ``reg``
- ``array``
- .. code-block:: none
register space
This property is **required**.
See :ref:`dt-important-props` for more information.
* - ``interrupts``
- ``array``
- .. code-block:: none
interrupts for device
This property is **required**.
See :ref:`dt-important-props` for more information.
* - ``clocks``
- ``phandle-array``
- .. code-block:: none
Clock gate information
This property is **required**.
* - ``clock-names``
- ``string-array``
- .. code-block:: none
name of each clock
This property is **required**.
* - ``dmas``
- ``phandle-array``
- .. code-block:: none
Optional TX & RX dma specifiers. Each specifier will have a phandle
reference to the dmac controller, the channel number, and peripheral
trigger source.
For example dmas for TX, RX on SERCOM3
dmas = <&dmac 0 0xb>, <&dmac 0 0xa>;
* - ``dma-names``
- ``string-array``
- .. code-block:: none
Required if the dmas property exists. This should be "tx" and "rx"
to match the dmas property.
For example
dma-names = "tx", "rx";
* - ``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-names``
- ``string-array``
- .. code-block:: none
name of each register space
* - ``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**.
* - ``#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
* - ``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.