]> begriffs open source - freertos/blob - portable/IAR/AVR_AVRDx/portmacro.h
Add SPDX-License-Identifier: MIT to MIT licensed files.
[freertos] / portable / IAR / AVR_AVRDx / portmacro.h
1 /*
2  * FreeRTOS Kernel <DEVELOPMENT BRANCH>
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 ( configUSE_16_BIT_TICKS == 1 )
64     typedef uint16_t     TickType_t;
65     #define portMAX_DELAY    ( TickType_t ) 0xffff
66 #else
67     typedef uint32_t     TickType_t;
68     #define portMAX_DELAY    ( TickType_t ) 0xffffffffUL
69 #endif
70
71 /*-----------------------------------------------------------*/
72
73 /* Critical section management. */
74 extern void vPortEnterCritical( void );
75 extern void vPortExitCritical( void );
76
77 #define portENTER_CRITICAL()        vPortEnterCritical()
78 #define portEXIT_CRITICAL()         vPortExitCritical()
79
80 #define portDISABLE_INTERRUPTS()    asm ( "cli" )
81 #define portENABLE_INTERRUPTS()     asm ( "sei" )
82 /*-----------------------------------------------------------*/
83
84 /* Architecture specifics. */
85 #define portSTACK_GROWTH      ( -1 )
86 #define portTICK_PERIOD_MS    ( ( TickType_t ) 1000 / configTICK_RATE_HZ )
87 #define portBYTE_ALIGNMENT    1
88 #define portNOP()    asm ( "nop" )
89 /*-----------------------------------------------------------*/
90
91 /* Kernel utilities. */
92 extern void vPortYield( void );
93 #define portYIELD()             vPortYield()
94
95 extern void vPortYieldFromISR( void );
96 #define portYIELD_FROM_ISR()    vPortYieldFromISR()
97 /*-----------------------------------------------------------*/
98
99 /* Task function macros as described on the FreeRTOS.org WEB site. */
100 #define portTASK_FUNCTION_PROTO( vFunction, pvParameters )    void vFunction( void * pvParameters )
101 #define portTASK_FUNCTION( vFunction, pvParameters )          void vFunction( void * pvParameters )
102
103 /* *INDENT-OFF* */
104 #ifdef __cplusplus
105     }
106 #endif
107 /* *INDENT-ON* */
108
109 #endif /* PORTMACRO_H */