summaryrefslogtreecommitdiffstats
path: root/cpukit
diff options
context:
space:
mode:
authorJoel Sherrill <joel.sherrill@OARcorp.com>2010-06-15 15:52:29 +0000
committerJoel Sherrill <joel.sherrill@OARcorp.com>2010-06-15 15:52:29 +0000
commit1e2216c63d6f59732cea9ddbf7364cdab36bea66 (patch)
treee5ba68d860d2269faca0609d2b12225b84df6501 /cpukit
parent2010-06-15 Ralf Corsépius <ralf.corsepius@rtems.org> (diff)
downloadrtems-1e2216c63d6f59732cea9ddbf7364cdab36bea66.tar.bz2
2010-06-15 Joel Sherrill <joel.sherrill@oarcorp.com>
* posix/include/rtems/posix/pthread.h: Improve comments.
Diffstat (limited to 'cpukit')
-rw-r--r--cpukit/ChangeLog4
-rw-r--r--cpukit/posix/include/rtems/posix/pthread.h15
2 files changed, 15 insertions, 4 deletions
diff --git a/cpukit/ChangeLog b/cpukit/ChangeLog
index ed9a306463..61a7000d6f 100644
--- a/cpukit/ChangeLog
+++ b/cpukit/ChangeLog
@@ -1,3 +1,7 @@
+2010-06-15 Joel Sherrill <joel.sherrill@oarcorp.com>
+
+ * posix/include/rtems/posix/pthread.h: Improve comments.
+
2010-06-15 Ralf Corsépius <ralf.corsepius@rtems.org>
* libfs/src/rfs/rtems-rfs-file-system.h: Remove bogus typecast.
diff --git a/cpukit/posix/include/rtems/posix/pthread.h b/cpukit/posix/include/rtems/posix/pthread.h
index aed74f4353..6185afa62c 100644
--- a/cpukit/posix/include/rtems/posix/pthread.h
+++ b/cpukit/posix/include/rtems/posix/pthread.h
@@ -128,10 +128,17 @@ void _POSIX_Threads_Sporadic_budget_callout(
/**
* _POSIX_Threads_Sporadic_budget_TSR
*
- * This routine supports the sporadic scheduling algorithm.
- *
- * @param[in] id
- * @param[in] argument
+ * This routine supports the sporadic scheduling algorithm. It
+ * is scheduled to be executed at the end of each replenishment
+ * period. In sporadic scheduling a thread will execute at a
+ * high priority for a user specified amount of CPU time. When
+ * it exceeds that amount of CPU time, its priority is automatically
+ * lowered. This TSR is executed when it is time to replenish
+ * the thread's processor budget and raise its priority.
+ *
+ * @param[in] id is ignored
+ * @param[in] argument is a pointer to the Thread_Control structure
+ * for the thread being replenished.
*/
void _POSIX_Threads_Sporadic_budget_TSR(
Objects_Id id,