Correct sample code for recursive mutexes.

git-svn-id: https://svn.code.sf.net/p/freertos/code/trunk@150 1d2547de-c912-0410-9cb9-b8ca96c0e9e2

diff --git a/Source/include/semphr.h b/Source/include/semphr.h
index d62a5bd0ae40622874d52989bb16e9b5559659f4..7f7389388ad322b98e0ad4ae8f002359799fc213 100644 (file)
--- a/Source/include/semphr.h
+++ b/Source/include/semphr.h
@@ -189,7 +189,7 @@ typedef xQueueHandle xSemaphoreHandle;
  * exactly five times.\r
  *\r
  * @param xMutex A handle to the mutex being obtained.  This is the\r
- * handle returned by xSemaphoreCreateMutex();\r
+ * handle returned by xSemaphoreCreateRecursiveMutex();\r
  *\r
  * @param xBlockTime The time in ticks to wait for the semaphore to become\r
  * available.  The macro portTICK_RATE_MS can be used to convert this to a\r
@@ -231,17 +231,17 @@ typedef xQueueHandle xSemaphoreHandle;
                        // code these would not be just sequential calls as this would make\r
                        // no sense.  Instead the calls are likely to be buried inside\r
                        // a more complex call structure.\r
-            xSemaphoreTakeRecursive( xSemaphore, ( portTickType ) 10 );\r
-            xSemaphoreTakeRecursive( xSemaphore, ( portTickType ) 10 );\r
+            xSemaphoreTakeRecursive( xMutex, ( portTickType ) 10 );\r
+            xSemaphoreTakeRecursive( xMutex, ( portTickType ) 10 );\r
 \r
             // The mutex has now been 'taken' three times, so will not be \r
                        // available to another task until it has also been given back\r
                        // three times.  Again it is unlikely that real code would have\r
                        // these calls sequentially, but instead buried in a more complex\r
                        // call structure.  This is just for illustrative purposes.\r
-            xSemaphoreGiveRecursive( xSemaphore );\r
-                       xSemaphoreGiveRecursive( xSemaphore );\r
-                       xSemaphoreGiveRecursive( xSemaphore );\r
+            xSemaphoreGiveRecursive( xMutex );\r
+                       xSemaphoreGiveRecursive( xMutex );\r
+                       xSemaphoreGiveRecursive( xMutex );\r
 \r
                        // Now the mutex can be taken by other tasks.\r
         }\r
@@ -338,7 +338,7 @@ typedef xQueueHandle xSemaphoreHandle;
 \r
 /**\r
  * semphr. h\r
- * <pre>xSemaphoreGiveRecursive( xSemaphoreHandle xSemaphore )</pre>\r
+ * <pre>xSemaphoreGiveRecursive( xSemaphoreHandle xMutex )</pre>\r
  *\r
  * <i>Macro</i> to recursively release, or 'give', a mutex type semaphore.\r
  * The mutex must have previously been created using a call to \r
@@ -381,7 +381,7 @@ typedef xQueueHandle xSemaphoreHandle;
     {\r
         // See if we can obtain the mutex.  If the mutex is not available\r
         // wait 10 ticks to see if it becomes free.    \r
-        if( xSemaphoreTakeRecursive( xSemaphore, ( portTickType ) 10 ) == pdTRUE )\r
+        if( xSemaphoreTakeRecursive( xMutex, ( portTickType ) 10 ) == pdTRUE )\r
         {\r
             // We were able to obtain the mutex and can now access the\r
             // shared resource.\r
@@ -392,8 +392,8 @@ typedef xQueueHandle xSemaphoreHandle;
                        // code these would not be just sequential calls as this would make\r
                        // no sense.  Instead the calls are likely to be buried inside\r
                        // a more complex call structure.\r
-            xSemaphoreTakeRecursive( xSemaphore, ( portTickType ) 10 );\r
-            xSemaphoreTakeRecursive( xSemaphore, ( portTickType ) 10 );\r
+            xSemaphoreTakeRecursive( xMutex, ( portTickType ) 10 );\r
+            xSemaphoreTakeRecursive( xMutex, ( portTickType ) 10 );\r
 \r
             // The mutex has now been 'taken' three times, so will not be \r
                        // available to another task until it has also been given back\r
@@ -401,9 +401,9 @@ typedef xQueueHandle xSemaphoreHandle;
                        // these calls sequentially, it would be more likely that the calls\r
                        // to xSemaphoreGiveRecursive() would be called as a call stack\r
                        // unwound.  This is just for demonstrative purposes.\r
-            xSemaphoreGiveRecursive( xSemaphore );\r
-                       xSemaphoreGiveRecursive( xSemaphore );\r
-                       xSemaphoreGiveRecursive( xSemaphore );\r
+            xSemaphoreGiveRecursive( xMutex );\r
+                       xSemaphoreGiveRecursive( xMutex );\r
+                       xSemaphoreGiveRecursive( xMutex );\r
 \r
                        // Now the mutex can be taken by other tasks.\r
         }\r