share/man/man4/pchtherm.4

   1 .\"
   2 .\" Copyright (c) 2020 Takanori Watanabe <takawata@freebsd.org>
   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 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  14 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  15 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  16 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  17 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  18 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  19 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  20 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  21 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  22 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  23 .\"
  24 .\" $FreeBSD$
  25 .\"
  26 .Dd March 15, 2020
  27 .Dt pchtherm 4
  28 .Os
  29 .Sh NAME
  30 .Nm pchtherm
  31 .Nd Intel PCH thermal subsystem
  32 .Sh SYNOPSIS
  33 .Cd "device pci"
  34 .Cd "device pchtherm"
  35 .Sh DESCRIPTION
  36 The
  37 .Nm
  38 driver provides access to sensor data and configuration
  39 installed in Intel PCH chipset.
  40 .Nm
  41 configuration register.
  42 .Pp
  43 The access to
  44 .Nm
  45 data is made via the
  46 .Xr sysctl 8
  47 interface:
  48 .Bd -literal
  49 dev.pchtherm.0.ctt: 115.0C
  50 dev.pchtherm.0.temperature: 28.5C
  51 dev.pchtherm.0.t2temp: 91.0C
  52 dev.pchtherm.0.t1temp: 86.0C
  53 dev.pchtherm.0.t0temp: 81.0C
  54 dev.pchtherm.0.tahv: 83.0C
  55 dev.pchtherm.0.talv: 30.0C
  56 dev.pchtherm.0.pmtime: 32
  57 dev.pchtherm.0.pmtemp: 50.0C
  58 dev.pchtherm.0.%parent: pci0
  59 dev.pchtherm.0.%pnpinfo: vendor=0x8086 device=0x9d31 subvendor=0x17aa subdevice=0x2256 class=0x118000
  60 dev.pchtherm.0.%location: slot=20 function=2 dbsf=pci0:0:20:2
  61 dev.pchtherm.0.%driver: pchtherm
  62 dev.pchtherm.0.%desc: Skylake PCH Thermal Subsystem
  63 dev.pchtherm.%parent:
  64 .Ed
  65 .Bl -tag -width ".Va dev.pchtherm.%d.pch_hot_level"
  66 .It Va dev.pchtherm.%d.temperature
  67 Is the read-only value of the current temperature read by the sensor.
  68 .It Va dev.pchtherm.%d.ctt
  69 When the system reaches this temperature, it will shut down.
  70 This will not appear when this feature is disabled and locked down.
  71 .It Va dev.pchtherm.%d.t0temp
  72 When temperature is under this value, system will be in T0 state.
  73 .It Va dev.pchtherm.%d.t1temp
  74 When temperature is over
  75 .Va t0temp
  76 and under this value, system will be in T1 state.
  77 .It Va dev.pchtherm.%d.t2temp
  78 When temperature is over
  79 .Va t1temp
  80 and under this value, system will be in T2 state.
  81 Over this value, system will be in T3 state.
  82 .It Va dev.pchtherm.%d.talv
  83 Lower alart value.
  84 This will not appear when sensor enable bit is locked down and the value is zero(which will show -50.0C).
  85 .It Va dev.pchtherm.%d.tahv
  86 High alart value.
  87 This will not appear when sensor enable bit is locked down and the value is zero(which will show -50.0C).
  88 .It Va dev.pchtherm.%d.pmtemp
  89 Sensor Power management temperature.
  90 Under this temperature, sensor will idle during
  91 .Va pmtime
  92 second.
  93 .It Va dev.pchtherm.%d.pmtime
  94 Sensor idle duration when low temperature.
  95 .It Va dev.pchtherm.%d.pch_hot_level
  96 When temperature is higher than this value, PCHHOT# pin will assert.
  97 This value is not appear when this feature is disabled and locked down.
  98 .El
  99 .Pp
 100 Please check the PCH datasheets for more details.
 101 .Pp
 102 .Sh CAVEATS
 103 All values are read-only.
 104 And it do not support event interrupt for now.
 105 .Sh SEE ALSO
 106 .Xr sysctl 8
 107 .Sh HISTORY
 108 The
 109 .Nm
 110 driver first appeared in
 111 .Fx 13.0 .
 112 .Sh AUTHORS
 113 .An -nosplit
 114 The
 115 .Nm
 116 driver and this manual page were written by
 117 .An Takanori Watanabe Aq Mt takawata@FreeBSD.org .