git.sur5r.net Git - freertos/blob

   1 /*\r
   2     FreeRTOS V7.0.1 - Copyright (C) 2011 Real Time Engineers Ltd.\r
   3         \r
   4 \r
   5         FreeRTOS supports many tools and architectures. V7.0.0 is sponsored by:\r
   6         Atollic AB - Atollic provides professional embedded systems development \r
   7         tools for C/C++ development, code analysis and test automation.  \r
   8         See http://www.atollic.com\r
   9         \r
  10 \r
  11     ***************************************************************************\r
  12      *                                                                       *\r
  13      *    FreeRTOS tutorial books are available in pdf and paperback.        *\r
  14      *    Complete, revised, and edited pdf reference manuals are also       *\r
  15      *    available.                                                         *\r
  16      *                                                                       *\r
  17      *    Purchasing FreeRTOS documentation will not only help you, by       *\r
  18      *    ensuring you get running as quickly as possible and with an        *\r
  19      *    in-depth knowledge of how to use FreeRTOS, it will also help       *\r
  20      *    the FreeRTOS project to continue with its mission of providing     *\r
  21      *    professional grade, cross platform, de facto standard solutions    *\r
  22      *    for microcontrollers - completely free of charge!                  *\r
  23      *                                                                       *\r
  24      *    >>> See http://www.FreeRTOS.org/Documentation for details. <<<     *\r
  25      *                                                                       *\r
  26      *    Thank you for using FreeRTOS, and thank you for your support!      *\r
  27      *                                                                       *\r
  28     ***************************************************************************\r
  29 \r
  30 \r
  31     This file is part of the FreeRTOS distribution.\r
  32 \r
  33     FreeRTOS is free software; you can redistribute it and/or modify it under\r
  34     the terms of the GNU General Public License (version 2) as published by the\r
  35     Free Software Foundation AND MODIFIED BY the FreeRTOS exception.\r
  36     >>>NOTE<<< The modification to the GPL is included to allow you to\r
  37     distribute a combined work that includes FreeRTOS without being obliged to\r
  38     provide the source code for proprietary components outside of the FreeRTOS\r
  39     kernel.  FreeRTOS is distributed in the hope that it will be useful, but\r
  40     WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY\r
  41     or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for\r
  42     more details. You should have received a copy of the GNU General Public\r
  43     License and the FreeRTOS license exception along with FreeRTOS; if not it\r
  44     can be viewed here: http://www.freertos.org/a00114.html and also obtained\r
  45     by writing to Richard Barry, contact details for whom are available on the\r
  46     FreeRTOS WEB site.\r
  47 \r
  48     1 tab == 4 spaces!\r
  49 \r
  50     http://www.FreeRTOS.org - Documentation, latest information, license and\r
  51     contact details.\r
  52 \r
  53     http://www.SafeRTOS.com - A version that is certified for use in safety\r
  54     critical systems.\r
  55 \r
  56     http://www.OpenRTOS.com - Commercial support, development, porting,\r
  57     licensing and training services.\r
  58 */\r
  59 \r
  60 #ifndef INC_FREERTOS_H\r
  61 #define INC_FREERTOS_H\r
  62 \r
  63 \r
  64 /*\r
  65  * Include the generic headers required for the FreeRTOS port being used.\r
  66  */\r
  67 #include <stddef.h>\r
  68 \r
  69 /* Basic FreeRTOS definitions. */\r
  70 #include "projdefs.h"\r
  71 \r
  72 /* Application specific configuration options. */\r
  73 #include "FreeRTOSConfig.h"\r
  74 \r
  75 /* Definitions specific to the port being used. */\r
  76 #include "portable.h"\r
  77 \r
  78 \r
  79 /* Defines the prototype to which the application task hook function must\r
  80 conform. */\r
  81 typedef portBASE_TYPE (*pdTASK_HOOK_CODE)( void * );\r
  82 \r
  83 \r
  84 \r
  85 \r
  86 \r
  87 /*\r
  88  * Check all the required application specific macros have been defined.\r
  89  * These macros are application specific and (as downloaded) are defined\r
  90  * within FreeRTOSConfig.h.\r
  91  */\r
  92 \r
  93 #ifndef configUSE_PREEMPTION\r
  94         #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
  95 #endif\r
  96 \r
  97 #ifndef configUSE_IDLE_HOOK\r
  98         #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
  99 #endif\r
 100 \r
 101 #ifndef configUSE_TICK_HOOK\r
 102         #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
 103 #endif\r
 104 \r
 105 #ifndef configUSE_CO_ROUTINES\r
 106         #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
 107 #endif\r
 108 \r
 109 #ifndef INCLUDE_vTaskPrioritySet\r
 110         #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
 111 #endif\r
 112 \r
 113 #ifndef INCLUDE_uxTaskPriorityGet\r
 114         #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
 115 #endif\r
 116 \r
 117 #ifndef INCLUDE_vTaskDelete             \r
 118         #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
 119 #endif\r
 120 \r
 121 #ifndef INCLUDE_vTaskCleanUpResources\r
 122         #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
 123 #endif\r
 124 \r
 125 #ifndef INCLUDE_vTaskSuspend    \r
 126         #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
 127 #endif\r
 128 \r
 129 #ifndef INCLUDE_vTaskDelayUntil\r
 130         #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
 131 #endif\r
 132 \r
 133 #ifndef INCLUDE_vTaskDelay\r
 134         #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
 135 #endif\r
 136 \r
 137 #ifndef configUSE_16_BIT_TICKS\r
 138         #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
 139 #endif\r
 140 \r
 141 #ifndef configUSE_APPLICATION_TASK_TAG\r
 142         #define configUSE_APPLICATION_TASK_TAG 0\r
 143 #endif\r
 144 \r
 145 #ifndef INCLUDE_uxTaskGetStackHighWaterMark\r
 146         #define INCLUDE_uxTaskGetStackHighWaterMark 0\r
 147 #endif\r
 148 \r
 149 #ifndef configUSE_RECURSIVE_MUTEXES\r
 150         #define configUSE_RECURSIVE_MUTEXES 0\r
 151 #endif\r
 152 \r
 153 #ifndef configUSE_MUTEXES\r
 154         #define configUSE_MUTEXES 0\r
 155 #endif\r
 156 \r
 157 #ifndef configUSE_TIMERS\r
 158         #define configUSE_TIMERS 0\r
 159 #endif\r
 160 \r
 161 #ifndef configUSE_COUNTING_SEMAPHORES\r
 162         #define configUSE_COUNTING_SEMAPHORES 0\r
 163 #endif\r
 164 \r
 165 #ifndef configUSE_ALTERNATIVE_API\r
 166         #define configUSE_ALTERNATIVE_API 0\r
 167 #endif\r
 168 \r
 169 #ifndef portCRITICAL_NESTING_IN_TCB\r
 170         #define portCRITICAL_NESTING_IN_TCB 0\r
 171 #endif\r
 172 \r
 173 #ifndef configMAX_TASK_NAME_LEN\r
 174         #define configMAX_TASK_NAME_LEN 16\r
 175 #endif\r
 176 \r
 177 #ifndef configIDLE_SHOULD_YIELD\r
 178         #define configIDLE_SHOULD_YIELD         1\r
 179 #endif\r
 180 \r
 181 #if configMAX_TASK_NAME_LEN < 1\r
 182         #error configMAX_TASK_NAME_LEN must be set to a minimum of 1 in FreeRTOSConfig.h\r
 183 #endif\r
 184 \r
 185 #ifndef INCLUDE_xTaskResumeFromISR\r
 186         #define INCLUDE_xTaskResumeFromISR 1\r
 187 #endif\r
 188 \r
 189 #ifndef configASSERT\r
 190         #define configASSERT( x )\r
 191 #endif\r
 192 \r
 193 /* The timers module relies on xTaskGetSchedulerState(). */\r
 194 #if configUSE_TIMERS == 1\r
 195 \r
 196         #ifndef configTIMER_TASK_PRIORITY\r
 197                 #error If configUSE_TIMERS is set to 1 then configTIMER_TASK_PRIORITY must also be defined.\r
 198         #endif /* configTIMER_TASK_PRIORITY */\r
 199 \r
 200         #ifndef configTIMER_QUEUE_LENGTH\r
 201                 #error If configUSE_TIMERS is set to 1 then configTIMER_QUEUE_LENGTH must also be defined.\r
 202         #endif /* configTIMER_QUEUE_LENGTH */\r
 203 \r
 204         #ifndef configTIMER_TASK_STACK_DEPTH\r
 205                 #error If configUSE_TIMERS is set to 1 then configTIMER_TASK_STACK_DEPTH must also be defined.\r
 206         #endif /* configTIMER_TASK_STACK_DEPTH */\r
 207 \r
 208 #endif /* configUSE_TIMERS */\r
 209 \r
 210 #ifndef INCLUDE_xTaskGetSchedulerState\r
 211         #define INCLUDE_xTaskGetSchedulerState 0\r
 212 #endif\r
 213 \r
 214 #ifndef INCLUDE_xTaskGetCurrentTaskHandle\r
 215         #define INCLUDE_xTaskGetCurrentTaskHandle 0\r
 216 #endif\r
 217 \r
 218 \r
 219 #ifndef portSET_INTERRUPT_MASK_FROM_ISR\r
 220         #define portSET_INTERRUPT_MASK_FROM_ISR() 0\r
 221 #endif\r
 222 \r
 223 #ifndef portCLEAR_INTERRUPT_MASK_FROM_ISR\r
 224         #define portCLEAR_INTERRUPT_MASK_FROM_ISR( uxSavedStatusValue ) ( void ) uxSavedStatusValue\r
 225 #endif\r
 226 \r
 227 \r
 228 #ifndef configQUEUE_REGISTRY_SIZE\r
 229         #define configQUEUE_REGISTRY_SIZE 0U\r
 230 #endif\r
 231 \r
 232 #if ( configQUEUE_REGISTRY_SIZE < 1U )\r
 233         #define vQueueAddToRegistry( xQueue, pcName )\r
 234         #define vQueueUnregisterQueue( xQueue )\r
 235 #endif\r
 236 \r
 237 \r
 238 /* Remove any unused trace macros. */\r
 239 #ifndef traceSTART\r
 240         /* Used to perform any necessary initialisation - for example, open a file\r
 241         into which trace is to be written. */\r
 242         #define traceSTART()\r
 243 #endif\r
 244 \r
 245 #ifndef traceEND\r
 246         /* Use to close a trace, for example close a file into which trace has been\r
 247         written. */\r
 248         #define traceEND()\r
 249 #endif\r
 250 \r
 251 #ifndef traceTASK_SWITCHED_IN\r
 252         /* Called after a task has been selected to run.  pxCurrentTCB holds a pointer\r
 253         to the task control block of the selected task. */\r
 254         #define traceTASK_SWITCHED_IN()\r
 255 #endif\r
 256 \r
 257 #ifndef traceTASK_SWITCHED_OUT\r
 258         /* Called before a task has been selected to run.  pxCurrentTCB holds a pointer\r
 259         to the task control block of the task being switched out. */\r
 260         #define traceTASK_SWITCHED_OUT()\r
 261 #endif\r
 262 \r
 263 #ifndef traceBLOCKING_ON_QUEUE_RECEIVE\r
 264         /* Task is about to block because it cannot read from a\r
 265         queue/mutex/semaphore.  pxQueue is a pointer to the queue/mutex/semaphore\r
 266         upon which the read was attempted.  pxCurrentTCB points to the TCB of the\r
 267         task that attempted the read. */\r
 268         #define traceBLOCKING_ON_QUEUE_RECEIVE( pxQueue )\r
 269 #endif\r
 270 \r
 271 #ifndef traceBLOCKING_ON_QUEUE_SEND\r
 272         /* Task is about to block because it cannot write to a\r
 273         queue/mutex/semaphore.  pxQueue is a pointer to the queue/mutex/semaphore\r
 274         upon which the write was attempted.  pxCurrentTCB points to the TCB of the\r
 275         task that attempted the write. */\r
 276         #define traceBLOCKING_ON_QUEUE_SEND( pxQueue )\r
 277 #endif\r
 278 \r
 279 #ifndef configCHECK_FOR_STACK_OVERFLOW\r
 280         #define configCHECK_FOR_STACK_OVERFLOW 0\r
 281 #endif\r
 282 \r
 283 /* The following event macros are embedded in the kernel API calls. */\r
 284 \r
 285 #ifndef traceQUEUE_CREATE       \r
 286         #define traceQUEUE_CREATE( pxNewQueue )\r
 287 #endif\r
 288 \r
 289 #ifndef traceQUEUE_CREATE_FAILED\r
 290         #define traceQUEUE_CREATE_FAILED()\r
 291 #endif\r
 292 \r
 293 #ifndef traceCREATE_MUTEX\r
 294         #define traceCREATE_MUTEX( pxNewQueue )\r
 295 #endif\r
 296 \r
 297 #ifndef traceCREATE_MUTEX_FAILED\r
 298         #define traceCREATE_MUTEX_FAILED()\r
 299 #endif\r
 300 \r
 301 #ifndef traceGIVE_MUTEX_RECURSIVE\r
 302         #define traceGIVE_MUTEX_RECURSIVE( pxMutex )\r
 303 #endif\r
 304 \r
 305 #ifndef traceGIVE_MUTEX_RECURSIVE_FAILED\r
 306         #define traceGIVE_MUTEX_RECURSIVE_FAILED( pxMutex )\r
 307 #endif\r
 308 \r
 309 #ifndef traceTAKE_MUTEX_RECURSIVE\r
 310         #define traceTAKE_MUTEX_RECURSIVE( pxMutex )\r
 311 #endif\r
 312 \r
 313 #ifndef traceTAKE_MUTEX_RECURSIVE_FAILED\r
 314         #define traceTAKE_MUTEX_RECURSIVE_FAILED( pxMutex )\r
 315 #endif\r
 316 \r
 317 #ifndef traceCREATE_COUNTING_SEMAPHORE\r
 318         #define traceCREATE_COUNTING_SEMAPHORE()\r
 319 #endif\r
 320 \r
 321 #ifndef traceCREATE_COUNTING_SEMAPHORE_FAILED\r
 322         #define traceCREATE_COUNTING_SEMAPHORE_FAILED()\r
 323 #endif\r
 324 \r
 325 #ifndef traceQUEUE_SEND\r
 326         #define traceQUEUE_SEND( pxQueue )\r
 327 #endif\r
 328 \r
 329 #ifndef traceQUEUE_SEND_FAILED\r
 330         #define traceQUEUE_SEND_FAILED( pxQueue )\r
 331 #endif\r
 332 \r
 333 #ifndef traceQUEUE_RECEIVE\r
 334         #define traceQUEUE_RECEIVE( pxQueue )\r
 335 #endif\r
 336 \r
 337 #ifndef traceQUEUE_PEEK\r
 338         #define traceQUEUE_PEEK( pxQueue )\r
 339 #endif\r
 340 \r
 341 #ifndef traceQUEUE_RECEIVE_FAILED\r
 342         #define traceQUEUE_RECEIVE_FAILED( pxQueue )\r
 343 #endif\r
 344 \r
 345 #ifndef traceQUEUE_SEND_FROM_ISR\r
 346         #define traceQUEUE_SEND_FROM_ISR( pxQueue )\r
 347 #endif\r
 348 \r
 349 #ifndef traceQUEUE_SEND_FROM_ISR_FAILED\r
 350         #define traceQUEUE_SEND_FROM_ISR_FAILED( pxQueue )\r
 351 #endif\r
 352 \r
 353 #ifndef traceQUEUE_RECEIVE_FROM_ISR\r
 354         #define traceQUEUE_RECEIVE_FROM_ISR( pxQueue )\r
 355 #endif\r
 356 \r
 357 #ifndef traceQUEUE_RECEIVE_FROM_ISR_FAILED\r
 358         #define traceQUEUE_RECEIVE_FROM_ISR_FAILED( pxQueue )\r
 359 #endif\r
 360 \r
 361 #ifndef traceQUEUE_DELETE\r
 362         #define traceQUEUE_DELETE( pxQueue )\r
 363 #endif\r
 364 \r
 365 #ifndef traceTASK_CREATE\r
 366         #define traceTASK_CREATE( pxNewTCB )\r
 367 #endif\r
 368 \r
 369 #ifndef traceTASK_CREATE_FAILED\r
 370         #define traceTASK_CREATE_FAILED()\r
 371 #endif\r
 372 \r
 373 #ifndef traceTASK_DELETE\r
 374         #define traceTASK_DELETE( pxTaskToDelete )\r
 375 #endif\r
 376 \r
 377 #ifndef traceTASK_DELAY_UNTIL\r
 378         #define traceTASK_DELAY_UNTIL()\r
 379 #endif\r
 380 \r
 381 #ifndef traceTASK_DELAY\r
 382         #define traceTASK_DELAY()\r
 383 #endif\r
 384 \r
 385 #ifndef traceTASK_PRIORITY_SET\r
 386         #define traceTASK_PRIORITY_SET( pxTask, uxNewPriority )\r
 387 #endif\r
 388 \r
 389 #ifndef traceTASK_SUSPEND\r
 390         #define traceTASK_SUSPEND( pxTaskToSuspend )\r
 391 #endif\r
 392 \r
 393 #ifndef traceTASK_RESUME\r
 394         #define traceTASK_RESUME( pxTaskToResume )\r
 395 #endif\r
 396 \r
 397 #ifndef traceTASK_RESUME_FROM_ISR\r
 398         #define traceTASK_RESUME_FROM_ISR( pxTaskToResume )\r
 399 #endif\r
 400 \r
 401 #ifndef traceTASK_INCREMENT_TICK\r
 402         #define traceTASK_INCREMENT_TICK( xTickCount )\r
 403 #endif\r
 404 \r
 405 #ifndef traceTIMER_CREATE\r
 406         #define traceTIMER_CREATE( pxNewTimer )\r
 407 #endif\r
 408 \r
 409 #ifndef traceTIMER_CREATE_FAILED\r
 410         #define traceTIMER_CREATE_FAILED()\r
 411 #endif\r
 412 \r
 413 #ifndef traceTIMER_COMMAND_SEND\r
 414         #define traceTIMER_COMMAND_SEND( xTimer, xMessageID, xMessageValueValue, xReturn )\r
 415 #endif\r
 416 \r
 417 #ifndef traceTIMER_EXPIRED\r
 418         #define traceTIMER_EXPIRED( pxTimer )\r
 419 #endif\r
 420 \r
 421 #ifndef traceTIMER_COMMAND_RECEIVED\r
 422         #define traceTIMER_COMMAND_RECEIVED( pxTimer, xMessageID, xMessageValue )\r
 423 #endif\r
 424 \r
 425 #ifndef configGENERATE_RUN_TIME_STATS\r
 426         #define configGENERATE_RUN_TIME_STATS 0\r
 427 #endif\r
 428 \r
 429 #if ( configGENERATE_RUN_TIME_STATS == 1 )\r
 430 \r
 431         #ifndef portCONFIGURE_TIMER_FOR_RUN_TIME_STATS\r
 432                 #error If configGENERATE_RUN_TIME_STATS is defined then portCONFIGURE_TIMER_FOR_RUN_TIME_STATS must also be defined.  portCONFIGURE_TIMER_FOR_RUN_TIME_STATS should call a port layer function to setup a peripheral timer/counter that can then be used as the run time counter time base.\r
 433         #endif /* portCONFIGURE_TIMER_FOR_RUN_TIME_STATS */\r
 434 \r
 435         #ifndef portGET_RUN_TIME_COUNTER_VALUE\r
 436                 #ifndef portALT_GET_RUN_TIME_COUNTER_VALUE\r
 437                         #error If configGENERATE_RUN_TIME_STATS is defined then either portGET_RUN_TIME_COUNTER_VALUE or portALT_GET_RUN_TIME_COUNTER_VALUE must also be defined.  See the examples provided and the FreeRTOS web site for more information.\r
 438                 #endif /* portALT_GET_RUN_TIME_COUNTER_VALUE */\r
 439         #endif /* portGET_RUN_TIME_COUNTER_VALUE */\r
 440 \r
 441 #endif /* configGENERATE_RUN_TIME_STATS */\r
 442 \r
 443 #ifndef portCONFIGURE_TIMER_FOR_RUN_TIME_STATS\r
 444         #define portCONFIGURE_TIMER_FOR_RUN_TIME_STATS()\r
 445 #endif\r
 446 \r
 447 #ifndef configUSE_MALLOC_FAILED_HOOK\r
 448         #define configUSE_MALLOC_FAILED_HOOK 0\r
 449 #endif\r
 450 \r
 451 #ifndef portPRIVILEGE_BIT\r
 452         #define portPRIVILEGE_BIT ( ( unsigned portBASE_TYPE ) 0x00 )\r
 453 #endif\r
 454 \r
 455 #ifndef portYIELD_WITHIN_API\r
 456         #define portYIELD_WITHIN_API portYIELD\r
 457 #endif\r
 458 \r
 459 #ifndef pvPortMallocAligned\r
 460         #define pvPortMallocAligned( x, puxStackBuffer ) ( ( ( puxStackBuffer ) == NULL ) ? ( pvPortMalloc( ( x ) ) ) : ( puxStackBuffer ) )\r
 461 #endif\r
 462 \r
 463 #ifndef vPortFreeAligned\r
 464         #define vPortFreeAligned( pvBlockToFree ) vPortFree( pvBlockToFree )\r
 465 #endif\r
 466 \r
 467 #endif /* INC_FREERTOS_H */\r
 468 \r