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 69 /* 32-bit tick type on a 32-bit architecture, so reads of the tick count do 70 * not need to be guarded with a critical section. */ 71 #define portTICK_TYPE_IS_ATOMIC 1 72 #else 73 #error configTICK_TYPE_WIDTH_IN_BITS set to unsupported tick type width. 74 #endif 75 /*-----------------------------------------------------------*/ 76 77 /* Architecture specifics. */ 78 #define portSTACK_GROWTH ( -1 ) 79 #define portTICK_PERIOD_MS ( ( TickType_t ) 1000 / configTICK_RATE_HZ ) 80 #define portBYTE_ALIGNMENT 8 81 82 /*-----------------------------------------------------------*/ 83 84 /* Compiler directives. */ 85 #define portWEAK_SYMBOL __attribute__( ( weak ) ) 86 87 /*-----------------------------------------------------------*/ 88 89 /* Scheduler utilities. */ 90 #define portYIELD() \ 91 { \ 92 /* Set a PendSV to request a context switch. */ \ 93 portNVIC_INT_CTRL_REG = portNVIC_PENDSVSET_BIT; \ 94 __asm( " dsb"); \ 95 __asm( " isb"); \ 96 } 97 98 #define portNVIC_INT_CTRL_REG ( *( ( volatile uint32_t * ) 0xe000ed04 ) ) 99 #define portNVIC_PENDSVSET_BIT ( 1UL << 28UL ) 100 #define portEND_SWITCHING_ISR( xSwitchRequired ) \ 101 do \ 102 { \ 103 if( xSwitchRequired != pdFALSE ) \ 104 { \ 105 traceISR_EXIT_TO_SCHEDULER(); \ 106 portYIELD(); \ 107 } \ 108 else \ 109 { \ 110 traceISR_EXIT(); \ 111 } \ 112 } while( 0 ) 113 #define portYIELD_FROM_ISR( x ) portEND_SWITCHING_ISR( x ) 114 115 /*-----------------------------------------------------------*/ 116 117 /* Architecture specific optimisations. */ 118 #ifndef configUSE_PORT_OPTIMISED_TASK_SELECTION 119 #define configUSE_PORT_OPTIMISED_TASK_SELECTION 1 120 #endif 121 122 #if configUSE_PORT_OPTIMISED_TASK_SELECTION == 1 123 124 /* Check the configuration. */ 125 #if ( configMAX_PRIORITIES > 32 ) 126 #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. 127 #endif 128 129 /* Store/clear the ready priorities in a bit map. */ 130 #define portRECORD_READY_PRIORITY( uxPriority, uxReadyPriorities ) ( uxReadyPriorities ) |= ( 1UL << ( uxPriority ) ) 131 #define portRESET_READY_PRIORITY( uxPriority, uxReadyPriorities ) ( uxReadyPriorities ) &= ~( 1UL << ( uxPriority ) ) 132 133 /*-----------------------------------------------------------*/ 134 135 #define portGET_HIGHEST_PRIORITY( uxTopPriority, uxReadyPriorities ) uxTopPriority = ( 31 - __clz( ( uxReadyPriorities ) ) ) 136 137 #endif /* configUSE_PORT_OPTIMISED_TASK_SELECTION */ 138 /*-----------------------------------------------------------*/ 139 140 /* Critical section management. */ 141 extern void vPortEnterCritical( void ); 142 extern void vPortExitCritical( void ); 143 144 #define portDISABLE_INTERRUPTS() \ 145 { \ 146 _set_interrupt_priority( configMAX_SYSCALL_INTERRUPT_PRIORITY ); \ 147 __asm( " dsb"); \ 148 __asm( " isb"); \ 149 } 150 151 #define portENABLE_INTERRUPTS() _set_interrupt_priority( 0 ) 152 #define portENTER_CRITICAL() vPortEnterCritical() 153 #define portEXIT_CRITICAL() vPortExitCritical() 154 #define portSET_INTERRUPT_MASK_FROM_ISR() _set_interrupt_priority( configMAX_SYSCALL_INTERRUPT_PRIORITY ); __asm( " dsb" ); __asm( " isb") 155 #define portCLEAR_INTERRUPT_MASK_FROM_ISR( x ) _set_interrupt_priority( x ) 156 /*-----------------------------------------------------------*/ 157 158 /* Tickless idle/low power functionality. */ 159 #ifndef portSUPPRESS_TICKS_AND_SLEEP 160 extern void vPortSuppressTicksAndSleep( TickType_t xExpectedIdleTime ); 161 #define portSUPPRESS_TICKS_AND_SLEEP( xExpectedIdleTime ) vPortSuppressTicksAndSleep( xExpectedIdleTime ) 162 #endif 163 164 /*-----------------------------------------------------------*/ 165 166 /* Task function macros as described on the FreeRTOS.org WEB site. These are 167 * not necessary for to use this port. They are defined so the common demo files 168 * (which build with all the ports) will build. */ 169 #define portTASK_FUNCTION_PROTO( vFunction, pvParameters ) void vFunction( void * pvParameters ) 170 #define portTASK_FUNCTION( vFunction, pvParameters ) void vFunction( void * pvParameters ) 171 /*-----------------------------------------------------------*/ 172 173 #ifdef configASSERT 174 void vPortValidateInterruptPriority( void ); 175 #define portASSERT_IF_INTERRUPT_PRIORITY_INVALID() vPortValidateInterruptPriority() 176 #endif 177 178 /* portNOP() is not required by this port. */ 179 #define portNOP() 180 181 /*-----------------------------------------------------------*/ 182 183 /* *INDENT-OFF* */ 184 #ifdef __cplusplus 185 } 186 #endif 187 /* *INDENT-ON* */ 188 189 #endif /* PORTMACRO_H */ 190
