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

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