[libsigrok.git] / src / 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 uint32_t hwopts[] = {
	SR_CONF_CONN,
	SR_CONF_SERIALCOMM,
};

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

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 dev_clear(int idx)
{
	return std_dev_clear(mic_devs[idx].di, NULL);
}

static int init(struct sr_context *sr_ctx, int idx)
{
	return std_init(sr_ctx, mic_devs[idx].di, LOG_PREFIX);
}

static GSList *mic_scan(const char *conn, const char *serialcomm, int idx)
{
	struct sr_dev_inst *sdi;
	struct drv_context *drvc;
	struct dev_context *devc;
	struct sr_channel *ch;
	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, NULL)))
		goto scan_cleanup;

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

	sdi->inst_type = SR_INST_SERIAL;
	sdi->conn = serial;

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

	if (!(ch = sr_channel_new(0, SR_CHANNEL_ANALOG, TRUE, "Temperature")))
		goto scan_cleanup;
	sdi->channels = g_slist_append(sdi->channels, ch);

	if (mic_devs[idx].has_humidity) {
		if (!(ch = sr_channel_new(1, SR_CHANNEL_ANALOG, TRUE, "Humidity")))
			goto scan_cleanup;
		sdi->channels = g_slist_append(sdi->channels, ch);
	}

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

scan_cleanup:
	serial_close(serial);

	return devices;
}

static GSList *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 = 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) {
		/* Use the provided comm specs. */
		devices = mic_scan(conn, serialcomm, idx);
	} else {
		/* Try the default. */
		devices = mic_scan(conn, mic_devs[idx].conn, idx);
	}

	return devices;
}

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

static int cleanup(int idx)
{
	return dev_clear(idx);
}

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;

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

	devc = sdi->priv;

	switch (key) {
	case SR_CONF_LIMIT_SAMPLES:
		devc->limit_samples = g_variant_get_uint64(data);
		sr_dbg("Setting sample limit to %" PRIu64 ".",
		       devc->limit_samples);
		break;
	case SR_CONF_LIMIT_MSEC:
		devc->limit_msec = g_variant_get_uint64(data);
		sr_dbg("Setting time limit to %" PRIu64 "ms.",
		       devc->limit_msec);
		break;
	default:
		return SR_ERR_NA;
	}

	return SR_OK;
}

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

	return SR_OK;
}

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

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

	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, LOG_PREFIX);

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

	return SR_OK;
}

static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
{
	return std_serial_dev_acquisition_stop(sdi, cb_data, std_serial_dev_close,
			sdi->conn, LOG_PREFIX);
}

