[libserialport.git] / libserialport.h.in

/*
 * This file is part of the libserialport project.
 *
 * Copyright (C) 2013 Martin Ling <martin-libserialport@earth.li>
 *
 * This program 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 3 of the
 * License, or (at your option) any later version.
 *
 * This program 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 General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef LIBSERIALPORT_H
#define LIBSERIALPORT_H

#ifdef __cplusplus
extern "C" {
#endif

#include <stddef.h>
#ifdef _WIN32
#include <windows.h>
#endif

/* Package version macros (e.g. for conditional compilation). */
#define SP_PACKAGE_VERSION_MAJOR @SP_PACKAGE_VERSION_MAJOR@
#define SP_PACKAGE_VERSION_MINOR @SP_PACKAGE_VERSION_MINOR@
#define SP_PACKAGE_VERSION_STRING "@SP_PACKAGE_VERSION@"

/* Library/libtool version macros (e.g. for conditional compilation). */
#define SP_LIB_VERSION_CURRENT @SP_LIB_VERSION_CURRENT@
#define SP_LIB_VERSION_REVISION @SP_LIB_VERSION_REVISION@
#define SP_LIB_VERSION_AGE @SP_LIB_VERSION_AGE@
#define SP_LIB_VERSION_STRING "@SP_LIB_VERSION@"

/* A serial port. */
struct sp_port {
	/* Name used to open the port */
	char *name;
	/* OS-specific port handle */
#ifdef _WIN32
	HANDLE hdl;
#else
	int fd;
#endif
};

/* Configuration for a serial port. */
struct sp_port_config {
	int baudrate;
	int bits;
	int parity;
	int stopbits;
	int flowcontrol;
	int rts;
	int cts;
	int dtr;
	int dsr;
	int xon_xoff;
};

/* Return values. */
enum {
	/* Operation completed successfully. */
	SP_OK = 0,
	/* Invalid arguments were passed to the function. */
	SP_ERR_ARG = -1,
	/* A system error occured while executing the operation. */
	SP_ERR_FAIL = -2,
	/* A memory allocation failed while executing the operation. */
	SP_ERR_MEM = -3,
};

/* Port access modes. */
enum {
	/* Open port for read/write access. */
	SP_MODE_RDWR = 1,
	/* Open port for read access only. */
	SP_MODE_RDONLY = 2,
	/* Open port in non-blocking mode. */
	SP_MODE_NONBLOCK = 4,
};

/* Parity settings. */
enum {
	/* No parity. */
	SP_PARITY_NONE = 0,
	/* Even parity. */
	SP_PARITY_EVEN = 1,
	/* Odd parity. */
	SP_PARITY_ODD = 2,
};

/* RTS pin behaviour. */
enum {
	SP_RTS_OFF = 0,
	SP_RTS_ON = 1,
	SP_RTS_FLOW_CONTROL = 2
};

/* CTS pin behaviour. */
enum {
	SP_CTS_IGNORE = 0,
	SP_CTS_FLOW_CONTROL = 1
};

/* DTR pin behaviour. */
enum {
	SP_DTR_OFF = 0,
	SP_DTR_ON = 1,
	SP_DTR_FLOW_CONTROL = 2
};

/* DSR pin behaviour. */
enum {
	SP_DSR_IGNORE = 0,
	SP_DSR_FLOW_CONTROL = 1
};

/* XON/XOFF flow control behaviour. */
enum {
	SP_XONXOFF_DISABLED = 0,
	SP_XONXOFF_IN = 1,
	SP_XONXOFF_OUT = 2,
	SP_XONXOFF_INOUT = 3
};

/* Enumeration */
int sp_get_port_by_name(const char *portname, struct sp_port **port_ptr);
void sp_free_port(struct sp_port *port);
int sp_list_ports(struct sp_port ***list_ptr);
int sp_copy_port(const struct sp_port *port, struct sp_port **copy_ptr);
void sp_free_port_list(struct sp_port **ports);

