#include <words.h>
#include <use_pack.h>

Data Structures
struct	PCPS_TIME_STAMP
	A high resolution time stamp. More...

struct	PCPS_TIME_STATUS_X_MASKS

struct	PCPS_HR_TIME
	High resolution time including status and local time offset. More...

struct	PCPS_TIME
	Local calendar date and time, plus sync status. More...

struct	PCPS_STIME
	Date time and status used with the PCPS_SET_TIME command. More...

union	PCPS_TIME_UNION

struct	PCPS_IRIG_TIME
	Raw IRIG time. More...

struct	PCPS_DL_ONOFF
	Daylight changeover specification. More...

struct	PCPS_TZDL
	Specification of a local time zone. More...

struct	PCPS_UCAP_ENTRIES
	Status of the time capture FIFO buffer. More...

struct	CORR_INFO
	PZF correlation status info. More...

Macros
#define	_USE_PCPSPRIV _IS_MBG_FIRMWARE

#define	PCPS_REF_NAME_NONE_ENG "unknown"

#define	PCPS_REF_NAME_NONE_GER "nicht bekannt"

#define	PCPS_REF_NAME_DCF "DCF77"

#define	PCPS_REF_NAME_GPS "GPS"

#define	PCPS_REF_NAME_IRIG "IRIG"

#define	PCPS_REF_NAME_MSF "MSF"

#define	PCPS_REF_NAME_PTP "PTP"

#define	PCPS_REF_NAME_FRC "FRC"

#define	PCPS_REF_NAME_WWVB "WWVB"

#define	PCPS_REF_NAME_JJY "JJY"

#define	PCPS_REF_NAMES_ENG
	Initializer for an array of English reference type names. More...

#define	PCPS_REF_NAMES_LSTR
	Initializer for a multi-language array of reference type names. More...

#define	PCI_VENDOR_MEINBERG 0x1360
	Meinberg PCI vendor ID (assigned by the PCI SIG) More...

#define	MBG_PCPS_FMT_STATUS

#define	MBG_CMD_TABLE_EXT _mbg_cn_table_end()

#define	PCPS_CMD_CODES_TABLE
	An initializer for a table of code/name entries of non-GPS commands. More...

#define	BITMASK(b) ( ( 1 << b ) - 1 )

#define	PCPS_FIFO_SIZE 16
	The size of a bus level device's command/data FIFO. More...

#define	PCPS_ID_SIZE ( 2 * PCPS_FIFO_SIZE + 1 )
	The maximum length of an ID string, including terminating 0. More...

#define	PCPS_SN_SIZE ( PCPS_FIFO_SIZE + 1 )
	The maximum length of a serial number string, including terminating 0. More...

#define	_mbg_swab_pcps_seconds(_p)

#define	_mbg_swab_pcps_frac_32(_p)

#define	_mbg_swab_pcps_time_stamp(_p)

#define	PCPS_HRT_FRAC_SCALE 10000000UL
	Scale to be used to print PCPS_TIME_STAMP::frac values. More...

#define	PCPS_HRT_FRAC_SCALE_FMT "%07lu"
	Format specifier used to print PCPS_TIME_STAMP::frac values. More...

#define	_mbg_swab_pcps_time_status_x(_p) _mbg_swab16( _p )

#define	_mbg_swab_pcps_time_status_x_masks(_p)

#define	_mbg_swab_pcps_hr_time(_p)

#define	sizeof_PCPS_TIME sizeof( PCPS_TIME )

#define	sizeof_PCPS_STIME sizeof( PCPS_STIME )

#define	_mbg_swab_pcps_irig_time(_p)

#define	IRIG_TIME_UNKNOWN_YEAR 0xFF
	A constant representing a 2 digit unknown IRIG year number. More...

#define	PCPS_TZCODE_MEZMESZ PCPS_TZCODE_CET_CEST

#define	PCPS_TZCODE_MEZ PCPS_TZCODE_CET

#define	PCPS_TZCODE_OEZ PCPS_TZCODE_EET_EEST

#define	_mbg_swab_pcps_dl_onoff(_p)

#define	DL_AUTO_FLAG 0x8000
	A flag indicating if DST changeovers are to be computed automatically. More...

#define	_mbg_swab_pcps_tzdl(_p)

#define	_mbg_swab_pcps_ucap_entries(_p)

#define	_mbg_swab_tr_distance(_p) _mbg_swab16( _p )

#define	_mbg_swab_corr_info(_p) _nop_macro_fnc()

#define	PZF_CORR_STATE_NAME_RAW_ENG "Searching"

#define	PZF_CORR_STATE_NAME_CHECK_ENG "Correlating"

#define	PZF_CORR_STATE_NAME_FINE_ENG "Locked"

#define	PZF_CORR_STATE_NAME_RAW_GER "suchen"

#define	PZF_CORR_STATE_NAME_CHECK_GER "korrelieren"

#define	PZF_CORR_STATE_NAME_FINE_GER "eingerastet"

#define	PZF_CORR_STATE_NAMES_ENG

#define	PZF_CORR_STATE_NAMES_LSTR

#define	PC_GPS_CMD_CODES_TABLE
	An initializer for a table of code/name entries of GPS commands. More...


#define	PCI_DEV_PCI32 ( ( PCPS_REF_DCF << 8 ) \| 0x01 )
	PCI device IDs assigned by Meinberg. More...

#define	PCI_DEV_PCI509 ( ( PCPS_REF_DCF << 8 ) \| 0x02 )

#define	PCI_DEV_PCI510 ( ( PCPS_REF_DCF << 8 ) \| 0x03 )

#define	PCI_DEV_PCI511 ( ( PCPS_REF_DCF << 8 ) \| 0x04 )

#define	PCI_DEV_PEX511 ( ( PCPS_REF_DCF << 8 ) \| 0x05 )

#define	PCI_DEV_PZF180PEX ( ( PCPS_REF_DCF << 8 ) \| 0x06 )

#define	PCI_DEV_GPS167PCI ( ( PCPS_REF_GPS << 8 ) \| 0x01 )

#define	PCI_DEV_GPS168PCI ( ( PCPS_REF_GPS << 8 ) \| 0x02 )

#define	PCI_DEV_GPS169PCI ( ( PCPS_REF_GPS << 8 ) \| 0x03 )

#define	PCI_DEV_GPS170PCI ( ( PCPS_REF_GPS << 8 ) \| 0x04 )

#define	PCI_DEV_GPS170PEX ( ( PCPS_REF_GPS << 8 ) \| 0x05 )

#define	PCI_DEV_GPS180PEX ( ( PCPS_REF_GPS << 8 ) \| 0x06 )

#define	PCI_DEV_GLN180PEX ( ( PCPS_REF_GPS << 8 ) \| 0x07 )

#define	PCI_DEV_GPS180AMC ( ( PCPS_REF_GPS << 8 ) \| 0x08 )

#define	PCI_DEV_GNS181PEX ( ( PCPS_REF_GPS << 8 ) \| 0x09 )

#define	PCI_DEV_TCR510PCI ( ( PCPS_REF_IRIG << 8 ) \| 0x01 )

#define	PCI_DEV_TCR167PCI ( ( PCPS_REF_IRIG << 8 ) \| 0x02 )

#define	PCI_DEV_TCR511PCI ( ( PCPS_REF_IRIG << 8 ) \| 0x03 )

#define	PCI_DEV_TCR511PEX ( ( PCPS_REF_IRIG << 8 ) \| 0x04 )

#define	PCI_DEV_TCR170PEX ( ( PCPS_REF_IRIG << 8 ) \| 0x05 )

#define	PCI_DEV_TCR180PEX ( ( PCPS_REF_IRIG << 8 ) \| 0x06 )

#define	PCI_DEV_PTP270PEX ( ( PCPS_REF_PTP << 8 ) \| 0x01 )

#define	PCI_DEV_FRC511PEX ( ( PCPS_REF_FRC << 8 ) \| 0x01 )


#define	PCPS_ST_BUSY 0x01
	Bit masks used with PCPS_STATUS_PORT. More...

#define	PCPS_ST_IRQF 0x02
	the clock has generated an IRQ on the PC bus (ISA cards only) More...

#define	PCPS_ST_MOD 0x20
	the raw demodulated DCF77 signal More...

#define	PCPS_ST_SEC 0x40
	seconds have changed since last reading More...

#define	PCPS_ST_MIN 0x80
	minutes have changed since last reading More...


#define	PCPS_GIVE_TIME 0x00
	Command codes used to communicate with bus level devices. More...

#define	PCPS_GIVE_TIME_NOCLEAR 0x01
	(r-) Read current time in PCPS_TIME format, don't clear sec and min flags (deprecated) More...

#define	PCPS_GIVE_SYNC_TIME 0x02
	(r-) Read last sync time as PCPS_TIME, only if _pcps_has_sync_time More...

#define	PCPS_GIVE_HR_TIME 0x03
	(r-) Read high res. time as PCPS_HR_TIME, only if _pcps_has_hr_time More...

#define	PCPS_GIVE_IRIG_TIME 0x04
	(r-) Read raw IRIG time as PCPS_IRIG_TIME, only if _pcps_has_irig_time More...

#define	PCPS_SET_TIME 0x10
	(-w) Set on-board time, see PCPS_STIME. Returns MBG_ERR_STIME on error. More...

#define	PCPS_SET_EVENT_TIME 0x14
	(-w) Write event time as PCPS_TIME_STAMP, only if _pcps_has_event_time More...

#define	PCPS_IRQ_NONE 0x20
	(-w) Disable IRQs More...

#define	PCPS_IRQ_1_SEC 0x21
	(-w) Enable IRQ per 1 second More...

#define	PCPS_IRQ_1_MIN 0x22
	(-w) Enable IRQ per 1 minute (deprecated) More...

#define	PCPS_IRQ_10_MIN 0x24
	(-w) Enable IRQ per 10 minutes (deprecated) More...

#define	PCPS_IRQ_30_MIN 0x28
	(-w) Enable IRQ per 10 minutes (deprecated) More...

#define	PCPS_GET_SERIAL 0x30
	(r-) Read serial settings as PCPS_SERIAL, deprecated by PC_GPS_ALL_PORT_INFO More...

#define	PCPS_SET_SERIAL 0x31
	(-w) Write serial settings as PCPS_SERIAL, deprecated by PC_GPS_PORT_SETTINGS_IDX, returns MBG_ERR_CFG on error More...

#define	PCPS_GET_TZCODE 0x32
	(r-) Read PCPS_TZCODE, only if _pcps_has_tzcode More...

#define	PCPS_SET_TZCODE 0x33
	(-w) Write PCPS_TZCODE, only if _pcps_has_tzcode, returns MBG_ERR_CFG on error More...

#define	PCPS_GET_PCPS_TZDL 0x34
	(r-) Read PCPS_TZDL, only if _pcps_has_pcps_tzdl More...

#define	PCPS_SET_PCPS_TZDL 0x35
	(-w) Write PCPS_TZDL, only if _pcps_has_pcps_tzdl, returns MBG_ERR_CFG on error More...

#define	PCPS_GET_REF_OFFS 0x36
	(r-) Read MBG_REF_OFFS, only if _pcps_has_ref_offs More...

#define	PCPS_SET_REF_OFFS 0x37
	(-w) Write MBG_REF_OFFS, only if _pcps_has_ref_offs, returns MBG_ERR_CFG on error More...

