STAR
Cal STAR — firmware, DAQ server, and engine design
Loading...
Searching...
No Matches
croutine.h File Reference
#include "list.h"
Include dependency graph for croutine.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

struct  corCoRoutineControlBlock

Macros

#define crSTART(pxCRCB)
#define crEND()
#define crSET_STATE0(xHandle)
#define crSET_STATE1(xHandle)
#define crDELAY(xHandle, xTicksToDelay)
#define crQUEUE_SEND(xHandle, pxQueue, pvItemToQueue, xTicksToWait, pxResult)
#define crQUEUE_RECEIVE(xHandle, pxQueue, pvBuffer, xTicksToWait, pxResult)
#define crQUEUE_SEND_FROM_ISR(pxQueue, pvItemToQueue, xCoRoutinePreviouslyWoken)
#define crQUEUE_RECEIVE_FROM_ISR(pxQueue, pvBuffer, pxCoRoutineWoken)

Typedefs

typedef void * CoRoutineHandle_t
typedef void(* crCOROUTINE_CODE) (CoRoutineHandle_t, UBaseType_t)
typedef struct corCoRoutineControlBlock CRCB_t

Functions

BaseType_t xCoRoutineCreate (crCOROUTINE_CODE pxCoRoutineCode, UBaseType_t uxPriority, UBaseType_t uxIndex)
void vCoRoutineSchedule (void)
void vCoRoutineAddToDelayedList (TickType_t xTicksToDelay, List_t *pxEventList)
BaseType_t xCoRoutineRemoveFromEventList (const List_t *pxEventList)

Macro Definition Documentation

◆ crDELAY

#define crDELAY ( xHandle,
xTicksToDelay )
Value:
do { \
if( ( xTicksToDelay ) > 0 ) \
{ \
vCoRoutineAddToDelayedList( ( xTicksToDelay ), NULL ); \
} \
crSET_STATE0( ( xHandle ) ); \
} while( 0 )
NULL
#define NULL
Definition usbd_def.h:44

Definition at line 310 of file croutine.h.

◆ crEND

#define crEND ( )
Value:
}

Definition at line 249 of file croutine.h.

◆ crQUEUE_RECEIVE

#define crQUEUE_RECEIVE ( xHandle,
pxQueue,
pvBuffer,
xTicksToWait,
pxResult )
Value:
do { \
*( pxResult ) = xQueueCRReceive( ( pxQueue ), ( pvBuffer ), ( xTicksToWait ) ); \
if( *( pxResult ) == errQUEUE_BLOCKED ) \
{ \
crSET_STATE0( ( xHandle ) ); \
*( pxResult ) = xQueueCRReceive( ( pxQueue ), ( pvBuffer ), 0 ); \
} \
if( *( pxResult ) == errQUEUE_YIELD ) \
{ \
crSET_STATE1( ( xHandle ) ); \
*( pxResult ) = pdPASS; \
} \
} while( 0 )
pdPASS
#define pdPASS
Definition projdefs.h:52
errQUEUE_YIELD
#define errQUEUE_YIELD
Definition projdefs.h:60
errQUEUE_BLOCKED
#define errQUEUE_BLOCKED
Definition projdefs.h:59
xQueueCRReceive
BaseType_t xQueueCRReceive(QueueHandle_t xQueue, void *pvBuffer, TickType_t xTicksToWait)

Definition at line 498 of file croutine.h.

◆ crQUEUE_RECEIVE_FROM_ISR

#define crQUEUE_RECEIVE_FROM_ISR ( pxQueue,
pvBuffer,
pxCoRoutineWoken )
Value:
xQueueCRReceiveFromISR( ( pxQueue ), ( pvBuffer ), ( pxCoRoutineWoken ) )
xQueueCRReceiveFromISR
BaseType_t xQueueCRReceiveFromISR(QueueHandle_t xQueue, void *pvBuffer, BaseType_t *pxTaskWoken)

Definition at line 725 of file croutine.h.

◆ crQUEUE_SEND

#define crQUEUE_SEND ( xHandle,
pxQueue,
pvItemToQueue,
xTicksToWait,
pxResult )
Value:
do { \
*( pxResult ) = xQueueCRSend( ( pxQueue ), ( pvItemToQueue ), ( xTicksToWait ) ); \
if( *( pxResult ) == errQUEUE_BLOCKED ) \
{ \
crSET_STATE0( ( xHandle ) ); \
*pxResult = xQueueCRSend( ( pxQueue ), ( pvItemToQueue ), 0 ); \
} \
if( *pxResult == errQUEUE_YIELD ) \
{ \
crSET_STATE1( ( xHandle ) ); \
*pxResult = pdPASS; \
} \
} while( 0 )
xQueueCRSend
BaseType_t xQueueCRSend(QueueHandle_t xQueue, const void *pvItemToQueue, TickType_t xTicksToWait)

Definition at line 404 of file croutine.h.

◆ crQUEUE_SEND_FROM_ISR

#define crQUEUE_SEND_FROM_ISR ( pxQueue,
pvItemToQueue,
xCoRoutinePreviouslyWoken )
Value:
xQueueCRSendFromISR( ( pxQueue ), ( pvItemToQueue ), ( xCoRoutinePreviouslyWoken ) )
xQueueCRSendFromISR
BaseType_t xQueueCRSendFromISR(QueueHandle_t xQueue, const void *pvItemToQueue, BaseType_t xCoRoutinePreviouslyWoken)

Definition at line 609 of file croutine.h.

◆ crSET_STATE0

#define crSET_STATE0 ( xHandle)
Value:
( ( CRCB_t * ) ( xHandle ) )->uxState = ( __LINE__ * 2 ); return; \
case ( __LINE__ * 2 ):
CRCB_t
struct corCoRoutineControlBlock CRCB_t

Definition at line 255 of file croutine.h.

◆ crSET_STATE1

#define crSET_STATE1 ( xHandle)
Value:
( ( CRCB_t * ) ( xHandle ) )->uxState = ( ( __LINE__ * 2 ) + 1 ); return; \
case ( ( __LINE__ * 2 ) + 1 ):

Definition at line 258 of file croutine.h.

◆ crSTART

#define crSTART ( pxCRCB)
Value:
switch( ( ( CRCB_t * ) ( pxCRCB ) )->uxState ) { \
case 0:

Definition at line 214 of file croutine.h.

Typedef Documentation

◆ CoRoutineHandle_t

typedef void* CoRoutineHandle_t

Definition at line 47 of file croutine.h.

◆ CRCB_t

typedef struct corCoRoutineControlBlock CRCB_t

◆ crCOROUTINE_CODE

typedef void(* crCOROUTINE_CODE) (CoRoutineHandle_t, UBaseType_t)

Definition at line 50 of file croutine.h.

Function Documentation

◆ vCoRoutineAddToDelayedList()

void vCoRoutineAddToDelayedList ( TickType_t xTicksToDelay,
List_t * pxEventList )

◆ vCoRoutineSchedule()

void vCoRoutineSchedule ( void )

◆ xCoRoutineCreate()

BaseType_t xCoRoutineCreate ( crCOROUTINE_CODE pxCoRoutineCode,
UBaseType_t uxPriority,
UBaseType_t uxIndex )

◆ xCoRoutineRemoveFromEventList()

BaseType_t xCoRoutineRemoveFromEventList ( const List_t * pxEventList)