queue.h File Reference

Macros
#define	queueSEND_TO_BACK
#define	queueSEND_TO_FRONT
#define	queueOVERWRITE
#define	queueQUEUE_TYPE_BASE
#define	queueQUEUE_TYPE_SET
#define	queueQUEUE_TYPE_MUTEX
#define	queueQUEUE_TYPE_COUNTING_SEMAPHORE
#define	queueQUEUE_TYPE_BINARY_SEMAPHORE
#define	queueQUEUE_TYPE_RECURSIVE_MUTEX
#define	xQueueSendToFront(xQueue, pvItemToQueue, xTicksToWait)
#define	xQueueSendToBack(xQueue, pvItemToQueue, xTicksToWait)
#define	xQueueSend(xQueue, pvItemToQueue, xTicksToWait)
#define	xQueueOverwrite(xQueue, pvItemToQueue)
#define	xQueueSendToFrontFromISR(xQueue, pvItemToQueue, pxHigherPriorityTaskWoken)
#define	xQueueSendToBackFromISR(xQueue, pvItemToQueue, pxHigherPriorityTaskWoken)
#define	xQueueOverwriteFromISR(xQueue, pvItemToQueue, pxHigherPriorityTaskWoken)
#define	xQueueSendFromISR(xQueue, pvItemToQueue, pxHigherPriorityTaskWoken)
#define	xQueueReset(xQueue)

Typedefs
typedef struct QueueDefinition *	QueueHandle_t
typedef struct QueueDefinition *	QueueSetHandle_t
typedef struct QueueDefinition *	QueueSetMemberHandle_t

