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