queue.c File Reference

#include <stdlib.h>
#include <string.h>
#include "FreeRTOS.h"
#include "task.h"
#include "queue.h"

Data Structures
struct	QUEUE_REGISTRY_ITEM
struct	QueueDefinition

Macros
#define	MPU_WRAPPERS_INCLUDED_FROM_API_FILE
#define	prvLockQueue(pxQueue)
#define	pxMutexHolder   pcTail
#define	queueLOCKED_UNMODIFIED   ( ( int8_t ) 0 )
#define	queueMUTEX_GIVE_BLOCK_TIME   ( ( TickType_t ) 0U )
#define	queueQUEUE_IS_MUTEX   NULL
#define	queueSEMAPHORE_QUEUE_ITEM_LENGTH   ( ( UBaseType_t ) 0 )
#define	queueUNLOCKED   ( ( int8_t ) -1 )
#define	queueYIELD_IF_USING_PREEMPTION()
#define	uxQueueType   pcHead

Typedefs
typedef xQUEUE	Queue_t
typedef xQueueRegistryItem	QueueRegistryItem_t
typedef struct QueueDefinition	xQUEUE
typedef struct QUEUE_REGISTRY_ITEM	xQueueRegistryItem

Functions
const char *	pcQueueGetName (QueueHandle_t xQueue)
static void	prvCopyDataFromQueue (Queue_t *const pxQueue, void *const pvBuffer) PRIVILEGED_FUNCTION
static BaseType_t	prvCopyDataToQueue (Queue_t *const pxQueue, const void *pvItemToQueue, const BaseType_t xPosition) PRIVILEGED_FUNCTION
static UBaseType_t	prvGetDisinheritPriorityAfterTimeout (const Queue_t *const pxQueue) PRIVILEGED_FUNCTION
static void	prvInitialiseMutex (Queue_t *pxNewQueue) PRIVILEGED_FUNCTION
static void	prvInitialiseNewQueue (const UBaseType_t uxQueueLength, const UBaseType_t uxItemSize, uint8_t *pucQueueStorage, const uint8_t ucQueueType, Queue_t *pxNewQueue) PRIVILEGED_FUNCTION
static BaseType_t	prvIsQueueEmpty (const Queue_t *pxQueue) PRIVILEGED_FUNCTION
static BaseType_t	prvIsQueueFull (const Queue_t *pxQueue) PRIVILEGED_FUNCTION
static void	prvUnlockQueue (Queue_t *const pxQueue) PRIVILEGED_FUNCTION
uint8_t	ucQueueGetQueueType (QueueHandle_t xQueue)
UBaseType_t	uxQueueGetQueueNumber (QueueHandle_t xQueue)
UBaseType_t	uxQueueMessagesWaiting (const QueueHandle_t xQueue)
UBaseType_t	uxQueueMessagesWaitingFromISR (const QueueHandle_t xQueue)
UBaseType_t	uxQueueSpacesAvailable (const QueueHandle_t xQueue)
void	vQueueAddToRegistry (QueueHandle_t xQueue, const char *pcQueueName)
void	vQueueDelete (QueueHandle_t xQueue)
void	vQueueSetQueueNumber (QueueHandle_t xQueue, UBaseType_t uxQueueNumber)
void	vQueueUnregisterQueue (QueueHandle_t xQueue)
QueueHandle_t	xQueueCreateMutex (const uint8_t ucQueueType)
QueueHandle_t	xQueueGenericCreate (const UBaseType_t uxQueueLength, const UBaseType_t uxItemSize, const uint8_t ucQueueType)
BaseType_t	xQueueGenericReset (QueueHandle_t xQueue, BaseType_t xNewQueue)
BaseType_t	xQueueGenericSend (QueueHandle_t xQueue, const void *const pvItemToQueue, TickType_t xTicksToWait, const BaseType_t xCopyPosition)
BaseType_t	xQueueGenericSendFromISR (QueueHandle_t xQueue, const void *const pvItemToQueue, BaseType_t *const pxHigherPriorityTaskWoken, const BaseType_t xCopyPosition)
BaseType_t	xQueueGiveFromISR (QueueHandle_t xQueue, BaseType_t *const pxHigherPriorityTaskWoken)
BaseType_t	xQueueIsQueueEmptyFromISR (const QueueHandle_t xQueue)
BaseType_t	xQueueIsQueueFullFromISR (const QueueHandle_t xQueue)
BaseType_t	xQueuePeek (QueueHandle_t xQueue, void *const pvBuffer, TickType_t xTicksToWait)
BaseType_t	xQueuePeekFromISR (QueueHandle_t xQueue, void *const pvBuffer)
BaseType_t	xQueueReceive (QueueHandle_t xQueue, void *const pvBuffer, TickType_t xTicksToWait)
BaseType_t	xQueueReceiveFromISR (QueueHandle_t xQueue, void *const pvBuffer, BaseType_t *const pxHigherPriorityTaskWoken)
BaseType_t	xQueueSemaphoreTake (QueueHandle_t xQueue, TickType_t xTicksToWait)

