[libsigrok.git] / src / hardware / teleinfo / api.c

/*
 * This file is part of the libsigrok project.
 *
 * Copyright (C) 2013 Aurelien Jacobs <aurel@gnuage.org>
 *
 * 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 3 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, see <http://www.gnu.org/licenses/>.
 */

#include <stdlib.h>
#include <glib.h>
#include "libsigrok.h"
#include "libsigrok-internal.h"
#include "protocol.h"

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

static const uint32_t devopts[] = {
	SR_CONF_ENERGYMETER,
	SR_CONF_CONTINUOUS,
	SR_CONF_LIMIT_SAMPLES | SR_CONF_SET,
	SR_CONF_LIMIT_MSEC | SR_CONF_SET,
};

SR_PRIV struct sr_dev_driver teleinfo_driver_info;
static struct sr_dev_driver *di = &teleinfo_driver_info;

static int init(struct sr_context *sr_ctx)
{
	return std_init(sr_ctx, di, LOG_PREFIX);
}

static GSList *scan(GSList *options)
{
	struct drv_context *drvc;
	struct dev_context *devc;
	struct sr_serial_dev_inst *serial;
	struct sr_dev_inst *sdi;
	struct sr_channel *ch;
	GSList *devices = NULL, *l;
	const char *conn = NULL, *serialcomm = NULL;
	uint8_t buf[292];
	size_t len;
	struct sr_config *src;

	len = sizeof(buf);

	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)
		serialcomm = "1200/7e1";

	if (!(serial = sr_serial_dev_inst_new(conn, serialcomm)))
		return NULL;
	if (serial_open(serial, SERIAL_RDONLY) != SR_OK)
		return NULL;

	sr_info("Probing serial port %s.", conn);

	drvc = di->priv;
	drvc->instances = NULL;
	serial_flush(serial);

	/* Let's get a bit of data and see if we can find a packet. */
	if (serial_stream_detect(serial, buf, &len, len,
	                         teleinfo_packet_valid, 3000, 1200) != SR_OK)
		goto scan_cleanup;

	sr_info("Found device on port %s.", conn);

	sdi = g_malloc0(sizeof(struct sr_dev_inst));
	sdi->status = SR_ST_INACTIVE;
	sdi->vendor = g_strdup("EDF");
	sdi->model = g_strdup("Teleinfo");
	devc = g_malloc0(sizeof(struct dev_context));
	devc->optarif = teleinfo_get_optarif(buf);
	sdi->inst_type = SR_INST_SERIAL;
	sdi->conn = serial;
	sdi->priv = devc;
	sdi->driver = di;

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

	if (devc->optarif == OPTARIF_BASE) {
		ch = sr_channel_new(0, SR_CHANNEL_ANALOG, TRUE, "BASE");
		sdi->channels = g_slist_append(sdi->channels, ch);
	} else if (devc->optarif == OPTARIF_HC) {
		ch = sr_channel_new(0, SR_CHANNEL_ANALOG, TRUE, "HP");
		sdi->channels = g_slist_append(sdi->channels, ch);
		ch = sr_channel_new(0, SR_CHANNEL_ANALOG, TRUE, "HC");
		sdi->channels = g_slist_append(sdi->channels, ch);
	} else if (devc->optarif == OPTARIF_EJP) {
		ch = sr_channel_new(0, SR_CHANNEL_ANALOG, TRUE, "HN");
		sdi->channels = g_slist_append(sdi->channels, ch);
		ch = sr_channel_new(0, SR_CHANNEL_ANALOG, TRUE, "HPM");
		sdi->channels = g_slist_append(sdi->channels, ch);
	} else if (devc->optarif == OPTARIF_BBR) {
		ch = sr_channel_new(0, SR_CHANNEL_ANALOG, TRUE, "HPJB");
		sdi->channels = g_slist_append(sdi->channels, ch);
		ch = sr_channel_new(0, SR_CHANNEL_ANALOG, TRUE, "HPJW");
		sdi->channels = g_slist_append(sdi->channels, ch);
		ch = sr_channel_new(0, SR_CHANNEL_ANALOG, TRUE, "HPJR");
		sdi->channels = g_slist_append(sdi->channels, ch);
		ch = sr_channel_new(0, SR_CHANNEL_ANALOG, TRUE, "HCJB");
		sdi->channels = g_slist_append(sdi->channels, ch);
		ch = sr_channel_new(0, SR_CHANNEL_ANALOG, TRUE, "HCJW");
		sdi->channels = g_slist_append(sdi->channels, ch);
		ch = sr_channel_new(0, SR_CHANNEL_ANALOG, TRUE, "HCJR");
		sdi->channels = g_slist_append(sdi->channels, ch);
	}

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

	ch = sr_channel_new(0, SR_CHANNEL_ANALOG, TRUE, "PAPP");
	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 *dev_list(void)
{
	return ((struct drv_context *)(di->priv))->instances;
}

