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

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