]> begriffs open source - freertos/blob - portable/IAR/AtmelSAM9XE/portmacro.h
Add SPDX-License-Identifier: MIT to MIT licensed files.
[freertos] / portable / IAR / AtmelSAM9XE / portmacro.h
1 /*\r
2  * FreeRTOS Kernel <DEVELOPMENT BRANCH>\r
3  * Copyright (C) 2021 Amazon.com, Inc. or its affiliates.  All Rights Reserved.\r
4  *\r
5  * SPDX-License-Identifier: MIT
6  *
7  * Permission is hereby granted, free of charge, to any person obtaining a copy of\r
8  * this software and associated documentation files (the "Software"), to deal in\r
9  * the Software without restriction, including without limitation the rights to\r
10  * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\r
11  * the Software, and to permit persons to whom the Software is furnished to do so,\r
12  * subject to the following conditions:\r
13  *\r
14  * The above copyright notice and this permission notice shall be included in all\r
15  * copies or substantial portions of the Software.\r
16  *\r
17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
18  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\r
19  * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\r
20  * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\r
21  * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\r
22  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r
23  *\r
24  * https://www.FreeRTOS.org\r
25  * https://github.com/FreeRTOS\r
26  *\r
27  */\r
28 \r
29 \r
30 #ifndef PORTMACRO_H\r
31 #define PORTMACRO_H\r
32 \r
33 #include <intrinsics.h>\r
34 \r
35 #ifdef __cplusplus\r
36 extern "C" {\r
37 #endif\r
38 \r
39 /*-----------------------------------------------------------\r
40  * Port specific definitions.\r
41  *\r
42  * The settings in this file configure FreeRTOS correctly for the\r
43  * given hardware and compiler.\r
44  *\r
45  * These settings should not be altered.\r
46  *-----------------------------------------------------------\r
47  */\r
48 \r
49 /* Type definitions. */\r
50 #define portCHAR                char\r
51 #define portFLOAT               float\r
52 #define portDOUBLE              double\r
53 #define portLONG                long\r
54 #define portSHORT               short\r
55 #define portSTACK_TYPE  uint32_t\r
56 #define portBASE_TYPE   long\r
57 \r
58 typedef portSTACK_TYPE StackType_t;\r
59 typedef long BaseType_t;\r
60 typedef unsigned long UBaseType_t;\r
61 \r
62 \r
63 #if( configUSE_16_BIT_TICKS == 1 )\r
64         typedef uint16_t TickType_t;\r
65         #define portMAX_DELAY ( TickType_t ) 0xffff\r
66 #else\r
67         typedef uint32_t TickType_t;\r
68         #define portMAX_DELAY ( TickType_t ) 0xffffffffUL\r
69 #endif\r
70 /*-----------------------------------------------------------*/\r
71 \r
72 /* Hardware specifics. */\r
73 #define portSTACK_GROWTH                        ( -1 )\r
74 #define portTICK_PERIOD_MS                      ( ( TickType_t ) 1000 / configTICK_RATE_HZ )\r
75 #define portBYTE_ALIGNMENT                      8\r
76 #define portYIELD()                                     asm ( "SWI 0" )\r
77 #define portNOP()                                       asm ( "NOP" )\r
78 /*-----------------------------------------------------------*/\r
79 \r
80 /* Critical section handling. */\r
81 __arm __interwork void vPortDisableInterruptsFromThumb( void );\r
82 __arm __interwork void vPortEnableInterruptsFromThumb( void );\r
83 __arm __interwork void vPortEnterCritical( void );\r
84 __arm __interwork void vPortExitCritical( void );\r
85 \r
86 #define portDISABLE_INTERRUPTS()        __disable_irq()\r
87 #define portENABLE_INTERRUPTS()         __enable_irq()\r
88 #define portENTER_CRITICAL()            vPortEnterCritical()\r
89 #define portEXIT_CRITICAL()                     vPortExitCritical()\r
90 /*-----------------------------------------------------------*/\r
91 \r
92 /* Task utilities. */\r
93 #define portEND_SWITCHING_ISR( xSwitchRequired )        \\r
94 {                                                                                                       \\r
95 extern void vTaskSwitchContext( void );                         \\r
96                                                                                                         \\r
97         if( xSwitchRequired )                                                   \\r
98         {                                                                                               \\r
99                 vTaskSwitchContext();                                           \\r
100         }                                                                                               \\r
101 }\r
102 /*-----------------------------------------------------------*/\r
103 \r
104 \r
105 /* Task function macros as described on the FreeRTOS.org WEB site. */\r
106 #define portTASK_FUNCTION_PROTO( vFunction, pvParameters ) void vFunction( void * pvParameters )\r
107 #define portTASK_FUNCTION( vFunction, pvParameters ) void vFunction( void * pvParameters )\r
108 \r
109 #ifdef __cplusplus\r
110 }\r
111 #endif\r
112 \r
113 #endif /* PORTMACRO_H */\r
114 \r
115 \r