mbgtools-lx  4.2.8
Definitions used with the old multi ref API

Data Structures

struct  MULTI_REF_SETTINGS
 A structure used to configure the priority of the supported ref sources. More...
 
struct  MULTI_REF_INFO
 A structure used to query MULTI_REF configuration parameters. More...
 

Macros

#define N_MULTI_REF_PRIO   4
 Maximum number of input sources. More...
 

Typedefs

typedef uint16_t MULTI_REF_STATUS
 A data type used to query MULTI_REF status information. More...
 

Enumerations

enum  MULTI_REF_STATUS_BITS {
  WRN_MODULE_MODE, WRN_COLD_BOOT, WRN_WARM_BOOT, WRN_ANT_DISCONN,
  WRN_10MHZ_UNLOCK, WRN_1PPS_UNLOCK, WRN_GPS_UNLOCK, WRN_10MHZ_MISSING,
  WRN_1PPS_MISSING, N_MULTI_REF_STATUS_BITS
}
 Enumeration of multi ref status bits. More...
 
enum  MULTI_REF_STATUS_BIT_MASKS {
  MSK_WRN_COLD_BOOT = ( 1UL << WRN_COLD_BOOT ), MSK_WRN_WARM_BOOT = ( 1UL << WRN_WARM_BOOT ), MSK_WRN_ANT_DISCONN = ( 1UL << WRN_ANT_DISCONN ), MSK_WRN_10MHZ_UNLOCK = ( 1UL << WRN_10MHZ_UNLOCK ),
  MSK_WRN_1PPS_UNLOCK = ( 1UL << WRN_1PPS_UNLOCK ), MSK_WRN_GPS_UNLOCK = ( 1UL << WRN_GPS_UNLOCK ), MSK_WRN_10MHZ_MISSING = ( 1UL << WRN_10MHZ_MISSING ), MSK_WRN_1PPS_MISSING = ( 1UL << WRN_1PPS_MISSING ),
  MSK_WRN_MODULE_MODE = ( 1UL << WRN_MODULE_MODE )
}
 Bit masks associated with MULTI_REF_STATUS_BITS. More...
 

Detailed Description

This API has been deprecated by a newer one which should be used preferably.

See also
Extended multi ref definitions

Macro Definition Documentation

◆ N_MULTI_REF_PRIO

#define N_MULTI_REF_PRIO   4

Maximum number of input sources.

The number of supported input sources and priorities is limited to this value if the old API is used, i.e. if only the GPS_FEAT_MULTI_REF flag is set.

Definition at line 6562 of file gpsdefs.h.

Typedef Documentation

◆ MULTI_REF_STATUS

A data type used to query MULTI_REF status information.

See also
MULTI_REF_STATUS_BIT_MASKS

Definition at line 6601 of file gpsdefs.h.

Enumeration Type Documentation

◆ MULTI_REF_STATUS_BIT_MASKS

Bit masks associated with MULTI_REF_STATUS_BITS.

Used with MULTI_REF_STATUS.

See also
MULTI_REF_STATUS_BITS
Enumerator
MSK_WRN_COLD_BOOT 

see WRN_COLD_BOOT

MSK_WRN_WARM_BOOT 

see WRN_WARM_BOOT

MSK_WRN_ANT_DISCONN 

see WRN_ANT_DISCONN

MSK_WRN_10MHZ_UNLOCK 

see WRN_10MHZ_UNLOCK

MSK_WRN_1PPS_UNLOCK 

see WRN_1PPS_UNLOCK

MSK_WRN_GPS_UNLOCK 

see WRN_GPS_UNLOCK

MSK_WRN_10MHZ_MISSING 

see WRN_10MHZ_MISSING

MSK_WRN_1PPS_MISSING 

see WRN_1PPS_MISSING

MSK_WRN_MODULE_MODE 

see WRN_MODULE_MODE

Definition at line 6631 of file gpsdefs.h.

◆ MULTI_REF_STATUS_BITS

Enumeration of multi ref status bits.

See also
MULTI_REF_STATUS_BIT_MASKS
Enumerator
WRN_MODULE_MODE 

selected input mode was invalid, set to default

WRN_COLD_BOOT 

GPS is in cold boot mode.

WRN_WARM_BOOT 

GPS is in warm boot mode.

WRN_ANT_DISCONN 

antenna is disconnected

WRN_10MHZ_UNLOCK 

impossible to lock to external 10 MHz reference

WRN_1PPS_UNLOCK 

impossible to lock to external 1 PPS reference

WRN_GPS_UNLOCK 

impossible to lock to GPS

WRN_10MHZ_MISSING 

external 10 MHz signal not available

WRN_1PPS_MISSING 

external 1 PPS signal not available

N_MULTI_REF_STATUS_BITS 

the number of known bits

Definition at line 6609 of file gpsdefs.h.