]> sigrok.org Git - libsigrok.git/blobdiff - src/serial.c
scpi-pps: Add a missing "break" in config_get().
[libsigrok.git] / src / serial.c
index b0ae07f083503ee5a615627528fdb467c223cbb6..3c7ab643b6d6dfb6a75c2ac7797fc6c87eaf02a2 100644 (file)
@@ -20,6 +20,7 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+#include <config.h>
 #include <string.h>
 #include <stdlib.h>
 #include <glib.h>
@@ -27,7 +28,7 @@
 #include <libserialport.h>
 #include <libsigrok/libsigrok.h>
 #include "libsigrok-internal.h"
-#ifdef G_OS_WIN32
+#ifdef _WIN32
 #include <windows.h> /* for HANDLE */
 #endif
 
@@ -54,7 +55,7 @@
  *
  * @param serial Previously initialized serial port structure.
  * @param[in] flags Flags to use when opening the serial port. Possible flags
- *              include SERIAL_RDWR, SERIAL_RDONLY.
+ *                  include SERIAL_RDWR, SERIAL_RDONLY.
  *
  * If the serial structure contains a serialcomm string, it will be
  * passed to serial_set_paramstr() after the port is opened.
@@ -267,7 +268,7 @@ static int _serial_write(struct sr_serial_dev_inst *serial,
                return SR_ERR;
        }
 
-       sr_spew("Wrote %d/%d bytes.", ret, count);
+       sr_spew("Wrote %zd/%zu bytes.", ret, count);
 
        return ret;
 }
@@ -345,7 +346,7 @@ static int _serial_read(struct sr_serial_dev_inst *serial, void *buf,
        }
 
        if (ret > 0)
-               sr_spew("Read %d/%d bytes.", ret, count);
+               sr_spew("Read %zd/%zu bytes.", ret, count);
 
        return ret;
 }
