[libsigrok.git] / session_driver.c

/*
 * This file is part of the sigrok project.
 *
 * Copyright (C) 2011 Bert Vermeulen <bert@biot.com>
 *
 * 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 <sys/types.h>
#include <sys/stat.h>
#include <fcntl.h>
#include <unistd.h>
#include <sys/time.h>
#include <zip.h>
#include <sigrok.h>
#include <sigrok-internal.h>

/* size of payloads sent across the session bus */
#define CHUNKSIZE 4096

struct session_vdevice {
	char *capturefile;
	struct zip *archive;
	struct zip_file *capfile;
	uint64_t samplerate;
	int unitsize;
	int num_probes;
};

static char *sessionfile = NULL;
static GSList *device_instances = NULL;
static int capabilities[] = {
	SR_HWCAP_CAPTUREFILE,
	SR_HWCAP_CAPTURE_UNITSIZE,
	0,
};


static struct session_vdevice *get_vdevice_by_index(int device_index)
{
	struct sr_device_instance *sdi;
	struct session_vdevice *vdevice;

	if (!(sdi = sr_get_device_instance(device_instances, device_index)))
		return NULL;

	vdevice = sdi->priv;

	return vdevice;
}

static int feed_chunk(int fd, int revents, void *session_data)
{
	struct sr_device_instance *sdi;
	struct session_vdevice *vdevice;
	struct sr_datafeed_packet packet;
	struct sr_datafeed_logic logic;
	GSList *l;
	void *buf;
	int ret, got_data;

	/* avoid compiler warning */
	fd = fd;
	revents = revents;

	sr_dbg("session_driver: feed chunk");

	got_data = FALSE;
	for (l = device_instances; l; l = l->next) {
		sdi = l->data;
		vdevice = sdi->priv;
		if (!vdevice)
			/* already done with this instance */
			continue;

		if (!(buf = g_try_malloc(CHUNKSIZE))) {
			sr_err("session: %s: buf malloc failed", __func__);
			// return SR_ERR_MALLOC;
			return FALSE;
		}

		ret = zip_fread(vdevice->capfile, buf, CHUNKSIZE);
		if (ret > 0) {
			got_data = TRUE;
			packet.type = SR_DF_LOGIC;
			packet.timeoffset = 0;
			packet.duration = 0;
			packet.payload = &logic;
			logic.length = ret;
			logic.unitsize = vdevice->unitsize;
			logic.data = buf;
			sr_session_bus(session_data, &packet);
		} else {
			/* done with this capture file */
			zip_fclose(vdevice->capfile);
			g_free(vdevice->capturefile);
			g_free(vdevice);
			sdi->priv = NULL;
		}
	}

	if (!got_data) {
		packet.type = SR_DF_END;
		sr_session_bus(session_data, &packet);
	}

	return TRUE;
}

/* driver callbacks */
static void hw_cleanup(void);

static int hw_init(const char *deviceinfo)
{
	hw_cleanup();

	sessionfile = g_strdup(deviceinfo);

	return 0;
}

static void hw_cleanup(void)
{
	GSList *l;

	for (l = device_instances; l; l = l->next)
		sr_device_instance_free(l->data);

	g_slist_free(device_instances);
	device_instances = NULL;

	sr_session_source_remove(-1);

	g_free(sessionfile);

}

static int hw_opendev(int device_index)
{
	struct sr_device_instance *sdi;

	sdi = sr_device_instance_new(device_index, SR_ST_INITIALIZING,
		NULL, NULL, NULL);
	if (!sdi)
		return SR_ERR;

	if (!(sdi->priv = g_try_malloc0(sizeof(struct session_vdevice)))) {
		sr_err("session: %s: sdi->priv malloc failed", __func__);
		return SR_ERR_MALLOC;
	}

	device_instances = g_slist_append(device_instances, sdi);

	return SR_OK;
}

static void *hw_get_device_info(int device_index, int device_info_id)
{
	struct session_vdevice *vdevice;
	void *info;

	if (device_info_id != SR_DI_CUR_SAMPLERATE)
		return NULL;

	if (!(vdevice = get_vdevice_by_index(device_index)))
		return NULL;

	info = &vdevice->samplerate;

	return info;
}

static int hw_get_status(int device_index)
{

	/* avoid compiler warning */
	device_index = device_index;

	if (devices)
		return SR_OK;
	else
		return SR_ERR;
}

static int *hw_get_capabilities(void)
{

	return capabilities;
}

