git.sur5r.net Git - freertos/blob - Source/include/portable.h

   1 /*\r
   2         FreeRTOS V4.0.1 - Copyright (C) 2003-2006 Richard Barry.\r
   3 \r
   4         This file is part of the FreeRTOS distribution.\r
   5 \r
   6         FreeRTOS is free software; you can redistribute it and/or modify\r
   7         it under the terms of the GNU General Public License as published by\r
   8         the Free Software Foundation; either version 2 of the License, or\r
   9         (at your option) any later version.\r
  10 \r
  11         FreeRTOS is distributed in the hope that it will be useful,\r
  12         but WITHOUT ANY WARRANTY; without even the implied warranty of\r
  13         MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
  14         GNU General Public License for more details.\r
  15 \r
  16         You should have received a copy of the GNU General Public License\r
  17         along with FreeRTOS; if not, write to the Free Software\r
  18         Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA\r
  19 \r
  20         A special exception to the GPL can be applied should you wish to distribute\r
  21         a combined work that includes FreeRTOS, without being obliged to provide\r
  22         the source code for any proprietary components.  See the licensing section\r
  23         of http:www.FreeRTOS.org for full details of how and when the exception\r
  24         can be applied.\r
  25 \r
  26         ***************************************************************************\r
  27         See http:www.FreeRTOS.org for documentation, latest information, license\r
  28         and contact details.  Please ensure to read the configuration and relevant\r
  29         port sections of the online documentation.\r
  30         ***************************************************************************\r
  31 */\r
  32 \r
  33 /*-----------------------------------------------------------\r
  34  * Portable layer API.  Each function must be defined for each port.\r
  35  *----------------------------------------------------------*/\r
  36 \r
  37 #ifndef PORTABLE_H\r
  38 #define PORTABLE_H\r
  39 \r
  40 /* Include the macro file relevant to the port being used. */\r
  41 \r
  42 #ifdef OPEN_WATCOM_INDUSTRIAL_PC_PORT\r
  43         #include "..\..\source\portable\owatcom\16bitdos\pc\portmacro.h"\r
  44         typedef void ( __interrupt __far *pxISR )();\r
  45 #endif\r
  46 \r
  47 #ifdef OPEN_WATCOM_FLASH_LITE_186_PORT\r
  48         #include "..\..\source\portable\owatcom\16bitdos\flsh186\portmacro.h"\r
  49         typedef void ( __interrupt __far *pxISR )();\r
  50 #endif\r
  51 \r
  52 #ifdef GCC_MEGA_AVR\r
  53         #include "../portable/GCC/ATMega323/portmacro.h"\r
  54 #endif\r
  55 \r
  56 #ifdef IAR_MEGA_AVR\r
  57         #include "../portable/IAR/ATMega323/portmacro.h"\r
  58 #endif\r
  59 \r
  60 #ifdef MPLAB_PIC18F_PORT\r
  61         #include "..\..\source\portable\MPLAB\PIC18F\portmacro.h"\r
  62 #endif\r
  63 \r
  64 #ifdef _FEDPICC\r
  65         #include "libFreeRTOS/Include/portmacro.h"\r
  66 #endif\r
  67 \r
  68 #ifdef SDCC_CYGNAL\r
  69         #include "../../Source/portable/SDCC/Cygnal/portmacro.h"\r
  70 #endif\r
  71 \r
  72 #ifdef GCC_ARM7\r
  73         #include "../../Source/portable/GCC/ARM7_LPC2000/portmacro.h"\r
  74 #endif\r
  75 \r
  76 #ifdef GCC_MSP430\r
  77         #include "../../Source/portable/GCC/MSP430F449/portmacro.h"\r
  78 #endif\r
  79 \r
  80 #ifdef ROWLEY_MSP430\r
  81         #include "../../Source/portable/Rowley/MSP430F449/portmacro.h"\r
  82 #endif\r
  83 \r
  84 #ifdef KEIL_ARM7\r
  85         #include "..\..\Source\portable\Keil\ARM7\portmacro.h"\r
  86 #endif\r
  87 \r
  88 #ifdef SAM7_GCC\r
  89         #include "../../Source/portable/GCC/ARM7_AT91SAM7S/portmacro.h"\r
  90 #endif\r
  91 \r
  92 #ifdef SAM7_IAR\r
  93         #include "..\..\Source\portable\IAR\AtmelSAM7S64\portmacro.h"\r
  94 #endif\r
  95 \r
  96 #ifdef LPC2000_IAR\r
  97         #include "..\..\Source\portable\IAR\LPC2000\portmacro.h"\r
  98 #endif\r
  99 \r
 100 #ifdef STR71X_IAR\r
 101         #include "..\..\Source\portable\IAR\STR71x\portmacro.h"\r
 102 #endif\r
 103 \r
 104 #ifdef GCC_H8S\r
 105         #include "../../Source/portable/GCC/H8S2329/portmacro.h"\r
 106 #endif\r
 107 \r
 108 #ifdef GCC_AT91FR40008\r
 109         #include "../../Source/portable/GCC/ARM7_AT91FR40008/portmacro.h"\r
 110 #endif\r
 111 \r
 112 #ifdef RVDS_ARMCM3_LM3S102\r
 113         #include "../../Source/portable/RVDS/ARM_CM3/portmacro.h"\r
 114 #endif\r
 115 \r
 116 #ifdef GCC_ARMCM3_LM3S102\r
 117         #include "../../Source/portable/GCC/ARM_CM3/portmacro.h"\r
 118 #endif\r
 119 \r
 120 #ifdef HCS12_CODE_WARRIOR\r
 121         #include "../../Source/portable/CodeWarrior/HCS12/portmacro.h"\r
 122 #endif  \r
 123 \r
 124 #ifdef MICROBLAZE_GCC\r
 125         #include "../../Source/portable/GCC/MicroBlaze/portmacro.h"\r
 126 #endif\r
 127 \r
 128 #ifdef BCC_INDUSTRIAL_PC_PORT\r
 129         /* A short file name has to be used in place of the normal\r
 130         FreeRTOSConfig.h when using the Borland compiler. */\r
 131         #include "frconfig.h"\r
 132         #include "..\portable\BCC\16BitDOS\PC\prtmacro.h"\r
 133     typedef void ( __interrupt __far *pxISR )();\r
 134 #endif\r
 135 \r
 136 #ifdef BCC_FLASH_LITE_186_PORT\r
 137         /* A short file name has to be used in place of the normal\r
 138         FreeRTOSConfig.h when using the Borland compiler. */\r
 139         #include "frconfig.h"\r
 140         #include "..\portable\BCC\16BitDOS\flsh186\prtmacro.h"\r
 141     typedef void ( __interrupt __far *pxISR )();\r
 142 #endif\r
 143 /*\r
 144  * Setup the stack of a new task so it is ready to be placed under the\r
 145  * scheduler control.  The registers have to be placed on the stack in\r
 146  * the order that the port expects to find them.\r
 147  */\r
 148 portSTACK_TYPE *pxPortInitialiseStack( portSTACK_TYPE *pxTopOfStack, pdTASK_CODE pxCode, void *pvParameters );\r
 149 \r
 150 /*\r
 151  * Map to the memory management routines required for the port.\r
 152  */\r
 153 void *pvPortMalloc( size_t xSize );\r
 154 void vPortFree( void *pv );\r
 155 void vPortInitialiseBlocks( void );\r
 156 \r
 157 /*\r
 158  * Setup the hardware ready for the scheduler to take control.  This generally\r
 159  * sets up a tick interrupt and sets timers for the correct tick frequency.\r
 160  */\r
 161 portBASE_TYPE xPortStartScheduler( void );\r
 162 \r
 163 /*\r
 164  * Undo any hardware/ISR setup that was performed by xPortStartScheduler() so\r
 165  * the hardware is left in its original condition after the scheduler stops\r
 166  * executing.\r
 167  */\r
 168 void vPortEndScheduler( void );\r
 169 \r
 170 \r
 171 #endif /* PORTABLE_H */\r
 172 \r