]> sigrok.org Git - libsigrok.git/blobdiff - hardware/fx2lafw/fx2lafw.c
GPL headers: Use correct project name.
[libsigrok.git] / hardware / fx2lafw / fx2lafw.c
index 46b65cb0947afa57c144715b8c37a447622dc18c..492e5397af5a135e9b5bf1f4a8e0e02f38c92ba8 100644 (file)
@@ -1,7 +1,7 @@
 /*
- * This file is part of the sigrok project.
+ * This file is part of the libsigrok project.
  *
- * Copyright (C) 2010-2012 Bert Vermeulen <bert@biot.com>
+ * Copyright (C) 2013 Bert Vermeulen <bert@biot.com>
  * Copyright (C) 2012 Joel Holdsworth <joel@airwebreathe.org.uk>
  *
  * This program is free software: you can redistribute it and/or modify
@@ -81,14 +81,18 @@ static const struct fx2lafw_profile supported_fx2[] = {
        { 0, 0, 0, 0, 0, 0, 0 }
 };
 
-static const int hwcaps[] = {
+static const int32_t hwopts[] = {
+       SR_CONF_CONN,
+};
+
+static const int32_t hwcaps[] = {
        SR_CONF_LOGIC_ANALYZER,
+       SR_CONF_TRIGGER_TYPE,
        SR_CONF_SAMPLERATE,
 
        /* These are really implemented in the driver, not the hardware. */
        SR_CONF_LIMIT_SAMPLES,
        SR_CONF_CONTINUOUS,
