mbgtools-lx  4.2.8

Macros

#define MAX_N_MULTI_REF_TYPES   32
 Theoretical maximum number of multi ref input signal types. More...
 
#define DEFAULT_MULTI_REF_NAMES
 Names of known ref time sources. More...
 
#define DEFAULT_MULTI_REF_NAMES_SHORT
 Short names of supported ref time sources. More...
 

Enumerations

enum  MULTI_REF_TYPES {
  MULTI_REF_NONE = -1, MULTI_REF_GPS = 0, MULTI_REF_10MHZ, MULTI_REF_PPS,
  MULTI_REF_10MHZ_PPS, MULTI_REF_IRIG, MULTI_REF_NTP, MULTI_REF_PTP,
  MULTI_REF_PTP_E1, MULTI_REF_FREQ, MULTI_REF_PPS_STRING, MULTI_REF_GPIO,
  MULTI_REF_INTERNAL, MULTI_REF_PZF, MULTI_REF_LWR, MULTI_REF_GRC,
  MULTI_REF_HAVEQUICK, MULTI_REF_EXT_OSC, MULTI_REF_SYNCE, N_MULTI_REF
}
 Enumeration of all known types of reference time source. More...
 
#define HAS_MULTI_REF_GPS   ( 1UL << MULTI_REF_GPS )
 Bit masks associated with multi ref types. More...
 
#define HAS_MULTI_REF_10MHZ   ( 1UL << MULTI_REF_10MHZ )
 see MULTI_REF_10MHZ More...
 
#define HAS_MULTI_REF_PPS   ( 1UL << MULTI_REF_PPS )
 see MULTI_REF_PPS More...
 
#define HAS_MULTI_REF_10MHZ_PPS   ( 1UL << MULTI_REF_10MHZ_PPS )
 see MULTI_REF_10MHZ_PPS More...
 
#define HAS_MULTI_REF_IRIG   ( 1UL << MULTI_REF_IRIG )
 see MULTI_REF_IRIG More...
 
#define HAS_MULTI_REF_NTP   ( 1UL << MULTI_REF_NTP )
 see MULTI_REF_NTP More...
 
#define HAS_MULTI_REF_PTP   ( 1UL << MULTI_REF_PTP )
 see MULTI_REF_PTP More...
 
#define HAS_MULTI_REF_PTP_E1   ( 1UL << MULTI_REF_PTP_E1 )
 see MULTI_REF_PTP_E1 More...
 
#define HAS_MULTI_REF_FREQ   ( 1UL << MULTI_REF_FREQ )
 see MULTI_REF_FREQ More...
 
#define HAS_MULTI_REF_PPS_STRING   ( 1UL << MULTI_REF_PPS_STRING )
 see MULTI_REF_PPS_STRING More...
 
#define HAS_MULTI_REF_GPIO   ( 1UL << MULTI_REF_GPIO )
 see MULTI_REF_GPIO More...
 
#define HAS_MULTI_REF_INTERNAL   ( 1UL << MULTI_REF_INTERNAL )
 see MULTI_REF_INTERNAL More...
 
#define HAS_MULTI_REF_PZF   ( 1UL << MULTI_REF_PZF )
 see MULTI_REF_PZF More...
 
#define HAS_MULTI_REF_LWR   ( 1UL << MULTI_REF_LWR )
 see MULTI_REF_LWR More...
 
#define HAS_MULTI_REF_GRC   ( 1UL << MULTI_REF_GRC )
 see MULTI_REF_GRC More...
 
#define HAS_MULTI_REF_HAVEQUICK   ( 1UL << MULTI_REF_HAVEQUICK )
 see MULTI_REF_HAVEQUICK More...
 
#define HAS_MULTI_REF_EXT_OSC   ( 1UL << MULTI_REF_EXT_OSC )
 see MULTI_REF_EXT_OSC More...
 
#define HAS_MULTI_REF_SYNCE   ( 1UL << MULTI_REF_SYNCE )
 see MULTI_REF_SYNCE More...
 

Detailed Description

Common definitions used with both the old and the extended multi ref API.

Macro Definition Documentation

◆ DEFAULT_MULTI_REF_NAMES

