endrun(4) - EndRun Technologies native time-of-day message timedelta

sensor.  Based on msts(4).  Tested with Praecis Ct
(http://www.endruntechnologies.com/network-time-source.htm).

help and feedback mbalmer
'no problem with this sensor going in' deraadt

2 files changed, 84 insertions, 2 deletions

diff --git a/share/man/man4/Makefile b/share/man/man4/Makefile
index 004dfd17da9..1cdcd1235f9 100644
--- a/share/man/man4/Makefile
+++ b/share/man/man4/Makefile
@@ -1,4 +1,4 @@
-#	$OpenBSD: Makefile,v 1.480 2009/04/24 21:04:27 mk Exp $
+#	$OpenBSD: Makefile,v 1.481 2009/05/06 18:21:23 stevesk Exp $
 
 MAN=	aac.4 ac97.4 acphy.4 \
 	acpi.4 acpiac.4 acpiasus.4 acpibat.4 acpibtn.4 acpicpu.4 acpidock.4 \
@@ -16,7 +16,7 @@ MAN=	aac.4 ac97.4 acphy.4 \
 	ch.4 ciphy.4 ciss.4 clcs.4 clct.4 cmpci.4 cnw.4 \
 	com.4 crypto.4 cue.4 cy.4 cz.4 dc.4 dcphy.4 ddb.4 de.4 dpt.4 \
 	drm.4 eap.4 ec.4 eephy.4 ef.4 eg.4 ehci.4 eisa.4 el.4 em.4 \
-	emu.4 enc.4 envy.4 ep.4 epic.4 esa.4 \
+	emu.4 enc.4 endrun.4 envy.4 ep.4 epic.4 esa.4 \
 	eso.4 ess.4 et.4 etphy.4 ex.4 exphy.4 \
 	faith.4 fd.4 fdc.4 fins.4 fintek.4 fms.4 fpa.4 fxp.4 gdt.4 \
 	gentbi.4 gem.4 gif.4 \
diff --git a/share/man/man4/endrun.4 b/share/man/man4/endrun.4
new file mode 100644
index 00000000000..ba90ce2badb
--- /dev/null
+++ b/share/man/man4/endrun.4
@@ -0,0 +1,82 @@
+.\"	$OpenBSD: endrun.4,v 1.1 2009/05/06 18:21:23 stevesk Exp $
+.\"
+.\" Copyright (c) 2008 Marc Balmer <mbalmer@openbsd.org>
+.\" Copyright (c) 2009 Kevin Steves <stevesk@openbsd.org>
+.\"
+.\" Permission to use, copy, modify, and distribute this software for any
+.\" purpose with or without fee is hereby granted, provided that the above
+.\" copyright notice and this permission notice appear in all copies.
+.\"
+.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+.\"
+.Dd $Mdocdate: May 6 2009 $
+.Dt ENDRUN 4
+.Os
+.Sh NAME
+.Nm endrun
+.Nd EndRun Technologies native time-of-day message timedelta sensor
+.Sh SYNOPSIS
+.Cd "pseudo-device endrun" Op Ar count
+.Sh DESCRIPTION
+This line discipline interfaces serial EndRun Technologies devices.
+.Pp
+The line discipline is enabled by the following sequence:
+.Bd -literal -offset indent
+#include <sys/ttycom.h>
+int ldisc = ENDRUNDISC, fildes; ...
+ioctl(fildes, TIOCSETD, &ldisc);
+.Ed
+.Pp
+The byte stream is unaltered by the line discipline which
+maintains a timedelta sensor using the EndRun data.
+The timedelta sensor will appear as endrun* in the list of sensors and the delta
+(in nanoseconds) between the received time information and the local time can
+be accessed through the
+.Xr sysctl 8
+interface.
+.Sh SENSOR STATES
+The quality of the timedelta is reported as the sensor status:
+.Bl -tag -width "CRITICALXX" -offset indent
+.It OK
+The time information is valid.
+The timedelta is safe to use for applications like
+.Xr ntpd 8 .
+.It WARN
+The attached receiver has been indicating a warning condition
+for at least the last ten minutes.
+The timedelta should be used with care.
+.It CRITICAL
+tty timestamping has been turned on but there is no PPS signal present or the
+receiver indicated a warning condition for at least the last twenty minutes.
+Check your hardware.
+.El
+.Pp
+The status of a second sensor is used to report the status of the
+device itself using the Time Figure Of Merit (TFOM) character:
+.Bl -tag -width "CRITICALXX" -offset indent
+.It OK
+The clock is synchronized.
+TFOM is 6-9.
+.It WARN
+The clock is synchronized and the time error is greater
+than 10ms or the clock is in the unsynchronized state.
+TFOM is 9.
+.It CRITICAL
+The TFOM is invalid.
+.El
+.Sh SEE ALSO
+.Xr tty 4 ,
+.Xr ldattach 8 ,
+.Xr ntpd 8 ,
+.Xr sysctl 8
+.Sh HISTORY
+The
+.Nm
+interface first appeared in
+.Ox 4.6 .