]> git.sur5r.net Git - freertos/blobdiff - FreeRTOS/Source/include/FreeRTOS.h
Update to MIT licensed FreeRTOS V10.0.0 - see https://www.freertos.org/History.txt
[freertos] / FreeRTOS / Source / include / FreeRTOS.h
index 6154db1b2f746548c444416445511ac544de10b2..dfd89cd63ada011d42bf20e3e68cc9358771fb09 100644 (file)
@@ -1,71 +1,30 @@
 /*\r
-    FreeRTOS V9.0.1 - Copyright (C) 2017 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
-    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
-    ***************************************************************************\r
-    >>!   NOTE: The modification to the GPL is included to allow you to     !<<\r
-    >>!   distribute a combined work that includes FreeRTOS without being   !<<\r
-    >>!   obliged to provide the source code for proprietary components     !<<\r
-    >>!   outside of the FreeRTOS kernel.                                   !<<\r
-    ***************************************************************************\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 on the following\r
-    link: http://www.freertos.org/a00114.html\r
-\r
-    ***************************************************************************\r
-     *                                                                       *\r
-     *    FreeRTOS provides completely free yet professionally developed,    *\r
-     *    robust, strictly quality controlled, supported, and cross          *\r
-     *    platform software that is more than just the market leader, it     *\r
-     *    is the industry's de facto standard.                               *\r
-     *                                                                       *\r
-     *    Help yourself get started quickly while simultaneously helping     *\r
-     *    to support the FreeRTOS project by purchasing a FreeRTOS           *\r
-     *    tutorial book, reference manual, or both:                          *\r
-     *    http://www.FreeRTOS.org/Documentation                              *\r
-     *                                                                       *\r
-    ***************************************************************************\r
-\r
-    http://www.FreeRTOS.org/FAQHelp.html - Having a problem?  Start by reading\r
-    the FAQ page "My application does not run, what could be wrong?".  Have you\r
-    defined configASSERT()?\r
-\r
-    http://www.FreeRTOS.org/support - In return for receiving this top quality\r
-    embedded software for free we request you assist our global community by\r
-    participating in the support forum.\r
-\r
-    http://www.FreeRTOS.org/training - Investing in training allows your team to\r
-    be as productive as possible as early as possible.  Now you can receive\r
-    FreeRTOS training directly from Richard Barry, CEO of Real Time Engineers\r
-    Ltd, and the world's leading authority on the world's leading RTOS.\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.FreeRTOS.org/labs - Where new FreeRTOS products go to incubate.\r
-    Come and try FreeRTOS+TCP, our new open source TCP/IP stack for FreeRTOS.\r
-\r
-    http://www.OpenRTOS.com - Real Time Engineers ltd. license FreeRTOS to High\r
-    Integrity Systems ltd. to sell under the OpenRTOS brand.  Low cost OpenRTOS\r
-    licenses offer ticketed support, indemnification and commercial 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.0\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. If you wish to use our Amazon\r
+ * FreeRTOS name, please do so in a fair use way that does not cause confusion.\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 INC_FREERTOS_H\r
 #define INC_FREERTOS_H\r
@@ -396,6 +355,14 @@ extern "C" {
        #define traceBLOCKING_ON_QUEUE_RECEIVE( pxQueue )\r
 #endif\r
 \r
+#ifndef traceBLOCKING_ON_QUEUE_PEEK\r
+       /* Task is about to block because it cannot read from a\r
+       queue/mutex/semaphore.  pxQueue is a pointer to the queue/mutex/semaphore\r
+       upon which the read was attempted.  pxCurrentTCB points to the TCB of the\r
+       task that attempted the read. */\r
+       #define traceBLOCKING_ON_QUEUE_PEEK( pxQueue )\r
+#endif\r
+\r
 #ifndef traceBLOCKING_ON_QUEUE_SEND\r
        /* Task is about to block because it cannot write to a\r
        queue/mutex/semaphore.  pxQueue is a pointer to the queue/mutex/semaphore\r
@@ -482,6 +449,10 @@ extern "C" {
        #define traceQUEUE_PEEK( pxQueue )\r
 #endif\r
 \r
+#ifndef traceQUEUE_PEEK_FAILED\r
+       #define traceQUEUE_PEEK_FAILED( pxQueue )\r
+#endif\r
+\r
 #ifndef traceQUEUE_PEEK_FROM_ISR\r
        #define traceQUEUE_PEEK_FROM_ISR( pxQueue )\r
 #endif\r
@@ -666,6 +637,58 @@ extern "C" {
        #define traceTASK_NOTIFY_GIVE_FROM_ISR()\r
 #endif\r
 \r
+#ifndef traceSTREAM_BUFFER_CREATE_FAILED\r
+       #define traceSTREAM_BUFFER_CREATE_FAILED( xIsMessageBuffer )\r
+#endif\r
+\r
+#ifndef traceSTREAM_BUFFER_CREATE_STATIC_FAILED\r
+       #define traceSTREAM_BUFFER_CREATE_STATIC_FAILED( xReturn, xIsMessageBuffer )\r
+#endif\r
+\r
+#ifndef traceSTREAM_BUFFER_CREATE\r
+       #define traceSTREAM_BUFFER_CREATE( pxStreamBuffer, xIsMessageBuffer )\r
+#endif\r
+\r
+#ifndef traceSTREAM_BUFFER_DELETE\r
+       #define traceSTREAM_BUFFER_DELETE( xStreamBuffer )\r
+#endif\r
+\r
+#ifndef traceSTREAM_BUFFER_RESET\r
+       #define traceSTREAM_BUFFER_RESET( xStreamBuffer )\r
+#endif\r
+\r
+#ifndef traceBLOCKING_ON_STREAM_BUFFER_SEND\r
+       #define traceBLOCKING_ON_STREAM_BUFFER_SEND( xStreamBuffer )\r
+#endif\r
+\r
+#ifndef traceSTREAM_BUFFER_SEND\r
+       #define traceSTREAM_BUFFER_SEND( xStreamBuffer, xBytesSent )\r
+#endif\r
+\r
+#ifndef traceSTREAM_BUFFER_SEND_FAILED\r
+       #define traceSTREAM_BUFFER_SEND_FAILED( xStreamBuffer )\r
+#endif\r
+\r
+#ifndef traceSTREAM_BUFFER_SEND_FROM_ISR\r
+       #define traceSTREAM_BUFFER_SEND_FROM_ISR( xStreamBuffer, xBytesSent )\r
+#endif\r
+\r
+#ifndef traceBLOCKING_ON_STREAM_BUFFER_RECEIVE\r
+       #define traceBLOCKING_ON_STREAM_BUFFER_RECEIVE( xStreamBuffer )\r
+#endif\r
+\r
+#ifndef traceSTREAM_BUFFER_RECEIVE\r
+       #define traceSTREAM_BUFFER_RECEIVE( xStreamBuffer, xReceivedLength )\r
+#endif\r
+\r
+#ifndef traceSTREAM_BUFFER_RECEIVE_FAILED\r
+       #define traceSTREAM_BUFFER_RECEIVE_FAILED( xStreamBuffer )\r
+#endif\r
+\r
+#ifndef traceSTREAM_BUFFER_RECEIVE_FROM_ISR\r
+       #define traceSTREAM_BUFFER_RECEIVE_FROM_ISR( xStreamBuffer, xReceivedLength )\r
+#endif\r
+\r
 #ifndef configGENERATE_RUN_TIME_STATS\r
        #define configGENERATE_RUN_TIME_STATS 0\r
 #endif\r
@@ -846,6 +869,32 @@ V8 if desired. */
        #define configENABLE_BACKWARD_COMPATIBILITY 1\r
 #endif\r
 \r
