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 /* When the FIT configurator or the Smart Configurator is used, platform.h has to be 50 * used. */ 51 #ifndef configINCLUDE_PLATFORM_H_INSTEAD_OF_IODEFINE_H 52 #define configINCLUDE_PLATFORM_H_INSTEAD_OF_IODEFINE_H 0 53 #endif 54 55 /* If configUSE_TASK_DPFPU_SUPPORT is set to 1 (or undefined) then each task will 56 * be created without a DPFPU context, and a task must call vTaskUsesDPFPU() before 57 * making use of any DPFPU registers. If configUSE_TASK_DPFPU_SUPPORT is set to 2 then 58 * tasks are created with a DPFPU context by default, and calling vTaskUsesDPFPU() has 59 * no effect. If configUSE_TASK_DPFPU_SUPPORT is set to 0 then tasks never take care 60 * of any DPFPU context (even if DPFPU registers are used). */ 61 #ifndef configUSE_TASK_DPFPU_SUPPORT 62 #define configUSE_TASK_DPFPU_SUPPORT 1 63 #endif 64 65 /*-----------------------------------------------------------*/ 66 67 /* Type definitions - these are a bit legacy and not really used now, other than 68 * portSTACK_TYPE and portBASE_TYPE. */ 69 #define portCHAR char 70 #define portFLOAT float 71 #define portDOUBLE double 72 #define portLONG long 73 #define portSHORT short 74 #define portSTACK_TYPE uint32_t 75 #define portBASE_TYPE long 76 77 typedef portSTACK_TYPE StackType_t; 78 typedef long BaseType_t; 79 typedef unsigned long UBaseType_t; 80 81 #if ( configTICK_TYPE_WIDTH_IN_BITS == TICK_TYPE_WIDTH_16_BITS ) 82 typedef uint16_t TickType_t; 83 #define portMAX_DELAY ( TickType_t ) 0xffff 84 #elif ( configTICK_TYPE_WIDTH_IN_BITS == TICK_TYPE_WIDTH_32_BITS ) 85 typedef uint32_t TickType_t; 86 #define portMAX_DELAY ( TickType_t ) 0xffffffffUL 87 88 /* 32-bit tick type on a 32-bit architecture, so reads of the tick count do 89 * not need to be guarded with a critical section. */ 90 #define portTICK_TYPE_IS_ATOMIC 1 91 #else 92 #error configTICK_TYPE_WIDTH_IN_BITS set to unsupported tick type width. 93 #endif 94 95 /*-----------------------------------------------------------*/ 96 97 /* Hardware specifics. */ 98 #define portBYTE_ALIGNMENT 8 /* Could make four, according to manual. */ 99 #define portSTACK_GROWTH -1 100 #define portTICK_PERIOD_MS ( ( TickType_t ) 1000 / configTICK_RATE_HZ ) 101 #define portNOP() __asm volatile ( "NOP" ) 102 103 /* Yield equivalent to "*portITU_SWINTR = 0x01; ( void ) *portITU_SWINTR;" 104 * where portITU_SWINTR is the location of the software interrupt register 105 * (0x000872E0). Don't rely on the assembler to select a register, so instead 106 * save and restore clobbered registers manually. */ 107 #define portYIELD() \ 108 __asm volatile \ 109 ( \ 110 "PUSH.L R10 \n" \ 111 "MOV.L #0x872E0, R10 \n" \ 112 "MOV.B #0x1, [R10] \n" \ 113 "CMP [R10].UB, R10 \n" \ 114 "POP R10 \n" \ 115 ::: "cc" \ 116 ) 117 118 #define portYIELD_FROM_ISR( x ) do { if( ( x ) != pdFALSE ) portYIELD( ); } while( 0 ) 119 120 /* Workaround to reduce errors/warnings caused by e2 studio CDT's INDEXER and CODAN. */ 121 #ifdef __CDT_PARSER__ 122 #ifndef __asm 123 #define __asm asm 124 #endif 125 #ifndef __attribute__ 126 #define __attribute__( ... ) 127 #endif 128 #endif 129 130 /* These macros should not be called directly, but through the 131 * taskENTER_CRITICAL() and taskEXIT_CRITICAL() macros. An extra check is 132 * performed if configASSERT() is defined to ensure an assertion handler does not 133 * inadvertently attempt to lower the IPL when the call to assert was triggered 134 * because the IPL value was found to be above configMAX_SYSCALL_INTERRUPT_PRIORITY 135 * when an ISR safe FreeRTOS API function was executed. ISR safe FreeRTOS API 136 * functions are those that end in FromISR. FreeRTOS maintains a separate 137 * interrupt API to ensure API function and interrupt entry is as fast and as 138 * simple as possible. */ 139 #define portENABLE_INTERRUPTS() __asm volatile ( "MVTIPL #0" ) 140 #ifdef configASSERT 141 #define portASSERT_IF_INTERRUPT_PRIORITY_INVALID() configASSERT( ( ulPortGetIPL() <= configMAX_SYSCALL_INTERRUPT_PRIORITY ) ) 142 #define portDISABLE_INTERRUPTS() if( ulPortGetIPL() < configMAX_SYSCALL_INTERRUPT_PRIORITY ) __asm volatile( "MVTIPL %0" ::"i" ( configMAX_SYSCALL_INTERRUPT_PRIORITY ) ) 143 #else 144 #define portDISABLE_INTERRUPTS() __asm volatile ( "MVTIPL %0" ::"i" ( configMAX_SYSCALL_INTERRUPT_PRIORITY ) ) 145 #endif 146 147 /* Critical nesting counts are stored in the TCB. */ 148 #define portCRITICAL_NESTING_IN_TCB ( 1 ) 149 150 /* The critical nesting functions defined within tasks.c. */ 151 extern void vTaskEnterCritical( void ); 152 extern void vTaskExitCritical( void ); 153 #define portENTER_CRITICAL() vTaskEnterCritical() 154 #define portEXIT_CRITICAL() vTaskExitCritical() 155 156 /* As this port allows interrupt nesting... */ 157 uint32_t ulPortGetIPL( void ) __attribute__( ( naked ) ); 158 void vPortSetIPL( uint32_t ulNewIPL ) __attribute__( ( naked ) ); 159 #define portSET_INTERRUPT_MASK_FROM_ISR() ulPortGetIPL(); portDISABLE_INTERRUPTS() 160 #define portCLEAR_INTERRUPT_MASK_FROM_ISR( uxSavedInterruptStatus ) vPortSetIPL( uxSavedInterruptStatus ) 161 162 /*-----------------------------------------------------------*/ 163 164 /* Task function macros as described on the FreeRTOS.org WEB site. */ 165 #define portTASK_FUNCTION_PROTO( vFunction, pvParameters ) void vFunction( void * pvParameters ) 166 #define portTASK_FUNCTION( vFunction, pvParameters ) void vFunction( void * pvParameters ) 167 168 /*-----------------------------------------------------------*/ 169 170 /* If configUSE_TASK_DPFPU_SUPPORT is set to 1 (or left undefined) then tasks are 171 * created without a DPFPU context and must call vPortTaskUsesDPFPU() to give 172 * themselves a DPFPU context before using any DPFPU instructions. If 173 * configUSE_TASK_DPFPU_SUPPORT is set to 2 then all tasks will have a DPFPU context 174 * by default. */ 175 #if ( configUSE_TASK_DPFPU_SUPPORT == 1 ) 176 void vPortTaskUsesDPFPU( void ); 177 #else 178 179 /* Each task has a DPFPU context already, so define this function away to 180 * nothing to prevent it being called accidentally. */ 181 #define vPortTaskUsesDPFPU() 182 #endif 183 #define portTASK_USES_DPFPU() vPortTaskUsesDPFPU() 184 185 /* Definition to allow compatibility with existing FreeRTOS Demo using flop.c. */ 186 #define portTASK_USES_FLOATING_POINT() vPortTaskUsesDPFPU() 187 188 #define portMEMORY_BARRIER() __asm volatile ( "" ::: "memory" ) 189 190 /* *INDENT-OFF* */ 191 #ifdef __cplusplus 192 } 193 #endif 194 /* *INDENT-ON* */ 195 196 #endif /* PORTMACRO_H */ 197
