git.sur5r.net Git - freertos/blob - FreeRTOS/Demo/CORTEX_M0_LPC1114_LPCXpresso/RTOSDemo/Source/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 /* Standard includes. */\r
 113 #include "string.h"\r
 114 \r
 115 /* FreeRTOS includes. */\r
 116 #include "FreeRTOS.h"\r
 117 #include "task.h"\r
 118 \r
 119 /* Hardware specific includes. */\r
 120 #include "lpc11xx.h"\r
 121 \r
 122 /* Set mainCREATE_SIMPLE_BLINKY_DEMO_ONLY to one to run the simple blinky demo,\r
 123 or 0 to run the more comprehensive test and demo application. */\r
 124 #define mainCREATE_SIMPLE_BLINKY_DEMO_ONLY      0\r
 125 \r
 126 /* The bit on port 0 to which the LED is wired. */\r
 127 #define mainLED_BIT             ( 1UL << 7UL )\r
 128 \r
 129 /* The configCHECK_FOR_STACK_OVERFLOW setting in FreeRTOSConifg can be used to\r
 130 check task stacks for overflows.  It does not however check the stack used by\r
 131 interrupts.  This demo has a simple addition that will also check the stack used\r
 132 by interrupts if mainCHECK_INTERRUPT_STACK is set to 1.  Note that this check is\r
 133 only performed from the tick hook function (which runs in an interrupt context).\r
 134 It is a good debugging aid - but won't catch interrupt stack problems until the\r
 135 tick interrupt next executes. */\r
 136 #define mainCHECK_INTERRUPT_STACK                       1\r
 137 #if mainCHECK_INTERRUPT_STACK == 1\r
 138         const unsigned char ucExpectedInterruptStackValues[] = { 0xCC, 0xCC, 0xCC, 0xCC, 0xCC, 0xCC, 0xCC, 0xCC, 0xCC, 0xCC, 0xCC, 0xCC, 0xCC, 0xCC, 0xCC, 0xCC };\r
 139 #endif\r
 140 \r
 141 /*-----------------------------------------------------------*/\r
 142 \r
 143 /*\r
 144  * Perform any application specific hardware configuration.  The clocks,\r
 145  * memory, etc. are configured before main() is called.\r
 146  */\r
 147 static void prvSetupHardware( void );\r
 148 \r
 149 /*\r
 150  * The hardware only has a single LED.  Simply toggle it.\r
 151  */\r
 152 void vMainToggleLED( void );\r
 153 \r
 154 /* main_blinky() is used when mainCREATE_SIMPLE_BLINKY_DEMO_ONLY is set to 1.\r
 155 main_full() is used when mainCREATE_SIMPLE_BLINKY_DEMO_ONLY is set to 0. */\r
 156 void main_blinky( void );\r
 157 void main_full( void );\r
 158 \r
 159 /*-----------------------------------------------------------*/\r
 160 \r
 161 /* The GPIO port to which the LED is attached. */\r
 162 static LPC_GPIO_TypeDef * const xGPIO0 = LPC_GPIO0;\r
 163 \r
 164 /*-----------------------------------------------------------*/\r
 165 int main( void )\r
 166 {\r
 167         /* Prepare the hardware to run this demo. */\r
 168         prvSetupHardware();\r
 169 \r
 170         /* The mainCREATE_SIMPLE_BLINKY_DEMO_ONLY setting is described at the top\r
 171         of this file. */\r
 172         #if mainCREATE_SIMPLE_BLINKY_DEMO_ONLY == 1\r
 173         {\r
 174                 main_blinky();\r
 175         }\r
 176         #else\r
 177         {\r
 178                 main_full();\r
 179         }\r
 180         #endif\r
 181 \r
 182         return 0;\r
 183 }\r
 184 /*-----------------------------------------------------------*/\r
 185 \r
 186 void vMainToggleLED( void )\r
 187 {\r
 188 static unsigned long ulLEDState = 0UL;\r
 189 \r
 190         if( ulLEDState == 0UL )\r
 191         {\r
 192                 xGPIO0->MASKED_ACCESS[ mainLED_BIT ] = 0UL;\r
 193         }\r
 194         else\r
 195         {\r
 196                 xGPIO0->MASKED_ACCESS[ mainLED_BIT ] = mainLED_BIT;\r
 197         }\r
 198 \r
 199         ulLEDState = !ulLEDState;\r
 200 }\r
 201 /*-----------------------------------------------------------*/\r
 202 \r
 203 static void prvSetupHardware( void )\r
 204 {\r
 205 extern unsigned long _vStackTop[], _pvHeapStart[];\r
 206 unsigned long ulInterruptStackSize;\r
 207 \r
 208         /* Enable AHB clock for GPIO. */\r
 209         LPC_SYSCON->SYSAHBCLKCTRL |= ( 1 << 6 );\r
 210 \r
 211         /* Configure GPIO for LED output. */\r
 212         xGPIO0->DIR |= mainLED_BIT;\r
 213 \r
 214         /* The size of the stack used by main and interrupts is not defined in\r
 215         the linker, but just uses whatever RAM is left.  Calculate the amount of\r
 216         RAM available for the main/interrupt/system stack, and check it against\r
 217         a reasonable number.  If this assert is hit then it is likely you don't\r
 218         have enough stack to start the kernel, or to allow interrupts to nest.\r
 219         Note - this is separate to the stacks that are used by tasks.  The stacks\r
 220         that are used by tasks are automatically checked if\r
 221         configCHECK_FOR_STACK_OVERFLOW is not 0 in FreeRTOSConfig.h - but the stack\r
 222         used by interrupts is not.  Reducing the conifgTOTAL_HEAP_SIZE setting will\r
 223         increase the stack available to main() and interrupts. */\r
 224         ulInterruptStackSize = ( ( unsigned long ) _vStackTop ) - ( ( unsigned long ) _pvHeapStart );\r
 225         configASSERT( ulInterruptStackSize > 350UL );\r
 226 \r
 227         /* Fill the stack used by main() and interrupts to a known value, so its\r
 228         use can be manually checked. */\r
 229         memcpy( ( void * ) _pvHeapStart, ucExpectedInterruptStackValues, sizeof( ucExpectedInterruptStackValues ) );\r
 230 }\r
 231 /*-----------------------------------------------------------*/\r
 232 \r
 233 void vApplicationMallocFailedHook( void )\r
 234 {\r
 235         /* vApplicationMallocFailedHook() will only be called if\r
 236         configUSE_MALLOC_FAILED_HOOK is set to 1 in FreeRTOSConfig.h.  It is a hook\r
 237         function that will get called if a call to pvPortMalloc() fails.\r
 238         pvPortMalloc() is called internally by the kernel whenever a task, queue,\r
 239         timer or semaphore is created.  It is also called by various parts of the\r
 240         demo application.  If heap_1.c or heap_2.c are used, then the size of the\r
 241         heap available to pvPortMalloc() is defined by configTOTAL_HEAP_SIZE in\r
 242         FreeRTOSConfig.h, and the xPortGetFreeHeapSize() API function can be used\r
 243         to query the size of free heap space that remains (although it does not\r
 244         provide information on how the remaining heap might be fragmented). */\r
 245         taskDISABLE_INTERRUPTS();\r
 246         for( ;; );\r
 247 }\r
 248 /*-----------------------------------------------------------*/\r
 249 \r
 250 void vApplicationIdleHook( void )\r
 251 {\r
 252         /* vApplicationIdleHook() will only be called if configUSE_IDLE_HOOK is set\r
 253         to 1 in FreeRTOSConfig.h.  It will be called on each iteration of the idle\r
 254         task.  It is essential that code added to this hook function never attempts\r
 255         to block in any way (for example, call xQueueReceive() with a block time\r
 256         specified, or call vTaskDelay()).  If the application makes use of the\r
 257         vTaskDelete() API function (as this demo application does) then it is also\r
 258         important that vApplicationIdleHook() is permitted to return to its calling\r
 259         function, because it is the responsibility of the idle task to clean up\r
 260         memory allocated by the kernel to any task that has since been deleted. */\r
 261 }\r
 262 /*-----------------------------------------------------------*/\r
 263 \r
 264 void vApplicationStackOverflowHook( TaskHandle_t pxTask, char *pcTaskName )\r
 265 {\r
 266         ( void ) pcTaskName;\r
 267         ( void ) pxTask;\r
 268 \r
 269         /* Run time stack overflow checking is performed if\r
 270         configCHECK_FOR_STACK_OVERFLOW is defined to 1 or 2.  This hook\r
 271         function is called if a stack overflow is detected. */\r
 272         taskDISABLE_INTERRUPTS();\r
 273         for( ;; );\r
 274 }\r
 275 /*-----------------------------------------------------------*/\r
 276 \r
 277 void vApplicationTickHook( void )\r
 278 {\r
 279 #if mainCHECK_INTERRUPT_STACK == 1\r
 280 extern unsigned long _pvHeapStart[];\r
 281 \r
 282         /* This function will be called by each tick interrupt if\r
 283         configUSE_TICK_HOOK is set to 1 in FreeRTOSConfig.h.  User code can be\r
 284         added here, but the tick hook is called from an interrupt context, so\r
 285         code must not attempt to block, and only the interrupt safe FreeRTOS API\r
 286         functions can be used (those that end in FromISR()). */\r
 287 \r
 288         /* Manually check the last few bytes of the interrupt stack to check they\r
 289         have not been overwritten.  Note - the task stacks are automatically\r
 290         checked for overflow if configCHECK_FOR_STACK_OVERFLOW is set to 1 or 2\r
 291         in FreeRTOSConifg.h, but the interrupt stack is not. */\r
 292         configASSERT( memcmp( ( void * ) _pvHeapStart, ucExpectedInterruptStackValues, sizeof( ucExpectedInterruptStackValues ) ) == 0U );\r
 293 #endif /* mainCHECK_INTERRUPT_STACK */\r
 294 }\r
 295 /*-----------------------------------------------------------*/\r
 296 \r
 297 #ifdef JUST_AN_EXAMPLE_ISR\r
 298 \r
 299 void Dummy_IRQHandler(void)\r
 300 {\r
 301 long lHigherPriorityTaskWoken = pdFALSE;\r
 302 \r
 303         /* Clear the interrupt if necessary. */\r
 304         Dummy_ClearITPendingBit();\r
 305 \r
 306         /* This interrupt does nothing more than demonstrate how to synchronise a\r
 307         task with an interrupt.  A semaphore is used for this purpose.  Note\r
 308         lHigherPriorityTaskWoken is initialised to zero.  Only FreeRTOS API functions\r
 309         that end in "FromISR" can be called from an ISR. */\r
 310         xSemaphoreGiveFromISR( xTestSemaphore, &lHigherPriorityTaskWoken );\r
 311 \r
 312         /* If there was a task that was blocked on the semaphore, and giving the\r
 313         semaphore caused the task to unblock, and the unblocked task has a priority\r
 314         higher than the current Running state task (the task that this interrupt\r
 315         interrupted), then lHigherPriorityTaskWoken will have been set to pdTRUE\r
 316         internally within xSemaphoreGiveFromISR().  Passing pdTRUE into the\r
 317         portEND_SWITCHING_ISR() macro will result in a context switch being pended to\r
 318         ensure this interrupt returns directly to the unblocked, higher priority,\r
 319         task.  Passing pdFALSE into portEND_SWITCHING_ISR() has no effect. */\r
 320         portEND_SWITCHING_ISR( lHigherPriorityTaskWoken );\r
 321 }\r
 322 \r
 323 #endif /* JUST_AN_EXAMPLE_ISR */\r
 324 \r
 325 \r
 326 \r
 327 \r