Skip to content

include: kernel: doc: improve slab API "isr-ok" documentation #96939

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+12 −0
Open

include: kernel: doc: improve slab API "isr-ok" documentation #96939

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions include/zephyr/kernel.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5664,6 +5664,8 @@ int k_mem_slab_alloc(struct k_mem_slab *slab, void **mem,
* This routine releases a previously allocated memory block back to its
* associated memory slab.
*
* @funcprops \isr_ok
*
* @param slab Address of the memory slab.
* @param mem Pointer to the memory block (as returned by k_mem_slab_alloc()).
*/
Expand All @@ -5675,6 +5677,8 @@ void k_mem_slab_free(struct k_mem_slab *slab, void *mem);
* This routine gets the number of memory blocks that are currently
* allocated in @a slab.
*
* @funcprops \isr_ok
*
* @param slab Address of the memory slab.
*
* @return Number of allocated memory blocks.
Expand All @@ -5690,6 +5694,8 @@ static inline uint32_t k_mem_slab_num_used_get(struct k_mem_slab *slab)
* This routine gets the maximum number of memory blocks that were
* allocated in @a slab.
*
* @funcprops \isr_ok
*
* @param slab Address of the memory slab.
*
* @return Maximum number of allocated memory blocks.
Expand All @@ -5710,6 +5716,8 @@ static inline uint32_t k_mem_slab_max_used_get(struct k_mem_slab *slab)
* This routine gets the number of memory blocks that are currently
* unallocated in @a slab.
*
* @funcprops \isr_ok
*
* @param slab Address of the memory slab.
*
* @return Number of unallocated memory blocks.
Expand All @@ -5724,6 +5732,8 @@ static inline uint32_t k_mem_slab_num_free_get(struct k_mem_slab *slab)
*
* This routine gets the runtime memory usage stats for the slab @a slab.
*
* @funcprops \isr_ok
*
* @param slab Address of the memory slab
* @param stats Pointer to memory into which to copy memory usage statistics
*
Expand All @@ -5739,6 +5749,8 @@ int k_mem_slab_runtime_stats_get(struct k_mem_slab *slab, struct sys_memory_stat
* This routine resets the maximum memory usage for the slab @a slab to its
* current usage.
*
* @funcprops \isr_ok
*
* @param slab Address of the memory slab
*
* @retval 0 Success
Expand Down