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

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