Functions
BaseType_t	xQueueGenericSend (QueueHandle_t xQueue, const void *const pvItemToQueue, TickType_t xTicksToWait, const BaseType_t xCopyPosition) PRIVILEGED_FUNCTION
BaseType_t	xQueuePeek (QueueHandle_t xQueue, void *const pvBuffer, TickType_t xTicksToWait) PRIVILEGED_FUNCTION
BaseType_t	xQueuePeekFromISR (QueueHandle_t xQueue, void *const pvBuffer) PRIVILEGED_FUNCTION
BaseType_t	xQueueReceive (QueueHandle_t xQueue, void *const pvBuffer, TickType_t xTicksToWait) PRIVILEGED_FUNCTION
UBaseType_t	uxQueueMessagesWaiting (const QueueHandle_t xQueue) PRIVILEGED_FUNCTION
UBaseType_t	uxQueueSpacesAvailable (const QueueHandle_t xQueue) PRIVILEGED_FUNCTION
void	vQueueDelete (QueueHandle_t xQueue) PRIVILEGED_FUNCTION
BaseType_t	xQueueGenericSendFromISR (QueueHandle_t xQueue, const void *const pvItemToQueue, BaseType_t *const pxHigherPriorityTaskWoken, const BaseType_t xCopyPosition) PRIVILEGED_FUNCTION
BaseType_t	xQueueGiveFromISR (QueueHandle_t xQueue, BaseType_t *const pxHigherPriorityTaskWoken) PRIVILEGED_FUNCTION
BaseType_t	xQueueReceiveFromISR (QueueHandle_t xQueue, void *const pvBuffer, BaseType_t *const pxHigherPriorityTaskWoken) PRIVILEGED_FUNCTION
BaseType_t	xQueueIsQueueEmptyFromISR (const QueueHandle_t xQueue) PRIVILEGED_FUNCTION
BaseType_t	xQueueIsQueueFullFromISR (const QueueHandle_t xQueue) PRIVILEGED_FUNCTION
UBaseType_t	uxQueueMessagesWaitingFromISR (const QueueHandle_t xQueue) PRIVILEGED_FUNCTION
BaseType_t	xQueueCRSendFromISR (QueueHandle_t xQueue, const void *pvItemToQueue, BaseType_t xCoRoutinePreviouslyWoken)
BaseType_t	xQueueCRReceiveFromISR (QueueHandle_t xQueue, void *pvBuffer, BaseType_t *pxTaskWoken)
BaseType_t	xQueueCRSend (QueueHandle_t xQueue, const void *pvItemToQueue, TickType_t xTicksToWait)
BaseType_t	xQueueCRReceive (QueueHandle_t xQueue, void *pvBuffer, TickType_t xTicksToWait)
QueueHandle_t	xQueueCreateMutex (const uint8_t ucQueueType) PRIVILEGED_FUNCTION
QueueHandle_t	xQueueCreateMutexStatic (const uint8_t ucQueueType, StaticQueue_t *pxStaticQueue) PRIVILEGED_FUNCTION
QueueHandle_t	xQueueCreateCountingSemaphore (const UBaseType_t uxMaxCount, const UBaseType_t uxInitialCount) PRIVILEGED_FUNCTION
QueueHandle_t	xQueueCreateCountingSemaphoreStatic (const UBaseType_t uxMaxCount, const UBaseType_t uxInitialCount, StaticQueue_t *pxStaticQueue) PRIVILEGED_FUNCTION
BaseType_t	xQueueSemaphoreTake (QueueHandle_t xQueue, TickType_t xTicksToWait) PRIVILEGED_FUNCTION
TaskHandle_t	xQueueGetMutexHolder (QueueHandle_t xSemaphore) PRIVILEGED_FUNCTION
TaskHandle_t	xQueueGetMutexHolderFromISR (QueueHandle_t xSemaphore) PRIVILEGED_FUNCTION
BaseType_t	xQueueTakeMutexRecursive (QueueHandle_t xMutex, TickType_t xTicksToWait) PRIVILEGED_FUNCTION
BaseType_t	xQueueGiveMutexRecursive (QueueHandle_t xMutex) PRIVILEGED_FUNCTION
QueueSetHandle_t	xQueueCreateSet (const UBaseType_t uxEventQueueLength) PRIVILEGED_FUNCTION
BaseType_t	xQueueAddToSet (QueueSetMemberHandle_t xQueueOrSemaphore, QueueSetHandle_t xQueueSet) PRIVILEGED_FUNCTION
BaseType_t	xQueueRemoveFromSet (QueueSetMemberHandle_t xQueueOrSemaphore, QueueSetHandle_t xQueueSet) PRIVILEGED_FUNCTION
QueueSetMemberHandle_t	xQueueSelectFromSet (QueueSetHandle_t xQueueSet, const TickType_t xTicksToWait) PRIVILEGED_FUNCTION
QueueSetMemberHandle_t	xQueueSelectFromSetFromISR (QueueSetHandle_t xQueueSet) PRIVILEGED_FUNCTION
void	vQueueWaitForMessageRestricted (QueueHandle_t xQueue, TickType_t xTicksToWait, const BaseType_t xWaitIndefinitely) PRIVILEGED_FUNCTION
BaseType_t	xQueueGenericReset (QueueHandle_t xQueue, BaseType_t xNewQueue) PRIVILEGED_FUNCTION
void	vQueueSetQueueNumber (QueueHandle_t xQueue, UBaseType_t uxQueueNumber) PRIVILEGED_FUNCTION
UBaseType_t	uxQueueGetQueueNumber (QueueHandle_t xQueue) PRIVILEGED_FUNCTION
uint8_t	ucQueueGetQueueType (QueueHandle_t xQueue) PRIVILEGED_FUNCTION

Macro Definition Documentation

#define queueOVERWRITE

Referenced by prvCopyDataToQueue(), xQueueGenericSend(), and xQueueGenericSendFromISR().

#define queueQUEUE_TYPE_BASE

#define queueQUEUE_TYPE_BINARY_SEMAPHORE

#define queueQUEUE_TYPE_COUNTING_SEMAPHORE

#define queueQUEUE_TYPE_MUTEX

#define queueQUEUE_TYPE_RECURSIVE_MUTEX

#define queueQUEUE_TYPE_SET

#define queueSEND_TO_BACK

Referenced by prvCopyDataToQueue(), prvUnlockQueue(), and xQueueGiveFromISR().

