]> sigrok.org Git - libsigrok.git/blobdiff - hardware/uni-t-dmm/api.c
build: Portability fixes.
[libsigrok.git] / hardware / uni-t-dmm / api.c
index 7c4c6b89cd3cf5a8d109621971706b85c8911067..f98c4f5e39e32654fc2fd3e87a1b99577e2dab7e 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 tecpel_dmm_8061_driver_info;
+SR_PRIV struct sr_dev_driver uni_t_ut60a_driver_info;
+SR_PRIV struct sr_dev_driver uni_t_ut60e_driver_info;
+SR_PRIV struct sr_dev_driver uni_t_ut60g_driver_info;
+SR_PRIV struct sr_dev_driver uni_t_ut61b_driver_info;
+SR_PRIV struct sr_dev_driver uni_t_ut61c_driver_info;
 SR_PRIV struct sr_dev_driver uni_t_ut61d_driver_info;
+SR_PRIV struct sr_dev_driver uni_t_ut61e_driver_info;
 SR_PRIV struct sr_dev_driver voltcraft_vc820_driver_info;
+SR_PRIV struct sr_dev_driver voltcraft_vc830_driver_info;
+SR_PRIV struct sr_dev_driver voltcraft_vc840_driver_info;
+SR_PRIV struct sr_dev_driver tenma_72_7745_driver_info;
+SR_PRIV struct sr_dev_driver tenma_72_7750_driver_info;
+
+SR_PRIV struct dmm_info udmms[] = {
+       {
+               "Tecpel", "DMM-8061", 2400,
+               FS9721_PACKET_SIZE,
+               sr_fs9721_packet_valid, sr_fs9721_parse,
+               sr_fs9721_00_temp_c,
+               &tecpel_dmm_8061_driver_info, receive_data_TECPEL_DMM_8061,
+       },
+       {
+               "UNI-T", "UT60A", 2400,
+               FS9721_PACKET_SIZE,
+               sr_fs9721_packet_valid, sr_fs9721_parse,
+               NULL,
+               &uni_t_ut60a_driver_info, receive_data_UNI_T_UT60A,
+       },
+       {
+               "UNI-T", "UT60E", 2400,
+               FS9721_PACKET_SIZE,
+               sr_fs9721_packet_valid, sr_fs9721_parse,
+               sr_fs9721_00_temp_c,
+               &uni_t_ut60e_driver_info, receive_data_UNI_T_UT60E,
+       },
+       {
+               /* The baudrate is actually 19230, see "Note 1" below. */
+               "UNI-T", "UT60G", 19200,
+               ES519XX_11B_PACKET_SIZE,
+               sr_es519xx_19200_11b_packet_valid, sr_es519xx_19200_11b_parse,
+               NULL,
+               &uni_t_ut60g_driver_info, receive_data_UNI_T_UT60G,
+       },
+       {
+               "UNI-T", "UT61B", 2400,
+               FS9922_PACKET_SIZE,
+               sr_fs9922_packet_valid, sr_fs9922_parse,
+               NULL,
+               &uni_t_ut61b_driver_info, receive_data_UNI_T_UT61B,
+       },
+       {
+               "UNI-T", "UT61C", 2400,
+               FS9922_PACKET_SIZE,
+               sr_fs9922_packet_valid, sr_fs9922_parse,
+               NULL,
+               &uni_t_ut61c_driver_info, receive_data_UNI_T_UT61C,
+       },
+       {
+               "UNI-T", "UT61D", 2400,
+               FS9922_PACKET_SIZE,
+               sr_fs9922_packet_valid, sr_fs9922_parse,
+               NULL,
+               &uni_t_ut61d_driver_info, receive_data_UNI_T_UT61D,
+       },
+       {
+               /* The baudrate is actually 19230, see "Note 1" below. */
+               "UNI-T", "UT61E", 19200,
+               ES519XX_14B_PACKET_SIZE,
+               sr_es519xx_19200_14b_packet_valid, sr_es519xx_19200_14b_parse,
+               NULL,
+               &uni_t_ut61e_driver_info, receive_data_UNI_T_UT61E,
+       },
+       {
+               "Voltcraft", "VC-820", 2400,
+               FS9721_PACKET_SIZE,
+               sr_fs9721_packet_valid, sr_fs9721_parse,
+               NULL,
+               &voltcraft_vc820_driver_info, receive_data_VOLTCRAFT_VC820,
+       },
+       {
+               /*
+                * Note: The VC830 doesn't set the 'volt' and 'diode' bits of
+                * the FS9922 protocol. Instead, it only sets the user-defined
+                * bit "z1" to indicate "diode mode" and "voltage".
+                */
+               "Voltcraft", "VC-830", 2400,
+               FS9922_PACKET_SIZE,
+               sr_fs9922_packet_valid, sr_fs9922_parse,
+               &sr_fs9922_z1_diode,
+               &voltcraft_vc830_driver_info, receive_data_VOLTCRAFT_VC830,
+       },
+       {
+               "Voltcraft", "VC-840", 2400,
+               FS9721_PACKET_SIZE,
+               sr_fs9721_packet_valid, sr_fs9721_parse,
+               sr_fs9721_00_temp_c,
+               &voltcraft_vc840_driver_info, receive_data_VOLTCRAFT_VC840,
+       },
+       {
+               "Tenma", "72-7745", 2400,
+               FS9721_PACKET_SIZE,
+               sr_fs9721_packet_valid, sr_fs9721_parse,
+               sr_fs9721_00_temp_c,
+               &tenma_72_7745_driver_info, receive_data_TENMA_72_7745,
+       },
+       {
+               /* The baudrate is actually 19230, see "Note 1" below. */
+               "Tenma", "72-7750", 19200,
+               ES519XX_11B_PACKET_SIZE,
+               sr_es519xx_19200_11b_packet_valid, sr_es519xx_19200_11b_parse,
+               NULL,
+               &tenma_72_7750_driver_info, receive_data_TENMA_72_7750,
+       },
+};
 
