xref: /Kernel-v10.6.2/portable/IAR/STR91x/portmacro.h (revision ef7b253b56c9788077f5ecd6c9deb4021923d646) 
1 /*
2  * FreeRTOS Kernel V10.6.2
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 
30 #ifndef PORTMACRO_H
31 #define PORTMACRO_H
32 
33 /*-----------------------------------------------------------
34  * Port specific definitions.
35  *
36  * The settings in this file configure FreeRTOS correctly for the
37  * given hardware and compiler.
38  *
39  * These settings should not be altered.
40  *-----------------------------------------------------------
41  */
42 
43 #include <intrinsics.h>
44 
45 /* *INDENT-OFF* */
46 #ifdef __cplusplus
47     extern "C" {
48 #endif
49 /* *INDENT-ON* */
50 
51 /* Type definitions. */
52 #define portCHAR            char
53 #define portFLOAT           float
54 #define portDOUBLE          double
55 #define portLONG            long
56 #define portSHORT           short
57 #define portSTACK_TYPE      uint32_t
58 #define portBASE_TYPE       long
59 
60 typedef portSTACK_TYPE StackType_t;
61 typedef long BaseType_t;
62 typedef unsigned long UBaseType_t;
63 
64 
65 #if( configTICK_TYPE_WIDTH_IN_BITS == TICK_TYPE_WIDTH_16_BITS )
66     typedef uint16_t TickType_t;
67     #define portMAX_DELAY ( TickType_t ) 0xffff
68 #elif ( configTICK_TYPE_WIDTH_IN_BITS  == TICK_TYPE_WIDTH_32_BITS )
69     typedef uint32_t             TickType_t;
70     #define portMAX_DELAY    ( TickType_t ) 0xffffffffUL
71 #else
72     #error configTICK_TYPE_WIDTH_IN_BITS set to unsupported tick type width.
73 #endif
74 /*-----------------------------------------------------------*/
75 
76 /* Hardware specifics. */
77 #define portSTACK_GROWTH            ( -1 )
78 #define portTICK_PERIOD_MS          ( ( TickType_t ) 1000 / configTICK_RATE_HZ )
79 #define portBYTE_ALIGNMENT          8
80 #define portYIELD()                 asm ( "SWI 0" )
81 #define portNOP()                   asm ( "NOP" )
82 /*-----------------------------------------------------------*/
83 
84 /* Critical section handling. */
85 __arm __interwork void vPortEnterCritical( void );
86 __arm __interwork void vPortExitCritical( void );
87 #define portENTER_CRITICAL()        vPortEnterCritical()
88 #define portEXIT_CRITICAL()         vPortExitCritical()
89 
90 #define portDISABLE_INTERRUPTS()    __disable_interrupt()
91 #define portENABLE_INTERRUPTS()     __enable_interrupt()
92 
93 
94 /*-----------------------------------------------------------*/
95 
96 /* Task utilities. */
97 #define portEND_SWITCHING_ISR( xSwitchRequired )    \
98 {                                                   \
99 extern void vTaskSwitchContext( void );             \
100                                                     \
101     if( xSwitchRequired )                           \
102     {                                               \
103         vTaskSwitchContext();                       \
104     }                                               \
105 }
106 /*-----------------------------------------------------------*/
107 
108 
109 /* Task function macros as described on the FreeRTOS.org WEB site. */
110 #define portTASK_FUNCTION_PROTO( vFunction, pvParameters ) void vFunction( void * pvParameters )
111 #define portTASK_FUNCTION( vFunction, pvParameters ) void vFunction( void * pvParameters )
112 
113 /* *INDENT-OFF* */
114 #ifdef __cplusplus
115     }
116 #endif
117 /* *INDENT-ON* */
118 
119 #endif /* PORTMACRO_H */
120