#define	PCPS_GET_OPT_INFO 0x38
	(r-) Read MBG_OPT_INFO, only if _pcps_has_opt_flags More...

#define	PCPS_SET_OPT_SETTINGS 0x39
	(-w) Write MBG_OPT_SETTINGS, only if _pcps_has_opt_flags, returns MBG_ERR_CFG on error More...

#define	PCPS_GET_IRIG_RX_INFO 0x3A
	(r-) Read IRIG_INFO, only if _pcps_is_irig_rx More...

#define	PCPS_SET_IRIG_RX_SETTINGS 0x3B
	(-w) Write IRIG_SETTINGS, only if _pcps_is_irig_rx, returns MBG_ERR_CFG on error More...

#define	PCPS_GET_IRIG_TX_INFO 0x3C
	(r-) Read IRIG_INFO, only if _pcps_has_irig_tx More...

#define	PCPS_SET_IRIG_TX_SETTINGS 0x3D
	(-w) Write IRIG_SETTINGS, only if _pcps_has_irig_tx, returns MBG_ERR_CFG on error More...

#define	PCPS_GET_SYNTH 0x3E
	(r-) Read SYNTH, only if _pcps_has_synth More...

#define	PCPS_SET_SYNTH 0x3F
	(-w) Write SYNTH, only if _pcps_has_synth, returns MBG_ERR_CFG on error More...

#define	PCPS_GIVE_FW_ID_1 0x40
	(r-) Read first PCPS_FIFO_SIZE chars of firmware ID More...

#define	PCPS_GIVE_FW_ID_2 0x41
	(r-) Read last PCPS_FIFO_SIZE chars of firmware ID More...

#define	PCPS_GIVE_SERNUM 0x42
	(r-) Read serial number as PCPS_SN_STR, only if _pcps_has_sernum More...

#define	PCPS_GENERIC_IO 0x43
	(rw) See pcps_generic_io or _mbgdevio_gen_io More...

#define	PCPS_GET_SYNTH_STATE 0x44
	(r-) Read SYNTH_STATE, only if _pcps_has_synth More...

#define	PCPS_GET_IRIG_CTRL_BITS 0x45
	(r-) Read MBG_IRIG_CTRL_BITS, only if _pcps_has_irig_ctrl_bits More...

#define	PCPS_GET_RAW_IRIG_DATA 0x46
	(r-) Read MBG_RAW_IRIG_DATA, only if _pcps_has_raw_irig_data More...

#define	PCPS_GET_STATUS_PORT 0x4B
	(r-) Read PCPS_STATUS_PORT More...

#define	PCPS_GET_DEBUG_STATUS 0x4C
	(r-) Read MBG_DEBUG_STATUS, only if _pcps_has_debug_status More...

#define	PCPS_READ_GPS_DATA 0x50
	(r-) Read large data structure, see PC_GPS_CMD_CODES More...

#define	PCPS_WRITE_GPS_DATA 0x51
	(-w) Write large data structure, see PC_GPS_CMD_CODES More...

#define	PCPS_CLR_UCAP_BUFF 0x60
	(-w) No param., clear on-board capture FIFO, only if _pcps_has_ucap More...

#define	PCPS_GIVE_UCAP_ENTRIES 0x61
	(r-) Read PCPS_UCAP_ENTRIES, only if _pcps_has_ucap More...

#define	PCPS_GIVE_UCAP_EVENT 0x62
	(r-) Return oldest event as PCPS_HR_TIME, only if _pcps_has_ucap More...

#define	PCPS_GET_CORR_INFO 0x63
	(r-) Read CORR_INFO structure, only if _pcps_has_pzf More...

#define	PCPS_GET_TR_DISTANCE 0x64
	(r-) Read TR_DISTANCE, only if _pcps_has_tr_distance More...

#define	PCPS_SET_TR_DISTANCE 0x65
	(-w) Write TR_DISTANCE, only if _pcps_has_tr_distance More...

#define	PCPS_CLR_EVT_LOG 0x66
	(-w) Write clear on-board event log, only if _pcps_has_evt_log More...

#define	PCPS_NUM_EVT_LOG_ENTRIES 0x67
	(r-) Read MBG_NUM_EVT_LOG_ENTRIES, only if _pcps_has_evt_log More...

#define	PCPS_FIRST_EVT_LOG_ENTRY 0x68
	(r-) Read first (oldest) MBG_EVT_LOG_ENTRY, only if _pcps_has_evt_log More...

#define	PCPS_NEXT_EVT_LOG_ENTRY 0x69
	(r-) Read next MBG_EVT_LOG_ENTRY, only if _pcps_has_evt_log More...

#define	PCPS_FORCE_RESET 0x80
	(-w) No param., reset the device (deprecated, this can lock up the computer!!) More...


#define	PCPS_SUCCESS 0
	Bus level command return codes. More...

#define	PCPS_ERR_STIME -1
	invalid date/time/status passed (see MBG_ERR_STIME) More...

#define	PCPS_ERR_CFG -2
	invalid parms for a cmd writing config parameters (see MBG_ERR_CFG) More...

Typedefs
typedef uint8_t	PCPS_STATUS_PORT
	Type of the status register port. More...

typedef int8_t	PCPS_BUFF[16]
	A data buffer for a bus level device's command/data. More...

typedef char	PCPS_ID_STR[(2 *16+1)]
	A buffer for an ID string, including terminating 0. More...

typedef char	PCPS_SN_STR[(16+1)]
	A buffer for a serial number string, including terminating 0. More...

typedef uint32_t	PCPS_SECONDS
	Seconds since epoch 1970-01-01, usually UTC scale. More...

typedef uint32_t	PCPS_FRAC_32
	32 bit binary fraction of a second More...

typedef uint16_t	PCPS_TIME_STATUS_X
	Extended status code. More...

typedef uint8_t	PCPS_TIME_STATUS
	Time synchronization status. More...

typedef uint8_t	PCPS_TZCODE
	Type of variable to hold a TZ code. More...

typedef uint16_t	TR_DISTANCE
	Receiver distance from transmitter [km]. More...

typedef uint16_t	PCPS_CMD_INFO
	A type used to store an unambiguous command code. More...

Enumerations
enum	PCPS_REF_TYPES { PCPS_REF_NONE, PCPS_REF_DCF, PCPS_REF_GPS, PCPS_REF_IRIG, PCPS_REF_MSF, PCPS_REF_PTP, PCPS_REF_FRC, PCPS_REF_WWVB, PCPS_REF_JJY, N_PCPS_REF }
	Enumeration of the ref time signal sources used by Meinberg devices. More...

enum	PCPS_TZCODES { PCPS_TZCODE_CET_CEST, PCPS_TZCODE_CET, PCPS_TZCODE_UTC, PCPS_TZCODE_EET_EEST, N_PCPS_TZCODE }
	Enumeration of codes used with PCPS_TZCODE. More...

enum	PZF_CORR_STATES { PZF_CORR_RAW, PZF_CORR_CHECK, PZF_CORR_FINE, N_PZF_CORR_STATE }
	Codes used with CORR_INFO::status. More...

enum	PC_GPS_CMD_CODES { PC_GPS_TZDL, PC_GPS_SW_REV, PC_GPS_BVAR_STAT, PC_GPS_TIME, PC_GPS_POS_XYZ, PC_GPS_POS_LLA, PC_GPS_PORT_PARM, PC_GPS_ANT_INFO, PC_GPS_UCAP, PC_GPS_ENABLE_FLAGS, PC_GPS_STAT_INFO, PC_GPS_CMD, PC_GPS_IDENT, PC_GPS_POS, PC_GPS_ANT_CABLE_LEN, PC_GPS_RECEIVER_INFO, PC_GPS_ALL_STR_TYPE_INFO, PC_GPS_ALL_PORT_INFO, PC_GPS_PORT_SETTINGS_IDX, PC_GPS_ALL_POUT_INFO, PC_GPS_POUT_SETTINGS_IDX, PC_GPS_TIME_SCALE, PC_GPS_LAN_IF_INFO, PC_GPS_IP4_STATE, PC_GPS_IP4_SETTINGS, PC_GPS_PTP_STATE, PC_GPS_PTP_CFG, PC_GPS_PTP_UC_MASTER_CFG_LIMITS, PC_GPS_ALL_PTP_UC_MASTER_INFO, PC_GPS_PTP_UC_MASTER_SETTINGS_IDX, PC_GPS_GPIO_CFG_LIMITS, PC_GPS_ALL_GPIO_INFO, PC_GPS_GPIO_SETTINGS_IDX, PC_GPS_GNSS_MODE, PC_GPS_ALL_GNSS_SAT_INFO, PC_GPS_XMR_INSTANCES, PC_GPS_XMR_SETTINGS_IDX, PC_GPS_ALL_XMR_INFO, PC_GPS_ALL_XMR_STATUS, PC_GPS_XMR_HOLDOVER_STATUS, PC_GPS_ALL_GPIO_STATUS, PC_GPS_XFEATURE_BUFFER, PC_GPS_TLV_INFO, PC_GPS_CFGH = 0x80, PC_GPS_ALM, PC_GPS_EPH, PC_GPS_UTC, PC_GPS_IONO, PC_GPS_ASCII_MSG }
	GPS Command codes passed via the system bus. More...

enum	PC_GPS_COMMANDS { PC_GPS_CMD_BOOT = 1, PC_GPS_CMD_INIT_SYS, PC_GPS_CMD_INIT_USER, PC_GPS_CMD_INIT_DAC, N_PC_GPS_CMD_CODES }
	Codes used with PC_GPS_CMD. More...

#define	PCPS_SIG_BIAS 55

#define	PCPS_SIG_ERR 1

#define	PCPS_SIG_MIN 20

#define	PCPS_SIG_MAX 68

#define	PCPS_SIG_LVL_SIG_NOT_AVAIL 0

#define	PCPS_SIG_LVL_SIG_AVAIL 128

typedef uint8_t	PCPS_SIG_VAL
	Definitions used to report a signal strength. More...

#define	PCPS_SCALE_MASK ( PCPS_SCALE_TAI \| PCPS_SCALE_GPS )

enum	PCPS_TIME_STATUS_FLAGS_COMMON { PCPS_FREER = 0x01, PCPS_DL_ENB = 0x02, PCPS_SYNCD = 0x04, PCPS_DL_ANN = 0x08, PCPS_UTC = 0x10, PCPS_LS_ANN = 0x20, PCPS_IFTM = 0x40, PCPS_INVT = 0x80 }
	Time status flags. More...

enum	PCPS_TIME_STATUS_FLAGS_EXT { PCPS_LS_ENB = 0x0100, PCPS_ANT_FAIL = 0x0200, PCPS_LS_ANN_NEG = 0x0400, PCPS_SCALE_GPS = 0x0800, PCPS_SCALE_TAI = 0x1000, PCPS_UCAP_OVERRUN = 0x2000, PCPS_UCAP_BUFFER_FULL = 0x4000, PCPS_SYNC_PZF = 0x2000, PCPS_IO_BLOCKED = 0x8000 }
	Extended time status flags. More...

#define	PCPS_BD_BITS 4
	field with in the cfg byte More...

#define	PCPS_BD_SHIFT 0
	num of bits to shift left More...

#define	PCPS_FR_BITS 2
	field with in the cfg byte More...

