share/man/man4/coretemp.4

   1 .\"-
   2 .\" Copyright (c) 2007 Dag-Erling Coïdan Smørgrav
   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: src/share/man/man4/coretemp.4,v 1.5 2011/05/22 14:03:30 uqs Exp $
  27 .\"
  28 .Dd May 24, 2015
  29 .Dt CORETEMP 4
  30 .Os
  31 .Sh NAME
  32 .Nm coretemp
  33 .Nd device driver for Intel Core on-die digital thermal sensor
  34 .Sh SYNOPSIS
  35 To compile this driver into the kernel,
  36 place the following line in your
  37 kernel configuration file:
  38 .Bd -ragged -offset indent
  39 .Cd "device coretemp"
  40 .Ed
  41 .Pp
  42 Alternatively, to load the driver as a
  43 module at boot time, place the following line in
  44 .Xr loader.conf 5 :
  45 .Bd -literal -offset indent
  46 coretemp_load="YES"
  47 .Ed
  48 .Sh DESCRIPTION
  49 The
  50 .Nm
  51 driver provides support for the on-die digital thermal sensors,
  52 both core level and package level,
  53 for Intel Core and newer CPUs.
  54 The values are exposed through the
  55 .Dv HW_SENSORS
  56 .Xr sysctl 3
  57 tree.
  58 For example:
  59 .Bd -literal -offset indent
  60 % sysctl hw.sensors
  61 hw.sensors.cpu0.temp0: 50.00 degC (node0 core0 temp), OK
  62 hw.sensors.cpu1.temp0: 50.00 degC (node0 core0 temp), OK
  63 hw.sensors.cpu2.temp0: 47.00 degC (node0 core1 temp), OK
  64 hw.sensors.cpu3.temp0: 47.00 degC (node0 core1 temp), OK
  65 hw.sensors.cpu_node0.temp0: 50.00 degC (node0 temp), OK
  66 .Ed
  67 .Pp
  68 If the core or package temperature reaches critical level,
  69 a notify event will be sent using
  70 .Xr devctl 4 .
  71 .Sh SEE ALSO
  72 .Xr systat 1 ,
  73 .Xr sysctl 3 ,
  74 .Xr devctl 4 ,
  75 .Xr devd 8 ,
  76 .Xr sensorsd 8 ,
  77 .Xr sysctl 8
  78 .Sh HISTORY
  79 The
  80 .Nm
  81 driver first appeared in
  82 .Fx 7.0 .
  83 .Sh AUTHORS
  84 .An -nosplit
  85 The
  86 .Nm
  87 driver was written by
  88 .An Rui Paulo Aq Mt rpaulo@FreeBSD.org
  89 as part of a Google Summer of Code project.
  90 This manual page was written by
  91 .An Dag-Erling Sm\(/orgrav Aq Mt des@FreeBSD.org .