/*
    io_serial.h
    Serial port input/output definitions

    This file is part of the Unix driver for Towitoko smartcard readers
    Copyright (C) 2000 Carlos Prados <cprados@yahoo.com>

    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Lesser General Public
    License as published by the Free Software Foundation; either
    version 2 of the License, or (at your option) any later version.

    This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Lesser General Public License for more details.

    You should have received a copy of the GNU Lesser General Public
    License along with this library; if not, write to the Free Software
    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
*/

#ifndef _IO_SERIAL_
#define _IO_SERIAL_

#include "defines.h"

/* 
 * Exported constants definition
 */

/* Type of parity of the serial device */
#define IO_SERIAL_PARITY_ODD		1
#define IO_SERIAL_PARITY_EVEN		2
#define IO_SERIAL_PARITY_NONE		3

/* Values for the modem lines */
#define IO_SERIAL_HIGH			1
#define IO_SERIAL_LOW			0

/* Maximum size of PnP Com ID */
#define IO_SERIAL_PNPID_SIZE 		256

/*
 * Exported datatypes definition
 */

/* Settings than can be modified to the serial device */
typedef struct
{
  unsigned long input_bitrate;
  unsigned long  output_bitrate;
  unsigned bits;
  unsigned stopbits;
  int parity;
  int dtr;
  int rts;
}
IO_Serial_Properties;

/* IO_Serial exported datatype */
typedef struct
{
  int fd;				/* Handle of the serial device */
  IO_Serial_Properties * props;
  unsigned com;				/* Com port number (1..4) */
  BYTE PnP_id[IO_SERIAL_PNPID_SIZE];	/* PnP Id of the serial device */
  unsigned PnP_id_size;			/* Length of PnP Id */
  bool usbserial;			/* Is serial USB device */
}
IO_Serial;

/* 
 * Exported functions declaration
 */

/* IO_Serial creation and deletion */
extern IO_Serial *IO_Serial_New (void);
extern void IO_Serial_Delete (IO_Serial * io);

/* Initialization and closing */
extern bool IO_Serial_Init (IO_Serial * io, unsigned com, bool usbserial, bool pnp);
extern bool IO_Serial_Close (IO_Serial * io);

/* Transmission properties */
extern bool IO_Serial_SetProperties (IO_Serial * io, IO_Serial_Properties * props);
extern bool IO_Serial_GetProperties (IO_Serial * io, IO_Serial_Properties * props);

/* Input and output */
extern bool IO_Serial_Read (IO_Serial * io, unsigned timeout, unsigned size, BYTE * data);
extern bool IO_Serial_Write (IO_Serial * io, unsigned delay, unsigned size, BYTE * data);

/* Serial port atributes */
extern unsigned IO_Serial_GetCom (IO_Serial * io);
extern void IO_Serial_GetPnPId (IO_Serial * io, BYTE * pnp_id, unsigned *length);

#endif /* IO_SERIAL */