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 V5.1.2 - Copyright (C) 2003-2009 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     * Get the FreeRTOS eBook!  See http://www.FreeRTOS.org/Documentation      *\r
  61         *                                                                         *\r
  62         * This is a concise, step by step, 'hands on' guide that describes both   *\r
  63         * general multitasking concepts and FreeRTOS specifics. It presents and   *\r
  64         * explains numerous examples that are written using the FreeRTOS API.     *\r
  65         * Full source code for all the examples is provided in an accompanying    *\r
  66         * .zip file.                                                              *\r
  67     *                                                                         *\r
  68     ***************************************************************************\r
  69     ***************************************************************************\r
  70 \r
  71         Please ensure to read the configuration and relevant port sections of the\r
  72         online documentation.\r
  73 \r
  74         http://www.FreeRTOS.org - Documentation, latest information, license and \r
  75         contact details.\r
  76 \r
  77         http://www.SafeRTOS.com - A version that is certified for use in safety \r
  78         critical systems.\r
  79 \r
  80         http://www.OpenRTOS.com - Commercial support, development, porting, \r
  81         licensing and training services.\r
  82 */\r
  83 \r
  84 \r
  85 #include <stdio.h>\r
  86 #include <stdlib.h>\r
  87 #include <string.h>\r
  88 \r
  89 /* Environment header files. */\r
  90 #include "pm.h"\r
  91 \r
  92 /* Scheduler header files. */\r
  93 #include "FreeRTOS.h"\r
  94 #include "task.h"\r
  95 \r
  96 /* Demo file headers. */\r
  97 #include "partest.h"\r
  98 #include "serial.h"\r
  99 #include "integer.h"\r
 100 #include "comtest.h"\r
 101 #include "flash.h"\r
 102 #include "PollQ.h"\r
 103 #include "semtest.h"\r
 104 #include "dynamic.h"\r
 105 #include "BlockQ.h"\r
 106 #include "death.h"\r
 107 #include "flop.h"\r
 108 \r
 109 /*! \name Priority definitions for most of the tasks in the demo application.\r
 110  * Some tasks just use the idle priority.\r
 111  */\r
 112 //! @{\r
 113 #define mainLED_TASK_PRIORITY     ( tskIDLE_PRIORITY + 1 )\r
 114 #define mainCOM_TEST_PRIORITY     ( tskIDLE_PRIORITY + 2 )\r
 115 #define mainQUEUE_POLL_PRIORITY   ( tskIDLE_PRIORITY + 2 )\r
 116 #define mainSEM_TEST_PRIORITY     ( tskIDLE_PRIORITY + 1 )\r
 117 #define mainBLOCK_Q_PRIORITY      ( tskIDLE_PRIORITY + 3 )\r
 118 #define mainCHECK_TASK_PRIORITY   ( tskIDLE_PRIORITY + 4 )\r
 119 #define mainCREATOR_TASK_PRIORITY ( tskIDLE_PRIORITY + 3 )\r
 120 //! @}\r
 121 \r
 122 //! Baud rate used by the serial port tasks.\r
 123 #define mainCOM_TEST_BAUD_RATE    ( ( unsigned portLONG ) 57600 )\r
 124 \r
 125 //! LED used by the serial port tasks.  This is toggled on each character Tx,\r
 126 //! and mainCOM_TEST_LED + 1 is toggled on each character Rx.\r
 127 #define mainCOM_TEST_LED          ( 3 )\r
 128 \r
 129 //! LED that is toggled by the check task.  The check task periodically checks\r
 130 //! that all the other tasks are operating without error.  If no errors are found\r
 131 //! the LED is toggled.  If an error is found at any time the LED toggles faster.\r
 132 #define mainCHECK_TASK_LED        ( 6 )\r
 133 \r
 134 //! LED that is set upon error.\r
 135 #define mainERROR_LED             ( 7 )\r
 136 \r
 137 //! The period between executions of the check task.\r
 138 #define mainCHECK_PERIOD          ( ( portTickType ) 3000 / portTICK_RATE_MS  )\r
 139 \r
 140 //! If an error is detected in a task, the vErrorChecks task will enter in an\r
 141 //! infinite loop flashing the LED at this rate.\r
 142 #define mainERROR_FLASH_RATE      ( (portTickType) 500 / portTICK_RATE_MS )\r
 143 \r
 144 /*! \name Constants used by the vMemCheckTask() task.\r
 145  */\r
 146 //! @{\r
 147 #define mainCOUNT_INITIAL_VALUE   ( ( unsigned portLONG ) 0 )\r
 148 #define mainNO_TASK               ( 0 )\r
 149 //! @}\r
 150 \r
 151 /*! \name The size of the memory blocks allocated by the vMemCheckTask() task.\r
 152  */\r
 153 //! @{\r
 154 #define mainMEM_CHECK_SIZE_1      ( ( size_t ) 51 )\r
 155 #define mainMEM_CHECK_SIZE_2      ( ( size_t ) 52 )\r
 156 #define mainMEM_CHECK_SIZE_3      ( ( size_t ) 15 )\r
 157 //! @}\r
 158 \r
 159 \r
 160 /*-----------------------------------------------------------*/\r
 161 \r
 162 /*\r
 163  * The task that executes at the highest priority and calls\r
 164  * prvCheckOtherTasksAreStillRunning().  See the description at the top\r
 165  * of the file.\r
 166  */\r
 167 static void vErrorChecks( void *pvParameters );\r
 168 \r
 169 /*\r
 170  * Checks that all the demo application tasks are still executing without error\r
 171  * - as described at the top of the file.\r
 172  */\r
 173 static portBASE_TYPE prvCheckOtherTasksAreStillRunning( void );\r
 174 \r
 175 /*\r
 176  * A task that exercises the memory allocator.\r
 177  */\r
 178 static void vMemCheckTask( void *pvParameters );\r
 179 \r
 180 /*\r
 181  * Called by the check task following the detection of an error to set the\r
 182  * LEDs into a state that shows an error has beeen found.\r
 183  */\r
 184 static void prvIndicateError( void );\r
 185 \r
 186 /*-----------------------------------------------------------*/\r
 187 \r
 188 int main( void )\r
 189 {\r
 190         /* Start the crystal oscillator 0 and switch the main clock to it. */\r
 191         pm_switch_to_osc0(&AVR32_PM, FOSC0, OSC0_STARTUP);\r
 192 \r
 193         portDBG_TRACE("Starting the FreeRTOS AVR32 UC3 Demo...");\r
 194 \r
 195         /* Setup the LED's for output. */\r
 196         vParTestInitialise();\r
 197 \r
 198         /* Start the standard demo tasks.  See the WEB documentation for more\r
 199         information. */\r
 200         vStartLEDFlashTasks( mainLED_TASK_PRIORITY );\r
 201         vAltStartComTestTasks( mainCOM_TEST_PRIORITY, mainCOM_TEST_BAUD_RATE, mainCOM_TEST_LED );\r
 202         vStartPolledQueueTasks( mainQUEUE_POLL_PRIORITY );\r
 203         vStartIntegerMathTasks( tskIDLE_PRIORITY );\r
 204         vStartSemaphoreTasks( mainSEM_TEST_PRIORITY );\r
 205         vStartDynamicPriorityTasks();\r
 206         vStartBlockingQueueTasks( mainBLOCK_Q_PRIORITY );\r
 207         vStartMathTasks( tskIDLE_PRIORITY );\r
 208 \r
 209         /* Start the demo tasks defined within this file, specifically the check\r
 210         task as described at the top of this file. */\r
 211         xTaskCreate(\r
 212                 vErrorChecks\r
 213                 ,  (const signed portCHAR *)"ErrCheck"\r
 214                 ,  configMINIMAL_STACK_SIZE\r
 215                 ,  NULL\r
 216                 ,  mainCHECK_TASK_PRIORITY\r
 217                 ,  NULL );\r
 218 \r
 219         /* Start the scheduler. */\r
 220         vTaskStartScheduler();\r
 221 \r
 222         /* Will only get here if there was insufficient memory to create the idle\r
 223         task. */\r
 224 \r
 225         return 0;\r
 226 }\r
 227 /*-----------------------------------------------------------*/\r
 228 \r
 229 /*!\r
 230  * \brief The task function for the "Check" task.\r
 231  */\r
 232 static void vErrorChecks( void *pvParameters )\r
 233 {\r
 234 static volatile unsigned portLONG ulDummyVariable = 3UL;\r
 235 unsigned portLONG ulMemCheckTaskRunningCount;\r
 236 xTaskHandle xCreatedTask;\r
 237 portBASE_TYPE bSuicidalTask = 0;\r
 238 \r
 239         /* The parameters are not used.  Prevent compiler warnings. */\r
 240         ( void ) pvParameters;\r
 241 \r
 242         /* Cycle for ever, delaying then checking all the other tasks are still\r
 243         operating without error.\r
 244 \r
 245         In addition to the standard tests the memory allocator is tested through\r
 246         the dynamic creation and deletion of a task each cycle.  Each time the\r
 247         task is created memory must be allocated for its stack.  When the task is\r
 248         deleted this memory is returned to the heap.  If the task cannot be created\r
 249         then it is likely that the memory allocation failed. */\r
 250 \r
 251         for( ;; )\r
 252         {\r
 253                 /* Do this only once. */\r
 254                 if( bSuicidalTask == 0 )\r
 255                 {\r
 256                         bSuicidalTask++;\r
 257 \r
 258                         /* This task has to be created last as it keeps account of the number of\r
 259                         tasks it expects to see running. However its implementation expects\r
 260                         to be called before vTaskStartScheduler(). We're in the case here where\r
 261                         vTaskStartScheduler() has already been called (thus the hidden IDLE task\r
 262                         has already been spawned). Since vCreateSuicidalTask() supposes that the\r
 263                         IDLE task isn't included in the response from uxTaskGetNumberOfTasks(),\r
 264                         let the MEM_CHECK task play that role. => this is why vCreateSuicidalTasks()\r
 265                         is not called as the last task. */\r
 266                         vCreateSuicidalTasks( mainCREATOR_TASK_PRIORITY );\r
 267                 }\r
 268 \r
 269                 /* Reset xCreatedTask.  This is modified by the task about to be\r
 270                 created so we can tell if it is executing correctly or not. */\r
 271                 xCreatedTask = mainNO_TASK;\r
 272 \r
 273                 /* Dynamically create a task - passing ulMemCheckTaskRunningCount as a\r
 274                 parameter. */\r
 275                 ulMemCheckTaskRunningCount = mainCOUNT_INITIAL_VALUE;\r
 276 \r
 277                 if( xTaskCreate( vMemCheckTask,\r
 278                         ( signed portCHAR * ) "MEM_CHECK",\r
 279                         configMINIMAL_STACK_SIZE,\r
 280                         ( void * ) &ulMemCheckTaskRunningCount,\r
 281                         tskIDLE_PRIORITY, &xCreatedTask ) != pdPASS )\r
 282                 {\r
 283                         /* Could not create the task - we have probably run out of heap.\r
 284                         Don't go any further and flash the LED faster to provide visual\r
 285                         feedback of the error. */\r
 286                         prvIndicateError();\r
 287                 }\r
 288 \r
 289                 /* Delay until it is time to execute again. */\r
 290                 vTaskDelay( mainCHECK_PERIOD );\r
 291 \r
 292                 /* Delete the dynamically created task. */\r
 293                 if( xCreatedTask != mainNO_TASK )\r
 294                 {\r
 295                         vTaskDelete( xCreatedTask );\r
 296                 }\r
 297 \r
 298                 /* Perform a bit of 32bit maths to ensure the registers used by the\r
 299                 integer tasks get some exercise. The result here is not important -\r
 300                 see the demo application documentation for more info. */\r
 301                 ulDummyVariable *= 3;\r
 302 \r
 303                 /* Check all other tasks are still operating without error.\r
 304                 Check that vMemCheckTask did increment the counter. */\r
 305                 if( ( prvCheckOtherTasksAreStillRunning() != pdFALSE )\r
 306                  || ( ulMemCheckTaskRunningCount == mainCOUNT_INITIAL_VALUE ) )\r
 307                 {\r
 308                         /* An error has occurred in one of the tasks.\r
 309                         Don't go any further and flash the LED faster to give visual\r
 310                         feedback of the error. */\r
 311                         prvIndicateError();\r
 312                 }\r
 313                 else\r
 314                 {\r
 315                         /* Toggle the LED if everything is okay. */\r
 316                         vParTestToggleLED( mainCHECK_TASK_LED );\r
 317                 }\r
 318         }\r
 319 }\r
 320 /*-----------------------------------------------------------*/\r
 321 \r
 322 \r
 323 /*!\r
 324  * \brief Checks that all the demo application tasks are still executing without error.\r
 325  */\r
 326 static portBASE_TYPE prvCheckOtherTasksAreStillRunning( void )\r
 327 {\r
 328 static portBASE_TYPE xErrorHasOccurred = pdFALSE;\r
 329 \r
 330         if( xAreComTestTasksStillRunning() != pdTRUE )\r
 331         {\r
 332                 xErrorHasOccurred = pdTRUE;\r
 333         }\r
 334 \r
 335         if( xArePollingQueuesStillRunning() != pdTRUE )\r
 336         {\r
 337                 xErrorHasOccurred = pdTRUE;\r
 338         }\r
 339 \r
 340         if( xAreIntegerMathsTaskStillRunning() != pdTRUE )\r
 341         {\r
 342                 xErrorHasOccurred = pdTRUE;\r
 343         }\r
 344 \r
 345         if( xAreSemaphoreTasksStillRunning() != pdTRUE )\r
 346         {\r
 347                 xErrorHasOccurred = pdTRUE;\r
 348         }\r
 349 \r
 350         if( xAreBlockingQueuesStillRunning() != pdTRUE )\r
 351         {\r
 352                 xErrorHasOccurred = pdTRUE;\r
 353         }\r
 354 \r
 355         if( xAreDynamicPriorityTasksStillRunning() != pdTRUE )\r
 356         {\r
 357                 xErrorHasOccurred = pdTRUE;\r
 358         }\r
 359 \r
 360         if( xAreMathsTaskStillRunning() != pdTRUE )\r
 361         {\r
 362                 xErrorHasOccurred = pdTRUE;\r
 363         }\r
 364 \r
 365         if( xIsCreateTaskStillRunning() != pdTRUE )\r
 366         {\r
 367                 xErrorHasOccurred = pdTRUE;\r
 368         }\r
 369 \r
 370         return ( xErrorHasOccurred );\r
 371 }\r
 372 /*-----------------------------------------------------------*/\r
 373 \r
 374 \r
 375 /*!\r
 376  * \brief Dynamically created and deleted during each cycle of the vErrorChecks()\r
 377  * task.  This is done to check the operation of the memory allocator.\r
 378  * See the top of vErrorChecks for more details.\r
 379  *\r
 380  * \param *pvParameters Parameters for the task (can be of any kind)\r
 381  */\r
 382 static void vMemCheckTask( void *pvParameters )\r
 383 {\r
 384 unsigned portLONG *pulMemCheckTaskRunningCounter;\r
 385 void *pvMem1, *pvMem2, *pvMem3;\r
 386 static portLONG lErrorOccurred = pdFALSE;\r
 387 \r
 388         /* This task is dynamically created then deleted during each cycle of the\r
 389         vErrorChecks task to check the operation of the memory allocator.  Each time\r
 390         the task is created memory is allocated for the stack and TCB.  Each time\r
 391         the task is deleted this memory is returned to the heap.  This task itself\r
 392         exercises the allocator by allocating and freeing blocks.\r
 393 \r
 394         The task executes at the idle priority so does not require a delay.\r
 395 \r
 396         pulMemCheckTaskRunningCounter is incremented each cycle to indicate to the\r
 397         vErrorChecks() task that this task is still executing without error. */\r
 398 \r
 399         pulMemCheckTaskRunningCounter = ( unsigned portLONG * ) pvParameters;\r
 400 \r
 401         for( ;; )\r
 402         {\r
 403                 if( lErrorOccurred == pdFALSE )\r
 404                 {\r
 405                         /* We have never seen an error so increment the counter. */\r
 406                         ( *pulMemCheckTaskRunningCounter )++;\r
 407                 }\r
 408                 else\r
 409                 {\r
 410                         /* There has been an error so reset the counter so the check task\r
 411                         can tell that an error occurred. */\r
 412                         *pulMemCheckTaskRunningCounter = mainCOUNT_INITIAL_VALUE;\r
 413                 }\r
 414 \r
 415                 /* Allocate some memory - just to give the allocator some extra\r
 416                 exercise.  This has to be in a critical section to ensure the\r
 417                 task does not get deleted while it has memory allocated. */\r
 418 \r
 419                 vTaskSuspendAll();\r
 420                 {\r
 421                         pvMem1 = pvPortMalloc( mainMEM_CHECK_SIZE_1 );\r
 422 \r
 423                         if( pvMem1 == NULL )\r
 424                         {\r
 425                                 lErrorOccurred = pdTRUE;\r
 426                         }\r
 427                         else\r
 428                         {\r
 429                                 memset( pvMem1, 0xaa, mainMEM_CHECK_SIZE_1 );\r
 430                                 vPortFree( pvMem1 );\r
 431                         }\r
 432                 }\r
 433                 xTaskResumeAll();\r
 434 \r
 435                 /* Again - with a different size block. */\r
 436                 vTaskSuspendAll();\r
 437                 {\r
 438                         pvMem2 = pvPortMalloc( mainMEM_CHECK_SIZE_2 );\r
 439 \r
 440                         if( pvMem2 == NULL )\r
 441                         {\r
 442                                 lErrorOccurred = pdTRUE;\r
 443                         }\r
 444                         else\r
 445                         {\r
 446                                 memset( pvMem2, 0xaa, mainMEM_CHECK_SIZE_2 );\r
 447                                 vPortFree( pvMem2 );\r
 448                         }\r
 449                 }\r
 450                 xTaskResumeAll();\r
 451 \r
 452                 /* Again - with a different size block. */\r
 453                 vTaskSuspendAll();\r
 454                 {\r
 455                         pvMem3 = pvPortMalloc( mainMEM_CHECK_SIZE_3 );\r
 456                         if( pvMem3 == NULL )\r
 457                         {\r
 458                                 lErrorOccurred = pdTRUE;\r
 459                         }\r
 460                         else\r
 461                         {\r
 462                                 memset( pvMem3, 0xaa, mainMEM_CHECK_SIZE_3 );\r
 463                                 vPortFree( pvMem3 );\r
 464                         }\r
 465                 }\r
 466                 xTaskResumeAll();\r
 467         }\r
 468 }\r
 469 /*-----------------------------------------------------------*/\r
 470 \r
 471 static void prvIndicateError( void )\r
 472 {\r
 473         /* The check task has found an error in one of the other tasks.\r
 474         Set the LEDs to a state that indicates this. */\r
 475         vParTestSetLED(mainERROR_LED,pdTRUE);\r
 476 \r
 477         for(;;)\r
 478         {\r
 479                 #if( BOARD==EVK1100 )\r
 480                         vParTestToggleLED( mainCHECK_TASK_LED );\r
 481                         vTaskDelay( mainERROR_FLASH_RATE );\r
 482                 #endif\r
 483                 #if ( BOARD==EVK1101 )\r
 484                         vParTestSetLED( 0, pdTRUE );\r
 485                         vParTestSetLED( 1, pdTRUE );\r
 486                         vParTestSetLED( 2, pdTRUE );\r
 487                         vParTestSetLED( 3, pdTRUE );\r
 488                 #endif\r
 489         }\r
 490 }\r
 491 \r