[libsigrok.git] / libsigrok.h

/*
 * 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/>.
 */

#ifndef LIBSIGROK_SIGROK_H
#define LIBSIGROK_SIGROK_H

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

#ifdef __cplusplus
extern "C" {
#endif

/*
 * 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 SR_OK                 0 /* No error */
#define SR_ERR               -1 /* Generic/unspecified error */
#define SR_ERR_MALLOC        -2 /* Malloc/calloc/realloc error */
#define SR_ERR_ARG           -3 /* Function argument error */
#define SR_ERR_BUG           -4 /* Errors hinting at internal bugs */
#define SR_ERR_SAMPLERATE    -5 /* Incorrect samplerate */

#define SR_MAX_NUM_PROBES    64 /* Limited by uint64_t. */
#define SR_MAX_PROBENAME_LEN 32

/* Handy little macros */
#define SR_HZ(n)  (n)
#define SR_KHZ(n) ((n) * 1000)
#define SR_MHZ(n) ((n) * 1000000)
#define SR_GHZ(n) ((n) * 1000000000)

#define SR_HZ_TO_NS(n) (1000000000 / (n))

/* libsigrok loglevels. */
#define SR_LOG_NONE           0 /**< Output no messages at all. */
#define SR_LOG_ERR            1 /**< Output error messages. */
#define SR_LOG_WARN           2 /**< Output warnings. */
#define SR_LOG_INFO           3 /**< Output informational messages. */
#define SR_LOG_DBG            4 /**< Output debug messages. */
#define SR_LOG_SPEW           5 /**< Output very noisy debug messages. */

/*
 * Use SR_API to mark public API symbols, and SR_PRIV for private symbols.
 *
 * Variables and functions marked 'static' are private already and don't
 * need SR_PRIV. However, functions which are not static (because they need
 * to be used in other libsigrok-internal files) but are also not meant to
 * be part of the public libsigrok API, must use SR_PRIV.
 *
 * This uses the 'visibility' feature of gcc (requires gcc >= 4.0).
 *
 * This feature is not available on MinGW/Windows, as it is a feature of
 * ELF files and MinGW/Windows uses PE files.
 *
 * Details: http://gcc.gnu.org/wiki/Visibility
 */

/* Marks public libsigrok API symbols. */
#ifndef _WIN32
#define SR_API __attribute__((visibility("default")))
#else
#define SR_API
#endif

/* Marks private, non-public libsigrok symbols (not part of the API). */
#ifndef _WIN32
#define SR_PRIV __attribute__((visibility("hidden")))
#else
#define SR_PRIV
#endif

typedef int (*sr_receive_data_callback_t)(int fd, int revents, void *cb_data);

/* Data types used by hardware drivers for dev_config_set() */
enum {
	SR_T_UINT64,
	SR_T_CHAR,
	SR_T_BOOL,
	SR_T_FLOAT,
	SR_T_RATIONAL_PERIOD,
	SR_T_RATIONAL_VOLT,
	SR_T_KEYVALUE,
};

struct sr_rational {
	/* numerator */
	uint64_t p;
	/* denominator */
	uint64_t q;
};

/* sr_datafeed_packet.type values */
enum {
	SR_DF_HEADER,
	SR_DF_END,
	SR_DF_TRIGGER,
	SR_DF_LOGIC,
	SR_DF_META_LOGIC,
	SR_DF_ANALOG,
	SR_DF_META_ANALOG,
	SR_DF_FRAME_BEGIN,
	SR_DF_FRAME_END,
};

/* sr_datafeed_analog.mq values */
enum {
	SR_MQ_VOLTAGE,
	SR_MQ_CURRENT,
	SR_MQ_RESISTANCE,
	SR_MQ_CAPACITANCE,
	SR_MQ_TEMPERATURE,
	SR_MQ_FREQUENCY,
	SR_MQ_DUTY_CYCLE,
};

/* sr_datafeed_analog.unit values */
enum {
	SR_UNIT_VOLT,
	SR_UNIT_AMPERE,
	SR_UNIT_OHM,
	SR_UNIT_FARAD,
	SR_UNIT_CELSIUS,
	SR_UNIT_KELVIN,
	SR_UNIT_HERTZ,
	SR_UNIT_PERCENTAGE,
};

struct sr_datafeed_packet {
	uint16_t type;
	void *payload;
};

struct sr_datafeed_header {
	int feed_version;
	struct timeval starttime;
};

struct sr_datafeed_meta_logic {
	int num_probes;
	uint64_t samplerate;
};

struct sr_datafeed_logic {
	uint64_t length;
	uint16_t unitsize;
	void *data;
};

struct sr_datafeed_meta_analog {
	int num_probes;
};

struct sr_datafeed_analog {
	int num_samples;
	int mq; /* Measured quantity (e.g. voltage, current, temperature) */
	int unit; /* Unit in which the MQ is measured. */
	float *data;
};

struct sr_input {
	struct sr_input_format *format;
	GHashTable *param;
	struct sr_dev *vdev;
	void *internal;
};

struct sr_input_format {
	char *id;
	char *description;
	int (*format_match) (const char *filename);
	int (*init) (struct sr_input *in);
	int (*loadfile) (struct sr_input *in, const char *filename);
};

struct sr_output {
	struct sr_output_format *format;
	struct sr_dev *dev;
	char *param;
	void *internal;
};

struct sr_output_format {
	char *id;
	char *description;
	int df_type;
	int (*init) (struct sr_output *o);
	int (*data) (struct sr_output *o, const uint8_t *data_in,
		     uint64_t length_in, uint8_t **data_out,
		     uint64_t *length_out);
	int (*event) (struct sr_output *o, int event_type, uint8_t **data_out,
		      uint64_t *length_out);
};

struct sr_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;
};

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

