[libsigrok.git] / src / hardware / brymen-bm86x / api.c

/*
 * This file is part of the libsigrok project.
 *
 * Copyright (C) 2014 Aurelien Jacobs <aurel@gnuage.org>
 *
 * 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"

#define BRYMEN_BC86X "0820.0001"

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

static const uint32_t devopts[] = {
	SR_CONF_MULTIMETER,
	SR_CONF_CONTINUOUS,
	SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
	SR_CONF_LIMIT_MSEC | SR_CONF_GET | SR_CONF_SET,
};

static GSList *scan(struct sr_dev_driver *di, GSList *options)
{
	GSList *usb_devices, *devices, *l;
	struct drv_context *drvc;
	struct dev_context *devc;
	struct sr_dev_inst *sdi;
	struct sr_usb_dev_inst *usb;
	struct sr_config *src;
	const char *conn;

	drvc = di->context;

	conn = BRYMEN_BC86X;
	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;
		}
	}

	devices = NULL;
	if (!(usb_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, conn))) {
		g_slist_free_full(usb_devices, g_free);
		return NULL;
	}

	for (l = usb_devices; l; l = l->next) {
		usb = l->data;

		sdi = g_malloc0(sizeof(struct sr_dev_inst));
		sdi->status = SR_ST_INACTIVE;
		sdi->vendor = g_strdup("Brymen");
		sdi->model = g_strdup("BM869");
		devc = g_malloc0(sizeof(struct dev_context));
		sdi->priv = devc;
		sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "P1");
		sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "P2");

		sdi->inst_type = SR_INST_USB;
		sdi->conn = usb;

		sr_sw_limits_init(&devc->sw_limits);

		devices = g_slist_append(devices, sdi);
	}

	return std_scan_complete(di, devices);
}

static int dev_open(struct sr_dev_inst *sdi)
{
	struct sr_dev_driver *di = sdi->driver;
	struct drv_context *drvc = di->context;
	struct sr_usb_dev_inst *usb;
	struct dev_context *devc;
	int ret;

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

	if ((ret = sr_usb_open(drvc->sr_ctx->libusb_ctx, usb)) == SR_OK)
		sdi->status = SR_ST_ACTIVE;
	else
		return SR_ERR;

	/* Detach kernel drivers which grabbed this device (if any). */
	if (libusb_kernel_driver_active(usb->devhdl, 0) == 1) {
		ret = libusb_detach_kernel_driver(usb->devhdl, 0);
		if (ret < 0) {
			sr_err("Failed to detach kernel driver: %s.",
			       libusb_error_name(ret));
			return SR_ERR;
		}
		devc->detached_kernel_driver = 1;
		sr_dbg("Successfully detached kernel driver.");
	} else {
		sr_dbg("No need to detach a kernel driver.");
	}

	/* Claim interface 0. */
	if ((ret = libusb_claim_interface(usb->devhdl, 0)) < 0) {
		sr_err("Failed to claim interface 0: %s.",
		       libusb_error_name(ret));
		return SR_ERR;
	}
	sr_dbg("Successfully claimed interface 0.");

	return ret;
}

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

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

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

	if ((ret = libusb_release_interface(usb->devhdl, 0)))
		sr_err("Failed to release interface 0: %s.\n", libusb_error_name(ret));
	else
		sr_dbg("Successfully released interface 0.\n");

	if (!ret && devc->detached_kernel_driver) {
		if ((ret = libusb_attach_kernel_driver(usb->devhdl, 0))) {
			sr_err("Failed to attach kernel driver: %s.\n",
			       libusb_error_name(ret));
		} else {
			devc->detached_kernel_driver = 0;
			sr_dbg("Successfully attached kernel driver.\n");
		}
	}

	libusb_close(usb->devhdl);

	sdi->status = SR_ST_INACTIVE;

	return ret;
}

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 = sdi->priv;

	(void)cg;

	return sr_sw_limits_config_get(&devc->sw_limits, key, data);
}

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;

	devc = sdi->priv;

	return sr_sw_limits_config_set(&devc->sw_limits, key, data);
}

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));
		break;
	case SR_CONF_DEVICE_OPTIONS:
		*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
				devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
		break;
	default:
		return SR_ERR_NA;
	}

	return SR_OK;
}

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

	devc = sdi->priv;

	sr_sw_limits_acquisition_start(&devc->sw_limits);

	std_session_send_df_header(sdi);

	sr_session_source_add(sdi->session, -1, 0, 10,
			brymen_bm86x_receive_data, (void *)sdi);

	return SR_OK;
}

