begriffs open source - cmsis-freertos/blob - Demo/RISC-V_RV32_SiFive_HiFive1-RevB_IAR/full_demo/main_full.c

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