Macros | |
#define | queueOVERWRITE ( ( BaseType_t ) 2 ) |
#define | queueQUEUE_TYPE_BASE ( ( uint8_t ) 0U ) |
#define | queueQUEUE_TYPE_BINARY_SEMAPHORE ( ( uint8_t ) 3U ) |
#define | queueQUEUE_TYPE_COUNTING_SEMAPHORE ( ( uint8_t ) 2U ) |
#define | queueQUEUE_TYPE_MUTEX ( ( uint8_t ) 1U ) |
#define | queueQUEUE_TYPE_RECURSIVE_MUTEX ( ( uint8_t ) 4U ) |
#define | queueQUEUE_TYPE_SET ( ( uint8_t ) 0U ) |
#define | queueSEND_TO_BACK ( ( BaseType_t ) 0 ) |
#define | queueSEND_TO_FRONT ( ( BaseType_t ) 1 ) |
#define | xQueueOverwrite(xQueue, pvItemToQueue) xQueueGenericSend( ( xQueue ), ( pvItemToQueue ), 0, queueOVERWRITE ) |
#define | xQueueOverwriteFromISR(xQueue, pvItemToQueue, pxHigherPriorityTaskWoken) xQueueGenericSendFromISR( ( xQueue ), ( pvItemToQueue ), ( pxHigherPriorityTaskWoken ), queueOVERWRITE ) |
#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 * | QueueHandle_t |
Type by which queues are referenced. More... | |
typedef void * | QueueSetHandle_t |
Type by which queue sets are referenced. More... | |
typedef void * | 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. More... | |
#define queueOVERWRITE ( ( BaseType_t ) 2 ) |
Referenced by prvCopyDataToQueue(), xQueueGenericSend(), and xQueueGenericSendFromISR().
#define queueQUEUE_TYPE_BASE ( ( uint8_t ) 0U ) |
#define queueQUEUE_TYPE_BINARY_SEMAPHORE ( ( uint8_t ) 3U ) |
#define queueQUEUE_TYPE_COUNTING_SEMAPHORE ( ( uint8_t ) 2U ) |
#define queueQUEUE_TYPE_MUTEX ( ( uint8_t ) 1U ) |
#define queueQUEUE_TYPE_RECURSIVE_MUTEX ( ( uint8_t ) 4U ) |
#define queueQUEUE_TYPE_SET ( ( uint8_t ) 0U ) |
#define queueSEND_TO_BACK ( ( BaseType_t ) 0 ) |
Referenced by prvCopyDataToQueue(), prvUnlockQueue(), and xQueueGiveFromISR().
#define queueSEND_TO_FRONT ( ( BaseType_t ) 1 ) |
#define xQueueOverwrite | ( | xQueue, | |
pvItemToQueue | |||
) | xQueueGenericSend( ( xQueue ), ( pvItemToQueue ), 0, queueOVERWRITE ) |
#define xQueueOverwriteFromISR | ( | xQueue, | |
pvItemToQueue, | |||
pxHigherPriorityTaskWoken | |||
) | xQueueGenericSendFromISR( ( xQueue ), ( pvItemToQueue ), ( pxHigherPriorityTaskWoken ), queueOVERWRITE ) |
#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* QueueHandle_t |
Type by which queues are referenced.
For example, a call to xQueueCreate() returns an QueueHandle_t variable that can then be used as a parameter to xQueueSend(), xQueueReceive(), etc.
typedef void* 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 void* 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.
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 | ) |
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 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, 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.
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.
void* xQueueGetMutexHolder | ( | QueueHandle_t | xSemaphore | ) |
void* xQueueGetMutexHolderFromISR | ( | QueueHandle_t | xSemaphore | ) |
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 xQueueGiveMutexRecursive | ( | QueueHandle_t | pxMutex | ) |
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 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, QueueDefinition::uxItemSize, QueueDefinition::uxMessagesWaiting, vTaskInternalSetTimeOutState(), vTaskPlaceOnEventList(), vTaskPriorityDisinheritAfterTimeout(), vTaskSuspendAll(), xTaskCheckForTimeOut(), xTaskGetSchedulerState(), xTaskPriorityInherit(), xTaskRemoveFromEventList(), xTaskResumeAll(), QueueDefinition::xTasksWaitingToReceive, and QueueDefinition::xTasksWaitingToSend.
BaseType_t xQueueTakeMutexRecursive | ( | QueueHandle_t | xMutex, |
TickType_t | xTicksToWait | ||
) |