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

   1 /*This file has been prepared for Doxygen automatic documentation generation.*/\r
   2 /*! \file *********************************************************************\r
   3  *\r
   4  * \brief FreeRTOS Real Time Kernel example.\r
   5  *\r
   6  * Creates all the demo application tasks, then starts the scheduler.  The WEB\r
   7  * documentation provides more details of the demo application tasks.\r
   8  *\r
   9  * Main. c also creates a task called "Check".  This only executes every three\r
  10  * seconds but has the highest priority so is guaranteed to get processor time.\r
  11  * Its main function is to check that all the other tasks are still operational.\r
  12  * Each task that does not flash an LED maintains a unique count that is\r
  13  * incremented each time the task successfully completes its function.  Should\r
  14  * any error occur within such a task the count is permanently halted.  The\r
  15  * check task inspects the count of each task to ensure it has changed since\r
  16  * the last time the check task executed.  If all the count variables have\r
  17  * changed all the tasks are still executing error free, and the check task\r
  18  * toggles an LED.  Should any task contain an error at any time the LED toggle\r
  19  * will stop.\r
  20  *\r
  21  * The LED flash and communications test tasks do not maintain a count.\r
  22  *\r
  23  * - Compiler:           IAR EWAVR32 and GNU GCC for AVR32\r
  24  * - Supported devices:  All AVR32 devices with GPIO.\r
  25  * - AppNote:\r
  26  *\r
  27  * \author               Atmel Corporation: http://www.atmel.com \n\r
  28  *                       Support and FAQ: http://support.atmel.no/\r
  29  *\r
  30  *****************************************************************************/\r
  31 \r
  32 /*\r
  33         FreeRTOS.org V4.8.0 - Copyright (C) 2003-2008 Richard Barry.\r
  34 \r
  35         This file is part of the FreeRTOS.org distribution.\r
  36 \r
  37         FreeRTOS.org is free software; you can redistribute it and/or modify\r
  38         it under the terms of the GNU General Public License as published by\r
  39         the Free Software Foundation; either version 2 of the License, or\r
  40         (at your option) any later version.\r
  41 \r
  42         FreeRTOS.org is distributed in the hope that it will be useful,\r
  43         but WITHOUT ANY WARRANTY; without even the implied warranty of\r
  44         MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
  45         GNU General Public License for more details.\r
  46 \r
  47         You should have received a copy of the GNU General Public License\r
  48         along with FreeRTOS.org; if not, write to the Free Software\r
  49         Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA\r
  50 \r
  51         A special exception to the GPL can be applied should you wish to distribute\r
  52         a combined work that includes FreeRTOS.org, without being obliged to provide\r
  53         the source code for any proprietary components.  See the licensing section\r
  54         of http://www.FreeRTOS.org for full details of how and when the exception\r
  55         can be applied.\r
  56 \r
  57         ***************************************************************************\r
  58         ***************************************************************************\r
  59         *                                                                                                                                                 *\r
  60         * SAVE TIME AND MONEY!  Why not get us to quote to get FreeRTOS.org               *\r
  61         * running on your hardware - or even write all or part of your application*\r
  62         * for you?  See http://www.OpenRTOS.com for details.                                      *\r
  63         *                                                                                                                                                 *\r
  64         ***************************************************************************\r
  65         ***************************************************************************\r
  66 \r
  67         Please ensure to read the configuration and relevant port sections of the\r
  68         online documentation.\r
  69 \r
  70         http://www.FreeRTOS.org - Documentation, latest information, license and \r
  71         contact details.\r
  72 \r
  73         http://www.SafeRTOS.com - A version that is certified for use in safety \r
  74         critical systems.\r
  75 \r
  76         http://www.OpenRTOS.com - Commercial support, development, porting, \r
  77         licensing and training services.\r
  78 */\r
  79 \r
  80 \r
  81 #include <stdio.h>\r
  82 #include <stdlib.h>\r
  83 #include <string.h>\r
  84 \r
  85 /* Environment header files. */\r
  86 #include "pm.h"\r
  87 \r
  88 /* Scheduler header files. */\r
  89 #include "FreeRTOS.h"\r
  90 #include "task.h"\r
  91 \r
  92 /* Demo file headers. */\r
  93 #include "partest.h"\r
  94 #include "serial.h"\r
  95 #include "integer.h"\r
  96 #include "comtest.h"\r
  97 #include "flash.h"\r
  98 #include "PollQ.h"\r
  99 #include "semtest.h"\r
 100 #include "dynamic.h"\r
 101 #include "BlockQ.h"\r
 102 #include "death.h"\r
 103 #include "flop.h"\r
 104 \r
 105 /*! \name Priority definitions for most of the tasks in the demo application.\r
 106  * Some tasks just use the idle priority.\r
 107  */\r
 108 //! @{\r
 109 #define mainLED_TASK_PRIORITY     ( tskIDLE_PRIORITY + 1 )\r
 110 #define mainCOM_TEST_PRIORITY     ( tskIDLE_PRIORITY + 2 )\r
 111 #define mainQUEUE_POLL_PRIORITY   ( tskIDLE_PRIORITY + 2 )\r
 112 #define mainSEM_TEST_PRIORITY     ( tskIDLE_PRIORITY + 1 )\r
 113 #define mainBLOCK_Q_PRIORITY      ( tskIDLE_PRIORITY + 3 )\r
 114 #define mainCHECK_TASK_PRIORITY   ( tskIDLE_PRIORITY + 4 )\r
 115 #define mainCREATOR_TASK_PRIORITY ( tskIDLE_PRIORITY + 3 )\r
 116 //! @}\r
 117 \r
 118 //! Baud rate used by the serial port tasks.\r
 119 #define mainCOM_TEST_BAUD_RATE    ( ( unsigned portLONG ) 57600 )\r
 120 \r
 121 //! LED used by the serial port tasks.  This is toggled on each character Tx,\r
 122 //! and mainCOM_TEST_LED + 1 is toggled on each character Rx.\r
 123 #define mainCOM_TEST_LED          ( 3 )\r
 124 \r
 125 //! LED that is toggled by the check task.  The check task periodically checks\r
 126 //! that all the other tasks are operating without error.  If no errors are found\r
 127 //! the LED is toggled.  If an error is found at any time the LED toggles faster.\r
 128 #define mainCHECK_TASK_LED        ( 6 )\r
 129 \r
 130 //! LED that is set upon error.\r
 131 #define mainERROR_LED             ( 7 )\r
 132 \r
 133 //! The period between executions of the check task.\r
 134 #define mainCHECK_PERIOD          ( ( portTickType ) 3000 / portTICK_RATE_MS  )\r
 135 \r
 136 //! If an error is detected in a task, the vErrorChecks task will enter in an\r
 137 //! infinite loop flashing the LED at this rate.\r
 138 #define mainERROR_FLASH_RATE      ( (portTickType) 500 / portTICK_RATE_MS )\r
 139 \r
 140 /*! \name Constants used by the vMemCheckTask() task.\r
 141  */\r
 142 //! @{\r
 143 #define mainCOUNT_INITIAL_VALUE   ( ( unsigned portLONG ) 0 )\r
 144 #define mainNO_TASK               ( 0 )\r
 145 //! @}\r
 146 \r
 147 /*! \name The size of the memory blocks allocated by the vMemCheckTask() task.\r
 148  */\r
 149 //! @{\r
 150 #define mainMEM_CHECK_SIZE_1      ( ( size_t ) 51 )\r
 151 #define mainMEM_CHECK_SIZE_2      ( ( size_t ) 52 )\r
 152 #define mainMEM_CHECK_SIZE_3      ( ( size_t ) 15 )\r
 153 //! @}\r
 154 \r
 155 \r
 156 /*-----------------------------------------------------------*/\r
 157 \r
 158 /*\r
 159  * The task that executes at the highest priority and calls\r
 160  * prvCheckOtherTasksAreStillRunning().  See the description at the top\r
 161  * of the file.\r
 162  */\r
 163 static void vErrorChecks( void *pvParameters );\r
 164 \r
 165 /*\r
 166  * Checks that all the demo application tasks are still executing without error\r
 167  * - as described at the top of the file.\r
 168  */\r
 169 static portBASE_TYPE prvCheckOtherTasksAreStillRunning( void );\r
 170 \r
 171 /*\r
 172  * A task that exercises the memory allocator.\r
 173  */\r
 174 static void vMemCheckTask( void *pvParameters );\r
 175 \r
 176 /*\r
 177  * Called by the check task following the detection of an error to set the\r
 178  * LEDs into a state that shows an error has beeen found.\r
 179  */\r
 180 static void prvIndicateError( void );\r
 181 \r
 182 /*-----------------------------------------------------------*/\r
 183 \r
 184 int main( void )\r
 185 {\r
 186         /* Start the crystal oscillator 0 and switch the main clock to it. */\r
 187         pm_switch_to_osc0(&AVR32_PM, FOSC0, OSC0_STARTUP);\r
 188 \r
 189         portDBG_TRACE("Starting the FreeRTOS AVR32 UC3 Demo...");\r
 190 \r
 191         /* Setup the LED's for output. */\r
 192         vParTestInitialise();\r
 193 \r
 194         /* Start the standard demo tasks.  See the WEB documentation for more\r
 195         information. */\r
 196         vStartLEDFlashTasks( mainLED_TASK_PRIORITY );\r
 197         vAltStartComTestTasks( mainCOM_TEST_PRIORITY, mainCOM_TEST_BAUD_RATE, mainCOM_TEST_LED );\r
 198         vStartPolledQueueTasks( mainQUEUE_POLL_PRIORITY );\r
 199         vStartIntegerMathTasks( tskIDLE_PRIORITY );\r
 200         vStartSemaphoreTasks( mainSEM_TEST_PRIORITY );\r
 201         vStartDynamicPriorityTasks();\r
 202         vStartBlockingQueueTasks( mainBLOCK_Q_PRIORITY );\r
 203         vStartMathTasks( tskIDLE_PRIORITY );\r
 204 \r
 205         /* Start the demo tasks defined within this file, specifically the check\r
 206         task as described at the top of this file. */\r
 207         xTaskCreate(\r
 208                 vErrorChecks\r
 209                 ,  (const signed portCHAR *)"ErrCheck"\r
 210                 ,  configMINIMAL_STACK_SIZE\r
 211                 ,  NULL\r
 212                 ,  mainCHECK_TASK_PRIORITY\r
 213                 ,  NULL );\r
 214 \r
 215         /* Start the scheduler. */\r
 216         vTaskStartScheduler();\r
 217 \r
 218         /* Will only get here if there was insufficient memory to create the idle\r
 219         task. */\r
 220 \r
 221         return 0;\r
 222 }\r
 223 /*-----------------------------------------------------------*/\r
 224 \r
 225 /*!\r
 226  * \brief The task function for the "Check" task.\r
 227  */\r
 228 static void vErrorChecks( void *pvParameters )\r
 229 {\r
 230 static volatile unsigned portLONG ulDummyVariable = 3UL;\r
 231 unsigned portLONG ulMemCheckTaskRunningCount;\r
 232 xTaskHandle xCreatedTask;\r
 233 portBASE_TYPE bSuicidalTask = 0;\r
 234 \r
 235         /* The parameters are not used.  Prevent compiler warnings. */\r
 236         ( void ) pvParameters;\r
 237 \r
 238         /* Cycle for ever, delaying then checking all the other tasks are still\r
 239         operating without error.\r
 240 \r
 241         In addition to the standard tests the memory allocator is tested through\r
 242         the dynamic creation and deletion of a task each cycle.  Each time the\r
 243         task is created memory must be allocated for its stack.  When the task is\r
 244         deleted this memory is returned to the heap.  If the task cannot be created\r
 245         then it is likely that the memory allocation failed. */\r
 246 \r
 247         for( ;; )\r
 248         {\r
 249                 /* Do this only once. */\r
 250                 if( bSuicidalTask == 0 )\r
 251                 {\r
 252                         bSuicidalTask++;\r
 253 \r
 254                         /* This task has to be created last as it keeps account of the number of\r
 255                         tasks it expects to see running. However its implementation expects\r
 256                         to be called before vTaskStartScheduler(). We're in the case here where\r
 257                         vTaskStartScheduler() has already been called (thus the hidden IDLE task\r
 258                         has already been spawned). Since vCreateSuicidalTask() supposes that the\r
 259                         IDLE task isn't included in the response from uxTaskGetNumberOfTasks(),\r
 260                         let the MEM_CHECK task play that role. => this is why vCreateSuicidalTasks()\r
 261                         is not called as the last task. */\r
 262                         vCreateSuicidalTasks( mainCREATOR_TASK_PRIORITY );\r
 263                 }\r
 264 \r
 265                 /* Reset xCreatedTask.  This is modified by the task about to be\r
 266                 created so we can tell if it is executing correctly or not. */\r
 267                 xCreatedTask = mainNO_TASK;\r
 268 \r
 269                 /* Dynamically create a task - passing ulMemCheckTaskRunningCount as a\r
 270                 parameter. */\r
 271                 ulMemCheckTaskRunningCount = mainCOUNT_INITIAL_VALUE;\r
 272 \r
 273                 if( xTaskCreate( vMemCheckTask,\r
 274                         ( signed portCHAR * ) "MEM_CHECK",\r
 275                         configMINIMAL_STACK_SIZE,\r
 276                         ( void * ) &ulMemCheckTaskRunningCount,\r
 277                         tskIDLE_PRIORITY, &xCreatedTask ) != pdPASS )\r
 278                 {\r
 279                         /* Could not create the task - we have probably run out of heap.\r
 280                         Don't go any further and flash the LED faster to provide visual\r
 281                         feedback of the error. */\r
 282                         prvIndicateError();\r
 283                 }\r
 284 \r
 285                 /* Delay until it is time to execute again. */\r
 286                 vTaskDelay( mainCHECK_PERIOD );\r
 287 \r
 288                 /* Delete the dynamically created task. */\r
 289                 if( xCreatedTask != mainNO_TASK )\r
 290                 {\r
 291                         vTaskDelete( xCreatedTask );\r
 292                 }\r
 293 \r
 294                 /* Perform a bit of 32bit maths to ensure the registers used by the\r
 295                 integer tasks get some exercise. The result here is not important -\r
 296                 see the demo application documentation for more info. */\r
 297                 ulDummyVariable *= 3;\r
 298 \r
 299                 /* Check all other tasks are still operating without error.\r
 300                 Check that vMemCheckTask did increment the counter. */\r
 301                 if( ( prvCheckOtherTasksAreStillRunning() != pdFALSE )\r
 302                  || ( ulMemCheckTaskRunningCount == mainCOUNT_INITIAL_VALUE ) )\r
 303                 {\r
 304                         /* An error has occurred in one of the tasks.\r
 305                         Don't go any further and flash the LED faster to give visual\r
 306                         feedback of the error. */\r
 307                         prvIndicateError();\r
 308                 }\r
 309                 else\r
 310                 {\r
 311                         /* Toggle the LED if everything is okay. */\r
 312                         vParTestToggleLED( mainCHECK_TASK_LED );\r
 313                 }\r
 314         }\r
 315 }\r
 316 /*-----------------------------------------------------------*/\r
 317 \r
 318 \r
 319 /*!\r
 320  * \brief Checks that all the demo application tasks are still executing without error.\r
 321  */\r
 322 static portBASE_TYPE prvCheckOtherTasksAreStillRunning( void )\r
 323 {\r
 324 static portBASE_TYPE xErrorHasOccurred = pdFALSE;\r
 325 \r
 326         if( xAreComTestTasksStillRunning() != pdTRUE )\r
 327         {\r
 328                 xErrorHasOccurred = pdTRUE;\r
 329         }\r
 330 \r
 331         if( xArePollingQueuesStillRunning() != pdTRUE )\r
 332         {\r
 333                 xErrorHasOccurred = pdTRUE;\r
 334         }\r
 335 \r
 336         if( xAreIntegerMathsTaskStillRunning() != pdTRUE )\r
 337         {\r
 338                 xErrorHasOccurred = pdTRUE;\r
 339         }\r
 340 \r
 341         if( xAreSemaphoreTasksStillRunning() != pdTRUE )\r
 342         {\r
 343                 xErrorHasOccurred = pdTRUE;\r
 344         }\r
 345 \r
 346         if( xAreBlockingQueuesStillRunning() != pdTRUE )\r
 347         {\r
 348                 xErrorHasOccurred = pdTRUE;\r
 349         }\r
 350 \r
 351         if( xAreDynamicPriorityTasksStillRunning() != pdTRUE )\r
 352         {\r
 353                 xErrorHasOccurred = pdTRUE;\r
 354         }\r
 355 \r
 356         if( xAreMathsTaskStillRunning() != pdTRUE )\r
 357         {\r
 358                 xErrorHasOccurred = pdTRUE;\r
 359         }\r
 360 \r
 361         if( xIsCreateTaskStillRunning() != pdTRUE )\r
 362         {\r
 363                 xErrorHasOccurred = pdTRUE;\r
 364         }\r
 365 \r
 366         return ( xErrorHasOccurred );\r
 367 }\r
 368 /*-----------------------------------------------------------*/\r
 369 \r
 370 \r
 371 /*!\r
 372  * \brief Dynamically created and deleted during each cycle of the vErrorChecks()\r
 373  * task.  This is done to check the operation of the memory allocator.\r
 374  * See the top of vErrorChecks for more details.\r
 375  *\r
 376  * \param *pvParameters Parameters for the task (can be of any kind)\r
 377  */\r
 378 static void vMemCheckTask( void *pvParameters )\r
 379 {\r
 380 unsigned portLONG *pulMemCheckTaskRunningCounter;\r
 381 void *pvMem1, *pvMem2, *pvMem3;\r
 382 static portLONG lErrorOccurred = pdFALSE;\r
 383 \r
 384         /* This task is dynamically created then deleted during each cycle of the\r
 385         vErrorChecks task to check the operation of the memory allocator.  Each time\r
 386         the task is created memory is allocated for the stack and TCB.  Each time\r
 387         the task is deleted this memory is returned to the heap.  This task itself\r
 388         exercises the allocator by allocating and freeing blocks.\r
 389 \r
 390         The task executes at the idle priority so does not require a delay.\r
 391 \r
 392         pulMemCheckTaskRunningCounter is incremented each cycle to indicate to the\r
 393         vErrorChecks() task that this task is still executing without error. */\r
 394 \r
 395         pulMemCheckTaskRunningCounter = ( unsigned portLONG * ) pvParameters;\r
 396 \r
 397         for( ;; )\r
 398         {\r
 399                 if( lErrorOccurred == pdFALSE )\r
 400                 {\r
 401                         /* We have never seen an error so increment the counter. */\r
 402                         ( *pulMemCheckTaskRunningCounter )++;\r
 403                 }\r
 404                 else\r
 405                 {\r
 406                         /* There has been an error so reset the counter so the check task\r
 407                         can tell that an error occurred. */\r
 408                         *pulMemCheckTaskRunningCounter = mainCOUNT_INITIAL_VALUE;\r
 409                 }\r
 410 \r
 411                 /* Allocate some memory - just to give the allocator some extra\r
 412                 exercise.  This has to be in a critical section to ensure the\r
 413                 task does not get deleted while it has memory allocated. */\r
 414 \r
 415                 vTaskSuspendAll();\r
 416                 {\r
 417                         pvMem1 = pvPortMalloc( mainMEM_CHECK_SIZE_1 );\r
 418 \r
 419                         if( pvMem1 == NULL )\r
 420                         {\r
 421                                 lErrorOccurred = pdTRUE;\r
 422                         }\r
 423                         else\r
 424                         {\r
 425                                 memset( pvMem1, 0xaa, mainMEM_CHECK_SIZE_1 );\r
 426                                 vPortFree( pvMem1 );\r
 427                         }\r
 428                 }\r
 429                 xTaskResumeAll();\r
 430 \r
 431                 /* Again - with a different size block. */\r
 432                 vTaskSuspendAll();\r
 433                 {\r
 434                         pvMem2 = pvPortMalloc( mainMEM_CHECK_SIZE_2 );\r
 435 \r
 436                         if( pvMem2 == NULL )\r
 437                         {\r
 438                                 lErrorOccurred = pdTRUE;\r
 439                         }\r
 440                         else\r
 441                         {\r
 442                                 memset( pvMem2, 0xaa, mainMEM_CHECK_SIZE_2 );\r
 443                                 vPortFree( pvMem2 );\r
 444                         }\r
 445                 }\r
 446                 xTaskResumeAll();\r
 447 \r
 448                 /* Again - with a different size block. */\r
 449                 vTaskSuspendAll();\r
 450                 {\r
 451                         pvMem3 = pvPortMalloc( mainMEM_CHECK_SIZE_3 );\r
 452                         if( pvMem3 == NULL )\r
 453                         {\r
 454                                 lErrorOccurred = pdTRUE;\r
 455                         }\r
 456                         else\r
 457                         {\r
 458                                 memset( pvMem3, 0xaa, mainMEM_CHECK_SIZE_3 );\r
 459                                 vPortFree( pvMem3 );\r
 460                         }\r
 461                 }\r
 462                 xTaskResumeAll();\r
 463         }\r
 464 }\r
 465 /*-----------------------------------------------------------*/\r
 466 \r
 467 static void prvIndicateError( void )\r
 468 {\r
 469         /* The check task has found an error in one of the other tasks.\r
 470         Set the LEDs to a state that indicates this. */\r
 471         vParTestSetLED(mainERROR_LED,pdTRUE);\r
 472 \r
 473         for(;;)\r
 474         {\r
 475                 #if( BOARD==EVK1100 )\r
 476                         vParTestToggleLED( mainCHECK_TASK_LED );\r
 477                         vTaskDelay( mainERROR_FLASH_RATE );\r
 478                 #endif\r
 479                 #if ( BOARD==EVK1101 )\r
 480                         vParTestSetLED( 0, pdTRUE );\r
 481                         vParTestSetLED( 1, pdTRUE );\r
 482                         vParTestSetLED( 2, pdTRUE );\r
 483                         vParTestSetLED( 3, pdTRUE );\r
 484                 #endif\r
 485         }\r
 486 }\r
 487 \r