#define queueSEND_TO_FRONT

#define xQueueOverwrite	(		xQueue,
			pvItemToQueue
	)

#define xQueueOverwriteFromISR	(		xQueue,
			pvItemToQueue,
			pxHigherPriorityTaskWoken
	)

#define xQueueReset

(

xQueue

)

#define xQueueSend	(		xQueue,
			pvItemToQueue,
			xTicksToWait
	)

#define xQueueSendFromISR	(		xQueue,
			pvItemToQueue,
			pxHigherPriorityTaskWoken
	)

#define xQueueSendToBack	(		xQueue,
			pvItemToQueue,
			xTicksToWait
	)

#define xQueueSendToBackFromISR	(		xQueue,
			pvItemToQueue,
			pxHigherPriorityTaskWoken
	)

#define xQueueSendToFront	(		xQueue,
			pvItemToQueue,
			xTicksToWait
	)

#define xQueueSendToFrontFromISR	(		xQueue,
			pvItemToQueue,
			pxHigherPriorityTaskWoken
	)

Typedef Documentation

typedef struct QueueDefinition* QueueHandle_t

typedef struct QueueDefinition* QueueSetHandle_t

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 struct QueueDefinition* QueueSetMemberHandle_t

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

Function Documentation

uint8_t ucQueueGetQueueType

(

QueueHandle_t

xQueue

)

UBaseType_t uxQueueGetQueueNumber

(

QueueHandle_t

xQueue

)

UBaseType_t uxQueueMessagesWaiting

(

const QueueHandle_t

xQueue

)

References configASSERT, taskENTER_CRITICAL, and taskEXIT_CRITICAL.

Referenced by MPU_uxQueueMessagesWaiting().

UBaseType_t uxQueueMessagesWaitingFromISR

(

const QueueHandle_t

xQueue

)

References configASSERT, and xQUEUE::uxMessagesWaiting.

UBaseType_t uxQueueSpacesAvailable

(

const QueueHandle_t

xQueue

)

References configASSERT, taskENTER_CRITICAL, taskEXIT_CRITICAL, xQUEUE::uxLength, and xQUEUE::uxMessagesWaiting.

Referenced by MPU_uxQueueSpacesAvailable().

void vQueueDelete

(

QueueHandle_t

xQueue

)

References configASSERT, mtCOVERAGE_TEST_MARKER, pdFALSE, traceQUEUE_DELETE, vPortFree, and vQueueUnregisterQueue.

Referenced by MPU_vQueueDelete().

void vQueueSetQueueNumber	(	QueueHandle_t	xQueue,
		UBaseType_t	uxQueueNumber
	)

void vQueueWaitForMessageRestricted	(	QueueHandle_t	xQueue,
		TickType_t	xTicksToWait,
		const BaseType_t	xWaitIndefinitely
	)

BaseType_t xQueueAddToSet	(	QueueSetMemberHandle_t	xQueueOrSemaphore,
		QueueSetHandle_t	xQueueSet
	)

QueueHandle_t xQueueCreateCountingSemaphore	(	const UBaseType_t	uxMaxCount,
		const UBaseType_t	uxInitialCount
	)

QueueHandle_t xQueueCreateCountingSemaphoreStatic	(	const UBaseType_t	uxMaxCount,
		const UBaseType_t	uxInitialCount,
		StaticQueue_t *	pxStaticQueue
	)

QueueHandle_t xQueueCreateMutex

(

const uint8_t

ucQueueType

)

QueueHandle_t xQueueCreateMutexStatic	(	const uint8_t	ucQueueType,
		StaticQueue_t *	pxStaticQueue
	)

QueueSetHandle_t xQueueCreateSet

(

const UBaseType_t

uxEventQueueLength

)

BaseType_t xQueueCRReceive	(	QueueHandle_t	xQueue,
		void *	pvBuffer,
		TickType_t	xTicksToWait
	)

BaseType_t xQueueCRReceiveFromISR	(	QueueHandle_t	xQueue,
		void *	pvBuffer,
		BaseType_t *	pxTaskWoken
	)

