[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,
};

static struct sr_dev_driver gwinstek_gds_800_driver_info;

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 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 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)
		return SR_ERR_ARG;

	devc = sdi->priv;

	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)
		return SR_ERR_ARG;

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

	devc = sdi->priv;

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

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