xref: /dflybsd-src/share/man/man4/memtemp.4 (revision fb3c2c0caaaa0e5d800e088b7dd7983e9ab009ec)

.\"
.\" Copyright (c) 2015 The DragonFly Project.  All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\"
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in
.\"    the documentation and/or other materials provided with the
.\"    distribution.
.\" 3. Neither the name of The DragonFly Project nor the names of its
.\"    contributors may be used to endorse or promote products derived
.\"    from this software without specific, prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
.\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
.\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
.\" COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
.\" INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
.\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
.\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
.\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
.\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.Dd May 24, 2015
.Dt MEMTEMP 4
.Os
.Sh NAME
.Nm memtemp
.Nd device driver for memory thermal sensor
.Sh SYNOPSIS
To compile this driver into the kernel,
place the following lines in your kernel configuration file:
.Bd -ragged -offset indent
.Cd "device dimm"
.Cd "device coremctl"
.Cd "device memtemp"
.Ed
.Pp
Alternatively, to load the driver as a
module at boot time, place the following line in
.Xr loader.conf 5 :
.Bd -literal -offset indent
memtemp_load="YES"
.Ed
.Sh DESCRIPTION
The
.Nm
driver provides support for the memory thermal sensor.
The values are exposed through the
.Dv HW_SENSORS
.Xr sysctl 3
tree.
For example:
.Bd -literal -offset indent
% sysctl hw.sensors
hw.sensors.dimm0.temp0: 40.00 degC (node0 chan0 DIMM0 temp), OK
hw.sensors.dimm1.temp0: 39.00 degC (node0 chan1 DIMM0 temp), OK
.Ed
.Pp
The DIMM location and configurable critical temperature thresholds
are exposed through hw.dimminfo
.Xr sysctl 3
tree.
For example:
.Bd -literal -offset indent
% sysctl hw.dimminfo
hw.dimminfo.dimm0.node: 0
hw.dimminfo.dimm0.chan: 0
hw.dimminfo.dimm0.slot: 0
hw.dimminfo.dimm0.temp_hiwat: 93
hw.dimminfo.dimm0.temp_lowat: 88
hw.dimminfo.dimm1.node: 0
hw.dimminfo.dimm1.chan: 1
hw.dimminfo.dimm1.slot: 0
hw.dimminfo.dimm1.temp_hiwat: 93
hw.dimminfo.dimm1.temp_lowat: 88
.Ed
.Pp
If the temperature goes above the configured critical temperature threshold
(temp_hiwat),
a notify event will be sent using
.Xr devctl 4 .
.Sh HARDWARE
The
.Nm
driver supports the following memory thermal sensors:
.Pp
.Bl -bullet -compact
.It
Intel E5 v2 memory thermal sensors
.It
Intel E5 v3 memory thermal sensors
.It
Intel E3 v3 memory thermal sensors
.It
Intel Core i3/i5/i7 Haswell thermal sensors
.El
.Sh SEE ALSO
.Xr systat 1 ,
.Xr sysctl 3 ,
.Xr devctl 4 ,
.Xr devd 8 ,
.Xr sensorsd 8 ,
.Xr sysctl 8
.Sh HISTORY
The
.Nm
driver first appeared in
.Dx 4.1 .
.Sh AUTHORS
.An -nosplit
The
.Nm
driver was written by
.An Sepherosa Ziehau Aq Mt sepherosa@gmail.com .