]> sigrok.org Git - libsigrok.git/blobdiff - hardware/uni-t-dmm/api.c
Don't automatically clear known instances from USB drivers on scan
[libsigrok.git] / hardware / uni-t-dmm / api.c
index 26b3e16e7a8fe6327cd8dd2f43f62fb32747de66..08a9e74725f4b4824987264231068443f04cf142 100644 (file)
@@ -1,7 +1,7 @@
 /*
- * This file is part of the sigrok project.
+ * This file is part of the libsigrok project.
  *
- * Copyright (C) 2012 Uwe Hermann <uwe@hermann-uwe.de>
+ * Copyright (C) 2012-2013 Uwe Hermann <uwe@hermann-uwe.de>
  *
  * 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
 
 #define UNI_T_UT_D04_NEW "1a86.e008"
 
-static const int hwopts[] = {
+static const int32_t hwopts[] = {
        SR_CONF_CONN,
-       0,
 };
 
-static const int hwcaps[] = {
+static const int32_t hwcaps[] = {
        SR_CONF_MULTIMETER,
        SR_CONF_LIMIT_SAMPLES,
        SR_CONF_LIMIT_MSEC,
        SR_CONF_CONTINUOUS,
-       0,
 };
 
 SR_PRIV struct sr_dev_driver uni_t_ut61d_driver_info;
 SR_PRIV struct sr_dev_driver voltcraft_vc820_driver_info;
 
-static struct sr_dev_driver *di_ut61d = &uni_t_ut61d_driver_info;
-static struct sr_dev_driver *di_vc820 = &voltcraft_vc820_driver_info;
-
-/* After hw_init() this will point to a device-specific entry (see above). */
-static struct sr_dev_driver *di = NULL;
+SR_PRIV struct dmm_info udmms[] = {
+       {
+               "UNI-T", "UT61D", 19230,
+               FS9922_PACKET_SIZE, NULL,
+               sr_fs9922_packet_valid, sr_fs9922_parse,
+               NULL,
+               &uni_t_ut61d_driver_info, receive_data_UNI_T_UT61D,
+       },
+       {
+               "Voltcraft", "VC-820", 2400,
+               FS9721_PACKET_SIZE, NULL,
+               sr_fs9721_packet_valid, sr_fs9721_parse,
+               NULL,
+               &voltcraft_vc820_driver_info, receive_data_VOLTCRAFT_VC820,
+       },
+};
 
-static int clear_instances(void)
+static int clear_instances(int dmm)
 {
+       (void)dmm;
+
        /* TODO: Use common code later. */
 
        return SR_OK;
@@ -57,36 +68,12 @@ static int clear_instances(void)
 
 static int hw_init(struct sr_context *sr_ctx, int dmm)
 {
-       struct drv_context *drvc;
-
-       if (!(drvc = g_try_malloc0(sizeof(struct drv_context)))) {
-               sr_err("Driver context malloc failed.");
-               return SR_ERR_MALLOC;
-       }
-
-       if (dmm == UNI_T_UT61D)
-               di = di_ut61d;
-       else if (dmm == VOLTCRAFT_VC820)
-               di = di_vc820;
-       sr_dbg("Selected '%s' subdriver.", di->name);
-
-       drvc->sr_ctx = sr_ctx;
-       di->priv = drvc;
+       sr_dbg("Selected '%s' subdriver.", udmms[dmm].di->name);
 
-       return SR_OK;
-}
-
-static int hw_init_ut61d(struct sr_context *sr_ctx)
-{
-       return hw_init(sr_ctx, UNI_T_UT61D);
-}
-
-static int hw_init_vc820(struct sr_context *sr_ctx)
-{
-       return hw_init(sr_ctx, VOLTCRAFT_VC820);
+       return std_hw_init(sr_ctx, udmms[dmm].di, DRIVER_LOG_DOMAIN);
 }
 
-static GSList *hw_scan(GSList *options)
+static GSList *hw_scan(GSList *options, int dmm)
 {
        GSList *usb_devices, *devices, *l;
        struct sr_dev_inst *sdi;
@@ -97,19 +84,14 @@ static GSList *hw_scan(GSList *options)
        struct sr_probe *probe;
        const char *conn;
 
-       (void)options;
-
-       drvc = di->priv;
-
-       /* USB scan is always authoritative. */
-       clear_instances();
+       drvc = udmms[dmm].di->priv;
 
        conn = NULL;
        for (l = options; l; l = l->next) {
                src = l->data;
                switch (src->key) {
                case SR_CONF_CONN:
-                       conn = src->value;
+                       conn = g_variant_get_string(src->data, NULL);
                        break;
                }
        }
@@ -130,13 +112,15 @@ static GSList *hw_scan(GSList *options)
                        return NULL;
                }
 
+               devc->first_run = TRUE;
+
                if (!(sdi = sr_dev_inst_new(0, SR_ST_INACTIVE,
-                               di->longname, NULL, NULL))) {
+                               udmms[dmm].vendor, udmms[dmm].device, NULL))) {
                        sr_err("sr_dev_inst_new returned NULL.");
                        return NULL;
                }
                sdi->priv = devc;
