SCThreadingSupport.h

Go to the documentation of this file.

/*
 * Copyright (c) 2018 https://www.thecoderscorner.com (Dave Cherry)
 * This product is licensed under an Apache license, see the LICENSE file in the top-level directory.
 */
 
#ifndef SIMPLECOLLECTIONS_SCTHREADINGSUPPORT_H
#define SIMPLECOLLECTIONS_SCTHREADINGSUPPORT_H

 
#if defined(BUILD_FOR_PICO_CMAKE)
#include <pico/stdlib.h>
#elif !defined(__MBED__)
// when not on mbed, we need to load Arduino.h to get the right defines for some boards.
#include <Arduino.h>
#endif

 
// You can add your own local definitions header file here, this enables you to adjust build flags in environments
// where there is no easy way to do so with compiler options. Just create an include file "io_local_definitions.h"
// at the top level of your project source tree. This file will be honoured by all our libraries.
#if defined __has_include
#  if __has_include ("zio_local_definitions.h")
#    include "zio_local_definitions.h"
#  endif
#endif // has include "io_local_definitions"
 
#include <inttypes.h>
 
// START PROCESSOR/BOARD SELECTION BLOCK
#if defined(ARDUINO_PICO_REVISION) || defined(BUILD_FOR_PICO_CMAKE)
typedef volatile uint32_t* position_ptr_t;
typedef volatile uint32_t position_t;
bool casAtomic(position_ptr_t ptr, position_t expected, position_t newVal);
inline position_t readAtomic(position_ptr_t ptr) { return *(ptr); }
void atomicInitialisationSupport();
#define SIMPLECOLLECTIONS_PICO_PHT_SUPPORT
#elif defined(__MBED__) || defined(TMIOA_FORCE_ARDUINO_MBED)
#include <mbed_atomic.h>
typedef volatile uint32_t* position_ptr_t;
typedef volatile uint32_t position_t;
#define atomicInitialisationSupport()
inline bool casAtomic(position_ptr_t ptr, position_t expected, position_t newVal) {
    uint32_t exp = expected;
    return core_util_atomic_cas_u32(ptr, &exp, newVal);
}
inline uint32_t readAtomic(position_ptr_t ptr) { return *(ptr); }
#elif (defined(SC_USE_ARM_ASM_CAS) || defined(ARDUINO_ARCH_STM32)) && !defined(SC_NO_ARM_ASM_CAS)
#define atomicInitialisationSupport()
#include <Arduino.h>
#if __CORTEX_M > 0x03U
#define SIMPLE_COLLECTIONS_ARM_SUPPORT
typedef volatile uint32_t* position_ptr_t;
typedef volatile uint32_t position_t;
bool casAtomic(position_ptr_t ptr, position_t expected, position_t newVal);
inline uint32_t readAtomic(position_ptr_t ptr) { return *(ptr); }
#else
typedef volatile uint32_t* position_ptr_t;
typedef volatile uint32_t position_t;
#define NEEDS_CAS_EMULATION
#endif // __CORTEX_M > 3
#elif defined(ESP8266)
#include <Arduino.h>
typedef volatile uint32_t* position_ptr_t;
typedef volatile uint32_t position_t;
#define atomicInitialisationSupport()
#define NEEDS_CAS_EMULATION
#elif defined(ESP32)
#include <Arduino.h>
typedef volatile uint32_t* position_ptr_t;
typedef volatile uint32_t position_t;
#define atomicInitialisationSupport()
#if ESP_IDF_VERSION < ESP_IDF_VERSION_VAL(5, 0, 0)
inline bool casAtomic(position_ptr_t ptr, position_t expected, position_t newVal) {
    uint32_t exp32 = expected;
    uint32_t new32 = newVal;
    uxPortCompareSet(ptr, exp32, &new32);
    return new32 == expected;
}
#else
inline bool casAtomic(position_ptr_t ptr, position_t expected, position_t newVal) {
    // function added in ESP-IDF v5.0
    return esp_cpu_compare_and_set(ptr, expected, newVal);
}
#endif // ESP_IDF_VERSION < 5
inline uint16_t readAtomic(position_ptr_t ptr) { return *(ptr); }
#else
#include <Arduino.h>
#define atomicInitialisationSupport()
typedef volatile uint16_t* position_ptr_t;
typedef volatile uint16_t position_t;
#define NEEDS_CAS_EMULATION
#endif // PROCESSOR/BOARD SELECTION BLOCK
 
#ifdef NEEDS_CAS_EMULATION
bool casAtomic(position_ptr_t ptr, position_t expected, position_t newVal);
inline uint16_t readAtomic(position_ptr_t ptr) { return *ptr; }
#endif // NEEDS_CAS_EMULATION
 
#endif //SIMPLECOLLECTIONS_SCTHREADINGSUPPORT_H