[libsigrok.git] / sigrok.h.in

/*
 * 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>
#ifdef HAVE_LIBUSB_1_0
#include <libusb.h>
#endif

#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
#define SR_LOG_ERR	 1
#define SR_LOG_WARN	 2
#define SR_LOG_INFO	 3
#define SR_LOG_DBG	 4
#define SR_LOG_SPEW	 5

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

/* Data types used by hardware plugins for set_configuration() */
enum {
	SR_T_UINT64,
	SR_T_CHAR,
	SR_T_BOOL,
};

/* sr_datafeed_packet.type values */
enum {
	SR_DF_HEADER,
	SR_DF_END,
	SR_DF_TRIGGER,
	SR_DF_LOGIC,
	SR_DF_ANALOG,
	SR_DF_PD,
};

struct sr_datafeed_packet {
	uint16_t type;
	/* timeoffset since start, in picoseconds */
	uint64_t timeoffset;
	/* duration of data in this packet, in picoseconds */
	uint64_t duration;
	void *payload;
};

struct sr_datafeed_header {
	int feed_version;
	struct timeval starttime;
	uint64_t samplerate;
	int num_analog_probes;
	int num_logic_probes;
};

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

#if defined(HAVE_LA_ALSA)
struct sr_analog_probe {
	uint8_t att;
	uint8_t res;	/* Needs to be a power of 2, FIXME */
	uint16_t val;	/* Max hardware ADC width is 16bits */
};

struct sr_analog_sample {
	uint8_t num_probes; /* Max hardware probes is 256 */
	struct sr_analog_probe probes[];
};
#endif

