[libsigrok.git] / session_driver.c

/*
 * This file is part of the sigrok project.
 *
 * Copyright (C) 2010-2012 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 (512 * 1024)

struct session_vdevice {
	char *capturefile;
	struct zip *archive;
	struct zip_file *capfile;
	int bytes_read;
	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,
};

/**
 * TODO.
 *
 * @param device_index TODO.
 */
static struct session_vdevice *get_vdevice_by_index(int device_index)
{
	struct sr_device_instance *sdi;
	struct session_vdevice *vdevice;

	/* TODO: Sanity checks on device_index. */

	if (!(sdi = sr_dev_inst_get(device_instances, device_index))) {
		sr_err("session driver: %s: device instance with device "
		       "index %d was not found", __func__, device_index);
		return NULL;
	}

	/* TODO: Is sdi->priv == NULL valid? */

	vdevice = sdi->priv;

	return vdevice;
}

/**
 * TODO.
 *
 * @param fd TODO.
 * @param revents TODO.
 * @param session_data TODO.
 *
 * @return TODO.
 */
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 warnings. */
	(void)fd;
	(void)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 FALSE; /* TODO: SR_ERR_MALLOC */
		}

		ret = zip_fread(vdevice->capfile, buf, CHUNKSIZE);
		if (ret > 0) {
			got_data = TRUE;
			packet.type = SR_DF_LOGIC;
			packet.payload = &logic;
			logic.length = ret;
			logic.unitsize = vdevice->unitsize;
			logic.data = buf;
			vdevice->bytes_read += ret;
			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 int hw_cleanup(void);

/**
 * TODO.
 *
 * @param deviceinfo TODO.
 *
 * @return TODO.
 */
static int hw_init(const char *deviceinfo)
{
	sessionfile = g_strdup(deviceinfo);

	return 0;
}

/**
 * TODO.
 *
 */
static int hw_cleanup(void)
{
	GSList *l;

	/* TODO: Error handling. */

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

	g_slist_free(device_instances);
	device_instances = NULL;

	sr_session_source_remove(-1);

	g_free(sessionfile);

	return SR_OK;
}

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

	sdi = sr_dev_inst_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 warnings. */
	(void)device_index;

	if (sr_dev_list() != NULL)
		return SR_OK;
	else
		return SR_ERR;
}

