len0rd/FreeRTOS-Kernel
1
0
Fork 0
mirror of https://github.com/FreeRTOS/FreeRTOS-Kernel.git synced 2025-04-25 16:01:59 -04:00
Code Issues Packages Projects Releases Wiki Activity

list.c: improve code comments to point to official documentation about problems which may cause code to get stuck inside of list.c (#1051)

Browse source 
list.c: improve documentation about initializing binary semaphores
This commit is contained in:
Gabriel Staples 2024-05-13 04:19:50 -07:00 committed by GitHub
parent 55eceb2203
commit 29b202a41e
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 11 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
list.c
View file

@ -184,7 +184,14 @@ void vListInsert( List_t * const pxList,
* 4) Using a queue or semaphore before it has been initialised or * 4) Using a queue or semaphore before it has been initialised or
* before the scheduler has been started (are interrupts firing * before the scheduler has been started (are interrupts firing
* before vTaskStartScheduler() has been called?). * before vTaskStartScheduler() has been called?).
* 5) If the FreeRTOS port supports interrupt nesting then ensure that * 5) Attempting to 'take' binary semaphores created using
* `xSemaphoreCreateBinary()` or `xSemaphoreCreateBinaryStatic()`
* APIs, before 'giving' them. Binary semaphores created using
* `xSemaphoreCreateBinary()` or `xSemaphoreCreateBinaryStatic()`,
* are created in a state such that the semaphore must first be
* 'given' using xSemaphoreGive() API before it can be 'taken' using
* xSemaphoreTake() API.
* 6) If the FreeRTOS port supports interrupt nesting then ensure that
* the priority of the tick interrupt is at or below * the priority of the tick interrupt is at or below
* configMAX_SYSCALL_INTERRUPT_PRIORITY. * configMAX_SYSCALL_INTERRUPT_PRIORITY.
**********************************************************************/ **********************************************************************/
@ -192,7 +199,9 @@ void vListInsert( List_t * const pxList,
for( pxIterator = ( ListItem_t * ) &( pxList->xListEnd ); pxIterator->pxNext->xItemValue <= xValueOfInsertion; pxIterator = pxIterator->pxNext ) for( pxIterator = ( ListItem_t * ) &( pxList->xListEnd ); pxIterator->pxNext->xItemValue <= xValueOfInsertion; pxIterator = pxIterator->pxNext )
{ {
/* There is nothing to do here, just iterating to the wanted /* There is nothing to do here, just iterating to the wanted
* insertion position. */ * insertion position.
* IF YOU FIND YOUR CODE STUCK HERE, SEE THE NOTE JUST ABOVE.
*/
} }
} }