xref: /openbsd-src/share/man/man4/mbg.4 (revision aed994fea9b2ad635c85d29b2fe182f326cf04f1)
1.\"	$OpenBSD: mbg.4,v 1.16 2024/03/23 10:38:02 sthen Exp $
2.\"
3.\" Copyright (c) 2006 Marc Balmer <mbalmer@openbsd.org>
4.\"
5.\" Permission to use, copy, modify, and distribute this software for any
6.\" purpose with or without fee is hereby granted, provided that the above
7.\" copyright notice and this permission notice appear in all copies.
8.\"
9.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16.\"
17.Dd $Mdocdate: March 23 2024 $
18.Dt MBG 4
19.Os
20.Sh NAME
21.Nm mbg
22.Nd Meinberg Funkuhren timedelta sensor
23.Sh SYNOPSIS
24.Cd "mbg* at pci?"
25.Sh DESCRIPTION
26The
27.Nm
28driver provides support for Meinberg Funkuhren radio clocks (time signal
29station and GPS receivers).
30.Nm
31implements a timedelta sensor and the delta (in nanoseconds) between the
32received time information and the local time can be accessed through the
33.Xr sysctl 8
34interface.
35.Pp
36The card type is indicated in the sensor description.
37Currently, the following cards are supported by
38.Nm :
39.Pp
40.Bl -tag -width "GPS170XXX" -offset indent -compact
41.It GPS170PCI
423.3V/5V 6-channel GPS receiver card
43.It PCI32
445V DCF77 time signal station receiver card
45.It PCI509
465V DCF77 time signal station receiver card
47.It PCI510
483.3V/5V DCF77 time signal station receiver card
49.It PCI511
503.3V/5V DCF77 time signal station receiver card
51.It PEX511
52PCI Express DCF77 time signal station receiver card
53.It PZF180PEX
54PCI Express DCF77 time signal station receiver card
55.El
56.Pp
57The quality of the timedelta is reported as the sensor status:
58.Bl -tag -width "CRITICALXX" -offset indent
59.It UNKNOWN
60No valid time information has been received yet.
61.It OK
62The time information is valid and the timedelta is safe to use for
63applications like
64.Xr ntpd 8 .
65.It WARN
66The time information is still valid, but no new time information has been
67decoded for twelve hours (four days in the case of a GPS170PCI card) due to
68a reception or parity error.
69The timedelta should be used with care.
70.It CRITICAL
71No valid time information has been received for more than twelve hours (or
72four days in the case of a GPS170PCI card) since the sensor state degraded
73from OK to WARN.
74This is an indication that hardware should be checked to see if it is still
75functional.
76.El
77.Pp
78A second sensor provides the relative signal quality as a percentage.
79The status of this sensor is used to report the status of the device itself:
80.Bl -tag -width "CRITICALXX" -offset indent
81.It OK
82The clock is synchronized.
83.It WARN
84The device's clock is free running on the local oscillator.
85For DCF77 receiver cards this is not an error and can happen due to the
86nature of the signal transmission using longwave radio.
87.It CRITICAL
88Hardware failure, e.g. communication with the device failed.
89.El
90.Sh SEE ALSO
91.Xr intro 4 ,
92.Xr pci 4 ,
93.Xr ntpd 8 ,
94.Xr sysctl 8
95.Sh HISTORY
96The
97.Nm
98driver first appeared in
99.Ox 4.1 .
100.Sh AUTHORS
101The
102.Nm
103driver was written by
104.An Marc Balmer Aq Mt mbalmer@openbsd.org .
105