]> sigrok.org Git - libsigrok.git/blobdiff - hardware/fluke-dmm/api.c
config.h usage cleanups.
[libsigrok.git] / hardware / fluke-dmm / api.c
index 1662afc45481fc60831d12f02a6c32c60be5b9af..d6c322accdc9416a0ccc3e214d5d8dc31cc7ec48 100644 (file)
 #include <glib.h>
 #include "libsigrok.h"
 #include "libsigrok-internal.h"
-#include "config.h"
+#include "fluke-dmm.h"
+#include <sys/types.h>
+#include <sys/stat.h>
+#include <fcntl.h>
+#include <string.h>
+#include <errno.h>
+
+static const int hwopts[] = {
+       SR_HWOPT_CONN,
+       SR_HWOPT_SERIALCOMM,
+       0,
+};
+
+static const int hwcaps[] = {
+       SR_HWCAP_MULTIMETER,
+       SR_HWCAP_LIMIT_SAMPLES,
+       SR_HWCAP_LIMIT_MSEC,
+       SR_HWCAP_CONTINUOUS,
+       0,
+};
+
+static const char *probe_names[] = {
+       "Probe",
+       NULL,
+};
 
+SR_PRIV struct sr_dev_driver flukedmm_driver_info;
+static struct sr_dev_driver *di = &flukedmm_driver_info;
 
-SR_PRIV struct sr_dev_driver driver_info;
-static struct sr_dev_driver *di = &driver_info;
+static const struct flukedmm_profile supported_flukedmm[] = {
+       { FLUKE_187, "187", 100 },
+       { FLUKE_287, "287", 100 },
+};
 
-/* TODO move to header file */
-struct drv_context { GSList *instances; };
-struct dev_context { };
 
 /* Properly close and free all devices. */
 static int clear_instances(void)
@@ -38,24 +63,18 @@ static int clear_instances(void)
        struct dev_context *devc;
        GSList *l;
 
+       if (!(drvc = di->priv))
+               return SR_OK;
+
        drvc = di->priv;
        for (l = drvc->instances; l; l = l->next) {
-               if (!(sdi = l->data)) {
-                       /* Log error, but continue cleaning up the rest. */
-                       sr_err("TODO: %s: sdi was NULL, continuing", __func__);
+               if (!(sdi = l->data))
                        continue;
-               }
-               if (!(devc = sdi->priv)) {
-                       /* Log error, but continue cleaning up the rest. */
-                       sr_err("TODO: %s: sdi->priv was NULL, continuing", __func__);
+               if (!(devc = sdi->priv))
                        continue;
-               }
-
-               /* TODO */
-
+               sr_serial_dev_inst_free(devc->serial);
                sr_dev_inst_free(sdi);
        }
-
        g_slist_free(drvc->instances);
        drvc->instances = NULL;
 
@@ -67,28 +86,163 @@ static int hw_init(void)
        struct drv_context *drvc;
 
        if (!(drvc = g_try_malloc0(sizeof(struct drv_context)))) {
-               sr_err("TODO: driver context malloc failed.");
+               sr_err("fluke-dmm: driver context malloc failed.");
                return SR_ERR;
        }
 
-       /* TODO */
-
        di->priv = drvc;
 
        return SR_OK;
 }
 
