2 * This file is part of the libsigrok project.
4 * Copyright (C) 2010-2012 Håvard Espeland <gus@ping.uio.no>,
5 * Copyright (C) 2010 Martin Stensgård <mastensg@ping.uio.no>
6 * Copyright (C) 2010 Carl Henrik Lunde <chlunde@ping.uio.no>
7 * Copyright (C) 2020 Gerhard Sittig <gerhard.sittig@gmx.net>
9 * This program is free software: you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation, either version 3 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program. If not, see <http://www.gnu.org/licenses/>.
27 * Channel numbers seem to go from 1-16, according to this image:
28 * http://tools.asix.net/img/sigma_sigmacab_pins_720.jpg
29 * (the cable has two additional GND pins, and a TI and TO pin)
31 static const char *channel_names[] = {
32 "1", "2", "3", "4", "5", "6", "7", "8",
33 "9", "10", "11", "12", "13", "14", "15", "16",
36 static const uint32_t scanopts[] = {
40 static const uint32_t drvopts[] = {
41 SR_CONF_LOGIC_ANALYZER,
44 static const uint32_t devopts[] = {
45 SR_CONF_LIMIT_MSEC | SR_CONF_GET | SR_CONF_SET,
46 SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
47 SR_CONF_CONN | SR_CONF_GET,
48 SR_CONF_SAMPLERATE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
49 #if ASIX_SIGMA_WITH_TRIGGER
50 SR_CONF_TRIGGER_MATCH | SR_CONF_LIST,
51 SR_CONF_CAPTURE_RATIO | SR_CONF_GET | SR_CONF_SET,
55 #if ASIX_SIGMA_WITH_TRIGGER
56 static const int32_t trigger_matches[] = {
64 static void clear_helper(struct dev_context *devc)
66 (void)sigma_force_close(devc);
69 static int dev_clear(const struct sr_dev_driver *di)
71 return std_dev_clear_with_callback(di,
72 (std_dev_clear_callback)clear_helper);
75 static gboolean bus_addr_in_devices(int bus, int addr, GSList *devs)
77 struct sr_usb_dev_inst *usb;
79 for (/* EMPTY */; devs; devs = devs->next) {
81 if (usb->bus == bus && usb->address == addr)
88 static gboolean known_vid_pid(const struct libusb_device_descriptor *des)
90 gboolean is_sigma, is_omega;
92 if (des->idVendor != USB_VENDOR_ASIX)
94 is_sigma = des->idProduct == USB_PRODUCT_SIGMA;
95 is_omega = des->idProduct == USB_PRODUCT_OMEGA;
96 if (!is_sigma && !is_omega)
101 static GSList *scan(struct sr_dev_driver *di, GSList *options)
103 struct drv_context *drvc;
104 libusb_context *usbctx;
106 GSList *l, *conn_devices;
107 struct sr_config *src;
109 libusb_device **devlist, *devitem;
111 struct libusb_device_descriptor des;
112 struct libusb_device_handle *hdl;
117 long serno_num, serno_pre;
118 enum asix_device_type dev_type;
119 const char *dev_text;
120 struct sr_dev_inst *sdi;
121 struct dev_context *devc;
122 size_t devidx, chidx;
125 usbctx = drvc->sr_ctx->libusb_ctx;
127 /* Find all devices which match an (optional) conn= spec. */
129 for (l = options; l; l = l->next) {
133 conn = g_variant_get_string(src->data, NULL);
139 conn_devices = sr_usb_find(usbctx, conn);
140 if (conn && !conn_devices)
143 /* Find all ASIX logic analyzers (which match the connection spec). */
145 libusb_get_device_list(usbctx, &devlist);
146 for (devidx = 0; devlist[devidx]; devidx++) {
147 devitem = devlist[devidx];
149 /* Check for connection match if a user spec was given. */
150 bus = libusb_get_bus_number(devitem);
151 addr = libusb_get_device_address(devitem);
152 if (conn && !bus_addr_in_devices(bus, addr, conn_devices))
154 snprintf(conn_id, sizeof(conn_id), "%d.%d", bus, addr);
157 * Check for known VID:PID pairs. Get the serial number,
158 * to then derive the device type from it.
160 libusb_get_device_descriptor(devitem, &des);
161 if (!known_vid_pid(&des))
163 if (!des.iSerialNumber) {
164 sr_warn("Cannot get serial number (index 0).");
167 ret = libusb_open(devitem, &hdl);
169 sr_warn("Cannot open USB device %04x.%04x: %s.",
170 des.idVendor, des.idProduct,
171 libusb_error_name(ret));
174 ret = libusb_get_string_descriptor_ascii(hdl,
176 (unsigned char *)serno_txt, sizeof(serno_txt));
178 sr_warn("Cannot get serial number (%s).",
179 libusb_error_name(ret));
186 * All ASIX logic analyzers have a serial number, which
187 * reads as a hex number, and tells the device type.
189 ret = sr_atol_base(serno_txt, &serno_num, &end, 16);
190 if (ret != SR_OK || !end || *end) {
191 sr_warn("Cannot interpret serial number %s.", serno_txt);
194 dev_type = ASIX_TYPE_NONE;
196 serno_pre = serno_num >> 16;
199 dev_type = ASIX_TYPE_SIGMA;
201 sr_info("Found SIGMA, serno %s.", serno_txt);
204 dev_type = ASIX_TYPE_SIGMA;
206 sr_info("Found SIGMA2, serno %s.", serno_txt);
209 dev_type = ASIX_TYPE_OMEGA;
211 sr_info("Found OMEGA, serno %s.", serno_txt);
212 if (!ASIX_WITH_OMEGA) {
213 sr_warn("OMEGA support is not implemented yet.");
218 sr_warn("Unknown serno %s, skipping.", serno_txt);
222 /* Create a device instance, add it to the result set. */
224 sdi = g_malloc0(sizeof(*sdi));
225 devices = g_slist_append(devices, sdi);
226 sdi->status = SR_ST_INITIALIZING;
227 sdi->vendor = g_strdup("ASIX");
228 sdi->model = g_strdup(dev_text);
229 sdi->serial_num = g_strdup(serno_txt);
230 sdi->connection_id = g_strdup(conn_id);
231 for (chidx = 0; chidx < ARRAY_SIZE(channel_names); chidx++)
232 sr_channel_new(sdi, chidx, SR_CHANNEL_LOGIC,
233 TRUE, channel_names[chidx]);
235 devc = g_malloc0(sizeof(*devc));
237 devc->id.vid = des.idVendor;
238 devc->id.pid = des.idProduct;
239 devc->id.serno = serno_num;
240 devc->id.prefix = serno_pre;
241 devc->id.type = dev_type;
242 sr_sw_limits_init(&devc->cfg_limits);
243 devc->capture_ratio = 50;
244 devc->use_triggers = 0;
246 /* TODO Retrieve some of this state from hardware? */
247 devc->firmware_idx = SIGMA_FW_NONE;
248 devc->samplerate = sigma_get_samplerate(sdi);
250 libusb_free_device_list(devlist, 1);
251 g_slist_free_full(conn_devices, (GDestroyNotify)sr_usb_dev_inst_free);
253 return std_scan_complete(di, devices);
256 static int dev_open(struct sr_dev_inst *sdi)
258 struct dev_context *devc;
262 if (devc->id.type == ASIX_TYPE_OMEGA && !ASIX_WITH_OMEGA) {
263 sr_err("OMEGA support is not implemented yet.");
267 return sigma_force_open(sdi);
270 static int dev_close(struct sr_dev_inst *sdi)
272 struct dev_context *devc;
276 return sigma_force_close(devc);
279 static int config_get(uint32_t key, GVariant **data,
280 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
282 struct dev_context *devc;
292 *data = g_variant_new_string(sdi->connection_id);
294 case SR_CONF_SAMPLERATE:
295 *data = g_variant_new_uint64(devc->samplerate);
297 case SR_CONF_LIMIT_MSEC:
298 case SR_CONF_LIMIT_SAMPLES:
299 return sr_sw_limits_config_get(&devc->cfg_limits, key, data);
300 #if ASIX_SIGMA_WITH_TRIGGER
301 case SR_CONF_CAPTURE_RATIO:
302 *data = g_variant_new_uint64(devc->capture_ratio);
312 static int config_set(uint32_t key, GVariant *data,
313 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
315 struct dev_context *devc;
317 uint64_t want_rate, have_rate;
324 case SR_CONF_SAMPLERATE:
325 want_rate = g_variant_get_uint64(data);
326 ret = sigma_normalize_samplerate(want_rate, &have_rate);
329 if (have_rate != want_rate) {
330 char *text_want, *text_have;
331 text_want = sr_samplerate_string(want_rate);
332 text_have = sr_samplerate_string(have_rate);
333 sr_info("Adjusted samplerate %s to %s.",
334 text_want, text_have);
338 devc->samplerate = have_rate;
340 case SR_CONF_LIMIT_MSEC:
341 case SR_CONF_LIMIT_SAMPLES:
342 return sr_sw_limits_config_set(&devc->cfg_limits, key, data);
343 #if ASIX_SIGMA_WITH_TRIGGER
344 case SR_CONF_CAPTURE_RATIO:
345 devc->capture_ratio = g_variant_get_uint64(data);
355 static int config_list(uint32_t key, GVariant **data,
356 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
359 case SR_CONF_SCAN_OPTIONS:
360 case SR_CONF_DEVICE_OPTIONS:
363 return STD_CONFIG_LIST(key, data, sdi, cg,
364 scanopts, drvopts, devopts);
365 case SR_CONF_SAMPLERATE:
366 *data = sigma_get_samplerates_list();
368 #if ASIX_SIGMA_WITH_TRIGGER
369 case SR_CONF_TRIGGER_MATCH:
370 *data = std_gvar_array_i32(ARRAY_AND_SIZE(trigger_matches));
380 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
382 struct dev_context *devc;
383 uint16_t pindis_mask;
387 struct triggerinout triggerinout_conf;
388 struct triggerlut lut;
389 uint8_t regval, trgconf_bytes[2], clock_bytes[4], *wrptr;
395 * Setup the device's samplerate from the value which up to now
396 * just got checked and stored. As a byproduct this can pick and
397 * send firmware to the device, reduce the number of available
398 * logic channels, etc.
400 * Determine an acquisition timeout from optionally configured
401 * sample count or time limits. Which depends on the samplerate.
403 ret = sigma_set_samplerate(sdi);
406 ret = sigma_set_acquire_timeout(devc);
410 ret = sigma_convert_trigger(sdi);
412 sr_err("Could not configure triggers.");
416 /* Enter trigger programming mode. */
417 trigsel2 = TRGSEL2_RESET;
418 ret = sigma_set_register(devc, WRITE_TRIGGER_SELECT2, trigsel2);
423 if (devc->samplerate >= SR_MHZ(100)) {
424 /* 100 and 200 MHz mode. */
425 /* TODO Decipher the 0x81 magic number's purpose. */
426 ret = sigma_set_register(devc, WRITE_TRIGGER_SELECT2, 0x81);
430 /* Find which pin to trigger on from mask. */
431 for (triggerpin = 0; triggerpin < 8; triggerpin++) {
432 if (devc->trigger.risingmask & (1 << triggerpin))
434 if (devc->trigger.fallingmask & (1 << triggerpin))
438 /* Set trigger pin and light LED on trigger. */
439 trigsel2 = triggerpin & TRGSEL2_PINS_MASK;
440 trigsel2 |= TRGSEL2_LEDSEL1;
442 /* Default rising edge. */
443 /* TODO Documentation disagrees, bit set means _rising_ edge. */
444 if (devc->trigger.fallingmask)
445 trigsel2 |= TRGSEL2_PINPOL_RISE;
447 } else if (devc->samplerate <= SR_MHZ(50)) {
448 /* 50MHz firmware modes. */
450 /* Translate application specs to hardware perspective. */
451 ret = sigma_build_basic_trigger(devc, &lut);
455 /* Communicate resulting register values to the device. */
456 ret = sigma_write_trigger_lut(devc, &lut);
460 trigsel2 = TRGSEL2_LEDSEL1 | TRGSEL2_LEDSEL0;
463 /* Setup trigger in and out pins to default values. */
464 memset(&triggerinout_conf, 0, sizeof(triggerinout_conf));
465 triggerinout_conf.trgout_bytrigger = 1;
466 triggerinout_conf.trgout_enable = 1;
468 * Verify the correctness of this implementation. The previous
469 * version used to assign to a C language struct with bit fields
470 * which is highly non-portable and hard to guess the resulting
471 * raw memory layout or wire transfer content. The C struct's
472 * field names did not match the vendor documentation's names.
473 * Which means that I could not verify "on paper" either. Let's
474 * re-visit this code later during research for trigger support.
476 wrptr = trgconf_bytes;
478 if (triggerinout_conf.trgout_bytrigger)
479 regval |= TRGOPT_TRGOOUTEN;
480 write_u8_inc(&wrptr, regval);
481 regval &= ~TRGOPT_CLEAR_MASK;
482 if (triggerinout_conf.trgout_enable)
483 regval |= TRGOPT_TRGOEN;
484 write_u8_inc(&wrptr, regval);
485 count = wrptr - trgconf_bytes;
486 ret = sigma_write_register(devc, WRITE_TRIGGER_OPTION,
487 trgconf_bytes, count);
491 /* Leave trigger programming mode. */
492 ret = sigma_set_register(devc, WRITE_TRIGGER_SELECT2, trigsel2);
497 * Samplerate dependent clock and channels configuration. Some
498 * channels by design are not available at higher clock rates.
499 * Register layout differs between firmware variants (depth 1
500 * with LSB channel mask above 50MHz, depth 4 with more details
503 * Derive a mask where bits are set for unavailable channels.
504 * Either send the single byte, or the full byte sequence.
506 pindis_mask = ~((1UL << devc->num_channels) - 1);
507 if (devc->samplerate > SR_MHZ(50)) {
508 ret = sigma_set_register(devc, WRITE_CLOCK_SELECT,
512 /* Select 50MHz base clock, and divider. */
514 div = SR_MHZ(50) / devc->samplerate - 1;
516 * TODO Optionally use external clock.
517 * async[0] = 1 to enable external clock
518 * div[5] = 1 to select falling edge
519 * div[4] = 1 to select rising edge
520 * div[3:0] = 1..16 to select clock pin
522 write_u8_inc(&wrptr, async);
523 write_u8_inc(&wrptr, div);
524 write_u16be_inc(&wrptr, pindis_mask);
525 ret = sigma_write_register(devc, WRITE_CLOCK_SELECT,
526 clock_bytes, wrptr - clock_bytes);
531 /* Setup maximum post trigger time. */
532 ret = sigma_set_register(devc, WRITE_POST_TRIGGER,
533 (devc->capture_ratio * 255) / 100);
537 /* Start acqusition. */
538 regval = WMR_TRGRES | WMR_SDRAMWRITEEN;
539 #if ASIX_SIGMA_WITH_TRIGGER
542 ret = sigma_set_register(devc, WRITE_MODE, regval);
546 ret = std_session_send_df_header(sdi);
550 /* Add capture source. */
551 ret = sr_session_source_add(sdi->session, -1, 0, 10,
552 sigma_receive_data, (void *)sdi);
556 devc->state.state = SIGMA_CAPTURE;
561 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
563 struct dev_context *devc;
568 * When acquisition is currently running, keep the receive
569 * routine registered and have it stop the acquisition upon the
570 * next invocation. Else unregister the receive routine here
571 * already. The detour is required to have sample data retrieved
572 * for forced acquisition stops.
574 if (devc->state.state == SIGMA_CAPTURE) {
575 devc->state.state = SIGMA_STOPPING;
577 devc->state.state = SIGMA_IDLE;
578 (void)sr_session_source_remove(sdi->session, -1);
584 static struct sr_dev_driver asix_sigma_driver_info = {
585 .name = "asix-sigma",
586 .longname = "ASIX SIGMA/SIGMA2",
589 .cleanup = std_cleanup,
591 .dev_list = std_dev_list,
592 .dev_clear = dev_clear,
593 .config_get = config_get,
594 .config_set = config_set,
595 .config_list = config_list,
596 .dev_open = dev_open,
597 .dev_close = dev_close,
598 .dev_acquisition_start = dev_acquisition_start,
599 .dev_acquisition_stop = dev_acquisition_stop,
602 SR_REGISTER_DEV_DRIVER(asix_sigma_driver_info);