begriffs open source - freertos/blob - queue.c

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