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 /* *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 /* When the FIT configurator or the Smart Configurator is used, platform.h has to be 49 * used. */ 50 #ifndef configINCLUDE_PLATFORM_H_INSTEAD_OF_IODEFINE_H 51 #define configINCLUDE_PLATFORM_H_INSTEAD_OF_IODEFINE_H 0 52 #endif 53 54 /* Type definitions - these are a bit legacy and not really used now, other than 55 portSTACK_TYPE and portBASE_TYPE. */ 56 #define portCHAR char 57 #define portFLOAT float 58 #define portDOUBLE double 59 #define portLONG long 60 #define portSHORT short 61 #define portSTACK_TYPE uint32_t 62 #define portBASE_TYPE long 63 64 typedef portSTACK_TYPE StackType_t; 65 typedef long BaseType_t; 66 typedef unsigned long UBaseType_t; 67 68 #if( configTICK_TYPE_WIDTH_IN_BITS == TICK_TYPE_WIDTH_16_BITS ) 69 typedef uint16_t TickType_t; 70 #define portMAX_DELAY ( TickType_t ) 0xffff 71 #elif ( configTICK_TYPE_WIDTH_IN_BITS == TICK_TYPE_WIDTH_32_BITS ) 72 typedef uint32_t TickType_t; 73 #define portMAX_DELAY ( TickType_t ) 0xffffffffUL 74 75 /* 32-bit tick type on a 32-bit architecture, so reads of the tick count do 76 not need to be guarded with a critical section. */ 77 #define portTICK_TYPE_IS_ATOMIC 1 78 #else 79 #error configTICK_TYPE_WIDTH_IN_BITS set to unsupported tick type width. 80 #endif 81 /*-----------------------------------------------------------*/ 82 83 /* Hardware specifics. */ 84 #define portBYTE_ALIGNMENT 8 /* Could make four, according to manual. */ 85 #define portSTACK_GROWTH -1 86 #define portTICK_PERIOD_MS ( ( TickType_t ) 1000 / configTICK_RATE_HZ ) 87 #define portNOP() __asm volatile( "NOP" ) 88 89 /* Save clobbered register, set ITU SWINR (at address 0x872E0), read the value 90 back to ensure it is set before continuing, then restore the clobbered 91 register. */ 92 #define portYIELD() \ 93 __asm volatile \ 94 ( \ 95 "MOV.L #0x872E0, r5 \n\t" \ 96 "MOV.B #1, [r5] \n\t" \ 97 "MOV.L [r5], r5 \n\t" \ 98 ::: "r5" \ 99 ) 100 101 #define portYIELD_FROM_ISR( x ) do { if( x != pdFALSE ) { portYIELD(); } } while( 0 ) 102 103 /* These macros should not be called directly, but through the 104 taskENTER_CRITICAL() and taskEXIT_CRITICAL() macros. An extra check is 105 performed if configASSERT() is defined to ensure an assertion handler does not 106 inadvertently attempt to lower the IPL when the call to assert was triggered 107 because the IPL value was found to be above configMAX_SYSCALL_INTERRUPT_PRIORITY 108 when an ISR safe FreeRTOS API function was executed. ISR safe FreeRTOS API 109 functions are those that end in FromISR. FreeRTOS maintains a separate 110 interrupt API to ensure API function and interrupt entry is as fast and as 111 simple as possible. */ 112 #define portENABLE_INTERRUPTS() __asm volatile ( "MVTIPL #0" ) 113 #ifdef configASSERT 114 #define portASSERT_IF_INTERRUPT_PRIORITY_INVALID() configASSERT( ( ulPortGetIPL() <= configMAX_SYSCALL_INTERRUPT_PRIORITY ) ) 115 #define portDISABLE_INTERRUPTS() if( ulPortGetIPL() < configMAX_SYSCALL_INTERRUPT_PRIORITY ) __asm volatile ( "MVTIPL %0" ::"i"(configMAX_SYSCALL_INTERRUPT_PRIORITY) ) 116 #else 117 #define portDISABLE_INTERRUPTS() __asm volatile ( "MVTIPL %0" ::"i"(configMAX_SYSCALL_INTERRUPT_PRIORITY) ) 118 #endif 119 120 /* Critical nesting counts are stored in the TCB. */ 121 #define portCRITICAL_NESTING_IN_TCB ( 1 ) 122 123 /* The critical nesting functions defined within tasks.c. */ 124 extern void vTaskEnterCritical( void ); 125 extern void vTaskExitCritical( void ); 126 #define portENTER_CRITICAL() vTaskEnterCritical() 127 #define portEXIT_CRITICAL() vTaskExitCritical() 128 129 /* As this port allows interrupt nesting... */ 130 uint32_t ulPortGetIPL( void ) __attribute__((naked)); 131 void vPortSetIPL( uint32_t ulNewIPL ) __attribute__((naked)); 132 #define portSET_INTERRUPT_MASK_FROM_ISR() ulPortGetIPL(); portDISABLE_INTERRUPTS() 133 #define portCLEAR_INTERRUPT_MASK_FROM_ISR( uxSavedInterruptStatus ) vPortSetIPL( uxSavedInterruptStatus ) 134 135 /* Tickless idle/low power functionality. */ 136 #if configUSE_TICKLESS_IDLE == 1 137 #ifndef portSUPPRESS_TICKS_AND_SLEEP 138 extern void vPortSuppressTicksAndSleep( TickType_t xExpectedIdleTime ); 139 #define portSUPPRESS_TICKS_AND_SLEEP( xExpectedIdleTime ) vPortSuppressTicksAndSleep( xExpectedIdleTime ) 140 #endif 141 #endif 142 143 /*-----------------------------------------------------------*/ 144 145 /* Task function macros as described on the FreeRTOS.org WEB site. */ 146 #define portTASK_FUNCTION_PROTO( vFunction, pvParameters ) void vFunction( void *pvParameters ) 147 #define portTASK_FUNCTION( vFunction, pvParameters ) void vFunction( void *pvParameters ) 148 149 /* *INDENT-OFF* */ 150 #ifdef __cplusplus 151 } 152 #endif 153 /* *INDENT-ON* */ 154 155 #endif /* PORTMACRO_H */ 156