-               sdi->driver = di;
+               sdi->driver = udmms[dmm].di;
                if (!(probe = sr_probe_new(0, SR_PROBE_ANALOG, TRUE, "P1")))
                        return NULL;
                sdi->probes = g_slist_append(sdi->probes, probe);
@@ -150,24 +134,24 @@ static GSList *hw_scan(GSList *options)
        return devices;
 }
 
-static GSList *hw_dev_list(void)
+static GSList *hw_dev_list(int dmm)
 {
-       struct drv_context *drvc;
-
-       drvc = di->priv;
-
-       return drvc->instances;
+       return ((struct drv_context *)(udmms[dmm].di->priv))->instances;
 }
 
-static int hw_dev_open(struct sr_dev_inst *sdi)
+static int hw_dev_open(struct sr_dev_inst *sdi, int dmm)
 {
        struct drv_context *drvc;
        struct dev_context *devc;
+       int ret;
 
-       drvc = di->priv;
+       drvc = udmms[dmm].di->priv;
        devc = sdi->priv;
 
-       return sr_usb_open(drvc->sr_ctx->libusb_ctx, devc->usb);
+       if ((ret = sr_usb_open(drvc->sr_ctx->libusb_ctx, devc->usb)) == SR_OK)
+               sdi->status = SR_ST_ACTIVE;
+
+       return ret;
 }
 
 static int hw_dev_close(struct sr_dev_inst *sdi)
@@ -176,17 +160,19 @@ static int hw_dev_close(struct sr_dev_inst *sdi)
 
        /* TODO */
 
+       sdi->status = SR_ST_INACTIVE;
+
        return SR_OK;
 }
 
-static int hw_cleanup(void)
+static int hw_cleanup(int dmm)
 {
-       clear_instances();
+       clear_instances(dmm);
 
        return SR_OK;
 }
 
-static int config_set(int id, const void *value, const struct sr_dev_inst *sdi)
+static int config_set(int id, GVariant *data, const struct sr_dev_inst *sdi)
 {
        struct dev_context *devc;
 
@@ -195,79 +181,64 @@ static int config_set(int id, const void *value, const struct sr_dev_inst *sdi)
        switch (id) {
        case SR_CONF_LIMIT_MSEC:
                /* TODO: Not yet implemented. */
-               if (*(const uint64_t *)value == 0) {
+               if (g_variant_get_uint64(data) == 0) {
                        sr_err("Time limit cannot be 0.");
                        return SR_ERR;
                }
-               devc->limit_msec = *(const uint64_t *)value;
+               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:
-               if (*(const uint64_t *)value == 0) {
+               if (g_variant_get_uint64(data) == 0) {
                        sr_err("Sample limit cannot be 0.");
                        return SR_ERR;
                }
-               devc->limit_samples = *(const uint64_t *)value;
+               devc->limit_samples = g_variant_get_uint64(data);
                sr_dbg("Setting sample limit to %" PRIu64 ".",
                       devc->limit_samples);
                break;
        default:
-               sr_err("Unknown capability: %d.", id);
-               return SR_ERR;
-               break;
+               return SR_ERR_NA;
        }
 
        return SR_OK;
 }
 
-static int config_list(int key, const void **data, const struct sr_dev_inst *sdi)
+static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi)
 {
-
        (void)sdi;
 
        switch (key) {
        case SR_CONF_SCAN_OPTIONS:
-               *data = hwopts;
+               *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
+                               hwopts, ARRAY_SIZE(hwopts), sizeof(int32_t));
                break;
        case SR_CONF_DEVICE_OPTIONS:
-               *data = hwcaps;
+               *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
+                               hwcaps, ARRAY_SIZE(hwcaps), sizeof(int32_t));
                break;
        default:
-               return SR_ERR_ARG;
+               return SR_ERR_NA;
        }
 
        return SR_OK;
 }
 
 static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
