[libsigrok.git] / sigrok.h.in

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

/*
 * Package version macros (can be used for conditional compilation).
 */

/** The libsigrok package 'major' version number. */
#define SR_PACKAGE_VERSION_MAJOR @SR_PACKAGE_VERSION_MAJOR@

/** The libsigrok package 'minor' version number. */
#define SR_PACKAGE_VERSION_MINOR @SR_PACKAGE_VERSION_MINOR@

/** The libsigrok package 'micro' version number. */
#define SR_PACKAGE_VERSION_MICRO @SR_PACKAGE_VERSION_MICRO@

/** The libsigrok package version ("major.minor.micro") as string. */
#define SR_PACKAGE_VERSION_STRING "@SR_PACKAGE_VERSION@"

/*
 * Library/libtool version macros (can be used for conditional compilation).
 */

/** The libsigrok libtool 'current' version number. */
#define SR_LIB_VERSION_CURRENT @SR_LIB_VERSION_CURRENT@

/** The libsigrok libtool 'revision' version number. */
#define SR_LIB_VERSION_REVISION @SR_LIB_VERSION_REVISION@

/** The libsigrok libtool 'age' version number. */
#define SR_LIB_VERSION_AGE @SR_LIB_VERSION_AGE@

/** The libsigrok libtool version ("current:revision:age") as string. */
#define SR_LIB_VERSION_STRING "@SR_LIB_VERSION@"

/*
 * 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,
};

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.unit values */
enum {
	SR_UNIT_VOLTAGE,
	SR_UNIT_CURRENT,
};

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 unit;
	float *data;
};

struct sr_input {
	struct sr_input_format *format;
	char *param;
	struct sr_dev *vdev;
};

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,

	/*--- Device types --------------------------------------------------*/

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

	/*--- Device options ------------------------------------------------*/

	/** 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;
};

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