mbgtools-lx  4.2.8
IO Port API

Data Structures

struct  MBG_IO_PORT_LIMITS
 IO Port Limits. More...
 
struct  MBG_IO_PORT_ANT_INFO
 
struct  MBG_IO_PORT_ANT_SETTINGS
 
union  MBG_IO_PORT_SETTINGS_U
 IO Port Settings Union. More...
 
struct  MBG_IO_PORT_SETTINGS
 IO Port Settings. More...
 
struct  MBG_IO_PORT_SETTINGS_IDX
 IO Port Settings Index. More...
 
struct  MBG_IO_PORT_INFO
 IO Port Info. More...
 
struct  MBG_IO_PORT_INFO_IDX
 IO Port Info Index. More...
 
union  MBG_IO_PORT_TYPE_INFO_U
 IO Port Type Info Union. More...
 
struct  MBG_IO_PORT_TYPE_INFO
 IO Port Type Info. More...
 
struct  MBG_IO_PORT_TYPE_INFO_IDX
 IO Port Type Info Index. More...
 
struct  MBG_IO_PORT_STATUS_BUFFER
 A structure used to store port status bits. More...
 
struct  MBG_IO_PORT_STATUS
 IO Port Type Status. More...
 
struct  MBG_IO_PORT_STATUS_IDX
 IO Port Type Status. More...
 

Macros

#define MBG_IO_PORT_TYPE_NONE   ( (uint16_t) -1 )
 Port type to be used for an undefined/unassigned port. More...
 
#define MBG_IO_PORT_TYPE_STRS
 Strings descriptions for MBG_IO_PORT_TYPES. More...
 
#define MBG_IO_PORT_DIR_STRS
 Strings descriptions for MBG_IO_PORT_DIRS. More...
 
#define MBG_IO_PORT_SRC_STRS
 Strings descriptions for MBG_IO_PORT_SRCS. More...
 
#define MBG_IO_PORT_CONN_TYPE_VAR_POLS
 Number of variable pols of the connector type, see MBG_IO_PORT_INFO::pols. More...
 
#define MBG_IO_PORT_CONN_TYPE_STRS
 Strings descriptions for MBG_IO_PORT_CONN_TYPES. More...
 
#define MBG_IO_PORT_BG_COLOUR_STRS
 
#define MBG_IO_PORT_SHAPE_LEVEL_STRS
 String initializers for I/O port shapes/levels. More...
 
#define _mbg_swab_io_port_limits(_p)
 
#define MBG_IO_PORT_OP_MODE_STRS
 Strings descriptions for MBG_IO_PORT_OP_MODE_BITS. More...
 
#define MBG_IO_PORT_GRP_ROLE_STRS
 Strings descriptions for MBG_IO_PORT_GRP_ROLE_BITS. More...
 
#define _mbg_swab_io_port_ant_info(_p)
 
#define _mbg_swab_io_port_ant_settings(_p)
 
#define _mbg_swab_io_port_settings_u(_type, _p, _recv)
 
#define MBG_IO_PORT_SETTINGS_MIN_SIZE   32
 
#define _mbg_swab_io_port_settings(_p, _recv)
 
#define _mbg_swab_io_port_settings_idx(_p, _recv)
 
#define MBG_IO_PORT_SETTINGS_IDX_MIN_SIZE   (MBG_IO_PORT_SETTINGS_MIN_SIZE + sizeof( uint32_t ))
 
#define MBG_IO_PORT_SETTINGS_IDX_SIZES
 
#define MBG_NO_PHYS_GROUP   0xFF
 
#define MBG_NO_LOG_GROUP   0xFF
 
#define MBG_IO_PORT_STR_SIZE   16
 
#define _mbg_port_has_phys_group(_p)   ( ( _p )->phys_grp != MBG_NO_PHYS_GROUP )
 
#define _mbg_swab_io_port_info(_p, _recv)
 
#define MBG_IO_PORT_INFO_MIN_SIZE   ( 60 + MBG_IO_PORT_SETTINGS_MIN_SIZE )
 
#define _mbg_swab_io_port_info_idx(_p, _recv)
 
#define MBG_IO_PORT_INFO_IDX_MIN_SIZE   (MBG_IO_PORT_INFO_MIN_SIZE + sizeof( uint32_t ))
 
#define MBG_IO_PORT_INFO_IDX_SIZES
 
#define _mbg_swab_io_port_type_info_u(_type, _p, _recv)
 
#define MBG_IO_PORT_TYPE_INFO_MIN_SIZE   32
 
#define _mbg_swab_io_port_type_info(_p, _recv)
 
#define MBG_IO_PORT_TYPE_INFO_IDX_MIN_SIZE   (MBG_IO_PORT_TYPE_INFO_MIN_SIZE + 2 * sizeof( uint32_t ))
 
#define MBG_IO_PORT_TYPE_INFO_IDX_SIZES
 
#define _mbg_swab_io_port_type_info_idx(_p, _recv)
 
#define MAX_IO_PORT_STATUS_BITS   64
 
#define MBG_IO_PORT_STATUS_STRS
 Strings descriptions for MBG_IO_PORT_STATUS_BITS. More...
 
#define MAX_IO_PORT_STATUS_BYTES   ( MAX_IO_PORT_STATUS_BITS / 8 )
 Array size required to store all status bits. More...
 
#define _mbg_swab_io_port_status_buffer(_p)   _nop_macro_fnc()
 
#define _set_io_port_status_bit(_status_bit, _status_buffp)   _set_array_bit( _status_bit, (_status_buffp)->b, MAX_IO_PORT_STATUS_BYTES )
 Set an port status bit in a MBG_IO_PORT_STATUS_BUFFER. More...
 
#define _clear_io_port_status_bit(_status_bit, _status_buffp)   _clear_array_bit( _status_bit, (_status_buffp)->b, MAX_IO_PORT_STATUS_BYTES )
 Clear a port status bit in a MBG_IO_PORT_STATUS_BUFFER. More...
 
#define _mbg_port_has_log_group(_p)   ( ( _p )->log_grp != MBG_NO_LOG_GROUP )
 
#define _mbg_swab_io_port_status(_p)
 
#define _mbg_swab_io_port_status_idx(_p)
 

Enumerations

enum  MBG_IO_PORT_TYPES {
  MBG_IO_PORT_TYPE_PPS, MBG_IO_PORT_TYPE_10MHz, MBG_IO_PORT_TYPE_2048KHz, MBG_IO_PORT_TYPE_GPIO,
  MBG_IO_PORT_TYPE_ETHERNET, MBG_IO_PORT_TYPE_TERMINAL, MBG_IO_PORT_TYPE_MULTI, MBG_IO_PORT_TYPE_POUT,
  MBG_IO_PORT_TYPE_SWITCH, MBG_IO_PORT_TYPE_TIMECODE, MBG_IO_PORT_TYPE_LIGHT, MBG_IO_PORT_TYPE_ANTENNA,
  MBG_IO_PORT_TYPE_UART, MBG_IO_PORT_TYPE_DCF77, MBG_IO_PORT_TYPE_POWER, N_MBG_IO_PORT_TYPES
}
 IO Port types. More...
 
enum  MBG_IO_PORT_DIRS {
  MBG_IO_PORT_DIR_NONE = -1, MBG_IO_PORT_DIR_IN, MBG_IO_PORT_DIR_OUT, MBG_IO_PORT_DIR_IN_OUT,
  N_MBG_IO_PORT_DIRS
}
 Port directions (input or output) More...
 
enum  MBG_IO_PORT_DIR_MSKS { MBG_IO_PORT_MSK_DIR_IN = ( 1UL << MBG_IO_PORT_DIR_IN ), MBG_IO_PORT_MSK_DIR_OUT = ( 1UL << MBG_IO_PORT_DIR_OUT ), MBG_IO_PORT_MSK_DIR_IN_OUT = ( 1UL << MBG_IO_PORT_DIR_IN_OUT ) }
 Bit masks of Meinberg I/O port directions. More...
 