-static GSList *hw_scan(GSList *options)
+static int serial_readline(int fd, char **buf, int *buflen, uint64_t timeout_ms)
+{
+       uint64_t start;
+       int maxlen, len;
+
+       timeout_ms *= 1000;
+       start = g_get_monotonic_time();
+
+       maxlen = *buflen;
+       *buflen = len = 0;
+       while(1) {
+               len = maxlen - *buflen - 1;
+               if (len < 1)
+                       break;
+               len = serial_read(fd, *buf + *buflen, 1);
+               if (len > 0) {
+                       *buflen += len;
+                       *(*buf + *buflen) = '\0';
+                       if (*buflen > 0 && *(*buf + *buflen - 1) == '\r') {
+                               /* Strip LF and terminate. */
+                               *(*buf + --*buflen) = '\0';
+                               break;
+                       }
+               }
+               if (g_get_monotonic_time() - start > timeout_ms)
+                       /* Timeout */
+                       break;
+               g_usleep(2000);
+       }
+       sr_dbg("fluke-dmm: received %d: '%s'", *buflen, *buf);
+
+       return SR_OK;
+}
+
+static GSList *fluke_scan(const char *conn, const char *serialcomm)
 {
+       struct sr_dev_inst *sdi;
        struct drv_context *drvc;
+       struct dev_context *devc;
+       struct sr_probe *probe;
        GSList *devices;
+       int fd, retry, len, i, s;
+       char buf[128], *b, **tokens;
+
+       if ((fd = serial_open(conn, O_RDWR|O_NONBLOCK)) == -1) {
+               sr_err("fluke-dmm: unable to open %s: %s", conn, strerror(errno));
+               return NULL;
+       }
+       if (serial_set_paramstr(fd, serialcomm) != SR_OK) {
+               sr_err("fluke-dmm: unable to set serial parameters");
+               return NULL;
+       }
 
-       (void)options;
-       devices = NULL;
        drvc = di->priv;
-       drvc->instances = NULL;
+       b = buf;
+       retry = 0;
+       devices = NULL;
+       /* We'll try the discovery sequence three times in case the device
+        * is not in an idle state when we send ID. */
+       while (!devices && retry < 3) {
+               retry++;
+               serial_flush(fd);
+               if (serial_write(fd, "ID\r", 3) == -1) {
+                       sr_err("fluke-dmm: unable to send ID string: %s",
+                                       strerror(errno));
+                       continue;
+               }
+
+               /* Response is first a CMD_ACK byte (ASCII '0' for OK,
+                * or '1' to signify an error. */
+               len = 128;
+               serial_readline(fd, &b, &len, 150);
+               if (len != 1)
+                       continue;
+               if (buf[0] != '0')
+                       continue;
+
+               /* If CMD_ACK was OK, ID string follows. */
+               len = 128;
+               serial_readline(fd, &b, &len, 150);
+               if (len < 10)
+                       continue;
+               tokens = g_strsplit(buf, ",", 3);
+               if (!strncmp("FLUKE", tokens[0], 5)
+                               && tokens[1] && tokens[2]) {
+                       for (i = 0; supported_flukedmm[i].model; i++) {
+                               if (strcmp(supported_flukedmm[i].modelname, tokens[0] + 6))
+                                       continue;
+                               /* Skip leading spaces in version number. */
+                               for (s = 0; tokens[1][s] == ' '; s++);
+                               if (!(sdi = sr_dev_inst_new(0, SR_ST_INACTIVE, "Fluke",
+                                               tokens[0] + 6, tokens[1] + s)))
+                                       return NULL;
+                               if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) {
+                                       sr_dbg("fluke-dmm: failed to malloc devc");
+                                       return NULL;
+                               }
+                               devc->profile = &supported_flukedmm[i];
+                               devc->serial = sr_serial_dev_inst_new(conn, -1);
+                               devc->serialcomm = g_strdup(serialcomm);
+                               sdi->priv = devc;
+                               sdi->driver = di;
+                               if (!(probe = sr_probe_new(0, SR_PROBE_ANALOG, TRUE, "P1")))
+                                       return NULL;
+                               sdi->probes = g_slist_append(sdi->probes, probe);
+                               drvc->instances = g_slist_append(drvc->instances, sdi);
+                               devices = g_slist_append(devices, sdi);
+                               break;
+                       }
+               }
+               g_strfreev(tokens);
+       }
+       serial_close(fd);
+
+       return devices;
+}
 