static int dev_acquisition_stop(struct sr_dev_inst *sdi)
{
	std_session_send_df_end(sdi);

	sr_session_source_remove(sdi->session, -1);

	return SR_OK;
}

static struct sr_dev_driver brymen_bm86x_driver_info = {
	.name = "brymen-bm86x",
	.longname = "Brymen BM86X",
	.api_version = 1,
	.init = std_init,
	.cleanup = std_cleanup,
	.scan = scan,
	.dev_list = std_dev_list,
	.dev_clear = NULL,
	.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(brymen_bm86x_driver_info);
Commit	Line	Data
	1	/*
	2	* This file is part of the libsigrok project.
	3	*
	4	* Copyright (C) 2014 Aurelien Jacobs <aurel@gnuage.org>
	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
	20	#include <config.h>
	21	#include "protocol.h"
	22
	23	#define BRYMEN_BC86X "0820.0001"
	24
	25	static const uint32_t scanopts[] = {
	26	SR_CONF_CONN,
	27	};
	28
	29	static const uint32_t devopts[] = {
	30	SR_CONF_MULTIMETER,
	31	SR_CONF_CONTINUOUS,
	32	SR_CONF_LIMIT_SAMPLES \| SR_CONF_GET \| SR_CONF_SET,
	33	SR_CONF_LIMIT_MSEC \| SR_CONF_GET \| SR_CONF_SET,
	34	};
	35
	36	static GSList scan(struct sr_dev_driver di, GSList *options)
	37	{
	38	GSList usb_devices, devices, *l;
	39	struct drv_context *drvc;
	40	struct dev_context *devc;
	41	struct sr_dev_inst *sdi;
	42	struct sr_usb_dev_inst *usb;
	43	struct sr_config *src;
	44	const char *conn;
	45
	46	drvc = di->context;
	47
	48	conn = BRYMEN_BC86X;
	49	for (l = options; l; l = l->next) {
	50	src = l->data;
	51	switch (src->key) {
	52	case SR_CONF_CONN:
	53	conn = g_variant_get_string(src->data, NULL);
	54	break;
	55	}
	56	}
	57
	58	devices = NULL;
	59	if (!(usb_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, conn))) {
	60	g_slist_free_full(usb_devices, g_free);
	61	return NULL;
	62	}
	63
	64	for (l = usb_devices; l; l = l->next) {
	65	usb = l->data;
	66
	67	sdi = g_malloc0(sizeof(struct sr_dev_inst));
	68	sdi->status = SR_ST_INACTIVE;
	69	sdi->vendor = g_strdup("Brymen");
	70	sdi->model = g_strdup("BM869");
	71	devc = g_malloc0(sizeof(struct dev_context));
	72	sdi->priv = devc;
	73	sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "P1");
	74	sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "P2");
	75
	76	sdi->inst_type = SR_INST_USB;
	77	sdi->conn = usb;
	78
	79	sr_sw_limits_init(&devc->sw_limits);
	80
	81	devices = g_slist_append(devices, sdi);
	82	}
	83
	84	return std_scan_complete(di, devices);
	85	}
	86
	87	static int dev_open(struct sr_dev_inst *sdi)
	88	{
	89	struct sr_dev_driver *di = sdi->driver;
	90	struct drv_context *drvc = di->context;
	91	struct sr_usb_dev_inst *usb;
	92	struct dev_context *devc;
	93	int ret;
	94
	95	usb = sdi->conn;
	96	devc = sdi->priv;
	97
	98	if ((ret = sr_usb_open(drvc->sr_ctx->libusb_ctx, usb)) == SR_OK)
	99	sdi->status = SR_ST_ACTIVE;
	100	else
	101	return SR_ERR;
	102
	103	/* Detach kernel drivers which grabbed this device (if any). */
	104	if (libusb_kernel_driver_active(usb->devhdl, 0) == 1) {
	105	ret = libusb_detach_kernel_driver(usb->devhdl, 0);
	106	if (ret < 0) {
	107	sr_err("Failed to detach kernel driver: %s.",
	108	libusb_error_name(ret));
	109	return SR_ERR;
	110	}
	111	devc->detached_kernel_driver = 1;
	112	sr_dbg("Successfully detached kernel driver.");
	113	} else {
	114	sr_dbg("No need to detach a kernel driver.");
	115	}
	116
	117	/* Claim interface 0. */
	118	if ((ret = libusb_claim_interface(usb->devhdl, 0)) < 0) {
	119	sr_err("Failed to claim interface 0: %s.",
	120	libusb_error_name(ret));
	121	return SR_ERR;
	122	}
	123	sr_dbg("Successfully claimed interface 0.");
	124
	125	return ret;
	126	}
	127
	128	static int dev_close(struct sr_dev_inst *sdi)
	129	{
	130	struct sr_usb_dev_inst *usb;
	131	struct dev_context *devc;
	132	int ret;
	133
	134	if (sdi->status != SR_ST_ACTIVE)
	135	return SR_ERR_DEV_CLOSED;
	136
	137	usb = sdi->conn;
	138	devc = sdi->priv;
	139
	140	if ((ret = libusb_release_interface(usb->devhdl, 0)))
	141	sr_err("Failed to release interface 0: %s.\n", libusb_error_name(ret));
	142	else
	143	sr_dbg("Successfully released interface 0.\n");
	144
	145	if (!ret && devc->detached_kernel_driver) {
	146	if ((ret = libusb_attach_kernel_driver(usb->devhdl, 0))) {
	147	sr_err("Failed to attach kernel driver: %s.\n",
	148	libusb_error_name(ret));
	149	} else {
	150	devc->detached_kernel_driver = 0;
	151	sr_dbg("Successfully attached kernel driver.\n");
	152	}
	153	}
	154
	155	libusb_close(usb->devhdl);
	156
	157	sdi->status = SR_ST_INACTIVE;
	158
	159	return ret;
	160	}
	161
	162	static int config_get(uint32_t key, GVariant *data, const struct sr_dev_inst sdi,
	163	const struct sr_channel_group *cg)
	164	{
	165	struct dev_context *devc = sdi->priv;
	166
	167	(void)cg;
	168
	169	return sr_sw_limits_config_get(&devc->sw_limits, key, data);
	170	}
	171
	172	static int config_set(uint32_t key, GVariant data, const struct sr_dev_inst sdi,
	173	const struct sr_channel_group *cg)
	174	{
	175	struct dev_context *devc;
	176
	177	(void)cg;
	178
	179	devc = sdi->priv;
	180
	181	return sr_sw_limits_config_set(&devc->sw_limits, key, data);
	182	}
	183
	184	static int config_list(uint32_t key, GVariant *data, const struct sr_dev_inst sdi,
	185	const struct sr_channel_group *cg)
	186	{
	187	(void)sdi;
	188	(void)cg;
	189
	190	switch (key) {
	191	case SR_CONF_SCAN_OPTIONS:
	192	*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
	193	scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
	194	break;
	195	case SR_CONF_DEVICE_OPTIONS:
	196	*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
	197	devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
	198	break;
	199	default:
	200	return SR_ERR_NA;
	201	}
	202
	203	return SR_OK;
	204	}
	205
	206	static int dev_acquisition_start(const struct sr_dev_inst *sdi)
	207	{
	208	struct dev_context *devc;
	209
	210	devc = sdi->priv;
	211
	212	sr_sw_limits_acquisition_start(&devc->sw_limits);
	213
	214	std_session_send_df_header(sdi);
	215
	216	sr_session_source_add(sdi->session, -1, 0, 10,
	217	brymen_bm86x_receive_data, (void *)sdi);
	218
	219	return SR_OK;
	220	}
	221
	222	static int dev_acquisition_stop(struct sr_dev_inst *sdi)
	223	{
	224	std_session_send_df_end(sdi);
	225
	226	sr_session_source_remove(sdi->session, -1);
	227
	228	return SR_OK;
	229	}
	230
	231	static struct sr_dev_driver brymen_bm86x_driver_info = {
	232	.name = "brymen-bm86x",
	233	.longname = "Brymen BM86X",
	234	.api_version = 1,
	235	.init = std_init,
	236	.cleanup = std_cleanup,
	237	.scan = scan,
	238	.dev_list = std_dev_list,
	239	.dev_clear = NULL,
	240	.config_get = config_get,
	241	.config_set = config_set,
	242	.config_list = config_list,
	243	.dev_open = dev_open,
	244	.dev_close = dev_close,
	245	.dev_acquisition_start = dev_acquisition_start,
	246	.dev_acquisition_stop = dev_acquisition_stop,
	247	.context = NULL,
	248	};
	249	SR_REGISTER_DEV_DRIVER(brymen_bm86x_driver_info);