1 /* 2 * FreeRTOS Kernel V11.1.0 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 /* *INDENT-OFF* */ 34 #ifdef __cplusplus 35 extern "C" { 36 #endif 37 /* *INDENT-ON* */ 38 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. */ 50 #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 57 58 typedef portSTACK_TYPE StackType_t; 59 typedef long BaseType_t; 60 typedef unsigned long UBaseType_t; 61 62 #if ( configTICK_TYPE_WIDTH_IN_BITS == TICK_TYPE_WIDTH_16_BITS ) 63 typedef uint16_t TickType_t; 64 #define portMAX_DELAY ( TickType_t ) 0xffff 65 #elif ( configTICK_TYPE_WIDTH_IN_BITS == TICK_TYPE_WIDTH_32_BITS ) 66 typedef uint32_t TickType_t; 67 #define portMAX_DELAY ( TickType_t ) ( 0xFFFFFFFFUL ) 68 #else 69 #error configTICK_TYPE_WIDTH_IN_BITS set to unsupported tick type width. 70 #endif 71 /*-----------------------------------------------------------*/ 72 73 /* Hardware specifics. */ 74 #define portSTACK_GROWTH ( -1 ) 75 #define portTICK_PERIOD_MS ( ( TickType_t ) 1000 / configTICK_RATE_HZ ) 76 #define portBYTE_ALIGNMENT 8 77 #define portYIELD() asm volatile ( "SWI 0" ) 78 #define portNOP() asm volatile ( "NOP" ) 79 /*-----------------------------------------------------------*/ 80 81 /* Critical section handling. */ 82 83 /* 84 * The interrupt management utilities can only be called from ARM mode. When 85 * THUMB_INTERWORK is defined the utilities are defined as functions in 86 * portISR.c to ensure a switch to ARM mode. When THUMB_INTERWORK is not 87 * defined then the utilities are defined as macros here - as per other ports. 88 */ 89 90 #ifdef THUMB_INTERWORK 91 92 extern void vPortDisableInterruptsFromThumb( void ) __attribute__( ( naked ) ); 93 extern void vPortEnableInterruptsFromThumb( void ) __attribute__( ( naked ) ); 94 95 #define portDISABLE_INTERRUPTS() vPortDisableInterruptsFromThumb() 96 #define portENABLE_INTERRUPTS() vPortEnableInterruptsFromThumb() 97 98 #else 99 100 #define portDISABLE_INTERRUPTS() \ 101 asm volatile ( \ 102 "STMDB SP!, {R0} \n\t" /* Push R0. */ \ 103 "MRS R0, CPSR \n\t" /* Get CPSR. */ \ 104 "ORR R0, R0, #0xC0 \n\t" /* Disable IRQ, FIQ. */ \ 105 "MSR CPSR, R0 \n\t" /* Write back modified value. */ \ 106 "LDMIA SP!, {R0} " ) /* Pop R0. */ 107 108 #define portENABLE_INTERRUPTS() \ 109 asm volatile ( \ 110 "STMDB SP!, {R0} \n\t" /* Push R0. */ \ 111 "MRS R0, CPSR \n\t" /* Get CPSR. */ \ 112 "BIC R0, R0, #0xC0 \n\t" /* Enable IRQ, FIQ. */ \ 113 "MSR CPSR, R0 \n\t" /* Write back modified value. */ \ 114 "LDMIA SP!, {R0} " ) /* Pop R0. */ 115 116 #endif /* THUMB_INTERWORK */ 117 118 extern void vPortEnterCritical( void ); 119 extern void vPortExitCritical( void ); 120 121 #define portENTER_CRITICAL() vPortEnterCritical(); 122 #define portEXIT_CRITICAL() vPortExitCritical(); 123 /*-----------------------------------------------------------*/ 124 125 /* Task utilities. */ 126 #define portEND_SWITCHING_ISR( xSwitchRequired ) \ 127 { \ 128 extern void vTaskSwitchContext( void ); \ 129 \ 130 if( xSwitchRequired ) \ 131 { \ 132 traceISR_EXIT_TO_SCHEDULER(); \ 133 vTaskSwitchContext(); \ 134 } \ 135 else \ 136 { \ 137 traceISR_EXIT(); \ 138 } \ 139 } 140 /*-----------------------------------------------------------*/ 141 142 /* Task function macros as described on the FreeRTOS.org WEB site. */ 143 #define portTASK_FUNCTION_PROTO( vFunction, pvParameters ) void vFunction( void * pvParameters ) 144 #define portTASK_FUNCTION( vFunction, pvParameters ) void vFunction( void * pvParameters ) 145 146 /* *INDENT-OFF* */ 147 #ifdef __cplusplus 148 } 149 #endif 150 /* *INDENT-ON* */ 151 152 #endif /* PORTMACRO_H */ 153
