blob: 75588d526e1a228769f9604c553a8dd981aaf9af [file] [log] [blame]
Paul Bartell01820d32022-11-29 10:36:04 -08001/*
2 * FreeRTOS Kernel <DEVELOPMENT BRANCH>
Soren Ptak839ccb72024-02-26 12:26:42 -05003 * Copyright (C) 2021 Amazon.com, Inc. or its affiliates. All Rights Reserved.
Paul Bartell01820d32022-11-29 10:36:04 -08004 *
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
Paul Bartellc1980ce2023-04-20 12:46:00 -070033/* *INDENT-OFF* */
Paul Bartell01820d32022-11-29 10:36:04 -080034#ifdef __cplusplus
Paul Bartellc1980ce2023-04-20 12:46:00 -070035 extern "C" {
Paul Bartell01820d32022-11-29 10:36:04 -080036#endif
Paul Bartellc1980ce2023-04-20 12:46:00 -070037/* *INDENT-ON* */
Paul Bartell01820d32022-11-29 10:36:04 -080038
39/*-----------------------------------------------------------
40 * Port specific definitions.
41 *
42 * The settings in this file configure FreeRTOS correctly for the
43 * given hardware and compiler.
44 *
45 * These settings should not be altered.
46 *-----------------------------------------------------------
47 */
48
49/* Type definitions. */
Soren Ptak5fb9b502023-09-05 17:24:04 -040050#define portCHAR char
51#define portFLOAT float
52#define portDOUBLE double
53#define portLONG long
54#define portSHORT short
55#define portSTACK_TYPE uint32_t
56#define portBASE_TYPE long
Paul Bartell01820d32022-11-29 10:36:04 -080057
Soren Ptak5fb9b502023-09-05 17:24:04 -040058typedef portSTACK_TYPE StackType_t;
59typedef long BaseType_t;
60typedef unsigned long UBaseType_t;
Paul Bartell01820d32022-11-29 10:36:04 -080061
Soren Ptak5fb9b502023-09-05 17:24:04 -040062#if ( configTICK_TYPE_WIDTH_IN_BITS == TICK_TYPE_WIDTH_16_BITS )
63 typedef uint16_t TickType_t;
64 #define portMAX_DELAY ( TickType_t ) 0xffff
Dusan Cervenka91c20f52023-02-03 15:34:02 +010065#elif ( configTICK_TYPE_WIDTH_IN_BITS == TICK_TYPE_WIDTH_32_BITS )
Soren Ptak5fb9b502023-09-05 17:24:04 -040066 typedef uint32_t TickType_t;
67 #define portMAX_DELAY ( TickType_t ) ( 0xFFFFFFFFUL )
Dusan Cervenka91c20f52023-02-03 15:34:02 +010068#else
69 #error configTICK_TYPE_WIDTH_IN_BITS set to unsupported tick type width.
Paul Bartell01820d32022-11-29 10:36:04 -080070#endif
71/*-----------------------------------------------------------*/
72
73/* Hardware specifics. */
Soren Ptak5fb9b502023-09-05 17:24:04 -040074#define portSTACK_GROWTH ( -1 )
75#define portTICK_PERIOD_MS ( ( TickType_t ) 1000 / configTICK_RATE_HZ )
76#define portBYTE_ALIGNMENT 8
77#define portYIELD() asm ( "SWI 0" )
78#define portNOP() asm ( "NOP" )
Paul Bartell01820d32022-11-29 10:36:04 -080079/*-----------------------------------------------------------*/
80
81/* Critical section handling. */
82__arm __interwork void vPortDisableInterruptsFromThumb( void );
83__arm __interwork void vPortEnableInterruptsFromThumb( void );
84__arm __interwork void vPortEnterCritical( void );
85__arm __interwork void vPortExitCritical( void );
86
87#define portDISABLE_INTERRUPTS() __disable_interrupt()
88#define portENABLE_INTERRUPTS() __enable_interrupt()
89#define portENTER_CRITICAL() vPortEnterCritical()
90#define portEXIT_CRITICAL() vPortExitCritical()
91/*-----------------------------------------------------------*/
92
93/* Task utilities. */
Soren Ptak5fb9b502023-09-05 17:24:04 -040094#define portEND_SWITCHING_ISR( xSwitchRequired ) \
95 { \
96 extern void vTaskSwitchContext( void ); \
97 \
98 if( xSwitchRequired ) \
99 { \
Boris van der Meerd43062b2023-09-20 12:49:42 +0200100 traceISR_EXIT_TO_SCHEDULER(); \
Soren Ptak5fb9b502023-09-05 17:24:04 -0400101 vTaskSwitchContext(); \
102 } \
Boris van der Meerd43062b2023-09-20 12:49:42 +0200103 else \
104 { \
105 traceISR_EXIT(); \
106 } \
Soren Ptak5fb9b502023-09-05 17:24:04 -0400107 }
Paul Bartell01820d32022-11-29 10:36:04 -0800108/*-----------------------------------------------------------*/
109
110
111/* Task function macros as described on the FreeRTOS.org WEB site. */
Soren Ptak5fb9b502023-09-05 17:24:04 -0400112#define portTASK_FUNCTION_PROTO( vFunction, pvParameters ) void vFunction( void * pvParameters )
113#define portTASK_FUNCTION( vFunction, pvParameters ) void vFunction( void * pvParameters )
Paul Bartell01820d32022-11-29 10:36:04 -0800114
Paul Bartellc1980ce2023-04-20 12:46:00 -0700115/* *INDENT-OFF* */
Paul Bartell01820d32022-11-29 10:36:04 -0800116#ifdef __cplusplus
Paul Bartellc1980ce2023-04-20 12:46:00 -0700117 }
Paul Bartell01820d32022-11-29 10:36:04 -0800118#endif
Paul Bartellc1980ce2023-04-20 12:46:00 -0700119/* *INDENT-ON* */
Paul Bartell01820d32022-11-29 10:36:04 -0800120
121#endif /* PORTMACRO_H */