[libsigrok.git] / src / scpi / scpi_serial.c

/*
 * This file is part of the libsigrok project.
 *
 * Copyright (C) 2013 poljar (Damir Jelić) <poljarinho@gmail.com>
 * Copyright (C) 2013 Martin Ling <martin-sigrok@earth.li>
 *
 * 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 3 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, see <http://www.gnu.org/licenses/>.
 */

#include <config.h>
#include <glib.h>
#include <stdlib.h>
#include <string.h>
#include <libsigrok/libsigrok.h>
#include "libsigrok-internal.h"
#include "scpi.h"

#define LOG_PREFIX "scpi_serial"

#ifdef HAVE_SERIAL_COMM

struct scpi_serial {
	struct sr_serial_dev_inst *serial;
	gboolean got_newline;
};

/* Default serial port options for some known USB devices */
static const struct {
	uint16_t vendor_id;
	uint16_t product_id;
	const char *serialcomm;
} scpi_serial_usb_ids[] = {
	{ 0x0403, 0xed72, "115200/8n1/flow=1" }, /* Hameg HO720 */
	{ 0x0403, 0xed73, "115200/8n1/flow=1" }, /* Hameg HO730 */
	{ 0x0aad, 0x0117, "115200/8n1" },        /* R&S HMO series, previously branded as Hameg HMO */
	{ 0x0aad, 0x0118, "115200/8n1" },        /* R&S HMO series, previously branded as Hameg HMO */
	{ 0x0aad, 0x0119, "115200/8n1" },        /* R&S HMO series, previously branded as Hameg HMO */
	{ 0x0aad, 0x0135, "115200/8n1" },        /* R&S HMC series, previously branded as Hameg HMC */
	{ 0x2184, 0x0030, "115200/8n1" },        /* GW-Instek GDM-8341 (VCP, SiLabs CP210x) */
	{ 0x2184, 0x0058, "115200/8n1" },        /* GW-Instek GDM-9061 (USBCDC mode) */
};

static GSList *scpi_serial_scan(struct drv_context *drvc)
{
	GSList *l, *r, *resources = NULL;
	gchar *res;
	unsigned i;

	(void)drvc;

	for (i = 0; i < ARRAY_SIZE(scpi_serial_usb_ids); i++) {
		if (!(l = sr_serial_find_usb(scpi_serial_usb_ids[i].vendor_id,
					scpi_serial_usb_ids[i].product_id)))
			continue;
		for (r = l; r; r = r->next) {
			if (scpi_serial_usb_ids[i].serialcomm)
				res = g_strdup_printf("%s:%s", (char *) r->data,
				                      scpi_serial_usb_ids[i].serialcomm);
			else
				res = g_strdup(r->data);
			resources = g_slist_append(resources, res);
		}
		g_slist_free_full(l, g_free);
	}

	return resources;
}

static int scpi_serial_dev_inst_new(void *priv, struct drv_context *drvc,
		const char *resource, char **params, const char *serialcomm)
{
	GSList *l, *r;
	unsigned i;
	struct scpi_serial *sscpi = priv;

	(void)drvc;
	(void)params;

	/* If no serial port option is specified on the command-line using the
	 * "serialcomm" driver option, but the device is connected through USB
	 * and it requires a known default serial port option, then used it in
	 * order to avoid data corruption or even worse problems.
	 */
	if (!serialcomm) {
		for (i = 0; i < ARRAY_SIZE(scpi_serial_usb_ids); i++) {
			if (!(l = sr_serial_find_usb(scpi_serial_usb_ids[i].vendor_id,
						scpi_serial_usb_ids[i].product_id)))
				continue;
			for (r = l; r; r = r->next)
				if (!strcmp(resource, r->data) && scpi_serial_usb_ids[i].serialcomm)
					serialcomm = scpi_serial_usb_ids[i].serialcomm;
			g_slist_free_full(l, g_free);
		}
	}

	sscpi->serial = sr_serial_dev_inst_new(resource, serialcomm);

	return SR_OK;
}

