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 .Dd March 15, 2020
  25 .Dt pchtherm 4
  26 .Os
  27 .Sh NAME
  28 .Nm pchtherm
  29 .Nd Intel PCH thermal subsystem
  30 .Sh SYNOPSIS
  31 .Cd "device pci"
  32 .Cd "device pchtherm"
  33 .Sh DESCRIPTION
  34 The
  35 .Nm
  36 driver provides access to sensor data and configuration
  37 installed in Intel PCH chipset.
  38 .Nm
  39 configuration register.
  40 .Pp
  41 The access to
  42 .Nm
  43 data is made via the
  44 .Xr sysctl 8
  45 interface:
  46 .Bd -literal
  47 dev.pchtherm.0.ctt: 115.0C
  48 dev.pchtherm.0.temperature: 28.5C
  49 dev.pchtherm.0.t2temp: 91.0C
  50 dev.pchtherm.0.t1temp: 86.0C
  51 dev.pchtherm.0.t0temp: 81.0C
  52 dev.pchtherm.0.tahv: 83.0C
  53 dev.pchtherm.0.talv: 30.0C
  54 dev.pchtherm.0.pmtime: 32
  55 dev.pchtherm.0.pmtemp: 50.0C
  56 dev.pchtherm.0.%parent: pci0
  57 dev.pchtherm.0.%pnpinfo: vendor=0x8086 device=0x9d31 subvendor=0x17aa subdevice=0x2256 class=0x118000
  58 dev.pchtherm.0.%location: slot=20 function=2 dbsf=pci0:0:20:2
  59 dev.pchtherm.0.%driver: pchtherm
  60 dev.pchtherm.0.%desc: Skylake PCH Thermal Subsystem
  61 dev.pchtherm.%parent:
  62 .Ed
  63 .Bl -tag -width ".Va dev.pchtherm.%d.pch_hot_level"
  64 .It Va dev.pchtherm.%d.temperature
  65 Is the read-only value of the current temperature read by the sensor.
  66 .It Va dev.pchtherm.%d.ctt
  67 When the system reaches this temperature, it will shut down.
  68 This will not appear when this feature is disabled and locked down.
  69 .It Va dev.pchtherm.%d.t0temp
  70 When temperature is under this value, system will be in T0 state.
  71 .It Va dev.pchtherm.%d.t1temp
  72 When temperature is over
  73 .Va t0temp
  74 and under this value, system will be in T1 state.
  75 .It Va dev.pchtherm.%d.t2temp
  76 When temperature is over
  77 .Va t1temp
  78 and under this value, system will be in T2 state.
  79 Over this value, system will be in T3 state.
  80 .It Va dev.pchtherm.%d.talv
  81 Lower alart value.
  82 This will not appear when sensor enable bit is locked down and the value is zero(which will show -50.0C).
  83 .It Va dev.pchtherm.%d.tahv
  84 High alart value.
  85 This will not appear when sensor enable bit is locked down and the value is zero(which will show -50.0C).
  86 .It Va dev.pchtherm.%d.pmtemp
  87 Sensor Power management temperature.
  88 Under this temperature, sensor will idle during
  89 .Va pmtime
  90 second.
  91 .It Va dev.pchtherm.%d.pmtime
  92 Sensor idle duration when low temperature.
  93 .It Va dev.pchtherm.%d.pch_hot_level
  94 When temperature is higher than this value, PCHHOT# pin will assert.
  95 This value is not appear when this feature is disabled and locked down.
  96 .El
  97 .Pp
  98 Please check the PCH datasheets for more details.
  99 .Sh CAVEATS
 100 All values are read-only.
 101 And it do not support event interrupt for now.
 102 .Sh SEE ALSO
 103 .Xr sysctl 8
 104 .Sh HISTORY
 105 The
 106 .Nm
 107 driver first appeared in
 108 .Fx 13.0 .
 109 .Sh AUTHORS
 110 .An -nosplit
 111 The
 112 .Nm
 113 driver and this manual page were written by
 114 .An Takanori Watanabe Aq Mt takawata@FreeBSD.org .