zephyr/doc/hardware/peripherals/mbox.rst
Henrik Brix Andersen 0ae32479b7 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-29 09:48:13 +00:00

19 lines
471 B
ReStructuredText

.. _mbox_api:
Multi-Channel Inter-Processor Mailbox (MBOX)
############################################
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