git.sur5r.net Git - freertos/blob - FreeRTOS/Demo/CORTEX_A2F200_SoftConsole/main-blinky.c

   1 /*\r
   2     FreeRTOS V7.1.1 - Copyright (C) 2012 Real Time Engineers Ltd.\r
   3 \r
   4 \r
   5     ***************************************************************************\r
   6      *                                                                       *\r
   7      *    FreeRTOS tutorial books are available in pdf and paperback.        *\r
   8      *    Complete, revised, and edited pdf reference manuals are also       *\r
   9      *    available.                                                         *\r
  10      *                                                                       *\r
  11      *    Purchasing FreeRTOS documentation will not only help you, by       *\r
  12      *    ensuring you get running as quickly as possible and with an        *\r
  13      *    in-depth knowledge of how to use FreeRTOS, it will also help       *\r
  14      *    the FreeRTOS project to continue with its mission of providing     *\r
  15      *    professional grade, cross platform, de facto standard solutions    *\r
  16      *    for microcontrollers - completely free of charge!                  *\r
  17      *                                                                       *\r
  18      *    >>> See http://www.FreeRTOS.org/Documentation for details. <<<     *\r
  19      *                                                                       *\r
  20      *    Thank you for using FreeRTOS, and thank you for your support!      *\r
  21      *                                                                       *\r
  22     ***************************************************************************\r
  23 \r
  24 \r
  25     This file is part of the FreeRTOS distribution.\r
  26 \r
  27     FreeRTOS is free software; you can redistribute it and/or modify it under\r
  28     the terms of the GNU General Public License (version 2) as published by the\r
  29     Free Software Foundation AND MODIFIED BY the FreeRTOS exception.\r
  30     >>>NOTE<<< The modification to the GPL is included to allow you to\r
  31     distribute a combined work that includes FreeRTOS without being obliged to\r
  32     provide the source code for proprietary components outside of the FreeRTOS\r
  33     kernel.  FreeRTOS is distributed in the hope that it will be useful, but\r
  34     WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY\r
  35     or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for\r
  36     more details. You should have received a copy of the GNU General Public\r
  37     License and the FreeRTOS license exception along with FreeRTOS; if not it\r
  38     can be viewed here: http://www.freertos.org/a00114.html and also obtained\r
  39     by writing to Richard Barry, contact details for whom are available on the\r
  40     FreeRTOS WEB site.\r
  41 \r
  42     1 tab == 4 spaces!\r
  43     \r
  44     ***************************************************************************\r
  45      *                                                                       *\r
  46      *    Having a problem?  Start by reading the FAQ "My application does   *\r
  47      *    not run, what could be wrong?                                      *\r
  48      *                                                                       *\r
  49      *    http://www.FreeRTOS.org/FAQHelp.html                               *\r
  50      *                                                                       *\r
  51     ***************************************************************************\r
  52 \r
  53     \r
  54     http://www.FreeRTOS.org - Documentation, training, latest information, \r
  55     license and contact details.\r
  56     \r
  57     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
  58     including FreeRTOS+Trace - an indispensable productivity tool.\r
  59 \r
  60     Real Time Engineers ltd license FreeRTOS to High Integrity Systems, who sell \r
  61     the code with commercial support, indemnification, and middleware, under \r
  62     the OpenRTOS brand: http://www.OpenRTOS.com.  High Integrity Systems also\r
  63     provide a safety engineered and independently SIL3 certified version under \r
  64     the SafeRTOS brand: http://www.SafeRTOS.com.\r
  65 */\r
  66 \r
  67 /*\r
  68  * main-blinky.c is included when the "Blinky" build configuration is used.\r
  69  * main-full.c is included when the "Full" build configuration is used.\r
  70  *\r
  71  * main-blinky.c (this file) defines a very simple demo that creates two tasks,\r
  72  * one queue, and one timer.  It also demonstrates how Cortex-M3 interrupts can\r
  73  * interact with FreeRTOS tasks/timers.\r
  74  *\r
  75  * This simple demo project runs on the SmartFusion A2F-EVAL-KIT evaluation\r
  76  * board, which is populated with an A2F200M3F SmartFusion mixed signal FPGA.\r
  77  * The A2F200M3F incorporates a Cortex-M3 microcontroller.\r
  78  *\r
  79  * The idle hook function:\r
  80  * The idle hook function demonstrates how to query the amount of FreeRTOS heap\r
  81  * space that is remaining (see vApplicationIdleHook() defined in this file).\r
  82  *\r
  83  * The main() Function:\r
  84  * main() creates one software timer, one queue, and two tasks.  It then starts\r
  85  * the scheduler.\r
  86  *\r
  87  * The Queue Send Task:\r
  88  * The queue send task is implemented by the prvQueueSendTask() function in\r
  89  * this file.  prvQueueSendTask() sits in a loop that causes it to repeatedly\r
  90  * block for 200 milliseconds, before sending the value 100 to the queue that\r
  91  * was created within main().  Once the value is sent, the task loops back\r
  92  * around to block for another 200 milliseconds.\r
  93  *\r
  94  * The Queue Receive Task:\r
  95  * The queue receive task is implemented by the prvQueueReceiveTask() function\r
  96  * in this file.  prvQueueReceiveTask() sits in a loop that causes it to\r
  97  * repeatedly attempt to read data from the queue that was created within\r
  98  * main().  When data is received, the task checks the value of the data, and\r
  99  * if the value equals the expected 100, toggles the green LED.  The 'block\r
 100  * time' parameter passed to the queue receive function specifies that the task\r
 101  * should be held in the Blocked state indefinitely to wait for data to be\r
 102  * available on the queue.  The queue receive task will only leave the Blocked\r
 103  * state when the queue send task writes to the queue.  As the queue send task\r
 104  * writes to the queue every 200 milliseconds, the queue receive task leaves\r
 105  * the Blocked state every 200 milliseconds, and therefore toggles the LED\r
 106  * every 200 milliseconds.\r
 107  *\r
 108  * The LED Software Timer and the Button Interrupt:\r
 109  * The user button SW1 is configured to generate an interrupt each time it is\r
 110  * pressed.  The interrupt service routine switches an LED on, and resets the\r
 111  * LED software timer.  The LED timer has a 5000 millisecond (5 second) period,\r
 112  * and uses a callback function that is defined to just turn the LED off again.\r
 113  * Therefore, pressing the user button will turn the LED on, and the LED will\r
 114  * remain on until a full five seconds pass without the button being pressed.\r
 115  */\r
 116 \r
 117 /* Kernel includes. */\r
 118 #include "FreeRTOS.h"\r
 119 #include "task.h"\r
 120 #include "queue.h"\r
 121 #include "timers.h"\r
 122 \r
 123 /* Microsemi drivers/libraries. */\r
 124 #include "mss_gpio.h"\r
 125 #include "mss_watchdog.h"\r
 126 \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                         0x01UL\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                        0x02UL\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 /* Maintains the current LED output state. */\r
 176 static volatile unsigned long ulGPIOState = 0UL;\r
 177 \r
 178 /*-----------------------------------------------------------*/\r
 179 \r
 180 int main(void)\r
 181 {\r
 182         /* Configure the NVIC, LED outputs and button inputs. */\r
 183         prvSetupHardware();\r
 184 \r
 185         /* Create the queue. */\r
 186         xQueue = xQueueCreate( mainQUEUE_LENGTH, sizeof( unsigned long ) );\r
 187 \r
 188         if( xQueue != NULL )\r
 189         {\r
 190                 /* Start the two tasks as described in the comments at the top of this\r
 191                 file. */\r
 192                 xTaskCreate( prvQueueReceiveTask, ( signed char * ) "Rx", configMINIMAL_STACK_SIZE, NULL, mainQUEUE_RECEIVE_TASK_PRIORITY, NULL );\r
 193                 xTaskCreate( prvQueueSendTask, ( signed char * ) "TX", configMINIMAL_STACK_SIZE, NULL, mainQUEUE_SEND_TASK_PRIORITY, NULL );\r
 194 \r
 195                 /* Create the software timer that is responsible for turning off the LED\r
 196                 if the button is not pushed within 5000ms, as described at the top of\r
 197                 this file. */\r
 198                 xLEDTimer = xTimerCreate(       ( const signed char * ) "LEDTimer", /* A text name, purely to help debugging. */\r
 199                                                                         ( 5000 / portTICK_RATE_MS ),            /* The timer period, in this case 5000ms (5s). */\r
 200                                                                         pdFALSE,                                                        /* This is a one shot timer, so xAutoReload is set to pdFALSE. */\r
 201                                                                         ( void * ) 0,                                           /* The ID is not used, so can be set to anything. */\r
 202                                                                         vLEDTimerCallback                                       /* The callback function that switches the LED off. */\r
 203                                                                 );\r
 204 \r
 205                 /* Start the tasks and timer running. */\r
 206                 vTaskStartScheduler();\r
 207         }\r
 208 \r
 209         /* If all is well, the scheduler will now be running, and the following line\r
 210         will never be reached.  If the following line does execute, then there was\r
 211         insufficient FreeRTOS heap memory available for the idle and/or timer tasks\r
 212         to be created.  See the memory management section on the FreeRTOS web site\r
 213         for more details. */\r
 214         for( ;; );\r
 215 }\r
 216 /*-----------------------------------------------------------*/\r
 217 \r
 218 static void vLEDTimerCallback( xTimerHandle xTimer )\r
 219 {\r
 220         /* The timer has expired - so no button pushes have occurred in the last\r
 221         five seconds - turn the LED off.  NOTE - accessing the LED port should use\r
 222         a critical section because it is accessed from multiple tasks, and the\r
 223         button interrupt - in this trivial case, for simplicity, the critical\r
 224         section is omitted. */\r
 225         ulGPIOState |= mainTIMER_CONTROLLED_LED;\r
 226         MSS_GPIO_set_outputs( ulGPIOState );\r
 227 }\r
 228 /*-----------------------------------------------------------*/\r
 229 \r
 230 /* The ISR executed when the user button is pushed. */\r
 231 void GPIO8_IRQHandler( void )\r
 232 {\r
 233 portBASE_TYPE xHigherPriorityTaskWoken = pdFALSE;\r
 234 \r
 235         /* The button was pushed, so ensure the LED is on before resetting the\r
 236         LED timer.  The LED timer will turn the LED off if the button is not\r
 237         pushed within 5000ms. */\r
 238         ulGPIOState &= ~mainTIMER_CONTROLLED_LED;\r
 239         MSS_GPIO_set_outputs( ulGPIOState );\r
 240 \r
 241         /* This interrupt safe FreeRTOS function can be called from this interrupt\r
 242         because the interrupt priority is below the\r
 243         configMAX_SYSCALL_INTERRUPT_PRIORITY setting in FreeRTOSConfig.h. */\r
 244         xTimerResetFromISR( xLEDTimer, &xHigherPriorityTaskWoken );\r
 245 \r
 246         /* Clear the interrupt before leaving. */\r
 247     MSS_GPIO_clear_irq( MSS_GPIO_8 );\r
 248 \r
 249         /* If calling xTimerResetFromISR() caused a task (in this case the timer\r
 250         service/daemon task) to unblock, and the unblocked task has a priority\r
 251         higher than or equal to the task that was interrupted, then\r
 252         xHigherPriorityTaskWoken will now be set to pdTRUE, and calling\r
 253         portEND_SWITCHING_ISR() will ensure the unblocked task runs next. */\r
 254         portEND_SWITCHING_ISR( xHigherPriorityTaskWoken );\r
 255 }\r
 256 /*-----------------------------------------------------------*/\r
 257 \r
 258 static void prvQueueSendTask( void *pvParameters )\r
 259 {\r
 260 portTickType xNextWakeTime;\r
 261 const unsigned long ulValueToSend = 100UL;\r
 262 \r
 263         /* Initialise xNextWakeTime - this only needs to be done once. */\r
 264         xNextWakeTime = xTaskGetTickCount();\r
 265 \r
 266         for( ;; )\r
 267         {\r
 268                 /* Place this task in the blocked state until it is time to run again.\r
 269                 The block time is specified in ticks, the constant used converts ticks\r
 270                 to ms.  While in the Blocked state this task will not consume any CPU\r
 271                 time. */\r
 272                 vTaskDelayUntil( &xNextWakeTime, mainQUEUE_SEND_FREQUENCY_MS );\r
 273 \r
 274                 /* Send to the queue - causing the queue receive task to unblock and\r
 275                 toggle an LED.  0 is used as the block time so the sending operation\r
 276                 will not block - it shouldn't need to block as the queue should always\r
 277                 be empty at this point in the code. */\r
 278                 xQueueSend( xQueue, &ulValueToSend, 0 );\r
 279         }\r
 280 }\r
 281 /*-----------------------------------------------------------*/\r
 282 \r
 283 static void prvQueueReceiveTask( void *pvParameters )\r
 284 {\r
 285 unsigned long ulReceivedValue;\r
 286 \r
 287         for( ;; )\r
 288         {\r
 289                 /* Wait until something arrives in the queue - this task will block\r
 290                 indefinitely provided INCLUDE_vTaskSuspend is set to 1 in\r
 291                 FreeRTOSConfig.h. */\r
 292                 xQueueReceive( xQueue, &ulReceivedValue, portMAX_DELAY );\r
 293 \r
 294                 /*  To get here something must have been received from the queue, but\r
 295                 is it the expected value?  If it is, toggle the green LED. */\r
 296                 if( ulReceivedValue == 100UL )\r
 297                 {\r
 298                         /* NOTE - accessing the LED port should use a critical section\r
 299                         because it is accessed from multiple tasks, and the button interrupt\r
 300                         - in this trivial case, for simplicity, the critical section is\r
 301                         omitted. */\r
 302                         if( ( ulGPIOState & mainTASK_CONTROLLED_LED ) != 0 )\r
 303                         {\r
 304                                 ulGPIOState &= ~mainTASK_CONTROLLED_LED;\r
 305                         }\r
 306                         else\r
 307                         {\r
 308                                 ulGPIOState |= mainTASK_CONTROLLED_LED;\r
 309                         }\r
 310                         MSS_GPIO_set_outputs( ulGPIOState );\r
 311                 }\r
 312         }\r
 313 }\r
 314 /*-----------------------------------------------------------*/\r
 315 \r
 316 static void prvSetupHardware( void )\r
 317 {\r
 318         SystemCoreClockUpdate();\r
 319 \r
 320         /* Disable the Watch Dog Timer */\r
 321         MSS_WD_disable( );\r
 322 \r
 323         /* Initialise the GPIO */\r
 324         MSS_GPIO_init();\r
 325 \r
 326         /* Set up GPIO for the LEDs. */\r
 327     MSS_GPIO_config( MSS_GPIO_0 , MSS_GPIO_OUTPUT_MODE );\r
 328     MSS_GPIO_config( MSS_GPIO_1 , MSS_GPIO_OUTPUT_MODE );\r
 329     MSS_GPIO_config( MSS_GPIO_2 , MSS_GPIO_OUTPUT_MODE );\r
 330     MSS_GPIO_config( MSS_GPIO_3 , MSS_GPIO_OUTPUT_MODE );\r
 331     MSS_GPIO_config( MSS_GPIO_4 , MSS_GPIO_OUTPUT_MODE );\r
 332     MSS_GPIO_config( MSS_GPIO_5 , MSS_GPIO_OUTPUT_MODE );\r
 333     MSS_GPIO_config( MSS_GPIO_6 , MSS_GPIO_OUTPUT_MODE );\r
 334     MSS_GPIO_config( MSS_GPIO_7 , MSS_GPIO_OUTPUT_MODE );\r
 335 \r
 336     /* All LEDs start off. */\r
 337     ulGPIOState = 0xffffffffUL;\r
 338     MSS_GPIO_set_outputs( ulGPIOState );\r
 339 \r
 340         /* Setup the GPIO and the NVIC for the switch used in this simple demo. */\r
 341         NVIC_SetPriority( GPIO8_IRQn, configLIBRARY_MAX_SYSCALL_INTERRUPT_PRIORITY );\r
 342     NVIC_EnableIRQ( GPIO8_IRQn );\r
 343     MSS_GPIO_config( MSS_GPIO_8, MSS_GPIO_INPUT_MODE | MSS_GPIO_IRQ_EDGE_NEGATIVE );\r
 344     MSS_GPIO_enable_irq( MSS_GPIO_8 );\r
 345 }\r
 346 /*-----------------------------------------------------------*/\r
 347 \r
 348 void vApplicationMallocFailedHook( void )\r
 349 {\r
 350         /* Called if a call to pvPortMalloc() fails because there is insufficient\r
 351         free memory available in the FreeRTOS heap.  pvPortMalloc() is called\r
 352         internally by FreeRTOS API functions that create tasks, queues, software\r
 353         timers, and semaphores.  The size of the FreeRTOS heap is set by the\r
 354         configTOTAL_HEAP_SIZE configuration constant in FreeRTOSConfig.h. */\r
 355         for( ;; );\r
 356 }\r
 357 /*-----------------------------------------------------------*/\r
 358 \r
 359 void vApplicationStackOverflowHook( xTaskHandle pxTask, signed char *pcTaskName )\r
 360 {\r
 361         ( void ) pcTaskName;\r
 362         ( void ) pxTask;\r
 363 \r
 364         /* Run time stack overflow checking is performed if\r
 365         configconfigCHECK_FOR_STACK_OVERFLOW is defined to 1 or 2.  This hook\r
 366         function is called if a stack overflow is detected. */\r
 367         for( ;; );\r
 368 }\r
 369 /*-----------------------------------------------------------*/\r
 370 \r
 371 void vApplicationIdleHook( void )\r
 372 {\r
 373 volatile size_t xFreeHeapSpace;\r
 374 \r
 375         /* This function is called on each cycle of the idle task.  In this case it\r
 376         does nothing useful, other than report the amout of FreeRTOS heap that\r
 377         remains unallocated. */\r
 378         xFreeHeapSpace = xPortGetFreeHeapSize();\r
 379 \r
 380         if( xFreeHeapSpace > 100 )\r
 381         {\r
 382                 /* By now, the kernel has allocated everything it is going to, so\r
 383                 if there is a lot of heap remaining unallocated then\r
 384                 the value of configTOTAL_HEAP_SIZE in FreeRTOSConfig.h can be\r
 385                 reduced accordingly. */\r
 386         }\r
 387 }\r
 388 /*-----------------------------------------------------------*/\r
 389 \r
 390 void vMainConfigureTimerForRunTimeStats( void )\r
 391 {\r
 392         /* This function is not used by the Blinky build configuration, but needs\r
 393         to be defined as the Blinky and Full build configurations share a\r
 394         FreeRTOSConfig.h header file. */\r
 395 }\r
 396 /*-----------------------------------------------------------*/\r
 397 \r
 398 unsigned long ulGetRunTimeCounterValue( void )\r
 399 {\r
 400         /* This function is not used by the Blinky build configuration, but needs\r
 401         to be defined as the Blinky and Full build configurations share a\r
 402         FreeRTOSConfig.h header file. */\r
 403         return 0UL;\r
 404 }\r
 405 \r