[libsigrok.git] / sigrok.h

/*
 * This file is part of the sigrok project.
 *
 * Copyright (C) 2010 Bert Vermeulen <bert@biot.com>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef SIGROK_SIGROK_H
#define SIGROK_SIGROK_H

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


/*
 * Status/error codes returned by libsigrok functions.
 *
 * All possible return codes of libsigrok functions must be listed here.
 * Functions should never return hardcoded numbers as status, but rather
 * use these #defines instead. All error codes are negative numbers.
 *
 * The error codes are globally unique in libsigrok, i.e. if one of the
 * libsigrok functions returns a "malloc error" it must be exactly the same
 * return value as used by all other functions to indicate "malloc error".
 * There must be no functions which indicate two different errors via the
 * same return code.
 *
 * Also, for compatibility reasons, no defined return codes are ever removed
 * or reused for different #defines later. You can only add new #defines and
 * return codes, but never remove or redefine existing ones.
 */
#define SIGROK_OK                 0 /* No error */
#define SIGROK_ERR               -1 /* Generic/unspecified error */
#define SIGROK_ERR_MALLOC        -2 /* Malloc/calloc/realloc error */
#define SIGROK_ERR_SAMPLERATE    -3 /* Incorrect samplerate */

/* limited by uint64_t */
#define MAX_NUM_PROBES 64
#define MAX_PROBENAME_LEN 32


/* Handy little macros */
#define KHZ(n) ((n) * 1000)
#define MHZ(n) ((n) * 1000000)
#define GHZ(n) ((n) * 1000000000)

#define HZ_TO_NS(n) (1000000000 / (n))

#ifndef ARRAY_SIZE
#define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0]))
#endif

#ifndef ARRAY_AND_SIZE
#define ARRAY_AND_SIZE(a) (a), ARRAY_SIZE(a)
#endif


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


/* Data types used by hardware plugins for set_configuration() */
enum {
	T_UINT64,
	T_CHAR,
};

enum {
	PROTO_RAW,
};

/* (Unused) protocol decoder stack entry */
struct protocol {
	char *name;
	int id;
	int stackindex;
};


/* datafeed_packet.type values */
enum {
	DF_HEADER,
	DF_END,
	DF_TRIGGER,
	DF_LOGIC,
	DF_ANALOG,
	DF_PD,
};

struct datafeed_packet {
	uint16_t type;
	uint64_t length;
	uint16_t unitsize;
	void *payload;
};

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


struct input {
	struct input_format *format;
	char *param;
	struct device *vdevice;
};

struct input_format {
	char *extension;
	char *description;
	int (*format_match) (const char *filename);
	int (*init) (struct input *in);
	int (*loadfile) (struct input *in, const char *filename);
};


struct output {
	struct output_format *format;
	struct device *device;
	char *param;
	void *internal;
};

struct output_format {
	char *extension;
	char *description;
	int df_type;
	int (*init) (struct output *o);
	int (*data) (struct output *o, char *data_in, uint64_t length_in,
		     char **data_out, uint64_t *length_out);
	int (*event) (struct output *o, int event_type, char **data_out,
		      uint64_t *length_out);
};


struct analyzer {
	char *name;
	char *filename;
	/*
	 * TODO: Parameters? If so, configured plugins need another struct.
	 * TODO: Input and output format?
	 */
};


/* Size of a chunk in units */
#define DATASTORE_CHUNKSIZE 512000

struct datastore {
	/* Size in bytes of the number of units stored in this datastore */
	int ds_unitsize;
	unsigned int num_units; /* TODO: uint64_t */
	GSList *chunklist;
};


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

enum {
	PROBE_TYPE_LOGIC,
	PROBE_TYPE_ANALOG,
};

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

extern GSList *devices;


/* Hardware plugin capabilities */
enum {
	HWCAP_DUMMY,             /* Used to terminate lists */
	/* device classes */
	HWCAP_LOGIC_ANALYZER,

