devs/foxbox
1
0
Fork 0
forked from len0rd/rockbox
Code Pull requests Activity

Add comments source comments about the behavior of yield and sleep.

Browse source 
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@31288 a1c6a512-1295-4272-9138-f99709370657
This commit is contained in:
Michael Sevakis 2011-12-15 19:57:08 +00:00
parent c8d45e0b1c
commit 5334379cd4
1 changed files with 14 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

14
firmware/kernel.c
View file

@ -224,6 +224,17 @@ void timeout_register(struct timeout *tmo, timeout_cb_type callback,
/**************************************************************************** /****************************************************************************
* Thread stuff * Thread stuff
****************************************************************************/ ****************************************************************************/
/* Suspends a thread's execution for at least the specified number of ticks.
* May result in CPU core entering wait-for-interrupt mode if no other thread
* may be scheduled.
*
* NOTE: sleep(0) sleeps until the end of the current tick
* sleep(n) that doesn't result in rescheduling:
* n <= ticks suspended < n + 1
* n to n+1 is a lower bound. Other factors may affect the actual time
* a thread is suspended before it runs again.
*/
unsigned sleep(unsigned ticks) unsigned sleep(unsigned ticks)
{ {
/* In certain situations, certain bootloaders in particular, a normal /* In certain situations, certain bootloaders in particular, a normal
@ -237,6 +248,9 @@ unsigned sleep(unsigned ticks)
return 0; return 0;
} }
/* Elects another thread to run or, if no other thread may be made ready to
* run, immediately returns control back to the calling thread.
*/
void yield(void) void yield(void)
{ {
/* In certain situations, certain bootloaders in particular, a normal /* In certain situations, certain bootloaders in particular, a normal