From e5f841c1832c849c4b910ebab4093bc0b9209d37 Mon Sep 17 00:00:00 2001 From: Anas Nashif Date: Mon, 21 Apr 2025 07:46:13 -0400 Subject: [PATCH] tests: kernel/arch: various doxygen fixes Group test using doxygen and other doxygen fixups. Signed-off-by: Anas Nashif --- .../src/arm_custom_interrupt.c | 2 +- .../arm/arm_interrupt/src/arm_interrupt.c | 21 +++++++++++++++---- .../src/arm_dynamic_direct_interrupts.c | 7 ++++--- .../src/arm_irq_target_state.c | 7 ++++--- .../src/arm_zero_latency_irqs.c | 8 +++---- .../src/arm_sw_vector_relay.c | 10 ++++++--- .../arm/arm_thread_swap/src/arm_syscalls.c | 8 +++---- .../arm/arm_thread_swap/src/arm_thread_arch.c | 7 ++++--- tests/arch/common/ramfunc/src/ramfunc.c | 3 --- tests/kernel/common/src/irq_offload.c | 2 +- .../mem_protect/mem_protect/src/mem_domain.c | 2 +- tests/tests.dox | 10 +++++++++ 12 files changed, 57 insertions(+), 30 deletions(-) diff --git a/tests/arch/arm/arm_custom_interrupt/src/arm_custom_interrupt.c b/tests/arch/arm/arm_custom_interrupt/src/arm_custom_interrupt.c index 97d3c55365d..998fe9a2957 100644 --- a/tests/arch/arm/arm_custom_interrupt/src/arm_custom_interrupt.c +++ b/tests/arch/arm/arm_custom_interrupt/src/arm_custom_interrupt.c @@ -120,7 +120,7 @@ void arm_isr_handler(const void *args) * @{ */ -ZTEST(arm_custom_interrupt, test_arm_interrupt) +ZTEST(arm_custom_interrupt, test_arm_custom_interrupt) { zassert_true(custom_init_called, "Custom IRQ init not called\n"); diff --git a/tests/arch/arm/arm_interrupt/src/arm_interrupt.c b/tests/arch/arm/arm_interrupt/src/arm_interrupt.c index dce39ede938..05535283be3 100644 --- a/tests/arch/arm/arm_interrupt/src/arm_interrupt.c +++ b/tests/arch/arm/arm_interrupt/src/arm_interrupt.c @@ -142,6 +142,10 @@ void set_regs_with_known_pattern(void *p1, void *p2, void *p3) "udf #90\n"); } +/** + * @brief Test to verify code fault handling in ISR execution context + * @ingroup kernel_fatal_tests + */ ZTEST(arm_interrupt, test_arm_esf_collection) { int test_validation_rv; @@ -222,6 +226,10 @@ void arm_isr_handler(const void *args) } } +/** + * @brief Test ARM Interrupt handling + * @ingroup kernel_arch_interrupt_tests + */ ZTEST(arm_interrupt, test_arm_interrupt) { /* Determine an NVIC IRQ line that is not currently in use. */ @@ -390,6 +398,10 @@ static inline void z_vrfy_test_arm_user_interrupt_syscall(void) } #include +/** + * @brief Test ARM Interrupt handling in user mode + * @ingroup kernel_arch_interrupt_tests + */ ZTEST_USER(arm_interrupt, test_arm_user_interrupt) { /* Test thread executing in user mode */ @@ -434,6 +446,11 @@ ZTEST_USER(arm_interrupt, test_arm_user_interrupt) #pragma GCC push_options #pragma GCC optimize("O0") /* Avoid compiler optimizing null pointer de-referencing. */ + +/** + * @brief Test ARM Null Pointer Exception handling + * @ingroup kernel_arch_interrupt_tests + */ ZTEST(arm_interrupt, test_arm_null_pointer_exception) { Z_TEST_SKIP_IFNDEF(CONFIG_CORTEX_M_NULL_POINTER_EXCEPTION); @@ -454,7 +471,3 @@ ZTEST(arm_interrupt, test_arm_null_pointer_exception) zassert_equal(reason, -1, "expected_reason has not been reset (%d)\n", reason); } #pragma GCC pop_options - -/** - * @} - */ diff --git a/tests/arch/arm/arm_irq_advanced_features/src/arm_dynamic_direct_interrupts.c b/tests/arch/arm/arm_irq_advanced_features/src/arm_dynamic_direct_interrupts.c index ce5043d882f..22634a19021 100644 --- a/tests/arch/arm/arm_irq_advanced_features/src/arm_dynamic_direct_interrupts.c +++ b/tests/arch/arm/arm_irq_advanced_features/src/arm_dynamic_direct_interrupts.c @@ -28,6 +28,10 @@ void arm_direct_isr_handler_1(const void *args) test_flag = 2; } +/** + * @brief Test the ARM Dynamic Direct Interrupts functionality. + * @ingroup kernel_arch_interrupt_tests + */ ZTEST(arm_irq_advanced_features, test_arm_dynamic_direct_interrupts) { int post_flag = 0; @@ -81,6 +85,3 @@ ZTEST(arm_irq_advanced_features, test_arm_dynamic_direct_interrupts) post_flag = test_flag; zassert_true(post_flag == 2, "Test flag not set by ISR1\n"); } -/** - * @} - */ diff --git a/tests/arch/arm/arm_irq_advanced_features/src/arm_irq_target_state.c b/tests/arch/arm/arm_irq_advanced_features/src/arm_irq_target_state.c index f1d005b47c5..47f5cc03bdc 100644 --- a/tests/arch/arm/arm_irq_advanced_features/src/arm_irq_target_state.c +++ b/tests/arch/arm/arm_irq_advanced_features/src/arm_irq_target_state.c @@ -13,6 +13,10 @@ extern irq_target_state_t irq_target_state_set(unsigned int irq, irq_target_state_t target_state); extern int irq_target_state_is_secure(unsigned int irq); +/** + * @brief Test the ARM IRQ target state functionality. + * @ingroup kernel_arch_interrupt_tests + */ ZTEST(arm_irq_advanced_features, test_arm_irq_target_state) { /* Determine an NVIC IRQ line that is implemented @@ -82,6 +86,3 @@ ZTEST(arm_irq_advanced_features, test_arm_irq_target_state) TC_PRINT("Skipped (TrustZone-M-enabled Cortex-M Mainline only)\n"); } #endif /* CONFIG_ZERO_LATENCY_IRQS */ -/** - * @} - */ diff --git a/tests/arch/arm/arm_irq_advanced_features/src/arm_zero_latency_irqs.c b/tests/arch/arm/arm_irq_advanced_features/src/arm_zero_latency_irqs.c index c3e8b5f574e..ca23716f17e 100644 --- a/tests/arch/arm/arm_irq_advanced_features/src/arm_zero_latency_irqs.c +++ b/tests/arch/arm/arm_irq_advanced_features/src/arm_zero_latency_irqs.c @@ -18,6 +18,10 @@ void arm_zero_latency_isr_handler(const void *args) test_flag = 1; } +/** + * @brief Test ARM Zero latency Interrupt functionality. + * @ingroup kernel_arch_interrupt_tests + */ ZTEST(arm_irq_advanced_features, test_arm_zero_latency_irqs) { @@ -101,7 +105,3 @@ ZTEST(arm_irq_advanced_features, test_arm_zero_latency_irqs) irq_unlock(key); } - -/** - * @} - */ diff --git a/tests/arch/arm/arm_sw_vector_relay/src/arm_sw_vector_relay.c b/tests/arch/arm/arm_sw_vector_relay/src/arm_sw_vector_relay.c index 8f5728abee0..506febcdb44 100644 --- a/tests/arch/arm/arm_sw_vector_relay/src/arm_sw_vector_relay.c +++ b/tests/arch/arm/arm_sw_vector_relay/src/arm_sw_vector_relay.c @@ -15,6 +15,13 @@ extern uint32_t _vector_table; extern uint32_t __vector_relay_handler; extern uint32_t _vector_table_pointer; + +/** + * @brief Test the ARM Software Vector Relay functionality. + * + * This test verifies the correctness of the ARM software vector relay mechanism. + * @ingroup kernel_arch_interrupt_tests + */ ZTEST(arm_sw_vector_relay, test_arm_sw_vector_relay) { uint32_t vector_relay_table_addr = (uint32_t)&__vector_relay_table; @@ -61,6 +68,3 @@ ZTEST(arm_sw_vector_relay, test_arm_sw_vector_relay) _vector_table_pointer, _vector_start); #endif } -/** - * @} - */ diff --git a/tests/arch/arm/arm_thread_swap/src/arm_syscalls.c b/tests/arch/arm/arm_thread_swap/src/arm_syscalls.c index 42a25f7dc28..4d55241bed7 100644 --- a/tests/arch/arm/arm_thread_swap/src/arm_syscalls.c +++ b/tests/arch/arm/arm_thread_swap/src/arm_syscalls.c @@ -143,7 +143,10 @@ static void user_thread_entry(void *p1, void *p2, void *p3) barrier_isync_fence_full(); #endif } - +/** + * @brief Test ARM thread swap mechanism + * @ingroup kernel_arch_sched_tests + */ ZTEST(arm_thread_swap, test_arm_syscalls) { int i = 0; @@ -288,6 +291,3 @@ ZTEST(arm_thread_swap, test_arm_syscalls) } #endif /* CONFIG_USERSPACE */ -/** - * @} - */ diff --git a/tests/arch/arm/arm_thread_swap/src/arm_thread_arch.c b/tests/arch/arm/arm_thread_swap/src/arm_thread_arch.c index 7572982a775..a29b76fc5a2 100644 --- a/tests/arch/arm/arm_thread_swap/src/arm_thread_arch.c +++ b/tests/arch/arm/arm_thread_swap/src/arm_thread_arch.c @@ -370,6 +370,10 @@ static int __noinline arch_swap_wrapper(void) } #endif +/** + * @brief Test the ARM thread swap mechanism + * @ingroup kernel_arch_sched_tests + */ ZTEST(arm_thread_swap, test_arm_thread_swap) { int test_flag; @@ -662,6 +666,3 @@ ZTEST(arm_thread_swap, test_arm_thread_swap) #endif #endif /* CONFIG_FPU && CONFIG_FPU_SHARING */ } -/** - * @} - */ diff --git a/tests/arch/common/ramfunc/src/ramfunc.c b/tests/arch/common/ramfunc/src/ramfunc.c index cd55c653618..f76c511687d 100644 --- a/tests/arch/common/ramfunc/src/ramfunc.c +++ b/tests/arch/common/ramfunc/src/ramfunc.c @@ -53,6 +53,3 @@ ZTEST(ramfunc, test_ramfunc) zassert_true(post_flag == 1, "ram_function() execution failed."); } -/** - * @} - */ diff --git a/tests/kernel/common/src/irq_offload.c b/tests/kernel/common/src/irq_offload.c index 89815f70eb0..3526aa81b84 100644 --- a/tests/kernel/common/src/irq_offload.c +++ b/tests/kernel/common/src/irq_offload.c @@ -140,7 +140,7 @@ ZTEST(common_1cpu, test_nested_irq_offload) k_thread_abort(&offload_thread); } /** - * + * @} */ extern void *common_setup(void); ZTEST_SUITE(irq_offload, NULL, common_setup, NULL, NULL, NULL); diff --git a/tests/kernel/mem_protect/mem_protect/src/mem_domain.c b/tests/kernel/mem_protect/mem_protect/src/mem_domain.c index 4ea5ad7ed1b..1d74cea29d2 100644 --- a/tests/kernel/mem_protect/mem_protect/src/mem_domain.c +++ b/tests/kernel/mem_protect/mem_protect/src/mem_domain.c @@ -176,7 +176,7 @@ ZTEST(mem_protect_domain, test_mem_domain_invalid_access) /** * @brief Show that a read-only partition can't be written to * - * @ingroup kernel_memgroup_tests + * @ingroup kernel_memprotect_tests */ ZTEST(mem_protect_domain, test_mem_domain_no_writes_to_ro) { diff --git a/tests/tests.dox b/tests/tests.dox index e0d7201f0ca..3f525c9d938 100644 --- a/tests/tests.dox +++ b/tests/tests.dox @@ -10,6 +10,16 @@ @{ @} +@defgroup kernel_arch_sched_tests Architecture Context Switching / Swap +@ingroup all_tests +@{ +@} + +@defgroup kernel_arch_interrupt_tests Architecture Interrupt Handling +@ingroup all_tests +@{ +@} + @defgroup kernel_memprotect_tests Memory Protection @ingroup all_tests @{