]> git.sur5r.net Git - freertos/blob - FreeRTOS/Demo/Common/Minimal/crflash.c
f15ad2726da4604670dc58f820f214b753d950f7
[freertos] / FreeRTOS / Demo / Common / Minimal / crflash.c
1 /*\r
2     FreeRTOS V7.5.2 - Copyright (C) 2013 Real Time Engineers Ltd.\r
3 \r
4     VISIT http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.\r
5 \r
6     ***************************************************************************\r
7      *                                                                       *\r
8      *    FreeRTOS provides completely free yet professionally developed,    *\r
9      *    robust, strictly quality controlled, supported, and cross          *\r
10      *    platform software that has become a de facto standard.             *\r
11      *                                                                       *\r
12      *    Help yourself get started quickly and support the FreeRTOS         *\r
13      *    project by purchasing a FreeRTOS tutorial book, reference          *\r
14      *    manual, or both from: http://www.FreeRTOS.org/Documentation        *\r
15      *                                                                       *\r
16      *    Thank you!                                                         *\r
17      *                                                                       *\r
18     ***************************************************************************\r
19 \r
20     This file is part of the FreeRTOS distribution.\r
21 \r
22     FreeRTOS is free software; you can redistribute it and/or modify it under\r
23     the terms of the GNU General Public License (version 2) as published by the\r
24     Free Software Foundation >>!AND MODIFIED BY!<< the FreeRTOS exception.\r
25 \r
26     >>! NOTE: The modification to the GPL is included to allow you to distribute\r
27     >>! a combined work that includes FreeRTOS without being obliged to provide\r
28     >>! the source code for proprietary components outside of the FreeRTOS\r
29     >>! kernel.\r
30 \r
31     FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY\r
32     WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS\r
33     FOR A PARTICULAR PURPOSE.  Full license text is available from the following\r
34     link: http://www.freertos.org/a00114.html\r
35 \r
36     1 tab == 4 spaces!\r
37 \r
38     ***************************************************************************\r
39      *                                                                       *\r
40      *    Having a problem?  Start by reading the FAQ "My application does   *\r
41      *    not run, what could be wrong?"                                     *\r
42      *                                                                       *\r
43      *    http://www.FreeRTOS.org/FAQHelp.html                               *\r
44      *                                                                       *\r
45     ***************************************************************************\r
46 \r
47     http://www.FreeRTOS.org - Documentation, books, training, latest versions,\r
48     license and Real Time Engineers Ltd. contact details.\r
49 \r
50     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
51     including FreeRTOS+Trace - an indispensable productivity tool, a DOS\r
52     compatible FAT file system, and our tiny thread aware UDP/IP stack.\r
53 \r
54     http://www.OpenRTOS.com - Real Time Engineers ltd license FreeRTOS to High\r
55     Integrity Systems to sell under the OpenRTOS brand.  Low cost OpenRTOS\r
56     licenses offer ticketed support, indemnification and middleware.\r
57 \r
58     http://www.SafeRTOS.com - High Integrity Systems also provide a safety\r
59     engineered and independently SIL3 certified version for use in safety and\r
60     mission critical applications that require provable dependability.\r
61 \r
62     1 tab == 4 spaces!\r
63 */\r
64 \r
65 /*\r
66  * This demo application file demonstrates the use of queues to pass data\r
67  * between co-routines.\r
68  *\r
69  * N represents the number of 'fixed delay' co-routines that are created and\r
70  * is set during initialisation.\r
71  *\r
72  * N 'fixed delay' co-routines are created that just block for a fixed\r
73  * period then post the number of an LED onto a queue.  Each such co-routine\r
74  * uses a different block period.  A single 'flash' co-routine is also created\r
75  * that blocks on the same queue, waiting for the number of the next LED it\r
76  * should flash.  Upon receiving a number it simply toggle the instructed LED\r
77  * then blocks on the queue once more.  In this manner each LED from LED 0 to\r
78  * LED N-1 is caused to flash at a different rate.\r
79  *\r
80  * The 'fixed delay' co-routines are created with co-routine priority 0.  The\r
81  * flash co-routine is created with co-routine priority 1.  This means that\r
82  * the queue should never contain more than a single item.  This is because\r
83  * posting to the queue will unblock the 'flash' co-routine, and as this has\r
84  * a priority greater than the tasks posting to the queue it is guaranteed to\r
85  * have emptied the queue and blocked once again before the queue can contain\r
86  * any more date.  An error is indicated if an attempt to post data to the\r
87  * queue fails - indicating that the queue is already full.\r
88  *\r
89  */\r
90 \r
91 /* Scheduler includes. */\r
92 #include "FreeRTOS.h"\r
93 #include "croutine.h"\r
94 #include "queue.h"\r
95 \r
96 /* Demo application includes. */\r
97 #include "partest.h"\r
98 #include "crflash.h"\r
99 \r
100 /* The queue should only need to be of length 1.  See the description at the\r
101 top of the file. */\r
102 #define crfQUEUE_LENGTH         1\r
103 \r
104 #define crfFIXED_DELAY_PRIORITY         0\r
105 #define crfFLASH_PRIORITY                       1\r
106 \r
107 /* Only one flash co-routine is created so the index is not significant. */\r
108 #define crfFLASH_INDEX                          0\r
109 \r
110 /* Don't allow more than crfMAX_FLASH_TASKS 'fixed delay' co-routines to be\r
111 created. */\r
112 #define crfMAX_FLASH_TASKS                      8\r
113 \r
114 /* We don't want to block when posting to the queue. */\r
115 #define crfPOSTING_BLOCK_TIME           0\r
116 \r
117 /*\r
118  * The 'fixed delay' co-routine as described at the top of the file.\r
119  */\r
120 static void prvFixedDelayCoRoutine( xCoRoutineHandle xHandle, unsigned portBASE_TYPE uxIndex );\r
121 \r
122 /*\r
123  * The 'flash' co-routine as described at the top of the file.\r
124  */\r
125 static void prvFlashCoRoutine( xCoRoutineHandle xHandle, unsigned portBASE_TYPE uxIndex );\r
126 \r
127 /* The queue used to pass data between the 'fixed delay' co-routines and the\r
128 'flash' co-routine. */\r
129 static xQueueHandle xFlashQueue;\r
130 \r
131 /* This will be set to pdFALSE if we detect an error. */\r
132 static portBASE_TYPE xCoRoutineFlashStatus = pdPASS;\r
133 \r
134 /*-----------------------------------------------------------*/\r
135 \r
136 /*\r
137  * See the header file for details.\r
138  */\r
139 void vStartFlashCoRoutines( unsigned portBASE_TYPE uxNumberToCreate )\r
140 {\r
141 unsigned portBASE_TYPE uxIndex;\r
142 \r
143         if( uxNumberToCreate > crfMAX_FLASH_TASKS )\r
144         {\r
145                 uxNumberToCreate = crfMAX_FLASH_TASKS;\r
146         }\r
147 \r
148         /* Create the queue used to pass data between the co-routines. */\r
149         xFlashQueue = xQueueCreate( crfQUEUE_LENGTH, sizeof( unsigned portBASE_TYPE ) );\r
150 \r
151         if( xFlashQueue )\r
152         {\r
153                 /* Create uxNumberToCreate 'fixed delay' co-routines. */\r
154                 for( uxIndex = 0; uxIndex < uxNumberToCreate; uxIndex++ )\r
155                 {\r
156                         xCoRoutineCreate( prvFixedDelayCoRoutine, crfFIXED_DELAY_PRIORITY, uxIndex );\r
157                 }\r
158 \r
159                 /* Create the 'flash' co-routine. */\r
160                 xCoRoutineCreate( prvFlashCoRoutine, crfFLASH_PRIORITY, crfFLASH_INDEX );\r
161         }\r
162 }\r
163 /*-----------------------------------------------------------*/\r
164 \r
165 static void prvFixedDelayCoRoutine( xCoRoutineHandle xHandle, unsigned portBASE_TYPE uxIndex )\r
166 {\r
167 /* Even though this is a co-routine the xResult variable does not need to be\r
168 static as we do not need it to maintain its state between blocks. */\r
169 signed portBASE_TYPE xResult;\r
170 /* The uxIndex parameter of the co-routine function is used as an index into\r
171 the xFlashRates array to obtain the delay period to use. */\r
172 static const portTickType xFlashRates[ crfMAX_FLASH_TASKS ] = { 150 / portTICK_RATE_MS,\r
173                                                                                                                                 200 / portTICK_RATE_MS,\r
174                                                                                                                                 250 / portTICK_RATE_MS,\r
175                                                                                                                                 300 / portTICK_RATE_MS,\r
176                                                                                                                                 350 / portTICK_RATE_MS,\r
177                                                                                                                                 400 / portTICK_RATE_MS,\r
178                                                                                                                                 450 / portTICK_RATE_MS,\r
179                                                                                                                                 500  / portTICK_RATE_MS };\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                 /* Post our uxIndex value onto the queue.  This is used as the LED to\r
187                 flash. */\r
188                 crQUEUE_SEND( xHandle, xFlashQueue, ( void * ) &uxIndex, crfPOSTING_BLOCK_TIME, &xResult );\r
189 \r
190                 if( xResult != pdPASS )\r
191                 {\r
192                         /* For the reasons stated at the top of the file we should always\r
193                         find that we can post to the queue.  If we could not then an error\r
194                         has occurred. */\r
195                         xCoRoutineFlashStatus = pdFAIL;\r
196                 }\r
197 \r
198                 crDELAY( xHandle, xFlashRates[ uxIndex ] );\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 static void prvFlashCoRoutine( xCoRoutineHandle xHandle, unsigned portBASE_TYPE uxIndex )\r
207 {\r
208 /* Even though this is a co-routine the variable do not need to be\r
209 static as we do not need it to maintain their state between blocks. */\r
210 signed portBASE_TYPE xResult;\r
211 unsigned portBASE_TYPE uxLEDToFlash;\r
212 \r
213         /* Co-routines MUST start with a call to crSTART. */\r
214         crSTART( xHandle );\r
215         ( void ) uxIndex;\r
216         \r
217         for( ;; )\r
218         {\r
219                 /* Block to wait for the number of the LED to flash. */\r
220                 crQUEUE_RECEIVE( xHandle, xFlashQueue, &uxLEDToFlash, portMAX_DELAY, &xResult );                \r
221 \r
222                 if( xResult != pdPASS )\r
223                 {\r
224                         /* We would not expect to wake unless we received something. */\r
225                         xCoRoutineFlashStatus = pdFAIL;\r
226                 }\r
227                 else\r
228                 {\r
229                         /* We received the number of an LED to flash - flash it! */\r
230                         vParTestToggleLED( uxLEDToFlash );\r
231                 }\r
232         }\r
233 \r
234         /* Co-routines MUST end with a call to crEND. */\r
235         crEND();\r
236 }\r
237 /*-----------------------------------------------------------*/\r
238 \r
239 portBASE_TYPE xAreFlashCoRoutinesStillRunning( void )\r
240 {\r
241         /* Return pdPASS or pdFAIL depending on whether an error has been detected\r
242         or not. */\r
243         return xCoRoutineFlashStatus;\r
244 }\r
245 \r