Microchip® Advanced Software Framework

freertos-7.4.2/Source/include/queue.h File Reference
#include "mpu_wrappers.h"

Macros

#define queueQUEUE_TYPE_BASE   ( 0U )
 
#define queueQUEUE_TYPE_BINARY_SEMAPHORE   ( 3U )
 
#define queueQUEUE_TYPE_COUNTING_SEMAPHORE   ( 2U )
 
#define queueQUEUE_TYPE_MUTEX   ( 1U )
 
#define queueQUEUE_TYPE_RECURSIVE_MUTEX   ( 4U )
 
#define queueQUEUE_TYPE_SET   ( 0U )
 
#define queueSEND_TO_BACK   ( 0 )
 
#define queueSEND_TO_FRONT   ( 1 )
 
#define xQueueAltPeek(xQueue, pvBuffer, xTicksToWait)   xQueueAltGenericReceive( ( xQueue ), ( pvBuffer ), ( xTicksToWait ), pdTRUE )
 
#define xQueueAltReceive(xQueue, pvBuffer, xTicksToWait)   xQueueAltGenericReceive( ( xQueue ), ( pvBuffer ), ( xTicksToWait ), pdFALSE )
 
#define xQueueAltSendToBack(xQueue, pvItemToQueue, xTicksToWait)   xQueueAltGenericSend( ( xQueue ), ( pvItemToQueue ), ( xTicksToWait ), queueSEND_TO_BACK )
 
#define xQueueAltSendToFront(xQueue, pvItemToQueue, xTicksToWait)   xQueueAltGenericSend( ( xQueue ), ( pvItemToQueue ), ( xTicksToWait ), queueSEND_TO_FRONT )
 
#define xQueueCreate(uxQueueLength, uxItemSize)   xQueueGenericCreate( uxQueueLength, uxItemSize, queueQUEUE_TYPE_BASE )
 
#define xQueuePeek(xQueue, pvBuffer, xTicksToWait)   xQueueGenericReceive( ( xQueue ), ( pvBuffer ), ( xTicksToWait ), pdTRUE )
 
#define xQueueReceive(xQueue, pvBuffer, xTicksToWait)   xQueueGenericReceive( ( xQueue ), ( pvBuffer ), ( xTicksToWait ), pdFALSE )
 
#define xQueueReset(xQueue)   xQueueGenericReset( xQueue, pdFALSE )
 
#define xQueueSend(xQueue, pvItemToQueue, xTicksToWait)   xQueueGenericSend( ( xQueue ), ( pvItemToQueue ), ( xTicksToWait ), queueSEND_TO_BACK )
 
#define xQueueSendFromISR(xQueue, pvItemToQueue, pxHigherPriorityTaskWoken)   xQueueGenericSendFromISR( ( xQueue ), ( pvItemToQueue ), ( pxHigherPriorityTaskWoken ), queueSEND_TO_BACK )
 
#define xQueueSendToBack(xQueue, pvItemToQueue, xTicksToWait)   xQueueGenericSend( ( xQueue ), ( pvItemToQueue ), ( xTicksToWait ), queueSEND_TO_BACK )
 
#define xQueueSendToBackFromISR(xQueue, pvItemToQueue, pxHigherPriorityTaskWoken)   xQueueGenericSendFromISR( ( xQueue ), ( pvItemToQueue ), ( pxHigherPriorityTaskWoken ), queueSEND_TO_BACK )
 
#define xQueueSendToFront(xQueue, pvItemToQueue, xTicksToWait)   xQueueGenericSend( ( xQueue ), ( pvItemToQueue ), ( xTicksToWait ), queueSEND_TO_FRONT )
 
#define xQueueSendToFrontFromISR(xQueue, pvItemToQueue, pxHigherPriorityTaskWoken)   xQueueGenericSendFromISR( ( xQueue ), ( pvItemToQueue ), ( pxHigherPriorityTaskWoken ), queueSEND_TO_FRONT )
 

Typedefs

typedef void * xQueueHandle
 Type by which queues are referenced. More...
 
typedef void * xQueueSetHandle
 Type by which queue sets are referenced. More...
 
typedef void * xQueueSetMemberHandle
 Queue sets can contain both queues and semaphores, so the xQueueSetMemberHandle is defined as a type to be used where a parameter or return value can be either an xQueueHandle or an xSemaphoreHandle. More...
 

Functions

unsigned char ucQueueGetQueueType (xQueueHandle xQueue) PRIVILEGED_FUNCTION
 
