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

   1 /*\r
   2         FreeRTOS.org V5.0.2 - Copyright (C) 2003-2008 Richard Barry.\r
   3 \r
   4         This file is part of the FreeRTOS.org distribution.\r
   5 \r
   6         FreeRTOS.org is free software; you can redistribute it and/or modify\r
   7         it under the terms of the GNU General Public License as published by\r
   8         the Free Software Foundation; either version 2 of the License, or\r
   9         (at your option) any later version.\r
  10 \r
  11         FreeRTOS.org is distributed in the hope that it will be useful,\r
  12         but WITHOUT ANY WARRANTY; without even the implied warranty of\r
  13         MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
  14         GNU General Public License for more details.\r
  15 \r
  16         You should have received a copy of the GNU General Public License\r
  17         along with FreeRTOS.org; if not, write to the Free Software\r
  18         Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA\r
  19 \r
  20         A special exception to the GPL can be applied should you wish to distribute\r
  21         a combined work that includes FreeRTOS.org, without being obliged to provide\r
  22         the source code for any proprietary components.  See the licensing section\r
  23         of http://www.FreeRTOS.org for full details of how and when the exception\r
  24         can be applied.\r
  25 \r
  26     ***************************************************************************\r
  27     ***************************************************************************\r
  28     *                                                                         *\r
  29     * SAVE TIME AND MONEY!  We can port FreeRTOS.org to your own hardware,    *\r
  30     * and even write all or part of your application on your behalf.          *\r
  31     * See http://www.OpenRTOS.com for details of the services we provide to   *\r
  32     * expedite your project.                                                  *\r
  33     *                                                                         *\r
  34     ***************************************************************************\r
  35     ***************************************************************************\r
  36 \r
  37         Please ensure to read the configuration and relevant port sections of the\r
  38         online documentation.\r
  39 \r
  40         http://www.FreeRTOS.org - Documentation, latest information, license and \r
  41         contact details.\r
  42 \r
  43         http://www.SafeRTOS.com - A version that is certified for use in safety \r
  44         critical systems.\r
  45 \r
  46         http://www.OpenRTOS.com - Commercial support, development, porting, \r
  47         licensing and training services.\r
  48 */\r
  49 \r
  50 \r
  51 /*\r
  52  * Creates all the demo application tasks, then starts the scheduler.  The WEB\r
  53  * documentation provides more details of the standard demo application tasks.\r
  54  * In addition to the standard demo tasks, the following tasks and tests are\r
  55  * defined and/or created within this file:\r
  56  *\r
  57  * "Fast Interrupt Test" - A high frequency periodic interrupt is generated\r
  58  * using a free running timer to demonstrate the use of the\r
  59  * configKERNEL_INTERRUPT_PRIORITY configuration constant.  The interrupt\r
  60  * service routine measures the number of processor clocks that occur between\r
  61  * each interrupt - and in so doing measures the jitter in the interrupt timing.\r
  62  * The maximum measured jitter time is latched in the ulMaxJitter variable, and\r
  63  * displayed on the OLED display by the 'OLED' task as described below.  The\r
  64  * fast interrupt is configured and handled in the timertest.c source file.\r
  65  *\r
  66  * "OLED" task - the OLED task is a 'gatekeeper' task.  It is the only task that\r
  67  * is permitted to access the display directly.  Other tasks wishing to write a\r
  68  * message to the OLED send the message on a queue to the OLED task instead of\r
  69  * accessing the OLED themselves.  The OLED task just blocks on the queue waiting\r
  70  * for messages - waking and displaying the messages as they arrive.\r
  71  *\r
  72  * "Check" hook -  This only executes every five seconds from the tick hook.\r
  73  * Its main function is to check that all the standard demo tasks are still \r
  74  * operational.  Should any unexpected behaviour within a demo task be discovered \r
  75  * the tick hook will write an error to the OLED (via the OLED task).  If all the \r
  76  * demo tasks are executing with their expected behaviour then the check task \r
  77  * writes PASS to the OLED (again via the OLED task), as described above.\r
  78  *\r
  79  * "uIP" task -  This is the task that handles the uIP stack.  All TCP/IP\r
  80  * processing is performed in this task.\r
  81  */\r
  82 \r
  83 \r
  84 \r
  85 \r
  86 /************************************************************************* \r
  87  * Please ensure to read http://www.freertos.org/portLM3Sxxxx_Eclipse.html\r
  88  * which provides information on configuring and running this demo for the\r
  89  * various Luminary Micro EKs.\r
  90  *************************************************************************/\r
  91 \r
  92 \r
  93 \r
  94 \r
  95 /* Standard includes. */\r
  96 #include <stdio.h>\r
  97 \r
  98 /* Scheduler includes. */\r
  99 #include "FreeRTOS.h"\r
 100 #include "task.h"\r
 101 #include "queue.h"\r
 102 #include "semphr.h"\r
 103 \r
 104 /* Hardware library includes. */\r
 105 #include "hw_memmap.h"\r
 106 #include "hw_types.h"\r
 107 #include "hw_sysctl.h"\r
 108 #include "sysctl.h"\r
 109 #include "gpio.h"\r
 110 #include "grlib.h"\r
 111 #include "rit128x96x4.h"\r
 112 #include "osram128x64x4.h"\r
 113 #include "formike128x128x16.h"\r
 114 \r
 115 /* Demo app includes. */\r
 116 #include "BlockQ.h"\r
 117 #include "death.h"\r
 118 #include "integer.h"\r
 119 #include "blocktim.h"\r
 120 #include "flash.h"\r
 121 #include "partest.h"\r
 122 #include "semtest.h"\r
 123 #include "PollQ.h"\r
 124 #include "lcd_message.h"\r
 125 #include "bitmap.h"\r
 126 #include "GenQTest.h"\r
 127 #include "QPeek.h"\r
 128 #include "recmutex.h"\r
 129 \r
 130 \r
 131 /*-----------------------------------------------------------*/\r
 132 \r
 133 /* The time between cycles of the 'check' functionality (defined within the\r
 134 tick hook. */\r
 135 #define mainCHECK_DELAY                                         ( ( portTickType ) 5000 / portTICK_RATE_MS )\r
 136 \r
 137 /* Size of the stack allocated to the uIP task. */\r
 138 #define mainBASIC_WEB_STACK_SIZE            ( configMINIMAL_STACK_SIZE * 3 )\r
 139 \r
 140 /* The OLED task uses the sprintf function so requires a little more stack too. */\r
 141 #define mainOLED_TASK_STACK_SIZE                        ( configMINIMAL_STACK_SIZE + 50 )\r
 142 \r
 143 /* Task priorities. */\r
 144 #define mainQUEUE_POLL_PRIORITY                         ( tskIDLE_PRIORITY + 2 )\r
 145 #define mainCHECK_TASK_PRIORITY                         ( tskIDLE_PRIORITY + 3 )\r
 146 #define mainSEM_TEST_PRIORITY                           ( tskIDLE_PRIORITY + 1 )\r
 147 #define mainBLOCK_Q_PRIORITY                            ( tskIDLE_PRIORITY + 2 )\r
 148 #define mainCREATOR_TASK_PRIORITY           ( tskIDLE_PRIORITY + 3 )\r
 149 #define mainINTEGER_TASK_PRIORITY           ( tskIDLE_PRIORITY )\r
 150 #define mainGEN_QUEUE_TASK_PRIORITY                     ( tskIDLE_PRIORITY )\r
 151 \r
 152 /* The maximum number of message that can be waiting for display at any one\r
 153 time. */\r
 154 #define mainOLED_QUEUE_SIZE                                     ( 3 )\r
 155 \r
 156 /* Dimensions the buffer into which the jitter time is written. */\r
 157 #define mainMAX_MSG_LEN                                         25\r
 158 \r
 159 /* The period of the system clock in nano seconds.  This is used to calculate\r
 160 the jitter time in nano seconds. */\r
 161 #define mainNS_PER_CLOCK                                        ( ( unsigned portLONG ) ( ( 1.0 / ( double ) configCPU_CLOCK_HZ ) * 1000000000.0 ) )\r
 162 \r
 163 /* Constants used when writing strings to the display. */\r
 164 #define mainCHARACTER_HEIGHT                            ( 9 )\r
 165 #define mainMAX_ROWS_128                                        ( mainCHARACTER_HEIGHT * 14 )\r
 166 #define mainMAX_ROWS_96                                         ( mainCHARACTER_HEIGHT * 10 )\r
 167 #define mainMAX_ROWS_64                                         ( mainCHARACTER_HEIGHT * 7 )\r
 168 #define mainFULL_SCALE                                          ( 15 )\r
 169 #define ulSSI_FREQUENCY                                         ( 3500000UL )\r
 170 \r
 171 /*-----------------------------------------------------------*/\r
 172 \r
 173 /*\r
 174  * The task that handles the uIP stack.  All TCP/IP processing is performed in\r
 175  * this task.\r
 176  */\r
 177 extern void vuIP_Task( void *pvParameters );\r
 178 \r
 179 /*\r
 180  * The display is written two by more than one task so is controlled by a\r
 181  * 'gatekeeper' task.  This is the only task that is actually permitted to\r
 182  * access the display directly.  Other tasks wanting to display a message send\r
 183  * the message to the gatekeeper.\r
 184  */\r
 185 static void vOLEDTask( void *pvParameters );\r
 186 \r
 187 /*\r
 188  * Configure the hardware for the demo.\r
 189  */\r
 190 static void prvSetupHardware( void );\r
 191 \r
 192 /*\r
 193  * Configures the high frequency timers - those used to measure the timing\r
 194  * jitter while the real time kernel is executing.\r
 195  */\r
 196 extern void vSetupTimer( void );\r
 197 \r
 198 /*\r
 199  * The idle hook is used to run a test of the scheduler context switch\r
 200  * mechanism.\r
 201  */\r
 202 void vApplicationIdleHook( void ) __attribute__((naked));\r
 203 /*-----------------------------------------------------------*/\r
 204 \r
 205 /* The queue used to send messages to the OLED task. */\r
 206 xQueueHandle xOLEDQueue;\r
 207 \r
 208 /* The welcome text. */\r
 209 const portCHAR * const pcWelcomeMessage = "   www.FreeRTOS.org";\r
 210 \r
 211 /* Variables used to detect the test in the idle hook failing. */\r
 212 unsigned portLONG ulIdleError = pdFALSE;\r
 213 \r
 214 /*-----------------------------------------------------------*/\r
 215 \r
 216 /************************************************************************* \r
 217  * Please ensure to read http://www.freertos.org/portLM3Sxxxx_Eclipse.html\r
 218  * which provides information on configuring and running this demo for the\r
 219  * various Luminary Micro EKs.\r
 220  *************************************************************************/\r
 221 int main( void )\r
 222 {\r
 223         prvSetupHardware();\r
 224 \r
 225         /* Create the queue used by the OLED task.  Messages for display on the OLED\r
 226         are received via this queue. */\r
 227         xOLEDQueue = xQueueCreate( mainOLED_QUEUE_SIZE, sizeof( xOLEDMessage ) );\r
 228 \r
 229         /* Create the uIP task if running on a processor that includes a MAC and \r
 230         PHY. */\r
 231         if( SysCtlPeripheralPresent( SYSCTL_PERIPH_ETH ) )\r
 232         {\r
 233                 xTaskCreate( vuIP_Task, ( signed portCHAR * ) "uIP", mainBASIC_WEB_STACK_SIZE, NULL, mainCHECK_TASK_PRIORITY - 1, NULL );\r
 234         }\r
 235 \r
 236         /* Start the standard demo tasks. */\r
 237         vStartBlockingQueueTasks( mainBLOCK_Q_PRIORITY );\r
 238     vCreateBlockTimeTasks();\r
 239     vStartSemaphoreTasks( mainSEM_TEST_PRIORITY );\r
 240     vStartPolledQueueTasks( mainQUEUE_POLL_PRIORITY );\r
 241     vStartIntegerMathTasks( mainINTEGER_TASK_PRIORITY );\r
 242     vStartGenericQueueTasks( mainGEN_QUEUE_TASK_PRIORITY );\r
 243     vStartQueuePeekTasks();\r
 244     vStartRecursiveMutexTasks();\r
 245 \r
 246         /* Start the tasks defined within this file/specific to this demo. */\r
 247         xTaskCreate( vOLEDTask, ( signed portCHAR * ) "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         vSetupTimer();\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         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 static 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 \r
 345                 /* Send the message to the OLED gatekeeper for display. */\r
 346                 xHigherPriorityTaskWoken = pdFALSE;\r
 347                 xQueueSendFromISR( xOLEDQueue, &xMessage, &xHigherPriorityTaskWoken );\r
 348         }\r
 349 }\r
 350 /*-----------------------------------------------------------*/\r
 351 \r
 352 void vOLEDTask( void *pvParameters )\r
 353 {\r
 354 xOLEDMessage xMessage;\r
 355 unsigned portLONG ulY, ulMaxY;\r
 356 static portCHAR cMessage[ mainMAX_MSG_LEN ];\r
 357 extern unsigned portLONG ulMaxJitter;\r
 358 unsigned portBASE_TYPE uxUnusedStackOnEntry, uxUnusedStackNow;\r
 359 const unsigned portCHAR *pucImage;\r
 360 \r
 361 /* Functions to access the OLED.  The one used depends on the dev kit\r
 362 being used. */\r
 363 void ( *vOLEDInit )( unsigned portLONG ) = NULL;\r
 364 void ( *vOLEDStringDraw )( const portCHAR *, unsigned portLONG, unsigned portLONG, unsigned portCHAR ) = NULL;\r
 365 void ( *vOLEDImageDraw )( const unsigned portCHAR *, unsigned portLONG, unsigned portLONG, unsigned portLONG, unsigned portLONG ) = NULL;\r
 366 void ( *vOLEDClear )( void ) = NULL;\r
 367 \r
 368         /* Just for demo purposes. */\r
 369         uxUnusedStackOnEntry = uxTaskGetStackHighWaterMark( NULL );\r
 370 \r
 371         /* Map the OLED access functions to the driver functions that are appropriate\r
 372         for the evaluation kit being used. */   \r
 373         switch( HWREG( SYSCTL_DID1 ) & SYSCTL_DID1_PRTNO_MASK )\r
 374         {\r
 375                 case SYSCTL_DID1_PRTNO_6965     :        \r
 376                 case SYSCTL_DID1_PRTNO_2965     :       vOLEDInit = OSRAM128x64x4Init;\r
 377                                                                                 vOLEDStringDraw = OSRAM128x64x4StringDraw;\r
 378                                                                                 vOLEDImageDraw = OSRAM128x64x4ImageDraw;\r
 379                                                                                 vOLEDClear = OSRAM128x64x4Clear;\r
 380                                                                                 ulMaxY = mainMAX_ROWS_64;\r
 381                                                                                 pucImage = pucBasicBitmap;\r
 382                                                                                 break;\r
 383                                                                                 \r
 384                 case SYSCTL_DID1_PRTNO_1968     :       \r
 385                 case SYSCTL_DID1_PRTNO_8962 :   vOLEDInit = RIT128x96x4Init;\r
 386                                                                                 vOLEDStringDraw = RIT128x96x4StringDraw;\r
 387                                                                                 vOLEDImageDraw = RIT128x96x4ImageDraw;\r
 388                                                                                 vOLEDClear = RIT128x96x4Clear;\r
 389                                                                                 ulMaxY = mainMAX_ROWS_96;\r
 390                                                                                 pucImage = pucBasicBitmap;\r
 391                                                                                 break;\r
 392                                                                                 \r
 393                 default                                         :       vOLEDInit = vFormike128x128x16Init;\r
 394                                                                                 vOLEDStringDraw = vFormike128x128x16StringDraw;\r
 395                                                                                 vOLEDImageDraw = vFormike128x128x16ImageDraw;\r
 396                                                                                 vOLEDClear = vFormike128x128x16Clear;\r
 397                                                                                 ulMaxY = mainMAX_ROWS_128;\r
 398                                                                                 pucImage = pucGrLibBitmap;\r
 399                                                                                 break;\r
 400         }\r
 401 \r
 402         ulY = ulMaxY;\r
 403         \r
 404         /* Initialise the OLED and display a startup message. */\r
 405         vOLEDInit( ulSSI_FREQUENCY );   \r
 406         vOLEDStringDraw( "POWERED BY FreeRTOS", 0, 0, mainFULL_SCALE );\r
 407         vOLEDImageDraw( pucImage, 0, mainCHARACTER_HEIGHT + 1, bmpBITMAP_WIDTH, bmpBITMAP_HEIGHT );\r
 408         \r
 409         for( ;; )\r
 410         {\r
 411                 /* Wait for a message to arrive that requires displaying. */\r
 412                 xQueueReceive( xOLEDQueue, &xMessage, portMAX_DELAY );\r
 413         \r
 414                 /* Write the message on the next available row. */\r
 415                 ulY += mainCHARACTER_HEIGHT;\r
 416                 if( ulY >= ulMaxY )\r
 417                 {\r
 418                         ulY = mainCHARACTER_HEIGHT;\r
 419                         vOLEDClear();\r
 420                         vOLEDStringDraw( pcWelcomeMessage, 0, 0, mainFULL_SCALE );                      \r
 421                 }\r
 422 \r
 423                 /* Display the message along with the maximum jitter time from the \r
 424                 high priority time test. */\r
 425                 sprintf( cMessage, "%s [%uns]", xMessage.pcMessage, ulMaxJitter * mainNS_PER_CLOCK );\r
 426                 vOLEDStringDraw( cMessage, 0, ulY, mainFULL_SCALE );\r
 427         }\r
 428 }\r
 429 /*-----------------------------------------------------------*/\r
 430 \r
 431 void vApplicationStackOverflowHook( xTaskHandle *pxTask, signed portCHAR *pcTaskName )\r
 432 {\r
 433         for( ;; );\r
 434 }\r
 435 \r
 436 \r