git.sur5r.net Git - freertos/blob - FreeRTOS/Demo/CORTEX_M0_LPC1114_LPCXpresso/RTOSDemo/Source/main.c

   1 /*\r
   2     FreeRTOS V7.5.0 - Copyright (C) 2013 Real Time Engineers Ltd.\r
   3 \r
   4     VISIT http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.\r
   5 \r
   6     ***************************************************************************\r
   7      *                                                                       *\r
   8      *    FreeRTOS provides completely free yet professionally developed,    *\r
   9      *    robust, strictly quality controlled, supported, and cross          *\r
  10      *    platform software that has become a de facto standard.             *\r
  11      *                                                                       *\r
  12      *    Help yourself get started quickly and support the FreeRTOS         *\r
  13      *    project by purchasing a FreeRTOS tutorial book, reference          *\r
  14      *    manual, or both from: http://www.FreeRTOS.org/Documentation        *\r
  15      *                                                                       *\r
  16      *    Thank you!                                                         *\r
  17      *                                                                       *\r
  18     ***************************************************************************\r
  19 \r
  20     This file is part of the FreeRTOS distribution.\r
  21 \r
  22     FreeRTOS is free software; you can redistribute it and/or modify it under\r
  23     the terms of the GNU General Public License (version 2) as published by the\r
  24     Free Software Foundation >>!AND MODIFIED BY!<< the FreeRTOS exception.\r
  25 \r
  26     >>! NOTE: The modification to the GPL is included to allow you to distribute\r
  27     >>! a combined work that includes FreeRTOS without being obliged to provide\r
  28     >>! the source code for proprietary components outside of the FreeRTOS\r
  29     >>! kernel.\r
  30 \r
  31     FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY\r
  32     WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS\r
  33     FOR A PARTICULAR PURPOSE.  Full license text is available from the following\r
  34     link: http://www.freertos.org/a00114.html\r
  35 \r
  36     1 tab == 4 spaces!\r
  37 \r
  38     ***************************************************************************\r
  39      *                                                                       *\r
  40      *    Having a problem?  Start by reading the FAQ "My application does   *\r
  41      *    not run, what could be wrong?"                                     *\r
  42      *                                                                       *\r
  43      *    http://www.FreeRTOS.org/FAQHelp.html                               *\r
  44      *                                                                       *\r
  45     ***************************************************************************\r
  46 \r
  47     http://www.FreeRTOS.org - Documentation, books, training, latest versions,\r
  48     license and Real Time Engineers Ltd. contact details.\r
  49 \r
  50     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
  51     including FreeRTOS+Trace - an indispensable productivity tool, a DOS\r
  52     compatible FAT file system, and our tiny thread aware UDP/IP stack.\r
  53 \r
  54     http://www.OpenRTOS.com - Real Time Engineers ltd license FreeRTOS to High\r
  55     Integrity Systems to sell under the OpenRTOS brand.  Low cost OpenRTOS\r
  56     licenses offer ticketed support, indemnification and middleware.\r
  57 \r
  58     http://www.SafeRTOS.com - High Integrity Systems also provide a safety\r
  59     engineered and independently SIL3 certified version for use in safety and\r
  60     mission critical applications that require provable dependability.\r
  61 \r
  62     1 tab == 4 spaces!\r
  63 */\r
  64 \r
  65 /******************************************************************************\r
  66  * This project provides two demo applications.  A simple blinky style project,\r
  67  * and a more comprehensive test and demo application.  The\r
  68  * mainCREATE_SIMPLE_BLINKY_DEMO_ONLY setting (defined in this file) is used to\r
  69  * select between the two.  The simply blinky demo is implemented and described\r
  70  * in main_blinky.c.  The more comprehensive test and demo application is\r
  71  * implemented and described in main_full.c.\r
  72  *\r
  73  * This file implements the code that is not demo specific, including the\r
  74  * hardware setup and FreeRTOS hook functions.  It also contains a dummy\r
  75  * interrupt service routine called Dummy_IRQHandler() that is provided as an\r
  76  * example of how to use interrupt safe FreeRTOS API functions (those that end\r
  77  * in "FromISR").\r
  78  *\r
  79  *****************************************************************************/\r
  80 \r
  81 /* Standard includes. */\r
  82 #include "string.h"\r
  83 \r
  84 /* FreeRTOS includes. */\r
  85 #include "FreeRTOS.h"\r
  86 #include "task.h"\r
  87 \r
  88 /* Hardware specific includes. */\r
  89 #include "lpc11xx.h"\r
  90 \r
  91 /* Set mainCREATE_SIMPLE_BLINKY_DEMO_ONLY to one to run the simple blinky demo,\r
  92 or 0 to run the more comprehensive test and demo application. */\r
  93 #define mainCREATE_SIMPLE_BLINKY_DEMO_ONLY      0\r
  94 \r
  95 /* The bit on port 0 to which the LED is wired. */\r
  96 #define mainLED_BIT             ( 1UL << 7UL )\r
  97 \r
  98 /* The configCHECK_FOR_STACK_OVERFLOW setting in FreeRTOSConifg can be used to\r
  99 check task stacks for overflows.  It does not however check the stack used by\r
 100 interrupts.  This demo has a simple addition that will also check the stack used\r
 101 by interrupts if mainCHECK_INTERRUPT_STACK is set to 1.  Note that this check is\r
 102 only performed from the tick hook function (which runs in an interrupt context).\r
 103 It is a good debugging aid - but won't catch interrupt stack problems until the\r
 104 tick interrupt next executes. */\r
 105 #define mainCHECK_INTERRUPT_STACK                       1\r
 106 #if mainCHECK_INTERRUPT_STACK == 1\r
 107         const unsigned char ucExpectedInterruptStackValues[] = { 0xCC, 0xCC, 0xCC, 0xCC, 0xCC, 0xCC, 0xCC, 0xCC, 0xCC, 0xCC, 0xCC, 0xCC, 0xCC, 0xCC, 0xCC, 0xCC };\r
 108 #endif\r
 109 \r
 110 /*-----------------------------------------------------------*/\r
 111 \r
 112 /*\r
 113  * Perform any application specific hardware configuration.  The clocks,\r
 114  * memory, etc. are configured before main() is called.\r
 115  */\r
 116 static void prvSetupHardware( void );\r
 117 \r
 118 /*\r
 119  * The hardware only has a single LED.  Simply toggle it.\r
 120  */\r
 121 void vMainToggleLED( void );\r
 122 \r
 123 /* main_blinky() is used when mainCREATE_SIMPLE_BLINKY_DEMO_ONLY is set to 1.\r
 124 main_full() is used when mainCREATE_SIMPLE_BLINKY_DEMO_ONLY is set to 0. */\r
 125 void main_blinky( void );\r
 126 void main_full( void );\r
 127 \r
 128 /*-----------------------------------------------------------*/\r
 129 \r
 130 /* The GPIO port to which the LED is attached. */\r
 131 static LPC_GPIO_TypeDef * const xGPIO0 = LPC_GPIO0;\r
 132 \r
 133 /*-----------------------------------------------------------*/\r
 134 int main( void )\r
 135 {\r
 136         /* Prepare the hardware to run this demo. */\r
 137         prvSetupHardware();\r
 138 \r
 139         /* The mainCREATE_SIMPLE_BLINKY_DEMO_ONLY setting is described at the top\r
 140         of this file. */\r
 141         #if mainCREATE_SIMPLE_BLINKY_DEMO_ONLY == 1\r
 142         {\r
 143                 main_blinky();\r
 144         }\r
 145         #else\r
 146         {\r
 147                 main_full();\r
 148         }\r
 149         #endif\r
 150 \r
 151         return 0;\r
 152 }\r
 153 /*-----------------------------------------------------------*/\r
 154 \r
 155 void vMainToggleLED( void )\r
 156 {\r
 157 static unsigned long ulLEDState = 0UL;\r
 158 \r
 159         if( ulLEDState == 0UL )\r
 160         {\r
 161                 xGPIO0->MASKED_ACCESS[ mainLED_BIT ] = 0UL;\r
 162         }\r
 163         else\r
 164         {\r
 165                 xGPIO0->MASKED_ACCESS[ mainLED_BIT ] = mainLED_BIT;\r
 166         }\r
 167 \r
 168         ulLEDState = !ulLEDState;\r
 169 }\r
 170 /*-----------------------------------------------------------*/\r
 171 \r
 172 static void prvSetupHardware( void )\r
 173 {\r
 174 extern unsigned long _vStackTop[], _pvHeapStart[];\r
 175 unsigned long ulInterruptStackSize;\r
 176 \r
 177         /* Enable AHB clock for GPIO. */\r
 178         LPC_SYSCON->SYSAHBCLKCTRL |= ( 1 << 6 );\r
 179 \r
 180         /* Configure GPIO for LED output. */\r
 181         xGPIO0->DIR |= mainLED_BIT;\r
 182 \r
 183         /* The size of the stack used by main and interrupts is not defined in\r
 184         the linker, but just uses whatever RAM is left.  Calculate the amount of\r
 185         RAM available for the main/interrupt/system stack, and check it against\r
 186         a reasonable number.  If this assert is hit then it is likely you don't\r
 187         have enough stack to start the kernel, or to allow interrupts to nest.\r
 188         Note - this is separate to the stacks that are used by tasks.  The stacks\r
 189         that are used by tasks are automatically checked if\r
 190         configCHECK_FOR_STACK_OVERFLOW is not 0 in FreeRTOSConfig.h - but the stack\r
 191         used by interrupts is not.  Reducing the conifgTOTAL_HEAP_SIZE setting will\r
 192         increase the stack available to main() and interrupts. */\r
 193         ulInterruptStackSize = ( ( unsigned long ) _vStackTop ) - ( ( unsigned long ) _pvHeapStart );\r
 194         configASSERT( ulInterruptStackSize > 350UL );\r
 195 \r
 196         /* Fill the stack used by main() and interrupts to a known value, so its\r
 197         use can be manually checked. */\r
 198         memcpy( ( void * ) _pvHeapStart, ucExpectedInterruptStackValues, sizeof( ucExpectedInterruptStackValues ) );\r
 199 }\r
 200 /*-----------------------------------------------------------*/\r
 201 \r
 202 void vApplicationMallocFailedHook( void )\r
 203 {\r
 204         /* vApplicationMallocFailedHook() will only be called if\r
 205         configUSE_MALLOC_FAILED_HOOK is set to 1 in FreeRTOSConfig.h.  It is a hook\r
 206         function that will get called if a call to pvPortMalloc() fails.\r
 207         pvPortMalloc() is called internally by the kernel whenever a task, queue,\r
 208         timer or semaphore is created.  It is also called by various parts of the\r
 209         demo application.  If heap_1.c or heap_2.c are used, then the size of the\r
 210         heap available to pvPortMalloc() is defined by configTOTAL_HEAP_SIZE in\r
 211         FreeRTOSConfig.h, and the xPortGetFreeHeapSize() API function can be used\r
 212         to query the size of free heap space that remains (although it does not\r
 213         provide information on how the remaining heap might be fragmented). */\r
 214         taskDISABLE_INTERRUPTS();\r
 215         for( ;; );\r
 216 }\r
 217 /*-----------------------------------------------------------*/\r
 218 \r
 219 void vApplicationIdleHook( void )\r
 220 {\r
 221         /* vApplicationIdleHook() will only be called if configUSE_IDLE_HOOK is set\r
 222         to 1 in FreeRTOSConfig.h.  It will be called on each iteration of the idle\r
 223         task.  It is essential that code added to this hook function never attempts\r
 224         to block in any way (for example, call xQueueReceive() with a block time\r
 225         specified, or call vTaskDelay()).  If the application makes use of the\r
 226         vTaskDelete() API function (as this demo application does) then it is also\r
 227         important that vApplicationIdleHook() is permitted to return to its calling\r
 228         function, because it is the responsibility of the idle task to clean up\r
 229         memory allocated by the kernel to any task that has since been deleted. */\r
 230 }\r
 231 /*-----------------------------------------------------------*/\r
 232 \r
 233 void vApplicationStackOverflowHook( xTaskHandle pxTask, signed char *pcTaskName )\r
 234 {\r
 235         ( void ) pcTaskName;\r
 236         ( void ) pxTask;\r
 237 \r
 238         /* Run time stack overflow checking is performed if\r
 239         configCHECK_FOR_STACK_OVERFLOW is defined to 1 or 2.  This hook\r
 240         function is called if a stack overflow is detected. */\r
 241         taskDISABLE_INTERRUPTS();\r
 242         for( ;; );\r
 243 }\r
 244 /*-----------------------------------------------------------*/\r
 245 \r
 246 void vApplicationTickHook( void )\r
 247 {\r
 248 #if mainCHECK_INTERRUPT_STACK == 1\r
 249 extern unsigned long _pvHeapStart[];\r
 250 \r
 251         /* This function will be called by each tick interrupt if\r
 252         configUSE_TICK_HOOK is set to 1 in FreeRTOSConfig.h.  User code can be\r
 253         added here, but the tick hook is called from an interrupt context, so\r
 254         code must not attempt to block, and only the interrupt safe FreeRTOS API\r
 255         functions can be used (those that end in FromISR()). */\r
 256 \r
 257         /* Manually check the last few bytes of the interrupt stack to check they\r
 258         have not been overwritten.  Note - the task stacks are automatically\r
 259         checked for overflow if configCHECK_FOR_STACK_OVERFLOW is set to 1 or 2\r
 260         in FreeRTOSConifg.h, but the interrupt stack is not. */\r
 261         configASSERT( memcmp( ( void * ) _pvHeapStart, ucExpectedInterruptStackValues, sizeof( ucExpectedInterruptStackValues ) ) == 0U );\r
 262 #endif /* mainCHECK_INTERRUPT_STACK */\r
 263 }\r
 264 /*-----------------------------------------------------------*/\r
 265 \r
 266 #ifdef JUST_AN_EXAMPLE_ISR\r
 267 \r
 268 void Dummy_IRQHandler(void)\r
 269 {\r
 270 long lHigherPriorityTaskWoken = pdFALSE;\r
 271 \r
 272         /* Clear the interrupt if necessary. */\r
 273         Dummy_ClearITPendingBit();\r
 274 \r
 275         /* This interrupt does nothing more than demonstrate how to synchronise a\r
 276         task with an interrupt.  A semaphore is used for this purpose.  Note\r
 277         lHigherPriorityTaskWoken is initialised to zero.  Only FreeRTOS API functions\r
 278         that end in "FromISR" can be called from an ISR. */\r
 279         xSemaphoreGiveFromISR( xTestSemaphore, &lHigherPriorityTaskWoken );\r
 280 \r
 281         /* If there was a task that was blocked on the semaphore, and giving the\r
 282         semaphore caused the task to unblock, and the unblocked task has a priority\r
 283         higher than the current Running state task (the task that this interrupt\r
 284         interrupted), then lHigherPriorityTaskWoken will have been set to pdTRUE\r
 285         internally within xSemaphoreGiveFromISR().  Passing pdTRUE into the\r
 286         portEND_SWITCHING_ISR() macro will result in a context switch being pended to\r
 287         ensure this interrupt returns directly to the unblocked, higher priority,\r
 288         task.  Passing pdFALSE into portEND_SWITCHING_ISR() has no effect. */\r
 289         portEND_SWITCHING_ISR( lHigherPriorityTaskWoken );\r
 290 }\r
 291 \r
 292 #endif /* JUST_AN_EXAMPLE_ISR */\r
 293 \r
 294 \r
 295 \r
 296 \r