static int cleanup(void)
{
	return std_dev_clear(di, NULL);
}

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;

	if (!(devc = sdi->priv)) {
		sr_err("sdi->priv was NULL.");
		return SR_ERR_BUG;
	}

	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)sdi;
	(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:
		*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)
{
	struct sr_serial_dev_inst *serial = sdi->conn;
	struct dev_context *devc;

	if (sdi->status != SR_ST_ACTIVE)
		return SR_ERR_DEV_CLOSED;

	if (!(devc = sdi->priv)) {
		sr_err("sdi->priv was NULL.");
		return SR_ERR_BUG;
	}

	devc->session_cb_data = cb_data;

	/*
	 * Reset the number of samples to take. If we've already collected our
	 * quota, but we start a new session, and don't reset this, we'll just
	 * quit without acquiring any new samples.
	 */
	devc->num_samples = 0;
	devc->start_time = g_get_monotonic_time();

	/* Send header packet to the session bus. */
	std_session_send_df_header(cb_data, LOG_PREFIX);

	/* Poll every 50ms, or whenever some data comes in. */
	serial_source_add(sdi->session, serial, G_IO_IN, 50,
			teleinfo_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);
}

SR_PRIV struct sr_dev_driver teleinfo_driver_info = {
	.name = "teleinfo",
	.longname = "Teleinfo",
	.api_version = 1,
	.init = init,
	.cleanup = cleanup,
	.scan = scan,
	.dev_list = dev_list,
	.dev_clear = NULL,
	.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,
	.dev_acquisition_stop = dev_acquisition_stop,
	.priv = NULL,
};
Commit	Line	Data
8e796cb4 AJ	1	/*
	2	* This file is part of the libsigrok project.
	3	*
	4	* Copyright (C) 2013 Aurelien Jacobs <aurel@gnuage.org>
	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 3 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, see <http://www.gnu.org/licenses/>.
	18	*/
	19
5542bee6 AJ	20	#include <stdlib.h>
	21	#include <glib.h>
	22	#include "libsigrok.h"
	23	#include "libsigrok-internal.h"
8e796cb4 AJ	24	#include "protocol.h"
8e796cb4 AJ	25
a0e0bb41	26	static const uint32_t scanopts[] = {
5542bee6 AJ	27	SR_CONF_CONN,
	28	SR_CONF_SERIALCOMM,
	29	};
	30
