]> sigrok.org Git - libsigrok.git/blobdiff - hardware/fluke-dmm/api.c
GPL headers: Use correct project name.
[libsigrok.git] / hardware / fluke-dmm / api.c
index 1662afc45481fc60831d12f02a6c32c60be5b9af..09847dd05ef4bc56bbe0b16ee2d0f529e9c28281 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * This file is part of the sigrok project.
+ * This file is part of the libsigrok project.
  *
  * Copyright (C) 2012 Bert Vermeulen <bert@biot.com>
  *
  */
 
 #include <glib.h>
+#include <sys/types.h>
+#include <sys/stat.h>
+#include <fcntl.h>
+#include <string.h>
+#include <errno.h>
 #include "libsigrok.h"
 #include "libsigrok-internal.h"
-#include "config.h"
+#include "fluke-dmm.h"
 
+static const int32_t hwopts[] = {
+       SR_CONF_CONN,
+       SR_CONF_SERIALCOMM,
+};
+
+static const int32_t hwcaps[] = {
+       SR_CONF_MULTIMETER,
+       SR_CONF_LIMIT_SAMPLES,
+       SR_CONF_LIMIT_MSEC,
+       SR_CONF_CONTINUOUS,
+};
+
+SR_PRIV struct sr_dev_driver flukedmm_driver_info;
+static struct sr_dev_driver *di = &flukedmm_driver_info;
+
+static char *scan_conn[] = {
+       /* 287/289 */
+       "115200/8n1",
+       /* 187/189 */
+       "9600/8n1",
+       /* Scopemeter 190 series */
+       "1200/8n1",
+       NULL
+};
 
-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, 1000 },
+       { FLUKE_287, "287", 100, 1000 },
+       { FLUKE_190, "199B", 1000, 3500 },
+};
 
-/* TODO move to header file */
-struct drv_context { GSList *instances; };
-struct dev_context { };
 
 /* Properly close and free all devices. */
 static int clear_instances(void)
@@ -36,84 +65,188 @@ static int clear_instances(void)
        struct sr_dev_inst *sdi;
        struct drv_context *drvc;
        struct dev_context *devc;
+       struct sr_serial_dev_inst *serial;
        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 */
-
+               serial = sdi->conn;
+               sr_serial_dev_inst_free(serial);
                sr_dev_inst_free(sdi);
        }
-
        g_slist_free(drvc->instances);
        drvc->instances = NULL;
 
        return SR_OK;
 }
 
-static int hw_init(void)
+static int hw_init(struct sr_context *sr_ctx)
 {
-       struct drv_context *drvc;
-
-       if (!(drvc = g_try_malloc0(sizeof(struct drv_context)))) {
-               sr_err("TODO: driver context malloc failed.");
-               return SR_ERR;
-       }
-
-       /* TODO */
-
-       di->priv = drvc;
-
-       return SR_OK;
+       return std_hw_init(sr_ctx, di, DRIVER_LOG_DOMAIN);
 }
 
-static GSList *hw_scan(GSList *options)
+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;
+       struct sr_serial_dev_inst *serial;
        GSList *devices;
+       int retry, len, i, s;
+       char buf[128], *b, **tokens;
+
+       if (!(serial = sr_serial_dev_inst_new(conn, serialcomm)))
+               return NULL;
+
+       if (serial_open(serial, SERIAL_RDWR | SERIAL_NONBLOCK) != SR_OK)
+               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(serial);
+               if (serial_write(serial, "ID\r", 3) == -1) {
+                       sr_err("Unable to send ID string: %s.",
+                              strerror(errno));
+                       continue;
+               }
 
