From c59d535678092c7c282c359fc8740af7e0a335cd Mon Sep 17 00:00:00 2001 From: Dmitrii Sharshakov Date: Sat, 2 Aug 2025 16:33:14 +0200 Subject: [PATCH] ipm: clarify `wait` parameter interpretation Wait acts as a boolean, make this clear to avoid implementations interpreting this as a duration to wait for. Signed-off-by: Dmitrii Sharshakov --- include/zephyr/drivers/ipm.h | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/include/zephyr/drivers/ipm.h b/include/zephyr/drivers/ipm.h index fe300921fb3c5..02c881e2c12b5 100644 --- a/include/zephyr/drivers/ipm.h +++ b/include/zephyr/drivers/ipm.h @@ -126,9 +126,10 @@ __subsystem struct ipm_driver_api { * data read back. * * @param ipmdev Driver instance - * @param wait If nonzero, busy-wait for remote to consume the message. The - * message is considered consumed once the remote interrupt handler - * finishes. If there is deferred processing on the remote side, + * @param wait If non-zero, busy-wait indefinitely for the remote to consume + * the message. The message is considered consumed + * once the remote interrupt handler finishes. + * If there is deferred processing on the remote side, * or you would like to queue outgoing messages and wait on an * event/semaphore, you can implement that in a high-level driver * @param id Message identifier. Values are constrained by