2 FreeRTOS V7.5.2 - Copyright (C) 2013 Real Time Engineers Ltd.
\r
4 VISIT http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.
\r
6 ***************************************************************************
\r
8 * FreeRTOS provides completely free yet professionally developed, *
\r
9 * robust, strictly quality controlled, supported, and cross *
\r
10 * platform software that has become a de facto standard. *
\r
12 * Help yourself get started quickly and support the FreeRTOS *
\r
13 * project by purchasing a FreeRTOS tutorial book, reference *
\r
14 * manual, or both from: http://www.FreeRTOS.org/Documentation *
\r
18 ***************************************************************************
\r
20 This file is part of the FreeRTOS distribution.
\r
22 FreeRTOS is free software; you can redistribute it and/or modify it under
\r
23 the terms of the GNU General Public License (version 2) as published by the
\r
24 Free Software Foundation >>!AND MODIFIED BY!<< the FreeRTOS exception.
\r
26 >>! NOTE: The modification to the GPL is included to allow you to distribute
\r
27 >>! a combined work that includes FreeRTOS without being obliged to provide
\r
28 >>! the source code for proprietary components outside of the FreeRTOS
\r
31 FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY
\r
32 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
\r
33 FOR A PARTICULAR PURPOSE. Full license text is available from the following
\r
34 link: http://www.freertos.org/a00114.html
\r
38 ***************************************************************************
\r
40 * Having a problem? Start by reading the FAQ "My application does *
\r
41 * not run, what could be wrong?" *
\r
43 * http://www.FreeRTOS.org/FAQHelp.html *
\r
45 ***************************************************************************
\r
47 http://www.FreeRTOS.org - Documentation, books, training, latest versions,
\r
48 license and Real Time Engineers Ltd. contact details.
\r
50 http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,
\r
51 including FreeRTOS+Trace - an indispensable productivity tool, a DOS
\r
52 compatible FAT file system, and our tiny thread aware UDP/IP stack.
\r
54 http://www.OpenRTOS.com - Real Time Engineers ltd license FreeRTOS to High
\r
55 Integrity Systems to sell under the OpenRTOS brand. Low cost OpenRTOS
\r
56 licenses offer ticketed support, indemnification and middleware.
\r
58 http://www.SafeRTOS.com - High Integrity Systems also provide a safety
\r
59 engineered and independently SIL3 certified version for use in safety and
\r
60 mission critical applications that require provable dependability.
\r
68 /* Defining MPU_WRAPPERS_INCLUDED_FROM_API_FILE prevents task.h from redefining
\r
69 all the API functions to use the MPU wrappers. That should only be done when
\r
70 task.h is included from an application file. */
\r
71 #define MPU_WRAPPERS_INCLUDED_FROM_API_FILE
\r
73 #include "FreeRTOS.h"
\r
77 #if ( configUSE_CO_ROUTINES == 1 )
\r
78 #include "croutine.h"
\r
81 /* Lint e961 and e750 are suppressed as a MISRA exception justified because the
\r
82 MPU ports require MPU_WRAPPERS_INCLUDED_FROM_API_FILE to be defined for the
\r
83 header files above, but not in this file, in order to generate the correct
\r
84 privileged Vs unprivileged linkage and placement. */
\r
85 #undef MPU_WRAPPERS_INCLUDED_FROM_API_FILE /*lint !e961 !e750. */
\r
88 /* Constants used with the cRxLock and xTxLock structure members. */
\r
89 #define queueUNLOCKED ( ( signed portBASE_TYPE ) -1 )
\r
90 #define queueLOCKED_UNMODIFIED ( ( signed portBASE_TYPE ) 0 )
\r
92 /* When the xQUEUE structure is used to represent a base queue its pcHead and
\r
93 pcTail members are used as pointers into the queue storage area. When the
\r
94 xQUEUE structure is used to represent a mutex pcHead and pcTail pointers are
\r
95 not necessary, and the pcHead pointer is set to NULL to indicate that the
\r
96 pcTail pointer actually points to the mutex holder (if any). Map alternative
\r
97 names to the pcHead and pcTail structure members to ensure the readability of
\r
98 the code is maintained despite this dual use of two structure members. An
\r
99 alternative implementation would be to use a union, but use of a union is
\r
100 against the coding standard (although an exception to the standard has been
\r
101 permitted where the dual use also significantly changes the type of the
\r
102 structure member). */
\r
103 #define pxMutexHolder pcTail
\r
104 #define uxQueueType pcHead
\r
105 #define queueQUEUE_IS_MUTEX NULL
\r
107 /* Semaphores do not actually store or copy data, so have an item size of
\r
109 #define queueSEMAPHORE_QUEUE_ITEM_LENGTH ( ( unsigned portBASE_TYPE ) 0 )
\r
110 #define queueMUTEX_GIVE_BLOCK_TIME ( ( portTickType ) 0U )
\r
114 * Definition of the queue used by the scheduler.
\r
115 * Items are queued by copy, not reference.
\r
117 typedef struct QueueDefinition
\r
119 signed char *pcHead; /*< Points to the beginning of the queue storage area. */
\r
120 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
122 signed char *pcWriteTo; /*< Points to the free next place in the storage area. */
\r
124 union /* Use of a union is an exception to the coding standard to ensure two mutually exclusive structure members don't appear simultaneously (wasting RAM). */
\r
126 signed char *pcReadFrom; /*< Points to the last place that a queued item was read from when the structure is used as a queue. */
\r
127 unsigned portBASE_TYPE uxRecursiveCallCount;/*< Maintains a count of the numebr of times a recursive mutex has been recursively 'taken' when the structure is used as a mutex. */
\r
130 xList xTasksWaitingToSend; /*< List of tasks that are blocked waiting to post onto this queue. Stored in priority order. */
\r
131 xList xTasksWaitingToReceive; /*< List of tasks that are blocked waiting to read from this queue. Stored in priority order. */
\r
133 volatile unsigned portBASE_TYPE uxMessagesWaiting;/*< The number of items currently in the queue. */
\r
134 unsigned portBASE_TYPE uxLength; /*< The length of the queue defined as the number of items it will hold, not the number of bytes. */
\r
135 unsigned portBASE_TYPE uxItemSize; /*< The size of each items that the queue will hold. */
\r
137 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
138 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
140 #if ( configUSE_TRACE_FACILITY == 1 )
\r
141 unsigned char ucQueueNumber;
\r
142 unsigned char ucQueueType;
\r
145 #if ( configUSE_QUEUE_SETS == 1 )
\r
146 struct QueueDefinition *pxQueueSetContainer;
\r
150 /*-----------------------------------------------------------*/
\r
153 * The queue registry is just a means for kernel aware debuggers to locate
\r
154 * queue structures. It has no other purpose so is an optional component.
\r
156 #if ( configQUEUE_REGISTRY_SIZE > 0 )
\r
158 /* The type stored within the queue registry array. This allows a name
\r
159 to be assigned to each queue making kernel aware debugging a little
\r
160 more user friendly. */
\r
161 typedef struct QUEUE_REGISTRY_ITEM
\r
163 signed char *pcQueueName;
\r
164 xQueueHandle xHandle;
\r
165 } xQueueRegistryItem;
\r
167 /* The queue registry is simply an array of xQueueRegistryItem structures.
\r
168 The pcQueueName member of a structure being NULL is indicative of the
\r
169 array position being vacant. */
\r
170 xQueueRegistryItem xQueueRegistry[ configQUEUE_REGISTRY_SIZE ];
\r
172 #endif /* configQUEUE_REGISTRY_SIZE */
\r
175 * Unlocks a queue locked by a call to prvLockQueue. Locking a queue does not
\r
176 * prevent an ISR from adding or removing items to the queue, but does prevent
\r
177 * an ISR from removing tasks from the queue event lists. If an ISR finds a
\r
178 * queue is locked it will instead increment the appropriate queue lock count
\r
179 * to indicate that a task may require unblocking. When the queue in unlocked
\r
180 * these lock counts are inspected, and the appropriate action taken.
\r
182 static void prvUnlockQueue( xQUEUE *pxQueue ) PRIVILEGED_FUNCTION;
\r
185 * Uses a critical section to determine if there is any data in a queue.
\r
187 * @return pdTRUE if the queue contains no items, otherwise pdFALSE.
\r
189 static signed portBASE_TYPE prvIsQueueEmpty( const xQUEUE *pxQueue ) PRIVILEGED_FUNCTION;
\r
192 * Uses a critical section to determine if there is any space in a queue.
\r
194 * @return pdTRUE if there is no space, otherwise pdFALSE;
\r
196 static signed portBASE_TYPE prvIsQueueFull( const xQUEUE *pxQueue ) PRIVILEGED_FUNCTION;
\r
199 * Copies an item into the queue, either at the front of the queue or the
\r
200 * back of the queue.
\r
202 static void prvCopyDataToQueue( xQUEUE *pxQueue, const void *pvItemToQueue, portBASE_TYPE xPosition ) PRIVILEGED_FUNCTION;
\r
205 * Copies an item out of a queue.
\r
207 static void prvCopyDataFromQueue( xQUEUE * const pxQueue, const void * const pvBuffer ) PRIVILEGED_FUNCTION;
\r
209 #if ( configUSE_QUEUE_SETS == 1 )
\r
211 * Checks to see if a queue is a member of a queue set, and if so, notifies
\r
212 * the queue set that the queue contains data.
\r
214 static portBASE_TYPE prvNotifyQueueSetContainer( const xQUEUE * const pxQueue, portBASE_TYPE xCopyPosition ) PRIVILEGED_FUNCTION;
\r
217 /*-----------------------------------------------------------*/
\r
220 * Macro to mark a queue as locked. Locking a queue prevents an ISR from
\r
221 * accessing the queue event lists.
\r
223 #define prvLockQueue( pxQueue ) \
\r
224 taskENTER_CRITICAL(); \
\r
226 if( ( pxQueue )->xRxLock == queueUNLOCKED ) \
\r
228 ( pxQueue )->xRxLock = queueLOCKED_UNMODIFIED; \
\r
230 if( ( pxQueue )->xTxLock == queueUNLOCKED ) \
\r
232 ( pxQueue )->xTxLock = queueLOCKED_UNMODIFIED; \
\r
235 taskEXIT_CRITICAL()
\r
236 /*-----------------------------------------------------------*/
\r
238 portBASE_TYPE xQueueGenericReset( xQueueHandle xQueue, portBASE_TYPE xNewQueue )
\r
240 xQUEUE * const pxQueue = ( xQUEUE * ) xQueue;
\r
242 configASSERT( pxQueue );
\r
244 taskENTER_CRITICAL();
\r
246 pxQueue->pcTail = pxQueue->pcHead + ( pxQueue->uxLength * pxQueue->uxItemSize );
\r
247 pxQueue->uxMessagesWaiting = ( unsigned portBASE_TYPE ) 0U;
\r
248 pxQueue->pcWriteTo = pxQueue->pcHead;
\r
249 pxQueue->u.pcReadFrom = pxQueue->pcHead + ( ( pxQueue->uxLength - ( unsigned portBASE_TYPE ) 1U ) * pxQueue->uxItemSize );
\r
250 pxQueue->xRxLock = queueUNLOCKED;
\r
251 pxQueue->xTxLock = queueUNLOCKED;
\r
253 if( xNewQueue == pdFALSE )
\r
255 /* If there are tasks blocked waiting to read from the queue, then
\r
256 the tasks will remain blocked as after this function exits the queue
\r
257 will still be empty. If there are tasks blocked waiting to write to
\r
258 the queue, then one should be unblocked as after this function exits
\r
259 it will be possible to write to it. */
\r
260 if( listLIST_IS_EMPTY( &( pxQueue->xTasksWaitingToSend ) ) == pdFALSE )
\r
262 if( xTaskRemoveFromEventList( &( pxQueue->xTasksWaitingToSend ) ) == pdTRUE )
\r
264 portYIELD_WITHIN_API();
\r
270 /* Ensure the event queues start in the correct state. */
\r
271 vListInitialise( &( pxQueue->xTasksWaitingToSend ) );
\r
272 vListInitialise( &( pxQueue->xTasksWaitingToReceive ) );
\r
275 taskEXIT_CRITICAL();
\r
277 /* A value is returned for calling semantic consistency with previous
\r
281 /*-----------------------------------------------------------*/
\r
283 xQueueHandle xQueueGenericCreate( unsigned portBASE_TYPE uxQueueLength, unsigned portBASE_TYPE uxItemSize, unsigned char ucQueueType )
\r
285 xQUEUE *pxNewQueue;
\r
286 size_t xQueueSizeInBytes;
\r
287 xQueueHandle xReturn = NULL;
\r
289 /* Remove compiler warnings about unused parameters should
\r
290 configUSE_TRACE_FACILITY not be set to 1. */
\r
291 ( void ) ucQueueType;
\r
293 /* Allocate the new queue structure. */
\r
294 if( uxQueueLength > ( unsigned portBASE_TYPE ) 0 )
\r
296 pxNewQueue = ( xQUEUE * ) pvPortMalloc( sizeof( xQUEUE ) );
\r
297 if( pxNewQueue != NULL )
\r
299 /* Create the list of pointers to queue items. The queue is one byte
\r
300 longer than asked for to make wrap checking easier/faster. */
\r
301 xQueueSizeInBytes = ( size_t ) ( uxQueueLength * uxItemSize ) + ( size_t ) 1; /*lint !e961 MISRA exception as the casts are only redundant for some ports. */
\r
303 pxNewQueue->pcHead = ( signed char * ) pvPortMalloc( xQueueSizeInBytes );
\r
304 if( pxNewQueue->pcHead != NULL )
\r
306 /* Initialise the queue members as described above where the
\r
307 queue type is defined. */
\r
308 pxNewQueue->uxLength = uxQueueLength;
\r
309 pxNewQueue->uxItemSize = uxItemSize;
\r
310 ( void ) xQueueGenericReset( pxNewQueue, pdTRUE );
\r
312 #if ( configUSE_TRACE_FACILITY == 1 )
\r
314 pxNewQueue->ucQueueType = ucQueueType;
\r
316 #endif /* configUSE_TRACE_FACILITY */
\r
318 #if( configUSE_QUEUE_SETS == 1 )
\r
320 pxNewQueue->pxQueueSetContainer = NULL;
\r
322 #endif /* configUSE_QUEUE_SETS */
\r
324 traceQUEUE_CREATE( pxNewQueue );
\r
325 xReturn = pxNewQueue;
\r
329 traceQUEUE_CREATE_FAILED( ucQueueType );
\r
330 vPortFree( pxNewQueue );
\r
335 configASSERT( xReturn );
\r
339 /*-----------------------------------------------------------*/
\r
341 #if ( configUSE_MUTEXES == 1 )
\r
343 xQueueHandle xQueueCreateMutex( unsigned char ucQueueType )
\r
345 xQUEUE *pxNewQueue;
\r
347 /* Prevent compiler warnings about unused parameters if
\r
348 configUSE_TRACE_FACILITY does not equal 1. */
\r
349 ( void ) ucQueueType;
\r
351 /* Allocate the new queue structure. */
\r
352 pxNewQueue = ( xQUEUE * ) pvPortMalloc( sizeof( xQUEUE ) );
\r
353 if( pxNewQueue != NULL )
\r
355 /* Information required for priority inheritance. */
\r
356 pxNewQueue->pxMutexHolder = NULL;
\r
357 pxNewQueue->uxQueueType = queueQUEUE_IS_MUTEX;
\r
359 /* Queues used as a mutex no data is actually copied into or out
\r
361 pxNewQueue->pcWriteTo = NULL;
\r
362 pxNewQueue->u.pcReadFrom = NULL;
\r
364 /* Each mutex has a length of 1 (like a binary semaphore) and
\r
365 an item size of 0 as nothing is actually copied into or out
\r
367 pxNewQueue->uxMessagesWaiting = ( unsigned portBASE_TYPE ) 0U;
\r
368 pxNewQueue->uxLength = ( unsigned portBASE_TYPE ) 1U;
\r
369 pxNewQueue->uxItemSize = ( unsigned portBASE_TYPE ) 0U;
\r
370 pxNewQueue->xRxLock = queueUNLOCKED;
\r
371 pxNewQueue->xTxLock = queueUNLOCKED;
\r
373 #if ( configUSE_TRACE_FACILITY == 1 )
\r
375 pxNewQueue->ucQueueType = ucQueueType;
\r
379 #if ( configUSE_QUEUE_SETS == 1 )
\r
381 pxNewQueue->pxQueueSetContainer = NULL;
\r
385 /* Ensure the event queues start with the correct state. */
\r
386 vListInitialise( &( pxNewQueue->xTasksWaitingToSend ) );
\r
387 vListInitialise( &( pxNewQueue->xTasksWaitingToReceive ) );
\r
389 traceCREATE_MUTEX( pxNewQueue );
\r
391 /* Start with the semaphore in the expected state. */
\r
392 ( void ) xQueueGenericSend( pxNewQueue, NULL, ( portTickType ) 0U, queueSEND_TO_BACK );
\r
396 traceCREATE_MUTEX_FAILED();
\r
399 configASSERT( pxNewQueue );
\r
403 #endif /* configUSE_MUTEXES */
\r
404 /*-----------------------------------------------------------*/
\r
406 #if ( ( configUSE_MUTEXES == 1 ) && ( INCLUDE_xSemaphoreGetMutexHolder == 1 ) )
\r
408 void* xQueueGetMutexHolder( xQueueHandle xSemaphore )
\r
412 /* This function is called by xSemaphoreGetMutexHolder(), and should not
\r
413 be called directly. Note: This is is a good way of determining if the
\r
414 calling task is the mutex holder, but not a good way of determining the
\r
415 identity of the mutex holder, as the holder may change between the
\r
416 following critical section exiting and the function returning. */
\r
417 taskENTER_CRITICAL();
\r
419 if( ( ( xQUEUE * ) xSemaphore )->uxQueueType == queueQUEUE_IS_MUTEX )
\r
421 pxReturn = ( void * ) ( ( xQUEUE * ) xSemaphore )->pxMutexHolder;
\r
428 taskEXIT_CRITICAL();
\r
434 /*-----------------------------------------------------------*/
\r
436 #if ( configUSE_RECURSIVE_MUTEXES == 1 )
\r
438 portBASE_TYPE xQueueGiveMutexRecursive( xQueueHandle xMutex )
\r
440 portBASE_TYPE xReturn;
\r
441 xQUEUE * const pxMutex = ( xQUEUE * ) xMutex;
\r
443 configASSERT( pxMutex );
\r
445 /* If this is the task that holds the mutex then pxMutexHolder will not
\r
446 change outside of this task. If this task does not hold the mutex then
\r
447 pxMutexHolder can never coincidentally equal the tasks handle, and as
\r
448 this is the only condition we are interested in it does not matter if
\r
449 pxMutexHolder is accessed simultaneously by another task. Therefore no
\r
450 mutual exclusion is required to test the pxMutexHolder variable. */
\r
451 if( pxMutex->pxMutexHolder == ( void * ) xTaskGetCurrentTaskHandle() ) /*lint !e961 Not a redundant cast as xTaskHandle is a typedef. */
\r
453 traceGIVE_MUTEX_RECURSIVE( pxMutex );
\r
455 /* uxRecursiveCallCount cannot be zero if pxMutexHolder is equal to
\r
456 the task handle, therefore no underflow check is required. Also,
\r
457 uxRecursiveCallCount is only modified by the mutex holder, and as
\r
458 there can only be one, no mutual exclusion is required to modify the
\r
459 uxRecursiveCallCount member. */
\r
460 ( pxMutex->u.uxRecursiveCallCount )--;
\r
462 /* Have we unwound the call count? */
\r
463 if( pxMutex->u.uxRecursiveCallCount == ( unsigned portBASE_TYPE ) 0 )
\r
465 /* Return the mutex. This will automatically unblock any other
\r
466 task that might be waiting to access the mutex. */
\r
467 ( void ) xQueueGenericSend( pxMutex, NULL, queueMUTEX_GIVE_BLOCK_TIME, queueSEND_TO_BACK );
\r
474 /* We cannot give the mutex because we are not the holder. */
\r
477 traceGIVE_MUTEX_RECURSIVE_FAILED( pxMutex );
\r
483 #endif /* configUSE_RECURSIVE_MUTEXES */
\r
484 /*-----------------------------------------------------------*/
\r
486 #if ( configUSE_RECURSIVE_MUTEXES == 1 )
\r
488 portBASE_TYPE xQueueTakeMutexRecursive( xQueueHandle xMutex, portTickType xBlockTime )
\r
490 portBASE_TYPE xReturn;
\r
491 xQUEUE * const pxMutex = ( xQUEUE * ) xMutex;
\r
493 configASSERT( pxMutex );
\r
495 /* Comments regarding mutual exclusion as per those within
\r
496 xQueueGiveMutexRecursive(). */
\r
498 traceTAKE_MUTEX_RECURSIVE( pxMutex );
\r
500 if( pxMutex->pxMutexHolder == ( void * ) xTaskGetCurrentTaskHandle() ) /*lint !e961 Cast is not redundant as xTaskHandle is a typedef. */
\r
502 ( pxMutex->u.uxRecursiveCallCount )++;
\r
507 xReturn = xQueueGenericReceive( pxMutex, NULL, xBlockTime, pdFALSE );
\r
509 /* pdPASS will only be returned if we successfully obtained the mutex,
\r
510 we may have blocked to reach here. */
\r
511 if( xReturn == pdPASS )
\r
513 ( pxMutex->u.uxRecursiveCallCount )++;
\r
517 traceTAKE_MUTEX_RECURSIVE_FAILED( pxMutex );
\r
524 #endif /* configUSE_RECURSIVE_MUTEXES */
\r
525 /*-----------------------------------------------------------*/
\r
527 #if ( configUSE_COUNTING_SEMAPHORES == 1 )
\r
529 xQueueHandle xQueueCreateCountingSemaphore( unsigned portBASE_TYPE uxCountValue, unsigned portBASE_TYPE uxInitialCount )
\r
531 xQueueHandle xHandle;
\r
533 xHandle = xQueueGenericCreate( uxCountValue, queueSEMAPHORE_QUEUE_ITEM_LENGTH, queueQUEUE_TYPE_COUNTING_SEMAPHORE );
\r
535 if( xHandle != NULL )
\r
537 ( ( xQUEUE * ) xHandle )->uxMessagesWaiting = uxInitialCount;
\r
539 traceCREATE_COUNTING_SEMAPHORE();
\r
543 traceCREATE_COUNTING_SEMAPHORE_FAILED();
\r
546 configASSERT( xHandle );
\r
550 #endif /* configUSE_COUNTING_SEMAPHORES */
\r
551 /*-----------------------------------------------------------*/
\r
553 signed portBASE_TYPE xQueueGenericSend( xQueueHandle xQueue, const void * const pvItemToQueue, portTickType xTicksToWait, portBASE_TYPE xCopyPosition )
\r
555 signed portBASE_TYPE xEntryTimeSet = pdFALSE;
\r
556 xTimeOutType xTimeOut;
\r
557 xQUEUE * const pxQueue = ( xQUEUE * ) xQueue;
\r
559 configASSERT( pxQueue );
\r
560 configASSERT( !( ( pvItemToQueue == NULL ) && ( pxQueue->uxItemSize != ( unsigned portBASE_TYPE ) 0U ) ) );
\r
561 configASSERT( !( ( xCopyPosition == queueOVERWRITE ) && ( pxQueue->uxLength != 1 ) ) );
\r
563 /* This function relaxes the coding standard somewhat to allow return
\r
564 statements within the function itself. This is done in the interest
\r
565 of execution time efficiency. */
\r
568 taskENTER_CRITICAL();
\r
570 /* Is there room on the queue now? The running task must be
\r
571 the highest priority task wanting to access the queue. If
\r
572 the head item in the queue is to be overwritten then it does
\r
573 not matter if the queue is full. */
\r
574 if( ( pxQueue->uxMessagesWaiting < pxQueue->uxLength ) || ( xCopyPosition == queueOVERWRITE ) )
\r
576 traceQUEUE_SEND( pxQueue );
\r
577 prvCopyDataToQueue( pxQueue, pvItemToQueue, xCopyPosition );
\r
579 #if ( configUSE_QUEUE_SETS == 1 )
\r
581 if( pxQueue->pxQueueSetContainer != NULL )
\r
583 if( prvNotifyQueueSetContainer( pxQueue, xCopyPosition ) == pdTRUE )
\r
585 /* The queue is a member of a queue set, and posting
\r
586 to the queue set caused a higher priority task to
\r
587 unblock. A context switch is required. */
\r
588 portYIELD_WITHIN_API();
\r
593 /* If there was a task waiting for data to arrive on the
\r
594 queue then unblock it now. */
\r
595 if( listLIST_IS_EMPTY( &( pxQueue->xTasksWaitingToReceive ) ) == pdFALSE )
\r
597 if( xTaskRemoveFromEventList( &( pxQueue->xTasksWaitingToReceive ) ) == pdTRUE )
\r
599 /* The unblocked task has a priority higher than
\r
600 our own so yield immediately. Yes it is ok to
\r
601 do this from within the critical section - the
\r
602 kernel takes care of that. */
\r
603 portYIELD_WITHIN_API();
\r
608 #else /* configUSE_QUEUE_SETS */
\r
610 /* If there was a task waiting for data to arrive on the
\r
611 queue then unblock it now. */
\r
612 if( listLIST_IS_EMPTY( &( pxQueue->xTasksWaitingToReceive ) ) == pdFALSE )
\r
614 if( xTaskRemoveFromEventList( &( pxQueue->xTasksWaitingToReceive ) ) == pdTRUE )
\r
616 /* The unblocked task has a priority higher than
\r
617 our own so yield immediately. Yes it is ok to do
\r
618 this from within the critical section - the kernel
\r
619 takes care of that. */
\r
620 portYIELD_WITHIN_API();
\r
624 #endif /* configUSE_QUEUE_SETS */
\r
626 taskEXIT_CRITICAL();
\r
628 /* Return to the original privilege level before exiting the
\r
634 if( xTicksToWait == ( portTickType ) 0 )
\r
636 /* The queue was full and no block time is specified (or
\r
637 the block time has expired) so leave now. */
\r
638 taskEXIT_CRITICAL();
\r
640 /* Return to the original privilege level before exiting
\r
642 traceQUEUE_SEND_FAILED( pxQueue );
\r
643 return errQUEUE_FULL;
\r
645 else if( xEntryTimeSet == pdFALSE )
\r
647 /* The queue was full and a block time was specified so
\r
648 configure the timeout structure. */
\r
649 vTaskSetTimeOutState( &xTimeOut );
\r
650 xEntryTimeSet = pdTRUE;
\r
654 /* Entry time was already set. */
\r
658 taskEXIT_CRITICAL();
\r
660 /* Interrupts and other tasks can send to and receive from the queue
\r
661 now the critical section has been exited. */
\r
664 prvLockQueue( pxQueue );
\r
666 /* Update the timeout state to see if it has expired yet. */
\r
667 if( xTaskCheckForTimeOut( &xTimeOut, &xTicksToWait ) == pdFALSE )
\r
669 if( prvIsQueueFull( pxQueue ) != pdFALSE )
\r
671 traceBLOCKING_ON_QUEUE_SEND( pxQueue );
\r
672 vTaskPlaceOnEventList( &( pxQueue->xTasksWaitingToSend ), xTicksToWait );
\r
674 /* Unlocking the queue means queue events can effect the
\r
675 event list. It is possible that interrupts occurring now
\r
676 remove this task from the event list again - but as the
\r
677 scheduler is suspended the task will go onto the pending
\r
678 ready last instead of the actual ready list. */
\r
679 prvUnlockQueue( pxQueue );
\r
681 /* Resuming the scheduler will move tasks from the pending
\r
682 ready list into the ready list - so it is feasible that this
\r
683 task is already in a ready list before it yields - in which
\r
684 case the yield will not cause a context switch unless there
\r
685 is also a higher priority task in the pending ready list. */
\r
686 if( xTaskResumeAll() == pdFALSE )
\r
688 portYIELD_WITHIN_API();
\r
694 prvUnlockQueue( pxQueue );
\r
695 ( void ) xTaskResumeAll();
\r
700 /* The timeout has expired. */
\r
701 prvUnlockQueue( pxQueue );
\r
702 ( void ) xTaskResumeAll();
\r
704 /* Return to the original privilege level before exiting the
\r
706 traceQUEUE_SEND_FAILED( pxQueue );
\r
707 return errQUEUE_FULL;
\r
711 /*-----------------------------------------------------------*/
\r
713 #if ( configUSE_ALTERNATIVE_API == 1 )
\r
715 signed portBASE_TYPE xQueueAltGenericSend( xQueueHandle xQueue, const void * const pvItemToQueue, portTickType xTicksToWait, portBASE_TYPE xCopyPosition )
\r
717 signed portBASE_TYPE xEntryTimeSet = pdFALSE;
\r
718 xTimeOutType xTimeOut;
\r
719 xQUEUE * const pxQueue = ( xQUEUE * ) xQueue;
\r
721 configASSERT( pxQueue );
\r
722 configASSERT( !( ( pvItemToQueue == NULL ) && ( pxQueue->uxItemSize != ( unsigned portBASE_TYPE ) 0U ) ) );
\r
726 taskENTER_CRITICAL();
\r
728 /* Is there room on the queue now? To be running we must be
\r
729 the highest priority task wanting to access the queue. */
\r
730 if( pxQueue->uxMessagesWaiting < pxQueue->uxLength )
\r
732 traceQUEUE_SEND( pxQueue );
\r
733 prvCopyDataToQueue( pxQueue, pvItemToQueue, xCopyPosition );
\r
735 /* If there was a task waiting for data to arrive on the
\r
736 queue then unblock it now. */
\r
737 if( listLIST_IS_EMPTY( &( pxQueue->xTasksWaitingToReceive ) ) == pdFALSE )
\r
739 if( xTaskRemoveFromEventList( &( pxQueue->xTasksWaitingToReceive ) ) == pdTRUE )
\r
741 /* The unblocked task has a priority higher than
\r
742 our own so yield immediately. */
\r
743 portYIELD_WITHIN_API();
\r
747 taskEXIT_CRITICAL();
\r
752 if( xTicksToWait == ( portTickType ) 0 )
\r
754 taskEXIT_CRITICAL();
\r
755 return errQUEUE_FULL;
\r
757 else if( xEntryTimeSet == pdFALSE )
\r
759 vTaskSetTimeOutState( &xTimeOut );
\r
760 xEntryTimeSet = pdTRUE;
\r
764 taskEXIT_CRITICAL();
\r
766 taskENTER_CRITICAL();
\r
768 if( xTaskCheckForTimeOut( &xTimeOut, &xTicksToWait ) == pdFALSE )
\r
770 if( prvIsQueueFull( pxQueue ) != pdFALSE )
\r
772 traceBLOCKING_ON_QUEUE_SEND( pxQueue );
\r
773 vTaskPlaceOnEventList( &( pxQueue->xTasksWaitingToSend ), xTicksToWait );
\r
774 portYIELD_WITHIN_API();
\r
779 taskEXIT_CRITICAL();
\r
780 traceQUEUE_SEND_FAILED( pxQueue );
\r
781 return errQUEUE_FULL;
\r
784 taskEXIT_CRITICAL();
\r
788 #endif /* configUSE_ALTERNATIVE_API */
\r
789 /*-----------------------------------------------------------*/
\r
791 #if ( configUSE_ALTERNATIVE_API == 1 )
\r
793 signed portBASE_TYPE xQueueAltGenericReceive( xQueueHandle xQueue, void * const pvBuffer, portTickType xTicksToWait, portBASE_TYPE xJustPeeking )
\r
795 signed portBASE_TYPE xEntryTimeSet = pdFALSE;
\r
796 xTimeOutType xTimeOut;
\r
797 signed char *pcOriginalReadPosition;
\r
798 xQUEUE * const pxQueue = ( xQUEUE * ) xQueue;
\r
800 configASSERT( pxQueue );
\r
801 configASSERT( !( ( pvBuffer == NULL ) && ( pxQueue->uxItemSize != ( unsigned portBASE_TYPE ) 0U ) ) );
\r
805 taskENTER_CRITICAL();
\r
807 if( pxQueue->uxMessagesWaiting > ( unsigned portBASE_TYPE ) 0 )
\r
809 /* Remember our read position in case we are just peeking. */
\r
810 pcOriginalReadPosition = pxQueue->u.pcReadFrom;
\r
812 prvCopyDataFromQueue( pxQueue, pvBuffer );
\r
814 if( xJustPeeking == pdFALSE )
\r
816 traceQUEUE_RECEIVE( pxQueue );
\r
818 /* Data is actually being removed (not just peeked). */
\r
819 --( pxQueue->uxMessagesWaiting );
\r
821 #if ( configUSE_MUTEXES == 1 )
\r
823 if( pxQueue->uxQueueType == queueQUEUE_IS_MUTEX )
\r
825 /* Record the information required to implement
\r
826 priority inheritance should it become necessary. */
\r
827 pxQueue->pxMutexHolder = ( signed char * ) xTaskGetCurrentTaskHandle();
\r
832 if( listLIST_IS_EMPTY( &( pxQueue->xTasksWaitingToSend ) ) == pdFALSE )
\r
834 if( xTaskRemoveFromEventList( &( pxQueue->xTasksWaitingToSend ) ) == pdTRUE )
\r
836 portYIELD_WITHIN_API();
\r
842 traceQUEUE_PEEK( pxQueue );
\r
844 /* We are not removing the data, so reset our read
\r
846 pxQueue->u.pcReadFrom = pcOriginalReadPosition;
\r
848 /* The data is being left in the queue, so see if there are
\r
849 any other tasks waiting for the data. */
\r
850 if( listLIST_IS_EMPTY( &( pxQueue->xTasksWaitingToReceive ) ) == pdFALSE )
\r
852 /* Tasks that are removed from the event list will get added to
\r
853 the pending ready list as the scheduler is still suspended. */
\r
854 if( xTaskRemoveFromEventList( &( pxQueue->xTasksWaitingToReceive ) ) != pdFALSE )
\r
856 /* The task waiting has a higher priority than this task. */
\r
857 portYIELD_WITHIN_API();
\r
863 taskEXIT_CRITICAL();
\r
868 if( xTicksToWait == ( portTickType ) 0 )
\r
870 taskEXIT_CRITICAL();
\r
871 traceQUEUE_RECEIVE_FAILED( pxQueue );
\r
872 return errQUEUE_EMPTY;
\r
874 else if( xEntryTimeSet == pdFALSE )
\r
876 vTaskSetTimeOutState( &xTimeOut );
\r
877 xEntryTimeSet = pdTRUE;
\r
881 taskEXIT_CRITICAL();
\r
883 taskENTER_CRITICAL();
\r
885 if( xTaskCheckForTimeOut( &xTimeOut, &xTicksToWait ) == pdFALSE )
\r
887 if( prvIsQueueEmpty( pxQueue ) != pdFALSE )
\r
889 traceBLOCKING_ON_QUEUE_RECEIVE( pxQueue );
\r
891 #if ( configUSE_MUTEXES == 1 )
\r
893 if( pxQueue->uxQueueType == queueQUEUE_IS_MUTEX )
\r
895 portENTER_CRITICAL();
\r
897 vTaskPriorityInherit( ( void * ) pxQueue->pxMutexHolder );
\r
899 portEXIT_CRITICAL();
\r
904 vTaskPlaceOnEventList( &( pxQueue->xTasksWaitingToReceive ), xTicksToWait );
\r
905 portYIELD_WITHIN_API();
\r
910 taskEXIT_CRITICAL();
\r
911 traceQUEUE_RECEIVE_FAILED( pxQueue );
\r
912 return errQUEUE_EMPTY;
\r
915 taskEXIT_CRITICAL();
\r
920 #endif /* configUSE_ALTERNATIVE_API */
\r
921 /*-----------------------------------------------------------*/
\r
923 signed portBASE_TYPE xQueueGenericSendFromISR( xQueueHandle xQueue, const void * const pvItemToQueue, signed portBASE_TYPE *pxHigherPriorityTaskWoken, portBASE_TYPE xCopyPosition )
\r
925 signed portBASE_TYPE xReturn;
\r
926 unsigned portBASE_TYPE uxSavedInterruptStatus;
\r
927 xQUEUE * const pxQueue = ( xQUEUE * ) xQueue;
\r
929 configASSERT( pxQueue );
\r
930 configASSERT( !( ( pvItemToQueue == NULL ) && ( pxQueue->uxItemSize != ( unsigned portBASE_TYPE ) 0U ) ) );
\r
931 configASSERT( !( ( xCopyPosition == queueOVERWRITE ) && ( pxQueue->uxLength != 1 ) ) );
\r
933 /* RTOS ports that support interrupt nesting have the concept of a maximum
\r
934 system call (or maximum API call) interrupt priority. Interrupts that are
\r
935 above the maximum system call priority are keep permanently enabled, even
\r
936 when the RTOS kernel is in a critical section, but cannot make any calls to
\r
937 FreeRTOS API functions. If configASSERT() is defined in FreeRTOSConfig.h
\r
938 then portASSERT_IF_INTERRUPT_PRIORITY_INVALID() will result in an assertion
\r
939 failure if a FreeRTOS API function is called from an interrupt that has been
\r
940 assigned a priority above the configured maximum system call priority.
\r
941 Only FreeRTOS functions that end in FromISR can be called from interrupts
\r
942 that have been assigned a priority at or (logically) below the maximum
\r
943 system call interrupt priority. FreeRTOS maintains a separate interrupt
\r
944 safe API to ensure interrupt entry is as fast and as simple as possible.
\r
945 More information (albeit Cortex-M specific) is provided on the following
\r
946 link: http://www.freertos.org/RTOS-Cortex-M3-M4.html */
\r
947 portASSERT_IF_INTERRUPT_PRIORITY_INVALID();
\r
949 /* Similar to xQueueGenericSend, except we don't block if there is no room
\r
950 in the queue. Also we don't directly wake a task that was blocked on a
\r
951 queue read, instead we return a flag to say whether a context switch is
\r
952 required or not (i.e. has a task with a higher priority than us been woken
\r
954 uxSavedInterruptStatus = portSET_INTERRUPT_MASK_FROM_ISR();
\r
956 if( ( pxQueue->uxMessagesWaiting < pxQueue->uxLength ) || ( xCopyPosition == queueOVERWRITE ) )
\r
958 traceQUEUE_SEND_FROM_ISR( pxQueue );
\r
960 prvCopyDataToQueue( pxQueue, pvItemToQueue, xCopyPosition );
\r
962 /* If the queue is locked we do not alter the event list. This will
\r
963 be done when the queue is unlocked later. */
\r
964 if( pxQueue->xTxLock == queueUNLOCKED )
\r
966 #if ( configUSE_QUEUE_SETS == 1 )
\r
968 if( pxQueue->pxQueueSetContainer != NULL )
\r
970 if( prvNotifyQueueSetContainer( pxQueue, xCopyPosition ) == pdTRUE )
\r
972 /* The queue is a member of a queue set, and posting
\r
973 to the queue set caused a higher priority task to
\r
974 unblock. A context switch is required. */
\r
975 if( pxHigherPriorityTaskWoken != NULL )
\r
977 *pxHigherPriorityTaskWoken = pdTRUE;
\r
983 if( listLIST_IS_EMPTY( &( pxQueue->xTasksWaitingToReceive ) ) == pdFALSE )
\r
985 if( xTaskRemoveFromEventList( &( pxQueue->xTasksWaitingToReceive ) ) != pdFALSE )
\r
987 /* The task waiting has a higher priority so record that a
\r
988 context switch is required. */
\r
989 if( pxHigherPriorityTaskWoken != NULL )
\r
991 *pxHigherPriorityTaskWoken = pdTRUE;
\r
997 #else /* configUSE_QUEUE_SETS */
\r
999 if( listLIST_IS_EMPTY( &( pxQueue->xTasksWaitingToReceive ) ) == pdFALSE )
\r
1001 if( xTaskRemoveFromEventList( &( pxQueue->xTasksWaitingToReceive ) ) != pdFALSE )
\r
1003 /* The task waiting has a higher priority so record that a
\r
1004 context switch is required. */
\r
1005 if( pxHigherPriorityTaskWoken != NULL )
\r
1007 *pxHigherPriorityTaskWoken = pdTRUE;
\r
1012 #endif /* configUSE_QUEUE_SETS */
\r
1016 /* Increment the lock count so the task that unlocks the queue
\r
1017 knows that data was posted while it was locked. */
\r
1018 ++( pxQueue->xTxLock );
\r
1025 traceQUEUE_SEND_FROM_ISR_FAILED( pxQueue );
\r
1026 xReturn = errQUEUE_FULL;
\r
1029 portCLEAR_INTERRUPT_MASK_FROM_ISR( uxSavedInterruptStatus );
\r
1033 /*-----------------------------------------------------------*/
\r
1035 signed portBASE_TYPE xQueueGenericReceive( xQueueHandle xQueue, const void * const pvBuffer, portTickType xTicksToWait, portBASE_TYPE xJustPeeking )
\r
1037 signed portBASE_TYPE xEntryTimeSet = pdFALSE;
\r
1038 xTimeOutType xTimeOut;
\r
1039 signed char *pcOriginalReadPosition;
\r
1040 xQUEUE * const pxQueue = ( xQUEUE * ) xQueue;
\r
1042 configASSERT( pxQueue );
\r
1043 configASSERT( !( ( pvBuffer == NULL ) && ( pxQueue->uxItemSize != ( unsigned portBASE_TYPE ) 0U ) ) );
\r
1045 /* This function relaxes the coding standard somewhat to allow return
\r
1046 statements within the function itself. This is done in the interest
\r
1047 of execution time efficiency. */
\r
1051 taskENTER_CRITICAL();
\r
1053 /* Is there data in the queue now? To be running we must be
\r
1054 the highest priority task wanting to access the queue. */
\r
1055 if( pxQueue->uxMessagesWaiting > ( unsigned portBASE_TYPE ) 0 )
\r
1057 /* Remember the read position in case the queue is only being
\r
1059 pcOriginalReadPosition = pxQueue->u.pcReadFrom;
\r
1061 prvCopyDataFromQueue( pxQueue, pvBuffer );
\r
1063 if( xJustPeeking == pdFALSE )
\r
1065 traceQUEUE_RECEIVE( pxQueue );
\r
1067 /* Actually removing data, not just peeking. */
\r
1068 --( pxQueue->uxMessagesWaiting );
\r
1070 #if ( configUSE_MUTEXES == 1 )
\r
1072 if( pxQueue->uxQueueType == queueQUEUE_IS_MUTEX )
\r
1074 /* Record the information required to implement
\r
1075 priority inheritance should it become necessary. */
\r
1076 pxQueue->pxMutexHolder = ( signed char * ) xTaskGetCurrentTaskHandle(); /*lint !e961 Cast is not redundant as xTaskHandle is a typedef. */
\r
1081 if( listLIST_IS_EMPTY( &( pxQueue->xTasksWaitingToSend ) ) == pdFALSE )
\r
1083 if( xTaskRemoveFromEventList( &( pxQueue->xTasksWaitingToSend ) ) == pdTRUE )
\r
1085 portYIELD_WITHIN_API();
\r
1091 traceQUEUE_PEEK( pxQueue );
\r
1093 /* The data is not being removed, so reset the read
\r
1095 pxQueue->u.pcReadFrom = pcOriginalReadPosition;
\r
1097 /* The data is being left in the queue, so see if there are
\r
1098 any other tasks waiting for the data. */
\r
1099 if( listLIST_IS_EMPTY( &( pxQueue->xTasksWaitingToReceive ) ) == pdFALSE )
\r
1101 /* Tasks that are removed from the event list will get added to
\r
1102 the pending ready list as the scheduler is still suspended. */
\r
1103 if( xTaskRemoveFromEventList( &( pxQueue->xTasksWaitingToReceive ) ) != pdFALSE )
\r
1105 /* The task waiting has a higher priority than this task. */
\r
1106 portYIELD_WITHIN_API();
\r
1111 taskEXIT_CRITICAL();
\r
1116 if( xTicksToWait == ( portTickType ) 0 )
\r
1118 /* The queue was empty and no block time is specified (or
\r
1119 the block time has expired) so leave now. */
\r
1120 taskEXIT_CRITICAL();
\r
1121 traceQUEUE_RECEIVE_FAILED( pxQueue );
\r
1122 return errQUEUE_EMPTY;
\r
1124 else if( xEntryTimeSet == pdFALSE )
\r
1126 /* The queue was empty and a block time was specified so
\r
1127 configure the timeout structure. */
\r
1128 vTaskSetTimeOutState( &xTimeOut );
\r
1129 xEntryTimeSet = pdTRUE;
\r
1133 /* Entry time was already set. */
\r
1137 taskEXIT_CRITICAL();
\r
1139 /* Interrupts and other tasks can send to and receive from the queue
\r
1140 now the critical section has been exited. */
\r
1142 vTaskSuspendAll();
\r
1143 prvLockQueue( pxQueue );
\r
1145 /* Update the timeout state to see if it has expired yet. */
\r
1146 if( xTaskCheckForTimeOut( &xTimeOut, &xTicksToWait ) == pdFALSE )
\r
1148 if( prvIsQueueEmpty( pxQueue ) != pdFALSE )
\r
1150 traceBLOCKING_ON_QUEUE_RECEIVE( pxQueue );
\r
1152 #if ( configUSE_MUTEXES == 1 )
\r
1154 if( pxQueue->uxQueueType == queueQUEUE_IS_MUTEX )
\r
1156 portENTER_CRITICAL();
\r
1158 vTaskPriorityInherit( ( void * ) pxQueue->pxMutexHolder );
\r
1160 portEXIT_CRITICAL();
\r
1165 vTaskPlaceOnEventList( &( pxQueue->xTasksWaitingToReceive ), xTicksToWait );
\r
1166 prvUnlockQueue( pxQueue );
\r
1167 if( xTaskResumeAll() == pdFALSE )
\r
1169 portYIELD_WITHIN_API();
\r
1175 prvUnlockQueue( pxQueue );
\r
1176 ( void ) xTaskResumeAll();
\r
1181 prvUnlockQueue( pxQueue );
\r
1182 ( void ) xTaskResumeAll();
\r
1183 traceQUEUE_RECEIVE_FAILED( pxQueue );
\r
1184 return errQUEUE_EMPTY;
\r
1188 /*-----------------------------------------------------------*/
\r
1190 signed portBASE_TYPE xQueueReceiveFromISR( xQueueHandle xQueue, const void * const pvBuffer, signed portBASE_TYPE *pxHigherPriorityTaskWoken )
\r
1192 signed portBASE_TYPE xReturn;
\r
1193 unsigned portBASE_TYPE uxSavedInterruptStatus;
\r
1194 xQUEUE * const pxQueue = ( xQUEUE * ) xQueue;
\r
1196 configASSERT( pxQueue );
\r
1197 configASSERT( !( ( pvBuffer == NULL ) && ( pxQueue->uxItemSize != ( unsigned portBASE_TYPE ) 0U ) ) );
\r
1199 /* RTOS ports that support interrupt nesting have the concept of a maximum
\r
1200 system call (or maximum API call) interrupt priority. Interrupts that are
\r
1201 above the maximum system call priority are keep permanently enabled, even
\r
1202 when the RTOS kernel is in a critical section, but cannot make any calls to
\r
1203 FreeRTOS API functions. If configASSERT() is defined in FreeRTOSConfig.h
\r
1204 then portASSERT_IF_INTERRUPT_PRIORITY_INVALID() will result in an assertion
\r
1205 failure if a FreeRTOS API function is called from an interrupt that has been
\r
1206 assigned a priority above the configured maximum system call priority.
\r
1207 Only FreeRTOS functions that end in FromISR can be called from interrupts
\r
1208 that have been assigned a priority at or (logically) below the maximum
\r
1209 system call interrupt priority. FreeRTOS maintains a separate interrupt
\r
1210 safe API to ensure interrupt entry is as fast and as simple as possible.
\r
1211 More information (albeit Cortex-M specific) is provided on the following
\r
1212 link: http://www.freertos.org/RTOS-Cortex-M3-M4.html */
\r
1213 portASSERT_IF_INTERRUPT_PRIORITY_INVALID();
\r
1215 uxSavedInterruptStatus = portSET_INTERRUPT_MASK_FROM_ISR();
\r
1217 /* Cannot block in an ISR, so check there is data available. */
\r
1218 if( pxQueue->uxMessagesWaiting > ( unsigned portBASE_TYPE ) 0 )
\r
1220 traceQUEUE_RECEIVE_FROM_ISR( pxQueue );
\r
1222 prvCopyDataFromQueue( pxQueue, pvBuffer );
\r
1223 --( pxQueue->uxMessagesWaiting );
\r
1225 /* If the queue is locked the event list will not be modified.
\r
1226 Instead update the lock count so the task that unlocks the queue
\r
1227 will know that an ISR has removed data while the queue was
\r
1229 if( pxQueue->xRxLock == queueUNLOCKED )
\r
1231 if( listLIST_IS_EMPTY( &( pxQueue->xTasksWaitingToSend ) ) == pdFALSE )
\r
1233 if( xTaskRemoveFromEventList( &( pxQueue->xTasksWaitingToSend ) ) != pdFALSE )
\r
1235 /* The task waiting has a higher priority than us so
\r
1236 force a context switch. */
\r
1237 if( pxHigherPriorityTaskWoken != NULL )
\r
1239 *pxHigherPriorityTaskWoken = pdTRUE;
\r
1246 /* Increment the lock count so the task that unlocks the queue
\r
1247 knows that data was removed while it was locked. */
\r
1248 ++( pxQueue->xRxLock );
\r
1256 traceQUEUE_RECEIVE_FROM_ISR_FAILED( pxQueue );
\r
1259 portCLEAR_INTERRUPT_MASK_FROM_ISR( uxSavedInterruptStatus );
\r
1263 /*-----------------------------------------------------------*/
\r
1265 signed portBASE_TYPE xQueuePeekFromISR( xQueueHandle xQueue, const void * const pvBuffer )
\r
1267 signed portBASE_TYPE xReturn;
\r
1268 unsigned portBASE_TYPE uxSavedInterruptStatus;
\r
1269 signed char *pcOriginalReadPosition;
\r
1270 xQUEUE * const pxQueue = ( xQUEUE * ) xQueue;
\r
1272 configASSERT( pxQueue );
\r
1273 configASSERT( !( ( pvBuffer == NULL ) && ( pxQueue->uxItemSize != ( unsigned portBASE_TYPE ) 0U ) ) );
\r
1275 /* RTOS ports that support interrupt nesting have the concept of a maximum
\r
1276 system call (or maximum API call) interrupt priority. Interrupts that are
\r
1277 above the maximum system call priority are keep permanently enabled, even
\r
1278 when the RTOS kernel is in a critical section, but cannot make any calls to
\r
1279 FreeRTOS API functions. If configASSERT() is defined in FreeRTOSConfig.h
\r
1280 then portASSERT_IF_INTERRUPT_PRIORITY_INVALID() will result in an assertion
\r
1281 failure if a FreeRTOS API function is called from an interrupt that has been
\r
1282 assigned a priority above the configured maximum system call priority.
\r
1283 Only FreeRTOS functions that end in FromISR can be called from interrupts
\r
1284 that have been assigned a priority at or (logically) below the maximum
\r
1285 system call interrupt priority. FreeRTOS maintains a separate interrupt
\r
1286 safe API to ensure interrupt entry is as fast and as simple as possible.
\r
1287 More information (albeit Cortex-M specific) is provided on the following
\r
1288 link: http://www.freertos.org/RTOS-Cortex-M3-M4.html */
\r
1289 portASSERT_IF_INTERRUPT_PRIORITY_INVALID();
\r
1291 uxSavedInterruptStatus = portSET_INTERRUPT_MASK_FROM_ISR();
\r
1293 /* Cannot block in an ISR, so check there is data available. */
\r
1294 if( pxQueue->uxMessagesWaiting > ( unsigned portBASE_TYPE ) 0 )
\r
1296 traceQUEUE_PEEK_FROM_ISR( pxQueue );
\r
1298 /* Remember the read position so it can be reset as nothing is
\r
1299 actually being removed from the queue. */
\r
1300 pcOriginalReadPosition = pxQueue->u.pcReadFrom;
\r
1301 prvCopyDataFromQueue( pxQueue, pvBuffer );
\r
1302 pxQueue->u.pcReadFrom = pcOriginalReadPosition;
\r
1309 traceQUEUE_PEEK_FROM_ISR_FAILED( pxQueue );
\r
1312 portCLEAR_INTERRUPT_MASK_FROM_ISR( uxSavedInterruptStatus );
\r
1316 /*-----------------------------------------------------------*/
\r
1318 unsigned portBASE_TYPE uxQueueMessagesWaiting( const xQueueHandle xQueue )
\r
1320 unsigned portBASE_TYPE uxReturn;
\r
1322 configASSERT( xQueue );
\r
1324 taskENTER_CRITICAL();
\r
1325 uxReturn = ( ( xQUEUE * ) xQueue )->uxMessagesWaiting;
\r
1326 taskEXIT_CRITICAL();
\r
1329 } /*lint !e818 Pointer cannot be declared const as xQueue is a typedef not pointer. */
\r
1330 /*-----------------------------------------------------------*/
\r
1332 unsigned portBASE_TYPE uxQueueSpacesAvailable( const xQueueHandle xQueue )
\r
1334 unsigned portBASE_TYPE uxReturn;
\r
1337 pxQueue = ( xQUEUE * ) xQueue;
\r
1338 configASSERT( pxQueue );
\r
1340 taskENTER_CRITICAL();
\r
1341 uxReturn = pxQueue->uxLength - pxQueue->uxMessagesWaiting;
\r
1342 taskEXIT_CRITICAL();
\r
1345 } /*lint !e818 Pointer cannot be declared const as xQueue is a typedef not pointer. */
\r
1346 /*-----------------------------------------------------------*/
\r
1348 unsigned portBASE_TYPE uxQueueMessagesWaitingFromISR( const xQueueHandle xQueue )
\r
1350 unsigned portBASE_TYPE uxReturn;
\r
1352 configASSERT( xQueue );
\r
1354 uxReturn = ( ( xQUEUE * ) xQueue )->uxMessagesWaiting;
\r
1357 } /*lint !e818 Pointer cannot be declared const as xQueue is a typedef not pointer. */
\r
1358 /*-----------------------------------------------------------*/
\r
1360 void vQueueDelete( xQueueHandle xQueue )
\r
1362 xQUEUE * const pxQueue = ( xQUEUE * ) xQueue;
\r
1364 configASSERT( pxQueue );
\r
1366 traceQUEUE_DELETE( pxQueue );
\r
1367 #if ( configQUEUE_REGISTRY_SIZE > 0 )
\r
1369 vQueueUnregisterQueue( pxQueue );
\r
1372 vPortFree( pxQueue->pcHead );
\r
1373 vPortFree( pxQueue );
\r
1375 /*-----------------------------------------------------------*/
\r
1377 #if ( configUSE_TRACE_FACILITY == 1 )
\r
1379 unsigned char ucQueueGetQueueNumber( xQueueHandle xQueue )
\r
1381 return ( ( xQUEUE * ) xQueue )->ucQueueNumber;
\r
1384 #endif /* configUSE_TRACE_FACILITY */
\r
1385 /*-----------------------------------------------------------*/
\r
1387 #if ( configUSE_TRACE_FACILITY == 1 )
\r
1389 void vQueueSetQueueNumber( xQueueHandle xQueue, unsigned char ucQueueNumber )
\r
1391 ( ( xQUEUE * ) xQueue )->ucQueueNumber = ucQueueNumber;
\r
1394 #endif /* configUSE_TRACE_FACILITY */
\r
1395 /*-----------------------------------------------------------*/
\r
1397 #if ( configUSE_TRACE_FACILITY == 1 )
\r
1399 unsigned char ucQueueGetQueueType( xQueueHandle xQueue )
\r
1401 return ( ( xQUEUE * ) xQueue )->ucQueueType;
\r
1404 #endif /* configUSE_TRACE_FACILITY */
\r
1405 /*-----------------------------------------------------------*/
\r
1407 static void prvCopyDataToQueue( xQUEUE *pxQueue, const void *pvItemToQueue, portBASE_TYPE xPosition )
\r
1409 if( pxQueue->uxItemSize == ( unsigned portBASE_TYPE ) 0 )
\r
1411 #if ( configUSE_MUTEXES == 1 )
\r
1413 if( pxQueue->uxQueueType == queueQUEUE_IS_MUTEX )
\r
1415 /* The mutex is no longer being held. */
\r
1416 vTaskPriorityDisinherit( ( void * ) pxQueue->pxMutexHolder );
\r
1417 pxQueue->pxMutexHolder = NULL;
\r
1420 #endif /* configUSE_MUTEXES */
\r
1422 else if( xPosition == queueSEND_TO_BACK )
\r
1424 ( void ) memcpy( ( void * ) pxQueue->pcWriteTo, pvItemToQueue, ( size_t ) pxQueue->uxItemSize ); /*lint !e961 !e418 MISRA exception as the casts are only redundant for some ports, plus previous logic ensures a null pointer can only be passed to memcpy() if the copy size is 0. */
\r
1425 pxQueue->pcWriteTo += pxQueue->uxItemSize;
\r
1426 if( pxQueue->pcWriteTo >= pxQueue->pcTail ) /*lint !e946 MISRA exception justified as comparison of pointers is the cleanest solution. */
\r
1428 pxQueue->pcWriteTo = pxQueue->pcHead;
\r
1433 ( void ) memcpy( ( void * ) pxQueue->u.pcReadFrom, pvItemToQueue, ( size_t ) pxQueue->uxItemSize ); /*lint !e961 MISRA exception as the casts are only redundant for some ports. */
\r
1434 pxQueue->u.pcReadFrom -= pxQueue->uxItemSize;
\r
1435 if( pxQueue->u.pcReadFrom < pxQueue->pcHead ) /*lint !e946 MISRA exception justified as comparison of pointers is the cleanest solution. */
\r
1437 pxQueue->u.pcReadFrom = ( pxQueue->pcTail - pxQueue->uxItemSize );
\r
1440 if( xPosition == queueOVERWRITE )
\r
1442 if( pxQueue->uxMessagesWaiting > ( unsigned portBASE_TYPE ) 0 )
\r
1444 /* An item is not being added but overwritten, so subtract
\r
1445 one from the recorded number of items in the queue so when
\r
1446 one is added again below the number of recorded items remains
\r
1448 --( pxQueue->uxMessagesWaiting );
\r
1453 ++( pxQueue->uxMessagesWaiting );
\r
1455 /*-----------------------------------------------------------*/
\r
1457 static void prvCopyDataFromQueue( xQUEUE * const pxQueue, const void * const pvBuffer )
\r
1459 if( pxQueue->uxQueueType != queueQUEUE_IS_MUTEX )
\r
1461 pxQueue->u.pcReadFrom += pxQueue->uxItemSize;
\r
1462 if( pxQueue->u.pcReadFrom >= pxQueue->pcTail ) /*lint !e946 MISRA exception justified as use of the relational operator is the cleanest solutions. */
\r
1464 pxQueue->u.pcReadFrom = pxQueue->pcHead;
\r
1466 ( void ) memcpy( ( void * ) pvBuffer, ( void * ) pxQueue->u.pcReadFrom, ( size_t ) pxQueue->uxItemSize ); /*lint !e961 !e418 MISRA exception as the casts are only redundant for some ports. Also previous logic ensures a null pointer can only be passed to memcpy() when the count is 0. */
\r
1469 /*-----------------------------------------------------------*/
\r
1471 static void prvUnlockQueue( xQUEUE *pxQueue )
\r
1473 /* THIS FUNCTION MUST BE CALLED WITH THE SCHEDULER SUSPENDED. */
\r
1475 /* The lock counts contains the number of extra data items placed or
\r
1476 removed from the queue while the queue was locked. When a queue is
\r
1477 locked items can be added or removed, but the event lists cannot be
\r
1479 taskENTER_CRITICAL();
\r
1481 /* See if data was added to the queue while it was locked. */
\r
1482 while( pxQueue->xTxLock > queueLOCKED_UNMODIFIED )
\r
1484 /* Data was posted while the queue was locked. Are any tasks
\r
1485 blocked waiting for data to become available? */
\r
1486 #if ( configUSE_QUEUE_SETS == 1 )
\r
1488 if( pxQueue->pxQueueSetContainer != NULL )
\r
1490 if( prvNotifyQueueSetContainer( pxQueue, queueSEND_TO_BACK ) == pdTRUE )
\r
1492 /* The queue is a member of a queue set, and posting to
\r
1493 the queue set caused a higher priority task to unblock.
\r
1494 A context switch is required. */
\r
1495 vTaskMissedYield();
\r
1500 /* Tasks that are removed from the event list will get added to
\r
1501 the pending ready list as the scheduler is still suspended. */
\r
1502 if( listLIST_IS_EMPTY( &( pxQueue->xTasksWaitingToReceive ) ) == pdFALSE )
\r
1504 if( xTaskRemoveFromEventList( &( pxQueue->xTasksWaitingToReceive ) ) != pdFALSE )
\r
1506 /* The task waiting has a higher priority so record that a
\r
1507 context switch is required. */
\r
1508 vTaskMissedYield();
\r
1517 #else /* configUSE_QUEUE_SETS */
\r
1519 /* Tasks that are removed from the event list will get added to
\r
1520 the pending ready list as the scheduler is still suspended. */
\r
1521 if( listLIST_IS_EMPTY( &( pxQueue->xTasksWaitingToReceive ) ) == pdFALSE )
\r
1523 if( xTaskRemoveFromEventList( &( pxQueue->xTasksWaitingToReceive ) ) != pdFALSE )
\r
1525 /* The task waiting has a higher priority so record that a
\r
1526 context switch is required. */
\r
1527 vTaskMissedYield();
\r
1535 #endif /* configUSE_QUEUE_SETS */
\r
1537 --( pxQueue->xTxLock );
\r
1540 pxQueue->xTxLock = queueUNLOCKED;
\r
1542 taskEXIT_CRITICAL();
\r
1544 /* Do the same for the Rx lock. */
\r
1545 taskENTER_CRITICAL();
\r
1547 while( pxQueue->xRxLock > queueLOCKED_UNMODIFIED )
\r
1549 if( listLIST_IS_EMPTY( &( pxQueue->xTasksWaitingToSend ) ) == pdFALSE )
\r
1551 if( xTaskRemoveFromEventList( &( pxQueue->xTasksWaitingToSend ) ) != pdFALSE )
\r
1553 vTaskMissedYield();
\r
1556 --( pxQueue->xRxLock );
\r
1564 pxQueue->xRxLock = queueUNLOCKED;
\r
1566 taskEXIT_CRITICAL();
\r
1568 /*-----------------------------------------------------------*/
\r
1570 static signed portBASE_TYPE prvIsQueueEmpty( const xQUEUE *pxQueue )
\r
1572 signed portBASE_TYPE xReturn;
\r
1574 taskENTER_CRITICAL();
\r
1576 if( pxQueue->uxMessagesWaiting == ( unsigned portBASE_TYPE ) 0 )
\r
1582 xReturn = pdFALSE;
\r
1585 taskEXIT_CRITICAL();
\r
1589 /*-----------------------------------------------------------*/
\r
1591 signed portBASE_TYPE xQueueIsQueueEmptyFromISR( const xQueueHandle xQueue )
\r
1593 signed portBASE_TYPE xReturn;
\r
1595 configASSERT( xQueue );
\r
1596 if( ( ( xQUEUE * ) xQueue )->uxMessagesWaiting == ( unsigned portBASE_TYPE ) 0 )
\r
1602 xReturn = pdFALSE;
\r
1606 } /*lint !e818 xQueue could not be pointer to const because it is a typedef. */
\r
1607 /*-----------------------------------------------------------*/
\r
1609 static signed portBASE_TYPE prvIsQueueFull( const xQUEUE *pxQueue )
\r
1611 signed portBASE_TYPE xReturn;
\r
1613 taskENTER_CRITICAL();
\r
1615 if( pxQueue->uxMessagesWaiting == pxQueue->uxLength )
\r
1621 xReturn = pdFALSE;
\r
1624 taskEXIT_CRITICAL();
\r
1628 /*-----------------------------------------------------------*/
\r
1630 signed portBASE_TYPE xQueueIsQueueFullFromISR( const xQueueHandle xQueue )
\r
1632 signed portBASE_TYPE xReturn;
\r
1634 configASSERT( xQueue );
\r
1635 if( ( ( xQUEUE * ) xQueue )->uxMessagesWaiting == ( ( xQUEUE * ) xQueue )->uxLength )
\r
1641 xReturn = pdFALSE;
\r
1645 } /*lint !e818 xQueue could not be pointer to const because it is a typedef. */
\r
1646 /*-----------------------------------------------------------*/
\r
1648 #if ( configUSE_CO_ROUTINES == 1 )
\r
1650 signed portBASE_TYPE xQueueCRSend( xQueueHandle xQueue, const void *pvItemToQueue, portTickType xTicksToWait )
\r
1652 signed portBASE_TYPE xReturn;
\r
1653 xQUEUE * const pxQueue = ( xQUEUE * ) xQueue;
\r
1655 /* If the queue is already full we may have to block. A critical section
\r
1656 is required to prevent an interrupt removing something from the queue
\r
1657 between the check to see if the queue is full and blocking on the queue. */
\r
1658 portDISABLE_INTERRUPTS();
\r
1660 if( prvIsQueueFull( pxQueue ) != pdFALSE )
\r
1662 /* The queue is full - do we want to block or just leave without
\r
1664 if( xTicksToWait > ( portTickType ) 0 )
\r
1666 /* As this is called from a coroutine we cannot block directly, but
\r
1667 return indicating that we need to block. */
\r
1668 vCoRoutineAddToDelayedList( xTicksToWait, &( pxQueue->xTasksWaitingToSend ) );
\r
1669 portENABLE_INTERRUPTS();
\r
1670 return errQUEUE_BLOCKED;
\r
1674 portENABLE_INTERRUPTS();
\r
1675 return errQUEUE_FULL;
\r
1679 portENABLE_INTERRUPTS();
\r
1681 portDISABLE_INTERRUPTS();
\r
1683 if( pxQueue->uxMessagesWaiting < pxQueue->uxLength )
\r
1685 /* There is room in the queue, copy the data into the queue. */
\r
1686 prvCopyDataToQueue( pxQueue, pvItemToQueue, queueSEND_TO_BACK );
\r
1689 /* Were any co-routines waiting for data to become available? */
\r
1690 if( listLIST_IS_EMPTY( &( pxQueue->xTasksWaitingToReceive ) ) == pdFALSE )
\r
1692 /* In this instance the co-routine could be placed directly
\r
1693 into the ready list as we are within a critical section.
\r
1694 Instead the same pending ready list mechanism is used as if
\r
1695 the event were caused from within an interrupt. */
\r
1696 if( xCoRoutineRemoveFromEventList( &( pxQueue->xTasksWaitingToReceive ) ) != pdFALSE )
\r
1698 /* The co-routine waiting has a higher priority so record
\r
1699 that a yield might be appropriate. */
\r
1700 xReturn = errQUEUE_YIELD;
\r
1706 xReturn = errQUEUE_FULL;
\r
1709 portENABLE_INTERRUPTS();
\r
1714 #endif /* configUSE_CO_ROUTINES */
\r
1715 /*-----------------------------------------------------------*/
\r
1717 #if ( configUSE_CO_ROUTINES == 1 )
\r
1719 signed portBASE_TYPE xQueueCRReceive( xQueueHandle xQueue, void *pvBuffer, portTickType xTicksToWait )
\r
1721 signed portBASE_TYPE xReturn;
\r
1722 xQUEUE * const pxQueue = ( xQUEUE * ) xQueue;
\r
1724 /* If the queue is already empty we may have to block. A critical section
\r
1725 is required to prevent an interrupt adding something to the queue
\r
1726 between the check to see if the queue is empty and blocking on the queue. */
\r
1727 portDISABLE_INTERRUPTS();
\r
1729 if( pxQueue->uxMessagesWaiting == ( unsigned portBASE_TYPE ) 0 )
\r
1731 /* There are no messages in the queue, do we want to block or just
\r
1732 leave with nothing? */
\r
1733 if( xTicksToWait > ( portTickType ) 0 )
\r
1735 /* As this is a co-routine we cannot block directly, but return
\r
1736 indicating that we need to block. */
\r
1737 vCoRoutineAddToDelayedList( xTicksToWait, &( pxQueue->xTasksWaitingToReceive ) );
\r
1738 portENABLE_INTERRUPTS();
\r
1739 return errQUEUE_BLOCKED;
\r
1743 portENABLE_INTERRUPTS();
\r
1744 return errQUEUE_FULL;
\r
1748 portENABLE_INTERRUPTS();
\r
1750 portDISABLE_INTERRUPTS();
\r
1752 if( pxQueue->uxMessagesWaiting > ( unsigned portBASE_TYPE ) 0 )
\r
1754 /* Data is available from the queue. */
\r
1755 pxQueue->u.pcReadFrom += pxQueue->uxItemSize;
\r
1756 if( pxQueue->u.pcReadFrom >= pxQueue->pcTail )
\r
1758 pxQueue->u.pcReadFrom = pxQueue->pcHead;
\r
1760 --( pxQueue->uxMessagesWaiting );
\r
1761 ( void ) memcpy( ( void * ) pvBuffer, ( void * ) pxQueue->u.pcReadFrom, ( unsigned ) pxQueue->uxItemSize );
\r
1765 /* Were any co-routines waiting for space to become available? */
\r
1766 if( listLIST_IS_EMPTY( &( pxQueue->xTasksWaitingToSend ) ) == pdFALSE )
\r
1768 /* In this instance the co-routine could be placed directly
\r
1769 into the ready list as we are within a critical section.
\r
1770 Instead the same pending ready list mechanism is used as if
\r
1771 the event were caused from within an interrupt. */
\r
1772 if( xCoRoutineRemoveFromEventList( &( pxQueue->xTasksWaitingToSend ) ) != pdFALSE )
\r
1774 xReturn = errQUEUE_YIELD;
\r
1783 portENABLE_INTERRUPTS();
\r
1788 #endif /* configUSE_CO_ROUTINES */
\r
1789 /*-----------------------------------------------------------*/
\r
1791 #if ( configUSE_CO_ROUTINES == 1 )
\r
1793 signed portBASE_TYPE xQueueCRSendFromISR( xQueueHandle xQueue, const void *pvItemToQueue, signed portBASE_TYPE xCoRoutinePreviouslyWoken )
\r
1795 xQUEUE * const pxQueue = ( xQUEUE * ) xQueue;
\r
1797 /* Cannot block within an ISR so if there is no space on the queue then
\r
1798 exit without doing anything. */
\r
1799 if( pxQueue->uxMessagesWaiting < pxQueue->uxLength )
\r
1801 prvCopyDataToQueue( pxQueue, pvItemToQueue, queueSEND_TO_BACK );
\r
1803 /* We only want to wake one co-routine per ISR, so check that a
\r
1804 co-routine has not already been woken. */
\r
1805 if( xCoRoutinePreviouslyWoken == pdFALSE )
\r
1807 if( listLIST_IS_EMPTY( &( pxQueue->xTasksWaitingToReceive ) ) == pdFALSE )
\r
1809 if( xCoRoutineRemoveFromEventList( &( pxQueue->xTasksWaitingToReceive ) ) != pdFALSE )
\r
1817 return xCoRoutinePreviouslyWoken;
\r
1820 #endif /* configUSE_CO_ROUTINES */
\r
1821 /*-----------------------------------------------------------*/
\r
1823 #if ( configUSE_CO_ROUTINES == 1 )
\r
1825 signed portBASE_TYPE xQueueCRReceiveFromISR( xQueueHandle xQueue, void *pvBuffer, signed portBASE_TYPE *pxCoRoutineWoken )
\r
1827 signed portBASE_TYPE xReturn;
\r
1828 xQUEUE * const pxQueue = ( xQUEUE * ) xQueue;
\r
1830 /* We cannot block from an ISR, so check there is data available. If
\r
1831 not then just leave without doing anything. */
\r
1832 if( pxQueue->uxMessagesWaiting > ( unsigned portBASE_TYPE ) 0 )
\r
1834 /* Copy the data from the queue. */
\r
1835 pxQueue->u.pcReadFrom += pxQueue->uxItemSize;
\r
1836 if( pxQueue->u.pcReadFrom >= pxQueue->pcTail )
\r
1838 pxQueue->u.pcReadFrom = pxQueue->pcHead;
\r
1840 --( pxQueue->uxMessagesWaiting );
\r
1841 ( void ) memcpy( ( void * ) pvBuffer, ( void * ) pxQueue->u.pcReadFrom, ( unsigned ) pxQueue->uxItemSize );
\r
1843 if( ( *pxCoRoutineWoken ) == pdFALSE )
\r
1845 if( listLIST_IS_EMPTY( &( pxQueue->xTasksWaitingToSend ) ) == pdFALSE )
\r
1847 if( xCoRoutineRemoveFromEventList( &( pxQueue->xTasksWaitingToSend ) ) != pdFALSE )
\r
1849 *pxCoRoutineWoken = pdTRUE;
\r
1864 #endif /* configUSE_CO_ROUTINES */
\r
1865 /*-----------------------------------------------------------*/
\r
1867 #if ( configQUEUE_REGISTRY_SIZE > 0 )
\r
1869 void vQueueAddToRegistry( xQueueHandle xQueue, signed char *pcQueueName )
\r
1871 unsigned portBASE_TYPE ux;
\r
1873 /* See if there is an empty space in the registry. A NULL name denotes
\r
1875 for( ux = ( unsigned portBASE_TYPE ) 0U; ux < ( unsigned portBASE_TYPE ) configQUEUE_REGISTRY_SIZE; ux++ )
\r
1877 if( xQueueRegistry[ ux ].pcQueueName == NULL )
\r
1879 /* Store the information on this queue. */
\r
1880 xQueueRegistry[ ux ].pcQueueName = pcQueueName;
\r
1881 xQueueRegistry[ ux ].xHandle = xQueue;
\r
1887 #endif /* configQUEUE_REGISTRY_SIZE */
\r
1888 /*-----------------------------------------------------------*/
\r
1890 #if ( configQUEUE_REGISTRY_SIZE > 0 )
\r
1892 void vQueueUnregisterQueue( xQueueHandle xQueue )
\r
1894 unsigned portBASE_TYPE ux;
\r
1896 /* See if the handle of the queue being unregistered in actually in the
\r
1898 for( ux = ( unsigned portBASE_TYPE ) 0U; ux < ( unsigned portBASE_TYPE ) configQUEUE_REGISTRY_SIZE; ux++ )
\r
1900 if( xQueueRegistry[ ux ].xHandle == xQueue )
\r
1902 /* Set the name to NULL to show that this slot if free again. */
\r
1903 xQueueRegistry[ ux ].pcQueueName = NULL;
\r
1908 } /*lint !e818 xQueue could not be pointer to const because it is a typedef. */
\r
1910 #endif /* configQUEUE_REGISTRY_SIZE */
\r
1911 /*-----------------------------------------------------------*/
\r
1913 #if ( configUSE_TIMERS == 1 )
\r
1915 void vQueueWaitForMessageRestricted( xQueueHandle xQueue, portTickType xTicksToWait )
\r
1917 xQUEUE * const pxQueue = ( xQUEUE * ) xQueue;
\r
1919 /* This function should not be called by application code hence the
\r
1920 'Restricted' in its name. It is not part of the public API. It is
\r
1921 designed for use by kernel code, and has special calling requirements.
\r
1922 It can result in vListInsert() being called on a list that can only
\r
1923 possibly ever have one item in it, so the list will be fast, but even
\r
1924 so it should be called with the scheduler locked and not from a critical
\r
1927 /* Only do anything if there are no messages in the queue. This function
\r
1928 will not actually cause the task to block, just place it on a blocked
\r
1929 list. It will not block until the scheduler is unlocked - at which
\r
1930 time a yield will be performed. If an item is added to the queue while
\r
1931 the queue is locked, and the calling task blocks on the queue, then the
\r
1932 calling task will be immediately unblocked when the queue is unlocked. */
\r
1933 prvLockQueue( pxQueue );
\r
1934 if( pxQueue->uxMessagesWaiting == ( unsigned portBASE_TYPE ) 0U )
\r
1936 /* There is nothing in the queue, block for the specified period. */
\r
1937 vTaskPlaceOnEventListRestricted( &( pxQueue->xTasksWaitingToReceive ), xTicksToWait );
\r
1939 prvUnlockQueue( pxQueue );
\r
1942 #endif /* configUSE_TIMERS */
\r
1943 /*-----------------------------------------------------------*/
\r
1945 #if ( configUSE_QUEUE_SETS == 1 )
\r
1947 xQueueSetHandle xQueueCreateSet( unsigned portBASE_TYPE uxEventQueueLength )
\r
1949 xQueueSetHandle pxQueue;
\r
1951 pxQueue = xQueueGenericCreate( uxEventQueueLength, sizeof( xQUEUE * ), queueQUEUE_TYPE_SET );
\r
1956 #endif /* configUSE_QUEUE_SETS */
\r
1957 /*-----------------------------------------------------------*/
\r
1959 #if ( configUSE_QUEUE_SETS == 1 )
\r
1961 portBASE_TYPE xQueueAddToSet( xQueueSetMemberHandle xQueueOrSemaphore, xQueueSetHandle xQueueSet )
\r
1963 portBASE_TYPE xReturn;
\r
1965 if( ( ( xQUEUE * ) xQueueOrSemaphore )->pxQueueSetContainer != NULL )
\r
1967 /* Cannot add a queue/semaphore to more than one queue set. */
\r
1970 else if( ( ( xQUEUE * ) xQueueOrSemaphore )->uxMessagesWaiting != ( unsigned portBASE_TYPE ) 0 )
\r
1972 /* Cannot add a queue/semaphore to a queue set if there are already
\r
1973 items in the queue/semaphore. */
\r
1978 taskENTER_CRITICAL();
\r
1980 ( ( xQUEUE * ) xQueueOrSemaphore )->pxQueueSetContainer = xQueueSet;
\r
1982 taskEXIT_CRITICAL();
\r
1989 #endif /* configUSE_QUEUE_SETS */
\r
1990 /*-----------------------------------------------------------*/
\r
1992 #if ( configUSE_QUEUE_SETS == 1 )
\r
1994 portBASE_TYPE xQueueRemoveFromSet( xQueueSetMemberHandle xQueueOrSemaphore, xQueueSetHandle xQueueSet )
\r
1996 portBASE_TYPE xReturn;
\r
1997 xQUEUE * const pxQueueOrSemaphore = ( xQUEUE * ) xQueueOrSemaphore;
\r
1999 if( pxQueueOrSemaphore->pxQueueSetContainer != xQueueSet )
\r
2001 /* The queue was not a member of the set. */
\r
2004 else if( pxQueueOrSemaphore->uxMessagesWaiting != ( unsigned portBASE_TYPE ) 0 )
\r
2006 /* It is dangerous to remove a queue from a set when the queue is
\r
2007 not empty because the queue set will still hold pending events for
\r
2013 taskENTER_CRITICAL();
\r
2015 /* The queue is no longer contained in the set. */
\r
2016 pxQueueOrSemaphore->pxQueueSetContainer = NULL;
\r
2018 taskEXIT_CRITICAL();
\r
2023 } /*lint !e818 xQueueSet could not be declared as pointing to const as it is a typedef. */
\r
2025 #endif /* configUSE_QUEUE_SETS */
\r
2026 /*-----------------------------------------------------------*/
\r
2028 #if ( configUSE_QUEUE_SETS == 1 )
\r
2030 xQueueSetMemberHandle xQueueSelectFromSet( xQueueSetHandle xQueueSet, portTickType xBlockTimeTicks )
\r
2032 xQueueSetMemberHandle xReturn = NULL;
\r
2034 ( void ) xQueueGenericReceive( ( xQueueHandle ) xQueueSet, &xReturn, xBlockTimeTicks, pdFALSE ); /*lint !e961 Casting from one typedef to another is not redundant. */
\r
2038 #endif /* configUSE_QUEUE_SETS */
\r
2039 /*-----------------------------------------------------------*/
\r
2041 #if ( configUSE_QUEUE_SETS == 1 )
\r
2043 xQueueSetMemberHandle xQueueSelectFromSetFromISR( xQueueSetHandle xQueueSet )
\r
2045 xQueueSetMemberHandle xReturn = NULL;
\r
2047 ( void ) xQueueReceiveFromISR( ( xQueueHandle ) xQueueSet, &xReturn, NULL ); /*lint !e961 Casting from one typedef to another is not redundant. */
\r
2051 #endif /* configUSE_QUEUE_SETS */
\r
2052 /*-----------------------------------------------------------*/
\r
2054 #if ( configUSE_QUEUE_SETS == 1 )
\r
2056 static portBASE_TYPE prvNotifyQueueSetContainer( const xQUEUE * const pxQueue, portBASE_TYPE xCopyPosition )
\r
2058 xQUEUE *pxQueueSetContainer = pxQueue->pxQueueSetContainer;
\r
2059 portBASE_TYPE xReturn = pdFALSE;
\r
2061 configASSERT( pxQueueSetContainer );
\r
2062 configASSERT( pxQueueSetContainer->uxMessagesWaiting < pxQueueSetContainer->uxLength );
\r
2064 if( pxQueueSetContainer->uxMessagesWaiting < pxQueueSetContainer->uxLength )
\r
2066 traceQUEUE_SEND( pxQueueSetContainer );
\r
2067 /* The data copies is the handle of the queue that contains data. */
\r
2068 prvCopyDataToQueue( pxQueueSetContainer, &pxQueue, xCopyPosition );
\r
2069 if( listLIST_IS_EMPTY( &( pxQueueSetContainer->xTasksWaitingToReceive ) ) == pdFALSE )
\r
2071 if( xTaskRemoveFromEventList( &( pxQueueSetContainer->xTasksWaitingToReceive ) ) != pdFALSE )
\r
2073 /* The task waiting has a higher priority */
\r
2082 #endif /* configUSE_QUEUE_SETS */
\r