[libsigrok.git] / sigrok.h

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

#ifndef SIGROK_SIGROK_H
#define SIGROK_SIGROK_H

#include <stdio.h>
#include <sys/time.h>
#include <stdint.h>
#include <inttypes.h>
#include <glib.h>
#include <libusb.h>

/*
 * Status/error codes returned by libsigrok functions.
 *
 * All possible return codes of libsigrok functions must be listed here.
 * Functions should never return hardcoded numbers as status, but rather
 * use these #defines instead. All error codes are negative numbers.
 *
 * The error codes are globally unique in libsigrok, i.e. if one of the
 * libsigrok functions returns a "malloc error" it must be exactly the same
 * return value as used by all other functions to indicate "malloc error".
 * There must be no functions which indicate two different errors via the
 * same return code.
 *
 * Also, for compatibility reasons, no defined return codes are ever removed
 * or reused for different #defines later. You can only add new #defines and
 * return codes, but never remove or redefine existing ones.
 */
#define SIGROK_OK			 0 /* No error */
#define SIGROK_ERR			-1 /* Generic/unspecified error */
#define SIGROK_ERR_MALLOC		-2 /* Malloc/calloc/realloc error */
#define SIGROK_ERR_SAMPLERATE		-3 /* Incorrect samplerate */

/* Handy little macros */
#define KHZ(n) ((n) * 1000)
#define MHZ(n) ((n) * 1000000)
#define GHZ(n) ((n) * 1000000000)

#ifndef ARRAY_SIZE
#define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0]))
#endif

/* Data types, used by hardware plugins for set_configuration() */
enum {
	T_UINT64,
	T_CHAR,
};

enum {
	PROTO_RAW,
};

/* (Unused) protocol decoder stack entry */
struct protocol {
	char *name;
	int id;
	int stackindex;
};

/*
 * Datafeed
 */

/* datafeed_packet.type values */
enum {
	DF_HEADER,
	DF_END,
	DF_TRIGGER,
	DF_LOGIC8,
	DF_LOGIC16,
	DF_LOGIC24,
	DF_LOGIC32,
	DF_LOGIC48,
	DF_LOGIC64,
};

struct datafeed_packet {
	uint16_t type;
	uint16_t length;
	void *payload;
};

struct datafeed_header {
	int feed_version;
	struct timeval starttime;
	uint64_t samplerate;
	int protocol_id;
	int num_probes;
};

/*
 * Output
 */
struct output {
	struct output_format *format;
	struct device *device;
	char *param;
	void *internal;
};

struct output_format {
	char *extension;
	char *description;
	int (*init) (struct output *o);
	int (*data) (struct output *o, char *data_in, uint64_t length_in,
		     char **data_out, uint64_t *length_out);
	int (*event) (struct output *o, int event_type, char **data_out,
		      uint64_t *length_out);
};

struct output_format **output_list(void);
int filter_probes(int in_unitsize, int out_unitsize, int *probelist,
		  char *data_in, uint64_t length_in, char **data_out,
		  uint64_t *length_out);

char *sigrok_samplerate_string(uint64_t samplerate);

/*--- analyzer.c ------------------------------------------------------------*/

struct analyzer {
	char *name;
	char *filename;
	/*
	 * TODO: Parameters? If so, configured plugins need another struct.
	 * TODO: Input and output format?
	 */
};

/*--- backend.c -------------------------------------------------------------*/

int sigrok_init(void);
void sigrok_cleanup(void);

/*--- datastore.c -----------------------------------------------------------*/

/* Size of a chunk in units */
#define DATASTORE_CHUNKSIZE 512000

struct datastore {
	/* Size in bytes of the number of units stored in this datastore */
	int ds_unitsize;
	unsigned int num_units;
	GSList *chunklist;
};

struct datastore *datastore_new(int unitsize);
void datastore_destroy(struct datastore *ds);
void datastore_put(struct datastore *ds, void *data, unsigned int length,
		   int in_unitsize, int *probelist);

/*--- debug.c ---------------------------------------------------------------*/

void hexdump(unsigned char *address, int length);

/*--- device.c --------------------------------------------------------------*/

/*
 * This represents a generic device connected to the system.
 * For device-specific information, ask the plugin. The plugin_index refers
 * to the device index within that plugin; it may be handling more than one
 * device. All relevant plugin calls take a device_index parameter for this.
 */
