[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,
};

static struct sr_dev_driver mic_98581_driver_info;
static 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 GSList *mic_scan(const char *conn, const char *serialcomm, int idx)
{
	struct sr_dev_inst *sdi;
	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;

	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));
	sr_sw_limits_init(&devc->limits);
	sdi->inst_type = SR_INST_SERIAL;
	sdi->conn = serial;
	sdi->priv = devc;

	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");

	devices = g_slist_append(devices, sdi);

	serial_close(serial);

	return std_scan_complete(mic_devs[idx].di, 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;

	return sr_sw_limits_config_set(&devc->limits, key, data);
}

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;

	sr_sw_limits_acquisition_start(&devc->limits);
	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_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_SCAN(ID_UPPER) \
HW_CONFIG_LIST(ID_UPPER) \
HW_DEV_ACQUISITION_START(ID_UPPER) \
static struct sr_dev_driver ID##_driver_info = { \
	.name = NAME, \
	.longname = LONGNAME, \
	.api_version = 1, \
	.init = std_init, \
	.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, \
}; \
SR_REGISTER_DEV_DRIVER(ID##_driver_info)

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
dd5c48a6 LPC	44	static struct sr_dev_driver mic_98581_driver_info;
dd5c48a6 LPC	45	static struct sr_dev_driver mic_98583_driver_info;
0cd8e231 UH	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 GSList mic_scan(const char conn, const char *serialcomm, int idx)
7ec5b549	61	{
0cd8e231	62	struct sr_dev_inst *sdi;
0cd8e231	63	struct dev_context *devc;
0cd8e231	64	struct sr_serial_dev_inst *serial;
7ec5b549 UH	65	GSList *devices;
7ec5b549 UH	66
91219afc	67	serial = sr_serial_dev_inst_new(conn, serialcomm);
7ec5b549	68
51056d61	69	if (serial_open(serial, SERIAL_RDWR) != SR_OK)
0cd8e231 UH	70	return NULL;
0cd8e231 UH	71
7ec5b549	72	devices = NULL;
0cd8e231	73	serial_flush(serial);
7ec5b549	74
0cd8e231 UH	75	/* TODO: Query device type. */
	76	// ret = mic_cmd_get_device_info(serial);
	77
	78	sr_info("Found device on port %s.", conn);
	79
	80	/* TODO: Fill in version from protocol response. */
aac29cc1	81	sdi = g_malloc0(sizeof(struct sr_dev_inst));
0af636be UH	82	sdi->status = SR_ST_INACTIVE;
	83	sdi->vendor = g_strdup(mic_devs[idx].vendor);
	84	sdi->model = g_strdup(mic_devs[idx].device);
f57d8ffe	85	devc = g_malloc0(sizeof(struct dev_context));
301090aa	86	sr_sw_limits_init(&devc->limits);
886bd5e0 UH	87	sdi->inst_type = SR_INST_SERIAL;
886bd5e0 UH	88	sdi->conn = serial;
0cd8e231	89	sdi->priv = devc;
0cd8e231	90
5e23fcab	91	sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "Temperature");
0cd8e231	92
5e23fcab ML	93	if (mic_devs[idx].has_humidity)
5e23fcab ML	94	sr_channel_new(sdi, 1, SR_CHANNEL_ANALOG, TRUE, "Humidity");
0cd8e231	95
0cd8e231 UH	96	devices = g_slist_append(devices, sdi);
0cd8e231 UH	97
0cd8e231	98	serial_close(serial);
7ec5b549	99
15a5bfe4	100	return std_scan_complete(mic_devs[idx].di, devices);
7ec5b549 UH	101	}
7ec5b549 UH	102
6078d2c9	103	static GSList scan(GSList options, int idx)
0cd8e231 UH	104	{
	105	struct sr_config *src;
	106	GSList l, devices;
	107	const char conn, serialcomm;
	108
	109	conn = serialcomm = NULL;
	110	for (l = options; l; l = l->next) {
	111	src = l->data;
	112	switch (src->key) {
	113	case SR_CONF_CONN:
2c2be401	114	conn = g_variant_get_string(src->data, NULL);
0cd8e231 UH	115	break;
0cd8e231 UH	116	case SR_CONF_SERIALCOMM:
06c45a66	117	serialcomm = g_variant_get_string(src->data, NULL);
0cd8e231 UH	118	break;
	119	}
	120	}
	121	if (!conn)
	122	return NULL;
	123
	124	if (serialcomm) {
	125	/* Use the provided comm specs. */
6078d2c9	126	devices = mic_scan(conn, serialcomm, idx);
0cd8e231 UH	127	} else {
0cd8e231 UH	128	/* Try the default. */
6078d2c9	129	devices = mic_scan(conn, mic_devs[idx].conn, idx);
0cd8e231 UH	130	}
	131
	132	return devices;
	133	}
	134