/* Driver-specific API function wrappers */
#define HW_INIT(X) \
static int init_##X(struct sr_context *sr_ctx) { return init(sr_ctx, X); }
#define HW_CLEANUP(X) \
static int cleanup_##X(void) { return cleanup(X); }
#define HW_SCAN(X) \
static GSList *scan_##X(GSList *options) { return scan(options, X); }
#define HW_DEV_LIST(X) \
static GSList *dev_list_##X(void) { return dev_list(X); }
#define HW_DEV_CLEAR(X) \
static int dev_clear_##X(void) { return dev_clear(X); }
#define HW_DEV_ACQUISITION_START(X) \
static int dev_acquisition_start_##X(const struct sr_dev_inst *sdi, \
void *cb_data) { return 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) \
HW_DEV_CLEAR(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 = init_##ID_UPPER, \
	.cleanup = cleanup_##ID_UPPER, \
	.scan = scan_##ID_UPPER, \
	.dev_list = dev_list_##ID_UPPER, \
	.dev_clear = dev_clear_##ID_UPPER, \
	.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_##ID_UPPER, \
	.dev_acquisition_stop = 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
7ec5b549 UH	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
584560f1	23	static const uint32_t hwopts[] = {
0cd8e231 UH	24	SR_CONF_CONN,
0cd8e231 UH	25	SR_CONF_SERIALCOMM,
0cd8e231 UH	26	};
0cd8e231 UH	27
584560f1	28	static const uint32_t hwcaps[] = {
0cd8e231 UH	29	SR_CONF_THERMOMETER,
	30	SR_CONF_HYGROMETER,
	31	SR_CONF_LIMIT_SAMPLES,
	32	SR_CONF_LIMIT_MSEC,
	33	SR_CONF_CONTINUOUS,
0cd8e231	34	};
7ec5b549	35
6f3e5335	36	SR_PRIV struct sr_dev_driver mic_98581_driver_info;
0cd8e231 UH	37	SR_PRIV struct sr_dev_driver mic_98583_driver_info;
	38
	39	SR_PRIV const struct mic_dev_info mic_devs[] = {
	40	{
6f3e5335 UH	41	"MIC", "98581", "38400/8n2", 32000, TRUE, FALSE, 6,
	42	packet_valid_temp,
	43	&mic_98581_driver_info, receive_data_MIC_98581,
	44	},
	45	{
	46	"MIC", "98583", "38400/8n2", 32000, TRUE, TRUE, 10,
	47	packet_valid_temp_hum,
0cd8e231 UH	48	&mic_98583_driver_info, receive_data_MIC_98583,
	49	},
	50	};
	51
3b412e3a	52	static int dev_clear(int idx)
7ec5b549	53	{
25e7adad	54	return std_dev_clear(mic_devs[idx].di, NULL);
7ec5b549 UH	55	}
7ec5b549 UH	56
6078d2c9	57	static int init(struct sr_context *sr_ctx, int idx)
7ec5b549	58	{
f6beaac5	59	return std_init(sr_ctx, mic_devs[idx].di, LOG_PREFIX);
7ec5b549 UH	60	}
7ec5b549 UH	61
6078d2c9	62	static GSList mic_scan(const char conn, const char *serialcomm, int idx)
7ec5b549	63	{
0cd8e231	64	struct sr_dev_inst *sdi;
7ec5b549	65	struct drv_context *drvc;
0cd8e231	66	struct dev_context *devc;
ba7dd8bb	67	struct sr_channel *ch;
0cd8e231	68	struct sr_serial_dev_inst *serial;
7ec5b549 UH	69	GSList *devices;
7ec5b549 UH	70
0cd8e231 UH	71	if (!(serial = sr_serial_dev_inst_new(conn, serialcomm)))
0cd8e231 UH	72	return NULL;
7ec5b549	73
0cd8e231 UH	74	if (serial_open(serial, SERIAL_RDWR \| SERIAL_NONBLOCK) != SR_OK)
	75	return NULL;
	76
	77	drvc = mic_devs[idx].di->priv;
7ec5b549	78	devices = NULL;
0cd8e231	79	serial_flush(serial);
7ec5b549	80
0cd8e231 UH	81	/* TODO: Query device type. */
	82	// ret = mic_cmd_get_device_info(serial);
	83
	84	sr_info("Found device on port %s.", conn);
	85
	86	/* TODO: Fill in version from protocol response. */
	87	if (!(sdi = sr_dev_inst_new(0, SR_ST_INACTIVE, mic_devs[idx].vendor,
55f98c65	88	mic_devs[idx].device, NULL)))
0cd8e231 UH	89	goto scan_cleanup;
	90
	91	if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) {
	92	sr_err("Device context malloc failed.");
	93	goto scan_cleanup;
	94	}
	95
886bd5e0 UH	96	sdi->inst_type = SR_INST_SERIAL;
886bd5e0 UH	97	sdi->conn = serial;
0cd8e231 UH	98
	99	sdi->priv = devc;
	100	sdi->driver = mic_devs[idx].di;
	101
3f239f08	102	if (!(ch = sr_channel_new(0, SR_CHANNEL_ANALOG, TRUE, "Temperature")))
0cd8e231	103	goto scan_cleanup;
ba7dd8bb	104	sdi->channels = g_slist_append(sdi->channels, ch);
0cd8e231	105
6f3e5335	106	if (mic_devs[idx].has_humidity) {
3f239f08	107	if (!(ch = sr_channel_new(1, SR_CHANNEL_ANALOG, TRUE, "Humidity")))
6f3e5335	108	goto scan_cleanup;
ba7dd8bb	109	sdi->channels = g_slist_append(sdi->channels, ch);
6f3e5335	110	}
0cd8e231 UH	111
	112	drvc->instances = g_slist_append(drvc->instances, sdi);
	113	devices = g_slist_append(devices, sdi);
	114
	115	scan_cleanup:
	116	serial_close(serial);
7ec5b549 UH	117
	118	return devices;
	119	}
	120
