Meinberg TLV API definitions

Modules
	Meinberg TLV feature definitions

Data Structures
struct	MBG_TLV_INFO
	A structure used to query current TLV capabilities. More...
struct	MBG_TLV_DATA
	General TLV data structure. More...
struct	MBG_TLV_RCV_STATE
	Structure containing state information while reading TLV data. More...
struct	MBG_TLV_ANNOUNCE
	A structure initiating a TLV transfer. More...
struct	MBG_TLV_HDR
	TLV header structure containing information on current TLV transaction. More...
struct	MBG_TLV
	TLV structure containing information on current TLV transaction and its current data. More...

Macros
#define	_mbg_swab_tlv_uid(_p)   _mbg_swab32( _p )
#define	_mbg_swab_tlv_type(_p)   _mbg_swab32( _p )
#define	_mbg_swab_tlv_info(_p)
#define	_mbg_swab_tlv_data(_p)
#define	_mbg_swab_tlv_announce(_p)
#define	MSG_TLV_MAX_VALUE_SIZE   480
#define	_mbg_swab_tlv_header(_p)
#define	_mbg_swab_tlv(_p)

Typedefs
typedef uint32_t	MBG_TLV_UID
	A data type used to hold a unique ID (UID) for a TLV transaction. More...
typedef uint32_t	MBG_TLV_TYPE
	A data type to hold one of the MBG_TLV_TYPES or MBG_TLV_FEAT_TYPES. More...

Enumerations
enum	MBG_TLV_TYPES { MBG_TLV_TYPE_STR, MBG_TLV_TYPE_FILE, MBG_TLV_TYPE_BLOB, N_MBG_TLV_TYPES }
	Enumeration of known TLV types. More...

Detailed Description

Note

These structures and definitions are only supported by a device if MBG_XFEATURE_TLV_API is set in the extended device features.

Macro Definition Documentation

_mbg_swab_tlv

#define _mbg_swab_tlv

(

_p

)

Value:

do                                      \
{                                       \
  _mbg_swab_tlv_header( &(_p)->hdr );   \
} while ( 0 )

Definition at line 18410 of file gpsdefs.h.

_mbg_swab_tlv_announce

#define _mbg_swab_tlv_announce

(

_p

)

Value:

do                                    \
{                                     \
  _mbg_swab_tlv_data( &(_p)->data );  \
  _mbg_swab32( &(_p)->reserved_1 );   \
  _mbg_swab32( &(_p)->reserved_2 );   \
} while ( 0 )

Definition at line 18356 of file gpsdefs.h.

_mbg_swab_tlv_data

#define _mbg_swab_tlv_data

(

_p

)

Value:

do                                    \
{                                     \
  _mbg_swab_tlv_uid( &(_p)->uid );    \
  _mbg_swab_tlv_type( &(_p)->type );  \
  _mbg_swab32( &(_p)->total_bytes );  \
  _mbg_swab32( &(_p)->reserved_1 );   \
} while ( 0 )

Definition at line 18316 of file gpsdefs.h.

_mbg_swab_tlv_header

#define _mbg_swab_tlv_header

(

_p

)

Value:

do                                        \
{                                         \
  _mbg_swab_tlv_uid( &(_p)->uid );        \
  _mbg_swab_tlv_type( &(_p)->tlv_type );  \
  _mbg_swab32( &(_p)->cur_bytes );        \
  _mbg_swab32( &(_p)->trans_bytes );      \
  _mbg_swab32( &(_p)->total_bytes );      \
  _mbg_swab32( &(_p)->reserved_1 );       \
  _mbg_swab32( &(_p)->reserved_2 );       \
  _mbg_swab32( &(_p)->reserved_3 );       \
} while ( 0 )

Definition at line 18385 of file gpsdefs.h.

_mbg_swab_tlv_info

#define _mbg_swab_tlv_info

(

_p

)

Value:

do                                 \
{                                  \
  _mbg_swab32( &(_p)->reserved );  \
  _mbg_swab32( &(_p)->flags );     \
} while ( 0 )

Definition at line 18271 of file gpsdefs.h.

_mbg_swab_tlv_type

#define _mbg_swab_tlv_type

(

_p

)

_mbg_swab32( _p )

Definition at line 18090 of file gpsdefs.h.

_mbg_swab_tlv_uid

#define _mbg_swab_tlv_uid

(

_p

)

_mbg_swab32( _p )

Definition at line 18077 of file gpsdefs.h.

MSG_TLV_MAX_VALUE_SIZE

#define MSG_TLV_MAX_VALUE_SIZE   480

Definition at line 18366 of file gpsdefs.h.

Typedef Documentation

MBG_TLV_TYPE

typedef uint32_t MBG_TLV_TYPE

A data type to hold one of the MBG_TLV_TYPES or MBG_TLV_FEAT_TYPES.

See also

MBG_TLV_TYPES

MBG_TLV_FEAT_TYPES

Definition at line 18088 of file gpsdefs.h.

MBG_TLV_UID

typedef uint32_t MBG_TLV_UID

A data type used to hold a unique ID (UID) for a TLV transaction.

Definition at line 18075 of file gpsdefs.h.

Enumeration Type Documentation

MBG_TLV_TYPES

enum MBG_TLV_TYPES

Enumeration of known TLV types.

Used with MBG_TLV_TYPE types, e.g. in MBG_TLV_HDR::tlv_type or MBG_TLV_DATA::type.

See also

MBG_TLV_FEAT_TYPES

MBG_TLV_TYPE

Enumerator
MBG_TLV_TYPE_STR
MBG_TLV_TYPE_FILE
MBG_TLV_TYPE_BLOB	In fact, a file is also a blob but give the child a different name to avoid confusion. Use this for getting/setting fixed structures!
N_MBG_TLV_TYPES

Definition at line 18289 of file gpsdefs.h.