[libsigrok.git] / src / hardware / zketech-ebd-usb / api.c

/*
 * This file is part of the libsigrok project.
 *
 * Copyright (C) 2018 Sven Bursch-Osewold <sb_git@bursch.com>
 * Copyright (C) 2019 King Kévin <kingkevin@cuvoodoo.info>
 *
 * 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 "protocol.h"

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

static const uint32_t drvopts[] = {
	SR_CONF_ELECTRONIC_LOAD,
};

static const uint32_t devopts[] = {
	SR_CONF_CONTINUOUS,
	SR_CONF_CURRENT_LIMIT | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
	SR_CONF_UNDER_VOLTAGE_CONDITION_THRESHOLD | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
	SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
};

static GSList *scan(struct sr_dev_driver *di, GSList *options)
{
	struct dev_context *devc;
	GSList *l;
	struct sr_dev_inst *sdi;
	const char *conn, *serialcomm;
	struct sr_config *src;
	struct sr_serial_dev_inst *serial;
	uint8_t reply[MSG_MAX_LEN];

	conn = NULL;
	serialcomm = NULL;

	for (l = options; l; l = l->next) {
		src = l->data;
		switch (src->key) {
		case SR_CONF_CONN:
			conn = g_variant_get_string(src->data, NULL);
			break;
		case SR_CONF_SERIALCOMM:
			serialcomm = g_variant_get_string(src->data, NULL);
			break;
		}
	}

	if (!conn)
		return NULL;
	if (!serialcomm)
		serialcomm = "9600/8e1";

	serial = sr_serial_dev_inst_new(conn, serialcomm);
	if (serial_open(serial, SERIAL_RDWR) != SR_OK)
		return NULL;

	sdi = g_malloc0(sizeof(struct sr_dev_inst));
	sdi->status = SR_ST_INACTIVE;
	sdi->vendor = g_strdup("ZKETECH");
	sdi->model = g_strdup("EBD-USB");
	sdi->inst_type = SR_INST_SERIAL;
	sdi->conn = serial;

	sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "V.VBUS");
	sr_channel_new(sdi, 1, SR_CHANNEL_ANALOG, TRUE, "I.VBUS");
	sr_channel_new(sdi, 2, SR_CHANNEL_ANALOG, TRUE, "V.D+");
	sr_channel_new(sdi, 3, SR_CHANNEL_ANALOG, TRUE, "V.D-");

	devc = g_malloc0(sizeof(struct dev_context));
	g_mutex_init(&devc->rw_mutex);
	devc->current_limit = 0;
	devc->voltage_limit = 0;
	devc->running = FALSE;
	devc->load_activated = FALSE;
	sr_sw_limits_init(&devc->limits);
	sdi->priv = devc;

	/* Starting device. */
	ebd_init(serial, devc);
	int ret = ebd_read_message(serial, MSG_MAX_LEN, reply);
	if (ret < 0) {
		sr_warn("Could not receive message!");
		ret = SR_ERR;
	} else if (0 == ret) {
		sr_warn("No message received!");
		ret = SR_ERR;
	}
	ebd_stop(serial, devc);

	serial_close(serial);

	if (ret < 0)
		return NULL;

	return std_scan_complete(di, g_slist_append(NULL, sdi));
}

static int dev_close(struct sr_dev_inst *sdi)
{
	struct dev_context *devc;

	devc = (sdi) ? sdi->priv : NULL;
	if (devc)
		g_mutex_clear(&devc->rw_mutex);

	return std_serial_dev_close(sdi);
}

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

	(void)cg;

	if (!sdi || !data)
		return SR_ERR_ARG;

	devc = sdi->priv;

	switch (key) {
	case SR_CONF_LIMIT_SAMPLES:
	case SR_CONF_LIMIT_MSEC:
		return sr_sw_limits_config_get(&devc->limits, key, data);
	case SR_CONF_CURRENT_LIMIT:
		ret = ebd_get_current_limit(sdi, &fvalue);
		if (ret == SR_OK)
			*data = g_variant_new_double(fvalue);
		return ret;
	case SR_CONF_UNDER_VOLTAGE_CONDITION_THRESHOLD:
		ret = ebd_get_voltage_limit(sdi, &fvalue);
		if (ret == SR_OK)
			*data = g_variant_new_double(fvalue);
		return ret;
	default:
		return SR_ERR_NA;
	}
}

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

	(void)data;
	(void)cg;

	devc = sdi->priv;

	switch (key) {
	case SR_CONF_LIMIT_MSEC:
	case SR_CONF_LIMIT_SAMPLES:
		return sr_sw_limits_config_set(&devc->limits, key, data);
	case SR_CONF_CURRENT_LIMIT:
		value = g_variant_get_double(data);
		if (value < 0.0 || value > 4.0)
			return SR_ERR_ARG;
		return ebd_set_current_limit(sdi, value);
	case SR_CONF_UNDER_VOLTAGE_CONDITION_THRESHOLD:
		value = g_variant_get_double(data);
		if (value < 0.0 || value > 21.0)
			return SR_ERR_ARG;
		return ebd_set_voltage_limit(sdi, value);
	default:
		return SR_ERR_NA;
	}
}

