git.sur5r.net Git - freertos/blob - FreeRTOS/Demo/RX100-RSK_IAR/main_full.c

   1 /*\r
   2     FreeRTOS V7.5.3 - Copyright (C) 2013 Real Time Engineers Ltd. \r
   3     All rights reserved\r
   4 \r
   5     VISIT http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.\r
   6 \r
   7     ***************************************************************************\r
   8      *                                                                       *\r
   9      *    FreeRTOS provides completely free yet professionally developed,    *\r
  10      *    robust, strictly quality controlled, supported, and cross          *\r
  11      *    platform software that has become a de facto standard.             *\r
  12      *                                                                       *\r
  13      *    Help yourself get started quickly and support the FreeRTOS         *\r
  14      *    project by purchasing a FreeRTOS tutorial book, reference          *\r
  15      *    manual, or both from: http://www.FreeRTOS.org/Documentation        *\r
  16      *                                                                       *\r
  17      *    Thank you!                                                         *\r
  18      *                                                                       *\r
  19     ***************************************************************************\r
  20 \r
  21     This file is part of the FreeRTOS distribution.\r
  22 \r
  23     FreeRTOS is free software; you can redistribute it and/or modify it under\r
  24     the terms of the GNU General Public License (version 2) as published by the\r
  25     Free Software Foundation >>!AND MODIFIED BY!<< the FreeRTOS exception.\r
  26 \r
  27     >>! NOTE: The modification to the GPL is included to allow you to distribute\r
  28     >>! a combined work that includes FreeRTOS without being obliged to provide\r
  29     >>! the source code for proprietary components outside of the FreeRTOS\r
  30     >>! kernel.\r
  31 \r
  32     FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY\r
  33     WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS\r
  34     FOR A PARTICULAR PURPOSE.  Full license text is available from the following\r
  35     link: http://www.freertos.org/a00114.html\r
  36 \r
  37     1 tab == 4 spaces!\r
  38 \r
  39     ***************************************************************************\r
  40      *                                                                       *\r
  41      *    Having a problem?  Start by reading the FAQ "My application does   *\r
  42      *    not run, what could be wrong?"                                     *\r
  43      *                                                                       *\r
  44      *    http://www.FreeRTOS.org/FAQHelp.html                               *\r
  45      *                                                                       *\r
  46     ***************************************************************************\r
  47 \r
  48     http://www.FreeRTOS.org - Documentation, books, training, latest versions,\r
  49     license and Real Time Engineers Ltd. contact details.\r
  50 \r
  51     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
  52     including FreeRTOS+Trace - an indispensable productivity tool, a DOS\r
  53     compatible FAT file system, and our tiny thread aware UDP/IP stack.\r
  54 \r
  55     http://www.OpenRTOS.com - Real Time Engineers ltd license FreeRTOS to High\r
  56     Integrity Systems to sell under the OpenRTOS brand.  Low cost OpenRTOS\r
  57     licenses offer ticketed support, indemnification and middleware.\r
  58 \r
  59     http://www.SafeRTOS.com - High Integrity Systems also provide a safety\r
  60     engineered and independently SIL3 certified version for use in safety and\r
  61     mission critical applications that require provable dependability.\r
  62 \r
  63     1 tab == 4 spaces!\r
  64 */\r
  65 \r
  66 /* ****************************************************************************\r
  67  * This project includes a lot of tasks and tests and is therefore complex.\r
  68  * If you would prefer a much simpler project to get started with then select\r
  69  * the 'low power' demo by setting configCREATE_LOW_POWER_DEMO to 1 in\r
  70  * FreeRTOSConfig.h.  When configCREATE_LOW_POWER_DEMO is set to 1 main() will\r
  71  * call main_low_power() instead of main_full().\r
  72  * ****************************************************************************\r
  73  *\r
  74  * Creates all the demo application tasks, then starts the scheduler.  The web\r
  75  * documentation provides more details of the standard demo application tasks,\r
  76  * which provide no particular functionality but do provide a good example of\r
  77  * how to use the FreeRTOS API.\r
  78  *\r
  79  * In addition to the standard demo tasks, the following tasks and tests are\r
  80  * defined and/or created within this file:\r
  81  *\r
  82  * "Reg test" tasks - These fill the registers with known values, then\r
  83  * repeatedly check that each register still contains its expected value for\r
  84  * the lifetime of the tasks.  Each task uses different values.  The tasks run\r
  85  * with very low priority so get preempted very frequently.  A check variable\r
  86  * is incremented on each iteration of the test loop.  A register containing an\r
  87  * unexpected value is indicative of an error in the context switching\r
  88  * mechanism and will result in a branch to a null loop - which in turn will\r
  89  * prevent the check variable from incrementing any further and allow the check\r
  90  * timer (described below) to determine that an error has occurred.  The nature\r
  91  * of the reg test tasks necessitates that they are written in assembly code.\r
  92  *\r
  93  * "Check Timer" and Callback Function - The check timer period is initially\r
  94  * set to three seconds.  The check timer callback function checks that all the\r
  95  * standard demo tasks are not only still executing, but are executing without\r
  96  * reporting any errors.  If the check timer discovers that a task has either\r
  97  * stalled, or reported an error, then it changes its own period from the\r
  98  * initial three seconds, to just 200ms.  The check timer callback function\r
  99  * also toggles LED 0 each time it is called.  This provides a visual\r
 100  * indication of the system status:  If the LED toggles every three seconds,\r
 101  * then no issues have been discovered.  If the LED toggles every 200ms, then\r
 102  * an issue has been discovered with at least one task.\r
 103  *\r
 104  * *NOTE 1* The CPU must be in Supervisor mode when the scheduler is started.\r
 105  * The PowerON_Reset_PC() supplied in resetprg.c with this demo has\r
 106  * Change_PSW_PM_to_UserMode() commented out to ensure this is the case.\r
 107 */\r
 108 \r
 109 /* Standard includes. */\r
 110 #include <string.h>\r
 111 \r
 112 /* Hardware specific includes. */\r
 113 #include "iorx111.h"\r
 114 \r
 115 /* Kernel includes. */\r
 116 #include "FreeRTOS.h"\r
 117 #include "task.h"\r
 118 #include "timers.h"\r
 119 #include "semphr.h"\r
 120 \r
 121 /* Standard demo includes. */\r
 122 #include "partest.h"\r
 123 #include "death.h"\r
 124 #include "blocktim.h"\r
 125 #include "GenQTest.h"\r
 126 #include "recmutex.h"\r
 127 \r
 128 \r
 129 /* Variables that are incremented on each iteration of the reg test tasks are\r
 130 declared outside of the #if configCREATE_LOW_POWER_DEMO conditional compilation\r
 131 to prevent linker issues when configCREATE_LOW_POWER_DEMO is set to 1.  The\r
 132 check timer inspects these variables to ensure they are still incrementing as\r
 133 expected.  If a variable stops incrementing then it is likely that its associate\r
 134 task has stalled. */\r
 135 unsigned long volatile ulRegTest1CycleCount = 0UL, ulRegTest2CycleCount = 0UL;\r
 136 \r
 137 \r
 138 /* The code in this file is only built when configCREATE_LOW_POWER_DEMO is set\r
 139 to 0, otherwise the code in main_low_power.c is used. */\r
 140 #if configCREATE_LOW_POWER_DEMO == 0\r
 141 \r
 142 \r
 143 /* Values that are passed into the reg test tasks using the task parameter.\r
 144 The tasks check that the values are passed in correctly. */\r
 145 #define mainREG_TEST_1_PARAMETER        ( 0x12121212UL )\r
 146 #define mainREG_TEST_2_PARAMETER        ( 0x12345678UL )\r
 147 \r
 148 /* Priorities at which the standard demo tasks are created. */\r
 149 #define mainGEN_QUEUE_TASK_PRIORITY     ( tskIDLE_PRIORITY )\r
 150 #define mainCREATOR_TASK_PRIORITY   ( tskIDLE_PRIORITY + 3 )\r
 151 \r
 152 /* The LED toggled by the check timer. */\r
 153 #define mainCHECK_LED                           ( 0 )\r
 154 \r
 155 /* The period at which the check timer will expire, in ms, provided no errors\r
 156 have been reported by any of the standard demo tasks.  ms are converted to the\r
 157 equivalent in ticks using the portTICK_RATE_MS constant. */\r
 158 #define mainCHECK_TIMER_PERIOD_MS                       ( 3000UL / portTICK_RATE_MS )\r
 159 \r
 160 /* The period at which the check timer will expire, in ms, if an error has been\r
 161 reported in one of the standard demo tasks.  ms are converted to the equivalent\r
 162 in ticks using the portTICK_RATE_MS constant. */\r
 163 #define mainERROR_CHECK_TIMER_PERIOD_MS         ( 200UL / portTICK_RATE_MS )\r
 164 \r
 165 /* A block time of zero simple means "Don't Block". */\r
 166 #define mainDONT_BLOCK                          ( 0UL )\r
 167 \r
 168 /*\r
 169  * The reg test tasks as described at the top of this file.\r
 170  */\r
 171 static void prvRegTest1Task( void *pvParameters );\r
 172 static void prvRegTest2Task( void *pvParameters );\r
 173 \r
 174 /*\r
 175  * The actual implementation of the reg test functionality, which, because of\r
 176  * the direct register access, have to be in assembly.\r
 177  */\r
 178 void vRegTest1Implementation( void );\r
 179 void vRegTest2Implementation( void );\r
 180 \r
 181 /*\r
 182  * The check timer callback function, as described at the top of this file.\r
 183  */\r
 184 static void prvCheckTimerCallback( xTimerHandle xTimer );\r
 185 \r
 186 \r
 187 /*-----------------------------------------------------------*/\r
 188 \r
 189 /* The check timer.  This uses prvCheckTimerCallback() as its callback\r
 190 function. */\r
 191 static xTimerHandle xCheckTimer = NULL;\r
 192 \r
 193 /*-----------------------------------------------------------*/\r
 194 \r
 195 void main_full( void )\r
 196 {\r
 197         /* Start the reg test tasks which test the context switching mechanism. */\r
 198         xTaskCreate( prvRegTest1Task, "RegTst1", configMINIMAL_STACK_SIZE, ( void * ) mainREG_TEST_1_PARAMETER, tskIDLE_PRIORITY, NULL );\r
 199         xTaskCreate( prvRegTest2Task, "RegTst2", configMINIMAL_STACK_SIZE, ( void * ) mainREG_TEST_2_PARAMETER, tskIDLE_PRIORITY, NULL );\r
 200 \r
 201         /* Create the standard demo tasks. */\r
 202         vCreateBlockTimeTasks();\r
 203         vStartGenericQueueTasks( mainGEN_QUEUE_TASK_PRIORITY );\r
 204         vStartRecursiveMutexTasks();\r
 205 \r
 206         /* The suicide tasks must be created last as they need to know how many\r
 207         tasks were running prior to their creation in order to ascertain whether\r
 208         or not the correct/expected number of tasks are running at any given time. */\r
 209         vCreateSuicidalTasks( mainCREATOR_TASK_PRIORITY );\r
 210 \r
 211         /* Create the software timer that performs the 'check' functionality,\r
 212         as described at the top of this file. */\r
 213         xCheckTimer = xTimerCreate( ( const signed char * ) "CheckTimer",/* A text name, purely to help debugging. */\r
 214                                                                 ( mainCHECK_TIMER_PERIOD_MS ),          /* The timer period, in this case 5000ms (5s). */\r
 215                                                                 pdTRUE,                                                         /* This is an auto-reload timer, so xAutoReload is set to pdTRUE. */\r
 216                                                                 ( void * ) 0,                                           /* The ID is not used, so can be set to anything. */\r
 217                                                                 prvCheckTimerCallback                           /* The callback function that inspects the status of all the other tasks. */\r
 218                                                           );\r
 219 \r
 220         configASSERT( xCheckTimer );\r
 221 \r
 222         /* Start the check timer.  It will actually start when the scheduler is\r
 223         started. */\r
 224         xTimerStart( xCheckTimer, mainDONT_BLOCK );\r
 225 \r
 226         /* Start the tasks running. */\r
 227         vTaskStartScheduler();\r
 228 \r
 229         /* If all is well execution will never reach here as the scheduler will be\r
 230         running.  If this null loop is reached then it is likely there was\r
 231         insufficient FreeRTOS heap available for the idle task and/or timer task to\r
 232         be created.  See http://www.freertos.org/a00111.html. */\r
 233         for( ;; );\r
 234 }\r
 235 /*-----------------------------------------------------------*/\r
 236 \r
 237 static void prvCheckTimerCallback( xTimerHandle xTimer )\r
 238 {\r
 239 static long lChangedTimerPeriodAlready = pdFALSE, lErrorStatus = pdPASS;\r
 240 static volatile unsigned long ulLastRegTest1CycleCount = 0UL, ulLastRegTest2CycleCount = 0UL;\r
 241 \r
 242         /* Remove compiler warnings about unused parameters. */\r
 243         ( void ) xTimer;\r
 244 \r
 245         /* Check the standard demo tasks are running without error. */\r
 246         if( xAreGenericQueueTasksStillRunning() != pdTRUE )\r
 247         {\r
 248                 lErrorStatus = pdFAIL;\r
 249         }\r
 250         else if( xIsCreateTaskStillRunning() != pdTRUE )\r
 251         {\r
 252                 lErrorStatus = pdFAIL;\r
 253         }\r
 254         else if( xAreBlockTimeTestTasksStillRunning() != pdTRUE )\r
 255         {\r
 256                 lErrorStatus = pdFAIL;\r
 257         }\r
 258         else if( xAreRecursiveMutexTasksStillRunning() != pdTRUE )\r
 259         {\r
 260                 lErrorStatus = pdFAIL;\r
 261         }\r
 262 \r
 263         /* Check the reg test tasks are still cycling.  They will stop incrementing\r
 264         their loop counters if they encounter an error. */\r
 265         if( ulRegTest1CycleCount == ulLastRegTest1CycleCount )\r
 266         {\r
 267                 lErrorStatus = pdFAIL;\r
 268         }\r
 269 \r
 270         if( ulRegTest2CycleCount == ulLastRegTest2CycleCount )\r
 271         {\r
 272                 lErrorStatus = pdFAIL;\r
 273         }\r
 274 \r
 275         /* Remember the loop counter values this time around so they can be checked\r
 276         again the next time this callback function executes. */\r
 277         ulLastRegTest1CycleCount = ulRegTest1CycleCount;\r
 278         ulLastRegTest2CycleCount = ulRegTest2CycleCount;\r
 279 \r
 280         /* Toggle the check LED to give an indication of the system status.  If\r
 281         the LED toggles every three seconds then everything is ok.  A faster toggle\r
 282         indicates an error. */\r
 283         vParTestToggleLED( mainCHECK_LED );\r
 284 \r
 285         /* Was an error detected this time through the callback execution? */\r
 286         if( lErrorStatus != pdPASS )\r
 287         {\r
 288                 if( lChangedTimerPeriodAlready == pdFALSE )\r
 289                 {\r
 290                         lChangedTimerPeriodAlready = pdTRUE;\r
 291 \r
 292                         /* This call to xTimerChangePeriod() uses a zero block time.\r
 293                         Functions called from inside of a timer callback function must\r
 294                         *never* attempt to block. */\r
 295                         xTimerChangePeriod( xCheckTimer, ( mainERROR_CHECK_TIMER_PERIOD_MS ), mainDONT_BLOCK );\r
 296                 }\r
 297         }\r
 298 }\r
 299 /*-----------------------------------------------------------*/\r
 300 \r
 301 /* This function is explained in the comments at the top of this file. */\r
 302 static void prvRegTest1Task( void *pvParameters )\r
 303 {\r
 304         if( ( ( unsigned long ) pvParameters ) != mainREG_TEST_1_PARAMETER )\r
 305         {\r
 306                 /* The parameter did not contain the expected value. */\r
 307                 for( ;; )\r
 308                 {\r
 309                         /* Stop the tick interrupt so its obvious something has gone wrong. */\r
 310                         taskDISABLE_INTERRUPTS();\r
 311                 }\r
 312         }\r
 313 \r
 314         /* This is an inline asm function that never returns. */\r
 315         vRegTest1Implementation();\r
 316 }\r
 317 /*-----------------------------------------------------------*/\r
 318 \r
 319 /* This function is explained in the comments at the top of this file. */\r
 320 static void prvRegTest2Task( void *pvParameters )\r
 321 {\r
 322         if( ( ( unsigned long ) pvParameters ) != mainREG_TEST_2_PARAMETER )\r
 323         {\r
 324                 /* The parameter did not contain the expected value. */\r
 325                 for( ;; )\r
 326                 {\r
 327                         /* Stop the tick interrupt so its obvious something has gone wrong. */\r
 328                         taskDISABLE_INTERRUPTS();\r
 329                 }\r
 330         }\r
 331 \r
 332         /* This is an inline asm function that never returns. */\r
 333         vRegTest2Implementation();\r
 334 }\r
 335 /*-----------------------------------------------------------*/\r
 336 \r
 337 #endif /* configCREATE_LOW_POWER_DEMO */\r