enum  MBG_IO_PORT_SRCS {
  MBG_IO_PORT_SRC_NONE = -1, MBG_IO_PORT_SRC_STATIC, MBG_IO_PORT_SRC_LOCAL, MBG_IO_PORT_SRC_ASSOC_CLOCK,
  MBG_IO_PORT_SRC_ACTIVE_CLOCK, MBG_IO_PORT_SRC_CLK1, MBG_IO_PORT_SRC_CLK2, MBG_IO_PORT_SRC_ARC,
  MBG_IO_PORT_SRC_OSC, MBG_IO_PORT_SRC_SYNCE, MBG_IO_PORT_SRC_SWITCH_CARD, MBG_IO_PORT_SRC_CONFIGURABLE,
  MBG_IO_PORT_SRC_EXTERNAL, N_MBG_IO_PORT_SRCS
}
 Port type sources. More...
 
enum  MBG_IO_PORT_SRC_MSKS {
  MBG_IO_PORT_SRC_MSK_STATIC = (1UL << MBG_IO_PORT_SRC_STATIC), MBG_IO_PORT_SRC_MSK_LOCAL = (1UL << MBG_IO_PORT_SRC_LOCAL), MBG_IO_PORT_SRC_MSK_ASSOC_CLOCK = (1UL << MBG_IO_PORT_SRC_ASSOC_CLOCK), MBG_IO_PORT_SRC_MSK_ACTIVE_CLOCK = (1UL << MBG_IO_PORT_SRC_ACTIVE_CLOCK),
  MBG_IO_PORT_SRC_MSK_CLK1 = (1UL << MBG_IO_PORT_SRC_CLK1), MBG_IO_PORT_SRC_MSK_CLK2 = (1UL << MBG_IO_PORT_SRC_CLK2), MBG_IO_PORT_SRC_MSK_ARC = (1UL << MBG_IO_PORT_SRC_ARC), MBG_IO_PORT_SRC_MSK_OSC = (1UL << MBG_IO_PORT_SRC_OSC),
  MBG_IO_PORT_SRC_MSK_SYNCE = (1UL << MBG_IO_PORT_SRC_SYNCE), MBG_IO_PORT_SRC_MSK_SWITCH_CARD = (1UL << MBG_IO_PORT_SRC_SWITCH_CARD), MBG_IO_PORT_SRC_MSK_CONFIGURABLE = (1UL << MBG_IO_PORT_SRC_CONFIGURABLE), MBG_IO_PORT_SRC_MSK_EXTERNAL = (1UL << MBG_IO_PORT_SRC_EXTERNAL)
}
 Bit masks of Meinberg I/O port attitudes. More...
 
enum  MBG_IO_PORT_CONN_TYPES {
  MBG_IO_PORT_CONN_TYPE_SMA, MBG_IO_PORT_CONN_TYPE_BNC, MBG_IO_PORT_CONN_TYPE_DSUB25, MBG_IO_PORT_CONN_TYPE_RJ45,
  MBG_IO_PORT_CONN_TYPE_SFP, MBG_IO_PORT_CONN_TYPE_USB_MICRO_B, MBG_IO_PORT_CONN_TYPE_USB_A, MBG_IO_PORT_CONN_TYPE_USB_B,
  MBG_IO_PORT_CONN_TYPE_SMA_ANT, MBG_IO_PORT_CONN_TYPE_RJ45_ETH, MBG_IO_PORT_CONN_TYPE_2_PIN_DFK, MBG_IO_PORT_CONN_TYPE_3_PIN_DFK,
  MBG_IO_PORT_CONN_TYPE_16_PIN_DFK, MBG_IO_PORT_CONN_TYPE_BNC_ISO, MBG_IO_PORT_CONN_TYPE_DSUB9, MBG_IO_PORT_CONN_TYPE_FIBRE_ST,
  MBG_IO_PORT_CONN_TYPE_XHE_SPI, MBG_IO_PORT_CONN_TYPE_LED_BUTTON, MBG_IO_PORT_CONN_TYPE_QUAD_LED, MBG_IO_PORT_CONN_TYPE_5_PIN_DFK,
  N_MBG_IO_PORT_CONN_TYPES
}
 Port connector types. More...
 
enum  MBG_IO_PORT_FLAGS {
  MBG_IO_PORT_FLAG_HORIZONTAL_LAYOUT, MBG_IO_PORT_FLAG_FRONT_PORTS, MBG_IO_PORT_FLAG_REAR_PORTS, MBG_IO_PORT_FLAG_NO_LABEL,
  MBG_IO_PORT_FLAG_NO_GRASP, N_MBG_IO_PORT_FLAGS
}
 
enum  MBG_IO_PORT_MSKS {
  MBG_IO_PORT_MSK_HORIZONTAL_LAYOUT = ( 1UL << MBG_IO_PORT_FLAG_HORIZONTAL_LAYOUT ), MBG_IO_PORT_MSK_FRONT_PORTS = ( 1UL << MBG_IO_PORT_FLAG_FRONT_PORTS ), MBG_IO_PORT_MSK_REAR_PORTS = ( 1UL << MBG_IO_PORT_FLAG_REAR_PORTS ), MBG_IO_PORT_MSK_NO_LABEL = ( 1UL << MBG_IO_PORT_FLAG_NO_LABEL ),
  MBG_IO_PORT_MSK_NO_GRASP = ( 1UL << MBG_IO_PORT_FLAG_NO_GRASP )
}
 
enum  MBG_IO_PORT_BG_COLOURS { MBG_IO_PORT_BG_COLOUR_SILVER, MBG_IO_PORT_BG_COLOUR_BLACK, MBG_IO_PORT_BG_COLOUR_BLUE, N_MBG_IO_PORT_BG_COLOURS }
 
enum  MBG_IO_PORT_SHAPE_LEVELS { MBG_IO_PORT_SHAPE_LEVEL_NONE, MBG_IO_PORT_SHAPE_LEVEL_SINE, MBG_IO_PORT_SHAPE_LEVEL_SQUARE, N_MBG_IO_PORT_SHAPE_LEVELS }
 Enumeration of known signal shapes/levels. More...
 
enum  MBG_IO_PORT_OP_MODE_BITS {
  MBG_IO_PORT_OP_MODE_NONE = -1, MBG_IO_PORT_OP_MODE_DISABLED, MBG_IO_PORT_OP_MODE_ALWAYS, MBG_IO_PORT_OP_MODE_IF_SYNC_ONLY,
  MBG_IO_PORT_OP_MODE_AFTER_SYNC, MBG_IO_PORT_OP_MODE_ENABLED, MBG_IO_PORT_OP_MODE_PASSTHROUGH, N_MBG_IO_PORT_OP_MODE_BITS
}
 Port Operation Bits. More...
 
enum  MBG_IO_PORT_OP_MODE_MSKS {
  MBG_IO_PORT_OP_MODE_MSK_DISABLED = (1UL << MBG_IO_PORT_OP_MODE_DISABLED), MBG_IO_PORT_OP_MODE_MSK_ALWAYS = (1UL << MBG_IO_PORT_OP_MODE_ALWAYS), MBG_IO_PORT_OP_MODE_MSK_IF_SYNC_ONLY = (1UL << MBG_IO_PORT_OP_MODE_IF_SYNC_ONLY), MBG_IO_PORT_OP_MODE_MSK_AFTER_SYNC = (1UL << MBG_IO_PORT_OP_MODE_AFTER_SYNC),
  MBG_IO_PORT_OP_MODE_MSK_ENABLED = (1UL << MBG_IO_PORT_OP_MODE_ENABLED), MBG_IO_PORT_OP_MODE_MSK_PASSTHROUGH = (1UL << MBG_IO_PORT_OP_MODE_PASSTHROUGH)
}
 Masks for MBG_IO_PORT_OP_MODE_BITS. More...
 
enum  MBG_IO_PORT_GRP_ROLE_BITS {
  MBG_IO_PORT_GRP_ROLE_NONE, MBG_IO_PORT_GRP_ROLE_MASTER, MBG_IO_PORT_GRP_ROLE_SLAVE, MBG_IO_PORT_GRP_ROLE_PASSIVE,
  N_MBG_IO_PORT_GRP_ROLE_BITS
}
 Physical or logical group role bits. More...
 
