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

   1 /*\r
   2     FreeRTOS V7.5.2 - 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 /*\r
  67  * Creates all the demo application tasks, then starts the scheduler.  The WEB\r
  68  * documentation provides more details of the standard demo application tasks.\r
  69  * In addition to the standard demo tasks, the following tasks and tests are\r
  70  * defined and/or created within this file:\r
  71  *\r
  72  * "Fast Interrupt Test" - A high frequency periodic interrupt is generated\r
  73  * using a free running timer to demonstrate the use of the\r
  74  * configKERNEL_INTERRUPT_PRIORITY configuration constant.  The interrupt\r
  75  * service routine measures the number of processor clocks that occur between\r
  76  * each interrupt - and in so doing measures the jitter in the interrupt timing.\r
  77  * The maximum measured jitter time is latched in the ulMaxJitter variable, and\r
  78  * displayed on the OLED display by the 'OLED' task as described below.  The\r
  79  * fast interrupt is configured and handled in the timertest.c source file.\r
  80  *\r
  81  * "OLED" task - the OLED task is a 'gatekeeper' task.  It is the only task that\r
  82  * is permitted to access the display directly.  Other tasks wishing to write a\r
  83  * message to the OLED send the message on a queue to the OLED task instead of\r
  84  * accessing the OLED themselves.  The OLED task just blocks on the queue waiting\r
  85  * for messages - waking and displaying the messages as they arrive.\r
  86  *\r
  87  * "Check" hook -  This only executes every five seconds from the tick hook.\r
  88  * Its main function is to check that all the standard demo tasks are still\r
  89  * operational.  Should any unexpected behaviour within a demo task be discovered\r
  90  * the tick hook will write an error to the OLED (via the OLED task).  If all the\r
  91  * demo tasks are executing with their expected behaviour then the check task\r
  92  * writes PASS to the OLED (again via the OLED task), as described above.\r
  93  *\r
  94  * "uIP" task -  This is the task that handles the uIP stack.  All TCP/IP\r
  95  * processing is performed in this task.\r
  96  */\r
  97 \r
  98 \r
  99 \r
 100 \r
 101 /*************************************************************************\r
 102  * Please ensure to read http://www.freertos.org/portLM3Sxxxx_Eclipse.html\r
 103  * which provides information on configuring and running this demo for the\r
 104  * various Luminary Micro EKs.\r
 105  *************************************************************************/\r
 106 \r
 107 \r
 108 \r
 109 \r
 110 /* Standard includes. */\r
 111 #include <stdio.h>\r
 112 \r
 113 /* Scheduler includes. */\r
 114 #include "FreeRTOS.h"\r
 115 #include "task.h"\r
 116 #include "queue.h"\r
 117 #include "semphr.h"\r
 118 \r
 119 /* Hardware library includes. */\r
 120 #include "hw_memmap.h"\r
 121 #include "hw_types.h"\r
 122 #include "hw_sysctl.h"\r
 123 #include "sysctl.h"\r
 124 #include "gpio.h"\r
 125 #include "grlib.h"\r
 126 #include "rit128x96x4.h"\r
 127 #include "osram128x64x4.h"\r
 128 #include "formike128x128x16.h"\r
 129 \r
 130 /* Demo app includes. */\r
 131 #include "BlockQ.h"\r
 132 #include "death.h"\r
 133 #include "integer.h"\r
 134 #include "blocktim.h"\r
 135 #include "flash.h"\r
 136 #include "partest.h"\r
 137 #include "semtest.h"\r
 138 #include "PollQ.h"\r
 139 #include "lcd_message.h"\r
 140 #include "bitmap.h"\r
 141 #include "GenQTest.h"\r
 142 #include "QPeek.h"\r
 143 #include "recmutex.h"\r
 144 #include "IntQueue.h"\r
 145 \r
 146 /*-----------------------------------------------------------*/\r
 147 \r
 148 /* The time between cycles of the 'check' functionality (defined within the\r
 149 tick hook. */\r
 150 #define mainCHECK_DELAY                                         ( ( portTickType ) 5000 / portTICK_RATE_MS )\r
 151 \r
 152 /* Size of the stack allocated to the uIP task. */\r
 153 #define mainBASIC_WEB_STACK_SIZE            ( configMINIMAL_STACK_SIZE * 3 )\r
 154 \r
 155 /* The OLED task uses the sprintf function so requires a little more stack too. */\r
 156 #define mainOLED_TASK_STACK_SIZE                        ( configMINIMAL_STACK_SIZE + 50 )\r
 157 \r
 158 /* Task priorities. */\r
 159 #define mainQUEUE_POLL_PRIORITY                         ( tskIDLE_PRIORITY + 2 )\r
 160 #define mainCHECK_TASK_PRIORITY                         ( tskIDLE_PRIORITY + 3 )\r
 161 #define mainSEM_TEST_PRIORITY                           ( tskIDLE_PRIORITY + 1 )\r
 162 #define mainBLOCK_Q_PRIORITY                            ( tskIDLE_PRIORITY + 2 )\r
 163 #define mainCREATOR_TASK_PRIORITY           ( tskIDLE_PRIORITY + 3 )\r
 164 #define mainINTEGER_TASK_PRIORITY           ( tskIDLE_PRIORITY )\r
 165 #define mainGEN_QUEUE_TASK_PRIORITY                     ( tskIDLE_PRIORITY )\r
 166 \r
 167 /* The maximum number of message that can be waiting for display at any one\r
 168 time. */\r
 169 #define mainOLED_QUEUE_SIZE                                     ( 3 )\r
 170 \r
 171 /* Dimensions the buffer into which the jitter time is written. */\r
 172 #define mainMAX_MSG_LEN                                         25\r
 173 \r
 174 /* The period of the system clock in nano seconds.  This is used to calculate\r
 175 the jitter time in nano seconds. */\r
 176 #define mainNS_PER_CLOCK                                        ( ( unsigned portLONG ) ( ( 1.0 / ( double ) configCPU_CLOCK_HZ ) * 1000000000.0 ) )\r
 177 \r
 178 /* Constants used when writing strings to the display. */\r
 179 #define mainCHARACTER_HEIGHT                            ( 9 )\r
 180 #define mainMAX_ROWS_128                                        ( mainCHARACTER_HEIGHT * 14 )\r
 181 #define mainMAX_ROWS_96                                         ( mainCHARACTER_HEIGHT * 10 )\r
 182 #define mainMAX_ROWS_64                                         ( mainCHARACTER_HEIGHT * 7 )\r
 183 #define mainFULL_SCALE                                          ( 15 )\r
 184 #define ulSSI_FREQUENCY                                         ( 3500000UL )\r
 185 \r
 186 /*-----------------------------------------------------------*/\r
 187 \r
 188 /*\r
 189  * The task that handles the uIP stack.  All TCP/IP processing is performed in\r
 190  * this task.\r
 191  */\r
 192 extern void vuIP_Task( void *pvParameters );\r
 193 \r
 194 /*\r
 195  * The display is written two by more than one task so is controlled by a\r
 196  * 'gatekeeper' task.  This is the only task that is actually permitted to\r
 197  * access the display directly.  Other tasks wanting to display a message send\r
 198  * the message to the gatekeeper.\r
 199  */\r
 200 static void vOLEDTask( void *pvParameters );\r
 201 \r
 202 /*\r
 203  * Configure the hardware for the demo.\r
 204  */\r
 205 static void prvSetupHardware( void );\r
 206 \r
 207 /*\r
 208  * Configures the high frequency timers - those used to measure the timing\r
 209  * jitter while the real time kernel is executing.\r
 210  */\r
 211 extern void vSetupHighFrequencyTimer( void );\r
 212 \r
 213 /*\r
 214  * The idle hook is used to run a test of the scheduler context switch\r
 215  * mechanism.\r
 216  */\r
 217 void vApplicationIdleHook( void ) __attribute__((naked));\r
 218 /*-----------------------------------------------------------*/\r
 219 \r
 220 /* The queue used to send messages to the OLED task. */\r
 221 xQueueHandle xOLEDQueue;\r
 222 \r
 223 /* The welcome text. */\r
 224 const portCHAR * const pcWelcomeMessage = "   www.FreeRTOS.org";\r
 225 \r
 226 /* Variables used to detect the test in the idle hook failing. */\r
 227 unsigned portLONG ulIdleError = pdFALSE;\r
 228 \r
 229 /*-----------------------------------------------------------*/\r
 230 \r
 231 /*************************************************************************\r
 232  * Please ensure to read http://www.freertos.org/portLM3Sxxxx_Eclipse.html\r
 233  * which provides information on configuring and running this demo for the\r
 234  * various Luminary Micro EKs.\r
 235  *************************************************************************/\r
 236 int main( void )\r
 237 {\r
 238         prvSetupHardware();\r
 239 \r
 240         /* Create the queue used by the OLED task.  Messages for display on the OLED\r
 241         are received via this queue. */\r
 242         xOLEDQueue = xQueueCreate( mainOLED_QUEUE_SIZE, sizeof( xOLEDMessage ) );\r
 243 \r
 244         /* Create the uIP task if running on a processor that includes a MAC and\r
 245         PHY. */\r
 246         if( SysCtlPeripheralPresent( SYSCTL_PERIPH_ETH ) )\r
 247         {\r
 248                 xTaskCreate( vuIP_Task, ( signed portCHAR * ) "uIP", mainBASIC_WEB_STACK_SIZE, NULL, mainCHECK_TASK_PRIORITY - 1, NULL );\r
 249         }\r
 250 \r
 251         /* Start the standard demo tasks. */\r
 252         vStartBlockingQueueTasks( mainBLOCK_Q_PRIORITY );\r
 253     vCreateBlockTimeTasks();\r
 254     vStartSemaphoreTasks( mainSEM_TEST_PRIORITY );\r
 255     vStartPolledQueueTasks( mainQUEUE_POLL_PRIORITY );\r
 256     vStartIntegerMathTasks( mainINTEGER_TASK_PRIORITY );\r
 257     vStartGenericQueueTasks( mainGEN_QUEUE_TASK_PRIORITY );\r
 258     vStartQueuePeekTasks();\r
 259     vStartRecursiveMutexTasks();\r
 260     vStartInterruptQueueTasks();\r
 261 \r
 262         /* Start the tasks defined within this file/specific to this demo. */\r
 263         xTaskCreate( vOLEDTask, ( signed portCHAR * ) "OLED", mainOLED_TASK_STACK_SIZE, NULL, tskIDLE_PRIORITY, NULL );\r
 264 \r
 265         /* The suicide tasks must be created last as they need to know how many\r
 266         tasks were running prior to their creation in order to ascertain whether\r
 267         or not the correct/expected number of tasks are running at any given time. */\r
 268     vCreateSuicidalTasks( mainCREATOR_TASK_PRIORITY );\r
 269 \r
 270         /* Configure the high frequency interrupt used to measure the interrupt\r
 271         jitter time. */\r
 272         vSetupHighFrequencyTimer();\r
 273 \r
 274         /* Start the scheduler. */\r
 275         vTaskStartScheduler();\r
 276 \r
 277     /* Will only get here if there was insufficient memory to create the idle\r
 278     task. */\r
 279         for( ;; );\r
 280         return 0;\r
 281 }\r
 282 /*-----------------------------------------------------------*/\r
 283 \r
 284 void prvSetupHardware( void )\r
 285 {\r
 286     /* If running on Rev A2 silicon, turn the LDO voltage up to 2.75V.  This is\r
 287     a workaround to allow the PLL to operate reliably. */\r
 288     if( DEVICE_IS_REVA2 )\r
 289     {\r
 290         SysCtlLDOSet( SYSCTL_LDO_2_75V );\r
 291     }\r
 292 \r
 293         /* Set the clocking to run from the PLL at 50 MHz */\r
 294         SysCtlClockSet( SYSCTL_SYSDIV_4 | SYSCTL_USE_PLL | SYSCTL_OSC_MAIN | SYSCTL_XTAL_8MHZ );\r
 295 \r
 296         /*      Enable Port F for Ethernet LEDs\r
 297                 LED0        Bit 3   Output\r
 298                 LED1        Bit 2   Output */\r
 299         SysCtlPeripheralEnable( SYSCTL_PERIPH_GPIOF );\r
 300         GPIODirModeSet( GPIO_PORTF_BASE, (GPIO_PIN_2 | GPIO_PIN_3), GPIO_DIR_MODE_HW );\r
 301         GPIOPadConfigSet( GPIO_PORTF_BASE, (GPIO_PIN_2 | GPIO_PIN_3 ), GPIO_STRENGTH_2MA, GPIO_PIN_TYPE_STD );\r
 302 \r
 303         vParTestInitialise();\r
 304 }\r
 305 /*-----------------------------------------------------------*/\r
 306 \r
 307 void vApplicationTickHook( void )\r
 308 {\r
 309 static xOLEDMessage xMessage = { "PASS" };\r
 310 static unsigned portLONG ulTicksSinceLastDisplay = 0;\r
 311 portBASE_TYPE xHigherPriorityTaskWoken = pdFALSE;\r
 312 \r
 313         /* Called from every tick interrupt.  Have enough ticks passed to make it\r
 314         time to perform our health status check again? */\r
 315         ulTicksSinceLastDisplay++;\r
 316         if( ulTicksSinceLastDisplay >= mainCHECK_DELAY )\r
 317         {\r
 318                 ulTicksSinceLastDisplay = 0;\r
 319 \r
 320                 /* Has an error been found in any task? */\r
 321                 if( xAreGenericQueueTasksStillRunning() != pdTRUE )\r
 322                 {\r
 323                         xMessage.pcMessage = "ERROR IN GEN Q";\r
 324                 }\r
 325                 else if( xAreQueuePeekTasksStillRunning() != pdTRUE )\r
 326                 {\r
 327                         xMessage.pcMessage = "ERROR IN PEEK Q";\r
 328                 }\r
 329                 else if( xAreBlockingQueuesStillRunning() != pdTRUE )\r
 330                 {\r
 331                         xMessage.pcMessage = "ERROR IN BLOCK Q";\r
 332                 }\r
 333                 else if( xAreBlockTimeTestTasksStillRunning() != pdTRUE )\r
 334                 {\r
 335                         xMessage.pcMessage = "ERROR IN BLOCK TIME";\r
 336                 }\r
 337             else if( xAreSemaphoreTasksStillRunning() != pdTRUE )\r
 338             {\r
 339                 xMessage.pcMessage = "ERROR IN SEMAPHORE";\r
 340             }\r
 341             else if( xArePollingQueuesStillRunning() != pdTRUE )\r
 342             {\r
 343                 xMessage.pcMessage = "ERROR IN POLL Q";\r
 344             }\r
 345             else if( xIsCreateTaskStillRunning() != pdTRUE )\r
 346             {\r
 347                 xMessage.pcMessage = "ERROR IN CREATE";\r
 348             }\r
 349             else if( xAreIntegerMathsTaskStillRunning() != pdTRUE )\r
 350             {\r
 351                 xMessage.pcMessage = "ERROR IN MATH";\r
 352             }\r
 353             else if( xAreRecursiveMutexTasksStillRunning() != pdTRUE )\r
 354             {\r
 355                 xMessage.pcMessage = "ERROR IN REC MUTEX";\r
 356             }\r
 357                 else if( ulIdleError != pdFALSE )\r
 358                 {\r
 359                         xMessage.pcMessage = "ERROR IN HOOK";\r
 360                 }\r
 361                 else if( xAreIntQueueTasksStillRunning() != pdTRUE )\r
 362                 {\r
 363                         xMessage.pcMessage = "ERROR IN INT QUEUE";\r
 364                 }\r
 365                 \r
 366 \r
 367                 /* Send the message to the OLED gatekeeper for display. */\r
 368                 xHigherPriorityTaskWoken = pdFALSE;\r
 369                 xQueueSendFromISR( xOLEDQueue, &xMessage, &xHigherPriorityTaskWoken );\r
 370         }\r
 371 }\r
 372 /*-----------------------------------------------------------*/\r
 373 \r
 374 void vOLEDTask( void *pvParameters )\r
 375 {\r
 376 xOLEDMessage xMessage;\r
 377 unsigned portLONG ulY, ulMaxY;\r
 378 static portCHAR cMessage[ mainMAX_MSG_LEN ];\r
 379 extern volatile unsigned portLONG ulMaxJitter;\r
 380 unsigned portBASE_TYPE uxUnusedStackOnEntry, uxUnusedStackNow;\r
 381 const unsigned portCHAR *pucImage;\r
 382 \r
 383 /* Functions to access the OLED.  The one used depends on the dev kit\r
 384 being used. */\r
 385 void ( *vOLEDInit )( unsigned portLONG ) = NULL;\r
 386 void ( *vOLEDStringDraw )( const portCHAR *, unsigned portLONG, unsigned portLONG, unsigned portCHAR ) = NULL;\r
 387 void ( *vOLEDImageDraw )( const unsigned portCHAR *, unsigned portLONG, unsigned portLONG, unsigned portLONG, unsigned portLONG ) = NULL;\r
 388 void ( *vOLEDClear )( void ) = NULL;\r
 389 \r
 390         /* Just for demo purposes. */\r
 391         uxUnusedStackOnEntry = uxTaskGetStackHighWaterMark( NULL );\r
 392 \r
 393         /* Map the OLED access functions to the driver functions that are appropriate\r
 394         for the evaluation kit being used. */\r
 395         switch( HWREG( SYSCTL_DID1 ) & SYSCTL_DID1_PRTNO_MASK )\r
 396         {\r
 397                 case SYSCTL_DID1_PRTNO_6965     :\r
 398                 case SYSCTL_DID1_PRTNO_2965     :       vOLEDInit = OSRAM128x64x4Init;\r
 399                                                                                 vOLEDStringDraw = OSRAM128x64x4StringDraw;\r
 400                                                                                 vOLEDImageDraw = OSRAM128x64x4ImageDraw;\r
 401                                                                                 vOLEDClear = OSRAM128x64x4Clear;\r
 402                                                                                 ulMaxY = mainMAX_ROWS_64;\r
 403                                                                                 pucImage = pucBasicBitmap;\r
 404                                                                                 break;\r
 405 \r
 406                 case SYSCTL_DID1_PRTNO_1968     :\r
 407                 case SYSCTL_DID1_PRTNO_8962 :   vOLEDInit = RIT128x96x4Init;\r
 408                                                                                 vOLEDStringDraw = RIT128x96x4StringDraw;\r
 409                                                                                 vOLEDImageDraw = RIT128x96x4ImageDraw;\r
 410                                                                                 vOLEDClear = RIT128x96x4Clear;\r
 411                                                                                 ulMaxY = mainMAX_ROWS_96;\r
 412                                                                                 pucImage = pucBasicBitmap;\r
 413                                                                                 break;\r
 414 \r
 415                 default                                         :       vOLEDInit = vFormike128x128x16Init;\r
 416                                                                                 vOLEDStringDraw = vFormike128x128x16StringDraw;\r
 417                                                                                 vOLEDImageDraw = vFormike128x128x16ImageDraw;\r
 418                                                                                 vOLEDClear = vFormike128x128x16Clear;\r
 419                                                                                 ulMaxY = mainMAX_ROWS_128;\r
 420                                                                                 pucImage = pucGrLibBitmap;\r
 421                                                                                 break;\r
 422         }\r
 423 \r
 424         ulY = ulMaxY;\r
 425 \r
 426         /* Initialise the OLED and display a startup message. */\r
 427         vOLEDInit( ulSSI_FREQUENCY );\r
 428         vOLEDStringDraw( "POWERED BY FreeRTOS", 0, 0, mainFULL_SCALE );\r
 429         vOLEDImageDraw( pucImage, 0, mainCHARACTER_HEIGHT + 1, bmpBITMAP_WIDTH, bmpBITMAP_HEIGHT );\r
 430 \r
 431         for( ;; )\r
 432         {\r
 433                 /* Wait for a message to arrive that requires displaying. */\r
 434                 xQueueReceive( xOLEDQueue, &xMessage, portMAX_DELAY );\r
 435 \r
 436                 /* Write the message on the next available row. */\r
 437                 ulY += mainCHARACTER_HEIGHT;\r
 438                 if( ulY >= ulMaxY )\r
 439                 {\r
 440                         ulY = mainCHARACTER_HEIGHT;\r
 441                         vOLEDClear();\r
 442                         vOLEDStringDraw( pcWelcomeMessage, 0, 0, mainFULL_SCALE );\r
 443                 }\r
 444 \r
 445                 /* Display the message along with the maximum jitter time from the\r
 446                 high priority time test. */\r
 447                 sprintf( cMessage, "%s [%uns]", xMessage.pcMessage, ulMaxJitter * mainNS_PER_CLOCK );\r
 448                 vOLEDStringDraw( cMessage, 0, ulY, mainFULL_SCALE );\r
 449         }\r
 450 }\r
 451 /*-----------------------------------------------------------*/\r
 452 \r
 453 void vApplicationStackOverflowHook( xTaskHandle *pxTask, signed portCHAR *pcTaskName )\r
 454 {\r
 455         for( ;; );\r
 456 }\r
 457 \r
 458 \r