[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 drvopts[] = {
	SR_CONF_OSCILLOSCOPE,
};

static const uint32_t devopts[] = {
	SR_CONF_LIMIT_FRAMES | SR_CONF_GET | 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.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 = sr_channel_group_new(sdi, "", NULL);
	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));

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

	return SR_OK;
}

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

	scpi = sdi->conn;

	if (!scpi)
		return SR_ERR_BUG;

	return sr_scpi_close(scpi);
}

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;
	case SR_CONF_LIMIT_FRAMES:
		*data = g_variant_new_uint64(devc->frame_limit);
		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;

	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)
{
	return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts);
}

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;

	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;

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

	if (devc->df_started) {
		std_session_send_df_frame_end(sdi);
		std_session_send_df_end(sdi);
		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,
	.dev_clear = std_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,
};
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
05199c0a	28	static const uint32_t drvopts[] = {
b11afbb1	29	SR_CONF_OSCILLOSCOPE,
05199c0a UH	30	};
	31
	32	static const uint32_t devopts[] = {
7c48d434	33	SR_CONF_LIMIT_FRAMES \| SR_CONF_GET \| SR_CONF_SET,
b11afbb1 ML	34	SR_CONF_SAMPLERATE \| SR_CONF_GET,
	35	};
	36
dd5c48a6	37	static struct sr_dev_driver gwinstek_gds_800_driver_info;
7c198f96	38
b11afbb1	39	static struct sr_dev_inst probe_device(struct sr_scpi_dev_inst scpi)
7c198f96	40	{
b11afbb1 ML	41	struct dev_context *devc;
	42	struct sr_dev_inst *sdi;
	43	struct sr_scpi_hw_info *hw_info;
	44	struct sr_channel_group *cg;
	45
	46	if (sr_scpi_get_hw_id(scpi, &hw_info) != SR_OK) {
	47	sr_info("Couldn't get IDN response.");
	48	return NULL;
	49	}
7c198f96	50
b11afbb1 ML	51	if (strcmp(hw_info->manufacturer, "GW") != 0 \|\|
	52	strncmp(hw_info->model, "GDS-8", 5) != 0) {
	53	sr_scpi_hw_info_free(hw_info);
	54	return NULL;
	55	}
7c198f96	56
b11afbb1	57	sdi = g_malloc0(sizeof(struct sr_dev_inst));
b11afbb1 ML	58	sdi->vendor = g_strdup(hw_info->manufacturer);
	59	sdi->model = g_strdup(hw_info->model);
	60	sdi->version = g_strdup(hw_info->firmware_version);
	61	sdi->conn = scpi;
	62	sdi->driver = &gwinstek_gds_800_driver_info;
	63	sdi->inst_type = SR_INST_SCPI;
	64	sdi->serial_num = g_strdup(hw_info->serial_number);
	65	sdi->channels = NULL;
	66	sdi->channel_groups = NULL;
	67
	68	sr_scpi_hw_info_free(hw_info);
	69
	70	devc = g_malloc0(sizeof(struct dev_context));
	71	devc->frame_limit = 1;
d9251a2c UH	72	devc->sample_rate = 0.0;
d9251a2c UH	73	devc->df_started = FALSE;
b11afbb1 ML	74	sdi->priv = devc;
	75
	76	sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "CH1");
	77	sr_channel_new(sdi, 1, SR_CHANNEL_ANALOG, TRUE, "CH2");
	78
