/*\r
- FreeRTOS V7.4.2 - Copyright (C) 2013 Real Time Engineers Ltd.\r
-\r
- FEATURES AND PORTS ARE ADDED TO FREERTOS ALL THE TIME. PLEASE VISIT\r
- http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.\r
-\r
- ***************************************************************************\r
- * *\r
- * FreeRTOS tutorial books are available in pdf and paperback. *\r
- * Complete, revised, and edited pdf reference manuals are also *\r
- * available. *\r
- * *\r
- * Purchasing FreeRTOS documentation will not only help you, by *\r
- * ensuring you get running as quickly as possible and with an *\r
- * in-depth knowledge of how to use FreeRTOS, it will also help *\r
- * the FreeRTOS project to continue with its mission of providing *\r
- * professional grade, cross platform, de facto standard solutions *\r
- * for microcontrollers - completely free of charge! *\r
- * *\r
- * >>> See http://www.FreeRTOS.org/Documentation for details. <<< *\r
- * *\r
- * Thank you for using FreeRTOS, and thank you for your support! *\r
- * *\r
- ***************************************************************************\r
-\r
-\r
- This file is part of the FreeRTOS distribution.\r
-\r
- FreeRTOS is free software; you can redistribute it and/or modify it under\r
- the terms of the GNU General Public License (version 2) as published by the\r
- Free Software Foundation AND MODIFIED BY the FreeRTOS exception.\r
-\r
- >>>>>>NOTE<<<<<< The modification to the GPL is included to allow you to\r
- distribute a combined work that includes FreeRTOS without being obliged to\r
- provide the source code for proprietary components outside of the FreeRTOS\r
- kernel.\r
-\r
- FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY\r
- WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS\r
- FOR A PARTICULAR PURPOSE. See the GNU General Public License for more\r
- details. You should have received a copy of the GNU General Public License\r
- and the FreeRTOS license exception along with FreeRTOS; if not it can be\r
- viewed here: http://www.freertos.org/a00114.html and also obtained by\r
- writing to Real Time Engineers Ltd., contact details for whom are available\r
- on the FreeRTOS WEB site.\r
-\r
- 1 tab == 4 spaces!\r
-\r
- ***************************************************************************\r
- * *\r
- * Having a problem? Start by reading the FAQ "My application does *\r
- * not run, what could be wrong?" *\r
- * *\r
- * http://www.FreeRTOS.org/FAQHelp.html *\r
- * *\r
- ***************************************************************************\r
-\r
-\r
- http://www.FreeRTOS.org - Documentation, books, training, latest versions,\r
- license and Real Time Engineers Ltd. contact details.\r
-\r
- http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
- including FreeRTOS+Trace - an indispensable productivity tool, and our new\r
- fully thread aware and reentrant UDP/IP stack.\r
-\r
- http://www.OpenRTOS.com - Real Time Engineers ltd license FreeRTOS to High\r
- Integrity Systems, who sell the code with commercial support,\r
- indemnification and middleware, under the OpenRTOS brand.\r
-\r
- http://www.SafeRTOS.com - High Integrity Systems also provide a safety\r
- engineered and independently SIL3 certified version for use in safety and\r
- mission critical applications that require provable dependability.\r
-*/\r
+ * FreeRTOS Kernel V10.2.1\r
+ * Copyright (C) 2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.\r
+ *\r
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of\r
+ * this software and associated documentation files (the "Software"), to deal in\r
+ * the Software without restriction, including without limitation the rights to\r
+ * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\r
+ * the Software, and to permit persons to whom the Software is furnished to do so,\r
+ * subject to the following conditions:\r
+ *\r
+ * The above copyright notice and this permission notice shall be included in all\r
+ * copies or substantial portions of the Software.\r
+ *\r
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\r
+ * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\r
+ * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\r
+ * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\r
+ * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r
+ *\r
+ * http://www.FreeRTOS.org\r
+ * http://aws.amazon.com/freertos\r
+ *\r
+ * 1 tab == 4 spaces!\r
+ */\r
\r
\r
#ifndef QUEUE_H\r
extern "C" {\r
#endif\r
\r
-\r
-#include "mpu_wrappers.h"\r
+#include "task.h"\r
\r
/**\r
* Type by which queues are referenced. For example, a call to xQueueCreate()\r
- * returns an xQueueHandle variable that can then be used as a parameter to\r
+ * returns an QueueHandle_t variable that can then be used as a parameter to\r
* xQueueSend(), xQueueReceive(), etc.\r
*/\r
-typedef void * xQueueHandle;\r
+struct QueueDefinition; /* Using old naming convention so as not to break kernel aware debuggers. */\r
+typedef struct QueueDefinition * QueueHandle_t;\r
\r
/**\r
* Type by which queue sets are referenced. For example, a call to\r
* xQueueCreateSet() returns an xQueueSet variable that can then be used as a\r
* parameter to xQueueSelectFromSet(), xQueueAddToSet(), etc.\r
*/\r
-typedef void * xQueueSetHandle;\r
+typedef struct QueueDefinition * QueueSetHandle_t;\r
\r
/**\r
* Queue sets can contain both queues and semaphores, so the\r
- * xQueueSetMemberHandle is defined as a type to be used where a parameter or\r
- * return value can be either an xQueueHandle or an xSemaphoreHandle.\r
+ * QueueSetMemberHandle_t is defined as a type to be used where a parameter or\r
+ * return value can be either an QueueHandle_t or an SemaphoreHandle_t.\r
*/\r
-typedef void * xQueueSetMemberHandle;\r
+typedef struct QueueDefinition * QueueSetMemberHandle_t;\r
\r
/* For internal use only. */\r
-#define queueSEND_TO_BACK ( 0 )\r
-#define queueSEND_TO_FRONT ( 1 )\r
-#define queueOVERWRITE ( 2 )\r
+#define queueSEND_TO_BACK ( ( BaseType_t ) 0 )\r
+#define queueSEND_TO_FRONT ( ( BaseType_t ) 1 )\r
+#define queueOVERWRITE ( ( BaseType_t ) 2 )\r
\r
/* For internal use only. These definitions *must* match those in queue.c. */\r
-#define queueQUEUE_TYPE_BASE ( 0U )\r
-#define queueQUEUE_TYPE_SET ( 0U )\r
-#define queueQUEUE_TYPE_MUTEX ( 1U )\r
-#define queueQUEUE_TYPE_COUNTING_SEMAPHORE ( 2U )\r
-#define queueQUEUE_TYPE_BINARY_SEMAPHORE ( 3U )\r
-#define queueQUEUE_TYPE_RECURSIVE_MUTEX ( 4U )\r
+#define queueQUEUE_TYPE_BASE ( ( uint8_t ) 0U )\r
+#define queueQUEUE_TYPE_SET ( ( uint8_t ) 0U )\r
+#define queueQUEUE_TYPE_MUTEX ( ( uint8_t ) 1U )\r
+#define queueQUEUE_TYPE_COUNTING_SEMAPHORE ( ( uint8_t ) 2U )\r
+#define queueQUEUE_TYPE_BINARY_SEMAPHORE ( ( uint8_t ) 3U )\r
+#define queueQUEUE_TYPE_RECURSIVE_MUTEX ( ( uint8_t ) 4U )\r
\r
/**\r
* queue. h\r
* <pre>\r
- xQueueHandle xQueueCreate(\r
- unsigned portBASE_TYPE uxQueueLength,\r
- unsigned portBASE_TYPE uxItemSize\r
+ QueueHandle_t xQueueCreate(\r
+ UBaseType_t uxQueueLength,\r
+ UBaseType_t uxItemSize\r
);\r
* </pre>\r
*\r
- * Creates a new queue instance. This allocates the storage required by the\r
- * new queue and returns a handle for the queue.\r
+ * Creates a new queue instance, and returns a handle by which the new queue\r
+ * can be referenced.\r
+ *\r
+ * Internally, within the FreeRTOS implementation, queues use two blocks of\r
+ * memory. The first block is used to hold the queue's data structures. The\r
+ * second block is used to hold items placed into the queue. If a queue is\r
+ * created using xQueueCreate() then both blocks of memory are automatically\r
+ * dynamically allocated inside the xQueueCreate() function. (see\r
+ * http://www.freertos.org/a00111.html). If a queue is created using\r
+ * xQueueCreateStatic() then the application writer must provide the memory that\r
+ * will get used by the queue. xQueueCreateStatic() therefore allows a queue to\r
+ * be created without using any dynamic memory allocation.\r
+ *\r
+ * http://www.FreeRTOS.org/Embedded-RTOS-Queues.html\r
*\r
* @param uxQueueLength The maximum number of items that the queue can contain.\r
*\r
\r
void vATask( void *pvParameters )\r
{\r
- xQueueHandle xQueue1, xQueue2;\r
+ QueueHandle_t xQueue1, xQueue2;\r
\r
- // Create a queue capable of containing 10 unsigned long values.\r
- xQueue1 = xQueueCreate( 10, sizeof( unsigned long ) );\r
+ // Create a queue capable of containing 10 uint32_t values.\r
+ xQueue1 = xQueueCreate( 10, sizeof( uint32_t ) );\r
if( xQueue1 == 0 )\r
{\r
// Queue was not created and must not be used.\r
* \defgroup xQueueCreate xQueueCreate\r
* \ingroup QueueManagement\r
*/\r
-#define xQueueCreate( uxQueueLength, uxItemSize ) xQueueGenericCreate( uxQueueLength, uxItemSize, queueQUEUE_TYPE_BASE )\r
+#if( configSUPPORT_DYNAMIC_ALLOCATION == 1 )\r
+ #define xQueueCreate( uxQueueLength, uxItemSize ) xQueueGenericCreate( ( uxQueueLength ), ( uxItemSize ), ( queueQUEUE_TYPE_BASE ) )\r
+#endif\r
\r
/**\r
* queue. h\r
* <pre>\r
- portBASE_TYPE xQueueSendToToFront(\r
- xQueueHandle xQueue,\r
- const void * pvItemToQueue,\r
- portTickType xTicksToWait\r
- );\r
+ QueueHandle_t xQueueCreateStatic(\r
+ UBaseType_t uxQueueLength,\r
+ UBaseType_t uxItemSize,\r
+ uint8_t *pucQueueStorageBuffer,\r
+ StaticQueue_t *pxQueueBuffer\r
+ );\r
* </pre>\r
*\r
- * This is a macro that calls xQueueGenericSend().\r
+ * Creates a new queue instance, and returns a handle by which the new queue\r
+ * can be referenced.\r
+ *\r
+ * Internally, within the FreeRTOS implementation, queues use two blocks of\r
+ * memory. The first block is used to hold the queue's data structures. The\r
+ * second block is used to hold items placed into the queue. If a queue is\r
+ * created using xQueueCreate() then both blocks of memory are automatically\r
+ * dynamically allocated inside the xQueueCreate() function. (see\r
+ * http://www.freertos.org/a00111.html). If a queue is created using\r
+ * xQueueCreateStatic() then the application writer must provide the memory that\r
+ * will get used by the queue. xQueueCreateStatic() therefore allows a queue to\r
+ * be created without using any dynamic memory allocation.\r
+ *\r
+ * http://www.FreeRTOS.org/Embedded-RTOS-Queues.html\r
+ *\r
+ * @param uxQueueLength The maximum number of items that the queue can contain.\r
+ *\r
+ * @param uxItemSize The number of bytes each item in the queue will require.\r
+ * Items are queued by copy, not by reference, so this is the number of bytes\r
+ * that will be copied for each posted item. Each item on the queue must be\r
+ * the same size.\r
+ *\r
+ * @param pucQueueStorageBuffer If uxItemSize is not zero then\r
+ * pucQueueStorageBuffer must point to a uint8_t array that is at least large\r
+ * enough to hold the maximum number of items that can be in the queue at any\r
+ * one time - which is ( uxQueueLength * uxItemsSize ) bytes. If uxItemSize is\r
+ * zero then pucQueueStorageBuffer can be NULL.\r
+ *\r
+ * @param pxQueueBuffer Must point to a variable of type StaticQueue_t, which\r
+ * will be used to hold the queue's data structure.\r
+ *\r
+ * @return If the queue is created then a handle to the created queue is\r
+ * returned. If pxQueueBuffer is NULL then NULL is returned.\r
+ *\r
+ * Example usage:\r
+ <pre>\r
+ struct AMessage\r
+ {\r
+ char ucMessageID;\r
+ char ucData[ 20 ];\r
+ };\r
+\r
+ #define QUEUE_LENGTH 10\r
+ #define ITEM_SIZE sizeof( uint32_t )\r
+\r
+ // xQueueBuffer will hold the queue structure.\r
+ StaticQueue_t xQueueBuffer;\r
+\r
+ // ucQueueStorage will hold the items posted to the queue. Must be at least\r
+ // [(queue length) * ( queue item size)] bytes long.\r
+ uint8_t ucQueueStorage[ QUEUE_LENGTH * ITEM_SIZE ];\r
+\r
+ void vATask( void *pvParameters )\r
+ {\r
+ QueueHandle_t xQueue1;\r
+\r
+ // Create a queue capable of containing 10 uint32_t values.\r
+ xQueue1 = xQueueCreate( QUEUE_LENGTH, // The number of items the queue can hold.\r
+ ITEM_SIZE // The size of each item in the queue\r
+ &( ucQueueStorage[ 0 ] ), // The buffer that will hold the items in the queue.\r
+ &xQueueBuffer ); // The buffer that will hold the queue structure.\r
+\r
+ // The queue is guaranteed to be created successfully as no dynamic memory\r
+ // allocation is used. Therefore xQueue1 is now a handle to a valid queue.\r
+\r
+ // ... Rest of task code.\r
+ }\r
+ </pre>\r
+ * \defgroup xQueueCreateStatic xQueueCreateStatic\r
+ * \ingroup QueueManagement\r
+ */\r
+#if( configSUPPORT_STATIC_ALLOCATION == 1 )\r
+ #define xQueueCreateStatic( uxQueueLength, uxItemSize, pucQueueStorage, pxQueueBuffer ) xQueueGenericCreateStatic( ( uxQueueLength ), ( uxItemSize ), ( pucQueueStorage ), ( pxQueueBuffer ), ( queueQUEUE_TYPE_BASE ) )\r
+#endif /* configSUPPORT_STATIC_ALLOCATION */\r
+\r
+/**\r
+ * queue. h\r
+ * <pre>\r
+ BaseType_t xQueueSendToToFront(\r
+ QueueHandle_t xQueue,\r
+ const void *pvItemToQueue,\r
+ TickType_t xTicksToWait\r
+ );\r
+ * </pre>\r
*\r
* Post an item to the front of a queue. The item is queued by copy, not by\r
* reference. This function must not be called from an interrupt service\r
* waiting for space to become available on the queue, should it already\r
* be full. The call will return immediately if this is set to 0 and the\r
* queue is full. The time is defined in tick periods so the constant\r
- * portTICK_RATE_MS should be used to convert to real time if this is required.\r
+ * portTICK_PERIOD_MS should be used to convert to real time if this is required.\r
*\r
* @return pdTRUE if the item was successfully posted, otherwise errQUEUE_FULL.\r
*\r
char ucData[ 20 ];\r
} xMessage;\r
\r
- unsigned long ulVar = 10UL;\r
+ uint32_t ulVar = 10UL;\r
\r
void vATask( void *pvParameters )\r
{\r
- xQueueHandle xQueue1, xQueue2;\r
+ QueueHandle_t xQueue1, xQueue2;\r
struct AMessage *pxMessage;\r
\r
- // Create a queue capable of containing 10 unsigned long values.\r
- xQueue1 = xQueueCreate( 10, sizeof( unsigned long ) );\r
+ // Create a queue capable of containing 10 uint32_t values.\r
+ xQueue1 = xQueueCreate( 10, sizeof( uint32_t ) );\r
\r
// Create a queue capable of containing 10 pointers to AMessage structures.\r
// These should be passed by pointer as they contain a lot of data.\r
\r
if( xQueue1 != 0 )\r
{\r
- // Send an unsigned long. Wait for 10 ticks for space to become\r
+ // Send an uint32_t. Wait for 10 ticks for space to become\r
// available if necessary.\r
- if( xQueueSendToFront( xQueue1, ( void * ) &ulVar, ( portTickType ) 10 ) != pdPASS )\r
+ if( xQueueSendToFront( xQueue1, ( void * ) &ulVar, ( TickType_t ) 10 ) != pdPASS )\r
{\r
// Failed to post the message, even after 10 ticks.\r
}\r
// Send a pointer to a struct AMessage object. Don't block if the\r
// queue is already full.\r
pxMessage = & xMessage;\r
- xQueueSendToFront( xQueue2, ( void * ) &pxMessage, ( portTickType ) 0 );\r
+ xQueueSendToFront( xQueue2, ( void * ) &pxMessage, ( TickType_t ) 0 );\r
}\r
\r
// ... Rest of task code.\r
/**\r
* queue. h\r
* <pre>\r
- portBASE_TYPE xQueueSendToBack(\r
- xQueueHandle xQueue,\r
- const void * pvItemToQueue,\r
- portTickType xTicksToWait\r
+ BaseType_t xQueueSendToBack(\r
+ QueueHandle_t xQueue,\r
+ const void *pvItemToQueue,\r
+ TickType_t xTicksToWait\r
);\r
* </pre>\r
*\r
* waiting for space to become available on the queue, should it already\r
* be full. The call will return immediately if this is set to 0 and the queue\r
* is full. The time is defined in tick periods so the constant\r
- * portTICK_RATE_MS should be used to convert to real time if this is required.\r
+ * portTICK_PERIOD_MS should be used to convert to real time if this is required.\r
*\r
* @return pdTRUE if the item was successfully posted, otherwise errQUEUE_FULL.\r
*\r
char ucData[ 20 ];\r
} xMessage;\r
\r
- unsigned long ulVar = 10UL;\r
+ uint32_t ulVar = 10UL;\r
\r
void vATask( void *pvParameters )\r
{\r
- xQueueHandle xQueue1, xQueue2;\r
+ QueueHandle_t xQueue1, xQueue2;\r
struct AMessage *pxMessage;\r
\r
- // Create a queue capable of containing 10 unsigned long values.\r
- xQueue1 = xQueueCreate( 10, sizeof( unsigned long ) );\r
+ // Create a queue capable of containing 10 uint32_t values.\r
+ xQueue1 = xQueueCreate( 10, sizeof( uint32_t ) );\r
\r
// Create a queue capable of containing 10 pointers to AMessage structures.\r
// These should be passed by pointer as they contain a lot of data.\r
\r
if( xQueue1 != 0 )\r
{\r
- // Send an unsigned long. Wait for 10 ticks for space to become\r
+ // Send an uint32_t. Wait for 10 ticks for space to become\r
// available if necessary.\r
- if( xQueueSendToBack( xQueue1, ( void * ) &ulVar, ( portTickType ) 10 ) != pdPASS )\r
+ if( xQueueSendToBack( xQueue1, ( void * ) &ulVar, ( TickType_t ) 10 ) != pdPASS )\r
{\r
// Failed to post the message, even after 10 ticks.\r
}\r
// Send a pointer to a struct AMessage object. Don't block if the\r
// queue is already full.\r
pxMessage = & xMessage;\r
- xQueueSendToBack( xQueue2, ( void * ) &pxMessage, ( portTickType ) 0 );\r
+ xQueueSendToBack( xQueue2, ( void * ) &pxMessage, ( TickType_t ) 0 );\r
}\r
\r
// ... Rest of task code.\r
/**\r
* queue. h\r
* <pre>\r
- portBASE_TYPE xQueueSend(\r
- xQueueHandle xQueue,\r
+ BaseType_t xQueueSend(\r
+ QueueHandle_t xQueue,\r
const void * pvItemToQueue,\r
- portTickType xTicksToWait\r
+ TickType_t xTicksToWait\r
);\r
* </pre>\r
*\r
* waiting for space to become available on the queue, should it already\r
* be full. The call will return immediately if this is set to 0 and the\r
* queue is full. The time is defined in tick periods so the constant\r
- * portTICK_RATE_MS should be used to convert to real time if this is required.\r
+ * portTICK_PERIOD_MS should be used to convert to real time if this is required.\r
*\r
* @return pdTRUE if the item was successfully posted, otherwise errQUEUE_FULL.\r
*\r
char ucData[ 20 ];\r
} xMessage;\r
\r
- unsigned long ulVar = 10UL;\r
+ uint32_t ulVar = 10UL;\r
\r
void vATask( void *pvParameters )\r
{\r
- xQueueHandle xQueue1, xQueue2;\r
+ QueueHandle_t xQueue1, xQueue2;\r
struct AMessage *pxMessage;\r
\r
- // Create a queue capable of containing 10 unsigned long values.\r
- xQueue1 = xQueueCreate( 10, sizeof( unsigned long ) );\r
+ // Create a queue capable of containing 10 uint32_t values.\r
+ xQueue1 = xQueueCreate( 10, sizeof( uint32_t ) );\r
\r
// Create a queue capable of containing 10 pointers to AMessage structures.\r
// These should be passed by pointer as they contain a lot of data.\r
\r
if( xQueue1 != 0 )\r
{\r
- // Send an unsigned long. Wait for 10 ticks for space to become\r
+ // Send an uint32_t. Wait for 10 ticks for space to become\r
// available if necessary.\r
- if( xQueueSend( xQueue1, ( void * ) &ulVar, ( portTickType ) 10 ) != pdPASS )\r
+ if( xQueueSend( xQueue1, ( void * ) &ulVar, ( TickType_t ) 10 ) != pdPASS )\r
{\r
// Failed to post the message, even after 10 ticks.\r
}\r
// Send a pointer to a struct AMessage object. Don't block if the\r
// queue is already full.\r
pxMessage = & xMessage;\r
- xQueueSend( xQueue2, ( void * ) &pxMessage, ( portTickType ) 0 );\r
+ xQueueSend( xQueue2, ( void * ) &pxMessage, ( TickType_t ) 0 );\r
}\r
\r
// ... Rest of task code.\r
/**\r
* queue. h\r
* <pre>\r
- portBASE_TYPE xQueueOverwrite(\r
- xQueueHandle xQueue,\r
- const void * pvItemToQueue,\r
+ BaseType_t xQueueOverwrite(\r
+ QueueHandle_t xQueue,\r
+ const void * pvItemToQueue\r
);\r
* </pre>\r
*\r
- * Only for use with queues that can hold a single item - so the queue is either\r
+ * Only for use with queues that have a length of one - so the queue is either\r
* empty or full.\r
*\r
* Post an item on a queue. If the queue is already full then overwrite the\r
* value held in the queue. The item is queued by copy, not by reference.\r
+ *\r
* This function must not be called from an interrupt service routine.\r
* See xQueueOverwriteFromISR () for an alternative which may be used in an ISR.\r
*\r
- * @param xQueue The handle to the queue on which the item is to be posted.\r
+ * @param xQueue The handle of the queue to which the data is being sent.\r
*\r
* @param pvItemToQueue A pointer to the item that is to be placed on the\r
* queue. The size of the items the queue will hold was defined when the\r
* into the queue storage area.\r
*\r
* @return xQueueOverwrite() is a macro that calls xQueueGenericSend(), and\r
- * therefore has the same return values as xQueueSendToFront(). However, as\r
- * xQueueOverwrite() will write to the queue even when the queue is full pdPASS\r
- * will be returned in all cases (errQUEUE_FULL will never be returned).\r
+ * therefore has the same return values as xQueueSendToFront(). However, pdPASS\r
+ * is the only value that can be returned because xQueueOverwrite() will write\r
+ * to the queue even when the queue is already full.\r
*\r
* Example usage:\r
<pre>\r
\r
void vFunction( void *pvParameters )\r
{\r
- xQueueHandle xQueue;\r
- unsigned long ulVarToSend, ulValReceived;\r
+ QueueHandle_t xQueue;\r
+ uint32_t ulVarToSend, ulValReceived;\r
\r
- // Create a queue to hold one unsigned long value. It is strongly\r
+ // Create a queue to hold one uint32_t value. It is strongly\r
// recommended *not* to use xQueueOverwrite() on queues that can\r
// contain more than one value, and doing so will trigger an assertion\r
// if configASSERT() is defined.\r
- xQueue = xQueueCreate( 1, sizeof( unsigned long ) );\r
+ xQueue = xQueueCreate( 1, sizeof( uint32_t ) );\r
\r
// Write the value 10 to the queue using xQueueOverwrite().\r
ulVarToSend = 10;\r
\r
if( ulValReceived != 10 )\r
{\r
- // Error!\r
+ // Error unless the item was removed by a different task.\r
}\r
\r
// The queue is still full. Use xQueueOverwrite() to overwrite the\r
/**\r
* queue. h\r
* <pre>\r
- portBASE_TYPE xQueueGenericSend(\r
- xQueueHandle xQueue,\r
+ BaseType_t xQueueGenericSend(\r
+ QueueHandle_t xQueue,\r
const void * pvItemToQueue,\r
- portTickType xTicksToWait\r
- portBASE_TYPE xCopyPosition\r
+ TickType_t xTicksToWait\r
+ BaseType_t xCopyPosition\r
);\r
* </pre>\r
*\r
* waiting for space to become available on the queue, should it already\r
* be full. The call will return immediately if this is set to 0 and the\r
* queue is full. The time is defined in tick periods so the constant\r
- * portTICK_RATE_MS should be used to convert to real time if this is required.\r
+ * portTICK_PERIOD_MS should be used to convert to real time if this is required.\r
*\r
* @param xCopyPosition Can take the value queueSEND_TO_BACK to place the\r
* item at the back of the queue, or queueSEND_TO_FRONT to place the item\r
char ucData[ 20 ];\r
} xMessage;\r
\r
- unsigned long ulVar = 10UL;\r
+ uint32_t ulVar = 10UL;\r
\r
void vATask( void *pvParameters )\r
{\r
- xQueueHandle xQueue1, xQueue2;\r
+ QueueHandle_t xQueue1, xQueue2;\r
struct AMessage *pxMessage;\r
\r
- // Create a queue capable of containing 10 unsigned long values.\r
- xQueue1 = xQueueCreate( 10, sizeof( unsigned long ) );\r
+ // Create a queue capable of containing 10 uint32_t values.\r
+ xQueue1 = xQueueCreate( 10, sizeof( uint32_t ) );\r
\r
// Create a queue capable of containing 10 pointers to AMessage structures.\r
// These should be passed by pointer as they contain a lot of data.\r
\r
if( xQueue1 != 0 )\r
{\r
- // Send an unsigned long. Wait for 10 ticks for space to become\r
+ // Send an uint32_t. Wait for 10 ticks for space to become\r
// available if necessary.\r
- if( xQueueGenericSend( xQueue1, ( void * ) &ulVar, ( portTickType ) 10, queueSEND_TO_BACK ) != pdPASS )\r
+ if( xQueueGenericSend( xQueue1, ( void * ) &ulVar, ( TickType_t ) 10, queueSEND_TO_BACK ) != pdPASS )\r
{\r
// Failed to post the message, even after 10 ticks.\r
}\r
// Send a pointer to a struct AMessage object. Don't block if the\r
// queue is already full.\r
pxMessage = & xMessage;\r
- xQueueGenericSend( xQueue2, ( void * ) &pxMessage, ( portTickType ) 0, queueSEND_TO_BACK );\r
+ xQueueGenericSend( xQueue2, ( void * ) &pxMessage, ( TickType_t ) 0, queueSEND_TO_BACK );\r
}\r
\r
// ... Rest of task code.\r
* \defgroup xQueueSend xQueueSend\r
* \ingroup QueueManagement\r
*/\r
-signed portBASE_TYPE xQueueGenericSend( xQueueHandle xQueue, const void * const pvItemToQueue, portTickType xTicksToWait, portBASE_TYPE xCopyPosition ) PRIVILEGED_FUNCTION;\r
+BaseType_t xQueueGenericSend( QueueHandle_t xQueue, const void * const pvItemToQueue, TickType_t xTicksToWait, const BaseType_t xCopyPosition ) PRIVILEGED_FUNCTION;\r
\r
/**\r
* queue. h\r
* <pre>\r
- portBASE_TYPE xQueuePeek(\r
- xQueueHandle xQueue,\r
- void *pvBuffer,\r
- portTickType xTicksToWait\r
+ BaseType_t xQueuePeek(\r
+ QueueHandle_t xQueue,\r
+ void * const pvBuffer,\r
+ TickType_t xTicksToWait\r
);</pre>\r
*\r
- * This is a macro that calls the xQueueGenericReceive() function.\r
- *\r
* Receive an item from a queue without removing the item from the queue.\r
* The item is received by copy so a buffer of adequate size must be\r
* provided. The number of bytes copied into the buffer was defined when\r
* Successfully received items remain on the queue so will be returned again\r
* by the next call, or a call to xQueueReceive().\r
*\r
- * This macro must not be used in an interrupt service routine.\r
+ * This macro must not be used in an interrupt service routine. See\r
+ * xQueuePeekFromISR() for an alternative that can be called from an interrupt\r
+ * service routine.\r
*\r
* @param xQueue The handle to the queue from which the item is to be\r
* received.\r
* @param xTicksToWait The maximum amount of time the task should block\r
* waiting for an item to receive should the queue be empty at the time\r
* of the call. The time is defined in tick periods so the constant\r
- * portTICK_RATE_MS should be used to convert to real time if this is required.\r
+ * portTICK_PERIOD_MS should be used to convert to real time if this is required.\r
* xQueuePeek() will return immediately if xTicksToWait is 0 and the queue\r
* is empty.\r
*\r
char ucData[ 20 ];\r
} xMessage;\r
\r
- xQueueHandle xQueue;\r
+ QueueHandle_t xQueue;\r
\r
// Task to create a queue and post a value.\r
void vATask( void *pvParameters )\r
// Send a pointer to a struct AMessage object. Don't block if the\r
// queue is already full.\r
pxMessage = & xMessage;\r
- xQueueSend( xQueue, ( void * ) &pxMessage, ( portTickType ) 0 );\r
+ xQueueSend( xQueue, ( void * ) &pxMessage, ( TickType_t ) 0 );\r
\r
// ... Rest of task code.\r
}\r
{\r
// Peek a message on the created queue. Block for 10 ticks if a\r
// message is not immediately available.\r
- if( xQueuePeek( xQueue, &( pxRxedMessage ), ( portTickType ) 10 ) )\r
+ if( xQueuePeek( xQueue, &( pxRxedMessage ), ( TickType_t ) 10 ) )\r
{\r
// pcRxedMessage now points to the struct AMessage variable posted\r
// by vATask, but the item still remains on the queue.\r
// ... Rest of task code.\r
}\r
</pre>\r
- * \defgroup xQueueReceive xQueueReceive\r
+ * \defgroup xQueuePeek xQueuePeek\r
* \ingroup QueueManagement\r
*/\r
-#define xQueuePeek( xQueue, pvBuffer, xTicksToWait ) xQueueGenericReceive( ( xQueue ), ( pvBuffer ), ( xTicksToWait ), pdTRUE )\r
+BaseType_t xQueuePeek( QueueHandle_t xQueue, void * const pvBuffer, TickType_t xTicksToWait ) PRIVILEGED_FUNCTION;\r
\r
/**\r
* queue. h\r
* <pre>\r
- portBASE_TYPE xQueueReceive(\r
- xQueueHandle xQueue,\r
- void *pvBuffer,\r
- portTickType xTicksToWait\r
- );</pre>\r
- *\r
- * This is a macro that calls the xQueueGenericReceive() function.\r
+ BaseType_t xQueuePeekFromISR(\r
+ QueueHandle_t xQueue,\r
+ void *pvBuffer,\r
+ );</pre>\r
*\r
- * Receive an item from a queue. The item is received by copy so a buffer of\r
- * adequate size must be provided. The number of bytes copied into the buffer\r
- * was defined when the queue was created.\r
+ * A version of xQueuePeek() that can be called from an interrupt service\r
+ * routine (ISR).\r
*\r
- * Successfully received items are removed from the queue.\r
+ * Receive an item from a queue without removing the item from the queue.\r
+ * The item is received by copy so a buffer of adequate size must be\r
+ * provided. The number of bytes copied into the buffer was defined when\r
+ * the queue was created.\r
*\r
- * This function must not be used in an interrupt service routine. See\r
- * xQueueReceiveFromISR for an alternative that can.\r
+ * Successfully received items remain on the queue so will be returned again\r
+ * by the next call, or a call to xQueueReceive().\r
*\r
* @param xQueue The handle to the queue from which the item is to be\r
* received.\r
* @param pvBuffer Pointer to the buffer into which the received item will\r
* be copied.\r
*\r
- * @param xTicksToWait The maximum amount of time the task should block\r
- * waiting for an item to receive should the queue be empty at the time\r
- * of the call. xQueueReceive() will return immediately if xTicksToWait\r
- * is zero and the queue is empty. The time is defined in tick periods so the\r
- * constant portTICK_RATE_MS should be used to convert to real time if this is\r
- * required.\r
- *\r
* @return pdTRUE if an item was successfully received from the queue,\r
* otherwise pdFALSE.\r
*\r
- * Example usage:\r
- <pre>\r
- struct AMessage\r
- {\r
- char ucMessageID;\r
- char ucData[ 20 ];\r
- } xMessage;\r
-\r
- xQueueHandle xQueue;\r
-\r
- // Task to create a queue and post a value.\r
- void vATask( void *pvParameters )\r
- {\r
- struct AMessage *pxMessage;\r
-\r
- // Create a queue capable of containing 10 pointers to AMessage structures.\r
- // These should be passed by pointer as they contain a lot of data.\r
- xQueue = xQueueCreate( 10, sizeof( struct AMessage * ) );\r
- if( xQueue == 0 )\r
- {\r
- // Failed to create the queue.\r
- }\r
-\r
- // ...\r
-\r
- // Send a pointer to a struct AMessage object. Don't block if the\r
- // queue is already full.\r
- pxMessage = & xMessage;\r
- xQueueSend( xQueue, ( void * ) &pxMessage, ( portTickType ) 0 );\r
-\r
- // ... Rest of task code.\r
- }\r
-\r
- // Task to receive from the queue.\r
- void vADifferentTask( void *pvParameters )\r
- {\r
- struct AMessage *pxRxedMessage;\r
-\r
- if( xQueue != 0 )\r
- {\r
- // Receive a message on the created queue. Block for 10 ticks if a\r
- // message is not immediately available.\r
- if( xQueueReceive( xQueue, &( pxRxedMessage ), ( portTickType ) 10 ) )\r
- {\r
- // pcRxedMessage now points to the struct AMessage variable posted\r
- // by vATask.\r
- }\r
- }\r
-\r
- // ... Rest of task code.\r
- }\r
- </pre>\r
- * \defgroup xQueueReceive xQueueReceive\r
+ * \defgroup xQueuePeekFromISR xQueuePeekFromISR\r
* \ingroup QueueManagement\r
*/\r
-#define xQueueReceive( xQueue, pvBuffer, xTicksToWait ) xQueueGenericReceive( ( xQueue ), ( pvBuffer ), ( xTicksToWait ), pdFALSE )\r
-\r
+BaseType_t xQueuePeekFromISR( QueueHandle_t xQueue, void * const pvBuffer ) PRIVILEGED_FUNCTION;\r
\r
/**\r
* queue. h\r
* <pre>\r
- portBASE_TYPE xQueueGenericReceive(\r
- xQueueHandle xQueue,\r
- void *pvBuffer,\r
- portTickType xTicksToWait\r
- portBASE_TYPE xJustPeek\r
- );</pre>\r
- *\r
- * It is preferred that the macro xQueueReceive() be used rather than calling\r
- * this function directly.\r
+ BaseType_t xQueueReceive(\r
+ QueueHandle_t xQueue,\r
+ void *pvBuffer,\r
+ TickType_t xTicksToWait\r
+ );</pre>\r
*\r
* Receive an item from a queue. The item is received by copy so a buffer of\r
* adequate size must be provided. The number of bytes copied into the buffer\r
* was defined when the queue was created.\r
*\r
+ * Successfully received items are removed from the queue.\r
+ *\r
* This function must not be used in an interrupt service routine. See\r
* xQueueReceiveFromISR for an alternative that can.\r
*\r
*\r
* @param xTicksToWait The maximum amount of time the task should block\r
* waiting for an item to receive should the queue be empty at the time\r
- * of the call. The time is defined in tick periods so the constant\r
- * portTICK_RATE_MS should be used to convert to real time if this is required.\r
- * xQueueGenericReceive() will return immediately if the queue is empty and\r
- * xTicksToWait is 0.\r
- *\r
- * @param xJustPeek When set to true, the item received from the queue is not\r
- * actually removed from the queue - meaning a subsequent call to\r
- * xQueueReceive() will return the same item. When set to false, the item\r
- * being received from the queue is also removed from the queue.\r
+ * of the call. xQueueReceive() will return immediately if xTicksToWait\r
+ * is zero and the queue is empty. The time is defined in tick periods so the\r
+ * constant portTICK_PERIOD_MS should be used to convert to real time if this is\r
+ * required.\r
*\r
* @return pdTRUE if an item was successfully received from the queue,\r
* otherwise pdFALSE.\r
char ucData[ 20 ];\r
} xMessage;\r
\r
- xQueueHandle xQueue;\r
+ QueueHandle_t xQueue;\r
\r
// Task to create a queue and post a value.\r
void vATask( void *pvParameters )\r
// Send a pointer to a struct AMessage object. Don't block if the\r
// queue is already full.\r
pxMessage = & xMessage;\r
- xQueueSend( xQueue, ( void * ) &pxMessage, ( portTickType ) 0 );\r
+ xQueueSend( xQueue, ( void * ) &pxMessage, ( TickType_t ) 0 );\r
\r
// ... Rest of task code.\r
}\r
{\r
// Receive a message on the created queue. Block for 10 ticks if a\r
// message is not immediately available.\r
- if( xQueueGenericReceive( xQueue, &( pxRxedMessage ), ( portTickType ) 10 ) )\r
+ if( xQueueReceive( xQueue, &( pxRxedMessage ), ( TickType_t ) 10 ) )\r
{\r
// pcRxedMessage now points to the struct AMessage variable posted\r
// by vATask.\r
* \defgroup xQueueReceive xQueueReceive\r
* \ingroup QueueManagement\r
*/\r
-signed portBASE_TYPE xQueueGenericReceive( xQueueHandle xQueue, void * const pvBuffer, portTickType xTicksToWait, portBASE_TYPE xJustPeek ) PRIVILEGED_FUNCTION;\r
+BaseType_t xQueueReceive( QueueHandle_t xQueue, void * const pvBuffer, TickType_t xTicksToWait ) PRIVILEGED_FUNCTION;\r
\r
/**\r
* queue. h\r
- * <pre>unsigned portBASE_TYPE uxQueueMessagesWaiting( const xQueueHandle xQueue );</pre>\r
+ * <pre>UBaseType_t uxQueueMessagesWaiting( const QueueHandle_t xQueue );</pre>\r
*\r
* Return the number of messages stored in a queue.\r
*\r
*\r
* @return The number of messages available in the queue.\r
*\r
- * \page uxQueueMessagesWaiting uxQueueMessagesWaiting\r
+ * \defgroup uxQueueMessagesWaiting uxQueueMessagesWaiting\r
+ * \ingroup QueueManagement\r
+ */\r
+UBaseType_t uxQueueMessagesWaiting( const QueueHandle_t xQueue ) PRIVILEGED_FUNCTION;\r
+\r
+/**\r
+ * queue. h\r
+ * <pre>UBaseType_t uxQueueSpacesAvailable( const QueueHandle_t xQueue );</pre>\r
+ *\r
+ * Return the number of free spaces available in a queue. This is equal to the\r
+ * number of items that can be sent to the queue before the queue becomes full\r
+ * if no items are removed.\r
+ *\r
+ * @param xQueue A handle to the queue being queried.\r
+ *\r
+ * @return The number of spaces available in the queue.\r
+ *\r
+ * \defgroup uxQueueMessagesWaiting uxQueueMessagesWaiting\r
* \ingroup QueueManagement\r
*/\r
-unsigned portBASE_TYPE uxQueueMessagesWaiting( const xQueueHandle xQueue ) PRIVILEGED_FUNCTION;\r
+UBaseType_t uxQueueSpacesAvailable( const QueueHandle_t xQueue ) PRIVILEGED_FUNCTION;\r
\r
/**\r
* queue. h\r
- * <pre>void vQueueDelete( xQueueHandle xQueue );</pre>\r
+ * <pre>void vQueueDelete( QueueHandle_t xQueue );</pre>\r
*\r
* Delete a queue - freeing all the memory allocated for storing of items\r
* placed on the queue.\r
*\r
* @param xQueue A handle to the queue to be deleted.\r
*\r
- * \page vQueueDelete vQueueDelete\r
+ * \defgroup vQueueDelete vQueueDelete\r
* \ingroup QueueManagement\r
*/\r
-void vQueueDelete( xQueueHandle xQueue ) PRIVILEGED_FUNCTION;\r
+void vQueueDelete( QueueHandle_t xQueue ) PRIVILEGED_FUNCTION;\r
\r
/**\r
* queue. h\r
* <pre>\r
- portBASE_TYPE xQueueSendToFrontFromISR(\r
- xQueueHandle xQueue,\r
+ BaseType_t xQueueSendToFrontFromISR(\r
+ QueueHandle_t xQueue,\r
const void *pvItemToQueue,\r
- portBASE_TYPE *pxHigherPriorityTaskWoken\r
+ BaseType_t *pxHigherPriorityTaskWoken\r
);\r
</pre>\r
*\r
void vBufferISR( void )\r
{\r
char cIn;\r
- portBASE_TYPE xHigherPrioritTaskWoken;\r
+ BaseType_t xHigherPrioritTaskWoken;\r
\r
// We have not woken a task at the start of the ISR.\r
xHigherPriorityTaskWoken = pdFALSE;\r
/**\r
* queue. h\r
* <pre>\r
- portBASE_TYPE xQueueSendToBackFromISR(\r
- xQueueHandle xQueue,\r
+ BaseType_t xQueueSendToBackFromISR(\r
+ QueueHandle_t xQueue,\r
const void *pvItemToQueue,\r
- portBASE_TYPE *pxHigherPriorityTaskWoken\r
+ BaseType_t *pxHigherPriorityTaskWoken\r
);\r
</pre>\r
*\r
void vBufferISR( void )\r
{\r
char cIn;\r
- portBASE_TYPE xHigherPriorityTaskWoken;\r
+ BaseType_t xHigherPriorityTaskWoken;\r
\r
// We have not woken a task at the start of the ISR.\r
xHigherPriorityTaskWoken = pdFALSE;\r
/**\r
* queue. h\r
* <pre>\r
- portBASE_TYPE xQueueSendFromISR(\r
- xQueueHandle xQueue,\r
+ BaseType_t xQueueOverwriteFromISR(\r
+ QueueHandle_t xQueue,\r
+ const void * pvItemToQueue,\r
+ BaseType_t *pxHigherPriorityTaskWoken\r
+ );\r
+ * </pre>\r
+ *\r
+ * A version of xQueueOverwrite() that can be used in an interrupt service\r
+ * routine (ISR).\r
+ *\r
+ * Only for use with queues that can hold a single item - so the queue is either\r
+ * empty or full.\r
+ *\r
+ * Post an item on a queue. If the queue is already full then overwrite the\r
+ * value held in the queue. The item is queued by copy, not by reference.\r
+ *\r
+ * @param xQueue The handle to the queue on which the item is to be posted.\r
+ *\r
+ * @param pvItemToQueue A pointer to the item that is to be placed on the\r
+ * queue. The size of the items the queue will hold was defined when the\r
+ * queue was created, so this many bytes will be copied from pvItemToQueue\r
+ * into the queue storage area.\r
+ *\r
+ * @param pxHigherPriorityTaskWoken xQueueOverwriteFromISR() will set\r
+ * *pxHigherPriorityTaskWoken to pdTRUE if sending to the queue caused a task\r
+ * to unblock, and the unblocked task has a priority higher than the currently\r
+ * running task. If xQueueOverwriteFromISR() sets this value to pdTRUE then\r
+ * a context switch should be requested before the interrupt is exited.\r
+ *\r
+ * @return xQueueOverwriteFromISR() is a macro that calls\r
+ * xQueueGenericSendFromISR(), and therefore has the same return values as\r
+ * xQueueSendToFrontFromISR(). However, pdPASS is the only value that can be\r
+ * returned because xQueueOverwriteFromISR() will write to the queue even when\r
+ * the queue is already full.\r
+ *\r
+ * Example usage:\r
+ <pre>\r
+\r
+ QueueHandle_t xQueue;\r
+\r
+ void vFunction( void *pvParameters )\r
+ {\r
+ // Create a queue to hold one uint32_t value. It is strongly\r
+ // recommended *not* to use xQueueOverwriteFromISR() on queues that can\r
+ // contain more than one value, and doing so will trigger an assertion\r
+ // if configASSERT() is defined.\r
+ xQueue = xQueueCreate( 1, sizeof( uint32_t ) );\r
+}\r
+\r
+void vAnInterruptHandler( void )\r
+{\r
+// xHigherPriorityTaskWoken must be set to pdFALSE before it is used.\r
+BaseType_t xHigherPriorityTaskWoken = pdFALSE;\r
+uint32_t ulVarToSend, ulValReceived;\r
+\r
+ // Write the value 10 to the queue using xQueueOverwriteFromISR().\r
+ ulVarToSend = 10;\r
+ xQueueOverwriteFromISR( xQueue, &ulVarToSend, &xHigherPriorityTaskWoken );\r
+\r
+ // The queue is full, but calling xQueueOverwriteFromISR() again will still\r
+ // pass because the value held in the queue will be overwritten with the\r
+ // new value.\r
+ ulVarToSend = 100;\r
+ xQueueOverwriteFromISR( xQueue, &ulVarToSend, &xHigherPriorityTaskWoken );\r
+\r
+ // Reading from the queue will now return 100.\r
+\r
+ // ...\r
+\r
+ if( xHigherPrioritytaskWoken == pdTRUE )\r
+ {\r
+ // Writing to the queue caused a task to unblock and the unblocked task\r
+ // has a priority higher than or equal to the priority of the currently\r
+ // executing task (the task this interrupt interrupted). Perform a context\r
+ // switch so this interrupt returns directly to the unblocked task.\r
+ portYIELD_FROM_ISR(); // or portEND_SWITCHING_ISR() depending on the port.\r
+ }\r
+}\r
+ </pre>\r
+ * \defgroup xQueueOverwriteFromISR xQueueOverwriteFromISR\r
+ * \ingroup QueueManagement\r
+ */\r
+#define xQueueOverwriteFromISR( xQueue, pvItemToQueue, pxHigherPriorityTaskWoken ) xQueueGenericSendFromISR( ( xQueue ), ( pvItemToQueue ), ( pxHigherPriorityTaskWoken ), queueOVERWRITE )\r
+\r
+/**\r
+ * queue. h\r
+ * <pre>\r
+ BaseType_t xQueueSendFromISR(\r
+ QueueHandle_t xQueue,\r
const void *pvItemToQueue,\r
- portBASE_TYPE *pxHigherPriorityTaskWoken\r
+ BaseType_t *pxHigherPriorityTaskWoken\r
);\r
</pre>\r
*\r
void vBufferISR( void )\r
{\r
char cIn;\r
- portBASE_TYPE xHigherPriorityTaskWoken;\r
+ BaseType_t xHigherPriorityTaskWoken;\r
\r
// We have not woken a task at the start of the ISR.\r
xHigherPriorityTaskWoken = pdFALSE;\r
if( xHigherPriorityTaskWoken )\r
{\r
// Actual macro used here is port specific.\r
- taskYIELD_FROM_ISR ();\r
+ portYIELD_FROM_ISR ();\r
}\r
}\r
</pre>\r
/**\r
* queue. h\r
* <pre>\r
- portBASE_TYPE xQueueGenericSendFromISR(\r
- xQueueHandle xQueue,\r
+ BaseType_t xQueueGenericSendFromISR(\r
+ QueueHandle_t xQueue,\r
const void *pvItemToQueue,\r
- portBASE_TYPE *pxHigherPriorityTaskWoken,\r
- portBASE_TYPE xCopyPosition\r
+ BaseType_t *pxHigherPriorityTaskWoken,\r
+ BaseType_t xCopyPosition\r
);\r
</pre>\r
*\r
* It is preferred that the macros xQueueSendFromISR(),\r
* xQueueSendToFrontFromISR() and xQueueSendToBackFromISR() be used in place\r
- * of calling this function directly.\r
+ * of calling this function directly. xQueueGiveFromISR() is an\r
+ * equivalent for use by semaphores that don't actually copy any data.\r
*\r
* Post an item on a queue. It is safe to use this function from within an\r
* interrupt service routine.\r
void vBufferISR( void )\r
{\r
char cIn;\r
- portBASE_TYPE xHigherPriorityTaskWokenByPost;\r
+ BaseType_t xHigherPriorityTaskWokenByPost;\r
\r
// We have not woken a task at the start of the ISR.\r
xHigherPriorityTaskWokenByPost = pdFALSE;\r
// name of the yield function required is port specific.\r
if( xHigherPriorityTaskWokenByPost )\r
{\r
- taskYIELD_YIELD_FROM_ISR();\r
+ portYIELD_FROM_ISR();\r
}\r
}\r
</pre>\r
* \defgroup xQueueSendFromISR xQueueSendFromISR\r
* \ingroup QueueManagement\r
*/\r
-signed portBASE_TYPE xQueueGenericSendFromISR( xQueueHandle xQueue, const void * const pvItemToQueue, signed portBASE_TYPE *pxHigherPriorityTaskWoken, portBASE_TYPE xCopyPosition ) PRIVILEGED_FUNCTION;\r
+BaseType_t xQueueGenericSendFromISR( QueueHandle_t xQueue, const void * const pvItemToQueue, BaseType_t * const pxHigherPriorityTaskWoken, const BaseType_t xCopyPosition ) PRIVILEGED_FUNCTION;\r
+BaseType_t xQueueGiveFromISR( QueueHandle_t xQueue, BaseType_t * const pxHigherPriorityTaskWoken ) PRIVILEGED_FUNCTION;\r
\r
/**\r
* queue. h\r
* <pre>\r
- portBASE_TYPE xQueueReceiveFromISR(\r
- xQueueHandle xQueue,\r
+ BaseType_t xQueueReceiveFromISR(\r
+ QueueHandle_t xQueue,\r
void *pvBuffer,\r
- portBASE_TYPE *pxTaskWoken\r
+ BaseType_t *pxTaskWoken\r
);\r
* </pre>\r
*\r
* Example usage:\r
<pre>\r
\r
- xQueueHandle xQueue;\r
+ QueueHandle_t xQueue;\r
\r
// Function to create a queue and post some values.\r
void vAFunction( void *pvParameters )\r
{\r
char cValueToPost;\r
- const portTickType xBlockTime = ( portTickType )0xff;\r
+ const TickType_t xTicksToWait = ( TickType_t )0xff;\r
\r
// Create a queue capable of containing 10 characters.\r
xQueue = xQueueCreate( 10, sizeof( char ) );\r
// ...\r
\r
// Post some characters that will be used within an ISR. If the queue\r
- // is full then this task will block for xBlockTime ticks.\r
+ // is full then this task will block for xTicksToWait ticks.\r
cValueToPost = 'a';\r
- xQueueSend( xQueue, ( void * ) &cValueToPost, xBlockTime );\r
+ xQueueSend( xQueue, ( void * ) &cValueToPost, xTicksToWait );\r
cValueToPost = 'b';\r
- xQueueSend( xQueue, ( void * ) &cValueToPost, xBlockTime );\r
+ xQueueSend( xQueue, ( void * ) &cValueToPost, xTicksToWait );\r
\r
// ... keep posting characters ... this task may block when the queue\r
// becomes full.\r
\r
cValueToPost = 'c';\r
- xQueueSend( xQueue, ( void * ) &cValueToPost, xBlockTime );\r
+ xQueueSend( xQueue, ( void * ) &cValueToPost, xTicksToWait );\r
}\r
\r
// ISR that outputs all the characters received on the queue.\r
void vISR_Routine( void )\r
{\r
- portBASE_TYPE xTaskWokenByReceive = pdFALSE;\r
+ BaseType_t xTaskWokenByReceive = pdFALSE;\r
char cRxedChar;\r
\r
while( xQueueReceiveFromISR( xQueue, ( void * ) &cRxedChar, &xTaskWokenByReceive) )\r
* \defgroup xQueueReceiveFromISR xQueueReceiveFromISR\r
* \ingroup QueueManagement\r
*/\r
-signed portBASE_TYPE xQueueReceiveFromISR( xQueueHandle xQueue, void * const pvBuffer, signed portBASE_TYPE *pxHigherPriorityTaskWoken ) PRIVILEGED_FUNCTION;\r
+BaseType_t xQueueReceiveFromISR( QueueHandle_t xQueue, void * const pvBuffer, BaseType_t * const pxHigherPriorityTaskWoken ) PRIVILEGED_FUNCTION;\r
\r
/*\r
* Utilities to query queues that are safe to use from an ISR. These utilities\r
* should be used only from witin an ISR, or within a critical section.\r
*/\r
-signed portBASE_TYPE xQueueIsQueueEmptyFromISR( const xQueueHandle xQueue ) PRIVILEGED_FUNCTION;\r
-signed portBASE_TYPE xQueueIsQueueFullFromISR( const xQueueHandle xQueue ) PRIVILEGED_FUNCTION;\r
-unsigned portBASE_TYPE uxQueueMessagesWaitingFromISR( const xQueueHandle xQueue ) PRIVILEGED_FUNCTION;\r
-\r
-\r
-/*\r
- * xQueueAltGenericSend() is an alternative version of xQueueGenericSend().\r
- * Likewise xQueueAltGenericReceive() is an alternative version of\r
- * xQueueGenericReceive().\r
- *\r
- * The source code that implements the alternative (Alt) API is much\r
- * simpler because it executes everything from within a critical section.\r
- * This is the approach taken by many other RTOSes, but FreeRTOS.org has the\r
- * preferred fully featured API too. The fully featured API has more\r
- * complex code that takes longer to execute, but makes much less use of\r
- * critical sections. Therefore the alternative API sacrifices interrupt\r
- * responsiveness to gain execution speed, whereas the fully featured API\r
- * sacrifices execution speed to ensure better interrupt responsiveness.\r
- */\r
-signed portBASE_TYPE xQueueAltGenericSend( xQueueHandle xQueue, const void * const pvItemToQueue, portTickType xTicksToWait, portBASE_TYPE xCopyPosition );\r
-signed portBASE_TYPE xQueueAltGenericReceive( xQueueHandle xQueue, void * const pvBuffer, portTickType xTicksToWait, portBASE_TYPE xJustPeeking );\r
-#define xQueueAltSendToFront( xQueue, pvItemToQueue, xTicksToWait ) xQueueAltGenericSend( ( xQueue ), ( pvItemToQueue ), ( xTicksToWait ), queueSEND_TO_FRONT )\r
-#define xQueueAltSendToBack( xQueue, pvItemToQueue, xTicksToWait ) xQueueAltGenericSend( ( xQueue ), ( pvItemToQueue ), ( xTicksToWait ), queueSEND_TO_BACK )\r
-#define xQueueAltReceive( xQueue, pvBuffer, xTicksToWait ) xQueueAltGenericReceive( ( xQueue ), ( pvBuffer ), ( xTicksToWait ), pdFALSE )\r
-#define xQueueAltPeek( xQueue, pvBuffer, xTicksToWait ) xQueueAltGenericReceive( ( xQueue ), ( pvBuffer ), ( xTicksToWait ), pdTRUE )\r
+BaseType_t xQueueIsQueueEmptyFromISR( const QueueHandle_t xQueue ) PRIVILEGED_FUNCTION;\r
+BaseType_t xQueueIsQueueFullFromISR( const QueueHandle_t xQueue ) PRIVILEGED_FUNCTION;\r
+UBaseType_t uxQueueMessagesWaitingFromISR( const QueueHandle_t xQueue ) PRIVILEGED_FUNCTION;\r
\r
/*\r
* The functions defined above are for passing data to and from tasks. The\r
* should not be called directly from application code. Instead use the macro\r
* wrappers defined within croutine.h.\r
*/\r
-signed portBASE_TYPE xQueueCRSendFromISR( xQueueHandle xQueue, const void *pvItemToQueue, signed portBASE_TYPE xCoRoutinePreviouslyWoken );\r
-signed portBASE_TYPE xQueueCRReceiveFromISR( xQueueHandle xQueue, void *pvBuffer, signed portBASE_TYPE *pxTaskWoken );\r
-signed portBASE_TYPE xQueueCRSend( xQueueHandle xQueue, const void *pvItemToQueue, portTickType xTicksToWait );\r
-signed portBASE_TYPE xQueueCRReceive( xQueueHandle xQueue, void *pvBuffer, portTickType xTicksToWait );\r
+BaseType_t xQueueCRSendFromISR( QueueHandle_t xQueue, const void *pvItemToQueue, BaseType_t xCoRoutinePreviouslyWoken );\r
+BaseType_t xQueueCRReceiveFromISR( QueueHandle_t xQueue, void *pvBuffer, BaseType_t *pxTaskWoken );\r
+BaseType_t xQueueCRSend( QueueHandle_t xQueue, const void *pvItemToQueue, TickType_t xTicksToWait );\r
+BaseType_t xQueueCRReceive( QueueHandle_t xQueue, void *pvBuffer, TickType_t xTicksToWait );\r
\r
/*\r
* For internal use only. Use xSemaphoreCreateMutex(),\r
* xSemaphoreCreateCounting() or xSemaphoreGetMutexHolder() instead of calling\r
* these functions directly.\r
*/\r
-xQueueHandle xQueueCreateMutex( unsigned char ucQueueType ) PRIVILEGED_FUNCTION;\r
-xQueueHandle xQueueCreateCountingSemaphore( unsigned portBASE_TYPE uxCountValue, unsigned portBASE_TYPE uxInitialCount ) PRIVILEGED_FUNCTION;\r
-void* xQueueGetMutexHolder( xQueueHandle xSemaphore ) PRIVILEGED_FUNCTION;\r
+QueueHandle_t xQueueCreateMutex( const uint8_t ucQueueType ) PRIVILEGED_FUNCTION;\r
+QueueHandle_t xQueueCreateMutexStatic( const uint8_t ucQueueType, StaticQueue_t *pxStaticQueue ) PRIVILEGED_FUNCTION;\r
+QueueHandle_t xQueueCreateCountingSemaphore( const UBaseType_t uxMaxCount, const UBaseType_t uxInitialCount ) PRIVILEGED_FUNCTION;\r
+QueueHandle_t xQueueCreateCountingSemaphoreStatic( const UBaseType_t uxMaxCount, const UBaseType_t uxInitialCount, StaticQueue_t *pxStaticQueue ) PRIVILEGED_FUNCTION;\r
+BaseType_t xQueueSemaphoreTake( QueueHandle_t xQueue, TickType_t xTicksToWait ) PRIVILEGED_FUNCTION;\r
+TaskHandle_t xQueueGetMutexHolder( QueueHandle_t xSemaphore ) PRIVILEGED_FUNCTION;\r
+TaskHandle_t xQueueGetMutexHolderFromISR( QueueHandle_t xSemaphore ) PRIVILEGED_FUNCTION;\r
\r
/*\r
* For internal use only. Use xSemaphoreTakeMutexRecursive() or\r
* xSemaphoreGiveMutexRecursive() instead of calling these functions directly.\r
*/\r
-portBASE_TYPE xQueueTakeMutexRecursive( xQueueHandle xMutex, portTickType xBlockTime ) PRIVILEGED_FUNCTION;\r
-portBASE_TYPE xQueueGiveMutexRecursive( xQueueHandle pxMutex ) PRIVILEGED_FUNCTION;\r
+BaseType_t xQueueTakeMutexRecursive( QueueHandle_t xMutex, TickType_t xTicksToWait ) PRIVILEGED_FUNCTION;\r
+BaseType_t xQueueGiveMutexRecursive( QueueHandle_t xMutex ) PRIVILEGED_FUNCTION;\r
\r
/*\r
- * Reset a queue back to its original empty state. pdPASS is returned if the\r
- * queue is successfully reset. pdFAIL is returned if the queue could not be\r
- * reset because there are tasks blocked on the queue waiting to either\r
- * receive from the queue or send to the queue.\r
+ * Reset a queue back to its original empty state. The return value is now\r
+ * obsolete and is always set to pdPASS.\r
*/\r
#define xQueueReset( xQueue ) xQueueGenericReset( xQueue, pdFALSE )\r
\r
* handles can also be passed in here.\r
*\r
* @param pcName The name to be associated with the handle. This is the\r
- * name that the kernel aware debugger will display.\r
+ * name that the kernel aware debugger will display. The queue registry only\r
+ * stores a pointer to the string - so the string must be persistent (global or\r
+ * preferably in ROM/Flash), not on the stack.\r
*/\r
-#if configQUEUE_REGISTRY_SIZE > 0U\r
- void vQueueAddToRegistry( xQueueHandle xQueue, signed char *pcName ) PRIVILEGED_FUNCTION;\r
+#if( configQUEUE_REGISTRY_SIZE > 0 )\r
+ void vQueueAddToRegistry( QueueHandle_t xQueue, const char *pcQueueName ) PRIVILEGED_FUNCTION; /*lint !e971 Unqualified char types are allowed for strings and single characters only. */\r
#endif\r
\r
/*\r
*\r
* @param xQueue The handle of the queue being removed from the registry.\r
*/\r
-#if configQUEUE_REGISTRY_SIZE > 0U\r
- void vQueueUnregisterQueue( xQueueHandle xQueue ) PRIVILEGED_FUNCTION;\r
+#if( configQUEUE_REGISTRY_SIZE > 0 )\r
+ void vQueueUnregisterQueue( QueueHandle_t xQueue ) PRIVILEGED_FUNCTION;\r
#endif\r
\r
/*\r
- * Generic version of the queue creation function, which is in turn called by\r
- * any queue, semaphore or mutex creation function or macro.\r
+ * The queue registry is provided as a means for kernel aware debuggers to\r
+ * locate queues, semaphores and mutexes. Call pcQueueGetName() to look\r
+ * up and return the name of a queue in the queue registry from the queue's\r
+ * handle.\r
+ *\r
+ * @param xQueue The handle of the queue the name of which will be returned.\r
+ * @return If the queue is in the registry then a pointer to the name of the\r
+ * queue is returned. If the queue is not in the registry then NULL is\r
+ * returned.\r
*/\r
-xQueueHandle xQueueGenericCreate( unsigned portBASE_TYPE uxQueueLength, unsigned portBASE_TYPE uxItemSize, unsigned char ucQueueType ) PRIVILEGED_FUNCTION;\r
+#if( configQUEUE_REGISTRY_SIZE > 0 )\r
+ const char *pcQueueGetName( QueueHandle_t xQueue ) PRIVILEGED_FUNCTION; /*lint !e971 Unqualified char types are allowed for strings and single characters only. */\r
+#endif\r
+\r
+/*\r
+ * Generic version of the function used to creaet a queue using dynamic memory\r
+ * allocation. This is called by other functions and macros that create other\r
+ * RTOS objects that use the queue structure as their base.\r
+ */\r
+#if( configSUPPORT_DYNAMIC_ALLOCATION == 1 )\r
+ QueueHandle_t xQueueGenericCreate( const UBaseType_t uxQueueLength, const UBaseType_t uxItemSize, const uint8_t ucQueueType ) PRIVILEGED_FUNCTION;\r
+#endif\r
+\r
+/*\r
+ * Generic version of the function used to creaet a queue using dynamic memory\r
+ * allocation. This is called by other functions and macros that create other\r
+ * RTOS objects that use the queue structure as their base.\r
+ */\r
+#if( configSUPPORT_STATIC_ALLOCATION == 1 )\r
+ QueueHandle_t xQueueGenericCreateStatic( const UBaseType_t uxQueueLength, const UBaseType_t uxItemSize, uint8_t *pucQueueStorage, StaticQueue_t *pxStaticQueue, const uint8_t ucQueueType ) PRIVILEGED_FUNCTION;\r
+#endif\r
\r
/*\r
* Queue sets provide a mechanism to allow a task to block (pend) on a read\r
* @return If the queue set is created successfully then a handle to the created\r
* queue set is returned. Otherwise NULL is returned.\r
*/\r
-xQueueSetHandle xQueueCreateSet( unsigned portBASE_TYPE uxEventQueueLength ) PRIVILEGED_FUNCTION;\r
+QueueSetHandle_t xQueueCreateSet( const UBaseType_t uxEventQueueLength ) PRIVILEGED_FUNCTION;\r
\r
/*\r
* Adds a queue or semaphore to a queue set that was previously created by a\r
* a call to xQueueSelectFromSet() has first returned a handle to that set member.\r
*\r
* @param xQueueOrSemaphore The handle of the queue or semaphore being added to\r
- * the queue set (cast to an xQueueSetMemberHandle type).\r
+ * the queue set (cast to an QueueSetMemberHandle_t type).\r
*\r
* @param xQueueSet The handle of the queue set to which the queue or semaphore\r
* is being added.\r
* queue set because it is already a member of a different queue set then pdFAIL\r
* is returned.\r
*/\r
-portBASE_TYPE xQueueAddToSet( xQueueSetMemberHandle xQueueOrSemaphore, xQueueSetHandle xQueueSet ) PRIVILEGED_FUNCTION;\r
+BaseType_t xQueueAddToSet( QueueSetMemberHandle_t xQueueOrSemaphore, QueueSetHandle_t xQueueSet ) PRIVILEGED_FUNCTION;\r
\r
/*\r
* Removes a queue or semaphore from a queue set. A queue or semaphore can only\r
* function.\r
*\r
* @param xQueueOrSemaphore The handle of the queue or semaphore being removed\r
- * from the queue set (cast to an xQueueSetMemberHandle type).\r
+ * from the queue set (cast to an QueueSetMemberHandle_t type).\r
*\r
* @param xQueueSet The handle of the queue set in which the queue or semaphore\r
* is included.\r
* then pdPASS is returned. If the queue was not in the queue set, or the\r
* queue (or semaphore) was not empty, then pdFAIL is returned.\r
*/\r
-portBASE_TYPE xQueueRemoveFromSet( xQueueSetMemberHandle xQueueOrSemaphore, xQueueSetHandle xQueueSet ) PRIVILEGED_FUNCTION;\r
+BaseType_t xQueueRemoveFromSet( QueueSetMemberHandle_t xQueueOrSemaphore, QueueSetHandle_t xQueueSet ) PRIVILEGED_FUNCTION;\r
\r
/*\r
* xQueueSelectFromSet() selects from the members of a queue set a queue or\r
*\r
* @param xQueueSet The queue set on which the task will (potentially) block.\r
*\r
- * @param xBlockTimeTicks The maximum time, in ticks, that the calling task will\r
+ * @param xTicksToWait The maximum time, in ticks, that the calling task will\r
* remain in the Blocked state (with other tasks executing) to wait for a member\r
* of the queue set to be ready for a successful queue read or semaphore take\r
* operation.\r
*\r
* @return xQueueSelectFromSet() will return the handle of a queue (cast to\r
- * a xQueueSetMemberHandle type) contained in the queue set that contains data,\r
- * or the handle of a semaphore (cast to a xQueueSetMemberHandle type) contained\r
+ * a QueueSetMemberHandle_t type) contained in the queue set that contains data,\r
+ * or the handle of a semaphore (cast to a QueueSetMemberHandle_t type) contained\r
* in the queue set that is available, or NULL if no such queue or semaphore\r
* exists before before the specified block time expires.\r
*/\r
-xQueueSetMemberHandle xQueueSelectFromSet( xQueueSetHandle xQueueSet, portTickType xBlockTimeTicks ) PRIVILEGED_FUNCTION;\r
+QueueSetMemberHandle_t xQueueSelectFromSet( QueueSetHandle_t xQueueSet, const TickType_t xTicksToWait ) PRIVILEGED_FUNCTION;\r
\r
/*\r
* A version of xQueueSelectFromSet() that can be used from an ISR.\r
*/\r
-xQueueSetMemberHandle xQueueSelectFromSetFromISR( xQueueSetHandle xQueueSet ) PRIVILEGED_FUNCTION;\r
+QueueSetMemberHandle_t xQueueSelectFromSetFromISR( QueueSetHandle_t xQueueSet ) PRIVILEGED_FUNCTION;\r
\r
/* Not public API functions. */\r
-void vQueueWaitForMessageRestricted( xQueueHandle xQueue, portTickType xTicksToWait ) PRIVILEGED_FUNCTION;\r
-portBASE_TYPE xQueueGenericReset( xQueueHandle xQueue, portBASE_TYPE xNewQueue ) PRIVILEGED_FUNCTION;\r
-void vQueueSetQueueNumber( xQueueHandle xQueue, unsigned char ucQueueNumber ) PRIVILEGED_FUNCTION;\r
-unsigned char ucQueueGetQueueNumber( xQueueHandle xQueue ) PRIVILEGED_FUNCTION;\r
-unsigned char ucQueueGetQueueType( xQueueHandle xQueue ) PRIVILEGED_FUNCTION;\r
+void vQueueWaitForMessageRestricted( QueueHandle_t xQueue, TickType_t xTicksToWait, const BaseType_t xWaitIndefinitely ) PRIVILEGED_FUNCTION;\r
+BaseType_t xQueueGenericReset( QueueHandle_t xQueue, BaseType_t xNewQueue ) PRIVILEGED_FUNCTION;\r
+void vQueueSetQueueNumber( QueueHandle_t xQueue, UBaseType_t uxQueueNumber ) PRIVILEGED_FUNCTION;\r
+UBaseType_t uxQueueGetQueueNumber( QueueHandle_t xQueue ) PRIVILEGED_FUNCTION;\r
+uint8_t ucQueueGetQueueType( QueueHandle_t xQueue ) PRIVILEGED_FUNCTION;\r
\r
\r
#ifdef __cplusplus\r
projects / freertos / blobdiff