]> git.sur5r.net Git - freertos/blobdiff - FreeRTOS/Source/include/projdefs.h
Update version number ready for version 9 release candidate 1.
[freertos] / FreeRTOS / Source / include / projdefs.h
index 74aa84f0dbfde6caeffafd9a745fd0ed4b295abe..bfb0fd88c22a5750698650d0734816c1ee23a20f 100644 (file)
@@ -1,60 +1,64 @@
 /*\r
-    FreeRTOS V7.6.0 - Copyright (C) 2013 Real Time Engineers Ltd.\r
+    FreeRTOS V9.0.0rc1 - Copyright (C) 2016 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
+    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
+    >>!   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 from the following\r
+    FOR A PARTICULAR PURPOSE.  Full license text is available on 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
+     *    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
-     *    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
-    http://www.FreeRTOS.org - Documentation, books, training, latest versions,\r
-    license and Real Time Engineers Ltd. contact details.\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.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
+    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
 #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
-/* Defines the prototype to which callback functions called from the RTOS/timer\r
-daemon task must conform. */\r
-typedef void (*pdAPPLICATION_CALLBACK_CODE)( void *, unsigned long );\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
-#define pdFALSE                ( ( portBASE_TYPE ) 0 )\r
-#define pdTRUE         ( ( portBASE_TYPE ) 1 )\r
+#define pdFALSE                        ( ( BaseType_t ) 0 )\r
+#define pdTRUE                 ( ( BaseType_t ) 1 )\r
 \r
-#define pdPASS                                                                 ( pdTRUE )\r
-#define pdFAIL                                                                 ( pdFALSE )\r
-#define errQUEUE_EMPTY                                                 ( ( portBASE_TYPE ) 0 )\r
-#define errQUEUE_FULL                                                  ( ( portBASE_TYPE ) 0 )\r
+#define pdPASS                 ( pdTRUE )\r
+#define pdFAIL                 ( pdFALSE )\r
+#define errQUEUE_EMPTY ( ( BaseType_t ) 0 )\r
+#define errQUEUE_FULL  ( ( BaseType_t ) 0 )\r
 \r
-/* Error definitions. */\r
+/* FreeRTOS error definitions. */\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
+/* 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