f254bc4b	31	static const uint32_t devopts[] = {
5542bee6	32	SR_CONF_ENERGYMETER,
5542bee6	33	SR_CONF_CONTINUOUS,
5827f61b BV	34	SR_CONF_LIMIT_SAMPLES \| SR_CONF_SET,
5827f61b BV	35	SR_CONF_LIMIT_MSEC \| SR_CONF_SET,
5542bee6 AJ	36	};
5542bee6 AJ	37
8e796cb4 AJ	38	SR_PRIV struct sr_dev_driver teleinfo_driver_info;
	39	static struct sr_dev_driver *di = &teleinfo_driver_info;
	40
	41	static int init(struct sr_context *sr_ctx)
	42	{
	43	return std_init(sr_ctx, di, LOG_PREFIX);
	44	}
	45
	46	static GSList scan(GSList options)
	47	{
	48	struct drv_context *drvc;
5542bee6 AJ	49	struct dev_context *devc;
	50	struct sr_serial_dev_inst *serial;
	51	struct sr_dev_inst *sdi;
ba7dd8bb	52	struct sr_channel *ch;
5542bee6 AJ	53	GSList devices = NULL, l;
	54	const char conn = NULL, serialcomm = NULL;
	55	uint8_t buf[292];
dafafb0e UH	56	size_t len;
	57	struct sr_config *src;
	58
	59	len = sizeof(buf);
5542bee6 AJ	60
5542bee6 AJ	61	for (l = options; l; l = l->next) {
dafafb0e	62	src = l->data;
5542bee6 AJ	63	switch (src->key) {
	64	case SR_CONF_CONN:
	65	conn = g_variant_get_string(src->data, NULL);
	66	break;
	67	case SR_CONF_SERIALCOMM:
	68	serialcomm = g_variant_get_string(src->data, NULL);
	69	break;
	70	}
	71	}
	72	if (!conn)
	73	return NULL;
	74	if (!serialcomm)
	75	serialcomm = "1200/7e1";
	76
	77	if (!(serial = sr_serial_dev_inst_new(conn, serialcomm)))
	78	return NULL;
9333691a	79	if (serial_open(serial, SERIAL_RDONLY) != SR_OK)
5542bee6	80	return NULL;
8e796cb4	81
5542bee6	82	sr_info("Probing serial port %s.", conn);
8e796cb4	83
8e796cb4 AJ	84	drvc = di->priv;
8e796cb4 AJ	85	drvc->instances = NULL;
5542bee6 AJ	86	serial_flush(serial);
	87
	88	/* Let's get a bit of data and see if we can find a packet. */
	89	if (serial_stream_detect(serial, buf, &len, len,
	90	teleinfo_packet_valid, 3000, 1200) != SR_OK)
	91	goto scan_cleanup;
	92
	93	sr_info("Found device on port %s.", conn);
	94
aac29cc1	95	sdi = g_malloc0(sizeof(struct sr_dev_inst));
0af636be UH	96	sdi->status = SR_ST_INACTIVE;
	97	sdi->vendor = g_strdup("EDF");
	98	sdi->model = g_strdup("Teleinfo");
f57d8ffe	99	devc = g_malloc0(sizeof(struct dev_context));
5542bee6	100	devc->optarif = teleinfo_get_optarif(buf);
5542bee6 AJ	101	sdi->inst_type = SR_INST_SERIAL;
	102	sdi->conn = serial;
	103	sdi->priv = devc;
	104	sdi->driver = di;
	105
c368e6f3	106	ch = sr_channel_new(0, SR_CHANNEL_ANALOG, TRUE, "P");
ba7dd8bb	107	sdi->channels = g_slist_append(sdi->channels, ch);
5542bee6 AJ	108
5542bee6 AJ	109	if (devc->optarif == OPTARIF_BASE) {
c368e6f3	110	ch = sr_channel_new(0, SR_CHANNEL_ANALOG, TRUE, "BASE");
ba7dd8bb	111	sdi->channels = g_slist_append(sdi->channels, ch);
5542bee6	112	} else if (devc->optarif == OPTARIF_HC) {
c368e6f3	113	ch = sr_channel_new(0, SR_CHANNEL_ANALOG, TRUE, "HP");
ba7dd8bb	114	sdi->channels = g_slist_append(sdi->channels, ch);
c368e6f3	115	ch = sr_channel_new(0, SR_CHANNEL_ANALOG, TRUE, "HC");
ba7dd8bb	116	sdi->channels = g_slist_append(sdi->channels, ch);
5542bee6	117	} else if (devc->optarif == OPTARIF_EJP) {
c368e6f3	118	ch = sr_channel_new(0, SR_CHANNEL_ANALOG, TRUE, "HN");
ba7dd8bb	119	sdi->channels = g_slist_append(sdi->channels, ch);
c368e6f3	120	ch = sr_channel_new(0, SR_CHANNEL_ANALOG, TRUE, "HPM");
ba7dd8bb	121	sdi->channels = g_slist_append(sdi->channels, ch);
5542bee6	122	} else if (devc->optarif == OPTARIF_BBR) {
c368e6f3	123	ch = sr_channel_new(0, SR_CHANNEL_ANALOG, TRUE, "HPJB");
ba7dd8bb	124	sdi->channels = g_slist_append(sdi->channels, ch);
c368e6f3	125	ch = sr_channel_new(0, SR_CHANNEL_ANALOG, TRUE, "HPJW");
ba7dd8bb	126	sdi->channels = g_slist_append(sdi->channels, ch);
c368e6f3	127	ch = sr_channel_new(0, SR_CHANNEL_ANALOG, TRUE, "HPJR");
ba7dd8bb	128	sdi->channels = g_slist_append(sdi->channels, ch);
c368e6f3	129	ch = sr_channel_new(0, SR_CHANNEL_ANALOG, TRUE, "HCJB");
ba7dd8bb	130	sdi->channels = g_slist_append(sdi->channels, ch);
c368e6f3	131	ch = sr_channel_new(0, SR_CHANNEL_ANALOG, TRUE, "HCJW");
ba7dd8bb	132	sdi->channels = g_slist_append(sdi->channels, ch);
c368e6f3	133	ch = sr_channel_new(0, SR_CHANNEL_ANALOG, TRUE, "HCJR");
ba7dd8bb	134	sdi->channels = g_slist_append(sdi->channels, ch);
5542bee6 AJ	135	}
5542bee6 AJ	136
c368e6f3	137	ch = sr_channel_new(0, SR_CHANNEL_ANALOG, TRUE, "IINST");
ba7dd8bb	138	sdi->channels = g_slist_append(sdi->channels, ch);
8e796cb4	139
c368e6f3	140	ch = sr_channel_new(0, SR_CHANNEL_ANALOG, TRUE, "PAPP");
ba7dd8bb	141	sdi->channels = g_slist_append(sdi->channels, ch);
5542bee6 AJ	142
	143	drvc->instances = g_slist_append(drvc->instances, sdi);
	144	devices = g_slist_append(devices, sdi);
	145
	146	scan_cleanup:
	147	serial_close(serial);
8e796cb4 AJ	148
	149	return devices;
	150	}
	151
	152	static GSList *dev_list(void)
	153	{
	154	return ((struct drv_context *)(di->priv))->instances;
	155	}
	156