enum  MBG_IO_PORT_GRP_ROLE_MSKS { MBG_IO_PORT_GRP_ROLE_MSK_NONE = (1UL << MBG_IO_PORT_GRP_ROLE_NONE), MBG_IO_PORT_GRP_ROLE_MSK_MASTER = (1UL << MBG_IO_PORT_GRP_ROLE_MASTER), MBG_IO_PORT_GRP_ROLE_MSK_SLAVE = (1UL << MBG_IO_PORT_GRP_ROLE_SLAVE), MBG_IO_PORT_GRP_ROLE_MSK_PASSIVE = (1UL << MBG_IO_PORT_GRP_ROLE_PASSIVE) }
 Masks for MBG_IO_PORT_GRP_ROLE_BITS. More...
 
enum  MBG_IO_PORT_ANT_MEMBERS {
  MBG_IO_PORT_ANT_MEMBER_GNSS, MBG_IO_PORT_ANT_MEMBER_CAB_LEN, MBG_IO_PORT_ANT_MEMBER_IGN_LOCK, MBG_IO_PORT_ANT_MEMBER_TR_DIST,
  N_MBG_IO_PORT_ANT_MEMBERS
}
 Supported members in ::MBG_IO_PORT_ANTENNA_INFO and ::MBG_IO_PORT_ANTENNA_SETTINGS. More...
 
enum  MBG_IO_PORT_ANT_MEMBER_MSKS { MBG_IO_PORT_ANT_MEMBER_MSK_GNSS = (1UL << MBG_IO_PORT_ANT_MEMBER_GNSS), MBG_IO_PORT_ANT_MEMBER_MSK_CAB_LEN = (1UL << MBG_IO_PORT_ANT_MEMBER_CAB_LEN), MBG_IO_PORT_ANT_MEMBER_MSK_IGN_LOCK = (1UL << MBG_IO_PORT_ANT_MEMBER_IGN_LOCK), MBG_IO_PORT_ANT_MEMBER_MSK_TR_DIST = (1UL << MBG_IO_PORT_ANT_MEMBER_TR_DIST) }
 
enum  MBG_IO_PORT_INFO_BITS { MBG_IO_PORT_INFO_BIT_IS_ALIGNED }
 
enum  MBG_IO_PORT_INFO_MASKS { MBG_IO_PORT_INFO_MASK_IS_ALIGNED = ( 1UL << MBG_IO_PORT_INFO_BIT_IS_ALIGNED ) }
 
enum  MBG_IO_PORT_STATUS_BITS {
  MBG_IO_PORT_STATUS_BIT_DISABLED, MBG_IO_PORT_STATUS_BIT_CARRIER_DETECTED, MBG_IO_PORT_STATUS_BIT_INPUT_SIGNAL_NEVER_AVAIL, MBG_IO_PORT_STATUS_BIT_INPUT_SIGNAL_AVAIL,
  MBG_IO_PORT_STATUS_BIT_INPUT_SIGNAL_LOST, MBG_IO_PORT_STATUS_BIT_SHORT_CIRCUIT, MBG_IO_PORT_STATUS_BIT_LIGHT_RED, MBG_IO_PORT_STATUS_BIT_LIGHT_GREEN,
  MBG_IO_PORT_STATUS_BIT_LIGHT_BLUE, MBG_IO_PORT_STATUS_BIT_LIGHT_YELLOW, N_MBG_IO_PORT_STATUS_BITS
}
 Port Type Status Bits. More...
 

Detailed Description

Note
This structure and its definitions are only supported by a device if MBG_XFEATURE_IO_PORTS is set in the extended device features.

Macro Definition Documentation

◆ _clear_io_port_status_bit

#define _clear_io_port_status_bit (   _status_bit,
  _status_buffp 
)    _clear_array_bit( _status_bit, (_status_buffp)->b, MAX_IO_PORT_STATUS_BYTES )

Clear a port status bit in a MBG_IO_PORT_STATUS_BUFFER.

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

Parameters
[in]_status_bitOne of the MBG_IO_PORT_STATUS_BITS
[in]_status_buffpPointer to an MBG_IO_PORT_STATUS_BUFFER

Definition at line 21165 of file gpsdefs.h.

◆ _mbg_port_has_log_group

#define _mbg_port_has_log_group (   _p)    ( ( _p )->log_grp != MBG_NO_LOG_GROUP )

Definition at line 21197 of file gpsdefs.h.

◆ _mbg_port_has_phys_group

#define _mbg_port_has_phys_group (   _p)    ( ( _p )->phys_grp != MBG_NO_PHYS_GROUP )

Definition at line 20827 of file gpsdefs.h.

◆ _mbg_swab_io_port_ant_info

#define _mbg_swab_io_port_ant_info (   _p)
Value:
do \
{ \
_mbg_swab32( &(_p)->supp_members ); \
_mbg_swab_mbg_gnss_mode_info( &(_p)->gnss_info ); \
} while ( 0 )

Definition at line 20589 of file gpsdefs.h.

◆ _mbg_swab_io_port_ant_settings

#define _mbg_swab_io_port_ant_settings (   _p)
Value:
do \
{ \
_mbg_swab_mbg_gnss_mode_settings( &(_p)->gnss_settings ); \
_mbg_swab_ant_cable_len( &(_p)->ant_cab_len ); \
_mbg_swab16( &(_p)->ignore_lock ); \
_mbg_swab16( &(_p)->tr_dist ); \
} while ( 0 )

Definition at line 20606 of file gpsdefs.h.

◆ _mbg_swab_io_port_info

#define _mbg_swab_io_port_info (   _p,
  _recv 
)
Value:
do \
{ \
_mbg_swab16( &(_p)->supp_op_modes ); \
_mbg_swab16( &(_p)->supp_phys_grp_roles ); \
_mbg_swab32( &(_p)->pols ); \
_mbg_swab32( &(_p)->flags ); \
_mbg_swab_io_port_settings( &(_p)->settings, (_recv) ); \
} while ( 0 )

Definition at line 20829 of file gpsdefs.h.

◆ _mbg_swab_io_port_info_idx

#define _mbg_swab_io_port_info_idx (   _p,
  _recv 
)
Value:
do \
{ \
_mbg_swab32( &(_p)->idx ); \
_mbg_swab_io_port_info( &(_p)->info, (_recv) ); \
} while ( 0 )

Definition at line 20869 of file gpsdefs.h.

Referenced by mbgextio_get_io_port_info_idx().

◆ _mbg_swab_io_port_limits

#define _mbg_swab_io_port_limits (   _p)
Value:
do \
{ \
_mbg_swab32( &(_p)->flags ); \
} while ( 0 )

Definition at line 20434 of file gpsdefs.h.

Referenced by mbgextio_get_io_port_limits().

◆ _mbg_swab_io_port_settings

#define _mbg_swab_io_port_settings (   _p,
  _recv 
)
Value:
do \
{ \
uint16_t t = (_p)->port_type; \
if ( (_recv) ) \
_mbg_swab16( &t ); \
_mbg_swab16( &(_p)->port_type ); \
_mbg_swab_io_port_settings_u( t, &(_p)->data, (_recv) ); \
} while ( 0 )

Definition at line 20708 of file gpsdefs.h.

◆ _mbg_swab_io_port_settings_idx

#define _mbg_swab_io_port_settings_idx (   _p,
  _recv 
)
Value:
do \
{ \
_mbg_swab32( &(_p)->idx ); \
_mbg_swab_io_port_settings( &(_p)->settings, (_recv) ); \
} while ( 0 )

Definition at line 20745 of file gpsdefs.h.

Referenced by mbgextio_set_io_port_settings_idx().

◆ _mbg_swab_io_port_settings_u

