michaelh/zephyr
1
0
Fork 0
Code Releases Activity

kernel: add cpu_idle functions to a doxy group

Browse source 
Added cpu_idle APIs to a doxygen group, otherwise there were missing
from the project documentation.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
This commit is contained in:
Anas Nashif 2019-01-22 08:18:13 -05:00
commit 30c3cff842
1 changed files with 11 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

13
include/kernel.h
View file

@ -4362,6 +4362,12 @@ extern void _handle_obj_poll_events(sys_dlist_t *events, u32_t state);
/** @} */
/**
* @defgroup cpu_idle_apis CPU Idling APIs
* @ingroup kernel_apis
* @{
*/
/**
* @brief Make the CPU idle.
*
@ -4373,7 +4379,7 @@ extern void _handle_obj_poll_events(sys_dlist_t *events, u32_t state);
* the only thread would be responsible for this if needed.
*
* @return N/A
* @req K-MISC-001
* @req K-CPU-IDLE-001
*/
extern void k_cpu_idle(void);
@ -4386,10 +4392,13 @@ extern void k_cpu_idle(void);
* @param key Interrupt locking key obtained from irq_lock().
*
* @return N/A
* @req K-MISC-002
* @req K-CPU-IDLE-002
*/
extern void k_cpu_atomic_idle(unsigned int key);
/**
* @}
*/
/**
* @internal