	/* device options */
	HWCAP_SAMPLERATE,        /* Change samplerate */
	HWCAP_PROBECONFIG,       /* Configure probe mask */
	HWCAP_CAPTURE_RATIO,     /* Set pre/post-trigger capture ratio */
	HWCAP_PATTERN_MODE,      /* Pattern generator mode */

	/* acquisition modes */
	HWCAP_LIMIT_MSEC,        /* Set a time limit for sample acquisition */
	HWCAP_LIMIT_SAMPLES,     /* Set a limit on number of samples */
	HWCAP_CONTINUOUS,
};

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


struct sigrok_device_instance {
	int index;
	int status;
	int instance_type;
	char *vendor;
	char *model;
	char *version;
	void *priv;
	union {
		struct usb_device_instance *usb;
		struct serial_device_instance *serial;
	};
};

/* sigrok_device_instance types */
enum {
	USB_INSTANCE,
	SERIAL_INSTANCE,
};

struct usb_device_instance {
	uint8_t bus;
	uint8_t address;
	struct libusb_device_handle *devhdl;
};

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

/* Device instance status */
enum {
	ST_NOT_FOUND,
	/* Found, but still booting */
	ST_INITIALIZING,
	/* Live, but not in use */
	ST_INACTIVE,
	/* Actively in use in a session */
	ST_ACTIVE,
};

/*
 * TODO: This sucks, you just kinda have to "know" the returned type.
 * TODO: Need a DI to return the number of trigger stages supported.
 */

/* Device info IDs */
enum {
	/* struct sigrok_device_instance for this specific device */
	DI_INSTANCE,
	/* The number of probes connected to this device */
	DI_NUM_PROBES,
	/* Samplerates supported by this device, (struct samplerates) */
	DI_SAMPLERATES,
	/* Types of trigger supported, out of "01crf" (char *) */
	DI_TRIGGER_TYPES,
	/* The currently set samplerate in Hz (uint64_t) */
	DI_CUR_SAMPLERATE,
	/* Supported pattern generator modes */
	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 samplerates {
	uint64_t low;
	uint64_t high;
	uint64_t step;
	uint64_t *list;
};

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

	/* Device-specific */
	int (*open) (int device_index);
	void (*close) (int device_index);
	void *(*get_device_info) (int device_index, int device_info_id);
	int (*get_status) (int device_index);
	int *(*get_capabilities) (void);
	int (*set_configuration) (int device_index, int capability, void *value);
	int (*start_acquisition) (int device_index, gpointer session_device_id);
	void (*stop_acquisition) (int device_index, gpointer session_device_id);
};

struct gsource_fd {
	GSource source;
	GPollFD gpfd;
	/* Not really using this */
	GSource *timeout_source;
};

struct session {
	/* List of struct device* */
	GSList *devices;
	/* List of struct analyzer* */
	GSList *analyzers;
	/* Datafeed callbacks */
	GSList *datafeed_callbacks;
	GTimeVal starttime;
};

#include "sigrok-proto.h"
#endif
Commit	Line	Data
a1bb33af UH	1	/*
	2	* This file is part of the sigrok project.
	3	*
	4	* Copyright (C) 2010 Bert Vermeulen <bert@biot.com>
	5	*
	6	* This program is free software: you can redistribute it and/or modify
	7	* it under the terms of the GNU General Public License as published by
	8	* the Free Software Foundation, either version 3 of the License, or
	9	* (at your option) any later version.
	10	*
	11	* This program is distributed in the hope that it will be useful,
	12	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	13	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	14	* GNU General Public License for more details.
	15	*
	16	* You should have received a copy of the GNU General Public License
	17	* along with this program. If not, see <http://www.gnu.org/licenses/>.
	18	*/
	19
	20	#ifndef SIGROK_SIGROK_H
	21	#define SIGROK_SIGROK_H
	22
	23	#include <stdio.h>
	24	#include <sys/time.h>
	25	#include <stdint.h>
	26	#include <inttypes.h>
	27	#include <glib.h>
	28	#include <libusb.h>
	29
