:orphan:
.. raw:: html
.. dtcompatible:: nxp,ipc-rpmsg-lite
.. _dtbinding_nxp_ipc_rpmsg_lite:
nxp,ipc-rpmsg-lite
##################
.. sidebar:: Overview
:Name: ``nxp,ipc-rpmsg-lite``
:Vendor: :ref:`NXP Semiconductors N.V. `
:Used in: :zephyr:board-catalog:`List of boards <#compatibles=nxp,ipc-rpmsg-lite>` using
this compatible
:Driver: :zephyr_file:`subsys/ipc/ipc_service/backends/ipc_rpmsg_lite.c`
Description
***********
.. code-block:: none
RPMsg-Lite IPC Service backend using mailbox-based signaling.
This binding represents one RPMsg-Lite link (instance). Multiple links
share a single physical MBOX channel for inter-processor notifications.
The signaling topology is modelled explicitly:
- The instance with link-id = <0> owns the physical MBOX channel and
declares the standard ``mboxes`` / ``mbox-names`` properties.
- All other instances declare ``notification-parent`` pointing to the
owning instance, and omit ``mboxes`` / ``mbox-names``.
Host ipc[0,1] links with Remote ipc[0,1] via the matching link-id values.
Both sides share a single physical MBOX channel owned by the instance
that does not have ``notification-parent`` (link-id = <0> in this example).
Examples
********
.. code-block:: dts
/* Host side */
ipc0: ipc0 {
compatible = "nxp,ipc-rpmsg-lite";
memory-region = <&shm_ipc0>;
mboxes = <&mbox 2>, <&mbox 3>;
mbox-names = "tx", "rx";
link-id = <0>;
role = "host";
status = "okay";
};
ipc1: ipc1 {
compatible = "nxp,ipc-rpmsg-lite";
memory-region = <&shm_ipc1>;
notification-parent = <&ipc0>;
link-id = <1>;
role = "host";
status = "okay";
};
----
.. code-block:: dts
/* Remote side -- link-id values must match the host */
ipc0: ipc0 {
compatible = "nxp,ipc-rpmsg-lite";
memory-region = <&shm_ipc0>;
mboxes = <&mbox 3>, <&mbox 2>;
mbox-names = "tx", "rx";
link-id = <0>;
role = "remote";
status = "okay";
};
ipc1: ipc1 {
compatible = "nxp,ipc-rpmsg-lite";
memory-region = <&shm_ipc1>;
notification-parent = <&ipc0>;
link-id = <1>;
role = "remote";
status = "okay";
};
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
RPMSG-Lite role of this instance
This property is **required**.
Legal values: ``host``, ``remote``
* - ``link-id``
- ``int``
- .. code-block:: none
Link ID of this instance. Must match the corresponding instance on
the remote side. Allowed values: [0 .. (DT_NUM_INST_STATUS_OKAY() - 1)].
The instance with link-id = <0> must own the shared MBOX channel
(via ``mboxes`` / ``mbox-names``). All other instances must set
``notification-parent`` pointing to it.
This property is **required**.
* - ``memory-region``
- ``phandle``
- .. code-block:: none
phandle to the shared memory region for this link
This property is **required**.
* - ``notification-parent``
- ``phandle``
- .. code-block:: none
phandle to the sibling nxp,ipc-rpmsg-lite instance that owns the
shared MBOX notification channel (i.e., the instance with
link-id = <0>).
Set this property on every instance except the one that declares
``mboxes`` / ``mbox-names`` directly. The driver uses this to
avoid registering duplicate MBOX callbacks and to route all
notifications through a single physical channel.
* - ``priority``
- ``array``
- .. code-block:: none
Work-queue priority for the per-instance RX thread. This is an
array of [priority, type] where type is PRIO_COOP or PRIO_PREEMPT.
Examples:
priority = <1 PRIO_COOP>; /* K_PRIO_COOP(1) */
priority = <2 PRIO_PREEMPT>; /* K_PRIO_PREEMPT(2) */
Defaults to <0 PRIO_PREEMPT> when omitted.
* - ``buffer-size``
- ``int``
- .. code-block:: none
Total message buffer size in bytes (including the 16-byte
RPMSG-Lite header). The payload available to the application is
(buffer-size - 16) bytes.
Both host and remote must use the same value. Must be > 16 bytes.
Common values:
256 -> 240 bytes payload
512 -> 496 bytes payload (default)
1024 -> 1008 bytes payload
Default value: ``512``
* - ``buffer-count``
- ``int``
- .. code-block:: none
Number of TX/RX buffers for this link. Must be a power of 2.
Both host and remote must use the same value.
Default value: ``2``
.. 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,ipc-rpmsg-lite" compatible.
.. list-table::
:widths: 1 1 4
:header-rows: 1
* - Name
- Type
- Details
* - ``mboxes``
- ``phandle-array``
- .. code-block:: none
phandle to the MBOX controller channels used for inter-processor
notification. Provide exactly two entries: TX and RX.
Only the instance with link-id = <0> (the notification owner)
declares this property. All other instances use
``notification-parent`` instead.
* - ``mbox-names``
- ``string-array``
- .. code-block:: none
MBOX channel names. Must be "tx" and "rx", matching the order of
the ``mboxes`` entries.
* - ``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.
* - ``reg``
- ``array``
- .. code-block:: none
Information used to address the device. The value is specific to
the device (i.e. is different depending on the compatible
property).
The "reg" property is typically a sequence of (address, length) pairs.
Each pair is called a "register block". Values are
conventionally written in hex.
For details, see "2.3.6 reg" in Devicetree Specification v0.4.
See :ref:`zephyr:dt-important-props` for more information.
* - ``reg-names``
- ``string-array``
- .. code-block:: none
Optional names given to each register block in the "reg" property.
For example:
/ {
soc {
#address-cells = <1>;
#size-cells = <1>;
uart@1000 {
reg = <0x1000 0x2000>, <0x3000 0x4000>;
reg-names = "foo", "bar";
};
};
};
The uart@1000 node has two register blocks:
- one with base address 0x1000, size 0x2000, and name "foo"
- another with base address 0x3000, size 0x4000, and name "bar"
* - ``ranges``
- ``compound``
- .. code-block:: none
Information used to define a mapping (or translation) between the address
space of a bus (the "child address space") and the address space of the
bus node's parent (the "parent address space").
The "ranges" property is typically empty, or a sequence of triplets
(child bus address, parent bus address, length).
If the "ranges" property is empty, it specifies that the parent and child
address spaces are identical and no address translation is required.
If the "ranges" property is not present in a bus node, it is assumed that
no mapping exists between children of the node and the parent address space.
For details, see "2.3.8 ranges" in Devicetree Specification v0.4.
* - ``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 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 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.
* - ``dma-coherent``
- ``boolean``
- .. code-block:: none
Indicates that the device is capable of coherent DMA operations.
For details, see "2.3.10 dma-coherent" 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.
* - ``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.