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

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