584560f1	135	static int config_set(uint32_t key, GVariant data, const struct sr_dev_inst sdi,
53b4680f	136	const struct sr_channel_group *cg)
7ec5b549	137	{
0cd8e231	138	struct dev_context *devc;
7ec5b549	139
53b4680f	140	(void)cg;
8f996b89	141
0cd8e231	142	if (sdi->status != SR_ST_ACTIVE)
e73ffd42	143	return SR_ERR_DEV_CLOSED;
7ec5b549	144
0cd8e231 UH	145	devc = sdi->priv;
0cd8e231 UH	146
301090aa	147	return sr_sw_limits_config_set(&devc->limits, key, data);
7ec5b549 UH	148	}
7ec5b549 UH	149
584560f1	150	static int config_list(uint32_t key, GVariant *data, const struct sr_dev_inst sdi,
e07edc83	151	const struct sr_channel_group *cg, int idx)
7ec5b549	152	{
53b4680f	153	(void)cg;
7ec5b549 UH	154
7ec5b549 UH	155	switch (key) {
0cd8e231	156	case SR_CONF_SCAN_OPTIONS:
584560f1	157	*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
a0e0bb41	158	scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
0cd8e231 UH	159	break;
0cd8e231 UH	160	case SR_CONF_DEVICE_OPTIONS:
e07edc83 UH	161	if (!sdi && !mic_devs[idx].has_humidity) {
	162	*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
	163	drvopts_temp, ARRAY_SIZE(drvopts_temp),
	164	sizeof(uint32_t));
	165	} else if (!sdi && mic_devs[idx].has_humidity) {
d6e1e6c4	166	*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
e07edc83 UH	167	drvopts_temp_hum, ARRAY_SIZE(drvopts_temp_hum),
	168	sizeof(uint32_t));
	169	} else {
d6e1e6c4	170	*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
f254bc4b	171	devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
e07edc83	172	}
0cd8e231	173	break;
7ec5b549	174	default:
bd6fbf62	175	return SR_ERR_NA;
7ec5b549 UH	176	}
	177
	178	return SR_OK;
	179	}
	180
695dc859	181	static int dev_acquisition_start(const struct sr_dev_inst *sdi, int idx)
7ec5b549	182	{
0cd8e231	183	struct dev_context *devc;
886bd5e0	184	struct sr_serial_dev_inst *serial;
0cd8e231	185
e73ffd42 BV	186	if (sdi->status != SR_ST_ACTIVE)
e73ffd42 BV	187	return SR_ERR_DEV_CLOSED;
0cd8e231	188
e73ffd42	189	devc = sdi->priv;
0cd8e231	190
301090aa	191	sr_sw_limits_acquisition_start(&devc->limits);
695dc859	192	std_session_send_df_header(sdi, LOG_PREFIX);
0cd8e231 UH	193
0cd8e231 UH	194	/* Poll every 100ms, or whenever some data comes in. */
886bd5e0	195	serial = sdi->conn;
102f1239	196	serial_source_add(sdi->session, serial, G_IO_IN, 100,
0cd8e231	197	mic_devs[idx].receive_data, (void *)sdi);
7ec5b549 UH	198
	199	return SR_OK;
	200	}
	201
695dc859	202	static int dev_acquisition_stop(struct sr_dev_inst *sdi)
7ec5b549	203	{
6525d819	204	return std_serial_dev_acquisition_stop(sdi, std_serial_dev_close,
d43b0908	205	sdi->conn, LOG_PREFIX);
7ec5b549 UH	206	}
7ec5b549 UH	207
0cd8e231	208	/* Driver-specific API function wrappers */
0cd8e231	209	#define HW_SCAN(X) \
4f840ce9	210	static GSList scan_##X(struct sr_dev_driver di, GSList *options) { \
1a863916	211	(void)di; return scan(options, X); }
e07edc83 UH	212	#define HW_CONFIG_LIST(X) \
	213	static int config_list_##X(uint32_t key, GVariant **data, \
	214	const struct sr_dev_inst sdi, const struct sr_channel_group cg) { \
	215	return config_list(key, data, sdi, cg, X); }
0cd8e231	216	#define HW_DEV_ACQUISITION_START(X) \
695dc859 UH	217	static int dev_acquisition_start_##X(const struct sr_dev_inst *sdi \
695dc859 UH	218	) { return dev_acquisition_start(sdi, X); }
0cd8e231 UH	219
	220	/* Driver structs and API function wrappers */
	221	#define DRV(ID, ID_UPPER, NAME, LONGNAME) \
0cd8e231	222	HW_SCAN(ID_UPPER) \
e07edc83	223	HW_CONFIG_LIST(ID_UPPER) \
0cd8e231	224	HW_DEV_ACQUISITION_START(ID_UPPER) \
dd5c48a6	225	static struct sr_dev_driver ID##_driver_info = { \
0cd8e231 UH	226	.name = NAME, \
	227	.longname = LONGNAME, \
	228	.api_version = 1, \
c2fdcc25	229	.init = std_init, \
700d6b64	230	.cleanup = std_cleanup, \
6078d2c9	231	.scan = scan_##ID_UPPER, \
c01bf34c	232	.dev_list = std_dev_list, \
0cd8e231 UH	233	.config_get = NULL, \
0cd8e231 UH	234	.config_set = config_set, \
e07edc83	235	.config_list = config_list_##ID_UPPER, \
854434de	236	.dev_open = std_serial_dev_open, \
bf2c987f	237	.dev_close = std_serial_dev_close, \
6078d2c9 UH	238	.dev_acquisition_start = dev_acquisition_start_##ID_UPPER, \
6078d2c9 UH	239	.dev_acquisition_stop = dev_acquisition_stop, \
41812aca	240	.context = NULL, \
dd5c48a6 LPC	241	}; \
dd5c48a6 LPC	242	SR_REGISTER_DEV_DRIVER(ID##_driver_info)
0cd8e231	243
6f3e5335	244	DRV(mic_98581, MIC_98581, "mic-98581", "MIC 98581")
0cd8e231	245	DRV(mic_98583, MIC_98583, "mic-98583", "MIC 98583")