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

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