Add sp_get_signals() function.

[libserialport.git] / libserialport.h.in

diff --git a/libserialport.h.in b/libserialport.h.in
index 264c7db8ca496c69d4ee87a9a199ce46c2919606..79babac9a70b21fa49f1ab0b12a63cb2af378125 100644 (file)
--- a/libserialport.h.in
+++ b/libserialport.h.in
@@ -101,14 +101,24 @@ enum sp_return {
 
 /** Port access modes. */
 enum sp_mode {
-       /** Open port for read/write access. */
-       SP_MODE_RDWR = 1,
-       /** Open port for read access only. */
-       SP_MODE_RDONLY = 2,
+       /** Open port for read access. */
+       SP_MODE_READ = 1,
+       /** Open port for write access. */
+       SP_MODE_WRITE = 2,
        /** Open port in non-blocking mode. */
        SP_MODE_NONBLOCK = 4,
 };
 
+/** Buffer selection. */
+enum sp_buffer {
+       /** Input buffer. */
+       SP_BUF_INPUT = 1,
+       /** Output buffer. */
+       SP_BUF_OUTPUT = 2,
+       /** Both buffers. */
+       SP_BUF_BOTH = 3,
+};
+
 /** Parity settings. */
 enum sp_parity {
        /** Special value to indicate setting should be left alone. */
@@ -191,6 +201,18 @@ enum sp_flowcontrol {
        SP_FLOWCONTROL_DTRDSR = 3,
 };
 
+/** Input signals. */
+enum sp_signal {
+       /** Clear to send. */
+       SP_SIG_CTS = 1,
+       /** Data set ready. */
+       SP_SIG_DSR = 2,
+       /** Data carrier detect. */
+       SP_SIG_DCD = 4,
+       /** Ring indicator. */
+       SP_SIG_RI = 8,
+};
+
 /** A serial port. */
 struct sp_port {
        /** Name used to open the port. */
@@ -506,12 +528,61 @@ enum sp_return sp_read(struct sp_port *port, void *buf, size_t count);
 enum sp_return sp_write(struct sp_port *port, const void *buf, size_t count);
 
 /**
- * Flush serial port buffers.
+ * Flush serial port buffers. Data in the selected buffer(s) is discarded.
+ *
+ * @param port Pointer to port structure.
+ * @param buffers Which buffer(s) to flush.
+ *
+ * @return SP_OK on success, SP_ERR_FAIL on failure, or SP_ERR_ARG
+ *         if an invalid port is passed.
+ */
+enum sp_return sp_flush(struct sp_port *port, enum sp_buffer buffers);
+
+/**
+ * Wait for buffered data to be transmitted.
+ *
+ * @return SP_OK on success, SP_ERR_FAIL on failure, or SP_ERR_ARG
+ *         if an invalid port is passed.
+ */
+enum sp_return sp_drain(struct sp_port *port);
+
+/**
+ * @}
+ * @defgroup Signal Port signalling operations
+ * @{
+ */
+
+/**
+ * Gets the status of the control signals for the specified port.
+ *
+ * The user should allocate a variable of type "enum sp_signal" and pass a
+ * pointer to this variable to receive the result. The result is a bitmask
+ * in which individual signals can be checked by bitwise OR with values of
+ * the sp_signal enum.
+ *
+ * @param port Pointer to port structure.
+ * @param signals Pointer to variable to receive result.
+ *
+ * @return SP_OK on success, SP_ERR_FAIL on failure, or SP_ERR_ARG
+ *         if an an invalid port or pointer is passed.
+ */
+enum sp_return sp_get_signals(struct sp_port *port, enum sp_signal *signals);
+
+/**
+ * Put the port transmit line into the break state.
+ *
+ * @return SP_OK on success, SP_ERR_FAIL on failure, or SP_ERR_ARG
+ *         if an invalid port is passed.
+ */
+enum sp_return sp_start_break(struct sp_port *port);
+
+/**
+ * Take the port transmit line out of the break state.
  *
  * @return SP_OK on success, SP_ERR_FAIL on failure, or SP_ERR_ARG
  *         if an invalid port is passed.
  */
-enum sp_return sp_flush(struct sp_port *port);
+enum sp_return sp_end_break(struct sp_port *port);
 
 /**
  * @}