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

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