@@ -359,8 +360,8 @@ static int _serial_read(struct sr_serial_dev_inst *serial, void *buf,
  * @param[in] timeout_ms Timeout in ms, or 0 for no timeout.
  *
  * @retval SR_ERR_ARG Invalid argument.
- * @retval SR_ERR     Other error.
- * @retval other      The number of bytes read. If this is less than the number
+ * @retval SR_ERR Other error.
+ * @retval other The number of bytes read. If this is less than the number
  * requested, the timeout was reached.
  *
  * @private
@@ -380,8 +381,8 @@ SR_PRIV int serial_read_blocking(struct sr_serial_dev_inst *serial, void *buf,
  * @param[in] count The number of bytes to read.
  *
  * @retval SR_ERR_ARG Invalid argument.
- * @retval SR_ERR     Other error.
- * @retval other      The number of bytes read.
+ * @retval SR_ERR Other error.
+ * @retval other The number of bytes read.
  *
  * @private
  */
@@ -400,7 +401,7 @@ SR_PRIV int serial_read_nonblocking(struct sr_serial_dev_inst *serial, void *buf
  * @param[in] parity The parity setting to use (0 = none, 1 = even, 2 = odd).
  * @param[in] stopbits The number of stop bits to use (1 or 2).
  * @param[in] flowcontrol The flow control settings to use (0 = none,
- *                      1 = RTS/CTS, 2 = XON/XOFF).
+ *                        1 = RTS/CTS, 2 = XON/XOFF).
  * @param[in] rts Status of RTS line (0 or 1; required by some interfaces).
  * @param[in] dtr Status of DTR line (0 or 1; required by some interfaces).
  *
@@ -476,7 +477,7 @@ SR_PRIV int serial_set_params(struct sr_serial_dev_inst *serial, int baudrate,
  * @param serial Previously initialized serial port structure.
  * @param[in] paramstr A serial communication parameters string of the form
  * "<baudrate>/<bits><parity><stopbits>{/<option>}".\n
- *  Examples: "9600/8n1", "600/7o2/dtr=1/rts=0" or "460800/8n1/flow=2".\n
+ * Examples: "9600/8n1", "600/7o2/dtr=1/rts=0" or "460800/8n1/flow=2".\n
  * \<baudrate\>=integer Baud rate.\n
  * \<bits\>=5|6|7|8 Number of data bits.\n
  * \<parity\>=n|e|o None, even, odd.\n
@@ -519,13 +520,13 @@ SR_PRIV int serial_set_paramstr(struct sr_serial_dev_inst *serial,
                if ((mstr = g_match_info_fetch(match, 3))) {
                        switch (mstr[0]) {
                        case 'n':
-                               parity = SERIAL_PARITY_NONE;
+                               parity = SP_PARITY_NONE;
                                break;
                        case 'e':
-                               parity = SERIAL_PARITY_EVEN;
+                               parity = SP_PARITY_EVEN;
                                break;
                        case 'o':
-                               parity = SERIAL_PARITY_ODD;
+                               parity = SP_PARITY_ODD;
                                break;
                        }
                }
@@ -665,10 +666,10 @@ SR_PRIV int serial_readline(struct sr_serial_dev_inst *serial, char **buf,
  * @param[in] packet_size Size, in bytes, of a valid packet.
  * @param is_valid Callback that assesses whether the packet is valid or not.
  * @param[in] timeout_ms The timeout after which, if no packet is detected, to
- *                   abort scanning.
+ *                       abort scanning.
  * @param[in] baudrate The baudrate of the serial port. This parameter is not
- *                 critical, but it helps fine tune the serial port polling
- *                 delay.
+ *                     critical, but it helps fine tune the serial port polling
+ *                     delay.
  *
  * @retval SR_OK Valid packet was found within the given timeout.
  * @retval SR_ERR Failure.
@@ -683,7 +684,7 @@ SR_PRIV int serial_stream_detect(struct sr_serial_dev_inst *serial,
 {
        uint64_t start, time, byte_delay_us;
        size_t ibuf, i, maxlen;
-       int len;
+       ssize_t len;
 
        maxlen = *buflen;
 
@@ -716,12 +717,12 @@ SR_PRIV int serial_stream_detect(struct sr_serial_dev_inst *serial,
                if ((ibuf - i) >= packet_size) {
                        /* We have at least a packet's worth of data. */
                        if (is_valid(&buf[i])) {
-                               sr_spew("Found valid %d-byte packet after "
+                               sr_spew("Found valid %zu-byte packet after "
                                        "%" PRIu64 "ms.", (ibuf - i), time);
                                *buflen = ibuf;
                                return SR_OK;
                        } else {
-                               sr_spew("Got %d bytes, but not a valid "
+                               sr_spew("Got %zu bytes, but not a valid "
                                        "packet.", (ibuf - i));
                        }
                        /* Not a valid packet. Continue searching. */
@@ -729,7 +730,7 @@ SR_PRIV int serial_stream_detect(struct sr_serial_dev_inst *serial,
                }
                if (time >= timeout_ms) {
                        /* Timeout */
-                       sr_dbg("Detection timed out after %dms.", time);
+                       sr_dbg("Detection timed out after %" PRIu64 "ms.", time);
                        break;
                }
                if (len < 1)
@@ -738,7 +739,7 @@ SR_PRIV int serial_stream_detect(struct sr_serial_dev_inst *serial,
 
        *buflen = ibuf;
 
-       sr_err("Didn't find a valid packet (read %d bytes).", *buflen);
+       sr_err("Didn't find a valid packet (read %zu bytes).", *buflen);
 
        return SR_ERR;
 }
@@ -787,7 +788,7 @@ SR_PRIV int sr_serial_extract_options(GSList *options, const char **serial_devic
 }
 
 /** @cond PRIVATE */
-#ifdef G_OS_WIN32
+#ifdef _WIN32
 typedef HANDLE event_handle;
 #else
 typedef int event_handle;
@@ -799,10 +800,17 @@ SR_PRIV int serial_source_add(struct sr_session *session,
                struct sr_serial_dev_inst *serial, int events, int timeout,
                sr_receive_data_callback cb, void *cb_data)
 {
+       struct sp_event_set *event_set;
+       gintptr poll_fd;
+       unsigned int poll_events;
        enum sp_event mask = 0;
-       unsigned int i;
 
-       if (sp_new_event_set(&serial->event_set) != SP_OK)
+       if ((events & (G_IO_IN|G_IO_ERR)) && (events & G_IO_OUT)) {
+               sr_err("Cannot poll input/error and output simultaneously.");
+               return SR_ERR_ARG;
+       }
+
+       if (sp_new_event_set(&event_set) != SP_OK)
                return SR_ERR;
 
        if (events & G_IO_IN)
@@ -812,54 +820,44 @@ SR_PRIV int serial_source_add(struct sr_session *session,
        if (events & G_IO_ERR)
                mask |= SP_EVENT_ERROR;
 
-       if (sp_add_port_events(serial->event_set, serial->data, mask) != SP_OK) {
-               sp_free_event_set(serial->event_set);
+       if (sp_add_port_events(event_set, serial->data, mask) != SP_OK) {
+               sp_free_event_set(event_set);
                return SR_ERR;
        }
-
-       serial->pollfds = g_new0(GPollFD, serial->event_set->count);
-
-       for (i = 0; i < serial->event_set->count; i++) {
-
-               serial->pollfds[i].fd = (gintptr)
-                       ((event_handle *)serial->event_set->handles)[i];
-               mask = serial->event_set->masks[i];
-
-               if (mask & SP_EVENT_RX_READY)
-                       serial->pollfds[i].events |= G_IO_IN;
-               if (mask & SP_EVENT_TX_READY)
-                       serial->pollfds[i].events |= G_IO_OUT;
-               if (mask & SP_EVENT_ERROR)
-                       serial->pollfds[i].events |= G_IO_ERR;
-
-               if (sr_session_source_add_pollfd(session, &serial->pollfds[i],
-                                       timeout, cb, cb_data) != SR_OK)
-                       return SR_ERR;
+       if (event_set->count != 1) {
+               sr_err("Unexpected number (%u) of event handles to poll.",
+                       event_set->count);
+               sp_free_event_set(event_set);
+               return SR_ERR;
        }
 
-       return SR_OK;
+       poll_fd = (gintptr) ((event_handle *)event_set->handles)[0];
+       mask = event_set->masks[0];
+
+       sp_free_event_set(event_set);
+
+       poll_events = 0;
+       if (mask & SP_EVENT_RX_READY)
+               poll_events |= G_IO_IN;
+       if (mask & SP_EVENT_TX_READY)
+               poll_events |= G_IO_OUT;
+       if (mask & SP_EVENT_ERROR)
+               poll_events |= G_IO_ERR;
+       /*
+        * Using serial->data as the key for the event source is not quite
+        * proper, as it makes it impossible to create another event source
+        * for the same serial port. However, these fixed keys will soon be
+        * removed from the API anyway, so this is OK for now.
+        */
+       return sr_session_fd_source_add(session, serial->data,
+                       poll_fd, poll_events, timeout, cb, cb_data);
 }
 
 /** @private */
 SR_PRIV int serial_source_remove(struct sr_session *session,
                struct sr_serial_dev_inst *serial)
 {
-       unsigned int i;
-
-       if (!serial->event_set)
-               return SR_OK;
-
-       for (i = 0; i < serial->event_set->count; i++)
-               if (sr_session_source_remove_pollfd(session, &serial->pollfds[i]) != SR_OK)
-                       return SR_ERR;
-
-       g_free(serial->pollfds);
-       sp_free_event_set(serial->event_set);
-
-       serial->pollfds = NULL;
-       serial->event_set = NULL;
-
-       return SR_OK;
+       return sr_session_source_remove_internal(session, serial->data);
 }
 
 /**