michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: kernel: mark k_event apis as being ISR safe

Browse source 
Most of the k_event APIs are ISR-safe, with the exception of

* k_event_init() - object should be initialized before ISR context
* k_event_wait(), k_event_wait_all() - only ISR safe with K_NO_WAIT

The last two functions already check for K_NO_WAIT when in ISR context
so this is very much just updating documentation to reflect the
current state.

Signed-off-by: Chris Friedt <cfriedt@tenstorrent.com>
This commit is contained in:
Chris Friedt 2025-04-28 13:44:25 -04:00 • committed by Benjamin Cabé
commit 0cac1849ca
1 changed files with 16 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

16
include/zephyr/kernel.h
View file

@ -2392,6 +2392,8 @@ __syscall void k_event_init(struct k_event *event);
* Posting differs from setting in that posted events are merged together with
* the current set of events tracked by the event object.
*
* @funcprops \isr_ok
*
* @param event Address of the event object
* @param events Set of events to post to @a event
*
@ -2409,6 +2411,8 @@ __syscall uint32_t k_event_post(struct k_event *event, uint32_t events);
* Setting differs from posting in that set events replace the current set of
* events tracked by the event object.
*
* @funcprops \isr_ok
*
* @param event Address of the event object
* @param events Set of events to set in @a event
*
@ -2424,6 +2428,8 @@ __syscall uint32_t k_event_set(struct k_event *event, uint32_t events);
* become met by this immediately unpend. Unlike @ref k_event_set, this routine
* allows specific event bits to be set and cleared as determined by the mask.
*
* @funcprops \isr_ok
*
* @param event Address of the event object
* @param events Set of events to set/clear in @a event
* @param events_mask Mask to be applied to @a events
@ -2438,6 +2444,8 @@ __syscall uint32_t k_event_set_masked(struct k_event *event, uint32_t events,
*
* This routine clears (resets) the specified events stored in an event object.
*
* @funcprops \isr_ok
*
* @param event Address of the event object
* @param events Set of events to clear in @a event
*
@ -2456,6 +2464,9 @@ __syscall uint32_t k_event_clear(struct k_event *event, uint32_t events);
* @note The caller must be careful when resetting if there are multiple threads
* waiting for the event object @a event.
*
* @note This function may be called from ISR context only when @a timeout is
* set to K_NO_WAIT.
*
* @param event Address of the event object
* @param events Set of desired events on which to wait
* @param reset If true, clear the set of events tracked by the event object
@ -2480,6 +2491,9 @@ __syscall uint32_t k_event_wait(struct k_event *event, uint32_t events,
* @note The caller must be careful when resetting if there are multiple threads
* waiting for the event object @a event.
*
* @note This function may be called from ISR context only when @a timeout is
* set to K_NO_WAIT.
*
* @param event Address of the event object
* @param events Set of desired events on which to wait
* @param reset If true, clear the set of events tracked by the event object
@ -2496,6 +2510,8 @@ __syscall uint32_t k_event_wait_all(struct k_event *event, uint32_t events,
/**
* @brief Test the events currently tracked in the event object
*
* @funcprops \isr_ok
*
* @param event Address of the event object
* @param events_mask Set of desired events to test
*