about summary refs log tree commit diff
path: root/manual/platform.texi
diff options
context:
space:
mode:
authorTulio Magno Quites Machado Filho <tuliom@linux.vnet.ibm.com>2012-06-04 13:46:37 -0500
committerRyan S. Arnold <rsa@linux.vnet.ibm.com>2012-06-04 13:46:37 -0500
commitd9dc34cd569bcfe714fe8c708e58c028106e8b2e (patch)
tree82c7c02aab8419ffd869c72b1b5644b1dae6eb38 /manual/platform.texi
parent06775cb82b8c8381ea0cc636a70ed9e7ca81b548 (diff)
downloadglibc-d9dc34cd569bcfe714fe8c708e58c028106e8b2e.tar.gz
glibc-d9dc34cd569bcfe714fe8c708e58c028106e8b2e.tar.xz
glibc-d9dc34cd569bcfe714fe8c708e58c028106e8b2e.zip
Manual for platform-specific features and new __ppc_get_timebase inline.
[BZ #13743]
A new class of installed headers has been documented for low-level
platform-specific functionality.  PowerPC added the first instance with a
function to provide time base register access (__ppc_get_timebase).  This
is required for applications that measure time at high frequencies with
high precision that can't afford a syscall.
Diffstat (limited to 'manual/platform.texi')
-rw-r--r--manual/platform.texi28
1 files changed, 28 insertions, 0 deletions
diff --git a/manual/platform.texi b/manual/platform.texi
new file mode 100644
index 0000000000..02b5c554ab
--- /dev/null
+++ b/manual/platform.texi
@@ -0,0 +1,28 @@
+@node Platform, Contributors, Maintenance, Top
+@c %MENU% Describe all platform-specific facilities provided
+@appendix Platform-specific facilities
+
+@Theglibc{} can provide machine-specific functionality.
+
+@menu
+* PowerPC::           Facilities Specific to the PowerPC Architecture
+@end menu
+
+@node PowerPC
+@appendixsec PowerPC-specific Facilities
+
+Facilities specific to PowerPC that are not specific to a particular
+operating system are declared in @file{sys/platform/ppc.h}.
+
+@deftypefun {uint64_t} __ppc_get_timebase (void)
+Read the current value of the Time Base Register.
+
+The @dfn{Time Base Register} is a 64-bit register that stores a monotonically
+incremented value updated at a system-dependent frequency that may be
+different from the processor frequency.  More information is available in
+@cite{Power ISA 2.06b - Book II - Section 5.2}.
+
+@code{__ppc_get_timebase} uses the processor's time base facility directly
+without requiring assistance from the operating system, so it is very
+efficient.
+@end deftypefun