: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:: xlnx,mbox-versal-ipi-mailbox
.. _dtbinding_xlnx_mbox_versal_ipi_mailbox:

xlnx,mbox-versal-ipi-mailbox
############################

.. sidebar:: Overview

   :Name: ``xlnx,mbox-versal-ipi-mailbox``
   :Vendor: :ref:`Xilinx <dt_vendor_xlnx>`
   :Used in: :zephyr:board-catalog:`List of boards <#compatibles=xlnx,mbox-versal-ipi-mailbox>` using
               this compatible
   :Driver: :zephyr_file:`drivers/mbox/mbox_xlnx_ipi_mailbox.c`

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



.. code-block:: none

   AMD-Xilinx IPI (Inter Processor Interrupt) Mailbox Controller.

   It manages messaging and interrupt handling between two IPI agents (processors).
   Each IPI agent owns registers used for notification and may include buffers for message.

   Example definition:

     mailbox@ff300000 {
       compatible = "xlnx,versal-ipi-mailbox";
       interrupts = <GIC_SPI 29 IRQ_TYPE_LEVEL_HIGH>;
       reg = <0x0 0xff300000 0x0 0x1000>,
             <0x0 0xff990000 0x0 0x1ff>;
       reg-names = "ctrl", "msg";
       xlnx,ipi-id = <0>;
       #address-cells = <2>;
       #size-cells = <2>;

       /* buffered IPI */
       child_1: mailbox@ff340000 {
         compatible = "xlnx,versal-ipi-dest-mailbox";
         reg = <0x0 0xff340000 0x0 0x1000>,
               <0x0 0xff990400 0x0 0x1ff>;
         reg-names = "ctrl", "msg";
         xlnx,ipi-id = <4>;
         #mbox-cells = <1>;
       };

       /* bufferless IPI */
       child_2: mailbox@ff370000 {
         compatible = "xlnx,versal-ipi-dest-mailbox";
         reg = <0x0 0xff370000 0x0 0x1000>;
         reg-names = "ctrl";
         xlnx,ipi-id = <7>;
         #mbox-cells = <1>;
       };
     };

   Example usage:
     mbox-consumer {
       compatible = "vnd,mbox-consumer";
       mboxes = <&child_1 0>, <&child_1 1>;
       mbox-names = "tx", "rx";
     };

Properties
**********

Top level properties
====================