#define _mbg_swab_io_port_settings_u (   _type,
  _p,
  _recv 
)
Value:
do \
{ \
switch ( (_type) ) \
{ \
_mbg_swab_mbg_gpio_settings( &(_p)->gpio_settings, (_recv) ); \
break; \
\
if ( _recv ) \
_mbg_swab_pout_settings_on_get( &(_p)->pout_settings ); \
else _mbg_swab_pout_settings_on_set( &(_p)->pout_settings ); \
break; \
\
_mbg_swab_irig_settings( &(_p)->irig_settings ); \
break; \
\
_mbg_swab_io_port_ant_settings( &(_p)->ant_settings ); \
break; \
\
_mbg_swab_port_settings( &(_p)->uart_settings ); \
break; \
\
default: break; \
} \
} while ( 0 )
#define _mbg_swab_pout_settings_on_set(_p)
Convert POUT_SETTINGS endianess before writing to a device.
Definition: gpsdefs.h:5726
e.g. IRIG AM/DC, see MBG_IO_PORT_SHAPE_LEVELS
Definition: gpsdefs.h:20066

Definition at line 20640 of file gpsdefs.h.

◆ _mbg_swab_io_port_status

#define _mbg_swab_io_port_status (   _p)
Value:
do \
{ \
_mbg_swab_io_port_status_buffer( &(_p)->supp_stati ); \
_mbg_swab_io_port_status_buffer( &(_p)->status ); \
} while ( 0 )

Definition at line 21199 of file gpsdefs.h.

◆ _mbg_swab_io_port_status_buffer

#define _mbg_swab_io_port_status_buffer (   _p)    _nop_macro_fnc()

Definition at line 21138 of file gpsdefs.h.

◆ _mbg_swab_io_port_status_idx

#define _mbg_swab_io_port_status_idx (   _p)
Value:
do \
{ \
_mbg_swab32( &(_p)->idx ); \
_mbg_swab_io_port_status( &(_p)->status ); \
} while ( 0 )

Definition at line 21232 of file gpsdefs.h.

Referenced by mbgextio_get_io_port_status_idx().

◆ _mbg_swab_io_port_type_info

#define _mbg_swab_io_port_type_info (   _p,
  _recv 
)
Value:
do \
{ \
uint16_t t = (_p)->port_type; \
if ( (_recv) ) \
_mbg_swab16( &t ); \
_mbg_swab16( &(_p)->port_type ); \
_mbg_swab_io_port_type_info_u( t, &(_p)->data, (_recv) ); \
_mbg_swab32( &(_p)->supp_srcs ); \
} while ( 0 )

Definition at line 20994 of file gpsdefs.h.

◆ _mbg_swab_io_port_type_info_idx

#define _mbg_swab_io_port_type_info_idx (   _p,
  _recv 
)
Value:
do \
{ \
_mbg_swab32( &(_p)->port_idx ); \
_mbg_swab32( &(_p)->port_type_idx ); \
_mbg_swab_io_port_type_info( &(_p)->info, (_recv) ); \
} while ( 0 )

Definition at line 21054 of file gpsdefs.h.

Referenced by mbgextio_get_io_port_type_info_idx().

◆ _mbg_swab_io_port_type_info_u

#define _mbg_swab_io_port_type_info_u (   _type,
  _p,
  _recv 
)
Value:
do \
{ \
switch ( (_type) ) \
{ \
_mbg_swab_mbg_gpio_limits( &(_p)->gpio_limits, (_recv) ); \
break; \
\
_mbg_swab_pout_info_on_get( &(_p)->pout_info ); \
break; \
\
_mbg_swab_irig_info( &(_p)->irig_info ); \
break; \
\
_mbg_swab_io_port_ant_info( &(_p)->ant_info ); \
break; \
\
_mbg_swab_port_info( &(_p)->uart_info ); \
break; \
\
default: break; \
} \
} while ( 0 )
e.g. IRIG AM/DC, see MBG_IO_PORT_SHAPE_LEVELS
Definition: gpsdefs.h:20066

Definition at line 20926 of file gpsdefs.h.

◆ _set_io_port_status_bit

#define _set_io_port_status_bit (   _status_bit,
  _status_buffp 
)    _set_array_bit( _status_bit, (_status_buffp)->b, MAX_IO_PORT_STATUS_BYTES )

Set an port status bit in a MBG_IO_PORT_STATUS_BUFFER.

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

Parameters
[in]_status_bitOne of the MBG_IO_PORT_STATUS_BITS
[in]_status_buffpPointer to an MBG_IO_PORT_STATUS_BUFFER

Definition at line 21152 of file gpsdefs.h.

◆ MAX_IO_PORT_STATUS_BITS

#define MAX_IO_PORT_STATUS_BITS   64

Definition at line 21064 of file gpsdefs.h.

◆ MAX_IO_PORT_STATUS_BYTES

#define MAX_IO_PORT_STATUS_BYTES   ( MAX_IO_PORT_STATUS_BITS / 8 )

Array size required to store all status bits.

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

Definition at line 21116 of file gpsdefs.h.

◆ MBG_IO_PORT_BG_COLOUR_STRS

#define MBG_IO_PORT_BG_COLOUR_STRS
Value:
{ \
"Silver", \
"Black", \
"Blue" \
}

Definition at line 20359 of file gpsdefs.h.

◆ MBG_IO_PORT_CONN_TYPE_STRS

#define MBG_IO_PORT_CONN_TYPE_STRS
Value:
{ \
"SMA", \
"BNC", \
"D-Sub 25", \
"RJ45", \
"SFP", \
"USB Micro B", \
"USB A", \
"USB B", \
"SMA Antenna", \
"RJ45 Ethernet", \
"DFK 2-Pin", \
"DFK 3-Pin", \
"DFK 16-Pin", \
"BNC isolated", \
"D-Sub 9", \
"Fibre ST", \
"XHE SPI", \
"LED Button", \
"Quad LED", \
"DFK 5-Pin" \
}

Strings descriptions for MBG_IO_PORT_CONN_TYPES.

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

See also
MBG_IO_PORT_CONN_TYPES

Definition at line 20304 of file gpsdefs.h.

◆ MBG_IO_PORT_CONN_TYPE_VAR_POLS

#define MBG_IO_PORT_CONN_TYPE_VAR_POLS
Value:
{ \
1, \
1, \
1, \
1, \
1, \
1, \
1, \
1, \
1, \
1, \
1, \
1, \
16, \
1, \
1, \
1, \
1, \
1, \
4, \
1 \
}

Number of variable pols of the connector type, see MBG_IO_PORT_INFO::pols.

Used with MBG_IO_PORT_INFO::conn_type and MBG_IO_PORT_INFO::pols

Definition at line 20271 of file gpsdefs.h.

◆ MBG_IO_PORT_DIR_STRS

#define MBG_IO_PORT_DIR_STRS
Value:
{ \
"Input", \
"Output", \
"Input/Output" \
}

Strings descriptions for MBG_IO_PORT_DIRS.

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

See also
MBG_IO_PORT_DIRS

Definition at line 20135 of file gpsdefs.h.

◆ MBG_IO_PORT_GRP_ROLE_STRS

#define MBG_IO_PORT_GRP_ROLE_STRS
Value:
{ \
"None", \
"Master", \
"Slave", \
"Passive" \
}

Strings descriptions for MBG_IO_PORT_GRP_ROLE_BITS.

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

See also
MBG_IO_PORT_GRP_ROLE_BITS

Definition at line 20528 of file gpsdefs.h.

◆ MBG_IO_PORT_INFO_IDX_MIN_SIZE

#define MBG_IO_PORT_INFO_IDX_MIN_SIZE   (MBG_IO_PORT_INFO_MIN_SIZE + sizeof( uint32_t ))

Definition at line 20878 of file gpsdefs.h.

Referenced by mbgextio_get_io_port_info_idx().

◆ MBG_IO_PORT_INFO_IDX_SIZES

