[libsigrok.git] / hardware / uni-t-dmm / protocol.c

/*
 * This file is part of the libsigrok project.
 *
 * Copyright (C) 2012 Uwe Hermann <uwe@hermann-uwe.de>
 *
 * 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
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
 */

#include <string.h>
#include <glib.h>
#include "libsigrok.h"
#include "libsigrok-internal.h"
#include "protocol.h"

/*
 * 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-D02 RS232 cable.
 *
 * 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/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
 * 8-byte chunks.
 *
 * An 8-byte chunk looks like this:
 *  - Byte 0: 0xfz, where z is the number of actual data bytes in this chunk.
 *  - Bytes 1-7: z data bytes, the rest of the bytes should be ignored.
 *
 * Example:
 *  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 sr_dev_inst *sdi, int dmm, const uint8_t *buf,
			  void *info)
{
	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. */
	ret = udmms[dmm].packet_parse(buf, &floatval, &analog, &info);
	if (ret != SR_OK) {
		sr_err("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;
	packet.payload = &analog;
	sr_session_send(devc->cb_data, &packet);

	/* Increase sample count. */
	devc->num_samples++;
}

static int hid_chip_init(struct dev_context *devc, uint16_t baudrate)
{
	int ret;
	uint8_t buf[5];

	/* 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 (ret < 0) {
			sr_err("Failed to detach kernel driver: %s.",
			       libusb_error_name(ret));
			return SR_ERR;
		}
		sr_dbg("Successfully detached kernel driver.");
	} else {
		sr_dbg("No need to detach a kernel driver.");
	}

	/* Claim interface 0. */
	if ((ret = libusb_claim_interface(devc->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 */
	buf[0] = baudrate & 0xff;        /* Baudrate, LSB */
	buf[1] = (baudrate >> 8) & 0xff; /* Baudrate, MSB */
	buf[2] = 0x00;                   /* Unknown/unused (?) */
	buf[3] = 0x00;                   /* Unknown/unused (?) */
	buf[4] = 0x03;                   /* Unknown, always 0x03. */

	/* Send HID feature report to setup the baudrate/chip. */
	sr_dbg("Sending initial HID feature report.");
	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 */
		LIBUSB_REQUEST_TYPE_CLASS |
		LIBUSB_RECIPIENT_INTERFACE |
		LIBUSB_ENDPOINT_OUT,
		9, /* bRequest: HID set_report */
		0x300, /* wValue: HID feature, report number 0 */
		0, /* wIndex: interface 0 */
		(unsigned char *)&buf, /* payload buffer */
		5, /* wLength: 5 bytes payload */
		1000 /* timeout (ms) */);

	if (ret < 0) {
		sr_err("HID feature report error: %s.", libusb_error_name(ret));
		return SR_ERR;
	}

	if (ret != 5) {
		/* TODO: Handle better by also sending the remaining bytes. */
		sr_err("Short packet: sent %d/5 bytes.", ret);
		return SR_ERR;
	}

	sr_dbg("Successfully sent initial HID feature report.");

	return SR_OK;
}

static void log_8byte_chunk(const uint8_t *buf)
{
	sr_spew("8-byte chunk: %02x %02x %02x %02x %02x %02x %02x %02x "
		"(%d data bytes)", buf[0], buf[1], buf[2], buf[3],
		buf[4], buf[5], buf[6], buf[7], (buf[0] & 0x0f));
}

static void log_dmm_packet(const uint8_t *buf)
{
	sr_dbg("DMM packet:   %02x %02x %02x %02x %02x %02x %02x"
	       " %02x %02x %02x %02x %02x %02x %02x",
	       buf[0], buf[1], buf[2], buf[3], buf[4], buf[5], buf[6],
	       buf[7], buf[8], buf[9], buf[10], buf[11], buf[12], buf[13]);
}

static int receive_data(int fd, int revents, int dmm, void *info, void *cb_data)
{
	struct sr_dev_inst *sdi;
	struct dev_context *devc;
	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;

	(void)fd;
	(void)revents;

	sdi = cb_data;
	devc = sdi->priv;

	pbuf = devc->protocol_buf;

	/* On the first run, we need to init the HID chip. */
	if (first_run) {
		/* Note: The baudrate is DMM-specific (UT61D: 19230). */
		if ((ret = hid_chip_init(devc, udmms[dmm].baudrate)) != SR_OK) {
			sr_err("HID chip init failed: %d.", ret);
			return FALSE;
		}
		memset(pbuf, 0x00, NUM_DATA_BYTES);
		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 */
		LIBUSB_ENDPOINT_IN | 2, /* EP2, IN */
		(unsigned char *)&buf, /* receive buffer */
		CHUNK_SIZE, /* wLength */
		&len, /* actually received byte count */
		1000 /* timeout (ms) */);

	if (ret < 0) {
		sr_err("USB receive error: %s.", libusb_error_name(ret));
		return FALSE;
	}

	if (len != CHUNK_SIZE) {
		sr_err("Short packet: received %d/%d bytes.", len, CHUNK_SIZE);
		/* TODO: Print the bytes? */
		return FALSE;
	}

	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 (!udmms[dmm].packet_valid(buf))
				return TRUE;
			synced_on_first_packet = TRUE;
			sr_spew("Successfully synchronized on first packet.");
		}

		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 (!udmms[dmm].packet_valid(pbuf)) {
				sr_err("Invalid packet.");
				return TRUE;
			}

			decode_packet(sdi, dmm, pbuf, info);

			memset(pbuf, 0x00, NUM_DATA_BYTES);
		}
	}

	/* Abort acquisition if we acquired enough samples. */
	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;
}