#define DEFAULT_MULTI_REF_NAMES
Value:
{ \
"GPS", \
"10 MHz freq in", \
"PPS in", \
"10 MHz + PPS in", \
"IRIG", \
"NTP", \
"PTP (IEEE1588)", \
"PTP over E1", \
"Fixed Freq. in", \
"PPS plus string", \
"Var. freq. via GPIO", \
"(reserved)", \
"DCF77 PZF Receiver", \
"Long Wave Receiver", \
"GNSS Receiver", \
"HaveQuick Input", \
"ext. Osc.", \
"Synchronous Ethernet" \
}

Names of known ref time sources.

See also
MULTI_REF_TYPES

Definition at line 6457 of file gpsdefs.h.

Referenced by mbg_get_all_ucap_info().

◆ DEFAULT_MULTI_REF_NAMES_SHORT

#define DEFAULT_MULTI_REF_NAMES_SHORT
Value:
{ \
"GPS", \
"FRQ", \
"PPS", \
"10MHZ+PPS", \
"TCR", \
"NTP", \
"PTP", \
"PTP_E1", \
"FIXED_FREQ", \
"STRING+PPS", \
"GPIO", \
"(reserved)", \
"PZF", \
"LWR", \
"GNSS", \
"HQI", \
"EXT", \
"SYNCE" \
}

Short names of supported ref time sources.

Used e.g. to configure a particular input signal type

See also
MULTI_REF_TYPES

Definition at line 6486 of file gpsdefs.h.

◆ HAS_MULTI_REF_10MHZ

#define HAS_MULTI_REF_10MHZ   ( 1UL << MULTI_REF_10MHZ )

see MULTI_REF_10MHZ

Definition at line 6520 of file gpsdefs.h.

◆ HAS_MULTI_REF_10MHZ_PPS

#define HAS_MULTI_REF_10MHZ_PPS   ( 1UL << MULTI_REF_10MHZ_PPS )

see MULTI_REF_10MHZ_PPS

Definition at line 6522 of file gpsdefs.h.

◆ HAS_MULTI_REF_EXT_OSC

#define HAS_MULTI_REF_EXT_OSC   ( 1UL << MULTI_REF_EXT_OSC )

see MULTI_REF_EXT_OSC

Definition at line 6537 of file gpsdefs.h.

◆ HAS_MULTI_REF_FREQ

#define HAS_MULTI_REF_FREQ   ( 1UL << MULTI_REF_FREQ )

see MULTI_REF_FREQ

Definition at line 6528 of file gpsdefs.h.

◆ HAS_MULTI_REF_GPIO

#define HAS_MULTI_REF_GPIO   ( 1UL << MULTI_REF_GPIO )

see MULTI_REF_GPIO

Definition at line 6530 of file gpsdefs.h.

◆ HAS_MULTI_REF_GPS

#define HAS_MULTI_REF_GPS   ( 1UL << MULTI_REF_GPS )

Bit masks associated with multi ref types.

Used to indicate which multi ref types are supported, e.g. in XMULTI_REF_INFO::supp_ref or MULTI_REF_INFO::supp_ref.

See also
MULTI_REF_TYPES

see MULTI_REF_GPS

Definition at line 6519 of file gpsdefs.h.

◆ HAS_MULTI_REF_GRC

#define HAS_MULTI_REF_GRC   ( 1UL << MULTI_REF_GRC )

see MULTI_REF_GRC

Definition at line 6534 of file gpsdefs.h.

◆ HAS_MULTI_REF_HAVEQUICK

#define HAS_MULTI_REF_HAVEQUICK   ( 1UL << MULTI_REF_HAVEQUICK )

see MULTI_REF_HAVEQUICK

Definition at line 6535 of file gpsdefs.h.

◆ HAS_MULTI_REF_INTERNAL

#define HAS_MULTI_REF_INTERNAL   ( 1UL << MULTI_REF_INTERNAL )

see MULTI_REF_INTERNAL

Definition at line 6531 of file gpsdefs.h.

◆ HAS_MULTI_REF_IRIG

#define HAS_MULTI_REF_IRIG   ( 1UL << MULTI_REF_IRIG )

see MULTI_REF_IRIG

Definition at line 6523 of file gpsdefs.h.

◆ HAS_MULTI_REF_LWR

#define HAS_MULTI_REF_LWR   ( 1UL << MULTI_REF_LWR )

see MULTI_REF_LWR

Definition at line 6533 of file gpsdefs.h.

◆ HAS_MULTI_REF_NTP

