]> begriffs open source - freertos/blob - portable/SDCC/Cygnal/portmacro.h
Make taskYIELD available to unprivileged tasks (#817)
[freertos] / portable / SDCC / Cygnal / portmacro.h
1 /*
2  * FreeRTOS Kernel <DEVELOPMENT BRANCH>
3  * Copyright (C) 2021 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
4  *
5  * SPDX-License-Identifier: MIT
6  *
7  * Permission is hereby granted, free of charge, to any person obtaining a copy of
8  * this software and associated documentation files (the "Software"), to deal in
9  * the Software without restriction, including without limitation the rights to
10  * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
11  * the Software, and to permit persons to whom the Software is furnished to do so,
12  * subject to the following conditions:
13  *
14  * The above copyright notice and this permission notice shall be included in all
15  * copies or substantial portions of the Software.
16  *
17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
19  * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
20  * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
21  * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
22  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
23  *
24  * https://www.FreeRTOS.org
25  * https://github.com/FreeRTOS
26  *
27  */
28
29 #ifndef PORTMACRO_H
30 #define PORTMACRO_H
31
32 #if configUSE_PREEMPTION == 0
33     void vTimer2ISR( void ) interrupt 5;
34 #else
35     void vTimer2ISR( void ) interrupt 5 _naked;
36 #endif
37
38 void vSerialISR( void ) interrupt 4;
39
40
41 /*-----------------------------------------------------------
42  * Port specific definitions.
43  *
44  * The settings in this file configure FreeRTOS correctly for the
45  * given hardware and compiler.
46  *
47  * These settings should not be altered.
48  *-----------------------------------------------------------
49  */
50
51 /* Type definitions. */
52 #define portCHAR          char
53 #define portFLOAT         float
54 #define portDOUBLE        float
55 #define portLONG          long
56 #define portSHORT         short
57 #define portSTACK_TYPE    uint8_t
58 #define portBASE_TYPE     char
59
60 typedef portSTACK_TYPE   StackType_t;
61 typedef signed char      BaseType_t;
62 typedef unsigned char    UBaseType_t;
63
64 #if ( configTICK_TYPE_WIDTH_IN_BITS == TICK_TYPE_WIDTH_16_BITS )
65     typedef uint16_t     TickType_t;
66     #define portMAX_DELAY    ( TickType_t ) 0xffff
67 #elif ( configTICK_TYPE_WIDTH_IN_BITS == TICK_TYPE_WIDTH_32_BITS )
68     typedef uint32_t     TickType_t;
69     #define portMAX_DELAY    ( TickType_t ) 0xffffffffUL
70 #else
71     #error configTICK_TYPE_WIDTH_IN_BITS set to unsupported tick type width.
72 #endif
73 /*-----------------------------------------------------------*/
74
75 /* Critical section management. */
76 #define portENTER_CRITICAL() \
77     _asm                     \
78     push ACC                 \
79     push IE                  \
80     _endasm;                 \
81     EA = 0;
82
83 #define portEXIT_CRITICAL() \
84     _asm                    \
85     pop ACC                 \
86     _endasm;                \
87     ACC &= 0x80;            \
88     IE |= ACC;              \
89     _asm                    \
90     pop ACC                 \
91         _endasm;
92
93 #define portDISABLE_INTERRUPTS()    EA = 0;
94 #define portENABLE_INTERRUPTS()     EA = 1;
95 /*-----------------------------------------------------------*/
96
97 /* Hardware specifics. */
98 #define portBYTE_ALIGNMENT    1
99 #define portSTACK_GROWTH      ( 1 )
100 #define portTICK_PERIOD_MS    ( ( uint32_t ) 1000 / configTICK_RATE_HZ )
101 /*-----------------------------------------------------------*/
102
103 /* Task utilities. */
104 void vPortYield( void ) _naked;
105 #define portYIELD()    vPortYield();
106 /*-----------------------------------------------------------*/
107
108 #define portNOP() \
109     _asm          \
110     nop           \
111     _endasm;
112
113 /*-----------------------------------------------------------*/
114
115 /* Task function macros as described on the FreeRTOS.org WEB site. */
116 #define portTASK_FUNCTION_PROTO( vFunction, pvParameters )    void vFunction( void * pvParameters )
117 #define portTASK_FUNCTION( vFunction, pvParameters )          void vFunction( void * pvParameters )
118
119 #endif /* PORTMACRO_H */