struct device {
	/* Which plugin handles this device */
	struct device_plugin *plugin;
	/* A plugin may handle multiple devices of the same type */
	int plugin_index;
	/* List of struct probe* */
	GSList *probes;
	/* Data acquired by this device, if any */
	struct datastore *datastore;
};

struct probe {
	int index;
	gboolean enabled;
	char *name;
	char *trigger;
};

extern GSList *devices;

void device_scan(void);
void device_close_all(void);
GSList *device_list(void);
struct device *device_new(struct device_plugin *plugin, int plugin_index);
void device_clear(struct device *device);
void device_destroy(struct device *dev);

void device_probe_clear(struct device *device, int probenum);
void device_probe_add(struct device *device, char *name);
struct probe *probe_find(struct device *device, int probenum);
void device_probe_name(struct device *device, int probenum, char *name);

void device_trigger_clear(struct device *device);
void device_trigger_set(struct device *device, int probenum, char *trigger);

/*--- hwplugin.c ------------------------------------------------------------*/

/* Hardware plugin capabilities */
enum {
	HWCAP_DUMMY,		/* Used to terminate lists */
	HWCAP_LOGIC_ANALYZER,
	HWCAP_SAMPLERATE,	/* Change samplerate */
	HWCAP_PROBECONFIG,	/* Configure probe mask */
	HWCAP_CAPTURE_RATIO,	/* Set pre-trigger / post-trigger ratio */
	HWCAP_LIMIT_MSEC,	/* Set a time limit for sample acquisition */
	HWCAP_LIMIT_SAMPLES,	/* Set a limit on number of samples */
};

struct hwcap_option {
	int capability;
	int type;
	char *description;
	char *shortname;
};

struct sigrok_device_instance {
	int index;
	int status;
	int instance_type;
	char *vendor;
	char *model;
	char *version;
	union {
		struct usb_device_instance *usb;
		struct serial_device_instance *serial;
	};
};

/* sigrok_device_instance types */
enum {
	USB_INSTANCE,
	SERIAL_INSTANCE,
};

struct usb_device_instance {
	uint8_t bus;
	uint8_t address;
	struct libusb_device_handle *devhdl;
};

struct serial_device_instance {
	char *port;
	int fd;
};

/* Device instance status */
enum {
	ST_NOT_FOUND,
	/* Found, but still booting */
	ST_INITIALIZING,
	/* Live, but not in use */
	ST_INACTIVE,
	/* Actively in use in a session */
	ST_ACTIVE,
};

/*
 * TODO: This sucks, you just kinda have to "know" the returned type.
 * TODO: Need a DI to return the number of trigger stages supported.
 */

/* Device info IDs */
enum {
	/* struct sigrok_device_instance for this specific device */
	DI_INSTANCE,
	/* The number of probes connected to this device */
	DI_NUM_PROBES,
	/* Samplerates supported by this device, (struct samplerates) */
	DI_SAMPLERATES,
	/* Types of trigger supported, out of "01crf" (char *) */
	DI_TRIGGER_TYPES,
	/* The currently set samplerate in Hz (uint64_t) */
	DI_CUR_SAMPLERATE,
};

/*
 * A device supports either a range of samplerates with steps of a given
 * granularity, or is limited to a set of defined samplerates. Use either
 * step or list, but not both.
 */
struct samplerates {
	uint64_t low;
	uint64_t high;
	uint64_t step;
	uint64_t *list;
};

struct device_plugin {
	/* Plugin-specific */
	char *name;
	int api_version;
	int (*init) (char *deviceinfo);
	void (*cleanup) (void);

	/* Device-specific */
	int (*open) (int device_index);
	void (*close) (int device_index);
	void *(*get_device_info) (int device_index, int device_info_id);
	int (*get_status) (int device_index);
	int *(*get_capabilities) (void);
	int (*set_configuration) (int device_index, int capability, void *value);
	int (*start_acquisition) (int device_index, gpointer session_device_id);
	void (*stop_acquisition) (int device_index, gpointer session_device_id);
};

struct gsource_fd {
	GSource source;
	GPollFD gpfd;
	/* Not really using this */
	GSource *timeout_source;
};

typedef int (*receive_data_callback) (int fd, int revents, void *user_data);

int load_hwplugins(void);
GSList *list_hwplugins(void);

/* Generic device instances */
struct sigrok_device_instance *sigrok_device_instance_new(int index,
	int status, char *vendor, char *model, char *version);
