[libsigrok.git] / hardware / mic-985xx / api.c

/*
 * This file is part of the libsigrok project.
 *
 * Copyright (C) 2013 Uwe Hermann <uwe@hermann-uwe.de>
 *
 * 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 2 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, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
 */

#include "protocol.h"

static const int hwopts[] = {
	SR_CONF_CONN,
	SR_CONF_SERIALCOMM,
	0,
};

static const int hwcaps[] = {
	SR_CONF_THERMOMETER,
	SR_CONF_HYGROMETER,
	SR_CONF_LIMIT_SAMPLES,
	SR_CONF_LIMIT_MSEC,
	SR_CONF_CONTINUOUS,
	0,
};

SR_PRIV struct sr_dev_driver mic_98583_driver_info;

SR_PRIV const struct mic_dev_info mic_devs[] = {
	{
		"MIC", "98583", "38400/8n2", 32000, TRUE, TRUE,
		&mic_98583_driver_info, receive_data_MIC_98583,
	},
};

static int clear_instances(int idx)
{
	struct sr_dev_inst *sdi;
	struct drv_context *drvc;
	struct dev_context *devc;
	GSList *l;
	struct sr_dev_driver *di;

	di = mic_devs[idx].di;

	if (!(drvc = di->priv))
		return SR_OK;

	for (l = drvc->instances; l; l = l->next) {
		if (!(sdi = l->data))
			continue;
		if (!(devc = sdi->priv))
			continue;
		sr_serial_dev_inst_free(devc->serial);
		sr_dev_inst_free(sdi);
	}

	g_slist_free(drvc->instances);
	drvc->instances = NULL;

	return SR_OK;
}

static int hw_init(struct sr_context *sr_ctx, int idx)
{
	sr_dbg("Selected '%s' subdriver.", mic_devs[idx].di->name);

	return std_hw_init(sr_ctx, mic_devs[idx].di, DRIVER_LOG_DOMAIN);
}

static GSList *scan(const char *conn, const char *serialcomm, int idx)
{
	struct sr_dev_inst *sdi;
	struct drv_context *drvc;
	struct dev_context *devc;
	struct sr_probe *probe;
	struct sr_serial_dev_inst *serial;
	GSList *devices;

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

	if (serial_open(serial, SERIAL_RDWR | SERIAL_NONBLOCK) != SR_OK)
		return NULL;

	drvc = mic_devs[idx].di->priv;
	devices = NULL;
	serial_flush(serial);

	/* TODO: Query device type. */
	// ret = mic_cmd_get_device_info(serial);

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

	/* TODO: Fill in version from protocol response. */
	if (!(sdi = sr_dev_inst_new(0, SR_ST_INACTIVE, mic_devs[idx].vendor,
				    mic_devs[idx].device, "")))
		goto scan_cleanup;

	if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) {
		sr_err("Device context malloc failed.");
		goto scan_cleanup;
	}

	devc->serial = serial;

	sdi->priv = devc;
	sdi->driver = mic_devs[idx].di;

	if (!(probe = sr_probe_new(0, SR_PROBE_ANALOG, TRUE, "Temperature")))
		goto scan_cleanup;
	sdi->probes = g_slist_append(sdi->probes, probe);

	if (!(probe = sr_probe_new(1, SR_PROBE_ANALOG, TRUE, "Humidity")))
		goto scan_cleanup;
	sdi->probes = g_slist_append(sdi->probes, probe);

	drvc->instances = g_slist_append(drvc->instances, sdi);
	devices = g_slist_append(devices, sdi);

scan_cleanup:
	serial_close(serial);

	return devices;
}

static GSList *hw_scan(GSList *options, int idx)
{
	struct sr_config *src;
	GSList *l, *devices;
	const char *conn, *serialcomm;

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

	if (serialcomm) {
		/* Use the provided comm specs. */
		devices = scan(conn, serialcomm, idx);
	} else {
		/* Try the default. */
		devices = scan(conn, mic_devs[idx].conn, idx);
	}

	return devices;
}

