NXP ESAI DAI binding

: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:: nxp,dai-esai
.. _dtbinding_nxp_dai_esai:

nxp,dai-esai
############

Vendor: :ref:`NXP Semiconductors <dt_vendor_nxp>`

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



.. code-block:: none

   NXP Enhanced Serial Audio Interface (ESAI) node

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

         * - ``dai-index``
           - ``int``
           - .. code-block:: none

                Use this property to specify the index of the DAI. At the
                moment, this is only used by SOF to fetch the "struct device"
                associated with the DAI whose index Linux passes to SOF
                through an IPC. If this property is not specified, the DAI
                index will be considered 0.



         * - ``tx-fifo-watermark``
           - ``int``
           - .. code-block:: none

                Use this property to specify the watermark value for the TX
                FIFO. This value needs to be in FIFO words (NOT BYTES). This
                value needs to be in the following interval: (0, DEFAULT_FIFO_DEPTH],
                otherwise a BUILD_ASSERT() failure will be raised. If unspecified,
                the TX FIFO watermark will be set to DEFAULT_FIFO_DEPTH / 2.



         * - ``rx-fifo-watermark``
           - ``int``
           - .. code-block:: none

                Use this property to specify the watermark value for the RX
                FIFO. This values needs to be in FIFO words (NOT BYTES). This
                value needs to be in the following interval: (0, DEFAULT_FIFO_DEPTH],
                otherwise a BUILD_ASSERT() failure will be raised. If unspecified,
                the RX FIFO watermark will be set to DEFAULT_FIFO_DEPTH / 2.



         * - ``fifo-depth``
           - ``int``
           - .. code-block:: none

                Use this property to set the FIFO depth that will be reported
                to upper layer applications calling dai_get_properties(). This
                value should be in the following interval: (0, DEFAULT_FIFO_DEPTH],
                otherwise a BUILD_ASSERT() failure will be raised. By DEFAULT_FIFO_DEPTH
                we mean the actual (hardware) value of the FIFO depth. This is needed
                because some applications (e.g: SOF) use this value directly as the
                DMA burst size in which case DEFAULT_FIFO_DEPTH cannot be used.
                Generally, reporting a false FIFO depth should be avoided. Please note
                that the sanity check for tx/rx-fifo-watermark uses DEFAULT_FIFO_DETPH
                instead of this value so use with caution. If unsure, it's better to
                not use this property at all, in which case the reported value will be
                DEFAULT_FIFO_DEPTH.



         * - ``word-width``
           - ``int``
           - .. code-block:: none

                This property is used to specify the width of a word. If unspecified,
                the word width used will be 24.



         * - ``esai-pin-modes``
           - ``array``
           - .. code-block:: none

                This property is used to configure the ESAI pins. Each ESAI pin
                supports 4 modes:
                  1) DISCONNECTED (PDC[i] = 0, PC[i] = 0)
                  2) GPIO input (PDC[i] = 0, PC[i] = 1)
                  3) GPIO output (PDC[i] = 1, PC[i] = 0)
                  4) ESAI (PDC[i] = 1, PC[i] = 1)
                If pin is not used then DISCONNECTED mode should be used for said pin.
                If unsure, don't specify this property at all. By default, all pins will
                be set to ESAI mode.



         * - ``esai-clock-configuration``
           - ``array``
           - .. code-block:: none

                Use this property to configure the directions of the ESAI clocks (HCLK, BCLK, FSYNC).
                This provides extra flexibility since the bespoke configuration is not direction-based.
                The values from this array will overwrite the values set through the bespoke
                configuration. If unspecified, the values from the bespoke configuration will be used.





   .. 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 "nxp,dai-esai" compatible.

      .. list-table::
         :widths: 1 1 4
         :header-rows: 1

         * - Name
           - Type
           - Details

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



         * - ``zephyr,disabling-power-states``
           - ``phandles``
           - .. code-block:: none

                List of power states that will disable this device power.



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


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


         * - ``zephyr,deferred-init``
           - ``boolean``
           - .. code-block:: none

                Do not initialize device automatically on boot. Device should be manually
                initialized using device_init().