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

/*
 * Input
 */
struct input {
	struct input_format *format;
	void *param;
	void *internal;
};

struct input_format {
	char *extension;
	char *description;
	int (*format_match) (char *filename);
	int (*in_loadfile) (char *filename);
};

struct input_format **input_list(void);


/*
 * 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; /* TODO: uint64_t */
	GSList *chunklist;
};

int datastore_new(int unitsize, struct datastore **ds);
int 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, int num_probes);
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, const char *vendor, const char *model, const 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(
					const 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);

/* libsigrok/hardware/common/misc.c */
/* TODO: Should not be public. */
int opendev2(int device_index, struct sigrok_device_instance **sdi,
	     libusb_device *dev, struct libusb_device_descriptor *des,
	     int *skip, uint16_t vid, uint16_t pid, int interface);
int opendev3(struct sigrok_device_instance **sdi, libusb_device *dev,
	     struct libusb_device_descriptor *des,
	     uint16_t vid, uint16_t pid, int interface);

#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
34e4813f BV	109	/*
	110	* Input
	111	*/
	112	struct input {
	113	struct input_format *format;
	114	void *param;
	115	void *internal;
	116	};
	117
	118	struct input_format {
	119	char *extension;
	120	char *description;
	121	int (format_match) (char filename);
	122	int (in_loadfile) (char filename);
	123	};
	124
	125	struct input_format **input_list(void);
	126
	127
a1bb33af	128	/*
1b452b85	129	* Output
a1bb33af UH	130	*/
	131	struct output {
	132	struct output_format *format;
	133	struct device *device;
	134	char *param;
	135	void *internal;
	136	};
	137
	138	struct output_format {
	139	char *extension;
	140	char *description;
5a8fda15	141	int (init) (struct output o);
a1bb33af UH	142	int (data) (struct output o, char *data_in, uint64_t length_in,
	143	char *data_out, uint64_t length_out);
	144	int (event) (struct output o, int event_type, char **data_out,
	145	uint64_t *length_out);
	146	};
	147
	148	struct output_format **output_list(void);
34e4813f BV	149
34e4813f BV	150
a1bb33af UH	151	int filter_probes(int in_unitsize, int out_unitsize, int *probelist,
	152	char data_in, uint64_t length_in, char *data_out,
	153	uint64_t *length_out);
	154
25e7d9b1 UH	155	char *sigrok_samplerate_string(uint64_t samplerate);
25e7d9b1 UH	156
a1bb33af UH	157	/--- analyzer.c ------------------------------------------------------------/
	158
	159	struct analyzer {
	160	char *name;
	161	char *filename;
	162	/*
	163	* TODO: Parameters? If so, configured plugins need another struct.
	164	* TODO: Input and output format?
	165	*/
	166	};
	167
	168	/--- backend.c -------------------------------------------------------------/
	169
	170	int sigrok_init(void);
	171	void sigrok_cleanup(void);
	172
	173	/--- datastore.c -----------------------------------------------------------/
	174
	175	/* Size of a chunk in units */
	176	#define DATASTORE_CHUNKSIZE 512000
	177
	178	struct datastore {
	179	/* Size in bytes of the number of units stored in this datastore */
	180	int ds_unitsize;
33247d6a	181	unsigned int num_units; /* TODO: uint64_t */
a1bb33af UH	182	GSList *chunklist;
	183	};
	184
2aebf78d	185	int datastore_new(int unitsize, struct datastore **ds);
33247d6a	186	int datastore_destroy(struct datastore *ds);
a1bb33af UH	187	void datastore_put(struct datastore ds, void data, unsigned int length,
	188	int in_unitsize, int *probelist);
	189
	190	/--- debug.c ---------------------------------------------------------------/
	191
	192	void hexdump(unsigned char *address, int length);
	193
	194	/--- device.c --------------------------------------------------------------/
	195
	196	/*
	197	* This represents a generic device connected to the system.
	198	* For device-specific information, ask the plugin. The plugin_index refers
	199	* to the device index within that plugin; it may be handling more than one
	200	* device. All relevant plugin calls take a device_index parameter for this.
	201	*/
	202	struct device {
	203	/* Which plugin handles this device */
	204	struct device_plugin *plugin;
	205	/* A plugin may handle multiple devices of the same type */
	206	int plugin_index;
	207	/* List of struct probe* */
	208	GSList *probes;
	209	/* Data acquired by this device, if any */
	210	struct datastore *datastore;
	211	};
	212
	213	struct probe {
	214	int index;
	215	gboolean enabled;
	216	char *name;
	217	char *trigger;
	218	};
	219
	220	extern GSList *devices;
	221
	222	void device_scan(void);
	223	void device_close_all(void);
	224	GSList *device_list(void);
