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

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