#define	PCPS_FR_SHIFT PCPS_BD_BITS
	num of bits to shift left More...

#define	PCPS_MOD_BITS 2
	field with in the cfg byte More...

#define	PCPS_MOD_SHIFT ( PCPS_BD_BITS + PCPS_FR_BITS )
	num of bits to shift left More...

enum	PCPS_BD_CODES { PCPS_BD_300, PCPS_BD_600, PCPS_BD_1200, PCPS_BD_2400, PCPS_BD_4800, PCPS_BD_9600, PCPS_BD_19200, N_PCPS_BD }
	Deprecated baud rate indices. More...

enum	PCPS_FR_CODES { PCPS_FR_8N1, PCPS_FR_7E2, PCPS_FR_8N2, PCPS_FR_8E1, N_PCPS_FR_DCF }
	Deprecated framing code indices. More...

enum	PCPS_MOD_CODES { PCPS_MOD_REQ, PCPS_MOD_SEC, PCPS_MOD_MIN, PCPS_MOD_RSVD, N_PCPS_MOD_DCF }
	Deprecated codes for modes of operation. More...

typedef uint8_t	PCPS_SERIAL
	Legacy definitions used to configure a device's serial port. More...

Macro Definition Documentation

◆ _mbg_swab_pcps_dl_onoff

#define _mbg_swab_pcps_dl_onoff ( _p )

Value:

do                                     \
{                                      \
  _mbg_swab16( &(_p)->year_or_wday );  \
} while ( 0 )

Definition at line 1471 of file pcpsdefs.h.

◆ _mbg_swab_pcps_frac_32

#define _mbg_swab_pcps_frac_32 ( _p )

Value:

do                                    \
{                                     \
  _mbg_swab32( _p );                  \
} while ( 0 )

Definition at line 961 of file pcpsdefs.h.

◆ _mbg_swab_pcps_hr_time

#define _mbg_swab_pcps_hr_time ( _p )

Value:

do                                                \
{                                                 \
  _mbg_swab_pcps_time_stamp( &(_p)->tstamp );     \
  _mbg_swab32( &(_p)->utc_offs );                 \
  _mbg_swab_pcps_time_status_x( &(_p)->status );  \
} while ( 0 )

Definition at line 1094 of file pcpsdefs.h.

Referenced by mbg_get_hr_time(), mbg_get_ucap_event(), and mbgclock_default_get_ucap_event().

◆ _mbg_swab_pcps_irig_time

#define _mbg_swab_pcps_irig_time ( _p )

Value:

do                                                \
{                                                 \
  _mbg_swab_pcps_time_status_x( &(_p)->status );  \
  _mbg_swab16( &(_p)->offs_utc );                 \
  _mbg_swab16( &(_p)->yday );                     \
  _mbg_swab16( &(_p)->frac );                     \
} while ( 0 )

Definition at line 1223 of file pcpsdefs.h.

Referenced by mbg_get_irig_time().

◆ _mbg_swab_pcps_seconds

#define _mbg_swab_pcps_seconds ( _p )

Value:

do                                    \
{                                     \
  _mbg_swab32( _p );                  \
} while ( 0 )

Definition at line 938 of file pcpsdefs.h.

◆ _mbg_swab_pcps_time_stamp

#define _mbg_swab_pcps_time_stamp ( _p )

Value:

do                                        \
{                                         \
  _mbg_swab_pcps_seconds( &(_p)->sec );   \
  _mbg_swab_pcps_frac_32( &(_p)->frac );  \
} while ( 0 )

Definition at line 979 of file pcpsdefs.h.

Referenced by mbg_set_event_time(), and mbgclock_default_get_fast_hr_timestamp().

◆ _mbg_swab_pcps_time_status_x

#define _mbg_swab_pcps_time_status_x ( _p ) _mbg_swab16( _p )

Definition at line 1024 of file pcpsdefs.h.

◆ _mbg_swab_pcps_time_status_x_masks

#define _mbg_swab_pcps_time_status_x_masks ( _p )

Value:

do                                                 \
{                                                  \
  _mbg_swab_pcps_time_status_x( &(_p)->set_mask ); \
  _mbg_swab_pcps_time_status_x( &(_p)->clr_mask ); \
} while ( 0 )

Definition at line 1034 of file pcpsdefs.h.

◆ _mbg_swab_pcps_tzdl

#define _mbg_swab_pcps_tzdl ( _p )

Value:

do                                           \
{                                            \
  _mbg_swab16( &(_p)->offs );                \
  _mbg_swab16( &(_p)->offs_dl );             \
  _mbg_swab_pcps_dl_onoff( &(_p)->tm_on );   \
  _mbg_swab_pcps_dl_onoff( &(_p)->tm_off );  \
} while ( 0 )

Definition at line 1513 of file pcpsdefs.h.

Referenced by mbg_get_pcps_tzdl(), and mbg_set_pcps_tzdl().

◆ _mbg_swab_pcps_ucap_entries

#define _mbg_swab_pcps_ucap_entries ( _p )

Value:

do                                         \
{                                          \
  _mbg_swab32( &(_p)->used );              \
  _mbg_swab32( &(_p)->max );               \
} while ( 0 )

Definition at line 1536 of file pcpsdefs.h.

Referenced by mbg_get_ucap_entries(), and mbgclock_default_get_ucap_entries().

◆ _USE_PCPSPRIV

#define _USE_PCPSPRIV _IS_MBG_FIRMWARE

Definition at line 273 of file pcpsdefs.h.

◆ BITMASK

#define BITMASK ( b ) ( ( 1 << b ) - 1 )

Definition at line 903 of file pcpsdefs.h.

Referenced by pcps_pack_serial(), and pcps_unpack_serial().

◆ DL_AUTO_FLAG

#define DL_AUTO_FLAG 0x8000

A flag indicating if DST changeovers are to be computed automatically.

If PCPS_DL_ONOFF::year_or_wday is or'ed with the constant DL_AUTO_FLAG then start and end of daylight saving time shall be computed automatically for each year. In this case the remaining bits represent the day-of-week after the specified mday/month at which the change shall occur. If that flag is not set then the field contains the full four-digit year number and the PCPS_DL_ONOFF::mday and PCPS_DL_ONOFF::month values specify the exact date of that year. Most devices supporting conversion to local time support the TZDL structure instead.

See also: TZDL; PCPS_TZDL

Definition at line 1492 of file pcpsdefs.h.

◆ IRIG_TIME_UNKNOWN_YEAR

#define IRIG_TIME_UNKNOWN_YEAR 0xFF

A constant representing a 2 digit unknown IRIG year number.

Used with PCPS_IRIG_TIME::year

Definition at line 1238 of file pcpsdefs.h.

◆ MBG_CMD_TABLE_EXT

#define MBG_CMD_TABLE_EXT _mbg_cn_table_end()

Note: Command codes 0xF0 through 0xFF are reserved.

Definition at line 817 of file pcpsdefs.h.

◆ MBG_PCPS_FMT_STATUS

#define MBG_PCPS_FMT_STATUS

Value:

"\177\20b\0FREER\0b\1DL_ENB\0b\2SYNCD\0b\3DL_ANN\0b\4UTC\0b\5LS_ANN\0b\6IFTM\0b\7INVT" \

"\0b\x08LS_ENB\0b\11ANT_FAIL\0b\x0aLS_ANN_NEG\0b\x0bSCALE_GPS\0b\x0cSCALE_TAI\0\0"

A format string to be used with snprintb() which is available on some Unix systems to print information held in a bit coded variable.

Definition at line 467 of file pcpsdefs.h.

◆ PC_GPS_CMD_CODES_TABLE

#define PC_GPS_CMD_CODES_TABLE

An initializer for a table of code/name entries of GPS commands.

This can e.g. be assigned to an array of MBG_CODE_NAME_TABLE_ENTRY elements and may be helpful when debugging.

See also: PC_GPS_CMD_CODES

Definition at line 1703 of file pcpsdefs.h.

◆ PCI_DEV_FRC511PEX

#define PCI_DEV_FRC511PEX ( ( PCPS_REF_FRC << 8 ) | 0x01 )

Definition at line 410 of file pcpsdefs.h.

◆ PCI_DEV_GLN180PEX

#define PCI_DEV_GLN180PEX ( ( PCPS_REF_GPS << 8 ) | 0x07 )

Definition at line 397 of file pcpsdefs.h.

◆ PCI_DEV_GNS181PEX

#define PCI_DEV_GNS181PEX ( ( PCPS_REF_GPS << 8 ) | 0x09 )

Definition at line 399 of file pcpsdefs.h.

◆ PCI_DEV_GPS167PCI

#define PCI_DEV_GPS167PCI ( ( PCPS_REF_GPS << 8 ) | 0x01 )

Definition at line 391 of file pcpsdefs.h.

◆ PCI_DEV_GPS168PCI

#define PCI_DEV_GPS168PCI ( ( PCPS_REF_GPS << 8 ) | 0x02 )

Definition at line 392 of file pcpsdefs.h.

◆ PCI_DEV_GPS169PCI

#define PCI_DEV_GPS169PCI ( ( PCPS_REF_GPS << 8 ) | 0x03 )

Definition at line 393 of file pcpsdefs.h.

◆ PCI_DEV_GPS170PCI

#define PCI_DEV_GPS170PCI ( ( PCPS_REF_GPS << 8 ) | 0x04 )

Definition at line 394 of file pcpsdefs.h.

◆ PCI_DEV_GPS170PEX

#define PCI_DEV_GPS170PEX ( ( PCPS_REF_GPS << 8 ) | 0x05 )

Definition at line 395 of file pcpsdefs.h.

◆ PCI_DEV_GPS180AMC

#define PCI_DEV_GPS180AMC ( ( PCPS_REF_GPS << 8 ) | 0x08 )

Definition at line 398 of file pcpsdefs.h.

◆ PCI_DEV_GPS180PEX

#define PCI_DEV_GPS180PEX ( ( PCPS_REF_GPS << 8 ) | 0x06 )

Definition at line 396 of file pcpsdefs.h.

◆ PCI_DEV_PCI32

#define PCI_DEV_PCI32 ( ( PCPS_REF_DCF << 8 ) | 0x01 )

PCI device IDs assigned by Meinberg.

High byte: type of ref time source, see PCPS_REF_TYPES Low Byte: enumeration of device types

See also: PCI_VENDOR_MEINBERG

Definition at line 384 of file pcpsdefs.h.

◆ PCI_DEV_PCI509

#define PCI_DEV_PCI509 ( ( PCPS_REF_DCF << 8 ) | 0x02 )

Definition at line 385 of file pcpsdefs.h.

◆ PCI_DEV_PCI510

#define PCI_DEV_PCI510 ( ( PCPS_REF_DCF << 8 ) | 0x03 )

Definition at line 386 of file pcpsdefs.h.

◆ PCI_DEV_PCI511

#define PCI_DEV_PCI511 ( ( PCPS_REF_DCF << 8 ) | 0x04 )

Definition at line 387 of file pcpsdefs.h.

◆ PCI_DEV_PEX511

#define PCI_DEV_PEX511 ( ( PCPS_REF_DCF << 8 ) | 0x05 )

Definition at line 388 of file pcpsdefs.h.

◆ PCI_DEV_PTP270PEX

#define PCI_DEV_PTP270PEX ( ( PCPS_REF_PTP << 8 ) | 0x01 )

