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