Add support for configuring examples individually

This adds the ability to configure examples individually, so you can either build all of pico examples, or you can just cd into a single example and build that.
raspberrypi · Feb 4, 2025 · e04bf4f · e04bf4f
1 parent abcd62a
commit e04bf4f
Show file tree

Hide file tree

Showing 132 changed files with 1,111 additions and 44 deletions.
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -1,10 +1,19 @@
 cmake_minimum_required(VERSION 3.12)
 
-# Pull in SDK (must be before project)
-include(pico_sdk_import.cmake)
-include(pico_extras_import_optional.cmake)
+if (NOT CMAKE_PROJECT_NAME)
+    # Pull in SDK (must be before project)
+    include(${CMAKE_CURRENT_LIST_DIR}/pico_sdk_import.cmake)
+    include(${CMAKE_CURRENT_LIST_DIR}/pico_extras_import_optional.cmake)
 
-project(pico_examples C CXX ASM)
+    pico_is_top_level_project(PICO_EXAMPLES_TOP_LEVEL_PROJECT)
+
+    if (PICO_EXAMPLES_TOP_LEVEL_PROJECT)
+        project(pico_examples C CXX ASM)
+    else()
+        # Go back to individual example for project
+        return()
+    endif()
+endif()
 
 set(CMAKE_C_STANDARD 11)
 set(CMAKE_CXX_STANDARD 17)
@@ -13,7 +22,7 @@ if (PICO_SDK_VERSION_STRING VERSION_LESS "2.1.0")
     message(FATAL_ERROR "Raspberry Pi Pico SDK version 2.1.0 (or later) required. Your version is ${PICO_SDK_VERSION_STRING}")
 endif()
 
-set(PICO_EXAMPLES_PATH ${PROJECT_SOURCE_DIR})
+set(PICO_EXAMPLES_PATH ${CMAKE_CURRENT_LIST_DIR})
 
 # If you want debug output from USB (pass -DPICO_STDIO_USB=1) this ensures you don't lose any debug output while USB is set up
 if (NOT DEFINED PICO_STDIO_USB_CONNECT_WAIT_TIMEOUT_MS)
@@ -23,7 +32,7 @@ endif()
 # Initialize the SDK
 pico_sdk_init()
 
-include(example_auto_set_url.cmake)
+include(${CMAKE_CURRENT_LIST_DIR}/example_auto_set_url.cmake)
 
 function(add_subdirectory_exclude_platforms NAME)
     if (ARGN)
@@ -42,13 +51,6 @@ function(add_subdirectory_exclude_platforms NAME)
     add_subdirectory(${NAME})
 endfunction()
 