+#ifndef configPRINTF\r
+       /* configPRINTF() was not defined, so define it away to nothing.  To use\r
+       configPRINTF() then define it as follows (where MyPrintFunction() is\r
+       provided by the application writer):\r
+\r
+       void MyPrintFunction(const char *pcFormat, ... );\r
+       #define configPRINTF( X )   MyPrintFunction X\r
+\r
+       Then call like a standard printf() function, but placing brackets around\r
+       all parameters so they are passed as a single parameter.  For example:\r
+       configPRINTF( ("Value = %d", MyVariable) ); */\r
+       #define configPRINTF( X )\r
+#endif\r
+\r
+#ifndef configMAX\r
+       /* The application writer has not provided their own MAX macro, so define\r
+       the following generic implementation. */\r
+       #define configMAX( a, b ) ( ( ( a ) > ( b ) ) ? ( a ) : ( b ) )\r
+#endif\r
+\r
+#ifndef configMIN\r
+       /* The application writer has not provided their own MAX macro, so define\r
+       the following generic implementation. */\r
+       #define configMIN( a, b ) ( ( ( a ) < ( b ) ) ? ( a ) : ( b ) )\r
+#endif\r
+\r
 #if configENABLE_BACKWARD_COMPATIBILITY == 1\r
        #define eTaskStateGet eTaskGetState\r
        #define portTickType TickType_t\r
@@ -1085,6 +1134,33 @@ typedef struct xSTATIC_TIMER
 \r
 } StaticTimer_t;\r
 \r
+/*\r
+* In line with software engineering best practice, especially when supplying a\r
+* library that is likely to change in future versions, FreeRTOS implements a\r
+* strict data hiding policy.  This means the stream buffer structure used\r
+* internally by FreeRTOS is not accessible to application code.  However, if\r
+* the application writer wants to statically allocate the memory required to\r
+* create a stream buffer then the size of the stream buffer object needs to be\r
+* know.  The StaticStreamBuffer_t structure below is provided for this purpose.\r
+* Its size and alignment requirements are guaranteed to match those of the\r
+* genuine structure, no matter which architecture is being used, and no matter\r
+* how the values in FreeRTOSConfig.h are set.  Its contents are somewhat\r
+* obfuscated in the hope users will recognise that it would be unwise to make\r
+* direct use of the structure members.\r
+*/\r
+typedef struct xSTATIC_STREAM_BUFFER\r
+{\r
+       size_t uxDummy1[ 4 ];\r
+       void * pvDummy2[ 3 ];\r
+       uint8_t ucDummy3;\r
+       #if ( configUSE_TRACE_FACILITY == 1 )\r
+               UBaseType_t uxDummy4;\r
+       #endif\r
+} StaticStreamBuffer_t;\r
+\r
+/* Message buffers are built on stream buffers. */\r
+typedef StaticStreamBuffer_t StaticMessageBuffer_t;\r
+\r
 #ifdef __cplusplus\r
 }\r
 #endif\r