]> begriffs open source - freertos/blob - portable/GCC/MicroBlaze/portmacro.h
Remove "1 tab == 4 spaces!" line from files that still contain it.
[freertos] / portable / GCC / MicroBlaze / portmacro.h
1 /*\r
2  * FreeRTOS Kernel <DEVELOPMENT BRANCH>\r
3  * Copyright (C) 2021 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  * https://www.FreeRTOS.org\r
23  * https://github.com/FreeRTOS\r
24  *\r
25  */\r
26 \r
27 #ifndef PORTMACRO_H\r
28 #define PORTMACRO_H\r
29 \r
30 #ifdef __cplusplus\r
31 extern "C" {\r
32 #endif\r
33 \r
34 /*-----------------------------------------------------------\r
35  * Port specific definitions.\r
36  *\r
37  * The settings in this file configure FreeRTOS correctly for the\r
38  * given hardware and compiler.\r
39  *\r
40  * These settings should not be altered.\r
41  *-----------------------------------------------------------\r
42  */\r
43 \r
44 /* Type definitions. */\r
45 #define portCHAR                char\r
46 #define portFLOAT               float\r
47 #define portDOUBLE              double\r
48 #define portLONG                long\r
49 #define portSHORT               short\r
50 #define portSTACK_TYPE  uint32_t\r
51 #define portBASE_TYPE   long\r
52 \r
53 typedef portSTACK_TYPE StackType_t;\r
54 typedef long BaseType_t;\r
55 typedef unsigned long UBaseType_t;\r
56 \r
57 #if( configUSE_16_BIT_TICKS == 1 )\r
58         typedef uint16_t TickType_t;\r
59         #define portMAX_DELAY ( TickType_t ) 0xffff\r
60 #else\r
61         typedef uint32_t TickType_t;\r
62         #define portMAX_DELAY ( TickType_t ) 0xffffffffUL\r
63 \r
64         /* 32-bit tick type on a 32-bit architecture, so reads of the tick count do\r
65         not need to be guarded with a critical section. */\r
66         #define portTICK_TYPE_IS_ATOMIC 1\r
67 #endif\r
68 /*-----------------------------------------------------------*/\r
69 \r
70 /* Interrupt control macros. */\r
71 void microblaze_disable_interrupts( void );\r
72 void microblaze_enable_interrupts( void );\r
73 #define portDISABLE_INTERRUPTS()        microblaze_disable_interrupts()\r
74 #define portENABLE_INTERRUPTS()         microblaze_enable_interrupts()\r
75 /*-----------------------------------------------------------*/\r
76 \r
77 /* Critical section macros. */\r
78 void vPortEnterCritical( void );\r
79 void vPortExitCritical( void );\r
80 #define portENTER_CRITICAL()            {                                                                                                               \\r
81                                                                                 extern UBaseType_t uxCriticalNesting;   \\r
82                                                                                 microblaze_disable_interrupts();                                        \\r
83                                                                                 uxCriticalNesting++;                                                            \\r
84                                                                         }\r
85 \r
86 #define portEXIT_CRITICAL()                     {                                                                                                               \\r
87                                                                                 extern UBaseType_t uxCriticalNesting;   \\r
88                                                                                 /* Interrupts are disabled, so we can */                        \\r
89                                                                                 /* access the variable directly. */                                     \\r
90                                                                                 uxCriticalNesting--;                                                            \\r
91                                                                                 if( uxCriticalNesting == 0 )                    \\r
92                                                                                 {                                                                                                       \\r
93                                                                                         /* The nesting has unwound and we                               \\r
94                                                                                         can enable interrupts again. */                                 \\r
95                                                                                         portENABLE_INTERRUPTS();                                                \\r
96                                                                                 }                                                                                                       \\r
97                                                                         }\r
98 \r
99 /*-----------------------------------------------------------*/\r
100 \r
101 /* Task utilities. */\r
102 void vPortYield( void );\r
103 #define portYIELD() vPortYield()\r
104 \r
105 void vTaskSwitchContext();\r
106 #define portYIELD_FROM_ISR() vTaskSwitchContext()\r
107 /*-----------------------------------------------------------*/\r
108 \r
109 /* Hardware specifics. */\r
110 #define portBYTE_ALIGNMENT                      4\r
111 #define portSTACK_GROWTH                        ( -1 )\r
112 #define portTICK_PERIOD_MS                      ( ( TickType_t ) 1000 / configTICK_RATE_HZ )\r
113 #define portNOP()                                       asm volatile ( "NOP" )\r
114 /*-----------------------------------------------------------*/\r
115 \r
116 /* Task function macros as described on the FreeRTOS.org WEB site. */\r
117 #define portTASK_FUNCTION_PROTO( vFunction, pvParameters ) void vFunction( void *pvParameters )\r
118 #define portTASK_FUNCTION( vFunction, pvParameters ) void vFunction( void *pvParameters )\r
119 \r
120 #ifdef __cplusplus\r
121 }\r
122 #endif\r
123 \r
124 #endif /* PORTMACRO_H */\r
125 \r