2 FreeRTOS V6.1.0 - Copyright (C) 2010 Real Time Engineers Ltd.
\r
4 ***************************************************************************
\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
13 * then take a look at the FreeRTOS books - available as PDF or paperback *
\r
15 * "Using the FreeRTOS Real Time Kernel - a Practical Guide" *
\r
16 * http://www.FreeRTOS.org/Documentation *
\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
23 ***************************************************************************
\r
25 This file is part of the FreeRTOS distribution.
\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
44 http://www.FreeRTOS.org - Documentation, latest information, license and
\r
47 http://www.SafeRTOS.com - A version that is certified for use in safety
\r
50 http://www.OpenRTOS.com - Commercial support, development, porting,
\r
51 licensing and training services.
\r
55 The tasks defined on this page demonstrate the use of recursive mutexes.
\r
57 For recursive mutex functionality the created mutex should be created using
\r
58 xSemaphoreCreateRecursiveMutex(), then be manipulated
\r
59 using the xSemaphoreTakeRecursive() and xSemaphoreGiveRecursive() API
\r
62 This demo creates three tasks all of which access the same recursive mutex:
\r
64 prvRecursiveMutexControllingTask() has the highest priority so executes
\r
65 first and grabs the mutex. It then performs some recursive accesses -
\r
66 between each of which it sleeps for a short period to let the lower
\r
67 priority tasks execute. When it has completed its demo functionality
\r
68 it gives the mutex back before suspending itself.
\r
70 prvRecursiveMutexBlockingTask() attempts to access the mutex by performing
\r
71 a blocking 'take'. The blocking task has a lower priority than the
\r
72 controlling task so by the time it executes the mutex has already been
\r
73 taken by the controlling task, causing the blocking task to block. It
\r
74 does not unblock until the controlling task has given the mutex back,
\r
75 and it does not actually run until the controlling task has suspended
\r
76 itself (due to the relative priorities). When it eventually does obtain
\r
77 the mutex all it does is give the mutex back prior to also suspending
\r
78 itself. At this point both the controlling task and the blocking task are
\r
81 prvRecursiveMutexPollingTask() runs at the idle priority. It spins round
\r
82 a tight loop attempting to obtain the mutex with a non-blocking call. As
\r
83 the lowest priority task it will not successfully obtain the mutex until
\r
84 both the controlling and blocking tasks are suspended. Once it eventually
\r
85 does obtain the mutex it first unsuspends both the controlling task and
\r
86 blocking task prior to giving the mutex back - resulting in the polling
\r
87 task temporarily inheriting the controlling tasks priority.
\r
90 /* Scheduler include files. */
\r
91 #include "FreeRTOS.h"
\r
95 /* Demo app include files. */
\r
96 #include "recmutex.h"
\r
98 /* Priorities assigned to the three tasks. */
\r
99 #define recmuCONTROLLING_TASK_PRIORITY ( tskIDLE_PRIORITY + 2 )
\r
100 #define recmuBLOCKING_TASK_PRIORITY ( tskIDLE_PRIORITY + 1 )
\r
101 #define recmuPOLLING_TASK_PRIORITY ( tskIDLE_PRIORITY + 0 )
\r
103 /* The recursive call depth. */
\r
104 #define recmuMAX_COUNT ( 10 )
\r
107 #define recmuSHORT_DELAY ( 20 / portTICK_RATE_MS )
\r
108 #define recmuNO_DELAY ( ( portTickType ) 0 )
\r
109 #define recmuTWO_TICK_DELAY ( ( portTickType ) 2 )
\r
111 /* The three tasks as described at the top of this file. */
\r
112 static void prvRecursiveMutexControllingTask( void *pvParameters );
\r
113 static void prvRecursiveMutexBlockingTask( void *pvParameters );
\r
114 static void prvRecursiveMutexPollingTask( void *pvParameters );
\r
116 /* The mutex used by the demo. */
\r
117 static xSemaphoreHandle xMutex;
\r
119 /* Variables used to detect and latch errors. */
\r
120 static volatile portBASE_TYPE xErrorOccurred = pdFALSE, xControllingIsSuspended = pdFALSE, xBlockingIsSuspended = pdFALSE;
\r
121 static volatile unsigned portBASE_TYPE uxControllingCycles = 0, uxBlockingCycles = 0, uxPollingCycles = 0;
\r
123 /* Handles of the two higher priority tasks, required so they can be resumed
\r
125 static xTaskHandle xControllingTaskHandle, xBlockingTaskHandle;
\r
127 /*-----------------------------------------------------------*/
\r
129 void vStartRecursiveMutexTasks( void )
\r
131 /* Just creates the mutex and the three tasks. */
\r
133 xMutex = xSemaphoreCreateRecursiveMutex();
\r
135 /* vQueueAddToRegistry() adds the mutex to the registry, if one is
\r
136 in use. The registry is provided as a means for kernel aware
\r
137 debuggers to locate mutex and has no purpose if a kernel aware debugger
\r
138 is not being used. The call to vQueueAddToRegistry() will be removed
\r
139 by the pre-processor if configQUEUE_REGISTRY_SIZE is not defined or is
\r
140 defined to be less than 1. */
\r
141 vQueueAddToRegistry( ( xQueueHandle ) xMutex, ( signed portCHAR * ) "Recursive_Mutex" );
\r
144 if( xMutex != NULL )
\r
146 xTaskCreate( prvRecursiveMutexControllingTask, ( signed portCHAR * ) "Rec1", configMINIMAL_STACK_SIZE, NULL, recmuCONTROLLING_TASK_PRIORITY, &xControllingTaskHandle );
\r
147 xTaskCreate( prvRecursiveMutexBlockingTask, ( signed portCHAR * ) "Rec2", configMINIMAL_STACK_SIZE, NULL, recmuBLOCKING_TASK_PRIORITY, &xBlockingTaskHandle );
\r
148 xTaskCreate( prvRecursiveMutexPollingTask, ( signed portCHAR * ) "Rec3", configMINIMAL_STACK_SIZE, NULL, recmuPOLLING_TASK_PRIORITY, NULL );
\r
151 /*-----------------------------------------------------------*/
\r
153 static void prvRecursiveMutexControllingTask( void *pvParameters )
\r
155 unsigned portBASE_TYPE ux;
\r
157 /* Just to remove compiler warning. */
\r
158 ( void ) pvParameters;
\r
162 /* Should not be able to 'give' the mutex, as we have not yet 'taken'
\r
163 it. The first time through, the mutex will not have been used yet,
\r
164 subsequent times through, at this point the mutex will be held by the
\r
166 if( xSemaphoreGiveRecursive( xMutex ) == pdPASS )
\r
168 xErrorOccurred = pdTRUE;
\r
171 for( ux = 0; ux < recmuMAX_COUNT; ux++ )
\r
173 /* We should now be able to take the mutex as many times as
\r
176 The first time through the mutex will be immediately available, on
\r
177 subsequent times through the mutex will be held by the polling task
\r
178 at this point and this Take will cause the polling task to inherit
\r
179 the priority of this task. In this case the block time must be
\r
180 long enough to ensure the polling task will execute again before the
\r
181 block time expires. If the block time does expire then the error
\r
182 flag will be set here. */
\r
183 if( xSemaphoreTakeRecursive( xMutex, recmuTWO_TICK_DELAY ) != pdPASS )
\r
185 xErrorOccurred = pdTRUE;
\r
188 /* Ensure the other task attempting to access the mutex (and the
\r
189 other demo tasks) are able to execute to ensure they either block
\r
190 (where a block time is specified) or return an error (where no
\r
191 block time is specified) as the mutex is held by this task. */
\r
192 vTaskDelay( recmuSHORT_DELAY );
\r
195 /* For each time we took the mutex, give it back. */
\r
196 for( ux = 0; ux < recmuMAX_COUNT; ux++ )
\r
198 /* Ensure the other task attempting to access the mutex (and the
\r
199 other demo tasks) are able to execute. */
\r
200 vTaskDelay( recmuSHORT_DELAY );
\r
202 /* We should now be able to give the mutex as many times as we
\r
203 took it. When the mutex is available again the Blocking task
\r
204 should be unblocked but not run because it has a lower priority
\r
205 than this task. The polling task should also not run at this point
\r
206 as it too has a lower priority than this task. */
\r
207 if( xSemaphoreGiveRecursive( xMutex ) != pdPASS )
\r
209 xErrorOccurred = pdTRUE;
\r
213 /* Having given it back the same number of times as it was taken, we
\r
214 should no longer be the mutex owner, so the next give sh ould fail. */
\r
215 if( xSemaphoreGiveRecursive( xMutex ) == pdPASS )
\r
217 xErrorOccurred = pdTRUE;
\r
220 /* Keep count of the number of cycles this task has performed so a
\r
221 stall can be detected. */
\r
222 uxControllingCycles++;
\r
224 /* Suspend ourselves to the blocking task can execute. */
\r
225 xControllingIsSuspended = pdTRUE;
\r
226 vTaskSuspend( NULL );
\r
227 xControllingIsSuspended = pdFALSE;
\r
230 /*-----------------------------------------------------------*/
\r
232 static void prvRecursiveMutexBlockingTask( void *pvParameters )
\r
234 /* Just to remove compiler warning. */
\r
235 ( void ) pvParameters;
\r
239 /* This task will run while the controlling task is blocked, and the
\r
240 controlling task will block only once it has the mutex - therefore
\r
241 this call should block until the controlling task has given up the
\r
242 mutex, and not actually execute past this call until the controlling
\r
243 task is suspended. */
\r
244 if( xSemaphoreTakeRecursive( xMutex, portMAX_DELAY ) == pdPASS )
\r
246 if( xControllingIsSuspended != pdTRUE )
\r
248 /* Did not expect to execute until the controlling task was
\r
250 xErrorOccurred = pdTRUE;
\r
254 /* Give the mutex back before suspending ourselves to allow
\r
255 the polling task to obtain the mutex. */
\r
256 if( xSemaphoreGiveRecursive( xMutex ) != pdPASS )
\r
258 xErrorOccurred = pdTRUE;
\r
261 xBlockingIsSuspended = pdTRUE;
\r
262 vTaskSuspend( NULL );
\r
263 xBlockingIsSuspended = pdFALSE;
\r
268 /* We should not leave the xSemaphoreTakeRecursive() function
\r
269 until the mutex was obtained. */
\r
270 xErrorOccurred = pdTRUE;
\r
273 /* The controlling and blocking tasks should be in lock step. */
\r
274 if( uxControllingCycles != ( uxBlockingCycles + 1 ) )
\r
276 xErrorOccurred = pdTRUE;
\r
279 /* Keep count of the number of cycles this task has performed so a
\r
280 stall can be detected. */
\r
281 uxBlockingCycles++;
\r
284 /*-----------------------------------------------------------*/
\r
286 static void prvRecursiveMutexPollingTask( void *pvParameters )
\r
288 /* Just to remove compiler warning. */
\r
289 ( void ) pvParameters;
\r
293 /* Keep attempting to obtain the mutex. We should only obtain it when
\r
294 the blocking task has suspended itself, which in turn should only
\r
295 happen when the controlling task is also suspended. */
\r
296 if( xSemaphoreTakeRecursive( xMutex, recmuNO_DELAY ) == pdPASS )
\r
298 /* Is the blocking task suspended? */
\r
299 if( ( xBlockingIsSuspended != pdTRUE ) || ( xControllingIsSuspended != pdTRUE ) )
\r
301 xErrorOccurred = pdTRUE;
\r
305 /* Keep count of the number of cycles this task has performed
\r
306 so a stall can be detected. */
\r
309 /* We can resume the other tasks here even though they have a
\r
310 higher priority than the polling task. When they execute they
\r
311 will attempt to obtain the mutex but fail because the polling
\r
312 task is still the mutex holder. The polling task (this task)
\r
313 will then inherit the higher priority. The Blocking task will
\r
314 block indefinitely when it attempts to obtain the mutex, the
\r
315 Controlling task will only block for a fixed period and an
\r
316 error will be latched if the polling task has not returned the
\r
317 mutex by the time this fixed period has expired. */
\r
318 vTaskResume( xBlockingTaskHandle );
\r
319 vTaskResume( xControllingTaskHandle );
\r
321 /* The other two tasks should now have executed and no longer
\r
323 if( ( xBlockingIsSuspended == pdTRUE ) || ( xControllingIsSuspended == pdTRUE ) )
\r
325 xErrorOccurred = pdTRUE;
\r
328 /* Release the mutex, disinheriting the higher priority again. */
\r
329 if( xSemaphoreGiveRecursive( xMutex ) != pdPASS )
\r
331 xErrorOccurred = pdTRUE;
\r
336 #if configUSE_PREEMPTION == 0
\r
343 /*-----------------------------------------------------------*/
\r
345 /* This is called to check that all the created tasks are still running. */
\r
346 portBASE_TYPE xAreRecursiveMutexTasksStillRunning( void )
\r
348 portBASE_TYPE xReturn;
\r
349 static unsigned portBASE_TYPE uxLastControllingCycles = 0, uxLastBlockingCycles = 0, uxLastPollingCycles = 0;
\r
351 /* Is the controlling task still cycling? */
\r
352 if( uxLastControllingCycles == uxControllingCycles )
\r
354 xErrorOccurred = pdTRUE;
\r
358 uxLastControllingCycles = uxControllingCycles;
\r
361 /* Is the blocking task still cycling? */
\r
362 if( uxLastBlockingCycles == uxBlockingCycles )
\r
364 xErrorOccurred = pdTRUE;
\r
368 uxLastBlockingCycles = uxBlockingCycles;
\r
371 /* Is the polling task still cycling? */
\r
372 if( uxLastPollingCycles == uxPollingCycles )
\r
374 xErrorOccurred = pdTRUE;
\r
378 uxLastPollingCycles = uxPollingCycles;
\r
381 if( xErrorOccurred == pdTRUE )
\r