X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=hardware%2Funi-t-dmm%2Fprotocol.c;h=3158e0fad54103eb6c534008cd1bfef9b92f56d6;hb=5f985df23cb2a15d498d60fec8a4e5d14e38a7c0;hp=96d26a65085e302f2751ed30b874d5b4e71f47a5;hpb=8c1adf3738b68912ab8cf4308341b82dbc83056a;p=libsigrok.git diff --git a/hardware/uni-t-dmm/protocol.c b/hardware/uni-t-dmm/protocol.c index 96d26a65..3158e0fa 100644 --- a/hardware/uni-t-dmm/protocol.c +++ b/hardware/uni-t-dmm/protocol.c @@ -1,7 +1,7 @@ /* - * This file is part of the sigrok project. + * This file is part of the libsigrok project. * - * Copyright (C) 2012 Uwe Hermann + * Copyright (C) 2012-2013 Uwe Hermann * * 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 @@ -24,17 +24,20 @@ #include "libsigrok-internal.h" #include "protocol.h" +extern struct dmm_info udmms[]; + /* * Driver for various UNI-T multimeters (and rebranded ones). * * Most UNI-T DMMs can be used with two (three) different PC interface cables: * - The UT-D04 USB/HID cable, old version with Hoitek HE2325U chip. * - The UT-D04 USB/HID cable, new version with WCH CH9325 chip. - * - The UT-D01 RS232 cable. + * - The UT-D02 RS232 cable. * - * This driver is meant to support all three cables, and various DMMs that + * This driver is meant to support all USB/HID cables, and various DMMs that * can be attached to a PC via these cables. Currently only the UT-D04 cable - * (new version) is supported. + * (new version) is supported/tested. + * The UT-D02 RS232 cable is handled by the 'serial-dmm' driver. * * The data for one DMM packet (e.g. 14 bytes if the respective DMM uses a * Fortune Semiconductor FS9922-DMM4 chip) is spread across multiple @@ -48,45 +51,33 @@ * f0 00 00 00 00 00 00 00 (no data bytes) * f2 55 77 00 00 00 00 00 (2 data bytes, 0x55 and 0x77) * f1 d1 00 00 00 00 00 00 (1 data byte, 0xd1) - * - * Chips and serial settings used in UNI-T DMMs (and rebranded ones): - * - UNI-T UT108: ? - * - UNI-T UT109: ? - * - UNI-T UT30A: ? - * - UNI-T UT30E: ? - * - UNI-T UT60E: Fortune Semiconductor FS9721_LP3 - * - UNI-T UT60G: ? - * - UNI-T UT61B: ? - * - UNI-T UT61C: ? - * - UNI-T UT61D: Fortune Semiconductor FS9922-DMM4 - * - UNI-T UT61E: Cyrustek ES51922 - * - UNI-T UT70B: ? - * - Voltcraft VC-820: Fortune Semiconductor FS9721_LP3 - * - Voltcraft VC-840: Fortune Semiconductor FS9721_LP3 - * - ... */ -static void decode_packet(struct dev_context *devc, int dmm, const uint8_t *buf) +static void decode_packet(struct sr_dev_inst *sdi, int dmm, const uint8_t *buf, + void *info) { + struct dev_context *devc; struct sr_datafeed_packet packet; struct sr_datafeed_analog analog; - struct fs9721_info info; float floatval; int ret; + devc = sdi->priv; memset(&analog, 0, sizeof(struct sr_datafeed_analog)); /* Parse the protocol packet. */ - if (dmm == UNI_T_UT61D) - ret = sr_dmm_parse_fs9922(buf, &floatval, &analog); - else if (dmm == VOLTCRAFT_VC820) - ret = sr_fs9721_parse(buf, &floatval, &analog, &info); + ret = udmms[dmm].packet_parse(buf, &floatval, &analog, info); if (ret != SR_OK) { - sr_err("Invalid DMM packet, ignoring."); + sr_dbg("Invalid DMM packet, ignoring."); return; } + /* If this DMM needs additional handling, call the resp. function. */ + if (udmms[dmm].dmm_details) + udmms[dmm].dmm_details(&analog, info); + /* Send a sample packet with one analog value. */ + analog.probes = sdi->probes; analog.num_samples = 1; analog.data = &floatval; packet.type = SR_DF_ANALOG; @@ -97,16 +88,20 @@ static void decode_packet(struct dev_context *devc, int dmm, const uint8_t *buf) devc->num_samples++; } -static int hid_chip_init(struct dev_context *devc, uint16_t baudrate) +static int hid_chip_init(struct sr_dev_inst *sdi, uint16_t baudrate) { int ret; uint8_t buf[5]; + struct sr_usb_dev_inst *usb; + usb = sdi->conn; + /* Detach kernel drivers which grabbed this device (if any). */ - if (libusb_kernel_driver_active(devc->usb->devhdl, 0) == 1) { - ret = libusb_detach_kernel_driver(devc->usb->devhdl, 0); + if (libusb_kernel_driver_active(usb->devhdl, 0) == 1) { + ret = libusb_detach_kernel_driver(usb->devhdl, 0); if (ret < 0) { - sr_err("Failed to detach kernel driver: %d.", ret); + sr_err("Failed to detach kernel driver: %s.", + libusb_error_name(ret)); return SR_ERR; } sr_dbg("Successfully detached kernel driver."); @@ -115,13 +110,14 @@ static int hid_chip_init(struct dev_context *devc, uint16_t baudrate) } /* Claim interface 0. */ - if ((ret = libusb_claim_interface(devc->usb->devhdl, 0)) < 0) { - sr_err("Failed to claim interface 0: %d.", ret); + if ((ret = libusb_claim_interface(usb->devhdl, 0)) < 0) { + sr_err("Failed to claim interface 0: %s.", + libusb_error_name(ret)); return SR_ERR; } sr_dbg("Successfully claimed interface 0."); - /* Baudrate example: 19230 baud -> HEX(19230) == 0x4b1e */ + /* Set data for the HID feature report (e.g. baudrate). */ buf[0] = baudrate & 0xff; /* Baudrate, LSB */ buf[1] = (baudrate >> 8) & 0xff; /* Baudrate, MSB */ buf[2] = 0x00; /* Unknown/unused (?) */ @@ -133,7 +129,7 @@ static int hid_chip_init(struct dev_context *devc, uint16_t baudrate) sr_spew("HID init = 0x%02x 0x%02x 0x%02x 0x%02x 0x%02x (%d baud)", buf[0], buf[1], buf[2], buf[3], buf[4], baudrate); ret = libusb_control_transfer( - devc->usb->devhdl, /* libusb device handle */ + usb->devhdl, /* libusb device handle */ LIBUSB_REQUEST_TYPE_CLASS | LIBUSB_RECIPIENT_INTERFACE | LIBUSB_ENDPOINT_OUT, @@ -145,7 +141,7 @@ static int hid_chip_init(struct dev_context *devc, uint16_t baudrate) 1000 /* timeout (ms) */); if (ret < 0) { - sr_err("HID feature report error: %d.", ret); + sr_err("HID feature report error: %s.", libusb_error_name(ret)); return SR_ERR; } @@ -175,40 +171,32 @@ static void log_dmm_packet(const uint8_t *buf) buf[7], buf[8], buf[9], buf[10], buf[11], buf[12], buf[13]); } -static int uni_t_dmm_receive_data(int fd, int revents, int dmm, void *cb_data) +static int get_and_handle_data(struct sr_dev_inst *sdi, int dmm, void *info) { - struct sr_dev_inst *sdi; struct dev_context *devc; + uint8_t buf[CHUNK_SIZE], *pbuf; int i, ret, len, num_databytes_in_chunk; - uint8_t buf[CHUNK_SIZE]; - uint8_t *pbuf; - static gboolean first_run = TRUE, synced_on_first_packet = FALSE; - static uint64_t data_byte_counter = 0; + struct sr_usb_dev_inst *usb; - (void)fd; - (void)revents; - - sdi = cb_data; devc = sdi->priv; - + usb = sdi->conn; pbuf = devc->protocol_buf; /* On the first run, we need to init the HID chip. */ - if (first_run) { - /* TODO: The baudrate is DMM-specific (UT61D: 19230). */ - if ((ret = hid_chip_init(devc, 19230)) != SR_OK) { + if (devc->first_run) { + if ((ret = hid_chip_init(sdi, udmms[dmm].baudrate)) != SR_OK) { sr_err("HID chip init failed: %d.", ret); - return FALSE; + return SR_ERR; } - memset(pbuf, 0x00, NUM_DATA_BYTES); - first_run = FALSE; + memset(pbuf, 0x00, DMM_BUFSIZE); + devc->first_run = FALSE; } memset(&buf, 0x00, CHUNK_SIZE); /* Get data from EP2 using an interrupt transfer. */ ret = libusb_interrupt_transfer( - devc->usb->devhdl, /* libusb device handle */ + usb->devhdl, /* libusb device handle */ LIBUSB_ENDPOINT_IN | 2, /* EP2, IN */ (unsigned char *)&buf, /* receive buffer */ CHUNK_SIZE, /* wLength */ @@ -216,66 +204,108 @@ static int uni_t_dmm_receive_data(int fd, int revents, int dmm, void *cb_data) 1000 /* timeout (ms) */); if (ret < 0) { - sr_err("USB receive error: %d.", ret); - return FALSE; + sr_err("USB receive error: %s.", libusb_error_name(ret)); + return SR_ERR; } if (len != CHUNK_SIZE) { sr_err("Short packet: received %d/%d bytes.", len, CHUNK_SIZE); /* TODO: Print the bytes? */ - return FALSE; + return SR_ERR; } log_8byte_chunk((const uint8_t *)&buf); - if (buf[0] != 0xf0) { - /* First time: Synchronize to the start of a packet. */ - if (!synced_on_first_packet) { - if (dmm == UNI_T_UT61D) { - /* Valid packets start with '+' or '-'. */ - if ((buf[1] != '+') && buf[1] != '-') - return TRUE; - } else if (dmm == VOLTCRAFT_VC820) { - /* Valid packets have 0x1 as high nibble. */ - if (!sr_fs9721_is_packet_start(buf[1])) - return TRUE; - } - synced_on_first_packet = TRUE; - sr_spew("Successfully synchronized on first packet."); - } + /* If there are no data bytes just return (without error). */ + if (buf[0] == 0xf0) + return SR_OK; + + devc->bufoffset = 0; + + /* + * Append the 1-7 data bytes of this chunk to pbuf. + * + * Special case: + * DMMs with Cyrustek ES51922 chip need serial settings of + * 19230/7o1. The WCH CH9325 UART to USB/HID chip used in (some + * versions of) the UNI-T UT-D04 cable however, will also send + * the parity bit to the host in the 8-byte data chunks. This bit + * is encoded in bit 7 of each of the 1-7 data bytes and must thus + * be removed in order for the actual ES51922 protocol parser to + * work properly. + */ + num_databytes_in_chunk = buf[0] & 0x0f; + for (i = 0; i < num_databytes_in_chunk; i++, devc->buflen++) { + pbuf[devc->buflen] = buf[1 + i]; + if (udmms[dmm].packet_parse == sr_es51922_parse) + pbuf[devc->buflen] &= ~(1 << 7); + } - num_databytes_in_chunk = buf[0] & 0x0f; - for (i = 0; i < num_databytes_in_chunk; i++) - pbuf[data_byte_counter++] = buf[1 + i]; - - /* TODO: Handle > 14 bytes in pbuf? Can this happen? */ - if (data_byte_counter == NUM_DATA_BYTES) { - log_dmm_packet(pbuf); - data_byte_counter = 0; - if (!sr_fs9721_packet_valid(pbuf)) { - sr_err("Invalid packet."); - return TRUE; - } - decode_packet(devc, dmm, pbuf); - memset(pbuf, 0x00, NUM_DATA_BYTES); + /* Now look for packets in that data. */ + while ((devc->buflen - devc->bufoffset) >= udmms[dmm].packet_size) { + if (udmms[dmm].packet_valid(pbuf + devc->bufoffset)) { + log_dmm_packet(pbuf + devc->bufoffset); + decode_packet(sdi, dmm, pbuf + devc->bufoffset, info); + devc->bufoffset += udmms[dmm].packet_size; + } else { + devc->bufoffset++; } } + /* Move remaining bytes to beginning of buffer. */ + for (i = 0; i < devc->buflen - devc->bufoffset; i++) + pbuf[i] = pbuf[devc->bufoffset + i]; + devc->buflen -= devc->bufoffset; + + return SR_OK; +} + +static int receive_data(int fd, int revents, int dmm, void *info, void *cb_data) +{ + int ret; + struct sr_dev_inst *sdi; + struct dev_context *devc; + int64_t time_ms; + + (void)fd; + (void)revents; + + sdi = cb_data; + devc = sdi->priv; + + if ((ret = get_and_handle_data(sdi, dmm, info)) != SR_OK) + return FALSE; + /* Abort acquisition if we acquired enough samples. */ - if (devc->num_samples >= devc->limit_samples && devc->limit_samples > 0) { + if (devc->limit_samples && devc->num_samples >= devc->limit_samples) { sr_info("Requested number of samples reached."); sdi->driver->dev_acquisition_stop(sdi, cb_data); } - return TRUE; -} + if (devc->limit_msec) { + time_ms = (g_get_monotonic_time() - devc->starttime) / 1000; + if (time_ms > (int64_t)devc->limit_msec) { + sr_info("Requested time limit reached."); + sdi->driver->dev_acquisition_stop(sdi, cb_data); + return TRUE; + } + } -SR_PRIV int uni_t_ut61d_receive_data(int fd, int revents, void *cb_data) -{ - return uni_t_dmm_receive_data(fd, revents, UNI_T_UT61D, cb_data); + return TRUE; } -SR_PRIV int voltcraft_vc820_receive_data(int fd, int revents, void *cb_data) -{ - return uni_t_dmm_receive_data(fd, revents, VOLTCRAFT_VC820, cb_data); -} +#define RECEIVE_DATA(ID_UPPER, DMM_DRIVER) \ +SR_PRIV int receive_data_##ID_UPPER(int fd, int revents, void *cb_data) { \ + struct DMM_DRIVER##_info info; \ + return receive_data(fd, revents, ID_UPPER, &info, cb_data); } + +/* Driver-specific receive_data() wrappers */ +RECEIVE_DATA(TECPEL_DMM_8061, fs9721) +RECEIVE_DATA(UNI_T_UT60A, fs9721) +RECEIVE_DATA(UNI_T_UT60E, fs9721) +RECEIVE_DATA(UNI_T_UT61C, fs9922) +RECEIVE_DATA(UNI_T_UT61D, fs9922) +RECEIVE_DATA(UNI_T_UT61E, es51922) +RECEIVE_DATA(VOLTCRAFT_VC820, fs9721) +RECEIVE_DATA(VOLTCRAFT_VC830, fs9922) +RECEIVE_DATA(VOLTCRAFT_VC840, fs9721)