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

   1 /*\r
   2         FreeRTOS.org V5.3.1 - Copyright (C) 2003-2009 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 it\r
   7         under the terms of the GNU General Public License (version 2) as published\r
   8         by the 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.org without being obliged to provide\r
  11         the source code for any proprietary components.  Alternative commercial\r
  12         license and support terms are also available upon request.  See the \r
  13         licensing section of http://www.FreeRTOS.org for full details.\r
  14 \r
  15         FreeRTOS.org is distributed in the hope that it will be useful, but WITHOUT\r
  16         ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\r
  17         FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for\r
  18         more details.\r
  19 \r
  20         You should have received a copy of the GNU General Public License along\r
  21         with FreeRTOS.org; if not, write to the Free Software Foundation, Inc., 59\r
  22         Temple Place, Suite 330, Boston, MA  02111-1307  USA.\r
  23 \r
  24 \r
  25         ***************************************************************************\r
  26         *                                                                         *\r
  27         * Get the FreeRTOS eBook!  See http://www.FreeRTOS.org/Documentation      *\r
  28         *                                                                         *\r
  29         * This is a concise, step by step, 'hands on' guide that describes both   *\r
  30         * general multitasking concepts and FreeRTOS specifics. It presents and   *\r
  31         * explains numerous examples that are written using the FreeRTOS API.     *\r
  32         * Full source code for all the examples is provided in an accompanying    *\r
  33         * .zip file.                                                              *\r
  34         *                                                                         *\r
  35         ***************************************************************************\r
  36 \r
  37         1 tab == 4 spaces!\r
  38 \r
  39         Please ensure to read the configuration and relevant port sections of the\r
  40         online documentation.\r
  41 \r
  42         http://www.FreeRTOS.org - Documentation, latest information, license and\r
  43         contact details.\r
  44 \r
  45         http://www.SafeRTOS.com - A version that is certified for use in safety\r
  46         critical systems.\r
  47 \r
  48         http://www.OpenRTOS.com - Commercial support, development, porting,\r
  49         licensing and training services.\r
  50 */\r
  51 \r
  52 /* \r
  53         NOTE : Tasks run in system mode and the scheduler runs in Supervisor mode.\r
  54         The processor MUST be in supervisor mode when vTaskStartScheduler is \r
  55         called.  The demo applications included in the FreeRTOS.org download switch\r
  56         to supervisor mode prior to main being called.  If you are not using one of\r
  57         these demo application projects then ensure Supervisor mode is used.\r
  58 */\r
  59 \r
  60 \r
  61 /*\r
  62  * Creates all the demo application tasks, then starts the scheduler.  The WEB\r
  63  * documentation provides more details of the demo application tasks.\r
  64  * \r
  65  * Main.c also creates a task called "Check".  This only executes every three \r
  66  * seconds but has the highest priority so is guaranteed to get processor time.  \r
  67  * Its main function is to check that all the other tasks are still operational.\r
  68  * Each task (other than the "flash" tasks) maintains a unique count that is \r
  69  * incremented each time the task successfully completes its function.  Should \r
  70  * any error occur within such a task the count is permanently halted.  The \r
  71  * check task inspects the count of each task to ensure it has changed since\r
  72  * the last time the check task executed.  If all the count variables have \r
  73  * changed all the tasks are still executing error free, and the check task\r
  74  * toggles the onboard LED.  Should any task contain an error at any time \r
  75  * the LED toggle rate will change from 3 seconds to 500ms.\r
  76  *\r
  77  * To check the operation of the memory allocator the check task also \r
  78  * dynamically creates a task before delaying, and deletes it again when it \r
  79  * wakes.  If memory cannot be allocated for the new task the call to xTaskCreate\r
  80  * will fail and an error is signalled.  The dynamically created task itself\r
  81  * allocates and frees memory just to give the allocator a bit more exercise.\r
  82  *\r
  83  */\r
  84 \r
  85 /* \r
  86         Changes from V2.4.2\r
  87 \r
  88         + The vErrorChecks() task now dynamically creates then deletes a task each\r
  89           cycle.  This tests the operation of the memory allocator.\r
  90 \r
  91         Changes from V2.5.2\r
  92                 \r
  93         + vParTestInitialise() is called during initialisation to ensure all the \r
  94           LED's start off.\r
  95 */\r
  96 \r
  97 \r
  98 /* Standard includes. */\r
  99 #include <stdlib.h>\r
 100 #include <string.h>\r
 101 \r
 102 /* Scheduler includes. */\r
 103 #include "FreeRTOS.h"\r
 104 #include "task.h"\r
 105 \r
 106 /* Demo application includes. */\r
 107 #include "partest.h"\r
 108 #include "flash.h"\r
 109 #include "integer.h"\r
 110 #include "PollQ.h"\r
 111 #include "comtest2.h"\r
 112 #include "semtest.h"\r
 113 #include "flop.h"\r
 114 #include "dynamic.h"\r
 115 #include "BlockQ.h"\r
 116 #include "serial.h"\r
 117 \r
 118 /*-----------------------------------------------------------*/\r
 119 \r
 120 /* Constants to setup I/O. */\r
 121 #define mainTX_ENABLE   ( ( unsigned portLONG ) 0x0001 )\r
 122 #define mainRX_ENABLE   ( ( unsigned portLONG ) 0x0004 )\r
 123 #define mainP0_14               ( ( unsigned portLONG ) 0x4000 )\r
 124 #define mainJTAG_PORT   ( ( unsigned portLONG ) 0x3E0000UL )\r
 125 \r
 126 /* Constants to setup the PLL. */\r
 127 #define mainPLL_MUL_4           ( ( unsigned portCHAR ) 0x0003 )\r
 128 #define mainPLL_DIV_1           ( ( unsigned portCHAR ) 0x0000 )\r
 129 #define mainPLL_ENABLE          ( ( unsigned portCHAR ) 0x0001 )\r
 130 #define mainPLL_CONNECT         ( ( unsigned portCHAR ) 0x0003 )\r
 131 #define mainPLL_FEED_BYTE1      ( ( unsigned portCHAR ) 0xaa )\r
 132 #define mainPLL_FEED_BYTE2      ( ( unsigned portCHAR ) 0x55 )\r
 133 #define mainPLL_LOCK            ( ( unsigned portLONG ) 0x0400 )\r
 134 \r
 135 /* Constants to setup the MAM. */\r
 136 #define mainMAM_TIM_3           ( ( unsigned portCHAR ) 0x03 )\r
 137 #define mainMAM_MODE_FULL       ( ( unsigned portCHAR ) 0x02 )\r
 138 \r
 139 /* Constants to setup the peripheral bus. */\r
 140 #define mainBUS_CLK_FULL        ( ( unsigned portCHAR ) 0x01 )\r
 141 \r
 142 /* Constants for the ComTest tasks. */\r
 143 #define mainCOM_TEST_BAUD_RATE  ( ( unsigned portLONG ) 115200 )\r
 144 #define mainCOM_TEST_LED                ( 3 )\r
 145 \r
 146 /* Priorities for the demo application tasks. */\r
 147 #define mainLED_TASK_PRIORITY           ( tskIDLE_PRIORITY + 3 )\r
 148 #define mainCOM_TEST_PRIORITY           ( tskIDLE_PRIORITY + 2 )\r
 149 #define mainQUEUE_POLL_PRIORITY         ( tskIDLE_PRIORITY + 0 )\r
 150 #define mainCHECK_TASK_PRIORITY         ( tskIDLE_PRIORITY + 4 )\r
 151 #define mainSEM_TEST_PRIORITY           ( tskIDLE_PRIORITY + 0 )\r
 152 #define mainBLOCK_Q_PRIORITY            ( tskIDLE_PRIORITY + 2 )\r
 153 \r
 154 /* The rate at which the on board LED will toggle when there is/is not an \r
 155 error. */\r
 156 #define mainNO_ERROR_FLASH_PERIOD       ( ( portTickType ) 3000 / portTICK_RATE_MS  )\r
 157 #define mainERROR_FLASH_PERIOD          ( ( portTickType ) 500 / portTICK_RATE_MS  )\r
 158 #define mainON_BOARD_LED_BIT            ( ( unsigned portLONG ) 0x80 )\r
 159 \r
 160 /* Constants used by the vMemCheckTask() task. */\r
 161 #define mainCOUNT_INITIAL_VALUE         ( ( unsigned portLONG ) 0 )\r
 162 #define mainNO_TASK                                     ( 0 )\r
 163 \r
 164 /* The size of the memory blocks allocated by the vMemCheckTask() task. */\r
 165 #define mainMEM_CHECK_SIZE_1            ( ( size_t ) 51 )\r
 166 #define mainMEM_CHECK_SIZE_2            ( ( size_t ) 52 )\r
 167 #define mainMEM_CHECK_SIZE_3            ( ( size_t ) 151 )\r
 168 \r
 169 /*-----------------------------------------------------------*/\r
 170 \r
 171 /*\r
 172  * The Olimex demo board has a single built in LED.  This function simply\r
 173  * toggles its state. \r
 174  */\r
 175 void prvToggleOnBoardLED( void );\r
 176 \r
 177 /*\r
 178  * Checks that all the demo application tasks are still executing without error\r
 179  * - as described at the top of the file.\r
 180  */\r
 181 static portLONG prvCheckOtherTasksAreStillRunning( unsigned portLONG ulMemCheckTaskCount );\r
 182 \r
 183 /*\r
 184  * The task that executes at the highest priority and calls \r
 185  * prvCheckOtherTasksAreStillRunning().  See the description at the top\r
 186  * of the file.\r
 187  */\r
 188 static void vErrorChecks( void *pvParameters );\r
 189 \r
 190 /*\r
 191  * Dynamically created and deleted during each cycle of the vErrorChecks()\r
 192  * task.  This is done to check the operation of the memory allocator.\r
 193  * See the top of vErrorChecks for more details.\r
 194  */\r
 195 static void vMemCheckTask( void *pvParameters );\r
 196 \r
 197 /*\r
 198  * Configure the processor for use with the Olimex demo board.  This includes\r
 199  * setup for the I/O, system clock, and access timings.\r
 200  */\r
 201 static void prvSetupHardware( void );\r
 202 \r
 203 /*-----------------------------------------------------------*/\r
 204 \r
 205 /*\r
 206  * Starts all the other tasks, then starts the scheduler. \r
 207  */\r
 208 int main( void )\r
 209 {\r
 210         /* Setup the hardware for use with the Olimex demo board. */\r
 211         prvSetupHardware();\r
 212 \r
 213         /* Start the demo/test application tasks. */\r
 214         vStartIntegerMathTasks( tskIDLE_PRIORITY );\r
 215         vAltStartComTestTasks( mainCOM_TEST_PRIORITY, mainCOM_TEST_BAUD_RATE, mainCOM_TEST_LED );\r
 216         vStartLEDFlashTasks( mainLED_TASK_PRIORITY );\r
 217         vStartPolledQueueTasks( mainQUEUE_POLL_PRIORITY );\r
 218         vStartMathTasks( tskIDLE_PRIORITY );\r
 219         vStartSemaphoreTasks( mainSEM_TEST_PRIORITY );\r
 220         vStartDynamicPriorityTasks();\r
 221         vStartBlockingQueueTasks( mainBLOCK_Q_PRIORITY );\r
 222 \r
 223         /* Start the check task - which is defined in this file. */\r
 224         xTaskCreate( vErrorChecks, ( signed portCHAR * ) "Check", configMINIMAL_STACK_SIZE, NULL, mainCHECK_TASK_PRIORITY, NULL );\r
 225 \r
 226         /* Now all the tasks have been started - start the scheduler.\r
 227 \r
 228         NOTE : Tasks run in system mode and the scheduler runs in Supervisor mode.\r
 229         The processor MUST be in supervisor mode when vTaskStartScheduler is \r
 230         called.  The demo applications included in the FreeRTOS.org download switch\r
 231         to supervisor mode prior to main being called.  If you are not using one of\r
 232         these demo application projects then ensure Supervisor mode is used here. */\r
 233         vTaskStartScheduler();\r
 234 \r
 235         /* Should never reach here! */\r
 236         return 0;\r
 237 }\r
 238 /*-----------------------------------------------------------*/\r
 239 \r
 240 static void vErrorChecks( void *pvParameters )\r
 241 {\r
 242 portTickType xDelayPeriod = mainNO_ERROR_FLASH_PERIOD;\r
 243 unsigned portLONG ulMemCheckTaskRunningCount;\r
 244 xTaskHandle xCreatedTask;\r
 245 \r
 246         /* The parameters are not used in this function. */\r
 247         ( void ) pvParameters;\r
 248 \r
 249         /* Cycle for ever, delaying then checking all the other tasks are still\r
 250         operating without error.  If an error is detected then the delay period\r
 251         is decreased from mainNO_ERROR_FLASH_PERIOD to mainERROR_FLASH_PERIOD so\r
 252         the on board LED flash rate will increase. \r
 253         \r
 254         In addition to the standard tests the memory allocator is tested through\r
 255         the dynamic creation and deletion of a task each cycle.  Each time the \r
 256         task is created memory must be allocated for its stack.  When the task is\r
 257         deleted this memory is returned to the heap.  If the task cannot be created \r
 258         then it is likely that the memory allocation failed. */\r
 259 \r
 260         for( ;; )\r
 261         {\r
 262                 /* Dynamically create a task - passing ulMemCheckTaskRunningCount as a \r
 263                 parameter. */\r
 264                 ulMemCheckTaskRunningCount = mainCOUNT_INITIAL_VALUE;\r
 265                 xCreatedTask = mainNO_TASK;\r
 266 \r
 267                 if( xTaskCreate( vMemCheckTask, ( signed portCHAR * ) "MEM_CHECK", configMINIMAL_STACK_SIZE, ( void * ) &ulMemCheckTaskRunningCount, tskIDLE_PRIORITY, &xCreatedTask ) != pdPASS )\r
 268                 {\r
 269                         /* Could not create the task - we have probably run out of heap. */\r
 270                         xDelayPeriod = mainERROR_FLASH_PERIOD;\r
 271                 }\r
 272 \r
 273                 /* Delay until it is time to execute again. */\r
 274                 vTaskDelay( xDelayPeriod );\r
 275         \r
 276                 /* Delete the dynamically created task. */\r
 277                 if( xCreatedTask != mainNO_TASK )\r
 278                 {\r
 279                         vTaskDelete( xCreatedTask );\r
 280                 }\r
 281 \r
 282                 /* Check all the standard demo application tasks are executing without \r
 283                 error.  ulMemCheckTaskRunningCount is checked to ensure it was\r
 284                 modified by the task just deleted. */\r
 285                 if( prvCheckOtherTasksAreStillRunning( ulMemCheckTaskRunningCount ) != pdPASS )\r
 286                 {\r
 287                         /* An error has been detected in one of the tasks - flash faster. */\r
 288                         xDelayPeriod = mainERROR_FLASH_PERIOD;\r
 289                 }\r
 290 \r
 291                 prvToggleOnBoardLED();\r
 292         }\r
 293 }\r
 294 /*-----------------------------------------------------------*/\r
 295 \r
 296 static void prvSetupHardware( void )\r
 297 {\r
 298         #ifdef RUN_FROM_RAM\r
 299                 /* Remap the interrupt vectors to RAM if we are are running from RAM. */\r
 300                 SCB_MEMMAP = 2;\r
 301         #endif\r
 302 \r
 303         /* Configure the RS2332 pins.  All other pins remain at their default of 0. */\r
 304         PCB_PINSEL0 |= mainTX_ENABLE;\r
 305         PCB_PINSEL0 |= mainRX_ENABLE;\r
 306 \r
 307         /* Set all GPIO to output other than the P0.14 (BSL), and the JTAG pins.  \r
 308         The JTAG pins are left as input as I'm not sure what will happen if the \r
 309         Wiggler is connected after powerup - not that it would be a good idea to\r
 310         do that anyway. */\r
 311         GPIO_IODIR = ~( mainP0_14 + mainJTAG_PORT );\r
 312 \r
 313         /* Setup the PLL to multiply the XTAL input by 4. */\r
 314         SCB_PLLCFG = ( mainPLL_MUL_4 | mainPLL_DIV_1 );\r
 315 \r
 316         /* Activate the PLL by turning it on then feeding the correct sequence of\r
 317         bytes. */\r
 318         SCB_PLLCON = mainPLL_ENABLE;\r
 319         SCB_PLLFEED = mainPLL_FEED_BYTE1;\r
 320         SCB_PLLFEED = mainPLL_FEED_BYTE2;\r
 321 \r
 322         /* Wait for the PLL to lock... */\r
 323         while( !( SCB_PLLSTAT & mainPLL_LOCK ) );\r
 324 \r
 325         /* ...before connecting it using the feed sequence again. */\r
 326         SCB_PLLCON = mainPLL_CONNECT;\r
 327         SCB_PLLFEED = mainPLL_FEED_BYTE1;\r
 328         SCB_PLLFEED = mainPLL_FEED_BYTE2;\r
 329 \r
 330         /* Setup and turn on the MAM.  Three cycle access is used due to the fast\r
 331         PLL used.  It is possible faster overall performance could be obtained by\r
 332         tuning the MAM and PLL settings. */\r
 333         MAM_TIM = mainMAM_TIM_3;\r
 334         MAM_CR = mainMAM_MODE_FULL;\r
 335 \r
 336         /* Setup the peripheral bus to be the same as the PLL output. */\r
 337         SCB_VPBDIV = mainBUS_CLK_FULL;\r
 338         \r
 339         /* Initialise LED outputs. */\r
 340         vParTestInitialise();\r
 341 }\r
 342 /*-----------------------------------------------------------*/\r
 343 \r
 344 void prvToggleOnBoardLED( void )\r
 345 {\r
 346 unsigned portLONG ulState;\r
 347 \r
 348         ulState = GPIO0_IOPIN;\r
 349         if( ulState & mainON_BOARD_LED_BIT )\r
 350         {\r
 351                 GPIO_IOCLR = mainON_BOARD_LED_BIT;\r
 352         }\r
 353         else\r
 354         {\r
 355                 GPIO_IOSET = mainON_BOARD_LED_BIT;\r
 356         }       \r
 357 }\r
 358 /*-----------------------------------------------------------*/\r
 359 \r
 360 static portLONG prvCheckOtherTasksAreStillRunning( unsigned portLONG ulMemCheckTaskCount )\r
 361 {\r
 362 portLONG lReturn = ( portLONG ) pdPASS;\r
 363 \r
 364         /* Check all the demo tasks (other than the flash tasks) to ensure\r
 365         that they are all still running, and that none of them have detected\r
 366         an error. */\r
 367 \r
 368         if( xAreIntegerMathsTaskStillRunning() != pdTRUE )\r
 369         {\r
 370                 lReturn = ( portLONG ) pdFAIL;\r
 371         }\r
 372 \r
 373         if( xAreComTestTasksStillRunning() != pdTRUE )\r
 374         {\r
 375                 lReturn = ( portLONG ) pdFAIL;\r
 376         }\r
 377 \r
 378         if( xArePollingQueuesStillRunning() != pdTRUE )\r
 379         {\r
 380                 lReturn = ( portLONG ) pdFAIL;\r
 381         }\r
 382 \r
 383         if( xAreMathsTaskStillRunning() != pdTRUE )\r
 384         {\r
 385                 lReturn = ( portLONG ) pdFAIL;\r
 386         }\r
 387 \r
 388         if( xAreSemaphoreTasksStillRunning() != pdTRUE )\r
 389         {\r
 390                 lReturn = ( portLONG ) pdFAIL;\r
 391         }\r
 392 \r
 393         if( xAreDynamicPriorityTasksStillRunning() != pdTRUE )\r
 394         {\r
 395                 lReturn = ( portLONG ) pdFAIL;\r
 396         }\r
 397 \r
 398         if( xAreBlockingQueuesStillRunning() != pdTRUE )\r
 399         {\r
 400                 lReturn = ( portLONG ) pdFAIL;\r
 401         }\r
 402 \r
 403         if( ulMemCheckTaskCount == mainCOUNT_INITIAL_VALUE )\r
 404         {\r
 405                 /* The vMemCheckTask did not increment the counter - it must\r
 406                 have failed. */\r
 407                 lReturn = ( portLONG ) pdFAIL;\r
 408         }\r
 409 \r
 410         return lReturn;\r
 411 }\r
 412 /*-----------------------------------------------------------*/\r
 413 \r
 414 static void vMemCheckTask( void *pvParameters )\r
 415 {\r
 416 unsigned portLONG *pulMemCheckTaskRunningCounter;\r
 417 void *pvMem1, *pvMem2, *pvMem3;\r
 418 static portLONG lErrorOccurred = pdFALSE;\r
 419 \r
 420         /* This task is dynamically created then deleted during each cycle of the\r
 421         vErrorChecks task to check the operation of the memory allocator.  Each time\r
 422         the task is created memory is allocated for the stack and TCB.  Each time\r
 423         the task is deleted this memory is returned to the heap.  This task itself\r
 424         exercises the allocator by allocating and freeing blocks. \r
 425         \r
 426         The task executes at the idle priority so does not require a delay. \r
 427         \r
 428         pulMemCheckTaskRunningCounter is incremented each cycle to indicate to the\r
 429         vErrorChecks() task that this task is still executing without error. */\r
 430 \r
 431         pulMemCheckTaskRunningCounter = ( unsigned portLONG * ) pvParameters;\r
 432 \r
 433         for( ;; )\r
 434         {\r
 435                 if( lErrorOccurred == pdFALSE )\r
 436                 {\r
 437                         /* We have never seen an error so increment the counter. */\r
 438                         ( *pulMemCheckTaskRunningCounter )++;\r
 439                 }\r
 440 \r
 441                 /* Allocate some memory - just to give the allocator some extra \r
 442                 exercise.  This has to be in a critical section to ensure the\r
 443                 task does not get deleted while it has memory allocated. */\r
 444                 vTaskSuspendAll();\r
 445                 {\r
 446                         pvMem1 = pvPortMalloc( mainMEM_CHECK_SIZE_1 );\r
 447                         if( pvMem1 == NULL )\r
 448                         {\r
 449                                 lErrorOccurred = pdTRUE;\r
 450                         }\r
 451                         else\r
 452                         {\r
 453                                 memset( pvMem1, 0xaa, mainMEM_CHECK_SIZE_1 );\r
 454                                 vPortFree( pvMem1 );\r
 455                         }\r
 456                 }\r
 457                 xTaskResumeAll();\r
 458 \r
 459                 /* Again - with a different size block. */\r
 460                 vTaskSuspendAll();\r
 461                 {\r
 462                         pvMem2 = pvPortMalloc( mainMEM_CHECK_SIZE_2 );\r
 463                         if( pvMem2 == NULL )\r
 464                         {\r
 465                                 lErrorOccurred = pdTRUE;\r
 466                         }\r
 467                         else\r
 468                         {\r
 469                                 memset( pvMem2, 0xaa, mainMEM_CHECK_SIZE_2 );\r
 470                                 vPortFree( pvMem2 );\r
 471                         }\r
 472                 }\r
 473                 xTaskResumeAll();\r
 474 \r
 475                 /* Again - with a different size block. */\r
 476                 vTaskSuspendAll();\r
 477                 {\r
 478                         pvMem3 = pvPortMalloc( mainMEM_CHECK_SIZE_3 );\r
 479                         if( pvMem3 == NULL )\r
 480                         {\r
 481                                 lErrorOccurred = pdTRUE;\r
 482                         }\r
 483                         else\r
 484                         {\r
 485                                 memset( pvMem3, 0xaa, mainMEM_CHECK_SIZE_3 );\r
 486                                 vPortFree( pvMem3 );\r
 487                         }\r
 488                 }\r
 489                 xTaskResumeAll();\r
 490         }\r
 491 }\r
 492 \r
 493 \r
 494 \r