These property descriptions apply to "xlnx,mbox-versal-ipi-mailbox"
nodes themselves. This page also describes child node
properties in the following sections.

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

         * - ``xlnx,ipi-id``
           - ``int``
           - .. code-block:: none

                Host IPI Agent ID associated with the mailbox


             This property is **required**.



   .. 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 "xlnx,mbox-versal-ipi-mailbox" compatible.

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

         * - Name
           - Type
           - Details

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

                Host IPI agent control and message register space


             This property is **required**.

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

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

                Identifiers for register spaces with "ctrl" for control and "msg" for message


             This property is **required**.

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

                Information about interrupts generated by the device, encoded as an array
                of one or more interrupt specifiers. The format of the data in this property
                varies by where the device appears in the interrupt tree. Devices with the same
                "interrupt-parent" will use the same format in their interrupts properties.

                For details, see "2.4 Interrupts and Interrupt Mapping" in
                Devicetree Specification v0.4.



             This property is **required**.

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

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

                Indicates the operational status of the hardware or other
                resource that the node represents. In particular:

                  - "okay" means the resource is operational and, for example,
                    can be used by device drivers
                  - "disabled" means the resource is not operational and the system
                    should treat it as if it is not present

                For details, see "2.3.4 status" in Devicetree Specification v0.4.



             Legal values: ``'okay'``, ``'disabled'``, ``'reserved'``, ``'fail'``, ``'fail-sss'``

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

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

                This property is a list of strings that essentially define what
                type of hardware or other resource this devicetree node
                represents. Each device driver checks for specific compatible
                property values to find the devicetree nodes that represent
                resources that the driver should manage.

                The recommended format is "vendor,device", The "vendor" part is
                an abbreviated name of the vendor. The "device" is usually from
                the datasheet.

                The compatible property can have multiple values, ordered from
                most- to least-specific. Having additional values is useful when the
                device is a specific instance of a more general family, to allow the
                system to match the most specific driver available.

                For details, see "2.3.1 compatible" in Devicetree Specification v0.4.



             This property is **required**.

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

         * - ``interrupts-extended``
           - ``compound``
           - .. code-block:: none

                Extended interrupt specifier for device, used as an alternative to
                the "interrupts" property.

                For details, see "2.4 Interrupts and Interrupt Mapping" in
                Devicetree Specification v0.4.



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

                Optional names given to each interrupt generated by a device.
                The interrupts themselves are defined in either "interrupts" or
                "interrupts-extended" properties.

                For details, see "2.4 Interrupts and Interrupt Mapping" in
                Devicetree Specification v0.4.



         * - ``interrupt-parent``
           - ``phandle``
           - .. code-block:: none

                If present, this refers to the node which handles interrupts generated
                by this device.

                For details, see "2.4 Interrupts and Interrupt Mapping" in
                Devicetree Specification v0.4.



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

                Human readable string describing the device. Use of this property is
                deprecated except as needed on a case-by-case basis.

                For details, see "4.1.2 Miscellaneous Properties" in Devicetree
                Specification v0.4.



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

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

                Information about the device's clock providers. In general, this property
                should follow conventions established in the dt-schema binding:

                  https://github.com/devicetree-org/dt-schema/blob/main/dtschema/schemas/clock/clock.yaml



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

                Optional names given to each clock provider in the "clocks" property.



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

                This property encodes the number of <u32> cells used by address fields
                in "reg" properties in this node's children.

                For details, see "2.3.5 #address-cells and #size-cells" in Devicetree
                Specification v0.4.



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

                This property encodes the number of <u32> cells used by size fields in
                "reg" properties in this node's children.

                For details, see "2.3.5 #address-cells and #size-cells" in Devicetree
                Specification v0.4.



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

                DMA channel specifiers relevant to the device.



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

                Optional names given to the DMA channel specifiers in the "dmas" property.



         * - ``io-channels``
           - ``phandle-array``
           - .. code-block:: none

                IO channel specifiers relevant to the device.



         * - ``io-channel-names``
           - ``string-array``
           - .. code-block:: none

                Optional names given to the IO channel specifiers in the "io-channels" property.



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

                Mailbox / IPM channel specifiers relevant to the device.



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

                Optional names given to the mbox specifiers in the "mboxes" property.



         * - ``power-domains``
           - ``phandle-array``
           - .. code-block:: none

                Power domain specifiers relevant to the device.



         * - ``power-domain-names``
           - ``string-array``
           - .. code-block:: none

                Optional names given to the power domain specifiers in the "power-domains" property.



         * - ``#power-domain-cells``
           - ``int``
           - .. code-block:: none

                Number of cells in power-domains property



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

                HW spinlock id relevant to the device.



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

                Optional names given to the hwlock specifiers in the "hwlocks" property.



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

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



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



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