#define MBG_IO_PORT_INFO_IDX_SIZES
Value:
{ \
MBG_IO_PORT_INFO_IDX_MIN_SIZE, /* MBG_IO_PORT_TYPE_PPS */ \
MBG_IO_PORT_INFO_IDX_MIN_SIZE, /* MBG_IO_PORT_TYPE_10MHz */ \
MBG_IO_PORT_INFO_IDX_MIN_SIZE, /* MBG_IO_PORT_TYPE_2048KHz */ \
MBG_IO_PORT_INFO_IDX_MIN_SIZE + sizeof( MBG_GPIO_SETTINGS ), /* MBG_IO_PORT_TYPE_GPIO */ \
MBG_IO_PORT_INFO_IDX_MIN_SIZE, /* MBG_IO_PORT_TYPE_ETHERNET */ \
MBG_IO_PORT_INFO_IDX_MIN_SIZE, /* MBG_IO_PORT_TYPE_TERMINAL */ \
MBG_IO_PORT_INFO_IDX_MIN_SIZE, /* MBG_IO_PORT_TYPE_MULTI */ \
MBG_IO_PORT_INFO_IDX_MIN_SIZE + sizeof( POUT_SETTINGS ), /* MBG_IO_PORT_TYPE_POUT */ \
MBG_IO_PORT_INFO_IDX_MIN_SIZE, /* MBG_IO_PORT_TYPE_SWITCH */ \
MBG_IO_PORT_INFO_IDX_MIN_SIZE + sizeof( IRIG_SETTINGS ), /* MBG_IO_PORT_TYPE_TIMECODE */ \
MBG_IO_PORT_INFO_IDX_MIN_SIZE, /* MBG_IO_PORT_TYPE_LIGHT */ \
MBG_IO_PORT_INFO_IDX_MIN_SIZE + sizeof( MBG_IO_PORT_ANT_SETTINGS ), /* MBG_IO_PORT_TYPE_ANTENNA */ \
MBG_IO_PORT_INFO_IDX_MIN_SIZE + sizeof( PORT_SETTINGS ), /* MBG_IO_PORT_TYPE_UART */ \
MBG_IO_PORT_INFO_IDX_MIN_SIZE, /* MBG_IO_PORT_TYPE_DCF77 */ \
MBG_IO_PORT_INFO_IDX_MIN_SIZE /* MBG_IO_PORT_TYPE_POWER */ \
}
Configuration settings of a serial port.
Definition: gpsdefs.h:3507
A generic structure used to hold a GPIO port&#39;s settings.
Definition: gpsdefs.h:9127
Configuration settings for a single programmable pulse output.
Definition: gpsdefs.h:5692
#define MBG_IO_PORT_INFO_IDX_MIN_SIZE
Definition: gpsdefs.h:20878
Configuration settings of an IRIG input or output.
Definition: gpsdefs.h:4999

Definition at line 20881 of file gpsdefs.h.

◆ MBG_IO_PORT_INFO_MIN_SIZE

#define MBG_IO_PORT_INFO_MIN_SIZE   ( 60 + MBG_IO_PORT_SETTINGS_MIN_SIZE )

Definition at line 20841 of file gpsdefs.h.

◆ MBG_IO_PORT_OP_MODE_STRS

#define MBG_IO_PORT_OP_MODE_STRS
Value:
{ \
"Disabled", \
"Always enabled", \
"If sync only", \
"Always after sync", \
"Enabled", \
"Passed through" \
}

Strings descriptions for MBG_IO_PORT_OP_MODE_BITS.

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

See also
MBG_IO_PORT_OP_MODE_BITS

Definition at line 20473 of file gpsdefs.h.

◆ MBG_IO_PORT_SETTINGS_IDX_MIN_SIZE

#define MBG_IO_PORT_SETTINGS_IDX_MIN_SIZE   (MBG_IO_PORT_SETTINGS_MIN_SIZE + sizeof( uint32_t ))

Definition at line 20753 of file gpsdefs.h.

◆ MBG_IO_PORT_SETTINGS_IDX_SIZES

#define MBG_IO_PORT_SETTINGS_IDX_SIZES
Value:
{ \
MBG_IO_PORT_SETTINGS_IDX_MIN_SIZE, /* MBG_IO_PORT_TYPE_PPS */ \
MBG_IO_PORT_SETTINGS_IDX_MIN_SIZE, /* MBG_IO_PORT_TYPE_10MHz */ \
MBG_IO_PORT_SETTINGS_IDX_MIN_SIZE, /* MBG_IO_PORT_TYPE_2048KHz */ \
MBG_IO_PORT_SETTINGS_IDX_MIN_SIZE + sizeof( MBG_GPIO_SETTINGS ), /* MBG_IO_PORT_TYPE_GPIO */ \
MBG_IO_PORT_SETTINGS_IDX_MIN_SIZE, /* MBG_IO_PORT_TYPE_ETHERNET */ \
MBG_IO_PORT_SETTINGS_IDX_MIN_SIZE, /* MBG_IO_PORT_TYPE_TERMINAL */ \
MBG_IO_PORT_SETTINGS_IDX_MIN_SIZE, /* MBG_IO_PORT_TYPE_MULTI */ \
MBG_IO_PORT_SETTINGS_IDX_MIN_SIZE + sizeof( POUT_SETTINGS ), /* MBG_IO_PORT_TYPE_POUT */ \
MBG_IO_PORT_SETTINGS_IDX_MIN_SIZE, /* MBG_IO_PORT_TYPE_SWITCH */ \
MBG_IO_PORT_SETTINGS_IDX_MIN_SIZE + sizeof( IRIG_SETTINGS ), /* MBG_IO_PORT_TYPE_TIMECODE */ \
MBG_IO_PORT_SETTINGS_IDX_MIN_SIZE, /* MBG_IO_PORT_TYPE_LIGHT */ \
MBG_IO_PORT_SETTINGS_IDX_MIN_SIZE + sizeof( MBG_IO_PORT_ANT_SETTINGS ), /* MBG_IO_PORT_TYPE_ANTENNA */ \
MBG_IO_PORT_SETTINGS_IDX_MIN_SIZE + sizeof( PORT_SETTINGS ), /* MBG_IO_PORT_TYPE_UART */ \
MBG_IO_PORT_SETTINGS_IDX_MIN_SIZE, /* MBG_IO_PORT_TYPE_DCF77 */ \
MBG_IO_PORT_SETTINGS_IDX_MIN_SIZE /* MBG_IO_PORT_TYPE_POWER */ \
}
Configuration settings of a serial port.
Definition: gpsdefs.h:3507
A generic structure used to hold a GPIO port&#39;s settings.
Definition: gpsdefs.h:9127
Configuration settings for a single programmable pulse output.
Definition: gpsdefs.h:5692
#define MBG_IO_PORT_SETTINGS_IDX_MIN_SIZE
Definition: gpsdefs.h:20753
Configuration settings of an IRIG input or output.
Definition: gpsdefs.h:4999

Definition at line 20756 of file gpsdefs.h.

Referenced by mbgextio_set_io_port_settings_idx().

◆ MBG_IO_PORT_SETTINGS_MIN_SIZE

#define MBG_IO_PORT_SETTINGS_MIN_SIZE   32

Definition at line 20672 of file gpsdefs.h.

◆ MBG_IO_PORT_SHAPE_LEVEL_STRS

#define MBG_IO_PORT_SHAPE_LEVEL_STRS
Value:
{ \
"None", \
"Sine wave", \
"Rectangle Pulse" \
}

String initializers for I/O port shapes/levels.

See also
MBG_IO_PORT_SHAPE_LEVELS

Definition at line 20389 of file gpsdefs.h.

◆ MBG_IO_PORT_SRC_STRS

#define MBG_IO_PORT_SRC_STRS
Value:
{ \
"Static", \
"Locally generated", \
"Associated clock", \
"Active clock", \
"Clock 1 fixed", \
"Clock 2 fixed", \
"Any rate converter", \
"Oscillator", \
"SyncE", \
"Switch card", \
"Configurable", \
"External" \
}

Strings descriptions for MBG_IO_PORT_SRCS.

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

See also
MBG_IO_PORT_SRCS

Definition at line 20192 of file gpsdefs.h.