static int config_list(uint32_t key, GVariant **data,
	const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
{
	switch (key) {
	case SR_CONF_SCAN_OPTIONS:
	case SR_CONF_DEVICE_OPTIONS:
		return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts);
	case SR_CONF_CURRENT_LIMIT:
		*data = std_gvar_min_max_step(0.0, 4.0, 0.001);
		break;
	case SR_CONF_UNDER_VOLTAGE_CONDITION_THRESHOLD:
		*data = std_gvar_min_max_step(0.0, 21.0, 0.01);
		break;
	default:
		return SR_ERR_NA;
	}

	return SR_OK;
}

static int dev_acquisition_start(const struct sr_dev_inst *sdi)
{
	struct dev_context *devc;
	struct sr_serial_dev_inst *serial;

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

	sr_sw_limits_acquisition_start(&devc->limits);
	std_session_send_df_header(sdi);

	ebd_init(serial, devc);

	serial_source_add(sdi->session, serial, G_IO_IN, 100,
		ebd_receive_data, (void *)sdi);

	return SR_OK;
}

static int dev_acquisition_stop(struct sr_dev_inst *sdi)
{
	struct dev_context *devc;

	if (sdi) {
		devc = sdi->priv;
		if (devc->load_activated) {
			ebd_loadtoggle(sdi->conn, devc);
		}
		ebd_stop(sdi->conn, devc);
	}

	return std_serial_dev_acquisition_stop(sdi);
}

static struct sr_dev_driver zketech_ebd_usb_driver_info = {
	.name = "zketech-ebd-usb",
	.longname = "ZKETECH EBD-USB",
	.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 = std_serial_dev_open,
	.dev_close = dev_close,
	.dev_acquisition_start = dev_acquisition_start,
	.dev_acquisition_stop = dev_acquisition_stop,
	.context = NULL,
};
SR_REGISTER_DEV_DRIVER(zketech_ebd_usb_driver_info);
Commit	Line	Data
c527132a SBO	1	/*
	2	* This file is part of the libsigrok project.
	3	*
	4	* Copyright (C) 2018 Sven Bursch-Osewold <sb_git@bursch.com>
ab3e9c8a	5	* Copyright (C) 2019 King Kévin <kingkevin@cuvoodoo.info>
c527132a SBO	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 "protocol.h"
	23
9890fb1f SBO	24	static const uint32_t scanopts[] = {
	25	SR_CONF_CONN,
	26	SR_CONF_SERIALCOMM,
	27	};
c527132a	28
9890fb1f SBO	29	static const uint32_t drvopts[] = {
	30	SR_CONF_ELECTRONIC_LOAD,
	31	};
c527132a	32
9890fb1f SBO	33	static const uint32_t devopts[] = {
	34	SR_CONF_CONTINUOUS,
	35	SR_CONF_CURRENT_LIMIT \| SR_CONF_GET \| SR_CONF_SET \| SR_CONF_LIST,
ab3e9c8a	36	SR_CONF_UNDER_VOLTAGE_CONDITION_THRESHOLD \| SR_CONF_GET \| SR_CONF_SET \| SR_CONF_LIST,
9890fb1f SBO	37	SR_CONF_LIMIT_SAMPLES \| SR_CONF_GET \| SR_CONF_SET,
9890fb1f SBO	38	};
c527132a	39
9890fb1f SBO	40	static GSList scan(struct sr_dev_driver di, GSList *options)
	41	{
	42	struct dev_context *devc;
	43	GSList *l;
	44	struct sr_dev_inst *sdi;
	45	const char conn, serialcomm;
	46	struct sr_config *src;
	47	struct sr_serial_dev_inst *serial;
ab3e9c8a	48	uint8_t reply[MSG_MAX_LEN];
9890fb1f SBO	49
	50	conn = NULL;
	51	serialcomm = NULL;
	52
	53	for (l = options; l; l = l->next) {
	54	src = l->data;
	55	switch (src->key) {
	56	case SR_CONF_CONN:
	57	conn = g_variant_get_string(src->data, NULL);
	58	break;
	59	case SR_CONF_SERIALCOMM:
	60	serialcomm = g_variant_get_string(src->data, NULL);
	61	break;
	62	}
	63	}
c527132a	64
9890fb1f SBO	65	if (!conn)
	66	return NULL;
	67	if (!serialcomm)
	68	serialcomm = "9600/8e1";
	69
	70	serial = sr_serial_dev_inst_new(conn, serialcomm);
	71	if (serial_open(serial, SERIAL_RDWR) != SR_OK)
	72	return NULL;
	73
	74	sdi = g_malloc0(sizeof(struct sr_dev_inst));
	75	sdi->status = SR_ST_INACTIVE;
	76	sdi->vendor = g_strdup("ZKETECH");
	77	sdi->model = g_strdup("EBD-USB");
	78	sdi->inst_type = SR_INST_SERIAL;
	79	sdi->conn = serial;
	80
ab3e9c8a KK	81	sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "V.VBUS");
	82	sr_channel_new(sdi, 1, SR_CHANNEL_ANALOG, TRUE, "I.VBUS");
	83	sr_channel_new(sdi, 2, SR_CHANNEL_ANALOG, TRUE, "V.D+");
	84	sr_channel_new(sdi, 3, SR_CHANNEL_ANALOG, TRUE, "V.D-");
9890fb1f SBO	85
	86	devc = g_malloc0(sizeof(struct dev_context));
	87	g_mutex_init(&devc->rw_mutex);
	88	devc->current_limit = 0;
ab3e9c8a	89	devc->voltage_limit = 0;
9890fb1f SBO	90	devc->running = FALSE;
	91	devc->load_activated = FALSE;
	92	sr_sw_limits_init(&devc->limits);
	93	sdi->priv = devc;
	94
	95	/* Starting device. */
