]> begriffs open source - freertos/blob - portable/IAR/V850ES/portmacro.h
Add SPDX-License-Identifier: MIT to MIT licensed files.
[freertos] / portable / IAR / V850ES / 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 #ifndef PORTMACRO_H\r
30 #define PORTMACRO_H\r
31 \r
32 #ifdef __cplusplus\r
33 extern "C" {\r
34 #endif\r
35 \r
36 /*-----------------------------------------------------------\r
37  * Port specific definitions.\r
38  *\r
39  * The settings in this file configure FreeRTOS correctly for the\r
40  * given hardware and compiler.\r
41  *\r
42  * These settings should not be altered.\r
43  *-----------------------------------------------------------\r
44  */\r
45 \r
46 /* Type definitions. */\r
47 #define portCHAR        char\r
48 #define portFLOAT       float\r
49 #define portDOUBLE      double\r
50 #define portLONG        long\r
51 #define portSHORT       short\r
52 #define portSTACK_TYPE  unsigned int\r
53 #define portBASE_TYPE   int\r
54 \r
55 typedef portSTACK_TYPE StackType_t;\r
56 typedef long BaseType_t;\r
57 typedef unsigned long UBaseType_t;\r
58 \r
59 \r
60 #if (configUSE_16_BIT_TICKS==1)\r
61         typedef uint16_t TickType_t;\r
62         #define portMAX_DELAY ( TickType_t ) 0xffff\r
63 #else\r
64         typedef uint32_t TickType_t;\r
65         #define portMAX_DELAY ( TickType_t ) 0xffffffffUL\r
66 #endif\r
67 /*-----------------------------------------------------------*/\r
68 \r
69 /* Interrupt control macros. */\r
70 #define portDISABLE_INTERRUPTS() __asm ( "DI" )\r
71 #define portENABLE_INTERRUPTS()  __asm ( "EI" )\r
72 /*-----------------------------------------------------------*/\r
73 \r
74 /* Critical section control macros. */\r
75 #define portNO_CRITICAL_SECTION_NESTING         ( ( UBaseType_t ) 0 )\r
76 \r
77 #define portENTER_CRITICAL()                                                                                                            \\r
78 {                                                                                                                                                                       \\r
79 extern volatile /*uint16_t*/ portSTACK_TYPE usCriticalNesting;                                          \\r
80                                                                                                                                                                         \\r
81         portDISABLE_INTERRUPTS();                                                                                                               \\r
82                                                                                                                                                                         \\r
83         /* Now interrupts are disabled ulCriticalNesting can be accessed */                             \\r
84         /* directly.  Increment ulCriticalNesting to keep a count of how many */                \\r
85         /* times portENTER_CRITICAL() has been called. */                                                               \\r
86         usCriticalNesting++;                                                                                                                    \\r
87 }\r
88 \r
89 #define portEXIT_CRITICAL()                                                                                                                     \\r
90 {                                                                                                                                                                       \\r
91 extern volatile /*uint16_t*/ portSTACK_TYPE usCriticalNesting;                                          \\r
92                                                                                                                                                                         \\r
93         if( usCriticalNesting > portNO_CRITICAL_SECTION_NESTING )                                               \\r
94         {                                                                                                                                                               \\r
95                 /* Decrement the nesting count as we are leaving a critical section. */         \\r
96                 usCriticalNesting--;                                                                                                            \\r
97                                                                                                                                                                         \\r
98                 /* If the nesting level has reached zero then interrupts should be */           \\r
99                 /* re-enabled. */                                                                                                                       \\r
100                 if( usCriticalNesting == portNO_CRITICAL_SECTION_NESTING )                                      \\r
101                 {                                                                                                                                                       \\r
102                         portENABLE_INTERRUPTS();                                                                                                \\r
103                 }                                                                                                                                                       \\r
104         }                                                                                                                                                               \\r
105 }\r
106 /*-----------------------------------------------------------*/\r
107 \r
108 /* Task utilities. */\r
109 extern void vPortYield( void );\r
110 extern void vPortStart( void );\r
111 extern void portSAVE_CONTEXT( void );\r
112 extern void portRESTORE_CONTEXT( void );\r
113 #define portYIELD()     __asm ( "trap 0" )\r
114 #define portNOP()       __asm ( "NOP" )\r
115 extern void vTaskSwitchContext( void );\r
116 #define portYIELD_FROM_ISR( xHigherPriorityTaskWoken ) do { if( xHigherPriorityTaskWoken ) vTaskSwitchContext(); } while( 0 )\r
117 \r
118 /*-----------------------------------------------------------*/\r
119 \r
120 /* Hardwware specifics. */\r
121 #define portBYTE_ALIGNMENT      4\r
122 #define portSTACK_GROWTH        ( -1 )\r
123 #define portTICK_PERIOD_MS      ( ( TickType_t ) 1000 / configTICK_RATE_HZ )\r
124 /*-----------------------------------------------------------*/\r
125 \r
126 /* Task function macros as described on the FreeRTOS.org WEB site. */\r
127 #define portTASK_FUNCTION_PROTO( vFunction, pvParameters ) void vFunction( void *pvParameters )\r
128 #define portTASK_FUNCTION( vFunction, pvParameters ) void vFunction( void *pvParameters )\r
129 \r
130 \r
131 #ifdef __cplusplus\r
132 }\r
133 #endif\r
134 \r
135 #endif /* PORTMACRO_H */\r
136 \r