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

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