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

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