stubs.hpp File Reference

Go to the source code of this file.

Macros
#define	errQUEUE_EMPTY   (static_cast<BaseType_t>(0))
#define	errQUEUE_FULL   (static_cast<BaseType_t>(0))
#define	pdFAIL   (pdFALSE)
#define	pdFALSE   (static_cast<BaseType_t>(0))
#define	pdPASS   (pdTRUE)
#define	pdTRUE   (static_cast<BaseType_t>(1))
#define	portYIELD()
#define	taskYIELD()

Typedefs
using	BaseType_t = long
using	configSTACK_DEPTH_TYPE = etl::uint16_t
using	MessageBufferHandle_t = void*
using	QueueHandle_t = QueueDefinition*
using	StreamBufferHandle_t = StreamBufferDef_t*
using	TaskFunction_t = void (*)(void*)
using	TaskHandle_t = tskTaskControlBlock*
using	TickType_t = etl::uint32_t
using	UBaseType_t = unsigned long

Functions
auto	uxQueueMessagesWaiting (QueueHandle_t xQueue) -> UBaseType_t
auto	vPortYield () -> void
auto	vQueueDelete (QueueHandle_t xQueue) -> void
auto	vStreamBufferDelete (StreamBufferHandle_t handle) -> void
auto	vTaskDelay (TickType_t const xTicksToDelay) -> void
auto	vTaskDelayUntil (TickType_t *const pxPreviousWakeTime, TickType_t const xTimeIncrement) -> void
auto	vTaskDelete (TaskHandle_t xTask) -> void
auto	vTaskStartScheduler () -> void
auto	xMessageBufferCreate (etl::size_t bufferSizeBytes) -> MessageBufferHandle_t
auto	xQueueCreate (UBaseType_t uxQueueLength, UBaseType_t uxItemSize) -> QueueHandle_t
auto	xQueueReceive (QueueHandle_t xQueue, void *pvBuffer, TickType_t xTicksToWait) -> BaseType_t
auto	xQueueReset (QueueHandle_t xQueue) -> BaseType_t
auto	xQueueSend (QueueHandle_t xQueue, void const *pvItemToQueue, TickType_t xTicksToWait) -> BaseType_t
auto	xStreamBufferBytesAvailable (StreamBufferHandle_t handle) -> etl::size_t
auto	xStreamBufferCreate (etl::size_t bufferSizeBytes, etl::size_t triggerLevelBytes) -> StreamBufferHandle_t
auto	xStreamBufferIsEmpty (StreamBufferHandle_t handle) -> BaseType_t
auto	xStreamBufferIsFull (StreamBufferHandle_t handle) -> BaseType_t
auto	xStreamBufferReceive (StreamBufferHandle_t handle, void *data, etl::size_t size, TickType_t ticks) -> etl::size_t
auto	xStreamBufferReceiveFromISR (StreamBufferHandle_t handle, void *data, etl::size_t size, BaseType_t *prio) -> etl::size_t
auto	xStreamBufferReset (StreamBufferHandle_t handle) -> BaseType_t
auto	xStreamBufferSend (StreamBufferHandle_t handle, void const *data, etl::size_t size, TickType_t ticksToWait) -> etl::size_t
auto	xStreamBufferSendFromISR (StreamBufferHandle_t handle, void const *data, etl::size_t size, BaseType_t *prio) -> etl::size_t
auto	xStreamBufferSetTriggerLevel (StreamBufferHandle_t handle, etl::size_t triggerLevel) -> BaseType_t
auto	xStreamBufferSpacesAvailable (StreamBufferHandle_t handle) -> etl::size_t
auto	xTaskCreate (TaskFunction_t pvTaskCode, char const *const pcName, configSTACK_DEPTH_TYPE usStackDepth, void *const pvParameters, UBaseType_t uxPriority, TaskHandle_t *const pxCreatedTask) -> BaseType_t

Macro Definition Documentation

errQUEUE_EMPTY

#define errQUEUE_EMPTY   (static_cast<BaseType_t>(0))

errQUEUE_FULL

#define errQUEUE_FULL   (static_cast<BaseType_t>(0))

pdFAIL

#define pdFAIL   (pdFALSE)

pdFALSE

#define pdFALSE   (static_cast<BaseType_t>(0))

pdPASS

#define pdPASS   (pdTRUE)

pdTRUE

#define pdTRUE   (static_cast<BaseType_t>(1))

portYIELD

#define portYIELD

(

)

Value:

vPortYield()

taskYIELD

#define taskYIELD

(

)

Value:

portYIELD()

Typedef Documentation

BaseType_t

using BaseType_t = long

configSTACK_DEPTH_TYPE