BaseType_t xQueueCRSend	(	QueueHandle_t	xQueue,
		const void *	pvItemToQueue,
		TickType_t	xTicksToWait
	)

BaseType_t xQueueCRSendFromISR	(	QueueHandle_t	xQueue,
		const void *	pvItemToQueue,
		BaseType_t	xCoRoutinePreviouslyWoken
	)

BaseType_t xQueueGenericReset	(	QueueHandle_t	xQueue,
		BaseType_t	xNewQueue
	)

References configASSERT, xQUEUE::cRxLock, xQUEUE::cTxLock, listLIST_IS_EMPTY, mtCOVERAGE_TEST_MARKER, xQUEUE::pcHead, QueuePointers_t::pcReadFrom, QueuePointers_t::pcTail, xQUEUE::pcWriteTo, pdFALSE, pdPASS, queueUNLOCKED, queueYIELD_IF_USING_PREEMPTION, taskENTER_CRITICAL, taskEXIT_CRITICAL, xQUEUE::u, xQUEUE::uxItemSize, xQUEUE::uxLength, xQUEUE::uxMessagesWaiting, vListInitialise(), xQUEUE::xQueue, xTaskRemoveFromEventList(), xQUEUE::xTasksWaitingToReceive, and xQUEUE::xTasksWaitingToSend.

Referenced by MPU_xQueueGenericReset(), and prvInitialiseNewQueue().

BaseType_t xQueueGenericSend	(	QueueHandle_t	xQueue,
		const void *const	pvItemToQueue,
		TickType_t	xTicksToWait,
		const BaseType_t	xCopyPosition
	)

References configASSERT, errQUEUE_FULL, listLIST_IS_EMPTY, mtCOVERAGE_TEST_MARKER, pdFALSE, pdPASS, pdTRUE, portYIELD_WITHIN_API, prvCopyDataToQueue(), prvIsQueueFull(), prvLockQueue, prvUnlockQueue(), queueOVERWRITE, queueYIELD_IF_USING_PREEMPTION, taskENTER_CRITICAL, taskEXIT_CRITICAL, taskSCHEDULER_SUSPENDED, traceBLOCKING_ON_QUEUE_SEND, traceQUEUE_SEND, traceQUEUE_SEND_FAILED, xQUEUE::uxItemSize, xQUEUE::uxLength, xQUEUE::uxMessagesWaiting, vTaskInternalSetTimeOutState(), vTaskPlaceOnEventList(), vTaskSuspendAll(), xTaskCheckForTimeOut(), xTaskGetSchedulerState(), xTaskRemoveFromEventList(), xTaskResumeAll(), xQUEUE::xTasksWaitingToReceive, and xQUEUE::xTasksWaitingToSend.

Referenced by MPU_xQueueGenericSend().

BaseType_t xQueueGenericSendFromISR	(	QueueHandle_t	xQueue,
		const void *const	pvItemToQueue,
		BaseType_t *const	pxHigherPriorityTaskWoken,
		const BaseType_t	xCopyPosition
	)

References configASSERT, xQUEUE::cTxLock, errQUEUE_FULL, listLIST_IS_EMPTY, mtCOVERAGE_TEST_MARKER, pdFALSE, pdPASS, pdTRUE, portASSERT_IF_INTERRUPT_PRIORITY_INVALID, portCLEAR_INTERRUPT_MASK_FROM_ISR, portSET_INTERRUPT_MASK_FROM_ISR, prvCopyDataToQueue(), queueOVERWRITE, queueUNLOCKED, traceQUEUE_SEND_FROM_ISR, traceQUEUE_SEND_FROM_ISR_FAILED, xQUEUE::uxItemSize, xQUEUE::uxLength, xQUEUE::uxMessagesWaiting, xTaskRemoveFromEventList(), and xQUEUE::xTasksWaitingToReceive.

TaskHandle_t xQueueGetMutexHolder

(

QueueHandle_t

xSemaphore

)

