]> begriffs open source - freertos/blob - portable/ThirdParty/GCC/ATmega/portmacro.h
[AUTO][RELEASE]: Bump file header version to "10.5.1"
[freertos] / portable / ThirdParty / GCC / ATmega / portmacro.h
1 /*
2  * FreeRTOS Kernel V10.5.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 #ifdef __cplusplus
33 extern "C" {
34 #endif
35
36 /*-----------------------------------------------------------
37  * Port specific definitions.
38  *
39  * The settings in this file configure FreeRTOS correctly for the
40  * given hardware and compiler.
41  *
42  * These settings should not be altered.
43  *-----------------------------------------------------------
44  */
45
46 #include <avr/wdt.h>
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
55 typedef uint8_t                     StackType_t;
56 typedef int8_t                      BaseType_t;
57 typedef uint8_t                     UBaseType_t;
58
59 #if configUSE_16_BIT_TICKS == 1
60     typedef uint16_t                TickType_t;
61     #define portMAX_DELAY           ( TickType_t ) 0xffff
62 #else
63     typedef uint32_t                TickType_t;
64     #define portMAX_DELAY           ( TickType_t ) 0xffffffffUL
65 #endif
66 /*-----------------------------------------------------------*/
67
68 /* Critical section management. */
69
70 #define portENTER_CRITICAL()        __asm__ __volatile__ (                          \
71                                         "in __tmp_reg__, __SREG__"        "\n\t"    \
72                                         "cli"                             "\n\t"    \
73                                         "push __tmp_reg__"                "\n\t"    \
74                                         ::: "memory"                                \
75                                         )
76
77
78 #define portEXIT_CRITICAL()         __asm__ __volatile__ (                          \
79                                         "pop __tmp_reg__"                 "\n\t"    \
80                                         "out __SREG__, __tmp_reg__"       "\n\t"    \
81                                         ::: "memory"                                \
82                                         )
83
84
85 #define portDISABLE_INTERRUPTS()    __asm__ __volatile__ ( "cli" ::: "memory")
86 #define portENABLE_INTERRUPTS()     __asm__ __volatile__ ( "sei" ::: "memory")
87 /*-----------------------------------------------------------*/
88
89 /* Architecture specifics. */
90
91 /* System Tick  - Scheduler timer
92  * Prefer to use the enhanced Watchdog Timer, but also Timer0 is ok.
93  */
94
95 #if defined(WDIE) && defined(WDIF)              /* If Enhanced WDT with interrupt capability is available */
96
97 #define portUSE_WDTO                WDTO_15MS   /* use the Watchdog Timer for xTaskIncrementTick */
98
99 /* Watchdog period options:         WDTO_15MS
100                                     WDTO_30MS
101                                     WDTO_60MS
102                                     WDTO_120MS
103                                     WDTO_250MS
104                                     WDTO_500MS
105                                     WDTO_1S
106                                     WDTO_2S
107 */
108
109 #else
110
111 #define portUSE_TIMER0                          /* use the 8-bit Timer0 for xTaskIncrementTick */
112
113 #endif
114
115 #define portSTACK_GROWTH            ( -1 )
116
117 /* Timing for the scheduler.
118  * Watchdog Timer is 128kHz nominal,
119  * but 120 kHz at 5V DC and 25 degrees is actually more accurate,
120  * from data sheet.
121  */
122 #if defined( portUSE_WDTO )
123 #define portTICK_PERIOD_MS          ( (TickType_t) _BV( portUSE_WDTO + 4 ) )
124 #else
125 #define portTICK_PERIOD_MS          ( (TickType_t) 1000 / configTICK_RATE_HZ )
126 #endif
127
128 #define portBYTE_ALIGNMENT          1
129 #define portNOP()                   __asm__ __volatile__ ( "nop" );
130 /*-----------------------------------------------------------*/
131
132 /* Kernel utilities. */
133 extern void vPortYield( void )      __attribute__ ( ( naked ) );
134 #define portYIELD()                 vPortYield()
135
136 extern void vPortYieldFromISR( void )   __attribute__ ( ( naked ) );
137 #define portYIELD_FROM_ISR()            vPortYieldFromISR()
138 /*-----------------------------------------------------------*/
139
140 #if defined(__AVR_3_BYTE_PC__)
141 /* Task function macros as described on the FreeRTOS.org WEB site. */
142
143 /* Add .lowtext tag from the avr linker script avr6.x for ATmega2560 and ATmega2561
144  * to make sure functions are loaded in low memory.
145  */
146 #define portTASK_FUNCTION_PROTO( vFunction, pvParameters ) void vFunction( void *pvParameters ) __attribute__ ((section (".lowtext")))
147 #else
148 #define portTASK_FUNCTION_PROTO( vFunction, pvParameters ) void vFunction( void *pvParameters )
149 #endif
150
151 #define portTASK_FUNCTION( vFunction, pvParameters ) void vFunction( void *pvParameters )
152
153 #ifdef __cplusplus
154 }
155 #endif
156
157 #endif /* PORTMACRO_H */