Sync usage with man page.
[netbsd-mini2440.git] / share / man / man4 / amdtemp.4
blob718b2777c7ebbc16586b2b6f43b7a2cd1f74041f
1 .\" $NetBSD: amdtemp.4,v 1.3 2008/11/20 10:09:06 jnemeth Exp $
2 .\"-
3 .\" Copyright (c) 2008 Christoph Egger
4 .\" All rights reserved.
5 .\"
6 .\" Redistribution and use in source and binary forms, with or without
7 .\" modification, are permitted provided that the following conditions
8 .\" are met:
9 .\" 1. Redistributions of source code must retain the above copyright
10 .\"    notice, this list of conditions and the following disclaimer.
11 .\" 2. Redistributions in binary form must reproduce the above copyright
12 .\"    notice, this list of conditions and the following disclaimer in the
13 .\"    documentation and/or other materials provided with the distribution.
14 .\"
15 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25 .\" SUCH DAMAGE.
26 .\"
27 .\" $FreeBSD: src/share/man/man4/coretemp.4,v 1.4 2007/10/15 20:00:19 netchild Exp $
28 .\"
29 .Dd November 19, 2008
30 .Dt AMDTEMP 4
31 .Os
32 .Sh NAME
33 .Nm amdtemp
34 .Nd AMD CPU on-die digital thermal sensor
35 .Sh SYNOPSIS
36 .Cd "amdtemp* at pci? dev ? function ?"
37 .Sh DESCRIPTION
38 The
39 .Nm
40 driver provides support for the on-die digital thermal sensor present
41 on AMD K8, AMD Barcelona, AMD Phenoms, and AMD Griffin CPUs.
42 .Pp
43 These sensors were officially introduced in AMD K8 Revision F processors,
44 and provide 0.5 degC accuracy.
45 Precision was improved in Revision
46 G chips, which provide two more bits for 0.25 degC steppings.
47 Each core
48 has two temperature sensors, and there are up to two cores per CPU socket.
49 .Pp
50 AMD Barcelona, AMD Phenom, and AMD Griffin provide 0.125 degC accuracy
51 and provide one temperature sensor for each CPU socket.
52 .Pp
53 The
54 .Nm
55 driver reports temperatures through the
56 .Xr envsys 4
57 API.
58 .Bl -column "Sensor    " "Units" "Typical" -offset indent
59 .It Sy "Sensor     " Ta Sy "Units" Ta Sy "Typical Use"
60 .It Li "CPUN sensor0" Ta "uK" Ta "cpuN temperature"
61 .El
62 .Sh SEE ALSO
63 .Xr envsys 4 ,
64 .Xr envstat 8 ,
65 .Xr powerd 8
66 .Sh HISTORY
67 The
68 .Nm
69 driver first appeared in
70 .Ox 4.4
71 named
72 .Dq kate .
73 It was then ported to
74 .Nx 5.0 .
75 The driver has been renamed with support for newer AMD CPUs.
76 .Sh AUTHORS
77 .An -nosplit
78 The
79 .Nm
80 driver was written by
81 .An Constantine A. Murenin Aq cnst@openbsd.org
82 whilst at the University of Waterloo.
83 It was adapted to
84 .Nx
86 .An Christoph Egger .