git.sur5r.net Git - freertos/blob - FreeRTOS/Demo/CORTEX_MB9A310_IAR_Keil/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 on the SK-FM3-64PMC1 evaluation board, which\r
  78  * is populated with an MB9A314 microcontroller.\r
  79  *\r
  80  * The idle hook function:\r
  81  * The idle hook function demonstrates how to query the amount of FreeRTOS heap\r
  82  * space that is remaining (see vApplicationIdleHook() defined in this file).\r
  83  *\r
  84  * The main() Function:\r
  85  * main() creates one software timer, one queue, and two tasks.  It then starts\r
  86  * the scheduler.\r
  87  *\r
  88  * The Queue Send Task:\r
  89  * The queue send task is implemented by the prvQueueSendTask() function in\r
  90  * this file.  prvQueueSendTask() sits in a loop that causes it to repeatedly\r
  91  * block for 200 milliseconds, before sending the value 100 to the queue that\r
  92  * was created within main().  Once the value is sent, the task loops back\r
  93  * around to block for another 200 milliseconds.\r
  94  *\r
  95  * The Queue Receive Task:\r
  96  * The queue receive task is implemented by the prvQueueReceiveTask() function\r
  97  * in this file.  prvQueueReceiveTask() sits in a loop that causes it to\r
  98  * repeatedly attempt to read data from the queue that was created within\r
  99  * main().  When data is received, the task checks the value of the data, and\r
 100  * if the value equals the expected 100, toggles an LED on the 7 segment\r
 101  * display.  The 'block time' parameter passed to the queue receive function\r
 102  * specifies that the task should be held in the Blocked state indefinitely to\r
 103  * wait for data to be available on the queue.  The queue receive task will only\r
 104  * leave the Blocked state when the queue send task writes to the queue.  As the\r
 105  * queue send task writes to the queue every 200 milliseconds, the queue receive\r
 106  * task leaves the Blocked state every 200 milliseconds, and therefore toggles\r
 107  * the LED every 200 milliseconds.\r
 108  *\r
 109  * The LED Software Timer and the Button Interrupt:\r
 110  * The user button SW2 is configured to generate an interrupt each time it is\r
 111  * pressed.  The interrupt service routine switches an LED in the 7 segment\r
 112  * display on, and resets the LED software timer.  The LED timer has a 5000\r
 113  * millisecond (5 second) period, and uses a callback function that is defined\r
 114  * to just turn the LED off again.  Therefore, pressing the user button will\r
 115  * turn the LED on, and the LED will remain on until a full five seconds pass\r
 116  * without the button being pressed.\r
 117  */\r
 118 \r
 119 /* Kernel includes. */\r
 120 #include "FreeRTOS.h"\r
 121 #include "task.h"\r
 122 #include "queue.h"\r
 123 #include "timers.h"\r
 124 \r
 125 /* Fujitsu drivers/libraries. */\r
 126 #include "mcu.h"\r
 127 \r
 128 /* Priorities at which the tasks are created. */\r
 129 #define mainQUEUE_RECEIVE_TASK_PRIORITY         ( tskIDLE_PRIORITY + 2 )\r
 130 #define mainQUEUE_SEND_TASK_PRIORITY            ( tskIDLE_PRIORITY + 1 )\r
 131 \r
 132 /* The rate at which data is sent to the queue, specified in milliseconds, and\r
 133 converted to ticks using the portTICK_RATE_MS constant. */\r
 134 #define mainQUEUE_SEND_FREQUENCY_MS                     ( 200 / portTICK_RATE_MS )\r
 135 \r
 136 /* The number of items the queue can hold.  This is 1 as the receive task\r
 137 will remove items as they are added, meaning the send task should always find\r
 138 the queue empty. */\r
 139 #define mainQUEUE_LENGTH                                        ( 1 )\r
 140 \r
 141 /* The LED toggle by the queue receive task. */\r
 142 #define mainTASK_CONTROLLED_LED                         ( 1UL << 3UL )\r
 143 \r
 144 /* The LED turned on by the button interrupt, and turned off by the LED timer. */\r
 145 #define mainTIMER_CONTROLLED_LED                        ( 1UL << 2UL )\r
 146 \r
 147 /*-----------------------------------------------------------*/\r
 148 \r
 149 /*\r
 150  * Setup the NVIC, LED outputs, and button inputs.\r
 151  */\r
 152 static void prvSetupHardware( void );\r
 153 \r
 154 /*\r
 155  * The tasks as described in the comments at the top of this file.\r
 156  */\r
 157 static void prvQueueReceiveTask( void *pvParameters );\r
 158 static void prvQueueSendTask( void *pvParameters );\r
 159 \r
 160 /*\r
 161  * The LED timer callback function.  This does nothing but switch off the\r
 162  * LED defined by the mainTIMER_CONTROLLED_LED constant.\r
 163  */\r
 164 static void vLEDTimerCallback( xTimerHandle xTimer );\r
 165 \r
 166 /*-----------------------------------------------------------*/\r
 167 \r
 168 /* The queue used by both tasks. */\r
 169 static xQueueHandle xQueue = NULL;\r
 170 \r
 171 /* The LED software timer.  This uses vLEDTimerCallback() as its callback\r
 172 function. */\r
 173 static xTimerHandle xLEDTimer = NULL;\r
 174 \r
 175 /*-----------------------------------------------------------*/\r
 176 \r
 177 int main(void)\r
 178 {\r
 179         /* Configure the NVIC, LED outputs and button inputs. */\r
 180         prvSetupHardware();\r
 181         \r
 182         /* Create the queue. */\r
 183         xQueue = xQueueCreate( mainQUEUE_LENGTH, sizeof( unsigned long ) );\r
 184 \r
 185         if( xQueue != NULL )\r
 186         {\r
 187                 /* Start the two tasks as described in the comments at the top of this\r
 188                 file. */\r
 189                 xTaskCreate( prvQueueReceiveTask, ( signed char * ) "Rx", configMINIMAL_STACK_SIZE, NULL, mainQUEUE_RECEIVE_TASK_PRIORITY, NULL );\r
 190                 xTaskCreate( prvQueueSendTask, ( signed char * ) "TX", configMINIMAL_STACK_SIZE, NULL, mainQUEUE_SEND_TASK_PRIORITY, NULL );\r
 191 \r
 192                 /* Create the software timer that is responsible for turning off the LED\r
 193                 if the button is not pushed within 5000ms, as described at the top of\r
 194                 this file. */\r
 195                 xLEDTimer = xTimerCreate(       ( const signed char * ) "LEDTimer", /* A text name, purely to help debugging. */\r
 196                                                                         ( 5000 / portTICK_RATE_MS ),            /* The timer period, in this case 5000ms (5s). */\r
 197                                                                         pdFALSE,                                                        /* This is a one shot timer, so xAutoReload is set to pdFALSE. */\r
 198                                                                         ( void * ) 0,                                           /* The ID is not used, so can be set to anything. */\r
 199                                                                         vLEDTimerCallback                                       /* The callback function that switches the LED off. */\r
 200                                                                 );\r
 201 \r
 202                 /* Start the tasks and timer running. */\r
 203                 vTaskStartScheduler();\r
 204         }\r
 205 \r
 206         /* If all is well, the scheduler will now be running, and the following line\r
 207         will never be reached.  If the following line does execute, then there was\r
 208         insufficient FreeRTOS heap memory available for the idle and/or timer tasks\r
 209         to be created.  See the memory management section on the FreeRTOS web site\r
 210         for more details. */\r
 211         for( ;; );\r
 212 }\r
 213 /*-----------------------------------------------------------*/\r
 214 \r
 215 static void vLEDTimerCallback( xTimerHandle xTimer )\r
 216 {\r
 217         /* The timer has expired - so no button pushes have occurred in the last\r
 218         five seconds - turn the LED off.  NOTE - accessing the LED port should use\r
 219         a critical section because it is accessed from multiple tasks, and the\r
 220         button interrupt - in this trivial case, for simplicity, the critical\r
 221         section is omitted. */\r
 222         FM3_GPIO->PDOR3 |= mainTIMER_CONTROLLED_LED;\r
 223 }\r
 224 /*-----------------------------------------------------------*/\r
 225 \r
 226 /* The ISR executed when the user button is pushed. */\r
 227 void INT0_7_Handler( void )\r
 228 {\r
 229 portBASE_TYPE xHigherPriorityTaskWoken = pdFALSE;\r
 230 \r
 231         /* The button was pushed, so ensure the LED is on before resetting the\r
 232         LED timer.  The LED timer will turn the LED off if the button is not\r
 233         pushed within 5000ms. */\r
 234         FM3_GPIO->PDOR3 &= ~mainTIMER_CONTROLLED_LED;\r
 235 \r
 236         /* This interrupt safe FreeRTOS function can be called from this interrupt\r
 237         because the interrupt priority is below the\r
 238         configMAX_SYSCALL_INTERRUPT_PRIORITY setting in FreeRTOSConfig.h. */\r
 239         xTimerResetFromISR( xLEDTimer, &xHigherPriorityTaskWoken );\r
 240 \r
 241         /* Clear the interrupt before leaving.  This just clears all the interrupts\r
 242         for simplicity, as only one is actually used in this simple demo anyway. */\r
 243         FM3_EXTI->EICL = 0x0000;\r
 244 \r
 245         /* If calling xTimerResetFromISR() caused a task (in this case the timer\r
 246         service/daemon task) to unblock, and the unblocked task has a priority\r
 247         higher than or equal to the task that was interrupted, then\r
 248         xHigherPriorityTaskWoken will now be set to pdTRUE, and calling\r
 249         portEND_SWITCHING_ISR() will ensure the unblocked task runs next. */\r
 250         portEND_SWITCHING_ISR( xHigherPriorityTaskWoken );\r
 251 }\r
 252 /*-----------------------------------------------------------*/\r
 253 \r
 254 static void prvQueueSendTask( void *pvParameters )\r
 255 {\r
 256 portTickType xNextWakeTime;\r
 257 const unsigned long ulValueToSend = 100UL;\r
 258 \r
 259         /* Initialise xNextWakeTime - this only needs to be done once. */\r
 260         xNextWakeTime = xTaskGetTickCount();\r
 261 \r
 262         for( ;; )\r
 263         {\r
 264                 /* Place this task in the blocked state until it is time to run again.\r
 265                 The block time is specified in ticks, the constant used converts ticks\r
 266                 to ms.  While in the Blocked state this task will not consume any CPU\r
 267                 time. */\r
 268                 vTaskDelayUntil( &xNextWakeTime, mainQUEUE_SEND_FREQUENCY_MS );\r
 269 \r
 270                 /* Send to the queue - causing the queue receive task to unblock and\r
 271                 toggle an LED.  0 is used as the block time so the sending operation\r
 272                 will not block - it shouldn't need to block as the queue should always\r
 273                 be empty at this point in the code. */\r
 274                 xQueueSend( xQueue, &ulValueToSend, 0 );\r
 275         }\r
 276 }\r
 277 /*-----------------------------------------------------------*/\r
 278 \r
 279 static void prvQueueReceiveTask( void *pvParameters )\r
 280 {\r
 281 unsigned long ulReceivedValue;\r
 282 \r
 283         for( ;; )\r
 284         {\r
 285                 /* Wait until something arrives in the queue - this task will block\r
 286                 indefinitely provided INCLUDE_vTaskSuspend is set to 1 in\r
 287                 FreeRTOSConfig.h. */\r
 288                 xQueueReceive( xQueue, &ulReceivedValue, portMAX_DELAY );\r
 289 \r
 290                 /*  To get here something must have been received from the queue, but\r
 291                 is it the expected value?  If it is, toggle the LED. */\r
 292                 if( ulReceivedValue == 100UL )\r
 293                 {\r
 294                         /* NOTE - accessing the LED port should use a critical section\r
 295                         because it is accessed from multiple tasks, and the button interrupt\r
 296                         - in this trivial case, for simplicity, the critical section is\r
 297                         omitted. */\r
 298                         if( ( FM3_GPIO->PDOR3 & mainTASK_CONTROLLED_LED ) != 0 )\r
 299                         {\r
 300                                 FM3_GPIO->PDOR3 &= ~mainTASK_CONTROLLED_LED;\r
 301                         }\r
 302                         else\r
 303                         {\r
 304                                 FM3_GPIO->PDOR3 |= mainTASK_CONTROLLED_LED;\r
 305                         }\r
 306                 }\r
 307         }\r
 308 }\r
 309 /*-----------------------------------------------------------*/\r
 310 \r
 311 static void prvSetupHardware( void )\r
 312 {\r
 313 const unsigned short usButtonInputBit = 0x01U;\r
 314 \r
 315         SystemInit();\r
 316         SystemCoreClockUpdate();\r
 317         \r
 318         /* Analog inputs are not used on the LED outputs. */\r
 319         FM3_GPIO->ADE  = 0x0000;\r
 320         \r
 321         /* Set to output. */\r
 322         FM3_GPIO->DDR1 |= 0xFFFF;\r
 323         FM3_GPIO->DDR3 |= 0xFFFF;\r
 324         \r
 325         /* Set as GPIO. */\r
 326         FM3_GPIO->PFR1 &= 0x0000;\r
 327         FM3_GPIO->PFR3 &= 0x0000;\r
 328 \r
 329         /* Start with all LEDs off. */\r
 330         FM3_GPIO->PDOR3 = 0xFFFF;\r
 331         FM3_GPIO->PDOR1 = 0xFFFF;\r
 332         \r
 333         /* Set the switches to input (P18->P1F). */\r
 334         FM3_GPIO->DDR5 = 0x0000;\r
 335         FM3_GPIO->PFR5 = 0x0000;\r
 336 \r
 337         /* Assign the button input as GPIO. */\r
 338         FM3_GPIO->PFR5 |= usButtonInputBit;\r
 339         \r
 340         /* Button interrupt on falling edge. */\r
 341         FM3_EXTI->ELVR  = 0x0003;\r
 342 \r
 343         /* Clear all external interrupts. */\r
 344         FM3_EXTI->EICL  = 0x0000;\r
 345 \r
 346         /* Enable the button interrupt. */\r
 347         FM3_EXTI->ENIR |= usButtonInputBit;\r
 348         \r
 349         /* Setup the GPIO and the NVIC for the switch used in this simple demo. */\r
 350         NVIC_SetPriority( EXINT0_7_IRQn, configLIBRARY_MAX_SYSCALL_INTERRUPT_PRIORITY );\r
 351     NVIC_EnableIRQ( EXINT0_7_IRQn );\r
 352 }\r
 353 /*-----------------------------------------------------------*/\r
 354 \r
 355 void vApplicationMallocFailedHook( void )\r
 356 {\r
 357         /* Called if a call to pvPortMalloc() fails because there is insufficient\r
 358         free memory available in the FreeRTOS heap.  pvPortMalloc() is called\r
 359         internally by FreeRTOS API functions that create tasks, queues, software\r
 360         timers, and semaphores.  The size of the FreeRTOS heap is set by the\r
 361         configTOTAL_HEAP_SIZE configuration constant in FreeRTOSConfig.h. */\r
 362         for( ;; );\r
 363 }\r
 364 /*-----------------------------------------------------------*/\r
 365 \r
 366 void vApplicationStackOverflowHook( xTaskHandle pxTask, signed char *pcTaskName )\r
 367 {\r
 368         ( void ) pcTaskName;\r
 369         ( void ) pxTask;\r
 370 \r
 371         /* Run time stack overflow checking is performed if\r
 372         configconfigCHECK_FOR_STACK_OVERFLOW is defined to 1 or 2.  This hook\r
 373         function is called if a stack overflow is detected. */\r
 374         for( ;; );\r
 375 }\r
 376 /*-----------------------------------------------------------*/\r
 377 \r
 378 void vApplicationTickHook( void )\r
 379 {\r
 380         /* A tick hook is used by the "Full" build configuration.  The Full and\r
 381         blinky build configurations share a FreeRTOSConfig.h header file, so this\r
 382         simple build configuration also has to define a tick hook - even though it\r
 383         does not actually use it for anything. */\r
 384 }\r
 385 /*-----------------------------------------------------------*/\r
 386 \r
 387 void vApplicationIdleHook( void )\r
 388 {\r
 389 volatile size_t xFreeHeapSpace;\r
 390 \r
 391         /* This function is called on each cycle of the idle task.  In this case it\r
 392         does nothing useful, other than report the amount of FreeRTOS heap that\r
 393         remains unallocated. */\r
 394         xFreeHeapSpace = xPortGetFreeHeapSize();\r
 395 \r
 396         if( xFreeHeapSpace > 100 )\r
 397         {\r
 398                 /* By now, the kernel has allocated everything it is going to, so\r
 399                 if there is a lot of heap remaining unallocated then\r
 400                 the value of configTOTAL_HEAP_SIZE in FreeRTOSConfig.h can be\r
 401                 reduced accordingly. */\r
 402         }\r
 403 }\r
 404 /*-----------------------------------------------------------*/\r
 405 \r
 406 \r
 407 \r
 408 \r