873080cc	225	struct device device_new(struct device_plugin plugin, int plugin_index, int num_probes);
a1bb33af UH	226	void device_clear(struct device *device);
	227	void device_destroy(struct device *dev);
	228
	229	void device_probe_clear(struct device *device, int probenum);
	230	void device_probe_add(struct device device, char name);
	231	struct probe probe_find(struct device device, int probenum);
	232	void device_probe_name(struct device device, int probenum, char name);
	233
	234	void device_trigger_clear(struct device *device);
	235	void device_trigger_set(struct device device, int probenum, char trigger);
	236
	237	/--- hwplugin.c ------------------------------------------------------------/
	238
	239	/* Hardware plugin capabilities */
	240	enum {
1b452b85	241	HWCAP_DUMMY, /* Used to terminate lists */
a1bb33af	242	HWCAP_LOGIC_ANALYZER,
1b452b85 UH	243	HWCAP_SAMPLERATE, /* Change samplerate */
	244	HWCAP_PROBECONFIG, /* Configure probe mask */
	245	HWCAP_CAPTURE_RATIO, /* Set pre-trigger / post-trigger ratio */
	246	HWCAP_LIMIT_MSEC, /* Set a time limit for sample acquisition */
	247	HWCAP_LIMIT_SAMPLES, /* Set a limit on number of samples */
a1bb33af UH	248	};
	249
	250	struct hwcap_option {
	251	int capability;
	252	int type;
	253	char *description;
	254	char *shortname;
	255	};
	256
	257	struct sigrok_device_instance {
	258	int index;
	259	int status;
	260	int instance_type;
	261	char *vendor;
	262	char *model;
	263	char *version;
	264	union {
	265	struct usb_device_instance *usb;
	266	struct serial_device_instance *serial;
	267	};
	268	};
	269
	270	/* sigrok_device_instance types */
	271	enum {
	272	USB_INSTANCE,
	273	SERIAL_INSTANCE,
	274	};
	275
	276	struct usb_device_instance {
	277	uint8_t bus;
	278	uint8_t address;
	279	struct libusb_device_handle *devhdl;
	280	};
	281
	282	struct serial_device_instance {
	283	char *port;
	284	int fd;
	285	};
	286
	287	/* Device instance status */
	288	enum {
	289	ST_NOT_FOUND,
	290	/* Found, but still booting */
	291	ST_INITIALIZING,
	292	/* Live, but not in use */
	293	ST_INACTIVE,
	294	/* Actively in use in a session */
	295	ST_ACTIVE,
	296	};
	297
	298	/*
	299	* TODO: This sucks, you just kinda have to "know" the returned type.
	300	* TODO: Need a DI to return the number of trigger stages supported.
	301	*/
	302
	303	/* Device info IDs */
	304	enum {
	305	/* struct sigrok_device_instance for this specific device */
	306	DI_INSTANCE,
	307	/* The number of probes connected to this device */
	308	DI_NUM_PROBES,
4c100f32	309	/* Samplerates supported by this device, (struct samplerates) */
a1bb33af UH	310	DI_SAMPLERATES,
	311	/* Types of trigger supported, out of "01crf" (char ) /
	312	DI_TRIGGER_TYPES,
4c100f32 UH	313	/* The currently set samplerate in Hz (uint64_t) */
4c100f32 UH	314	DI_CUR_SAMPLERATE,
a1bb33af UH	315	};
a1bb33af UH	316
1b452b85 UH	317	/*
	318	* A device supports either a range of samplerates with steps of a given
	319	* granularity, or is limited to a set of defined samplerates. Use either
a1bb33af UH	320	* step or list, but not both.
	321	*/
	322	struct samplerates {
	323	uint64_t low;
	324	uint64_t high;
	325	uint64_t step;
	326	uint64_t *list;
	327	};
	328
	329	struct device_plugin {
1b452b85	330	/* Plugin-specific */
a1bb33af UH	331	char *name;
	332	int api_version;
	333	int (init) (char deviceinfo);
	334	void (*cleanup) (void);
	335
1b452b85	336	/* Device-specific */
a1bb33af UH	337	int (*open) (int device_index);
	338	void (*close) (int device_index);
	339	void (get_device_info) (int device_index, int device_info_id);
	340	int (*get_status) (int device_index);
	341	int (get_capabilities) (void);
	342	int (set_configuration) (int device_index, int capability, void value);
	343	int (*start_acquisition) (int device_index, gpointer session_device_id);
	344	void (*stop_acquisition) (int device_index, gpointer session_device_id);
	345	};
	346
	347	struct gsource_fd {
	348	GSource source;
	349	GPollFD gpfd;
	350	/* Not really using this */
	351	GSource *timeout_source;
	352	};
	353
	354	typedef int (receive_data_callback) (int fd, int revents, void user_data);
	355
	356	int load_hwplugins(void);
	357	GSList *list_hwplugins(void);
	358
	359	/* Generic device instances */
	360	struct sigrok_device_instance *sigrok_device_instance_new(int index,
49d0ce50	361	int status, const char vendor, const char model, const char *version);
1b452b85 UH	362	struct sigrok_device_instance *get_sigrok_device_instance(
1b452b85 UH	363	GSList *device_instances, int device_index);
a1bb33af UH	364	void sigrok_device_instance_free(struct sigrok_device_instance *sdi);
	365
	366	/* USB-specific instances */
	367	struct usb_device_instance *usb_device_instance_new(uint8_t bus,
	368	uint8_t address, struct libusb_device_handle *hdl);
	369	void usb_device_instance_free(struct usb_device_instance *usb);
	370
	371	/* Serial-specific instances */