330a32b2	96	ebd_init(serial, devc);
ab3e9c8a KK	97	int ret = ebd_read_message(serial, MSG_MAX_LEN, reply);
	98	if (ret < 0) {
	99	sr_warn("Could not receive message!");
	100	ret = SR_ERR;
	101	} else if (0 == ret) {
	102	sr_warn("No message received!");
9890fb1f SBO	103	ret = SR_ERR;
9890fb1f SBO	104	}
330a32b2	105	ebd_stop(serial, devc);
c527132a	106
9890fb1f	107	serial_close(serial);
c527132a	108
9890fb1f SBO	109	if (ret < 0)
9890fb1f SBO	110	return NULL;
c527132a	111
9890fb1f	112	return std_scan_complete(di, g_slist_append(NULL, sdi));
c527132a SBO	113	}
	114
	115	static int dev_close(struct sr_dev_inst *sdi)
	116	{
9890fb1f	117	struct dev_context *devc;
c527132a	118
9890fb1f SBO	119	devc = (sdi) ? sdi->priv : NULL;
	120	if (devc)
	121	g_mutex_clear(&devc->rw_mutex);
c527132a	122
9890fb1f	123	return std_serial_dev_close(sdi);
c527132a SBO	124	}
	125
	126	static int config_get(uint32_t key, GVariant **data,
	127	const struct sr_dev_inst sdi, const struct sr_channel_group cg)
	128	{
	129	int ret;
9890fb1f SBO	130	struct dev_context *devc;
9890fb1f SBO	131	float fvalue;
c527132a	132
c527132a SBO	133	(void)cg;
c527132a SBO	134
9890fb1f SBO	135	if (!sdi \|\| !data)
	136	return SR_ERR_ARG;
	137
	138	devc = sdi->priv;
	139
c527132a	140	switch (key) {
9890fb1f SBO	141	case SR_CONF_LIMIT_SAMPLES:
	142	case SR_CONF_LIMIT_MSEC:
	143	return sr_sw_limits_config_get(&devc->limits, key, data);
	144	case SR_CONF_CURRENT_LIMIT:
330a32b2	145	ret = ebd_get_current_limit(sdi, &fvalue);
9890fb1f SBO	146	if (ret == SR_OK)
	147	*data = g_variant_new_double(fvalue);
	148	return ret;
ab3e9c8a KK	149	case SR_CONF_UNDER_VOLTAGE_CONDITION_THRESHOLD:
	150	ret = ebd_get_voltage_limit(sdi, &fvalue);
	151	if (ret == SR_OK)
	152	*data = g_variant_new_double(fvalue);
	153	return ret;
c527132a SBO	154	default:
	155	return SR_ERR_NA;
	156	}
c527132a SBO	157	}
	158
	159	static int config_set(uint32_t key, GVariant *data,
	160	const struct sr_dev_inst sdi, const struct sr_channel_group cg)
	161	{
9890fb1f SBO	162	double value;
9890fb1f SBO	163	struct dev_context *devc;
c527132a	164
c527132a SBO	165	(void)data;
	166	(void)cg;
	167
9890fb1f SBO	168	devc = sdi->priv;
9890fb1f SBO	169
c527132a	170	switch (key) {
9890fb1f SBO	171	case SR_CONF_LIMIT_MSEC:
	172	case SR_CONF_LIMIT_SAMPLES:
	173	return sr_sw_limits_config_set(&devc->limits, key, data);
	174	case SR_CONF_CURRENT_LIMIT:
	175	value = g_variant_get_double(data);
	176	if (value < 0.0 \|\| value > 4.0)
	177	return SR_ERR_ARG;
330a32b2	178	return ebd_set_current_limit(sdi, value);
ab3e9c8a KK	179	case SR_CONF_UNDER_VOLTAGE_CONDITION_THRESHOLD:
	180	value = g_variant_get_double(data);
	181	if (value < 0.0 \|\| value > 21.0)
	182	return SR_ERR_ARG;
	183	return ebd_set_voltage_limit(sdi, value);
c527132a	184	default:
9890fb1f	185	return SR_ERR_NA;
c527132a	186	}
c527132a SBO	187	}
	188
	189	static int config_list(uint32_t key, GVariant **data,
	190	const struct sr_dev_inst sdi, const struct sr_channel_group cg)
	191	{
c527132a	192	switch (key) {
9890fb1f SBO	193	case SR_CONF_SCAN_OPTIONS:
	194	case SR_CONF_DEVICE_OPTIONS:
	195	return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts);
	196	case SR_CONF_CURRENT_LIMIT:
ab3e9c8a KK	197	*data = std_gvar_min_max_step(0.0, 4.0, 0.001);
	198	break;
	199	case SR_CONF_UNDER_VOLTAGE_CONDITION_THRESHOLD:
	200	*data = std_gvar_min_max_step(0.0, 21.0, 0.01);
9890fb1f	201	break;
c527132a SBO	202	default:
	203	return SR_ERR_NA;
	204	}
	205
