]> git.sur5r.net Git - freertos/blob - FreeRTOS/Source/include/projdefs.h
Update version numbers ready for release.
[freertos] / FreeRTOS / Source / include / projdefs.h
1 /*\r
2  * FreeRTOS Kernel V10.1.1\r
3  * Copyright (C) 2018 Amazon.com, Inc. or its affiliates.  All Rights Reserved.\r
4  *\r
5  * Permission is hereby granted, free of charge, to any person obtaining a copy of\r
6  * this software and associated documentation files (the "Software"), to deal in\r
7  * the Software without restriction, including without limitation the rights to\r
8  * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\r
9  * the Software, and to permit persons to whom the Software is furnished to do so,\r
10  * subject to the following conditions:\r
11  *\r
12  * The above copyright notice and this permission notice shall be included in all\r
13  * copies or substantial portions of the Software.\r
14  *\r
15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\r
17  * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\r
18  * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\r
19  * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\r
20  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r
21  *\r
22  * http://www.FreeRTOS.org\r
23  * http://aws.amazon.com/freertos\r
24  *\r
25  * 1 tab == 4 spaces!\r
26  */\r
27 \r
28 #ifndef PROJDEFS_H\r
29 #define PROJDEFS_H\r
30 \r
31 /*\r
32  * Defines the prototype to which task functions must conform.  Defined in this\r
33  * file to ensure the type is known before portable.h is included.\r
34  */\r
35 typedef void (*TaskFunction_t)( void * );\r
36 \r
37 /* Converts a time in milliseconds to a time in ticks.  This macro can be\r
38 overridden by a macro of the same name defined in FreeRTOSConfig.h in case the\r
39 definition here is not suitable for your application. */\r
40 #ifndef pdMS_TO_TICKS\r
41         #define pdMS_TO_TICKS( xTimeInMs ) ( ( TickType_t ) ( ( ( TickType_t ) ( xTimeInMs ) * ( TickType_t ) configTICK_RATE_HZ ) / ( TickType_t ) 1000 ) )\r
42 #endif\r
43 \r
44 #define pdFALSE                 ( ( BaseType_t ) 0 )\r
45 #define pdTRUE                  ( ( BaseType_t ) 1 )\r
46 \r
47 #define pdPASS                  ( pdTRUE )\r
48 #define pdFAIL                  ( pdFALSE )\r
49 #define errQUEUE_EMPTY  ( ( BaseType_t ) 0 )\r
50 #define errQUEUE_FULL   ( ( BaseType_t ) 0 )\r
51 \r
52 /* FreeRTOS error definitions. */\r
53 #define errCOULD_NOT_ALLOCATE_REQUIRED_MEMORY   ( -1 )\r
54 #define errQUEUE_BLOCKED                                                ( -4 )\r
55 #define errQUEUE_YIELD                                                  ( -5 )\r
56 \r
57 /* Macros used for basic data corruption checks. */\r
58 #ifndef configUSE_LIST_DATA_INTEGRITY_CHECK_BYTES\r
59         #define configUSE_LIST_DATA_INTEGRITY_CHECK_BYTES 0\r
60 #endif\r
61 \r
62 #if( configUSE_16_BIT_TICKS == 1 )\r
63         #define pdINTEGRITY_CHECK_VALUE 0x5a5a\r
64 #else\r
65         #define pdINTEGRITY_CHECK_VALUE 0x5a5a5a5aUL\r
66 #endif\r
67 \r
68 /* The following errno values are used by FreeRTOS+ components, not FreeRTOS\r
69 itself. */\r
70 #define pdFREERTOS_ERRNO_NONE                   0       /* No errors */\r
71 #define pdFREERTOS_ERRNO_ENOENT                 2       /* No such file or directory */\r
72 #define pdFREERTOS_ERRNO_EINTR                  4       /* Interrupted system call */\r
73 #define pdFREERTOS_ERRNO_EIO                    5       /* I/O error */\r
74 #define pdFREERTOS_ERRNO_ENXIO                  6       /* No such device or address */\r
75 #define pdFREERTOS_ERRNO_EBADF                  9       /* Bad file number */\r
76 #define pdFREERTOS_ERRNO_EAGAIN                 11      /* No more processes */\r
77 #define pdFREERTOS_ERRNO_EWOULDBLOCK    11      /* Operation would block */\r
78 #define pdFREERTOS_ERRNO_ENOMEM                 12      /* Not enough memory */\r
79 #define pdFREERTOS_ERRNO_EACCES                 13      /* Permission denied */\r
80 #define pdFREERTOS_ERRNO_EFAULT                 14      /* Bad address */\r
81 #define pdFREERTOS_ERRNO_EBUSY                  16      /* Mount device busy */\r
82 #define pdFREERTOS_ERRNO_EEXIST                 17      /* File exists */\r
83 #define pdFREERTOS_ERRNO_EXDEV                  18      /* Cross-device link */\r
84 #define pdFREERTOS_ERRNO_ENODEV                 19      /* No such device */\r
85 #define pdFREERTOS_ERRNO_ENOTDIR                20      /* Not a directory */\r
86 #define pdFREERTOS_ERRNO_EISDIR                 21      /* Is a directory */\r
87 #define pdFREERTOS_ERRNO_EINVAL                 22      /* Invalid argument */\r
88 #define pdFREERTOS_ERRNO_ENOSPC                 28      /* No space left on device */\r
89 #define pdFREERTOS_ERRNO_ESPIPE                 29      /* Illegal seek */\r
90 #define pdFREERTOS_ERRNO_EROFS                  30      /* Read only file system */\r
91 #define pdFREERTOS_ERRNO_EUNATCH                42      /* Protocol driver not attached */\r
92 #define pdFREERTOS_ERRNO_EBADE                  50      /* Invalid exchange */\r
93 #define pdFREERTOS_ERRNO_EFTYPE                 79      /* Inappropriate file type or format */\r
94 #define pdFREERTOS_ERRNO_ENMFILE                89      /* No more files */\r
95 #define pdFREERTOS_ERRNO_ENOTEMPTY              90      /* Directory not empty */\r
96 #define pdFREERTOS_ERRNO_ENAMETOOLONG   91      /* File or path name too long */\r
97 #define pdFREERTOS_ERRNO_EOPNOTSUPP             95      /* Operation not supported on transport endpoint */\r
98 #define pdFREERTOS_ERRNO_ENOBUFS                105     /* No buffer space available */\r
99 #define pdFREERTOS_ERRNO_ENOPROTOOPT    109     /* Protocol not available */\r
100 #define pdFREERTOS_ERRNO_EADDRINUSE             112     /* Address already in use */\r
101 #define pdFREERTOS_ERRNO_ETIMEDOUT              116     /* Connection timed out */\r
102 #define pdFREERTOS_ERRNO_EINPROGRESS    119     /* Connection already in progress */\r
103 #define pdFREERTOS_ERRNO_EALREADY               120     /* Socket already connected */\r
104 #define pdFREERTOS_ERRNO_EADDRNOTAVAIL  125     /* Address not available */\r
105 #define pdFREERTOS_ERRNO_EISCONN                127     /* Socket is already connected */\r
106 #define pdFREERTOS_ERRNO_ENOTCONN               128     /* Socket is not connected */\r
107 #define pdFREERTOS_ERRNO_ENOMEDIUM              135     /* No medium inserted */\r
108 #define pdFREERTOS_ERRNO_EILSEQ                 138     /* An invalid UTF-16 sequence was encountered. */\r
109 #define pdFREERTOS_ERRNO_ECANCELED              140     /* Operation canceled. */\r
110 \r
111 /* The following endian values are used by FreeRTOS+ components, not FreeRTOS\r
112 itself. */\r
113 #define pdFREERTOS_LITTLE_ENDIAN                0\r
114 #define pdFREERTOS_BIG_ENDIAN                   1\r
115 \r
116 /* Re-defining endian values for generic naming. */\r
117 #define pdLITTLE_ENDIAN                                 pdFREERTOS_LITTLE_ENDIAN\r
118 #define pdBIG_ENDIAN                                    pdFREERTOS_BIG_ENDIAN\r
119 \r
120 \r
121 #endif /* PROJDEFS_H */\r
122 \r
123 \r
124 \r