8e796cb4 AJ	157	static int cleanup(void)
8e796cb4 AJ	158	{
a6630742	159	return std_dev_clear(di, NULL);
8e796cb4 AJ	160	}
8e796cb4 AJ	161
584560f1	162	static int config_set(uint32_t key, GVariant data, const struct sr_dev_inst sdi,
53b4680f	163	const struct sr_channel_group *cg)
8e796cb4	164	{
5542bee6	165	struct dev_context *devc;
8e796cb4	166
53b4680f	167	(void)cg;
d3c74a6f	168
8e796cb4 AJ	169	if (sdi->status != SR_ST_ACTIVE)
	170	return SR_ERR_DEV_CLOSED;
	171
5542bee6 AJ	172	if (!(devc = sdi->priv)) {
	173	sr_err("sdi->priv was NULL.");
	174	return SR_ERR_BUG;
	175	}
	176
8e796cb4	177	switch (key) {
5542bee6 AJ	178	case SR_CONF_LIMIT_SAMPLES:
	179	devc->limit_samples = g_variant_get_uint64(data);
	180	sr_dbg("Setting sample limit to %" PRIu64 ".", devc->limit_samples);
	181	break;
	182	case SR_CONF_LIMIT_MSEC:
	183	devc->limit_msec = g_variant_get_uint64(data);
	184	sr_dbg("Setting time limit to %" PRIu64 "ms.", devc->limit_msec);
	185	break;
8e796cb4	186	default:
5542bee6	187	return SR_ERR_NA;
8e796cb4 AJ	188	}
8e796cb4 AJ	189
5542bee6	190	return SR_OK;
8e796cb4 AJ	191	}
8e796cb4 AJ	192
584560f1	193	static int config_list(uint32_t key, GVariant *data, const struct sr_dev_inst sdi,
53b4680f	194	const struct sr_channel_group *cg)
8e796cb4	195	{
8e796cb4	196	(void)sdi;
53b4680f	197	(void)cg;
8e796cb4	198
8e796cb4	199	switch (key) {
5542bee6	200	case SR_CONF_SCAN_OPTIONS:
584560f1	201	*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
a0e0bb41	202	scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
5542bee6 AJ	203	break;
5542bee6 AJ	204	case SR_CONF_DEVICE_OPTIONS:
584560f1	205	*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
f254bc4b	206	devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
5542bee6	207	break;
8e796cb4 AJ	208	default:
	209	return SR_ERR_NA;
	210	}
	211
5542bee6	212	return SR_OK;
8e796cb4 AJ	213	}
8e796cb4 AJ	214
5542bee6	215	static int dev_acquisition_start(const struct sr_dev_inst sdi, void cb_data)
8e796cb4	216	{
5542bee6 AJ	217	struct sr_serial_dev_inst *serial = sdi->conn;
5542bee6 AJ	218	struct dev_context *devc;
8e796cb4 AJ	219
	220	if (sdi->status != SR_ST_ACTIVE)
	221	return SR_ERR_DEV_CLOSED;
	222
5542bee6 AJ	223	if (!(devc = sdi->priv)) {
	224	sr_err("sdi->priv was NULL.");
	225	return SR_ERR_BUG;
	226	}
8e796cb4	227
5542bee6	228	devc->session_cb_data = cb_data;
8e796cb4	229
5542bee6 AJ	230	/*
	231	* Reset the number of samples to take. If we've already collected our
	232	* quota, but we start a new session, and don't reset this, we'll just
	233	* quit without acquiring any new samples.
	234	*/
	235	devc->num_samples = 0;
	236	devc->start_time = g_get_monotonic_time();
8e796cb4	237
5542bee6 AJ	238	/* Send header packet to the session bus. */
5542bee6 AJ	239	std_session_send_df_header(cb_data, LOG_PREFIX);
8e796cb4	240
5542bee6	241	/* Poll every 50ms, or whenever some data comes in. */
102f1239 BV	242	serial_source_add(sdi->session, serial, G_IO_IN, 50,
102f1239 BV	243	teleinfo_receive_data, (void *)sdi);
8e796cb4 AJ	244
	245	return SR_OK;
	246	}
	247