TaskHandle_t xQueueGetMutexHolderFromISR

(

QueueHandle_t

xSemaphore

)

BaseType_t xQueueGiveFromISR	(	QueueHandle_t	xQueue,
		BaseType_t *const	pxHigherPriorityTaskWoken
	)

References configASSERT, xQUEUE::cTxLock, errQUEUE_FULL, listLIST_IS_EMPTY, mtCOVERAGE_TEST_MARKER, pdFALSE, pdPASS, pdTRUE, portASSERT_IF_INTERRUPT_PRIORITY_INVALID, portCLEAR_INTERRUPT_MASK_FROM_ISR, portSET_INTERRUPT_MASK_FROM_ISR, queueQUEUE_IS_MUTEX, queueSEND_TO_BACK, queueUNLOCKED, traceQUEUE_SEND_FROM_ISR, traceQUEUE_SEND_FROM_ISR_FAILED, xQUEUE::u, xQUEUE::uxItemSize, xQUEUE::uxMessagesWaiting, SemaphoreData_t::xMutexHolder, xQUEUE::xSemaphore, xTaskRemoveFromEventList(), and xQUEUE::xTasksWaitingToReceive.

BaseType_t xQueueGiveMutexRecursive

(

QueueHandle_t

xMutex

)

BaseType_t xQueueIsQueueEmptyFromISR

(

const QueueHandle_t

xQueue

)

References configASSERT, pdFALSE, pdTRUE, and xQUEUE::uxMessagesWaiting.

BaseType_t xQueueIsQueueFullFromISR

(

const QueueHandle_t

xQueue

)

References configASSERT, pdFALSE, pdTRUE, xQUEUE::uxLength, and xQUEUE::uxMessagesWaiting.

BaseType_t xQueuePeek	(	QueueHandle_t	xQueue,
		void *const	pvBuffer,
		TickType_t	xTicksToWait
	)

References configASSERT, errQUEUE_EMPTY, listLIST_IS_EMPTY, mtCOVERAGE_TEST_MARKER, QueuePointers_t::pcReadFrom, pdFALSE, pdPASS, pdTRUE, portYIELD_WITHIN_API, prvCopyDataFromQueue(), prvIsQueueEmpty(), prvLockQueue, prvUnlockQueue(), queueYIELD_IF_USING_PREEMPTION, taskENTER_CRITICAL, taskEXIT_CRITICAL, taskSCHEDULER_SUSPENDED, traceBLOCKING_ON_QUEUE_PEEK, traceQUEUE_PEEK, traceQUEUE_PEEK_FAILED, xQUEUE::u, xQUEUE::uxMessagesWaiting, vTaskInternalSetTimeOutState(), vTaskPlaceOnEventList(), vTaskSuspendAll(), xQUEUE::xQueue, xTaskCheckForTimeOut(), xTaskGetSchedulerState(), xTaskRemoveFromEventList(), xTaskResumeAll(), and xQUEUE::xTasksWaitingToReceive.

Referenced by MPU_xQueuePeek().

BaseType_t xQueuePeekFromISR	(	QueueHandle_t	xQueue,
		void *const	pvBuffer
	)

References configASSERT, QueuePointers_t::pcReadFrom, pdFAIL, pdPASS, portASSERT_IF_INTERRUPT_PRIORITY_INVALID, portCLEAR_INTERRUPT_MASK_FROM_ISR, portSET_INTERRUPT_MASK_FROM_ISR, prvCopyDataFromQueue(), traceQUEUE_PEEK_FROM_ISR, traceQUEUE_PEEK_FROM_ISR_FAILED, xQUEUE::u, xQUEUE::uxItemSize, xQUEUE::uxMessagesWaiting, and xQUEUE::xQueue.

BaseType_t xQueueReceive	(	QueueHandle_t	xQueue,
		void *const	pvBuffer,
		TickType_t	xTicksToWait
	)

