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