-                                   void *cb_data)
+                                   void *cb_data, int dmm)
 {
-       struct sr_datafeed_packet packet;
-       struct sr_datafeed_header header;
        struct dev_context *devc;
 
        devc = sdi->priv;
 
-       sr_dbg("Starting acquisition.");
-
        devc->cb_data = cb_data;
 
        /* Send header packet to the session bus. */
-       sr_dbg("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);
-
-       if (!strcmp(di->name, "uni-t-ut61d")) {
-               sr_source_add(0, 0, 10 /* poll_timeout */,
-                             uni_t_ut61d_receive_data, (void *)sdi);
-       } else if (!strcmp(di->name, "voltcraft-vc820")) {
-               sr_source_add(0, 0, 10 /* poll_timeout */,
-                             voltcraft_vc820_receive_data, (void *)sdi);
-       }
+       std_session_send_df_header(cb_data, DRIVER_LOG_DOMAIN);
+
+       sr_source_add(0, 0, 10 /* poll_timeout */,
+                     udmms[dmm].receive_data, (void *)sdi);
 
        return SR_OK;
 }
@@ -291,38 +262,50 @@ static int hw_dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
        return SR_OK;
 }
 
-SR_PRIV struct sr_dev_driver uni_t_ut61d_driver_info = {
-       .name = "uni-t-ut61d",
-       .longname = "UNI-T UT61D",
-       .api_version = 1,
-       .init = hw_init_ut61d,
-       .cleanup = hw_cleanup,
-       .scan = hw_scan,
-       .dev_list = hw_dev_list,
-       .dev_clear = clear_instances,
-       .config_set = config_set,
-       .config_list = config_list,
-       .dev_open = hw_dev_open,
-       .dev_close = hw_dev_close,
-       .dev_acquisition_start = hw_dev_acquisition_start,
-       .dev_acquisition_stop = hw_dev_acquisition_stop,
-       .priv = NULL,
+/* Driver-specific API function wrappers */
+#define HW_INIT(X) \
+static int hw_init_##X(struct sr_context *sr_ctx) { return hw_init(sr_ctx, X); }
+#define HW_CLEANUP(X) \
+static int hw_cleanup_##X(void) { return hw_cleanup(X); }
+#define HW_SCAN(X) \
+static GSList *hw_scan_##X(GSList *options) { return hw_scan(options, X); }
+#define HW_DEV_LIST(X) \
+static GSList *hw_dev_list_##X(void) { return hw_dev_list(X); }
+#define CLEAR_INSTANCES(X) \
+static int clear_instances_##X(void) { return clear_instances(X); }
+#define HW_DEV_ACQUISITION_START(X) \
+static int hw_dev_acquisition_start_##X(const struct sr_dev_inst *sdi, \
+void *cb_data) { return hw_dev_acquisition_start(sdi, cb_data, X); }
+#define HW_DEV_OPEN(X) \
+static int hw_dev_open_##X(struct sr_dev_inst *sdi) { return hw_dev_open(sdi, X); }
+
+/* Driver structs and API function wrappers */
+#define DRV(ID, ID_UPPER, NAME, LONGNAME) \
+HW_INIT(ID_UPPER) \
+HW_CLEANUP(ID_UPPER) \
+HW_SCAN(ID_UPPER) \
+HW_DEV_LIST(ID_UPPER) \
+CLEAR_INSTANCES(ID_UPPER) \
+HW_DEV_ACQUISITION_START(ID_UPPER) \
+HW_DEV_OPEN(ID_UPPER) \
+SR_PRIV struct sr_dev_driver ID##_driver_info = { \
+       .name = NAME, \
+       .longname = LONGNAME, \
+       .api_version = 1, \
+       .init = hw_init_##ID_UPPER, \
+       .cleanup = hw_cleanup_##ID_UPPER, \
+       .scan = hw_scan_##ID_UPPER, \
+       .dev_list = hw_dev_list_##ID_UPPER, \
+       .dev_clear = clear_instances_##ID_UPPER, \
+       .config_get = NULL, \
+       .config_set = config_set, \
+       .config_list = config_list, \
+       .dev_open = hw_dev_open_##ID_UPPER, \
+       .dev_close = hw_dev_close, \
+       .dev_acquisition_start = hw_dev_acquisition_start_##ID_UPPER, \
+       .dev_acquisition_stop = hw_dev_acquisition_stop, \
+       .priv = NULL, \
 };
 
-SR_PRIV struct sr_dev_driver voltcraft_vc820_driver_info = {
-       .name = "voltcraft-vc820",
-       .longname = "Voltcraft VC-820",
-       .api_version = 1,
-       .init = hw_init_vc820,
-       .cleanup = hw_cleanup,
-       .scan = hw_scan,
-       .dev_list = hw_dev_list,
-       .dev_clear = clear_instances,
-       .config_set = config_set,
-       .config_list = config_list,
-       .dev_open = hw_dev_open,
-       .dev_close = hw_dev_close,
-       .dev_acquisition_start = hw_dev_acquisition_start,
-       .dev_acquisition_stop = hw_dev_acquisition_stop,
-       .priv = NULL,
-};
+DRV(uni_t_ut61d, UNI_T_UT61D, "uni-t-ut61d", "UNI-T UT61D")
+DRV(voltcraft_vc820, VOLTCRAFT_VC820, "voltcraft-vc820", "Voltcraft VC-820")