enum {
	SR_PROBE_TYPE_LOGIC,
};

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

/* Hardware driver capabilities */
enum {
	SR_HWCAP_DUMMY = 0, /* Used to terminate lists. Must be 0! */

	/*--- Device classes ------------------------------------------------*/

	/** The device can act as logic analyzer. */
	SR_HWCAP_LOGIC_ANALYZER,

	/** The device can act as an oscilloscope. */
	SR_HWCAP_OSCILLOSCOPE,

	/** The device can act as a multimeter. */
	SR_HWCAP_MULTIMETER,

	/** The device is a demo device. */
	SR_HWCAP_DEMO_DEV,


	/*--- Device communication ------------------------------------------*/
	/** Some drivers cannot detect the exact model they're talking to. */
	SR_HWCAP_MODEL,

	/** Specification on how to connect to a device */
	SR_HWCAP_CONN,

	/** Serial communication spec: <data bits><parity><stop bit> e.g. 8n1 */
	SR_HWCAP_SERIALCOMM,


	/*--- Device configuration ------------------------------------------*/

	/** The device supports setting/changing its samplerate. */
	SR_HWCAP_SAMPLERATE,

	/* TODO: Better description? Rename to PROBE_AND_TRIGGER_CONFIG? */
	/** The device supports setting a probe mask. */
	SR_HWCAP_PROBECONFIG,

	/** The device supports setting a pre/post-trigger capture ratio. */
	SR_HWCAP_CAPTURE_RATIO,

	/* TODO? */
	/** The device supports setting a pattern (pattern generator mode). */
	SR_HWCAP_PATTERN_MODE,

	/** The device supports Run Length Encoding. */
	SR_HWCAP_RLE,

	/** The device supports setting trigger slope. */
	SR_HWCAP_TRIGGER_SLOPE,

	/** Trigger source. */
	SR_HWCAP_TRIGGER_SOURCE,

	/** Horizontal trigger position */
	SR_HWCAP_HORIZ_TRIGGERPOS,

	/** Buffer size. */
	SR_HWCAP_BUFFERSIZE,

	/** Time base. */
	SR_HWCAP_TIMEBASE,

	/** Filter. */
	SR_HWCAP_FILTER,

	/** Volts/div. */
	SR_HWCAP_VDIV,

	/** Coupling. */
	SR_HWCAP_COUPLING,


	/*--- Special stuff -------------------------------------------------*/

	/* TODO: Better description. */
	/** The device supports specifying a capturefile to inject. */
	SR_HWCAP_CAPTUREFILE,

	/* TODO: Better description. */
	/** The device supports specifying the capturefile unit size. */
	SR_HWCAP_CAPTURE_UNITSIZE,

	/* TODO: Better description. */
	/** The device supports setting the number of probes. */
	SR_HWCAP_CAPTURE_NUM_PROBES,


