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