git.sur5r.net Git - freertos/blob - Demo/CORTEX_STM32F100_Atollic/Simple_Demo_Source/main.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 \r
 106 /* Kernel includes. */\r
 107 #include "FreeRTOS.h"\r
 108 #include "task.h"\r
 109 #include "queue.h"\r
 110 #include "timers.h"\r
 111 \r
 112 /* STM32 Library includes. */\r
 113 #include "stm32f10x.h"\r
 114 #include "STM32vldiscovery.h"\r
 115 \r
 116 /* Priorities at which the tasks are created. */\r
 117 #define mainQUEUE_RECEIVE_TASK_PRIORITY         ( tskIDLE_PRIORITY + 2 )\r
 118 #define mainQUEUE_SEND_TASK_PRIORITY            ( tskIDLE_PRIORITY + 1 )\r
 119 \r
 120 /* The rate at which data is sent to the queue, specified in milliseconds, and\r
 121 converted to ticks using the portTICK_RATE_MS constant. */\r
 122 #define mainQUEUE_SEND_FREQUENCY_MS                     ( 200 / portTICK_RATE_MS )\r
 123 \r
 124 /* The number of items the queue can hold.  This is 1 as the receive task\r
 125 will remove items as they are added, meaning the send task should always find\r
 126 the queue empty. */\r
 127 #define mainQUEUE_LENGTH                                        ( 1 )\r
 128 \r
 129 /*-----------------------------------------------------------*/\r
 130 \r
 131 /*\r
 132  * Setup the NVIC, LED outputs, and button inputs.\r
 133  */\r
 134 static void prvSetupHardware( void );\r
 135 \r
 136 /*\r
 137  * The tasks as described in the comments at the top of this file.\r
 138  */\r
 139 static void prvQueueReceiveTask( void *pvParameters );\r
 140 static void prvQueueSendTask( void *pvParameters );\r
 141 \r
 142 /*\r
 143  * The LED timer callback function.  This does nothing but switch the red LED \r
 144  * off.\r
 145  */\r
 146 static void vLEDTimerCallback( xTimerHandle xTimer );\r
 147 \r
 148 /*-----------------------------------------------------------*/\r
 149 \r
 150 /* The queue used by both tasks. */\r
 151 static xQueueHandle xQueue = NULL;\r
 152 \r
 153 /* The LED software timer.  This uses vLEDTimerCallback() as its callback\r
 154  * function. \r
 155  */\r
 156 static xTimerHandle xLEDTimer = NULL;\r
 157 \r
 158 /*-----------------------------------------------------------*/\r
 159 \r
 160 int main(void)\r
 161 {\r
 162         /* Configure the NVIC, LED outputs and button inputs. */\r
 163         prvSetupHardware();\r
 164 \r
 165         /* Create the queue. */\r
 166         xQueue = xQueueCreate( mainQUEUE_LENGTH, sizeof( unsigned long ) );\r
 167 \r
 168         if( xQueue != NULL )\r
 169         {\r
 170                 /* Start the two tasks as described in the comments at the top of this\r
 171                 file. */\r
 172                 xTaskCreate( prvQueueReceiveTask, ( signed char * ) "Rx", configMINIMAL_STACK_SIZE, NULL, mainQUEUE_RECEIVE_TASK_PRIORITY, NULL );\r
 173                 xTaskCreate( prvQueueSendTask, ( signed char * ) "TX", configMINIMAL_STACK_SIZE, NULL, mainQUEUE_SEND_TASK_PRIORITY, NULL );\r
 174 \r
 175                 /* Create the software timer that is responsible for turning off the LED \r
 176                 if the button is not pushed within 5000ms, as described at the top of \r
 177                 this file. */\r
 178                 xLEDTimer = xTimerCreate(       ( const signed char * ) "LEDTimer", /* A text name, purely to help debugging. */\r
 179                                                                         ( 5000 / portTICK_RATE_MS ),            /* The timer period, in this case 5000ms (5s). */\r
 180                                                                         pdFALSE,                                                        /* This is a one shot timer, so xAutoReload is set to pdFALSE. */\r
 181                                                                         ( void * ) 0,                                           /* The ID is not used, so can be set to anything. */\r
 182                                                                         vLEDTimerCallback                                       /* The callback function that switches the LED off. */\r
 183                                                                 );\r
 184 \r
 185                 /* Start the tasks and timer running. */\r
 186                 vTaskStartScheduler();\r
 187         }\r
 188 \r
 189         /* If all is well, the scheduler will now be running, and the following line\r
 190         will never be reached.  If the following line does execute, then there was\r
 191         insufficient FreeRTOS heap memory available for the idle and/or timer tasks\r
 192         to be created.  See the memory management section on the FreeRTOS web site\r
 193         for more details. */\r
 194         for( ;; );\r
 195 }\r
 196 /*-----------------------------------------------------------*/\r
 197 \r
 198 static void vLEDTimerCallback( xTimerHandle xTimer )\r
 199 {\r
 200         /* The timer has expired - so no button pushes have occurred in the last\r
 201         five seconds - turn the LED off.  NOTE - accessing the LED port should use\r
 202         a critical section because it is accessed from multiple tasks, and the\r
 203         button interrupt - in this trivial case, for simplicity, the critical\r
 204         section is omitted. */\r
 205         STM32vldiscovery_LEDOff( LED4 );\r
 206 }\r
 207 /*-----------------------------------------------------------*/\r
 208 \r
 209 /* The ISR executed when the user button is pushed. */\r
 210 void EXTI0_IRQHandler( void )\r
 211 {\r
 212 portBASE_TYPE xHigherPriorityTaskWoken = pdFALSE;\r
 213 \r
 214         /* The button was pushed, so ensure the LED is on before resetting the\r
 215         LED timer.  The LED timer will turn the LED off if the button is not\r
 216         pushed within 5000ms. */\r
 217         STM32vldiscovery_LEDOn( LED4 );\r
 218 \r
 219         /* This interrupt safe FreeRTOS function can be called from this interrupt\r
 220         because the interrupt priority is below the\r
 221         configMAX_SYSCALL_INTERRUPT_PRIORITY setting in FreeRTOSConfig.h. */\r
 222         xTimerResetFromISR( xLEDTimer, &xHigherPriorityTaskWoken );\r
 223 \r
 224         /* Clear the interrupt before leaving. */\r
 225         EXTI_ClearITPendingBit( EXTI_Line0 );\r
 226 \r
 227         /* If calling xTimerResetFromISR() caused a task (in this case the timer\r
 228         service/daemon task) to unblock, and the unblocked task has a priority\r
 229         higher than or equal to the task that was interrupted, then\r
 230         xHigherPriorityTaskWoken will now be set to pdTRUE, and calling\r
 231         portEND_SWITCHING_ISR() will ensure the unblocked task runs next. */\r
 232         portEND_SWITCHING_ISR( xHigherPriorityTaskWoken );\r
 233 }\r
 234 /*-----------------------------------------------------------*/\r
 235 \r
 236 static void prvQueueSendTask( void *pvParameters )\r
 237 {\r
 238 portTickType xNextWakeTime;\r
 239 const unsigned long ulValueToSend = 100UL;\r
 240 \r
 241         /* Initialise xNextWakeTime - this only needs to be done once. */\r
 242         xNextWakeTime = xTaskGetTickCount();\r
 243 \r
 244         for( ;; )\r
 245         {\r
 246                 /* Place this task in the blocked state until it is time to run again.\r
 247                 The block time is specified in ticks, the constant used converts ticks\r
 248                 to ms.  While in the Blocked state this task will not consume any CPU\r
 249                 time. */\r
 250                 vTaskDelayUntil( &xNextWakeTime, mainQUEUE_SEND_FREQUENCY_MS );\r
 251 \r
 252                 /* Send to the queue - causing the queue receive task to unblock and\r
 253                 toggle an LED.  0 is used as the block time so the sending operation\r
 254                 will not block - it shouldn't need to block as the queue should always\r
 255                 be empty at this point in the code. */\r
 256                 xQueueSend( xQueue, &ulValueToSend, 0 );\r
 257         }\r
 258 }\r
 259 /*-----------------------------------------------------------*/\r
 260 \r
 261 static void prvQueueReceiveTask( void *pvParameters )\r
 262 {\r
 263 unsigned long ulReceivedValue;\r
 264 \r
 265         for( ;; )\r
 266         {\r
 267                 /* Wait until something arrives in the queue - this task will block\r
 268                 indefinitely provided INCLUDE_vTaskSuspend is set to 1 in\r
 269                 FreeRTOSConfig.h. */\r
 270                 xQueueReceive( xQueue, &ulReceivedValue, portMAX_DELAY );\r
 271 \r
 272                 /*  To get here something must have been received from the queue, but\r
 273                 is it the expected value?  If it is, toggle the green LED. */\r
 274                 if( ulReceivedValue == 100UL )\r
 275                 {\r
 276                         /* NOTE - accessing the LED port should use a critical section\r
 277                         because it is accessed from multiple tasks, and the button interrupt \r
 278                         - in this trivial case, for simplicity, the critical section is \r
 279                         omitted. */\r
 280                         STM32vldiscovery_LEDToggle( LED3 );\r
 281                 }\r
 282         }\r
 283 }\r
 284 /*-----------------------------------------------------------*/\r
 285 \r
 286 static void prvSetupHardware( void )\r
 287 {\r
 288         /* Ensure that all 4 interrupt priority bits are used as the pre-emption\r
 289         priority. */\r
 290         NVIC_PriorityGroupConfig( NVIC_PriorityGroup_4 );\r
 291 \r
 292         /* Set up the LED outputs and the button inputs. */\r
 293         STM32vldiscovery_LEDInit( LED3 );\r
 294         STM32vldiscovery_LEDInit( LED4 );\r
 295         STM32vldiscovery_PBInit( BUTTON_USER, BUTTON_MODE_EXTI );\r
 296         \r
 297         /* Start with the LEDs off. */\r
 298         STM32vldiscovery_LEDOff( LED3 );\r
 299         STM32vldiscovery_LEDOff( LED4 );\r
 300 }\r
 301 /*-----------------------------------------------------------*/\r
 302 \r
 303 void vApplicationMallocFailedHook( void )\r
 304 {\r
 305         /* Called if a call to pvPortMalloc() fails because there is insufficient\r
 306         free memory available in the FreeRTOS heap.  pvPortMalloc() is called\r
 307         internally by FreeRTOS API functions that create tasks, queues, software \r
 308         timers, and semaphores.  The size of the FreeRTOS heap is set by the\r
 309         configTOTAL_HEAP_SIZE configuration constant in FreeRTOSConfig.h. */\r
 310         for( ;; );\r
 311 }\r
 312 /*-----------------------------------------------------------*/\r
 313 \r
 314 void vApplicationStackOverflowHook( xTaskHandle *pxTask, signed char *pcTaskName )\r
 315 {\r
 316         ( void ) pcTaskName;\r
 317         ( void ) pxTask;\r
 318 \r
 319         /* Run time stack overflow checking is performed if\r
 320         configconfigCHECK_FOR_STACK_OVERFLOW is defined to 1 or 2.  This hook\r
 321         function is called if a stack overflow is detected. */\r
 322         for( ;; );\r
 323 }\r
 324 /*-----------------------------------------------------------*/\r
 325 \r
 326 void vApplicationIdleHook( void )\r
 327 {\r
 328 volatile size_t xFreeStackSpace;\r
 329 \r
 330         /* This function is called on each cycle of the idle task.  In this case it\r
 331         does nothing useful, other than report the amout of FreeRTOS heap that \r
 332         remains unallocated. */\r
 333         xFreeStackSpace = xPortGetFreeHeapSize();\r
 334 \r
 335         if( xFreeStackSpace > 100 )\r
 336         {\r
 337                 /* By now, the kernel has allocated everything it is going to, so\r
 338                 if there is a lot of heap remaining unallocated then\r
 339                 the value of configTOTAL_HEAP_SIZE in FreeRTOSConfig.h can be\r
 340                 reduced accordingly. */\r
 341         }\r
 342 }\r