1 /* 2 * FreeRTOS Kernel V10.2.0 3 * Copyright (C) 2019 Amazon.com, Inc. or its affiliates. All Rights Reserved. 4 * 5 * Permission is hereby granted, free of charge, to any person obtaining a copy of 6 * this software and associated documentation files (the "Software"), to deal in 7 * the Software without restriction, including without limitation the rights to 8 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of 9 * the Software, and to permit persons to whom the Software is furnished to do so, 10 * subject to the following conditions: 11 * 12 * The above copyright notice and this permission notice shall be included in all 13 * copies or substantial portions of the Software. 14 * 15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS 17 * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR 18 * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER 19 * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN 20 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 21 * 22 * http://www.FreeRTOS.org 23 * http://aws.amazon.com/freertos 24 * 25 * 1 tab == 4 spaces! 26 */ 27 28 29 #ifndef PORTMACRO_H 30 #define PORTMACRO_H 31 32 #ifdef __cplusplus 33 extern "C" { 34 #endif 35 36 /*----------------------------------------------------------- 37 * Port specific definitions. 38 * 39 * The settings in this file configure FreeRTOS correctly for the 40 * given hardware and compiler. 41 * 42 * These settings should not be altered. 43 *----------------------------------------------------------- 44 */ 45 46 /* Type definitions. */ 47 #define portCHAR char 48 #define portFLOAT float 49 #define portDOUBLE double 50 #define portLONG long 51 #define portSHORT short 52 #define portSTACK_TYPE uint32_t 53 #define portBASE_TYPE long 54 55 typedef portSTACK_TYPE StackType_t; 56 typedef long BaseType_t; 57 typedef unsigned long UBaseType_t; 58 59 #if( configUSE_16_BIT_TICKS == 1 ) 60 typedef uint16_t TickType_t; 61 #define portMAX_DELAY ( TickType_t ) 0xffff 62 #else 63 typedef uint32_t TickType_t; 64 #define portMAX_DELAY ( TickType_t ) 0xffffffffUL 65 #endif 66 /*-----------------------------------------------------------*/ 67 68 /* Architecture specifics. */ 69 #define portSTACK_GROWTH ( -1 ) 70 #define portTICK_PERIOD_MS ( ( TickType_t ) 1000 / configTICK_RATE_HZ ) 71 #define portBYTE_ALIGNMENT 8 72 /*-----------------------------------------------------------*/ 73 74 75 /* Scheduler utilities. */ 76 extern void vPortYield( void ); 77 #define portNVIC_INT_CTRL_REG ( * ( ( volatile uint32_t * ) 0xe000ed04 ) ) 78 #define portNVIC_PENDSVSET_BIT ( 1UL << 28UL ) 79 #define portYIELD() vPortYield() 80 #define portEND_SWITCHING_ISR( xSwitchRequired ) if( xSwitchRequired ) portNVIC_INT_CTRL_REG = portNVIC_PENDSVSET_BIT 81 #define portYIELD_FROM_ISR( x ) portEND_SWITCHING_ISR( x ) 82 /*-----------------------------------------------------------*/ 83 84 /* Critical section management. */ 85 extern void vPortEnterCritical( void ); 86 extern void vPortExitCritical( void ); 87 extern uint32_t ulPortSetInterruptMask( void ); 88 extern void vPortClearInterruptMask( uint32_t ulNewMaskValue ); 89 #define portSET_INTERRUPT_MASK_FROM_ISR() ulPortSetInterruptMask() 90 #define portCLEAR_INTERRUPT_MASK_FROM_ISR(x) vPortClearInterruptMask(x) 91 #define portDISABLE_INTERRUPTS() ulPortSetInterruptMask() 92 #define portENABLE_INTERRUPTS() vPortClearInterruptMask(0) 93 #define portENTER_CRITICAL() vPortEnterCritical() 94 #define portEXIT_CRITICAL() vPortExitCritical() 95 96 /*-----------------------------------------------------------*/ 97 98 /* Task function macros as described on the FreeRTOS.org WEB site. These are 99 not necessary for to use this port. They are defined so the common demo files 100 (which build with all the ports) will build. */ 101 #define portTASK_FUNCTION_PROTO( vFunction, pvParameters ) void vFunction( void *pvParameters ) 102 #define portTASK_FUNCTION( vFunction, pvParameters ) void vFunction( void *pvParameters ) 103 /*-----------------------------------------------------------*/ 104 105 /* Tickless idle/low power functionality. */ 106 #ifndef portSUPPRESS_TICKS_AND_SLEEP 107 extern void vPortSuppressTicksAndSleep( TickType_t xExpectedIdleTime ); 108 #define portSUPPRESS_TICKS_AND_SLEEP( xExpectedIdleTime ) vPortSuppressTicksAndSleep( xExpectedIdleTime ) 109 #endif 110 /*-----------------------------------------------------------*/ 111 112 /* Architecture specific optimisations. */ 113 #ifndef configUSE_PORT_OPTIMISED_TASK_SELECTION 114 #define configUSE_PORT_OPTIMISED_TASK_SELECTION 1 115 #endif 116 117 #if configUSE_PORT_OPTIMISED_TASK_SELECTION == 1 118 119 /* Generic helper function. */ ucPortCountLeadingZeros(uint32_t ulBitmap)120 __attribute__( ( always_inline ) ) static inline uint8_t ucPortCountLeadingZeros( uint32_t ulBitmap ) 121 { 122 uint8_t ucReturn; 123 124 __asm volatile ( "clz %0, %1" : "=r" ( ucReturn ) : "r" ( ulBitmap ) ); 125 return ucReturn; 126 } 127 128 /* Check the configuration. */ 129 #if( configMAX_PRIORITIES > 32 ) 130 #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. 131 #endif 132 133 /* Store/clear the ready priorities in a bit map. */ 134 #define portRECORD_READY_PRIORITY( uxPriority, uxReadyPriorities ) ( uxReadyPriorities ) |= ( 1UL << ( uxPriority ) ) 135 #define portRESET_READY_PRIORITY( uxPriority, uxReadyPriorities ) ( uxReadyPriorities ) &= ~( 1UL << ( uxPriority ) ) 136 137 /*-----------------------------------------------------------*/ 138 139 #define portGET_HIGHEST_PRIORITY( uxTopPriority, uxReadyPriorities ) uxTopPriority = ( 31 - ucPortCountLeadingZeros( ( uxReadyPriorities ) ) ) 140 141 #endif /* configUSE_PORT_OPTIMISED_TASK_SELECTION */ 142 143 /*-----------------------------------------------------------*/ 144 145 #ifdef configASSERT 146 void vPortValidateInterruptPriority( void ); 147 #define portASSERT_IF_INTERRUPT_PRIORITY_INVALID() vPortValidateInterruptPriority() 148 #endif 149 150 /* portNOP() is not required by this port. */ 151 #define portNOP() 152 153 #ifdef __cplusplus 154 } 155 #endif 156 157 #endif /* PORTMACRO_H */ 158