freertos-7.3.0/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	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(pxQueue)   xQueueGenericReset( pxQueue, pdFALSE )
#define	xQueueSend(xQueue, pvItemToQueue, xTicksToWait)   xQueueGenericSend( ( xQueue ), ( pvItemToQueue ), ( xTicksToWait ), queueSEND_TO_BACK )
#define	xQueueSendFromISR(pxQueue, pvItemToQueue, pxHigherPriorityTaskWoken)   xQueueGenericSendFromISR( ( pxQueue ), ( pvItemToQueue ), ( pxHigherPriorityTaskWoken ), queueSEND_TO_BACK )
#define	xQueueSendToBack(xQueue, pvItemToQueue, xTicksToWait)   xQueueGenericSend( ( xQueue ), ( pvItemToQueue ), ( xTicksToWait ), queueSEND_TO_BACK )
#define	xQueueSendToBackFromISR(pxQueue, pvItemToQueue, pxHigherPriorityTaskWoken)   xQueueGenericSendFromISR( ( pxQueue ), ( pvItemToQueue ), ( pxHigherPriorityTaskWoken ), queueSEND_TO_BACK )
#define	xQueueSendToFront(xQueue, pvItemToQueue, xTicksToWait)   xQueueGenericSend( ( xQueue ), ( pvItemToQueue ), ( xTicksToWait ), queueSEND_TO_FRONT )
#define	xQueueSendToFrontFromISR(pxQueue, pvItemToQueue, pxHigherPriorityTaskWoken)   xQueueGenericSendFromISR( ( pxQueue ), ( pvItemToQueue ), ( pxHigherPriorityTaskWoken ), queueSEND_TO_FRONT )

Typedefs
typedef void *	xQueueHandle
	Type by which queues are referenced. More...

Functions
unsigned portBASE_TYPE	uxQueueMessagesWaiting (const xQueueHandle xQueue)
unsigned portBASE_TYPE	uxQueueMessagesWaitingFromISR (const xQueueHandle pxQueue)
void	vQueueDelete (xQueueHandle pxQueue)
void	vQueueWaitForMessageRestricted (xQueueHandle pxQueue, portTickType xTicksToWait)
signed portBASE_TYPE	xQueueAltGenericReceive (xQueueHandle pxQueue, void *const pvBuffer, portTickType xTicksToWait, portBASE_TYPE xJustPeeking)
signed portBASE_TYPE	xQueueAltGenericSend (xQueueHandle pxQueue, const void *const pvItemToQueue, portTickType xTicksToWait, portBASE_TYPE xCopyPosition)
xQueueHandle	xQueueCreateCountingSemaphore (unsigned portBASE_TYPE uxCountValue, unsigned portBASE_TYPE uxInitialCount)
xQueueHandle	xQueueCreateMutex (unsigned char ucQueueType)
signed portBASE_TYPE	xQueueCRReceive (xQueueHandle pxQueue, void *pvBuffer, portTickType xTicksToWait)
signed portBASE_TYPE	xQueueCRReceiveFromISR (xQueueHandle pxQueue, void *pvBuffer, signed portBASE_TYPE *pxTaskWoken)
signed portBASE_TYPE	xQueueCRSend (xQueueHandle pxQueue, const void *pvItemToQueue, portTickType xTicksToWait)
signed portBASE_TYPE	xQueueCRSendFromISR (xQueueHandle pxQueue, 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 pxQueue, portBASE_TYPE xNewQueue)
signed portBASE_TYPE	xQueueGenericSend (xQueueHandle pxQueue, const void *const pvItemToQueue, portTickType xTicksToWait, portBASE_TYPE xCopyPosition)
signed portBASE_TYPE	xQueueGenericSendFromISR (xQueueHandle pxQueue, 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 pxQueue)
signed portBASE_TYPE	xQueueIsQueueFullFromISR (const xQueueHandle pxQueue)
signed portBASE_TYPE	xQueueReceiveFromISR (xQueueHandle pxQueue, void *const pvBuffer, signed portBASE_TYPE *pxHigherPriorityTaskWoken)
portBASE_TYPE	xQueueTakeMutexRecursive (xQueueHandle pxMutex, 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 queueSEND_TO_BACK   ( 0 )

#define queueSEND_TO_FRONT   ( 1 )

#define xQueueAltPeek	(		xQueue,
			pvBuffer,
			xTicksToWait
	)		xQueueAltGenericReceive( ( xQueue ), ( pvBuffer ), ( xTicksToWait ), pdTRUE )

Referenced by prvSendFrontAndBackTest().

