[libserialport.git] / serialport.h

/*
 * 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 SERIALPORT_H
#define SERIALPORT_H

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

/* 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
};

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

/* 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
};

char **sp_list_ports(void);
void sp_free_port_list(char **ports);
int sp_open(struct sp_port *port, char *portname, int flags);
int sp_close(struct sp_port *port);
int sp_flush(struct sp_port *port);
int sp_write(struct sp_port *port, const void *buf, size_t count);
int sp_read(struct sp_port *port, void *buf, size_t count);
int sp_set_params(struct sp_port *port, int baudrate, int bits, int parity,
		int stopbits, int flowcontrol, int rts, int dtr);
int sp_last_error_code(void);
char *sp_last_error_message(void);
void sp_free_error_message(char *message);

#endif /* SERIALPORT_H */
Commit	Line	Data
74510d4b ML	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
e8ffaee9 ML	20	#ifndef SERIALPORT_H
	21	#define SERIALPORT_H
	22
74510d4b ML	23	#include <stddef.h>
	24	#ifdef _WIN32
	25	#include <windows.h>
	26	#endif
	27
	28	/* A serial port. */
	29	struct sp_port {
	30	/* Name used to open the port */
	31	char *name;
	32	/* OS-specific port handle */
	33	#ifdef _WIN32
	34	HANDLE hdl;
	35	#else
	36	int fd;
	37	#endif
	38	};
	39
	40	/* Return values. */
	41	enum {
	42	/* Operation completed successfully. */
	43	SP_OK = 0,
	44	/* A system error occured while executing the operation. */
	45	SP_ERR_FAIL = -1,
	46	/* Invalid arguments were passed to the function. */
	47	SP_ERR_ARG = -2
	48	};
	49
	50	/* Port access modes. */
	51	enum {
	52	/* Open port for read/write access. */
	53	SP_MODE_RDWR = 1,
	54	/* Open port for read access only. */
	55	SP_MODE_RDONLY = 2,
	56	/* Open port in non-blocking mode. */
	57	SP_MODE_NONBLOCK = 4
	58	};
	59
	60	/* Parity settings. */
	61	enum {
	62	/* No parity. */
	63	SP_PARITY_NONE = 0,
	64	/* Even parity. */
	65	SP_PARITY_EVEN = 1,
	66	/* Odd parity. */
	67	SP_PARITY_ODD = 2
	68	};
	69
3b63f34d ML	70	char **sp_list_ports(void);
3b63f34d ML	71	void sp_free_port_list(char **ports);
74510d4b ML	72	int sp_open(struct sp_port port, char portname, int flags);
	73	int sp_close(struct sp_port *port);
	74	int sp_flush(struct sp_port *port);
	75	int sp_write(struct sp_port port, const void buf, size_t count);
	76	int sp_read(struct sp_port port, void buf, size_t count);
	77	int sp_set_params(struct sp_port *port, int baudrate, int bits, int parity,
	78	int stopbits, int flowcontrol, int rts, int dtr);
	79	int sp_last_error_code(void);
	80	char *sp_last_error_message(void);
	81	void sp_free_error_message(char *message);
e8ffaee9 ML	82
e8ffaee9 ML	83	#endif /* SERIALPORT_H */