hantek-dso: proper protocol implementation of trigger/samplerate setting

[libsigrok.git] / sigrok.h.in

diff --git a/sigrok.h.in b/sigrok.h.in
index 358743851e2ac57125f03684d662368b6307ea23..2b57bcfceeccc7574847d997582983f8d88022d9 100644 (file)
--- a/sigrok.h.in
+++ b/sigrok.h.in
@@ -30,6 +30,38 @@
 extern "C" {
 #endif
 
+/*
+ * Package version macros (can be used for conditional compilation).
+ */
+
+/** The libsigrok package 'major' version number. */
+#define SR_PACKAGE_VERSION_MAJOR @SR_PACKAGE_VERSION_MAJOR@
+
+/** The libsigrok package 'minor' version number. */
+#define SR_PACKAGE_VERSION_MINOR @SR_PACKAGE_VERSION_MINOR@
+
+/** The libsigrok package 'micro' version number. */
+#define SR_PACKAGE_VERSION_MICRO @SR_PACKAGE_VERSION_MICRO@
+
+/** The libsigrok package version ("major.minor.micro") as string. */
+#define SR_PACKAGE_VERSION_STRING "@SR_PACKAGE_VERSION@"
+
+/*
+ * Library/libtool version macros (can be used for conditional compilation).
+ */
+
+/** The libsigrok libtool 'current' version number. */
+#define SR_LIB_VERSION_CURRENT @SR_LIB_VERSION_CURRENT@
+
+/** The libsigrok libtool 'revision' version number. */
+#define SR_LIB_VERSION_REVISION @SR_LIB_VERSION_REVISION@
+
+/** The libsigrok libtool 'age' version number. */
+#define SR_LIB_VERSION_AGE @SR_LIB_VERSION_AGE@
+
+/** The libsigrok libtool version ("current:revision:age") as string. */
+#define SR_LIB_VERSION_STRING "@SR_LIB_VERSION@"
+
 /*
  * Status/error codes returned by libsigrok functions.
  *
@@ -83,14 +115,25 @@ extern "C" {
  *
  * This uses the 'visibility' feature of gcc (requires gcc >= 4.0).
  *
+ * This feature is not available on MinGW/Windows, as it is a feature of
+ * ELF files and MinGW/Windows uses PE files.
+ *
  * Details: http://gcc.gnu.org/wiki/Visibility
  */
 
 /* Marks public libsigrok API symbols. */
+#ifndef _WIN32
 #define SR_API __attribute__((visibility("default")))
+#else
+#define SR_API
+#endif
 
 /* Marks private, non-public libsigrok symbols (not part of the API). */
+#ifndef _WIN32
 #define SR_PRIV __attribute__((visibility("hidden")))
+#else
+#define SR_PRIV
+#endif
 
 typedef int (*sr_receive_data_callback_t)(int fd, int revents, void *cb_data);
 
@@ -107,7 +150,11 @@ enum {
        SR_DF_END,
        SR_DF_TRIGGER,
        SR_DF_LOGIC,
-       SR_DF_PD,
+       SR_DF_META_LOGIC,
+       SR_DF_ANALOG,
+       SR_DF_META_ANALOG,
+       SR_DF_FRAME_BEGIN,
+       SR_DF_FRAME_END,
 };
 
 struct sr_datafeed_packet {
@@ -118,8 +165,11 @@ struct sr_datafeed_packet {
 struct sr_datafeed_header {
        int feed_version;
        struct timeval starttime;
+};
+
+struct sr_datafeed_meta_logic {
+       int num_probes;
        uint64_t samplerate;
-       int num_logic_probes;
 };
 
 struct sr_datafeed_logic {
@@ -128,6 +178,15 @@ struct sr_datafeed_logic {
        void *data;
 };
 
+struct sr_datafeed_meta_analog {
+       int num_probes;
+};
+
+struct sr_datafeed_analog {
+       int num_samples;
+       float *data;
+};
+
 struct sr_input {
        struct sr_input_format *format;
        char *param;
@@ -154,9 +213,10 @@ struct sr_output_format {
        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,
+       int (*data) (struct sr_output *o, const uint8_t *data_in,
+                    uint64_t length_in, uint8_t **data_out,
+                    uint64_t *length_out);
+       int (*event) (struct sr_output *o, int event_type, uint8_t **data_out,
                      uint64_t *length_out);
 };
 
@@ -205,7 +265,8 @@ enum {
        /** The device can act as logic analyzer. */
        SR_HWCAP_LOGIC_ANALYZER,
 
-       /* TODO: SR_HWCAP_SCOPE, SW_HWCAP_PATTERN_GENERATOR, etc.? */
+       /** The device can act as an oscilloscope. */
+       SR_HWCAP_OSCILLOSCOPE,
 
        /*--- Device types --------------------------------------------------*/
 
@@ -231,6 +292,9 @@ enum {
        /** The device supports Run Length Encoding. */
        SR_HWCAP_RLE,
 
+       /** The device supports setting trigger slope. */
+       SR_HWCAP_TRIGGERSLOPE,
+
        /*--- Special stuff -------------------------------------------------*/
 
        /* TODO: Better description. */
@@ -259,6 +323,12 @@ enum {
         */
        SR_HWCAP_LIMIT_SAMPLES,
 
+       /**
+        * The device supports setting a frame limit, i.e. how many
+        * frames should be acquired.
+        */
+       SR_HWCAP_LIMIT_FRAMES,
+
        /**
         * The device supports continuous sampling, i.e. neither a time limit
         * nor a sample number limit has to be supplied, it will just acquire
@@ -266,7 +336,6 @@ enum {
         */
        SR_HWCAP_CONTINUOUS,
 
-       /* TODO: SR_HWCAP_JUST_SAMPLE or similar. */
 };
 
 struct sr_hwcap_option {