share/man/man4/memtemp.4

   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 April 4, 2015
  32 .Dt MEMTEMP 4
  33 .Os
  34 .Sh NAME
  35 .Nm memtemp
  36 .Nd device driver for memory thermal sensor
  37 .Sh SYNOPSIS
  38 To compile this driver into the kernel,
  39 place 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
  46 Alternatively, to load the driver as a
  47 module at boot time, place the following line in
  48 .Xr loader.conf 5 :
  49 .Bd -literal -offset indent
  50 memtemp_load="YES"
  51 .Ed
  52 .Sh DESCRIPTION
  53 The
  54 .Nm
  55 driver provides support for the memory thermal sensor.
  56 The values are exposed through the
  57 .Dv HW_SENSORS
  58 .Xr sysctl 3
  59 tree.
  60 For example:
  61 .Bd -literal -offset indent
  62 % sysctl hw.sensors
  63 hw.sensors.dimm0.temp0: 40.00 degC (node0 chan0 DIMM0), OK
  64 hw.sensors.dimm1.temp0: 39.00 degC (node0 chan1 DIMM0), OK
  65 .Ed
  66 .Pp
  67 The DIMM location and configurable critical temperature thresholds
  68 are exposed through hw.dimminfo
  69 .Xr sysctl 3
  70 tree.
  71 For example:
  72 .Bd -literal -offset indent
  73 % sysctl hw.dimminfo
  74 hw.dimminfo.dimm0.node: 0
  75 hw.dimminfo.dimm0.chan: 0
  76 hw.dimminfo.dimm0.slot: 0
  77 hw.dimminfo.dimm0.temp_hiwat: 93
  78 hw.dimminfo.dimm0.temp_lowat: 88
  79 hw.dimminfo.dimm1.node: 0
  80 hw.dimminfo.dimm1.chan: 1
  81 hw.dimminfo.dimm1.slot: 0
  82 hw.dimminfo.dimm1.temp_hiwat: 93
  83 hw.dimminfo.dimm1.temp_lowat: 88
  84 .Ed
  85 .Sh HARDWARE
  86 The
  87 .Nm
  88 driver supports the following memory thermal sensors:
  89 .Pp
  90 .Bl -bullet -compact
  91 .It
  92 Intel E5 v2 memory thermal sensors
  93 .It
  94 Intel E5 v3 memory thermal sensors
  95 .It
  96 Intel E3 v3 memory thermal sensors
  97 .It
  98 Intel Core i3/i5/i7 Haswell thermal sensors
  99 .El
 100 .Sh SEE ALSO
 101 .Xr systat 1 ,
 102 .Xr sysctl 3 ,
 103 .Xr sensorsd 8 ,
 104 .Xr sysctl 8
 105 .Sh HISTORY
 106 The
 107 .Nm
 108 driver first appeared in
 109 .Dx 4.1 .
 110 .Sh AUTHORS
 111 .An -nosplit
 112 The
 113 .Nm
 114 driver was written by
 115 .An Sepherosa Ziehau Aq Mt sepherosa@gmail.com .