Skip to content

Commit ef60501

Browse files
dssengkartben
authored andcommitted
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 <[email protected]>
1 parent 5c5923c commit ef60501

File tree

1 file changed

+4
-3
lines changed
  • include/zephyr/drivers

1 file changed

+4
-3
lines changed

include/zephyr/drivers/ipm.h

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -126,9 +126,10 @@ __subsystem struct ipm_driver_api {
126126
* data read back.
127127
*
128128
* @param ipmdev Driver instance
129-
* @param wait If nonzero, busy-wait for remote to consume the message. The
130-
* message is considered consumed once the remote interrupt handler
131-
* finishes. If there is deferred processing on the remote side,
129+
* @param wait If non-zero, busy-wait indefinitely for the remote to consume
130+
* the message. The message is considered consumed
131+
* once the remote interrupt handler finishes.
132+
* If there is deferred processing on the remote side,
132133
* or you would like to queue outgoing messages and wait on an
133134
* event/semaphore, you can implement that in a high-level driver
134135
* @param id Message identifier. Values are constrained by

0 commit comments

Comments
 (0)