Definition at line 408 of file pcpsdefs.h.

Referenced by pcps_ddev_is_ptp270pex().

◆ PCI_DEV_PZF180PEX

#define PCI_DEV_PZF180PEX ( ( PCPS_REF_DCF << 8 ) | 0x06 )

Definition at line 389 of file pcpsdefs.h.

◆ PCI_DEV_TCR167PCI

#define PCI_DEV_TCR167PCI ( ( PCPS_REF_IRIG << 8 ) | 0x02 )

Definition at line 402 of file pcpsdefs.h.

◆ PCI_DEV_TCR170PEX

#define PCI_DEV_TCR170PEX ( ( PCPS_REF_IRIG << 8 ) | 0x05 )

Definition at line 405 of file pcpsdefs.h.

◆ PCI_DEV_TCR180PEX

#define PCI_DEV_TCR180PEX ( ( PCPS_REF_IRIG << 8 ) | 0x06 )

Definition at line 406 of file pcpsdefs.h.

◆ PCI_DEV_TCR510PCI

#define PCI_DEV_TCR510PCI ( ( PCPS_REF_IRIG << 8 ) | 0x01 )

Definition at line 401 of file pcpsdefs.h.

◆ PCI_DEV_TCR511PCI

#define PCI_DEV_TCR511PCI ( ( PCPS_REF_IRIG << 8 ) | 0x03 )

Definition at line 403 of file pcpsdefs.h.

◆ PCI_DEV_TCR511PEX

#define PCI_DEV_TCR511PEX ( ( PCPS_REF_IRIG << 8 ) | 0x04 )

Definition at line 404 of file pcpsdefs.h.

◆ PCI_VENDOR_MEINBERG

#define PCI_VENDOR_MEINBERG 0x1360

Meinberg PCI vendor ID (assigned by the PCI SIG)

See also: MEINBERG_PCI_DEVICE_IDS

Definition at line 371 of file pcpsdefs.h.

◆ PCPS_BD_BITS

#define PCPS_BD_BITS 4

field with in the cfg byte

Definition at line 1367 of file pcpsdefs.h.

Referenced by pcps_pack_serial(), and pcps_unpack_serial().

◆ PCPS_BD_SHIFT

#define PCPS_BD_SHIFT 0

num of bits to shift left

Definition at line 1368 of file pcpsdefs.h.

◆ PCPS_CLR_EVT_LOG

#define PCPS_CLR_EVT_LOG 0x66

(-w) Write clear on-board event log, only if _pcps_has_evt_log

Definition at line 776 of file pcpsdefs.h.

Referenced by ioctl_switch(), and mbg_clr_evt_log().

◆ PCPS_CLR_UCAP_BUFF

#define PCPS_CLR_UCAP_BUFF 0x60

(-w) No param., clear on-board capture FIFO, only if _pcps_has_ucap

Definition at line 768 of file pcpsdefs.h.

Referenced by ioctl_switch(), mbg_clr_ucap_buff(), and mbgclock_default_clr_ucap_buff().

◆ PCPS_CMD_CODES_TABLE

#define PCPS_CMD_CODES_TABLE

An initializer for a table of code/name entries of non-GPS commands.

This can e.g. initialize an array of MBG_CODE_NAME_TABLE_ENTRY elements and may be helpful when debugging.

See also: PCPS_CMD_CODES

Definition at line 828 of file pcpsdefs.h.

◆ PCPS_ERR_CFG

#define PCPS_ERR_CFG -2

invalid parms for a cmd writing config parameters (see MBG_ERR_CFG)

Definition at line 896 of file pcpsdefs.h.

◆ PCPS_ERR_STIME

#define PCPS_ERR_STIME -1

invalid date/time/status passed (see MBG_ERR_STIME)

Definition at line 895 of file pcpsdefs.h.

◆ PCPS_FIFO_SIZE

#define PCPS_FIFO_SIZE 16

The size of a bus level device's command/data FIFO.

Definition at line 908 of file pcpsdefs.h.

Referenced by pcps_generic_io(), pcps_get_fw_id(), pcps_read_gps(), and pcps_read_gps_block().

◆ PCPS_FIRST_EVT_LOG_ENTRY

#define PCPS_FIRST_EVT_LOG_ENTRY 0x68

(r-) Read first (oldest) MBG_EVT_LOG_ENTRY, only if _pcps_has_evt_log

Definition at line 778 of file pcpsdefs.h.

Referenced by ioctl_switch(), and mbg_get_first_evt_log_entry().

◆ PCPS_FORCE_RESET

#define PCPS_FORCE_RESET 0x80

(-w) No param., reset the device (deprecated, this can lock up the computer!!)

Definition at line 781 of file pcpsdefs.h.

◆ PCPS_FR_BITS

#define PCPS_FR_BITS 2

field with in the cfg byte

Definition at line 1392 of file pcpsdefs.h.

Referenced by pcps_pack_serial(), and pcps_unpack_serial().

◆ PCPS_FR_SHIFT

#define PCPS_FR_SHIFT PCPS_BD_BITS

num of bits to shift left

Definition at line 1393 of file pcpsdefs.h.

Referenced by pcps_pack_serial(), and pcps_unpack_serial().

◆ PCPS_GENERIC_IO

#define PCPS_GENERIC_IO 0x43

(rw) See pcps_generic_io or _mbgdevio_gen_io

Definition at line 755 of file pcpsdefs.h.

Referenced by pcps_generic_io().

◆ PCPS_GET_CORR_INFO

#define PCPS_GET_CORR_INFO 0x63

(r-) Read CORR_INFO structure, only if _pcps_has_pzf

Definition at line 772 of file pcpsdefs.h.

Referenced by ioctl_switch(), and mbg_get_corr_info().

◆ PCPS_GET_DEBUG_STATUS

#define PCPS_GET_DEBUG_STATUS 0x4C

(r-) Read MBG_DEBUG_STATUS, only if _pcps_has_debug_status

Definition at line 761 of file pcpsdefs.h.

Referenced by ioctl_switch(), and mbg_get_debug_status().

◆ PCPS_GET_IRIG_CTRL_BITS

#define PCPS_GET_IRIG_CTRL_BITS 0x45

(r-) Read MBG_IRIG_CTRL_BITS, only if _pcps_has_irig_ctrl_bits

Definition at line 757 of file pcpsdefs.h.

Referenced by ioctl_switch(), and mbg_get_irig_ctrl_bits().

◆ PCPS_GET_IRIG_RX_INFO

#define PCPS_GET_IRIG_RX_INFO 0x3A

(r-) Read IRIG_INFO, only if _pcps_is_irig_rx

Definition at line 743 of file pcpsdefs.h.

Referenced by ioctl_switch(), mbg_get_irig_rx_info(), and mbg_get_irig_tx_info().

◆ PCPS_GET_IRIG_TX_INFO

#define PCPS_GET_IRIG_TX_INFO 0x3C

(r-) Read IRIG_INFO, only if _pcps_has_irig_tx

Definition at line 746 of file pcpsdefs.h.

Referenced by ioctl_switch(), and mbg_get_irig_tx_info().

◆ PCPS_GET_OPT_INFO

#define PCPS_GET_OPT_INFO 0x38

(r-) Read MBG_OPT_INFO, only if _pcps_has_opt_flags

Definition at line 740 of file pcpsdefs.h.

Referenced by ioctl_switch(), and mbg_get_opt_info().

◆ PCPS_GET_PCPS_TZDL

#define PCPS_GET_PCPS_TZDL 0x34

(r-) Read PCPS_TZDL, only if _pcps_has_pcps_tzdl

Definition at line 734 of file pcpsdefs.h.

Referenced by ioctl_switch(), and mbg_get_pcps_tzdl().

◆ PCPS_GET_RAW_IRIG_DATA

#define PCPS_GET_RAW_IRIG_DATA 0x46

(r-) Read MBG_RAW_IRIG_DATA, only if _pcps_has_raw_irig_data

Definition at line 758 of file pcpsdefs.h.

Referenced by ioctl_switch(), and mbg_get_raw_irig_data().

◆ PCPS_GET_REF_OFFS

#define PCPS_GET_REF_OFFS 0x36

(r-) Read MBG_REF_OFFS, only if _pcps_has_ref_offs

Definition at line 737 of file pcpsdefs.h.

Referenced by ioctl_switch(), and mbg_get_ref_offs().

◆ PCPS_GET_SERIAL

#define PCPS_GET_SERIAL 0x30

(r-) Read serial settings as PCPS_SERIAL, deprecated by PC_GPS_ALL_PORT_INFO

Definition at line 728 of file pcpsdefs.h.

Referenced by ioctl_switch(), and mbg_get_serial().

◆ PCPS_GET_STATUS_PORT

#define PCPS_GET_STATUS_PORT 0x4B

(r-) Read PCPS_STATUS_PORT

Definition at line 760 of file pcpsdefs.h.

Referenced by ioctl_switch().

◆ PCPS_GET_SYNTH

#define PCPS_GET_SYNTH 0x3E

(r-) Read SYNTH, only if _pcps_has_synth

Definition at line 749 of file pcpsdefs.h.

Referenced by ioctl_switch(), and mbg_get_synth().

◆ PCPS_GET_SYNTH_STATE

#define PCPS_GET_SYNTH_STATE 0x44

(r-) Read SYNTH_STATE, only if _pcps_has_synth

Definition at line 756 of file pcpsdefs.h.

Referenced by ioctl_switch(), and mbg_get_synth_state().

◆ PCPS_GET_TR_DISTANCE

#define PCPS_GET_TR_DISTANCE 0x64

(r-) Read TR_DISTANCE, only if _pcps_has_tr_distance

Definition at line 773 of file pcpsdefs.h.

Referenced by ioctl_switch(), and mbg_get_tr_distance().

◆ PCPS_GET_TZCODE

#define PCPS_GET_TZCODE 0x32

(r-) Read PCPS_TZCODE, only if _pcps_has_tzcode

Definition at line 731 of file pcpsdefs.h.

Referenced by ioctl_switch(), and mbg_get_tzcode().

◆ PCPS_GIVE_FW_ID_1

#define PCPS_GIVE_FW_ID_1 0x40

(r-) Read first PCPS_FIFO_SIZE chars of firmware ID

Definition at line 752 of file pcpsdefs.h.

Referenced by pcps_get_fw_id().

◆ PCPS_GIVE_FW_ID_2

#define PCPS_GIVE_FW_ID_2 0x41

(r-) Read last PCPS_FIFO_SIZE chars of firmware ID

Definition at line 753 of file pcpsdefs.h.

Referenced by pcps_get_fw_id().

◆ PCPS_GIVE_HR_TIME

#define PCPS_GIVE_HR_TIME 0x03

(r-) Read high res. time as PCPS_HR_TIME, only if _pcps_has_hr_time

Definition at line 715 of file pcpsdefs.h.

Referenced by ioctl_switch(), mbg_get_hr_time(), mbg_get_hr_time_cycles(), and report_ret_val().

◆ PCPS_GIVE_IRIG_TIME

#define PCPS_GIVE_IRIG_TIME 0x04

(r-) Read raw IRIG time as PCPS_IRIG_TIME, only if _pcps_has_irig_time

Definition at line 716 of file pcpsdefs.h.

Referenced by ioctl_switch(), and mbg_get_irig_time().

◆ PCPS_GIVE_SERNUM

