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