]> begriffs open source - cmsis-freertos/blob - Source/include/projdefs.h
Updated pdsc after release (development version).
[cmsis-freertos] / Source / include / projdefs.h
1 /*
2  * FreeRTOS Kernel V10.2.0
3  * Copyright (C) 2019 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  * http://www.FreeRTOS.org
23  * http://aws.amazon.com/freertos
24  *
25  * 1 tab == 4 spaces!
26  */
27
28 #ifndef PROJDEFS_H
29 #define PROJDEFS_H
30
31 /*
32  * Defines the prototype to which task functions must conform.  Defined in this
33  * file to ensure the type is known before portable.h is included.
34  */
35 typedef void (*TaskFunction_t)( void * );
36
37 /* Converts a time in milliseconds to a time in ticks.  This macro can be
38 overridden by a macro of the same name defined in FreeRTOSConfig.h in case the
39 definition here is not suitable for your application. */
40 #ifndef pdMS_TO_TICKS
41         #define pdMS_TO_TICKS( xTimeInMs ) ( ( TickType_t ) ( ( ( TickType_t ) ( xTimeInMs ) * ( TickType_t ) configTICK_RATE_HZ ) / ( TickType_t ) 1000 ) )
42 #endif
43
44 #define pdFALSE                 ( ( BaseType_t ) 0 )
45 #define pdTRUE                  ( ( BaseType_t ) 1 )
46
47 #define pdPASS                  ( pdTRUE )
48 #define pdFAIL                  ( pdFALSE )
49 #define errQUEUE_EMPTY  ( ( BaseType_t ) 0 )
50 #define errQUEUE_FULL   ( ( BaseType_t ) 0 )
51
52 /* FreeRTOS error definitions. */
53 #define errCOULD_NOT_ALLOCATE_REQUIRED_MEMORY   ( -1 )
54 #define errQUEUE_BLOCKED                                                ( -4 )
55 #define errQUEUE_YIELD                                                  ( -5 )
56
57 /* Macros used for basic data corruption checks. */
58 #ifndef configUSE_LIST_DATA_INTEGRITY_CHECK_BYTES
59         #define configUSE_LIST_DATA_INTEGRITY_CHECK_BYTES 0
60 #endif
61
62 #if( configUSE_16_BIT_TICKS == 1 )
63         #define pdINTEGRITY_CHECK_VALUE 0x5a5a
64 #else
65         #define pdINTEGRITY_CHECK_VALUE 0x5a5a5a5aUL
66 #endif
67
68 /* The following errno values are used by FreeRTOS+ components, not FreeRTOS
69 itself. */
70 #define pdFREERTOS_ERRNO_NONE                   0       /* No errors */
71 #define pdFREERTOS_ERRNO_ENOENT                 2       /* No such file or directory */
72 #define pdFREERTOS_ERRNO_EINTR                  4       /* Interrupted system call */
73 #define pdFREERTOS_ERRNO_EIO                    5       /* I/O error */
74 #define pdFREERTOS_ERRNO_ENXIO                  6       /* No such device or address */
75 #define pdFREERTOS_ERRNO_EBADF                  9       /* Bad file number */
76 #define pdFREERTOS_ERRNO_EAGAIN                 11      /* No more processes */
77 #define pdFREERTOS_ERRNO_EWOULDBLOCK    11      /* Operation would block */
78 #define pdFREERTOS_ERRNO_ENOMEM                 12      /* Not enough memory */
79 #define pdFREERTOS_ERRNO_EACCES                 13      /* Permission denied */
80 #define pdFREERTOS_ERRNO_EFAULT                 14      /* Bad address */
81 #define pdFREERTOS_ERRNO_EBUSY                  16      /* Mount device busy */
82 #define pdFREERTOS_ERRNO_EEXIST                 17      /* File exists */
83 #define pdFREERTOS_ERRNO_EXDEV                  18      /* Cross-device link */
84 #define pdFREERTOS_ERRNO_ENODEV                 19      /* No such device */
85 #define pdFREERTOS_ERRNO_ENOTDIR                20      /* Not a directory */
86 #define pdFREERTOS_ERRNO_EISDIR                 21      /* Is a directory */
87 #define pdFREERTOS_ERRNO_EINVAL                 22      /* Invalid argument */
88 #define pdFREERTOS_ERRNO_ENOSPC                 28      /* No space left on device */
89 #define pdFREERTOS_ERRNO_ESPIPE                 29      /* Illegal seek */
90 #define pdFREERTOS_ERRNO_EROFS                  30      /* Read only file system */
91 #define pdFREERTOS_ERRNO_EUNATCH                42      /* Protocol driver not attached */
92 #define pdFREERTOS_ERRNO_EBADE                  50      /* Invalid exchange */
93 #define pdFREERTOS_ERRNO_EFTYPE                 79      /* Inappropriate file type or format */
94 #define pdFREERTOS_ERRNO_ENMFILE                89      /* No more files */
95 #define pdFREERTOS_ERRNO_ENOTEMPTY              90      /* Directory not empty */
96 #define pdFREERTOS_ERRNO_ENAMETOOLONG   91      /* File or path name too long */
97 #define pdFREERTOS_ERRNO_EOPNOTSUPP             95      /* Operation not supported on transport endpoint */
98 #define pdFREERTOS_ERRNO_ENOBUFS                105     /* No buffer space available */
99 #define pdFREERTOS_ERRNO_ENOPROTOOPT    109     /* Protocol not available */
100 #define pdFREERTOS_ERRNO_EADDRINUSE             112     /* Address already in use */
101 #define pdFREERTOS_ERRNO_ETIMEDOUT              116     /* Connection timed out */
102 #define pdFREERTOS_ERRNO_EINPROGRESS    119     /* Connection already in progress */
103 #define pdFREERTOS_ERRNO_EALREADY               120     /* Socket already connected */
104 #define pdFREERTOS_ERRNO_EADDRNOTAVAIL  125     /* Address not available */
105 #define pdFREERTOS_ERRNO_EISCONN                127     /* Socket is already connected */
106 #define pdFREERTOS_ERRNO_ENOTCONN               128     /* Socket is not connected */
107 #define pdFREERTOS_ERRNO_ENOMEDIUM              135     /* No medium inserted */
108 #define pdFREERTOS_ERRNO_EILSEQ                 138     /* An invalid UTF-16 sequence was encountered. */
109 #define pdFREERTOS_ERRNO_ECANCELED              140     /* Operation canceled. */
110
111 /* The following endian values are used by FreeRTOS+ components, not FreeRTOS
112 itself. */
113 #define pdFREERTOS_LITTLE_ENDIAN                0
114 #define pdFREERTOS_BIG_ENDIAN                   1
115
116 /* Re-defining endian values for generic naming. */
117 #define pdLITTLE_ENDIAN                                 pdFREERTOS_LITTLE_ENDIAN
118 #define pdBIG_ENDIAN                                    pdFREERTOS_BIG_ENDIAN
119
120
121 #endif /* PROJDEFS_H */
122
123
124