1 /* 2 * FreeRTOS Kernel V11.0.1 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 #ifndef PORTMACRO_H 30 #define PORTMACRO_H 31 32 #ifdef WIN32_LEAN_AND_MEAN 33 #include <winsock2.h> 34 #else 35 #include <winsock.h> 36 #endif 37 38 #include <windows.h> 39 #include <timeapi.h> 40 #include <mmsystem.h> 41 #include <winbase.h> 42 43 /****************************************************************************** 44 * Defines 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 size_t 53 #define portPOINTER_SIZE_TYPE size_t 54 55 typedef portSTACK_TYPE StackType_t; 56 57 #if defined( __x86_64__ ) || defined( _M_X64 ) 58 #define portBASE_TYPE long long 59 typedef long long BaseType_t; 60 typedef unsigned long long UBaseType_t; 61 #else 62 #define portBASE_TYPE long 63 typedef long BaseType_t; 64 typedef unsigned long UBaseType_t; 65 #endif 66 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/64-bit tick type on a 32/64-bit architecture, so reads of the tick 76 * count do 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 /* Hardware specifics. */ 83 #define portSTACK_GROWTH ( -1 ) 84 #define portTICK_PERIOD_MS ( ( TickType_t ) 1000 / configTICK_RATE_HZ ) 85 #define portINLINE __inline 86 87 #if defined( __x86_64__ ) || defined( _M_X64 ) 88 #define portBYTE_ALIGNMENT 8 89 #else 90 #define portBYTE_ALIGNMENT 4 91 #endif 92 93 #define portYIELD() vPortGenerateSimulatedInterrupt( portINTERRUPT_YIELD ) 94 95 96 extern volatile BaseType_t xInsideInterrupt; 97 #define portSOFTWARE_BARRIER() while( xInsideInterrupt != pdFALSE ) 98 99 100 /* Simulated interrupts return pdFALSE if no context switch should be performed, 101 * or a non-zero number if a context switch should be performed. */ 102 #define portYIELD_FROM_ISR( x ) ( void ) x 103 #define portEND_SWITCHING_ISR( x ) portYIELD_FROM_ISR( ( x ) ) 104 105 void vPortCloseRunningThread( void * pvTaskToDelete, 106 volatile BaseType_t * pxPendYield ); 107 void vPortDeleteThread( void * pvThreadToDelete ); 108 #define portCLEAN_UP_TCB( pxTCB ) vPortDeleteThread( pxTCB ) 109 #define portPRE_TASK_DELETE_HOOK( pvTaskToDelete, pxPendYield ) vPortCloseRunningThread( ( pvTaskToDelete ), ( pxPendYield ) ) 110 #define portDISABLE_INTERRUPTS() vPortEnterCritical() 111 #define portENABLE_INTERRUPTS() vPortExitCritical() 112 113 /* Critical section handling. */ 114 void vPortEnterCritical( void ); 115 void vPortExitCritical( void ); 116 117 #define portENTER_CRITICAL() vPortEnterCritical() 118 #define portEXIT_CRITICAL() vPortExitCritical() 119 120 #ifndef configUSE_PORT_OPTIMISED_TASK_SELECTION 121 #define configUSE_PORT_OPTIMISED_TASK_SELECTION 1 122 #endif 123 124 #if configUSE_PORT_OPTIMISED_TASK_SELECTION == 1 125 126 /* Check the configuration. */ 127 #if ( configMAX_PRIORITIES > 32 ) 128 #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. 129 #endif 130 131 /* Store/clear the ready priorities in a bit map. */ 132 #define portRECORD_READY_PRIORITY( uxPriority, uxReadyPriorities ) ( uxReadyPriorities ) |= ( 1UL << ( uxPriority ) ) 133 #define portRESET_READY_PRIORITY( uxPriority, uxReadyPriorities ) ( uxReadyPriorities ) &= ~( 1UL << ( uxPriority ) ) 134 135 136 /*-----------------------------------------------------------*/ 137 138 #ifdef __GNUC__ 139 #define portGET_HIGHEST_PRIORITY( uxTopPriority, uxReadyPriorities ) \ 140 __asm volatile ( "bsr %1, %0\n\t" \ 141 : "=r" ( uxTopPriority ) : "rm" ( uxReadyPriorities ) : "cc" ) 142 #else 143 144 /* BitScanReverse returns the bit position of the most significant '1' 145 * in the word. */ 146 #define portGET_HIGHEST_PRIORITY( uxTopPriority, uxReadyPriorities ) _BitScanReverse( ( DWORD * ) &( uxTopPriority ), ( uxReadyPriorities ) ) 147 #endif /* __GNUC__ */ 148 149 #endif /* taskRECORD_READY_PRIORITY */ 150 151 #ifndef __GNUC__ 152 __pragma( warning( disable:4211 ) ) /* Nonstandard extension used, as extern is only nonstandard to MSVC. */ 153 #endif 154 155 156 /* Task function macros as described on the FreeRTOS.org WEB site. */ 157 #define portTASK_FUNCTION_PROTO( vFunction, pvParameters ) void vFunction( void * pvParameters ) 158 #define portTASK_FUNCTION( vFunction, pvParameters ) void vFunction( void * pvParameters ) 159 160 #define portINTERRUPT_YIELD ( 0UL ) 161 #define portINTERRUPT_TICK ( 1UL ) 162 163 /* 164 * Raise a simulated interrupt represented by the bit mask in ulInterruptMask. 165 * Each bit can be used to represent an individual interrupt - with the first 166 * two bits being used for the Yield and Tick interrupts respectively. 167 */ 168 void vPortGenerateSimulatedInterrupt( uint32_t ulInterruptNumber ); 169 170 /* 171 * Install an interrupt handler to be called by the simulated interrupt handler 172 * thread. The interrupt number must be above any used by the kernel itself 173 * (at the time of writing the kernel was using interrupt numbers 0, 1, and 2 174 * as defined above). The number must also be lower than 32. 175 * 176 * Interrupt handler functions must return a non-zero value if executing the 177 * handler resulted in a task switch being required. 178 */ 179 void vPortSetInterruptHandler( uint32_t ulInterruptNumber, 180 uint32_t ( * pvHandler )( void ) ); 181 182 #endif /* ifndef PORTMACRO_H */ 183
