[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>
#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_SAMPLERATE    -4 /* 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_NULL,
};

enum {
	SR_PROTO_RAW,
};

#if 0
/* (Unused) protocol decoder stack entry */
struct sr_protocol {
	char *name;
	int id;
	int stackindex;
};
#endif

/* 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;
	uint64_t length;
	uint16_t unitsize;
	void *payload;
};

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

#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);
};

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

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

/* TODO: Get rid of this global variable. */
extern GSList *devices;

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

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