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

#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_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,
	T_NULL,
};

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 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 analog_sample {
	uint8_t num_probes; /* Max hardware probes is 256 */
	struct analog_probe 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;
	/* list of receive_data_callback */
	GSList *datafeed_callbacks;
	GTimeVal starttime;
	gboolean running;
};

#include "sigrok-proto.h"

#ifdef __cplusplus
}
#endif

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