#include <mbg_arch.h>
#include <gpsserio.h>
#include <mbggeo.h>
#include <pcpsdefs.h>
#include <time.h>

Macros
#define	_ext extern

#define	_ttm_time_set_unavail(_t) do { (_t)->tm.sec = (uint8_t) 0xFF; } while ( 0 )

#define	_ttm_time_is_avail(_t) ( (uint8_t) (_t)->tm.sec != (uint8_t) 0xFF )

#define	FT_STATUS int

#define	FT_HANDLE int

#define	_MBGEXTIO_REQ_ACK 1

#define	OPT_GPS_ACK_CODE GPS_REQACK

#define	MBGEXTIO_READ_BUFFER_SIZE (MAX_MSG_DATA_SIZE + 1)

#define	_mbgextio_xmt_msg(_pmctl, _addr, _cmd, _s) mbgextio_xmt_msg( _pmctl, _addr, _cmd, _s, sizeof( *(_s) ) )

Typedefs
typedef int	MBG_USB_DEV_INFO

typedef int	libusb_device

typedef int	MBG_LAN_DEV_CHAN

typedef int	MBG_LAN_DEV_CFG

typedef int	MBG_LAN_DEV_LIST

typedef int	MBGEXTIO_CHK_SUPP_FNC(const MBG_MSG_CTL *pmctl)
	Type of functions to check if a feature is supported. More...

Functions
const char *	mbgextio_get_cmd_name (GPS_CMD cmd_code)

int	mbgextio_setup_xdevfeat (MBG_MSG_CTL pmctl, XBP_ADDR addr)
	Set up MBG_XDEV_FEATURES for a device which has just been opened. More...

int	mbgextio_find_lan_devices (MBG_LAN_DEV_LIST **list, uint16_t timeout_ms)
	Sets up a list of all available Meinberg LAN devices in the network. More...

int	mbgextio_free_lan_devices (MBG_LAN_DEV_LIST *list)
	Frees the MBG_LAN_DEV_LIST allocated by mbgextio_find_lan_devices. More...

int	mbgextio_xmt_secu_settings (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, const char old_passwd, const char new_passwd)
	Send security settings for the socket connection. More...

int	mbgextio_socket_write_default (MBG_MSG_CTL pmctl, const void buf, size_t len)
	Function, which can be used to write data to a standard LAN socket. More...

int	mbgextio_socket_read_default (MBG_MSG_CTL pmctl, void buf, size_t len)
	Function, which can be used to read data from a standard LAN socket. More...

int	mbgextio_open_socket (const char host, MBG_MSG_CTL ppmctl, const char passwd)
	Open a binary communication channel via a LAN/socket connection. More...

int	mbgextio_socket_write_ssh (MBG_MSG_CTL pmctl, const void buf, size_t len)
	Function, which can be used to write data to an SSH binary protocol channel. More...

int	mbgextio_socket_read_ssh (MBG_MSG_CTL pmctl, void buf, size_t len)
	Function, which can be used to read data from an SSH binary protocol channel. More...

int	mbgextio_open_ssh_socket (const char host, MBG_MSG_CTL ppmctl, SSH_DATA ssh_data)

int	mbgextio_open_serial_raw (const char dev, MBG_MSG_CTL ppmctl, uint32_t baud_rate, const char framing)

int	mbgextio_open_serial (const char dev, MBG_MSG_CTL ppmctl, uint32_t baud_rate, const char framing)
	Open a binary communication channel using direct serial I/O. More...

int	mbgextio_open_serial_force_default (const char dev, MBG_MSG_CTL ppmctl, uint32_t baud_rate, const char framing)
	Open a binary communication channel forcing default serial parameters. More...

int	mbgextio_get_serial_ftdi_port_handle (MBG_MSG_CTL *pmctl)
	Get the port handle of a serial FTDI device. More...

int	mbgextio_open_serial_ftdi (int device_num, MBG_MSG_CTL *ppmctl, uint32_t baud_rate, const char framing)
	Open a binary communication channel using serial FTDI D2xx port. More...

int	mbgextio_open_usb (const MBG_USB_DEV_INFO mdev_info, MBG_MSG_CTL *ppmctl)
	Open a binary communication channel using direct USB I/O. More...

int	mbgextio_reset_usb (const MBG_USB_DEV_INFO *mdev_info)
	Reset an USB device in case that the open_usb function return MBG_ERR_BUSY. More...

int	mbgextio_open_usb_ldev (libusb_device ldev, MBG_MSG_CTL *ppmctl)
	Open a binary communication channel using direct USB I/O. More...

int	mbgextio_close_connection (MBG_MSG_CTL **ppmctl)
	Close a binary communication channel and release resources. More...

long	mbgextio_force_conn_serial (const char *dev)
	Try to force a serial connection to a device. More...

long	mbgextio_force_conn_serial_ftdi (int device_num)
	Try to force a serial connection to a device via the FTDI API. More...

void	mbgextio_register_nack_callback (MBG_MSG_CTL pmctl, MBG_NACK_HANDLER_FNC fnc)
	Register a NACK message handler callback function. More...

void	mbgextio_register_async_msg_callback (MBG_MSG_CTL pmctl, MBG_ASYNC_MSG_HANDLER_FNC fnc)
	Register an asynchronous message handler callback function. More...

void	mbgextio_register_async_data_callback (MBG_MSG_CTL pmctl, MBG_ASYNC_DATA_HANDLER_FNC fnc)
	Register an asynchronous data handler callback function. More...

void	mbgextio_register_async_data_reset_callback (MBG_MSG_CTL pmctl, MBG_ASYNC_DATA_RESET_FNC fnc)
	Register an asynchronous data reset callback function. More...

RECEIVER_INFO *	mbgextio_get_receiver_info_addr (MBG_MSG_CTL *pmctl)
	Retrieve address of the RECEIVER_INFO read from the device. More...

MBG_MSG_BUFF *	mbgextio_get_rcv_buffer_addr (MBG_MSG_CTL *pmctl)
	Retrieve address of the allocated receive buffer. More...

size_t	mbgextio_get_rcv_buffer_size (MBG_MSG_CTL *pmctl)
	Retrieve size of the allocated receive buffer. More...

MBG_MSG_BUFF *	mbgextio_get_xmt_buffer_addr (MBG_MSG_CTL *pmctl)
	Retrieve address of the allocated transmit buffer. More...

size_t	mbgextio_get_xmt_buffer_size (MBG_MSG_CTL *pmctl)
	Retrieve size of the allocated transmit buffer. More...

ulong	mbgextio_set_dev_poll_timeout (MBG_MSG_CTL *pmctl, ulong new_timeout)
	Set device poll timeout. More...

ulong	mbgextio_get_dev_poll_timeout (const MBG_MSG_CTL *pmctl)
	Get device poll timeout. More...

void	mbgextio_set_msg_rcv_timeout (MBG_MSG_CTL *pmctl, ulong new_timeout)
	Set message receive timeout value. More...

ulong	mbgextio_get_msg_rcv_timeout (const MBG_MSG_CTL *pmctl)
	Get message receive timeout value. More...

int	mbgextio_dev_is_legacy (const MBG_MSG_CTL *pmctl)
	Check if a device is a legacy device. More...

int	mbgextio_dev_has_pos_xyz (const MBG_MSG_CTL *pmctl)

int	mbgextio_dev_has_pos_lla (const MBG_MSG_CTL *pmctl)

int	mbgextio_dev_has_time_ttm (const MBG_MSG_CTL *pmctl)

int	mbgextio_dev_has_ant_info (const MBG_MSG_CTL *pmctl)

int	mbgextio_dev_has_ant_cable_length (const MBG_MSG_CTL *pmctl)

int	mbgextio_dev_has_io_ports (const MBG_MSG_CTL *pmctl)

int	mbgextio_dev_has_tainted_cfg (const MBG_MSG_CTL *pmctl)

int	mbgextio_dev_has_push_msgs (const MBG_MSG_CTL *pmctl)

int	mbgextio_dev_has_clk_res_info (const MBG_MSG_CTL *pmctl)

int	mbgextio_dev_has_gps_stat_info (const MBG_MSG_CTL *pmctl)
	Check if a device supports the STAT_INFO structure and API. More...

int	mbgextio_dev_is_gps (const MBG_MSG_CTL *pmctl)
	Check if a device can receive the GPS satellite system. More...

int	mbgextio_dev_is_gnss (const MBG_MSG_CTL *pmctl)
	Check if a device supports the GNSS API. More...

int	mbgextio_dev_is_tcr (const MBG_MSG_CTL *pmctl)
	Check if a device is a time code receiver(TCR) More...

int	mbgextio_dev_is_dcf (const MBG_MSG_CTL *pmctl)
	Check if a device is a DCF77 receiver. More...

int	mbgextio_dev_has_pzf (const MBG_MSG_CTL *pmctl)
	Check if a device supports DCF77 PZF decoding. More...

int	mbgextio_dev_is_bus_lvl_dev (const MBG_MSG_CTL *pmctl)
	Check if a device is a bus level device. More...

int	mbgextio_dev_has_enable_flags (const MBG_MSG_CTL *pmctl)

int	mbgextio_dev_has_time_scale (const MBG_MSG_CTL *pmctl)

int	mbgextio_dev_has_tzdl (const MBG_MSG_CTL *pmctl)

int	mbgextio_dev_has_tzcode (const MBG_MSG_CTL *pmctl)

int	mbgextio_dev_has_ims (const MBG_MSG_CTL *pmctl)

int	mbgextio_dev_has_synth (const MBG_MSG_CTL *pmctl)

int	mbgextio_dev_has_gpio (const MBG_MSG_CTL *pmctl)

int	mbgextio_dev_has_prog_pulses (const MBG_MSG_CTL *pmctl)

int	mbgextio_dev_has_irig_tx (const MBG_MSG_CTL *pmctl)

int	mbgextio_dev_has_irig_rx (const MBG_MSG_CTL *pmctl)

int	mbgextio_dev_has_serouts (const MBG_MSG_CTL *pmctl)

int	mbgextio_dev_has_bvar_stat (const MBG_MSG_CTL *pmctl)

int	mbgextio_dev_has_service (const MBG_MSG_CTL *pmctl)

int	mbgextio_dev_has_up_conv (const MBG_MSG_CTL *pmctl)
	Check if the device has an L1 frequency up converter. More...

int	mbgextio_dev_has_scu_stat (const MBG_MSG_CTL *pmctl)
	Check if the device supports the SCU_STAT structures. More...

int	mbgextio_dev_has_raw_irig_data (const MBG_MSG_CTL *pmctl)
	Check if a timecode receiver provides MBG_RAW_IRIG_DATA. More...

int	mbgextio_dev_has_lan_ip4 (const MBG_MSG_CTL *pmctl)
	Check if a device supports the old LAN_IP4 API. More...

int	mbgextio_dev_has_net_cfg (const MBG_MSG_CTL *pmctl)
	Check if a device supports the new NET_CFG API. More...

int	mbgextio_dev_has_ptp (const MBG_MSG_CTL *pmctl)
	Check if a device supports the PTP API. More...

int	mbgextio_dev_has_ntp (const MBG_MSG_CTL *pmctl)
	Check if a device supports the NTP API. More...

int	mbgextio_dev_has_fw_mngmnt (const MBG_MSG_CTL *pmctl)
	Check if a device supports the FW management API. More...

int	mbgextio_dev_has_evt_log (const MBG_MSG_CTL *pmctl)

int	mbgextio_dev_has_ucap (const MBG_MSG_CTL *pmctl)

int	mbgextio_dev_has_ucap_net (const MBG_MSG_CTL *pmctl)

int	mbgextio_dev_has_tlv_api (const MBG_MSG_CTL *pmctl)
	Check if a device supports the TLV API. More...

int	mbgextio_dev_has_user_auth (const MBG_MSG_CTL *pmctl)
	Check if a device supports user authentication. More...

int	mbgextio_dev_has_user_mngmnt (const MBG_MSG_CTL *pmctl)
	Check if a device supports user management. More...

int	mbgextio_dev_supp_tlv_file_req (const MBG_MSG_CTL *pmctl)
	Check if a device supports file request via TLV. More...

int	mbgextio_dev_supp_tlv_exec_cmd (const MBG_MSG_CTL *pmctl)
	Check if a device supports command execution via TLV. More...

int	mbgextio_dev_supp_tlv_fw_rollback (const MBG_MSG_CTL *pmctl)
	Check if a device supports a factory reset via TLV. More...

int	mbgextio_dev_supp_tlv_fw_update (const MBG_MSG_CTL *pmctl)
	Check if a device supports a firmware update via TLV. More...

int	mbgextio_dev_supp_tlv_diag_file (const MBG_MSG_CTL *pmctl)
	Check if a device supports creating / sending a diagnostics file via TLV. More...

int	mbgextio_dev_supp_tlv_ptpv2_license (const MBG_MSG_CTL *pmctl)
	Check if a device supports upports PTPv2 license infos. More...

int	mbgextio_dev_supp_tlv_ptpv1_license (const MBG_MSG_CTL *pmctl)
	Check if a device supports supports PTPv1 License Infos via TLV. More...

int	mbgextio_dev_supp_tlv_ntp_license (const MBG_MSG_CTL *pmctl)
	Check if a device supports supports NTP license infos via TLV. More...

int	mbgextio_dev_supp_tlv_time_monitor_license (const MBG_MSG_CTL *pmctl)
	Check if a device supports supportsTime Monitor License infos via TLV. More...

int	mbgextio_dev_supp_tlv_ufu (const MBG_MSG_CTL *pmctl)
	Check if a device supports a UFU (Unified Firmware Update) via TLV. More...

int	mbgextio_dev_has_cmd_save_cfg (const MBG_MSG_CTL *pmctl)
	Check if a device supports the GPS_SAVE_CFG command. More...

int	mbgextio_dev_has_monitoring (const MBG_MSG_CTL *pmctl)
	Check if a device supports the extended feature monitoring. More...

int	mbgextio_dev_has_led_api (const MBG_MSG_CTL *pmctl)
	Check if a device supports the LED API. More...

int	mbgextio_dev_has_lne_api (const MBG_MSG_CTL *pmctl)
	Check if a device supports the LNE API. More...

int	mbgextio_dev_has_pwr_ctl_api (const MBG_MSG_CTL *pmctl)
	Check if a device supports the power control API. More...

int	mbgextio_dev_has_ext_sys_info (const MBG_MSG_CTL *pmctl)
	Check if a device has MBG_XFEATURE_EXT_SYS_INFO. More...

int	mbgextio_dev_has_transactions (const MBG_MSG_CTL *pmctl)
	Check if a device has MBG_XFEATURE_TRANSACTIONS. More...

int	mbgextio_dev_has_reboot (const MBG_MSG_CTL *pmctl)
	Check if a device has MBG_XFEATURE_REBOOT. More...

int	mbgextio_dev_has_req_ttm (const MBG_MSG_CTL *pmctl)
	Check if a device has MBG_XFEATURE_REQ_TTM. More...

int	mbgextio_dev_has_xmulti_ref (const MBG_MSG_CTL *pmctl)
	Check if a device supports the up-to-date extended multi ref API. More...

int	mbgextio_dev_has_xbp (const MBG_MSG_CTL *pmctl)
	Check if a device supports the extended binary protocl (XBP) feature. More...

int	mbgextio_dev_has_database (const MBG_MSG_CTL *pmctl)
	Check if a device supports database(s) feature. More...

int	mbgextio_dev_has_gnss_mode (const MBG_MSG_CTL *pmctl)
	Check if a device supports GNSS mode feature All GNSS receivers support this feature by default, this is for GPS-only devices. More...

int	mbgextio_rcv_msg_unlocked (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, GPS_CMD cmd, void *buf, size_t buf_size)
	Generic reception of a binary message. More...

int	mbgextio_rcv_msg (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, GPS_CMD cmd, void *buf, size_t buf_size)
	Generic reception of a binary message. More...

int	mbgextio_xmt_msg (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, GPS_CMD cmd, const void *p, uint16_t n_bytes)
	Set up and send a generic binary message. More...

int	mbgextio_xmt_cmd (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, GPS_CMD cmd)
	Transmit a command-only message without additional data. More...

int	mbgextio_xmt_cmd_us (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, GPS_CMD cmd, uint16_t us)
	Transmit a message with a single ushort (uint16_t) parameter. More...

int	mbgextio_xmt_cmd_u32 (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, GPS_CMD cmd, uint32_t u32)
	Transmit a message with a single ushort (uint32_t) parameter. More...

int	mbgextio_req_data (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, GPS_CMD cmd, void *buf, size_t buf_size)
	Transmit a message without a single ushort (16 bit) parameter. More...

int	mbgextio_req_data_idx_unlocked (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, GPS_CMD cmd, uint16_t idx, void *buf, size_t buf_size)
	Read a specific element of an array of data structures. More...

int	mbgextio_req_data_idx (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, GPS_CMD cmd, uint16_t idx, void *buf, size_t buf_size)
	Read a specific element of an array of data structures. More...

int	mbgextio_get_receiver_info (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, RECEIVER_INFO *p)
	Read a receiver info structure. More...

int	mbgextio_get_io_port_limits (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, MBG_IO_PORT_LIMITS *p)
	Read I/O port limits in MBG_IO_PORT_LIMITS format. More...

int	mbgextio_set_io_port_settings_idx (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, const MBG_IO_PORT_SETTINGS *p, uint8_t idx)
	Send I/O port settings in MBG_IO_PORT_SETTINGS format. More...

int	mbgextio_get_io_port_info_idx (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, MBG_IO_PORT_INFO_IDX *p, uint8_t idx)
	Read I/O port info in MBG_IO_PORT_INFO_IDX format. More...

int	mbgextio_get_io_port_type_info_idx (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, MBG_IO_PORT_TYPE_INFO_IDX *p, uint8_t port_idx, uint8_t port_type_idx)
	Read I/O port type info in MBG_IO_PORT_TYPE_INFO_IDX format. More...

int	mbgextio_get_io_port_status_idx (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, MBG_IO_PORT_STATUS_IDX *p, uint8_t idx)
	Read I/O port status in MBG_IO_PORT_STATUS_IDX format. More...

int	mbgextio_get_clk_res_info (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, MBG_CLK_RES_INFO *p)
	Read clk_res_info from device. More...

int	mbgextio_setup_receiver_info (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, RECEIVER_INFO *p)
	Setup a receiver info structure. More...

int	mbgextio_get_sw_rev (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, SW_REV *p)
	Read the software revision. More...

int	mbgextio_get_ignore_lock (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, IGNORE_LOCK *p)
	Read the status of ignore lock. More...

int	mbgextio_set_ignore_lock (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, const IGNORE_LOCK *p)
	Send the ignore lock configuration. More...

int	mbgextio_get_bvar_stat (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, BVAR_STAT *p)
	Read the status of buffered variables. More...

int	mbgextio_get_time (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, TTM *p)
	Read the current time as TTM strucure. More...

int	mbgextio_set_time (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, const TTM *p)
	Set the device's time by sending a TTM strucure. More...

int	mbgextio_set_pos_lla (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, const LLA lla)
	Set the device's position by sending an LLA array. More...

int	mbgextio_get_pos_lla (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, LLA lla)
	Read the current receiver position as LLA array. More...

int	mbgextio_get_pos_xyz (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, XYZ xyz)
	Read the current receiver position as XYZ array. More...

int	mbgextio_get_pos (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, POS *p_pos)
	Read the current receiver position as POS structure. More...

int	mbgextio_get_tzdl (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, TZDL *p)
	Read the local time conversion parameters in TZDL format. More...

int	mbgextio_set_tzdl (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, const TZDL *p)
	Set the local time conversion parameters in TZDL format. More...

int	mbgextio_get_port_parm (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, PORT_PARM *p)
	Read serial port parameters in PORT_PARM format. More...

int	mbgextio_set_port_parm (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, const PORT_PARM *p)
	Send serial port parameters in PORT_PARM format. More...

int	mbgextio_get_synth (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, SYNTH *p)
	Read the frequency synthesizer settings. More...

int	mbgextio_set_synth (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, const SYNTH *p)
	Write the frequency synthesizer settings. More...

int	mbgextio_get_ant_info (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, ANT_INFO *p)
	Read the GPS antenna info structure. More...

int	mbgextio_get_ucap (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, TTM *p)
	Read a user capture event in TTM format. More...

int	mbgextio_get_ucap_net_glb_info (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, MBG_UCAP_NET_GLB_INFO *p)
	Read the user capture network global info in MBG_UCAP_NET_GLB_INFO format. More...

int	mbgextio_set_ucap_net_glb_settings (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, const MBG_UCAP_NET_GLB_SETTINGS *p)
	Send the user capture network global configuration in MBG_UCAP_NET_GLB_SETTINGS format. More...

int	mbgextio_get_ucap_net_recv_info_idx (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, MBG_UCAP_NET_RECV_INFO_IDX *p, uint16_t idx)
	Read the user capture network receiver info with the given index in MBG_UCAP_NET_RECV_INFO_IDX format. More...

int	mbgextio_set_ucap_net_recv_settings_idx (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, const MBG_UCAP_NET_RECV_SETTINGS_IDX *p, uint16_t idx)
	Send the user capture network receiver configuration with the given index in MBG_UCAP_NET_RECV_SETTINGS_IDX format. More...

int	mbgextio_get_user_mngmnt_info (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, MBG_USER_MNGMNT_INFO *p)
	Read the user management info in MBG_USER_MNGMNT_INFO format. More...

int	mbgextio_set_user_mngmnt_settings (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, const MBG_USER_MNGMNT_SETTINGS *p)
	Send the user configuration in MBG_USER_MNGMNT_SETTINGS format. More...

int	mbgextio_get_user_info_idx (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, MBG_USER_INFO_IDX *p, uint16_t idx)
	Read the user info with the given index in MBG_USER_INFO_IDX format. More...

int	mbgextio_set_user_settings_idx (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, const MBG_USER_SETTINGS *p, uint16_t idx)
	Write user settings in MBG_USER_SETTINGS_IDX format. More...

int	mbgextio_get_user_level_info_idx (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, MBG_USER_INFO_IDX *p, uint16_t idx)
	Read the user level info with the given index in MBG_USER_INFO_IDX format. More...

int	mbgextio_set_user_level_settings_idx (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, const MBG_USER_SETTINGS *p, uint16_t idx)
	Write user level settings in MBG_USER_SETTINGS_IDX format. More...

int	mbgextio_get_user_status_idx (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, MBG_USER_STATUS_IDX *p, uint16_t idx)
	Read the user status with the given index in MBG_USER_STATUS_IDX format. More...

int	mbgextio_get_enable_flags (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, ENABLE_FLAGS *p)
	Read the enable flags controlling when output signals are enabled. More...

int	mbgextio_set_enable_flags (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, const ENABLE_FLAGS *p)
	Send the enable flags controlling when output signals are enabled. More...

int	mbgextio_get_gps_stat_info (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, STAT_INFO *p)
	Read GPS status info. More...

int	mbgextio_get_ant_cable_len (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, ANT_CABLE_LEN *p)
	Read the configured length of the antenna cable. More...

int	mbgextio_set_ant_cable_len (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, const ANT_CABLE_LEN *p)
	Send the GPS antenna cable length configuration. More...

int	mbgextio_get_irig_tx_info (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, IRIG_INFO *p)
	Read configuration info and supported features of the device's IRIG output. More...

int	mbgextio_set_irig_tx_settings (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, const IRIG_SETTINGS *p)
	Send new configuration settings for the device's IRIG output. More...

int	mbgextio_get_irig_rx_info (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, IRIG_INFO *p)
	Read configuration info and supported features for the device's IRIG input. More...

int	mbgextio_set_irig_rx_settings (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, const IRIG_SETTINGS *p)
	Send new configuration settings for the device's IRIG input. More...

int	mbgextio_get_raw_irig_data (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, MBG_RAW_IRIG_DATA *p)
	Read raw IRIG data. More...

int	mbgextio_get_ref_offs (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, MBG_REF_OFFS *p)
	Read current ref offset to UTC configuration. More...

int	mbgextio_set_ref_offs (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, const MBG_REF_OFFS *p)
	Send new ref offset to UTC settings. More...

int	mbgextio_get_debug_status (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, MBG_DEBUG_STATUS *p)
	Read current debug status. More...

int	mbgextio_get_opt_info (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, MBG_OPT_INFO *p)
	Read current optional settings and supported options. More...

int	mbgextio_set_opt_settings (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, const MBG_OPT_SETTINGS *p)
	Send new optional settings flags. More...

int	mbgextio_get_str_type_info_idx (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, STR_TYPE_INFO_IDX *p, uint16_t idx)
	Read information on a specific supported string format. More...

int	mbgextio_get_all_str_type_info (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, STR_TYPE_INFO_IDX stii[])
	Read an array of all supported string types. More...

int	mbgextio_get_port_info_idx (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, PORT_INFO_IDX *p, uint16_t idx)
	Read current settings and capabilities of a specific serial port. More...

int	mbgextio_get_all_port_info (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, PORT_INFO_IDX pii[])
	Read an array of current settings and capabilities of all serial ports. More...

int	mbgextio_set_port_settings_idx (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, const PORT_SETTINGS *p, uint16_t idx)
	Send configuration settings for a specific serial port. More...

int	mbgextio_get_pout_info_idx (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, POUT_INFO_IDX *p, uint16_t idx)
	Read current settings and capabilities of a specific programmable pulse output. More...

int	mbgextio_get_all_pout_info (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, POUT_INFO_IDX *pii)
	Read an array of current settings and capabilities of all programmable pulse outputs. More...

int	mbgextio_set_pout_settings_idx (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, const POUT_SETTINGS *p, uint16_t idx)
	Send configuration settings for a specific programmable pulse output. More...

int	mbgextio_set_gpio_settings_idx (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, const MBG_GPIO_SETTINGS *p, uint16_t idx)
	Send configuration settings for a specific GPIO. More...

int	mbgextio_clr_ucap_buff (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr)
	Clear the user capture event buffer on-board the device. More...

int	mbgextio_get_time_scale_info (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, MBG_TIME_SCALE_INFO *p)
	Read time scale configuration parameters. More...

int	mbgextio_set_time_scale_settings (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, const MBG_TIME_SCALE_SETTINGS *p)
	Send new time scale configuration settings. More...

int	mbgextio_clr_evt_log (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr)
	Clear the on-board event log. More...

int	mbgextio_get_num_evt_log_entries (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, MBG_NUM_EVT_LOG_ENTRIES *p)
	Read the current number of entries in the on-board event log. More...

int	mbgextio_get_first_evt_log_entry (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, MBG_EVT_LOG_ENTRY *p)
	Return the first entry from the on-board event log. More...

int	mbgextio_get_next_evt_log_entry (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, MBG_EVT_LOG_ENTRY *p)
	Return the next entry from the on-board event log. More...

int	mbgextio_get_ims_state (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, MBG_IMS_STATE *p)
	Read the current IMS state and supported IMS features. More...

int	mbgextio_get_ims_sensor_state_idx (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, MBG_IMS_SENSOR_STATE_IDX *p, uint16_t idx)
	Read sensor values from a specified sensor on the device. More...

int	mbgextio_set_holdover_interval (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, const XMR_HOLDOVER_INTV *p)
	Set the XMR holdover interval. More...

int	mbgextio_get_holdover_interval_counter (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, XMR_HOLDOVER_INTV *p)
	Read the XMR holdover interval counter. More...

int	mbgextio_get_xmulti_ref_info_idx (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, XMULTI_REF_INFO_IDX *p)
	Read the multi ref info from a device. More...

int	mbgextio_get_tzcode (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, TZCODE *p)
	Read the local time conversion configuration in TZCODE format. More...

int	mbgextio_set_tzcode (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, const TZCODE *p)
	Set the local time conversion configuration in TZCODE format. More...

int	mbgextio_set_hq_tx_settings (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, const HAVEQUICK_SETTINGS *p)
	Send new configuration settings for the device's HAVEQUICK output. More...

int	mbgextio_set_hq_rx_settings (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, const HAVEQUICK_SETTINGS *p)
	Send new configuration settings for the device's HAVEQUICK input. More...

int	mbgextio_get_tr_distance (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, TR_DISTANCE *p)
	Read the distance from transmitter TR_DISTANCE format. More...

int	mbgextio_set_tr_distance (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, const TR_DISTANCE *p)
	Set the transmitter distance (km) in TR_DISTANCE format. More...

int	mbgextio_get_gnss_mode_info (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, MBG_GNSS_MODE_INFO *p)
	Read current GNSS mode settings and supported features. More...

int	mbgextio_set_gnss_mode_settings (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, const MBG_GNSS_MODE_SETTINGS *p)
	Write GNSS mode settings. More...

int	mbgextio_get_gnss_sat_info (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, GNSS_SAT_INFO *p)
	::TODO More...

int	mbgextio_get_gnss_sat_info_idx (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, GNSS_SAT_INFO_IDX *p, uint16_t idx)
	::TODO More...

int	mbgextio_get_all_gnss_sat_info (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, GNSS_SAT_INFO_IDX gsii[], const MBG_GNSS_MODE_INFO *p_mi)
	::TODO Read an array of all supported string types More...

int	mbgextio_get_gnss_sv_status_idx (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, GNSS_SV_STATUS_IDX *p, uint16_t idx)
	::TODO More...

int	mbgextio_get_xmr_instances (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, XMULTI_REF_INSTANCES *p)
	Read XMULTI_REF_INSTANCES. More...

int	mbgextio_get_xmr_ext_src_info_idx (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, XMR_EXT_SRC_INFO_IDX *p, uint16_t idx)
	Read XMR_EXT_SRC_INFO_IDX. More...

int	mbgextio_get_xmr_holdover_status (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, XMR_HOLDOVER_STATUS *p)
	Read XMR_HOLDOVER_STATUS. More...

int	mbgextio_get_xmr_info_idx (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, XMULTI_REF_INFO_IDX *p, uint16_t idx)
	Read XMULTI_REF_INFO_IDX for a specific XMR source. More...

int	mbgextio_get_xmr_status_idx (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, XMULTI_REF_STATUS_IDX *p, uint16_t idx)
	Read XMULTI_REF_STATUS_IDX for a specific XMR source. More...

int	mbgextio_get_xmr_ext_source_stats_idx (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, XMR_STATS_IDX *p, uint16_t idx)
	Read XMR_STATS_IDX for a specific XMR source. More...

int	mbgextio_get_xmr_ext_source_metrics_idx (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, XMR_METRICS_IDX *p, uint16_t idx)
	Read XMR_METRICS_IDX for a specific XMR source. More...

int	mbgextio_set_xmr_settings_idx (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, const XMULTI_REF_SETTINGS *p, uint16_t idx)
	Set XMULTI_REF_SETTINGS for a specific XMR source. More...

int	mbgextio_get_lan_if_info (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, LAN_IF_INFO *p)
	Read the lan interface configuration LAN_IF_INFO format. More...

int	mbgextio_get_ip4_settings (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, IP4_SETTINGS *p)
	Read the lan ipv4 configuration state IP4_SETTINGS format. More...

int	mbgextio_set_ip4_settings (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, const IP4_SETTINGS *p)
	Save the current ipv4 settings IP4_SETTINGS format. More...

int	mbgextio_get_ip4_state (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, IP4_SETTINGS *p)
	Read the current lan ipv4 state IP4_SETTINGS format. More...

int	mbgextio_get_ptp_state (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, PTP_STATE *p)
	Read the current state of PTP device PTP_STATE format. More...

int	mbgextio_get_ptp_cfg_info (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, PTP_CFG_INFO *p)
	Read the ptp configuration PTP_CFG_INFO format. More...

int	mbgextio_get_ptp_uc_master_cfg_limits (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, PTP_UC_MASTER_CFG_LIMITS *p)
	Read the ptp configuration PTP_UC_MASTER_CFG_LIMITS format. More...

int	mbgextio_get_all_ptp_uc_master_info (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, PTP_UC_MASTER_INFO_IDX ptp_uc_master_info_idx, const PTP_UC_MASTER_CFG_LIMITS ptp_uc_master_cfg_limits)
	Read the ptp configuration ALL_PTP_UC_MASTER_INFO_IDX format. More...

int	mbgextio_set_ptp_cfg_settings (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, const PTP_CFG_SETTINGS *p)
	Send configuration settings for PTP. More...

int	mbgextio_set_ptp_uc_master_settings_idx (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, const PTP_UC_MASTER_SETTINGS *p, uint16_t idx)
	Send PTP unicast master configuration settings for a PTP unicast slave mode device. More...

int	mbgextio_get_ptp_v1_default_dataset (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, MBG_PTP_V1_DEFAULT_DATASET *p)
	Read the PTPv1 default dataset in MBG_PTP_V1_DEFAULT_DATASET format. More...

int	mbgextio_set_ptp_v1_default_dataset (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, const MBG_PTP_V1_DEFAULT_DATASET *p)
	Send PTPv1 default dataset to a device in MBG_PTP_V1_DEFAULT_DATASET format. More...

int	mbgextio_get_ptp_v1_current_dataset (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, MBG_PTP_V1_CURRENT_DATASET *p)
	Read the PTPv1 current dataset in MBG_PTP_V1_CURRENT_DATASET format. More...

int	mbgextio_set_ptp_v1_current_dataset (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, const MBG_PTP_V1_CURRENT_DATASET *p)
	Send PTPv1 current dataset to a device in MBG_PTP_V1_CURRENT_DATASET format. More...

int	mbgextio_get_ptp_v1_parent_dataset (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, MBG_PTP_V1_PARENT_DATASET *p)
	Read the PTPv1 parent dataset in MBG_PTP_V1_PARENT_DATASET format. More...

int	mbgextio_set_ptp_v1_parent_dataset (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, const MBG_PTP_V1_PARENT_DATASET *p)
	Send PTPv1 parent dataset to a device in MBG_PTP_V1_PARENT_DATASET format. More...

int	mbgextio_get_ptp_v1_time_properties_dataset (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, MBG_PTP_V1_TIME_PROPERTIES_DATASET *p)
	Read the PTPv1 time properties dataset in MBG_PTP_V1_TIME_PROPERTIES_DATASET format. More...

int	mbgextio_set_ptp_v1_time_properties_dataset (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, const MBG_PTP_V1_TIME_PROPERTIES_DATASET *p)
	Send PTPv1 time properties dataset to a device in MBG_PTP_V1_TIME_PROPERTIES_DATASET format. More...

int	mbgextio_get_ptp_v1_port_dataset_idx (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, MBG_PTP_V1_PORT_DATASET_IDX *p, uint16_t idx)
	Read the PTPv1 port dataset with the appropriate index in MBG_PTP_V1_PORT_DATASET_IDX format. More...

int	mbgextio_set_ptp_v1_port_dataset_idx (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, const MBG_PTP_V1_PORT_DATASET *p, uint16_t idx)
	Send PTPv1 port dataset with the appropriate index to a device in MBG_PTP_V1_PORT_DATASET format. More...

int	mbgextio_get_ptp_v2_default_dataset (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, MBG_PTP_V2_DEFAULT_DATASET *p)
	Read the PTPv2 default dataset in MBG_PTP_V2_DEFAULT_DATASET format. More...

int	mbgextio_set_ptp_v2_default_dataset (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, const MBG_PTP_V2_DEFAULT_DATASET *p)
	Send PTPv2 default dataset to a device in MBG_PTP_V2_DEFAULT_DATASET format. More...

int	mbgextio_get_ptp_v2_current_dataset (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, MBG_PTP_V2_CURRENT_DATASET *p)
	Read the PTPv2 current dataset in MBG_PTP_V2_CURRENT_DATASET format. More...

int	mbgextio_set_ptp_v2_current_dataset (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, const MBG_PTP_V2_CURRENT_DATASET *p)
	Send PTPv2 current dataset to a device in MBG_PTP_V2_CURRENT_DATASET format. More...

int	mbgextio_get_ptp_v2_parent_dataset (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, MBG_PTP_V2_PARENT_DATASET *p)
	Read the PTPv2 parent dataset in MBG_PTP_V2_PARENT_DATASET format. More...

int	mbgextio_set_ptp_v2_parent_dataset (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, const MBG_PTP_V2_PARENT_DATASET *p)
	Send PTPv2 parent dataset to a device in MBG_PTP_V2_PARENT_DATASET format. More...

int	mbgextio_get_ptp_v2_time_properties_dataset (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, MBG_PTP_V2_TIME_PROPERTIES_DATASET *p)
	Read the PTPv2 time properties dataset in MBG_PTP_V2_TIME_PROPERTIES_DATASET format. More...

int	mbgextio_set_ptp_v2_time_properties_dataset (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, const MBG_PTP_V2_TIME_PROPERTIES_DATASET *p)
	Send PTPv2 time properties dataset to a device in MBG_PTP_V2_TIME_PROPERTIES_DATASET format. More...

int	mbgextio_get_ptp_v2_port_dataset_idx (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, MBG_PTP_V2_PORT_DATASET_IDX *p, uint16_t idx)
	Read the PTPv2 port dataset with the appropriate index in MBG_PTP_V2_PORT_DATASET_IDX format. More...

int	mbgextio_set_ptp_v2_port_dataset_idx (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, const MBG_PTP_V2_PORT_DATASET *p, uint16_t idx)
	Send PTPv2 port dataset with the appropriate index to a device in MBG_PTP_V2_PORT_DATASET format. More...

int	mbgextio_get_ptp_smpte_tlv_state (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, PTP_SMPTE_PROFILE_CFG *p)
	Read the current SMPTE TLV. More...

int	mbgextio_get_monitoring_limits (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, MBG_MONITORING_LIMITS *p)
	Read the monitoring limits in MBG_MONITORING_LIMITS format. More...

int	mbgextio_get_snmp_glb_info (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, MBG_SNMP_GLB_INFO *p)
	Read the SNMP global info in MBG_SNMP_GLB_INFO format. More...

int	mbgextio_set_snmp_glb_settings (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, const MBG_SNMP_GLB_SETTINGS *p)
	Send the SNMP global settings in MBG_SNMP_GLB_SETTINGS format. More...

int	mbgextio_get_snmp_v12_info_idx (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, MBG_SNMP_V12_INFO_IDX *p, uint16_t idx)
	Read SNMP v1 or v2 info in MBG_SNMP_V12_INFO_IDX format. More...

int	mbgextio_set_snmp_v12_settings_idx (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, const MBG_SNMP_V12_SETTINGS *p, uint16_t idx)
	Write SNMP v1 or v2 settings in MBG_SNMP_V12_SETTINGS format. More...

int	mbgextio_get_snmp_v12_trap_info_idx (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, MBG_SNMP_V12_TRAP_INFO_IDX *p, uint16_t idx)
	Read SNMP v1 or v2 trap info in MBG_SNMP_V12_TRAP_INFO_IDX format. More...

int	mbgextio_set_snmp_v12_trap_settings_idx (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, const MBG_SNMP_V12_TRAP_SETTINGS *p, uint16_t idx)
	Write SNMP v1 or v2 trap settings in MBG_SNMP_V12_TRAP_SETTINGS format. More...

int	mbgextio_get_snmp_v3_info_idx (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, MBG_SNMP_V3_INFO_IDX *p, uint16_t idx)
	Read SNMP v3 info in MBG_SNMP_V3_INFO_IDX format. More...

int	mbgextio_set_snmp_v3_settings_idx (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, const MBG_SNMP_V3_SETTINGS *p, uint16_t idx)
	Write SNMP v3 settings in MBG_SNMP_V3_SETTINGS format. More...

int	mbgextio_get_snmp_v3_trap_info_idx (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, MBG_SNMP_V3_TRAP_INFO_IDX *p, uint16_t idx)
	Read SNMP v3 trap info in MBG_SNMP_V3_TRAP_INFO_IDX format. More...

int	mbgextio_set_snmp_v3_trap_settings_idx (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, const MBG_SNMP_V3_TRAP_SETTINGS *p, uint16_t idx)
	Write SNMP v3 trap settings in MBG_SNMP_V3_TRAP_SETTINGS format. More...

int	mbgextio_get_event_info_idx (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, MBG_EVENT_INFO_IDX *p, uint16_t idx)
	Read monitoring event info in MBG_EVENT_INFO_IDX format. More...

int	mbgextio_set_event_settings_idx (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, const MBG_EVENT_SETTINGS *p, uint16_t idx)
	Write monitoring event settings in MBG_EVENT_SETTINGS format. More...

int	mbgextio_get_event_status_idx (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, uint8_t vtype, MBG_EVENT_STATUS_IDX *p, uint16_t idx)
	Read monitoring event status in MBG_EVENT_STATUS_IDX format. More...

int	mbgextio_get_event_value_idx (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, uint16_t eidx, uint8_t vtype, MBG_EVENT_VALUE_IDX *p, uint16_t vidx)
	Read monitoring event status in MBG_EVENT_STATUS_IDX format. More...

int	mbgextio_get_syslog_glb_info (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, MBG_SYSLOG_GLB_INFO *p)
	Read the syslog global info in MBG_SYSLOG_GLB_INFO format. More...

int	mbgextio_set_syslog_glb_settings (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, const MBG_SYSLOG_GLB_SETTINGS *p)
	Send the syslog global settings in MBG_SYSLOG_GLB_SETTINGS format. More...

int	mbgextio_get_syslog_info_idx (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, MBG_SYSLOG_INFO_IDX *p, uint16_t idx)
	Read syslog server information in MBG_SYSLOG_INFO_IDX format. More...

int	mbgextio_set_syslog_settings_idx (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, const MBG_SYSLOG_SETTINGS *p, uint16_t idx)
	Write syslog server information in MBG_SYSLOG_SETTINGS_IDX format. More...

int	mbgextio_get_fw_glb_info (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, MBG_FW_GLB_INFO *p)
	Read the firmware global information in MBG_FW_GLB_INFO format. More...

int	mbgextio_get_fw_info_idx (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, MBG_FW_INFO_IDX *p, uint16_t idx)
	Read the firmware info with the given index in MBG_FW_INFO_IDX format. More...

int	mbgextio_set_active_fw (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, uint16_t idx)
	Activate the firmware with the given index. More...

int	mbgextio_delete_fw (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, uint16_t idx)
	Delete the firmware with the given index. More...

int	mbgextio_get_fw_ufu_info_idx (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, MBG_FW_UFU_INFO_IDX *p, uint8_t fw_idx, uint8_t ufu_idx)
	Read the firmware ufu info of the given firmware with the also given index in MBG_FW_UFU_INFO_IDX format. More...

int	mbgextio_fw_ufu_flash (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, const MBG_FW_UFU_FLASH_CMD *p)
	Send UFU flash instruction(s) More...

int	mbgextio_get_database_glb_info (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, MBG_DATABASE_GLB_INFO *p)
	Read global database information in MBG_DATABASE_GLB_INFO format. More...

int	mbgextio_get_database_info_idx (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, MBG_DATABASE_INFO_IDX *p, uint8_t idx)
	Read a database info with given index in MBG_DATABASE_INFO_IDX format. More...

int	mbgextio_set_database_settings_idx (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, const MBG_DATABASE_SETTINGS *p, uint8_t idx)
	Write database settings in MBG_DATABASE_SETTINGS_IDX format. More...

int	mbgextio_send_database_cmd (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, uint32_t cmd, const void *payload, uint32_t payload_len)
	Send a specific command to database in MBG_DATABASE_CMD format. More...

int	mbgextio_get_ntp_glb_info (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, NTP_GLB_INFO *p)
	Read the ntp global information NTP_GLB_INFO format. More...

int	mbgextio_set_ntp_glb_info (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, const NTP_GLB_SETTINGS *p)
	Send the NTP global configuration. More...

int	mbgextio_get_ntp_symm_key_limits (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, NTP_SYMM_KEY_LIMITS *p)
	Read the NTP symmetric key limits in NTP_SYMM_KEY_LIMITS format. More...

int	mbgextio_get_ntp_symm_key_info_idx (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, NTP_SYMM_KEY_INFO_IDX *p, uint16_t idx)
	Read the NTP symmetric key info with the given index in NTP_SYMM_KEY_INFO_IDX format. More...

int	mbgextio_set_ntp_symm_key_settings_idx (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, const NTP_SYMM_KEY_SETTINGS *p, uint16_t idx)
	Send NTP symmetric key settings with the given index in NTP_SYMM_KEY_SETTINGS format. More...

int	mbgextio_get_ntp_trusted_key_info_idx (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, NTP_TRUSTED_KEY_INFO_IDX *p, uint16_t idx)
	Read the NTP trusted key info with the given index in NTP_TRUSTED_KEY_INFO_IDX format. More...

int	mbgextio_set_ntp_trusted_key_settings_idx (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, const NTP_TRUSTED_KEY_SETTINGS *p, uint16_t idx)
	Send NTP trusted key settings with the given index in NTP_TRUSTED_KEY_SETTINGS format. More...

int	mbgextio_get_ntp_misc_limits (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, NTP_MISC_LIMITS *p)
	Read the NTP misc limits in NTP_MISC_LIMITS format. More...

int	mbgextio_get_ntp_misc_orphan_mode_info (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, NTP_MISC_ORPHAN_MODE_INFO *p)
	Read the NTP orphan mode information in NTP_MISC_ORPHAN_MODE_INFO format. More...

int	mbgextio_set_ntp_misc_orphan_mode_settings (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, const NTP_MISC_ORPHAN_MODE_SETTINGS *p)
	Send the NTP orphan mode configuration in NTP_MISC_ORPHAN_MODE_SETTINGS format. More...

int	mbgextio_get_ntp_clnt_mode_info (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, NTP_CLNT_MODE_INFO *p)
	Read the ntp global information NTP_CLNT_MODE_INFO format. More...

int	mbgextio_set_ntp_clnt_mode_cfg (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, const NTP_CLNT_MODE_SETTINGS *p)
	Send the NTP client mode configuration. More...

int	mbgextio_get_ntp_peer_settings_idx (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, NTP_PEER_SETTINGS_IDX *p, uint16_t idx)
	Read the ntp peer settings of current idx NTP_PEER_SETTINGS format. More...

int	mbgextio_set_ntp_peer_settings_idx (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, const NTP_PEER_SETTINGS *p, uint16_t idx)
	Send configuration settings for a specific NTP peer. More...

int	mbgextio_get_ntp_srv_mode_info (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, NTP_SRV_MODE_INFO *p)
	Read the ntp server mode information in NTP_SRV_MODE_INFO format. More...

int	mbgextio_set_ntp_srv_mode_cfg (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, const NTP_SRV_MODE_SETTINGS *p)
	Send the NTP server mode configuration. More...

int	mbgextio_get_ntp_refclk_cfg_info_idx (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, NTP_REFCLK_CFG_INFO_IDX *p, uint16_t idx)
	Read the NTP refclock config info with the given index in NTP_REFCLK_CFG_INFO_IDX format. More...

int	mbgextio_set_ntp_refclk_cfg_settings_idx (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, const NTP_REFCLK_CFG_SETTINGS *p, uint16_t idx)
	Send NTP refclk config settings with the given index in NTP_REFCLK_CFG_SETTINGS format. More...

int	mbgextio_get_ntp_sys_state (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, NTP_SYS_STATE *p)
	Read the current system state of ntp device NTP_SYS_STATE format. More...

int	mbgextio_get_ntp_peer_state_idx (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, NTP_PEER_STATE_IDX *p, uint16_t idx)
	Read the NTP peer state of current idx NTP_PEER_STATE format. More...

int	mbgextio_get_ntp_refclk_state_idx (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, NTP_REFCLK_STATE_IDX *p, uint16_t idx)
	Read the NTP refclock state of current idx in NTP_REFCLK_STATE format. More...

int	mbgextio_get_net_glb_cfg_info (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, MBG_NET_GLB_CFG_INFO *p)
	Read the network global config information MBG_NET_GLB_CFG_INFO format. More...

int	mbgextio_set_net_glb_cfg_settings (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, const MBG_NET_GLB_CFG_SETTINGS *p)
	Set the device's global network configuration settings. More...

int	mbgextio_get_net_dns_srvr_idx (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, MBG_IP_ADDR_IDX *p, uint16_t idx)
	Read a network DNS server entry in MBG_IP_ADDR_IDX format. More...

int	mbgextio_set_net_dns_srvr_idx (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, const MBG_IP_ADDR *p, uint16_t idx)
	Send the network DNS server address in MBG_IP_ADDR format. More...

int	mbgextio_get_net_dns_srch_dom_idx (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, MBG_NET_NAME_IDX *p, uint16_t idx)
	Read the network DNS search domain in MBG_NET_NAME_IDX format. More...

int	mbgextio_set_net_dns_srch_dom_idx (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, const MBG_NET_NAME *p, uint16_t idx)
	Send the network DNS search domain in MBG_NET_NAME format. More...

int	mbgextio_get_net_stat_dns_srvr_idx (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, MBG_IP_ADDR_IDX *p, uint16_t idx)
	Read the current network DNS server in MBG_IP_ADDR_IDX format. More...

int	mbgextio_get_net_stat_dns_srch_dom_stat_idx (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, MBG_NET_NAME_IDX *p, uint16_t idx)
	Read the current network DNS search domain in MBG_NET_NAME_IDX format. More...

int	mbgextio_get_net_intf_link_info_idx (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, MBG_NET_INTF_LINK_INFO_IDX *p, uint16_t idx)
	Read MBG_NET_INTF_LINK_INFO_IDX from the config with the given index. More...

int	mbgextio_set_net_intf_link_settings_idx (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, const MBG_NET_INTF_LINK_SETTINGS *p, uint16_t idx)
	Send the network link configuration in MBG_NET_INTF_LINK_SETTINGS format. More...

int	mbgextio_get_net_intf_addr_info_idx (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, MBG_NET_INTF_ADDR_INFO_IDX *p, uint16_t idx)
	Read MBG_NET_INTF_ADDR_INFO_IDX from the config with the given index. More...

int	mbgextio_set_net_intf_addr_settings_idx (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, const MBG_NET_INTF_ADDR_SETTINGS *p, uint16_t idx)
	Send the network addr configuration in MBG_NET_INTF_ADDR_SETTINGS format. More...

int	mbgextio_get_net_intf_route_info_idx (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, MBG_NET_INTF_ROUTE_INFO_IDX *p, uint16_t idx)
	Read MBG_NET_INTF_ROUTE_INFO_IDX from the config with the given index. More...

int	mbgextio_set_net_intf_route_settings_idx (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, const MBG_NET_INTF_ROUTE_SETTINGS *p, uint16_t idx)
	Send the network addr configuration in MBG_NET_INTF_ROUTE_SETTINGS format. More...

int	mbgextio_get_net_stat_glb_cfg_info (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, MBG_NET_GLB_CFG_INFO *p)
	Read the network global status information MBG_NET_GLB_CFG_INFO format. More...

int	mbgextio_get_net_stat_intf_link_info_idx (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, MBG_NET_INTF_LINK_INFO_IDX *p, uint16_t idx)
	Read MBG_NET_INTF_LINK_INFO_IDX from the status with the given index. More...

int	mbgextio_get_net_stat_intf_addr_info_idx (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, MBG_NET_INTF_ADDR_INFO_IDX *p, uint16_t idx)
	Read MBG_NET_INTF_ADDR_INFO_IDX from the status with the given index. More...

int	mbgextio_get_net_stat_intf_route_info_idx (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, MBG_NET_INTF_ROUTE_INFO_IDX *p, uint16_t idx)
	Read MBG_NET_INTF_ROUTE_INFO_IDX from the status with the given index. More...

int	mbgextio_get_xbp_limits (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, XBP_LIMITS *p)
	Read the XBP_LIMITS to check which XBP features are supported. More...

int	mbgextio_get_xbp_node_limits (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, XBP_NODE_LIMITS *p)
	Read the XBP_NODE_LIMITS to check how many ports are provided. More...

int	mbgextio_get_xbp_node_info_idx (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, XBP_NODE_INFO_IDX *p, uint16_t idx)
	Read the XBP_NODE_INFO for a specific node in XBP_NODE_INFO_IDX format. More...

int	mbgextio_setup_xbp_node_list (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr)
	Read the XBP_NODE_INFO for a specific node in XBP_NODE_INFO_IDX format //##+++++++++++++++++++++++++. More...

int	mbgextio_get_cfgh (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, CFGH *p)
	Read configuration and health data of all satellites from a device. More...

int	mbgextio_get_sv_alm (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, SV_ALM *p, SVNO svno)
	Read the GPS almanach for the specified SV from a device. More...

int	mbgextio_get_iono (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, IONO *p)
	Read the ionospheric correction parameters from a device. More...

int	mbgextio_get_utc_parm (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, UTC *p)
	Read a UTC parameter structure from a device. More...

int	mbgextio_set_utc_parm (MBG_MSG_CTL pmctl, XBP_ADDR p_addr, const UTC *p)
	Write a UTC parameter structure to a device. More...

int	mbgextio_get_scu_stat_info (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, SCU_STAT_INFO *p)
	Read SCU_STAT_INFO from the device. More...

int	mbgextio_set_scu_stat_settings (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, const SCU_STAT_SETTINGS *p)
	Send SCU_STAT_SETTINGS to the device. More...

int	mbgextio_time_mon_get_inst_info (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, MBG_TIME_MON_INST_INFO *p)

int	mbgextio_time_mon_send_inst_info (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, const MBG_TIME_MON_INST_INFO *p)

int	mbgextio_time_mon_send_target_settings (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, const MBG_TIME_MON_TARGET_SETTINGS *p)

int	mbgextio_time_mon_get_target_status_idx (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, MBG_TIME_MON_TARGET_STATUS_IDX *p, uint16_t idx)

int	mbgextio_time_mon_get_target_ext_data_set_idx (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, MBG_TIME_MON_TARGET_EXT_DATA_SET_IDX *p, uint16_t idx)

int	mbgextio_get_fdm_freq (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, MBG_GPIO_FREQ *p)
	Read a MBG_GPIO_FREQ parameter structure from a device. More...

int	mbgextio_get_ims_fdm_info (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, MBG_IMS_FDM_INFO *p)
	Read a MBG_IMS_FDM_INFO parameter structure from a device. More...

int	mbgextio_get_ims_fdm_limits (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, MBG_IMS_FDM_LIMITS *p)
	Read a MBG_IMS_FDM_LIMITS parameter structure from a device. More...

int	mbgextio_get_ims_fdm_output_info_idx (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, MBG_IMS_FDM_OUTPUT_INFO_IDX *p, uint16_t idx)
	Read a MBG_IMS_FDM_OUTPUT_INFO_IDX parameter structure from a device. More...

int	mbgextio_get_ims_fdm_output_state_idx (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, MBG_IMS_FDM_OUTPUT_STATE_IDX *p, uint16_t idx)
	Read a MBG_IMS_FDM_OUTPUT_STATE_IDX parameter structure from a device. More...

int	mbgextio_get_ims_fdm_state (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, MBG_IMS_FDM_STATE *p)
	Read a MBG_IMS_FDM_STATE parameter structure from a device. More...

int	mbgextio_set_ims_fdm_settings (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, const MBG_IMS_FDM_SETTINGS *p)
	Write a MBG_IMS_FDM_SETTINGS parameter structure to a device. More...

int	mbgextio_set_ims_fdm_output_settings_idx (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, const MBG_IMS_FDM_OUTPUT_SETTINGS *p, uint16_t idx)
	Write a MBG_IMS_FDM_OUTPUT_SETTINGS parameter structure to a device. More...

int	mbgextio_set_fdm_tdev (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, const NANO_TIME_64 *p)
	Set time deviation of powerline time in relation to the current reference time. More...

int	mbgextio_cmd_save_cfg (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr)
	Send a command to let the device save it's current configuration as default. More...

int	mbgextio_get_lne_limits (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, MBG_LNE_LIMITS *p)
	Read a MBG_IMS_FDM_STATE parameter structure from a device. ::TODO ###. More...

int	mbgextio_get_lne_port_info_idx (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, MBG_LNE_PORT_INFO_IDX *p, uint16_t idx)
	Read a MBG_LNE_PORT_INFO_IDX parameter structure from a device. More...

int	mbgextio_get_lne_port_settings_idx (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, MBG_LNE_PORT_SETTINGS_IDX *p, uint16_t idx)
	Read a MBG_LNE_PORT_SETTINGS_IDX parameter structure from a device. More...

int	mbgextio_set_lne_port_settings_idx (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, const MBG_LNE_PORT_SETTINGS *p, uint16_t idx)
	Write a MBG_LNE_PORT_SETTINGS parameter structure to a device. More...

int	mbgextio_set_pwr_ctl (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, const MBG_PWR_CTL *p)
	Write a MBG_PWR_CTL parameter structure to a device. More...

int	mbgextio_get_pwr_ctl (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, MBG_PWR_CTL *p)
	Read a MBG_PWR_CTL parameter structure from a device. More...

int	mbgextio_get_led_limits (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, MBG_LED_LIMITS *p)
	Read the MBG_LED_LIMITS to check how many LEDs are provided. More...

int	mbgextio_get_led_info_idx (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, MBG_LED_INFO_IDX *p, uint16_t idx)
	Read the current settings and features of a particular LED. More...

int	mbgextio_get_led_settings_idx (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, MBG_LED_SETTINGS_IDX *p, uint16_t idx)
	Read a MBG_LED_SETTINGS_IDX parameter structure from a device. More...

int	mbgextio_set_led_settings_idx (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, const MBG_LED_SETTINGS *p, uint16_t idx)
	Write a MBG_LED_SETTINGS parameter structure to a device. More...

int	mbgextio_get_tainted_cfg (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, MBG_TAINTED_CFG *p)
	Read MBG_TAINTED_CFG structure from a device. More...

int	mbgextio_register_push_msg (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, GPS_CMD cmd)
	Register for command specific push messages. More...

int	mbgextio_unregister_push_msg (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, GPS_CMD cmd)
	Unregister for command specific push messages. More...

int	mbgextio_get_ext_sys_info (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, MBG_EXT_SYS_INFO *p)

int	mbgextio_get_corr_info (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, CORR_INFO *p)

int	mbgextio_chk_user_perm (MBG_MSG_CTL *pmctl, uint16_t perm, uint32_t scope_mask)
	Check user permission for one of the given scopes. More...

int	mbgextio_get_svc_mgmt_info (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, MBG_SERVICE_MGMT_INFO *p)
	Read service management info in MBG_SERVICE_MGMT_INFO format. More...

int	mbgextio_get_svc_info_idx (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, MBG_SERVICE_INFO_IDX *p, uint16_t idx)
	Read the service info with the given index in MBG_SERVICE_INFO_IDX format. More...

int	mbgextio_set_svc_settings_idx (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, const MBG_SERVICE_SETTINGS *p, uint16_t idx)
	Write service settings in MBG_SERVICE_SETTINGS_IDX format. More...

int	mbgextio_get_svc_status_idx (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, MBG_SERVICE_STATUS_IDX *p, uint16_t idx)
	Read the service status with the given index in MBG_SERVICE_STATUS_IDX format. More...

int	mbgextio_set_svc_ctl_idx (MBG_MSG_CTL pmctl, const XBP_ADDR p_addr, uint16_t idx, uint16_t ctl)
	Set service control command. More...

Variables
uint32_t	mbg_baud_rates [N_MBG_BAUD_RATES]

const char *	mbg_baud_rate_strs [N_MBG_BAUD_RATES]

const char *	mbg_framing_strs [N_MBG_FRAMINGS]

Macro Definition Documentation

◆ _ext

#define _ext extern

Definition at line 412 of file mbgextio.h.

◆ _MBGEXTIO_REQ_ACK

#define _MBGEXTIO_REQ_ACK 1

Definition at line 460 of file mbgextio.h.

◆ _mbgextio_xmt_msg

#define _mbgextio_xmt_msg	(	_pmctl,
		_addr,
		_cmd,
		_s
	)	mbgextio_xmt_msg( _pmctl, _addr, _cmd, _s, sizeof( *(_s) ) )

Definition at line 5863 of file mbgextio.h.

◆ _ttm_time_is_avail

#define _ttm_time_is_avail ( _t ) ( (uint8_t) (_t)->tm.sec != (uint8_t) 0xFF )

Definition at line 438 of file mbgextio.h.

◆ _ttm_time_set_unavail

#define _ttm_time_set_unavail ( _t ) do { (_t)->tm.sec = (uint8_t) 0xFF; } while ( 0 )

Definition at line 437 of file mbgextio.h.

Referenced by mbgextio_get_ucap().

◆ FT_HANDLE

#define FT_HANDLE int

Definition at line 444 of file mbgextio.h.

Referenced by dev_open_finish_setup(), and mbgextio_close_connection().

◆ FT_STATUS

#define FT_STATUS int

Definition at line 443 of file mbgextio.h.

◆ MBGEXTIO_READ_BUFFER_SIZE

#define MBGEXTIO_READ_BUFFER_SIZE (MAX_MSG_DATA_SIZE + 1)

Definition at line 475 of file mbgextio.h.

Referenced by mbgextio_rcv_msg_unlocked().

◆ OPT_GPS_ACK_CODE

#define OPT_GPS_ACK_CODE GPS_REQACK

Definition at line 464 of file mbgextio.h.

Typedef Documentation

◆ libusb_device

typedef int libusb_device

Definition at line 451 of file mbgextio.h.

◆ MBG_LAN_DEV_CFG

typedef int MBG_LAN_DEV_CFG

Definition at line 554 of file mbgextio.h.

◆ MBG_LAN_DEV_CHAN

typedef int MBG_LAN_DEV_CHAN

Definition at line 553 of file mbgextio.h.

◆ MBG_LAN_DEV_LIST

typedef int MBG_LAN_DEV_LIST

Definition at line 555 of file mbgextio.h.

◆ MBG_USB_DEV_INFO

typedef int MBG_USB_DEV_INFO

Definition at line 450 of file mbgextio.h.

◆ MBGEXTIO_CHK_SUPP_FNC

typedef int MBGEXTIO_CHK_SUPP_FNC(const MBG_MSG_CTL *pmctl)

Type of functions to check if a feature is supported.

Definition at line 563 of file mbgextio.h.

Function Documentation

◆ mbgextio_chk_user_perm()

int mbgextio_chk_user_perm	(	MBG_MSG_CTL *	pmctl,
		uint16_t	perm,
		uint32_t	scope_mask
	)

Check user permission for one of the given scopes.

Parameters

[in]	pmctl	Pointer to a valid message control structure
[in]	perm	Permission to be checked, see MBG_USER_PERMS
[in]	scope_mask	Mask of scopes that shall be checked, see MBG_USER_SCOPE_MSKS

Returns: One of the MBG_RETURN_CODES

Definition at line 13948 of file mbgextio.c.

References _check_user_perm, MBG_USER_STATUS::cfg_read_perm, MBG_USER_STATUS::cfg_write_perm, MBG_ERR_PERM, mbg_rc_is_success, MBG_SUCCESS, mbgextio_dev_has_user_auth, MBG_USER_STATUS::stat_read_perm, USER_SCOPE_CONFIG_READ_MSK, USER_SCOPE_CONFIG_WRITE_MSK, USER_SCOPE_STATUS_READ_MSK, MBG_XDEV_FEATURES::user_status, and MBG_MSG_CTL_s::xdev_features.

◆ mbgextio_close_connection()

int mbgextio_close_connection ( MBG_MSG_CTL ** ppmctl )

Close a binary communication channel and release resources.

Closes a binary communication channel which has been opened by one of the mbgextio_open_...() functions and releases the buffers which have been allocated when the channel was opened.

The pointer to the message control structure passed by address is set to NULL after the channel has been closed and the resources have been released.

Parameters

[in,out] ppmctl Address of a pointer to a message control structure created when the communication channel was opened by one of the mbgextio_open_...() calls.

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_open_socket; mbgextio_open_serial; mbgextio_open_serial_ftdi; mbgextio_open_usb; mbgextio_open_usb_ldev

Definition at line 2697 of file mbgextio.c.

References _MBG_API, _mbg_mutex_destroy, _NO_MBG_API_ATTR, MBG_MSG_CTL_s::conn_type, MBG_MSG_CTL_s::dev_mutex, force_conn_cmd_str, force_conn_hs_cmd_str, FT_HANDLE, FT_STATUS, mbg_baud_rates, MBG_CONN_TYPE_SERIAL, MBG_CONN_TYPE_SERIAL_FTDI, MBG_CONN_TYPE_SOCKET, MBG_CONN_TYPE_USB, MBG_DEFAULT_BAUDRATE, MBG_DEFAULT_BAUDRATE_HS, MBG_DEFAULT_FRAMING, MBG_ERR_CONN_TYPE, MBG_ERR_IO, MBG_ERR_NO_ENTITY, MBG_ERR_UNSPEC, mbg_framing_strs, mbg_ftdi_ft_status_to_mbg(), mbg_rc_is_error, mbg_rc_is_success, mbg_strerror(), mbgextio_close_connection(), mbgextio_force_conn_serial(), mbgextio_force_conn_serial_ftdi(), mbgextio_get_receiver_info(), mbgextio_open_serial_ftdi(), mbgextio_open_serial_raw(), mbgserio_close(), mbgserio_write(), N_MBG_BAUD_RATES, N_MBG_FRAMINGS, MBG_MSG_CTL_s::st::p_serio, and MBG_MSG_CTL_s::st.

Referenced by dev_open_finish_setup(), and mbgextio_close_connection().

◆ mbgextio_clr_evt_log()

int mbgextio_clr_evt_log	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr
	)

Clear the on-board event log.

Note: Some devices don't provide an on-board event log

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_get_num_evt_log_entries; mbgextio_get_first_evt_log_entry; mbgextio_get_next_evt_log_entry

Definition at line 7884 of file mbgextio.c.

References GPS_CLR_EVT_LOG, mbg_rc_is_error, mbgextio_chk_user_perm(), mbgextio_xmt_cmd(), USER_PERM_MONITORING, and USER_SCOPE_CONFIG_WRITE_MSK.

◆ mbgextio_clr_ucap_buff()

int mbgextio_clr_ucap_buff	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr
	)

Clear the user capture event buffer on-board the device.

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_get_ucap

Definition at line 7785 of file mbgextio.c.

References GPS_CLR_UCAP_BUFF, mbg_rc_is_error, mbgextio_chk_user_perm(), mbgextio_xmt_cmd(), USER_PERM_IOPORTS, and USER_SCOPE_CONFIG_WRITE_MSK.

◆ mbgextio_cmd_save_cfg()

int mbgextio_cmd_save_cfg	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr
	)

Send a command to let the device save it's current configuration as default.

Call mbgextio_dev_has_cmd_save_cfg to check if this function is supported.

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_dev_has_cmd_save_cfg

Definition at line 13509 of file mbgextio.c.

References GPS_SAVE_CFG, mbg_rc_is_error, mbgextio_chk_user_perm(), mbgextio_xmt_cmd(), OPT_GPS_ACK_CODE, USER_PERM_SYSTEM, and USER_SCOPE_CONFIG_WRITE_MSK.

◆ mbgextio_delete_fw()

int mbgextio_delete_fw	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		uint16_t	idx
	)

Delete the firmware with the given index.

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[in]	idx	Index of the firmware to be deleted

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_dev_has_fw_mngmnt; mbgextio_get_all_firmware_info; mbgextio_get_fw_glb_info; mbgextio_get_fw_info_idx; mbgextio_fw_ufu_flash

Definition at line 11005 of file mbgextio.c.

References GPS_FW_DELETE, mbg_rc_is_error, mbgextio_chk_user_perm(), mbgextio_xmt_cmd_us(), OPT_GPS_ACK_CODE, USER_PERM_FIRMWARE, and USER_SCOPE_CONFIG_WRITE_MSK.

◆ mbgextio_dev_has_ant_cable_length()

int mbgextio_dev_has_ant_cable_length ( const MBG_MSG_CTL * pmctl )

Definition at line 3384 of file mbgextio.c.

References MBG_MSG_CTL_s::xdev_features, and xdevfeat_has_ant_cable_length.

◆ mbgextio_dev_has_ant_info()

int mbgextio_dev_has_ant_info ( const MBG_MSG_CTL * pmctl )

Definition at line 3373 of file mbgextio.c.

References MBG_MSG_CTL_s::xdev_features, and xdevfeat_has_ant_info.

◆ mbgextio_dev_has_bvar_stat()

int mbgextio_dev_has_bvar_stat ( const MBG_MSG_CTL * pmctl )

Definition at line 3714 of file mbgextio.c.

References MBG_MSG_CTL_s::xdev_features, and xdevfeat_has_bvar_stat.

◆ mbgextio_dev_has_clk_res_info()

int mbgextio_dev_has_clk_res_info ( const MBG_MSG_CTL * pmctl )

Definition at line 3426 of file mbgextio.c.

References MBG_MSG_CTL_s::xdev_features, and xdevfeat_has_clk_res_info.

◆ mbgextio_dev_has_enable_flags()

int mbgextio_dev_has_enable_flags ( const MBG_MSG_CTL * pmctl )

Definition at line 3597 of file mbgextio.c.

References MBG_MSG_CTL_s::xdev_features, and xdevfeat_has_enable_flags.

◆ mbgextio_dev_has_evt_log()

int mbgextio_dev_has_evt_log ( const MBG_MSG_CTL * pmctl )

Definition at line 3940 of file mbgextio.c.

References MBG_MSG_CTL_s::xdev_features, and xdevfeat_has_evt_log.

◆ mbgextio_dev_has_gpio()

int mbgextio_dev_has_gpio ( const MBG_MSG_CTL * pmctl )

Definition at line 3659 of file mbgextio.c.

References MBG_MSG_CTL_s::xdev_features, and xdevfeat_has_gpio.

◆ mbgextio_dev_has_ims()

int mbgextio_dev_has_ims ( const MBG_MSG_CTL * pmctl )

Definition at line 3637 of file mbgextio.c.

References MBG_MSG_CTL_s::xdev_features, and xdevfeat_has_ims.

◆ mbgextio_dev_has_io_ports()

int mbgextio_dev_has_io_ports ( const MBG_MSG_CTL * pmctl )

Definition at line 3395 of file mbgextio.c.

References MBG_MSG_CTL_s::xdev_features, and xdevfeat_has_io_ports.

◆ mbgextio_dev_has_irig_rx()

int mbgextio_dev_has_irig_rx ( const MBG_MSG_CTL * pmctl )

Definition at line 3692 of file mbgextio.c.

References MBG_MSG_CTL_s::xdev_features, and xdevfeat_has_irig_rx.

◆ mbgextio_dev_has_irig_tx()

int mbgextio_dev_has_irig_tx ( const MBG_MSG_CTL * pmctl )

Definition at line 3681 of file mbgextio.c.

References MBG_MSG_CTL_s::xdev_features, and xdevfeat_has_irig_tx.

◆ mbgextio_dev_has_pos_lla()

int mbgextio_dev_has_pos_lla ( const MBG_MSG_CTL * pmctl )

Definition at line 3351 of file mbgextio.c.

References MBG_MSG_CTL_s::xdev_features, and xdevfeat_has_pos_lla.

◆ mbgextio_dev_has_pos_xyz()

int mbgextio_dev_has_pos_xyz ( const MBG_MSG_CTL * pmctl )

Definition at line 3340 of file mbgextio.c.

References MBG_MSG_CTL_s::xdev_features, and xdevfeat_has_pos_xyz.

◆ mbgextio_dev_has_prog_pulses()

int mbgextio_dev_has_prog_pulses ( const MBG_MSG_CTL * pmctl )

Definition at line 3670 of file mbgextio.c.

References MBG_MSG_CTL_s::xdev_features, and xdevfeat_has_prog_pulses.

◆ mbgextio_dev_has_push_msgs()

int mbgextio_dev_has_push_msgs ( const MBG_MSG_CTL * pmctl )

Definition at line 3417 of file mbgextio.c.

References MBG_MSG_CTL_s::xdev_features, and xdevfeat_has_push_msgs.

◆ mbgextio_dev_has_serouts()

int mbgextio_dev_has_serouts ( const MBG_MSG_CTL * pmctl )

Definition at line 3703 of file mbgextio.c.

References MBG_MSG_CTL_s::xdev_features, and xdevfeat_has_serouts.

◆ mbgextio_dev_has_service()

int mbgextio_dev_has_service ( const MBG_MSG_CTL * pmctl )

Definition at line 3725 of file mbgextio.c.

References MBG_MSG_CTL_s::xdev_features, and xdevfeat_has_service.

◆ mbgextio_dev_has_synth()

int mbgextio_dev_has_synth ( const MBG_MSG_CTL * pmctl )

Definition at line 3648 of file mbgextio.c.

References MBG_MSG_CTL_s::xdev_features, and xdevfeat_has_synth.

◆ mbgextio_dev_has_tainted_cfg()

int mbgextio_dev_has_tainted_cfg ( const MBG_MSG_CTL * pmctl )

Definition at line 3406 of file mbgextio.c.

References MBG_MSG_CTL_s::xdev_features, and xdevfeat_has_tainted_cfg.

◆ mbgextio_dev_has_time_scale()

int mbgextio_dev_has_time_scale ( const MBG_MSG_CTL * pmctl )

Definition at line 3607 of file mbgextio.c.

References MBG_MSG_CTL_s::xdev_features, and xdevfeat_has_time_scale.

◆ mbgextio_dev_has_time_ttm()

int mbgextio_dev_has_time_ttm ( const MBG_MSG_CTL * pmctl )

Definition at line 3362 of file mbgextio.c.

References MBG_MSG_CTL_s::xdev_features, and xdevfeat_has_time_ttm().

◆ mbgextio_dev_has_tzcode()

int mbgextio_dev_has_tzcode ( const MBG_MSG_CTL * pmctl )

Definition at line 3627 of file mbgextio.c.

References MBG_MSG_CTL_s::xdev_features, and xdevfeat_has_tzcode.

◆ mbgextio_dev_has_tzdl()

int mbgextio_dev_has_tzdl ( const MBG_MSG_CTL * pmctl )

Definition at line 3617 of file mbgextio.c.

References MBG_MSG_CTL_s::xdev_features, and xdevfeat_has_tzdl.

◆ mbgextio_dev_has_ucap()

int mbgextio_dev_has_ucap ( const MBG_MSG_CTL * pmctl )

Definition at line 3950 of file mbgextio.c.

References MBG_MSG_CTL_s::xdev_features, and xdevfeat_has_ucap.

◆ mbgextio_dev_has_ucap_net()

int mbgextio_dev_has_ucap_net ( const MBG_MSG_CTL * pmctl )

Definition at line 3960 of file mbgextio.c.

References MBG_MSG_CTL_s::xdev_features, and xdevfeat_has_ucap_net.

◆ mbgextio_find_lan_devices()

int mbgextio_find_lan_devices	(	MBG_LAN_DEV_LIST **	list,
		uint16_t	timeout_ms
	)

Sets up a list of all available Meinberg LAN devices in the network.

List entries will be allocated and have to be freed by calling mbgextio_free_lan_devices

Parameters

[out]	list	Pointer to the list
[in]	timeout_ms	Timeout in ms for each network interface

Returns: One of the MBG_RETURN_CODES or the number of found devices on success

See also: mbgextio_free_lan_devices

Referenced by dev_open_finish_setup().

◆ mbgextio_force_conn_serial()

long mbgextio_force_conn_serial ( const char * dev )

Try to force a serial connection to a device.

A device's serial port may have been configured to work by default in a way which is not appropriate for binary communication, e.g. using a low communication speed, or some framing like "7E2" which messes up binary data since the parity bit overrides a data bit.

This function sends a special ASCII string to a device which lets the device temporarily switch to a specific baud rate and 8N1 framing which is usually used for binary communication, see MBG_DEFAULT_BAUDRATE, MBG_DEFAULT_BAUDRATE_HS, and MBG_DEFAULT_FRAMING.

Since the current settings of the device's serial port are unknown this this command is sent in all common combinations of baud rates and framings.

If the connected device supports this it should be possible to open the serial communication channel using the default parameters after this function has finished.

Parameters

[in] dev Name of the serial port to which the device is connected, depending on the naming conventions of the target system

Returns: One of the negative MBG_ERROR_CODES on error, else the determined baud rate.

See also: mbgextio_open_serial; mbgextio_open_serial_ftdi

Referenced by mbgextio_close_connection().

◆ mbgextio_force_conn_serial_ftdi()

long mbgextio_force_conn_serial_ftdi ( int device_num )

Try to force a serial connection to a device via the FTDI API.

A device's serial port may have been configured to work by default in a way which is not appropriate for binary communication, e.g. using a low communication speed, or some framing like "7E2" which messes up binary data since the parity bit overrides a data bit.

This function sends a special ASCII string to a device which lets the device temporarily switch to a specific baud rate and 8N1 framing which is usually used for binary communication, see MBG_DEFAULT_BAUDRATE, MBG_DEFAULT_BAUDRATE_HS, and MBG_DEFAULT_FRAMING.

Since the current settings of the device's serial port are unknown this this command is sent in all common combinations of baud rates and framings.

If the connected device supports this it should be possible to open the serial communication channel using the default parameters after this function has finished.

Parameters

[in] device_num device number from a list set up by FT_ListDevices()

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_open_serial_ftdi

Referenced by mbgextio_close_connection().

◆ mbgextio_free_lan_devices()

int mbgextio_free_lan_devices ( MBG_LAN_DEV_LIST * list )

Frees the MBG_LAN_DEV_LIST allocated by mbgextio_find_lan_devices.

Parameters

[in] list The list that will be freed

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_find_lan_devices

Referenced by dev_open_finish_setup().

◆ mbgextio_fw_ufu_flash()

int mbgextio_fw_ufu_flash	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		const MBG_FW_UFU_FLASH_CMD *	p
	)

Send UFU flash instruction(s)

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_dev_has_fw_mngmnt; mbgextio_get_all_firmware_info; mbgextio_get_fw_glb_info; mbgextio_get_fw_info_idx; mbgextio_get_fw_ufu_info_idx

Definition at line 11078 of file mbgextio.c.

References _mbg_mutex_acquire, _mbg_swab_fw_ufu_flash_cmd, MBG_MSG_CTL_s::dev_mutex, MSG_DATA::fw_ufu_flash_cmd, GPS_FW_UFU_FLASH, mbg_rc_is_error, mbgextio_chk_user_perm(), mbgextio_xmt_msg(), MBG_MSG_BUFF::msg_data, OPT_GPS_ACK_CODE, MBG_MSG_XMT_CTL::pmb, MBG_MSG_BUFF::u, USER_PERM_FIRMWARE, USER_SCOPE_CONFIG_WRITE_MSK, and MBG_MSG_CTL_s::xmt.

◆ mbgextio_get_all_gnss_sat_info()

int mbgextio_get_all_gnss_sat_info	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		GNSS_SAT_INFO_IDX	gsii[],
		const MBG_GNSS_MODE_INFO *	p_mi
	)

::TODO Read an array of all supported string types

The number of supported string types is specified in RECEIVER_INFO::n_str_type.

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	gsii	::TODO
[in]	p_mi	::TODO

Returns: One of the MBG_RETURN_CODES

See also: ::TODO

Definition at line 8527 of file mbgextio.c.

References mbg_rc_is_error, MBG_SUCCESS, mbgextio_get_gnss_sat_info_idx(), num_bits_set(), and MBG_GNSS_MODE_INFO::supp_gnss_types.

Referenced by mbgextio_get_gnss_sv_status_idx().

◆ mbgextio_get_all_port_info()

int mbgextio_get_all_port_info	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		PORT_INFO_IDX	pii[]
	)

Read an array of current settings and capabilities of all serial ports.

The number of serial ports provided by the device is specified in RECEIVER_INFO::n_com_ports.

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	pii	An array which can hold at least RECEIVER_INFO::n_com_ports entries

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_get_port_info_idx; mbgextio_set_port_settings_idx

Definition at line 7536 of file mbgextio.c.

References mbg_rc_is_error, mbgextio_chk_user_perm(), mbgextio_get_port_info_idx(), mbgextio_get_receiver_info_addr(), RECEIVER_INFO::n_com_ports, USER_PERM_SERIAL, and USER_SCOPE_CONFIG_READ_MSK.

◆ mbgextio_get_all_pout_info()

int mbgextio_get_all_pout_info	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		POUT_INFO_IDX *	pii
	)

Read an array of current settings and capabilities of all programmable pulse outputs.

The number of supported pulse outputs is specified in RECEIVER_INFO::n_prg_out.

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	pii	An array which can hold at least RECEIVER_INFO::n_prg_out entries

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_get_pout_info_idx; mbgextio_set_pout_settings_idx

Definition at line 7664 of file mbgextio.c.

References mbg_rc_is_error, mbgextio_chk_user_perm(), mbgextio_get_pout_info_idx(), mbgextio_get_receiver_info_addr(), RECEIVER_INFO::n_prg_out, USER_PERM_IOPORTS, and USER_SCOPE_CONFIG_READ_MSK.

◆ mbgextio_get_all_ptp_uc_master_info()

int mbgextio_get_all_ptp_uc_master_info	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		PTP_UC_MASTER_INFO_IDX *	ptp_uc_master_info_idx,
		const PTP_UC_MASTER_CFG_LIMITS *	ptp_uc_master_cfg_limits
	)

Read the ptp configuration ALL_PTP_UC_MASTER_INFO_IDX format.

Note: ptp feature must set and read number of ptp unicast masters before.

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	ptp_uc_master_info_idx	Pointer to an array of PTP_UC_MASTER_INFO_IDX structures to be filled up
[in]	ptp_uc_master_cfg_limits	Pointer to a PTP_UC_MASTER_CFG_LIMITS structure read before

Returns: One of the MBG_RETURN_CODES

See also: //##+++++++++++++ TODO

Definition at line 9252 of file mbgextio.c.

References _mbg_swab_ptp_uc_master_info_idx, GPS_PTP_UC_MASTER_CFG, mbg_rc_is_error, mbg_rc_is_success, mbgextio_chk_user_perm(), mbgextio_rcv_msg_unlocked(), MBG_MSG_BUFF::msg_data, PTP_UC_MASTER_CFG_LIMITS::n_supp_master, MBG_MSG_RCV_CTL::pmb, MSG_DATA::ptp_uc_master_info_idx, MBG_MSG_CTL_s::rcv, MBG_MSG_BUFF::u, USER_PERM_PTP, USER_SCOPE_CONFIG_READ_MSK, and xmt_cmd_us().

◆ mbgextio_get_all_str_type_info()

int mbgextio_get_all_str_type_info	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		STR_TYPE_INFO_IDX	stii[]
	)

Read an array of all supported string types.

The number of supported string types is specified in RECEIVER_INFO::n_str_type.

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	stii	An array which can hold at least RECEIVER_INFO::n_str_type entries

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_get_str_type_info_idx

Definition at line 7450 of file mbgextio.c.

References mbg_rc_is_error, mbgextio_chk_user_perm(), mbgextio_get_receiver_info_addr(), mbgextio_get_str_type_info_idx(), RECEIVER_INFO::n_str_type, USER_PERM_SERIAL, and USER_SCOPE_CONFIG_READ_MSK.

◆ mbgextio_get_ant_cable_len()

int mbgextio_get_ant_cable_len	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		ANT_CABLE_LEN *	p
	)

Read the configured length of the antenna cable.

This is only supported by GPS/GNSS receivers, check GPS_MODEL_HAS_ANT_CABLE_LEN

Note: Some older devices may not reply to this request unless the application has registered itself as terminal application (GPS_AUTO_ON is not sufficient).

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_set_ant_cable_len

Definition at line 6987 of file mbgextio.c.

References _mbg_swab_ant_cable_len, GPS_ANT_CABLE_LENGTH, mbg_rc_is_error, mbg_rc_is_success, mbgextio_chk_user_perm(), mbgextio_req_data(), USER_PERM_RECEIVER, and USER_SCOPE_CONFIG_READ_MSK.

◆ mbgextio_get_ant_info()

int mbgextio_get_ant_info	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		ANT_INFO *	p
	)

Read the GPS antenna info structure.

Note: This is only supported by GPS receivers.

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data

Returns: One of the MBG_RETURN_CODES

Definition at line 6402 of file mbgextio.c.

References _mbg_swab_ant_info, GPS_ANT_INFO, mbg_rc_is_success, and mbgextio_req_data().

◆ mbgextio_get_bvar_stat()

int mbgextio_get_bvar_stat	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		BVAR_STAT *	p
	)

Read the status of buffered variables.

Note: Only supported if GPS_MODEL_HAS_BVAR_STAT

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data

Returns: One of the MBG_RETURN_CODES

Definition at line 5939 of file mbgextio.c.

References _mbg_swab_bvar_stat, GPS_BVAR_STAT, mbg_rc_is_success, and mbgextio_req_data().

◆ mbgextio_get_cfgh()

int mbgextio_get_cfgh	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		CFGH *	p
	)

Read configuration and health data of all satellites from a device.

Note: Only supported by GPS receivers

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data

Returns: One of the MBG_RETURN_CODES

Definition at line 12909 of file mbgextio.c.

References _mbg_swab_dummy, GPS_CFGH, mbg_rc_is_success, and mbgextio_req_data().

◆ mbgextio_get_clk_res_info()

int mbgextio_get_clk_res_info	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		MBG_CLK_RES_INFO *	p
	)

Read clk_res_info from device.

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to be sent by the device

Returns: One of the MBG_RETURN_CODES

Definition at line 5657 of file mbgextio.c.

References _mbg_swab_mbg_clk_res_info, GPS_CLK_RES_INFO, mbg_rc_is_success, and mbgextio_req_data().

◆ mbgextio_get_cmd_name()

const char* mbgextio_get_cmd_name ( GPS_CMD cmd_code )

◆ mbgextio_get_corr_info()

int mbgextio_get_corr_info	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		CORR_INFO *	p
	)

Definition at line 13918 of file mbgextio.c.

References _mbg_swab_corr_info, mbg_rc_is_error, mbg_rc_is_success, mbgextio_chk_user_perm(), mbgextio_req_data(), PZF_CORR_INFO, USER_PERM_RECEIVER, and USER_SCOPE_STATUS_READ_MSK.

◆ mbgextio_get_database_glb_info()

int mbgextio_get_database_glb_info	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		MBG_DATABASE_GLB_INFO *	p
	)

Read global database information in MBG_DATABASE_GLB_INFO format.

Note: MBG_XFEATURE_DATABASE ext. feature must be set

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_dev_has_database; mbgextio_get_database_info_idx; mbgextio_set_database_settings_idx; mbgextio_send_database_cmd

Definition at line 11121 of file mbgextio.c.

References _mbg_swab_database_glb_info, GPS_DATABASE_GLB_INFO, mbg_rc_is_error, mbg_rc_is_success, mbgextio_chk_user_perm(), mbgextio_req_data(), USER_PERM_DATABASE, and USER_SCOPE_CONFIG_READ_MSK.

◆ mbgextio_get_database_info_idx()

int mbgextio_get_database_info_idx	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		MBG_DATABASE_INFO_IDX *	p,
		uint8_t	idx
	)

Read a database info with given index in MBG_DATABASE_INFO_IDX format.

Note: MBG_XFEATURE_DATABASE ext. feature must be set

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data
[in]	idx	Database info index to be queried, 0...MBG_DATABASE_GLB_INFO::num_dbs-1

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_dev_has_database; mbgextio_get_database_glb_info; mbgextio_set_database_settings_idx; mbgextio_send_database_cmd

Definition at line 11159 of file mbgextio.c.

References _mbg_swab_database_info_idx, GPS_DATABASE_INFO_IDX, mbg_rc_is_error, mbg_rc_is_success, mbgextio_chk_user_perm(), mbgextio_req_data_idx(), USER_PERM_DATABASE, and USER_SCOPE_CONFIG_READ_MSK.

◆ mbgextio_get_debug_status()

int mbgextio_get_debug_status	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		MBG_DEBUG_STATUS *	p
	)

Read current debug status.

Note: This is only supported if GPS_HAS_DEBUG_STATUS is set in RECEIVER_INFO::features, usually with IRIG receivers

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data

Returns: One of the MBG_RETURN_CODES

Definition at line 7315 of file mbgextio.c.

References _mbg_swab_debug_status, GPS_DEBUG_STATUS, mbg_rc_is_success, and mbgextio_req_data().

◆ mbgextio_get_dev_poll_timeout()

ulong mbgextio_get_dev_poll_timeout ( const MBG_MSG_CTL * pmctl )

Get device poll timeout.

Parameters

[in,out] pmctl Pointer to a valid message control structure

Returns: Current poll timeout value [ms]

See also: mbgextio_set_dev_poll_timeout; mbgextio_set_msg_rcv_timeout; mbgextio_get_msg_rcv_timeout

Definition at line 3264 of file mbgextio.c.

◆ mbgextio_get_enable_flags()

int mbgextio_get_enable_flags	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		ENABLE_FLAGS *	p
	)

Read the enable flags controlling when output signals are enabled.

Note: Some devices may not support ENABLE_FLAGS

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_set_enable_flags

Definition at line 6881 of file mbgextio.c.

References _mbg_swab_enable_flags, GPS_ENABLE_FLAGS, mbg_rc_is_error, mbg_rc_is_success, mbgextio_chk_user_perm(), mbgextio_req_data(), USER_PERM_IOPORTS, and USER_SCOPE_CONFIG_READ_MSK.

◆ mbgextio_get_event_info_idx()

int mbgextio_get_event_info_idx	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		MBG_EVENT_INFO_IDX *	p,
		uint16_t	idx
	)

Read monitoring event info in MBG_EVENT_INFO_IDX format.

Note: extended feature MBG_XFEATURE_MONITORING must be set idx shall be the type of the appropriate event, it should be checked if this event is supported in MBG_MONITORING_LIMITS::supp_num_events

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data
[in]	idx	Index of the event info to be received, type of the appropriate event

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_dev_has_monitoring; mbgextio_get_monitoring_limits; mbgextio_set_event_settings_idx; mbgextio_get_event_status_idx; mbgextio_get_event_value_idx

Definition at line 10568 of file mbgextio.c.

References _mbg_swab_event_info_idx, GPS_EVENT_IDX, mbg_rc_is_error, mbg_rc_is_success, mbgextio_chk_user_perm(), mbgextio_req_data_idx(), USER_PERM_MONITORING, USER_SCOPE_CONFIG_READ_MSK, and USER_SCOPE_STATUS_READ_MSK.

◆ mbgextio_get_event_status_idx()

int mbgextio_get_event_status_idx	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		uint8_t	vtype,
		MBG_EVENT_STATUS_IDX *	p,
		uint16_t	idx
	)

Read monitoring event status in MBG_EVENT_STATUS_IDX format.

Note: extended feature MBG_XFEATURE_MONITORING must be set idx shall be the type of the appropriate event, it should be checked if this event is supported in MBG_MONITORING_LIMITS::supp_num_events

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[in]	vtype	Corresponding value type if MBG_EVENT_INFO::value_type
[out]	p	Pointer to the data structure to return the received data
[in]	idx	Index of the event info to be received, type of the appropriate event

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_dev_has_monitoring; mbgextio_get_monitoring_limits; mbgextio_get_event_info_idx; mbgextio_get_event_value_idx

Definition at line 10651 of file mbgextio.c.

References _mbg_swab_event_status_idx, GPS_EVENT_STAT_IDX, mbg_rc_is_error, mbg_rc_is_success, mbgextio_chk_user_perm(), mbgextio_req_data_idx(), USER_PERM_MONITORING, and USER_SCOPE_STATUS_READ_MSK.

◆ mbgextio_get_event_value_idx()

int mbgextio_get_event_value_idx	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		uint16_t	eidx,
		uint8_t	vtype,
		MBG_EVENT_VALUE_IDX *	p,
		uint16_t	vidx
	)

Read monitoring event status in MBG_EVENT_STATUS_IDX format.

Note: extended feature MBG_XFEATURE_MONITORING must be set idx shall be the type of the appropriate event, it should be checked if this event is supported in MBG_MONITORING_LIMITS::supp_num_events

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[in]	eidx	Event idx to be requested (0..MBG_MONITORING_LIMITS::supp_num_events - 1)
[in]	vtype	Corresponding value type, see MBG_EVENT_INFO::value_type
[out]	p	Pointer to the data structure to return the received data
[in]	vidx	Index of the event value to be requested (0..MBG_EVENT_INFO::value_dict_entries - 1)

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_dev_has_monitoring; mbgextio_get_monitoring_limits; mbgextio_get_event_info_idx; mbgextio_get_event_status_idx

Definition at line 10691 of file mbgextio.c.

References _mbg_mutex_acquire, _mbg_mutex_release, _mbg_swab_event_value_idx, MBG_MSG_CTL_s::dev_mutex, GPS_EVENT_VALUE_IDX, mbg_rc_is_error, mbg_rc_is_success, MBG_SUCCESS, mbgextio_chk_user_perm(), mbgextio_rcv_msg_unlocked(), USER_PERM_MONITORING, USER_SCOPE_CONFIG_READ_MSK, USER_SCOPE_STATUS_READ_MSK, and xmt_cmd_u32().

◆ mbgextio_get_ext_sys_info()

int mbgextio_get_ext_sys_info	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		MBG_EXT_SYS_INFO *	p
	)

Definition at line 13903 of file mbgextio.c.

References _mbg_swab_ext_sys_info, GPS_EXT_SYS_INFO, mbg_rc_is_success, and mbgextio_req_data().

◆ mbgextio_get_fdm_freq()

int mbgextio_get_fdm_freq	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		MBG_GPIO_FREQ *	p
	)

Read a MBG_GPIO_FREQ parameter structure from a device.

The MBG_GPIO_FREQ parameter structure contains the current frequency

Note: Only supported if MBG_IMS_STATE_FLAG_BIT_HAS_FDM is set in MBG_IMS_STATE::flags

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data

Returns: One of the MBG_RETURN_CODES

Definition at line 13216 of file mbgextio.c.

References _mbg_swab_mbg_gpio_freq, GPS_FDM_FREQ, mbg_rc_is_success, and mbgextio_req_data().

◆ mbgextio_get_first_evt_log_entry()

int mbgextio_get_first_evt_log_entry	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		MBG_EVT_LOG_ENTRY *	p
	)

Return the first entry from the on-board event log.

This resets an internal counter, so subsequent calls to mbgextio_get_next_evt_log_entry will retrieve the following entries.

Note: Some devices don't provide an on-board event log

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_clr_evt_log; mbgextio_get_num_evt_log_entries; mbgextio_get_next_evt_log_entry

Definition at line 7953 of file mbgextio.c.

References _mbg_swab_mbg_evt_log_entry, GPS_FIRST_EVT_LOG_ENTRY, mbg_rc_is_error, mbg_rc_is_success, mbgextio_chk_user_perm(), mbgextio_req_data(), USER_PERM_MONITORING, and USER_SCOPE_STATUS_READ_MSK.

◆ mbgextio_get_fw_glb_info()

int mbgextio_get_fw_glb_info	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		MBG_FW_GLB_INFO *	p
	)

Read the firmware global information in MBG_FW_GLB_INFO format.

Note: MBG_XFEATURE_FW_MNGMNT ext. feature must be set

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_dev_has_fw_mngmnt; mbgextio_get_all_firmware_info; mbgextio_get_fw_info_idx; mbgextio_get_fw_ufu_info_idx; mbgextio_fw_ufu_flash

Definition at line 10901 of file mbgextio.c.

References _mbg_swab_fw_glb_info, GPS_FW_GLB_INFO, mbg_rc_is_error, mbg_rc_is_success, mbgextio_chk_user_perm(), mbgextio_req_data(), USER_PERM_FIRMWARE, and USER_SCOPE_CONFIG_READ_MSK.

◆ mbgextio_get_fw_info_idx()

int mbgextio_get_fw_info_idx	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		MBG_FW_INFO_IDX *	p,
		uint16_t	idx
	)

Read the firmware info with the given index in MBG_FW_INFO_IDX format.

Note: MBG_XFEATURE_FW_MNGMNT ext. feature must be set

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data
[in]	idx	Index of the firmware info to be queried, 0 ... MBG_FW_GLB_INFO::installed_fws - 1

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_dev_has_fw_mngmnt; mbgextio_get_all_firmware_info; mbgextio_get_fw_glb_info; mbgextio_get_fw_ufu_info_idx; mbgextio_fw_ufu_flash

Definition at line 10939 of file mbgextio.c.

References _mbg_swab_fw_info_idx, GPS_FW_INFO_IDX, mbg_rc_is_error, mbg_rc_is_success, mbgextio_chk_user_perm(), mbgextio_req_data_idx(), USER_PERM_FIRMWARE, and USER_SCOPE_CONFIG_READ_MSK.

◆ mbgextio_get_fw_ufu_info_idx()

int mbgextio_get_fw_ufu_info_idx	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		MBG_FW_UFU_INFO_IDX *	p,
		uint8_t	fw_idx,
		uint8_t	ufu_idx
	)

Read the firmware ufu info of the given firmware with the also given index in MBG_FW_UFU_INFO_IDX format.

Note: MBG_XFEATURE_FW_MNGMNT ext. feature must be set the 2-byte idx field be used for fw_idx (<< 8) and ufu_idx

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data
[in]	fw_idx	Index of the firmware to be queried, 0...MBG_FW_GLB_INFO::installed_fws-1
[in]	ufu_idx	Index of the firmware ufu info to be queried, 0...::MBG_FW_INFO_IDX::info::num_ufus-1 for each MBG_FW_INFO_IDX

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_dev_has_fw_mngmnt; mbgextio_get_all_firmware_info; mbgextio_get_fw_glb_info; mbgextio_get_fw_info_idx; mbgextio_fw_ufu_flash

Definition at line 11042 of file mbgextio.c.

References _mbg_swab_fw_ufu_info_idx, GPS_FW_UFU_INFO_IDX, mbg_rc_is_error, mbg_rc_is_success, mbgextio_chk_user_perm(), mbgextio_req_data_idx(), USER_PERM_FIRMWARE, and USER_SCOPE_CONFIG_READ_MSK.

◆ mbgextio_get_gnss_mode_info()

int mbgextio_get_gnss_mode_info	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		MBG_GNSS_MODE_INFO *	p
	)

Read current GNSS mode settings and supported features.

Note: Some devices may not support GNSS configuration

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to a MBG_GNSS_MODE_INFO structure to be filled up

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_set_gnss_mode_settings

Definition at line 8373 of file mbgextio.c.

References _mbg_swab_mbg_gnss_mode_info, GPS_GNSS_MODE, mbg_rc_is_error, mbg_rc_is_success, mbgextio_chk_user_perm(), mbgextio_req_data(), USER_PERM_RECEIVER, and USER_SCOPE_CONFIG_READ_MSK.

◆ mbgextio_get_gnss_sat_info()

int mbgextio_get_gnss_sat_info	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		GNSS_SAT_INFO *	p
	)

::TODO

TODO this is obsolete

Retrieve a single entry from an array of supported string types. The number of supported string types is specified in RECEIVER_INFO::n_str_type.

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data

Returns: One of the MBG_RETURN_CODES

See also: ::TODO

Definition at line 8446 of file mbgextio.c.

References _mbg_swab_gnss_sat_info, GPS_GNSS_SAT_INFO, mbg_rc_is_error, mbg_rc_is_success, mbgextio_chk_user_perm(), mbgextio_req_data(), USER_PERM_RECEIVER, and USER_SCOPE_STATUS_READ_MSK.

◆ mbgextio_get_gnss_sat_info_idx()

int mbgextio_get_gnss_sat_info_idx	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		GNSS_SAT_INFO_IDX *	p,
		uint16_t	idx
	)

::TODO

TODO

Retrieve a single entry from an array of supported string types. The number of supported string types is specified in RECEIVER_INFO::n_str_type.

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data
[in]	idx	Index of the array element to be retrieved, 0..RECEIVER_INFO::n_str_type - 1

Returns: One of the MBG_RETURN_CODES

See also: ::TODO

Definition at line 8482 of file mbgextio.c.

References _mbg_swab_gnss_sat_info_idx, GPS_GNSS_SAT_INFO_IDX, mbg_rc_is_error, mbg_rc_is_success, mbgextio_chk_user_perm(), mbgextio_req_data_idx(), USER_PERM_RECEIVER, and USER_SCOPE_STATUS_READ_MSK.

Referenced by mbgextio_get_all_gnss_sat_info(), and mbgextio_get_gnss_sv_status_idx().

◆ mbgextio_get_gnss_sv_status_idx()

int mbgextio_get_gnss_sv_status_idx	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		GNSS_SV_STATUS_IDX *	p,
		uint16_t	idx
	)

::TODO

TODO

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data
[in]	idx	Index of the array element to be retrieved, 0..RECEIVER_INFO::n_str_type - 1

Returns: One of the MBG_RETURN_CODES

See also: GNSS Satellite Status ::TODO

Definition at line 8564 of file mbgextio.c.

References _MBG_API, _mbg_swab_gnss_sv_status_idx, _NO_MBG_API_ATTR, GPS_GNSS_SV_STATUS_IDX, mbg_rc_is_error, mbg_rc_is_success, MBG_SUCCESS, mbgextio_get_all_gnss_sat_info(), mbgextio_get_gnss_sat_info_idx(), mbgextio_req_data_idx(), num_bits_set(), and MBG_GNSS_MODE_INFO::supp_gnss_types.

◆ mbgextio_get_gps_stat_info()

int mbgextio_get_gps_stat_info	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		STAT_INFO *	p
	)

Read GPS status info.

Note: This is only supported by GPS receivers

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data

Returns: One of the MBG_RETURN_CODES

Definition at line 6950 of file mbgextio.c.

References _mbg_swab_stat_info, GPS_STAT_INFO, mbg_rc_is_error, mbg_rc_is_success, mbgextio_chk_user_perm(), mbgextio_req_data(), USER_PERM_RECEIVER, and USER_SCOPE_STATUS_READ_MSK.

◆ mbgextio_get_holdover_interval_counter()

int mbgextio_get_holdover_interval_counter	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		XMR_HOLDOVER_INTV *	p
	)

Read the XMR holdover interval counter.

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_set_holdover_interval

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_set_holdover_interval

Definition at line 8125 of file mbgextio.c.

References _mbg_swab_xmr_holdover_intv, GPS_XMR_HOLDOVER_INTV, mbg_rc_is_success, and mbgextio_req_data().

◆ mbgextio_get_ignore_lock()

int mbgextio_get_ignore_lock	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		IGNORE_LOCK *	p
	)

Read the status of ignore lock.

Note: Only supported if GPS_HAS_IGNORE_LOCK

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data

See also: mbgextio_set_ignore_lock

Returns: One of the MBG_RETURN_CODES

Definition at line 5873 of file mbgextio.c.

References _mbg_swab16, GPS_IGNORE_LOCK, mbg_rc_is_error, mbg_rc_is_success, mbgextio_chk_user_perm(), mbgextio_req_data(), USER_PERM_RECEIVER, and USER_SCOPE_CONFIG_READ_MSK.

◆ mbgextio_get_ims_fdm_info()

int mbgextio_get_ims_fdm_info	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		MBG_IMS_FDM_INFO *	p
	)

Read a MBG_IMS_FDM_INFO parameter structure from a device.

The MBG_IMS_FDM_INFO parameter structure contains the MBG_IMS_FDM_SETTINGS, the supported nominal frequencies and flags

Note: Only supported if MBG_IMS_STATE_FLAG_BIT_HAS_FDM is set in MBG_IMS_STATE::flags

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data

Returns: One of the MBG_RETURN_CODES

Definition at line 13242 of file mbgextio.c.

References _mbg_swab_mbg_ims_fdm_info, GPS_FDM_INFO, mbg_rc_is_error, mbg_rc_is_success, mbgextio_chk_user_perm(), mbgextio_req_data(), USER_PERM_FDM, and USER_SCOPE_CONFIG_READ_MSK.

◆ mbgextio_get_ims_fdm_limits()

int mbgextio_get_ims_fdm_limits	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		MBG_IMS_FDM_LIMITS *	p
	)

Read a MBG_IMS_FDM_LIMITS parameter structure from a device.

The MBG_IMS_FDM_LIMITS parameter structure contains the limits of the configurable parameters and number of outpus

Note: Only supported if MBG_IMS_STATE_FLAG_BIT_HAS_FDM is set in MBG_IMS_STATE::flags

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data

Returns: One of the MBG_RETURN_CODES

Definition at line 13273 of file mbgextio.c.

References _mbg_swab_mbg_ims_fdm_limits, GPS_FDM_LIMITS, mbg_rc_is_error, mbg_rc_is_success, mbgextio_chk_user_perm(), mbgextio_req_data(), USER_PERM_FDM, USER_SCOPE_CONFIG_READ_MSK, and USER_SCOPE_STATUS_READ_MSK.

◆ mbgextio_get_ims_fdm_output_info_idx()

int mbgextio_get_ims_fdm_output_info_idx	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		MBG_IMS_FDM_OUTPUT_INFO_IDX *	p,
		uint16_t	idx
	)

Read a MBG_IMS_FDM_OUTPUT_INFO_IDX parameter structure from a device.

The MBG_IMS_FDM_OUTPUT_INFO parameter structure contains the MBG_IMS_FDM_OUTPUT_SETTINGS, the supported modes and specific DAC limits

Note: Only supported if MBG_IMS_STATE_FLAG_BIT_HAS_FDM is set in MBG_IMS_STATE::flags

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data
[in]	idx	Index of the array element to be retrieved, 0..MBG_IMS_FDM_LIMITS::n_outputs-1

Returns: One of the MBG_RETURN_CODES

Definition at line 13305 of file mbgextio.c.

References _mbg_swab_mbg_ims_fdm_output_info_idx, GPS_FDM_OUTPUT_INFO_IDX, mbg_rc_is_error, mbg_rc_is_success, mbgextio_chk_user_perm(), mbgextio_req_data_idx(), USER_PERM_FDM, and USER_SCOPE_CONFIG_READ_MSK.

◆ mbgextio_get_ims_fdm_output_state_idx()

int mbgextio_get_ims_fdm_output_state_idx	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		MBG_IMS_FDM_OUTPUT_STATE_IDX *	p,
		uint16_t	idx
	)

Read a MBG_IMS_FDM_OUTPUT_STATE_IDX parameter structure from a device.

The MBG_IMS_FDM_OUTPUT_STATE parameter structure contains the current DAC val and specs and the configured mode

Note: Only supported if MBG_IMS_STATE_FLAG_BIT_HAS_FDM is set in MBG_IMS_STATE::flags

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data
[in]	idx	Index of the array element to be retrieved, 0..MBG_IMS_FDM_LIMITS::n_outputs-1

Returns: One of the MBG_RETURN_CODES

Definition at line 13338 of file mbgextio.c.

References _mbg_swab_mbg_ims_fdm_output_state_idx, GPS_FDM_OUTPUT_STATE_IDX, mbg_rc_is_error, mbg_rc_is_success, mbgextio_chk_user_perm(), mbgextio_req_data_idx(), USER_PERM_FDM, and USER_SCOPE_STATUS_READ_MSK.

◆ mbgextio_get_ims_fdm_state()

int mbgextio_get_ims_fdm_state	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		MBG_IMS_FDM_STATE *	p
	)

Read a MBG_IMS_FDM_STATE parameter structure from a device.

The MBG_IMS_FDM_STATE parameter structure contains the current frequency, the reference, powerline and sync time, the configured nominal frequency and flags

Note: Only supported if MBG_IMS_STATE_FLAG_BIT_HAS_FDM is set in MBG_IMS_STATE::flags

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data

Returns: One of the MBG_RETURN_CODES

Definition at line 13369 of file mbgextio.c.

References _mbg_swab_mbg_ims_fdm_state, GPS_FDM_STATE, mbg_rc_is_error, mbg_rc_is_success, mbgextio_chk_user_perm(), mbgextio_req_data(), USER_PERM_FDM, and USER_SCOPE_STATUS_READ_MSK.

◆ mbgextio_get_ims_sensor_state_idx()

int mbgextio_get_ims_sensor_state_idx	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		MBG_IMS_SENSOR_STATE_IDX *	p,
		uint16_t	idx
	)

Read sensor values from a specified sensor on the device.

Info on supported sensors can be retrieved using mbgextio_get_ims_state. Valid range for the sensor index is [0..MBG_IMS_STATE::num_sensors - 1].

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data
[in]	idx	The index of the array element to read

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_get_ims_state

Definition at line 8060 of file mbgextio.c.

References _mbg_swab_mbg_ims_sensor_state_idx, GPS_IMS_SENSOR_STATE_IDX, mbg_rc_is_error, mbg_rc_is_success, mbgextio_chk_user_perm(), mbgextio_req_data_idx(), USER_PERM_SENSORS, and USER_SCOPE_STATUS_READ_MSK.

◆ mbgextio_get_ims_state()

int mbgextio_get_ims_state	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		MBG_IMS_STATE *	p
	)

Read the current IMS state and supported IMS features.

Note: This is only supported if mbgextio_dev_has_ims returns MBG_SUCCESS

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_get_ims_sensor_state_idx

Definition at line 8026 of file mbgextio.c.

References _mbg_swab_mbg_ims_state, GPS_IMS_STATE, mbg_rc_is_error, mbg_rc_is_success, mbgextio_chk_user_perm(), mbgextio_req_data(), USER_PERM_SENSORS, and USER_SCOPE_STATUS_READ_MSK.

◆ mbgextio_get_io_port_info_idx()

int mbgextio_get_io_port_info_idx	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		MBG_IO_PORT_INFO_IDX *	p,
		uint8_t	idx
	)

Read I/O port info in MBG_IO_PORT_INFO_IDX format.

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to be read from the device
[in]	idx	Index of I/O port info to be read, 0..MBG_IO_PORT_LIMITS::num_ports - 1

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_get_io_port_limits; mbgextio_set_io_port_settings_idx; mbgextio_get_io_port_type_info_idx; mbgextio_get_io_port_status_idx

Definition at line 5522 of file mbgextio.c.

References _mbg_swab_io_port_info_idx, GPS_IO_PORT_INFO_IDX, MBG_MSG_BUFF::hdr, MSG_DATA::iop_info_idx, MSG_HDR::len, MBG_ERR_NBYTES, MBG_IO_PORT_INFO_IDX_MIN_SIZE, mbg_rc_is_error, MBG_SUCCESS, mbgextio_chk_user_perm(), mbgextio_get_rcv_buffer_addr(), mbgextio_req_data_idx(), MBG_MSG_BUFF::msg_data, MBG_MSG_BUFF::u, USER_PERM_IOPORTS, USER_SCOPE_CONFIG_READ_MSK, and USER_SCOPE_STATUS_READ_MSK.

◆ mbgextio_get_io_port_limits()

int mbgextio_get_io_port_limits	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		MBG_IO_PORT_LIMITS *	p
	)

Read I/O port limits in MBG_IO_PORT_LIMITS format.

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to be sent by the device

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_set_io_port_settings_idx; mbgextio_get_io_port_info_idx; mbgextio_get_io_port_type_info_idx; mbgextio_get_io_port_status_idx

Definition at line 5439 of file mbgextio.c.

References _mbg_swab_io_port_limits, GPS_IO_PORT_LIMITS, mbg_rc_is_error, mbg_rc_is_success, mbgextio_chk_user_perm(), mbgextio_req_data(), USER_PERM_IOPORTS, USER_SCOPE_CONFIG_READ_MSK, and USER_SCOPE_STATUS_READ_MSK.

◆ mbgextio_get_io_port_status_idx()

int mbgextio_get_io_port_status_idx	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		MBG_IO_PORT_STATUS_IDX *	p,
		uint8_t	idx
	)

Read I/O port status in MBG_IO_PORT_STATUS_IDX format.

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to be read from the device
[in]	idx	Index of I/O port to be read, 0..MBG_IO_PORT_LIMITS::num_ports - 1

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_get_io_port_limits; mbgextio_set_io_port_settings_idx; mbgextio_get_io_port_info_idx; mbgextio_get_io_port_type_info_idx

Definition at line 5626 of file mbgextio.c.

References _mbg_swab_io_port_status_idx, GPS_IO_PORT_STATUS_IDX, mbg_rc_is_error, mbg_rc_is_success, mbgextio_chk_user_perm(), mbgextio_req_data_idx(), USER_PERM_IOPORTS, and USER_SCOPE_STATUS_READ_MSK.

◆ mbgextio_get_io_port_type_info_idx()

int mbgextio_get_io_port_type_info_idx	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		MBG_IO_PORT_TYPE_INFO_IDX *	p,
		uint8_t	port_idx,
		uint8_t	port_type_idx
	)

Read I/O port type info in MBG_IO_PORT_TYPE_INFO_IDX format.

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to be read from the device
[in]	port_idx	Index of I/O port to be read, 0..MBG_IO_PORT_LIMITS::num_ports - 1
[in]	port_type_idx	Index of I/O port type info to be read, 0..MBG_IO_PORT_INFO::num_types - 1

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_get_io_port_limits; mbgextio_set_io_port_settings_idx; mbgextio_get_io_port_info_idx; mbgextio_get_io_port_status_idx

Definition at line 5574 of file mbgextio.c.

References _mbg_swab_io_port_type_info_idx, GPS_IO_PORT_TYPE_INFO_IDX, MBG_MSG_BUFF::hdr, MSG_DATA::iop_type_info_idx, MSG_HDR::len, MBG_ERR_NBYTES, MBG_IO_PORT_TYPE_INFO_IDX_MIN_SIZE, mbg_rc_is_error, MBG_SUCCESS, mbgextio_chk_user_perm(), mbgextio_get_rcv_buffer_addr(), mbgextio_req_data_idx(), MBG_MSG_BUFF::msg_data, MBG_MSG_BUFF::u, USER_PERM_IOPORTS, USER_SCOPE_CONFIG_READ_MSK, and USER_SCOPE_STATUS_READ_MSK.

◆ mbgextio_get_iono()

int mbgextio_get_iono	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		IONO *	p
	)

Read the ionospheric correction parameters from a device.

Note: Only supported by GPS receivers

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the IONO structure to return the received data

Returns: One of the MBG_RETURN_CODES

Definition at line 12962 of file mbgextio.c.

References _mbg_swab_dummy, GPS_IONO, mbg_rc_is_success, and mbgextio_req_data().

◆ mbgextio_get_ip4_settings()

int mbgextio_get_ip4_settings	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		IP4_SETTINGS *	p
	)

Read the lan ipv4 configuration state IP4_SETTINGS format.

Note: ptp or xmr with ntp feature must set

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data

Returns: One of the MBG_RETURN_CODES

See also: //##+++++++++++++

Definition at line 9051 of file mbgextio.c.

References _mbg_swab_ip4_settings, GPS_IP4_SETTINGS, mbg_rc_is_error, mbg_rc_is_success, mbgextio_chk_user_perm(), mbgextio_req_data(), USER_PERM_NETWORK, and USER_SCOPE_CONFIG_READ_MSK.

◆ mbgextio_get_ip4_state()

int mbgextio_get_ip4_state	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		IP4_SETTINGS *	p
	)

Read the current lan ipv4 state IP4_SETTINGS format.

Note: ptp or xmr with ntp feature must set

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data

Returns: One of the MBG_RETURN_CODES

See also: //##+++++++++++++

Definition at line 9120 of file mbgextio.c.

References _mbg_swab_ip4_settings, GPS_IP4_STATE, mbg_rc_is_error, mbg_rc_is_success, mbgextio_chk_user_perm(), mbgextio_req_data(), USER_PERM_NETWORK, and USER_SCOPE_STATUS_READ_MSK.

◆ mbgextio_get_irig_rx_info()

int mbgextio_get_irig_rx_info	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		IRIG_INFO *	p
	)

Read configuration info and supported features for the device's IRIG input.

Note: This is only supported if GPS_HAS_IRIG_RX is set in RECEIVER_INFO::features

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_set_irig_rx_settings

Definition at line 7133 of file mbgextio.c.

References _mbg_swab_irig_info, GPS_IRIG_RX_INFO, mbg_rc_is_error, mbg_rc_is_success, mbgextio_chk_user_perm(), mbgextio_req_data(), USER_PERM_IOPORTS, and USER_SCOPE_CONFIG_READ_MSK.

◆ mbgextio_get_irig_tx_info()

int mbgextio_get_irig_tx_info	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		IRIG_INFO *	p
	)

Read configuration info and supported features of the device's IRIG output.

Note: This is only supported if GPS_HAS_IRIG_TX is set in RECEIVER_INFO::features

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_set_irig_tx_settings

Definition at line 7062 of file mbgextio.c.

References _mbg_swab_irig_info, GPS_IRIG_TX_INFO, mbg_rc_is_error, mbg_rc_is_success, mbgextio_chk_user_perm(), mbgextio_req_data(), USER_PERM_IOPORTS, and USER_SCOPE_CONFIG_READ_MSK.

◆ mbgextio_get_lan_if_info()

int mbgextio_get_lan_if_info	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		LAN_IF_INFO *	p
	)

Read the lan interface configuration LAN_IF_INFO format.

Note: ptp or xmr with ntp feature must set

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data

Returns: One of the MBG_RETURN_CODES

See also: //##+++++++++++++

Definition at line 9019 of file mbgextio.c.

References _mbg_swab_lan_if_info, GPS_LAN_IF_INFO, mbg_rc_is_error, mbg_rc_is_success, mbgextio_chk_user_perm(), mbgextio_req_data(), USER_PERM_NETWORK, USER_SCOPE_CONFIG_READ_MSK, and USER_SCOPE_STATUS_READ_MSK.

◆ mbgextio_get_lne_limits()

int mbgextio_get_lne_limits	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		MBG_LNE_LIMITS *	p
	)

Read a MBG_IMS_FDM_STATE parameter structure from a device. ::TODO ###.

Note: Only supported if MBG_IMS_STATE_FLAG_BIT_HAS_FDM is set in ::TODO MBG_IMS_STATE::flags

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data

Returns: One of the MBG_RETURN_CODES

Definition at line 13537 of file mbgextio.c.

References _mbg_swab_mbg_lne_limits, GPS_LNE_LIMITS, mbg_rc_is_success, and mbgextio_req_data().

◆ mbgextio_get_lne_port_info_idx()

int mbgextio_get_lne_port_info_idx	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		MBG_LNE_PORT_INFO_IDX *	p,
		uint16_t	idx
	)

Read a MBG_LNE_PORT_INFO_IDX parameter structure from a device.

Note: ### ::TODO Only supported if MBG_IMS_STATE_FLAG_BIT_HAS_FDM is set in MBG_IMS_STATE::flags

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data
[in]	idx	Index of the array element to be retrieved, 0..MBG_LNE_LIMITS::num_ports-1

Returns: One of the MBG_RETURN_CODES

Definition at line 13563 of file mbgextio.c.

References _mbg_swab_mbg_lne_port_info_idx, GPS_LNE_PORT_INFO_IDX, mbg_rc_is_success, and mbgextio_req_data_idx().

◆ mbgextio_get_lne_port_settings_idx()

int mbgextio_get_lne_port_settings_idx	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		MBG_LNE_PORT_SETTINGS_IDX *	p,
		uint16_t	idx
	)

Read a MBG_LNE_PORT_SETTINGS_IDX parameter structure from a device.

Note: ### ::TODO Only supported if MBG_IMS_STATE_FLAG_BIT_HAS_FDM is set in MBG_IMS_STATE::flags

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data
[in]	idx	Index of the array element to be retrieved, 0..MBG_LNE_LIMITS::num_ports

Returns: One of the MBG_RETURN_CODES

Definition at line 13589 of file mbgextio.c.

References _mbg_swab_mbg_lne_port_settings_idx, GPS_LNE_PORT_SETTINGS_IDX, mbg_rc_is_success, and mbgextio_req_data_idx().

◆ mbgextio_get_monitoring_limits()

int mbgextio_get_monitoring_limits	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		MBG_MONITORING_LIMITS *	p
	)

Read the monitoring limits in MBG_MONITORING_LIMITS format.

Note: extended feature MBG_XFEATURE_MONITORING must be set

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_dev_has_monitoring

Definition at line 10143 of file mbgextio.c.

References _mbg_swab_monitoring_limits, GPS_MONITORING_LIMITS, mbg_rc_is_error, mbg_rc_is_success, mbgextio_chk_user_perm(), mbgextio_req_data(), USER_PERM_MONITORING, USER_SCOPE_CONFIG_READ_MSK, and USER_SCOPE_STATUS_READ_MSK.

◆ mbgextio_get_msg_rcv_timeout()

ulong mbgextio_get_msg_rcv_timeout ( const MBG_MSG_CTL * pmctl )

Get message receive timeout value.

Parameters

[in,out] pmctl Pointer to a valid message control structure

Returns: Current timeout value [ms]

See also: mbgextio_set_dev_poll_timeout; mbgextio_get_dev_poll_timeout; mbgextio_set_msg_rcv_timeout

Definition at line 3303 of file mbgextio.c.

◆ mbgextio_get_net_dns_srch_dom_idx()

int mbgextio_get_net_dns_srch_dom_idx	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		MBG_NET_NAME_IDX *	p,
		uint16_t	idx
	)

Read the network DNS search domain in MBG_NET_NAME_IDX format.

The number of DNS search domains supported by the device is specified in MBG_NET_GLB_CFG_INFO::n_supp_dns_srch_dom

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data
[in]	idx	Index of the array element to be retrieved, 0..MBG_NET_GLB_CFG_INFO::n_supp_dns_srch_dom - 1

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_set_net_dns_srch_dom_idx; mbgextio_get_net_stat_dns_srch_dom_stat_idx

Definition at line 12229 of file mbgextio.c.

References _mbg_swab_net_name_idx, GPS_NET_DNS_SRCH_DOM, mbg_rc_is_error, mbg_rc_is_success, mbgextio_chk_user_perm(), mbgextio_req_data_idx(), USER_PERM_NETWORK, and USER_SCOPE_CONFIG_READ_MSK.

◆ mbgextio_get_net_dns_srvr_idx()

int mbgextio_get_net_dns_srvr_idx	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		MBG_IP_ADDR_IDX *	p,
		uint16_t	idx
	)

Read a network DNS server entry in MBG_IP_ADDR_IDX format.

The number of DNS server provided by the device is specified in MBG_NET_GLB_CFG_INFO::n_supp_dns_srvr

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data
[in]	idx	Index of the array element to be retrieved, 0..MBG_NET_GLB_CFG_INFO::n_supp_dns_srvr - 1

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_set_net_dns_srvr_idx; mbgextio_get_net_stat_dns_srvr_idx

Definition at line 12153 of file mbgextio.c.

References _mbg_swab_ip_addr_idx, GPS_NET_DNS_SRVR, mbg_rc_is_error, mbg_rc_is_success, mbgextio_chk_user_perm(), mbgextio_req_data_idx(), USER_PERM_NETWORK, and USER_SCOPE_CONFIG_READ_MSK.

◆ mbgextio_get_net_glb_cfg_info()

int mbgextio_get_net_glb_cfg_info	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		MBG_NET_GLB_CFG_INFO *	p
	)

Read the network global config information MBG_NET_GLB_CFG_INFO format.

Note: GPS_HAS_NET_CFG must set

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_set_net_glb_cfg_settings

Definition at line 12082 of file mbgextio.c.

References _mbg_swab_net_glb_cfg_info, GPS_NET_GLB_CFG, mbg_rc_is_error, mbg_rc_is_success, mbgextio_chk_user_perm(), mbgextio_req_data(), USER_PERM_NETWORK, USER_SCOPE_CONFIG_READ_MSK, and USER_SCOPE_STATUS_READ_MSK.

◆ mbgextio_get_net_intf_addr_info_idx()

int mbgextio_get_net_intf_addr_info_idx	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		MBG_NET_INTF_ADDR_INFO_IDX *	p,
		uint16_t	idx
	)

Read MBG_NET_INTF_ADDR_INFO_IDX from the config with the given index.

Note: GPS_HAS_NET_CFG must be set and MBG_NET_GLB_SUPP_STAGE_2_MASK must be set in MBG_NET_GLB_CFG_INFO::feat_flags

The number of MBG_NET_INTF_ADDR_INFO_IDX provided by the device is specified in ::MBG_NET_GLB_CFG_INFO::glb_settings::num_intf_addr.

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data
[in]	idx	Index of the array element to be retrieved, 0..::MBG_NET_GLB_CFG_INFO::glb_settings::n_supp_intf_addr - 1

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_get_all_net_cfg_info

Definition at line 12451 of file mbgextio.c.

References _mbg_swab_net_intf_addr_info_idx, GPS_NET_INTF_ADDR_IDX, mbg_rc_is_error, mbg_rc_is_success, mbgextio_chk_user_perm(), mbgextio_req_data_idx(), USER_PERM_NETWORK, and USER_SCOPE_CONFIG_READ_MSK.

◆ mbgextio_get_net_intf_link_info_idx()

int mbgextio_get_net_intf_link_info_idx	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		MBG_NET_INTF_LINK_INFO_IDX *	p,
		uint16_t	idx
	)

Read MBG_NET_INTF_LINK_INFO_IDX from the config with the given index.

Note: GPS_HAS_NET_CFG must be set and MBG_NET_GLB_SUPP_STAGE_2_MASK must be set in MBG_NET_GLB_CFG_INFO::feat_flags

The number of MBG_NET_INTF_LINK_INFO_IDX provided by the device is specified in ::MBG_NET_GLB_CFG_INFO::glb_settings::num_intf_link.

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data
[in]	idx	Index of the array element to be retrieved, 0..::MBG_NET_GLB_CFG_INFO::glb_settings::num_intf_link - 1

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_get_all_net_cfg_info

Definition at line 12376 of file mbgextio.c.

References _mbg_swab_net_intf_link_info_idx, GPS_NET_INTF_LINK_IDX, mbg_rc_is_error, mbg_rc_is_success, mbgextio_chk_user_perm(), mbgextio_req_data_idx(), USER_PERM_NETWORK, and USER_SCOPE_CONFIG_READ_MSK.

◆ mbgextio_get_net_intf_route_info_idx()

int mbgextio_get_net_intf_route_info_idx	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		MBG_NET_INTF_ROUTE_INFO_IDX *	p,
		uint16_t	idx
	)

Read MBG_NET_INTF_ROUTE_INFO_IDX from the config with the given index.

Note: GPS_HAS_NET_CFG must be set and MBG_NET_GLB_SUPP_STAGE_2_MASK must be set in MBG_NET_GLB_CFG_INFO::feat_flags

The number of MBG_NET_INTF_ROUTE_INFO_IDX provided by the device is specified in ::MBG_NET_GLB_CFG_INFO::glb_settings::num_intf_route.

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data
[in]	idx	Index of the array element to be retrieved, 0..::MBG_NET_GLB_CFG_INFO::glb_settings::num_intf_route - 1

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_get_all_net_cfg_info

Definition at line 12526 of file mbgextio.c.

References _mbg_swab_net_intf_route_info_idx, GPS_NET_INTF_ROUTE_IDX, mbg_rc_is_error, mbg_rc_is_success, mbgextio_chk_user_perm(), mbgextio_req_data_idx(), USER_PERM_NETWORK, and USER_SCOPE_CONFIG_READ_MSK.

◆ mbgextio_get_net_stat_dns_srch_dom_stat_idx()

int mbgextio_get_net_stat_dns_srch_dom_stat_idx	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		MBG_NET_NAME_IDX *	p,
		uint16_t	idx
	)

Read the current network DNS search domain in MBG_NET_NAME_IDX format.

The number of DNS search domains supported by the device is specified in MBG_NET_GLB_CFG_INFO::n_supp_dns_srch_dom

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data
[in]	idx	Index of the array element to be retrieved, 0..MBG_NET_GLB_CFG_INFO::n_supp_dns_srch_dom - 1

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_set_net_dns_srch_dom_idx; mbgextio_get_net_dns_srch_dom_idx

Definition at line 12340 of file mbgextio.c.

References _mbg_swab_net_name_idx, GPS_NET_STAT_DNS_SRCH_DOM, mbg_rc_is_error, mbg_rc_is_success, mbgextio_chk_user_perm(), mbgextio_req_data_idx(), USER_PERM_NETWORK, and USER_SCOPE_STATUS_READ_MSK.

◆ mbgextio_get_net_stat_dns_srvr_idx()

int mbgextio_get_net_stat_dns_srvr_idx	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		MBG_IP_ADDR_IDX *	p,
		uint16_t	idx
	)

Read the current network DNS server in MBG_IP_ADDR_IDX format.

The number of DNS servers supported by the device is specified in MBG_NET_GLB_CFG_INFO::n_supp_dns_srvr

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data
[in]	idx	Index of the array element to be retrieved, 0..MBG_NET_GLB_CFG_INFO::n_supp_dns_srvr - 1

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_get_net_dns_srvr_idx; mbgextio_set_net_dns_srvr_idx

Definition at line 12305 of file mbgextio.c.

References _mbg_swab_ip_addr_idx, GPS_NET_STAT_DNS_SRVR, mbg_rc_is_error, mbg_rc_is_success, mbgextio_chk_user_perm(), mbgextio_req_data_idx(), USER_PERM_NETWORK, and USER_SCOPE_STATUS_READ_MSK.

◆ mbgextio_get_net_stat_glb_cfg_info()

int mbgextio_get_net_stat_glb_cfg_info	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		MBG_NET_GLB_CFG_INFO *	p
	)

Read the network global status information MBG_NET_GLB_CFG_INFO format.

Note: GPS_HAS_NET_CFG must be set and MBG_NET_GLB_SUPP_STAGE_2_MASK must be set in MBG_NET_GLB_CFG_INFO::feat_flags

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_set_net_glb_cfg_settings

Definition at line 12597 of file mbgextio.c.

References _mbg_swab_net_glb_cfg_info, GPS_NET_STAT_GLB_CFG, mbg_rc_is_error, mbg_rc_is_success, mbgextio_chk_user_perm(), mbgextio_req_data(), USER_PERM_NETWORK, and USER_SCOPE_STATUS_READ_MSK.

◆ mbgextio_get_net_stat_intf_addr_info_idx()

int mbgextio_get_net_stat_intf_addr_info_idx	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		MBG_NET_INTF_ADDR_INFO_IDX *	p,
		uint16_t	idx
	)

Read MBG_NET_INTF_ADDR_INFO_IDX from the status with the given index.

Note: GPS_HAS_NET_CFG must be set and MBG_NET_GLB_SUPP_STAGE_2_MASK must be set in MBG_NET_GLB_CFG_INFO::feat_flags

The number of MBG_NET_INTF_ADDR_INFO_IDX provided by the device is specified in ::MBG_NET_GLB_CFG_INFO::glb_settings::num_intf_addr.

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data
[in]	idx	Index of the array element to be retrieved, 0..::MBG_NET_GLB_CFG_INFO::glb_settings::num_intf_addr - 1

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_get_all_net_status_info

Definition at line 12669 of file mbgextio.c.

References _mbg_swab_net_intf_addr_info_idx, GPS_NET_STAT_INTF_ADDR_IDX, mbg_rc_is_error, mbg_rc_is_success, mbgextio_chk_user_perm(), mbgextio_req_data_idx(), USER_PERM_NETWORK, and USER_SCOPE_STATUS_READ_MSK.

◆ mbgextio_get_net_stat_intf_link_info_idx()

int mbgextio_get_net_stat_intf_link_info_idx	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		MBG_NET_INTF_LINK_INFO_IDX *	p,
		uint16_t	idx
	)

Read MBG_NET_INTF_LINK_INFO_IDX from the status with the given index.

Note: GPS_HAS_NET_CFG must be set and MBG_NET_GLB_SUPP_STAGE_2_MASK must be set in MBG_NET_GLB_CFG_INFO::feat_flags

The number of MBG_NET_INTF_LINK_INFO_IDX provided by the device is specified in ::MBG_NET_GLB_CFG_INFO::glb_settings::num_intf_link.

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data
[in]	idx	Index of the array element to be retrieved, 0..::MBG_NET_GLB_CFG_INFO::glb_settings::num_intf_link - 1

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_get_all_net_status_info

Definition at line 12633 of file mbgextio.c.

References _mbg_swab_net_intf_link_info_idx, GPS_NET_STAT_INTF_LINK_IDX, mbg_rc_is_error, mbg_rc_is_success, mbgextio_chk_user_perm(), mbgextio_req_data_idx(), USER_PERM_NETWORK, and USER_SCOPE_STATUS_READ_MSK.

◆ mbgextio_get_net_stat_intf_route_info_idx()

int mbgextio_get_net_stat_intf_route_info_idx	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		MBG_NET_INTF_ROUTE_INFO_IDX *	p,
		uint16_t	idx
	)

Read MBG_NET_INTF_ROUTE_INFO_IDX from the status with the given index.

Note: GPS_HAS_NET_CFG must be set and MBG_NET_GLB_SUPP_STAGE_2_MASK must be set in MBG_NET_GLB_CFG_INFO::feat_flags

The number of MBG_NET_INTF_ROUTE_INFO_IDX provided by the device is specified in ::MBG_NET_GLB_CFG_INFO::glb_settings::num_intf_route.

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data
[in]	idx	Index of the array element to be retrieved, 0..::MBG_NET_GLB_CFG_INFO::glb_settings::num_intf_route - 1

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_get_all_net_status_info

Definition at line 12705 of file mbgextio.c.

References _mbg_swab_net_intf_route_info_idx, GPS_NET_STAT_INTF_ROUTE_IDX, mbg_rc_is_error, mbg_rc_is_success, mbgextio_chk_user_perm(), mbgextio_req_data_idx(), USER_PERM_NETWORK, and USER_SCOPE_STATUS_READ_MSK.

◆ mbgextio_get_next_evt_log_entry()

int mbgextio_get_next_evt_log_entry	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		MBG_EVT_LOG_ENTRY *	p
	)

Return the next entry from the on-board event log.

This increments an internal counter, so subsequent calls will return subsequent entries. mbgextio_get_first_evt_log_entry should be called first to reset the counter and retrieve the oldest log entry.

Note: Some devices don't provide an on-board event log

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_clr_evt_log; mbgextio_get_num_evt_log_entries; mbgextio_get_first_evt_log_entry

Definition at line 7993 of file mbgextio.c.

References _mbg_swab_mbg_evt_log_entry, GPS_NEXT_EVT_LOG_ENTRY, mbg_rc_is_error, mbg_rc_is_success, mbgextio_chk_user_perm(), mbgextio_req_data(), USER_PERM_MONITORING, and USER_SCOPE_STATUS_READ_MSK.

◆ mbgextio_get_ntp_clnt_mode_info()

int mbgextio_get_ntp_clnt_mode_info	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		NTP_CLNT_MODE_INFO *	p
	)

Read the ntp global information NTP_CLNT_MODE_INFO format.

Note: ntp feature must set; ntp client mode must set

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_get_ntp_glb_info; mbgextio_set_ntp_clnt_mode_cfg; mbgextio_get_ntp_peer_settings_idx; mbgextio_set_ntp_peer_settings_idx

Definition at line 11676 of file mbgextio.c.

References _mbg_swab_ntp_clnt_mode_info, GPS_NTP_CLNT_MODE_CFG, mbg_rc_is_error, mbg_rc_is_success, mbgextio_chk_user_perm(), mbgextio_req_data(), USER_PERM_NTP, USER_SCOPE_CONFIG_READ_MSK, and USER_SCOPE_STATUS_READ_MSK.

◆ mbgextio_get_ntp_glb_info()

int mbgextio_get_ntp_glb_info	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		NTP_GLB_INFO *	p
	)

Read the ntp global information NTP_GLB_INFO format.

Note: ntp feature must set

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_get_ntp_clnt_mode_info; mbgextio_get_ntp_peer_settings_idx; mbgextio_set_ntp_peer_settings_idx

Definition at line 11305 of file mbgextio.c.

References _mbg_swab_ntp_glb_info, GPS_NTP_GLB_CFG, mbg_rc_is_error, mbg_rc_is_success, mbgextio_chk_user_perm(), mbgextio_req_data(), USER_PERM_NTP, USER_SCOPE_CONFIG_READ_MSK, and USER_SCOPE_STATUS_READ_MSK.

◆ mbgextio_get_ntp_misc_limits()

int mbgextio_get_ntp_misc_limits	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		NTP_MISC_LIMITS *	p
	)

Read the NTP misc limits in NTP_MISC_LIMITS format.

Note: NTP_MSK_MISCELLANEOUS must be set in NTP_GLB_INFO::supp_flags

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_get_ntp_glb_info

Definition at line 11564 of file mbgextio.c.

References _mbg_swab_ntp_misc_limits, GPS_NTP_MISC_LIMITS, mbg_rc_is_error, mbg_rc_is_success, mbgextio_chk_user_perm(), mbgextio_req_data(), USER_PERM_NTP, and USER_SCOPE_CONFIG_READ_MSK.

◆ mbgextio_get_ntp_misc_orphan_mode_info()

int mbgextio_get_ntp_misc_orphan_mode_info	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		NTP_MISC_ORPHAN_MODE_INFO *	p
	)

Read the NTP orphan mode information in NTP_MISC_ORPHAN_MODE_INFO format.

Note: NTP_MISC_MSK_ORPHAN_MODE must be set in NTP_MISC_LIMITS::supp_flags

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_get_ntp_glb_info; mbgextio_get_ntp_misc_limits; mbgextio_set_ntp_misc_orphan_mode_settings

Definition at line 11598 of file mbgextio.c.

References _mbg_swab_ntp_misc_orphan_mode_info, GPS_NTP_MISC_ORPHAN_MODE, mbg_rc_is_error, mbg_rc_is_success, mbgextio_chk_user_perm(), mbgextio_req_data(), USER_PERM_NTP, and USER_SCOPE_CONFIG_READ_MSK.

◆ mbgextio_get_ntp_peer_settings_idx()

int mbgextio_get_ntp_peer_settings_idx	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		NTP_PEER_SETTINGS_IDX *	p,
		uint16_t	idx
	)

Read the ntp peer settings of current idx NTP_PEER_SETTINGS format.

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data
[in]	idx	Index of the NTP peer settings to be configured, 0 ... NTP_CLNT_MODE_INFO::n_supp_peers - 1

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_get_ntp_glb_info; mbgextio_set_ntp_peer_settings_idx; mbgextio_get_ntp_clnt_mode_info

Definition at line 11752 of file mbgextio.c.

References _mbg_swab_ntp_peer_settings_idx, GPS_NTP_PEER_SETTINGS_IDX, mbg_rc_is_error, mbg_rc_is_success, mbgextio_chk_user_perm(), mbgextio_req_data_idx(), USER_PERM_NTP, and USER_SCOPE_CONFIG_READ_MSK.

◆ mbgextio_get_ntp_peer_state_idx()

int mbgextio_get_ntp_peer_state_idx	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		NTP_PEER_STATE_IDX *	p,
		uint16_t	idx
	)

Read the NTP peer state of current idx NTP_PEER_STATE format.

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data
[in]	idx	Index of the NTP peer state to be read, 0 ... NTP_CLNT_MODE_SETTINGS::num_peers - 1

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_get_ntp_sys_state; mbgextio_get_ntp_peer_settings_idx; mbgextio_get_ntp_clnt_mode_info

Definition at line 12016 of file mbgextio.c.

References _mbg_swab_ntp_peer_state_idx, GPS_NTP_PEER_STATE_IDX, mbg_rc_is_error, mbg_rc_is_success, mbgextio_chk_user_perm(), mbgextio_req_data_idx(), USER_PERM_NTP, and USER_SCOPE_STATUS_READ_MSK.

◆ mbgextio_get_ntp_refclk_cfg_info_idx()

int mbgextio_get_ntp_refclk_cfg_info_idx	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		NTP_REFCLK_CFG_INFO_IDX *	p,
		uint16_t	idx
	)

Read the NTP refclock config info with the given index in NTP_REFCLK_CFG_INFO_IDX format.

Note: NTP feature GPS_FEAT_NTP must be set; NTP roles NTP_ROLE_SERVER or NTP_ROLE_CLIENT_SERVER must be set in NTP_GLB_INFO::supp_ntp_roles

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data
[in]	idx	Index of the NTP refclock config to be queried, 0 ... NTP_SRV_MODE_SETTINGS::num_refclks - 1

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_get_ntp_glb_info; mbgextio_get_ntp_srv_mode_info; mbgextio_set_ntp_refclk_cfg_settings_idx

Definition at line 11904 of file mbgextio.c.

References _mbg_swab_ntp_refclk_cfg_info_idx, GPS_NTP_REFCLK_CFG, mbg_rc_is_error, mbg_rc_is_success, mbgextio_chk_user_perm(), mbgextio_req_data_idx(), USER_PERM_NTP, and USER_SCOPE_CONFIG_READ_MSK.

◆ mbgextio_get_ntp_refclk_state_idx()

int mbgextio_get_ntp_refclk_state_idx	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		NTP_REFCLK_STATE_IDX *	p,
		uint16_t	idx
	)

Read the NTP refclock state of current idx in NTP_REFCLK_STATE format.

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data
[in]	idx	Index of the NTP refclk state to be read, 0 ... NTP_SRV_MODE_SETTINGS::num_refclks - 1

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_get_ntp_sys_state; mbgextio_get_ntp_refclk_cfg_info_idx; mbgextio_get_ntp_srv_mode_info

Definition at line 12050 of file mbgextio.c.

References _mbg_swab_ntp_refclk_state_idx, GPS_NTP_REFCLK_STATE_IDX, mbg_rc_is_error, mbg_rc_is_success, mbgextio_chk_user_perm(), mbgextio_req_data_idx(), USER_PERM_NTP, and USER_SCOPE_STATUS_READ_MSK.

◆ mbgextio_get_ntp_srv_mode_info()

int mbgextio_get_ntp_srv_mode_info	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		NTP_SRV_MODE_INFO *	p
	)

Read the ntp server mode information in NTP_SRV_MODE_INFO format.

Note: NTP feature GPS_FEAT_NTP must be set; NTP roles NTP_ROLE_SERVER or NTP_ROLE_CLIENT_SERVER must be set in NTP_GLB_INFO::supp_ntp_roles

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_get_ntp_glb_info; mbgextio_set_ntp_srv_mode_cfg

Definition at line 11830 of file mbgextio.c.

References _mbg_swab_ntp_srv_mode_info, GPS_NTP_SRV_MODE_CFG, mbg_rc_is_error, mbg_rc_is_success, mbgextio_chk_user_perm(), mbgextio_req_data(), USER_PERM_NTP, USER_SCOPE_CONFIG_READ_MSK, and USER_SCOPE_STATUS_READ_MSK.

◆ mbgextio_get_ntp_symm_key_info_idx()

int mbgextio_get_ntp_symm_key_info_idx	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		NTP_SYMM_KEY_INFO_IDX *	p,
		uint16_t	idx
	)

Read the NTP symmetric key info with the given index in NTP_SYMM_KEY_INFO_IDX format.

Note: NTP_MSK_SYMM_KEYS must be set in NTP_GLB_INFO::supp_flags

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data
[in]	idx	Index of the NTP symmetric key info to be queried, 0 ... NTP_GLB_SETTINGS::num_symm_keys - 1

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_get_ntp_glb_info; mbgextio_get_ntp_symm_key_limits; mbgextio_set_ntp_symm_key_settings_idx

Definition at line 11411 of file mbgextio.c.

References _mbg_swab_ntp_symm_key_info_idx, GPS_NTP_SYMM_KEY_CFG, mbg_rc_is_error, mbg_rc_is_success, mbgextio_chk_user_perm(), mbgextio_req_data_idx(), USER_PERM_NTP, and USER_SCOPE_CONFIG_READ_MSK.

◆ mbgextio_get_ntp_symm_key_limits()

int mbgextio_get_ntp_symm_key_limits	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		NTP_SYMM_KEY_LIMITS *	p
	)

Read the NTP symmetric key limits in NTP_SYMM_KEY_LIMITS format.

Note: NTP_MSK_SYMM_KEYS must be set in NTP_GLB_INFO::supp_flags

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_get_ntp_glb_info

Definition at line 11376 of file mbgextio.c.

References _mbg_swab_ntp_symm_key_limits, GPS_NTP_SYMM_KEY_LIMITS, mbg_rc_is_error, mbg_rc_is_success, mbgextio_chk_user_perm(), mbgextio_req_data(), USER_PERM_NTP, and USER_SCOPE_CONFIG_READ_MSK.

◆ mbgextio_get_ntp_sys_state()

int mbgextio_get_ntp_sys_state	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		NTP_SYS_STATE *	p
	)

Read the current system state of ntp device NTP_SYS_STATE format.

Note: NTP feature must set

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_set_ntp_clnt_mode_cfg; mbgextio_get_ntp_glb_info

Definition at line 11982 of file mbgextio.c.

References _mbg_swab_ntp_sys_state, GPS_NTP_SYS_STATE, mbg_rc_is_error, mbg_rc_is_success, mbgextio_chk_user_perm(), mbgextio_req_data(), USER_PERM_NTP, and USER_SCOPE_STATUS_READ_MSK.

◆ mbgextio_get_ntp_trusted_key_info_idx()

int mbgextio_get_ntp_trusted_key_info_idx	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		NTP_TRUSTED_KEY_INFO_IDX *	p,
		uint16_t	idx
	)

Read the NTP trusted key info with the given index in NTP_TRUSTED_KEY_INFO_IDX format.

Note: NTP_MSK_TRUSTED_KEYS must be set in NTP_GLB_INFO::supp_flags

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data
[in]	idx	Index of the NTP trusted key info to be queried, 0 ... NTP_GLB_SETTINGS::num_trusted_keys - 1

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_get_ntp_glb_info; mbgextio_set_ntp_trusted_key_settings_idx

Definition at line 11489 of file mbgextio.c.

References _mbg_swab_ntp_trusted_key_info_idx, GPS_NTP_TRUSTED_KEY_CFG, mbg_rc_is_error, mbg_rc_is_success, mbgextio_chk_user_perm(), mbgextio_req_data_idx(), USER_PERM_NTP, and USER_SCOPE_CONFIG_READ_MSK.

◆ mbgextio_get_num_evt_log_entries()

int mbgextio_get_num_evt_log_entries	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		MBG_NUM_EVT_LOG_ENTRIES *	p
	)

Read the current number of entries in the on-board event log.

Note: Some devices don't provide an on-board event log

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_clr_evt_log; mbgextio_get_first_evt_log_entry; mbgextio_get_next_evt_log_entry

Definition at line 7915 of file mbgextio.c.

References _mbg_swab_mbg_num_evt_log_entries, GPS_NUM_EVT_LOG_ENTRIES, mbg_rc_is_error, mbg_rc_is_success, mbgextio_chk_user_perm(), mbgextio_req_data(), USER_PERM_MONITORING, and USER_SCOPE_STATUS_READ_MSK.

◆ mbgextio_get_opt_info()

int mbgextio_get_opt_info	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		MBG_OPT_INFO *	p
	)

Read current optional settings and supported options.

Note: This is only supported if GPS_HAS_OPT_SETTINGS is set in RECEIVER_INFO::features

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_set_opt_settings

Definition at line 7343 of file mbgextio.c.

References _mbg_swab_mbg_opt_info, GPS_OPT_INFO, mbg_rc_is_success, and mbgextio_req_data().

◆ mbgextio_get_port_info_idx()

int mbgextio_get_port_info_idx	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		PORT_INFO_IDX *	p,
		uint16_t	idx
	)

Read current settings and capabilities of a specific serial port.

The number of serial ports provided by the device is specified in RECEIVER_INFO::n_com_ports.

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data
[in]	idx	Index of the array element to be retrieved, 0..RECEIVER_INFO::n_com_ports - 1

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_get_all_port_info; mbgextio_set_port_settings_idx

Definition at line 7491 of file mbgextio.c.

References _mbg_swab_port_info_idx, GPS_PORT_INFO_IDX, mbg_rc_is_error, mbg_rc_is_success, mbgextio_chk_user_perm(), mbgextio_req_data_idx(), USER_PERM_SERIAL, and USER_SCOPE_CONFIG_READ_MSK.

Referenced by mbgextio_get_all_port_info().

◆ mbgextio_get_port_parm()

int mbgextio_get_port_parm	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		PORT_PARM *	p
	)

Read serial port parameters in PORT_PARM format.

Deprecated:: This function is deprecated since the PORT_PARM structure supports only 2 serial ports, and does not not support configuration of a string type. The function mbgextio_get_serial_settings should be used instead.

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_get_serial_settings; mbgextio_save_serial_settings; mbgextio_set_port_parm; mbgextio_setup_receiver_info

Deprecated:: This function is deprecated since the PORT_PARM structure supports only 2 serial ports, and does not not support configuration of a string type. The function mbgextio_get_serial_settings should be used instead.

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_get_serial_settings; mbgextio_save_serial_settings; mbgextio_set_port_parm; mbgextio_setup_receiver_info

Definition at line 6266 of file mbgextio.c.

References _mbg_swab_port_parm, GPS_PORT_PARM, mbg_rc_is_success, and mbgextio_req_data().

◆ mbgextio_get_pos()

int mbgextio_get_pos	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		POS *	p_pos
	)

Read the current receiver position as POS structure.

Note: This function is only supported by GPS receivers

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p_pos	Pointer to the data structure to return the received data

Returns: One of the MBG_RETURN_CODES

Definition at line 6152 of file mbgextio.c.

References POS::lla, lla_to_dms(), mbg_rc_is_error, mbgextio_chk_user_perm(), mbgextio_get_pos_lla(), mbgextio_get_pos_xyz(), USER_PERM_RECEIVER, USER_SCOPE_CONFIG_READ_MSK, USER_SCOPE_STATUS_READ_MSK, and POS::xyz.

◆ mbgextio_get_pos_lla()

int mbgextio_get_pos_lla	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		LLA	lla
	)

Read the current receiver position as LLA array.

Note: This function is only supported by GPS receivers

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	lla	Pointer to the data array to return the received data

Returns: One of the MBG_RETURN_CODES

Definition at line 6080 of file mbgextio.c.

References GPS_POS_LLA, mbg_rc_is_error, mbg_rc_is_success, mbgextio_chk_user_perm(), mbgextio_req_data(), N_LLA, swap_double(), USER_PERM_RECEIVER, USER_SCOPE_CONFIG_READ_MSK, and USER_SCOPE_STATUS_READ_MSK.

Referenced by mbgextio_get_pos().

◆ mbgextio_get_pos_xyz()

int mbgextio_get_pos_xyz	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		XYZ	xyz
	)

Read the current receiver position as XYZ array.

Note: This function is only supported by GPS receivers

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	xyz	Pointer to the data array to return the received data

Returns: One of the MBG_RETURN_CODES

Definition at line 6116 of file mbgextio.c.

References GPS_POS_XYZ, mbg_rc_is_error, mbg_rc_is_success, mbgextio_chk_user_perm(), mbgextio_req_data(), N_XYZ, swap_double(), USER_PERM_RECEIVER, USER_SCOPE_CONFIG_READ_MSK, and USER_SCOPE_STATUS_READ_MSK.

Referenced by mbgextio_get_pos().

◆ mbgextio_get_pout_info_idx()

int mbgextio_get_pout_info_idx	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		POUT_INFO_IDX *	p,
		uint16_t	idx
	)

Read current settings and capabilities of a specific programmable pulse output.

The number of supported pulse outputs is specified in RECEIVER_INFO::n_prg_out.

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data
[in]	idx	Index of the array element to be retrieved, 0..RECEIVER_INFO::n_prg_out - 1

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_get_all_pout_info; mbgextio_set_pout_settings_idx

Definition at line 7619 of file mbgextio.c.

References _mbg_swab_pout_info_idx_on_get, GPS_POUT_INFO_IDX, mbg_rc_is_error, mbg_rc_is_success, mbgextio_chk_user_perm(), mbgextio_req_data_idx(), USER_PERM_IOPORTS, and USER_SCOPE_CONFIG_READ_MSK.

Referenced by mbgextio_get_all_pout_info().

◆ mbgextio_get_ptp_cfg_info()

int mbgextio_get_ptp_cfg_info	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		PTP_CFG_INFO *	p
	)

Read the ptp configuration PTP_CFG_INFO format.

Note: ptp feature must set

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data

Returns: One of the MBG_RETURN_CODES

See also: //##+++++++++++++

Definition at line 9185 of file mbgextio.c.

References _mbg_swab_ptp_cfg_info, GPS_PTP_CFG, mbg_rc_is_error, mbg_rc_is_success, mbgextio_chk_user_perm(), mbgextio_req_data(), USER_PERM_PTP, and USER_SCOPE_CONFIG_READ_MSK.

◆ mbgextio_get_ptp_smpte_tlv_state()

int mbgextio_get_ptp_smpte_tlv_state	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		PTP_SMPTE_PROFILE_CFG *	p
	)

Read the current SMPTE TLV.

Note: SMPTE TLV status feature must set

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data

Returns: One of the MBG_RETURN_CODES

See also: //##+++++++++++++

Definition at line 10115 of file mbgextio.c.

References _mbg_swab_dummy, GPS_PTP_SMPTE_TLV, mbg_rc_is_success, and mbgextio_req_data().

◆ mbgextio_get_ptp_state()

int mbgextio_get_ptp_state	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		PTP_STATE *	p
	)

Read the current state of PTP device PTP_STATE format.

Note: ptp feature must set

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data

Returns: One of the MBG_RETURN_CODES

See also: //##+++++++++++++

Definition at line 9152 of file mbgextio.c.

References _mbg_swab_ptp_state, GPS_PTP_STATE, mbg_rc_is_error, mbg_rc_is_success, mbgextio_chk_user_perm(), mbgextio_req_data(), USER_PERM_PTP, and USER_SCOPE_STATUS_READ_MSK.

◆ mbgextio_get_ptp_uc_master_cfg_limits()

int mbgextio_get_ptp_uc_master_cfg_limits	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		PTP_UC_MASTER_CFG_LIMITS *	p
	)

Read the ptp configuration PTP_UC_MASTER_CFG_LIMITS format.

Note: ptp feature must set

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data

Returns: One of the MBG_RETURN_CODES

See also: //##+++++++++++++

Definition at line 9218 of file mbgextio.c.

References _mbg_swab_ptp_uc_master_cfg_limits, GPS_PTP_UC_MASTER_CFG_LIMITS, mbg_rc_is_error, mbg_rc_is_success, mbgextio_chk_user_perm(), mbgextio_req_data(), USER_PERM_PTP, and USER_SCOPE_CONFIG_READ_MSK.

◆ mbgextio_get_ptp_v1_current_dataset()

int mbgextio_get_ptp_v1_current_dataset	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		MBG_PTP_V1_CURRENT_DATASET *	p
	)

Read the PTPv1 current dataset in MBG_PTP_V1_CURRENT_DATASET format.

Note: only supported if PTP_CFG_MSK_HAS_V1_COMMON_DATASETS is set in PTP_CFG_INFO::supp_flags

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_get_ptp_cfg_info; mbgextio_set_ptp_v1_current_dataset

Definition at line 9453 of file mbgextio.c.

References _mbg_swab_ptp_v1_current_dataset, GPS_PTP_V1_CURRENT_DS, mbg_rc_is_error, mbg_rc_is_success, mbgextio_chk_user_perm(), mbgextio_req_data(), USER_PERM_PTP, USER_SCOPE_CONFIG_READ_MSK, and USER_SCOPE_STATUS_READ_MSK.

◆ mbgextio_get_ptp_v1_default_dataset()

int mbgextio_get_ptp_v1_default_dataset	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		MBG_PTP_V1_DEFAULT_DATASET *	p
	)

Read the PTPv1 default dataset in MBG_PTP_V1_DEFAULT_DATASET format.

Note: This is only supported if PTP_CFG_MSK_HAS_V1_COMMON_DATASETS is set in PTP_CFG_INFO::supp_flags

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_get_ptp_cfg_info; mbgextio_set_ptp_v1_default_dataset

Definition at line 9380 of file mbgextio.c.

References _mbg_swab_ptp_v1_default_dataset, GPS_PTP_V1_DEFAULT_DS, mbg_rc_is_error, mbg_rc_is_success, mbgextio_chk_user_perm(), mbgextio_req_data(), USER_PERM_PTP, USER_SCOPE_CONFIG_READ_MSK, and USER_SCOPE_STATUS_READ_MSK.

◆ mbgextio_get_ptp_v1_parent_dataset()

int mbgextio_get_ptp_v1_parent_dataset	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		MBG_PTP_V1_PARENT_DATASET *	p
	)

Read the PTPv1 parent dataset in MBG_PTP_V1_PARENT_DATASET format.

Note: only supported if PTP_CFG_MSK_HAS_V1_COMMON_DATASETS is set in PTP_CFG_INFO::supp_flags

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_get_ptp_cfg_info; mbgextio_set_ptp_v1_parent_dataset

Definition at line 9526 of file mbgextio.c.

References _mbg_swab_ptp_v1_parent_dataset, GPS_PTP_V1_PARENT_DS, mbg_rc_is_error, mbg_rc_is_success, mbgextio_chk_user_perm(), mbgextio_req_data(), USER_PERM_PTP, USER_SCOPE_CONFIG_READ_MSK, and USER_SCOPE_STATUS_READ_MSK.

◆ mbgextio_get_ptp_v1_port_dataset_idx()

int mbgextio_get_ptp_v1_port_dataset_idx	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		MBG_PTP_V1_PORT_DATASET_IDX *	p,
		uint16_t	idx
	)

Read the PTPv1 port dataset with the appropriate index in MBG_PTP_V1_PORT_DATASET_IDX format.

Note: only supported if PTP_CFG_MSK_HAS_V1_COMMON_DATASETS is set in PTP_CFG_INFO::supp_flags

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data
[in]	idx	Index of the port dataset be received, 0..MBG_PTP_V1_DEFAULT_DATASET::number_ports - 1

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_get_ptp_cfg_info; mbgextio_set_ptp_v1_port_dataset_idx

Definition at line 9673 of file mbgextio.c.

References _mbg_swab_ptp_v1_port_dataset_idx, GPS_PTP_V1_PORT_DS_IDX, mbg_rc_is_error, mbg_rc_is_success, mbgextio_chk_user_perm(), mbgextio_req_data_idx(), USER_PERM_PTP, USER_SCOPE_CONFIG_READ_MSK, and USER_SCOPE_STATUS_READ_MSK.

◆ mbgextio_get_ptp_v1_time_properties_dataset()

int mbgextio_get_ptp_v1_time_properties_dataset	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		MBG_PTP_V1_TIME_PROPERTIES_DATASET *	p
	)

Read the PTPv1 time properties dataset in MBG_PTP_V1_TIME_PROPERTIES_DATASET format.

Note: only supported if PTP_CFG_MSK_HAS_V1_COMMON_DATASETS is set in PTP_CFG_INFO::supp_flags

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_get_ptp_cfg_info; mbgextio_set_ptp_v1_time_properties_dataset

Definition at line 9599 of file mbgextio.c.

References _mbg_swab_ptp_v1_time_properties_dataset, GPS_PTP_V1_TIME_PROP_DS, mbg_rc_is_error, mbg_rc_is_success, mbgextio_chk_user_perm(), mbgextio_req_data(), USER_PERM_PTP, USER_SCOPE_CONFIG_READ_MSK, and USER_SCOPE_STATUS_READ_MSK.

◆ mbgextio_get_ptp_v2_current_dataset()

int mbgextio_get_ptp_v2_current_dataset	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		MBG_PTP_V2_CURRENT_DATASET *	p
	)

Read the PTPv2 current dataset in MBG_PTP_V2_CURRENT_DATASET format.

Note: only supported if PTP_CFG_MSK_HAS_V2_COMMON_DATASETS is set in PTP_CFG_INFO::supp_flags

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_get_ptp_cfg_info; mbgextio_set_ptp_v2_current_dataset

Definition at line 9821 of file mbgextio.c.

References _mbg_swab_ptp_v2_current_dataset, GPS_PTP_V2_CURRENT_DS, mbg_rc_is_error, mbg_rc_is_success, mbgextio_chk_user_perm(), mbgextio_req_data(), USER_PERM_PTP, USER_SCOPE_CONFIG_READ_MSK, and USER_SCOPE_STATUS_READ_MSK.

◆ mbgextio_get_ptp_v2_default_dataset()

int mbgextio_get_ptp_v2_default_dataset	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		MBG_PTP_V2_DEFAULT_DATASET *	p
	)

Read the PTPv2 default dataset in MBG_PTP_V2_DEFAULT_DATASET format.

Note: This is only supported if PTP_CFG_MSK_HAS_V2_COMMON_DATASETS is set in PTP_CFG_INFO::supp_flags

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_get_ptp_cfg_info; mbgextio_set_ptp_v2_default_dataset

Definition at line 9748 of file mbgextio.c.

References _mbg_swab_ptp_v2_default_dataset, GPS_PTP_V2_DEFAULT_DS, mbg_rc_is_error, mbg_rc_is_success, mbgextio_chk_user_perm(), mbgextio_req_data(), USER_PERM_PTP, USER_SCOPE_CONFIG_READ_MSK, and USER_SCOPE_STATUS_READ_MSK.

◆ mbgextio_get_ptp_v2_parent_dataset()

int mbgextio_get_ptp_v2_parent_dataset	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		MBG_PTP_V2_PARENT_DATASET *	p
	)

Read the PTPv2 parent dataset in MBG_PTP_V2_PARENT_DATASET format.

Note: only supported if PTP_CFG_MSK_HAS_V2_COMMON_DATASETS is set in PTP_CFG_INFO::supp_flags

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_get_ptp_cfg_info; mbgextio_set_ptp_v2_parent_dataset

Definition at line 9894 of file mbgextio.c.

References _mbg_swab_ptp_v2_parent_dataset, GPS_PTP_V2_PARENT_DS, mbg_rc_is_error, mbg_rc_is_success, mbgextio_chk_user_perm(), mbgextio_req_data(), USER_PERM_PTP, USER_SCOPE_CONFIG_READ_MSK, and USER_SCOPE_STATUS_READ_MSK.

◆ mbgextio_get_ptp_v2_port_dataset_idx()

int mbgextio_get_ptp_v2_port_dataset_idx	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		MBG_PTP_V2_PORT_DATASET_IDX *	p,
		uint16_t	idx
	)

Read the PTPv2 port dataset with the appropriate index in MBG_PTP_V2_PORT_DATASET_IDX format.

Note: only supported if PTP_CFG_MSK_HAS_V2_COMMON_DATASETS is set in PTP_CFG_INFO::supp_flags

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data
[in]	idx	Index of the port dataset be received, 0..MBG_PTP_V2_DEFAULT_DATASET::number_ports - 1

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_get_ptp_cfg_info; mbgextio_set_ptp_v2_port_dataset_idx

Definition at line 10041 of file mbgextio.c.

References _mbg_swab_ptp_v2_port_dataset_idx, GPS_PTP_V2_PORT_DS_IDX, mbg_rc_is_error, mbg_rc_is_success, mbgextio_chk_user_perm(), mbgextio_req_data_idx(), USER_PERM_PTP, USER_SCOPE_CONFIG_READ_MSK, and USER_SCOPE_STATUS_READ_MSK.

◆ mbgextio_get_ptp_v2_time_properties_dataset()

int mbgextio_get_ptp_v2_time_properties_dataset	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		MBG_PTP_V2_TIME_PROPERTIES_DATASET *	p
	)

Read the PTPv2 time properties dataset in MBG_PTP_V2_TIME_PROPERTIES_DATASET format.

Note: only supported if PTP_CFG_MSK_HAS_V2_COMMON_DATASETS is set in PTP_CFG_INFO::supp_flags

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_get_ptp_cfg_info; mbgextio_set_ptp_v2_time_properties_dataset

Definition at line 9967 of file mbgextio.c.

References _mbg_swab_ptp_v2_time_properties_dataset, GPS_PTP_V2_TIME_PROP_DS, mbg_rc_is_error, mbg_rc_is_success, mbgextio_chk_user_perm(), mbgextio_req_data(), USER_PERM_PTP, USER_SCOPE_CONFIG_READ_MSK, and USER_SCOPE_STATUS_READ_MSK.

◆ mbgextio_get_pwr_ctl()

int mbgextio_get_pwr_ctl	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		MBG_PWR_CTL *	p
	)

Read a MBG_PWR_CTL parameter structure from a device.

Note: ### ::TODO Only supported if MBG_XFEATURE_PWR_CTL_API is set

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data

Returns: One of the MBG_RETURN_CODES

Definition at line 13676 of file mbgextio.c.

References _mbg_swab_mbg_pwr_ctl, GPS_PWR_CTL, mbg_rc_is_success, and mbgextio_req_data().

◆ mbgextio_get_raw_irig_data()

int mbgextio_get_raw_irig_data	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		MBG_RAW_IRIG_DATA *	p
	)

Read raw IRIG data.

The MBG_RAW_IRIG_DATA structure can be read for debugging purposes, to decode application defined bits in the control field (CF) segment of the incoming time code, etc. Usually the data set is only updated once per second, even if the code format provides many data frames per second.

Note: Call mbgextio_dev_has_raw_irig_data to check if this is supported.

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data

See also: mbgextio_dev_has_raw_irig_data

Returns: One of the MBG_RETURN_CODES

Definition at line 7210 of file mbgextio.c.

References _mbg_swab_mbg_raw_irig_data, GPS_RAW_IRIG_DATA, mbg_rc_is_error, mbg_rc_is_success, mbgextio_chk_user_perm(), mbgextio_req_data(), USER_PERM_IOPORTS, and USER_SCOPE_STATUS_READ_MSK.

◆ mbgextio_get_rcv_buffer_addr()

MBG_MSG_BUFF* mbgextio_get_rcv_buffer_addr ( MBG_MSG_CTL * pmctl )

Retrieve address of the allocated receive buffer.

Parameters

[in,out] pmctl Pointer to a valid message control structure

Returns: Address of the allocated receive buffer

See also: mbgextio_get_rcv_buffer_size; mbgextio_get_xmt_buffer_addr; mbgextio_get_xmt_buffer_size

Definition at line 3151 of file mbgextio.c.

References MBG_MSG_RCV_CTL::pmb, and MBG_MSG_CTL_s::rcv.

Referenced by mbgextio_get_io_port_info_idx(), and mbgextio_get_io_port_type_info_idx().

◆ mbgextio_get_rcv_buffer_size()

size_t mbgextio_get_rcv_buffer_size ( MBG_MSG_CTL * pmctl )

Retrieve size of the allocated receive buffer.

Parameters

[in,out] pmctl Pointer to a valid message control structure

Returns: Size of the allocated receive buffer

See also: mbgextio_get_rcv_buffer_addr; mbgextio_get_xmt_buffer_addr; mbgextio_get_xmt_buffer_size

Definition at line 3174 of file mbgextio.c.

References MBG_MSG_RCV_CTL::pmb, and MBG_MSG_CTL_s::rcv.

◆ mbgextio_get_receiver_info()

int mbgextio_get_receiver_info	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		RECEIVER_INFO *	p
	)

Read a receiver info structure.

The RECEIVER_INFO should be read at first to identify the connected device and determine the basic features supported by the device.

Note: Some very old devices may not provide a RECEIVER_INFO, so mbgextio_setup_receiver_info should be called preferably to read the receiver info using this function, if supported, or set up a default structure for devices which don't provide a receiver info.

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_setup_receiver_info

Definition at line 5410 of file mbgextio.c.

References _mbg_swab_receiver_info, GPS_RECEIVER_INFO, mbg_rc_is_success, and mbgextio_req_data().

Referenced by chk_get_rcvr_info(), and mbgextio_close_connection().

◆ mbgextio_get_receiver_info_addr()

RECEIVER_INFO* mbgextio_get_receiver_info_addr ( MBG_MSG_CTL * pmctl )

Retrieve address of the RECEIVER_INFO read from the device.

The RECEIVER_INFO and some other device specific data is read from the device and stored in the MBG_MSG_CTL structure when the device is opened. This function should be used to determine the address of that RECEIVER_INFO structure instead of accessing the sub-structure directly.

Parameters

[in,out] pmctl Pointer to a valid message control structure

Returns: Address of the RECEIVER_INFO read from the device when the device was opened

Definition at line 3128 of file mbgextio.c.

References MBG_XDEV_FEATURES::receiver_info, and MBG_MSG_CTL_s::xdev_features.

Referenced by mbgextio_get_all_port_info(), mbgextio_get_all_pout_info(), mbgextio_get_all_str_type_info(), and mbgextio_setup_receiver_info().

◆ mbgextio_get_ref_offs()

int mbgextio_get_ref_offs	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		MBG_REF_OFFS *	p
	)

Read current ref offset to UTC configuration.

Note: This is only supported if GPS_HAS_REF_OFFS is set in RECEIVER_INFO::features, usually with IRIG receivers

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_set_ref_offs

Definition at line 7244 of file mbgextio.c.

References _mbg_swab_mbg_ref_offs, GPS_REF_OFFS, mbg_rc_is_error, mbg_rc_is_success, mbgextio_chk_user_perm(), mbgextio_req_data(), USER_PERM_IOPORTS, and USER_SCOPE_CONFIG_READ_MSK.

◆ mbgextio_get_scu_stat_info()

int mbgextio_get_scu_stat_info	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		SCU_STAT_INFO *	p
	)

Read SCU_STAT_INFO from the device.

Note: This is only supported if GPS_MODEL_HAS_SCU_STAT is set in the builtin features of the device

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_dev_has_scu_stat; mbgextio_set_scu_stat_settings

Definition at line 13056 of file mbgextio.c.

References _mbg_swab_scu_stat_info, GPS_SCU_STAT, mbg_rc_is_error, mbg_rc_is_success, mbgextio_chk_user_perm(), mbgextio_req_data(), USER_PERM_SYSTEM, USER_SCOPE_CONFIG_READ_MSK, and USER_SCOPE_STATUS_READ_MSK.

◆ mbgextio_get_serial_ftdi_port_handle()

int mbgextio_get_serial_ftdi_port_handle ( MBG_MSG_CTL * pmctl )

Get the port handle of a serial FTDI device.

Parameters

[in,out] pmctl Pointer to a valid message control structure

Returns: the port handle retrieved from the message control structure

Referenced by dev_open_finish_setup().

◆ mbgextio_get_snmp_glb_info()

int mbgextio_get_snmp_glb_info	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		MBG_SNMP_GLB_INFO *	p
	)

Read the SNMP global info in MBG_SNMP_GLB_INFO format.

Note: MBG_MONITORING_TYPE_MSK_SNMP must be set in MBG_MONITORING_LIMITS::supp_types

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_dev_has_monitoring; mbgextio_set_snmp_glb_settings

Definition at line 10177 of file mbgextio.c.

References _mbg_swab_snmp_glb_info, GPS_SNMP_GLB, mbg_rc_is_error, mbg_rc_is_success, mbgextio_chk_user_perm(), mbgextio_req_data(), USER_PERM_MONITORING, and USER_SCOPE_CONFIG_READ_MSK.

◆ mbgextio_get_snmp_v12_info_idx()

int mbgextio_get_snmp_v12_info_idx	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		MBG_SNMP_V12_INFO_IDX *	p,
		uint16_t	idx
	)

Read SNMP v1 or v2 info in MBG_SNMP_V12_INFO_IDX format.

Note: MBG_MONITORING_TYPE_MSK_SNMP must be set in MBG_MONITORING_LIMITS::supp_types

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data
[in]	idx	Index of the SNMP info to be received, 0 ... MBG_SNMP_GLB_SETTINGS::num_v12_settings - 1

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_dev_has_monitoring; mbgextio_get_snmp_glb_info; mbgextio_set_snmp_v12_settings_idx

Definition at line 10252 of file mbgextio.c.

References _mbg_swab_snmp_v12_info_idx, GPS_SNMP_V12_IDX, mbg_rc_is_error, mbg_rc_is_success, mbgextio_chk_user_perm(), mbgextio_req_data_idx(), USER_PERM_MONITORING, and USER_SCOPE_CONFIG_READ_MSK.

◆ mbgextio_get_snmp_v12_trap_info_idx()

int mbgextio_get_snmp_v12_trap_info_idx	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		MBG_SNMP_V12_TRAP_INFO_IDX *	p,
		uint16_t	idx
	)

Read SNMP v1 or v2 trap info in MBG_SNMP_V12_TRAP_INFO_IDX format.

Note: MBG_MONITORING_TYPE_MSK_SNMP must be set in MBG_MONITORING_LIMITS::supp_types

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data
[in]	idx	Index of the SNMP trap info to be received, 0 ... MBG_SNMP_GLB_SETTINGS::num_v12_trap_receivers - 1

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_dev_has_monitoring; mbgextio_get_snmp_glb_info; mbgextio_set_snmp_v12_trap_settings_idx

Definition at line 10330 of file mbgextio.c.

References _mbg_swab_snmp_v12_trap_info_idx, GPS_SNMP_V12_TRAP_IDX, mbg_rc_is_error, mbg_rc_is_success, mbgextio_chk_user_perm(), mbgextio_req_data_idx(), USER_PERM_MONITORING, and USER_SCOPE_CONFIG_READ_MSK.

◆ mbgextio_get_snmp_v3_info_idx()

int mbgextio_get_snmp_v3_info_idx	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		MBG_SNMP_V3_INFO_IDX *	p,
		uint16_t	idx
	)

Read SNMP v3 info in MBG_SNMP_V3_INFO_IDX format.

Note: MBG_MONITORING_TYPE_MSK_SNMP must be set in MBG_MONITORING_LIMITS::supp_types

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data
[in]	idx	Index of the SNMP info to be received, 0 ... MBG_SNMP_GLB_SETTINGS::num_v3_settings - 1

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_dev_has_monitoring; mbgextio_get_snmp_glb_info; mbgextio_set_snmp_v3_settings_idx

Definition at line 10408 of file mbgextio.c.

References _mbg_swab_snmp_v3_info_idx, GPS_SNMP_V3_IDX, mbg_rc_is_error, mbg_rc_is_success, mbgextio_chk_user_perm(), mbgextio_req_data_idx(), USER_PERM_MONITORING, and USER_SCOPE_CONFIG_READ_MSK.

◆ mbgextio_get_snmp_v3_trap_info_idx()

int mbgextio_get_snmp_v3_trap_info_idx	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		MBG_SNMP_V3_TRAP_INFO_IDX *	p,
		uint16_t	idx
	)

Read SNMP v3 trap info in MBG_SNMP_V3_TRAP_INFO_IDX format.

Note: MBG_MONITORING_TYPE_MSK_SNMP must be set in MBG_MONITORING_LIMITS::supp_types

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data
[in]	idx	Index of the SNMP trap info to be received, 0 ... MBG_SNMP_GLB_SETTINGS::num_v3_trap_receivers - 1

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_dev_has_monitoring; mbgextio_get_snmp_glb_info; mbgextio_set_snmp_v3_trap_settings_idx

Definition at line 10486 of file mbgextio.c.

References _mbg_swab_snmp_v3_trap_info_idx, GPS_SNMP_V3_TRAP_IDX, mbg_rc_is_error, mbg_rc_is_success, mbgextio_chk_user_perm(), mbgextio_req_data_idx(), USER_PERM_MONITORING, and USER_SCOPE_CONFIG_READ_MSK.

◆ mbgextio_get_str_type_info_idx()

int mbgextio_get_str_type_info_idx	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		STR_TYPE_INFO_IDX *	p,
		uint16_t	idx
	)

Read information on a specific supported string format.

Retrieve a single entry from an array of supported string types. The number of supported string types is specified in RECEIVER_INFO::n_str_type.

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data
[in]	idx	Index of the array element to be retrieved, 0..RECEIVER_INFO::n_str_type - 1

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_get_all_str_type_info

Definition at line 7406 of file mbgextio.c.

References _mbg_swab_str_type_info_idx, GPS_STR_TYPE_INFO_IDX, mbg_rc_is_error, mbg_rc_is_success, mbgextio_chk_user_perm(), mbgextio_req_data_idx(), USER_PERM_SERIAL, and USER_SCOPE_CONFIG_READ_MSK.

Referenced by mbgextio_get_all_str_type_info().

◆ mbgextio_get_sv_alm()

int mbgextio_get_sv_alm	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		SV_ALM *	p,
		SVNO	svno
	)

Read the GPS almanach for the specified SV from a device.

Note: Only supported by GPS receivers

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data
[in]	svno	SV number, for which the SV_ALM structure shall be requested

Returns: One of the MBG_RETURN_CODES

Definition at line 12936 of file mbgextio.c.

References _mbg_swab_dummy, GPS_ALM, mbg_rc_is_success, and mbgextio_req_data_idx().

◆ mbgextio_get_svc_info_idx()

int mbgextio_get_svc_info_idx	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		MBG_SERVICE_INFO_IDX *	p,
		uint16_t	idx
	)

Read the service info with the given index in MBG_SERVICE_INFO_IDX format.

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data
[in]	idx	Index of the array element to be retrieved, 0..MBG_SERVICE_MGMT_INFO::num_services

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_dev_has_service; mbgextio_get_svc_mgmt_info; mbgextio_set_svc_settings_idx; mbgextio_get_svc_status_idx; mbgextio_set_svc_ctl_idx

Definition at line 14033 of file mbgextio.c.

References _mbg_swab_svc_info_idx, GPS_SVC_INFO_IDX, mbg_rc_is_error, mbg_rc_is_success, mbgextio_chk_user_perm(), mbgextio_req_data_idx(), USER_PERM_SERVICE, USER_SCOPE_CONFIG_READ_MSK, and USER_SCOPE_STATUS_READ_MSK.

◆ mbgextio_get_svc_mgmt_info()

int mbgextio_get_svc_mgmt_info	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		MBG_SERVICE_MGMT_INFO *	p
	)

Read service management info in MBG_SERVICE_MGMT_INFO format.

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_dev_has_service; mbgextio_get_svc_info_idx; mbgextio_set_svc_settings_idx; mbgextio_get_svc_status_idx; mbgextio_set_svc_ctl_idx

Definition at line 13997 of file mbgextio.c.

References _mbg_swab_svc_mgmt_info, GPS_SVC_MGMT_INFO, mbg_rc_is_error, mbg_rc_is_success, mbgextio_chk_user_perm(), mbgextio_req_data(), USER_PERM_SERVICE, USER_SCOPE_CONFIG_READ_MSK, and USER_SCOPE_STATUS_READ_MSK.

◆ mbgextio_get_svc_status_idx()

int mbgextio_get_svc_status_idx	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		MBG_SERVICE_STATUS_IDX *	p,
		uint16_t	idx
	)

Read the service status with the given index in MBG_SERVICE_STATUS_IDX format.

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data
[in]	idx	Index of the array element to be retrieved, 0..MBG_SERVICE_MGMT_INFO::num_services - 1

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_dev_has_service; mbgextio_get_svc_mgmt_info; mbgextio_get_svc_info_idx; mbgextio_set_svc_settings_idx; mbgextio_set_svc_ctl_idx

Definition at line 14111 of file mbgextio.c.

References _mbg_swab_svc_status_idx, GPS_SVC_STATUS_IDX, mbg_rc_is_error, mbg_rc_is_success, mbgextio_chk_user_perm(), mbgextio_req_data_idx(), USER_PERM_SERVICE, and USER_SCOPE_STATUS_READ_MSK.

◆ mbgextio_get_sw_rev()

int mbgextio_get_sw_rev	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		SW_REV *	p
	)

Read the software revision.

Deprecated:: This function is deprecated since the SW_REV structure is also a member of the RECEIVER_INFO. This call may be required, though, for very old devices which don't support the RECEIVER_INFO.

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_setup_receiver_info

Deprecated:: This function is deprecated since the SW_REV structure is also a member of the RECEIVER_INFO. This call may be required, though, for very old devices which don't support the RECEIVER_INFO.

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_setup_receiver_info

Definition at line 5845 of file mbgextio.c.

References _mbg_swab_sw_rev, GPS_SW_REV, mbg_rc_is_success, and mbgextio_req_data().

Referenced by mbgextio_setup_receiver_info().

◆ mbgextio_get_synth()

int mbgextio_get_synth	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		SYNTH *	p
	)

Read the frequency synthesizer settings.

Note: Some devices may not provide a frequency synthesizer

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_set_synth

Definition at line 6333 of file mbgextio.c.

References _mbg_swab_synth, GPS_SYNTH, mbg_rc_is_error, mbg_rc_is_success, mbgextio_chk_user_perm(), mbgextio_req_data(), USER_PERM_IOPORTS, and USER_SCOPE_CONFIG_READ_MSK.

◆ mbgextio_get_syslog_glb_info()

int mbgextio_get_syslog_glb_info	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		MBG_SYSLOG_GLB_INFO *	p
	)

Read the syslog global info in MBG_SYSLOG_GLB_INFO format.

Note: MBG_MONITORING_TYPE_MSK_SYSLOG must be set in MBG_MONITORING_LIMITS::supp_types

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_dev_has_monitoring; mbgextio_set_syslog_glb_settings; mbgextio_get_syslog_info_idx; mbgextio_set_syslog_settings_idx

Definition at line 10740 of file mbgextio.c.

References _mbg_swab_syslog_glb_info, GPS_SYSLOG_GLB_INFO, mbg_rc_is_error, mbg_rc_is_success, mbgextio_chk_user_perm(), mbgextio_req_data(), USER_PERM_MONITORING, and USER_SCOPE_CONFIG_READ_MSK.

◆ mbgextio_get_syslog_info_idx()

int mbgextio_get_syslog_info_idx	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		MBG_SYSLOG_INFO_IDX *	p,
		uint16_t	idx
	)

Read syslog server information in MBG_SYSLOG_INFO_IDX format.

Note: MBG_MONITORING_TYPE_MSK_SYSLOG must be set in MBG_MONITORING_LIMITS::supp_types

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to be retrieved from the device
[in]	idx	Index number of the structure to be retrieved

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_dev_has_monitoring; mbgextio_get_syslog_glb_info; mbgextio_set_syslog_glb_settings; mbgextio_set_syslog_settings_idx

Definition at line 10818 of file mbgextio.c.

References _mbg_swab_syslog_info_idx, GPS_SYSLOG_INFO_IDX, mbg_rc_is_error, mbg_rc_is_success, mbgextio_chk_user_perm(), mbgextio_req_data_idx(), USER_PERM_MONITORING, and USER_SCOPE_CONFIG_READ_MSK.

◆ mbgextio_get_tainted_cfg()

int mbgextio_get_tainted_cfg	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		MBG_TAINTED_CFG *	p
	)

Read MBG_TAINTED_CFG structure from a device.

mbgextio_dev_has_tainted_cfg should be used to check if this is supported

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[in]	p	Pointer to a MBG_TAINTED_CFG data structure to be read from the device

Returns: One of the MBG_RETURN_CODES

Definition at line 13843 of file mbgextio.c.

References _mbg_swab_tainted_cfg, GPS_TAINTED_CFG, mbg_rc_is_success, and mbgextio_req_data().

◆ mbgextio_get_time()

int mbgextio_get_time	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		TTM *	p
	)

Read the current time as TTM strucure.

Note: This function is only supported if the device has MBG_XFEATURE_REQ_TTM

The returned time is not very accurate since the request can be sent at any time and the response is sent immediately and not after a second change.

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_dev_has_req_ttm

Definition at line 5970 of file mbgextio.c.

References _mbg_swab_ttm, GPS_TIME, mbg_rc_is_error, mbg_rc_is_success, mbgextio_chk_user_perm(), mbgextio_req_data(), USER_PERM_RECEIVER, USER_SCOPE_CONFIG_READ_MSK, and USER_SCOPE_STATUS_READ_MSK.

◆ mbgextio_get_time_scale_info()

int mbgextio_get_time_scale_info	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		MBG_TIME_SCALE_INFO *	p
	)

Read time scale configuration parameters.

Note: Some devices may not support a configurable time scale

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_set_time_scale_settings

Definition at line 7814 of file mbgextio.c.

References _mbg_swab_mbg_time_scale_info, GPS_TIME_SCALE, mbg_rc_is_error, mbg_rc_is_success, mbgextio_chk_user_perm(), mbgextio_req_data(), USER_PERM_SYSTEM, and USER_SCOPE_CONFIG_READ_MSK.

◆ mbgextio_get_tr_distance()

int mbgextio_get_tr_distance	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		TR_DISTANCE *	p
	)

Read the distance from transmitter TR_DISTANCE format.

Note: Some devices may not support TR_DISTANCE configuration

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_set_tr_distance

Definition at line 8312 of file mbgextio.c.

References _mbg_swab_tr_distance, mbg_rc_is_success, mbgextio_req_data(), and PZF_TR_DISTANCE.

◆ mbgextio_get_tzcode()

int mbgextio_get_tzcode	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		TZCODE *	p
	)

Read the local time conversion configuration in TZCODE format.

Note: Some devices may not support TZCODE configuration

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_set_tzcode

Definition at line 8177 of file mbgextio.c.

References _mbg_swab_tzcode, mbg_rc_is_error, mbg_rc_is_success, mbgextio_chk_user_perm(), mbgextio_req_data(), PZF_TZCODE, USER_PERM_SYSTEM, and USER_SCOPE_CONFIG_READ_MSK.

◆ mbgextio_get_tzdl()

int mbgextio_get_tzdl	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		TZDL *	p
	)

Read the local time conversion parameters in TZDL format.

Note: Some devices may not support TZDL settings

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data

Returns: One of the MBG_RETURN_CODES

Definition at line 6191 of file mbgextio.c.

References _mbg_swab_tzdl, GPS_TZDL, mbg_rc_is_error, mbg_rc_is_success, mbgextio_chk_user_perm(), mbgextio_req_data(), USER_PERM_SYSTEM, and USER_SCOPE_CONFIG_READ_MSK.

◆ mbgextio_get_ucap()

int mbgextio_get_ucap	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		TTM *	p
	)

Read a user capture event in TTM format.

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_clr_ucap_buff

Definition at line 6428 of file mbgextio.c.

References _mbg_swab_ttm, _ttm_time_set_unavail, MBG_MSG_CTL_s::async_msg_handler_fnc, TTM::channel, MSG_HDR::cmd, GPS_TIME, GPS_UCAP, MBG_MSG_BUFF::hdr, MSG_HDR::len, mbg_rc_is_error, mbgextio_chk_user_perm(), mbgextio_rcv_msg_unlocked(), MBG_MSG_BUFF::msg_data, MBG_MSG_RCV_CTL::pmb, MBG_MSG_CTL_s::rcv, MSG_DATA::ttm, MBG_MSG_BUFF::u, USER_PERM_IOPORTS, USER_SCOPE_STATUS_READ_MSK, and xmt_cmd().

◆ mbgextio_get_ucap_net_glb_info()

int mbgextio_get_ucap_net_glb_info	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		MBG_UCAP_NET_GLB_INFO *	p
	)

Read the user capture network global info in MBG_UCAP_NET_GLB_INFO format.

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_dev_has_ucap_net

Definition at line 6495 of file mbgextio.c.

References _mbg_swab_ucap_net_glb_info, GPS_UCAP_NET_GLB_INFO, mbg_rc_is_error, mbg_rc_is_success, mbgextio_chk_user_perm(), mbgextio_req_data(), USER_PERM_IOPORTS, and USER_SCOPE_CONFIG_READ_MSK.

◆ mbgextio_get_ucap_net_recv_info_idx()

int mbgextio_get_ucap_net_recv_info_idx	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		MBG_UCAP_NET_RECV_INFO_IDX *	p,
		uint16_t	idx
	)

Read the user capture network receiver info with the given index in MBG_UCAP_NET_RECV_INFO_IDX format.

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received dat
[in]	idx	Index of the array element to be retrieved, 0..::MBG_UCAP_NET_GLB_INFO::settings::num_recvs

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_dev_has_ucap_net

Definition at line 6564 of file mbgextio.c.

References _mbg_swab_ucap_net_recv_info_idx, GPS_UCAP_NET_RECV_INFO_IDX, mbg_rc_is_error, mbg_rc_is_success, mbgextio_chk_user_perm(), mbgextio_req_data_idx(), USER_PERM_IOPORTS, and USER_SCOPE_CONFIG_READ_MSK.

◆ mbgextio_get_user_info_idx()

int mbgextio_get_user_info_idx	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		MBG_USER_INFO_IDX *	p,
		uint16_t	idx
	)

Read the user info with the given index in MBG_USER_INFO_IDX format.

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data
[in]	idx	Index of the array element to be retrieved, 0..::MBG_USER_MNGMNT_INFO::settings::num_users

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_dev_has_user_mngmnt

Definition at line 6704 of file mbgextio.c.

References _mbg_swab_user_info_idx, GPS_USER_INFO_IDX, mbg_rc_is_error, mbg_rc_is_success, mbgextio_chk_user_perm(), mbgextio_req_data_idx(), USER_PERM_USERS, USER_SCOPE_CONFIG_READ_MSK, and USER_SCOPE_STATUS_READ_MSK.

◆ mbgextio_get_user_level_info_idx()

int mbgextio_get_user_level_info_idx	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		MBG_USER_INFO_IDX *	p,
		uint16_t	idx
	)

Read the user level info with the given index in MBG_USER_INFO_IDX format.

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data
[in]	idx	Index of the array element to be retrieved, 0..::MBG_USER_MNGMNT_INFO::settings::num_levels

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_dev_has_user_mngmnt

Definition at line 6776 of file mbgextio.c.

References _mbg_swab_user_info_idx, GPS_USER_LEVEL_INFO_IDX, mbg_rc_is_error, mbg_rc_is_success, mbgextio_chk_user_perm(), mbgextio_req_data_idx(), USER_PERM_USERS, and USER_SCOPE_CONFIG_READ_MSK.

◆ mbgextio_get_user_mngmnt_info()

int mbgextio_get_user_mngmnt_info	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		MBG_USER_MNGMNT_INFO *	p
	)

Read the user management info in MBG_USER_MNGMNT_INFO format.

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_dev_has_user_mngmnt

Definition at line 6634 of file mbgextio.c.

References _mbg_swab_user_mngmnt_info, GPS_USER_MNGMNT_INFO, mbg_rc_is_error, mbg_rc_is_success, mbgextio_chk_user_perm(), mbgextio_req_data(), USER_PERM_USERS, USER_SCOPE_CONFIG_READ_MSK, and USER_SCOPE_STATUS_READ_MSK.

◆ mbgextio_get_user_status_idx()

int mbgextio_get_user_status_idx	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		MBG_USER_STATUS_IDX *	p,
		uint16_t	idx
	)

Read the user status with the given index in MBG_USER_STATUS_IDX format.

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data
[in]	idx	Index of the array element to be retrieved, 0..::MBG_USER_MNGMNT_INFO::settings::num_users

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_dev_has_user_mngmnt

Definition at line 6848 of file mbgextio.c.

References _mbg_swab_user_status_idx, GPS_USER_STATUS_IDX, mbg_rc_is_error, mbg_rc_is_success, mbgextio_chk_user_perm(), mbgextio_req_data_idx(), USER_PERM_USERS, and USER_SCOPE_STATUS_READ_MSK.

◆ mbgextio_get_utc_parm()

int mbgextio_get_utc_parm	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		UTC *	p
	)

Read a UTC parameter structure from a device.

The UTC parameter structure contains the current UTC/GPS time offset as well as information on an eventually upcoming leap second.

Note: Only supported by GPS/GNSS and some PZF receivers //##+++++++ TODO Associated feature flag?

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_set_utc_parm

Definition at line 12992 of file mbgextio.c.

References _mbg_swab_utc_parm, GPS_UTC, mbg_rc_is_success, and mbgextio_req_data().

◆ mbgextio_get_xbp_limits()

int mbgextio_get_xbp_limits	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		XBP_LIMITS *	p
	)

Read the XBP_LIMITS to check which XBP features are supported.

Note: Only supported if GPS_HAS_XBP is set in RECEIVER_INFO::features

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_get_xbp_node_limits; mbgextio_get_xbp_node_info_idx

Definition at line 12738 of file mbgextio.c.

References _mbg_swab_xbp_limits, GPS_XBP_LIMITS, mbg_rc_is_success, and mbgextio_req_data().

◆ mbgextio_get_xbp_node_info_idx()

int mbgextio_get_xbp_node_info_idx	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		XBP_NODE_INFO_IDX *	p,
		uint16_t	idx
	)

Read the XBP_NODE_INFO for a specific node in XBP_NODE_INFO_IDX format.

The supported number of nodes is provided by XBP_NODE_LIMITS::node_count.

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data
[in]	idx	Index of the array element to be retrieved, 0..XBP_NODE_LIMITS::node_count-1

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_get_xbp_limits; mbgextio_get_xbp_node_limits

Definition at line 12797 of file mbgextio.c.

References _mbg_swab_xbp_node_info_idx, GPS_XBP_NODE_INFO_IDX, mbg_rc_is_success, and mbgextio_req_data_idx().

Referenced by mbgextio_setup_xbp_node_list().

◆ mbgextio_get_xbp_node_limits()

int mbgextio_get_xbp_node_limits	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		XBP_NODE_LIMITS *	p
	)

Read the XBP_NODE_LIMITS to check how many ports are provided.

Note: Only supported if XBP_FEAT_MASK_NODES is set in XBP_LIMITS::features.

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_get_xbp_limits; mbgextio_get_xbp_node_info_idx

Definition at line 12767 of file mbgextio.c.

References _mbg_swab_xbp_node_limits, GPS_XBP_NODE_LIMITS, mbg_rc_is_success, and mbgextio_req_data().

Referenced by mbgextio_setup_xbp_node_list().

◆ mbgextio_get_xmr_ext_source_metrics_idx()

int mbgextio_get_xmr_ext_source_metrics_idx	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		XMR_METRICS_IDX *	p,
		uint16_t	idx
	)

Read XMR_METRICS_IDX for a specific XMR source.

Call chk_dev_xmulti_ref_supp_ext_source_metrics to see if supported

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data
[in]	idx	Index of the array element to be retrieved, 0..MULTI_REF_TYPES-1

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_get_xmr_instances; mbgextio_get_xmr_ext_src_info_idx; mbgextio_get_xmr_holdover_status; mbgextio_get_xmr_info_idx; mbgextio_set_xmr_settings_idx; mbgextio_get_xmr_info_idx; mbgextio_get_xmr_status_idx

Definition at line 8935 of file mbgextio.c.

References _mbg_swab_xmr_metrics_idx, GPS_XMR_METRICS_IDX, XMR_METRICS_IDX::idx, mbg_rc_is_error, mbg_rc_is_success, mbgextio_chk_user_perm(), mbgextio_req_data_idx(), USER_PERM_MRS, and USER_SCOPE_STATUS_READ_MSK.

◆ mbgextio_get_xmr_ext_source_stats_idx()

int mbgextio_get_xmr_ext_source_stats_idx	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		XMR_STATS_IDX *	p,
		uint16_t	idx
	)

Read XMR_STATS_IDX for a specific XMR source.

Call chk_dev_xmulti_ref_supp_ext_source_stats to see if supported

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data
[in]	idx	Index of the array element to be retrieved, 0..MULTI_REF_TYPES-1

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_get_xmr_instances; mbgextio_get_xmr_ext_src_info_idx; mbgextio_get_xmr_holdover_status; mbgextio_get_xmr_info_idx; mbgextio_set_xmr_settings_idx; mbgextio_get_xmr_info_idx; mbgextio_get_xmr_status_idx; mbgextio_get_xmr_ext_source_metrics_idx

Definition at line 8892 of file mbgextio.c.

References _mbg_swab_xmr_stats_idx, GPS_XMR_STATS_IDX, XMR_STATS_IDX::idx, mbg_rc_is_error, mbg_rc_is_success, mbgextio_chk_user_perm(), mbgextio_req_data_idx(), USER_PERM_MRS, and USER_SCOPE_STATUS_READ_MSK.

◆ mbgextio_get_xmr_ext_src_info_idx()

int mbgextio_get_xmr_ext_src_info_idx	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		XMR_EXT_SRC_INFO_IDX *	p,
		uint16_t	idx
	)

Read XMR_EXT_SRC_INFO_IDX.

Only if GPS_HAS_XMULTI_REF is set in RECEIVER_INFO::features AND XMRIF_MSK_EXT_SRC_INFO_SUPP is set in XMULTI_REF_INSTANCES::flags.

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data
[in]	idx	Index of the array element to be retrieved, 0..XMULTI_REF_INSTANCES::n_xmr_settings-1

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_get_xmr_instances; mbgextio_get_xmr_holdover_status; mbgextio_get_xmr_info_idx; mbgextio_get_xmr_status_idx; mbgextio_set_xmr_settings_idx; mbgextio_get_xmr_ext_source_stats_idx; mbgextio_get_xmr_ext_source_metrics_idx

Definition at line 8689 of file mbgextio.c.

References _mbg_swab_xmr_ext_src_info_idx, GPS_XMR_EXT_SRC_INFO_IDX, XMR_EXT_SRC_INFO_IDX::idx, mbg_rc_is_error, mbg_rc_is_success, mbgextio_chk_user_perm(), mbgextio_req_data_idx(), USER_PERM_MRS, USER_SCOPE_CONFIG_READ_MSK, and USER_SCOPE_STATUS_READ_MSK.

◆ mbgextio_get_xmr_holdover_status()

int mbgextio_get_xmr_holdover_status	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		XMR_HOLDOVER_STATUS *	p
	)

Read XMR_HOLDOVER_STATUS.

Only if GPS_HAS_XMULTI_REF is set in RECEIVER_INFO::features AND XMRIF_MSK_HOLDOVER_STATUS_SUPP is set in XMULTI_REF_INSTANCES::flags.

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_get_xmr_instances; mbgextio_get_xmr_ext_src_info_idx; mbgextio_get_xmr_info_idx; mbgextio_get_xmr_status_idx; mbgextio_set_xmr_settings_idx; mbgextio_get_xmr_ext_source_stats_idx; mbgextio_get_xmr_ext_source_metrics_idx

Definition at line 8733 of file mbgextio.c.

References _mbg_swab_xmr_holdover_status, GPS_XMR_HOLDOVER_STATUS, mbg_rc_is_error, mbg_rc_is_success, mbgextio_chk_user_perm(), mbgextio_req_data(), USER_PERM_MRS, and USER_SCOPE_STATUS_READ_MSK.

◆ mbgextio_get_xmr_info_idx()

int mbgextio_get_xmr_info_idx	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		XMULTI_REF_INFO_IDX *	p,
		uint16_t	idx
	)

Read XMULTI_REF_INFO_IDX for a specific XMR source.

Only if GPS_HAS_XMULTI_REF is set in RECEIVER_INFO::features.

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data
[in]	idx	Index of the array element to be retrieved, 0..0..XMULTI_REF_INSTANCES::n_xmr_settings-1

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_get_xmr_instances; mbgextio_get_xmr_ext_src_info_idx; mbgextio_get_xmr_holdover_status; mbgextio_get_xmr_status_idx; mbgextio_set_xmr_settings_idx; mbgextio_get_xmr_ext_source_stats_idx; mbgextio_get_xmr_ext_source_metrics_idx

Definition at line 8774 of file mbgextio.c.

References _mbg_swab_xmulti_ref_info_idx, GPS_XMR_INFO_IDX, XMULTI_REF_INFO_IDX::idx, mbg_rc_is_error, mbg_rc_is_success, mbgextio_chk_user_perm(), mbgextio_req_data_idx(), USER_PERM_MRS, USER_SCOPE_CONFIG_READ_MSK, and USER_SCOPE_STATUS_READ_MSK.

◆ mbgextio_get_xmr_instances()

int mbgextio_get_xmr_instances	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		XMULTI_REF_INSTANCES *	p
	)

Read XMULTI_REF_INSTANCES.

Only if GPS_HAS_XMULTI_REF is set in RECEIVER_INFO::features AND XMRIF_MSK_EXT_SRC_INFO_SUPP is set in XMULTI_REF_INSTANCES::flags.

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_get_xmr_ext_src_info_idx; mbgextio_get_xmr_info_idx; mbgextio_get_xmr_status_idx; mbgextio_set_xmr_settings_idx; mbgextio_get_xmr_ext_source_stats_idx; mbgextio_get_xmr_ext_source_metrics_idx

Read XMULTI_REF_INSTANCES.

Read XMULTI_REF_INSTANCES

Only if GPS_HAS_XMULTI_REF is set in RECEIVER_INFO::features AND XMRIF_MSK_EXT_SRC_INFO_SUPP is set in XMULTI_REF_INSTANCES::flags.

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_get_xmr_ext_src_info_idx; mbgextio_get_xmr_info_idx; mbgextio_get_xmr_status_idx; mbgextio_set_xmr_settings_idx; mbgextio_get_xmr_ext_source_stats_idx; mbgextio_get_xmr_ext_source_metrics_idx

Definition at line 8647 of file mbgextio.c.

References _mbg_swab_xmulti_ref_instances, GPS_XMR_INSTANCES, mbg_rc_is_error, mbg_rc_is_success, mbgextio_chk_user_perm(), mbgextio_req_data(), USER_PERM_MRS, USER_SCOPE_CONFIG_READ_MSK, and USER_SCOPE_STATUS_READ_MSK.

◆ mbgextio_get_xmr_status_idx()

int mbgextio_get_xmr_status_idx	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		XMULTI_REF_STATUS_IDX *	p,
		uint16_t	idx
	)

Read XMULTI_REF_STATUS_IDX for a specific XMR source.

Only if GPS_HAS_XMULTI_REF is set in RECEIVER_INFO::features.

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data
[in]	idx	Index of the array element to be retrieved, 0..0..XMULTI_REF_INSTANCES::n_xmr_settings-1

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_get_xmr_instances; mbgextio_get_xmr_ext_src_info_idx; mbgextio_get_xmr_holdover_status; mbgextio_get_xmr_info_idx; mbgextio_set_xmr_settings_idx; mbgextio_get_xmr_ext_source_stats_idx; mbgextio_get_xmr_ext_source_metrics_idx; mbgextio_get_xmr_ext_source_metrics_idx

Definition at line 8818 of file mbgextio.c.

References _mbg_mutex_acquire, _mbg_mutex_release, _mbg_swab_xmulti_ref_status_idx, MBG_MSG_CTL_s::dev_mutex, GPS_XMR_STATUS_IDX, XMULTI_REF_STATUS_IDX::idx, MBG_ERR_UNSPEC, mbg_rc_is_error, mbgextio_chk_user_perm(), mbgextio_rcv_msg_unlocked(), USER_PERM_MRS, USER_SCOPE_STATUS_READ_MSK, and xmt_cmd_us().

◆ mbgextio_get_xmt_buffer_addr()

MBG_MSG_BUFF* mbgextio_get_xmt_buffer_addr ( MBG_MSG_CTL * pmctl )

Retrieve address of the allocated transmit buffer.

Parameters

[in,out] pmctl Pointer to a valid message control structure

Returns: Address of the allocated transmit buffer

See also: mbgextio_get_rcv_buffer_addr; mbgextio_get_rcv_buffer_size; mbgextio_get_xmt_buffer_size

Definition at line 3197 of file mbgextio.c.

References MBG_MSG_XMT_CTL::pmb, and MBG_MSG_CTL_s::xmt.

◆ mbgextio_get_xmt_buffer_size()

size_t mbgextio_get_xmt_buffer_size ( MBG_MSG_CTL * pmctl )

Retrieve size of the allocated transmit buffer.

Parameters

[in,out] pmctl Pointer to a valid message control structure

Returns: Size of the allocated transmit buffer

See also: mbgextio_get_rcv_buffer_addr; mbgextio_get_rcv_buffer_size; mbgextio_get_xmt_buffer_addr

Definition at line 3220 of file mbgextio.c.

References MBG_MSG_XMT_CTL::pmb, and MBG_MSG_CTL_s::xmt.

◆ mbgextio_get_xmulti_ref_info_idx()

int mbgextio_get_xmulti_ref_info_idx	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		XMULTI_REF_INFO_IDX *	p
	)

Read the multi ref info from a device.

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data

Returns: One of the MBG_RETURN_CODES

Definition at line 8149 of file mbgextio.c.

References GPS_MULTI_REF_INFO, MBG_SUCCESS, mbgextio_req_data(), MBG_MSG_BUFF::msg_data, MBG_MSG_RCV_CTL::pmb, MBG_MSG_CTL_s::rcv, MBG_MSG_BUFF::u, and MSG_DATA::xmulti_ref_info_idx.

◆ mbgextio_open_serial()

int mbgextio_open_serial	(	const char *	dev,
		MBG_MSG_CTL **	ppmctl,
		uint32_t	baud_rate,
		const char *	framing
	)

Open a binary communication channel using direct serial I/O.

Commonly used serial parameters are 19200/8N1, see MBG_DEFAULT_BAUDRATE and MBG_DEFAULT_FRAMING. Some newer devices may also support MBG_DEFAULT_BAUDRATE_HS.

Parameters

[in]	dev	Name of the serial port to which the device is connected, depending on the naming conventions of the host system.
[out]	ppmctl	Address of a pointer to a MBG_MSG_CTL control structure allocated and set up by this call. Set to NULL on error.
[in]	baud_rate	Baud rate used for serial communication
[in]	framing	Framing used for serial communication

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_force_conn_serial; mbgextio_open_serial_ftdi; mbgextio_force_conn_serial_ftdi; mbgextio_open_socket; mbgextio_open_usb; mbgextio_open_usb_ldev; mbgextio_close_connection

Referenced by dev_open_finish_setup().

◆ mbgextio_open_serial_force_default()

int mbgextio_open_serial_force_default	(	const char *	dev,
		MBG_MSG_CTL **	ppmctl,
		uint32_t	baud_rate,
		const char *	framing
	)

Open a binary communication channel forcing default serial parameters.

If current serial paramaters (baud rate and framing) do not match the default parameters for binary communication then the serial device is forced into binary communication mode.

Parameters

[in]	dev	Name of the serial port to which the device is connected, depending on the naming conventions of the host system.
[out]	ppmctl	Address of a pointer to a MBG_MSG_CTL control structure allocated and set up by this call. Set to NULL on error.
[in]	baud_rate	Baud rate used for serial communication
[in]	framing	Framing used for serial communication

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_open_serial; mbgextio_open_serial_raw; mbgserio_write; mbgextio_close_connection

Referenced by dev_open_finish_setup().

◆ mbgextio_open_serial_ftdi()

int mbgextio_open_serial_ftdi	(	int	device_num,
		MBG_MSG_CTL **	ppmctl,
		uint32_t	baud_rate,
		const char *	framing
	)

Open a binary communication channel using serial FTDI D2xx port.

Commonly used serial parameters are 19200/8N1, see MBG_DEFAULT_BAUDRATE and MBG_DEFAULT_FRAMING. Some newer devices may also support MBG_DEFAULT_BAUDRATE_HS.

Parameters

[in]	device_num	device number from a list set up by FT_ListDevices()
[out]	ppmctl	Address of a pointer to a MBG_MSG_CTL control structure allocated and set up by this call. Set to NULL on error.
[in]	baud_rate	Baud rate used for serial communication
[in]	framing	Framing used for serial communication

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_force_conn_serial_ftdi; mbgextio_open_serial; mbgextio_force_conn_serial; mbgextio_open_socket; mbgextio_open_usb; mbgextio_open_usb_ldev; mbgextio_close_connection

Referenced by dev_open_finish_setup(), and mbgextio_close_connection().

◆ mbgextio_open_serial_raw()

int mbgextio_open_serial_raw	(	const char *	dev,
		MBG_MSG_CTL **	ppmctl,
		uint32_t	baud_rate,
		const char *	framing
	)

Referenced by dev_open_finish_setup(), and mbgextio_close_connection().

◆ mbgextio_open_socket()

int mbgextio_open_socket	(	const char *	host,
		MBG_MSG_CTL **	ppmctl,
		const char *	passwd
	)

Open a binary communication channel via a LAN/socket connection.

Parameters

[in]	host	DNS name or IP address of the target device
[out]	ppmctl	Address of a pointer to a MBG_MSG_CTL control structure allocated and set up by this call. Pointer is set to NULL on error.
[in]	passwd	Password string for the encrypted communication

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_open_serial; mbgextio_open_serial_ftdi; mbgextio_open_usb; mbgextio_open_usb_ldev; mbgextio_close_connection

Referenced by dev_open_finish_setup().

◆ mbgextio_open_ssh_socket()

int mbgextio_open_ssh_socket	(	const char *	host,
		MBG_MSG_CTL **	ppmctl,
		SSH_DATA *	ssh_data
	)

Open a binary communication channel with user login via encrypted SSH connection

Parameters

[in]	host	DNS name or IP address of the target device
[out]	ppmctl	Address of a pointer to a MBG_MSG_CTL control structure allocated and set up by this call. Pointer is set to NULL on error.
[in]	ssh_data	Pointer to a SSH_DATA structure containing the callback functions for key and login handling

Returns: MBG_SUCCESS, if the channel is set up successfully and can be used for communication MBG_ERR_PAM, if the system authentication failed (user unknown or wrong password) MBG_ERR_NOT_FOUND, if the system authentication is successful, but the user is unknown to the subsystem (i.e. lantimed) MBG_ERR_AUTH, if the user has been disabled due to maximum number of failed logins MBG_ERR_BUSY, if the user is already logged in and multiple sessions are not allowed MBG_ERR_TIMEOUT, if the user has been disabled due to password expiration one of the MBG error codes, otherwise

See also: mbgextio_open_socket; mbgextio_close_connection

Referenced by dev_open_finish_setup().

◆ mbgextio_open_usb()

int mbgextio_open_usb	(	const MBG_USB_DEV_INFO *	mdev_info,
		MBG_MSG_CTL **	ppmctl
	)

Open a binary communication channel using direct USB I/O.

Parameters

[in]	mdev_info	The USB device to communicate with.
[out]	ppmctl	Address of a pointer to a MBG_MSG_CTL control structure allocated and set up by this call. Set to NULL on error.

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_open_socket; mbgextio_open_serial; mbgextio_open_serial_ftdi; mbgextio_close_connection

Referenced by dev_open_finish_setup().

◆ mbgextio_open_usb_ldev()

int mbgextio_open_usb_ldev	(	libusb_device *	ldev,
		MBG_MSG_CTL **	ppmctl
	)

Open a binary communication channel using direct USB I/O.

//### TODO group opening functions, ref to group only

Parameters

[in]	ldev	A libusb_device to communicate with.
[out]	ppmctl	Address of a pointer to a MBG_MSG_CTL control structure allocated and set up by this call. Set to NULL on error.

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_open_socket; mbgextio_open_serial; mbgextio_open_serial_ftdi; mbgextio_close_connection

Referenced by dev_open_finish_setup().

◆ mbgextio_rcv_msg()

int mbgextio_rcv_msg	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		GPS_CMD	cmd,
		void *	buf,
		size_t	buf_size
	)

Generic reception of a binary message.

Note: A certain message type to be waited for can be specified by passing one of the GPS_CMD_CODES. If the special cmd code GPS_WILDCARD is specified the function returns successfully after any type of binary message has been received.

//##++ TODO: callback function to handle asynchronous spontaneous messages

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[in]	cmd	One of the command codes enumerated in GPS_CMD_CODES, or GPS_WILDCARD
[out]	buf	Pointer to a buffer to be filled with the requested data, or NULL
[in]	buf_size	Size of the buffer specified by buf

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_rcv_msg_unlocked; mbgextio_xmt_msg //##++++; mbgextio_xmt_cmd; mbgextio_req_data; mbgextio_xmt_cmd_us; mbgextio_req_data_idx

Definition at line 4981 of file mbgextio.c.

References _mbg_mutex_acquire, _mbg_mutex_release, MBG_MSG_CTL_s::dev_mutex, and mbgextio_rcv_msg_unlocked().

◆ mbgextio_rcv_msg_unlocked()

int mbgextio_rcv_msg_unlocked	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		GPS_CMD	cmd,
		void *	buf,
		size_t	buf_size
	)

Generic reception of a binary message.

Note: A certain message type to be waited for can be specified by passing one of the GPS_CMD_CODES. If the special cmd code GPS_WILDCARD is specified the function returns successfully after any type of binary message has been received.

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[in]	cmd	One of the command codes enumerated in GPS_CMD_CODES, or GPS_WILDCARD
[out]	buf	Pointer to a buffer to be filled with the requested data, or NULL
[in]	buf_size	Size of the buffer specified by buf

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_rcv_msg_unlocked; mbgextio_xmt_msg //##++++; mbgextio_xmt_cmd; mbgextio_req_data; mbgextio_xmt_cmd_us; mbgextio_req_data_idx

Definition at line 4614 of file mbgextio.c.

References MBG_MSG_CTL_s::async_data_handler_fnc, MBG_MSG_CTL_s::async_data_reset_fnc, MBG_MSG_CTL_s::async_msg_handler_fnc, check_transfer(), MSG_HDR::cmd, MBG_MSG_CTL_s::conn_type, decrypt_message(), FT_STATUS, GPS_CRYPTED_PACKET, GPS_CTRL_MSK, GPS_WILDCARD, GPS_XBP_PACKET, MBG_MSG_BUFF::hdr, init_transfer(), MSG_HDR::len, MBG_CONN_TYPE_SERIAL, MBG_CONN_TYPE_SERIAL_FTDI, MBG_CONN_TYPE_SOCKET, MBG_CONN_TYPE_USB, MBG_CONN_TYPE_USB_DIRECT_IO, MBG_ERR_CONN_TYPE, MBG_ERR_DATA_CSUM, MBG_ERR_DATA_SIZE, MBG_ERR_DISCONN, MBG_ERR_HDR_CSUM, MBG_ERR_OVERFLOW, MBG_ERR_TIMEOUT, MBG_ERR_UNSPEC, mbg_ftdi_ft_status_to_mbg(), mbg_get_last_error(), mbg_get_last_socket_error(), mbg_memcpy(), mbg_rc_is_error, MBG_SUCCESS, mbgextio_get_cmd_name(), MBGEXTIO_READ_BUFFER_SIZE, mbgserio_read_wait(), MBG_MSG_BUFF::msg_data, MBG_MSG_CTL_s::msg_rcv_timeout, msg_return_code(), MBG_MSG_CTL_s::st::p_serio, MBG_MSG_RCV_CTL::pmb, MBG_MSG_CTL_s::rcv, MBG_MSG_CTL_s::st, XBP_MSG_DATA::std_msg, TR_COMPLETE, TR_CSUM_DATA, TR_CSUM_HDR, TR_OVERFLOW, TR_RECEIVING, TR_WAITING, MBG_MSG_BUFF::u, XBP_MSG_DATA::xbp_addr, and MBG_MSG_BUFF::xbp_msg_data.

Referenced by dev_open_finish_setup(), mbgextio_check_ack(), mbgextio_get_all_ptp_uc_master_info(), mbgextio_get_event_value_idx(), mbgextio_get_ucap(), mbgextio_get_xmr_status_idx(), mbgextio_rcv_msg(), mbgextio_req_data(), mbgextio_req_data_idx_unlocked(), and mbgextio_setup_receiver_info().

◆ mbgextio_register_async_data_callback()

void mbgextio_register_async_data_callback	(	MBG_MSG_CTL *	pmctl,
		MBG_ASYNC_DATA_HANDLER_FNC *	fnc
	)

Register an asynchronous data handler callback function.

The specified function is called for each spurious data byte that is received while some API function waits for a binary message, for example if a spurious ASCII time string has been transmitted by the device.

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	fnc	Address of the callback function to be registered

See also: mbgextio_register_nack_callback; mbgextio_register_async_msg_callback; mbgextio_register_async_data_reset_callback

Definition at line 3080 of file mbgextio.c.

References MBG_MSG_CTL_s::async_data_handler_fnc.

◆ mbgextio_register_async_data_reset_callback()

void mbgextio_register_async_data_reset_callback	(	MBG_MSG_CTL *	pmctl,
		MBG_ASYNC_DATA_RESET_FNC *	fnc
	)

Register an asynchronous data reset callback function.

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	fnc	Address of the callback function to be registered

The specified function is called for each spurious data byte that is received while some API function waits for a binary message, for example if a spurious ASCII time string has been transmitted by the device.

See also: mbgextio_register_nack_callback; mbgextio_register_async_msg_callback; mbgextio_register_async_data_callback

Definition at line 3105 of file mbgextio.c.

References MBG_MSG_CTL_s::async_data_reset_fnc.

◆ mbgextio_register_async_msg_callback()

void mbgextio_register_async_msg_callback	(	MBG_MSG_CTL *	pmctl,
		MBG_ASYNC_MSG_HANDLER_FNC *	fnc
	)

Register an asynchronous message handler callback function.

The specified function is called whenever some API function waits to receive a specific binary message, but another spurious, valid binary message with a different data type is received first.

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	fnc	Address of the callback function to be registered

See also: mbgextio_register_nack_callback; mbgextio_register_async_data_callback; mbgextio_register_async_data_reset_callback

Definition at line 3055 of file mbgextio.c.

References MBG_MSG_CTL_s::async_msg_handler_fnc.

◆ mbgextio_register_nack_callback()

void mbgextio_register_nack_callback	(	MBG_MSG_CTL *	pmctl,
		MBG_NACK_HANDLER_FNC *	fnc
	)

Register a NACK message handler callback function.

The specified function is called whenever a device has replied a message with the GPS_NACK flag set. The default behavior of the protocol handler should be appropriate for most applications, but some specific applications may need to determine by themselves how to handle a NACK message, in which case a callback function can be registered.

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	fnc	Address of the callback function to be registered

See also: mbgextio_register_async_msg_callback; mbgextio_register_async_data_callback; mbgextio_register_async_data_reset_callback

Definition at line 3031 of file mbgextio.c.

References MBG_MSG_CTL_s::nack_handler_fnc.

◆ mbgextio_register_push_msg()

int mbgextio_register_push_msg	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		GPS_CMD	cmd
	)

Register for command specific push messages.

mbgextio_dev_has_push_msgs should be used to check if this is supported

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[in]	cmd	GPS command to register for push messages for

Returns: One of the MBG_RETURN_CODES

Definition at line 13870 of file mbgextio.c.

References GPS_REGISTER_PUSH_MSGS, mbgextio_xmt_cmd_us(), and OPT_GPS_ACK_CODE.

◆ mbgextio_req_data()

int mbgextio_req_data	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		GPS_CMD	cmd,
		void *	buf,
		size_t	buf_size
	)

Transmit a message without a single ushort (16 bit) parameter.

The ushort parameter is often used to send an index value when requesting a specific element of an array of data structures.

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[in]	cmd	One of the command codes enumerated in GPS_CMD_CODES
[out]	buf	Pointer to a buffer to be filled with the requested data, or NULL
[in]	buf_size	Size of the buffer specified by buf

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_xmt_msg; mbgextio_rcv_msg_unlocked; mbgextio_xmt_cmd; mbgextio_xmt_cmd_us; mbgextio_req_data_idx

Definition at line 5280 of file mbgextio.c.

References _mbg_mutex_acquire, _mbg_mutex_release, MBG_MSG_CTL_s::dev_mutex, mbg_rc_is_success, mbgextio_rcv_msg_unlocked(), and xmt_cmd().

◆ mbgextio_req_data_idx()

int mbgextio_req_data_idx	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		GPS_CMD	cmd,
		uint16_t	idx,
		void *	buf,
		size_t	buf_size
	)

Read a specific element of an array of data structures.

The type of data is implicitly associated with the cmd parameter. Usually the number of supported array elements has to be determined by some other means, e.g. from a field in the RECEIVER_INFO structure.

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[in]	cmd	One of the command codes enumerated in GPS_CMD_CODES
[in]	idx	The index of the array element to read
[out]	buf	Pointer to a buffer to be filled with the requested data, or NULL
[in]	buf_size	Size of the buffer specified by buf

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_xmt_msg; mbgextio_rcv_msg_unlocked; mbgextio_xmt_cmd; mbgextio_req_data; mbgextio_xmt_cmd_us

Definition at line 5368 of file mbgextio.c.

References _mbg_mutex_acquire, _mbg_mutex_release, MBG_MSG_CTL_s::dev_mutex, and mbgextio_req_data_idx_unlocked().

◆ mbgextio_req_data_idx_unlocked()

int mbgextio_req_data_idx_unlocked	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		GPS_CMD	cmd,
		uint16_t	idx,
		void *	buf,
		size_t	buf_size
	)

Read a specific element of an array of data structures.

This function dos not lock/unlock the device mutex, so this has to be done by The type of data is implicitly associated with the cmd parameter. The type of data is implicitly associated with the cmd parameter. Usually the number of supported array elements has to be determined by some other means, e.g. from a field in the RECEIVER_INFO structure.

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[in]	cmd	One of the command codes enumerated in GPS_CMD_CODES
[in]	idx	The index of the array element to read
[out]	buf	Pointer to a buffer to be filled with the requested data, or NULL
[in]	buf_size	Size of the buffer specified by buf

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_xmt_msg; mbgextio_rcv_msg_unlocked; mbgextio_xmt_cmd; mbgextio_req_data; mbgextio_xmt_cmd_us

Definition at line 5329 of file mbgextio.c.

References mbg_rc_is_success, mbgextio_rcv_msg_unlocked(), and xmt_cmd_us().

Referenced by mbgextio_req_data_idx().

◆ mbgextio_reset_usb()

int mbgextio_reset_usb ( const MBG_USB_DEV_INFO * mdev_info )

Reset an USB device in case that the open_usb function return MBG_ERR_BUSY.

Parameters

[in] mdev_info The USB device to communicate with.

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_open_socket; mbgextio_open_serial; mbgextio_open_serial_ftdi; mbgextio_close_connection

Referenced by dev_open_finish_setup().

◆ mbgextio_send_database_cmd()

int mbgextio_send_database_cmd	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		uint32_t	cmd,
		const void *	payload,
		uint32_t	payload_len
	)

Send a specific command to database in MBG_DATABASE_CMD format.

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[in]	cmd	One of MBG_DATABASE_CMDS to send to the database
[in]	payload	Pointer to payload data to copy into MBG_DATABASE_CMD
[in]	payload_len	Payload length in bytes

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_dev_has_database; mbgextio_get_database_glb_info; mbgextio_get_database_info_idx; mbgextio_set_database_settings_idx

Definition at line 11243 of file mbgextio.c.

References _mbg_mutex_acquire, _mbg_swab_database_cmd, MBG_DATABASE_CMD::cmd, MSG_DATA::db_cmd, MBG_MSG_CTL_s::dev_mutex, GPS_DATABASE_CMD, MBG_DATABASE_CMD::length, MBG_ERR_DATA_SIZE, MBG_ERR_INV_PARM, mbg_rc_is_error, mbgextio_chk_user_perm(), mbgextio_xmt_msg(), MBG_MSG_BUFF::msg_data, OPT_GPS_ACK_CODE, MBG_DATABASE_CMD::payload, MBG_MSG_XMT_CTL::pmb, MBG_MSG_BUFF::u, USER_PERM_DATABASE, USER_SCOPE_CONFIG_WRITE_MSK, and MBG_MSG_CTL_s::xmt.

◆ mbgextio_set_active_fw()

int mbgextio_set_active_fw	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		uint16_t	idx
	)

Activate the firmware with the given index.

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[in]	idx	Index of the firmware to be activated

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_dev_has_fw_mngmnt; mbgextio_get_all_firmware_info; mbgextio_get_fw_glb_info; mbgextio_get_fw_info_idx; mbgextio_fw_ufu_flash

Definition at line 10973 of file mbgextio.c.

References GPS_FW_ACTIVATE, mbg_rc_is_error, mbgextio_chk_user_perm(), mbgextio_xmt_cmd_us(), OPT_GPS_ACK_CODE, USER_PERM_FIRMWARE, and USER_SCOPE_CONFIG_WRITE_MSK.

◆ mbgextio_set_ant_cable_len()

int mbgextio_set_ant_cable_len	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		const ANT_CABLE_LEN *	p
	)

Send the GPS antenna cable length configuration.

This is only supported by GPS/GNSS receivers, check GPS_MODEL_HAS_ANT_CABLE_LEN

Note: Different devices may accept different maximum values, so the written value should be re-read using mbgextio_get_ant_cable_len to check if the parameter has been accepted.

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to be sent to the device

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_get_ant_cable_len

Definition at line 7024 of file mbgextio.c.

References _mbg_mutex_acquire, _mbg_swab_ant_cable_len, MSG_DATA::ant_cable_len, MBG_MSG_CTL_s::dev_mutex, GPS_ANT_CABLE_LENGTH, mbg_rc_is_error, mbgextio_chk_user_perm(), mbgextio_xmt_msg(), MBG_MSG_BUFF::msg_data, OPT_GPS_ACK_CODE, MBG_MSG_XMT_CTL::pmb, MBG_MSG_BUFF::u, USER_PERM_RECEIVER, USER_SCOPE_CONFIG_WRITE_MSK, and MBG_MSG_CTL_s::xmt.

◆ mbgextio_set_database_settings_idx()

int mbgextio_set_database_settings_idx	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		const MBG_DATABASE_SETTINGS *	p,
		uint8_t	idx
	)

Write database settings in MBG_DATABASE_SETTINGS_IDX format.

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[in]	p	Pointer to the data structure to be sent to the device
[in]	idx	Index number of the structure to be sent

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_dev_has_database; mbgextio_get_database_glb_info; mbgextio_get_database_info_idx; mbgextio_send_database_cmd

Definition at line 11196 of file mbgextio.c.

References _mbg_mutex_acquire, _mbg_swab_database_settings_idx, MSG_DATA::db_settings_idx, MBG_MSG_CTL_s::dev_mutex, GPS_DATABASE_INFO_IDX, MBG_DATABASE_SETTINGS_IDX::idx, mbg_rc_is_error, mbgextio_chk_user_perm(), mbgextio_xmt_msg(), MBG_MSG_BUFF::msg_data, OPT_GPS_ACK_CODE, MBG_MSG_XMT_CTL::pmb, MBG_DATABASE_SETTINGS_IDX::settings, MBG_MSG_BUFF::u, USER_PERM_DATABASE, USER_SCOPE_CONFIG_WRITE_MSK, and MBG_MSG_CTL_s::xmt.

◆ mbgextio_set_dev_poll_timeout()

ulong mbgextio_set_dev_poll_timeout	(	MBG_MSG_CTL *	pmctl,
		ulong	new_timeout
	)

Set device poll timeout.

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	new_timeout	New poll timeout value [ms]

Returns: Previous poll timeout value [ms]

See also: mbgextio_get_dev_poll_timeout; mbgextio_set_msg_rcv_timeout; mbgextio_get_msg_rcv_timeout

Definition at line 3244 of file mbgextio.c.

◆ mbgextio_set_enable_flags()

int mbgextio_set_enable_flags	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		const ENABLE_FLAGS *	p
	)

Send the enable flags controlling when output signals are enabled.

Note: Some devices may not support ENABLE_FLAGS

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to be sent to the device

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_get_enable_flags

Definition at line 6914 of file mbgextio.c.

References _mbg_mutex_acquire, _mbg_swab_enable_flags, MBG_MSG_CTL_s::dev_mutex, MSG_DATA::enable_flags, GPS_ENABLE_FLAGS, mbg_rc_is_error, mbgextio_chk_user_perm(), mbgextio_xmt_msg(), MBG_MSG_BUFF::msg_data, OPT_GPS_ACK_CODE, MBG_MSG_XMT_CTL::pmb, MBG_MSG_BUFF::u, USER_PERM_IOPORTS, USER_SCOPE_CONFIG_WRITE_MSK, and MBG_MSG_CTL_s::xmt.

◆ mbgextio_set_event_settings_idx()

int mbgextio_set_event_settings_idx	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		const MBG_EVENT_SETTINGS *	p,
		uint16_t	idx
	)

Write monitoring event settings in MBG_EVENT_SETTINGS format.

Note: extended feature MBG_XFEATURE_MONITORING must be set idx shall be the type of the appropriate event, it should be checked if this event is supported in MBG_MONITORING_LIMITS::supp_num_events

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[in]	p	Pointer to the data structure to be sent to the device
[in]	idx	Index of the event settings to be written, type of the appropriate event

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_dev_has_monitoring; mbgextio_get_monitoring_limits; mbgextio_get_event_info_idx

Definition at line 10606 of file mbgextio.c.

References _mbg_mutex_acquire, _mbg_swab_event_settings_idx, MBG_MSG_CTL_s::dev_mutex, MSG_DATA::event_settings_idx, GPS_EVENT_IDX, MBG_EVENT_SETTINGS_IDX::idx, mbg_rc_is_error, mbgextio_chk_user_perm(), mbgextio_xmt_msg(), MBG_MSG_BUFF::msg_data, OPT_GPS_ACK_CODE, MBG_MSG_XMT_CTL::pmb, MBG_EVENT_SETTINGS_IDX::settings, MBG_MSG_BUFF::u, USER_PERM_MONITORING, USER_SCOPE_CONFIG_WRITE_MSK, and MBG_MSG_CTL_s::xmt.

◆ mbgextio_set_fdm_tdev()

int mbgextio_set_fdm_tdev	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		const NANO_TIME_64 *	p
	)

Set time deviation of powerline time in relation to the current reference time.

Note: Only supported if MBG_IMS_STATE_FLAG_BIT_HAS_FDM is set in MBG_IMS_STATE::flags and MBG_IMS_FDM_FLAG_CAN_SET_TDEV is set in MBG_IMS_FDM_INFO::flags

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[in]	p	Pointer to the data structure to be sent to the device

Returns: One of the MBG_RETURN_CODES

Definition at line 13474 of file mbgextio.c.

References _mbg_mutex_acquire, _mbg_swab_nano_time_64, MBG_MSG_CTL_s::dev_mutex, GPS_FDM_SET_TD, mbg_rc_is_error, mbgextio_chk_user_perm(), mbgextio_xmt_msg(), MBG_MSG_BUFF::msg_data, MSG_DATA::nano_time_64, OPT_GPS_ACK_CODE, MBG_MSG_XMT_CTL::pmb, MBG_MSG_BUFF::u, USER_PERM_FDM, USER_SCOPE_CONFIG_WRITE_MSK, and MBG_MSG_CTL_s::xmt.

◆ mbgextio_set_gnss_mode_settings()

int mbgextio_set_gnss_mode_settings	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		const MBG_GNSS_MODE_SETTINGS *	p
	)

Write GNSS mode settings.

Note: Some devices may not support GNSS configuration

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[in]	p	Pointer to a MBG_GNSS_MODE_SETTINGS structure to be sent

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_get_gnss_mode_info

Definition at line 8406 of file mbgextio.c.

References _mbg_mutex_acquire, _mbg_swab_mbg_gnss_mode_settings, MBG_MSG_CTL_s::dev_mutex, MSG_DATA::gnss_mode_settings, GPS_GNSS_MODE, mbg_rc_is_error, mbgextio_chk_user_perm(), mbgextio_xmt_msg(), MBG_MSG_BUFF::msg_data, OPT_GPS_ACK_CODE, MBG_MSG_XMT_CTL::pmb, MBG_MSG_BUFF::u, USER_PERM_RECEIVER, USER_SCOPE_CONFIG_WRITE_MSK, and MBG_MSG_CTL_s::xmt.

◆ mbgextio_set_gpio_settings_idx()

int mbgextio_set_gpio_settings_idx	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		const MBG_GPIO_SETTINGS *	p,
		uint16_t	idx
	)

Send configuration settings for a specific GPIO.

Note: This is only supported if GPS_HAS_GPIO is set in RECEIVER_INFO::features

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to be sent to the device
[in]	idx	Index of the pulse output to be configured, 0..MBG_GPIO_CFG_LIMITS::num_io - 1

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_get_all_gpio_info

Definition at line 7748 of file mbgextio.c.

References _mbg_mutex_acquire, _mbg_swab_mbg_gpio_settings_idx, MBG_MSG_CTL_s::dev_mutex, MSG_DATA::gpio_settings_idx, GPS_GPIO_SETTINGS_IDX, MBG_GPIO_SETTINGS_IDX::idx, mbg_rc_is_error, mbgextio_chk_user_perm(), mbgextio_xmt_msg(), MBG_MSG_BUFF::msg_data, OPT_GPS_ACK_CODE, MBG_MSG_XMT_CTL::pmb, MBG_GPIO_SETTINGS_IDX::settings, MBG_MSG_BUFF::u, USER_PERM_IOPORTS, USER_SCOPE_CONFIG_WRITE_MSK, and MBG_MSG_CTL_s::xmt.

◆ mbgextio_set_holdover_interval()

int mbgextio_set_holdover_interval	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		const XMR_HOLDOVER_INTV *	p
	)

Set the XMR holdover interval.

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to be sent to the device

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_get_holdover_interval_counter

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to be sent to the device

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_get_holdover_interval_counter

Definition at line 8092 of file mbgextio.c.

References _mbg_mutex_acquire, _mbg_swab_xmr_holdover_intv, MBG_MSG_CTL_s::dev_mutex, GPS_XMR_HOLDOVER_INTV, mbgextio_xmt_msg(), MBG_MSG_BUFF::msg_data, OPT_GPS_ACK_CODE, MBG_MSG_XMT_CTL::pmb, MBG_MSG_BUFF::u, MSG_DATA::xmr_holdover_intv, and MBG_MSG_CTL_s::xmt.

◆ mbgextio_set_hq_rx_settings()

int mbgextio_set_hq_rx_settings	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		const HAVEQUICK_SETTINGS *	p
	)

Send new configuration settings for the device's HAVEQUICK input.

Note: This is only supported if MULTI_REF_HAVEQUICK is > 0 in XMULTI_REF_INSTANCES::n_inst //##+++++++++++++++++++++++ ???

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to be sent to the device

Returns: One of the MBG_RETURN_CODES

See also: //##+++++++++++++++++++++

Definition at line 8279 of file mbgextio.c.

References _mbg_mutex_acquire, _mbg_swab_havequick_settings, MBG_MSG_CTL_s::dev_mutex, GPS_HAVEQUICK_RX_SETTINGS, MSG_DATA::havequick_settings, mbgextio_xmt_msg(), MBG_MSG_BUFF::msg_data, OPT_GPS_ACK_CODE, MBG_MSG_XMT_CTL::pmb, MBG_MSG_BUFF::u, and MBG_MSG_CTL_s::xmt.

◆ mbgextio_set_hq_tx_settings()

int mbgextio_set_hq_tx_settings	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		const HAVEQUICK_SETTINGS *	p
	)

Send new configuration settings for the device's HAVEQUICK output.

Note: This is only supported if GPS_HAS_HAVEQUICK is set in RECEIVER_INFO::features

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to be sent to the device

Returns: One of the MBG_RETURN_CODES

See also: //##+++++++++++++++++++++

Definition at line 8246 of file mbgextio.c.

References _mbg_mutex_acquire, _mbg_swab_havequick_settings, MBG_MSG_CTL_s::dev_mutex, GPS_HAVEQUICK_TX_SETTINGS, MSG_DATA::havequick_settings, mbgextio_xmt_msg(), MBG_MSG_BUFF::msg_data, OPT_GPS_ACK_CODE, MBG_MSG_XMT_CTL::pmb, MBG_MSG_BUFF::u, and MBG_MSG_CTL_s::xmt.

◆ mbgextio_set_ignore_lock()

int mbgextio_set_ignore_lock	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		const IGNORE_LOCK *	p
	)

Send the ignore lock configuration.

Note: Only supported if GPS_HAS_IGNORE_LOCK

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to be sent to the device

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_get_ignore_lock

Definition at line 5904 of file mbgextio.c.

References _mbg_mutex_acquire, _mbg_swab16, MBG_MSG_CTL_s::dev_mutex, GPS_IGNORE_LOCK, MSG_DATA::ignore_lock, mbg_rc_is_error, mbgextio_chk_user_perm(), mbgextio_xmt_msg(), MBG_MSG_BUFF::msg_data, OPT_GPS_ACK_CODE, MBG_MSG_XMT_CTL::pmb, MBG_MSG_BUFF::u, USER_PERM_RECEIVER, USER_SCOPE_CONFIG_WRITE_MSK, and MBG_MSG_CTL_s::xmt.

◆ mbgextio_set_ims_fdm_output_settings_idx()

int mbgextio_set_ims_fdm_output_settings_idx	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		const MBG_IMS_FDM_OUTPUT_SETTINGS *	p,
		uint16_t	idx
	)

Write a MBG_IMS_FDM_OUTPUT_SETTINGS parameter structure to a device.

The MBG_IMS_FDM_SETTINGS parameter structure contains the analog output mode

Note: Only supported if MBG_IMS_STATE_FLAG_BIT_HAS_FDM is set in MBG_IMS_STATE::flags

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[in]	p	Pointer to the data structure to be sent to the device
[in]	idx	Index of the array element to be set, 0..MBG_IMS_FDM_LIMITS::n_outputs-1

Returns: One of the MBG_RETURN_CODES

Definition at line 13437 of file mbgextio.c.

References _mbg_mutex_acquire, _mbg_swab_mbg_ims_fdm_output_settings_idx, MBG_MSG_CTL_s::dev_mutex, MSG_DATA::fdm_output_settings_idx, GPS_FDM_OUTPUT_SETTINGS_IDX, MBG_IMS_FDM_OUTPUT_SETTINGS_IDX::idx, mbg_rc_is_error, mbgextio_chk_user_perm(), mbgextio_xmt_msg(), MBG_MSG_BUFF::msg_data, OPT_GPS_ACK_CODE, MBG_MSG_XMT_CTL::pmb, MBG_IMS_FDM_OUTPUT_SETTINGS_IDX::settings, MBG_MSG_BUFF::u, USER_PERM_FDM, USER_SCOPE_CONFIG_WRITE_MSK, and MBG_MSG_CTL_s::xmt.

◆ mbgextio_set_ims_fdm_settings()

int mbgextio_set_ims_fdm_settings	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		const MBG_IMS_FDM_SETTINGS *	p
	)

Write a MBG_IMS_FDM_SETTINGS parameter structure to a device.

The MBG_IMS_FDM_SETTINGS parameter structure contains the limits for time and frequency deviation and the nominal frequency

Note: Only supported if MBG_IMS_STATE_FLAG_BIT_HAS_FDM is set in MBG_IMS_STATE::flags

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[in]	p	Pointer to the data structure to be sent to the device

Returns: One of the MBG_RETURN_CODES

Definition at line 13400 of file mbgextio.c.

References _mbg_mutex_acquire, _mbg_swab_mbg_ims_fdm_settings, MBG_MSG_CTL_s::dev_mutex, MSG_DATA::fdm_settings, GPS_FDM_SETTINGS, mbg_rc_is_error, mbgextio_chk_user_perm(), mbgextio_xmt_msg(), MBG_MSG_BUFF::msg_data, OPT_GPS_ACK_CODE, MBG_MSG_XMT_CTL::pmb, MBG_MSG_BUFF::u, USER_PERM_FDM, USER_SCOPE_CONFIG_WRITE_MSK, and MBG_MSG_CTL_s::xmt.

◆ mbgextio_set_io_port_settings_idx()

int mbgextio_set_io_port_settings_idx	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		const MBG_IO_PORT_SETTINGS *	p,
		uint8_t	idx
	)

Send I/O port settings in MBG_IO_PORT_SETTINGS format.

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to be sent to the device
[in]	idx	Index of I/O port settings to be configured, 0..MBG_IO_PORT_LIMITS::num_ports - 1

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_get_io_port_limits; mbgextio_get_io_port_info_idx; mbgextio_get_io_port_type_info_idx; mbgextio_get_io_port_status_idx

Definition at line 5476 of file mbgextio.c.

References _mbg_mutex_acquire, _mbg_swab_io_port_settings_idx, MBG_MSG_CTL_s::dev_mutex, GPS_IO_PORT_SETTINGS_IDX, MBG_IO_PORT_SETTINGS_IDX::idx, MSG_DATA::iop_settings_idx, MBG_IO_PORT_SETTINGS_IDX_SIZES, mbg_rc_is_error, mbgextio_chk_user_perm(), mbgextio_xmt_msg(), MBG_MSG_BUFF::msg_data, OPT_GPS_ACK_CODE, MBG_MSG_XMT_CTL::pmb, MBG_IO_PORT_SETTINGS::port_type, MBG_IO_PORT_SETTINGS_IDX::settings, MBG_MSG_BUFF::u, USER_PERM_IOPORTS, USER_SCOPE_CONFIG_WRITE_MSK, and MBG_MSG_CTL_s::xmt.

◆ mbgextio_set_ip4_settings()

int mbgextio_set_ip4_settings	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		const IP4_SETTINGS *	p
	)

Save the current ipv4 settings IP4_SETTINGS format.

Note: ptp or xmr with ntp feature must set

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to be sent to the device

Returns: One of the MBG_RETURN_CODES

See also: //##+++++++++++++

Definition at line 9083 of file mbgextio.c.

References _mbg_mutex_acquire, _mbg_swab_ip4_settings, MBG_MSG_CTL_s::dev_mutex, GPS_IP4_SETTINGS, MSG_DATA::ip4_settings, mbg_rc_is_error, mbgextio_chk_user_perm(), mbgextio_xmt_msg(), MBG_MSG_BUFF::msg_data, OPT_GPS_ACK_CODE, MBG_MSG_XMT_CTL::pmb, MBG_MSG_BUFF::u, USER_PERM_NETWORK, USER_SCOPE_CONFIG_WRITE_MSK, and MBG_MSG_CTL_s::xmt.

◆ mbgextio_set_irig_rx_settings()

int mbgextio_set_irig_rx_settings	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		const IRIG_SETTINGS *	p
	)

Send new configuration settings for the device's IRIG input.

Note: This is only supported if GPS_HAS_IRIG_RX is set in RECEIVER_INFO::features

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to be sent to the device

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_get_irig_rx_info

Definition at line 7166 of file mbgextio.c.

References _mbg_mutex_acquire, _mbg_swab_irig_settings, MBG_MSG_CTL_s::dev_mutex, GPS_IRIG_RX_SETTINGS, MSG_DATA::irig_rx_settings, mbg_rc_is_error, mbgextio_chk_user_perm(), mbgextio_xmt_msg(), MBG_MSG_BUFF::msg_data, OPT_GPS_ACK_CODE, MBG_MSG_XMT_CTL::pmb, MBG_MSG_BUFF::u, USER_PERM_IOPORTS, USER_SCOPE_CONFIG_WRITE_MSK, and MBG_MSG_CTL_s::xmt.

◆ mbgextio_set_irig_tx_settings()

int mbgextio_set_irig_tx_settings	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		const IRIG_SETTINGS *	p
	)

Send new configuration settings for the device's IRIG output.

Note: This is only supported if GPS_HAS_IRIG_TX is set in RECEIVER_INFO::features

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to be sent to the device

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_get_irig_tx_info

Definition at line 7095 of file mbgextio.c.

References _mbg_mutex_acquire, _mbg_swab_irig_settings, MBG_MSG_CTL_s::dev_mutex, GPS_IRIG_TX_SETTINGS, MSG_DATA::irig_tx_settings, mbg_rc_is_error, mbgextio_chk_user_perm(), mbgextio_xmt_msg(), MBG_MSG_BUFF::msg_data, OPT_GPS_ACK_CODE, MBG_MSG_XMT_CTL::pmb, MBG_MSG_BUFF::u, USER_PERM_IOPORTS, USER_SCOPE_CONFIG_WRITE_MSK, and MBG_MSG_CTL_s::xmt.

◆ mbgextio_set_lne_port_settings_idx()

int mbgextio_set_lne_port_settings_idx	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		const MBG_LNE_PORT_SETTINGS *	p,
		uint16_t	idx
	)

Write a MBG_LNE_PORT_SETTINGS parameter structure to a device.

Note: ### ::TODO Only supported if MBG_IMS_STATE_FLAG_BIT_HAS_FDM is set in MBG_IMS_STATE::flags

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[in]	p	Pointer to the data structure to be sent to the device
[in]	idx	Index of the array element to be set, 0..MBG_LNE_LIMITS::num_ports - 1

Returns: One of the MBG_RETURN_CODES

Definition at line 13615 of file mbgextio.c.

References _mbg_mutex_acquire, _mbg_swab_mbg_lne_port_settings_idx, MBG_MSG_CTL_s::dev_mutex, GPS_LNE_PORT_SETTINGS_IDX, MBG_LNE_PORT_SETTINGS_IDX::idx, MSG_DATA::lne_port_settings_idx, mbgextio_xmt_msg(), MBG_MSG_BUFF::msg_data, OPT_GPS_ACK_CODE, MBG_MSG_XMT_CTL::pmb, MBG_LNE_PORT_SETTINGS_IDX::settings, MBG_MSG_BUFF::u, and MBG_MSG_CTL_s::xmt.

◆ mbgextio_set_msg_rcv_timeout()

void mbgextio_set_msg_rcv_timeout	(	MBG_MSG_CTL *	pmctl,
		ulong	new_timeout
	)

Set message receive timeout value.

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	new_timeout	New timeout value [ms]

See also: mbgextio_set_dev_poll_timeout; mbgextio_get_dev_poll_timeout; mbgextio_get_msg_rcv_timeout

Definition at line 3283 of file mbgextio.c.

◆ mbgextio_set_net_dns_srch_dom_idx()

int mbgextio_set_net_dns_srch_dom_idx	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		const MBG_NET_NAME *	p,
		uint16_t	idx
	)

Send the network DNS search domain in MBG_NET_NAME format.

The number of DNS search domains supported by the device is specified in MBG_NET_GLB_CFG_INFO::n_supp_dns_srch_dom

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to be sent to the device
[in]	idx	Index of the DNS search domain entry to be configured, 0..MBG_NET_GLB_CFG_INFO::n_supp_dns_srch_dom - 1

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_get_net_dns_srch_dom_idx; mbgextio_get_net_stat_dns_srch_dom_stat_idx

Definition at line 12264 of file mbgextio.c.

References _mbg_mutex_acquire, _mbg_swab_net_name, MBG_MSG_CTL_s::dev_mutex, GPS_NET_DNS_SRCH_DOM, MBG_NET_NAME_IDX::idx, mbg_rc_is_error, mbgextio_chk_user_perm(), mbgextio_xmt_msg(), MBG_MSG_BUFF::msg_data, MBG_NET_NAME_IDX::net_name, MSG_DATA::net_name_idx, OPT_GPS_ACK_CODE, MBG_MSG_XMT_CTL::pmb, MBG_MSG_BUFF::u, USER_PERM_NETWORK, USER_SCOPE_CONFIG_WRITE_MSK, and MBG_MSG_CTL_s::xmt.

◆ mbgextio_set_net_dns_srvr_idx()

int mbgextio_set_net_dns_srvr_idx	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		const MBG_IP_ADDR *	p,
		uint16_t	idx
	)

Send the network DNS server address in MBG_IP_ADDR format.

The number of DNS search domains supported by the device is specified in MBG_NET_GLB_CFG_INFO::n_supp_dns_srvr

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to be sent to the device
[in]	idx	Index of the DNS server port to be configured, 0..MBG_NET_GLB_CFG_INFO::n_supp_dns_srvr - 1

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_get_net_dns_srvr_idx; mbgextio_get_net_stat_dns_srvr_idx

Definition at line 12188 of file mbgextio.c.

References _mbg_mutex_acquire, _mbg_swab_ip_addr_idx, MBG_IP_ADDR_IDX::addr, MBG_MSG_CTL_s::dev_mutex, GPS_NET_DNS_SRVR, MBG_IP_ADDR_IDX::idx, MSG_DATA::ip_addr_idx, mbg_rc_is_error, mbgextio_chk_user_perm(), mbgextio_xmt_msg(), MBG_MSG_BUFF::msg_data, OPT_GPS_ACK_CODE, MBG_MSG_XMT_CTL::pmb, MBG_MSG_BUFF::u, USER_PERM_NETWORK, USER_SCOPE_CONFIG_WRITE_MSK, and MBG_MSG_CTL_s::xmt.

◆ mbgextio_set_net_glb_cfg_settings()

int mbgextio_set_net_glb_cfg_settings	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		const MBG_NET_GLB_CFG_SETTINGS *	p
	)

Set the device's global network configuration settings.

Note: The function is not supported by all devices. //##++++++++++++

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to be sent to the device

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_get_net_glb_cfg_info

Definition at line 12114 of file mbgextio.c.

References _mbg_mutex_acquire, _mbg_swab_net_glb_cfg_settings, MBG_MSG_CTL_s::dev_mutex, GPS_NET_GLB_CFG, mbg_rc_is_error, mbgextio_chk_user_perm(), mbgextio_xmt_msg(), MBG_MSG_BUFF::msg_data, MSG_DATA::net_glb_cfg_settings, OPT_GPS_ACK_CODE, MBG_MSG_XMT_CTL::pmb, MBG_MSG_BUFF::u, USER_PERM_NETWORK, USER_SCOPE_CONFIG_WRITE_MSK, and MBG_MSG_CTL_s::xmt.

◆ mbgextio_set_net_intf_addr_settings_idx()

int mbgextio_set_net_intf_addr_settings_idx	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		const MBG_NET_INTF_ADDR_SETTINGS *	p,
		uint16_t	idx
	)

Send the network addr configuration in MBG_NET_INTF_ADDR_SETTINGS format.

Note: GPS_HAS_NET_CFG must be set and MBG_NET_GLB_SUPP_STAGE_2_MASK must be set in MBG_NET_GLB_CFG_INFO::feat_flags

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to be sent to the device
[in]	idx	Index of the link to be configured, 0..MBG_NET_GLB_CFG_INFO::n_supp_intf_addr - 1

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_get_net_intf_addr_info_idx

Definition at line 12484 of file mbgextio.c.

References _mbg_mutex_acquire, _mbg_swab_net_intf_addr_settings_idx, MBG_MSG_CTL_s::dev_mutex, GPS_NET_INTF_ADDR_IDX, MBG_NET_INTF_ADDR_SETTINGS_IDX::idx, mbg_rc_is_error, mbgextio_chk_user_perm(), mbgextio_xmt_msg(), MBG_MSG_BUFF::msg_data, MSG_DATA::net_intf_addr_settings_idx, OPT_GPS_ACK_CODE, MBG_MSG_XMT_CTL::pmb, MBG_NET_INTF_ADDR_SETTINGS_IDX::settings, MBG_MSG_BUFF::u, USER_PERM_NETWORK, USER_SCOPE_CONFIG_WRITE_MSK, and MBG_MSG_CTL_s::xmt.

◆ mbgextio_set_net_intf_link_settings_idx()

int mbgextio_set_net_intf_link_settings_idx	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		const MBG_NET_INTF_LINK_SETTINGS *	p,
		uint16_t	idx
	)

Send the network link configuration in MBG_NET_INTF_LINK_SETTINGS format.

Note: GPS_HAS_NET_CFG must be set and MBG_NET_GLB_SUPP_STAGE_2_MASK must be set in MBG_NET_GLB_CFG_INFO::feat_flags

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to be sent to the device
[in]	idx	Index of the link to be configured, 0..MBG_NET_GLB_CFG_INFO::n_supp_intf_link - 1

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_get_net_intf_link_info_idx

Definition at line 12409 of file mbgextio.c.

References _mbg_mutex_acquire, _mbg_swab_net_intf_link_settings_idx, MBG_MSG_CTL_s::dev_mutex, GPS_NET_INTF_LINK_IDX, MBG_NET_INTF_LINK_SETTINGS_IDX::idx, mbg_rc_is_error, mbgextio_chk_user_perm(), mbgextio_xmt_msg(), MBG_MSG_BUFF::msg_data, MSG_DATA::net_intf_link_settings_idx, OPT_GPS_ACK_CODE, MBG_MSG_XMT_CTL::pmb, MBG_NET_INTF_LINK_SETTINGS_IDX::settings, MBG_MSG_BUFF::u, USER_PERM_NETWORK, USER_SCOPE_CONFIG_WRITE_MSK, and MBG_MSG_CTL_s::xmt.

◆ mbgextio_set_net_intf_route_settings_idx()

int mbgextio_set_net_intf_route_settings_idx	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		const MBG_NET_INTF_ROUTE_SETTINGS *	p,
		uint16_t	idx
	)

Send the network addr configuration in MBG_NET_INTF_ROUTE_SETTINGS format.

Note: GPS_HAS_NET_CFG must be set and MBG_NET_GLB_SUPP_STAGE_2_MASK must be set in MBG_NET_GLB_CFG_INFO::feat_flags

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to be sent to the device
[in]	idx	Index of the link to be configured, 0..MBG_NET_GLB_CFG_INFO::n_supp_intf_route - 1

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_get_net_intf_route_info_idx

Definition at line 12559 of file mbgextio.c.

References _mbg_mutex_acquire, _mbg_swab_net_intf_route_settings_idx, MBG_MSG_CTL_s::dev_mutex, GPS_NET_INTF_ROUTE_IDX, MBG_NET_INTF_ROUTE_SETTINGS_IDX::idx, mbg_rc_is_error, mbgextio_chk_user_perm(), mbgextio_xmt_msg(), MBG_MSG_BUFF::msg_data, MSG_DATA::net_intf_route_settings_idx, OPT_GPS_ACK_CODE, MBG_MSG_XMT_CTL::pmb, MBG_NET_INTF_ROUTE_SETTINGS_IDX::settings, MBG_MSG_BUFF::u, USER_PERM_NETWORK, USER_SCOPE_CONFIG_WRITE_MSK, and MBG_MSG_CTL_s::xmt.

◆ mbgextio_set_ntp_clnt_mode_cfg()

int mbgextio_set_ntp_clnt_mode_cfg	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		const NTP_CLNT_MODE_SETTINGS *	p
	)

Send the NTP client mode configuration.

Note: This is only supported by NTP devices

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to be sent to the device

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_get_ntp_glb_info; mbgextio_get_ntp_clnt_mode_info; mbgextio_get_ntp_peer_settings_idx; mbgextio_set_ntp_peer_settings_idx

Definition at line 11712 of file mbgextio.c.

References _mbg_mutex_acquire, _mbg_swab_ntp_clnt_mode_settings, MBG_MSG_CTL_s::dev_mutex, GPS_NTP_CLNT_MODE_CFG, mbg_rc_is_error, mbgextio_chk_user_perm(), mbgextio_xmt_msg(), MBG_MSG_BUFF::msg_data, MSG_DATA::ntp_clnt_mode_settings, OPT_GPS_ACK_CODE, MBG_MSG_XMT_CTL::pmb, MBG_MSG_BUFF::u, USER_PERM_NTP, USER_SCOPE_CONFIG_WRITE_MSK, and MBG_MSG_CTL_s::xmt.

◆ mbgextio_set_ntp_glb_info()

int mbgextio_set_ntp_glb_info	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		const NTP_GLB_SETTINGS *	p
	)

Send the NTP global configuration.

Note: This is only supported by NTP devices

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to be sent to the device

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_get_ant_cable_len

Definition at line 11337 of file mbgextio.c.

References _mbg_mutex_acquire, _mbg_swab_ntp_glb_settings, MBG_MSG_CTL_s::dev_mutex, GPS_NTP_GLB_CFG, mbg_rc_is_error, mbgextio_chk_user_perm(), mbgextio_xmt_msg(), MBG_MSG_BUFF::msg_data, MSG_DATA::ntp_glb_settings, OPT_GPS_ACK_CODE, MBG_MSG_XMT_CTL::pmb, MBG_MSG_BUFF::u, USER_PERM_NTP, USER_SCOPE_CONFIG_WRITE_MSK, and MBG_MSG_CTL_s::xmt.

◆ mbgextio_set_ntp_misc_orphan_mode_settings()

int mbgextio_set_ntp_misc_orphan_mode_settings	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		const NTP_MISC_ORPHAN_MODE_SETTINGS *	p
	)

Send the NTP orphan mode configuration in NTP_MISC_ORPHAN_MODE_SETTINGS format.

Note: NTP_MISC_MSK_ORPHAN_MODE must be set in NTP_MISC_LIMITS::supp_flags

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to be sent to the device

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_get_ntp_glb_info; mbgextio_get_ntp_misc_limits; mbgextio_get_ntp_misc_orphan_mode_info

Definition at line 11633 of file mbgextio.c.

References _mbg_mutex_acquire, _mbg_swab_ntp_misc_orphan_mode_settings, MBG_MSG_CTL_s::dev_mutex, GPS_NTP_MISC_ORPHAN_MODE, mbg_rc_is_error, mbgextio_chk_user_perm(), mbgextio_xmt_msg(), MBG_MSG_BUFF::msg_data, MSG_DATA::ntp_misc_orphan_mode_settings, OPT_GPS_ACK_CODE, MBG_MSG_XMT_CTL::pmb, MBG_MSG_BUFF::u, USER_PERM_NTP, USER_SCOPE_CONFIG_WRITE_MSK, and MBG_MSG_CTL_s::xmt.

◆ mbgextio_set_ntp_peer_settings_idx()

int mbgextio_set_ntp_peer_settings_idx	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		const NTP_PEER_SETTINGS *	p,
		uint16_t	idx
	)

Send configuration settings for a specific NTP peer.

The number of supported NTP peers is specified in NTP_CLNT_MODE_INFO::n_supp_peers -1.

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to be sent to the device
[in]	idx	Index of the NTP peer to be configured, 0 ... NTP_CLNT_MODE_INFO::n_supp_peers - 1

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_get_ntp_glb_info; mbgextio_get_ntp_peer_settings_idx; mbgextio_get_ntp_clnt_mode_info

Definition at line 11788 of file mbgextio.c.

References _mbg_mutex_acquire, _mbg_swab_ntp_peer_settings_idx, MBG_MSG_CTL_s::dev_mutex, GPS_NTP_PEER_SETTINGS_IDX, NTP_PEER_SETTINGS_IDX::idx, mbg_rc_is_error, mbgextio_chk_user_perm(), mbgextio_xmt_msg(), MBG_MSG_BUFF::msg_data, MSG_DATA::ntp_peer_settings_idx, OPT_GPS_ACK_CODE, NTP_PEER_SETTINGS_IDX::peer_settings, MBG_MSG_XMT_CTL::pmb, MBG_MSG_BUFF::u, USER_PERM_NTP, USER_SCOPE_CONFIG_WRITE_MSK, and MBG_MSG_CTL_s::xmt.

◆ mbgextio_set_ntp_refclk_cfg_settings_idx()

int mbgextio_set_ntp_refclk_cfg_settings_idx	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		const NTP_REFCLK_CFG_SETTINGS *	p,
		uint16_t	idx
	)

Send NTP refclk config settings with the given index in NTP_REFCLK_CFG_SETTINGS format.

Note: NTP feature GPS_FEAT_NTP must be set; NTP roles NTP_ROLE_SERVER or NTP_ROLE_CLIENT_SERVER must be set in NTP_GLB_INFO::supp_ntp_roles

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to be sent to the device
[in]	idx	Index of the NTP refclock config to be set, 0 ... NTP_SRV_MODE_SETTINGS::num_refclks - 1

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_get_ntp_glb_info; mbgextio_get_ntp_srv_mode_info; mbgextio_get_ntp_refclk_cfg_info_idx

Definition at line 11941 of file mbgextio.c.

References _mbg_mutex_acquire, _mbg_swab_ntp_refclk_cfg_settings_idx, MBG_MSG_CTL_s::dev_mutex, GPS_NTP_REFCLK_CFG, NTP_REFCLK_CFG_SETTINGS_IDX::idx, mbg_rc_is_error, mbgextio_chk_user_perm(), mbgextio_xmt_msg(), MBG_MSG_BUFF::msg_data, MSG_DATA::ntp_refclk_cfg_settings_idx, OPT_GPS_ACK_CODE, MBG_MSG_XMT_CTL::pmb, NTP_REFCLK_CFG_SETTINGS_IDX::settings, MBG_MSG_BUFF::u, USER_PERM_NTP, USER_SCOPE_CONFIG_WRITE_MSK, and MBG_MSG_CTL_s::xmt.

◆ mbgextio_set_ntp_srv_mode_cfg()

int mbgextio_set_ntp_srv_mode_cfg	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		const NTP_SRV_MODE_SETTINGS *	p
	)

Send the NTP server mode configuration.

Note: NTP feature GPS_FEAT_NTP must be set; NTP roles NTP_ROLE_SERVER or NTP_ROLE_CLIENT_SERVER must be set in NTP_GLB_INFO::supp_ntp_roles

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to be sent to the device

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_get_ntp_glb_info; mbgextio_get_ntp_srv_mode_info

Definition at line 11863 of file mbgextio.c.

References _mbg_mutex_acquire, _mbg_swab_ntp_srv_mode_settings, MBG_MSG_CTL_s::dev_mutex, GPS_NTP_SRV_MODE_CFG, mbg_rc_is_error, mbgextio_chk_user_perm(), mbgextio_xmt_msg(), MBG_MSG_BUFF::msg_data, MSG_DATA::ntp_srv_mode_settings, OPT_GPS_ACK_CODE, MBG_MSG_XMT_CTL::pmb, MBG_MSG_BUFF::u, USER_PERM_NTP, USER_SCOPE_CONFIG_WRITE_MSK, and MBG_MSG_CTL_s::xmt.

◆ mbgextio_set_ntp_symm_key_settings_idx()

int mbgextio_set_ntp_symm_key_settings_idx	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		const NTP_SYMM_KEY_SETTINGS *	p,
		uint16_t	idx
	)

Send NTP symmetric key settings with the given index in NTP_SYMM_KEY_SETTINGS format.

Note: NTP_MSK_SYMM_KEYS must be set in NTP_GLB_INFO::supp_flags

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to be sent to the device
[in]	idx	Index of the NTP symmetric key to be configured, 0 ... NTP_GLB_SETTINGS::num_symm_keys - 1

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_get_ntp_glb_info; mbgextio_get_ntp_symm_key_limits; mbgextio_get_ntp_symm_key_info_idx

Definition at line 11447 of file mbgextio.c.

References _mbg_mutex_acquire, _mbg_swab_ntp_symm_key_settings_idx, MBG_MSG_CTL_s::dev_mutex, GPS_NTP_SYMM_KEY_CFG, NTP_SYMM_KEY_SETTINGS_IDX::idx, mbg_rc_is_error, mbgextio_chk_user_perm(), mbgextio_xmt_msg(), MBG_MSG_BUFF::msg_data, MSG_DATA::ntp_symm_key_settings_idx, OPT_GPS_ACK_CODE, MBG_MSG_XMT_CTL::pmb, NTP_SYMM_KEY_SETTINGS_IDX::settings, MBG_MSG_BUFF::u, USER_PERM_NTP, USER_SCOPE_CONFIG_WRITE_MSK, and MBG_MSG_CTL_s::xmt.

◆ mbgextio_set_ntp_trusted_key_settings_idx()

int mbgextio_set_ntp_trusted_key_settings_idx	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		const NTP_TRUSTED_KEY_SETTINGS *	p,
		uint16_t	idx
	)

Send NTP trusted key settings with the given index in NTP_TRUSTED_KEY_SETTINGS format.

Note: NTP_MSK_TRUSTED_KEYS must be set in NTP_GLB_INFO::supp_flags

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to be sent to the device
[in]	idx	Index of the NTP trusted key to be configured, 0 ... NTP_GLB_SETTINGS::num_trusted_keys - 1

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_get_ntp_glb_info; mbgextio_get_ntp_trusted_key_info_idx

Definition at line 11524 of file mbgextio.c.

References _mbg_mutex_acquire, _mbg_swab_ntp_trusted_key_settings_idx, MBG_MSG_CTL_s::dev_mutex, GPS_NTP_TRUSTED_KEY_CFG, NTP_TRUSTED_KEY_SETTINGS_IDX::idx, mbg_rc_is_error, mbgextio_chk_user_perm(), mbgextio_xmt_msg(), MBG_MSG_BUFF::msg_data, MSG_DATA::ntp_trusted_key_settings_idx, OPT_GPS_ACK_CODE, MBG_MSG_XMT_CTL::pmb, NTP_TRUSTED_KEY_SETTINGS_IDX::settings, MBG_MSG_BUFF::u, USER_PERM_NTP, USER_SCOPE_CONFIG_WRITE_MSK, and MBG_MSG_CTL_s::xmt.

◆ mbgextio_set_opt_settings()

int mbgextio_set_opt_settings	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		const MBG_OPT_SETTINGS *	p
	)

Send new optional settings flags.

Note: This is only supported if GPS_HAS_OPT_SETTINGS is set in RECEIVER_INFO::features

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to be sent to the device

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_get_opt_info

Definition at line 7371 of file mbgextio.c.

References _mbg_mutex_acquire, _mbg_swab_mbg_opt_settings, MBG_MSG_CTL_s::dev_mutex, GPS_OPT_SETTINGS, mbgextio_xmt_msg(), MBG_MSG_BUFF::msg_data, OPT_GPS_ACK_CODE, MSG_DATA::opt_settings, MBG_MSG_XMT_CTL::pmb, MBG_MSG_BUFF::u, and MBG_MSG_CTL_s::xmt.

◆ mbgextio_set_port_parm()

int mbgextio_set_port_parm	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		const PORT_PARM *	p
	)

Send serial port parameters in PORT_PARM format.

Deprecated:: This function is deprecated since the PORT_PARM structure supports only 2 serial ports, and does not not support configuration of a string type. The function mbgextio_save_serial_settings should be used instead.

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to be sent to the device

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_get_serial_settings; mbgextio_save_serial_settings; mbgextio_get_port_parm; mbgextio_setup_receiver_info

Deprecated:: This function is deprecated since the PORT_PARM structure supports only 2 serial ports, and does not not support configuration of a string type. The function mbgextio_save_serial_settings should be used instead.

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to be sent to the device

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_get_serial_settings; mbgextio_save_serial_settings; mbgextio_get_port_parm; mbgextio_setup_receiver_info

Definition at line 6300 of file mbgextio.c.

References _mbg_mutex_acquire, _mbg_swab_port_parm, MBG_MSG_CTL_s::dev_mutex, GPS_PORT_PARM, mbgextio_xmt_msg(), MBG_MSG_BUFF::msg_data, OPT_GPS_ACK_CODE, MBG_MSG_XMT_CTL::pmb, MSG_DATA::port_parm, MBG_MSG_BUFF::u, and MBG_MSG_CTL_s::xmt.

◆ mbgextio_set_port_settings_idx()

int mbgextio_set_port_settings_idx	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		const PORT_SETTINGS *	p,
		uint16_t	idx
	)

Send configuration settings for a specific serial port.

The number of serial ports provided by the device is specified in RECEIVER_INFO::n_com_ports.

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to be sent to the device
[in]	idx	Index of the serial port to be configured, 0..RECEIVER_INFO::n_com_ports - 1

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_get_port_info_idx; mbgextio_get_all_port_info

Definition at line 7578 of file mbgextio.c.

References _mbg_mutex_acquire, _mbg_swab_port_settings_idx, MBG_MSG_CTL_s::dev_mutex, GPS_PORT_SETTINGS_IDX, PORT_SETTINGS_IDX::idx, mbg_rc_is_error, mbgextio_chk_user_perm(), mbgextio_xmt_msg(), MBG_MSG_BUFF::msg_data, OPT_GPS_ACK_CODE, MBG_MSG_XMT_CTL::pmb, PORT_SETTINGS_IDX::port_settings, MSG_DATA::port_settings_idx, MBG_MSG_BUFF::u, USER_PERM_SERIAL, USER_SCOPE_CONFIG_WRITE_MSK, and MBG_MSG_CTL_s::xmt.

◆ mbgextio_set_pos_lla()

int mbgextio_set_pos_lla	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		const LLA	lla
	)

Set the device's position by sending an LLA array.

Note: This function is only supported by GPS receivers

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	lla	Pointer to the data structure to be sent to the device

Returns: One of the MBG_RETURN_CODES

Definition at line 6038 of file mbgextio.c.

References _mbg_mutex_acquire, _mbg_swab_double, MBG_MSG_CTL_s::dev_mutex, GPS_POS_LLA, MSG_DATA::lla, mbg_rc_is_error, mbgextio_chk_user_perm(), mbgextio_xmt_msg(), MBG_MSG_BUFF::msg_data, N_LLA, OPT_GPS_ACK_CODE, MBG_MSG_XMT_CTL::pmb, swap_double(), MBG_MSG_BUFF::u, USER_PERM_RECEIVER, USER_SCOPE_CONFIG_WRITE_MSK, and MBG_MSG_CTL_s::xmt.

◆ mbgextio_set_pout_settings_idx()

int mbgextio_set_pout_settings_idx	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		const POUT_SETTINGS *	p,
		uint16_t	idx
	)

Send configuration settings for a specific programmable pulse output.

The number of supported pulse outputs is specified in RECEIVER_INFO::n_prg_out.

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to be sent to the device
[in]	idx	Index of the pulse output to be configured, 0..RECEIVER_INFO::n_prg_out - 1

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_get_pout_info_idx; mbgextio_get_all_pout_info

Definition at line 7708 of file mbgextio.c.

References _mbg_mutex_acquire, _mbg_swab_pout_settings_idx_on_set, MBG_MSG_CTL_s::dev_mutex, GPS_POUT_SETTINGS_IDX, POUT_SETTINGS_IDX::idx, mbg_rc_is_error, mbgextio_chk_user_perm(), mbgextio_xmt_msg(), MBG_MSG_BUFF::msg_data, OPT_GPS_ACK_CODE, MBG_MSG_XMT_CTL::pmb, POUT_SETTINGS_IDX::pout_settings, MSG_DATA::pout_settings_idx, MBG_MSG_BUFF::u, USER_PERM_IOPORTS, USER_SCOPE_CONFIG_WRITE_MSK, and MBG_MSG_CTL_s::xmt.

◆ mbgextio_set_ptp_cfg_settings()

int mbgextio_set_ptp_cfg_settings	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		const PTP_CFG_SETTINGS *	p
	)

Send configuration settings for PTP.

Note: This is only supported by PTP devices

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to be sent to the device

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_get_ptp_cfg_info

Definition at line 9298 of file mbgextio.c.

References _mbg_mutex_acquire, _mbg_swab_ptp_cfg_settings, MBG_MSG_CTL_s::dev_mutex, GPS_PTP_CFG, mbg_rc_is_error, mbgextio_chk_user_perm(), mbgextio_xmt_msg(), MBG_MSG_BUFF::msg_data, OPT_GPS_ACK_CODE, MBG_MSG_XMT_CTL::pmb, MSG_DATA::ptp_cfg_settings, MBG_MSG_BUFF::u, USER_PERM_PTP, USER_SCOPE_CONFIG_WRITE_MSK, and MBG_MSG_CTL_s::xmt.

◆ mbgextio_set_ptp_uc_master_settings_idx()

int mbgextio_set_ptp_uc_master_settings_idx	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		const PTP_UC_MASTER_SETTINGS *	p,
		uint16_t	idx
	)

Send PTP unicast master configuration settings for a PTP unicast slave mode device.

The number of supported PTP Masters is specified in PTP_UC_MASTER_CFG_LIMITS::n_supp_master.

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to be sent to the device
[in]	idx	Index of the PTP unicast grandmaster to be configured, 0 ... PTP_UC_MASTER_CFG_LIMITS::n_supp_master - 1 .

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_set_ptp_cfg_settings; mbgextio_get_all_ptp_uc_master_info; mbgextio_get_ptp_uc_master_cfg_limits; mbgextio_get_ptp_cfg_info; mbgextio_get_ptp_state

Definition at line 9340 of file mbgextio.c.

References _mbg_mutex_acquire, _mbg_swab_ptp_uc_master_settings_idx, MBG_MSG_CTL_s::dev_mutex, GPS_PTP_UC_MASTER_CFG, PTP_UC_MASTER_SETTINGS_IDX::idx, mbg_rc_is_error, mbgextio_chk_user_perm(), mbgextio_xmt_msg(), MBG_MSG_BUFF::msg_data, OPT_GPS_ACK_CODE, MBG_MSG_XMT_CTL::pmb, MSG_DATA::ptp_uc_master_settings_idx, PTP_UC_MASTER_SETTINGS_IDX::settings, MBG_MSG_BUFF::u, USER_PERM_PTP, USER_SCOPE_CONFIG_WRITE_MSK, and MBG_MSG_CTL_s::xmt.

◆ mbgextio_set_ptp_v1_current_dataset()

int mbgextio_set_ptp_v1_current_dataset	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		const MBG_PTP_V1_CURRENT_DATASET *	p
	)

Send PTPv1 current dataset to a device in MBG_PTP_V1_CURRENT_DATASET format.

Note: This is only supported if PTP_CFG_MSK_HAS_V1_COMMON_DATASETS is set in PTP_CFG_INFO::supp_flags

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to be sent to the device

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_get_ptp_cfg_info; mbgextio_get_ptp_v1_current_dataset

Definition at line 9487 of file mbgextio.c.

References _mbg_mutex_acquire, _mbg_swab_ptp_v1_current_dataset, MBG_MSG_CTL_s::dev_mutex, GPS_PTP_V1_CURRENT_DS, mbg_rc_is_error, mbgextio_chk_user_perm(), mbgextio_xmt_msg(), MBG_MSG_BUFF::msg_data, OPT_GPS_ACK_CODE, MBG_MSG_XMT_CTL::pmb, MSG_DATA::ptp_v1_current_dataset, MBG_MSG_BUFF::u, USER_PERM_PTP, USER_SCOPE_CONFIG_WRITE_MSK, and MBG_MSG_CTL_s::xmt.

◆ mbgextio_set_ptp_v1_default_dataset()

int mbgextio_set_ptp_v1_default_dataset	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		const MBG_PTP_V1_DEFAULT_DATASET *	p
	)

Send PTPv1 default dataset to a device in MBG_PTP_V1_DEFAULT_DATASET format.

Note: This is only supported if PTP_CFG_MSK_HAS_V1_COMMON_DATASETS is set in PTP_CFG_INFO::supp_flags

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to be sent to the device

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_get_ptp_cfg_info; mbgextio_get_ptp_v1_default_dataset

Definition at line 9414 of file mbgextio.c.

References _mbg_mutex_acquire, _mbg_swab_ptp_v1_default_dataset, MBG_MSG_CTL_s::dev_mutex, GPS_PTP_V1_DEFAULT_DS, mbg_rc_is_error, mbgextio_chk_user_perm(), mbgextio_xmt_msg(), MBG_MSG_BUFF::msg_data, OPT_GPS_ACK_CODE, MBG_MSG_XMT_CTL::pmb, MSG_DATA::ptp_v1_default_dataset, MBG_MSG_BUFF::u, USER_PERM_PTP, USER_SCOPE_CONFIG_WRITE_MSK, and MBG_MSG_CTL_s::xmt.

◆ mbgextio_set_ptp_v1_parent_dataset()

int mbgextio_set_ptp_v1_parent_dataset	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		const MBG_PTP_V1_PARENT_DATASET *	p
	)

Send PTPv1 parent dataset to a device in MBG_PTP_V1_PARENT_DATASET format.

Note: This is only supported if PTP_CFG_MSK_HAS_V1_COMMON_DATASETS is set in PTP_CFG_INFO::supp_flags

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to be sent to the device

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_get_ptp_cfg_info; mbgextio_get_ptp_v1_parent_dataset

Definition at line 9560 of file mbgextio.c.

References _mbg_mutex_acquire, _mbg_swab_ptp_v1_parent_dataset, MBG_MSG_CTL_s::dev_mutex, GPS_PTP_V1_PARENT_DS, mbg_rc_is_error, mbgextio_chk_user_perm(), mbgextio_xmt_msg(), MBG_MSG_BUFF::msg_data, OPT_GPS_ACK_CODE, MBG_MSG_XMT_CTL::pmb, MSG_DATA::ptp_v1_parent_dataset, MBG_MSG_BUFF::u, USER_PERM_PTP, USER_SCOPE_CONFIG_WRITE_MSK, and MBG_MSG_CTL_s::xmt.

◆ mbgextio_set_ptp_v1_port_dataset_idx()

int mbgextio_set_ptp_v1_port_dataset_idx	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		const MBG_PTP_V1_PORT_DATASET *	p,
		uint16_t	idx
	)

Send PTPv1 port dataset with the appropriate index to a device in MBG_PTP_V1_PORT_DATASET format.

Note: This is only supported if PTP_CFG_MSK_HAS_V1_COMMON_DATASETS is set in PTP_CFG_INFO::supp_flags

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to be sent to the device
[in]	idx	Index of the port dataset to be written, 0..MBG_PTP_V1_DEFAULT_DATASET::number_ports - 1

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_get_ptp_cfg_info; mbgextio_get_ptp_v1_port_dataset_idx

Definition at line 9708 of file mbgextio.c.

References _mbg_mutex_acquire, _mbg_swab_ptp_v1_port_dataset_idx, MBG_MSG_CTL_s::dev_mutex, GPS_PTP_V1_PORT_DS_IDX, MBG_PTP_V1_PORT_DATASET_IDX::idx, mbg_rc_is_error, mbgextio_chk_user_perm(), mbgextio_xmt_msg(), MBG_MSG_BUFF::msg_data, OPT_GPS_ACK_CODE, MBG_MSG_XMT_CTL::pmb, MBG_PTP_V1_PORT_DATASET_IDX::port_dataset, MSG_DATA::ptp_v1_port_dataset_idx, MBG_MSG_BUFF::u, USER_PERM_PTP, USER_SCOPE_CONFIG_WRITE_MSK, and MBG_MSG_CTL_s::xmt.

◆ mbgextio_set_ptp_v1_time_properties_dataset()

int mbgextio_set_ptp_v1_time_properties_dataset	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		const MBG_PTP_V1_TIME_PROPERTIES_DATASET *	p
	)

Send PTPv1 time properties dataset to a device in MBG_PTP_V1_TIME_PROPERTIES_DATASET format.

Note: This is only supported if PTP_CFG_MSK_HAS_V1_COMMON_DATASETS is set in PTP_CFG_INFO::supp_flags

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to be sent to the device

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_get_ptp_cfg_info; mbgextio_get_ptp_v1_time_properties_dataset

Definition at line 9633 of file mbgextio.c.

References _mbg_mutex_acquire, _mbg_swab_ptp_v1_time_properties_dataset, MBG_MSG_CTL_s::dev_mutex, GPS_PTP_V1_TIME_PROP_DS, mbg_rc_is_error, mbgextio_chk_user_perm(), mbgextio_xmt_msg(), MBG_MSG_BUFF::msg_data, OPT_GPS_ACK_CODE, MBG_MSG_XMT_CTL::pmb, MSG_DATA::ptp_v1_time_properties_dataset, MBG_MSG_BUFF::u, USER_PERM_PTP, USER_SCOPE_CONFIG_WRITE_MSK, and MBG_MSG_CTL_s::xmt.

◆ mbgextio_set_ptp_v2_current_dataset()

int mbgextio_set_ptp_v2_current_dataset	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		const MBG_PTP_V2_CURRENT_DATASET *	p
	)

Send PTPv2 current dataset to a device in MBG_PTP_V2_CURRENT_DATASET format.

Note: This is only supported if PTP_CFG_MSK_HAS_V2_COMMON_DATASETS is set in PTP_CFG_INFO::supp_flags

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to be sent to the device

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_get_ptp_cfg_info; mbgextio_get_ptp_v2_current_dataset

Definition at line 9855 of file mbgextio.c.

References _mbg_mutex_acquire, _mbg_swab_ptp_v2_current_dataset, MBG_MSG_CTL_s::dev_mutex, GPS_PTP_V2_CURRENT_DS, mbg_rc_is_error, mbgextio_chk_user_perm(), mbgextio_xmt_msg(), MBG_MSG_BUFF::msg_data, OPT_GPS_ACK_CODE, MBG_MSG_XMT_CTL::pmb, MSG_DATA::ptp_v2_current_dataset, MBG_MSG_BUFF::u, USER_PERM_PTP, USER_SCOPE_CONFIG_WRITE_MSK, and MBG_MSG_CTL_s::xmt.

◆ mbgextio_set_ptp_v2_default_dataset()

int mbgextio_set_ptp_v2_default_dataset	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		const MBG_PTP_V2_DEFAULT_DATASET *	p
	)

Send PTPv2 default dataset to a device in MBG_PTP_V2_DEFAULT_DATASET format.

Note: This is only supported if PTP_CFG_MSK_HAS_V2_COMMON_DATASETS is set in PTP_CFG_INFO::supp_flags

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to be sent to the device

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_get_ptp_cfg_info; mbgextio_get_ptp_v2_default_dataset

Definition at line 9782 of file mbgextio.c.

References _mbg_mutex_acquire, _mbg_swab_ptp_v2_default_dataset, MBG_MSG_CTL_s::dev_mutex, GPS_PTP_V2_DEFAULT_DS, mbg_rc_is_error, mbgextio_chk_user_perm(), mbgextio_xmt_msg(), MBG_MSG_BUFF::msg_data, OPT_GPS_ACK_CODE, MBG_MSG_XMT_CTL::pmb, MSG_DATA::ptp_v2_default_dataset, MBG_MSG_BUFF::u, USER_PERM_PTP, USER_SCOPE_CONFIG_WRITE_MSK, and MBG_MSG_CTL_s::xmt.

◆ mbgextio_set_ptp_v2_parent_dataset()

int mbgextio_set_ptp_v2_parent_dataset	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		const MBG_PTP_V2_PARENT_DATASET *	p
	)

Send PTPv2 parent dataset to a device in MBG_PTP_V2_PARENT_DATASET format.

Note: This is only supported if PTP_CFG_MSK_HAS_V2_COMMON_DATASETS is set in PTP_CFG_INFO::supp_flags

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to be sent to the device

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_get_ptp_cfg_info; mbgextio_get_ptp_v2_parent_dataset

Definition at line 9928 of file mbgextio.c.

References _mbg_mutex_acquire, _mbg_swab_ptp_v2_parent_dataset, MBG_MSG_CTL_s::dev_mutex, GPS_PTP_V2_PARENT_DS, mbg_rc_is_error, mbgextio_chk_user_perm(), mbgextio_xmt_msg(), MBG_MSG_BUFF::msg_data, OPT_GPS_ACK_CODE, MBG_MSG_XMT_CTL::pmb, MSG_DATA::ptp_v2_parent_dataset, MBG_MSG_BUFF::u, USER_PERM_PTP, USER_SCOPE_CONFIG_WRITE_MSK, and MBG_MSG_CTL_s::xmt.

◆ mbgextio_set_ptp_v2_port_dataset_idx()

int mbgextio_set_ptp_v2_port_dataset_idx	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		const MBG_PTP_V2_PORT_DATASET *	p,
		uint16_t	idx
	)

Send PTPv2 port dataset with the appropriate index to a device in MBG_PTP_V2_PORT_DATASET format.

Note: This is only supported if PTP_CFG_MSK_HAS_V2_COMMON_DATASETS is set in PTP_CFG_INFO::supp_flags

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to be sent to the device
[in]	idx	Index of the port dataset be written, 0..MBG_PTP_V2_DEFAULT_DATASET::number_ports - 1

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_get_ptp_cfg_info; mbgextio_get_ptp_v2_port_dataset_idx

Definition at line 10076 of file mbgextio.c.

References _mbg_mutex_acquire, _mbg_swab_ptp_v2_port_dataset_idx, MBG_MSG_CTL_s::dev_mutex, GPS_PTP_V2_PORT_DS_IDX, MBG_PTP_V2_PORT_DATASET_IDX::idx, mbg_rc_is_error, mbgextio_chk_user_perm(), mbgextio_xmt_msg(), MBG_MSG_BUFF::msg_data, OPT_GPS_ACK_CODE, MBG_MSG_XMT_CTL::pmb, MBG_PTP_V2_PORT_DATASET_IDX::port_dataset, MSG_DATA::ptp_v2_port_dataset_idx, MBG_MSG_BUFF::u, USER_PERM_PTP, USER_SCOPE_CONFIG_WRITE_MSK, and MBG_MSG_CTL_s::xmt.

◆ mbgextio_set_ptp_v2_time_properties_dataset()

int mbgextio_set_ptp_v2_time_properties_dataset	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		const MBG_PTP_V2_TIME_PROPERTIES_DATASET *	p
	)

Send PTPv2 time properties dataset to a device in MBG_PTP_V2_TIME_PROPERTIES_DATASET format.

Note: This is only supported if PTP_CFG_MSK_HAS_V2_COMMON_DATASETS is set in PTP_CFG_INFO::supp_flags

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to be sent to the device

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_get_ptp_cfg_info; mbgextio_get_ptp_v2_time_properties_dataset

Definition at line 10001 of file mbgextio.c.

References _mbg_mutex_acquire, _mbg_swab_ptp_v2_time_properties_dataset, MBG_MSG_CTL_s::dev_mutex, GPS_PTP_V2_TIME_PROP_DS, mbg_rc_is_error, mbgextio_chk_user_perm(), mbgextio_xmt_msg(), MBG_MSG_BUFF::msg_data, OPT_GPS_ACK_CODE, MBG_MSG_XMT_CTL::pmb, MSG_DATA::ptp_v2_time_properties_dataset, MBG_MSG_BUFF::u, USER_PERM_PTP, USER_SCOPE_CONFIG_WRITE_MSK, and MBG_MSG_CTL_s::xmt.

◆ mbgextio_set_pwr_ctl()

int mbgextio_set_pwr_ctl	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		const MBG_PWR_CTL *	p
	)

Write a MBG_PWR_CTL parameter structure to a device.

Note: Only supported if MBG_XFEATURE_PWR_CTL_API is set

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[in]	p	Pointer to the data structure to be sent to the device

Returns: One of the MBG_RETURN_CODES

Definition at line 13646 of file mbgextio.c.

References _mbg_mutex_acquire, _mbg_swab_mbg_pwr_ctl, MBG_MSG_CTL_s::dev_mutex, GPS_PWR_CTL, mbgextio_xmt_msg(), MBG_MSG_BUFF::msg_data, OPT_GPS_ACK_CODE, MBG_MSG_XMT_CTL::pmb, MSG_DATA::pwr_ctl, MBG_MSG_BUFF::u, and MBG_MSG_CTL_s::xmt.

◆ mbgextio_set_ref_offs()

int mbgextio_set_ref_offs	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		const MBG_REF_OFFS *	p
	)

Send new ref offset to UTC settings.

Note: This is only supported if GPS_HAS_REF_OFFS is set in RECEIVER_INFO::features, usually with IRIG receivers

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to be sent to the device

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_get_ref_offs

Definition at line 7278 of file mbgextio.c.

References _mbg_mutex_acquire, _mbg_swab_mbg_ref_offs, MBG_MSG_CTL_s::dev_mutex, GPS_REF_OFFS, mbg_rc_is_error, mbgextio_chk_user_perm(), mbgextio_xmt_msg(), MBG_MSG_BUFF::msg_data, OPT_GPS_ACK_CODE, MBG_MSG_XMT_CTL::pmb, MSG_DATA::ref_offs, MBG_MSG_BUFF::u, USER_PERM_IOPORTS, USER_SCOPE_CONFIG_WRITE_MSK, and MBG_MSG_CTL_s::xmt.

◆ mbgextio_set_scu_stat_settings()

int mbgextio_set_scu_stat_settings	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		const SCU_STAT_SETTINGS *	p
	)

Send SCU_STAT_SETTINGS to the device.

Note: This is only supported if GPS_MODEL_HAS_SCU_STAT is set in the builtin features of the device

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to be sent to the device

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_dev_has_scu_stat; mbgextio_get_scu_stat_info

Definition at line 13090 of file mbgextio.c.

References _MBG_API, _mbg_mutex_acquire, _mbg_swab_scu_stat_settings, _NO_MBG_API_ATTR, MBG_MSG_CTL_s::dev_mutex, GPS_SCU_STAT, GPS_TIME_MON_INST_INFO, GPS_TIME_MON_TARGET_EXT_DATA_SET_IDX, GPS_TIME_MON_TARGET_SETTINGS, GPS_TIME_MON_TARGET_STATUS_IDX, mbg_rc_is_error, mbg_rc_is_success, mbgextio_chk_user_perm(), mbgextio_req_data(), mbgextio_req_data_idx(), mbgextio_time_mon_get_inst_info(), mbgextio_time_mon_get_target_ext_data_set_idx(), mbgextio_time_mon_get_target_status_idx(), mbgextio_time_mon_send_inst_info(), mbgextio_time_mon_send_target_settings(), mbgextio_xmt_msg(), MBG_MSG_BUFF::msg_data, OPT_GPS_ACK_CODE, MBG_MSG_XMT_CTL::pmb, MSG_DATA::scu_stat_settings, MBG_MSG_BUFF::u, USER_PERM_SYSTEM, USER_SCOPE_CONFIG_WRITE_MSK, and MBG_MSG_CTL_s::xmt.

◆ mbgextio_set_snmp_glb_settings()

int mbgextio_set_snmp_glb_settings	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		const MBG_SNMP_GLB_SETTINGS *	p
	)

Send the SNMP global settings in MBG_SNMP_GLB_SETTINGS format.

Note: MBG_MONITORING_TYPE_MSK_SNMP must be set in MBG_MONITORING_LIMITS::supp_types

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[in]	p	Pointer to the data structure to be sent to the device

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_dev_has_monitoring; mbgextio_get_snmp_glb_info

Definition at line 10211 of file mbgextio.c.

References _mbg_mutex_acquire, _mbg_swab_snmp_glb_settings, MBG_MSG_CTL_s::dev_mutex, GPS_SNMP_GLB, mbg_rc_is_error, mbgextio_chk_user_perm(), mbgextio_xmt_msg(), MBG_MSG_BUFF::msg_data, OPT_GPS_ACK_CODE, MBG_MSG_XMT_CTL::pmb, MSG_DATA::snmp_glb_settings, MBG_MSG_BUFF::u, USER_PERM_MONITORING, USER_SCOPE_CONFIG_WRITE_MSK, and MBG_MSG_CTL_s::xmt.

◆ mbgextio_set_snmp_v12_settings_idx()

int mbgextio_set_snmp_v12_settings_idx	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		const MBG_SNMP_V12_SETTINGS *	p,
		uint16_t	idx
	)

Write SNMP v1 or v2 settings in MBG_SNMP_V12_SETTINGS format.

Note: MBG_MONITORING_TYPE_MSK_SNMP must be set in MBG_MONITORING_LIMITS::supp_types

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[in]	p	Pointer to the data structure to be sent to the device
[in]	idx	Index of the SNMP settings to be written, 0 ... MBG_SNMP_GLB_SETTINGS::num_v12_settings - 1

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_dev_has_monitoring; mbgextio_get_snmp_glb_info; mbgextio_get_snmp_v12_info_idx

Definition at line 10288 of file mbgextio.c.

References _mbg_mutex_acquire, _mbg_swab_snmp_v12_settings_idx, MBG_MSG_CTL_s::dev_mutex, GPS_SNMP_V12_IDX, MBG_SNMP_V12_SETTINGS_IDX::idx, mbg_rc_is_error, mbgextio_chk_user_perm(), mbgextio_xmt_msg(), MBG_MSG_BUFF::msg_data, OPT_GPS_ACK_CODE, MBG_MSG_XMT_CTL::pmb, MBG_SNMP_V12_SETTINGS_IDX::settings, MSG_DATA::snmp_v12_settings_idx, MBG_MSG_BUFF::u, USER_PERM_MONITORING, USER_SCOPE_CONFIG_WRITE_MSK, and MBG_MSG_CTL_s::xmt.

◆ mbgextio_set_snmp_v12_trap_settings_idx()

int mbgextio_set_snmp_v12_trap_settings_idx	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		const MBG_SNMP_V12_TRAP_SETTINGS *	p,
		uint16_t	idx
	)

Write SNMP v1 or v2 trap settings in MBG_SNMP_V12_TRAP_SETTINGS format.

Note: MBG_MONITORING_TYPE_MSK_SNMP must be set in MBG_MONITORING_LIMITS::supp_types

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[in]	p	Pointer to the data structure to be sent to the device
[in]	idx	Index of the SNMP settings to be written, 0 ... MBG_SNMP_GLB_SETTINGS::num_v12_trap_receivers - 1

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_dev_has_monitoring; mbgextio_get_snmp_glb_info; mbgextio_get_snmp_v12_trap_info_idx

Definition at line 10366 of file mbgextio.c.

References _mbg_mutex_acquire, _mbg_swab_snmp_v12_trap_settings_idx, MBG_MSG_CTL_s::dev_mutex, GPS_SNMP_V12_TRAP_IDX, MBG_SNMP_V12_TRAP_SETTINGS_IDX::idx, mbg_rc_is_error, mbgextio_chk_user_perm(), mbgextio_xmt_msg(), MBG_MSG_BUFF::msg_data, OPT_GPS_ACK_CODE, MBG_MSG_XMT_CTL::pmb, MBG_SNMP_V12_TRAP_SETTINGS_IDX::settings, MSG_DATA::snmp_v12_trap_settings_idx, MBG_MSG_BUFF::u, USER_PERM_MONITORING, USER_SCOPE_CONFIG_WRITE_MSK, and MBG_MSG_CTL_s::xmt.

◆ mbgextio_set_snmp_v3_settings_idx()

int mbgextio_set_snmp_v3_settings_idx	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		const MBG_SNMP_V3_SETTINGS *	p,
		uint16_t	idx
	)

Write SNMP v3 settings in MBG_SNMP_V3_SETTINGS format.

Note: MBG_MONITORING_TYPE_MSK_SNMP must be set in MBG_MONITORING_LIMITS::supp_types

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[in]	p	Pointer to the data structure to be sent to the device
[in]	idx	Index of the SNMP settings to be written, 0 ... MBG_SNMP_GLB_SETTINGS::num_v3_settings - 1

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_dev_has_monitoring; mbgextio_get_snmp_glb_info; mbgextio_get_snmp_v3_info_idx

Definition at line 10444 of file mbgextio.c.

References _mbg_mutex_acquire, _mbg_swab_snmp_v3_settings_idx, MBG_MSG_CTL_s::dev_mutex, GPS_SNMP_V3_IDX, MBG_SNMP_V3_SETTINGS_IDX::idx, mbg_rc_is_error, mbgextio_chk_user_perm(), mbgextio_xmt_msg(), MBG_MSG_BUFF::msg_data, OPT_GPS_ACK_CODE, MBG_MSG_XMT_CTL::pmb, MBG_SNMP_V3_SETTINGS_IDX::settings, MSG_DATA::snmp_v3_settings_idx, MBG_MSG_BUFF::u, USER_PERM_MONITORING, USER_SCOPE_CONFIG_WRITE_MSK, and MBG_MSG_CTL_s::xmt.

◆ mbgextio_set_snmp_v3_trap_settings_idx()

int mbgextio_set_snmp_v3_trap_settings_idx	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		const MBG_SNMP_V3_TRAP_SETTINGS *	p,
		uint16_t	idx
	)

Write SNMP v3 trap settings in MBG_SNMP_V3_TRAP_SETTINGS format.

Note: MBG_MONITORING_TYPE_MSK_SNMP must be set in MBG_MONITORING_LIMITS::supp_types

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[in]	p	Pointer to the data structure to be sent to the device
[in]	idx	Index of the SNMP trap settings to be written, 0 ... MBG_SNMP_GLB_SETTINGS::num_v3_trap_receivers - 1

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_dev_has_monitoring; mbgextio_get_snmp_glb_info; mbgextio_get_snmp_v3_trap_info_idx

Definition at line 10522 of file mbgextio.c.

References _mbg_mutex_acquire, _mbg_swab_snmp_v3_trap_settings_idx, MBG_MSG_CTL_s::dev_mutex, GPS_SNMP_V3_TRAP_IDX, MBG_SNMP_V3_TRAP_SETTINGS_IDX::idx, mbg_rc_is_error, mbgextio_chk_user_perm(), mbgextio_xmt_msg(), MBG_MSG_BUFF::msg_data, OPT_GPS_ACK_CODE, MBG_MSG_XMT_CTL::pmb, MBG_SNMP_V3_TRAP_SETTINGS_IDX::settings, MSG_DATA::snmp_v3_trap_settings_idx, MBG_MSG_BUFF::u, USER_PERM_MONITORING, USER_SCOPE_CONFIG_WRITE_MSK, and MBG_MSG_CTL_s::xmt.

◆ mbgextio_set_svc_ctl_idx()

int mbgextio_set_svc_ctl_idx	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		uint16_t	idx,
		uint16_t	ctl
	)

Set service control command.

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[in]	idx	Index of the service settings to be written, 0 ... MBG_SERVICE_MGMT_INFO::num_services - 1
[in]	ctl	See MBG_SERVICE_CTL

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_dev_has_service; mbgextio_get_svc_mgmt_info; mbgextio_get_svc_info_idx; mbgextio_set_svc_settings_idx; mbgextio_get_svc_status_idx

Definition at line 14147 of file mbgextio.c.

References GPS_SVC_CTL_IDX, mbg_rc_is_error, mbgextio_chk_user_perm(), mbgextio_xmt_cmd_u32(), OPT_GPS_ACK_CODE, USER_PERM_SERVICE, and USER_SCOPE_CONFIG_WRITE_MSK.

◆ mbgextio_set_svc_settings_idx()

int mbgextio_set_svc_settings_idx	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		const MBG_SERVICE_SETTINGS *	p,
		uint16_t	idx
	)

Write service settings in MBG_SERVICE_SETTINGS_IDX format.

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[in]	p	Pointer to the data structure to be sent to the device
[in]	idx	Index of the service settings to be written, 0 ... MBG_SERVICE_MGMT_INFO::num_services - 1

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_dev_has_service; mbgextio_get_svc_mgmt_info; mbgextio_get_svc_info_idx; mbgextio_get_svc_status_idx; mbgextio_set_svc_ctl_idx

Definition at line 14069 of file mbgextio.c.

References _mbg_mutex_acquire, _mbg_swab_svc_settings_idx, MBG_MSG_CTL_s::dev_mutex, GPS_SVC_INFO_IDX, MBG_SERVICE_SETTINGS_IDX::idx, mbg_rc_is_error, mbgextio_chk_user_perm(), mbgextio_xmt_msg(), MBG_MSG_BUFF::msg_data, OPT_GPS_ACK_CODE, MBG_MSG_XMT_CTL::pmb, MBG_SERVICE_SETTINGS_IDX::settings, MSG_DATA::svc_settings_idx, MBG_MSG_BUFF::u, USER_PERM_SERVICE, USER_SCOPE_CONFIG_WRITE_MSK, and MBG_MSG_CTL_s::xmt.

◆ mbgextio_set_synth()

int mbgextio_set_synth	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		const SYNTH *	p
	)

Write the frequency synthesizer settings.

Note: Some devices may not provide a frequency synthesizer

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to be sent to the device

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_get_synth

Definition at line 6366 of file mbgextio.c.

References _mbg_mutex_acquire, _mbg_swab_synth, MBG_MSG_CTL_s::dev_mutex, GPS_SYNTH, mbg_rc_is_error, mbgextio_chk_user_perm(), mbgextio_xmt_msg(), MBG_MSG_BUFF::msg_data, OPT_GPS_ACK_CODE, MBG_MSG_XMT_CTL::pmb, MSG_DATA::synth, MBG_MSG_BUFF::u, USER_PERM_IOPORTS, USER_SCOPE_CONFIG_WRITE_MSK, and MBG_MSG_CTL_s::xmt.

◆ mbgextio_set_syslog_glb_settings()

int mbgextio_set_syslog_glb_settings	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		const MBG_SYSLOG_GLB_SETTINGS *	p
	)

Send the syslog global settings in MBG_SYSLOG_GLB_SETTINGS format.

Note: MBG_MONITORING_TYPE_MSK_SYSLOG must be set in MBG_MONITORING_LIMITS::supp_types

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[in]	p	Pointer to the data structure to be sent to the device

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_dev_has_monitoring; mbgextio_get_syslog_glb_info; mbgextio_get_syslog_info_idx; mbgextio_set_syslog_settings_idx

Definition at line 10776 of file mbgextio.c.

References _mbg_mutex_acquire, _mbg_swab_syslog_glb_settings, MBG_MSG_CTL_s::dev_mutex, GPS_SYSLOG_GLB_INFO, mbg_rc_is_error, mbgextio_chk_user_perm(), mbgextio_xmt_msg(), MBG_MSG_BUFF::msg_data, OPT_GPS_ACK_CODE, MBG_MSG_XMT_CTL::pmb, MSG_DATA::syslog_glb_settings, MBG_MSG_BUFF::u, USER_PERM_MONITORING, USER_SCOPE_CONFIG_WRITE_MSK, and MBG_MSG_CTL_s::xmt.

◆ mbgextio_set_syslog_settings_idx()

int mbgextio_set_syslog_settings_idx	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		const MBG_SYSLOG_SETTINGS *	p,
		uint16_t	idx
	)

Write syslog server information in MBG_SYSLOG_SETTINGS_IDX format.

Note: MBG_MONITORING_TYPE_MSK_SYSLOG must be set in MBG_MONITORING_LIMITS::supp_types

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[in]	p	Pointer to the data structure to be sent to the device
[in]	idx	Index number of the structure to be sent

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_dev_has_monitoring; mbgextio_get_syslog_glb_info; mbgextio_set_syslog_glb_settings; mbgextio_get_syslog_info_idx

Definition at line 10854 of file mbgextio.c.

References _mbg_mutex_acquire, _mbg_swab_syslog_settings_idx, MBG_MSG_CTL_s::dev_mutex, GPS_SYSLOG_INFO_IDX, MBG_SYSLOG_SETTINGS_IDX::idx, mbg_rc_is_error, mbgextio_chk_user_perm(), mbgextio_xmt_msg(), MBG_MSG_BUFF::msg_data, OPT_GPS_ACK_CODE, MBG_MSG_XMT_CTL::pmb, MBG_SYSLOG_SETTINGS_IDX::settings, MSG_DATA::syslog_settings_idx, MBG_MSG_BUFF::u, USER_PERM_MONITORING, USER_SCOPE_CONFIG_WRITE_MSK, and MBG_MSG_CTL_s::xmt.

◆ mbgextio_set_time()

int mbgextio_set_time	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		const TTM *	p
	)

Set the device's time by sending a TTM strucure.

Note: The function is not supported by all devices. Time has to be passed as local time according to the device's TZDL settings. New time is only set with some tens of ms accuracy.

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to be sent to the device

Returns: One of the MBG_RETURN_CODES

Definition at line 6002 of file mbgextio.c.

References _mbg_mutex_acquire, _mbg_swab_ttm, MBG_MSG_CTL_s::dev_mutex, GPS_TIME, mbg_rc_is_error, mbgextio_chk_user_perm(), mbgextio_xmt_msg(), MBG_MSG_BUFF::msg_data, OPT_GPS_ACK_CODE, MBG_MSG_XMT_CTL::pmb, MSG_DATA::ttm, MBG_MSG_BUFF::u, USER_PERM_RECEIVER, USER_SCOPE_CONFIG_WRITE_MSK, and MBG_MSG_CTL_s::xmt.

◆ mbgextio_set_time_scale_settings()

int mbgextio_set_time_scale_settings	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		const MBG_TIME_SCALE_SETTINGS *	p
	)

Send new time scale configuration settings.

Note: Some devices may not support a configurable time scale

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to be sent to the device

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_get_time_scale_info

Definition at line 7846 of file mbgextio.c.

References _mbg_mutex_acquire, _mbg_swab_mbg_time_scale_settings, MBG_MSG_CTL_s::dev_mutex, GPS_TIME_SCALE, mbg_rc_is_error, mbgextio_chk_user_perm(), mbgextio_xmt_msg(), MBG_MSG_BUFF::msg_data, OPT_GPS_ACK_CODE, MBG_MSG_XMT_CTL::pmb, MSG_DATA::time_scale_settings, MBG_MSG_BUFF::u, USER_PERM_SYSTEM, USER_SCOPE_CONFIG_WRITE_MSK, and MBG_MSG_CTL_s::xmt.

◆ mbgextio_set_tr_distance()

int mbgextio_set_tr_distance	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		const TR_DISTANCE *	p
	)

Set the transmitter distance (km) in TR_DISTANCE format.

Note: Some devices may not support TR_DISTANCE configuration

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to be sent to the device

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_get_tr_distance

Definition at line 8340 of file mbgextio.c.

References _mbg_mutex_acquire, _mbg_swab_tr_distance, MBG_MSG_CTL_s::dev_mutex, mbgextio_xmt_msg(), MBG_MSG_BUFF::msg_data, OPT_GPS_ACK_CODE, MBG_MSG_XMT_CTL::pmb, PZF_TR_DISTANCE, MSG_DATA::tr_distance, MBG_MSG_BUFF::u, and MBG_MSG_CTL_s::xmt.

◆ mbgextio_set_tzcode()

int mbgextio_set_tzcode	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		const TZCODE *	p
	)

Set the local time conversion configuration in TZCODE format.

Note: Some devices may not support TZCODE configuration

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to be sent to the device

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_get_tzcode

Definition at line 8209 of file mbgextio.c.

References _mbg_mutex_acquire, _mbg_swab_tzcode, MBG_MSG_CTL_s::dev_mutex, mbg_rc_is_error, mbgextio_chk_user_perm(), mbgextio_xmt_msg(), MBG_MSG_BUFF::msg_data, OPT_GPS_ACK_CODE, MBG_MSG_XMT_CTL::pmb, PZF_TZCODE, MSG_DATA::tzcode, MBG_MSG_BUFF::u, USER_PERM_SYSTEM, USER_SCOPE_CONFIG_WRITE_MSK, and MBG_MSG_CTL_s::xmt.

◆ mbgextio_set_tzdl()

int mbgextio_set_tzdl	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		const TZDL *	p
	)

Set the local time conversion parameters in TZDL format.

Note: Some devices may not support TZDL settings

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to be sent to the device

Returns: One of the MBG_RETURN_CODES

Definition at line 6222 of file mbgextio.c.

References _mbg_mutex_acquire, _mbg_swab_tzdl, MBG_MSG_CTL_s::dev_mutex, GPS_TZDL, mbg_rc_is_error, mbgextio_chk_user_perm(), mbgextio_xmt_msg(), MBG_MSG_BUFF::msg_data, OPT_GPS_ACK_CODE, MBG_MSG_XMT_CTL::pmb, MSG_DATA::tzdl, MBG_MSG_BUFF::u, USER_PERM_SYSTEM, USER_SCOPE_CONFIG_WRITE_MSK, and MBG_MSG_CTL_s::xmt.

◆ mbgextio_set_ucap_net_glb_settings()

int mbgextio_set_ucap_net_glb_settings	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		const MBG_UCAP_NET_GLB_SETTINGS *	p
	)

Send the user capture network global configuration in MBG_UCAP_NET_GLB_SETTINGS format.

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to be sent to the device

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_dev_has_ucap_net

Definition at line 6526 of file mbgextio.c.

References _mbg_mutex_acquire, _mbg_swab_ucap_net_glb_settings, MBG_MSG_CTL_s::dev_mutex, GPS_UCAP_NET_GLB_INFO, mbg_rc_is_error, mbgextio_chk_user_perm(), mbgextio_xmt_msg(), MBG_MSG_BUFF::msg_data, OPT_GPS_ACK_CODE, MBG_MSG_XMT_CTL::pmb, MBG_MSG_BUFF::u, MSG_DATA::ucap_net_glb_settings, USER_PERM_IOPORTS, USER_SCOPE_CONFIG_WRITE_MSK, and MBG_MSG_CTL_s::xmt.

◆ mbgextio_set_ucap_net_recv_settings_idx()

int mbgextio_set_ucap_net_recv_settings_idx	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		const MBG_UCAP_NET_RECV_SETTINGS_IDX *	p,
		uint16_t	idx
	)

Send the user capture network receiver configuration with the given index in MBG_UCAP_NET_RECV_SETTINGS_IDX format.

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to be sent to the device
[in]	idx	Index of the array element to be sent, 0..::MBG_UCAP_NET_GLB_INFO::settings::num_recvs

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_dev_has_ucap_net

Definition at line 6597 of file mbgextio.c.

References _mbg_mutex_acquire, _mbg_swab_ucap_net_recv_settings_idx, MBG_MSG_CTL_s::dev_mutex, GPS_UCAP_NET_RECV_INFO_IDX, MBG_UCAP_NET_RECV_SETTINGS_IDX::idx, mbg_rc_is_error, mbgextio_chk_user_perm(), mbgextio_xmt_msg(), MBG_MSG_BUFF::msg_data, OPT_GPS_ACK_CODE, MBG_MSG_XMT_CTL::pmb, MBG_MSG_BUFF::u, MSG_DATA::ucap_net_recv_settings_idx, USER_PERM_IOPORTS, USER_SCOPE_CONFIG_WRITE_MSK, and MBG_MSG_CTL_s::xmt.

◆ mbgextio_set_user_level_settings_idx()

int mbgextio_set_user_level_settings_idx	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		const MBG_USER_SETTINGS *	p,
		uint16_t	idx
	)

Write user level settings in MBG_USER_SETTINGS_IDX format.

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[in]	p	Pointer to the data structure to be sent to the device
[in]	idx	Index of the user level settings to be written, 0 ... MBG_USER_MNGMNT_SETTINGS::num_levels - 1

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_dev_has_user_mngmnt; mbgextio_get_user_mngmnt_info; mbgextio_set_user_mngmnt_settings; mbgextio_get_user_level_info_idx

Definition at line 6810 of file mbgextio.c.

References _mbg_mutex_acquire, _mbg_swab_user_settings_idx, MBG_MSG_CTL_s::dev_mutex, GPS_USER_LEVEL_INFO_IDX, MBG_USER_SETTINGS_IDX::idx, mbg_rc_is_error, mbgextio_chk_user_perm(), mbgextio_xmt_msg(), MBG_MSG_BUFF::msg_data, OPT_GPS_ACK_CODE, MBG_MSG_XMT_CTL::pmb, MBG_USER_SETTINGS_IDX::settings, MBG_MSG_BUFF::u, USER_PERM_USERS, USER_SCOPE_CONFIG_WRITE_MSK, MSG_DATA::user_settings_idx, and MBG_MSG_CTL_s::xmt.

◆ mbgextio_set_user_mngmnt_settings()

int mbgextio_set_user_mngmnt_settings	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		const MBG_USER_MNGMNT_SETTINGS *	p
	)

Send the user configuration in MBG_USER_MNGMNT_SETTINGS format.

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[in]	p	Pointer to the data structure to be sent to the device

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_dev_has_user_mngmnt; mbgextio_get_user_mngmnt_info

Definition at line 6666 of file mbgextio.c.

References _mbg_mutex_acquire, _mbg_swab_user_mngmnt_settings, MBG_MSG_CTL_s::dev_mutex, GPS_USER_MNGMNT_INFO, mbg_rc_is_error, mbgextio_chk_user_perm(), mbgextio_xmt_msg(), MBG_MSG_BUFF::msg_data, OPT_GPS_ACK_CODE, MBG_MSG_XMT_CTL::pmb, MBG_MSG_BUFF::u, MSG_DATA::user_mngmnt_settings, USER_PERM_USERS, USER_SCOPE_CONFIG_WRITE_MSK, and MBG_MSG_CTL_s::xmt.

◆ mbgextio_set_user_settings_idx()

int mbgextio_set_user_settings_idx	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		const MBG_USER_SETTINGS *	p,
		uint16_t	idx
	)

Write user settings in MBG_USER_SETTINGS_IDX format.

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[in]	p	Pointer to the data structure to be sent to the device
[in]	idx	Index of the user settings to be written, 0 ... MBG_USER_MNGMNT_SETTINGS::num_users - 1

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_dev_has_user_mngmnt; mbgextio_get_user_mngmnt_info; mbgextio_set_user_mngmnt_settings; mbgextio_get_user_info_idx

Definition at line 6738 of file mbgextio.c.

References _mbg_mutex_acquire, _mbg_swab_user_settings_idx, MBG_MSG_CTL_s::dev_mutex, GPS_USER_INFO_IDX, MBG_USER_SETTINGS_IDX::idx, mbg_rc_is_error, mbgextio_chk_user_perm(), mbgextio_xmt_msg(), MBG_MSG_BUFF::msg_data, OPT_GPS_ACK_CODE, MBG_MSG_XMT_CTL::pmb, MBG_USER_SETTINGS_IDX::settings, MBG_MSG_BUFF::u, USER_PERM_USERS, USER_SCOPE_CONFIG_WRITE_MSK, MSG_DATA::user_settings_idx, and MBG_MSG_CTL_s::xmt.

◆ mbgextio_set_utc_parm()

int mbgextio_set_utc_parm	(	MBG_MSG_CTL *	pmctl,
		XBP_ADDR *	p_addr,
		const UTC *	p
	)

Write a UTC parameter structure to a device.

The UTC parameter structure contains the current UTC/GPS time offset as well as information on an eventually upcoming leap second.

Note: Only supported by GPS/GNSS and some PZF receivers //##+++++++ TODO Associated feature flag?

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to be sent to the device

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_get_utc_parm

Definition at line 13022 of file mbgextio.c.

References _mbg_mutex_acquire, _mbg_swab_utc_parm, MBG_MSG_CTL_s::dev_mutex, GPS_UTC, mbgextio_xmt_msg(), MBG_MSG_BUFF::msg_data, OPT_GPS_ACK_CODE, MBG_MSG_XMT_CTL::pmb, MBG_MSG_BUFF::u, MSG_DATA::utc, and MBG_MSG_CTL_s::xmt.

◆ mbgextio_set_xmr_settings_idx()

int mbgextio_set_xmr_settings_idx	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		const XMULTI_REF_SETTINGS *	p,
		uint16_t	idx
	)

Set XMULTI_REF_SETTINGS for a specific XMR source.

Only if GPS_HAS_XMULTI_REF is set in RECEIVER_INFO::features.

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to be sent to the device
[in]	idx	Index of the array element to be retrieved, 0..0..XMULTI_REF_INSTANCES::n_xmr_settings-1

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_get_xmr_instances; mbgextio_get_xmr_ext_src_info_idx; mbgextio_get_xmr_holdover_status; mbgextio_get_xmr_info_idx; mbgextio_get_xmr_status_idx; mbgextio_get_xmr_ext_source_stats_idx; mbgextio_get_xmr_ext_source_metrics_idx

Definition at line 8978 of file mbgextio.c.

References _mbg_mutex_acquire, _mbg_swab_xmulti_ref_settings_idx, MBG_MSG_CTL_s::dev_mutex, GPS_XMR_SETTINGS_IDX, XMULTI_REF_SETTINGS_IDX::idx, mbg_rc_is_error, mbgextio_chk_user_perm(), mbgextio_xmt_msg(), MBG_MSG_BUFF::msg_data, OPT_GPS_ACK_CODE, MBG_MSG_XMT_CTL::pmb, XMULTI_REF_SETTINGS_IDX::settings, MBG_MSG_BUFF::u, USER_PERM_MRS, USER_SCOPE_CONFIG_WRITE_MSK, MBG_MSG_CTL_s::xmt, and MSG_DATA::xmulti_ref_settings_idx.

◆ mbgextio_setup_receiver_info()

int mbgextio_setup_receiver_info	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		RECEIVER_INFO *	p
	)

Setup a receiver info structure.

The RECEIVER_INFO should be read at first to identify the connected device and determine the basic features supported by the device.

Note: Some very old devices may not provide a RECEIVER_INFO. This function tries to read the RECEIVER_INFO from the device, and sets up a default structure if the device doesn't support this.

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[out]	p	Pointer to the data structure to return the received data

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_get_receiver_info

Definition at line 5716 of file mbgextio.c.

References _mbg_mutex_acquire, _mbg_mutex_release, _setup_default_receiver_info_gps, IDENT::c, chk_get_rcvr_info(), MBG_MSG_CTL_s::conn_type, MBG_MSG_CTL_s::dev_mutex, MBG_MSG_CTL_s::device_flags, GPS_MODEL_GPS16X, GPS_MODEL_NAME_GPS16X, MBG_CONN_TYPE_USB, MBG_ERR_TIMEOUT, mbg_gps_ident_decode(), mbg_rc_is_error, mbg_rc_is_success, MBG_SUCCESS, mbgextio_get_receiver_info_addr(), mbgextio_get_sw_rev(), mbgextio_rcv_msg_unlocked(), RECEIVER_INFO::model_code, RECEIVER_INFO::model_name, MSG_CTL_DEVICE_FLAG_MSK_LEGACY, SW_REV::name, RECEIVER_INFO::sernum, sn_cpy_str_safe(), MBG_MSG_CTL_s::st, RECEIVER_INFO::sw_rev, trim_whitespace(), and xmt_cmd().

Referenced by mbgextio_setup_xdevfeat().

◆ mbgextio_setup_xbp_node_list()

int mbgextio_setup_xbp_node_list	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr
	)

Read the XBP_NODE_INFO for a specific node in XBP_NODE_INFO_IDX format //##+++++++++++++++++++++++++.

Definition at line 12840 of file mbgextio.c.

References handle_xbp_node(), XBP_NODE_INFO_IDX::idx, MAX_XBP_CASC_LVL, MBG_ERR_XBP_CASC_LVL, mbg_rc_is_error, MBG_SUCCESS, mbgextio_get_xbp_node_info_idx(), mbgextio_get_xbp_node_limits(), XBP_NODE_LIMITS::node_count, and XBP_NODE_INFO_IDX::node_info.

◆ mbgextio_setup_xdevfeat()

int mbgextio_setup_xdevfeat	(	MBG_MSG_CTL *	pmctl,
		XBP_ADDR *	addr
	)

Set up MBG_XDEV_FEATURES for a device which has just been opened.

This function should be called after a device has been opened successfully to read extended device information which is stored in (and can be retrieved from) the message control structure.

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	addr	The XBP address of the appropriate device

Returns: One of the MBG_RETURN_CODES

Definition at line 922 of file mbgextio.c.

References RECEIVER_INFO::features, GPS_AUTH_USER_INFO, GPS_AUTH_USER_STATUS, GPS_HAS_XFEATURE, GPS_TLV_INFO, GPS_XFEATURES, mbg_rc_is_error, mbg_rc_is_success, mbg_rc_is_success_or_err_perm, MBG_SUCCESS, mbgextio_dev_has_user_auth, mbgextio_req_data(), mbgextio_setup_receiver_info(), MBG_XDEV_FEATURES::receiver_info, MBG_XDEV_FEATURES::tlv_info, MBG_XDEV_FEATURES::user_info, MBG_XDEV_FEATURES::user_status, MBG_MSG_CTL_s::xdev_features, xdevfeat_has_tlv_api, and MBG_XDEV_FEATURES::xfeature_buffer.

Referenced by dev_open_finish_setup().

◆ mbgextio_socket_read_default()

int mbgextio_socket_read_default	(	MBG_MSG_CTL *	pmctl,
		void *	buf,
		size_t	len
	)

Function, which can be used to read data from a standard LAN socket.

The function pointer in the MBG_MSG_CTL is automatically set in mbgextio_open_socket, but has to be set manually, if the socket is created in a different way.

Parameters

[in]	pmctl	Pointer to a MBG_MSG_CTL control structure containing the socket to read from
[out]	buf	The buffer to use for incoming data
[in]	len	Size of buf in bytes

Returns: number of bytes received, 0 if the socket is disconnected, MBG_ERR_TIMEOUT if no data is received

See also: mbgextio_socket_read_ssh; mbgextio_socket_write_default; mbgextio_open_socket; mbgextio_close_connection

Referenced by dev_open_finish_setup().

◆ mbgextio_socket_read_ssh()

int mbgextio_socket_read_ssh	(	MBG_MSG_CTL *	pmctl,
		void *	buf,
		size_t	len
	)

Function, which can be used to read data from an SSH binary protocol channel.

The function pointer in the MBG_MSG_CTL is automatically set in mbgextio_open_ssh_socket, but has to be set manually, if the socket is created in a different way.

Parameters

[in]	pmctl	Pointer to a MBG_MSG_CTL control structure containing the socket to read from
[out]	buf	The buffer to use for incoming data
[in]	len	Size of buf in bytes

Returns: number of bytes received, 0 if the socket is disconnected, MBG_ERR_TIMEOUT if no data is received, one of the MBG error codes, otherwise

See also: mbgextio_socket_read_default; mbgextio_socket_write_ssh; mbgextio_open_ssh_socket; mbgextio_close_connection

Referenced by dev_open_finish_setup().

◆ mbgextio_socket_write_default()

int mbgextio_socket_write_default	(	MBG_MSG_CTL *	pmctl,
		const void *	buf,
		size_t	len
	)

Function, which can be used to write data to a standard LAN socket.

The function pointer in the MBG_MSG_CTL is automatically set in mbgextio_open_socket, but has to be set manually, if the socket is created in a different way.

Parameters

[in]	pmctl	Pointer to a MBG_MSG_CTL control structure containing the socket to write to
[out]	buf	Buffer containing the data to write
[in]	len	Number of bytes to write

Returns: number of bytes sent, if successful, one of the MBG error codes otherwise

See also: mbgextio_socket_read_default; mbgextio_socket_write_ssh; mbgextio_open_socket; mbgextio_close_connection

Referenced by dev_open_finish_setup().

◆ mbgextio_socket_write_ssh()

int mbgextio_socket_write_ssh	(	MBG_MSG_CTL *	pmctl,
		const void *	buf,
		size_t	len
	)

Function, which can be used to write data to an SSH binary protocol channel.

The function pointer in the MBG_MSG_CTL is automatically set in mbgextio_open_ssh_socket, but has to be set manually, if the socket is created in a different way.

Parameters

[in]	pmctl	Pointer to a MBG_MSG_CTL control structure containing the socket to write to
[out]	buf	Buffer containing the data to write
[in]	len	Number of bytes to write

Returns: number of bytes sent, if successful, one of the MBG error codes otherwise

See also: mbgextio_socket_read_ssh; mbgextio_socket_write_default; mbgextio_open_ssh_socket; mbgextio_close_connection

Referenced by dev_open_finish_setup().

◆ mbgextio_time_mon_get_inst_info()

int mbgextio_time_mon_get_inst_info	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		MBG_TIME_MON_INST_INFO *	p
	)

Referenced by mbgextio_set_scu_stat_settings().

◆ mbgextio_time_mon_get_target_ext_data_set_idx()

int mbgextio_time_mon_get_target_ext_data_set_idx	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		MBG_TIME_MON_TARGET_EXT_DATA_SET_IDX *	p,
		uint16_t	idx
	)

Referenced by mbgextio_set_scu_stat_settings().

◆ mbgextio_time_mon_get_target_status_idx()

int mbgextio_time_mon_get_target_status_idx	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		MBG_TIME_MON_TARGET_STATUS_IDX *	p,
		uint16_t	idx
	)

Referenced by mbgextio_set_scu_stat_settings().

◆ mbgextio_time_mon_send_inst_info()

int mbgextio_time_mon_send_inst_info	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		const MBG_TIME_MON_INST_INFO *	p
	)

Referenced by mbgextio_set_scu_stat_settings().

◆ mbgextio_time_mon_send_target_settings()

int mbgextio_time_mon_send_target_settings	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		const MBG_TIME_MON_TARGET_SETTINGS *	p
	)

Referenced by mbgextio_set_scu_stat_settings().

◆ mbgextio_unregister_push_msg()

int mbgextio_unregister_push_msg	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		GPS_CMD	cmd
	)

Unregister for command specific push messages.

mbgextio_dev_has_push_msgs should be used to check if this is supported

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[in]	cmd	GPS command to register for push messages for

Returns: One of the MBG_RETURN_CODES

Definition at line 13892 of file mbgextio.c.

References GPS_UNREGISTER_PUSH_MSGS, mbgextio_xmt_cmd_us(), and OPT_GPS_ACK_CODE.

◆ mbgextio_xmt_cmd()

int mbgextio_xmt_cmd	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		GPS_CMD	cmd
	)

Transmit a command-only message without additional data.

If the caller has or'ed the cmd code with GPS_REQACK then this function expects an ACK or a NACK message to be replied by the device.

Transmission is protected by a mutex which is acquired before and released after the binary message has been sent.

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[in]	cmd	One of the command codes enumerated in GPS_CMD_CODES, optionally or'ed with GPS_REQACK

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_xmt_msg; mbgextio_rcv_msg_unlocked; mbgextio_req_data; mbgextio_xmt_cmd_us; mbgextio_req_data_idx

Definition at line 5136 of file mbgextio.c.

References _mbg_mutex_acquire, _mbg_mutex_release, MBG_MSG_CTL_s::dev_mutex, mbg_rc_is_success, mbgextio_check_ack(), and xmt_cmd().

Referenced by mbgextio_clr_evt_log(), mbgextio_clr_ucap_buff(), and mbgextio_cmd_save_cfg().

◆ mbgextio_xmt_cmd_u32()

int mbgextio_xmt_cmd_u32	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		GPS_CMD	cmd,
		uint32_t	u32
	)

Transmit a message with a single ushort (uint32_t) parameter.

The uint32_t parameter us is often used to send an index value when requesting a certain element of an array of same data structures.

Transmission is protected by a mutex which is acquired before and released after the binary message has been sent.

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[in]	cmd	One of the command codes enumerated in GPS_CMD_CODES
[in]	u32	The 32 bit parameter for the command code

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_xmt_msg; mbgextio_rcv_msg_unlocked; mbgextio_xmt_cmd; mbgextio_req_data; mbgextio_req_data_idx

Definition at line 5235 of file mbgextio.c.

References _mbg_mutex_acquire, _mbg_mutex_release, MBG_MSG_CTL_s::dev_mutex, mbg_rc_is_success, mbgextio_check_ack(), and xmt_cmd_u32().

Referenced by mbgextio_set_svc_ctl_idx().

◆ mbgextio_xmt_cmd_us()

int mbgextio_xmt_cmd_us	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		GPS_CMD	cmd,
		uint16_t	us
	)

Transmit a message with a single ushort (uint16_t) parameter.

The uint16_t parameter us is often used to send an index value when requesting a certain element of an array of same data structures.

Transmission is protected by a mutex which is acquired before and released after the binary message has been sent.

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[in]	cmd	One of the command codes enumerated in GPS_CMD_CODES
[in]	us	The ushort parameter for the command code

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_xmt_msg; mbgextio_rcv_msg_unlocked; mbgextio_xmt_cmd; mbgextio_req_data; mbgextio_req_data_idx

Definition at line 5188 of file mbgextio.c.

References _mbg_mutex_acquire, _mbg_mutex_release, MBG_MSG_CTL_s::dev_mutex, mbg_rc_is_success, mbgextio_check_ack(), and xmt_cmd_us().

Referenced by mbgextio_delete_fw(), mbgextio_register_push_msg(), mbgextio_set_active_fw(), and mbgextio_unregister_push_msg().

◆ mbgextio_xmt_msg()

int mbgextio_xmt_msg	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		GPS_CMD	cmd,
		const void *	p,
		uint16_t	n_bytes
	)

Set up and send a generic binary message.

This function should preferably be used only as low level function called from within more specific functions used to send specific data.

If this function is called directly with a buffer p to be sent then the device mutex is acquired by this function, and after this the specified buffer p is copied to the transmit buffer.

However, other (higher level) API functions which set up the transmit buffer directly have to acquire the device mutex by themselves before they set up the transmit buffer, and then pass p as NULL pointer to indicate the transmit buffer has already been set up. The correct number of bytes to be sent (n_bytes) has to be specified anyway, though.

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[in]	cmd	One of the command codes enumerated in GPS_CMD_CODES
[in]	p	Address of a data structure according to the specified cmd parameter, or NULL
[in]	n_bytes	Size of the data structure addressed by parameter p

Returns: One of the MBG_RETURN_CODES

Definition at line 5058 of file mbgextio.c.

References _mbg_mutex_acquire, _mbg_mutex_release, MBG_MSG_BUFF::bytes, MSG_HDR::cmd, MBG_MSG_CTL_s::dev_mutex, MBG_MSG_BUFF::hdr, MSG_HDR::len, MBG_ERR_OVERFLOW, MBG_ERR_UNSPEC, mbg_rc_is_success, mbgextio_check_ack(), MBG_MSG_BUFF::msg_data, MBG_MSG_XMT_CTL::pmb, MBG_MSG_BUFF::u, MBG_MSG_CTL_s::xmt, and xmt_tbuff().

◆ mbgextio_xmt_secu_settings()

int mbgextio_xmt_secu_settings	(	MBG_MSG_CTL *	pmctl,
		const XBP_ADDR *	p_addr,
		const char *	old_passwd,
		const char *	new_passwd
	)

Send security settings for the socket connection.

If new_passwd is not a NULL pointer, the old_passwd will be overwritten by the new_passwd.

Parameters

[in,out]	pmctl	Pointer to a valid message control structure
[in]	p_addr	Pointer to an XBP address specifier, or NULL
[in]	old_passwd	Pointer to the current LAN port password of the device
[in]	new_passwd	Pointer to the new LAN port password for the device

Returns: One of the MBG_RETURN_CODES

See also: mbgextio_open_socket

Referenced by dev_open_finish_setup().

Variable Documentation

◆ mbg_baud_rate_strs

const char* mbg_baud_rate_strs[N_MBG_BAUD_RATES]

◆ mbg_baud_rates

uint32_t mbg_baud_rates[N_MBG_BAUD_RATES]

◆ mbg_framing_strs

const char* mbg_framing_strs[N_MBG_FRAMINGS]

Macros

Typedefs

Functions

Variables

Macro Definition Documentation

◆ _ext

◆ _MBGEXTIO_REQ_ACK

◆ _mbgextio_xmt_msg

◆ _ttm_time_is_avail

◆ _ttm_time_set_unavail

◆ FT_HANDLE

◆ FT_STATUS

◆ MBGEXTIO_READ_BUFFER_SIZE

◆ OPT_GPS_ACK_CODE

Typedef Documentation

◆ libusb_device

◆ MBG_LAN_DEV_CFG

◆ MBG_LAN_DEV_CHAN

◆ MBG_LAN_DEV_LIST

◆ MBG_USB_DEV_INFO

◆ MBGEXTIO_CHK_SUPP_FNC

Function Documentation

◆ mbgextio_chk_user_perm()

◆ mbgextio_close_connection()

◆ mbgextio_clr_evt_log()

◆ mbgextio_clr_ucap_buff()

◆ mbgextio_cmd_save_cfg()

◆ mbgextio_delete_fw()

◆ mbgextio_dev_has_ant_cable_length()

◆ mbgextio_dev_has_ant_info()

◆ mbgextio_dev_has_bvar_stat()

◆ mbgextio_dev_has_clk_res_info()

◆ mbgextio_dev_has_enable_flags()

◆ mbgextio_dev_has_evt_log()

◆ mbgextio_dev_has_gpio()

◆ mbgextio_dev_has_ims()

◆ mbgextio_dev_has_io_ports()

◆ mbgextio_dev_has_irig_rx()

◆ mbgextio_dev_has_irig_tx()

◆ mbgextio_dev_has_pos_lla()

◆ mbgextio_dev_has_pos_xyz()

◆ mbgextio_dev_has_prog_pulses()

◆ mbgextio_dev_has_push_msgs()

◆ mbgextio_dev_has_serouts()

◆ mbgextio_dev_has_service()

◆ mbgextio_dev_has_synth()

◆ mbgextio_dev_has_tainted_cfg()

◆ mbgextio_dev_has_time_scale()

◆ mbgextio_dev_has_time_ttm()

◆ mbgextio_dev_has_tzcode()

◆ mbgextio_dev_has_tzdl()

◆ mbgextio_dev_has_ucap()

◆ mbgextio_dev_has_ucap_net()

◆ mbgextio_find_lan_devices()

◆ mbgextio_force_conn_serial()

◆ mbgextio_force_conn_serial_ftdi()

◆ mbgextio_free_lan_devices()

◆ mbgextio_fw_ufu_flash()

◆ mbgextio_get_all_gnss_sat_info()

◆ mbgextio_get_all_port_info()

◆ mbgextio_get_all_pout_info()

◆ mbgextio_get_all_ptp_uc_master_info()

◆ mbgextio_get_all_str_type_info()

◆ mbgextio_get_ant_cable_len()

◆ mbgextio_get_ant_info()

◆ mbgextio_get_bvar_stat()

◆ mbgextio_get_cfgh()

◆ mbgextio_get_clk_res_info()

◆ mbgextio_get_cmd_name()

◆ mbgextio_get_corr_info()

◆ mbgextio_get_database_glb_info()

◆ mbgextio_get_database_info_idx()

◆ mbgextio_get_debug_status()

◆ mbgextio_get_dev_poll_timeout()

◆ mbgextio_get_enable_flags()

◆ mbgextio_get_event_info_idx()

◆ mbgextio_get_event_status_idx()

◆ mbgextio_get_event_value_idx()

◆ mbgextio_get_ext_sys_info()

◆ mbgextio_get_fdm_freq()