#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(UNI_T_UT61D, fs9922)
RECEIVE_DATA(VOLTCRAFT_VC820, fs9721)
Commit	Line	Data
79081ec8	1	/*
50985c20	2	* This file is part of the libsigrok project.
79081ec8 UH	3	*
	4	* Copyright (C) 2012 Uwe Hermann <uwe@hermann-uwe.de>
	5	*
	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 2 of the License, or
	9	* (at your option) any later version.
	10	*
	11	* This program is distributed in the hope that it will be useful,
	12	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	13	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	14	* GNU General Public License for more details.
	15	*
	16	* You should have received a copy of the GNU General Public License
	17	* along with this program; if not, write to the Free Software
	18	* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
	19	*/
	20
	21	#include <string.h>
	22	#include <glib.h>
	23	#include "libsigrok.h"
	24	#include "libsigrok-internal.h"
	25	#include "protocol.h"
	26
	27	/*
	28	* Driver for various UNI-T multimeters (and rebranded ones).
	29	*
	30	* Most UNI-T DMMs can be used with two (three) different PC interface cables:
	31	* - The UT-D04 USB/HID cable, old version with Hoitek HE2325U chip.
	32	* - The UT-D04 USB/HID cable, new version with WCH CH9325 chip.
c8852687	33	* - The UT-D02 RS232 cable.
79081ec8	34	*
c8852687	35	* This driver is meant to support all USB/HID cables, and various DMMs that
79081ec8	36	* can be attached to a PC via these cables. Currently only the UT-D04 cable
c8852687 UH	37	* (new version) is supported/tested.
c8852687 UH	38	* The UT-D02 RS232 cable is handled by the 'serial-dmm' driver.
79081ec8 UH	39	*
	40	* The data for one DMM packet (e.g. 14 bytes if the respective DMM uses a
	41	* Fortune Semiconductor FS9922-DMM4 chip) is spread across multiple
	42	* 8-byte chunks.
	43	*
	44	* An 8-byte chunk looks like this:
	45	* - Byte 0: 0xfz, where z is the number of actual data bytes in this chunk.
	46	* - Bytes 1-7: z data bytes, the rest of the bytes should be ignored.
	47	*
	48	* Example:
	49	* f0 00 00 00 00 00 00 00 (no data bytes)
	50	* f2 55 77 00 00 00 00 00 (2 data bytes, 0x55 and 0x77)
	51	* f1 d1 00 00 00 00 00 00 (1 data byte, 0xd1)
	52	*
	53	* Chips and serial settings used in UNI-T DMMs (and rebranded ones):
	54	* - UNI-T UT108: ?
	55	* - UNI-T UT109: ?
	56	* - UNI-T UT30A: ?
	57	* - UNI-T UT30E: ?
	58	* - UNI-T UT60E: Fortune Semiconductor FS9721_LP3
	59	* - UNI-T UT60G: ?
	60	* - UNI-T UT61B: ?
	61	* - UNI-T UT61C: ?
	62	* - UNI-T UT61D: Fortune Semiconductor FS9922-DMM4
	63	* - UNI-T UT61E: Cyrustek ES51922
	64	* - UNI-T UT70B: ?
	65	* - Voltcraft VC-820: Fortune Semiconductor FS9721_LP3
	66	* - Voltcraft VC-840: Fortune Semiconductor FS9721_LP3
	67	* - ...
	68	*/
	69
