]> sigrok.org Git - libsigrok.git/blobdiff - src/hardware/chronovu-la/api.c
Drop unneeded std_session_send_df_header() comments.
[libsigrok.git] / src / hardware / chronovu-la / api.c
index 5a8a3d36c959a1c4b06c7411a07e01508d6907fe..4ea1440af6f18f0d7cc93afc66fde35b395c69ed 100644 (file)
@@ -1,7 +1,7 @@
 /*
  * This file is part of the libsigrok project.
  *
- * Copyright (C) 2011-2014 Uwe Hermann <uwe@hermann-uwe.de>
+ * Copyright (C) 2011-2015 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
  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  */
 
+#include <config.h>
 #include "protocol.h"
 
 SR_PRIV struct sr_dev_driver chronovu_la_driver_info;
 static struct sr_dev_driver *di = &chronovu_la_driver_info;
 
-static const int32_t hwcaps[] = {
+static const uint32_t drvopts[] = {
        SR_CONF_LOGIC_ANALYZER,
-       SR_CONF_SAMPLERATE,
-       SR_CONF_TRIGGER_MATCH,
-       SR_CONF_LIMIT_MSEC, /* TODO: Not yet implemented. */
-       SR_CONF_LIMIT_SAMPLES, /* TODO: Not yet implemented. */
+};
+
+static const uint32_t scanopts[] = {
+       SR_CONF_CONN,
+};
+
+static const uint32_t devopts[] = {
+       SR_CONF_LIMIT_MSEC | SR_CONF_SET,
+       SR_CONF_LIMIT_SAMPLES | SR_CONF_SET | SR_CONF_LIST,
+       SR_CONF_CONN | SR_CONF_GET,
+       SR_CONF_SAMPLERATE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
+       SR_CONF_TRIGGER_MATCH | SR_CONF_LIST,
 };
 
 static const int32_t trigger_matches[] = {
@@ -38,19 +47,6 @@ static const int32_t trigger_matches[] = {
        SR_TRIGGER_FALLING,
 };
 
-/* The ChronoVu LA8/LA16 can have multiple VID/PID pairs. */
-static struct {
-       uint16_t vid;
-       uint16_t pid;
-       int model;
-       const char *iproduct;
-} vid_pid[] = {
-       { 0x0403, 0x6001, CHRONOVU_LA8,  "ChronoVu LA8"  },
-       { 0x0403, 0x8867, CHRONOVU_LA8,  "ChronoVu LA8"  },
-       { 0x0403, 0x6001, CHRONOVU_LA16, "ChronoVu LA16" },
-       { 0x0403, 0x8867, CHRONOVU_LA16, "ChronoVu LA16" },
-};
-
 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data);
 
 static void clear_helper(void *priv)
@@ -63,31 +59,32 @@ static void clear_helper(void *priv)
        g_free(devc->final_buf);
 }
 
-static int dev_clear(void)
+static int dev_clear(const struct sr_dev_driver *di)
 {
        return std_dev_clear(di, clear_helper);
 }
 
-static int init(struct sr_context *sr_ctx)
+static int init(struct sr_dev_driver *di, struct sr_context *sr_ctx)
 {
        return std_init(sr_ctx, di, LOG_PREFIX);
 }
 
