git.sur5r.net Git - freertos/blob - FreeRTOS/Demo/RL78_E2Studio_GCC/src/main.c

   1 /*\r
   2     FreeRTOS V7.4.0 - Copyright (C) 2013 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 \r
  33     >>>>>>NOTE<<<<<< The modification to the GPL is included to allow you to\r
  34     distribute a combined work that includes FreeRTOS without being obliged to\r
  35     provide the source code for proprietary components outside of the FreeRTOS\r
  36     kernel.\r
  37 \r
  38     FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY\r
  39     WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS\r
  40     FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more\r
  41     details. You should have received a copy of the GNU General Public License\r
  42     and the FreeRTOS license exception along with FreeRTOS; if not itcan be\r
  43     viewed here: http://www.freertos.org/a00114.html and also obtained by\r
  44     writing to Real Time Engineers Ltd., contact details for whom are available\r
  45     on the FreeRTOS WEB site.\r
  46 \r
  47     1 tab == 4 spaces!\r
  48 \r
  49     ***************************************************************************\r
  50      *                                                                       *\r
  51      *    Having a problem?  Start by reading the FAQ "My application does   *\r
  52      *    not run, what could be wrong?"                                     *\r
  53      *                                                                       *\r
  54      *    http://www.FreeRTOS.org/FAQHelp.html                               *\r
  55      *                                                                       *\r
  56     ***************************************************************************\r
  57 \r
  58 \r
  59     http://www.FreeRTOS.org - Documentation, books, training, latest versions,\r
  60     license and Real Time Engineers Ltd. contact details.\r
  61 \r
  62     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
  63     including FreeRTOS+Trace - an indispensable productivity tool, and our new\r
  64     fully thread aware and reentrant UDP/IP stack.\r
  65 \r
  66     http://www.OpenRTOS.com - Real Time Engineers ltd license FreeRTOS to High\r
  67     Integrity Systems, who sell the code with commercial support,\r
  68     indemnification and middleware, under the OpenRTOS brand.\r
  69 \r
  70     http://www.SafeRTOS.com - High Integrity Systems also provide a safety\r
  71     engineered and independently SIL3 certified version for use in safety and\r
  72     mission critical applications that require provable dependability.\r
  73 */\r
  74 \r
  75 /*\r
  76  *\r
  77  * ENSURE TO READ THE DOCUMENTATION PAGE FOR THIS PORT AND DEMO APPLICATION ON\r
  78  * THE http://www.FreeRTOS.org WEB SITE FOR FULL INFORMATION ON USING THIS DEMO\r
  79  * APPLICATION, AND ITS ASSOCIATE FreeRTOS ARCHITECTURE PORT!\r
  80  *\r
  81  *\r
  82  * main() creates the demo application tasks and timers, then starts the\r
  83  * scheduler.\r
  84  *\r
  85  * This demo is configured to run on the RL78/G13 Promotion Board, which is\r
  86  * fitted with a R5F100LEA microcontroller.  The R5F100LEA contains a little\r
  87  * under 4K bytes of usable internal RAM.  The RAM size restricts the number of\r
  88  * demo tasks that can be created, and the demo creates 13 tasks, 4 queues and\r
  89  * two timers.  The RL78 range does however include parts with up to 32K bytes\r
  90  * of RAM (at the time of writing).  Using FreeRTOS on such a part will allow an\r
  91  * application to make a more comprehensive use of FreeRTOS tasks, and other\r
  92  * FreeRTOS features.\r
  93  *\r
  94  * In addition to the standard demo tasks, the following tasks, tests and timers\r
  95  * are created within this file:\r
  96  *\r
  97  * "Reg test" tasks - These fill the registers with known values, then check\r
  98  * that each register still contains its expected value.  Each task uses a\r
  99  * different set of values.  The reg test tasks execute with a very low priority,\r
 100  * so get preempted very frequently.  A register containing an unexpected value\r
 101  * is indicative of an error in the context switching mechanism.\r
 102  *\r
 103  * The "Demo" Timer and Callback Function:\r
 104  * The demo timer callback function does nothing more than increment a variable.\r
 105  * The period of the demo timer is set relative to the period of the check timer\r
 106  * (described below).  This allows the check timer to know how many times the\r
 107  * demo timer callback function should execute between each execution of the\r
 108  * check timer callback function.  The variable incremented in the demo timer\r
 109  * callback function is used to determine how many times the callback function\r
 110  * has executed.\r
 111  *\r
 112  * The "Check" Timer and Callback Function:\r
 113  * The check timer period is initially set to three seconds.  The check timer\r
 114  * callback function checks that all the standard demo tasks, the reg test tasks,\r
 115  * and the demo timer are not only still executing, but are executing without\r
 116  * reporting any errors.  If the check timer discovers that a task or timer has\r
 117  * stalled, or reported an error, then it changes its own period from the\r
 118  * initial three seconds, to just 200ms.  The check timer callback function also\r
 119  * toggles the user LED each time it is called.  This provides a visual\r
 120  * indication of the system status:  If the LED toggles every three seconds,\r
 121  * then no issues have been discovered.  If the LED toggles every 200ms, then an\r
 122  * issue has been discovered with at least one task.\r
 123  *\r
 124  */\r
 125 \r
 126 /* Scheduler include files. */\r
 127 #include "FreeRTOS.h"\r
 128 #include "task.h"\r
 129 #include "timers.h"\r
 130 \r
 131 /* Standard demo includes. */\r
 132 #include "dynamic.h"\r
 133 #include "PollQ.h"\r
 134 #include "blocktim.h"\r
 135 \r
 136 /* Hardware includes. */\r
 137 #include "port_iodefine.h"\r
 138 #include "port_iodefine_ext.h"\r
 139 #include "LED.h"\r
 140 \r
 141 /* The period at which the check timer will expire, in ms, provided no errors\r
 142 have been reported by any of the standard demo tasks.  ms are converted to the\r
 143 equivalent in ticks using the portTICK_RATE_MS constant. */\r
 144 #define mainCHECK_TIMER_PERIOD_MS                       ( 3000UL / portTICK_RATE_MS )\r
 145 \r
 146 /* The period at which the check timer will expire, in ms, if an error has been\r
 147 reported in one of the standard demo tasks, the check tasks, or the demo timer.\r
 148 ms are converted to the equivalent in ticks using the portTICK_RATE_MS\r
 149 constant. */\r
 150 #define mainERROR_CHECK_TIMER_PERIOD_MS         ( 200UL / portTICK_RATE_MS )\r
 151 \r
 152 /* These two definitions are used to set the period of the demo timer.  The demo\r
 153 timer period is always relative to the check timer period, so the check timer\r
 154 can determine if the demo timer has expired the expected number of times between\r
 155 its own executions. */\r
 156 #define mainDEMO_TIMER_INCREMENTS_PER_CHECK_TIMER_TIMEOUT       ( 100UL )\r
 157 #define mainDEMO_TIMER_PERIOD_MS                        ( mainCHECK_TIMER_PERIOD_MS / mainDEMO_TIMER_INCREMENTS_PER_CHECK_TIMER_TIMEOUT )\r
 158 \r
 159 /* A block time of zero simple means "don't block". */\r
 160 #define mainDONT_BLOCK                                          ( 0U )\r
 161 \r
 162 /* Values that are passed as parameters into the reg test tasks (purely to\r
 163 ensure task parameters are passed correctly). */\r
 164 #define mainREG_TEST_1_PARAMETER                        ( ( void * ) 0x1234 )\r
 165 #define mainREG_TEST_2_PARAMETER                        ( ( void * ) 0x5678 )\r
 166 \r
 167 /*-----------------------------------------------------------*/\r
 168 \r
 169 /*\r
 170  * The 'check' timer callback function, as described at the top of this file.\r
 171  */\r
 172 static void prvCheckTimerCallback( xTimerHandle xTimer );\r
 173 \r
 174 /*\r
 175  * The 'demo' timer callback function, as described at the top of this file.\r
 176  */\r
 177 static void prvDemoTimerCallback( xTimerHandle xTimer );\r
 178 \r
 179 /*\r
 180  * Functions that define the RegTest tasks, as described at the top of this\r
 181  * file.  The RegTest tasks are written (necessarily) in assembler.  Their\r
 182  * entry points are written in C to allow for easy checking of the task\r
 183  * parameter values.\r
 184  */\r
 185 extern void vRegTest1Task( void );\r
 186 extern void vRegTest2Task( void );\r
 187 static void prvRegTest1Entry( void *pvParameters );\r
 188 static void prvRegTest2Entry( void *pvParameters );\r
 189 \r
 190 /*\r
 191  * Called if a RegTest task discovers an error as a mechanism to stop the\r
 192  * tasks loop counter incrementing (so the check task can detect that an\r
 193  * error exists).\r
 194  */\r
 195 void vRegTestError( void );\r
 196 \r
 197 /*-----------------------------------------------------------*/\r
 198 \r
 199 /* Variables that are incremented on each cycle of the two reg tests to allow\r
 200 the check timer to know that they are still executing. */\r
 201 unsigned short usRegTest1LoopCounter = 0, usRegTest2LoopCounter;\r
 202 \r
 203 /* The check timer.  This uses prvCheckTimerCallback() as its callback\r
 204 function. */\r
 205 static xTimerHandle xCheckTimer = NULL;\r
 206 \r
 207 /* The demo timer.  This uses prvDemoTimerCallback() as its callback function. */\r
 208 static xTimerHandle xDemoTimer = NULL;\r
 209 \r
 210 /* This variable is incremented each time the demo timer expires. */\r
 211 static volatile unsigned long ulDemoSoftwareTimerCounter = 0UL;\r
 212 \r
 213 /*-----------------------------------------------------------*/\r
 214 \r
 215 short main( void )\r
 216 {\r
 217         /* Creates all the tasks and timers, then starts the scheduler. */\r
 218 \r
 219         /* First create the 'standard demo' tasks.  These are used to demonstrate\r
 220         API functions being used and also to test the kernel port.  More information\r
 221         is provided on the FreeRTOS.org WEB site. */\r
 222         vStartDynamicPriorityTasks();\r
 223         vStartPolledQueueTasks( tskIDLE_PRIORITY );\r
 224         vCreateBlockTimeTasks();\r
 225 \r
 226         /* Create the RegTest tasks as described at the top of this file. */\r
 227         xTaskCreate( prvRegTest1Entry, "Reg1", configMINIMAL_STACK_SIZE, mainREG_TEST_1_PARAMETER, tskIDLE_PRIORITY, NULL );\r
 228         xTaskCreate( prvRegTest2Entry, "Reg2", configMINIMAL_STACK_SIZE, mainREG_TEST_2_PARAMETER, tskIDLE_PRIORITY, NULL );\r
 229 \r
 230         /* Create the software timer that performs the 'check' functionality,\r
 231         as described at the top of this file. */\r
 232         xCheckTimer = xTimerCreate( ( const signed char * ) "CheckTimer",/* A text name, purely to help debugging. */\r
 233                                                                 ( mainCHECK_TIMER_PERIOD_MS ),          /* The timer period, in this case 3000ms (3s). */\r
 234                                                                 pdTRUE,                                                         /* This is an auto-reload timer, so xAutoReload is set to pdTRUE. */\r
 235                                                                 ( void * ) 0,                                           /* The ID is not used, so can be set to anything. */\r
 236                                                                 prvCheckTimerCallback                           /* The callback function that inspects the status of all the other tasks. */\r
 237                                                           );\r
 238 \r
 239         /* Create the software timer that just increments a variable for demo\r
 240         purposes. */\r
 241         xDemoTimer = xTimerCreate( ( const signed char * ) "DemoTimer",/* A text name, purely to help debugging. */\r
 242                                                                 ( mainDEMO_TIMER_PERIOD_MS ),           /* The timer period, in this case it is always calculated relative to the check timer period (see the definition of mainDEMO_TIMER_PERIOD_MS). */\r
 243                                                                 pdTRUE,                                                         /* This is an auto-reload timer, so xAutoReload is set to pdTRUE. */\r
 244                                                                 ( void * ) 0,                                           /* The ID is not used, so can be set to anything. */\r
 245                                                                 prvDemoTimerCallback                            /* The callback function that inspects the status of all the other tasks. */\r
 246                                                           );\r
 247 \r
 248         /* Start both the check timer and the demo timer.  The timers won't actually\r
 249         start until the scheduler is started. */\r
 250         xTimerStart( xCheckTimer, mainDONT_BLOCK );\r
 251         xTimerStart( xDemoTimer, mainDONT_BLOCK );\r
 252 \r
 253         /* Finally start the scheduler running. */\r
 254         vTaskStartScheduler();\r
 255 \r
 256         /* If all is well execution will never reach here as the scheduler will be\r
 257         running.  If this null loop is reached then it is likely there was\r
 258         insufficient FreeRTOS heap available for the idle task and/or timer task to\r
 259         be created.  See http://www.freertos.org/a00111.html. */\r
 260         for( ;; );\r
 261 }\r
 262 /*-----------------------------------------------------------*/\r
 263 \r
 264 static void prvDemoTimerCallback( xTimerHandle xTimer )\r
 265 {\r
 266         /* The demo timer has expired.  All it does is increment a variable.  The\r
 267         period of the demo timer is relative to that of the check timer, so the\r
 268         check timer knows how many times this variable should have been incremented\r
 269         between each execution of the check timer's own callback. */\r
 270         ulDemoSoftwareTimerCounter++;\r
 271 }\r
 272 /*-----------------------------------------------------------*/\r
 273 \r
 274 static void prvCheckTimerCallback( xTimerHandle xTimer )\r
 275 {\r
 276 static portBASE_TYPE xChangedTimerPeriodAlready = pdFALSE, xErrorStatus = pdPASS;\r
 277 static unsigned short usLastRegTest1Counter = 0, usLastRegTest2Counter = 0;\r
 278 \r
 279         /* Inspect the status of the standard demo tasks. */\r
 280         if( xAreDynamicPriorityTasksStillRunning() != pdTRUE )\r
 281         {\r
 282                 xErrorStatus = pdFAIL;\r
 283         }\r
 284 \r
 285         if( xArePollingQueuesStillRunning() != pdTRUE )\r
 286         {\r
 287                 xErrorStatus = pdFAIL;\r
 288         }\r
 289 \r
 290         if( xAreBlockTimeTestTasksStillRunning() != pdTRUE )\r
 291         {\r
 292                 xErrorStatus = pdFAIL;\r
 293         }\r
 294 \r
 295         /* Indicate an error if either of the reg test loop counters have not\r
 296         incremented since the last time this function was called. */\r
 297         if( usLastRegTest1Counter == usRegTest1LoopCounter )\r
 298         {\r
 299                 xErrorStatus = pdFAIL;\r
 300         }\r
 301         else\r
 302         {\r
 303                 usLastRegTest1Counter = usRegTest1LoopCounter;\r
 304         }\r
 305 \r
 306         if( usLastRegTest2Counter == usRegTest2LoopCounter )\r
 307         {\r
 308                 xErrorStatus = pdFAIL;\r
 309         }\r
 310         else\r
 311         {\r
 312                 usLastRegTest2Counter = usRegTest2LoopCounter;\r
 313         }\r
 314 \r
 315         /* Ensure that the demo software timer has expired\r
 316         mainDEMO_TIMER_INCREMENTS_PER_CHECK_TIMER_TIMEOUT times in between\r
 317         each call of this function.  A critical section is not required to access\r
 318         ulDemoSoftwareTimerCounter as the variable is only accessed from another\r
 319         software timer callback, and only one software timer callback can be\r
 320         executing at any time. */\r
 321         if( ( ulDemoSoftwareTimerCounter < ( mainDEMO_TIMER_INCREMENTS_PER_CHECK_TIMER_TIMEOUT - 1 ) ) ||\r
 322             ( ulDemoSoftwareTimerCounter > ( mainDEMO_TIMER_INCREMENTS_PER_CHECK_TIMER_TIMEOUT + 1 ) )\r
 323           )\r
 324         {\r
 325                 xErrorStatus = pdFAIL;\r
 326         }\r
 327         else\r
 328         {\r
 329                 ulDemoSoftwareTimerCounter = 0UL;\r
 330         }\r
 331 \r
 332         if( ( xErrorStatus == pdFAIL ) && ( xChangedTimerPeriodAlready == pdFALSE ) )\r
 333         {\r
 334                 /* An error has occurred, but the timer's period has not yet been changed,\r
 335                 change it now, and remember that it has been changed.  Shortening the\r
 336                 timer's period means the LED will toggle at a faster rate, giving a\r
 337                 visible indication that something has gone wrong. */\r
 338                 xChangedTimerPeriodAlready = pdTRUE;\r
 339 \r
 340                 /* This call to xTimerChangePeriod() uses a zero block time.  Functions\r
 341                 called from inside of a timer callback function must *never* attempt to\r
 342                 block. */\r
 343                 xTimerChangePeriod( xCheckTimer, ( mainERROR_CHECK_TIMER_PERIOD_MS ), mainDONT_BLOCK );\r
 344         }\r
 345 \r
 346         /* Toggle the LED.  The toggle rate will depend on whether or not an error\r
 347         has been found in any tasks. */\r
 348         LED_BIT = !LED_BIT;\r
 349 }\r
 350 /*-----------------------------------------------------------*/\r
 351 \r
 352 void vRegTestError( void )\r
 353 {\r
 354         /* Called by both reg test tasks if an error is found.  There is no way out\r
 355         of this function so the loop counter of the calling task will stop\r
 356         incrementing, which will result in the check timer signaling an error. */\r
 357         for( ;; );\r
 358 }\r
 359 /*-----------------------------------------------------------*/\r
 360 \r
 361 void vApplicationMallocFailedHook( void )\r
 362 {\r
 363         /* Called if a call to pvPortMalloc() fails because there is insufficient\r
 364         free memory available in the FreeRTOS heap.  pvPortMalloc() is called\r
 365         internally by FreeRTOS API functions that create tasks, queues, software\r
 366         timers, and semaphores.  The size of the FreeRTOS heap is set by the\r
 367         configTOTAL_HEAP_SIZE configuration constant in FreeRTOSConfig.h. */\r
 368         taskDISABLE_INTERRUPTS();\r
 369         for( ;; );\r
 370 }\r
 371 /*-----------------------------------------------------------*/\r
 372 \r
 373 void vApplicationStackOverflowHook( xTaskHandle pxTask, signed char *pcTaskName )\r
 374 {\r
 375         ( void ) pcTaskName;\r
 376         ( void ) pxTask;\r
 377 \r
 378         /* Run time stack overflow checking is performed if\r
 379         configCHECK_FOR_STACK_OVERFLOW is defined to 1 or 2.  This hook\r
 380         function is called if a stack overflow is detected. */\r
 381         taskDISABLE_INTERRUPTS();\r
 382         for( ;; );\r
 383 }\r
 384 /*-----------------------------------------------------------*/\r
 385 \r
 386 void vApplicationIdleHook( void )\r
 387 {\r
 388 volatile size_t xFreeHeapSpace;\r
 389 \r
 390         /* This is just a trivial example of an idle hook.  It is called on each\r
 391         cycle of the idle task.  It must *NOT* attempt to block.  In this case the\r
 392         idle task just queries the amount of FreeRTOS heap that remains.  See the\r
 393         memory management section on the http://www.FreeRTOS.org web site for memory\r
 394         management options.  If there is a lot of heap memory free then the\r
 395         configTOTAL_HEAP_SIZE value in FreeRTOSConfig.h can be reduced to free up\r
 396         RAM. */\r
 397         xFreeHeapSpace = xPortGetFreeHeapSize();\r
 398 }\r
 399 /*-----------------------------------------------------------*/\r
 400 \r
 401 static void prvRegTest1Entry( void *pvParameters )\r
 402 {\r
 403         /* If the parameter has its expected value then start the first reg test\r
 404         task (this is only done to test that the RTOS port is correctly handling\r
 405         task parameters. */\r
 406         if( pvParameters == mainREG_TEST_1_PARAMETER )\r
 407         {\r
 408                 vRegTest1Task();\r
 409         }\r
 410         else\r
 411         {\r
 412                 vRegTestError();\r
 413         }\r
 414 \r
 415         /* It is not possible to get here as neither of the two functions called\r
 416         above will ever return. */\r
 417 }\r
 418 /*-----------------------------------------------------------*/\r
 419 \r
 420 static void prvRegTest2Entry( void *pvParameters )\r
 421 {\r
 422         /* If the parameter has its expected value then start the first reg test\r
 423         task (this is only done to test that the RTOS port is correctly handling\r
 424         task parameters. */\r
 425         if( pvParameters == mainREG_TEST_2_PARAMETER )\r
 426         {\r
 427                 vRegTest2Task();\r
 428         }\r
 429         else\r
 430         {\r
 431                 vRegTestError();\r
 432         }\r
 433 \r
 434         /* It is not possible to get here as neither of the two functions called\r
 435         above will ever return. */\r
 436 }\r
 437 /*-----------------------------------------------------------*/\r
 438 \r
 439 void vAssertCalled( void )\r
 440 {\r
 441 volatile unsigned long ul = 0;\r
 442         taskENTER_CRITICAL();\r
 443         {\r
 444                 /* Set ul to a non-zero value using the debugger to step out of this\r
 445                 function. */\r
 446                 while( ul == 0 )\r
 447                 {\r
 448                         __asm volatile( "NOP" );\r
 449                 }\r
 450         }\r
 451         taskEXIT_CRITICAL();\r
 452 }\r