c8852687 UH	70	static void decode_packet(struct sr_dev_inst sdi, int dmm, const uint8_t buf,
c8852687 UH	71	void *info)
79081ec8 UH	72	{
	73	struct sr_datafeed_packet packet;
	74	struct sr_datafeed_analog analog;
c8852687	75	/// struct fs9721_info info;
79081ec8 UH	76	float floatval;
	77	int ret;
	78
69e19dd7	79	devc = sdi->priv;
79081ec8 UH	80	memset(&analog, 0, sizeof(struct sr_datafeed_analog));
	81
	82	/* Parse the protocol packet. */
c8852687	83	ret = udmms[dmm].packet_parse(buf, &floatval, &analog, &info);
fdbcb86d	84	if (ret != SR_OK) {
79081ec8 UH	85	sr_err("Invalid DMM packet, ignoring.");
	86	return;
	87	}
	88
c8852687 UH	89	/* If this DMM needs additional handling, call the resp. function. */
	90	if (udmms[dmm].dmm_details)
	91	udmms[dmm].dmm_details(&analog, info);
	92
79081ec8	93	/* Send a sample packet with one analog value. */
69e19dd7	94	analog.probes = sdi->probes;
79081ec8 UH	95	analog.num_samples = 1;
	96	analog.data = &floatval;
	97	packet.type = SR_DF_ANALOG;
	98	packet.payload = &analog;
	99	sr_session_send(devc->cb_data, &packet);
	100
	101	/* Increase sample count. */
	102	devc->num_samples++;
	103	}
	104
	105	static int hid_chip_init(struct dev_context *devc, uint16_t baudrate)
	106	{
	107	int ret;
	108	uint8_t buf[5];
	109
	110	/* Detach kernel drivers which grabbed this device (if any). */
	111	if (libusb_kernel_driver_active(devc->usb->devhdl, 0) == 1) {
	112	ret = libusb_detach_kernel_driver(devc->usb->devhdl, 0);
	113	if (ret < 0) {
d4928d71 PS	114	sr_err("Failed to detach kernel driver: %s.",
d4928d71 PS	115	libusb_error_name(ret));
79081ec8 UH	116	return SR_ERR;
	117	}
	118	sr_dbg("Successfully detached kernel driver.");
	119	} else {
	120	sr_dbg("No need to detach a kernel driver.");
	121	}
	122
	123	/* Claim interface 0. */
	124	if ((ret = libusb_claim_interface(devc->usb->devhdl, 0)) < 0) {
d4928d71 PS	125	sr_err("Failed to claim interface 0: %s.",
d4928d71 PS	126	libusb_error_name(ret));
79081ec8 UH	127	return SR_ERR;
	128	}
	129	sr_dbg("Successfully claimed interface 0.");
	130
	131	/* Baudrate example: 19230 baud -> HEX(19230) == 0x4b1e */
	132	buf[0] = baudrate & 0xff; /* Baudrate, LSB */
	133	buf[1] = (baudrate >> 8) & 0xff; /* Baudrate, MSB */
	134	buf[2] = 0x00; /* Unknown/unused (?) */
	135	buf[3] = 0x00; /* Unknown/unused (?) */
	136	buf[4] = 0x03; /* Unknown, always 0x03. */
	137
	138	/* Send HID feature report to setup the baudrate/chip. */
	139	sr_dbg("Sending initial HID feature report.");
	140	sr_spew("HID init = 0x%02x 0x%02x 0x%02x 0x%02x 0x%02x (%d baud)",
	141	buf[0], buf[1], buf[2], buf[3], buf[4], baudrate);
	142	ret = libusb_control_transfer(
	143	devc->usb->devhdl, /* libusb device handle */
	144	LIBUSB_REQUEST_TYPE_CLASS \|
	145	LIBUSB_RECIPIENT_INTERFACE \|
	146	LIBUSB_ENDPOINT_OUT,
	147	9, /* bRequest: HID set_report */
	148	0x300, /* wValue: HID feature, report number 0 */
	149	0, /* wIndex: interface 0 */
	150	(unsigned char )&buf, / payload buffer */
	151	5, /* wLength: 5 bytes payload */
	152	1000 /* timeout (ms) */);
	153
	154	if (ret < 0) {
d4928d71	155	sr_err("HID feature report error: %s.", libusb_error_name(ret));
79081ec8 UH	156	return SR_ERR;
	157	}
	158
	159	if (ret != 5) {
	160	/* TODO: Handle better by also sending the remaining bytes. */
	161	sr_err("Short packet: sent %d/5 bytes.", ret);
	162	return SR_ERR;
	163	}
	164
	165	sr_dbg("Successfully sent initial HID feature report.");
	166
	167	return SR_OK;
	168	}
	169
	170	static void log_8byte_chunk(const uint8_t *buf)
	171	{
	172	sr_spew("8-byte chunk: %02x %02x %02x %02x %02x %02x %02x %02x "
	173	"(%d data bytes)", buf[0], buf[1], buf[2], buf[3],
	174	buf[4], buf[5], buf[6], buf[7], (buf[0] & 0x0f));
	175	}
	176
	177	static void log_dmm_packet(const uint8_t *buf)
	178	{
	179	sr_dbg("DMM packet: %02x %02x %02x %02x %02x %02x %02x"
	180	" %02x %02x %02x %02x %02x %02x %02x",
	181	buf[0], buf[1], buf[2], buf[3], buf[4], buf[5], buf[6],
	182	buf[7], buf[8], buf[9], buf[10], buf[11], buf[12], buf[13]);
	183	}
	184