-static int add_device(int idx, int model, GSList **devices)
+static int add_device(int model, struct libusb_device_descriptor *des,
+       const char *serial_num, const char *connection_id,
+       libusb_device *usbdev, GSList **devices)
 {
        int ret;
        unsigned int i;
        struct sr_dev_inst *sdi;
        struct drv_context *drvc;
        struct dev_context *devc;
-       struct sr_channel *ch;
 
        ret = SR_OK;
 
-       drvc = di->priv;
+       drvc = di->context;
 
        /* Allocate memory for our private device context. */
-       devc = g_try_malloc(sizeof(struct dev_context));
+       devc = g_malloc0(sizeof(struct dev_context));
 
        /* Set some sane defaults. */
        devc->prof = &cv_profiles[model];
@@ -105,8 +102,8 @@ static int add_device(int idx, int model, GSList **devices)
        devc->done = 0;
        devc->block_counter = 0;
        devc->divcount = 0;
-       devc->usb_vid = vid_pid[idx].vid;
-       devc->usb_pid = vid_pid[idx].pid;
+       devc->usb_vid = des->idVendor;
+       devc->usb_pid = des->idProduct;
        memset(devc->samplerates, 0, sizeof(uint64_t) * 255);
 
        /* Allocate memory where we'll store the de-mangled data. */
@@ -120,89 +117,138 @@ static int add_device(int idx, int model, GSList **devices)
        devc->cur_samplerate = devc->prof->max_samplerate;
 
        /* Register the device with libsigrok. */
-       sdi = sr_dev_inst_new(0, SR_ST_INITIALIZING,
-                             "ChronoVu", devc->prof->modelname, NULL);
-       if (!sdi) {
-               sr_err("Failed to create device instance.");
-               ret = SR_ERR;
-               goto err_free_final_buf;
-       }
+       sdi = g_malloc0(sizeof(struct sr_dev_inst));
+       sdi->status = SR_ST_INITIALIZING;
+       sdi->vendor = g_strdup("ChronoVu");
+       sdi->model = g_strdup(devc->prof->modelname);
+       sdi->serial_num = g_strdup(serial_num);
+       sdi->connection_id = g_strdup(connection_id);
+       sdi->conn = sr_usb_dev_inst_new(libusb_get_bus_number(usbdev),
+               libusb_get_device_address(usbdev), NULL);
        sdi->driver = di;
        sdi->priv = devc;
 
-       for (i = 0; i < devc->prof->num_channels; i++) {
-               if (!(ch = sr_channel_new(i, SR_CHANNEL_LOGIC, TRUE,
-                                         cv_channel_names[i]))) {
-                       ret = SR_ERR;
-                       goto err_free_dev_inst;
-               }
-               sdi->channels = g_slist_append(sdi->channels, ch);
-       }
+       for (i = 0; i < devc->prof->num_channels; i++)
+               sr_channel_new(sdi, i, SR_CHANNEL_LOGIC, TRUE,
+                               cv_channel_names[i]);
 
        *devices = g_slist_append(*devices, sdi);
        drvc->instances = g_slist_append(drvc->instances, sdi);
 
-       return SR_OK;
+       if (ret == SR_OK)
+               return SR_OK;
 
-err_free_dev_inst:
-       sr_dev_inst_free(sdi);
-err_free_final_buf:
-       g_free(devc->final_buf);
 err_free_devc:
        g_free(devc);
 
        return ret;
 }
 
-static GSList *scan(GSList *options)
+static GSList *scan(struct sr_dev_driver *di, GSList *options)
 {
-       int ret;
-       unsigned int i;
-       GSList *devices;
-       struct ftdi_context *ftdic;
-
-       (void)options;
+       int i, ret, model;
+       struct drv_context *drvc;
+       GSList *devices, *conn_devices, *l;
+       struct sr_usb_dev_inst *usb;
+       struct sr_config *src;
+       struct libusb_device_descriptor des;
+       libusb_device **devlist;
+       struct libusb_device_handle *hdl;
+       const char *conn;
+       char product[64], serial_num[64], connection_id[64];
+
+       drvc = di->context;
+       drvc->instances = NULL;
+
+       conn = 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;
+               }
+       }
+       if (conn)
+               conn_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, conn);
+       else
+               conn_devices = NULL;
 
        devices = NULL;
