share/man/man4/aibs.4

   1 .\"     $FreeBSD$
   2 .\"     $NetBSD: aibs.4,v 1.2 2010/02/09 05:37:25 cnst Exp $
   3 .\"     $OpenBSD: aibs.4,v 1.4 2009/07/30 06:30:45 jmc Exp $
   4 .\"
   5 .\" Copyright (c) 2009/2010 Constantine A. Murenin <cnst++@FreeBSD.org>
   6 .\"
   7 .\" Permission to use, copy, modify, and distribute this software for any
   8 .\" purpose with or without fee is hereby granted, provided that the above
   9 .\" copyright notice and this permission notice appear in all copies.
  10 .\"
  11 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  12 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  13 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  14 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  15 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  16 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  17 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  18 .\"
  19 .Dd April 4, 2010
  20 .Dt AIBS 4
  21 .Os
  22 .Sh NAME
  23 .Nm aibs
  24 .Nd "ASUSTeK AI Booster ACPI ATK0110 voltage, temperature and fan sensor"
  25 .Sh SYNOPSIS
  26 To compile this driver into the kernel,
  27 place the following lines in your
  28 kernel configuration file:
  29 .Bd -ragged -offset indent
  30 .Cd "device acpi"
  31 .Cd "device aibs"
  32 .Ed
  33 .Pp
  34 Alternatively, to load the driver as a
  35 module at boot time, place the following lines in
  36 .Xr loader.conf 5 :
  37 .Bd -literal -offset indent
  38 acpi_load="YES"
  39 aibs_load="YES"
  40 .Ed
  41 .Sh DESCRIPTION
  42 The
  43 .Nm
  44 driver provides support for the voltage, temperature and fan sensors
  45 available through the
  46 .Tn ATK0110
  47 .Tn ASOC
  48 .Tn ACPI
  49 device
  50 on
  51 .Tn ASUSTeK
  52 motherboards.
  53 The number of sensors of each type,
  54 as well as the description of each sensor,
  55 varies according to the motherboard.
  56 .Pp
  57 The driver supports an arbitrary set of sensors,
  58 provides descriptions regarding what each sensor is used for,
  59 and reports the current values as well as
  60 the supposed range specifications of each sensor's input
  61 as defined by the motherboard manufacturer through
  62 .Tn ACPI .
  63 .Pp
  64 The range specifications are as follows:
  65 .Bl -bullet
  66 .It
  67 Voltage sensors have a lower and an upper range specification.
  68 .It
  69 Temperature sensors have two upper specifications.
  70 .It
  71 Fan sensors may either have only the lower specification,
  72 or, depending on the
  73 .Tn DSDT ,
  74 one lower and one upper specification.
  75 .El
  76 .Pp
  77 Sensor readings and the range specifications are made available through the
  78 .Xr sysctl 3
  79 interface,
  80 and can be monitored with
  81 .Xr sysctl 8 .
  82 For example, on an ASUS V3-P5G965 barebone:
  83 .Bd -literal -offset indent
  84 > sysctl dev.aibs.0.{volt,temp,fan}
  85 dev.aibs.0.volt.0: 1192 850 1600
  86 dev.aibs.0.volt.1: 3312 2970 3630
  87 dev.aibs.0.volt.2: 5017 4500 5500
  88 dev.aibs.0.volt.3: 12302 10200 13800
  89 dev.aibs.0.temp.0: 28.0C 80.0C 95.0C
  90 dev.aibs.0.temp.1: 55.0C 60.0C 95.0C
  91 dev.aibs.0.fan.0: 878 600 7200
  92 dev.aibs.0.fan.1: 0 700 7200
  93 .Pp
  94 > sysctl -d dev.aibs.0.{volt,temp,fan}
  95 dev.aibs.0.volt:
  96 dev.aibs.0.volt.0: Vcore Voltage
  97 dev.aibs.0.volt.1:  +3.3 Voltage
  98 dev.aibs.0.volt.2:  +5 Voltage
  99 dev.aibs.0.volt.3:  +12 Voltage
 100 dev.aibs.0.temp:
 101 dev.aibs.0.temp.0: CPU Temperature
 102 dev.aibs.0.temp.1: MB Temperature
 103 dev.aibs.0.fan:
 104 dev.aibs.0.fan.0: CPU FAN Speed
 105 dev.aibs.0.fan.1: CHASSIS FAN Speed
 106 .Ed
 107 .Pp
 108 Generally, sensors provided by the
 109 .Nm
 110 driver may also be supported by certain other drivers or utilities
 111 that access the
 112 .Tn ISA /
 113 .Tn LPC
 114 or
 115 .Tn I2C /
 116 .Tn SMBus
 117 devices directly.
 118 The precise collection of
 119 .Nm
 120 sensors is comprised of the sensors
 121 specifically utilised in the motherboard
 122 design, which may be supported through
 123 a combination of one or more physical hardware monitoring chips.
 124 .Pp
 125 The
 126 .Nm
 127 driver, however, provides the following advantages
 128 when compared to the native hardware monitoring drivers or other utilities:
 129 .Bl -bullet
 130 .It
 131 Sensor values from
 132 .Nm
 133 are expected to be more reliable.
 134 For example, voltage sensors in many hardware monitoring chips
 135 can only sense voltage from 0 to 2 or 4 volts, and the excessive
 136 voltage is removed by the resistors, which may vary with the motherboard
 137 and with the voltage that is being sensed.
 138 In
 139 .Nm ,
 140 the required resistor factors are provided by
 141 the motherboard manufacturer through
 142 .Tn ACPI ;
 143 in the native drivers, the resistor factors
 144 are encoded into the driver based on the chip manufacturer's recommendations.
 145 In essence, sensor values from
 146 .Nm
 147 are very likely to be identical to the readings from the
 148 Hardware Monitor screen in the BIOS.
 149 .It
 150 Sensor descriptions from
 151 .Nm
 152 are more likely to match the markings on the motherboard.
 153 .It
 154 Sensor range specifications are supported by
 155 .Nm .
 156 The range specification is reported
 157 for each individual sensor as suggested by the motherboard manufacturer.
 158 For example, the threshold for the CPU temperature sensor is likely
 159 to be significantly higher than that for the chassis temperature sensor.
 160 .It
 161 Support for newer chips in
 162 .Nm .
 163 Newer chips may miss a native driver,
 164 but should be supported through
 165 .Nm
 166 regardless.
 167 .El
 168 .Sh SEE ALSO
 169 .Xr sysctl 3 ,
 170 .Xr acpi 4 ,
 171 .Xr sysctl 8
 172 .Sh HISTORY
 173 The
 174 .Nm
 175 driver first appeared in
 176 .Ox 4.7 ,
 177 .Dx 2.5 ,
 178 .Nx 6.0
 179 and
 180 .Fx 9.0 .
 181 .Pp
 182 An earlier version of the driver,
 183 .Nm acpi_aiboost ,
 184 first appeared in
 185 .Fx 7.0
 186 and
 187 .Nx 5.0 .
 188 .Sh AUTHORS
 189 .An -nosplit
 190 The
 191 .Nm
 192 driver was written for
 193 .Ox ,
 194 .Dx ,
 195 .Nx
 196 and
 197 .Fx
 198 by
 199 .An Constantine A. Murenin Aq cnst@FreeBSD.org ,
 200 Raouf Boutaba Research Group,
 201 David R. Cheriton School of Computer Science,
 202 University of Waterloo.
 203 .Pp
 204 An earlier version of the driver, named
 205 .Nm acpi_aiboost ,
 206 was written for
 207 .Fx
 208 by
 209 .An Takanori Watanabe .