/**
 * Get the list of hardware capabilities.
 *
 * @return A pointer to the (hardware) capabilities of this virtual session
 *         driver. This could be NULL, if no such capabilities exist.
 */
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;
		sr_info("session driver: setting samplerate to %" PRIu64,
		        vdevice->samplerate);
		break;
	case SR_HWCAP_CAPTUREFILE:
		vdevice->capturefile = g_strdup(value);
		sr_info("session driver: setting capturefile to %s",
		        vdevice->capturefile);
		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:
		sr_err("session driver: %s: unknown capability %d requested",
		       __func__, capability);
		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 warnings. */
	(void)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_err("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_err("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_err("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 = vdevice->samplerate;
	header->num_logic_probes = vdevice->num_probes;
	sr_session_bus(session_device_id, packet);
	g_free(header);
	g_free(packet);

	return SR_OK;
}

/* Not static, it's used elsewhere (via 'extern'). */
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	*
c73d2ea4	4	* Copyright (C) 2010-2012 Bert Vermeulen <bert@biot.com>
7d658874 BV	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>
b7f09cf8 UH	26	#include "sigrok.h"
b7f09cf8 UH	27	#include "sigrok-internal.h"
7d658874 BV	28
7d658874 BV	29	/* size of payloads sent across the session bus */
8ff6afc9	30	#define CHUNKSIZE (512 * 1024)
7d658874 BV	31
	32	struct session_vdevice {
	33	char *capturefile;
	34	struct zip *archive;
	35	struct zip_file *capfile;
cb1e389c	36	int bytes_read;
7d658874 BV	37	uint64_t samplerate;
	38	int unitsize;
	39	int num_probes;
	40	};
	41
	42	static char *sessionfile = NULL;
	43	static GSList *device_instances = NULL;
	44	static int capabilities[] = {
	45	SR_HWCAP_CAPTUREFILE,
	46	SR_HWCAP_CAPTURE_UNITSIZE,
	47	0,
	48	};
	49
9f45fb3a UH	50	/**
	51	* TODO.
	52	*
	53	* @param device_index TODO.
	54	*/
7d658874 BV	55	static struct session_vdevice *get_vdevice_by_index(int device_index)
	56	{
	57	struct sr_device_instance *sdi;
	58	struct session_vdevice *vdevice;
	59
9f45fb3a UH	60	/* TODO: Sanity checks on device_index. */
9f45fb3a UH	61
da1466d6	62	if (!(sdi = sr_dev_inst_get(device_instances, device_index))) {
9f45fb3a UH	63	sr_err("session driver: %s: device instance with device "
9f45fb3a UH	64	"index %d was not found", __func__, device_index);
7d658874	65	return NULL;
9f45fb3a UH	66	}
	67
	68	/* TODO: Is sdi->priv == NULL valid? */
7d658874 BV	69
	70	vdevice = sdi->priv;
	71
	72	return vdevice;
	73	}
	74
9f45fb3a UH	75	/**
	76	* TODO.
	77	*
	78	* @param fd TODO.
	79	* @param revents TODO.
	80	* @param session_data TODO.
	81	*
	82	* @return TODO.
	83	*/
9c939c51	84	static int feed_chunk(int fd, int revents, void *session_data)
7d658874 BV	85	{
	86	struct sr_device_instance *sdi;
	87	struct session_vdevice *vdevice;
	88	struct sr_datafeed_packet packet;
9c939c51	89	struct sr_datafeed_logic logic;
7d658874 BV	90	GSList *l;
	91	void *buf;
	92	int ret, got_data;
	93
cb93f8a9 UH	94	/* Avoid compiler warnings. */
	95	(void)fd;
	96	(void)revents;
7d658874	97
b08024a8	98	sr_dbg("session_driver: feed chunk");
7d658874 BV	99
	100	got_data = FALSE;
	101	for (l = device_instances; l; l = l->next) {
	102	sdi = l->data;
	103	vdevice = sdi->priv;
	104	if (!vdevice)
	105	/* already done with this instance */
	106	continue;
	107
b53738ba UH	108	if (!(buf = g_try_malloc(CHUNKSIZE))) {
b53738ba UH	109	sr_err("session: %s: buf malloc failed", __func__);
133a37bf	110	return FALSE; /* TODO: SR_ERR_MALLOC */
b53738ba UH	111	}
b53738ba UH	112
7d658874 BV	113	ret = zip_fread(vdevice->capfile, buf, CHUNKSIZE);
	114	if (ret > 0) {
	115	got_data = TRUE;
	116	packet.type = SR_DF_LOGIC;
9c939c51 BV	117	packet.payload = &logic;
	118	logic.length = ret;
	119	logic.unitsize = vdevice->unitsize;
	120	logic.data = buf;
cb1e389c	121	vdevice->bytes_read += ret;
9c939c51	122	sr_session_bus(session_data, &packet);
7d658874 BV	123	} else {
	124	/* done with this capture file */
	125	zip_fclose(vdevice->capfile);
	126	g_free(vdevice->capturefile);
	127	g_free(vdevice);
	128	sdi->priv = NULL;
	129	}
	130	}
	131
	132	if (!got_data) {
	133	packet.type = SR_DF_END;
9c939c51	134	sr_session_bus(session_data, &packet);
7d658874 BV	135	}
	136
	137	return TRUE;
	138	}
	139
	140	/* driver callbacks */
57ab7d9f	141	static int hw_cleanup(void);
7d658874	142
9f45fb3a UH	143	/**
	144	* TODO.
	145	*
	146	* @param deviceinfo TODO.
	147	*
	148	* @return TODO.
	149	*/
54ac5277	150	static int hw_init(const char *deviceinfo)
7d658874	151	{
7d658874 BV	152	sessionfile = g_strdup(deviceinfo);
	153
	154	return 0;
	155	}
	156
9f45fb3a UH	157	/**
	158	* TODO.
	159	*
	160	*/
57ab7d9f	161	static int hw_cleanup(void)
7d658874 BV	162	{
	163	GSList *l;
	164
57ab7d9f UH	165	/* TODO: Error handling. */
57ab7d9f UH	166
7d658874	167	for (l = device_instances; l; l = l->next)
d3683c42	168	sr_dev_inst_free(l->data);
7d658874	169
805e9640 GM	170	g_slist_free(device_instances);
	171	device_instances = NULL;
	172
	173	sr_session_source_remove(-1);
	174
7d658874	175	g_free(sessionfile);
57ab7d9f UH	176
57ab7d9f UH	177	return SR_OK;
7d658874 BV	178	}
	179
	180	static int hw_opendev(int device_index)
	181	{
	182	struct sr_device_instance *sdi;
	183
d3683c42	184	sdi = sr_dev_inst_new(device_index, SR_ST_INITIALIZING,
7d658874 BV	185	NULL, NULL, NULL);
	186	if (!sdi)
	187	return SR_ERR;
b53738ba UH	188
	189	if (!(sdi->priv = g_try_malloc0(sizeof(struct session_vdevice)))) {
	190	sr_err("session: %s: sdi->priv malloc failed", __func__);
	191	return SR_ERR_MALLOC;
	192	}
	193
7d658874 BV	194	device_instances = g_slist_append(device_instances, sdi);
	195
	196	return SR_OK;
	197	}
	198
7d658874 BV	199	static void *hw_get_device_info(int device_index, int device_info_id)
	200	{
	201	struct session_vdevice *vdevice;
	202	void *info;
	203
b8c2f85f BV	204	if (device_info_id != SR_DI_CUR_SAMPLERATE)
	205	return NULL;
	206
7d658874 BV	207	if (!(vdevice = get_vdevice_by_index(device_index)))
	208	return NULL;
	209
	210	info = &vdevice->samplerate;
	211
	212	return info;
	213	}
	214
	215	static int hw_get_status(int device_index)
	216	{
cb93f8a9 UH	217	/* Avoid compiler warnings. */
cb93f8a9 UH	218	(void)device_index;
7d658874	219
03168500	220	if (sr_dev_list() != NULL)
7d658874 BV	221	return SR_OK;
	222	else
	223	return SR_ERR;
	224	}
	225
9f45fb3a UH	226	/**
	227	* Get the list of hardware capabilities.
	228	*
	229	* @return A pointer to the (hardware) capabilities of this virtual session
	230	* driver. This could be NULL, if no such capabilities exist.
	231	*/
7d658874 BV	232	static int *hw_get_capabilities(void)
7d658874 BV	233	{
7d658874 BV	234	return capabilities;
	235	}
	236
	237	static int hw_set_configuration(int device_index, int capability, void *value)
	238	{
	239	struct session_vdevice *vdevice;
	240	uint64_t *tmp_u64;
	241
	242	if (!(vdevice = get_vdevice_by_index(device_index)))
	243	return SR_ERR;
	244
	245	switch (capability) {
	246	case SR_HWCAP_SAMPLERATE:
	247	tmp_u64 = value;
	248	vdevice->samplerate = *tmp_u64;
9f45fb3a UH	249	sr_info("session driver: setting samplerate to %" PRIu64,
9f45fb3a UH	250	vdevice->samplerate);
7d658874 BV	251	break;
	252	case SR_HWCAP_CAPTUREFILE:
	253	vdevice->capturefile = g_strdup(value);
9f45fb3a UH	254	sr_info("session driver: setting capturefile to %s",
9f45fb3a UH	255	vdevice->capturefile);
7d658874 BV	256	break;
	257	case SR_HWCAP_CAPTURE_UNITSIZE:
	258	tmp_u64 = value;
	259	vdevice->unitsize = *tmp_u64;
	260	break;
	261	case SR_HWCAP_CAPTURE_NUM_PROBES:
	262	tmp_u64 = value;
	263	vdevice->num_probes = *tmp_u64;
	264	break;
	265	default:
9f45fb3a UH	266	sr_err("session driver: %s: unknown capability %d requested",
9f45fb3a UH	267	__func__, capability);
7d658874 BV	268	return SR_ERR;
	269	}
	270
	271	return SR_OK;
	272	}
	273
	274	static int hw_start_acquisition(int device_index, gpointer session_device_id)
	275	{
	276	struct zip_stat zs;
	277	struct session_vdevice *vdevice;
	278	struct sr_datafeed_header *header;
	279	struct sr_datafeed_packet *packet;
	280	int err;
	281
cb93f8a9 UH	282	/* Avoid compiler warnings. */
cb93f8a9 UH	283	(void)session_device_id;
7d658874 BV	284
	285	if (!(vdevice = get_vdevice_by_index(device_index)))
	286	return SR_ERR;
	287
b08024a8 UH	288	sr_info("session_driver: opening archive %s file %s", sessionfile,
b08024a8 UH	289	vdevice->capturefile);
7d658874 BV	290
7d658874 BV	291	if (!(vdevice->archive = zip_open(sessionfile, 0, &err))) {
133a37bf UH	292	sr_err("Failed to open session file '%s': zip error %d\n",
133a37bf UH	293	sessionfile, err);
7d658874 BV	294	return SR_ERR;
	295	}
	296
	297	if (zip_stat(vdevice->archive, vdevice->capturefile, 0, &zs) == -1) {
133a37bf UH	298	sr_err("Failed to check capture file '%s' in session file "
133a37bf UH	299	"'%s'.", vdevice->capturefile, sessionfile);
7d658874 BV	300	return SR_ERR;
	301	}
	302
133a37bf UH	303	if (!(vdevice->capfile = zip_fopen(vdevice->archive,
	304	vdevice->capturefile, 0))) {
	305	sr_err("Failed to open capture file '%s' in session file '%s'.",
	306	vdevice->capturefile, sessionfile);
7d658874 BV	307	return SR_ERR;
	308	}
	309
	310	/* freewheeling source */
8a2efef2	311	sr_session_source_add(-1, 0, 0, feed_chunk, session_device_id);
7d658874	312
b53738ba UH	313	if (!(packet = g_try_malloc(sizeof(struct sr_datafeed_packet)))) {
	314	sr_err("session: %s: packet malloc failed", __func__);
	315	return SR_ERR_MALLOC;
	316	}
	317
	318	if (!(header = g_try_malloc(sizeof(struct sr_datafeed_header)))) {
	319	sr_err("session: %s: header malloc failed", __func__);
	320	return SR_ERR_MALLOC;
	321	}
	322
7d658874	323	/* Send header packet to the session bus. */
7d658874	324	packet->type = SR_DF_HEADER;
7d658874 BV	325	packet->payload = (unsigned char *)header;
	326	header->feed_version = 1;
	327	gettimeofday(&header->starttime, NULL);
276585ff	328	header->samplerate = vdevice->samplerate;
7d658874	329	header->num_logic_probes = vdevice->num_probes;
8a2efef2	330	sr_session_bus(session_device_id, packet);
7d658874 BV	331	g_free(header);
	332	g_free(packet);
	333
	334	return SR_OK;
	335	}
	336
a0ecd83b	337	/* Not static, it's used elsewhere (via 'extern'). */
7d658874 BV	338	struct sr_device_plugin session_driver = {
	339	"session",
	340	"Session-emulating driver",
	341	1,
	342	hw_init,
	343	hw_cleanup,
	344	hw_opendev,
b8c2f85f	345	NULL,
7d658874 BV	346	hw_get_device_info,
	347	hw_get_status,
	348	hw_get_capabilities,
	349	hw_set_configuration,
	350	hw_start_acquisition,
8a2efef2	351	NULL,
7d658874	352	};