begriffs open source - freertos/blob - queue.c

   1 /*
   2  * FreeRTOS SMP Kernel V202110.00
   3  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
   4  *
   5  * Permission is hereby granted, free of charge, to any person obtaining a copy of
   6  * this software and associated documentation files (the "Software"), to deal in
   7  * the Software without restriction, including without limitation the rights to
   8  * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
   9  * the Software, and to permit persons to whom the Software is furnished to do so,
  10  * subject to the following conditions:
  11  *
  12  * The above copyright notice and this permission notice shall be included in all
  13  * copies or substantial portions of the Software.
  14  *
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
  17  * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
  18  * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
  19  * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  20  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  21  *
  22  * https://www.FreeRTOS.org
  23  * https://github.com/FreeRTOS
  24  *
  25  */
  26
  27 #include <stdlib.h>
  28 #include <string.h>
  29
  30 /* Defining MPU_WRAPPERS_INCLUDED_FROM_API_FILE prevents task.h from redefining
  31  * all the API functions to use the MPU wrappers.  That should only be done when
  32  * task.h is included from an application file. */
  33 #define MPU_WRAPPERS_INCLUDED_FROM_API_FILE
  34
  35 #include "FreeRTOS.h"
  36 #include "task.h"
  37 #include "queue.h"
  38
  39 #if ( configUSE_CO_ROUTINES == 1 )
  40     #include "croutine.h"
  41 #endif
  42
  43 /* Lint e9021, e961 and e750 are suppressed as a MISRA exception justified
  44  * because the MPU ports require MPU_WRAPPERS_INCLUDED_FROM_API_FILE to be defined
  45  * for the header files above, but not in this file, in order to generate the
  46  * correct privileged Vs unprivileged linkage and placement. */
  47 #undef MPU_WRAPPERS_INCLUDED_FROM_API_FILE /*lint !e961 !e750 !e9021. */
  48
  49
  50 /* Constants used with the cRxLock and cTxLock structure members. */
  51 #define queueUNLOCKED             ( ( int8_t ) -1 )
  52 #define queueLOCKED_UNMODIFIED    ( ( int8_t ) 0 )
  53 #define queueINT8_MAX             ( ( int8_t ) 127 )
  54
  55 /* When the Queue_t structure is used to represent a base queue its pcHead and
  56  * pcTail members are used as pointers into the queue storage area.  When the
  57  * Queue_t structure is used to represent a mutex pcHead and pcTail pointers are
  58  * not necessary, and the pcHead pointer is set to NULL to indicate that the
  59  * structure instead holds a pointer to the mutex holder (if any).  Map alternative
  60  * names to the pcHead and structure member to ensure the readability of the code
  61  * is maintained.  The QueuePointers_t and SemaphoreData_t types are used to form
  62  * a union as their usage is mutually exclusive dependent on what the queue is
  63  * being used for. */
  64 #define uxQueueType               pcHead
  65 #define queueQUEUE_IS_MUTEX       NULL
  66
  67 typedef struct QueuePointers
  68 {
  69     int8_t * pcTail;     /*< Points to the byte at the end of the queue storage area.  Once more byte is allocated than necessary to store the queue items, this is used as a marker. */
  70     int8_t * pcReadFrom; /*< Points to the last place that a queued item was read from when the structure is used as a queue. */
  71 } QueuePointers_t;
  72
  73 typedef struct SemaphoreData
  74 {
  75     TaskHandle_t xMutexHolder;        /*< The handle of the task that holds the mutex. */
  76     UBaseType_t uxRecursiveCallCount; /*< Maintains a count of the number of times a recursive mutex has been recursively 'taken' when the structure is used as a mutex. */
  77 } SemaphoreData_t;
  78
  79 /* Semaphores do not actually store or copy data, so have an item size of
  80  * zero. */
  81 #define queueSEMAPHORE_QUEUE_ITEM_LENGTH    ( ( UBaseType_t ) 0 )
  82 #define queueMUTEX_GIVE_BLOCK_TIME          ( ( TickType_t ) 0U )
  83
  84 #if ( configUSE_PREEMPTION == 0 )
  85
  86 /* If the cooperative scheduler is being used then a yield should not be
  87  * performed just because a higher priority task has been woken. */
  88     #define queueYIELD_IF_USING_PREEMPTION()
  89 #else
  90     #define queueYIELD_IF_USING_PREEMPTION()    vTaskYieldWithinAPI()
  91 #endif
  92
  93 /*
  94  * Definition of the queue used by the scheduler.
  95  * Items are queued by copy, not reference.  See the following link for the
  96  * rationale: https://www.FreeRTOS.org/Embedded-RTOS-Queues.html
  97  */
  98 typedef struct QueueDefinition /* The old naming convention is used to prevent breaking kernel aware debuggers. */
  99 {
 100     int8_t * pcHead;           /*< Points to the beginning of the queue storage area. */
 101     int8_t * pcWriteTo;        /*< Points to the free next place in the storage area. */
 102
 103     union
 104     {
 105         QueuePointers_t xQueue;     /*< Data required exclusively when this structure is used as a queue. */
 106         SemaphoreData_t xSemaphore; /*< Data required exclusively when this structure is used as a semaphore. */
 107     } u;
 108
 109     List_t xTasksWaitingToSend;             /*< List of tasks that are blocked waiting to post onto this queue.  Stored in priority order. */
 110     List_t xTasksWaitingToReceive;          /*< List of tasks that are blocked waiting to read from this queue.  Stored in priority order. */
 111
 112     volatile UBaseType_t uxMessagesWaiting; /*< The number of items currently in the queue. */
 113     UBaseType_t uxLength;                   /*< The length of the queue defined as the number of items it will hold, not the number of bytes. */
 114     UBaseType_t uxItemSize;                 /*< The size of each items that the queue will hold. */
 115
 116     volatile int8_t cRxLock;                /*< Stores the number of items received from the queue (removed from the queue) while the queue was locked.  Set to queueUNLOCKED when the queue is not locked. */
 117     volatile int8_t cTxLock;                /*< Stores the number of items transmitted to the queue (added to the queue) while the queue was locked.  Set to queueUNLOCKED when the queue is not locked. */
 118
 119     #if ( ( configSUPPORT_STATIC_ALLOCATION == 1 ) && ( configSUPPORT_DYNAMIC_ALLOCATION == 1 ) )
 120         uint8_t ucStaticallyAllocated; /*< Set to pdTRUE if the memory used by the queue was statically allocated to ensure no attempt is made to free the memory. */
 121     #endif
 122
 123     #if ( configUSE_QUEUE_SETS == 1 )
 124         struct QueueDefinition * pxQueueSetContainer;
 125     #endif
 126
 127     #if ( configUSE_TRACE_FACILITY == 1 )
 128         UBaseType_t uxQueueNumber;
 129         uint8_t ucQueueType;
 130     #endif
 131 } xQUEUE;
 132
 133 /* The old xQUEUE name is maintained above then typedefed to the new Queue_t
 134  * name below to enable the use of older kernel aware debuggers. */
 135 typedef xQUEUE Queue_t;
 136
 137 /*-----------------------------------------------------------*/
 138
 139 /*
 140  * The queue registry is just a means for kernel aware debuggers to locate
 141  * queue structures.  It has no other purpose so is an optional component.
 142  */
 143 #if ( configQUEUE_REGISTRY_SIZE > 0 )
 144
 145 /* The type stored within the queue registry array.  This allows a name
 146  * to be assigned to each queue making kernel aware debugging a little
 147  * more user friendly. */
 148     typedef struct QUEUE_REGISTRY_ITEM
 149     {
 150         const char * pcQueueName; /*lint !e971 Unqualified char types are allowed for strings and single characters only. */
 151         QueueHandle_t xHandle;
 152     } xQueueRegistryItem;
 153
 154 /* The old xQueueRegistryItem name is maintained above then typedefed to the
 155  * new xQueueRegistryItem name below to enable the use of older kernel aware
 156  * debuggers. */
 157     typedef xQueueRegistryItem QueueRegistryItem_t;
 158
 159 /* The queue registry is simply an array of QueueRegistryItem_t structures.
 160  * The pcQueueName member of a structure being NULL is indicative of the
 161  * array position being vacant. */
 162     PRIVILEGED_DATA QueueRegistryItem_t xQueueRegistry[ configQUEUE_REGISTRY_SIZE ];
 163
 164 #endif /* configQUEUE_REGISTRY_SIZE */
 165
 166 /*
 167  * Unlocks a queue locked by a call to prvLockQueue.  Locking a queue does not
 168  * prevent an ISR from adding or removing items to the queue, but does prevent
 169  * an ISR from removing tasks from the queue event lists.  If an ISR finds a
 170  * queue is locked it will instead increment the appropriate queue lock count
 171  * to indicate that a task may require unblocking.  When the queue in unlocked
 172  * these lock counts are inspected, and the appropriate action taken.
 173  */
 174 static void prvUnlockQueue( Queue_t * const pxQueue ) PRIVILEGED_FUNCTION;
 175
 176 /*
 177  * Uses a critical section to determine if there is any data in a queue.
 178  *
 179  * @return pdTRUE if the queue contains no items, otherwise pdFALSE.
 180  */
 181 static BaseType_t prvIsQueueEmpty( const Queue_t * pxQueue ) PRIVILEGED_FUNCTION;
 182
 183 /*
 184  * Uses a critical section to determine if there is any space in a queue.
 185  *
 186  * @return pdTRUE if there is no space, otherwise pdFALSE;
 187  */
 188 static BaseType_t prvIsQueueFull( const Queue_t * pxQueue ) PRIVILEGED_FUNCTION;
 189
 190 /*
 191  * Copies an item into the queue, either at the front of the queue or the
 192  * back of the queue.
 193  */
 194 static BaseType_t prvCopyDataToQueue( Queue_t * const pxQueue,
 195                                       const void * pvItemToQueue,
 196                                       const BaseType_t xPosition ) PRIVILEGED_FUNCTION;
 197
 198 /*
 199  * Copies an item out of a queue.
 200  */
 201 static void prvCopyDataFromQueue( Queue_t * const pxQueue,
 202                                   void * const pvBuffer ) PRIVILEGED_FUNCTION;
 203
 204 #if ( configUSE_QUEUE_SETS == 1 )
 205
 206 /*
 207  * Checks to see if a queue is a member of a queue set, and if so, notifies
 208  * the queue set that the queue contains data.
 209  */
 210     static BaseType_t prvNotifyQueueSetContainer( const Queue_t * const pxQueue ) PRIVILEGED_FUNCTION;
 211 #endif
 212
 213 /*
 214  * Called after a Queue_t structure has been allocated either statically or
 215  * dynamically to fill in the structure's members.
 216  */
 217 static void prvInitialiseNewQueue( const UBaseType_t uxQueueLength,
 218                                    const UBaseType_t uxItemSize,
 219                                    uint8_t * pucQueueStorage,
 220                                    const uint8_t ucQueueType,
 221                                    Queue_t * pxNewQueue ) PRIVILEGED_FUNCTION;
 222
 223 /*
 224  * Mutexes are a special type of queue.  When a mutex is created, first the
 225  * queue is created, then prvInitialiseMutex() is called to configure the queue
 226  * as a mutex.
 227  */
 228 #if ( configUSE_MUTEXES == 1 )
 229     static void prvInitialiseMutex( Queue_t * pxNewQueue ) PRIVILEGED_FUNCTION;
 230 #endif
 231
 232 #if ( configUSE_MUTEXES == 1 )
 233
 234 /*
 235  * If a task waiting for a mutex causes the mutex holder to inherit a
 236  * priority, but the waiting task times out, then the holder should
 237  * disinherit the priority - but only down to the highest priority of any
 238  * other tasks that are waiting for the same mutex.  This function returns
 239  * that priority.
 240  */
 241     static UBaseType_t prvGetDisinheritPriorityAfterTimeout( const Queue_t * const pxQueue ) PRIVILEGED_FUNCTION;
 242 #endif
 243 /*-----------------------------------------------------------*/
 244
 245 /*
 246  * Macro to mark a queue as locked.  Locking a queue prevents an ISR from
 247  * accessing the queue event lists.
 248  */
 249 #define prvLockQueue( pxQueue )                            \
 250     taskENTER_CRITICAL();                                  \
 251     {                                                      \
 252         if( ( pxQueue )->cRxLock == queueUNLOCKED )        \
 253         {                                                  \
 254             ( pxQueue )->cRxLock = queueLOCKED_UNMODIFIED; \
 255         }                                                  \
 256         if( ( pxQueue )->cTxLock == queueUNLOCKED )        \
 257         {                                                  \
 258             ( pxQueue )->cTxLock = queueLOCKED_UNMODIFIED; \
 259         }                                                  \
 260     }                                                      \
 261     taskEXIT_CRITICAL()
 262 /*-----------------------------------------------------------*/
 263
 264 BaseType_t xQueueGenericReset( QueueHandle_t xQueue,
 265                                BaseType_t xNewQueue )
 266 {
 267     Queue_t * const pxQueue = xQueue;
 268
 269     configASSERT( pxQueue );
 270
 271     taskENTER_CRITICAL();
 272     {
 273         pxQueue->u.xQueue.pcTail = pxQueue->pcHead + ( pxQueue->uxLength * pxQueue->uxItemSize ); /*lint !e9016 Pointer arithmetic allowed on char types, especially when it assists conveying intent. */
 274         pxQueue->uxMessagesWaiting = ( UBaseType_t ) 0U;
 275         pxQueue->pcWriteTo = pxQueue->pcHead;
 276         pxQueue->u.xQueue.pcReadFrom = pxQueue->pcHead + ( ( pxQueue->uxLength - 1U ) * pxQueue->uxItemSize ); /*lint !e9016 Pointer arithmetic allowed on char types, especially when it assists conveying intent. */
 277         pxQueue->cRxLock = queueUNLOCKED;
 278         pxQueue->cTxLock = queueUNLOCKED;
 279
 280         if( xNewQueue == pdFALSE )
 281         {
 282             /* If there are tasks blocked waiting to read from the queue, then
 283              * the tasks will remain blocked as after this function exits the queue
 284              * will still be empty.  If there are tasks blocked waiting to write to
 285              * the queue, then one should be unblocked as after this function exits
 286              * it will be possible to write to it. */
 287             if( listLIST_IS_EMPTY( &( pxQueue->xTasksWaitingToSend ) ) == pdFALSE )
 288             {
 289                 if( xTaskRemoveFromEventList( &( pxQueue->xTasksWaitingToSend ) ) != pdFALSE )
 290                 {
 291                     queueYIELD_IF_USING_PREEMPTION();
 292                 }
 293                 else
 294                 {
 295                     mtCOVERAGE_TEST_MARKER();
 296                 }
 297             }
 298             else
 299             {
 300                 mtCOVERAGE_TEST_MARKER();
 301             }
 302         }
 303         else
 304         {
 305             /* Ensure the event queues start in the correct state. */
 306             vListInitialise( &( pxQueue->xTasksWaitingToSend ) );
 307             vListInitialise( &( pxQueue->xTasksWaitingToReceive ) );
 308         }
 309     }
 310     taskEXIT_CRITICAL();
 311
 312     /* A value is returned for calling semantic consistency with previous
 313      * versions. */
 314     return pdPASS;
 315 }
 316 /*-----------------------------------------------------------*/
 317
 318 #if ( configSUPPORT_STATIC_ALLOCATION == 1 )
 319
 320     QueueHandle_t xQueueGenericCreateStatic( const UBaseType_t uxQueueLength,
 321                                              const UBaseType_t uxItemSize,
 322                                              uint8_t * pucQueueStorage,
 323                                              StaticQueue_t * pxStaticQueue,
 324                                              const uint8_t ucQueueType )
 325     {
 326         Queue_t * pxNewQueue;
 327
 328         configASSERT( uxQueueLength > ( UBaseType_t ) 0 );
 329
 330         /* The StaticQueue_t structure and the queue storage area must be
 331          * supplied. */
 332         configASSERT( pxStaticQueue != NULL );
 333
 334         /* A queue storage area should be provided if the item size is not 0, and
 335          * should not be provided if the item size is 0. */
 336         configASSERT( !( ( pucQueueStorage != NULL ) && ( uxItemSize == 0 ) ) );
 337         configASSERT( !( ( pucQueueStorage == NULL ) && ( uxItemSize != 0 ) ) );
 338
 339         #if ( configASSERT_DEFINED == 1 )
 340             {
 341                 /* Sanity check that the size of the structure used to declare a
 342                  * variable of type StaticQueue_t or StaticSemaphore_t equals the size of
 343                  * the real queue and semaphore structures. */
 344                 volatile size_t xSize = sizeof( StaticQueue_t );
 345
 346                 /* This assertion cannot be branch covered in unit tests */
 347                 configASSERT( xSize == sizeof( Queue_t ) ); /* LCOV_EXCL_BR_LINE */
 348                 ( void ) xSize;                             /* Keeps lint quiet when configASSERT() is not defined. */
 349             }
 350         #endif /* configASSERT_DEFINED */
 351
 352         /* The address of a statically allocated queue was passed in, use it.
 353          * The address of a statically allocated storage area was also passed in
 354          * but is already set. */
 355         pxNewQueue = ( Queue_t * ) pxStaticQueue; /*lint !e740 !e9087 Unusual cast is ok as the structures are designed to have the same alignment, and the size is checked by an assert. */
 356
 357         if( pxNewQueue != NULL )
 358         {
 359             #if ( configSUPPORT_DYNAMIC_ALLOCATION == 1 )
 360                 {
 361                     /* Queues can be allocated wither statically or dynamically, so
 362                      * note this queue was allocated statically in case the queue is
 363                      * later deleted. */
 364                     pxNewQueue->ucStaticallyAllocated = pdTRUE;
 365                 }
 366             #endif /* configSUPPORT_DYNAMIC_ALLOCATION */
 367
 368             prvInitialiseNewQueue( uxQueueLength, uxItemSize, pucQueueStorage, ucQueueType, pxNewQueue );
 369         }
 370         else
 371         {
 372             traceQUEUE_CREATE_FAILED( ucQueueType );
 373             mtCOVERAGE_TEST_MARKER();
 374         }
 375
 376         return pxNewQueue;
 377     }
 378
 379 #endif /* configSUPPORT_STATIC_ALLOCATION */
 380 /*-----------------------------------------------------------*/
 381
 382 #if ( configSUPPORT_DYNAMIC_ALLOCATION == 1 )
 383
 384     QueueHandle_t xQueueGenericCreate( const UBaseType_t uxQueueLength,
 385                                        const UBaseType_t uxItemSize,
 386                                        const uint8_t ucQueueType )
 387     {
 388         Queue_t * pxNewQueue;
 389         size_t xQueueSizeInBytes;
 390         uint8_t * pucQueueStorage;
 391
 392         configASSERT( uxQueueLength > ( UBaseType_t ) 0 );
 393
 394         /* Allocate enough space to hold the maximum number of items that
 395          * can be in the queue at any time.  It is valid for uxItemSize to be
 396          * zero in the case the queue is used as a semaphore. */
 397         xQueueSizeInBytes = ( size_t ) ( uxQueueLength * uxItemSize ); /*lint !e961 MISRA exception as the casts are only redundant for some ports. */
 398
 399         /* Check for multiplication overflow. */
 400         configASSERT( ( uxItemSize == 0 ) || ( uxQueueLength == ( xQueueSizeInBytes / uxItemSize ) ) );
 401
 402         /* Check for addition overflow. */
 403         configASSERT( ( sizeof( Queue_t ) + xQueueSizeInBytes ) > xQueueSizeInBytes );
 404
 405         /* Allocate the queue and storage area.  Justification for MISRA
 406          * deviation as follows:  pvPortMalloc() always ensures returned memory
 407          * blocks are aligned per the requirements of the MCU stack.  In this case
 408          * pvPortMalloc() must return a pointer that is guaranteed to meet the
 409          * alignment requirements of the Queue_t structure - which in this case
 410          * is an int8_t *.  Therefore, whenever the stack alignment requirements
 411          * are greater than or equal to the pointer to char requirements the cast
 412          * is safe.  In other cases alignment requirements are not strict (one or
 413          * two bytes). */
 414         pxNewQueue = ( Queue_t * ) pvPortMalloc( sizeof( Queue_t ) + xQueueSizeInBytes ); /*lint !e9087 !e9079 see comment above. */
 415
 416         if( pxNewQueue != NULL )
 417         {
 418             /* Jump past the queue structure to find the location of the queue
 419              * storage area. */
 420             pucQueueStorage = ( uint8_t * ) pxNewQueue;
 421             pucQueueStorage += sizeof( Queue_t ); /*lint !e9016 Pointer arithmetic allowed on char types, especially when it assists conveying intent. */
 422
 423             #if ( configSUPPORT_STATIC_ALLOCATION == 1 )
 424                 {
 425                     /* Queues can be created either statically or dynamically, so
 426                      * note this task was created dynamically in case it is later
 427                      * deleted. */
 428                     pxNewQueue->ucStaticallyAllocated = pdFALSE;
 429                 }
 430             #endif /* configSUPPORT_STATIC_ALLOCATION */
 431
 432             prvInitialiseNewQueue( uxQueueLength, uxItemSize, pucQueueStorage, ucQueueType, pxNewQueue );
 433         }
 434         else
 435         {
 436             traceQUEUE_CREATE_FAILED( ucQueueType );
 437             mtCOVERAGE_TEST_MARKER();
 438         }
 439
 440         return pxNewQueue;
 441     }
 442
 443 #endif /* configSUPPORT_STATIC_ALLOCATION */
 444 /*-----------------------------------------------------------*/
 445
 446 static void prvInitialiseNewQueue( const UBaseType_t uxQueueLength,
 447                                    const UBaseType_t uxItemSize,
 448                                    uint8_t * pucQueueStorage,
 449                                    const uint8_t ucQueueType,
 450                                    Queue_t * pxNewQueue )
 451 {
 452     /* Remove compiler warnings about unused parameters should
 453      * configUSE_TRACE_FACILITY not be set to 1. */
 454     ( void ) ucQueueType;
 455
 456     if( uxItemSize == ( UBaseType_t ) 0 )
 457     {
 458         /* No RAM was allocated for the queue storage area, but PC head cannot
 459          * be set to NULL because NULL is used as a key to say the queue is used as
 460          * a mutex.  Therefore just set pcHead to point to the queue as a benign
 461          * value that is known to be within the memory map. */
 462         pxNewQueue->pcHead = ( int8_t * ) pxNewQueue;
 463     }
 464     else
 465     {
 466         /* Set the head to the start of the queue storage area. */
 467         pxNewQueue->pcHead = ( int8_t * ) pucQueueStorage;
 468     }
 469
 470     /* Initialise the queue members as described where the queue type is
 471      * defined. */
 472     pxNewQueue->uxLength = uxQueueLength;
 473     pxNewQueue->uxItemSize = uxItemSize;
 474     ( void ) xQueueGenericReset( pxNewQueue, pdTRUE );
 475
 476     #if ( configUSE_TRACE_FACILITY == 1 )
 477         {
 478             pxNewQueue->ucQueueType = ucQueueType;
 479         }
 480     #endif /* configUSE_TRACE_FACILITY */
 481
 482     #if ( configUSE_QUEUE_SETS == 1 )
 483         {
 484             pxNewQueue->pxQueueSetContainer = NULL;
 485         }
 486     #endif /* configUSE_QUEUE_SETS */
 487
 488     traceQUEUE_CREATE( pxNewQueue );
 489 }
 490 /*-----------------------------------------------------------*/
 491
 492 #if ( configUSE_MUTEXES == 1 )
 493
 494     static void prvInitialiseMutex( Queue_t * pxNewQueue )
 495     {
 496         if( pxNewQueue != NULL )
 497         {
 498             /* The queue create function will set all the queue structure members
 499             * correctly for a generic queue, but this function is creating a
 500             * mutex.  Overwrite those members that need to be set differently -
 501             * in particular the information required for priority inheritance. */
 502             pxNewQueue->u.xSemaphore.xMutexHolder = NULL;
 503             pxNewQueue->uxQueueType = queueQUEUE_IS_MUTEX;
 504
 505             /* In case this is a recursive mutex. */
 506             pxNewQueue->u.xSemaphore.uxRecursiveCallCount = 0;
 507
 508             traceCREATE_MUTEX( pxNewQueue );
 509
 510             /* Start with the semaphore in the expected state. */
 511             ( void ) xQueueGenericSend( pxNewQueue, NULL, ( TickType_t ) 0U, queueSEND_TO_BACK );
 512         }
 513         else
 514         {
 515             traceCREATE_MUTEX_FAILED();
 516         }
 517     }
 518
 519 #endif /* configUSE_MUTEXES */
 520 /*-----------------------------------------------------------*/
 521
 522 #if ( ( configUSE_MUTEXES == 1 ) && ( configSUPPORT_DYNAMIC_ALLOCATION == 1 ) )
 523
 524     QueueHandle_t xQueueCreateMutex( const uint8_t ucQueueType )
 525     {
 526         QueueHandle_t xNewQueue;
 527         const UBaseType_t uxMutexLength = ( UBaseType_t ) 1, uxMutexSize = ( UBaseType_t ) 0;
 528
 529         xNewQueue = xQueueGenericCreate( uxMutexLength, uxMutexSize, ucQueueType );
 530         prvInitialiseMutex( ( Queue_t * ) xNewQueue );
 531
 532         return xNewQueue;
 533     }
 534
 535 #endif /* configUSE_MUTEXES */
 536 /*-----------------------------------------------------------*/
 537
 538 #if ( ( configUSE_MUTEXES == 1 ) && ( configSUPPORT_STATIC_ALLOCATION == 1 ) )
 539
 540     QueueHandle_t xQueueCreateMutexStatic( const uint8_t ucQueueType,
 541                                            StaticQueue_t * pxStaticQueue )
 542     {
 543         QueueHandle_t xNewQueue;
 544         const UBaseType_t uxMutexLength = ( UBaseType_t ) 1, uxMutexSize = ( UBaseType_t ) 0;
 545
 546         /* Prevent compiler warnings about unused parameters if
 547          * configUSE_TRACE_FACILITY does not equal 1. */
 548         ( void ) ucQueueType;
 549
 550         xNewQueue = xQueueGenericCreateStatic( uxMutexLength, uxMutexSize, NULL, pxStaticQueue, ucQueueType );
 551         prvInitialiseMutex( ( Queue_t * ) xNewQueue );
 552
 553         return xNewQueue;
 554     }
 555
 556 #endif /* configUSE_MUTEXES */
 557 /*-----------------------------------------------------------*/
 558
 559 #if ( ( configUSE_MUTEXES == 1 ) && ( INCLUDE_xSemaphoreGetMutexHolder == 1 ) )
 560
 561     TaskHandle_t xQueueGetMutexHolder( QueueHandle_t xSemaphore )
 562     {
 563         TaskHandle_t pxReturn;
 564         Queue_t * const pxSemaphore = ( Queue_t * ) xSemaphore;
 565
 566         configASSERT( xSemaphore );
 567
 568         /* This function is called by xSemaphoreGetMutexHolder(), and should not
 569          * be called directly.  Note:  This is a good way of determining if the
 570          * calling task is the mutex holder, but not a good way of determining the
 571          * identity of the mutex holder, as the holder may change between the
 572          * following critical section exiting and the function returning. */
 573         taskENTER_CRITICAL();
 574         {
 575             if( pxSemaphore->uxQueueType == queueQUEUE_IS_MUTEX )
 576             {
 577                 pxReturn = pxSemaphore->u.xSemaphore.xMutexHolder;
 578             }
 579             else
 580             {
 581                 pxReturn = NULL;
 582             }
 583         }
 584         taskEXIT_CRITICAL();
 585
 586         return pxReturn;
 587     } /*lint !e818 xSemaphore cannot be a pointer to const because it is a typedef. */
 588
 589 #endif /* if ( ( configUSE_MUTEXES == 1 ) && ( INCLUDE_xSemaphoreGetMutexHolder == 1 ) ) */
 590 /*-----------------------------------------------------------*/
 591
 592 #if ( ( configUSE_MUTEXES == 1 ) && ( INCLUDE_xSemaphoreGetMutexHolder == 1 ) )
 593
 594     TaskHandle_t xQueueGetMutexHolderFromISR( QueueHandle_t xSemaphore )
 595     {
 596         TaskHandle_t pxReturn;
 597
 598         configASSERT( xSemaphore );
 599
 600         /* Mutexes cannot be used in interrupt service routines, so the mutex
 601          * holder should not change in an ISR, and therefore a critical section is
 602          * not required here. */
 603         if( ( ( Queue_t * ) xSemaphore )->uxQueueType == queueQUEUE_IS_MUTEX )
 604         {
 605             pxReturn = ( ( Queue_t * ) xSemaphore )->u.xSemaphore.xMutexHolder;
 606         }
 607         else
 608         {
 609             pxReturn = NULL;
 610         }
 611
 612         return pxReturn;
 613     } /*lint !e818 xSemaphore cannot be a pointer to const because it is a typedef. */
 614
 615 #endif /* if ( ( configUSE_MUTEXES == 1 ) && ( INCLUDE_xSemaphoreGetMutexHolder == 1 ) ) */
 616 /*-----------------------------------------------------------*/
 617
 618 #if ( configUSE_RECURSIVE_MUTEXES == 1 )
 619
 620     BaseType_t xQueueGiveMutexRecursive( QueueHandle_t xMutex )
 621     {
 622         BaseType_t xReturn;
 623         Queue_t * const pxMutex = ( Queue_t * ) xMutex;
 624
 625         configASSERT( pxMutex );
 626
 627         /* If this is the task that holds the mutex then xMutexHolder will not
 628          * change outside of this task.  If this task does not hold the mutex then
 629          * pxMutexHolder can never coincidentally equal the tasks handle, and as
 630          * this is the only condition we are interested in it does not matter if
 631          * pxMutexHolder is accessed simultaneously by another task.  Therefore no
 632          * mutual exclusion is required to test the pxMutexHolder variable. */
 633         if( pxMutex->u.xSemaphore.xMutexHolder == xTaskGetCurrentTaskHandle() )
 634         {
 635             traceGIVE_MUTEX_RECURSIVE( pxMutex );
 636
 637             /* uxRecursiveCallCount cannot be zero if xMutexHolder is equal to
 638              * the task handle, therefore no underflow check is required.  Also,
 639              * uxRecursiveCallCount is only modified by the mutex holder, and as
 640              * there can only be one, no mutual exclusion is required to modify the
 641              * uxRecursiveCallCount member. */
 642             ( pxMutex->u.xSemaphore.uxRecursiveCallCount )--;
 643
 644             /* Has the recursive call count unwound to 0? */
 645             if( pxMutex->u.xSemaphore.uxRecursiveCallCount == ( UBaseType_t ) 0 )
 646             {
 647                 /* Return the mutex.  This will automatically unblock any other
 648                  * task that might be waiting to access the mutex. */
 649                 ( void ) xQueueGenericSend( pxMutex, NULL, queueMUTEX_GIVE_BLOCK_TIME, queueSEND_TO_BACK );
 650             }
 651             else
 652             {
 653                 mtCOVERAGE_TEST_MARKER();
 654             }
 655
 656             xReturn = pdPASS;
 657         }
 658         else
 659         {
 660             /* The mutex cannot be given because the calling task is not the
 661              * holder. */
 662             xReturn = pdFAIL;
 663
 664             traceGIVE_MUTEX_RECURSIVE_FAILED( pxMutex );
 665         }
 666
 667         return xReturn;
 668     }
 669
 670 #endif /* configUSE_RECURSIVE_MUTEXES */
 671 /*-----------------------------------------------------------*/
 672
 673 #if ( configUSE_RECURSIVE_MUTEXES == 1 )
 674
 675     BaseType_t xQueueTakeMutexRecursive( QueueHandle_t xMutex,
 676                                          TickType_t xTicksToWait )
 677     {
 678         BaseType_t xReturn;
 679         Queue_t * const pxMutex = ( Queue_t * ) xMutex;
 680
 681         configASSERT( pxMutex );
 682
 683         /* Comments regarding mutual exclusion as per those within
 684          * xQueueGiveMutexRecursive(). */
 685
 686         traceTAKE_MUTEX_RECURSIVE( pxMutex );
 687
 688         if( pxMutex->u.xSemaphore.xMutexHolder == xTaskGetCurrentTaskHandle() )
 689         {
 690             ( pxMutex->u.xSemaphore.uxRecursiveCallCount )++;
 691             xReturn = pdPASS;
 692         }
 693         else
 694         {
 695             xReturn = xQueueSemaphoreTake( pxMutex, xTicksToWait );
 696
 697             /* pdPASS will only be returned if the mutex was successfully
 698              * obtained.  The calling task may have entered the Blocked state
 699              * before reaching here. */
 700             if( xReturn != pdFAIL )
 701             {
 702                 ( pxMutex->u.xSemaphore.uxRecursiveCallCount )++;
 703             }
 704             else
 705             {
 706                 traceTAKE_MUTEX_RECURSIVE_FAILED( pxMutex );
 707             }
 708         }
 709
 710         return xReturn;
 711     }
 712
 713 #endif /* configUSE_RECURSIVE_MUTEXES */
 714 /*-----------------------------------------------------------*/
 715
 716 #if ( ( configUSE_COUNTING_SEMAPHORES == 1 ) && ( configSUPPORT_STATIC_ALLOCATION == 1 ) )
 717
 718     QueueHandle_t xQueueCreateCountingSemaphoreStatic( const UBaseType_t uxMaxCount,
 719                                                        const UBaseType_t uxInitialCount,
 720                                                        StaticQueue_t * pxStaticQueue )
 721     {
 722         QueueHandle_t xHandle;
 723
 724         configASSERT( uxMaxCount != 0 );
 725         configASSERT( uxInitialCount <= uxMaxCount );
 726
 727         xHandle = xQueueGenericCreateStatic( uxMaxCount, queueSEMAPHORE_QUEUE_ITEM_LENGTH, NULL, pxStaticQueue, queueQUEUE_TYPE_COUNTING_SEMAPHORE );
 728
 729         if( xHandle != NULL )
 730         {
 731             ( ( Queue_t * ) xHandle )->uxMessagesWaiting = uxInitialCount;
 732
 733             traceCREATE_COUNTING_SEMAPHORE();
 734         }
 735         else
 736         {
 737             traceCREATE_COUNTING_SEMAPHORE_FAILED();
 738         }
 739
 740         return xHandle;
 741     }
 742
 743 #endif /* ( ( configUSE_COUNTING_SEMAPHORES == 1 ) && ( configSUPPORT_DYNAMIC_ALLOCATION == 1 ) ) */
 744 /*-----------------------------------------------------------*/
 745
 746 #if ( ( configUSE_COUNTING_SEMAPHORES == 1 ) && ( configSUPPORT_DYNAMIC_ALLOCATION == 1 ) )
 747
 748     QueueHandle_t xQueueCreateCountingSemaphore( const UBaseType_t uxMaxCount,
 749                                                  const UBaseType_t uxInitialCount )
 750     {
 751         QueueHandle_t xHandle;
 752
 753         configASSERT( uxMaxCount != 0 );
 754         configASSERT( uxInitialCount <= uxMaxCount );
 755
 756         xHandle = xQueueGenericCreate( uxMaxCount, queueSEMAPHORE_QUEUE_ITEM_LENGTH, queueQUEUE_TYPE_COUNTING_SEMAPHORE );
 757
 758         if( xHandle != NULL )
 759         {
 760             ( ( Queue_t * ) xHandle )->uxMessagesWaiting = uxInitialCount;
 761
 762             traceCREATE_COUNTING_SEMAPHORE();
 763         }
 764         else
 765         {
 766             traceCREATE_COUNTING_SEMAPHORE_FAILED();
 767         }
 768
 769         return xHandle;
 770     }
 771
 772 #endif /* ( ( configUSE_COUNTING_SEMAPHORES == 1 ) && ( configSUPPORT_DYNAMIC_ALLOCATION == 1 ) ) */
 773 /*-----------------------------------------------------------*/
 774
 775 BaseType_t xQueueGenericSend( QueueHandle_t xQueue,
 776                               const void * const pvItemToQueue,
 777                               TickType_t xTicksToWait,
 778                               const BaseType_t xCopyPosition )
 779 {
 780     BaseType_t xEntryTimeSet = pdFALSE, xYieldRequired;
 781     TimeOut_t xTimeOut;
 782     Queue_t * const pxQueue = xQueue;
 783
 784     configASSERT( pxQueue );
 785     configASSERT( !( ( pvItemToQueue == NULL ) && ( pxQueue->uxItemSize != ( UBaseType_t ) 0U ) ) );
 786     configASSERT( !( ( xCopyPosition == queueOVERWRITE ) && ( pxQueue->uxLength != 1 ) ) );
 787     #if ( ( INCLUDE_xTaskGetSchedulerState == 1 ) || ( configUSE_TIMERS == 1 ) )
 788         {
 789             configASSERT( !( ( xTaskGetSchedulerState() == taskSCHEDULER_SUSPENDED ) && ( xTicksToWait != 0 ) ) );
 790         }
 791     #endif
 792
 793     /*lint -save -e904 This function relaxes the coding standard somewhat to
 794      * allow return statements within the function itself.  This is done in the
 795      * interest of execution time efficiency. */
 796     for( ; ; )
 797     {
 798         taskENTER_CRITICAL();
 799         {
 800             /* Is there room on the queue now?  The running task must be the
 801              * highest priority task wanting to access the queue.  If the head item
 802              * in the queue is to be overwritten then it does not matter if the
 803              * queue is full. */
 804             if( ( pxQueue->uxMessagesWaiting < pxQueue->uxLength ) || ( xCopyPosition == queueOVERWRITE ) )
 805             {
 806                 traceQUEUE_SEND( pxQueue );
 807
 808                 #if ( configUSE_QUEUE_SETS == 1 )
 809                     {
 810                         const UBaseType_t uxPreviousMessagesWaiting = pxQueue->uxMessagesWaiting;
 811
 812                         xYieldRequired = prvCopyDataToQueue( pxQueue, pvItemToQueue, xCopyPosition );
 813
 814                         if( pxQueue->pxQueueSetContainer != NULL )
 815                         {
 816                             if( ( xCopyPosition == queueOVERWRITE ) && ( uxPreviousMessagesWaiting != ( UBaseType_t ) 0 ) )
 817                             {
 818                                 /* Do not notify the queue set as an existing item
 819                                  * was overwritten in the queue so the number of items
 820                                  * in the queue has not changed. */
 821                                 mtCOVERAGE_TEST_MARKER();
 822                             }
 823                             else if( prvNotifyQueueSetContainer( pxQueue ) != pdFALSE )
 824                             {
 825                                 /* The queue is a member of a queue set, and posting
 826                                  * to the queue set caused a higher priority task to
 827                                  * unblock. A context switch is required. */
 828                                 queueYIELD_IF_USING_PREEMPTION();
 829                             }
 830                             else
 831                             {
 832                                 mtCOVERAGE_TEST_MARKER();
 833                             }
 834                         }
 835                         else
 836                         {
 837                             /* If there was a task waiting for data to arrive on the
 838                              * queue then unblock it now. */
 839                             if( listLIST_IS_EMPTY( &( pxQueue->xTasksWaitingToReceive ) ) == pdFALSE )
 840                             {
 841                                 if( xTaskRemoveFromEventList( &( pxQueue->xTasksWaitingToReceive ) ) != pdFALSE )
 842                                 {
 843                                     /* The unblocked task has a priority higher than
 844                                      * our own so yield immediately.  Yes it is ok to
 845                                      * do this from within the critical section - the
 846                                      * kernel takes care of that. */
 847                                     queueYIELD_IF_USING_PREEMPTION();
 848                                 }
 849                                 else
 850                                 {
 851                                     mtCOVERAGE_TEST_MARKER();
 852                                 }
 853                             }
 854                             else if( xYieldRequired != pdFALSE )
 855                             {
 856                                 /* This path is a special case that will only get
 857                                  * executed if the task was holding multiple mutexes
 858                                  * and the mutexes were given back in an order that is
 859                                  * different to that in which they were taken. */
 860                                 queueYIELD_IF_USING_PREEMPTION();
 861                             }
 862                             else
 863                             {
 864                                 mtCOVERAGE_TEST_MARKER();
 865                             }
 866                         }
 867                     }
 868                 #else /* configUSE_QUEUE_SETS */
 869                     {
 870                         xYieldRequired = prvCopyDataToQueue( pxQueue, pvItemToQueue, xCopyPosition );
 871
 872                         /* If there was a task waiting for data to arrive on the
 873                          * queue then unblock it now. */
 874                         if( listLIST_IS_EMPTY( &( pxQueue->xTasksWaitingToReceive ) ) == pdFALSE )
 875                         {
 876                             if( xTaskRemoveFromEventList( &( pxQueue->xTasksWaitingToReceive ) ) != pdFALSE )
 877                             {
 878                                 /* The unblocked task has a priority higher than
 879                                  * our own so yield immediately.  Yes it is ok to do
 880                                  * this from within the critical section - the kernel
 881                                  * takes care of that. */
 882                                 queueYIELD_IF_USING_PREEMPTION();
 883                             }
 884                             else
 885                             {
 886                                 mtCOVERAGE_TEST_MARKER();
 887                             }
 888                         }
 889                         else if( xYieldRequired != pdFALSE )
 890                         {
 891                             /* This path is a special case that will only get
 892                              * executed if the task was holding multiple mutexes and
 893                              * the mutexes were given back in an order that is
 894                              * different to that in which they were taken. */
 895                             queueYIELD_IF_USING_PREEMPTION();
 896                         }
 897                         else
 898                         {
 899                             mtCOVERAGE_TEST_MARKER();
 900                         }
 901                     }
 902                 #endif /* configUSE_QUEUE_SETS */
 903
 904                 taskEXIT_CRITICAL();
 905                 return pdPASS;
 906             }
 907             else
 908             {
 909                 if( xTicksToWait == ( TickType_t ) 0 )
 910                 {
 911                     /* The queue was full and no block time is specified (or
 912                      * the block time has expired) so leave now. */
 913                     taskEXIT_CRITICAL();
 914
 915                     /* Return to the original privilege level before exiting
 916                      * the function. */
 917                     traceQUEUE_SEND_FAILED( pxQueue );
 918                     return errQUEUE_FULL;
 919                 }
 920                 else if( xEntryTimeSet == pdFALSE )
 921                 {
 922                     /* The queue was full and a block time was specified so
 923                      * configure the timeout structure. */
 924                     vTaskInternalSetTimeOutState( &xTimeOut );
 925                     xEntryTimeSet = pdTRUE;
 926                 }
 927                 else
 928                 {
 929                     /* Entry time was already set. */
 930                     mtCOVERAGE_TEST_MARKER();
 931                 }
 932             }
 933         }
 934         taskEXIT_CRITICAL();
 935
 936         /* Interrupts and other tasks can send to and receive from the queue
 937          * now the critical section has been exited. */
 938
 939         vTaskSuspendAll();
 940         prvLockQueue( pxQueue );
 941
 942         /* Update the timeout state to see if it has expired yet. */
 943         if( xTaskCheckForTimeOut( &xTimeOut, &xTicksToWait ) == pdFALSE )
 944         {
 945             if( prvIsQueueFull( pxQueue ) != pdFALSE )
 946             {
 947                 traceBLOCKING_ON_QUEUE_SEND( pxQueue );
 948                 vTaskPlaceOnEventList( &( pxQueue->xTasksWaitingToSend ), xTicksToWait );
 949
 950                 /* Unlocking the queue means queue events can effect the
 951                  * event list. It is possible that interrupts occurring now
 952                  * remove this task from the event list again - but as the
 953                  * scheduler is suspended the task will go onto the pending
 954                  * ready list instead of the actual ready list. */
 955                 prvUnlockQueue( pxQueue );
 956
 957                 /* Resuming the scheduler will move tasks from the pending
 958                  * ready list into the ready list - so it is feasible that this
 959                  * task is already in the ready list before it yields - in which
 960                  * case the yield will not cause a context switch unless there
 961                  * is also a higher priority task in the pending ready list. */
 962                 if( xTaskResumeAll() == pdFALSE )
 963                 {
 964                     vTaskYieldWithinAPI();
 965                 }
 966             }
 967             else
 968             {
 969                 /* Try again. */
 970                 prvUnlockQueue( pxQueue );
 971                 ( void ) xTaskResumeAll();
 972             }
 973         }
 974         else
 975         {
 976             /* The timeout has expired. */
 977             prvUnlockQueue( pxQueue );
 978             ( void ) xTaskResumeAll();
 979
 980             traceQUEUE_SEND_FAILED( pxQueue );
 981             return errQUEUE_FULL;
 982         }
 983     } /*lint -restore */
 984 }
 985 /*-----------------------------------------------------------*/
 986
 987 BaseType_t xQueueGenericSendFromISR( QueueHandle_t xQueue,
 988                                      const void * const pvItemToQueue,
 989                                      BaseType_t * const pxHigherPriorityTaskWoken,
 990                                      const BaseType_t xCopyPosition )
 991 {
 992     BaseType_t xReturn;
 993     UBaseType_t uxSavedInterruptStatus;
 994     Queue_t * const pxQueue = xQueue;
 995
 996     configASSERT( pxQueue );
 997     configASSERT( !( ( pvItemToQueue == NULL ) && ( pxQueue->uxItemSize != ( UBaseType_t ) 0U ) ) );
 998     configASSERT( !( ( xCopyPosition == queueOVERWRITE ) && ( pxQueue->uxLength != 1 ) ) );
 999
1000     /* RTOS ports that support interrupt nesting have the concept of a maximum
1001      * system call (or maximum API call) interrupt priority.  Interrupts that are
1002      * above the maximum system call priority are kept permanently enabled, even
1003      * when the RTOS kernel is in a critical section, but cannot make any calls to
1004      * FreeRTOS API functions.  If configASSERT() is defined in FreeRTOSConfig.h
1005      * then portASSERT_IF_INTERRUPT_PRIORITY_INVALID() will result in an assertion
1006      * failure if a FreeRTOS API function is called from an interrupt that has been
1007      * assigned a priority above the configured maximum system call priority.
1008      * Only FreeRTOS functions that end in FromISR can be called from interrupts
1009      * that have been assigned a priority at or (logically) below the maximum
1010      * system call interrupt priority.  FreeRTOS maintains a separate interrupt
1011      * safe API to ensure interrupt entry is as fast and as simple as possible.
1012      * More information (albeit Cortex-M specific) is provided on the following
1013      * link: https://www.FreeRTOS.org/RTOS-Cortex-M3-M4.html */
1014     portASSERT_IF_INTERRUPT_PRIORITY_INVALID();
1015
1016     /* Similar to xQueueGenericSend, except without blocking if there is no room
1017      * in the queue.  Also don't directly wake a task that was blocked on a queue
1018      * read, instead return a flag to say whether a context switch is required or
1019      * not (i.e. has a task with a higher priority than us been woken by this
1020      * post). */
1021     uxSavedInterruptStatus = portSET_INTERRUPT_MASK_FROM_ISR();
1022     {
1023         if( ( pxQueue->uxMessagesWaiting < pxQueue->uxLength ) || ( xCopyPosition == queueOVERWRITE ) )
1024         {
1025             const int8_t cTxLock = pxQueue->cTxLock;
1026             const UBaseType_t uxPreviousMessagesWaiting = pxQueue->uxMessagesWaiting;
1027
1028             traceQUEUE_SEND_FROM_ISR( pxQueue );
1029
1030             /* Semaphores use xQueueGiveFromISR(), so pxQueue will not be a
1031              *  semaphore or mutex.  That means prvCopyDataToQueue() cannot result
1032              *  in a task disinheriting a priority and prvCopyDataToQueue() can be
1033              *  called here even though the disinherit function does not check if
1034              *  the scheduler is suspended before accessing the ready lists. */
1035             ( void ) prvCopyDataToQueue( pxQueue, pvItemToQueue, xCopyPosition );
1036
1037             /* The event list is not altered if the queue is locked.  This will
1038              * be done when the queue is unlocked later. */
1039             if( cTxLock == queueUNLOCKED )
1040             {
1041                 #if ( configUSE_QUEUE_SETS == 1 )
1042                     {
1043                         if( pxQueue->pxQueueSetContainer != NULL )
1044                         {
1045                             if( ( xCopyPosition == queueOVERWRITE ) && ( uxPreviousMessagesWaiting != ( UBaseType_t ) 0 ) )
1046                             {
1047                                 /* Do not notify the queue set as an existing item
1048                                  * was overwritten in the queue so the number of items
1049                                  * in the queue has not changed. */
1050                                 mtCOVERAGE_TEST_MARKER();
1051                             }
1052                             else if( prvNotifyQueueSetContainer( pxQueue ) != pdFALSE )
1053                             {
1054                                 /* The queue is a member of a queue set, and posting
1055                                  * to the queue set caused a higher priority task to
1056                                  * unblock.  A context switch is required. */
1057                                 if( pxHigherPriorityTaskWoken != NULL )
1058                                 {
1059                                     *pxHigherPriorityTaskWoken = pdTRUE;
1060                                 }
1061                                 else
1062                                 {
1063                                     mtCOVERAGE_TEST_MARKER();
1064                                 }
1065                             }
1066                             else
1067                             {
1068                                 mtCOVERAGE_TEST_MARKER();
1069                             }
1070                         }
1071                         else
1072                         {
1073                             if( listLIST_IS_EMPTY( &( pxQueue->xTasksWaitingToReceive ) ) == pdFALSE )
1074                             {
1075                                 if( xTaskRemoveFromEventList( &( pxQueue->xTasksWaitingToReceive ) ) != pdFALSE )
1076                                 {
1077                                     /* The task waiting has a higher priority so
1078                                      *  record that a context switch is required. */
1079                                     if( pxHigherPriorityTaskWoken != NULL )
1080                                     {
1081                                         *pxHigherPriorityTaskWoken = pdTRUE;
1082                                     }
1083                                     else
1084                                     {
1085                                         mtCOVERAGE_TEST_MARKER();
1086                                     }
1087                                 }
1088                                 else
1089                                 {
1090                                     mtCOVERAGE_TEST_MARKER();
1091                                 }
1092                             }
1093                             else
1094                             {
1095                                 mtCOVERAGE_TEST_MARKER();
1096                             }
1097                         }
1098                     }
1099                 #else /* configUSE_QUEUE_SETS */
1100                     {
1101                         if( listLIST_IS_EMPTY( &( pxQueue->xTasksWaitingToReceive ) ) == pdFALSE )
1102                         {
1103                             if( xTaskRemoveFromEventList( &( pxQueue->xTasksWaitingToReceive ) ) != pdFALSE )
1104                             {
1105                                 /* The task waiting has a higher priority so record that a
1106                                  * context switch is required. */
1107                                 if( pxHigherPriorityTaskWoken != NULL )
1108                                 {
1109                                     *pxHigherPriorityTaskWoken = pdTRUE;
1110                                 }
1111                                 else
1112                                 {
1113                                     mtCOVERAGE_TEST_MARKER();
1114                                 }
1115                             }
1116                             else
1117                             {
1118                                 mtCOVERAGE_TEST_MARKER();
1119                             }
1120                         }
1121                         else
1122                         {
1123                             mtCOVERAGE_TEST_MARKER();
1124                         }
1125
1126                         /* Not used in this path. */
1127                         ( void ) uxPreviousMessagesWaiting;
1128                     }
1129                 #endif /* configUSE_QUEUE_SETS */
1130             }
1131             else
1132             {
1133                 /* Increment the lock count so the task that unlocks the queue
1134                  * knows that data was posted while it was locked. */
1135                 configASSERT( cTxLock != queueINT8_MAX );
1136
1137                 pxQueue->cTxLock = ( int8_t ) ( cTxLock + 1 );
1138             }
1139
1140             xReturn = pdPASS;
1141         }
1142         else
1143         {
1144             traceQUEUE_SEND_FROM_ISR_FAILED( pxQueue );
1145             xReturn = errQUEUE_FULL;
1146         }
1147     }
1148     portCLEAR_INTERRUPT_MASK_FROM_ISR( uxSavedInterruptStatus );
1149
1150     return xReturn;
1151 }
1152 /*-----------------------------------------------------------*/
1153
1154 BaseType_t xQueueGiveFromISR( QueueHandle_t xQueue,
1155                               BaseType_t * const pxHigherPriorityTaskWoken )
1156 {
1157     BaseType_t xReturn;
1158     UBaseType_t uxSavedInterruptStatus;
1159     Queue_t * const pxQueue = xQueue;
1160
1161     /* Similar to xQueueGenericSendFromISR() but used with semaphores where the
1162      * item size is 0.  Don't directly wake a task that was blocked on a queue
1163      * read, instead return a flag to say whether a context switch is required or
1164      * not (i.e. has a task with a higher priority than us been woken by this
1165      * post). */
1166
1167     configASSERT( pxQueue );
1168
1169     /* xQueueGenericSendFromISR() should be used instead of xQueueGiveFromISR()
1170      * if the item size is not 0. */
1171     configASSERT( pxQueue->uxItemSize == 0 );
1172
1173     /* Normally a mutex would not be given from an interrupt, especially if
1174      * there is a mutex holder, as priority inheritance makes no sense for an
1175      * interrupts, only tasks. */
1176     configASSERT( !( ( pxQueue->uxQueueType == queueQUEUE_IS_MUTEX ) && ( pxQueue->u.xSemaphore.xMutexHolder != NULL ) ) );
1177
1178     /* RTOS ports that support interrupt nesting have the concept of a maximum
1179      * system call (or maximum API call) interrupt priority.  Interrupts that are
1180      * above the maximum system call priority are kept permanently enabled, even
1181      * when the RTOS kernel is in a critical section, but cannot make any calls to
1182      * FreeRTOS API functions.  If configASSERT() is defined in FreeRTOSConfig.h
1183      * then portASSERT_IF_INTERRUPT_PRIORITY_INVALID() will result in an assertion
1184      * failure if a FreeRTOS API function is called from an interrupt that has been
1185      * assigned a priority above the configured maximum system call priority.
1186      * Only FreeRTOS functions that end in FromISR can be called from interrupts
1187      * that have been assigned a priority at or (logically) below the maximum
1188      * system call interrupt priority.  FreeRTOS maintains a separate interrupt
1189      * safe API to ensure interrupt entry is as fast and as simple as possible.
1190      * More information (albeit Cortex-M specific) is provided on the following
1191      * link: https://www.FreeRTOS.org/RTOS-Cortex-M3-M4.html */
1192     portASSERT_IF_INTERRUPT_PRIORITY_INVALID();
1193
1194     uxSavedInterruptStatus = portSET_INTERRUPT_MASK_FROM_ISR();
1195     {
1196         const UBaseType_t uxMessagesWaiting = pxQueue->uxMessagesWaiting;
1197
1198         /* When the queue is used to implement a semaphore no data is ever
1199          * moved through the queue but it is still valid to see if the queue 'has
1200          * space'. */
1201         if( uxMessagesWaiting < pxQueue->uxLength )
1202         {
1203             const int8_t cTxLock = pxQueue->cTxLock;
1204
1205             traceQUEUE_SEND_FROM_ISR( pxQueue );
1206
1207             /* A task can only have an inherited priority if it is a mutex
1208              * holder - and if there is a mutex holder then the mutex cannot be
1209              * given from an ISR.  As this is the ISR version of the function it
1210              * can be assumed there is no mutex holder and no need to determine if
1211              * priority disinheritance is needed.  Simply increase the count of
1212              * messages (semaphores) available. */
1213             pxQueue->uxMessagesWaiting = uxMessagesWaiting + ( UBaseType_t ) 1;
1214
1215             /* The event list is not altered if the queue is locked.  This will
1216              * be done when the queue is unlocked later. */
1217             if( cTxLock == queueUNLOCKED )
1218             {
1219                 #if ( configUSE_QUEUE_SETS == 1 )
1220                     {
1221                         if( pxQueue->pxQueueSetContainer != NULL )
1222                         {
1223                             if( prvNotifyQueueSetContainer( pxQueue ) != pdFALSE )
1224                             {
1225                                 /* The semaphore is a member of a queue set, and
1226                                  * posting to the queue set caused a higher priority
1227                                  * task to unblock.  A context switch is required. */
1228                                 if( pxHigherPriorityTaskWoken != NULL )
1229                                 {
1230                                     *pxHigherPriorityTaskWoken = pdTRUE;
1231                                 }
1232                                 else
1233                                 {
1234                                     mtCOVERAGE_TEST_MARKER();
1235                                 }
1236                             }
1237                             else
1238                             {
1239                                 mtCOVERAGE_TEST_MARKER();
1240                             }
1241                         }
1242                         else
1243                         {
1244                             if( listLIST_IS_EMPTY( &( pxQueue->xTasksWaitingToReceive ) ) == pdFALSE )
1245                             {
1246                                 if( xTaskRemoveFromEventList( &( pxQueue->xTasksWaitingToReceive ) ) != pdFALSE )
1247                                 {
1248                                     /* The task waiting has a higher priority so
1249                                      *  record that a context switch is required. */
1250                                     if( pxHigherPriorityTaskWoken != NULL )
1251                                     {
1252                                         *pxHigherPriorityTaskWoken = pdTRUE;
1253                                     }
1254                                     else
1255                                     {
1256                                         mtCOVERAGE_TEST_MARKER();
1257                                     }
1258                                 }
1259                                 else
1260                                 {
1261                                     mtCOVERAGE_TEST_MARKER();
1262                                 }
1263                             }
1264                             else
1265                             {
1266                                 mtCOVERAGE_TEST_MARKER();
1267                             }
1268                         }
1269                     }
1270                 #else /* configUSE_QUEUE_SETS */
1271                     {
1272                         if( listLIST_IS_EMPTY( &( pxQueue->xTasksWaitingToReceive ) ) == pdFALSE )
1273                         {
1274                             if( xTaskRemoveFromEventList( &( pxQueue->xTasksWaitingToReceive ) ) != pdFALSE )
1275                             {
1276                                 /* The task waiting has a higher priority so record that a
1277                                  * context switch is required. */
1278                                 if( pxHigherPriorityTaskWoken != NULL )
1279                                 {
1280                                     *pxHigherPriorityTaskWoken = pdTRUE;
1281                                 }
1282                                 else
1283                                 {
1284                                     mtCOVERAGE_TEST_MARKER();
1285                                 }
1286                             }
1287                             else
1288                             {
1289                                 mtCOVERAGE_TEST_MARKER();
1290                             }
1291                         }
1292                         else
1293                         {
1294                             mtCOVERAGE_TEST_MARKER();
1295                         }
1296                     }
1297                 #endif /* configUSE_QUEUE_SETS */
1298             }
1299             else
1300             {
1301                 /* Increment the lock count so the task that unlocks the queue
1302                  * knows that data was posted while it was locked. */
1303                 configASSERT( cTxLock != queueINT8_MAX );
1304
1305                 pxQueue->cTxLock = ( int8_t ) ( cTxLock + 1 );
1306             }
1307
1308             xReturn = pdPASS;
1309         }
1310         else
1311         {
1312             traceQUEUE_SEND_FROM_ISR_FAILED( pxQueue );
1313             xReturn = errQUEUE_FULL;
1314         }
1315     }
1316     portCLEAR_INTERRUPT_MASK_FROM_ISR( uxSavedInterruptStatus );
1317
1318     return xReturn;
1319 }
1320 /*-----------------------------------------------------------*/
1321
1322 BaseType_t xQueueReceive( QueueHandle_t xQueue,
1323                           void * const pvBuffer,
1324                           TickType_t xTicksToWait )
1325 {
1326     BaseType_t xEntryTimeSet = pdFALSE;
1327     TimeOut_t xTimeOut;
1328     Queue_t * const pxQueue = xQueue;
1329
1330     /* Check the pointer is not NULL. */
1331     configASSERT( ( pxQueue ) );
1332
1333     /* The buffer into which data is received can only be NULL if the data size
1334      * is zero (so no data is copied into the buffer). */
1335     configASSERT( !( ( ( pvBuffer ) == NULL ) && ( ( pxQueue )->uxItemSize != ( UBaseType_t ) 0U ) ) );
1336
1337     /* Cannot block if the scheduler is suspended. */
1338     #if ( ( INCLUDE_xTaskGetSchedulerState == 1 ) || ( configUSE_TIMERS == 1 ) )
1339         {
1340             configASSERT( !( ( xTaskGetSchedulerState() == taskSCHEDULER_SUSPENDED ) && ( xTicksToWait != 0 ) ) );
1341         }
1342     #endif
1343
1344     /*lint -save -e904  This function relaxes the coding standard somewhat to
1345      * allow return statements within the function itself.  This is done in the
1346      * interest of execution time efficiency. */
1347     for( ; ; )
1348     {
1349         taskENTER_CRITICAL();
1350         {
1351             const UBaseType_t uxMessagesWaiting = pxQueue->uxMessagesWaiting;
1352
1353             /* Is there data in the queue now?  To be running the calling task
1354              * must be the highest priority task wanting to access the queue. */
1355             if( uxMessagesWaiting > ( UBaseType_t ) 0 )
1356             {
1357                 /* Data available, remove one item. */
1358                 prvCopyDataFromQueue( pxQueue, pvBuffer );
1359                 traceQUEUE_RECEIVE( pxQueue );
1360                 pxQueue->uxMessagesWaiting = uxMessagesWaiting - ( UBaseType_t ) 1;
1361
1362                 /* There is now space in the queue, were any tasks waiting to
1363                  * post to the queue?  If so, unblock the highest priority waiting
1364                  * task. */
1365                 if( listLIST_IS_EMPTY( &( pxQueue->xTasksWaitingToSend ) ) == pdFALSE )
1366                 {
1367                     if( xTaskRemoveFromEventList( &( pxQueue->xTasksWaitingToSend ) ) != pdFALSE )
1368                     {
1369                         queueYIELD_IF_USING_PREEMPTION();
1370                     }
1371                     else
1372                     {
1373                         mtCOVERAGE_TEST_MARKER();
1374                     }
1375                 }
1376                 else
1377                 {
1378                     mtCOVERAGE_TEST_MARKER();
1379                 }
1380
1381                 taskEXIT_CRITICAL();
1382                 return pdPASS;
1383             }
1384             else
1385             {
1386                 if( xTicksToWait == ( TickType_t ) 0 )
1387                 {
1388                     /* The queue was empty and no block time is specified (or
1389                      * the block time has expired) so leave now. */
1390                     taskEXIT_CRITICAL();
1391                     traceQUEUE_RECEIVE_FAILED( pxQueue );
1392                     return errQUEUE_EMPTY;
1393                 }
1394                 else if( xEntryTimeSet == pdFALSE )
1395                 {
1396                     /* The queue was empty and a block time was specified so
1397                      * configure the timeout structure. */
1398                     vTaskInternalSetTimeOutState( &xTimeOut );
1399                     xEntryTimeSet = pdTRUE;
1400                 }
1401                 else
1402                 {
1403                     /* Entry time was already set. */
1404                     mtCOVERAGE_TEST_MARKER();
1405                 }
1406             }
1407         }
1408         taskEXIT_CRITICAL();
1409
1410         /* Interrupts and other tasks can send to and receive from the queue
1411          * now the critical section has been exited. */
1412
1413         vTaskSuspendAll();
1414         prvLockQueue( pxQueue );
1415
1416         /* Update the timeout state to see if it has expired yet. */
1417         if( xTaskCheckForTimeOut( &xTimeOut, &xTicksToWait ) == pdFALSE )
1418         {
1419             /* The timeout has not expired.  If the queue is still empty place
1420              * the task on the list of tasks waiting to receive from the queue. */
1421             if( prvIsQueueEmpty( pxQueue ) != pdFALSE )
1422             {
1423                 traceBLOCKING_ON_QUEUE_RECEIVE( pxQueue );
1424                 vTaskPlaceOnEventList( &( pxQueue->xTasksWaitingToReceive ), xTicksToWait );
1425                 prvUnlockQueue( pxQueue );
1426
1427                 if( xTaskResumeAll() == pdFALSE )
1428                 {
1429                     vTaskYieldWithinAPI();
1430                 }
1431                 else
1432                 {
1433                     mtCOVERAGE_TEST_MARKER();
1434                 }
1435             }
1436             else
1437             {
1438                 /* The queue contains data again.  Loop back to try and read the
1439                  * data. */
1440                 prvUnlockQueue( pxQueue );
1441                 ( void ) xTaskResumeAll();
1442             }
1443         }
1444         else
1445         {
1446             /* Timed out.  If there is no data in the queue exit, otherwise loop
1447              * back and attempt to read the data. */
1448             prvUnlockQueue( pxQueue );
1449             ( void ) xTaskResumeAll();
1450
1451             if( prvIsQueueEmpty( pxQueue ) != pdFALSE )
1452             {
1453                 traceQUEUE_RECEIVE_FAILED( pxQueue );
1454                 return errQUEUE_EMPTY;
1455             }
1456             else
1457             {
1458                 mtCOVERAGE_TEST_MARKER();
1459             }
1460         }
1461     } /*lint -restore */
1462 }
1463 /*-----------------------------------------------------------*/
1464
1465 BaseType_t xQueueSemaphoreTake( QueueHandle_t xQueue,
1466                                 TickType_t xTicksToWait )
1467 {
1468     BaseType_t xEntryTimeSet = pdFALSE;
1469     TimeOut_t xTimeOut;
1470     Queue_t * const pxQueue = xQueue;
1471
1472     #if ( configUSE_MUTEXES == 1 )
1473         BaseType_t xInheritanceOccurred = pdFALSE;
1474     #endif
1475
1476     /* Check the queue pointer is not NULL. */
1477     configASSERT( ( pxQueue ) );
1478
1479     /* Check this really is a semaphore, in which case the item size will be
1480      * 0. */
1481     configASSERT( pxQueue->uxItemSize == 0 );
1482
1483     /* Cannot block if the scheduler is suspended. */
1484     #if ( ( INCLUDE_xTaskGetSchedulerState == 1 ) || ( configUSE_TIMERS == 1 ) )
1485         {
1486             configASSERT( !( ( xTaskGetSchedulerState() == taskSCHEDULER_SUSPENDED ) && ( xTicksToWait != 0 ) ) );
1487         }
1488     #endif
1489
1490     /*lint -save -e904 This function relaxes the coding standard somewhat to allow return
1491      * statements within the function itself.  This is done in the interest
1492      * of execution time efficiency. */
1493     for( ; ; )
1494     {
1495         taskENTER_CRITICAL();
1496         {
1497             /* Semaphores are queues with an item size of 0, and where the
1498              * number of messages in the queue is the semaphore's count value. */
1499             const UBaseType_t uxSemaphoreCount = pxQueue->uxMessagesWaiting;
1500
1501             /* Is there data in the queue now?  To be running the calling task
1502              * must be the highest priority task wanting to access the queue. */
1503             if( uxSemaphoreCount > ( UBaseType_t ) 0 )
1504             {
1505                 traceQUEUE_RECEIVE( pxQueue );
1506
1507                 /* Semaphores are queues with a data size of zero and where the
1508                  * messages waiting is the semaphore's count.  Reduce the count. */
1509                 pxQueue->uxMessagesWaiting = uxSemaphoreCount - ( UBaseType_t ) 1;
1510
1511                 #if ( configUSE_MUTEXES == 1 )
1512                     {
1513                         if( pxQueue->uxQueueType == queueQUEUE_IS_MUTEX )
1514                         {
1515                             /* Record the information required to implement
1516                              * priority inheritance should it become necessary. */
1517                             pxQueue->u.xSemaphore.xMutexHolder = pvTaskIncrementMutexHeldCount();
1518                         }
1519                         else
1520                         {
1521                             mtCOVERAGE_TEST_MARKER();
1522                         }
1523                     }
1524                 #endif /* configUSE_MUTEXES */
1525
1526                 /* Check to see if other tasks are blocked waiting to give the
1527                  * semaphore, and if so, unblock the highest priority such task. */
1528                 if( listLIST_IS_EMPTY( &( pxQueue->xTasksWaitingToSend ) ) == pdFALSE )
1529                 {
1530                     if( xTaskRemoveFromEventList( &( pxQueue->xTasksWaitingToSend ) ) != pdFALSE )
1531                     {
1532                         queueYIELD_IF_USING_PREEMPTION();
1533                     }
1534                     else
1535                     {
1536                         mtCOVERAGE_TEST_MARKER();
1537                     }
1538                 }
1539                 else
1540                 {
1541                     mtCOVERAGE_TEST_MARKER();
1542                 }
1543
1544                 taskEXIT_CRITICAL();
1545                 return pdPASS;
1546             }
1547             else
1548             {
1549                 if( xTicksToWait == ( TickType_t ) 0 )
1550                 {
1551                     /* For inheritance to have occurred there must have been an
1552                      * initial timeout, and an adjusted timeout cannot become 0, as
1553                      * if it were 0 the function would have exited. */
1554                     #if ( configUSE_MUTEXES == 1 )
1555                         {
1556                             configASSERT( xInheritanceOccurred == pdFALSE );
1557                         }
1558                     #endif /* configUSE_MUTEXES */
1559
1560                     /* The semaphore count was 0 and no block time is specified
1561                      * (or the block time has expired) so exit now. */
1562                     taskEXIT_CRITICAL();
1563                     traceQUEUE_RECEIVE_FAILED( pxQueue );
1564                     return errQUEUE_EMPTY;
1565                 }
1566                 else if( xEntryTimeSet == pdFALSE )
1567                 {
1568                     /* The semaphore count was 0 and a block time was specified
1569                      * so configure the timeout structure ready to block. */
1570                     vTaskInternalSetTimeOutState( &xTimeOut );
1571                     xEntryTimeSet = pdTRUE;
1572                 }
1573                 else
1574                 {
1575                     /* Entry time was already set. */
1576                     mtCOVERAGE_TEST_MARKER();
1577                 }
1578             }
1579         }
1580         taskEXIT_CRITICAL();
1581
1582         /* Interrupts and other tasks can give to and take from the semaphore
1583          * now the critical section has been exited. */
1584
1585         vTaskSuspendAll();
1586         prvLockQueue( pxQueue );
1587
1588         /* Update the timeout state to see if it has expired yet. */
1589         if( xTaskCheckForTimeOut( &xTimeOut, &xTicksToWait ) == pdFALSE )
1590         {
1591             /* A block time is specified and not expired.  If the semaphore
1592              * count is 0 then enter the Blocked state to wait for a semaphore to
1593              * become available.  As semaphores are implemented with queues the
1594              * queue being empty is equivalent to the semaphore count being 0. */
1595             if( prvIsQueueEmpty( pxQueue ) != pdFALSE )
1596             {
1597                 traceBLOCKING_ON_QUEUE_RECEIVE( pxQueue );
1598
1599                 #if ( configUSE_MUTEXES == 1 )
1600                     {
1601                         if( pxQueue->uxQueueType == queueQUEUE_IS_MUTEX )
1602                         {
1603                             taskENTER_CRITICAL();
1604                             {
1605                                 xInheritanceOccurred = xTaskPriorityInherit( pxQueue->u.xSemaphore.xMutexHolder );
1606                             }
1607                             taskEXIT_CRITICAL();
1608                         }
1609                         else
1610                         {
1611                             mtCOVERAGE_TEST_MARKER();
1612                         }
1613                     }
1614                 #endif /* if ( configUSE_MUTEXES == 1 ) */
1615
1616                 vTaskPlaceOnEventList( &( pxQueue->xTasksWaitingToReceive ), xTicksToWait );
1617                 prvUnlockQueue( pxQueue );
1618
1619                 if( xTaskResumeAll() == pdFALSE )
1620                 {
1621                     vTaskYieldWithinAPI();
1622                 }
1623                 else
1624                 {
1625                     mtCOVERAGE_TEST_MARKER();
1626                 }
1627             }
1628             else
1629             {
1630                 /* There was no timeout and the semaphore count was not 0, so
1631                  * attempt to take the semaphore again. */
1632                 prvUnlockQueue( pxQueue );
1633                 ( void ) xTaskResumeAll();
1634             }
1635         }
1636         else
1637         {
1638             /* Timed out. */
1639             prvUnlockQueue( pxQueue );
1640             ( void ) xTaskResumeAll();
1641
1642             /* If the semaphore count is 0 exit now as the timeout has
1643              * expired.  Otherwise return to attempt to take the semaphore that is
1644              * known to be available.  As semaphores are implemented by queues the
1645              * queue being empty is equivalent to the semaphore count being 0. */
1646             if( prvIsQueueEmpty( pxQueue ) != pdFALSE )
1647             {
1648                 #if ( configUSE_MUTEXES == 1 )
1649                     {
1650                         /* xInheritanceOccurred could only have be set if
1651                          * pxQueue->uxQueueType == queueQUEUE_IS_MUTEX so no need to
1652                          * test the mutex type again to check it is actually a mutex. */
1653                         if( xInheritanceOccurred != pdFALSE )
1654                         {
1655                             taskENTER_CRITICAL();
1656                             {
1657                                 UBaseType_t uxHighestWaitingPriority;
1658
1659                                 /* This task blocking on the mutex caused another
1660                                  * task to inherit this task's priority.  Now this task
1661                                  * has timed out the priority should be disinherited
1662                                  * again, but only as low as the next highest priority
1663                                  * task that is waiting for the same mutex. */
1664                                 uxHighestWaitingPriority = prvGetDisinheritPriorityAfterTimeout( pxQueue );
1665                                 vTaskPriorityDisinheritAfterTimeout( pxQueue->u.xSemaphore.xMutexHolder, uxHighestWaitingPriority );
1666                             }
1667                             taskEXIT_CRITICAL();
1668                         }
1669                     }
1670                 #endif /* configUSE_MUTEXES */
1671
1672                 traceQUEUE_RECEIVE_FAILED( pxQueue );
1673                 return errQUEUE_EMPTY;
1674             }
1675             else
1676             {
1677                 mtCOVERAGE_TEST_MARKER();
1678             }
1679         }
1680     } /*lint -restore */
1681 }
1682 /*-----------------------------------------------------------*/
1683
1684 BaseType_t xQueuePeek( QueueHandle_t xQueue,
1685                        void * const pvBuffer,
1686                        TickType_t xTicksToWait )
1687 {
1688     BaseType_t xEntryTimeSet = pdFALSE;
1689     TimeOut_t xTimeOut;
1690     int8_t * pcOriginalReadPosition;
1691     Queue_t * const pxQueue = xQueue;
1692
1693     /* Check the pointer is not NULL. */
1694     configASSERT( ( pxQueue ) );
1695
1696     /* The buffer into which data is received can only be NULL if the data size
1697      * is zero (so no data is copied into the buffer. */
1698     configASSERT( !( ( ( pvBuffer ) == NULL ) && ( ( pxQueue )->uxItemSize != ( UBaseType_t ) 0U ) ) );
1699
1700     /* Cannot block if the scheduler is suspended. */
1701     #if ( ( INCLUDE_xTaskGetSchedulerState == 1 ) || ( configUSE_TIMERS == 1 ) )
1702         {
1703             configASSERT( !( ( xTaskGetSchedulerState() == taskSCHEDULER_SUSPENDED ) && ( xTicksToWait != 0 ) ) );
1704         }
1705     #endif
1706
1707     /*lint -save -e904  This function relaxes the coding standard somewhat to
1708      * allow return statements within the function itself.  This is done in the
1709      * interest of execution time efficiency. */
1710     for( ; ; )
1711     {
1712         taskENTER_CRITICAL();
1713         {
1714             const UBaseType_t uxMessagesWaiting = pxQueue->uxMessagesWaiting;
1715
1716             /* Is there data in the queue now?  To be running the calling task
1717              * must be the highest priority task wanting to access the queue. */
1718             if( uxMessagesWaiting > ( UBaseType_t ) 0 )
1719             {
1720                 /* Remember the read position so it can be reset after the data
1721                  * is read from the queue as this function is only peeking the
1722                  * data, not removing it. */
1723                 pcOriginalReadPosition = pxQueue->u.xQueue.pcReadFrom;
1724
1725                 prvCopyDataFromQueue( pxQueue, pvBuffer );
1726                 traceQUEUE_PEEK( pxQueue );
1727
1728                 /* The data is not being removed, so reset the read pointer. */
1729                 pxQueue->u.xQueue.pcReadFrom = pcOriginalReadPosition;
1730
1731                 /* The data is being left in the queue, so see if there are
1732                  * any other tasks waiting for the data. */
1733                 if( listLIST_IS_EMPTY( &( pxQueue->xTasksWaitingToReceive ) ) == pdFALSE )
1734                 {
1735                     if( xTaskRemoveFromEventList( &( pxQueue->xTasksWaitingToReceive ) ) != pdFALSE )
1736                     {
1737                         /* The task waiting has a higher priority than this task. */
1738                         queueYIELD_IF_USING_PREEMPTION();
1739                     }
1740                     else
1741                     {
1742                         mtCOVERAGE_TEST_MARKER();
1743                     }
1744                 }
1745                 else
1746                 {
1747                     mtCOVERAGE_TEST_MARKER();
1748                 }
1749
1750                 taskEXIT_CRITICAL();
1751                 return pdPASS;
1752             }
1753             else
1754             {
1755                 if( xTicksToWait == ( TickType_t ) 0 )
1756                 {
1757                     /* The queue was empty and no block time is specified (or
1758                      * the block time has expired) so leave now. */
1759                     taskEXIT_CRITICAL();
1760                     traceQUEUE_PEEK_FAILED( pxQueue );
1761                     return errQUEUE_EMPTY;
1762                 }
1763                 else if( xEntryTimeSet == pdFALSE )
1764                 {
1765                     /* The queue was empty and a block time was specified so
1766                      * configure the timeout structure ready to enter the blocked
1767                      * state. */
1768                     vTaskInternalSetTimeOutState( &xTimeOut );
1769                     xEntryTimeSet = pdTRUE;
1770                 }
1771                 else
1772                 {
1773                     /* Entry time was already set. */
1774                     mtCOVERAGE_TEST_MARKER();
1775                 }
1776             }
1777         }
1778         taskEXIT_CRITICAL();
1779
1780         /* Interrupts and other tasks can send to and receive from the queue
1781          * now that the critical section has been exited. */
1782
1783         vTaskSuspendAll();
1784         prvLockQueue( pxQueue );
1785
1786         /* Update the timeout state to see if it has expired yet. */
1787         if( xTaskCheckForTimeOut( &xTimeOut, &xTicksToWait ) == pdFALSE )
1788         {
1789             /* Timeout has not expired yet, check to see if there is data in the
1790             * queue now, and if not enter the Blocked state to wait for data. */
1791             if( prvIsQueueEmpty( pxQueue ) != pdFALSE )
1792             {
1793                 traceBLOCKING_ON_QUEUE_PEEK( pxQueue );
1794                 vTaskPlaceOnEventList( &( pxQueue->xTasksWaitingToReceive ), xTicksToWait );
1795                 prvUnlockQueue( pxQueue );
1796
1797                 if( xTaskResumeAll() == pdFALSE )
1798                 {
1799                     vTaskYieldWithinAPI();
1800                 }
1801                 else
1802                 {
1803                     mtCOVERAGE_TEST_MARKER();
1804                 }
1805             }
1806             else
1807             {
1808                 /* There is data in the queue now, so don't enter the blocked
1809                  * state, instead return to try and obtain the data. */
1810                 prvUnlockQueue( pxQueue );
1811                 ( void ) xTaskResumeAll();
1812             }
1813         }
1814         else
1815         {
1816             /* The timeout has expired.  If there is still no data in the queue
1817              * exit, otherwise go back and try to read the data again. */
1818             prvUnlockQueue( pxQueue );
1819             ( void ) xTaskResumeAll();
1820
1821             if( prvIsQueueEmpty( pxQueue ) != pdFALSE )
1822             {
1823                 traceQUEUE_PEEK_FAILED( pxQueue );
1824                 return errQUEUE_EMPTY;
1825             }
1826             else
1827             {
1828                 mtCOVERAGE_TEST_MARKER();
1829             }
1830         }
1831     } /*lint -restore */
1832 }
1833 /*-----------------------------------------------------------*/
1834
1835 BaseType_t xQueueReceiveFromISR( QueueHandle_t xQueue,
1836                                  void * const pvBuffer,
1837                                  BaseType_t * const pxHigherPriorityTaskWoken )
1838 {
1839     BaseType_t xReturn;
1840     UBaseType_t uxSavedInterruptStatus;
1841     Queue_t * const pxQueue = xQueue;
1842
1843     configASSERT( pxQueue );
1844     configASSERT( !( ( pvBuffer == NULL ) && ( pxQueue->uxItemSize != ( UBaseType_t ) 0U ) ) );
1845
1846     /* RTOS ports that support interrupt nesting have the concept of a maximum
1847      * system call (or maximum API call) interrupt priority.  Interrupts that are
1848      * above the maximum system call priority are kept permanently enabled, even
1849      * when the RTOS kernel is in a critical section, but cannot make any calls to
1850      * FreeRTOS API functions.  If configASSERT() is defined in FreeRTOSConfig.h
1851      * then portASSERT_IF_INTERRUPT_PRIORITY_INVALID() will result in an assertion
1852      * failure if a FreeRTOS API function is called from an interrupt that has been
1853      * assigned a priority above the configured maximum system call priority.
1854      * Only FreeRTOS functions that end in FromISR can be called from interrupts
1855      * that have been assigned a priority at or (logically) below the maximum
1856      * system call interrupt priority.  FreeRTOS maintains a separate interrupt
1857      * safe API to ensure interrupt entry is as fast and as simple as possible.
1858      * More information (albeit Cortex-M specific) is provided on the following
1859      * link: https://www.FreeRTOS.org/RTOS-Cortex-M3-M4.html */
1860     portASSERT_IF_INTERRUPT_PRIORITY_INVALID();
1861
1862     uxSavedInterruptStatus = portSET_INTERRUPT_MASK_FROM_ISR();
1863     {
1864         const UBaseType_t uxMessagesWaiting = pxQueue->uxMessagesWaiting;
1865
1866         /* Cannot block in an ISR, so check there is data available. */
1867         if( uxMessagesWaiting > ( UBaseType_t ) 0 )
1868         {
1869             const int8_t cRxLock = pxQueue->cRxLock;
1870
1871             traceQUEUE_RECEIVE_FROM_ISR( pxQueue );
1872
1873             prvCopyDataFromQueue( pxQueue, pvBuffer );
1874             pxQueue->uxMessagesWaiting = uxMessagesWaiting - ( UBaseType_t ) 1;
1875
1876             /* If the queue is locked the event list will not be modified.
1877              * Instead update the lock count so the task that unlocks the queue
1878              * will know that an ISR has removed data while the queue was
1879              * locked. */
1880             if( cRxLock == queueUNLOCKED )
1881             {
1882                 if( listLIST_IS_EMPTY( &( pxQueue->xTasksWaitingToSend ) ) == pdFALSE )
1883                 {
1884                     if( xTaskRemoveFromEventList( &( pxQueue->xTasksWaitingToSend ) ) != pdFALSE )
1885                     {
1886                         /* The task waiting has a higher priority than us so
1887                          * force a context switch. */
1888                         if( pxHigherPriorityTaskWoken != NULL )
1889                         {
1890                             *pxHigherPriorityTaskWoken = pdTRUE;
1891                         }
1892                         else
1893                         {
1894                             mtCOVERAGE_TEST_MARKER();
1895                         }
1896                     }
1897                     else
1898                     {
1899                         mtCOVERAGE_TEST_MARKER();
1900                     }
1901                 }
1902                 else
1903                 {
1904                     mtCOVERAGE_TEST_MARKER();
1905                 }
1906             }
1907             else
1908             {
1909                 /* Increment the lock count so the task that unlocks the queue
1910                  * knows that data was removed while it was locked. */
1911                 configASSERT( cRxLock != queueINT8_MAX );
1912
1913                 pxQueue->cRxLock = ( int8_t ) ( cRxLock + 1 );
1914             }
1915
1916             xReturn = pdPASS;
1917         }
1918         else
1919         {
1920             xReturn = pdFAIL;
1921             traceQUEUE_RECEIVE_FROM_ISR_FAILED( pxQueue );
1922         }
1923     }
1924     portCLEAR_INTERRUPT_MASK_FROM_ISR( uxSavedInterruptStatus );
1925
1926     return xReturn;
1927 }
1928 /*-----------------------------------------------------------*/
1929
1930 BaseType_t xQueuePeekFromISR( QueueHandle_t xQueue,
1931                               void * const pvBuffer )
1932 {
1933     BaseType_t xReturn;
1934     UBaseType_t uxSavedInterruptStatus;
1935     int8_t * pcOriginalReadPosition;
1936     Queue_t * const pxQueue = xQueue;
1937
1938     configASSERT( pxQueue );
1939     configASSERT( !( ( pvBuffer == NULL ) && ( pxQueue->uxItemSize != ( UBaseType_t ) 0U ) ) );
1940     configASSERT( pxQueue->uxItemSize != 0 ); /* Can't peek a semaphore. */
1941
1942     /* RTOS ports that support interrupt nesting have the concept of a maximum
1943      * system call (or maximum API call) interrupt priority.  Interrupts that are
1944      * above the maximum system call priority are kept permanently enabled, even
1945      * when the RTOS kernel is in a critical section, but cannot make any calls to
1946      * FreeRTOS API functions.  If configASSERT() is defined in FreeRTOSConfig.h
1947      * then portASSERT_IF_INTERRUPT_PRIORITY_INVALID() will result in an assertion
1948      * failure if a FreeRTOS API function is called from an interrupt that has been
1949      * assigned a priority above the configured maximum system call priority.
1950      * Only FreeRTOS functions that end in FromISR can be called from interrupts
1951      * that have been assigned a priority at or (logically) below the maximum
1952      * system call interrupt priority.  FreeRTOS maintains a separate interrupt
1953      * safe API to ensure interrupt entry is as fast and as simple as possible.
1954      * More information (albeit Cortex-M specific) is provided on the following
1955      * link: https://www.FreeRTOS.org/RTOS-Cortex-M3-M4.html */
1956     portASSERT_IF_INTERRUPT_PRIORITY_INVALID();
1957
1958     uxSavedInterruptStatus = portSET_INTERRUPT_MASK_FROM_ISR();
1959     {
1960         /* Cannot block in an ISR, so check there is data available. */
1961         if( pxQueue->uxMessagesWaiting > ( UBaseType_t ) 0 )
1962         {
1963             traceQUEUE_PEEK_FROM_ISR( pxQueue );
1964
1965             /* Remember the read position so it can be reset as nothing is
1966              * actually being removed from the queue. */
1967             pcOriginalReadPosition = pxQueue->u.xQueue.pcReadFrom;
1968             prvCopyDataFromQueue( pxQueue, pvBuffer );
1969             pxQueue->u.xQueue.pcReadFrom = pcOriginalReadPosition;
1970
1971             xReturn = pdPASS;
1972         }
1973         else
1974         {
1975             xReturn = pdFAIL;
1976             traceQUEUE_PEEK_FROM_ISR_FAILED( pxQueue );
1977         }
1978     }
1979     portCLEAR_INTERRUPT_MASK_FROM_ISR( uxSavedInterruptStatus );
1980
1981     return xReturn;
1982 }
1983 /*-----------------------------------------------------------*/
1984
1985 UBaseType_t uxQueueMessagesWaiting( const QueueHandle_t xQueue )
1986 {
1987     UBaseType_t uxReturn;
1988
1989     configASSERT( xQueue );
1990
1991     taskENTER_CRITICAL();
1992     {
1993         uxReturn = ( ( Queue_t * ) xQueue )->uxMessagesWaiting;
1994     }
1995     taskEXIT_CRITICAL();
1996
1997     return uxReturn;
1998 } /*lint !e818 Pointer cannot be declared const as xQueue is a typedef not pointer. */
1999 /*-----------------------------------------------------------*/
2000
2001 UBaseType_t uxQueueSpacesAvailable( const QueueHandle_t xQueue )
2002 {
2003     UBaseType_t uxReturn;
2004     Queue_t * const pxQueue = xQueue;
2005
2006     configASSERT( pxQueue );
2007
2008     taskENTER_CRITICAL();
2009     {
2010         uxReturn = pxQueue->uxLength - pxQueue->uxMessagesWaiting;
2011     }
2012     taskEXIT_CRITICAL();
2013
2014     return uxReturn;
2015 } /*lint !e818 Pointer cannot be declared const as xQueue is a typedef not pointer. */
2016 /*-----------------------------------------------------------*/
2017
2018 UBaseType_t uxQueueMessagesWaitingFromISR( const QueueHandle_t xQueue )
2019 {
2020     UBaseType_t uxReturn;
2021     Queue_t * const pxQueue = xQueue;
2022
2023     configASSERT( pxQueue );
2024     uxReturn = pxQueue->uxMessagesWaiting;
2025
2026     return uxReturn;
2027 } /*lint !e818 Pointer cannot be declared const as xQueue is a typedef not pointer. */
2028 /*-----------------------------------------------------------*/
2029
2030 void vQueueDelete( QueueHandle_t xQueue )
2031 {
2032     Queue_t * const pxQueue = xQueue;
2033
2034     configASSERT( pxQueue );
2035     traceQUEUE_DELETE( pxQueue );
2036
2037     #if ( configQUEUE_REGISTRY_SIZE > 0 )
2038         {
2039             vQueueUnregisterQueue( pxQueue );
2040         }
2041     #endif
2042
2043     #if ( ( configSUPPORT_DYNAMIC_ALLOCATION == 1 ) && ( configSUPPORT_STATIC_ALLOCATION == 0 ) )
2044         {
2045             /* The queue can only have been allocated dynamically - free it
2046              * again. */
2047             vPortFree( pxQueue );
2048         }
2049     #elif ( ( configSUPPORT_DYNAMIC_ALLOCATION == 1 ) && ( configSUPPORT_STATIC_ALLOCATION == 1 ) )
2050         {
2051             /* The queue could have been allocated statically or dynamically, so
2052              * check before attempting to free the memory. */
2053             if( pxQueue->ucStaticallyAllocated == ( uint8_t ) pdFALSE )
2054             {
2055                 vPortFree( pxQueue );
2056             }
2057             else
2058             {
2059                 mtCOVERAGE_TEST_MARKER();
2060             }
2061         }
2062     #else /* if ( ( configSUPPORT_DYNAMIC_ALLOCATION == 1 ) && ( configSUPPORT_STATIC_ALLOCATION == 0 ) ) */
2063         {
2064             /* The queue must have been statically allocated, so is not going to be
2065              * deleted.  Avoid compiler warnings about the unused parameter. */
2066             ( void ) pxQueue;
2067         }
2068     #endif /* configSUPPORT_DYNAMIC_ALLOCATION */
2069 }
2070 /*-----------------------------------------------------------*/
2071
2072 #if ( configUSE_TRACE_FACILITY == 1 )
2073
2074     UBaseType_t uxQueueGetQueueNumber( QueueHandle_t xQueue )
2075     {
2076         return ( ( Queue_t * ) xQueue )->uxQueueNumber;
2077     }
2078
2079 #endif /* configUSE_TRACE_FACILITY */
2080 /*-----------------------------------------------------------*/
2081
2082 #if ( configUSE_TRACE_FACILITY == 1 )
2083
2084     void vQueueSetQueueNumber( QueueHandle_t xQueue,
2085                                UBaseType_t uxQueueNumber )
2086     {
2087         ( ( Queue_t * ) xQueue )->uxQueueNumber = uxQueueNumber;
2088     }
2089
2090 #endif /* configUSE_TRACE_FACILITY */
2091 /*-----------------------------------------------------------*/
2092
2093 #if ( configUSE_TRACE_FACILITY == 1 )
2094
2095     uint8_t ucQueueGetQueueType( QueueHandle_t xQueue )
2096     {
2097         return ( ( Queue_t * ) xQueue )->ucQueueType;
2098     }
2099
2100 #endif /* configUSE_TRACE_FACILITY */
2101 /*-----------------------------------------------------------*/
2102
2103 #if ( configUSE_MUTEXES == 1 )
2104
2105     static UBaseType_t prvGetDisinheritPriorityAfterTimeout( const Queue_t * const pxQueue )
2106     {
2107         UBaseType_t uxHighestPriorityOfWaitingTasks;
2108
2109         /* If a task waiting for a mutex causes the mutex holder to inherit a
2110          * priority, but the waiting task times out, then the holder should
2111          * disinherit the priority - but only down to the highest priority of any
2112          * other tasks that are waiting for the same mutex.  For this purpose,
2113          * return the priority of the highest priority task that is waiting for the
2114          * mutex. */
2115         if( listCURRENT_LIST_LENGTH( &( pxQueue->xTasksWaitingToReceive ) ) > 0U )
2116         {
2117             uxHighestPriorityOfWaitingTasks = ( UBaseType_t ) configMAX_PRIORITIES - ( UBaseType_t ) listGET_ITEM_VALUE_OF_HEAD_ENTRY( &( pxQueue->xTasksWaitingToReceive ) );
2118         }
2119         else
2120         {
2121             uxHighestPriorityOfWaitingTasks = tskIDLE_PRIORITY;
2122         }
2123
2124         return uxHighestPriorityOfWaitingTasks;
2125     }
2126
2127 #endif /* configUSE_MUTEXES */
2128 /*-----------------------------------------------------------*/
2129
2130 static BaseType_t prvCopyDataToQueue( Queue_t * const pxQueue,
2131                                       const void * pvItemToQueue,
2132                                       const BaseType_t xPosition )
2133 {
2134     BaseType_t xReturn = pdFALSE;
2135     UBaseType_t uxMessagesWaiting;
2136
2137     /* This function is called from a critical section. */
2138
2139     uxMessagesWaiting = pxQueue->uxMessagesWaiting;
2140
2141     if( pxQueue->uxItemSize == ( UBaseType_t ) 0 )
2142     {
2143         #if ( configUSE_MUTEXES == 1 )
2144             {
2145                 if( pxQueue->uxQueueType == queueQUEUE_IS_MUTEX )
2146                 {
2147                     /* The mutex is no longer being held. */
2148                     xReturn = xTaskPriorityDisinherit( pxQueue->u.xSemaphore.xMutexHolder );
2149                     pxQueue->u.xSemaphore.xMutexHolder = NULL;
2150                 }
2151                 else
2152                 {
2153                     mtCOVERAGE_TEST_MARKER();
2154                 }
2155             }
2156         #endif /* configUSE_MUTEXES */
2157     }
2158     else if( xPosition == queueSEND_TO_BACK )
2159     {
2160         ( void ) memcpy( ( void * ) pxQueue->pcWriteTo, pvItemToQueue, ( size_t ) pxQueue->uxItemSize ); /*lint !e961 !e418 !e9087 MISRA exception as the casts are only redundant for some ports, plus previous logic ensures a null pointer can only be passed to memcpy() if the copy size is 0.  Cast to void required by function signature and safe as no alignment requirement and copy length specified in bytes. */
2161         pxQueue->pcWriteTo += pxQueue->uxItemSize;                                                       /*lint !e9016 Pointer arithmetic on char types ok, especially in this use case where it is the clearest way of conveying intent. */
2162
2163         if( pxQueue->pcWriteTo >= pxQueue->u.xQueue.pcTail )                                             /*lint !e946 MISRA exception justified as comparison of pointers is the cleanest solution. */
2164         {
2165             pxQueue->pcWriteTo = pxQueue->pcHead;
2166         }
2167         else
2168         {
2169             mtCOVERAGE_TEST_MARKER();
2170         }
2171     }
2172     else
2173     {
2174         ( void ) memcpy( ( void * ) pxQueue->u.xQueue.pcReadFrom, pvItemToQueue, ( size_t ) pxQueue->uxItemSize ); /*lint !e961 !e9087 !e418 MISRA exception as the casts are only redundant for some ports.  Cast to void required by function signature and safe as no alignment requirement and copy length specified in bytes.  Assert checks null pointer only used when length is 0. */
2175         pxQueue->u.xQueue.pcReadFrom -= pxQueue->uxItemSize;
2176
2177         if( pxQueue->u.xQueue.pcReadFrom < pxQueue->pcHead ) /*lint !e946 MISRA exception justified as comparison of pointers is the cleanest solution. */
2178         {
2179             pxQueue->u.xQueue.pcReadFrom = ( pxQueue->u.xQueue.pcTail - pxQueue->uxItemSize );
2180         }
2181         else
2182         {
2183             mtCOVERAGE_TEST_MARKER();
2184         }
2185
2186         if( xPosition == queueOVERWRITE )
2187         {
2188             if( uxMessagesWaiting > ( UBaseType_t ) 0 )
2189             {
2190                 /* An item is not being added but overwritten, so subtract
2191                  * one from the recorded number of items in the queue so when
2192                  * one is added again below the number of recorded items remains
2193                  * correct. */
2194                 --uxMessagesWaiting;
2195             }
2196             else
2197             {
2198                 mtCOVERAGE_TEST_MARKER();
2199             }
2200         }
2201         else
2202         {
2203             mtCOVERAGE_TEST_MARKER();
2204         }
2205     }
2206
2207     pxQueue->uxMessagesWaiting = uxMessagesWaiting + ( UBaseType_t ) 1;
2208
2209     return xReturn;
2210 }
2211 /*-----------------------------------------------------------*/
2212
2213 static void prvCopyDataFromQueue( Queue_t * const pxQueue,
2214                                   void * const pvBuffer )
2215 {
2216     if( pxQueue->uxItemSize != ( UBaseType_t ) 0 )
2217     {
2218         pxQueue->u.xQueue.pcReadFrom += pxQueue->uxItemSize;           /*lint !e9016 Pointer arithmetic on char types ok, especially in this use case where it is the clearest way of conveying intent. */
2219
2220         if( pxQueue->u.xQueue.pcReadFrom >= pxQueue->u.xQueue.pcTail ) /*lint !e946 MISRA exception justified as use of the relational operator is the cleanest solutions. */
2221         {
2222             pxQueue->u.xQueue.pcReadFrom = pxQueue->pcHead;
2223         }
2224         else
2225         {
2226             mtCOVERAGE_TEST_MARKER();
2227         }
2228
2229         ( void ) memcpy( ( void * ) pvBuffer, ( void * ) pxQueue->u.xQueue.pcReadFrom, ( size_t ) pxQueue->uxItemSize ); /*lint !e961 !e418 !e9087 MISRA exception as the casts are only redundant for some ports.  Also previous logic ensures a null pointer can only be passed to memcpy() when the count is 0.  Cast to void required by function signature and safe as no alignment requirement and copy length specified in bytes. */
2230     }
2231 }
2232 /*-----------------------------------------------------------*/
2233
2234 static void prvUnlockQueue( Queue_t * const pxQueue )
2235 {
2236     /* THIS FUNCTION MUST BE CALLED WITH THE SCHEDULER SUSPENDED. */
2237
2238     /* The lock counts contains the number of extra data items placed or
2239      * removed from the queue while the queue was locked.  When a queue is
2240      * locked items can be added or removed, but the event lists cannot be
2241      * updated. */
2242     taskENTER_CRITICAL();
2243     {
2244         int8_t cTxLock = pxQueue->cTxLock;
2245
2246         /* See if data was added to the queue while it was locked. */
2247         while( cTxLock > queueLOCKED_UNMODIFIED )
2248         {
2249             /* Data was posted while the queue was locked.  Are any tasks
2250              * blocked waiting for data to become available? */
2251             #if ( configUSE_QUEUE_SETS == 1 )
2252                 {
2253                     if( pxQueue->pxQueueSetContainer != NULL )
2254                     {
2255                         if( prvNotifyQueueSetContainer( pxQueue ) != pdFALSE )
2256                         {
2257                             /* The queue is a member of a queue set, and posting to
2258                              * the queue set caused a higher priority task to unblock.
2259                              * A context switch is required. */
2260                             vTaskMissedYield();
2261                         }
2262                         else
2263                         {
2264                             mtCOVERAGE_TEST_MARKER();
2265                         }
2266                     }
2267                     else
2268                     {
2269                         /* Tasks that are removed from the event list will get
2270                          * added to the pending ready list as the scheduler is still
2271                          * suspended. */
2272                         if( listLIST_IS_EMPTY( &( pxQueue->xTasksWaitingToReceive ) ) == pdFALSE )
2273                         {
2274                             if( xTaskRemoveFromEventList( &( pxQueue->xTasksWaitingToReceive ) ) != pdFALSE )
2275                             {
2276                                 /* The task waiting has a higher priority so record that a
2277                                  * context switch is required. */
2278                                 vTaskMissedYield();
2279                             }
2280                             else
2281                             {
2282                                 mtCOVERAGE_TEST_MARKER();
2283                             }
2284                         }
2285                         else
2286                         {
2287                             break;
2288                         }
2289                     }
2290                 }
2291             #else /* configUSE_QUEUE_SETS */
2292                 {
2293                     /* Tasks that are removed from the event list will get added to
2294                      * the pending ready list as the scheduler is still suspended. */
2295                     if( listLIST_IS_EMPTY( &( pxQueue->xTasksWaitingToReceive ) ) == pdFALSE )
2296                     {
2297                         if( xTaskRemoveFromEventList( &( pxQueue->xTasksWaitingToReceive ) ) != pdFALSE )
2298                         {
2299                             /* The task waiting has a higher priority so record that
2300                              * a context switch is required. */
2301                             vTaskMissedYield();
2302                         }
2303                         else
2304                         {
2305                             mtCOVERAGE_TEST_MARKER();
2306                         }
2307                     }
2308                     else
2309                     {
2310                         break;
2311                     }
2312                 }
2313             #endif /* configUSE_QUEUE_SETS */
2314
2315             --cTxLock;
2316         }
2317
2318         pxQueue->cTxLock = queueUNLOCKED;
2319     }
2320     taskEXIT_CRITICAL();
2321
2322     /* Do the same for the Rx lock. */
2323     taskENTER_CRITICAL();
2324     {
2325         int8_t cRxLock = pxQueue->cRxLock;
2326
2327         while( cRxLock > queueLOCKED_UNMODIFIED )
2328         {
2329             if( listLIST_IS_EMPTY( &( pxQueue->xTasksWaitingToSend ) ) == pdFALSE )
2330             {
2331                 if( xTaskRemoveFromEventList( &( pxQueue->xTasksWaitingToSend ) ) != pdFALSE )
2332                 {
2333                     vTaskMissedYield();
2334                 }
2335                 else
2336                 {
2337                     mtCOVERAGE_TEST_MARKER();
2338                 }
2339
2340                 --cRxLock;
2341             }
2342             else
2343             {
2344                 break;
2345             }
2346         }
2347
2348         pxQueue->cRxLock = queueUNLOCKED;
2349     }
2350     taskEXIT_CRITICAL();
2351 }
2352 /*-----------------------------------------------------------*/
2353
2354 static BaseType_t prvIsQueueEmpty( const Queue_t * pxQueue )
2355 {
2356     BaseType_t xReturn;
2357
2358     taskENTER_CRITICAL();
2359     {
2360         if( pxQueue->uxMessagesWaiting == ( UBaseType_t ) 0 )
2361         {
2362             xReturn = pdTRUE;
2363         }
2364         else
2365         {
2366             xReturn = pdFALSE;
2367         }
2368     }
2369     taskEXIT_CRITICAL();
2370
2371     return xReturn;
2372 }
2373 /*-----------------------------------------------------------*/
2374
2375 BaseType_t xQueueIsQueueEmptyFromISR( const QueueHandle_t xQueue )
2376 {
2377     BaseType_t xReturn;
2378     Queue_t * const pxQueue = xQueue;
2379
2380     configASSERT( pxQueue );
2381
2382     if( pxQueue->uxMessagesWaiting == ( UBaseType_t ) 0 )
2383     {
2384         xReturn = pdTRUE;
2385     }
2386     else
2387     {
2388         xReturn = pdFALSE;
2389     }
2390
2391     return xReturn;
2392 } /*lint !e818 xQueue could not be pointer to const because it is a typedef. */
2393 /*-----------------------------------------------------------*/
2394
2395 static BaseType_t prvIsQueueFull( const Queue_t * pxQueue )
2396 {
2397     BaseType_t xReturn;
2398
2399     taskENTER_CRITICAL();
2400     {
2401         if( pxQueue->uxMessagesWaiting == pxQueue->uxLength )
2402         {
2403             xReturn = pdTRUE;
2404         }
2405         else
2406         {
2407             xReturn = pdFALSE;
2408         }
2409     }
2410     taskEXIT_CRITICAL();
2411
2412     return xReturn;
2413 }
2414 /*-----------------------------------------------------------*/
2415
2416 BaseType_t xQueueIsQueueFullFromISR( const QueueHandle_t xQueue )
2417 {
2418     BaseType_t xReturn;
2419     Queue_t * const pxQueue = xQueue;
2420
2421     configASSERT( pxQueue );
2422
2423     if( pxQueue->uxMessagesWaiting == pxQueue->uxLength )
2424     {
2425         xReturn = pdTRUE;
2426     }
2427     else
2428     {
2429         xReturn = pdFALSE;
2430     }
2431
2432     return xReturn;
2433 } /*lint !e818 xQueue could not be pointer to const because it is a typedef. */
2434 /*-----------------------------------------------------------*/
2435
2436 #if ( configUSE_CO_ROUTINES == 1 )
2437
2438     BaseType_t xQueueCRSend( QueueHandle_t xQueue,
2439                              const void * pvItemToQueue,
2440                              TickType_t xTicksToWait )
2441     {
2442         BaseType_t xReturn;
2443         Queue_t * const pxQueue = xQueue;
2444
2445         /* If the queue is already full we may have to block.  A critical section
2446          * is required to prevent an interrupt removing something from the queue
2447          * between the check to see if the queue is full and blocking on the queue. */
2448         portDISABLE_INTERRUPTS();
2449         {
2450             if( prvIsQueueFull( pxQueue ) != pdFALSE )
2451             {
2452                 /* The queue is full - do we want to block or just leave without
2453                  * posting? */
2454                 if( xTicksToWait > ( TickType_t ) 0 )
2455                 {
2456                     /* As this is called from a coroutine we cannot block directly, but
2457                      * return indicating that we need to block. */
2458                     vCoRoutineAddToDelayedList( xTicksToWait, &( pxQueue->xTasksWaitingToSend ) );
2459                     portENABLE_INTERRUPTS();
2460                     return errQUEUE_BLOCKED;
2461                 }
2462                 else
2463                 {
2464                     portENABLE_INTERRUPTS();
2465                     return errQUEUE_FULL;
2466                 }
2467             }
2468         }
2469         portENABLE_INTERRUPTS();
2470
2471         portDISABLE_INTERRUPTS();
2472         {
2473             if( pxQueue->uxMessagesWaiting < pxQueue->uxLength )
2474             {
2475                 /* There is room in the queue, copy the data into the queue. */
2476                 prvCopyDataToQueue( pxQueue, pvItemToQueue, queueSEND_TO_BACK );
2477                 xReturn = pdPASS;
2478
2479                 /* Were any co-routines waiting for data to become available? */
2480                 if( listLIST_IS_EMPTY( &( pxQueue->xTasksWaitingToReceive ) ) == pdFALSE )
2481                 {
2482                     /* In this instance the co-routine could be placed directly
2483                      * into the ready list as we are within a critical section.
2484                      * Instead the same pending ready list mechanism is used as if
2485                      * the event were caused from within an interrupt. */
2486                     if( xCoRoutineRemoveFromEventList( &( pxQueue->xTasksWaitingToReceive ) ) != pdFALSE )
2487                     {
2488                         /* The co-routine waiting has a higher priority so record
2489                          * that a yield might be appropriate. */
2490                         xReturn = errQUEUE_YIELD;
2491                     }
2492                     else
2493                     {
2494                         mtCOVERAGE_TEST_MARKER();
2495                     }
2496                 }
2497                 else
2498                 {
2499                     mtCOVERAGE_TEST_MARKER();
2500                 }
2501             }
2502             else
2503             {
2504                 xReturn = errQUEUE_FULL;
2505             }
2506         }
2507         portENABLE_INTERRUPTS();
2508
2509         return xReturn;
2510     }
2511
2512 #endif /* configUSE_CO_ROUTINES */
2513 /*-----------------------------------------------------------*/
2514
2515 #if ( configUSE_CO_ROUTINES == 1 )
2516
2517     BaseType_t xQueueCRReceive( QueueHandle_t xQueue,
2518                                 void * pvBuffer,
2519                                 TickType_t xTicksToWait )
2520     {
2521         BaseType_t xReturn;
2522         Queue_t * const pxQueue = xQueue;
2523
2524         /* If the queue is already empty we may have to block.  A critical section
2525          * is required to prevent an interrupt adding something to the queue
2526          * between the check to see if the queue is empty and blocking on the queue. */
2527         portDISABLE_INTERRUPTS();
2528         {
2529             if( pxQueue->uxMessagesWaiting == ( UBaseType_t ) 0 )
2530             {
2531                 /* There are no messages in the queue, do we want to block or just
2532                  * leave with nothing? */
2533                 if( xTicksToWait > ( TickType_t ) 0 )
2534                 {
2535                     /* As this is a co-routine we cannot block directly, but return
2536                      * indicating that we need to block. */
2537                     vCoRoutineAddToDelayedList( xTicksToWait, &( pxQueue->xTasksWaitingToReceive ) );
2538                     portENABLE_INTERRUPTS();
2539                     return errQUEUE_BLOCKED;
2540                 }
2541                 else
2542                 {
2543                     portENABLE_INTERRUPTS();
2544                     return errQUEUE_FULL;
2545                 }
2546             }
2547             else
2548             {
2549                 mtCOVERAGE_TEST_MARKER();
2550             }
2551         }
2552         portENABLE_INTERRUPTS();
2553
2554         portDISABLE_INTERRUPTS();
2555         {
2556             if( pxQueue->uxMessagesWaiting > ( UBaseType_t ) 0 )
2557             {
2558                 /* Data is available from the queue. */
2559                 pxQueue->u.xQueue.pcReadFrom += pxQueue->uxItemSize;
2560
2561                 if( pxQueue->u.xQueue.pcReadFrom >= pxQueue->u.xQueue.pcTail )
2562                 {
2563                     pxQueue->u.xQueue.pcReadFrom = pxQueue->pcHead;
2564                 }
2565                 else
2566                 {
2567                     mtCOVERAGE_TEST_MARKER();
2568                 }
2569
2570                 --( pxQueue->uxMessagesWaiting );
2571                 ( void ) memcpy( ( void * ) pvBuffer, ( void * ) pxQueue->u.xQueue.pcReadFrom, ( unsigned ) pxQueue->uxItemSize );
2572
2573                 xReturn = pdPASS;
2574
2575                 /* Were any co-routines waiting for space to become available? */
2576                 if( listLIST_IS_EMPTY( &( pxQueue->xTasksWaitingToSend ) ) == pdFALSE )
2577                 {
2578                     /* In this instance the co-routine could be placed directly
2579                      * into the ready list as we are within a critical section.
2580                      * Instead the same pending ready list mechanism is used as if
2581                      * the event were caused from within an interrupt. */
2582                     if( xCoRoutineRemoveFromEventList( &( pxQueue->xTasksWaitingToSend ) ) != pdFALSE )
2583                     {
2584                         xReturn = errQUEUE_YIELD;
2585                     }
2586                     else
2587                     {
2588                         mtCOVERAGE_TEST_MARKER();
2589                     }
2590                 }
2591                 else
2592                 {
2593                     mtCOVERAGE_TEST_MARKER();
2594                 }
2595             }
2596             else
2597             {
2598                 xReturn = pdFAIL;
2599             }
2600         }
2601         portENABLE_INTERRUPTS();
2602
2603         return xReturn;
2604     }
2605
2606 #endif /* configUSE_CO_ROUTINES */
2607 /*-----------------------------------------------------------*/
2608
2609 #if ( configUSE_CO_ROUTINES == 1 )
2610
2611     BaseType_t xQueueCRSendFromISR( QueueHandle_t xQueue,
2612                                     const void * pvItemToQueue,
2613                                     BaseType_t xCoRoutinePreviouslyWoken )
2614     {
2615         Queue_t * const pxQueue = xQueue;
2616
2617         /* Cannot block within an ISR so if there is no space on the queue then
2618          * exit without doing anything. */
2619         if( pxQueue->uxMessagesWaiting < pxQueue->uxLength )
2620         {
2621             prvCopyDataToQueue( pxQueue, pvItemToQueue, queueSEND_TO_BACK );
2622
2623             /* We only want to wake one co-routine per ISR, so check that a
2624              * co-routine has not already been woken. */
2625             if( xCoRoutinePreviouslyWoken == pdFALSE )
2626             {
2627                 if( listLIST_IS_EMPTY( &( pxQueue->xTasksWaitingToReceive ) ) == pdFALSE )
2628                 {
2629                     if( xCoRoutineRemoveFromEventList( &( pxQueue->xTasksWaitingToReceive ) ) != pdFALSE )
2630                     {
2631                         return pdTRUE;
2632                     }
2633                     else
2634                     {
2635                         mtCOVERAGE_TEST_MARKER();
2636                     }
2637                 }
2638                 else
2639                 {
2640                     mtCOVERAGE_TEST_MARKER();
2641                 }
2642             }
2643             else
2644             {
2645                 mtCOVERAGE_TEST_MARKER();
2646             }
2647         }
2648         else
2649         {
2650             mtCOVERAGE_TEST_MARKER();
2651         }
2652
2653         return xCoRoutinePreviouslyWoken;
2654     }
2655
2656 #endif /* configUSE_CO_ROUTINES */
2657 /*-----------------------------------------------------------*/
2658
2659 #if ( configUSE_CO_ROUTINES == 1 )
2660
2661     BaseType_t xQueueCRReceiveFromISR( QueueHandle_t xQueue,
2662                                        void * pvBuffer,
2663                                        BaseType_t * pxCoRoutineWoken )
2664     {
2665         BaseType_t xReturn;
2666         Queue_t * const pxQueue = xQueue;
2667
2668         /* We cannot block from an ISR, so check there is data available. If
2669          * not then just leave without doing anything. */
2670         if( pxQueue->uxMessagesWaiting > ( UBaseType_t ) 0 )
2671         {
2672             /* Copy the data from the queue. */
2673             pxQueue->u.xQueue.pcReadFrom += pxQueue->uxItemSize;
2674
2675             if( pxQueue->u.xQueue.pcReadFrom >= pxQueue->u.xQueue.pcTail )
2676             {
2677                 pxQueue->u.xQueue.pcReadFrom = pxQueue->pcHead;
2678             }
2679             else
2680             {
2681                 mtCOVERAGE_TEST_MARKER();
2682             }
2683
2684             --( pxQueue->uxMessagesWaiting );
2685             ( void ) memcpy( ( void * ) pvBuffer, ( void * ) pxQueue->u.xQueue.pcReadFrom, ( unsigned ) pxQueue->uxItemSize );
2686
2687             if( ( *pxCoRoutineWoken ) == pdFALSE )
2688             {
2689                 if( listLIST_IS_EMPTY( &( pxQueue->xTasksWaitingToSend ) ) == pdFALSE )
2690                 {
2691                     if( xCoRoutineRemoveFromEventList( &( pxQueue->xTasksWaitingToSend ) ) != pdFALSE )
2692                     {
2693                         *pxCoRoutineWoken = pdTRUE;
2694                     }
2695                     else
2696                     {
2697                         mtCOVERAGE_TEST_MARKER();
2698                     }
2699                 }
2700                 else
2701                 {
2702                     mtCOVERAGE_TEST_MARKER();
2703                 }
2704             }
2705             else
2706             {
2707                 mtCOVERAGE_TEST_MARKER();
2708             }
2709
2710             xReturn = pdPASS;
2711         }
2712         else
2713         {
2714             xReturn = pdFAIL;
2715         }
2716
2717         return xReturn;
2718     }
2719
2720 #endif /* configUSE_CO_ROUTINES */
2721 /*-----------------------------------------------------------*/
2722
2723 #if ( configQUEUE_REGISTRY_SIZE > 0 )
2724
2725     void vQueueAddToRegistry( QueueHandle_t xQueue,
2726                               const char * pcQueueName ) /*lint !e971 Unqualified char types are allowed for strings and single characters only. */
2727     {
2728         UBaseType_t ux;
2729
2730         configASSERT( xQueue );
2731         configASSERT( pcQueueName );
2732
2733         /* See if there is an empty space in the registry.  A NULL name denotes
2734          * a free slot. */
2735         for( ux = ( UBaseType_t ) 0U; ux < ( UBaseType_t ) configQUEUE_REGISTRY_SIZE; ux++ )
2736         {
2737             if( xQueueRegistry[ ux ].pcQueueName == NULL )
2738             {
2739                 /* Store the information on this queue. */
2740                 xQueueRegistry[ ux ].pcQueueName = pcQueueName;
2741                 xQueueRegistry[ ux ].xHandle = xQueue;
2742
2743                 traceQUEUE_REGISTRY_ADD( xQueue, pcQueueName );
2744                 break;
2745             }
2746             else
2747             {
2748                 mtCOVERAGE_TEST_MARKER();
2749             }
2750         }
2751     }
2752
2753 #endif /* configQUEUE_REGISTRY_SIZE */
2754 /*-----------------------------------------------------------*/
2755
2756 #if ( configQUEUE_REGISTRY_SIZE > 0 )
2757
2758     const char * pcQueueGetName( QueueHandle_t xQueue ) /*lint !e971 Unqualified char types are allowed for strings and single characters only. */
2759     {
2760         UBaseType_t ux;
2761         const char * pcReturn = NULL; /*lint !e971 Unqualified char types are allowed for strings and single characters only. */
2762
2763         configASSERT( xQueue );
2764
2765         /* Note there is nothing here to protect against another task adding or
2766          * removing entries from the registry while it is being searched. */
2767
2768         for( ux = ( UBaseType_t ) 0U; ux < ( UBaseType_t ) configQUEUE_REGISTRY_SIZE; ux++ )
2769         {
2770             if( xQueueRegistry[ ux ].xHandle == xQueue )
2771             {
2772                 pcReturn = xQueueRegistry[ ux ].pcQueueName;
2773                 break;
2774             }
2775             else
2776             {
2777                 mtCOVERAGE_TEST_MARKER();
2778             }
2779         }
2780
2781         return pcReturn;
2782     } /*lint !e818 xQueue cannot be a pointer to const because it is a typedef. */
2783
2784 #endif /* configQUEUE_REGISTRY_SIZE */
2785 /*-----------------------------------------------------------*/
2786
2787 #if ( configQUEUE_REGISTRY_SIZE > 0 )
2788
2789     void vQueueUnregisterQueue( QueueHandle_t xQueue )
2790     {
2791         UBaseType_t ux;
2792
2793         configASSERT( xQueue );
2794
2795         /* See if the handle of the queue being unregistered in actually in the
2796          * registry. */
2797         for( ux = ( UBaseType_t ) 0U; ux < ( UBaseType_t ) configQUEUE_REGISTRY_SIZE; ux++ )
2798         {
2799             if( xQueueRegistry[ ux ].xHandle == xQueue )
2800             {
2801                 /* Set the name to NULL to show that this slot if free again. */
2802                 xQueueRegistry[ ux ].pcQueueName = NULL;
2803
2804                 /* Set the handle to NULL to ensure the same queue handle cannot
2805                  * appear in the registry twice if it is added, removed, then
2806                  * added again. */
2807                 xQueueRegistry[ ux ].xHandle = ( QueueHandle_t ) 0;
2808                 break;
2809             }
2810             else
2811             {
2812                 mtCOVERAGE_TEST_MARKER();
2813             }
2814         }
2815     } /*lint !e818 xQueue could not be pointer to const because it is a typedef. */
2816
2817 #endif /* configQUEUE_REGISTRY_SIZE */
2818 /*-----------------------------------------------------------*/
2819
2820 #if ( configUSE_TIMERS == 1 )
2821
2822     void vQueueWaitForMessageRestricted( QueueHandle_t xQueue,
2823                                          TickType_t xTicksToWait,
2824                                          const BaseType_t xWaitIndefinitely )
2825     {
2826         Queue_t * const pxQueue = xQueue;
2827
2828         /* This function should not be called by application code hence the
2829          * 'Restricted' in its name.  It is not part of the public API.  It is
2830          * designed for use by kernel code, and has special calling requirements.
2831          * It can result in vListInsert() being called on a list that can only
2832          * possibly ever have one item in it, so the list will be fast, but even
2833          * so it should be called with the scheduler locked and not from a critical
2834          * section. */
2835
2836         /* Only do anything if there are no messages in the queue.  This function
2837          *  will not actually cause the task to block, just place it on a blocked
2838          *  list.  It will not block until the scheduler is unlocked - at which
2839          *  time a yield will be performed.  If an item is added to the queue while
2840          *  the queue is locked, and the calling task blocks on the queue, then the
2841          *  calling task will be immediately unblocked when the queue is unlocked. */
2842         prvLockQueue( pxQueue );
2843
2844         if( pxQueue->uxMessagesWaiting == ( UBaseType_t ) 0U )
2845         {
2846             /* There is nothing in the queue, block for the specified period. */
2847             vTaskPlaceOnEventListRestricted( &( pxQueue->xTasksWaitingToReceive ), xTicksToWait, xWaitIndefinitely );
2848         }
2849         else
2850         {
2851             mtCOVERAGE_TEST_MARKER();
2852         }
2853
2854         prvUnlockQueue( pxQueue );
2855     }
2856
2857 #endif /* configUSE_TIMERS */
2858 /*-----------------------------------------------------------*/
2859
2860 #if ( ( configUSE_QUEUE_SETS == 1 ) && ( configSUPPORT_DYNAMIC_ALLOCATION == 1 ) )
2861
2862     QueueSetHandle_t xQueueCreateSet( const UBaseType_t uxEventQueueLength )
2863     {
2864         QueueSetHandle_t pxQueue;
2865
2866         pxQueue = xQueueGenericCreate( uxEventQueueLength, ( UBaseType_t ) sizeof( Queue_t * ), queueQUEUE_TYPE_SET );
2867
2868         return pxQueue;
2869     }
2870
2871 #endif /* configUSE_QUEUE_SETS */
2872 /*-----------------------------------------------------------*/
2873
2874 #if ( configUSE_QUEUE_SETS == 1 )
2875
2876     BaseType_t xQueueAddToSet( QueueSetMemberHandle_t xQueueOrSemaphore,
2877                                QueueSetHandle_t xQueueSet )
2878     {
2879         BaseType_t xReturn;
2880
2881         taskENTER_CRITICAL();
2882         {
2883             if( ( ( Queue_t * ) xQueueOrSemaphore )->pxQueueSetContainer != NULL )
2884             {
2885                 /* Cannot add a queue/semaphore to more than one queue set. */
2886                 xReturn = pdFAIL;
2887             }
2888             else if( ( ( Queue_t * ) xQueueOrSemaphore )->uxMessagesWaiting != ( UBaseType_t ) 0 )
2889             {
2890                 /* Cannot add a queue/semaphore to a queue set if there are already
2891                  * items in the queue/semaphore. */
2892                 xReturn = pdFAIL;
2893             }
2894             else
2895             {
2896                 ( ( Queue_t * ) xQueueOrSemaphore )->pxQueueSetContainer = xQueueSet;
2897                 xReturn = pdPASS;
2898             }
2899         }
2900         taskEXIT_CRITICAL();
2901
2902         return xReturn;
2903     }
2904
2905 #endif /* configUSE_QUEUE_SETS */
2906 /*-----------------------------------------------------------*/
2907
2908 #if ( configUSE_QUEUE_SETS == 1 )
2909
2910     BaseType_t xQueueRemoveFromSet( QueueSetMemberHandle_t xQueueOrSemaphore,
2911                                     QueueSetHandle_t xQueueSet )
2912     {
2913         BaseType_t xReturn;
2914         Queue_t * const pxQueueOrSemaphore = ( Queue_t * ) xQueueOrSemaphore;
2915
2916         if( pxQueueOrSemaphore->pxQueueSetContainer != xQueueSet )
2917         {
2918             /* The queue was not a member of the set. */
2919             xReturn = pdFAIL;
2920         }
2921         else if( pxQueueOrSemaphore->uxMessagesWaiting != ( UBaseType_t ) 0 )
2922         {
2923             /* It is dangerous to remove a queue from a set when the queue is
2924              * not empty because the queue set will still hold pending events for
2925              * the queue. */
2926             xReturn = pdFAIL;
2927         }
2928         else
2929         {
2930             taskENTER_CRITICAL();
2931             {
2932                 /* The queue is no longer contained in the set. */
2933                 pxQueueOrSemaphore->pxQueueSetContainer = NULL;
2934             }
2935             taskEXIT_CRITICAL();
2936             xReturn = pdPASS;
2937         }
2938
2939         return xReturn;
2940     } /*lint !e818 xQueueSet could not be declared as pointing to const as it is a typedef. */
2941
2942 #endif /* configUSE_QUEUE_SETS */
2943 /*-----------------------------------------------------------*/
2944
2945 #if ( configUSE_QUEUE_SETS == 1 )
2946
2947     QueueSetMemberHandle_t xQueueSelectFromSet( QueueSetHandle_t xQueueSet,
2948                                                 TickType_t const xTicksToWait )
2949     {
2950         QueueSetMemberHandle_t xReturn = NULL;
2951
2952         ( void ) xQueueReceive( ( QueueHandle_t ) xQueueSet, &xReturn, xTicksToWait ); /*lint !e961 Casting from one typedef to another is not redundant. */
2953         return xReturn;
2954     }
2955
2956 #endif /* configUSE_QUEUE_SETS */
2957 /*-----------------------------------------------------------*/
2958
2959 #if ( configUSE_QUEUE_SETS == 1 )
2960
2961     QueueSetMemberHandle_t xQueueSelectFromSetFromISR( QueueSetHandle_t xQueueSet )
2962     {
2963         QueueSetMemberHandle_t xReturn = NULL;
2964
2965         ( void ) xQueueReceiveFromISR( ( QueueHandle_t ) xQueueSet, &xReturn, NULL ); /*lint !e961 Casting from one typedef to another is not redundant. */
2966         return xReturn;
2967     }
2968
2969 #endif /* configUSE_QUEUE_SETS */
2970 /*-----------------------------------------------------------*/
2971
2972 #if ( configUSE_QUEUE_SETS == 1 )
2973
2974     static BaseType_t prvNotifyQueueSetContainer( const Queue_t * const pxQueue )
2975     {
2976         Queue_t * pxQueueSetContainer = pxQueue->pxQueueSetContainer;
2977         BaseType_t xReturn = pdFALSE;
2978
2979         /* This function must be called form a critical section. */
2980
2981         /* The following line is not reachable in unit tests because every call
2982          * to prvNotifyQueueSetContainer is preceded by a check that
2983          * pxQueueSetContainer != NULL */
2984         configASSERT( pxQueueSetContainer ); /* LCOV_EXCL_BR_LINE */
2985         configASSERT( pxQueueSetContainer->uxMessagesWaiting < pxQueueSetContainer->uxLength );
2986
2987         if( pxQueueSetContainer->uxMessagesWaiting < pxQueueSetContainer->uxLength )
2988         {
2989             const int8_t cTxLock = pxQueueSetContainer->cTxLock;
2990
2991             traceQUEUE_SET_SEND( pxQueueSetContainer );
2992
2993             /* The data copied is the handle of the queue that contains data. */
2994             xReturn = prvCopyDataToQueue( pxQueueSetContainer, &pxQueue, queueSEND_TO_BACK );
2995
2996             if( cTxLock == queueUNLOCKED )
2997             {
2998                 if( listLIST_IS_EMPTY( &( pxQueueSetContainer->xTasksWaitingToReceive ) ) == pdFALSE )
2999                 {
3000                     if( xTaskRemoveFromEventList( &( pxQueueSetContainer->xTasksWaitingToReceive ) ) != pdFALSE )
3001                     {
3002                         /* The task waiting has a higher priority. */
3003                         xReturn = pdTRUE;
3004                     }
3005                     else
3006                     {
3007                         mtCOVERAGE_TEST_MARKER();
3008                     }
3009                 }
3010                 else
3011                 {
3012                     mtCOVERAGE_TEST_MARKER();
3013                 }
3014             }
3015             else
3016             {
3017                 configASSERT( cTxLock != queueINT8_MAX );
3018
3019                 pxQueueSetContainer->cTxLock = ( int8_t ) ( cTxLock + 1 );
3020             }
3021         }
3022         else
3023         {
3024             mtCOVERAGE_TEST_MARKER();
3025         }
3026
3027         return xReturn;
3028     }
3029
3030 #endif /* configUSE_QUEUE_SETS */