#define xQueueAltReceive	(		xQueue,
			pvBuffer,
			xTicksToWait
	)		xQueueAltGenericReceive( ( xQueue ), ( pvBuffer ), ( xTicksToWait ), pdFALSE )

Referenced by portTASK_FUNCTION(), prvSendFrontAndBackTest(), vPrimaryBlockTimeTestTask(), and vSecondaryBlockTimeTestTask().

#define xQueueAltSendToBack	(		xQueue,
			pvItemToQueue,
			xTicksToWait
	)		xQueueAltGenericSend( ( xQueue ), ( pvItemToQueue ), ( xTicksToWait ), queueSEND_TO_BACK )

Referenced by portTASK_FUNCTION(), prvSendFrontAndBackTest(), vPrimaryBlockTimeTestTask(), and vSecondaryBlockTimeTestTask().

#define xQueueAltSendToFront	(		xQueue,
			pvItemToQueue,
			xTicksToWait
	)		xQueueAltGenericSend( ( xQueue ), ( pvItemToQueue ), ( xTicksToWait ), queueSEND_TO_FRONT )

Referenced by prvSendFrontAndBackTest().

#define xQueueCreate	(		uxQueueLength,
			uxItemSize
	)		xQueueGenericCreate( uxQueueLength, uxItemSize, queueQUEUE_TYPE_BASE )

Referenced by vCreateAltBlockTimeTasks(), vCreateBlockTimeTasks(), vStartAltBlockingQueueTasks(), vStartAltGenericQueueTasks(), vStartAltPolledQueueTasks(), vStartBlockingQueueTasks(), vStartDynamicPriorityTasks(), vStartFlashCoRoutines(), vStartGenericQueueTasks(), vStartHookCoRoutines(), vStartPolledQueueTasks(), and vStartQueuePeekTasks().

#define xQueuePeek	(		xQueue,
			pvBuffer,
			xTicksToWait
	)		xQueueGenericReceive( ( xQueue ), ( pvBuffer ), ( xTicksToWait ), pdTRUE )

Referenced by prvHighestPriorityPeekTask(), prvHighPriorityPeekTask(), prvLowPriorityPeekTask(), prvMediumPriorityPeekTask(), and prvSendFrontAndBackTest().

#define xQueueReceive	(		xQueue,
			pvBuffer,
			xTicksToWait
	)		xQueueGenericReceive( ( xQueue ), ( pvBuffer ), ( xTicksToWait ), pdFALSE )

Referenced by portTASK_FUNCTION(), prvHighestPriorityPeekTask(), prvHighPriorityPeekTask(), prvLowPriorityPeekTask(), prvSendFrontAndBackTest(), vPrimaryBlockTimeTestTask(), and vSecondaryBlockTimeTestTask().

#define xQueueReset

(

pxQueue

)

xQueueGenericReset( pxQueue, pdFALSE )

#define xQueueSend	(		xQueue,
			pvItemToQueue,
			xTicksToWait
	)		xQueueGenericSend( ( xQueue ), ( pvItemToQueue ), ( xTicksToWait ), queueSEND_TO_BACK )

Referenced by portTASK_FUNCTION(), prvSendFrontAndBackTest(), vPrimaryBlockTimeTestTask(), vSecondaryBlockTimeTestTask(), and vStartHookCoRoutines().

#define xQueueSendFromISR	(		pxQueue,
			pvItemToQueue,
			pxHigherPriorityTaskWoken
	)		xQueueGenericSendFromISR( ( pxQueue ), ( pvItemToQueue ), ( pxHigherPriorityTaskWoken ), queueSEND_TO_BACK )

#define xQueueSendToBack	(		xQueue,
			pvItemToQueue,
			xTicksToWait
	)		xQueueGenericSend( ( xQueue ), ( pvItemToQueue ), ( xTicksToWait ), queueSEND_TO_BACK )

Referenced by prvLowPriorityPeekTask(), and prvSendFrontAndBackTest().

#define xQueueSendToBackFromISR	(		pxQueue,
			pvItemToQueue,
			pxHigherPriorityTaskWoken
	)		xQueueGenericSendFromISR( ( pxQueue ), ( pvItemToQueue ), ( pxHigherPriorityTaskWoken ), queueSEND_TO_BACK )

#define xQueueSendToFront	(		xQueue,
			pvItemToQueue,
			xTicksToWait
	)		xQueueGenericSend( ( xQueue ), ( pvItemToQueue ), ( xTicksToWait ), queueSEND_TO_FRONT )

Referenced by prvLowPriorityPeekTask(), and prvSendFrontAndBackTest().

#define xQueueSendToFrontFromISR	(		pxQueue,
			pvItemToQueue,
			pxHigherPriorityTaskWoken
	)		xQueueGenericSendFromISR( ( pxQueue ), ( pvItemToQueue ), ( pxHigherPriorityTaskWoken ), queueSEND_TO_FRONT )

