X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=sigrok.h;h=c3629831d3662124f1708b399e1a18a276c5c410;hb=9a751023136a058dadf008a4ff983351947cc0df;hp=7b3d4a4967d9c38c92e552099c4752a5ea64c8ed;hpb=8bb416becf64c5095dc7f553a7899fbe9ebc28e0;p=libsigrok.git

diff --git a/sigrok.h b/sigrok.h
index 7b3d4a49..c3629831 100644
--- a/sigrok.h
+++ b/sigrok.h
@@ -53,7 +53,8 @@ extern "C" {
 #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 */
+#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
@@ -66,6 +67,14 @@ extern "C" {
 
 #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() */
@@ -75,10 +84,6 @@ enum {
 	SR_T_NULL,
 };
 
-enum {
-	SR_PROTO_RAW,
-};
-
 #if 0
 /* (Unused) protocol decoder stack entry */
 struct sr_protocol {
@@ -100,8 +105,10 @@ enum {
 
 struct sr_datafeed_packet {
 	uint16_t type;
-	uint64_t length;
-	uint16_t unitsize;
+	/* timeoffset since start, in picoseconds */
+	uint64_t timeoffset;
+	/* duration of data in this packet, in picoseconds */
+	uint64_t duration;
 	void *payload;
 };
 
@@ -109,12 +116,23 @@ 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 0
+struct sr_datafeed_logic {
+	uint64_t length;
+	uint16_t unitsize;
+	void *data;
+};
+
+struct sr_datafeed_pd {
+	char *protocol;
+	char *annotation;
+	unsigned char *data;
+};
+
+#if defined(HAVE_LA_ALSA)
 struct sr_analog_probe {
 	uint8_t att;
 	uint8_t res;	/* Needs to be a power of 2, FIXME */
@@ -134,7 +152,7 @@ struct sr_input {
 };
 
 struct sr_input_format {
-	char *extension;
+	char *id;
 	char *description;
 	int (*format_match) (const char *filename);
 	int (*init) (struct sr_input *in);
@@ -149,7 +167,7 @@ struct sr_output {
 };
 
 struct sr_output_format {
-	char *extension;
+	char *id;
 	char *description;
 	int df_type;
 	int (*init) (struct sr_output *o);
@@ -213,24 +231,66 @@ extern GSList *devices;
 /* Hardware plugin capabilities */
 enum {
 	SR_HWCAP_DUMMY,             /* Used to terminate lists */
-	/* device classes */
+
+	/*--- Device classes ------------------------------------------------*/
+
+	/** The device can act as logic analyzer. */
 	SR_HWCAP_LOGIC_ANALYZER,
 
-	/* device options */
-	SR_HWCAP_SAMPLERATE,        /* Change samplerate */
-	SR_HWCAP_PROBECONFIG,       /* Configure probe mask */
-	SR_HWCAP_CAPTURE_RATIO,     /* Set pre/post-trigger capture ratio */
-	SR_HWCAP_PATTERN_MODE,      /* Pattern generator mode */
+	/* TODO: SR_HWCAP_SCOPE, SW_HWCAP_PATTERN_GENERATOR, etc.? */
 
-	/* special stuff */
-	SR_HWCAP_CAPTUREFILE,       /* capturefile to inject */
-	SR_HWCAP_CAPTURE_UNITSIZE,  /* unitsize of capturefile data */
-	SR_HWCAP_CAPTURE_NUM_PROBES,/* set number of probes */
+	/*--- Device options ------------------------------------------------*/
 
-	/* acquisition modes */
-	SR_HWCAP_LIMIT_MSEC,        /* Set a time limit for sample acquisition */
-	SR_HWCAP_LIMIT_SAMPLES,     /* Set a limit on number of samples */
+	/** 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 {
@@ -326,8 +386,8 @@ struct sr_device_plugin {
 	void (*cleanup) (void);
 
 	/* Device-specific */
-	int (*open) (int device_index);
-	void (*close) (int device_index);
+	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);