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

   1 /*\r
   2     FreeRTOS V8.1.2 - Copyright (C) 2014 Real Time Engineers Ltd.\r
   3     All rights reserved\r
   4 \r
   5     VISIT http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.\r
   6 \r
   7     ***************************************************************************\r
   8      *                                                                       *\r
   9      *    FreeRTOS provides completely free yet professionally developed,    *\r
  10      *    robust, strictly quality controlled, supported, and cross          *\r
  11      *    platform software that has become a de facto standard.             *\r
  12      *                                                                       *\r
  13      *    Help yourself get started quickly and support the FreeRTOS         *\r
  14      *    project by purchasing a FreeRTOS tutorial book, reference          *\r
  15      *    manual, or both from: http://www.FreeRTOS.org/Documentation        *\r
  16      *                                                                       *\r
  17      *    Thank you!                                                         *\r
  18      *                                                                       *\r
  19     ***************************************************************************\r
  20 \r
  21     This file is part of the FreeRTOS distribution.\r
  22 \r
  23     FreeRTOS is free software; you can redistribute it and/or modify it under\r
  24     the terms of the GNU General Public License (version 2) as published by the\r
  25     Free Software Foundation >>!AND MODIFIED BY!<< the FreeRTOS exception.\r
  26 \r
  27     >>!   NOTE: The modification to the GPL is included to allow you to     !<<\r
  28     >>!   distribute a combined work that includes FreeRTOS without being   !<<\r
  29     >>!   obliged to provide the source code for proprietary components     !<<\r
  30     >>!   outside of the FreeRTOS kernel.                                   !<<\r
  31 \r
  32     FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY\r
  33     WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS\r
  34     FOR A PARTICULAR PURPOSE.  Full license text is available from the following\r
  35     link: http://www.freertos.org/a00114.html\r
  36 \r
  37     1 tab == 4 spaces!\r
  38 \r
  39     ***************************************************************************\r
  40      *                                                                       *\r
  41      *    Having a problem?  Start by reading the FAQ "My application does   *\r
  42      *    not run, what could be wrong?"                                     *\r
  43      *                                                                       *\r
  44      *    http://www.FreeRTOS.org/FAQHelp.html                               *\r
  45      *                                                                       *\r
  46     ***************************************************************************\r
  47 \r
  48     http://www.FreeRTOS.org - Documentation, books, training, latest versions,\r
  49     license and Real Time Engineers Ltd. contact details.\r
  50 \r
  51     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
  52     including FreeRTOS+Trace - an indispensable productivity tool, a DOS\r
  53     compatible FAT file system, and our tiny thread aware UDP/IP stack.\r
  54 \r
  55     http://www.OpenRTOS.com - Real Time Engineers ltd license FreeRTOS to High\r
  56     Integrity Systems to sell under the OpenRTOS brand.  Low cost OpenRTOS\r
  57     licenses offer ticketed support, indemnification and middleware.\r
  58 \r
  59     http://www.SafeRTOS.com - High Integrity Systems also provide a safety\r
  60     engineered and independently SIL3 certified version for use in safety and\r
  61     mission critical applications that require provable dependability.\r
  62 \r
  63     1 tab == 4 spaces!\r
  64 */\r
  65 \r
  66 #ifndef PORTMACRO_H\r
  67 #define PORTMACRO_H\r
  68 \r
  69 #include <Windows.h>\r
  70 \r
  71 /******************************************************************************\r
  72         Defines\r
  73 ******************************************************************************/\r
  74 /* Type definitions. */\r
  75 #define portCHAR                char\r
  76 #define portFLOAT               float\r
  77 #define portDOUBLE              double\r
  78 #define portLONG                long\r
  79 #define portSHORT               short\r
  80 #define portSTACK_TYPE  uint32_t\r
  81 #define portBASE_TYPE   long\r
  82 \r
  83 typedef portSTACK_TYPE StackType_t;\r
  84 typedef long BaseType_t;\r
  85 typedef unsigned long UBaseType_t;\r
  86 \r
  87 \r
  88 #if( configUSE_16_BIT_TICKS == 1 )\r
  89     typedef uint16_t TickType_t;\r
  90     #define portMAX_DELAY ( TickType_t ) 0xffff\r
  91 #else\r
  92     typedef uint32_t TickType_t;\r
  93     #define portMAX_DELAY ( TickType_t ) 0xffffffffUL\r
  94 #endif\r
  95 \r
  96 /* Hardware specifics. */\r
  97 #define portSTACK_GROWTH                        ( -1 )\r
  98 #define portTICK_PERIOD_MS                      ( ( TickType_t ) 1000 / configTICK_RATE_HZ )\r
  99 #define portBYTE_ALIGNMENT                      4\r
 100 \r
 101 #define portYIELD()                                     vPortGenerateSimulatedInterrupt( portINTERRUPT_YIELD )\r
 102 \r
 103 void vPortCloseRunningThread( void *pvTaskToDelete, volatile BaseType_t *pxPendYield );\r
 104 void vPortDeleteThread( void *pvThreadToDelete );\r
 105 #define portCLEAN_UP_TCB( pxTCB )       vPortDeleteThread( pxTCB )\r
 106 #define portPRE_TASK_DELETE_HOOK( pvTaskToDelete, pxPendYield ) vPortCloseRunningThread( ( pvTaskToDelete ), ( pxPendYield ) )\r
 107 #define portDISABLE_INTERRUPTS() vPortEnterCritical()\r
 108 #define portENABLE_INTERRUPTS() vPortExitCritical()\r
 109 \r
 110 /* Critical section handling. */\r
 111 void vPortEnterCritical( void );\r
 112 void vPortExitCritical( void );\r
 113 \r
 114 #define portENTER_CRITICAL()            vPortEnterCritical()\r
 115 #define portEXIT_CRITICAL()                     vPortExitCritical()\r
 116 \r
 117 #ifndef configUSE_PORT_OPTIMISED_TASK_SELECTION\r
 118         #define configUSE_PORT_OPTIMISED_TASK_SELECTION 1\r
 119 #endif\r
 120 \r
 121 #if configUSE_PORT_OPTIMISED_TASK_SELECTION == 1\r
 122 \r
 123         /* Check the configuration. */\r
 124         #if( configMAX_PRIORITIES > 32 )\r
 125                 #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
 126         #endif\r
 127 \r
 128         /* Store/clear the ready priorities in a bit map. */\r
 129         #define portRECORD_READY_PRIORITY( uxPriority, uxReadyPriorities ) ( uxReadyPriorities ) |= ( 1UL << ( uxPriority ) )\r
 130         #define portRESET_READY_PRIORITY( uxPriority, uxReadyPriorities ) ( uxReadyPriorities ) &= ~( 1UL << ( uxPriority ) )\r
 131 \r
 132 \r
 133         /*-----------------------------------------------------------*/\r
 134 \r
 135         #ifdef __GNUC__\r
 136                 #define portGET_HIGHEST_PRIORITY( uxTopPriority, uxReadyPriorities )      \\r
 137                         __asm volatile( "mov %0, %%eax                                                                  \n\t" \\r
 138                                                         "bsr %%eax, %%eax                                                               \n\t" \\r
 139                                                         "mov %%eax, %1                                                                  \n\t" \\r
 140                                                         :"=r"(uxTopPriority) : "r"(uxReadyPriorities) : "eax" )\r
 141         #else\r
 142                 /* BitScanReverse returns the bit position of the most significant '1'\r
 143                 in the word. */\r
 144                 #define portGET_HIGHEST_PRIORITY( uxTopPriority, uxReadyPriorities ) _BitScanReverse( ( DWORD * ) &( uxTopPriority ), ( uxReadyPriorities ) )\r
 145         #endif /* __GNUC__ */\r
 146 \r
 147 #endif /* taskRECORD_READY_PRIORITY */\r
 148 \r
 149 #ifndef __GNUC__\r
 150         __pragma( warning( disable:4211 ) ) /* Nonstandard extension used, as extern is only nonstandard to MSVC. */\r
 151 #endif\r
 152 \r
 153 \r
 154 /* Task function macros as described on the FreeRTOS.org WEB site. */\r
 155 #define portTASK_FUNCTION_PROTO( vFunction, pvParameters ) void vFunction( void * pvParameters )\r
 156 #define portTASK_FUNCTION( vFunction, pvParameters ) void vFunction( void * pvParameters )\r
 157 \r
 158 \r
 159 #define portINTERRUPT_YIELD                             ( 0UL )\r
 160 #define portINTERRUPT_TICK                              ( 1UL )\r
 161 \r
 162 /*\r
 163  * Raise a simulated interrupt represented by the bit mask in ulInterruptMask.\r
 164  * Each bit can be used to represent an individual interrupt - with the first\r
 165  * two bits being used for the Yield and Tick interrupts respectively.\r
 166 */\r
 167 void vPortGenerateSimulatedInterrupt( uint32_t ulInterruptNumber );\r
 168 \r
 169 /*\r
 170  * Install an interrupt handler to be called by the simulated interrupt handler\r
 171  * thread.  The interrupt number must be above any used by the kernel itself\r
 172  * (at the time of writing the kernel was using interrupt numbers 0, 1, and 2\r
 173  * as defined above).  The number must also be lower than 32.\r
 174  *\r
 175  * Interrupt handler functions must return a non-zero value if executing the\r
 176  * handler resulted in a task switch being required.\r
 177  */\r
 178 void vPortSetInterruptHandler( uint32_t ulInterruptNumber, uint32_t (*pvHandler)( void ) );\r
 179 \r
 180 #endif\r