[src/trunk]: src/share/man/man4 Mention supported chips and their differences.

[jdc <jdc%NetBSD.org@localhost>]

details:   https://anonhg.NetBSD.org/src/rev/8111cd70c1c6
branches:  trunk
changeset: 812794:8111cd70c1c6
user:      jdc <jdc%NetBSD.org@localhost>
date:      Sun Jan 03 17:27:39 2016 +0000

description:
Mention supported chips and their differences.
Mention display and setting of chip temperature limits.

diffstat:

 share/man/man4/admtemp.4 |  51 ++++++++++++++++++++++++++++++++++++++++-------
 1 files changed, 43 insertions(+), 8 deletions(-)

diffs (80 lines):

diff -r 79feef768ca4 -r 8111cd70c1c6 share/man/man4/admtemp.4
--- a/share/man/man4/admtemp.4  Sun Jan 03 17:27:26 2016 +0000
+++ b/share/man/man4/admtemp.4  Sun Jan 03 17:27:39 2016 +0000
@@ -1,4 +1,4 @@
-.\"    $NetBSD: admtemp.4,v 1.4 2014/03/18 18:20:39 riastradh Exp $
+.\"    $NetBSD: admtemp.4,v 1.5 2016/01/03 17:27:39 jdc Exp $
 .\"
 .\"    $OpenBSD: admtemp.4,v 1.8 2007/05/31 19:19:48 jmc Exp $
 .\"
@@ -16,7 +16,7 @@
 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 .\"
-.Dd October 29, 2008
+.Dd December 31, 2015
 .Dt ADMTEMP 4
 .Os
 .Sh NAME
@@ -29,16 +29,44 @@
 .Nm
 driver provides support for the Analog Devices ADM1021,
 Analog Devices ADM1023, Analog Devices ADM1032, Genesys Logic GL523SM,
-Global Mixed-mode Technology G781, Maxim 1617, and Xeon embedded
-temperature sensors.
-The device possesses internal and external temperature sensors.
-These values are made available through the
-.Xr envstat 8
-interface.
+Global Mixed-mode Technology G781, Texas Instruments LM84, Maxim 1617,
+Maxim 1617A, Philips Semiconductors NE1617A, and Xeon embedded temperature
+sensors.
+The device possesses internal and external temperature sensors, and
+programmable low and high temperature limits, with a temperature range of
+-65 to +127 degC and a resolution of 1 degC.
 .Pp
 On i386 machines, this driver also supports the Xeon embedded
 I2C temperature probes.
 In this case, however, only one temperature value is provided.
+.Pp
+Exceeding the temperature limits causes the device to assert an Alarm signal,
+which can be used by other hardware to detect critical conditions.
+.Pp
+Some sensors differ from the ADM1021, MAX1617 and NE1617A:
+.Bl -item -offset indent
+.It
+The ADM1021A, ADM1023, ADM1032, and G781 have a temperature range of 0 to
++127 degC and a resolution of 1 degC.
+.It
+The LM84 has no low temperature limits.
+.It
+The ADM1023, ADM1032, and G781 have extended precision remote temperature
+sensors, with a range of 0 to +127.875 degC and a resolution of 0.125 degC.
+.It
+The ADM1032 and G781 have additional high temperature limits with a range of
+0 to +127 degC and a resolution of 1 degC.
+If these are exceeded, a separate Therm signal is asserted.
+.El
+.Pp
+The sensor and limit values are made available through the
+.Xr envstat 8
+interface.
+For devices without additional high temperature limits, the limits that are
+displayed and set are the critical limits.
+For devices with additional high temperature limits, high and low temperature
+warning limits and high temperature critical limits are displayed and can be
+set.
 .Sh SEE ALSO
 .Xr iic 4 ,
 .Xr intro 4 ,
@@ -49,3 +77,10 @@
 .Nm
 driver was written by
 .An Theo de Raadt Aq Mt deraadt%openbsd.org@localhost .
+Extended precision temperatures, and limit display and setting were added by
+.An Julian Coleman Aq Mt jcoleman%NetBSD.org@localhost .
+.Sh BUGS
+Limit sensors occasionally read as 0xff.
+If this occurs, the
+.Nm
+driver will ignore that limit.