[libsigrok.git] / src / hardware / gwinstek-gds-800 / api.c

/*
 * This file is part of the libsigrok project.
 *
 * Copyright (C) 2015 Martin Lederhilger <martin.lederhilger@gmx.at>
 *
 * 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 <string.h>
#include "protocol.h"

static const uint32_t scanopts[] = {
	SR_CONF_CONN,
	SR_CONF_SERIALCOMM,
};

static const uint32_t devopts[] = {
	SR_CONF_OSCILLOSCOPE,
	SR_CONF_LIMIT_FRAMES | SR_CONF_SET,
	SR_CONF_SAMPLERATE | SR_CONF_GET,
};

SR_PRIV struct sr_dev_driver gwinstek_gds_800_driver_info;

static int init(struct sr_dev_driver *di, struct sr_context *sr_ctx)
{
	return std_init(sr_ctx, di, LOG_PREFIX);
}

static struct sr_dev_inst *probe_device(struct sr_scpi_dev_inst *scpi)
{
	struct dev_context *devc;
	struct sr_dev_inst *sdi;
	struct sr_scpi_hw_info *hw_info;
	struct sr_channel_group *cg;

	if (sr_scpi_get_hw_id(scpi, &hw_info) != SR_OK) {
		sr_info("Couldn't get IDN response.");
		return NULL;
	}

	if (strcmp(hw_info->manufacturer, "GW") != 0 ||
	    strncmp(hw_info->model, "GDS-8", 5) != 0) {
		sr_scpi_hw_info_free(hw_info);
		return NULL;
	}

	sdi = g_malloc0(sizeof(struct sr_dev_inst));
	sdi->vendor = g_strdup(hw_info->manufacturer);
	sdi->model = g_strdup(hw_info->model);
	sdi->version = g_strdup(hw_info->firmware_version);
	sdi->conn = scpi;
	sdi->driver = &gwinstek_gds_800_driver_info;
	sdi->inst_type = SR_INST_SCPI;
	sdi->serial_num = g_strdup(hw_info->serial_number);
	sdi->channels = NULL;
	sdi->channel_groups = NULL;

	sr_scpi_hw_info_free(hw_info);

	devc = g_malloc0(sizeof(struct dev_context));
	devc->frame_limit = 1;
	devc->sample_rate = 0.;
	devc->df_started  = FALSE;
	sdi->priv = devc;

	sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "CH1");
	sr_channel_new(sdi, 1, SR_CHANNEL_ANALOG, TRUE, "CH2");

	cg = g_malloc0(sizeof(struct sr_channel_group));
	cg->name = g_strdup("");
	cg->channels = g_slist_append(cg->channels, g_slist_nth_data(sdi->channels, 0));
	cg->channels = g_slist_append(cg->channels, g_slist_nth_data(sdi->channels, 1));
	cg->priv = NULL;
	sdi->channel_groups = g_slist_append(NULL, cg);

	return sdi;
}

static GSList *scan(struct sr_dev_driver *di, GSList *options)
{
	return sr_scpi_scan(di->context, options, probe_device);
}

static GSList *dev_list(const struct sr_dev_driver *di)
{
	return ((struct drv_context *)(di->context))->instances;
}

static int dev_clear(const struct sr_dev_driver *di)
{
	return std_dev_clear(di, NULL);
}

static int dev_open(struct sr_dev_inst *sdi)
{
	int ret;
	struct sr_scpi_dev_inst *scpi = sdi->conn;

	if ((ret = sr_scpi_open(scpi)) < 0) {
		sr_err("Failed to open SCPI device: %s.", sr_strerror(ret));
		return SR_ERR;
	}

	sdi->status = SR_ST_ACTIVE;

	return SR_OK;
}

static int dev_close(struct sr_dev_inst *sdi)
{
	struct sr_scpi_dev_inst *scpi;

	if (sdi->status != SR_ST_ACTIVE)
		return SR_ERR_DEV_CLOSED;

	scpi = sdi->conn;
	if (scpi) {
		if (sr_scpi_close(scpi) < 0)
			return SR_ERR;
		sdi->status = SR_ST_INACTIVE;
	}

	return SR_OK;
}

static int cleanup(const struct sr_dev_driver *di)
{
	dev_clear(di);

	return SR_OK;
}

static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
		const struct sr_channel_group *cg)
{
	struct dev_context *devc;

	(void)cg;

	if (!sdi || !(devc = sdi->priv))
		return SR_ERR_ARG;

	switch (key) {
	case SR_CONF_SAMPLERATE:
		*data = g_variant_new_uint64(devc->sample_rate);
		break;
	default:
		return SR_ERR_NA;
	}

	return SR_OK;
}

static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
		const struct sr_channel_group *cg)
{
	struct dev_context *devc;

	(void)cg;

	if (!sdi || !(devc = sdi->priv))
		return SR_ERR_ARG;

	if (sdi->status != SR_ST_ACTIVE)
		return SR_ERR_DEV_CLOSED;

	switch (key) {
	case SR_CONF_LIMIT_FRAMES:
		devc->frame_limit = g_variant_get_uint64(data);
		break;
	default:
		return SR_ERR_NA;
	}

	return SR_OK;
}

static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
		const struct sr_channel_group *cg)
{
	(void)sdi;
	(void)cg;

	switch (key) {
	case SR_CONF_SCAN_OPTIONS:
		*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
			scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
		return SR_OK;
	case SR_CONF_DEVICE_OPTIONS:
		*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
			devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
		return SR_OK;
	default:
		return SR_ERR_NA;
	}

	return SR_OK;
}

static int dev_acquisition_start(const struct sr_dev_inst *sdi)
{
	struct sr_scpi_dev_inst *scpi;
	struct dev_context *devc;

	scpi = sdi->conn;
	devc = sdi->priv;

	if (sdi->status != SR_ST_ACTIVE)
		return SR_ERR_DEV_CLOSED;

	devc->state = START_ACQUISITION;
	devc->cur_acq_frame = 0;

	sr_scpi_source_add(sdi->session, scpi, G_IO_IN, 50,
			gwinstek_gds_800_receive_data, (void *)sdi);

	return SR_OK;
}

static int dev_acquisition_stop(struct sr_dev_inst *sdi)
{
	struct sr_scpi_dev_inst *scpi;
	struct dev_context *devc;
	struct sr_datafeed_packet packet;

	scpi = sdi->conn;
	devc = sdi->priv;

	if (sdi->status != SR_ST_ACTIVE) {
		sr_err("Device inactive, can't stop acquisition.");
		return SR_ERR;
	}

	if (devc->df_started) {
		packet.type = SR_DF_FRAME_END;
		sr_session_send(sdi, &packet);

		std_session_send_df_end(sdi, LOG_PREFIX);

		devc->df_started = FALSE;
	}

	sr_scpi_source_remove(sdi->session, scpi);

	return SR_OK;
}

SR_PRIV struct sr_dev_driver gwinstek_gds_800_driver_info = {
	.name = "gwinstek-gds-800",
	.longname = "GW Instek GDS-800 series",
	.api_version = 1,
	.init = init,
	.cleanup = cleanup,
	.scan = scan,
	.dev_list = dev_list,
	.dev_clear = dev_clear,
	.config_get = config_get,
	.config_set = config_set,
	.config_list = config_list,
	.dev_open = dev_open,
	.dev_close = dev_close,
	.dev_acquisition_start = dev_acquisition_start,
	.dev_acquisition_stop = dev_acquisition_stop,
	.context = NULL,
};
Commit	Line	Data
7c198f96 ML	1	/*
	2	* This file is part of the libsigrok project.
	3	*
	4	* Copyright (C) 2015 Martin Lederhilger <martin.lederhilger@gmx.at>
	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
b11afbb1	20	#include <string.h>
7c198f96 ML	21	#include "protocol.h"
7c198f96 ML	22
b11afbb1 ML	23	static const uint32_t scanopts[] = {
	24	SR_CONF_CONN,
	25	SR_CONF_SERIALCOMM,
	26	};
	27
	28	static const uint32_t devopts[] = {
	29	SR_CONF_OSCILLOSCOPE,
	30	SR_CONF_LIMIT_FRAMES \| SR_CONF_SET,
	31	SR_CONF_SAMPLERATE \| SR_CONF_GET,
	32	};
	33
7c198f96 ML	34	SR_PRIV struct sr_dev_driver gwinstek_gds_800_driver_info;
	35
	36	static int init(struct sr_dev_driver di, struct sr_context sr_ctx)
	37	{
	38	return std_init(sr_ctx, di, LOG_PREFIX);
	39	}
	40
b11afbb1	41	static struct sr_dev_inst probe_device(struct sr_scpi_dev_inst scpi)
7c198f96	42	{
b11afbb1 ML	43	struct dev_context *devc;
	44	struct sr_dev_inst *sdi;
	45	struct sr_scpi_hw_info *hw_info;
	46	struct sr_channel_group *cg;
	47
	48	if (sr_scpi_get_hw_id(scpi, &hw_info) != SR_OK) {
	49	sr_info("Couldn't get IDN response.");
	50	return NULL;
	51	}
7c198f96	52
b11afbb1 ML	53	if (strcmp(hw_info->manufacturer, "GW") != 0 \|\|
	54	strncmp(hw_info->model, "GDS-8", 5) != 0) {
	55	sr_scpi_hw_info_free(hw_info);
	56	return NULL;
	57	}
7c198f96	58
b11afbb1	59	sdi = g_malloc0(sizeof(struct sr_dev_inst));
b11afbb1 ML	60	sdi->vendor = g_strdup(hw_info->manufacturer);
	61	sdi->model = g_strdup(hw_info->model);
	62	sdi->version = g_strdup(hw_info->firmware_version);
	63	sdi->conn = scpi;
	64	sdi->driver = &gwinstek_gds_800_driver_info;
	65	sdi->inst_type = SR_INST_SCPI;
	66	sdi->serial_num = g_strdup(hw_info->serial_number);
	67	sdi->channels = NULL;
	68	sdi->channel_groups = NULL;
	69
	70	sr_scpi_hw_info_free(hw_info);
	71
	72	devc = g_malloc0(sizeof(struct dev_context));
	73	devc->frame_limit = 1;
	74	devc->sample_rate = 0.;
	75	devc->df_started = FALSE;
	76	sdi->priv = devc;
	77
	78	sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "CH1");
	79	sr_channel_new(sdi, 1, SR_CHANNEL_ANALOG, TRUE, "CH2");
	80
	81	cg = g_malloc0(sizeof(struct sr_channel_group));
	82	cg->name = g_strdup("");
	83	cg->channels = g_slist_append(cg->channels, g_slist_nth_data(sdi->channels, 0));
	84	cg->channels = g_slist_append(cg->channels, g_slist_nth_data(sdi->channels, 1));
	85	cg->priv = NULL;
	86	sdi->channel_groups = g_slist_append(NULL, cg);
	87
	88	return sdi;
	89	}
7c198f96	90
b11afbb1 ML	91	static GSList scan(struct sr_dev_driver di, GSList *options)
	92	{
	93	return sr_scpi_scan(di->context, options, probe_device);
7c198f96 ML	94	}
	95
	96	static GSList dev_list(const struct sr_dev_driver di)
	97	{
	98	return ((struct drv_context *)(di->context))->instances;
	99	}
	100
	101	static int dev_clear(const struct sr_dev_driver *di)
	102	{
	103	return std_dev_clear(di, NULL);
	104	}
	105
	106	static int dev_open(struct sr_dev_inst *sdi)
	107	{
b11afbb1 ML	108	int ret;
b11afbb1 ML	109	struct sr_scpi_dev_inst *scpi = sdi->conn;
7c198f96	110
b11afbb1 ML	111	if ((ret = sr_scpi_open(scpi)) < 0) {
	112	sr_err("Failed to open SCPI device: %s.", sr_strerror(ret));
	113	return SR_ERR;
	114	}
7c198f96 ML	115
	116	sdi->status = SR_ST_ACTIVE;
	117
	118	return SR_OK;
	119	}
	120
	121	static int dev_close(struct sr_dev_inst *sdi)
	122	{
b11afbb1	123	struct sr_scpi_dev_inst *scpi;
7c198f96	124
b11afbb1 ML	125	if (sdi->status != SR_ST_ACTIVE)
b11afbb1 ML	126	return SR_ERR_DEV_CLOSED;
7c198f96	127
b11afbb1 ML	128	scpi = sdi->conn;
	129	if (scpi) {
	130	if (sr_scpi_close(scpi) < 0)
	131	return SR_ERR;
	132	sdi->status = SR_ST_INACTIVE;
	133	}
7c198f96 ML	134
	135	return SR_OK;
	136	}
	137
	138	static int cleanup(const struct sr_dev_driver *di)
	139	{
	140	dev_clear(di);
	141
7c198f96 ML	142	return SR_OK;
	143	}
	144
	145	static int config_get(uint32_t key, GVariant *data, const struct sr_dev_inst sdi,
	146	const struct sr_channel_group *cg)
	147	{
b11afbb1	148	struct dev_context *devc;
7c198f96	149
7c198f96 ML	150	(void)cg;
7c198f96 ML	151
b11afbb1 ML	152	if (!sdi \|\| !(devc = sdi->priv))
	153	return SR_ERR_ARG;
	154
7c198f96	155	switch (key) {
b11afbb1 ML	156	case SR_CONF_SAMPLERATE:
	157	*data = g_variant_new_uint64(devc->sample_rate);
	158	break;
7c198f96 ML	159	default:
	160	return SR_ERR_NA;
	161	}
	162
b11afbb1	163	return SR_OK;
7c198f96 ML	164	}
	165
	166	static int config_set(uint32_t key, GVariant data, const struct sr_dev_inst sdi,
	167	const struct sr_channel_group *cg)
	168	{
b11afbb1	169	struct dev_context *devc;
7c198f96	170
7c198f96 ML	171	(void)cg;
7c198f96 ML	172
b11afbb1 ML	173	if (!sdi \|\| !(devc = sdi->priv))
	174	return SR_ERR_ARG;
	175
7c198f96 ML	176	if (sdi->status != SR_ST_ACTIVE)
	177	return SR_ERR_DEV_CLOSED;
	178
7c198f96	179	switch (key) {
b11afbb1 ML	180	case SR_CONF_LIMIT_FRAMES:
	181	devc->frame_limit = g_variant_get_uint64(data);
	182	break;
7c198f96	183	default:
b11afbb1	184	return SR_ERR_NA;
7c198f96 ML	185	}
7c198f96 ML	186
b11afbb1	187	return SR_OK;
7c198f96 ML	188	}
	189
	190	static int config_list(uint32_t key, GVariant *data, const struct sr_dev_inst sdi,
	191	const struct sr_channel_group *cg)
	192	{
7c198f96	193	(void)sdi;
7c198f96 ML	194	(void)cg;
7c198f96 ML	195
7c198f96	196	switch (key) {
b11afbb1 ML	197	case SR_CONF_SCAN_OPTIONS:
	198	*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
	199	scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
	200	return SR_OK;
	201	case SR_CONF_DEVICE_OPTIONS:
	202	*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
	203	devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
	204	return SR_OK;
7c198f96 ML	205	default:
	206	return SR_ERR_NA;
	207	}
	208
b11afbb1	209	return SR_OK;
7c198f96 ML	210	}
7c198f96 ML	211
695dc859	212	static int dev_acquisition_start(const struct sr_dev_inst *sdi)
7c198f96	213	{
b11afbb1 ML	214	struct sr_scpi_dev_inst *scpi;
	215	struct dev_context *devc;
	216
b11afbb1 ML	217	scpi = sdi->conn;
	218	devc = sdi->priv;
	219
7c198f96 ML	220	if (sdi->status != SR_ST_ACTIVE)
	221	return SR_ERR_DEV_CLOSED;
	222
b11afbb1 ML	223	devc->state = START_ACQUISITION;
	224	devc->cur_acq_frame = 0;
	225
	226	sr_scpi_source_add(sdi->session, scpi, G_IO_IN, 50,
	227	gwinstek_gds_800_receive_data, (void *)sdi);
7c198f96 ML	228
	229	return SR_OK;
	230	}
	231
695dc859	232	static int dev_acquisition_stop(struct sr_dev_inst *sdi)
7c198f96	233	{
b11afbb1 ML	234	struct sr_scpi_dev_inst *scpi;
	235	struct dev_context *devc;
	236	struct sr_datafeed_packet packet;
	237
b11afbb1 ML	238	scpi = sdi->conn;
	239	devc = sdi->priv;
	240
	241	if (sdi->status != SR_ST_ACTIVE) {
	242	sr_err("Device inactive, can't stop acquisition.");
	243	return SR_ERR;
	244	}
	245
	246	if (devc->df_started) {
	247	packet.type = SR_DF_FRAME_END;
	248	sr_session_send(sdi, &packet);
	249
3be42bc2	250	std_session_send_df_end(sdi, LOG_PREFIX);
b11afbb1 ML	251
	252	devc->df_started = FALSE;
	253	}
7c198f96	254
b11afbb1	255	sr_scpi_source_remove(sdi->session, scpi);
7c198f96 ML	256
	257	return SR_OK;
	258	}
	259
	260	SR_PRIV struct sr_dev_driver gwinstek_gds_800_driver_info = {
	261	.name = "gwinstek-gds-800",
b11afbb1	262	.longname = "GW Instek GDS-800 series",
7c198f96 ML	263	.api_version = 1,
	264	.init = init,
	265	.cleanup = cleanup,
	266	.scan = scan,
	267	.dev_list = dev_list,
	268	.dev_clear = dev_clear,
	269	.config_get = config_get,
	270	.config_set = config_set,
	271	.config_list = config_list,
	272	.dev_open = dev_open,
	273	.dev_close = dev_close,
	274	.dev_acquisition_start = dev_acquisition_start,
	275	.dev_acquisition_stop = dev_acquisition_stop,
	276	.context = NULL,
	277	};