	/*--- Acquisition modes ---------------------------------------------*/

	/**
	 * The device supports setting a sample time limit, i.e. how long the
	 * sample acquisition should run (in ms).
	 */
	SR_HWCAP_LIMIT_MSEC,

	/**
	 * The device supports setting a sample number limit, i.e. how many
	 * samples should be acquired.
	 */
	SR_HWCAP_LIMIT_SAMPLES,

	/**
	 * The device supports setting a frame limit, i.e. how many
	 * frames should be acquired.
	 */
	SR_HWCAP_LIMIT_FRAMES,

	/**
	 * The device supports continuous sampling, i.e. neither a time limit
	 * nor a sample number limit has to be supplied, it will just acquire
	 * samples continuously, until explicitly stopped by a certain command.
	 */
	SR_HWCAP_CONTINUOUS,

};

struct sr_hwcap_option {
	int hwcap;
	int type;
	char *description;
	char *shortname;
};

struct sr_dev_inst {
	int index;
	int status;
	int inst_type;
	char *vendor;
	char *model;
	char *version;
	void *priv;
};

/* sr_dev_inst types */
enum {
	/** Device instance type for USB devices. */
	SR_INST_USB,
	/** Device instance type for serial port devices. */
	SR_INST_SERIAL,
};

/* Device instance status */
enum {
	SR_ST_NOT_FOUND,
	/* Found, but still booting */
	SR_ST_INITIALIZING,
	/* Live, but not in use */
	SR_ST_INACTIVE,
	/* Actively in use in a session */
	SR_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 sr_dev_inst for this specific device */
	SR_DI_INST,
	/* The number of probes connected to this device */
	SR_DI_NUM_PROBES,
	/* The probe names on this device */
	SR_DI_PROBE_NAMES,
	/* Samplerates supported by this device, (struct sr_samplerates) */
	SR_DI_SAMPLERATES,
	/* Types of logic trigger supported, out of "01crf" (char *) */
	SR_DI_TRIGGER_TYPES,
	/* The currently set samplerate in Hz (uint64_t) */
	SR_DI_CUR_SAMPLERATE,
	/* Supported patterns (in pattern generator mode) */
	SR_DI_PATTERNS,
	/* Supported buffer sizes */
	SR_DI_BUFFERSIZES,
	/* Supported time bases */
	SR_DI_TIMEBASES,
	/* Supported trigger sources */
	SR_DI_TRIGGER_SOURCES,
	/* Supported filter targets */
	SR_DI_FILTERS,
	/* Valid volts/div values */
	SR_DI_VDIVS,
	/* Coupling options */
	SR_DI_COUPLING,
};

/*
 * 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 sr_samplerates {
	uint64_t low;
	uint64_t high;
	uint64_t step;
	const uint64_t *list;
};

struct sr_dev_driver {
	/* Driver-specific */
	char *name;
	char *longname;
	int api_version;
	int (*init) (const char *devinfo);
	int (*cleanup) (void);

	/* Device-specific */
	int (*dev_open) (int dev_index);
	int (*dev_close) (int dev_index);
	const void *(*dev_info_get) (int dev_index, int dev_info_id);
	int (*dev_status_get) (int dev_index);
	const int *(*hwcap_get_all) (void);
	int (*dev_config_set) (int dev_index, int hwcap, const void *value);
	int (*dev_acquisition_start) (int dev_index, void *session_dev_id);
	int (*dev_acquisition_stop) (int dev_index, void *session_dev_id);
};

struct sr_session {
	/* List of struct sr_dev* */
	GSList *devs;
	/* list of sr_receive_data_callback_t */
	GSList *datafeed_callbacks;
	GTimeVal starttime;
	gboolean running;

	unsigned int num_sources;

	/* Both "sources" and "pollfds" are of the same size and contain pairs of
	 * descriptor and callback function. We can not embed the GPollFD into the
	 * source struct since we want to be able to pass the array of all poll
	 * descriptors to g_poll.
	 */
	struct source *sources;
	GPollFD *pollfds;
	int source_timeout;
};

#include "proto.h"
#include "version.h"

#ifdef __cplusplus
}
#endif

