[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 <config.h>
#include <stdlib.h>
#include <glib.h>
#include <libsigrok/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 int init(struct sr_dev_driver *di, struct sr_context *sr_ctx)
{
	return std_init(sr_ctx, di, LOG_PREFIX);
}

static GSList *scan(struct sr_dev_driver *di, GSList *options)
{
	struct drv_context *drvc;
	struct dev_context *devc;
	struct sr_serial_dev_inst *serial;
	struct sr_dev_inst *sdi;
	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";

	serial = sr_serial_dev_inst_new(conn, serialcomm);

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

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

	drvc = di->context;
	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;

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

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

	sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "IINST");
	sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "PAPP");

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

scan_cleanup:
	serial_close(serial);

	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;

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

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

	devc = sdi->priv;

	/*
	 * 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();

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