typedef void* xQueueHandle

Type by which queues are referenced.

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

unsigned portBASE_TYPE uxQueueMessagesWaiting

(

const xQueueHandle

xQueue

)

unsigned portBASE_TYPE uxQueueMessagesWaitingFromISR

(

const xQueueHandle

pxQueue

)

void vQueueDelete

(

xQueueHandle

pxQueue

)

void vQueueWaitForMessageRestricted	(	xQueueHandle	pxQueue,
		portTickType	xTicksToWait
	)

signed portBASE_TYPE xQueueAltGenericReceive	(	xQueueHandle	pxQueue,
		void *const	pvBuffer,
		portTickType	xTicksToWait,
		portBASE_TYPE	xJustPeeking
	)

signed portBASE_TYPE xQueueAltGenericSend	(	xQueueHandle	pxQueue,
		const void *const	pvItemToQueue,
		portTickType	xTicksToWait,
		portBASE_TYPE	xCopyPosition
	)

xQueueHandle xQueueCreateCountingSemaphore	(	unsigned portBASE_TYPE	uxCountValue,
		unsigned portBASE_TYPE	uxInitialCount
	)

xQueueHandle xQueueCreateMutex

(

unsigned char

ucQueueType

)

signed portBASE_TYPE xQueueCRReceive	(	xQueueHandle	pxQueue,
		void *	pvBuffer,
		portTickType	xTicksToWait
	)

signed portBASE_TYPE xQueueCRReceiveFromISR	(	xQueueHandle	pxQueue,
		void *	pvBuffer,
		signed portBASE_TYPE *	pxTaskWoken
	)

signed portBASE_TYPE xQueueCRSend	(	xQueueHandle	pxQueue,
		const void *	pvItemToQueue,
		portTickType	xTicksToWait
	)

signed portBASE_TYPE xQueueCRSendFromISR	(	xQueueHandle	pxQueue,
		const void *	pvItemToQueue,
		signed portBASE_TYPE	xCoRoutinePreviouslyWoken
	)

xQueueHandle xQueueGenericCreate	(	unsigned portBASE_TYPE	uxQueueLength,
		unsigned portBASE_TYPE	uxItemSize,
		unsigned char	ucQueueType
	)

References configASSERT, NULL, QueueDefinition::pcHead, pdTRUE, pvPortMalloc(), traceQUEUE_CREATE, traceQUEUE_CREATE_FAILED, QueueDefinition::uxItemSize, QueueDefinition::uxLength, vPortFree(), and xQueueGenericReset().

signed portBASE_TYPE xQueueGenericReceive	(	xQueueHandle	xQueue,
		void *const	pvBuffer,
		portTickType	xTicksToWait,
		portBASE_TYPE	xJustPeek
	)

portBASE_TYPE xQueueGenericReset	(	xQueueHandle	pxQueue,
		portBASE_TYPE	xNewQueue
	)

References configASSERT, listLIST_IS_EMPTY, QueueDefinition::pcHead, QueueDefinition::pcReadFrom, QueueDefinition::pcTail, QueueDefinition::pcWriteTo, pdFALSE, pdPASS, pdTRUE, portYIELD_WITHIN_API, queueUNLOCKED, taskENTER_CRITICAL, taskEXIT_CRITICAL, QueueDefinition::uxItemSize, QueueDefinition::uxLength, QueueDefinition::uxMessagesWaiting, vListInitialise(), QueueDefinition::xRxLock, xTaskRemoveFromEventList(), QueueDefinition::xTasksWaitingToReceive, QueueDefinition::xTasksWaitingToSend, and QueueDefinition::xTxLock.

Referenced by prvInitialiseNewQueue(), and xQueueGenericCreate().

signed portBASE_TYPE xQueueGenericSend	(	xQueueHandle	pxQueue,
		const void *const	pvItemToQueue,
		portTickType	xTicksToWait,
		portBASE_TYPE	xCopyPosition
	)

signed portBASE_TYPE xQueueGenericSendFromISR	(	xQueueHandle	pxQueue,
		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

pxQueue

)

signed portBASE_TYPE xQueueIsQueueFullFromISR

(

const xQueueHandle

pxQueue

)

signed portBASE_TYPE xQueueReceiveFromISR	(	xQueueHandle	pxQueue,
		void *const	pvBuffer,
		signed portBASE_TYPE *	pxHigherPriorityTaskWoken
	)

portBASE_TYPE xQueueTakeMutexRecursive	(	xQueueHandle	pxMutex,
		portTickType	xBlockTime
	)