From a40e164988ccc5301c3f525867fa1d5f6ed2fc16 Mon Sep 17 00:00:00 2001 From: Angus Gratton Date: Wed, 31 Jul 2019 11:07:23 +0800 Subject: [PATCH 1/2] doc: Add clarifications Xtensa Core ID and "Core ID" used in FreeRTOS are different Closes https://github.com/espressif/esp-idf/issues/2567 --- components/freertos/include/freertos/portmacro.h | 6 +++++- components/freertos/include/freertos/task.h | 6 +++--- components/freertos/include/freertos/xtensa_context.h | 3 +++ 3 files changed, 11 insertions(+), 4 deletions(-) diff --git a/components/freertos/include/freertos/portmacro.h b/components/freertos/include/freertos/portmacro.h index d5df0b274..6b09a2ce8 100644 --- a/components/freertos/include/freertos/portmacro.h +++ b/components/freertos/include/freertos/portmacro.h @@ -136,10 +136,14 @@ typedef unsigned portBASE_TYPE UBaseType_t; /* "mux" data structure (spinlock) */ typedef struct { /* owner field values: - * 0 - Uninitialized (invalid) + * 0 - Uninitialized (invalid) * portMUX_FREE_VAL - Mux is free, can be locked by either CPU * CORE_ID_PRO / CORE_ID_APP - Mux is locked to the particular core * + * Note that for performance reasons we use the full Xtensa CORE ID values + * (CORE_ID_PRO, CORE_ID_APP) and not the 0,1 values which are used in most + * other FreeRTOS code. + * * Any value other than portMUX_FREE_VAL, CORE_ID_PRO, CORE_ID_APP indicates corruption */ uint32_t owner; diff --git a/components/freertos/include/freertos/task.h b/components/freertos/include/freertos/task.h index 3fc06d9e3..8fb6ee22f 100644 --- a/components/freertos/include/freertos/task.h +++ b/components/freertos/include/freertos/task.h @@ -185,7 +185,7 @@ typedef struct xTASK_STATUS StackType_t *pxStackBase; /*!< Points to the lowest address of the task's stack area. */ uint32_t usStackHighWaterMark; /*!< The minimum amount of stack space that has remained for the task since the task was created. The closer this value is to zero the closer the task has come to overflowing its stack. */ #if configTASKLIST_INCLUDE_COREID - BaseType_t xCoreID; /*!< Core this task is pinned to. This field is present if CONFIG_FREERTOS_VTASKLIST_INCLUDE_COREID is set. */ + BaseType_t xCoreID; /*!< Core this task is pinned to (0, 1, or -1 for tskNO_AFFINITY). This field is present if CONFIG_FREERTOS_VTASKLIST_INCLUDE_COREID is set. */ #endif } TaskStatus_t; @@ -324,7 +324,7 @@ is used in assert() statements. */ * * @param xCoreID If the value is tskNO_AFFINITY, the created task is not * pinned to any CPU, and the scheduler can run it on any core available. - * Other values indicate the index number of the CPU which the task should + * Values 0 or 1 indicate the index number of the CPU which the task should * be pinned to. Specifying values larger than (portNUM_PROCESSORS - 1) will * cause the function to fail. * @@ -476,7 +476,7 @@ is used in assert() statements. */ * * @param xCoreID If the value is tskNO_AFFINITY, the created task is not * pinned to any CPU, and the scheduler can run it on any core available. - * Other values indicate the index number of the CPU which the task should + * Values 0 or 1 indicate the index number of the CPU which the task should * be pinned to. Specifying values larger than (portNUM_PROCESSORS - 1) will * cause the function to fail. * diff --git a/components/freertos/include/freertos/xtensa_context.h b/components/freertos/include/freertos/xtensa_context.h index 9e6fe558f..073a137bc 100644 --- a/components/freertos/include/freertos/xtensa_context.h +++ b/components/freertos/include/freertos/xtensa_context.h @@ -325,6 +325,9 @@ STRUCT_END(XtSolFrame) .endm #endif +/* Note: These are different to xCoreID used in ESP-IDF FreeRTOS, we just use + 0 and 1 which are determined by checking bit 13 (see previous comment) +*/ #define CORE_ID_PRO 0xCDCD #define CORE_ID_APP 0xABAB From 4fe74b8f6471d302cd0f7fa812ce53e2dfa01134 Mon Sep 17 00:00:00 2001 From: Angus Gratton Date: Mon, 12 Aug 2019 11:12:34 +1000 Subject: [PATCH 2/2] freertos: Rename CORE_ID_PRO/CORE_ID_APP macros to CORE_ID_REGVAL_xxx Old values remain for compatibility. As suggested in https://github.com/espressif/esp-idf/issues/2567 --- components/freertos/include/freertos/portmacro.h | 6 +++--- .../freertos/include/freertos/xtensa_context.h | 12 +++++++++--- components/freertos/portmux_impl.h | 2 +- components/freertos/portmux_impl.inc.h | 12 ++++++------ 4 files changed, 19 insertions(+), 13 deletions(-) diff --git a/components/freertos/include/freertos/portmacro.h b/components/freertos/include/freertos/portmacro.h index 6b09a2ce8..d6b218465 100644 --- a/components/freertos/include/freertos/portmacro.h +++ b/components/freertos/include/freertos/portmacro.h @@ -138,13 +138,13 @@ typedef struct { /* owner field values: * 0 - Uninitialized (invalid) * portMUX_FREE_VAL - Mux is free, can be locked by either CPU - * CORE_ID_PRO / CORE_ID_APP - Mux is locked to the particular core + * CORE_ID_REGVAL_PRO / CORE_ID_REGVAL_APP - Mux is locked to the particular core * * Note that for performance reasons we use the full Xtensa CORE ID values - * (CORE_ID_PRO, CORE_ID_APP) and not the 0,1 values which are used in most + * (CORE_ID_REGVAL_PRO, CORE_ID_REGVAL_APP) and not the 0,1 values which are used in most * other FreeRTOS code. * - * Any value other than portMUX_FREE_VAL, CORE_ID_PRO, CORE_ID_APP indicates corruption + * Any value other than portMUX_FREE_VAL, CORE_ID_REGVAL_PRO, CORE_ID_REGVAL_APP indicates corruption */ uint32_t owner; /* count field: diff --git a/components/freertos/include/freertos/xtensa_context.h b/components/freertos/include/freertos/xtensa_context.h index 073a137bc..120676dad 100644 --- a/components/freertos/include/freertos/xtensa_context.h +++ b/components/freertos/include/freertos/xtensa_context.h @@ -325,11 +325,17 @@ STRUCT_END(XtSolFrame) .endm #endif -/* Note: These are different to xCoreID used in ESP-IDF FreeRTOS, we just use +/* Note: These are different to xCoreID used in ESP-IDF FreeRTOS, most places use 0 and 1 which are determined by checking bit 13 (see previous comment) */ -#define CORE_ID_PRO 0xCDCD -#define CORE_ID_APP 0xABAB +#define CORE_ID_REGVAL_PRO 0xCDCD +#define CORE_ID_REGVAL_APP 0xABAB + +/* Included for compatibility, recommend using CORE_ID_REGVAL_PRO instead */ +#define CORE_ID_PRO CORE_ID_REGVAL_PRO + +/* Included for compatibility, recommend using CORE_ID_REGVAL_APP instead */ +#define CORE_ID_APP CORE_ID_REGVAL_APP /* ------------------------------------------------------------------------------- diff --git a/components/freertos/portmux_impl.h b/components/freertos/portmux_impl.h index 5aef351b6..691ad01e2 100644 --- a/components/freertos/portmux_impl.h +++ b/components/freertos/portmux_impl.h @@ -49,7 +49,7 @@ #include "soc/soc_memory_layout.h" /* XOR one core ID with this value to get the other core ID */ -#define CORE_ID_XOR_SWAP (CORE_ID_PRO ^ CORE_ID_APP) +#define CORE_ID_REGVAL_XOR_SWAP (CORE_ID_REGVAL_PRO ^ CORE_ID_REGVAL_APP) diff --git a/components/freertos/portmux_impl.inc.h b/components/freertos/portmux_impl.inc.h index 07a7ce9fe..908fec153 100644 --- a/components/freertos/portmux_impl.inc.h +++ b/components/freertos/portmux_impl.inc.h @@ -61,7 +61,7 @@ PORTMUX_AQUIRE_MUX_FN_NAME(portMUX_TYPE *mux, int timeout_cycles) { #ifdef CONFIG_FREERTOS_PORTMUX_DEBUG uint32_t owner = mux->owner; - if (owner != portMUX_FREE_VAL && owner != CORE_ID_PRO && owner != CORE_ID_APP) { + if (owner != portMUX_FREE_VAL && owner != CORE_ID_REGVAL_PRO && owner != CORE_ID_REGVAL_APP) { ets_printf("ERROR: vPortCPUAcquireMutex: mux %p is uninitialized (0x%X)! Called from %s line %d.\n", mux, owner, fnName, line); mux->owner=portMUX_FREE_VAL; } @@ -70,13 +70,13 @@ PORTMUX_AQUIRE_MUX_FN_NAME(portMUX_TYPE *mux, int timeout_cycles) { /* Spin until we own the core */ RSR(PRID, coreID); - /* Note: coreID is the full 32 bit core ID (CORE_ID_PRO/CORE_ID_APP), + /* Note: coreID is the full 32 bit core ID (CORE_ID_REGVAL_PRO/CORE_ID_REGVAL_APP), not the 0/1 value returned by xPortGetCoreID() */ - otherCoreID = CORE_ID_XOR_SWAP ^ coreID; + otherCoreID = CORE_ID_REGVAL_XOR_SWAP ^ coreID; do { - /* mux->owner should be one of portMUX_FREE_VAL, CORE_ID_PRO, - CORE_ID_APP: + /* mux->owner should be one of portMUX_FREE_VAL, CORE_ID_REGVAL_PRO, + CORE_ID_REGVAL_APP: - If portMUX_FREE_VAL, we want to atomically set to 'coreID'. - If "our" coreID, we can drop through immediately. @@ -138,7 +138,7 @@ static inline void PORTMUX_RELEASE_MUX_FN_NAME(portMUX_TYPE *mux) { mux->lastLockedFn=fnName; mux->lastLockedLine=line; uint32_t owner = mux->owner; - if (owner != portMUX_FREE_VAL && owner != CORE_ID_PRO && owner != CORE_ID_APP) { + if (owner != portMUX_FREE_VAL && owner != CORE_ID_REGVAL_PRO && owner != CORE_ID_REGVAL_APP) { ets_printf("ERROR: vPortCPUReleaseMutex: mux %p is invalid (0x%x)!\n", mux, mux->owner); } #endif