From fadef43433e25c0bfea13598021cb6f95cb60f58 Mon Sep 17 00:00:00 2001 From: Katsuhiro Suzuki Date: Wed, 16 Dec 2020 11:22:13 +0900 Subject: [PATCH] kernel: describe detailed means of K_FP_REGS flag Current brief of the flag is ambiguous. This patch adds more details about K_FP_REGS flag. Signed-off-by: Katsuhiro Suzuki --- include/kernel.h | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/include/kernel.h b/include/kernel.h index 7b5af4a78bb..9dcd0a0b491 100644 --- a/include/kernel.h +++ b/include/kernel.h @@ -204,7 +204,13 @@ extern void k_thread_foreach_unlocked( #if defined(CONFIG_FPU_SHARING) /** - * @brief thread uses floating point registers + * @brief FPU registers are managed by context switch + * + * @details + * This option indicates that the thread uses the CPU's floating point + * registers. This instructs the kernel to take additional steps to save + * and restore the contents of these registers when scheduling the thread. + * No effect if @option{CONFIG_FPU_SHARING} is not enabled. */ #define K_FP_REGS (BIT(1)) #endif