6078d2c9	121	static GSList scan(GSList options, int idx)
0cd8e231 UH	122	{
	123	struct sr_config *src;
	124	GSList l, devices;
	125	const char conn, serialcomm;
	126
	127	conn = serialcomm = NULL;
	128	for (l = options; l; l = l->next) {
	129	src = l->data;
	130	switch (src->key) {
	131	case SR_CONF_CONN:
2c2be401	132	conn = g_variant_get_string(src->data, NULL);
0cd8e231 UH	133	break;
0cd8e231 UH	134	case SR_CONF_SERIALCOMM:
06c45a66	135	serialcomm = g_variant_get_string(src->data, NULL);
0cd8e231 UH	136	break;
	137	}
	138	}
	139	if (!conn)
	140	return NULL;
	141
	142	if (serialcomm) {
	143	/* Use the provided comm specs. */
6078d2c9	144	devices = mic_scan(conn, serialcomm, idx);
0cd8e231 UH	145	} else {
0cd8e231 UH	146	/* Try the default. */
6078d2c9	147	devices = mic_scan(conn, mic_devs[idx].conn, idx);
0cd8e231 UH	148	}
	149
	150	return devices;
	151	}
	152
6078d2c9	153	static GSList *dev_list(int idx)
7ec5b549	154	{
0e94d524	155	return ((struct drv_context *)(mic_devs[idx].di->priv))->instances;
7ec5b549 UH	156	}
7ec5b549 UH	157
6078d2c9	158	static int cleanup(int idx)
7ec5b549	159	{
3b412e3a	160	return dev_clear(idx);
7ec5b549 UH	161	}
7ec5b549 UH	162
584560f1	163	static int config_set(uint32_t key, GVariant data, const struct sr_dev_inst sdi,
53b4680f	164	const struct sr_channel_group *cg)
7ec5b549	165	{
0cd8e231	166	struct dev_context *devc;
7ec5b549	167
53b4680f	168	(void)cg;
8f996b89	169
0cd8e231	170	if (sdi->status != SR_ST_ACTIVE)
e73ffd42	171	return SR_ERR_DEV_CLOSED;
7ec5b549	172
0cd8e231 UH	173	devc = sdi->priv;
0cd8e231 UH	174
584560f1	175	switch (key) {
0cd8e231	176	case SR_CONF_LIMIT_SAMPLES:
2c2be401	177	devc->limit_samples = g_variant_get_uint64(data);
0cd8e231 UH	178	sr_dbg("Setting sample limit to %" PRIu64 ".",
	179	devc->limit_samples);
	180	break;
	181	case SR_CONF_LIMIT_MSEC:
2c2be401	182	devc->limit_msec = g_variant_get_uint64(data);
0cd8e231 UH	183	sr_dbg("Setting time limit to %" PRIu64 "ms.",
	184	devc->limit_msec);
	185	break;
7ec5b549	186	default:
bd6fbf62	187	return SR_ERR_NA;
7ec5b549 UH	188	}
7ec5b549 UH	189
0cd8e231	190	return SR_OK;
7ec5b549 UH	191	}
7ec5b549 UH	192
584560f1	193	static int config_list(uint32_t key, GVariant *data, const struct sr_dev_inst sdi,
53b4680f	194	const struct sr_channel_group *cg)
7ec5b549 UH	195	{
7ec5b549 UH	196	(void)sdi;
53b4680f	197	(void)cg;
7ec5b549 UH	198
7ec5b549 UH	199	switch (key) {
0cd8e231	200	case SR_CONF_SCAN_OPTIONS:
584560f1 BV	201	*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
584560f1 BV	202	hwopts, ARRAY_SIZE(hwopts), sizeof(uint32_t));
0cd8e231 UH	203	break;
0cd8e231 UH	204	case SR_CONF_DEVICE_OPTIONS:
584560f1 BV	205	*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
584560f1 BV	206	hwcaps, ARRAY_SIZE(hwcaps), sizeof(uint32_t));
0cd8e231	207	break;
7ec5b549	208	default:
bd6fbf62	209	return SR_ERR_NA;
7ec5b549 UH	210	}
	211
	212	return SR_OK;
	213	}
	214