Variables
PRIVILEGED_DATA QueueRegistryItem_t	xQueueRegistry [configQUEUE_REGISTRY_SIZE]

#define MPU_WRAPPERS_INCLUDED_FROM_API_FILE

#define prvLockQueue

(

pxQueue

)

Value:

taskENTER_CRITICAL();                                   \
    {                                                       \
        if( ( pxQueue )->cRxLock == queueUNLOCKED )         \
        {                                                   \
            ( pxQueue )->cRxLock = queueLOCKED_UNMODIFIED;  \
        }                                                   \
        if( ( pxQueue )->cTxLock == queueUNLOCKED )         \
        {                                                   \
            ( pxQueue )->cTxLock = queueLOCKED_UNMODIFIED;  \
        }                                                   \
    }                                                       \
	taskEXIT_CRITICAL()

Referenced by xQueueGenericSend(), xQueuePeek(), xQueueReceive(), and xQueueSemaphoreTake().

#define pxMutexHolder   pcTail

#define queueLOCKED_UNMODIFIED   ( ( int8_t ) 0 )

Referenced by prvUnlockQueue().

#define queueMUTEX_GIVE_BLOCK_TIME   ( ( TickType_t ) 0U )

#define queueQUEUE_IS_MUTEX   NULL

Referenced by prvCopyDataToQueue(), prvInitialiseMutex(), xQueueGiveFromISR(), and xQueueSemaphoreTake().

#define queueSEMAPHORE_QUEUE_ITEM_LENGTH   ( ( UBaseType_t ) 0 )

#define queueUNLOCKED   ( ( int8_t ) -1 )

Referenced by prvUnlockQueue(), xQueueGenericReset(), xQueueGenericSendFromISR(), xQueueGiveFromISR(), and xQueueReceiveFromISR().

#define queueYIELD_IF_USING_PREEMPTION

(

)

Referenced by xQueueGenericReset(), xQueueGenericSend(), xQueuePeek(), xQueueReceive(), and xQueueSemaphoreTake().

#define uxQueueType   pcHead

typedef xQUEUE Queue_t

typedef xQueueRegistryItem QueueRegistryItem_t

typedef struct QueueDefinition xQUEUE

typedef struct QUEUE_REGISTRY_ITEM xQueueRegistryItem

const char* pcQueueGetName

(

QueueHandle_t

xQueue

)

References configQUEUE_REGISTRY_SIZE, mtCOVERAGE_TEST_MARKER, QUEUE_REGISTRY_ITEM::pcQueueName, and xQueueRegistry.

static void prvCopyDataFromQueue ( Queue_t *const  pxQueue, void *const  pvBuffer  )

static

References mtCOVERAGE_TEST_MARKER, QueueDefinition::pcHead, QueueDefinition::pcReadFrom, QueueDefinition::pcTail, QueueDefinition::u, and QueueDefinition::uxItemSize.

Referenced by xQueuePeek(), xQueuePeekFromISR(), xQueueReceive(), and xQueueReceiveFromISR().

static BaseType_t prvCopyDataToQueue ( Queue_t *const  pxQueue, const void *  pvItemToQueue, const BaseType_t  xPosition  )

static

References mtCOVERAGE_TEST_MARKER, QueueDefinition::pcHead, QueueDefinition::pcReadFrom, QueueDefinition::pcTail, QueueDefinition::pcWriteTo, pdFALSE, queueOVERWRITE, queueQUEUE_IS_MUTEX, queueSEND_TO_BACK, QueueDefinition::u, QueueDefinition::uxItemSize, QueueDefinition::uxMessagesWaiting, and xTaskPriorityDisinherit().