struct sigrok_device_instance *get_sigrok_device_instance(
			GSList *device_instances, int device_index);
void sigrok_device_instance_free(struct sigrok_device_instance *sdi);

/* USB-specific instances */
struct usb_device_instance *usb_device_instance_new(uint8_t bus,
		uint8_t address, struct libusb_device_handle *hdl);
void usb_device_instance_free(struct usb_device_instance *usb);

/* Serial-specific instances */
struct serial_device_instance *serial_device_instance_new(char *port, int fd);
void serial_device_instance_free(struct serial_device_instance *serial);

int find_hwcap(int *capabilities, int hwcap);
struct hwcap_option *find_hwcap_option(int hwcap);
void source_remove(int fd);
void source_add(int fd, int events, int timeout, receive_data_callback rcv_cb,
		void *user_data);

/*--- session.c -------------------------------------------------------------*/

typedef void (*source_callback_remove) (int fd);
typedef void (*source_callback_add) (int fd, int events, int timeout,
		receive_data_callback callback, void *user_data);
typedef void (*datafeed_callback) (struct device *device,
				 struct datafeed_packet *packet);

struct session {
	/* List of struct device* */
	GSList *devices;
	/* List of struct analyzer* */
	GSList *analyzers;
	/* Datafeed callbacks */
	GSList *datafeed_callbacks;
	GTimeVal starttime;
};

/* Session setup */
struct session *session_load(const char *filename);
struct session *session_new(void);
void session_destroy(void);
void session_device_clear(void);
int session_device_add(struct device *device);

/* Protocol analyzers setup */
void session_pa_clear(void);
void session_pa_add(struct analyzer *pa);

/* Datafeed setup */
void session_datafeed_callback_clear(void);
void session_datafeed_callback_add(datafeed_callback callback);

/* Session control */
int session_start(void);
void session_stop(void);
void session_bus(struct device *device, struct datafeed_packet *packet);
void make_metadata(char *filename);
int session_save(char *filename);

/*--- hwcommon.c ------------------------------------------------------------*/

int ezusb_reset(struct libusb_device_handle *hdl, int set_clear);
int ezusb_install_firmware(libusb_device_handle *hdl, char *filename);
int ezusb_upload_firmware(libusb_device *dev, int configuration,
                          const char *filename);

GSList *list_serial_ports(void);
int serial_open(const char *pathname, int flags);
int serial_close(int fd);
void *serial_backup_params(int fd);
void serial_restore_params(int fd, void *backup);
int serial_set_params(int fd, int speed, int bits, int parity, int stopbits,
		      int flowcontrol);

#endif
Commit	Line	Data
a1bb33af UH	1	/*
	2	* This file is part of the sigrok project.
	3	*
	4	* Copyright (C) 2010 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	#ifndef SIGROK_SIGROK_H
	21	#define SIGROK_SIGROK_H
	22
	23	#include <stdio.h>
	24	#include <sys/time.h>
	25	#include <stdint.h>
	26	#include <inttypes.h>
	27	#include <glib.h>
	28	#include <libusb.h>
	29
e31b636d UH	30	/*
	31	* Status/error codes returned by libsigrok functions.
	32	*
	33	* All possible return codes of libsigrok functions must be listed here.
	34	* Functions should never return hardcoded numbers as status, but rather
	35	* use these #defines instead. All error codes are negative numbers.
	36	*
	37	* The error codes are globally unique in libsigrok, i.e. if one of the
2b3414a4 UH	38	* libsigrok functions returns a "malloc error" it must be exactly the same
2b3414a4 UH	39	* return value as used by all other functions to indicate "malloc error".
e31b636d UH	40	* There must be no functions which indicate two different errors via the
	41	* same return code.
	42	*
	43	* Also, for compatibility reasons, no defined return codes are ever removed
	44	* or reused for different #defines later. You can only add new #defines and
	45	* return codes, but never remove or redefine existing ones.
	46	*/
2b3414a4	47	#define SIGROK_OK 0 /* No error */
e31b636d UH	48	#define SIGROK_ERR -1 /* Generic/unspecified error */
	49	#define SIGROK_ERR_MALLOC -2 /* Malloc/calloc/realloc error */
	50	#define SIGROK_ERR_SAMPLERATE -3 /* Incorrect samplerate */