unsigned portBASE_TYPE uxQueueMessagesWaiting (const xQueueHandle xQueue)
 
unsigned portBASE_TYPE uxQueueMessagesWaitingFromISR (const xQueueHandle xQueue)
 
void vQueueDelete (xQueueHandle xQueue)
 
void vQueueSetQueueNumber (xQueueHandle xQueue, unsigned char ucQueueNumber) PRIVILEGED_FUNCTION
 
void vQueueWaitForMessageRestricted (xQueueHandle xQueue, portTickType xTicksToWait)
 
portBASE_TYPE xQueueAddToSet (xQueueSetMemberHandle xQueueOrSemaphore, xQueueSetHandle xQueueSet)
 
signed portBASE_TYPE xQueueAltGenericReceive (xQueueHandle xQueue, void *const pvBuffer, portTickType xTicksToWait, portBASE_TYPE xJustPeeking)
 
signed portBASE_TYPE xQueueAltGenericSend (xQueueHandle xQueue, const void *const pvItemToQueue, portTickType xTicksToWait, portBASE_TYPE xCopyPosition)
 
xQueueHandle xQueueCreateCountingSemaphore (unsigned portBASE_TYPE uxCountValue, unsigned portBASE_TYPE uxInitialCount)
 
xQueueHandle xQueueCreateMutex (unsigned char ucQueueType)
 
xQueueSetHandle xQueueCreateSet (unsigned portBASE_TYPE uxEventQueueLength)
 
signed portBASE_TYPE xQueueCRReceive (xQueueHandle xQueue, void *pvBuffer, portTickType xTicksToWait)
 
signed portBASE_TYPE xQueueCRReceiveFromISR (xQueueHandle xQueue, void *pvBuffer, signed portBASE_TYPE *pxTaskWoken)
 
signed portBASE_TYPE xQueueCRSend (xQueueHandle xQueue, const void *pvItemToQueue, portTickType xTicksToWait)
 
signed portBASE_TYPE xQueueCRSendFromISR (xQueueHandle xQueue, const void *pvItemToQueue, signed portBASE_TYPE xCoRoutinePreviouslyWoken)
 
xQueueHandle xQueueGenericCreate (unsigned portBASE_TYPE uxQueueLength, unsigned portBASE_TYPE uxItemSize, unsigned char ucQueueType)
 
signed portBASE_TYPE xQueueGenericReceive (xQueueHandle xQueue, void *const pvBuffer, portTickType xTicksToWait, portBASE_TYPE xJustPeek)
 
portBASE_TYPE xQueueGenericReset (xQueueHandle xQueue, portBASE_TYPE xNewQueue)
 
signed portBASE_TYPE xQueueGenericSend (xQueueHandle xQueue, const void *const pvItemToQueue, portTickType xTicksToWait, portBASE_TYPE xCopyPosition)
 
signed portBASE_TYPE xQueueGenericSendFromISR (xQueueHandle xQueue, const void *const pvItemToQueue, signed portBASE_TYPE *pxHigherPriorityTaskWoken, portBASE_TYPE xCopyPosition)
 
void * xQueueGetMutexHolder (xQueueHandle xSemaphore)
 
portBASE_TYPE xQueueGiveMutexRecursive (xQueueHandle pxMutex)
 
signed portBASE_TYPE xQueueIsQueueEmptyFromISR (const xQueueHandle xQueue)
 
signed portBASE_TYPE xQueueIsQueueFullFromISR (const xQueueHandle xQueue)
 
signed portBASE_TYPE xQueueReceiveFromISR (xQueueHandle xQueue, void *const pvBuffer, signed portBASE_TYPE *pxHigherPriorityTaskWoken)
 
portBASE_TYPE xQueueRemoveFromSet (xQueueSetMemberHandle xQueueOrSemaphore, xQueueSetHandle xQueueSet)
 
xQueueSetMemberHandle xQueueSelectFromSet (xQueueSetHandle xQueueSet, portTickType xBlockTimeTicks)
 
xQueueSetMemberHandle xQueueSelectFromSetFromISR (xQueueSetHandle xQueueSet)
 
portBASE_TYPE xQueueTakeMutexRecursive (xQueueHandle xMutex, portTickType xBlockTime)
 

