[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 */
	{ 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;

	if (ret > 0) {
		if (buf[ret - 1] == '\n') {
			sscpi->got_newline = TRUE;
			sr_spew("Received NL terminator");
		} else if (ret > 1 &&
			   buf[ret - 2] == '\n' && buf[ret - 1] == '\r') {
			sscpi->got_newline = TRUE;
			sr_spew("Received NL+CR terminator");
			ret--;
		} else {
			sscpi->got_newline = FALSE;
		}
	}

	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
	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
	21	#include <config.h>
	22	#include <glib.h>
	23	#include <stdlib.h>
	24	#include <string.h>
	25	#include <libsigrok/libsigrok.h>
	26	#include "libsigrok-internal.h"
	27	#include "scpi.h"
	28
	29	#define LOG_PREFIX "scpi_serial"
	30
	31	#ifdef HAVE_SERIAL_COMM
	32
	33	struct scpi_serial {
	34	struct sr_serial_dev_inst *serial;
	35	gboolean got_newline;
	36	};
	37
	38	/* Default serial port options for some known USB devices */
	39	static const struct {
	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 */
	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 */
	49	{ 0x2184, 0x0058, "115200/8n1" }, /* GW-Instek GDM-9061 (USBCDC mode) */
	50	};
	51
	52	static GSList scpi_serial_scan(struct drv_context drvc)
	53	{
	54	GSList l, r, *resources = NULL;
	55	gchar *res;
	56	unsigned i;
	57
	58	(void)drvc;
	59
	60	for (i = 0; i < ARRAY_SIZE(scpi_serial_usb_ids); i++) {
	61	if (!(l = sr_serial_find_usb(scpi_serial_usb_ids[i].vendor_id,
	62	scpi_serial_usb_ids[i].product_id)))
	63	continue;
	64	for (r = l; r; r = r->next) {
	65	if (scpi_serial_usb_ids[i].serialcomm)
	66	res = g_strdup_printf("%s:%s", (char *) r->data,
	67	scpi_serial_usb_ids[i].serialcomm);
	68	else
	69	res = g_strdup(r->data);
	70	resources = g_slist_append(resources, res);
	71	}
	72	g_slist_free_full(l, g_free);
	73	}
	74
	75	return resources;
	76	}
	77
	78	static int scpi_serial_dev_inst_new(void priv, struct drv_context drvc,
	79	const char resource, char params, const char serialcomm)
	80	{
	81	GSList l, r;
	82	unsigned i;
	83	struct scpi_serial *sscpi = priv;
	84
	85	(void)drvc;
	86	(void)params;
	87
	88	/* If no serial port option is specified on the command-line using the
	89	* "serialcomm" driver option, but the device is connected through USB
	90	* and it requires a known default serial port option, then used it in
	91	* order to avoid data corruption or even worse problems.
	92	*/
	93	if (!serialcomm) {
	94	for (i = 0; i < ARRAY_SIZE(scpi_serial_usb_ids); i++) {
	95	if (!(l = sr_serial_find_usb(scpi_serial_usb_ids[i].vendor_id,
	96	scpi_serial_usb_ids[i].product_id)))
	97	continue;
	98	for (r = l; r; r = r->next)
	99	if (!strcmp(resource, r->data) && scpi_serial_usb_ids[i].serialcomm)
	100	serialcomm = scpi_serial_usb_ids[i].serialcomm;
	101	g_slist_free_full(l, g_free);
	102	}
	103	}
	104
	105	sscpi->serial = sr_serial_dev_inst_new(resource, serialcomm);
	106
	107	return SR_OK;
	108	}
	109
	110	static int scpi_serial_open(struct sr_scpi_dev_inst *scpi)
	111	{
	112	struct scpi_serial *sscpi = scpi->priv;
	113	struct sr_serial_dev_inst *serial = sscpi->serial;
	114
	115	if (serial_open(serial, SERIAL_RDWR) != SR_OK)
	116	return SR_ERR;
	117
	118	sscpi->got_newline = FALSE;
	119
	120	return SR_OK;
	121	}
	122
	123	static int scpi_serial_connection_id(struct sr_scpi_dev_inst *scpi,
	124	char **connection_id)
	125	{
	126	struct scpi_serial *sscpi = scpi->priv;
	127	struct sr_serial_dev_inst *serial = sscpi->serial;
	128
	129	*connection_id = g_strdup(serial->port);
	130
	131	return SR_OK;
	132	}
	133
	134	static int scpi_serial_source_add(struct sr_session session, void priv,
	135	int events, int timeout, sr_receive_data_callback cb, void *cb_data)
	136	{
	137	struct scpi_serial *sscpi = priv;
	138	struct sr_serial_dev_inst *serial = sscpi->serial;
	139
	140	return serial_source_add(session, serial, events, timeout, cb, cb_data);
	141	}
	142
	143	static int scpi_serial_source_remove(struct sr_session session, void priv)
	144	{
	145	struct scpi_serial *sscpi = priv;
	146	struct sr_serial_dev_inst *serial = sscpi->serial;
	147
	148	return serial_source_remove(session, serial);
	149	}
	150
	151	static int scpi_serial_send(void priv, const char command)
	152	{
	153	int result;
	154	struct scpi_serial *sscpi = priv;
	155	struct sr_serial_dev_inst *serial = sscpi->serial;
	156
	157	result = serial_write_blocking(serial, command, strlen(command), 0);
	158	if (result < 0) {
	159	sr_err("Error while sending SCPI command '%s': %d.",
	160	command, result);
	161	return SR_ERR;
	162	}
	163
	164	sr_spew("Successfully sent SCPI command: '%s'.", command);
	165
	166	return SR_OK;
	167	}
	168
	169	static int scpi_serial_read_begin(void *priv)
	170	{
	171	struct scpi_serial *sscpi = priv;
	172	sscpi->got_newline = FALSE;
	173
	174	return SR_OK;
	175	}
	176
	177	static int scpi_serial_read_data(void priv, char buf, int maxlen)
	178	{
	179	struct scpi_serial *sscpi = priv;
	180	int ret;
	181
	182	/* Try to read new data into the buffer. */
	183	ret = serial_read_nonblocking(sscpi->serial, buf, maxlen);
	184
	185	if (ret < 0)
	186	return ret;
	187
	188	if (ret > 0) {
	189	if (buf[ret - 1] == '\n') {
	190	sscpi->got_newline = TRUE;
	191	sr_spew("Received NL terminator");
	192	} else if (ret > 1 &&
	193	buf[ret - 2] == '\n' && buf[ret - 1] == '\r') {
	194	sscpi->got_newline = TRUE;
	195	sr_spew("Received NL+CR terminator");
	196	ret--;
	197	} else {
	198	sscpi->got_newline = FALSE;
	199	}
	200	}
	201
	202	return ret;
	203	}
	204
	205	static int scpi_serial_read_complete(void *priv)
	206	{
	207	struct scpi_serial *sscpi = priv;
	208
	209	return sscpi->got_newline;
	210	}
	211
	212	static int scpi_serial_close(struct sr_scpi_dev_inst *scpi)
	213	{
	214	struct scpi_serial *sscpi = scpi->priv;
	215
	216	return serial_close(sscpi->serial);
	217	}
	218
	219	static void scpi_serial_free(void *priv)
	220	{
	221	struct scpi_serial *sscpi = priv;
	222
	223	sr_serial_dev_inst_free(sscpi->serial);
	224	}
	225
	226	SR_PRIV const struct sr_scpi_dev_inst scpi_serial_dev = {
	227	.name = "serial",
	228	.prefix = "",
	229	.transport = SCPI_TRANSPORT_SERIAL,
	230	.priv_size = sizeof(struct scpi_serial),
	231	.scan = scpi_serial_scan,
	232	.dev_inst_new = scpi_serial_dev_inst_new,
	233	.open = scpi_serial_open,
	234	.connection_id = scpi_serial_connection_id,
	235	.source_add = scpi_serial_source_add,
	236	.source_remove = scpi_serial_source_remove,
	237	.send = scpi_serial_send,
	238	.read_begin = scpi_serial_read_begin,
	239	.read_data = scpi_serial_read_data,
	240	.read_complete = scpi_serial_read_complete,
	241	.close = scpi_serial_close,
	242	.free = scpi_serial_free,
	243	};
	244
	245	#endif