-       /* TODO */
+               /* Response is first a CMD_ACK byte (ASCII '0' for OK,
+                * or '1' to signify an error. */
+               len = 128;
+               serial_readline(serial, &b, &len, 150);
+               if (len != 1)
+                       continue;
+               if (buf[0] != '0')
+                       continue;
+
+               /* If CMD_ACK was OK, ID string follows. */
+               len = 128;
+               serial_readline(serial, &b, &len, 850);
+               if (len < 10)
+                       continue;
+               if (strcspn(buf, ",") < 15)
+                       /* Looks like it's comma-separated. */
+                       tokens = g_strsplit(buf, ",", 3);
+               else
+                       /* Fluke 199B, at least, uses semicolon. */
+                       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_err("Device context malloc failed.");
+                                       return NULL;
+                               }
+                               devc->profile = &supported_flukedmm[i];
+                               sdi->conn = serial;
+                               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);
+               if (devices)
+                       /* Found one. */
+                       break;
+       }
+       serial_close(serial);
+       if (!devices)
+               sr_serial_dev_inst_free(serial);
 
        return devices;
 }
 
-static GSList *hw_dev_list(void)
+static GSList *hw_scan(GSList *options)
 {
-       struct drv_context *drvc;
+       struct sr_config *src;
+       GSList *l, *devices;
+       int i;
+       const char *conn, *serialcomm;
+
+       conn = serialcomm = NULL;
+       for (l = options; l; l = l->next) {
+               src = l->data;
+               switch (src->key) {
+               case SR_CONF_CONN:
+                       conn = g_variant_get_string(src->data, NULL);
+                       break;
+               case SR_CONF_SERIALCOMM:
+                       serialcomm = g_variant_get_string(src->data, NULL);
+                       break;
+               }
+       }
+       if (!conn)
+               return NULL;
+
+       if (serialcomm) {
+               /* Use the provided comm specs. */
+               devices = fluke_scan(conn, serialcomm);
+       } else {
+               for (i = 0; scan_conn[i]; i++) {
+                       if ((devices = fluke_scan(conn, scan_conn[i])))
+                               break;
+                       /* The Scopemeter 199B, at least, requires this
+                        * after all the 115k/9.6k confusion. */
+                       g_usleep(5000);
+               }
+       }
 
-       drvc = di->priv;
+       return devices;
+}
 
-       return drvc->instances;
+static GSList *hw_dev_list(void)
+{
+       return ((struct drv_context *)(di->priv))->instances;
 }
 
 static int hw_dev_open(struct sr_dev_inst *sdi)
 {
+       struct sr_serial_dev_inst *serial;
+
+       serial = sdi->conn;
+       if (serial_open(serial, SERIAL_RDWR | SERIAL_NONBLOCK) != SR_OK)
+               return SR_ERR;
 
-       /* TODO */
+       sdi->status = SR_ST_ACTIVE;
 
        return SR_OK;
 }
 
 static int hw_dev_close(struct sr_dev_inst *sdi)
 {
+       struct sr_serial_dev_inst *serial;
 
-       /* TODO */
+       serial = sdi->conn;
+       if (serial && serial->fd != -1) {
+               serial_close(serial);
+               sdi->status = SR_ST_INACTIVE;
+       }
 
        return SR_OK;
 }
@@ -123,67 +256,102 @@ static int hw_cleanup(void)
 
        clear_instances();
 
-       /* TODO */
-
        return SR_OK;
 }
 
