mbgserio.h

Go to the documentation of this file.

/**************************************************************************
 *
 *  $Id: mbgserio.h 1.8.1.1 2018/05/29 08:18:56 martin TRASH $
 *
 *  Copyright (c) Meinberg Funkuhren, Bad Pyrmont, Germany
 *
 *  Description:
 *    Definitions and prototypes for mbgserio.c.
 *
 * -----------------------------------------------------------------------
 *  $Log: mbgserio.h $
 *  Revision 1.8.1.1  2018/05/29 08:18:56  martin
 *  Removed conditional _USE_MBG_TSTR stuff.
 *  Revision 1.8  2017/07/06 07:41:00  martin
 *  Renamed SERIAL_IO_STATUS to MBGSERIO_DEV,
 *  and renamed some fields of the structure.
 *  Defined default device names for serial ports
 *  depending on the target system.
 *  Check preprocessor symbol _USE_MBG_TSTR instead
 *  of _USE_CHK_TSTR.
 *  Check for MBG_TGT_POSIX instead of MBG_TGT_UNIX.
 *  Updated function prototypes.
 *  Revision 1.7  2013/02/01 16:10:45  martin
 *  Got rid of _mbg_open/close/read/write() macros.
 *  Functions are now used instead.
 *  Updated function prototypes.
 *  Revision 1.6  2011/08/23 10:15:25Z  martin
 *  Updated function prototypes.
 *  Revision 1.5  2011/08/04 09:48:55  martin
 *  Support flushing output.
 *  Re-ordered some definitions.
 *  Revision 1.4  2009/09/01 10:54:29  martin
 *  Include mbg_tmo.h for the new portable timeout functions.
 *  Added symbols for return codes in case of an error.
 *  Code cleanup.
 *  Revision 1.3  2009/04/01 14:17:31  martin
 *  Cleanup for CVI.
 *  Revision 1.2  2008/09/04 15:11:36Z  martin
 *  Preliminary support for device lists.
 *  Updated function prototypes.
 *  Revision 1.1  2007/11/12 16:48:02  martin
 *  Initial revision.
 *
 **************************************************************************/

#ifndef _MBGSERIO_H
#define _MBGSERIO_H


/* Other headers to be included */

#include <mbg_tgt.h>
#include <mbg_tmo.h>
#include <mbgerror.h>

#include <stdlib.h>
#include <string.h>

#if defined( MBG_TGT_POSIX )
  #include <termios.h>
#endif

#if !defined( _USE_SELECT_FOR_SERIAL_IO )
  #if defined( MBG_TGT_POSIX )
    #define _USE_SELECT_FOR_SERIAL_IO  1
  #else
    #define _USE_SELECT_FOR_SERIAL_IO  0
  #endif
#endif


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


/* Start of header body */

