xref: /openbsd/share/man/man4/mbg.4 (revision 274d7c50)
1.\"	$OpenBSD: mbg.4,v 1.14 2013/07/16 16:05:49 schwarze 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: July 16 2013 $
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 PCI511
483.3V/5V DCF77 time signal station receiver card
49.It PEX511
50PCI Express DCF77 time signal station receiver card
51.El
52.Pp
53The quality of the timedelta is reported as the sensor status:
54.Bl -tag -width "CRITICALXX" -offset indent
55.It UNKNOWN
56No valid time information has been received yet.
57.It OK
58The time information is valid and the timedelta is safe to use for
59applications like
60.Xr ntpd 8 .
61.It WARN
62The time information is still valid, but no new time information has been
63decoded for twelve hours (four days in the case of a GPS170PCI card) due to
64a reception or parity error.
65The timedelta should be used with care.
66.It CRITICAL
67No valid time information has been received for more than twelve hours (or
68four days in the case of a GPS170PCI card) since the sensor state degraded
69from OK to WARN.
70This is an indication that hardware should be checked to see if it is still
71functional.
72.El
73.Pp
74A second sensor provides the relative signal quality as a percentage.
75The status of this sensor is used to report the status of the device itself:
76.Bl -tag -width "CRITICALXX" -offset indent
77.It OK
78The clock is synchronized.
79.It WARN
80The device's clock is free running on the local oscillator.
81For DCF77 receiver cards this is not an error and can happen due to the
82nature of the signal transmission using longwave radio.
83.It CRITICAL
84Hardware failure, e.g. communication with the device failed.
85.El
86.Sh SEE ALSO
87.Xr intro 4 ,
88.Xr pci 4 ,
89.Xr ntpd 8 ,
90.Xr sysctl 8
91.Sh HISTORY
92The
93.Nm
94driver first appeared in
95.Ox 4.1 .
96.Sh AUTHORS
97The
98.Nm
99driver was written by
100.An Marc Balmer Aq Mt mbalmer@openbsd.org .
101