toolutil.h

Go to the documentation of this file.

/**************************************************************************
 *
 *  $Id: toolutil.h 1.8 2019/03/13 09:44:57 martin REL_M $
 *
 *  Copyright (c) Meinberg Funkuhren, Bad Pyrmont, Germany
 *
 *  Description:
 *    Definitions and prototypes for toolutil.c.
 *
 * -----------------------------------------------------------------------
 *  $Log: toolutil.h $
 *  Revision 1.8  2019/03/13 09:44:57  martin
 *  Moved predefined program exit codes to mbgerror.h.
 *  Revision 1.7  2018/12/14 13:14:52  martin
 *  Updated function prototypes.
 *  Revision 1.6  2018/11/15 12:21:10  martin
 *  Updated function prototypes.
 *  Revision 1.5  2018/06/25 13:47:45  martin
 *  Updated function prototypes.
 *  Revision 1.4  2017/07/05 07:38:06  martin
 *  Support Windows target.
 *  Defined function type MBG_DEV_HANDLER_FNC.
 *  Defined some OS-specific strings e.g. for example
 *  file and device names used in help messages.
 *  Check for MBG_TGT_POSIX instead of MBG_TGT_UNIX.
 *  Doxygen comments.
 *  Updated function prototypes.
 *  Revision 1.3  2012/10/15 09:36:22  martin
 *  Use common way to handle version information.
 *  Added string table with PZF state names.
 *  Updated function prototypes.
 *  Revision 1.2  2009/06/19 12:11:35  martin
 *  Updated function prototypes.
 *  Revision 1.1  2008/12/17 10:45:14  martin
 *  Initial revision.
 *  Revision 1.1  2008/12/15 08:35:08  martin
 *  Initial revision.
 *
 **************************************************************************/

#ifndef _TOOLUTIL_H
#define _TOOLUTIL_H


/* Other headers to be included */

#include <mbgdevio.h>
#include <mbgversion.h>

#if defined( MBG_TGT_POSIX )

  #include <unistd.h>

#elif defined( MBG_TGT_WIN32 )

  #include <io.h>
  #include <fcntl.h>
  #include <sys/types.h>
  #include <sys/stat.h>
  #include <wingetopt.h>

  #define open          _open
  #define snprintf      _snprintf
  #define sleep( _x )   Sleep( (_x) * 1000 )
  #define usleep( _x )  Sleep( (_x) / 1000 )

#endif



#ifdef _TOOLUTIL
 #define _ext
 #define _DO_INIT
#else
 #define _ext extern
#endif


/* Start of header body */

#ifdef __cplusplus
extern "C" {
#endif


enum CHK_DEV_FLAGS
{
  CHK_DEV_ALL_DEVICES = 0x0001,   
  CHK_DEV_WITHOUT_DEV = 0x0002    
};



#if MBG_TGT_HAS_DEV_FN
  #define EXAMPLE_DEV_FN_1      MBGCLOCK_DEV_FN_BASE "0"
  #define EXAMPLE_DEV_FN_1_TCR  EXAMPLE_DEV_FN_1
  #define EXAMPLE_DEV_FN_2      MBGCLOCK_DEV_FN_BASE "3"
#endif

#define EXAMPLE_DEV_NAME_1      "gps180pex"
#define EXAMPLE_DEV_NAME_1_TCR  "tcr167pci"
#define EXAMPLE_DEV_NAME_2      "tcr170pex_027911002000"


#if defined( MBG_TGT_POSIX )
  #define ROOT_PRIVILEGES_STR        "with root privileges"
#else
  #define ROOT_PRIVILEGES_STR        "as administrator"
#endif


#if !defined( MBG_EXP_YEAR_LIMIT )
  #define MBG_EXP_YEAR_LIMIT   1980
#endif


_ext uint16_t mbg_exp_year_limit
#ifdef _DO_INIT
 = MBG_EXP_YEAR_LIMIT
#endif
;

_ext int must_print_usage;

_ext const char str_empty[]
#ifdef _DO_INIT
 = ""
#endif
;


_ext const char *pzf_corr_state_name[N_PZF_CORR_STATE]
#ifdef _DO_INIT
 = PZF_CORR_STATE_NAMES_ENG
#endif
;



typedef int MBG_DEV_HANDLER_FNC( MBG_DEV_HANDLE, const PCPS_DEV *);



/* ----- function prototypes begin ----- */

/* This section was generated automatically */
/* by MAKEHDR, do not remove the comments. */

 int mbg_program_version_str( char *s, size_t max_len ) ;

 int mbg_program_info_str( char *s, size_t max_len, const char *pname, int first_year, int last_year ) ;

 void mbg_print_program_info( const char *pname, int first_year, int last_year ) ;

 void mbg_print_usage_intro( const char *pname, const char *info ) ;

 void mbg_print_opt_info( const char *opt_name, const char *opt_info ) ;

 void mbg_print_help_options( void ) ;

 void mbg_print_device_options( void ) ;

 void mbg_print_default_usage( const char *pname, const char *prog_info ) ;

 int mbg_get_show_dev_info( MBG_DEV_HANDLE dh, const char *dev_name, PCPS_DEV *p_dev ) ;

 int mbg_handle_device( MBG_DEV_HANDLE dh, const char *dev_name, MBG_DEV_HANDLER_FNC *fnc ) ;

 int chk_get_num_devices( void ) ;

 int mbg_open_device_by_param( MBG_DEV_HANDLE *p_dh, const char *dev_param_str, int dev_idx, char *dev_name_buffer, size_t dev_name_buffer_size ) ;

 int mbg_open_device_by_param_chk( MBG_DEV_HANDLE *p_dh, const char *dev_param_str, int dev_idx, char *dev_name_buffer, size_t dev_name_buffer_size ) ;

 int mbg_handle_devices( int argc, char *argv[], int optind, MBG_DEV_HANDLER_FNC *fnc, int chk_dev_flags ) ;

 int mbg_snprint_date_time( char *s, size_t max_len, const PCPS_TIME *p, int verbose ) ;

 int mbg_snprint_hr_tstamp( char *s, size_t max_len, const PCPS_TIME_STAMP *p, long utc_offs, int show_raw ) ;

 int mbg_snprint_hr_time( char *s, size_t max_len, const PCPS_HR_TIME *p, int show_raw ) ;

 void mbg_print_hr_timestamp( PCPS_TIME_STAMP *p_ts, int32_t hns_latency, PCPS_TIME_STAMP *p_prv_ts, int no_latency, int show_raw ) ;

 void mbg_print_hr_time( PCPS_HR_TIME *p_ht, int32_t hns_latency, PCPS_TIME_STAMP *p_prv_ts, int no_latency, int show_raw, int verbose ) ;

 int mbg_show_pzf_corr_info( MBG_DEV_HANDLE dh, int show_corr_step ) ;

 int mbg_get_gps_gnss_mode_info_chk( MBG_DEV_HANDLE dh, MBG_GNSS_MODE_INFO *p ) ;


/* ----- function prototypes end ----- */


#ifdef __cplusplus
}
#endif


/* End of header body */

#undef _ext
#undef _DO_INIT

#endif  /* _TOOLUTIL_H */