[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 drvopts[] = {
	SR_CONF_THERMOMETER,
	SR_CONF_HYGROMETER,
};

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