git.sur5r.net Git - freertos/blob - FreeRTOS/Source/queue.c

   1 /*\r
   2     FreeRTOS V8.0.1 - Copyright (C) 2014 Real Time Engineers Ltd.\r
   3     All rights reserved\r
   4 \r
   5     VISIT http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.\r
   6 \r
   7     ***************************************************************************\r
   8      *                                                                       *\r
   9      *    FreeRTOS provides completely free yet professionally developed,    *\r
  10      *    robust, strictly quality controlled, supported, and cross          *\r
  11      *    platform software that has become a de facto standard.             *\r
  12      *                                                                       *\r
  13      *    Help yourself get started quickly and support the FreeRTOS         *\r
  14      *    project by purchasing a FreeRTOS tutorial book, reference          *\r
  15      *    manual, or both from: http://www.FreeRTOS.org/Documentation        *\r
  16      *                                                                       *\r
  17      *    Thank you!                                                         *\r
  18      *                                                                       *\r
  19     ***************************************************************************\r
  20 \r
  21     This file is part of the FreeRTOS distribution.\r
  22 \r
  23     FreeRTOS is free software; you can redistribute it and/or modify it under\r
  24     the terms of the GNU General Public License (version 2) as published by the\r
  25     Free Software Foundation >>!AND MODIFIED BY!<< the FreeRTOS exception.\r
  26 \r
  27     >>!   NOTE: The modification to the GPL is included to allow you to     !<<\r
  28     >>!   distribute a combined work that includes FreeRTOS without being   !<<\r
  29     >>!   obliged to provide the source code for proprietary components     !<<\r
  30     >>!   outside of the FreeRTOS kernel.                                   !<<\r
  31 \r
  32     FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY\r
  33     WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS\r
  34     FOR A PARTICULAR PURPOSE.  Full license text is available from the following\r
  35     link: http://www.freertos.org/a00114.html\r
  36 \r
  37     1 tab == 4 spaces!\r
  38 \r
  39     ***************************************************************************\r
  40      *                                                                       *\r
  41      *    Having a problem?  Start by reading the FAQ "My application does   *\r
  42      *    not run, what could be wrong?"                                     *\r
  43      *                                                                       *\r
  44      *    http://www.FreeRTOS.org/FAQHelp.html                               *\r
  45      *                                                                       *\r
  46     ***************************************************************************\r
  47 \r
  48     http://www.FreeRTOS.org - Documentation, books, training, latest versions,\r
  49     license and Real Time Engineers Ltd. contact details.\r
  50 \r
  51     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
  52     including FreeRTOS+Trace - an indispensable productivity tool, a DOS\r
  53     compatible FAT file system, and our tiny thread aware UDP/IP stack.\r
  54 \r
  55     http://www.OpenRTOS.com - Real Time Engineers ltd license FreeRTOS to High\r
  56     Integrity Systems to sell under the OpenRTOS brand.  Low cost OpenRTOS\r
  57     licenses offer ticketed support, indemnification and middleware.\r
  58 \r
  59     http://www.SafeRTOS.com - High Integrity Systems also provide a safety\r
  60     engineered and independently SIL3 certified version for use in safety and\r
  61     mission critical applications that require provable dependability.\r
  62 \r
  63     1 tab == 4 spaces!\r
  64 */\r
  65 \r
  66 #include <stdlib.h>\r
  67 #include <string.h>\r
  68 \r
  69 /* Defining MPU_WRAPPERS_INCLUDED_FROM_API_FILE prevents task.h from redefining\r
  70 all the API functions to use the MPU wrappers.  That should only be done when\r
  71 task.h is included from an application file. */\r
  72 #define MPU_WRAPPERS_INCLUDED_FROM_API_FILE\r
  73 \r
  74 #include "FreeRTOS.h"\r
  75 #include "task.h"\r
  76 #include "queue.h"\r
  77 \r
  78 #if ( configUSE_CO_ROUTINES == 1 )\r
  79         #include "croutine.h"\r
  80 #endif\r
  81 \r
  82 /* Lint e961 and e750 are suppressed as a MISRA exception justified because the\r
  83 MPU ports require MPU_WRAPPERS_INCLUDED_FROM_API_FILE to be defined for the\r
  84 header files above, but not in this file, in order to generate the correct\r
  85 privileged Vs unprivileged linkage and placement. */\r
  86 #undef MPU_WRAPPERS_INCLUDED_FROM_API_FILE /*lint !e961 !e750. */\r
  87 \r
  88 \r
  89 /* Constants used with the xRxLock and xTxLock structure members. */\r
  90 #define queueUNLOCKED                                   ( ( BaseType_t ) -1 )\r
  91 #define queueLOCKED_UNMODIFIED                  ( ( BaseType_t ) 0 )\r
  92 \r
  93 /* When the Queue_t structure is used to represent a base queue its pcHead and\r
  94 pcTail members are used as pointers into the queue storage area.  When the\r
  95 Queue_t structure is used to represent a mutex pcHead and pcTail pointers are\r
  96 not necessary, and the pcHead pointer is set to NULL to indicate that the\r
  97 pcTail pointer actually points to the mutex holder (if any).  Map alternative\r
  98 names to the pcHead and pcTail structure members to ensure the readability of\r
  99 the code is maintained despite this dual use of two structure members.  An\r
 100 alternative implementation would be to use a union, but use of a union is\r
 101 against the coding standard (although an exception to the standard has been\r
 102 permitted where the dual use also significantly changes the type of the\r
 103 structure member). */\r
 104 #define pxMutexHolder                                   pcTail\r
 105 #define uxQueueType                                             pcHead\r
 106 #define queueQUEUE_IS_MUTEX                             NULL\r
 107 \r
 108 /* Semaphores do not actually store or copy data, so have an item size of\r
 109 zero. */\r
 110 #define queueSEMAPHORE_QUEUE_ITEM_LENGTH ( ( UBaseType_t ) 0 )\r
 111 #define queueMUTEX_GIVE_BLOCK_TIME               ( ( TickType_t ) 0U )\r
 112 \r
 113 #if( configUSE_PREEMPTION == 0 )\r
 114         /* If the cooperative scheduler is being used then a yield should not be\r
 115         performed just because a higher priority task has been woken. */\r
 116         #define queueYIELD_IF_USING_PREEMPTION()\r
 117 #else\r
 118         #define queueYIELD_IF_USING_PREEMPTION() portYIELD_WITHIN_API()\r
 119 #endif\r
 120 \r
 121 /*\r
 122  * Definition of the queue used by the scheduler.\r
 123  * Items are queued by copy, not reference.\r
 124  */\r
 125 typedef struct QueueDefinition\r
 126 {\r
 127         int8_t *pcHead;                                 /*< Points to the beginning of the queue storage area. */\r
 128         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
 129         int8_t *pcWriteTo;                              /*< Points to the free next place in the storage area. */\r
 130 \r
 131         union                                                   /* Use of a union is an exception to the coding standard to ensure two mutually exclusive structure members don't appear simultaneously (wasting RAM). */\r
 132         {\r
 133                 int8_t *pcReadFrom;                     /*< Points to the last place that a queued item was read from when the structure is used as a queue. */\r
 134                 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
 135         } u;\r
 136 \r
 137         List_t xTasksWaitingToSend;             /*< List of tasks that are blocked waiting to post onto this queue.  Stored in priority order. */\r
 138         List_t xTasksWaitingToReceive;  /*< List of tasks that are blocked waiting to read from this queue.  Stored in priority order. */\r
 139 \r
 140         volatile UBaseType_t uxMessagesWaiting;/*< The number of items currently in the queue. */\r
 141         UBaseType_t uxLength;                   /*< The length of the queue defined as the number of items it will hold, not the number of bytes. */\r
 142         UBaseType_t uxItemSize;                 /*< The size of each items that the queue will hold. */\r
 143 \r
 144         volatile BaseType_t xRxLock;    /*< 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
 145         volatile BaseType_t xTxLock;    /*< 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
 146 \r
 147         #if ( configUSE_TRACE_FACILITY == 1 )\r
 148                 UBaseType_t uxQueueNumber;\r
 149                 uint8_t ucQueueType;\r
 150         #endif\r
 151 \r
 152         #if ( configUSE_QUEUE_SETS == 1 )\r
 153                 struct QueueDefinition *pxQueueSetContainer;\r
 154         #endif\r
 155 \r
 156 } xQUEUE;\r
 157 \r
 158 /* The old xQUEUE name is maintained above then typedefed to the new Queue_t\r
 159 name below to enable the use of older kernel aware debuggers. */\r
 160 typedef xQUEUE Queue_t;\r
 161 \r
 162 /*-----------------------------------------------------------*/\r
 163 \r
 164 /*\r
 165  * The queue registry is just a means for kernel aware debuggers to locate\r
 166  * queue structures.  It has no other purpose so is an optional component.\r
 167  */\r
 168 #if ( configQUEUE_REGISTRY_SIZE > 0 )\r
 169 \r
 170         /* The type stored within the queue registry array.  This allows a name\r
 171         to be assigned to each queue making kernel aware debugging a little\r
 172         more user friendly. */\r
 173         typedef struct QUEUE_REGISTRY_ITEM\r
 174         {\r
 175                 const char *pcQueueName; /*lint !e971 Unqualified char types are allowed for strings and single characters only. */\r
 176                 QueueHandle_t xHandle;\r
 177         } xQueueRegistryItem;\r
 178 \r
 179         /* The old xQueueRegistryItem name is maintained above then typedefed to the\r
 180         new xQueueRegistryItem name below to enable the use of older kernel aware\r
 181         debuggers. */\r
 182         typedef xQueueRegistryItem QueueRegistryItem_t;\r
 183 \r
 184         /* The queue registry is simply an array of QueueRegistryItem_t structures.\r
 185         The pcQueueName member of a structure being NULL is indicative of the\r
 186         array position being vacant. */\r
 187         QueueRegistryItem_t xQueueRegistry[ configQUEUE_REGISTRY_SIZE ];\r
 188 \r
 189 #endif /* configQUEUE_REGISTRY_SIZE */\r
 190 \r
 191 /*\r
 192  * Unlocks a queue locked by a call to prvLockQueue.  Locking a queue does not\r
 193  * prevent an ISR from adding or removing items to the queue, but does prevent\r
 194  * an ISR from removing tasks from the queue event lists.  If an ISR finds a\r
 195  * queue is locked it will instead increment the appropriate queue lock count\r
 196  * to indicate that a task may require unblocking.  When the queue in unlocked\r
 197  * these lock counts are inspected, and the appropriate action taken.\r
 198  */\r
 199 static void prvUnlockQueue( Queue_t * const pxQueue ) PRIVILEGED_FUNCTION;\r
 200 \r
 201 /*\r
 202  * Uses a critical section to determine if there is any data in a queue.\r
 203  *\r
 204  * @return pdTRUE if the queue contains no items, otherwise pdFALSE.\r
 205  */\r
 206 static BaseType_t prvIsQueueEmpty( const Queue_t *pxQueue ) PRIVILEGED_FUNCTION;\r
 207 \r
 208 /*\r
 209  * Uses a critical section to determine if there is any space in a queue.\r
 210  *\r
 211  * @return pdTRUE if there is no space, otherwise pdFALSE;\r
 212  */\r
 213 static BaseType_t prvIsQueueFull( const Queue_t *pxQueue ) PRIVILEGED_FUNCTION;\r
 214 \r
 215 /*\r
 216  * Copies an item into the queue, either at the front of the queue or the\r
 217  * back of the queue.\r
 218  */\r
 219 static BaseType_t prvCopyDataToQueue( Queue_t * const pxQueue, const void *pvItemToQueue, const BaseType_t xPosition ) PRIVILEGED_FUNCTION;\r
 220 \r
 221 /*\r
 222  * Copies an item out of a queue.\r
 223  */\r
 224 static void prvCopyDataFromQueue( Queue_t * const pxQueue, void * const pvBuffer ) PRIVILEGED_FUNCTION;\r
 225 \r
 226 #if ( configUSE_QUEUE_SETS == 1 )\r
 227         /*\r
 228          * Checks to see if a queue is a member of a queue set, and if so, notifies\r
 229          * the queue set that the queue contains data.\r
 230          */\r
 231         static BaseType_t prvNotifyQueueSetContainer( const Queue_t * const pxQueue, const BaseType_t xCopyPosition ) PRIVILEGED_FUNCTION;\r
 232 #endif\r
 233 \r
 234 /*-----------------------------------------------------------*/\r
 235 \r
 236 /*\r
 237  * Macro to mark a queue as locked.  Locking a queue prevents an ISR from\r
 238  * accessing the queue event lists.\r
 239  */\r
 240 #define prvLockQueue( pxQueue )                                                         \\r
 241         taskENTER_CRITICAL();                                                                   \\r
 242         {                                                                                                               \\r
 243                 if( ( pxQueue )->xRxLock == queueUNLOCKED )                     \\r
 244                 {                                                                                                       \\r
 245                         ( pxQueue )->xRxLock = queueLOCKED_UNMODIFIED;  \\r
 246                 }                                                                                                       \\r
 247                 if( ( pxQueue )->xTxLock == queueUNLOCKED )                     \\r
 248                 {                                                                                                       \\r
 249                         ( pxQueue )->xTxLock = queueLOCKED_UNMODIFIED;  \\r
 250                 }                                                                                                       \\r
 251         }                                                                                                               \\r
 252         taskEXIT_CRITICAL()\r
 253 /*-----------------------------------------------------------*/\r
 254 \r
 255 BaseType_t xQueueGenericReset( QueueHandle_t xQueue, BaseType_t xNewQueue )\r
 256 {\r
 257 Queue_t * const pxQueue = ( Queue_t * ) xQueue;\r
 258 \r
 259         configASSERT( pxQueue );\r
 260 \r
 261         taskENTER_CRITICAL();\r
 262         {\r
 263                 pxQueue->pcTail = pxQueue->pcHead + ( pxQueue->uxLength * pxQueue->uxItemSize );\r
 264                 pxQueue->uxMessagesWaiting = ( UBaseType_t ) 0U;\r
 265                 pxQueue->pcWriteTo = pxQueue->pcHead;\r
 266                 pxQueue->u.pcReadFrom = pxQueue->pcHead + ( ( pxQueue->uxLength - ( UBaseType_t ) 1U ) * pxQueue->uxItemSize );\r
 267                 pxQueue->xRxLock = queueUNLOCKED;\r
 268                 pxQueue->xTxLock = queueUNLOCKED;\r
 269 \r
 270                 if( xNewQueue == pdFALSE )\r
 271                 {\r
 272                         /* If there are tasks blocked waiting to read from the queue, then\r
 273                         the tasks will remain blocked as after this function exits the queue\r
 274                         will still be empty.  If there are tasks blocked waiting to write to\r
 275                         the queue, then one should be unblocked as after this function exits\r
 276                         it will be possible to write to it. */\r
 277                         if( listLIST_IS_EMPTY( &( pxQueue->xTasksWaitingToSend ) ) == pdFALSE )\r
 278                         {\r
 279                                 if( xTaskRemoveFromEventList( &( pxQueue->xTasksWaitingToSend ) ) == pdTRUE )\r
 280                                 {\r
 281                                         queueYIELD_IF_USING_PREEMPTION();\r
 282                                 }\r
 283                                 else\r
 284                                 {\r
 285                                         mtCOVERAGE_TEST_MARKER();\r
 286                                 }\r
 287                         }\r
 288                         else\r
 289                         {\r
 290                                 mtCOVERAGE_TEST_MARKER();\r
 291                         }\r
 292                 }\r
 293                 else\r
 294                 {\r
 295                         /* Ensure the event queues start in the correct state. */\r
 296                         vListInitialise( &( pxQueue->xTasksWaitingToSend ) );\r
 297                         vListInitialise( &( pxQueue->xTasksWaitingToReceive ) );\r
 298                 }\r
 299         }\r
 300         taskEXIT_CRITICAL();\r
 301 \r
 302         /* A value is returned for calling semantic consistency with previous\r
 303         versions. */\r
 304         return pdPASS;\r
 305 }\r
 306 /*-----------------------------------------------------------*/\r
 307 \r
 308 QueueHandle_t xQueueGenericCreate( const UBaseType_t uxQueueLength, const UBaseType_t uxItemSize, const uint8_t ucQueueType )\r
 309 {\r
 310 Queue_t *pxNewQueue;\r
 311 size_t xQueueSizeInBytes;\r
 312 QueueHandle_t xReturn = NULL;\r
 313 \r
 314         /* Remove compiler warnings about unused parameters should\r
 315         configUSE_TRACE_FACILITY not be set to 1. */\r
 316         ( void ) ucQueueType;\r
 317 \r
 318         /* Allocate the new queue structure. */\r
 319         if( uxQueueLength > ( UBaseType_t ) 0 )\r
 320         {\r
 321                 pxNewQueue = ( Queue_t * ) pvPortMalloc( sizeof( Queue_t ) );\r
 322                 if( pxNewQueue != NULL )\r
 323                 {\r
 324                         /* Create the list of pointers to queue items.  The queue is one byte\r
 325                         longer than asked for to make wrap checking easier/faster. */\r
 326                         xQueueSizeInBytes = ( size_t ) ( uxQueueLength * uxItemSize ) + ( size_t ) 1; /*lint !e961 MISRA exception as the casts are only redundant for some ports. */\r
 327 \r
 328                         pxNewQueue->pcHead = ( int8_t * ) pvPortMalloc( xQueueSizeInBytes );\r
 329                         if( pxNewQueue->pcHead != NULL )\r
 330                         {\r
 331                                 /* Initialise the queue members as described above where the\r
 332                                 queue type is defined. */\r
 333                                 pxNewQueue->uxLength = uxQueueLength;\r
 334                                 pxNewQueue->uxItemSize = uxItemSize;\r
 335                                 ( void ) xQueueGenericReset( pxNewQueue, pdTRUE );\r
 336 \r
 337                                 #if ( configUSE_TRACE_FACILITY == 1 )\r
 338                                 {\r
 339                                         pxNewQueue->ucQueueType = ucQueueType;\r
 340                                 }\r
 341                                 #endif /* configUSE_TRACE_FACILITY */\r
 342 \r
 343                                 #if( configUSE_QUEUE_SETS == 1 )\r
 344                                 {\r
 345                                         pxNewQueue->pxQueueSetContainer = NULL;\r
 346                                 }\r
 347                                 #endif /* configUSE_QUEUE_SETS */\r
 348 \r
 349                                 traceQUEUE_CREATE( pxNewQueue );\r
 350                                 xReturn = pxNewQueue;\r
 351                         }\r
 352                         else\r
 353                         {\r
 354                                 traceQUEUE_CREATE_FAILED( ucQueueType );\r
 355                                 vPortFree( pxNewQueue );\r
 356                         }\r
 357                 }\r
 358                 else\r
 359                 {\r
 360                         mtCOVERAGE_TEST_MARKER();\r
 361                 }\r
 362         }\r
 363         else\r
 364         {\r
 365                 mtCOVERAGE_TEST_MARKER();\r
 366         }\r
 367 \r
 368         configASSERT( xReturn );\r
 369 \r
 370         return xReturn;\r
 371 }\r
 372 /*-----------------------------------------------------------*/\r
 373 \r
 374 #if ( configUSE_MUTEXES == 1 )\r
 375 \r
 376         QueueHandle_t xQueueCreateMutex( const uint8_t ucQueueType )\r
 377         {\r
 378         Queue_t *pxNewQueue;\r
 379 \r
 380                 /* Prevent compiler warnings about unused parameters if\r
 381                 configUSE_TRACE_FACILITY does not equal 1. */\r
 382                 ( void ) ucQueueType;\r
 383 \r
 384                 /* Allocate the new queue structure. */\r
 385                 pxNewQueue = ( Queue_t * ) pvPortMalloc( sizeof( Queue_t ) );\r
 386                 if( pxNewQueue != NULL )\r
 387                 {\r
 388                         /* Information required for priority inheritance. */\r
 389                         pxNewQueue->pxMutexHolder = NULL;\r
 390                         pxNewQueue->uxQueueType = queueQUEUE_IS_MUTEX;\r
 391 \r
 392                         /* Queues used as a mutex no data is actually copied into or out\r
 393                         of the queue. */\r
 394                         pxNewQueue->pcWriteTo = NULL;\r
 395                         pxNewQueue->u.pcReadFrom = NULL;\r
 396 \r
 397                         /* Each mutex has a length of 1 (like a binary semaphore) and\r
 398                         an item size of 0 as nothing is actually copied into or out\r
 399                         of the mutex. */\r
 400                         pxNewQueue->uxMessagesWaiting = ( UBaseType_t ) 0U;\r
 401                         pxNewQueue->uxLength = ( UBaseType_t ) 1U;\r
 402                         pxNewQueue->uxItemSize = ( UBaseType_t ) 0U;\r
 403                         pxNewQueue->xRxLock = queueUNLOCKED;\r
 404                         pxNewQueue->xTxLock = queueUNLOCKED;\r
 405 \r
 406                         #if ( configUSE_TRACE_FACILITY == 1 )\r
 407                         {\r
 408                                 pxNewQueue->ucQueueType = ucQueueType;\r
 409                         }\r
 410                         #endif\r
 411 \r
 412                         #if ( configUSE_QUEUE_SETS == 1 )\r
 413                         {\r
 414                                 pxNewQueue->pxQueueSetContainer = NULL;\r
 415                         }\r
 416                         #endif\r
 417 \r
 418                         /* Ensure the event queues start with the correct state. */\r
 419                         vListInitialise( &( pxNewQueue->xTasksWaitingToSend ) );\r
 420                         vListInitialise( &( pxNewQueue->xTasksWaitingToReceive ) );\r
 421 \r
 422                         traceCREATE_MUTEX( pxNewQueue );\r
 423 \r
 424                         /* Start with the semaphore in the expected state.  Preload the\r
 425                          mutex held count as calling xQueueGenericSend() will decrement the\r
 426                          count back to 0. */\r
 427                         vTaskIncrementMutexHeldCount();\r
 428                         ( void ) xQueueGenericSend( pxNewQueue, NULL, ( TickType_t ) 0U, queueSEND_TO_BACK );\r
 429                 }\r
 430                 else\r
 431                 {\r
 432                         traceCREATE_MUTEX_FAILED();\r
 433                 }\r
 434 \r
 435                 configASSERT( pxNewQueue );\r
 436                 return pxNewQueue;\r
 437         }\r
 438 \r
 439 #endif /* configUSE_MUTEXES */\r
 440 /*-----------------------------------------------------------*/\r
 441 \r
 442 #if ( ( configUSE_MUTEXES == 1 ) && ( INCLUDE_xSemaphoreGetMutexHolder == 1 ) )\r
 443 \r
 444         void* xQueueGetMutexHolder( QueueHandle_t xSemaphore )\r
 445         {\r
 446         void *pxReturn;\r
 447 \r
 448                 /* This function is called by xSemaphoreGetMutexHolder(), and should not\r
 449                 be called directly.  Note:  This is a good way of determining if the\r
 450                 calling task is the mutex holder, but not a good way of determining the\r
 451                 identity of the mutex holder, as the holder may change between the\r
 452                 following critical section exiting and the function returning. */\r
 453                 taskENTER_CRITICAL();\r
 454                 {\r
 455                         if( ( ( Queue_t * ) xSemaphore )->uxQueueType == queueQUEUE_IS_MUTEX )\r
 456                         {\r
 457                                 pxReturn = ( void * ) ( ( Queue_t * ) xSemaphore )->pxMutexHolder;\r
 458                         }\r
 459                         else\r
 460                         {\r
 461                                 pxReturn = NULL;\r
 462                         }\r
 463                 }\r
 464                 taskEXIT_CRITICAL();\r
 465 \r
 466                 return pxReturn;\r
 467         }\r
 468 \r
 469 #endif\r
 470 /*-----------------------------------------------------------*/\r
 471 \r
 472 #if ( configUSE_RECURSIVE_MUTEXES == 1 )\r
 473 \r
 474         BaseType_t xQueueGiveMutexRecursive( QueueHandle_t xMutex )\r
 475         {\r
 476         BaseType_t xReturn;\r
 477         Queue_t * const pxMutex = ( Queue_t * ) xMutex;\r
 478 \r
 479                 configASSERT( pxMutex );\r
 480 \r
 481                 /* If this is the task that holds the mutex then pxMutexHolder will not\r
 482                 change outside of this task.  If this task does not hold the mutex then\r
 483                 pxMutexHolder can never coincidentally equal the tasks handle, and as\r
 484                 this is the only condition we are interested in it does not matter if\r
 485                 pxMutexHolder is accessed simultaneously by another task.  Therefore no\r
 486                 mutual exclusion is required to test the pxMutexHolder variable. */\r
 487                 if( pxMutex->pxMutexHolder == ( void * ) xTaskGetCurrentTaskHandle() ) /*lint !e961 Not a redundant cast as TaskHandle_t is a typedef. */\r
 488                 {\r
 489                         traceGIVE_MUTEX_RECURSIVE( pxMutex );\r
 490 \r
 491                         /* uxRecursiveCallCount cannot be zero if pxMutexHolder is equal to\r
 492                         the task handle, therefore no underflow check is required.  Also,\r
 493                         uxRecursiveCallCount is only modified by the mutex holder, and as\r
 494                         there can only be one, no mutual exclusion is required to modify the\r
 495                         uxRecursiveCallCount member. */\r
 496                         ( pxMutex->u.uxRecursiveCallCount )--;\r
 497 \r
 498                         /* Have we unwound the call count? */\r
 499                         if( pxMutex->u.uxRecursiveCallCount == ( UBaseType_t ) 0 )\r
 500                         {\r
 501                                 /* Return the mutex.  This will automatically unblock any other\r
 502                                 task that might be waiting to access the mutex. */\r
 503                                 ( void ) xQueueGenericSend( pxMutex, NULL, queueMUTEX_GIVE_BLOCK_TIME, queueSEND_TO_BACK );\r
 504                         }\r
 505                         else\r
 506                         {\r
 507                                 mtCOVERAGE_TEST_MARKER();\r
 508                         }\r
 509 \r
 510                         xReturn = pdPASS;\r
 511                 }\r
 512                 else\r
 513                 {\r
 514                         /* The mutex cannot be given because the calling task is not the \r
 515                         holder. */\r
 516                         xReturn = pdFAIL;\r
 517 \r
 518                         traceGIVE_MUTEX_RECURSIVE_FAILED( pxMutex );\r
 519                 }\r
 520 \r
 521                 return xReturn;\r
 522         }\r
 523 \r
 524 #endif /* configUSE_RECURSIVE_MUTEXES */\r
 525 /*-----------------------------------------------------------*/\r
 526 \r
 527 #if ( configUSE_RECURSIVE_MUTEXES == 1 )\r
 528 \r
 529         BaseType_t xQueueTakeMutexRecursive( QueueHandle_t xMutex, TickType_t xTicksToWait )\r
 530         {\r
 531         BaseType_t xReturn;\r
 532         Queue_t * const pxMutex = ( Queue_t * ) xMutex;\r
 533 \r
 534                 configASSERT( pxMutex );\r
 535 \r
 536                 /* Comments regarding mutual exclusion as per those within\r
 537                 xQueueGiveMutexRecursive(). */\r
 538 \r
 539                 traceTAKE_MUTEX_RECURSIVE( pxMutex );\r
 540 \r
 541                 if( pxMutex->pxMutexHolder == ( void * ) xTaskGetCurrentTaskHandle() ) /*lint !e961 Cast is not redundant as TaskHandle_t is a typedef. */\r
 542                 {\r
 543                         ( pxMutex->u.uxRecursiveCallCount )++;\r
 544                         xReturn = pdPASS;\r
 545                 }\r
 546                 else\r
 547                 {\r
 548                         xReturn = xQueueGenericReceive( pxMutex, NULL, xTicksToWait, pdFALSE );\r
 549 \r
 550                         /* pdPASS will only be returned if the mutex was successfully \r
 551                         obtained.  The calling task may have entered the Blocked state\r
 552                         before reaching here. */\r
 553                         if( xReturn == pdPASS )\r
 554                         {\r
 555                                 ( pxMutex->u.uxRecursiveCallCount )++;\r
 556                         }\r
 557                         else\r
 558                         {\r
 559                                 traceTAKE_MUTEX_RECURSIVE_FAILED( pxMutex );\r
 560                         }\r
 561                 }\r
 562 \r
 563                 return xReturn;\r
 564         }\r
 565 \r
 566 #endif /* configUSE_RECURSIVE_MUTEXES */\r
 567 /*-----------------------------------------------------------*/\r
 568 \r
 569 #if ( configUSE_COUNTING_SEMAPHORES == 1 )\r
 570 \r
 571         QueueHandle_t xQueueCreateCountingSemaphore( const UBaseType_t uxMaxCount, const UBaseType_t uxInitialCount )\r
 572         {\r
 573         QueueHandle_t xHandle;\r
 574 \r
 575                 configASSERT( uxMaxCount != 0 );\r
 576                 configASSERT( uxInitialCount <= uxMaxCount );\r
 577 \r
 578                 xHandle = xQueueGenericCreate( uxMaxCount, queueSEMAPHORE_QUEUE_ITEM_LENGTH, queueQUEUE_TYPE_COUNTING_SEMAPHORE );\r
 579 \r
 580                 if( xHandle != NULL )\r
 581                 {\r
 582                         ( ( Queue_t * ) xHandle )->uxMessagesWaiting = uxInitialCount;\r
 583 \r
 584                         traceCREATE_COUNTING_SEMAPHORE();\r
 585                 }\r
 586                 else\r
 587                 {\r
 588                         traceCREATE_COUNTING_SEMAPHORE_FAILED();\r
 589                 }\r
 590 \r
 591                 configASSERT( xHandle );\r
 592                 return xHandle;\r
 593         }\r
 594 \r
 595 #endif /* configUSE_COUNTING_SEMAPHORES */\r
 596 /*-----------------------------------------------------------*/\r
 597 \r
 598 BaseType_t xQueueGenericSend( QueueHandle_t xQueue, const void * const pvItemToQueue, TickType_t xTicksToWait, const BaseType_t xCopyPosition )\r
 599 {\r
 600 BaseType_t xEntryTimeSet = pdFALSE, xYieldRequired;\r
 601 TimeOut_t xTimeOut;\r
 602 Queue_t * const pxQueue = ( Queue_t * ) xQueue;\r
 603 \r
 604         configASSERT( pxQueue );\r
 605         configASSERT( !( ( pvItemToQueue == NULL ) && ( pxQueue->uxItemSize != ( UBaseType_t ) 0U ) ) );\r
 606         configASSERT( !( ( xCopyPosition == queueOVERWRITE ) && ( pxQueue->uxLength != 1 ) ) );\r
 607         #if ( ( INCLUDE_xTaskGetSchedulerState == 1 ) || ( configUSE_TIMERS == 1 ) )\r
 608         {\r
 609                 configASSERT( !( ( xTaskGetSchedulerState() == taskSCHEDULER_SUSPENDED ) && ( xTicksToWait != 0 ) ) );\r
 610         }\r
 611         #endif\r
 612 \r
 613 \r
 614         /* This function relaxes the coding standard somewhat to allow return\r
 615         statements within the function itself.  This is done in the interest\r
 616         of execution time efficiency. */\r
 617         for( ;; )\r
 618         {\r
 619                 taskENTER_CRITICAL();\r
 620                 {\r
 621                         /* Is there room on the queue now?  The running task must be\r
 622                         the highest priority task wanting to access the queue.  If\r
 623                         the head item in the queue is to be overwritten then it does\r
 624                         not matter if the queue is full. */\r
 625                         if( ( pxQueue->uxMessagesWaiting < pxQueue->uxLength ) || ( xCopyPosition == queueOVERWRITE ) )\r
 626                         {\r
 627                                 traceQUEUE_SEND( pxQueue );\r
 628                                 xYieldRequired = prvCopyDataToQueue( pxQueue, pvItemToQueue, xCopyPosition );\r
 629 \r
 630                                 #if ( configUSE_QUEUE_SETS == 1 )\r
 631                                 {\r
 632                                         if( pxQueue->pxQueueSetContainer != NULL )\r
 633                                         {\r
 634                                                 if( prvNotifyQueueSetContainer( pxQueue, xCopyPosition ) == pdTRUE )\r
 635                                                 {\r
 636                                                         /* The queue is a member of a queue set, and posting\r
 637                                                         to the queue set caused a higher priority task to\r
 638                                                         unblock. A context switch is required. */\r
 639                                                         queueYIELD_IF_USING_PREEMPTION();\r
 640                                                 }\r
 641                                                 else\r
 642                                                 {\r
 643                                                         mtCOVERAGE_TEST_MARKER();\r
 644                                                 }\r
 645                                         }\r
 646                                         else\r
 647                                         {\r
 648                                                 /* If there was a task waiting for data to arrive on the\r
 649                                                 queue then unblock it now. */\r
 650                                                 if( listLIST_IS_EMPTY( &( pxQueue->xTasksWaitingToReceive ) ) == pdFALSE )\r
 651                                                 {\r
 652                                                         if( xTaskRemoveFromEventList( &( pxQueue->xTasksWaitingToReceive ) ) == pdTRUE )\r
 653                                                         {\r
 654                                                                 /* The unblocked task has a priority higher than\r
 655                                                                 our own so yield immediately.  Yes it is ok to\r
 656                                                                 do this from within the critical section - the\r
 657                                                                 kernel takes care of that. */\r
 658                                                                 queueYIELD_IF_USING_PREEMPTION();\r
 659                                                         }\r
 660                                                         else\r
 661                                                         {\r
 662                                                                 mtCOVERAGE_TEST_MARKER();\r
 663                                                         }\r
 664                                                 }\r
 665                                                 else if( xYieldRequired != pdFALSE )\r
 666                                                 {\r
 667                                                         /* This path is a special case that will only get\r
 668                                                         executed if the task was holding multiple mutexes\r
 669                                                         and the mutexes were given back in an order that is\r
 670                                                         different to that in which they were taken. */\r
 671                                                         queueYIELD_IF_USING_PREEMPTION();\r
 672                                                 }\r
 673                                                 else\r
 674                                                 {\r
 675                                                         mtCOVERAGE_TEST_MARKER();\r
 676                                                 }\r
 677                                         }\r
 678                                 }\r
 679                                 #else /* configUSE_QUEUE_SETS */\r
 680                                 {\r
 681                                         /* If there was a task waiting for data to arrive on the\r
 682                                         queue then unblock it now. */\r
 683                                         if( listLIST_IS_EMPTY( &( pxQueue->xTasksWaitingToReceive ) ) == pdFALSE )\r
 684                                         {\r
 685                                                 if( xTaskRemoveFromEventList( &( pxQueue->xTasksWaitingToReceive ) ) == pdTRUE )\r
 686                                                 {\r
 687                                                         /* The unblocked task has a priority higher than\r
 688                                                         our own so yield immediately.  Yes it is ok to do\r
 689                                                         this from within the critical section - the kernel\r
 690                                                         takes care of that. */\r
 691                                                         queueYIELD_IF_USING_PREEMPTION();\r
 692                                                 }\r
 693                                                 else\r
 694                                                 {\r
 695                                                         mtCOVERAGE_TEST_MARKER();\r
 696                                                 }\r
 697                                         }\r
 698                                         else\r
 699                                         {\r
 700                                                 mtCOVERAGE_TEST_MARKER();\r
 701                                         }\r
 702                                 }\r
 703                                 #endif /* configUSE_QUEUE_SETS */\r
 704 \r
 705                                 taskEXIT_CRITICAL();\r
 706                                 return pdPASS;\r
 707                         }\r
 708                         else\r
 709                         {\r
 710                                 if( xTicksToWait == ( TickType_t ) 0 )\r
 711                                 {\r
 712                                         /* The queue was full and no block time is specified (or\r
 713                                         the block time has expired) so leave now. */\r
 714                                         taskEXIT_CRITICAL();\r
 715 \r
 716                                         /* Return to the original privilege level before exiting\r
 717                                         the function. */\r
 718                                         traceQUEUE_SEND_FAILED( pxQueue );\r
 719                                         return errQUEUE_FULL;\r
 720                                 }\r
 721                                 else if( xEntryTimeSet == pdFALSE )\r
 722                                 {\r
 723                                         /* The queue was full and a block time was specified so\r
 724                                         configure the timeout structure. */\r
 725                                         vTaskSetTimeOutState( &xTimeOut );\r
 726                                         xEntryTimeSet = pdTRUE;\r
 727                                 }\r
 728                                 else\r
 729                                 {\r
 730                                         /* Entry time was already set. */\r
 731                                         mtCOVERAGE_TEST_MARKER();\r
 732                                 }\r
 733                         }\r
 734                 }\r
 735                 taskEXIT_CRITICAL();\r
 736 \r
 737                 /* Interrupts and other tasks can send to and receive from the queue\r
 738                 now the critical section has been exited. */\r
 739 \r
 740                 vTaskSuspendAll();\r
 741                 prvLockQueue( pxQueue );\r
 742 \r
 743                 /* Update the timeout state to see if it has expired yet. */\r
 744                 if( xTaskCheckForTimeOut( &xTimeOut, &xTicksToWait ) == pdFALSE )\r
 745                 {\r
 746                         if( prvIsQueueFull( pxQueue ) != pdFALSE )\r
 747                         {\r
 748                                 traceBLOCKING_ON_QUEUE_SEND( pxQueue );\r
 749                                 vTaskPlaceOnEventList( &( pxQueue->xTasksWaitingToSend ), xTicksToWait );\r
 750 \r
 751                                 /* Unlocking the queue means queue events can effect the\r
 752                                 event list.  It is possible     that interrupts occurring now\r
 753                                 remove this task from the event list again - but as the\r
 754                                 scheduler is suspended the task will go onto the pending\r
 755                                 ready last instead of the actual ready list. */\r
 756                                 prvUnlockQueue( pxQueue );\r
 757 \r
 758                                 /* Resuming the scheduler will move tasks from the pending\r
 759                                 ready list into the ready list - so it is feasible that this\r
 760                                 task is already in a ready list before it yields - in which\r
 761                                 case the yield will not cause a context switch unless there\r
 762                                 is also a higher priority task in the pending ready list. */\r
 763                                 if( xTaskResumeAll() == pdFALSE )\r
 764                                 {\r
 765                                         portYIELD_WITHIN_API();\r
 766                                 }\r
 767                         }\r
 768                         else\r
 769                         {\r
 770                                 /* Try again. */\r
 771                                 prvUnlockQueue( pxQueue );\r
 772                                 ( void ) xTaskResumeAll();\r
 773                         }\r
 774                 }\r
 775                 else\r
 776                 {\r
 777                         /* The timeout has expired. */\r
 778                         prvUnlockQueue( pxQueue );\r
 779                         ( void ) xTaskResumeAll();\r
 780 \r
 781                         /* Return to the original privilege level before exiting the\r
 782                         function. */\r
 783                         traceQUEUE_SEND_FAILED( pxQueue );\r
 784                         return errQUEUE_FULL;\r
 785                 }\r
 786         }\r
 787 }\r
 788 /*-----------------------------------------------------------*/\r
 789 \r
 790 #if ( configUSE_ALTERNATIVE_API == 1 )\r
 791 \r
 792         BaseType_t xQueueAltGenericSend( QueueHandle_t xQueue, const void * const pvItemToQueue, TickType_t xTicksToWait, BaseType_t xCopyPosition )\r
 793         {\r
 794         BaseType_t xEntryTimeSet = pdFALSE;\r
 795         TimeOut_t xTimeOut;\r
 796         Queue_t * const pxQueue = ( Queue_t * ) xQueue;\r
 797 \r
 798                 configASSERT( pxQueue );\r
 799                 configASSERT( !( ( pvItemToQueue == NULL ) && ( pxQueue->uxItemSize != ( UBaseType_t ) 0U ) ) );\r
 800 \r
 801                 for( ;; )\r
 802                 {\r
 803                         taskENTER_CRITICAL();\r
 804                         {\r
 805                                 /* Is there room on the queue now?  To be running we must be\r
 806                                 the highest priority task wanting to access the queue. */\r
 807                                 if( pxQueue->uxMessagesWaiting < pxQueue->uxLength )\r
 808                                 {\r
 809                                         traceQUEUE_SEND( pxQueue );\r
 810                                         prvCopyDataToQueue( pxQueue, pvItemToQueue, xCopyPosition );\r
 811 \r
 812                                         /* If there was a task waiting for data to arrive on the\r
 813                                         queue then unblock it now. */\r
 814                                         if( listLIST_IS_EMPTY( &( pxQueue->xTasksWaitingToReceive ) ) == pdFALSE )\r
 815                                         {\r
 816                                                 if( xTaskRemoveFromEventList( &( pxQueue->xTasksWaitingToReceive ) ) == pdTRUE )\r
 817                                                 {\r
 818                                                         /* The unblocked task has a priority higher than\r
 819                                                         our own so yield immediately. */\r
 820                                                         portYIELD_WITHIN_API();\r
 821                                                 }\r
 822                                                 else\r
 823                                                 {\r
 824                                                         mtCOVERAGE_TEST_MARKER();\r
 825                                                 }\r
 826                                         }\r
 827                                         else\r
 828                                         {\r
 829                                                 mtCOVERAGE_TEST_MARKER();\r
 830                                         }\r
 831 \r
 832                                         taskEXIT_CRITICAL();\r
 833                                         return pdPASS;\r
 834                                 }\r
 835                                 else\r
 836                                 {\r
 837                                         if( xTicksToWait == ( TickType_t ) 0 )\r
 838                                         {\r
 839                                                 taskEXIT_CRITICAL();\r
 840                                                 return errQUEUE_FULL;\r
 841                                         }\r
 842                                         else if( xEntryTimeSet == pdFALSE )\r
 843                                         {\r
 844                                                 vTaskSetTimeOutState( &xTimeOut );\r
 845                                                 xEntryTimeSet = pdTRUE;\r
 846                                         }\r
 847                                 }\r
 848                         }\r
 849                         taskEXIT_CRITICAL();\r
 850 \r
 851                         taskENTER_CRITICAL();\r
 852                         {\r
 853                                 if( xTaskCheckForTimeOut( &xTimeOut, &xTicksToWait ) == pdFALSE )\r
 854                                 {\r
 855                                         if( prvIsQueueFull( pxQueue ) != pdFALSE )\r
 856                                         {\r
 857                                                 traceBLOCKING_ON_QUEUE_SEND( pxQueue );\r
 858                                                 vTaskPlaceOnEventList( &( pxQueue->xTasksWaitingToSend ), xTicksToWait );\r
 859                                                 portYIELD_WITHIN_API();\r
 860                                         }\r
 861                                         else\r
 862                                         {\r
 863                                                 mtCOVERAGE_TEST_MARKER();\r
 864                                         }\r
 865                                 }\r
 866                                 else\r
 867                                 {\r
 868                                         taskEXIT_CRITICAL();\r
 869                                         traceQUEUE_SEND_FAILED( pxQueue );\r
 870                                         return errQUEUE_FULL;\r
 871                                 }\r
 872                         }\r
 873                         taskEXIT_CRITICAL();\r
 874                 }\r
 875         }\r
 876 \r
 877 #endif /* configUSE_ALTERNATIVE_API */\r
 878 /*-----------------------------------------------------------*/\r
 879 \r
 880 #if ( configUSE_ALTERNATIVE_API == 1 )\r
 881 \r
 882         BaseType_t xQueueAltGenericReceive( QueueHandle_t xQueue, void * const pvBuffer, TickType_t xTicksToWait, BaseType_t xJustPeeking )\r
 883         {\r
 884         BaseType_t xEntryTimeSet = pdFALSE;\r
 885         TimeOut_t xTimeOut;\r
 886         int8_t *pcOriginalReadPosition;\r
 887         Queue_t * const pxQueue = ( Queue_t * ) xQueue;\r
 888 \r
 889                 configASSERT( pxQueue );\r
 890                 configASSERT( !( ( pvBuffer == NULL ) && ( pxQueue->uxItemSize != ( UBaseType_t ) 0U ) ) );\r
 891 \r
 892                 for( ;; )\r
 893                 {\r
 894                         taskENTER_CRITICAL();\r
 895                         {\r
 896                                 if( pxQueue->uxMessagesWaiting > ( UBaseType_t ) 0 )\r
 897                                 {\r
 898                                         /* Remember our read position in case we are just peeking. */\r
 899                                         pcOriginalReadPosition = pxQueue->u.pcReadFrom;\r
 900 \r
 901                                         prvCopyDataFromQueue( pxQueue, pvBuffer );\r
 902 \r
 903                                         if( xJustPeeking == pdFALSE )\r
 904                                         {\r
 905                                                 traceQUEUE_RECEIVE( pxQueue );\r
 906 \r
 907                                                 /* Data is actually being removed (not just peeked). */\r
 908                                                 --( pxQueue->uxMessagesWaiting );\r
 909 \r
 910                                                 #if ( configUSE_MUTEXES == 1 )\r
 911                                                 {\r
 912                                                         if( pxQueue->uxQueueType == queueQUEUE_IS_MUTEX )\r
 913                                                         {\r
 914                                                                 /* Record the information required to implement\r
 915                                                                 priority inheritance should it become necessary. */\r
 916                                                                 pxQueue->pxMutexHolder = ( int8_t * ) xTaskGetCurrentTaskHandle();\r
 917                                                         }\r
 918                                                         else\r
 919                                                         {\r
 920                                                                 mtCOVERAGE_TEST_MARKER();\r
 921                                                         }\r
 922                                                 }\r
 923                                                 #endif\r
 924 \r
 925                                                 if( listLIST_IS_EMPTY( &( pxQueue->xTasksWaitingToSend ) ) == pdFALSE )\r
 926                                                 {\r
 927                                                         if( xTaskRemoveFromEventList( &( pxQueue->xTasksWaitingToSend ) ) == pdTRUE )\r
 928                                                         {\r
 929                                                                 portYIELD_WITHIN_API();\r
 930                                                         }\r
 931                                                         else\r
 932                                                         {\r
 933                                                                 mtCOVERAGE_TEST_MARKER();\r
 934                                                         }\r
 935                                                 }\r
 936                                         }\r
 937                                         else\r
 938                                         {\r
 939                                                 traceQUEUE_PEEK( pxQueue );\r
 940 \r
 941                                                 /* We are not removing the data, so reset our read\r
 942                                                 pointer. */\r
 943                                                 pxQueue->u.pcReadFrom = pcOriginalReadPosition;\r
 944 \r
 945                                                 /* The data is being left in the queue, so see if there are\r
 946                                                 any other tasks waiting for the data. */\r
 947                                                 if( listLIST_IS_EMPTY( &( pxQueue->xTasksWaitingToReceive ) ) == pdFALSE )\r
 948                                                 {\r
 949                                                         /* Tasks that are removed from the event list will get added to\r
 950                                                         the pending ready list as the scheduler is still suspended. */\r
 951                                                         if( xTaskRemoveFromEventList( &( pxQueue->xTasksWaitingToReceive ) ) != pdFALSE )\r
 952                                                         {\r
 953                                                                 /* The task waiting has a higher priority than this task. */\r
 954                                                                 portYIELD_WITHIN_API();\r
 955                                                         }\r
 956                                                         else\r
 957                                                         {\r
 958                                                                 mtCOVERAGE_TEST_MARKER();\r
 959                                                         }\r
 960                                                 }\r
 961                                                 else\r
 962                                                 {\r
 963                                                         mtCOVERAGE_TEST_MARKER();\r
 964                                                 }\r
 965                                         }\r
 966 \r
 967                                         taskEXIT_CRITICAL();\r
 968                                         return pdPASS;\r
 969                                 }\r
 970                                 else\r
 971                                 {\r
 972                                         if( xTicksToWait == ( TickType_t ) 0 )\r
 973                                         {\r
 974                                                 taskEXIT_CRITICAL();\r
 975                                                 traceQUEUE_RECEIVE_FAILED( pxQueue );\r
 976                                                 return errQUEUE_EMPTY;\r
 977                                         }\r
 978                                         else if( xEntryTimeSet == pdFALSE )\r
 979                                         {\r
 980                                                 vTaskSetTimeOutState( &xTimeOut );\r
 981                                                 xEntryTimeSet = pdTRUE;\r
 982                                         }\r
 983                                 }\r
 984                         }\r
 985                         taskEXIT_CRITICAL();\r
 986 \r
 987                         taskENTER_CRITICAL();\r
 988                         {\r
 989                                 if( xTaskCheckForTimeOut( &xTimeOut, &xTicksToWait ) == pdFALSE )\r
 990                                 {\r
 991                                         if( prvIsQueueEmpty( pxQueue ) != pdFALSE )\r
 992                                         {\r
 993                                                 traceBLOCKING_ON_QUEUE_RECEIVE( pxQueue );\r
 994 \r
 995                                                 #if ( configUSE_MUTEXES == 1 )\r
 996                                                 {\r
 997                                                         if( pxQueue->uxQueueType == queueQUEUE_IS_MUTEX )\r
 998                                                         {\r
 999                                                                 taskENTER_CRITICAL();\r
1000                                                                 {\r
1001                                                                         vTaskPriorityInherit( ( void * ) pxQueue->pxMutexHolder );\r
1002                                                                 }\r
1003                                                                 taskEXIT_CRITICAL();\r
1004                                                         }\r
1005                                                         else\r
1006                                                         {\r
1007                                                                 mtCOVERAGE_TEST_MARKER();\r
1008                                                         }\r
1009                                                 }\r
1010                                                 #endif\r
1011 \r
1012                                                 vTaskPlaceOnEventList( &( pxQueue->xTasksWaitingToReceive ), xTicksToWait );\r
1013                                                 portYIELD_WITHIN_API();\r
1014                                         }\r
1015                                         else\r
1016                                         {\r
1017                                                 mtCOVERAGE_TEST_MARKER();\r
1018                                         }\r
1019                                 }\r
1020                                 else\r
1021                                 {\r
1022                                         taskEXIT_CRITICAL();\r
1023                                         traceQUEUE_RECEIVE_FAILED( pxQueue );\r
1024                                         return errQUEUE_EMPTY;\r
1025                                 }\r
1026                         }\r
1027                         taskEXIT_CRITICAL();\r
1028                 }\r
1029         }\r
1030 \r
1031 \r
1032 #endif /* configUSE_ALTERNATIVE_API */\r
1033 /*-----------------------------------------------------------*/\r
1034 \r
1035 BaseType_t xQueueGenericSendFromISR( QueueHandle_t xQueue, const void * const pvItemToQueue, BaseType_t * const pxHigherPriorityTaskWoken, const BaseType_t xCopyPosition )\r
1036 {\r
1037 BaseType_t xReturn;\r
1038 UBaseType_t uxSavedInterruptStatus;\r
1039 Queue_t * const pxQueue = ( Queue_t * ) xQueue;\r
1040 \r
1041         configASSERT( pxQueue );\r
1042         configASSERT( !( ( pvItemToQueue == NULL ) && ( pxQueue->uxItemSize != ( UBaseType_t ) 0U ) ) );\r
1043         configASSERT( !( ( xCopyPosition == queueOVERWRITE ) && ( pxQueue->uxLength != 1 ) ) );\r
1044 \r
1045         /* RTOS ports that support interrupt nesting have the concept of a maximum\r
1046         system call (or maximum API call) interrupt priority.  Interrupts that are\r
1047         above the maximum system call priority are kept permanently enabled, even\r
1048         when the RTOS kernel is in a critical section, but cannot make any calls to\r
1049         FreeRTOS API functions.  If configASSERT() is defined in FreeRTOSConfig.h\r
1050         then portASSERT_IF_INTERRUPT_PRIORITY_INVALID() will result in an assertion\r
1051         failure if a FreeRTOS API function is called from an interrupt that has been\r
1052         assigned a priority above the configured maximum system call priority.\r
1053         Only FreeRTOS functions that end in FromISR can be called from interrupts\r
1054         that have been assigned a priority at or (logically) below the maximum\r
1055         system call     interrupt priority.  FreeRTOS maintains a separate interrupt\r
1056         safe API to ensure interrupt entry is as fast and as simple as possible.\r
1057         More information (albeit Cortex-M specific) is provided on the following\r
1058         link: http://www.freertos.org/RTOS-Cortex-M3-M4.html */\r
1059         portASSERT_IF_INTERRUPT_PRIORITY_INVALID();\r
1060 \r
1061         /* Similar to xQueueGenericSend, except without blocking if there is no room\r
1062         in the queue.  Also don't directly wake a task that was blocked on a queue\r
1063         read, instead return a flag to say whether a context switch is required or\r
1064         not (i.e. has a task with a higher priority than us been woken by this\r
1065         post). */\r
1066         uxSavedInterruptStatus = portSET_INTERRUPT_MASK_FROM_ISR();\r
1067         {\r
1068                 if( ( pxQueue->uxMessagesWaiting < pxQueue->uxLength ) || ( xCopyPosition == queueOVERWRITE ) )\r
1069                 {\r
1070                         traceQUEUE_SEND_FROM_ISR( pxQueue );\r
1071 \r
1072                         if( prvCopyDataToQueue( pxQueue, pvItemToQueue, xCopyPosition ) != pdFALSE )\r
1073                         {\r
1074                                 /* This is a special case that can only be executed if a task\r
1075                                 holds multiple mutexes and then gives the mutexes back in an\r
1076                                 order that is different to that in which they were taken. */\r
1077                                 if( pxHigherPriorityTaskWoken != NULL )\r
1078                                 {\r
1079                                         *pxHigherPriorityTaskWoken = pdTRUE;\r
1080                                 }\r
1081                                 else\r
1082                                 {\r
1083                                         mtCOVERAGE_TEST_MARKER();\r
1084                                 }\r
1085                         }\r
1086 \r
1087                         /* The event list is not altered if the queue is locked.  This will\r
1088                         be done when the queue is unlocked later. */\r
1089                         if( pxQueue->xTxLock == queueUNLOCKED )\r
1090                         {\r
1091                                 #if ( configUSE_QUEUE_SETS == 1 )\r
1092                                 {\r
1093                                         if( pxQueue->pxQueueSetContainer != NULL )\r
1094                                         {\r
1095                                                 if( prvNotifyQueueSetContainer( pxQueue, xCopyPosition ) == pdTRUE )\r
1096                                                 {\r
1097                                                         /* The queue is a member of a queue set, and posting\r
1098                                                         to the queue set caused a higher priority task to\r
1099                                                         unblock.  A context switch is required. */\r
1100                                                         if( pxHigherPriorityTaskWoken != NULL )\r
1101                                                         {\r
1102                                                                 *pxHigherPriorityTaskWoken = pdTRUE;\r
1103                                                         }\r
1104                                                         else\r
1105                                                         {\r
1106                                                                 mtCOVERAGE_TEST_MARKER();\r
1107                                                         }\r
1108                                                 }\r
1109                                                 else\r
1110                                                 {\r
1111                                                         mtCOVERAGE_TEST_MARKER();\r
1112                                                 }\r
1113                                         }\r
1114                                         else\r
1115                                         {\r
1116                                                 if( listLIST_IS_EMPTY( &( pxQueue->xTasksWaitingToReceive ) ) == pdFALSE )\r
1117                                                 {\r
1118                                                         if( xTaskRemoveFromEventList( &( pxQueue->xTasksWaitingToReceive ) ) != pdFALSE )\r
1119                                                         {\r
1120                                                                 /* The task waiting has a higher priority so record that a\r
1121                                                                 context switch is required. */\r
1122                                                                 if( pxHigherPriorityTaskWoken != NULL )\r
1123                                                                 {\r
1124                                                                         *pxHigherPriorityTaskWoken = pdTRUE;\r
1125                                                                 }\r
1126                                                                 else\r
1127                                                                 {\r
1128                                                                         mtCOVERAGE_TEST_MARKER();\r
1129                                                                 }\r
1130                                                         }\r
1131                                                         else\r
1132                                                         {\r
1133                                                                 mtCOVERAGE_TEST_MARKER();\r
1134                                                         }\r
1135                                                 }\r
1136                                                 else\r
1137                                                 {\r
1138                                                         mtCOVERAGE_TEST_MARKER();\r
1139                                                 }\r
1140                                         }\r
1141                                 }\r
1142                                 #else /* configUSE_QUEUE_SETS */\r
1143                                 {\r
1144                                         if( listLIST_IS_EMPTY( &( pxQueue->xTasksWaitingToReceive ) ) == pdFALSE )\r
1145                                         {\r
1146                                                 if( xTaskRemoveFromEventList( &( pxQueue->xTasksWaitingToReceive ) ) != pdFALSE )\r
1147                                                 {\r
1148                                                         /* The task waiting has a higher priority so record that a\r
1149                                                         context switch is required. */\r
1150                                                         if( pxHigherPriorityTaskWoken != NULL )\r
1151                                                         {\r
1152                                                                 *pxHigherPriorityTaskWoken = pdTRUE;\r
1153                                                         }\r
1154                                                         else\r
1155                                                         {\r
1156                                                                 mtCOVERAGE_TEST_MARKER();\r
1157                                                         }\r
1158                                                 }\r
1159                                                 else\r
1160                                                 {\r
1161                                                         mtCOVERAGE_TEST_MARKER();\r
1162                                                 }\r
1163                                         }\r
1164                                         else\r
1165                                         {\r
1166                                                 mtCOVERAGE_TEST_MARKER();\r
1167                                         }\r
1168                                 }\r
1169                                 #endif /* configUSE_QUEUE_SETS */\r
1170                         }\r
1171                         else\r
1172                         {\r
1173                                 /* Increment the lock count so the task that unlocks the queue\r
1174                                 knows that data was posted while it was locked. */\r
1175                                 ++( pxQueue->xTxLock );\r
1176                         }\r
1177 \r
1178                         xReturn = pdPASS;\r
1179                 }\r
1180                 else\r
1181                 {\r
1182                         traceQUEUE_SEND_FROM_ISR_FAILED( pxQueue );\r
1183                         xReturn = errQUEUE_FULL;\r
1184                 }\r
1185         }\r
1186         portCLEAR_INTERRUPT_MASK_FROM_ISR( uxSavedInterruptStatus );\r
1187 \r
1188         return xReturn;\r
1189 }\r
1190 /*-----------------------------------------------------------*/\r
1191 \r
1192 BaseType_t xQueueGenericReceive( QueueHandle_t xQueue, void * const pvBuffer, TickType_t xTicksToWait, const BaseType_t xJustPeeking )\r
1193 {\r
1194 BaseType_t xEntryTimeSet = pdFALSE;\r
1195 TimeOut_t xTimeOut;\r
1196 int8_t *pcOriginalReadPosition;\r
1197 Queue_t * const pxQueue = ( Queue_t * ) xQueue;\r
1198 \r
1199         configASSERT( pxQueue );\r
1200         configASSERT( !( ( pvBuffer == NULL ) && ( pxQueue->uxItemSize != ( UBaseType_t ) 0U ) ) );\r
1201         #if ( ( INCLUDE_xTaskGetSchedulerState == 1 ) || ( configUSE_TIMERS == 1 ) )\r
1202         {\r
1203                 configASSERT( !( ( xTaskGetSchedulerState() == taskSCHEDULER_SUSPENDED ) && ( xTicksToWait != 0 ) ) );\r
1204         }\r
1205         #endif\r
1206 \r
1207         /* This function relaxes the coding standard somewhat to allow return\r
1208         statements within the function itself.  This is done in the interest\r
1209         of execution time efficiency. */\r
1210 \r
1211         for( ;; )\r
1212         {\r
1213                 taskENTER_CRITICAL();\r
1214                 {\r
1215                         /* Is there data in the queue now?  To be running we must be\r
1216                         the highest priority task wanting to access the queue. */\r
1217                         if( pxQueue->uxMessagesWaiting > ( UBaseType_t ) 0 )\r
1218                         {\r
1219                                 /* Remember the read position in case the queue is only being\r
1220                                 peeked. */\r
1221                                 pcOriginalReadPosition = pxQueue->u.pcReadFrom;\r
1222 \r
1223                                 prvCopyDataFromQueue( pxQueue, pvBuffer );\r
1224 \r
1225                                 if( xJustPeeking == pdFALSE )\r
1226                                 {\r
1227                                         traceQUEUE_RECEIVE( pxQueue );\r
1228 \r
1229                                         /* Actually removing data, not just peeking. */\r
1230                                         --( pxQueue->uxMessagesWaiting );\r
1231 \r
1232                                         #if ( configUSE_MUTEXES == 1 )\r
1233                                         {\r
1234                                                 if( pxQueue->uxQueueType == queueQUEUE_IS_MUTEX )\r
1235                                                 {\r
1236                                                         /* Record the information required to implement\r
1237                                                         priority inheritance should it become necessary. */\r
1238                                                         pxQueue->pxMutexHolder = ( int8_t * ) xTaskGetCurrentTaskHandle(); /*lint !e961 Cast is not redundant as TaskHandle_t is a typedef. */\r
1239                                                 }\r
1240                                                 else\r
1241                                                 {\r
1242                                                         mtCOVERAGE_TEST_MARKER();\r
1243                                                 }\r
1244                                         }\r
1245                                         #endif\r
1246 \r
1247                                         if( listLIST_IS_EMPTY( &( pxQueue->xTasksWaitingToSend ) ) == pdFALSE )\r
1248                                         {\r
1249                                                 if( xTaskRemoveFromEventList( &( pxQueue->xTasksWaitingToSend ) ) == pdTRUE )\r
1250                                                 {\r
1251                                                         queueYIELD_IF_USING_PREEMPTION();\r
1252                                                 }\r
1253                                                 else\r
1254                                                 {\r
1255                                                         mtCOVERAGE_TEST_MARKER();\r
1256                                                 }\r
1257                                         }\r
1258                                         else\r
1259                                         {\r
1260                                                 mtCOVERAGE_TEST_MARKER();\r
1261                                         }\r
1262                                 }\r
1263                                 else\r
1264                                 {\r
1265                                         traceQUEUE_PEEK( pxQueue );\r
1266 \r
1267                                         /* The data is not being removed, so reset the read\r
1268                                         pointer. */\r
1269                                         pxQueue->u.pcReadFrom = pcOriginalReadPosition;\r
1270 \r
1271                                         /* The data is being left in the queue, so see if there are\r
1272                                         any other tasks waiting for the data. */\r
1273                                         if( listLIST_IS_EMPTY( &( pxQueue->xTasksWaitingToReceive ) ) == pdFALSE )\r
1274                                         {\r
1275                                                 /* Tasks that are removed from the event list will get added to\r
1276                                                 the pending ready list as the scheduler is still suspended. */\r
1277                                                 if( xTaskRemoveFromEventList( &( pxQueue->xTasksWaitingToReceive ) ) != pdFALSE )\r
1278                                                 {\r
1279                                                         /* The task waiting has a higher priority than this task. */\r
1280                                                         queueYIELD_IF_USING_PREEMPTION();\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 \r
1293                                 taskEXIT_CRITICAL();\r
1294                                 return pdPASS;\r
1295                         }\r
1296                         else\r
1297                         {\r
1298                                 if( xTicksToWait == ( TickType_t ) 0 )\r
1299                                 {\r
1300                                         /* The queue was empty and no block time is specified (or\r
1301                                         the block time has expired) so leave now. */\r
1302                                         taskEXIT_CRITICAL();\r
1303                                         traceQUEUE_RECEIVE_FAILED( pxQueue );\r
1304                                         return errQUEUE_EMPTY;\r
1305                                 }\r
1306                                 else if( xEntryTimeSet == pdFALSE )\r
1307                                 {\r
1308                                         /* The queue was empty and a block time was specified so\r
1309                                         configure the timeout structure. */\r
1310                                         vTaskSetTimeOutState( &xTimeOut );\r
1311                                         xEntryTimeSet = pdTRUE;\r
1312                                 }\r
1313                                 else\r
1314                                 {\r
1315                                         /* Entry time was already set. */\r
1316                                         mtCOVERAGE_TEST_MARKER();\r
1317                                 }\r
1318                         }\r
1319                 }\r
1320                 taskEXIT_CRITICAL();\r
1321 \r
1322                 /* Interrupts and other tasks can send to and receive from the queue\r
1323                 now the critical section has been exited. */\r
1324 \r
1325                 vTaskSuspendAll();\r
1326                 prvLockQueue( pxQueue );\r
1327 \r
1328                 /* Update the timeout state to see if it has expired yet. */\r
1329                 if( xTaskCheckForTimeOut( &xTimeOut, &xTicksToWait ) == pdFALSE )\r
1330                 {\r
1331                         if( prvIsQueueEmpty( pxQueue ) != pdFALSE )\r
1332                         {\r
1333                                 traceBLOCKING_ON_QUEUE_RECEIVE( pxQueue );\r
1334 \r
1335                                 #if ( configUSE_MUTEXES == 1 )\r
1336                                 {\r
1337                                         if( pxQueue->uxQueueType == queueQUEUE_IS_MUTEX )\r
1338                                         {\r
1339                                                 taskENTER_CRITICAL();\r
1340                                                 {\r
1341                                                         vTaskPriorityInherit( ( void * ) pxQueue->pxMutexHolder );\r
1342                                                 }\r
1343                                                 taskEXIT_CRITICAL();\r
1344                                         }\r
1345                                         else\r
1346                                         {\r
1347                                                 mtCOVERAGE_TEST_MARKER();\r
1348                                         }\r
1349                                 }\r
1350                                 #endif\r
1351 \r
1352                                 vTaskPlaceOnEventList( &( pxQueue->xTasksWaitingToReceive ), xTicksToWait );\r
1353                                 prvUnlockQueue( pxQueue );\r
1354                                 if( xTaskResumeAll() == pdFALSE )\r
1355                                 {\r
1356                                         portYIELD_WITHIN_API();\r
1357                                 }\r
1358                                 else\r
1359                                 {\r
1360                                         mtCOVERAGE_TEST_MARKER();\r
1361                                 }\r
1362                         }\r
1363                         else\r
1364                         {\r
1365                                 /* Try again. */\r
1366                                 prvUnlockQueue( pxQueue );\r
1367                                 ( void ) xTaskResumeAll();\r
1368                         }\r
1369                 }\r
1370                 else\r
1371                 {\r
1372                         prvUnlockQueue( pxQueue );\r
1373                         ( void ) xTaskResumeAll();\r
1374                         traceQUEUE_RECEIVE_FAILED( pxQueue );\r
1375                         return errQUEUE_EMPTY;\r
1376                 }\r
1377         }\r
1378 }\r
1379 /*-----------------------------------------------------------*/\r
1380 \r
1381 BaseType_t xQueueReceiveFromISR( QueueHandle_t xQueue, void * const pvBuffer, BaseType_t * const pxHigherPriorityTaskWoken )\r
1382 {\r
1383 BaseType_t xReturn;\r
1384 UBaseType_t uxSavedInterruptStatus;\r
1385 Queue_t * const pxQueue = ( Queue_t * ) xQueue;\r
1386 \r
1387         configASSERT( pxQueue );\r
1388         configASSERT( !( ( pvBuffer == NULL ) && ( pxQueue->uxItemSize != ( UBaseType_t ) 0U ) ) );\r
1389 \r
1390         /* RTOS ports that support interrupt nesting have the concept of a maximum\r
1391         system call (or maximum API call) interrupt priority.  Interrupts that are\r
1392         above the maximum system call priority are kept permanently enabled, even\r
1393         when the RTOS kernel is in a critical section, but cannot make any calls to\r
1394         FreeRTOS API functions.  If configASSERT() is defined in FreeRTOSConfig.h\r
1395         then portASSERT_IF_INTERRUPT_PRIORITY_INVALID() will result in an assertion\r
1396         failure if a FreeRTOS API function is called from an interrupt that has been\r
1397         assigned a priority above the configured maximum system call priority.\r
1398         Only FreeRTOS functions that end in FromISR can be called from interrupts\r
1399         that have been assigned a priority at or (logically) below the maximum\r
1400         system call     interrupt priority.  FreeRTOS maintains a separate interrupt\r
1401         safe API to ensure interrupt entry is as fast and as simple as possible.\r
1402         More information (albeit Cortex-M specific) is provided on the following\r
1403         link: http://www.freertos.org/RTOS-Cortex-M3-M4.html */\r
1404         portASSERT_IF_INTERRUPT_PRIORITY_INVALID();\r
1405 \r
1406         uxSavedInterruptStatus = portSET_INTERRUPT_MASK_FROM_ISR();\r
1407         {\r
1408                 /* Cannot block in an ISR, so check there is data available. */\r
1409                 if( pxQueue->uxMessagesWaiting > ( UBaseType_t ) 0 )\r
1410                 {\r
1411                         traceQUEUE_RECEIVE_FROM_ISR( pxQueue );\r
1412 \r
1413                         prvCopyDataFromQueue( pxQueue, pvBuffer );\r
1414                         --( pxQueue->uxMessagesWaiting );\r
1415 \r
1416                         /* If the queue is locked the event list will not be modified.\r
1417                         Instead update the lock count so the task that unlocks the queue\r
1418                         will know that an ISR has removed data while the queue was\r
1419                         locked. */\r
1420                         if( pxQueue->xRxLock == queueUNLOCKED )\r
1421                         {\r
1422                                 if( listLIST_IS_EMPTY( &( pxQueue->xTasksWaitingToSend ) ) == pdFALSE )\r
1423                                 {\r
1424                                         if( xTaskRemoveFromEventList( &( pxQueue->xTasksWaitingToSend ) ) != pdFALSE )\r
1425                                         {\r
1426                                                 /* The task waiting has a higher priority than us so\r
1427                                                 force a context switch. */\r
1428                                                 if( pxHigherPriorityTaskWoken != NULL )\r
1429                                                 {\r
1430                                                         *pxHigherPriorityTaskWoken = pdTRUE;\r
1431                                                 }\r
1432                                                 else\r
1433                                                 {\r
1434                                                         mtCOVERAGE_TEST_MARKER();\r
1435                                                 }\r
1436                                         }\r
1437                                         else\r
1438                                         {\r
1439                                                 mtCOVERAGE_TEST_MARKER();\r
1440                                         }\r
1441                                 }\r
1442                                 else\r
1443                                 {\r
1444                                         mtCOVERAGE_TEST_MARKER();\r
1445                                 }\r
1446                         }\r
1447                         else\r
1448                         {\r
1449                                 /* Increment the lock count so the task that unlocks the queue\r
1450                                 knows that data was removed while it was locked. */\r
1451                                 ++( pxQueue->xRxLock );\r
1452                         }\r
1453 \r
1454                         xReturn = pdPASS;\r
1455                 }\r
1456                 else\r
1457                 {\r
1458                         xReturn = pdFAIL;\r
1459                         traceQUEUE_RECEIVE_FROM_ISR_FAILED( pxQueue );\r
1460                 }\r
1461         }\r
1462         portCLEAR_INTERRUPT_MASK_FROM_ISR( uxSavedInterruptStatus );\r
1463 \r
1464         return xReturn;\r
1465 }\r
1466 /*-----------------------------------------------------------*/\r
1467 \r
1468 BaseType_t xQueuePeekFromISR( QueueHandle_t xQueue,  void * const pvBuffer )\r
1469 {\r
1470 BaseType_t xReturn;\r
1471 UBaseType_t uxSavedInterruptStatus;\r
1472 int8_t *pcOriginalReadPosition;\r
1473 Queue_t * const pxQueue = ( Queue_t * ) xQueue;\r
1474 \r
1475         configASSERT( pxQueue );\r
1476         configASSERT( !( ( pvBuffer == NULL ) && ( pxQueue->uxItemSize != ( UBaseType_t ) 0U ) ) );\r
1477 \r
1478         /* RTOS ports that support interrupt nesting have the concept of a maximum\r
1479         system call (or maximum API call) interrupt priority.  Interrupts that are\r
1480         above the maximum system call priority are kept permanently enabled, even\r
1481         when the RTOS kernel is in a critical section, but cannot make any calls to\r
1482         FreeRTOS API functions.  If configASSERT() is defined in FreeRTOSConfig.h\r
1483         then portASSERT_IF_INTERRUPT_PRIORITY_INVALID() will result in an assertion\r
1484         failure if a FreeRTOS API function is called from an interrupt that has been\r
1485         assigned a priority above the configured maximum system call priority.\r
1486         Only FreeRTOS functions that end in FromISR can be called from interrupts\r
1487         that have been assigned a priority at or (logically) below the maximum\r
1488         system call     interrupt priority.  FreeRTOS maintains a separate interrupt\r
1489         safe API to ensure interrupt entry is as fast and as simple as possible.\r
1490         More information (albeit Cortex-M specific) is provided on the following\r
1491         link: http://www.freertos.org/RTOS-Cortex-M3-M4.html */\r
1492         portASSERT_IF_INTERRUPT_PRIORITY_INVALID();\r
1493 \r
1494         uxSavedInterruptStatus = portSET_INTERRUPT_MASK_FROM_ISR();\r
1495         {\r
1496                 /* Cannot block in an ISR, so check there is data available. */\r
1497                 if( pxQueue->uxMessagesWaiting > ( UBaseType_t ) 0 )\r
1498                 {\r
1499                         traceQUEUE_PEEK_FROM_ISR( pxQueue );\r
1500 \r
1501                         /* Remember the read position so it can be reset as nothing is\r
1502                         actually being removed from the queue. */\r
1503                         pcOriginalReadPosition = pxQueue->u.pcReadFrom;\r
1504                         prvCopyDataFromQueue( pxQueue, pvBuffer );\r
1505                         pxQueue->u.pcReadFrom = pcOriginalReadPosition;\r
1506 \r
1507                         xReturn = pdPASS;\r
1508                 }\r
1509                 else\r
1510                 {\r
1511                         xReturn = pdFAIL;\r
1512                         traceQUEUE_PEEK_FROM_ISR_FAILED( pxQueue );\r
1513                 }\r
1514         }\r
1515         portCLEAR_INTERRUPT_MASK_FROM_ISR( uxSavedInterruptStatus );\r
1516 \r
1517         return xReturn;\r
1518 }\r
1519 /*-----------------------------------------------------------*/\r
1520 \r
1521 UBaseType_t uxQueueMessagesWaiting( const QueueHandle_t xQueue )\r
1522 {\r
1523 UBaseType_t uxReturn;\r
1524 \r
1525         configASSERT( xQueue );\r
1526 \r
1527         taskENTER_CRITICAL();\r
1528         {\r
1529                 uxReturn = ( ( Queue_t * ) xQueue )->uxMessagesWaiting;\r
1530         }\r
1531         taskEXIT_CRITICAL();\r
1532 \r
1533         return uxReturn;\r
1534 } /*lint !e818 Pointer cannot be declared const as xQueue is a typedef not pointer. */\r
1535 /*-----------------------------------------------------------*/\r
1536 \r
1537 UBaseType_t uxQueueSpacesAvailable( const QueueHandle_t xQueue )\r
1538 {\r
1539 UBaseType_t uxReturn;\r
1540 Queue_t *pxQueue;\r
1541 \r
1542         pxQueue = ( Queue_t * ) xQueue;\r
1543         configASSERT( pxQueue );\r
1544 \r
1545         taskENTER_CRITICAL();\r
1546         {\r
1547                 uxReturn = pxQueue->uxLength - pxQueue->uxMessagesWaiting;\r
1548         }\r
1549         taskEXIT_CRITICAL();\r
1550 \r
1551         return uxReturn;\r
1552 } /*lint !e818 Pointer cannot be declared const as xQueue is a typedef not pointer. */\r
1553 /*-----------------------------------------------------------*/\r
1554 \r
1555 UBaseType_t uxQueueMessagesWaitingFromISR( const QueueHandle_t xQueue )\r
1556 {\r
1557 UBaseType_t uxReturn;\r
1558 \r
1559         configASSERT( xQueue );\r
1560 \r
1561         uxReturn = ( ( Queue_t * ) xQueue )->uxMessagesWaiting;\r
1562 \r
1563         return uxReturn;\r
1564 } /*lint !e818 Pointer cannot be declared const as xQueue is a typedef not pointer. */\r
1565 /*-----------------------------------------------------------*/\r
1566 \r
1567 void vQueueDelete( QueueHandle_t xQueue )\r
1568 {\r
1569 Queue_t * const pxQueue = ( Queue_t * ) xQueue;\r
1570 \r
1571         configASSERT( pxQueue );\r
1572 \r
1573         traceQUEUE_DELETE( pxQueue );\r
1574         #if ( configQUEUE_REGISTRY_SIZE > 0 )\r
1575         {\r
1576                 vQueueUnregisterQueue( pxQueue );\r
1577         }\r
1578         #endif\r
1579         if( pxQueue->pcHead != NULL )\r
1580         {\r
1581                 vPortFree( pxQueue->pcHead );\r
1582         }\r
1583         vPortFree( pxQueue );\r
1584 }\r
1585 /*-----------------------------------------------------------*/\r
1586 \r
1587 #if ( configUSE_TRACE_FACILITY == 1 )\r
1588 \r
1589         UBaseType_t uxQueueGetQueueNumber( QueueHandle_t xQueue )\r
1590         {\r
1591                 return ( ( Queue_t * ) xQueue )->uxQueueNumber;\r
1592         }\r
1593 \r
1594 #endif /* configUSE_TRACE_FACILITY */\r
1595 /*-----------------------------------------------------------*/\r
1596 \r
1597 #if ( configUSE_TRACE_FACILITY == 1 )\r
1598 \r
1599         void vQueueSetQueueNumber( QueueHandle_t xQueue, UBaseType_t uxQueueNumber )\r
1600         {\r
1601                 ( ( Queue_t * ) xQueue )->uxQueueNumber = uxQueueNumber;\r
1602         }\r
1603 \r
1604 #endif /* configUSE_TRACE_FACILITY */\r
1605 /*-----------------------------------------------------------*/\r
1606 \r
1607 #if ( configUSE_TRACE_FACILITY == 1 )\r
1608 \r
1609         uint8_t ucQueueGetQueueType( QueueHandle_t xQueue )\r
1610         {\r
1611                 return ( ( Queue_t * ) xQueue )->ucQueueType;\r
1612         }\r
1613 \r
1614 #endif /* configUSE_TRACE_FACILITY */\r
1615 /*-----------------------------------------------------------*/\r
1616 \r
1617 static BaseType_t prvCopyDataToQueue( Queue_t * const pxQueue, const void *pvItemToQueue, const BaseType_t xPosition )\r
1618 {\r
1619 BaseType_t xReturn = pdFALSE;\r
1620 \r
1621         if( pxQueue->uxItemSize == ( UBaseType_t ) 0 )\r
1622         {\r
1623                 #if ( configUSE_MUTEXES == 1 )\r
1624                 {\r
1625                         if( pxQueue->uxQueueType == queueQUEUE_IS_MUTEX )\r
1626                         {\r
1627                                 /* The mutex is no longer being held. */\r
1628                                 vTaskDecrementMutexHeldCount();\r
1629                                 xReturn = xTaskPriorityDisinherit( ( void * ) pxQueue->pxMutexHolder );\r
1630                                 pxQueue->pxMutexHolder = NULL;                          \r
1631                         }\r
1632                         else\r
1633                         {\r
1634                                 mtCOVERAGE_TEST_MARKER();\r
1635                         }\r
1636                 }\r
1637                 #endif /* configUSE_MUTEXES */\r
1638         }\r
1639         else if( xPosition == queueSEND_TO_BACK )\r
1640         {\r
1641                 ( void ) memcpy( ( void * ) pxQueue->pcWriteTo, pvItemToQueue, ( size_t ) pxQueue->uxItemSize ); /*lint !e961 !e418 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. */\r
1642                 pxQueue->pcWriteTo += pxQueue->uxItemSize;\r
1643                 if( pxQueue->pcWriteTo >= pxQueue->pcTail ) /*lint !e946 MISRA exception justified as comparison of pointers is the cleanest solution. */\r
1644                 {\r
1645                         pxQueue->pcWriteTo = pxQueue->pcHead;\r
1646                 }\r
1647                 else\r
1648                 {\r
1649                         mtCOVERAGE_TEST_MARKER();\r
1650                 }\r
1651         }\r
1652         else\r
1653         {\r
1654                 ( void ) memcpy( ( void * ) pxQueue->u.pcReadFrom, pvItemToQueue, ( size_t ) pxQueue->uxItemSize ); /*lint !e961 MISRA exception as the casts are only redundant for some ports. */\r
1655                 pxQueue->u.pcReadFrom -= pxQueue->uxItemSize;\r
1656                 if( pxQueue->u.pcReadFrom < pxQueue->pcHead ) /*lint !e946 MISRA exception justified as comparison of pointers is the cleanest solution. */\r
1657                 {\r
1658                         pxQueue->u.pcReadFrom = ( pxQueue->pcTail - pxQueue->uxItemSize );\r
1659                 }\r
1660                 else\r
1661                 {\r
1662                         mtCOVERAGE_TEST_MARKER();\r
1663                 }\r
1664 \r
1665                 if( xPosition == queueOVERWRITE )\r
1666                 {\r
1667                         if( pxQueue->uxMessagesWaiting > ( UBaseType_t ) 0 )\r
1668                         {\r
1669                                 /* An item is not being added but overwritten, so subtract\r
1670                                 one from the recorded number of items in the queue so when\r
1671                                 one is added again below the number of recorded items remains\r
1672                                 correct. */\r
1673                                 --( pxQueue->uxMessagesWaiting );\r
1674                         }\r
1675                         else\r
1676                         {\r
1677                                 mtCOVERAGE_TEST_MARKER();\r
1678                         }\r
1679                 }\r
1680                 else\r
1681                 {\r
1682                         mtCOVERAGE_TEST_MARKER();\r
1683                 }\r
1684         }\r
1685 \r
1686         ++( pxQueue->uxMessagesWaiting );\r
1687 \r
1688         return xReturn;\r
1689 }\r
1690 /*-----------------------------------------------------------*/\r
1691 \r
1692 static void prvCopyDataFromQueue( Queue_t * const pxQueue, void * const pvBuffer )\r
1693 {\r
1694         if( pxQueue->uxQueueType != queueQUEUE_IS_MUTEX )\r
1695         {\r
1696                 pxQueue->u.pcReadFrom += pxQueue->uxItemSize;\r
1697                 if( pxQueue->u.pcReadFrom >= pxQueue->pcTail ) /*lint !e946 MISRA exception justified as use of the relational operator is the cleanest solutions. */\r
1698                 {\r
1699                         pxQueue->u.pcReadFrom = pxQueue->pcHead;\r
1700                 }\r
1701                 else\r
1702                 {\r
1703                         mtCOVERAGE_TEST_MARKER();\r
1704                 }\r
1705                 ( void ) memcpy( ( void * ) pvBuffer, ( void * ) pxQueue->u.pcReadFrom, ( size_t ) pxQueue->uxItemSize ); /*lint !e961 !e418 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. */\r
1706         }\r
1707         else\r
1708         {\r
1709                 /* A mutex was taken. */\r
1710                 vTaskIncrementMutexHeldCount();\r
1711         }\r
1712 }\r
1713 /*-----------------------------------------------------------*/\r
1714 \r
1715 static void prvUnlockQueue( Queue_t * const pxQueue )\r
1716 {\r
1717         /* THIS FUNCTION MUST BE CALLED WITH THE SCHEDULER SUSPENDED. */\r
1718 \r
1719         /* The lock counts contains the number of extra data items placed or\r
1720         removed from the queue while the queue was locked.  When a queue is\r
1721         locked items can be added or removed, but the event lists cannot be\r
1722         updated. */\r
1723         taskENTER_CRITICAL();\r
1724         {\r
1725                 /* See if data was added to the queue while it was locked. */\r
1726                 while( pxQueue->xTxLock > queueLOCKED_UNMODIFIED )\r
1727                 {\r
1728                         /* Data was posted while the queue was locked.  Are any tasks\r
1729                         blocked waiting for data to become available? */\r
1730                         #if ( configUSE_QUEUE_SETS == 1 )\r
1731                         {\r
1732                                 if( pxQueue->pxQueueSetContainer != NULL )\r
1733                                 {\r
1734                                         if( prvNotifyQueueSetContainer( pxQueue, queueSEND_TO_BACK ) == pdTRUE )\r
1735                                         {\r
1736                                                 /* The queue is a member of a queue set, and posting to\r
1737                                                 the queue set caused a higher priority task to unblock.\r
1738                                                 A context switch is required. */\r
1739                                                 vTaskMissedYield();\r
1740                                         }\r
1741                                         else\r
1742                                         {\r
1743                                                 mtCOVERAGE_TEST_MARKER();\r
1744                                         }\r
1745                                 }\r
1746                                 else\r
1747                                 {\r
1748                                         /* Tasks that are removed from the event list will get added to\r
1749                                         the pending ready list as the scheduler is still suspended. */\r
1750                                         if( listLIST_IS_EMPTY( &( pxQueue->xTasksWaitingToReceive ) ) == pdFALSE )\r
1751                                         {\r
1752                                                 if( xTaskRemoveFromEventList( &( pxQueue->xTasksWaitingToReceive ) ) != pdFALSE )\r
1753                                                 {\r
1754                                                         /* The task waiting has a higher priority so record that a\r
1755                                                         context switch is required. */\r
1756                                                         vTaskMissedYield();\r
1757                                                 }\r
1758                                                 else\r
1759                                                 {\r
1760                                                         mtCOVERAGE_TEST_MARKER();\r
1761                                                 }\r
1762                                         }\r
1763                                         else\r
1764                                         {\r
1765                                                 break;\r
1766                                         }\r
1767                                 }\r
1768                         }\r
1769                         #else /* configUSE_QUEUE_SETS */\r
1770                         {\r
1771                                 /* Tasks that are removed from the event list will get added to\r
1772                                 the pending ready list as the scheduler is still suspended. */\r
1773                                 if( listLIST_IS_EMPTY( &( pxQueue->xTasksWaitingToReceive ) ) == pdFALSE )\r
1774                                 {\r
1775                                         if( xTaskRemoveFromEventList( &( pxQueue->xTasksWaitingToReceive ) ) != pdFALSE )\r
1776                                         {\r
1777                                                 /* The task waiting has a higher priority so record that a\r
1778                                                 context switch is required. */\r
1779                                                 vTaskMissedYield();\r
1780                                         }\r
1781                                         else\r
1782                                         {\r
1783                                                 mtCOVERAGE_TEST_MARKER();\r
1784                                         }\r
1785                                 }\r
1786                                 else\r
1787                                 {\r
1788                                         break;\r
1789                                 }\r
1790                         }\r
1791                         #endif /* configUSE_QUEUE_SETS */\r
1792 \r
1793                         --( pxQueue->xTxLock );\r
1794                 }\r
1795 \r
1796                 pxQueue->xTxLock = queueUNLOCKED;\r
1797         }\r
1798         taskEXIT_CRITICAL();\r
1799 \r
1800         /* Do the same for the Rx lock. */\r
1801         taskENTER_CRITICAL();\r
1802         {\r
1803                 while( pxQueue->xRxLock > queueLOCKED_UNMODIFIED )\r
1804                 {\r
1805                         if( listLIST_IS_EMPTY( &( pxQueue->xTasksWaitingToSend ) ) == pdFALSE )\r
1806                         {\r
1807                                 if( xTaskRemoveFromEventList( &( pxQueue->xTasksWaitingToSend ) ) != pdFALSE )\r
1808                                 {\r
1809                                         vTaskMissedYield();\r
1810                                 }\r
1811                                 else\r
1812                                 {\r
1813                                         mtCOVERAGE_TEST_MARKER();\r
1814                                 }\r
1815 \r
1816                                 --( pxQueue->xRxLock );\r
1817                         }\r
1818                         else\r
1819                         {\r
1820                                 break;\r
1821                         }\r
1822                 }\r
1823 \r
1824                 pxQueue->xRxLock = queueUNLOCKED;\r
1825         }\r
1826         taskEXIT_CRITICAL();\r
1827 }\r
1828 /*-----------------------------------------------------------*/\r
1829 \r
1830 static BaseType_t prvIsQueueEmpty( const Queue_t *pxQueue )\r
1831 {\r
1832 BaseType_t xReturn;\r
1833 \r
1834         taskENTER_CRITICAL();\r
1835         {\r
1836                 if( pxQueue->uxMessagesWaiting == ( UBaseType_t )  0 )\r
1837                 {\r
1838                         xReturn = pdTRUE;\r
1839                 }\r
1840                 else\r
1841                 {\r
1842                         xReturn = pdFALSE;\r
1843                 }\r
1844         }\r
1845         taskEXIT_CRITICAL();\r
1846 \r
1847         return xReturn;\r
1848 }\r
1849 /*-----------------------------------------------------------*/\r
1850 \r
1851 BaseType_t xQueueIsQueueEmptyFromISR( const QueueHandle_t xQueue )\r
1852 {\r
1853 BaseType_t xReturn;\r
1854 \r
1855         configASSERT( xQueue );\r
1856         if( ( ( Queue_t * ) xQueue )->uxMessagesWaiting == ( UBaseType_t ) 0 )\r
1857         {\r
1858                 xReturn = pdTRUE;\r
1859         }\r
1860         else\r
1861         {\r
1862                 xReturn = pdFALSE;\r
1863         }\r
1864 \r
1865         return xReturn;\r
1866 } /*lint !e818 xQueue could not be pointer to const because it is a typedef. */\r
1867 /*-----------------------------------------------------------*/\r
1868 \r
1869 static BaseType_t prvIsQueueFull( const Queue_t *pxQueue )\r
1870 {\r
1871 BaseType_t xReturn;\r
1872 \r
1873         taskENTER_CRITICAL();\r
1874         {\r
1875                 if( pxQueue->uxMessagesWaiting == pxQueue->uxLength )\r
1876                 {\r
1877                         xReturn = pdTRUE;\r
1878                 }\r
1879                 else\r
1880                 {\r
1881                         xReturn = pdFALSE;\r
1882                 }\r
1883         }\r
1884         taskEXIT_CRITICAL();\r
1885 \r
1886         return xReturn;\r
1887 }\r
1888 /*-----------------------------------------------------------*/\r
1889 \r
1890 BaseType_t xQueueIsQueueFullFromISR( const QueueHandle_t xQueue )\r
1891 {\r
1892 BaseType_t xReturn;\r
1893 \r
1894         configASSERT( xQueue );\r
1895         if( ( ( Queue_t * ) xQueue )->uxMessagesWaiting == ( ( Queue_t * ) xQueue )->uxLength )\r
1896         {\r
1897                 xReturn = pdTRUE;\r
1898         }\r
1899         else\r
1900         {\r
1901                 xReturn = pdFALSE;\r
1902         }\r
1903 \r
1904         return xReturn;\r
1905 } /*lint !e818 xQueue could not be pointer to const because it is a typedef. */\r
1906 /*-----------------------------------------------------------*/\r
1907 \r
1908 #if ( configUSE_CO_ROUTINES == 1 )\r
1909 \r
1910         BaseType_t xQueueCRSend( QueueHandle_t xQueue, const void *pvItemToQueue, TickType_t xTicksToWait )\r
1911         {\r
1912         BaseType_t xReturn;\r
1913         Queue_t * const pxQueue = ( Queue_t * ) xQueue;\r
1914 \r
1915                 /* If the queue is already full we may have to block.  A critical section\r
1916                 is required to prevent an interrupt removing something from the queue\r
1917                 between the check to see if the queue is full and blocking on the queue. */\r
1918                 portDISABLE_INTERRUPTS();\r
1919                 {\r
1920                         if( prvIsQueueFull( pxQueue ) != pdFALSE )\r
1921                         {\r
1922                                 /* The queue is full - do we want to block or just leave without\r
1923                                 posting? */\r
1924                                 if( xTicksToWait > ( TickType_t ) 0 )\r
1925                                 {\r
1926                                         /* As this is called from a coroutine we cannot block directly, but\r
1927                                         return indicating that we need to block. */\r
1928                                         vCoRoutineAddToDelayedList( xTicksToWait, &( pxQueue->xTasksWaitingToSend ) );\r
1929                                         portENABLE_INTERRUPTS();\r
1930                                         return errQUEUE_BLOCKED;\r
1931                                 }\r
1932                                 else\r
1933                                 {\r
1934                                         portENABLE_INTERRUPTS();\r
1935                                         return errQUEUE_FULL;\r
1936                                 }\r
1937                         }\r
1938                 }\r
1939                 portENABLE_INTERRUPTS();\r
1940 \r
1941                 portDISABLE_INTERRUPTS();\r
1942                 {\r
1943                         if( pxQueue->uxMessagesWaiting < pxQueue->uxLength )\r
1944                         {\r
1945                                 /* There is room in the queue, copy the data into the queue. */\r
1946                                 prvCopyDataToQueue( pxQueue, pvItemToQueue, queueSEND_TO_BACK );\r
1947                                 xReturn = pdPASS;\r
1948 \r
1949                                 /* Were any co-routines waiting for data to become available? */\r
1950                                 if( listLIST_IS_EMPTY( &( pxQueue->xTasksWaitingToReceive ) ) == pdFALSE )\r
1951                                 {\r
1952                                         /* In this instance the co-routine could be placed directly\r
1953                                         into the ready list as we are within a critical section.\r
1954                                         Instead the same pending ready list mechanism is used as if\r
1955                                         the event were caused from within an interrupt. */\r
1956                                         if( xCoRoutineRemoveFromEventList( &( pxQueue->xTasksWaitingToReceive ) ) != pdFALSE )\r
1957                                         {\r
1958                                                 /* The co-routine waiting has a higher priority so record\r
1959                                                 that a yield might be appropriate. */\r
1960                                                 xReturn = errQUEUE_YIELD;\r
1961                                         }\r
1962                                         else\r
1963                                         {\r
1964                                                 mtCOVERAGE_TEST_MARKER();\r
1965                                         }\r
1966                                 }\r
1967                                 else\r
1968                                 {\r
1969                                         mtCOVERAGE_TEST_MARKER();\r
1970                                 }\r
1971                         }\r
1972                         else\r
1973                         {\r
1974                                 xReturn = errQUEUE_FULL;\r
1975                         }\r
1976                 }\r
1977                 portENABLE_INTERRUPTS();\r
1978 \r
1979                 return xReturn;\r
1980         }\r
1981 \r
1982 #endif /* configUSE_CO_ROUTINES */\r
1983 /*-----------------------------------------------------------*/\r
1984 \r
1985 #if ( configUSE_CO_ROUTINES == 1 )\r
1986 \r
1987         BaseType_t xQueueCRReceive( QueueHandle_t xQueue, void *pvBuffer, TickType_t xTicksToWait )\r
1988         {\r
1989         BaseType_t xReturn;\r
1990         Queue_t * const pxQueue = ( Queue_t * ) xQueue;\r
1991 \r
1992                 /* If the queue is already empty we may have to block.  A critical section\r
1993                 is required to prevent an interrupt adding something to the queue\r
1994                 between the check to see if the queue is empty and blocking on the queue. */\r
1995                 portDISABLE_INTERRUPTS();\r
1996                 {\r
1997                         if( pxQueue->uxMessagesWaiting == ( UBaseType_t ) 0 )\r
1998                         {\r
1999                                 /* There are no messages in the queue, do we want to block or just\r
2000                                 leave with nothing? */\r
2001                                 if( xTicksToWait > ( TickType_t ) 0 )\r
2002                                 {\r
2003                                         /* As this is a co-routine we cannot block directly, but return\r
2004                                         indicating that we need to block. */\r
2005                                         vCoRoutineAddToDelayedList( xTicksToWait, &( pxQueue->xTasksWaitingToReceive ) );\r
2006                                         portENABLE_INTERRUPTS();\r
2007                                         return errQUEUE_BLOCKED;\r
2008                                 }\r
2009                                 else\r
2010                                 {\r
2011                                         portENABLE_INTERRUPTS();\r
2012                                         return errQUEUE_FULL;\r
2013                                 }\r
2014                         }\r
2015                         else\r
2016                         {\r
2017                                 mtCOVERAGE_TEST_MARKER();\r
2018                         }\r
2019                 }\r
2020                 portENABLE_INTERRUPTS();\r
2021 \r
2022                 portDISABLE_INTERRUPTS();\r
2023                 {\r
2024                         if( pxQueue->uxMessagesWaiting > ( UBaseType_t ) 0 )\r
2025                         {\r
2026                                 /* Data is available from the queue. */\r
2027                                 pxQueue->u.pcReadFrom += pxQueue->uxItemSize;\r
2028                                 if( pxQueue->u.pcReadFrom >= pxQueue->pcTail )\r
2029                                 {\r
2030                                         pxQueue->u.pcReadFrom = pxQueue->pcHead;\r
2031                                 }\r
2032                                 else\r
2033                                 {\r
2034                                         mtCOVERAGE_TEST_MARKER();\r
2035                                 }\r
2036                                 --( pxQueue->uxMessagesWaiting );\r
2037                                 ( void ) memcpy( ( void * ) pvBuffer, ( void * ) pxQueue->u.pcReadFrom, ( unsigned ) pxQueue->uxItemSize );\r
2038 \r
2039                                 xReturn = pdPASS;\r
2040 \r
2041                                 /* Were any co-routines waiting for space to become available? */\r
2042                                 if( listLIST_IS_EMPTY( &( pxQueue->xTasksWaitingToSend ) ) == pdFALSE )\r
2043                                 {\r
2044                                         /* In this instance the co-routine could be placed directly\r
2045                                         into the ready list as we are within a critical section.\r
2046                                         Instead the same pending ready list mechanism is used as if\r
2047                                         the event were caused from within an interrupt. */\r
2048                                         if( xCoRoutineRemoveFromEventList( &( pxQueue->xTasksWaitingToSend ) ) != pdFALSE )\r
2049                                         {\r
2050                                                 xReturn = errQUEUE_YIELD;\r
2051                                         }\r
2052                                         else\r
2053                                         {\r
2054                                                 mtCOVERAGE_TEST_MARKER();\r
2055                                         }\r
2056                                 }\r
2057                                 else\r
2058                                 {\r
2059                                         mtCOVERAGE_TEST_MARKER();\r
2060                                 }\r
2061                         }\r
2062                         else\r
2063                         {\r
2064                                 xReturn = pdFAIL;\r
2065                         }\r
2066                 }\r
2067                 portENABLE_INTERRUPTS();\r
2068 \r
2069                 return xReturn;\r
2070         }\r
2071 \r
2072 #endif /* configUSE_CO_ROUTINES */\r
2073 /*-----------------------------------------------------------*/\r
2074 \r
2075 #if ( configUSE_CO_ROUTINES == 1 )\r
2076 \r
2077         BaseType_t xQueueCRSendFromISR( QueueHandle_t xQueue, const void *pvItemToQueue, BaseType_t xCoRoutinePreviouslyWoken )\r
2078         {\r
2079         Queue_t * const pxQueue = ( Queue_t * ) xQueue;\r
2080 \r
2081                 /* Cannot block within an ISR so if there is no space on the queue then\r
2082                 exit without doing anything. */\r
2083                 if( pxQueue->uxMessagesWaiting < pxQueue->uxLength )\r
2084                 {\r
2085                         prvCopyDataToQueue( pxQueue, pvItemToQueue, queueSEND_TO_BACK );\r
2086 \r
2087                         /* We only want to wake one co-routine per ISR, so check that a\r
2088                         co-routine has not already been woken. */\r
2089                         if( xCoRoutinePreviouslyWoken == pdFALSE )\r
2090                         {\r
2091                                 if( listLIST_IS_EMPTY( &( pxQueue->xTasksWaitingToReceive ) ) == pdFALSE )\r
2092                                 {\r
2093                                         if( xCoRoutineRemoveFromEventList( &( pxQueue->xTasksWaitingToReceive ) ) != pdFALSE )\r
2094                                         {\r
2095                                                 return pdTRUE;\r
2096                                         }\r
2097                                         else\r
2098                                         {\r
2099                                                 mtCOVERAGE_TEST_MARKER();\r
2100                                         }\r
2101                                 }\r
2102                                 else\r
2103                                 {\r
2104                                         mtCOVERAGE_TEST_MARKER();\r
2105                                 }\r
2106                         }\r
2107                         else\r
2108                         {\r
2109                                 mtCOVERAGE_TEST_MARKER();\r
2110                         }\r
2111                 }\r
2112                 else\r
2113                 {\r
2114                         mtCOVERAGE_TEST_MARKER();\r
2115                 }\r
2116 \r
2117                 return xCoRoutinePreviouslyWoken;\r
2118         }\r
2119 \r
2120 #endif /* configUSE_CO_ROUTINES */\r
2121 /*-----------------------------------------------------------*/\r
2122 \r
2123 #if ( configUSE_CO_ROUTINES == 1 )\r
2124 \r
2125         BaseType_t xQueueCRReceiveFromISR( QueueHandle_t xQueue, void *pvBuffer, BaseType_t *pxCoRoutineWoken )\r
2126         {\r
2127         BaseType_t xReturn;\r
2128         Queue_t * const pxQueue = ( Queue_t * ) xQueue;\r
2129 \r
2130                 /* We cannot block from an ISR, so check there is data available. If\r
2131                 not then just leave without doing anything. */\r
2132                 if( pxQueue->uxMessagesWaiting > ( UBaseType_t ) 0 )\r
2133                 {\r
2134                         /* Copy the data from the queue. */\r
2135                         pxQueue->u.pcReadFrom += pxQueue->uxItemSize;\r
2136                         if( pxQueue->u.pcReadFrom >= pxQueue->pcTail )\r
2137                         {\r
2138                                 pxQueue->u.pcReadFrom = pxQueue->pcHead;\r
2139                         }\r
2140                         else\r
2141                         {\r
2142                                 mtCOVERAGE_TEST_MARKER();\r
2143                         }\r
2144                         --( pxQueue->uxMessagesWaiting );\r
2145                         ( void ) memcpy( ( void * ) pvBuffer, ( void * ) pxQueue->u.pcReadFrom, ( unsigned ) pxQueue->uxItemSize );\r
2146 \r
2147                         if( ( *pxCoRoutineWoken ) == pdFALSE )\r
2148                         {\r
2149                                 if( listLIST_IS_EMPTY( &( pxQueue->xTasksWaitingToSend ) ) == pdFALSE )\r
2150                                 {\r
2151                                         if( xCoRoutineRemoveFromEventList( &( pxQueue->xTasksWaitingToSend ) ) != pdFALSE )\r
2152                                         {\r
2153                                                 *pxCoRoutineWoken = pdTRUE;\r
2154                                         }\r
2155                                         else\r
2156                                         {\r
2157                                                 mtCOVERAGE_TEST_MARKER();\r
2158                                         }\r
2159                                 }\r
2160                                 else\r
2161                                 {\r
2162                                         mtCOVERAGE_TEST_MARKER();\r
2163                                 }\r
2164                         }\r
2165                         else\r
2166                         {\r
2167                                 mtCOVERAGE_TEST_MARKER();\r
2168                         }\r
2169 \r
2170                         xReturn = pdPASS;\r
2171                 }\r
2172                 else\r
2173                 {\r
2174                         xReturn = pdFAIL;\r
2175                 }\r
2176 \r
2177                 return xReturn;\r
2178         }\r
2179 \r
2180 #endif /* configUSE_CO_ROUTINES */\r
2181 /*-----------------------------------------------------------*/\r
2182 \r
2183 #if ( configQUEUE_REGISTRY_SIZE > 0 )\r
2184 \r
2185         void vQueueAddToRegistry( QueueHandle_t xQueue, const char *pcQueueName ) /*lint !e971 Unqualified char types are allowed for strings and single characters only. */\r
2186         {\r
2187         UBaseType_t ux;\r
2188 \r
2189                 /* See if there is an empty space in the registry.  A NULL name denotes\r
2190                 a free slot. */\r
2191                 for( ux = ( UBaseType_t ) 0U; ux < ( UBaseType_t ) configQUEUE_REGISTRY_SIZE; ux++ )\r
2192                 {\r
2193                         if( xQueueRegistry[ ux ].pcQueueName == NULL )\r
2194                         {\r
2195                                 /* Store the information on this queue. */\r
2196                                 xQueueRegistry[ ux ].pcQueueName = pcQueueName;\r
2197                                 xQueueRegistry[ ux ].xHandle = xQueue;\r
2198 \r
2199                                 traceQUEUE_REGISTRY_ADD( xQueue, pcQueueName );\r
2200                                 break;\r
2201                         }\r
2202                         else\r
2203                         {\r
2204                                 mtCOVERAGE_TEST_MARKER();\r
2205                         }\r
2206                 }\r
2207         }\r
2208 \r
2209 #endif /* configQUEUE_REGISTRY_SIZE */\r
2210 /*-----------------------------------------------------------*/\r
2211 \r
2212 #if ( configQUEUE_REGISTRY_SIZE > 0 )\r
2213 \r
2214         void vQueueUnregisterQueue( QueueHandle_t xQueue )\r
2215         {\r
2216         UBaseType_t ux;\r
2217 \r
2218                 /* See if the handle of the queue being unregistered in actually in the\r
2219                 registry. */\r
2220                 for( ux = ( UBaseType_t ) 0U; ux < ( UBaseType_t ) configQUEUE_REGISTRY_SIZE; ux++ )\r
2221                 {\r
2222                         if( xQueueRegistry[ ux ].xHandle == xQueue )\r
2223                         {\r
2224                                 /* Set the name to NULL to show that this slot if free again. */\r
2225                                 xQueueRegistry[ ux ].pcQueueName = NULL;\r
2226                                 break;\r
2227                         }\r
2228                         else\r
2229                         {\r
2230                                 mtCOVERAGE_TEST_MARKER();\r
2231                         }\r
2232                 }\r
2233 \r
2234         } /*lint !e818 xQueue could not be pointer to const because it is a typedef. */\r
2235 \r
2236 #endif /* configQUEUE_REGISTRY_SIZE */\r
2237 /*-----------------------------------------------------------*/\r
2238 \r
2239 #if ( configUSE_TIMERS == 1 )\r
2240 \r
2241         void vQueueWaitForMessageRestricted( QueueHandle_t xQueue, TickType_t xTicksToWait )\r
2242         {\r
2243         Queue_t * const pxQueue = ( Queue_t * ) xQueue;\r
2244 \r
2245                 /* This function should not be called by application code hence the\r
2246                 'Restricted' in its name.  It is not part of the public API.  It is\r
2247                 designed for use by kernel code, and has special calling requirements.\r
2248                 It can result in vListInsert() being called on a list that can only\r
2249                 possibly ever have one item in it, so the list will be fast, but even\r
2250                 so it should be called with the scheduler locked and not from a critical\r
2251                 section. */\r
2252 \r
2253                 /* Only do anything if there are no messages in the queue.  This function\r
2254                 will not actually cause the task to block, just place it on a blocked\r
2255                 list.  It will not block until the scheduler is unlocked - at which\r
2256                 time a yield will be performed.  If an item is added to the queue while\r
2257                 the queue is locked, and the calling task blocks on the queue, then the\r
2258                 calling task will be immediately unblocked when the queue is unlocked. */\r
2259                 prvLockQueue( pxQueue );\r
2260                 if( pxQueue->uxMessagesWaiting == ( UBaseType_t ) 0U )\r
2261                 {\r
2262                         /* There is nothing in the queue, block for the specified period. */\r
2263                         vTaskPlaceOnEventListRestricted( &( pxQueue->xTasksWaitingToReceive ), xTicksToWait );\r
2264                 }\r
2265                 else\r
2266                 {\r
2267                         mtCOVERAGE_TEST_MARKER();\r
2268                 }\r
2269                 prvUnlockQueue( pxQueue );\r
2270         }\r
2271 \r
2272 #endif /* configUSE_TIMERS */\r
2273 /*-----------------------------------------------------------*/\r
2274 \r
2275 #if ( configUSE_QUEUE_SETS == 1 )\r
2276 \r
2277         QueueSetHandle_t xQueueCreateSet( const UBaseType_t uxEventQueueLength )\r
2278         {\r
2279         QueueSetHandle_t pxQueue;\r
2280 \r
2281                 pxQueue = xQueueGenericCreate( uxEventQueueLength, sizeof( Queue_t * ), queueQUEUE_TYPE_SET );\r
2282 \r
2283                 return pxQueue;\r
2284         }\r
2285 \r
2286 #endif /* configUSE_QUEUE_SETS */\r
2287 /*-----------------------------------------------------------*/\r
2288 \r
2289 #if ( configUSE_QUEUE_SETS == 1 )\r
2290 \r
2291         BaseType_t xQueueAddToSet( QueueSetMemberHandle_t xQueueOrSemaphore, QueueSetHandle_t xQueueSet )\r
2292         {\r
2293         BaseType_t xReturn;\r
2294 \r
2295                 taskENTER_CRITICAL();\r
2296                 {\r
2297                         if( ( ( Queue_t * ) xQueueOrSemaphore )->pxQueueSetContainer != NULL )\r
2298                         {\r
2299                                 /* Cannot add a queue/semaphore to more than one queue set. */\r
2300                                 xReturn = pdFAIL;\r
2301                         }\r
2302                         else if( ( ( Queue_t * ) xQueueOrSemaphore )->uxMessagesWaiting != ( UBaseType_t ) 0 )\r
2303                         {\r
2304                                 /* Cannot add a queue/semaphore to a queue set if there are already\r
2305                                 items in the queue/semaphore. */\r
2306                                 xReturn = pdFAIL;\r
2307                         }\r
2308                         else\r
2309                         {\r
2310                                 ( ( Queue_t * ) xQueueOrSemaphore )->pxQueueSetContainer = xQueueSet;\r
2311                                 xReturn = pdPASS;\r
2312                         }\r
2313                 }\r
2314                 taskEXIT_CRITICAL();\r
2315 \r
2316                 return xReturn;\r
2317         }\r
2318 \r
2319 #endif /* configUSE_QUEUE_SETS */\r
2320 /*-----------------------------------------------------------*/\r
2321 \r
2322 #if ( configUSE_QUEUE_SETS == 1 )\r
2323 \r
2324         BaseType_t xQueueRemoveFromSet( QueueSetMemberHandle_t xQueueOrSemaphore, QueueSetHandle_t xQueueSet )\r
2325         {\r
2326         BaseType_t xReturn;\r
2327         Queue_t * const pxQueueOrSemaphore = ( Queue_t * ) xQueueOrSemaphore;\r
2328 \r
2329                 if( pxQueueOrSemaphore->pxQueueSetContainer != xQueueSet )\r
2330                 {\r
2331                         /* The queue was not a member of the set. */\r
2332                         xReturn = pdFAIL;\r
2333                 }\r
2334                 else if( pxQueueOrSemaphore->uxMessagesWaiting != ( UBaseType_t ) 0 )\r
2335                 {\r
2336                         /* It is dangerous to remove a queue from a set when the queue is\r
2337                         not empty because the queue set will still hold pending events for\r
2338                         the queue. */\r
2339                         xReturn = pdFAIL;\r
2340                 }\r
2341                 else\r
2342                 {\r
2343                         taskENTER_CRITICAL();\r
2344                         {\r
2345                                 /* The queue is no longer contained in the set. */\r
2346                                 pxQueueOrSemaphore->pxQueueSetContainer = NULL;\r
2347                         }\r
2348                         taskEXIT_CRITICAL();\r
2349                         xReturn = pdPASS;\r
2350                 }\r
2351 \r
2352                 return xReturn;\r
2353         } /*lint !e818 xQueueSet could not be declared as pointing to const as it is a typedef. */\r
2354 \r
2355 #endif /* configUSE_QUEUE_SETS */\r
2356 /*-----------------------------------------------------------*/\r
2357 \r
2358 #if ( configUSE_QUEUE_SETS == 1 )\r
2359 \r
2360         QueueSetMemberHandle_t xQueueSelectFromSet( QueueSetHandle_t xQueueSet, TickType_t const xTicksToWait )\r
2361         {\r
2362         QueueSetMemberHandle_t xReturn = NULL;\r
2363 \r
2364                 ( void ) xQueueGenericReceive( ( QueueHandle_t ) xQueueSet, &xReturn, xTicksToWait, pdFALSE ); /*lint !e961 Casting from one typedef to another is not redundant. */\r
2365                 return xReturn;\r
2366         }\r
2367 \r
2368 #endif /* configUSE_QUEUE_SETS */\r
2369 /*-----------------------------------------------------------*/\r
2370 \r
2371 #if ( configUSE_QUEUE_SETS == 1 )\r
2372 \r
2373         QueueSetMemberHandle_t xQueueSelectFromSetFromISR( QueueSetHandle_t xQueueSet )\r
2374         {\r
2375         QueueSetMemberHandle_t xReturn = NULL;\r
2376 \r
2377                 ( void ) xQueueReceiveFromISR( ( QueueHandle_t ) xQueueSet, &xReturn, NULL ); /*lint !e961 Casting from one typedef to another is not redundant. */\r
2378                 return xReturn;\r
2379         }\r
2380 \r
2381 #endif /* configUSE_QUEUE_SETS */\r
2382 /*-----------------------------------------------------------*/\r
2383 \r
2384 #if ( configUSE_QUEUE_SETS == 1 )\r
2385 \r
2386         static BaseType_t prvNotifyQueueSetContainer( const Queue_t * const pxQueue, const BaseType_t xCopyPosition )\r
2387         {\r
2388         Queue_t *pxQueueSetContainer = pxQueue->pxQueueSetContainer;\r
2389         BaseType_t xReturn = pdFALSE;\r
2390 \r
2391                 /* This function must be called form a critical section. */\r
2392 \r
2393                 configASSERT( pxQueueSetContainer );\r
2394                 configASSERT( pxQueueSetContainer->uxMessagesWaiting < pxQueueSetContainer->uxLength );\r
2395 \r
2396                 if( pxQueueSetContainer->uxMessagesWaiting < pxQueueSetContainer->uxLength )\r
2397                 {\r
2398                         traceQUEUE_SEND( pxQueueSetContainer );\r
2399                         /* The data copied is the handle of the queue that contains data. */\r
2400                         xReturn = prvCopyDataToQueue( pxQueueSetContainer, &pxQueue, xCopyPosition );\r
2401 \r
2402                         if( listLIST_IS_EMPTY( &( pxQueueSetContainer->xTasksWaitingToReceive ) ) == pdFALSE )\r
2403                         {\r
2404                                 if( xTaskRemoveFromEventList( &( pxQueueSetContainer->xTasksWaitingToReceive ) ) != pdFALSE )\r
2405                                 {\r
2406                                         /* The task waiting has a higher priority */\r
2407                                         xReturn = pdTRUE;\r
2408                                 }\r
2409                                 else\r
2410                                 {\r
2411                                         mtCOVERAGE_TEST_MARKER();\r
2412                                 }\r
2413                         }\r
2414                         else\r
2415                         {\r
2416                                 mtCOVERAGE_TEST_MARKER();\r
2417                         }\r
2418                 }\r
2419                 else\r
2420                 {\r
2421                         mtCOVERAGE_TEST_MARKER();\r
2422                 }\r
2423 \r
2424                 return xReturn;\r
2425         }\r
2426 \r
2427 #endif /* configUSE_QUEUE_SETS */\r
2428 \r
2429 \r
2430 \r
2431 \r
2432 \r
2433 \r
2434 \r
2435 \r
2436 \r
2437 \r
2438 \r
2439 \r