Module Name: src
Committed By: uwe
Date: Fri Jan 24 16:12:50 UTC 2025
Modified Files:
src/share/man/man4: si70xxtemp.4
Log Message:
si70xxtemp(4): mark up sysctl node names as Li
To generate a diff of this commit:
cvs rdiff -u -r1.8 -r1.9 src/share/man/man4/si70xxtemp.4
Please note that diffs are not public domain; they are subject to the
copyright notices on the relevant files.
Modified files:
Index: src/share/man/man4/si70xxtemp.4
diff -u src/share/man/man4/si70xxtemp.4:1.8 src/share/man/man4/si70xxtemp.4:1.9
--- src/share/man/man4/si70xxtemp.4:1.8 Thu Jan 23 19:13:19 2025
+++ src/share/man/man4/si70xxtemp.4 Fri Jan 24 16:12:50 2025
@@ -1,4 +1,4 @@
-.\" $NetBSD: si70xxtemp.4,v 1.8 2025/01/23 19:13:19 brad Exp $
+.\" $NetBSD: si70xxtemp.4,v 1.9 2025/01/24 16:12:50 uwe Exp $
.\"
.\" Copyright (c) 2017 Brad Spencer <[email protected]>
.\"
@@ -32,7 +32,7 @@ framework.
The
.Nm
.Ar addr
-argument selects the address at the
+locator selects the address at the
.Xr iic 4
bus.
The resolution, heater control and crc validity can be changed through
@@ -40,32 +40,33 @@ The resolution, heater control and crc v
nodes.
.Sh SYSCTL VARIABLES
The following
-.Xr sysctl 3
+.Xr sysctl 8
variables are provided:
-.Bl -tag -width indent
-.It hw.si70xxtemp0.resolutions
+.Bl -tag -width Li
+.It Li hw.si70xxtemp0.resolutions
Lists the resolutions supported by the driver and chip.
-.It hw.si70xxtemp0.resolution
+.It Li hw.si70xxtemp0.resolution
Set the resolution, or number of bits, used for %RH and temperature.
-Use one of the strings listed in hw.si70xxtemp.resolutions.
-.It hw.si70xxtemp0.ignorecrc
+Use one of the strings listed in
+.Li hw.si70xxtemp.resolutions .
+.It Li hw.si70xxtemp0.ignorecrc
If set, the crc calculation for %RH and temperature will be ignored.
-.It hw.si70xxtemp0.vddok
+.It Li hw.si70xxtemp0.vddok
If 1, the chip is getting enough power.
-.It hw.si70xxtemp0.heateron
+.It Li hw.si70xxtemp0.heateron
Turn the heater on and off.
-.It hw.si70xxtemp0.heaterstrength
+.It Li hw.si70xxtemp0.heaterstrength
From 1 to 6, the amount of energy put into the heater.
The higher the number, the more power used.
.Pp
Some HTU21D chips do not support a heater register.
These chips are detected and the heater features of the driver will
be disabled.
-.It hw.si70xxtemp0.debug
+.It Li hw.si70xxtemp0.debug
If the driver is compiled with
.Dv SI70XX_DEBUG ,
this node will appear and can be used to set the debugging level.
-.It hw.si70xxtemp0.readattempts
+.It Li hw.si70xxtemp0.readattempts
To read %RH or temperature the driver uses a No Hold Master command.
This command needs to be sent to the device, a wait must then occur
and then another read command is sent to read back the values.
@@ -75,7 +76,7 @@ times.
The default is 40 which should be enough for most purposes.
There is an initial wait of 10,500 microseconds followed by
a additional 1,000 microseconds per read attempt.
-.It hw.si70xxtemp0.clockstretch
+.It Li hw.si70xxtemp0.clockstretch
The chip supports a set of commands that lets it use I2C clock
stretching to perform the temperature or humidity measurement. If
this is set to 1 then use the clock stretching commands with the