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"
33 #include "link-mso19.h"
35 #define USB_VENDOR "3195"
36 #define USB_PRODUCT "f190"
40 static int capabilities[] = {
41 SR_HWCAP_LOGIC_ANALYZER,
42 // SR_HWCAP_OSCILLOSCOPE,
43 // SR_HWCAP_PAT_GENERATOR,
46 // SR_HWCAP_CAPTURE_RATIO,
47 SR_HWCAP_LIMIT_SAMPLES,
51 static const char *probe_names[NUM_PROBES + 1] = {
63 static uint64_t supported_samplerates[] = {
87 static struct sr_samplerates samplerates = {
91 supported_samplerates,
94 static GSList *device_instances = NULL;
96 static int mso_send_control_message(struct sr_device_instance *sdi,
97 uint16_t payload[], int n)
99 int fd = sdi->serial->fd;
100 int i, w, ret, s = n * 2 + sizeof(mso_head) + sizeof(mso_foot);
108 if (!(buf = g_try_malloc(s))) {
109 sr_err("mso19: %s: buf malloc failed", __func__);
115 memcpy(p, mso_head, sizeof(mso_head));
116 p += sizeof(mso_head);
118 for (i = 0; i < n; i++) {
119 *(uint16_t *) p = htons(payload[i]);
122 memcpy(p, mso_foot, sizeof(mso_foot));
126 ret = serial_write(fd, buf + w, s - w);
140 static int mso_reset_adc(struct sr_device_instance *sdi)
142 struct mso *mso = sdi->priv;
145 ops[0] = mso_trans(REG_CTL1, (mso->ctlbase1 | BIT_CTL1_RESETADC));
146 ops[1] = mso_trans(REG_CTL1, mso->ctlbase1);
147 mso->ctlbase1 |= BIT_CTL1_ADC_UNKNOWN4;
149 sr_dbg("Requesting ADC reset");
150 return mso_send_control_message(sdi, ARRAY_AND_SIZE(ops));
153 static int mso_reset_fsm(struct sr_device_instance *sdi)
155 struct mso *mso = sdi->priv;
158 mso->ctlbase1 |= BIT_CTL1_RESETFSM;
159 ops[0] = mso_trans(REG_CTL1, mso->ctlbase1);
161 sr_dbg("Requesting ADC reset");
162 return mso_send_control_message(sdi, ARRAY_AND_SIZE(ops));
165 static int mso_toggle_led(struct sr_device_instance *sdi, int state)
167 struct mso *mso = sdi->priv;
170 mso->ctlbase1 &= ~BIT_CTL1_LED;
172 mso->ctlbase1 |= BIT_CTL1_LED;
173 ops[0] = mso_trans(REG_CTL1, mso->ctlbase1);
175 sr_dbg("Requesting LED toggle");
176 return mso_send_control_message(sdi, ARRAY_AND_SIZE(ops));
179 static int mso_check_trigger(struct sr_device_instance *sdi,
182 uint16_t ops[] = { mso_trans(REG_TRIGGER, 0) };
186 sr_dbg("Requesting trigger state");
187 ret = mso_send_control_message(sdi, ARRAY_AND_SIZE(ops));
188 if (info == NULL || ret != SR_OK)
192 if (serial_read(sdi->serial->fd, buf, 1) != 1) /* FIXME: Need timeout */
196 sr_dbg("Trigger state is: 0x%x", *info);
200 static int mso_read_buffer(struct sr_device_instance *sdi)
202 uint16_t ops[] = { mso_trans(REG_BUFFER, 0) };
204 sr_dbg("Requesting buffer dump");
205 return mso_send_control_message(sdi, ARRAY_AND_SIZE(ops));
208 static int mso_arm(struct sr_device_instance *sdi)
210 struct mso *mso = sdi->priv;
212 mso_trans(REG_CTL1, mso->ctlbase1 | BIT_CTL1_RESETFSM),
213 mso_trans(REG_CTL1, mso->ctlbase1 | BIT_CTL1_ARM),
214 mso_trans(REG_CTL1, mso->ctlbase1),
217 sr_dbg("Requesting trigger arm");
218 return mso_send_control_message(sdi, ARRAY_AND_SIZE(ops));
221 static int mso_force_capture(struct sr_device_instance *sdi)
223 struct mso *mso = sdi->priv;
225 mso_trans(REG_CTL1, mso->ctlbase1 | 8),
226 mso_trans(REG_CTL1, mso->ctlbase1),
229 sr_dbg("Requesting forced capture");
230 return mso_send_control_message(sdi, ARRAY_AND_SIZE(ops));
233 static int mso_dac_out(struct sr_device_instance *sdi, uint16_t val)
235 struct mso *mso = sdi->priv;
237 mso_trans(REG_DAC1, (val >> 8) & 0xff),
238 mso_trans(REG_DAC2, val & 0xff),
239 mso_trans(REG_CTL1, mso->ctlbase1 | BIT_CTL1_RESETADC),
242 sr_dbg("Setting dac word to 0x%x", val);
243 return mso_send_control_message(sdi, ARRAY_AND_SIZE(ops));
246 static int mso_clkrate_out(struct sr_device_instance *sdi, uint16_t val)
249 mso_trans(REG_CLKRATE1, (val >> 8) & 0xff),
250 mso_trans(REG_CLKRATE2, val & 0xff),
253 sr_dbg("Setting clkrate word to 0x%x", val);
254 return mso_send_control_message(sdi, ARRAY_AND_SIZE(ops));
257 static int mso_configure_rate(struct sr_device_instance *sdi,
260 struct mso *mso = sdi->priv;
264 for (i = 0; i < ARRAY_SIZE(rate_map); i++) {
265 if (rate_map[i].rate == rate) {
266 mso->ctlbase2 = rate_map[i].slowmode;
267 ret = mso_clkrate_out(sdi, rate_map[i].val);
269 mso->cur_rate = rate;
276 static inline uint16_t mso_calc_raw_from_mv(struct mso *mso)
278 return (uint16_t) (0x200 -
279 ((mso->dso_trigger_voltage / mso->dso_probe_attn) /
283 static int mso_configure_trigger(struct sr_device_instance *sdi)
285 struct mso *mso = sdi->priv;
287 uint16_t dso_trigger = mso_calc_raw_from_mv(mso);
289 dso_trigger &= 0x3ff;
290 if ((!mso->trigger_slope && mso->trigger_chan == 1) ||
291 (mso->trigger_slope &&
292 (mso->trigger_chan == 0 ||
293 mso->trigger_chan == 2 ||
294 mso->trigger_chan == 3)))
295 dso_trigger |= 0x400;
297 switch (mso->trigger_chan) {
299 dso_trigger |= 0xe000;
301 dso_trigger |= 0x4000;
304 dso_trigger |= 0x2000;
307 dso_trigger |= 0xa000;
310 dso_trigger |= 0x8000;
317 switch (mso->trigger_outsrc) {
319 dso_trigger |= 0x800;
322 dso_trigger |= 0x1000;
325 dso_trigger |= 0x1800;
330 ops[0] = mso_trans(5, mso->la_trigger);
331 ops[1] = mso_trans(6, mso->la_trigger_mask);
332 ops[2] = mso_trans(3, dso_trigger & 0xff);
333 ops[3] = mso_trans(4, (dso_trigger >> 8) & 0xff);
334 ops[4] = mso_trans(11,
335 mso->dso_trigger_width / SR_HZ_TO_NS(mso->cur_rate));
337 /* Select the SPI/I2C trigger config bank */
338 ops[5] = mso_trans(REG_CTL2, (mso->ctlbase2 | BITS_CTL2_BANK(2)));
339 /* Configure the SPI/I2C protocol trigger */
340 ops[6] = mso_trans(REG_PT_WORD(0), mso->protocol_trigger.word[0]);
341 ops[7] = mso_trans(REG_PT_WORD(1), mso->protocol_trigger.word[1]);
342 ops[8] = mso_trans(REG_PT_WORD(2), mso->protocol_trigger.word[2]);
343 ops[9] = mso_trans(REG_PT_WORD(3), mso->protocol_trigger.word[3]);
344 ops[10] = mso_trans(REG_PT_MASK(0), mso->protocol_trigger.mask[0]);
345 ops[11] = mso_trans(REG_PT_MASK(1), mso->protocol_trigger.mask[1]);
346 ops[12] = mso_trans(REG_PT_MASK(2), mso->protocol_trigger.mask[2]);
347 ops[13] = mso_trans(REG_PT_MASK(3), mso->protocol_trigger.mask[3]);
348 ops[14] = mso_trans(REG_PT_SPIMODE, mso->protocol_trigger.spimode);
349 /* Select the default config bank */
350 ops[15] = mso_trans(REG_CTL2, mso->ctlbase2);
352 return mso_send_control_message(sdi, ARRAY_AND_SIZE(ops));
355 static int mso_configure_threshold_level(struct sr_device_instance *sdi)
357 struct mso *mso = sdi->priv;
359 return mso_dac_out(sdi, la_threshold_map[mso->la_threshold]);
362 static int mso_parse_serial(const char *iSerial, const char *iProduct,
365 unsigned int u1, u2, u3, u4, u5, u6;
368 /* FIXME: This code is in the original app, but I think its
369 * used only for the GUI */
370 /* if (strstr(iProduct, "REV_02") || strstr(iProduct, "REV_03"))
371 mso->num_sample_rates = 0x16;
373 mso->num_sample_rates = 0x10; */
376 if (iSerial[0] != '4' || sscanf(iSerial, "%5u%3u%3u%1u%1u%6u",
377 &u1, &u2, &u3, &u4, &u5, &u6) != 6)
382 mso->vbit = u1 / 10000;
385 mso->dac_offset = u2;
386 if (mso->dac_offset == 0)
387 mso->dac_offset = 0x1ff;
388 mso->offset_range = u3;
389 if (mso->offset_range == 0)
390 mso->offset_range = 0x17d;
393 * FIXME: There is more code on the original software to handle
394 * bigger iSerial strings, but as I can't test on my device
395 * I will not implement it yet
401 static int hw_init(const char *deviceinfo)
403 struct sr_device_instance *sdi;
406 struct udev_enumerate *enumerate;
407 struct udev_list_entry *devices, *dev_list_entry;
410 deviceinfo = deviceinfo;
412 /* It's easier to map usb<->serial using udev */
414 * FIXME: On windows we can get the same information from the
415 * registry, add an #ifdef here later
419 sr_err("Failed to initialize udev.");
422 enumerate = udev_enumerate_new(udev);
423 udev_enumerate_add_match_subsystem(enumerate, "usb-serial");
424 udev_enumerate_scan_devices(enumerate);
425 devices = udev_enumerate_get_list_entry(enumerate);
426 udev_list_entry_foreach(dev_list_entry, devices) {
427 const char *syspath, *sysname, *idVendor, *idProduct,
429 char path[32], manufacturer[32], product[32], hwrev[32];
430 struct udev_device *dev, *parent;
433 syspath = udev_list_entry_get_name(dev_list_entry);
434 dev = udev_device_new_from_syspath(udev, syspath);
435 sysname = udev_device_get_sysname(dev);
436 parent = udev_device_get_parent_with_subsystem_devtype(
437 dev, "usb", "usb_device");
439 sr_err("Unable to find parent usb device for %s",
444 idVendor = udev_device_get_sysattr_value(parent, "idVendor");
445 idProduct = udev_device_get_sysattr_value(parent, "idProduct");
446 if (strcmp(USB_VENDOR, idVendor)
447 || strcmp(USB_PRODUCT, idProduct))
450 iSerial = udev_device_get_sysattr_value(parent, "serial");
451 iProduct = udev_device_get_sysattr_value(parent, "product");
453 snprintf(path, sizeof(path), "/dev/%s", sysname);
455 s = strcspn(iProduct, " ");
456 if (s > sizeof(product) ||
457 strlen(iProduct) - s > sizeof(manufacturer)) {
458 sr_err("Could not parse iProduct: %s", iProduct);
461 strncpy(product, iProduct, s);
463 strcpy(manufacturer, iProduct + s);
465 if (!(mso = g_try_malloc0(sizeof(struct mso)))) {
466 sr_err("mso19: %s: mso malloc failed", __func__);
467 continue; /* TODO: Errors handled correctly? */
470 if (mso_parse_serial(iSerial, iProduct, mso) != SR_OK) {
471 sr_err("Invalid iSerial: %s", iSerial);
474 sprintf(hwrev, "r%d", mso->hwrev);
476 /* hardware initial state */
479 /* Initialize the protocol trigger configuration */
481 for (i = 0; i < 4; i++)
483 mso->protocol_trigger.word[i] = 0;
484 mso->protocol_trigger.mask[i] = 0xff;
486 mso->protocol_trigger.spimode = 0;
489 sdi = sr_dev_inst_new(devcnt, SR_ST_INITIALIZING,
490 manufacturer, product, hwrev);
492 sr_err("Unable to create device instance for %s",
497 /* save a pointer to our private instance data */
500 sdi->serial = sr_serial_dev_inst_new(path, -1);
502 goto err_device_instance_free;
504 device_instances = g_slist_append(device_instances, sdi);
508 err_device_instance_free:
509 sr_dev_inst_free(sdi);
514 udev_enumerate_unref(enumerate);
521 static int hw_cleanup(void)
524 struct sr_device_instance *sdi;
528 /* Properly close all devices. */
529 for (l = device_instances; l; l = l->next) {
530 if (!(sdi = l->data)) {
531 /* Log error, but continue cleaning up the rest. */
532 sr_err("mso19: %s: sdi was NULL, continuing", __func__);
536 if (sdi->serial->fd != -1)
537 serial_close(sdi->serial->fd);
538 sr_dev_inst_free(sdi);
540 g_slist_free(device_instances);
541 device_instances = NULL;
546 static int hw_opendev(int device_index)
548 struct sr_device_instance *sdi;
552 if (!(sdi = sr_dev_inst_get(device_instances, device_index)))
556 sdi->serial->fd = serial_open(sdi->serial->port, O_RDWR);
557 if (sdi->serial->fd == -1)
560 ret = serial_set_params(sdi->serial->fd, 460800, 8, 0, 1, 2);
564 sdi->status = SR_ST_ACTIVE;
566 /* FIXME: discard serial buffer */
568 mso_check_trigger(sdi, &mso->trigger_state);
569 sr_dbg("trigger state: 0x%x", mso->trigger_state);
571 ret = mso_reset_adc(sdi);
575 mso_check_trigger(sdi, &mso->trigger_state);
576 sr_dbg("trigger state: 0x%x", mso->trigger_state);
578 // ret = mso_reset_fsm(sdi);
582 sr_dbg("Finished %s", __func__);
588 static int hw_closedev(int device_index)
590 struct sr_device_instance *sdi;
592 if (!(sdi = sr_dev_inst_get(device_instances, device_index))) {
593 sr_err("mso19: %s: sdi was NULL", __func__);
594 return SR_ERR; /* TODO: SR_ERR_ARG? */
598 if (sdi->serial->fd != -1) {
599 serial_close(sdi->serial->fd);
600 sdi->serial->fd = -1;
601 sdi->status = SR_ST_INACTIVE;
604 sr_dbg("finished %s", __func__);
608 static void *hw_get_device_info(int device_index, int device_info_id)
610 struct sr_device_instance *sdi;
614 if (!(sdi = sr_dev_inst_get(device_instances, device_index)))
618 switch (device_info_id) {
622 case SR_DI_NUM_PROBES: /* FIXME: How to report analog probe? */
623 info = GINT_TO_POINTER(NUM_PROBES);
625 case SR_DI_PROBE_NAMES:
628 case SR_DI_SAMPLERATES:
631 case SR_DI_TRIGGER_TYPES:
632 info = "01"; /* FIXME */
634 case SR_DI_CUR_SAMPLERATE:
635 info = &mso->cur_rate;
641 static int hw_get_status(int device_index)
643 struct sr_device_instance *sdi;
645 if (!(sdi = sr_dev_inst_get(device_instances, device_index)))
646 return SR_ST_NOT_FOUND;
651 static int *hw_get_capabilities(void)
656 static int hw_set_configuration(int device_index, int capability, void *value)
658 struct sr_device_instance *sdi;
660 if (!(sdi = sr_dev_inst_get(device_instances, device_index)))
663 switch (capability) {
664 case SR_HWCAP_SAMPLERATE:
665 return mso_configure_rate(sdi, *(uint64_t *) value);
666 case SR_HWCAP_PROBECONFIG:
667 case SR_HWCAP_LIMIT_SAMPLES:
669 return SR_OK; /* FIXME */
673 #define MSO_TRIGGER_UNKNOWN '!'
674 #define MSO_TRIGGER_UNKNOWN1 '1'
675 #define MSO_TRIGGER_UNKNOWN2 '2'
676 #define MSO_TRIGGER_UNKNOWN3 '3'
677 #define MSO_TRIGGER_WAIT '4'
678 #define MSO_TRIGGER_FIRED '5'
679 #define MSO_TRIGGER_DATAREADY '6'
681 /* FIXME: Pass errors? */
682 static int receive_data(int fd, int revents, void *user_data)
684 struct sr_device_instance *sdi = user_data;
685 struct mso *mso = sdi->priv;
686 struct sr_datafeed_packet packet;
687 struct sr_datafeed_logic logic;
688 uint8_t in[1024], logic_out[1024];
689 double analog_out[1024];
694 s = serial_read(fd, in, sizeof(in));
699 if (mso->trigger_state != MSO_TRIGGER_DATAREADY) {
700 mso->trigger_state = in[0];
701 if (mso->trigger_state == MSO_TRIGGER_DATAREADY) {
702 mso_read_buffer(sdi);
705 mso_check_trigger(sdi, NULL);
710 /* the hardware always dumps 1024 samples, 24bits each */
711 if (mso->buffer_n < 3072) {
712 memcpy(mso->buffer + mso->buffer_n, in, s);
715 if (mso->buffer_n < 3072)
718 /* do the conversion */
719 for (i = 0; i < 1024; i++) {
720 /* FIXME: Need to do conversion to mV */
721 analog_out[i] = (mso->buffer[i * 3] & 0x3f) |
722 ((mso->buffer[i * 3 + 1] & 0xf) << 6);
723 logic_out[i] = ((mso->buffer[i * 3 + 1] & 0x30) >> 4) |
724 ((mso->buffer[i * 3 + 2] & 0x3f) << 2);
727 packet.type = SR_DF_LOGIC;
728 packet.payload = &logic;
731 logic.data = logic_out;
732 sr_session_bus(mso->session_id, &packet);
734 // Dont bother fixing this yet, keep it "old style"
736 packet.type = SR_DF_ANALOG;
737 packet.length = 1024;
738 packet.unitsize = sizeof(double);
739 packet.payload = analog_out;
740 sr_session_bus(mso->session_id, &packet);
743 packet.type = SR_DF_END;
744 sr_session_bus(mso->session_id, &packet);
749 static int hw_start_acquisition(int device_index, gpointer session_device_id)
751 struct sr_device_instance *sdi;
753 struct sr_datafeed_packet packet;
754 struct sr_datafeed_header header;
757 if (!(sdi = sr_dev_inst_get(device_instances, device_index)))
761 /* FIXME: No need to do full reconfigure every time */
762 // ret = mso_reset_fsm(sdi);
766 /* FIXME: ACDC Mode */
767 mso->ctlbase1 &= 0x7f;
768 // mso->ctlbase1 |= mso->acdcmode;
770 ret = mso_configure_rate(sdi, mso->cur_rate);
775 ret = mso_dac_out(sdi, mso->dac_offset);
779 ret = mso_configure_threshold_level(sdi);
783 ret = mso_configure_trigger(sdi);
787 /* FIXME: trigger_position */
790 /* END of config hardware part */
797 /* without trigger */
798 // ret = mso_force_capture(sdi);
802 mso_check_trigger(sdi, &mso->trigger_state);
803 ret = mso_check_trigger(sdi, NULL);
807 mso->session_id = session_device_id;
808 sr_source_add(sdi->serial->fd, G_IO_IN, -1, receive_data, sdi);
810 packet.type = SR_DF_HEADER;
811 packet.payload = (unsigned char *) &header;
812 header.feed_version = 1;
813 gettimeofday(&header.starttime, NULL);
814 header.samplerate = mso->cur_rate;
815 // header.num_analog_probes = 1;
816 header.num_logic_probes = 8;
817 sr_session_bus(session_device_id, &packet);
823 static int hw_stop_acquisition(int device_index, gpointer session_device_id)
825 struct sr_datafeed_packet packet;
827 device_index = device_index;
829 packet.type = SR_DF_END;
830 sr_session_bus(session_device_id, &packet);
835 SR_PRIV struct sr_device_plugin link_mso19_plugin_info = {
836 .name = "link-mso19",
837 .longname = "Link Instruments MSO-19",
840 .cleanup = hw_cleanup,
841 .opendev = hw_opendev,
842 .closedev = hw_closedev,
843 .get_device_info = hw_get_device_info,
844 .get_status = hw_get_status,
845 .get_capabilities = hw_get_capabilities,
846 .set_configuration = hw_set_configuration,
847 .start_acquisition = hw_start_acquisition,
848 .stop_acquisition = hw_stop_acquisition,