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

   1 /*\r
   2     FreeRTOS V7.5.1 - Copyright (C) 2013 Real Time Engineers Ltd.\r
   3 \r
   4     VISIT http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.\r
   5 \r
   6     ***************************************************************************\r
   7      *                                                                       *\r
   8      *    FreeRTOS provides completely free yet professionally developed,    *\r
   9      *    robust, strictly quality controlled, supported, and cross          *\r
  10      *    platform software that has become a de facto standard.             *\r
  11      *                                                                       *\r
  12      *    Help yourself get started quickly and support the FreeRTOS         *\r
  13      *    project by purchasing a FreeRTOS tutorial book, reference          *\r
  14      *    manual, or both from: http://www.FreeRTOS.org/Documentation        *\r
  15      *                                                                       *\r
  16      *    Thank you!                                                         *\r
  17      *                                                                       *\r
  18     ***************************************************************************\r
  19 \r
  20     This file is part of the FreeRTOS distribution.\r
  21 \r
  22     FreeRTOS is free software; you can redistribute it and/or modify it under\r
  23     the terms of the GNU General Public License (version 2) as published by the\r
  24     Free Software Foundation >>!AND MODIFIED BY!<< the FreeRTOS exception.\r
  25 \r
  26     >>! NOTE: The modification to the GPL is included to allow you to distribute\r
  27     >>! a combined work that includes FreeRTOS without being obliged to provide\r
  28     >>! the source code for proprietary components outside of the FreeRTOS\r
  29     >>! kernel.\r
  30 \r
  31     FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY\r
  32     WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS\r
  33     FOR A PARTICULAR PURPOSE.  Full license text is available from the following\r
  34     link: http://www.freertos.org/a00114.html\r
  35 \r
  36     1 tab == 4 spaces!\r
  37 \r
  38     ***************************************************************************\r
  39      *                                                                       *\r
  40      *    Having a problem?  Start by reading the FAQ "My application does   *\r
  41      *    not run, what could be wrong?"                                     *\r
  42      *                                                                       *\r
  43      *    http://www.FreeRTOS.org/FAQHelp.html                               *\r
  44      *                                                                       *\r
  45     ***************************************************************************\r
  46 \r
  47     http://www.FreeRTOS.org - Documentation, books, training, latest versions,\r
  48     license and Real Time Engineers Ltd. contact details.\r
  49 \r
  50     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
  51     including FreeRTOS+Trace - an indispensable productivity tool, a DOS\r
  52     compatible FAT file system, and our tiny thread aware UDP/IP stack.\r
  53 \r
  54     http://www.OpenRTOS.com - Real Time Engineers ltd license FreeRTOS to High\r
  55     Integrity Systems to sell under the OpenRTOS brand.  Low cost OpenRTOS\r
  56     licenses offer ticketed support, indemnification and middleware.\r
  57 \r
  58     http://www.SafeRTOS.com - High Integrity Systems also provide a safety\r
  59     engineered and independently SIL3 certified version for use in safety and\r
  60     mission critical applications that require provable dependability.\r
  61 \r
  62     1 tab == 4 spaces!\r
  63 */\r
  64 \r
  65 /*\r
  66  * Creates all the demo application tasks, then starts the scheduler.  The WEB\r
  67  * documentation provides more details of the standard demo application tasks.\r
  68  * In addition to the standard demo tasks, the following tasks and tests are\r
  69  * defined and/or created within this file:\r
  70  *\r
  71  * "Fast Interrupt Test" - A high frequency periodic interrupt is generated\r
  72  * using a free running timer to demonstrate the use of the \r
  73  * configKERNEL_INTERRUPT_PRIORITY configuration constant.  The interrupt \r
  74  * service routine measures the number of processor clocks that occur between\r
  75  * each interrupt - and in so doing measures the jitter in the interrupt \r
  76  * timing.  The maximum measured jitter time is latched in the usMaxJitter \r
  77  * variable, and displayed on the LCD by the 'Check' as described below.  \r
  78  * The fast interrupt is configured and handled in the timer_test.c source \r
  79  * file.\r
  80  *\r
  81  * "LCD" task - the LCD task is a 'gatekeeper' task.  It is the only task that\r
  82  * is permitted to access the LCD directly.  Other tasks wishing to write a\r
  83  * message to the LCD send the message on a queue to the LCD task instead of \r
  84  * accessing the LCD themselves.  The LCD task just blocks on the queue waiting \r
  85  * for messages - waking and displaying the messages as they arrive.  The LCD\r
  86  * task is defined in lcd.c.  \r
  87  * \r
  88  * "Check" task -  This only executes every three seconds but has the highest \r
  89  * priority so is guaranteed to get processor time.  Its main function is to \r
  90  * check that all the standard demo tasks are still operational.  Should any\r
  91  * unexpected behaviour within a demo task be discovered the 'check' task will\r
  92  * write "FAIL #n" to the LCD (via the LCD task).  If all the demo tasks are \r
  93  * executing with their expected behaviour then the check task writes the max\r
  94  * jitter time to the LCD (again via the LCD task), as described above.\r
  95  */\r
  96 \r
  97 /* Standard includes. */\r
  98 #include <stdio.h>\r
  99 \r
 100 /* Scheduler includes. */\r
 101 #include "FreeRTOS.h"\r
 102 #include "task.h"\r
 103 #include "queue.h"\r
 104 #include "croutine.h"\r
 105 \r
 106 /* Demo application includes. */\r
 107 #include "BlockQ.h"\r
 108 #include "crflash.h"\r
 109 #include "blocktim.h"\r
 110 #include "integer.h"\r
 111 #include "comtest2.h"\r
 112 #include "partest.h"\r
 113 #include "lcd.h"\r
 114 #include "timertest.h"\r
 115 \r
 116 /* Demo task priorities. */\r
 117 #define mainBLOCK_Q_PRIORITY                            ( tskIDLE_PRIORITY + 2 )\r
 118 #define mainCHECK_TASK_PRIORITY                         ( tskIDLE_PRIORITY + 3 )\r
 119 #define mainCOM_TEST_PRIORITY                           ( 2 )\r
 120 \r
 121 /* The check task may require a bit more stack as it calls sprintf(). */\r
 122 #define mainCHECK_TAKS_STACK_SIZE                       ( configMINIMAL_STACK_SIZE * 2 )\r
 123 \r
 124 /* The execution period of the check task. */\r
 125 #define mainCHECK_TASK_PERIOD                           ( ( portTickType ) 3000 / portTICK_RATE_MS )\r
 126 \r
 127 /* The number of flash co-routines to create. */\r
 128 #define mainNUM_FLASH_COROUTINES                        ( 5 )\r
 129 \r
 130 /* Baud rate used by the comtest tasks. */\r
 131 #define mainCOM_TEST_BAUD_RATE                          ( 19200 )\r
 132 \r
 133 /* The LED used by the comtest tasks.  mainCOM_TEST_LED + 1 is also used.\r
 134 See the comtest.c file for more information. */\r
 135 #define mainCOM_TEST_LED                                        ( 6 )\r
 136 \r
 137 /* The frequency at which the "fast interrupt test" interrupt will occur. */\r
 138 #define mainTEST_INTERRUPT_FREQUENCY            ( 20000 )\r
 139 \r
 140 /* The number of processor clocks we expect to occur between each "fast\r
 141 interrupt test" interrupt. */\r
 142 #define mainEXPECTED_CLOCKS_BETWEEN_INTERRUPTS ( configCPU_CLOCK_HZ / mainTEST_INTERRUPT_FREQUENCY )\r
 143 \r
 144 /* The number of nano seconds between each processor clock. */\r
 145 #define mainNS_PER_CLOCK ( ( unsigned short ) ( ( 1.0 / ( double ) configCPU_CLOCK_HZ ) * 1000000000.0 ) )\r
 146 \r
 147 /* Dimension the buffer used to hold the value of the maximum jitter time when\r
 148 it is converted to a string. */\r
 149 #define mainMAX_STRING_LENGTH                           ( 20 )\r
 150 \r
 151 /*-----------------------------------------------------------*/\r
 152 \r
 153 /*\r
 154  * The check task as described at the top of this file.\r
 155  */\r
 156 static void vCheckTask( void *pvParameters );\r
 157 \r
 158 /*\r
 159  * Setup the processor ready for the demo.\r
 160  */\r
 161 static void prvSetupHardware( void );\r
 162 \r
 163 /*-----------------------------------------------------------*/\r
 164 \r
 165 /* The queue used to send messages to the LCD task. */\r
 166 static xQueueHandle xLCDQueue;\r
 167 \r
 168 /*-----------------------------------------------------------*/\r
 169 \r
 170 /*\r
 171  * Create the demo tasks then start the scheduler.\r
 172  */\r
 173 int main( void )\r
 174 {\r
 175         /* Configure any hardware required for this demo. */\r
 176         prvSetupHardware();\r
 177 \r
 178         /* Create the standard demo tasks. */\r
 179         vStartBlockingQueueTasks( mainBLOCK_Q_PRIORITY );       \r
 180         vStartIntegerMathTasks( tskIDLE_PRIORITY );\r
 181         vStartFlashCoRoutines( mainNUM_FLASH_COROUTINES );\r
 182         vAltStartComTestTasks( mainCOM_TEST_PRIORITY, mainCOM_TEST_BAUD_RATE, mainCOM_TEST_LED );\r
 183         vCreateBlockTimeTasks();\r
 184 \r
 185         /* Create the test tasks defined within this file. */\r
 186         xTaskCreate( vCheckTask, ( signed char * ) "Check", mainCHECK_TAKS_STACK_SIZE, NULL, mainCHECK_TASK_PRIORITY, NULL );\r
 187 \r
 188         /* Start the task that will control the LCD.  This returns the handle\r
 189         to the queue used to write text out to the task. */\r
 190         xLCDQueue = xStartLCDTask();\r
 191 \r
 192         /* Start the high frequency interrupt test. */\r
 193         vSetupTimerTest( mainTEST_INTERRUPT_FREQUENCY );\r
 194 \r
 195         /* Finally start the scheduler. */\r
 196         vTaskStartScheduler();\r
 197 \r
 198         /* Will only reach here if there is insufficient heap available to start\r
 199         the scheduler. */\r
 200         return 0;\r
 201 }\r
 202 /*-----------------------------------------------------------*/\r
 203 \r
 204 static void prvSetupHardware( void )\r
 205 {\r
 206         vParTestInitialise();\r
 207 }\r
 208 /*-----------------------------------------------------------*/\r
 209 \r
 210 static void vCheckTask( void *pvParameters )\r
 211 {\r
 212 /* Used to wake the task at the correct frequency. */\r
 213 portTickType xLastExecutionTime; \r
 214 \r
 215 /* The maximum jitter time measured by the fast interrupt test. */\r
 216 extern unsigned short usMaxJitter ;\r
 217 \r
 218 /* Buffer into which the maximum jitter time is written as a string. */\r
 219 static char cStringBuffer[ mainMAX_STRING_LENGTH ];\r
 220 \r
 221 /* The message that is sent on the queue to the LCD task.  The first\r
 222 parameter is the minimum time (in ticks) that the message should be\r
 223 left on the LCD without being overwritten.  The second parameter is a pointer\r
 224 to the message to display itself. */\r
 225 xLCDMessage xMessage = { 0, cStringBuffer };\r
 226 \r
 227 /* Set to pdTRUE should an error be detected in any of the standard demo tasks. */\r
 228 unsigned short usErrorDetected = pdFALSE;\r
 229 \r
 230         /* Initialise xLastExecutionTime so the first call to vTaskDelayUntil()\r
 231         works correctly. */\r
 232         xLastExecutionTime = xTaskGetTickCount();\r
 233 \r
 234         for( ;; )\r
 235         {\r
 236                 /* Wait until it is time for the next cycle. */\r
 237                 vTaskDelayUntil( &xLastExecutionTime, mainCHECK_TASK_PERIOD );\r
 238 \r
 239                 /* Has an error been found in any of the standard demo tasks? */\r
 240 \r
 241                 if( xAreIntegerMathsTaskStillRunning() != pdTRUE )\r
 242                 {\r
 243                         usErrorDetected = pdTRUE;\r
 244                         sprintf( cStringBuffer, "FAIL #1" );\r
 245                 }\r
 246         \r
 247                 if( xAreComTestTasksStillRunning() != pdTRUE )\r
 248                 {\r
 249                         usErrorDetected = pdTRUE;\r
 250                         sprintf( cStringBuffer, "FAIL #2" );\r
 251                 }\r
 252 \r
 253                 if( xAreBlockTimeTestTasksStillRunning() != pdTRUE )\r
 254                 {\r
 255                         usErrorDetected = pdTRUE;\r
 256                         sprintf( cStringBuffer, "FAIL #3" );\r
 257                 }\r
 258 \r
 259                 if( xAreBlockingQueuesStillRunning() != pdTRUE )\r
 260                 {\r
 261                         usErrorDetected = pdTRUE;\r
 262                         sprintf( cStringBuffer, "FAIL #4" );\r
 263                 }\r
 264 \r
 265                 if( usErrorDetected == pdFALSE )\r
 266                 {\r
 267                         /* No errors have been discovered, so display the maximum jitter\r
 268                         timer discovered by the "fast interrupt test". */\r
 269                         sprintf( cStringBuffer, "%dns max jitter", ( short ) ( usMaxJitter - mainEXPECTED_CLOCKS_BETWEEN_INTERRUPTS ) * mainNS_PER_CLOCK );\r
 270                 }\r
 271 \r
 272                 /* Send the message to the LCD gatekeeper for display. */\r
 273                 xQueueSend( xLCDQueue, &xMessage, portMAX_DELAY );\r
 274         }\r
 275 }\r
 276 /*-----------------------------------------------------------*/\r
 277 \r
 278 void vApplicationIdleHook( void )\r
 279 {\r
 280         /* Schedule the co-routines from within the idle task hook. */\r
 281         vCoRoutineSchedule();\r
 282 }\r
 283 /*-----------------------------------------------------------*/\r
 284 \r