]> begriffs open source - freertos/blob - portable/GCC/NiosII/portmacro.h
Update SMP branch readme for port migration (#999)
[freertos] / portable / GCC / NiosII / portmacro.h
1 /*
2  * FreeRTOS SMP Kernel V202110.00
3  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
4  *
5  * Permission is hereby granted, free of charge, to any person obtaining a copy of
6  * this software and associated documentation files (the "Software"), to deal in
7  * the Software without restriction, including without limitation the rights to
8  * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
9  * the Software, and to permit persons to whom the Software is furnished to do so,
10  * subject to the following conditions:
11  *
12  * The above copyright notice and this permission notice shall be included in all
13  * copies or substantial portions of the Software.
14  *
15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
17  * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
18  * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
19  * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
20  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
21  *
22  * https://www.FreeRTOS.org
23  * https://github.com/FreeRTOS
24  *
25  * 1 tab == 4 spaces!
26  */
27
28 #ifndef PORTMACRO_H
29 #define PORTMACRO_H
30
31 #ifdef __cplusplus
32 extern "C" {
33 #endif
34
35 #include "sys/alt_irq.h"
36
37 /*-----------------------------------------------------------
38  * Port specific definitions.
39  *
40  * The settings in this file configure FreeRTOS correctly for the
41  * given hardware and compiler.
42  *
43  * These settings should not be altered.
44  *-----------------------------------------------------------
45  */
46
47 /* Type definitions. */
48 #define portCHAR                char
49 #define portFLOAT               float
50 #define portDOUBLE              double
51 #define portLONG                long
52 #define portSHORT               short
53 #define portSTACK_TYPE  uint32_t
54 #define portBASE_TYPE   long
55
56 typedef portSTACK_TYPE StackType_t;
57 typedef long BaseType_t;
58 typedef unsigned long UBaseType_t;
59
60 #if( configUSE_16_BIT_TICKS == 1 )
61         typedef uint16_t TickType_t;
62         #define portMAX_DELAY ( TickType_t ) 0xffff
63 #else
64         typedef uint32_t TickType_t;
65         #define portMAX_DELAY ( TickType_t ) 0xffffffffUL
66
67         /* 32-bit tick type on a 32-bit architecture, so reads of the tick count do
68         not need to be guarded with a critical section. */
69         #define portTICK_TYPE_IS_ATOMIC 1
70 #endif
71 /*-----------------------------------------------------------*/
72
73 /* Architecture specifics. */
74 #define portSTACK_GROWTH                                ( -1 )
75 #define portTICK_PERIOD_MS                              ( ( TickType_t ) 1000 / configTICK_RATE_HZ )
76 #define portBYTE_ALIGNMENT                              4
77 #define portNOP()                       asm volatile ( "NOP" )
78 #define portCRITICAL_NESTING_IN_TCB             1
79 /*-----------------------------------------------------------*/
80
81 extern void vTaskSwitchContext( void );
82 #define portYIELD()                                                                     asm volatile ( "trap" );
83 #define portEND_SWITCHING_ISR( xSwitchRequired )        if( xSwitchRequired )   vTaskSwitchContext()
84
85
86 /* Include the port_asm.S file where the Context saving/restoring is defined. */
87 __asm__( "\n\t.globl    save_context" );
88
89 /*-----------------------------------------------------------*/
90
91 extern void vTaskEnterCritical( void );
92 extern void vTaskExitCritical( void );
93
94 #define portDISABLE_INTERRUPTS()        alt_irq_disable_all()
95 #define portENABLE_INTERRUPTS()         alt_irq_enable_all( 0x01 );
96 #define portENTER_CRITICAL()        vTaskEnterCritical()
97 #define portEXIT_CRITICAL()         vTaskExitCritical()
98 /*-----------------------------------------------------------*/
99
100 /* Task function macros as described on the FreeRTOS.org WEB site. */
101 #define portTASK_FUNCTION_PROTO( vFunction, pvParameters ) void vFunction( void *pvParameters )
102 #define portTASK_FUNCTION( vFunction, pvParameters ) void vFunction( void *pvParameters )
103
104 #ifdef __cplusplus
105 }
106 #endif
107
108 #endif /* PORTMACRO_H */
109