static int hw_set_configuration(int device_index, int capability, void *value)
{
	struct session_vdevice *vdevice;
	uint64_t *tmp_u64;

	if (!(vdevice = get_vdevice_by_index(device_index)))
		return SR_ERR;

	switch (capability) {
	case SR_HWCAP_SAMPLERATE:
		tmp_u64 = value;
		vdevice->samplerate = *tmp_u64;
		break;
	case SR_HWCAP_CAPTUREFILE:
		vdevice->capturefile = g_strdup(value);
		break;
	case SR_HWCAP_CAPTURE_UNITSIZE:
		tmp_u64 = value;
		vdevice->unitsize = *tmp_u64;
		break;
	case SR_HWCAP_CAPTURE_NUM_PROBES:
		tmp_u64 = value;
		vdevice->num_probes = *tmp_u64;
		break;
	default:
		return SR_ERR;
	}

	return SR_OK;
}

static int hw_start_acquisition(int device_index, gpointer session_device_id)
{
	struct zip_stat zs;
	struct session_vdevice *vdevice;
	struct sr_datafeed_header *header;
	struct sr_datafeed_packet *packet;
	int err;

	/* avoid compiler warning */
	session_device_id = session_device_id;

	if (!(vdevice = get_vdevice_by_index(device_index)))
		return SR_ERR;

	sr_info("session_driver: opening archive %s file %s", sessionfile,
		vdevice->capturefile);

	if (!(vdevice->archive = zip_open(sessionfile, 0, &err))) {
		sr_warn("Failed to open session file '%s': zip error %d\n",
			sessionfile, err);
		return SR_ERR;
	}

	if (zip_stat(vdevice->archive, vdevice->capturefile, 0, &zs) == -1) {
		sr_warn("Failed to check capture file '%s' in session file '%s'.",
			vdevice->capturefile, sessionfile);
		return SR_ERR;
	}

	if (!(vdevice->capfile = zip_fopen(vdevice->archive, vdevice->capturefile, 0))) {
		sr_warn("Failed to open capture file '%s' in session file '%s'.",
			vdevice->capturefile, sessionfile);
		return SR_ERR;
	}

	/* freewheeling source */
	sr_session_source_add(-1, 0, 0, feed_chunk, session_device_id);

	if (!(packet = g_try_malloc(sizeof(struct sr_datafeed_packet)))) {
		sr_err("session: %s: packet malloc failed", __func__);
		return SR_ERR_MALLOC;
	}

	if (!(header = g_try_malloc(sizeof(struct sr_datafeed_header)))) {
		sr_err("session: %s: header malloc failed", __func__);
		return SR_ERR_MALLOC;
	}

	/* Send header packet to the session bus. */
	packet->type = SR_DF_HEADER;
	packet->payload = (unsigned char *)header;
	header->feed_version = 1;
	gettimeofday(&header->starttime, NULL);
	header->samplerate = 0;
	header->num_logic_probes = vdevice->num_probes;
	header->num_analog_probes = 0;
	sr_session_bus(session_device_id, packet);
	g_free(header);
	g_free(packet);

	return SR_OK;
}

struct sr_device_plugin session_driver = {
	"session",
	"Session-emulating driver",
	1,
	hw_init,
	hw_cleanup,
	hw_opendev,
	NULL,
	hw_get_device_info,
	hw_get_status,
	hw_get_capabilities,
	hw_set_configuration,
	hw_start_acquisition,
	NULL,
};
Commit	Line	Data
7d658874 BV	1	/*
	2	* This file is part of the sigrok project.
	3	*
	4	* Copyright (C) 2011 Bert Vermeulen <bert@biot.com>
	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 <sys/types.h>
	21	#include <sys/stat.h>
	22	#include <fcntl.h>
	23	#include <unistd.h>
	24	#include <sys/time.h>
	25	#include <zip.h>
	26	#include <sigrok.h>
b08024a8	27	#include <sigrok-internal.h>
7d658874 BV	28
	29	/* size of payloads sent across the session bus */
	30	#define CHUNKSIZE 4096
	31
	32	struct session_vdevice {
	33	char *capturefile;
	34	struct zip *archive;
	35	struct zip_file *capfile;
	36	uint64_t samplerate;
	37	int unitsize;
	38	int num_probes;
	39	};
	40
	41	static char *sessionfile = NULL;
	42	static GSList *device_instances = NULL;
	43	static int capabilities[] = {
	44	SR_HWCAP_CAPTUREFILE,
	45	SR_HWCAP_CAPTURE_UNITSIZE,
	46	0,
	47	};
	48
	49
	50	static struct session_vdevice *get_vdevice_by_index(int device_index)
	51	{
	52	struct sr_device_instance *sdi;
	53	struct session_vdevice *vdevice;
	54
	55	if (!(sdi = sr_get_device_instance(device_instances, device_index)))
	56	return NULL;
	57
	58	vdevice = sdi->priv;
	59
	60	return vdevice;
	61	}
	62
