1 /*
2  * FreeRTOS Kernel V11.0.1
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 PORTMACRO_H
30 #define PORTMACRO_H
31 
32 /* *INDENT-OFF* */
33 #ifdef __cplusplus
34     extern "C" {
35 #endif
36 /* *INDENT-ON* */
37 
38 /*-----------------------------------------------------------
39  * Port specific definitions.
40  *
41  * The settings in this file configure FreeRTOS correctly for the
42  * given hardware and compiler.
43  *
44  * These settings should not be altered.
45  *-----------------------------------------------------------
46  */
47 
48 /* Type definitions. */
49 #define portCHAR          char
50 #define portFLOAT         float
51 #define portDOUBLE        double
52 #define portLONG          long
53 #define portSHORT         int
54 #define portSTACK_TYPE    uint16_t
55 #define portBASE_TYPE     short
56 
57 typedef portSTACK_TYPE   StackType_t;
58 typedef short            BaseType_t;
59 typedef unsigned short   UBaseType_t;
60 
61 #if ( configTICK_TYPE_WIDTH_IN_BITS == TICK_TYPE_WIDTH_16_BITS )
62     typedef uint16_t     TickType_t;
63     #define portMAX_DELAY    ( TickType_t ) 0xffff
64 #elif ( configTICK_TYPE_WIDTH_IN_BITS == TICK_TYPE_WIDTH_32_BITS )
65     typedef uint32_t     TickType_t;
66     #define portMAX_DELAY    ( TickType_t ) ( 0xFFFFFFFFUL )
67 #else
68     #error configTICK_TYPE_WIDTH_IN_BITS set to unsupported tick type width.
69 #endif
70 /*-----------------------------------------------------------*/
71 
72 /* Interrupt control macros. */
73 #define portDISABLE_INTERRUPTS()    asm volatile ( "DINT" ); asm volatile ( "NOP" )
74 #define portENABLE_INTERRUPTS()     asm volatile ( "EINT" ); asm volatile ( "NOP" )
75 /*-----------------------------------------------------------*/
76 
77 /* Critical section control macros. */
78 #define portNO_CRITICAL_SECTION_NESTING    ( ( uint16_t ) 0 )
79 
80 #define portENTER_CRITICAL()                                                      \
81     {                                                                             \
82         extern volatile uint16_t usCriticalNesting;                               \
83                                                                                   \
84         portDISABLE_INTERRUPTS();                                                 \
85                                                                                   \
86         /* Now that interrupts are disabled, ulCriticalNesting can be accessed */ \
87         /* directly.  Increment ulCriticalNesting to keep a count of how many */  \
88         /* times portENTER_CRITICAL() has been called. */                         \
89         usCriticalNesting++;                                                      \
90     }
91 
92 #define portEXIT_CRITICAL()                                                         \
93     {                                                                               \
94         extern volatile uint16_t usCriticalNesting;                                 \
95                                                                                     \
96         if( usCriticalNesting > portNO_CRITICAL_SECTION_NESTING )                   \
97         {                                                                           \
98             /* Decrement the nesting count as we are leaving a critical section. */ \
99             usCriticalNesting--;                                                    \
100                                                                                     \
101             /* If the nesting level has reached zero then interrupts should be */   \
102             /* re-enabled. */                                                       \
103             if( usCriticalNesting == portNO_CRITICAL_SECTION_NESTING )              \
104             {                                                                       \
105                 portENABLE_INTERRUPTS();                                            \
106             }                                                                       \
107         }                                                                           \
108     }
109 /*-----------------------------------------------------------*/
110 
111 /* Task utilities. */
112 extern void vPortYield( void ) __attribute__( ( naked ) );
113 #define portYIELD()    vPortYield()
114 #define portNOP()      asm volatile ( "NOP" )
115 /*-----------------------------------------------------------*/
116 
117 /* Hardware specifics. */
118 #define portBYTE_ALIGNMENT    2
119 #define portSTACK_GROWTH      ( -1 )
120 #define portTICK_PERIOD_MS    ( ( TickType_t ) 1000 / configTICK_RATE_HZ )
121 /*-----------------------------------------------------------*/
122 
123 /* Task function macros as described on the FreeRTOS.org WEB site. */
124 #define portTASK_FUNCTION_PROTO( vFunction, pvParameters )    void vFunction( void * pvParameters )
125 #define portTASK_FUNCTION( vFunction, pvParameters )          void vFunction( void * pvParameters )
126 
127 /* *INDENT-OFF* */
128 #ifdef __cplusplus
129     }
130 #endif
131 /* *INDENT-ON* */
132 
133 #endif /* PORTMACRO_H */
134