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

   1 /*\r
   2     FreeRTOS V8.2.0 - 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  * NOTE 1: The Win32 port is a simulation (or is that emulation?) only!  Do not\r
  72  * expect to get real time behaviour from the Win32 port or this demo\r
  73  * application.  It is provided as a convenient development and demonstration\r
  74  * test bed only.  This was tested using Windows XP on a dual core laptop.\r
  75  *\r
  76  * Windows will not be running the FreeRTOS simulator threads continuously, so\r
  77  * the timing information in the FreeRTOS+Trace logs have no meaningful units.\r
  78  * See the documentation page for the Windows simulator for an explanation of\r
  79  * the slow timing:\r
  80  * http://www.freertos.org/FreeRTOS-Windows-Simulator-Emulator-for-Visual-Studio-and-Eclipse-MingW.html\r
  81  * - READ THE WEB DOCUMENTATION FOR THIS PORT FOR MORE INFORMATION ON USING IT -\r
  82  *\r
  83  * NOTE 2:  This project provides two demo applications.  A simple blinky style\r
  84  * project, and a more comprehensive test and demo application.  The\r
  85  * mainCREATE_SIMPLE_BLINKY_DEMO_ONLY setting in main.c is used to select\r
  86  * between the two.  See the notes on using mainCREATE_SIMPLE_BLINKY_DEMO_ONLY\r
  87  * in main.c.  This file implements the simply blinky style version.\r
  88  *\r
  89  * NOTE 3:  This file only contains the source code that is specific to the\r
  90  * basic demo.  Generic functions, such FreeRTOS hook functions, are defined\r
  91  * in main.c.\r
  92  ******************************************************************************\r
  93  *\r
  94  * main_blinky() creates one queue, and two tasks.  It then starts the\r
  95  * scheduler.\r
  96  *\r
  97  * The Queue Send Task:\r
  98  * The queue send task is implemented by the prvQueueSendTask() function in\r
  99  * this file.  prvQueueSendTask() sits in a loop that causes it to repeatedly\r
 100  * block for 200 (simulated as far as the scheduler is concerned, but in\r
 101  * reality much longer - see notes above) milliseconds, before sending the\r
 102  * value 100 to the queue that was created within main_blinky().  Once the\r
 103  * value is sent, the task loops back around to block for another 200\r
 104  * (simulated) milliseconds.\r
 105  *\r
 106  * The Queue Receive Task:\r
 107  * The queue receive task is implemented by the prvQueueReceiveTask() function\r
 108  * in this file.  prvQueueReceiveTask() sits in a loop where it repeatedly\r
 109  * blocks on attempts to read data from the queue that was created within\r
 110  * main_blinky().  When data is received, the task checks the value of the\r
 111  * data, and if the value equals the expected 100, outputs a message.  The\r
 112  * 'block time' parameter passed to the queue receive function specifies that\r
 113  * the task should be held in the Blocked state indefinitely to wait for data\r
 114  * to be available on the queue.  The queue receive task will only leave the\r
 115  * Blocked state when the queue send task writes to the queue.  As the queue\r
 116  * send task writes to the queue every 200 (simulated - see notes above)\r
 117  * milliseconds, the queue receive task leaves the Blocked state every 200\r
 118  * milliseconds, and therefore outputs a message every 200 milliseconds.\r
 119  */\r
 120 \r
 121 /* Standard includes. */\r
 122 #include <stdio.h>\r
 123 \r
 124 /* Kernel includes. */\r
 125 #include "FreeRTOS.h"\r
 126 #include "task.h"\r
 127 #include "semphr.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.  The 200ms value is converted\r
 134 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 /* Values passed to the two tasks just to check the task parameter\r
 143 functionality. */\r
 144 #define mainQUEUE_SEND_PARAMETER                        ( 0x1111UL )\r
 145 #define mainQUEUE_RECEIVE_PARAMETER                     ( 0x22UL )\r
 146 \r
 147 /*-----------------------------------------------------------*/\r
 148 \r
 149 /*\r
 150  * The tasks as described in the comments at the top of this file.\r
 151  */\r
 152 static void prvQueueReceiveTask( void *pvParameters );\r
 153 static void prvQueueSendTask( void *pvParameters );\r
 154 \r
 155 /*-----------------------------------------------------------*/\r
 156 \r
 157 /* The queue used by both tasks. */\r
 158 static QueueHandle_t xQueue = NULL;\r
 159 \r
 160 /*-----------------------------------------------------------*/\r
 161 \r
 162 void main_blinky( void )\r
 163 {\r
 164         /* Create the queue. */\r
 165         xQueue = xQueueCreate( mainQUEUE_LENGTH, sizeof( unsigned long ) );\r
 166 \r
 167         if( xQueue != NULL )\r
 168         {\r
 169                 /* Start the two tasks as described in the comments at the top of this\r
 170                 file. */\r
 171                 xTaskCreate( prvQueueReceiveTask,                                       /* The function that implements the task. */\r
 172                                         "Rx",                                                                   /* The text name assigned to the task - for debug only as it is not used by the kernel. */\r
 173                                         configMINIMAL_STACK_SIZE,                               /* The size of the stack to allocate to the task. */\r
 174                                         ( void * ) mainQUEUE_RECEIVE_PARAMETER, /* The parameter passed to the task - just to check the functionality. */\r
 175                                         mainQUEUE_RECEIVE_TASK_PRIORITY,                /* The priority assigned to the task. */\r
 176                                         NULL );                                                                 /* The task handle is not required, so NULL is passed. */\r
 177 \r
 178                 xTaskCreate( prvQueueSendTask, "TX", configMINIMAL_STACK_SIZE, ( void * ) mainQUEUE_SEND_PARAMETER, mainQUEUE_SEND_TASK_PRIORITY, NULL );\r
 179 \r
 180                 /* Start the tasks and timer running. */\r
 181                 vTaskStartScheduler();\r
 182         }\r
 183 \r
 184         /* If all is well, the scheduler will now be running, and the following\r
 185         line will never be reached.  If the following line does execute, then\r
 186         there was insufficient FreeRTOS heap memory available for the idle and/or\r
 187         timer tasks     to be created.  See the memory management section on the\r
 188         FreeRTOS web site for more details. */\r
 189         for( ;; );\r
 190 }\r
 191 /*-----------------------------------------------------------*/\r
 192 \r
 193 static void prvQueueSendTask( void *pvParameters )\r
 194 {\r
 195 TickType_t xNextWakeTime;\r
 196 const unsigned long ulValueToSend = 100UL;\r
 197 const TickType_t xBlockTime = pdMS_TO_TICKS( mainQUEUE_SEND_FREQUENCY_MS );\r
 198 \r
 199         /* Remove compiler warning in the case that configASSERT() is not\r
 200         defined. */\r
 201         ( void ) pvParameters;\r
 202 \r
 203         /* Check the task parameter is as expected. */\r
 204         configASSERT( ( ( unsigned long ) pvParameters ) == mainQUEUE_SEND_PARAMETER );\r
 205 \r
 206         /* Initialise xNextWakeTime - this only needs to be done once. */\r
 207         xNextWakeTime = xTaskGetTickCount();\r
 208 \r
 209         for( ;; )\r
 210         {\r
 211                 /* Place this task in the blocked state until it is time to run again.\r
 212                 The block time is specified in ticks, the constant used converts ticks\r
 213                 to ms.  While in the Blocked state this task will not consume any CPU\r
 214                 time. */\r
 215                 vTaskDelayUntil( &xNextWakeTime, xBlockTime );\r
 216 \r
 217                 /* Send to the queue - causing the queue receive task to unblock and\r
 218                 toggle the LED.  0 is used as the block time so the sending operation\r
 219                 will not block - it shouldn't need to block as the queue should always\r
 220                 be empty at this point in the code. */\r
 221                 xQueueSend( xQueue, &ulValueToSend, 0U );\r
 222         }\r
 223 }\r
 224 /*-----------------------------------------------------------*/\r
 225 \r
 226 static void prvQueueReceiveTask( void *pvParameters )\r
 227 {\r
 228 unsigned long ulReceivedValue;\r
 229 \r
 230         /* Remove compiler warning in the case that configASSERT() is not\r
 231         defined. */\r
 232         ( void ) pvParameters;\r
 233 \r
 234         /* Check the task parameter is as expected. */\r
 235         configASSERT( ( ( unsigned long ) pvParameters ) == mainQUEUE_RECEIVE_PARAMETER );\r
 236 \r
 237         for( ;; )\r
 238         {\r
 239                 /* Wait until something arrives in the queue - this task will block\r
 240                 indefinitely provided INCLUDE_vTaskSuspend is set to 1 in\r
 241                 FreeRTOSConfig.h. */\r
 242                 xQueueReceive( xQueue, &ulReceivedValue, portMAX_DELAY );\r
 243 \r
 244                 /*  To get here something must have been received from the queue, but\r
 245                 is it the expected value?  If it is, toggle the LED. */\r
 246                 if( ulReceivedValue == 100UL )\r
 247                 {\r
 248                         /* Normally calling printf() from a task is not a good idea.  Here\r
 249                         there is lots of stack space and only one task is using console  IO\r
 250                         so it is ok. */\r
 251                         printf( "Message received\r\n" );\r
 252                         ulReceivedValue = 0U;\r
 253                 }\r
 254         }\r
 255 }\r
 256 /*-----------------------------------------------------------*/\r
 257 \r