From 2b6eda4b7163ffd8bda48dd18b473eb66700b6a9 Mon Sep 17 00:00:00 2001 From: Carl Hamilton Date: Fri, 15 May 2026 14:43:30 -0700 Subject: [PATCH 1/2] Flesh out board configuration include guards Added "_CONFIG" to the include guards for the board configuration headers. This will help avoid collisions and confusion with other, similarly named headers. --- include/board_debug_probe_config.h | 4 ++-- include/board_example_config.h | 4 ++-- include/board_pico_config.h | 4 ++-- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/include/board_debug_probe_config.h b/include/board_debug_probe_config.h index 3e7fc353c..244b500fb 100644 --- a/include/board_debug_probe_config.h +++ b/include/board_debug_probe_config.h @@ -23,8 +23,8 @@ * */ -#ifndef BOARD_DEBUG_PROBE_H_ -#define BOARD_DEBUG_PROBE_H_ +#ifndef BOARD_DEBUG_PROBE_CONFIG_H_ +#define BOARD_DEBUG_PROBE_CONFIG_H_ #define PROBE_IO_SWDI #define PROBE_CDC_UART diff --git a/include/board_example_config.h b/include/board_example_config.h index 0e0f13130..2c731d8b1 100644 --- a/include/board_example_config.h +++ b/include/board_example_config.h @@ -23,8 +23,8 @@ * */ -#ifndef BOARD_EXAMPLE_H_ -#define BOARD_EXAMPLE_H_ +#ifndef BOARD_EXAMPLE_CONFIG_H_ +#define BOARD_EXAMPLE_CONFIG_H_ #error "Example board configuration requested - specify PICO_BOARD and re-run CMake." /* Select one of these. */ diff --git a/include/board_pico_config.h b/include/board_pico_config.h index dd22f0a74..f732fb707 100644 --- a/include/board_pico_config.h +++ b/include/board_pico_config.h @@ -23,8 +23,8 @@ * */ -#ifndef BOARD_PICO_H_ -#define BOARD_PICO_H_ +#ifndef BOARD_PICO_CONFIG_H_ +#define BOARD_PICO_CONFIG_H_ #define PROBE_IO_RAW #define PROBE_CDC_UART From 201c28d7fb2d2c3ede492e2a78ff9e273a6d74dc Mon Sep 17 00:00:00 2001 From: Carl Hamilton Date: Fri, 15 May 2026 16:07:18 -0700 Subject: [PATCH 2/2] Move board configuration logic to dedicated header The small amount of logic to select and configure the target board has moved to a new, dedicated header: board_config.h. This will allow future changes to board selection and configuration to be more easily isolated and prevent probe_config.h from being polluted by board-related shenanigans. --- include/board_config.h | 38 ++++++++++++++++++++++++++++++++++++++ src/probe_config.h | 9 +-------- 2 files changed, 39 insertions(+), 8 deletions(-) create mode 100644 include/board_config.h diff --git a/include/board_config.h b/include/board_config.h new file mode 100644 index 000000000..825552146 --- /dev/null +++ b/include/board_config.h @@ -0,0 +1,38 @@ +/* + * The MIT License (MIT) + * + * Copyright (c) 2023 Raspberry Pi (Trading) Ltd. + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in + * all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN + * THE SOFTWARE. + * + */ + +#ifndef BOARD_CONFIG_H_ +#define BOARD_CONFIG_H_ + +// TODO tie this up with PICO_BOARD defines in the main SDK + +#ifdef DEBUG_ON_PICO +#include "board_pico_config.h" +#else +#include "board_debug_probe_config.h" +#endif +//#include "board_example_config.h" + +#endif diff --git a/src/probe_config.h b/src/probe_config.h index 5c5e14909..ff12f0413 100644 --- a/src/probe_config.h +++ b/src/probe_config.h @@ -63,14 +63,7 @@ do { \ #define probe_dump(format,...) ((void)0) #endif -// TODO tie this up with PICO_BOARD defines in the main SDK - -#ifdef DEBUG_ON_PICO -#include "board_pico_config.h" -#else -#include "board_debug_probe_config.h" -#endif -//#include "board_example_config.h" +#include "board_config.h" // Add the configuration to binary information void bi_decl_config();