#define queueQUEUE_TYPE_BASE   ( 0U )
#define queueQUEUE_TYPE_BINARY_SEMAPHORE   ( 3U )
#define queueQUEUE_TYPE_COUNTING_SEMAPHORE   ( 2U )
#define queueQUEUE_TYPE_MUTEX   ( 1U )
#define queueQUEUE_TYPE_RECURSIVE_MUTEX   ( 4U )
#define queueQUEUE_TYPE_SET   ( 0U )
#define queueSEND_TO_BACK   ( 0 )
#define queueSEND_TO_FRONT   ( 1 )
#define xQueueAltPeek (   xQueue,
  pvBuffer,
  xTicksToWait 
)    xQueueAltGenericReceive( ( xQueue ), ( pvBuffer ), ( xTicksToWait ), pdTRUE )
#define xQueueAltReceive (   xQueue,
  pvBuffer,
  xTicksToWait 
)    xQueueAltGenericReceive( ( xQueue ), ( pvBuffer ), ( xTicksToWait ), pdFALSE )
#define xQueueAltSendToBack (   xQueue,
  pvItemToQueue,
  xTicksToWait 
)    xQueueAltGenericSend( ( xQueue ), ( pvItemToQueue ), ( xTicksToWait ), queueSEND_TO_BACK )
#define xQueueAltSendToFront (   xQueue,
  pvItemToQueue,
  xTicksToWait 
)    xQueueAltGenericSend( ( xQueue ), ( pvItemToQueue ), ( xTicksToWait ), queueSEND_TO_FRONT )
#define xQueueCreate (   uxQueueLength,
  uxItemSize 
)    xQueueGenericCreate( uxQueueLength, uxItemSize, queueQUEUE_TYPE_BASE )
#define xQueuePeek (   xQueue,
  pvBuffer,
  xTicksToWait 
)    xQueueGenericReceive( ( xQueue ), ( pvBuffer ), ( xTicksToWait ), pdTRUE )
#define xQueueReceive (   xQueue,
  pvBuffer,
  xTicksToWait 
)    xQueueGenericReceive( ( xQueue ), ( pvBuffer ), ( xTicksToWait ), pdFALSE )
#define xQueueReset (   xQueue)    xQueueGenericReset( xQueue, pdFALSE )
#define xQueueSend (   xQueue,
  pvItemToQueue,
  xTicksToWait 
)    xQueueGenericSend( ( xQueue ), ( pvItemToQueue ), ( xTicksToWait ), queueSEND_TO_BACK )
#define xQueueSendFromISR (   xQueue,
  pvItemToQueue,
  pxHigherPriorityTaskWoken 
)    xQueueGenericSendFromISR( ( xQueue ), ( pvItemToQueue ), ( pxHigherPriorityTaskWoken ), queueSEND_TO_BACK )
#define xQueueSendToBack (   xQueue,
  pvItemToQueue,
  xTicksToWait 
)    xQueueGenericSend( ( xQueue ), ( pvItemToQueue ), ( xTicksToWait ), queueSEND_TO_BACK )
#define xQueueSendToBackFromISR (   xQueue,
  pvItemToQueue,
  pxHigherPriorityTaskWoken 
)    xQueueGenericSendFromISR( ( xQueue ), ( pvItemToQueue ), ( pxHigherPriorityTaskWoken ), queueSEND_TO_BACK )
#define xQueueSendToFront (   xQueue,
  pvItemToQueue,
  xTicksToWait 
)    xQueueGenericSend( ( xQueue ), ( pvItemToQueue ), ( xTicksToWait ), queueSEND_TO_FRONT )
#define xQueueSendToFrontFromISR (   xQueue,
  pvItemToQueue,
  pxHigherPriorityTaskWoken 
)    xQueueGenericSendFromISR( ( xQueue ), ( pvItemToQueue ), ( pxHigherPriorityTaskWoken ), queueSEND_TO_FRONT )

typedef void* xQueueHandle

Type by which queues are referenced.

For example, a call to xQueueCreate() returns an xQueueHandle variable that can then be used as a parameter to xQueueSend(), xQueueReceive(), etc.

typedef void* xQueueSetHandle

Type by which queue sets are referenced.

For example, a call to xQueueCreateSet() returns an xQueueSet variable that can then be used as a parameter to xQueueSelectFromSet(), xQueueAddToSet(), etc.

typedef void* xQueueSetMemberHandle

Queue sets can contain both queues and semaphores, so the xQueueSetMemberHandle is defined as a type to be used where a parameter or return value can be either an xQueueHandle or an xSemaphoreHandle.