static int scpi_serial_open(struct sr_scpi_dev_inst *scpi)
{
	struct scpi_serial *sscpi = scpi->priv;
	struct sr_serial_dev_inst *serial = sscpi->serial;

	if (serial_open(serial, SERIAL_RDWR) != SR_OK)
		return SR_ERR;

	sscpi->got_newline = FALSE;

	return SR_OK;
}

static int scpi_serial_connection_id(struct sr_scpi_dev_inst *scpi,
		char **connection_id)
{
	struct scpi_serial *sscpi = scpi->priv;
	struct sr_serial_dev_inst *serial = sscpi->serial;

	*connection_id = g_strdup(serial->port);

	return SR_OK;
}

static int scpi_serial_source_add(struct sr_session *session, void *priv,
		int events, int timeout, sr_receive_data_callback cb, void *cb_data)
{
	struct scpi_serial *sscpi = priv;
	struct sr_serial_dev_inst *serial = sscpi->serial;

	return serial_source_add(session, serial, events, timeout, cb, cb_data);
}

static int scpi_serial_source_remove(struct sr_session *session, void *priv)
{
	struct scpi_serial *sscpi = priv;
	struct sr_serial_dev_inst *serial = sscpi->serial;

	return serial_source_remove(session, serial);
}

static int scpi_serial_send(void *priv, const char *command)
{
	int result;
	struct scpi_serial *sscpi = priv;
	struct sr_serial_dev_inst *serial = sscpi->serial;

	result = serial_write_blocking(serial, command, strlen(command), 0);
	if (result < 0) {
		sr_err("Error while sending SCPI command '%s': %d.",
			command, result);
		return SR_ERR;
	}

	sr_spew("Successfully sent SCPI command: '%s'.", command);

	return SR_OK;
}

static int scpi_serial_read_begin(void *priv)
{
	struct scpi_serial *sscpi = priv;
	sscpi->got_newline = FALSE;

	return SR_OK;
}

static int scpi_serial_read_data(void *priv, char *buf, int maxlen)
{
	struct scpi_serial *sscpi = priv;
	int ret;

	/* Try to read new data into the buffer. */
	ret = serial_read_nonblocking(sscpi->serial, buf, maxlen);
	if (ret < 0)
		return ret;

	/*
	 * Check for line termination at the end of the receive data.
	 * Handle the usual case of NL, as well as the unusual NL+CR
	 * combination (some GWInstek DMMs were found to do this).
	 */
	sscpi->got_newline = FALSE;
	if (ret >= 1 && buf[ret - 1] == '\n') {
		sscpi->got_newline = TRUE;
		sr_spew("Received NL terminator");
	} else if (ret >= 2 && buf[ret - 2] == '\n' && buf[ret - 1] == '\r') {
		ret--;
		sscpi->got_newline = TRUE;
		sr_spew("Received NL+CR terminator");
	}

	return ret;
}

static int scpi_serial_read_complete(void *priv)
{
	struct scpi_serial *sscpi = priv;

	return sscpi->got_newline;
}

static int scpi_serial_close(struct sr_scpi_dev_inst *scpi)
{
	struct scpi_serial *sscpi = scpi->priv;

	return serial_close(sscpi->serial);
}

static void scpi_serial_free(void *priv)
{
	struct scpi_serial *sscpi = priv;

	sr_serial_dev_inst_free(sscpi->serial);
}

SR_PRIV const struct sr_scpi_dev_inst scpi_serial_dev = {
	.name          = "serial",
	.prefix        = "",
	.transport     = SCPI_TRANSPORT_SERIAL,
	.priv_size     = sizeof(struct scpi_serial),
	.scan          = scpi_serial_scan,
	.dev_inst_new  = scpi_serial_dev_inst_new,
	.open          = scpi_serial_open,
	.connection_id = scpi_serial_connection_id,
	.source_add    = scpi_serial_source_add,
	.source_remove = scpi_serial_source_remove,
	.send          = scpi_serial_send,
	.read_begin    = scpi_serial_read_begin,
	.read_data     = scpi_serial_read_data,
	.read_complete = scpi_serial_read_complete,
	.close         = scpi_serial_close,
	.free          = scpi_serial_free,
};