using configSTACK_DEPTH_TYPE = etl::uint16_t

MessageBufferHandle_t

using MessageBufferHandle_t = void*

QueueHandle_t

using QueueHandle_t = QueueDefinition*

StreamBufferHandle_t

using StreamBufferHandle_t = StreamBufferDef_t*

TaskFunction_t

using TaskFunction_t = void (*)(void*)

TaskHandle_t

using TaskHandle_t = tskTaskControlBlock*

TickType_t

using TickType_t = etl::uint32_t

UBaseType_t

using UBaseType_t = unsigned long

Function Documentation

uxQueueMessagesWaiting()

auto uxQueueMessagesWaiting ( QueueHandle_t xQueue ) -> UBaseType_t

inline

vPortYield()

auto vPortYield ( ) -> void

inline

vQueueDelete()

auto vQueueDelete ( QueueHandle_t xQueue ) -> void

inline

vStreamBufferDelete()

auto vStreamBufferDelete ( StreamBufferHandle_t handle ) -> void

inline

vTaskDelay()

auto vTaskDelay ( TickType_t const xTicksToDelay ) -> void

inline

vTaskDelayUntil()

auto vTaskDelayUntil ( TickType_t *const pxPreviousWakeTime, TickType_t const xTimeIncrement ) -> void

inline

vTaskDelete()

auto vTaskDelete ( TaskHandle_t xTask ) -> void

inline

vTaskStartScheduler()

auto vTaskStartScheduler ( ) -> void

inline

xMessageBufferCreate()

auto xMessageBufferCreate ( etl::size_t bufferSizeBytes ) -> MessageBufferHandle_t

inlinenodiscard

xQueueCreate()

auto xQueueCreate ( UBaseType_t uxQueueLength, UBaseType_t uxItemSize ) -> QueueHandle_t

inline

xQueueReceive()

auto xQueueReceive ( QueueHandle_t xQueue, void * pvBuffer, TickType_t xTicksToWait ) -> BaseType_t

inline

xQueueReset()

auto xQueueReset ( QueueHandle_t xQueue ) -> BaseType_t

inline

xQueueSend()

auto xQueueSend ( QueueHandle_t xQueue, void const * pvItemToQueue, TickType_t xTicksToWait ) -> BaseType_t

inline

xStreamBufferBytesAvailable()

auto xStreamBufferBytesAvailable ( StreamBufferHandle_t handle ) -> etl::size_t

inlinenodiscard

xStreamBufferCreate()

auto xStreamBufferCreate ( etl::size_t bufferSizeBytes, etl::size_t triggerLevelBytes ) -> StreamBufferHandle_t

inlinenodiscard

xStreamBufferIsEmpty()

auto xStreamBufferIsEmpty ( StreamBufferHandle_t handle ) -> BaseType_t

inlinenodiscard

xStreamBufferIsFull()

auto xStreamBufferIsFull ( StreamBufferHandle_t handle ) -> BaseType_t

inlinenodiscard

xStreamBufferReceive()

auto xStreamBufferReceive ( StreamBufferHandle_t handle, void * data, etl::size_t size, TickType_t ticks ) -> etl::size_t

inlinenodiscard

xStreamBufferReceiveFromISR()

auto xStreamBufferReceiveFromISR ( StreamBufferHandle_t handle, void * data, etl::size_t size, BaseType_t * prio ) -> etl::size_t

inlinenodiscard

xStreamBufferReset()

auto xStreamBufferReset ( StreamBufferHandle_t handle ) -> BaseType_t

inline

xStreamBufferSend()

auto xStreamBufferSend ( StreamBufferHandle_t handle, void const * data, etl::size_t size, TickType_t ticksToWait ) -> etl::size_t

inlinenodiscard

xStreamBufferSendFromISR()

auto xStreamBufferSendFromISR ( StreamBufferHandle_t handle, void const * data, etl::size_t size, BaseType_t * prio ) -> etl::size_t

inlinenodiscard

xStreamBufferSetTriggerLevel()

auto xStreamBufferSetTriggerLevel ( StreamBufferHandle_t handle, etl::size_t triggerLevel ) -> BaseType_t

inline

xStreamBufferSpacesAvailable()

auto xStreamBufferSpacesAvailable ( StreamBufferHandle_t handle ) -> etl::size_t

inlinenodiscard

xTaskCreate()

auto xTaskCreate ( TaskFunction_t pvTaskCode, char const *const pcName, configSTACK_DEPTH_TYPE usStackDepth, void *const pvParameters, UBaseType_t uxPriority, TaskHandle_t *const pxCreatedTask ) -> BaseType_t

inline