1 /*
2  * FreeRTOS Kernel V11.1.0
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 
30 #ifndef PORTMACRO_H
31 #define PORTMACRO_H
32 
33 /* *INDENT-OFF* */
34 #ifdef __cplusplus
35     extern "C" {
36 #endif
37 /* *INDENT-ON* */
38 
39 /*-----------------------------------------------------------
40  * Port specific definitions.
41  *
42  * The settings in this file configure FreeRTOS correctly for the
43  * given hardware and compiler.
44  *
45  * These settings should not be altered.
46  *-----------------------------------------------------------
47  */
48 
49 /* Type definitions. */
50 #define portCHAR          char
51 #define portFLOAT         float
52 #define portDOUBLE        double
53 #define portLONG          long
54 #define portSHORT         short
55 #define portSTACK_TYPE    uint32_t
56 #define portBASE_TYPE     long
57 
58 typedef portSTACK_TYPE   StackType_t;
59 typedef long             BaseType_t;
60 typedef unsigned long    UBaseType_t;
61 
62 
63 #if ( configTICK_TYPE_WIDTH_IN_BITS == TICK_TYPE_WIDTH_16_BITS )
64     typedef uint16_t     TickType_t;
65     #define portMAX_DELAY    ( TickType_t ) 0xffff
66 #elif ( configTICK_TYPE_WIDTH_IN_BITS == TICK_TYPE_WIDTH_32_BITS )
67     typedef uint32_t     TickType_t;
68     #define portMAX_DELAY    ( TickType_t ) 0xffffffffUL
69 #else
70     #error configTICK_TYPE_WIDTH_IN_BITS set to unsupported tick type width.
71 #endif
72 /*-----------------------------------------------------------*/
73 
74 /* Hardware specifics. */
75 #define portSTACK_GROWTH      ( -1 )
76 #define portTICK_PERIOD_MS    ( ( TickType_t ) 1000 / configTICK_RATE_HZ )
77 #define portBYTE_ALIGNMENT    8
78 /*-----------------------------------------------------------*/
79 
80 /* Task utilities. */
81 
82 /*-----------------------------------------------------------
83 * ISR entry and exit macros.  These are only required if a task switch
84 * is required from an ISR.
85 *----------------------------------------------------------*/
86 
87 /* If a switch is required then we just need to call */
88 /* vTaskSwitchContext() as the context has already been */
89 /* saved. */
90 
91 #define portEXIT_SWITCHING_ISR( SwitchRequired ) \
92     {                                            \
93         extern void vTaskSwitchContext( void );  \
94                                                  \
95         if( SwitchRequired )                     \
96         {                                        \
97             vTaskSwitchContext();                \
98         }                                        \
99     }                                            \
100 
101 extern void vPortYield( void );
102 #define portYIELD()    vPortYield()
103 
104 
105 /* Critical section management. */
106 
107 /*
108  ******************************************************************
109  * We don't need to worry about whether we're in ARM or
110  * THUMB mode with the Keil Real View compiler when enabling
111  * or disabling interrupts as the compiler's intrinsic functions
112  * take care of that for us.
113  *******************************************************************
114  */
115 #define portDISABLE_INTERRUPTS()    __disable_irq()
116 #define portENABLE_INTERRUPTS()     __enable_irq()
117 
118 
119 /*-----------------------------------------------------------
120 * Critical section control
121 *
122 * The code generated by the Keil compiler does not maintain separate
123 * stack and frame pointers. The portENTER_CRITICAL macro cannot therefore
124 * use the stack as per other ports.  Instead a variable is used to keep
125 * track of the critical section nesting.  This necessitates the use of a
126 * function in place of the macro.
127 *----------------------------------------------------------*/
128 
129 extern void vPortEnterCritical( void );
130 extern void vPortExitCritical( void );
131 
132 #define portENTER_CRITICAL()    vPortEnterCritical();
133 #define portEXIT_CRITICAL()     vPortExitCritical();
134 /*-----------------------------------------------------------*/
135 
136 /* Compiler specifics. */
137 #define inline
138 #define register
139 #define portNOP()    __asm { NOP }
140 /*-----------------------------------------------------------*/
141 
142 /* Task function macros as described on the FreeRTOS.org WEB site. */
143 #define portTASK_FUNCTION_PROTO( vFunction, pvParameters )    void vFunction( void * pvParameters )
144 #define portTASK_FUNCTION( vFunction, pvParameters )          void vFunction( void * pvParameters )
145 
146 /* *INDENT-OFF* */
147 #ifdef __cplusplus
148     }
149 #endif
150 /* *INDENT-ON* */
151 
152 #endif /* PORTMACRO_H */
153