a1bb33af UH	51
a1bb33af UH	52	/* Handy little macros */
d86dc674 UH	53	#define KHZ(n) ((n) * 1000)
	54	#define MHZ(n) ((n) * 1000000)
	55	#define GHZ(n) ((n) * 1000000000)
a1bb33af	56
fdd20b52 UH	57	#ifndef ARRAY_SIZE
	58	#define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0]))
	59	#endif
	60
a1bb33af UH	61	/* Data types, used by hardware plugins for set_configuration() */
	62	enum {
	63	T_UINT64,
	64	T_CHAR,
	65	};
	66
	67	enum {
	68	PROTO_RAW,
	69	};
	70
	71	/* (Unused) protocol decoder stack entry */
	72	struct protocol {
	73	char *name;
	74	int id;
	75	int stackindex;
	76	};
	77
	78	/*
1b452b85	79	* Datafeed
a1bb33af UH	80	*/
	81
	82	/* datafeed_packet.type values */
	83	enum {
	84	DF_HEADER,
	85	DF_END,
	86	DF_TRIGGER,
	87	DF_LOGIC8,
	88	DF_LOGIC16,
	89	DF_LOGIC24,
	90	DF_LOGIC32,
	91	DF_LOGIC48,
	92	DF_LOGIC64,
	93	};
	94
	95	struct datafeed_packet {
	96	uint16_t type;
	97	uint16_t length;
	98	void *payload;
	99	};
	100
	101	struct datafeed_header {
	102	int feed_version;
	103	struct timeval starttime;
4c100f32	104	uint64_t samplerate;
a1bb33af UH	105	int protocol_id;
	106	int num_probes;
	107	};
	108
	109	/*
1b452b85	110	* Output
a1bb33af UH	111	*/
	112	struct output {
	113	struct output_format *format;
	114	struct device *device;
	115	char *param;
	116	void *internal;
	117	};
	118
	119	struct output_format {
	120	char *extension;
	121	char *description;
5a8fda15	122	int (init) (struct output o);
a1bb33af UH	123	int (data) (struct output o, char *data_in, uint64_t length_in,
	124	char *data_out, uint64_t length_out);
	125	int (event) (struct output o, int event_type, char **data_out,
	126	uint64_t *length_out);
	127	};
	128
	129	struct output_format **output_list(void);
	130	int filter_probes(int in_unitsize, int out_unitsize, int *probelist,
	131	char data_in, uint64_t length_in, char *data_out,
	132	uint64_t *length_out);
	133
25e7d9b1 UH	134	char *sigrok_samplerate_string(uint64_t samplerate);
25e7d9b1 UH	135
a1bb33af UH	136	/--- analyzer.c ------------------------------------------------------------/
	137
	138	struct analyzer {
	139	char *name;
	140	char *filename;
	141	/*
	142	* TODO: Parameters? If so, configured plugins need another struct.
	143	* TODO: Input and output format?
	144	*/
	145	};
	146
	147	/--- backend.c -------------------------------------------------------------/
	148
	149	int sigrok_init(void);
	150	void sigrok_cleanup(void);
	151
	152	/--- datastore.c -----------------------------------------------------------/
	153
	154	/* Size of a chunk in units */
	155	#define DATASTORE_CHUNKSIZE 512000
	156
	157	struct datastore {
	158	/* Size in bytes of the number of units stored in this datastore */
	159	int ds_unitsize;
	160	unsigned int num_units;
	161	GSList *chunklist;
	162	};
	163
	164	struct datastore *datastore_new(int unitsize);
	165	void datastore_destroy(struct datastore *ds);
	166	void datastore_put(struct datastore ds, void data, unsigned int length,
	167	int in_unitsize, int *probelist);
	168
	169	/--- debug.c ---------------------------------------------------------------/
	170
	171	void hexdump(unsigned char *address, int length);
	172
	173	/--- device.c --------------------------------------------------------------/
	174
	175	/*
	176	* This represents a generic device connected to the system.
	177	* For device-specific information, ask the plugin. The plugin_index refers
	178	* to the device index within that plugin; it may be handling more than one
	179	* device. All relevant plugin calls take a device_index parameter for this.
	180	*/
	181	struct device {
	182	/* Which plugin handles this device */
	183	struct device_plugin *plugin;
	184	/* A plugin may handle multiple devices of the same type */
	185	int plugin_index;
	186	/* List of struct probe* */
	187	GSList *probes;
	188	/* Data acquired by this device, if any */
	189	struct datastore *datastore;
	190	};
	191
	192	struct probe {
	193	int index;
	194	gboolean enabled;
	195	char *name;
	196	char *trigger;
	197	};
	198
	199	extern GSList *devices;