6078d2c9	215	static int dev_acquisition_start(const struct sr_dev_inst *sdi,
0cd8e231	216	void *cb_data, int idx)
7ec5b549	217	{
0cd8e231	218	struct dev_context *devc;
886bd5e0	219	struct sr_serial_dev_inst *serial;
0cd8e231	220
e73ffd42 BV	221	if (sdi->status != SR_ST_ACTIVE)
e73ffd42 BV	222	return SR_ERR_DEV_CLOSED;
0cd8e231	223
e73ffd42	224	devc = sdi->priv;
0cd8e231	225	devc->cb_data = cb_data;
0cd8e231 UH	226	devc->num_samples = 0;
	227	devc->starttime = g_get_monotonic_time();
	228
	229	/* Send header packet to the session bus. */
29a27196	230	std_session_send_df_header(cb_data, LOG_PREFIX);
0cd8e231 UH	231
0cd8e231 UH	232	/* Poll every 100ms, or whenever some data comes in. */
886bd5e0	233	serial = sdi->conn;
102f1239	234	serial_source_add(sdi->session, serial, G_IO_IN, 100,
0cd8e231	235	mic_devs[idx].receive_data, (void *)sdi);
7ec5b549 UH	236
	237	return SR_OK;
	238	}
	239
6078d2c9	240	static int dev_acquisition_stop(struct sr_dev_inst sdi, void cb_data)
7ec5b549	241	{
d43b0908 BV	242	return std_serial_dev_acquisition_stop(sdi, cb_data, std_serial_dev_close,
d43b0908 BV	243	sdi->conn, LOG_PREFIX);
7ec5b549 UH	244	}
7ec5b549 UH	245
0cd8e231 UH	246	/* Driver-specific API function wrappers */
0cd8e231 UH	247	#define HW_INIT(X) \
6078d2c9	248	static int init_##X(struct sr_context *sr_ctx) { return init(sr_ctx, X); }
0cd8e231	249	#define HW_CLEANUP(X) \
6078d2c9	250	static int cleanup_##X(void) { return cleanup(X); }
0cd8e231	251	#define HW_SCAN(X) \
6078d2c9	252	static GSList scan_##X(GSList options) { return scan(options, X); }
0cd8e231	253	#define HW_DEV_LIST(X) \
6078d2c9	254	static GSList *dev_list_##X(void) { return dev_list(X); }
3b412e3a UH	255	#define HW_DEV_CLEAR(X) \
3b412e3a UH	256	static int dev_clear_##X(void) { return dev_clear(X); }
0cd8e231	257	#define HW_DEV_ACQUISITION_START(X) \
6078d2c9 UH	258	static int dev_acquisition_start_##X(const struct sr_dev_inst *sdi, \
6078d2c9 UH	259	void *cb_data) { return dev_acquisition_start(sdi, cb_data, X); }
0cd8e231 UH	260
	261	/* Driver structs and API function wrappers */
	262	#define DRV(ID, ID_UPPER, NAME, LONGNAME) \
	263	HW_INIT(ID_UPPER) \
	264	HW_CLEANUP(ID_UPPER) \
	265	HW_SCAN(ID_UPPER) \
	266	HW_DEV_LIST(ID_UPPER) \
3b412e3a	267	HW_DEV_CLEAR(ID_UPPER) \
0cd8e231 UH	268	HW_DEV_ACQUISITION_START(ID_UPPER) \
	269	SR_PRIV struct sr_dev_driver ID##_driver_info = { \
	270	.name = NAME, \
	271	.longname = LONGNAME, \
	272	.api_version = 1, \
6078d2c9 UH	273	.init = init_##ID_UPPER, \
	274	.cleanup = cleanup_##ID_UPPER, \
	275	.scan = scan_##ID_UPPER, \
	276	.dev_list = dev_list_##ID_UPPER, \
3b412e3a	277	.dev_clear = dev_clear_##ID_UPPER, \
0cd8e231 UH	278	.config_get = NULL, \
	279	.config_set = config_set, \
	280	.config_list = config_list, \
854434de	281	.dev_open = std_serial_dev_open, \
bf2c987f	282	.dev_close = std_serial_dev_close, \
6078d2c9 UH	283	.dev_acquisition_start = dev_acquisition_start_##ID_UPPER, \
6078d2c9 UH	284	.dev_acquisition_stop = dev_acquisition_stop, \
0cd8e231	285	.priv = NULL, \
7ec5b549	286	};
0cd8e231	287
6f3e5335	288	DRV(mic_98581, MIC_98581, "mic-98581", "MIC 98581")
0cd8e231	289	DRV(mic_98583, MIC_98583, "mic-98583", "MIC 98583")