[libsigrok.git] / hardware / common / scpi_tcp.c

/*
 * This file is part of the libsigrok project.
 *
 * 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/>.
 */

#ifdef _WIN32
#define _WIN32_WINNT 0x0501
#include <winsock2.h>
#include <ws2tcpip.h>
#endif

#include "libsigrok.h"
#include "libsigrok-internal.h"

#include <glib.h>
#include <string.h>
#include <unistd.h>
#ifndef _WIN32
#include <sys/socket.h>
#include <netinet/in.h>
#include <arpa/inet.h>
#include <netdb.h>
#endif
#include <errno.h>

#define LOG_PREFIX "scpi_tcp"

#define LENGTH_BYTES 4

struct scpi_tcp {
	char *address;
	char *port;
	int socket;
	char length_buf[LENGTH_BYTES];
	int length_bytes_read;
	int response_length;
	int response_bytes_read;
};

static int scpi_tcp_dev_inst_new(void *priv, const char *resource,
		char **params, const char *serialcomm)
{
	struct scpi_tcp *tcp = priv;

	(void)resource;
	(void)serialcomm;

	if (!params || !params[1] || !params[2]) {
		sr_err("Invalid parameters.");
		return SR_ERR;
	}

	tcp->address = g_strdup(params[1]);
	tcp->port    = g_strdup(params[2]);
	tcp->socket  = -1;

	return SR_OK;
}

static int scpi_tcp_open(void *priv)
{
	struct scpi_tcp *tcp = priv;
	struct addrinfo hints;
	struct addrinfo *results, *res;
	int err;

	memset(&hints, 0, sizeof(hints));
	hints.ai_family = AF_UNSPEC;
	hints.ai_socktype = SOCK_STREAM;
	hints.ai_protocol = IPPROTO_TCP;

	err = getaddrinfo(tcp->address, tcp->port, &hints, &results);

	if (err) {
		sr_err("Address lookup failed: %s:%d: %s", tcp->address, tcp->port,
			gai_strerror(err));
		return SR_ERR;
	}

	for (res = results; res; res = res->ai_next) {
		if ((tcp->socket = socket(res->ai_family, res->ai_socktype,
						res->ai_protocol)) < 0)
			continue;
		if (connect(tcp->socket, res->ai_addr, res->ai_addrlen) != 0) {
			close(tcp->socket);
			tcp->socket = -1;
			continue;
		}
		break;
	}

	freeaddrinfo(results);

	if (tcp->socket < 0) {
		sr_err("Failed to connect to %s:%s: %s", tcp->address, tcp->port,
				strerror(errno));
		return SR_ERR;
	}

	return SR_OK;
}

static int scpi_tcp_source_add(void *priv, int events, int timeout,
			sr_receive_data_callback_t cb, void *cb_data)
{
	struct scpi_tcp *tcp = priv;

	return sr_source_add(tcp->socket, events, timeout, cb, cb_data);
}

static int scpi_tcp_source_remove(void *priv)
{
	struct scpi_tcp *tcp = priv;

	return sr_source_remove(tcp->socket);
}

static int scpi_tcp_send(void *priv, const char *command)
{
	struct scpi_tcp *tcp = priv;
	int len, out;
	char *terminated_command;

	terminated_command = g_strdup_printf("%s\r\n", command);
	len = strlen(terminated_command);
	out = send(tcp->socket, terminated_command, len, 0);
	g_free(terminated_command);

	if (out < 0) {
		sr_err("Send error: %s", strerror(errno));
		return SR_ERR;
	}

	if (out < len) {
		sr_dbg("Only sent %d/%d bytes of SCPI command: '%s'.", out,
		       len, command);
	}

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

	return SR_OK;
}

static int scpi_tcp_read_begin(void *priv)
{
	struct scpi_tcp *tcp = priv;

	tcp->response_bytes_read = 0;
	tcp->length_bytes_read = 0;

	return SR_OK;
}

static int scpi_tcp_raw_read_data(void *priv, char *buf, int maxlen)
{
	struct scpi_tcp *tcp = priv;
	int len;

	len = recv(tcp->socket, buf, maxlen, 0);

	if (len < 0) {
		sr_err("Receive error: %s", strerror(errno));
		return SR_ERR;
	}

	tcp->length_bytes_read = LENGTH_BYTES;
	tcp->response_length = len < maxlen ? len : maxlen + 1;
	tcp->response_bytes_read = len;

	return len;
}