5542bee6 AJ	248	static int dev_acquisition_stop(struct sr_dev_inst sdi, void cb_data)
5542bee6 AJ	249	{
dafafb0e UH	250	return std_serial_dev_acquisition_stop(sdi, cb_data,
dafafb0e UH	251	std_serial_dev_close, sdi->conn, LOG_PREFIX);
5542bee6 AJ	252	}
5542bee6 AJ	253
8e796cb4 AJ	254	SR_PRIV struct sr_dev_driver teleinfo_driver_info = {
	255	.name = "teleinfo",
	256	.longname = "Teleinfo",
	257	.api_version = 1,
	258	.init = init,
	259	.cleanup = cleanup,
	260	.scan = scan,
	261	.dev_list = dev_list,
a6630742	262	.dev_clear = NULL,
dafafb0e	263	.config_get = NULL,
8e796cb4 AJ	264	.config_set = config_set,
8e796cb4 AJ	265	.config_list = config_list,
854434de	266	.dev_open = std_serial_dev_open,
bf2c987f	267	.dev_close = std_serial_dev_close,
8e796cb4 AJ	268	.dev_acquisition_start = dev_acquisition_start,
8e796cb4 AJ	269	.dev_acquisition_stop = dev_acquisition_stop,
dafafb0e	270	.priv = NULL,
8e796cb4	271	};