git.sur5r.net Git - freertos/blob - FreeRTOS/Demo/CORTEX_M4F_M0_LPC43xx_Keil/M4/main.c

   1 /*\r
   2     FreeRTOS V7.3.0 - Copyright (C) 2012 Real Time Engineers Ltd.\r
   3 \r
   4     FEATURES AND PORTS ARE ADDED TO FREERTOS ALL THE TIME.  PLEASE VISIT \r
   5     http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.\r
   6 \r
   7     ***************************************************************************\r
   8      *                                                                       *\r
   9      *    FreeRTOS tutorial books are available in pdf and paperback.        *\r
  10      *    Complete, revised, and edited pdf reference manuals are also       *\r
  11      *    available.                                                         *\r
  12      *                                                                       *\r
  13      *    Purchasing FreeRTOS documentation will not only help you, by       *\r
  14      *    ensuring you get running as quickly as possible and with an        *\r
  15      *    in-depth knowledge of how to use FreeRTOS, it will also help       *\r
  16      *    the FreeRTOS project to continue with its mission of providing     *\r
  17      *    professional grade, cross platform, de facto standard solutions    *\r
  18      *    for microcontrollers - completely free of charge!                  *\r
  19      *                                                                       *\r
  20      *    >>> See http://www.FreeRTOS.org/Documentation for details. <<<     *\r
  21      *                                                                       *\r
  22      *    Thank you for using FreeRTOS, and thank you for your support!      *\r
  23      *                                                                       *\r
  24     ***************************************************************************\r
  25 \r
  26 \r
  27     This file is part of the FreeRTOS distribution.\r
  28 \r
  29     FreeRTOS is free software; you can redistribute it and/or modify it under\r
  30     the terms of the GNU General Public License (version 2) as published by the\r
  31     Free Software Foundation AND MODIFIED BY the FreeRTOS exception.\r
  32     >>>NOTE<<< The modification to the GPL is included to allow you to\r
  33     distribute a combined work that includes FreeRTOS without being obliged to\r
  34     provide the source code for proprietary components outside of the FreeRTOS\r
  35     kernel.  FreeRTOS is distributed in the hope that it will be useful, but\r
  36     WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY\r
  37     or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for\r
  38     more details. You should have received a copy of the GNU General Public\r
  39     License and the FreeRTOS license exception along with FreeRTOS; if not it\r
  40     can be viewed here: http://www.freertos.org/a00114.html and also obtained\r
  41     by writing to Richard Barry, contact details for whom are available on the\r
  42     FreeRTOS WEB site.\r
  43 \r
  44     1 tab == 4 spaces!\r
  45     \r
  46     ***************************************************************************\r
  47      *                                                                       *\r
  48      *    Having a problem?  Start by reading the FAQ "My application does   *\r
  49      *    not run, what could be wrong?"                                     *\r
  50      *                                                                       *\r
  51      *    http://www.FreeRTOS.org/FAQHelp.html                               *\r
  52      *                                                                       *\r
  53     ***************************************************************************\r
  54 \r
  55     \r
  56     http://www.FreeRTOS.org - Documentation, training, latest versions, license \r
  57     and contact details.  \r
  58     \r
  59     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
  60     including FreeRTOS+Trace - an indispensable productivity tool.\r
  61 \r
  62     Real Time Engineers ltd license FreeRTOS to High Integrity Systems, who sell \r
  63     the code with commercial support, indemnification, and middleware, under \r
  64     the OpenRTOS brand: http://www.OpenRTOS.com.  High Integrity Systems also\r
  65     provide a safety engineered and independently SIL3 certified version under \r
  66     the SafeRTOS brand: http://www.SafeRTOS.com.\r
  67 */\r
  68 \r
  69 /******************************************************************************\r
  70  * >>>>>> NOTE 1: <<<<<<\r
  71  *\r
  72  * main() can be configured to create either a very simple LED flasher demo, or\r
  73  * a more comprehensive test/demo application.\r
  74  *\r
  75  * To create a very simple LED flasher example, set the\r
  76  * mainCREATE_SIMPLE_LED_FLASHER_DEMO_ONLY constant (defined below) to 1.  When\r
  77  * this is done, only the standard demo flash tasks are created.  The standard\r
  78  * demo flash example creates three tasks, each of which toggle an LED at a\r
  79  * fixed but different frequency.\r
  80  *\r
  81  * To create a more comprehensive test and demo application, set\r
  82  * mainCREATE_SIMPLE_LED_FLASHER_DEMO_ONLY to 0.\r
  83  ******************************************************************************\r
  84  *\r
  85  * main() creates all the demo application tasks and software timers, then starts\r
  86  * the scheduler.  The web documentation provides more details of the standard\r
  87  * demo application tasks, which provide no particular functionality, but do\r
  88  * provide a good example of how to use the FreeRTOS API.\r
  89  *\r
  90  * In addition to the standard demo tasks, the following tasks and tests are\r
  91  * defined and/or created within this file:\r
  92  *\r
  93  * "Reg test" tasks - These fill both the core and floating point registers with\r
  94  * known values, then check that each register maintains its expected value for\r
  95  * the lifetime of the task.  Each task uses a different set of values.  The reg\r
  96  * test tasks execute with a very low priority, so get preempted very\r
  97  * frequently.  A register containing an unexpected value is indicative of an\r
  98  * error in the context switching mechanism.\r
  99  *\r
 100  * "Check" timer - The check software timer period is initially set to three\r
 101  * seconds.  The callback function associated with the check software timer\r
 102  * checks that all the standard demo tasks, and the register check tasks, are\r
 103  * not only still executing, but are executing without reporting any errors.  If\r
 104  * the check software timer discovers that a task has either stalled, or\r
 105  * reported an error, then it changes its own execution period from the initial\r
 106  * three seconds, to just 200ms.  The check software timer callback function\r
 107  * also toggles an LED each time it is called.  This provides a visual\r
 108  * indication of the system status:  If the LED toggles every three seconds,\r
 109  * then no issues have been discovered.  If the LED toggles every 200ms, then\r
 110  * an issue has been discovered with at least one task.\r
 111  */\r
 112 \r
 113 /* Standard includes. */\r
 114 #include <stdio.h>\r
 115 \r
 116 /* Kernel includes. */\r
 117 #include "FreeRTOS.h"\r
 118 #include "task.h"\r
 119 #include "timers.h"\r
 120 #include "semphr.h"\r
 121 \r
 122 /* Demo application includes. */\r
 123 #include "partest.h"\r
 124 #include "flash.h"\r
 125 #include "flop.h"\r
 126 #include "integer.h"\r
 127 #include "PollQ.h"\r
 128 #include "semtest.h"\r
 129 #include "dynamic.h"\r
 130 #include "BlockQ.h"\r
 131 #include "blocktim.h"\r
 132 #include "countsem.h"\r
 133 #include "GenQTest.h"\r
 134 #include "recmutex.h"\r
 135 #include "death.h"\r
 136 \r
 137 /* Hardware includes. */\r
 138 #include "platform_config.h"\r
 139 \r
 140 /* Priorities for the demo application tasks. */\r
 141 #define mainFLASH_TASK_PRIORITY                         ( tskIDLE_PRIORITY + 1UL )\r
 142 #define mainQUEUE_POLL_PRIORITY                         ( tskIDLE_PRIORITY + 2UL )\r
 143 #define mainSEM_TEST_PRIORITY                           ( tskIDLE_PRIORITY + 1UL )\r
 144 #define mainBLOCK_Q_PRIORITY                            ( tskIDLE_PRIORITY + 2UL )\r
 145 #define mainCREATOR_TASK_PRIORITY                       ( tskIDLE_PRIORITY + 3UL )\r
 146 #define mainFLOP_TASK_PRIORITY                          ( tskIDLE_PRIORITY )\r
 147 \r
 148 /* The LED used by the check timer. */\r
 149 #define mainCHECK_LED                                           ( 3UL )\r
 150 \r
 151 /* A block time of zero simply means "don't block". */\r
 152 #define mainDONT_BLOCK                                          ( 0UL )\r
 153 \r
 154 /* The period after which the check timer will expire, in ms, provided no errors\r
 155 have been reported by any of the standard demo tasks.  ms are converted to the\r
 156 equivalent in ticks using the portTICK_RATE_MS constant. */\r
 157 #define mainCHECK_TIMER_PERIOD_MS                       ( 3000UL / portTICK_RATE_MS )\r
 158 \r
 159 /* The period at which the check timer will expire, in ms, if an error has been\r
 160 reported in one of the standard demo tasks.  ms are converted to the equivalent\r
 161 in ticks using the portTICK_RATE_MS constant. */\r
 162 #define mainERROR_CHECK_TIMER_PERIOD_MS         ( 200UL / portTICK_RATE_MS )\r
 163 \r
 164 /* Set mainCREATE_SIMPLE_LED_FLASHER_DEMO_ONLY to 1 to create a simple demo.\r
 165 Set mainCREATE_SIMPLE_LED_FLASHER_DEMO_ONLY to 0 to create a much more\r
 166 comprehensive test application.  See the comments at the top of this file, and\r
 167 the documentation page on the http://www.FreeRTOS.org web site for more\r
 168 information. */\r
 169 #define mainCREATE_SIMPLE_LED_FLASHER_DEMO_ONLY         0\r
 170 \r
 171 /*-----------------------------------------------------------*/\r
 172 \r
 173 /*\r
 174  * Set up the hardware ready to run this demo.\r
 175  */\r
 176 static void prvSetupHardware( void );\r
 177 \r
 178 /*\r
 179  * The check timer callback function, as described at the top of this file.\r
 180  */\r
 181 static void prvCheckTimerCallback( xTimerHandle xTimer );\r
 182 \r
 183 /*\r
 184  * Register check tasks, and the tasks used to write over and check the contents\r
 185  * of the FPU registers, as described at the top of this file.  The nature of\r
 186  * these files necessitates that they are written in an assembly file.\r
 187  */\r
 188 extern void vRegTest1Task( void *pvParameters );\r
 189 extern void vRegTest2Task( void *pvParameters );\r
 190 extern void vRegTestClearFlopRegistersToParameterValue( unsigned long ulValue );\r
 191 extern unsigned long ulRegTestCheckFlopRegistersContainParameterValue( unsigned long ulValue );\r
 192 \r
 193 /*\r
 194  * This file can be used to create either a simple LED flasher example, or a\r
 195  * comprehensive test/demo application - depending on the setting of the\r
 196  * mainCREATE_SIMPLE_LED_FLASHER_DEMO_ONLY constant defined above.  If\r
 197  * mainCREATE_SIMPLE_LED_FLASHER_DEMO_ONLY is set to 1, then the following\r
 198  * function will create a lot of additional tasks and a software timer.  If\r
 199  * mainCREATE_SIMPLE_LED_FLASHER_DEMO_ONLY is set to 0, then the following\r
 200  * function will do nothing.\r
 201  */\r
 202 static void prvOptionallyCreateComprehensveTestApplication( void );\r
 203 \r
 204 /*-----------------------------------------------------------*/\r
 205 \r
 206 /* The following two variables are used to communicate the status of the\r
 207 register check tasks to the check software timer.  If the variables keep\r
 208 incrementing, then the register check tasks has not discovered any errors.  If\r
 209 a variable stops incrementing, then an error has been found. */\r
 210 volatile unsigned long ulRegTest1LoopCounter = 0UL, ulRegTest2LoopCounter = 0UL;\r
 211 \r
 212 /*-----------------------------------------------------------*/\r
 213 \r
 214 int main( void )\r
 215 {\r
 216         /* Configure the hardware ready to run the test. */\r
 217         prvSetupHardware();\r
 218 \r
 219         /* Start standard demo/test application flash tasks.  See the comments at\r
 220         the top of this file.  The LED flash tasks are always created.  The other\r
 221         tasks are only created if mainCREATE_SIMPLE_LED_FLASHER_DEMO_ONLY is set to\r
 222         0 (at the top of this file).  See the comments at the top of this file for\r
 223         more information. */\r
 224         vStartLEDFlashTasks( mainFLASH_TASK_PRIORITY );\r
 225 \r
 226         /* The following function will only create more tasks and timers if\r
 227         mainCREATE_SIMPLE_LED_FLASHER_DEMO_ONLY is set to 0 (at the top of this\r
 228         file).  See the comments at the top of this file for more information. */\r
 229         prvOptionallyCreateComprehensveTestApplication();\r
 230 \r
 231         /* Start the scheduler. */\r
 232         vTaskStartScheduler();\r
 233         \r
 234         /* Infinite loop */\r
 235         for( ;; );      \r
 236 }\r
 237 /*-----------------------------------------------------------*/\r
 238 \r
 239 static void prvCheckTimerCallback( xTimerHandle xTimer )\r
 240 {\r
 241 static long lChangedTimerPeriodAlready = pdFALSE;\r
 242 static unsigned long ulLastRegTest1Value = 0, ulLastRegTest2Value = 0;\r
 243 unsigned long ulErrorFound = pdFALSE;\r
 244 \r
 245         /* Check all the demo tasks (other than the flash tasks) to ensure\r
 246         that they are all still running, and that none have detected an error. */\r
 247 \r
 248         if( xAreMathsTaskStillRunning() != pdTRUE )\r
 249         {\r
 250                 ulErrorFound |= 0x01UL << 0UL;\r
 251         }\r
 252 \r
 253         if( xAreIntegerMathsTaskStillRunning() != pdTRUE )\r
 254         {\r
 255                 ulErrorFound |= 0x01UL << 1UL;\r
 256         }\r
 257 \r
 258         if( xAreDynamicPriorityTasksStillRunning() != pdTRUE )\r
 259         {\r
 260                 ulErrorFound |= 0x01UL << 2UL;\r
 261         }\r
 262 \r
 263         if( xAreBlockingQueuesStillRunning() != pdTRUE )\r
 264         {\r
 265                 ulErrorFound |= 0x01UL << 3UL;\r
 266         }\r
 267 \r
 268         if ( xAreBlockTimeTestTasksStillRunning() != pdTRUE )\r
 269         {\r
 270                 ulErrorFound |= 0x01UL << 4UL;\r
 271         }\r
 272 \r
 273         if ( xAreGenericQueueTasksStillRunning() != pdTRUE )\r
 274         {\r
 275                 ulErrorFound |= 0x01UL << 5UL;\r
 276         }\r
 277 \r
 278         if ( xAreRecursiveMutexTasksStillRunning() != pdTRUE )\r
 279         {\r
 280                 ulErrorFound |= 0x01UL << 6UL;\r
 281         }\r
 282 \r
 283         if( xIsCreateTaskStillRunning() != pdTRUE )\r
 284         {\r
 285                 ulErrorFound |= 0x01UL << 7UL;\r
 286         }\r
 287 \r
 288         if( xArePollingQueuesStillRunning() != pdTRUE )\r
 289         {\r
 290                 ulErrorFound |= 0x01UL << 8UL;\r
 291         }\r
 292 \r
 293         if( xAreSemaphoreTasksStillRunning() != pdTRUE )\r
 294         {\r
 295                 ulErrorFound |= 0x01UL << 9UL;\r
 296         }\r
 297         \r
 298         /* Check that the register test 1 task is still running. */\r
 299         if( ulLastRegTest1Value == ulRegTest1LoopCounter )\r
 300         {\r
 301                 ulErrorFound |= 0x01UL << 10UL;\r
 302         }\r
 303         ulLastRegTest1Value = ulRegTest1LoopCounter;\r
 304 \r
 305         /* Check that the register test 2 task is still running. */\r
 306         if( ulLastRegTest2Value == ulRegTest2LoopCounter )\r
 307         {\r
 308                 ulErrorFound |= 0x01UL << 11UL;\r
 309         }\r
 310         ulLastRegTest2Value = ulRegTest2LoopCounter;\r
 311 \r
 312         /* Toggle the check LED to give an indication of the system status.  If\r
 313         the LED toggles every mainCHECK_TIMER_PERIOD_MS milliseconds then\r
 314         everything is ok.  A faster toggle indicates an error. */\r
 315         vParTestToggleLED( mainCHECK_LED );     \r
 316         \r
 317         /* Have any errors been latch in ulErrorFound?  If so, shorten the\r
 318         period of the check timer to mainERROR_CHECK_TIMER_PERIOD_MS milliseconds.\r
 319         This will result in an increase in the rate at which mainCHECK_LED\r
 320         toggles. */\r
 321         if( ulErrorFound != pdFALSE )\r
 322         {\r
 323                 if( lChangedTimerPeriodAlready == pdFALSE )\r
 324                 {\r
 325                         lChangedTimerPeriodAlready = pdTRUE;\r
 326                         \r
 327                         /* This call to xTimerChangePeriod() uses a zero block time.\r
 328                         Functions called from inside of a timer callback function must\r
 329                         *never* attempt to block. */\r
 330                         xTimerChangePeriod( xTimer, ( mainERROR_CHECK_TIMER_PERIOD_MS ), mainDONT_BLOCK );\r
 331                 }\r
 332         }\r
 333 }\r
 334 /*-----------------------------------------------------------*/\r
 335 \r
 336 static void prvSetupHardware( void )\r
 337 {\r
 338 extern void Hitex_CGU_Init( void );\r
 339 \r
 340         /* Setup system (clock, PLL and Flash configuration) */\r
 341         platformInit();\r
 342 \r
 343         /* Wind the clock speed up in steps to its maximum. */\r
 344         Hitex_CGU_Init();\r
 345         \r
 346         /* Ensure all priority bits are assigned as preemption priority bits. */\r
 347         NVIC_SetPriorityGrouping( 0 );\r
 348         \r
 349         /* Setup the LED outputs. */\r
 350         vParTestInitialise();\r
 351 }\r
 352 /*-----------------------------------------------------------*/\r
 353 \r
 354 static void prvOptionallyCreateComprehensveTestApplication( void )\r
 355 {\r
 356         #if ( mainCREATE_SIMPLE_LED_FLASHER_DEMO_ONLY == 0 )\r
 357         {\r
 358         xTimerHandle xCheckTimer = NULL;\r
 359 \r
 360                 /* Start all the other standard demo/test tasks. */\r
 361                 vStartIntegerMathTasks( tskIDLE_PRIORITY );\r
 362                 vStartDynamicPriorityTasks();\r
 363                 vStartBlockingQueueTasks( mainBLOCK_Q_PRIORITY );\r
 364                 vCreateBlockTimeTasks();\r
 365                 vStartCountingSemaphoreTasks();\r
 366                 vStartGenericQueueTasks( tskIDLE_PRIORITY );\r
 367                 vStartRecursiveMutexTasks();\r
 368                 vStartPolledQueueTasks( mainQUEUE_POLL_PRIORITY );\r
 369                 vStartSemaphoreTasks( mainSEM_TEST_PRIORITY );\r
 370 \r
 371                 /* Most importantly, start the tasks that use the FPU. */\r
 372                 vStartMathTasks( mainFLOP_TASK_PRIORITY );\r
 373                 \r
 374                 /* Create the register check tasks, as described at the top of this\r
 375                 file */\r
 376                 xTaskCreate( vRegTest1Task, ( signed char * ) "Reg1", configMINIMAL_STACK_SIZE, ( void * ) NULL, tskIDLE_PRIORITY, NULL );\r
 377                 xTaskCreate( vRegTest2Task, ( signed char * ) "Reg2", configMINIMAL_STACK_SIZE, ( void * ) NULL, tskIDLE_PRIORITY, NULL );\r
 378 \r
 379                 /* Create the software timer that performs the 'check' functionality,\r
 380                 as described at the top of this file. */\r
 381                 xCheckTimer = xTimerCreate( ( const signed char * ) "CheckTimer",/* A text name, purely to help debugging. */\r
 382                                                                         ( mainCHECK_TIMER_PERIOD_MS ),          /* The timer period, in this case 3000ms (3s). */\r
 383                                                                         pdTRUE,                                                         /* This is an auto-reload timer, so xAutoReload is set to pdTRUE. */\r
 384                                                                         ( void * ) 0,                                           /* The ID is not used, so can be set to anything. */\r
 385                                                                         prvCheckTimerCallback                           /* The callback function that inspects the status of all the other tasks. */\r
 386                                                                   );    \r
 387                 \r
 388                 if( xCheckTimer != NULL )\r
 389                 {\r
 390                         xTimerStart( xCheckTimer, mainDONT_BLOCK );\r
 391                 }\r
 392 \r
 393                 /* This task has to be created last as it keeps account of the number of\r
 394                 tasks it expects to see running. */\r
 395                 vCreateSuicidalTasks( mainCREATOR_TASK_PRIORITY );\r
 396         }\r
 397         #else /* mainCREATE_SIMPLE_LED_FLASHER_DEMO_ONLY */\r
 398         {\r
 399                 /* Just to prevent compiler warnings when the configuration options are\r
 400                 set such that these static functions are not used. */\r
 401                 ( void ) vRegTest1Task;\r
 402                 ( void ) vRegTest2Task;\r
 403                 ( void ) prvCheckTimerCallback;\r
 404                 ( void ) prvSetupNestedFPUInterruptsTest;\r
 405         }\r
 406         #endif /* mainCREATE_SIMPLE_LED_FLASHER_DEMO_ONLY */\r
 407 }\r
 408 /*-----------------------------------------------------------*/\r
 409 \r
 410 void vApplicationMallocFailedHook( void )\r
 411 {\r
 412         /* vApplicationMallocFailedHook() will only be called if\r
 413         configUSE_MALLOC_FAILED_HOOK is set to 1 in FreeRTOSConfig.h.  It is a hook\r
 414         function that will get called if a call to pvPortMalloc() fails.\r
 415         pvPortMalloc() is called internally by the kernel whenever a task, queue,\r
 416         timer or semaphore is created.  It is also called by various parts of the\r
 417         demo application.  If heap_1.c or heap_2.c are used, then the size of the\r
 418         heap available to pvPortMalloc() is defined by configTOTAL_HEAP_SIZE in\r
 419         FreeRTOSConfig.h, and the xPortGetFreeHeapSize() API function can be used\r
 420         to query the size of free heap space that remains (although it does not\r
 421         provide information on how the remaining heap might be fragmented). */\r
 422         taskDISABLE_INTERRUPTS();\r
 423         for( ;; );\r
 424 }\r
 425 /*-----------------------------------------------------------*/\r
 426 \r
 427 void vApplicationIdleHook( void )\r
 428 {\r
 429         /* vApplicationIdleHook() will only be called if configUSE_IDLE_HOOK is set\r
 430         to 1 in FreeRTOSConfig.h.  It will be called on each iteration of the idle\r
 431         task.  It is essential that code added to this hook function never attempts\r
 432         to block in any way (for example, call xQueueReceive() with a block time\r
 433         specified, or call vTaskDelay()).  If the application makes use of the\r
 434         vTaskDelete() API function (as this demo application does) then it is also\r
 435         important that vApplicationIdleHook() is permitted to return to its calling\r
 436         function, because it is the responsibility of the idle task to clean up\r
 437         memory allocated by the kernel to any task that has since been deleted. */\r
 438 }\r
 439 /*-----------------------------------------------------------*/\r
 440 \r
 441 void vApplicationStackOverflowHook( xTaskHandle pxTask, signed char *pcTaskName )\r
 442 {\r
 443         ( void ) pcTaskName;\r
 444         ( void ) pxTask;\r
 445 \r
 446         /* Run time stack overflow checking is performed if\r
 447         configCHECK_FOR_STACK_OVERFLOW is defined to 1 or 2.  This hook\r
 448         function is called if a stack overflow is detected. */\r
 449         taskDISABLE_INTERRUPTS();\r
 450         for( ;; );\r
 451 }\r
 452 /*-----------------------------------------------------------*/\r
 453 \r
 454 void vApplicationTickHook( void )\r
 455 {\r
 456         /* This function will be called by each tick interrupt if \r
 457         configUSE_TICK_HOOK is set to 1 in FreeRTOSConfig.h.  User code can be\r
 458         added here, but the tick hook is called from an interrupt context, so\r
 459         code must not attempt to block, and only the interrupt safe FreeRTOS API\r
 460         functions can be used (those that end in FromISR()). */\r
 461 }\r
 462 /*-----------------------------------------------------------*/\r