GM6000 Digital Heater Controller Branch: main
SDX-1330
portmacro.h
1/*
2 * FreeRTOS Kernel V10.0.0
3 * Copyright (C) 2017 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. If you wish to use our Amazon
14 * FreeRTOS name, please do so in a fair use way that does not cause confusion.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
18 * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
19 * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
20 * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
21 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
22 *
23 * http://www.FreeRTOS.org
24 * http://aws.amazon.com/freertos
25 *
26 * 1 tab == 4 spaces!
27 */
28
29#ifndef PORTMACRO_H
30#define PORTMACRO_H
31
32#ifdef __cplusplus
33extern "C" {
34#endif
35
36/*-----------------------------------------------------------
37 * Port specific definitions.
38 *
39 * The settings in this file configure FreeRTOS correctly for the
40 * given hardware and compiler.
41 *
42 * These settings should not be altered.
43 *-----------------------------------------------------------
44 */
45
46/* Type definitions. */
47#define portCHAR char
48#define portFLOAT float
49#define portDOUBLE double
50#define portLONG long
51#define portSHORT short
52#define portSTACK_TYPE uint32_t
53#define portBASE_TYPE long
54
55typedef portSTACK_TYPE StackType_t;
56typedef long BaseType_t;
57typedef unsigned long UBaseType_t;
58
59#if (configUSE_16_BIT_TICKS == 1)
60typedef uint16_t TickType_t;
61#define portMAX_DELAY (TickType_t)0xffff
62#else
63typedef uint32_t TickType_t;
64#define portMAX_DELAY (TickType_t)0xffffffffUL
65
66/* 32-bit tick type on a 32-bit architecture, so reads of the tick count do
67not need to be guarded with a critical section. */
68#define portTICK_TYPE_IS_ATOMIC 1
69#endif
70/*-----------------------------------------------------------*/
71
72/* Architecture specifics. */
73#define portSTACK_GROWTH (-1)
74#define portTICK_PERIOD_MS ((TickType_t)1000 / configTICK_RATE_HZ)
75#define portBYTE_ALIGNMENT 8
76/*-----------------------------------------------------------*/
77
78/* Scheduler utilities. */
79#define portYIELD() \
80 { \
81 /* Set a PendSV to request a context switch. */ \
82 portNVIC_INT_CTRL_REG = portNVIC_PENDSVSET_BIT; \
83 \
84 /* Barriers are normally not required but do ensure the code is completely \
85 within the specified behaviour for the architecture. */ \
86 __asm volatile("dsb" ::: "memory"); \
87 __asm volatile("isb"); \
88 }
89
90#define portNVIC_INT_CTRL_REG (*((volatile uint32_t *)0xe000ed04))
91#define portNVIC_PENDSVSET_BIT (1UL << 28UL)
92#define portEND_SWITCHING_ISR(xSwitchRequired) \
93 if (xSwitchRequired != pdFALSE) \
94 portYIELD()
95#define portYIELD_FROM_ISR(x) portEND_SWITCHING_ISR(x)
96/*-----------------------------------------------------------*/
97
98/* Critical section management. */
99extern void vPortEnterCritical(void);
100extern void vPortExitCritical(void);
101#define portSET_INTERRUPT_MASK_FROM_ISR() ulPortRaiseBASEPRI()
102#define portCLEAR_INTERRUPT_MASK_FROM_ISR(x) vPortSetBASEPRI(x)
103#define portDISABLE_INTERRUPTS() vPortRaiseBASEPRI()
104#define portENABLE_INTERRUPTS() vPortSetBASEPRI(0)
105#define portENTER_CRITICAL() vPortEnterCritical()
106#define portEXIT_CRITICAL() vPortExitCritical()
107
108/*-----------------------------------------------------------*/
109
110/* Task function macros as described on the FreeRTOS.org WEB site. These are
111not necessary for to use this port. They are defined so the common demo files
112(which build with all the ports) will build. */
113#define portTASK_FUNCTION_PROTO(vFunction, pvParameters) void vFunction(void *pvParameters)
114#define portTASK_FUNCTION(vFunction, pvParameters) void vFunction(void *pvParameters)
115/*-----------------------------------------------------------*/
116
117/* Tickless idle/low power functionality. */
118#ifndef portSUPPRESS_TICKS_AND_SLEEP
119extern void vPortSuppressTicksAndSleep(TickType_t xExpectedIdleTime);
120#define portSUPPRESS_TICKS_AND_SLEEP(xExpectedIdleTime) vPortSuppressTicksAndSleep(xExpectedIdleTime)
121#endif
122/*-----------------------------------------------------------*/
123
124/* Architecture specific optimisations. */
125#ifndef configUSE_PORT_OPTIMISED_TASK_SELECTION
126#define configUSE_PORT_OPTIMISED_TASK_SELECTION 1
127#endif
128
129#if configUSE_PORT_OPTIMISED_TASK_SELECTION == 1
130
131/* Generic helper function. */
132__attribute__((always_inline)) static inline uint8_t ucPortCountLeadingZeros(uint32_t ulBitmap)
133{
134 uint8_t ucReturn;
135
136 __asm volatile("clz %0, %1" : "=r"(ucReturn) : "r"(ulBitmap) : "memory");
137 return ucReturn;
138}
139
140/* Check the configuration. */
141#if (configMAX_PRIORITIES > 32)
142#error configUSE_PORT_OPTIMISED_TASK_SELECTION can only be set to 1 when configMAX_PRIORITIES is less than or equal to 32. It is very rare that a system requires more than 10 to 15 difference priorities as tasks that share a priority will time slice.
143#endif
144
145/* Store/clear the ready priorities in a bit map. */
146#define portRECORD_READY_PRIORITY(uxPriority, uxReadyPriorities) (uxReadyPriorities) |= (1UL << (uxPriority))
147#define portRESET_READY_PRIORITY(uxPriority, uxReadyPriorities) (uxReadyPriorities) &= ~(1UL << (uxPriority))
148
149 /*-----------------------------------------------------------*/
150
151#define portGET_HIGHEST_PRIORITY(uxTopPriority, uxReadyPriorities) \
152 uxTopPriority = (31UL - (uint32_t)ucPortCountLeadingZeros((uxReadyPriorities)))
153
154#endif /* configUSE_PORT_OPTIMISED_TASK_SELECTION */
155
156 /*-----------------------------------------------------------*/
157
158#ifdef configASSERT
159void vPortValidateInterruptPriority(void);
160#define portASSERT_IF_INTERRUPT_PRIORITY_INVALID() vPortValidateInterruptPriority()
161#endif
162
163/* portNOP() is not required by this port. */
164#define portNOP()
165
166#define portINLINE __inline
167
168#ifndef portFORCE_INLINE
169#define portFORCE_INLINE inline __attribute__((always_inline))
170#endif
171
172portFORCE_INLINE static BaseType_t xPortIsInsideInterrupt(void)
173{
174 uint32_t ulCurrentInterrupt;
175 BaseType_t xReturn;
176
177 /* Obtain the number of the currently executing interrupt. */
178 __asm volatile("mrs %0, ipsr" : "=r"(ulCurrentInterrupt)::"memory");
179
180 if (ulCurrentInterrupt == 0) {
181 xReturn = pdFALSE;
182 } else {
183 xReturn = pdTRUE;
184 }
185
186 return xReturn;
187}
188
189/*-----------------------------------------------------------*/
190
191portFORCE_INLINE static void vPortRaiseBASEPRI(void)
192{
193 uint32_t ulNewBASEPRI;
194
195 __asm volatile(" mov %0, %1 \n"
196 " msr basepri, %0 \n"
197 " isb \n"
198 " dsb \n"
199 : "=r"(ulNewBASEPRI)
200 : "i"(configMAX_SYSCALL_INTERRUPT_PRIORITY)
201 : "memory");
202}
203
204/*-----------------------------------------------------------*/
205
206portFORCE_INLINE static uint32_t ulPortRaiseBASEPRI(void)
207{
208 uint32_t ulOriginalBASEPRI, ulNewBASEPRI;
209
210 __asm volatile(" mrs %0, basepri \n"
211 " mov %1, %2 \n"
212 " msr basepri, %1 \n"
213 " isb \n"
214 " dsb \n"
215 : "=r"(ulOriginalBASEPRI), "=r"(ulNewBASEPRI)
216 : "i"(configMAX_SYSCALL_INTERRUPT_PRIORITY)
217 : "memory");
218
219 /* This return will not be reached but is necessary to prevent compiler
220 warnings. */
221 return ulOriginalBASEPRI;
222}
223/*-----------------------------------------------------------*/
224
225portFORCE_INLINE static void vPortSetBASEPRI(uint32_t ulNewMaskValue)
226{
227 __asm volatile(" msr basepri, %0 " ::"r"(ulNewMaskValue) : "memory");
228}
229 /*-----------------------------------------------------------*/
230
231#ifdef __cplusplus
232}
233#endif
234
235#endif /* PORTMACRO_H */
Generated on Sat Jan 18 2025 22:23:55 for GM6000 Digital Heater Controller by doxygen 1.9.8