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

	serial = sr_serial_dev_inst_new(conn, serialcomm);

	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 = 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;

	ch = sr_channel_new(0, SR_CHANNEL_ANALOG, TRUE, "Temperature");
	sdi->channels = g_slist_append(sdi->channels, ch);

	if (mic_devs[idx].has_humidity) {
		ch = sr_channel_new(1, SR_CHANNEL_ANALOG, TRUE, "Humidity");
		sdi->channels = g_slist_append(sdi->channels, ch);
	}

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