-# Add blink example
-add_subdirectory_exclude_platforms(blink)
-add_subdirectory_exclude_platforms(blink_simple)
-
-# Add hello world example
-add_subdirectory_exclude_platforms(hello_world)
-
 add_compile_options(-Wall
         -Wno-format          # int != int32_t as far as the compiler is concerned because gcc has int32_t as long int
         -Wno-unused-function # we have some for the docs that aren't called
@@ -57,34 +59,43 @@ if (CMAKE_C_COMPILER_ID STREQUAL "GNU")
     add_compile_options(-Wno-maybe-uninitialized)
 endif()
 
-# Hardware-specific examples in subdirectories:
-add_subdirectory(adc)
-add_subdirectory(binary_info)
-add_subdirectory(bootloaders)
-add_subdirectory(clocks)
-add_subdirectory(cmake)
-add_subdirectory(dcp)
-add_subdirectory(divider)
-add_subdirectory(dma)
-add_subdirectory(flash)
-add_subdirectory(gpio)
-add_subdirectory(hstx)
-add_subdirectory(i2c)
-add_subdirectory(interp)
-add_subdirectory(multicore)
-add_subdirectory(otp)
-add_subdirectory(picoboard)
-add_subdirectory(pico_w)
-add_subdirectory(pio)
-add_subdirectory(pwm)
-add_subdirectory(reset)
-add_subdirectory(rtc)
-add_subdirectory(spi)
-add_subdirectory(system)
-add_subdirectory(timer)
-add_subdirectory(uart)
-add_subdirectory(universal)
-add_subdirectory(usb)
-add_subdirectory(watchdog)
-add_subdirectory(sha)
-add_subdirectory(freertos)
+if (PICO_EXAMPLES_TOP_LEVEL_PROJECT)
+    # Add blink example
+    add_subdirectory_exclude_platforms(blink)
+    add_subdirectory_exclude_platforms(blink_simple)
+
+    # Add hello world example
+    add_subdirectory_exclude_platforms(hello_world)
+
+    # Hardware-specific examples in subdirectories:
+    add_subdirectory(adc)
+    add_subdirectory(binary_info)
+    add_subdirectory(bootloaders)
+    add_subdirectory(clocks)
+    add_subdirectory(cmake)
+    add_subdirectory(dcp)
+    add_subdirectory(divider)
+    add_subdirectory(dma)
+    add_subdirectory(flash)
+    add_subdirectory(gpio)
+    add_subdirectory(hstx)
+    add_subdirectory(i2c)
+    add_subdirectory(interp)
+    add_subdirectory(multicore)
+    add_subdirectory(otp)
+    add_subdirectory(picoboard)
+    add_subdirectory(pico_w)
+    add_subdirectory(pio)
+    add_subdirectory(pwm)
+    add_subdirectory(reset)
+    add_subdirectory(rtc)
+    add_subdirectory(spi)
+    add_subdirectory(system)
+    add_subdirectory(timer)
+    add_subdirectory(uart)
+    add_subdirectory(universal)
+    add_subdirectory(usb)
+    add_subdirectory(watchdog)
+    add_subdirectory(sha)
+    add_subdirectory(freertos)
+endif()
diff --git a/adc/adc_console/CMakeLists.txt b/adc/adc_console/CMakeLists.txt
@@ -1,3 +1,11 @@
+cmake_minimum_required(VERSION 3.12)
+
+if (NOT CMAKE_PROJECT_NAME)
+    include(../../CMakeLists.txt)
+    project(adc_console C CXX ASM)
+    include(../../CMakeLists.txt)
+endif()
+
 add_executable(adc_console
         adc_console.c
         )

diff --git a/adc/dma_capture/CMakeLists.txt b/adc/dma_capture/CMakeLists.txt
@@ -1,3 +1,11 @@
+cmake_minimum_required(VERSION 3.12)
+
+if (NOT CMAKE_PROJECT_NAME)
+    include(../../CMakeLists.txt)
+    project(dma_capture C CXX ASM)
+    include(../../CMakeLists.txt)
+endif()
+
 add_executable(adc_dma_capture
         dma_capture.c
         )

diff --git a/adc/hello_adc/CMakeLists.txt b/adc/hello_adc/CMakeLists.txt
@@ -1,3 +1,11 @@
+cmake_minimum_required(VERSION 3.12)
+
+if (NOT CMAKE_PROJECT_NAME)
+    include(../../CMakeLists.txt)
+    project(hello_adc C CXX ASM)
+    include(../../CMakeLists.txt)
+endif()
+
 add_executable(hello_adc
         hello_adc.c
         )

diff --git a/adc/joystick_display/CMakeLists.txt b/adc/joystick_display/CMakeLists.txt
@@ -1,3 +1,11 @@
+cmake_minimum_required(VERSION 3.12)
+
+if (NOT CMAKE_PROJECT_NAME)
+    include(../../CMakeLists.txt)
+    project(joystick_display C CXX ASM)
+    include(../../CMakeLists.txt)
+endif()
+
 add_executable(joystick_display
         joystick_display.c
         )

diff --git a/adc/microphone_adc/CMakeLists.txt b/adc/microphone_adc/CMakeLists.txt
@@ -1,3 +1,11 @@
+cmake_minimum_required(VERSION 3.12)
+
+if (NOT CMAKE_PROJECT_NAME)
+    include(../../CMakeLists.txt)
+    project(microphone_adc C CXX ASM)
+    include(../../CMakeLists.txt)
+endif()
+
 add_executable(microphone_adc
         microphone_adc.c
         )

diff --git a/adc/onboard_temperature/CMakeLists.txt b/adc/onboard_temperature/CMakeLists.txt
@@ -1,3 +1,11 @@
+cmake_minimum_required(VERSION 3.12)
+
+if (NOT CMAKE_PROJECT_NAME)
+    include(../../CMakeLists.txt)
+    project(onboard_temperature C CXX ASM)
+    include(../../CMakeLists.txt)
+endif()
+
 add_executable(onboard_temperature onboard_temperature.c)
 
 target_link_libraries(onboard_temperature pico_stdlib hardware_adc)

diff --git a/adc/read_vsys/CMakeLists.txt b/adc/read_vsys/CMakeLists.txt
@@ -1,3 +1,11 @@
+cmake_minimum_required(VERSION 3.12)
+
+if (NOT CMAKE_PROJECT_NAME)
+    include(../../CMakeLists.txt)
+    project(read_vsys C CXX ASM)
+    include(../../CMakeLists.txt)
+endif()
+
 add_library(power_status_adc INTERFACE)
 target_sources(power_status_adc INTERFACE
         ${CMAKE_CURRENT_LIST_DIR}/power_status.c

diff --git a/binary_info/blink_any/CMakeLists.txt b/binary_info/blink_any/CMakeLists.txt
@@ -1,3 +1,11 @@
+cmake_minimum_required(VERSION 3.12)
+
+if (NOT CMAKE_PROJECT_NAME)
+    include(../../CMakeLists.txt)
+    project(blink_any C CXX ASM)
+    include(../../CMakeLists.txt)
+endif()
+
 if (NOT PICO_CYW43_SUPPORTED)
     message("Only building blink_any for non W boards as PICO_CYW43_SUPPORTED is not set")
 endif()

diff --git a/binary_info/hello_anything/CMakeLists.txt b/binary_info/hello_anything/CMakeLists.txt
@@ -1,3 +1,11 @@
+cmake_minimum_required(VERSION 3.12)
+
+if (NOT CMAKE_PROJECT_NAME)
+    include(../../CMakeLists.txt)
+    project(hello_anything C CXX ASM)
+    include(../../CMakeLists.txt)
+endif()
+
 if (TARGET tinyusb_device)
     add_executable(hello_anything
             hello_anything.c

diff --git a/blink/CMakeLists.txt b/blink/CMakeLists.txt
@@ -1,3 +1,19 @@
+cmake_minimum_required(VERSION 3.12)
+
+if (NOT CMAKE_PROJECT_NAME)
+    include(../CMakeLists.txt)
+    project(blink C CXX ASM)
+    include(../CMakeLists.txt)
+endif()
+
+cmake_minimum_required(VERSION 3.12)
+
+if (NOT CMAKE_PROJECT_NAME)
+    include(${CMAKE_CURRENT_LIST_DIR}/../CMakeLists.txt)
+    project(blink C CXX ASM)
+    include(${CMAKE_CURRENT_LIST_DIR}/../CMakeLists.txt)
+endif()
+
 add_executable(blink
     blink.c
     )

diff --git a/blink_simple/CMakeLists.txt b/blink_simple/CMakeLists.txt
@@ -1,3 +1,11 @@
+cmake_minimum_required(VERSION 3.12)
+
+if (NOT CMAKE_PROJECT_NAME)
+    include(../CMakeLists.txt)
+    project(blink_simple C CXX ASM)
+    include(../CMakeLists.txt)
+endif()
+
 add_executable(blink_simple
         blink_simple.c
 )

diff --git a/bootloaders/encrypted/CMakeLists.txt b/bootloaders/encrypted/CMakeLists.txt
@@ -1,3 +1,11 @@
+cmake_minimum_required(VERSION 3.12)
+
+if (NOT CMAKE_PROJECT_NAME)
+    include(../../CMakeLists.txt)
+    project(encrypted C CXX ASM)
+    include(../../CMakeLists.txt)
+endif()
+
 # Encrypted Bootloader
 add_executable(enc_bootloader
         enc_bootloader.c

diff --git a/clocks/detached_clk_peri/CMakeLists.txt b/clocks/detached_clk_peri/CMakeLists.txt
@@ -1,3 +1,11 @@
+cmake_minimum_required(VERSION 3.12)
+
+if (NOT CMAKE_PROJECT_NAME)
+    include(../../CMakeLists.txt)
+    project(detached_clk_peri C CXX ASM)
+    include(../../CMakeLists.txt)
+endif()
+
 add_executable(clocks_detached_clk_peri
         detached_clk_peri.c
         )

diff --git a/clocks/hello_48MHz/CMakeLists.txt b/clocks/hello_48MHz/CMakeLists.txt
@@ -1,3 +1,11 @@
+cmake_minimum_required(VERSION 3.12)
+
+if (NOT CMAKE_PROJECT_NAME)
+    include(../../CMakeLists.txt)
+    project(hello_48MHz C CXX ASM)
+    include(../../CMakeLists.txt)
+endif()
+
 add_executable(hello_48MHz
         hello_48MHz.c
         )

diff --git a/clocks/hello_gpout/CMakeLists.txt b/clocks/hello_gpout/CMakeLists.txt
@@ -1,3 +1,11 @@
+cmake_minimum_required(VERSION 3.12)
+
+if (NOT CMAKE_PROJECT_NAME)
+    include(../../CMakeLists.txt)
+    project(hello_gpout C CXX ASM)
+    include(../../CMakeLists.txt)
+endif()
+
 add_executable(hello_gpout
         hello_gpout.c
         )

diff --git a/clocks/hello_resus/CMakeLists.txt b/clocks/hello_resus/CMakeLists.txt
@@ -1,3 +1,11 @@
+cmake_minimum_required(VERSION 3.12)
+
+if (NOT CMAKE_PROJECT_NAME)
+    include(../../CMakeLists.txt)
+    project(hello_resus C CXX ASM)
+    include(../../CMakeLists.txt)
+endif()
+
 add_executable(hello_resus
         hello_resus.c
         )

diff --git a/cmake/build_variants/CMakeLists.txt b/cmake/build_variants/CMakeLists.txt
@@ -1,3 +1,11 @@
+cmake_minimum_required(VERSION 3.12)
+
+if (NOT CMAKE_PROJECT_NAME)
+    include(../../CMakeLists.txt)
+    project(build_variants C CXX ASM)
+    include(../../CMakeLists.txt)
+endif()
+
 # 1 Create an INTERFACE library aggregating all the common parts of the application
 add_library(common_stuff INTERFACE)
 

diff --git a/dcp/hello_dcp/CMakeLists.txt b/dcp/hello_dcp/CMakeLists.txt
@@ -1,3 +1,11 @@
+cmake_minimum_required(VERSION 3.12)
+
+if (NOT CMAKE_PROJECT_NAME)
+    include(../../CMakeLists.txt)
+    project(hello_dcp C CXX ASM)
+    include(../../CMakeLists.txt)
+endif()
+
 add_executable(hello_dcp
         hello_dcp.c
         dcp_examples.S

diff --git a/divider/CMakeLists.txt b/divider/CMakeLists.txt
@@ -1,3 +1,11 @@
+cmake_minimum_required(VERSION 3.12)
+
+if (NOT CMAKE_PROJECT_NAME)
+    include(../CMakeLists.txt)
+    project(divider C CXX ASM)
+    include(../CMakeLists.txt)
+endif()
+
 if (TARGET hardware_divider)
         add_executable(hello_divider
                 hello_divider.c

diff --git a/dma/channel_irq/CMakeLists.txt b/dma/channel_irq/CMakeLists.txt
@@ -1,3 +1,11 @@
+cmake_minimum_required(VERSION 3.12)
+
+if (NOT CMAKE_PROJECT_NAME)
+    include(../../CMakeLists.txt)
+    project(channel_irq C CXX ASM)
+    include(../../CMakeLists.txt)
+endif()
+
 add_executable(dma_channel_irq
         channel_irq.c
         )

diff --git a/dma/control_blocks/CMakeLists.txt b/dma/control_blocks/CMakeLists.txt
@@ -1,3 +1,11 @@
+cmake_minimum_required(VERSION 3.12)
+
+if (NOT CMAKE_PROJECT_NAME)
+    include(../../CMakeLists.txt)
+    project(control_blocks C CXX ASM)
+    include(../../CMakeLists.txt)
+endif()
+
 add_executable(dma_control_blocks
         control_blocks.c
         )