-       0,
 };
 
 static const char *probe_names[] = {
@@ -97,7 +101,7 @@ static const char *probe_names[] = {
        NULL,
 };
 
-static const uint64_t supported_samplerates[] = {
+static const uint64_t samplerates[] = {
        SR_KHZ(20),
        SR_KHZ(25),
        SR_KHZ(50),
@@ -114,20 +118,11 @@ static const uint64_t supported_samplerates[] = {
        SR_MHZ(12),
        SR_MHZ(16),
        SR_MHZ(24),
-       0,
-};
-
-static const struct sr_samplerates samplerates = {
-       0,
-       0,
-       0,
-       supported_samplerates,
 };
 
 SR_PRIV struct sr_dev_driver fx2lafw_driver_info;
 static struct sr_dev_driver *di = &fx2lafw_driver_info;
 static int hw_dev_close(struct sr_dev_inst *sdi);
-static int config_set(int id, const void *value, const struct sr_dev_inst *sdi);
 static int hw_dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data);
 
 /**
@@ -177,6 +172,7 @@ static gboolean check_conf_profile(libusb_device *dev)
 static int fx2lafw_dev_open(struct sr_dev_inst *sdi)
 {
        libusb_device **devlist;
+       struct sr_usb_dev_inst *usb;
        struct libusb_device_descriptor des;
        struct dev_context *devc;
        struct drv_context *drvc;
@@ -186,6 +182,7 @@ static int fx2lafw_dev_open(struct sr_dev_inst *sdi)
 
        drvc = di->priv;
        devc = sdi->priv;
+       usb = sdi->conn;
 
        if (sdi->status == SR_ST_ACTIVE)
                /* Device is already in use. */
@@ -221,32 +218,32 @@ static int fx2lafw_dev_open(struct sr_dev_inst *sdi)
                         * This device is fully enumerated, so we need to find
                         * this device by vendor, product, bus and address.
                         */
-                       if (libusb_get_bus_number(devlist[i]) != devc->usb->bus
-                               || libusb_get_device_address(devlist[i]) != devc->usb->address)
+                       if (libusb_get_bus_number(devlist[i]) != usb->bus
+                               || libusb_get_device_address(devlist[i]) != usb->address)
                                /* This is not the one. */
                                continue;
                }
 
-               if (!(ret = libusb_open(devlist[i], &devc->usb->devhdl))) {
-                       if (devc->usb->address == 0xff)
+               if (!(ret = libusb_open(devlist[i], &usb->devhdl))) {
+                       if (usb->address == 0xff)
                                /*
                                 * First time we touch this device after FW
                                 * upload, so we don't know the address yet.
                                 */
-                               devc->usb->address = libusb_get_device_address(devlist[i]);
+                               usb->address = libusb_get_device_address(devlist[i]);
                } else {
                        sr_err("Failed to open device: %s.",
                               libusb_error_name(ret));
                        break;
                }
 
-               ret = command_get_fw_version(devc->usb->devhdl, &vi);
+               ret = command_get_fw_version(usb->devhdl, &vi);
                if (ret != SR_OK) {
                        sr_err("Failed to get firmware version.");
                        break;
                }
 
-               ret = command_get_revid_version(devc->usb->devhdl, &revid);
+               ret = command_get_revid_version(usb->devhdl, &revid);
                if (ret != SR_OK) {
                        sr_err("Failed to get REVID.");
                        break;
@@ -267,7 +264,7 @@ static int fx2lafw_dev_open(struct sr_dev_inst *sdi)
                sdi->status = SR_ST_ACTIVE;
                sr_info("Opened device %d on %d.%d, "
                        "interface %d, firmware %d.%d.",
-                       sdi->index, devc->usb->bus, devc->usb->address,
+                       sdi->index, usb->bus, usb->address,
                        USB_INTERFACE, vi.major, vi.minor);
 
                sr_info("Detected REVID=%d, it's a Cypress CY7C68013%s.",
@@ -349,65 +346,28 @@ static struct dev_context *fx2lafw_dev_new(void)
 
 static int clear_instances(void)
 {
-       GSList *l;
-       struct sr_dev_inst *sdi;
-       struct drv_context *drvc;
-       struct dev_context *devc;
-       int ret;
-
-       drvc = di->priv;
-       ret = SR_OK;
-       for (l = drvc->instances; l; l = l->next) {
-               if (!(sdi = l->data)) {
-                       /* Log error, but continue cleaning up the rest. */
-                       sr_err("sdi was NULL, continuing.");
-                       ret = SR_ERR_BUG;
-                       continue;
-               }
-               if (!(devc = sdi->priv)) {
-                       /* Log error, but continue cleaning up the rest. */
-                       sr_err("sdi->priv was NULL, continuing.");
-                       ret = SR_ERR_BUG;
-                       continue;
-               }
-               hw_dev_close(sdi);
-               sr_usb_dev_inst_free(devc->usb);
-               sdi = l->data;
-               sr_dev_inst_free(sdi);
-       }
-
-       g_slist_free(drvc->instances);
-       drvc->instances = NULL;
-
-       return ret;
+       return std_dev_clear(di, NULL);
 }
 
 static int hw_init(struct sr_context *sr_ctx)
 {
-       struct drv_context *drvc;
-
-       if (!(drvc = g_try_malloc0(sizeof(struct drv_context)))) {
-               sr_err("Driver context malloc failed.");
-               return SR_ERR_MALLOC;
-       }
-
-       drvc->sr_ctx = sr_ctx;
-       di->priv = drvc;
-
-       return SR_OK;
+       return std_hw_init(sr_ctx, di, DRIVER_LOG_DOMAIN);
 }
 
 static GSList *hw_scan(GSList *options)
 {
-       GSList *devices;
-       struct libusb_device_descriptor des;
-       struct sr_dev_inst *sdi;
-       const struct fx2lafw_profile *prof;
        struct drv_context *drvc;
        struct dev_context *devc;
+       struct sr_dev_inst *sdi;
+       struct sr_usb_dev_inst *usb;
        struct sr_probe *probe;
+       struct sr_config *src;
+       const struct fx2lafw_profile *prof;
+       GSList *l, *devices, *conn_devices;
+       struct libusb_device_descriptor des;
        libusb_device **devlist;
        int devcnt, num_logic_probes, ret, i, j;
+       const char *conn;
 
        (void)options;
 
@@ -416,13 +376,39 @@ static GSList *hw_scan(GSList *options)
        /* This scan always invalidates any previous scans. */
        clear_instances();
 
+       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;
+
        /* Find all fx2lafw compatible devices and upload firmware to them. */
        devices = NULL;
        libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
        for (i = 0; devlist[i]; i++) {
+               if (conn) {
+                       usb = NULL;
+                       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;
+               }
 
-               if ((ret = libusb_get_device_descriptor(
-                    devlist[i], &des)) != 0) {
+               if ((ret = libusb_get_device_descriptor( devlist[i], &des)) != 0) {
                        sr_warn("Failed to get device descriptor: %s.",
                                libusb_error_name(ret));
                        continue;
@@ -466,9 +452,9 @@ static GSList *hw_scan(GSList *options)
                        /* Already has the firmware, so fix the new address. */
                        sr_dbg("Found an fx2lafw device.");
                        sdi->status = SR_ST_INACTIVE;
-                       devc->usb = sr_usb_dev_inst_new
-                           (libusb_get_bus_number(devlist[i]),
-                            libusb_get_device_address(devlist[i]), NULL);
+                       sdi->inst_type = SR_INST_USB;
+                       sdi->conn = sr_usb_dev_inst_new(libusb_get_bus_number(devlist[i]),
+                                       libusb_get_device_address(devlist[i]), NULL);
                } else {
                        if (ezusb_upload_firmware(devlist[i], USB_CONFIGURATION,
                                prof->firmware) == SR_OK)
@@ -477,8 +463,9 @@ static GSList *hw_scan(GSList *options)
                        else
                                sr_err("Firmware upload failed for "
                                       "device %d.", devcnt);
-                       devc->usb = sr_usb_dev_inst_new
-                               (libusb_get_bus_number(devlist[i]), 0xff, NULL);
+                       sdi->inst_type = SR_INST_USB;
+                       sdi->conn = sr_usb_dev_inst_new (libusb_get_bus_number(devlist[i]),
+                                       0xff, NULL);
                }
        }
        libusb_free_device_list(devlist, 1);
@@ -488,20 +475,18 @@ static GSList *hw_scan(GSList *options)
 
 static GSList *hw_dev_list(void)
 {
-       struct drv_context *drvc;
-
-       drvc = di->priv;
-
-       return drvc->instances;
+       return ((struct drv_context *)(di->priv))->instances;
 }
 
 static int hw_dev_open(struct sr_dev_inst *sdi)
 {
+       struct sr_usb_dev_inst *usb;
        struct dev_context *devc;
        int ret;
        int64_t timediff_us, timediff_ms;
 
        devc = sdi->priv;
+       usb = sdi->conn;
 
        /*
         * If the firmware was recently uploaded, wait up to MAX_RENUM_DELAY_MS
@@ -537,9 +522,7 @@ static int hw_dev_open(struct sr_dev_inst *sdi)
                return SR_ERR;
        }
 
-       devc = sdi->priv;
-
-       ret = libusb_claim_interface(devc->usb->devhdl, USB_INTERFACE);
+       ret = libusb_claim_interface(usb->devhdl, USB_INTERFACE);
        if (ret != 0) {
                switch(ret) {
                case LIBUSB_ERROR_BUSY:
@@ -560,9 +543,7 @@ static int hw_dev_open(struct sr_dev_inst *sdi)
 
        if (devc->cur_samplerate == 0) {
                /* Samplerate hasn't been set; default to the slowest one. */
-               if (config_set(SR_CONF_SAMPLERATE, &supported_samplerates[0],
-                               sdi) == SR_ERR)
-                       return SR_ERR;
+               devc->cur_samplerate = samplerates[0];
        }
 
        return SR_OK;
@@ -570,17 +551,17 @@ static int hw_dev_open(struct sr_dev_inst *sdi)
 
 static int hw_dev_close(struct sr_dev_inst *sdi)
 {
-       struct dev_context *devc;
+       struct sr_usb_dev_inst *usb;
 
-       devc = sdi->priv;
-       if (devc->usb->devhdl == NULL)
+       usb = sdi->conn;
+       if (usb->devhdl == NULL)
                return SR_ERR;
 
-       sr_info("Closing device %d on %d.%d, interface %d.",
-               sdi->index, devc->usb->bus, devc->usb->address, USB_INTERFACE);
-       libusb_release_interface(devc->usb->devhdl, USB_INTERFACE);
-       libusb_close(devc->usb->devhdl);
-       devc->usb->devhdl = NULL;
+       sr_info("fx2lafw: Closing device %d on %d.%d interface %d.",
+               sdi->index, usb->bus, usb->address, USB_INTERFACE);
+       libusb_release_interface(usb->devhdl, USB_INTERFACE);
+       libusb_close(usb->devhdl);
+       usb->devhdl = NULL;
        sdi->status = SR_ST_INACTIVE;
 
        return SR_OK;
@@ -602,35 +583,38 @@ static int hw_cleanup(void)
        return ret;
 }
 
-static int config_get(int id, const void **data, const struct sr_dev_inst *sdi)
+static int config_get(int id, GVariant **data, const struct sr_dev_inst *sdi)
 {
        struct dev_context *devc;
+       struct sr_usb_dev_inst *usb;
+       char str[128];
 
        switch (id) {
-       case SR_DI_HWCAPS:
-               *data = hwcaps;
-               break;
-       case SR_DI_SAMPLERATES:
-               *data = &samplerates;
-               break;
-       case SR_DI_TRIGGER_TYPES:
-               *data = TRIGGER_TYPES;
+       case SR_CONF_CONN:
+               if (!sdi || !sdi->conn)
+                       return SR_ERR_ARG;
+               usb = sdi->conn;
+               if (usb->address == 255)
+                       /* Device still needs to re-enumerate after firmware
+                        * upload, so we don't know its (future) address. */
+                       return SR_ERR;
+               snprintf(str, 128, "%d.%d", usb->bus, usb->address);
+               *data = g_variant_new_string(str);
                break;
-       case SR_DI_CUR_SAMPLERATE:
-               if (sdi) {
-                       devc = sdi->priv;
-                       *data = &devc->cur_samplerate;
-               } else
+       case SR_CONF_SAMPLERATE:
+               if (!sdi)
                        return SR_ERR;
+               devc = sdi->priv;
+               *data = g_variant_new_uint64(devc->cur_samplerate);
                break;
        default:
-               return SR_ERR_ARG;
+               return SR_ERR_NA;
        }
 
        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;
        int ret;
@@ -638,18 +622,51 @@ static int config_set(int id, const void *value, const struct sr_dev_inst *sdi)
        devc = sdi->priv;
 
        if (id == SR_CONF_SAMPLERATE) {
-               devc->cur_samplerate = *(const uint64_t *)value;
+               devc->cur_samplerate = g_variant_get_uint64(data);
                ret = SR_OK;
        } else if (id == SR_CONF_LIMIT_SAMPLES) {
-               devc->limit_samples = *(const uint64_t *)value;
+               devc->limit_samples = g_variant_get_uint64(data);
                ret = SR_OK;
        } else {
-               ret = SR_ERR;
+               ret = SR_ERR_NA;
        }
 
        return ret;
 }
 
+static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi)
+{
+       GVariant *gvar;
+       GVariantBuilder gvb;
+
+       (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;
+       case SR_CONF_SAMPLERATE:
+               g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
+               gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"), samplerates,
+                               ARRAY_SIZE(samplerates), sizeof(uint64_t));
+               g_variant_builder_add(&gvb, "{sv}", "samplerates", gvar);
+               *data = g_variant_builder_end(&gvb);
+               break;
+       case SR_CONF_TRIGGER_TYPE:
+               *data = g_variant_new_string(TRIGGER_TYPE);
+               break;
+       default:
+               return SR_ERR_NA;
+       }
+
+       return SR_OK;
+}
+
 static int receive_data(int fd, int revents, void *cb_data)
 {
        struct timeval tv;
@@ -688,7 +705,7 @@ static void finish_acquisition(struct dev_context *devc)
 
        /* Terminate session. */
        packet.type = SR_DF_END;
-       sr_session_send(devc->session_dev_id, &packet);
+       sr_session_send(devc->cb_data, &packet);
 
        /* Remove fds from polling. */
        lupfd = libusb_get_pollfds(drvc->sr_ctx->libusb_ctx);
@@ -820,7 +837,7 @@ static void receive_transfer(struct libusb_transfer *transfer)
                                         */
                                        packet.type = SR_DF_TRIGGER;
                                        packet.payload = NULL;
-                                       sr_session_send(devc->session_dev_id, &packet);
+                                       sr_session_send(devc->cb_data, &packet);
 
                                        /*
                                         * Send the samples that triggered it,
@@ -831,7 +848,7 @@ static void receive_transfer(struct libusb_transfer *transfer)
                                        logic.unitsize = sizeof(*devc->trigger_buffer);
                                        logic.length = devc->trigger_stage * logic.unitsize;
                                        logic.data = devc->trigger_buffer;
-                                       sr_session_send(devc->session_dev_id, &packet);
+                                       sr_session_send(devc->cb_data, &packet);
 
                                        devc->trigger_stage = TRIGGER_FIRED;
                                        break;
@@ -861,7 +878,7 @@ static void receive_transfer(struct libusb_transfer *transfer)
                logic.length = transfer->actual_length - trigger_offset_bytes;
                logic.unitsize = sample_width;
                logic.data = cur_buf + trigger_offset_bytes;
-               sr_session_send(devc->session_dev_id, &packet);
+               sr_session_send(devc->cb_data, &packet);
 
                devc->num_samples += cur_sample_count;
                if (devc->limit_samples &&
@@ -923,10 +940,9 @@ static unsigned int get_timeout(struct dev_context *devc)
 static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
                void *cb_data)
 {
-       struct sr_datafeed_packet packet;
-       struct sr_datafeed_header header;
        struct dev_context *devc;
        struct drv_context *drvc;
+       struct sr_usb_dev_inst *usb;
        struct libusb_transfer *transfer;
        const struct libusb_pollfd **lupfd;
        unsigned int i, timeout, num_transfers;
@@ -936,6 +952,7 @@ static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
 
        drvc = di->priv;
        devc = sdi->priv;
+       usb = sdi->conn;
 
        if (devc->submitted_transfers != 0)
                return SR_ERR;
@@ -945,7 +962,7 @@ static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
                return SR_ERR;
        }
 
-       devc->session_dev_id = cb_data;
+       devc->cb_data = cb_data;
        devc->num_samples = 0;
        devc->empty_transfer_count = 0;
 
@@ -967,7 +984,7 @@ static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
                        return SR_ERR_MALLOC;
                }
                transfer = libusb_alloc_transfer(0);
-               libusb_fill_bulk_transfer(transfer, devc->usb->devhdl,
+               libusb_fill_bulk_transfer(transfer, usb->devhdl,
                                2 | LIBUSB_ENDPOINT_IN, buf, size,
                                receive_transfer, devc, timeout);
                if ((ret = libusb_submit_transfer(transfer)) != 0) {
@@ -988,13 +1005,10 @@ static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
                              timeout, receive_data, NULL);
        free(lupfd); /* NOT g_free()! */
 
-       packet.type = SR_DF_HEADER;
-       packet.payload = &header;
-       header.feed_version = 1;
-       gettimeofday(&header.starttime, NULL);
-       sr_session_send(cb_data, &packet);
+       /* Send header packet to the session bus. */
+       std_session_send_df_header(cb_data, DRIVER_LOG_DOMAIN);
 
-       if ((ret = command_start_acquisition(devc->usb->devhdl,
+       if ((ret = command_start_acquisition (usb->devhdl,
                devc->cur_samplerate, devc->sample_wide)) != SR_OK) {
                abort_acquisition(devc);
                return ret;
@@ -1024,6 +1038,7 @@ SR_PRIV struct sr_dev_driver fx2lafw_driver_info = {
        .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,