Update version number ready for version 9 release candidate 1.

[freertos] / FreeRTOS / Source / include / projdefs.h

diff --git a/FreeRTOS/Source/include/projdefs.h b/FreeRTOS/Source/include/projdefs.h
index 5371cddcceddc632090a99836878318aa0b3b3c3..bfb0fd88c22a5750698650d0734816c1ee23a20f 100644 (file)
--- a/FreeRTOS/Source/include/projdefs.h
+++ b/FreeRTOS/Source/include/projdefs.h
@@ -1,97 +1,156 @@
 /*\r
 /*\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
+    FreeRTOS V9.0.0rc1 - Copyright (C) 2016 Real Time Engineers Ltd.\r
+    All rights reserved\r

 \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
 \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
+    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 obliged to\r
-    provide the source code for proprietary components outside of the FreeRTOS\r
-    kernel.\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
 \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
+    FOR A PARTICULAR PURPOSE.  Full license text is available on the following\r
+    link: http://www.freertos.org/a00114.html\r

 \r
     ***************************************************************************\r
      *                                                                       *\r
 \r
     ***************************************************************************\r
      *                                                                       *\r

-     *    Having a problem?  Start by reading the FAQ "My application does   *\r
-     *    not run, what could be wrong?"                                     *\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
      *                                                                       *\r

-     *    http://www.FreeRTOS.org/FAQHelp.html                               *\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
      *                                                                       *\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
 \r

-    http://www.FreeRTOS.org - Documentation, books, training, latest versions, \r
-    license and Real Time Engineers Ltd. contact details.\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
 \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
+    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
     mission critical applications that require provable dependability.\r

+\r
+    1 tab == 4 spaces!\r

 */\r
 \r
 #ifndef PROJDEFS_H\r
 #define PROJDEFS_H\r
 \r
 */\r
 \r
 #ifndef PROJDEFS_H\r
 #define PROJDEFS_H\r
 \r

-/* Defines the prototype to which task functions must conform. */\r
-typedef void (*pdTASK_CODE)( void * );\r
+/*\r
+ * Defines the prototype to which task functions must conform.  Defined in this\r
+ * file to ensure the type is known before portable.h is included.\r
+ */\r
+typedef void (*TaskFunction_t)( void * );\r

 \r
 \r

-#define pdTRUE         ( 1 )\r
-#define pdFALSE                ( 0 )\r
+/* Converts a time in milliseconds to a time in ticks. */\r
+#define pdMS_TO_TICKS( xTimeInMs ) ( ( TickType_t ) ( ( ( TickType_t ) ( xTimeInMs ) * ( TickType_t ) configTICK_RATE_HZ ) / ( TickType_t ) 1000 ) )\r

 \r
 \r

-#define pdPASS                                                                 ( 1 )\r
-#define pdFAIL                                                                 ( 0 )\r
-#define errQUEUE_EMPTY                                                 ( 0 )\r
-#define errQUEUE_FULL                                                  ( 0 )\r
+#define pdFALSE                        ( ( BaseType_t ) 0 )\r
+#define pdTRUE                 ( ( BaseType_t ) 1 )\r

 \r
 \r

-/* Error definitions. */\r
+#define pdPASS                 ( pdTRUE )\r
+#define pdFAIL                 ( pdFALSE )\r
+#define errQUEUE_EMPTY ( ( BaseType_t ) 0 )\r
+#define errQUEUE_FULL  ( ( BaseType_t ) 0 )\r
+\r
+/* FreeRTOS error definitions. */\r

 #define errCOULD_NOT_ALLOCATE_REQUIRED_MEMORY  ( -1 )\r
 #define errCOULD_NOT_ALLOCATE_REQUIRED_MEMORY  ( -1 )\r

-#define errNO_TASK_TO_RUN                                              ( -2 )\r

 #define errQUEUE_BLOCKED                                               ( -4 )\r
 #define errQUEUE_YIELD                                                 ( -5 )\r
 \r
 #define errQUEUE_BLOCKED                                               ( -4 )\r
 #define errQUEUE_YIELD                                                 ( -5 )\r
 \r