#ifdef __cplusplus
extern "C" {
#endif

#if !defined( DEFAULT_SERIAL_DEVICE_NAME )
  // For applications which 2 serial ports we also define
  // default names for the second port to be used.
  #if defined( MBG_TGT_WIN32 ) || defined( MBG_TGT_DOS )
    #define DEFAULT_SERIAL_DEVICE_NAME   "COM1"
    #define DEFAULT_SERIAL_DEVICE_NAME_2 "COM2"
  #elif defined( MBG_TGT_LINUX )
    #define DEFAULT_SERIAL_DEVICE_NAME   "/dev/ttyS0"
    #define DEFAULT_SERIAL_DEVICE_NAME_2 "/dev/ttyS1"
  #elif defined( MBG_TGT_FREEBSD )
    // Call-in ports are named /dev/ttyuN where N is the port number, starting from zero.
    // Generally, the call-in port is used for terminals. Call-in ports require that
    // the serial line assert the "Data Carrier Detect" signal to work correctly.
    // Call-out ports are named /dev/cuauN on FreeBSD versions 8.X and higher
    // and /dev/cuadN on FreeBSD versions 7.X and lower. Call-out ports are usually
    // not used for terminals, but are used for modems. The call-out port can be used if
    // the serial cable or the terminal does not support the "Data Carrier Detect" signal.
    #if ( __FreeBSD__ > 7 )
      #define DEFAULT_SERIAL_DEVICE_NAME   "/dev/cuau0"
      #define DEFAULT_SERIAL_DEVICE_NAME_2 "/dev/cuau1"
    #else
      #define DEFAULT_SERIAL_DEVICE_NAME   "/dev/cuad0"
      #define DEFAULT_SERIAL_DEVICE_NAME_2 "/dev/cuad1"
    #endif
  #elif defined( MBG_TGT_NETBSD )
    // The ttyXX devices are traditional dial-in devices;
    // the dtyXX devices are used for dial-out. See tty(4).
    #define DEFAULT_SERIAL_DEVICE_NAME   "/dev/dty00"
    #define DEFAULT_SERIAL_DEVICE_NAME_2 "/dev/dty01"
  #else
    #error DEFAULT_SERIAL_DEVICE_NAME needs to be defined for this target.
  #endif
#endif


/*
 * The following macros control parts of the build process.
 * The default values are suitable for most cases but can be
 * overridden by global definitions, if required.
 */

#if _IS_MBG_FIRMWARE

  // This handle type in not used by the firmware.
  // However, we define it to avoid build errors.
  typedef int MBG_HANDLE;

#else

  #if defined( MBG_TGT_CVI )

    #include <rs232.h>

  #elif defined( MBG_TGT_WIN32 )

    #include <io.h>

  #elif defined( MBG_TGT_DOS )

    #if defined( _USE_V24TOOLS )
      #include <v24tools.h>
    #endif

  #endif

#endif



typedef struct _MBG_STR_LIST
{
  char *s;
  struct _MBG_STR_LIST *next;

} MBG_STR_LIST;



typedef struct
{
  MBG_PORT_HANDLE port_handle;   

  ulong poll_timeout;            

  #if defined( MBG_TGT_WIN32 )
    DCB org_dcb;
    int org_dcb_has_been_read;

    COMMTIMEOUTS org_commtimeouts;
    int org_commtimeouts_have_been_read;

    COMMPROP comm_prop;          
    int comm_prop_have_been_read;
  #endif

  #if defined( MBG_TGT_POSIX )
    struct termios org_tio;      
    int org_tio_has_been_read;
  #endif

} MBGSERIO_DEV;



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

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

 _NO_MBG_API_ATTR int _MBG_API mbgserio_close( MBGSERIO_DEV **pp_mdev ) ;

 _NO_MBG_API_ATTR int _MBG_API mbgserio_open( MBGSERIO_DEV **pp_mdev, const char *dev_name ) ;

 _NO_MBG_API_ATTR int _MBG_API mbgserio_setup_port_str_list( MBG_STR_LIST **list, int max_devs ) ;
 _NO_MBG_API_ATTR void _MBG_API mbgserio_free_str_list( MBG_STR_LIST *list ) ;
 _NO_MBG_API_ATTR int _MBG_API mbgserio_set_parms( MBGSERIO_DEV *mdev, uint32_t baud_rate, const char *framing ) ;

 _NO_MBG_API_ATTR int _MBG_API mbgserio_read( MBGSERIO_DEV *mdev, void *buffer, unsigned int count ) ;
 _NO_MBG_API_ATTR int _MBG_API mbgserio_write( MBGSERIO_DEV *mdev, const void *buffer, unsigned int count ) ;
 _NO_MBG_API_ATTR void _MBG_API mbgserio_flush_tx( MBGSERIO_DEV *mdev ) ;
 _NO_MBG_API_ATTR int _MBG_API mbgserio_read_wait( MBGSERIO_DEV *mdev, void *buffer, uint count ) ;

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

#ifdef __cplusplus
}
#endif

/* End of header body */

#undef _ext
#undef _DO_INIT

#endif  /* _MBGSERIO_H */