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

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