include/sysio/serial.h

#ifndef _SYSIO_SERIAL_H_
#define _SYSIO_SERIAL_H_
#include <termios.h>
#include <sysio/defs.h>

#ifdef __cplusplus
  extern "C" {
#endif
/* ========================================================================== */

#define EBADBAUD (-2)

typedef enum {
  SERIAL_DATABIT_5 = 5,
  SERIAL_DATABIT_6 = 6,
  SERIAL_DATABIT_7 = 7,
  SERIAL_DATABIT_8 = 8,
  SERIAL_DATABIT_UNKNOWN = -1
} eSerialDataBits;

typedef enum {
  SERIAL_PARITY_NONE = 'N',
  SERIAL_PARITY_EVEN = 'E',
  SERIAL_PARITY_ODD  = 'O',
  SERIAL_PARITY_SPACE = 'S',
  SERIAL_PARITY_MARK = 'M',
  SERIAL_PARITY_UNKNOWN = -1
} eSerialParity;

typedef enum {
  SERIAL_STOPBIT_ONE = 1,
  SERIAL_STOPBIT_TWO = 2,
  SERIAL_STOPBIT_ONEHALF = 3,
  SERIAL_STOPBIT_UNKNOWN
} eSerialStopBits;

typedef enum {

  SERIAL_FLOW_NONE = ' ', 
  SERIAL_FLOW_RTSCTS = 'H', 
  SERIAL_FLOW_XONXOFF = 'S', 
  SERIAL_FLOW_RS485_RTS_AFTER_SEND = 'R', 
  SERIAL_FLOW_RS485_RTS_ON_SEND = 'r', 
  SERIAL_FLOW_UNKNOWN = -1
} eSerialFlow;

/* structures =============================================================== */
typedef struct xSerialIos {
  long baud; 
  eSerialDataBits dbits; 
  eSerialParity parity; 
  eSerialStopBits sbits;
  eSerialFlow flow;
  int flag; 
} xSerialIos;

/* internal public functions ================================================ */

int iSerialOpen (const char *device, xSerialIos * xIos);


void vSerialClose (int fd);

void vSerialFlush (int fd);

int iSerialDataAvailable (int fd);

int iSerialPoll (int fd, int timeout_ms);

int iSerialSetAttr (int fd, const xSerialIos * xIos);

int iSerialGetAttr (int fd, xSerialIos * xIos);

const char * sSerialAttrToStr (const xSerialIos * xIos);

bool bSerialFdIsValid (int fd);

int iSerialGetBaudrate (int fd);

eSerialDataBits eSerialGetDataBits (int fd);

eSerialParity eSerialGetParity (int fd);

eSerialStopBits eSerialGetStopBits (int fd);

eSerialFlow eSerialGetFlow (int fd);

int iSerialSetBaudrate (int fd, int iBaudrate);

int iSerialSetDataBits (int fd, eSerialDataBits eDataBits);

int iSerialSetParity (int fd, eSerialParity eParity);

int iSerialSetStopBits (int fd, eSerialStopBits eStopBits);

int iSerialSetFlow (int fd, eSerialFlow eNewFlow);

const char * sSerialGetFlowStr (int fd);

const char * sSerialAttrStr (int fd);

int iSerialTermiosSetAttr (struct termios * ts, const xSerialIos * xIos);

int iSerialTermiosGetAttr (const struct termios * ts, xSerialIos * xIos);

int iSerialTermiosSetBaudrate (struct termios * ts, int iBaudrate);

int iSerialTermiosSetDataBits (struct termios * ts, eSerialDataBits eDataBits);

int iSerialTermiosSetParity (struct termios * ts, eSerialParity eParity);

int iSerialTermiosSetStopBits (struct termios * ts, eSerialStopBits eStopBits);

int iSerialTermiosSetFlow (struct termios * ts, eSerialFlow eFlow);

int iSerialTermiosGetBaudrate (const struct termios * ts);

int iSerialTermiosGetDataBits (const struct termios * ts);

int iSerialTermiosGetStopBits (const struct termios * ts);

int iSerialTermiosGetParity (const struct termios * ts);

int iSerialTermiosGetFlow (const struct termios * ts);

const char * sSerialTermiosToStr (const struct termios * ts);

double dSerialTermiosFrameDuration (const struct termios * ts, size_t ulSize);

const char * sSerialFlowToStr (eSerialFlow eFlow);

const char * sSerialParityToStr (eSerialParity eParity);

const char * sSerialDataBitsToStr (eSerialDataBits eDataBits);

const char * sSerialStopBitsToStr (eSerialStopBits eStopBits);

int iSerialSpeedToInt (speed_t speed);

speed_t eSerialIntToSpeed (int baud);

double dSerialFrameDuration (int fd, size_t ulSize);

/* ========================================================================== */
#ifdef __cplusplus
  }
#endif
#endif /* _SYSIO_SERIAL_H_ */