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

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