[libsigrok.git] / 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_98581_driver_info;
SR_PRIV struct sr_dev_driver mic_98583_driver_info;

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