]> begriffs open source - freertos/blob - portable/GCC/STR75x/portmacro.h
Style: uncrusitfy
[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 /*\r
78  * The interrupt management utilities can only be called from ARM mode.  When\r
79  * THUMB_INTERWORK is defined the utilities are defined as functions in\r
80  * portISR.c to ensure a switch to ARM mode.  When THUMB_INTERWORK is not\r
81  * defined then the utilities are defined as macros here - as per other ports.\r
82  */\r
83 \r
84     #ifdef THUMB_INTERWORK\r
85 \r
86         extern void vPortDisableInterruptsFromThumb( void ) __attribute__( ( naked ) );\r
87         extern void vPortEnableInterruptsFromThumb( void ) __attribute__( ( naked ) );\r
88 \r
89         #define portDISABLE_INTERRUPTS()    vPortDisableInterruptsFromThumb()\r
90         #define portENABLE_INTERRUPTS()     vPortEnableInterruptsFromThumb()\r
91 \r
92     #else\r
93 \r
94         #define portDISABLE_INTERRUPTS()                                     \\r
95     asm volatile (                                                           \\r
96         "STMDB  SP!, {R0}               \n\t"       /* Push R0.                                         */\\r
97         "MRS    R0, CPSR                \n\t"       /* Get CPSR.                                        */\\r
98         "ORR    R0, R0, #0xC0   \n\t"       /* Disable IRQ, FIQ.                        */\\r
99         "MSR    CPSR, R0                \n\t"       /* Write back modified value.       */\\r
100         "LDMIA  SP!, {R0}                       ")      /* Pop R0.                                              */\r
101 \r
102         #define portENABLE_INTERRUPTS()                                      \\r
103     asm volatile (                                                           \\r
104         "STMDB  SP!, {R0}               \n\t"       /* Push R0.                                         */\\r
105         "MRS    R0, CPSR                \n\t"       /* Get CPSR.                                        */\\r
106         "BIC    R0, R0, #0xC0   \n\t"       /* Enable IRQ, FIQ.                         */\\r
107         "MSR    CPSR, R0                \n\t"       /* Write back modified value.       */\\r
108         "LDMIA  SP!, {R0}                       ")      /* Pop R0.                                              */\r
109 \r
110     #endif /* THUMB_INTERWORK */\r
111 \r
112     extern void vPortEnterCritical( void );\r
113     extern void vPortExitCritical( void );\r
114 \r
115     #define portENTER_CRITICAL()    vPortEnterCritical();\r
116     #define portEXIT_CRITICAL()     vPortExitCritical();\r
117 /*-----------------------------------------------------------*/\r
118 \r
119 /* Task utilities. */\r
120     #define portEND_SWITCHING_ISR( xSwitchRequired ) \\r
121     {                                                \\r
122         extern void vTaskSwitchContext( void );      \\r
123                                                      \\r
124         if( xSwitchRequired )                        \\r
125         {                                            \\r
126             vTaskSwitchContext();                    \\r
127         }                                            \\r
128     }\r
129 /*-----------------------------------------------------------*/\r
130 \r
131 /* Task function macros as described on the FreeRTOS.org WEB site. */\r
132     #define portTASK_FUNCTION_PROTO( vFunction, pvParameters )    void vFunction( void * pvParameters )\r
133     #define portTASK_FUNCTION( vFunction, pvParameters )          void vFunction( void * pvParameters )\r
134 \r
135     #ifdef __cplusplus\r
136         }\r
137     #endif\r
138 \r
139 #endif /* PORTMACRO_H */\r