]> sigrok.org Git - libsigrok.git/commitdiff
Make 'struct sr_dev_inst' opaque.
authorUwe Hermann <redacted>
Tue, 11 Nov 2014 11:24:08 +0000 (12:24 +0100)
committerUwe Hermann <redacted>
Tue, 11 Nov 2014 11:24:08 +0000 (12:24 +0100)
include/libsigrok/libsigrok.h
src/libsigrok-internal.h

index 746ee3743141a450dcb4c984d1658713fd936710..d626bac66bf08c484d566d38e1cb99722ddccedc 100644 (file)
@@ -892,36 +892,12 @@ enum sr_configkey {
        SR_CONF_TEST_MODE,
 };
 
-/** Device instance data
+/**
+ * Opaque structure representing a libsigrok device instance.
+ *
+ * None of the fields of this structure are meant to be accessed directly.
  */
-struct sr_dev_inst {
-       /** Device driver. */
-       struct sr_dev_driver *driver;
-       /** Device instance status. SR_ST_NOT_FOUND, etc. */
-       int status;
-       /** Device instance type. SR_INST_USB, etc. */
-       int inst_type;
-       /** Device vendor. */
-       char *vendor;
-       /** Device model. */
-       char *model;
-       /** Device version. */
-       char *version;
-       /** Serial number. */
-       char *serial_num;
-       /** Connection string to uniquely identify devices. */
-       char *connection_id;
-       /** List of channels. */
-       GSList *channels;
-       /** List of sr_channel_group structs */
-       GSList *channel_groups;
-       /** Device instance connection data (used?) */
-       void *conn;
-       /** Device instance private data (used?) */
-       void *priv;
-       /** Session to which this device is currently assigned. */
-       struct sr_session *session;
-};
+struct sr_dev_inst;
 
 /** Types of device instance, struct sr_dev_inst.type */
 enum sr_dev_inst_type {
index 432a4c2107080a9ad8de7ecceb774e8784ee3922..9e393f422fedd19e988fafb7fad0e726f255ae9d 100644 (file)
@@ -490,6 +490,36 @@ enum {
 SR_PRIV struct sr_channel *sr_channel_new(int index, int type,
                gboolean enabled, const char *name);
 
+/** Device instance data */
+struct sr_dev_inst {
+       /** Device driver. */
+       struct sr_dev_driver *driver;
+       /** Device instance status. SR_ST_NOT_FOUND, etc. */
+       int status;
+       /** Device instance type. SR_INST_USB, etc. */
+       int inst_type;
+       /** Device vendor. */
+       char *vendor;
+       /** Device model. */
+       char *model;
+       /** Device version. */
+       char *version;
+       /** Serial number. */
+       char *serial_num;
+       /** Connection string to uniquely identify devices. */
+       char *connection_id;
+       /** List of channels. */
+       GSList *channels;
+       /** List of sr_channel_group structs */
+       GSList *channel_groups;
+       /** Device instance connection data (used?) */
+       void *conn;
+       /** Device instance private data (used?) */
+       void *priv;
+       /** Session to which this device is currently assigned. */
+       struct sr_session *session;
+};
+
 /* Generic device instances */
 SR_PRIV struct sr_dev_inst *sr_dev_inst_new(int status,
                const char *vendor, const char *model, const char *version);