:orphan:
.. raw:: html
.. dtcompatible:: zephyr,ipc-openamp-static-vrings
.. _dtbinding_zephyr_ipc_openamp_static_vrings:
zephyr,ipc-openamp-static-vrings
################################
Vendor: :ref:`Zephyr-specific binding `
Description
***********
.. code-block:: none
OpenAMP (RPMsg with static VRINGs) backend
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
* - ``role``
- ``string``
- .. code-block:: none
OpenAMP roles
This property is **required**.
Legal values: ``'host'``, ``'remote'``
* - ``memory-region``
- ``phandle``
- .. code-block:: none
phandle to the shared memory region
This property is **required**.
* - ``zephyr,priority``
- ``array``
- .. code-block:: none
WQ priority for the instance. This property is an array composed by the
priority level and the type of priority (PRIO_COOP for cooperative or
PRIO_PREEMPT for preemptive).
For example for a thread priority K_PRIO_COOP(1) in DT we have
priority = <1 PRIO_COOP>;
or for K_PRIO_PREEMPT(2)
priority = <2 PRIO_PREEMPT>;
When this property is missing a default priority of <0 PRIO_PREEMPT> is
assumed.
* - ``zephyr,buffer-size``
- ``int``
- .. code-block:: none
The size of the buffer used to send data between host and remote. Default
value is RPMSG_BUFFER_SIZE. This property must be the same for host and remote.
.. 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 "zephyr,ipc-openamp-static-vrings" compatible.
.. list-table::
:widths: 1 1 4
:header-rows: 1
* - Name
- Type
- Details
* - ``mboxes``
- ``phandle-array``
- .. code-block:: none
phandle to the MBOX controller (TX and RX are required)
This property is **required**.
* - ``mbox-names``
- ``string-array``
- .. code-block:: none
MBOX channel names (must be called "tx" and "rx")
This property is **required**.
* - ``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``
- ``array``
- .. code-block:: none
register space
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
* - ``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.