+       libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
+
+       for (i = 0; devlist[i]; i++) {
+               if (conn) {
+                       for (l = conn_devices; l; l = l->next) {
+                               usb = l->data;
+                               if (usb->bus == libusb_get_bus_number(devlist[i])
+                                       && usb->address == libusb_get_device_address(devlist[i]))
+                                       break;
+                       }
+                       if (!l)
+                               /* This device matched none of the ones that
+                                * matched the conn specification. */
+                               continue;
+               }
 
-       /* Allocate memory for the FTDI context and initialize it. */
-       if (!(ftdic = ftdi_new())) {
-               sr_err("Failed to initialize libftdi.");
-               return NULL;
-       }
+               libusb_get_device_descriptor(devlist[i], &des);
 
-       /* Check for LA8 and/or LA16 devices with various VID/PIDs. */
-       for (i = 0; i < ARRAY_SIZE(vid_pid); i++) {
-               ret = ftdi_usb_open_desc(ftdic, vid_pid[i].vid,
-                       vid_pid[i].pid, vid_pid[i].iproduct, NULL);
-               /* Show errors other than "device not found". */
-               if (ret < 0 && ret != -3)
-                       sr_dbg("Error finding/opening device (%d): %s.",
-                              ret, ftdi_get_error_string(ftdic));
-               if (ret < 0)
-                       continue; /* No device found, or not usable. */
-
-               sr_dbg("Found %s device (%04x:%04x).",
-                      vid_pid[i].iproduct, vid_pid[i].vid, vid_pid[i].pid);
-
-               if ((ret = add_device(i, vid_pid[i].model, &devices)) < 0)
-                       sr_dbg("Failed to add device: %d.", ret);
+               if ((ret = libusb_open(devlist[i], &hdl)) < 0)
+                       continue;
 
-               if ((ret = ftdi_usb_close(ftdic)) < 0)
-                       sr_dbg("Failed to close FTDI device (%d): %s.",
-                              ret, ftdi_get_error_string(ftdic));
+               if (des.iProduct == 0) {
+                       product[0] = '\0';
+               } else if ((ret = libusb_get_string_descriptor_ascii(hdl,
+                               des.iProduct, (unsigned char *)product,
+                               sizeof(product))) < 0) {
+                       sr_warn("Failed to get product string descriptor: %s.",
+                               libusb_error_name(ret));
+                       continue;
+               }
+
+               if (des.iSerialNumber == 0) {
+                       serial_num[0] = '\0';
+               } else if ((ret = libusb_get_string_descriptor_ascii(hdl,
+                               des.iSerialNumber, (unsigned char *)serial_num,
+                               sizeof(serial_num))) < 0) {
+                       sr_warn("Failed to get serial number string descriptor: %s.",
+                               libusb_error_name(ret));
+                       continue;
+               }
+
+               usb_get_port_path(devlist[i], connection_id, sizeof(connection_id));
+
+               libusb_close(hdl);
+
+               if (!strcmp(product, "ChronoVu LA8")) {
+                       model = 0;
+               } else if (!strcmp(product, "ChronoVu LA16")) {
+                       model = 1;
+               } else {
+                       sr_spew("Unknown iProduct string '%s'.", product);
+                       continue;
+               }
+
+               sr_dbg("Found %s (%04x:%04x, %d.%d, %s).",
+                      product, des.idVendor, des.idProduct,
+                      libusb_get_bus_number(devlist[i]),
+                      libusb_get_device_address(devlist[i]), connection_id);
+
+               if ((ret = add_device(model, &des, serial_num, connection_id,
+                                       devlist[i], &devices)) < 0) {
+                       sr_dbg("Failed to add device: %d.", ret);
+               }
        }
 
-       /* Close USB device, deinitialize and free the FTDI context. */
-       ftdi_free(ftdic);
-       ftdic = NULL;
+       libusb_free_device_list(devlist, 1);
+       g_slist_free_full(conn_devices, (GDestroyNotify)sr_usb_dev_inst_free);
 
        return devices;
 }
 
-static GSList *dev_list(void)
+static GSList *dev_list(const struct sr_dev_driver *di)
 {
-       return ((struct drv_context *)(di->priv))->instances;
+       return ((struct drv_context *)(di->context))->instances;
 }
 
 static int dev_open(struct sr_dev_inst *sdi)
@@ -210,8 +256,6 @@ static int dev_open(struct sr_dev_inst *sdi)
        struct dev_context *devc;
        int ret;
 
-       ret = SR_ERR;
-
        if (!(devc = sdi->priv))
                return SR_ERR_BUG;
 
@@ -254,7 +298,8 @@ static int dev_open(struct sr_dev_inst *sdi)
 
        sdi->status = SR_ST_ACTIVE;
 
-       return SR_OK;
+       if (ret == SR_OK)
+               return SR_OK;
 
 err_ftdi_free:
        ftdi_free(devc->ftdic); /* Close device (if open), free FTDI context. */