#endif
Commit	Line	Data
23f43dff ML	1	/*
	2	* This file is part of the libsigrok project.
	3	*
	4	* Copyright (C) 2013 poljar (Damir Jelić) <poljarinho@gmail.com>
	5	* Copyright (C) 2013 Martin Ling <martin-sigrok@earth.li>
	6	*
	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.
	11	*
	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.
	16	*
	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/>.
	19	*/
	20
6ec6c43b	21	#include <config.h>
23f43dff	22	#include <glib.h>
b541f837	23	#include <stdlib.h>
23f43dff	24	#include <string.h>
c1aae900	25	#include <libsigrok/libsigrok.h>
515ab088	26	#include "libsigrok-internal.h"
5a1afc09	27	#include "scpi.h"
23f43dff	28
3544f848	29	#define LOG_PREFIX "scpi_serial"
23f43dff	30
48b7c346 GS	31	#ifdef HAVE_SERIAL_COMM
48b7c346 GS	32
05c644ea ML	33	struct scpi_serial {
05c644ea ML	34	struct sr_serial_dev_inst *serial;
35bb2fce	35	gboolean got_newline;
05c644ea ML	36	};
05c644ea ML	37
33084500	38	/* Default serial port options for some known USB devices */
329733d9	39	static const struct {
b541f837 AJ	40	uint16_t vendor_id;
	41	uint16_t product_id;
	42	const char *serialcomm;
	43	} scpi_serial_usb_ids[] = {
	44	{ 0x0403, 0xed72, "115200/8n1/flow=1" }, /* Hameg HO720 */
	45	{ 0x0403, 0xed73, "115200/8n1/flow=1" }, /* Hameg HO730 */
33084500 GT	46	{ 0x0aad, 0x0117, "115200/8n1" }, /* R&S HMO series, previously branded as Hameg HMO */
	47	{ 0x0aad, 0x0118, "115200/8n1" }, /* R&S HMO series, previously branded as Hameg HMO */
	48	{ 0x0aad, 0x0119, "115200/8n1" }, /* R&S HMO series, previously branded as Hameg HMO */
f1b22e56	49	{ 0x0aad, 0x0135, "115200/8n1" }, /* R&S HMC series, previously branded as Hameg HMC */
f91c6940	50	{ 0x2184, 0x0030, "115200/8n1" }, /* GW-Instek GDM-8341 (VCP, SiLabs CP210x) */
4e5ff004	51	{ 0x2184, 0x0058, "115200/8n1" }, /* GW-Instek GDM-9061 (USBCDC mode) */
b541f837 AJ	52	};
	53
	54	static GSList scpi_serial_scan(struct drv_context drvc)
	55	{
	56	GSList l, r, *resources = NULL;
	57	gchar *res;
	58	unsigned i;
	59
	60	(void)drvc;
	61
	62	for (i = 0; i < ARRAY_SIZE(scpi_serial_usb_ids); i++) {
98fec29e UH	63	if (!(l = sr_serial_find_usb(scpi_serial_usb_ids[i].vendor_id,
98fec29e UH	64	scpi_serial_usb_ids[i].product_id)))
b541f837 AJ	65	continue;
	66	for (r = l; r; r = r->next) {
	67	if (scpi_serial_usb_ids[i].serialcomm)
	68	res = g_strdup_printf("%s:%s", (char *) r->data,
	69	scpi_serial_usb_ids[i].serialcomm);
	70	else
	71	res = g_strdup(r->data);
	72	resources = g_slist_append(resources, res);
	73	}
	74	g_slist_free_full(l, g_free);
	75	}
	76
	77	return resources;
	78	}
	79
