freertos: Uncrustify FreeRTOSConfig files

2023-03-17 23:54:18 +08:00
parent 6895e92fd2
commit 54deed0566
4 changed files with 225 additions and 220 deletions
--- a/components/freertos/esp_additions/arch/linux/include/freertos/FreeRTOSConfig_arch.h
+++ b/components/freertos/esp_additions/arch/linux/include/freertos/FreeRTOSConfig_arch.h
@@ -6,7 +6,7 @@

 #pragma once

-// Linux POSIX simulator specific configuration. This file is included in the common FreeRTOSConfig.h.
+/* Linux POSIX simulator specific configuration. This file is included in the common FreeRTOSConfig.h. */

 #include "sdkconfig.h"

@@ -16,32 +16,33 @@
 *   https://github.com/FreeRTOS/FreeRTOS/blob/main/FreeRTOS/Demo/Posix_GCC/FreeRTOSConfig.h
 * ------------------------------------------------------------------------------------------------------------------ */

-// ------------------ Scheduler Related --------------------
+/* ------------------ Scheduler Related -------------------- */

 #define configMAX_PRIORITIES                       ( 7 )
 #define configUSE_PORT_OPTIMISED_TASK_SELECTION    0
+
 /* The stack allocated by FreeRTOS will be passed to a pthread.
-   pthread has a minimal stack size which currently is 16KB.
-   The rest is for additional structures of the POSIX/Linux port.
-   This is a magic number since PTHREAD_STACK_MIN seems to not be a constant. */
+ * pthread has a minimal stack size which currently is 16KB.
+ * The rest is for additional structures of the POSIX/Linux port.
+ * This is a magic number since PTHREAD_STACK_MIN seems to not be a constant. */
 #define configMINIMAL_STACK_SIZE                   ( ( unsigned short ) ( 0x4000 + 40 ) / sizeof( portSTACK_TYPE ) )
 /* Currently not used in Linux POSIX simulator */
 #define configMAX_API_CALL_INTERRUPT_PRIORITY      0

-// ----------------------- System --------------------------
+/* ----------------------- System -------------------------- */

 #define configUSE_NEWLIB_REENTRANT                   0
 #define configINCLUDE_FREERTOS_TASK_C_ADDITIONS_H    0

-// ----------------------- Memory  -------------------------
+/* ----------------------- Memory  ------------------------- */

 #define configTOTAL_HEAP_SIZE    ( ( size_t ) ( 65 * 1024 ) )

-// ------------------- Run-time Stats ----------------------
+/* ------------------- Run-time Stats ---------------------- */

 #define configUSE_TRACE_FACILITY    1

-// -------------------- API Includes -----------------------
+/* -------------------- API Includes ----------------------- */

 #define INCLUDE_xTaskGetCurrentTaskHandle    0                /* not defined in POSIX simulator */
 #define INCLUDE_vTaskDelayUntil              1
--- a/components/freertos/esp_additions/arch/riscv/include/freertos/FreeRTOSConfig_arch.h
+++ b/components/freertos/esp_additions/arch/riscv/include/freertos/FreeRTOSConfig_arch.h
@@ -6,7 +6,7 @@

 #pragma once

-// RISC-V Architecture specific configuration. This file is included in the common FreeRTOSConfig.h.
+/* RISC-V Architecture specific configuration. This file is included in the common FreeRTOSConfig.h. */

 #include "sdkconfig.h"

@@ -14,7 +14,7 @@
 * - All Vanilla FreeRTOS configuration goes into this section
 * ------------------------------------------------------------------------------------------------------------------ */

-// ------------------ Scheduler Related --------------------
+/* ------------------ Scheduler Related -------------------- */

 #define configMAX_PRIORITIES                           ( 25 )
 #ifdef CONFIG_FREERTOS_OPTIMIZED_SCHEDULER
@@ -25,26 +25,26 @@
 #define configMINIMAL_STACK_SIZE                       ( CONFIG_FREERTOS_IDLE_TASK_STACKSIZE + configSTACK_OVERHEAD_TOTAL )
 #define configMAX_API_CALL_INTERRUPT_PRIORITY          0

-// ----------------------- System --------------------------
+/* ----------------------- System -------------------------- */

 #define configUSE_NEWLIB_REENTRANT                   1
 #define configINCLUDE_FREERTOS_TASK_C_ADDITIONS_H    1

-// ----------------------- Memory  -------------------------
+/* ----------------------- Memory  ------------------------- */

 /* This isn't used as FreeRTOS will only allocate from internal memory (see
 * heap_idf.c). We simply define this macro to span all non-statically-allocated
 * shared RAM. */
 #define configTOTAL_HEAP_SIZE    ( &_heap_end - &_heap_start )

