summaryrefslogtreecommitdiffstats
path: root/cpukit/libmisc/cpuuse/README
diff options
context:
space:
mode:
Diffstat (limited to 'cpukit/libmisc/cpuuse/README')
-rw-r--r--cpukit/libmisc/cpuuse/README21
1 files changed, 21 insertions, 0 deletions
diff --git a/cpukit/libmisc/cpuuse/README b/cpukit/libmisc/cpuuse/README
new file mode 100644
index 0000000000..ac674bb0b6
--- /dev/null
+++ b/cpukit/libmisc/cpuuse/README
@@ -0,0 +1,21 @@
+#
+# $Id$
+#
+
+This directory contains code to report and reset per-task CPU usage.
+If the BSP supports nanosecond timestamp granularity, this this information
+is very accurate. Otherwise, it is dependendent on the tick granularity.
+
+It provides two primary features:
+
+ + Generate a CPU Usage Report
+ + Reset CPU Usage Information
+
+NOTES:
+
+1. If configured for tick granularity, CPU usage is "docked" by a
+ clock tick at each context switch.
+2. If configured for nanosecond granularity, no work is done at each
+ clock tick. All bookkeeping is done as part of a context switch.
+
+