struct sr_input {
	struct sr_input_format *format;
	char *param;
	struct sr_device *vdevice;
};

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_device *device;
	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 char *data_in,
		     uint64_t length_in, char **data_out, uint64_t *length_out);
	int (*event) (struct sr_output *o, int event_type, char **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 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 sr_device {
	/* Which plugin handles this device */
	struct sr_device_plugin *plugin;
	/* A plugin may handle multiple devices of the same type */
	int plugin_index;
	/* List of struct sr_probe* */
	GSList *probes;
	/* Data acquired by this device, if any */
	struct sr_datastore *datastore;
};

enum {
	SR_PROBE_TYPE_LOGIC,
	SR_PROBE_TYPE_ANALOG,
};

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

/* Hardware plugin capabilities */
enum {
	SR_HWCAP_DUMMY,             /* Used to terminate lists */

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

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

	/* TODO: SR_HWCAP_SCOPE, SW_HWCAP_PATTERN_GENERATOR, etc.? */

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

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

	/* TODO: SR_HWCAP_JUST_SAMPLE or similar. */
};

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

struct sr_device_instance {
	int index;
	int status;
	int instance_type;
	char *vendor;
	char *model;
	char *version;
	void *priv;
	union {
		struct sr_usb_device_instance *usb;
		struct sr_serial_device_instance *serial;
	};
};

/* sr_device_instance types */
enum {
	SR_USB_INSTANCE,
	SR_SERIAL_INSTANCE,
};

#ifdef HAVE_LIBUSB_1_0
struct sr_usb_device_instance {
	uint8_t bus;
	uint8_t address;
	struct libusb_device_handle *devhdl;
};
#endif

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

/* 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_device_instance for this specific device */
	SR_DI_INSTANCE,
	/* 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 trigger supported, out of "01crf" (char *) */
	SR_DI_TRIGGER_TYPES,
	/* The currently set samplerate in Hz (uint64_t) */
	SR_DI_CUR_SAMPLERATE,
	/* Supported pattern generator modes */
	SR_DI_PATTERNMODES,
};

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

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

	/* Device-specific */
	int (*opendev) (int device_index);
	int (*closedev) (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 sr_session {
	/* List of struct sr_device* */
	GSList *devices;
	/* List of struct analyzer* */
	GSList *analyzers;
	/* list of sr_receive_data_callback */
	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 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	#ifdef HAVE_LIBUSB_1_0
	29	#include <libusb.h>
	30	#endif
	31
	32	#ifdef __cplusplus
	33	extern "C" {
	34	#endif
	35
	36	/*
	37	* Status/error codes returned by libsigrok functions.
	38	*
	39	* All possible return codes of libsigrok functions must be listed here.
	40	* Functions should never return hardcoded numbers as status, but rather
	41	* use these #defines instead. All error codes are negative numbers.
	42	*
	43	* The error codes are globally unique in libsigrok, i.e. if one of the
	44	* libsigrok functions returns a "malloc error" it must be exactly the same
	45	* return value as used by all other functions to indicate "malloc error".
	46	* There must be no functions which indicate two different errors via the
	47	* same return code.
	48	*
	49	* Also, for compatibility reasons, no defined return codes are ever removed
	50	* or reused for different #defines later. You can only add new #defines and
	51	* return codes, but never remove or redefine existing ones.
	52	*/
	53	#define SR_OK 0 /* No error */
	54	#define SR_ERR -1 /* Generic/unspecified error */
	55	#define SR_ERR_MALLOC -2 /* Malloc/calloc/realloc error */
	56	#define SR_ERR_ARG -3 /* Function argument error */
	57	#define SR_ERR_BUG -4 /* Errors hinting at internal bugs */
	58	#define SR_ERR_SAMPLERATE -5 /* Incorrect samplerate */
	59
	60	#define SR_MAX_NUM_PROBES 64 /* Limited by uint64_t. */
	61	#define SR_MAX_PROBENAME_LEN 32
	62
	63	/* Handy little macros */
	64	#define SR_HZ(n) (n)
	65	#define SR_KHZ(n) ((n) * 1000)
	66	#define SR_MHZ(n) ((n) * 1000000)
	67	#define SR_GHZ(n) ((n) * 1000000000)
	68
	69	#define SR_HZ_TO_NS(n) (1000000000 / (n))
	70
	71	/* libsigrok loglevels. */
	72	#define SR_LOG_NONE 0
	73	#define SR_LOG_ERR 1
	74	#define SR_LOG_WARN 2
	75	#define SR_LOG_INFO 3
	76	#define SR_LOG_DBG 4
	77	#define SR_LOG_SPEW 5
	78
	79	typedef int (sr_receive_data_callback) (int fd, int revents, void user_data);
	80
	81	/* Data types used by hardware plugins for set_configuration() */
	82	enum {
	83	SR_T_UINT64,
	84	SR_T_CHAR,
	85	SR_T_BOOL,
	86	};
	87
	88	/* sr_datafeed_packet.type values */
	89	enum {
	90	SR_DF_HEADER,
	91	SR_DF_END,
	92	SR_DF_TRIGGER,
	93	SR_DF_LOGIC,
	94	SR_DF_ANALOG,
	95	SR_DF_PD,
	96	};
	97
	98	struct sr_datafeed_packet {
	99	uint16_t type;
	100	/* timeoffset since start, in picoseconds */
	101	uint64_t timeoffset;
	102	/* duration of data in this packet, in picoseconds */
	103	uint64_t duration;
	104	void *payload;
	105	};
	106
	107	struct sr_datafeed_header {
	108	int feed_version;
	109	struct timeval starttime;
	110	uint64_t samplerate;
	111	int num_analog_probes;
	112	int num_logic_probes;
	113	};
	114
	115	struct sr_datafeed_logic {
	116	uint64_t length;
	117	uint16_t unitsize;
	118	void *data;
	119	};
	120
	121	#if defined(HAVE_LA_ALSA)
	122	struct sr_analog_probe {
	123	uint8_t att;
	124	uint8_t res; /* Needs to be a power of 2, FIXME */
	125	uint16_t val; /* Max hardware ADC width is 16bits */
	126	};
	127
	128	struct sr_analog_sample {
	129	uint8_t num_probes; /* Max hardware probes is 256 */
	130	struct sr_analog_probe probes[];
	131	};
	132	#endif
	133
	134	struct sr_input {
	135	struct sr_input_format *format;
	136	char *param;
	137	struct sr_device *vdevice;
	138	};
	139
	140	struct sr_input_format {
	141	char *id;
	142	char *description;
	143	int (format_match) (const char filename);
	144	int (init) (struct sr_input in);
	145	int (loadfile) (struct sr_input in, const char *filename);
	146	};
	147
	148	struct sr_output {
	149	struct sr_output_format *format;
	150	struct sr_device *device;
	151	char *param;
	152	void *internal;
	153	};
	154
	155	struct sr_output_format {
	156	char *id;
	157	char *description;
	158	int df_type;
	159	int (init) (struct sr_output o);
	160	int (data) (struct sr_output o, const char *data_in,
	161	uint64_t length_in, char *data_out, uint64_t length_out);
	162	int (event) (struct sr_output o, int event_type, char **data_out,
	163	uint64_t *length_out);
	164	};
	165
	166	struct sr_datastore {
	167	/* Size in bytes of the number of units stored in this datastore */
	168	int ds_unitsize;
	169	unsigned int num_units; /* TODO: uint64_t */
	170	GSList *chunklist;
	171	};
	172
	173	/*
	174	* This represents a generic device connected to the system.
	175	* For device-specific information, ask the plugin. The plugin_index refers
	176	* to the device index within that plugin; it may be handling more than one
	177	* device. All relevant plugin calls take a device_index parameter for this.
	178	*/
	179	struct sr_device {
	180	/* Which plugin handles this device */
	181	struct sr_device_plugin *plugin;
	182	/* A plugin may handle multiple devices of the same type */
	183	int plugin_index;
	184	/* List of struct sr_probe* */
	185	GSList *probes;
	186	/* Data acquired by this device, if any */
	187	struct sr_datastore *datastore;
	188	};
	189
	190	enum {
	191	SR_PROBE_TYPE_LOGIC,
	192	SR_PROBE_TYPE_ANALOG,
	193	};
	194
	195	struct sr_probe {
	196	int index;
	197	int type;
	198	gboolean enabled;
	199	char *name;
	200	char *trigger;
	201	};
	202
	203	/* Hardware plugin capabilities */
	204	enum {
	205	SR_HWCAP_DUMMY, /* Used to terminate lists */
	206
	207	/--- Device classes ------------------------------------------------/
	208
	209	/** The device can act as logic analyzer. */
	210	SR_HWCAP_LOGIC_ANALYZER,
	211
	212	/* TODO: SR_HWCAP_SCOPE, SW_HWCAP_PATTERN_GENERATOR, etc.? */
	213
	214	/--- Device options ------------------------------------------------/
	215
	216	/** The device supports setting/changing its samplerate. */
	217	SR_HWCAP_SAMPLERATE,
	218
	219	/* TODO: Better description? Rename to PROBE_AND_TRIGGER_CONFIG? */
	220	/** The device supports setting a probe mask. */
	221	SR_HWCAP_PROBECONFIG,
	222
	223	/** The device supports setting a pre/post-trigger capture ratio. */
	224	SR_HWCAP_CAPTURE_RATIO,
	225
	226	/* TODO? */
	227	/** The device supports setting a pattern (pattern generator mode). */
	228	SR_HWCAP_PATTERN_MODE,
	229
	230	/** The device supports Run Length Encoding. */
	231	SR_HWCAP_RLE,
	232
	233	/--- Special stuff -------------------------------------------------/
	234
	235	/* TODO: Better description. */
	236	/** The device supports specifying a capturefile to inject. */
	237	SR_HWCAP_CAPTUREFILE,
	238
	239	/* TODO: Better description. */
	240	/** The device supports specifying the capturefile unit size. */
	241	SR_HWCAP_CAPTURE_UNITSIZE,
	242
	243	/* TODO: Better description. */
	244	/** The device supports setting the number of probes. */
	245	SR_HWCAP_CAPTURE_NUM_PROBES,
	246
	247	/--- Acquisition modes ---------------------------------------------/
	248
	249	/**
	250	* The device supports setting a sample time limit, i.e. how long the
	251	* sample acquisition should run (in ms).
	252	*/
	253	SR_HWCAP_LIMIT_MSEC,
	254
	255	/**
	256	* The device supports setting a sample number limit, i.e. how many
	257	* samples should be acquired.
	258	*/
	259	SR_HWCAP_LIMIT_SAMPLES,
	260
	261	/**
	262	* The device supports continuous sampling, i.e. neither a time limit
	263	* nor a sample number limit has to be supplied, it will just acquire
	264	* samples continuously, until explicitly stopped by a certain command.
	265	*/
	266	SR_HWCAP_CONTINUOUS,
	267
	268	/* TODO: SR_HWCAP_JUST_SAMPLE or similar. */
	269	};
	270
	271	struct sr_hwcap_option {
	272	int capability;
	273	int type;
	274	char *description;
	275	char *shortname;
	276	};
	277
	278	struct sr_device_instance {
	279	int index;
	280	int status;
	281	int instance_type;
	282	char *vendor;
	283	char *model;
	284	char *version;
	285	void *priv;
	286	union {
	287	struct sr_usb_device_instance *usb;
	288	struct sr_serial_device_instance *serial;
	289	};
	290	};
	291
	292	/* sr_device_instance types */
	293	enum {
	294	SR_USB_INSTANCE,
	295	SR_SERIAL_INSTANCE,
	296	};
	297
	298	#ifdef HAVE_LIBUSB_1_0
	299	struct sr_usb_device_instance {
	300	uint8_t bus;
	301	uint8_t address;
	302	struct libusb_device_handle *devhdl;
	303	};
	304	#endif
	305
	306	struct sr_serial_device_instance {
	307	char *port;
	308	int fd;
	309	};
	310
	311	/* Device instance status */
	312	enum {
	313	SR_ST_NOT_FOUND,
	314	/* Found, but still booting */
	315	SR_ST_INITIALIZING,
	316	/* Live, but not in use */
	317	SR_ST_INACTIVE,
	318	/* Actively in use in a session */
	319	SR_ST_ACTIVE,
	320	};
	321
	322	/*
	323	* TODO: This sucks, you just kinda have to "know" the returned type.
	324	* TODO: Need a DI to return the number of trigger stages supported.
	325	*/
	326
	327	/* Device info IDs */
	328	enum {
	329	/* struct sr_device_instance for this specific device */
	330	SR_DI_INSTANCE,
	331	/* The number of probes connected to this device */
	332	SR_DI_NUM_PROBES,
	333	/* The probe names on this device */
	334	SR_DI_PROBE_NAMES,
	335	/* Samplerates supported by this device, (struct sr_samplerates) */
	336	SR_DI_SAMPLERATES,
	337	/* Types of trigger supported, out of "01crf" (char ) /
	338	SR_DI_TRIGGER_TYPES,
	339	/* The currently set samplerate in Hz (uint64_t) */
	340	SR_DI_CUR_SAMPLERATE,
	341	/* Supported pattern generator modes */
	342	SR_DI_PATTERNMODES,
	343	};
	344
	345	/*
	346	* A device supports either a range of samplerates with steps of a given
	347	* granularity, or is limited to a set of defined samplerates. Use either
	348	* step or list, but not both.
	349	*/
	350	struct sr_samplerates {
	351	uint64_t low;
	352	uint64_t high;
	353	uint64_t step;
	354	uint64_t *list;
	355	};
	356
	357	struct sr_device_plugin {
	358	/* Plugin-specific */
	359	char *name;
	360	char *longname;
	361	int api_version;
	362	int (init) (const char deviceinfo);
	363	void (*cleanup) (void);
	364
	365	/* Device-specific */
	366	int (*opendev) (int device_index);
	367	int (*closedev) (int device_index);
	368	void (get_device_info) (int device_index, int device_info_id);
	369	int (*get_status) (int device_index);
	370	int (get_capabilities) (void);
	371	int (set_configuration) (int device_index, int capability, void value);
	372	int (*start_acquisition) (int device_index, gpointer session_device_id);
	373	void (*stop_acquisition) (int device_index, gpointer session_device_id);
	374	};
	375
	376	struct sr_session {
	377	/* List of struct sr_device* */
	378	GSList *devices;
	379	/* List of struct analyzer* */
	380	GSList *analyzers;
	381	/* list of sr_receive_data_callback */
	382	GSList *datafeed_callbacks;
	383	GTimeVal starttime;
	384	gboolean running;
	385	};
	386
	387	#include "sigrok-proto.h"
	388
	389	#ifdef __cplusplus
	390	}
	391	#endif
	392
	393	#endif