-// ------------------- Run-time Stats ----------------------
+/* ------------------- Run-time Stats ---------------------- */

 #if CONFIG_FREERTOS_USE_TRACE_FACILITY
    /* Used by uxTaskGetSystemState(), and other trace facility functions */
    #define configUSE_TRACE_FACILITY    1
 #endif /* CONFIG_FREERTOS_USE_TRACE_FACILITY */

-// -------------------- API Includes -----------------------
+/* -------------------- API Includes ----------------------- */

 #define INCLUDE_xTaskDelayUntil              1
 #define INCLUDE_xTaskGetCurrentTaskHandle    1
--- a/components/freertos/esp_additions/arch/xtensa/include/freertos/FreeRTOSConfig_arch.h
+++ b/components/freertos/esp_additions/arch/xtensa/include/freertos/FreeRTOSConfig_arch.h
@@ -6,7 +6,7 @@

 #pragma once

-// Xtensa Architecture specific configuration. This file is included in the common FreeRTOSConfig.h.
+/* Xtensa Architecture specific configuration. This file is included in the common FreeRTOSConfig.h. */

 #include "sdkconfig.h"

@@ -41,7 +41,7 @@
 * - All Vanilla FreeRTOS configuration goes into this section
 * ------------------------------------------------------------------------------------------------------------------ */

-// ------------------ Scheduler Related --------------------
+/* ------------------ Scheduler Related -------------------- */

 #define configMAX_PRIORITIES                           ( 25 )
 #ifdef CONFIG_FREERTOS_OPTIMIZED_SCHEDULER
@@ -52,26 +52,26 @@
 #define configMINIMAL_STACK_SIZE                       ( CONFIG_FREERTOS_IDLE_TASK_STACKSIZE + configSTACK_OVERHEAD_TOTAL )
 #define configMAX_API_CALL_INTERRUPT_PRIORITY          XCHAL_EXCM_LEVEL

-// ----------------------- System --------------------------
+/* ----------------------- System -------------------------- */

 #define configUSE_NEWLIB_REENTRANT                   1
 #define configINCLUDE_FREERTOS_TASK_C_ADDITIONS_H    1

-// ----------------------- Memory  -------------------------
+/* ----------------------- Memory  ------------------------- */

 /* This isn't used as FreeRTOS will only allocate from internal memory (see
 * heap_idf.c). We simply define this macro to span all non-statically-allocated
 * shared RAM. */
 #define configTOTAL_HEAP_SIZE    ( &_heap_end - &_heap_start )

-// ------------------- Run-time Stats ----------------------
+/* ------------------- Run-time Stats ---------------------- */

 #if CONFIG_FREERTOS_USE_TRACE_FACILITY
    /* Used by uxTaskGetSystemState(), and other trace facility functions */
    #define configUSE_TRACE_FACILITY    1
 #endif /* CONFIG_FREERTOS_USE_TRACE_FACILITY */

-// -------------------- API Includes -----------------------
+/* -------------------- API Includes ----------------------- */

 #define INCLUDE_xTaskDelayUntil              1
 #define INCLUDE_xTaskGetCurrentTaskHandle    1
--- a/components/freertos/esp_additions/include/freertos/FreeRTOSConfig.h
+++ b/components/freertos/esp_additions/include/freertos/FreeRTOSConfig.h
@@ -8,12 +8,12 @@

 #include "sdkconfig.h"

-/*
-This file gets pulled into assembly sources. Therefore, some includes need to be wrapped in #ifndef __ASSEMBLER__
-*/
+/* This file gets pulled into assembly sources. Therefore, some includes need to
+ * be wrapped in #ifndef __ASSEMBLER__ */

 #ifndef __ASSEMBLER__
-#include <assert.h>         //For configASSERT()
+    /* For configASSERT() */
+    #include <assert.h>
 #endif /* def __ASSEMBLER__ */

 /* ----------------------------------------------------- Helpers -------------------------------------------------------
@@ -42,14 +42,15 @@ This file gets pulled into assembly sources. Therefore, some includes need to be
 #endif

 /* Stack watchpoint decreases minimum usable stack size by up to 60 bytes.
-   See FreeRTOS FREERTOS_WATCHPOINT_END_OF_STACK option in Kconfig. */
+ * See FreeRTOS FREERTOS_WATCHPOINT_END_OF_STACK option in Kconfig. */
 #if CONFIG_FREERTOS_WATCHPOINT_END_OF_STACK
    #define STACK_OVERHEAD_WATCHPOINT    60
 #else
    #define STACK_OVERHEAD_WATCHPOINT    0
 #endif