882e2075	30
e31b636d UH	31	/*
	32	* Status/error codes returned by libsigrok functions.
	33	*
	34	* All possible return codes of libsigrok functions must be listed here.
	35	* Functions should never return hardcoded numbers as status, but rather
	36	* use these #defines instead. All error codes are negative numbers.
	37	*
	38	* The error codes are globally unique in libsigrok, i.e. if one of the
2b3414a4 UH	39	* libsigrok functions returns a "malloc error" it must be exactly the same
2b3414a4 UH	40	* return value as used by all other functions to indicate "malloc error".
e31b636d UH	41	* There must be no functions which indicate two different errors via the
	42	* same return code.
	43	*
	44	* Also, for compatibility reasons, no defined return codes are ever removed
	45	* or reused for different #defines later. You can only add new #defines and
	46	* return codes, but never remove or redefine existing ones.
	47	*/
882e2075 BV	48	#define SIGROK_OK 0 /* No error */
	49	#define SIGROK_ERR -1 /* Generic/unspecified error */
	50	#define SIGROK_ERR_MALLOC -2 /* Malloc/calloc/realloc error */
	51	#define SIGROK_ERR_SAMPLERATE -3 /* Incorrect samplerate */
a1bb33af	52
2a3f9541 BV	53	/* limited by uint64_t */
	54	#define MAX_NUM_PROBES 64
	55	#define MAX_PROBENAME_LEN 32
	56
	57
a1bb33af	58	/* Handy little macros */
d86dc674 UH	59	#define KHZ(n) ((n) * 1000)
	60	#define MHZ(n) ((n) * 1000000)
	61	#define GHZ(n) ((n) * 1000000000)
a1bb33af	62
3677f3ec DR	63	#define HZ_TO_NS(n) (1000000000 / (n))
3677f3ec DR	64
fdd20b52 UH	65	#ifndef ARRAY_SIZE
	66	#define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0]))
	67	#endif
	68
dfa4b731 DR	69	#ifndef ARRAY_AND_SIZE
	70	#define ARRAY_AND_SIZE(a) (a), ARRAY_SIZE(a)
	71	#endif
	72
882e2075 BV	73
	74	typedef int (receive_data_callback) (int fd, int revents, void user_data);
	75
	76
	77	/* Data types used by hardware plugins for set_configuration() */
a1bb33af UH	78	enum {
	79	T_UINT64,
	80	T_CHAR,
	81	};
	82
	83	enum {
	84	PROTO_RAW,
	85	};
	86
	87	/* (Unused) protocol decoder stack entry */
	88	struct protocol {
	89	char *name;
	90	int id;
	91	int stackindex;
	92	};
	93
882e2075	94
a1bb33af UH	95
	96	/* datafeed_packet.type values */
	97	enum {
	98	DF_HEADER,
	99	DF_END,
	100	DF_TRIGGER,
4c046c6b	101	DF_LOGIC,
1437e893	102	DF_ANALOG,
4c046c6b	103	DF_PD,
a1bb33af UH	104	};
	105
	106	struct datafeed_packet {
	107	uint16_t type;
e1aac231	108	uint64_t length;
4c046c6b	109	uint16_t unitsize;
a1bb33af UH	110	void *payload;
	111	};
	112
	113	struct datafeed_header {
	114	int feed_version;
	115	struct timeval starttime;
4c100f32	116	uint64_t samplerate;
a1bb33af	117	int protocol_id;
921e753f DR	118	int num_analog_probes;
921e753f DR	119	int num_logic_probes;
a1bb33af UH	120	};
a1bb33af UH	121
882e2075 BV	122
882e2075 BV	123
34e4813f BV	124	struct input {
34e4813f BV	125	struct input_format *format;
13a12913 BV	126	char *param;
13a12913 BV	127	struct device *vdevice;
34e4813f BV	128	};
	129
	130	struct input_format {
	131	char *extension;
	132	char *description;
757b8c62	133	int (format_match) (const char filename);
13a12913 BV	134	int (init) (struct input in);
13a12913 BV	135	int (loadfile) (struct input in, const char *filename);
34e4813f BV	136	};
34e4813f BV	137
34e4813f BV	138
34e4813f BV	139
a1bb33af UH	140	struct output {
	141	struct output_format *format;
	142	struct device *device;
	143	char *param;
	144	void *internal;
	145	};
	146
	147	struct output_format {
	148	char *extension;
	149	char *description;
f0411b1d	150	int df_type;
5a8fda15	151	int (init) (struct output o);
a1bb33af UH	152	int (data) (struct output o, char *data_in, uint64_t length_in,
	153	char *data_out, uint64_t length_out);
	154	int (event) (struct output o, int event_type, char **data_out,
	155	uint64_t *length_out);
	156	};
	157
