Skip to content

Commit c123d98

Browse files
ljd42cfriedt
authored andcommitted
include: kernel: doc: improve slab API "isr-ok" documentation
As discussed on Discord, certain k_mem_slab* APIs are ISR-OK, but not marked as such. After APIs review, the following functions should be ISR-OK: - k_mem_slab_free - k_mem_slab_num_used_get - k_mem_slab_max_used_get - k_mem_slab_num_free_get - k_mem_slab_runtime_stats_get - k_mem_slab_runtime_stats_reset_max Added the Doxygen marker where needed. Signed-off-by: Loic Domaigne <[email protected]>
1 parent 0a7d6bc commit c123d98

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

include/zephyr/kernel.h

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5663,6 +5663,8 @@ int k_mem_slab_alloc(struct k_mem_slab *slab, void **mem,
56635663
* This routine releases a previously allocated memory block back to its
56645664
* associated memory slab.
56655665
*
5666+
* @funcprops \isr_ok
5667+
*
56665668
* @param slab Address of the memory slab.
56675669
* @param mem Pointer to the memory block (as returned by k_mem_slab_alloc()).
56685670
*/
@@ -5674,6 +5676,8 @@ void k_mem_slab_free(struct k_mem_slab *slab, void *mem);
56745676
* This routine gets the number of memory blocks that are currently
56755677
* allocated in @a slab.
56765678
*
5679+
* @funcprops \isr_ok
5680+
*
56775681
* @param slab Address of the memory slab.
56785682
*
56795683
* @return Number of allocated memory blocks.
@@ -5689,6 +5693,8 @@ static inline uint32_t k_mem_slab_num_used_get(struct k_mem_slab *slab)
56895693
* This routine gets the maximum number of memory blocks that were
56905694
* allocated in @a slab.
56915695
*
5696+
* @funcprops \isr_ok
5697+
*
56925698
* @param slab Address of the memory slab.
56935699
*
56945700
* @return Maximum number of allocated memory blocks.
@@ -5709,6 +5715,8 @@ static inline uint32_t k_mem_slab_max_used_get(struct k_mem_slab *slab)
57095715
* This routine gets the number of memory blocks that are currently
57105716
* unallocated in @a slab.
57115717
*
5718+
* @funcprops \isr_ok
5719+
*
57125720
* @param slab Address of the memory slab.
57135721
*
57145722
* @return Number of unallocated memory blocks.
@@ -5723,6 +5731,8 @@ static inline uint32_t k_mem_slab_num_free_get(struct k_mem_slab *slab)
57235731
*
57245732
* This routine gets the runtime memory usage stats for the slab @a slab.
57255733
*
5734+
* @funcprops \isr_ok
5735+
*
57265736
* @param slab Address of the memory slab
57275737
* @param stats Pointer to memory into which to copy memory usage statistics
57285738
*
@@ -5738,6 +5748,8 @@ int k_mem_slab_runtime_stats_get(struct k_mem_slab *slab, struct sys_memory_stat
57385748
* This routine resets the maximum memory usage for the slab @a slab to its
57395749
* current usage.
57405750
*
5751+
* @funcprops \isr_ok
5752+
*
57415753
* @param slab Address of the memory slab
57425754
*
57435755
* @retval 0 Success

0 commit comments

Comments
 (0)