xref: /Kernel-v10.6.2/portable/IAR/AVR_AVRDx/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 #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                int
54 #define portSTACK_TYPE           uint8_t
55 #define portBASE_TYPE            char
56 
57 #define portPOINTER_SIZE_TYPE    uint16_t
58 
59 typedef portSTACK_TYPE   StackType_t;
60 typedef signed char      BaseType_t;
61 typedef unsigned char    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 
75 /* Critical section management. */
76 extern void vPortEnterCritical( void );
77 extern void vPortExitCritical( void );
78 
79 #define portENTER_CRITICAL()        vPortEnterCritical()
80 #define portEXIT_CRITICAL()         vPortExitCritical()
81 
82 #define portDISABLE_INTERRUPTS()    asm ( "cli" )
83 #define portENABLE_INTERRUPTS()     asm ( "sei" )
84 /*-----------------------------------------------------------*/
85 
86 /* Architecture specifics. */
87 #define portSTACK_GROWTH      ( -1 )
88 #define portTICK_PERIOD_MS    ( ( TickType_t ) 1000 / configTICK_RATE_HZ )
89 #define portBYTE_ALIGNMENT    1
90 #define portNOP()    asm ( "nop" )
91 /*-----------------------------------------------------------*/
92 
93 /* Kernel utilities. */
94 extern void vPortYield( void );
95 #define portYIELD()             vPortYield()
96 
97 extern void vPortYieldFromISR( void );
98 #define portYIELD_FROM_ISR()    vPortYieldFromISR()
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 /* *INDENT-OFF* */
106 #ifdef __cplusplus
107     }
108 #endif
109 /* *INDENT-ON* */
110 
111 #endif /* PORTMACRO_H */
112