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