Referenced by xQueueGenericSend(), and xQueueGenericSendFromISR().

static UBaseType_t prvGetDisinheritPriorityAfterTimeout ( const Queue_t *const  pxQueue )

static

References configMAX_PRIORITIES, listCURRENT_LIST_LENGTH, listGET_ITEM_VALUE_OF_HEAD_ENTRY, tskIDLE_PRIORITY, and QueueDefinition::xTasksWaitingToReceive.

Referenced by xQueueSemaphoreTake().

static void prvInitialiseMutex ( Queue_t *  pxNewQueue )

static

References queueQUEUE_IS_MUTEX, queueSEND_TO_BACK, traceCREATE_MUTEX, traceCREATE_MUTEX_FAILED, QueueDefinition::u, QueueDefinition::uxRecursiveCallCount, and xQueueGenericSend().

Referenced by xQueueCreateMutex().

static void prvInitialiseNewQueue ( const UBaseType_t  uxQueueLength, const UBaseType_t  uxItemSize, uint8_t *  pucQueueStorage, const uint8_t  ucQueueType, Queue_t *  pxNewQueue  )

static

References QueueDefinition::pcHead, pdTRUE, traceQUEUE_CREATE, QueueDefinition::ucQueueType, QueueDefinition::uxItemSize, QueueDefinition::uxLength, and xQueueGenericReset().

Referenced by xQueueGenericCreate().

static BaseType_t prvIsQueueEmpty ( const Queue_t *  pxQueue )

static

References pdFALSE, pdTRUE, taskENTER_CRITICAL, taskEXIT_CRITICAL, and QueueDefinition::uxMessagesWaiting.

Referenced by xQueuePeek(), xQueueReceive(), and xQueueSemaphoreTake().

static BaseType_t prvIsQueueFull ( const Queue_t *  pxQueue )

static

References pdFALSE, pdTRUE, taskENTER_CRITICAL, taskEXIT_CRITICAL, QueueDefinition::uxLength, and QueueDefinition::uxMessagesWaiting.

Referenced by xQueueGenericSend().

static void prvUnlockQueue ( Queue_t *const  pxQueue )

static

References QueueDefinition::cRxLock, QueueDefinition::cTxLock, listLIST_IS_EMPTY, mtCOVERAGE_TEST_MARKER, pdFALSE, queueLOCKED_UNMODIFIED, queueSEND_TO_BACK, queueUNLOCKED, taskENTER_CRITICAL, taskEXIT_CRITICAL, vTaskMissedYield(), xTaskRemoveFromEventList(), QueueDefinition::xTasksWaitingToReceive, and QueueDefinition::xTasksWaitingToSend.

Referenced by xQueueGenericSend(), xQueuePeek(), xQueueReceive(), and xQueueSemaphoreTake().

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.

UBaseType_t uxQueueMessagesWaitingFromISR

(

const QueueHandle_t

xQueue

)

References configASSERT.

UBaseType_t uxQueueSpacesAvailable

(

const QueueHandle_t

xQueue

)

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

void vQueueAddToRegistry	(	QueueHandle_t	xQueue,
		const char *	pcQueueName
	)

References configQUEUE_REGISTRY_SIZE, mtCOVERAGE_TEST_MARKER, QUEUE_REGISTRY_ITEM::pcQueueName, traceQUEUE_REGISTRY_ADD, QUEUE_REGISTRY_ITEM::xHandle, and xQueueRegistry.

void vQueueDelete

(

QueueHandle_t

xQueue

)

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

void vQueueSetQueueNumber	(	QueueHandle_t	xQueue,
		UBaseType_t	uxQueueNumber
	)

void vQueueUnregisterQueue

(

QueueHandle_t

xQueue

)

References configQUEUE_REGISTRY_SIZE, mtCOVERAGE_TEST_MARKER, QUEUE_REGISTRY_ITEM::pcQueueName, QUEUE_REGISTRY_ITEM::xHandle, and xQueueRegistry.

Referenced by vQueueDelete().

QueueHandle_t xQueueCreateMutex

(

const uint8_t

ucQueueType

)

References prvInitialiseMutex(), and xQueueGenericCreate().

