]> sigrok.org Git - libserialport.git/commitdiff
Rename header to libserialport.h.
authorMartin Ling <redacted>
Mon, 4 Nov 2013 12:53:12 +0000 (12:53 +0000)
committerUwe Hermann <redacted>
Thu, 14 Nov 2013 23:42:39 +0000 (00:42 +0100)
Makefile.am
libserialport.h [new file with mode: 0644]
serialport.c
serialport.h [deleted file]

index ade0fd0aec25b340d26ecf03497962a0833d0323..85a79b2c041392d3ce105921655e104f784b64e9 100644 (file)
@@ -31,7 +31,7 @@ libserialport_la_LIBADD = $(LIBOBJS)
 libserialport_la_LDFLAGS = $(SP_LIB_LDFLAGS)
 
 library_includedir = $(includedir)
-library_include_HEADERS = serialport.h
+library_include_HEADERS = libserialport.h
 
 pkgconfigdir = $(libdir)/pkgconfig
 pkgconfig_DATA = libserialport.pc
diff --git a/libserialport.h b/libserialport.h
new file mode 100644 (file)
index 0000000..ac583e9
--- /dev/null
@@ -0,0 +1,97 @@
+/*
+ * 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,
+       /* 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
+};
+
+/* Flow control settings. */
+enum {
+       /* No flow control. */
+       SP_FLOW_NONE = 0,
+       /* Hardware (RTS/CTS) flow control. */
+       SP_FLOW_HARDWARE = 1,
+       /* Software (XON/XOFF) flow control. */
+       SP_FLOW_SOFTWARE = 2
+};
+
+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);
+void sp_free_port_list(struct sp_port **ports);
+int sp_open(struct sp_port *port, 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 */
index 5b5739dff58991da8396bf9af352eb3351d1535e..ddddb518be2b1b4b9cb38d0fd1ca178bb48a5400 100644 (file)
@@ -43,7 +43,7 @@
 #include "linux/serial.h"
 #endif
 
-#include "serialport.h"
+#include "libserialport.h"
 
 int sp_get_port_by_name(const char *portname, struct sp_port **port_ptr)
 {
diff --git a/serialport.h b/serialport.h
deleted file mode 100644 (file)
index ac583e9..0000000
+++ /dev/null
@@ -1,97 +0,0 @@
-/*
- * 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,
-       /* 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
-};
-
-/* Flow control settings. */
-enum {
-       /* No flow control. */
-       SP_FLOW_NONE = 0,
-       /* Hardware (RTS/CTS) flow control. */
-       SP_FLOW_HARDWARE = 1,
-       /* Software (XON/XOFF) flow control. */
-       SP_FLOW_SOFTWARE = 2
-};
-
-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);
-void sp_free_port_list(struct sp_port **ports);
-int sp_open(struct sp_port *port, 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 */