git.sur5r.net Git - freertos/blob - FreeRTOS/Demo/PIC32MX_MPLAB/main_full.c

   1 /*\r
   2     FreeRTOS V9.0.0 - Copyright (C) 2016 Real Time Engineers Ltd.\r
   3     All rights reserved\r
   4 \r
   5     VISIT http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.\r
   6 \r
   7     This file is part of the FreeRTOS distribution.\r
   8 \r
   9     FreeRTOS is free software; you can redistribute it and/or modify it under\r
  10     the terms of the GNU General Public License (version 2) as published by the\r
  11     Free Software Foundation >>>> AND MODIFIED BY <<<< the FreeRTOS exception.\r
  12 \r
  13     ***************************************************************************\r
  14     >>!   NOTE: The modification to the GPL is included to allow you to     !<<\r
  15     >>!   distribute a combined work that includes FreeRTOS without being   !<<\r
  16     >>!   obliged to provide the source code for proprietary components     !<<\r
  17     >>!   outside of the FreeRTOS kernel.                                   !<<\r
  18     ***************************************************************************\r
  19 \r
  20     FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY\r
  21     WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS\r
  22     FOR A PARTICULAR PURPOSE.  Full license text is available on the following\r
  23     link: http://www.freertos.org/a00114.html\r
  24 \r
  25     ***************************************************************************\r
  26      *                                                                       *\r
  27      *    FreeRTOS provides completely free yet professionally developed,    *\r
  28      *    robust, strictly quality controlled, supported, and cross          *\r
  29      *    platform software that is more than just the market leader, it     *\r
  30      *    is the industry's de facto standard.                               *\r
  31      *                                                                       *\r
  32      *    Help yourself get started quickly while simultaneously helping     *\r
  33      *    to support the FreeRTOS project by purchasing a FreeRTOS           *\r
  34      *    tutorial book, reference manual, or both:                          *\r
  35      *    http://www.FreeRTOS.org/Documentation                              *\r
  36      *                                                                       *\r
  37     ***************************************************************************\r
  38 \r
  39     http://www.FreeRTOS.org/FAQHelp.html - Having a problem?  Start by reading\r
  40     the FAQ page "My application does not run, what could be wrong?".  Have you\r
  41     defined configASSERT()?\r
  42 \r
  43     http://www.FreeRTOS.org/support - In return for receiving this top quality\r
  44     embedded software for free we request you assist our global community by\r
  45     participating in the support forum.\r
  46 \r
  47     http://www.FreeRTOS.org/training - Investing in training allows your team to\r
  48     be as productive as possible as early as possible.  Now you can receive\r
  49     FreeRTOS training directly from Richard Barry, CEO of Real Time Engineers\r
  50     Ltd, and the world's leading authority on the world's leading RTOS.\r
  51 \r
  52     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
  53     including FreeRTOS+Trace - an indispensable productivity tool, a DOS\r
  54     compatible FAT file system, and our tiny thread aware UDP/IP stack.\r
  55 \r
  56     http://www.FreeRTOS.org/labs - Where new FreeRTOS products go to incubate.\r
  57     Come and try FreeRTOS+TCP, our new open source TCP/IP stack for FreeRTOS.\r
  58 \r
  59     http://www.OpenRTOS.com - Real Time Engineers ltd. license FreeRTOS to High\r
  60     Integrity Systems ltd. to sell under the OpenRTOS brand.  Low cost OpenRTOS\r
  61     licenses offer ticketed support, indemnification and commercial middleware.\r
  62 \r
  63     http://www.SafeRTOS.com - High Integrity Systems also provide a safety\r
  64     engineered and independently SIL3 certified version for use in safety and\r
  65     mission critical applications that require provable dependability.\r
  66 \r
  67     1 tab == 4 spaces!\r
  68 */\r
  69 \r
  70 /******************************************************************************\r
  71  * NOTE 1:  This project provides two demo applications.  A simple blinky style\r
  72  * project, and a more comprehensive test and demo application.  The\r
  73  * mainCREATE_SIMPLE_BLINKY_DEMO_ONLY setting in main.c is used to select\r
  74  * between the two.  See the notes on using mainCREATE_SIMPLE_BLINKY_DEMO_ONLY\r
  75  * in main.c.  This file implements the comprehensive test and demo version.\r
  76  *\r
  77  * NOTE 2:  This file only contains the source code that is specific to the\r
  78  * full demo.  Generic functions, such FreeRTOS hook functions, and functions\r
  79  * required to configure the hardware, are defined in main.c.\r
  80  ******************************************************************************\r
  81  *\r
  82  * main_full() creates all the demo application tasks and software timers, then\r
  83  * starts the scheduler.  The WEB documentation provides more details of the\r
  84  * standard demo application tasks.  In addition to the standard demo tasks, the\r
  85  * following tasks and tests are defined and/or created within this file:\r
  86  *\r
  87  * "LCD" task - the LCD task is a 'gatekeeper' task.  It is the only task that\r
  88  * is permitted to access the display directly.  Other tasks wishing to write a\r
  89  * message to the LCD send the message on a queue to the LCD task instead of\r
  90  * accessing the LCD themselves.  The LCD task just blocks on the queue waiting\r
  91  * for messages - waking and displaying the messages as they arrive.\r
  92  * **NOTE** The LCD driver has a dependency on the PLIB library, which is no\r
  93  * longer provided by Microchip, so LCD functionality has been removed from this\r
  94  * demo - however the source files remain in the distribution.\r
  95  *\r
  96  * "Check" timer - The check software timer period is initially set to three\r
  97  * seconds.  The callback function associated with the check software timer\r
  98  * checks that all the standard demo tasks, and the register check tasks, are\r
  99  * not only still executing, but are executing without reporting any errors.  If\r
 100  * the check software timer discovers that a task has either stalled, or\r
 101  * reported an error, then it changes its own execution period from the initial\r
 102  * three seconds, to just 200ms.  The check software timer callback function\r
 103  * also writes a status message to the LCD (via the LCD task).  If all the demo\r
 104  * tasks are executing with their expected behaviour then the check task writes\r
 105  * a count of the number of times the high frequency interrupt has incremented\r
 106  * ulHighFrequencyTimerInterrupts - which is one in every 20,000 interrupts.\r
 107  *\r
 108  * "Register test" tasks - These tasks are used in part to test the kernel port.\r
 109  * They set each processor register to a known value, then check that the\r
 110  * register still contains that value.  Each of the tasks sets the registers\r
 111  * to different values, and will get swapping in and out between setting and\r
 112  * then subsequently checking the register values.  Discovery of an incorrect\r
 113  * value would be indicative of an error in the task switching mechanism.\r
 114  *\r
 115  * By way of demonstration, the demo application defines\r
 116  * configMAX_SYSCALL_INTERRUPT_PRIORITY to be 3, configKERNEL_INTERRUPT_PRIORITY\r
 117  * to be 1, and all other interrupts as follows:\r
 118  *\r
 119  *      + The UART is allocated a priority of 2. This means it can interrupt the\r
 120  *    RTOS tick, and can also safely use queues.\r
 121  *    **NOTE** The UART driver has a dependency on the PLIB library, which is no\r
 122  *    longer provided by Microchip, so UART functionality has been removed from\r
 123  *    this demo - however the source files remain in the distribution.\r
 124  *\r
 125  *  + Two timers are configured to generate interrupts just to test the nesting\r
 126  *    and queue access mechanisms. These timers are allocated priorities 2 and 3\r
 127  *    respectively. Even though they both access the same two queues, the\r
 128  *    priority 3 interrupt can safely interrupt the priority 2 interrupt. Both\r
 129  *    can interrupt the RTOS tick.\r
 130  *  + Finally a high frequency timer interrupt is configured to use priority 4 -\r
 131  *    therefore kernel activity will never prevent the high frequency timer from\r
 132  *    executing immediately that the interrupt is raised (within the limitations\r
 133  *    of the hardware itself). It would not be safe to access a queue from this\r
 134  *    interrupt as it is above configMAX_SYSCALL_INTERRUPT_PRIORITY.\r
 135  *\r
 136  * See the online documentation for this demo for more information on interrupt\r
 137  * usage.\r
 138  */\r
 139 \r
 140 /* Standard includes. */\r
 141 #include <stdio.h>\r
 142 \r
 143 /* Scheduler includes. */\r
 144 #include "FreeRTOS.h"\r
 145 #include "task.h"\r
 146 #include "queue.h"\r
 147 #include "timers.h"\r
 148 \r
 149 /* Demo application includes. */\r
 150 #include "partest.h"\r
 151 #include "blocktim.h"\r
 152 #include "flash_timer.h"\r
 153 #include "semtest.h"\r
 154 #include "GenQTest.h"\r
 155 #include "QPeek.h"\r
 156 #include "lcd.h"\r
 157 #include "timertest.h"\r
 158 #include "IntQueue.h"\r
 159 \r
 160 /*-----------------------------------------------------------*/\r
 161 \r
 162 /* The period after which the check timer will expire, in ms, provided no errors\r
 163 have been reported by any of the standard demo tasks.  ms are converted to the\r
 164 equivalent in ticks using the portTICK_PERIOD_MS constant. */\r
 165 #define mainCHECK_TIMER_PERIOD_MS                       ( 3000UL / portTICK_PERIOD_MS )\r
 166 \r
 167 /* The period at which the check timer will expire, in ms, if an error has been\r
 168 reported in one of the standard demo tasks.  ms are converted to the equivalent\r
 169 in ticks using the portTICK_PERIOD_MS constant. */\r
 170 #define mainERROR_CHECK_TIMER_PERIOD_MS         ( 200UL / portTICK_PERIOD_MS )\r
 171 \r
 172 /* The priorities of the various demo application tasks. */\r
 173 #define mainSEM_TEST_PRIORITY                           ( tskIDLE_PRIORITY + 1 )\r
 174 #define mainBLOCK_Q_PRIORITY                            ( tskIDLE_PRIORITY + 2 )\r
 175 #define mainCOM_TEST_PRIORITY                           ( tskIDLE_PRIORITY + 2 )\r
 176 #define mainINTEGER_TASK_PRIORITY           ( tskIDLE_PRIORITY )\r
 177 #define mainGEN_QUEUE_TASK_PRIORITY                     ( tskIDLE_PRIORITY )\r
 178 \r
 179 /* Misc. */\r
 180 #define mainDONT_BLOCK                                          ( 0 )\r
 181 \r
 182 /* Dimension the buffer used to hold the value of the high frequency timer\r
 183 count when it is converted to a string. */\r
 184 #define mainMAX_STRING_LENGTH                           ( 20 )\r
 185 \r
 186 /* The frequency at which the "fast interrupt test" interrupt will occur. */\r
 187 #define mainTEST_INTERRUPT_FREQUENCY            ( 20000 )\r
 188 \r
 189 /* The number of timer clocks expected to occur between each "fast interrupt\r
 190 test" interrupt. */\r
 191 #define mainEXPECTED_CLOCKS_BETWEEN_INTERRUPTS ( ( configCPU_CLOCK_HZ >> 1 ) / mainTEST_INTERRUPT_FREQUENCY )\r
 192 \r
 193 /* The number of nano seconds between each core clock. */\r
 194 #define mainNS_PER_CLOCK ( ( unsigned long ) ( ( 1.0 / ( double ) ( configCPU_CLOCK_HZ >> 1 ) ) * 1000000000.0 ) )\r
 195 \r
 196 /* The number of LEDs that should be controlled by the flash software timer\r
 197 standard demo and the LED to be toggle by the check task.  The starter kit only\r
 198 has three LEDs so when the demo is configured to run on the starter kit there\r
 199 is one less flash timer so the check task can use the third LED. */\r
 200 #ifdef PIC32_STARTER_KIT\r
 201         #define mainNUM_FLASH_TIMER_LEDS                        ( 2 )\r
 202         #define mainCHECK_LED                                           ( 2 )\r
 203 #else\r
 204         #define mainNUM_FLASH_TIMER_LEDS                        ( 3 )\r
 205         #define mainCHECK_LED                                           ( 7 )\r
 206 #endif\r
 207 \r
 208 /*-----------------------------------------------------------*/\r
 209 \r
 210 /*\r
 211  * The check timer callback function, as described at the top of this file.\r
 212  */\r
 213 static void prvCheckTimerCallback( TimerHandle_t xTimer );\r
 214 \r
 215 /*\r
 216  * It is important to ensure the high frequency timer test does not start before\r
 217  * the kernel.  It is therefore started from inside a software timer callback\r
 218  * function, which will not execute until the timer service/daemon task is\r
 219  * executing.  A one-shot timer is used, so the callback function will only\r
 220  * execute once (unless it is manually reset/restarted).\r
 221  */\r
 222 static void prvSetupHighFrequencyTimerTest( TimerHandle_t xTimer );\r
 223 \r
 224 /*\r
 225  * Tasks that test the context switch mechanism by filling the processor\r
 226  * registers with known values, then checking that the values contained\r
 227  * within the registers is as expected.  The tasks are likely to get swapped\r
 228  * in and out between setting the register values and checking the register\r
 229  * values.\r
 230  */\r
 231 static void prvRegTestTask1( void *pvParameters );\r
 232 static void prvRegTestTask2( void *pvParameters );\r
 233 \r
 234 /*-----------------------------------------------------------*/\r
 235 \r
 236 /* The queue used to send messages to the LCD task. */\r
 237 static QueueHandle_t xLCDQueue;\r
 238 \r
 239 /* Variables incremented by prvRegTestTask1() and prvRegTestTask2() respectively on\r
 240 each iteration of their function.  This is used to detect either task stopping\r
 241 their execution.. */\r
 242 volatile unsigned long ulRegTest1Cycles = 0, ulRegTest2Cycles = 0;\r
 243 \r
 244 /*-----------------------------------------------------------*/\r
 245 \r
 246 /*\r
 247  * Create the demo tasks then start the scheduler.\r
 248  */\r
 249 int main_full( void )\r
 250 {\r
 251 TimerHandle_t xTimer = NULL;\r
 252 \r
 253         /* Create all the other standard demo tasks. */\r
 254         vStartLEDFlashTimers( mainNUM_FLASH_TIMER_LEDS );\r
 255     vCreateBlockTimeTasks();\r
 256     vStartSemaphoreTasks( mainSEM_TEST_PRIORITY );\r
 257     vStartGenericQueueTasks( mainGEN_QUEUE_TASK_PRIORITY );\r
 258     vStartQueuePeekTasks();\r
 259         vStartInterruptQueueTasks();\r
 260 \r
 261         /* Create the tasks defined within this file. */\r
 262         xTaskCreate( prvRegTestTask1, "Reg1", configMINIMAL_STACK_SIZE, NULL, tskIDLE_PRIORITY, NULL );\r
 263         xTaskCreate( prvRegTestTask2, "Reg2", configMINIMAL_STACK_SIZE, NULL, tskIDLE_PRIORITY, NULL );\r
 264 \r
 265         /* Create the software timer that performs the 'check' functionality, as\r
 266         described at the top of this file. */\r
 267         xTimer = xTimerCreate(  "CheckTimer",/* A text name, purely to help debugging. */\r
 268                                                         ( mainCHECK_TIMER_PERIOD_MS ),          /* The timer period, in this case 3000ms (3s). */\r
 269                                                         pdTRUE,                                                         /* This is an auto-reload timer, so xAutoReload is set to pdTRUE. */\r
 270                                                         ( void * ) 0,                                           /* The ID is not used, so can be set to anything. */\r
 271                                                         prvCheckTimerCallback                           /* The callback function that inspects the status of all the other tasks. */\r
 272                                                 );\r
 273 \r
 274         if( xTimer != NULL )\r
 275         {\r
 276                 xTimerStart( xTimer, mainDONT_BLOCK );\r
 277         }\r
 278 \r
 279         /* A software timer is also used to start the high frequency timer test.\r
 280         This is to ensure the test does not start before the kernel.  This time a\r
 281         one shot software timer is used. */\r
 282         xTimer = xTimerCreate( "HighHzTimerSetup", 1, pdFALSE, ( void * ) 0, prvSetupHighFrequencyTimerTest );\r
 283         if( xTimer != NULL )\r
 284         {\r
 285                 xTimerStart( xTimer, mainDONT_BLOCK );\r
 286         }\r
 287 \r
 288         /* Finally start the scheduler. */\r
 289         vTaskStartScheduler();\r
 290 \r
 291         /* If all is well, the scheduler will now be running, and the following line\r
 292         will never be reached.  If the following line does execute, then there was\r
 293         insufficient FreeRTOS heap memory available for the idle and/or timer tasks\r
 294         to be created.  See the memory management section on the FreeRTOS web site\r
 295         for more details. */\r
 296         for( ;; );\r
 297 }\r
 298 /*-----------------------------------------------------------*/\r
 299 \r
 300 static void prvRegTestTask1( void *pvParameters )\r
 301 {\r
 302 extern void vRegTest1( volatile unsigned long * );\r
 303 \r
 304         /* Avoid compiler warnings. */\r
 305         ( void ) pvParameters;\r
 306 \r
 307         /* Pass the address of the RegTest1 loop counter into the test function,\r
 308         which is necessarily implemented in assembler. */\r
 309         vRegTest1( &ulRegTest1Cycles );\r
 310 \r
 311         /* vRegTest1 should never exit! */\r
 312         vTaskDelete( NULL );\r
 313 }\r
 314 /*-----------------------------------------------------------*/\r
 315 \r
 316 static void prvRegTestTask2( void *pvParameters )\r
 317 {\r
 318 extern void vRegTest2( volatile unsigned long * );\r
 319 \r
 320         /* Avoid compiler warnings. */\r
 321         ( void ) pvParameters;\r
 322 \r
 323         /* Pass the address of the RegTest2 loop counter into the test function,\r
 324         which is necessarily implemented in assembler. */\r
 325         vRegTest2( &ulRegTest2Cycles );\r
 326 \r
 327         /* vRegTest1 should never exit! */\r
 328         vTaskDelete( NULL );\r
 329 }\r
 330 /*-----------------------------------------------------------*/\r
 331 \r
 332 static void prvCheckTimerCallback( TimerHandle_t xTimer )\r
 333 {\r
 334 static long lChangedTimerPeriodAlready = pdFALSE;\r
 335 static unsigned long ulLastRegTest1Value = 0, ulLastRegTest2Value = 0;\r
 336 \r
 337 /* Buffer into which the high frequency timer count is written as a string. */\r
 338 static char cStringBuffer[ mainMAX_STRING_LENGTH ];\r
 339 \r
 340 /* The count of the high frequency timer interrupts. */\r
 341 extern unsigned long ulHighFrequencyTimerInterrupts;\r
 342 static xLCDMessage xMessage = { ( 200 / portTICK_PERIOD_MS ), cStringBuffer };\r
 343 \r
 344         /* Check that the register test 1 task is still running. */\r
 345         if( ulLastRegTest1Value == ulRegTest1Cycles )\r
 346         {\r
 347                 xMessage.pcMessage = "Error: Reg test2";\r
 348         }\r
 349         ulLastRegTest1Value = ulRegTest1Cycles;\r
 350 \r
 351 \r
 352         /* Check that the register test 2 task is still running. */\r
 353         if( ulLastRegTest2Value == ulRegTest2Cycles )\r
 354         {\r
 355                 xMessage.pcMessage = "Error: Reg test3";\r
 356         }\r
 357         ulLastRegTest2Value = ulRegTest2Cycles;\r
 358 \r
 359 \r
 360         /* Have any of the standard demo tasks detected an error in their\r
 361         operation? */\r
 362         if( xAreGenericQueueTasksStillRunning() != pdTRUE )\r
 363         {\r
 364                 xMessage.pcMessage = "Error: Gen Q";\r
 365         }\r
 366         else if( xAreQueuePeekTasksStillRunning() != pdTRUE )\r
 367         {\r
 368                 xMessage.pcMessage = "Error: Q Peek";\r
 369         }\r
 370         else if( xAreBlockTimeTestTasksStillRunning() != pdTRUE )\r
 371         {\r
 372                 xMessage.pcMessage = "Error: Blck time";\r
 373         }\r
 374         else if( xAreSemaphoreTasksStillRunning() != pdTRUE )\r
 375         {\r
 376                 xMessage.pcMessage = "Error: Sem test";\r
 377         }\r
 378         else if( xAreIntQueueTasksStillRunning() != pdTRUE )\r
 379         {\r
 380                 xMessage.pcMessage = "Error: Int queue";\r
 381         }\r
 382 \r
 383         if( xMessage.pcMessage != cStringBuffer )\r
 384         {\r
 385                 /* An error string has been logged.  If the timer period has not yet\r
 386                 been changed it should be changed now.  Increasing the frequency of the\r
 387                 LED gives visual feedback of the error status. */\r
 388                 if( lChangedTimerPeriodAlready == pdFALSE )\r
 389                 {\r
 390                         lChangedTimerPeriodAlready = pdTRUE;\r
 391 \r
 392                         /* This call to xTimerChangePeriod() uses a zero block time.\r
 393                         Functions called from inside of a timer callback function must\r
 394                         *never* attempt to block as to do so could impact other software\r
 395                         timers. */\r
 396                         xTimerChangePeriod( xTimer, ( mainERROR_CHECK_TIMER_PERIOD_MS ), mainDONT_BLOCK );\r
 397                 }\r
 398         }\r
 399         else\r
 400         {\r
 401                 /* Write the ulHighFrequencyTimerInterrupts value to the string\r
 402                 buffer.  It will only be displayed if no errors have been detected. */\r
 403                 sprintf( cStringBuffer, "Pass %u", ( unsigned int ) ulHighFrequencyTimerInterrupts );\r
 404         }\r
 405 \r
 406         vParTestToggleLED( mainCHECK_LED );\r
 407 }\r
 408 /*-----------------------------------------------------------*/\r
 409 \r
 410 static void prvSetupHighFrequencyTimerTest( TimerHandle_t xTimer )\r
 411 {\r
 412         /* Setup the high frequency, high priority, timer test.  It is setup in this\r
 413         software timer callback to ensure it does not start before the kernel does.\r
 414         This is a one shot timer - so the setup routine will only be executed once. */\r
 415         vSetupTimerTest( mainTEST_INTERRUPT_FREQUENCY );\r
 416 }\r
 417 \r