X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=src%2Fhardware%2Fasix-sigma%2Fapi.c;h=4fdafec955eb1cfb1b1ef4eb112a2192f63b1e22;hb=584269fd2f44daa61497fb2cc9baa10a472577b0;hp=15c222521aca1c7d6fd0f0ae01ec10f55a694960;hpb=9fb4c6324dc05e909387c3db44d5a43d899c8641;p=libsigrok.git diff --git a/src/hardware/asix-sigma/api.c b/src/hardware/asix-sigma/api.c index 15c22252..4fdafec9 100644 --- a/src/hardware/asix-sigma/api.c +++ b/src/hardware/asix-sigma/api.c @@ -4,6 +4,7 @@ * Copyright (C) 2010-2012 Håvard Espeland , * Copyright (C) 2010 Martin Stensgård * Copyright (C) 2010 Carl Henrik Lunde + * Copyright (C) 2020 Gerhard Sittig * * 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 @@ -23,9 +24,9 @@ #include "protocol.h" /* - * Channel numbers seem to go from 1-16, according to this image: - * http://tools.asix.net/img/sigma_sigmacab_pins_720.jpg - * (the cable has two additional GND pins, and a TI and TO pin) + * Channels are labelled 1-16, see this vendor's image of the cable: + * http://tools.asix.net/img/sigma_sigmacab_pins_720.jpg (TI/TO are + * additional trigger in/out signals). */ static const char *channel_names[] = { "1", "2", "3", "4", "5", "6", "7", "8", @@ -45,29 +46,36 @@ static const uint32_t devopts[] = { SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET, SR_CONF_CONN | SR_CONF_GET, SR_CONF_SAMPLERATE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST, -#if ASIX_SIGMA_WITH_TRIGGER + SR_CONF_EXTERNAL_CLOCK | SR_CONF_GET | SR_CONF_SET, + SR_CONF_EXTERNAL_CLOCK_SOURCE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST, + SR_CONF_CLOCK_EDGE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST, SR_CONF_TRIGGER_MATCH | SR_CONF_LIST, SR_CONF_CAPTURE_RATIO | SR_CONF_GET | SR_CONF_SET, -#endif + /* Consider SR_CONF_TRIGGER_PATTERN (SR_T_STRING, GET/SET) support. */ +}; + +static const char *ext_clock_edges[] = { + [SIGMA_CLOCK_EDGE_RISING] = "rising", + [SIGMA_CLOCK_EDGE_FALLING] = "falling", + [SIGMA_CLOCK_EDGE_EITHER] = "either", }; -#if ASIX_SIGMA_WITH_TRIGGER static const int32_t trigger_matches[] = { SR_TRIGGER_ZERO, SR_TRIGGER_ONE, SR_TRIGGER_RISING, SR_TRIGGER_FALLING, }; -#endif static void clear_helper(struct dev_context *devc) { - ftdi_deinit(&devc->ftdic); + (void)sigma_force_close(devc); } static int dev_clear(const struct sr_dev_driver *di) { - return std_dev_clear_with_callback(di, (std_dev_clear_callback)clear_helper); + return std_dev_clear_with_callback(di, + (std_dev_clear_callback)clear_helper); } static gboolean bus_addr_in_devices(int bus, int addr, GSList *devs) @@ -85,9 +93,13 @@ static gboolean bus_addr_in_devices(int bus, int addr, GSList *devs) static gboolean known_vid_pid(const struct libusb_device_descriptor *des) { + gboolean is_sigma, is_omega; + if (des->idVendor != USB_VENDOR_ASIX) return FALSE; - if (des->idProduct != USB_PRODUCT_SIGMA && des->idProduct != USB_PRODUCT_OMEGA) + is_sigma = des->idProduct == USB_PRODUCT_SIGMA; + is_omega = des->idProduct == USB_PRODUCT_OMEGA; + if (!is_sigma && !is_omega) return FALSE; return TRUE; } @@ -108,7 +120,7 @@ static GSList *scan(struct sr_dev_driver *di, GSList *options) char conn_id[20]; char serno_txt[16]; char *end; - long serno_num, serno_pre; + unsigned long serno_num, serno_pre; enum asix_device_type dev_type; const char *dev_text; struct sr_dev_inst *sdi; @@ -180,7 +192,7 @@ static GSList *scan(struct sr_dev_driver *di, GSList *options) * All ASIX logic analyzers have a serial number, which * reads as a hex number, and tells the device type. */ - ret = sr_atol_base(serno_txt, &serno_num, &end, 16); + ret = sr_atoul_base(serno_txt, &serno_num, &end, 16); if (ret != SR_OK || !end || *end) { sr_warn("Cannot interpret serial number %s.", serno_txt); continue; @@ -233,14 +245,12 @@ static GSList *scan(struct sr_dev_driver *di, GSList *options) devc->id.serno = serno_num; devc->id.prefix = serno_pre; devc->id.type = dev_type; - devc->cur_samplerate = samplerates[0]; - devc->limit_msec = 0; - devc->limit_samples = 0; - devc->cur_firmware = -1; - devc->num_channels = 0; - devc->samples_per_event = 0; + sr_sw_limits_init(&devc->limit.config); devc->capture_ratio = 50; - devc->use_triggers = 0; + devc->use_triggers = FALSE; + + /* Get current hardware configuration (or use defaults). */ + (void)sigma_fetch_hw_config(sdi); } libusb_free_device_list(devlist, 1); g_slist_free_full(conn_devices, (GDestroyNotify)sr_usb_dev_inst_free); @@ -251,9 +261,6 @@ static GSList *scan(struct sr_dev_driver *di, GSList *options) static int dev_open(struct sr_dev_inst *sdi) { struct dev_context *devc; - long vid, pid; - const char *serno; - int ret; devc = sdi->priv; @@ -261,43 +268,24 @@ static int dev_open(struct sr_dev_inst *sdi) sr_err("OMEGA support is not implemented yet."); return SR_ERR_NA; } - vid = devc->id.vid; - pid = devc->id.pid; - serno = sdi->serial_num; - - ret = ftdi_init(&devc->ftdic); - if (ret < 0) { - sr_err("Cannot initialize FTDI context (%d): %s.", - ret, ftdi_get_error_string(&devc->ftdic)); - return SR_ERR_IO; - } - ret = ftdi_usb_open_desc_index(&devc->ftdic, vid, pid, NULL, serno, 0); - if (ret < 0) { - sr_err("Cannot open device (%d): %s.", - ret, ftdi_get_error_string(&devc->ftdic)); - return SR_ERR_IO; - } - return SR_OK; + return sigma_force_open(sdi); } static int dev_close(struct sr_dev_inst *sdi) { struct dev_context *devc; - int ret; devc = sdi->priv; - ret = ftdi_usb_close(&devc->ftdic); - ftdi_deinit(&devc->ftdic); - - return (ret == 0) ? SR_OK : SR_ERR; + return sigma_force_close(devc); } 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; + const char *clock_text; (void)cg; @@ -310,19 +298,25 @@ static int config_get(uint32_t key, GVariant **data, *data = g_variant_new_string(sdi->connection_id); break; case SR_CONF_SAMPLERATE: - *data = g_variant_new_uint64(devc->cur_samplerate); + *data = g_variant_new_uint64(devc->clock.samplerate); break; - case SR_CONF_LIMIT_MSEC: - *data = g_variant_new_uint64(devc->limit_msec); + case SR_CONF_EXTERNAL_CLOCK: + *data = g_variant_new_boolean(devc->clock.use_ext_clock); break; - case SR_CONF_LIMIT_SAMPLES: - *data = g_variant_new_uint64(devc->limit_samples); + case SR_CONF_EXTERNAL_CLOCK_SOURCE: + clock_text = channel_names[devc->clock.clock_pin]; + *data = g_variant_new_string(clock_text); break; -#if ASIX_SIGMA_WITH_TRIGGER + case SR_CONF_CLOCK_EDGE: + clock_text = ext_clock_edges[devc->clock.clock_edge]; + *data = g_variant_new_string(clock_text); + break; + case SR_CONF_LIMIT_MSEC: + case SR_CONF_LIMIT_SAMPLES: + return sr_sw_limits_config_get(&devc->limit.config, key, data); case SR_CONF_CAPTURE_RATIO: *data = g_variant_new_uint64(devc->capture_ratio); break; -#endif default: return SR_ERR_NA; } @@ -334,6 +328,9 @@ 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; + int ret; + uint64_t want_rate, have_rate; + int idx; (void)cg; @@ -341,20 +338,42 @@ static int config_set(uint32_t key, GVariant *data, switch (key) { case SR_CONF_SAMPLERATE: - return sigma_set_samplerate(sdi, g_variant_get_uint64(data)); - case SR_CONF_LIMIT_MSEC: - devc->limit_msec = g_variant_get_uint64(data); + want_rate = g_variant_get_uint64(data); + ret = sigma_normalize_samplerate(want_rate, &have_rate); + if (ret != SR_OK) + return ret; + if (have_rate != want_rate) { + char *text_want, *text_have; + text_want = sr_samplerate_string(want_rate); + text_have = sr_samplerate_string(have_rate); + sr_info("Adjusted samplerate %s to %s.", + text_want, text_have); + g_free(text_want); + g_free(text_have); + } + devc->clock.samplerate = have_rate; break; - case SR_CONF_LIMIT_SAMPLES: - devc->limit_samples = g_variant_get_uint64(data); - devc->limit_msec = sigma_limit_samples_to_msec(devc, - devc->limit_samples); + case SR_CONF_EXTERNAL_CLOCK: + devc->clock.use_ext_clock = g_variant_get_boolean(data); + break; + case SR_CONF_EXTERNAL_CLOCK_SOURCE: + idx = std_str_idx(data, ARRAY_AND_SIZE(channel_names)); + if (idx < 0) + return SR_ERR_ARG; + devc->clock.clock_pin = idx; break; -#if ASIX_SIGMA_WITH_TRIGGER + case SR_CONF_CLOCK_EDGE: + idx = std_str_idx(data, ARRAY_AND_SIZE(ext_clock_edges)); + if (idx < 0) + return SR_ERR_ARG; + devc->clock.clock_edge = idx; + break; + case SR_CONF_LIMIT_MSEC: + case SR_CONF_LIMIT_SAMPLES: + return sr_sw_limits_config_set(&devc->limit.config, key, data); case SR_CONF_CAPTURE_RATIO: devc->capture_ratio = g_variant_get_uint64(data); break; -#endif default: return SR_ERR_NA; } @@ -370,15 +389,20 @@ static int config_list(uint32_t key, GVariant **data, case SR_CONF_DEVICE_OPTIONS: if (cg) return SR_ERR_NA; - return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts); + return STD_CONFIG_LIST(key, data, sdi, cg, + scanopts, drvopts, devopts); case SR_CONF_SAMPLERATE: - *data = std_gvar_samplerates(samplerates, samplerates_count); + *data = sigma_get_samplerates_list(); + break; + case SR_CONF_EXTERNAL_CLOCK_SOURCE: + *data = g_variant_new_strv(ARRAY_AND_SIZE(channel_names)); + break; + case SR_CONF_CLOCK_EDGE: + *data = g_variant_new_strv(ARRAY_AND_SIZE(ext_clock_edges)); break; -#if ASIX_SIGMA_WITH_TRIGGER case SR_CONF_TRIGGER_MATCH: *data = std_gvar_array_i32(ARRAY_AND_SIZE(trigger_matches)); break; -#endif default: return SR_ERR_NA; } @@ -389,115 +413,194 @@ static int config_list(uint32_t key, GVariant **data, static int dev_acquisition_start(const struct sr_dev_inst *sdi) { struct dev_context *devc; - struct clockselect_50 clockselect; - int triggerpin, ret; - uint8_t triggerselect; + uint16_t pindis_mask; + uint8_t async, div; + int ret; + size_t triggerpin; + uint8_t trigsel2; struct triggerinout triggerinout_conf; struct triggerlut lut; - uint8_t regval; - uint8_t clock_bytes[sizeof(clockselect)]; - size_t clock_idx; + uint8_t regval, cmd_bytes[4], *wrptr; devc = sdi->priv; - if (sigma_convert_trigger(sdi) != SR_OK) { - sr_err("Failed to configure triggers."); - return SR_ERR; + /* Convert caller's trigger spec to driver's internal format. */ + ret = sigma_convert_trigger(sdi); + if (ret != SR_OK) { + sr_err("Could not configure triggers."); + return ret; } - /* If the samplerate has not been set, default to 200 kHz. */ - if (devc->cur_firmware == -1) { - if ((ret = sigma_set_samplerate(sdi, SR_KHZ(200))) != SR_OK) - return ret; + /* + * Setup the device's samplerate from the value which up to now + * just got checked and stored. As a byproduct this can pick and + * send firmware to the device, reduce the number of available + * logic channels, etc. + * + * Determine an acquisition timeout from optionally configured + * sample count or time limits. Which depends on the samplerate. + * Force 50MHz samplerate when external clock is in use. + */ + if (devc->clock.use_ext_clock) { + if (devc->clock.samplerate != SR_MHZ(50)) + sr_info("External clock, forcing 50MHz samplerate."); + devc->clock.samplerate = SR_MHZ(50); } + ret = sigma_set_samplerate(sdi); + if (ret != SR_OK) + return ret; + ret = sigma_set_acquire_timeout(devc); + if (ret != SR_OK) + return ret; /* Enter trigger programming mode. */ - sigma_set_register(WRITE_TRIGGER_SELECT2, 0x20, devc); + trigsel2 = TRGSEL2_RESET; + ret = sigma_set_register(devc, WRITE_TRIGGER_SELECT2, trigsel2); + if (ret != SR_OK) + return ret; - triggerselect = 0; - if (devc->cur_samplerate >= SR_MHZ(100)) { + trigsel2 = 0; + if (devc->clock.samplerate >= SR_MHZ(100)) { /* 100 and 200 MHz mode. */ - sigma_set_register(WRITE_TRIGGER_SELECT2, 0x81, devc); + /* TODO Decipher the 0x81 magic number's purpose. */ + ret = sigma_set_register(devc, WRITE_TRIGGER_SELECT2, 0x81); + if (ret != SR_OK) + return ret; /* Find which pin to trigger on from mask. */ - for (triggerpin = 0; triggerpin < 8; triggerpin++) - if ((devc->trigger.risingmask | devc->trigger.fallingmask) & - (1 << triggerpin)) + for (triggerpin = 0; triggerpin < 8; triggerpin++) { + if (devc->trigger.risingmask & BIT(triggerpin)) + break; + if (devc->trigger.fallingmask & BIT(triggerpin)) break; + } /* Set trigger pin and light LED on trigger. */ - triggerselect = (1 << LEDSEL1) | (triggerpin & 0x7); + trigsel2 = triggerpin & TRGSEL2_PINS_MASK; + trigsel2 |= TRGSEL2_LEDSEL1; /* Default rising edge. */ + /* TODO Documentation disagrees, bit set means _rising_ edge. */ if (devc->trigger.fallingmask) - triggerselect |= 1 << 3; + trigsel2 |= TRGSEL2_PINPOL_RISE; + + } else if (devc->clock.samplerate <= SR_MHZ(50)) { + /* 50MHz firmware modes. */ - } else if (devc->cur_samplerate <= SR_MHZ(50)) { - /* All other modes. */ - sigma_build_basic_trigger(&lut, devc); + /* Translate application specs to hardware perspective. */ + ret = sigma_build_basic_trigger(devc, &lut); + if (ret != SR_OK) + return ret; - sigma_write_trigger_lut(&lut, devc); + /* Communicate resulting register values to the device. */ + ret = sigma_write_trigger_lut(devc, &lut); + if (ret != SR_OK) + return ret; - triggerselect = (1 << LEDSEL1) | (1 << LEDSEL0); + trigsel2 = TRGSEL2_LEDSEL1 | TRGSEL2_LEDSEL0; } /* Setup trigger in and out pins to default values. */ - memset(&triggerinout_conf, 0, sizeof(struct triggerinout)); - triggerinout_conf.trgout_bytrigger = 1; - triggerinout_conf.trgout_enable = 1; - - sigma_write_register(WRITE_TRIGGER_OPTION, - (uint8_t *) &triggerinout_conf, - sizeof(struct triggerinout), devc); - - /* Go back to normal mode. */ - sigma_set_register(WRITE_TRIGGER_SELECT2, triggerselect, devc); - - /* Set clock select register. */ - clockselect.async = 0; - clockselect.fraction = 1 - 1; /* Divider 1. */ - clockselect.disabled_channels = 0x0000; /* All channels enabled. */ - if (devc->cur_samplerate == SR_MHZ(200)) { - /* Enable 4 channels. */ - clockselect.disabled_channels = 0xf0ff; - } else if (devc->cur_samplerate == SR_MHZ(100)) { - /* Enable 8 channels. */ - clockselect.disabled_channels = 0x00ff; + memset(&triggerinout_conf, 0, sizeof(triggerinout_conf)); + triggerinout_conf.trgout_bytrigger = TRUE; + triggerinout_conf.trgout_enable = TRUE; + /* TODO + * Verify the correctness of this implementation. The previous + * version used to assign to a C language struct with bit fields + * which is highly non-portable and hard to guess the resulting + * raw memory layout or wire transfer content. The C struct's + * field names did not match the vendor documentation's names. + * Which means that I could not verify "on paper" either. Let's + * re-visit this code later during research for trigger support. + */ + wrptr = cmd_bytes; + regval = 0; + if (triggerinout_conf.trgout_bytrigger) + regval |= TRGOPT_TRGOOUTEN; + write_u8_inc(&wrptr, regval); + regval &= ~TRGOPT_CLEAR_MASK; + if (triggerinout_conf.trgout_enable) + regval |= TRGOPT_TRGOEN; + write_u8_inc(&wrptr, regval); + ret = sigma_write_register(devc, WRITE_TRIGGER_OPTION, + cmd_bytes, wrptr - cmd_bytes); + if (ret != SR_OK) + return ret; + + /* Leave trigger programming mode. */ + ret = sigma_set_register(devc, WRITE_TRIGGER_SELECT2, trigsel2); + if (ret != SR_OK) + return ret; + + /* + * Samplerate dependent clock and channels configuration. Some + * channels by design are not available at higher clock rates. + * Register layout differs between firmware variants (depth 1 + * with LSB channel mask above 50MHz, depth 4 with more details + * up to 50MHz). + * + * Derive a mask where bits are set for unavailable channels. + * Either send the single byte, or the full byte sequence. + */ + pindis_mask = ~BITS_MASK(devc->interp.num_channels); + if (devc->clock.samplerate > SR_MHZ(50)) { + ret = sigma_set_register(devc, WRITE_CLOCK_SELECT, + pindis_mask & 0xff); } else { - /* - * 50 MHz mode, or fraction thereof. The 50MHz reference - * can get divided by any integer in the range 1 to 256. - * Divider minus 1 gets written to the hardware. - * (The driver lists a discrete set of sample rates, but - * all of them fit the above description.) - */ - clockselect.fraction = SR_MHZ(50) / devc->cur_samplerate - 1; + wrptr = cmd_bytes; + /* Select 50MHz base clock, and divider. */ + async = 0; + div = SR_MHZ(50) / devc->clock.samplerate - 1; + if (devc->clock.use_ext_clock) { + async = CLKSEL_CLKSEL8; + div = devc->clock.clock_pin + 1; + switch (devc->clock.clock_edge) { + case SIGMA_CLOCK_EDGE_RISING: + div |= CLKSEL_RISING; + break; + case SIGMA_CLOCK_EDGE_FALLING: + div |= CLKSEL_FALLING; + break; + case SIGMA_CLOCK_EDGE_EITHER: + div |= CLKSEL_RISING; + div |= CLKSEL_FALLING; + break; + } + } + write_u8_inc(&wrptr, async); + write_u8_inc(&wrptr, div); + write_u16be_inc(&wrptr, pindis_mask); + ret = sigma_write_register(devc, WRITE_CLOCK_SELECT, + cmd_bytes, wrptr - cmd_bytes); } - clock_idx = 0; - clock_bytes[clock_idx++] = clockselect.async; - clock_bytes[clock_idx++] = clockselect.fraction; - clock_bytes[clock_idx++] = clockselect.disabled_channels & 0xff; - clock_bytes[clock_idx++] = clockselect.disabled_channels >> 8; - sigma_write_register(WRITE_CLOCK_SELECT, clock_bytes, clock_idx, devc); + if (ret != SR_OK) + return ret; /* Setup maximum post trigger time. */ - sigma_set_register(WRITE_POST_TRIGGER, - (devc->capture_ratio * 255) / 100, devc); + ret = sigma_set_register(devc, WRITE_POST_TRIGGER, + (devc->capture_ratio * 255) / 100); + if (ret != SR_OK) + return ret; /* Start acqusition. */ - devc->start_time = g_get_monotonic_time(); - regval = WMR_TRGRES | WMR_SDRAMWRITEEN; -#if ASIX_SIGMA_WITH_TRIGGER - regval |= WMR_TRGEN; -#endif - sigma_set_register(WRITE_MODE, regval, devc); + regval = WMR_TRGRES | WMR_SDRAMWRITEEN; + if (devc->use_triggers) + regval |= WMR_TRGEN; + ret = sigma_set_register(devc, WRITE_MODE, regval); + if (ret != SR_OK) + return ret; - std_session_send_df_header(sdi); + ret = std_session_send_df_header(sdi); + if (ret != SR_OK) + return ret; /* Add capture source. */ - sr_session_source_add(sdi->session, -1, 0, 10, sigma_receive_data, (void *)sdi); + ret = sr_session_source_add(sdi->session, -1, 0, 10, + sigma_receive_data, (void *)sdi); + if (ret != SR_OK) + return ret; - devc->state.state = SIGMA_CAPTURE; + devc->state = SIGMA_CAPTURE; return SR_OK; } @@ -515,11 +618,11 @@ static int dev_acquisition_stop(struct sr_dev_inst *sdi) * already. The detour is required to have sample data retrieved * for forced acquisition stops. */ - if (devc->state.state == SIGMA_CAPTURE) { - devc->state.state = SIGMA_STOPPING; + if (devc->state == SIGMA_CAPTURE) { + devc->state = SIGMA_STOPPING; } else { - devc->state.state = SIGMA_IDLE; - sr_session_source_remove(sdi->session, -1); + devc->state = SIGMA_IDLE; + (void)sr_session_source_remove(sdi->session, -1); } return SR_OK;