#define PCPS_GIVE_SERNUM 0x42

(r-) Read serial number as PCPS_SN_STR, only if _pcps_has_sernum

Definition at line 754 of file pcpsdefs.h.

Referenced by setup_sernum_and_receiver_info().

◆ PCPS_GIVE_SYNC_TIME

#define PCPS_GIVE_SYNC_TIME 0x02

(r-) Read last sync time as PCPS_TIME, only if _pcps_has_sync_time

Definition at line 714 of file pcpsdefs.h.

Referenced by ioctl_switch(), and mbg_get_sync_time().

◆ PCPS_GIVE_TIME

#define PCPS_GIVE_TIME 0x00

Command codes used to communicate with bus level devices.

These commands are used for low level access to bus-level devices manufactured by Meinberg.

Applications should instead use the API functions declared in mbgdevio.h.

The header files pcpsdev.h and pcpsdrvr.h contain macros which can be used to check if a detected device supports a certain feature or command. If checking is required then the name of the macro is given in the comments associated with the command codes.

Some commands expect parameters to be passed to the board. In that case, the board returns the number of parameter bytes expected when the command code is passed. Every parameter byte has to be supplied to the board exactly like a command byte.

Refer to function pcps_write and the macro _pcps_write_var for details.

PCPS_GIVE_TIME
Return a PCPS_TIME structure with current date, time and status. Supported by all clocks.
PCPS_GIVE_TIME_NOCLEAR
Same as PCPS_GIVE_TIME but the bits PCPS_ST_SEC and PCPS_ST_MIN of the status port are not cleared. Supported by all clocks except PC31/PS31 with firmware version older than v3.0. This is mainly used by the DOS TSR and should not be used in other environments.
PCPS_GIVE_SYNC_TIME
Return a PCPS_TIME structure with date and time of last synchronization of the clock or the last time set via the interface. _pcps_has_sync_time checks whether supported.
PCPS_GIVE_HR_TIME
Return a PCPS_HR_TIME structure with current date, time and status. This command should be used to read the clock with higher resolution. _pcps_has_hr_time checks whether supported.
PCPS_GIVE_IRIG_TIME
Return a PCPS_IRIG_TIME structure with day-of-year, time and status as decoded from the IRIG signal. _pcps_has_irig_time checks whether supported.
PCPS_SET_TIME
Set the board date, time and status. This command expects sizeof( ::PCPS_STIME ) parameter bytes. _pcps_can_set_time checks whether supported.
PCPS_SET_EVENT_TIME
Send a high resolution time stamp to the clock to configure a UTC time when the clock shall generate some event. This command expects a PCPS_TIME_STAMP parameter. _pcps_has_event_time checks whether supported. (requires custom GPS CERN firmware)
PCPS_IRQ_NONE
Disable the card's hardware IRQ
PCPS_IRQ_1_SEC
Enable hardware IRQs once per second
PCPS_IRQ_1_MIN
Enable hardware IRQs once per minute (deprecated)
PCPS_IRQ_10_MIN
Enable hardware IRQs once per 10 minutes (deprecated)
PCPS_IRQ_30_MIN
Enable hardware IRQs once per 30 minutes (deprecated)
PCPS_GET_SERIAL
PCPS_SET_SERIAL
Deprecated. Read or write the configuration of a card's serial port COM0 in PCPS_SERIAL format. _pcps_has_serial checks whether supported. Newer cards should be configured using the structures RECEIVER_INFO, PORT_INFO, and STR_TYPE_INFO. _pcps_has_receiver_info checks whether these are supported.
PCPS_GET_TZCODE
PCPS_SET_TZCODE
These commands read or set a DCF77 clock's time zone code and should be used preferably with older DCF77 receivers which have limited support of different time zones. _pcps_has_tzcode checks whether supported. Most newer devices support the TZDL structure which can be read or written using PC_GPS_TZDL.
PCPS_GET_PCPS_TZDL
PCPS_SET_PCPS_TZDL
Read or write time zone / daylight saving information in PCPS_TZDL format. _pcps_has_pcps_tzdl checks whether supported.
PCPS_GET_REF_OFFS
PCPS_SET_REF_OFFS
These commands can be used to configure the reference time offset from UTC for clocks which can't determine the offset automatically, e.g. from an IRIG input signal. _pcps_has_ref_offs checks whether supported.
PCPS_GET_OPT_INFO
PCPS_SET_OPT_SETTINGS
These commands can be used to configure some optional settings, controlled by flags. When reading, the clock returns a MBG_OPT_INFO structure which contains the supported values, plus the current settings. When writing, clocks accepts a MBG_OPT_SETTINGS structure only which contain the desired settings of the supported flags only. _pcps_has_opt_flags checks whether supported.
PCPS_GET_IRIG_RX_INFO
PCPS_SET_IRIG_RX_SETTINGS
PCPS_GET_IRIG_TX_INFO
PCPS_SET_IRIG_TX_SETTINGS
These commands can be used to configure IRIG inputs and outputs.
When reading, the clock returns an IRIG_INFO structure which contains the supported values, plus the current settings.
When writing, clocks accepts an IRIG_SETTINGS structure only which contain the desired settings only. _pcps_is_irig_rx and _pcps_has_irig_tx check whether supported.
PCPS_GET_IRIG_CTRL_BITS
This command can be used to retrieve the control function bits of the latest IRIG input frame. Those bits may carry some well-known information as in the IEEE 1344 code, but may also contain some customized information, depending on the IRIG frame type and the configuration of the IRIG generator. So these bits are returned as-is and must be interpreted by the application. _pcps_has_irig_ctrl_bits checks whether supported.
PCPS_GET_SYNTH
PCPS_SET_SYNTH
PCPS_GET_SYNTH_STATE
These commands can be used to configure an on-board frequency synthesizer and query the synthesizer status. The commands are only supported if the board supports the RECEIVER_INFO structure and the flag GPS_HAS_SYNTH is set in the RECEIVER_INFO::features. _pcps_has_synth checks whether supported. The structures SYNTH and SYNTH_STATE used with these commands are defined in gpsdefs.h.
PCPS_GIVE_FW_ID_1
PCPS_GIVE_FW_ID_2
Returns the first/second block of PCPS_FIFO_SIZE characters of the firmware ID string. These commands can be used to check if the board responds properly. This is done by the clock detection functions.
PCPS_GIVE_SERNUM
Returns PCPS_FIFO_SIZE characters of the clock's serial number. _pcps_has_sernum checks whether supported.
PCPS_GENERIC_IO
Generic I/O read and write. Can be used to query specific data, e.g. a selected element of an array. _pcps_has_generic_io checks whether supported.
PCPS_GET_DEBUG_STATUS
This command reads an MBG_DEBUG_STATUS structure which represents the internal status of the IRIG decoder and some additional debug info. _pcps_has_debug_status checks whether supported.
PCPS_READ_GPS_DATA
PCPS_WRITE_GPS_DATA
These commands are used by the functions pcps_read_gps and pcps_write_gps to read or write large data structures to Meinberg GPS plug-in clocks. _pcps_is_gps checks whether supported.
PCPS_CLR_UCAP_BUFF
Clear a clock's time capture buffer. _pcps_can_clr_ucap_buff checks whether supported.
PCPS_GIVE_UCAP_ENTRIES
Read a PCPS_UCAP_ENTRIES structure which reports the max number of entries and the currently used number of entries in the user capture buffer. _pcps_has_ucap checks whether supported.
PCPS_GIVE_UCAP_EVENT
Read capture events using a PCPS_HR_TIME structure. This is faster than reading using the GPS command PC_GPS_UCAP. If no capture event is available then the returned structure is all 0. _pcps_has_ucap checks whether supported.
PCPS_GET_CORR_INFO
Read PZF correlation info using a CORR_INFO structure. _pcps_has_pzf checks whether supported.
PCPS_GET_TR_DISTANCE
PCPS_SET_TR_DISTANCE
Read or write distance from the RF transmitter. This is used to compensate the RF propagation delay for PZF receivers. _pcps_has_tr_distance checks whether supported.
PCPS_CLR_EVT_LOG
Clear on-board event log. _pcps_has_evt_log checks whether supported.
PCPS_NUM_EVT_LOG_ENTRIES
Read max. number of num event log entries which can be saved on the board, and how many entries have currently been saved. _pcps_has_evt_log checks whether supported.
PCPS_FIRST_EVT_LOG_ENTRY
PCPS_NEXT_EVT_LOG_ENTRY
Read first (oldest) or next event log entry. _pcps_has_evt_log checks whether supported.
PCPS_FORCE_RESET
Resets the card's hardware. This may lock up the computer and thus should only be used by very specific applications.

(r-) Read current time in PCPS_TIME format

Definition at line 712 of file pcpsdefs.h.

Referenced by ioctl_switch(), mbg_get_time(), mbg_get_time_cycles(), mbgclock_irq_handler(), and pcps_probe_device().

◆ PCPS_GIVE_TIME_NOCLEAR

#define PCPS_GIVE_TIME_NOCLEAR 0x01

(r-) Read current time in PCPS_TIME format, don't clear sec and min flags (deprecated)

Definition at line 713 of file pcpsdefs.h.

Referenced by ioctl_switch().

◆ PCPS_GIVE_UCAP_ENTRIES

#define PCPS_GIVE_UCAP_ENTRIES 0x61

(r-) Read PCPS_UCAP_ENTRIES, only if _pcps_has_ucap

Definition at line 769 of file pcpsdefs.h.

Referenced by ioctl_switch(), mbg_get_ucap_entries(), and mbgclock_default_get_ucap_entries().

◆ PCPS_GIVE_UCAP_EVENT

#define PCPS_GIVE_UCAP_EVENT 0x62

(r-) Return oldest event as PCPS_HR_TIME, only if _pcps_has_ucap

Definition at line 770 of file pcpsdefs.h.

Referenced by ioctl_switch(), mbg_get_ucap_event(), and mbgclock_default_get_ucap_event().

◆ PCPS_HRT_FRAC_SCALE

#define PCPS_HRT_FRAC_SCALE 10000000UL

Scale to be used to print PCPS_TIME_STAMP::frac values.

The function bin_frac_32_to_dec_frac can be used for the conversion.

See also: PCPS_HRT_FRAC_SCALE_FMT

Definition at line 996 of file pcpsdefs.h.

Referenced by mbg_snprint_hr_tstamp(), and mbg_str_pcps_hr_time_frac().

◆ PCPS_HRT_FRAC_SCALE_FMT

#define PCPS_HRT_FRAC_SCALE_FMT "%07lu"

Format specifier used to print PCPS_TIME_STAMP::frac values.

Used to print values scaled with bin_frac_32_to_dec_frac called with PCPS_HRT_FRAC_SCALE.

See also: PCPS_HRT_FRAC_SCALE

Definition at line 1008 of file pcpsdefs.h.

Referenced by mbg_snprint_hr_tstamp(), and mbg_str_pcps_hr_time_frac().

◆ PCPS_ID_SIZE

#define PCPS_ID_SIZE ( 2 * PCPS_FIFO_SIZE + 1 )

The maximum length of an ID string, including terminating 0.

ASCIIZ string

Definition at line 915 of file pcpsdefs.h.

Referenced by pcps_get_fw_id().

◆ PCPS_IRQ_10_MIN

#define PCPS_IRQ_10_MIN 0x24

