[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"

#define BUFFER_SIZE 1024

struct scpi_serial {
	struct sr_serial_dev_inst *serial;
	char buffer[BUFFER_SIZE];
	size_t count;
	size_t read;
};

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

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)
{
	struct scpi_serial *sscpi = priv;

	(void)drvc;
	(void)params;

	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;

	if (serial_flush(serial) != SR_OK)
		return SR_ERR;

	sscpi->count = 0;
	sscpi->read = 0;

	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 len, result, written;
	gchar *terminated_command;
	struct scpi_serial *sscpi = priv;
	struct sr_serial_dev_inst *serial = sscpi->serial;

	terminated_command = g_strconcat(command, "\n", NULL);
	len = strlen(terminated_command);
	written = 0;
	while (written < len) {
		result = serial_write_nonblocking(serial,
				terminated_command + written, len - written);
		if (result < 0) {
			sr_err("Error while sending SCPI command: '%s'.", command);
			g_free(terminated_command);
			return SR_ERR;
		}
		written += result;
	}

	g_free(terminated_command);

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

	return SR_OK;
}

static int scpi_serial_read_begin(void *priv)
{
	(void) priv;

	return SR_OK;
}

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

	len = BUFFER_SIZE - sscpi->count;

	/* Try to read new data into the buffer if there is space. */
	if (len > 0) {
		ret = serial_read_nonblocking(sscpi->serial, sscpi->buffer + sscpi->count,
				BUFFER_SIZE - sscpi->count);

		if (ret < 0)
			return ret;

		sscpi->count += ret;

		if (ret > 0)
			sr_spew("Read %d bytes into buffer.", ret);
	}

	/* Return as many bytes as possible from buffer, excluding any trailing newline. */
	if (sscpi->read < sscpi->count) {
		len = sscpi->count - sscpi->read;
		if (len > maxlen)
			len = maxlen;
		if (sscpi->buffer[sscpi->read + len - 1] == '\n')
			len--;
		sr_spew("Returning %d bytes from buffer.", len);
		memcpy(buf, sscpi->buffer + sscpi->read, len);
		sscpi->read += len;
		if (sscpi->read == BUFFER_SIZE) {
			sr_spew("Resetting buffer.");
			sscpi->count = 0;
			sscpi->read = 0;
		}
		return len;
	}

	return 0;
}

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

	/* If the next character is a newline, discard it and report complete. */
	if (sscpi->read < sscpi->count && sscpi->buffer[sscpi->read] == '\n') {
		sscpi->read++;
		return 1;
	} else {
		return 0;
	}
}

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        = "",
	.priv_size     = sizeof(struct scpi_serial),
	.scan          = scpi_serial_scan,
	.dev_inst_new  = scpi_serial_dev_inst_new,
	.open          = scpi_serial_open,
	.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,
};
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	#define BUFFER_SIZE 1024
	32
	33	struct scpi_serial {
	34	struct sr_serial_dev_inst *serial;
	35	char buffer[BUFFER_SIZE];
	36	size_t count;
	37	size_t read;
	38	};
	39
	40	static const struct {
	41	uint16_t vendor_id;
	42	uint16_t product_id;
	43	const char *serialcomm;
	44	} scpi_serial_usb_ids[] = {
	45	{ 0x0403, 0xed72, "115200/8n1/flow=1" }, /* Hameg HO720 */
	46	{ 0x0403, 0xed73, "115200/8n1/flow=1" }, /* Hameg HO730 */
	47	};
	48
	49	static GSList scpi_serial_scan(struct drv_context drvc)
	50	{
	51	GSList l, r, *resources = NULL;
	52	gchar *res;
	53	unsigned i;
	54
	55	(void)drvc;
	56
	57	for (i = 0; i < ARRAY_SIZE(scpi_serial_usb_ids); i++) {
	58	if (!(l = sr_serial_find_usb(scpi_serial_usb_ids[i].vendor_id,
	59	scpi_serial_usb_ids[i].product_id)))
	60	continue;
	61	for (r = l; r; r = r->next) {
	62	if (scpi_serial_usb_ids[i].serialcomm)
	63	res = g_strdup_printf("%s:%s", (char *) r->data,
	64	scpi_serial_usb_ids[i].serialcomm);
	65	else
	66	res = g_strdup(r->data);
	67	resources = g_slist_append(resources, res);
	68	}
	69	g_slist_free_full(l, g_free);
	70	}
	71
	72	return resources;
	73	}
	74
	75	static int scpi_serial_dev_inst_new(void priv, struct drv_context drvc,
	76	const char resource, char params, const char serialcomm)
	77	{
	78	struct scpi_serial *sscpi = priv;
	79
	80	(void)drvc;
	81	(void)params;
	82
	83	sscpi->serial = sr_serial_dev_inst_new(resource, serialcomm);
	84
	85	return SR_OK;
	86	}
	87
	88	static int scpi_serial_open(struct sr_scpi_dev_inst *scpi)
	89	{
	90	struct scpi_serial *sscpi = scpi->priv;
	91	struct sr_serial_dev_inst *serial = sscpi->serial;
	92
	93	if (serial_open(serial, SERIAL_RDWR) != SR_OK)
	94	return SR_ERR;
	95
	96	if (serial_flush(serial) != SR_OK)
	97	return SR_ERR;
	98
	99	sscpi->count = 0;
	100	sscpi->read = 0;
	101
	102	return SR_OK;
	103	}
	104
	105	static int scpi_serial_source_add(struct sr_session session, void priv,
	106	int events, int timeout, sr_receive_data_callback cb, void *cb_data)
	107	{
	108	struct scpi_serial *sscpi = priv;
	109	struct sr_serial_dev_inst *serial = sscpi->serial;
	110
	111	return serial_source_add(session, serial, events, timeout, cb, cb_data);
	112	}
	113
	114	static int scpi_serial_source_remove(struct sr_session session, void priv)
	115	{
	116	struct scpi_serial *sscpi = priv;
	117	struct sr_serial_dev_inst *serial = sscpi->serial;
	118
	119	return serial_source_remove(session, serial);
	120	}
	121
	122	static int scpi_serial_send(void priv, const char command)
	123	{
	124	int len, result, written;
	125	gchar *terminated_command;
	126	struct scpi_serial *sscpi = priv;
	127	struct sr_serial_dev_inst *serial = sscpi->serial;
	128
	129	terminated_command = g_strconcat(command, "\n", NULL);
	130	len = strlen(terminated_command);
	131	written = 0;
	132	while (written < len) {
	133	result = serial_write_nonblocking(serial,
	134	terminated_command + written, len - written);
	135	if (result < 0) {
	136	sr_err("Error while sending SCPI command: '%s'.", command);
	137	g_free(terminated_command);
	138	return SR_ERR;
	139	}
	140	written += result;
	141	}
	142
	143	g_free(terminated_command);
	144
	145	sr_spew("Successfully sent SCPI command: '%s'.", command);
	146
	147	return SR_OK;
	148	}
	149
	150	static int scpi_serial_read_begin(void *priv)
	151	{
	152	(void) priv;
	153
	154	return SR_OK;
	155	}
	156
	157	static int scpi_serial_read_data(void priv, char buf, int maxlen)
	158	{
	159	struct scpi_serial *sscpi = priv;
	160	int len, ret;
	161
	162	len = BUFFER_SIZE - sscpi->count;
	163
	164	/* Try to read new data into the buffer if there is space. */
	165	if (len > 0) {
	166	ret = serial_read_nonblocking(sscpi->serial, sscpi->buffer + sscpi->count,
	167	BUFFER_SIZE - sscpi->count);
	168
	169	if (ret < 0)
	170	return ret;
	171
	172	sscpi->count += ret;
	173
	174	if (ret > 0)
	175	sr_spew("Read %d bytes into buffer.", ret);
	176	}
	177
	178	/* Return as many bytes as possible from buffer, excluding any trailing newline. */
	179	if (sscpi->read < sscpi->count) {
	180	len = sscpi->count - sscpi->read;
	181	if (len > maxlen)
	182	len = maxlen;
	183	if (sscpi->buffer[sscpi->read + len - 1] == '\n')
	184	len--;
	185	sr_spew("Returning %d bytes from buffer.", len);
	186	memcpy(buf, sscpi->buffer + sscpi->read, len);
	187	sscpi->read += len;
	188	if (sscpi->read == BUFFER_SIZE) {
	189	sr_spew("Resetting buffer.");
	190	sscpi->count = 0;
	191	sscpi->read = 0;
	192	}
	193	return len;
	194	}
	195
	196	return 0;
	197	}
	198
	199	static int scpi_serial_read_complete(void *priv)
	200	{
	201	struct scpi_serial *sscpi = priv;
	202
	203	/* If the next character is a newline, discard it and report complete. */
	204	if (sscpi->read < sscpi->count && sscpi->buffer[sscpi->read] == '\n') {
	205	sscpi->read++;
	206	return 1;
	207	} else {
	208	return 0;
	209	}
	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	.priv_size = sizeof(struct scpi_serial),
	230	.scan = scpi_serial_scan,
	231	.dev_inst_new = scpi_serial_dev_inst_new,
	232	.open = scpi_serial_open,
	233	.source_add = scpi_serial_source_add,
	234	.source_remove = scpi_serial_source_remove,
	235	.send = scpi_serial_send,
	236	.read_begin = scpi_serial_read_begin,
	237	.read_data = scpi_serial_read_data,
	238	.read_complete = scpi_serial_read_complete,
	239	.close = scpi_serial_close,
	240	.free = scpi_serial_free,
	241	};