2022-05-17 03:21:15 -04:00
/*
2023-01-10 02:13:19 -05:00
* SPDX - FileCopyrightText : 2022 - 2023 Espressif Systems ( Shanghai ) CO LTD
2022-05-17 03:21:15 -04:00
*
* SPDX - License - Identifier : Apache - 2.0
*/
# include "sdkconfig.h"
# include <string.h>
# include "soc/soc_caps.h"
# include "soc/periph_defs.h"
# include "soc/system_reg.h"
# include "hal/systimer_hal.h"
# include "hal/systimer_ll.h"
# include "riscv/rvruntime-frames.h"
2022-07-26 10:07:58 -04:00
# include "riscv/rv_utils.h"
2022-05-17 03:21:15 -04:00
# include "riscv/interrupt.h"
# include "esp_private/crosscore_int.h"
2022-07-21 07:05:21 -04:00
# include "esp_private/esp_int_wdt.h"
# include "esp_private/periph_ctrl.h"
# include "esp_private/systimer.h"
2022-05-17 03:21:15 -04:00
# include "esp_attr.h"
# include "esp_system.h"
# include "esp_heap_caps_init.h"
# include "esp_task_wdt.h"
# include "esp_task.h"
# include "esp_intr_alloc.h"
# include "esp_log.h"
# include "FreeRTOS.h" /* This pulls in portmacro.h */
# include "task.h"
# include "portmacro.h"
2022-07-21 07:14:41 -04:00
# include "esp_memory_utils.h"
2022-05-17 03:21:15 -04:00
# ifdef CONFIG_FREERTOS_SYSTICK_USES_SYSTIMER
# include "soc/periph_defs.h"
# include "soc/system_reg.h"
# include "hal/systimer_hal.h"
# include "hal/systimer_ll.h"
# endif
# ifdef CONFIG_PM_TRACE
# include "esp_private/pm_trace.h"
# endif //CONFIG_PM_TRACE
2022-11-11 02:00:42 -05:00
_Static_assert ( portBYTE_ALIGNMENT = = 16 , " portBYTE_ALIGNMENT must be set to 16 " ) ;
2022-05-17 03:21:15 -04:00
/* ---------------------------------------------------- Variables ------------------------------------------------------
*
* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
2022-11-24 09:20:50 -05:00
BaseType_t uxSchedulerRunning = 0 ; // Duplicate of xSchedulerRunning, accessible to port files
2022-06-09 10:00:03 -04:00
volatile UBaseType_t uxInterruptNesting = 0 ;
2022-06-08 04:52:32 -04:00
portMUX_TYPE port_xTaskLock = portMUX_INITIALIZER_UNLOCKED ;
portMUX_TYPE port_xISRLock = portMUX_INITIALIZER_UNLOCKED ;
2022-06-09 10:00:03 -04:00
volatile BaseType_t xPortSwitchFlag = 0 ;
2022-05-17 03:21:15 -04:00
__attribute__ ( ( aligned ( 16 ) ) ) static StackType_t xIsrStack [ configISR_STACK_SIZE ] ;
StackType_t * xIsrStackTop = & xIsrStack [ 0 ] + ( configISR_STACK_SIZE & ( ~ ( ( portPOINTER_SIZE_TYPE ) portBYTE_ALIGNMENT_MASK ) ) ) ;
2022-06-08 04:52:32 -04:00
// Variables used for IDF style critical sections. These are orthogonal to FreeRTOS critical sections
static UBaseType_t port_uxCriticalNestingIDF = 0 ;
static UBaseType_t port_uxCriticalOldInterruptStateIDF = 0 ;
2022-05-17 03:21:15 -04:00
/* ------------------------------------------------ IDF Compatibility --------------------------------------------------
* - These need to be defined for IDF to compile
* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
2022-06-09 10:00:03 -04:00
// ------------------ Critical Sections --------------------
2022-05-17 03:21:15 -04:00
2022-06-17 03:18:46 -04:00
void vPortEnterCritical ( void )
2022-05-17 03:21:15 -04:00
{
2022-06-09 10:00:03 -04:00
// Save current interrupt threshold and disable interrupts
UBaseType_t old_thresh = ulPortSetInterruptMask ( ) ;
// Update the IDF critical nesting count
port_uxCriticalNestingIDF + + ;
if ( port_uxCriticalNestingIDF = = 1 ) {
// Save a copy of the old interrupt threshold
port_uxCriticalOldInterruptStateIDF = ( UBaseType_t ) old_thresh ;
}
2022-05-17 03:21:15 -04:00
}
2022-06-17 03:18:46 -04:00
void vPortExitCritical ( void )
2022-05-17 03:21:15 -04:00
{
2022-06-09 10:00:03 -04:00
if ( port_uxCriticalNestingIDF > 0 ) {
port_uxCriticalNestingIDF - - ;
if ( port_uxCriticalNestingIDF = = 0 ) {
// Restore the saved interrupt threshold
vPortClearInterruptMask ( ( int ) port_uxCriticalOldInterruptStateIDF ) ;
}
}
2022-05-17 03:21:15 -04:00
}
2022-06-09 10:00:03 -04:00
// ----------------------- System --------------------------
2022-05-17 03:21:15 -04:00
# define STACK_WATCH_AREA_SIZE 32
# define STACK_WATCH_POINT_NUMBER (SOC_CPU_WATCHPOINTS_NUM - 1)
void vPortSetStackWatchpoint ( void * pxStackStart )
{
uint32_t addr = ( uint32_t ) pxStackStart ;
addr = ( addr + ( STACK_WATCH_AREA_SIZE - 1 ) ) & ( ~ ( STACK_WATCH_AREA_SIZE - 1 ) ) ;
esp_cpu_set_watchpoint ( STACK_WATCH_POINT_NUMBER , ( char * ) addr , STACK_WATCH_AREA_SIZE , ESP_CPU_WATCHPOINT_STORE ) ;
}
// ---------------------- Tick Timer -----------------------
BaseType_t xPortSysTickHandler ( void ) ;
2022-06-22 16:00:16 -04:00
# ifdef CONFIG_FREERTOS_SYSTICK_USES_CCOUNT
# ifdef CONFIG_FREERTOS_CORETIMER_0
# define SYSTICK_INTR_ID (ETS_INTERNAL_TIMER0_INTR_SOURCE+ETS_INTERNAL_INTR_SOURCE_OFF)
# endif
# ifdef CONFIG_FREERTOS_CORETIMER_1
# define SYSTICK_INTR_ID (ETS_INTERNAL_TIMER1_INTR_SOURCE+ETS_INTERNAL_INTR_SOURCE_OFF)
# endif
# elif CONFIG_FREERTOS_SYSTICK_USES_SYSTIMER
2022-05-17 03:21:15 -04:00
_Static_assert ( SOC_CPU_CORES_NUM < = SOC_SYSTIMER_ALARM_NUM - 1 , " the number of cores must match the number of core alarms in SYSTIMER " ) ;
void SysTickIsrHandler ( void * arg ) ;
static uint32_t s_handled_systicks [ portNUM_PROCESSORS ] = { 0 } ;
# define SYSTICK_INTR_ID (ETS_SYSTIMER_TARGET0_EDGE_INTR_SOURCE)
/**
* @ brief Set up the systimer peripheral to generate the tick interrupt
*
* Both timer alarms are configured in periodic mode .
* It is done at the same time so SysTicks for both CPUs occur at the same time or very close .
* Shifts a time of triggering interrupts for core 0 and core 1.
*/
void vPortSetupTimer ( void )
{
unsigned cpuid = xPortGetCoreID ( ) ;
# ifdef CONFIG_FREERTOS_CORETIMER_SYSTIMER_LVL3
const unsigned level = ESP_INTR_FLAG_LEVEL3 ;
# else
const unsigned level = ESP_INTR_FLAG_LEVEL1 ;
# endif
/* Systimer HAL layer object */
static systimer_hal_context_t systimer_hal ;
/* set system timer interrupt vector */
ESP_ERROR_CHECK ( esp_intr_alloc ( ETS_SYSTIMER_TARGET0_EDGE_INTR_SOURCE + cpuid , ESP_INTR_FLAG_IRAM | level , SysTickIsrHandler , & systimer_hal , NULL ) ) ;
if ( cpuid = = 0 ) {
2022-07-21 07:05:21 -04:00
periph_module_enable ( PERIPH_SYSTIMER_MODULE ) ;
2022-05-17 03:21:15 -04:00
systimer_hal_init ( & systimer_hal ) ;
2022-07-21 07:05:21 -04:00
systimer_hal_tick_rate_ops_t ops = {
. ticks_to_us = systimer_ticks_to_us ,
. us_to_ticks = systimer_us_to_ticks ,
} ;
systimer_hal_set_tick_rate_ops ( & systimer_hal , & ops ) ;
2023-01-10 02:13:19 -05:00
systimer_ll_set_counter_value ( systimer_hal . dev , SYSTIMER_COUNTER_OS_TICK , 0 ) ;
systimer_ll_apply_counter_value ( systimer_hal . dev , SYSTIMER_COUNTER_OS_TICK ) ;
2022-05-17 03:21:15 -04:00
for ( cpuid = 0 ; cpuid < SOC_CPU_CORES_NUM ; cpuid + + ) {
2023-06-19 09:57:02 -04:00
// Set stall option and alarm mode to default state. Below they will be set to a required state.
2023-01-10 02:13:19 -05:00
systimer_hal_counter_can_stall_by_cpu ( & systimer_hal , SYSTIMER_COUNTER_OS_TICK , cpuid , false ) ;
2023-06-19 09:57:02 -04:00
uint32_t alarm_id = SYSTIMER_ALARM_OS_TICK_CORE0 + cpuid ;
systimer_hal_select_alarm_mode ( & systimer_hal , alarm_id , SYSTIMER_ALARM_MODE_ONESHOT ) ;
2022-05-17 03:21:15 -04:00
}
for ( cpuid = 0 ; cpuid < portNUM_PROCESSORS ; + + cpuid ) {
2023-01-10 02:13:19 -05:00
uint32_t alarm_id = SYSTIMER_ALARM_OS_TICK_CORE0 + cpuid ;
2022-05-17 03:21:15 -04:00
/* configure the timer */
2023-01-10 02:13:19 -05:00
systimer_hal_connect_alarm_counter ( & systimer_hal , alarm_id , SYSTIMER_COUNTER_OS_TICK ) ;
2022-05-17 03:21:15 -04:00
systimer_hal_set_alarm_period ( & systimer_hal , alarm_id , 1000000UL / CONFIG_FREERTOS_HZ ) ;
systimer_hal_select_alarm_mode ( & systimer_hal , alarm_id , SYSTIMER_ALARM_MODE_PERIOD ) ;
2023-01-10 02:13:19 -05:00
systimer_hal_counter_can_stall_by_cpu ( & systimer_hal , SYSTIMER_COUNTER_OS_TICK , cpuid , true ) ;
2022-05-17 03:21:15 -04:00
if ( cpuid = = 0 ) {
systimer_hal_enable_alarm_int ( & systimer_hal , alarm_id ) ;
2023-01-10 02:13:19 -05:00
systimer_hal_enable_counter ( & systimer_hal , SYSTIMER_COUNTER_OS_TICK ) ;
2022-05-17 03:21:15 -04:00
# ifndef CONFIG_FREERTOS_UNICORE
// SysTick of core 0 and core 1 are shifted by half of period
2023-01-10 02:13:19 -05:00
systimer_hal_counter_value_advance ( & systimer_hal , SYSTIMER_COUNTER_OS_TICK , 1000000UL / CONFIG_FREERTOS_HZ / 2 ) ;
2022-05-17 03:21:15 -04:00
# endif
}
}
} else {
2023-01-10 02:13:19 -05:00
uint32_t alarm_id = SYSTIMER_ALARM_OS_TICK_CORE0 + cpuid ;
2022-05-17 03:21:15 -04:00
systimer_hal_enable_alarm_int ( & systimer_hal , alarm_id ) ;
}
}
/**
* @ brief Systimer interrupt handler .
*
* The Systimer interrupt for SysTick works in periodic mode no need to calc the next alarm .
* If a timer interrupt is ever serviced more than one tick late , it is necessary to process multiple ticks .
*/
IRAM_ATTR void SysTickIsrHandler ( void * arg )
{
uint32_t cpuid = xPortGetCoreID ( ) ;
systimer_hal_context_t * systimer_hal = ( systimer_hal_context_t * ) arg ;
# ifdef CONFIG_PM_TRACE
ESP_PM_TRACE_ENTER ( TICK , cpuid ) ;
# endif
2023-01-10 02:13:19 -05:00
uint32_t alarm_id = SYSTIMER_ALARM_OS_TICK_CORE0 + cpuid ;
2022-05-17 03:21:15 -04:00
do {
systimer_ll_clear_alarm_int ( systimer_hal - > dev , alarm_id ) ;
2023-01-10 02:13:19 -05:00
uint32_t diff = systimer_hal_get_counter_value ( systimer_hal , SYSTIMER_COUNTER_OS_TICK ) / systimer_ll_get_alarm_period ( systimer_hal - > dev , alarm_id ) - s_handled_systicks [ cpuid ] ;
2022-05-17 03:21:15 -04:00
if ( diff > 0 ) {
if ( s_handled_systicks [ cpuid ] = = 0 ) {
s_handled_systicks [ cpuid ] = diff ;
diff = 1 ;
} else {
s_handled_systicks [ cpuid ] + = diff ;
}
do {
xPortSysTickHandler ( ) ;
} while ( - - diff ) ;
}
} while ( systimer_ll_is_alarm_int_fired ( systimer_hal - > dev , alarm_id ) ) ;
# ifdef CONFIG_PM_TRACE
ESP_PM_TRACE_EXIT ( TICK , cpuid ) ;
# endif
}
# endif // CONFIG_FREERTOS_SYSTICK_USES_SYSTIMER
/* ---------------------------------------------- Port Implementations -------------------------------------------------
* Implementations of Porting Interface functions
* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
// --------------------- Interrupts ------------------------
2022-06-09 10:00:03 -04:00
UBaseType_t ulPortSetInterruptMask ( void )
{
int ret ;
unsigned old_mstatus = RV_CLEAR_CSR ( mstatus , MSTATUS_MIE ) ;
ret = REG_READ ( INTERRUPT_CORE0_CPU_INT_THRESH_REG ) ;
REG_WRITE ( INTERRUPT_CORE0_CPU_INT_THRESH_REG , RVHAL_EXCM_LEVEL ) ;
RV_SET_CSR ( mstatus , old_mstatus & MSTATUS_MIE ) ;
/**
* In theory , this function should not return immediately as there is a
* delay between the moment we mask the interrupt threshold register and
* the moment a potential lower - priority interrupt is triggered ( as said
* above ) , it should have a delay of 2 machine cycles / instructions .
*
* However , in practice , this function has an epilogue of one instruction ,
* thus the instruction masking the interrupt threshold register is
* followed by two instructions : ` ret ` and ` csrrs ` ( RV_SET_CSR ) .
* That ' s why we don ' t need any additional nop instructions here .
*/
return ret ;
}
void vPortClearInterruptMask ( UBaseType_t mask )
{
REG_WRITE ( INTERRUPT_CORE0_CPU_INT_THRESH_REG , mask ) ;
/**
* The delay between the moment we unmask the interrupt threshold register
* and the moment the potential requested interrupt is triggered is not
* null : up to three machine cycles / instructions can be executed .
*
* When compilation size optimization is enabled , this function and its
* callers returning void will have NO epilogue , thus the instruction
* following these calls will be executed .
*
* If the requested interrupt is a context switch to a higher priority
* task then the one currently running , we MUST NOT execute any instruction
* before the interrupt effectively happens .
* In order to prevent this , force this routine to have a 3 - instruction
* delay before exiting .
*/
asm volatile ( " nop " ) ;
asm volatile ( " nop " ) ;
asm volatile ( " nop " ) ;
}
2022-05-17 03:21:15 -04:00
BaseType_t xPortCheckIfInISR ( void )
{
return uxInterruptNesting ;
}
// ------------------ Critical Sections --------------------
2022-06-09 10:00:03 -04:00
void IRAM_ATTR vPortTakeLock ( portMUX_TYPE * lock )
2022-05-17 03:21:15 -04:00
{
spinlock_acquire ( lock , portMUX_NO_TIMEOUT ) ;
}
2022-06-09 10:00:03 -04:00
void IRAM_ATTR vPortReleaseLock ( portMUX_TYPE * lock )
2022-05-17 03:21:15 -04:00
{
spinlock_release ( lock ) ;
}
// ---------------------- Yielding -------------------------
2022-06-09 10:00:03 -04:00
void vPortYield ( void )
{
if ( uxInterruptNesting ) {
vPortYieldFromISR ( ) ;
} else {
esp_crosscore_int_send_yield ( 0 ) ;
/* There are 3-4 instructions of latency between triggering the software
interrupt and the CPU interrupt happening . Make sure it happened before
we return , otherwise vTaskDelay ( ) may return and execute 1 - 2
instructions before the delay actually happens .
( We could use the WFI instruction here , but there is a chance that
the interrupt will happen while evaluating the other two conditions
for an instant yield , and if that happens then the WFI would be
waiting for the next interrupt to occur . . . )
*/
while ( uxSchedulerRunning & & REG_READ ( SYSTEM_CPU_INTR_FROM_CPU_0_REG ) ! = 0 ) { }
}
}
void vPortYieldFromISR ( void )
{
//traceISR_EXIT_TO_SCHEDULER();
uxSchedulerRunning = 1 ;
xPortSwitchFlag = 1 ;
}
2022-05-17 03:21:15 -04:00
/* ------------------------------------------------ FreeRTOS Portable --------------------------------------------------
* - Provides implementation for functions required by FreeRTOS
* - Declared in portable . h
* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
// ----------------- Scheduler Start/End -------------------
BaseType_t xPortStartScheduler ( void )
{
uxInterruptNesting = 0 ;
2022-06-08 04:52:32 -04:00
port_uxCriticalNestingIDF = 0 ;
2022-05-17 03:21:15 -04:00
uxSchedulerRunning = 0 ;
/* Setup the hardware to generate the tick. */
vPortSetupTimer ( ) ;
esprv_intc_int_set_threshold ( 1 ) ; /* set global INTC masking level */
2022-07-26 10:07:58 -04:00
rv_utils_intr_global_enable ( ) ;
2022-05-17 03:21:15 -04:00
vPortYield ( ) ;
/*Should not get here*/
return pdFALSE ;
}
void vPortEndScheduler ( void )
{
/* very unlikely this function will be called, so just trap here */
abort ( ) ;
}
// ------------------------ Stack --------------------------
2022-09-27 06:17:13 -04:00
/**
* @ brief Align stack pointer in a downward growing stack
*
* This macro is used to round a stack pointer downwards to the nearest n - byte boundary , where n is a power of 2.
* This macro is generally used when allocating aligned areas on a downward growing stack .
*/
# define STACKPTR_ALIGN_DOWN(n, ptr) ((ptr) & (~((n)-1)))
/**
* @ brief Allocate and initialize GCC TLS area
*
* This function allocates and initializes the area on the stack used to store GCC TLS ( Thread Local Storage ) variables .
* - The area ' s size is derived from the TLS section ' s linker variables , and rounded up to a multiple of 16 bytes
* - The allocated area is aligned to a 16 - byte aligned address
* - The TLS variables in the area are then initialized
*
* Each task access the TLS variables using the THREADPTR register plus an offset to obtain the address of the variable .
* The value for the THREADPTR register is also calculated by this function , and that value should be use to initialize
* the THREADPTR register .
*
* @ param [ in ] uxStackPointer Current stack pointer address
* @ param [ out ] ret_threadptr_reg_init Calculated THREADPTR register initialization value
* @ return Stack pointer that points to the TLS area
*/
FORCE_INLINE_ATTR UBaseType_t uxInitialiseStackTLS ( UBaseType_t uxStackPointer , uint32_t * ret_threadptr_reg_init )
2022-05-17 03:21:15 -04:00
{
2022-09-27 06:17:13 -04:00
/*
TLS layout at link - time , where 0 xNNN is the offset that the linker calculates to a particular TLS variable .
LOW ADDRESS
| - - - - - - - - - - - - - - - - - - - - - - - - - - - | Linker Symbols
| Section | - - - - - - - - - - - - - -
| . flash . rodata |
0x0 | - - - - - - - - - - - - - - - - - - - - - - - - - - - | < - _flash_rodata_start
^ | Other Data |
| | - - - - - - - - - - - - - - - - - - - - - - - - - - - | < - _thread_local_start
| | . tbss | ^
V | | |
0 xNNN | int example ; | | tls_area_size
| | |
| . tdata | V
| - - - - - - - - - - - - - - - - - - - - - - - - - - - | < - _thread_local_end
| Other data |
| . . . |
| - - - - - - - - - - - - - - - - - - - - - - - - - - - |
HIGH ADDRESS
*/
// Calculate TLS area size and round up to multiple of 16 bytes.
2022-05-17 03:21:15 -04:00
extern char _thread_local_start , _thread_local_end , _flash_rodata_start ;
2022-09-27 06:17:13 -04:00
const uint32_t tls_area_size = ALIGNUP ( 16 , ( uint32_t ) & _thread_local_end - ( uint32_t ) & _thread_local_start ) ;
// TODO: check that TLS area fits the stack
// Allocate space for the TLS area on the stack. The area must be aligned to 16-bytes
uxStackPointer = STACKPTR_ALIGN_DOWN ( 16 , uxStackPointer - ( UBaseType_t ) tls_area_size ) ;
// Initialize the TLS area with the initialization values of each TLS variable
memcpy ( ( void * ) uxStackPointer , & _thread_local_start , tls_area_size ) ;
/*
Calculate the THREADPTR register ' s initialization value based on the link - time offset and the TLS area allocated on
the stack .
HIGH ADDRESS
| - - - - - - - - - - - - - - - - - - - - - - - - - - - |
| . tdata ( * ) |
^ | int example ; |
| | |
| | . tbss ( * ) |
| | - - - - - - - - - - - - - - - - - - - - - - - - - - - | < - uxStackPointer ( start of TLS area )
0 xNNN | | | ^
| | | |
| . . . | _thread_local_start - _rodata_start
| | | |
| | | V
V | | < - threadptr register ' s value
LOW ADDRESS
*/
* ret_threadptr_reg_init = ( uint32_t ) uxStackPointer - ( ( uint32_t ) & _thread_local_start - ( uint32_t ) & _flash_rodata_start ) ;
return uxStackPointer ;
}
2022-05-17 03:21:15 -04:00
2022-10-27 06:41:19 -04:00
# if CONFIG_FREERTOS_TASK_FUNCTION_WRAPPER
2023-02-01 13:17:28 -05:00
static void vPortTaskWrapper ( TaskFunction_t pxCode , void * pvParameters )
2022-10-27 06:41:19 -04:00
{
2023-02-01 13:17:28 -05:00
__asm__ volatile ( " .cfi_undefined ra " ) ; // tell to debugger that it's outermost (inital) frame
2022-10-27 06:41:19 -04:00
extern void __attribute__ ( ( noreturn ) ) panic_abort ( const char * details ) ;
static char DRAM_ATTR msg [ 80 ] = " FreeRTOS: FreeRTOS Task \" \0 " ;
pxCode ( pvParameters ) ;
2023-02-01 13:17:28 -05:00
/* FreeRTOS tasks should not return. Log the task name and abort. */
2022-10-27 06:41:19 -04:00
/* We cannot use s(n)printf because it is in flash */
2023-02-01 13:17:28 -05:00
strcat ( msg , pcTaskGetName ( NULL ) ) ;
2022-10-27 06:41:19 -04:00
strcat ( msg , " \" should not return, Aborting now! " ) ;
panic_abort ( msg ) ;
}
# endif // CONFIG_FREERTOS_TASK_FUNCTION_WRAPPER
2022-09-27 06:17:13 -04:00
/**
* @ brief Initialize the task ' s starting interrupt stack frame
*
* This function initializes the task ' s starting interrupt stack frame . The dispatcher will use this stack frame in a
* context restore routine . Therefore , the starting stack frame must be initialized as if the task was interrupted right
* before its first instruction is called .
*
* - The stack frame is allocated to a 16 - byte aligned address
*
* @ param [ in ] uxStackPointer Current stack pointer address
* @ param [ in ] pxCode Task function
* @ param [ in ] pvParameters Task function ' s parameter
* @ param [ in ] threadptr_reg_init THREADPTR register initialization value
* @ return Stack pointer that points to the stack frame
*/
FORCE_INLINE_ATTR UBaseType_t uxInitialiseStackFrame ( UBaseType_t uxStackPointer , TaskFunction_t pxCode , void * pvParameters , uint32_t threadptr_reg_init )
{
/*
Allocate space for the task ' s starting interrupt stack frame .
- The stack frame must be allocated to a 16 - byte aligned address .
- We use RV_STK_FRMSZ ( instead of sizeof ( RvExcFrame ) ) as it rounds up the total size to a multiple of 16.
*/
uxStackPointer = STACKPTR_ALIGN_DOWN ( 16 , uxStackPointer - RV_STK_FRMSZ ) ;
// Clear the entire interrupt stack frame
RvExcFrame * frame = ( RvExcFrame * ) uxStackPointer ;
memset ( frame , 0 , sizeof ( RvExcFrame ) ) ;
2022-10-27 06:41:19 -04:00
/* Initialize the stack frame. */
2022-09-27 06:17:13 -04:00
extern uint32_t __global_pointer $ ;
2022-10-27 06:41:19 -04:00
# if CONFIG_FREERTOS_TASK_FUNCTION_WRAPPER
frame - > mepc = ( UBaseType_t ) vPortTaskWrapper ;
frame - > a0 = ( UBaseType_t ) pxCode ;
frame - > a1 = ( UBaseType_t ) pvParameters ;
# else
frame - > mepc = ( UBaseType_t ) pxCode ;
frame - > a0 = ( UBaseType_t ) pvParameters ;
# endif // CONFIG_FREERTOS_TASK_FUNCTION_WRAPPER
2022-05-17 03:21:15 -04:00
frame - > gp = ( UBaseType_t ) & __global_pointer $ ;
2022-09-27 06:17:13 -04:00
frame - > tp = ( UBaseType_t ) threadptr_reg_init ;
2022-05-17 03:21:15 -04:00
2022-09-27 06:17:13 -04:00
return uxStackPointer ;
}
StackType_t * pxPortInitialiseStack ( StackType_t * pxTopOfStack , TaskFunction_t pxCode , void * pvParameters )
{
2022-12-13 06:02:42 -05:00
# ifdef __clang_analyzer__
// Teach clang-tidy that pxTopOfStack cannot be a pointer to const
volatile StackType_t * pxTemp = pxTopOfStack ;
pxTopOfStack = pxTemp ;
# endif /*__clang_analyzer__ */
2022-09-27 06:17:13 -04:00
/*
HIGH ADDRESS
| - - - - - - - - - - - - - - - - - - - - - - - - - - - | < - pxTopOfStack on entry
| TLS Variables |
| - - - - - - - - - - - - - - - - - - - - - - - - - | < - Start of useable stack
| Starting stack frame |
| - - - - - - - - - - - - - - - - - - - - - - - - - | < - pxTopOfStack on return ( which is the tasks current SP )
| | |
| | |
| V |
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - < - Bottom of stack
LOW ADDRESS
- All stack areas are aligned to 16 byte boundary
- We use UBaseType_t for all of stack area initialization functions for more convenient pointer arithmetic
*/
UBaseType_t uxStackPointer = ( UBaseType_t ) pxTopOfStack ;
2022-11-11 02:00:42 -05:00
configASSERT ( ( uxStackPointer & portBYTE_ALIGNMENT_MASK ) = = 0 ) ;
2022-09-27 06:17:13 -04:00
// Initialize GCC TLS area
uint32_t threadptr_reg_init ;
uxStackPointer = uxInitialiseStackTLS ( uxStackPointer , & threadptr_reg_init ) ;
2022-11-11 02:00:42 -05:00
configASSERT ( ( uxStackPointer & portBYTE_ALIGNMENT_MASK ) = = 0 ) ;
2022-09-27 06:17:13 -04:00
// Initialize the starting interrupt stack frame
uxStackPointer = uxInitialiseStackFrame ( uxStackPointer , pxCode , pvParameters , threadptr_reg_init ) ;
2022-11-11 02:00:42 -05:00
configASSERT ( ( uxStackPointer & portBYTE_ALIGNMENT_MASK ) = = 0 ) ;
2022-09-27 06:17:13 -04:00
// Return the task's current stack pointer address which should point to the starting interrupt stack frame
return ( StackType_t * ) uxStackPointer ;
2022-05-17 03:21:15 -04:00
//TODO: IDF-2393
}
// ------- Thread Local Storage Pointers Deletion Callbacks -------
# if ( CONFIG_FREERTOS_TLSP_DELETION_CALLBACKS )
2022-07-21 07:05:21 -04:00
void vPortTLSPointersDelCb ( void * pxTCB )
2022-05-17 03:21:15 -04:00
{
/* Typecast pxTCB to StaticTask_t type to access TCB struct members.
* pvDummy15 corresponds to pvThreadLocalStoragePointers member of the TCB .
*/
StaticTask_t * tcb = ( StaticTask_t * ) pxTCB ;
/* The TLSP deletion callbacks are stored at an offset of (configNUM_THREAD_LOCAL_STORAGE_POINTERS/2) */
TlsDeleteCallbackFunction_t * pvThreadLocalStoragePointersDelCallback = ( TlsDeleteCallbackFunction_t * ) ( & ( tcb - > pvDummy15 [ ( configNUM_THREAD_LOCAL_STORAGE_POINTERS / 2 ) ] ) ) ;
/* We need to iterate over half the depth of the pvThreadLocalStoragePointers area
* to access all TLS pointers and their respective TLS deletion callbacks .
*/
2022-07-21 07:05:21 -04:00
for ( int x = 0 ; x < ( configNUM_THREAD_LOCAL_STORAGE_POINTERS / 2 ) ; x + + ) {
if ( pvThreadLocalStoragePointersDelCallback [ x ] ! = NULL ) { //If del cb is set
2022-05-17 03:21:15 -04:00
/* In case the TLSP deletion callback has been overwritten by a TLS pointer, gracefully abort. */
if ( ! esp_ptr_executable ( pvThreadLocalStoragePointersDelCallback [ x ] ) ) {
ESP_LOGE ( " FreeRTOS " , " Fatal error: TLSP deletion callback at index %d overwritten with non-excutable pointer %p " , x , pvThreadLocalStoragePointersDelCallback [ x ] ) ;
abort ( ) ;
}
pvThreadLocalStoragePointersDelCallback [ x ] ( x , tcb - > pvDummy15 [ x ] ) ; //Call del cb
}
}
}
# endif // CONFIG_FREERTOS_TLSP_DELETION_CALLBACKS
// -------------------- Tick Handler -----------------------
extern void esp_vApplicationIdleHook ( void ) ;
extern void esp_vApplicationTickHook ( void ) ;
BaseType_t xPortSysTickHandler ( void )
{
# if configBENCHMARK
portbenchmarkIntLatency ( ) ;
# endif //configBENCHMARK
traceISR_ENTER ( SYSTICK_INTR_ID ) ;
BaseType_t ret = xTaskIncrementTick ( ) ;
//Manually call the IDF tick hooks
esp_vApplicationTickHook ( ) ;
2022-07-21 07:05:21 -04:00
if ( ret ! = pdFALSE ) {
2022-05-17 03:21:15 -04:00
portYIELD_FROM_ISR ( ) ;
} else {
traceISR_EXIT ( ) ;
}
return ret ;
}
// ------------------- Hook Functions ----------------------
void __attribute__ ( ( weak ) ) vApplicationStackOverflowHook ( TaskHandle_t xTask , char * pcTaskName )
{
# define ERR_STR1 "***ERROR*** A stack overflow in task "
# define ERR_STR2 " has been detected."
const char * str [ ] = { ERR_STR1 , pcTaskName , ERR_STR2 } ;
char buf [ sizeof ( ERR_STR1 ) + CONFIG_FREERTOS_MAX_TASK_NAME_LEN + sizeof ( ERR_STR2 ) + 1 /* null char */ ] = { 0 } ;
char * dest = buf ;
for ( int i = 0 ; i < sizeof ( str ) / sizeof ( str [ 0 ] ) ; i + + ) {
dest = strcat ( dest , str [ i ] ) ;
}
esp_system_abort ( buf ) ;
}
# if ( configUSE_TICK_HOOK > 0 )
void vApplicationTickHook ( void )
{
esp_vApplicationTickHook ( ) ;
}
# endif
# if CONFIG_FREERTOS_USE_MINIMAL_IDLE_HOOK
/*
By default , the port uses vApplicationMinimalIdleHook ( ) to run IDF style idle
hooks . However , users may also want to provide their own vApplicationMinimalIdleHook ( ) .
In this case , we use to - Wl , - - wrap option to wrap the user provided vApplicationMinimalIdleHook ( )
*/
extern void __real_vApplicationMinimalIdleHook ( void ) ;
void __wrap_vApplicationMinimalIdleHook ( void )
{
esp_vApplicationIdleHook ( ) ; //Run IDF style hooks
__real_vApplicationMinimalIdleHook ( ) ; //Call the user provided vApplicationMinimalIdleHook()
}
# else // CONFIG_FREERTOS_USE_MINIMAL_IDLE_HOOK
void vApplicationMinimalIdleHook ( void )
{
esp_vApplicationIdleHook ( ) ; //Run IDF style hooks
}
# endif // CONFIG_FREERTOS_USE_MINIMAL_IDLE_HOOK
/*
* Hook function called during prvDeleteTCB ( ) to cleanup any
* user defined static memory areas in the TCB .
*/
2022-11-10 07:40:40 -05:00
# if CONFIG_FREERTOS_ENABLE_STATIC_TASK_CLEAN_UP
void __real_vPortCleanUpTCB ( void * pxTCB ) ;
void __wrap_vPortCleanUpTCB ( void * pxTCB )
# else
2022-05-17 03:21:15 -04:00
void vPortCleanUpTCB ( void * pxTCB )
2022-11-10 07:40:40 -05:00
# endif /* CONFIG_FREERTOS_ENABLE_STATIC_TASK_CLEAN_UP */
2022-05-17 03:21:15 -04:00
{
2022-11-10 07:40:40 -05:00
# if ( CONFIG_FREERTOS_ENABLE_STATIC_TASK_CLEAN_UP )
/* Call user defined vPortCleanUpTCB */
__real_vPortCleanUpTCB ( pxTCB ) ;
# endif /* CONFIG_FREERTOS_ENABLE_STATIC_TASK_CLEAN_UP */
2022-05-17 03:21:15 -04:00
# if ( CONFIG_FREERTOS_TLSP_DELETION_CALLBACKS )
/* Call TLS pointers deletion callbacks */
vPortTLSPointersDelCb ( pxTCB ) ;
# endif /* CONFIG_FREERTOS_TLSP_DELETION_CALLBACKS */
}