xref: /Kernel-v10.6.2/portable/GCC/ATMega323/portmacro.h (revision ef7b253b56c9788077f5ecd6c9deb4021923d646)
1 /*
2  * FreeRTOS Kernel V10.6.2
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 Changes from V1.2.3
31 
32     + portCPU_CLOSK_HZ definition changed to 8MHz base 10, previously it
33       base 16.
34 */
35 
36 #ifndef PORTMACRO_H
37 #define PORTMACRO_H
38 
39 /* *INDENT-OFF* */
40 #ifdef __cplusplus
41     extern "C" {
42 #endif
43 /* *INDENT-ON* */
44 
45 /*-----------------------------------------------------------
46  * Port specific definitions.
47  *
48  * The settings in this file configure FreeRTOS correctly for the
49  * given hardware and compiler.
50  *
51  * These settings should not be altered.
52  *-----------------------------------------------------------
53  */
54 
55 /* Type definitions. */
56 #define portCHAR        char
57 #define portFLOAT       float
58 #define portDOUBLE      double
59 #define portLONG        long
60 #define portSHORT       int
61 #define portSTACK_TYPE  uint8_t
62 #define portBASE_TYPE   char
63 
64 #define portPOINTER_SIZE_TYPE    uint16_t
65 
66 typedef portSTACK_TYPE StackType_t;
67 typedef signed char BaseType_t;
68 typedef unsigned char UBaseType_t;
69 
70 #if( configTICK_TYPE_WIDTH_IN_BITS == TICK_TYPE_WIDTH_16_BITS )
71     typedef uint16_t TickType_t;
72     #define portMAX_DELAY ( TickType_t ) 0xffff
73 #elif ( configTICK_TYPE_WIDTH_IN_BITS == TICK_TYPE_WIDTH_32_BITS )
74     typedef uint32_t TickType_t;
75     #define portMAX_DELAY ( TickType_t )    ( 0xFFFFFFFFUL )
76 #else
77     #error configTICK_TYPE_WIDTH_IN_BITS set to unsupported tick type width.
78 #endif
79 /*-----------------------------------------------------------*/
80 
81 /* Critical section management. */
82 #define portENTER_CRITICAL()        asm volatile ( "in      __tmp_reg__, __SREG__" :: );    \
83                                     asm volatile ( "cli" :: );                              \
84                                     asm volatile ( "push    __tmp_reg__" :: )
85 
86 #define portEXIT_CRITICAL()         asm volatile ( "pop     __tmp_reg__" :: );              \
87                                     asm volatile ( "out     __SREG__, __tmp_reg__" :: )
88 
89 #define portDISABLE_INTERRUPTS()    asm volatile ( "cli" :: );
90 #define portENABLE_INTERRUPTS()     asm volatile ( "sei" :: );
91 /*-----------------------------------------------------------*/
92 
93 /* Architecture specifics. */
94 #define portSTACK_GROWTH            ( -1 )
95 #define portTICK_PERIOD_MS          ( ( TickType_t ) 1000 / configTICK_RATE_HZ )
96 #define portBYTE_ALIGNMENT          1
97 #define portNOP()                   asm volatile ( "nop" );
98 /*-----------------------------------------------------------*/
99 
100 /* Kernel utilities. */
101 extern void vPortYield( void ) __attribute__ ( ( naked ) );
102 #define portYIELD()                 vPortYield()
103 /*-----------------------------------------------------------*/
104 
105 /* Task function macros as described on the FreeRTOS.org WEB site. */
106 #define portTASK_FUNCTION_PROTO( vFunction, pvParameters ) void vFunction( void *pvParameters )
107 #define portTASK_FUNCTION( vFunction, pvParameters ) void vFunction( void *pvParameters )
108 
109 /* *INDENT-OFF* */
110 #ifdef __cplusplus
111     }
112 #endif
113 /* *INDENT-ON* */
114 
115 #endif /* PORTMACRO_H */
116