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

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