static int scpi_tcp_rigol_read_data(void *priv, char *buf, int maxlen)
{
	struct scpi_tcp *tcp = priv;
	int len;

	if (tcp->length_bytes_read < LENGTH_BYTES) {
		len = recv(tcp->socket, tcp->length_buf + tcp->length_bytes_read,
				LENGTH_BYTES - tcp->length_bytes_read, 0);
		if (len < 0) {
			sr_err("Receive error: %s", strerror(errno));
			return SR_ERR;
		}

		tcp->length_bytes_read += len;

		if (tcp->length_bytes_read < LENGTH_BYTES)
			return 0;
		else
			tcp->response_length = RL32(tcp->length_buf);
	}

	if (tcp->response_bytes_read >= tcp->response_length)
		return SR_ERR;

	len = recv(tcp->socket, buf, maxlen, 0);

	if (len < 0) {
		sr_err("Receive error: %s", strerror(errno));
		return SR_ERR;
	}

	tcp->response_bytes_read += len;

	return len;
}

static int scpi_tcp_read_complete(void *priv)
{
	struct scpi_tcp *tcp = priv;

	return (tcp->length_bytes_read == LENGTH_BYTES &&
			tcp->response_bytes_read >= tcp->response_length);
}

static int scpi_tcp_close(void *priv)
{
	struct scpi_tcp *tcp = priv;

	if (close(tcp->socket) < 0)
		return SR_ERR;

	return SR_OK;
}

static void scpi_tcp_free(void *priv)
{
	struct scpi_tcp *tcp = priv;

	g_free(tcp->address);
	g_free(tcp->port);
}

SR_PRIV const struct sr_scpi_dev_inst scpi_tcp_raw_dev = {
	.name          = "RAW TCP",
	.prefix        = "tcp-raw",
	.priv_size     = sizeof(struct scpi_tcp),
	.dev_inst_new  = scpi_tcp_dev_inst_new,
	.open          = scpi_tcp_open,
	.source_add    = scpi_tcp_source_add,
	.source_remove = scpi_tcp_source_remove,
	.send          = scpi_tcp_send,
	.read_begin    = scpi_tcp_read_begin,
	.read_data     = scpi_tcp_raw_read_data,
	.read_complete = scpi_tcp_read_complete,
	.close         = scpi_tcp_close,
	.free          = scpi_tcp_free,
};

SR_PRIV const struct sr_scpi_dev_inst scpi_tcp_rigol_dev = {
	.name          = "RIGOL TCP",
	.prefix        = "tcp-rigol",
	.priv_size     = sizeof(struct scpi_tcp),
	.dev_inst_new  = scpi_tcp_dev_inst_new,
	.open          = scpi_tcp_open,
	.source_add    = scpi_tcp_source_add,
	.source_remove = scpi_tcp_source_remove,
	.send          = scpi_tcp_send,
	.read_begin    = scpi_tcp_read_begin,
	.read_data     = scpi_tcp_rigol_read_data,
	.read_complete = scpi_tcp_read_complete,
	.close         = scpi_tcp_close,
	.free          = scpi_tcp_free,
};
Commit	Line	Data
08a35913 ML	1	/*
	2	* This file is part of the libsigrok project.
	3	*
	4	* Copyright (C) 2013 Martin Ling <martin-sigrok@earth.li>
	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 3 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, see <http://www.gnu.org/licenses/>.
	18	*/
	19
589edd9b	20	#ifdef _WIN32
0f4a4350	21	#define _WIN32_WINNT 0x0501
589edd9b ML	22	#include <winsock2.h>
	23	#include <ws2tcpip.h>
	24	#endif
0f4a4350	25
08a35913 ML	26	#include "libsigrok.h"
	27	#include "libsigrok-internal.h"
	28
	29	#include <glib.h>
	30	#include <string.h>
	31	#include <unistd.h>
589edd9b	32	#ifndef _WIN32
08a35913 ML	33	#include <sys/socket.h>
	34	#include <netinet/in.h>
	35	#include <arpa/inet.h>
	36	#include <netdb.h>
