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