200
201	void device_scan(void);
202	void device_close_all(void);
203	GSList *device_list(void);
204	struct device device_new(struct device_plugin plugin, int plugin_index);
205	void device_clear(struct device *device);
206	void device_destroy(struct device *dev);
207
208	void device_probe_clear(struct device *device, int probenum);
209	void device_probe_add(struct device device, char name);
210	struct probe probe_find(struct device device, int probenum);
211	void device_probe_name(struct device device, int probenum, char name);
212
213	void device_trigger_clear(struct device *device);
214	void device_trigger_set(struct device device, int probenum, char trigger);
215
216	/--- hwplugin.c ------------------------------------------------------------/
217
218	/* Hardware plugin capabilities */
219	enum {
1b452b85	220	HWCAP_DUMMY, /* Used to terminate lists */
a1bb33af	221	HWCAP_LOGIC_ANALYZER,
1b452b85 UH	222	HWCAP_SAMPLERATE, /* Change samplerate */
	223	HWCAP_PROBECONFIG, /* Configure probe mask */
	224	HWCAP_CAPTURE_RATIO, /* Set pre-trigger / post-trigger ratio */
	225	HWCAP_LIMIT_MSEC, /* Set a time limit for sample acquisition */
	226	HWCAP_LIMIT_SAMPLES, /* Set a limit on number of samples */
a1bb33af UH	227	};
	228
	229	struct hwcap_option {
	230	int capability;
	231	int type;
	232	char *description;
	233	char *shortname;
	234	};
	235
	236	struct sigrok_device_instance {
	237	int index;
	238	int status;
	239	int instance_type;
	240	char *vendor;
	241	char *model;
	242	char *version;
	243	union {
	244	struct usb_device_instance *usb;
	245	struct serial_device_instance *serial;
	246	};
	247	};
	248
	249	/* sigrok_device_instance types */
	250	enum {
	251	USB_INSTANCE,
	252	SERIAL_INSTANCE,
	253	};
	254
	255	struct usb_device_instance {
	256	uint8_t bus;
	257	uint8_t address;
	258	struct libusb_device_handle *devhdl;
	259	};
	260
	261	struct serial_device_instance {
	262	char *port;
	263	int fd;
	264	};
	265
	266	/* Device instance status */
	267	enum {
	268	ST_NOT_FOUND,
	269	/* Found, but still booting */
	270	ST_INITIALIZING,
	271	/* Live, but not in use */
	272	ST_INACTIVE,
	273	/* Actively in use in a session */
	274	ST_ACTIVE,
	275	};
	276
	277	/*
	278	* TODO: This sucks, you just kinda have to "know" the returned type.
	279	* TODO: Need a DI to return the number of trigger stages supported.
	280	*/
	281
	282	/* Device info IDs */
	283	enum {
	284	/* struct sigrok_device_instance for this specific device */
	285	DI_INSTANCE,
	286	/* The number of probes connected to this device */
	287	DI_NUM_PROBES,
4c100f32	288	/* Samplerates supported by this device, (struct samplerates) */
a1bb33af UH	289	DI_SAMPLERATES,
	290	/* Types of trigger supported, out of "01crf" (char ) /
	291	DI_TRIGGER_TYPES,
4c100f32 UH	292	/* The currently set samplerate in Hz (uint64_t) */
4c100f32 UH	293	DI_CUR_SAMPLERATE,
a1bb33af UH	294	};
a1bb33af UH	295
1b452b85 UH	296	/*
	297	* A device supports either a range of samplerates with steps of a given
	298	* granularity, or is limited to a set of defined samplerates. Use either
a1bb33af UH	299	* step or list, but not both.
	300	*/
	301	struct samplerates {
	302	uint64_t low;
	303	uint64_t high;
	304	uint64_t step;
	305	uint64_t *list;
	306	};
	307
	308	struct device_plugin {
1b452b85	309	/* Plugin-specific */
a1bb33af UH	310	char *name;
	311	int api_version;
	312	int (init) (char deviceinfo);
	313	void (*cleanup) (void);
	314
1b452b85	315	/* Device-specific */
a1bb33af UH	316	int (*open) (int device_index);
	317	void (*close) (int device_index);
	318	void (get_device_info) (int device_index, int device_info_id);
	319	int (*get_status) (int device_index);
	320	int (get_capabilities) (void);
	321	int (set_configuration) (int device_index, int capability, void value);
	322	int (*start_acquisition) (int device_index, gpointer session_device_id);
	323	void (*stop_acquisition) (int device_index, gpointer session_device_id);
	324	};
	325
	326	struct gsource_fd {
	327	GSource source;
	328	GPollFD gpfd;
	329	/* Not really using this */
	330	GSource *timeout_source;
	331	};
	332
	333	typedef int (receive_data_callback) (int fd, int revents, void user_data);
	334
	335	int load_hwplugins(void);
	336	GSList *list_hwplugins(void);
	337
	338	/* Generic device instances */
	339	struct sigrok_device_instance *sigrok_device_instance_new(int index,
	340	int status, char vendor, char model, char *version);
