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