(-w) Enable IRQ per 10 minutes (deprecated)

Definition at line 725 of file pcpsdefs.h.

◆ PCPS_IRQ_1_MIN

#define PCPS_IRQ_1_MIN 0x22

(-w) Enable IRQ per 1 minute (deprecated)

Definition at line 724 of file pcpsdefs.h.

◆ PCPS_IRQ_1_SEC

#define PCPS_IRQ_1_SEC 0x21

(-w) Enable IRQ per 1 second

Definition at line 723 of file pcpsdefs.h.

Referenced by mbgdrvr_enable_cyclic().

◆ PCPS_IRQ_30_MIN

#define PCPS_IRQ_30_MIN 0x28

(-w) Enable IRQ per 10 minutes (deprecated)

Definition at line 726 of file pcpsdefs.h.

◆ PCPS_IRQ_NONE

#define PCPS_IRQ_NONE 0x20

(-w) Disable IRQs

Definition at line 722 of file pcpsdefs.h.

Referenced by mbgdrvr_disable_cyclic().

◆ PCPS_MOD_BITS

#define PCPS_MOD_BITS 2

field with in the cfg byte

Definition at line 1416 of file pcpsdefs.h.

Referenced by pcps_pack_serial(), and pcps_unpack_serial().

◆ PCPS_MOD_SHIFT

#define PCPS_MOD_SHIFT ( PCPS_BD_BITS + PCPS_FR_BITS )

num of bits to shift left

Definition at line 1417 of file pcpsdefs.h.

Referenced by pcps_pack_serial(), and pcps_unpack_serial().

◆ PCPS_NEXT_EVT_LOG_ENTRY

#define PCPS_NEXT_EVT_LOG_ENTRY 0x69

(r-) Read next MBG_EVT_LOG_ENTRY, only if _pcps_has_evt_log

Definition at line 779 of file pcpsdefs.h.

Referenced by ioctl_switch(), and mbg_get_next_evt_log_entry().

◆ PCPS_NUM_EVT_LOG_ENTRIES

#define PCPS_NUM_EVT_LOG_ENTRIES 0x67

(r-) Read MBG_NUM_EVT_LOG_ENTRIES, only if _pcps_has_evt_log

Definition at line 777 of file pcpsdefs.h.

Referenced by ioctl_switch(), and mbg_get_num_evt_log_entries().

◆ PCPS_READ_GPS_DATA

#define PCPS_READ_GPS_DATA 0x50

(r-) Read large data structure, see PC_GPS_CMD_CODES

Note: Command codes 0x4D, 0x4E, and 0x4F are reserved.

Definition at line 765 of file pcpsdefs.h.

Referenced by pcps_read_gps_block(), and report_ret_val().

◆ PCPS_REF_NAMES_ENG

#define PCPS_REF_NAMES_ENG

Value:

{                          \
  PCPS_REF_NAME_NONE_ENG,  \
  PCPS_REF_NAME_DCF,       \
  PCPS_REF_NAME_GPS,       \
  PCPS_REF_NAME_IRIG,      \
  PCPS_REF_NAME_MSF,       \
  PCPS_REF_NAME_PTP,       \
  PCPS_REF_NAME_FRC,       \
  PCPS_REF_NAME_WWVB,      \
  PCPS_REF_NAME_JJY        \
}

Initializer for an array of English reference type names.

See also: PCPS_REF_TYPES

Definition at line 332 of file pcpsdefs.h.

◆ PCPS_REF_NAMES_LSTR

#define PCPS_REF_NAMES_LSTR

Value:

{                                                      \
  { PCPS_REF_NAME_NONE_ENG, PCPS_REF_NAME_NONE_GER },  \
  { PCPS_REF_NAME_DCF, NULL },                         \
  { PCPS_REF_NAME_GPS, NULL },                         \
  { PCPS_REF_NAME_IRIG, NULL },                        \
  { PCPS_REF_NAME_MSF, NULL },                         \
  { PCPS_REF_NAME_PTP, NULL },                         \
  { PCPS_REF_NAME_FRC, NULL },                         \
  { PCPS_REF_NAME_WWVB, NULL },                        \
  { PCPS_REF_NAME_JJY, NULL }                          \
}

Initializer for a multi-language array of reference type names.

See also: PCPS_REF_TYPES

Definition at line 351 of file pcpsdefs.h.

◆ PCPS_SCALE_MASK

#define PCPS_SCALE_MASK ( PCPS_SCALE_TAI | PCPS_SCALE_GPS )

This bit mask can be used to extract the time scale information out of a PCPS_TIME_STATUS_X value.

Definition at line 1308 of file pcpsdefs.h.

◆ PCPS_SET_EVENT_TIME

#define PCPS_SET_EVENT_TIME 0x14

(-w) Write event time as PCPS_TIME_STAMP, only if _pcps_has_event_time

Definition at line 720 of file pcpsdefs.h.

Referenced by ioctl_switch(), and mbg_set_event_time().

◆ PCPS_SET_IRIG_RX_SETTINGS

#define PCPS_SET_IRIG_RX_SETTINGS 0x3B

(-w) Write IRIG_SETTINGS, only if _pcps_is_irig_rx, returns MBG_ERR_CFG on error

Definition at line 744 of file pcpsdefs.h.

Referenced by ioctl_switch(), mbg_set_irig_rx_settings(), and mbg_set_irig_tx_settings().

◆ PCPS_SET_IRIG_TX_SETTINGS

#define PCPS_SET_IRIG_TX_SETTINGS 0x3D

(-w) Write IRIG_SETTINGS, only if _pcps_has_irig_tx, returns MBG_ERR_CFG on error

Definition at line 747 of file pcpsdefs.h.

Referenced by ioctl_switch(), and mbg_set_irig_tx_settings().

◆ PCPS_SET_OPT_SETTINGS

#define PCPS_SET_OPT_SETTINGS 0x39

(-w) Write MBG_OPT_SETTINGS, only if _pcps_has_opt_flags, returns MBG_ERR_CFG on error

Definition at line 741 of file pcpsdefs.h.

Referenced by ioctl_switch(), and mbg_set_opt_settings().

◆ PCPS_SET_PCPS_TZDL

#define PCPS_SET_PCPS_TZDL 0x35

(-w) Write PCPS_TZDL, only if _pcps_has_pcps_tzdl, returns MBG_ERR_CFG on error

Definition at line 735 of file pcpsdefs.h.

Referenced by ioctl_switch(), and mbg_set_pcps_tzdl().

◆ PCPS_SET_REF_OFFS

#define PCPS_SET_REF_OFFS 0x37

(-w) Write MBG_REF_OFFS, only if _pcps_has_ref_offs, returns MBG_ERR_CFG on error

Definition at line 738 of file pcpsdefs.h.

Referenced by ioctl_switch(), and mbg_set_ref_offs().

◆ PCPS_SET_SERIAL

#define PCPS_SET_SERIAL 0x31

(-w) Write serial settings as PCPS_SERIAL, deprecated by PC_GPS_PORT_SETTINGS_IDX, returns MBG_ERR_CFG on error

Definition at line 729 of file pcpsdefs.h.

Referenced by ioctl_switch(), and mbg_set_serial().

◆ PCPS_SET_SYNTH

#define PCPS_SET_SYNTH 0x3F

(-w) Write SYNTH, only if _pcps_has_synth, returns MBG_ERR_CFG on error

Definition at line 750 of file pcpsdefs.h.

Referenced by ioctl_switch(), and mbg_set_synth().

◆ PCPS_SET_TIME

#define PCPS_SET_TIME 0x10

(-w) Set on-board time, see PCPS_STIME. Returns MBG_ERR_STIME on error.

Definition at line 718 of file pcpsdefs.h.

Referenced by ioctl_switch(), and mbg_set_time().

◆ PCPS_SET_TR_DISTANCE

#define PCPS_SET_TR_DISTANCE 0x65

(-w) Write TR_DISTANCE, only if _pcps_has_tr_distance

Definition at line 774 of file pcpsdefs.h.

Referenced by ioctl_switch(), and mbg_set_tr_distance().

◆ PCPS_SET_TZCODE

#define PCPS_SET_TZCODE 0x33

(-w) Write PCPS_TZCODE, only if _pcps_has_tzcode, returns MBG_ERR_CFG on error

Definition at line 732 of file pcpsdefs.h.

Referenced by ioctl_switch(), and mbg_set_tzcode().

◆ PCPS_SIG_BIAS

#define PCPS_SIG_BIAS 55

Definition at line 1055 of file pcpsdefs.h.

Referenced by show_modulation(), and show_time_and_status().

◆ PCPS_SIG_ERR

#define PCPS_SIG_ERR 1

Definition at line 1056 of file pcpsdefs.h.

Referenced by show_time_and_status().

◆ PCPS_SIG_LVL_SIG_AVAIL

#define PCPS_SIG_LVL_SIG_AVAIL 128

Definition at line 1063 of file pcpsdefs.h.

◆ PCPS_SIG_LVL_SIG_NOT_AVAIL

#define PCPS_SIG_LVL_SIG_NOT_AVAIL 0

Definition at line 1062 of file pcpsdefs.h.

◆ PCPS_SIG_MAX

#define PCPS_SIG_MAX 68

Definition at line 1058 of file pcpsdefs.h.

Referenced by show_modulation(), show_signal(), and show_time_and_status().

◆ PCPS_SIG_MIN

#define PCPS_SIG_MIN 20

Definition at line 1057 of file pcpsdefs.h.

◆ PCPS_SN_SIZE

#define PCPS_SN_SIZE ( PCPS_FIFO_SIZE + 1 )

The maximum length of a serial number string, including terminating 0.

ASCIIZ string

Definition at line 922 of file pcpsdefs.h.

◆ PCPS_SUCCESS

#define PCPS_SUCCESS 0

Bus level command return codes.

Deprecated:: These codes are deprecated and MBG_RETURN_CODES should be used instead which provide corresponding symbols with same numeric values.

OK, no error (see MBG_SUCCESS)

Definition at line 894 of file pcpsdefs.h.

◆ PCPS_TZCODE_MEZ

#define PCPS_TZCODE_MEZ PCPS_TZCODE_CET

Definition at line 1449 of file pcpsdefs.h.

◆ PCPS_TZCODE_MEZMESZ

#define PCPS_TZCODE_MEZMESZ PCPS_TZCODE_CET_CEST

Definition at line 1448 of file pcpsdefs.h.

Referenced by set_timezone().

◆ PCPS_TZCODE_OEZ

#define PCPS_TZCODE_OEZ PCPS_TZCODE_EET_EEST

Definition at line 1450 of file pcpsdefs.h.

Referenced by set_timezone().

◆ PCPS_WRITE_GPS_DATA

#define PCPS_WRITE_GPS_DATA 0x51

(-w) Write large data structure, see PC_GPS_CMD_CODES

Definition at line 766 of file pcpsdefs.h.

Referenced by pcps_write_gps(), and report_ret_val().

◆ sizeof_PCPS_STIME

#define sizeof_PCPS_STIME sizeof( PCPS_STIME )

Definition at line 1181 of file pcpsdefs.h.

◆ sizeof_PCPS_TIME

#define sizeof_PCPS_TIME sizeof( PCPS_TIME )

Definition at line 1180 of file pcpsdefs.h.

Typedef Documentation

◆ PCPS_BUFF

