espressif/esp-idf
1
0
Fork 1
mirror of https://github.com/espressif/esp-idf.git synced 2025-08-05 13:44:32 +02:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'docs/fix_static_sem_api_desc' into 'master'

Browse Source 
Fix usage example in xSemaphoreCreateBinaryStatic

Closes IDFGH-3280

See merge request espressif/esp-idf!8750
This commit is contained in:
Angus Gratton
2020-05-15 15:04:36 +08:00
parent 26ab1c54ec ecbfe0f406
commit 62754ff90a
1 changed files with 3 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
components/freertos/include/freertos/semphr.h
View File

@@ -235,13 +235,14 @@ typedef QueueHandle_t SemaphoreHandle_t;
* *
* void vATask( void * pvParameters ) * void vATask( void * pvParameters )
* { * {
* // Semaphore cannot be used before a call to xSemaphoreCreateBinary(). * // Semaphore cannot be used before a call to xSemaphoreCreateBinary() or
* // xSemaphoreCreateBinaryStatic().
* // The semaphore's data structures will be placed in the xSemaphoreBuffer * // The semaphore's data structures will be placed in the xSemaphoreBuffer
* // variable, the address of which is passed into the function. The * // variable, the address of which is passed into the function. The
* // function's parameter is not NULL, so the function will not attempt any * // function's parameter is not NULL, so the function will not attempt any
* // dynamic memory allocation, and therefore the function will not return * // dynamic memory allocation, and therefore the function will not return
* // return NULL. * // return NULL.
* xSemaphore = xSemaphoreCreateBinary( &xSemaphoreBuffer ); * xSemaphore = xSemaphoreCreateBinaryStatic( &xSemaphoreBuffer );
* *
* // Rest of task code goes here. * // Rest of task code goes here.
* } * }