michaelh/zephyr
1
0
Fork 0
Code Releases Activity

mbox: Enforce callback registration before enabling the channel

Browse source 
Specify in the API that the callback must be registered before the
channel is enabled, fix the NRFX IPC driver to be compliant and change
the MBOX sample.

Signed-off-by: Carlo Caione <ccaione@baylibre.com>
This commit is contained in:
Carlo Caione 2021-12-03 14:53:40 +01:00 • committed by Carles Cufí
commit 67ef1df950
4 changed files with 30 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

16
include/drivers/mbox.h
View file

@ -405,7 +405,21 @@ static inline int z_impl_mbox_mtu_get(const struct device *dev)
}
/**
* @brief Enable interrupts and callbacks for inbound channels.
* @brief Enable (disable) interrupts and callbacks for inbound channels.
*
* Enable interrupt for the channel when the parameter 'enable' is set to true.
* Disable it otherwise.
*
* Immediately after calling this function with 'enable' set to true, the
* channel is considered enabled and ready to receive signal and messages (even
* already pending), so the user must take care of installing a proper callback
* (if needed) using @a mbox_register_callback() on the channel before enabling
* it. For this reason it is recommended that all the channels are disabled at
* probe time.
*
* Enabling a channel for which there is no installed callback is considered
* undefined behavior (in general the driver must take care of gracefully
* handling spurious interrupts with no installed callback).
*
* @param channel Channel instance pointer.
* @param enable Set to 0 to disable and to nonzero to enable.