git.sur5r.net Git - freertos/blob - Demo/WIN32-MSVC/FreeRTOSConfig.h

   1 /*\r
   2     FreeRTOS V6.1.0 - Copyright (C) 2010 Real Time Engineers Ltd.\r
   3 \r
   4     ***************************************************************************\r
   5     *                                                                         *\r
   6     * If you are:                                                             *\r
   7     *                                                                         *\r
   8     *    + New to FreeRTOS,                                                   *\r
   9     *    + Wanting to learn FreeRTOS or multitasking in general quickly       *\r
  10     *    + Looking for basic training,                                        *\r
  11     *    + Wanting to improve your FreeRTOS skills and productivity           *\r
  12     *                                                                         *\r
  13     * then take a look at the FreeRTOS books - available as PDF or paperback  *\r
  14     *                                                                         *\r
  15     *        "Using the FreeRTOS Real Time Kernel - a Practical Guide"        *\r
  16     *                  http://www.FreeRTOS.org/Documentation                  *\r
  17     *                                                                         *\r
  18     * A pdf reference manual is also available.  Both are usually delivered   *\r
  19     * to your inbox within 20 minutes to two hours when purchased between 8am *\r
  20     * and 8pm GMT (although please allow up to 24 hours in case of            *\r
  21     * exceptional circumstances).  Thank you for your support!                *\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 exception to the GPL is included to allow you to distribute\r
  31     a combined work that includes FreeRTOS without being obliged to provide the\r
  32     source code for proprietary components outside of the FreeRTOS kernel.\r
  33     FreeRTOS is distributed in the hope that it will be useful, but WITHOUT\r
  34     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\r
  35     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     http://www.FreeRTOS.org - Documentation, latest information, license and\r
  45     contact details.\r
  46 \r
  47     http://www.SafeRTOS.com - A version that is certified for use in safety\r
  48     critical systems.\r
  49 \r
  50     http://www.OpenRTOS.com - Commercial support, development, porting,\r
  51     licensing and training services.\r
  52 */\r
  53 \r
  54 \r
  55 #ifndef FREERTOS_CONFIG_H\r
  56 #define FREERTOS_CONFIG_H\r
  57 \r
  58 /*-----------------------------------------------------------\r
  59  * Application specific definitions.\r
  60  *\r
  61  * These definitions should be adjusted for your particular hardware and\r
  62  * application requirements.\r
  63  *\r
  64  * THESE PARAMETERS ARE DESCRIBED WITHIN THE 'CONFIGURATION' SECTION OF THE\r
  65  * FreeRTOS API DOCUMENTATION AVAILABLE ON THE FreeRTOS.org WEB SITE.\r
  66  *----------------------------------------------------------*/\r
  67 \r
  68 #define configUSE_PREEMPTION                    1\r
  69 #define configUSE_IDLE_HOOK                             1\r
  70 #define configUSE_TICK_HOOK                             0\r
  71 #define configTICK_RATE_HZ                              ( 50 ) /* In this non-real time simulated environment the tick frequency has to be at least a multiple of the Win32 tick frequency, and therefore very slow. */\r
  72 #define configMINIMAL_STACK_SIZE                ( ( unsigned portSHORT ) 50 ) /* In this simulated case, the stack only has to hold one small structure as the real stack is part of the win32 thread. */\r
  73 #define configTOTAL_HEAP_SIZE                   ( ( size_t ) 0 ) /* This parameter has no effect when heap_3.c is included in the project. */\r
  74 #define configMAX_TASK_NAME_LEN                 ( 12 )\r
  75 #define configUSE_TRACE_FACILITY                1\r
  76 #define configUSE_16_BIT_TICKS                  0\r
  77 #define configIDLE_SHOULD_YIELD                 1\r
  78 #define configUSE_CO_ROUTINES                   0\r
  79 #define configUSE_MUTEXES                               1\r
  80 #define configGENERATE_RUN_TIME_STATS   0\r
  81 #define configCHECK_FOR_STACK_OVERFLOW  0\r
  82 #define configUSE_RECURSIVE_MUTEXES             1\r
  83 #define configQUEUE_REGISTRY_SIZE               0\r
  84 #define configUSE_MALLOC_FAILED_HOOK    1\r
  85 #define configUSE_APPLICATION_TASK_TAG  0\r
  86 \r
  87 #define configMAX_PRIORITIES                    ( ( unsigned portBASE_TYPE ) 7 )\r
  88 #define configMAX_CO_ROUTINE_PRIORITIES ( 2 )\r
  89 \r
  90 \r
  91 /* Co-routine definitions. */\r
  92 #define configUSE_CO_ROUTINES           0\r
  93 #define configMAX_CO_ROUTINE_PRIORITIES ( 2 )\r
  94 \r
  95 /* Set the following definitions to 1 to include the API function, or zero\r
  96 to exclude the API function. */\r
  97 \r
  98 #define INCLUDE_vTaskPrioritySet                        1\r
  99 #define INCLUDE_uxTaskPriorityGet                       1\r
 100 #define INCLUDE_vTaskDelete                                     1\r
 101 #define INCLUDE_vTaskCleanUpResources           0\r
 102 #define INCLUDE_vTaskSuspend                            1\r
 103 #define INCLUDE_vTaskDelayUntil                         1\r
 104 #define INCLUDE_vTaskDelay                                      1\r
 105 #define INCLUDE_uxTaskGetStackHighWaterMark     1\r
 106 #define INCLUDE_xTaskGetSchedulerState          1\r
 107 \r
 108 \r
 109 /* When switching threads, Windows does not always seem to run the selected\r
 110 thread immediately.  This function can be called to check if the thread\r
 111 that is currently running is the thread that is responsible for executing\r
 112 the task selected by the real time scheduler.  If not then a yield is performed\r
 113 which will try and force the running thread to block on a semaphore, and hence\r
 114 allow the thread that should be running to take over.  The trace macros are a\r
 115 convenient way of lacing the code with these checking calls. */\r
 116 void vPortCheckCorrectThreadIsRunning( void );\r
 117 \r
 118 #define traceBLOCKING_ON_QUEUE_RECEIVE(pxQueue)                 vPortCheckCorrectThreadIsRunning();(void)pxQueue\r
 119 #define traceBLOCKING_ON_QUEUE_SEND(pxQueue)                    vPortCheckCorrectThreadIsRunning();(void)pxQueue\r
 120 #define traceGIVE_MUTEX_RECURSIVE(pxMutex)                              vPortCheckCorrectThreadIsRunning();(void)pxMutex\r
 121 #define traceQUEUE_CREATE(pxNewQueue)                                   vPortCheckCorrectThreadIsRunning();(void)pxNewQueue\r
 122 #define traceQUEUE_CREATE_FAILED()                                              vPortCheckCorrectThreadIsRunning()\r
 123 #define traceCREATE_MUTEX(pxNewMutex)                                   vPortCheckCorrectThreadIsRunning();(void)pxNewMutex\r
 124 #define traceCREATE_MUTEX_FAILED()                                              vPortCheckCorrectThreadIsRunning()\r
 125 #define traceGIVE_MUTEX_RECURSIVE(pxMutex)                              vPortCheckCorrectThreadIsRunning();(void)pxMutex\r
 126 #define traceGIVE_MUTEX_RECURSIVE_FAILED(pxMutex)               vPortCheckCorrectThreadIsRunning();(void)pxMutex\r
 127 #define traceTAKE_MUTEX_RECURSIVE(pxMutex)                              vPortCheckCorrectThreadIsRunning();(void)pxMutex\r
 128 #define traceTAKE_MUTEX_RECURSIVE_FAILED(pxMutex)               vPortCheckCorrectThreadIsRunning();(void)pxMutex\r
 129 #define traceCREATE_COUNTING_SEMAPHORE()                                vPortCheckCorrectThreadIsRunning()\r
 130 #define traceCREATE_COUNTING_SEMAPHORE_FAILED()                 vPortCheckCorrectThreadIsRunning()\r
 131 #define traceQUEUE_SEND(pxQueue)                                                vPortCheckCorrectThreadIsRunning();(void)pxQueue\r
 132 #define traceQUEUE_SEND_FAILED(pxQueue)                                 vPortCheckCorrectThreadIsRunning();(void)pxQueue\r
 133 #define traceQUEUE_RECEIVE(pxQueue)                                             vPortCheckCorrectThreadIsRunning();(void)pxQueue\r
 134 #define traceQUEUE_RECEIVE_FAILED(pxQueue)                              vPortCheckCorrectThreadIsRunning();(void)pxQueue\r
 135 #define traceQUEUE_PEEK(pxQueue)                                                vPortCheckCorrectThreadIsRunning();(void)pxQueue\r
 136 #define traceQUEUE_SEND_FROM_ISR(pxQueue)                               vPortCheckCorrectThreadIsRunning();(void)pxQueue\r
 137 #define traceQUEUE_SEND_FROM_ISR_FAILED(pxQueue)                vPortCheckCorrectThreadIsRunning();(void)pxQueue\r
 138 #define traceQUEUE_RECEIVE_FROM_ISR(pxQueue)                    vPortCheckCorrectThreadIsRunning();(void)pxQueue\r
 139 #define traceQUEUE_RECEIVE_FROM_ISR_FAILED(pxQueue)             vPortCheckCorrectThreadIsRunning();(void)pxQueue\r
 140 #define traceQUEUE_DELETE(pxQueue)                                              vPortCheckCorrectThreadIsRunning();(void)pxQueue\r
 141 #define traceTASK_CREATE(pxTask)                                                vPortCheckCorrectThreadIsRunning();(void)pxTask\r
 142 #define traceTASK_CREATE_FAILED(pxNewTCB)                               vPortCheckCorrectThreadIsRunning();(void)pxNewTCB\r
 143 #define traceTASK_DELETE(pxTask)                                                vPortCheckCorrectThreadIsRunning();(void)pxTask\r
 144 #define traceTASK_DELAY_UNTIL()                                                 vPortCheckCorrectThreadIsRunning()\r
 145 #define traceTASK_DELAY()                                                               vPortCheckCorrectThreadIsRunning()\r
 146 #define traceTASK_PRIORITY_SET(pxTask,uxNewPriority)    vPortCheckCorrectThreadIsRunning();(void)pxTask;(void)uxNewPriority\r
 147 #define traceTASK_SUSPEND(pxTask)                                               vPortCheckCorrectThreadIsRunning();(void)pxTask\r
 148 #define traceTASK_RESUME(pxTask)                                                vPortCheckCorrectThreadIsRunning();(void)pxTask\r
 149 #define traceTASK_RESUME_FROM_ISR(pxTask)                               vPortCheckCorrectThreadIsRunning();(void)pxTask\r
 150 \r
 151 \r
 152 #endif /* FREERTOS_CONFIG_H */\r