a1bb33af UH	158
	159	struct analyzer {
	160	char *name;
	161	char *filename;
	162	/*
	163	* TODO: Parameters? If so, configured plugins need another struct.
	164	* TODO: Input and output format?
	165	*/
	166	};
	167
a1bb33af UH	168
	169	/* Size of a chunk in units */
	170	#define DATASTORE_CHUNKSIZE 512000
	171
	172	struct datastore {
	173	/* Size in bytes of the number of units stored in this datastore */
	174	int ds_unitsize;
33247d6a	175	unsigned int num_units; /* TODO: uint64_t */
a1bb33af UH	176	GSList *chunklist;
	177	};
	178
a1bb33af UH	179
	180	/*
	181	* This represents a generic device connected to the system.
	182	* For device-specific information, ask the plugin. The plugin_index refers
	183	* to the device index within that plugin; it may be handling more than one
	184	* device. All relevant plugin calls take a device_index parameter for this.
	185	*/
	186	struct device {
	187	/* Which plugin handles this device */
	188	struct device_plugin *plugin;
	189	/* A plugin may handle multiple devices of the same type */
	190	int plugin_index;
	191	/* List of struct probe* */
	192	GSList *probes;
	193	/* Data acquired by this device, if any */
	194	struct datastore *datastore;
	195	};
	196
921e753f DR	197	enum {
	198	PROBE_TYPE_LOGIC,
	199	PROBE_TYPE_ANALOG,
	200	};
	201
a1bb33af UH	202	struct probe {
a1bb33af UH	203	int index;
921e753f	204	int type;
a1bb33af UH	205	gboolean enabled;
	206	char *name;
	207	char *trigger;
	208	};
	209
	210	extern GSList *devices;
	211
a1bb33af UH	212
	213	/* Hardware plugin capabilities */
	214	enum {
74b9b438	215	HWCAP_DUMMY, /* Used to terminate lists */
925dbf9f	216	/* device classes */
a1bb33af	217	HWCAP_LOGIC_ANALYZER,
925dbf9f BV	218
925dbf9f BV	219	/* device options */
74b9b438 BV	220	HWCAP_SAMPLERATE, /* Change samplerate */
	221	HWCAP_PROBECONFIG, /* Configure probe mask */
	222	HWCAP_CAPTURE_RATIO, /* Set pre/post-trigger capture ratio */
925dbf9f BV	223	HWCAP_PATTERN_MODE, /* Pattern generator mode */
	224
	225	/* acquisition modes */
74b9b438 BV	226	HWCAP_LIMIT_MSEC, /* Set a time limit for sample acquisition */
	227	HWCAP_LIMIT_SAMPLES, /* Set a limit on number of samples */
	228	HWCAP_CONTINUOUS,
a1bb33af UH	229	};
	230
	231	struct hwcap_option {
	232	int capability;
	233	int type;
	234	char *description;
	235	char *shortname;
	236	};
	237
