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

   1 /*\r
   2         FreeRTOS.org V4.7.2 - Copyright (C) 2003-2008 Richard Barry.\r
   3 \r
   4         This file is part of the FreeRTOS.org distribution.\r
   5 \r
   6         FreeRTOS.org is free software; you can redistribute it and/or modify\r
   7         it under the terms of the GNU General Public License as published by\r
   8         the Free Software Foundation; either version 2 of the License, or\r
   9         (at your option) any later version.\r
  10 \r
  11         FreeRTOS.org is distributed in the hope that it will be useful,\r
  12         but WITHOUT ANY WARRANTY; without even the implied warranty of\r
  13         MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
  14         GNU General Public License for more details.\r
  15 \r
  16         You should have received a copy of the GNU General Public License\r
  17         along with FreeRTOS.org; if not, write to the Free Software\r
  18         Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA\r
  19 \r
  20         A special exception to the GPL can be applied should you wish to distribute\r
  21         a combined work that includes FreeRTOS.org, without being obliged to provide\r
  22         the source code for any proprietary components.  See the licensing section\r
  23         of http://www.FreeRTOS.org for full details of how and when the exception\r
  24         can be applied.\r
  25 \r
  26         ***************************************************************************\r
  27 \r
  28         Please ensure to read the configuration and relevant port sections of the \r
  29         online documentation.\r
  30 \r
  31         +++ http://www.FreeRTOS.org +++\r
  32         Documentation, latest information, license and contact details.  \r
  33 \r
  34         +++ http://www.SafeRTOS.com +++\r
  35         A version that is certified for use in safety critical systems.\r
  36 \r
  37         +++ http://www.OpenRTOS.com +++\r
  38         Commercial support, development, porting, licensing and training services.\r
  39 \r
  40         ***************************************************************************\r
  41 */\r
  42 \r
  43 /*\r
  44  * Creates all the demo application tasks, then starts the scheduler.  The WEB\r
  45  * documentation provides more details of the standard demo application tasks.\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  * "Fast Interrupt Test" - A high frequency periodic interrupt is generated\r
  50  * using a free running timer to demonstrate the use of the\r
  51  * configKERNEL_INTERRUPT_PRIORITY configuration constant.  The interrupt\r
  52  * service routine measures the number of processor clocks that occur between\r
  53  * each interrupt - and in so doing measures the jitter in the interrupt timing.\r
  54  * The maximum measured jitter time is latched in the ulMaxJitter variable, and\r
  55  * displayed on the LCD display by the 'LCD' task as described below.  The\r
  56  * fast interrupt is configured and handled in the timertest.c source file.\r
  57  *\r
  58  * "LCD" task - the LCD task is a 'gatekeeper' task.  It is the only task that\r
  59  * is permitted to access the display directly.  Other tasks wishing to write a\r
  60  * message to the LCD send the message on a queue to the LCD task instead of\r
  61  * accessing the LCD themselves.  The LCD task just blocks on the queue waiting\r
  62  * for messages - waking and displaying the messages as they arrive.\r
  63  *\r
  64  * "Check" task -  This only executes every three seconds but has the highest\r
  65  * priority so is guaranteed to get processor time.  Its main function is to \r
  66  * check that all the standard demo tasks are still operational.  Should any \r
  67  * unexpected behaviour within a demo task be discovered the check task will \r
  68  * write an error to the LCD (via the LCD task).  If all the demo tasks are \r
  69  * executing with their expected behaviour then the check task writes the \r
  70  * maximum jitter time to the LCD (as described above) - again via the LCD task.\r
  71  *\r
  72  * "Register test" tasks - These tasks are used in part to test the kernel port.\r
  73  * They set each processor register to a known value, then check that the \r
  74  * register still contains that value.  Each of the tasks sets the registers\r
  75  * to different values, and will get swapping in and out between setting and \r
  76  * then subsequently checking the register values.  Discovery of an incorrect\r
  77  * value would be indicative of an error in the task switching mechanism.\r
  78  */\r
  79 \r
  80 /* Standard includes. */\r
  81 #include <stdio.h>\r
  82 \r
  83 /* Scheduler includes. */\r
  84 #include "FreeRTOS.h"\r
  85 #include "task.h"\r
  86 #include "queue.h"\r
  87 \r
  88 /* Demo application includes. */\r
  89 #include "partest.h"\r
  90 #include "integer.h"\r
  91 #include "blocktim.h"\r
  92 #include "flash.h"\r
  93 #include "semtest.h"\r
  94 #include "GenQTest.h"\r
  95 #include "QPeek.h"\r
  96 #include "lcd.h"\r
  97 #include "comtest2.h"\r
  98 #include "timertest.h"\r
  99 \r
 100 #pragma config FPLLMUL = MUL_18, FPLLIDIV = DIV_2, FPLLODIV = DIV_1, FWDTEN = OFF\r
 101 #pragma config POSCMOD = HS, FNOSC = PRIPLL, FPBDIV = DIV_2\r
 102 \r
 103 /*-----------------------------------------------------------*/\r
 104 \r
 105 /* The rate at which the LED controlled by the 'check' task will flash when no\r
 106 errors have been detected. */\r
 107 #define mainNO_ERROR_PERIOD     ( 3000 / portTICK_RATE_MS )\r
 108 \r
 109 /* The rate at which the LED controlled by the 'check' task will flash when an\r
 110 error has been detected. */\r
 111 #define mainERROR_PERIOD        ( 500 )\r
 112 \r
 113 /* The priorities of the various demo application tasks. */\r
 114 #define mainCHECK_TASK_PRIORITY                         ( tskIDLE_PRIORITY + 4 )\r
 115 #define mainSEM_TEST_PRIORITY                           ( tskIDLE_PRIORITY + 1 )\r
 116 #define mainBLOCK_Q_PRIORITY                            ( tskIDLE_PRIORITY + 2 )\r
 117 #define mainCOM_TEST_PRIORITY                           ( tskIDLE_PRIORITY + 2 )\r
 118 #define mainINTEGER_TASK_PRIORITY           ( tskIDLE_PRIORITY )\r
 119 #define mainGEN_QUEUE_TASK_PRIORITY                     ( tskIDLE_PRIORITY )\r
 120 \r
 121 /* The LED controlled by the 'check' task. */\r
 122 #define mainCHECK_LED                                           ( 7 )\r
 123 \r
 124 /* The LED used by the comtest tasks.  mainCOM_TEST_LED + 1 is also used.\r
 125 See the comtest.c file for more information. */\r
 126 #define mainCOM_TEST_LED                                        ( 4 )\r
 127 \r
 128 /* Baud rate used by the comtest tasks. */\r
 129 #define mainCOM_TEST_BAUD_RATE                          ( 115200 )\r
 130 \r
 131 /* Misc. */\r
 132 #define mainDONT_WAIT                                           ( 0 )\r
 133 \r
 134 /* Dimension the buffer used to hold the value of the maximum jitter time when\r
 135 it is converted to a string. */\r
 136 #define mainMAX_STRING_LENGTH                           ( 20 )\r
 137 \r
 138 /* The frequency at which the "fast interrupt test" interrupt will occur. */\r
 139 #define mainTEST_INTERRUPT_FREQUENCY            ( 20000 )\r
 140 \r
 141 /* The number of timer clocks we expect to occur between each "fast\r
 142 interrupt test" interrupt. */\r
 143 #define mainEXPECTED_CLOCKS_BETWEEN_INTERRUPTS ( ( configCPU_CLOCK_HZ >> 1 ) / mainTEST_INTERRUPT_FREQUENCY )\r
 144 \r
 145 /* The number of nano seconds between each core clock. */\r
 146 #define mainNS_PER_CLOCK ( ( unsigned portLONG ) ( ( 1.0 / ( double ) ( configCPU_CLOCK_HZ >> 1 ) ) * 1000000000.0 ) )\r
 147 \r
 148 /*-----------------------------------------------------------*/\r
 149 \r
 150 /*\r
 151  * Setup the processor ready for the demo.\r
 152  */\r
 153 static void prvSetupHardware( void );\r
 154 \r
 155 /*\r
 156  * Implements the 'check' task functionality as described at the top of this \r
 157  * file. \r
 158  */\r
 159 static void prvCheckTask( void *pvParameters ) __attribute__((noreturn));\r
 160 \r
 161 /*\r
 162  * Tasks that test the context switch mechanism by filling the processor \r
 163  * registers with known values, then checking that the values contained\r
 164  * within the registers is as expected.  The tasks are likely to get swapped\r
 165  * in and out between setting the register values and checking the register\r
 166  * values. */\r
 167 static void prvTestTask1( void *pvParameters );\r
 168 static void prvTestTask2( void *pvParameters );\r
 169 \r
 170 /*-----------------------------------------------------------*/\r
 171 \r
 172 /* The queue used to send messages to the LCD task. */\r
 173 static xQueueHandle xLCDQueue;\r
 174 \r
 175 /* Flag used by prvTestTask1() and prvTestTask2() to indicate their status\r
 176 (pass/fail). */\r
 177 unsigned portLONG ulStatus1 = pdPASS;\r
 178 \r
 179 /* Variables incremented by prvTestTask1() and prvTestTask2() respectively on \r
 180 each iteration of their function.  This is used to detect either task stopping\r
 181 their execution.. */\r
 182 unsigned portLONG ulRegTest1Cycles = 0, ulRegTest2Cycles = 0;\r
 183 \r
 184 /*-----------------------------------------------------------*/\r
 185 \r
 186 \r
 187 /*\r
 188  * Create the demo tasks then start the scheduler.\r
 189  */\r
 190 int main( void )\r
 191 {\r
 192         /* Configure any hardware required for this demo. */\r
 193         prvSetupHardware();\r
 194 \r
 195         /* Create the LCD task - this returns the queue to use when writing \r
 196         messages to the LCD. */\r
 197         xLCDQueue = xStartLCDTask();\r
 198 \r
 199         /* Create all the other standard demo tasks. */\r
 200         vStartLEDFlashTasks( tskIDLE_PRIORITY );\r
 201     vCreateBlockTimeTasks();\r
 202     vStartSemaphoreTasks( mainSEM_TEST_PRIORITY );\r
 203     vStartIntegerMathTasks( mainINTEGER_TASK_PRIORITY );\r
 204     vStartGenericQueueTasks( mainGEN_QUEUE_TASK_PRIORITY );\r
 205     vStartQueuePeekTasks();\r
 206         vAltStartComTestTasks( mainCOM_TEST_PRIORITY, mainCOM_TEST_BAUD_RATE, mainCOM_TEST_LED );\r
 207 \r
 208         /* Create the tasks defined within this file. */\r
 209         xTaskCreate( prvTestTask1, "Tst1", configMINIMAL_STACK_SIZE, NULL, tskIDLE_PRIORITY, NULL );\r
 210         xTaskCreate( prvTestTask2, "Tst2", configMINIMAL_STACK_SIZE, NULL, tskIDLE_PRIORITY, NULL );\r
 211 \r
 212         /* prvCheckTask uses sprintf so requires more stack. */\r
 213         xTaskCreate( prvCheckTask, "Check", configMINIMAL_STACK_SIZE * 2, NULL, mainCHECK_TASK_PRIORITY, NULL );\r
 214 \r
 215         /* Setup the high frequency, high priority, timer test. */\r
 216         vSetupTimerTest( mainTEST_INTERRUPT_FREQUENCY );\r
 217 \r
 218         /* Finally start the scheduler. */\r
 219         vTaskStartScheduler();\r
 220 \r
 221         /* Will only reach here if there is insufficient heap available to start\r
 222         the scheduler. */\r
 223         return 0;\r
 224 }\r
 225 /*-----------------------------------------------------------*/\r
 226 \r
 227 static void prvTestTask1( void *pvParameters )\r
 228 {\r
 229 extern void vRegTest1( unsigned long * );\r
 230 \r
 231         for( ;; )\r
 232         {\r
 233                 /* Perform the register test function. */\r
 234                 vRegTest1( &ulStatus1 );\r
 235 \r
 236                 /* Increment the counter so the check task knows we are still \r
 237                 running. */\r
 238                 ulRegTest1Cycles++;\r
 239         }\r
 240 }\r
 241 /*-----------------------------------------------------------*/\r
 242 \r
 243 static void prvTestTask2( void *pvParameters )\r
 244 {\r
 245 extern void vRegTest2( unsigned long * );\r
 246 \r
 247         for( ;; )\r
 248         {\r
 249                 /* Perform the register test function. */\r
 250                 vRegTest2( &ulStatus1 );\r
 251 \r
 252                 /* Increment the counter so the check task knows we are still\r
 253                 running. */\r
 254                 ulRegTest2Cycles++;\r
 255         }\r
 256 }\r
 257 /*-----------------------------------------------------------*/\r
 258 \r
 259 static void prvSetupHardware( void )\r
 260 {\r
 261         /* Set the system and peripheral bus speeds and enable the program cache*/\r
 262     SYSTEMConfigPerformance( configCPU_CLOCK_HZ );\r
 263 \r
 264         /* Setup to use the external interrupt controller. */\r
 265     INTEnableSystemMultiVectoredInt();\r
 266 \r
 267         portDISABLE_INTERRUPTS();\r
 268 \r
 269         /* Setup the digital IO for the LED's. */\r
 270         vParTestInitialise();\r
 271 }\r
 272 /*-----------------------------------------------------------*/\r
 273 \r
 274 static void prvCheckTask( void *pvParameters )\r
 275 {\r
 276 unsigned portLONG ulLastRegTest1Value = 0, ulLastRegTest2Value = 0, ulTicksToWait = mainNO_ERROR_PERIOD;\r
 277 portTickType xLastExecutionTime;\r
 278 \r
 279 /* Buffer into which the maximum jitter time is written as a string. */\r
 280 static portCHAR cStringBuffer[ mainMAX_STRING_LENGTH ];\r
 281 \r
 282 /* The maximum jitter time measured by the fast interrupt test. */\r
 283 extern unsigned portLONG ulMaxJitter ;\r
 284 xLCDMessage xMessage = { ( 200 / portTICK_RATE_MS ), cStringBuffer };\r
 285 \r
 286         /* Initialise the variable used to control our iteration rate prior to\r
 287         its first use. */\r
 288         xLastExecutionTime = xTaskGetTickCount();\r
 289 \r
 290         for( ;; )\r
 291         {\r
 292                 /* Wait until it is time to run the tests again. */\r
 293                 vTaskDelayUntil( &xLastExecutionTime, ulTicksToWait );\r
 294 \r
 295                 /* Has either register check 1 or 2 task discovered an error? */\r
 296                 if( ulStatus1 != pdPASS )\r
 297                 {\r
 298                         ulTicksToWait = mainERROR_PERIOD;\r
 299                         xMessage.pcMessage = "Error: Reg test1";\r
 300                 }\r
 301 \r
 302                 /* Check that the register test 1 task is still running. */\r
 303                 if( ulLastRegTest1Value == ulRegTest1Cycles )\r
 304                 {\r
 305                         ulTicksToWait = mainERROR_PERIOD;\r
 306                         xMessage.pcMessage = "Error: Reg test2";\r
 307                 }\r
 308                 ulLastRegTest1Value = ulRegTest1Cycles;\r
 309 \r
 310                 \r
 311                 /* Check that the register test 2 task is still running. */\r
 312                 if( ulLastRegTest2Value == ulRegTest2Cycles )\r
 313                 {\r
 314                         ulTicksToWait = mainERROR_PERIOD;\r
 315                         xMessage.pcMessage = "Error: Reg test3";\r
 316                 }\r
 317                 ulLastRegTest2Value = ulRegTest2Cycles;\r
 318                 \r
 319 \r
 320                 /* Have any of the standard demo tasks detected an error in their \r
 321                 operation? */\r
 322                 if( xAreGenericQueueTasksStillRunning() != pdTRUE )\r
 323                 {\r
 324                         ulTicksToWait = mainERROR_PERIOD;\r
 325                         xMessage.pcMessage = "Error: Gen Q";\r
 326                 }\r
 327                 else if( xAreQueuePeekTasksStillRunning() != pdTRUE )\r
 328                 {\r
 329                         ulTicksToWait = mainERROR_PERIOD;\r
 330                         xMessage.pcMessage = "Error: Q Peek";\r
 331                 }\r
 332                 else if( xAreComTestTasksStillRunning() != pdTRUE )\r
 333                 {\r
 334                         ulTicksToWait = mainERROR_PERIOD;\r
 335                         xMessage.pcMessage = "Error: COM test";\r
 336                 }\r
 337                 else if( xAreBlockTimeTestTasksStillRunning() != pdTRUE )\r
 338                 {\r
 339                         ulTicksToWait = mainERROR_PERIOD;\r
 340                         xMessage.pcMessage = "Error: Blck time";\r
 341                 }\r
 342             else if( xAreSemaphoreTasksStillRunning() != pdTRUE )\r
 343             {\r
 344                 ulTicksToWait = mainERROR_PERIOD;\r
 345                         xMessage.pcMessage = "Error: Sem test";\r
 346             }\r
 347             else if( xAreIntegerMathsTaskStillRunning() != pdTRUE )\r
 348             {\r
 349                 ulTicksToWait = mainERROR_PERIOD;\r
 350                         xMessage.pcMessage = "Error: Int math";\r
 351             }\r
 352 \r
 353                 /* Write the max jitter time to the string buffer.  It will only be \r
 354                 displayed if no errors have been detected. */\r
 355                 sprintf( cStringBuffer, "%dns max jitter", ( int ) ( ( ulMaxJitter - mainEXPECTED_CLOCKS_BETWEEN_INTERRUPTS ) * mainNS_PER_CLOCK ) );\r
 356 \r
 357                 xQueueSend( xLCDQueue, &xMessage, mainDONT_WAIT );\r
 358                 vParTestToggleLED( mainCHECK_LED );\r
 359         }\r
 360 }\r
 361 /*-----------------------------------------------------------*/\r
 362 \r
 363 void vApplicationGeneralExceptionHandler( unsigned portLONG ulCause, unsigned portLONG ulStatus )\r
 364 {\r
 365         /* This overrides the definition provided by the kernel.  Other exceptions \r
 366         should be handled here. */\r
 367         for( ;; );\r
 368 }\r