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

/*
 * This file is part of the libsigrok project.
 *
 * Copyright (C) 2012 Alexandru Gagniuc <mr.nuke.me@gmail.com>
 *
 * 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_MULTIMETER,
};

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

static GSList *brymen_scan(struct sr_dev_driver *di, const char *conn,
	const char *serialcomm)
{
	struct sr_dev_inst *sdi;
	struct dev_context *devc;
	struct sr_serial_dev_inst *serial;
	int rts_toggle_delay_us;
	GSList *devices;
	int ret;
	uint8_t buf[128];
	size_t len;

	serial = sr_serial_dev_inst_new(conn, serialcomm);

	if (serial_open(serial, SERIAL_RDWR) != SR_OK)
		return NULL;
	/*
	 * The device requires an RTS *pulse* before communication.
	 * The vendor's documentation recommends the following sequence:
	 * Open the COM port, wait for 100ms, set RTS=1, wait for 100ms,
	 * set RTS=0, wait for 100ms, set RTS=1, configure bitrate and
	 * frame format, transmit request data, receive response data.
	 */
	rts_toggle_delay_us = 100 * 1000; /* 100ms */
	g_usleep(rts_toggle_delay_us);
	serial_set_handshake(serial, 1, -1);
	g_usleep(rts_toggle_delay_us);
	serial_set_handshake(serial, 0, -1);
	g_usleep(rts_toggle_delay_us);
	serial_set_handshake(serial, 1, -1);
	g_usleep(rts_toggle_delay_us);

	sr_info("Probing port %s.", conn);

	devices = NULL;

	/* Request reading */
	if ((ret = brymen_packet_request(serial)) < 0) {
		sr_err("Unable to send command: %d.", ret);
		goto scan_cleanup;
	}

	len = sizeof(buf);
	ret = brymen_stream_detect(serial, buf, &len, brymen_packet_length,
			     brymen_packet_is_valid, 1000, 9600);
	if (ret != SR_OK)
		goto scan_cleanup;

	sr_info("Found device on port %s.", conn);

	sdi = g_malloc0(sizeof(struct sr_dev_inst));
	sdi->status = SR_ST_INACTIVE;
	sdi->vendor = g_strdup("Brymen");
	sdi->model = g_strdup("BM85x");
	devc = g_malloc0(sizeof(struct dev_context));
	sr_sw_limits_init(&devc->sw_limits);
	sdi->inst_type = SR_INST_SERIAL;
	sdi->conn = serial;
	sdi->priv = devc;
	sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "P1");
	devices = g_slist_append(devices, sdi);

scan_cleanup:
	serial_close(serial);

	return std_scan_complete(di, devices);
}

static GSList *scan(struct sr_dev_driver *di, GSList *options)
{
	struct sr_config *src;
	GSList *devices, *l;
	const char *conn, *serialcomm;

	devices = NULL;

	/*
	 * BEWARE! Default 'conn' is not desirable when the device cannot
	 * reliably get detected. Insist that users specify the port.
	 */
	conn = NULL;
	serialcomm = "9600/8n1/dtr=1/rts=1";
	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;

	devices = brymen_scan(di, conn, serialcomm);

	return devices;
}

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

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

	devc = sdi->priv;

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

	serial = sdi->conn;
	serial_source_add(sdi->session, serial, G_IO_IN, 50,
			brymen_dmm_receive_data, (void *)sdi);

	return SR_OK;
}

