]> sigrok.org Git - libsigrok.git/blobdiff - src/hardware/hp-3478a/api.c
hp-3478a: Fix switching from 4-wire to 2-wire measurement.
[libsigrok.git] / src / hardware / hp-3478a / api.c
index edc16fc896befcfb07d069e1ab3b1c679f36014c..0c461bb1740bebd4c4c4f1e41b892cfac1248057 100644 (file)
@@ -1,7 +1,7 @@
 /*
  * This file is part of the libsigrok project.
  *
- * Copyright (C) 2017 Frank Stettner <frank-stettner@gmx.net>
+ * Copyright (C) 2017-2021 Frank Stettner <frank-stettner@gmx.net>
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -34,6 +34,8 @@ static const uint32_t devopts[] = {
        SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
        SR_CONF_LIMIT_MSEC | SR_CONF_GET | SR_CONF_SET,
        SR_CONF_MEASURED_QUANTITY | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
+       SR_CONF_RANGE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
+       SR_CONF_DIGITS | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
 };
 
 static const struct {
@@ -41,20 +43,71 @@ static const struct {
        enum sr_mqflag mqflag;
 } mqopts[] = {
        {SR_MQ_VOLTAGE, SR_MQFLAG_DC},
-       {SR_MQ_VOLTAGE, SR_MQFLAG_DC | SR_MQFLAG_AUTORANGE},
-       {SR_MQ_VOLTAGE, SR_MQFLAG_AC | SR_MQFLAG_RMS},
-       {SR_MQ_VOLTAGE, SR_MQFLAG_AC | SR_MQFLAG_RMS | SR_MQFLAG_AUTORANGE},
+       {SR_MQ_VOLTAGE, SR_MQFLAG_AC},
        {SR_MQ_CURRENT, SR_MQFLAG_DC},
-       {SR_MQ_CURRENT, SR_MQFLAG_DC | SR_MQFLAG_AUTORANGE},
-       {SR_MQ_CURRENT, SR_MQFLAG_AC | SR_MQFLAG_RMS},
-       {SR_MQ_CURRENT, SR_MQFLAG_AC | SR_MQFLAG_RMS | SR_MQFLAG_AUTORANGE},
+       {SR_MQ_CURRENT, SR_MQFLAG_AC},
        {SR_MQ_RESISTANCE, 0},
-       {SR_MQ_RESISTANCE, 0 | SR_MQFLAG_AUTORANGE},
        {SR_MQ_RESISTANCE, SR_MQFLAG_FOUR_WIRE},
-       {SR_MQ_RESISTANCE, SR_MQFLAG_FOUR_WIRE | SR_MQFLAG_AUTORANGE},
 };
 
-SR_PRIV struct sr_dev_driver hp_3478a_driver_info;
+static const struct {
+       enum sr_mq mq;
+       enum sr_mqflag mqflag;
+       int range_exp;
+       const char *range_str;
+} rangeopts[] = {
+       /* -99 is a dummy exponent for auto ranging. */
+       {SR_MQ_VOLTAGE, SR_MQFLAG_DC,             -99,   "Auto"},
+       {SR_MQ_VOLTAGE, SR_MQFLAG_DC,              -2,   "30mV"},
+       {SR_MQ_VOLTAGE, SR_MQFLAG_DC,              -1,   "300mV"},
+       {SR_MQ_VOLTAGE, SR_MQFLAG_DC,               0,   "3V"},
+       {SR_MQ_VOLTAGE, SR_MQFLAG_DC,               1,   "30V"},
+       {SR_MQ_VOLTAGE, SR_MQFLAG_DC,               2,   "300V"},
+       /* -99 is a dummy exponent for auto ranging. */
+       {SR_MQ_VOLTAGE, SR_MQFLAG_AC,             -99,   "Auto"},
+       {SR_MQ_VOLTAGE, SR_MQFLAG_AC,              -1,   "300mV"},
+       {SR_MQ_VOLTAGE, SR_MQFLAG_AC,               0,   "3V"},
+       {SR_MQ_VOLTAGE, SR_MQFLAG_AC,               1,   "30V"},
+       {SR_MQ_VOLTAGE, SR_MQFLAG_AC,               2,   "300V"},
+       /* -99 is a dummy exponent for auto ranging. */
+       {SR_MQ_CURRENT, SR_MQFLAG_DC,             -99,   "Auto"},
+       {SR_MQ_CURRENT, SR_MQFLAG_DC,              -1,   "300mV"},
+       {SR_MQ_CURRENT, SR_MQFLAG_DC,               0,   "3V"},
+       /* -99 is a dummy exponent for auto ranging. */
+       {SR_MQ_CURRENT, SR_MQFLAG_AC,             -99,   "Auto"},
+       {SR_MQ_CURRENT, SR_MQFLAG_AC,              -1,   "300mV"},
+       {SR_MQ_CURRENT, SR_MQFLAG_AC,               0,   "3V"},
+       /* -99 is a dummy exponent for auto ranging. */
+       {SR_MQ_RESISTANCE, 0,                     -99,   "Auto"},
+       {SR_MQ_RESISTANCE, 0,                       1,   "30"},
+       {SR_MQ_RESISTANCE, 0,                       2,   "300"},
+       {SR_MQ_RESISTANCE, 0,                       3,   "3k"},
+       {SR_MQ_RESISTANCE, 0,                       4,   "30k"},
+       {SR_MQ_RESISTANCE, 0,                       5,   "300k"},
+       {SR_MQ_RESISTANCE, 0,                       6,   "3M"},
+       {SR_MQ_RESISTANCE, 0,                       7,   "30M"},
+       /* -99 is a dummy exponent for auto ranging. */
+       {SR_MQ_RESISTANCE, SR_MQFLAG_FOUR_WIRE,   -99,   "Auto"},
+       {SR_MQ_RESISTANCE, SR_MQFLAG_FOUR_WIRE,     1,   "30R"},
+       {SR_MQ_RESISTANCE, SR_MQFLAG_FOUR_WIRE,     2,   "300R"},
+       {SR_MQ_RESISTANCE, SR_MQFLAG_FOUR_WIRE,     3,   "3kR"},
+       {SR_MQ_RESISTANCE, SR_MQFLAG_FOUR_WIRE,     4,   "30kR"},
+       {SR_MQ_RESISTANCE, SR_MQFLAG_FOUR_WIRE,     5,   "300kR"},
+       {SR_MQ_RESISTANCE, SR_MQFLAG_FOUR_WIRE,     6,   "3MR"},
+       {SR_MQ_RESISTANCE, SR_MQFLAG_FOUR_WIRE,     7,   "30MR"},
+};
+
+/** Available digits as strings. */
+static const char *digits[] = {
+       "3.5", "4.5", "5.5",
+};
+
+/** Mapping between devc->spec_digits and digits string. */
+static const char *digits_map[] = {
+       "", "", "", "", "3.5", "4.5", "5.5",
+};
+
+static struct sr_dev_driver hp_3478a_driver_info;
 
 static int create_front_channel(struct sr_dev_inst *sdi, int chan_idx)
 {
@@ -76,6 +129,14 @@ static struct sr_dev_inst *probe_device(struct sr_scpi_dev_inst *scpi)
        struct sr_dev_inst *sdi;
        struct dev_context *devc;
 
+       /*
+        * The device cannot get identified by means of SCPI queries.
+        * Neither shall non-SCPI requests get emitted before reliable
+        * identification of the device. Assume that we only get here
+        * when user specs led us to believe it's safe to communicate
+        * to the expected kind of device.
+        */
+
        sdi = g_malloc0(sizeof(struct sr_dev_inst));
        sdi->vendor = g_strdup("Hewlett-Packard");
        sdi->model = g_strdup("3478A");
@@ -99,6 +160,14 @@ static struct sr_dev_inst *probe_device(struct sr_scpi_dev_inst *scpi)
 
 static GSList *scan(struct sr_dev_driver *di, GSList *options)
 {
+       const char *conn;
+
+       /* Only scan for a device when conn= was specified. */
+       conn = NULL;
+       (void)sr_serial_extract_options(options, &conn, NULL);
+       if (!conn)
+               return NULL;
+
        return sr_scpi_scan(di->context, options, probe_device);
 }
 
@@ -118,10 +187,12 @@ static int config_get(uint32_t key, GVariant **data,
        struct dev_context *devc;
        int ret;
        GVariant *arr[2];
+       unsigned int i;
+       const char *range_str;
 
        (void)cg;
 
-       devc = sdi->priv;
+       devc = sdi ? sdi->priv : NULL;
 
        switch (key) {
        case SR_CONF_LIMIT_SAMPLES:
@@ -132,9 +203,30 @@ static int config_get(uint32_t key, GVariant **data,
                if (ret != SR_OK)
                        return ret;
                arr[0] = g_variant_new_uint32(devc->measurement_mq);
-               arr[1] = g_variant_new_uint64(devc->measurement_mq_flags);
+               arr[1] = g_variant_new_uint64(devc->measurement_mq_flag);
                *data = g_variant_new_tuple(arr, 2);
                break;
+       case SR_CONF_RANGE:
+               ret = hp_3478a_get_status_bytes(sdi);
+               if (ret != SR_OK)
+                       return ret;
+               range_str = "Auto";
+               for (i = 0; i < ARRAY_SIZE(rangeopts); i++) {
+                       if (rangeopts[i].mq == devc->measurement_mq &&
+                                       rangeopts[i].mqflag == devc->measurement_mq_flag &&
+                                       rangeopts[i].range_exp == devc->range_exp) {
+                               range_str = rangeopts[i].range_str;
+                               break;
+                       }
+               }
+               *data = g_variant_new_string(range_str);
+               break;
+       case SR_CONF_DIGITS:
+               ret = hp_3478a_get_status_bytes(sdi);
+               if (ret != SR_OK)
+                       return ret;
+               *data = g_variant_new_string(digits_map[devc->spec_digits]);
+               break;
        default:
                return SR_ERR_NA;
        }
@@ -149,10 +241,13 @@ static int config_set(uint32_t key, GVariant *data,
        enum sr_mq mq;
        enum sr_mqflag mq_flags;
        GVariant *tuple_child;
+       unsigned int i;
+       const char *range_str;
+       const char *digits_str;
 
        (void)cg;
 
-       devc = sdi->priv;
+       devc = sdi ? sdi->priv : NULL;
 
        switch (key) {
        case SR_CONF_LIMIT_SAMPLES:
@@ -161,10 +256,28 @@ static int config_set(uint32_t key, GVariant *data,
        case SR_CONF_MEASURED_QUANTITY:
                tuple_child = g_variant_get_child_value(data, 0);
                mq = g_variant_get_uint32(tuple_child);
+               g_variant_unref(tuple_child);
                tuple_child = g_variant_get_child_value(data, 1);
                mq_flags = g_variant_get_uint64(tuple_child);
                g_variant_unref(tuple_child);
                return hp_3478a_set_mq(sdi, mq, mq_flags);
+       case SR_CONF_RANGE:
+               range_str = g_variant_get_string(data, NULL);
+               for (i = 0; i < ARRAY_SIZE(rangeopts); i++) {
+                       if (rangeopts[i].mq == devc->measurement_mq &&
+                                       rangeopts[i].mqflag == devc->measurement_mq_flag &&
+                                       g_strcmp0(rangeopts[i].range_str, range_str) == 0) {
+                               return hp_3478a_set_range(sdi, rangeopts[i].range_exp);
+                       }
+               }
+               return SR_ERR_NA;
+       case SR_CONF_DIGITS:
+               digits_str = g_variant_get_string(data, NULL);
+               for (i = 0; i < ARRAY_SIZE(rangeopts); i++) {
+                       if (g_strcmp0(digits_map[i], digits_str) == 0)
+                               return hp_3478a_set_digits(sdi, i);
+               }
+               return SR_ERR_NA;
        default:
                return SR_ERR_NA;
        }
@@ -175,10 +288,14 @@ static int config_set(uint32_t key, GVariant *data,
 static int config_list(uint32_t key, GVariant **data,
        const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
 {
+       struct dev_context *devc;
+       int ret;
        unsigned int i;
        GVariant *gvar, *arr[2];
        GVariantBuilder gvb;
 
+       devc = sdi ? sdi->priv : NULL;
+
        switch (key) {
        case SR_CONF_SCAN_OPTIONS:
        case SR_CONF_DEVICE_OPTIONS:
@@ -197,6 +314,22 @@ static int config_list(uint32_t key, GVariant **data,
                }
                *data = g_variant_builder_end(&gvb);
                break;
+       case SR_CONF_RANGE:
+               ret = hp_3478a_get_status_bytes(sdi);
+               if (ret != SR_OK)
+                       return ret;
+               g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
+               for (i = 0; i < ARRAY_SIZE(rangeopts); i++) {
+                       if (rangeopts[i].mq == devc->measurement_mq &&
+                                       rangeopts[i].mqflag == devc->measurement_mq_flag) {
+                               g_variant_builder_add(&gvb, "s", rangeopts[i].range_str);
+                       }
+               }
+               *data = g_variant_builder_end(&gvb);
+               break;
+       case SR_CONF_DIGITS:
+               *data = g_variant_new_strv(ARRAY_AND_SIZE(digits));
+               break;
        default:
                return SR_ERR_NA;
        }
@@ -206,7 +339,6 @@ static int config_list(uint32_t key, GVariant **data,
 
 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
 {
-       int ret;
        struct sr_scpi_dev_inst *scpi;
        struct dev_context *devc;
 
@@ -220,7 +352,7 @@ static int dev_acquisition_start(const struct sr_dev_inst *sdi)
         * NOTE: For faster readings, there are some things one can do:
         *     - Turn off the display: sr_scpi_send(scpi, "D3SIGROK").
         *     - Set the line frequency to 60Hz via switch (back of the unit).
-        *     - Set to 3.5 digits measurement (add config key SR_CONF_DIGITS).
+        *     - Set to 3.5 digits measurement.
         */
 
        /* Set to internal trigger. */
@@ -249,7 +381,7 @@ static int dev_acquisition_stop(struct sr_dev_inst *sdi)
        return SR_OK;
 }
 
-SR_PRIV struct sr_dev_driver hp_3478a_driver_info = {
+static struct sr_dev_driver hp_3478a_driver_info = {
        .name = "hp-3478a",
        .longname = "HP 3478A",
        .api_version = 1,
@@ -267,5 +399,4 @@ SR_PRIV struct sr_dev_driver hp_3478a_driver_info = {
        .dev_acquisition_stop = dev_acquisition_stop,
        .context = NULL,
 };
-
 SR_REGISTER_DEV_DRIVER(hp_3478a_driver_info);