]> begriffs open source - freertos/blob - Source/portable/GCC/STR75x/portmacro.h
Prepare for V5.3.1 release.
[freertos] / Source / portable / GCC / STR75x / portmacro.h
1 /*\r
2         FreeRTOS.org V5.3.1 - Copyright (C) 2003-2009 Richard Barry.\r
3 \r
4         This file is part of the FreeRTOS.org distribution.\r
5 \r
6         FreeRTOS.org is free software; you can redistribute it and/or modify it\r
7         under the terms of the GNU General Public License (version 2) as published\r
8         by the Free Software Foundation and modified by the FreeRTOS exception.\r
9         **NOTE** The exception to the GPL is included to allow you to distribute a\r
10         combined work that includes FreeRTOS.org without being obliged to provide\r
11         the source code for any proprietary components.  Alternative commercial\r
12         license and support terms are also available upon request.  See the \r
13         licensing section of http://www.FreeRTOS.org for full details.\r
14 \r
15         FreeRTOS.org is distributed in the hope that it will be useful, but WITHOUT\r
16         ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\r
17         FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for\r
18         more details.\r
19 \r
20         You should have received a copy of the GNU General Public License along\r
21         with FreeRTOS.org; if not, write to the Free Software Foundation, Inc., 59\r
22         Temple Place, Suite 330, Boston, MA  02111-1307  USA.\r
23 \r
24 \r
25         ***************************************************************************\r
26         *                                                                         *\r
27         * Get the FreeRTOS eBook!  See http://www.FreeRTOS.org/Documentation      *\r
28         *                                                                         *\r
29         * This is a concise, step by step, 'hands on' guide that describes both   *\r
30         * general multitasking concepts and FreeRTOS specifics. It presents and   *\r
31         * explains numerous examples that are written using the FreeRTOS API.     *\r
32         * Full source code for all the examples is provided in an accompanying    *\r
33         * .zip file.                                                              *\r
34         *                                                                         *\r
35         ***************************************************************************\r
36 \r
37         1 tab == 4 spaces!\r
38 \r
39         Please ensure to read the configuration and relevant port sections of the\r
40         online documentation.\r
41 \r
42         http://www.FreeRTOS.org - Documentation, latest information, license and\r
43         contact details.\r
44 \r
45         http://www.SafeRTOS.com - A version that is certified for use in safety\r
46         critical systems.\r
47 \r
48         http://www.OpenRTOS.com - Commercial support, development, porting,\r
49         licensing and training services.\r
50 */\r
51 \r
52 \r
53 #ifndef PORTMACRO_H\r
54 #define PORTMACRO_H\r
55 \r
56 #ifdef __cplusplus\r
57 extern "C" {\r
58 #endif\r
59 \r
60 /*-----------------------------------------------------------\r
61  * Port specific definitions.\r
62  *\r
63  * The settings in this file configure FreeRTOS correctly for the\r
64  * given hardware and compiler.\r
65  *\r
66  * These settings should not be altered.\r
67  *-----------------------------------------------------------\r
68  */\r
69 \r
70 /* Type definitions. */\r
71 #define portCHAR                char\r
72 #define portFLOAT               float\r
73 #define portDOUBLE              double\r
74 #define portLONG                long\r
75 #define portSHORT               short\r
76 #define portSTACK_TYPE  unsigned portLONG\r
77 #define portBASE_TYPE   portLONG\r
78 \r
79 #if( configUSE_16_BIT_TICKS == 1 )\r
80         typedef unsigned portSHORT portTickType;\r
81         #define portMAX_DELAY ( portTickType ) 0xffff\r
82 #else\r
83         typedef unsigned portLONG portTickType;\r
84         #define portMAX_DELAY ( portTickType ) 0xffffffff\r
85 #endif\r
86 /*-----------------------------------------------------------*/ \r
87 \r
88 /* Hardware specifics. */\r
89 #define portSTACK_GROWTH                        ( -1 )\r
90 #define portTICK_RATE_MS                        ( ( portTickType ) 1000 / configTICK_RATE_HZ )          \r
91 #define portBYTE_ALIGNMENT                      4\r
92 #define portYIELD()                                     asm volatile ( "SWI 0" )\r
93 #define portNOP()                                       asm volatile ( "NOP" )\r
94 /*-----------------------------------------------------------*/ \r
95 \r
96 /* Critical section handling. */\r
97 /*\r
98  * The interrupt management utilities can only be called from ARM mode.  When\r
99  * THUMB_INTERWORK is defined the utilities are defined as functions in \r
100  * portISR.c to ensure a switch to ARM mode.  When THUMB_INTERWORK is not \r
101  * defined then the utilities are defined as macros here - as per other ports.\r
102  */\r
103 \r
104 #ifdef THUMB_INTERWORK\r
105 \r
106         extern void vPortDisableInterruptsFromThumb( void ) __attribute__ ((naked));\r
107         extern void vPortEnableInterruptsFromThumb( void ) __attribute__ ((naked));\r
108 \r
109         #define portDISABLE_INTERRUPTS()        vPortDisableInterruptsFromThumb()\r
110         #define portENABLE_INTERRUPTS()         vPortEnableInterruptsFromThumb()\r
111         \r
112 #else\r
113 \r
114         #define portDISABLE_INTERRUPTS()                                                                                        \\r
115                 asm volatile (                                                                                                                  \\r
116                         "STMDB  SP!, {R0}               \n\t"   /* Push R0.                                             */      \\r
117                         "MRS    R0, CPSR                \n\t"   /* Get CPSR.                                    */      \\r
118                         "ORR    R0, R0, #0xC0   \n\t"   /* Disable IRQ, FIQ.                    */      \\r
119                         "MSR    CPSR, R0                \n\t"   /* Write back modified value.   */      \\r
120                         "LDMIA  SP!, {R0}                       " )     /* Pop R0.                                              */\r
121                         \r
122         #define portENABLE_INTERRUPTS()                                                                                         \\r
123                 asm volatile (                                                                                                                  \\r
124                         "STMDB  SP!, {R0}               \n\t"   /* Push R0.                                             */      \\r
125                         "MRS    R0, CPSR                \n\t"   /* Get CPSR.                                    */      \\r
126                         "BIC    R0, R0, #0xC0   \n\t"   /* Enable IRQ, FIQ.                             */      \\r
127                         "MSR    CPSR, R0                \n\t"   /* Write back modified value.   */      \\r
128                         "LDMIA  SP!, {R0}                       " )     /* Pop R0.                                              */\r
129 \r
130 #endif /* THUMB_INTERWORK */\r
131 \r
132 extern void vPortEnterCritical( void );\r
133 extern void vPortExitCritical( void );\r
134 \r
135 #define portENTER_CRITICAL()            vPortEnterCritical();\r
136 #define portEXIT_CRITICAL()                     vPortExitCritical();\r
137 /*-----------------------------------------------------------*/ \r
138 \r
139 /* Task utilities. */\r
140 #define portEND_SWITCHING_ISR( xSwitchRequired )        \\r
141 {                                                                                                       \\r
142 extern void vTaskSwitchContext( void );                         \\r
143                                                                                                         \\r
144         if( xSwitchRequired )                                                   \\r
145         {                                                                                               \\r
146                 vTaskSwitchContext();                                           \\r
147         }                                                                                               \\r
148 }\r
149 /*-----------------------------------------------------------*/ \r
150 \r
151 /* Task function macros as described on the FreeRTOS.org WEB site. */\r
152 #define portTASK_FUNCTION_PROTO( vFunction, pvParameters ) void vFunction( void * pvParameters )\r
153 #define portTASK_FUNCTION( vFunction, pvParameters ) void vFunction( void * pvParameters )\r
154 \r
155 #ifdef __cplusplus\r
156 }\r
157 #endif\r
158 \r
159 #endif /* PORTMACRO_H */\r
160 \r
161 \r