static struct sr_dev_driver brymen_bm857_driver_info = {
	.name = "brymen-bm857",
	.longname = "Brymen BM857",
	.api_version = 1,
	.init = std_init,
	.cleanup = std_cleanup,
	.scan = scan,
	.dev_list = std_dev_list,
	.dev_clear = std_dev_clear,
	.config_get = NULL,
	.config_set = config_set,
	.config_list = config_list,
	.dev_open = std_serial_dev_open,
	.dev_close = std_serial_dev_close,
	.dev_acquisition_start = dev_acquisition_start,
	.dev_acquisition_stop = std_serial_dev_acquisition_stop,
	.context = NULL,
};
SR_REGISTER_DEV_DRIVER(brymen_bm857_driver_info);
Commit	Line	Data
	1	/*
	2	* This file is part of the libsigrok project.
	3	*
	4	* Copyright (C) 2012 Alexandru Gagniuc <mr.nuke.me@gmail.com>
	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	static const uint32_t scanopts[] = {
	24	SR_CONF_CONN,
	25	SR_CONF_SERIALCOMM,
	26	};
	27
	28	static const uint32_t drvopts[] = {
	29	SR_CONF_MULTIMETER,
	30	};
	31
	32	static const uint32_t devopts[] = {
	33	SR_CONF_CONTINUOUS,
	34	SR_CONF_LIMIT_SAMPLES \| SR_CONF_SET,
	35	SR_CONF_LIMIT_MSEC \| SR_CONF_SET,
	36	};
	37
	38	static GSList brymen_scan(struct sr_dev_driver di, const char *conn,
	39	const char *serialcomm)
	40	{
	41	struct sr_dev_inst *sdi;
	42	struct dev_context *devc;
	43	struct sr_serial_dev_inst *serial;
	44	int rts_toggle_delay_us;
	45	GSList *devices;
	46	int ret;
	47	uint8_t buf[128];
	48	size_t len;
	49
	50	serial = sr_serial_dev_inst_new(conn, serialcomm);
	51
	52	if (serial_open(serial, SERIAL_RDWR) != SR_OK)
	53	return NULL;
	54	/*
	55	* The device requires an RTS pulse before communication.
	56	* The vendor's documentation recommends the following sequence:
	57	* Open the COM port, wait for 100ms, set RTS=1, wait for 100ms,
	58	* set RTS=0, wait for 100ms, set RTS=1, configure bitrate and
	59	* frame format, transmit request data, receive response data.
	60	*/
	61	rts_toggle_delay_us = 100 * 1000; /* 100ms */
	62	g_usleep(rts_toggle_delay_us);
	63	serial_set_handshake(serial, 1, -1);
	64	g_usleep(rts_toggle_delay_us);
	65	serial_set_handshake(serial, 0, -1);
	66	g_usleep(rts_toggle_delay_us);
	67	serial_set_handshake(serial, 1, -1);
	68	g_usleep(rts_toggle_delay_us);
	69
	70	sr_info("Probing port %s.", conn);
	71
	72	devices = NULL;
	73
	74	/* Request reading */
	75	if ((ret = brymen_packet_request(serial)) < 0) {
	76	sr_err("Unable to send command: %d.", ret);
	77	goto scan_cleanup;
	78	}
	79
	80	len = sizeof(buf);
	81	ret = brymen_stream_detect(serial, buf, &len, brymen_packet_length,
	82	brymen_packet_is_valid, 1000, 9600);
	83	if (ret != SR_OK)
	84	goto scan_cleanup;
	85
	86	sr_info("Found device on port %s.", conn);
	87
	88	sdi = g_malloc0(sizeof(struct sr_dev_inst));
	89	sdi->status = SR_ST_INACTIVE;
	90	sdi->vendor = g_strdup("Brymen");
	91	sdi->model = g_strdup("BM85x");
	92	devc = g_malloc0(sizeof(struct dev_context));
	93	sr_sw_limits_init(&devc->sw_limits);
	94	sdi->inst_type = SR_INST_SERIAL;
	95	sdi->conn = serial;
	96	sdi->priv = devc;
	97	sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "P1");
	98	devices = g_slist_append(devices, sdi);
	99
	100	scan_cleanup:
	101	serial_close(serial);
	102
	103	return std_scan_complete(di, devices);
	104	}
	105
	106	static GSList scan(struct sr_dev_driver di, GSList *options)
	107	{
	108	struct sr_config *src;
	109	GSList devices, l;
	110	const char conn, serialcomm;
	111
	112	devices = NULL;
	113
	114	/*
	115	* BEWARE! Default 'conn' is not desirable when the device cannot
	116	* reliably get detected. Insist that users specify the port.
	117	*/
	118	conn = NULL;
	119	serialcomm = "9600/8n1/dtr=1/rts=1";
	120	for (l = options; l; l = l->next) {
	121	src = l->data;
	122	switch (src->key) {
	123	case SR_CONF_CONN:
	124	conn = g_variant_get_string(src->data, NULL);
	125	break;
	126	case SR_CONF_SERIALCOMM:
	127	serialcomm = g_variant_get_string(src->data, NULL);
	128	break;
	129	}
	130	}
	131	if (!conn)
	132	return NULL;
	133
	134	devices = brymen_scan(di, conn, serialcomm);
	135
	136	return devices;
	137	}
	138
	139	static int config_set(uint32_t key, GVariant *data,
	140	const struct sr_dev_inst sdi, const struct sr_channel_group cg)
	141	{
	142	struct dev_context *devc;
	143
	144	(void)cg;
	145
	146	devc = sdi->priv;
	147
	148	return sr_sw_limits_config_set(&devc->sw_limits, key, data);
	149	}
	150
	151	static int config_list(uint32_t key, GVariant **data,
	152	const struct sr_dev_inst sdi, const struct sr_channel_group cg)
	153	{
	154	return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts);
	155	}
	156
	157	static int dev_acquisition_start(const struct sr_dev_inst *sdi)
	158	{
	159	struct dev_context *devc;
	160	struct sr_serial_dev_inst *serial;
	161
	162	devc = sdi->priv;
	163
	164	sr_sw_limits_acquisition_start(&devc->sw_limits);
	165	std_session_send_df_header(sdi);
	166
	167	serial = sdi->conn;
	168	serial_source_add(sdi->session, serial, G_IO_IN, 50,
	169	brymen_dmm_receive_data, (void *)sdi);
	170
	171	return SR_OK;
	172	}
	173
	174	static struct sr_dev_driver brymen_bm857_driver_info = {
	175	.name = "brymen-bm857",
	176	.longname = "Brymen BM857",
	177	.api_version = 1,
	178	.init = std_init,
	179	.cleanup = std_cleanup,
	180	.scan = scan,
	181	.dev_list = std_dev_list,
	182	.dev_clear = std_dev_clear,
	183	.config_get = NULL,
	184	.config_set = config_set,
	185	.config_list = config_list,
	186	.dev_open = std_serial_dev_open,
	187	.dev_close = std_serial_dev_close,
	188	.dev_acquisition_start = dev_acquisition_start,
	189	.dev_acquisition_stop = std_serial_dev_acquisition_stop,
	190	.context = NULL,
	191	};
	192	SR_REGISTER_DEV_DRIVER(brymen_bm857_driver_info);