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

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