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

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