#define HAS_MULTI_REF_NTP   ( 1UL << MULTI_REF_NTP )

see MULTI_REF_NTP

Definition at line 6524 of file gpsdefs.h.

◆ HAS_MULTI_REF_PPS

#define HAS_MULTI_REF_PPS   ( 1UL << MULTI_REF_PPS )

see MULTI_REF_PPS

Definition at line 6521 of file gpsdefs.h.

◆ HAS_MULTI_REF_PPS_STRING

#define HAS_MULTI_REF_PPS_STRING   ( 1UL << MULTI_REF_PPS_STRING )

see MULTI_REF_PPS_STRING

Definition at line 6529 of file gpsdefs.h.

◆ HAS_MULTI_REF_PTP

#define HAS_MULTI_REF_PTP   ( 1UL << MULTI_REF_PTP )

see MULTI_REF_PTP

Definition at line 6525 of file gpsdefs.h.

◆ HAS_MULTI_REF_PTP_E1

#define HAS_MULTI_REF_PTP_E1   ( 1UL << MULTI_REF_PTP_E1 )

see MULTI_REF_PTP_E1

Definition at line 6526 of file gpsdefs.h.

◆ HAS_MULTI_REF_PZF

#define HAS_MULTI_REF_PZF   ( 1UL << MULTI_REF_PZF )

see MULTI_REF_PZF

Definition at line 6532 of file gpsdefs.h.

◆ HAS_MULTI_REF_SYNCE

#define HAS_MULTI_REF_SYNCE   ( 1UL << MULTI_REF_SYNCE )

see MULTI_REF_SYNCE

Definition at line 6538 of file gpsdefs.h.

◆ MAX_N_MULTI_REF_TYPES

#define MAX_N_MULTI_REF_TYPES   32

Theoretical maximum number of multi ref input signal types.

Actually only N_MULTI_REF types have been defined, but N_MULTI_REF must not exceed the number of bits which can be hold by a uint32_t type.

Definition at line 6449 of file gpsdefs.h.

Referenced by mbg_get_all_ucap_info().

Enumeration Type Documentation

◆ MULTI_REF_TYPES

Enumeration of all known types of reference time source.

All known types of input signal which may possibly be supported by devices which support several different input signals, i.e. have the GPS_HAS_MULTI_REF or GPS_HAS_XMULTI_REF bit set in RECEIVER_INFO::features. Not all devices support each known type of input signal.

See also
Support for multiple reference time sources
DEFAULT_MULTI_REF_NAMES
DEFAULT_MULTI_REF_NAMES_SHORT
MULTI_REF_TYPE_MASKS
Enumerator
MULTI_REF_NONE 

This ref type must not be used as index, but marks particular XMULTI_REF_SETTINGS structures as "unused". It is only supported if bit XMRIF_BIT_MRF_NONE_SUPP is set.

MULTI_REF_GPS 

standard GPS

MULTI_REF_10MHZ 

10 MHz input frequency

MULTI_REF_PPS 

1 PPS input signal

MULTI_REF_10MHZ_PPS 

combined 10 MHz plus PPS

MULTI_REF_IRIG 

IRIG input.

MULTI_REF_NTP 

Network Time Protocol (NTP)

MULTI_REF_PTP 

Precision Time Protocol (PTP/IEEE1588)

MULTI_REF_PTP_E1 

PTP over E1.

MULTI_REF_FREQ 

fixed frequency

MULTI_REF_PPS_STRING 

1 PPS in addition to time string

MULTI_REF_GPIO 

variable input signal via GPIO

MULTI_REF_INTERNAL 

reserved, used internally by firmware only

MULTI_REF_PZF 

DCF77 PZF providing much more accuracy than a standard LWR.

MULTI_REF_LWR 

long wave receiver. e.g. DCF77 AM, WWVB, MSF, JJY

MULTI_REF_GRC 

Glonass / GPS receiver.

MULTI_REF_HAVEQUICK 

HaveQuick input.

MULTI_REF_EXT_OSC 

external oscillator disciplined and looped back via 1 PPS I/O

MULTI_REF_SYNCE 

Synchronous Ethernet, needs (external) ethernet interface.

N_MULTI_REF 

the number of defined sources, must not exceed MAX_N_MULTI_REF_TYPES

Definition at line 6415 of file gpsdefs.h.