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