XMULTI_REF_INSTANCES Struct Reference

General info on supported XMR sources and instances. More...

#include <gpsdefs.h>

Data Fields
uint32_t	flags
	see XMR_INST_FLAG_BIT_MASKS More...
uint16_t	n_xmr_settings
	number of XMULTI_REF_INFO_IDX or XMULTI_REF_STATUS_IDX which can be retrieved More...
uint8_t	slot_id
	ID of the slot in which this device is installed, 0 or up to 15, if multiple slots not supported. More...
uint8_t	reserved
	reserved, don't use, currently always 0 More...
uint8_t	n_inst [32]
	the number of supported instances of each input signal type More...

Detailed Description

General info on supported XMR sources and instances.

Note

This structure is only supported if GPS_HAS_XMRS_MULT_INSTC is set in RECEIVER_INFO::features.

The field XMULTI_REF_INSTANCES::n_xmr_settings reports the maximum number of entries that can be held by the input source table provided by this device. The input source table entry with the lowest index has the highest priority, and values 0..XMULTI_REF_INSTANCES::n_xmr_settings-1 can be used as index when reading XMULTI_REF_INFO_IDX or XMULTI_REF_STATUS_IDX from the device, or when writing XMULTI_REF_SETTINGS_IDX to the device to configure the priority/order of input sources.

An input source table entry is empty if XMULTI_REF_ID::type is set to MULTI_REF_NONE in XMULTI_REF_SETTINGS::id, and accordingly in XMULTI_REF_STATUS::id.

The array XMULTI_REF_INSTANCES::n_inst reports how many instances are supported for every known reference type. For example, if 2 PPS input signals were supported then XMULTI_REF_INSTANCES::n_inst[MULTI_REF_PPS] was set to 2. Even though this array can hold up to MAX_N_MULTI_REF_TYPES entries, the number entries which are actually used is N_MULTI_REF, according to the number of known reference signal types, which is less or equal than MAX_N_MULTI_REF_TYPES.

Definition at line 7054 of file gpsdefs.h.

Field Documentation

flags

uint32_t XMULTI_REF_INSTANCES::flags

see XMR_INST_FLAG_BIT_MASKS

Definition at line 7056 of file gpsdefs.h.

Referenced by chk_dev_xmulti_ref_supp_ext_src_info(), chk_dev_xmulti_ref_supp_holdover_status(), chk_dev_xmulti_ref_supp_mrf_none(), mbg_get_all_ucap_info(), mbg_get_all_xmulti_ref_info(), and mbg_get_xmr_holdover_status().

n_inst

uint8_t XMULTI_REF_INSTANCES::n_inst[32]

the number of supported instances of each input signal type

Definition at line 7060 of file gpsdefs.h.

Referenced by mbg_get_all_ucap_info().

n_xmr_settings

uint16_t XMULTI_REF_INSTANCES::n_xmr_settings

number of XMULTI_REF_INFO_IDX or XMULTI_REF_STATUS_IDX which can be retrieved

Definition at line 7057 of file gpsdefs.h.

Referenced by mbg_get_all_ucap_info(), mbg_get_all_xmulti_ref_info(), mbg_get_all_xmulti_ref_status(), mbg_get_gps_all_xmr_info(), mbg_get_gps_all_xmr_status(), and mbg_save_all_xmulti_ref_info().

reserved

uint8_t XMULTI_REF_INSTANCES::reserved

reserved, don't use, currently always 0

Definition at line 7059 of file gpsdefs.h.

slot_id

uint8_t XMULTI_REF_INSTANCES::slot_id

ID of the slot in which this device is installed, 0 or up to 15, if multiple slots not supported.

Definition at line 7058 of file gpsdefs.h.

Referenced by mbg_get_all_ucap_info().

---

The documentation for this struct was generated from the following file:

• mbglib/common/gpsdefs.h