◆ MBG_IO_PORT_STATUS_STRS

#define MBG_IO_PORT_STATUS_STRS
Value:
{ \
"Disabled", \
"Carrier detected", \
"Input signal has never been avail", \
"Input signal is avail", \
"Input signal is currently lost", \
"Short circuit", \
"Red", \
"Green", \
"Blue", \
"Yellow" \
}

Strings descriptions for MBG_IO_PORT_STATUS_BITS.

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

See also
MBG_IO_PORT_STATUS_BITS

Definition at line 21095 of file gpsdefs.h.

◆ MBG_IO_PORT_STR_SIZE

#define MBG_IO_PORT_STR_SIZE   16

Definition at line 20790 of file gpsdefs.h.

◆ MBG_IO_PORT_TYPE_INFO_IDX_MIN_SIZE

#define MBG_IO_PORT_TYPE_INFO_IDX_MIN_SIZE   (MBG_IO_PORT_TYPE_INFO_MIN_SIZE + 2 * sizeof( uint32_t ))

Definition at line 21006 of file gpsdefs.h.

Referenced by mbgextio_get_io_port_type_info_idx().

◆ MBG_IO_PORT_TYPE_INFO_IDX_SIZES

#define MBG_IO_PORT_TYPE_INFO_IDX_SIZES
Value:
{ \
MBG_IO_PORT_TYPE_INFO_IDX_MIN_SIZE, /* MBG_IO_PORT_TYPE_PPS */ \
MBG_IO_PORT_TYPE_INFO_IDX_MIN_SIZE, /* MBG_IO_PORT_TYPE_10MHz */ \
MBG_IO_PORT_TYPE_INFO_IDX_MIN_SIZE, /* MBG_IO_PORT_TYPE_2048KHz */ \
MBG_IO_PORT_TYPE_INFO_IDX_MIN_SIZE + sizeof( MBG_GPIO_LIMITS ), /* MBG_IO_PORT_TYPE_GPIO */ \
MBG_IO_PORT_TYPE_INFO_IDX_MIN_SIZE, /* MBG_IO_PORT_TYPE_ETHERNET */ \
MBG_IO_PORT_TYPE_INFO_IDX_MIN_SIZE, /* MBG_IO_PORT_TYPE_TERMINAL */ \
MBG_IO_PORT_TYPE_INFO_IDX_MIN_SIZE, /* MBG_IO_PORT_TYPE_MULTI */ \
MBG_IO_PORT_TYPE_INFO_IDX_MIN_SIZE + sizeof( POUT_INFO ), /* MBG_IO_PORT_TYPE_POUT */ \
MBG_IO_PORT_TYPE_INFO_IDX_MIN_SIZE, /* MBG_IO_PORT_TYPE_SWITCH */ \
MBG_IO_PORT_TYPE_INFO_IDX_MIN_SIZE + sizeof( IRIG_INFO ), /* MBG_IO_PORT_TYPE_TIMECODE */ \
MBG_IO_PORT_TYPE_INFO_IDX_MIN_SIZE, /* MBG_IO_PORT_TYPE_LIGHT */ \
MBG_IO_PORT_TYPE_INFO_IDX_MIN_SIZE + sizeof( MBG_IO_PORT_ANT_INFO ), /* MBG_IO_PORT_TYPE_ANTENNA */ \
MBG_IO_PORT_TYPE_INFO_IDX_MIN_SIZE + sizeof( PORT_INFO ), /* MBG_IO_PORT_TYPE_UART */ \
MBG_IO_PORT_TYPE_INFO_IDX_MIN_SIZE, /* MBG_IO_PORT_TYPE_DCF77 */ \
MBG_IO_PORT_TYPE_INFO_IDX_MIN_SIZE /* MBG_IO_PORT_TYPE_POWER */ \
}
Current IRIG settings and supported codes.
Definition: gpsdefs.h:5054
Current settings and general capabilities of a programmable pulse output.
Definition: gpsdefs.h:6281
Current settings and general capabilities of a serial port.
Definition: gpsdefs.h:3618
A generic structure used to specify a GPIO port&#39;s limits.
Definition: gpsdefs.h:9203
#define MBG_IO_PORT_TYPE_INFO_IDX_MIN_SIZE
Definition: gpsdefs.h:21006

Definition at line 21009 of file gpsdefs.h.

◆ MBG_IO_PORT_TYPE_INFO_MIN_SIZE

#define MBG_IO_PORT_TYPE_INFO_MIN_SIZE   32

Definition at line 20957 of file gpsdefs.h.

◆ MBG_IO_PORT_TYPE_NONE

#define MBG_IO_PORT_TYPE_NONE   ( (uint16_t) -1 )

Port type to be used for an undefined/unassigned port.

Only use this for MBG_IO_PORT_SETTINGS::port_type if MBG_IO_PORT_SETTINGS::op_mode is MBG_IO_PORT_OP_MODE_NONE

Definition at line 20081 of file gpsdefs.h.

◆ MBG_IO_PORT_TYPE_STRS

#define MBG_IO_PORT_TYPE_STRS
Value:
{ \
"PPS", \
"10 MHz", \
"2048 KHz", \
"GPIO", \
"Ethernet", \
"Terminal", \
"Multi", \
"Prog. Output", \
"Switch", \
"Timecode", \
"Light", \
"Antenna", \
"UART", \
"DCF77", \
"Power" \
}

Strings descriptions for MBG_IO_PORT_TYPES.

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

See also
MBG_IO_PORT_TYPES

Definition at line 20092 of file gpsdefs.h.

◆ MBG_NO_LOG_GROUP

#define MBG_NO_LOG_GROUP   0xFF

Definition at line 20789 of file gpsdefs.h.

◆ MBG_NO_PHYS_GROUP

#define MBG_NO_PHYS_GROUP   0xFF

Definition at line 20788 of file gpsdefs.h.

Enumeration Type Documentation

◆ MBG_IO_PORT_ANT_MEMBER_MSKS

Enumerator
MBG_IO_PORT_ANT_MEMBER_MSK_GNSS 
MBG_IO_PORT_ANT_MEMBER_MSK_CAB_LEN 

See MBG_IO_PORT_ANT_MEMBER_GNSS.

MBG_IO_PORT_ANT_MEMBER_MSK_IGN_LOCK 

See MBG_IO_PORT_ANT_MEMBER_CAB_LEN.

MBG_IO_PORT_ANT_MEMBER_MSK_TR_DIST 

See MBG_IO_PORT_ANT_MEMBER_IGN_LOCK.

Definition at line 20573 of file gpsdefs.h.

◆ MBG_IO_PORT_ANT_MEMBERS

Supported members in ::MBG_IO_PORT_ANTENNA_INFO and ::MBG_IO_PORT_ANTENNA_SETTINGS.

Used with ::MBG_IO_PORT_ANTENNA_INFO::supp_members

Enumerator
MBG_IO_PORT_ANT_MEMBER_GNSS 

Supports MBG_IO_PORT_ANT_INFO::gnss_info and MBG_IO_PORT_ANT_SETTINGS::gnss_settings.

MBG_IO_PORT_ANT_MEMBER_CAB_LEN 

Supports MBG_IO_PORT_ANT_SETTINGS::ant_cab_len.

MBG_IO_PORT_ANT_MEMBER_IGN_LOCK 

Supports MBG_IO_PORT_ANT_SETTINGS::ignore_lock.

MBG_IO_PORT_ANT_MEMBER_TR_DIST 

Supports MBG_IO_PORT_ANT_SETTINGS::tr_dist.

N_MBG_IO_PORT_ANT_MEMBERS 

Definition at line 20559 of file gpsdefs.h.

◆ MBG_IO_PORT_BG_COLOURS

Enumerator
MBG_IO_PORT_BG_COLOUR_SILVER 
MBG_IO_PORT_BG_COLOUR_BLACK 
MBG_IO_PORT_BG_COLOUR_BLUE 
N_MBG_IO_PORT_BG_COLOURS 

Definition at line 20350 of file gpsdefs.h.

◆ MBG_IO_PORT_CONN_TYPES