c8852687	185	static int receive_data(int fd, int revents, int dmm, void info, void cb_data)
79081ec8 UH	186	{
	187	struct sr_dev_inst *sdi;
	188	struct dev_context *devc;
	189	int i, ret, len, num_databytes_in_chunk;
	190	uint8_t buf[CHUNK_SIZE];
	191	uint8_t *pbuf;
	192	static gboolean first_run = TRUE, synced_on_first_packet = FALSE;
	193	static uint64_t data_byte_counter = 0;
	194
	195	(void)fd;
	196	(void)revents;
	197
	198	sdi = cb_data;
	199	devc = sdi->priv;
	200
	201	pbuf = devc->protocol_buf;
	202
	203	/* On the first run, we need to init the HID chip. */
	204	if (first_run) {
c8852687 UH	205	/* Note: The baudrate is DMM-specific (UT61D: 19230). */
c8852687 UH	206	if ((ret = hid_chip_init(devc, udmms[dmm].baudrate)) != SR_OK) {
79081ec8 UH	207	sr_err("HID chip init failed: %d.", ret);
	208	return FALSE;
	209	}
	210	memset(pbuf, 0x00, NUM_DATA_BYTES);
	211	first_run = FALSE;
	212	}
	213
	214	memset(&buf, 0x00, CHUNK_SIZE);
	215
	216	/* Get data from EP2 using an interrupt transfer. */
	217	ret = libusb_interrupt_transfer(
	218	devc->usb->devhdl, /* libusb device handle */
	219	LIBUSB_ENDPOINT_IN \| 2, /* EP2, IN */
	220	(unsigned char )&buf, / receive buffer */
	221	CHUNK_SIZE, /* wLength */
	222	&len, /* actually received byte count */
	223	1000 /* timeout (ms) */);
	224
	225	if (ret < 0) {
d4928d71	226	sr_err("USB receive error: %s.", libusb_error_name(ret));
79081ec8 UH	227	return FALSE;
	228	}
	229
	230	if (len != CHUNK_SIZE) {
	231	sr_err("Short packet: received %d/%d bytes.", len, CHUNK_SIZE);
	232	/* TODO: Print the bytes? */
	233	return FALSE;
	234	}
	235
	236	log_8byte_chunk((const uint8_t *)&buf);
	237
	238	if (buf[0] != 0xf0) {
	239	/* First time: Synchronize to the start of a packet. */
	240	if (!synced_on_first_packet) {
c8852687 UH	241	if (!udmms[dmm].packet_valid(buf))
c8852687 UH	242	return TRUE;
79081ec8 UH	243	synced_on_first_packet = TRUE;
	244	sr_spew("Successfully synchronized on first packet.");
	245	}
	246
	247	num_databytes_in_chunk = buf[0] & 0x0f;
	248	for (i = 0; i < num_databytes_in_chunk; i++)
	249	pbuf[data_byte_counter++] = buf[1 + i];
	250
	251	/* TODO: Handle > 14 bytes in pbuf? Can this happen? */
	252	if (data_byte_counter == NUM_DATA_BYTES) {
	253	log_dmm_packet(pbuf);
	254	data_byte_counter = 0;
c8852687 UH	255
	256	if (!udmms[dmm].packet_valid(pbuf)) {
	257	sr_err("Invalid packet.");
	258	return TRUE;
8c1adf37	259	}
c8852687 UH	260
	261	decode_packet(sdi, dmm, pbuf, info);
	262
79081ec8 UH	263	memset(pbuf, 0x00, NUM_DATA_BYTES);
	264	}
	265	}
	266
	267	/* Abort acquisition if we acquired enough samples. */
35e199da	268	if (devc->limit_samples && devc->num_samples >= devc->limit_samples) {
79081ec8 UH	269	sr_info("Requested number of samples reached.");
	270	sdi->driver->dev_acquisition_stop(sdi, cb_data);
	271	}
	272
	273	return TRUE;
	274	}
fdbcb86d	275
c8852687 UH	276	#define RECEIVE_DATA(ID_UPPER, DMM_DRIVER) \
	277	SR_PRIV int receive_data_##ID_UPPER(int fd, int revents, void *cb_data) { \
	278	struct DMM_DRIVER##_info info; \
	279	return receive_data(fd, revents, ID_UPPER, &info, cb_data); }
fdbcb86d	280
c8852687 UH	281	/* Driver-specific receive_data() wrappers */
	282	RECEIVE_DATA(UNI_T_UT61D, fs9922)
	283	RECEIVE_DATA(VOLTCRAFT_VC820, fs9721)