1b452b85 UH	341	struct sigrok_device_instance *get_sigrok_device_instance(
1b452b85 UH	342	GSList *device_instances, int device_index);
a1bb33af UH	343	void sigrok_device_instance_free(struct sigrok_device_instance *sdi);
	344
	345	/* USB-specific instances */
	346	struct usb_device_instance *usb_device_instance_new(uint8_t bus,
	347	uint8_t address, struct libusb_device_handle *hdl);
	348	void usb_device_instance_free(struct usb_device_instance *usb);
	349
	350	/* Serial-specific instances */
	351	struct serial_device_instance serial_device_instance_new(char port, int fd);
	352	void serial_device_instance_free(struct serial_device_instance *serial);
	353
	354	int find_hwcap(int *capabilities, int hwcap);
	355	struct hwcap_option *find_hwcap_option(int hwcap);
	356	void source_remove(int fd);
1b452b85 UH	357	void source_add(int fd, int events, int timeout, receive_data_callback rcv_cb,
1b452b85 UH	358	void *user_data);
a1bb33af UH	359
	360	/--- session.c -------------------------------------------------------------/
	361
	362	typedef void (*source_callback_remove) (int fd);
	363	typedef void (*source_callback_add) (int fd, int events, int timeout,
	364	receive_data_callback callback, void *user_data);
	365	typedef void (datafeed_callback) (struct device device,
	366	struct datafeed_packet *packet);
	367
	368	struct session {
	369	/* List of struct device* */
	370	GSList *devices;
	371	/* List of struct analyzer* */
	372	GSList *analyzers;
1b452b85	373	/* Datafeed callbacks */
a1bb33af UH	374	GSList *datafeed_callbacks;
	375	GTimeVal starttime;
	376	};
	377
	378	/* Session setup */
afc8e4de	379	struct session session_load(const char filename);
a1bb33af UH	380	struct session *session_new(void);
	381	void session_destroy(void);
	382	void session_device_clear(void);
	383	int session_device_add(struct device *device);
	384
	385	/* Protocol analyzers setup */
	386	void session_pa_clear(void);
	387	void session_pa_add(struct analyzer *pa);
	388
	389	/* Datafeed setup */
	390	void session_datafeed_callback_clear(void);
	391	void session_datafeed_callback_add(datafeed_callback callback);
	392
	393	/* Session control */
	394	int session_start(void);
	395	void session_stop(void);
	396	void session_bus(struct device device, struct datafeed_packet packet);
	397	void make_metadata(char *filename);
	398	int session_save(char *filename);
	399
	400	/--- hwcommon.c ------------------------------------------------------------/
	401
	402	int ezusb_reset(struct libusb_device_handle *hdl, int set_clear);
	403	int ezusb_install_firmware(libusb_device_handle hdl, char filename);
edf60d05 UH	404	int ezusb_upload_firmware(libusb_device *dev, int configuration,
edf60d05 UH	405	const char *filename);
a1bb33af UH	406
a1bb33af UH	407	GSList *list_serial_ports(void);
d02a535e BV	408	int serial_open(const char *pathname, int flags);
	409	int serial_close(int fd);
	410	void *serial_backup_params(int fd);
	411	void serial_restore_params(int fd, void *backup);
1b452b85 UH	412	int serial_set_params(int fd, int speed, int bits, int parity, int stopbits,
1b452b85 UH	413	int flowcontrol);
a1bb33af UH	414
a1bb33af UH	415	#endif