[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(mic_devs[idx].di, sr_ctx);
}

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));
	sr_sw_limits_init(&devc->limits);
	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;

	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_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	{
c45c32ce	62	return std_init(mic_devs[idx].di, sr_ctx);
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));
301090aa	93	sr_sw_limits_init(&devc->limits);
886bd5e0 UH	94	sdi->inst_type = SR_INST_SERIAL;
886bd5e0 UH	95	sdi->conn = serial;
0cd8e231 UH	96	sdi->priv = devc;
	97	sdi->driver = mic_devs[idx].di;
	98
5e23fcab	99	sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "Temperature");
0cd8e231	100
5e23fcab ML	101	if (mic_devs[idx].has_humidity)
5e23fcab ML	102	sr_channel_new(sdi, 1, SR_CHANNEL_ANALOG, TRUE, "Humidity");
0cd8e231 UH	103
	104	drvc->instances = g_slist_append(drvc->instances, sdi);
	105	devices = g_slist_append(devices, sdi);
	106
0cd8e231	107	serial_close(serial);
7ec5b549 UH	108
	109	return devices;
	110	}
	111
6078d2c9	112	static GSList scan(GSList options, int idx)
0cd8e231 UH	113	{
	114	struct sr_config *src;
	115	GSList l, devices;
	116	const char conn, serialcomm;
	117
	118	conn = serialcomm = NULL;
	119	for (l = options; l; l = l->next) {
	120	src = l->data;
	121	switch (src->key) {
	122	case SR_CONF_CONN:
2c2be401	123	conn = g_variant_get_string(src->data, NULL);
0cd8e231 UH	124	break;
0cd8e231 UH	125	case SR_CONF_SERIALCOMM:
06c45a66	126	serialcomm = g_variant_get_string(src->data, NULL);
0cd8e231 UH	127	break;
	128	}
	129	}
	130	if (!conn)
	131	return NULL;
	132
	133	if (serialcomm) {
	134	/* Use the provided comm specs. */
6078d2c9	135	devices = mic_scan(conn, serialcomm, idx);
0cd8e231 UH	136	} else {
0cd8e231 UH	137	/* Try the default. */
6078d2c9	138	devices = mic_scan(conn, mic_devs[idx].conn, idx);
0cd8e231 UH	139	}
	140
	141	return devices;
	142	}
	143
584560f1	144	static int config_set(uint32_t key, GVariant data, const struct sr_dev_inst sdi,
53b4680f	145	const struct sr_channel_group *cg)
7ec5b549	146	{
0cd8e231	147	struct dev_context *devc;
7ec5b549	148
53b4680f	149	(void)cg;
8f996b89	150
0cd8e231	151	if (sdi->status != SR_ST_ACTIVE)
e73ffd42	152	return SR_ERR_DEV_CLOSED;
7ec5b549	153
0cd8e231 UH	154	devc = sdi->priv;
0cd8e231 UH	155
301090aa	156	return sr_sw_limits_config_set(&devc->limits, key, data);
7ec5b549 UH	157	}
7ec5b549 UH	158
584560f1	159	static int config_list(uint32_t key, GVariant *data, const struct sr_dev_inst sdi,
e07edc83	160	const struct sr_channel_group *cg, int idx)
7ec5b549	161	{
53b4680f	162	(void)cg;
7ec5b549 UH	163
7ec5b549 UH	164	switch (key) {
0cd8e231	165	case SR_CONF_SCAN_OPTIONS:
584560f1	166	*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
a0e0bb41	167	scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
0cd8e231 UH	168	break;
0cd8e231 UH	169	case SR_CONF_DEVICE_OPTIONS:
e07edc83 UH	170	if (!sdi && !mic_devs[idx].has_humidity) {
	171	*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
	172	drvopts_temp, ARRAY_SIZE(drvopts_temp),
	173	sizeof(uint32_t));
	174	} else if (!sdi && mic_devs[idx].has_humidity) {
d6e1e6c4	175	*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
e07edc83 UH	176	drvopts_temp_hum, ARRAY_SIZE(drvopts_temp_hum),
	177	sizeof(uint32_t));
	178	} else {
d6e1e6c4	179	*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
f254bc4b	180	devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
e07edc83	181	}
0cd8e231	182	break;
7ec5b549	183	default:
bd6fbf62	184	return SR_ERR_NA;
7ec5b549 UH	185	}
	186
	187	return SR_OK;
	188	}
	189
