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

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

	devc = sdi->priv;

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

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;

	sr_sw_limits_acquisition_start(&devc->sw_limits);

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

static struct sr_dev_driver teleinfo_driver_info = {
	.name = "teleinfo",
	.longname = "Teleinfo",
	.api_version = 1,
	.init = std_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,
};
SR_REGISTER_DEV_DRIVER(teleinfo_driver_info);
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	static GSList scan(struct sr_dev_driver di, GSList *options)
	40	{
	41	struct drv_context *drvc;
	42	struct dev_context *devc;
	43	struct sr_serial_dev_inst *serial;
	44	struct sr_dev_inst *sdi;
	45	GSList devices = NULL, l;
	46	const char conn = NULL, serialcomm = NULL;
	47	uint8_t buf[292];
	48	size_t len;
	49	struct sr_config *src;
	50
	51	len = sizeof(buf);
	52
	53	for (l = options; l; l = l->next) {
	54	src = l->data;
	55	switch (src->key) {
	56	case SR_CONF_CONN:
	57	conn = g_variant_get_string(src->data, NULL);
	58	break;
	59	case SR_CONF_SERIALCOMM:
	60	serialcomm = g_variant_get_string(src->data, NULL);
	61	break;
	62	}
	63	}
	64	if (!conn)
	65	return NULL;
	66	if (!serialcomm)
	67	serialcomm = "1200/7e1";
	68
	69	serial = sr_serial_dev_inst_new(conn, serialcomm);
	70
	71	if (serial_open(serial, SERIAL_RDONLY) != SR_OK)
	72	return NULL;
	73
	74	sr_info("Probing serial port %s.", conn);
	75
	76	drvc = di->context;
	77	serial_flush(serial);
	78
	79	/* Let's get a bit of data and see if we can find a packet. */
	80	if (serial_stream_detect(serial, buf, &len, len,
	81	teleinfo_packet_valid, 3000, 1200) != SR_OK)
	82	goto scan_cleanup;
	83
	84	sr_info("Found device on port %s.", conn);
	85
	86	sdi = g_malloc0(sizeof(struct sr_dev_inst));
	87	sdi->status = SR_ST_INACTIVE;
	88	sdi->vendor = g_strdup("EDF");
	89	sdi->model = g_strdup("Teleinfo");
	90	devc = g_malloc0(sizeof(struct dev_context));
	91	devc->optarif = teleinfo_get_optarif(buf);
	92	sdi->inst_type = SR_INST_SERIAL;
	93	sdi->conn = serial;
	94	sdi->priv = devc;
	95	sdi->driver = di;
	96
	97	sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "P");
	98
	99	if (devc->optarif == OPTARIF_BASE) {
	100	sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "BASE");
	101	} else if (devc->optarif == OPTARIF_HC) {
	102	sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "HP");
	103	sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "HC");
	104	} else if (devc->optarif == OPTARIF_EJP) {
	105	sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "HN");
	106	sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "HPM");
	107	} else if (devc->optarif == OPTARIF_BBR) {
	108	sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "HPJB");
	109	sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "HPJW");
	110	sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "HPJR");
	111	sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "HCJB");
	112	sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "HCJW");
	113	sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "HCJR");
	114	}
	115
	116	sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "IINST");
	117	sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "PAPP");
	118
	119	drvc->instances = g_slist_append(drvc->instances, sdi);
	120	devices = g_slist_append(devices, sdi);
	121
	122	scan_cleanup:
	123	serial_close(serial);
	124
	125	return devices;
	126	}
	127
	128	static int config_set(uint32_t key, GVariant data, const struct sr_dev_inst sdi,
	129	const struct sr_channel_group *cg)
	130	{
	131	struct dev_context *devc;
	132
	133	(void)cg;
	134
	135	if (sdi->status != SR_ST_ACTIVE)
	136	return SR_ERR_DEV_CLOSED;
	137
	138	devc = sdi->priv;
	139
	140	return sr_sw_limits_config_set(&devc->sw_limits, key, data);
	141	}
	142
	143	static int config_list(uint32_t key, GVariant *data, const struct sr_dev_inst sdi,
	144	const struct sr_channel_group *cg)
	145	{
	146	(void)sdi;
	147	(void)cg;
	148
	149	switch (key) {
	150	case SR_CONF_SCAN_OPTIONS:
	151	*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
	152	scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
	153	break;
	154	case SR_CONF_DEVICE_OPTIONS:
	155	*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
	156	devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
	157	break;
	158	default:
	159	return SR_ERR_NA;
	160	}
	161
	162	return SR_OK;
	163	}
	164
	165	static int dev_acquisition_start(const struct sr_dev_inst *sdi)
	166	{
	167	struct sr_serial_dev_inst *serial = sdi->conn;
	168	struct dev_context *devc;
	169
	170	if (sdi->status != SR_ST_ACTIVE)
	171	return SR_ERR_DEV_CLOSED;
	172
	173	devc = sdi->priv;
	174
	175	sr_sw_limits_acquisition_start(&devc->sw_limits);
	176
	177	std_session_send_df_header(sdi, LOG_PREFIX);
	178
	179	/* Poll every 50ms, or whenever some data comes in. */
	180	serial_source_add(sdi->session, serial, G_IO_IN, 50,
	181	teleinfo_receive_data, (void *)sdi);
	182
	183	return SR_OK;
	184	}
	185
	186	static int dev_acquisition_stop(struct sr_dev_inst *sdi)
	187	{
	188	return std_serial_dev_acquisition_stop(sdi,
	189	std_serial_dev_close, sdi->conn, LOG_PREFIX);
	190	}
	191
	192	static struct sr_dev_driver teleinfo_driver_info = {
	193	.name = "teleinfo",
	194	.longname = "Teleinfo",
	195	.api_version = 1,
	196	.init = std_init,
	197	.cleanup = std_cleanup,
	198	.scan = scan,
	199	.dev_list = std_dev_list,
	200	.dev_clear = NULL,
	201	.config_get = NULL,
	202	.config_set = config_set,
	203	.config_list = config_list,
	204	.dev_open = std_serial_dev_open,
	205	.dev_close = std_serial_dev_close,
	206	.dev_acquisition_start = dev_acquisition_start,
	207	.dev_acquisition_stop = dev_acquisition_stop,
	208	.context = NULL,
	209	};
	210	SR_REGISTER_DEV_DRIVER(teleinfo_driver_info);