-#define configSTACK_OVERHEAD_TOTAL (                              \
+#define configSTACK_OVERHEAD_TOTAL    \
+    (                                 \
        STACK_OVERHEAD_CHECKER +      \
        STACK_OVERHEAD_OPTIMIZATION + \
        STACK_OVERHEAD_APPTRACE +     \
@@ -80,21 +81,21 @@ This file gets pulled into assembly sources. Therefore, some includes need to be
 * See http://www.freertos.org/a00110.html
 *----------------------------------------------------------*/

-// ------------------ Scheduler Related --------------------
+/* ------------------ Scheduler Related -------------------- */

 #define configUSE_PREEMPTION                         1
 #define configUSE_TICKLESS_IDLE                      CONFIG_FREERTOS_USE_TICKLESS_IDLE
 #if configUSE_TICKLESS_IDLE
    #define configEXPECTED_IDLE_TIME_BEFORE_SLEEP    CONFIG_FREERTOS_IDLE_TIME_BEFORE_SLEEP
-#endif //configUSE_TICKLESS_IDLE
+#endif /* configUSE_TICKLESS_IDLE */
 #define configCPU_CLOCK_HZ                           ( CONFIG_ESP_DEFAULT_CPU_FREQ_MHZ * 1000000 )
 #define configTICK_RATE_HZ                           CONFIG_FREERTOS_HZ
 #define configUSE_TIME_SLICING                       1
 #define configUSE_16_BIT_TICKS                       0
 #define configIDLE_SHOULD_YIELD                      0
-#define configKERNEL_INTERRUPT_PRIORITY                 1   //Todo: This currently isn't used anywhere
+#define configKERNEL_INTERRUPT_PRIORITY              1      /*Todo: This currently isn't used anywhere */

-// ------------- Synchronization Primitives ----------------
+/* ------------- Synchronization Primitives ---------------- */

 #define configUSE_MUTEXES                        1
 #define configUSE_RECURSIVE_MUTEXES              1
@@ -104,7 +105,7 @@ This file gets pulled into assembly sources. Therefore, some includes need to be
 #define configUSE_TASK_NOTIFICATIONS             1
 #define configTASK_NOTIFICATION_ARRAY_ENTRIES    CONFIG_FREERTOS_TASK_NOTIFICATION_ARRAY_ENTRIES

-// ----------------------- System --------------------------
+/* ----------------------- System -------------------------- */

 #define configMAX_TASK_NAME_LEN                        CONFIG_FREERTOS_MAX_TASK_NAME_LEN
 #if CONFIG_FREERTOS_SMP
@@ -116,19 +117,19 @@ This file gets pulled into assembly sources. Therefore, some includes need to be
 #define configSTACK_DEPTH_TYPE                         uint32_t
 #if CONFIG_FREERTOS_ENABLE_BACKWARD_COMPATIBILITY
    #define configENABLE_BACKWARD_COMPATIBILITY        1
-#else
+#else /* CONFIG_FREERTOS_ENABLE_BACKWARD_COMPATIBILITY */
    #define configENABLE_BACKWARD_COMPATIBILITY        0
-#endif
+#endif /* CONFIG_FREERTOS_ENABLE_BACKWARD_COMPATIBILITY */
 #define configASSERT( a )    assert( a )

-// ----------------------- Memory  -------------------------
+/* ----------------------- Memory  ------------------------- */

 #define configSUPPORT_STATIC_ALLOCATION              1
 #define configSUPPORT_DYNAMIC_ALLOCATION             1
 #define configAPPLICATION_ALLOCATED_HEAP             1
 #define configSTACK_ALLOCATION_FROM_SEPARATE_HEAP    0

-// ------------------------ Hooks --------------------------
+/* ------------------------ Hooks -------------------------- */

 #if CONFIG_FREERTOS_USE_IDLE_HOOK
    #define configUSE_IDLE_HOOK               1
@@ -146,37 +147,37 @@ This file gets pulled into assembly sources. Therefore, some includes need to be
    #define configCHECK_FOR_STACK_OVERFLOW    1
 #elif CONFIG_FREERTOS_CHECK_STACKOVERFLOW_CANARY
    #define configCHECK_FOR_STACK_OVERFLOW    2
-#endif
-#define configRECORD_STACK_HIGH_ADDRESS                 1   // This must be set as the port requires TCB.pxEndOfStack
+#endif /* CONFIG_FREERTOS_CHECK_STACKOVERFLOW_NONE */
+#define configRECORD_STACK_HIGH_ADDRESS       1             /* This must be set as the port requires TCB.pxEndOfStack */

-// ------------------- Run-time Stats ----------------------
+/* ------------------- Run-time Stats ---------------------- */

 #ifdef CONFIG_FREERTOS_GENERATE_RUN_TIME_STATS
    #define configGENERATE_RUN_TIME_STATS           1       /* Used by vTaskGetRunTimeStats() */
-#endif
+#endif /* CONFIG_FREERTOS_GENERATE_RUN_TIME_STATS */
 #ifdef CONFIG_FREERTOS_USE_STATS_FORMATTING_FUNCTIONS
    #define configUSE_STATS_FORMATTING_FUNCTIONS    1       /* Used by vTaskList() */
-#endif
+#endif /* CONFIG_FREERTOS_USE_STATS_FORMATTING_FUNCTIONS */

-// -------------------- Co-routines  -----------------------
+/* -------------------- Co-routines  ----------------------- */

-#define configUSE_CO_ROUTINES                           0 // CO_ROUTINES are not supported in ESP-IDF
+#define configUSE_CO_ROUTINES              0              /* CO_ROUTINES are not supported in ESP-IDF */
 #define configMAX_CO_ROUTINE_PRIORITIES    2

-// ------------------- Software Timer ----------------------
+/* ------------------- Software Timer ---------------------- */

 #define configUSE_TIMERS                1
 #define configTIMER_TASK_PRIORITY       CONFIG_FREERTOS_TIMER_TASK_PRIORITY
 #define configTIMER_QUEUE_LENGTH        CONFIG_FREERTOS_TIMER_QUEUE_LENGTH
 #define configTIMER_TASK_STACK_DEPTH    CONFIG_FREERTOS_TIMER_TASK_STACK_DEPTH

-// -------------------- API Includes -----------------------
+/* -------------------- API Includes ----------------------- */

 #if CONFIG_FREERTOS_ENABLE_BACKWARD_COMPATIBILITY
    #define configENABLE_BACKWARD_COMPATIBILITY    1
-#else
+#else /* CONFIG_FREERTOS_ENABLE_BACKWARD_COMPATIBILITY */
    #define configENABLE_BACKWARD_COMPATIBILITY    0
-#endif
+#endif /* CONFIG_FREERTOS_ENABLE_BACKWARD_COMPATIBILITY */

 #define INCLUDE_vTaskPrioritySet                   1
 #define INCLUDE_uxTaskPriorityGet                  1
@@ -193,22 +194,23 @@ This file gets pulled into assembly sources. Therefore, some includes need to be
 #define INCLUDE_xTaskResumeFromISR                 1
 #define INCLUDE_xTimerPendFunctionCall             1
 #define INCLUDE_xTaskGetSchedulerState             1
-//Unlisted
+/* Unlisted */
 #define INCLUDE_pxTaskGetStackStart                1

-// -------------------- Trace Macros -----------------------
+/* -------------------- Trace Macros ----------------------- */

 /*
-For trace macros.
-Note: Include trace macros here and not above as trace macros are dependent on some of the FreeRTOS configs
+ * For trace macros.
+ * Note: Include trace macros here and not above as trace macros are dependent on some of the FreeRTOS configs
 */
 #ifndef __ASSEMBLER__
    #if CONFIG_SYSVIEW_ENABLE
        #include "SEGGER_SYSVIEW_FreeRTOS.h"
-#undef INLINE // to avoid redefinition
-#endif //CONFIG_SYSVIEW_ENABLE
+        #undef INLINE /* to avoid redefinition */
+    #endif /* CONFIG_SYSVIEW_ENABLE */

    #if CONFIG_FREERTOS_SMP
+
 /* Default values for trace macros added to ESP-IDF implementation of SYSVIEW
 * that is not part of Amazon SMP FreeRTOS. */
        #ifndef traceISR_EXIT
@@ -245,9 +247,11 @@ Note: Include trace macros here and not above as trace macros are dependent on s
    #define configUSE_CORE_AFFINITY              1
    #define configRUN_MULTIPLE_PRIORITIES        1
    #define configUSE_TASK_PREEMPTION_DISABLE    1
+
 /* This is always enabled to call IDF style idle hooks, by can be "--Wl,--wrap"
 * if users enable CONFIG_FREERTOS_USE_MINIMAL_IDLE_HOOK. */
    #define configUSE_MINIMAL_IDLE_HOOK          1
+
 /* IDF Newlib supports dynamic reentrancy. We provide our own __getreent()
 * function. */
    #define configNEWLIB_REENTRANT_IS_DYNAMIC    1