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

   1 /*\r
   2     FreeRTOS V7.3.0 - Copyright (C) 2012 Real Time Engineers Ltd.\r
   3 \r
   4     FEATURES AND PORTS ARE ADDED TO FREERTOS ALL THE TIME.  PLEASE VISIT \r
   5     http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.\r
   6 \r
   7     ***************************************************************************\r
   8      *                                                                       *\r
   9      *    FreeRTOS tutorial books are available in pdf and paperback.        *\r
  10      *    Complete, revised, and edited pdf reference manuals are also       *\r
  11      *    available.                                                         *\r
  12      *                                                                       *\r
  13      *    Purchasing FreeRTOS documentation will not only help you, by       *\r
  14      *    ensuring you get running as quickly as possible and with an        *\r
  15      *    in-depth knowledge of how to use FreeRTOS, it will also help       *\r
  16      *    the FreeRTOS project to continue with its mission of providing     *\r
  17      *    professional grade, cross platform, de facto standard solutions    *\r
  18      *    for microcontrollers - completely free of charge!                  *\r
  19      *                                                                       *\r
  20      *    >>> See http://www.FreeRTOS.org/Documentation for details. <<<     *\r
  21      *                                                                       *\r
  22      *    Thank you for using FreeRTOS, and thank you for your support!      *\r
  23      *                                                                       *\r
  24     ***************************************************************************\r
  25 \r
  26 \r
  27     This file is part of the FreeRTOS distribution.\r
  28 \r
  29     FreeRTOS is free software; you can redistribute it and/or modify it under\r
  30     the terms of the GNU General Public License (version 2) as published by the\r
  31     Free Software Foundation AND MODIFIED BY the FreeRTOS exception.\r
  32     >>>NOTE<<< The modification to the GPL is included to allow you to\r
  33     distribute a combined work that includes FreeRTOS without being obliged to\r
  34     provide the source code for proprietary components outside of the FreeRTOS\r
  35     kernel.  FreeRTOS is distributed in the hope that it will be useful, but\r
  36     WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY\r
  37     or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for\r
  38     more details. You should have received a copy of the GNU General Public\r
  39     License and the FreeRTOS license exception along with FreeRTOS; if not it\r
  40     can be viewed here: http://www.freertos.org/a00114.html and also obtained\r
  41     by writing to Richard Barry, contact details for whom are available on the\r
  42     FreeRTOS WEB site.\r
  43 \r
  44     1 tab == 4 spaces!\r
  45     \r
  46     ***************************************************************************\r
  47      *                                                                       *\r
  48      *    Having a problem?  Start by reading the FAQ "My application does   *\r
  49      *    not run, what could be wrong?"                                     *\r
  50      *                                                                       *\r
  51      *    http://www.FreeRTOS.org/FAQHelp.html                               *\r
  52      *                                                                       *\r
  53     ***************************************************************************\r
  54 \r
  55     \r
  56     http://www.FreeRTOS.org - Documentation, training, latest versions, license \r
  57     and contact details.  \r
  58     \r
  59     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
  60     including FreeRTOS+Trace - an indispensable productivity tool.\r
  61 \r
  62     Real Time Engineers ltd license FreeRTOS to High Integrity Systems, who sell \r
  63     the code with commercial support, indemnification, and middleware, under \r
  64     the OpenRTOS brand: http://www.OpenRTOS.com.  High Integrity Systems also\r
  65     provide a safety engineered and independently SIL3 certified version under \r
  66     the SafeRTOS brand: http://www.SafeRTOS.com.\r
  67 */\r
  68 \r
  69 #ifndef PORTMACRO_H\r
  70 #define PORTMACRO_H\r
  71 \r
  72 #include <Windows.h>\r
  73 \r
  74 /******************************************************************************\r
  75         Defines\r
  76 ******************************************************************************/\r
  77 /* Type definitions. */\r
  78 #define portCHAR                char\r
  79 #define portFLOAT               float\r
  80 #define portDOUBLE              double\r
  81 #define portLONG                long\r
  82 #define portSHORT               short\r
  83 #define portSTACK_TYPE  unsigned portLONG\r
  84 #define portBASE_TYPE   portLONG\r
  85 \r
  86 #if( configUSE_16_BIT_TICKS == 1 )\r
  87     typedef unsigned portSHORT portTickType;\r
  88     #define portMAX_DELAY ( portTickType ) 0xffff\r
  89 #else\r
  90     typedef unsigned portLONG portTickType;\r
  91     #define portMAX_DELAY ( portTickType ) 0xffffffff\r
  92 #endif\r
  93 \r
  94 /* Hardware specifics. */\r
  95 #define portSTACK_GROWTH                        ( -1 )\r
  96 #define portTICK_RATE_MS                        ( ( portTickType ) 1000 / configTICK_RATE_HZ )  \r
  97 #define portBYTE_ALIGNMENT                      4\r
  98 \r
  99 #define portYIELD()                                     vPortGenerateSimulatedInterrupt( portINTERRUPT_YIELD )\r
 100 \r
 101 void vPortDeleteThread( void *pvThreadToDelete );\r
 102 #define portCLEAN_UP_TCB( pxTCB )       vPortDeleteThread( pxTCB )\r
 103 #define portDISABLE_INTERRUPTS()\r
 104 #define portENABLE_INTERRUPTS()\r
 105 \r
 106 /* Critical section handling. */\r
 107 void vPortEnterCritical( void );\r
 108 void vPortExitCritical( void );\r
 109 \r
 110 #define portENTER_CRITICAL()            vPortEnterCritical()\r
 111 #define portEXIT_CRITICAL()                     vPortExitCritical()\r
 112 \r
 113 #ifndef __GNUC__\r
 114         #if configUSE_PORT_OPTIMISED_TASK_SELECTION == 1\r
 115 \r
 116         /* Check the configuration. */\r
 117         #if( configMAX_PRIORITIES > 32 )\r
 118                 #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
 119         #endif\r
 120 \r
 121                 /* Store/clear the ready priorities in a bit map. */\r
 122                 #define portRECORD_READY_PRIORITY( uxPriority, uxReadyPriorities ) ( uxReadyPriorities ) |= ( 1UL << ( uxPriority ) )\r
 123                 #define portRESET_READY_PRIORITY( uxPriority, uxReadyPriorities ) ( uxReadyPriorities ) &= ~( 1UL << ( uxPriority ) )\r
 124 \r
 125 \r
 126                 /*-----------------------------------------------------------*/\r
 127 \r
 128                 /* BitScanReverse returns the bit position of the most significant '1'\r
 129                 in the word. */\r
 130                 #define portGET_HIGHEST_PRIORITY( uxTopPriority, uxReadyPriorities ) _BitScanReverse( ( DWORD * ) &( uxTopPriority ), ( uxReadyPriorities ) )\r
 131 \r
 132         #endif /* taskRECORD_READY_PRIORITY */\r
 133 #endif /* __GNUC__ */\r
 134 \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 \r
 142 #define portINTERRUPT_YIELD                             ( 0UL )\r
 143 #define portINTERRUPT_TICK                              ( 1UL )\r
 144 \r
 145 /* \r
 146  * Raise a simulated interrupt represented by the bit mask in ulInterruptMask.\r
 147  * Each bit can be used to represent an individual interrupt - with the first\r
 148  * two bits being used for the Yield and Tick interrupts respectively.\r
 149 */\r
 150 void vPortGenerateSimulatedInterrupt( unsigned long ulInterruptNumber );\r
 151 \r
 152 /*\r
 153  * Install an interrupt handler to be called by the simulated interrupt handler \r
 154  * thread.  The interrupt number must be above any used by the kernel itself\r
 155  * (at the time of writing the kernel was using interrupt numbers 0, 1, and 2\r
 156  * as defined above).  The number must also be lower than 32. \r
 157  *\r
 158  * Interrupt handler functions must return a non-zero value if executing the\r
 159  * handler resulted in a task switch being required. \r
 160  */\r
 161 void vPortSetInterruptHandler( unsigned long ulInterruptNumber, unsigned long (*pvHandler)( void ) );\r
 162 \r
 163 #endif\r