695dc859	190	static int dev_acquisition_start(const struct sr_dev_inst *sdi, int idx)
7ec5b549	191	{
0cd8e231	192	struct dev_context *devc;
886bd5e0	193	struct sr_serial_dev_inst *serial;
0cd8e231	194
e73ffd42 BV	195	if (sdi->status != SR_ST_ACTIVE)
e73ffd42 BV	196	return SR_ERR_DEV_CLOSED;
0cd8e231	197
e73ffd42	198	devc = sdi->priv;
0cd8e231	199
301090aa	200	sr_sw_limits_acquisition_start(&devc->limits);
695dc859	201	std_session_send_df_header(sdi, LOG_PREFIX);
0cd8e231 UH	202
0cd8e231 UH	203	/* Poll every 100ms, or whenever some data comes in. */
886bd5e0	204	serial = sdi->conn;
102f1239	205	serial_source_add(sdi->session, serial, G_IO_IN, 100,
0cd8e231	206	mic_devs[idx].receive_data, (void *)sdi);
7ec5b549 UH	207
	208	return SR_OK;
	209	}
	210
695dc859	211	static int dev_acquisition_stop(struct sr_dev_inst *sdi)
7ec5b549	212	{
6525d819	213	return std_serial_dev_acquisition_stop(sdi, std_serial_dev_close,
d43b0908	214	sdi->conn, LOG_PREFIX);
7ec5b549 UH	215	}
7ec5b549 UH	216
0cd8e231 UH	217	/* Driver-specific API function wrappers */
0cd8e231 UH	218	#define HW_INIT(X) \
4f840ce9	219	static int init_##X(struct sr_dev_driver di, struct sr_context sr_ctx) { \
1a863916	220	(void)di; return init(sr_ctx, X); }
0cd8e231	221	#define HW_SCAN(X) \
4f840ce9	222	static GSList scan_##X(struct sr_dev_driver di, GSList *options) { \
1a863916	223	(void)di; return scan(options, X); }
e07edc83 UH	224	#define HW_CONFIG_LIST(X) \
	225	static int config_list_##X(uint32_t key, GVariant **data, \
	226	const struct sr_dev_inst sdi, const struct sr_channel_group cg) { \
	227	return config_list(key, data, sdi, cg, X); }
0cd8e231	228	#define HW_DEV_ACQUISITION_START(X) \
695dc859 UH	229	static int dev_acquisition_start_##X(const struct sr_dev_inst *sdi \
695dc859 UH	230	) { return dev_acquisition_start(sdi, X); }
0cd8e231 UH	231
	232	/* Driver structs and API function wrappers */
	233	#define DRV(ID, ID_UPPER, NAME, LONGNAME) \
	234	HW_INIT(ID_UPPER) \
0cd8e231	235	HW_SCAN(ID_UPPER) \
e07edc83	236	HW_CONFIG_LIST(ID_UPPER) \
0cd8e231 UH	237	HW_DEV_ACQUISITION_START(ID_UPPER) \
	238	SR_PRIV struct sr_dev_driver ID##_driver_info = { \
	239	.name = NAME, \
	240	.longname = LONGNAME, \
	241	.api_version = 1, \
6078d2c9	242	.init = init_##ID_UPPER, \
700d6b64	243	.cleanup = std_cleanup, \
6078d2c9	244	.scan = scan_##ID_UPPER, \
c01bf34c	245	.dev_list = std_dev_list, \
0cd8e231 UH	246	.config_get = NULL, \
0cd8e231 UH	247	.config_set = config_set, \
e07edc83	248	.config_list = config_list_##ID_UPPER, \
854434de	249	.dev_open = std_serial_dev_open, \
bf2c987f	250	.dev_close = std_serial_dev_close, \
6078d2c9 UH	251	.dev_acquisition_start = dev_acquisition_start_##ID_UPPER, \
6078d2c9 UH	252	.dev_acquisition_stop = dev_acquisition_stop, \
41812aca	253	.context = NULL, \
7ec5b549	254	};
0cd8e231	255
6f3e5335	256	DRV(mic_98581, MIC_98581, "mic-98581", "MIC 98581")
0cd8e231	257	DRV(mic_98583, MIC_98583, "mic-98583", "MIC 98583")