/*\r
- FreeRTOS V8.0.0:rc1 - Copyright (C) 2014 Real Time Engineers Ltd.\r
- All rights reserved\r
-\r
- VISIT http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.\r
-\r
- ***************************************************************************\r
- * *\r
- * FreeRTOS provides completely free yet professionally developed, *\r
- * robust, strictly quality controlled, supported, and cross *\r
- * platform software that has become a de facto standard. *\r
- * *\r
- * Help yourself get started quickly and support the FreeRTOS *\r
- * project by purchasing a FreeRTOS tutorial book, reference *\r
- * manual, or both from: http://www.FreeRTOS.org/Documentation *\r
- * *\r
- * Thank you! *\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 distribute\r
- >>! a combined work that includes FreeRTOS without being obliged to provide\r
- >>! 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. Full license text is available from the following\r
- link: http://www.freertos.org/a00114.html\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
- 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, a DOS\r
- compatible FAT file system, and our tiny thread aware UDP/IP stack.\r
-\r
- http://www.OpenRTOS.com - Real Time Engineers ltd license FreeRTOS to High\r
- Integrity Systems to sell under the OpenRTOS brand. Low cost OpenRTOS\r
- licenses offer ticketed support, indemnification and middleware.\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
- 1 tab == 4 spaces!\r
-*/\r
+ * FreeRTOS Kernel V10.0.1\r
+ * Copyright (C) 2017 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
#ifndef EVENT_GROUPS_H\r
#define EVENT_GROUPS_H\r
#error "include FreeRTOS.h" must appear in source files before "include event_groups.h"\r
#endif\r
\r
+/* FreeRTOS includes. */\r
#include "timers.h"\r
\r
#ifdef __cplusplus\r
* \defgroup EventGroupHandle_t EventGroupHandle_t\r
* \ingroup EventGroup\r
*/\r
-typedef void * EventGroupHandle_t;\r
+struct EventGroupDef_t;\r
+typedef struct EventGroupDef_t * EventGroupHandle_t;\r
\r
-/* \r
+/*\r
* The type that holds event bits always matches TickType_t - therefore the\r
* number of bits it holds is set by configUSE_16_BIT_TICKS (16 bits if set to 1,\r
- * 32 bits if set to 0. \r
+ * 32 bits if set to 0.\r
*\r
* \defgroup EventBits_t EventBits_t\r
* \ingroup EventGroup\r
EventGroupHandle_t xEventGroupCreate( void );\r
</pre>\r
*\r
- * Create a new event group. This function cannot be called from an interrupt.\r
+ * Create a new event group.\r
+ *\r
+ * Internally, within the FreeRTOS implementation, event groups use a [small]\r
+ * block of memory, in which the event group's structure is stored. If an event\r
+ * groups is created using xEventGropuCreate() then the required memory is\r
+ * automatically dynamically allocated inside the xEventGroupCreate() function.\r
+ * (see http://www.freertos.org/a00111.html). If an event group is created\r
+ * using xEventGropuCreateStatic() then the application writer must instead\r
+ * provide the memory that will get used by the event group.\r
+ * xEventGroupCreateStatic() therefore allows an event group to be created\r
+ * without using any dynamic memory allocation.\r
*\r
* Although event groups are not related to ticks, for internal implementation\r
* reasons the number of bits available for use in an event group is dependent\r
* \defgroup xEventGroupCreate xEventGroupCreate\r
* \ingroup EventGroup\r
*/\r
-EventGroupHandle_t xEventGroupCreate( void ) PRIVILEGED_FUNCTION;\r
+#if( configSUPPORT_DYNAMIC_ALLOCATION == 1 )\r
+ EventGroupHandle_t xEventGroupCreate( void ) PRIVILEGED_FUNCTION;\r
+#endif\r
+\r
+/**\r
+ * event_groups.h\r
+ *<pre>\r
+ EventGroupHandle_t xEventGroupCreateStatic( EventGroupHandle_t * pxEventGroupBuffer );\r
+ </pre>\r
+ *\r
+ * Create a new event group.\r
+ *\r
+ * Internally, within the FreeRTOS implementation, event groups use a [small]\r
+ * block of memory, in which the event group's structure is stored. If an event\r
+ * groups is created using xEventGropuCreate() then the required memory is\r
+ * automatically dynamically allocated inside the xEventGroupCreate() function.\r
+ * (see http://www.freertos.org/a00111.html). If an event group is created\r
+ * using xEventGropuCreateStatic() then the application writer must instead\r
+ * provide the memory that will get used by the event group.\r
+ * xEventGroupCreateStatic() therefore allows an event group to be created\r
+ * without using any dynamic memory allocation.\r
+ *\r
+ * Although event groups are not related to ticks, for internal implementation\r
+ * reasons the number of bits available for use in an event group is dependent\r
+ * on the configUSE_16_BIT_TICKS setting in FreeRTOSConfig.h. If\r
+ * configUSE_16_BIT_TICKS is 1 then each event group contains 8 usable bits (bit\r
+ * 0 to bit 7). If configUSE_16_BIT_TICKS is set to 0 then each event group has\r
+ * 24 usable bits (bit 0 to bit 23). The EventBits_t type is used to store\r
+ * event bits within an event group.\r
+ *\r
+ * @param pxEventGroupBuffer pxEventGroupBuffer must point to a variable of type\r
+ * StaticEventGroup_t, which will be then be used to hold the event group's data\r
+ * structures, removing the need for the memory to be allocated dynamically.\r
+ *\r
+ * @return If the event group was created then a handle to the event group is\r
+ * returned. If pxEventGroupBuffer was NULL then NULL is returned.\r
+ *\r
+ * Example usage:\r
+ <pre>\r
+ // StaticEventGroup_t is a publicly accessible structure that has the same\r
+ // size and alignment requirements as the real event group structure. It is\r
+ // provided as a mechanism for applications to know the size of the event\r
+ // group (which is dependent on the architecture and configuration file\r
+ // settings) without breaking the strict data hiding policy by exposing the\r
+ // real event group internals. This StaticEventGroup_t variable is passed\r
+ // into the xSemaphoreCreateEventGroupStatic() function and is used to store\r
+ // the event group's data structures\r
+ StaticEventGroup_t xEventGroupBuffer;\r
+\r
+ // Create the event group without dynamically allocating any memory.\r
+ xEventGroup = xEventGroupCreateStatic( &xEventGroupBuffer );\r
+ </pre>\r
+ */\r
+#if( configSUPPORT_STATIC_ALLOCATION == 1 )\r
+ EventGroupHandle_t xEventGroupCreateStatic( StaticEventGroup_t *pxEventGroupBuffer ) PRIVILEGED_FUNCTION;\r
+#endif\r
\r
/**\r
* event_groups.h\r
/**\r
* event_groups.h\r
*<pre>\r
- EventBits_t xEventGroupClearBitsFromISR( EventGroupHandle_t xEventGroup, const EventBits_t uxBitsToClear );\r
+ BaseType_t xEventGroupClearBitsFromISR( EventGroupHandle_t xEventGroup, const EventBits_t uxBitsToSet );\r
</pre>\r
*\r
- * A version of xEventGroupClearBits() that can be called from an interrupt\r
- * service routine. See the xEventGroupClearBits() documentation.\r
+ * A version of xEventGroupClearBits() that can be called from an interrupt.\r
*\r
+ * Setting bits in an event group is not a deterministic operation because there\r
+ * are an unknown number of tasks that may be waiting for the bit or bits being\r
+ * set. FreeRTOS does not allow nondeterministic operations to be performed\r
+ * while interrupts are disabled, so protects event groups that are accessed\r
+ * from tasks by suspending the scheduler rather than disabling interrupts. As\r
+ * a result event groups cannot be accessed directly from an interrupt service\r
+ * routine. Therefore xEventGroupClearBitsFromISR() sends a message to the\r
+ * timer task to have the clear operation performed in the context of the timer\r
+ * task.\r
+ *\r
+ * @param xEventGroup The event group in which the bits are to be cleared.\r
+ *\r
+ * @param uxBitsToClear A bitwise value that indicates the bit or bits to clear.\r
+ * For example, to clear bit 3 only, set uxBitsToClear to 0x08. To clear bit 3\r
+ * and bit 0 set uxBitsToClear to 0x09.\r
+ *\r
+ * @return If the request to execute the function was posted successfully then\r
+ * pdPASS is returned, otherwise pdFALSE is returned. pdFALSE will be returned\r
+ * if the timer service queue was full.\r
+ *\r
+ * Example usage:\r
+ <pre>\r
+ #define BIT_0 ( 1 << 0 )\r
+ #define BIT_4 ( 1 << 4 )\r
+\r
+ // An event group which it is assumed has already been created by a call to\r
+ // xEventGroupCreate().\r
+ EventGroupHandle_t xEventGroup;\r
+\r
+ void anInterruptHandler( void )\r
+ {\r
+ // Clear bit 0 and bit 4 in xEventGroup.\r
+ xResult = xEventGroupClearBitsFromISR(\r
+ xEventGroup, // The event group being updated.\r
+ BIT_0 | BIT_4 ); // The bits being set.\r
+\r
+ if( xResult == pdPASS )\r
+ {\r
+ // The message was posted successfully.\r
+ }\r
+ }\r
+ </pre>\r
* \defgroup xEventGroupClearBitsFromISR xEventGroupClearBitsFromISR\r
* \ingroup EventGroup\r
*/\r
-EventBits_t xEventGroupClearBitsFromISR( EventGroupHandle_t xEventGroup, const EventBits_t uxBitsToClear ) PRIVILEGED_FUNCTION;\r
+#if( configUSE_TRACE_FACILITY == 1 )\r
+ BaseType_t xEventGroupClearBitsFromISR( EventGroupHandle_t xEventGroup, const EventBits_t uxBitsToClear ) PRIVILEGED_FUNCTION;\r
+#else\r
+ #define xEventGroupClearBitsFromISR( xEventGroup, uxBitsToClear ) xTimerPendFunctionCallFromISR( vEventGroupClearBitsCallback, ( void * ) xEventGroup, ( uint32_t ) uxBitsToClear, NULL )\r
+#endif\r
\r
/**\r
* event_groups.h\r
* Setting bits in an event group is not a deterministic operation because there\r
* are an unknown number of tasks that may be waiting for the bit or bits being\r
* set. FreeRTOS does not allow nondeterministic operations to be performed in\r
- * interrupts or from critical sections. Therefore xEventGroupSetBitFromISR()\r
+ * interrupts or from critical sections. Therefore xEventGroupSetBitsFromISR()\r
* sends a message to the timer task to have the set operation performed in the\r
* context of the timer task - where a scheduler lock is used in place of a\r
* critical section.\r
* *pxHigherPriorityTaskWoken must be initialised to pdFALSE. See the\r
* example code below.\r
*\r
- * @return If the request to execute the function was posted successfully then \r
- * pdPASS is returned, otherwise pdFALSE is returned. pdFALSE will be returned \r
+ * @return If the request to execute the function was posted successfully then\r
+ * pdPASS is returned, otherwise pdFALSE is returned. pdFALSE will be returned\r
* if the timer service queue was full.\r
*\r
* Example usage:\r
if( xResult == pdPASS )\r
{\r
// If xHigherPriorityTaskWoken is now set to pdTRUE then a context\r
- // switch should be requested. The macro used is port specific and \r
- // will be either portYIELD_FROM_ISR() or portEND_SWITCHING_ISR() - \r
+ // switch should be requested. The macro used is port specific and\r
+ // will be either portYIELD_FROM_ISR() or portEND_SWITCHING_ISR() -\r
// refer to the documentation page for the port being used.\r
portYIELD_FROM_ISR( xHigherPriorityTaskWoken );\r
}\r
* \ingroup EventGroup\r
*/\r
#if( configUSE_TRACE_FACILITY == 1 )\r
- BaseType_t xEventGroupSetBitsFromISR( EventGroupHandle_t xEventGroup, const EventBits_t uxBitsToSet, BaseType_t *pxHigherPriorityTaskWoken );\r
+ BaseType_t xEventGroupSetBitsFromISR( EventGroupHandle_t xEventGroup, const EventBits_t uxBitsToSet, BaseType_t *pxHigherPriorityTaskWoken ) PRIVILEGED_FUNCTION;\r
#else\r
#define xEventGroupSetBitsFromISR( xEventGroup, uxBitsToSet, pxHigherPriorityTaskWoken ) xTimerPendFunctionCallFromISR( vEventGroupSetBitsCallback, ( void * ) xEventGroup, ( uint32_t ) uxBitsToSet, pxHigherPriorityTaskWoken )\r
#endif\r
* \defgroup xEventGroupGetBitsFromISR xEventGroupGetBitsFromISR\r
* \ingroup EventGroup\r
*/\r
-#define xEventGroupGetBitsFromISR( xEventGroup ) xEventGroupClearBitsFromISR( xEventGroup, 0 )\r
+EventBits_t xEventGroupGetBitsFromISR( EventGroupHandle_t xEventGroup ) PRIVILEGED_FUNCTION;\r
\r
/**\r
* event_groups.h\r
*\r
* @param xEventGroup The event group being deleted.\r
*/\r
-void vEventGroupDelete( EventGroupHandle_t xEventGroup );\r
+void vEventGroupDelete( EventGroupHandle_t xEventGroup ) PRIVILEGED_FUNCTION;\r
\r
/* For internal use only. */\r
-void vEventGroupSetBitsCallback( void *pvEventGroup, const uint32_t ulBitsToSet );\r
+void vEventGroupSetBitsCallback( void *pvEventGroup, const uint32_t ulBitsToSet ) PRIVILEGED_FUNCTION;\r
+void vEventGroupClearBitsCallback( void *pvEventGroup, const uint32_t ulBitsToClear ) PRIVILEGED_FUNCTION;\r
+\r
\r
#if (configUSE_TRACE_FACILITY == 1)\r
- UBaseType_t uxEventGroupGetNumber( void* xEventGroup );\r
+ UBaseType_t uxEventGroupGetNumber( void* xEventGroup ) PRIVILEGED_FUNCTION;\r
+ void vEventGroupSetNumber( void* xEventGroup, UBaseType_t uxEventGroupNumber ) PRIVILEGED_FUNCTION;\r
#endif\r
\r
#ifdef __cplusplus\r
projects / freertos / blobdiff