: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,edma
.. _dtbinding_nxp_edma:

nxp,edma
########

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

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

These nodes are "dma" bus nodes.

.. code-block:: none

   NXP enhanced Direct Memory Access (eDMA) 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

         * - ``valid-channels``
           - ``array``
           - .. code-block:: none

                Use this property to specify which channel indexes are
                to be considered valid. The difference between this
                property and "dma-channels" is the fact that this
                property allows you to have "gaps" between the channel
                indexes. This is useful in cases where you know you're
                not going to be using all of the possible channels, thus
                leading to a more readable DTS. Of course, this property
                and "dma-channels" are mutually exclusive, meaning you
                can't specify both properties as this will lead to a
                BUILD_ASSERT() failure.



         * - ``hal-cfg-index``
           - ``int``
           - .. code-block:: none

                Use this property to specify which HAL configuration
                should be used. In the case of some SoCs (e.g: i.MX93),
                there can be multiple eDMA variants, each of them having
                different configurations (e.g: i.MX93 eDMA3 has 31 channels,
                i.MX93 eDMA4 has 64 channels and both of them have slightly
                different register layouts). To overcome this issue, the HAL
                exposes an array of configurations called "edma_hal_configs".
                To perform various operations, the HAL uses an eDMA configuration
                which will tell it what register layout the IP has, the number of
                channels, various flags and offsets. As such, if there's multiple
                configurations available, the user will have to specify which
                configuration to use through this property. If missing, the
                configuration found at index 0 will be used.



         * - ``#dma-cells``
           - ``int``
           - .. code-block:: none

                Number of items to expect in a DMA specifier


             This property is **required**.

         * - ``dma-channel-mask``
           - ``int``
           - .. code-block:: none

                Bitmask of available DMA channels in ascending order that are
                not reserved by firmware and are available to the
                kernel. i.e. first channel corresponds to LSB.



         * - ``dma-channels``
           - ``int``
           - .. code-block:: none

                Number of DMA channels supported by the controller


         * - ``dma-requests``
           - ``int``
           - .. code-block:: none

                Number of DMA request signals supported by the controller.


         * - ``dma-buf-addr-alignment``
           - ``int``
           - .. code-block:: none

                Memory address alignment requirement for DMA buffers used by the controller.


         * - ``dma-buf-size-alignment``
           - ``int``
           - .. code-block:: none

                Memory size alignment requirement for DMA buffers used by the controller.


         * - ``dma-copy-alignment``
           - ``int``
           - .. code-block:: none

                Minimal chunk of data possible to be copied by the controller.




   .. 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,edma" 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:`zephyr: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:`zephyr:dt-important-props` for more information.

         * - ``compatible``
           - ``string-array``
           - .. code-block:: none

                compatible strings


             This property is **required**.

             See :ref:`zephyr: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:`zephyr: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:`zephyr: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.