begriffs open source - freertos/blob - queue.c

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