static GSList *hw_dev_list(int idx)
{
	return ((struct drv_context *)(mic_devs[idx].di->priv))->instances;
}

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

	devc = sdi->priv;

	if (serial_open(devc->serial, SERIAL_RDWR | SERIAL_NONBLOCK) != SR_OK)
		return SR_ERR;

	sdi->status = SR_ST_ACTIVE;

	return SR_OK;
}

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

	devc = sdi->priv;

	if (devc->serial && devc->serial->fd != -1) {
		serial_close(devc->serial);
		sdi->status = SR_ST_INACTIVE;
	}

	return SR_OK;
}

static int hw_cleanup(int idx)
{
	clear_instances(idx);

	return SR_OK;
}

static int config_set(int id, const void *value, const struct sr_dev_inst *sdi)
{
	struct dev_context *devc;

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

	devc = sdi->priv;

	switch (id) {
	case SR_CONF_LIMIT_SAMPLES:
		devc->limit_samples = *(const uint64_t *)value;
		sr_dbg("Setting sample limit to %" PRIu64 ".",
		       devc->limit_samples);
		break;
	case SR_CONF_LIMIT_MSEC:
		devc->limit_msec = *(const uint64_t *)value;
		sr_dbg("Setting time limit to %" PRIu64 "ms.",
		       devc->limit_msec);
		break;
	default:
		sr_err("Unknown config: %d.", id);
		return SR_ERR_ARG;
	}

	return SR_OK;
}

static int config_list(int key, const void **data, const struct sr_dev_inst *sdi)
{
	(void)sdi;

	switch (key) {
	case SR_CONF_SCAN_OPTIONS:
		*data = hwopts;
		break;
	case SR_CONF_DEVICE_OPTIONS:
		*data = hwcaps;
		break;
	default:
		return SR_ERR_ARG;
	}

	return SR_OK;
}

static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
				    void *cb_data, int idx)
{
	struct dev_context *devc;

	devc = sdi->priv;

	devc->cb_data = cb_data;

	devc->num_samples = 0;
	devc->starttime = g_get_monotonic_time();

	/* Send header packet to the session bus. */
	std_session_send_df_header(cb_data, DRIVER_LOG_DOMAIN);

	/* Poll every 100ms, or whenever some data comes in. */
	sr_source_add(devc->serial->fd, G_IO_IN, 100,
		      mic_devs[idx].receive_data, (void *)sdi);

	return SR_OK;
}

static int hw_dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
{
	return std_hw_dev_acquisition_stop_serial(sdi, cb_data, hw_dev_close,
	       ((struct dev_context *)(sdi->priv))->serial, DRIVER_LOG_DOMAIN);
}

/* Driver-specific API function wrappers */
#define HW_INIT(X) \
static int hw_init_##X(struct sr_context *sr_ctx) { return hw_init(sr_ctx, X); }
#define HW_CLEANUP(X) \
static int hw_cleanup_##X(void) { return hw_cleanup(X); }
#define HW_SCAN(X) \
static GSList *hw_scan_##X(GSList *options) { return hw_scan(options, X); }
#define HW_DEV_LIST(X) \
static GSList *hw_dev_list_##X(void) { return hw_dev_list(X); }
#define CLEAR_INSTANCES(X) \
static int clear_instances_##X(void) { return clear_instances(X); }
#define HW_DEV_ACQUISITION_START(X) \
static int hw_dev_acquisition_start_##X(const struct sr_dev_inst *sdi, \
void *cb_data) { return hw_dev_acquisition_start(sdi, cb_data, X); }

