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 #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       short
54 #define portSTACK_TYPE  uint16_t
55 #define portBASE_TYPE   short
56 #define portPOINTER_SIZE_TYPE size_t
57 #define SIZE_MAX    ( ( size_t ) -1 )
58 
59 typedef portSTACK_TYPE StackType_t;
60 typedef short BaseType_t;
61 typedef unsigned short UBaseType_t;
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 /* 16-bit tick type on a 16-bit architecture, so reads of the tick count do
67  * not need to be guarded with a critical section. */
68     #define portTICK_TYPE_IS_ATOMIC 1
69 #elif ( configTICK_TYPE_WIDTH_IN_BITS  == TICK_TYPE_WIDTH_32_BITS )
70     typedef uint32_t             TickType_t;
71     #define portMAX_DELAY    ( TickType_t ) 0xffffffffUL
72 #else
73     #error configTICK_TYPE_WIDTH_IN_BITS set to unsupported tick type width.
74 #endif
75 /*-----------------------------------------------------------*/
76 
77 /* Hardware specifics. */
78 #define portBYTE_ALIGNMENT          2
79 #define portSTACK_GROWTH            1
80 #define portTICK_PERIOD_MS          ( ( TickType_t ) 1000 / configTICK_RATE_HZ )
81 /*-----------------------------------------------------------*/
82 
83 /* Critical section management. */
84 #define portDISABLE_INTERRUPTS()    SET_CPU_IPL( configKERNEL_INTERRUPT_PRIORITY ); __asm volatile ( "NOP" )
85 #define portENABLE_INTERRUPTS()     SET_CPU_IPL( 0 )
86 
87 /* Note that exiting a critical sectino will set the IPL bits to 0, no matter
88 what their value was prior to entering the critical section. */
89 extern void vPortEnterCritical( void );
90 extern void vPortExitCritical( void );
91 #define portENTER_CRITICAL()        vPortEnterCritical()
92 #define portEXIT_CRITICAL()         vPortExitCritical()
93 /*-----------------------------------------------------------*/
94 
95 /* Task utilities. */
96 extern void vPortYield( void );
97 #define portYIELD()             asm volatile ( "CALL _vPortYield            \n"     \
98                                                 "NOP                      " );
99 /*-----------------------------------------------------------*/
100 
101 /* Task function macros as described on the FreeRTOS.org WEB site. */
102 #define portTASK_FUNCTION_PROTO( vFunction, pvParameters ) void vFunction( void *pvParameters )
103 #define portTASK_FUNCTION( vFunction, pvParameters ) void vFunction( void *pvParameters )
104 /*-----------------------------------------------------------*/
105 
106 /* Required by the kernel aware debugger. */
107 #ifdef __DEBUG
108     #define portREMOVE_STATIC_QUALIFIER
109 #endif
110 
111 #define portNOP()               asm volatile ( "NOP" )
112 
113 /* *INDENT-OFF* */
114 #ifdef __cplusplus
115     }
116 #endif
117 /* *INDENT-ON* */
118 
119 #endif /* PORTMACRO_H */
120