sr/cli/gtk: Remove analog left-overs from API.

[libsigrok.git] / sigrok.h.in

diff --git a/sigrok.h.in b/sigrok.h.in
index 2c57ee5c817d6c59945c573aa32fb2ea1f44c100..0a18f8d1231b09c3465e1bef8c70a11506af0912 100644 (file)
--- a/sigrok.h.in
+++ b/sigrok.h.in
@@ -1,7 +1,7 @@
 /*
  * This file is part of the sigrok project.
  *
- * Copyright (C) 2010 Bert Vermeulen <bert@biot.com>
+ * Copyright (C) 2012 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
@@ -25,9 +25,6 @@
 #include <stdint.h>
 #include <inttypes.h>
 #include <glib.h>
-#ifdef HAVE_LIBUSB_1_0
-#include <libusb.h>
-#endif
 
 #ifdef __cplusplus
 extern "C" {
@@ -54,7 +51,8 @@ extern "C" {
 #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_ERR_BUG           -4 /* Errors hinting at internal bugs */
+#define SR_ERR_SAMPLERATE    -5 /* Incorrect samplerate */
 
 #define SR_MAX_NUM_PROBES      64 /* Limited by uint64_t. */
 #define SR_MAX_PROBENAME_LEN   32
@@ -75,6 +73,25 @@ extern "C" {
 #define SR_LOG_DBG      4
 #define SR_LOG_SPEW     5
 
+/*
+ * Use SR_API to mark public API symbols, and SR_PRIV for private symbols.
+ *
+ * Variables and functions marked 'static' are private already and don't
+ * need SR_PRIV. However, functions which are not static (because they need
+ * to be used in other libsigrok-internal files) but are also not meant to
+ * be part of the public libsigrok API, must use SR_PRIV.
+ *
+ * This uses the 'visibility' feature of gcc (requires gcc >= 4.0).
+ *
+ * Details: http://gcc.gnu.org/wiki/Visibility
+ */
+
+/* Marks public libsigrok API symbols. */
+#define SR_API __attribute__((visibility("default")))
+
+/* Marks private, non-public libsigrok symbols (not part of the API). */
+#define SR_PRIV __attribute__((visibility("hidden")))
+
 typedef int (*sr_receive_data_callback) (int fd, int revents, void *user_data);
 
 /* Data types used by hardware plugins for set_configuration() */
@@ -90,16 +107,11 @@ enum {
        SR_DF_END,
        SR_DF_TRIGGER,
        SR_DF_LOGIC,
-       SR_DF_ANALOG,
        SR_DF_PD,
 };
 
 struct sr_datafeed_packet {
        uint16_t type;
-       /* timeoffset since start, in picoseconds */
-       uint64_t timeoffset;
-       /* duration of data in this packet, in picoseconds */
-       uint64_t duration;
        void *payload;
 };
 
@@ -107,7 +119,6 @@ struct sr_datafeed_header {
        int feed_version;
        struct timeval starttime;
        uint64_t samplerate;
-       int num_analog_probes;
        int num_logic_probes;
 };
 
@@ -117,19 +128,6 @@ struct sr_datafeed_logic {
        void *data;
 };
 
-#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;
@@ -188,7 +186,6 @@ struct sr_device {
 
 enum {
        SR_PROBE_TYPE_LOGIC,
-       SR_PROBE_TYPE_ANALOG,
 };
 
 struct sr_probe {
@@ -201,7 +198,7 @@ struct sr_probe {
 
 /* Hardware plugin capabilities */
 enum {
-       SR_HWCAP_DUMMY,             /* Used to terminate lists */
+       SR_HWCAP_DUMMY = 0, /* Used to terminate lists. Must be 0! */
 
        /*--- Device classes ------------------------------------------------*/
 
@@ -210,6 +207,11 @@ enum {
 
        /* TODO: SR_HWCAP_SCOPE, SW_HWCAP_PATTERN_GENERATOR, etc.? */
 
+       /*--- Device types --------------------------------------------------*/
+
+       /** The device is demo device. */
+       SR_HWCAP_DEMO_DEVICE,
+
        /*--- Device options ------------------------------------------------*/
 
        /** The device supports setting/changing its samplerate. */
@@ -282,10 +284,6 @@ struct sr_device_instance {
        char *model;
        char *version;
        void *priv;
-       union {
-               struct sr_usb_device_instance *usb;
-               struct sr_serial_device_instance *serial;
-       };
 };
 
 /* sr_device_instance types */
@@ -294,19 +292,6 @@ enum {
        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,
@@ -375,8 +360,6 @@ struct sr_device_plugin {
 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;