2 * This file is part of the sigrok project.
4 * Copyright (C) 2011 Daniel Ribeiro <drwyrm@gmail.com>
5 * Copyright (C) 2012 Renato Caldas <rmsc@fe.up.pt>
7 * This program is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation, either version 3 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program. If not, see <http://www.gnu.org/licenses/>.
30 #include <arpa/inet.h>
32 #include "sigrok-internal.h"
34 #include "link-mso19.h"
36 #define USB_VENDOR "3195"
37 #define USB_PRODUCT "f190"
41 static int capabilities[] = {
42 SR_HWCAP_LOGIC_ANALYZER,
43 // SR_HWCAP_OSCILLOSCOPE,
44 // SR_HWCAP_PAT_GENERATOR,
47 // SR_HWCAP_CAPTURE_RATIO,
48 SR_HWCAP_LIMIT_SAMPLES,
52 static const char *probe_names[NUM_PROBES + 1] = {
64 static uint64_t supported_samplerates[] = {
88 static struct sr_samplerates samplerates = {
92 supported_samplerates,
95 static GSList *device_instances = NULL;
97 static int mso_send_control_message(struct sr_device_instance *sdi,
98 uint16_t payload[], int n)
100 int fd = sdi->serial->fd;
101 int i, w, ret, s = n * 2 + sizeof(mso_head) + sizeof(mso_foot);
109 if (!(buf = g_try_malloc(s))) {
110 sr_err("mso19: %s: buf malloc failed", __func__);
116 memcpy(p, mso_head, sizeof(mso_head));
117 p += sizeof(mso_head);
119 for (i = 0; i < n; i++) {
120 *(uint16_t *) p = htons(payload[i]);
123 memcpy(p, mso_foot, sizeof(mso_foot));
127 ret = serial_write(fd, buf + w, s - w);
141 static int mso_reset_adc(struct sr_device_instance *sdi)
143 struct mso *mso = sdi->priv;
146 ops[0] = mso_trans(REG_CTL1, (mso->ctlbase1 | BIT_CTL1_RESETADC));
147 ops[1] = mso_trans(REG_CTL1, mso->ctlbase1);
148 mso->ctlbase1 |= BIT_CTL1_ADC_UNKNOWN4;
150 sr_dbg("Requesting ADC reset");
151 return mso_send_control_message(sdi, ARRAY_AND_SIZE(ops));
154 static int mso_reset_fsm(struct sr_device_instance *sdi)
156 struct mso *mso = sdi->priv;
159 mso->ctlbase1 |= BIT_CTL1_RESETFSM;
160 ops[0] = mso_trans(REG_CTL1, mso->ctlbase1);
162 sr_dbg("Requesting ADC reset");
163 return mso_send_control_message(sdi, ARRAY_AND_SIZE(ops));
166 static int mso_toggle_led(struct sr_device_instance *sdi, int state)
168 struct mso *mso = sdi->priv;
171 mso->ctlbase1 &= ~BIT_CTL1_LED;
173 mso->ctlbase1 |= BIT_CTL1_LED;
174 ops[0] = mso_trans(REG_CTL1, mso->ctlbase1);
176 sr_dbg("Requesting LED toggle");
177 return mso_send_control_message(sdi, ARRAY_AND_SIZE(ops));
180 static int mso_check_trigger(struct sr_device_instance *sdi,
183 uint16_t ops[] = { mso_trans(REG_TRIGGER, 0) };
187 sr_dbg("Requesting trigger state");
188 ret = mso_send_control_message(sdi, ARRAY_AND_SIZE(ops));
189 if (info == NULL || ret != SR_OK)
193 if (serial_read(sdi->serial->fd, buf, 1) != 1) /* FIXME: Need timeout */
197 sr_dbg("Trigger state is: 0x%x", *info);
201 static int mso_read_buffer(struct sr_device_instance *sdi)
203 uint16_t ops[] = { mso_trans(REG_BUFFER, 0) };
205 sr_dbg("Requesting buffer dump");
206 return mso_send_control_message(sdi, ARRAY_AND_SIZE(ops));
209 static int mso_arm(struct sr_device_instance *sdi)
211 struct mso *mso = sdi->priv;
213 mso_trans(REG_CTL1, mso->ctlbase1 | BIT_CTL1_RESETFSM),
214 mso_trans(REG_CTL1, mso->ctlbase1 | BIT_CTL1_ARM),
215 mso_trans(REG_CTL1, mso->ctlbase1),
218 sr_dbg("Requesting trigger arm");
219 return mso_send_control_message(sdi, ARRAY_AND_SIZE(ops));
222 static int mso_force_capture(struct sr_device_instance *sdi)
224 struct mso *mso = sdi->priv;
226 mso_trans(REG_CTL1, mso->ctlbase1 | 8),
227 mso_trans(REG_CTL1, mso->ctlbase1),
230 sr_dbg("Requesting forced capture");
231 return mso_send_control_message(sdi, ARRAY_AND_SIZE(ops));
234 static int mso_dac_out(struct sr_device_instance *sdi, uint16_t val)
236 struct mso *mso = sdi->priv;
238 mso_trans(REG_DAC1, (val >> 8) & 0xff),
239 mso_trans(REG_DAC2, val & 0xff),
240 mso_trans(REG_CTL1, mso->ctlbase1 | BIT_CTL1_RESETADC),
243 sr_dbg("Setting dac word to 0x%x", val);
244 return mso_send_control_message(sdi, ARRAY_AND_SIZE(ops));
247 static int mso_clkrate_out(struct sr_device_instance *sdi, uint16_t val)
250 mso_trans(REG_CLKRATE1, (val >> 8) & 0xff),
251 mso_trans(REG_CLKRATE2, val & 0xff),
254 sr_dbg("Setting clkrate word to 0x%x", val);
255 return mso_send_control_message(sdi, ARRAY_AND_SIZE(ops));
258 static int mso_configure_rate(struct sr_device_instance *sdi,
261 struct mso *mso = sdi->priv;
265 for (i = 0; i < ARRAY_SIZE(rate_map); i++) {
266 if (rate_map[i].rate == rate) {
267 mso->ctlbase2 = rate_map[i].slowmode;
268 ret = mso_clkrate_out(sdi, rate_map[i].val);
270 mso->cur_rate = rate;
277 static inline uint16_t mso_calc_raw_from_mv(struct mso *mso)
279 return (uint16_t) (0x200 -
280 ((mso->dso_trigger_voltage / mso->dso_probe_attn) /
284 static int mso_configure_trigger(struct sr_device_instance *sdi)
286 struct mso *mso = sdi->priv;
288 uint16_t dso_trigger = mso_calc_raw_from_mv(mso);
290 dso_trigger &= 0x3ff;
291 if ((!mso->trigger_slope && mso->trigger_chan == 1) ||
292 (mso->trigger_slope &&
293 (mso->trigger_chan == 0 ||
294 mso->trigger_chan == 2 ||
295 mso->trigger_chan == 3)))
296 dso_trigger |= 0x400;
298 switch (mso->trigger_chan) {
300 dso_trigger |= 0xe000;
302 dso_trigger |= 0x4000;
305 dso_trigger |= 0x2000;
308 dso_trigger |= 0xa000;
311 dso_trigger |= 0x8000;
318 switch (mso->trigger_outsrc) {
320 dso_trigger |= 0x800;
323 dso_trigger |= 0x1000;
326 dso_trigger |= 0x1800;
331 ops[0] = mso_trans(5, mso->la_trigger);
332 ops[1] = mso_trans(6, mso->la_trigger_mask);
333 ops[2] = mso_trans(3, dso_trigger & 0xff);
334 ops[3] = mso_trans(4, (dso_trigger >> 8) & 0xff);
335 ops[4] = mso_trans(11,
336 mso->dso_trigger_width / SR_HZ_TO_NS(mso->cur_rate));
338 /* Select the SPI/I2C trigger config bank */
339 ops[5] = mso_trans(REG_CTL2, (mso->ctlbase2 | BITS_CTL2_BANK(2)));
340 /* Configure the SPI/I2C protocol trigger */
341 ops[6] = mso_trans(REG_PT_WORD(0), mso->protocol_trigger.word[0]);
342 ops[7] = mso_trans(REG_PT_WORD(1), mso->protocol_trigger.word[1]);
343 ops[8] = mso_trans(REG_PT_WORD(2), mso->protocol_trigger.word[2]);
344 ops[9] = mso_trans(REG_PT_WORD(3), mso->protocol_trigger.word[3]);
345 ops[10] = mso_trans(REG_PT_MASK(0), mso->protocol_trigger.mask[0]);
346 ops[11] = mso_trans(REG_PT_MASK(1), mso->protocol_trigger.mask[1]);
347 ops[12] = mso_trans(REG_PT_MASK(2), mso->protocol_trigger.mask[2]);
348 ops[13] = mso_trans(REG_PT_MASK(3), mso->protocol_trigger.mask[3]);
349 ops[14] = mso_trans(REG_PT_SPIMODE, mso->protocol_trigger.spimode);
350 /* Select the default config bank */
351 ops[15] = mso_trans(REG_CTL2, mso->ctlbase2);
353 return mso_send_control_message(sdi, ARRAY_AND_SIZE(ops));
356 static int mso_configure_threshold_level(struct sr_device_instance *sdi)
358 struct mso *mso = sdi->priv;
360 return mso_dac_out(sdi, la_threshold_map[mso->la_threshold]);
363 static int mso_parse_serial(const char *iSerial, const char *iProduct,
366 unsigned int u1, u2, u3, u4, u5, u6;
369 /* FIXME: This code is in the original app, but I think its
370 * used only for the GUI */
371 /* if (strstr(iProduct, "REV_02") || strstr(iProduct, "REV_03"))
372 mso->num_sample_rates = 0x16;
374 mso->num_sample_rates = 0x10; */
377 if (iSerial[0] != '4' || sscanf(iSerial, "%5u%3u%3u%1u%1u%6u",
378 &u1, &u2, &u3, &u4, &u5, &u6) != 6)
383 mso->vbit = u1 / 10000;
386 mso->dac_offset = u2;
387 if (mso->dac_offset == 0)
388 mso->dac_offset = 0x1ff;
389 mso->offset_range = u3;
390 if (mso->offset_range == 0)
391 mso->offset_range = 0x17d;
394 * FIXME: There is more code on the original software to handle
395 * bigger iSerial strings, but as I can't test on my device
396 * I will not implement it yet
402 static int hw_init(const char *deviceinfo)
404 struct sr_device_instance *sdi;
407 struct udev_enumerate *enumerate;
408 struct udev_list_entry *devices, *dev_list_entry;
411 deviceinfo = deviceinfo;
413 /* It's easier to map usb<->serial using udev */
415 * FIXME: On windows we can get the same information from the
416 * registry, add an #ifdef here later
420 sr_warn("Failed to initialize udev.");
423 enumerate = udev_enumerate_new(udev);
424 udev_enumerate_add_match_subsystem(enumerate, "usb-serial");
425 udev_enumerate_scan_devices(enumerate);
426 devices = udev_enumerate_get_list_entry(enumerate);
427 udev_list_entry_foreach(dev_list_entry, devices) {
428 const char *syspath, *sysname, *idVendor, *idProduct,
430 char path[32], manufacturer[32], product[32], hwrev[32];
431 struct udev_device *dev, *parent;
434 syspath = udev_list_entry_get_name(dev_list_entry);
435 dev = udev_device_new_from_syspath(udev, syspath);
436 sysname = udev_device_get_sysname(dev);
437 parent = udev_device_get_parent_with_subsystem_devtype(
438 dev, "usb", "usb_device");
440 sr_warn("Unable to find parent usb device for %s",
445 idVendor = udev_device_get_sysattr_value(parent, "idVendor");
446 idProduct = udev_device_get_sysattr_value(parent, "idProduct");
447 if (strcmp(USB_VENDOR, idVendor)
448 || strcmp(USB_PRODUCT, idProduct))
451 iSerial = udev_device_get_sysattr_value(parent, "serial");
452 iProduct = udev_device_get_sysattr_value(parent, "product");
454 snprintf(path, sizeof(path), "/dev/%s", sysname);
456 s = strcspn(iProduct, " ");
457 if (s > sizeof(product) ||
458 strlen(iProduct) - s > sizeof(manufacturer)) {
459 sr_warn("Could not parse iProduct: %s", iProduct);
462 strncpy(product, iProduct, s);
464 strcpy(manufacturer, iProduct + s);
466 if (!(mso = g_try_malloc0(sizeof(struct mso)))) {
467 sr_err("mso19: %s: mso malloc failed", __func__);
468 continue; /* TODO: Errors handled correctly? */
471 if (mso_parse_serial(iSerial, iProduct, mso) != SR_OK) {
472 sr_warn("Invalid iSerial: %s", iSerial);
475 sprintf(hwrev, "r%d", mso->hwrev);
477 /* hardware initial state */
480 /* Initialize the protocol trigger configuration */
482 for (i = 0; i < 4; i++)
484 mso->protocol_trigger.word[i] = 0;
485 mso->protocol_trigger.mask[i] = 0xff;
487 mso->protocol_trigger.spimode = 0;
490 sdi = sr_device_instance_new(devcnt, SR_ST_INITIALIZING,
491 manufacturer, product, hwrev);
493 sr_warn("Unable to create device instance for %s",
498 /* save a pointer to our private instance data */
501 sdi->serial = sr_serial_device_instance_new(path, -1);
503 goto err_device_instance_free;
505 device_instances = g_slist_append(device_instances, sdi);
509 err_device_instance_free:
510 sr_device_instance_free(sdi);
515 udev_enumerate_unref(enumerate);
522 static void hw_cleanup(void)
525 struct sr_device_instance *sdi;
527 /* Properly close all devices. */
528 for (l = device_instances; l; l = l->next) {
530 if (sdi->serial->fd != -1)
531 serial_close(sdi->serial->fd);
532 if (sdi->priv != NULL)
537 sr_device_instance_free(sdi);
539 g_slist_free(device_instances);
540 device_instances = NULL;
543 static int hw_opendev(int device_index)
545 struct sr_device_instance *sdi;
549 if (!(sdi = sr_get_device_instance(device_instances, device_index)))
553 sdi->serial->fd = serial_open(sdi->serial->port, O_RDWR);
554 if (sdi->serial->fd == -1)
557 ret = serial_set_params(sdi->serial->fd, 460800, 8, 0, 1, 2);
561 sdi->status = SR_ST_ACTIVE;
563 /* FIXME: discard serial buffer */
565 mso_check_trigger(sdi, &mso->trigger_state);
566 sr_dbg("trigger state: 0x%x", mso->trigger_state);
568 ret = mso_reset_adc(sdi);
572 mso_check_trigger(sdi, &mso->trigger_state);
573 sr_dbg("trigger state: 0x%x", mso->trigger_state);
575 // ret = mso_reset_fsm(sdi);
579 sr_dbg("Finished %s", __func__);
585 static int hw_closedev(int device_index)
587 struct sr_device_instance *sdi;
589 if (!(sdi = sr_get_device_instance(device_instances, device_index))) {
590 sr_err("mso19: %s: sdi was NULL", __func__);
591 return SR_ERR; /* TODO: SR_ERR_ARG? */
595 if (sdi->serial->fd != -1) {
596 serial_close(sdi->serial->fd);
597 sdi->serial->fd = -1;
598 sdi->status = SR_ST_INACTIVE;
601 sr_dbg("finished %s", __func__);
605 static void *hw_get_device_info(int device_index, int device_info_id)
607 struct sr_device_instance *sdi;
611 if (!(sdi = sr_get_device_instance(device_instances, device_index)))
615 switch (device_info_id) {
619 case SR_DI_NUM_PROBES: /* FIXME: How to report analog probe? */
620 info = GINT_TO_POINTER(NUM_PROBES);
622 case SR_DI_PROBE_NAMES:
625 case SR_DI_SAMPLERATES:
628 case SR_DI_TRIGGER_TYPES:
629 info = "01"; /* FIXME */
631 case SR_DI_CUR_SAMPLERATE:
632 info = &mso->cur_rate;
638 static int hw_get_status(int device_index)
640 struct sr_device_instance *sdi;
642 if (!(sdi = sr_get_device_instance(device_instances, device_index)))
643 return SR_ST_NOT_FOUND;
648 static int *hw_get_capabilities(void)
653 static int hw_set_configuration(int device_index, int capability, void *value)
655 struct sr_device_instance *sdi;
657 if (!(sdi = sr_get_device_instance(device_instances, device_index)))
660 switch (capability) {
661 case SR_HWCAP_SAMPLERATE:
662 return mso_configure_rate(sdi, *(uint64_t *) value);
663 case SR_HWCAP_PROBECONFIG:
664 case SR_HWCAP_LIMIT_SAMPLES:
666 return SR_OK; /* FIXME */
670 #define MSO_TRIGGER_UNKNOWN '!'
671 #define MSO_TRIGGER_UNKNOWN1 '1'
672 #define MSO_TRIGGER_UNKNOWN2 '2'
673 #define MSO_TRIGGER_UNKNOWN3 '3'
674 #define MSO_TRIGGER_WAIT '4'
675 #define MSO_TRIGGER_FIRED '5'
676 #define MSO_TRIGGER_DATAREADY '6'
678 /* FIXME: Pass errors? */
679 static int receive_data(int fd, int revents, void *user_data)
681 struct sr_device_instance *sdi = user_data;
682 struct mso *mso = sdi->priv;
683 struct sr_datafeed_packet packet;
684 struct sr_datafeed_logic logic;
685 uint8_t in[1024], logic_out[1024];
686 double analog_out[1024];
691 s = serial_read(fd, in, sizeof(in));
696 if (mso->trigger_state != MSO_TRIGGER_DATAREADY) {
697 mso->trigger_state = in[0];
698 if (mso->trigger_state == MSO_TRIGGER_DATAREADY) {
699 mso_read_buffer(sdi);
702 mso_check_trigger(sdi, NULL);
707 /* the hardware always dumps 1024 samples, 24bits each */
708 if (mso->buffer_n < 3072) {
709 memcpy(mso->buffer + mso->buffer_n, in, s);
712 if (mso->buffer_n < 3072)
715 /* do the conversion */
716 for (i = 0; i < 1024; i++) {
717 /* FIXME: Need to do conversion to mV */
718 analog_out[i] = (mso->buffer[i * 3] & 0x3f) |
719 ((mso->buffer[i * 3 + 1] & 0xf) << 6);
720 logic_out[i] = ((mso->buffer[i * 3 + 1] & 0x30) >> 4) |
721 ((mso->buffer[i * 3 + 2] & 0x3f) << 2);
724 packet.type = SR_DF_LOGIC;
725 packet.payload = &logic;
728 logic.data = logic_out;
729 sr_session_bus(mso->session_id, &packet);
731 // Dont bother fixing this yet, keep it "old style"
733 packet.type = SR_DF_ANALOG;
734 packet.length = 1024;
735 packet.unitsize = sizeof(double);
736 packet.payload = analog_out;
737 sr_session_bus(mso->session_id, &packet);
740 packet.type = SR_DF_END;
741 sr_session_bus(mso->session_id, &packet);
746 static int hw_start_acquisition(int device_index, gpointer session_device_id)
748 struct sr_device_instance *sdi;
750 struct sr_datafeed_packet packet;
751 struct sr_datafeed_header header;
754 if (!(sdi = sr_get_device_instance(device_instances, device_index)))
758 /* FIXME: No need to do full reconfigure every time */
759 // ret = mso_reset_fsm(sdi);
763 /* FIXME: ACDC Mode */
764 mso->ctlbase1 &= 0x7f;
765 // mso->ctlbase1 |= mso->acdcmode;
767 ret = mso_configure_rate(sdi, mso->cur_rate);
772 ret = mso_dac_out(sdi, mso->dac_offset);
776 ret = mso_configure_threshold_level(sdi);
780 ret = mso_configure_trigger(sdi);
784 /* FIXME: trigger_position */
787 /* END of config hardware part */
794 /* without trigger */
795 // ret = mso_force_capture(sdi);
799 mso_check_trigger(sdi, &mso->trigger_state);
800 ret = mso_check_trigger(sdi, NULL);
804 mso->session_id = session_device_id;
805 sr_source_add(sdi->serial->fd, G_IO_IN, -1, receive_data, sdi);
807 packet.type = SR_DF_HEADER;
808 packet.payload = (unsigned char *) &header;
809 header.feed_version = 1;
810 gettimeofday(&header.starttime, NULL);
811 header.samplerate = mso->cur_rate;
812 header.num_analog_probes = 1;
813 header.num_logic_probes = 8;
814 sr_session_bus(session_device_id, &packet);
820 static void hw_stop_acquisition(int device_index, gpointer session_device_id)
822 struct sr_datafeed_packet packet;
824 device_index = device_index;
826 packet.type = SR_DF_END;
827 sr_session_bus(session_device_id, &packet);
830 struct sr_device_plugin link_mso19_plugin_info = {
831 .name = "link-mso19",
832 .longname = "Link Instruments MSO-19",
835 .cleanup = hw_cleanup,
836 .opendev = hw_opendev,
837 .closedev = hw_closedev,
838 .get_device_info = hw_get_device_info,
839 .get_status = hw_get_status,
840 .get_capabilities = hw_get_capabilities,
841 .set_configuration = hw_set_configuration,
842 .start_acquisition = hw_start_acquisition,
843 .stop_acquisition = hw_stop_acquisition,