9c939c51	63	static int feed_chunk(int fd, int revents, void *session_data)
7d658874 BV	64	{
	65	struct sr_device_instance *sdi;
	66	struct session_vdevice *vdevice;
	67	struct sr_datafeed_packet packet;
9c939c51	68	struct sr_datafeed_logic logic;
7d658874 BV	69	GSList *l;
	70	void *buf;
	71	int ret, got_data;
	72
	73	/* avoid compiler warning */
	74	fd = fd;
	75	revents = revents;
	76
b08024a8	77	sr_dbg("session_driver: feed chunk");
7d658874 BV	78
	79	got_data = FALSE;
	80	for (l = device_instances; l; l = l->next) {
	81	sdi = l->data;
	82	vdevice = sdi->priv;
	83	if (!vdevice)
	84	/* already done with this instance */
	85	continue;
	86
b53738ba UH	87	if (!(buf = g_try_malloc(CHUNKSIZE))) {
	88	sr_err("session: %s: buf malloc failed", __func__);
	89	// return SR_ERR_MALLOC;
	90	return FALSE;
	91	}
	92
7d658874 BV	93	ret = zip_fread(vdevice->capfile, buf, CHUNKSIZE);
	94	if (ret > 0) {
	95	got_data = TRUE;
	96	packet.type = SR_DF_LOGIC;
9c939c51 BV	97	packet.timeoffset = 0;
	98	packet.duration = 0;
	99	packet.payload = &logic;
	100	logic.length = ret;
	101	logic.unitsize = vdevice->unitsize;
	102	logic.data = buf;
	103	sr_session_bus(session_data, &packet);
7d658874 BV	104	} else {
	105	/* done with this capture file */
	106	zip_fclose(vdevice->capfile);
	107	g_free(vdevice->capturefile);
	108	g_free(vdevice);
	109	sdi->priv = NULL;
	110	}
	111	}
	112
	113	if (!got_data) {
	114	packet.type = SR_DF_END;
9c939c51	115	sr_session_bus(session_data, &packet);
7d658874 BV	116	}
	117
	118	return TRUE;
	119	}
	120
	121	/* driver callbacks */
805e9640	122	static void hw_cleanup(void);
7d658874	123
54ac5277	124	static int hw_init(const char *deviceinfo)
7d658874	125	{
805e9640	126	hw_cleanup();
7d658874 BV	127
	128	sessionfile = g_strdup(deviceinfo);
	129
	130	return 0;
	131	}
	132
	133	static void hw_cleanup(void)
	134	{
	135	GSList *l;
	136
	137	for (l = device_instances; l; l = l->next)
	138	sr_device_instance_free(l->data);
	139
805e9640 GM	140	g_slist_free(device_instances);
	141	device_instances = NULL;
	142
	143	sr_session_source_remove(-1);
	144
7d658874 BV	145	g_free(sessionfile);
	146
	147	}
	148
	149	static int hw_opendev(int device_index)
	150	{
	151	struct sr_device_instance *sdi;
	152
	153	sdi = sr_device_instance_new(device_index, SR_ST_INITIALIZING,
	154	NULL, NULL, NULL);
	155	if (!sdi)
	156	return SR_ERR;
b53738ba UH	157
	158	if (!(sdi->priv = g_try_malloc0(sizeof(struct session_vdevice)))) {
	159	sr_err("session: %s: sdi->priv malloc failed", __func__);
	160	return SR_ERR_MALLOC;
	161	}
	162
7d658874 BV	163	device_instances = g_slist_append(device_instances, sdi);
	164
	165	return SR_OK;
	166	}
	167