QueueHandle_t xQueueGenericCreate	(	const UBaseType_t	uxQueueLength,
		const UBaseType_t	uxItemSize,
		const uint8_t	ucQueueType
	)

References configASSERT, pdFALSE, prvInitialiseNewQueue(), pvPortMalloc(), and traceQUEUE_CREATE_FAILED.

Referenced by xQueueCreateMutex().

BaseType_t xQueueGenericReset	(	QueueHandle_t	xQueue,
		BaseType_t	xNewQueue
	)

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

Referenced by 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, QueueDefinition::uxItemSize, QueueDefinition::uxLength, QueueDefinition::uxMessagesWaiting, vTaskInternalSetTimeOutState(), vTaskPlaceOnEventList(), vTaskSuspendAll(), xTaskCheckForTimeOut(), xTaskGetSchedulerState(), xTaskRemoveFromEventList(), xTaskResumeAll(), QueueDefinition::xTasksWaitingToReceive, and QueueDefinition::xTasksWaitingToSend.

Referenced by prvInitialiseMutex().

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

References configASSERT, QueueDefinition::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, QueueDefinition::uxItemSize, QueueDefinition::uxLength, QueueDefinition::uxMessagesWaiting, xTaskRemoveFromEventList(), and QueueDefinition::xTasksWaitingToReceive.

BaseType_t xQueueGiveFromISR	(	QueueHandle_t	xQueue,
		BaseType_t *const	pxHigherPriorityTaskWoken
	)

References configASSERT, QueueDefinition::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, QueueDefinition::uxItemSize, QueueDefinition::uxMessagesWaiting, xTaskRemoveFromEventList(), and QueueDefinition::xTasksWaitingToReceive.

BaseType_t xQueueIsQueueEmptyFromISR

(

const QueueHandle_t

xQueue

)

References configASSERT, pdFALSE, and pdTRUE.

BaseType_t xQueueIsQueueFullFromISR

(

const QueueHandle_t

xQueue

)

References configASSERT, pdFALSE, and pdTRUE.

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

References configASSERT, errQUEUE_EMPTY, listLIST_IS_EMPTY, mtCOVERAGE_TEST_MARKER, QueueDefinition::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, QueueDefinition::u, QueueDefinition::uxMessagesWaiting, vTaskInternalSetTimeOutState(), vTaskPlaceOnEventList(), vTaskSuspendAll(), xTaskCheckForTimeOut(), xTaskGetSchedulerState(), xTaskRemoveFromEventList(), xTaskResumeAll(), and QueueDefinition::xTasksWaitingToReceive.

BaseType_t xQueuePeekFromISR	(	QueueHandle_t	xQueue,
		void *const	pvBuffer
	)

References configASSERT, QueueDefinition::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, QueueDefinition::u, QueueDefinition::uxItemSize, and QueueDefinition::uxMessagesWaiting.

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, QueueDefinition::uxMessagesWaiting, vTaskInternalSetTimeOutState(), vTaskPlaceOnEventList(), vTaskSuspendAll(), xTaskCheckForTimeOut(), xTaskGetSchedulerState(), xTaskRemoveFromEventList(), xTaskResumeAll(), QueueDefinition::xTasksWaitingToReceive, and QueueDefinition::xTasksWaitingToSend.

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

References configASSERT, QueueDefinition::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, QueueDefinition::uxItemSize, QueueDefinition::uxMessagesWaiting, xTaskRemoveFromEventList(), and QueueDefinition::xTasksWaitingToSend.

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, prvGetDisinheritPriorityAfterTimeout(), 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, QueueDefinition::uxItemSize, QueueDefinition::uxMessagesWaiting, vTaskInternalSetTimeOutState(), vTaskPlaceOnEventList(), vTaskPriorityDisinheritAfterTimeout(), vTaskSuspendAll(), xTaskCheckForTimeOut(), xTaskGetSchedulerState(), xTaskPriorityInherit(), xTaskRemoveFromEventList(), xTaskResumeAll(), QueueDefinition::xTasksWaitingToReceive, and QueueDefinition::xTasksWaitingToSend.

PRIVILEGED_DATA QueueRegistryItem_t xQueueRegistry[configQUEUE_REGISTRY_SIZE]

Referenced by pcQueueGetName(), vQueueAddToRegistry(), and vQueueUnregisterQueue().