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

static const int32_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)
{
	sr_dbg("Selected '%s' subdriver.", mic_devs[idx].di->name);

	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_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;
	}

	sdi->inst_type = SR_INST_SERIAL;
	sdi->conn = 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 *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 dev_open(struct sr_dev_inst *sdi)
{
	struct sr_serial_dev_inst *serial;

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

	sdi->status = SR_ST_ACTIVE;

	return SR_OK;
}

static int dev_close(struct sr_dev_inst *sdi)
{
	struct sr_serial_dev_inst *serial;

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

	return SR_OK;
}

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

static int config_set(int id, GVariant *data, const struct sr_dev_inst *sdi,
		const struct sr_probe_group *probe_group)
{
	struct dev_context *devc;

	(void)probe_group;

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

	devc = sdi->priv;

	switch (id) {
	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(int key, GVariant **data, const struct sr_dev_inst *sdi,
		const struct sr_probe_group *probe_group)
{
	(void)sdi;
	(void)probe_group;

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