Registered User mNo edit summary |
Registered User (Merge articles) |
||
| Line 13: | Line 13: | ||
* A '''mailbox client''' that is in charge of the message to send or receive. | * A '''mailbox client''' that is in charge of the message to send or receive. | ||
<BR> | <BR> | ||
A general presentation of the mailbox framework is available in the Linux mailbox documentation <ref>{{CodeSource | Linux kernel | Documentation/mailbox. | A general presentation of the mailbox framework is available in the Linux mailbox documentation <ref name="Linux Mailbox documentation">{{CodeSource | Linux kernel | Documentation/driver-api/mailbox.rst | Linux Mailbox documentation}}</ref>. | ||
== System overview == | == System overview == | ||
| Line 27: | Line 27: | ||
:For example, the [[Linux RPMsg framework overview|RPMsg framework]] uses mailbox for the interprocessor communication. | :For example, the [[Linux RPMsg framework overview|RPMsg framework]] uses mailbox for the interprocessor communication. | ||
:In this case the mailbox client is the [[Linux remoteproc framework overview|remoteproc]] driver that forwards services from/to the RPMsg framework. | :In this case the mailbox client is the [[Linux remoteproc framework overview|remoteproc]] driver that forwards services from/to the RPMsg framework. | ||
=== API description === | === API description === | ||
The APIs are described in the | The APIs are described in the Mailbox client API <ref>{{CodeSource | Linux kernel | include/linux/mailbox_client.h | Mailbox client API}}</ref> | ||
== Configuration== | == Configuration== | ||
=== Kernel Configuration === | |||
Activate '''stm32 IPCC''' mailbox in kernel configuration using the Linux Menuconfig tool: [[Menuconfig or how to configure kernel]] | Activate '''stm32 IPCC''' mailbox in kernel configuration using the Linux Menuconfig tool: [[Menuconfig or how to configure kernel]] | ||
Device drivers ---> | Device drivers ---> | ||
| Line 38: | Line 38: | ||
<*> STM32 IPCC Mailbox | <*> STM32 IPCC Mailbox | ||
== Device tree configuration == | === Device tree configuration === | ||
Please refer to the [[IPCC_device_tree_configuration | IPCC device tree configuration]]. | |||
==How to use the framework== | |||
The Linux mailbox documentation <ref name="Linux Mailbox documentation">{{CodeSource | Linux kernel | Documentation/driver-api/mailbox.rst | Linux Mailbox documentation}}</ref> provides with a very simple example of use. | |||
{{ | |||
==How to trace and debug the framework== | ==How to trace and debug the framework== | ||
| Line 81: | Line 51: | ||
echo -n 'file mailbox.c +p' > /sys/kernel/debug/dynamic_debug/control | echo -n 'file mailbox.c +p' > /sys/kernel/debug/dynamic_debug/control | ||
=References= | *stm32-ipcc driver: {{CodeSource | Linux kernel | drivers/mailbox/stm32-ipcc.c}} | ||
<references/> | ==Source code location== | ||
*framework: {{CodeSource | Linux kernel | drivers/mailbox/mailbox.c}} | |||
*client interface: {{CodeSource | Linux kernel | include/linux/mailbox_client.h}} | |||
==References== | |||
<references /> | |||
<noinclude> | <noinclude> | ||
Revision as of 17:09, 24 November 2021
This article gives information about the Linux® mailbox framework. The mailbox framework is involved in interprocessor communication in heterogeneous multicore systems.
1. Framework purpose[edit | edit source]
The mailbox is used in interprocessor communication to exchange messages or signals between the host and the coprocessor cores. The mailbox framework is based on:
- A mailbox controller that is platform dependent:
- It is in charge of configuring and handling IRQ from the IPCC peripheral.
- It provides a generic API to the mailbox client.
- A mailbox client that is in charge of the message to send or receive.
A general presentation of the mailbox framework is available in the Linux mailbox documentation [1].
2. System overview[edit | edit source]
2.1. Component description[edit | edit source]
- Mailbox controller
- The mailbox controller is the stm32_ipcc. It configures and controls the IPCC peripheral
- Mailbox client
- The user can define his own mailbox client.
- For example, the RPMsg framework uses mailbox for the interprocessor communication.
- In this case the mailbox client is the remoteproc driver that forwards services from/to the RPMsg framework.
2.2. API description[edit | edit source]
The APIs are described in the Mailbox client API [2]
3. Configuration[edit | edit source]
3.1. Kernel Configuration[edit | edit source]
Activate stm32 IPCC mailbox in kernel configuration using the Linux Menuconfig tool: Menuconfig or how to configure kernel
Device drivers ---> -*- Mailbox Hardware Support ---> <*> STM32 IPCC Mailbox
3.2. Device tree configuration[edit | edit source]
Please refer to the IPCC device tree configuration.
4. How to use the framework[edit | edit source]
The Linux mailbox documentation [1] provides with a very simple example of use.
5. How to trace and debug the framework[edit | edit source]
5.1. How to trace[edit | edit source]
Dynamic debug traces can be added using the following commands:
echo -n 'file stm32-ipcc.c +p' > /sys/kernel/debug/dynamic_debug/control
echo -n 'file mailbox.c +p' > /sys/kernel/debug/dynamic_debug/control
- stm32-ipcc driver: drivers/mailbox/stm32-ipcc.c
6. Source code location[edit | edit source]
- framework: drivers/mailbox/mailbox.c
- client interface: include/linux/mailbox_client.h
7. References[edit | edit source]