17bdda58 AJ	80	static int scpi_serial_dev_inst_new(void priv, struct drv_context drvc,
17bdda58 AJ	81	const char resource, char params, const char serialcomm)
f754c146	82	{
232eb33c GT	83	GSList l, r;
232eb33c GT	84	unsigned i;
f754c146 AJ	85	struct scpi_serial *sscpi = priv;
f754c146 AJ	86
17bdda58	87	(void)drvc;
f754c146 AJ	88	(void)params;
f754c146 AJ	89
232eb33c GT	90	/* If no serial port option is specified on the command-line using the
	91	* "serialcomm" driver option, but the device is connected through USB
	92	* and it requires a known default serial port option, then used it in
	93	* order to avoid data corruption or even worse problems.
	94	*/
	95	if (!serialcomm) {
	96	for (i = 0; i < ARRAY_SIZE(scpi_serial_usb_ids); i++) {
	97	if (!(l = sr_serial_find_usb(scpi_serial_usb_ids[i].vendor_id,
	98	scpi_serial_usb_ids[i].product_id)))
	99	continue;
	100	for (r = l; r; r = r->next)
	101	if (!strcmp(resource, r->data) && scpi_serial_usb_ids[i].serialcomm)
	102	serialcomm = scpi_serial_usb_ids[i].serialcomm;
	103	g_slist_free_full(l, g_free);
	104	}
	105	}
	106
91219afc	107	sscpi->serial = sr_serial_dev_inst_new(resource, serialcomm);
f754c146 AJ	108
	109	return SR_OK;
	110	}
	111
04229f7b	112	static int scpi_serial_open(struct sr_scpi_dev_inst *scpi)
23f43dff	113	{
04229f7b	114	struct scpi_serial *sscpi = scpi->priv;
05c644ea	115	struct sr_serial_dev_inst *serial = sscpi->serial;
23f43dff	116
406e0c79	117	if (serial_open(serial, SERIAL_RDWR) != SR_OK)
9dfeb81b ML	118	return SR_ERR;
9dfeb81b ML	119
35bb2fce	120	sscpi->got_newline = FALSE;
8943049c	121
9dfeb81b	122	return SR_OK;
23f43dff ML	123	}
23f43dff ML	124
8107a9a6 FS	125	static int scpi_serial_connection_id(struct sr_scpi_dev_inst *scpi,
	126	char **connection_id)
	127	{
	128	struct scpi_serial *sscpi = scpi->priv;
	129	struct sr_serial_dev_inst *serial = sscpi->serial;
	130
	131	*connection_id = g_strdup(serial->port);
	132
	133	return SR_OK;
	134	}
	135
102f1239 BV	136	static int scpi_serial_source_add(struct sr_session session, void priv,
102f1239 BV	137	int events, int timeout, sr_receive_data_callback cb, void *cb_data)
23f43dff	138	{
05c644ea ML	139	struct scpi_serial *sscpi = priv;
05c644ea ML	140	struct sr_serial_dev_inst *serial = sscpi->serial;
23f43dff	141
102f1239	142	return serial_source_add(session, serial, events, timeout, cb, cb_data);
23f43dff ML	143	}
23f43dff ML	144
102f1239	145	static int scpi_serial_source_remove(struct sr_session session, void priv)
23f43dff	146	{
05c644ea ML	147	struct scpi_serial *sscpi = priv;
05c644ea ML	148	struct sr_serial_dev_inst *serial = sscpi->serial;
23f43dff	149
102f1239	150	return serial_source_remove(session, serial);
23f43dff ML	151	}
23f43dff ML	152
d87c1766	153	static int scpi_serial_send(void priv, const char command)
23f43dff	154	{
379e95c5	155	int result;
05c644ea ML	156	struct scpi_serial *sscpi = priv;
05c644ea ML	157	struct sr_serial_dev_inst *serial = sscpi->serial;
23f43dff	158
379e95c5 UH	159	result = serial_write_blocking(serial, command, strlen(command), 0);
379e95c5 UH	160	if (result < 0) {
0c8aedb5 UH	161	sr_err("Error while sending SCPI command '%s': %d.",
0c8aedb5 UH	162	command, result);
379e95c5	163	return SR_ERR;
23f43dff ML	164	}
	165
	166	sr_spew("Successfully sent SCPI command: '%s'.", command);
	167
	168	return SR_OK;
	169	}
	170
