/share/man/man4/amdtemp.4

  1.\"-
  2.\" Copyright (c) 2008 Rui Paulo
  3.\" All rights reserved.
  4.\"
  5.\" Redistribution and use in source and binary forms, with or without
  6.\" modification, are permitted provided that the following conditions
  7.\" are met:
  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 the
 12.\"    documentation and/or other materials provided with the distribution.
 13.\"
 14.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
 15.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 16.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 17.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
 18.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 19.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 20.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 21.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 22.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 23.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 24.\" SUCH DAMAGE.
 25.\"
 26.\" $FreeBSD$
 27.\"
 28.Dd February 23, 2012
 29.Dt AMDTEMP 4
 30.Os
 31.Sh NAME
 32.Nm amdtemp
 33.Nd device driver for
 34.Tn AMD
 35processor on-die digital thermal sensor
 36.Sh SYNOPSIS
 37To compile this driver into the kernel,
 38place the following line in your
 39kernel configuration file:
 40.Bd -ragged -offset indent
 41.Cd "device amdtemp"
 42.Ed
 43.Pp
 44Alternatively, to load the driver as a
 45module at boot time, place the following line in
 46.Xr loader.conf 5 :
 47.Bd -literal -offset indent
 48amdtemp_load="YES"
 49.Ed
 50.Sh DESCRIPTION
 51The
 52.Nm
 53driver provides support for the on-die digital thermal sensor present
 54in
 55.Tn AMD
 56Family 0Fh, 10h, 11h, 12h, 14h, and 15h processors.
 57.Pp
 58For Family 0Fh processors, the
 59.Nm
 60driver reports each core's temperature through sysctl nodes, named
 61.Va dev.amdtemp.%d.core{0,1}.sensor{0,1} .
 62The driver also creates
 63.Va dev.cpu.%d.temperature
 64in the corresponding CPU device's sysctl tree, displaying the maximum
 65temperature of the two sensors located in each CPU core.
 66.Pp
 67For Family 10h, 11h, 12h, 14h, and 15h processors, the driver reports each
 68package's temperature through a sysctl node, named
 69.Va dev.amdtemp.%d.core0.sensor0 .
 70The driver also creates
 71.Va dev.cpu.%d.temperature
 72in the corresponding CPU device's sysctl tree, displaying the temperature
 73of the shared sensor located in each CPU package.
 74.Sh SYSCTL VARIABLES
 75The following variable is available as both
 76.Xr sysctl 8
 77variable and
 78.Xr loader 8
 79tunable:
 80.Bl -tag -width indent
 81.It Va dev.amdtemp.%d.sensor_offset
 82.El
 83Add the given offset to the temperature of the sensor.
 84Default is 0.
 85.Sh SEE ALSO
 86.Xr loader 8 ,
 87.Xr sysctl 8
 88.Sh HISTORY
 89The
 90.Nm
 91driver first appeared in
 92.Fx 7.1 .
 93.Sh AUTHORS
 94.An Rui Paulo Aq rpaulo@FreeBSD.org
 95.An Norikatsu Shigemura Aq nork@FreeBSD.org
 96.An Jung-uk Kim Aq jkim@FreeBSD.org
 97.Sh CAVEATS
 98For Family 10h and later processors,
 99.Do
100(the reported temperature) is a non-physical temperature measured on
101an arbitrary scale and it does not represent an actual physical
102temperature like die or case temperature.
103Instead, it specifies the processor temperature relative to the point
104at which the system must supply the maximum cooling for the processor's
105specified maximum case temperature and maximum thermal power dissipation
106.Dc
107according to
108.Rs
109.%T BIOS and Kernel Developer's Guide (BKDG) for AMD Processors
110.%U http://developer.amd.com/documentation/guides/Pages/default.aspx
111.Re