987a0530	37	#endif
08a35913 ML	38	#include <errno.h>
08a35913 ML	39
3544f848	40	#define LOG_PREFIX "scpi_tcp"
08a35913	41
05c644ea ML	42	#define LENGTH_BYTES 4
05c644ea ML	43
08a35913 ML	44	struct scpi_tcp {
	45	char *address;
	46	char *port;
	47	int socket;
05c644ea ML	48	char length_buf[LENGTH_BYTES];
	49	int length_bytes_read;
	50	int response_length;
	51	int response_bytes_read;
08a35913 ML	52	};
08a35913 ML	53
f754c146 AJ	54	static int scpi_tcp_dev_inst_new(void priv, const char resource,
	55	char *params, const char serialcomm)
	56	{
	57	struct scpi_tcp *tcp = priv;
	58
	59	(void)resource;
	60	(void)serialcomm;
	61
	62	if (!params \|\| !params[1] \|\| !params[2]) {
	63	sr_err("Invalid parameters.");
	64	return SR_ERR;
	65	}
	66
	67	tcp->address = g_strdup(params[1]);
	68	tcp->port = g_strdup(params[2]);
	69	tcp->socket = -1;
	70
	71	return SR_OK;
	72	}
	73
d87c1766	74	static int scpi_tcp_open(void *priv)
08a35913 ML	75	{
	76	struct scpi_tcp *tcp = priv;
	77	struct addrinfo hints;
	78	struct addrinfo results, res;
	79	int err;
	80
	81	memset(&hints, 0, sizeof(hints));
	82	hints.ai_family = AF_UNSPEC;
	83	hints.ai_socktype = SOCK_STREAM;
	84	hints.ai_protocol = IPPROTO_TCP;
	85
	86	err = getaddrinfo(tcp->address, tcp->port, &hints, &results);
	87
	88	if (err) {
	89	sr_err("Address lookup failed: %s:%d: %s", tcp->address, tcp->port,
	90	gai_strerror(err));
	91	return SR_ERR;
	92	}
	93
	94	for (res = results; res; res = res->ai_next) {
	95	if ((tcp->socket = socket(res->ai_family, res->ai_socktype,
	96	res->ai_protocol)) < 0)
	97	continue;
	98	if (connect(tcp->socket, res->ai_addr, res->ai_addrlen) != 0) {
	99	close(tcp->socket);
	100	tcp->socket = -1;
	101	continue;
	102	}
	103	break;
	104	}
	105
	106	freeaddrinfo(results);
	107
	108	if (tcp->socket < 0) {
	109	sr_err("Failed to connect to %s:%s: %s", tcp->address, tcp->port,
	110	strerror(errno));
	111	return SR_ERR;
	112	}
	113
	114	return SR_OK;
	115	}
	116
d87c1766	117	static int scpi_tcp_source_add(void *priv, int events, int timeout,
08a35913 ML	118	sr_receive_data_callback_t cb, void *cb_data)
	119	{
	120	struct scpi_tcp *tcp = priv;
	121
	122	return sr_source_add(tcp->socket, events, timeout, cb, cb_data);
	123	}
	124
d87c1766	125	static int scpi_tcp_source_remove(void *priv)
08a35913 ML	126	{
	127	struct scpi_tcp *tcp = priv;
	128
	129	return sr_source_remove(tcp->socket);
	130	}
	131
d87c1766	132	static int scpi_tcp_send(void priv, const char command)
08a35913 ML	133	{
	134	struct scpi_tcp *tcp = priv;
	135	int len, out;
b8705e99	136	char *terminated_command;
08a35913	137
b8705e99 ML	138	terminated_command = g_strdup_printf("%s\r\n", command);
	139	len = strlen(terminated_command);
	140	out = send(tcp->socket, terminated_command, len, 0);
	141	g_free(terminated_command);
08a35913 ML	142
	143	if (out < 0) {
	144	sr_err("Send error: %s", strerror(errno));
	145	return SR_ERR;
	146	}
	147
	148	if (out < len) {
	149	sr_dbg("Only sent %d/%d bytes of SCPI command: '%s'.", out,
	150	len, command);
	151	}
	152
	153	sr_spew("Successfully sent SCPI command: '%s'.", command);
	154
	155	return SR_OK;
	156	}
	157
d87c1766	158	static int scpi_tcp_read_begin(void *priv)
08a35913 ML	159	{
08a35913 ML	160	struct scpi_tcp *tcp = priv;
08a35913	161
05c644ea ML	162	tcp->response_bytes_read = 0;
05c644ea ML	163	tcp->length_bytes_read = 0;
08a35913 ML	164
	165	return SR_OK;
	166	}
	167
