zephyr,ipc-icmsg

Note

An implementation of a driver matching this compatible is available in subsys/ipc/ipc_service/backends/ipc_icmsg.c.

Description

Inter core messaging backend

Properties

Properties not inherited from the base binding file.

Name

Type

Details

tx-region

phandle

phandle to the shared memory region used for data transmission

This property is required.

rx-region

phandle

phandle to the shared memory region used for data reception

This property is required.

dcache-alignment

int

Data cache alignment. If any side of the communication uses cache on
rx-region/tx-region this property must be the biggest value of the
invalidation or the write-back size for both sides of the communication.
If no side of the communication uses data cache this property could be
safely omitted.
For example:
  Side A: no data cache
  Side B: 32 Bytes write-back size, 16 Bytes invalidation size
  dcache-alignment = <32>; for both

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-icmsg” compatible.

Name	Type	Details
`mboxes`	`phandle-array`	phandle to the MBOX controller (TX and RX are required) This property is required.
`mbox-names`	`string-array`	MBOX channel names (must be called "tx" and "rx") This property is required.
`status`	`string`	indicates the operational status of a device Legal values: `'ok'`, `'okay'`, `'disabled'`, `'reserved'`, `'fail'`, `'fail-sss'` See Important properties for more information.
`compatible`	`string-array`	compatible strings This property is required. See Important properties for more information.
`reg`	`array`	register space See Important properties for more information.
`reg-names`	`string-array`	name of each register space
`interrupts`	`array`	interrupts for device See Important properties for more information.
`interrupts-extended`	`compound`	extended interrupt specifier for device
`interrupt-names`	`string-array`	name of each interrupt
`interrupt-parent`	`phandle`	phandle to interrupt controller node
`label`	`string`	Human readable string describing the device (used as device_get_binding() argument) See Important properties for more information. This property is deprecated.
`clocks`	`phandle-array`	Clock gate information
`clock-names`	`string-array`	name of each clock
`#address-cells`	`int`	number of address cells in reg property
`#size-cells`	`int`	number of size cells in reg property
`dmas`	`phandle-array`	DMA channels specifiers
`dma-names`	`string-array`	Provided names of DMA channel specifiers
`io-channels`	`phandle-array`	IO channels specifiers
`io-channel-names`	`string-array`	Provided names of IO channel specifiers
`power-domains`	`phandle-array`	Power domain specifiers
`power-domain-names`	`string-array`	Provided names of power domain specifiers
`#power-domain-cells`	`int`	Number of cells in power-domains property
`zephyr,deferred-init`	`boolean`	Do not initialize device automatically on boot. Device should be manually initialized using device_init().
`wakeup-source`	`boolean`	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`	Automatically configure the device for runtime power management after the init function runs.
`zephyr,disabling-power-states`	`phandles`	List of power states that will disable this device power.