xref: /dragonfly/share/man/man4/memtemp.4 (revision cd1c6085)
1.\"
2.\" Copyright (c) 2015 The DragonFly Project.  All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\"
8.\" 1. Redistributions of source code must retain the above copyright
9.\"    notice, this list of conditions and the following disclaimer.
10.\" 2. Redistributions in binary form must reproduce the above copyright
11.\"    notice, this list of conditions and the following disclaimer in
12.\"    the documentation and/or other materials provided with the
13.\"    distribution.
14.\" 3. Neither the name of The DragonFly Project nor the names of its
15.\"    contributors may be used to endorse or promote products derived
16.\"    from this software without specific, prior written permission.
17.\"
18.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20.\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
21.\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
22.\" COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
23.\" INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
24.\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
25.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
26.\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
27.\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
28.\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29.\" SUCH DAMAGE.
30.\"
31.Dd May 24, 2015
32.Dt MEMTEMP 4
33.Os
34.Sh NAME
35.Nm memtemp
36.Nd device driver for memory thermal sensor
37.Sh SYNOPSIS
38To compile this driver into the kernel,
39place the following lines in your kernel configuration file:
40.Bd -ragged -offset indent
41.Cd "device dimm"
42.Cd "device coremctl"
43.Cd "device memtemp"
44.Ed
45.Pp
46Alternatively, to load the driver as a
47module at boot time, place the following line in
48.Xr loader.conf 5 :
49.Bd -literal -offset indent
50memtemp_load="YES"
51.Ed
52.Sh DESCRIPTION
53The
54.Nm
55driver provides support for the memory thermal sensor.
56The values are exposed through the
57.Dv HW_SENSORS
58.Xr sysctl 3
59tree.
60For example:
61.Bd -literal -offset indent
62% sysctl hw.sensors
63hw.sensors.dimm0.temp0: 40.00 degC (node0 chan0 DIMM0 temp), OK
64hw.sensors.dimm1.temp0: 39.00 degC (node0 chan1 DIMM0 temp), OK
65.Ed
66.Pp
67The DIMM location and configurable critical temperature thresholds
68are exposed through hw.dimminfo
69.Xr sysctl 3
70tree.
71For example:
72.Bd -literal -offset indent
73% sysctl hw.dimminfo
74hw.dimminfo.dimm0.node: 0
75hw.dimminfo.dimm0.chan: 0
76hw.dimminfo.dimm0.slot: 0
77hw.dimminfo.dimm0.temp_hiwat: 93
78hw.dimminfo.dimm0.temp_lowat: 88
79hw.dimminfo.dimm1.node: 0
80hw.dimminfo.dimm1.chan: 1
81hw.dimminfo.dimm1.slot: 0
82hw.dimminfo.dimm1.temp_hiwat: 93
83hw.dimminfo.dimm1.temp_lowat: 88
84.Ed
85.Pp
86If the temperature goes above the configured critical temperature threshold
87(temp_hiwat),
88a notify event will be sent using
89.Xr devctl 4 .
90.Sh HARDWARE
91The
92.Nm
93driver supports the following memory thermal sensors:
94.Pp
95.Bl -bullet -compact
96.It
97Intel E5 v2 memory thermal sensors
98.It
99Intel E5 v3 memory thermal sensors
100.It
101Intel E3 v3 memory thermal sensors
102.It
103Intel Core i3/i5/i7 Haswell thermal sensors
104.El
105.Sh SEE ALSO
106.Xr systat 1 ,
107.Xr sysctl 3 ,
108.Xr devctl 4 ,
109.Xr devd 8 ,
110.Xr sensorsd 8 ,
111.Xr sysctl 8
112.Sh HISTORY
113The
114.Nm
115driver first appeared in
116.Dx 4.1 .
117.Sh AUTHORS
118.An -nosplit
119The
120.Nm
121driver was written by
122.An Sepherosa Ziehau Aq Mt sepherosa@gmail.com .
123