7d658874 BV	168	static void *hw_get_device_info(int device_index, int device_info_id)
	169	{
	170	struct session_vdevice *vdevice;
	171	void *info;
	172
b8c2f85f BV	173	if (device_info_id != SR_DI_CUR_SAMPLERATE)
	174	return NULL;
	175
7d658874 BV	176	if (!(vdevice = get_vdevice_by_index(device_index)))
	177	return NULL;
	178
	179	info = &vdevice->samplerate;
	180
	181	return info;
	182	}
	183
	184	static int hw_get_status(int device_index)
	185	{
	186
	187	/* avoid compiler warning */
	188	device_index = device_index;
	189
	190	if (devices)
	191	return SR_OK;
	192	else
	193	return SR_ERR;
	194	}
	195
	196	static int *hw_get_capabilities(void)
	197	{
	198
	199	return capabilities;
	200	}
	201
	202	static int hw_set_configuration(int device_index, int capability, void *value)
	203	{
	204	struct session_vdevice *vdevice;
	205	uint64_t *tmp_u64;
	206
	207	if (!(vdevice = get_vdevice_by_index(device_index)))
	208	return SR_ERR;
	209
	210	switch (capability) {
	211	case SR_HWCAP_SAMPLERATE:
	212	tmp_u64 = value;
	213	vdevice->samplerate = *tmp_u64;
	214	break;
	215	case SR_HWCAP_CAPTUREFILE:
	216	vdevice->capturefile = g_strdup(value);
	217	break;
	218	case SR_HWCAP_CAPTURE_UNITSIZE:
	219	tmp_u64 = value;
	220	vdevice->unitsize = *tmp_u64;
	221	break;
	222	case SR_HWCAP_CAPTURE_NUM_PROBES:
	223	tmp_u64 = value;
	224	vdevice->num_probes = *tmp_u64;
	225	break;
	226	default:
	227	return SR_ERR;
	228	}
	229
	230	return SR_OK;
	231	}
	232
	233	static int hw_start_acquisition(int device_index, gpointer session_device_id)
	234	{
	235	struct zip_stat zs;
	236	struct session_vdevice *vdevice;
	237	struct sr_datafeed_header *header;
	238	struct sr_datafeed_packet *packet;
	239	int err;
240
241	/* avoid compiler warning */
242	session_device_id = session_device_id;
243
244	if (!(vdevice = get_vdevice_by_index(device_index)))
245	return SR_ERR;
246
b08024a8 UH	247	sr_info("session_driver: opening archive %s file %s", sessionfile,
b08024a8 UH	248	vdevice->capturefile);
7d658874 BV	249
7d658874 BV	250	if (!(vdevice->archive = zip_open(sessionfile, 0, &err))) {
b08024a8 UH	251	sr_warn("Failed to open session file '%s': zip error %d\n",
b08024a8 UH	252	sessionfile, err);
7d658874 BV	253	return SR_ERR;
	254	}
	255
	256	if (zip_stat(vdevice->archive, vdevice->capturefile, 0, &zs) == -1) {
b08024a8 UH	257	sr_warn("Failed to check capture file '%s' in session file '%s'.",
b08024a8 UH	258	vdevice->capturefile, sessionfile);
7d658874 BV	259	return SR_ERR;
	260	}
	261
	262	if (!(vdevice->capfile = zip_fopen(vdevice->archive, vdevice->capturefile, 0))) {
b08024a8 UH	263	sr_warn("Failed to open capture file '%s' in session file '%s'.",
b08024a8 UH	264	vdevice->capturefile, sessionfile);
7d658874 BV	265	return SR_ERR;
	266	}
	267
	268	/* freewheeling source */
8a2efef2	269	sr_session_source_add(-1, 0, 0, feed_chunk, session_device_id);
7d658874	270
b53738ba UH	271	if (!(packet = g_try_malloc(sizeof(struct sr_datafeed_packet)))) {
	272	sr_err("session: %s: packet malloc failed", __func__);
	273	return SR_ERR_MALLOC;
	274	}
	275
	276	if (!(header = g_try_malloc(sizeof(struct sr_datafeed_header)))) {
	277	sr_err("session: %s: header malloc failed", __func__);
	278	return SR_ERR_MALLOC;
	279	}
	280
7d658874	281	/* Send header packet to the session bus. */
7d658874	282	packet->type = SR_DF_HEADER;
7d658874 BV	283	packet->payload = (unsigned char *)header;
	284	header->feed_version = 1;
	285	gettimeofday(&header->starttime, NULL);
	286	header->samplerate = 0;
7d658874 BV	287	header->num_logic_probes = vdevice->num_probes;
7d658874 BV	288	header->num_analog_probes = 0;
8a2efef2	289	sr_session_bus(session_device_id, packet);
7d658874 BV	290	g_free(header);
	291	g_free(packet);
	292
	293	return SR_OK;
	294	}
	295
7d658874 BV	296	struct sr_device_plugin session_driver = {
	297	"session",
	298	"Session-emulating driver",
	299	1,
	300	hw_init,
	301	hw_cleanup,
	302	hw_opendev,
b8c2f85f	303	NULL,
7d658874 BV	304	hw_get_device_info,
	305	hw_get_status,
	306	hw_get_capabilities,
	307	hw_set_configuration,
	308	hw_start_acquisition,
8a2efef2	309	NULL,
7d658874	310	};