git.sur5r.net Git - freertos/blob - FreeRTOS/Demo/RISC-V_IGLOO2_Creative_SoftConsole/full_demo/main_full.c

   1 /*\r
   2  * FreeRTOS Kernel V10.1.1\r
   3  * Copyright (C) 2018 Amazon.com, Inc. or its affiliates.  All Rights Reserved.\r
   4  *\r
   5  * Permission is hereby granted, free of charge, to any person obtaining a copy of\r
   6  * this software and associated documentation files (the "Software"), to deal in\r
   7  * the Software without restriction, including without limitation the rights to\r
   8  * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\r
   9  * the Software, and to permit persons to whom the Software is furnished to do so,\r
  10  * subject to the following conditions:\r
  11  *\r
  12  * The above copyright notice and this permission notice shall be included in all\r
  13  * copies or substantial portions of the Software.\r
  14  *\r
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
  16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\r
  17  * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\r
  18  * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\r
  19  * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\r
  20  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r
  21  *\r
  22  * http://www.FreeRTOS.org\r
  23  * http://aws.amazon.com/freertos\r
  24  *\r
  25  * 1 tab == 4 spaces!\r
  26  */\r
  27 \r
  28 /******************************************************************************\r
  29  * NOTE 1:  This project provides two demo applications.  A simple blinky style\r
  30  * project, and a more comprehensive test and demo application.  The\r
  31  * mainCREATE_SIMPLE_BLINKY_DEMO_ONLY setting in main.c is used to select\r
  32  * between the two.  See the notes on using mainCREATE_SIMPLE_BLINKY_DEMO_ONLY\r
  33  * in main.c.  This file implements the comprehensive test and demo version.\r
  34  *\r
  35  * NOTE 2:  This file only contains the source code that is specific to the\r
  36  * full demo.  Generic functions, such FreeRTOS hook functions, and functions\r
  37  * required to configure the hardware, are defined in main.c.\r
  38  *\r
  39  ******************************************************************************\r
  40  *\r
  41  * main_full() creates all the demo application tasks and software timers, then\r
  42  * starts the scheduler.  The web documentation provides more details of the\r
  43  * standard demo application tasks, which provide no particular functionality,\r
  44  * but do provide a good example of how to use the FreeRTOS API.\r
  45  *\r
  46  * In addition to the standard demo tasks, the following tasks and tests are\r
  47  * defined and/or created within this file:\r
  48  *\r
  49  * "Reg test" tasks - These fill both the core registers with known values, then\r
  50  * check that each register maintains its expected value for the lifetime of the\r
  51  * task.  Each task uses a different set of values.  The reg test tasks execute\r
  52  * with a very low priority, so get preempted very frequently.  A register\r
  53  * containing an unexpected value is indicative of an error in the context\r
  54  * switching mechanism.\r
  55  *\r
  56  * "Check" task - The check executes every three seconds.  It checks that all\r
  57  * the standard demo tasks, and the register check tasks, are not only still\r
  58  * executing, but are executing without reporting any errors.  If the check task\r
  59  * discovers that a task has either stalled, or reported an error, then it\r
  60  * prints an error message to the UART, otherwise it prints "Pass.".\r
  61  */\r
  62 \r
  63 /* Standard includes. */\r
  64 #include <stdio.h>\r
  65 #include <string.h>\r
  66 \r
  67 /* Kernel includes. */\r
  68 #include "FreeRTOS.h"\r
  69 #include "task.h"\r
  70 #include "timers.h"\r
  71 #include "semphr.h"\r
  72 \r
  73 /* Standard demo application includes. */\r
  74 #include "dynamic.h"\r
  75 #include "blocktim.h"\r
  76 #include "GenQTest.h"\r
  77 #include "recmutex.h"\r
  78 #include "TimerDemo.h"\r
  79 #include "EventGroupsDemo.h"\r
  80 #include "TaskNotify.h"\r
  81 \r
  82 /* Priorities for the demo application tasks. */\r
  83 #define mainCHECK_TASK_PRIORITY                         ( configMAX_PRIORITIES - 1 )\r
  84 \r
  85 /* The period of the check task, in ms, converted to ticks using the\r
  86 pdMS_TO_TICKS() macro.  mainNO_ERROR_CHECK_TASK_PERIOD is used if no errors have\r
  87 been found, mainERROR_CHECK_TASK_PERIOD is used if an error has been found. */\r
  88 #define mainNO_ERROR_CHECK_TASK_PERIOD          pdMS_TO_TICKS( 3000UL )\r
  89 #define mainERROR_CHECK_TASK_PERIOD             pdMS_TO_TICKS( 500UL )\r
  90 \r
  91 /* Parameters that are passed into the register check tasks solely for the\r
  92 purpose of ensuring parameters are passed into tasks correctly. */\r
  93 #define mainREG_TEST_TASK_1_PARAMETER           ( ( void * ) 0x12345678 )\r
  94 #define mainREG_TEST_TASK_2_PARAMETER           ( ( void * ) 0x87654321 )\r
  95 \r
  96 /* The base period used by the timer test tasks. */\r
  97 #define mainTIMER_TEST_PERIOD                           ( 50 )\r
  98 \r
  99 /* The size of the stack allocated to the check task (as described in the\r
 100 comments at the top of this file. */\r
 101 #define mainCHECK_TASK_STACK_SIZE_WORDS 100\r
 102 \r
 103 /* Size of the stacks to allocated for the register check tasks. */\r
 104 #define mainREG_TEST_STACK_SIZE_WORDS 60\r
 105 \r
 106 /*-----------------------------------------------------------*/\r
 107 \r
 108 /*\r
 109  * Called by main() to run the full demo (as opposed to the blinky demo) when\r
 110  * mainCREATE_SIMPLE_BLINKY_DEMO_ONLY is set to 0.\r
 111  */\r
 112 void main_full( void );\r
 113 \r
 114 /*\r
 115  * The check task, as described at the top of this file.\r
 116  */\r
 117 static void prvCheckTask( void *pvParameters );\r
 118 \r
 119 /*\r
 120  * Register check tasks as described at the top of this file.  The nature of\r
 121  * these files necessitates that they are written in an assembly file, but the\r
 122  * entry points are kept in the C file for the convenience of checking the task\r
 123  * parameter.\r
 124  */\r
 125 static void prvRegTestTaskEntry1( void *pvParameters );\r
 126 extern void vRegTest1Implementation( void );\r
 127 static void prvRegTestTaskEntry2( void *pvParameters );\r
 128 extern void vRegTest2Implementation( void );\r
 129 \r
 130 /*\r
 131  * Tick hook used by the full demo, which includes code that interacts with\r
 132  * some of the tests.\r
 133  */\r
 134 void vFullDemoTickHook( void );\r
 135 \r
 136 /*-----------------------------------------------------------*/\r
 137 \r
 138 /* The following two variables are used to communicate the status of the\r
 139 register check tasks to the check task.  If the variables keep incrementing,\r
 140 then the register check tasks have not discovered any errors.  If a variable\r
 141 stops incrementing, then an error has been found. */\r
 142 volatile uint32_t ulRegTest1LoopCounter = 0UL, ulRegTest2LoopCounter = 0UL;\r
 143 \r
 144 /*-----------------------------------------------------------*/\r
 145 \r
 146 void main_full( void )\r
 147 {\r
 148         /* Start all the other standard demo/test tasks.  They have no particular\r
 149         functionality, but do demonstrate how to use the FreeRTOS API and test the\r
 150         kernel port. */\r
 151         vStartDynamicPriorityTasks();\r
 152         vCreateBlockTimeTasks();\r
 153 //      vStartGenericQueueTasks( tskIDLE_PRIORITY );\r
 154 //      vStartRecursiveMutexTasks();\r
 155 //      vStartTimerDemoTask( mainTIMER_TEST_PERIOD );\r
 156 //      vStartEventGroupTasks();\r
 157 //      vStartTaskNotifyTask();\r
 158 \r
 159         /* Create the register check tasks, as described at the top of this     file.\r
 160         Use xTaskCreateStatic() to create a task using only statically allocated\r
 161         memory. */\r
 162 //      xTaskCreate( prvRegTestTaskEntry1,                      /* The function that implements the task. */\r
 163 //                               "Reg1",                                                /* The name of the task. */\r
 164 //                               mainREG_TEST_STACK_SIZE_WORDS, /* Size of stack to allocate for the task - in words not bytes!. */\r
 165 //                               mainREG_TEST_TASK_1_PARAMETER, /* Parameter passed into the task. */\r
 166 //                               tskIDLE_PRIORITY,                              /* Priority of the task. */\r
 167 //                               NULL );                                                /* Can be used to pass out a handle to the created task. */\r
 168 //      xTaskCreate( prvRegTestTaskEntry2, "Reg2", mainREG_TEST_STACK_SIZE_WORDS, mainREG_TEST_TASK_2_PARAMETER, tskIDLE_PRIORITY, NULL );\r
 169 \r
 170         /* Create the task that performs the 'check' functionality,     as described at\r
 171         the top of this file. */\r
 172         xTaskCreate( prvCheckTask, "Check", mainCHECK_TASK_STACK_SIZE_WORDS, NULL, mainCHECK_TASK_PRIORITY, NULL );\r
 173 \r
 174         /* Start the scheduler. */\r
 175         vTaskStartScheduler();\r
 176 \r
 177         /* If all is well, the scheduler will now be running, and the following\r
 178         line will never be reached.  If the following line does execute, then\r
 179         there was insufficient FreeRTOS heap memory available for the Idle and/or\r
 180         timer tasks to be created.  See the memory management section on the\r
 181         FreeRTOS web site for more details on the FreeRTOS heap\r
 182         http://www.freertos.org/a00111.html. */\r
 183         for( ;; );\r
 184 }\r
 185 /*-----------------------------------------------------------*/\r
 186 \r
 187 static void prvCheckTask( void *pvParameters )\r
 188 {\r
 189 TickType_t xDelayPeriod = mainNO_ERROR_CHECK_TASK_PERIOD;\r
 190 TickType_t xLastExecutionTime;\r
 191 static unsigned long ulLastRegTest1Value = 0, ulLastRegTest2Value = 0;\r
 192 char * const pcPassMessage = "Pass.\r\n";\r
 193 char * pcStatusMessage = pcPassMessage;\r
 194 extern void vSendString( const char * const pcString );\r
 195 extern void vToggleLED( void );\r
 196 \r
 197         /* Just to stop compiler warnings. */\r
 198         ( void ) pvParameters;\r
 199 \r
 200         /* Initialise xLastExecutionTime so the first call to vTaskDelayUntil()\r
 201         works correctly. */\r
 202         xLastExecutionTime = xTaskGetTickCount();\r
 203 \r
 204         /* Cycle for ever, delaying then checking all the other tasks are still\r
 205         operating without error.  The onboard LED is toggled on each iteration.\r
 206         If an error is detected then the delay period is decreased from\r
 207         mainNO_ERROR_CHECK_TASK_PERIOD to mainERROR_CHECK_TASK_PERIOD.  This has the\r
 208         effect of increasing the rate at which the onboard LED toggles, and in so\r
 209         doing gives visual feedback of the system status. */\r
 210         for( ;; )\r
 211         {\r
 212                 /* Delay until it is time to execute again. */\r
 213                 vTaskDelayUntil( &xLastExecutionTime, xDelayPeriod );\r
 214 \r
 215                 /* Check all the demo tasks (other than the flash tasks) to ensure\r
 216                 that they are all still running, and that none have detected an error. */\r
 217                 if( xAreDynamicPriorityTasksStillRunning() != pdTRUE )\r
 218                 {\r
 219                         pcStatusMessage = "ERROR: Dynamic priority demo/tests.\r\n";\r
 220                 }\r
 221 \r
 222                 if ( xAreBlockTimeTestTasksStillRunning() != pdTRUE )\r
 223                 {\r
 224                         pcStatusMessage = "ERROR: Block time demo/tests.\r\n";\r
 225                 }\r
 226 \r
 227                 if ( xAreGenericQueueTasksStillRunning() != pdTRUE )\r
 228                 {\r
 229 //                      pcStatusMessage = "ERROR: Generic queue demo/tests.\r\n";\r
 230                 }\r
 231 \r
 232                 if ( xAreRecursiveMutexTasksStillRunning() != pdTRUE )\r
 233                 {\r
 234 //                      pcStatusMessage = "ERROR: Recursive mutex demo/tests.\r\n";\r
 235                 }\r
 236 \r
 237                 if( xAreTimerDemoTasksStillRunning( ( TickType_t ) xDelayPeriod ) != pdPASS )\r
 238                 {\r
 239 //                      pcStatusMessage = "ERROR: Timer demo/tests.\r\n";\r
 240                 }\r
 241 \r
 242                 if( xAreEventGroupTasksStillRunning() != pdPASS )\r
 243                 {\r
 244 //                      pcStatusMessage = "ERROR: Event group demo/tests.\r\n";\r
 245                 }\r
 246 \r
 247                 if( xAreTaskNotificationTasksStillRunning() != pdPASS )\r
 248                 {\r
 249 //                      pcStatusMessage = "ERROR: Task notification demo/tests.\r\n";\r
 250                 }\r
 251 \r
 252                 /* Check that the register test 1 task is still running. */\r
 253                 if( ulLastRegTest1Value == ulRegTest1LoopCounter )\r
 254                 {\r
 255 //                      pcStatusMessage = "ERROR: Register test 1.\r\n";\r
 256                 }\r
 257                 ulLastRegTest1Value = ulRegTest1LoopCounter;\r
 258 \r
 259                 /* Check that the register test 2 task is still running. */\r
 260                 if( ulLastRegTest2Value == ulRegTest2LoopCounter )\r
 261                 {\r
 262 //                      pcStatusMessage = "ERROR: Register test 2.\r\n";\r
 263                 }\r
 264                 ulLastRegTest2Value = ulRegTest2LoopCounter;\r
 265 \r
 266                 /* Write the status message to the UART. */\r
 267 //              vSendString( pcStatusMessage );\r
 268                 vToggleLED();\r
 269 \r
 270                 /* If an error has been found then increase the LED toggle rate by\r
 271                 increasing the cycle frequency. */\r
 272                 if( pcStatusMessage != pcPassMessage )\r
 273                 {\r
 274                         xDelayPeriod = mainERROR_CHECK_TASK_PERIOD;\r
 275                 }\r
 276         }\r
 277 }\r
 278 /*-----------------------------------------------------------*/\r
 279 \r
 280 static void prvRegTestTaskEntry1( void *pvParameters )\r
 281 {\r
 282         /* Although the regtest task is written in assembler, its entry point is\r
 283         written in C for convenience of checking the task parameter is being passed\r
 284         in correctly. */\r
 285         if( pvParameters == mainREG_TEST_TASK_1_PARAMETER )\r
 286         {\r
 287                 /* Start the part of the test that is written in assembler. */\r
 288                 vRegTest1Implementation();\r
 289         }\r
 290 \r
 291         /* The following line will only execute if the task parameter is found to\r
 292         be incorrect.  The check task will detect that the regtest loop counter is\r
 293         not being incremented and flag an error. */\r
 294         vTaskDelete( NULL );\r
 295 }\r
 296 /*-----------------------------------------------------------*/\r
 297 \r
 298 static void prvRegTestTaskEntry2( void *pvParameters )\r
 299 {\r
 300         /* Although the regtest task is written in assembler, its entry point is\r
 301         written in C for convenience of checking the task parameter is being passed\r
 302         in correctly. */\r
 303         if( pvParameters == mainREG_TEST_TASK_2_PARAMETER )\r
 304         {\r
 305                 /* Start the part of the test that is written in assembler. */\r
 306                 vRegTest2Implementation();\r
 307         }\r
 308 \r
 309         /* The following line will only execute if the task parameter is found to\r
 310         be incorrect.  The check task will detect that the regtest loop counter is\r
 311         not being incremented and flag an error. */\r
 312         vTaskDelete( NULL );\r
 313 }\r
 314 /*-----------------------------------------------------------*/\r
 315 \r
 316 void vFullDemoTickHook( void )\r
 317 {\r
 318         /* Called from vApplicationTickHook() when the project is configured to\r
 319         build the full demo. */\r
 320 //      vTimerPeriodicISRTests();\r
 321 //      vPeriodicEventGroupsProcessing();\r
 322 }\r