Extended feature definitions

Data Structures
struct	MBG_XFEATURE_BUFFER
	A structure used to store extended device features. More...

Macros
#define	MAX_XFEATURE_BITS   1024
	The maximum number of feature bits supported by the MBG_XFEATURE API. More...
#define	MBG_XFEATURE_NAMES
	Names of extended device features. More...
#define	MAX_XFEATURE_BYTES   ( MAX_XFEATURE_BITS / 8 )
	Array size required to store all extended features. More...
#define	_set_xfeature_bit(_xf_bit, _xf_buffp)   _set_array_bit( _xf_bit, (_xf_buffp)->b, MAX_XFEATURE_BYTES )
	Set an extended feature bit in a MBG_XFEATURE_BUFFER. More...

Enumerations
enum	MBG_XFEATURE_BITS {   MBG_XFEATURE_TLV_API, MBG_XFEATURE_SAVE_CFG, MBG_XFEATURE_LED_API, MBG_XFEATURE_LNE_API,   MBG_XFEATURE_PWR_CTL_API, MBG_XFEATURE_EXT_SYS_INFO, MBG_XFEATURE_TRANSACTIONS, MBG_XFEATURE_REBOOT,   MBG_XFEATURE_CLK_RES_INFO, MBG_XFEATURE_UCAP_NET, MBG_XFEATURE_REQ_TTM, MBG_XFEATURE_IO_PORTS,   MBG_XFEATURE_MONITORING, MBG_XFEATURE_XHE, MBG_XFEATURE_TAINTED_CFG, MBG_XFEATURE_PUSH_MSGS,   MBG_XFEATURE_USER_AUTH, MBG_XFEATURE_USER_MNGMNT, MBG_XFEATURE_SERVICE, MBG_XFEATURE_UP_CONV,   MBG_XFEATURE_FW_MNGMNT, MBG_XFEATURE_DAC_CTRL_PCI, MBG_XFEATURE_DATABASE, MBG_XFEATURE_GNSS_MODE,   N_MBG_XFEATURE }
	Enumeration of defined extended features. More...

Detailed Description

Note

These structures and definitions are only supported by a device if GPS_HAS_XFEATURE is set in RECEIVER_INFO::features.

Macro Definition Documentation

_set_xfeature_bit

#define _set_xfeature_bit	(		_xf_bit,
			_xf_buffp
	)		_set_array_bit( _xf_bit, (_xf_buffp)->b, MAX_XFEATURE_BYTES )

Set an extended feature bit in a MBG_XFEATURE_BUFFER.

Should be used by the firmware only to set one of the MBG_XFEATURE_BITS in an MBG_XFEATURE_BUFFER after power-up.

Parameters

[in]	_xf_bit	One of the MBG_XFEATURE_BITS
[in]	_xf_buffp	Pointer to an MBG_XFEATURE_BUFFER

Definition at line 2455 of file gpsdefs.h.

Referenced by check_receiver_info_and_features().

MAX_XFEATURE_BITS

#define MAX_XFEATURE_BITS   1024

The maximum number of feature bits supported by the MBG_XFEATURE API.

Warning: Changing this number breaks API compatibility!

See also

MBG_XFEATURE_BITS

Definition at line 2333 of file gpsdefs.h.

Referenced by dump_xfeature_buffer().

MAX_XFEATURE_BYTES

#define MAX_XFEATURE_BYTES   ( MAX_XFEATURE_BITS / 8 )

Array size required to store all extended features.

The number of bytes required to store up to MAX_XFEATURE_BITS feature bits in a byte array.

Definition at line 2421 of file gpsdefs.h.

MBG_XFEATURE_NAMES

#define MBG_XFEATURE_NAMES

Value:

{                           \
  "Generic TLV API",        \
  "Save Config On Card",    \
  "Programmable LED API",   \
  "LNE API",                \
  "Power Control API",      \
  "Extended Revision Info", \
  "Transaction commands",   \
  "Reboot Command",         \
  "Clock Resolution Info",  \
  "Extended User Captures", \
  "Request TTM",            \
  "I/O Ports",              \
  "Monitoring",             \
  "XHE Unit",               \
  "Tainted Config",         \
  "Push Messages",          \
  "User Authentication",    \
  "User Management",        \
  "Service Management",     \
  "Antenna Converter",      \
  "Firmware Management",    \
  "DAC control via bus",    \
  "Database",               \
  "GNSS Messages"           \
}

Names of extended device features.

Can be used to initialize a string array of N_MBG_XFEATURE entries, so the number of strings must correspond to N_MBG_XFEATURE.

See also

MBG_XFEATURE_BITS

Definition at line 2385 of file gpsdefs.h.

Referenced by dump_xfeature_buffer().

Enumeration Type Documentation

MBG_XFEATURE_BITS

enum MBG_XFEATURE_BITS

Enumeration of defined extended features.

See also

MBG_XFEATURE_NAMES

MBG_XFEATURE_BUFFER

Enumerator
MBG_XFEATURE_TLV_API	Supports generic TLV API, see Meinberg TLV API definitions.
MBG_XFEATURE_SAVE_CFG	Supports the GPS_SAVE_CFG command.
MBG_XFEATURE_LED_API	Supports programmable LED API, see Meinberg LED API definitions.
MBG_XFEATURE_LNE_API	Supports specific LNE API, see Definitions specific to LNE devices.
MBG_XFEATURE_PWR_CTL_API	Supports power control, see Definitions for power control API.
MBG_XFEATURE_EXT_SYS_INFO	Supports extended revision information, see Extended system information.
MBG_XFEATURE_TRANSACTIONS	Supports the GPS_BEGIN_TRANSACTION and GPS_END_TRANSACTION commands, see also MBG_TRANSACTION_TYPES.
MBG_XFEATURE_REBOOT	Supports the GPS_REBOOT command.
MBG_XFEATURE_CLK_RES_INFO	Supports the GPS_CLK_RES_INFO command, see Clock resolution info.
MBG_XFEATURE_UCAP_NET	Supports the GPS_UCAP_NET_GLB_INFO and GPS_UCAP_NET_RECV_INFO_IDX commands, see User Captures via Network.
MBG_XFEATURE_REQ_TTM	Supports TTM requests via GPS_TIME command.
MBG_XFEATURE_IO_PORTS	Supports I/O port structures, see IO Port API.
MBG_XFEATURE_MONITORING	Supports monitoring / notifications, see Monitoring / notification.
MBG_XFEATURE_XHE	Supports XHE external rubidium unit I/O commands.
MBG_XFEATURE_TAINTED_CFG	Supports tainted config structures, see Tainted config.
MBG_XFEATURE_PUSH_MSGS	Supports commands GPS_REGISTER_PUSH_MSGS and GPS_UNREGISTER_PUSH_MSGS.
MBG_XFEATURE_USER_AUTH	Supports user authentication and command GPS_AUTH_USER_INFO.
MBG_XFEATURE_USER_MNGMNT	Supports user management, see User Management.
MBG_XFEATURE_SERVICE	Supports service management, see Service Management.
MBG_XFEATURE_UP_CONV	Instead of a standard L1 antenna, a Meinberg antenna/converter can be used with this GNSS device.
MBG_XFEATURE_FW_MNGMNT	Supports firmware management, see Firmware Management.
MBG_XFEATURE_DAC_CTRL_PCI	Supports DAC control via PCI or USB bus API.
MBG_XFEATURE_DATABASE	Supports database(s), see Database(s).
MBG_XFEATURE_GNSS_MODE	Supports GPS_GNSS_MODE.
N_MBG_XFEATURE	Number of defined extended features.

Definition at line 2343 of file gpsdefs.h.