Port connector types.

Used with MBG_IO_PORT_INFO::conn_type

Enumerator
MBG_IO_PORT_CONN_TYPE_SMA 
MBG_IO_PORT_CONN_TYPE_BNC 
MBG_IO_PORT_CONN_TYPE_DSUB25 
MBG_IO_PORT_CONN_TYPE_RJ45 
MBG_IO_PORT_CONN_TYPE_SFP 
MBG_IO_PORT_CONN_TYPE_USB_MICRO_B 
MBG_IO_PORT_CONN_TYPE_USB_A 
MBG_IO_PORT_CONN_TYPE_USB_B 
MBG_IO_PORT_CONN_TYPE_SMA_ANT 
MBG_IO_PORT_CONN_TYPE_RJ45_ETH 
MBG_IO_PORT_CONN_TYPE_2_PIN_DFK 
MBG_IO_PORT_CONN_TYPE_3_PIN_DFK 
MBG_IO_PORT_CONN_TYPE_16_PIN_DFK 
MBG_IO_PORT_CONN_TYPE_BNC_ISO 
MBG_IO_PORT_CONN_TYPE_DSUB9 
MBG_IO_PORT_CONN_TYPE_FIBRE_ST 
MBG_IO_PORT_CONN_TYPE_XHE_SPI 
MBG_IO_PORT_CONN_TYPE_LED_BUTTON 
MBG_IO_PORT_CONN_TYPE_QUAD_LED 
MBG_IO_PORT_CONN_TYPE_5_PIN_DFK 
N_MBG_IO_PORT_CONN_TYPES 

Definition at line 20239 of file gpsdefs.h.

◆ MBG_IO_PORT_DIR_MSKS

Bit masks of Meinberg I/O port directions.

Used with MBG_IO_PORT_TYPE_INFO::supp_dirs

See also
MBG_IO_PORT_DIRS
Enumerator
MBG_IO_PORT_MSK_DIR_IN 

See MBG_IO_PORT_DIR_IN.

MBG_IO_PORT_MSK_DIR_OUT 

See MBG_IO_PORT_DIR_OUT.

MBG_IO_PORT_MSK_DIR_IN_OUT 

See MBG_IO_PORT_DIR_IN_OUT.

Definition at line 20150 of file gpsdefs.h.

◆ MBG_IO_PORT_DIRS

Port directions (input or output)

See also
MBG_IO_PORT_DIR_MSKS
Enumerator
MBG_IO_PORT_DIR_NONE 

Only use this for MBG_IO_PORT_SETTINGS::direction if MBG_IO_PORT_SETTINGS::op_mode is MBG_IO_PORT_OP_MODE_NONE.

MBG_IO_PORT_DIR_IN 

Port is input like PPS In.

MBG_IO_PORT_DIR_OUT 

Port is output like 10Mhz.

MBG_IO_PORT_DIR_IN_OUT 

Port can be in- & output in parallel like network port.

N_MBG_IO_PORT_DIRS 

Definition at line 20117 of file gpsdefs.h.

◆ MBG_IO_PORT_FLAGS

Enumerator
MBG_IO_PORT_FLAG_HORIZONTAL_LAYOUT 

Modules (rows and columns) are layouted horizontally.

MBG_IO_PORT_FLAG_FRONT_PORTS 

Device has ports at the front side.

MBG_IO_PORT_FLAG_REAR_PORTS 

Device has ports at the rear side.

MBG_IO_PORT_FLAG_NO_LABEL 

Device does not have a label.

MBG_IO_PORT_FLAG_NO_GRASP 

Device does not have a grasp.

N_MBG_IO_PORT_FLAGS 

Definition at line 20329 of file gpsdefs.h.

◆ MBG_IO_PORT_GRP_ROLE_BITS

Physical or logical group role bits.

Used with MBG_IO_PORT_STATUS::phys_grp_role, MBG_IO_PORT_STATUS::log_grp_role

See also
MBG_IO_PORT_GRP_ROLE_MSKS
Enumerator
MBG_IO_PORT_GRP_ROLE_NONE 

No group role, only possible if port is not assigned to any group.

MBG_IO_PORT_GRP_ROLE_MASTER 

Master port in group, i.e. configurable port of LIU.

MBG_IO_PORT_GRP_ROLE_SLAVE 

Slave port in group, i.e. non-configurable port of LIU.

MBG_IO_PORT_GRP_ROLE_PASSIVE 

Passive port in group, i.e. passive port of network group (i.e. SFP or RJ45)

N_MBG_IO_PORT_GRP_ROLE_BITS 

Definition at line 20510 of file gpsdefs.h.

◆ MBG_IO_PORT_GRP_ROLE_MSKS

Masks for MBG_IO_PORT_GRP_ROLE_BITS.

Used with MBG_IO_PORT_INFO::supp_phys_grp_roles

See also
MBG_IO_PORT_GRP_ROLE_BITS
Enumerator
MBG_IO_PORT_GRP_ROLE_MSK_NONE 

See MBG_IO_PORT_GRP_ROLE_NONE.

MBG_IO_PORT_GRP_ROLE_MSK_MASTER 

See MBG_IO_PORT_GRP_ROLE_MASTER.

MBG_IO_PORT_GRP_ROLE_MSK_SLAVE 

See MBG_IO_PORT_GRP_ROLE_SLAVE.

MBG_IO_PORT_GRP_ROLE_MSK_PASSIVE 

See MBG_IO_PORT_GRP_ROLE_PASSIVE.

Definition at line 20544 of file gpsdefs.h.

◆ MBG_IO_PORT_INFO_BITS

Enumerator
MBG_IO_PORT_INFO_BIT_IS_ALIGNED 

Indicates, that this port shall be optically aligned to MBG_IO_PORT_INFO::align_rule_idx.

Definition at line 20776 of file gpsdefs.h.

◆ MBG_IO_PORT_INFO_MASKS

Enumerator
MBG_IO_PORT_INFO_MASK_IS_ALIGNED 

see MBG_IO_PORT_INFO_BIT_IS_ALIGNED

Definition at line 20782 of file gpsdefs.h.

◆ MBG_IO_PORT_MSKS

Enumerator
MBG_IO_PORT_MSK_HORIZONTAL_LAYOUT 

See MBG_IO_PORT_FLAG_HORIZONTAL_LAYOUT.

MBG_IO_PORT_MSK_FRONT_PORTS 

See MBG_IO_PORT_FLAG_FRONT_PORTS.

MBG_IO_PORT_MSK_REAR_PORTS 

See MBG_IO_PORT_FLAG_REAR_PORTS.

MBG_IO_PORT_MSK_NO_LABEL 

See MBG_IO_PORT_FLAG_REAR_PORTS.

MBG_IO_PORT_MSK_NO_GRASP 

See MBG_IO_PORT_FLAG_NO_GRASP.

Definition at line 20340 of file gpsdefs.h.

◆ MBG_IO_PORT_OP_MODE_BITS

Port Operation Bits.

Used with MBG_IO_PORT_SETTINGS::op_mode

For now, there is a per port operation mode setting which is quite equal to ENABLE_FLAGS.

See also
MBG_IO_PORT_OP_MODE_MSKS
Enumerator
MBG_IO_PORT_OP_MODE_NONE 

Current mode cannot be determined.

MBG_IO_PORT_OP_MODE_DISABLED 

Disabled port.

MBG_IO_PORT_OP_MODE_ALWAYS 

Always enable port.

MBG_IO_PORT_OP_MODE_IF_SYNC_ONLY 

Enable port if sync only.

MBG_IO_PORT_OP_MODE_AFTER_SYNC 

Always enable port after being sync once.

MBG_IO_PORT_OP_MODE_ENABLED 

Enabled.

MBG_IO_PORT_OP_MODE_PASSTHROUGH 

Forwarded signals from backplane (e.g. PPS of BPE)

N_MBG_IO_PORT_OP_MODE_BITS 

Definition at line 20452 of file gpsdefs.h.

◆ MBG_IO_PORT_OP_MODE_MSKS

