: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:: nordic,nrf-ipct-global
.. _dtbinding_nordic_nrf_ipct_global:

nordic,nrf-ipct-global
######################

Vendor: :ref:`Nordic Semiconductor <dt_vendor_nordic>`

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



.. code-block:: none

   Nordic Global IPCT (Interprocessor Communication Transceiver)

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

         * - ``global-domain-id``
           - ``int``
           - .. code-block:: none

                Global IPCT instances reside on specific buses within the Global Domain,
                such as fast and slow, which have different IDs that do not match the
                standard Global Domain ID presented in their address.



             This property is **required**.

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

                Number of channels implemented by the IPCT instance.


             This property is **required**.

         * - ``source-channel-links``
           - ``array``
           - .. code-block:: none

                Mapping of IPCT channels that are mapped between two IPCT instances on
                separate domains, in which a channel on this IPCT node is considered
                the source. This array is then comprised of a 3-integer-wide "unit"
                that defines one connection of the mapping. The format of this unit
                is <source_channel sink_domain_id sink_channel>. Units are sequential
                in the array, therefore requiring the length of this property to be
                a factor of 3.

                For example, if channel 2 is to be mapped to Radio Core (ID: 3) IPCT
                channel 4, then the array "unit" would be <2 NRF_DOMAIN_ID_RADIOCORE 4>
                or <2 3 4>.



         * - ``sink-channel-links``
           - ``array``
           - .. code-block:: none

                Mapping of IPCT channels that are mapped between two IPCT instances on
                separate domains, in which a channel on this IPCT node is considered
                the sink. This array is then comprised of a 3-integer-wide "unit"
                that defines one connection of the mapping. The format of this unit
                is <sink_channel source_domain_id source_channel>. Units are sequential
                in the array, therefore requiring the length of this property to be
                a factor of 3.

                For example, if channel 2 is to be mapped to Radio Core (ID: 3) IPCT
                channel 4, then the array "unit" would be <2 NRF_DOMAIN_ID_RADIOCORE 4>
                or <2 3 4>.



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

                List of channels in a split-ownership peripheral that are to be owned
                for use by the compiled CPU.



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

                List of channels in a split-ownership, split-security peripheral that
                are to be configured as nonsecure. In Trustzone systems, this property
                is only evaluated for secure peripherals, as nonsecure channels are
                implicitly specified through the owned-channels property. This property
                is ignored in non-Trustzone systems.



         * - ``child-owned-channels``
           - ``array``
           - .. code-block:: none

                List of channels in a split-ownership peripheral that are officially
                owned by the compiled CPU but intended to be used by its child
                subprocessor(s).





   .. 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 "nordic,nrf-ipct-global" 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.

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


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