X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=hardware%2Fsaleae-logic%2Fsaleae-logic.c;h=b986243b80a8693fe8bfbdb29c584e8e11596e1c;hb=d261dbbfcc73;hp=8f140a5a0c9b8ee8889f40106f632f9a416821f2;hpb=e31b636df6651ae17f9bb28c51157a51fc92c421;p=libsigrok.git diff --git a/hardware/saleae-logic/saleae-logic.c b/hardware/saleae-logic/saleae-logic.c index 8f140a5a..b986243b 100644 --- a/hardware/saleae-logic/saleae-logic.c +++ b/hardware/saleae-logic/saleae-logic.c @@ -1,7 +1,7 @@ /* * This file is part of the sigrok project. * - * Copyright (C) 2010 Bert Vermeulen + * Copyright (C) 2010-2012 Bert Vermeulen * * 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 @@ -25,811 +25,886 @@ #include #include "config.h" #include "sigrok.h" +#include "sigrok-internal.h" +#include "saleae-logic.h" + +static struct fx2_profile supported_fx2[] = { + /* Saleae Logic */ + { 0x0925, 0x3881, 0x0925, 0x3881, "Saleae", "Logic", NULL, 8 }, + /* default Cypress FX2 without EEPROM */ + { 0x04b4, 0x8613, 0x0925, 0x3881, "Cypress", "FX2", NULL, 16 }, + { 0, 0, 0, 0, 0, 0, 0, 0 } +}; -#define USB_VENDOR 0x0925 -#define USB_PRODUCT 0x3881 -#define USB_VENDOR_NAME "Saleae" -#define USB_MODEL_NAME "Logic" -#define USB_MODEL_VERSION "" - -#define USB_INTERFACE 0 -#define USB_CONFIGURATION 1 -#define NUM_PROBES 8 -#define NUM_TRIGGER_STAGES 4 -#define TRIGGER_TYPES "01" -#define FIRMWARE FIRMWARE_DIR "/saleae-logic.firmware" - -/* delay in ms */ -#define FIRMWARE_RENUM_DELAY 2000 -#define NUM_SIMUL_TRANSFERS 10 -#define MAX_EMPTY_TRANSFERS NUM_SIMUL_TRANSFERS * 2 - -/* software trigger implementation: positive values indicate trigger stage */ -#define TRIGGER_FIRED -1 - - -/* there is only one model Saleae Logic, and this is what it supports */ -static int capabilities[] = { - HWCAP_LOGIC_ANALYZER, - HWCAP_SAMPLERATE, +static int hwcaps[] = { + SR_HWCAP_LOGIC_ANALYZER, + SR_HWCAP_SAMPLERATE, - /* these are really implemented in the driver, not the hardware */ - HWCAP_LIMIT_SAMPLES, - 0 + /* These are really implemented in the driver, not the hardware. */ + SR_HWCAP_LIMIT_SAMPLES, + SR_HWCAP_CONTINUOUS, + 0, }; -/* list of struct sigrok_device_instance, maintained by opendev() and closedev() */ -static GSList *device_instances = NULL; - -/* since we can't keep track of a Saleae Logic device after upgrading the - * firmware -- it re-enumerates into a different device address after the - * upgrade -- this is like a global lock. No device will open until a proper - * delay after the last device was upgraded. +/* + * Probes are numbered 1-8. + * + * TODO: FX2 eval boards with the standard Cypress VID/PID can have 16 pins + * or probes in theory, which is not supported by the Saleae Logic firmware. */ -GTimeVal firmware_updated = {0}; - -static libusb_context *usb_context = NULL; - -static uint64_t supported_samplerates[] = { - KHZ(200), - KHZ(250), - KHZ(500), - MHZ(1), - MHZ(2), - MHZ(4), - MHZ(8), - MHZ(12), - MHZ(16), - MHZ(24), - 0 +static const char *probe_names[] = { + "0", + "1", + "2", + "3", + "4", + "5", + "6", + "7", + "8", + "9", + "10", + "11", + "12", + "13", + "14", + "15", + NULL, }; -static struct samplerates samplerates = { - KHZ(200), - MHZ(24), +static uint64_t supported_samplerates[] = { + SR_KHZ(200), + SR_KHZ(250), + SR_KHZ(500), + SR_MHZ(1), + SR_MHZ(2), + SR_MHZ(4), + SR_MHZ(8), + SR_MHZ(12), + SR_MHZ(16), + SR_MHZ(24), 0, - supported_samplerates }; -/* TODO: all of these should go in a device-specific struct */ -static uint64_t cur_samplerate = 0; -static uint64_t limit_samples = 0; -static uint8_t probe_mask = 0, \ - trigger_mask[NUM_TRIGGER_STAGES] = {0}, \ - trigger_value[NUM_TRIGGER_STAGES] = {0}, \ - trigger_buffer[NUM_TRIGGER_STAGES] = {0};; -int trigger_stage = TRIGGER_FIRED; +static struct sr_samplerates samplerates = { + SR_KHZ(200), + SR_MHZ(24), + SR_HZ(0), + supported_samplerates, +}; +/* List of struct sr_dev_inst, maintained by dev_open()/dev_close(). */ +static GSList *dev_insts = NULL; +static libusb_context *usb_context = NULL; -static int hw_set_configuration(int device_index, int capability, void *value); +static int new_saleae_logic_firmware = 0; +static int hw_dev_config_set(int dev_index, int hwcap, void *value); +static int hw_dev_acquisition_stop(int dev_index, gpointer session_dev_id); -/* returns 1 if the device's configuration profile match the Logic firmware's - * configuration, 0 otherwise +/** + * Check the USB configuration to determine if this is a Saleae Logic. + * + * @return 1 if the device's configuration profile match the Logic firmware's + * configuration, 0 otherwise. */ -int check_conf_profile(libusb_device *dev) +static int check_conf_profile(libusb_device *dev) { struct libusb_device_descriptor des; - struct libusb_config_descriptor *conf_dsc; + struct libusb_config_descriptor *conf_dsc = NULL; const struct libusb_interface_descriptor *intf_dsc; - int ret; + int ret = -1; - ret = -1; - conf_dsc = NULL; - while(ret == -1) - { - /* assume it's not a Saleae Logic unless proven wrong */ + while (ret == -1) { + /* Assume it's not a Saleae Logic unless proven wrong. */ ret = 0; - if(libusb_get_device_descriptor(dev, &des) != 0) + if (libusb_get_device_descriptor(dev, &des) != 0) break; - if(des.bNumConfigurations != 1) - /* need exactly 1 configuration */ + if (des.bNumConfigurations != 1) + /* Need exactly 1 configuration. */ break; - if(libusb_get_config_descriptor(dev, 0, &conf_dsc) != 0) + if (libusb_get_config_descriptor(dev, 0, &conf_dsc) != 0) break; - if(conf_dsc->bNumInterfaces != 1) - /* need exactly 1 interface */ + if (conf_dsc->bNumInterfaces != 1) + /* Need exactly 1 interface. */ break; - if(conf_dsc->interface[0].num_altsetting != 1) - /* need just one alternate setting */ + if (conf_dsc->interface[0].num_altsetting != 1) + /* Need just one alternate setting. */ break; intf_dsc = &(conf_dsc->interface[0].altsetting[0]); - if(intf_dsc->bNumEndpoints != 2) - /* need 2 endpoints */ + if (intf_dsc->bNumEndpoints == 4) { + /* The new Saleae Logic firmware has 4 endpoints. */ + new_saleae_logic_firmware = 1; + } else if (intf_dsc->bNumEndpoints == 2) { + /* The old Saleae Logic firmware has 2 endpoints. */ + new_saleae_logic_firmware = 0; + } else { + /* Other number of endpoints -> not a Saleae Logic. */ break; + } - if((intf_dsc->endpoint[0].bEndpointAddress & 0x8f) != (1 | LIBUSB_ENDPOINT_OUT)) - /* first endpoint should be 1 (outbound) */ + if ((intf_dsc->endpoint[0].bEndpointAddress & 0x8f) != + (1 | LIBUSB_ENDPOINT_OUT)) + /* The first endpoint should be 1 (outbound). */ break; - if((intf_dsc->endpoint[1].bEndpointAddress & 0x8f) != (2 | LIBUSB_ENDPOINT_IN)) - /* first endpoint should be 2 (inbound) */ + if ((intf_dsc->endpoint[1].bEndpointAddress & 0x8f) != + (2 | LIBUSB_ENDPOINT_IN)) + /* The second endpoint should be 2 (inbound). */ break; - /* if we made it here, it must be a Saleae Logic */ + /* TODO: The new firmware has 4 endpoints... */ + + /* If we made it here, it must be a Saleae Logic. */ ret = 1; } - if(conf_dsc) + + if (conf_dsc) libusb_free_config_descriptor(conf_dsc); return ret; } - -struct sigrok_device_instance *sl_open_device(int device_index) +static int sl_open_dev(int dev_index) { - struct sigrok_device_instance *sdi; libusb_device **devlist; struct libusb_device_descriptor des; + struct sr_dev_inst *sdi; + struct context *ctx; int err, skip, i; - if(!(sdi = get_sigrok_device_instance(device_instances, device_index))) - return NULL; + if (!(sdi = sr_dev_inst_get(dev_insts, dev_index))) + return SR_ERR; + ctx = sdi->priv; - libusb_get_device_list(usb_context, &devlist); - if(sdi->status == ST_INITIALIZING) - { - /* this device was renumerating last time we touched it. opendev() guarantees we've - * waited long enough for it to have booted properly, so now we need to find it on - * the bus and record its new address. - */ - skip = 0; - for(i = 0; devlist[i]; i++) - { - if( (err = libusb_get_device_descriptor(devlist[i], &des)) ) - { - g_warning("failed to get device descriptor: %d", err); - continue; - } + if (sdi->status == SR_ST_ACTIVE) + /* already in use */ + return SR_ERR; - if(des.idVendor == USB_VENDOR && des.idProduct == USB_PRODUCT) - { - if(skip != device_index) - { - /* skip past devices of this type that aren't the one we want */ - skip++; - continue; - } + skip = 0; + libusb_get_device_list(usb_context, &devlist); + for (i = 0; devlist[i]; i++) { + if ((err = libusb_get_device_descriptor(devlist[i], &des))) { + sr_err("logic: failed to get device descriptor: %d", err); + continue; + } - /* should check the bus here, since we know that already... but what - * are we going to do if it doesn't match after the right number of skips? - */ + if (des.idVendor != ctx->profile->fw_vid + || des.idProduct != ctx->profile->fw_pid) + continue; - if( !(err = libusb_open(devlist[i], &(sdi->usb->devhdl))) ) - { - sdi->usb->address = libusb_get_device_address(devlist[i]); - sdi->status = ST_ACTIVE; - g_message("opened device %d on %d.%d interface %d", sdi->index, sdi->usb->bus, - sdi->usb->address, USB_INTERFACE); - } - else - { - g_warning("failed to open device: %d", err); - sdi = NULL; - } - } - } - } - else if(sdi->status == ST_INACTIVE) - { - /* this device is fully enumerated, so we need to find this device by - * vendor, product, bus and address */ - libusb_get_device_list(usb_context, &devlist); - for(i = 0; devlist[i]; i++) - { - if( (err = libusb_get_device_descriptor(devlist[i], &des)) ) - { - g_warning("failed to get device descriptor: %d", err); + if (sdi->status == SR_ST_INITIALIZING) { + if (skip != dev_index) { + /* Skip devices of this type that aren't the one we want. */ + skip += 1; continue; } + } else if (sdi->status == SR_ST_INACTIVE) { + /* + * 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]) != ctx->usb->bus + || libusb_get_device_address(devlist[i]) != ctx->usb->address) + /* this is not the one */ + continue; + } - if(des.idVendor == USB_VENDOR && des.idProduct == USB_PRODUCT) - { - if(libusb_get_bus_number(devlist[i]) == sdi->usb->bus && - libusb_get_device_address(devlist[i]) == sdi->usb->address) - { - /* found it */ - if( !(err = libusb_open(devlist[i], &(sdi->usb->devhdl))) ) - { - sdi->status = ST_ACTIVE; - g_message("opened device %d on %d.%d interface %d", sdi->index, sdi->usb->bus, - sdi->usb->address, USB_INTERFACE); - } - else - { - g_warning("failed to open device: %d", err); - sdi = NULL; - } - } - } + if (!(err = libusb_open(devlist[i], &ctx->usb->devhdl))) { + if (ctx->usb->address == 0xff) + /* + * first time we touch this device after firmware upload, + * so we don't know the address yet. + */ + ctx->usb->address = libusb_get_device_address(devlist[i]); + + sdi->status = SR_ST_ACTIVE; + sr_info("logic: opened device %d on %d.%d interface %d", + sdi->index, ctx->usb->bus, + ctx->usb->address, USB_INTERFACE); + } else { + sr_err("logic: failed to open device: %d", err); } - } - else - { - /* status must be ST_ACTIVE, i.e. already in use... */ - sdi = NULL; + + /* if we made it here, we handled the device one way or another */ + break; } libusb_free_device_list(devlist, 1); - if(sdi && sdi->status != ST_ACTIVE) - sdi = NULL; + if (sdi->status != SR_ST_ACTIVE) + return SR_ERR; - return sdi; + return SR_OK; } - -int upload_firmware(libusb_device *dev) +static void close_dev(struct sr_dev_inst *sdi) { - struct libusb_device_handle *hdl; - int err; - - g_message("uploading firmware to device on %d.%d", - libusb_get_bus_number(dev), libusb_get_device_address(dev)); + struct context *ctx; - err = libusb_open(dev, &hdl); - if(err != 0) - { - g_warning("failed to open device: %d", err); - return 1; - } - - err = libusb_set_configuration(hdl, USB_CONFIGURATION); - if(err != 0) - { - g_warning("Unable to set configuration: %d", err); - return 1; - } - - if((ezusb_reset(hdl, 1)) < 0) - return 1; - - if(ezusb_install_firmware(hdl, FIRMWARE) != 0) - return 1; + ctx = sdi->priv; - if((ezusb_reset(hdl, 0)) < 0) - return 1; + if (ctx->usb->devhdl == NULL) + return; - libusb_close(hdl); - - /* remember when the last firmware update was done */ - g_get_current_time(&firmware_updated); - - return 0; + sr_info("logic: closing device %d on %d.%d interface %d", sdi->index, + ctx->usb->bus, ctx->usb->address, USB_INTERFACE); + libusb_release_interface(ctx->usb->devhdl, USB_INTERFACE); + libusb_close(ctx->usb->devhdl); + ctx->usb->devhdl = NULL; + sdi->status = SR_ST_INACTIVE; } - -static void close_device(struct sigrok_device_instance *sdi) +static int configure_probes(struct context *ctx, GSList *probes) { - - if(sdi->usb->devhdl) - { - g_message("closing device %d on %d.%d interface %d", sdi->index, sdi->usb->bus, - sdi->usb->address, USB_INTERFACE); - libusb_release_interface(sdi->usb->devhdl, USB_INTERFACE); - libusb_close(sdi->usb->devhdl); - sdi->usb->devhdl = NULL; - sdi->status = ST_INACTIVE; - } - -} - - -static int configure_probes(GSList *probes) -{ - struct probe *probe; + struct sr_probe *probe; GSList *l; int probe_bit, stage, i; char *tc; - probe_mask = 0; - for(i = 0; i < NUM_TRIGGER_STAGES; i++) - { - trigger_mask[i] = 0; - trigger_value[i] = 0; + ctx->probe_mask = 0; + for (i = 0; i < NUM_TRIGGER_STAGES; i++) { + ctx->trigger_mask[i] = 0; + ctx->trigger_value[i] = 0; } stage = -1; - for(l = probes; l; l = l->next) - { - probe = (struct probe *) l->data; - if(probe->enabled == FALSE) + for (l = probes; l; l = l->next) { + probe = (struct sr_probe *)l->data; + if (probe->enabled == FALSE) continue; probe_bit = 1 << (probe->index - 1); - probe_mask |= probe_bit; - if(probe->trigger) - { - stage = 0; - for(tc = probe->trigger; *tc; tc++) - { - trigger_mask[stage] |= probe_bit; - if(*tc == '1') - trigger_value[stage] |= probe_bit; - stage++; - if(stage > NUM_TRIGGER_STAGES) - return SIGROK_ERR; - } + ctx->probe_mask |= probe_bit; + if (!(probe->trigger)) + continue; + + stage = 0; + for (tc = probe->trigger; *tc; tc++) { + ctx->trigger_mask[stage] |= probe_bit; + if (*tc == '1') + ctx->trigger_value[stage] |= probe_bit; + stage++; + if (stage > NUM_TRIGGER_STAGES) + return SR_ERR; } } - if(stage == -1) - /* we didn't configure any triggers, make sure acquisition doesn't wait for any */ - trigger_stage = TRIGGER_FIRED; + if (stage == -1) + /* + * We didn't configure any triggers, make sure acquisition + * doesn't wait for any. + */ + ctx->trigger_stage = TRIGGER_FIRED; else - trigger_stage = 0; + ctx->trigger_stage = 0; - return SIGROK_OK; + return SR_OK; } +static struct context *fx2_dev_new(void) +{ + struct context *ctx; + + if (!(ctx = g_try_malloc0(sizeof(struct context)))) { + sr_err("logic: %s: ctx malloc failed", __func__); + return NULL; + } + ctx->trigger_stage = TRIGGER_FIRED; + ctx->usb = NULL; + + return ctx; +} /* * API callbacks */ -static int hw_init(char *deviceinfo) +static int hw_init(const char *devinfo) { - struct sigrok_device_instance *sdi; + struct sr_dev_inst *sdi; struct libusb_device_descriptor des; + struct fx2_profile *fx2_prof; + struct context *ctx; libusb_device **devlist; - int err, devcnt, i; + int err, devcnt, i, j; + + /* Avoid compiler warnings. */ + (void)devinfo; - if(libusb_init(&usb_context) != 0) { - g_warning("Failed to initialize USB."); + if (libusb_init(&usb_context) != 0) { + sr_err("logic: Failed to initialize USB."); return 0; } - libusb_set_debug(usb_context, 3); - /* find all Saleae Logic devices and upload firmware to all of them */ + /* Find all Saleae Logic devices and upload firmware to all of them. */ devcnt = 0; libusb_get_device_list(usb_context, &devlist); - for(i = 0; devlist[i]; i++) { + for (i = 0; devlist[i]; i++) { + fx2_prof = NULL; err = libusb_get_device_descriptor(devlist[i], &des); - if(err != 0) { - g_warning("failed to get device descriptor: %d", err); + if (err != 0) { + sr_err("logic: failed to get device descriptor: %d", + err); continue; } - if(des.idVendor == USB_VENDOR && des.idProduct == USB_PRODUCT) { - /* definitely a Saleae Logic */ - - sdi = sigrok_device_instance_new(devcnt, ST_INITIALIZING, - USB_VENDOR_NAME, USB_MODEL_NAME, USB_MODEL_VERSION); - if(!sdi) - return 0; - device_instances = g_slist_append(device_instances, sdi); - - if(check_conf_profile(devlist[i]) == 0) - { - if(upload_firmware(devlist[i]) > 0) - /* continue on the off chance that the device is in a working state */ - /* TODO: could maybe try a USB reset, or uploading the firmware again... */ - g_warning("firmware upload failed for device %d", devcnt); - - sdi->usb = usb_device_instance_new(libusb_get_bus_number(devlist[i]), 0, NULL); - } - else { - /* already has the firmware on it, so fix the new address */ - sdi->usb = usb_device_instance_new(libusb_get_bus_number(devlist[i]), - libusb_get_device_address(devlist[i]), NULL); + for (j = 0; supported_fx2[j].orig_vid; j++) { + if (des.idVendor == supported_fx2[j].orig_vid + && des.idProduct == supported_fx2[j].orig_pid) { + fx2_prof = &supported_fx2[j]; + break; } - devcnt++; } + if (!fx2_prof) + /* not a supported VID/PID */ + continue; + + sdi = sr_dev_inst_new(devcnt, SR_ST_INITIALIZING, + fx2_prof->vendor, fx2_prof->model, fx2_prof->model_version); + if (!sdi) + return 0; + ctx = fx2_dev_new(); + ctx->profile = fx2_prof; + sdi->priv = ctx; + dev_insts = g_slist_append(dev_insts, sdi); + + if (check_conf_profile(devlist[i])) { + /* Already has the firmware, so fix the new address. */ + sr_dbg("logic: Found a Saleae Logic with %s firmware.", + new_saleae_logic_firmware ? "new" : "old"); + sdi->status = SR_ST_INACTIVE; + ctx->usb = 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, FIRMWARE) == SR_OK) + /* Remember when the firmware on this device was updated */ + g_get_current_time(&ctx->fw_updated); + else + sr_err("logic: firmware upload failed for " + "device %d", devcnt); + ctx->usb = sr_usb_dev_inst_new + (libusb_get_bus_number(devlist[i]), 0xff, NULL); + } + devcnt++; } libusb_free_device_list(devlist, 1); return devcnt; } - -static int hw_opendev(int device_index) +static int hw_dev_open(int dev_index) { GTimeVal cur_time; - struct sigrok_device_instance *sdi; + struct sr_dev_inst *sdi; + struct context *ctx; int timediff, err; - unsigned int cur, upd; - - if(firmware_updated.tv_sec > 0) { - /* firmware was recently uploaded */ - g_get_current_time(&cur_time); - cur = cur_time.tv_sec * 1000 + cur_time.tv_usec / 1000; - upd = firmware_updated.tv_sec * 1000 + firmware_updated.tv_usec / 1000; - timediff = cur - upd; - if(timediff < FIRMWARE_RENUM_DELAY) { - timediff = FIRMWARE_RENUM_DELAY - timediff; - g_message("waiting %d ms for device to reset", timediff); - g_usleep(timediff * 1000); - firmware_updated.tv_sec = 0; + + if (!(sdi = sr_dev_inst_get(dev_insts, dev_index))) + return SR_ERR; + ctx = sdi->priv; + + /* + * if the firmware was recently uploaded, wait up to MAX_RENUM_DELAY ms + * for the FX2 to renumerate + */ + err = 0; + if (GTV_TO_MSEC(ctx->fw_updated) > 0) { + sr_info("logic: waiting for device to reset"); + /* takes at least 300ms for the FX2 to be gone from the USB bus */ + g_usleep(300 * 1000); + timediff = 0; + while (timediff < MAX_RENUM_DELAY) { + if ((err = sl_open_dev(dev_index)) == SR_OK) + break; + g_usleep(100 * 1000); + g_get_current_time(&cur_time); + timediff = GTV_TO_MSEC(cur_time) - GTV_TO_MSEC(ctx->fw_updated); } + sr_info("logic: device came back after %d ms", timediff); + } else { + err = sl_open_dev(dev_index); } - if( !(sdi = sl_open_device(device_index)) ) { - g_warning("unable to open device"); - return SIGROK_ERR; + if (err != SR_OK) { + sr_err("logic: unable to open device"); + return SR_ERR; } + ctx = sdi->priv; - err = libusb_claim_interface(sdi->usb->devhdl, USB_INTERFACE); - if(err != 0) { - g_warning("Unable to claim interface: %d", err); - return SIGROK_ERR; + err = libusb_claim_interface(ctx->usb->devhdl, USB_INTERFACE); + if (err != 0) { + sr_err("logic: Unable to claim interface: %d", err); + return SR_ERR; } - if(cur_samplerate == 0) { - /* sample rate hasn't been set; default to the slowest it has */ - if(hw_set_configuration(device_index, HWCAP_SAMPLERATE, &supported_samplerates[0]) == SIGROK_ERR) - return SIGROK_ERR; + if (ctx->cur_samplerate == 0) { + /* Samplerate hasn't been set; default to the slowest one. */ + if (hw_dev_config_set(dev_index, SR_HWCAP_SAMPLERATE, + &supported_samplerates[0]) == SR_ERR) + return SR_ERR; } - return SIGROK_OK; + return SR_OK; } - -static void hw_closedev(int device_index) +static int hw_dev_close(int dev_index) { - struct sigrok_device_instance *sdi; + struct sr_dev_inst *sdi; - if( (sdi = get_sigrok_device_instance(device_instances, device_index)) ) - close_device(sdi); + if (!(sdi = sr_dev_inst_get(dev_insts, dev_index))) { + sr_err("logic: %s: sdi was NULL", __func__); + return SR_ERR; /* TODO: SR_ERR_ARG? */ + } -} + /* TODO */ + close_dev(sdi); + return SR_OK; +} -static void hw_cleanup(void) +static int hw_cleanup(void) { GSList *l; + struct sr_dev_inst *sdi; + struct context *ctx; + int ret = SR_OK; + + /* Properly close and free all devices. */ + for (l = dev_insts; l; l = l->next) { + if (!(sdi = l->data)) { + /* Log error, but continue cleaning up the rest. */ + sr_err("logic: %s: sdi was NULL, continuing", __func__); + ret = SR_ERR_BUG; + continue; + } + if (!(ctx = sdi->priv)) { + /* Log error, but continue cleaning up the rest. */ + sr_err("logic: %s: sdi->priv was NULL, continuing", + __func__); + ret = SR_ERR_BUG; + continue; + } + close_dev(sdi); + sr_usb_dev_inst_free(ctx->usb); + sr_dev_inst_free(sdi); + } - /* properly close all devices */ - for(l = device_instances; l; l = l->next) - close_device( (struct sigrok_device_instance *) l->data); - - /* and free all their memory */ - for(l = device_instances; l; l = l->next) - g_free(l->data); - g_slist_free(device_instances); - device_instances = NULL; + g_slist_free(dev_insts); + dev_insts = NULL; - if(usb_context) + if (usb_context) libusb_exit(usb_context); usb_context = NULL; + return ret; } - -static void *hw_get_device_info(int device_index, int device_info_id) +static void *hw_dev_info_get(int dev_index, int dev_info_id) { - struct sigrok_device_instance *sdi; - void *info; + struct sr_dev_inst *sdi; + struct context *ctx; + void *info = NULL; - if( !(sdi = get_sigrok_device_instance(device_instances, device_index)) ) + if (!(sdi = sr_dev_inst_get(dev_insts, dev_index))) return NULL; + ctx = sdi->priv; - info = NULL; - switch(device_info_id) - { - case DI_INSTANCE: + switch (dev_info_id) { + case SR_DI_INST: info = sdi; break; - case DI_NUM_PROBES: - info = GINT_TO_POINTER(NUM_PROBES); + case SR_DI_NUM_PROBES: + info = GINT_TO_POINTER(ctx->profile->num_probes); + break; + case SR_DI_PROBE_NAMES: + info = probe_names; break; - case DI_SAMPLERATES: + case SR_DI_SAMPLERATES: info = &samplerates; break; - case DI_TRIGGER_TYPES: + case SR_DI_TRIGGER_TYPES: info = TRIGGER_TYPES; break; - case DI_CUR_SAMPLERATE: - info = &cur_samplerate; + case SR_DI_CUR_SAMPLERATE: + info = &ctx->cur_samplerate; break; } return info; } - -static int hw_get_status(int device_index) +static int hw_dev_status_get(int dev_index) { - struct sigrok_device_instance *sdi; + struct sr_dev_inst *sdi; - sdi = get_sigrok_device_instance(device_instances, device_index); - if(sdi) + sdi = sr_dev_inst_get(dev_insts, dev_index); + if (sdi) return sdi->status; else - return ST_NOT_FOUND; + return SR_ST_NOT_FOUND; } +static int *hw_hwcap_get_all(void) +{ + return hwcaps; +} -static int *hw_get_capabilities(void) +static uint8_t new_firmware_divider_value(uint64_t samplerate) { + switch (samplerate) { + case SR_MHZ(24): + return 0xe0; + break; + case SR_MHZ(16): + return 0xd5; + break; + case SR_MHZ(12): + return 0xe2; + break; + case SR_MHZ(8): + return 0xd4; + break; + case SR_MHZ(4): + return 0xda; + break; + case SR_MHZ(2): + return 0xe6; + break; + case SR_MHZ(1): + return 0x8e; + break; + case SR_KHZ(500): + return 0xfe; + break; + case SR_KHZ(250): + return 0x9e; + break; + case SR_KHZ(200): + return 0x4e; + break; + } - return capabilities; + /* Shouldn't happen. */ + sr_err("logic: %s: Invalid samplerate %" PRIu64 "", + __func__, samplerate); + return 0; } - -static int set_configuration_samplerate(struct sigrok_device_instance *sdi, uint64_t samplerate) +static int set_samplerate(struct sr_dev_inst *sdi, uint64_t samplerate) { + struct context *ctx; uint8_t divider; int ret, result, i; unsigned char buf[2]; - for(i = 0; supported_samplerates[i]; i++) { - if(supported_samplerates[i] == samplerate) + ctx = sdi->priv; + for (i = 0; supported_samplerates[i]; i++) { + if (supported_samplerates[i] == samplerate) break; } - if(supported_samplerates[i] == 0) - return SIGROK_ERR_SAMPLERATE; + if (supported_samplerates[i] == 0) + return SR_ERR_SAMPLERATE; + + if (new_saleae_logic_firmware) + divider = new_firmware_divider_value(samplerate); + else + divider = (uint8_t) (48 / (samplerate / 1000000.0)) - 1; - divider = (uint8_t) (48 / (float) (samplerate/1000000)) - 1; + sr_info("logic: setting samplerate to %" PRIu64 " Hz (divider %d)", + samplerate, divider); - g_message("setting samplerate to %"PRIu64" Hz (divider %d)", samplerate, divider); - buf[0] = 0x01; + buf[0] = (new_saleae_logic_firmware) ? 0xd5 : 0x01; buf[1] = divider; - ret = libusb_bulk_transfer(sdi->usb->devhdl, 1 | LIBUSB_ENDPOINT_OUT, buf, 2, &result, 500); - if(ret != 0) { - g_warning("failed to set samplerate: %d", ret); - return SIGROK_ERR; + ret = libusb_bulk_transfer(ctx->usb->devhdl, 1 | LIBUSB_ENDPOINT_OUT, + buf, 2, &result, 500); + if (ret != 0) { + sr_err("logic: failed to set samplerate: %d", ret); + return SR_ERR; } - cur_samplerate = samplerate; + ctx->cur_samplerate = samplerate; - return SIGROK_OK; + return SR_OK; } - -static int hw_set_configuration(int device_index, int capability, void *value) +static int hw_dev_config_set(int dev_index, int hwcap, void *value) { - struct sigrok_device_instance *sdi; + struct sr_dev_inst *sdi; + struct context *ctx; int ret; - uint64_t *tmp_u64; - if( !(sdi = get_sigrok_device_instance(device_instances, device_index)) ) - return SIGROK_ERR; - - if(capability == HWCAP_SAMPLERATE) { - tmp_u64 = value; - ret = set_configuration_samplerate(sdi, *tmp_u64); - } - else if(capability == HWCAP_PROBECONFIG) - ret = configure_probes( (GSList *) value); - else if(capability == HWCAP_LIMIT_SAMPLES) { - limit_samples = strtoull(value, NULL, 10); - ret = SIGROK_OK; + if (!(sdi = sr_dev_inst_get(dev_insts, dev_index))) + return SR_ERR; + ctx = sdi->priv; + + if (hwcap == SR_HWCAP_SAMPLERATE) { + ret = set_samplerate(sdi, *(uint64_t *)value); + } else if (hwcap == SR_HWCAP_PROBECONFIG) { + ret = configure_probes(ctx, (GSList *) value); + } else if (hwcap == SR_HWCAP_LIMIT_SAMPLES) { + ctx->limit_samples = *(uint64_t *)value; + ret = SR_OK; + } else { + ret = SR_ERR; } - else - ret = SIGROK_ERR; return ret; } - static int receive_data(int fd, int revents, void *user_data) { struct timeval tv; + /* Avoid compiler warnings. */ + (void)fd; + (void)revents; + (void)user_data; + tv.tv_sec = tv.tv_usec = 0; libusb_handle_events_timeout(usb_context, &tv); return TRUE; } - -void receive_transfer(struct libusb_transfer *transfer) +static void receive_transfer(struct libusb_transfer *transfer) { + /* TODO: These statics have to move to the ctx struct. */ static int num_samples = 0; static int empty_transfer_count = 0; - - struct datafeed_packet packet; - void *user_data; + struct sr_datafeed_packet packet; + struct sr_datafeed_logic logic; + struct context *ctx; int cur_buflen, trigger_offset, i; unsigned char *cur_buf, *new_buf; - if(transfer == NULL) { - /* hw_stop_acquisition() telling us to stop */ + /* hw_dev_acquisition_stop() is telling us to stop. */ + if (transfer == NULL) num_samples = -1; + + /* + * If acquisition has already ended, just free any queued up + * transfer that come in. + */ + if (num_samples == -1) { + if (transfer) + libusb_free_transfer(transfer); + return; + } + + sr_info("logic: receive_transfer(): status %d received %d bytes", + transfer->status, transfer->actual_length); + + /* Save incoming transfer before reusing the transfer struct. */ + cur_buf = transfer->buffer; + cur_buflen = transfer->actual_length; + ctx = transfer->user_data; + + /* Fire off a new request. */ + if (!(new_buf = g_try_malloc(4096))) { + sr_err("logic: %s: new_buf malloc failed", __func__); + return; /* TODO: SR_ERR_MALLOC */ } - if(num_samples == -1) { - /* acquisition has already ended, just free any queued up transfer that come in */ - libusb_free_transfer(transfer); + transfer->buffer = new_buf; + transfer->length = 4096; + if (libusb_submit_transfer(transfer) != 0) { + /* TODO: Stop session? */ + /* TODO: Better error message. */ + sr_err("logic: %s: libusb_submit_transfer error", __func__); } - else { - g_message("receive_transfer(): status %d received %d bytes", transfer->status, transfer->actual_length); - - /* save the incoming transfer before reusing the transfer struct */ - cur_buf = transfer->buffer; - cur_buflen = transfer->actual_length; - user_data = transfer->user_data; - - /* fire off a new request */ - new_buf = g_malloc(4096); - transfer->buffer = new_buf; - transfer->length = 4096; - if(libusb_submit_transfer(transfer) != 0) { - /* TODO: stop session? */ - g_warning("eek"); - } - if(cur_buflen == 0) { - empty_transfer_count++; - if(empty_transfer_count > MAX_EMPTY_TRANSFERS) { - /* the FX2 gave up... end the acquisition, the frontend will work - * out that the samplecount is short - */ - packet.type = DF_END; - session_bus(user_data, &packet); - num_samples = -1; - } - return; + if (cur_buflen == 0) { + empty_transfer_count++; + if (empty_transfer_count > MAX_EMPTY_TRANSFERS) { + /* + * The FX2 gave up. End the acquisition, the frontend + * will work out that the samplecount is short. + */ + hw_dev_acquisition_stop(-1, ctx->session_data); } - else - empty_transfer_count = 0; - - trigger_offset = 0; - if(trigger_stage >= 0) - { - for(i = 0; i < cur_buflen; i++) - { - if((cur_buf[i] & trigger_mask[trigger_stage]) == trigger_value[trigger_stage]) - { - /* match on this trigger stage */ - trigger_buffer[trigger_stage] = cur_buf[i]; - trigger_stage++; - if(trigger_stage == NUM_TRIGGER_STAGES || trigger_mask[trigger_stage] == 0) - { - /* match on all trigger stages, we're done */ - trigger_offset = i+1; - - /* TODO: send pre-trigger buffer to session bus */ - - /* tell the frontend we hit the trigger here */ - packet.type = DF_TRIGGER; - packet.length = 0; - session_bus(user_data, &packet); - - /* send the samples that triggered it, since we're skipping past them */ - packet.type = DF_LOGIC8; - packet.length = trigger_stage; - packet.payload = trigger_buffer; - session_bus(user_data, &packet); - break; - - trigger_stage = TRIGGER_FIRED; - } - } - else if(trigger_stage > 0) - { - /* we had a match before, but not in the next sample. however, we may - * have a match on this stage in the next bit -- trigger on 0001 will - * fail on seeing 00001, so we need to go back to stage 0 -- but at - * the next sample from the one that matched originally, which the - * counter increment at the end of the loop takes care of. + return; + } else { + empty_transfer_count = 0; + } + + trigger_offset = 0; + if (ctx->trigger_stage >= 0) { + for (i = 0; i < cur_buflen; i++) { + + if ((cur_buf[i] & ctx->trigger_mask[ctx->trigger_stage]) == ctx->trigger_value[ctx->trigger_stage]) { + /* Match on this trigger stage. */ + ctx->trigger_buffer[ctx->trigger_stage] = cur_buf[i]; + ctx->trigger_stage++; + + if (ctx->trigger_stage == NUM_TRIGGER_STAGES || ctx->trigger_mask[ctx->trigger_stage] == 0) { + /* Match on all trigger stages, we're done. */ + trigger_offset = i + 1; + + /* + * TODO: Send pre-trigger buffer to session bus. + * Tell the frontend we hit the trigger here. */ - i -= trigger_stage; - if(i < -1) - /* oops, went back past this buffer */ - i = -1; - /* reset trigger stage */ - trigger_stage = 0; + packet.type = SR_DF_TRIGGER; + packet.payload = NULL; + sr_session_bus(ctx->session_data, &packet); + + /* + * Send the samples that triggered it, since we're + * skipping past them. + */ + packet.type = SR_DF_LOGIC; + packet.payload = &logic; + logic.length = ctx->trigger_stage; + logic.unitsize = 1; + logic.data = ctx->trigger_buffer; + sr_session_bus(ctx->session_data, &packet); + + ctx->trigger_stage = TRIGGER_FIRED; + break; } + return; } - } - if(trigger_stage == TRIGGER_FIRED) - { - /* send the incoming transfer to the session bus */ - packet.type = DF_LOGIC8; - packet.length = cur_buflen - trigger_offset; - packet.payload = cur_buf + trigger_offset; - session_bus(user_data, &packet); - g_free(cur_buf); - - num_samples += cur_buflen; - if(num_samples > limit_samples) - { - /* end the acquisition */ - packet.type = DF_END; - session_bus(user_data, &packet); - num_samples = -1; + /* + * We had a match before, but not in the next sample. However, we may + * have a match on this stage in the next bit -- trigger on 0001 will + * fail on seeing 00001, so we need to go back to stage 0 -- but at + * the next sample from the one that matched originally, which the + * counter increment at the end of the loop takes care of. + */ + if (ctx->trigger_stage > 0) { + i -= ctx->trigger_stage; + if (i < -1) + i = -1; /* Oops, went back past this buffer. */ + /* Reset trigger stage. */ + ctx->trigger_stage = 0; } } - else - { - /* TODO: buffer pre-trigger data in capture ratio-sized buffer */ + } + if (ctx->trigger_stage == TRIGGER_FIRED) { + /* Send the incoming transfer to the session bus. */ + packet.type = SR_DF_LOGIC; + packet.payload = &logic; + logic.length = cur_buflen - trigger_offset; + logic.unitsize = 1; + logic.data = cur_buf + trigger_offset; + sr_session_bus(ctx->session_data, &packet); + g_free(cur_buf); + + num_samples += cur_buflen; + if (ctx->limit_samples && (unsigned int) num_samples > ctx->limit_samples) { + hw_dev_acquisition_stop(-1, ctx->session_data); } + } else { + /* + * TODO: Buffer pre-trigger data in capture + * ratio-sized buffer. + */ } - } - -static int hw_start_acquisition(int device_index, gpointer session_device_id) +static int hw_dev_acquisition_start(int dev_index, gpointer session_data) { - struct sigrok_device_instance *sdi; - struct datafeed_packet *packet; - struct datafeed_header *header; + struct sr_dev_inst *sdi; + struct sr_datafeed_packet *packet; + struct sr_datafeed_header *header; + struct context *ctx; struct libusb_transfer *transfer; const struct libusb_pollfd **lupfd; int size, i; unsigned char *buf; - if( !(sdi = get_sigrok_device_instance(device_instances, device_index))) - return SIGROK_ERR; + if (!(sdi = sr_dev_inst_get(dev_insts, dev_index))) + return SR_ERR; + ctx = sdi->priv; + ctx->session_data = session_data; - packet = g_malloc(sizeof(struct datafeed_packet)); - header = g_malloc(sizeof(struct datafeed_header)); - if(!packet || !header) - return SIGROK_ERR; + if (!(packet = g_try_malloc(sizeof(struct sr_datafeed_packet)))) { + sr_err("logic: %s: packet malloc failed", __func__); + return SR_ERR_MALLOC; + } - /* start with 2K transfer, subsequently increased to 4K */ + if (!(header = g_try_malloc(sizeof(struct sr_datafeed_header)))) { + sr_err("logic: %s: header malloc failed", __func__); + return SR_ERR_MALLOC; + } + + /* Start with 2K transfer, subsequently increased to 4K. */ size = 2048; - for(i = 0; i < NUM_SIMUL_TRANSFERS; i++) { - buf = g_malloc(size); + for (i = 0; i < NUM_SIMUL_TRANSFERS; i++) { + if (!(buf = g_try_malloc(size))) { + sr_err("logic: %s: buf malloc failed", __func__); + return SR_ERR_MALLOC; + } transfer = libusb_alloc_transfer(0); - libusb_fill_bulk_transfer(transfer, sdi->usb->devhdl, 2 | LIBUSB_ENDPOINT_IN, buf, size, - receive_transfer, session_device_id, 40); - if(libusb_submit_transfer(transfer) != 0) { - /* TODO: free them all */ + libusb_fill_bulk_transfer(transfer, ctx->usb->devhdl, + 2 | LIBUSB_ENDPOINT_IN, buf, size, + receive_transfer, ctx, 40); + if (libusb_submit_transfer(transfer) != 0) { + /* TODO: Free them all. */ libusb_free_transfer(transfer); g_free(buf); - return SIGROK_ERR; + return SR_ERR; } size = 4096; } lupfd = libusb_get_pollfds(usb_context); - for(i = 0; lupfd[i]; i++) - source_add(lupfd[i]->fd, lupfd[i]->events, -1, receive_data, NULL); - free(lupfd); + for (i = 0; lupfd[i]; i++) + sr_source_add(lupfd[i]->fd, lupfd[i]->events, 40, receive_data, + NULL); + free(lupfd); /* NOT g_free()! */ - packet->type = DF_HEADER; - packet->length = sizeof(struct datafeed_header); - packet->payload = (unsigned char *) header; + packet->type = SR_DF_HEADER; + packet->payload = header; header->feed_version = 1; gettimeofday(&header->starttime, NULL); - header->samplerate = cur_samplerate; - header->protocol_id = PROTO_RAW; - header->num_probes = NUM_PROBES; - session_bus(session_device_id, packet); + header->samplerate = ctx->cur_samplerate; + header->num_logic_probes = ctx->profile->num_probes; + sr_session_bus(session_data, packet); g_free(header); g_free(packet); - return SIGROK_OK; + return SR_OK; } - -/* this stops acquisition on ALL devices, ignoring device_index */ -static void hw_stop_acquisition(int device_index, gpointer session_device_id) +/* This stops acquisition on ALL devices, ignoring dev_index. */ +static int hw_dev_acquisition_stop(int dev_index, gpointer session_data) { - struct datafeed_packet packet; + struct sr_datafeed_packet packet; + + /* Avoid compiler warnings. */ + (void)dev_index; - packet.type = DF_END; - session_bus(session_device_id, &packet); + packet.type = SR_DF_END; + sr_session_bus(session_data, &packet); receive_transfer(NULL); - /* TODO: need to cancel and free any queued up transfers */ + /* TODO: Need to cancel and free any queued up transfers. */ + return SR_OK; } - - -struct device_plugin saleae_logic_plugin_info = { - "saleae-logic", - 1, - hw_init, - hw_cleanup, - - hw_opendev, - hw_closedev, - hw_get_device_info, - hw_get_status, - hw_get_capabilities, - hw_set_configuration, - hw_start_acquisition, - hw_stop_acquisition +SR_PRIV struct sr_dev_plugin saleae_logic_plugin_info = { + .name = "saleae-logic", + .longname = "Saleae Logic", + .api_version = 1, + .init = hw_init, + .cleanup = hw_cleanup, + .dev_open = hw_dev_open, + .dev_close = hw_dev_close, + .dev_info_get = hw_dev_info_get, + .dev_status_get = hw_dev_status_get, + .hwcap_get_all = hw_hwcap_get_all, + .dev_config_set = hw_dev_config_set, + .dev_acquisition_start = hw_dev_acquisition_start, + .dev_acquisition_stop = hw_dev_acquisition_stop, }; -