typedef int8_t PCPS_BUFF[16]

A data buffer for a bus level device's command/data.

Definition at line 911 of file pcpsdefs.h.

◆ PCPS_CMD_INFO

typedef uint16_t PCPS_CMD_INFO

A type used to store an unambiguous command code.

In case of the standard PCPS_CMD_CODES the lower byte contains the command code and the upper byte is 0. In case of a GPS command the lower byte contains PCPS_READ_GPS_DATA or PCPS_WRITE_GPS_DATA, as appropriate, and the upper byte contains the associated type code from PC_GPS_CMD_CODES.

Used internally by the firmware only.

Definition at line 1787 of file pcpsdefs.h.

◆ PCPS_FRAC_32

typedef uint32_t PCPS_FRAC_32

32 bit binary fraction of a second

Used with PCPS_TIME_STAMP, e.g. 0x80000000 == 0.5 s, 0xFFFFFFFF == 0.9999999.. s, etc. Use bin_frac_32_to_dec_frac for conversion.

See also: bin_frac_32_to_dec_frac; PCPS_SECONDS; PCPS_TIME_STAMP; PCPS_HRT_FRAC_SCALE; PCPS_HRT_FRAC_SCALE_FMT

Definition at line 959 of file pcpsdefs.h.

◆ PCPS_ID_STR

typedef char PCPS_ID_STR[(2 * 16+1)]

A buffer for an ID string, including terminating 0.

Definition at line 918 of file pcpsdefs.h.

◆ PCPS_SECONDS

typedef uint32_t PCPS_SECONDS

Seconds since epoch 1970-01-01, usually UTC scale.

Used with PCPS_TIME_STAMP.

See also: PCPS_FRAC_32; PCPS_TIME_STAMP

Definition at line 936 of file pcpsdefs.h.

◆ PCPS_SERIAL

typedef uint8_t PCPS_SERIAL

Legacy definitions used to configure a device's serial port.

Deprecated:: This structure and the associated command codes are deprecated. PORT_SETTINGS, PORT_INFO and associated definitions should be used instead, if supported.

Configuration information for a device's serial port

Used with PCPS_GET_SERIAL and PCPS_SET_SERIAL

The serial interface on some old DCF77 clocks can be configured using the commands PCPS_SET_SERIAL and PCPS_GET_SERIAL. Both commands use a parameter byte describing transmission speed, framing and mode of operation. The parameter byte can be assembled using the constants defined in PCPS_BD_CODES, PCPS_FR_CODES, and PCPS_MOD_CODES, by or'ing one of the constants of each group, shifted to the right position. PCPS_GET_SERIAL expects that parameter byte and PCPS_GET_SERIAL returns the current configuration from the board. _pcps_has_serial checks whether supported. For old GPS clocks refer to the comments for the PCPS_GET_SERIAL command.

Definition at line 1342 of file pcpsdefs.h.

◆ PCPS_SIG_VAL

typedef uint8_t PCPS_SIG_VAL

Definitions used to report a signal strength.

A data type used to report the signal value

Definition at line 1051 of file pcpsdefs.h.

◆ PCPS_SN_STR

typedef char PCPS_SN_STR[( 16+1)]

A buffer for a serial number string, including terminating 0.

Definition at line 925 of file pcpsdefs.h.

◆ PCPS_TIME_STATUS

typedef uint8_t PCPS_TIME_STATUS

Time synchronization status.

Used by legacy API calls. New API calls provide an extended status word PCPS_TIME_STATUS_X.

See also: PCPS_TIME_STATUS_FLAGS_COMMON; PCPS_TIME_STATUS_X

Definition at line 1112 of file pcpsdefs.h.

◆ PCPS_TIME_STATUS_X

typedef uint16_t PCPS_TIME_STATUS_X

Extended status code.

Low byte corresponds to PCPS_TIME_STATUS, high byte contains additional flags.

See also: PCPS_TIME_STATUS; PCPS_TIME_STATUS_FLAGS

Definition at line 1022 of file pcpsdefs.h.

◆ PCPS_TZCODE

typedef uint8_t PCPS_TZCODE

Type of variable to hold a TZ code.

This is used with the PCI interface but differs from TZCODE which is used with the binary protocol.

See also: TZCODE; TZCODE_UNION

Definition at line 1432 of file pcpsdefs.h.

Enumeration Type Documentation

◆ PC_GPS_CMD_CODES

enum PC_GPS_CMD_CODES

GPS Command codes passed via the system bus.

Codes specifying various types of data that can be read from or written to Meinberg bus level devices which support this. Access is done using the low level functions pcps_read_gps and pcps_write_gps since the size of some of the structures exceeds the size of the device's I/O buffer and must therefore be accessed in several blocks.

Applications should instead use the API functions declared in mbgdevio.h.

The structures to be used are defined in gpsdefs.h. Not all structures are supported, yet. Check the r/w indicators for details.

See also: PCPS_CMD_CODES; PC_GPS_CMD_CODES_TABLE

Enumerator
PC_GPS_TZDL	(r/w) TZDL, time zone / daylight saving, only if GPS_MODEL_HAS_TZDL
PC_GPS_SW_REV	(r/-) SW_REV, software revision, deprecated by PC_GPS_RECEIVER_INFO
PC_GPS_BVAR_STAT	(r/-) BVAR_STAT, status of buffered variables, only if GPS_MODEL_HAS_BVAR_STAT
PC_GPS_TIME	(r/w) TTM, current time, deprecated by PCPS_GIVE_HR_TIME
PC_GPS_POS_XYZ	(-/w) XYZ, current position in ECEF coordinates, only if GPS_MODEL_HAS_POS_XYZ
PC_GPS_POS_LLA	(-/w) LLA, current position in geographic coordinates, only if GPS_MODEL_HAS_POS_LLA
PC_GPS_PORT_PARM	(r/w) PORT_PARM, param. of the serial ports, deprecated by PC_GPS_ALL_PORT_INFO
PC_GPS_ANT_INFO	(r/-) ANT_INFO, time diff at sync. after antenna had been disconn., only if GPS_MODEL_HAS_ANT_INFO
PC_GPS_UCAP	(r/-) TTM, user capture events, deprecated by PCPS_GIVE_UCAP_EVENT
PC_GPS_ENABLE_FLAGS	(r/w) ENABLE_FLAGS, when to enable serial, pulses, and synth, only if GPS_MODEL_HAS_ENABLE_FLAGS
PC_GPS_STAT_INFO	(r/-) GPS_STAT_INFO, satellite info, mode of operation, and DAC info, only if GPS_MODEL_HAS_STAT_INFO
PC_GPS_CMD	(-/w) GPS_CMD, send one of the PC_GPS_COMMANDS
PC_GPS_IDENT	(r/-) IDENT, serial number, deprecated by PC_GPS_RECEIVER_INFO
PC_GPS_POS	(r/-) POS, position XYZ, LLA, and DMS combined, only if GPS_MODEL_HAS_POS
PC_GPS_ANT_CABLE_LEN	(r/w) ANT_CABLE_LEN, length of antenna cable, only if GPS_MODEL_HAS_ANT_CABLE_LEN
PC_GPS_RECEIVER_INFO	(r/-) RECEIVER_INFO, rcvr model info, only if PCPS_HAS_RECEIVER_INFO
PC_GPS_ALL_STR_TYPE_INFO	(r/-) n * STR_TYPE_INFO_IDX, names and capabilities of all supp. string types, only if RECEIVER_INFO::n_str_type > 0
PC_GPS_ALL_PORT_INFO	(r/-) n * PORT_INFO_IDX, settings and capabilities of all serial ports, only if RECEIVER_INFO::n_com_ports > 0
PC_GPS_PORT_SETTINGS_IDX	(-/w) PORT_SETTINGS_IDX, settings for specified serial port, only if RECEIVER_INFO::n_com_ports > 0
PC_GPS_ALL_POUT_INFO	(r/-) n * POUT_INFO_IDX, all programmable output info
PC_GPS_POUT_SETTINGS_IDX	(-/w) POUT_SETTINGS_IDX, settings for one programmable output
PC_GPS_TIME_SCALE	(r/w) MBG_TIME_SCALE_SETTINGS / MBG_TIME_SCALE_INFO, only if PCPS_HAS_TIME_SCALE
PC_GPS_LAN_IF_INFO	(r/-) LAN_IF_INFO, LAN interface info, only if PCPS_HAS_LAN_INTF
PC_GPS_IP4_STATE	(r/-) IP4_SETTINGS, LAN interface state, only if PCPS_HAS_LAN_INTF
PC_GPS_IP4_SETTINGS	(r/w) IP4_SETTINGS, LAN interface configuration, only if PCPS_HAS_LAN_INTF
PC_GPS_PTP_STATE	(r/-) PTP_STATE, only if PCPS_HAS_PTP
PC_GPS_PTP_CFG	(r/w) PTP_CFG_SETTINGS / PTP_CFG_INFO, only if PCPS_HAS_PTP
PC_GPS_PTP_UC_MASTER_CFG_LIMITS	(r/-) PTP_UC_MASTER_CFG_LIMITS, only if PTP_CFG_MSK_SUPPORT_PTP_UNICAST
PC_GPS_ALL_PTP_UC_MASTER_INFO	(r/-) n * PTP_UC_MASTER_INFO_IDX, only if PTP_CFG_MSK_SUPPORT_PTP_UNICAST
PC_GPS_PTP_UC_MASTER_SETTINGS_IDX	(-/w) PTP_UC_MASTER_SETTINGS_IDX, only if PTP_CFG_MSK_SUPPORT_PTP_UNICAST
PC_GPS_GPIO_CFG_LIMITS	(r/-) MBG_GPIO_CFG_LIMITS, only if GPS_HAS_GPIO
PC_GPS_ALL_GPIO_INFO	(r/-) n * MBG_GPIO_INFO_IDX, all GPIO info, only if GPS_HAS_GPIO
PC_GPS_GPIO_SETTINGS_IDX	(-/w) MBG_GPIO_SETTINGS_IDX, settings for a specific port, only if GPS_HAS_GPIO
PC_GPS_GNSS_MODE	(r/w) MBG_GNSS_MODE_INFO / MBG_GNSS_MODE_SETTINGS, only if PCPS_IS_GNSS
PC_GPS_ALL_GNSS_SAT_INFO	(r/-) n * GNSS_SAT_INFO_IDX, satellite info, only if PCPS_IS_GNSS
PC_GPS_XMR_INSTANCES	(r/-) XMULTI_REF_INSTANCES, only if GPS_HAS_XMULTI_REF and GPS_HAS_XMRS_MULT_INSTC
PC_GPS_XMR_SETTINGS_IDX	(-/w) XMULTI_REF_SETTINGS_IDX, idx 0..XMULTI_REF_INSTANCES::n_xmr_settings-1, only if GPS_HAS_XMULTI_REF
PC_GPS_ALL_XMR_INFO	(r/-) n * XMULTI_REF_INFO_IDX, where n == XMULTI_REF_INSTANCES::n_xmr_settings, only if GPS_HAS_XMULTI_REF
PC_GPS_ALL_XMR_STATUS	(r/w) n * XMULTI_REF_STATUS_IDX, where n == XMULTI_REF_INSTANCES::n_xmr_settings, one structure on write, only if GPS_HAS_XMULTI_REF
PC_GPS_XMR_HOLDOVER_STATUS	(r/-) XMR_HOLDOVER_STATUS, only if XMRIF_MSK_HOLDOVER_STATUS_SUPP
PC_GPS_ALL_GPIO_STATUS	(r/-) n * MBG_GPIO_STATUS_IDX, where n == MBG_GPIO_CFG_LIMITS::num_io, only if MBG_GPIO_CFG_LIMIT_FLAG_MASK_STATUS_SUPP
PC_GPS_XFEATURE_BUFFER	(r/-) MBG_XFEATURE_BUFFER, only if GPS_HAS_XFEATURE
PC_GPS_TLV_INFO	(r/-) MBG_TLV_INFO, only if MBG_XFEATURE_TLV_API
PC_GPS_CFGH	(-/-) CFGH, SVs' config. and health codes (yet not used)
PC_GPS_ALM	(-/-) SV_ALM, one SV's num and almanac (yet not used)
PC_GPS_EPH	(-/-) SV_EPH, one SV's num and ephemeris (yet not used)
PC_GPS_UTC	(r/w) UTC, UTC corr. param., only if PCPS_HAS_UTC_PARM
PC_GPS_IONO	(-/-) IONO, ionospheric corr. param. (yet not used)
PC_GPS_ASCII_MSG	(-/-) ASCII_MSG, the GPS ASCII message (yet not used)

