xref: /Kernel-v10.6.2/portable/IAR/MSP430X/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 #ifndef PORTMACRO_H
30 #define PORTMACRO_H
31 
32 /*-----------------------------------------------------------
33  * Port specific definitions.
34  *
35  * The settings in this file configure FreeRTOS correctly for the
36  * given hardware and compiler.
37  *
38  * These settings should not be altered.
39  *-----------------------------------------------------------
40  */
41 
42 /* Hardware includes. */
43 #include "msp430.h"
44 
45 /* Type definitions. */
46 #define portCHAR        char
47 #define portFLOAT       float
48 #define portDOUBLE      double
49 #define portLONG        long
50 #define portSHORT       int
51 #define portBASE_TYPE   short
52 
53 /* The stack type changes depending on the data model. */
54 #if( __DATA_MODEL__ == __DATA_MODEL_SMALL__ )
55     #define portSTACK_TYPE uint16_t
56     #define portPOINTER_SIZE_TYPE uint16_t
57 #else
58     #define portSTACK_TYPE uint32_t
59 #endif
60 
61 typedef portSTACK_TYPE StackType_t;
62 typedef short BaseType_t;
63 typedef unsigned short UBaseType_t;
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 
77 /* Interrupt control macros. */
78 #define portDISABLE_INTERRUPTS()    _DINT(); _NOP()
79 #define portENABLE_INTERRUPTS()     _EINT(); _NOP()
80 /*-----------------------------------------------------------*/
81 
82 /* Critical section control macros. */
83 #define portNO_CRITICAL_SECTION_NESTING     ( ( uint16_t ) 0 )
84 
85 #define portENTER_CRITICAL()                                                    \
86 {                                                                               \
87 extern volatile uint16_t usCriticalNesting;                                     \
88                                                                                 \
89     portDISABLE_INTERRUPTS();                                                   \
90                                                                                 \
91     /* Now interrupts are disabled usCriticalNesting can be accessed */         \
92     /* directly.  Increment ulCriticalNesting to keep a count of how many */    \
93     /* times portENTER_CRITICAL() has been called. */                           \
94     usCriticalNesting++;                                                        \
95 }
96 
97 #define portEXIT_CRITICAL()                                                     \
98 {                                                                               \
99 extern volatile uint16_t usCriticalNesting;                                     \
100                                                                                 \
101     if( usCriticalNesting > portNO_CRITICAL_SECTION_NESTING )                   \
102     {                                                                           \
103         /* Decrement the nesting count as we are leaving a critical section. */ \
104         usCriticalNesting--;                                                    \
105                                                                                 \
106         /* If the nesting level has reached zero then interrupts should be */   \
107         /* re-enabled. */                                                       \
108         if( usCriticalNesting == portNO_CRITICAL_SECTION_NESTING )              \
109         {                                                                       \
110             portENABLE_INTERRUPTS();                                            \
111         }                                                                       \
112     }                                                                           \
113 }
114 /*-----------------------------------------------------------*/
115 
116 /* Task utilities. */
117 
118 /*
119  * Manual context switch called by portYIELD or taskYIELD.
120  */
121 extern void vPortYield( void );
122 #define portYIELD() vPortYield()
123 /*-----------------------------------------------------------*/
124 
125 /* Hardware specifics. */
126 #define portBYTE_ALIGNMENT          2
127 #define portSTACK_GROWTH            ( -1 )
128 #define portTICK_PERIOD_MS          ( ( TickType_t ) 1000 / configTICK_RATE_HZ )
129 #define portNOP()                   __no_operation()
130 /*-----------------------------------------------------------*/
131 
132 /* Task function macros as described on the FreeRTOS.org WEB site. */
133 #define portTASK_FUNCTION_PROTO( vFunction, pvParameters ) void vFunction( void *pvParameters )
134 #define portTASK_FUNCTION( vFunction, pvParameters ) void vFunction( void *pvParameters )
135 
136 #define portYIELD_FROM_ISR( x ) do { if( x ) vPortYield(); } while( 0 )
137 
138 void vApplicationSetupTimerInterrupt( void );
139 
140 /* sizeof( int ) != sizeof( long ) so a full printf() library is required if
141 run time stats information is to be displayed. */
142 #define portLU_PRINTF_SPECIFIER_REQUIRED
143 
144 #endif /* PORTMACRO_H */
145