X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=sigrok.h;h=b3ca41aece36fec81508c22ecba6d1e2b7b925cb;hb=7583b99dbb2310ce2e34fd435c42634dec940ad6;hp=13641bfdf13252ca988ad9fd45b49045ae666d43;hpb=1352eeddd4d164b58f2233ae109432b73faab539;p=libsigrok.git

diff --git a/sigrok.h b/sigrok.h
index 13641bfd..b3ca41ae 100644
--- a/sigrok.h
+++ b/sigrok.h
@@ -68,11 +68,12 @@ 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_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);
 
@@ -83,10 +84,6 @@ enum {
 	SR_T_NULL,
 };
 
-enum {
-	SR_PROTO_RAW,
-};
-
 #if 0
 /* (Unused) protocol decoder stack entry */
 struct sr_protocol {
@@ -108,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;
 };
 
@@ -117,11 +116,22 @@ struct sr_datafeed_header {
 	int feed_version;
 	struct timeval starttime;
 	uint64_t samplerate;
-	int protocol_id;
 	int num_analog_probes;
 	int num_logic_probes;
 };
 
+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;
@@ -221,24 +231,69 @@ 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.? */
+
+	/*--- Device options ------------------------------------------------*/
+
+	/** The device supports setting/changing its samplerate. */
+	SR_HWCAP_SAMPLERATE,
 
-	/* 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 */
+	/* TODO: Better description? Rename to PROBE_AND_TRIGGER_CONFIG? */
+	/** The device supports setting a probe mask. */
+	SR_HWCAP_PROBECONFIG,
 
-	/* 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 a pre/post-trigger capture ratio. */
+	SR_HWCAP_CAPTURE_RATIO,
+
+	/* TODO? */
+	/** The device supports setting a pattern (pattern generator mode). */
+	SR_HWCAP_PATTERN_MODE,
+
+	/** The device supports Run Length Encoding. */
+	SR_HWCAP_RLE,
+
+	/*--- 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 {
@@ -335,7 +390,7 @@ struct sr_device_plugin {
 
 	/* Device-specific */
 	int (*opendev) (int device_index);
-	void (*closedev) (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);