Skip to content

Commit 482a150

Browse files
dcpleungcfriedt
authored andcommitted
kernel: add public API doc for K_SSE_REGS
This adds public API documentation for the thread bit K_SSE_REGS. It was previously a single line comment. Signed-off-by: Daniel Leung <[email protected]>
1 parent d8f9cc6 commit 482a150

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

include/kernel.h

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -214,7 +214,15 @@ extern void k_thread_foreach_unlocked(
214214
/* x86 Bitmask definitions for threads user options */
215215

216216
#if defined(CONFIG_FPU_SHARING) && defined(CONFIG_X86_SSE)
217-
/* thread uses SSEx (and also FP) registers */
217+
/**
218+
* @brief FP and SSE registers are managed by context switch on x86
219+
*
220+
* @details
221+
* This option indicates that the thread uses the x86 CPU's floating point
222+
* and SSE registers. This instructs the kernel to take additional steps to
223+
* save and restore the contents of these registers when scheduling
224+
* the thread. No effect if @kconfig{CONFIG_X86_SSE} is not enabled.
225+
*/
218226
#define K_SSE_REGS (BIT(7))
219227
#endif
220228
#endif

0 commit comments

Comments
 (0)