mbgtools-lx  4.2.8
pcpsiobf.h
Go to the documentation of this file.
1 
2 /**************************************************************************
3  *
4  * $Id: pcpsiobf.h 1.3 2019/04/03 12:33:22 martin TRASH $
5  *
6  * Copyright (c) Meinberg Funkuhren, Bad Pyrmont, Germany
7  *
8  * Description:
9  * Definitions an I/O buffer that can be used in kernel space
10  * and user space, on targets that support IOCTL as well as
11  * on targets that don't.
12  *
13  * -----------------------------------------------------------------------
14  * $Log: pcpsiobf.h $
15  * Revision 1.3 2019/04/03 12:33:22 martin
16  * Excluded some PCPS_IO_BUFFER fields that are currently not required.
17  * Revision 1.2 2018/01/18 14:52:52 martin
18  * Fix for C++ builds.
19  * Revision 1.1 2018/01/15 10:31:26Z martin
20  * Initial revision with structures moved from mbgioctl.h here.
21  *
22  **************************************************************************/
23 
24 #ifndef _PCPSIOBF_H
25 #define _PCPSIOBF_H
26 
27 #include <pcpsdev.h>
28 #include <cfg_hlp.h>
29 #include <mbggeo.h>
30 
31 
32 /* Start of header body */
33 
34 // We must *not* use byte-alignment here.
35 
36 
37 #ifdef __cplusplus
38 extern "C" {
39 #endif
40 
41 
50 typedef struct
51 {
53 } LLAs;
54 
55 
56 
65 typedef struct
66 {
68 } XYZs;
69 
70 
71 
78 typedef union
79 {
80  PCPS_STATUS_PORT pcps_status_port_usb; // only used with USB devices
135  // MBG_DBG_DATA mbg_dbg_data; // currently not required
136  // MBG_PC_CYCLES_FREQUENCY mbg_pc_cycles_frequency; // currently not required
138  // MBG_TIME_INFO_TSTAMP mbg_time_info_tstamp; // currently not required
156 
158 
159 
160 #ifdef __cplusplus
161 }
162 #endif
163 
164 
165 /* End of header body */
166 
167 #undef _ext
168 
169 #endif /* _PCPSIOBF_H */
PTP_STATE ptp_state
Definition: pcpsiobf.h:125
A structure to used to read the status of the PTP protocol stack.
Definition: gpsdefs.h:13184
uint16_t TR_DISTANCE
Receiver distance from transmitter [km].
Definition: pcpsdefs.h:1553
Configuration settings for a specific PTP unicast master.
Definition: gpsdefs.h:14329
Number of event log entries that can be stored and yet have been saved.
Definition: gpsdefs.h:9540
uint8_t PCPS_TZCODE
Type of variable to hold a TZ code.
Definition: pcpsdefs.h:1432
MBG_OPT_SETTINGS mbg_opt_settings
Definition: pcpsiobf.h:92
Configuration settings of a specific serial port.
Definition: gpsdefs.h:3594
High resolution device time, system time, and associated cycles counts.
Definition: pcpsdev.h:1418
uint16_t MBG_DBG_PORT
Definition: pcpsdev.h:370
MBG_GNSS_MODE_INFO gnss_mode_info
Definition: pcpsiobf.h:145
Settings of an IPv4-only network interface.
Definition: gpsdefs.h:11239
PCPS_SN_STR sernum
Definition: pcpsiobf.h:82
GPS UTC correction parameters.
Definition: gpsdefs.h:18564
MBG_GNSS_MODE_SETTINGS gnss_mode_settings
Definition: pcpsiobf.h:144
A structure used to configure a PTP port.
Definition: gpsdefs.h:13278
A The structure used to store the configuration of two serial ports.
Definition: gpsdefs.h:3929
Time scale configuration settings plus capabilities.
Definition: gpsdefs.h:5519
PCPS_TIME pcps_time
Definition: pcpsiobf.h:83
ALL_XMULTI_REF_INFO_IDX all_xmulti_ref_info_idx
Definition: pcpsiobf.h:153
MBG_EVT_LOG_ENTRY evt_log_entry
Definition: pcpsiobf.h:143
GPS_CMD gps_cmd
Definition: pcpsiobf.h:105
MBG_GPIO_CFG_LIMITS mbg_gpio_cfg_limits
Definition: pcpsiobf.h:147
Current IRIG settings and supported codes.
Definition: gpsdefs.h:5054
MBG_TIME_SCALE_SETTINGS mbg_time_scale_settings
Definition: pcpsiobf.h:120
GNSS_SAT_INFO_IDX ALL_GNSS_SAT_INFO_IDX[N_GNSS_TYPES]
An array of configuration settings for all programmable pulse outputs.
Definition: cfg_hlp.h:437
A structure used to configure optional settings.
Definition: gpsdefs.h:5342
XMR holdover status.
Definition: gpsdefs.h:7157
ALL_XMULTI_REF_STATUS_IDX all_xmulti_ref_status_idx
Definition: pcpsiobf.h:152
An event log entry.
Definition: gpsdefs.h:9564
uint8_t PCPS_STATUS_PORT
Type of the status register port.
Definition: pcpsdefs.h:431
PCPS_TZDL pcps_tzdl
Definition: pcpsiobf.h:89
IP4_SETTINGS ip4_settings
Definition: pcpsiobf.h:124
ALL_GPIO_STATUS_IDX all_gpio_status_idx
Definition: pcpsiobf.h:149
PORT_SETTINGS_IDX port_settings_idx
Definition: pcpsiobf.h:111
uint8_t PCPS_SERIAL
Legacy definitions used to configure a device&#39;s serial port.
Definition: pcpsdefs.h:1342
uint16_t GPS_CMD
The type of a GPS command code.
Definition: gpsdefs.h:719
STAT_INFO stat_info
Definition: pcpsiobf.h:103
PCPS_HR_TIME_CYCLES pcps_hr_time_cycles
Definition: pcpsiobf.h:133
General GPIO config info to be read from a device.
Definition: gpsdefs.h:7608
TR_DISTANCE tr_distance
Definition: pcpsiobf.h:140
Time read from a device plus associated system cycles count.
Definition: pcpsdev.h:1354
Status of the time capture FIFO buffer.
Definition: pcpsdefs.h:1529
PCPS_TIME_CYCLES pcps_time_cycles
Definition: pcpsiobf.h:132
MBG_TIME_INFO_HRT mbg_time_info_hrt
Definition: pcpsiobf.h:137
uint16_t BVAR_STAT
Status flags of battery buffered data.
Definition: gpsdefs.h:770
Time scale configuration settings.
Definition: gpsdefs.h:5505
PTP_UC_MASTER_SETTINGS_IDX ptp_uc_master_settings_idx
Definition: pcpsiobf.h:131
Specification of a local time zone.
Definition: pcpsdefs.h:1504
PCPS_STIME pcps_stime
Definition: pcpsiobf.h:84
ANT_INFO ant_info
Definition: pcpsiobf.h:101
MBG_GPIO_SETTINGS_IDX mbg_gpio_settings_idx
Definition: pcpsiobf.h:150
ENABLE_FLAGS enable_flags
Definition: pcpsiobf.h:102
CORR_INFO corr_info
Definition: pcpsiobf.h:139
PCPS_TZCODE pcps_tzcode
Definition: pcpsiobf.h:88
MBG_DBG_PORT mbg_dbg_port
Definition: pcpsiobf.h:134
Reference source configuration for a specific priority level.
Definition: gpsdefs.h:6749
SW_REV sw_rev
Definition: pcpsiobf.h:97
MBG_RAW_IRIG_DATA mbg_raw_irig_data
Definition: pcpsiobf.h:129
Date time and status used with the PCPS_SET_TIME command.
Definition: pcpsdefs.h:1156
uint16_t ANT_CABLE_LEN
A data type used to configure the length of an antenna cable [m].
Definition: gpsdefs.h:11012
MBG_IRIG_CTRL_BITS mbg_irig_ctrl_bits
Definition: pcpsiobf.h:122
A structure to used to query the current configuration and capabilities of a PTP port.
Definition: gpsdefs.h:13342
PORT_PARM port_parm
Definition: pcpsiobf.h:100
ALL_PTP_UC_MASTER_INFO_IDX all_ptp_uc_master_info_idx
Definition: pcpsiobf.h:118
double XYZ[N_XYZ]
A position in cartesian coordinates.
Definition: gpsdefs.h:2742
A structure used to report the synthesizer state.
Definition: gpsdefs.h:2890
A structure used to transmit information on date and time.
Definition: gpsdefs.h:2713
PTP_CFG_INFO ptp_cfg_info
Definition: pcpsiobf.h:126
GNSS mode settings.
Definition: gpsdefs.h:10677
A GPIO port&#39;s current settings, plus port index.
Definition: gpsdefs.h:9184
Limits to be considered when specifying PTP unicast masters.
Definition: gpsdefs.h:14231
char PCPS_SN_STR[(16+1)]
A buffer for a serial number string, including terminating 0.
Definition: pcpsdefs.h:925
XMULTI_REF_INSTANCES xmulti_ref_instances
Definition: pcpsiobf.h:151
Configuration settings for a specific programmable pulse output.
Definition: gpsdefs.h:6249
MBG_GPIO_STATUS_IDX ALL_GPIO_STATUS_IDX[10]
Status information on all GPIO ports.
Definition: cfg_hlp.h:507
A wrapper struct for the XYZ array type.
Definition: pcpsiobf.h:65
A structure used to configure optional settings.
Definition: gpsdefs.h:5323
int16_t MBG_REF_OFFS
A data type used to configure the ref offset.
Definition: gpsdefs.h:5297
XMULTI_REF_STATUS_IDX ALL_XMULTI_REF_STATUS_IDX[10]
Status of all XMR inputs.
Definition: cfg_hlp.h:513
ALL_POUT_INFO_IDX all_pout_info_idx
Definition: pcpsiobf.h:114
General info on supported XMR sources and instances.
Definition: gpsdefs.h:7054
A wrapper struct for the LLA array type.
Definition: pcpsiobf.h:50
char PCPS_ID_STR[(2 *16+1)]
A buffer for an ID string, including terminating 0.
Definition: pcpsdefs.h:918
PTP_UC_MASTER_CFG_LIMITS ptp_uc_master_cfg_limits
Definition: pcpsiobf.h:130
POUT_SETTINGS_IDX pout_settings_idx
Definition: pcpsiobf.h:115
An I/O buffer for bus level devices.
Definition: pcpsiobf.h:78
Raw IRIG time.
Definition: pcpsdefs.h:1207
ALL_STR_TYPE_INFO_IDX all_str_type_info_idx
Definition: pcpsiobf.h:116
Time zone / daylight saving parameters.
Definition: gpsdefs.h:2940
XMULTI_REF_INFO_IDX ALL_XMULTI_REF_INFO_IDX[10]
Configuration settings for all XMR inputs.
Definition: cfg_hlp.h:516
Synthesizer configuration parameters.
Definition: gpsdefs.h:2856
MBG_NUM_EVT_LOG_ENTRIES num_evt_log_entries
Definition: pcpsiobf.h:142
ANT_CABLE_LEN ant_cable_len
Definition: pcpsiobf.h:110
POUT_INFO_IDX ALL_POUT_INFO_IDX[10]
An array of configuration settings for all programmable pulse outputs.
Definition: cfg_hlp.h:224
A geographic position represented in different formats.
Definition: mbggeo.h:113
A buffer used to read raw IRIG data bits from an IRIG receiver.
Definition: gpsdefs.h:5423
ALL_PORT_INFO_IDX all_port_info_idx
Definition: pcpsiobf.h:117
LLA lla
Definition: pcpsiobf.h:52
XMULTI_REF_SETTINGS_IDX xmulti_ref_settings_idx
Definition: pcpsiobf.h:154
PZF correlation status info.
Definition: pcpsdefs.h:1562
LAN_IF_INFO lan_if_info
Definition: pcpsiobf.h:123
High resolution time including status and local time offset.
Definition: pcpsdefs.h:1085
High resolution time plus associated system cycles count.
Definition: pcpsdev.h:1392
Satellite receiver status information.
Definition: gpsdefs.h:10591
MBG_GPIO_INFO_IDX ALL_GPIO_INFO_IDX[10]
Configuration settings for all GPIO ports.
Definition: cfg_hlp.h:504
XMR_HOLDOVER_STATUS xmr_holdover_status
Definition: pcpsiobf.h:155
MBG_TIME_SCALE_INFO mbg_time_scale_info
Definition: pcpsiobf.h:119
ALL_GPIO_INFO_IDX all_gpio_info_idx
Definition: pcpsiobf.h:148
Software revision information.
Definition: gpsdefs.h:732
Local calendar date and time, plus sync status.
Definition: pcpsdefs.h:1128
XYZ xyz
Definition: pcpsiobf.h:67
A high resolution time stamp.
Definition: pcpsdefs.h:972
double LLA[N_LLA]
A geographic position based on latitude, longitude, and altitude.
Definition: gpsdefs.h:2764
Configuration settings of an IRIG input or output.
Definition: gpsdefs.h:4999
PTP_UC_MASTER_INFO_IDX ALL_PTP_UC_MASTER_INFO_IDX[3]
Configuration settings for all unicast master specifications.
Definition: cfg_hlp.h:358
RECEIVER_INFO receiver_info
Definition: pcpsiobf.h:104
SYNTH_STATE synth_state
Definition: pcpsiobf.h:113
uint32_t MBG_IRIG_CTRL_BITS
Bit coded return type for PCPS_GET_IRIG_CTRL_BITS.
Definition: gpsdefs.h:5392
PTP_CFG_SETTINGS ptp_cfg_settings
Definition: pcpsiobf.h:127
STR_TYPE_INFO_IDX ALL_STR_TYPE_INFO_IDX[20]
An array of configuration settings for all serial string types.
Definition: cfg_hlp.h:179
PCPS_UCAP_ENTRIES pcps_ucap_entries
Definition: pcpsiobf.h:95
Antenna status and error at reconnect information.
Definition: gpsdefs.h:3100
PORT_INFO_IDX ALL_PORT_INFO_IDX[10]
An array of configuration settings for all serial ports.
Definition: cfg_hlp.h:176
PCPS_IRIG_TIME pcps_irig_time
Definition: pcpsiobf.h:128
PCPS_HR_TIME pcps_hr_time
Definition: pcpsiobf.h:85
PCPS_SERIAL pcps_serial
Definition: pcpsiobf.h:87
BVAR_STAT bvar_stat
Definition: pcpsiobf.h:98
IRIG_INFO irig_info
Definition: pcpsiobf.h:93
PCPS_ID_STR fw_id
Definition: pcpsiobf.h:81
A structure used to identify a device type and supported features.
Definition: gpsdefs.h:873
PCPS_STATUS_PORT pcps_status_port_usb
Definition: pcpsiobf.h:80
uint32_t MBG_DEBUG_STATUS
A data type used to read the board&#39;s debug status.
Definition: gpsdefs.h:5204
MBG_OPT_INFO mbg_opt_info
Definition: pcpsiobf.h:91
ALL_GNSS_SAT_INFO_IDX all_gnss_sat_info_idx
Definition: pcpsiobf.h:146
Simple LAN interface information.
Definition: gpsdefs.h:11274
MBG_DEBUG_STATUS debug_status
Definition: pcpsiobf.h:141
MBG_REF_OFFS mbg_ref_offs
Definition: pcpsiobf.h:90
IRIG_SETTINGS irig_settings
Definition: pcpsiobf.h:94
A structure controlling when output signals are enabled.
Definition: gpsdefs.h:3142
PCPS_TIME_STAMP pcps_time_stamp
Definition: pcpsiobf.h:86