+/* Macros used for basic data corruption checks. */\r
+#ifndef configUSE_LIST_DATA_INTEGRITY_CHECK_BYTES\r
+       #define configUSE_LIST_DATA_INTEGRITY_CHECK_BYTES 0\r
+#endif\r
+\r
+#if( configUSE_16_BIT_TICKS == 1 )\r
+       #define pdINTEGRITY_CHECK_VALUE 0x5a5a\r
+#else\r
+       #define pdINTEGRITY_CHECK_VALUE 0x5a5a5a5aUL\r
+#endif\r
+\r
+/* The following errno values are used by FreeRTOS+ components, not FreeRTOS\r
+itself. */\r
+#define pdFREERTOS_ERRNO_NONE                  0       /* No errors */\r
+#define        pdFREERTOS_ERRNO_ENOENT                 2       /* No such file or directory */\r
+#define        pdFREERTOS_ERRNO_EINTR                  4       /* Interrupted system call */\r
+#define        pdFREERTOS_ERRNO_EIO                    5       /* I/O error */\r
+#define        pdFREERTOS_ERRNO_ENXIO                  6       /* No such device or address */\r
+#define        pdFREERTOS_ERRNO_EBADF                  9       /* Bad file number */\r
+#define        pdFREERTOS_ERRNO_EAGAIN                 11      /* No more processes */\r
+#define        pdFREERTOS_ERRNO_EWOULDBLOCK    11      /* Operation would block */\r
+#define        pdFREERTOS_ERRNO_ENOMEM                 12      /* Not enough memory */\r
+#define        pdFREERTOS_ERRNO_EACCES                 13      /* Permission denied */\r
+#define        pdFREERTOS_ERRNO_EFAULT                 14      /* Bad address */\r
+#define        pdFREERTOS_ERRNO_EBUSY                  16      /* Mount device busy */\r
+#define        pdFREERTOS_ERRNO_EEXIST                 17      /* File exists */\r
+#define        pdFREERTOS_ERRNO_EXDEV                  18      /* Cross-device link */\r
+#define        pdFREERTOS_ERRNO_ENODEV                 19      /* No such device */\r
+#define        pdFREERTOS_ERRNO_ENOTDIR                20      /* Not a directory */\r
+#define        pdFREERTOS_ERRNO_EISDIR                 21      /* Is a directory */\r
+#define        pdFREERTOS_ERRNO_EINVAL                 22      /* Invalid argument */\r
+#define        pdFREERTOS_ERRNO_ENOSPC                 28      /* No space left on device */\r
+#define        pdFREERTOS_ERRNO_ESPIPE                 29      /* Illegal seek */\r
+#define        pdFREERTOS_ERRNO_EROFS                  30      /* Read only file system */\r
+#define        pdFREERTOS_ERRNO_EUNATCH                42      /* Protocol driver not attached */\r
+#define        pdFREERTOS_ERRNO_EBADE                  50      /* Invalid exchange */\r
+#define        pdFREERTOS_ERRNO_EFTYPE                 79      /* Inappropriate file type or format */\r
+#define        pdFREERTOS_ERRNO_ENMFILE                89      /* No more files */\r
+#define        pdFREERTOS_ERRNO_ENOTEMPTY              90      /* Directory not empty */\r
+#define        pdFREERTOS_ERRNO_ENAMETOOLONG   91      /* File or path name too long */\r
+#define        pdFREERTOS_ERRNO_EOPNOTSUPP             95      /* Operation not supported on transport endpoint */\r
+#define        pdFREERTOS_ERRNO_ENOBUFS                105     /* No buffer space available */\r
+#define        pdFREERTOS_ERRNO_ENOPROTOOPT    109     /* Protocol not available */\r
+#define        pdFREERTOS_ERRNO_EADDRINUSE             112     /* Address already in use */\r
+#define        pdFREERTOS_ERRNO_ETIMEDOUT              116     /* Connection timed out */\r
+#define        pdFREERTOS_ERRNO_EINPROGRESS    119     /* Connection already in progress */\r
+#define        pdFREERTOS_ERRNO_EALREADY               120     /* Socket already connected */\r
+#define        pdFREERTOS_ERRNO_EADDRNOTAVAIL  125     /* Address not available */\r
+#define        pdFREERTOS_ERRNO_EISCONN                127     /* Socket is already connected */\r
+#define        pdFREERTOS_ERRNO_ENOTCONN               128     /* Socket is not connected */\r
+#define        pdFREERTOS_ERRNO_ENOMEDIUM              135     /* No medium inserted */\r
+#define        pdFREERTOS_ERRNO_EILSEQ                 138     /* An invalid UTF-16 sequence was encountered. */\r
+#define        pdFREERTOS_ERRNO_ECANCELED              140     /* Operation canceled. */\r
+\r
+/* The following endian values are used by FreeRTOS+ components, not FreeRTOS\r
+itself. */\r
+#define pdFREERTOS_LITTLE_ENDIAN       0\r
+#define pdFREERTOS_BIG_ENDIAN          1\r
+\r

 #endif /* PROJDEFS_H */\r
 \r
 \r
 #endif /* PROJDEFS_H */\r
 \r
 \r