]> sigrok.org Git - libsigrok.git/blobdiff - hardware/common/scpi_serial.c
build: Portability fixes.
[libsigrok.git] / hardware / common / scpi_serial.c
index d4c3add23527f34745bfe434a62ea3c895613fa9..feb3317651eb18f2d858b576bd242e4556c1e1d0 100644 (file)
 #include "libsigrok-internal.h"
 
 #include <glib.h>
+#include <stdlib.h>
 #include <string.h>
 
 #define LOG_PREFIX "scpi_serial"
 
-#define SCPI_READ_RETRIES 100
-#define SCPI_READ_RETRY_TIMEOUT 10000
+#define BUFFER_SIZE 1024
 
 struct scpi_serial {
        struct sr_serial_dev_inst *serial;
-       char last_character;
+       char buffer[BUFFER_SIZE];
+       size_t count;
+       size_t read;
 };
 
-static int scpi_serial_dev_inst_new(void *priv, const char *resource,
-               char **params, const char *serialcomm)
+static struct {
+       uint16_t vendor_id;
+       uint16_t product_id;
+       const char *serialcomm;
+} scpi_serial_usb_ids[] = {
+       { 0x0403, 0xed72, "115200/8n1/flow=1" }, /* Hameg HO720 */
+       { 0x0403, 0xed73, "115200/8n1/flow=1" }, /* Hameg HO730 */
+};
+
+static GSList *scpi_serial_scan(struct drv_context *drvc)
+{
+       GSList *l, *r, *resources = NULL;
+       gchar *res;
+       unsigned i;
+
+       (void)drvc;
+
+       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)) == NULL)
+                       continue;
+               for (r = l; r; r = r->next) {
+                       if (scpi_serial_usb_ids[i].serialcomm)
+                               res = g_strdup_printf("%s:%s", (char *) r->data,
+                                                     scpi_serial_usb_ids[i].serialcomm);
+                       else
+                               res = g_strdup(r->data);
+                       resources = g_slist_append(resources, res);
+               }
+               g_slist_free_full(l, g_free);
+       }
+
+       return resources;
+}
+
+static int scpi_serial_dev_inst_new(void *priv, struct drv_context *drvc,
+               const char *resource, char **params, const char *serialcomm)
 {
        struct scpi_serial *sscpi = priv;
 
+       (void)drvc;
        (void)params;
 
        if (!(sscpi->serial = sr_serial_dev_inst_new(resource, serialcomm)))
@@ -47,7 +85,7 @@ static int scpi_serial_dev_inst_new(void *priv, const char *resource,
        return SR_OK;
 }
 
-SR_PRIV int scpi_serial_open(void *priv)
+static int scpi_serial_open(void *priv)
 {
        struct scpi_serial *sscpi = priv;
        struct sr_serial_dev_inst *serial = sscpi->serial;
@@ -58,27 +96,30 @@ SR_PRIV int scpi_serial_open(void *priv)
        if (serial_flush(serial) != SR_OK)
                return SR_ERR;
 
+       sscpi->count = 0;
+       sscpi->read = 0;
+
        return SR_OK;
 }
 
-SR_PRIV int scpi_serial_source_add(void *priv, int events, int timeout,
-                       sr_receive_data_callback_t cb, void *cb_data)
+static int scpi_serial_source_add(struct sr_session *session, void *priv,
+               int events, int timeout, sr_receive_data_callback cb, void *cb_data)
 {
        struct scpi_serial *sscpi = priv;
        struct sr_serial_dev_inst *serial = sscpi->serial;
 
-       return serial_source_add(serial, events, timeout, cb, cb_data);
+       return serial_source_add(session, serial, events, timeout, cb, cb_data);
 }
 
-SR_PRIV int scpi_serial_source_remove(void *priv)
+static int scpi_serial_source_remove(struct sr_session *session, void *priv)
 {
        struct scpi_serial *sscpi = priv;
        struct sr_serial_dev_inst *serial = sscpi->serial;
 
-       return serial_source_remove(serial);
+       return serial_source_remove(session, serial);
 }
 
-SR_PRIV int scpi_serial_send(void *priv, const char *command)
+static int scpi_serial_send(void *priv, const char *command)
 {
        int len, result, written;
        gchar *terminated_command;
@@ -105,93 +146,66 @@ SR_PRIV int scpi_serial_send(void *priv, const char *command)
        return SR_OK;
 }
 
-SR_PRIV int scpi_serial_receive(void *priv, char **scpi_response)
+static int scpi_serial_read_begin(void *priv)
 {
-       int len, ret;
-       char buf[256];
-       unsigned int i;
-       GString *response;
-       struct scpi_serial *sscpi = priv;
-       struct sr_serial_dev_inst *serial = sscpi->serial;
-
-       response = g_string_sized_new(1024);
-
-       for (i = 0; i <= SCPI_READ_RETRIES; i++) {
-               while ((len = serial_read(serial, buf, sizeof(buf))) > 0)
-                       response = g_string_append_len(response, buf, len);
-
-               if (response->len > 0 &&
-                   response->str[response->len-1] == '\n') {
-                       sr_spew("Fetched full SCPI response.");
-                       break;
-               }
-
-               g_usleep(SCPI_READ_RETRY_TIMEOUT);
-       }
+       (void) priv;
 
-       if (response->len == 0) {
-               sr_dbg("No SCPI response received.");
-               g_string_free(response, TRUE);
-               *scpi_response = NULL;
-               return SR_ERR;
-       } else if (response->str[response->len - 1] == '\n') {
-               /*
-                * The SCPI response contains a LF ('\n') at the end and we
-                * don't need this so replace it with a '\0' and decrement
-                * the length.
-                */
-               response->str[--response->len] = '\0';
-               ret = SR_OK;
-       } else {
-               sr_warn("Incomplete SCPI response received!");
-               ret = SR_ERR;
-       }
-
-       /* Minor optimization: steal the string instead of copying. */
-       *scpi_response = response->str;
-
-       /* A SCPI response can be quite large, print at most 50 characters. */
-       sr_dbg("SCPI response received (length %d): '%.50s'",
-              response->len, response->str);
-
-       g_string_free(response, FALSE);
-
-       return ret;
+       return SR_OK;
 }
 
-SR_PRIV int scpi_serial_read_begin(void *priv)
+static int scpi_serial_read_data(void *priv, char *buf, int maxlen)
 {
        struct scpi_serial *sscpi = priv;
+       int len, ret;
 
-       sscpi->last_character = '\0';
+       len = BUFFER_SIZE - sscpi->count;
 
-       return SR_OK;
-}
+       /* Try to read new data into the buffer if there is space. */
+       if (len > 0) {
+               ret = serial_read(sscpi->serial, sscpi->buffer + sscpi->read,
+                               BUFFER_SIZE - sscpi->count);
 
-SR_PRIV int scpi_serial_read_data(void *priv, char *buf, int maxlen)
-{
-       struct scpi_serial *sscpi = priv;
-       int ret;
+               if (ret < 0)
+                       return ret;
 
-       ret = serial_read(sscpi->serial, buf, maxlen);
+               sscpi->count += ret;
 
-       if (ret < 0)
-               return ret;
+               if (ret > 0)
+                       sr_spew("Read %d bytes into buffer.", ret);
+       }
 
-       if (ret > 0) {
-               sscpi->last_character = buf[ret - 1];
-               if (sscpi->last_character == '\n')
-                       ret--;
+       /* Return as many bytes as possible from buffer, excluding any trailing newline. */
+       if (sscpi->read < sscpi->count) {
+               len = sscpi->count - sscpi->read;
+               if (len > maxlen)
+                       len = maxlen;
+               if (sscpi->buffer[sscpi->read + len - 1] == '\n')
+                       len--;
+               sr_spew("Returning %d bytes from buffer.", len);
+               memcpy(buf, sscpi->buffer + sscpi->read, len);
+               sscpi->read += len;
+               if (sscpi->read == BUFFER_SIZE) {
+                       sr_spew("Resetting buffer.");
+                       sscpi->count = 0;
+                       sscpi->read = 0;
+               }
+               return len;
        }
 
-       return ret;
+       return 0;
 }
 
-SR_PRIV int scpi_serial_read_complete(void *priv)
+static int scpi_serial_read_complete(void *priv)
 {
        struct scpi_serial *sscpi = priv;
 
-       return (sscpi->last_character == '\n');
+       /* If the next character is a newline, discard it and report complete. */
+       if (sscpi->read < sscpi->count && sscpi->buffer[sscpi->read] == '\n') {
+               sscpi->read++;
+               return 1;
+       } else {
+               return 0;
+       }
 }
 
 static int scpi_serial_close(void *priv)
@@ -212,6 +226,7 @@ SR_PRIV const struct sr_scpi_dev_inst scpi_serial_dev = {
        .name          = "serial",
        .prefix        = "",
        .priv_size     = sizeof(struct scpi_serial),
+       .scan          = scpi_serial_scan,
        .dev_inst_new  = scpi_serial_dev_inst_new,
        .open          = scpi_serial_open,
        .source_add    = scpi_serial_source_add,