-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;
-
-static int clear_instances(void)
-{
-       /* TODO: Use common code later. */
-
-       return SR_OK;
-}
+/*
+ * Note 1: The actual baudrate of the Cyrustek ES519xx chip used in this DMM
+ * is 19230. However, the WCH CH9325 chip (UART to USB/HID) used in (some
+ * versions of) the UNI-T UT-D04 cable doesn't support 19230 baud. It only
+ * supports 19200, and setting an unsupported baudrate will result in the
+ * default of 2400 being used (which will not work with this DMM, of course).
+ */
 
-static int hw_init(struct sr_context *sr_ctx, int dmm)
+static int dev_clear(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;
-
-       return SR_OK;
+       return std_dev_clear(udmms[dmm].di, NULL);
 }
 
-static int hw_init_ut61d(struct sr_context *sr_ctx)
+static int init(struct sr_context *sr_ctx, int dmm)
 {
-       return hw_init(sr_ctx, UNI_T_UT61D);
-}
+       sr_dbg("Selected '%s' subdriver.", udmms[dmm].di->name);
 
-static int hw_init_vc820(struct sr_context *sr_ctx)
-{
-       return hw_init(sr_ctx, VOLTCRAFT_VC820);
+       return std_init(sr_ctx, udmms[dmm].di, LOG_PREFIX);
 }
 
-static GSList *hw_scan(GSList *options)
+static GSList *scan(GSList *options, int dmm)
 {
        GSList *usb_devices, *devices, *l;
        struct sr_dev_inst *sdi;
@@ -94,27 +181,22 @@ static GSList *hw_scan(GSList *options)
        struct drv_context *drvc;
        struct sr_usb_dev_inst *usb;
        struct sr_config *src;
-       struct sr_probe *probe;
+       struct sr_channel *ch;
        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;
                }
        }
        if (!conn)
-               conn = UNI_T_UT_D04_NEW;
+               return NULL;
 
        devices = NULL;
        if (!(usb_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, conn))) {
@@ -130,18 +212,21 @@ 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;
-               if (!(probe = sr_probe_new(0, SR_PROBE_ANALOG, TRUE, "P1")))
+               sdi->driver = udmms[dmm].di;
+               if (!(ch = sr_channel_new(0, SR_CHANNEL_ANALOG, TRUE, "P1")))
                        return NULL;
-               sdi->probes = g_slist_append(sdi->probes, probe);
+               sdi->channels = g_slist_append(sdi->channels, ch);
 
-               devc->usb = usb;
+               sdi->inst_type = SR_INST_USB;
+               sdi->conn = usb;
 
                drvc->instances = g_slist_append(drvc->instances, sdi);
                devices = g_slist_append(devices, sdi);
@@ -150,203 +235,190 @@ static GSList *hw_scan(GSList *options)
        return devices;
 }
 
-static GSList *hw_dev_list(void)
+static GSList *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 dev_open(struct sr_dev_inst *sdi, int dmm)
 {
        struct drv_context *drvc;
-       struct dev_context *devc;
+       struct sr_usb_dev_inst *usb;
+       int ret;
 
-       drvc = di->priv;
-       devc = sdi->priv;
+       drvc = udmms[dmm].di->priv;
+       usb = sdi->conn;
+
+       if ((ret = sr_usb_open(drvc->sr_ctx->libusb_ctx, usb)) == SR_OK)
+               sdi->status = SR_ST_ACTIVE;
 
-       return sr_usb_open(drvc->sr_ctx->libusb_ctx, devc->usb);
+       return ret;
 }
 
-static int hw_dev_close(struct sr_dev_inst *sdi)
+static int dev_close(struct sr_dev_inst *sdi)
 {
-       (void)sdi;
-
        /* TODO */
 
-       return SR_OK;
-}
-
-static int hw_cleanup(void)
-{
-       clear_instances();
+       sdi->status = SR_ST_INACTIVE;
 
        return SR_OK;
 }
 
