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 #include <avr/wdt.h>
49 
50 /* Type definitions. */
51 #define portCHAR                 char
52 #define portFLOAT                float
53 #define portDOUBLE               double
54 #define portLONG                 long
55 #define portSHORT                int
56 
57 #define portPOINTER_SIZE_TYPE    uint16_t
58 
59 typedef uint8_t        StackType_t;
60 typedef int8_t         BaseType_t;
61 typedef uint8_t        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 #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 /* Critical section management. */
75 
76 #define portENTER_CRITICAL()                        \
77     __asm__ __volatile__ (                          \
78         "in __tmp_reg__, __SREG__"        "\n\t"    \
79         "cli"                             "\n\t"    \
80         "push __tmp_reg__"                "\n\t"    \
81         ::: "memory"                                \
82         )
83 
84 
85 #define portEXIT_CRITICAL()                         \
86     __asm__ __volatile__ (                          \
87         "pop __tmp_reg__"                 "\n\t"    \
88         "out __SREG__, __tmp_reg__"       "\n\t"    \
89         ::: "memory"                                \
90         )
91 
92 
93 #define portDISABLE_INTERRUPTS()    __asm__ __volatile__ ( "cli" ::: "memory" )
94 #define portENABLE_INTERRUPTS()     __asm__ __volatile__ ( "sei" ::: "memory" )
95 /*-----------------------------------------------------------*/
96 
97 /* Architecture specifics. */
98 
99 /* System Tick  - Scheduler timer
100  * Prefer to use the enhanced Watchdog Timer, but also Timer0 is ok.
101  */
102 
103 #if defined( WDIE ) && defined( WDIF ) /* If Enhanced WDT with interrupt capability is available */
104 
105     #define portUSE_WDTO    WDTO_15MS  /* use the Watchdog Timer for xTaskIncrementTick */
106 
107 /* Watchdog period options:         WDTO_15MS
108  *                                  WDTO_30MS
109  *                                  WDTO_60MS
110  *                                  WDTO_120MS
111  *                                  WDTO_250MS
112  *                                  WDTO_500MS
113  *                                  WDTO_1S
114  *                                  WDTO_2S
115  */
116 
117 #else
118 
119     #define portUSE_TIMER0    /* use the 8-bit Timer0 for xTaskIncrementTick */
120 
121 #endif
122 
123 #define portSTACK_GROWTH    ( -1 )
124 
125 /* Timing for the scheduler.
126  * Watchdog Timer is 128kHz nominal,
127  * but 120 kHz at 5V DC and 25 degrees is actually more accurate,
128  * from data sheet.
129  */
130 #if defined( portUSE_WDTO )
131     #define portTICK_PERIOD_MS    ( ( TickType_t ) _BV( portUSE_WDTO + 4 ) )
132 #else
133     #define portTICK_PERIOD_MS    ( ( TickType_t ) 1000 / configTICK_RATE_HZ )
134 #endif
135 
136 #define portBYTE_ALIGNMENT        1
137 #define portNOP()    __asm__ __volatile__ ( "nop" );
138 /*-----------------------------------------------------------*/
139 
140 /* Kernel utilities. */
141 extern void vPortYield( void )      __attribute__( ( naked ) );
142 #define portYIELD()             vPortYield()
143 
144 extern void vPortYieldFromISR( void )   __attribute__( ( naked ) );
145 #define portYIELD_FROM_ISR()    vPortYieldFromISR()
146 /*-----------------------------------------------------------*/
147 
148 #if defined( __AVR_3_BYTE_PC__ )
149 /* Task function macros as described on the FreeRTOS.org WEB site. */
150 
151 /* Add .lowtext tag from the avr linker script avr6.x for ATmega2560 and ATmega2561
152  * to make sure functions are loaded in low memory.
153  */
154     #define portTASK_FUNCTION_PROTO( vFunction, pvParameters )    void vFunction( void * pvParameters ) __attribute__( ( section( ".lowtext" ) ) )
155 #else
156     #define portTASK_FUNCTION_PROTO( vFunction, pvParameters )    void vFunction( void * pvParameters )
157 #endif
158 
159 #define portTASK_FUNCTION( vFunction, pvParameters )              void vFunction( void * pvParameters )
160 
161 /* *INDENT-OFF* */
162 #ifdef __cplusplus
163     }
164 #endif
165 /* *INDENT-ON* */
166 
167 #endif /* PORTMACRO_H */
168