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

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