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

   1 /*\r
   2         FreeRTOS.org V4.0.4 - Copyright (C) 2003-2006 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 */\r
  32 \r
  33 #ifndef INC_FREERTOS_H\r
  34 #define INC_FREERTOS_H\r
  35 \r
  36 \r
  37 /* \r
  38  * Include the generic headers required for the FreeRTOS port being used. \r
  39  */\r
  40 #include <stddef.h>\r
  41 \r
  42 /* Basic FreeRTOS definitions. */\r
  43 #include "projdefs.h"\r
  44 \r
  45 /* Application specific configuration options. */\r
  46 #include "FreeRTOSConfig.h"\r
  47 \r
  48 /* Definitions specific to the port being used. */\r
  49 #include "portable.h"\r
  50 \r
  51 \r
  52 \r
  53 \r
  54 \r
  55 \r
  56 \r
  57 /*\r
  58  * Check all the required application specific macros have been defined. \r
  59  * These macros are application specific and (as downloaded) are defined\r
  60  * within FreeRTOSConfig.h.\r
  61  */\r
  62 \r
  63 #ifndef configUSE_PREEMPTION\r
  64         #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
  65 #endif\r
  66 \r
  67 #ifndef configUSE_IDLE_HOOK\r
  68         #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
  69 #endif\r
  70 \r
  71 #ifndef configUSE_TICK_HOOK\r
  72         #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
  73 #endif\r
  74 \r
  75 #ifndef configUSE_CO_ROUTINES\r
  76         #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
  77 #endif\r
  78 \r
  79 #ifndef INCLUDE_vTaskPrioritySet\r
  80         #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
  81 #endif\r
  82 \r
  83 #ifndef INCLUDE_uxTaskPriorityGet\r
  84         #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
  85 #endif\r
  86 \r
  87 #ifndef INCLUDE_vTaskDelete             \r
  88         #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
  89 #endif\r
  90 \r
  91 #ifndef INCLUDE_vTaskCleanUpResources\r
  92         #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
  93 #endif\r
  94 \r
  95 #ifndef INCLUDE_vTaskSuspend    \r
  96         #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
  97 #endif\r
  98 \r
  99 #ifndef INCLUDE_vTaskDelayUntil\r
 100         #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
 101 #endif\r
 102 \r
 103 #ifndef INCLUDE_vTaskDelay\r
 104         #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
 105 #endif\r
 106 \r
 107 #ifndef configUSE_16_BIT_TICKS\r
 108         #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
 109 #endif\r
 110 \r
 111 #endif\r