882e2075	238
a1bb33af UH	239	struct sigrok_device_instance {
	240	int index;
	241	int status;
	242	int instance_type;
	243	char *vendor;
	244	char *model;
	245	char *version;
8d672550	246	void *priv;
a1bb33af UH	247	union {
	248	struct usb_device_instance *usb;
	249	struct serial_device_instance *serial;
	250	};
	251	};
	252
	253	/* sigrok_device_instance types */
	254	enum {
	255	USB_INSTANCE,
	256	SERIAL_INSTANCE,
	257	};
	258
	259	struct usb_device_instance {
	260	uint8_t bus;
	261	uint8_t address;
	262	struct libusb_device_handle *devhdl;
	263	};
	264
	265	struct serial_device_instance {
	266	char *port;
	267	int fd;
	268	};
	269
	270	/* Device instance status */
	271	enum {
	272	ST_NOT_FOUND,
	273	/* Found, but still booting */
	274	ST_INITIALIZING,
	275	/* Live, but not in use */
	276	ST_INACTIVE,
	277	/* Actively in use in a session */
	278	ST_ACTIVE,
	279	};
	280
	281	/*
	282	* TODO: This sucks, you just kinda have to "know" the returned type.
	283	* TODO: Need a DI to return the number of trigger stages supported.
	284	*/
	285
	286	/* Device info IDs */
	287	enum {
	288	/* struct sigrok_device_instance for this specific device */
	289	DI_INSTANCE,
	290	/* The number of probes connected to this device */
	291	DI_NUM_PROBES,
4c100f32	292	/* Samplerates supported by this device, (struct samplerates) */
a1bb33af UH	293	DI_SAMPLERATES,
	294	/* Types of trigger supported, out of "01crf" (char ) /
	295	DI_TRIGGER_TYPES,
4c100f32 UH	296	/* The currently set samplerate in Hz (uint64_t) */
4c100f32 UH	297	DI_CUR_SAMPLERATE,
925dbf9f BV	298	/* Supported pattern generator modes */
925dbf9f BV	299	DI_PATTERNMODES,
a1bb33af UH	300	};
a1bb33af UH	301
1b452b85 UH	302	/*
	303	* A device supports either a range of samplerates with steps of a given
	304	* granularity, or is limited to a set of defined samplerates. Use either
a1bb33af UH	305	* step or list, but not both.
	306	*/
	307	struct samplerates {
	308	uint64_t low;
	309	uint64_t high;
	310	uint64_t step;
	311	uint64_t *list;
	312	};
	313
	314	struct device_plugin {
1b452b85	315	/* Plugin-specific */
a1bb33af UH	316	char *name;
	317	int api_version;
	318	int (init) (char deviceinfo);
	319	void (*cleanup) (void);
	320
1b452b85	321	/* Device-specific */
a1bb33af UH	322	int (*open) (int device_index);
	323	void (*close) (int device_index);
	324	void (get_device_info) (int device_index, int device_info_id);
	325	int (*get_status) (int device_index);
	326	int (get_capabilities) (void);
	327	int (set_configuration) (int device_index, int capability, void value);
	328	int (*start_acquisition) (int device_index, gpointer session_device_id);
	329	void (*stop_acquisition) (int device_index, gpointer session_device_id);
	330	};
	331
	332	struct gsource_fd {
	333	GSource source;
	334	GPollFD gpfd;
	335	/* Not really using this */
	336	GSource *timeout_source;
	337	};
	338
a1bb33af UH	339	struct session {
	340	/* List of struct device* */
	341	GSList *devices;
	342	/* List of struct analyzer* */
	343	GSList *analyzers;
1b452b85	344	/* Datafeed callbacks */
a1bb33af UH	345	GSList *datafeed_callbacks;
	346	GTimeVal starttime;
	347	};
	348
882e2075	349	#include "sigrok-proto.h"
a1bb33af	350	#endif