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

   1 /*\r
   2  * FreeRTOS Kernel V10.2.1\r
   3  * Copyright (C) 2019 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 \r
  74 /* Standard demo application includes. */\r
  75 #include "dynamic.h"\r
  76 #include "blocktim.h"\r
  77 #include "GenQTest.h"\r
  78 #include "recmutex.h"\r
  79 #include "TimerDemo.h"\r
  80 #include "EventGroupsDemo.h"\r
  81 #include "TaskNotify.h"\r
  82 #include "AbortDelay.h"\r
  83 #include "countsem.h"\r
  84 #include "death.h"\r
  85 #include "MessageBufferDemo.h"\r
  86 #include "StreamBufferDemo.h"\r
  87 #include "StreamBufferInterrupt.h"\r
  88 \r
  89 /* Priorities for the demo application tasks. */\r
  90 #define mainCHECK_TASK_PRIORITY                         ( configMAX_PRIORITIES - 1 )\r
  91 #define mainCREATOR_TASK_PRIORITY                       ( tskIDLE_PRIORITY + 3UL )\r
  92 \r
  93 /* The period of the check task, in ms, converted to ticks using the\r
  94 pdMS_TO_TICKS() macro.  mainNO_ERROR_CHECK_TASK_PERIOD is used if no errors have\r
  95 been found, mainERROR_CHECK_TASK_PERIOD is used if an error has been found. */\r
  96 #define mainNO_ERROR_CHECK_TASK_PERIOD          pdMS_TO_TICKS( 3000UL )\r
  97 #define mainERROR_CHECK_TASK_PERIOD             pdMS_TO_TICKS( 500UL )\r
  98 \r
  99 /* Parameters that are passed into the register check tasks solely for the\r
 100 purpose of ensuring parameters are passed into tasks correctly. */\r
 101 #define mainREG_TEST_TASK_1_PARAMETER           ( ( void * ) 0x12345678 )\r
 102 #define mainREG_TEST_TASK_2_PARAMETER           ( ( void * ) 0x87654321 )\r
 103 \r
 104 /* The base period used by the timer test tasks. */\r
 105 #define mainTIMER_TEST_PERIOD                           ( 50 )\r
 106 \r
 107 /* The size of the stack allocated to the check task (as described in the\r
 108 comments at the top of this file. */\r
 109 #define mainCHECK_TASK_STACK_SIZE_WORDS 100\r
 110 \r
 111 /* Size of the stacks to allocated for the register check tasks. */\r
 112 #define mainREG_TEST_STACK_SIZE_WORDS 70\r
 113 \r
 114 /*-----------------------------------------------------------*/\r
 115 \r
 116 /*\r
 117  * Called by main() to run the full demo (as opposed to the blinky demo) when\r
 118  * mainCREATE_SIMPLE_BLINKY_DEMO_ONLY is set to 0.\r
 119  */\r
 120 void main_full( void );\r
 121 \r
 122 /*\r
 123  * The check task, as described at the top of this file.\r
 124  */\r
 125 static void prvCheckTask( void *pvParameters );\r
 126 \r
 127 /*\r
 128  * Initialise and start the peripheral timers that are used to exercise external\r
 129  * interrupt processing.\r
 130  */\r
 131 static void prvSetupPeripheralTimers( void );\r
 132 \r
 133 /*\r
 134  * Register check tasks as described at the top of this file.  The nature of\r
 135  * these files necessitates that they are written in an assembly file, but the\r
 136  * entry points are kept in the C file for the convenience of checking the task\r
 137  * parameter.\r
 138  */\r
 139 static void prvRegTestTaskEntry1( void *pvParameters );\r
 140 extern void vRegTest1Implementation( void );\r
 141 static void prvRegTestTaskEntry2( void *pvParameters );\r
 142 extern void vRegTest2Implementation( void );\r
 143 \r
 144 /*\r
 145  * Tick hook used by the full demo, which includes code that interacts with\r
 146  * some of the tests.\r
 147  */\r
 148 void vFullDemoTickHook( void );\r
 149 \r
 150 /*-----------------------------------------------------------*/\r
 151 \r
 152 /* The following two variables are used to communicate the status of the\r
 153 register check tasks to the check task.  If the variables keep incrementing,\r
 154 then the register check tasks have not discovered any errors.  If a variable\r
 155 stops incrementing, then an error has been found. */\r
 156 volatile uint32_t ulRegTest1LoopCounter = 0UL, ulRegTest2LoopCounter = 0UL;\r
 157 \r
 158 /*-----------------------------------------------------------*/\r
 159 \r
 160 void main_full( void )\r
 161 {\r
 162         /* Start all the other standard demo/test tasks.  They have no particular\r
 163         functionality, but do demonstrate how to use the FreeRTOS API and test the\r
 164         kernel port. */\r
 165         vStartDynamicPriorityTasks();\r
 166         vCreateBlockTimeTasks();\r
 167         vStartGenericQueueTasks( tskIDLE_PRIORITY );\r
 168         vStartRecursiveMutexTasks();\r
 169         vStartTimerDemoTask( mainTIMER_TEST_PERIOD );\r
 170         vStartEventGroupTasks();\r
 171         vStartTaskNotifyTask();\r
 172         vCreateAbortDelayTasks();\r
 173         vStartCountingSemaphoreTasks();\r
 174         vStartMessageBufferTasks( configMINIMAL_STACK_SIZE  );\r
 175         vStartStreamBufferTasks();\r
 176         vStartStreamBufferInterruptDemo();\r
 177 \r
 178         /* Create the register check tasks, as described at the top of this     file.\r
 179         Use xTaskCreateStatic() to create a task using only statically allocated\r
 180         memory. */\r
 181         xTaskCreate( prvRegTestTaskEntry1,                      /* The function that implements the task. */\r
 182                                  "Reg1",                                                /* The name of the task. */\r
 183                                  mainREG_TEST_STACK_SIZE_WORDS, /* Size of stack to allocate for the task - in words not bytes!. */\r
 184                                  mainREG_TEST_TASK_1_PARAMETER, /* Parameter passed into the task. */\r
 185                                  tskIDLE_PRIORITY,                              /* Priority of the task. */\r
 186                                  NULL );                                                /* Can be used to pass out a handle to the created task. */\r
 187         xTaskCreate( prvRegTestTaskEntry2, "Reg2", mainREG_TEST_STACK_SIZE_WORDS, mainREG_TEST_TASK_2_PARAMETER, tskIDLE_PRIORITY, NULL );\r
 188 \r
 189         /* Create the task that performs the 'check' functionality,     as described at\r
 190         the top of this file. */\r
 191         xTaskCreate( prvCheckTask, "Check", mainCHECK_TASK_STACK_SIZE_WORDS, NULL, mainCHECK_TASK_PRIORITY, NULL );\r
 192 \r
 193         /* The set of tasks created by the following function call have to be\r
 194         created last as they keep account of the number of tasks they expect to see\r
 195         running. */\r
 196         vCreateSuicidalTasks( mainCREATOR_TASK_PRIORITY );\r
 197 \r
 198         /* Start the scheduler. */\r
 199         vTaskStartScheduler();\r
 200 \r
 201         /* If all is well, the scheduler will now be running, and the following\r
 202         line will never be reached.  If the following line does execute, then\r
 203         there was insufficient FreeRTOS heap memory available for the Idle and/or\r
 204         timer tasks to be created.  See the memory management section on the\r
 205         FreeRTOS web site for more details on the FreeRTOS heap\r
 206         http://www.freertos.org/a00111.html. */\r
 207         for( ;; );\r
 208 }\r
 209 /*-----------------------------------------------------------*/\r
 210 \r
 211 static void prvCheckTask( void *pvParameters )\r
 212 {\r
 213 TickType_t xDelayPeriod = mainNO_ERROR_CHECK_TASK_PERIOD;\r
 214 TickType_t xLastExecutionTime;\r
 215 uint32_t ulLastRegTest1Value = 0, ulLastRegTest2Value = 0;\r
 216 char * const pcPassMessage = ".";\r
 217 char * pcStatusMessage = pcPassMessage;\r
 218 extern void vSendString( const char * const pcString );\r
 219 extern void vToggleLED( void );\r
 220 \r
 221         /* Just to stop compiler warnings. */\r
 222         ( void ) pvParameters;\r
 223 \r
 224         /* Start with a pass message, after which a '.' character will be printed\r
 225         out on each successful loop. */\r
 226         vSendString( "Pass" );\r
 227 \r
 228         /* Initialise xLastExecutionTime so the first call to vTaskDelayUntil()\r
 229         works correctly. */\r
 230         xLastExecutionTime = xTaskGetTickCount();\r
 231 \r
 232         /* Cycle for ever, delaying then checking all the other tasks are still\r
 233         operating without error.  The onboard LED is toggled on each iteration.\r
 234         If an error is detected then the delay period is decreased from\r
 235         mainNO_ERROR_CHECK_TASK_PERIOD to mainERROR_CHECK_TASK_PERIOD.  This has the\r
 236         effect of increasing the rate at which the onboard LED toggles, and in so\r
 237         doing gives visual feedback of the system status. */\r
 238         for( ;; )\r
 239         {\r
 240                 /* Delay until it is time to execute again. */\r
 241                 vTaskDelayUntil( &xLastExecutionTime, xDelayPeriod );\r
 242 \r
 243                 /* Check all the demo tasks (other than the flash tasks) to ensure\r
 244                 that they are all still running, and that none have detected an error. */\r
 245                 if( xAreDynamicPriorityTasksStillRunning() == pdFALSE )\r
 246                 {\r
 247                         pcStatusMessage = "ERROR: Dynamic priority demo/tests.\r\n";\r
 248                 }\r
 249 \r
 250                 if( xAreBlockTimeTestTasksStillRunning() == pdFALSE )\r
 251                 {\r
 252                         pcStatusMessage = "ERROR: Block time demo/tests.\r\n";\r
 253                 }\r
 254 \r
 255                 if( xAreGenericQueueTasksStillRunning() == pdFALSE )\r
 256                 {\r
 257                         pcStatusMessage = "ERROR: Generic queue demo/tests.\r\n";\r
 258                 }\r
 259 \r
 260                 if( xAreRecursiveMutexTasksStillRunning() == pdFALSE )\r
 261                 {\r
 262                         pcStatusMessage = "ERROR: Recursive mutex demo/tests.\r\n";\r
 263                 }\r
 264 \r
 265                 if( xAreTimerDemoTasksStillRunning( ( TickType_t ) xDelayPeriod ) == pdFALSE )\r
 266                 {\r
 267                         pcStatusMessage = "ERROR: Timer demo/tests.\r\n";\r
 268                 }\r
 269 \r
 270                 if( xAreEventGroupTasksStillRunning() == pdFALSE )\r
 271                 {\r
 272                         pcStatusMessage = "ERROR: Event group demo/tests.\r\n";\r
 273                 }\r
 274 \r
 275                 if( xAreTaskNotificationTasksStillRunning() == pdFALSE )\r
 276                 {\r
 277                         pcStatusMessage = "ERROR: Task notification demo/tests.\r\n";\r
 278                 }\r
 279 \r
 280                 if( xAreAbortDelayTestTasksStillRunning() == pdFALSE )\r
 281                 {\r
 282                         pcStatusMessage = "ERROR: Abort delay.\r\n";\r
 283                 }\r
 284 \r
 285                 if( xAreCountingSemaphoreTasksStillRunning() == pdFALSE )\r
 286                 {\r
 287                         pcStatusMessage = "ERROR: Counting semaphores.\r\n";\r
 288                 }\r
 289 \r
 290                 if( xIsCreateTaskStillRunning() == pdFALSE )\r
 291                 {\r
 292                         pcStatusMessage = "ERROR: Suicide tasks.\r\n";\r
 293                 }\r
 294 \r
 295                 if( xAreMessageBufferTasksStillRunning() == pdFALSE )\r
 296                 {\r
 297                         pcStatusMessage = "ERROR: Message buffer.\r\n";\r
 298                 }\r
 299 \r
 300                 if( xAreStreamBufferTasksStillRunning() == pdFALSE )\r
 301                 {\r
 302                         pcStatusMessage = "ERROR: Stream buffer.\r\n";\r
 303                 }\r
 304 \r
 305                 if( xIsInterruptStreamBufferDemoStillRunning() == pdFALSE )\r
 306                 {\r
 307                         pcStatusMessage = "ERROR: Stream buffer interrupt.\r\n";\r
 308                 }\r
 309 \r
 310                 /* Check that the register test 1 task is still running. */\r
 311                 if( ulLastRegTest1Value == ulRegTest1LoopCounter )\r
 312                 {\r
 313                         pcStatusMessage = "ERROR: Register test 1.\r\n";\r
 314                 }\r
 315                 ulLastRegTest1Value = ulRegTest1LoopCounter;\r
 316 \r
 317                 /* Check that the register test 2 task is still running. */\r
 318                 if( ulLastRegTest2Value == ulRegTest2LoopCounter )\r
 319                 {\r
 320                         pcStatusMessage = "ERROR: Register test 2.\r\n";\r
 321                 }\r
 322                 ulLastRegTest2Value = ulRegTest2LoopCounter;\r
 323 \r
 324                 /* Write the status message to the UART. */\r
 325                 vSendString( pcStatusMessage );\r
 326 \r
 327                 /* If an error has been found then increase the LED toggle rate by\r
 328                 increasing the cycle frequency. */\r
 329                 if( pcStatusMessage != pcPassMessage )\r
 330                 {\r
 331                         xDelayPeriod = mainERROR_CHECK_TASK_PERIOD;\r
 332                 }\r
 333         }\r
 334 }\r
 335 /*-----------------------------------------------------------*/\r
 336 \r
 337 static void prvRegTestTaskEntry1( void *pvParameters )\r
 338 {\r
 339         /* Although the regtest task is written in assembler, its entry point is\r
 340         written in C for convenience of checking the task parameter is being passed\r
 341         in correctly. */\r
 342         if( pvParameters == mainREG_TEST_TASK_1_PARAMETER )\r
 343         {\r
 344                 /* Start the part of the test that is written in assembler. */\r
 345                 vRegTest1Implementation();\r
 346         }\r
 347 \r
 348         /* The following line will only execute if the task parameter is found to\r
 349         be incorrect.  The check task will detect that the regtest loop counter is\r
 350         not being incremented and flag an error. */\r
 351         vTaskDelete( NULL );\r
 352 }\r
 353 /*-----------------------------------------------------------*/\r
 354 \r
 355 static void prvRegTestTaskEntry2( void *pvParameters )\r
 356 {\r
 357         /* Although the regtest task is written in assembler, its entry point is\r
 358         written in C for convenience of checking the task parameter is being passed\r
 359         in correctly. */\r
 360         if( pvParameters == mainREG_TEST_TASK_2_PARAMETER )\r
 361         {\r
 362                 /* Start the part of the test that is written in assembler. */\r
 363                 vRegTest2Implementation();\r
 364         }\r
 365 \r
 366         /* The following line will only execute if the task parameter is found to\r
 367         be incorrect.  The check task will detect that the regtest loop counter is\r
 368         not being incremented and flag an error. */\r
 369         vTaskDelete( NULL );\r
 370 }\r
 371 /*-----------------------------------------------------------*/\r
 372 \r
 373 void vFullDemoTickHook( void )\r
 374 {\r
 375         /* The full demo includes a software timer demo/test that requires\r
 376         prodding periodically from the tick interrupt. */\r
 377         vTimerPeriodicISRTests();\r
 378 \r
 379         /* Call the periodic event group from ISR demo. */\r
 380         vPeriodicEventGroupsProcessing();\r
 381 \r
 382         /* Use task notifications from an interrupt. */\r
 383         xNotifyTaskFromISR();\r
 384 \r
 385         /* Writes to stream buffer byte by byte to test the stream buffer trigger\r
 386         level functionality. */\r
 387         vPeriodicStreamBufferProcessing();\r
 388 \r
 389         /* Writes a string to a string buffer four bytes at a time to demonstrate\r
 390         a stream being sent from an interrupt to a task. */\r
 391         vBasicStreamBufferSendFromISR();\r
 392 \r
 393         /* Called from vApplicationTickHook() when the project is configured to\r
 394         build the full test/demo applications. */\r
 395 }\r
 396 /*-----------------------------------------------------------*/\r
 397 \r