kate(4) and km(4): temperature sensors for AMD Family 0Fh, 10h and 11h AMD64 processors
[dragonfly.git] / share / man / man4 / km.4
1 .\"     $OpenBSD: km.4,v 1.5 2009/07/23 17:19:07 cnst Exp $
2 .\"
3 .\" Copyright (c) 2008/2010 Constantine A. Murenin <cnst+dfly@bugmail.mojo.ru>
4 .\"
5 .\" Permission to use, copy, modify, and distribute this software for any
6 .\" purpose with or without fee is hereby granted, provided that the above
7 .\" copyright notice and this permission notice appear in all copies.
8 .\"
9 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16 .\"
17 .Dd February 12, 2010
18 .Dt KM 4
19 .Os
20 .Sh NAME
21 .Nm km
22 .Nd AMD K10 temperature sensor
23 .Sh SYNOPSIS
24 To compile this driver into the kernel,
25 place the following lines in your
26 kernel configuration file:
27 .Bd -ragged -offset indent
28 .Cd "device km"
29 .Ed
30 .Pp
31 Alternatively, to load the driver as a
32 module at boot time, place the following lines in
33 .Xr loader.conf 5 :
34 .Bd -literal -offset indent
35 km_load="YES"
36 .Ed
37 .Sh DESCRIPTION
38 The
39 .Nm
40 driver provides support for the temperature sensors available in the
41 AMD Family 10h and 11h processors.
42 .Pp
43 Each chip reports one temperature sensor.
44 Multiprocessor systems have one instance of
45 .Nm
46 per chip.
47 The highest resolution supported by the driver is 0.125 degC.
48 .Pp
49 Sensor values are made available through the
50 .Dv HW_SENSORS
51 .Xr sysctl 3
52 interface,
53 and can be monitored with the
54 .Xr systat 1
55 .Ar sensors
56 display,
57 .Xr sensorsd 8
58 and
59 .Xr sysctl 8
60 .Ar hw.sensors .
61 For example, with an
62 .Tn AMD
63 .Tn Phenom X4
64 9850 Black Edition 2.5GHz
65 .Tn Socket AM2+
66 125W quad-core processor:
67 .Bd -literal -offset indent
68 %sysctl hw.sensors.km0
69 hw.sensors.km0.temp0: 60.50 degC
70 .Ed
71 .Sh SEE ALSO
72 .Xr systat 1 ,
73 .Xr sysctl 3 ,
74 .Xr intro 4 ,
75 .Xr kate 4 ,
76 .Xr pci 4 ,
77 .Xr sensorsd 8 ,
78 .Xr sysctl 8
79 .Rs
80 .%T "BIOS and Kernel Developer's Guide for AMD Family 10h Processors"
81 .%D March 26, 2008
82 .%R Publication # 31116
83 .%P pp. 236--237 and pp. 243--244
84 .\" .%O http://www.amd.com/us-en/assets/content_type/white_papers_and_tech_docs/31116.PDF
85 .Re
86 .Rs
87 .%T "BIOS and Kernel Developer's Guide for AMD Family 11h Processors"
88 .%D July 07, 2008
89 .%R Publication # 41256
90 .%P pp. 156--157 and pp. 159--160
91 .\" .%O http://www.amd.com/us-en/assets/content_type/white_papers_and_tech_docs/41256.pdf
92 .Re
93 .Sh HISTORY
94 The
95 .Nm
96 driver first appeared in
97 .Ox 4.4
98 and
99 .Dx 2.5.1 .
100 .Sh AUTHORS
101 The
102 .Nm
103 driver was written for
104 .Ox
105 and
106 .Dx
107 by
108 .An Constantine A. Murenin Aq http://cnst.su/ ,
109 Raouf Boutaba Research Group,
110 David R. Cheriton School of Computer Science,
111 University of Waterloo.