#endif
Commit	Line	Data
	1	/*
	2	* This file is part of the sigrok project.
	3	*
	4	* Copyright (C) 2010-2012 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 LIBSIGROK_SIGROK_H
	21	#define LIBSIGROK_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
	29	#ifdef __cplusplus
	30	extern "C" {
	31	#endif
	32
	33	/*
	34	* Status/error codes returned by libsigrok functions.
	35	*
	36	* All possible return codes of libsigrok functions must be listed here.
	37	* Functions should never return hardcoded numbers as status, but rather
	38	* use these #defines instead. All error codes are negative numbers.
	39	*
	40	* The error codes are globally unique in libsigrok, i.e. if one of the
	41	* libsigrok functions returns a "malloc error" it must be exactly the same
	42	* return value as used by all other functions to indicate "malloc error".
	43	* There must be no functions which indicate two different errors via the
	44	* same return code.
	45	*
	46	* Also, for compatibility reasons, no defined return codes are ever removed
	47	* or reused for different #defines later. You can only add new #defines and
	48	* return codes, but never remove or redefine existing ones.
	49	*/
	50	#define SR_OK 0 /* No error */
	51	#define SR_ERR -1 /* Generic/unspecified error */
	52	#define SR_ERR_MALLOC -2 /* Malloc/calloc/realloc error */
	53	#define SR_ERR_ARG -3 /* Function argument error */
	54	#define SR_ERR_BUG -4 /* Errors hinting at internal bugs */
	55	#define SR_ERR_SAMPLERATE -5 /* Incorrect samplerate */
	56
	57	#define SR_MAX_NUM_PROBES 64 /* Limited by uint64_t. */
	58	#define SR_MAX_PROBENAME_LEN 32
	59
	60	/* Handy little macros */
	61	#define SR_HZ(n) (n)
	62	#define SR_KHZ(n) ((n) * 1000)
	63	#define SR_MHZ(n) ((n) * 1000000)
	64	#define SR_GHZ(n) ((n) * 1000000000)
	65
	66	#define SR_HZ_TO_NS(n) (1000000000 / (n))
	67
	68	/* libsigrok loglevels. */
	69	#define SR_LOG_NONE 0 /*< Output no messages at all. /
	70	#define SR_LOG_ERR 1 /*< Output error messages. /
	71	#define SR_LOG_WARN 2 /*< Output warnings. /
	72	#define SR_LOG_INFO 3 /*< Output informational messages. /
	73	#define SR_LOG_DBG 4 /*< Output debug messages. /
	74	#define SR_LOG_SPEW 5 /*< Output very noisy debug messages. /
	75
	76	/*
	77	* Use SR_API to mark public API symbols, and SR_PRIV for private symbols.
	78	*
	79	* Variables and functions marked 'static' are private already and don't
	80	* need SR_PRIV. However, functions which are not static (because they need
	81	* to be used in other libsigrok-internal files) but are also not meant to
	82	* be part of the public libsigrok API, must use SR_PRIV.
	83	*
	84	* This uses the 'visibility' feature of gcc (requires gcc >= 4.0).
	85	*
	86	* This feature is not available on MinGW/Windows, as it is a feature of
	87	* ELF files and MinGW/Windows uses PE files.
	88	*
	89	* Details: http://gcc.gnu.org/wiki/Visibility
	90	*/
	91
	92	/* Marks public libsigrok API symbols. */
	93	#ifndef _WIN32
	94	#define SR_API __attribute__((visibility("default")))
	95	#else
	96	#define SR_API
	97	#endif
	98
	99	/* Marks private, non-public libsigrok symbols (not part of the API). */
	100	#ifndef _WIN32
	101	#define SR_PRIV __attribute__((visibility("hidden")))
	102	#else
	103	#define SR_PRIV
	104	#endif
	105
	106	typedef int (sr_receive_data_callback_t)(int fd, int revents, void cb_data);
	107
	108	/* Data types used by hardware drivers for dev_config_set() */
	109	enum {
	110	SR_T_UINT64,
	111	SR_T_CHAR,
	112	SR_T_BOOL,
	113	SR_T_FLOAT,
	114	SR_T_RATIONAL_PERIOD,
	115	SR_T_RATIONAL_VOLT,
	116	SR_T_KEYVALUE,
	117	};
	118
	119	struct sr_rational {
	120	/* numerator */
	121	uint64_t p;
	122	/* denominator */
	123	uint64_t q;
	124	};
	125
	126	/* sr_datafeed_packet.type values */
	127	enum {
	128	SR_DF_HEADER,
	129	SR_DF_END,
	130	SR_DF_TRIGGER,
	131	SR_DF_LOGIC,
	132	SR_DF_META_LOGIC,
	133	SR_DF_ANALOG,
	134	SR_DF_META_ANALOG,
	135	SR_DF_FRAME_BEGIN,
	136	SR_DF_FRAME_END,
	137	};
	138
	139	/* sr_datafeed_analog.mq values */
	140	enum {
	141	SR_MQ_VOLTAGE,
	142	SR_MQ_CURRENT,
	143	SR_MQ_RESISTANCE,
	144	SR_MQ_CAPACITANCE,
	145	SR_MQ_TEMPERATURE,
	146	SR_MQ_FREQUENCY,
	147	SR_MQ_DUTY_CYCLE,
	148	};
	149
	150	/* sr_datafeed_analog.unit values */
	151	enum {
	152	SR_UNIT_VOLT,
	153	SR_UNIT_AMPERE,
	154	SR_UNIT_OHM,
	155	SR_UNIT_FARAD,
	156	SR_UNIT_CELSIUS,
	157	SR_UNIT_KELVIN,
	158	SR_UNIT_HERTZ,
	159	SR_UNIT_PERCENTAGE,
	160	};
	161
	162	struct sr_datafeed_packet {
	163	uint16_t type;
	164	void *payload;
	165	};
	166
	167	struct sr_datafeed_header {
	168	int feed_version;
	169	struct timeval starttime;
	170	};
	171
	172	struct sr_datafeed_meta_logic {
	173	int num_probes;
	174	uint64_t samplerate;
	175	};
	176
	177	struct sr_datafeed_logic {
	178	uint64_t length;
	179	uint16_t unitsize;
	180	void *data;
	181	};
	182
	183	struct sr_datafeed_meta_analog {
	184	int num_probes;
	185	};
	186
	187	struct sr_datafeed_analog {
	188	int num_samples;
	189	int mq; /* Measured quantity (e.g. voltage, current, temperature) */
	190	int unit; /* Unit in which the MQ is measured. */
	191	float *data;
	192	};
	193
	194	struct sr_input {
	195	struct sr_input_format *format;
	196	GHashTable *param;
	197	struct sr_dev *vdev;
	198	void *internal;
	199	};
	200
	201	struct sr_input_format {
	202	char *id;
	203	char *description;
	204	int (format_match) (const char filename);
	205	int (init) (struct sr_input in);
	206	int (loadfile) (struct sr_input in, const char *filename);
	207	};
	208
	209	struct sr_output {
	210	struct sr_output_format *format;
	211	struct sr_dev *dev;
	212	char *param;
	213	void *internal;
	214	};
	215
	216	struct sr_output_format {
	217	char *id;
	218	char *description;
	219	int df_type;
	220	int (init) (struct sr_output o);
	221	int (data) (struct sr_output o, const uint8_t *data_in,
	222	uint64_t length_in, uint8_t **data_out,
	223	uint64_t *length_out);
	224	int (event) (struct sr_output o, int event_type, uint8_t **data_out,
	225	uint64_t *length_out);
	226	};
	227
	228	struct sr_datastore {
	229	/* Size in bytes of the number of units stored in this datastore */
	230	int ds_unitsize;
	231	unsigned int num_units; /* TODO: uint64_t */
	232	GSList *chunklist;
	233	};
	234
	235	/*
	236	* This represents a generic device connected to the system.
	237	* For device-specific information, ask the driver. The driver_index refers
	238	* to the device index within that driver; it may be handling more than one
	239	* device. All relevant driver calls take a dev_index parameter for this.
	240	*/
	241	struct sr_dev {
	242	/* Which driver handles this device */
	243	struct sr_dev_driver *driver;
	244	/* A driver may handle multiple devices of the same type */
	245	int driver_index;
	246	/* List of struct sr_probe* */
	247	GSList *probes;
	248	/* Data acquired by this device, if any */
	249	struct sr_datastore *datastore;
	250	};
	251
	252	enum {
	253	SR_PROBE_TYPE_LOGIC,
	254	};
	255
	256	struct sr_probe {
	257	int index;
	258	int type;
	259	gboolean enabled;
	260	char *name;
	261	char *trigger;
	262	};
	263
	264	/* Hardware driver capabilities */
	265	enum {
	266	SR_HWCAP_DUMMY = 0, /* Used to terminate lists. Must be 0! */
	267
	268	/--- Device classes ------------------------------------------------/
	269
	270	/** The device can act as logic analyzer. */
	271	SR_HWCAP_LOGIC_ANALYZER,
	272
	273	/** The device can act as an oscilloscope. */
	274	SR_HWCAP_OSCILLOSCOPE,
	275
	276	/** The device can act as a multimeter. */
	277	SR_HWCAP_MULTIMETER,
	278
	279	/** The device is a demo device. */
	280	SR_HWCAP_DEMO_DEV,
	281
	282
	283	/--- Device communication ------------------------------------------/
	284	/** Some drivers cannot detect the exact model they're talking to. */
	285	SR_HWCAP_MODEL,
	286
	287	/** Specification on how to connect to a device */
	288	SR_HWCAP_CONN,
	289
	290	/** Serial communication spec: <data bits><parity><stop bit> e.g. 8n1 */
	291	SR_HWCAP_SERIALCOMM,
	292
	293
	294	/--- Device configuration ------------------------------------------/
	295
	296	/** The device supports setting/changing its samplerate. */
	297	SR_HWCAP_SAMPLERATE,
	298
	299	/* TODO: Better description? Rename to PROBE_AND_TRIGGER_CONFIG? */
	300	/** The device supports setting a probe mask. */
	301	SR_HWCAP_PROBECONFIG,
	302
	303	/** The device supports setting a pre/post-trigger capture ratio. */
	304	SR_HWCAP_CAPTURE_RATIO,
	305
	306	/* TODO? */
	307	/** The device supports setting a pattern (pattern generator mode). */
	308	SR_HWCAP_PATTERN_MODE,
	309
	310	/** The device supports Run Length Encoding. */
	311	SR_HWCAP_RLE,
	312
	313	/** The device supports setting trigger slope. */
	314	SR_HWCAP_TRIGGER_SLOPE,
	315
	316	/** Trigger source. */
	317	SR_HWCAP_TRIGGER_SOURCE,
	318
	319	/** Horizontal trigger position */
	320	SR_HWCAP_HORIZ_TRIGGERPOS,
	321
	322	/** Buffer size. */
	323	SR_HWCAP_BUFFERSIZE,
	324
	325	/** Time base. */
	326	SR_HWCAP_TIMEBASE,
	327
	328	/** Filter. */
	329	SR_HWCAP_FILTER,
	330
	331	/** Volts/div. */
	332	SR_HWCAP_VDIV,
	333
	334	/** Coupling. */
	335	SR_HWCAP_COUPLING,
	336
	337
	338	/--- Special stuff -------------------------------------------------/
	339
	340	/* TODO: Better description. */
	341	/** The device supports specifying a capturefile to inject. */
	342	SR_HWCAP_CAPTUREFILE,
	343
	344	/* TODO: Better description. */
	345	/** The device supports specifying the capturefile unit size. */
	346	SR_HWCAP_CAPTURE_UNITSIZE,
	347
	348	/* TODO: Better description. */
	349	/** The device supports setting the number of probes. */
	350	SR_HWCAP_CAPTURE_NUM_PROBES,
	351
	352
	353	/--- Acquisition modes ---------------------------------------------/
	354
	355	/**
	356	* The device supports setting a sample time limit, i.e. how long the
	357	* sample acquisition should run (in ms).
	358	*/
	359	SR_HWCAP_LIMIT_MSEC,
	360
	361	/**
	362	* The device supports setting a sample number limit, i.e. how many
	363	* samples should be acquired.
	364	*/
	365	SR_HWCAP_LIMIT_SAMPLES,
	366
	367	/**
	368	* The device supports setting a frame limit, i.e. how many
	369	* frames should be acquired.
	370	*/
	371	SR_HWCAP_LIMIT_FRAMES,
	372
	373	/**
	374	* The device supports continuous sampling, i.e. neither a time limit
	375	* nor a sample number limit has to be supplied, it will just acquire
	376	* samples continuously, until explicitly stopped by a certain command.
	377	*/
	378	SR_HWCAP_CONTINUOUS,
	379
	380	};
	381
	382	struct sr_hwcap_option {
	383	int hwcap;
	384	int type;
	385	char *description;
	386	char *shortname;
	387	};
	388
	389	struct sr_dev_inst {
	390	int index;
	391	int status;
	392	int inst_type;
	393	char *vendor;
	394	char *model;
	395	char *version;
	396	void *priv;
	397	};
	398
	399	/* sr_dev_inst types */
	400	enum {
	401	/** Device instance type for USB devices. */
	402	SR_INST_USB,
	403	/** Device instance type for serial port devices. */
	404	SR_INST_SERIAL,
	405	};
	406
	407	/* Device instance status */
	408	enum {
	409	SR_ST_NOT_FOUND,
	410	/* Found, but still booting */
	411	SR_ST_INITIALIZING,
	412	/* Live, but not in use */
	413	SR_ST_INACTIVE,
	414	/* Actively in use in a session */
	415	SR_ST_ACTIVE,
	416	};
	417
	418	/*
	419	* TODO: This sucks, you just kinda have to "know" the returned type.
	420	* TODO: Need a DI to return the number of trigger stages supported.
	421	*/
	422
	423	/* Device info IDs */
	424	enum {
	425	/* struct sr_dev_inst for this specific device */
	426	SR_DI_INST,
	427	/* The number of probes connected to this device */
	428	SR_DI_NUM_PROBES,
	429	/* The probe names on this device */
	430	SR_DI_PROBE_NAMES,
	431	/* Samplerates supported by this device, (struct sr_samplerates) */
	432	SR_DI_SAMPLERATES,
	433	/* Types of logic trigger supported, out of "01crf" (char ) /
	434	SR_DI_TRIGGER_TYPES,
	435	/* The currently set samplerate in Hz (uint64_t) */
	436	SR_DI_CUR_SAMPLERATE,
	437	/* Supported patterns (in pattern generator mode) */
	438	SR_DI_PATTERNS,
	439	/* Supported buffer sizes */
	440	SR_DI_BUFFERSIZES,
	441	/* Supported time bases */
	442	SR_DI_TIMEBASES,
	443	/* Supported trigger sources */
	444	SR_DI_TRIGGER_SOURCES,
	445	/* Supported filter targets */
	446	SR_DI_FILTERS,
	447	/* Valid volts/div values */
	448	SR_DI_VDIVS,
	449	/* Coupling options */
	450	SR_DI_COUPLING,
	451	};
	452
	453	/*
	454	* A device supports either a range of samplerates with steps of a given
	455	* granularity, or is limited to a set of defined samplerates. Use either
	456	* step or list, but not both.
	457	*/
	458	struct sr_samplerates {
	459	uint64_t low;
	460	uint64_t high;
	461	uint64_t step;
	462	const uint64_t *list;
	463	};
	464
	465	struct sr_dev_driver {
	466	/* Driver-specific */
	467	char *name;
	468	char *longname;
	469	int api_version;
	470	int (init) (const char devinfo);
	471	int (*cleanup) (void);
	472
	473	/* Device-specific */
	474	int (*dev_open) (int dev_index);
	475	int (*dev_close) (int dev_index);
	476	const void (dev_info_get) (int dev_index, int dev_info_id);
	477	int (*dev_status_get) (int dev_index);
	478	const int (hwcap_get_all) (void);
	479	int (dev_config_set) (int dev_index, int hwcap, const void value);
	480	int (dev_acquisition_start) (int dev_index, void session_dev_id);
	481	int (dev_acquisition_stop) (int dev_index, void session_dev_id);
	482	};
	483
	484	struct sr_session {
	485	/* List of struct sr_dev* */
	486	GSList *devs;
	487	/* list of sr_receive_data_callback_t */
	488	GSList *datafeed_callbacks;
	489	GTimeVal starttime;
	490	gboolean running;
	491
	492	unsigned int num_sources;
	493
	494	/* Both "sources" and "pollfds" are of the same size and contain pairs of
	495	* descriptor and callback function. We can not embed the GPollFD into the
	496	* source struct since we want to be able to pass the array of all poll
	497	* descriptors to g_poll.
	498	*/
	499	struct source *sources;
	500	GPollFD *pollfds;
	501	int source_timeout;
	502	};
	503
	504	#include "proto.h"
	505	#include "version.h"
	506
	507	#ifdef __cplusplus
	508	}
	509	#endif
	510
	511	#endif