Masks for MBG_IO_PORT_OP_MODE_BITS.

Used with MBG_IO_PORT_INFO::supp_op_modes

See also
MBG_IO_PORT_OP_MODE_BITS
Enumerator
MBG_IO_PORT_OP_MODE_MSK_DISABLED 

See MBG_IO_PORT_OP_MODE_DISABLED.

MBG_IO_PORT_OP_MODE_MSK_ALWAYS 

See MBG_IO_PORT_OP_MODE_ALWAYS.

MBG_IO_PORT_OP_MODE_MSK_IF_SYNC_ONLY 

See MBG_IO_PORT_OP_MODE_IF_SYNC_ONLY.

MBG_IO_PORT_OP_MODE_MSK_AFTER_SYNC 

See MBG_IO_PORT_OP_MODE_AFTER_SYNC.

MBG_IO_PORT_OP_MODE_MSK_ENABLED 

See MBG_IO_PORT_OP_MODE_ENABLED.

MBG_IO_PORT_OP_MODE_MSK_PASSTHROUGH 

See MBG_IO_PORT_OP_MODE_PASSTHROUGH.

Definition at line 20492 of file gpsdefs.h.

◆ MBG_IO_PORT_SHAPE_LEVELS

Enumeration of known signal shapes/levels.

Used to specify the signal shape/level of an I/O port.

See also
MBG_IO_PORT_SHAPE_LEVEL_STRS
Enumerator
MBG_IO_PORT_SHAPE_LEVEL_NONE 

Unknown or unspecified signal shape. Must be zero for backward compatibility.

MBG_IO_PORT_SHAPE_LEVEL_SINE 

Sine wave.

MBG_IO_PORT_SHAPE_LEVEL_SQUARE 

Square wave.

N_MBG_IO_PORT_SHAPE_LEVELS 

Number of known signal shapes.

Definition at line 20374 of file gpsdefs.h.

◆ MBG_IO_PORT_SRC_MSKS

Bit masks of Meinberg I/O port attitudes.

Used with MBG_IO_PORT_TYPE_INFO::supp_srcs

See also
MBG_IO_PORT_SRCS
Enumerator
MBG_IO_PORT_SRC_MSK_STATIC 

See MBG_IO_PORT_SRC_STATIC.

MBG_IO_PORT_SRC_MSK_LOCAL 

See MBG_IO_PORT_SRC_LOCAL.

MBG_IO_PORT_SRC_MSK_ASSOC_CLOCK 

See MBG_IO_PORT_SRC_ASSOC_CLOCK.

MBG_IO_PORT_SRC_MSK_ACTIVE_CLOCK 

See MBG_IO_PORT_SRC_ACTIVE_CLOCK.

MBG_IO_PORT_SRC_MSK_CLK1 

See MBG_IO_PORT_SRC_CLK1.

MBG_IO_PORT_SRC_MSK_CLK2 

See MBG_IO_PORT_SRC_CLK2.

MBG_IO_PORT_SRC_MSK_ARC 

See MBG_IO_PORT_SRC_ARC.

MBG_IO_PORT_SRC_MSK_OSC 

See MBG_IO_PORT_SRC_OSC.

MBG_IO_PORT_SRC_MSK_SYNCE 

See MBG_IO_PORT_SRC_SYNCE.

MBG_IO_PORT_SRC_MSK_SWITCH_CARD 

See MBG_IO_PORT_SRC_SWITCH_CARD.

MBG_IO_PORT_SRC_MSK_CONFIGURABLE 

See MBG_IO_PORT_SRC_CONFIGURABLE.

MBG_IO_PORT_SRC_MSK_EXTERNAL 

See MBG_IO_PORT_SRC_EXTERNAL.

Definition at line 20216 of file gpsdefs.h.

◆ MBG_IO_PORT_SRCS

Port type sources.

Configurable sources for an I/O port type

See also
MBG_IO_PORT_SRC_MSKS
Enumerator
MBG_IO_PORT_SRC_NONE 

Only use this for MBG_IO_PORT_SETTINGS::source if MBG_IO_PORT_SETTINGS::op_mode is MBG_IO_PORT_OP_MODE_NONE.

MBG_IO_PORT_SRC_STATIC 

Static, not configurable.

MBG_IO_PORT_SRC_LOCAL 

Locally generated, e.g. on (carrier) board.

MBG_IO_PORT_SRC_ASSOC_CLOCK 

Fixed (wired) clock from back plane (e.g. refclock 1 in M500 IMS)

MBG_IO_PORT_SRC_ACTIVE_CLOCK 

Switched clock from back plane (e.g. selected by RSC)

MBG_IO_PORT_SRC_CLK1 

Clock 1 fixed (CPU board only)

MBG_IO_PORT_SRC_CLK2 

Clock 2 fixed (CPU board only)

MBG_IO_PORT_SRC_ARC 

Any rate converter.

MBG_IO_PORT_SRC_OSC 

Oscillator.

MBG_IO_PORT_SRC_SYNCE 

SyncE.

MBG_IO_PORT_SRC_SWITCH_CARD 

Switch Card Unit fixed (SCU, RSC, ...)

MBG_IO_PORT_SRC_CONFIGURABLE 

configurable

MBG_IO_PORT_SRC_EXTERNAL 

external (e.g. for inputs)

N_MBG_IO_PORT_SRCS 

Definition at line 20165 of file gpsdefs.h.

◆ MBG_IO_PORT_STATUS_BITS

Port Type Status Bits.

Enumerator
MBG_IO_PORT_STATUS_BIT_DISABLED 

See MBG_IO_PORT_OP_MODE_DISABLED. Other bits should be 0 in this case.

MBG_IO_PORT_STATUS_BIT_CARRIER_DETECTED 

Port has physical carrier connection (e.g. BNC cable in BPE's case)

MBG_IO_PORT_STATUS_BIT_INPUT_SIGNAL_NEVER_AVAIL 

Input signal has NEVER been avail.

MBG_IO_PORT_STATUS_BIT_INPUT_SIGNAL_AVAIL 

Input signal is avail right now.

MBG_IO_PORT_STATUS_BIT_INPUT_SIGNAL_LOST 

Input signal is currently not avail, but has been avail before.

MBG_IO_PORT_STATUS_BIT_SHORT_CIRCUIT 

Short circuit.

MBG_IO_PORT_STATUS_BIT_LIGHT_RED 

LED shows red light.

MBG_IO_PORT_STATUS_BIT_LIGHT_GREEN 

LED shows green light.

MBG_IO_PORT_STATUS_BIT_LIGHT_BLUE 

LED shows blue light.

MBG_IO_PORT_STATUS_BIT_LIGHT_YELLOW 

LED shows yellow light.

N_MBG_IO_PORT_STATUS_BITS 

Definition at line 21071 of file gpsdefs.h.

◆ MBG_IO_PORT_TYPES

IO Port types.

Used with MBG_IO_PORT_TYPE_INFO::port_type and MBG_IO_PORT_SETTINGS::port_type

Enumerator
MBG_IO_PORT_TYPE_PPS 
MBG_IO_PORT_TYPE_10MHz 
MBG_IO_PORT_TYPE_2048KHz 
MBG_IO_PORT_TYPE_GPIO 
MBG_IO_PORT_TYPE_ETHERNET 
MBG_IO_PORT_TYPE_TERMINAL 
MBG_IO_PORT_TYPE_MULTI 
MBG_IO_PORT_TYPE_POUT 
MBG_IO_PORT_TYPE_SWITCH 
MBG_IO_PORT_TYPE_TIMECODE 

e.g. IRIG AM/DC, see MBG_IO_PORT_SHAPE_LEVELS

MBG_IO_PORT_TYPE_LIGHT 
MBG_IO_PORT_TYPE_ANTENNA 
MBG_IO_PORT_TYPE_UART 
MBG_IO_PORT_TYPE_DCF77 
MBG_IO_PORT_TYPE_POWER 
N_MBG_IO_PORT_TYPES 

Definition at line 20055 of file gpsdefs.h.