/* Driver structs and API function wrappers */
#define DRV(ID, ID_UPPER, NAME, LONGNAME) \
HW_INIT(ID_UPPER) \
HW_CLEANUP(ID_UPPER) \
HW_SCAN(ID_UPPER) \
HW_DEV_LIST(ID_UPPER) \
CLEAR_INSTANCES(ID_UPPER) \
HW_DEV_ACQUISITION_START(ID_UPPER) \
SR_PRIV struct sr_dev_driver ID##_driver_info = { \
	.name = NAME, \
	.longname = LONGNAME, \
	.api_version = 1, \
	.init = hw_init_##ID_UPPER, \
	.cleanup = hw_cleanup_##ID_UPPER, \
	.scan = hw_scan_##ID_UPPER, \
	.dev_list = hw_dev_list_##ID_UPPER, \
	.dev_clear = clear_instances_##ID_UPPER, \
	.config_get = NULL, \
	.config_set = config_set, \
	.config_list = config_list, \
	.dev_open = hw_dev_open, \
	.dev_close = hw_dev_close, \
	.dev_acquisition_start = hw_dev_acquisition_start_##ID_UPPER, \
	.dev_acquisition_stop = hw_dev_acquisition_stop, \
	.priv = NULL, \
};

DRV(mic_98583, MIC_98583, "mic-98583", "MIC 98583")
Commit	Line	Data
	1	/*
	2	* This file is part of the libsigrok project.
	3	*
	4	* Copyright (C) 2013 Uwe Hermann <uwe@hermann-uwe.de>
	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 2 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, write to the Free Software
	18	* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
	19	*/
	20
	21	#include "protocol.h"
	22
	23	static const int hwopts[] = {
	24	SR_CONF_CONN,
	25	SR_CONF_SERIALCOMM,
	26	0,
	27	};
	28
	29	static const int hwcaps[] = {
	30	SR_CONF_THERMOMETER,
	31	SR_CONF_HYGROMETER,
	32	SR_CONF_LIMIT_SAMPLES,
	33	SR_CONF_LIMIT_MSEC,
	34	SR_CONF_CONTINUOUS,
	35	0,
	36	};
	37
	38	SR_PRIV struct sr_dev_driver mic_98583_driver_info;
	39
	40	SR_PRIV const struct mic_dev_info mic_devs[] = {
	41	{
	42	"MIC", "98583", "38400/8n2", 32000, TRUE, TRUE,
	43	&mic_98583_driver_info, receive_data_MIC_98583,
	44	},
	45	};
	46
	47	static int clear_instances(int idx)
	48	{
	49	struct sr_dev_inst *sdi;
	50	struct drv_context *drvc;
	51	struct dev_context *devc;
	52	GSList *l;
	53	struct sr_dev_driver *di;
	54
	55	di = mic_devs[idx].di;
	56
	57	if (!(drvc = di->priv))
	58	return SR_OK;
	59
	60	for (l = drvc->instances; l; l = l->next) {
	61	if (!(sdi = l->data))
	62	continue;
	63	if (!(devc = sdi->priv))
	64	continue;
	65	sr_serial_dev_inst_free(devc->serial);
	66	sr_dev_inst_free(sdi);
	67	}
	68
	69	g_slist_free(drvc->instances);
	70	drvc->instances = NULL;
	71
	72	return SR_OK;
	73	}
	74
	75	static int hw_init(struct sr_context *sr_ctx, int idx)
	76	{
	77	sr_dbg("Selected '%s' subdriver.", mic_devs[idx].di->name);
	78
	79	return std_hw_init(sr_ctx, mic_devs[idx].di, DRIVER_LOG_DOMAIN);
	80	}
	81
	82	static GSList scan(const char conn, const char *serialcomm, int idx)
	83	{
	84	struct sr_dev_inst *sdi;
	85	struct drv_context *drvc;
	86	struct dev_context *devc;
	87	struct sr_probe *probe;
	88	struct sr_serial_dev_inst *serial;
	89	GSList *devices;
	90
	91	if (!(serial = sr_serial_dev_inst_new(conn, serialcomm)))
	92	return NULL;
	93
	94	if (serial_open(serial, SERIAL_RDWR \| SERIAL_NONBLOCK) != SR_OK)
	95	return NULL;
	96
	97	drvc = mic_devs[idx].di->priv;
	98	devices = NULL;
	99	serial_flush(serial);
	100
	101	/* TODO: Query device type. */
	102	// ret = mic_cmd_get_device_info(serial);
	103
	104	sr_info("Found device on port %s.", conn);
	105
	106	/* TODO: Fill in version from protocol response. */
	107	if (!(sdi = sr_dev_inst_new(0, SR_ST_INACTIVE, mic_devs[idx].vendor,
	108	mic_devs[idx].device, "")))
	109	goto scan_cleanup;
	110
	111	if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) {
	112	sr_err("Device context malloc failed.");
	113	goto scan_cleanup;
	114	}
	115
	116	devc->serial = serial;
	117
	118	sdi->priv = devc;
	119	sdi->driver = mic_devs[idx].di;
	120
	121	if (!(probe = sr_probe_new(0, SR_PROBE_ANALOG, TRUE, "Temperature")))
	122	goto scan_cleanup;
	123	sdi->probes = g_slist_append(sdi->probes, probe);
	124
	125	if (!(probe = sr_probe_new(1, SR_PROBE_ANALOG, TRUE, "Humidity")))
	126	goto scan_cleanup;
	127	sdi->probes = g_slist_append(sdi->probes, probe);
	128
	129	drvc->instances = g_slist_append(drvc->instances, sdi);
	130	devices = g_slist_append(devices, sdi);
	131
	132	scan_cleanup:
	133	serial_close(serial);
	134
	135	return devices;
	136	}
	137
	138	static GSList hw_scan(GSList options, int idx)
	139	{
	140	struct sr_config *src;
	141	GSList l, devices;
	142	const char conn, serialcomm;
	143
	144	conn = serialcomm = NULL;
	145	for (l = options; l; l = l->next) {
	146	src = l->data;
	147	switch (src->key) {
	148	case SR_CONF_CONN:
	149	conn = src->value;
	150	break;
	151	case SR_CONF_SERIALCOMM:
	152	serialcomm = src->value;
	153	break;
	154	}
	155	}
	156	if (!conn)
	157	return NULL;
	158
	159	if (serialcomm) {
	160	/* Use the provided comm specs. */
	161	devices = scan(conn, serialcomm, idx);
	162	} else {
	163	/* Try the default. */
	164	devices = scan(conn, mic_devs[idx].conn, idx);
	165	}
	166
	167	return devices;
	168	}
	169
	170	static GSList *hw_dev_list(int idx)
	171	{
	172	return ((struct drv_context *)(mic_devs[idx].di->priv))->instances;
	173	}
	174
	175	static int hw_dev_open(struct sr_dev_inst *sdi)
	176	{
	177	struct dev_context *devc;
	178
	179	devc = sdi->priv;
	180
	181	if (serial_open(devc->serial, SERIAL_RDWR \| SERIAL_NONBLOCK) != SR_OK)
	182	return SR_ERR;
	183
	184	sdi->status = SR_ST_ACTIVE;
	185
	186	return SR_OK;
	187	}
	188
	189	static int hw_dev_close(struct sr_dev_inst *sdi)
	190	{
	191	struct dev_context *devc;
	192
	193	devc = sdi->priv;
	194
	195	if (devc->serial && devc->serial->fd != -1) {
	196	serial_close(devc->serial);
	197	sdi->status = SR_ST_INACTIVE;
	198	}
	199
	200	return SR_OK;
	201	}
	202
	203	static int hw_cleanup(int idx)
	204	{
	205	clear_instances(idx);
	206
	207	return SR_OK;
	208	}
	209
	210	static int config_set(int id, const void value, const struct sr_dev_inst sdi)
	211	{
	212	struct dev_context *devc;
	213
	214	if (sdi->status != SR_ST_ACTIVE)
	215	return SR_ERR;
	216
	217	devc = sdi->priv;
	218
	219	switch (id) {
	220	case SR_CONF_LIMIT_SAMPLES:
	221	devc->limit_samples = (const uint64_t )value;
	222	sr_dbg("Setting sample limit to %" PRIu64 ".",
	223	devc->limit_samples);
	224	break;
	225	case SR_CONF_LIMIT_MSEC:
	226	devc->limit_msec = (const uint64_t )value;
	227	sr_dbg("Setting time limit to %" PRIu64 "ms.",
	228	devc->limit_msec);
	229	break;
	230	default:
	231	sr_err("Unknown config: %d.", id);
	232	return SR_ERR_ARG;
	233	}
	234
	235	return SR_OK;
	236	}
	237
	238	static int config_list(int key, const void *data, const struct sr_dev_inst sdi)
	239	{
	240	(void)sdi;
	241
	242	switch (key) {
	243	case SR_CONF_SCAN_OPTIONS:
	244	*data = hwopts;
	245	break;
	246	case SR_CONF_DEVICE_OPTIONS:
	247	*data = hwcaps;
	248	break;
	249	default:
	250	return SR_ERR_ARG;
	251	}
	252
	253	return SR_OK;
	254	}
	255
	256	static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
	257	void *cb_data, int idx)
	258	{
	259	struct dev_context *devc;
	260
	261	devc = sdi->priv;
	262
	263	devc->cb_data = cb_data;
	264
	265	devc->num_samples = 0;
	266	devc->starttime = g_get_monotonic_time();
	267
	268	/* Send header packet to the session bus. */
	269	std_session_send_df_header(cb_data, DRIVER_LOG_DOMAIN);
	270
	271	/* Poll every 100ms, or whenever some data comes in. */
	272	sr_source_add(devc->serial->fd, G_IO_IN, 100,
	273	mic_devs[idx].receive_data, (void *)sdi);
	274
	275	return SR_OK;
	276	}
	277
	278	static int hw_dev_acquisition_stop(struct sr_dev_inst sdi, void cb_data)
	279	{
	280	return std_hw_dev_acquisition_stop_serial(sdi, cb_data, hw_dev_close,
	281	((struct dev_context *)(sdi->priv))->serial, DRIVER_LOG_DOMAIN);
	282	}
	283
	284	/* Driver-specific API function wrappers */
	285	#define HW_INIT(X) \
	286	static int hw_init_##X(struct sr_context *sr_ctx) { return hw_init(sr_ctx, X); }
	287	#define HW_CLEANUP(X) \
	288	static int hw_cleanup_##X(void) { return hw_cleanup(X); }
	289	#define HW_SCAN(X) \
	290	static GSList hw_scan_##X(GSList options) { return hw_scan(options, X); }
	291	#define HW_DEV_LIST(X) \
	292	static GSList *hw_dev_list_##X(void) { return hw_dev_list(X); }
	293	#define CLEAR_INSTANCES(X) \
	294	static int clear_instances_##X(void) { return clear_instances(X); }
	295	#define HW_DEV_ACQUISITION_START(X) \
	296	static int hw_dev_acquisition_start_##X(const struct sr_dev_inst *sdi, \
	297	void *cb_data) { return hw_dev_acquisition_start(sdi, cb_data, X); }
	298
	299	/* Driver structs and API function wrappers */
	300	#define DRV(ID, ID_UPPER, NAME, LONGNAME) \
	301	HW_INIT(ID_UPPER) \
	302	HW_CLEANUP(ID_UPPER) \
	303	HW_SCAN(ID_UPPER) \
	304	HW_DEV_LIST(ID_UPPER) \
	305	CLEAR_INSTANCES(ID_UPPER) \
	306	HW_DEV_ACQUISITION_START(ID_UPPER) \
	307	SR_PRIV struct sr_dev_driver ID##_driver_info = { \
	308	.name = NAME, \
	309	.longname = LONGNAME, \
	310	.api_version = 1, \
	311	.init = hw_init_##ID_UPPER, \
	312	.cleanup = hw_cleanup_##ID_UPPER, \
	313	.scan = hw_scan_##ID_UPPER, \
	314	.dev_list = hw_dev_list_##ID_UPPER, \
	315	.dev_clear = clear_instances_##ID_UPPER, \
	316	.config_get = NULL, \
	317	.config_set = config_set, \
	318	.config_list = config_list, \
	319	.dev_open = hw_dev_open, \
	320	.dev_close = hw_dev_close, \
	321	.dev_acquisition_start = hw_dev_acquisition_start_##ID_UPPER, \
	322	.dev_acquisition_stop = hw_dev_acquisition_stop, \
	323	.priv = NULL, \
	324	};
	325
	326	DRV(mic_98583, MIC_98583, "mic-98583", "MIC 98583")