michaelh/zephyr
1
0
Fork 0
Code Releases Activity
zephyr/doc/hardware/peripherals/mbox.rst

19 lines
471 B
ReStructuredText
Raw Permalink Normal View History

drivers: mbox: Introduce MBOX driver class One limitation of the current IPM API is that it is assuming that the hardware is only exporting one single channel through which the data can be sent or signalling can happen. If the hardware supports multiple channels, the IPM device must be instantiated (possibly in the DT) several times, one for each channel to be able to send data through multiple channels using the same hw peripheral. Also in the current IPM API only one callback can be registered, that means that only one driver is controlling all the signalling happening on all the channels. This patch is introducing a new MBOX API that is supporting multi-channel signalling and data exachange leveraging and extending the previous (and outdated) IPM API. Signed-off-by: Carlo Caione <ccaione@baylibre.com>
2021-10-15 11:55:56 +02:00
.. _mbox_api:
doc: peripherals: unify title strings Unify the peripheral documentation title strings to the format "<class> [(acronym)] [Bus]". Including both the full name of the peripheral class and an acronym makes the documentation more user friendly as some of the acronyms are less well-known than others. Signed-off-by: Henrik Brix Andersen <hebad@vestas.com>
2023-03-28 16:10:21 +02:00
Multi-Channel Inter-Processor Mailbox (MBOX)
############################################
drivers: mbox: Introduce MBOX driver class One limitation of the current IPM API is that it is assuming that the hardware is only exporting one single channel through which the data can be sent or signalling can happen. If the hardware supports multiple channels, the IPM device must be instantiated (possibly in the DT) several times, one for each channel to be able to send data through multiple channels using the same hw peripheral. Also in the current IPM API only one callback can be registered, that means that only one driver is controlling all the signalling happening on all the channels. This patch is introducing a new MBOX API that is supporting multi-channel signalling and data exachange leveraging and extending the previous (and outdated) IPM API. Signed-off-by: Carlo Caione <ccaione@baylibre.com>
2021-10-15 11:55:56 +02:00
Overview
********
An MBOX device is a peripheral capable of passing signals (and data depending
on the peripheral) between CPUs and clusters in the system. Each MBOX instance
is providing one or more channels, each one targeting one other CPU cluster
(multiple channels can target the same cluster).
API Reference
*************
.. doxygengroup:: mbox_interface
Copy permalink