]> git.sur5r.net Git - freertos/blob - FreeRTOS/Source/queue.c
Fix a few compiler warnings when compiling the QueueSet.c test code with GCC.
[freertos] / FreeRTOS / Source / queue.c
1 /*\r
2     FreeRTOS V7.3.0 - Copyright (C) 2012 Real Time Engineers Ltd.\r
3 \r
4     FEATURES AND PORTS ARE ADDED TO FREERTOS ALL THE TIME.  PLEASE VISIT\r
5     http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.\r
6 \r
7     ***************************************************************************\r
8      *                                                                       *\r
9      *    FreeRTOS tutorial books are available in pdf and paperback.        *\r
10      *    Complete, revised, and edited pdf reference manuals are also       *\r
11      *    available.                                                         *\r
12      *                                                                       *\r
13      *    Purchasing FreeRTOS documentation will not only help you, by       *\r
14      *    ensuring you get running as quickly as possible and with an        *\r
15      *    in-depth knowledge of how to use FreeRTOS, it will also help       *\r
16      *    the FreeRTOS project to continue with its mission of providing     *\r
17      *    professional grade, cross platform, de facto standard solutions    *\r
18      *    for microcontrollers - completely free of charge!                  *\r
19      *                                                                       *\r
20      *    >>> See http://www.FreeRTOS.org/Documentation for details. <<<     *\r
21      *                                                                       *\r
22      *    Thank you for using FreeRTOS, and thank you for your support!      *\r
23      *                                                                       *\r
24     ***************************************************************************\r
25 \r
26 \r
27     This file is part of the FreeRTOS distribution.\r
28 \r
29     FreeRTOS is free software; you can redistribute it and/or modify it under\r
30     the terms of the GNU General Public License (version 2) as published by the\r
31     Free Software Foundation AND MODIFIED BY the FreeRTOS exception.\r
32     >>>NOTE<<< The modification to the GPL is included to allow you to\r
33     distribute a combined work that includes FreeRTOS without being obliged to\r
34     provide the source code for proprietary components outside of the FreeRTOS\r
35     kernel.  FreeRTOS is distributed in the hope that it will be useful, but\r
36     WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY\r
37     or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for\r
38     more details. You should have received a copy of the GNU General Public\r
39     License and the FreeRTOS license exception along with FreeRTOS; if not it\r
40     can be viewed here: http://www.freertos.org/a00114.html and also obtained\r
41     by writing to Richard Barry, contact details for whom are available on the\r
42     FreeRTOS WEB site.\r
43 \r
44     1 tab == 4 spaces!\r
45 \r
46     ***************************************************************************\r
47      *                                                                       *\r
48      *    Having a problem?  Start by reading the FAQ "My application does   *\r
49      *    not run, what could be wrong?"                                     *\r
50      *                                                                       *\r
51      *    http://www.FreeRTOS.org/FAQHelp.html                               *\r
52      *                                                                       *\r
53     ***************************************************************************\r
54 \r
55 \r
56     http://www.FreeRTOS.org - Documentation, training, latest versions, license\r
57     and contact details.\r
58 \r
59     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
60     including FreeRTOS+Trace - an indispensable productivity tool.\r
61 \r
62     Real Time Engineers ltd license FreeRTOS to High Integrity Systems, who sell\r
63     the code with commercial support, indemnification, and middleware, under\r
64     the OpenRTOS brand: http://www.OpenRTOS.com.  High Integrity Systems also\r
65     provide a safety engineered and independently SIL3 certified version under\r
66     the SafeRTOS brand: http://www.SafeRTOS.com.\r
67 */\r
68 \r
69 #include <stdlib.h>\r
70 #include <string.h>\r
71 \r
72 /* Defining MPU_WRAPPERS_INCLUDED_FROM_API_FILE prevents task.h from redefining\r
73 all the API functions to use the MPU wrappers.  That should only be done when\r
74 task.h is included from an application file. */\r
75 #define MPU_WRAPPERS_INCLUDED_FROM_API_FILE\r
76 \r
77 #include "FreeRTOS.h"\r
78 #include "task.h"\r
79 \r
80 #if ( configUSE_CO_ROUTINES == 1 )\r
81         #include "croutine.h"\r
82 #endif\r
83 \r
84 #undef MPU_WRAPPERS_INCLUDED_FROM_API_FILE\r
85 \r
86 /* Constants used with the cRxLock and xTxLock structure members. */\r
87 #define queueUNLOCKED                                   ( ( signed portBASE_TYPE ) -1 )\r
88 #define queueLOCKED_UNMODIFIED                  ( ( signed portBASE_TYPE ) 0 )\r
89 \r
90 #define queueERRONEOUS_UNBLOCK                  ( -1 )\r
91 \r
92 /* For internal use only. */\r
93 #define queueSEND_TO_BACK                               ( 0 )\r
94 #define queueSEND_TO_FRONT                              ( 1 )\r
95 \r
96 /* Effectively make a union out of the xQUEUE structure. */\r
97 #define pxMutexHolder                                   pcTail\r
98 #define uxQueueType                                             pcHead\r
99 #define uxRecursiveCallCount                    pcReadFrom\r
100 #define queueQUEUE_IS_MUTEX                             NULL\r
101 \r
102 /* Semaphores do not actually store or copy data, so have an items size of\r
103 zero. */\r
104 #define queueSEMAPHORE_QUEUE_ITEM_LENGTH ( ( unsigned portBASE_TYPE ) 0 )\r
105 #define queueDONT_BLOCK                                  ( ( portTickType ) 0U )\r
106 #define queueMUTEX_GIVE_BLOCK_TIME               ( ( portTickType ) 0U )\r
107 \r
108 /* These definitions *must* match those in queue.h. */\r
109 #define queueQUEUE_TYPE_BASE                            ( 0U )\r
110 #define queueQUEUE_TYPE_MUTEX                           ( 1U )\r
111 #define queueQUEUE_TYPE_COUNTING_SEMAPHORE      ( 2U )\r
112 #define queueQUEUE_TYPE_BINARY_SEMAPHORE        ( 3U )\r
113 #define queueQUEUE_TYPE_RECURSIVE_MUTEX         ( 4U )\r
114 #define queueQUEUE_TYPE_SET                                     ( 5U )\r
115 \r
116 /*\r
117  * Definition of the queue used by the scheduler.\r
118  * Items are queued by copy, not reference.\r
119  */\r
120 typedef struct QueueDefinition\r
121 {\r
122         signed char *pcHead;                                    /*< Points to the beginning of the queue storage area. */\r
123         signed char *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
124 \r
125         signed char *pcWriteTo;                                 /*< Points to the free next place in the storage area. */\r
126         signed char *pcReadFrom;                                /*< Points to the last place that a queued item was read from. */\r
127 \r
128         xList xTasksWaitingToSend;                              /*< List of tasks that are blocked waiting to post onto this queue.  Stored in priority order. */\r
129         xList xTasksWaitingToReceive;                   /*< List of tasks that are blocked waiting to read from this queue.  Stored in priority order. */\r
130 \r
131         volatile unsigned portBASE_TYPE uxMessagesWaiting;/*< The number of items currently in the queue. */\r
132         unsigned portBASE_TYPE uxLength;                /*< The length of the queue defined as the number of items it will hold, not the number of bytes. */\r
133         unsigned portBASE_TYPE uxItemSize;              /*< The size of each items that the queue will hold. */\r
134 \r
135         volatile signed portBASE_TYPE 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
136         volatile signed portBASE_TYPE 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
137 \r
138         #if ( configUSE_TRACE_FACILITY == 1 )\r
139                 unsigned char ucQueueNumber;\r
140                 unsigned char ucQueueType;\r
141         #endif\r
142 \r
143         #if ( configUSE_QUEUE_SETS == 1 )\r
144                 struct QueueDefinition *pxQueueSetContainer;\r
145         #endif\r
146 \r
147 } xQUEUE;\r
148 /*-----------------------------------------------------------*/\r
149 \r
150 /*\r
151  * Inside this file xQueueHandle and xQueueSetHandle are both pointers to xQUEUE\r
152  * structures.  To keep the definition private the API header file defines both\r
153  * as pointers to void.\r
154  */\r
155 typedef xQUEUE * xQueueHandle;\r
156 typedef xQUEUE * xQueueSetHandle;\r
157 \r
158 /**\r
159  * Queue sets can contain both queues and semaphores, so the\r
160  * xQueueSetMemberHandle is defined as a type to be used where a parameter or\r
161  * return value can be either an xQueueHandle or an xSemaphoreHandle.\r
162  */\r
163 typedef xQUEUE * xQueueSetMemberHandle;\r
164 \r
165 /*\r
166  * In order to implement strict data hiding, the queue.h header file defines\r
167  * xQueueHandle and xQueueSetHandle as pointers to void.  In this file\r
168  * xQueueHandle and xQueueSetHandle are defined as pointers to xQUEUE objects.\r
169  * Therefore the queue.h header file cannot be included in this source file,\r
170  * and the function prototypes are provided directly.\r
171  */\r
172 xQueueHandle xQueueGenericCreate( unsigned portBASE_TYPE uxQueueLength, unsigned portBASE_TYPE uxItemSize, unsigned char ucQueueType ) PRIVILEGED_FUNCTION;\r
173 signed portBASE_TYPE xQueueGenericSend( xQueueHandle pxQueue, const void * const pvItemToQueue, portTickType xTicksToWait, portBASE_TYPE xCopyPosition ) PRIVILEGED_FUNCTION;\r
174 unsigned portBASE_TYPE uxQueueMessagesWaiting( const xQueueHandle pxQueue ) PRIVILEGED_FUNCTION;\r
175 void vQueueDelete( xQueueHandle xQueue ) PRIVILEGED_FUNCTION;\r
176 signed portBASE_TYPE xQueueGenericSendFromISR( xQueueHandle pxQueue, const void * const pvItemToQueue, signed portBASE_TYPE *pxHigherPriorityTaskWoken, portBASE_TYPE xCopyPosition ) PRIVILEGED_FUNCTION;\r
177 signed portBASE_TYPE xQueueGenericReceive( xQueueHandle pxQueue, void * const pvBuffer, portTickType xTicksToWait, portBASE_TYPE xJustPeeking ) PRIVILEGED_FUNCTION;\r
178 signed portBASE_TYPE xQueueReceiveFromISR( xQueueHandle pxQueue, void * const pvBuffer, signed portBASE_TYPE *pxHigherPriorityTaskWoken ) PRIVILEGED_FUNCTION;\r
179 xQueueHandle xQueueCreateMutex( unsigned char ucQueueType ) PRIVILEGED_FUNCTION;\r
180 xQueueHandle xQueueCreateCountingSemaphore( unsigned portBASE_TYPE uxCountValue, unsigned portBASE_TYPE uxInitialCount ) PRIVILEGED_FUNCTION;\r
181 portBASE_TYPE xQueueTakeMutexRecursive( xQueueHandle xMutex, portTickType xBlockTime ) PRIVILEGED_FUNCTION;\r
182 portBASE_TYPE xQueueGiveMutexRecursive( xQueueHandle xMutex ) PRIVILEGED_FUNCTION;\r
183 signed portBASE_TYPE xQueueAltGenericSend( xQueueHandle pxQueue, const void * const pvItemToQueue, portTickType xTicksToWait, portBASE_TYPE xCopyPosition ) PRIVILEGED_FUNCTION;\r
184 signed portBASE_TYPE xQueueAltGenericReceive( xQueueHandle pxQueue, void * const pvBuffer, portTickType xTicksToWait, portBASE_TYPE xJustPeeking ) PRIVILEGED_FUNCTION;\r
185 signed portBASE_TYPE xQueueIsQueueEmptyFromISR( const xQueueHandle pxQueue ) PRIVILEGED_FUNCTION;\r
186 signed portBASE_TYPE xQueueIsQueueFullFromISR( const xQueueHandle pxQueue ) PRIVILEGED_FUNCTION;\r
187 unsigned portBASE_TYPE uxQueueMessagesWaitingFromISR( const xQueueHandle pxQueue ) PRIVILEGED_FUNCTION;\r
188 void vQueueWaitForMessageRestricted( xQueueHandle pxQueue, portTickType xTicksToWait ) PRIVILEGED_FUNCTION;\r
189 unsigned char ucQueueGetQueueNumber( xQueueHandle pxQueue ) PRIVILEGED_FUNCTION;\r
190 void vQueueSetQueueNumber( xQueueHandle pxQueue, unsigned char ucQueueNumber ) PRIVILEGED_FUNCTION;\r
191 unsigned char ucQueueGetQueueType( xQueueHandle pxQueue ) PRIVILEGED_FUNCTION;\r
192 portBASE_TYPE xQueueGenericReset( xQueueHandle pxQueue, portBASE_TYPE xNewQueue ) PRIVILEGED_FUNCTION;\r
193 xTaskHandle xQueueGetMutexHolder( xQueueHandle xSemaphore ) PRIVILEGED_FUNCTION;\r
194 xQueueSetHandle xQueueSetCreate( unsigned portBASE_TYPE uxEventQueueLength ) PRIVILEGED_FUNCTION;\r
195 xQueueSetMemberHandle xQueueBlockMultiple( xQueueSetHandle xQueueSet, portTickType xBlockTimeTicks ) PRIVILEGED_FUNCTION;\r
196 portBASE_TYPE xQueueAddToQueueSet( xQueueSetMemberHandle xQueueOrSemaphore, xQueueSetHandle xQueueSet ) PRIVILEGED_FUNCTION;\r
197 portBASE_TYPE xQueueRemoveFromQueueSet( xQueueSetMemberHandle xQueueOrSemaphore, xQueueSetHandle xQueueSet ) PRIVILEGED_FUNCTION;\r
198 \r
199 /*\r
200  * Co-routine queue functions differ from task queue functions.  Co-routines are\r
201  * an optional component.\r
202  */\r
203 #if ( configUSE_CO_ROUTINES == 1 )\r
204         signed portBASE_TYPE xQueueCRSendFromISR( xQueueHandle pxQueue, const void *pvItemToQueue, signed portBASE_TYPE xCoRoutinePreviouslyWoken ) PRIVILEGED_FUNCTION;\r
205         signed portBASE_TYPE xQueueCRReceiveFromISR( xQueueHandle pxQueue, void *pvBuffer, signed portBASE_TYPE *pxTaskWoken ) PRIVILEGED_FUNCTION;\r
206         signed portBASE_TYPE xQueueCRSend( xQueueHandle pxQueue, const void *pvItemToQueue, portTickType xTicksToWait ) PRIVILEGED_FUNCTION;\r
207         signed portBASE_TYPE xQueueCRReceive( xQueueHandle pxQueue, void *pvBuffer, portTickType xTicksToWait ) PRIVILEGED_FUNCTION;\r
208 #endif\r
209 \r
210 /*\r
211  * The queue registry is just a means for kernel aware debuggers to locate\r
212  * queue structures.  It has no other purpose so is an optional component.\r
213  */\r
214 #if ( configQUEUE_REGISTRY_SIZE > 0 )\r
215 \r
216         /* The type stored within the queue registry array.  This allows a name\r
217         to be assigned to each queue making kernel aware debugging a little\r
218         more user friendly. */\r
219         typedef struct QUEUE_REGISTRY_ITEM\r
220         {\r
221                 signed char *pcQueueName;\r
222                 xQueueHandle xHandle;\r
223         } xQueueRegistryItem;\r
224 \r
225         /* The queue registry is simply an array of xQueueRegistryItem structures.\r
226         The pcQueueName member of a structure being NULL is indicative of the\r
227         array position being vacant. */\r
228         xQueueRegistryItem xQueueRegistry[ configQUEUE_REGISTRY_SIZE ];\r
229 \r
230         /* Removes a queue from the registry by simply setting the pcQueueName\r
231         member to NULL. */\r
232         static void vQueueUnregisterQueue( xQueueHandle xQueue ) PRIVILEGED_FUNCTION;\r
233         void vQueueAddToRegistry( xQueueHandle xQueue, signed char *pcQueueName ) PRIVILEGED_FUNCTION;\r
234 #endif\r
235 \r
236 /*\r
237  * Unlocks a queue locked by a call to prvLockQueue.  Locking a queue does not\r
238  * prevent an ISR from adding or removing items to the queue, but does prevent\r
239  * an ISR from removing tasks from the queue event lists.  If an ISR finds a\r
240  * queue is locked it will instead increment the appropriate queue lock count\r
241  * to indicate that a task may require unblocking.  When the queue in unlocked\r
242  * these lock counts are inspected, and the appropriate action taken.\r
243  */\r
244 static void prvUnlockQueue( xQueueHandle pxQueue ) PRIVILEGED_FUNCTION;\r
245 \r
246 /*\r
247  * Uses a critical section to determine if there is any data in a queue.\r
248  *\r
249  * @return pdTRUE if the queue contains no items, otherwise pdFALSE.\r
250  */\r
251 static signed portBASE_TYPE prvIsQueueEmpty( const xQueueHandle pxQueue ) PRIVILEGED_FUNCTION;\r
252 \r
253 /*\r
254  * Uses a critical section to determine if there is any space in a queue.\r
255  *\r
256  * @return pdTRUE if there is no space, otherwise pdFALSE;\r
257  */\r
258 static signed portBASE_TYPE prvIsQueueFull( const xQueueHandle pxQueue ) PRIVILEGED_FUNCTION;\r
259 \r
260 /*\r
261  * Copies an item into the queue, either at the front of the queue or the\r
262  * back of the queue.\r
263  */\r
264 static void prvCopyDataToQueue( xQUEUE *pxQueue, const void *pvItemToQueue, portBASE_TYPE xPosition ) PRIVILEGED_FUNCTION;\r
265 \r
266 /*\r
267  * Copies an item out of a queue.\r
268  */\r
269 static void prvCopyDataFromQueue( xQUEUE * const pxQueue, const void *pvBuffer ) PRIVILEGED_FUNCTION;\r
270 \r
271 #if ( configUSE_QUEUE_SETS == 1 )\r
272         /*\r
273          * Checks to see if a queue is a member of a queue set, and if so, notifies\r
274          * the queue set that the queue contains data.\r
275          */\r
276         static portBASE_TYPE prvNotifyQueueSetContainer( xQUEUE *pxQueue, portBASE_TYPE xCopyPosition );\r
277 #endif\r
278 \r
279 /*-----------------------------------------------------------*/\r
280 \r
281 /*\r
282  * Macro to mark a queue as locked.  Locking a queue prevents an ISR from\r
283  * accessing the queue event lists.\r
284  */\r
285 #define prvLockQueue( pxQueue )                                                         \\r
286         taskENTER_CRITICAL();                                                                   \\r
287         {                                                                                                               \\r
288                 if( ( pxQueue )->xRxLock == queueUNLOCKED )                     \\r
289                 {                                                                                                       \\r
290                         ( pxQueue )->xRxLock = queueLOCKED_UNMODIFIED;  \\r
291                 }                                                                                                       \\r
292                 if( ( pxQueue )->xTxLock == queueUNLOCKED )                     \\r
293                 {                                                                                                       \\r
294                         ( pxQueue )->xTxLock = queueLOCKED_UNMODIFIED;  \\r
295                 }                                                                                                       \\r
296         }                                                                                                               \\r
297         taskEXIT_CRITICAL()\r
298 /*-----------------------------------------------------------*/\r
299 \r
300 portBASE_TYPE xQueueGenericReset( xQueueHandle pxQueue, portBASE_TYPE xNewQueue )\r
301 {\r
302         configASSERT( pxQueue );\r
303 \r
304         taskENTER_CRITICAL();\r
305         {\r
306                 pxQueue->pcTail = pxQueue->pcHead + ( pxQueue->uxLength * pxQueue->uxItemSize );\r
307                 pxQueue->uxMessagesWaiting = ( unsigned portBASE_TYPE ) 0U;\r
308                 pxQueue->pcWriteTo = pxQueue->pcHead;\r
309                 pxQueue->pcReadFrom = pxQueue->pcHead + ( ( pxQueue->uxLength - ( unsigned portBASE_TYPE ) 1U ) * pxQueue->uxItemSize );\r
310                 pxQueue->xRxLock = queueUNLOCKED;\r
311                 pxQueue->xTxLock = queueUNLOCKED;\r
312 \r
313                 if( xNewQueue == pdFALSE )\r
314                 {\r
315                         /* If there are tasks blocked waiting to read from the queue, then\r
316                         the tasks will remain blocked as after this function exits the queue\r
317                         will still be empty.  If there are tasks blocked waiting to     write to\r
318                         the queue, then one should be unblocked as after this function exits\r
319                         it will be possible to write to it. */\r
320                         if( listLIST_IS_EMPTY( &( pxQueue->xTasksWaitingToSend ) ) == pdFALSE )\r
321                         {\r
322                                 if( xTaskRemoveFromEventList( &( pxQueue->xTasksWaitingToSend ) ) == pdTRUE )\r
323                                 {\r
324                                         portYIELD_WITHIN_API();\r
325                                 }\r
326                         }\r
327                 }\r
328                 else\r
329                 {\r
330                         /* Ensure the event queues start in the correct state. */\r
331                         vListInitialise( &( pxQueue->xTasksWaitingToSend ) );\r
332                         vListInitialise( &( pxQueue->xTasksWaitingToReceive ) );\r
333                 }\r
334         }\r
335         taskEXIT_CRITICAL();\r
336 \r
337         /* A value is returned for calling semantic consistency with previous\r
338         versions. */\r
339         return pdPASS;\r
340 }\r
341 /*-----------------------------------------------------------*/\r
342 \r
343 xQueueHandle xQueueGenericCreate( unsigned portBASE_TYPE uxQueueLength, unsigned portBASE_TYPE uxItemSize, unsigned char ucQueueType )\r
344 {\r
345 xQUEUE *pxNewQueue;\r
346 size_t xQueueSizeInBytes;\r
347 xQueueHandle xReturn = NULL;\r
348 \r
349         /* Remove compiler warnings about unused parameters should\r
350         configUSE_TRACE_FACILITY not be set to 1. */\r
351         ( void ) ucQueueType;\r
352 \r
353         /* Allocate the new queue structure. */\r
354         if( uxQueueLength > ( unsigned portBASE_TYPE ) 0 )\r
355         {\r
356                 pxNewQueue = ( xQUEUE * ) pvPortMalloc( sizeof( xQUEUE ) );\r
357                 if( pxNewQueue != NULL )\r
358                 {\r
359                         /* Create the list of pointers to queue items.  The queue is one byte\r
360                         longer than asked for to make wrap checking easier/faster. */\r
361                         xQueueSizeInBytes = ( size_t ) ( uxQueueLength * uxItemSize ) + ( size_t ) 1;\r
362 \r
363                         pxNewQueue->pcHead = ( signed char * ) pvPortMalloc( xQueueSizeInBytes );\r
364                         if( pxNewQueue->pcHead != NULL )\r
365                         {\r
366                                 /* Initialise the queue members as described above where the\r
367                                 queue type is defined. */\r
368                                 pxNewQueue->uxLength = uxQueueLength;\r
369                                 pxNewQueue->uxItemSize = uxItemSize;\r
370                                 xQueueGenericReset( pxNewQueue, pdTRUE );\r
371 \r
372                                 #if ( configUSE_TRACE_FACILITY == 1 )\r
373                                 {\r
374                                         pxNewQueue->ucQueueType = ucQueueType;\r
375                                 }\r
376                                 #endif /* configUSE_TRACE_FACILITY */\r
377 \r
378                                 #if( configUSE_QUEUE_SETS == 1 )\r
379                                 {\r
380                                         pxNewQueue->pxQueueSetContainer = NULL;\r
381                                 }\r
382                                 #endif /* configUSE_QUEUE_SETS */\r
383 \r
384                                 traceQUEUE_CREATE( pxNewQueue );\r
385                                 xReturn = pxNewQueue;\r
386                         }\r
387                         else\r
388                         {\r
389                                 traceQUEUE_CREATE_FAILED( ucQueueType );\r
390                                 vPortFree( pxNewQueue );\r
391                         }\r
392                 }\r
393         }\r
394 \r
395         configASSERT( xReturn );\r
396 \r
397         return xReturn;\r
398 }\r
399 /*-----------------------------------------------------------*/\r
400 \r
401 #if ( configUSE_MUTEXES == 1 )\r
402 \r
403         xQueueHandle xQueueCreateMutex( unsigned char ucQueueType )\r
404         {\r
405         xQUEUE *pxNewQueue;\r
406 \r
407                 /* Prevent compiler warnings about unused parameters if\r
408                 configUSE_TRACE_FACILITY does not equal 1. */\r
409                 ( void ) ucQueueType;\r
410 \r
411                 /* Allocate the new queue structure. */\r
412                 pxNewQueue = ( xQUEUE * ) pvPortMalloc( sizeof( xQUEUE ) );\r
413                 if( pxNewQueue != NULL )\r
414                 {\r
415                         /* Information required for priority inheritance. */\r
416                         pxNewQueue->pxMutexHolder = NULL;\r
417                         pxNewQueue->uxQueueType = queueQUEUE_IS_MUTEX;\r
418 \r
419                         /* Queues used as a mutex no data is actually copied into or out\r
420                         of the queue. */\r
421                         pxNewQueue->pcWriteTo = NULL;\r
422                         pxNewQueue->pcReadFrom = NULL;\r
423 \r
424                         /* Each mutex has a length of 1 (like a binary semaphore) and\r
425                         an item size of 0 as nothing is actually copied into or out\r
426                         of the mutex. */\r
427                         pxNewQueue->uxMessagesWaiting = ( unsigned portBASE_TYPE ) 0U;\r
428                         pxNewQueue->uxLength = ( unsigned portBASE_TYPE ) 1U;\r
429                         pxNewQueue->uxItemSize = ( unsigned portBASE_TYPE ) 0U;\r
430                         pxNewQueue->xRxLock = queueUNLOCKED;\r
431                         pxNewQueue->xTxLock = queueUNLOCKED;\r
432 \r
433                         #if ( configUSE_TRACE_FACILITY == 1 )\r
434                         {\r
435                                 pxNewQueue->ucQueueType = ucQueueType;\r
436                         }\r
437                         #endif\r
438 \r
439                         #if ( configUSE_QUEUE_SETS == 1 )\r
440                         {\r
441                                 pxNewQueue->pxQueueSetContainer = NULL;\r
442                         }\r
443                         #endif\r
444 \r
445                         /* Ensure the event queues start with the correct state. */\r
446                         vListInitialise( &( pxNewQueue->xTasksWaitingToSend ) );\r
447                         vListInitialise( &( pxNewQueue->xTasksWaitingToReceive ) );\r
448 \r
449                         traceCREATE_MUTEX( pxNewQueue );\r
450 \r
451                         /* Start with the semaphore in the expected state. */\r
452                         xQueueGenericSend( pxNewQueue, NULL, ( portTickType ) 0U, queueSEND_TO_BACK );\r
453                 }\r
454                 else\r
455                 {\r
456                         traceCREATE_MUTEX_FAILED();\r
457                 }\r
458 \r
459                 configASSERT( pxNewQueue );\r
460                 return pxNewQueue;\r
461         }\r
462 \r
463 #endif /* configUSE_MUTEXES */\r
464 /*-----------------------------------------------------------*/\r
465 \r
466 #if ( ( configUSE_MUTEXES == 1 ) && ( INCLUDE_xSemaphoreGetMutexHolder == 1 ) )\r
467 \r
468         void* xQueueGetMutexHolder( xQueueHandle xSemaphore )\r
469         {\r
470         void *pxReturn;\r
471 \r
472                 /* This function is called by xSemaphoreGetMutexHolder(), and should not\r
473                 be called directly.  Note:  This is is a good way of determining if the\r
474                 calling task is the mutex holder, but not a good way of determining the\r
475                 identity of the mutex holder, as the holder may change between the\r
476                 following critical section exiting and the function returning. */\r
477                 taskENTER_CRITICAL();\r
478                 {\r
479                         if( xSemaphore->uxQueueType == queueQUEUE_IS_MUTEX )\r
480                         {\r
481                                 pxReturn = ( void * ) xSemaphore->pxMutexHolder;\r
482                         }\r
483                         else\r
484                         {\r
485                                 pxReturn = NULL;\r
486                         }\r
487                 }\r
488                 taskEXIT_CRITICAL();\r
489 \r
490                 return pxReturn;\r
491         }\r
492 \r
493 #endif\r
494 /*-----------------------------------------------------------*/\r
495 \r
496 #if ( configUSE_RECURSIVE_MUTEXES == 1 )\r
497 \r
498         portBASE_TYPE xQueueGiveMutexRecursive( xQueueHandle pxMutex )\r
499         {\r
500         portBASE_TYPE xReturn;\r
501 \r
502                 configASSERT( pxMutex );\r
503 \r
504                 /* If this is the task that holds the mutex then pxMutexHolder will not\r
505                 change outside of this task.  If this task does not hold the mutex then\r
506                 pxMutexHolder can never coincidentally equal the tasks handle, and as\r
507                 this is the only condition we are interested in it does not matter if\r
508                 pxMutexHolder is accessed simultaneously by another task.  Therefore no\r
509                 mutual exclusion is required to test the pxMutexHolder variable. */\r
510                 if( pxMutex->pxMutexHolder == xTaskGetCurrentTaskHandle() )\r
511                 {\r
512                         traceGIVE_MUTEX_RECURSIVE( pxMutex );\r
513 \r
514                         /* uxRecursiveCallCount cannot be zero if pxMutexHolder is equal to\r
515                         the task handle, therefore no underflow check is required.  Also,\r
516                         uxRecursiveCallCount is only modified by the mutex holder, and as\r
517                         there can only be one, no mutual exclusion is required to modify the\r
518                         uxRecursiveCallCount member. */\r
519                         ( pxMutex->uxRecursiveCallCount )--;\r
520 \r
521                         /* Have we unwound the call count? */\r
522                         if( pxMutex->uxRecursiveCallCount == 0 )\r
523                         {\r
524                                 /* Return the mutex.  This will automatically unblock any other\r
525                                 task that might be waiting to access the mutex. */\r
526                                 xQueueGenericSend( pxMutex, NULL, queueMUTEX_GIVE_BLOCK_TIME, queueSEND_TO_BACK );\r
527                         }\r
528 \r
529                         xReturn = pdPASS;\r
530                 }\r
531                 else\r
532                 {\r
533                         /* We cannot give the mutex because we are not the holder. */\r
534                         xReturn = pdFAIL;\r
535 \r
536                         traceGIVE_MUTEX_RECURSIVE_FAILED( pxMutex );\r
537                 }\r
538 \r
539                 return xReturn;\r
540         }\r
541 \r
542 #endif /* configUSE_RECURSIVE_MUTEXES */\r
543 /*-----------------------------------------------------------*/\r
544 \r
545 #if ( configUSE_RECURSIVE_MUTEXES == 1 )\r
546 \r
547         portBASE_TYPE xQueueTakeMutexRecursive( xQueueHandle pxMutex, portTickType xBlockTime )\r
548         {\r
549         portBASE_TYPE xReturn;\r
550 \r
551                 configASSERT( pxMutex );\r
552 \r
553                 /* Comments regarding mutual exclusion as per those within\r
554                 xQueueGiveMutexRecursive(). */\r
555 \r
556                 traceTAKE_MUTEX_RECURSIVE( pxMutex );\r
557 \r
558                 if( pxMutex->pxMutexHolder == xTaskGetCurrentTaskHandle() )\r
559                 {\r
560                         ( pxMutex->uxRecursiveCallCount )++;\r
561                         xReturn = pdPASS;\r
562                 }\r
563                 else\r
564                 {\r
565                         xReturn = xQueueGenericReceive( pxMutex, NULL, xBlockTime, pdFALSE );\r
566 \r
567                         /* pdPASS will only be returned if we successfully obtained the mutex,\r
568                         we may have blocked to reach here. */\r
569                         if( xReturn == pdPASS )\r
570                         {\r
571                                 ( pxMutex->uxRecursiveCallCount )++;\r
572                         }\r
573                         else\r
574                         {\r
575                                 traceTAKE_MUTEX_RECURSIVE_FAILED( pxMutex );\r
576                         }\r
577                 }\r
578 \r
579                 return xReturn;\r
580         }\r
581 \r
582 #endif /* configUSE_RECURSIVE_MUTEXES */\r
583 /*-----------------------------------------------------------*/\r
584 \r
585 #if ( configUSE_COUNTING_SEMAPHORES == 1 )\r
586 \r
587         xQueueHandle xQueueCreateCountingSemaphore( unsigned portBASE_TYPE uxCountValue, unsigned portBASE_TYPE uxInitialCount )\r
588         {\r
589         xQueueHandle pxHandle;\r
590 \r
591                 pxHandle = xQueueGenericCreate( ( unsigned portBASE_TYPE ) uxCountValue, queueSEMAPHORE_QUEUE_ITEM_LENGTH, queueQUEUE_TYPE_COUNTING_SEMAPHORE );\r
592 \r
593                 if( pxHandle != NULL )\r
594                 {\r
595                         pxHandle->uxMessagesWaiting = uxInitialCount;\r
596 \r
597                         traceCREATE_COUNTING_SEMAPHORE();\r
598                 }\r
599                 else\r
600                 {\r
601                         traceCREATE_COUNTING_SEMAPHORE_FAILED();\r
602                 }\r
603 \r
604                 configASSERT( pxHandle );\r
605                 return pxHandle;\r
606         }\r
607 \r
608 #endif /* configUSE_COUNTING_SEMAPHORES */\r
609 /*-----------------------------------------------------------*/\r
610 \r
611 signed portBASE_TYPE xQueueGenericSend( xQueueHandle pxQueue, const void * const pvItemToQueue, portTickType xTicksToWait, portBASE_TYPE xCopyPosition )\r
612 {\r
613 signed portBASE_TYPE xEntryTimeSet = pdFALSE;\r
614 xTimeOutType xTimeOut;\r
615 \r
616         configASSERT( pxQueue );\r
617         configASSERT( !( ( pvItemToQueue == NULL ) && ( pxQueue->uxItemSize != ( unsigned portBASE_TYPE ) 0U ) ) );\r
618 \r
619         /* This function relaxes the coding standard somewhat to allow return\r
620         statements within the function itself.  This is done in the interest\r
621         of execution time efficiency. */\r
622         for( ;; )\r
623         {\r
624                 taskENTER_CRITICAL();\r
625                 {\r
626                         /* Is there room on the queue now?  To be running we must be\r
627                         the highest priority task wanting to access the queue. */\r
628                         if( pxQueue->uxMessagesWaiting < pxQueue->uxLength )\r
629                         {\r
630                                 traceQUEUE_SEND( pxQueue );\r
631                                 prvCopyDataToQueue( pxQueue, pvItemToQueue, xCopyPosition );\r
632 \r
633                                 /* If there was a task waiting for data to arrive on the\r
634                                 queue then unblock it now. */\r
635                                 if( listLIST_IS_EMPTY( &( pxQueue->xTasksWaitingToReceive ) ) == pdFALSE )\r
636                                 {\r
637                                         if( xTaskRemoveFromEventList( &( pxQueue->xTasksWaitingToReceive ) ) == pdTRUE )\r
638                                         {\r
639                                                 /* The unblocked task has a priority higher than\r
640                                                 our own so yield immediately.  Yes it is ok to do\r
641                                                 this from within the critical section - the kernel\r
642                                                 takes care of that. */\r
643                                                 portYIELD_WITHIN_API();\r
644                                         }\r
645                                 }\r
646                                 else\r
647                                 {\r
648                                         #if ( configUSE_QUEUE_SETS == 1 )\r
649                                         {\r
650                                                 if( pxQueue->pxQueueSetContainer != NULL )\r
651                                                 {\r
652                                                         if( prvNotifyQueueSetContainer( pxQueue, xCopyPosition ) == pdTRUE )\r
653                                                         {\r
654                                                                 /* The queue is a member of a queue set, and posting to\r
655                                                                 the queue set caused a higher priority task to unblock.\r
656                                                                 A context switch is required. */\r
657                                                                 portYIELD_WITHIN_API();\r
658                                                         }\r
659                                                 }\r
660                                         }\r
661                                         #endif /* configUSE_QUEUE_SETS */\r
662                                 }\r
663 \r
664                                 taskEXIT_CRITICAL();\r
665 \r
666                                 /* Return to the original privilege level before exiting the\r
667                                 function. */\r
668                                 return pdPASS;\r
669                         }\r
670                         else\r
671                         {\r
672                                 if( xTicksToWait == ( portTickType ) 0 )\r
673                                 {\r
674                                         /* The queue was full and no block time is specified (or\r
675                                         the block time has expired) so leave now. */\r
676                                         taskEXIT_CRITICAL();\r
677 \r
678                                         /* Return to the original privilege level before exiting\r
679                                         the function. */\r
680                                         traceQUEUE_SEND_FAILED( pxQueue );\r
681                                         return errQUEUE_FULL;\r
682                                 }\r
683                                 else if( xEntryTimeSet == pdFALSE )\r
684                                 {\r
685                                         /* The queue was full and a block time was specified so\r
686                                         configure the timeout structure. */\r
687                                         vTaskSetTimeOutState( &xTimeOut );\r
688                                         xEntryTimeSet = pdTRUE;\r
689                                 }\r
690                         }\r
691                 }\r
692                 taskEXIT_CRITICAL();\r
693 \r
694                 /* Interrupts and other tasks can send to and receive from the queue\r
695                 now the critical section has been exited. */\r
696 \r
697                 vTaskSuspendAll();\r
698                 prvLockQueue( pxQueue );\r
699 \r
700                 /* Update the timeout state to see if it has expired yet. */\r
701                 if( xTaskCheckForTimeOut( &xTimeOut, &xTicksToWait ) == pdFALSE )\r
702                 {\r
703                         if( prvIsQueueFull( pxQueue ) != pdFALSE )\r
704                         {\r
705                                 traceBLOCKING_ON_QUEUE_SEND( pxQueue );\r
706                                 vTaskPlaceOnEventList( &( pxQueue->xTasksWaitingToSend ), xTicksToWait );\r
707 \r
708                                 /* Unlocking the queue means queue events can effect the\r
709                                 event list.  It is possible     that interrupts occurring now\r
710                                 remove this task from the event list again - but as the\r
711                                 scheduler is suspended the task will go onto the pending\r
712                                 ready last instead of the actual ready list. */\r
713                                 prvUnlockQueue( pxQueue );\r
714 \r
715                                 /* Resuming the scheduler will move tasks from the pending\r
716                                 ready list into the ready list - so it is feasible that this\r
717                                 task is already in a ready list before it yields - in which\r
718                                 case the yield will not cause a context switch unless there\r
719                                 is also a higher priority task in the pending ready list. */\r
720                                 if( xTaskResumeAll() == pdFALSE )\r
721                                 {\r
722                                         portYIELD_WITHIN_API();\r
723                                 }\r
724                         }\r
725                         else\r
726                         {\r
727                                 /* Try again. */\r
728                                 prvUnlockQueue( pxQueue );\r
729                                 ( void ) xTaskResumeAll();\r
730                         }\r
731                 }\r
732                 else\r
733                 {\r
734                         /* The timeout has expired. */\r
735                         prvUnlockQueue( pxQueue );\r
736                         ( void ) xTaskResumeAll();\r
737 \r
738                         /* Return to the original privilege level before exiting the\r
739                         function. */\r
740                         traceQUEUE_SEND_FAILED( pxQueue );\r
741                         return errQUEUE_FULL;\r
742                 }\r
743         }\r
744 }\r
745 /*-----------------------------------------------------------*/\r
746 \r
747 #if ( configUSE_ALTERNATIVE_API == 1 )\r
748 \r
749         signed portBASE_TYPE xQueueAltGenericSend( xQueueHandle pxQueue, const void * const pvItemToQueue, portTickType xTicksToWait, portBASE_TYPE xCopyPosition )\r
750         {\r
751         signed portBASE_TYPE xEntryTimeSet = pdFALSE;\r
752         xTimeOutType xTimeOut;\r
753 \r
754                 configASSERT( pxQueue );\r
755                 configASSERT( !( ( pvItemToQueue == NULL ) && ( pxQueue->uxItemSize != ( unsigned portBASE_TYPE ) 0U ) ) );\r
756 \r
757                 for( ;; )\r
758                 {\r
759                         taskENTER_CRITICAL();\r
760                         {\r
761                                 /* Is there room on the queue now?  To be running we must be\r
762                                 the highest priority task wanting to access the queue. */\r
763                                 if( pxQueue->uxMessagesWaiting < pxQueue->uxLength )\r
764                                 {\r
765                                         traceQUEUE_SEND( pxQueue );\r
766                                         prvCopyDataToQueue( pxQueue, pvItemToQueue, xCopyPosition );\r
767 \r
768                                         /* If there was a task waiting for data to arrive on the\r
769                                         queue then unblock it now. */\r
770                                         if( listLIST_IS_EMPTY( &( pxQueue->xTasksWaitingToReceive ) ) == pdFALSE )\r
771                                         {\r
772                                                 if( xTaskRemoveFromEventList( &( pxQueue->xTasksWaitingToReceive ) ) == pdTRUE )\r
773                                                 {\r
774                                                         /* The unblocked task has a priority higher than\r
775                                                         our own so yield immediately. */\r
776                                                         portYIELD_WITHIN_API();\r
777                                                 }\r
778                                         }\r
779 \r
780                                         taskEXIT_CRITICAL();\r
781                                         return pdPASS;\r
782                                 }\r
783                                 else\r
784                                 {\r
785                                         if( xTicksToWait == ( portTickType ) 0 )\r
786                                         {\r
787                                                 taskEXIT_CRITICAL();\r
788                                                 return errQUEUE_FULL;\r
789                                         }\r
790                                         else if( xEntryTimeSet == pdFALSE )\r
791                                         {\r
792                                                 vTaskSetTimeOutState( &xTimeOut );\r
793                                                 xEntryTimeSet = pdTRUE;\r
794                                         }\r
795                                 }\r
796                         }\r
797                         taskEXIT_CRITICAL();\r
798 \r
799                         taskENTER_CRITICAL();\r
800                         {\r
801                                 if( xTaskCheckForTimeOut( &xTimeOut, &xTicksToWait ) == pdFALSE )\r
802                                 {\r
803                                         if( prvIsQueueFull( pxQueue ) != pdFALSE )\r
804                                         {\r
805                                                 traceBLOCKING_ON_QUEUE_SEND( pxQueue );\r
806                                                 vTaskPlaceOnEventList( &( pxQueue->xTasksWaitingToSend ), xTicksToWait );\r
807                                                 portYIELD_WITHIN_API();\r
808                                         }\r
809                                 }\r
810                                 else\r
811                                 {\r
812                                         taskEXIT_CRITICAL();\r
813                                         traceQUEUE_SEND_FAILED( pxQueue );\r
814                                         return errQUEUE_FULL;\r
815                                 }\r
816                         }\r
817                         taskEXIT_CRITICAL();\r
818                 }\r
819         }\r
820 \r
821 #endif /* configUSE_ALTERNATIVE_API */\r
822 /*-----------------------------------------------------------*/\r
823 \r
824 #if ( configUSE_ALTERNATIVE_API == 1 )\r
825 \r
826         signed portBASE_TYPE xQueueAltGenericReceive( xQueueHandle pxQueue, void * const pvBuffer, portTickType xTicksToWait, portBASE_TYPE xJustPeeking )\r
827         {\r
828         signed portBASE_TYPE xEntryTimeSet = pdFALSE;\r
829         xTimeOutType xTimeOut;\r
830         signed char *pcOriginalReadPosition;\r
831 \r
832                 configASSERT( pxQueue );\r
833                 configASSERT( !( ( pvBuffer == NULL ) && ( pxQueue->uxItemSize != ( unsigned portBASE_TYPE ) 0U ) ) );\r
834 \r
835                 for( ;; )\r
836                 {\r
837                         taskENTER_CRITICAL();\r
838                         {\r
839                                 if( pxQueue->uxMessagesWaiting > ( unsigned portBASE_TYPE ) 0 )\r
840                                 {\r
841                                         /* Remember our read position in case we are just peeking. */\r
842                                         pcOriginalReadPosition = pxQueue->pcReadFrom;\r
843 \r
844                                         prvCopyDataFromQueue( pxQueue, pvBuffer );\r
845 \r
846                                         if( xJustPeeking == pdFALSE )\r
847                                         {\r
848                                                 traceQUEUE_RECEIVE( pxQueue );\r
849 \r
850                                                 /* We are actually removing data. */\r
851                                                 --( pxQueue->uxMessagesWaiting );\r
852 \r
853                                                 #if ( configUSE_MUTEXES == 1 )\r
854                                                 {\r
855                                                         if( pxQueue->uxQueueType == queueQUEUE_IS_MUTEX )\r
856                                                         {\r
857                                                                 /* Record the information required to implement\r
858                                                                 priority inheritance should it become necessary. */\r
859                                                                 pxQueue->pxMutexHolder = xTaskGetCurrentTaskHandle();\r
860                                                         }\r
861                                                 }\r
862                                                 #endif\r
863 \r
864                                                 if( listLIST_IS_EMPTY( &( pxQueue->xTasksWaitingToSend ) ) == pdFALSE )\r
865                                                 {\r
866                                                         if( xTaskRemoveFromEventList( &( pxQueue->xTasksWaitingToSend ) ) == pdTRUE )\r
867                                                         {\r
868                                                                 portYIELD_WITHIN_API();\r
869                                                         }\r
870                                                 }\r
871                                         }\r
872                                         else\r
873                                         {\r
874                                                 traceQUEUE_PEEK( pxQueue );\r
875 \r
876                                                 /* We are not removing the data, so reset our read\r
877                                                 pointer. */\r
878                                                 pxQueue->pcReadFrom = pcOriginalReadPosition;\r
879 \r
880                                                 /* The data is being left in the queue, so see if there are\r
881                                                 any other tasks waiting for the data. */\r
882                                                 if( listLIST_IS_EMPTY( &( pxQueue->xTasksWaitingToReceive ) ) == pdFALSE )\r
883                                                 {\r
884                                                         /* Tasks that are removed from the event list will get added to\r
885                                                         the pending ready list as the scheduler is still suspended. */\r
886                                                         if( xTaskRemoveFromEventList( &( pxQueue->xTasksWaitingToReceive ) ) != pdFALSE )\r
887                                                         {\r
888                                                                 /* The task waiting has a higher priority than this task. */\r
889                                                                 portYIELD_WITHIN_API();\r
890                                                         }\r
891                                                 }\r
892 \r
893                                         }\r
894 \r
895                                         taskEXIT_CRITICAL();\r
896                                         return pdPASS;\r
897                                 }\r
898                                 else\r
899                                 {\r
900                                         if( xTicksToWait == ( portTickType ) 0 )\r
901                                         {\r
902                                                 taskEXIT_CRITICAL();\r
903                                                 traceQUEUE_RECEIVE_FAILED( pxQueue );\r
904                                                 return errQUEUE_EMPTY;\r
905                                         }\r
906                                         else if( xEntryTimeSet == pdFALSE )\r
907                                         {\r
908                                                 vTaskSetTimeOutState( &xTimeOut );\r
909                                                 xEntryTimeSet = pdTRUE;\r
910                                         }\r
911                                 }\r
912                         }\r
913                         taskEXIT_CRITICAL();\r
914 \r
915                         taskENTER_CRITICAL();\r
916                         {\r
917                                 if( xTaskCheckForTimeOut( &xTimeOut, &xTicksToWait ) == pdFALSE )\r
918                                 {\r
919                                         if( prvIsQueueEmpty( pxQueue ) != pdFALSE )\r
920                                         {\r
921                                                 traceBLOCKING_ON_QUEUE_RECEIVE( pxQueue );\r
922 \r
923                                                 #if ( configUSE_MUTEXES == 1 )\r
924                                                 {\r
925                                                         if( pxQueue->uxQueueType == queueQUEUE_IS_MUTEX )\r
926                                                         {\r
927                                                                 portENTER_CRITICAL();\r
928                                                                 {\r
929                                                                         vTaskPriorityInherit( ( void * ) pxQueue->pxMutexHolder );\r
930                                                                 }\r
931                                                                 portEXIT_CRITICAL();\r
932                                                         }\r
933                                                 }\r
934                                                 #endif\r
935 \r
936                                                 vTaskPlaceOnEventList( &( pxQueue->xTasksWaitingToReceive ), xTicksToWait );\r
937                                                 portYIELD_WITHIN_API();\r
938                                         }\r
939                                 }\r
940                                 else\r
941                                 {\r
942                                         taskEXIT_CRITICAL();\r
943                                         traceQUEUE_RECEIVE_FAILED( pxQueue );\r
944                                         return errQUEUE_EMPTY;\r
945                                 }\r
946                         }\r
947                         taskEXIT_CRITICAL();\r
948                 }\r
949         }\r
950 \r
951 \r
952 #endif /* configUSE_ALTERNATIVE_API */\r
953 /*-----------------------------------------------------------*/\r
954 \r
955 signed portBASE_TYPE xQueueGenericSendFromISR( xQueueHandle pxQueue, const void * const pvItemToQueue, signed portBASE_TYPE *pxHigherPriorityTaskWoken, portBASE_TYPE xCopyPosition )\r
956 {\r
957 signed portBASE_TYPE xReturn;\r
958 unsigned portBASE_TYPE uxSavedInterruptStatus;\r
959 \r
960         configASSERT( pxQueue );\r
961         configASSERT( !( ( pvItemToQueue == NULL ) && ( pxQueue->uxItemSize != ( unsigned portBASE_TYPE ) 0U ) ) );\r
962 \r
963         /* Similar to xQueueGenericSend, except we don't block if there is no room\r
964         in the queue.  Also we don't directly wake a task that was blocked on a\r
965         queue read, instead we return a flag to say whether a context switch is\r
966         required or not (i.e. has a task with a higher priority than us been woken\r
967         by this post). */\r
968         uxSavedInterruptStatus = portSET_INTERRUPT_MASK_FROM_ISR();\r
969         {\r
970                 if( pxQueue->uxMessagesWaiting < pxQueue->uxLength )\r
971                 {\r
972                         traceQUEUE_SEND_FROM_ISR( pxQueue );\r
973 \r
974                         prvCopyDataToQueue( pxQueue, pvItemToQueue, xCopyPosition );\r
975 \r
976                         /* If the queue is locked we do not alter the event list.  This will\r
977                         be done when the queue is unlocked later. */\r
978                         if( pxQueue->xTxLock == queueUNLOCKED )\r
979                         {\r
980                                 if( listLIST_IS_EMPTY( &( pxQueue->xTasksWaitingToReceive ) ) == pdFALSE )\r
981                                 {\r
982                                         if( xTaskRemoveFromEventList( &( pxQueue->xTasksWaitingToReceive ) ) != pdFALSE )\r
983                                         {\r
984                                                 /* The task waiting has a higher priority so record that a\r
985                                                 context switch is required. */\r
986                                                 if( pxHigherPriorityTaskWoken != NULL )\r
987                                                 {\r
988                                                         *pxHigherPriorityTaskWoken = pdTRUE;\r
989                                                 }\r
990                                         }\r
991                                 }\r
992                                 else\r
993                                 {\r
994                                         #if ( configUSE_QUEUE_SETS == 1 )\r
995                                         {\r
996                                                 if( pxQueue->pxQueueSetContainer != NULL )\r
997                                                 {\r
998                                                         if( prvNotifyQueueSetContainer( pxQueue, xCopyPosition ) == pdTRUE )\r
999                                                         {\r
1000                                                                 /* The queue is a member of a queue set, and posting\r
1001                                                                 to the queue set caused a higher priority task to\r
1002                                                                 unblock.  A context switch is required. */\r
1003                                                                 if( pxHigherPriorityTaskWoken != NULL )\r
1004                                                                 {\r
1005                                                                         *pxHigherPriorityTaskWoken = pdTRUE;\r
1006                                                                 }\r
1007                                                         }\r
1008                                                 }\r
1009                                         }\r
1010                                         #endif /* configUSE_QUEUE_SETS */\r
1011                                 }\r
1012                         }\r
1013                         else\r
1014                         {\r
1015                                 /* Increment the lock count so the task that unlocks the queue\r
1016                                 knows that data was posted while it was locked. */\r
1017                                 ++( pxQueue->xTxLock );\r
1018                         }\r
1019 \r
1020                         xReturn = pdPASS;\r
1021                 }\r
1022                 else\r
1023                 {\r
1024                         traceQUEUE_SEND_FROM_ISR_FAILED( pxQueue );\r
1025                         xReturn = errQUEUE_FULL;\r
1026                 }\r
1027         }\r
1028         portCLEAR_INTERRUPT_MASK_FROM_ISR( uxSavedInterruptStatus );\r
1029 \r
1030         return xReturn;\r
1031 }\r
1032 /*-----------------------------------------------------------*/\r
1033 \r
1034 signed portBASE_TYPE xQueueGenericReceive( xQueueHandle pxQueue, void * const pvBuffer, portTickType xTicksToWait, portBASE_TYPE xJustPeeking )\r
1035 {\r
1036 signed portBASE_TYPE xEntryTimeSet = pdFALSE;\r
1037 xTimeOutType xTimeOut;\r
1038 signed char *pcOriginalReadPosition;\r
1039 \r
1040         configASSERT( pxQueue );\r
1041         configASSERT( !( ( pvBuffer == NULL ) && ( pxQueue->uxItemSize != ( unsigned portBASE_TYPE ) 0U ) ) );\r
1042 \r
1043         /* This function relaxes the coding standard somewhat to allow return\r
1044         statements within the function itself.  This is done in the interest\r
1045         of execution time efficiency. */\r
1046 \r
1047         for( ;; )\r
1048         {\r
1049                 taskENTER_CRITICAL();\r
1050                 {\r
1051                         /* Is there data in the queue now?  To be running we must be\r
1052                         the highest priority task wanting to access the queue. */\r
1053                         if( pxQueue->uxMessagesWaiting > ( unsigned portBASE_TYPE ) 0 )\r
1054                         {\r
1055                                 /* Remember our read position in case we are just peeking. */\r
1056                                 pcOriginalReadPosition = pxQueue->pcReadFrom;\r
1057 \r
1058                                 prvCopyDataFromQueue( pxQueue, pvBuffer );\r
1059 \r
1060                                 if( xJustPeeking == pdFALSE )\r
1061                                 {\r
1062                                         traceQUEUE_RECEIVE( pxQueue );\r
1063 \r
1064                                         /* We are actually removing data. */\r
1065                                         --( pxQueue->uxMessagesWaiting );\r
1066 \r
1067                                         #if ( configUSE_MUTEXES == 1 )\r
1068                                         {\r
1069                                                 if( pxQueue->uxQueueType == queueQUEUE_IS_MUTEX )\r
1070                                                 {\r
1071                                                         /* Record the information required to implement\r
1072                                                         priority inheritance should it become necessary. */\r
1073                                                         pxQueue->pxMutexHolder = xTaskGetCurrentTaskHandle();\r
1074                                                 }\r
1075                                         }\r
1076                                         #endif\r
1077 \r
1078                                         if( listLIST_IS_EMPTY( &( pxQueue->xTasksWaitingToSend ) ) == pdFALSE )\r
1079                                         {\r
1080                                                 if( xTaskRemoveFromEventList( &( pxQueue->xTasksWaitingToSend ) ) == pdTRUE )\r
1081                                                 {\r
1082                                                         portYIELD_WITHIN_API();\r
1083                                                 }\r
1084                                         }\r
1085                                 }\r
1086                                 else\r
1087                                 {\r
1088                                         traceQUEUE_PEEK( pxQueue );\r
1089 \r
1090                                         /* The data is not being removed, so reset the read\r
1091                                         pointer. */\r
1092                                         pxQueue->pcReadFrom = pcOriginalReadPosition;\r
1093 \r
1094                                         /* The data is being left in the queue, so see if there are\r
1095                                         any other tasks waiting for the data. */\r
1096                                         if( listLIST_IS_EMPTY( &( pxQueue->xTasksWaitingToReceive ) ) == pdFALSE )\r
1097                                         {\r
1098                                                 /* Tasks that are removed from the event list will get added to\r
1099                                                 the pending ready list as the scheduler is still suspended. */\r
1100                                                 if( xTaskRemoveFromEventList( &( pxQueue->xTasksWaitingToReceive ) ) != pdFALSE )\r
1101                                                 {\r
1102                                                         /* The task waiting has a higher priority than this task. */\r
1103                                                         portYIELD_WITHIN_API();\r
1104                                                 }\r
1105                                         }\r
1106                                 }\r
1107 \r
1108                                 taskEXIT_CRITICAL();\r
1109                                 return pdPASS;\r
1110                         }\r
1111                         else\r
1112                         {\r
1113                                 if( xTicksToWait == ( portTickType ) 0 )\r
1114                                 {\r
1115                                         /* The queue was empty and no block time is specified (or\r
1116                                         the block time has expired) so leave now. */\r
1117                                         taskEXIT_CRITICAL();\r
1118                                         traceQUEUE_RECEIVE_FAILED( pxQueue );\r
1119                                         return errQUEUE_EMPTY;\r
1120                                 }\r
1121                                 else if( xEntryTimeSet == pdFALSE )\r
1122                                 {\r
1123                                         /* The queue was empty and a block time was specified so\r
1124                                         configure the timeout structure. */\r
1125                                         vTaskSetTimeOutState( &xTimeOut );\r
1126                                         xEntryTimeSet = pdTRUE;\r
1127                                 }\r
1128                         }\r
1129                 }\r
1130                 taskEXIT_CRITICAL();\r
1131 \r
1132                 /* Interrupts and other tasks can send to and receive from the queue\r
1133                 now the critical section has been exited. */\r
1134 \r
1135                 vTaskSuspendAll();\r
1136                 prvLockQueue( pxQueue );\r
1137 \r
1138                 /* Update the timeout state to see if it has expired yet. */\r
1139                 if( xTaskCheckForTimeOut( &xTimeOut, &xTicksToWait ) == pdFALSE )\r
1140                 {\r
1141                         if( prvIsQueueEmpty( pxQueue ) != pdFALSE )\r
1142                         {\r
1143                                 traceBLOCKING_ON_QUEUE_RECEIVE( pxQueue );\r
1144 \r
1145                                 #if ( configUSE_MUTEXES == 1 )\r
1146                                 {\r
1147                                         if( pxQueue->uxQueueType == queueQUEUE_IS_MUTEX )\r
1148                                         {\r
1149                                                 portENTER_CRITICAL();\r
1150                                                 {\r
1151                                                         vTaskPriorityInherit( ( void * ) pxQueue->pxMutexHolder );\r
1152                                                 }\r
1153                                                 portEXIT_CRITICAL();\r
1154                                         }\r
1155                                 }\r
1156                                 #endif\r
1157 \r
1158                                 vTaskPlaceOnEventList( &( pxQueue->xTasksWaitingToReceive ), xTicksToWait );\r
1159                                 prvUnlockQueue( pxQueue );\r
1160                                 if( xTaskResumeAll() == pdFALSE )\r
1161                                 {\r
1162                                         portYIELD_WITHIN_API();\r
1163                                 }\r
1164                         }\r
1165                         else\r
1166                         {\r
1167                                 /* Try again. */\r
1168                                 prvUnlockQueue( pxQueue );\r
1169                                 ( void ) xTaskResumeAll();\r
1170                         }\r
1171                 }\r
1172                 else\r
1173                 {\r
1174                         prvUnlockQueue( pxQueue );\r
1175                         ( void ) xTaskResumeAll();\r
1176                         traceQUEUE_RECEIVE_FAILED( pxQueue );\r
1177                         return errQUEUE_EMPTY;\r
1178                 }\r
1179         }\r
1180 }\r
1181 /*-----------------------------------------------------------*/\r
1182 \r
1183 signed portBASE_TYPE xQueueReceiveFromISR( xQueueHandle pxQueue, void * const pvBuffer, signed portBASE_TYPE *pxHigherPriorityTaskWoken )\r
1184 {\r
1185 signed portBASE_TYPE xReturn;\r
1186 unsigned portBASE_TYPE uxSavedInterruptStatus;\r
1187 \r
1188         configASSERT( pxQueue );\r
1189         configASSERT( !( ( pvBuffer == NULL ) && ( pxQueue->uxItemSize != ( unsigned portBASE_TYPE ) 0U ) ) );\r
1190 \r
1191         uxSavedInterruptStatus = portSET_INTERRUPT_MASK_FROM_ISR();\r
1192         {\r
1193                 /* We cannot block from an ISR, so check there is data available. */\r
1194                 if( pxQueue->uxMessagesWaiting > ( unsigned portBASE_TYPE ) 0 )\r
1195                 {\r
1196                         traceQUEUE_RECEIVE_FROM_ISR( pxQueue );\r
1197 \r
1198                         prvCopyDataFromQueue( pxQueue, pvBuffer );\r
1199                         --( pxQueue->uxMessagesWaiting );\r
1200 \r
1201                         /* If the queue is locked we will not modify the event list.  Instead\r
1202                         we update the lock count so the task that unlocks the queue will know\r
1203                         that an ISR has removed data while the queue was locked. */\r
1204                         if( pxQueue->xRxLock == queueUNLOCKED )\r
1205                         {\r
1206                                 if( listLIST_IS_EMPTY( &( pxQueue->xTasksWaitingToSend ) ) == pdFALSE )\r
1207                                 {\r
1208                                         if( xTaskRemoveFromEventList( &( pxQueue->xTasksWaitingToSend ) ) != pdFALSE )\r
1209                                         {\r
1210                                                 /* The task waiting has a higher priority than us so\r
1211                                                 force a context switch. */\r
1212                                                 if( pxHigherPriorityTaskWoken != NULL )\r
1213                                                 {\r
1214                                                         *pxHigherPriorityTaskWoken = pdTRUE;\r
1215                                                 }\r
1216                                         }\r
1217                                 }\r
1218                         }\r
1219                         else\r
1220                         {\r
1221                                 /* Increment the lock count so the task that unlocks the queue\r
1222                                 knows that data was removed while it was locked. */\r
1223                                 ++( pxQueue->xRxLock );\r
1224                         }\r
1225 \r
1226                         xReturn = pdPASS;\r
1227                 }\r
1228                 else\r
1229                 {\r
1230                         xReturn = pdFAIL;\r
1231                         traceQUEUE_RECEIVE_FROM_ISR_FAILED( pxQueue );\r
1232                 }\r
1233         }\r
1234         portCLEAR_INTERRUPT_MASK_FROM_ISR( uxSavedInterruptStatus );\r
1235 \r
1236         return xReturn;\r
1237 }\r
1238 /*-----------------------------------------------------------*/\r
1239 \r
1240 unsigned portBASE_TYPE uxQueueMessagesWaiting( const xQueueHandle pxQueue )\r
1241 {\r
1242 unsigned portBASE_TYPE uxReturn;\r
1243 \r
1244         configASSERT( pxQueue );\r
1245 \r
1246         taskENTER_CRITICAL();\r
1247                 uxReturn = pxQueue->uxMessagesWaiting;\r
1248         taskEXIT_CRITICAL();\r
1249 \r
1250         return uxReturn;\r
1251 }\r
1252 /*-----------------------------------------------------------*/\r
1253 \r
1254 unsigned portBASE_TYPE uxQueueMessagesWaitingFromISR( const xQueueHandle pxQueue )\r
1255 {\r
1256 unsigned portBASE_TYPE uxReturn;\r
1257 \r
1258         configASSERT( pxQueue );\r
1259 \r
1260         uxReturn = pxQueue->uxMessagesWaiting;\r
1261 \r
1262         return uxReturn;\r
1263 }\r
1264 /*-----------------------------------------------------------*/\r
1265 \r
1266 void vQueueDelete( xQueueHandle pxQueue )\r
1267 {\r
1268         configASSERT( pxQueue );\r
1269 \r
1270         traceQUEUE_DELETE( pxQueue );\r
1271         vQueueUnregisterQueue( pxQueue );\r
1272         vPortFree( pxQueue->pcHead );\r
1273         vPortFree( pxQueue );\r
1274 }\r
1275 /*-----------------------------------------------------------*/\r
1276 \r
1277 #if ( configUSE_TRACE_FACILITY == 1 )\r
1278 \r
1279         unsigned char ucQueueGetQueueNumber( xQueueHandle pxQueue )\r
1280         {\r
1281                 return pxQueue->ucQueueNumber;\r
1282         }\r
1283 \r
1284 #endif /* configUSE_TRACE_FACILITY */\r
1285 /*-----------------------------------------------------------*/\r
1286 \r
1287 #if ( configUSE_TRACE_FACILITY == 1 )\r
1288 \r
1289         void vQueueSetQueueNumber( xQueueHandle pxQueue, unsigned char ucQueueNumber )\r
1290         {\r
1291                 pxQueue->ucQueueNumber = ucQueueNumber;\r
1292         }\r
1293 \r
1294 #endif /* configUSE_TRACE_FACILITY */\r
1295 /*-----------------------------------------------------------*/\r
1296 \r
1297 #if ( configUSE_TRACE_FACILITY == 1 )\r
1298 \r
1299         unsigned char ucQueueGetQueueType( xQueueHandle pxQueue )\r
1300         {\r
1301                 return pxQueue->ucQueueType;\r
1302         }\r
1303 \r
1304 #endif /* configUSE_TRACE_FACILITY */\r
1305 /*-----------------------------------------------------------*/\r
1306 \r
1307 static void prvCopyDataToQueue( xQUEUE *pxQueue, const void *pvItemToQueue, portBASE_TYPE xPosition )\r
1308 {\r
1309         if( pxQueue->uxItemSize == ( unsigned portBASE_TYPE ) 0 )\r
1310         {\r
1311                 #if ( configUSE_MUTEXES == 1 )\r
1312                 {\r
1313                         if( pxQueue->uxQueueType == queueQUEUE_IS_MUTEX )\r
1314                         {\r
1315                                 /* The mutex is no longer being held. */\r
1316                                 vTaskPriorityDisinherit( ( void * ) pxQueue->pxMutexHolder );\r
1317                                 pxQueue->pxMutexHolder = NULL;\r
1318                         }\r
1319                 }\r
1320                 #endif\r
1321         }\r
1322         else if( xPosition == queueSEND_TO_BACK )\r
1323         {\r
1324                 memcpy( ( void * ) pxQueue->pcWriteTo, pvItemToQueue, ( unsigned ) pxQueue->uxItemSize );\r
1325                 pxQueue->pcWriteTo += pxQueue->uxItemSize;\r
1326                 if( pxQueue->pcWriteTo >= pxQueue->pcTail )\r
1327                 {\r
1328                         pxQueue->pcWriteTo = pxQueue->pcHead;\r
1329                 }\r
1330         }\r
1331         else\r
1332         {\r
1333                 memcpy( ( void * ) pxQueue->pcReadFrom, pvItemToQueue, ( unsigned ) pxQueue->uxItemSize );\r
1334                 pxQueue->pcReadFrom -= pxQueue->uxItemSize;\r
1335                 if( pxQueue->pcReadFrom < pxQueue->pcHead )\r
1336                 {\r
1337                         pxQueue->pcReadFrom = ( pxQueue->pcTail - pxQueue->uxItemSize );\r
1338                 }\r
1339         }\r
1340 \r
1341         ++( pxQueue->uxMessagesWaiting );\r
1342 }\r
1343 /*-----------------------------------------------------------*/\r
1344 \r
1345 static void prvCopyDataFromQueue( xQUEUE * const pxQueue, const void *pvBuffer )\r
1346 {\r
1347         if( pxQueue->uxQueueType != queueQUEUE_IS_MUTEX )\r
1348         {\r
1349                 pxQueue->pcReadFrom += pxQueue->uxItemSize;\r
1350                 if( pxQueue->pcReadFrom >= pxQueue->pcTail )\r
1351                 {\r
1352                         pxQueue->pcReadFrom = pxQueue->pcHead;\r
1353                 }\r
1354                 memcpy( ( void * ) pvBuffer, ( void * ) pxQueue->pcReadFrom, ( unsigned ) pxQueue->uxItemSize );\r
1355         }\r
1356 }\r
1357 /*-----------------------------------------------------------*/\r
1358 \r
1359 static void prvUnlockQueue( xQueueHandle pxQueue )\r
1360 {\r
1361         /* THIS FUNCTION MUST BE CALLED WITH THE SCHEDULER SUSPENDED. */\r
1362 \r
1363         /* The lock counts contains the number of extra data items placed or\r
1364         removed from the queue while the queue was locked.  When a queue is\r
1365         locked items can be added or removed, but the event lists cannot be\r
1366         updated. */\r
1367         taskENTER_CRITICAL();\r
1368         {\r
1369                 /* See if data was added to the queue while it was locked. */\r
1370                 while( pxQueue->xTxLock > queueLOCKED_UNMODIFIED )\r
1371                 {\r
1372                         /* Data was posted while the queue was locked.  Are any tasks\r
1373                         blocked waiting for data to become available? */\r
1374                         if( listLIST_IS_EMPTY( &( pxQueue->xTasksWaitingToReceive ) ) == pdFALSE )\r
1375                         {\r
1376                                 /* Tasks that are removed from the event list will get added to\r
1377                                 the pending ready list as the scheduler is still suspended. */\r
1378                                 if( xTaskRemoveFromEventList( &( pxQueue->xTasksWaitingToReceive ) ) != pdFALSE )\r
1379                                 {\r
1380                                         /* The task waiting has a higher priority so record that a\r
1381                                         context switch is required. */\r
1382                                         vTaskMissedYield();\r
1383                                 }\r
1384                                 else\r
1385                                 {\r
1386                                         #if ( configUSE_QUEUE_SETS == 1 )\r
1387                                         {\r
1388                                                 /* It is highly unlikely that this code will ever run,\r
1389                                                 for the following reason:\r
1390                                                   + A task will only lock a queue that is part of a\r
1391                                                     queue set when it is blocking on a write to the\r
1392                                                         queue.\r
1393                                                   + An interrupt can only add something to a queue\r
1394                                                     while the queue is locked (resulting in the\r
1395                                                         following code executing when the queue is unlocked)\r
1396                                                         if the queue is not full, meaning a task will never\r
1397                                                         have blocked on a write in the first place.\r
1398                                                  The code could execute if an interrupt is also removing\r
1399                                                  items from a queue. */\r
1400                                                 if( pxQueue->pxQueueSetContainer != NULL )\r
1401                                                 {\r
1402                                                         if( prvNotifyQueueSetContainer( pxQueue, queueSEND_TO_BACK ) == pdTRUE )\r
1403                                                         {\r
1404                                                                 /* The queue is a member of a queue set, and posting to\r
1405                                                                 the queue set caused a higher priority task to unblock.\r
1406                                                                 A context switch is required. */\r
1407                                                                 vTaskMissedYield();\r
1408                                                         }\r
1409                                                 }\r
1410                                         }\r
1411                                         #endif /* configUSE_QUEUE_SETS */\r
1412                                 }\r
1413 \r
1414                                 --( pxQueue->xTxLock );\r
1415                         }\r
1416                         else\r
1417                         {\r
1418                                 break;\r
1419                         }\r
1420                 }\r
1421 \r
1422                 pxQueue->xTxLock = queueUNLOCKED;\r
1423         }\r
1424         taskEXIT_CRITICAL();\r
1425 \r
1426         /* Do the same for the Rx lock. */\r
1427         taskENTER_CRITICAL();\r
1428         {\r
1429                 while( pxQueue->xRxLock > queueLOCKED_UNMODIFIED )\r
1430                 {\r
1431                         if( listLIST_IS_EMPTY( &( pxQueue->xTasksWaitingToSend ) ) == pdFALSE )\r
1432                         {\r
1433                                 if( xTaskRemoveFromEventList( &( pxQueue->xTasksWaitingToSend ) ) != pdFALSE )\r
1434                                 {\r
1435                                         vTaskMissedYield();\r
1436                                 }\r
1437 \r
1438                                 --( pxQueue->xRxLock );\r
1439                         }\r
1440                         else\r
1441                         {\r
1442                                 break;\r
1443                         }\r
1444                 }\r
1445 \r
1446                 pxQueue->xRxLock = queueUNLOCKED;\r
1447         }\r
1448         taskEXIT_CRITICAL();\r
1449 }\r
1450 /*-----------------------------------------------------------*/\r
1451 \r
1452 static signed portBASE_TYPE prvIsQueueEmpty( const xQueueHandle pxQueue )\r
1453 {\r
1454 signed portBASE_TYPE xReturn;\r
1455 \r
1456         taskENTER_CRITICAL();\r
1457                 xReturn = ( pxQueue->uxMessagesWaiting == ( unsigned portBASE_TYPE ) 0 );\r
1458         taskEXIT_CRITICAL();\r
1459 \r
1460         return xReturn;\r
1461 }\r
1462 /*-----------------------------------------------------------*/\r
1463 \r
1464 signed portBASE_TYPE xQueueIsQueueEmptyFromISR( const xQueueHandle pxQueue )\r
1465 {\r
1466 signed portBASE_TYPE xReturn;\r
1467 \r
1468         configASSERT( pxQueue );\r
1469         xReturn = ( pxQueue->uxMessagesWaiting == ( unsigned portBASE_TYPE ) 0 );\r
1470 \r
1471         return xReturn;\r
1472 }\r
1473 /*-----------------------------------------------------------*/\r
1474 \r
1475 static signed portBASE_TYPE prvIsQueueFull( const xQueueHandle pxQueue )\r
1476 {\r
1477 signed portBASE_TYPE xReturn;\r
1478 \r
1479         taskENTER_CRITICAL();\r
1480                 xReturn = ( pxQueue->uxMessagesWaiting == pxQueue->uxLength );\r
1481         taskEXIT_CRITICAL();\r
1482 \r
1483         return xReturn;\r
1484 }\r
1485 /*-----------------------------------------------------------*/\r
1486 \r
1487 signed portBASE_TYPE xQueueIsQueueFullFromISR( const xQueueHandle pxQueue )\r
1488 {\r
1489 signed portBASE_TYPE xReturn;\r
1490 \r
1491         configASSERT( pxQueue );\r
1492         xReturn = ( pxQueue->uxMessagesWaiting == pxQueue->uxLength );\r
1493 \r
1494         return xReturn;\r
1495 }\r
1496 /*-----------------------------------------------------------*/\r
1497 \r
1498 #if ( configUSE_CO_ROUTINES == 1 )\r
1499 \r
1500         signed portBASE_TYPE xQueueCRSend( xQueueHandle pxQueue, const void *pvItemToQueue, portTickType xTicksToWait )\r
1501         {\r
1502         signed portBASE_TYPE xReturn;\r
1503 \r
1504                 /* If the queue is already full we may have to block.  A critical section\r
1505                 is required to prevent an interrupt removing something from the queue\r
1506                 between the check to see if the queue is full and blocking on the queue. */\r
1507                 portDISABLE_INTERRUPTS();\r
1508                 {\r
1509                         if( prvIsQueueFull( pxQueue ) != pdFALSE )\r
1510                         {\r
1511                                 /* The queue is full - do we want to block or just leave without\r
1512                                 posting? */\r
1513                                 if( xTicksToWait > ( portTickType ) 0 )\r
1514                                 {\r
1515                                         /* As this is called from a coroutine we cannot block directly, but\r
1516                                         return indicating that we need to block. */\r
1517                                         vCoRoutineAddToDelayedList( xTicksToWait, &( pxQueue->xTasksWaitingToSend ) );\r
1518                                         portENABLE_INTERRUPTS();\r
1519                                         return errQUEUE_BLOCKED;\r
1520                                 }\r
1521                                 else\r
1522                                 {\r
1523                                         portENABLE_INTERRUPTS();\r
1524                                         return errQUEUE_FULL;\r
1525                                 }\r
1526                         }\r
1527                 }\r
1528                 portENABLE_INTERRUPTS();\r
1529 \r
1530                 portNOP();\r
1531 \r
1532                 portDISABLE_INTERRUPTS();\r
1533                 {\r
1534                         if( pxQueue->uxMessagesWaiting < pxQueue->uxLength )\r
1535                         {\r
1536                                 /* There is room in the queue, copy the data into the queue. */\r
1537                                 prvCopyDataToQueue( pxQueue, pvItemToQueue, queueSEND_TO_BACK );\r
1538                                 xReturn = pdPASS;\r
1539 \r
1540                                 /* Were any co-routines waiting for data to become available? */\r
1541                                 if( listLIST_IS_EMPTY( &( pxQueue->xTasksWaitingToReceive ) ) == pdFALSE )\r
1542                                 {\r
1543                                         /* In this instance the co-routine could be placed directly\r
1544                                         into the ready list as we are within a critical section.\r
1545                                         Instead the same pending ready list mechanism is used as if\r
1546                                         the event were caused from within an interrupt. */\r
1547                                         if( xCoRoutineRemoveFromEventList( &( pxQueue->xTasksWaitingToReceive ) ) != pdFALSE )\r
1548                                         {\r
1549                                                 /* The co-routine waiting has a higher priority so record\r
1550                                                 that a yield might be appropriate. */\r
1551                                                 xReturn = errQUEUE_YIELD;\r
1552                                         }\r
1553                                 }\r
1554                         }\r
1555                         else\r
1556                         {\r
1557                                 xReturn = errQUEUE_FULL;\r
1558                         }\r
1559                 }\r
1560                 portENABLE_INTERRUPTS();\r
1561 \r
1562                 return xReturn;\r
1563         }\r
1564 \r
1565 #endif /* configUSE_CO_ROUTINES */\r
1566 /*-----------------------------------------------------------*/\r
1567 \r
1568 #if ( configUSE_CO_ROUTINES == 1 )\r
1569 \r
1570         signed portBASE_TYPE xQueueCRReceive( xQueueHandle pxQueue, void *pvBuffer, portTickType xTicksToWait )\r
1571         {\r
1572         signed portBASE_TYPE xReturn;\r
1573 \r
1574                 /* If the queue is already empty we may have to block.  A critical section\r
1575                 is required to prevent an interrupt adding something to the queue\r
1576                 between the check to see if the queue is empty and blocking on the queue. */\r
1577                 portDISABLE_INTERRUPTS();\r
1578                 {\r
1579                         if( pxQueue->uxMessagesWaiting == ( unsigned portBASE_TYPE ) 0 )\r
1580                         {\r
1581                                 /* There are no messages in the queue, do we want to block or just\r
1582                                 leave with nothing? */\r
1583                                 if( xTicksToWait > ( portTickType ) 0 )\r
1584                                 {\r
1585                                         /* As this is a co-routine we cannot block directly, but return\r
1586                                         indicating that we need to block. */\r
1587                                         vCoRoutineAddToDelayedList( xTicksToWait, &( pxQueue->xTasksWaitingToReceive ) );\r
1588                                         portENABLE_INTERRUPTS();\r
1589                                         return errQUEUE_BLOCKED;\r
1590                                 }\r
1591                                 else\r
1592                                 {\r
1593                                         portENABLE_INTERRUPTS();\r
1594                                         return errQUEUE_FULL;\r
1595                                 }\r
1596                         }\r
1597                 }\r
1598                 portENABLE_INTERRUPTS();\r
1599 \r
1600                 portNOP();\r
1601 \r
1602                 portDISABLE_INTERRUPTS();\r
1603                 {\r
1604                         if( pxQueue->uxMessagesWaiting > ( unsigned portBASE_TYPE ) 0 )\r
1605                         {\r
1606                                 /* Data is available from the queue. */\r
1607                                 pxQueue->pcReadFrom += pxQueue->uxItemSize;\r
1608                                 if( pxQueue->pcReadFrom >= pxQueue->pcTail )\r
1609                                 {\r
1610                                         pxQueue->pcReadFrom = pxQueue->pcHead;\r
1611                                 }\r
1612                                 --( pxQueue->uxMessagesWaiting );\r
1613                                 memcpy( ( void * ) pvBuffer, ( void * ) pxQueue->pcReadFrom, ( unsigned ) pxQueue->uxItemSize );\r
1614 \r
1615                                 xReturn = pdPASS;\r
1616 \r
1617                                 /* Were any co-routines waiting for space to become available? */\r
1618                                 if( listLIST_IS_EMPTY( &( pxQueue->xTasksWaitingToSend ) ) == pdFALSE )\r
1619                                 {\r
1620                                         /* In this instance the co-routine could be placed directly\r
1621                                         into the ready list as we are within a critical section.\r
1622                                         Instead the same pending ready list mechanism is used as if\r
1623                                         the event were caused from within an interrupt. */\r
1624                                         if( xCoRoutineRemoveFromEventList( &( pxQueue->xTasksWaitingToSend ) ) != pdFALSE )\r
1625                                         {\r
1626                                                 xReturn = errQUEUE_YIELD;\r
1627                                         }\r
1628                                 }\r
1629                         }\r
1630                         else\r
1631                         {\r
1632                                 xReturn = pdFAIL;\r
1633                         }\r
1634                 }\r
1635                 portENABLE_INTERRUPTS();\r
1636 \r
1637                 return xReturn;\r
1638         }\r
1639 \r
1640 #endif /* configUSE_CO_ROUTINES */\r
1641 /*-----------------------------------------------------------*/\r
1642 \r
1643 #if ( configUSE_CO_ROUTINES == 1 )\r
1644 \r
1645         signed portBASE_TYPE xQueueCRSendFromISR( xQueueHandle pxQueue, const void *pvItemToQueue, signed portBASE_TYPE xCoRoutinePreviouslyWoken )\r
1646         {\r
1647                 /* Cannot block within an ISR so if there is no space on the queue then\r
1648                 exit without doing anything. */\r
1649                 if( pxQueue->uxMessagesWaiting < pxQueue->uxLength )\r
1650                 {\r
1651                         prvCopyDataToQueue( pxQueue, pvItemToQueue, queueSEND_TO_BACK );\r
1652 \r
1653                         /* We only want to wake one co-routine per ISR, so check that a\r
1654                         co-routine has not already been woken. */\r
1655                         if( xCoRoutinePreviouslyWoken == pdFALSE )\r
1656                         {\r
1657                                 if( listLIST_IS_EMPTY( &( pxQueue->xTasksWaitingToReceive ) ) == pdFALSE )\r
1658                                 {\r
1659                                         if( xCoRoutineRemoveFromEventList( &( pxQueue->xTasksWaitingToReceive ) ) != pdFALSE )\r
1660                                         {\r
1661                                                 return pdTRUE;\r
1662                                         }\r
1663                                 }\r
1664                         }\r
1665                 }\r
1666 \r
1667                 return xCoRoutinePreviouslyWoken;\r
1668         }\r
1669 \r
1670 #endif /* configUSE_CO_ROUTINES */\r
1671 /*-----------------------------------------------------------*/\r
1672 \r
1673 #if ( configUSE_CO_ROUTINES == 1 )\r
1674 \r
1675         signed portBASE_TYPE xQueueCRReceiveFromISR( xQueueHandle pxQueue, void *pvBuffer, signed portBASE_TYPE *pxCoRoutineWoken )\r
1676         {\r
1677         signed portBASE_TYPE xReturn;\r
1678 \r
1679                 /* We cannot block from an ISR, so check there is data available. If\r
1680                 not then just leave without doing anything. */\r
1681                 if( pxQueue->uxMessagesWaiting > ( unsigned portBASE_TYPE ) 0 )\r
1682                 {\r
1683                         /* Copy the data from the queue. */\r
1684                         pxQueue->pcReadFrom += pxQueue->uxItemSize;\r
1685                         if( pxQueue->pcReadFrom >= pxQueue->pcTail )\r
1686                         {\r
1687                                 pxQueue->pcReadFrom = pxQueue->pcHead;\r
1688                         }\r
1689                         --( pxQueue->uxMessagesWaiting );\r
1690                         memcpy( ( void * ) pvBuffer, ( void * ) pxQueue->pcReadFrom, ( unsigned ) pxQueue->uxItemSize );\r
1691 \r
1692                         if( ( *pxCoRoutineWoken ) == pdFALSE )\r
1693                         {\r
1694                                 if( listLIST_IS_EMPTY( &( pxQueue->xTasksWaitingToSend ) ) == pdFALSE )\r
1695                                 {\r
1696                                         if( xCoRoutineRemoveFromEventList( &( pxQueue->xTasksWaitingToSend ) ) != pdFALSE )\r
1697                                         {\r
1698                                                 *pxCoRoutineWoken = pdTRUE;\r
1699                                         }\r
1700                                 }\r
1701                         }\r
1702 \r
1703                         xReturn = pdPASS;\r
1704                 }\r
1705                 else\r
1706                 {\r
1707                         xReturn = pdFAIL;\r
1708                 }\r
1709 \r
1710                 return xReturn;\r
1711         }\r
1712 \r
1713 #endif /* configUSE_CO_ROUTINES */\r
1714 /*-----------------------------------------------------------*/\r
1715 \r
1716 #if ( configQUEUE_REGISTRY_SIZE > 0 )\r
1717 \r
1718         void vQueueAddToRegistry( xQueueHandle xQueue, signed char *pcQueueName )\r
1719         {\r
1720         unsigned portBASE_TYPE ux;\r
1721 \r
1722                 /* See if there is an empty space in the registry.  A NULL name denotes\r
1723                 a free slot. */\r
1724                 for( ux = ( unsigned portBASE_TYPE ) 0U; ux < ( unsigned portBASE_TYPE ) configQUEUE_REGISTRY_SIZE; ux++ )\r
1725                 {\r
1726                         if( xQueueRegistry[ ux ].pcQueueName == NULL )\r
1727                         {\r
1728                                 /* Store the information on this queue. */\r
1729                                 xQueueRegistry[ ux ].pcQueueName = pcQueueName;\r
1730                                 xQueueRegistry[ ux ].xHandle = xQueue;\r
1731                                 break;\r
1732                         }\r
1733                 }\r
1734         }\r
1735 \r
1736 #endif /* configQUEUE_REGISTRY_SIZE */\r
1737 /*-----------------------------------------------------------*/\r
1738 \r
1739 #if ( configQUEUE_REGISTRY_SIZE > 0 )\r
1740 \r
1741         static void vQueueUnregisterQueue( xQueueHandle xQueue )\r
1742         {\r
1743         unsigned portBASE_TYPE ux;\r
1744 \r
1745                 /* See if the handle of the queue being unregistered in actually in the\r
1746                 registry. */\r
1747                 for( ux = ( unsigned portBASE_TYPE ) 0U; ux < ( unsigned portBASE_TYPE ) configQUEUE_REGISTRY_SIZE; ux++ )\r
1748                 {\r
1749                         if( xQueueRegistry[ ux ].xHandle == xQueue )\r
1750                         {\r
1751                                 /* Set the name to NULL to show that this slot if free again. */\r
1752                                 xQueueRegistry[ ux ].pcQueueName = NULL;\r
1753                                 break;\r
1754                         }\r
1755                 }\r
1756 \r
1757         }\r
1758 \r
1759 #endif /* configQUEUE_REGISTRY_SIZE */\r
1760 /*-----------------------------------------------------------*/\r
1761 \r
1762 #if ( configUSE_TIMERS == 1 )\r
1763 \r
1764         void vQueueWaitForMessageRestricted( xQueueHandle pxQueue, portTickType xTicksToWait )\r
1765         {\r
1766                 /* This function should not be called by application code hence the\r
1767                 'Restricted' in its name.  It is not part of the public API.  It is\r
1768                 designed for use by kernel code, and has special calling requirements.\r
1769                 It can result in vListInsert() being called on a list that can only\r
1770                 possibly ever have one item in it, so the list will be fast, but even\r
1771                 so it should be called with the scheduler locked and not from a critical\r
1772                 section. */\r
1773 \r
1774                 /* Only do anything if there are no messages in the queue.  This function\r
1775                 will not actually cause the task to block, just place it on a blocked\r
1776                 list.  It will not block until the scheduler is unlocked - at which\r
1777                 time a yield will be performed.  If an item is added to the queue while\r
1778                 the queue is locked, and the calling task blocks on the queue, then the\r
1779                 calling task will be immediately unblocked when the queue is unlocked. */\r
1780                 prvLockQueue( pxQueue );\r
1781                 if( pxQueue->uxMessagesWaiting == ( unsigned portBASE_TYPE ) 0U )\r
1782                 {\r
1783                         /* There is nothing in the queue, block for the specified period. */\r
1784                         vTaskPlaceOnEventListRestricted( &( pxQueue->xTasksWaitingToReceive ), xTicksToWait );\r
1785                 }\r
1786                 prvUnlockQueue( pxQueue );\r
1787         }\r
1788 \r
1789 #endif /* configUSE_TIMERS */\r
1790 /*-----------------------------------------------------------*/\r
1791 \r
1792 #if ( configUSE_QUEUE_SETS == 1 )\r
1793 \r
1794         xQueueSetHandle xQueueSetCreate( unsigned portBASE_TYPE uxEventQueueLength )\r
1795         {\r
1796         xQUEUE *pxQueue;\r
1797 \r
1798                 pxQueue = xQueueGenericCreate( uxEventQueueLength, sizeof( xQUEUE * ), queueQUEUE_TYPE_SET );\r
1799 \r
1800                 return ( xQueueSetHandle ) pxQueue;\r
1801         }\r
1802 \r
1803 #endif /* configUSE_QUEUE_SETS */\r
1804 /*-----------------------------------------------------------*/\r
1805 \r
1806 #if ( configUSE_QUEUE_SETS == 1 )\r
1807 \r
1808         portBASE_TYPE xQueueAddToQueueSet( xQueueSetMemberHandle xQueueOrSemaphore, xQueueSetHandle xQueueSet )\r
1809         {\r
1810         portBASE_TYPE xReturn;\r
1811 \r
1812                 if( xQueueOrSemaphore->pxQueueSetContainer != NULL )\r
1813                 {\r
1814                         xReturn = pdFAIL;\r
1815                 }\r
1816                 else\r
1817                 {\r
1818                         taskENTER_CRITICAL();\r
1819                         {\r
1820                                 xQueueOrSemaphore->pxQueueSetContainer = xQueueSet;\r
1821                         }\r
1822                         taskEXIT_CRITICAL();\r
1823                         xReturn = pdPASS;\r
1824                 }\r
1825 \r
1826                 return xReturn;\r
1827         }\r
1828 \r
1829 #endif /* configUSE_QUEUE_SETS */\r
1830 /*-----------------------------------------------------------*/\r
1831 \r
1832 #if ( configUSE_QUEUE_SETS == 1 )\r
1833 \r
1834         portBASE_TYPE xQueueRemoveFromQueueSet( xQueueSetMemberHandle xQueueOrSemaphore, xQueueSetHandle xQueueSet )\r
1835         {\r
1836         portBASE_TYPE xReturn;\r
1837 \r
1838                 if( xQueueOrSemaphore->pxQueueSetContainer != xQueueSet )\r
1839                 {\r
1840                         xReturn = pdFAIL;\r
1841                 }\r
1842                 else\r
1843                 {\r
1844                         taskENTER_CRITICAL();\r
1845                         {\r
1846                                 xQueueOrSemaphore->pxQueueSetContainer = NULL;\r
1847                         }\r
1848                         taskEXIT_CRITICAL();\r
1849                         xReturn = pdPASS;\r
1850                 }\r
1851 \r
1852                 return xReturn;\r
1853         }\r
1854 \r
1855 #endif /* configUSE_QUEUE_SETS */\r
1856 /*-----------------------------------------------------------*/\r
1857 \r
1858 #if ( configUSE_QUEUE_SETS == 1 )\r
1859 \r
1860         xQueueSetMemberHandle xQueueBlockMultiple( xQueueSetHandle xQueueSet, portTickType xBlockTimeTicks )\r
1861         {\r
1862         xQueueSetMemberHandle xReturn = NULL;\r
1863 \r
1864                 xQueueGenericReceive( ( xQueueHandle ) xQueueSet, &xReturn, xBlockTimeTicks, pdFALSE );\r
1865                 return xReturn;\r
1866         }\r
1867 \r
1868 #endif /* configUSE_QUEUE_SETS */\r
1869 /*-----------------------------------------------------------*/\r
1870 \r
1871 #if ( configUSE_QUEUE_SETS == 1 )\r
1872 \r
1873         static portBASE_TYPE prvNotifyQueueSetContainer( xQUEUE *pxQueue, portBASE_TYPE xCopyPosition )\r
1874         {\r
1875         xQUEUE *pxQueueSetContainer = pxQueue->pxQueueSetContainer;\r
1876         portBASE_TYPE xReturn = pdFALSE;\r
1877 \r
1878                 configASSERT( pxQueueSetContainer );\r
1879                 configASSERT( pxQueueSetContainer->uxMessagesWaiting < pxQueueSetContainer->uxLength );\r
1880 \r
1881                 if( pxQueueSetContainer->uxMessagesWaiting < pxQueueSetContainer->uxLength )\r
1882                 {\r
1883                         prvCopyDataToQueue( pxQueueSetContainer, &pxQueue, xCopyPosition );\r
1884                         if( listLIST_IS_EMPTY( &( pxQueueSetContainer->xTasksWaitingToReceive ) ) == pdFALSE )\r
1885                         {\r
1886                                 if( xTaskRemoveFromEventList( &( pxQueueSetContainer->xTasksWaitingToReceive ) ) != pdFALSE )\r
1887                                 {\r
1888                                         /* The task waiting has a higher priority */\r
1889                                         xReturn = pdTRUE;\r
1890                                 }\r
1891                         }\r
1892                 }\r
1893 \r
1894                 return xReturn;\r
1895         }\r
1896 \r
1897 #endif /* configUSE_QUEUE_SETS */\r
1898 \r