2 FreeRTOS V7.5.3 - Copyright (C) 2013 Real Time Engineers Ltd.
\r
5 VISIT http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.
\r
7 ***************************************************************************
\r
9 * FreeRTOS provides completely free yet professionally developed, *
\r
10 * robust, strictly quality controlled, supported, and cross *
\r
11 * platform software that has become a de facto standard. *
\r
13 * Help yourself get started quickly and support the FreeRTOS *
\r
14 * project by purchasing a FreeRTOS tutorial book, reference *
\r
15 * manual, or both from: http://www.FreeRTOS.org/Documentation *
\r
19 ***************************************************************************
\r
21 This file is part of the FreeRTOS distribution.
\r
23 FreeRTOS is free software; you can redistribute it and/or modify it under
\r
24 the terms of the GNU General Public License (version 2) as published by the
\r
25 Free Software Foundation >>!AND MODIFIED BY!<< the FreeRTOS exception.
\r
27 >>! NOTE: The modification to the GPL is included to allow you to distribute
\r
28 >>! a combined work that includes FreeRTOS without being obliged to provide
\r
29 >>! the source code for proprietary components outside of the FreeRTOS
\r
32 FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY
\r
33 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
\r
34 FOR A PARTICULAR PURPOSE. Full license text is available from the following
\r
35 link: http://www.freertos.org/a00114.html
\r
39 ***************************************************************************
\r
41 * Having a problem? Start by reading the FAQ "My application does *
\r
42 * not run, what could be wrong?" *
\r
44 * http://www.FreeRTOS.org/FAQHelp.html *
\r
46 ***************************************************************************
\r
48 http://www.FreeRTOS.org - Documentation, books, training, latest versions,
\r
49 license and Real Time Engineers Ltd. contact details.
\r
51 http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,
\r
52 including FreeRTOS+Trace - an indispensable productivity tool, a DOS
\r
53 compatible FAT file system, and our tiny thread aware UDP/IP stack.
\r
55 http://www.OpenRTOS.com - Real Time Engineers ltd license FreeRTOS to High
\r
56 Integrity Systems to sell under the OpenRTOS brand. Low cost OpenRTOS
\r
57 licenses offer ticketed support, indemnification and middleware.
\r
59 http://www.SafeRTOS.com - High Integrity Systems also provide a safety
\r
60 engineered and independently SIL3 certified version for use in safety and
\r
61 mission critical applications that require provable dependability.
\r
70 #ifndef INC_FREERTOS_H
\r
71 #error "include FreeRTOS.h" must appear in source files before "include queue.h"
\r
80 * Type by which queues are referenced. For example, a call to xQueueCreate()
\r
81 * returns an xQueueHandle variable that can then be used as a parameter to
\r
82 * xQueueSend(), xQueueReceive(), etc.
\r
84 typedef void * xQueueHandle;
\r
87 * Type by which queue sets are referenced. For example, a call to
\r
88 * xQueueCreateSet() returns an xQueueSet variable that can then be used as a
\r
89 * parameter to xQueueSelectFromSet(), xQueueAddToSet(), etc.
\r
91 typedef void * xQueueSetHandle;
\r
94 * Queue sets can contain both queues and semaphores, so the
\r
95 * xQueueSetMemberHandle is defined as a type to be used where a parameter or
\r
96 * return value can be either an xQueueHandle or an xSemaphoreHandle.
\r
98 typedef void * xQueueSetMemberHandle;
\r
100 /* For internal use only. */
\r
101 #define queueSEND_TO_BACK ( ( portBASE_TYPE ) 0 )
\r
102 #define queueSEND_TO_FRONT ( ( portBASE_TYPE ) 1 )
\r
103 #define queueOVERWRITE ( ( portBASE_TYPE ) 2 )
\r
105 /* For internal use only. These definitions *must* match those in queue.c. */
\r
106 #define queueQUEUE_TYPE_BASE ( ( unsigned char ) 0U )
\r
107 #define queueQUEUE_TYPE_SET ( ( unsigned char ) 0U )
\r
108 #define queueQUEUE_TYPE_MUTEX ( ( unsigned char ) 1U )
\r
109 #define queueQUEUE_TYPE_COUNTING_SEMAPHORE ( ( unsigned char ) 2U )
\r
110 #define queueQUEUE_TYPE_BINARY_SEMAPHORE ( ( unsigned char ) 3U )
\r
111 #define queueQUEUE_TYPE_RECURSIVE_MUTEX ( ( unsigned char ) 4U )
\r
116 xQueueHandle xQueueCreate(
\r
117 unsigned portBASE_TYPE uxQueueLength,
\r
118 unsigned portBASE_TYPE uxItemSize
\r
122 * Creates a new queue instance. This allocates the storage required by the
\r
123 * new queue and returns a handle for the queue.
\r
125 * @param uxQueueLength The maximum number of items that the queue can contain.
\r
127 * @param uxItemSize The number of bytes each item in the queue will require.
\r
128 * Items are queued by copy, not by reference, so this is the number of bytes
\r
129 * that will be copied for each posted item. Each item on the queue must be
\r
132 * @return If the queue is successfully create then a handle to the newly
\r
133 * created queue is returned. If the queue cannot be created then 0 is
\r
144 void vATask( void *pvParameters )
\r
146 xQueueHandle xQueue1, xQueue2;
\r
148 // Create a queue capable of containing 10 unsigned long values.
\r
149 xQueue1 = xQueueCreate( 10, sizeof( unsigned long ) );
\r
152 // Queue was not created and must not be used.
\r
155 // Create a queue capable of containing 10 pointers to AMessage structures.
\r
156 // These should be passed by pointer as they contain a lot of data.
\r
157 xQueue2 = xQueueCreate( 10, sizeof( struct AMessage * ) );
\r
160 // Queue was not created and must not be used.
\r
163 // ... Rest of task code.
\r
166 * \defgroup xQueueCreate xQueueCreate
\r
167 * \ingroup QueueManagement
\r
169 #define xQueueCreate( uxQueueLength, uxItemSize ) xQueueGenericCreate( uxQueueLength, uxItemSize, queueQUEUE_TYPE_BASE )
\r
174 portBASE_TYPE xQueueSendToToFront(
\r
175 xQueueHandle xQueue,
\r
176 const void * pvItemToQueue,
\r
177 portTickType xTicksToWait
\r
181 * This is a macro that calls xQueueGenericSend().
\r
183 * Post an item to the front of a queue. The item is queued by copy, not by
\r
184 * reference. This function must not be called from an interrupt service
\r
185 * routine. See xQueueSendFromISR () for an alternative which may be used
\r
188 * @param xQueue The handle to the queue on which the item is to be posted.
\r
190 * @param pvItemToQueue A pointer to the item that is to be placed on the
\r
191 * queue. The size of the items the queue will hold was defined when the
\r
192 * queue was created, so this many bytes will be copied from pvItemToQueue
\r
193 * into the queue storage area.
\r
195 * @param xTicksToWait The maximum amount of time the task should block
\r
196 * waiting for space to become available on the queue, should it already
\r
197 * be full. The call will return immediately if this is set to 0 and the
\r
198 * queue is full. The time is defined in tick periods so the constant
\r
199 * portTICK_RATE_MS should be used to convert to real time if this is required.
\r
201 * @return pdTRUE if the item was successfully posted, otherwise errQUEUE_FULL.
\r
211 unsigned long ulVar = 10UL;
\r
213 void vATask( void *pvParameters )
\r
215 xQueueHandle xQueue1, xQueue2;
\r
216 struct AMessage *pxMessage;
\r
218 // Create a queue capable of containing 10 unsigned long values.
\r
219 xQueue1 = xQueueCreate( 10, sizeof( unsigned long ) );
\r
221 // Create a queue capable of containing 10 pointers to AMessage structures.
\r
222 // These should be passed by pointer as they contain a lot of data.
\r
223 xQueue2 = xQueueCreate( 10, sizeof( struct AMessage * ) );
\r
229 // Send an unsigned long. Wait for 10 ticks for space to become
\r
230 // available if necessary.
\r
231 if( xQueueSendToFront( xQueue1, ( void * ) &ulVar, ( portTickType ) 10 ) != pdPASS )
\r
233 // Failed to post the message, even after 10 ticks.
\r
239 // Send a pointer to a struct AMessage object. Don't block if the
\r
240 // queue is already full.
\r
241 pxMessage = & xMessage;
\r
242 xQueueSendToFront( xQueue2, ( void * ) &pxMessage, ( portTickType ) 0 );
\r
245 // ... Rest of task code.
\r
248 * \defgroup xQueueSend xQueueSend
\r
249 * \ingroup QueueManagement
\r
251 #define xQueueSendToFront( xQueue, pvItemToQueue, xTicksToWait ) xQueueGenericSend( ( xQueue ), ( pvItemToQueue ), ( xTicksToWait ), queueSEND_TO_FRONT )
\r
256 portBASE_TYPE xQueueSendToBack(
\r
257 xQueueHandle xQueue,
\r
258 const void * pvItemToQueue,
\r
259 portTickType xTicksToWait
\r
263 * This is a macro that calls xQueueGenericSend().
\r
265 * Post an item to the back of a queue. The item is queued by copy, not by
\r
266 * reference. This function must not be called from an interrupt service
\r
267 * routine. See xQueueSendFromISR () for an alternative which may be used
\r
270 * @param xQueue The handle to the queue on which the item is to be posted.
\r
272 * @param pvItemToQueue A pointer to the item that is to be placed on the
\r
273 * queue. The size of the items the queue will hold was defined when the
\r
274 * queue was created, so this many bytes will be copied from pvItemToQueue
\r
275 * into the queue storage area.
\r
277 * @param xTicksToWait The maximum amount of time the task should block
\r
278 * waiting for space to become available on the queue, should it already
\r
279 * be full. The call will return immediately if this is set to 0 and the queue
\r
280 * is full. The time is defined in tick periods so the constant
\r
281 * portTICK_RATE_MS should be used to convert to real time if this is required.
\r
283 * @return pdTRUE if the item was successfully posted, otherwise errQUEUE_FULL.
\r
293 unsigned long ulVar = 10UL;
\r
295 void vATask( void *pvParameters )
\r
297 xQueueHandle xQueue1, xQueue2;
\r
298 struct AMessage *pxMessage;
\r
300 // Create a queue capable of containing 10 unsigned long values.
\r
301 xQueue1 = xQueueCreate( 10, sizeof( unsigned long ) );
\r
303 // Create a queue capable of containing 10 pointers to AMessage structures.
\r
304 // These should be passed by pointer as they contain a lot of data.
\r
305 xQueue2 = xQueueCreate( 10, sizeof( struct AMessage * ) );
\r
311 // Send an unsigned long. Wait for 10 ticks for space to become
\r
312 // available if necessary.
\r
313 if( xQueueSendToBack( xQueue1, ( void * ) &ulVar, ( portTickType ) 10 ) != pdPASS )
\r
315 // Failed to post the message, even after 10 ticks.
\r
321 // Send a pointer to a struct AMessage object. Don't block if the
\r
322 // queue is already full.
\r
323 pxMessage = & xMessage;
\r
324 xQueueSendToBack( xQueue2, ( void * ) &pxMessage, ( portTickType ) 0 );
\r
327 // ... Rest of task code.
\r
330 * \defgroup xQueueSend xQueueSend
\r
331 * \ingroup QueueManagement
\r
333 #define xQueueSendToBack( xQueue, pvItemToQueue, xTicksToWait ) xQueueGenericSend( ( xQueue ), ( pvItemToQueue ), ( xTicksToWait ), queueSEND_TO_BACK )
\r
338 portBASE_TYPE xQueueSend(
\r
339 xQueueHandle xQueue,
\r
340 const void * pvItemToQueue,
\r
341 portTickType xTicksToWait
\r
345 * This is a macro that calls xQueueGenericSend(). It is included for
\r
346 * backward compatibility with versions of FreeRTOS.org that did not
\r
347 * include the xQueueSendToFront() and xQueueSendToBack() macros. It is
\r
348 * equivalent to xQueueSendToBack().
\r
350 * Post an item on a queue. The item is queued by copy, not by reference.
\r
351 * This function must not be called from an interrupt service routine.
\r
352 * See xQueueSendFromISR () for an alternative which may be used in an ISR.
\r
354 * @param xQueue The handle to the queue on which the item is to be posted.
\r
356 * @param pvItemToQueue A pointer to the item that is to be placed on the
\r
357 * queue. The size of the items the queue will hold was defined when the
\r
358 * queue was created, so this many bytes will be copied from pvItemToQueue
\r
359 * into the queue storage area.
\r
361 * @param xTicksToWait The maximum amount of time the task should block
\r
362 * waiting for space to become available on the queue, should it already
\r
363 * be full. The call will return immediately if this is set to 0 and the
\r
364 * queue is full. The time is defined in tick periods so the constant
\r
365 * portTICK_RATE_MS should be used to convert to real time if this is required.
\r
367 * @return pdTRUE if the item was successfully posted, otherwise errQUEUE_FULL.
\r
377 unsigned long ulVar = 10UL;
\r
379 void vATask( void *pvParameters )
\r
381 xQueueHandle xQueue1, xQueue2;
\r
382 struct AMessage *pxMessage;
\r
384 // Create a queue capable of containing 10 unsigned long values.
\r
385 xQueue1 = xQueueCreate( 10, sizeof( unsigned long ) );
\r
387 // Create a queue capable of containing 10 pointers to AMessage structures.
\r
388 // These should be passed by pointer as they contain a lot of data.
\r
389 xQueue2 = xQueueCreate( 10, sizeof( struct AMessage * ) );
\r
395 // Send an unsigned long. Wait for 10 ticks for space to become
\r
396 // available if necessary.
\r
397 if( xQueueSend( xQueue1, ( void * ) &ulVar, ( portTickType ) 10 ) != pdPASS )
\r
399 // Failed to post the message, even after 10 ticks.
\r
405 // Send a pointer to a struct AMessage object. Don't block if the
\r
406 // queue is already full.
\r
407 pxMessage = & xMessage;
\r
408 xQueueSend( xQueue2, ( void * ) &pxMessage, ( portTickType ) 0 );
\r
411 // ... Rest of task code.
\r
414 * \defgroup xQueueSend xQueueSend
\r
415 * \ingroup QueueManagement
\r
417 #define xQueueSend( xQueue, pvItemToQueue, xTicksToWait ) xQueueGenericSend( ( xQueue ), ( pvItemToQueue ), ( xTicksToWait ), queueSEND_TO_BACK )
\r
422 portBASE_TYPE xQueueOverwrite(
\r
423 xQueueHandle xQueue,
\r
424 const void * pvItemToQueue
\r
428 * Only for use with queues that have a length of one - so the queue is either
\r
431 * Post an item on a queue. If the queue is already full then overwrite the
\r
432 * value held in the queue. The item is queued by copy, not by reference.
\r
434 * This function must not be called from an interrupt service routine.
\r
435 * See xQueueOverwriteFromISR () for an alternative which may be used in an ISR.
\r
437 * @param xQueue The handle of the queue to which the data is being sent.
\r
439 * @param pvItemToQueue A pointer to the item that is to be placed on the
\r
440 * queue. The size of the items the queue will hold was defined when the
\r
441 * queue was created, so this many bytes will be copied from pvItemToQueue
\r
442 * into the queue storage area.
\r
444 * @return xQueueOverwrite() is a macro that calls xQueueGenericSend(), and
\r
445 * therefore has the same return values as xQueueSendToFront(). However, pdPASS
\r
446 * is the only value that can be returned because xQueueOverwrite() will write
\r
447 * to the queue even when the queue is already full.
\r
452 void vFunction( void *pvParameters )
\r
454 xQueueHandle xQueue;
\r
455 unsigned long ulVarToSend, ulValReceived;
\r
457 // Create a queue to hold one unsigned long value. It is strongly
\r
458 // recommended *not* to use xQueueOverwrite() on queues that can
\r
459 // contain more than one value, and doing so will trigger an assertion
\r
460 // if configASSERT() is defined.
\r
461 xQueue = xQueueCreate( 1, sizeof( unsigned long ) );
\r
463 // Write the value 10 to the queue using xQueueOverwrite().
\r
465 xQueueOverwrite( xQueue, &ulVarToSend );
\r
467 // Peeking the queue should now return 10, but leave the value 10 in
\r
468 // the queue. A block time of zero is used as it is known that the
\r
469 // queue holds a value.
\r
471 xQueuePeek( xQueue, &ulValReceived, 0 );
\r
473 if( ulValReceived != 10 )
\r
475 // Error unless the item was removed by a different task.
\r
478 // The queue is still full. Use xQueueOverwrite() to overwrite the
\r
479 // value held in the queue with 100.
\r
481 xQueueOverwrite( xQueue, &ulVarToSend );
\r
483 // This time read from the queue, leaving the queue empty once more.
\r
484 // A block time of 0 is used again.
\r
485 xQueueReceive( xQueue, &ulValReceived, 0 );
\r
487 // The value read should be the last value written, even though the
\r
488 // queue was already full when the value was written.
\r
489 if( ulValReceived != 100 )
\r
497 * \defgroup xQueueOverwrite xQueueOverwrite
\r
498 * \ingroup QueueManagement
\r
500 #define xQueueOverwrite( xQueue, pvItemToQueue ) xQueueGenericSend( ( xQueue ), ( pvItemToQueue ), 0, queueOVERWRITE )
\r
506 portBASE_TYPE xQueueGenericSend(
\r
507 xQueueHandle xQueue,
\r
508 const void * pvItemToQueue,
\r
509 portTickType xTicksToWait
\r
510 portBASE_TYPE xCopyPosition
\r
514 * It is preferred that the macros xQueueSend(), xQueueSendToFront() and
\r
515 * xQueueSendToBack() are used in place of calling this function directly.
\r
517 * Post an item on a queue. The item is queued by copy, not by reference.
\r
518 * This function must not be called from an interrupt service routine.
\r
519 * See xQueueSendFromISR () for an alternative which may be used in an ISR.
\r
521 * @param xQueue The handle to the queue on which the item is to be posted.
\r
523 * @param pvItemToQueue A pointer to the item that is to be placed on the
\r
524 * queue. The size of the items the queue will hold was defined when the
\r
525 * queue was created, so this many bytes will be copied from pvItemToQueue
\r
526 * into the queue storage area.
\r
528 * @param xTicksToWait The maximum amount of time the task should block
\r
529 * waiting for space to become available on the queue, should it already
\r
530 * be full. The call will return immediately if this is set to 0 and the
\r
531 * queue is full. The time is defined in tick periods so the constant
\r
532 * portTICK_RATE_MS should be used to convert to real time if this is required.
\r
534 * @param xCopyPosition Can take the value queueSEND_TO_BACK to place the
\r
535 * item at the back of the queue, or queueSEND_TO_FRONT to place the item
\r
536 * at the front of the queue (for high priority messages).
\r
538 * @return pdTRUE if the item was successfully posted, otherwise errQUEUE_FULL.
\r
548 unsigned long ulVar = 10UL;
\r
550 void vATask( void *pvParameters )
\r
552 xQueueHandle xQueue1, xQueue2;
\r
553 struct AMessage *pxMessage;
\r
555 // Create a queue capable of containing 10 unsigned long values.
\r
556 xQueue1 = xQueueCreate( 10, sizeof( unsigned long ) );
\r
558 // Create a queue capable of containing 10 pointers to AMessage structures.
\r
559 // These should be passed by pointer as they contain a lot of data.
\r
560 xQueue2 = xQueueCreate( 10, sizeof( struct AMessage * ) );
\r
566 // Send an unsigned long. Wait for 10 ticks for space to become
\r
567 // available if necessary.
\r
568 if( xQueueGenericSend( xQueue1, ( void * ) &ulVar, ( portTickType ) 10, queueSEND_TO_BACK ) != pdPASS )
\r
570 // Failed to post the message, even after 10 ticks.
\r
576 // Send a pointer to a struct AMessage object. Don't block if the
\r
577 // queue is already full.
\r
578 pxMessage = & xMessage;
\r
579 xQueueGenericSend( xQueue2, ( void * ) &pxMessage, ( portTickType ) 0, queueSEND_TO_BACK );
\r
582 // ... Rest of task code.
\r
585 * \defgroup xQueueSend xQueueSend
\r
586 * \ingroup QueueManagement
\r
588 signed portBASE_TYPE xQueueGenericSend( xQueueHandle xQueue, const void * const pvItemToQueue, portTickType xTicksToWait, portBASE_TYPE xCopyPosition ) PRIVILEGED_FUNCTION;
\r
593 portBASE_TYPE xQueuePeek(
\r
594 xQueueHandle xQueue,
\r
596 portTickType xTicksToWait
\r
599 * This is a macro that calls the xQueueGenericReceive() function.
\r
601 * Receive an item from a queue without removing the item from the queue.
\r
602 * The item is received by copy so a buffer of adequate size must be
\r
603 * provided. The number of bytes copied into the buffer was defined when
\r
604 * the queue was created.
\r
606 * Successfully received items remain on the queue so will be returned again
\r
607 * by the next call, or a call to xQueueReceive().
\r
609 * This macro must not be used in an interrupt service routine. See
\r
610 * xQueuePeekFromISR() for an alternative that can be called from an interrupt
\r
613 * @param xQueue The handle to the queue from which the item is to be
\r
616 * @param pvBuffer Pointer to the buffer into which the received item will
\r
619 * @param xTicksToWait The maximum amount of time the task should block
\r
620 * waiting for an item to receive should the queue be empty at the time
\r
621 * of the call. The time is defined in tick periods so the constant
\r
622 * portTICK_RATE_MS should be used to convert to real time if this is required.
\r
623 * xQueuePeek() will return immediately if xTicksToWait is 0 and the queue
\r
626 * @return pdTRUE if an item was successfully received from the queue,
\r
627 * otherwise pdFALSE.
\r
637 xQueueHandle xQueue;
\r
639 // Task to create a queue and post a value.
\r
640 void vATask( void *pvParameters )
\r
642 struct AMessage *pxMessage;
\r
644 // Create a queue capable of containing 10 pointers to AMessage structures.
\r
645 // These should be passed by pointer as they contain a lot of data.
\r
646 xQueue = xQueueCreate( 10, sizeof( struct AMessage * ) );
\r
649 // Failed to create the queue.
\r
654 // Send a pointer to a struct AMessage object. Don't block if the
\r
655 // queue is already full.
\r
656 pxMessage = & xMessage;
\r
657 xQueueSend( xQueue, ( void * ) &pxMessage, ( portTickType ) 0 );
\r
659 // ... Rest of task code.
\r
662 // Task to peek the data from the queue.
\r
663 void vADifferentTask( void *pvParameters )
\r
665 struct AMessage *pxRxedMessage;
\r
669 // Peek a message on the created queue. Block for 10 ticks if a
\r
670 // message is not immediately available.
\r
671 if( xQueuePeek( xQueue, &( pxRxedMessage ), ( portTickType ) 10 ) )
\r
673 // pcRxedMessage now points to the struct AMessage variable posted
\r
674 // by vATask, but the item still remains on the queue.
\r
678 // ... Rest of task code.
\r
681 * \defgroup xQueueReceive xQueueReceive
\r
682 * \ingroup QueueManagement
\r
684 #define xQueuePeek( xQueue, pvBuffer, xTicksToWait ) xQueueGenericReceive( ( xQueue ), ( pvBuffer ), ( xTicksToWait ), pdTRUE )
\r
689 portBASE_TYPE xQueuePeekFromISR(
\r
690 xQueueHandle xQueue,
\r
694 * A version of xQueuePeek() that can be called from an interrupt service
\r
697 * Receive an item from a queue without removing the item from the queue.
\r
698 * The item is received by copy so a buffer of adequate size must be
\r
699 * provided. The number of bytes copied into the buffer was defined when
\r
700 * the queue was created.
\r
702 * Successfully received items remain on the queue so will be returned again
\r
703 * by the next call, or a call to xQueueReceive().
\r
705 * @param xQueue The handle to the queue from which the item is to be
\r
708 * @param pvBuffer Pointer to the buffer into which the received item will
\r
711 * @return pdTRUE if an item was successfully received from the queue,
\r
712 * otherwise pdFALSE.
\r
714 * \defgroup xQueuePeekFromISR xQueuePeekFromISR
\r
715 * \ingroup QueueManagement
\r
717 signed portBASE_TYPE xQueuePeekFromISR( xQueueHandle xQueue, const void * const pvBuffer ) PRIVILEGED_FUNCTION;
\r
722 portBASE_TYPE xQueueReceive(
\r
723 xQueueHandle xQueue,
\r
725 portTickType xTicksToWait
\r
728 * This is a macro that calls the xQueueGenericReceive() function.
\r
730 * Receive an item from a queue. The item is received by copy so a buffer of
\r
731 * adequate size must be provided. The number of bytes copied into the buffer
\r
732 * was defined when the queue was created.
\r
734 * Successfully received items are removed from the queue.
\r
736 * This function must not be used in an interrupt service routine. See
\r
737 * xQueueReceiveFromISR for an alternative that can.
\r
739 * @param xQueue The handle to the queue from which the item is to be
\r
742 * @param pvBuffer Pointer to the buffer into which the received item will
\r
745 * @param xTicksToWait The maximum amount of time the task should block
\r
746 * waiting for an item to receive should the queue be empty at the time
\r
747 * of the call. xQueueReceive() will return immediately if xTicksToWait
\r
748 * is zero and the queue is empty. The time is defined in tick periods so the
\r
749 * constant portTICK_RATE_MS should be used to convert to real time if this is
\r
752 * @return pdTRUE if an item was successfully received from the queue,
\r
753 * otherwise pdFALSE.
\r
763 xQueueHandle xQueue;
\r
765 // Task to create a queue and post a value.
\r
766 void vATask( void *pvParameters )
\r
768 struct AMessage *pxMessage;
\r
770 // Create a queue capable of containing 10 pointers to AMessage structures.
\r
771 // These should be passed by pointer as they contain a lot of data.
\r
772 xQueue = xQueueCreate( 10, sizeof( struct AMessage * ) );
\r
775 // Failed to create the queue.
\r
780 // Send a pointer to a struct AMessage object. Don't block if the
\r
781 // queue is already full.
\r
782 pxMessage = & xMessage;
\r
783 xQueueSend( xQueue, ( void * ) &pxMessage, ( portTickType ) 0 );
\r
785 // ... Rest of task code.
\r
788 // Task to receive from the queue.
\r
789 void vADifferentTask( void *pvParameters )
\r
791 struct AMessage *pxRxedMessage;
\r
795 // Receive a message on the created queue. Block for 10 ticks if a
\r
796 // message is not immediately available.
\r
797 if( xQueueReceive( xQueue, &( pxRxedMessage ), ( portTickType ) 10 ) )
\r
799 // pcRxedMessage now points to the struct AMessage variable posted
\r
804 // ... Rest of task code.
\r
807 * \defgroup xQueueReceive xQueueReceive
\r
808 * \ingroup QueueManagement
\r
810 #define xQueueReceive( xQueue, pvBuffer, xTicksToWait ) xQueueGenericReceive( ( xQueue ), ( pvBuffer ), ( xTicksToWait ), pdFALSE )
\r
816 portBASE_TYPE xQueueGenericReceive(
\r
817 xQueueHandle xQueue,
\r
819 portTickType xTicksToWait
\r
820 portBASE_TYPE xJustPeek
\r
823 * It is preferred that the macro xQueueReceive() be used rather than calling
\r
824 * this function directly.
\r
826 * Receive an item from a queue. The item is received by copy so a buffer of
\r
827 * adequate size must be provided. The number of bytes copied into the buffer
\r
828 * was defined when the queue was created.
\r
830 * This function must not be used in an interrupt service routine. See
\r
831 * xQueueReceiveFromISR for an alternative that can.
\r
833 * @param xQueue The handle to the queue from which the item is to be
\r
836 * @param pvBuffer Pointer to the buffer into which the received item will
\r
839 * @param xTicksToWait The maximum amount of time the task should block
\r
840 * waiting for an item to receive should the queue be empty at the time
\r
841 * of the call. The time is defined in tick periods so the constant
\r
842 * portTICK_RATE_MS should be used to convert to real time if this is required.
\r
843 * xQueueGenericReceive() will return immediately if the queue is empty and
\r
844 * xTicksToWait is 0.
\r
846 * @param xJustPeek When set to true, the item received from the queue is not
\r
847 * actually removed from the queue - meaning a subsequent call to
\r
848 * xQueueReceive() will return the same item. When set to false, the item
\r
849 * being received from the queue is also removed from the queue.
\r
851 * @return pdTRUE if an item was successfully received from the queue,
\r
852 * otherwise pdFALSE.
\r
862 xQueueHandle xQueue;
\r
864 // Task to create a queue and post a value.
\r
865 void vATask( void *pvParameters )
\r
867 struct AMessage *pxMessage;
\r
869 // Create a queue capable of containing 10 pointers to AMessage structures.
\r
870 // These should be passed by pointer as they contain a lot of data.
\r
871 xQueue = xQueueCreate( 10, sizeof( struct AMessage * ) );
\r
874 // Failed to create the queue.
\r
879 // Send a pointer to a struct AMessage object. Don't block if the
\r
880 // queue is already full.
\r
881 pxMessage = & xMessage;
\r
882 xQueueSend( xQueue, ( void * ) &pxMessage, ( portTickType ) 0 );
\r
884 // ... Rest of task code.
\r
887 // Task to receive from the queue.
\r
888 void vADifferentTask( void *pvParameters )
\r
890 struct AMessage *pxRxedMessage;
\r
894 // Receive a message on the created queue. Block for 10 ticks if a
\r
895 // message is not immediately available.
\r
896 if( xQueueGenericReceive( xQueue, &( pxRxedMessage ), ( portTickType ) 10 ) )
\r
898 // pcRxedMessage now points to the struct AMessage variable posted
\r
903 // ... Rest of task code.
\r
906 * \defgroup xQueueReceive xQueueReceive
\r
907 * \ingroup QueueManagement
\r
909 signed portBASE_TYPE xQueueGenericReceive( xQueueHandle xQueue, const void * const pvBuffer, portTickType xTicksToWait, portBASE_TYPE xJustPeek ) PRIVILEGED_FUNCTION;
\r
913 * <pre>unsigned portBASE_TYPE uxQueueMessagesWaiting( const xQueueHandle xQueue );</pre>
\r
915 * Return the number of messages stored in a queue.
\r
917 * @param xQueue A handle to the queue being queried.
\r
919 * @return The number of messages available in the queue.
\r
921 * \defgroup uxQueueMessagesWaiting uxQueueMessagesWaiting
\r
922 * \ingroup QueueManagement
\r
924 unsigned portBASE_TYPE uxQueueMessagesWaiting( const xQueueHandle xQueue ) PRIVILEGED_FUNCTION;
\r
928 * <pre>unsigned portBASE_TYPE uxQueueSpacesAvailable( const xQueueHandle xQueue );</pre>
\r
930 * Return the number of free spaces available in a queue. This is equal to the
\r
931 * number of items that can be sent to the queue before the queue becomes full
\r
932 * if no items are removed.
\r
934 * @param xQueue A handle to the queue being queried.
\r
936 * @return The number of spaces available in the queue.
\r
938 * \defgroup uxQueueMessagesWaiting uxQueueMessagesWaiting
\r
939 * \ingroup QueueManagement
\r
941 unsigned portBASE_TYPE uxQueueSpacesAvailable( const xQueueHandle xQueue ) PRIVILEGED_FUNCTION;
\r
945 * <pre>void vQueueDelete( xQueueHandle xQueue );</pre>
\r
947 * Delete a queue - freeing all the memory allocated for storing of items
\r
948 * placed on the queue.
\r
950 * @param xQueue A handle to the queue to be deleted.
\r
952 * \defgroup vQueueDelete vQueueDelete
\r
953 * \ingroup QueueManagement
\r
955 void vQueueDelete( xQueueHandle xQueue ) PRIVILEGED_FUNCTION;
\r
960 portBASE_TYPE xQueueSendToFrontFromISR(
\r
961 xQueueHandle xQueue,
\r
962 const void *pvItemToQueue,
\r
963 portBASE_TYPE *pxHigherPriorityTaskWoken
\r
967 * This is a macro that calls xQueueGenericSendFromISR().
\r
969 * Post an item to the front of a queue. It is safe to use this macro from
\r
970 * within an interrupt service routine.
\r
972 * Items are queued by copy not reference so it is preferable to only
\r
973 * queue small items, especially when called from an ISR. In most cases
\r
974 * it would be preferable to store a pointer to the item being queued.
\r
976 * @param xQueue The handle to the queue on which the item is to be posted.
\r
978 * @param pvItemToQueue A pointer to the item that is to be placed on the
\r
979 * queue. The size of the items the queue will hold was defined when the
\r
980 * queue was created, so this many bytes will be copied from pvItemToQueue
\r
981 * into the queue storage area.
\r
983 * @param pxHigherPriorityTaskWoken xQueueSendToFrontFromISR() will set
\r
984 * *pxHigherPriorityTaskWoken to pdTRUE if sending to the queue caused a task
\r
985 * to unblock, and the unblocked task has a priority higher than the currently
\r
986 * running task. If xQueueSendToFromFromISR() sets this value to pdTRUE then
\r
987 * a context switch should be requested before the interrupt is exited.
\r
989 * @return pdTRUE if the data was successfully sent to the queue, otherwise
\r
992 * Example usage for buffered IO (where the ISR can obtain more than one value
\r
995 void vBufferISR( void )
\r
998 portBASE_TYPE xHigherPrioritTaskWoken;
\r
1000 // We have not woken a task at the start of the ISR.
\r
1001 xHigherPriorityTaskWoken = pdFALSE;
\r
1003 // Loop until the buffer is empty.
\r
1006 // Obtain a byte from the buffer.
\r
1007 cIn = portINPUT_BYTE( RX_REGISTER_ADDRESS );
\r
1010 xQueueSendToFrontFromISR( xRxQueue, &cIn, &xHigherPriorityTaskWoken );
\r
1012 } while( portINPUT_BYTE( BUFFER_COUNT ) );
\r
1014 // Now the buffer is empty we can switch context if necessary.
\r
1015 if( xHigherPriorityTaskWoken )
\r
1022 * \defgroup xQueueSendFromISR xQueueSendFromISR
\r
1023 * \ingroup QueueManagement
\r
1025 #define xQueueSendToFrontFromISR( xQueue, pvItemToQueue, pxHigherPriorityTaskWoken ) xQueueGenericSendFromISR( ( xQueue ), ( pvItemToQueue ), ( pxHigherPriorityTaskWoken ), queueSEND_TO_FRONT )
\r
1031 portBASE_TYPE xQueueSendToBackFromISR(
\r
1032 xQueueHandle xQueue,
\r
1033 const void *pvItemToQueue,
\r
1034 portBASE_TYPE *pxHigherPriorityTaskWoken
\r
1038 * This is a macro that calls xQueueGenericSendFromISR().
\r
1040 * Post an item to the back of a queue. It is safe to use this macro from
\r
1041 * within an interrupt service routine.
\r
1043 * Items are queued by copy not reference so it is preferable to only
\r
1044 * queue small items, especially when called from an ISR. In most cases
\r
1045 * it would be preferable to store a pointer to the item being queued.
\r
1047 * @param xQueue The handle to the queue on which the item is to be posted.
\r
1049 * @param pvItemToQueue A pointer to the item that is to be placed on the
\r
1050 * queue. The size of the items the queue will hold was defined when the
\r
1051 * queue was created, so this many bytes will be copied from pvItemToQueue
\r
1052 * into the queue storage area.
\r
1054 * @param pxHigherPriorityTaskWoken xQueueSendToBackFromISR() will set
\r
1055 * *pxHigherPriorityTaskWoken to pdTRUE if sending to the queue caused a task
\r
1056 * to unblock, and the unblocked task has a priority higher than the currently
\r
1057 * running task. If xQueueSendToBackFromISR() sets this value to pdTRUE then
\r
1058 * a context switch should be requested before the interrupt is exited.
\r
1060 * @return pdTRUE if the data was successfully sent to the queue, otherwise
\r
1063 * Example usage for buffered IO (where the ISR can obtain more than one value
\r
1066 void vBufferISR( void )
\r
1069 portBASE_TYPE xHigherPriorityTaskWoken;
\r
1071 // We have not woken a task at the start of the ISR.
\r
1072 xHigherPriorityTaskWoken = pdFALSE;
\r
1074 // Loop until the buffer is empty.
\r
1077 // Obtain a byte from the buffer.
\r
1078 cIn = portINPUT_BYTE( RX_REGISTER_ADDRESS );
\r
1081 xQueueSendToBackFromISR( xRxQueue, &cIn, &xHigherPriorityTaskWoken );
\r
1083 } while( portINPUT_BYTE( BUFFER_COUNT ) );
\r
1085 // Now the buffer is empty we can switch context if necessary.
\r
1086 if( xHigherPriorityTaskWoken )
\r
1093 * \defgroup xQueueSendFromISR xQueueSendFromISR
\r
1094 * \ingroup QueueManagement
\r
1096 #define xQueueSendToBackFromISR( xQueue, pvItemToQueue, pxHigherPriorityTaskWoken ) xQueueGenericSendFromISR( ( xQueue ), ( pvItemToQueue ), ( pxHigherPriorityTaskWoken ), queueSEND_TO_BACK )
\r
1101 portBASE_TYPE xQueueOverwriteFromISR(
\r
1102 xQueueHandle xQueue,
\r
1103 const void * pvItemToQueue,
\r
1104 portBASE_TYPE *pxHigherPriorityTaskWoken
\r
1108 * A version of xQueueOverwrite() that can be used in an interrupt service
\r
1111 * Only for use with queues that can hold a single item - so the queue is either
\r
1114 * Post an item on a queue. If the queue is already full then overwrite the
\r
1115 * value held in the queue. The item is queued by copy, not by reference.
\r
1117 * @param xQueue The handle to the queue on which the item is to be posted.
\r
1119 * @param pvItemToQueue A pointer to the item that is to be placed on the
\r
1120 * queue. The size of the items the queue will hold was defined when the
\r
1121 * queue was created, so this many bytes will be copied from pvItemToQueue
\r
1122 * into the queue storage area.
\r
1124 * @param pxHigherPriorityTaskWoken xQueueOverwriteFromISR() will set
\r
1125 * *pxHigherPriorityTaskWoken to pdTRUE if sending to the queue caused a task
\r
1126 * to unblock, and the unblocked task has a priority higher than the currently
\r
1127 * running task. If xQueueOverwriteFromISR() sets this value to pdTRUE then
\r
1128 * a context switch should be requested before the interrupt is exited.
\r
1130 * @return xQueueOverwriteFromISR() is a macro that calls
\r
1131 * xQueueGenericSendFromISR(), and therefore has the same return values as
\r
1132 * xQueueSendToFrontFromISR(). However, pdPASS is the only value that can be
\r
1133 * returned because xQueueOverwriteFromISR() will write to the queue even when
\r
1134 * the queue is already full.
\r
1139 xQueueHandle xQueue;
\r
1141 void vFunction( void *pvParameters )
\r
1143 // Create a queue to hold one unsigned long value. It is strongly
\r
1144 // recommended *not* to use xQueueOverwriteFromISR() on queues that can
\r
1145 // contain more than one value, and doing so will trigger an assertion
\r
1146 // if configASSERT() is defined.
\r
1147 xQueue = xQueueCreate( 1, sizeof( unsigned long ) );
\r
1150 void vAnInterruptHandler( void )
\r
1152 // xHigherPriorityTaskWoken must be set to pdFALSE before it is used.
\r
1153 portBASE_TYPE xHigherPriorityTaskWoken = pdFALSE;
\r
1154 unsigned long ulVarToSend, ulValReceived;
\r
1156 // Write the value 10 to the queue using xQueueOverwriteFromISR().
\r
1158 xQueueOverwriteFromISR( xQueue, &ulVarToSend, &xHigherPriorityTaskWoken );
\r
1160 // The queue is full, but calling xQueueOverwriteFromISR() again will still
\r
1161 // pass because the value held in the queue will be overwritten with the
\r
1163 ulVarToSend = 100;
\r
1164 xQueueOverwriteFromISR( xQueue, &ulVarToSend, &xHigherPriorityTaskWoken );
\r
1166 // Reading from the queue will now return 100.
\r
1170 if( xHigherPrioritytaskWoken == pdTRUE )
\r
1172 // Writing to the queue caused a task to unblock and the unblocked task
\r
1173 // has a priority higher than or equal to the priority of the currently
\r
1174 // executing task (the task this interrupt interrupted). Perform a context
\r
1175 // switch so this interrupt returns directly to the unblocked task.
\r
1176 portYIELD_FROM_ISR(); // or portEND_SWITCHING_ISR() depending on the port.
\r
1180 * \defgroup xQueueOverwriteFromISR xQueueOverwriteFromISR
\r
1181 * \ingroup QueueManagement
\r
1183 #define xQueueOverwriteFromISR( xQueue, pvItemToQueue, pxHigherPriorityTaskWoken ) xQueueGenericSendFromISR( ( xQueue ), ( pvItemToQueue ), ( pxHigherPriorityTaskWoken ), queueOVERWRITE )
\r
1188 portBASE_TYPE xQueueSendFromISR(
\r
1189 xQueueHandle xQueue,
\r
1190 const void *pvItemToQueue,
\r
1191 portBASE_TYPE *pxHigherPriorityTaskWoken
\r
1195 * This is a macro that calls xQueueGenericSendFromISR(). It is included
\r
1196 * for backward compatibility with versions of FreeRTOS.org that did not
\r
1197 * include the xQueueSendToBackFromISR() and xQueueSendToFrontFromISR()
\r
1200 * Post an item to the back of a queue. It is safe to use this function from
\r
1201 * within an interrupt service routine.
\r
1203 * Items are queued by copy not reference so it is preferable to only
\r
1204 * queue small items, especially when called from an ISR. In most cases
\r
1205 * it would be preferable to store a pointer to the item being queued.
\r
1207 * @param xQueue The handle to the queue on which the item is to be posted.
\r
1209 * @param pvItemToQueue A pointer to the item that is to be placed on the
\r
1210 * queue. The size of the items the queue will hold was defined when the
\r
1211 * queue was created, so this many bytes will be copied from pvItemToQueue
\r
1212 * into the queue storage area.
\r
1214 * @param pxHigherPriorityTaskWoken xQueueSendFromISR() will set
\r
1215 * *pxHigherPriorityTaskWoken to pdTRUE if sending to the queue caused a task
\r
1216 * to unblock, and the unblocked task has a priority higher than the currently
\r
1217 * running task. If xQueueSendFromISR() sets this value to pdTRUE then
\r
1218 * a context switch should be requested before the interrupt is exited.
\r
1220 * @return pdTRUE if the data was successfully sent to the queue, otherwise
\r
1223 * Example usage for buffered IO (where the ISR can obtain more than one value
\r
1226 void vBufferISR( void )
\r
1229 portBASE_TYPE xHigherPriorityTaskWoken;
\r
1231 // We have not woken a task at the start of the ISR.
\r
1232 xHigherPriorityTaskWoken = pdFALSE;
\r
1234 // Loop until the buffer is empty.
\r
1237 // Obtain a byte from the buffer.
\r
1238 cIn = portINPUT_BYTE( RX_REGISTER_ADDRESS );
\r
1241 xQueueSendFromISR( xRxQueue, &cIn, &xHigherPriorityTaskWoken );
\r
1243 } while( portINPUT_BYTE( BUFFER_COUNT ) );
\r
1245 // Now the buffer is empty we can switch context if necessary.
\r
1246 if( xHigherPriorityTaskWoken )
\r
1248 // Actual macro used here is port specific.
\r
1249 taskYIELD_FROM_ISR ();
\r
1254 * \defgroup xQueueSendFromISR xQueueSendFromISR
\r
1255 * \ingroup QueueManagement
\r
1257 #define xQueueSendFromISR( xQueue, pvItemToQueue, pxHigherPriorityTaskWoken ) xQueueGenericSendFromISR( ( xQueue ), ( pvItemToQueue ), ( pxHigherPriorityTaskWoken ), queueSEND_TO_BACK )
\r
1262 portBASE_TYPE xQueueGenericSendFromISR(
\r
1263 xQueueHandle xQueue,
\r
1264 const void *pvItemToQueue,
\r
1265 portBASE_TYPE *pxHigherPriorityTaskWoken,
\r
1266 portBASE_TYPE xCopyPosition
\r
1270 * It is preferred that the macros xQueueSendFromISR(),
\r
1271 * xQueueSendToFrontFromISR() and xQueueSendToBackFromISR() be used in place
\r
1272 * of calling this function directly.
\r
1274 * Post an item on a queue. It is safe to use this function from within an
\r
1275 * interrupt service routine.
\r
1277 * Items are queued by copy not reference so it is preferable to only
\r
1278 * queue small items, especially when called from an ISR. In most cases
\r
1279 * it would be preferable to store a pointer to the item being queued.
\r
1281 * @param xQueue The handle to the queue on which the item is to be posted.
\r
1283 * @param pvItemToQueue A pointer to the item that is to be placed on the
\r
1284 * queue. The size of the items the queue will hold was defined when the
\r
1285 * queue was created, so this many bytes will be copied from pvItemToQueue
\r
1286 * into the queue storage area.
\r
1288 * @param pxHigherPriorityTaskWoken xQueueGenericSendFromISR() will set
\r
1289 * *pxHigherPriorityTaskWoken to pdTRUE if sending to the queue caused a task
\r
1290 * to unblock, and the unblocked task has a priority higher than the currently
\r
1291 * running task. If xQueueGenericSendFromISR() sets this value to pdTRUE then
\r
1292 * a context switch should be requested before the interrupt is exited.
\r
1294 * @param xCopyPosition Can take the value queueSEND_TO_BACK to place the
\r
1295 * item at the back of the queue, or queueSEND_TO_FRONT to place the item
\r
1296 * at the front of the queue (for high priority messages).
\r
1298 * @return pdTRUE if the data was successfully sent to the queue, otherwise
\r
1301 * Example usage for buffered IO (where the ISR can obtain more than one value
\r
1304 void vBufferISR( void )
\r
1307 portBASE_TYPE xHigherPriorityTaskWokenByPost;
\r
1309 // We have not woken a task at the start of the ISR.
\r
1310 xHigherPriorityTaskWokenByPost = pdFALSE;
\r
1312 // Loop until the buffer is empty.
\r
1315 // Obtain a byte from the buffer.
\r
1316 cIn = portINPUT_BYTE( RX_REGISTER_ADDRESS );
\r
1318 // Post each byte.
\r
1319 xQueueGenericSendFromISR( xRxQueue, &cIn, &xHigherPriorityTaskWokenByPost, queueSEND_TO_BACK );
\r
1321 } while( portINPUT_BYTE( BUFFER_COUNT ) );
\r
1323 // Now the buffer is empty we can switch context if necessary. Note that the
\r
1324 // name of the yield function required is port specific.
\r
1325 if( xHigherPriorityTaskWokenByPost )
\r
1327 taskYIELD_YIELD_FROM_ISR();
\r
1332 * \defgroup xQueueSendFromISR xQueueSendFromISR
\r
1333 * \ingroup QueueManagement
\r
1335 signed portBASE_TYPE xQueueGenericSendFromISR( xQueueHandle xQueue, const void * const pvItemToQueue, signed portBASE_TYPE *pxHigherPriorityTaskWoken, portBASE_TYPE xCopyPosition ) PRIVILEGED_FUNCTION;
\r
1340 portBASE_TYPE xQueueReceiveFromISR(
\r
1341 xQueueHandle xQueue,
\r
1343 portBASE_TYPE *pxTaskWoken
\r
1347 * Receive an item from a queue. It is safe to use this function from within an
\r
1348 * interrupt service routine.
\r
1350 * @param xQueue The handle to the queue from which the item is to be
\r
1353 * @param pvBuffer Pointer to the buffer into which the received item will
\r
1356 * @param pxTaskWoken A task may be blocked waiting for space to become
\r
1357 * available on the queue. If xQueueReceiveFromISR causes such a task to
\r
1358 * unblock *pxTaskWoken will get set to pdTRUE, otherwise *pxTaskWoken will
\r
1359 * remain unchanged.
\r
1361 * @return pdTRUE if an item was successfully received from the queue,
\r
1362 * otherwise pdFALSE.
\r
1367 xQueueHandle xQueue;
\r
1369 // Function to create a queue and post some values.
\r
1370 void vAFunction( void *pvParameters )
\r
1372 char cValueToPost;
\r
1373 const portTickType xBlockTime = ( portTickType )0xff;
\r
1375 // Create a queue capable of containing 10 characters.
\r
1376 xQueue = xQueueCreate( 10, sizeof( char ) );
\r
1379 // Failed to create the queue.
\r
1384 // Post some characters that will be used within an ISR. If the queue
\r
1385 // is full then this task will block for xBlockTime ticks.
\r
1386 cValueToPost = 'a';
\r
1387 xQueueSend( xQueue, ( void * ) &cValueToPost, xBlockTime );
\r
1388 cValueToPost = 'b';
\r
1389 xQueueSend( xQueue, ( void * ) &cValueToPost, xBlockTime );
\r
1391 // ... keep posting characters ... this task may block when the queue
\r
1394 cValueToPost = 'c';
\r
1395 xQueueSend( xQueue, ( void * ) &cValueToPost, xBlockTime );
\r
1398 // ISR that outputs all the characters received on the queue.
\r
1399 void vISR_Routine( void )
\r
1401 portBASE_TYPE xTaskWokenByReceive = pdFALSE;
\r
1404 while( xQueueReceiveFromISR( xQueue, ( void * ) &cRxedChar, &xTaskWokenByReceive) )
\r
1406 // A character was received. Output the character now.
\r
1407 vOutputCharacter( cRxedChar );
\r
1409 // If removing the character from the queue woke the task that was
\r
1410 // posting onto the queue cTaskWokenByReceive will have been set to
\r
1411 // pdTRUE. No matter how many times this loop iterates only one
\r
1412 // task will be woken.
\r
1415 if( cTaskWokenByPost != ( char ) pdFALSE;
\r
1421 * \defgroup xQueueReceiveFromISR xQueueReceiveFromISR
\r
1422 * \ingroup QueueManagement
\r
1424 signed portBASE_TYPE xQueueReceiveFromISR( xQueueHandle xQueue, const void * const pvBuffer, signed portBASE_TYPE *pxHigherPriorityTaskWoken ) PRIVILEGED_FUNCTION;
\r
1427 * Utilities to query queues that are safe to use from an ISR. These utilities
\r
1428 * should be used only from witin an ISR, or within a critical section.
\r
1430 signed portBASE_TYPE xQueueIsQueueEmptyFromISR( const xQueueHandle xQueue ) PRIVILEGED_FUNCTION;
\r
1431 signed portBASE_TYPE xQueueIsQueueFullFromISR( const xQueueHandle xQueue ) PRIVILEGED_FUNCTION;
\r
1432 unsigned portBASE_TYPE uxQueueMessagesWaitingFromISR( const xQueueHandle xQueue ) PRIVILEGED_FUNCTION;
\r
1436 * xQueueAltGenericSend() is an alternative version of xQueueGenericSend().
\r
1437 * Likewise xQueueAltGenericReceive() is an alternative version of
\r
1438 * xQueueGenericReceive().
\r
1440 * The source code that implements the alternative (Alt) API is much
\r
1441 * simpler because it executes everything from within a critical section.
\r
1442 * This is the approach taken by many other RTOSes, but FreeRTOS.org has the
\r
1443 * preferred fully featured API too. The fully featured API has more
\r
1444 * complex code that takes longer to execute, but makes much less use of
\r
1445 * critical sections. Therefore the alternative API sacrifices interrupt
\r
1446 * responsiveness to gain execution speed, whereas the fully featured API
\r
1447 * sacrifices execution speed to ensure better interrupt responsiveness.
\r
1449 signed portBASE_TYPE xQueueAltGenericSend( xQueueHandle xQueue, const void * const pvItemToQueue, portTickType xTicksToWait, portBASE_TYPE xCopyPosition );
\r
1450 signed portBASE_TYPE xQueueAltGenericReceive( xQueueHandle xQueue, void * const pvBuffer, portTickType xTicksToWait, portBASE_TYPE xJustPeeking );
\r
1451 #define xQueueAltSendToFront( xQueue, pvItemToQueue, xTicksToWait ) xQueueAltGenericSend( ( xQueue ), ( pvItemToQueue ), ( xTicksToWait ), queueSEND_TO_FRONT )
\r
1452 #define xQueueAltSendToBack( xQueue, pvItemToQueue, xTicksToWait ) xQueueAltGenericSend( ( xQueue ), ( pvItemToQueue ), ( xTicksToWait ), queueSEND_TO_BACK )
\r
1453 #define xQueueAltReceive( xQueue, pvBuffer, xTicksToWait ) xQueueAltGenericReceive( ( xQueue ), ( pvBuffer ), ( xTicksToWait ), pdFALSE )
\r
1454 #define xQueueAltPeek( xQueue, pvBuffer, xTicksToWait ) xQueueAltGenericReceive( ( xQueue ), ( pvBuffer ), ( xTicksToWait ), pdTRUE )
\r
1457 * The functions defined above are for passing data to and from tasks. The
\r
1458 * functions below are the equivalents for passing data to and from
\r
1461 * These functions are called from the co-routine macro implementation and
\r
1462 * should not be called directly from application code. Instead use the macro
\r
1463 * wrappers defined within croutine.h.
\r
1465 signed portBASE_TYPE xQueueCRSendFromISR( xQueueHandle xQueue, const void *pvItemToQueue, signed portBASE_TYPE xCoRoutinePreviouslyWoken );
\r
1466 signed portBASE_TYPE xQueueCRReceiveFromISR( xQueueHandle xQueue, void *pvBuffer, signed portBASE_TYPE *pxTaskWoken );
\r
1467 signed portBASE_TYPE xQueueCRSend( xQueueHandle xQueue, const void *pvItemToQueue, portTickType xTicksToWait );
\r
1468 signed portBASE_TYPE xQueueCRReceive( xQueueHandle xQueue, void *pvBuffer, portTickType xTicksToWait );
\r
1471 * For internal use only. Use xSemaphoreCreateMutex(),
\r
1472 * xSemaphoreCreateCounting() or xSemaphoreGetMutexHolder() instead of calling
\r
1473 * these functions directly.
\r
1475 xQueueHandle xQueueCreateMutex( unsigned char ucQueueType ) PRIVILEGED_FUNCTION;
\r
1476 xQueueHandle xQueueCreateCountingSemaphore( unsigned portBASE_TYPE uxCountValue, unsigned portBASE_TYPE uxInitialCount ) PRIVILEGED_FUNCTION;
\r
1477 void* xQueueGetMutexHolder( xQueueHandle xSemaphore ) PRIVILEGED_FUNCTION;
\r
1480 * For internal use only. Use xSemaphoreTakeMutexRecursive() or
\r
1481 * xSemaphoreGiveMutexRecursive() instead of calling these functions directly.
\r
1483 portBASE_TYPE xQueueTakeMutexRecursive( xQueueHandle xMutex, portTickType xBlockTime ) PRIVILEGED_FUNCTION;
\r
1484 portBASE_TYPE xQueueGiveMutexRecursive( xQueueHandle pxMutex ) PRIVILEGED_FUNCTION;
\r
1487 * Reset a queue back to its original empty state. pdPASS is returned if the
\r
1488 * queue is successfully reset. pdFAIL is returned if the queue could not be
\r
1489 * reset because there are tasks blocked on the queue waiting to either
\r
1490 * receive from the queue or send to the queue.
\r
1492 #define xQueueReset( xQueue ) xQueueGenericReset( xQueue, pdFALSE )
\r
1495 * The registry is provided as a means for kernel aware debuggers to
\r
1496 * locate queues, semaphores and mutexes. Call vQueueAddToRegistry() add
\r
1497 * a queue, semaphore or mutex handle to the registry if you want the handle
\r
1498 * to be available to a kernel aware debugger. If you are not using a kernel
\r
1499 * aware debugger then this function can be ignored.
\r
1501 * configQUEUE_REGISTRY_SIZE defines the maximum number of handles the
\r
1502 * registry can hold. configQUEUE_REGISTRY_SIZE must be greater than 0
\r
1503 * within FreeRTOSConfig.h for the registry to be available. Its value
\r
1504 * does not effect the number of queues, semaphores and mutexes that can be
\r
1505 * created - just the number that the registry can hold.
\r
1507 * @param xQueue The handle of the queue being added to the registry. This
\r
1508 * is the handle returned by a call to xQueueCreate(). Semaphore and mutex
\r
1509 * handles can also be passed in here.
\r
1511 * @param pcName The name to be associated with the handle. This is the
\r
1512 * name that the kernel aware debugger will display.
\r
1514 #if configQUEUE_REGISTRY_SIZE > 0
\r
1515 void vQueueAddToRegistry( xQueueHandle xQueue, signed char *pcName ) PRIVILEGED_FUNCTION;
\r
1519 * The registry is provided as a means for kernel aware debuggers to
\r
1520 * locate queues, semaphores and mutexes. Call vQueueAddToRegistry() add
\r
1521 * a queue, semaphore or mutex handle to the registry if you want the handle
\r
1522 * to be available to a kernel aware debugger, and vQueueUnregisterQueue() to
\r
1523 * remove the queue, semaphore or mutex from the register. If you are not using
\r
1524 * a kernel aware debugger then this function can be ignored.
\r
1526 * @param xQueue The handle of the queue being removed from the registry.
\r
1528 #if configQUEUE_REGISTRY_SIZE > 0
\r
1529 void vQueueUnregisterQueue( xQueueHandle xQueue ) PRIVILEGED_FUNCTION;
\r
1533 * Generic version of the queue creation function, which is in turn called by
\r
1534 * any queue, semaphore or mutex creation function or macro.
\r
1536 xQueueHandle xQueueGenericCreate( unsigned portBASE_TYPE uxQueueLength, unsigned portBASE_TYPE uxItemSize, unsigned char ucQueueType ) PRIVILEGED_FUNCTION;
\r
1539 * Queue sets provide a mechanism to allow a task to block (pend) on a read
\r
1540 * operation from multiple queues or semaphores simultaneously.
\r
1542 * See FreeRTOS/Source/Demo/Common/Minimal/QueueSet.c for an example using this
\r
1545 * A queue set must be explicitly created using a call to xQueueCreateSet()
\r
1546 * before it can be used. Once created, standard FreeRTOS queues and semaphores
\r
1547 * can be added to the set using calls to xQueueAddToSet().
\r
1548 * xQueueSelectFromSet() is then used to determine which, if any, of the queues
\r
1549 * or semaphores contained in the set is in a state where a queue read or
\r
1550 * semaphore take operation would be successful.
\r
1552 * Note 1: See the documentation on http://wwwFreeRTOS.org/RTOS-queue-sets.html
\r
1553 * for reasons why queue sets are very rarely needed in practice as there are
\r
1554 * simpler methods of blocking on multiple objects.
\r
1556 * Note 2: Blocking on a queue set that contains a mutex will not cause the
\r
1557 * mutex holder to inherit the priority of the blocked task.
\r
1559 * Note 3: An additional 4 bytes of RAM is required for each space in a every
\r
1560 * queue added to a queue set. Therefore counting semaphores that have a high
\r
1561 * maximum count value should not be added to a queue set.
\r
1563 * Note 4: A receive (in the case of a queue) or take (in the case of a
\r
1564 * semaphore) operation must not be performed on a member of a queue set unless
\r
1565 * a call to xQueueSelectFromSet() has first returned a handle to that set member.
\r
1567 * @param uxEventQueueLength Queue sets store events that occur on
\r
1568 * the queues and semaphores contained in the set. uxEventQueueLength specifies
\r
1569 * the maximum number of events that can be queued at once. To be absolutely
\r
1570 * certain that events are not lost uxEventQueueLength should be set to the
\r
1571 * total sum of the length of the queues added to the set, where binary
\r
1572 * semaphores and mutexes have a length of 1, and counting semaphores have a
\r
1573 * length set by their maximum count value. Examples:
\r
1574 * + If a queue set is to hold a queue of length 5, another queue of length 12,
\r
1575 * and a binary semaphore, then uxEventQueueLength should be set to
\r
1576 * (5 + 12 + 1), or 18.
\r
1577 * + If a queue set is to hold three binary semaphores then uxEventQueueLength
\r
1578 * should be set to (1 + 1 + 1 ), or 3.
\r
1579 * + If a queue set is to hold a counting semaphore that has a maximum count of
\r
1580 * 5, and a counting semaphore that has a maximum count of 3, then
\r
1581 * uxEventQueueLength should be set to (5 + 3), or 8.
\r
1583 * @return If the queue set is created successfully then a handle to the created
\r
1584 * queue set is returned. Otherwise NULL is returned.
\r
1586 xQueueSetHandle xQueueCreateSet( unsigned portBASE_TYPE uxEventQueueLength ) PRIVILEGED_FUNCTION;
\r
1589 * Adds a queue or semaphore to a queue set that was previously created by a
\r
1590 * call to xQueueCreateSet().
\r
1592 * See FreeRTOS/Source/Demo/Common/Minimal/QueueSet.c for an example using this
\r
1595 * Note 1: A receive (in the case of a queue) or take (in the case of a
\r
1596 * semaphore) operation must not be performed on a member of a queue set unless
\r
1597 * a call to xQueueSelectFromSet() has first returned a handle to that set member.
\r
1599 * @param xQueueOrSemaphore The handle of the queue or semaphore being added to
\r
1600 * the queue set (cast to an xQueueSetMemberHandle type).
\r
1602 * @param xQueueSet The handle of the queue set to which the queue or semaphore
\r
1605 * @return If the queue or semaphore was successfully added to the queue set
\r
1606 * then pdPASS is returned. If the queue could not be successfully added to the
\r
1607 * queue set because it is already a member of a different queue set then pdFAIL
\r
1610 portBASE_TYPE xQueueAddToSet( xQueueSetMemberHandle xQueueOrSemaphore, xQueueSetHandle xQueueSet ) PRIVILEGED_FUNCTION;
\r
1613 * Removes a queue or semaphore from a queue set. A queue or semaphore can only
\r
1614 * be removed from a set if the queue or semaphore is empty.
\r
1616 * See FreeRTOS/Source/Demo/Common/Minimal/QueueSet.c for an example using this
\r
1619 * @param xQueueOrSemaphore The handle of the queue or semaphore being removed
\r
1620 * from the queue set (cast to an xQueueSetMemberHandle type).
\r
1622 * @param xQueueSet The handle of the queue set in which the queue or semaphore
\r
1625 * @return If the queue or semaphore was successfully removed from the queue set
\r
1626 * then pdPASS is returned. If the queue was not in the queue set, or the
\r
1627 * queue (or semaphore) was not empty, then pdFAIL is returned.
\r
1629 portBASE_TYPE xQueueRemoveFromSet( xQueueSetMemberHandle xQueueOrSemaphore, xQueueSetHandle xQueueSet ) PRIVILEGED_FUNCTION;
\r
1632 * xQueueSelectFromSet() selects from the members of a queue set a queue or
\r
1633 * semaphore that either contains data (in the case of a queue) or is available
\r
1634 * to take (in the case of a semaphore). xQueueSelectFromSet() effectively
\r
1635 * allows a task to block (pend) on a read operation on all the queues and
\r
1636 * semaphores in a queue set simultaneously.
\r
1638 * See FreeRTOS/Source/Demo/Common/Minimal/QueueSet.c for an example using this
\r
1641 * Note 1: See the documentation on http://wwwFreeRTOS.org/RTOS-queue-sets.html
\r
1642 * for reasons why queue sets are very rarely needed in practice as there are
\r
1643 * simpler methods of blocking on multiple objects.
\r
1645 * Note 2: Blocking on a queue set that contains a mutex will not cause the
\r
1646 * mutex holder to inherit the priority of the blocked task.
\r
1648 * Note 3: A receive (in the case of a queue) or take (in the case of a
\r
1649 * semaphore) operation must not be performed on a member of a queue set unless
\r
1650 * a call to xQueueSelectFromSet() has first returned a handle to that set member.
\r
1652 * @param xQueueSet The queue set on which the task will (potentially) block.
\r
1654 * @param xBlockTimeTicks The maximum time, in ticks, that the calling task will
\r
1655 * remain in the Blocked state (with other tasks executing) to wait for a member
\r
1656 * of the queue set to be ready for a successful queue read or semaphore take
\r
1659 * @return xQueueSelectFromSet() will return the handle of a queue (cast to
\r
1660 * a xQueueSetMemberHandle type) contained in the queue set that contains data,
\r
1661 * or the handle of a semaphore (cast to a xQueueSetMemberHandle type) contained
\r
1662 * in the queue set that is available, or NULL if no such queue or semaphore
\r
1663 * exists before before the specified block time expires.
\r
1665 xQueueSetMemberHandle xQueueSelectFromSet( xQueueSetHandle xQueueSet, portTickType xBlockTimeTicks ) PRIVILEGED_FUNCTION;
\r
1668 * A version of xQueueSelectFromSet() that can be used from an ISR.
\r
1670 xQueueSetMemberHandle xQueueSelectFromSetFromISR( xQueueSetHandle xQueueSet ) PRIVILEGED_FUNCTION;
\r
1672 /* Not public API functions. */
\r
1673 void vQueueWaitForMessageRestricted( xQueueHandle xQueue, portTickType xTicksToWait ) PRIVILEGED_FUNCTION;
\r
1674 portBASE_TYPE xQueueGenericReset( xQueueHandle xQueue, portBASE_TYPE xNewQueue ) PRIVILEGED_FUNCTION;
\r
1675 void vQueueSetQueueNumber( xQueueHandle xQueue, unsigned char ucQueueNumber ) PRIVILEGED_FUNCTION;
\r
1676 unsigned char ucQueueGetQueueNumber( xQueueHandle xQueue ) PRIVILEGED_FUNCTION;
\r
1677 unsigned char ucQueueGetQueueType( xQueueHandle xQueue ) PRIVILEGED_FUNCTION;
\r
1680 #ifdef __cplusplus
\r
1684 #endif /* QUEUE_H */
\r