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

   1 /*\r
   2     FreeRTOS V8.1.1 - Copyright (C) 2014 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     ***************************************************************************\r
   8      *                                                                       *\r
   9      *    FreeRTOS provides completely free yet professionally developed,    *\r
  10      *    robust, strictly quality controlled, supported, and cross          *\r
  11      *    platform software that has become a de facto standard.             *\r
  12      *                                                                       *\r
  13      *    Help yourself get started quickly and support the FreeRTOS         *\r
  14      *    project by purchasing a FreeRTOS tutorial book, reference          *\r
  15      *    manual, or both from: http://www.FreeRTOS.org/Documentation        *\r
  16      *                                                                       *\r
  17      *    Thank you!                                                         *\r
  18      *                                                                       *\r
  19     ***************************************************************************\r
  20 \r
  21     This file is part of the FreeRTOS distribution.\r
  22 \r
  23     FreeRTOS is free software; you can redistribute it and/or modify it under\r
  24     the terms of the GNU General Public License (version 2) as published by the\r
  25     Free Software Foundation >>!AND MODIFIED BY!<< the FreeRTOS exception.\r
  26 \r
  27     >>!   NOTE: The modification to the GPL is included to allow you to     !<<\r
  28     >>!   distribute a combined work that includes FreeRTOS without being   !<<\r
  29     >>!   obliged to provide the source code for proprietary components     !<<\r
  30     >>!   outside of the FreeRTOS kernel.                                   !<<\r
  31 \r
  32     FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY\r
  33     WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS\r
  34     FOR A PARTICULAR PURPOSE.  Full license text is available from the following\r
  35     link: http://www.freertos.org/a00114.html\r
  36 \r
  37     1 tab == 4 spaces!\r
  38 \r
  39     ***************************************************************************\r
  40      *                                                                       *\r
  41      *    Having a problem?  Start by reading the FAQ "My application does   *\r
  42      *    not run, what could be wrong?"                                     *\r
  43      *                                                                       *\r
  44      *    http://www.FreeRTOS.org/FAQHelp.html                               *\r
  45      *                                                                       *\r
  46     ***************************************************************************\r
  47 \r
  48     http://www.FreeRTOS.org - Documentation, books, training, latest versions,\r
  49     license and Real Time Engineers Ltd. contact details.\r
  50 \r
  51     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
  52     including FreeRTOS+Trace - an indispensable productivity tool, a DOS\r
  53     compatible FAT file system, and our tiny thread aware UDP/IP stack.\r
  54 \r
  55     http://www.OpenRTOS.com - Real Time Engineers ltd license FreeRTOS to High\r
  56     Integrity Systems to sell under the OpenRTOS brand.  Low cost OpenRTOS\r
  57     licenses offer ticketed support, indemnification and middleware.\r
  58 \r
  59     http://www.SafeRTOS.com - High Integrity Systems also provide a safety\r
  60     engineered and independently SIL3 certified version for use in safety and\r
  61     mission critical applications that require provable dependability.\r
  62 \r
  63     1 tab == 4 spaces!\r
  64 */\r
  65 \r
  66 /******************************************************************************\r
  67  * NOTE 1:  This project provides two demo applications.  A simple blinky style\r
  68  * project, and a more comprehensive test and demo application.  The\r
  69  * mainCREATE_SIMPLE_BLINKY_DEMO_ONLY setting in main.c is used to select\r
  70  * between the two.  See the notes on using mainCREATE_SIMPLE_BLINKY_DEMO_ONLY\r
  71  * in main.c.  This file implements the simply blinky style version.\r
  72  *\r
  73  * NOTE 2:  This file only contains the source code that is specific to the\r
  74  * basic demo.  Generic functions, such FreeRTOS hook functions, and functions\r
  75  * required to configure the hardware, are defined in main.c.\r
  76  ******************************************************************************\r
  77  *\r
  78  * main_blinky() creates one queue, two tasks, and one software timer.  It then\r
  79  * starts the scheduler.\r
  80  *\r
  81  * The Blinky Software Timer:\r
  82  * This demonstrates an auto-reload software timer.  The timer callback function\r
  83  * does nothing but toggle an LED.\r
  84  *\r
  85  * The Queue Send Task:\r
  86  * The queue send task is implemented by the prvQueueSendTask() function in\r
  87  * this file.  prvQueueSendTask() sits in a loop that causes it to repeatedly\r
  88  * block for 200 milliseconds, before sending the value 100 to the queue that\r
  89  * was created within main_blinky().  Once the value is sent, the task loops\r
  90  * back around to block for another 200 milliseconds.\r
  91  *\r
  92  * The Queue Receive Task:\r
  93  * The queue receive task is implemented by the prvQueueReceiveTask() function\r
  94  * in this file.  prvQueueReceiveTask() sits in a loop where it repeatedly\r
  95  * blocks on attempts to read data from the queue that was created within\r
  96  * main_blinky().  When data is received, the task checks the value of the\r
  97  * data, and if the value equals the expected 100, toggles the LED.  The 'block\r
  98  * time' parameter passed to the queue receive function specifies that the\r
  99  * task should be held in the Blocked state indefinitely to wait for data to\r
 100  * be available on the queue.  The queue receive task will only leave the\r
 101  * Blocked state when the queue send task writes to the queue.  As the queue\r
 102  * send task writes to the queue every 200 milliseconds, the queue receive\r
 103  * task leaves the Blocked state every 200 milliseconds, and therefore toggles\r
 104  * the LED every 200 milliseconds.\r
 105  */\r
 106 \r
 107 /* Standard includes. */\r
 108 #include <stdio.h>\r
 109 \r
 110 /* Kernel includes. */\r
 111 #include "FreeRTOS.h"\r
 112 #include "task.h"\r
 113 #include "queue.h"\r
 114 #include "timers.h"\r
 115 \r
 116 /* Standard demo includes. */\r
 117 #include "partest.h"\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.  The 200ms value is converted\r
 124 to ticks using the portTICK_PERIOD_MS constant. */\r
 125 #define mainQUEUE_SEND_FREQUENCY_MS                     ( 200 / portTICK_PERIOD_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 /* Values passed to the two tasks just to check the task parameter\r
 133 functionality. */\r
 134 #define mainQUEUE_SEND_PARAMETER                        ( 0x1111UL )\r
 135 #define mainQUEUE_RECEIVE_PARAMETER                     ( 0x22UL )\r
 136 \r
 137 /* The period of the blinky software timer.  The period is specified in ms and\r
 138 converted to ticks using the portTICK_PERIOD_MS constant. */\r
 139 #define mainBLINKY_TIMER_PERIOD                         ( 50 / portTICK_PERIOD_MS )\r
 140 \r
 141 /* The LED used by the communicating tasks and the blinky timer respectively. */\r
 142 #define mainTASKS_LED                                           ( 0 )\r
 143 #define mainTIMER_LED                                           ( 1 )\r
 144 \r
 145 /* Misc. */\r
 146 #define mainDONT_BLOCK                                          ( 0 )\r
 147 \r
 148 /*-----------------------------------------------------------*/\r
 149 \r
 150 /*\r
 151  * The tasks as described in the comments at the top of this file.\r
 152  */\r
 153 static void prvQueueReceiveTask( void *pvParameters );\r
 154 static void prvQueueSendTask( void *pvParameters );\r
 155 \r
 156 /*\r
 157  * The callback function for the blinky software timer, as described at the top\r
 158  * of this file.\r
 159  */\r
 160 static void prvBlinkyTimerCallback( TimerHandle_t xTimer );\r
 161 \r
 162 /*\r
 163  * Called by main() to create the simply blinky style application if\r
 164  * mainCREATE_SIMPLE_BLINKY_DEMO_ONLY is set to 1.\r
 165  */\r
 166 void main_blinky( void );\r
 167 \r
 168 /*-----------------------------------------------------------*/\r
 169 \r
 170 /* The queue used by both tasks. */\r
 171 static QueueHandle_t xQueue = NULL;\r
 172 \r
 173 /*-----------------------------------------------------------*/\r
 174 \r
 175 void main_blinky( void )\r
 176 {\r
 177 TimerHandle_t xTimer;\r
 178 \r
 179         /* Create the queue. */\r
 180         xQueue = xQueueCreate( mainQUEUE_LENGTH, sizeof( unsigned long ) );\r
 181 \r
 182         if( xQueue != NULL )\r
 183         {\r
 184                 /* Create the two tasks as described in the comments at the top of this\r
 185                 file. */\r
 186                 xTaskCreate( prvQueueReceiveTask,                                       /* The function that implements the task. */\r
 187                                         "Rx",                                                                   /* The text name assigned to the task - for debug only as it is not used by the kernel. */\r
 188                                         configMINIMAL_STACK_SIZE,                               /* The size of the stack to allocate to the task. */\r
 189                                         ( void * ) mainQUEUE_RECEIVE_PARAMETER, /* The parameter passed to the task - just to check the functionality. */\r
 190                                         mainQUEUE_RECEIVE_TASK_PRIORITY,                /* The priority assigned to the task. */\r
 191                                         NULL );                                                                 /* The task handle is not required, so NULL is passed. */\r
 192 \r
 193                 xTaskCreate( prvQueueSendTask, "TX", configMINIMAL_STACK_SIZE, ( void * ) mainQUEUE_SEND_PARAMETER, mainQUEUE_SEND_TASK_PRIORITY, NULL );\r
 194 \r
 195                 /* Create the blinky software timer as described at the top of this\r
 196                 file. */\r
 197                 xTimer = xTimerCreate(  "Blinky",                                       /* A text name, purely to help debugging. */\r
 198                                                                 ( mainBLINKY_TIMER_PERIOD ),/* The timer period. */\r
 199                                                                 pdTRUE,                                         /* This is an auto-reload timer, so xAutoReload is set to pdTRUE. */\r
 200                                                                 ( void * ) 0,                           /* The ID is not used, so can be set to anything. */\r
 201                                                                 prvBlinkyTimerCallback          /* The callback function that inspects the status of all the other tasks. */\r
 202                                                         );\r
 203 \r
 204                 if( xTimer != NULL )\r
 205                 {\r
 206                         xTimerStart( xTimer, mainDONT_BLOCK );\r
 207                 }\r
 208 \r
 209                 /* Start the tasks and timer running. */\r
 210                 vTaskStartScheduler();\r
 211         }\r
 212 \r
 213         /* If all is well, the scheduler will now be running, and the following\r
 214         line will never be reached.  If the following line does execute, then\r
 215         there was insufficient FreeRTOS heap memory available for the idle and/or\r
 216         timer tasks     to be created.  See the memory management section on the\r
 217         FreeRTOS web site for more details. */\r
 218         for( ;; );\r
 219 }\r
 220 /*-----------------------------------------------------------*/\r
 221 \r
 222 static void prvQueueSendTask( void *pvParameters )\r
 223 {\r
 224 TickType_t xNextWakeTime;\r
 225 const unsigned long ulValueToSend = 100UL;\r
 226 \r
 227         /* Check the task parameter is as expected. */\r
 228         configASSERT( ( ( unsigned long ) pvParameters ) == mainQUEUE_SEND_PARAMETER );\r
 229 \r
 230         /* Initialise xNextWakeTime - this only needs to be done once. */\r
 231         xNextWakeTime = xTaskGetTickCount();\r
 232 \r
 233         for( ;; )\r
 234         {\r
 235                 /* Place this task in the blocked state until it is time to run again.\r
 236                 The block time is specified in ticks, the constant used converts ticks\r
 237                 to ms.  While in the Blocked state this task will not consume any CPU\r
 238                 time. */\r
 239                 vTaskDelayUntil( &xNextWakeTime, mainQUEUE_SEND_FREQUENCY_MS );\r
 240 \r
 241                 /* Send to the queue - causing the queue receive task to unblock and\r
 242                 toggle the LED.  0 is used as the block time so the sending operation\r
 243                 will not block - it shouldn't need to block as the queue should always\r
 244                 be empty at this point in the code. */\r
 245                 xQueueSend( xQueue, &ulValueToSend, 0U );\r
 246         }\r
 247 }\r
 248 /*-----------------------------------------------------------*/\r
 249 \r
 250 static void prvQueueReceiveTask( void *pvParameters )\r
 251 {\r
 252 unsigned long ulReceivedValue;\r
 253 \r
 254         /* Check the task parameter is as expected. */\r
 255         configASSERT( ( ( unsigned long ) pvParameters ) == mainQUEUE_RECEIVE_PARAMETER );\r
 256 \r
 257         for( ;; )\r
 258         {\r
 259                 /* Wait until something arrives in the queue - this task will block\r
 260                 indefinitely provided INCLUDE_vTaskSuspend is set to 1 in\r
 261                 FreeRTOSConfig.h. */\r
 262                 xQueueReceive( xQueue, &ulReceivedValue, portMAX_DELAY );\r
 263 \r
 264                 /*  To get here something must have been received from the queue, but\r
 265                 is it the expected value?  If it is, toggle the LED. */\r
 266                 if( ulReceivedValue == 100UL )\r
 267                 {\r
 268                         vParTestToggleLED( mainTASKS_LED );\r
 269                         ulReceivedValue = 0U;\r
 270                 }\r
 271         }\r
 272 }\r
 273 /*-----------------------------------------------------------*/\r
 274 \r
 275 static void prvBlinkyTimerCallback( TimerHandle_t xTimer )\r
 276 {\r
 277         /* This function is called when the blinky software time expires.  All the\r
 278         function does is toggle the LED.  LED mainTIMER_LED should therefore toggle\r
 279         with the period set by mainBLINKY_TIMER_PERIOD. */\r
 280         vParTestToggleLED( mainTIMER_LED );\r
 281 }\r
 282 \r