summaryrefslogtreecommitdiff
path: root/static/openbsd/man4/mbg.4
diff options
context:
space:
mode:
authorJacob McDonnell <jacob@jacobmcdonnell.com>2026-04-25 14:02:27 -0400
committerJacob McDonnell <jacob@jacobmcdonnell.com>2026-04-25 14:02:27 -0400
commit6d8bdc65446a704d0750217efd05532fc641ea7d (patch)
tree8ae6d698b3c9801750a8b117b3842fb369872a3a /static/openbsd/man4/mbg.4
parent2f467bd7ff8f8db0dafa40426166491d7f57f368 (diff)
docs: OpenBSD Man Pages Added
Diffstat (limited to 'static/openbsd/man4/mbg.4')
-rw-r--r--static/openbsd/man4/mbg.4104
1 files changed, 104 insertions, 0 deletions
diff --git a/static/openbsd/man4/mbg.4 b/static/openbsd/man4/mbg.4
new file mode 100644
index 00000000..af73669d
--- /dev/null
+++ b/static/openbsd/man4/mbg.4
@@ -0,0 +1,104 @@
+.\" $OpenBSD: mbg.4,v 1.16 2024/03/23 10:38:02 sthen Exp $
+.\"
+.\" Copyright (c) 2006 Marc Balmer <mbalmer@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: March 23 2024 $
+.Dt MBG 4
+.Os
+.Sh NAME
+.Nm mbg
+.Nd Meinberg Funkuhren timedelta sensor
+.Sh SYNOPSIS
+.Cd "mbg* at pci?"
+.Sh DESCRIPTION
+The
+.Nm
+driver provides support for Meinberg Funkuhren radio clocks (time signal
+station and GPS receivers).
+.Nm
+implements a timedelta sensor and the delta (in nanoseconds) between the
+received time information and the local time can be accessed through the
+.Xr sysctl 8
+interface.
+.Pp
+The card type is indicated in the sensor description.
+Currently, the following cards are supported by
+.Nm :
+.Pp
+.Bl -tag -width "GPS170XXX" -offset indent -compact
+.It GPS170PCI
+3.3V/5V 6-channel GPS receiver card
+.It PCI32
+5V DCF77 time signal station receiver card
+.It PCI509
+5V DCF77 time signal station receiver card
+.It PCI510
+3.3V/5V DCF77 time signal station receiver card
+.It PCI511
+3.3V/5V DCF77 time signal station receiver card
+.It PEX511
+PCI Express DCF77 time signal station receiver card
+.It PZF180PEX
+PCI Express DCF77 time signal station receiver card
+.El
+.Pp
+The quality of the timedelta is reported as the sensor status:
+.Bl -tag -width "CRITICALXX" -offset indent
+.It UNKNOWN
+No valid time information has been received yet.
+.It OK
+The time information is valid and the timedelta is safe to use for
+applications like
+.Xr ntpd 8 .
+.It WARN
+The time information is still valid, but no new time information has been
+decoded for twelve hours (four days in the case of a GPS170PCI card) due to
+a reception or parity error.
+The timedelta should be used with care.
+.It CRITICAL
+No valid time information has been received for more than twelve hours (or
+four days in the case of a GPS170PCI card) since the sensor state degraded
+from OK to WARN.
+This is an indication that hardware should be checked to see if it is still
+functional.
+.El
+.Pp
+A second sensor provides the relative signal quality as a percentage.
+The status of this sensor is used to report the status of the device itself:
+.Bl -tag -width "CRITICALXX" -offset indent
+.It OK
+The clock is synchronized.
+.It WARN
+The device's clock is free running on the local oscillator.
+For DCF77 receiver cards this is not an error and can happen due to the
+nature of the signal transmission using longwave radio.
+.It CRITICAL
+Hardware failure, e.g. communication with the device failed.
+.El
+.Sh SEE ALSO
+.Xr intro 4 ,
+.Xr pci 4 ,
+.Xr ntpd 8 ,
+.Xr sysctl 8
+.Sh HISTORY
+The
+.Nm
+driver first appeared in
+.Ox 4.1 .
+.Sh AUTHORS
+The
+.Nm
+driver was written by
+.An Marc Balmer Aq Mt mbalmer@openbsd.org .