Rename a few more API calls with 'probe' in their name.

[libsigrok.git] / libsigrok.h

diff --git a/libsigrok.h b/libsigrok.h
index 48bddab475c6a04d5d4a598f84939fdf402c4759..8df2f396ab15ed6f90614672cc7f74602378a663 100644 (file)
--- a/libsigrok.h
+++ b/libsigrok.h
@@ -81,7 +81,7 @@ enum {
         */
 };
 
-#define SR_MAX_PROBENAME_LEN 32
+#define SR_MAX_CHANNELNAME_LEN 32
 
 /* Handy little macros */
 #define SR_HZ(n)  (n)
@@ -340,8 +340,8 @@ struct sr_datafeed_logic {
 
 /** Analog datafeed payload for type SR_DF_ANALOG. */
 struct sr_datafeed_analog {
-       /** The probes for which data is included in this packet. */
-       GSList *probes;
+       /** The channels for which data is included in this packet. */
+       GSList *channels;
        /** Number of samples in data */
        int num_samples;
        /** Measured quantity (voltage, current, temperature, and so on).
@@ -352,7 +352,7 @@ struct sr_datafeed_analog {
        /** Bitmap with extra information about the MQ. Use SR_MQFLAG_AC, ... */
        uint64_t mqflags;
        /** The analog value(s). The data is interleaved according to
-        * the probes list. */
+        * the channels list. */
        float *data;
 };
 
@@ -438,7 +438,7 @@ struct sr_output {
 
        /**
         * The device for which this output module is creating output. This
-        * can be used by the module to find out probe names and numbers.
+        * can be used by the module to find out channel names and numbers.
         */
        struct sr_dev_inst *sdi;
 
@@ -600,20 +600,20 @@ struct sr_output_format {
 /** Constants for probe type. */
 enum {
        /** Probe type is logic probe. */
-    SR_PROBE_LOGIC = 10000,
+    SR_CHANNEL_LOGIC = 10000,
        /** Probe type is analog probe. */
-    SR_PROBE_ANALOG,
+    SR_CHANNEL_ANALOG,
 };
 
-/** Information on single probe. */
-struct sr_probe {
-       /** Number of probes, starting at 0. */
+/** Information on single channel. */
+struct sr_channel {
+       /** Number of channels, starting at 0. */
        int index;
-       /** Probe type (SR_PROBE_LOGIC, ...) */
+       /** Channel type (SR_CHANNEL_LOGIC, ...) */
        int type;
-       /** Is this probe enabled? */
+       /** Is this channel enabled? */
        gboolean enabled;
-       /** Name of probe. */
+       /** Name of channel. */
        char *name;
        /** Trigger string, format like used by sigrok-cli */
        char *trigger;
@@ -623,7 +623,7 @@ struct sr_probe {
 struct sr_channel_group {
        /** Name of the channel group. */
        char *name;
-       /** List of sr_probe structs of the channels belonging to this group. */
+       /** List of sr_channel structs of the channels belonging to this group. */
        GSList *channels;
        /** Private data for driver use. */
        void *priv;
@@ -804,10 +804,10 @@ enum {
        SR_CONF_CENTER_FREQUENCY,
 
        /** The device supports setting the number of logic probes. */
-       SR_CONF_NUM_LOGIC_PROBES,
+       SR_CONF_NUM_LOGIC_CHANNELS,
 
        /** The device supports setting the number of analog probes. */
-       SR_CONF_NUM_ANALOG_PROBES,
+       SR_CONF_NUM_ANALOG_CHANNELS,
 
        /** Output voltage. */
        SR_CONF_OUTPUT_VOLTAGE,
@@ -919,8 +919,8 @@ struct sr_dev_inst {
        char *model;
        /** Device version. */
        char *version;
-       /** List of probes. */
-       GSList *probes;
+       /** List of channels. */
+       GSList *channels;
        /** List of sr_channel_group structs */
        GSList *channel_groups;
        /** Device instance connection data (used?) */
@@ -986,16 +986,16 @@ struct sr_dev_driver {
         */
        int (*config_get) (int id, GVariant **data,
                        const struct sr_dev_inst *sdi,
-                       const struct sr_channel_group *channel_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_channel_group *channel_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,
-                       struct sr_probe *probe, unsigned int changes);
+        *  @see sr_dev_channel_enable(), sr_dev_trigger_set(). */
+       int (*config_channel_set) (const struct sr_dev_inst *sdi,
+                       struct sr_channel *ch, unsigned int changes);
        /** Apply configuration settings to the device hardware.
         *  @see sr_config_commit().*/
        int (*config_commit) (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_channel_group *channel_group);
+                       const struct sr_channel_group *cg);
 
        /* Device-specific */
        /** Open device */