[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

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