kate(4) and km(4): temperature sensors for AMD Family 0Fh, 10h and 11h AMD64 processors
[dragonfly.git] / share / man / man4 / kate.4
1 .\"     $OpenBSD: kate.4,v 1.1 2008/03/27 01:54:44 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 KATE 4
19 .Os
20 .Sh NAME
21 .Nm kate
22 .Nd AMD K8 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 kate"
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 kate_load="YES"
36 .Ed
37 .Sh DESCRIPTION
38 The
39 .Nm
40 driver provides support for the temperature sensors available in the
41 AMD K8 family of processors.
42 (Subsequent AMD families are supported by
43 .Xr km 4 . )
44 .Pp
45 These sensors were officially introduced with
46 Revision F Family 0Fh processors,
47 and provide 1 degC accuracy.
48 Precision was improved in Revision G chips,
49 which provide two more bits for 0.25 degC steppings.
50 Each core may have two temperature sensors, and
51 there may be up to two cores per package.
52 .Pp
53 Multiprocessor systems would have one instance of
54 .Nm
55 per each chip.
56 In each instance,
57 .Va temp0
58 and
59 .Va temp1
60 sensors
61 correspond to the temperature sensors on the first core,
62 whereas
63 .Va temp2
64 and
65 .Va temp3
66 correspond to the temperature sensors on the second core.
67 As such, single core chips may have two sensors,
68 and dual-core dual-processor systems may have as many as 8
69 temperature sensors in total.
70 .Pp
71 Since many prior revisions of the chips appear to have
72 valid readings for at least some temperature sensors
73 in the same address space as the abovementioned revisions,
74 the driver may also attach on such older revisions provided
75 that it finds some sensor readings that appear valid.
76 However, in such cases
77 .Nm
78 would not print the core revision information into the dmesg.
79 .Pp
80 Sensor values are made available through the
81 .Dv HW_SENSORS
82 .Xr sysctl 3
83 interface,
84 and can be monitored with the
85 .Xr systat 1
86 .Ar sensors
87 display,
88 .Xr sensorsd 8
89 and
90 .Xr sysctl 8
91 .Ar hw.sensors .
92 .Sh SEE ALSO
93 .Xr systat 1 ,
94 .Xr sysctl 3 ,
95 .Xr intro 4 ,
96 .Xr km 4 ,
97 .Xr pci 4 ,
98 .Xr sensorsd 8 ,
99 .Xr sysctl 8
100 .Rs
101 .%T "BIOS and Kernel Developer's Guide for AMD NPT Family 0Fh Processors"
102 .%D July 2007
103 .%R Publication # 32559
104 .%P pp. 21--23 and pp. 179--184
105 .\" .%O http://www.amd.com/us-en/assets/content_type/white_papers_and_tech_docs/32559.pdf
106 .Re
107 .Rs
108 .%T "Revision Guide for AMD NPT Family 0Fh Processors"
109 .%D February 2008
110 .%R Publication # 33610
111 .\" .%O http://www.amd.com/us-en/assets/content_type/white_papers_and_tech_docs/33610.pdf
112 .Re
113 .Sh HISTORY
114 The
115 .Nm
116 driver first appeared in
117 .Ox 4.4
118 and
119 .Dx 2.5.1 .
120 .Sh AUTHORS
121 The
122 .Nm
123 driver was written for
124 .Ox
125 and
126 .Dx
127 by
128 .An Constantine A. Murenin
129 whilst at the University of Waterloo.