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

   1 /*\r
   2         FreeRTOS.org V4.3.0 - Copyright (C) 2003-2007 Richard Barry.\r
   3 \r
   4         This file is part of the FreeRTOS.org distribution.\r
   5 \r
   6         FreeRTOS.org 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.org 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.org; 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.org, 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         Also see http://www.SafeRTOS.com for an IEC 61508 compliant version along\r
  32         with commercial development and support options.\r
  33         ***************************************************************************\r
  34 */\r
  35 \r
  36 #ifndef INC_FREERTOS_H\r
  37 #define INC_FREERTOS_H\r
  38 \r
  39 \r
  40 /* \r
  41  * Include the generic headers required for the FreeRTOS port being used. \r
  42  */\r
  43 #include <stddef.h>\r
  44 \r
  45 /* Basic FreeRTOS definitions. */\r
  46 #include "projdefs.h"\r
  47 \r
  48 /* Application specific configuration options. */\r
  49 #include "FreeRTOSConfig.h"\r
  50 \r
  51 /* Definitions specific to the port being used. */\r
  52 #include "portable.h"\r
  53 \r
  54 \r
  55 \r
  56 \r
  57 \r
  58 \r
  59 \r
  60 /*\r
  61  * Check all the required application specific macros have been defined. \r
  62  * These macros are application specific and (as downloaded) are defined\r
  63  * within FreeRTOSConfig.h.\r
  64  */\r
  65 \r
  66 #ifndef configUSE_PREEMPTION\r
  67         #error Missing definition:  configUSE_PREEMPTION should be defined in FreeRTOSConfig.h as either 1 or 0.  See the Configuration section of the FreeRTOS API documentation for details.\r
  68 #endif\r
  69 \r
  70 #ifndef configUSE_IDLE_HOOK\r
  71         #error Missing definition:  configUSE_IDLE_HOOK should be defined in FreeRTOSConfig.h as either 1 or 0.  See the Configuration section of the FreeRTOS API documentation for details.\r
  72 #endif\r
  73 \r
  74 #ifndef configUSE_TICK_HOOK\r
  75         #error Missing definition:  configUSE_TICK_HOOK should be defined in FreeRTOSConfig.h as either 1 or 0.  See the Configuration section of the FreeRTOS API documentation for details.\r
  76 #endif\r
  77 \r
  78 #ifndef configUSE_CO_ROUTINES\r
  79         #error  Missing definition:  configUSE_CO_ROUTINES should be defined in FreeRTOSConfig.h as either 1 or 0.  See the Configuration section of the FreeRTOS API documentation for details.\r
  80 #endif\r
  81 \r
  82 #ifndef INCLUDE_vTaskPrioritySet\r
  83         #error Missing definition:  INCLUDE_vTaskPrioritySet should be defined in FreeRTOSConfig.h as either 1 or 0.  See the Configuration section of the FreeRTOS API documentation for details.\r
  84 #endif\r
  85 \r
  86 #ifndef INCLUDE_uxTaskPriorityGet\r
  87         #error Missing definition:  INCLUDE_uxTaskPriorityGet should be defined in FreeRTOSConfig.h as either 1 or 0.  See the Configuration section of the FreeRTOS API documentation for details.\r
  88 #endif\r
  89 \r
  90 #ifndef INCLUDE_vTaskDelete             \r
  91         #error Missing definition:  INCLUDE_vTaskDelete          should be defined in FreeRTOSConfig.h as either 1 or 0.  See the Configuration section of the FreeRTOS API documentation for details.\r
  92 #endif\r
  93 \r
  94 #ifndef INCLUDE_vTaskCleanUpResources\r
  95         #error Missing definition:  INCLUDE_vTaskCleanUpResources should be defined in FreeRTOSConfig.h as either 1 or 0.  See the Configuration section of the FreeRTOS API documentation for details.\r
  96 #endif\r
  97 \r
  98 #ifndef INCLUDE_vTaskSuspend    \r
  99         #error Missing definition:  INCLUDE_vTaskSuspend         should be defined in FreeRTOSConfig.h as either 1 or 0.  See the Configuration section of the FreeRTOS API documentation for details.\r
 100 #endif\r
 101 \r
 102 #ifndef INCLUDE_vTaskDelayUntil\r
 103         #error Missing definition:  INCLUDE_vTaskDelayUntil should be defined in FreeRTOSConfig.h as either 1 or 0.  See the Configuration section of the FreeRTOS API documentation for details.\r
 104 #endif\r
 105 \r
 106 #ifndef INCLUDE_vTaskDelay\r
 107         #error Missing definition:  INCLUDE_vTaskDelay should be defined in FreeRTOSConfig.h as either 1 or 0.  See the Configuration section of the FreeRTOS API documentation for details.\r
 108 #endif\r
 109 \r
 110 #ifndef configUSE_16_BIT_TICKS\r
 111         #error Missing definition:  configUSE_16_BIT_TICKS should be defined in FreeRTOSConfig.h as either 1 or 0.  See the Configuration section of the FreeRTOS API documentation for details.\r
 112 #endif\r
 113 \r
 114 #endif\r