[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 <config.h>
#include "protocol.h"

static const uint32_t scanopts[] = {
	SR_CONF_CONN,
	SR_CONF_SERIALCOMM,
};

static const uint32_t drvopts_temp[] = {
	SR_CONF_THERMOMETER,
};

static const uint32_t drvopts_temp_hum[] = {
	SR_CONF_THERMOMETER,
	SR_CONF_HYGROMETER,
};

static const uint32_t devopts[] = {
	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 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_serial_dev_inst *serial;
	GSList *devices;

	serial = sr_serial_dev_inst_new(conn, serialcomm);

	if (serial_open(serial, SERIAL_RDWR) != SR_OK)
		return NULL;

	drvc = mic_devs[idx].di->context;
	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 = g_malloc0(sizeof(struct sr_dev_inst));
	sdi->status = SR_ST_INACTIVE;
	sdi->vendor = g_strdup(mic_devs[idx].vendor);
	sdi->model = g_strdup(mic_devs[idx].device);
	devc = g_malloc0(sizeof(struct dev_context));
	sdi->inst_type = SR_INST_SERIAL;
	sdi->conn = serial;
	sdi->priv = devc;
	sdi->driver = mic_devs[idx].di;

	sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "Temperature");

	if (mic_devs[idx].has_humidity)
		sr_channel_new(sdi, 1, SR_CHANNEL_ANALOG, TRUE, "Humidity");

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

	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 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);
		break;
	case SR_CONF_LIMIT_MSEC:
		devc->limit_msec = g_variant_get_uint64(data);
		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, int idx)
{
	(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 && !mic_devs[idx].has_humidity) {
			*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
				drvopts_temp, ARRAY_SIZE(drvopts_temp),
				sizeof(uint32_t));
		} else if (!sdi && mic_devs[idx].has_humidity) {
			*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
				drvopts_temp_hum, ARRAY_SIZE(drvopts_temp_hum),
				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, 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->num_samples = 0;
	devc->starttime = g_get_monotonic_time();

	std_session_send_df_header(sdi, 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)
{
	return std_serial_dev_acquisition_stop(sdi, std_serial_dev_close,
			sdi->conn, LOG_PREFIX);
}

/* Driver-specific API function wrappers */
#define HW_INIT(X) \
static int init_##X(struct sr_dev_driver *di, struct sr_context *sr_ctx) { \
	(void)di; return init(sr_ctx, X); }
#define HW_SCAN(X) \
static GSList *scan_##X(struct sr_dev_driver *di, GSList *options) { \
	(void)di; return scan(options, X); }
#define HW_CONFIG_LIST(X) \
static int config_list_##X(uint32_t key, GVariant **data, \
const struct sr_dev_inst *sdi, const struct sr_channel_group *cg) { \
return config_list(key, data, sdi, cg, X); }
#define HW_DEV_ACQUISITION_START(X) \
static int dev_acquisition_start_##X(const struct sr_dev_inst *sdi \
) { return dev_acquisition_start(sdi, X); }

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