add extra test and fix PICO_CONFIGs

Author: kilograham

src/rp2_common/pico_platform_panic/include/pico/platform/panic.h

@@ -13,16 +13,20 @@ extern "C" {
 
 // PICO_CONFIG: PICO_PANIC_FUNCTION, Name of a function to use in place of the stock panic function or empty string to simply breakpoint on panic, group=pico_runtime
 
-// PICO_CONFIG: PICO_PANIC_FUNCTION_WITH_CALL_STACK, Ensure the call stack is available when using a custom panic function via PICO_PANIC_FUNCTION=. When set to 1 it conflicts with PICO_PANIC_FUNCTION_WITH_ALL_VAARGS=1 as a stack fram is pushed onto the stack corrupting later vaargs. Note this defaults to 1 as most custom panic functions don't actually use the arguments and the call stack seems more useful in general, default=1group=pico_runtime
+// PICO_CONFIG: PICO_PANIC_FUNCTION_WITH_CALL_STACK, Ensure the call stack is available when using a custom panic function via PICO_PANIC_FUNCTION=. When set to 1 it conflicts with PICO_PANIC_FUNCTION_WITH_ALL_VAARGS=1 as a stack fram is pushed onto the stack corrupting later vaargs. Note this defaults to 1 as most custom panic functions don't actually use the arguments and the call stack seems more useful in general, default=1, group=pico_runtime
 #ifndef PICO_PANIC_FUNCTION_WITH_CALL_STACK
 #define PICO_PANIC_FUNCTION_WITH_CALL_STACK 1
 #endif
 
-// PICO_CONFIG: PICO_PANIC_FUNCTION_WITH_ALL_VAARGS, Ensures that all vaargs are faithfully passed to the custom panic function via PICO_PANIC_FUNCTION=. When set to 1 it conflicts with PICO_PANIC_FUNCTION_WITH_CALL_STACK=1 because both the later vaargs and the stack frame would be expected at the top of the stack. Note this defaults to 0 as most custom panic functions don't actually use the arguments and the call stack seems more useful in general, default=1group=pico_runtime
+// PICO_CONFIG: PICO_PANIC_FUNCTION_WITH_ALL_VAARGS, Ensures that all vaargs are faithfully passed to the custom panic function via PICO_PANIC_FUNCTION=. When set to 1 it conflicts with PICO_PANIC_FUNCTION_WITH_CALL_STACK=1 because both the later vaargs and the stack frame would be expected at the top of the stack. Note this defaults to 0 as most custom panic functions don't actually use the arguments and the call stack seems more useful in general, default=0, group=pico_runtime
 #ifndef PICO_PANIC_FUNCTION_WITH_ALL_VAARGS
 #define PICO_PANIC_FUNCTION_WITH_ALL_VAARGS 0
 #endif
 
+// PICO_CONFIG: PICO_PANIC_FUNCTION_DOES_NOT_RETURN, Indicate that the user supplied PICO_PANIC_FUNCTION= does not return so the caller does not need to inject a breakpoint. When this is 1 both full call stacks are available and all vaargs are correctly passed to the user function, default=-0 group=pico_runtime
+#ifndef PICO_PANIC_FUNCTION_WITH_ALL_VAARGS
+#define PICO_PANIC_FUNCTION_WITH_ALL_VAARGS 0
+#endif
 
 #ifndef __ASSEMBLER__
 /*! \brief Panics with the message "Unsupported"

test/panic_function_test/CMakeLists.txt

@@ -16,3 +16,11 @@ add_executable(panic_function_test_user_all_vaargs ${CMAKE_CURRENT_LIST_DIR}/pan
 target_compile_definitions(panic_function_test_user_all_vaargs PRIVATE PICO_PANIC_FUNCTION=handle_panic PICO_PANIC_FUNCTION_WITH_ALL_VAARGS=1 PICO_PANIC_FUNCTION_WITH_CALL_STACK=0)
 target_link_libraries(panic_function_test_user_all_vaargs PRIVATE pico_stdlib)
 pico_add_extra_outputs(panic_function_test_user_all_vaargs)
+
+add_executable(panic_function_test_user_not_returning ${CMAKE_CURRENT_LIST_DIR}/panic_function_test.c)
+target_compile_definitions(panic_function_test_user_not_returning PRIVATE PICO_PANIC_FUNCTION=handle_panic
+        PICO_PANIC_FUNCTION_DOES_NOT_RETURN=1
+        PICO_PANIC_FUNCTION_WITH_ALL_VAARGS=1 PICO_PANIC_FUNCTION_WITH_CALL_STACK=1 #these usually conflicting options are now fine
+)
+target_link_libraries(panic_function_test_user_not_returning PRIVATE pico_stdlib)
+pico_add_extra_outputs(panic_function_test_user_not_returning)

test/panic_function_test/panic_function_test.c

@@ -58,6 +58,9 @@ void __printflike(1, 0) handle_panic(const char *magic1, ...)
 #endif
     va_end(args);
     puts("PASSED");
+#if PICO_PANIC_FUNCTION_DOES_NOT_RETURN
+    __breakpoint();
+#endif
 }
 
 void main() {