git.sur5r.net Git - freertos/blob - FreeRTOS/Demo/CORTEX_Kinetis_K60_Tower_IAR/main_blinky.c

   1 /*\r
   2     FreeRTOS V7.3.0 - Copyright (C) 2012 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     >>>NOTE<<< The modification to the GPL is included to allow you to\r
  33     distribute a combined work that includes FreeRTOS without being obliged to\r
  34     provide the source code for proprietary components outside of the FreeRTOS\r
  35     kernel.  FreeRTOS is distributed in the hope that it will be useful, but\r
  36     WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY\r
  37     or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for\r
  38     more details. You should have received a copy of the GNU General Public\r
  39     License and the FreeRTOS license exception along with FreeRTOS; if not it\r
  40     can be viewed here: http://www.freertos.org/a00114.html and also obtained\r
  41     by writing to Richard Barry, contact details for whom are available on the\r
  42     FreeRTOS WEB site.\r
  43 \r
  44     1 tab == 4 spaces!\r
  45     \r
  46     ***************************************************************************\r
  47      *                                                                       *\r
  48      *    Having a problem?  Start by reading the FAQ "My application does   *\r
  49      *    not run, what could be wrong?"                                     *\r
  50      *                                                                       *\r
  51      *    http://www.FreeRTOS.org/FAQHelp.html                               *\r
  52      *                                                                       *\r
  53     ***************************************************************************\r
  54 \r
  55     \r
  56     http://www.FreeRTOS.org - Documentation, training, latest versions, license \r
  57     and contact details.  \r
  58     \r
  59     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
  60     including FreeRTOS+Trace - an indispensable productivity tool.\r
  61 \r
  62     Real Time Engineers ltd license FreeRTOS to High Integrity Systems, who sell \r
  63     the code with commercial support, indemnification, and middleware, under \r
  64     the OpenRTOS brand: http://www.OpenRTOS.com.  High Integrity Systems also\r
  65     provide a safety engineered and independently SIL3 certified version under \r
  66     the SafeRTOS brand: http://www.SafeRTOS.com.\r
  67 */\r
  68 \r
  69 /*\r
  70  * main-blinky.c is included when the "Blinky" build configuration is used.\r
  71  * main-full.c is included when the "Full" build configuration is used.\r
  72  *\r
  73  * main-blinky.c (this file) defines a very simple demo that creates two tasks,\r
  74  * one queue, and one timer.  It also demonstrates how Cortex-M3 interrupts can\r
  75  * interact with FreeRTOS tasks/timers.\r
  76  *\r
  77  * This simple demo project runs 'stand alone' (without the rest of the tower\r
  78  * system) on the TWR-K60N512 tower module, which is populated with a K60N512\r
  79  * Cortex-M4 microcontroller.\r
  80  *\r
  81  * The idle hook function:\r
  82  * The idle hook function demonstrates how to query the amount of FreeRTOS heap\r
  83  * space that is remaining (see vApplicationIdleHook() defined in this file).\r
  84  *\r
  85  * The main() Function:\r
  86  * main() creates one software timer, one queue, and two tasks.  It then starts\r
  87  * the scheduler.\r
  88  *\r
  89  * The Queue Send Task:\r
  90  * The queue send task is implemented by the prvQueueSendTask() function in\r
  91  * this file.  prvQueueSendTask() sits in a loop that causes it to repeatedly\r
  92  * block for 200 milliseconds, before sending the value 100 to the queue that\r
  93  * was created within main().  Once the value is sent, the task loops back\r
  94  * around to block for another 200 milliseconds.\r
  95  *\r
  96  * The Queue Receive Task:\r
  97  * The queue receive task is implemented by the prvQueueReceiveTask() function\r
  98  * in this file.  prvQueueReceiveTask() sits in a loop that causes it to\r
  99  * repeatedly attempt to read data from the queue that was created within\r
 100  * main().  When data is received, the task checks the value of the data, and\r
 101  * if the value equals the expected 100, toggles the blue LED.  The 'block \r
 102  * time' parameter passed to the queue receive function specifies that the task \r
 103  * should be held in the Blocked state indefinitely to wait for data to be \r
 104  * available on the queue.  The queue receive task will only leave the Blocked \r
 105  * state when the queue send task writes to the queue.  As the queue send task \r
 106  * writes to the queue every 200 milliseconds, the queue receive task leaves the \r
 107  * Blocked state every 200 milliseconds, and therefore toggles the blue LED \r
 108  * every 200 milliseconds.\r
 109  *\r
 110  * The LED Software Timer and the Button Interrupt:\r
 111  * The user button SW2 is configured to generate an interrupt each time it is\r
 112  * pressed.  The interrupt service routine switches the green LED on, and \r
 113  * resets the LED software timer.  The LED timer has a 5000 millisecond (5 \r
 114  * second) period, and uses a callback function that is defined to just turn the \r
 115  * LED off again.  Therefore, pressing the user button will turn the LED on, and \r
 116  * the LED will remain on until a full five seconds pass without the button \r
 117  * being pressed.\r
 118  */\r
 119 \r
 120 /* Kernel includes. */\r
 121 #include "FreeRTOS.h"\r
 122 #include "task.h"\r
 123 #include "queue.h"\r
 124 #include "timers.h"\r
 125 \r
 126 /* Freescale includes. */\r
 127 #include "common.h"\r
 128 \r
 129 /* Priorities at which the tasks are created. */\r
 130 #define mainQUEUE_RECEIVE_TASK_PRIORITY         ( tskIDLE_PRIORITY + 2 )\r
 131 #define mainQUEUE_SEND_TASK_PRIORITY            ( tskIDLE_PRIORITY + 1 )\r
 132 \r
 133 /* The rate at which data is sent to the queue, specified in milliseconds, and\r
 134 converted to ticks using the portTICK_RATE_MS constant. */\r
 135 #define mainQUEUE_SEND_FREQUENCY_MS                     ( 200 / portTICK_RATE_MS )\r
 136 \r
 137 /* The LED will remain on until the button has not been pushed for a full\r
 138 5000ms. */\r
 139 #define mainBUTTON_LED_TIMER_PERIOD_MS          ( 5000UL / portTICK_RATE_MS )\r
 140 \r
 141 /* The number of items the queue can hold.  This is 1 as the receive task\r
 142 will remove items as they are added, meaning the send task should always find\r
 143 the queue empty. */\r
 144 #define mainQUEUE_LENGTH                                        ( 1 )\r
 145 \r
 146 /* The LED toggle by the queue receive task (blue). */\r
 147 #define mainTASK_CONTROLLED_LED                         ( 1UL << 10UL )\r
 148 \r
 149 /* The LED turned on by the button interrupt, and turned off by the LED timer\r
 150 (green). */\r
 151 #define mainTIMER_CONTROLLED_LED                        ( 1UL << 29UL )\r
 152 \r
 153 /* The vector used by the GPIO port E.  Button SW2 is configured to generate\r
 154 an interrupt on this port. */\r
 155 #define mainGPIO_E_VECTOR                                       ( 91 )\r
 156 \r
 157 /* A block time of zero simply means "don't block". */\r
 158 #define mainDONT_BLOCK                                          ( 0UL )\r
 159 \r
 160 /*-----------------------------------------------------------*/\r
 161 \r
 162 /*\r
 163  * Setup the NVIC, LED outputs, and button inputs.\r
 164  */\r
 165 static void prvSetupHardware( void );\r
 166 \r
 167 /*\r
 168  * The tasks as described in the comments at the top of this file.\r
 169  */\r
 170 static void prvQueueReceiveTask( void *pvParameters );\r
 171 static void prvQueueSendTask( void *pvParameters );\r
 172 \r
 173 /*\r
 174  * The LED timer callback function.  This does nothing but switch off the\r
 175  * LED defined by the mainTIMER_CONTROLLED_LED constant.\r
 176  */\r
 177 static void prvButtonLEDTimerCallback( xTimerHandle xTimer );\r
 178 \r
 179 /*-----------------------------------------------------------*/\r
 180 \r
 181 /* The queue used by both tasks. */\r
 182 static xQueueHandle xQueue = NULL;\r
 183 \r
 184 /* The LED software timer.  This uses prvButtonLEDTimerCallback() as its callback\r
 185 function. */\r
 186 static xTimerHandle xButtonLEDTimer = NULL;\r
 187 \r
 188 /*-----------------------------------------------------------*/\r
 189 \r
 190 void main( void )\r
 191 {\r
 192         /* Configure the NVIC, LED outputs and button inputs. */\r
 193         prvSetupHardware();\r
 194 \r
 195         /* Create the queue. */\r
 196         xQueue = xQueueCreate( mainQUEUE_LENGTH, sizeof( unsigned long ) );\r
 197 \r
 198         if( xQueue != NULL )\r
 199         {\r
 200                 /* Start the two tasks as described in the comments at the top of this\r
 201                 file. */\r
 202                 xTaskCreate( prvQueueReceiveTask, ( signed char * ) "Rx", configMINIMAL_STACK_SIZE, NULL, mainQUEUE_RECEIVE_TASK_PRIORITY, NULL );\r
 203                 xTaskCreate( prvQueueSendTask, ( signed char * ) "TX", configMINIMAL_STACK_SIZE, NULL, mainQUEUE_SEND_TASK_PRIORITY, NULL );\r
 204 \r
 205                 /* Create the software timer that is responsible for turning off the LED\r
 206                 if the button is not pushed within 5000ms, as described at the top of\r
 207                 this file. */\r
 208                 xButtonLEDTimer = xTimerCreate( ( const signed char * ) "ButtonLEDTimer", /* A text name, purely to help debugging. */\r
 209                                                                         mainBUTTON_LED_TIMER_PERIOD_MS,                 /* The timer period, in this case 5000ms (5s). */\r
 210                                                                         pdFALSE,                                                                /* This is a one shot timer, so xAutoReload is set to pdFALSE. */\r
 211                                                                         ( void * ) 0,                                                   /* The ID is not used, so can be set to anything. */\r
 212                                                                         prvButtonLEDTimerCallback                               /* The callback function that switches the LED off. */\r
 213                                                                 );\r
 214 \r
 215                 /* Start the tasks and timer running. */\r
 216                 vTaskStartScheduler();\r
 217         }\r
 218 \r
 219         /* If all is well, the scheduler will now be running, and the following line\r
 220         will never be reached.  If the following line does execute, then there was\r
 221         insufficient FreeRTOS heap memory available for the idle and/or timer tasks\r
 222         to be created.  See the memory management section on the FreeRTOS web site\r
 223         for more details. */\r
 224         for( ;; );\r
 225 }\r
 226 /*-----------------------------------------------------------*/\r
 227 \r
 228 static void prvButtonLEDTimerCallback( xTimerHandle xTimer )\r
 229 {\r
 230         /* The timer has expired - so no button pushes have occurred in the last\r
 231         five seconds - turn the LED off. */\r
 232         GPIOA_PSOR = mainTIMER_CONTROLLED_LED;\r
 233 }\r
 234 /*-----------------------------------------------------------*/\r
 235 \r
 236 /* The ISR executed when the user button is pushed. */\r
 237 void vPort_E_ISRHandler( void )\r
 238 {\r
 239 portBASE_TYPE xHigherPriorityTaskWoken = pdFALSE;\r
 240 \r
 241         /* The button was pushed, so ensure the LED is on before resetting the\r
 242         LED timer.  The LED timer will turn the LED off if the button is not\r
 243         pushed within 5000ms. */\r
 244         GPIOA_PCOR = mainTIMER_CONTROLLED_LED;\r
 245 \r
 246         /* This interrupt safe FreeRTOS function can be called from this interrupt\r
 247         because the interrupt priority is below the\r
 248         configLIBRARY_MAX_SYSCALL_INTERRUPT_PRIORITY setting in FreeRTOSConfig.h. */\r
 249         xTimerResetFromISR( xButtonLEDTimer, &xHigherPriorityTaskWoken );\r
 250 \r
 251         /* Clear the interrupt before leaving. */\r
 252         PORTE_ISFR = 0xFFFFFFFFUL;\r
 253 \r
 254         /* If calling xTimerResetFromISR() caused a task (in this case the timer\r
 255         service/daemon task) to unblock, and the unblocked task has a priority\r
 256         higher than or equal to the task that was interrupted, then\r
 257         xHigherPriorityTaskWoken will now be set to pdTRUE, and calling\r
 258         portEND_SWITCHING_ISR() will ensure the unblocked task runs next. */\r
 259         portEND_SWITCHING_ISR( xHigherPriorityTaskWoken );\r
 260 }\r
 261 /*-----------------------------------------------------------*/\r
 262 \r
 263 static void prvQueueSendTask( void *pvParameters )\r
 264 {\r
 265 portTickType xNextWakeTime;\r
 266 const unsigned long ulValueToSend = 100UL;\r
 267 \r
 268         /* Initialise xNextWakeTime - this only needs to be done once. */\r
 269         xNextWakeTime = xTaskGetTickCount();\r
 270 \r
 271         for( ;; )\r
 272         {\r
 273                 /* Place this task in the blocked state until it is time to run again.\r
 274                 The block time is specified in ticks, the constant used converts ticks\r
 275                 to ms.  While in the Blocked state this task will not consume any CPU\r
 276                 time. */\r
 277                 vTaskDelayUntil( &xNextWakeTime, mainQUEUE_SEND_FREQUENCY_MS );\r
 278 \r
 279                 /* Send to the queue - causing the queue receive task to unblock and\r
 280                 toggle an LED.  0 is used as the block time so the sending operation\r
 281                 will not block - it shouldn't need to block as the queue should always\r
 282                 be empty at this point in the code. */\r
 283                 xQueueSend( xQueue, &ulValueToSend, mainDONT_BLOCK );\r
 284         }\r
 285 }\r
 286 /*-----------------------------------------------------------*/\r
 287 \r
 288 static void prvQueueReceiveTask( void *pvParameters )\r
 289 {\r
 290 unsigned long ulReceivedValue;\r
 291 \r
 292         for( ;; )\r
 293         {\r
 294                 /* Wait until something arrives in the queue - this task will block\r
 295                 indefinitely provided INCLUDE_vTaskSuspend is set to 1 in\r
 296                 FreeRTOSConfig.h. */\r
 297                 xQueueReceive( xQueue, &ulReceivedValue, portMAX_DELAY );\r
 298 \r
 299                 /*  To get here something must have been received from the queue, but\r
 300                 is it the expected value?  If it is, toggle the LED. */\r
 301                 if( ulReceivedValue == 100UL )\r
 302                 {\r
 303                     GPIOA_PTOR = mainTASK_CONTROLLED_LED;\r
 304                 }\r
 305         }\r
 306 }\r
 307 /*-----------------------------------------------------------*/\r
 308 \r
 309 static void prvSetupHardware( void )\r
 310 {\r
 311         /* Enable the interrupt on SW1. */\r
 312         PORTE_PCR26 = PORT_PCR_MUX( 1 ) | PORT_PCR_IRQC( 0xA ) | PORT_PCR_PE_MASK | PORT_PCR_PS_MASK;\r
 313         enable_irq( mainGPIO_E_VECTOR );\r
 314         \r
 315         /* The interrupt calls an interrupt safe API function - so its priority must\r
 316         be equal to or lower than configLIBRARY_MAX_SYSCALL_INTERRUPT_PRIORITY. */\r
 317         set_irq_priority( mainGPIO_E_VECTOR, configLIBRARY_MAX_SYSCALL_INTERRUPT_PRIORITY );\r
 318         \r
 319         /* Set PTA10, PTA11, PTA28, and PTA29 (connected to LED's) for GPIO\r
 320         functionality. */\r
 321         PORTA_PCR10 = ( 0 | PORT_PCR_MUX( 1 ) );\r
 322         PORTA_PCR11 = ( 0 | PORT_PCR_MUX( 1 ) );\r
 323         PORTA_PCR28 = ( 0 | PORT_PCR_MUX( 1 ) );\r
 324         PORTA_PCR29 = ( 0 | PORT_PCR_MUX( 1 ) );\r
 325         \r
 326         /* Change PTA10, PTA29 to outputs. */\r
 327         GPIOA_PDDR=GPIO_PDDR_PDD( mainTASK_CONTROLLED_LED | mainTIMER_CONTROLLED_LED ); \r
 328 \r
 329         /* Start with LEDs off. */\r
 330         GPIOA_PTOR = ~0U;\r
 331 }\r
 332 /*-----------------------------------------------------------*/\r
 333 \r
 334 void vApplicationMallocFailedHook( void )\r
 335 {\r
 336         /* Called if a call to pvPortMalloc() fails because there is insufficient\r
 337         free memory available in the FreeRTOS heap.  pvPortMalloc() is called\r
 338         internally by FreeRTOS API functions that create tasks, queues, software\r
 339         timers, and semaphores.  The size of the FreeRTOS heap is set by the\r
 340         configTOTAL_HEAP_SIZE configuration constant in FreeRTOSConfig.h. */\r
 341         taskDISABLE_INTERRUPTS();\r
 342         for( ;; );\r
 343 }\r
 344 /*-----------------------------------------------------------*/\r
 345 \r
 346 void vApplicationStackOverflowHook( xTaskHandle pxTask, signed char *pcTaskName )\r
 347 {\r
 348         ( void ) pcTaskName;\r
 349         ( void ) pxTask;\r
 350 \r
 351         /* Run time stack overflow checking is performed if\r
 352         configCHECK_FOR_STACK_OVERFLOW is defined to 1 or 2.  This hook\r
 353         function is called if a stack overflow is detected. */\r
 354         taskDISABLE_INTERRUPTS();\r
 355         for( ;; );\r
 356 }\r
 357 /*-----------------------------------------------------------*/\r
 358 \r
 359 void vApplicationIdleHook( void )\r
 360 {\r
 361 volatile size_t xFreeHeapSpace;\r
 362 \r
 363         /* This function is called on each cycle of the idle task.  In this case it\r
 364         does nothing useful, other than report the amount of FreeRTOS heap that\r
 365         remains unallocated. */\r
 366         xFreeHeapSpace = xPortGetFreeHeapSize();\r
 367 \r
 368         if( xFreeHeapSpace > 100 )\r
 369         {\r
 370                 /* By now, the kernel has allocated everything it is going to, so\r
 371                 if there is a lot of heap remaining unallocated then\r
 372                 the value of configTOTAL_HEAP_SIZE in FreeRTOSConfig.h can be\r
 373                 reduced accordingly. */\r
 374         }\r
 375 }\r
 376 /*-----------------------------------------------------------*/\r
 377 \r
 378 /* The Blinky build configuration does not include Ethernet functionality,\r
 379 however, the Full and Blinky build configurations share a vectors.h header file.\r
 380 Therefore, dummy Ethernet interrupt handers need to be defined to keep the\r
 381 linker happy. */\r
 382 void vEMAC_TxISRHandler( void ) {}\r
 383 void vEMAC_RxISRHandler( void ){}\r
 384 void vEMAC_ErrorISRHandler( void ) {}\r
 385 \r
 386 /* The Blinky build configuration does not include run time stats gathering,\r
 387 however, the Full and Blinky build configurations share a FreeRTOSConfig.h\r
 388 file.  Therefore, dummy run time stats functions need to be defined to keep the\r
 389 linker happy. */\r
 390 void vMainConfigureTimerForRunTimeStats( void ) {}\r
 391 unsigned long ulMainGetRunTimeCounterValue( void ) { return 0UL; }\r
 392 \r
 393 /* A tick hook is used by the "Full" build configuration.  The Full and blinky \r
 394 build configurations share a FreeRTOSConfig.h header file, so this simple build \r
 395 configuration also has to define a tick hook - even though it does not actually \r
 396 use it for anything. */\r
 397 void vApplicationTickHook( void ) {}\r
 398 \r
 399 \r
 400 \r
 401 \r
 402 \r
 403 \r
 404 \r