-       /* TODO */
+static GSList *hw_scan(GSList *options)
+{
+       struct sr_hwopt *opt;
+       GSList *l, *devices;
+       const char *conn, *serialcomm;
+
+       conn = serialcomm = NULL;
+       for (l = options; l; l = l->next) {
+               opt = l->data;
+               switch (opt->hwopt) {
+               case SR_HWOPT_CONN:
+                       conn = opt->value;
+                       break;
+               case SR_HWOPT_SERIALCOMM:
+                       serialcomm = opt->value;
+                       break;
+               }
+       }
+       if (!conn)
+               return NULL;
+
+       if (serialcomm) {
+               /* Use the provided comm specs. */
+               devices = fluke_scan(conn, serialcomm);
+       } else {
+               /* Try 115200, as used on 287/289. */
+               devices = fluke_scan(conn, "115200/8n1");
+               if (!devices)
+                       /* Fall back to 9600 for 187/189. */
+                       devices = fluke_scan(conn, "9600/8n1");
+       }
 
        return devices;
 }
@@ -104,16 +258,42 @@ static GSList *hw_dev_list(void)
 
 static int hw_dev_open(struct sr_dev_inst *sdi)
 {
+       struct dev_context *devc;
 
-       /* TODO */
+       if (!(devc = sdi->priv)) {
+               sr_err("fluke-dmm: sdi->priv was NULL.");
+               return SR_ERR_BUG;
+       }
+
+       devc->serial->fd = serial_open(devc->serial->port, O_RDWR | O_NONBLOCK);
+       if (devc->serial->fd == -1) {
+               sr_err("fluke-dmm: Couldn't open serial port '%s'.",
+                      devc->serial->port);
+               return SR_ERR;
+       }
+       if (serial_set_paramstr(devc->serial->fd, devc->serialcomm) != SR_OK) {
+               sr_err("fluke-dmm: unable to set serial parameters");
+               return SR_ERR;
+       }
+       sdi->status = SR_ST_ACTIVE;
 
        return SR_OK;
 }
 
 static int hw_dev_close(struct sr_dev_inst *sdi)
 {
+       struct dev_context *devc;
+
+       if (!(devc = sdi->priv)) {
+               sr_err("fluke-dmm: sdi->priv was NULL.");
+               return SR_ERR_BUG;
+       }
 
-       /* TODO */
+       if (devc->serial && devc->serial->fd != -1) {
+               serial_close(devc->serial->fd);
+               devc->serial->fd = -1;
+               sdi->status = SR_ST_INACTIVE;
+       }
 
        return SR_OK;
 }
@@ -123,8 +303,6 @@ static int hw_cleanup(void)
 
        clear_instances();
 
-       /* TODO */
-
        return SR_OK;
 }
 
