git.sur5r.net Git - freertos/blob - FreeRTOS/Source/portable/MSVC-MingW/portmacro.h

   1 /*\r
   2  * FreeRTOS Kernel V10.3.0\r
   3  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.\r
   4  *\r
   5  * Permission is hereby granted, free of charge, to any person obtaining a copy of\r
   6  * this software and associated documentation files (the "Software"), to deal in\r
   7  * the Software without restriction, including without limitation the rights to\r
   8  * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\r
   9  * the Software, and to permit persons to whom the Software is furnished to do so,\r
  10  * subject to the following conditions:\r
  11  *\r
  12  * The above copyright notice and this permission notice shall be included in all\r
  13  * copies or substantial portions of the Software.\r
  14  *\r
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
  16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\r
  17  * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\r
  18  * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\r
  19  * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\r
  20  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r
  21  *\r
  22  * http://www.FreeRTOS.org\r
  23  * http://aws.amazon.com/freertos\r
  24  *\r
  25  * 1 tab == 4 spaces!\r
  26  */\r
  27 \r
  28 #ifndef PORTMACRO_H\r
  29 #define PORTMACRO_H\r
  30 \r
  31 #include <Windows.h>\r
  32 #include <WinBase.h>\r
  33 \r
  34 /******************************************************************************\r
  35         Defines\r
  36 ******************************************************************************/\r
  37 /* Type definitions. */\r
  38 #define portCHAR                char\r
  39 #define portFLOAT               float\r
  40 #define portDOUBLE              double\r
  41 #define portLONG                long\r
  42 #define portSHORT               short\r
  43 #define portSTACK_TYPE  size_t\r
  44 #define portBASE_TYPE   long\r
  45 #define portPOINTER_SIZE_TYPE size_t\r
  46 \r
  47 typedef portSTACK_TYPE StackType_t;\r
  48 typedef long BaseType_t;\r
  49 typedef unsigned long UBaseType_t;\r
  50 \r
  51 \r
  52 #if( configUSE_16_BIT_TICKS == 1 )\r
  53     typedef uint16_t TickType_t;\r
  54     #define portMAX_DELAY ( TickType_t ) 0xffff\r
  55 #else\r
  56     typedef uint32_t TickType_t;\r
  57     #define portMAX_DELAY ( TickType_t ) 0xffffffffUL\r
  58 \r
  59         /* 32/64-bit tick type on a 32/64-bit architecture, so reads of the tick\r
  60         count do not need to be guarded with a critical section. */\r
  61         #define portTICK_TYPE_IS_ATOMIC 1\r
  62 #endif\r
  63 \r
  64 /* Hardware specifics. */\r
  65 #define portSTACK_GROWTH                        ( -1 )\r
  66 #define portTICK_PERIOD_MS                      ( ( TickType_t ) 1000 / configTICK_RATE_HZ )\r
  67 #define portINLINE __inline\r
  68 \r
  69 #if defined( __x86_64__) || defined( _M_X64 )\r
  70         #define portBYTE_ALIGNMENT              8\r
  71 #else\r
  72         #define portBYTE_ALIGNMENT              4\r
  73 #endif\r
  74 \r
  75 #define portYIELD()                                     vPortGenerateSimulatedInterrupt( portINTERRUPT_YIELD )\r
  76 \r
  77 \r
  78 extern volatile BaseType_t xInsideInterrupt;\r
  79 #define portSOFTWARE_BARRIER() while( xInsideInterrupt != pdFALSE )\r
  80 \r
  81 \r
  82 /* Simulated interrupts return pdFALSE if no context switch should be performed,\r
  83 or a non-zero number if a context switch should be performed. */\r
  84 #define portYIELD_FROM_ISR( x ) ( void ) x\r
  85 #define portEND_SWITCHING_ISR( x ) portYIELD_FROM_ISR( ( x ) )\r
  86 \r
  87 void vPortCloseRunningThread( void *pvTaskToDelete, volatile BaseType_t *pxPendYield );\r
  88 void vPortDeleteThread( void *pvThreadToDelete );\r
  89 #define portCLEAN_UP_TCB( pxTCB )       vPortDeleteThread( pxTCB )\r
  90 #define portPRE_TASK_DELETE_HOOK( pvTaskToDelete, pxPendYield ) vPortCloseRunningThread( ( pvTaskToDelete ), ( pxPendYield ) )\r
  91 #define portDISABLE_INTERRUPTS() vPortEnterCritical()\r
  92 #define portENABLE_INTERRUPTS() vPortExitCritical()\r
  93 \r
  94 /* Critical section handling. */\r
  95 void vPortEnterCritical( void );\r
  96 void vPortExitCritical( void );\r
  97 \r
  98 #define portENTER_CRITICAL()            vPortEnterCritical()\r
  99 #define portEXIT_CRITICAL()                     vPortExitCritical()\r
 100 \r
 101 #ifndef configUSE_PORT_OPTIMISED_TASK_SELECTION\r
 102         #define configUSE_PORT_OPTIMISED_TASK_SELECTION 1\r
 103 #endif\r
 104 \r
 105 #if configUSE_PORT_OPTIMISED_TASK_SELECTION == 1\r
 106 \r
 107         /* Check the configuration. */\r
 108         #if( configMAX_PRIORITIES > 32 )\r
 109                 #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.\r
 110         #endif\r
 111 \r
 112         /* Store/clear the ready priorities in a bit map. */\r
 113         #define portRECORD_READY_PRIORITY( uxPriority, uxReadyPriorities ) ( uxReadyPriorities ) |= ( 1UL << ( uxPriority ) )\r
 114         #define portRESET_READY_PRIORITY( uxPriority, uxReadyPriorities ) ( uxReadyPriorities ) &= ~( 1UL << ( uxPriority ) )\r
 115 \r
 116 \r
 117         /*-----------------------------------------------------------*/\r
 118 \r
 119         #ifdef __GNUC__\r
 120                 #define portGET_HIGHEST_PRIORITY( uxTopPriority, uxReadyPriorities )    \\r
 121                         __asm volatile( "bsr %1, %0\n\t"                                                                        \\r
 122                                                         :"=r"(uxTopPriority) : "rm"(uxReadyPriorities) : "cc" )\r
 123         #else\r
 124                 /* BitScanReverse returns the bit position of the most significant '1'\r
 125                 in the word. */\r
 126                 #define portGET_HIGHEST_PRIORITY( uxTopPriority, uxReadyPriorities ) _BitScanReverse( ( DWORD * ) &( uxTopPriority ), ( uxReadyPriorities ) )\r
 127         #endif /* __GNUC__ */\r
 128 \r
 129 #endif /* taskRECORD_READY_PRIORITY */\r
 130 \r
 131 #ifndef __GNUC__\r
 132         __pragma( warning( disable:4211 ) ) /* Nonstandard extension used, as extern is only nonstandard to MSVC. */\r
 133 #endif\r
 134 \r
 135 \r
 136 /* Task function macros as described on the FreeRTOS.org WEB site. */\r
 137 #define portTASK_FUNCTION_PROTO( vFunction, pvParameters ) void vFunction( void * pvParameters )\r
 138 #define portTASK_FUNCTION( vFunction, pvParameters ) void vFunction( void * pvParameters )\r
 139 \r
 140 #define portINTERRUPT_YIELD                             ( 0UL )\r
 141 #define portINTERRUPT_TICK                              ( 1UL )\r
 142 \r
 143 /*\r
 144  * Raise a simulated interrupt represented by the bit mask in ulInterruptMask.\r
 145  * Each bit can be used to represent an individual interrupt - with the first\r
 146  * two bits being used for the Yield and Tick interrupts respectively.\r
 147 */\r
 148 void vPortGenerateSimulatedInterrupt( uint32_t ulInterruptNumber );\r
 149 \r
 150 /*\r
 151  * Install an interrupt handler to be called by the simulated interrupt handler\r
 152  * thread.  The interrupt number must be above any used by the kernel itself\r
 153  * (at the time of writing the kernel was using interrupt numbers 0, 1, and 2\r
 154  * as defined above).  The number must also be lower than 32.\r
 155  *\r
 156  * Interrupt handler functions must return a non-zero value if executing the\r
 157  * handler resulted in a task switch being required.\r
 158  */\r
 159 void vPortSetInterruptHandler( uint32_t ulInterruptNumber, uint32_t (*pvHandler)( void ) );\r
 160 \r
 161 #endif\r
 162 \r