Date: Tue, 13 Aug 2019 03:49:53 +0000 (UTC) From: Ian Lepore <ian@FreeBSD.org> To: src-committers@freebsd.org, svn-src-all@freebsd.org, svn-src-head@freebsd.org Subject: svn commit: r350971 - head/share/man/man4 Message-ID: <201908130349.x7D3nr6x085342@repo.freebsd.org>
next in thread | raw e-mail | index | archive | help
Author: ian Date: Tue Aug 13 03:49:53 2019 New Revision: 350971 URL: https://svnweb.freebsd.org/changeset/base/350971 Log: Fix the driver name in ads111x.4, and hook the manpage up to the build. The driver was originally written with the name ads1115, but at the last minute it got renamed to ads111x to reflect its support for many related chips, but I forgot to update the manpage to match the renaming before committing it all. Modified: head/share/man/man4/Makefile head/share/man/man4/ads111x.4 Modified: head/share/man/man4/Makefile ============================================================================== --- head/share/man/man4/Makefile Tue Aug 13 01:25:07 2019 (r350970) +++ head/share/man/man4/Makefile Tue Aug 13 03:49:53 2019 (r350971) @@ -21,6 +21,7 @@ MAN= aac.4 \ ${_acpi_wmi.4} \ ada.4 \ adm6996fc.4 \ + ads111x.4 \ ae.4 \ ${_aesni.4} \ age.4 \ @@ -568,7 +569,13 @@ MAN= aac.4 \ xpt.4 \ zero.4 -MLINKS= ae.4 if_ae.4 +MLINKS= ads111x.4 ads1013.4 \ + ads111x.4 ads1014.4 \ + ads111x.4 ads1015.4 \ + ads111x.4 ads1113.4 \ + ads111x.4 ads1114.4 \ + ads111x.4 ads1115.4 +MLINKS+=ae.4 if_ae.4 MLINKS+=age.4 if_age.4 MLINKS+=agp.4 agpgart.4 MLINKS+=alc.4 if_alc.4 Modified: head/share/man/man4/ads111x.4 ============================================================================== --- head/share/man/man4/ads111x.4 Tue Aug 13 01:25:07 2019 (r350970) +++ head/share/man/man4/ads111x.4 Tue Aug 13 03:49:53 2019 (r350971) @@ -24,25 +24,25 @@ .\" .\" $FreeBSD$ .\" -.Dd August 5, 2019 -.Dt ADS1115 4 +.Dd August 12, 2019 +.Dt ADS111x 4 .Os .Sh NAME -.Nm ads1115 +.Nm ads111x .Nd driver for ADS101x and ADS111x i2c analog to digital converters .Sh SYNOPSIS To compile this driver into the kernel, place the following line in your kernel configuration file: .Bd -ragged -offset indent -.Cd "device ads1115" +.Cd "device ads111x" .Ed .Pp Alternatively, to load the driver as a module at boot time, place the following line in .Xr loader.conf 5 : .Bd -literal -offset indent -ads1115_load="YES" +ads111x_load="YES" .Ed .Sh DESCRIPTION The @@ -58,7 +58,7 @@ set via hints, FDT data, and .Xr Sysctl 8 provides access to the voltage measurements made by the device. Each time the -.Va dev.ads1115.<unit>.<channel>.voltage +.Va dev.ads111x.<unit>.<channel>.voltage variable is accessed for a given channel, the driver switches the chip's internal mux to choose the right input pins for that channel, directs it to make a single measurement, and returns the measured value @@ -106,16 +106,16 @@ All writeable variables may also be set as tunables. Channel numbers in these sysctl variables range from 0 through 7. .Bl -tag -width indent -.It Va dev.ads1115.<unit>.config +.It Va dev.ads111x.<unit>.config Provides access to the configuration register bits that control the alert pin configuration. Other bits which are controlled by the driver are masked out, and cannot be viewed or changed using this variable. -.It Va dev.ads1115.<unit>.lo_thresh +.It Va dev.ads111x.<unit>.lo_thresh Sets the low threshold for activating the alert pin. -.It Va dev.ads1115.<unit>.hi_thresh +.It Va dev.ads111x.<unit>.hi_thresh Sets the high threshold for activating the alert pin. -.It Va dev.ads1115.<unit>.<channel>.rate_index +.It Va dev.ads111x.<unit>.<channel>.rate_index Sets the sample rate for the channel. The device datasheet documents eight available sample rates, chosen by setting a value of 0 through 7 into the corresponding control @@ -126,7 +126,7 @@ measurement on the given channel. Because measurements are always made in single-shot mode, think of this variable as controlling the averaging time for a single sample; the time to make a measurement is 1 / samplerate. -.It Va dev.ads1115.<unit>.<channel>.gain_index +.It Va dev.ads111x.<unit>.<channel>.gain_index Sets the programmable gain amplifier for the channel on devices which have an internal amplifier. The device datasheet documents eight available gain values, chosen @@ -134,7 +134,7 @@ by setting a value of 0 through 7 into the correspondi register bits. This variable sets the value used for those bits when making a measurement on the given channel. -.It Va dev.ads1115.<unit>.<channel>.voltage +.It Va dev.ads111x.<unit>.<channel>.voltage Reading this variable causes the device to make a measurement on the corresponding input pin(s) and return the voltage in microvolts. .Pp @@ -215,16 +215,16 @@ based system, such as these values are configurable for .Nm : .Bl -tag -width indent -.It Va hint.ads1115.<unit>.at +.It Va hint.ads111x.<unit>.at The iicbus instance the .Nm instance is attached to. -.It Va hint.ads1115.<unit>.<channel>.gain_index +.It Va hint.ads111x.<unit>.<channel>.gain_index The amplifier gain, as described above for the sysctl variable -.Va dev.ads1115.<unit>.<channel>.gain_index . -.It Va hint.ads1115.<unit>.<channel>.rate_index +.Va dev.ads111x.<unit>.<channel>.gain_index . +.It Va hint.ads111x.<unit>.<channel>.rate_index The sample rate, as described above for the sysctl variable -.Va dev.ads1115.<unit>.<channel>.rate_index . +.Va dev.ads111x.<unit>.<channel>.rate_index . .El .Pp If no channels are configured, sysctl variables will be created
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?201908130349.x7D3nr6x085342>