d87c1766	168	static int scpi_tcp_raw_read_data(void priv, char buf, int maxlen)
104ed125 AJ	169	{
	170	struct scpi_tcp *tcp = priv;
	171	int len;
	172
	173	len = recv(tcp->socket, buf, maxlen, 0);
	174
	175	if (len < 0) {
	176	sr_err("Receive error: %s", strerror(errno));
	177	return SR_ERR;
	178	}
	179
	180	tcp->length_bytes_read = LENGTH_BYTES;
	181	tcp->response_length = len < maxlen ? len : maxlen + 1;
	182	tcp->response_bytes_read = len;
	183
	184	return len;
	185	}
	186
d87c1766	187	static int scpi_tcp_rigol_read_data(void priv, char buf, int maxlen)
08a35913 ML	188	{
	189	struct scpi_tcp *tcp = priv;
	190	int len;
	191
05c644ea ML	192	if (tcp->length_bytes_read < LENGTH_BYTES) {
	193	len = recv(tcp->socket, tcp->length_buf + tcp->length_bytes_read,
	194	LENGTH_BYTES - tcp->length_bytes_read, 0);
	195	if (len < 0) {
	196	sr_err("Receive error: %s", strerror(errno));
	197	return SR_ERR;
	198	}
	199
	200	tcp->length_bytes_read += len;
	201
	202	if (tcp->length_bytes_read < LENGTH_BYTES)
	203	return 0;
	204	else
	205	tcp->response_length = RL32(tcp->length_buf);
	206	}
	207
	208	if (tcp->response_bytes_read >= tcp->response_length)
	209	return SR_ERR;
	210
08a35913 ML	211	len = recv(tcp->socket, buf, maxlen, 0);
	212
	213	if (len < 0) {
	214	sr_err("Receive error: %s", strerror(errno));
	215	return SR_ERR;
	216	}
	217
05c644ea ML	218	tcp->response_bytes_read += len;
05c644ea ML	219
08a35913 ML	220	return len;
	221	}
	222
d87c1766	223	static int scpi_tcp_read_complete(void *priv)
05c644ea ML	224	{
	225	struct scpi_tcp *tcp = priv;
	226
	227	return (tcp->length_bytes_read == LENGTH_BYTES &&
	228	tcp->response_bytes_read >= tcp->response_length);
	229	}
	230
d87c1766	231	static int scpi_tcp_close(void *priv)
08a35913 ML	232	{
	233	struct scpi_tcp *tcp = priv;
	234
	235	if (close(tcp->socket) < 0)
	236	return SR_ERR;
	237
	238	return SR_OK;
	239	}
	240
d87c1766	241	static void scpi_tcp_free(void *priv)
08a35913 ML	242	{
	243	struct scpi_tcp *tcp = priv;
	244
	245	g_free(tcp->address);
	246	g_free(tcp->port);
08a35913 ML	247	}
08a35913 ML	248
104ed125 AJ	249	SR_PRIV const struct sr_scpi_dev_inst scpi_tcp_raw_dev = {
	250	.name = "RAW TCP",
	251	.prefix = "tcp-raw",
	252	.priv_size = sizeof(struct scpi_tcp),
	253	.dev_inst_new = scpi_tcp_dev_inst_new,
	254	.open = scpi_tcp_open,
	255	.source_add = scpi_tcp_source_add,
	256	.source_remove = scpi_tcp_source_remove,
	257	.send = scpi_tcp_send,
	258	.read_begin = scpi_tcp_read_begin,
	259	.read_data = scpi_tcp_raw_read_data,
	260	.read_complete = scpi_tcp_read_complete,
	261	.close = scpi_tcp_close,
	262	.free = scpi_tcp_free,
	263	};
	264
	265	SR_PRIV const struct sr_scpi_dev_inst scpi_tcp_rigol_dev = {
	266	.name = "RIGOL TCP",
	267	.prefix = "tcp-rigol",
f754c146 AJ	268	.priv_size = sizeof(struct scpi_tcp),
	269	.dev_inst_new = scpi_tcp_dev_inst_new,
	270	.open = scpi_tcp_open,
	271	.source_add = scpi_tcp_source_add,
	272	.source_remove = scpi_tcp_source_remove,
	273	.send = scpi_tcp_send,
	274	.read_begin = scpi_tcp_read_begin,
104ed125	275	.read_data = scpi_tcp_rigol_read_data,
f754c146 AJ	276	.read_complete = scpi_tcp_read_complete,
	277	.close = scpi_tcp_close,
	278	.free = scpi_tcp_free,
	279	};