d810901a	79	cg = sr_channel_group_new(sdi, "", NULL);
b11afbb1 ML	80	cg->channels = g_slist_append(cg->channels, g_slist_nth_data(sdi->channels, 0));
b11afbb1 ML	81	cg->channels = g_slist_append(cg->channels, g_slist_nth_data(sdi->channels, 1));
b11afbb1 ML	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	100
7c198f96 ML	101	return SR_OK;
	102	}
	103
	104	static int dev_close(struct sr_dev_inst *sdi)
	105	{
b11afbb1	106	struct sr_scpi_dev_inst *scpi;
7c198f96	107
b11afbb1	108	scpi = sdi->conn;
7c198f96	109
f1ba6b4b UH	110	if (!scpi)
	111	return SR_ERR_BUG;
	112
	113	return sr_scpi_close(scpi);
7c198f96 ML	114	}
7c198f96 ML	115
dd7a72ea UH	116	static int config_get(uint32_t key, GVariant **data,
dd7a72ea UH	117	const struct sr_dev_inst sdi, const struct sr_channel_group cg)
7c198f96	118	{
b11afbb1	119	struct dev_context *devc;
7c198f96	120
7c198f96 ML	121	(void)cg;
7c198f96 ML	122
709468ba	123	if (!sdi)
b11afbb1 ML	124	return SR_ERR_ARG;
b11afbb1 ML	125
709468ba UH	126	devc = sdi->priv;
709468ba UH	127
7c198f96	128	switch (key) {
b11afbb1 ML	129	case SR_CONF_SAMPLERATE:
	130	*data = g_variant_new_uint64(devc->sample_rate);
	131	break;
7c48d434 VO	132	case SR_CONF_LIMIT_FRAMES:
	133	*data = g_variant_new_uint64(devc->frame_limit);
	134	break;
7c198f96 ML	135	default:
	136	return SR_ERR_NA;
	137	}
	138
b11afbb1	139	return SR_OK;
7c198f96 ML	140	}
7c198f96 ML	141
dd7a72ea UH	142	static int config_set(uint32_t key, GVariant *data,
dd7a72ea UH	143	const struct sr_dev_inst sdi, const struct sr_channel_group cg)
7c198f96	144	{
b11afbb1	145	struct dev_context *devc;
7c198f96	146
7c198f96 ML	147	(void)cg;
7c198f96 ML	148
b0baddef	149	if (!sdi)
b11afbb1 ML	150	return SR_ERR_ARG;
b11afbb1 ML	151
b0baddef UH	152	devc = sdi->priv;
b0baddef UH	153
7c198f96	154	switch (key) {
b11afbb1 ML	155	case SR_CONF_LIMIT_FRAMES:
	156	devc->frame_limit = g_variant_get_uint64(data);
	157	break;
7c198f96	158	default:
b11afbb1	159	return SR_ERR_NA;
7c198f96 ML	160	}
7c198f96 ML	161
b11afbb1	162	return SR_OK;
7c198f96 ML	163	}
7c198f96 ML	164
dd7a72ea UH	165	static int config_list(uint32_t key, GVariant **data,
dd7a72ea UH	166	const struct sr_dev_inst sdi, const struct sr_channel_group cg)
7c198f96	167	{
05199c0a	168	return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts);
7c198f96 ML	169	}
7c198f96 ML	170
695dc859	171	static int dev_acquisition_start(const struct sr_dev_inst *sdi)
7c198f96	172	{
b11afbb1 ML	173	struct sr_scpi_dev_inst *scpi;
	174	struct dev_context *devc;
	175
b11afbb1 ML	176	scpi = sdi->conn;
	177	devc = sdi->priv;
	178
b11afbb1 ML	179	devc->state = START_ACQUISITION;
	180	devc->cur_acq_frame = 0;
	181
	182	sr_scpi_source_add(sdi->session, scpi, G_IO_IN, 50,
	183	gwinstek_gds_800_receive_data, (void *)sdi);
7c198f96 ML	184
	185	return SR_OK;
	186	}
	187
695dc859	188	static int dev_acquisition_stop(struct sr_dev_inst *sdi)
7c198f96	189	{
b11afbb1 ML	190	struct sr_scpi_dev_inst *scpi;
b11afbb1 ML	191	struct dev_context *devc;
b11afbb1	192
b11afbb1 ML	193	scpi = sdi->conn;
	194	devc = sdi->priv;
	195
b11afbb1	196	if (devc->df_started) {
4c5f7006	197	std_session_send_df_frame_end(sdi);
bee2b016	198	std_session_send_df_end(sdi);
b11afbb1 ML	199	devc->df_started = FALSE;
b11afbb1 ML	200	}
7c198f96	201
b11afbb1	202	sr_scpi_source_remove(sdi->session, scpi);
7c198f96 ML	203
	204	return SR_OK;
	205	}
	206
dd5c48a6	207	static struct sr_dev_driver gwinstek_gds_800_driver_info = {
7c198f96	208	.name = "gwinstek-gds-800",
b11afbb1	209	.longname = "GW Instek GDS-800 series",
7c198f96	210	.api_version = 1,
c2fdcc25	211	.init = std_init,
700d6b64	212	.cleanup = std_cleanup,
7c198f96	213	.scan = scan,
c01bf34c	214	.dev_list = std_dev_list,
f778bf02	215	.dev_clear = std_dev_clear,
7c198f96 ML	216	.config_get = config_get,
	217	.config_set = config_set,
	218	.config_list = config_list,
	219	.dev_open = dev_open,
	220	.dev_close = dev_close,
	221	.dev_acquisition_start = dev_acquisition_start,
	222	.dev_acquisition_stop = dev_acquisition_stop,
	223	.context = NULL,
	224	};
dd5c48a6	225	SR_REGISTER_DEV_DRIVER(gwinstek_gds_800_driver_info);