@@ -132,9 +310,21 @@ static int hw_info_get(int info_id, const void **data,
        const struct sr_dev_inst *sdi)
 {
 
+       (void)sdi;
 
        switch (info_id) {
-       /* TODO */
+       case SR_DI_HWOPTS:
+               *data = hwopts;
+               break;
+       case SR_DI_HWCAPS:
+               *data = hwcaps;
+               break;
+       case SR_DI_NUM_PROBES:
+               *data = GINT_TO_POINTER(1);
+               break;
+       case SR_DI_PROBE_NAMES:
+               *data = probe_names;
+               break;
        default:
                return SR_ERR_ARG;
        }
@@ -145,26 +335,82 @@ static int hw_info_get(int info_id, const void **data,
 static int hw_dev_config_set(const struct sr_dev_inst *sdi, int hwcap,
                const void *value)
 {
-       int ret;
+       struct dev_context *devc;
 
        if (sdi->status != SR_ST_ACTIVE)
                return SR_ERR;
 
-       ret = SR_OK;
+       if (!(devc = sdi->priv)) {
+               sr_err("fluke-dmm: sdi->priv was NULL.");
+               return SR_ERR_BUG;
+       }
+
        switch (hwcap) {
-       /* TODO */
+       case SR_HWCAP_LIMIT_MSEC:
+               /* TODO: not yet implemented */
+               if (*(const uint64_t *)value == 0) {
+                       sr_err("fluke-dmm: LIMIT_MSEC can't be 0.");
+                       return SR_ERR;
+               }
+               devc->limit_msec = *(const uint64_t *)value;
+               sr_dbg("fluke-dmm: Setting time limit to %" PRIu64 "ms.",
+                      devc->limit_msec);
+               break;
+       case SR_HWCAP_LIMIT_SAMPLES:
+               devc->limit_samples = *(const uint64_t *)value;
+               sr_dbg("fluke-dmm: Setting sample limit to %" PRIu64 ".",
+                      devc->limit_samples);
+               break;
        default:
-               ret = SR_ERR_ARG;
+               sr_err("fluke-dmm: Unknown capability: %d.", hwcap);
+               return SR_ERR;
+               break;
        }
 
-       return ret;
+       return SR_OK;
 }
 
 static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
                void *cb_data)
 {
+       struct sr_datafeed_packet packet;
+       struct sr_datafeed_header header;
+       struct sr_datafeed_meta_analog meta;
+       struct dev_context *devc;
+
+       if (!(devc = sdi->priv)) {
+               sr_err("fluke-dmm: sdi->priv was NULL.");
+               return SR_ERR_BUG;
+       }
+
+       sr_dbg("fluke-dmm: Starting acquisition.");
+
+       devc->cb_data = cb_data;
+
+       /* Send header packet to the session bus. */
+       sr_dbg("fluke-dmm: Sending SR_DF_HEADER.");
+       packet.type = SR_DF_HEADER;
+       packet.payload = (uint8_t *)&header;
+       header.feed_version = 1;
+       gettimeofday(&header.starttime, NULL);
+       sr_session_send(devc->cb_data, &packet);
 
-       /* TODO */
+       /* Send metadata about the SR_DF_ANALOG packets to come. */
+       sr_dbg("fluke-dmm: Sending SR_DF_META_ANALOG.");
+       packet.type = SR_DF_META_ANALOG;
+       packet.payload = &meta;
+       meta.num_probes = 1;
+       sr_session_send(devc->cb_data, &packet);
+
+       /* Poll every 100ms, or whenever some data comes in. */
+       sr_source_add(devc->serial->fd, G_IO_IN, 50, fluke_receive_data, (void *)sdi);
+
+       if (serial_write(devc->serial->fd, "QM\r", 3) == -1) {
+               sr_err("fluke-dmm: unable to send QM: %s", strerror(errno));
+               return SR_ERR;
+       }
+       devc->cmd_sent_at = g_get_monotonic_time() / 1000;
+       devc->expect_response = TRUE;
 
        return SR_OK;
 }
@@ -172,18 +418,31 @@ static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
 static int hw_dev_acquisition_stop(const struct sr_dev_inst *sdi,
                void *cb_data)
 {
-
-       (void)cb_data;
+       struct sr_datafeed_packet packet;
+       struct dev_context *devc;
 
        if (sdi->status != SR_ST_ACTIVE)
                return SR_ERR;
 
-       /* TODO */
+       if (!(devc = sdi->priv)) {
+               sr_err("fluke-dmm: sdi->priv was NULL.");
+               return SR_ERR_BUG;
+       }
+
+       sr_dbg("fluke-dmm: Stopping acquisition.");
+
+       sr_source_remove(devc->serial->fd);
+       hw_dev_close((struct sr_dev_inst *)sdi);
+
+       /* Send end packet to the session bus. */
+       sr_dbg("fluke-dmm: Sending SR_DF_END.");
+       packet.type = SR_DF_END;
+       sr_session_send(cb_data, &packet);
 
        return SR_OK;
 }
 
-SR_PRIV struct sr_dev_driver driver_info = {
+SR_PRIV struct sr_dev_driver flukedmm_driver_info = {
        .name = "fluke-dmm",
        .longname = "Fluke 18x/28x series DMMs",
        .api_version = 1,