: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:: arm,dma-pl330
.. _dtbinding_arm_dma_pl330:

arm,dma-pl330
#############

Vendor: :ref:`ARM Ltd. <dt_vendor_arm>`

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

These nodes are "dma" bus nodes.

.. code-block:: none

   PL330 DMA Controller

   A phandle to the DMA controller plus "channel" integer cell specifying
   channel to be used for data transfer

   Example for pl330 DMA Controller
      pl330: pl330@48300000 {
                   compatible = "arm,dma-pl330";
                   ...
                   dma-channels = <8>;
                   #dma-cells = <1>;
                   label = "PL330";
             };

   If PCIe EP client uses channel 0 for Tx DMA and channel 1 for Rx DMA
      pcie0_ep: pcie@4e100000 {
                   compatible = "brcm,iproc-pcie-ep";
                   ...
                   dmas = <&pl330 0>, <&pl330 1>;
                   dma-names = "txdma", "rxdma";
                   label = "PCIE_0";
             };

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

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

                microcode's physical memory address


             This property is **required**.

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

                Number of items to expect in a DMA specifier


             This property is **required**.

             Constant value: ``1``

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




   .. 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 "arm,dma-pl330" 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.

         * - ``label``
           - ``string``
           - .. code-block:: none

                Human readable string describing the device (used as device_get_binding() argument)


             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


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





Specifier cell names
********************

- dma cells: channel