diff --git a/BUILD.md b/BUILD.md new file mode 100644 index 0000000..14a1537 --- /dev/null +++ b/BUILD.md @@ -0,0 +1,7 @@ + +# IN PROGRESS + +The build process for this repo is still not stabilized. + + + diff --git a/README.md b/README.md index c58658a..bc89215 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -Remember to `git submodule update --init` +Remember to `git submodule update --init --recursive` # SomeFreeRTOSExamples diff --git a/REMEMBER_TO_INIT_SUBMODULES.md b/REMEMBER_TO_INIT_SUBMODULES.md index dd71ade..db61f5b 100644 --- a/REMEMBER_TO_INIT_SUBMODULES.md +++ b/REMEMBER_TO_INIT_SUBMODULES.md @@ -1 +1 @@ -Remember to `git submodule update --init` +Remember to `git submodule update --init --recursive` diff --git a/examples/ex0_no_freertos/CMakeLists.txt b/examples/ex0_no_freertos/CMakeLists.txt new file mode 100644 index 0000000..be58882 --- /dev/null +++ b/examples/ex0_no_freertos/CMakeLists.txt @@ -0,0 +1,30 @@ +cmake_minimum_required(VERSION 3.13) + +if(NOT DEFINED LIB_ROOT) + set(LIB_ROOT ${CMAKE_SOURCE_DIR}/../..) +endif(NOT DEFINED LIB_ROOT) + +set(PICO_SDK_PATH ${LIB_ROOT}/submodules/pico-sdk/) +set(PICOTOOL_FETCH_FROM_GIT_PATH ${LIB_ROOT}/submodules/picotool/) + +# Include the Pico SDK (make sure to use the correct path to pico_sdk_import.cmake) +include(${LIB_ROOT}/submodules/pico-sdk/external/pico_sdk_import.cmake) + +# Define the project +project(ex0_hello_world C CXX ASM) + +# Initialize the Pico SDK +pico_sdk_init() + +# Add the executable target (your main C file) +add_executable(ex0_hello_world main.c) + +# Link the Pico standard library to the executable +target_link_libraries(ex0_hello_world pico_stdlib) + +# Generate additional output formats (like UF2 for flashing) +pico_add_extra_outputs(ex0_hello_world) + +pico_enable_stdio_usb(ex0_hello_world 1) +pico_enable_stdio_uart(ex0_hello_world 0) + diff --git a/examples/ex0_no_freertos/main.c b/examples/ex0_no_freertos/main.c new file mode 100644 index 0000000..4101549 --- /dev/null +++ b/examples/ex0_no_freertos/main.c @@ -0,0 +1,16 @@ +#include "pico/stdlib.h" +#include "hardware/uart.h" + +int main() { + // Initialize stdio with USB support + stdio_init_all(); + + // Delay to allow USB connection setup + sleep_ms(2000); + + while (true) { + printf("Hello, World!\n"); + sleep_ms(1000); + } +} + diff --git a/examples/ex1_task_hello/CMakeLists.txt b/examples/ex1_task_hello/CMakeLists.txt new file mode 100644 index 0000000..41c8897 --- /dev/null +++ b/examples/ex1_task_hello/CMakeLists.txt @@ -0,0 +1,51 @@ +cmake_minimum_required(VERSION 3.13) + +if(NOT DEFINED LIB_ROOT) + set(LIB_ROOT ${CMAKE_SOURCE_DIR}/../..) +endif(NOT DEFINED LIB_ROOT) + +set(PICO_SDK_PATH ${LIB_ROOT}/submodules/pico-sdk/) +include( ${LIB_ROOT}/submodules/pico-sdk/external/pico_sdk_import.cmake) + +# Pull in FreeRTOS +include(${LIB_ROOT}/submodules/FreeRTOS-Kernel/portable/ThirdParty/GCC/RP2040/FreeRTOS_Kernel_import.cmake) + +set(PICOTOOL_FETCH_FROM_GIT_PATH ${LIB_ROOT}/submodules/picotool/) + +# Include the Pico SDK (make sure to use the correct path to pico_sdk_import.cmake) +include(FetchContent) + +# Define the project +project(ex1_task_hello C CXX ASM) + +# Initialize the Pico SDK +pico_sdk_init() + +include_directories( + ${LIB_ROOT}/submodules/pico-sdk/src/rp2040/hardware_structs/include/ + ${LIB_ROOT}/submodules/FreeRTOS-Kernel/include/ + ${LIB_ROOT}/submodules/FreeRTOS-Kernel/portable/ThirdParty/GCC/RP2040/include/ + include/ + ${LIB_ROOT}/submodules/pico-sdk/src/rp2_common/hardware_exception/include/ + ${LIB_ROOT}/submodules/pico-sdk/src/rp2_common/pico_multicore/include/ +) + +# Create the executable +add_executable(ex1_task_hello main.c + ${LIB_ROOT}/submodules/FreeRTOS-Kernel/tasks.c + ${LIB_ROOT}/submodules/FreeRTOS-Kernel/queue.c + ${LIB_ROOT}/submodules/FreeRTOS-Kernel/list.c + ${LIB_ROOT}/submodules/FreeRTOS-Kernel/portable/ThirdParty/GCC/RP2040/port.c + ${LIB_ROOT}/submodules/FreeRTOS-Kernel/portable/MemMang/heap_3.c + ${LIB_ROOT}/submodules/FreeRTOS-Kernel/event_groups.c + ${LIB_ROOT}/submodules/FreeRTOS-Kernel/timers.c + ${LIB_ROOT}/submodules/pico-sdk/src/rp2_common/hardware_exception/exception.c +) + +# Link against FreeRTOS, Pico SDK, and freertos_config +target_link_libraries(ex1_task_hello pico_stdlib) +pico_add_extra_outputs(ex1_task_hello) + +pico_enable_stdio_usb( ex1_task_hello 1) +pico_enable_stdio_uart(ex1_task_hello 0) + diff --git a/examples/ex1_task_hello/include/FreeRTOSConfig.h b/examples/ex1_task_hello/include/FreeRTOSConfig.h new file mode 100644 index 0000000..b0b311b --- /dev/null +++ b/examples/ex1_task_hello/include/FreeRTOSConfig.h @@ -0,0 +1,143 @@ +/* + * FreeRTOS V202212.00 + * Copyright (C) 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved. + * + * 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. + * + * https://www.FreeRTOS.org + * https://github.com/FreeRTOS + * + */ + +#ifndef FREERTOS_CONFIG_H +#define FREERTOS_CONFIG_H + +/*----------------------------------------------------------- + * Application specific definitions. + * + * These definitions should be adjusted for your particular hardware and + * application requirements. + * + * THESE PARAMETERS ARE DESCRIBED WITHIN THE 'CONFIGURATION' SECTION OF THE + * FreeRTOS API DOCUMENTATION AVAILABLE ON THE FreeRTOS.org WEB SITE. + * + * See http://www.freertos.org/a00110.html + *----------------------------------------------------------*/ + +/* Scheduler Related */ +#define configUSE_PREEMPTION 1 +#define configUSE_TICKLESS_IDLE 0 +#define configUSE_IDLE_HOOK 0 +#define configUSE_TICK_HOOK 0 +#define configTICK_RATE_HZ ( ( TickType_t ) 1000 ) +#define configMAX_PRIORITIES 32 +#define configMINIMAL_STACK_SIZE ( configSTACK_DEPTH_TYPE ) 256 +#define configUSE_16_BIT_TICKS 0 + +#define configIDLE_SHOULD_YIELD 1 + +/* Synchronization Related */ +#define configUSE_MUTEXES 1 +#define configUSE_RECURSIVE_MUTEXES 1 +#define configUSE_APPLICATION_TASK_TAG 0 +#define configUSE_COUNTING_SEMAPHORES 1 +#define configQUEUE_REGISTRY_SIZE 8 +#define configUSE_QUEUE_SETS 1 +#define configUSE_TIME_SLICING 1 +#define configUSE_NEWLIB_REENTRANT 0 +#define configENABLE_BACKWARD_COMPATIBILITY 0 +#define configNUM_THREAD_LOCAL_STORAGE_POINTERS 5 + +/* System */ +#define configSTACK_DEPTH_TYPE uint32_t +#define configMESSAGE_BUFFER_LENGTH_TYPE size_t + +/* Memory allocation related definitions. */ +#define configSUPPORT_STATIC_ALLOCATION 0 +#define configSUPPORT_DYNAMIC_ALLOCATION 1 +#define configTOTAL_HEAP_SIZE (128*1024) +#define configAPPLICATION_ALLOCATED_HEAP 0 + +/* Hook function related definitions. */ +#define configCHECK_FOR_STACK_OVERFLOW 0 +#define configUSE_MALLOC_FAILED_HOOK 0 +#define configUSE_DAEMON_TASK_STARTUP_HOOK 0 + +/* Run time and task stats gathering related definitions. */ +#define configGENERATE_RUN_TIME_STATS 0 +#define configUSE_TRACE_FACILITY 1 +#define configUSE_STATS_FORMATTING_FUNCTIONS 0 + +/* Co-routine related definitions. */ +#define configUSE_CO_ROUTINES 0 +#define configMAX_CO_ROUTINE_PRIORITIES 1 + +/* Software timer related definitions. */ +#define configUSE_TIMERS 1 +#define configTIMER_TASK_PRIORITY ( configMAX_PRIORITIES - 1 ) +#define configTIMER_QUEUE_LENGTH 10 +#define configTIMER_TASK_STACK_DEPTH 1024 + +/* Interrupt nesting behaviour configuration. */ +/* +#define configKERNEL_INTERRUPT_PRIORITY [dependent of processor] +#define configMAX_SYSCALL_INTERRUPT_PRIORITY [dependent on processor and application] +#define configMAX_API_CALL_INTERRUPT_PRIORITY [dependent on processor and application] +*/ + +/* SMP port only */ +#define configNUMBER_OF_CORES 1 +#define configTICK_CORE 0 +#define configRUN_MULTIPLE_PRIORITIES 0 + +/* RP2040 specific */ +#define configSUPPORT_PICO_SYNC_INTEROP 1 +#define configSUPPORT_PICO_TIME_INTEROP 1 + +#include +/* Define to trap errors during development. */ +#define configASSERT(x) assert(x) + +/* Set the following definitions to 1 to include the API function, or zero +to exclude the API function. */ +#define INCLUDE_vTaskPrioritySet 1 +#define INCLUDE_uxTaskPriorityGet 1 +#define INCLUDE_vTaskDelete 1 +#define INCLUDE_vTaskSuspend 1 +#define INCLUDE_vTaskDelayUntil 1 +#define INCLUDE_vTaskDelay 1 +#define INCLUDE_xTaskGetSchedulerState 1 +#define INCLUDE_xTaskGetCurrentTaskHandle 1 +#define INCLUDE_uxTaskGetStackHighWaterMark 1 +#define INCLUDE_xTaskGetIdleTaskHandle 1 +#define INCLUDE_eTaskGetState 1 +#define INCLUDE_xTimerPendFunctionCall 1 +#define INCLUDE_xTaskAbortDelay 1 +#define INCLUDE_xTaskGetHandle 1 +#define INCLUDE_xTaskResumeFromISR 1 +#define INCLUDE_xQueueGetMutexHolder 1 +#define INCLUDE_vApplicationStackOverflowHook 0 +#define INCLUDE_vApplicationTickHook 1 +#define INCLUDE_vApplicationMallocFailedHook 1 + + +#define LIB_PICO_MULTICORE 1 +/* A header file that defines trace macro can be included here. */ + +#endif /* FREERTOS_CONFIG_H */ + diff --git a/examples/ex1_task_hello/main.c b/examples/ex1_task_hello/main.c new file mode 100644 index 0000000..63bd23e --- /dev/null +++ b/examples/ex1_task_hello/main.c @@ -0,0 +1,21 @@ +#include "pico/stdlib.h" +#include "FreeRTOS.h" +#include "task.h" + +void hello_task(void *pvParameters) { + while (true) { + printf("Hello from FreeRTOS! Success!\n"); + vTaskDelay(pdMS_TO_TICKS(1000)); + } +} + +int main() { + stdio_init_all(); + xTaskCreate(hello_task, "Hello Task", 256, NULL, 1, NULL); + vTaskStartScheduler(); + + // The scheduler will take over, so main() should never reach here. + while (true) {} + return 0; +} +