portmacro.h

/*
 * SPDX-FileCopyrightText: 2019 Gunar Schorcht
 * SPDX-License-Identifier: LGPL-2.1-only
 */
 
/*
 * FreeRTOS to RIOT-OS adaption module for source code compatibility
 */
 
#pragma once
 
#ifndef DOXYGEN
 
#include "stdbool.h"
#include "stdint.h"
 
#ifndef CPU_ESP8266
#include "esp_heap_caps.h"
#include "esp_timer.h"
#include "soc/soc.h"
#endif
 
#include "mutex.h"
#include "irq.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define portBASE_TYPE                   int
#define portUBASE_TYPE                  unsigned portBASE_TYPE
#define portTICK_TYPE                   uint32_t
#define portSTACK_TYPE                  uint8_t
 
#define portMAX_DELAY                   0xFFFFFFFFUL
 
#define portMUX_TYPE                    mutex_t
#define portMUX_INITIALIZE              mutex_init
#define portMUX_INITIALIZER_UNLOCKED    MUTEX_INIT
 
#define portYIELD                       thread_yield_higher
#define portYIELD_FROM_ISR              thread_yield_higher
 
#define portENTER_CRITICAL              vTaskEnterCritical
#define portEXIT_CRITICAL               vTaskExitCritical
#define portENTER_CRITICAL_SAFE         vTaskEnterCritical
#define portEXIT_CRITICAL_SAFE          vTaskExitCritical
#define portENTER_CRITICAL_ISR          vTaskEnterCritical
#define portEXIT_CRITICAL_ISR           vTaskExitCritical
#define portENTER_CRITICAL_NESTED       irq_disable
#define portEXIT_CRITICAL_NESTED        irq_restore
 
#define portSET_INTERRUPT_MASK_FROM_ISR     xPortSetInterruptMaskFromISR
#define portCLEAR_INTERRUPT_MASK_FROM_ISR   vPortClearInterruptMaskFromISR
 
#define errCOULD_NOT_ALLOCATE_REQUIRED_MEMORY    ( -1 )
 
/*
 * NOTE: RIOT generally uses only one CPU, and the second CPU, if there is one,
 * is stalled by default. Defining portNUM_PROCESSORS here as 2 can cause
 * problems. For example, the SYSTIMER counting units are stopped when the
 * second CPU is disabled, which in turn leads to a memory leak because
 * SYSTIMER is used for the esp_timer implementation to delete timers in
 * thread context. Therefore, we define portNUM_PROCESSORS always as 1 even for
 * ESP32x SOCs with 2 CPUs.
 */
#if 0 /* SOC_CPU_CORES_NUM */
#  define portNUM_PROCESSORS            SOC_CPU_CORES_NUM
#else
#  define portNUM_PROCESSORS            1
#endif
 
#define xPortGetCoreID()                PRO_CPU_NUM
#define vPortYield                      portYIELD
 
extern void vTaskEnterCritical(portMUX_TYPE *mux);
extern void vTaskExitCritical(portMUX_TYPE *mux);
 
bool xPortCanYield(void);
 
#ifdef __cplusplus
}
#endif
 
#endif /* DOXYGEN */