share/man/man4/aibs.4

   1 .\"     $OpenBSD: aibs.4,v 1.4 2009/07/30 06:30:45 jmc Exp $
   2 .\"
   3 .\" Copyright (c) 2009 Constantine A. Murenin <cnst+dfly@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 September 23, 2009
  18 .Dt AIBS 4
  19 .Os
  20 .Sh NAME
  21 .Nm aibs
  22 .Nd "ASUSTeK AI Booster ACPI ATK0110 voltage, temperature and fan sensor"
  23 .Sh SYNOPSIS
  24 To compile this driver into the kernel,
  25 place the following lines in your
  26 kernel configuration file:
  27 .Bd -ragged -offset indent
  28 .Cd "device acpi"
  29 .Cd "device aibs"
  30 .Ed
  31 .Pp
  32 Alternatively, to load the driver as a
  33 module at boot time, place the following lines in
  34 .Xr loader.conf 5 :
  35 .Bd -literal -offset indent
  36 acpi_load="YES"
  37 aibs_load="YES"
  38 .Ed
  39 .Sh DESCRIPTION
  40 The
  41 .Nm
  42 driver provides support for the voltage, temperature and fan sensors
  43 available through the
  44 ATK0110
  45 ASOC
  46 ACPI
  47 device
  48 on ASUSTeK motherboards.
  49 The number of sensors of each type,
  50 as well as the description of each sensor,
  51 varies according to the motherboard.
  52 .Pp
  53 The driver supports an arbitrary set of sensors,
  54 provides descriptions regarding what each sensor is used for,
  55 and reports whether each sensor is within the specifications
  56 as defined by the motherboard manufacturer through ACPI.
  57 .Pp
  58 The
  59 .Nm
  60 driver supports sensor states as follows:
  61 temperature sensors can have a state of
  62 .Dv OK ,
  63 .Dv WARN ,
  64 .Dv CRIT
  65 or
  66 .Dv UNKNOWN ;
  67 fan and voltage sensors can have a state of
  68 .Dv OK
  69 or
  70 .Dv WARN
  71 only.
  72 Temperature sensors that have a reading of 0
  73 are marked as invalid and their state is set to
  74 .Dv UNKNOWN ,
  75 whereas all other sensors are always assumed valid.
  76 Temperature sensors have two upper limits
  77 .Dv ( WARN
  78 and
  79 .Dv CRIT ) ,
  80 fan sensors have either only the lower limit, or
  81 one lower and one upper limit,
  82 and voltage sensors always have a lower and an upper limit.
  83 .Pp
  84 Sensor values are made available through the
  85 .Dv HW_SENSORS
  86 .Xr sysctl 3
  87 interface,
  88 and can be monitored with the
  89 .Xr systat 1
  90 .Ar sensors
  91 display,
  92 .Xr sensorsd 8
  93 and
  94 .Xr sysctl 8
  95 .Ar hw.sensors .
  96 For example, on an Asus Stricker Extreme motherboard:
  97 .Bd -literal -offset indent
  98 $ sysctl hw.sensors.aibs0
  99 hw.sensors.aibs0.temp0=31.00 degC (CPU Temperature), OK
 100 hw.sensors.aibs0.temp1=43.00 degC (MB Temperature), OK
 101 hw.sensors.aibs0.fan0=2490 RPM (CPU FAN Speed), OK
 102 hw.sensors.aibs0.fan1=0 RPM (CHASSIS FAN Speed), WARNING
 103 hw.sensors.aibs0.fan2=0 RPM (OPT1 FAN Speed), WARNING
 104 hw.sensors.aibs0.fan3=0 RPM (OPT2 FAN Speed), WARNING
 105 hw.sensors.aibs0.fan4=0 RPM (OPT3 FAN Speed), WARNING
 106 hw.sensors.aibs0.fan5=0 RPM (OPT4 FAN Speed), WARNING
 107 hw.sensors.aibs0.fan6=0 RPM (OPT5 FAN Speed), WARNING
 108 hw.sensors.aibs0.fan7=0 RPM (PWR FAN Speed), WARNING
 109 hw.sensors.aibs0.volt0=1.26 VDC (Vcore Voltage), OK
 110 hw.sensors.aibs0.volt1=3.25 VDC ( +3.3 Voltage), OK
 111 hw.sensors.aibs0.volt2=4.95 VDC ( +5.0 Voltage), OK
 112 hw.sensors.aibs0.volt3=11.78 VDC (+12.0 Voltage), OK
 113 hw.sensors.aibs0.volt4=1.23 VDC (1.2VHT Voltage), OK
 114 hw.sensors.aibs0.volt5=1.50 VDC (SB CORE Voltage), OK
 115 hw.sensors.aibs0.volt6=1.25 VDC (CPU VTT Voltage), OK
 116 hw.sensors.aibs0.volt7=0.93 VDC (DDR2 TERM Voltage), OK
 117 hw.sensors.aibs0.volt8=1.23 VDC (NB CORE Voltage), OK
 118 hw.sensors.aibs0.volt9=1.87 VDC (MEMORY Voltage), OK
 119 .Ed
 120 .Pp
 121 Generally, sensors provided by the
 122 .Nm
 123 driver may also be supported by a variety of other drivers,
 124 such as
 125 .Xr lm 4
 126 or
 127 .Xr it 4 .
 128 The precise collection of
 129 .Nm
 130 sensors is comprised of the sensors
 131 specifically utilised in the motherboard
 132 design, which may be supported through
 133 a combination of one or more physical hardware monitoring chips.
 134 .Pp
 135 The
 136 .Nm
 137 driver, however, provides the following advantages
 138 when compared to the native hardware monitoring drivers:
 139 .Bl -bullet
 140 .It
 141 Sensor values from
 142 .Nm
 143 are expected to be more reliable.
 144 For example, voltage sensors in many hardware monitoring chips
 145 can only sense voltage from 0 to 2 or 4 volts, and the excessive
 146 voltage is removed by the resistors, which may vary with the motherboard
 147 and with the voltage that is being sensed.
 148 In
 149 .Nm ,
 150 the required resistor factors are provided by
 151 the motherboard manufacturer through ACPI;
 152 in the native drivers, the resistor factors
 153 are encoded into the driver based on the chip manufacturer's recommendations.
 154 In essence, sensor values from
 155 .Nm
 156 are very likely to be identical to the readings from the
 157 Hardware Monitor screen in the BIOS.
 158 .It
 159 Sensor descriptions from
 160 .Nm
 161 are more likely to match the markings on the motherboard.
 162 .It
 163 Sensor status is supported by
 164 .Nm .
 165 The status is reported based on the acceptable range of values
 166 for each individual sensor as suggested by the motherboard manufacturer.
 167 For example, the threshold for the CPU temperature sensor is likely
 168 to be significantly higher than that for the chassis temperature sensor.
 169 .It
 170 Support for newer chips in
 171 .Nm .
 172 Newer chips may miss a native driver,
 173 but should be supported through
 174 .Nm
 175 regardless.
 176 .El
 177 .Pp
 178 As a result, sensor readings from the actual
 179 native hardware monitoring drivers
 180 are redundant when
 181 .Nm
 182 is present, and
 183 may be ignored as appropriate.
 184 Whereas on
 185 .Ox
 186 the native drivers have to be specifically disabled should
 187 their presence be judged unnecessary,
 188 on
 189 .Dx
 190 the
 191 .Xr lm 4
 192 and
 193 .Xr it 4
 194 are not probed provided that
 195 .Xr acpi 4
 196 is configured and the system potentially supports
 197 the hardware monitoring chip through ACPI.
 198 .Sh SEE ALSO
 199 .Xr systat 1 ,
 200 .Xr sysctl 3 ,
 201 .Xr acpi 4 ,
 202 .Xr intro 4 ,
 203 .Xr sensorsd 8 ,
 204 .Xr sysctl 8
 205 .Sh HISTORY
 206 The
 207 .Nm
 208 driver first appeared in
 209 .Ox 4.7
 210 and
 211 .Dx 2.5 .
 212 .Sh AUTHORS
 213 The
 214 .Nm
 215 driver was written for
 216 .Ox
 217 and
 218 .Dx
 219 by
 220 .An Constantine A. Murenin Aq http://cnst.su/ ,
 221 David R. Cheriton School of Computer Science,
 222 University of Waterloo.