begriffs open source - freertos/blob - portable/MSVC-MingW/portmacro.h

   1 /*\r
   2  * FreeRTOS Kernel V10.3.1\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  */\r
  26 \r
  27 #ifndef PORTMACRO_H\r
  28 #define PORTMACRO_H\r
  29 \r
  30 #include <Windows.h>\r
  31 #include <WinBase.h>\r
  32 \r
  33 /******************************************************************************\r
  34 *   Defines\r
  35 ******************************************************************************/\r
  36 /* Type definitions. */\r
  37 #define portCHAR                 char\r
  38 #define portFLOAT                float\r
  39 #define portDOUBLE               double\r
  40 #define portLONG                 long\r
  41 #define portSHORT                short\r
  42 #define portSTACK_TYPE           size_t\r
  43 #define portBASE_TYPE            long\r
  44 #define portPOINTER_SIZE_TYPE    size_t\r
  45 \r
  46 typedef portSTACK_TYPE   StackType_t;\r
  47 typedef long             BaseType_t;\r
  48 typedef unsigned long    UBaseType_t;\r
  49 \r
  50 \r
  51 #if ( configUSE_16_BIT_TICKS == 1 )\r
  52     typedef uint16_t     TickType_t;\r
  53     #define portMAX_DELAY              ( TickType_t ) 0xffff\r
  54 #else\r
  55     typedef uint32_t     TickType_t;\r
  56     #define portMAX_DELAY              ( TickType_t ) 0xffffffffUL\r
  57 \r
  58 /* 32/64-bit tick type on a 32/64-bit architecture, so reads of the tick\r
  59  * count do not need to be guarded with a critical section. */\r
  60     #define portTICK_TYPE_IS_ATOMIC    1\r
  61 #endif\r
  62 \r
  63 /* Hardware specifics. */\r
  64 #define portSTACK_GROWTH          ( -1 )\r
  65 #define portTICK_PERIOD_MS        ( ( TickType_t ) 1000 / configTICK_RATE_HZ )\r
  66 #define portINLINE                __inline\r
  67 \r
  68 #if defined( __x86_64__ ) || defined( _M_X64 )\r
  69     #define portBYTE_ALIGNMENT    8\r
  70 #else\r
  71     #define portBYTE_ALIGNMENT    4\r
  72 #endif\r
  73 \r
  74 #define portYIELD()    vPortGenerateSimulatedInterrupt( portINTERRUPT_YIELD )\r
  75 \r
  76 \r
  77 extern volatile BaseType_t xInsideInterrupt;\r
  78 #define portSOFTWARE_BARRIER()    while( xInsideInterrupt != pdFALSE )\r
  79 \r
  80 \r
  81 /* Simulated interrupts return pdFALSE if no context switch should be performed,\r
  82  * or a non-zero number if a context switch should be performed. */\r
  83 #define portYIELD_FROM_ISR( x )       ( void ) x\r
  84 #define portEND_SWITCHING_ISR( x )    portYIELD_FROM_ISR( ( x ) )\r
  85 \r
  86 void vPortCloseRunningThread( void * pvTaskToDelete,\r
  87                               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 \r
 125 /* BitScanReverse returns the bit position of the most significant '1'\r
 126  * in the word. */\r
 127         #define portGET_HIGHEST_PRIORITY( uxTopPriority, uxReadyPriorities )    _BitScanReverse( ( DWORD * ) &( uxTopPriority ), ( uxReadyPriorities ) )\r
 128     #endif /* __GNUC__ */\r
 129 \r
 130 #endif /* taskRECORD_READY_PRIORITY */\r
 131 \r
 132 #ifndef __GNUC__\r
 133     __pragma( warning( disable: 4211 ) ) /* Nonstandard extension used, as extern is only nonstandard to MSVC. */\r
 134 #endif\r
 135 \r
 136 \r
 137 /* Task function macros as described on the FreeRTOS.org WEB site. */\r
 138 #define portTASK_FUNCTION_PROTO( vFunction, pvParameters )    void vFunction( void * pvParameters )\r
 139 #define portTASK_FUNCTION( vFunction, pvParameters )          void vFunction( void * pvParameters )\r
 140 \r
 141 #define portINTERRUPT_YIELD    ( 0UL )\r
 142 #define portINTERRUPT_TICK     ( 1UL )\r
 143 \r
 144 /*\r
 145  * Raise a simulated interrupt represented by the bit mask in ulInterruptMask.\r
 146  * Each bit can be used to represent an individual interrupt - with the first\r
 147  * two bits being used for the Yield and Tick interrupts respectively.\r
 148  */\r
 149 void vPortGenerateSimulatedInterrupt( uint32_t ulInterruptNumber );\r
 150 \r
 151 /*\r
 152  * Install an interrupt handler to be called by the simulated interrupt handler\r
 153  * thread.  The interrupt number must be above any used by the kernel itself\r
 154  * (at the time of writing the kernel was using interrupt numbers 0, 1, and 2\r
 155  * as defined above).  The number must also be lower than 32.\r
 156  *\r
 157  * Interrupt handler functions must return a non-zero value if executing the\r
 158  * handler resulted in a task switch being required.\r
 159  */\r
 160 void vPortSetInterruptHandler( uint32_t ulInterruptNumber,\r
 161                                uint32_t ( * pvHandler )( void ) );\r
 162 \r
 163 #endif /* ifndef PORTMACRO_H */\r