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

   1 /*\r
   2     FreeRTOS V6.1.1 - Copyright (C) 2011 Real Time Engineers Ltd.\r
   3 \r
   4     ***************************************************************************\r
   5     *                                                                         *\r
   6     * If you are:                                                             *\r
   7     *                                                                         *\r
   8     *    + New to FreeRTOS,                                                   *\r
   9     *    + Wanting to learn FreeRTOS or multitasking in general quickly       *\r
  10     *    + Looking for basic training,                                        *\r
  11     *    + Wanting to improve your FreeRTOS skills and productivity           *\r
  12     *                                                                         *\r
  13     * then take a look at the FreeRTOS books - available as PDF or paperback  *\r
  14     *                                                                         *\r
  15     *        "Using the FreeRTOS Real Time Kernel - a Practical Guide"        *\r
  16     *                  http://www.FreeRTOS.org/Documentation                  *\r
  17     *                                                                         *\r
  18     * A pdf reference manual is also available.  Both are usually delivered   *\r
  19     * to your inbox within 20 minutes to two hours when purchased between 8am *\r
  20     * and 8pm GMT (although please allow up to 24 hours in case of            *\r
  21     * exceptional circumstances).  Thank you for your support!                *\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 exception to the GPL is included to allow you to distribute\r
  31     a combined work that includes FreeRTOS without being obliged to provide the\r
  32     source code for proprietary components outside of the FreeRTOS kernel.\r
  33     FreeRTOS is distributed in the hope that it will be useful, but WITHOUT\r
  34     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\r
  35     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     http://www.FreeRTOS.org - Documentation, latest information, license and\r
  45     contact details.\r
  46 \r
  47     http://www.SafeRTOS.com - A version that is certified for use in safety\r
  48     critical systems.\r
  49 \r
  50     http://www.OpenRTOS.com - Commercial support, development, porting,\r
  51     licensing and training services.\r
  52 */\r
  53 \r
  54 /*\r
  55 This simple demo project runs on the STM32 Discovery board, which is\r
  56 populated with an STM32F100RB Cortex-M3 microcontroller.  The discovery board \r
  57 makes an ideal low cost evaluation platform, but the 8K of RAM provided on the\r
  58 STM32F100RB does not allow the simple application to demonstrate all of all the \r
  59 FreeRTOS kernel features.  Therefore, this simple demo only actively \r
  60 demonstrates task, queue, timer and interrupt functionality.  In addition, the \r
  61 demo is configured to include malloc failure, idle and stack overflow hook \r
  62 functions.\r
  63 \r
  64 The idle hook function:\r
  65 The idle hook function queries the amount of FreeRTOS heap space that is\r
  66 remaining (see vApplicationIdleHook() defined in this file).  The demo \r
  67 application is configured use 7K or the available 8K of RAM as the FreeRTOS heap.\r
  68 Memory is only allocated from this heap during initialisation, and this demo \r
  69 only actually uses 1.6K bytes of the configured 7K available - leaving 5.4K \r
  70 bytes of heap space unallocated.\r
  71 \r
  72 The main() Function:\r
  73 main() creates one software timer, one queue, and two tasks.  It then starts the\r
  74 scheduler.\r
  75 \r
  76 The Queue Send Task:\r
  77 The queue send task is implemented by the prvQueueSendTask() function in this \r
  78 file.  prvQueueSendTask() sits in a loop that causes it to repeatedly block for \r
  79 200 milliseconds, before sending the value 100 to the queue that was created \r
  80 within main().  Once the value is sent, the task loops back around to block for\r
  81 another 200 milliseconds.\r
  82 \r
  83 The Queue Receive Task:\r
  84 The queue receive task is implemented by the prvQueueReceiveTask() function\r
  85 in this file.  prvQueueReceiveTask() sits in a loop that causes repeatedly \r
  86 attempt to read data from the queue that was created within main().  When data \r
  87 is received, the task checks the value of the data, and if the value equals \r
  88 the expected 100, toggles the green LED.  The 'block time' parameter passed to \r
  89 the queue receive function specifies that the task should be held in the Blocked \r
  90 state indefinitely to wait for data to be available on the queue.  The queue \r
  91 receive task will only leave the Blocked state when the queue send task writes \r
  92 to the queue.  As the queue send task writes to the queue every 200 \r
  93 milliseconds, the queue receive task leaves the Blocked state every 200 \r
  94 milliseconds, and therefore toggles the green LED every 200 milliseconds.\r
  95 \r
  96 The LED Software Timer and the Button Interrupt:\r
  97 The user button B1 is configured to generate an interrupt each time it is\r
  98 pressed.  The interrupt service routine switches the red LED on, and resets the \r
  99 LED software timer.  The LED timer has a 5000 millisecond (5 second) period, and\r
 100 uses a callback function that is defined to just turn the red LED off.  \r
 101 Therefore, pressing the user button will turn the red LED on, and the LED will \r
 102 remain on until a full five seconds pass without the button being pressed.\r
 103 */\r
 104 \r
 105 /* Kernel includes. */\r
 106 #include "FreeRTOS.h"\r
 107 #include "task.h"\r
 108 #include "queue.h"\r
 109 #include "timers.h"\r
 110 \r
 111 /* Microsemi drivers/libraries includes. */\r
 112 #include "mss_gpio.h"\r
 113 #include "mss_watchdog.h"\r
 114 \r
 115 /* Common demo includes. */\r
 116 #include "partest.h"\r
 117 \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 number of items the queue can hold.  This is 1 as the receive task\r
 128 will remove items as they are added, meaning the send task should always find\r
 129 the queue empty. */\r
 130 #define mainQUEUE_LENGTH                                        ( 1 )\r
 131 \r
 132 #define mainTASK_CONTROLLED_LED                         0x01UL\r
 133 #define mainTIMER_CONTROLLED_LED                        0x02UL\r
 134 /*-----------------------------------------------------------*/\r
 135 \r
 136 /*\r
 137  * Setup the NVIC, LED outputs, and button inputs.\r
 138  */\r
 139 static void prvSetupHardware( void );\r
 140 \r
 141 /*\r
 142  * The tasks as described in the comments at the top of this file.\r
 143  */\r
 144 static void prvQueueReceiveTask( void *pvParameters );\r
 145 static void prvQueueSendTask( void *pvParameters );\r
 146 \r
 147 /*\r
 148  * The LED timer callback function.  This does nothing but switch the red LED \r
 149  * off.\r
 150  */\r
 151 static void vLEDTimerCallback( xTimerHandle xTimer );\r
 152 \r
 153 /*-----------------------------------------------------------*/\r
 154 \r
 155 /* The queue used by both tasks. */\r
 156 static xQueueHandle xQueue = NULL;\r
 157 \r
 158 /* The LED software timer.  This uses vLEDTimerCallback() as its callback\r
 159 function. */\r
 160 static xTimerHandle xLEDTimer = NULL;\r
 161 \r
 162 \r
 163 \r
 164 /*-----------------------------------------------------------*/\r
 165 \r
 166 int main(void)\r
 167 {\r
 168         /* Configure the NVIC, LED outputs and button inputs. */\r
 169         prvSetupHardware();\r
 170 \r
 171         /* Create the queue. */\r
 172         xQueue = xQueueCreate( mainQUEUE_LENGTH, sizeof( unsigned long ) );\r
 173 \r
 174         if( xQueue != NULL )\r
 175         {\r
 176                 /* Start the two tasks as described in the comments at the top of this\r
 177                 file. */\r
 178                 xTaskCreate( prvQueueReceiveTask, ( signed char * ) "Rx", configMINIMAL_STACK_SIZE, NULL, mainQUEUE_RECEIVE_TASK_PRIORITY, NULL );\r
 179                 xTaskCreate( prvQueueSendTask, ( signed char * ) "TX", configMINIMAL_STACK_SIZE, NULL, mainQUEUE_SEND_TASK_PRIORITY, NULL );\r
 180 \r
 181                 /* Create the software timer that is responsible for turning off the LED \r
 182                 if the button is not pushed within 5000ms, as described at the top of \r
 183                 this file. */\r
 184                 xLEDTimer = xTimerCreate(       ( const signed char * ) "LEDTimer", /* A text name, purely to help debugging. */\r
 185                                                                         ( 5000 / portTICK_RATE_MS ),            /* The timer period, in this case 5000ms (5s). */\r
 186                                                                         pdFALSE,                                                        /* This is a one shot timer, so xAutoReload is set to pdFALSE. */\r
 187                                                                         ( void * ) 0,                                           /* The ID is not used, so can be set to anything. */\r
 188                                                                         vLEDTimerCallback                                       /* The callback function that switches the LED off. */\r
 189                                                                 );\r
 190 \r
 191                 /* Start the tasks and timer running. */\r
 192                 vTaskStartScheduler();\r
 193         }\r
 194 \r
 195         /* If all is well, the scheduler will now be running, and the following line\r
 196         will never be reached.  If the following line does execute, then there was\r
 197         insufficient FreeRTOS heap memory available for the idle and/or timer tasks\r
 198         to be created.  See the memory management section on the FreeRTOS web site\r
 199         for more details. */\r
 200         for( ;; );\r
 201 }\r
 202 /*-----------------------------------------------------------*/\r
 203 \r
 204 static void vLEDTimerCallback( xTimerHandle xTimer )\r
 205 {\r
 206         /* The timer has expired - so no button pushes have occurred in the last\r
 207         five seconds - turn the LED off.  NOTE - accessing the LED port should use\r
 208         a critical section because it is accessed from multiple tasks, and the\r
 209         button interrupt - in this trivial case, for simplicity, the critical\r
 210         section is omitted. */\r
 211         ulGPIOState |= mainTIMER_CONTROLLED_LED;\r
 212         MSS_GPIO_set_outputs( ulGPIOState );\r
 213 }\r
 214 /*-----------------------------------------------------------*/\r
 215 \r
 216 /* The ISR executed when the user button is pushed. */\r
 217 void GPIO8_IRQHandler( void )\r
 218 {\r
 219 portBASE_TYPE xHigherPriorityTaskWoken = pdFALSE;\r
 220 \r
 221         /* The button was pushed, so ensure the LED is on before resetting the\r
 222         LED timer.  The LED timer will turn the LED off if the button is not\r
 223         pushed within 5000ms. */\r
 224         ulGPIOState &= ~mainTIMER_CONTROLLED_LED;\r
 225         MSS_GPIO_set_outputs( ulGPIOState );\r
 226 \r
 227         /* This interrupt safe FreeRTOS function can be called from this interrupt\r
 228         because the interrupt priority is below the\r
 229         configMAX_SYSCALL_INTERRUPT_PRIORITY setting in FreeRTOSConfig.h. */\r
 230         xTimerResetFromISR( xLEDTimer, &xHigherPriorityTaskWoken );\r
 231 \r
 232         /* Clear the interrupt before leaving. */\r
 233     MSS_GPIO_clear_irq( MSS_GPIO_8 );\r
 234 \r
 235         /* If calling xTimerResetFromISR() caused a task (in this case the timer\r
 236         service/daemon task) to unblock, and the unblocked task has a priority\r
 237         higher than or equal to the task that was interrupted, then\r
 238         xHigherPriorityTaskWoken will now be set to pdTRUE, and calling\r
 239         portEND_SWITCHING_ISR() will ensure the unblocked task runs next. */\r
 240         portEND_SWITCHING_ISR( xHigherPriorityTaskWoken );\r
 241 }\r
 242 /*-----------------------------------------------------------*/\r
 243 \r
 244 static void prvQueueSendTask( void *pvParameters )\r
 245 {\r
 246 portTickType xNextWakeTime;\r
 247 const unsigned long ulValueToSend = 100UL;\r
 248 \r
 249         /* Initialise xNextWakeTime - this only needs to be done once. */\r
 250         xNextWakeTime = xTaskGetTickCount();\r
 251 \r
 252         for( ;; )\r
 253         {\r
 254                 /* Place this task in the blocked state until it is time to run again.\r
 255                 The block time is specified in ticks, the constant used converts ticks\r
 256                 to ms.  While in the Blocked state this task will not consume any CPU\r
 257                 time. */\r
 258                 vTaskDelayUntil( &xNextWakeTime, mainQUEUE_SEND_FREQUENCY_MS );\r
 259 \r
 260                 /* Send to the queue - causing the queue receive task to unblock and\r
 261                 toggle an LED.  0 is used as the block time so the sending operation\r
 262                 will not block - it shouldn't need to block as the queue should always\r
 263                 be empty at this point in the code. */\r
 264                 xQueueSend( xQueue, &ulValueToSend, 0 );\r
 265         }\r
 266 }\r
 267 /*-----------------------------------------------------------*/\r
 268 \r
 269 static void prvQueueReceiveTask( void *pvParameters )\r
 270 {\r
 271 unsigned long ulReceivedValue;\r
 272 \r
 273         for( ;; )\r
 274         {\r
 275                 /* Wait until something arrives in the queue - this task will block\r
 276                 indefinitely provided INCLUDE_vTaskSuspend is set to 1 in\r
 277                 FreeRTOSConfig.h. */\r
 278                 xQueueReceive( xQueue, &ulReceivedValue, portMAX_DELAY );\r
 279 \r
 280                 /*  To get here something must have been received from the queue, but\r
 281                 is it the expected value?  If it is, toggle the green LED. */\r
 282                 if( ulReceivedValue == 100UL )\r
 283                 {\r
 284                         /* NOTE - accessing the LED port should use a critical section\r
 285                         because it is accessed from multiple tasks, and the button interrupt \r
 286                         - in this trivial case, for simplicity, the critical section is \r
 287                         omitted. */\r
 288                         if( ( ulGPIOState & mainTASK_CONTROLLED_LED ) != 0 )\r
 289                         {\r
 290                                 ulGPIOState &= ~mainTASK_CONTROLLED_LED;\r
 291                         }\r
 292                         else\r
 293                         {\r
 294                                 ulGPIOState |= mainTASK_CONTROLLED_LED;\r
 295                         }\r
 296                         MSS_GPIO_set_outputs( ulGPIOState );\r
 297                 }\r
 298         }\r
 299 }\r
 300 /*-----------------------------------------------------------*/\r
 301 \r
 302 static void prvSetupHardware( void )\r
 303 {\r
 304         /* Disable the Watch Dog Timer */\r
 305         MSS_WD_disable( );\r
 306 \r
 307         /* Configure the GPIO for the LEDs. */\r
 308         vParTestInitialise();\r
 309 \r
 310         /* Setup the GPIO and the NVIC for the switch used in this simple demo. */\r
 311     NVIC_EnableIRQ( GPIO8_IRQn );\r
 312     MSS_GPIO_config( MSS_GPIO_8, MSS_GPIO_INPUT_MODE | MSS_GPIO_IRQ_EDGE_NEGATIVE );\r
 313     MSS_GPIO_enable_irq( MSS_GPIO_8 );\r
 314 }\r
 315 /*-----------------------------------------------------------*/\r
 316 \r
 317 void vApplicationMallocFailedHook( void )\r
 318 {\r
 319         /* Called if a call to pvPortMalloc() fails because there is insufficient\r
 320         free memory available in the FreeRTOS heap.  pvPortMalloc() is called\r
 321         internally by FreeRTOS API functions that create tasks, queues, software \r
 322         timers, and semaphores.  The size of the FreeRTOS heap is set by the\r
 323         configTOTAL_HEAP_SIZE configuration constant in FreeRTOSConfig.h. */\r
 324         for( ;; );\r
 325 }\r
 326 /*-----------------------------------------------------------*/\r
 327 \r
 328 void vApplicationStackOverflowHook( xTaskHandle *pxTask, signed char *pcTaskName )\r
 329 {\r
 330         ( void ) pcTaskName;\r
 331         ( void ) pxTask;\r
 332 \r
 333         /* Run time stack overflow checking is performed if\r
 334         configconfigCHECK_FOR_STACK_OVERFLOW is defined to 1 or 2.  This hook\r
 335         function is called if a stack overflow is detected. */\r
 336         for( ;; );\r
 337 }\r
 338 /*-----------------------------------------------------------*/\r
 339 \r
 340 void vApplicationIdleHook( void )\r
 341 {\r
 342 volatile size_t xFreeStackSpace;\r
 343 \r
 344         /* This function is called on each cycle of the idle task.  In this case it\r
 345         does nothing useful, other than report the amout of FreeRTOS heap that \r
 346         remains unallocated. */\r
 347         xFreeStackSpace = xPortGetFreeHeapSize();\r
 348 \r
 349         if( xFreeStackSpace > 100 )\r
 350         {\r
 351                 /* By now, the kernel has allocated everything it is going to, so\r
 352                 if there is a lot of heap remaining unallocated then\r
 353                 the value of configTOTAL_HEAP_SIZE in FreeRTOSConfig.h can be\r
 354                 reduced accordingly. */\r
 355         }\r
 356 }\r