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