@@ -280,19 +325,27 @@ static int dev_close(struct sr_dev_inst *sdi)
        return SR_OK;
 }
 
-static int cleanup(void)
+static int cleanup(const struct sr_dev_driver *di)
 {
-       return dev_clear();
+       return dev_clear(di);
 }
 
-static int config_get(int id, GVariant **data, const struct sr_dev_inst *sdi,
+static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
                const struct sr_channel_group *cg)
 {
        struct dev_context *devc;
+       struct sr_usb_dev_inst *usb;
+       char str[128];
 
        (void)cg;
 
-       switch (id) {
+       switch (key) {
+       case SR_CONF_CONN:
+               if (!sdi || !(usb = sdi->conn))
+                       return SR_ERR_ARG;
+               snprintf(str, 128, "%d.%d", usb->bus, usb->address);
+               *data = g_variant_new_string(str);
+               break;
        case SR_CONF_SAMPLERATE:
                if (!sdi || !(devc = sdi->priv))
                        return SR_ERR_BUG;
@@ -305,7 +358,7 @@ static int config_get(int id, GVariant **data, const struct sr_dev_inst *sdi,
        return SR_OK;
 }
 
-static int config_set(int id, GVariant *data, const struct sr_dev_inst *sdi,
+static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
                const struct sr_channel_group *cg)
 {
        struct dev_context *devc;
@@ -318,7 +371,7 @@ static int config_set(int id, GVariant *data, const struct sr_dev_inst *sdi,
        if (!(devc = sdi->priv))
                return SR_ERR_BUG;
 
-       switch (id) {
+       switch (key) {
        case SR_CONF_SAMPLERATE:
                if (cv_set_samplerate(sdi, g_variant_get_uint64(data)) < 0)
                        return SR_ERR;
@@ -340,7 +393,7 @@ static int config_set(int id, GVariant *data, const struct sr_dev_inst *sdi,
        return SR_OK;
 }
 
-static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi,
+static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
                const struct sr_channel_group *cg)
 {
        GVariant *gvar, *grange[2];
@@ -350,9 +403,17 @@ static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi,
        (void)cg;
 
        switch (key) {
+       case SR_CONF_SCAN_OPTIONS:
+               *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
+                               scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
+               break;
        case SR_CONF_DEVICE_OPTIONS:
-               *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
-                               hwcaps, ARRAY_SIZE(hwcaps), sizeof(int32_t));
+               if (!sdi)
+                       *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
+                                       drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t));
+               else
+                       *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
+                                       devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
                break;
        case SR_CONF_SAMPLERATE:
                if (!sdi || !sdi->priv || !(devc = sdi->priv))
@@ -506,7 +567,6 @@ static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
 
        devc->cb_data = cb_data;
 
-       /* Send header packet to the session bus. */
        std_session_send_df_header(sdi, LOG_PREFIX);
 
        /* Time when we should be done (for detecting trigger timeouts). */
@@ -516,24 +576,18 @@ static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
        devc->trigger_found = 0;
 
        /* Hook up a dummy handler to receive data from the device. */
-       sr_session_source_add(sdi->session, -1, G_IO_IN, 0, receive_data, (void *)sdi);
+       sr_session_source_add(sdi->session, -1, 0, 0, receive_data, (void *)sdi);
 
        return SR_OK;
 }
 
 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
 {
-       struct sr_datafeed_packet packet;
-
        (void)cb_data;
 
        sr_dbg("Stopping acquisition.");
        sr_session_source_remove(sdi->session, -1);
-
-       /* Send end packet to the session bus. */
-       sr_dbg("Sending SR_DF_END.");
-       packet.type = SR_DF_END;
-       sr_session_send(sdi, &packet);
+       std_session_send_df_end(sdi, LOG_PREFIX);
 
        return SR_OK;
 }
@@ -554,5 +608,5 @@ SR_PRIV struct sr_dev_driver chronovu_la_driver_info = {
        .dev_close = dev_close,
        .dev_acquisition_start = dev_acquisition_start,
        .dev_acquisition_stop = dev_acquisition_stop,
-       .priv = NULL,
+       .context = NULL,
 };