Add functions for setting individual port parameters.

[libserialport.git] / libserialport.h.in

diff --git a/libserialport.h.in b/libserialport.h.in
index f9f5b243a9fa37923d69887b936a8855cce32dfc..f58530cb6567415221e73f585b3d6d4faed5ab3b 100644 (file)
--- a/libserialport.h.in
+++ b/libserialport.h.in
@@ -52,6 +52,20 @@ struct sp_port {
 #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. */
@@ -84,14 +98,38 @@ enum {
        SP_PARITY_ODD = 2,
 };
 
-/* Flow control settings. */
+/* 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 {
-       /* 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,
+       SP_XONXOFF_DISABLED = 0,
+       SP_XONXOFF_IN = 1,
+       SP_XONXOFF_OUT = 2,
+       SP_XONXOFF_INOUT = 3
 };
 
 int sp_get_port_by_name(const char *portname, struct sp_port **port_ptr);
@@ -104,8 +142,16 @@ 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_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);
 int sp_last_error_code(void);
 char *sp_last_error_message(void);
 void sp_free_error_message(char *message);