[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 scanopts[] = {
	SR_CONF_CONN,
	SR_CONF_SERIALCOMM,
};

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

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) != 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. */
	sdi = sr_dev_inst_new();
	sdi->status = SR_ST_INACTIVE;
	sdi->vendor = g_strdup(mic_devs[idx].vendor);
	sdi->model = g_strdup(mic_devs[idx].device);

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