9890fb1f	206	return SR_OK;
c527132a SBO	207	}
	208
	209	static int dev_acquisition_start(const struct sr_dev_inst *sdi)
	210	{
9890fb1f SBO	211	struct dev_context *devc;
	212	struct sr_serial_dev_inst *serial;
	213
	214	devc = sdi->priv;
	215	serial = sdi->conn;
	216
	217	sr_sw_limits_acquisition_start(&devc->limits);
	218	std_session_send_df_header(sdi);
c527132a	219
330a32b2	220	ebd_init(serial, devc);
9890fb1f SBO	221
9890fb1f SBO	222	serial_source_add(sdi->session, serial, G_IO_IN, 100,
330a32b2	223	ebd_receive_data, (void *)sdi);
c527132a SBO	224
	225	return SR_OK;
	226	}
	227
	228	static int dev_acquisition_stop(struct sr_dev_inst *sdi)
	229	{
ab3e9c8a KK	230	struct dev_context *devc;
	231
	232	if (sdi) {
	233	devc = sdi->priv;
	234	if (devc->load_activated) {
	235	ebd_loadtoggle(sdi->conn, devc);
	236	}
	237	ebd_stop(sdi->conn, devc);
	238	}
c527132a	239
9890fb1f	240	return std_serial_dev_acquisition_stop(sdi);
c527132a SBO	241	}
c527132a SBO	242
3f34a402	243	static struct sr_dev_driver zketech_ebd_usb_driver_info = {
c527132a SBO	244	.name = "zketech-ebd-usb",
	245	.longname = "ZKETECH EBD-USB",
	246	.api_version = 1,
	247	.init = std_init,
	248	.cleanup = std_cleanup,
	249	.scan = scan,
	250	.dev_list = std_dev_list,
	251	.dev_clear = std_dev_clear,
	252	.config_get = config_get,
	253	.config_set = config_set,
	254	.config_list = config_list,
9890fb1f	255	.dev_open = std_serial_dev_open,
c527132a SBO	256	.dev_close = dev_close,
	257	.dev_acquisition_start = dev_acquisition_start,
	258	.dev_acquisition_stop = dev_acquisition_stop,
	259	.context = NULL,
	260	};
c527132a	261	SR_REGISTER_DEV_DRIVER(zketech_ebd_usb_driver_info);