]> git.sur5r.net Git - freertos/blob - FreeRTOS/Source/portable/GCC/CORTUS_APS3/portmacro.h
Multiple tidy up, documentation corrections and typo corrections highlighted by Tamas...
[freertos] / FreeRTOS / Source / portable / GCC / CORTUS_APS3 / portmacro.h
1 /*\r
2     FreeRTOS V7.6.0 - Copyright (C) 2013 Real Time Engineers Ltd. \r
3     All rights reserved\r
4 \r
5     VISIT http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.\r
6 \r
7     ***************************************************************************\r
8      *                                                                       *\r
9      *    FreeRTOS provides completely free yet professionally developed,    *\r
10      *    robust, strictly quality controlled, supported, and cross          *\r
11      *    platform software that has become a de facto standard.             *\r
12      *                                                                       *\r
13      *    Help yourself get started quickly and support the FreeRTOS         *\r
14      *    project by purchasing a FreeRTOS tutorial book, reference          *\r
15      *    manual, or both from: http://www.FreeRTOS.org/Documentation        *\r
16      *                                                                       *\r
17      *    Thank you!                                                         *\r
18      *                                                                       *\r
19     ***************************************************************************\r
20 \r
21     This file is part of the FreeRTOS distribution.\r
22 \r
23     FreeRTOS is free software; you can redistribute it and/or modify it under\r
24     the terms of the GNU General Public License (version 2) as published by the\r
25     Free Software Foundation >>!AND MODIFIED BY!<< the FreeRTOS exception.\r
26 \r
27     >>! NOTE: The modification to the GPL is included to allow you to distribute\r
28     >>! a combined work that includes FreeRTOS without being obliged to provide\r
29     >>! the source code for proprietary components outside of the FreeRTOS\r
30     >>! kernel.\r
31 \r
32     FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY\r
33     WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS\r
34     FOR A PARTICULAR PURPOSE.  Full license text is available from the following\r
35     link: http://www.freertos.org/a00114.html\r
36 \r
37     1 tab == 4 spaces!\r
38 \r
39     ***************************************************************************\r
40      *                                                                       *\r
41      *    Having a problem?  Start by reading the FAQ "My application does   *\r
42      *    not run, what could be wrong?"                                     *\r
43      *                                                                       *\r
44      *    http://www.FreeRTOS.org/FAQHelp.html                               *\r
45      *                                                                       *\r
46     ***************************************************************************\r
47 \r
48     http://www.FreeRTOS.org - Documentation, books, training, latest versions,\r
49     license and Real Time Engineers Ltd. contact details.\r
50 \r
51     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
52     including FreeRTOS+Trace - an indispensable productivity tool, a DOS\r
53     compatible FAT file system, and our tiny thread aware UDP/IP stack.\r
54 \r
55     http://www.OpenRTOS.com - Real Time Engineers ltd license FreeRTOS to High\r
56     Integrity Systems to sell under the OpenRTOS brand.  Low cost OpenRTOS\r
57     licenses offer ticketed support, indemnification and middleware.\r
58 \r
59     http://www.SafeRTOS.com - High Integrity Systems also provide a safety\r
60     engineered and independently SIL3 certified version for use in safety and\r
61     mission critical applications that require provable dependability.\r
62 \r
63     1 tab == 4 spaces!\r
64 */\r
65 \r
66 #ifndef PORTMACRO_H\r
67 #define PORTMACRO_H\r
68 \r
69 #ifdef __cplusplus\r
70 extern "C" {\r
71 #endif\r
72 \r
73 #include <machine/cpu.h>\r
74 \r
75 /*-----------------------------------------------------------\r
76  * Port specific definitions.\r
77  *\r
78  * The settings in this file configure FreeRTOS correctly for the\r
79  * given hardware and compiler.\r
80  *\r
81  * These settings should not be altered.\r
82  *-----------------------------------------------------------\r
83  */\r
84 \r
85 /* Type definitions. */\r
86 #define portCHAR                char\r
87 #define portFLOAT               float\r
88 #define portDOUBLE              double\r
89 #define portLONG                long\r
90 #define portSHORT               short\r
91 #define portSTACK_TYPE  unsigned portLONG\r
92 #define portBASE_TYPE   portLONG\r
93 \r
94 #if( configUSE_16_BIT_TICKS == 1 )\r
95         typedef unsigned portSHORT portTickType;\r
96         #define portMAX_DELAY ( portTickType ) 0xffff\r
97 #else\r
98         typedef unsigned portLONG portTickType;\r
99         #define portMAX_DELAY ( portTickType ) 0xffffffffUL\r
100 #endif\r
101 /*-----------------------------------------------------------*/\r
102 \r
103 /* Architecture specifics. */\r
104 #define portSTACK_GROWTH                                                        ( -1 )\r
105 #define portTICK_RATE_MS                                                        ( ( portTickType ) 1000 / configTICK_RATE_HZ )\r
106 #define portBYTE_ALIGNMENT                                                      4\r
107 #define portNOP()                                                                       __asm__ volatile ( "mov r0, r0" )\r
108 #define portCRITICAL_NESTING_IN_TCB                                     1\r
109 #define portIRQ_TRAP_YIELD                                                      31\r
110 /*-----------------------------------------------------------*/\r
111 \r
112 /* Task utilities. */\r
113 \r
114 extern void vPortYield( void );\r
115 \r
116 /*---------------------------------------------------------------------------*/\r
117 \r
118 #define portYIELD()             asm __volatile__( " trap #%0 "::"i"(portIRQ_TRAP_YIELD):"memory")\r
119 /*---------------------------------------------------------------------------*/\r
120 \r
121 extern void vTaskEnterCritical( void );\r
122 extern void vTaskExitCritical( void );\r
123 #define portENTER_CRITICAL()            vTaskEnterCritical()\r
124 #define portEXIT_CRITICAL()                     vTaskExitCritical()\r
125 /*---------------------------------------------------------------------------*/\r
126 \r
127 /* Critical section management. */\r
128 #define portDISABLE_INTERRUPTS()        cpu_int_disable()\r
129 #define portENABLE_INTERRUPTS()         cpu_int_enable()\r
130 \r
131 /*---------------------------------------------------------------------------*/\r
132 \r
133 #define portYIELD_FROM_ISR( xHigherPriorityTaskWoken ) if( xHigherPriorityTaskWoken != pdFALSE ) vTaskSwitchContext()\r
134 \r
135 /*---------------------------------------------------------------------------*/\r
136 \r
137 #define portSAVE_CONTEXT()                              \\r
138         asm __volatile__                                                                                                                                                                                                \\r
139         (                                                                                                                                                                                                                               \\r
140                 "sub    r1, #68                                 \n" /* Make space on the stack for the context. */                                                      \\r
141                 "std    r2, [r1] +      0                       \n"                                                                                                                                                     \\r
142                 "stq    r4, [r1] +      8                       \n"                                                                                                                                                     \\r
143                 "stq    r8, [r1] +      24                      \n"                                                                                                                                                     \\r
144                 "stq    r12, [r1] +     40                      \n"                                                                                                                                                     \\r
145                 "mov    r6, rtt                                 \n"                                                                                                                                                     \\r
146                 "mov    r7, psr                                 \n"                                                                                                                                                     \\r
147                 "std    r6, [r1] +      56                      \n"                                                                                                                                                     \\r
148                 "movhi  r2, #16384                              \n"     /* Set the pointer to the IC. */                                                                                \\r
149                 "ldub   r3, [r2] + 2                    \n"     /* Load the current interrupt mask. */                                                                  \\r
150                 "st             r3, [r1]+ 64                    \n"     /* Store the interrupt mask on the stack. */                                                    \\r
151                 "ld             r2, [r0]+short(pxCurrentTCB)    \n"     /* Load the pointer to the TCB. */                                                              \\r
152                 "st             r1, [r2]                                \n"     /* Save the stack pointer into the TCB. */                                                              \\r
153                 "mov    r14, r1                                 \n"     /* Compiler expects r14 to be set to the function stack. */                             \\r
154         );\r
155 /*---------------------------------------------------------------------------*/\r
156 \r
157 #define portRESTORE_CONTEXT()                                                                                                                                                                           \\r
158         asm __volatile__(                                                                                                                                                                                               \\r
159                 "ld             r2, [r0]+short(pxCurrentTCB)    \n"     /* Load the TCB to find the stack pointer and context. */               \\r
160                 "ld             r1, [r2]                                \n"                                                                                                                                                     \\r
161                 "movhi  r2, #16384                              \n"     /* Set the pointer to the IC. */                                                                                \\r
162                 "ld             r3, [r1] + 64                   \n"     /* Load the previous interrupt mask. */                                                                 \\r
163                 "stb    r3, [r2] + 2                    \n"     /* Set the current interrupt mask to be the previous. */                                \\r
164                 "ldd    r6, [r1] + 56                   \n"     /* Restore context. */                                                                                                  \\r
165                 "mov    rtt, r6                                 \n"                                                                                                                                                     \\r
166                 "mov    psr, r7                                 \n"                                                                                                                                                     \\r
167                 "ldd    r2, [r1] + 0                    \n"                                                                                                                                                     \\r
168                 "ldq    r4, [r1] +      8                       \n"                                                                                                                                                     \\r
169                 "ldq    r8, [r1] +      24                      \n"                                                                                                                                                     \\r
170                 "ldq    r12, [r1] +     40                      \n"                                                                                                                                                     \\r
171                 "add    r1, #68                                 \n"                                                                                                                                                     \\r
172                 "rti                                                    \n"                                                                                                                                                     \\r
173          );\r
174 \r
175 /*---------------------------------------------------------------------------*/\r
176 \r
177 /* Task function macros as described on the FreeRTOS.org WEB site. */\r
178 #define portTASK_FUNCTION_PROTO( vFunction, pvParameters ) void vFunction( void *pvParameters )\r
179 #define portTASK_FUNCTION( vFunction, pvParameters ) void vFunction( void *pvParameters )\r
180 /*---------------------------------------------------------------------------*/\r
181 \r
182 #ifdef __cplusplus\r
183 }\r
184 #endif\r
185 \r
186 #endif /* PORTMACRO_H */\r