References configASSERT, errQUEUE_EMPTY, listLIST_IS_EMPTY, mtCOVERAGE_TEST_MARKER, pdFALSE, pdPASS, pdTRUE, portYIELD_WITHIN_API, prvCopyDataFromQueue(), prvIsQueueEmpty(), prvLockQueue, prvUnlockQueue(), queueYIELD_IF_USING_PREEMPTION, taskENTER_CRITICAL, taskEXIT_CRITICAL, taskSCHEDULER_SUSPENDED, traceBLOCKING_ON_QUEUE_RECEIVE, traceQUEUE_RECEIVE, traceQUEUE_RECEIVE_FAILED, xQUEUE::uxMessagesWaiting, vTaskInternalSetTimeOutState(), vTaskPlaceOnEventList(), vTaskSuspendAll(), xTaskCheckForTimeOut(), xTaskGetSchedulerState(), xTaskRemoveFromEventList(), xTaskResumeAll(), xQUEUE::xTasksWaitingToReceive, and xQUEUE::xTasksWaitingToSend.

Referenced by MPU_xQueueReceive().

BaseType_t xQueueReceiveFromISR	(	QueueHandle_t	xQueue,
		void *const	pvBuffer,
		BaseType_t *const	pxHigherPriorityTaskWoken
	)

References configASSERT, xQUEUE::cRxLock, listLIST_IS_EMPTY, mtCOVERAGE_TEST_MARKER, pdFAIL, pdFALSE, pdPASS, pdTRUE, portASSERT_IF_INTERRUPT_PRIORITY_INVALID, portCLEAR_INTERRUPT_MASK_FROM_ISR, portSET_INTERRUPT_MASK_FROM_ISR, prvCopyDataFromQueue(), queueUNLOCKED, traceQUEUE_RECEIVE_FROM_ISR, traceQUEUE_RECEIVE_FROM_ISR_FAILED, xQUEUE::uxItemSize, xQUEUE::uxMessagesWaiting, xTaskRemoveFromEventList(), and xQUEUE::xTasksWaitingToSend.

BaseType_t xQueueRemoveFromSet	(	QueueSetMemberHandle_t	xQueueOrSemaphore,
		QueueSetHandle_t	xQueueSet
	)

QueueSetMemberHandle_t xQueueSelectFromSet	(	QueueSetHandle_t	xQueueSet,
		const TickType_t	xTicksToWait
	)

QueueSetMemberHandle_t xQueueSelectFromSetFromISR

(

QueueSetHandle_t

xQueueSet

)

BaseType_t xQueueSemaphoreTake	(	QueueHandle_t	xQueue,
		TickType_t	xTicksToWait
	)

References configASSERT, errQUEUE_EMPTY, listLIST_IS_EMPTY, mtCOVERAGE_TEST_MARKER, pdFALSE, pdPASS, pdTRUE, portYIELD_WITHIN_API, prvIsQueueEmpty(), prvLockQueue, prvUnlockQueue(), pvTaskIncrementMutexHeldCount(), queueQUEUE_IS_MUTEX, queueYIELD_IF_USING_PREEMPTION, taskENTER_CRITICAL, taskEXIT_CRITICAL, taskSCHEDULER_SUSPENDED, traceBLOCKING_ON_QUEUE_RECEIVE, traceQUEUE_RECEIVE, traceQUEUE_RECEIVE_FAILED, xQUEUE::u, xQUEUE::uxItemSize, xQUEUE::uxMessagesWaiting, vTaskInternalSetTimeOutState(), vTaskPlaceOnEventList(), vTaskPriorityDisinheritAfterTimeout(), vTaskSuspendAll(), SemaphoreData_t::xMutexHolder, xQUEUE::xSemaphore, xTaskCheckForTimeOut(), xTaskGetSchedulerState(), xTaskPriorityInherit(), xTaskRemoveFromEventList(), xTaskResumeAll(), xQUEUE::xTasksWaitingToReceive, and xQUEUE::xTasksWaitingToSend.

Referenced by MPU_xQueueSemaphoreTake().

BaseType_t xQueueTakeMutexRecursive	(	QueueHandle_t	xMutex,
		TickType_t	xTicksToWait
	)