scpi_serial: Add GW-Instek GPD-9061 (USBCDC mode) VID/PID.

[libsigrok.git] / src / scpi / scpi_serial.c

diff --git a/src/scpi/scpi_serial.c b/src/scpi/scpi_serial.c
index 6811ad3688345ad81a5d93b81732d6ab5d761df1..f0ec4c4dfc77a4ba246e7a3f6dd4b56099827eb3 100644 (file)
--- a/src/scpi/scpi_serial.c
+++ b/src/scpi/scpi_serial.c
@@ -28,11 +28,14 @@
 
 #define LOG_PREFIX "scpi_serial"
 
+#ifdef HAVE_SERIAL_COMM
+
 struct scpi_serial {
        struct sr_serial_dev_inst *serial;
-       char got_newline;
+       gboolean got_newline;
 };
 
+/* Default serial port options for some known USB devices */
 static const struct {
        uint16_t vendor_id;
        uint16_t product_id;
@@ -40,7 +43,10 @@ static const struct {
 } scpi_serial_usb_ids[] = {
        { 0x0403, 0xed72, "115200/8n1/flow=1" }, /* Hameg HO720 */
        { 0x0403, 0xed73, "115200/8n1/flow=1" }, /* Hameg HO730 */
-       { 0x0aad, 0x0118, "115200/8n1" },        /* R&S HMO1002 */
+       { 0x0aad, 0x0117, "115200/8n1" },        /* R&S HMO series, previously branded as Hameg HMO */
+       { 0x0aad, 0x0118, "115200/8n1" },        /* R&S HMO series, previously branded as Hameg HMO */
+       { 0x0aad, 0x0119, "115200/8n1" },        /* R&S HMO series, previously branded as Hameg HMO */
+       { 0x2184, 0x0058, "115200/8n1" },        /* GW-Instek GDM-9061 (USBCDC mode) */
 };
 
 static GSList *scpi_serial_scan(struct drv_context *drvc)
@@ -72,11 +78,30 @@ static GSList *scpi_serial_scan(struct drv_context *drvc)
 static int scpi_serial_dev_inst_new(void *priv, struct drv_context *drvc,
                const char *resource, char **params, const char *serialcomm)
 {
+       GSList *l, *r;
+       unsigned i;
        struct scpi_serial *sscpi = priv;
 
        (void)drvc;
        (void)params;
 
+       /* If no serial port option is specified on the command-line using the
+        * "serialcomm" driver option, but the device is connected through USB
+        * and it requires a known default serial port option, then used it in
+        * order to avoid data corruption or even worse problems.
+        */
+       if (!serialcomm) {
+               for (i = 0; i < ARRAY_SIZE(scpi_serial_usb_ids); i++) {
+                       if (!(l = sr_serial_find_usb(scpi_serial_usb_ids[i].vendor_id,
+                                               scpi_serial_usb_ids[i].product_id)))
+                               continue;
+                       for (r = l; r; r = r->next)
+                               if (!strcmp(resource, r->data) && scpi_serial_usb_ids[i].serialcomm)
+                                       serialcomm = scpi_serial_usb_ids[i].serialcomm;
+                       g_slist_free_full(l, g_free);
+               }
+       }
+
        sscpi->serial = sr_serial_dev_inst_new(resource, serialcomm);
 
        return SR_OK;
@@ -90,10 +115,18 @@ static int scpi_serial_open(struct sr_scpi_dev_inst *scpi)
        if (serial_open(serial, SERIAL_RDWR) != SR_OK)
                return SR_ERR;
 
-       if (serial_flush(serial) != SR_OK)
-               return SR_ERR;
+       sscpi->got_newline = FALSE;
 
-       sscpi->got_newline = 0;
+       return SR_OK;
+}
+
+static int scpi_serial_connection_id(struct sr_scpi_dev_inst *scpi,
+               char **connection_id)
+{
+       struct scpi_serial *sscpi = scpi->priv;
+       struct sr_serial_dev_inst *serial = sscpi->serial;
+
+       *connection_id = g_strdup(serial->port);
 
        return SR_OK;
 }
@@ -117,20 +150,15 @@ static int scpi_serial_source_remove(struct sr_session *session, void *priv)
 
 static int scpi_serial_send(void *priv, const char *command)
 {
-       int len, result, written;
+       int result;
        struct scpi_serial *sscpi = priv;
        struct sr_serial_dev_inst *serial = sscpi->serial;
 
-       len = strlen(command);
-       written = 0;
-       while (written < len) {
-               result = serial_write_nonblocking(serial,
-                               command + written, len - written);
-               if (result < 0) {
-                       sr_err("Error while sending SCPI command: '%s'.", command);
-                       return SR_ERR;
-               }
-               written += result;
+       result = serial_write_blocking(serial, command, strlen(command), 0);
+       if (result < 0) {
+               sr_err("Error while sending SCPI command '%s': %d.",
+                       command, result);
+               return SR_ERR;
        }
 
        sr_spew("Successfully sent SCPI command: '%s'.", command);
@@ -141,7 +169,7 @@ static int scpi_serial_send(void *priv, const char *command)
 static int scpi_serial_read_begin(void *priv)
 {
        struct scpi_serial *sscpi = priv;
-       sscpi->got_newline = 0;
+       sscpi->got_newline = FALSE;
 
        return SR_OK;
 }
@@ -158,13 +186,16 @@ static int scpi_serial_read_data(void *priv, char *buf, int maxlen)
                return ret;
 
        if (ret > 0) {
-               sr_spew("Read %d bytes into buffer.", ret);
-
                if (buf[ret - 1] == '\n') {
-                       sscpi->got_newline = 1;
-                       sr_spew("Received terminator");
+                       sscpi->got_newline = TRUE;
+                       sr_spew("Received NL terminator");
+               } else if (ret > 1 &&
+                          buf[ret - 2] == '\n' && buf[ret - 1] == '\r') {
+                       sscpi->got_newline = TRUE;
+                       sr_spew("Received NL+CR terminator");
+                       ret--;
                } else {
-                       sscpi->got_newline = 0;
+                       sscpi->got_newline = FALSE;
                }
        }
 
@@ -195,10 +226,12 @@ static void scpi_serial_free(void *priv)
 SR_PRIV const struct sr_scpi_dev_inst scpi_serial_dev = {
        .name          = "serial",
        .prefix        = "",
+       .transport     = SCPI_TRANSPORT_SERIAL,
        .priv_size     = sizeof(struct scpi_serial),
        .scan          = scpi_serial_scan,
        .dev_inst_new  = scpi_serial_dev_inst_new,
        .open          = scpi_serial_open,
+       .connection_id = scpi_serial_connection_id,
        .source_add    = scpi_serial_source_add,
        .source_remove = scpi_serial_source_remove,
        .send          = scpi_serial_send,
@@ -208,3 +241,5 @@ SR_PRIV const struct sr_scpi_dev_inst scpi_serial_dev = {
        .close         = scpi_serial_close,
        .free          = scpi_serial_free,
 };
+
+#endif