2 * This file is part of the sigrok project.
4 * Copyright (C) 2011 Daniel Ribeiro <drwyrm@gmail.com>
6 * This program is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
22 #include <arpa/inet.h>
24 #include "link-mso19.h"
26 #define USB_VENDOR "3195"
27 #define USB_PRODUCT "f190"
29 static int capabilities[] = {
31 // HWCAP_OSCILLOSCOPE,
32 // HWCAP_PAT_GENERATOR,
35 // HWCAP_CAPTURE_RATIO,
40 static uint64_t supported_samplerates[] = {
41 100, 200, 500, KHZ(1), KHZ(2), KHZ(5), KHZ(10), KHZ(20),
42 KHZ(50), KHZ(100), KHZ(200), KHZ(500), MHZ(1), MHZ(2), MHZ(5),
43 MHZ(10), MHZ(20), MHZ(50), MHZ(100), MHZ(200), 0
46 static struct samplerates samplerates = {
47 100, MHZ(200), 0, supported_samplerates,
50 static GSList *device_instances = NULL;
52 static int mso_send_control_message(struct sigrok_device_instance *sdi,
53 uint16_t payload[], int n)
55 int fd = sdi->serial->fd;
56 int i, w, ret, s = n * 2 + sizeof(mso_head) + sizeof(mso_foot);
67 memcpy(p, mso_head, sizeof(mso_head));
68 p += sizeof(mso_head);
70 for (i = 0; i < n; i++) {
71 *(uint16_t *) p = htons(payload[i]);
74 memcpy(p, mso_foot, sizeof(mso_foot));
78 ret = write(fd, buf + w, s - w);
92 static int mso_reset_adc(struct sigrok_device_instance *sdi)
94 struct mso *mso = sdi->priv;
97 ops[0] = mso_trans(REG_CTL, (mso->ctlbase | BIT_CTL_RESETADC));
98 ops[1] = mso_trans(REG_CTL, mso->ctlbase);
99 mso->ctlbase |= BIT_CTL_ADC_UNKNOWN4;
101 return mso_send_control_message(sdi, ARRAY_AND_SIZE(ops));
104 static int mso_reset_fsm(struct sigrok_device_instance *sdi)
106 struct mso *mso = sdi->priv;
109 mso->ctlbase |= BIT_CTL_RESETFSM;
110 ops[0] = mso_trans(REG_CTL, mso->ctlbase);
112 return mso_send_control_message(sdi, ARRAY_AND_SIZE(ops));
115 static int mso_toggle_led(struct sigrok_device_instance *sdi, int state)
117 struct mso *mso = sdi->priv;
120 mso->ctlbase &= BIT_CTL_LED;
122 mso->ctlbase |= BIT_CTL_LED;
123 ops[0] = mso_trans(REG_CTL, mso->ctlbase);
125 return mso_send_control_message(sdi, ARRAY_AND_SIZE(ops));
128 static int mso_check_trigger(struct sigrok_device_instance *sdi,
131 uint16_t ops[] = { mso_trans(REG_TRIGGER, 0) };
135 ret = mso_send_control_message(sdi, ARRAY_AND_SIZE(ops));
136 if (info == NULL || ret != SIGROK_OK)
140 if (read(sdi->serial->fd, buf, 1) != 1) /* FIXME: Need timeout */
147 static int mso_read_buffer(struct sigrok_device_instance *sdi)
149 uint16_t ops[] = { mso_trans(REG_BUFFER, 0) };
151 return mso_send_control_message(sdi, ARRAY_AND_SIZE(ops));
154 static int mso_arm(struct sigrok_device_instance *sdi)
156 struct mso *mso = sdi->priv;
158 mso_trans(REG_CTL, mso->ctlbase | BIT_CTL_RESETFSM),
159 mso_trans(REG_CTL, mso->ctlbase | BIT_CTL_ARM),
160 mso_trans(REG_CTL, mso->ctlbase),
163 return mso_send_control_message(sdi, ARRAY_AND_SIZE(ops));
166 static int mso_force_capture(struct sigrok_device_instance *sdi)
168 struct mso *mso = sdi->priv;
170 mso_trans(REG_CTL, mso->ctlbase | 8),
171 mso_trans(REG_CTL, mso->ctlbase),
174 return mso_send_control_message(sdi, ARRAY_AND_SIZE(ops));
177 static int mso_dac_out(struct sigrok_device_instance *sdi, uint16_t val)
179 struct mso *mso = sdi->priv;
181 mso_trans(REG_DAC1, (val >> 8) & 0xff),
182 mso_trans(REG_DAC2, val & 0xff),
183 mso_trans(REG_CTL, mso->ctlbase | BIT_CTL_RESETADC),
186 return mso_send_control_message(sdi, ARRAY_AND_SIZE(ops));
189 static int mso_clkrate_out(struct sigrok_device_instance *sdi, uint16_t val)
192 mso_trans(REG_CLKRATE1, (val >> 8) & 0xff),
193 mso_trans(REG_CLKRATE2, val & 0xff),
196 return mso_send_control_message(sdi, ARRAY_AND_SIZE(ops));
199 static int mso_configure_rate(struct sigrok_device_instance *sdi,
202 struct mso *mso = sdi->priv;
204 int ret = SIGROK_ERR;
206 for (i = 0; i < ARRAY_SIZE(rate_map); i++) {
207 if (rate_map[i].rate == rate) {
208 mso->slowmode = rate_map[i].slowmode;
209 ret = mso_clkrate_out(sdi, rate_map[i].val);
210 if (ret == SIGROK_OK)
211 mso->cur_rate = rate;
219 static inline uint16_t mso_calc_raw_from_mv(struct mso *mso)
221 return (uint16_t) (0x200 -
222 ((mso->dso_trigger_voltage / mso->dso_probe_attn) /
226 static int mso_configure_trigger(struct sigrok_device_instance *sdi)
228 struct mso *mso = sdi->priv;
230 uint16_t dso_trigger = mso_calc_raw_from_mv(mso);
232 dso_trigger &= 0x3ff;
233 if ((!mso->trigger_slope && mso->trigger_chan == 1) ||
234 (mso->trigger_slope &&
235 (mso->trigger_chan == 0 ||
236 mso->trigger_chan == 2 ||
237 mso->trigger_chan == 3)))
238 dso_trigger |= 0x400;
240 switch (mso->trigger_chan) {
242 dso_trigger |= 0xe000;
244 dso_trigger |= 0x4000;
247 dso_trigger |= 0x2000;
250 dso_trigger |= 0xa000;
253 dso_trigger |= 0x8000;
260 switch (mso->trigger_outsrc) {
262 dso_trigger |= 0x800;
265 dso_trigger |= 0x1000;
268 dso_trigger |= 0x1800;
273 ops[0] = mso_trans(5, mso->la_trigger);
274 ops[1] = mso_trans(6, mso->la_trigger_mask);
275 ops[2] = mso_trans(3, dso_trigger & 0xff);
276 ops[3] = mso_trans(4, (dso_trigger >> 8) & 0xff);
277 ops[4] = mso_trans(11,
278 mso->dso_trigger_width / HZ_TO_NS(mso->cur_rate));
279 ops[5] = mso_trans(15, (2 | mso->slowmode));
281 /* FIXME SPI/I2C Triggers */
282 ops[6] = mso_trans(0, 0);
283 ops[7] = mso_trans(1, 0);
284 ops[8] = mso_trans(2, 0);
285 ops[9] = mso_trans(3, 0);
286 ops[10] = mso_trans(4, 0xff);
287 ops[11] = mso_trans(5, 0xff);
288 ops[12] = mso_trans(6, 0xff);
289 ops[13] = mso_trans(7, 0xff);
290 ops[14] = mso_trans(8, mso->trigger_spimode);
291 ops[15] = mso_trans(15, mso->slowmode);
293 return mso_send_control_message(sdi, ARRAY_AND_SIZE(ops));
296 static int mso_configure_threshold_level(struct sigrok_device_instance *sdi)
298 struct mso *mso = sdi->priv;
300 return mso_dac_out(sdi, la_threshold_map[mso->la_threshold]);
303 static int mso_parse_serial(const char *iSerial, const char *iProduct,
306 unsigned int u1, u2, u3, u4, u5, u6;
309 /* FIXME: This code is in the original app, but I think its
310 * used only for the GUI */
311 /* if (strstr(iProduct, "REV_02") || strstr(iProduct, "REV_03"))
312 mso->num_sample_rates = 0x16;
314 mso->num_sample_rates = 0x10; */
317 if (iSerial[0] != '4' || sscanf(iSerial, "%5u%3u%3u%1u%1u%6u",
318 &u1, &u2, &u3, &u4, &u5, &u6) != 6)
323 mso->vbit = u1 / 10000;
326 mso->dac_offset = u2;
327 if (mso->dac_offset == 0)
328 mso->dac_offset = 0x1ff;
329 mso->offset_range = u3;
330 if (mso->offset_range == 0)
331 mso->offset_range = 0x17d;
334 * FIXME: There is more code on the original software to handle
335 * bigger iSerial strings, but as I can't test on my device
336 * I will not implement it yet
342 static int hw_init(char *deviceinfo)
344 struct sigrok_device_instance *sdi;
347 struct udev_enumerate *enumerate;
348 struct udev_list_entry *devices, *dev_list_entry;
351 deviceinfo = deviceinfo;
353 /* It's easier to map usb<->serial using udev */
355 * FIXME: On windows we can get the same information from the
356 * registry, add an #ifdef here later
360 g_warning("Failed to initialize udev.");
363 enumerate = udev_enumerate_new(udev);
364 udev_enumerate_add_match_subsystem(enumerate, "usb-serial");
365 udev_enumerate_scan_devices(enumerate);
366 devices = udev_enumerate_get_list_entry(enumerate);
367 udev_list_entry_foreach(dev_list_entry, devices) {
368 const char *syspath, *sysname, *idVendor, *idProduct,
370 char path[32], manufacturer[32], product[32], hwrev[32];
371 struct udev_device *dev, *parent;
374 syspath = udev_list_entry_get_name(dev_list_entry);
375 dev = udev_device_new_from_syspath(udev, syspath);
376 sysname = udev_device_get_sysname(dev);
377 parent = udev_device_get_parent_with_subsystem_devtype(
378 dev, "usb", "usb_device");
380 g_warning("Unable to find parent usb device for %s",
385 idVendor = udev_device_get_sysattr_value(parent, "idVendor");
386 idProduct = udev_device_get_sysattr_value(parent, "idProduct");
387 if (strcmp(USB_VENDOR, idVendor)
388 || strcmp(USB_PRODUCT, idProduct))
391 iSerial = udev_device_get_sysattr_value(parent, "serial");
392 iProduct = udev_device_get_sysattr_value(parent, "product");
394 snprintf(path, sizeof(path), "/dev/%s", sysname);
396 s = strcspn(iProduct, " ");
397 if (s > sizeof(product) ||
398 strlen(iProduct) - s > sizeof(manufacturer)) {
399 g_warning("Could not parse iProduct: %s", iProduct);
402 strncpy(product, iProduct, s);
404 strcpy(manufacturer, iProduct + s);
405 sprintf(hwrev, "r%d", mso->hwrev);
407 mso = malloc(sizeof(struct mso));
410 memset(mso, 0, sizeof(struct mso));
412 if (mso_parse_serial(iSerial, iProduct, mso) != SIGROK_OK) {
413 g_warning("Invalid iSerial: %s", iSerial);
416 /* hardware initial state */
419 sdi = sigrok_device_instance_new(devcnt, ST_INITIALIZING,
420 manufacturer, product, hwrev);
422 g_warning("Unable to create device instance for %s",
427 /* save a pointer to our private instance data */
430 sdi->serial = serial_device_instance_new(path, -1);
432 goto err_device_instance_free;
434 device_instances = g_slist_append(device_instances, sdi);
438 err_device_instance_free:
439 sigrok_device_instance_free(sdi);
444 udev_enumerate_unref(enumerate);
451 static void hw_cleanup(void)
454 struct sigrok_device_instance *sdi;
456 /* Properly close all devices. */
457 for (l = device_instances; l; l = l->next) {
459 if (sdi->serial->fd != -1)
460 serial_close(sdi->serial->fd);
461 if (sdi->priv != NULL)
463 sigrok_device_instance_free(sdi);
465 g_slist_free(device_instances);
466 device_instances = NULL;
469 static int hw_opendev(int device_index)
471 struct sigrok_device_instance *sdi;
473 int ret = SIGROK_ERR;
475 if (!(sdi = get_sigrok_device_instance(device_instances, device_index)))
479 sdi->serial->fd = serial_open(sdi->serial->port, O_RDWR);
480 if (sdi->serial->fd == -1)
483 ret = serial_set_params(sdi->serial->fd, 460800, 8, 0, 1, 2);
484 if (ret != SIGROK_OK)
487 sdi->status = ST_ACTIVE;
489 /* FIXME: discard serial buffer */
491 mso_check_trigger(sdi, &mso->trigger_state);
492 // g_warning("trigger state: %c", mso->trigger_state);
494 ret = mso_reset_adc(sdi);
495 if (ret != SIGROK_OK)
498 mso_check_trigger(sdi, &mso->trigger_state);
499 // g_warning("trigger state: %c", mso->trigger_state);
501 // ret = mso_reset_fsm(sdi);
502 // if (ret != SIGROK_OK)
505 // return SIGROK_ERR;
509 static void hw_closedev(int device_index)
511 struct sigrok_device_instance *sdi;
513 if (!(sdi = get_sigrok_device_instance(device_instances, device_index)))
516 if (sdi->serial->fd != -1) {
517 serial_close(sdi->serial->fd);
518 sdi->serial->fd = -1;
519 sdi->status = ST_INACTIVE;
523 static void *hw_get_device_info(int device_index, int device_info_id)
525 struct sigrok_device_instance *sdi;
529 if (!(sdi = get_sigrok_device_instance(device_instances, device_index)))
533 switch (device_info_id) {
537 case DI_NUM_PROBES: /* FIXME: How to report analog probe? */
538 info = GINT_TO_POINTER(8);
543 case DI_TRIGGER_TYPES:
544 info = "01"; /* FIXME */
546 case DI_CUR_SAMPLERATE:
547 info = &mso->cur_rate;
553 static int hw_get_status(int device_index)
555 struct sigrok_device_instance *sdi;
557 if (!(sdi = get_sigrok_device_instance(device_instances, device_index)))
563 static int *hw_get_capabilities(void)
568 static int hw_set_configuration(int device_index, int capability, void *value)
570 struct sigrok_device_instance *sdi;
572 if (!(sdi = get_sigrok_device_instance(device_instances, device_index)))
575 switch (capability) {
576 case HWCAP_SAMPLERATE:
577 return mso_configure_rate(sdi, *(uint64_t *) value);
578 case HWCAP_PROBECONFIG:
579 case HWCAP_LIMIT_SAMPLES:
581 return SIGROK_OK; /* FIXME */
586 #define MSO_TRIGGER_UNKNOWN '!'
587 #define MSO_TRIGGER_UNKNOWN1 '1'
588 #define MSO_TRIGGER_UNKNOWN2 '2'
589 #define MSO_TRIGGER_UNKNOWN3 '3'
590 #define MSO_TRIGGER_WAIT '4'
591 #define MSO_TRIGGER_FIRED '5'
592 #define MSO_TRIGGER_DATAREADY '6'
594 /* FIXME: Pass errors? */
595 static int receive_data(int fd, int revents, void *user_data)
597 struct sigrok_device_instance *sdi = user_data;
598 struct mso *mso = sdi->priv;
599 struct datafeed_packet packet;
600 uint8_t in[1024], logic_out[1024];
601 double analog_out[1024];
606 s = read(fd, in, sizeof(in));
611 if (mso->trigger_state != MSO_TRIGGER_DATAREADY) {
612 mso->trigger_state = in[0];
613 if (mso->trigger_state == MSO_TRIGGER_DATAREADY) {
614 mso_read_buffer(sdi);
617 mso_check_trigger(sdi, NULL);
622 /* the hardware always dumps 1024 samples, 24bits each */
623 if (mso->buffer_n < 3072) {
624 memcpy(mso->buffer + mso->buffer_n, in, s);
627 if (mso->buffer_n < 3072)
630 /* do the conversion */
631 for (i = 0; i < 1024; i++) {
632 /* FIXME: Need to do conversion to mV */
633 analog_out[i] = (mso->buffer[i * 3] & 0x3f) |
634 ((mso->buffer[i * 3 + 1] & 0xf) << 6);
635 logic_out[i] = ((mso->buffer[i * 3 + 1] & 0x30) >> 4) |
636 ((mso->buffer[i * 3 + 2] & 0x3f) << 2);
639 packet.type = DF_LOGIC;
640 packet.length = 1024;
642 packet.payload = logic_out;
643 session_bus(mso->session_id, &packet);
646 packet.type = DF_ANALOG;
647 packet.length = 1024;
648 packet.unitsize = sizeof(double);
649 packet.payload = analog_out;
650 session_bus(mso->session_id, &packet);
652 packet.type = DF_END;
653 session_bus(mso->session_id, &packet);
658 static int hw_start_acquisition(int device_index, gpointer session_device_id)
660 struct sigrok_device_instance *sdi;
662 struct datafeed_packet packet;
663 struct datafeed_header header;
664 int ret = SIGROK_ERR;
666 if (!(sdi = get_sigrok_device_instance(device_instances, device_index)))
670 /* FIXME: No need to do full reconfigure every time */
671 // ret = mso_reset_fsm(sdi);
672 // if (ret != SIGROK_OK)
675 /* FIXME: ACDC Mode */
676 mso->ctlbase &= 0x7f;
677 // mso->ctlbase |= mso->acdcmode;
679 ret = mso_configure_rate(sdi, mso->cur_rate);
680 if (ret != SIGROK_OK)
684 ret = mso_dac_out(sdi, mso->dac_offset);
685 if (ret != SIGROK_OK)
688 ret = mso_configure_threshold_level(sdi);
689 if (ret != SIGROK_OK)
692 ret = mso_configure_trigger(sdi);
693 if (ret != SIGROK_OK)
696 /* FIXME: trigger_position */
699 /* END of config hardware part */
703 if (ret != SIGROK_OK)
706 /* without trigger */
707 // ret = mso_force_capture(sdi);
708 // if (ret != SIGROK_OK)
711 mso_check_trigger(sdi, &mso->trigger_state);
712 ret = mso_check_trigger(sdi, NULL);
713 if (ret != SIGROK_OK)
716 mso->session_id = session_device_id;
717 source_add(sdi->serial->fd, G_IO_IN, -1, receive_data, sdi);
719 packet.type = DF_HEADER;
720 packet.length = sizeof(struct datafeed_header);
721 packet.payload = (unsigned char *) &header;
722 header.feed_version = 1;
723 gettimeofday(&header.starttime, NULL);
724 header.samplerate = mso->cur_rate;
725 header.num_analog_probes = 1;
726 header.num_logic_probes = 8;
727 header.protocol_id = PROTO_RAW;
728 session_bus(session_device_id, &packet);
734 static void hw_stop_acquisition(int device_index, gpointer session_device_id)
736 struct datafeed_packet packet;
738 device_index = device_index;
740 packet.type = DF_END;
741 session_bus(session_device_id, &packet);
744 struct device_plugin link_mso19_plugin_info = {
745 .name = "link-mso19",
748 .cleanup = hw_cleanup,
751 .close = hw_closedev,
752 .get_device_info = hw_get_device_info,
753 .get_status = hw_get_status,
754 .get_capabilities = hw_get_capabilities,
755 .set_configuration = hw_set_configuration,
756 .start_acquisition = hw_start_acquisition,
757 .stop_acquisition = hw_stop_acquisition,