]> git.sur5r.net Git - freertos/blob - FreeRTOS/Source/portable/GCC/RL78/portmacro.h
Prepare for V9.0.0 release:
[freertos] / FreeRTOS / Source / portable / GCC / RL78 / portmacro.h
1 /*\r
2     FreeRTOS V9.0.0 - Copyright (C) 2016 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     This file is part of the FreeRTOS distribution.\r
8 \r
9     FreeRTOS is free software; you can redistribute it and/or modify it under\r
10     the terms of the GNU General Public License (version 2) as published by the\r
11     Free Software Foundation >>>> AND MODIFIED BY <<<< the FreeRTOS exception.\r
12 \r
13     ***************************************************************************\r
14     >>!   NOTE: The modification to the GPL is included to allow you to     !<<\r
15     >>!   distribute a combined work that includes FreeRTOS without being   !<<\r
16     >>!   obliged to provide the source code for proprietary components     !<<\r
17     >>!   outside of the FreeRTOS kernel.                                   !<<\r
18     ***************************************************************************\r
19 \r
20     FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY\r
21     WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS\r
22     FOR A PARTICULAR PURPOSE.  Full license text is available on the following\r
23     link: http://www.freertos.org/a00114.html\r
24 \r
25     ***************************************************************************\r
26      *                                                                       *\r
27      *    FreeRTOS provides completely free yet professionally developed,    *\r
28      *    robust, strictly quality controlled, supported, and cross          *\r
29      *    platform software that is more than just the market leader, it     *\r
30      *    is the industry's de facto standard.                               *\r
31      *                                                                       *\r
32      *    Help yourself get started quickly while simultaneously helping     *\r
33      *    to support the FreeRTOS project by purchasing a FreeRTOS           *\r
34      *    tutorial book, reference manual, or both:                          *\r
35      *    http://www.FreeRTOS.org/Documentation                              *\r
36      *                                                                       *\r
37     ***************************************************************************\r
38 \r
39     http://www.FreeRTOS.org/FAQHelp.html - Having a problem?  Start by reading\r
40     the FAQ page "My application does not run, what could be wrong?".  Have you\r
41     defined configASSERT()?\r
42 \r
43     http://www.FreeRTOS.org/support - In return for receiving this top quality\r
44     embedded software for free we request you assist our global community by\r
45     participating in the support forum.\r
46 \r
47     http://www.FreeRTOS.org/training - Investing in training allows your team to\r
48     be as productive as possible as early as possible.  Now you can receive\r
49     FreeRTOS training directly from Richard Barry, CEO of Real Time Engineers\r
50     Ltd, and the world's leading authority on the world's leading RTOS.\r
51 \r
52     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
53     including FreeRTOS+Trace - an indispensable productivity tool, a DOS\r
54     compatible FAT file system, and our tiny thread aware UDP/IP stack.\r
55 \r
56     http://www.FreeRTOS.org/labs - Where new FreeRTOS products go to incubate.\r
57     Come and try FreeRTOS+TCP, our new open source TCP/IP stack for FreeRTOS.\r
58 \r
59     http://www.OpenRTOS.com - Real Time Engineers ltd. license FreeRTOS to High\r
60     Integrity Systems ltd. to sell under the OpenRTOS brand.  Low cost OpenRTOS\r
61     licenses offer ticketed support, indemnification and commercial middleware.\r
62 \r
63     http://www.SafeRTOS.com - High Integrity Systems also provide a safety\r
64     engineered and independently SIL3 certified version for use in safety and\r
65     mission critical applications that require provable dependability.\r
66 \r
67     1 tab == 4 spaces!\r
68 */\r
69 \r
70 #ifndef PORTMACRO_H\r
71 #define PORTMACRO_H\r
72 \r
73 /*-----------------------------------------------------------\r
74  * Port specific definitions.\r
75  *\r
76  * The settings in this file configure FreeRTOS correctly for the\r
77  * given hardware and compiler.\r
78  *\r
79  * These settings should not be altered.\r
80  *-----------------------------------------------------------\r
81  */\r
82 \r
83 /* Type definitions. */\r
84 \r
85 #define portCHAR        char\r
86 #define portFLOAT       float\r
87 #define portDOUBLE      double\r
88 #define portLONG        long\r
89 #define portSHORT       short\r
90 #define portSTACK_TYPE  uint16_t\r
91 #define portBASE_TYPE   short\r
92 #define portPOINTER_SIZE_TYPE uint16_t\r
93 \r
94 typedef portSTACK_TYPE StackType_t;\r
95 typedef short BaseType_t;\r
96 typedef unsigned short UBaseType_t;\r
97 \r
98 #if( configUSE_16_BIT_TICKS == 1 )\r
99         typedef uint16_t TickType_t;\r
100         #define portMAX_DELAY ( TickType_t ) 0xffff\r
101 #else\r
102         typedef uint32_t TickType_t;\r
103         #define portMAX_DELAY ( TickType_t ) 0xffffffffUL\r
104 #endif\r
105 /*-----------------------------------------------------------*/\r
106 \r
107 /* Interrupt control macros. */\r
108 #define portDISABLE_INTERRUPTS() __asm volatile ( "DI" )\r
109 #define portENABLE_INTERRUPTS()  __asm volatile ( "EI" )\r
110 /*-----------------------------------------------------------*/\r
111 \r
112 /* Critical section control macros. */\r
113 #define portNO_CRITICAL_SECTION_NESTING         ( ( unsigned short ) 0 )\r
114 \r
115 #define portENTER_CRITICAL()                                                                                                    \\r
116 {                                                                                                                                                               \\r
117 extern volatile uint16_t usCriticalNesting;                                                                             \\r
118                                                                                                                                                                 \\r
119         portDISABLE_INTERRUPTS();                                                                                                       \\r
120                                                                                                                                                                 \\r
121         /* Now interrupts are disabled ulCriticalNesting can be accessed */                     \\r
122         /* directly.  Increment ulCriticalNesting to keep a count of how many */        \\r
123         /* times portENTER_CRITICAL() has been called. */                                                       \\r
124         usCriticalNesting++;                                                                                                            \\r
125 }\r
126 \r
127 #define portEXIT_CRITICAL()                                                                                                             \\r
128 {                                                                                                                                                               \\r
129 extern volatile uint16_t usCriticalNesting;                                                                             \\r
130                                                                                                                                                                 \\r
131         if( usCriticalNesting > portNO_CRITICAL_SECTION_NESTING )                                       \\r
132         {                                                                                                                                                       \\r
133                 /* Decrement the nesting count as we are leaving a critical section. */ \\r
134                 usCriticalNesting--;                                                                                                    \\r
135                                                                                                                                                                 \\r
136                 /* If the nesting level has reached zero then interrupts should be */   \\r
137                 /* re-enabled. */                                                                                                               \\r
138                 if( usCriticalNesting == portNO_CRITICAL_SECTION_NESTING )                              \\r
139                 {                                                                                                                                               \\r
140                         portENABLE_INTERRUPTS();                                                                                        \\r
141                 }                                                                                                                                               \\r
142         }                                                                                                                                                       \\r
143 }\r
144 /*-----------------------------------------------------------*/\r
145 \r
146 /* Task utilities. */\r
147 #define portYIELD()     __asm volatile ( "BRK" )\r
148 #define portYIELD_FROM_ISR( xHigherPriorityTaskWoken ) if( xHigherPriorityTaskWoken ) vTaskSwitchContext()\r
149 #define portNOP()       __asm volatile ( "NOP" )\r
150 /*-----------------------------------------------------------*/\r
151 \r
152 /* Hardwware specifics. */\r
153 #define portBYTE_ALIGNMENT      2\r
154 #define portSTACK_GROWTH        ( -1 )\r
155 #define portTICK_PERIOD_MS      ( ( TickType_t ) 1000 / configTICK_RATE_HZ )\r
156 /*-----------------------------------------------------------*/\r
157 \r
158 /* Task function macros as described on the FreeRTOS.org WEB site. */\r
159 #define portTASK_FUNCTION_PROTO( vFunction, pvParameters ) void vFunction( void *pvParameters )\r
160 #define portTASK_FUNCTION( vFunction, pvParameters ) void vFunction( void *pvParameters )\r
161 \r
162 #endif /* PORTMACRO_H */\r
163 \r