d87c1766	171	static int scpi_serial_read_begin(void *priv)
05c644ea	172	{
9ea4018f	173	struct scpi_serial *sscpi = priv;
35bb2fce	174	sscpi->got_newline = FALSE;
05c644ea ML	175
	176	return SR_OK;
	177	}
	178
d87c1766	179	static int scpi_serial_read_data(void priv, char buf, int maxlen)
bc03a7cc	180	{
05c644ea	181	struct scpi_serial *sscpi = priv;
9ea4018f	182	int ret;
8943049c	183
9ea4018f SB	184	/* Try to read new data into the buffer. */
9ea4018f SB	185	ret = serial_read_nonblocking(sscpi->serial, buf, maxlen);
9ea4018f SB	186	if (ret < 0)
9ea4018f SB	187	return ret;
05c644ea	188
6dc0007c GS	189	/*
	190	* Check for line termination at the end of the receive data.
	191	* Handle the usual case of NL, as well as the unusual NL+CR
	192	* combination (some GWInstek DMMs were found to do this).
	193	*/
	194	sscpi->got_newline = FALSE;
	195	if (ret >= 1 && buf[ret - 1] == '\n') {
	196	sscpi->got_newline = TRUE;
	197	sr_spew("Received NL terminator");
	198	} else if (ret >= 2 && buf[ret - 2] == '\n' && buf[ret - 1] == '\r') {
	199	ret--;
	200	sscpi->got_newline = TRUE;
	201	sr_spew("Received NL+CR terminator");
8943049c ML	202	}
8943049c ML	203
9ea4018f	204	return ret;
bc03a7cc	205	}
05c644ea	206
d87c1766	207	static int scpi_serial_read_complete(void *priv)
05c644ea ML	208	{
	209	struct scpi_serial *sscpi = priv;
	210
9ea4018f	211	return sscpi->got_newline;
05c644ea ML	212	}
05c644ea ML	213
04229f7b	214	static int scpi_serial_close(struct sr_scpi_dev_inst *scpi)
bc03a7cc	215	{
04229f7b	216	struct scpi_serial *sscpi = scpi->priv;
05c644ea	217
f754c146	218	return serial_close(sscpi->serial);
bc03a7cc	219	}
05c644ea	220
bc03a7cc BV	221	static void scpi_serial_free(void *priv)
bc03a7cc BV	222	{
05c644ea	223	struct scpi_serial *sscpi = priv;
05c644ea	224
f754c146	225	sr_serial_dev_inst_free(sscpi->serial);
bc03a7cc BV	226	}
bc03a7cc BV	227
f754c146 AJ	228	SR_PRIV const struct sr_scpi_dev_inst scpi_serial_dev = {
	229	.name = "serial",
	230	.prefix = "",
87aa1e63	231	.transport = SCPI_TRANSPORT_SERIAL,
f754c146	232	.priv_size = sizeof(struct scpi_serial),
b541f837	233	.scan = scpi_serial_scan,
f754c146 AJ	234	.dev_inst_new = scpi_serial_dev_inst_new,
f754c146 AJ	235	.open = scpi_serial_open,
8107a9a6	236	.connection_id = scpi_serial_connection_id,
f754c146 AJ	237	.source_add = scpi_serial_source_add,
	238	.source_remove = scpi_serial_source_remove,
	239	.send = scpi_serial_send,
	240	.read_begin = scpi_serial_read_begin,
	241	.read_data = scpi_serial_read_data,
	242	.read_complete = scpi_serial_read_complete,
	243	.close = scpi_serial_close,
	244	.free = scpi_serial_free,
	245	};
48b7c346 GS	246
48b7c346 GS	247	#endif