-static int config_get(int id, const void **data, const struct sr_dev_inst *sdi)
+static int cleanup(int dmm)
 {
-       (void)sdi;
-
-       sr_spew("Backend requested info_id %d.", id);
-
-       switch (id) {
-       case SR_DI_HWOPTS:
-               *data = hwopts;
-               break;
-       case SR_DI_HWCAPS:
-               *data = hwcaps;
-               sr_spew("%s: Returning hwcaps.", __func__);
-               break;
-       case SR_CONF_SAMPLERATE:
-               /* TODO: Get rid of this. */
-               *data = NULL;
-               sr_spew("%s: Returning current samplerate.", __func__);
-               return SR_ERR_ARG;
-               break;
-       default:
-               return SR_ERR_ARG;
-               break;
-       }
-
-       return SR_OK;
+       return dev_clear(dmm);
 }
 
-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,
+               const struct sr_channel_group *cg)
 {
        struct dev_context *devc;
 
+       (void)cg;
+
        devc = sdi->priv;
 
        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,
+               const struct sr_channel_group *cg)
 {
-
        (void)sdi;
+       (void)cg;
 
        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:
-               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)
+static int dev_acquisition_start(const struct sr_dev_inst *sdi,
+                                   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;
 
+       devc->starttime = g_get_monotonic_time();
+
        /* 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(sdi, LOG_PREFIX);
+
+       sr_session_source_add(sdi->session, 0, 0, 10 /* poll_timeout */,
+                     udmms[dmm].receive_data, (void *)sdi);
 
        return SR_OK;
 }
 
-static int hw_dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
+static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
 {
        struct sr_datafeed_packet packet;
 
-       (void)sdi;
+       (void)cb_data;
 
        sr_dbg("Stopping acquisition.");
 
        /* Send end packet to the session bus. */
        sr_dbg("Sending SR_DF_END.");
        packet.type = SR_DF_END;
-       sr_session_send(cb_data, &packet);
+       sr_session_send(sdi, &packet);
 
-       /* TODO? */
-       sr_source_remove(0);
+       sr_session_source_remove(sdi->session, 0);
 
        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_get = config_get,
-       .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 init_##X(struct sr_context *sr_ctx) { return init(sr_ctx, X); }
+#define HW_CLEANUP(X) \
+static int cleanup_##X(void) { return cleanup(X); }
+#define HW_SCAN(X) \
+static GSList *scan_##X(GSList *options) { return scan(options, X); }
+#define HW_DEV_LIST(X) \
+static GSList *dev_list_##X(void) { return dev_list(X); }
+#define HW_DEV_CLEAR(X) \
+static int dev_clear_##X(void) { return dev_clear(X); }
+#define HW_DEV_ACQUISITION_START(X) \
+static int dev_acquisition_start_##X(const struct sr_dev_inst *sdi, \
+void *cb_data) { return dev_acquisition_start(sdi, cb_data, X); }
+#define HW_DEV_OPEN(X) \
+static int dev_open_##X(struct sr_dev_inst *sdi) { return 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) \
+HW_DEV_CLEAR(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 = init_##ID_UPPER, \
+       .cleanup = cleanup_##ID_UPPER, \
+       .scan = scan_##ID_UPPER, \
+       .dev_list = dev_list_##ID_UPPER, \
+       .dev_clear = dev_clear_##ID_UPPER, \
+       .config_get = NULL, \
+       .config_set = config_set, \
+       .config_list = config_list, \
+       .dev_open = dev_open_##ID_UPPER, \
+       .dev_close = dev_close, \
+       .dev_acquisition_start = dev_acquisition_start_##ID_UPPER, \
+       .dev_acquisition_stop = 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_get = config_get,
-       .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(tecpel_dmm_8061, TECPEL_DMM_8061, "tecpel-dmm-8061", "Tecpel DMM-8061")
+DRV(uni_t_ut60a, UNI_T_UT60A, "uni-t-ut60a", "UNI-T UT60A")
+DRV(uni_t_ut60e, UNI_T_UT60E, "uni-t-ut60e", "UNI-T UT60E")
+DRV(uni_t_ut60g, UNI_T_UT60G, "uni-t-ut60g", "UNI-T UT60G")
+DRV(uni_t_ut61b, UNI_T_UT61B, "uni-t-ut61b", "UNI-T UT61B")
+DRV(uni_t_ut61c, UNI_T_UT61C, "uni-t-ut61c", "UNI-T UT61C")
+DRV(uni_t_ut61d, UNI_T_UT61D, "uni-t-ut61d", "UNI-T UT61D")
+DRV(uni_t_ut61e, UNI_T_UT61E, "uni-t-ut61e", "UNI-T UT61E")
+DRV(voltcraft_vc820, VOLTCRAFT_VC820, "voltcraft-vc820", "Voltcraft VC-820")
+DRV(voltcraft_vc830, VOLTCRAFT_VC830, "voltcraft-vc830", "Voltcraft VC-830")
+DRV(voltcraft_vc840, VOLTCRAFT_VC840, "voltcraft-vc840", "Voltcraft VC-840")
+DRV(tenma_72_7745, TENMA_72_7745, "tenma-72-7745", "Tenma 72-7745")
+DRV(tenma_72_7750, TENMA_72_7750, "tenma-72-7750", "Tenma 72-7750")