Definition at line 1633 of file pcpsdefs.h.

◆ PC_GPS_COMMANDS

enum PC_GPS_COMMANDS

Codes used with PC_GPS_CMD.

Note: These commands should only used with care, in very rare cases!

Enumerator
PC_GPS_CMD_BOOT	force a GPS receiver to boot mode
PC_GPS_CMD_INIT_SYS	let the clock clear its system variables
PC_GPS_CMD_INIT_USER	reset the clock's user parameters to defaults
PC_GPS_CMD_INIT_DAC	initialize the oscillator disciplining values
N_PC_GPS_CMD_CODES	no command, just the number of known commands

Definition at line 1765 of file pcpsdefs.h.

◆ PCPS_BD_CODES

enum PCPS_BD_CODES

Deprecated baud rate indices.

Deprecated:: These values are deprecated. MBG_BAUD_RATE_CODES and associated structures should be used preferably.

The sequence of codes matches the sequence defined in MBG_BAUD_RATE_CODES.

Enumerator
PCPS_BD_300
PCPS_BD_600
PCPS_BD_1200
PCPS_BD_2400
PCPS_BD_4800
PCPS_BD_9600
PCPS_BD_19200
N_PCPS_BD	number of codes

Definition at line 1355 of file pcpsdefs.h.

◆ PCPS_FR_CODES

enum PCPS_FR_CODES

Deprecated framing code indices.

Deprecated:: These values are deprecated. MBG_FRAMING_CODES and associated structures should be used preferably.

Unfortunately, these framing codes can not simply be replaced by the newer MBG_FRAMING_... definitions since the order of indices doesn't match.

Enumerator
PCPS_FR_8N1
PCPS_FR_7E2
PCPS_FR_8N2
PCPS_FR_8E1
N_PCPS_FR_DCF	number of valid codes

Definition at line 1383 of file pcpsdefs.h.

◆ PCPS_MOD_CODES

enum PCPS_MOD_CODES

Deprecated codes for modes of operation.

Deprecated:: These values are deprecated. STR_MODES and associated structures should be used preferably.

The sequence of codes matches the sequence defined in STR_MODES.

Enumerator
PCPS_MOD_REQ	time string on request '?' only
PCPS_MOD_SEC	time string once per second
PCPS_MOD_MIN	time string once per minute
PCPS_MOD_RSVD	reserved
N_PCPS_MOD_DCF	number of possible codes

Definition at line 1407 of file pcpsdefs.h.

◆ PCPS_REF_TYPES

enum PCPS_REF_TYPES

Enumeration of the ref time signal sources used by Meinberg devices.

Enumerator
PCPS_REF_NONE	unknown, or not defined
PCPS_REF_DCF	DCF77 long wave signal (Germany), see http://www.meinberg.de/english/info/dcf77.htm.
PCPS_REF_GPS	GPS satellite system, see http://www.meinberg.de/english/info/gps.htm.
PCPS_REF_IRIG	IRIG or similar time code, see http://www.meinberg.de/english/info/irig.htm.
PCPS_REF_MSF	MSF long wave signal (UK)
PCPS_REF_PTP	PTP/IEEE1588 network protocol.
PCPS_REF_FRC	Free Running Clock.
PCPS_REF_WWVB	WWVB long wave signal (U.S.)
PCPS_REF_JJY	JJY long wave signal (Japan)
N_PCPS_REF	number of defined ref time sources

Definition at line 291 of file pcpsdefs.h.

◆ PCPS_TIME_STATUS_FLAGS_COMMON

enum PCPS_TIME_STATUS_FLAGS_COMMON

Time status flags.

Legacy time status flags

Bit masks used with both PCPS_TIME_STATUS and PCPS_TIME_STATUS_X

Enumerator
PCPS_FREER	long wave or time code receiver running on xtal, satellite receiver has not verified its position
PCPS_DL_ENB	daylight saving currently enabled
PCPS_SYNCD	long wave or time code receiver has sync'ed at least once after pwr up, sat receiver is synchronized
PCPS_DL_ANN	a change in daylight saving status is announced
PCPS_UTC	returned time is always UTC instead of some local time
PCPS_LS_ANN	leap second announced, for very old clocks see REV_PCPS_LS_ANN_PC31PS31
PCPS_IFTM	the current time has been set by an API call, for very old clocks see REV_PCPS_IFTM_PC31PS31
PCPS_INVT	invalid time because battery had been disconnected, or absolute time can't be decoded safely

Definition at line 1252 of file pcpsdefs.h.

◆ PCPS_TIME_STATUS_FLAGS_EXT

enum PCPS_TIME_STATUS_FLAGS_EXT

Extended time status flags.

Bit masks used with PCPS_TIME_STATUS_X only

Enumerator
PCPS_LS_ENB	current second is leap second
PCPS_ANT_FAIL	antenna failure
PCPS_LS_ANN_NEG	announced leap second is negative
PCPS_SCALE_GPS	time stamp is GPS scale
PCPS_SCALE_TAI	time stamp is TAI scale
PCPS_UCAP_OVERRUN	events interval too short (capture events only)
PCPS_UCAP_BUFFER_FULL	events read too slow (capture events only)
PCPS_SYNC_PZF	Bit masks used only with time stamps representing the current board time. A DCF77 PZF receiver can set this bit if it is actually synchronized using PZF correlation and thus provides higher accuracy than AM receivers. Same numeric code as PCPS_UCAP_OVERRUN
PCPS_IO_BLOCKED	Immediately after a clock has been accessed, subsequent accesses may be blocked for up to 1.5 msec to give the clock's microprocessor some time to decode the incoming time signal. The flag below is eventually set if a program tries to read PCPS_HR_TIME during this interval. In this case the read function returns the proper time stamp which is taken if the command byte is written, however, the read function returns with delay. This flag is not supported by all clocks.

Definition at line 1270 of file pcpsdefs.h.

◆ PCPS_TZCODES

enum PCPS_TZCODES

Enumeration of codes used with PCPS_TZCODE.

Enumerator
PCPS_TZCODE_CET_CEST	default as broadcast by DCF77 (UTC+1h/UTC+2h)
PCPS_TZCODE_CET	always CET (UTC+1h), discard DST
PCPS_TZCODE_UTC	always UTC
PCPS_TZCODE_EET_EEST	East European Time, CET/CEST + 1h.
N_PCPS_TZCODE	the number of valid codes

Definition at line 1438 of file pcpsdefs.h.

Data Structures

Macros

Typedefs

Enumerations

Macro Definition Documentation

◆ _mbg_swab_pcps_dl_onoff

◆ _mbg_swab_pcps_frac_32

◆ _mbg_swab_pcps_hr_time

◆ _mbg_swab_pcps_irig_time

◆ _mbg_swab_pcps_seconds

◆ _mbg_swab_pcps_time_stamp

◆ _mbg_swab_pcps_time_status_x

◆ _mbg_swab_pcps_time_status_x_masks

◆ _mbg_swab_pcps_tzdl

◆ _mbg_swab_pcps_ucap_entries

◆ _USE_PCPSPRIV

◆ BITMASK

◆ DL_AUTO_FLAG

◆ IRIG_TIME_UNKNOWN_YEAR

◆ MBG_CMD_TABLE_EXT

◆ MBG_PCPS_FMT_STATUS

◆ PC_GPS_CMD_CODES_TABLE

◆ PCI_DEV_FRC511PEX

◆ PCI_DEV_GLN180PEX

◆ PCI_DEV_GNS181PEX

◆ PCI_DEV_GPS167PCI

◆ PCI_DEV_GPS168PCI

◆ PCI_DEV_GPS169PCI

◆ PCI_DEV_GPS170PCI

◆ PCI_DEV_GPS170PEX

◆ PCI_DEV_GPS180AMC

◆ PCI_DEV_GPS180PEX

◆ PCI_DEV_PCI32

◆ PCI_DEV_PCI509

◆ PCI_DEV_PCI510

◆ PCI_DEV_PCI511

◆ PCI_DEV_PEX511

◆ PCI_DEV_PTP270PEX

◆ PCI_DEV_PZF180PEX

◆ PCI_DEV_TCR167PCI

◆ PCI_DEV_TCR170PEX

◆ PCI_DEV_TCR180PEX

◆ PCI_DEV_TCR510PCI

◆ PCI_DEV_TCR511PCI

◆ PCI_DEV_TCR511PEX

◆ PCI_VENDOR_MEINBERG

◆ PCPS_BD_BITS

◆ PCPS_BD_SHIFT

◆ PCPS_CLR_EVT_LOG

◆ PCPS_CLR_UCAP_BUFF

◆ PCPS_CMD_CODES_TABLE

◆ PCPS_ERR_CFG

◆ PCPS_ERR_STIME

◆ PCPS_FIFO_SIZE

◆ PCPS_FIRST_EVT_LOG_ENTRY

◆ PCPS_FORCE_RESET

◆ PCPS_FR_BITS

◆ PCPS_FR_SHIFT

◆ PCPS_GENERIC_IO

◆ PCPS_GET_CORR_INFO

◆ PCPS_GET_DEBUG_STATUS

◆ PCPS_GET_IRIG_CTRL_BITS

◆ PCPS_GET_IRIG_RX_INFO

◆ PCPS_GET_IRIG_TX_INFO

◆ PCPS_GET_OPT_INFO

◆ PCPS_GET_PCPS_TZDL

◆ PCPS_GET_RAW_IRIG_DATA

◆ PCPS_GET_REF_OFFS

◆ PCPS_GET_SERIAL

◆ PCPS_GET_STATUS_PORT

◆ PCPS_GET_SYNTH

◆ PCPS_GET_SYNTH_STATE

◆ PCPS_GET_TR_DISTANCE

◆ PCPS_GET_TZCODE

◆ PCPS_GIVE_FW_ID_1

◆ PCPS_GIVE_FW_ID_2

◆ PCPS_GIVE_HR_TIME

◆ PCPS_GIVE_IRIG_TIME

◆ PCPS_GIVE_SERNUM

◆ PCPS_GIVE_SYNC_TIME