git.sur5r.net Git - freertos/blob - Demo/Common/Minimal/crflash.c

   1 /*\r
   2         FreeRTOS.org V4.0.3 - Copyright (C) 2003-2006 Richard Barry.\r
   3 \r
   4         This file is part of the FreeRTOS.org distribution.\r
   5 \r
   6         FreeRTOS.org is free software; you can redistribute it and/or modify\r
   7         it under the terms of the GNU General Public License as published by\r
   8         the Free Software Foundation; either version 2 of the License, or\r
   9         (at your option) any later version.\r
  10 \r
  11         FreeRTOS.org is distributed in the hope that it will be useful,\r
  12         but WITHOUT ANY WARRANTY; without even the implied warranty of\r
  13         MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
  14         GNU General Public License for more details.\r
  15 \r
  16         You should have received a copy of the GNU General Public License\r
  17         along with FreeRTOS.org; if not, write to the Free Software\r
  18         Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA\r
  19 \r
  20         A special exception to the GPL can be applied should you wish to distribute\r
  21         a combined work that includes FreeRTOS.org, without being obliged to provide\r
  22         the source code for any proprietary components.  See the licensing section \r
  23         of http://www.FreeRTOS.org for full details of how and when the exception\r
  24         can be applied.\r
  25 \r
  26         ***************************************************************************\r
  27         See http://www.FreeRTOS.org for documentation, latest information, license \r
  28         and contact details.  Please ensure to read the configuration and relevant \r
  29         port sections of the online documentation.\r
  30         ***************************************************************************\r
  31 */\r
  32 \r
  33 /* \r
  34  * This demo application file demonstrates the use of queues to pass data\r
  35  * between co-routines.\r
  36  *\r
  37  * N represents the number of 'fixed delay' co-routines that are created and\r
  38  * is set during initialisation.\r
  39  *\r
  40  * N 'fixed delay' co-routines are created that just block for a fixed \r
  41  * period then post the number of an LED onto a queue.  Each such co-routine\r
  42  * uses a different block period.  A single 'flash' co-routine is also created \r
  43  * that blocks on the same queue, waiting for the number of the next LED it \r
  44  * should flash.  Upon receiving a number it simply toggle the instructed LED \r
  45  * then blocks on the queue once more.  In this manner each LED from LED 0 to \r
  46  * LED N-1 is caused to flash at a different rate.\r
  47  *\r
  48  * The 'fixed delay' co-routines are created with co-routine priority 0.  The\r
  49  * flash co-routine is created with co-routine priority 1.  This means that\r
  50  * the queue should never contain more than a single item.  This is because\r
  51  * posting to the queue will unblock the 'flash' co-routine, and as this has\r
  52  * a priority greater than the tasks posting to the queue it is guaranteed to \r
  53  * have emptied the queue and blocked once again before the queue can contain\r
  54  * any more date.  An error is indicated if an attempt to post data to the \r
  55  * queue fails - indicating that the queue is already full.\r
  56  *\r
  57  */\r
  58 \r
  59 /* Scheduler includes. */\r
  60 #include "FreeRTOS.h"\r
  61 #include "croutine.h"\r
  62 #include "queue.h"\r
  63 \r
  64 /* Demo application includes. */\r
  65 #include "partest.h"\r
  66 #include "crflash.h"\r
  67 \r
  68 /* The queue should only need to be of length 1.  See the description at the\r
  69 top of the file. */\r
  70 #define crfQUEUE_LENGTH         1\r
  71 \r
  72 #define crfFIXED_DELAY_PRIORITY         0\r
  73 #define crfFLASH_PRIORITY                       1\r
  74 \r
  75 /* Only one flash co-routine is created so the index is not significant. */\r
  76 #define crfFLASH_INDEX                          0\r
  77 \r
  78 /* Don't allow more than crfMAX_FLASH_TASKS 'fixed delay' co-routines to be\r
  79 created. */\r
  80 #define crfMAX_FLASH_TASKS                      8\r
  81 \r
  82 /* We don't want to block when posting to the queue. */\r
  83 #define crfPOSTING_BLOCK_TIME           0\r
  84 \r
  85 /* \r
  86  * The 'fixed delay' co-routine as described at the top of the file.\r
  87  */\r
  88 static void prvFixedDelayCoRoutine( xCoRoutineHandle xHandle, unsigned portBASE_TYPE uxIndex );\r
  89 \r
  90 /*\r
  91  * The 'flash' co-routine as described at the top of the file.\r
  92  */\r
  93 static void prvFlashCoRoutine( xCoRoutineHandle xHandle, unsigned portBASE_TYPE uxIndex );\r
  94 \r
  95 /* The queue used to pass data between the 'fixed delay' co-routines and the\r
  96 'flash' co-routine. */\r
  97 static xQueueHandle xFlashQueue;\r
  98 \r
  99 /* This will be set to pdFALSE if we detect an error. */\r
 100 static unsigned portBASE_TYPE uxCoRoutineFlashStatus = pdPASS;\r
 101 \r
 102 /*-----------------------------------------------------------*/\r
 103 \r
 104 /*\r
 105  * See the header file for details.\r
 106  */\r
 107 void vStartFlashCoRoutines( unsigned portBASE_TYPE uxNumberToCreate )\r
 108 {\r
 109 unsigned portBASE_TYPE uxIndex;\r
 110 \r
 111         if( uxNumberToCreate > crfMAX_FLASH_TASKS )\r
 112         {\r
 113                 uxNumberToCreate = crfMAX_FLASH_TASKS;\r
 114         }\r
 115 \r
 116         /* Create the queue used to pass data between the co-routines. */\r
 117         xFlashQueue = xQueueCreate( crfQUEUE_LENGTH, sizeof( unsigned portBASE_TYPE ) );\r
 118 \r
 119         if( xFlashQueue )\r
 120         {\r
 121                 /* Create uxNumberToCreate 'fixed delay' co-routines. */\r
 122                 for( uxIndex = 0; uxIndex < uxNumberToCreate; uxIndex++ )\r
 123                 {\r
 124                         xCoRoutineCreate( prvFixedDelayCoRoutine, crfFIXED_DELAY_PRIORITY, uxIndex );\r
 125                 }\r
 126 \r
 127                 /* Create the 'flash' co-routine. */\r
 128                 xCoRoutineCreate( prvFlashCoRoutine, crfFLASH_PRIORITY, crfFLASH_INDEX );\r
 129         }\r
 130 }\r
 131 /*-----------------------------------------------------------*/\r
 132 \r
 133 static void prvFixedDelayCoRoutine( xCoRoutineHandle xHandle, unsigned portBASE_TYPE uxIndex )\r
 134 {\r
 135 /* Even though this is a co-routine the xResult variable does not need to be\r
 136 static as we do not need it to maintain its state between blocks. */\r
 137 portBASE_TYPE xResult;\r
 138 /* The uxIndex parameter of the co-routine function is used as an index into \r
 139 the xFlashRates array to obtain the delay period to use. */\r
 140 static const portTickType xFlashRates[ crfMAX_FLASH_TASKS ] = { 150 / portTICK_RATE_MS, \r
 141                                                                                                                                 200 / portTICK_RATE_MS, \r
 142                                                                                                                                 250 / portTICK_RATE_MS, \r
 143                                                                                                                                 300 / portTICK_RATE_MS, \r
 144                                                                                                                                 350 / portTICK_RATE_MS,\r
 145                                                                                                                                 400 / portTICK_RATE_MS, \r
 146                                                                                                                                 450 / portTICK_RATE_MS, \r
 147                                                                                                                                 500  / portTICK_RATE_MS };\r
 148 \r
 149         /* Co-routines MUST start with a call to crSTART. */\r
 150         crSTART( xHandle );\r
 151 \r
 152         for( ;; )\r
 153         {\r
 154                 /* Post our uxIndex value onto the queue.  This is used as the LED to \r
 155                 flash. */\r
 156                 crQUEUE_SEND( xHandle, xFlashQueue, ( void * ) &uxIndex, crfPOSTING_BLOCK_TIME, &xResult );\r
 157 \r
 158                 if( xResult != pdPASS )\r
 159                 {\r
 160                         /* For the reasons stated at the top of the file we should always\r
 161                         find that we can post to the queue.  If we could not then an error\r
 162                         has occurred. */\r
 163                         uxCoRoutineFlashStatus = pdFAIL;\r
 164                 }\r
 165 \r
 166                 crDELAY( xHandle, xFlashRates[ uxIndex ] );\r
 167         }\r
 168 \r
 169         /* Co-routines MUST end with a call to crEND. */\r
 170         crEND();\r
 171 }\r
 172 /*-----------------------------------------------------------*/\r
 173 \r
 174 static void prvFlashCoRoutine( xCoRoutineHandle xHandle, unsigned portBASE_TYPE uxIndex )\r
 175 {\r
 176 /* Even though this is a co-routine the variable do not need to be\r
 177 static as we do not need it to maintain their state between blocks. */\r
 178 portBASE_TYPE xResult;\r
 179 unsigned portBASE_TYPE uxLEDToFlash;\r
 180 \r
 181         /* Co-routines MUST start with a call to crSTART. */\r
 182         crSTART( xHandle );\r
 183 \r
 184         for( ;; )\r
 185         {\r
 186                 /* Block to wait for the number of the LED to flash. */\r
 187                 crQUEUE_RECEIVE( xHandle, xFlashQueue, &uxLEDToFlash, portMAX_DELAY, &xResult );                \r
 188 \r
 189                 if( xResult != pdPASS )\r
 190                 {\r
 191                         /* We would not expect to wake unless we received something. */\r
 192                         uxCoRoutineFlashStatus = pdFAIL;\r
 193                 }\r
 194                 else\r
 195                 {\r
 196                         /* We received the number of an LED to flash - flash it! */\r
 197                         vParTestToggleLED( uxLEDToFlash );\r
 198                 }\r
 199         }\r
 200 \r
 201         /* Co-routines MUST end with a call to crEND. */\r
 202         crEND();\r
 203 }\r
 204 /*-----------------------------------------------------------*/\r
 205 \r
 206 portBASE_TYPE xAreFlashCoRoutinesStillRunning( void )\r
 207 {\r
 208         /* Return pdPASS or pdFAIL depending on whether an error has been detected\r
 209         or not. */\r
 210         return uxCoRoutineFlashStatus;\r
 211 }\r
 212 \r