unsigned char ucQueueGetQueueType ( xQueueHandle  xQueue)
unsigned portBASE_TYPE uxQueueMessagesWaiting ( const xQueueHandle  xQueue)
unsigned portBASE_TYPE uxQueueMessagesWaitingFromISR ( const xQueueHandle  xQueue)
void vQueueDelete ( xQueueHandle  xQueue)
void vQueueSetQueueNumber ( xQueueHandle  xQueue,
unsigned char  ucQueueNumber 
)
void vQueueWaitForMessageRestricted ( xQueueHandle  xQueue,
portTickType  xTicksToWait 
)
portBASE_TYPE xQueueAddToSet ( xQueueSetMemberHandle  xQueueOrSemaphore,
xQueueSetHandle  xQueueSet 
)
signed portBASE_TYPE xQueueAltGenericReceive ( xQueueHandle  xQueue,
void *const  pvBuffer,
portTickType  xTicksToWait,
portBASE_TYPE  xJustPeeking 
)
signed portBASE_TYPE xQueueAltGenericSend ( xQueueHandle  xQueue,
const void *const  pvItemToQueue,
portTickType  xTicksToWait,
portBASE_TYPE  xCopyPosition 
)
xQueueHandle xQueueCreateCountingSemaphore ( unsigned portBASE_TYPE  uxCountValue,
unsigned portBASE_TYPE  uxInitialCount 
)
xQueueHandle xQueueCreateMutex ( unsigned char  ucQueueType)
xQueueSetHandle xQueueCreateSet ( unsigned portBASE_TYPE  uxEventQueueLength)
signed portBASE_TYPE xQueueCRReceive ( xQueueHandle  xQueue,
void *  pvBuffer,
portTickType  xTicksToWait 
)
signed portBASE_TYPE xQueueCRReceiveFromISR ( xQueueHandle  xQueue,
void *  pvBuffer,
signed portBASE_TYPE *  pxTaskWoken 
)
signed portBASE_TYPE xQueueCRSend ( xQueueHandle  xQueue,
const void *  pvItemToQueue,
portTickType  xTicksToWait 
)
signed portBASE_TYPE xQueueCRSendFromISR ( xQueueHandle  xQueue,
const void *  pvItemToQueue,
signed portBASE_TYPE  xCoRoutinePreviouslyWoken 
)
xQueueHandle xQueueGenericCreate ( unsigned portBASE_TYPE  uxQueueLength,
unsigned portBASE_TYPE  uxItemSize,
unsigned char  ucQueueType 
)
signed portBASE_TYPE xQueueGenericReceive ( xQueueHandle  xQueue,
void *const  pvBuffer,
portTickType  xTicksToWait,
portBASE_TYPE  xJustPeek 
)
portBASE_TYPE xQueueGenericReset ( xQueueHandle  xQueue,
portBASE_TYPE  xNewQueue 
)
signed portBASE_TYPE xQueueGenericSend ( xQueueHandle  xQueue,
const void *const  pvItemToQueue,
portTickType  xTicksToWait,
portBASE_TYPE  xCopyPosition 
)
signed portBASE_TYPE xQueueGenericSendFromISR ( xQueueHandle  xQueue,
const void *const  pvItemToQueue,
signed portBASE_TYPE *  pxHigherPriorityTaskWoken,
portBASE_TYPE  xCopyPosition 
)
void* xQueueGetMutexHolder ( xQueueHandle  xSemaphore)
portBASE_TYPE xQueueGiveMutexRecursive ( xQueueHandle  pxMutex)
signed portBASE_TYPE xQueueIsQueueEmptyFromISR ( const xQueueHandle  xQueue)
signed portBASE_TYPE xQueueIsQueueFullFromISR ( const xQueueHandle  xQueue)
signed portBASE_TYPE xQueueReceiveFromISR ( xQueueHandle  xQueue,
void *const  pvBuffer,
signed portBASE_TYPE *  pxHigherPriorityTaskWoken 
)
portBASE_TYPE xQueueRemoveFromSet ( xQueueSetMemberHandle  xQueueOrSemaphore,
xQueueSetHandle  xQueueSet 
)
xQueueSetMemberHandle xQueueSelectFromSet ( xQueueSetHandle  xQueueSet,
portTickType  xBlockTimeTicks 
)
xQueueSetMemberHandle xQueueSelectFromSetFromISR ( xQueueSetHandle  xQueueSet)
portBASE_TYPE xQueueTakeMutexRecursive ( xQueueHandle  xMutex,
portTickType  xBlockTime 
)