]> begriffs open source - freertos/blob - portable/GCC/STR75x/portmacro.h
Style: uncrustify kernel files
[freertos] / portable / GCC / STR75x / portmacro.h
1 /*\r
2  * FreeRTOS Kernel V10.3.1\r
3  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.\r
4  *\r
5  * Permission is hereby granted, free of charge, to any person obtaining a copy of\r
6  * this software and associated documentation files (the "Software"), to deal in\r
7  * the Software without restriction, including without limitation the rights to\r
8  * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\r
9  * the Software, and to permit persons to whom the Software is furnished to do so,\r
10  * subject to the following conditions:\r
11  *\r
12  * The above copyright notice and this permission notice shall be included in all\r
13  * copies or substantial portions of the Software.\r
14  *\r
15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\r
17  * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\r
18  * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\r
19  * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\r
20  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r
21  *\r
22  * http://www.FreeRTOS.org\r
23  * http://aws.amazon.com/freertos\r
24  *\r
25  */\r
26 \r
27 \r
28 #ifndef PORTMACRO_H\r
29 #define PORTMACRO_H\r
30 \r
31 #ifdef __cplusplus\r
32 extern "C" {\r
33 #endif\r
34 \r
35 /*-----------------------------------------------------------\r
36  * Port specific definitions.\r
37  *\r
38  * The settings in this file configure FreeRTOS correctly for the\r
39  * given hardware and compiler.\r
40  *\r
41  * These settings should not be altered.\r
42  *-----------------------------------------------------------\r
43  */\r
44 \r
45 /* Type definitions. */\r
46 #define portCHAR                char\r
47 #define portFLOAT               float\r
48 #define portDOUBLE              double\r
49 #define portLONG                long\r
50 #define portSHORT               short\r
51 #define portSTACK_TYPE  uint32_t\r
52 #define portBASE_TYPE   long\r
53 \r
54 typedef portSTACK_TYPE StackType_t;\r
55 typedef long BaseType_t;\r
56 typedef unsigned long UBaseType_t;\r
57 \r
58 #if( configUSE_16_BIT_TICKS == 1 )\r
59         typedef uint16_t TickType_t;\r
60         #define portMAX_DELAY ( TickType_t ) 0xffff\r
61 #else\r
62         typedef uint32_t TickType_t;\r
63         #define portMAX_DELAY ( TickType_t ) 0xffffffffUL\r
64 #endif\r
65 /*-----------------------------------------------------------*/\r
66 \r
67 /* Hardware specifics. */\r
68 #define portSTACK_GROWTH                        ( -1 )\r
69 #define portTICK_PERIOD_MS                      ( ( TickType_t ) 1000 / configTICK_RATE_HZ )\r
70 #define portBYTE_ALIGNMENT                      8\r
71 #define portYIELD()                                     asm volatile ( "SWI 0" )\r
72 #define portNOP()                                       asm volatile ( "NOP" )\r
73 /*-----------------------------------------------------------*/\r
74 \r
75 /* Critical section handling. */\r
76 /*\r
77  * The interrupt management utilities can only be called from ARM mode.  When\r
78  * THUMB_INTERWORK is defined the utilities are defined as functions in\r
79  * portISR.c to ensure a switch to ARM mode.  When THUMB_INTERWORK is not\r
80  * defined then the utilities are defined as macros here - as per other ports.\r
81  */\r
82 \r
83 #ifdef THUMB_INTERWORK\r
84 \r
85         extern void vPortDisableInterruptsFromThumb( void ) __attribute__ ((naked));\r
86         extern void vPortEnableInterruptsFromThumb( void ) __attribute__ ((naked));\r
87 \r
88         #define portDISABLE_INTERRUPTS()        vPortDisableInterruptsFromThumb()\r
89         #define portENABLE_INTERRUPTS()         vPortEnableInterruptsFromThumb()\r
90 \r
91 #else\r
92 \r
93         #define portDISABLE_INTERRUPTS()                                                                                        \\r
94                 asm volatile (                                                                                                                  \\r
95                         "STMDB  SP!, {R0}               \n\t"   /* Push R0.                                             */      \\r
96                         "MRS    R0, CPSR                \n\t"   /* Get CPSR.                                    */      \\r
97                         "ORR    R0, R0, #0xC0   \n\t"   /* Disable IRQ, FIQ.                    */      \\r
98                         "MSR    CPSR, R0                \n\t"   /* Write back modified value.   */      \\r
99                         "LDMIA  SP!, {R0}                       " )     /* Pop R0.                                              */\r
100 \r
101         #define portENABLE_INTERRUPTS()                                                                                         \\r
102                 asm volatile (                                                                                                                  \\r
103                         "STMDB  SP!, {R0}               \n\t"   /* Push R0.                                             */      \\r
104                         "MRS    R0, CPSR                \n\t"   /* Get CPSR.                                    */      \\r
105                         "BIC    R0, R0, #0xC0   \n\t"   /* Enable IRQ, FIQ.                             */      \\r
106                         "MSR    CPSR, R0                \n\t"   /* Write back modified value.   */      \\r
107                         "LDMIA  SP!, {R0}                       " )     /* Pop R0.                                              */\r
108 \r
109 #endif /* THUMB_INTERWORK */\r
110 \r
111 extern void vPortEnterCritical( void );\r
112 extern void vPortExitCritical( void );\r
113 \r
114 #define portENTER_CRITICAL()            vPortEnterCritical();\r
115 #define portEXIT_CRITICAL()                     vPortExitCritical();\r
116 /*-----------------------------------------------------------*/\r
117 \r
118 /* Task utilities. */\r
119 #define portEND_SWITCHING_ISR( xSwitchRequired )        \\r
120 {                                                                                                       \\r
121 extern void vTaskSwitchContext( void );                         \\r
122                                                                                                         \\r
123         if( xSwitchRequired )                                                   \\r
124         {                                                                                               \\r
125                 vTaskSwitchContext();                                           \\r
126         }                                                                                               \\r
127 }\r
128 /*-----------------------------------------------------------*/\r
129 \r
130 /* Task function macros as described on the FreeRTOS.org WEB site. */\r
131 #define portTASK_FUNCTION_PROTO( vFunction, pvParameters ) void vFunction( void * pvParameters )\r
132 #define portTASK_FUNCTION( vFunction, pvParameters ) void vFunction( void * pvParameters )\r
133 \r
134 #ifdef __cplusplus\r
135 }\r
136 #endif\r
137 \r
138 #endif /* PORTMACRO_H */\r
139 \r
140 \r