xref: /openbsd/share/man/man4/aibs.4 (revision e5dd7070)
1.\"	$OpenBSD: aibs.4,v 1.7 2018/01/12 04:36:44 deraadt Exp $
2.\"
3.\" Copyright (c) 2009 Constantine A. Murenin <cnst+openbsd@bugmail.mojo.ru>
4.\"
5.\" Permission to use, copy, modify, and distribute this software for any
6.\" purpose with or without fee is hereby granted, provided that the above
7.\" copyright notice and this permission notice appear in all copies.
8.\"
9.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16.\"
17.Dd $Mdocdate: January 12 2018 $
18.Dt AIBS 4
19.Os
20.Sh NAME
21.Nm aibs
22.Nd ASUSTeK AI Booster ACPI ATK0110 temperature, voltage, and fan sensor
23.Sh SYNOPSIS
24.Cd "aibs* at acpi?"
25.Sh DESCRIPTION
26The
27.Nm
28driver provides support for the voltage, temperature and fan sensors
29available through the
30ATK0110
31ACPI
32device
33on ASUSTeK motherboards.
34The number of sensors of each type,
35as well as the description of each sensor,
36varies according to the motherboard.
37.Pp
38The driver supports an arbitrary set of sensors,
39provides a description regarding what each sensor is used for,
40and reports whether each sensor is within the specifications
41as defined by the motherboard manufacturer through ACPI.
42.Pp
43The
44.Nm
45driver supports sensor states as follows:
46temperature sensors can have a state of
47.Dv OK ,
48.Dv WARN ,
49.Dv CRIT
50or
51.Dv UNKNOWN ;
52fan and voltage sensors can have a state of
53.Dv OK
54or
55.Dv WARN
56only.
57Temperature sensors that have a reading of 0
58are marked as invalid and their state is set to
59.Dv UNKNOWN ,
60whereas all other sensors are always assumed valid.
61Temperature sensors have two upper limits
62.Dv ( WARN
63and
64.Dv CRIT ) ,
65fan sensors have either only the lower limit, or
66one lower and one upper limit,
67and voltage sensors always have a lower and an upper limit.
68.Pp
69Sensor values are made available through the
70.Dv HW_SENSORS
71.Xr sysctl 2
72interface,
73and can be monitored with the
74.Xr systat 1
75.Ar sensors
76view,
77.Xr sensorsd 8 ,
78or
79.Xr sysctl 8
80.Ar hw.sensors .
81For example, on an Asus Stricker Extreme motherboard:
82.Bd -literal -offset indent
83$ sysctl hw.sensors.aibs0
84hw.sensors.aibs0.temp0=31.00 degC (CPU Temperature), OK
85hw.sensors.aibs0.temp1=43.00 degC (MB Temperature), OK
86hw.sensors.aibs0.fan0=2490 RPM (CPU FAN Speed), OK
87hw.sensors.aibs0.fan1=0 RPM (CHASSIS FAN Speed), WARNING
88hw.sensors.aibs0.fan2=0 RPM (OPT1 FAN Speed), WARNING
89hw.sensors.aibs0.fan3=0 RPM (OPT2 FAN Speed), WARNING
90hw.sensors.aibs0.fan4=0 RPM (OPT3 FAN Speed), WARNING
91hw.sensors.aibs0.fan5=0 RPM (OPT4 FAN Speed), WARNING
92hw.sensors.aibs0.fan6=0 RPM (OPT5 FAN Speed), WARNING
93hw.sensors.aibs0.fan7=0 RPM (PWR FAN Speed), WARNING
94hw.sensors.aibs0.volt0=1.26 VDC (Vcore Voltage), OK
95hw.sensors.aibs0.volt1=3.25 VDC ( +3.3 Voltage), OK
96hw.sensors.aibs0.volt2=4.95 VDC ( +5.0 Voltage), OK
97hw.sensors.aibs0.volt3=11.78 VDC (+12.0 Voltage), OK
98hw.sensors.aibs0.volt4=1.23 VDC (1.2VHT Voltage), OK
99hw.sensors.aibs0.volt5=1.50 VDC (SB CORE Voltage), OK
100hw.sensors.aibs0.volt6=1.25 VDC (CPU VTT Voltage), OK
101hw.sensors.aibs0.volt7=0.93 VDC (DDR2 TERM Voltage), OK
102hw.sensors.aibs0.volt8=1.23 VDC (NB CORE Voltage), OK
103hw.sensors.aibs0.volt9=1.87 VDC (MEMORY Voltage), OK
104.Ed
105.Pp
106Generally, sensors provided by the
107.Nm
108driver may also be supported by a variety of other drivers,
109such as
110.Xr lm 4
111or
112.Xr it 4 .
113The precise collection of
114.Nm
115sensors is comprised of the sensors
116specifically utilised in the motherboard
117design, which may be supported through
118a combination of one or more physical hardware monitoring chips.
119.Pp
120The
121.Nm
122driver, however, provides the following advantages
123when compared to the native hardware monitoring drivers:
124.Bl -bullet
125.It
126Sensor values from
127.Nm
128are expected to be more reliable.
129For example, voltage sensors in many hardware monitoring chips
130can only sense voltage from 0 to 2 or 4 volts, and the excessive
131voltage is removed by the resistors, which may vary with the motherboard
132and with the voltage that is being sensed.
133In
134.Nm ,
135the required resistor factors are provided by
136the motherboard manufacturer through ACPI;
137in the native drivers, the resistor factors
138are encoded into the driver based on the chip manufacturer's recommendations.
139In essence, sensor values from
140.Nm
141are very likely to be identical to the readings from the
142Hardware Monitor screen in the BIOS.
143.It
144Sensor descriptions from
145.Nm
146are more likely to match the markings on the motherboard.
147.It
148Sensor status is supported by
149.Nm .
150The status is reported based on the acceptable range of values
151for each individual sensor as suggested by the motherboard manufacturer.
152For example, the threshold for the CPU temperature sensor is likely
153to be significantly higher than that for the chassis temperature sensor.
154.It
155Support for newer chips in
156.Nm .
157Newer chips may miss a native driver,
158but should be supported through
159.Nm
160regardless.
161.El
162.Pp
163As a result, sensor readings from the actual
164native hardware monitoring drivers
165may be ignored as appropriate.
166.Sh SEE ALSO
167.Xr systat 1 ,
168.Xr sysctl 2 ,
169.Xr acpi 4 ,
170.Xr intro 4 ,
171.Xr sensorsd 8 ,
172.Xr sysctl 8
173.Sh HISTORY
174The
175.Nm
176driver first appeared in
177.Ox 4.7 .
178.Sh AUTHORS
179The
180.Nm
181driver was written by
182.An Constantine A. Murenin Aq Mt cnst@openbsd.org ,
183University of Waterloo.
184