-static int hw_info_get(int info_id, const void **data,
-       const struct sr_dev_inst *sdi)
+static int config_set(int id, GVariant *data, const struct sr_dev_inst *sdi)
 {
+       struct dev_context *devc;
 
+       if (sdi->status != SR_ST_ACTIVE)
+               return SR_ERR;
 
-       switch (info_id) {
-       /* TODO */
+       if (!(devc = sdi->priv)) {
+               sr_err("sdi->priv was NULL.");
+               return SR_ERR_BUG;
+       }
+
+       switch (id) {
+       case SR_CONF_LIMIT_MSEC:
+               /* TODO: not yet implemented */
+               if (g_variant_get_uint64(data) == 0) {
+                       sr_err("LIMIT_MSEC can't be 0.");
+                       return SR_ERR;
+               }
+               devc->limit_msec = g_variant_get_uint64(data);
+               sr_dbg("Setting time limit to %" PRIu64 "ms.",
+                      devc->limit_msec);
+               break;
+       case SR_CONF_LIMIT_SAMPLES:
+               devc->limit_samples = g_variant_get_uint64(data);
+               sr_dbg("Setting sample limit to %" PRIu64 ".",
+                      devc->limit_samples);
+               break;
        default:
-               return SR_ERR_ARG;
+               return SR_ERR_NA;
        }
 
        return SR_OK;
 }
 
-static int hw_dev_config_set(const struct sr_dev_inst *sdi, int hwcap,
-               const void *value)
+static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi)
 {
-       int ret;
-
-       if (sdi->status != SR_ST_ACTIVE)
-               return SR_ERR;
 
-       ret = SR_OK;
-       switch (hwcap) {
-       /* TODO */
+       (void)sdi;
+
+       switch (key) {
+       case SR_CONF_SCAN_OPTIONS:
+               *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
+                               hwopts, ARRAY_SIZE(hwopts), sizeof(int32_t));
+               break;
+       case SR_CONF_DEVICE_OPTIONS:
+               *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
+                               hwcaps, ARRAY_SIZE(hwcaps), sizeof(int32_t));
+               break;
        default:
-               ret = SR_ERR_ARG;
+               return SR_ERR_NA;
        }
 
-       return ret;
+       return SR_OK;
 }
 
 static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
                void *cb_data)
 {
+       struct dev_context *devc;
+       struct sr_serial_dev_inst *serial;
 
-       /* TODO */
+       if (!(devc = sdi->priv)) {
+               sr_err("sdi->priv was NULL.");
+               return SR_ERR_BUG;
+       }
 
-       return SR_OK;
-}
+       devc->cb_data = cb_data;
 
-static int hw_dev_acquisition_stop(const struct sr_dev_inst *sdi,
-               void *cb_data)
-{
+       /* Send header packet to the session bus. */
+       std_session_send_df_header(cb_data, DRIVER_LOG_DOMAIN);
 
-       (void)cb_data;
+       /* Poll every 100ms, or whenever some data comes in. */
+       serial = sdi->conn;
+       sr_source_add(serial->fd, G_IO_IN, 50, fluke_receive_data, (void *)sdi);
 
-       if (sdi->status != SR_ST_ACTIVE)
+       if (serial_write(serial, "QM\r", 3) == -1) {
+               sr_err("Unable to send QM: %s.", strerror(errno));
                return SR_ERR;
-
-       /* TODO */
+       }
+       devc->cmd_sent_at = g_get_monotonic_time() / 1000;
+       devc->expect_response = TRUE;
 
        return SR_OK;
 }
 
-SR_PRIV struct sr_dev_driver driver_info = {
+static int hw_dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
+{
+       return std_hw_dev_acquisition_stop_serial(sdi, cb_data, hw_dev_close,
+              sdi->conn, DRIVER_LOG_DOMAIN);
+}
+
+SR_PRIV struct sr_dev_driver flukedmm_driver_info = {
        .name = "fluke-dmm",
        .longname = "Fluke 18x/28x series DMMs",
        .api_version = 1,
@@ -192,10 +360,11 @@ SR_PRIV struct sr_dev_driver driver_info = {
        .scan = hw_scan,
        .dev_list = hw_dev_list,
        .dev_clear = clear_instances,
+       .config_get = NULL,
+       .config_set = config_set,
+       .config_list = config_list,
        .dev_open = hw_dev_open,
        .dev_close = hw_dev_close,
-       .info_get = hw_info_get,
-       .dev_config_set = hw_dev_config_set,
        .dev_acquisition_start = hw_dev_acquisition_start,
        .dev_acquisition_stop = hw_dev_acquisition_stop,
        .priv = NULL,