ezV24.h

Go to the documentation of this file.

/* -*- Mode: C -*-
 *
 * $Id: ezV24.h,v 1.7 2011/04/12 07:10:51 jdesch Exp $
 * -----------------------------------------------------------------------
 * Copyright  (c) 2001,02  Joerg Desch <jd@die-deschs.de>
 * -----------------------------------------------------------------------
 * PROJECT: ezV24 -- easy RS232/V24 access
 * MODULE.: EZV24.H:
 * AUTHOR.: Joerg Desch <jdesch@users.sourceforge.net>
 * -----------------------------------------------------------------------
 * DESCRIPTION:
 *
 * -----------------------------------------------------------------------
 * COMPILER-FLAGS:
 *
 * -----------------------------------------------------------------------
 */

#ifndef __EZV24_H__
#define __EZV24_H__ 1


#include <stdlib.h>                          /* we need size_t */

#ifdef __cplusplus
extern "C" {
#endif



/*+=========================================================================+*/
/*|                      CONSTANT AND MACRO DEFINITIONS                     |*/
/*`========================================================================='*/

/*  common constant declarations
 */
#define V24_SZ_PORTNAME 25                   /* max. length of the port name */


enum __EZV24_ERROR_CODES
{
    V24_E_OK=0,
    V24_E_ILLPARM,
    V24_E_ILLBAUD,
    V24_E_ILLDATASZ,
    V24_E_ILLPARITY,

    V24_E_ILLHANDLE,
    V24_E_ILLTIMEOUT,
    V24_E_CREATE_LOCK,
    V24_E_OPEN_LOCK,
    V24_E_KILL_LOCK,
    V24_E_WRITE_LOCK,

    V24_E_LOCK_EXIST,
    V24_E_NOMEM,
    V24_E_NULL_POINTER,
    V24_E_OPEN,
    V24_E_READ,
    V24_E_WRITE,
    V24_E_NOT_INIT,

    V24_E_NO_PROC_FILE,
    V24_E_NOT_IMPLEMENTED,
    V24_E_TIMEOUT,

    V24_E_DBG_MESSAGES=100,

    V24_E_DBG_STALE_LOCK
};

enum __EZV24_BAUDRATE
{
    V24_B0=0,                           
    V24_B50,                            
    V24_B75,                            
    V24_B110,                           
    V24_B134,                           
    V24_B150,                           
    V24_B200,                           
    V24_B300,                           
    V24_B600,                           
    V24_B1200,                          
    V24_B1800,                          
    V24_B2400,                          
    V24_B4800,                          
    V24_B9600,                          
    V24_B19200,                         
    V24_B38400,                         
    V24_B57600,                         
    V24_B115200,                        
    V24_NUM_BAUDRATES                   
};

enum __EZV24_DATASIZE
{
    V24_5BIT=0,                              
    V24_6BIT,                                
    V24_7BIT,                                
    V24_8BIT,                                
    V24_NUM_DATASIZES                        
};


enum __EZV24_PARITY_FLAGS
{
    V24_NONE=0,                              
    V24_EVEN,                                
    V24_ODD,                                 
    V24_IGNORE                               
};


enum __EZV24_OPEN_FLAGS
{
    V24_STANDARD    = 0x0000,                
    V24_LOCK        = 0x0001,                
    V24_NO_DELAY    = 0x0002,                
    V24_RTS_CTS     = 0x0004,                
    V24_XON_XOFF    = 0x0008,                
    V24_DROP_DTR    = 0x0010,                
    V24_NON_BLOCK   = 0x0020,                
    V24_SYNC        = 0x0040,                
    V24_DEBUG_ON    = 0x8000                 
};


enum __EZV24_STATUS_FLAGS
{
    V24_DSR_LOW=0,                           
    V24_DSR_HIGH,                            
    V24_CTS_LOW,                             
    V24_CTS_HIGH,                            
    V24_DSRCTS_UNKNOWN                       
};



/*+=========================================================================+*/
/*|                             TYPEDECLARATIONS                            |*/
/*`========================================================================='*/

struct __EZV24_PORT_HANDLE
{
        int fd;                              
        int Errno;                           
        int Locked;                          
        int lock_fd;                         
        int Initialized;                     
        char PortName[V24_SZ_PORTNAME+1];    
        unsigned int OpenFlags;              
        int Baudrate;                        
        int Datasize;                        
        int Parity;                          
        int TimeoutValue;                    
};

typedef struct __EZV24_PORT_HANDLE v24_port_t;

// typedef void (*v24_error_handler_t)
//     (const v24_port_t *port, const int Errno, const char* caller);


/*+=========================================================================+*/
/*|                            PUBLIC VARIABLES                             |*/
/*`========================================================================='*/

/*+=========================================================================+*/
/*|                     PROTOTYPES OF GLOBAL FUNCTIONS                      |*/
/*`========================================================================='*/



int v24CountPorts ( unsigned long* BitMask );


const char* v24PortName ( int PortNo, char* PortName );



v24_port_t* v24OpenPort ( const char* PortName, unsigned int OpenFlags );


int v24ClosePort ( v24_port_t *port );


int v24SetParameters ( v24_port_t *port, int Baudrate, int Datasize, int Parity );


int v24SetStopbits ( v24_port_t *port, int Stops );



int v24SetTimeouts ( v24_port_t *port, int TenthOfSeconds );


int v24Getc ( v24_port_t *port );


int v24Putc ( v24_port_t *port, unsigned char TheData );


int v24Read ( v24_port_t *port, unsigned char* Buffer, size_t Len );


int v24Write ( v24_port_t *port, const unsigned char* Buffer, size_t Len  );


int v24Gets ( v24_port_t *port, char* Buffer, size_t BuffSize );


int v24Puts ( v24_port_t *port, const char* Buffer );


int v24HaveData ( v24_port_t *port );


int v24FlushRxQueue ( v24_port_t *port );


int v24FlushTxQueue ( v24_port_t *port );


int v24SetDTR ( v24_port_t *port, int NewState );


int v24SetRTS (v24_port_t *port, int NewState );


int v24GetDSR ( v24_port_t *port, int *CurrState );


int v24GetCTS (v24_port_t *port, int *CurrState );


const char* v24QueryPortName ( v24_port_t *port );


int v24QueryFileHandle ( v24_port_t *port );


int v24QueryErrno ( v24_port_t *port );



#ifdef __cplusplus
};
#endif

#endif
/* ==[End of file]========================================================== */

---