:orphan:

.. raw:: html

    <!--
    FIXME: do not limit page width until content uses another representation
    format other than tables
    -->
    <style>.wy-nav-content { max-width: none; !important }</style>

.. dtcompatible:: st,stm32-usart
.. _dtbinding_st_stm32_usart:

st,stm32-usart
##############

Vendor: :ref:`STMicroelectronics <dt_vendor_st>`

Description
***********

These nodes are "uart" bus nodes.

.. code-block:: none

   STM32 USART

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

         * - ``resets``
           - ``phandle-array``
           - .. code-block:: none

                Reset information


             This property is **required**.

         * - ``single-wire``
           - ``boolean``
           - .. code-block:: none

                Enable the single wire half-duplex communication.
                Using this mode, TX and RX lines are internally connected and
                only TX pin is used afterwards and should be configured.
                RX/TX conflicts must be handled on user side.



         * - ``tx-rx-swap``
           - ``boolean``
           - .. code-block:: none

                Swap the TX and RX pins. Used in case of a cross wired connection.


         * - ``tx-invert``
           - ``boolean``
           - .. code-block:: none

                Invert the binary logic of tx pin. When enabled, physical logic levels are inverted and
                we use 1=Low, 0=High instead of 1=High, 0=Low.



         * - ``rx-invert``
           - ``boolean``
           - .. code-block:: none

                Invert the binary logic of rx pin. When enabled, physical logic levels are inverted and
                we use 1=Low, 0=High instead of 1=High, 0=Low.



         * - ``pinctrl-0``
           - ``phandles``
           - .. code-block:: none

                Pin configuration/s for the first state. Content is specific to the
                selected pin controller driver implementation.



             This property is **required**.

         * - ``pinctrl-names``
           - ``string-array``
           - .. code-block:: none

                Names for the provided states. The number of names needs to match the
                number of states.



             This property is **required**.

         * - ``wakeup-line``
           - ``int``
           - .. code-block:: none

                EXTI line number matching the device wakeup interrupt mask register.
                This property is required on stm32 devices where the wakeup interrupt signal could be
                configured masked at boot (sm32wl55 for instance), preventing the device to wakeup
                the core from stop mode(s).
                Valid range: 0 - 31



         * - ``de-enable``
           - ``boolean``
           - .. code-block:: none

                Enable activating an external transeiver through the DE pin which must also be configured
                using pinctrl.



         * - ``de-assert-time``
           - ``int``
           - .. code-block:: none

                Defines the time between the activation of the DE signal and the beginning of the start bit.
                It is expressed in 16th of a bit time.
                Valid range: 0 - 31



         * - ``de-deassert-time``
           - ``int``
           - .. code-block:: none

                Defines the time between the activation of the DE signal and the beginning of the start bit.
                It is expressed in 16th of a bit time.
                Valid range: 0 - 31



         * - ``de-invert``
           - ``boolean``
           - .. code-block:: none

                Invert the binary logic of the de pin. When enabled, physical logic levels are inverted and
                we use 1=Low, 0=High instead of 1=High, 0=Low.



         * - ``fifo-enable``
           - ``boolean``
           - .. code-block:: none

                Enables transmit and receive FIFO using default FIFO configuration (typically threshold is
                set to 1/8).
                In TX, FIFO allows to work in burst mode, easing scheduling of loaded applications. It also
                allows more reliable communication with UART devices sensitive to variation of inter-frames
                delays.
                In RX, FIFO reduces overrun occurrences.



         * - ``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-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.



         * - ``reset-names``
           - ``string-array``
           - .. code-block:: none

                Name of each reset




   .. 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 "st,stm32-usart" 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.

         * - ``clocks``
           - ``phandle-array``
           - .. code-block:: none

                Clock gate information


             This property is **required**.

         * - ``interrupts``
           - ``array``
           - .. code-block:: none

                interrupts for device


             This property is **required**.

             See :ref:`dt-important-props` for more information.

         * - ``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**.

         * - ``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.