49d0ce50 UH	372	struct serial_device_instance *serial_device_instance_new(
49d0ce50 UH	373	const char *port, int fd);
a1bb33af UH	374	void serial_device_instance_free(struct serial_device_instance *serial);
	375
	376	int find_hwcap(int *capabilities, int hwcap);
	377	struct hwcap_option *find_hwcap_option(int hwcap);
	378	void source_remove(int fd);
1b452b85 UH	379	void source_add(int fd, int events, int timeout, receive_data_callback rcv_cb,
1b452b85 UH	380	void *user_data);
a1bb33af UH	381
	382	/--- session.c -------------------------------------------------------------/
	383
	384	typedef void (*source_callback_remove) (int fd);
	385	typedef void (*source_callback_add) (int fd, int events, int timeout,
	386	receive_data_callback callback, void *user_data);
	387	typedef void (datafeed_callback) (struct device device,
	388	struct datafeed_packet *packet);
	389
	390	struct session {
	391	/* List of struct device* */
	392	GSList *devices;
	393	/* List of struct analyzer* */
	394	GSList *analyzers;
1b452b85	395	/* Datafeed callbacks */
a1bb33af UH	396	GSList *datafeed_callbacks;
	397	GTimeVal starttime;
	398	};
	399
	400	/* Session setup */
afc8e4de	401	struct session session_load(const char filename);
a1bb33af UH	402	struct session *session_new(void);
	403	void session_destroy(void);
	404	void session_device_clear(void);
	405	int session_device_add(struct device *device);
	406
	407	/* Protocol analyzers setup */
	408	void session_pa_clear(void);
	409	void session_pa_add(struct analyzer *pa);
	410
	411	/* Datafeed setup */
	412	void session_datafeed_callback_clear(void);
	413	void session_datafeed_callback_add(datafeed_callback callback);
	414
	415	/* Session control */
	416	int session_start(void);
	417	void session_stop(void);
	418	void session_bus(struct device device, struct datafeed_packet packet);
	419	void make_metadata(char *filename);
	420	int session_save(char *filename);
	421
	422	/--- hwcommon.c ------------------------------------------------------------/
	423
	424	int ezusb_reset(struct libusb_device_handle *hdl, int set_clear);
	425	int ezusb_install_firmware(libusb_device_handle hdl, char filename);
edf60d05 UH	426	int ezusb_upload_firmware(libusb_device *dev, int configuration,
edf60d05 UH	427	const char *filename);
a1bb33af UH	428
a1bb33af UH	429	GSList *list_serial_ports(void);
d02a535e BV	430	int serial_open(const char *pathname, int flags);
	431	int serial_close(int fd);
	432	void *serial_backup_params(int fd);
	433	void serial_restore_params(int fd, void *backup);
1b452b85 UH	434	int serial_set_params(int fd, int speed, int bits, int parity, int stopbits,
1b452b85 UH	435	int flowcontrol);
a1bb33af	436
9a5c6dcf UH	437	/* libsigrok/hardware/common/misc.c */
	438	/* TODO: Should not be public. */
	439	int opendev2(int device_index, struct sigrok_device_instance **sdi,
	440	libusb_device dev, struct libusb_device_descriptor des,
	441	int *skip, uint16_t vid, uint16_t pid, int interface);
	442	int opendev3(struct sigrok_device_instance *sdi, libusb_device dev,
	443	struct libusb_device_descriptor *des,
	444	uint16_t vid, uint16_t pid, int interface);
	445
a1bb33af	446	#endif