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

   1 /*\r
   2     FreeRTOS V7.4.2 - 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                                               P7_bit.no7\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 /* If an error is discovered by one of the RegTest tasks then this flag is set\r
 188 to pdFAIL.  The 'check' timer then inspects this flag to detect errors within\r
 189 the RegTest tasks. */\r
 190 static short sRegTestStatus = pdPASS;\r
 191 \r
 192 /* The check timer.  This uses prvCheckTimerCallback() as its callback\r
 193 function. */\r
 194 static xTimerHandle xCheckTimer = NULL;\r
 195 \r
 196 /* The demo timer.  This uses prvDemoTimerCallback() as its callback function. */\r
 197 static xTimerHandle xDemoTimer = NULL;\r
 198 \r
 199 /* This variable is incremented each time the demo timer expires. */\r
 200 static volatile unsigned long ulDemoSoftwareTimerCounter = 0UL;\r
 201 \r
 202 /* RL78/G13 Option Byte Definition. Watchdog disabled, LVI enabled, OCD interface\r
 203 enabled. */\r
 204 __root __far const unsigned char OptionByte[] @ 0x00C0 =\r
 205 {\r
 206         WATCHDOG_DISABLED, LVI_ENABLED, RESERVED_FF, OCD_ENABLED\r
 207 };\r
 208 \r
 209 /* Security byte definition */\r
 210 __root __far const unsigned char SecuIDCode[]  @ 0x00C4 =\r
 211 {\r
 212         0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x54\r
 213 };\r
 214 \r
 215 /*-----------------------------------------------------------*/\r
 216 \r
 217 short main( void )\r
 218 {\r
 219         /* Creates all the tasks and timers, then starts the scheduler. */\r
 220 \r
 221         /* First create the 'standard demo' tasks.  These are used to demonstrate\r
 222         API functions being used and also to test the kernel port.  More information\r
 223         is provided on the FreeRTOS.org WEB site. */\r
 224         vStartDynamicPriorityTasks();\r
 225         vStartPolledQueueTasks( tskIDLE_PRIORITY );\r
 226         vCreateBlockTimeTasks();\r
 227 \r
 228         /* Create the RegTest tasks as described at the top of this file. */\r
 229         xTaskCreate( vRegTest1, "Reg1", configMINIMAL_STACK_SIZE, NULL, 0, NULL );\r
 230         xTaskCreate( vRegTest2, "Reg2", configMINIMAL_STACK_SIZE, NULL, 0, NULL );      \r
 231 \r
 232         /* Create the software timer that performs the 'check' functionality,\r
 233         as described at the top of this file. */\r
 234         xCheckTimer = xTimerCreate( ( const signed char * ) "CheckTimer",/* A text name, purely to help debugging. */\r
 235                                                                 ( mainCHECK_TIMER_PERIOD_MS ),          /* The timer period, in this case 3000ms (3s). */\r
 236                                                                 pdTRUE,                                                         /* This is an auto-reload timer, so xAutoReload is set to pdTRUE. */\r
 237                                                                 ( void * ) 0,                                           /* The ID is not used, so can be set to anything. */\r
 238                                                                 prvCheckTimerCallback                           /* The callback function that inspects the status of all the other tasks. */\r
 239                                                           );\r
 240                                                         \r
 241         /* Create the software timer that just increments a variable for demo\r
 242         purposes. */\r
 243         xDemoTimer = xTimerCreate( ( const signed char * ) "DemoTimer",/* A text name, purely to help debugging. */\r
 244                                                                 ( 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
 245                                                                 pdTRUE,                                                         /* This is an auto-reload timer, so xAutoReload is set to pdTRUE. */\r
 246                                                                 ( void * ) 0,                                           /* The ID is not used, so can be set to anything. */\r
 247                                                                 prvDemoTimerCallback                            /* The callback function that inspects the status of all the other tasks. */\r
 248                                                           );\r
 249         \r
 250         /* Start both the check timer and the demo timer.  The timers won't actually\r
 251         start until the scheduler is started. */\r
 252         xTimerStart( xCheckTimer, mainDONT_BLOCK );\r
 253         xTimerStart( xDemoTimer, mainDONT_BLOCK );\r
 254         \r
 255         /* Finally start the scheduler running. */\r
 256         vTaskStartScheduler();\r
 257 \r
 258         /* If this line is reached then vTaskStartScheduler() returned because there\r
 259         was insufficient heap memory remaining for the idle task to be created. */\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 \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         /* Inspect the status of the reg test tasks. */\r
 295         if( sRegTestStatus != pdPASS )\r
 296         {\r
 297                 xErrorStatus = pdFAIL;\r
 298         }\r
 299         \r
 300         /* Ensure that the demo software timer has expired\r
 301         mainDEMO_TIMER_INCREMENTS_PER_CHECK_TIMER_TIMEOUT times in between\r
 302         each call of this function.  A critical section is not required to access\r
 303         ulDemoSoftwareTimerCounter as the variable is only accessed from another\r
 304         software timer callback, and only one software timer callback can be\r
 305         executing at any time. */\r
 306         if( ( ulDemoSoftwareTimerCounter < ( mainDEMO_TIMER_INCREMENTS_PER_CHECK_TIMER_TIMEOUT - 1 ) ) ||\r
 307             ( ulDemoSoftwareTimerCounter > ( mainDEMO_TIMER_INCREMENTS_PER_CHECK_TIMER_TIMEOUT + 1 ) )\r
 308           )\r
 309         {\r
 310                 xErrorStatus = pdFAIL;\r
 311         }\r
 312         else\r
 313         {\r
 314                 ulDemoSoftwareTimerCounter = 0UL;\r
 315         }\r
 316         \r
 317         if( ( xErrorStatus == pdFAIL ) && ( xChangedTimerPeriodAlready == pdFALSE ) )\r
 318         {\r
 319                 /* An error has occurred, but the timer's period has not yet been changed,\r
 320                 change it now, and remember that it has been changed.  Shortening the\r
 321                 timer's period means the LED will toggle at a faster rate, giving a\r
 322                 visible indication that something has gone wrong. */\r
 323                 xChangedTimerPeriodAlready = pdTRUE;\r
 324                         \r
 325                 /* This call to xTimerChangePeriod() uses a zero block time.  Functions\r
 326                 called from inside of a timer callback function must *never* attempt to\r
 327                 block. */\r
 328                 xTimerChangePeriod( xCheckTimer, ( mainERROR_CHECK_TIMER_PERIOD_MS ), mainDONT_BLOCK );\r
 329         }\r
 330         \r
 331         /* Toggle the LED.  The toggle rate will depend on whether or not an error\r
 332         has been found in any tasks. */\r
 333         mainLED_0 = !mainLED_0;\r
 334 }\r
 335 /*-----------------------------------------------------------*/\r
 336 \r
 337 int __low_level_init(void)\r
 338 {\r
 339 unsigned portCHAR ucResetFlag = RESF;\r
 340 \r
 341         portDISABLE_INTERRUPTS();\r
 342 \r
 343         /* Clock Configuration:\r
 344         In this port, to use the internal high speed clock source of the\r
 345         microcontroller, define the configCLOCK_SOURCE as 1 in FreeRTOSConfig.h.  To\r
 346         use an external clock define configCLOCK_SOURCE as 0. */\r
 347         #if configCLOCK_SOURCE == 1\r
 348         {\r
 349                 /* Set fMX */\r
 350                 CMC = 0x00;\r
 351                 MSTOP = 1U;\r
 352                 \r
 353                 /* Set fMAIN */\r
 354                 MCM0 = 0U;\r
 355                 \r
 356                 /* Set fSUB */\r
 357                 XTSTOP = 1U;\r
 358                 OSMC = 0x10;\r
 359                 \r
 360                 /* Set fCLK */\r
 361                 CSS = 0U;\r
 362                 \r
 363                 /* Set fIH */\r
 364                 HIOSTOP = 0U;\r
 365         }\r
 366         #else\r
 367         {\r
 368                 unsigned char ucTempStabset, ucTempStabWait;    \r
 369 \r
 370                 /* Set fMX */\r
 371                 CMC = 0x41;\r
 372                 OSTS = 0x07;\r
 373                 MSTOP = 0U;\r
 374                 ucTempStabset = 0xFF;\r
 375                 \r
 376                 do\r
 377                 {\r
 378                         ucTempStabWait = OSTC;\r
 379                         ucTempStabWait &= ucTempStabset;\r
 380                 }\r
 381                 while( ucTempStabWait != ucTempStabset );\r
 382                 \r
 383                 /* Set fMAIN */\r
 384                 MCM0 = 1U;\r
 385                 \r
 386                 /* Set fSUB */\r
 387                 XTSTOP = 1U;\r
 388                 OSMC = 0x10;\r
 389                 \r
 390                 /* Set fCLK */\r
 391                 CSS = 0U;\r
 392                 \r
 393                 /* Set fIH */\r
 394                 HIOSTOP = 0U;\r
 395         }\r
 396         #endif /* configCLOCK_SOURCE == 1 */\r
 397         \r
 398         /* LED port initialization - set port register. */\r
 399         P7 &= 0x7F;\r
 400         \r
 401         /* Set port mode register. */\r
 402         PM7 &= 0x7F;\r
 403         \r
 404         /* Switch pin initialization - enable pull-up resistor. */\r
 405         PU12_bit.no0  = 1;\r
 406 \r
 407         return pdTRUE;\r
 408 }\r
 409 /*-----------------------------------------------------------*/\r
 410 \r
 411 void vRegTestError( void )\r
 412 {\r
 413         /* Called by the RegTest tasks if an error is found.  lRegTestStatus is\r
 414         inspected by the check task. */\r
 415         sRegTestStatus = pdFAIL;\r
 416 \r
 417         /* Do not return from here as the reg test tasks clobber all registers so\r
 418         function calls may not function correctly. */\r
 419         for( ;; );\r
 420 }\r
 421 /*-----------------------------------------------------------*/\r
 422 \r
 423 void vApplicationMallocFailedHook( void )\r
 424 {\r
 425         /* Called if a call to pvPortMalloc() fails because there is insufficient\r
 426         free memory available in the FreeRTOS heap.  pvPortMalloc() is called\r
 427         internally by FreeRTOS API functions that create tasks, queues, software\r
 428         timers, and semaphores.  The size of the FreeRTOS heap is set by the\r
 429         configTOTAL_HEAP_SIZE configuration constant in FreeRTOSConfig.h. */\r
 430         taskDISABLE_INTERRUPTS();\r
 431         for( ;; );\r
 432 }\r
 433 /*-----------------------------------------------------------*/\r
 434 \r
 435 void vApplicationStackOverflowHook( xTaskHandle pxTask, signed char *pcTaskName )\r
 436 {\r
 437         ( void ) pcTaskName;\r
 438         ( void ) pxTask;\r
 439 \r
 440         /* Run time stack overflow checking is performed if\r
 441         configCHECK_FOR_STACK_OVERFLOW is defined to 1 or 2.  This hook\r
 442         function is called if a stack overflow is detected. */\r
 443         taskDISABLE_INTERRUPTS();\r
 444         for( ;; );\r
 445 }\r
 446 /*-----------------------------------------------------------*/\r
 447 \r
 448 void vApplicationIdleHook( void )\r
 449 {\r
 450 volatile size_t xFreeHeapSpace;\r
 451 \r
 452         /* This is just a trivial example of an idle hook.  It is called on each\r
 453         cycle of the idle task.  It must *NOT* attempt to block.  In this case the\r
 454         idle task just queries the amount of FreeRTOS heap that remains.  See the\r
 455         memory management section on the http://www.FreeRTOS.org web site for memory\r
 456         management options.  If there is a lot of heap memory free then the\r
 457         configTOTAL_HEAP_SIZE value in FreeRTOSConfig.h can be reduced to free up\r
 458         RAM. */\r
 459         xFreeHeapSpace = xPortGetFreeHeapSize();        \r
 460 }\r
 461 \r