Child node properties
=====================

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

   * - Name
     - Type
     - Details

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

          Remote IPI agent control and message register space


       This property is **required**.

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

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

          Identifiers for register spaces with "ctrl" for control and "msg" for message


       This property is **required**.

   * - ``xlnx,ipi-id``
     - ``int``
     - .. code-block:: none

          Remote IPI Agent ID associated with the mailbox


       This property is **required**.

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

          Indicates the operational status of the hardware or other
          resource that the node represents. In particular:

            - "okay" means the resource is operational and, for example,
              can be used by device drivers
            - "disabled" means the resource is not operational and the system
              should treat it as if it is not present

          For details, see "2.3.4 status" in Devicetree Specification v0.4.



       Legal values: ``'okay'``, ``'disabled'``, ``'reserved'``, ``'fail'``, ``'fail-sss'``

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

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

          This property is a list of strings that essentially define what
          type of hardware or other resource this devicetree node
          represents. Each device driver checks for specific compatible
          property values to find the devicetree nodes that represent
          resources that the driver should manage.

          The recommended format is "vendor,device", The "vendor" part is
          an abbreviated name of the vendor. The "device" is usually from
          the datasheet.

          The compatible property can have multiple values, ordered from
          most- to least-specific. Having additional values is useful when the
          device is a specific instance of a more general family, to allow the
          system to match the most specific driver available.

          For details, see "2.3.1 compatible" in Devicetree Specification v0.4.



       This property is **required**.

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

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

          Information about interrupts generated by the device, encoded as an array
          of one or more interrupt specifiers. The format of the data in this property
          varies by where the device appears in the interrupt tree. Devices with the same
          "interrupt-parent" will use the same format in their interrupts properties.

          For details, see "2.4 Interrupts and Interrupt Mapping" in
          Devicetree Specification v0.4.



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

   * - ``interrupts-extended``
     - ``compound``
     - .. code-block:: none

          Extended interrupt specifier for device, used as an alternative to
          the "interrupts" property.

          For details, see "2.4 Interrupts and Interrupt Mapping" in
          Devicetree Specification v0.4.



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

          Optional names given to each interrupt generated by a device.
          The interrupts themselves are defined in either "interrupts" or
          "interrupts-extended" properties.

          For details, see "2.4 Interrupts and Interrupt Mapping" in
          Devicetree Specification v0.4.



   * - ``interrupt-parent``
     - ``phandle``
     - .. code-block:: none

          If present, this refers to the node which handles interrupts generated
          by this device.

          For details, see "2.4 Interrupts and Interrupt Mapping" in
          Devicetree Specification v0.4.



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

          Human readable string describing the device. Use of this property is
          deprecated except as needed on a case-by-case basis.

          For details, see "4.1.2 Miscellaneous Properties" in Devicetree
          Specification v0.4.



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

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

          Information about the device's clock providers. In general, this property
          should follow conventions established in the dt-schema binding:

            https://github.com/devicetree-org/dt-schema/blob/main/dtschema/schemas/clock/clock.yaml



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

          Optional names given to each clock provider in the "clocks" property.



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

          This property encodes the number of <u32> cells used by address fields
          in "reg" properties in this node's children.

          For details, see "2.3.5 #address-cells and #size-cells" in Devicetree
          Specification v0.4.



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

          This property encodes the number of <u32> cells used by size fields in
          "reg" properties in this node's children.

          For details, see "2.3.5 #address-cells and #size-cells" in Devicetree
          Specification v0.4.



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

          DMA channel specifiers relevant to the device.



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

          Optional names given to the DMA channel specifiers in the "dmas" property.



   * - ``io-channels``
     - ``phandle-array``
     - .. code-block:: none

          IO channel specifiers relevant to the device.



   * - ``io-channel-names``
     - ``string-array``
     - .. code-block:: none

          Optional names given to the IO channel specifiers in the "io-channels" property.



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

          Mailbox / IPM channel specifiers relevant to the device.



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

          Optional names given to the mbox specifiers in the "mboxes" property.



   * - ``power-domains``
     - ``phandle-array``
     - .. code-block:: none

          Power domain specifiers relevant to the device.



   * - ``power-domain-names``
     - ``string-array``
     - .. code-block:: none

          Optional names given to the power domain specifiers in the "power-domains" property.



   * - ``#power-domain-cells``
     - ``int``
     - .. code-block:: none

          Number of cells in power-domains property



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

          HW spinlock id relevant to the device.



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

          Optional names given to the hwlock specifiers in the "hwlocks" property.



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

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



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



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



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

          Number of items to expect in a Mailbox specifier


       This property is **required**.