X-Git-Url: https://sigrok.org/gitweb/?p=libsigrok.git;a=blobdiff_plain;f=hardware%2Fchronovu-la8%2Fapi.c;h=9d07955941cc674dfb94ac3db487948219f9a193;hp=7d64176c72f730fb73e18c1d35708ccee9c7a9f3;hb=ba7dd8bbb8168cba432a844259a3e239aa5f36d7;hpb=cf1ebd544652274923e808c93f7e88292acc2f11 diff --git a/hardware/chronovu-la8/api.c b/hardware/chronovu-la8/api.c index 7d64176c..9d079559 100644 --- a/hardware/chronovu-la8/api.c +++ b/hardware/chronovu-la8/api.c @@ -1,5 +1,5 @@ /* - * This file is part of the sigrok project. + * This file is part of the libsigrok project. * * Copyright (C) 2011-2012 Uwe Hermann * @@ -23,10 +23,26 @@ #include #include "libsigrok.h" #include "libsigrok-internal.h" -#include "driver.h" +#include "protocol.h" SR_PRIV struct sr_dev_driver chronovu_la8_driver_info; -static struct sr_dev_driver *cdi = &chronovu_la8_driver_info; +static struct sr_dev_driver *di = &chronovu_la8_driver_info; + +/* + * This will be initialized via config_list()/SR_CONF_SAMPLERATE. + * + * Min: 1 sample per 0.01us -> sample time is 0.084s, samplerate 100MHz + * Max: 1 sample per 2.55us -> sample time is 21.391s, samplerate 392.15kHz + */ +SR_PRIV uint64_t chronovu_la8_samplerates[255] = { 0 }; + +/* Note: Continuous sampling is not supported by the hardware. */ +SR_PRIV const int32_t chronovu_la8_hwcaps[] = { + SR_CONF_LOGIC_ANALYZER, + SR_CONF_SAMPLERATE, + SR_CONF_LIMIT_MSEC, /* TODO: Not yet implemented. */ + SR_CONF_LIMIT_SAMPLES, /* TODO: Not yet implemented. */ +}; /* * The ChronoVu LA8 can have multiple PIDs. Older versions shipped with @@ -38,54 +54,32 @@ static const uint16_t usb_pids[] = { }; /* Function prototypes. */ -static int hw_dev_acquisition_stop(const struct sr_dev_inst *sdi, - void *cb_data); +static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data); -static void clear_instances(void) +static void clear_helper(void *priv) { - GSList *l; - struct sr_dev_inst *sdi; - struct drv_context *drvc; struct dev_context *devc; + + devc = priv; - drvc = cdi->priv; - - /* Properly close all devices. */ - for (l = drvc->instances; l; l = l->next) { - if (!(sdi = l->data)) { - /* Log error, but continue cleaning up the rest. */ - sr_err("la8: %s: sdi was NULL, continuing", __func__); - continue; - } - if (sdi->priv) { - devc = sdi->priv; - ftdi_free(devc->ftdic); - g_free(devc); - } - sr_dev_inst_free(sdi); - } - g_slist_free(drvc->instances); - drvc->instances = NULL; - + ftdi_free(devc->ftdic); + g_free(devc->final_buf); } -static int hw_init(void) +static int dev_clear(void) { - struct drv_context *drvc; - - if (!(drvc = g_try_malloc0(sizeof(struct drv_context)))) { - sr_err("chronovu-la8: driver context malloc failed."); - return SR_ERR; - } - cdi->priv = drvc; + return std_dev_clear(di, clear_helper); +} - return SR_OK; +static int init(struct sr_context *sr_ctx) +{ + return std_init(sr_ctx, di, LOG_PREFIX); } -static GSList *hw_scan(GSList *options) +static GSList *scan(GSList *options) { struct sr_dev_inst *sdi; - struct sr_probe *probe; + struct sr_channel *ch; struct drv_context *drvc; struct dev_context *devc; GSList *devices; @@ -93,12 +87,14 @@ static GSList *hw_scan(GSList *options) int ret; (void)options; - drvc = cdi->priv; + + drvc = di->priv; + devices = NULL; /* Allocate memory for our private device context. */ if (!(devc = g_try_malloc(sizeof(struct dev_context)))) { - sr_err("la8: %s: struct context malloc failed", __func__); + sr_err("Device context malloc failed."); goto err_free_nothing; } @@ -107,11 +103,11 @@ static GSList *hw_scan(GSList *options) devc->cur_samplerate = SR_MHZ(100); /* 100MHz == max. samplerate */ devc->limit_msec = 0; devc->limit_samples = 0; - devc->session_dev_id = NULL; + devc->cb_data = NULL; memset(devc->mangled_buf, 0, BS); devc->final_buf = NULL; devc->trigger_pattern = 0x00; /* Value irrelevant, see trigger_mask. */ - devc->trigger_mask = 0x00; /* All probes are "don't care". */ + devc->trigger_mask = 0x00; /* All channels are "don't care". */ devc->trigger_timeout = 10; /* Default to 10s trigger timeout. */ devc->trigger_found = 0; devc->done = 0; @@ -121,24 +117,24 @@ static GSList *hw_scan(GSList *options) /* Allocate memory where we'll store the de-mangled data. */ if (!(devc->final_buf = g_try_malloc(SDRAM_SIZE))) { - sr_err("la8: %s: final_buf malloc failed", __func__); + sr_err("final_buf malloc failed."); goto err_free_devc; } /* Allocate memory for the FTDI context (ftdic) and initialize it. */ if (!(devc->ftdic = ftdi_new())) { - sr_err("la8: %s: ftdi_new failed", __func__); + sr_err("%s: ftdi_new failed.", __func__); goto err_free_final_buf; } /* Check for the device and temporarily open it. */ for (i = 0; i < ARRAY_SIZE(usb_pids); i++) { - sr_dbg("la8: Probing for VID/PID %04x:%04x.", USB_VENDOR_ID, + sr_dbg("Probing for VID/PID %04x:%04x.", USB_VENDOR_ID, usb_pids[i]); ret = ftdi_usb_open_desc(devc->ftdic, USB_VENDOR_ID, usb_pids[i], USB_DESCRIPTION, NULL); if (ret == 0) { - sr_dbg("la8: Found LA8 device (%04x:%04x).", + sr_dbg("Found LA8 device (%04x:%04x).", USB_VENDOR_ID, usb_pids[i]); devc->usb_pid = usb_pids[i]; } @@ -151,24 +147,22 @@ static GSList *hw_scan(GSList *options) sdi = sr_dev_inst_new(0, SR_ST_INITIALIZING, USB_VENDOR_NAME, USB_MODEL_NAME, USB_MODEL_VERSION); if (!sdi) { - sr_err("la8: %s: sr_dev_inst_new failed", __func__); + sr_err("%s: sr_dev_inst_new failed.", __func__); goto err_close_ftdic; } - sdi->driver = cdi; + sdi->driver = di; sdi->priv = devc; - for (i = 0; probe_names[i]; i++) { - if (!(probe = sr_probe_new(i, SR_PROBE_ANALOG, TRUE, - probe_names[i]))) + for (i = 0; chronovu_la8_channel_names[i]; i++) { + if (!(ch = sr_probe_new(i, SR_PROBE_LOGIC, TRUE, + chronovu_la8_channel_names[i]))) return NULL; - sdi->probes = g_slist_append(sdi->probes, probe); + sdi->channels = g_slist_append(sdi->channels, ch); } devices = g_slist_append(devices, sdi); drvc->instances = g_slist_append(drvc->instances, sdi); - sr_spew("la8: Device init successful."); - /* Close device. We'll reopen it again when we need it. */ (void) la8_close(devc); /* Log, but ignore errors. */ @@ -177,7 +171,7 @@ static GSList *hw_scan(GSList *options) err_close_ftdic: (void) la8_close(devc); /* Log, but ignore errors. */ err_free_ftdic: - free(devc->ftdic); /* NOT g_free()! */ + ftdi_free(devc->ftdic); /* NOT free() or g_free()! */ err_free_final_buf: g_free(devc->final_buf); err_free_devc: @@ -187,46 +181,51 @@ err_free_nothing: return NULL; } -static int hw_dev_open(struct sr_dev_inst *sdi) +static GSList *dev_list(void) +{ + return ((struct drv_context *)(di->priv))->instances; +} + +static int dev_open(struct sr_dev_inst *sdi) { struct dev_context *devc; int ret; if (!(devc = sdi->priv)) { - sr_err("la8: %s: sdi->priv was NULL", __func__); + sr_err("%s: sdi->priv was NULL.", __func__); return SR_ERR_BUG; } - sr_dbg("la8: Opening LA8 device (%04x:%04x).", USB_VENDOR_ID, + sr_dbg("Opening LA8 device (%04x:%04x).", USB_VENDOR_ID, devc->usb_pid); /* Open the device. */ if ((ret = ftdi_usb_open_desc(devc->ftdic, USB_VENDOR_ID, devc->usb_pid, USB_DESCRIPTION, NULL)) < 0) { - sr_err("la8: %s: ftdi_usb_open_desc: (%d) %s", + sr_err("%s: ftdi_usb_open_desc: (%d) %s", __func__, ret, ftdi_get_error_string(devc->ftdic)); (void) la8_close_usb_reset_sequencer(devc); /* Ignore errors. */ return SR_ERR; } - sr_dbg("la8: Device opened successfully."); + sr_dbg("Device opened successfully."); /* Purge RX/TX buffers in the FTDI chip. */ if ((ret = ftdi_usb_purge_buffers(devc->ftdic)) < 0) { - sr_err("la8: %s: ftdi_usb_purge_buffers: (%d) %s", + sr_err("%s: ftdi_usb_purge_buffers: (%d) %s", __func__, ret, ftdi_get_error_string(devc->ftdic)); (void) la8_close_usb_reset_sequencer(devc); /* Ignore errors. */ goto err_dev_open_close_ftdic; } - sr_dbg("la8: FTDI buffers purged successfully."); + sr_dbg("FTDI buffers purged successfully."); /* Enable flow control in the FTDI chip. */ if ((ret = ftdi_setflowctrl(devc->ftdic, SIO_RTS_CTS_HS)) < 0) { - sr_err("la8: %s: ftdi_setflowcontrol: (%d) %s", + sr_err("%s: ftdi_setflowcontrol: (%d) %s", __func__, ret, ftdi_get_error_string(devc->ftdic)); (void) la8_close_usb_reset_sequencer(devc); /* Ignore errors. */ goto err_dev_open_close_ftdic; } - sr_dbg("la8: FTDI flow control enabled successfully."); + sr_dbg("FTDI flow control enabled successfully."); /* Wait 100ms. */ g_usleep(100 * 1000); @@ -240,133 +239,135 @@ err_dev_open_close_ftdic: return SR_ERR; } -static int hw_dev_close(struct sr_dev_inst *sdi) +static int dev_close(struct sr_dev_inst *sdi) { struct dev_context *devc; - if (!(devc = sdi->priv)) { - sr_err("la8: %s: sdi->priv was NULL", __func__); - return SR_ERR_BUG; - } - - sr_dbg("la8: Closing device."); + devc = sdi->priv; if (sdi->status == SR_ST_ACTIVE) { - sr_dbg("la8: Status ACTIVE, closing device."); - /* TODO: Really ignore errors here, or return SR_ERR? */ + sr_dbg("Status ACTIVE, closing device."); (void) la8_close_usb_reset_sequencer(devc); /* Ignore errors. */ } else { - sr_spew("la8: Status not ACTIVE, nothing to do."); + sr_spew("Status not ACTIVE, nothing to do."); } sdi->status = SR_ST_INACTIVE; - sr_dbg("la8: Freeing sample buffer."); - g_free(devc->final_buf); - return SR_OK; } -static int hw_cleanup(void) +static int cleanup(void) { - - if (!cdi->priv) - return SR_OK; - - clear_instances(); - - return SR_OK; + return dev_clear(); } -static int hw_info_get(int info_id, const void **data, - const struct sr_dev_inst *sdi) +static int config_get(int id, GVariant **data, const struct sr_dev_inst *sdi, + const struct sr_channel_group *cg) { struct dev_context *devc; - switch (info_id) { - case SR_DI_HWCAPS: - *data = hwcaps; - break; - case SR_DI_NUM_PROBES: - *data = GINT_TO_POINTER(NUM_PROBES); - sr_spew("la8: %s: Returning number of probes: %d.", __func__, - NUM_PROBES); - break; - case SR_DI_PROBE_NAMES: - *data = probe_names; - sr_spew("la8: %s: Returning probenames.", __func__); - break; - case SR_DI_SAMPLERATES: - fill_supported_samplerates_if_needed(); - *data = &samplerates; - sr_spew("la8: %s: Returning samplerates.", __func__); - break; - case SR_DI_TRIGGER_TYPES: - *data = (char *)TRIGGER_TYPES; - sr_spew("la8: %s: Returning trigger types: %s.", __func__, - TRIGGER_TYPES); - break; - case SR_DI_CUR_SAMPLERATE: + (void)cg; + + switch (id) { + case SR_CONF_SAMPLERATE: if (sdi) { devc = sdi->priv; - *data = &devc->cur_samplerate; - sr_spew("la8: %s: Returning samplerate: %" PRIu64 "Hz.", + *data = g_variant_new_uint64(devc->cur_samplerate); + sr_spew("%s: Returning samplerate: %" PRIu64 "Hz.", __func__, devc->cur_samplerate); } else return SR_ERR; break; default: - return SR_ERR_ARG; + return SR_ERR_NA; } return SR_OK; } -static int hw_dev_config_set(const struct sr_dev_inst *sdi, int hwcap, - const void *value) +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; + + if (sdi->status != SR_ST_ACTIVE) + return SR_ERR_DEV_CLOSED; + if (!(devc = sdi->priv)) { - sr_err("la8: %s: sdi->priv was NULL", __func__); + sr_err("%s: sdi->priv was NULL.", __func__); return SR_ERR_BUG; } - switch (hwcap) { - case SR_HWCAP_SAMPLERATE: - if (set_samplerate(sdi, *(const uint64_t *)value) == SR_ERR) { - sr_err("la8: %s: setting samplerate failed.", __func__); - return SR_ERR; - } - sr_dbg("la8: SAMPLERATE = %" PRIu64, devc->cur_samplerate); - break; - case SR_HWCAP_PROBECONFIG: - if (configure_probes(devc, (const GSList *)value) != SR_OK) { - sr_err("la8: %s: probe config failed.", __func__); + switch (id) { + case SR_CONF_SAMPLERATE: + if (set_samplerate(sdi, g_variant_get_uint64(data)) == SR_ERR) { + sr_err("%s: setting samplerate failed.", __func__); return SR_ERR; } + sr_dbg("SAMPLERATE = %" PRIu64, devc->cur_samplerate); break; - case SR_HWCAP_LIMIT_MSEC: - if (*(const uint64_t *)value == 0) { - sr_err("la8: %s: LIMIT_MSEC can't be 0.", __func__); + case SR_CONF_LIMIT_MSEC: + if (g_variant_get_uint64(data) == 0) { + sr_err("%s: LIMIT_MSEC can't be 0.", __func__); return SR_ERR; } - devc->limit_msec = *(const uint64_t *)value; - sr_dbg("la8: LIMIT_MSEC = %" PRIu64, devc->limit_msec); + devc->limit_msec = g_variant_get_uint64(data); + sr_dbg("LIMIT_MSEC = %" PRIu64, devc->limit_msec); break; - case SR_HWCAP_LIMIT_SAMPLES: - if (*(const uint64_t *)value < MIN_NUM_SAMPLES) { - sr_err("la8: %s: LIMIT_SAMPLES too small.", __func__); + case SR_CONF_LIMIT_SAMPLES: + if (g_variant_get_uint64(data) < MIN_NUM_SAMPLES) { + sr_err("%s: LIMIT_SAMPLES too small.", __func__); return SR_ERR; } - devc->limit_samples = *(const uint64_t *)value; - sr_dbg("la8: LIMIT_SAMPLES = %" PRIu64, devc->limit_samples); + devc->limit_samples = g_variant_get_uint64(data); + sr_dbg("LIMIT_SAMPLES = %" PRIu64, devc->limit_samples); break; default: - /* Unknown capability, return SR_ERR. */ - sr_err("la8: %s: Unknown capability.", __func__); - return SR_ERR; + return SR_ERR_NA; + } + + return SR_OK; +} + +static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi, + const struct sr_channel_group *cg) +{ + GVariant *gvar, *grange[2]; + GVariantBuilder gvb; + + (void)sdi; + (void)cg; + + switch (key) { + case SR_CONF_DEVICE_OPTIONS: + *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32, + chronovu_la8_hwcaps, + ARRAY_SIZE(chronovu_la8_hwcaps), + sizeof(int32_t)); + break; + case SR_CONF_SAMPLERATE: + fill_supported_samplerates_if_needed(); + g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}")); + gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"), + chronovu_la8_samplerates, + ARRAY_SIZE(chronovu_la8_samplerates), + sizeof(uint64_t)); + g_variant_builder_add(&gvb, "{sv}", "samplerates", gvar); + *data = g_variant_builder_end(&gvb); break; + case SR_CONF_LIMIT_SAMPLES: + grange[0] = g_variant_new_uint64(0); + grange[1] = g_variant_new_uint64(MAX_NUM_SAMPLES); + *data = g_variant_new_tuple(grange, 2); + break; + case SR_CONF_TRIGGER_TYPE: + *data = g_variant_new_string(TRIGGER_TYPE); + break; + default: + return SR_ERR_NA; } return SR_OK; @@ -378,29 +379,28 @@ static int receive_data(int fd, int revents, void *cb_data) struct sr_dev_inst *sdi; struct dev_context *devc; - /* Avoid compiler errors. */ (void)fd; (void)revents; if (!(sdi = cb_data)) { - sr_err("la8: %s: cb_data was NULL", __func__); + sr_err("%s: cb_data was NULL.", __func__); return FALSE; } if (!(devc = sdi->priv)) { - sr_err("la8: %s: sdi->priv was NULL", __func__); + sr_err("%s: sdi->priv was NULL.", __func__); return FALSE; } if (!devc->ftdic) { - sr_err("la8: %s: devc->ftdic was NULL", __func__); + sr_err("%s: devc->ftdic was NULL.", __func__); return FALSE; } /* Get one block of data. */ if ((ret = la8_read_block(devc)) < 0) { - sr_err("la8: %s: la8_read_block error: %d", __func__, ret); - hw_dev_acquisition_stop(sdi, sdi); + sr_err("%s: la8_read_block error: %d.", __func__, ret); + dev_acquisition_stop(sdi, sdi); return FALSE; } @@ -410,45 +410,46 @@ static int receive_data(int fd, int revents, void *cb_data) return TRUE; } - sr_dbg("la8: Sampling finished, sending data to session bus now."); + sr_dbg("Sampling finished, sending data to session bus now."); /* All data was received and demangled, send it to the session bus. */ for (i = 0; i < NUM_BLOCKS; i++) send_block_to_session_bus(devc, i); - hw_dev_acquisition_stop(sdi, sdi); + dev_acquisition_stop(sdi, sdi); - // return FALSE; /* FIXME? */ return TRUE; } -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) { struct dev_context *devc; - struct sr_datafeed_packet packet; - struct sr_datafeed_header header; - struct sr_datafeed_meta_logic meta; uint8_t buf[4]; int bytes_written; + if (sdi->status != SR_ST_ACTIVE) + return SR_ERR_DEV_CLOSED; + if (!(devc = sdi->priv)) { - sr_err("la8: %s: sdi->priv was NULL", __func__); + sr_err("%s: sdi->priv was NULL.", __func__); return SR_ERR_BUG; } if (!devc->ftdic) { - sr_err("la8: %s: devc->ftdic was NULL", __func__); + sr_err("%s: devc->ftdic was NULL.", __func__); return SR_ERR_BUG; } devc->divcount = samplerate_to_divcount(devc->cur_samplerate); if (devc->divcount == 0xff) { - sr_err("la8: %s: invalid divcount/samplerate", __func__); + sr_err("%s: Invalid divcount/samplerate.", __func__); return SR_ERR; } - sr_dbg("la8: Starting acquisition."); + if (configure_channels(sdi) != SR_OK) { + sr_err("Failed to configure channels."); + return SR_ERR; + } /* Fill acquisition parameters into buf[]. */ buf[0] = devc->divcount; @@ -460,31 +461,19 @@ static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi, bytes_written = la8_write(devc, buf, 4); if (bytes_written < 0) { - sr_err("la8: Acquisition failed to start."); + sr_err("Acquisition failed to start: %d.", bytes_written); return SR_ERR; } else if (bytes_written != 4) { - sr_err("la8: Acquisition failed to start."); - return SR_ERR; /* TODO: Other error and return code? */ + sr_err("Acquisition failed to start: %d.", bytes_written); + return SR_ERR; } - sr_dbg("la8: Acquisition started successfully."); + sr_dbg("Hardware acquisition started successfully."); - devc->session_dev_id = cb_data; + devc->cb_data = cb_data; /* Send header packet to the session bus. */ - sr_dbg("la8: Sending SR_DF_HEADER."); - packet.type = SR_DF_HEADER; - packet.payload = &header; - header.feed_version = 1; - gettimeofday(&header.starttime, NULL); - sr_session_send(devc->session_dev_id, &packet); - - /* Send metadata about the SR_DF_LOGIC packets to come. */ - packet.type = SR_DF_META_LOGIC; - packet.payload = &meta; - meta.samplerate = devc->cur_samplerate; - meta.num_probes = NUM_PROBES; - sr_session_send(devc->session_dev_id, &packet); + std_session_send_df_header(cb_data, LOG_PREFIX); /* Time when we should be done (for detecting trigger timeouts). */ devc->done = (devc->divcount + 1) * 0.08388608 + time(NULL) @@ -498,21 +487,17 @@ static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi, return SR_OK; } -static int hw_dev_acquisition_stop(const struct sr_dev_inst *sdi, - void *cb_data) +static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data) { - struct dev_context *devc; struct sr_datafeed_packet packet; - sr_dbg("la8: Stopping acquisition."); + (void)sdi; - if (!(devc = sdi->priv)) { - sr_err("la8: %s: sdi->priv was NULL", __func__); - return SR_ERR_BUG; - } + sr_dbg("Stopping acquisition."); + sr_source_remove(-1); /* Send end packet to the session bus. */ - sr_dbg("la8: Sending SR_DF_END."); + sr_dbg("Sending SR_DF_END."); packet.type = SR_DF_END; sr_session_send(cb_data, &packet); @@ -523,14 +508,17 @@ SR_PRIV struct sr_dev_driver chronovu_la8_driver_info = { .name = "chronovu-la8", .longname = "ChronoVu LA8", .api_version = 1, - .init = hw_init, - .cleanup = hw_cleanup, - .scan = hw_scan, - .dev_open = hw_dev_open, - .dev_close = hw_dev_close, - .info_get = hw_info_get, - .dev_config_set = hw_dev_config_set, - .dev_acquisition_start = hw_dev_acquisition_start, - .dev_acquisition_stop = hw_dev_acquisition_stop, + .init = init, + .cleanup = cleanup, + .scan = scan, + .dev_list = dev_list, + .dev_clear = dev_clear, + .config_get = config_get, + .config_set = config_set, + .config_list = config_list, + .dev_open = dev_open, + .dev_close = dev_close, + .dev_acquisition_start = dev_acquisition_start, + .dev_acquisition_stop = dev_acquisition_stop, .priv = NULL, };