/* Opening & closing ports */
int sp_open(struct sp_port *port, int flags);
int sp_close(struct sp_port *port);

/* Reading, writing and flushing. */
int sp_read(struct sp_port *port, void *buf, size_t count);
int sp_write(struct sp_port *port, const void *buf, size_t count);
int sp_flush(struct sp_port *port);

/* Port configuration */
int sp_set_config(struct sp_port *port, struct sp_port_config *config);
int sp_set_baudrate(struct sp_port *port, int baudrate);
int sp_set_bits(struct sp_port *port, int bits);
int sp_set_parity(struct sp_port *port, int parity);
int sp_set_stopbits(struct sp_port *port, int stopbits);
int sp_set_rts(struct sp_port *port, int rts);
int sp_set_cts(struct sp_port *port, int cts);
int sp_set_dtr(struct sp_port *port, int dtr);
int sp_set_dsr(struct sp_port *port, int dsr);
int sp_set_xon_xoff(struct sp_port *port, int xon_xoff);

/* Error handling */
int sp_last_error_code(void);
char *sp_last_error_message(void);
void sp_free_error_message(char *message);

#ifdef __cplusplus
}
#endif

#endif /* LIBSERIALPORT_H */
Commit	Line	Data
	1	/*
	2	* This file is part of the libserialport project.
	3	*
	4	* Copyright (C) 2013 Martin Ling <martin-libserialport@earth.li>
	5	*
	6	* This program is free software: you can redistribute it and/or modify
	7	* it under the terms of the GNU Lesser General Public License as
	8	* published by the Free Software Foundation, either version 3 of the
	9	* License, or (at your option) any later version.
	10	*
	11	* This program is distributed in the hope that it will be useful,
	12	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	13	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	14	* GNU General Public License for more details.
	15	*
	16	* You should have received a copy of the GNU Lesser General Public License
	17	* along with this program. If not, see <http://www.gnu.org/licenses/>.
	18	*/
	19
	20	#ifndef LIBSERIALPORT_H
	21	#define LIBSERIALPORT_H
	22
	23	#ifdef __cplusplus
	24	extern "C" {
	25	#endif
	26
	27	#include <stddef.h>
	28	#ifdef _WIN32
	29	#include <windows.h>
	30	#endif
	31
	32	/* Package version macros (e.g. for conditional compilation). */
	33	#define SP_PACKAGE_VERSION_MAJOR @SP_PACKAGE_VERSION_MAJOR@
	34	#define SP_PACKAGE_VERSION_MINOR @SP_PACKAGE_VERSION_MINOR@
	35	#define SP_PACKAGE_VERSION_STRING "@SP_PACKAGE_VERSION@"
	36
	37	/* Library/libtool version macros (e.g. for conditional compilation). */
	38	#define SP_LIB_VERSION_CURRENT @SP_LIB_VERSION_CURRENT@
	39	#define SP_LIB_VERSION_REVISION @SP_LIB_VERSION_REVISION@
	40	#define SP_LIB_VERSION_AGE @SP_LIB_VERSION_AGE@
	41	#define SP_LIB_VERSION_STRING "@SP_LIB_VERSION@"
	42
	43	/* A serial port. */
	44	struct sp_port {
	45	/* Name used to open the port */
	46	char *name;
	47	/* OS-specific port handle */
	48	#ifdef _WIN32
	49	HANDLE hdl;
	50	#else
	51	int fd;
	52	#endif
	53	};
	54
	55	/* Configuration for a serial port. */
	56	struct sp_port_config {
	57	int baudrate;
	58	int bits;
	59	int parity;
	60	int stopbits;
	61	int flowcontrol;
	62	int rts;
	63	int cts;
	64	int dtr;
	65	int dsr;
	66	int xon_xoff;
	67	};
	68
	69	/* Return values. */
	70	enum {
	71	/* Operation completed successfully. */
	72	SP_OK = 0,
	73	/* Invalid arguments were passed to the function. */
	74	SP_ERR_ARG = -1,
	75	/* A system error occured while executing the operation. */
	76	SP_ERR_FAIL = -2,
	77	/* A memory allocation failed while executing the operation. */
	78	SP_ERR_MEM = -3,
	79	};
	80
	81	/* Port access modes. */
	82	enum {
	83	/* Open port for read/write access. */
	84	SP_MODE_RDWR = 1,
	85	/* Open port for read access only. */
	86	SP_MODE_RDONLY = 2,
	87	/* Open port in non-blocking mode. */
	88	SP_MODE_NONBLOCK = 4,
	89	};
	90
	91	/* Parity settings. */
	92	enum {
	93	/* No parity. */
	94	SP_PARITY_NONE = 0,
	95	/* Even parity. */
	96	SP_PARITY_EVEN = 1,
	97	/* Odd parity. */
	98	SP_PARITY_ODD = 2,
	99	};
	100
	101	/* RTS pin behaviour. */
	102	enum {
	103	SP_RTS_OFF = 0,
	104	SP_RTS_ON = 1,
	105	SP_RTS_FLOW_CONTROL = 2
	106	};
	107
	108	/* CTS pin behaviour. */
	109	enum {
	110	SP_CTS_IGNORE = 0,
	111	SP_CTS_FLOW_CONTROL = 1
	112	};
	113
	114	/* DTR pin behaviour. */
	115	enum {
	116	SP_DTR_OFF = 0,
	117	SP_DTR_ON = 1,
	118	SP_DTR_FLOW_CONTROL = 2
	119	};
	120
	121	/* DSR pin behaviour. */
	122	enum {
	123	SP_DSR_IGNORE = 0,
	124	SP_DSR_FLOW_CONTROL = 1
	125	};
	126
	127	/* XON/XOFF flow control behaviour. */
	128	enum {
	129	SP_XONXOFF_DISABLED = 0,
	130	SP_XONXOFF_IN = 1,
	131	SP_XONXOFF_OUT = 2,
	132	SP_XONXOFF_INOUT = 3
	133	};
	134
	135	/* Enumeration */
	136	int sp_get_port_by_name(const char portname, struct sp_port *port_ptr);
	137	void sp_free_port(struct sp_port *port);
	138	int sp_list_ports(struct sp_port ***list_ptr);
	139	int sp_copy_port(const struct sp_port port, struct sp_port *copy_ptr);
	140	void sp_free_port_list(struct sp_port **ports);
	141
	142	/* Opening & closing ports */
	143	int sp_open(struct sp_port *port, int flags);
	144	int sp_close(struct sp_port *port);
	145
	146	/* Reading, writing and flushing. */
	147	int sp_read(struct sp_port port, void buf, size_t count);
	148	int sp_write(struct sp_port port, const void buf, size_t count);
	149	int sp_flush(struct sp_port *port);
	150
	151	/* Port configuration */
	152	int sp_set_config(struct sp_port port, struct sp_port_config config);
	153	int sp_set_baudrate(struct sp_port *port, int baudrate);
	154	int sp_set_bits(struct sp_port *port, int bits);
	155	int sp_set_parity(struct sp_port *port, int parity);
	156	int sp_set_stopbits(struct sp_port *port, int stopbits);
	157	int sp_set_rts(struct sp_port *port, int rts);
	158	int sp_set_cts(struct sp_port *port, int cts);
	159	int sp_set_dtr(struct sp_port *port, int dtr);
	160	int sp_set_dsr(struct sp_port *port, int dsr);
	161	int sp_set_xon_xoff(struct sp_port *port, int xon_xoff);
	162
	163	/* Error handling */
	164	int sp_last_error_code(void);
	165	char *sp_last_error_message(void);
	166	void sp_free_error_message(char *message);
	167
	168	#ifdef __cplusplus
	169	}
	170	#endif
	171
	172	#endif /* LIBSERIALPORT_H */