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

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

#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	SR_T_KEYVALUE,
	149	};
	150
	151	struct sr_rational {
	152	/* numerator */
	153	uint64_t p;
	154	/* denominator */
	155	uint64_t q;
	156	};
	157
	158	/* sr_datafeed_packet.type values */
	159	enum {
	160	SR_DF_HEADER,
	161	SR_DF_END,
	162	SR_DF_TRIGGER,
	163	SR_DF_LOGIC,
	164	SR_DF_META_LOGIC,
	165	SR_DF_ANALOG,
	166	SR_DF_META_ANALOG,
	167	SR_DF_FRAME_BEGIN,
	168	SR_DF_FRAME_END,
	169	};
	170
	171	/* sr_datafeed_analog.mq values */
	172	enum {
	173	SR_MQ_VOLTAGE,
	174	SR_MQ_CURRENT,
	175	SR_MQ_RESISTANCE,
	176	SR_MQ_CAPACITANCE,
	177	SR_MQ_TEMPERATURE,
	178	SR_MQ_FREQUENCY,
	179	SR_MQ_DUTY_CYCLE,
	180	};
	181
	182	/* sr_datafeed_analog.unit values */
	183	enum {
	184	SR_UNIT_VOLT,
	185	SR_UNIT_AMPERE,
	186	SR_UNIT_OHM,
	187	SR_UNIT_FARAD,
	188	SR_UNIT_CELSIUS,
	189	SR_UNIT_KELVIN,
	190	SR_UNIT_HERTZ,
	191	SR_UNIT_PERCENTAGE,
	192	};
	193
	194	struct sr_datafeed_packet {
	195	uint16_t type;
	196	void *payload;
	197	};
	198
	199	struct sr_datafeed_header {
	200	int feed_version;
	201	struct timeval starttime;
	202	};
	203
	204	struct sr_datafeed_meta_logic {
	205	int num_probes;
	206	uint64_t samplerate;
	207	};
	208
	209	struct sr_datafeed_logic {
	210	uint64_t length;
	211	uint16_t unitsize;
	212	void *data;
	213	};
	214
	215	struct sr_datafeed_meta_analog {
	216	int num_probes;
	217	};
	218
	219	struct sr_datafeed_analog {
	220	int num_samples;
	221	int mq; /* Measured quantity (e.g. voltage, current, temperature) */
	222	int unit; /* Unit in which the MQ is measured. */
	223	float *data;
	224	};
	225
	226	struct sr_input {
	227	struct sr_input_format *format;
	228	char *param;
	229	struct sr_dev *vdev;
	230	};
	231
	232	struct sr_input_format {
	233	char *id;
	234	char *description;
	235	int (format_match) (const char filename);
	236	int (init) (struct sr_input in);
	237	int (loadfile) (struct sr_input in, const char *filename);
	238	};
	239
	240	struct sr_output {
	241	struct sr_output_format *format;
	242	struct sr_dev *dev;
	243	char *param;
	244	void *internal;
	245	};
	246
	247	struct sr_output_format {
	248	char *id;
	249	char *description;
	250	int df_type;
	251	int (init) (struct sr_output o);
	252	int (data) (struct sr_output o, const uint8_t *data_in,
	253	uint64_t length_in, uint8_t **data_out,
	254	uint64_t *length_out);
	255	int (event) (struct sr_output o, int event_type, uint8_t **data_out,
	256	uint64_t *length_out);
	257	};
	258
	259	struct sr_datastore {
	260	/* Size in bytes of the number of units stored in this datastore */
	261	int ds_unitsize;
	262	unsigned int num_units; /* TODO: uint64_t */
	263	GSList *chunklist;
	264	};
	265
	266	/*
	267	* This represents a generic device connected to the system.
	268	* For device-specific information, ask the driver. The driver_index refers
	269	* to the device index within that driver; it may be handling more than one
	270	* device. All relevant driver calls take a dev_index parameter for this.
	271	*/
	272	struct sr_dev {
	273	/* Which driver handles this device */
	274	struct sr_dev_driver *driver;
	275	/* A driver may handle multiple devices of the same type */
	276	int driver_index;
	277	/* List of struct sr_probe* */
	278	GSList *probes;
	279	/* Data acquired by this device, if any */
	280	struct sr_datastore *datastore;
	281	};
	282
	283	enum {
	284	SR_PROBE_TYPE_LOGIC,
	285	};
	286
	287	struct sr_probe {
	288	int index;
	289	int type;
	290	gboolean enabled;
	291	char *name;
	292	char *trigger;
	293	};
	294
	295	/* Hardware driver capabilities */
	296	enum {
	297	SR_HWCAP_DUMMY = 0, /* Used to terminate lists. Must be 0! */
	298
	299	/--- Device classes ------------------------------------------------/
	300
	301	/** The device can act as logic analyzer. */
	302	SR_HWCAP_LOGIC_ANALYZER,
	303
	304	/** The device can act as an oscilloscope. */
	305	SR_HWCAP_OSCILLOSCOPE,
	306
	307	/** The device can act as a multimeter. */
	308	SR_HWCAP_MULTIMETER,
	309
	310	/** The device is a demo device. */
	311	SR_HWCAP_DEMO_DEV,
	312
	313
	314	/--- Device communication ------------------------------------------/
	315	/** Some drivers cannot detect the exact model they're talking to. */
	316	SR_HWCAP_MODEL,
	317
	318	/** Specification on how to connect to a device */
	319	SR_HWCAP_CONN,
	320
	321	/** Serial communication spec: <data bits><parity><stop bit> e.g. 8n1 */
	322	SR_HWCAP_SERIALCOMM,
	323
	324
	325	/--- Device configuration ------------------------------------------/
	326
	327	/** The device supports setting/changing its samplerate. */
	328	SR_HWCAP_SAMPLERATE,
	329
	330	/* TODO: Better description? Rename to PROBE_AND_TRIGGER_CONFIG? */
	331	/** The device supports setting a probe mask. */
	332	SR_HWCAP_PROBECONFIG,
	333
	334	/** The device supports setting a pre/post-trigger capture ratio. */
	335	SR_HWCAP_CAPTURE_RATIO,
	336
	337	/* TODO? */
	338	/** The device supports setting a pattern (pattern generator mode). */
	339	SR_HWCAP_PATTERN_MODE,
	340
	341	/** The device supports Run Length Encoding. */
	342	SR_HWCAP_RLE,
	343
	344	/** The device supports setting trigger slope. */
	345	SR_HWCAP_TRIGGER_SLOPE,
	346
	347	/** Trigger source. */
	348	SR_HWCAP_TRIGGER_SOURCE,
	349
	350	/** Horizontal trigger position */
	351	SR_HWCAP_HORIZ_TRIGGERPOS,
	352
	353	/** Buffer size. */
	354	SR_HWCAP_BUFFERSIZE,
	355
	356	/** Time base. */
	357	SR_HWCAP_TIMEBASE,
	358
	359	/** Filter. */
	360	SR_HWCAP_FILTER,
	361
	362	/** Volts/div. */
	363	SR_HWCAP_VDIV,
	364
	365	/** Coupling. */
	366	SR_HWCAP_COUPLING,
	367
	368
	369	/--- Special stuff -------------------------------------------------/
	370
	371	/* TODO: Better description. */
	372	/** The device supports specifying a capturefile to inject. */
	373	SR_HWCAP_CAPTUREFILE,
	374
	375	/* TODO: Better description. */
	376	/** The device supports specifying the capturefile unit size. */
	377	SR_HWCAP_CAPTURE_UNITSIZE,
	378
	379	/* TODO: Better description. */
	380	/** The device supports setting the number of probes. */
	381	SR_HWCAP_CAPTURE_NUM_PROBES,
	382
	383
	384	/--- Acquisition modes ---------------------------------------------/
	385
	386	/**
	387	* The device supports setting a sample time limit, i.e. how long the
	388	* sample acquisition should run (in ms).
	389	*/
	390	SR_HWCAP_LIMIT_MSEC,
	391
	392	/**
	393	* The device supports setting a sample number limit, i.e. how many
	394	* samples should be acquired.
	395	*/
	396	SR_HWCAP_LIMIT_SAMPLES,
	397
	398	/**
	399	* The device supports setting a frame limit, i.e. how many
	400	* frames should be acquired.
	401	*/
	402	SR_HWCAP_LIMIT_FRAMES,
	403
	404	/**
	405	* The device supports continuous sampling, i.e. neither a time limit
	406	* nor a sample number limit has to be supplied, it will just acquire
	407	* samples continuously, until explicitly stopped by a certain command.
	408	*/
	409	SR_HWCAP_CONTINUOUS,
	410
	411	};
	412
	413	struct sr_hwcap_option {
	414	int hwcap;
	415	int type;
	416	char *description;
	417	char *shortname;
	418	};
	419
	420	struct sr_dev_inst {
	421	int index;
	422	int status;
	423	int inst_type;
	424	char *vendor;
	425	char *model;
	426	char *version;
	427	void *priv;
	428	};
	429
	430	/* sr_dev_inst types */
	431	enum {
	432	/** Device instance type for USB devices. */
	433	SR_INST_USB,
	434	/** Device instance type for serial port devices. */
	435	SR_INST_SERIAL,
	436	};
	437
	438	/* Device instance status */
	439	enum {
	440	SR_ST_NOT_FOUND,
	441	/* Found, but still booting */
	442	SR_ST_INITIALIZING,
	443	/* Live, but not in use */
	444	SR_ST_INACTIVE,
	445	/* Actively in use in a session */
	446	SR_ST_ACTIVE,
	447	};
	448
	449	/*
	450	* TODO: This sucks, you just kinda have to "know" the returned type.
	451	* TODO: Need a DI to return the number of trigger stages supported.
	452	*/
	453
	454	/* Device info IDs */
	455	enum {
	456	/* struct sr_dev_inst for this specific device */
	457	SR_DI_INST,
	458	/* The number of probes connected to this device */
	459	SR_DI_NUM_PROBES,
	460	/* The probe names on this device */
	461	SR_DI_PROBE_NAMES,
	462	/* Samplerates supported by this device, (struct sr_samplerates) */
	463	SR_DI_SAMPLERATES,
	464	/* Types of logic trigger supported, out of "01crf" (char ) /
	465	SR_DI_TRIGGER_TYPES,
	466	/* The currently set samplerate in Hz (uint64_t) */
	467	SR_DI_CUR_SAMPLERATE,
	468	/* Supported patterns (in pattern generator mode) */
	469	SR_DI_PATTERNS,
	470	/* Supported buffer sizes */
	471	SR_DI_BUFFERSIZES,
	472	/* Supported time bases */
	473	SR_DI_TIMEBASES,
	474	/* Supported trigger sources */
	475	SR_DI_TRIGGER_SOURCES,
	476	/* Supported filter targets */
	477	SR_DI_FILTERS,
	478	/* Valid volts/div values */
	479	SR_DI_VDIVS,
	480	/* Coupling options */
	481	SR_DI_COUPLING,
	482	};
	483
	484	/*
	485	* A device supports either a range of samplerates with steps of a given
	486	* granularity, or is limited to a set of defined samplerates. Use either
	487	* step or list, but not both.
	488	*/
	489	struct sr_samplerates {
	490	uint64_t low;
	491	uint64_t high;
	492	uint64_t step;
	493	const uint64_t *list;
	494	};
	495
	496	struct sr_dev_driver {
	497	/* Driver-specific */
	498	char *name;
	499	char *longname;
	500	int api_version;
	501	int (init) (const char devinfo);
	502	int (*cleanup) (void);
	503
	504	/* Device-specific */
	505	int (*dev_open) (int dev_index);
	506	int (*dev_close) (int dev_index);
	507	const void (dev_info_get) (int dev_index, int dev_info_id);
	508	int (*dev_status_get) (int dev_index);
	509	const int (hwcap_get_all) (void);
	510	int (dev_config_set) (int dev_index, int hwcap, const void value);
	511	int (dev_acquisition_start) (int dev_index, void session_dev_id);
	512	int (dev_acquisition_stop) (int dev_index, void session_dev_id);
	513	};
	514
	515	struct sr_session {
	516	/* List of struct sr_dev* */
	517	GSList *devs;
	518	/* list of sr_receive_data_callback_t */
	519	GSList *datafeed_callbacks;
	520	GTimeVal starttime;
	521	gboolean running;
	522	};
	523
	524	#include "sigrok-proto.h"
	525
	526	#ifdef __cplusplus
	527	}
	528	#endif
	529
	530	#endif