git.sur5r.net Git - freertos/blob - FreeRTOS/Demo/CORTEX_M0+_Atmel_SAMD20_XPlained/RTOSDemo/src/main.c

   1 /*\r
   2     FreeRTOS V8.1.2 - Copyright (C) 2014 Real Time Engineers Ltd. \r
   3     All rights reserved\r
   4 \r
   5     VISIT http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.\r
   6 \r
   7     ***************************************************************************\r
   8      *                                                                       *\r
   9      *    FreeRTOS provides completely free yet professionally developed,    *\r
  10      *    robust, strictly quality controlled, supported, and cross          *\r
  11      *    platform software that has become a de facto standard.             *\r
  12      *                                                                       *\r
  13      *    Help yourself get started quickly and support the FreeRTOS         *\r
  14      *    project by purchasing a FreeRTOS tutorial book, reference          *\r
  15      *    manual, or both from: http://www.FreeRTOS.org/Documentation        *\r
  16      *                                                                       *\r
  17      *    Thank you!                                                         *\r
  18      *                                                                       *\r
  19     ***************************************************************************\r
  20 \r
  21     This file is part of the FreeRTOS distribution.\r
  22 \r
  23     FreeRTOS is free software; you can redistribute it and/or modify it under\r
  24     the terms of the GNU General Public License (version 2) as published by the\r
  25     Free Software Foundation >>!AND MODIFIED BY!<< the FreeRTOS exception.\r
  26 \r
  27     >>!   NOTE: The modification to the GPL is included to allow you to     !<<\r
  28     >>!   distribute a combined work that includes FreeRTOS without being   !<<\r
  29     >>!   obliged to provide the source code for proprietary components     !<<\r
  30     >>!   outside of the FreeRTOS kernel.                                   !<<\r
  31 \r
  32     FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY\r
  33     WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS\r
  34     FOR A PARTICULAR PURPOSE.  Full license text is available from the following\r
  35     link: http://www.freertos.org/a00114.html\r
  36 \r
  37     1 tab == 4 spaces!\r
  38 \r
  39     ***************************************************************************\r
  40      *                                                                       *\r
  41      *    Having a problem?  Start by reading the FAQ "My application does   *\r
  42      *    not run, what could be wrong?"                                     *\r
  43      *                                                                       *\r
  44      *    http://www.FreeRTOS.org/FAQHelp.html                               *\r
  45      *                                                                       *\r
  46     ***************************************************************************\r
  47 \r
  48     http://www.FreeRTOS.org - Documentation, books, training, latest versions,\r
  49     license and Real Time Engineers Ltd. contact details.\r
  50 \r
  51     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
  52     including FreeRTOS+Trace - an indispensable productivity tool, a DOS\r
  53     compatible FAT file system, and our tiny thread aware UDP/IP stack.\r
  54 \r
  55     http://www.OpenRTOS.com - Real Time Engineers ltd license FreeRTOS to High\r
  56     Integrity Systems to sell under the OpenRTOS brand.  Low cost OpenRTOS\r
  57     licenses offer ticketed support, indemnification and middleware.\r
  58 \r
  59     http://www.SafeRTOS.com - High Integrity Systems also provide a safety\r
  60     engineered and independently SIL3 certified version for use in safety and\r
  61     mission critical applications that require provable dependability.\r
  62 \r
  63     1 tab == 4 spaces!\r
  64 */\r
  65 \r
  66 /******************************************************************************\r
  67  * This project provides two demo applications.  A simple blinky style project,\r
  68  * and a more comprehensive test and demo application.  The\r
  69  * mainCREATE_SIMPLE_BLINKY_DEMO_ONLY setting (defined in this file) is used to\r
  70  * select between the two.  The simply blinky demo is implemented and described\r
  71  * in main_blinky.c.  The more comprehensive test and demo application is\r
  72  * implemented and described in main_full.c.\r
  73  *\r
  74  * This file implements the code that is not demo specific, including the\r
  75  * hardware setup and FreeRTOS hook functions.  It also contains a dummy\r
  76  * interrupt service routine called Dummy_IRQHandler() that is provided as an\r
  77  * example of how to use interrupt safe FreeRTOS API functions (those that end\r
  78  * in "FromISR").\r
  79  *\r
  80  *****************************************************************************/\r
  81 \r
  82 /* FreeRTOS includes. */\r
  83 #include "FreeRTOS.h"\r
  84 #include "task.h"\r
  85 \r
  86 /* Demo app includes. */\r
  87 #include "UARTCommandConsole.h"\r
  88 \r
  89 /* Demo application include. */\r
  90 #include "QueueSet.h"\r
  91 \r
  92 /* Library includes. */\r
  93 #include <asf.h>\r
  94 \r
  95 /* Set mainCREATE_SIMPLE_BLINKY_DEMO_ONLY to one to run the simple blinky demo,\r
  96 or 0 to run the more comprehensive test and demo application. */\r
  97 #define mainCREATE_SIMPLE_BLINKY_DEMO_ONLY      0\r
  98 \r
  99 /*-----------------------------------------------------------*/\r
 100 \r
 101 /*\r
 102  * Perform any application specific hardware configuration.  \r
 103  */\r
 104 static void prvSetupHardware( void );\r
 105 \r
 106 /* \r
 107  * Prototypes for the FreeRTOS hook/callback functions.  See the comments in\r
 108  * the implementation of each function for more information.\r
 109  */\r
 110 void vApplicationMallocFailedHook( void );\r
 111 void vApplicationIdleHook( void );\r
 112 void vApplicationStackOverflowHook( TaskHandle_t pxTask, char *pcTaskName );\r
 113 void vApplicationTickHook( void );\r
 114 \r
 115 /*\r
 116  * main_blinky() is used when mainCREATE_SIMPLE_BLINKY_DEMO_ONLY is set to 1.\r
 117  * main_full() is used when mainCREATE_SIMPLE_BLINKY_DEMO_ONLY is set to 0.\r
 118  */\r
 119 extern void main_blinky( void );\r
 120 extern void main_full( void );\r
 121 \r
 122 /*-----------------------------------------------------------*/\r
 123 \r
 124 /* Used in the run time stats calculations. */\r
 125 static unsigned long ulClocksPer10thOfAMilliSecond = 0UL;\r
 126 \r
 127 /*-----------------------------------------------------------*/\r
 128 \r
 129 int main (void)\r
 130 {\r
 131         /* Prepare the hardware for the demo. */\r
 132         prvSetupHardware();\r
 133 \r
 134         /* The mainCREATE_SIMPLE_BLINKY_DEMO_ONLY setting is described at the top\r
 135         of this file. */\r
 136         #if mainCREATE_SIMPLE_BLINKY_DEMO_ONLY == 1\r
 137         {\r
 138                 main_blinky();\r
 139         }\r
 140         #else\r
 141         {\r
 142                 main_full();\r
 143         }\r
 144         #endif\r
 145 }\r
 146 /*-----------------------------------------------------------*/\r
 147 \r
 148 static void prvSetupHardware( void )\r
 149 {\r
 150         /* Initialisation is performed by the Atmel board support package. */\r
 151         system_init();\r
 152 }\r
 153 /*-----------------------------------------------------------*/\r
 154 \r
 155 void vApplicationMallocFailedHook( void )\r
 156 {\r
 157         /* vApplicationMallocFailedHook() will only be called if\r
 158         configUSE_MALLOC_FAILED_HOOK is set to 1 in FreeRTOSConfig.h.  It is a hook\r
 159         function that will get called if a call to pvPortMalloc() fails.\r
 160         pvPortMalloc() is called internally by the kernel whenever a task, queue,\r
 161         timer or semaphore is created.  It is also called by various parts of the\r
 162         demo application.  If heap_1.c or heap_2.c are used, then the size of the\r
 163         heap available to pvPortMalloc() is defined by configTOTAL_HEAP_SIZE in\r
 164         FreeRTOSConfig.h, and the xPortGetFreeHeapSize() API function can be used\r
 165         to query the size of free heap space that remains (although it does not\r
 166         provide information on how the remaining heap might be fragmented). */\r
 167         taskDISABLE_INTERRUPTS();\r
 168         for( ;; );\r
 169 }\r
 170 /*-----------------------------------------------------------*/\r
 171 \r
 172 void vApplicationIdleHook( void )\r
 173 {\r
 174         /* vApplicationIdleHook() will only be called if configUSE_IDLE_HOOK is set\r
 175         to 1 in FreeRTOSConfig.h.  It will be called on each iteration of the idle\r
 176         task.  It is essential that code added to this hook function never attempts\r
 177         to block in any way (for example, call xQueueReceive() with a block time\r
 178         specified, or call vTaskDelay()).  If the application makes use of the\r
 179         vTaskDelete() API function (as this demo application does) then it is also\r
 180         important that vApplicationIdleHook() is permitted to return to its calling\r
 181         function, because it is the responsibility of the idle task to clean up\r
 182         memory allocated by the kernel to any task that has since been deleted. */\r
 183 }\r
 184 /*-----------------------------------------------------------*/\r
 185 \r
 186 void vApplicationStackOverflowHook( TaskHandle_t pxTask, char *pcTaskName )\r
 187 {\r
 188         ( void ) pcTaskName;\r
 189         ( void ) pxTask;\r
 190 \r
 191         /* Run time stack overflow checking is performed if\r
 192         configCHECK_FOR_STACK_OVERFLOW is defined to 1 or 2.  This hook\r
 193         function is called if a stack overflow is detected. */\r
 194         taskDISABLE_INTERRUPTS();\r
 195         for( ;; );\r
 196 }\r
 197 /*-----------------------------------------------------------*/\r
 198 \r
 199 void vApplicationTickHook( void )\r
 200 {\r
 201         /* This function will be called by each tick interrupt if\r
 202         configUSE_TICK_HOOK is set to 1 in FreeRTOSConfig.h.  User code can be\r
 203         added here, but the tick hook is called from an interrupt context, so\r
 204         code must not attempt to block, and only the interrupt safe FreeRTOS API\r
 205         functions can be used (those that end in FromISR()). */\r
 206 \r
 207         /* The semaphore and associated task are not created when the simple blinky\r
 208         demo is used. */\r
 209         #if mainCREATE_SIMPLE_BLINKY_DEMO_ONLY == 0\r
 210         {\r
 211                 /* Write to a queue that is in use as part of the queue set demo to\r
 212                 demonstrate using queue sets from an ISR. */\r
 213                 vQueueSetAccessQueueSetFromISR();\r
 214         }\r
 215         #endif /* mainCREATE_SIMPLE_BLINKY_DEMO_ONLY */\r
 216 }\r
 217 /*-----------------------------------------------------------*/\r
 218 \r
 219 void vMainConfigureTimerForRunTimeStats( void )\r
 220 {\r
 221         /* Used by the optional run-time stats gathering functionality. */\r
 222         \r
 223         /* How many clocks are there per tenth of a millisecond? */\r
 224         ulClocksPer10thOfAMilliSecond = configCPU_CLOCK_HZ / 10000UL;\r
 225 }\r
 226 /*-----------------------------------------------------------*/\r
 227 \r
 228 unsigned long ulMainGetRunTimeCounterValue( void )\r
 229 {\r
 230 unsigned long ulSysTickCounts, ulTickCount, ulReturn;\r
 231 const unsigned long ulSysTickReloadValue = ( configCPU_CLOCK_HZ / configTICK_RATE_HZ ) - 1UL;\r
 232 volatile unsigned long * const pulCurrentSysTickCount = ( ( volatile unsigned long *) 0xe000e018 );\r
 233 volatile unsigned long * const pulInterruptCTRLState = ( ( volatile unsigned long *) 0xe000ed04 );\r
 234 const unsigned long ulSysTickPendingBit = 0x04000000UL;\r
 235 \r
 236         /* Used by the optional run-time stats gathering functionality. */\r
 237 \r
 238 \r
 239         /* NOTE: There are potentially race conditions here.  However, it is used\r
 240         anyway to keep the examples simple, and to avoid reliance on a separate\r
 241         timer peripheral. */\r
 242 \r
 243 \r
 244         /* The SysTick is a down counter.  How many clocks have passed since it was\r
 245         last reloaded? */\r
 246         ulSysTickCounts = ulSysTickReloadValue - *pulCurrentSysTickCount;\r
 247         \r
 248         /* How many times has it overflowed? */\r
 249         ulTickCount = xTaskGetTickCountFromISR();\r
 250 \r
 251         /* This is called from the context switch, so will be called from a\r
 252         critical section.  xTaskGetTickCountFromISR() contains its own critical\r
 253         section, and the ISR safe critical sections are not designed to nest,\r
 254         so reset the critical section. */\r
 255         portSET_INTERRUPT_MASK_FROM_ISR();\r
 256         \r
 257         /* Is there a SysTick interrupt pending? */\r
 258         if( ( *pulInterruptCTRLState & ulSysTickPendingBit ) != 0UL )\r
 259         {\r
 260                 /* There is a SysTick interrupt pending, so the SysTick has overflowed\r
 261                 but the tick count not yet incremented. */\r
 262                 ulTickCount++;\r
 263                 \r
 264                 /* Read the SysTick again, as the overflow might have occurred since\r
 265                 it was read last. */\r
 266                 ulSysTickCounts = ulSysTickReloadValue - *pulCurrentSysTickCount;\r
 267         }       \r
 268         \r
 269         /* Convert the tick count into tenths of a millisecond.  THIS ASSUMES\r
 270         configTICK_RATE_HZ is 1000! */\r
 271         ulReturn = ( ulTickCount * 10UL ) ;\r
 272                 \r
 273         /* Add on the number of tenths of a millisecond that have passed since the\r
 274         tick count last got updated. */\r
 275         ulReturn += ( ulSysTickCounts / ulClocksPer10thOfAMilliSecond );\r
 276         \r
 277         return ulReturn;        \r
 278 }\r
 279 /*-----------------------------------------------------------*/\r
 280 \r
 281 #ifdef JUST_AN_EXAMPLE_ISR\r
 282 \r
 283 void Dummy_IRQHandler(void)\r
 284 {\r
 285 long lHigherPriorityTaskWoken = pdFALSE;\r
 286 \r
 287         /* Clear the interrupt if necessary. */\r
 288         Dummy_ClearITPendingBit();\r
 289 \r
 290         /* This interrupt does nothing more than demonstrate how to synchronise a\r
 291         task with an interrupt.  A semaphore is used for this purpose.  Note\r
 292         lHigherPriorityTaskWoken is initialised to zero. Only FreeRTOS API functions\r
 293         that end in "FromISR" can be called from an ISR. */\r
 294         xSemaphoreGiveFromISR( xTestSemaphore, &lHigherPriorityTaskWoken );\r
 295 \r
 296         /* If there was a task that was blocked on the semaphore, and giving the\r
 297         semaphore caused the task to unblock, and the unblocked task has a priority\r
 298         higher than the current Running state task (the task that this interrupt\r
 299         interrupted), then lHigherPriorityTaskWoken will have been set to pdTRUE\r
 300         internally within xSemaphoreGiveFromISR().  Passing pdTRUE into the\r
 301         portEND_SWITCHING_ISR() macro will result in a context switch being pended to\r
 302         ensure this interrupt returns directly to the unblocked, higher priority,\r
 303         task.  Passing pdFALSE into portEND_SWITCHING_ISR() has no effect. */\r
 304         portEND_SWITCHING_ISR( lHigherPriorityTaskWoken );\r
 305 }\r
 306 \r
 307 #endif /* JUST_AN_EXAMPLE_ISR */\r
 308 \r