Consistently use 'cg' for channel group variables.

[libsigrok.git] / libsigrok.h

diff --git a/libsigrok.h b/libsigrok.h
index 21468c875a2dac2828dc59a28e128d8ce0d63e7a..382f502b470a3a992c868a10b4730344133f864b 100644 (file)
--- a/libsigrok.h
+++ b/libsigrok.h
@@ -64,16 +64,16 @@ extern "C" {
 
 /** Status/error codes returned by libsigrok functions. */
 enum {
-       SR_OK             =  0, /**< No error. */
-       SR_ERR            = -1, /**< Generic/unspecified error. */
-       SR_ERR_MALLOC     = -2, /**< Malloc/calloc/realloc error. */
-       SR_ERR_ARG        = -3, /**< Function argument error. */
-       SR_ERR_BUG        = -4, /**< Errors hinting at internal bugs. */
-       SR_ERR_SAMPLERATE = -5, /**< Incorrect samplerate. */
-       SR_ERR_NA         = -6, /**< Not applicable. */
-       SR_ERR_DEV_CLOSED = -7, /**< Device is closed, but needs to be open. */
-       SR_ERR_TIMEOUT    = -8, /**< A timeout occurred. */
-       SR_ERR_PROBE_GROUP= -9, /**< A probe group must be specified. */
+       SR_OK                =  0, /**< No error. */
+       SR_ERR               = -1, /**< Generic/unspecified error. */
+       SR_ERR_MALLOC        = -2, /**< Malloc/calloc/realloc error. */
+       SR_ERR_ARG           = -3, /**< Function argument error. */
+       SR_ERR_BUG           = -4, /**< Errors hinting at internal bugs. */
+       SR_ERR_SAMPLERATE    = -5, /**< Incorrect samplerate. */
+       SR_ERR_NA            = -6, /**< Not applicable. */
+       SR_ERR_DEV_CLOSED    = -7, /**< Device is closed, but must be open. */
+       SR_ERR_TIMEOUT       = -8, /**< A timeout occurred. */
+       SR_ERR_CHANNEL_GROUP = -9, /**< A channel group must be specified. */
 
        /*
         * Note: When adding entries here, don't forget to also update the
@@ -619,12 +619,12 @@ struct sr_probe {
        char *trigger;
 };
 
-/** Structure for groups of probes that have common properties. */
-struct sr_probe_group {
-       /** Name of the probe group. */
+/** Structure for groups of channels that have common properties. */
+struct sr_channel_group {
+       /** Name of the channel group. */
        char *name;
-       /** List of sr_probe structs of the probes belonging to this group. */
-       GSList *probes;
+       /** List of sr_probe structs of the channels belonging to this group. */
+       GSList *channels;
        /** Private data for driver use. */
        void *priv;
 };
@@ -921,8 +921,8 @@ struct sr_dev_inst {
        char *version;
        /** List of probes. */
        GSList *probes;
-       /** List of sr_probe_group structs */
-       GSList *probe_groups;
+       /** List of sr_channel_group structs */
+       GSList *channel_groups;
        /** Device instance connection data (used?) */
        void *conn;
        /** Device instance private data (used?) */
@@ -986,12 +986,12 @@ struct sr_dev_driver {
         */
        int (*config_get) (int id, GVariant **data,
                        const struct sr_dev_inst *sdi,
-                       const struct sr_probe_group *probe_group);
+                       const struct sr_channel_group *cg);
        /** Set value of a configuration key in driver or a given device instance.
         *  @see sr_config_set(). */
        int (*config_set) (int id, GVariant *data,
                        const struct sr_dev_inst *sdi,
-                       const struct sr_probe_group *probe_group);
+                       const struct sr_channel_group *cg);
        /** Probe status change.
         *  @see sr_dev_probe_enable(), sr_dev_trigger_set(). */
        int (*config_probe_set) (const struct sr_dev_inst *sdi,
@@ -1004,7 +1004,7 @@ struct sr_dev_driver {
         */
        int (*config_list) (int info_id, GVariant **data,
                        const struct sr_dev_inst *sdi,
-                       const struct sr_probe_group *probe_group);
+                       const struct sr_channel_group *cg);
 
        /* Device-specific */
        /** Open device */