git.sur5r.net Git - freertos/blob - FreeRTOS/Demo/RL78_RL78G13_Promo_Board_IAR/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 /* The period at which the check timer will expire, in ms, provided no errors\r
 137 have been reported by any of the standard demo tasks.  ms are converted to the\r
 138 equivalent in ticks using the portTICK_RATE_MS constant. */\r
 139 #define mainCHECK_TIMER_PERIOD_MS                       ( 3000UL / portTICK_RATE_MS )\r
 140 \r
 141 /* The period at which the check timer will expire, in ms, if an error has been\r
 142 reported in one of the standard demo tasks, the check tasks, or the demo timer.\r
 143 ms are converted to the equivalent in ticks using the portTICK_RATE_MS\r
 144 constant. */\r
 145 #define mainERROR_CHECK_TIMER_PERIOD_MS         ( 200UL / portTICK_RATE_MS )\r
 146 \r
 147 /* These two definitions are used to set the period of the demo timer.  The demo\r
 148 timer period is always relative to the check timer period, so the check timer\r
 149 can determine if the demo timer has expired the expected number of times between\r
 150 its own executions. */\r
 151 #define mainDEMO_TIMER_INCREMENTS_PER_CHECK_TIMER_TIMEOUT       ( 100UL )\r
 152 #define mainDEMO_TIMER_PERIOD_MS                        ( mainCHECK_TIMER_PERIOD_MS / mainDEMO_TIMER_INCREMENTS_PER_CHECK_TIMER_TIMEOUT )\r
 153 \r
 154 /* The LED toggled by the check timer. */\r
 155 #define mainLED_0                                               P1_bit.no0\r
 156 \r
 157 /* A block time of zero simple means "don't block". */\r
 158 #define mainDONT_BLOCK                                          ( 0U )\r
 159 \r
 160 /*-----------------------------------------------------------*/\r
 161 \r
 162 /*\r
 163  * The 'check' timer callback function, as described at the top of this file.\r
 164  */\r
 165 static void prvCheckTimerCallback( xTimerHandle xTimer );\r
 166 \r
 167 /*\r
 168  * The 'demo' timer callback function, as described at the top of this file.\r
 169  */\r
 170 static void prvDemoTimerCallback( xTimerHandle xTimer );\r
 171 \r
 172 /*\r
 173  * This function is called from the C startup routine to setup the processor -\r
 174  * in particular the clock source.\r
 175  */\r
 176 int __low_level_init(void);\r
 177 \r
 178 /*\r
 179  * Functions that define the RegTest tasks, as described at the top of this file.\r
 180  */\r
 181 extern void vRegTest1( void *pvParameters );\r
 182 extern void vRegTest2( void *pvParameters );\r
 183 \r
 184 \r
 185 /*-----------------------------------------------------------*/\r
 186 \r
 187 /* Variables that are incremented on each cycle of the two reg tests to allow\r
 188 the check timer to know that they are still executing. */\r
 189 unsigned short usRegTest1LoopCounter = 0, usRegTest2LoopCounter;\r
 190 \r
 191 /* The check timer.  This uses prvCheckTimerCallback() as its callback\r
 192 function. */\r
 193 static xTimerHandle xCheckTimer = NULL;\r
 194 \r
 195 /* The demo timer.  This uses prvDemoTimerCallback() as its callback function. */\r
 196 static xTimerHandle xDemoTimer = NULL;\r
 197 \r
 198 /* This variable is incremented each time the demo timer expires. */\r
 199 static volatile unsigned long ulDemoSoftwareTimerCounter = 0UL;\r
 200 \r
 201 /* RL78/G13 Option Byte Definition. Watchdog disabled, LVI enabled, OCD interface\r
 202 enabled. */\r
 203 __root __far const unsigned char OptionByte[] @ 0x00C0 =\r
 204 {\r
 205         0x00U, 0xFFU, 0xF8U, 0x81U\r
 206 };\r
 207 \r
 208 /* Security byte definition */\r
 209 __root __far const unsigned char ucSecurityCode[]  @ 0x00C4 =\r
 210 {\r
 211         0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00\r
 212 };\r
 213 \r
 214 /*-----------------------------------------------------------*/\r
 215 \r
 216 short main( void )\r
 217 {\r
 218         /* Creates all the tasks and timers, then starts the scheduler. */\r
 219 \r
 220         /* First create the 'standard demo' tasks.  These are used to demonstrate\r
 221         API functions being used and also to test the kernel port.  More information\r
 222         is provided on the FreeRTOS.org WEB site. */\r
 223         vStartDynamicPriorityTasks();\r
 224         vStartPolledQueueTasks( tskIDLE_PRIORITY );\r
 225         vCreateBlockTimeTasks();\r
 226 \r
 227         /* Create the RegTest tasks as described at the top of this file. */\r
 228         xTaskCreate( vRegTest1, "Reg1", configMINIMAL_STACK_SIZE, NULL, 0, NULL );\r
 229         xTaskCreate( vRegTest2, "Reg2", configMINIMAL_STACK_SIZE, NULL, 0, NULL );      \r
 230 \r
 231         /* Create the software timer that performs the 'check' functionality,\r
 232         as described at the top of this file. */\r
 233         xCheckTimer = xTimerCreate( ( const signed char * ) "CheckTimer",/* A text name, purely to help debugging. */\r
 234                                                                 ( mainCHECK_TIMER_PERIOD_MS ),          /* The timer period, in this case 3000ms (3s). */\r
 235                                                                 pdTRUE,                                                         /* This is an auto-reload timer, so xAutoReload is set to pdTRUE. */\r
 236                                                                 ( void * ) 0,                                           /* The ID is not used, so can be set to anything. */\r
 237                                                                 prvCheckTimerCallback                           /* The callback function that inspects the status of all the other tasks. */\r
 238                                                           );\r
 239                                                         \r
 240         /* Create the software timer that just increments a variable for demo\r
 241         purposes. */\r
 242         xDemoTimer = xTimerCreate( ( const signed char * ) "DemoTimer",/* A text name, purely to help debugging. */\r
 243                                                                 ( 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
 244                                                                 pdTRUE,                                                         /* This is an auto-reload timer, so xAutoReload is set to pdTRUE. */\r
 245                                                                 ( void * ) 0,                                           /* The ID is not used, so can be set to anything. */\r
 246                                                                 prvDemoTimerCallback                            /* The callback function that inspects the status of all the other tasks. */\r
 247                                                           );\r
 248         \r
 249         /* Start both the check timer and the demo timer.  The timers won't actually\r
 250         start until the scheduler is started. */\r
 251         xTimerStart( xCheckTimer, mainDONT_BLOCK );\r
 252         xTimerStart( xDemoTimer, mainDONT_BLOCK );\r
 253         \r
 254         /* Finally start the scheduler running. */\r
 255         vTaskStartScheduler();\r
 256 \r
 257         /* If this line is reached then vTaskStartScheduler() returned because there\r
 258         was insufficient heap memory remaining for the idle task to be created. */\r
 259         for( ;; );\r
 260 }\r
 261 /*-----------------------------------------------------------*/\r
 262 \r
 263 static void prvDemoTimerCallback( xTimerHandle xTimer )\r
 264 {\r
 265         /* The demo timer has expired.  All it does is increment a variable.  The\r
 266         period of the demo timer is relative to that of the check timer, so the\r
 267         check timer knows how many times this variable should have been incremented\r
 268         between each execution of the check timer's own callback. */\r
 269         ulDemoSoftwareTimerCounter++;\r
 270 }\r
 271 /*-----------------------------------------------------------*/\r
 272 \r
 273 static void prvCheckTimerCallback( xTimerHandle xTimer )\r
 274 {\r
 275 static portBASE_TYPE xChangedTimerPeriodAlready = pdFALSE, xErrorStatus = pdPASS;\r
 276 static unsigned short usLastRegTest1Counter = 0, usLastRegTest2Counter = 0;\r
 277 \r
 278         /* Inspect the status of the standard demo tasks. */\r
 279         if( xAreDynamicPriorityTasksStillRunning() != pdTRUE )\r
 280         {\r
 281                 xErrorStatus = pdFAIL;\r
 282         }\r
 283         \r
 284         if( xArePollingQueuesStillRunning() != pdTRUE )\r
 285         {\r
 286                 xErrorStatus = pdFAIL;\r
 287         }\r
 288         \r
 289         if( xAreBlockTimeTestTasksStillRunning() != pdTRUE )\r
 290         {\r
 291                 xErrorStatus = pdFAIL;\r
 292         }\r
 293 \r
 294         /* Indicate an error if either of the reg test loop counters have not\r
 295         incremented since the last time this function was called. */\r
 296         if( usLastRegTest1Counter == usRegTest1LoopCounter )\r
 297         {\r
 298                 xErrorStatus = pdFAIL;\r
 299         }\r
 300         else\r
 301         {\r
 302                 usLastRegTest1Counter = usRegTest1LoopCounter;\r
 303         }\r
 304 \r
 305         if( usLastRegTest2Counter == usRegTest2LoopCounter )\r
 306         {\r
 307                 xErrorStatus = pdFAIL;\r
 308         }\r
 309         else\r
 310         {\r
 311                 usLastRegTest2Counter = usRegTest2LoopCounter;\r
 312         }\r
 313         \r
 314         /* Ensure that the demo software timer has expired\r
 315         mainDEMO_TIMER_INCREMENTS_PER_CHECK_TIMER_TIMEOUT times in between\r
 316         each call of this function.  A critical section is not required to access\r
 317         ulDemoSoftwareTimerCounter as the variable is only accessed from another\r
 318         software timer callback, and only one software timer callback can be\r
 319         executing at any time. */\r
 320         if( ( ulDemoSoftwareTimerCounter < ( mainDEMO_TIMER_INCREMENTS_PER_CHECK_TIMER_TIMEOUT - 1 ) ) ||\r
 321             ( ulDemoSoftwareTimerCounter > ( mainDEMO_TIMER_INCREMENTS_PER_CHECK_TIMER_TIMEOUT + 1 ) )\r
 322           )\r
 323         {\r
 324                 xErrorStatus = pdFAIL;\r
 325         }\r
 326         else\r
 327         {\r
 328                 ulDemoSoftwareTimerCounter = 0UL;\r
 329         }\r
 330         \r
 331         if( ( xErrorStatus == pdFAIL ) && ( xChangedTimerPeriodAlready == pdFALSE ) )\r
 332         {\r
 333                 /* An error has occurred, but the timer's period has not yet been changed,\r
 334                 change it now, and remember that it has been changed.  Shortening the\r
 335                 timer's period means the LED will toggle at a faster rate, giving a\r
 336                 visible indication that something has gone wrong. */\r
 337                 xChangedTimerPeriodAlready = pdTRUE;\r
 338                         \r
 339                 /* This call to xTimerChangePeriod() uses a zero block time.  Functions\r
 340                 called from inside of a timer callback function must *never* attempt to\r
 341                 block. */\r
 342                 xTimerChangePeriod( xCheckTimer, ( mainERROR_CHECK_TIMER_PERIOD_MS ), mainDONT_BLOCK );\r
 343         }\r
 344         \r
 345         /* Toggle the LED.  The toggle rate will depend on whether or not an error\r
 346         has been found in any tasks. */\r
 347         mainLED_0 = !mainLED_0;\r
 348 }\r
 349 /*-----------------------------------------------------------*/\r
 350 \r
 351 int __low_level_init(void)\r
 352 {\r
 353 unsigned portCHAR ucResetFlag = RESF;\r
 354 \r
 355         portDISABLE_INTERRUPTS();\r
 356 \r
 357         /* Set fMX */\r
 358         CMC = 0x00;\r
 359         MSTOP = 1U;\r
 360         \r
 361         /* Set fMAIN */\r
 362         MCM0 = 0U;\r
 363         \r
 364         /* Set fSUB */\r
 365         XTSTOP = 1U;\r
 366         OSMC = 0x10;\r
 367         \r
 368         /* Set fCLK */\r
 369         CSS = 0U;\r
 370         \r
 371         /* Set fIH */\r
 372         HIOSTOP = 0U;\r
 373         \r
 374         /* LED port initialization - set port register. */\r
 375 //      P7 &= 0x7F;\r
 376         P1 &= 0xFE;\r
 377         \r
 378         /* Set port mode register. */\r
 379 //      PM7 &= 0x7F;\r
 380         PM1 &= 0xFE;\r
 381         \r
 382         /* Switch pin initialization - enable pull-up resistor. */\r
 383 //      PU12_bit.no0  = 1;\r
 384 \r
 385         return pdTRUE;\r
 386 }\r
 387 /*-----------------------------------------------------------*/\r
 388 \r
 389 void vRegTestError( void )\r
 390 {\r
 391         /* Called by both reg test tasks if an error is found.  There is no way out\r
 392         of this function so the loop counter of the calling task will stop\r
 393         incrementing, which will result in the check timer signialling an error. */\r
 394         for( ;; );\r
 395 }\r
 396 /*-----------------------------------------------------------*/\r
 397 \r
 398 void vApplicationMallocFailedHook( void )\r
 399 {\r
 400         /* Called if a call to pvPortMalloc() fails because there is insufficient\r
 401         free memory available in the FreeRTOS heap.  pvPortMalloc() is called\r
 402         internally by FreeRTOS API functions that create tasks, queues, software\r
 403         timers, and semaphores.  The size of the FreeRTOS heap is set by the\r
 404         configTOTAL_HEAP_SIZE configuration constant in FreeRTOSConfig.h. */\r
 405         taskDISABLE_INTERRUPTS();\r
 406         for( ;; );\r
 407 }\r
 408 /*-----------------------------------------------------------*/\r
 409 \r
 410 void vApplicationStackOverflowHook( xTaskHandle pxTask, signed char *pcTaskName )\r
 411 {\r
 412         ( void ) pcTaskName;\r
 413         ( void ) pxTask;\r
 414 \r
 415         /* Run time stack overflow checking is performed if\r
 416         configCHECK_FOR_STACK_OVERFLOW is defined to 1 or 2.  This hook\r
 417         function is called if a stack overflow is detected. */\r
 418         taskDISABLE_INTERRUPTS();\r
 419         for( ;; );\r
 420 }\r
 421 /*-----------------------------------------------------------*/\r
 422 \r
 423 void vApplicationIdleHook( void )\r
 424 {\r
 425 volatile size_t xFreeHeapSpace;\r
 426 \r
 427         /* This is just a trivial example of an idle hook.  It is called on each\r
 428         cycle of the idle task.  It must *NOT* attempt to block.  In this case the\r
 429         idle task just queries the amount of FreeRTOS heap that remains.  See the\r
 430         memory management section on the http://www.FreeRTOS.org web site for memory\r
 431         management options.  If there is a lot of heap memory free then the\r
 432         configTOTAL_HEAP_SIZE value in FreeRTOSConfig.h can be reduced to free up\r
 433         RAM. */\r
 434         xFreeHeapSpace = xPortGetFreeHeapSize();        \r
 435 }\r
 436 \r