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