Change type of SR_CONF keys to uint32_t.

[libsigrok.git] / include / libsigrok / libsigrok.h

diff --git a/include/libsigrok/libsigrok.h b/include/libsigrok/libsigrok.h
index cadb88e881f1913723511fb14688ae7a9a224ac2..c029f1176f193a7c9aeb0af21f9dd5e2b573e20b 100644 (file)
--- a/include/libsigrok/libsigrok.h
+++ b/include/libsigrok/libsigrok.h
@@ -469,6 +469,8 @@ struct sr_channel {
        gboolean enabled;
        /** Name of channel. */
        char *name;
+       /** Private data for driver use. */
+       void *priv;
 };
 
 /** Structure for groups of channels that have common properties. */
@@ -484,7 +486,7 @@ struct sr_channel_group {
 /** Used for setting or getting value of a config item. */
 struct sr_config {
        /** Config key like SR_CONF_CONN, etc. */
-       int key;
+       uint32_t key;
        /** Key-specific data. */
        GVariant *data;
 };
@@ -492,7 +494,7 @@ struct sr_config {
 /** Information about a config key. */
 struct sr_config_info {
        /** Config key like SR_CONF_CONN, etc. */
-       int key;
+       uint32_t key;
        /** Data type like SR_T_STRING, etc. */
        int datatype;
        /** Id string, e.g. "serialcomm". */
@@ -661,29 +663,100 @@ enum sr_configkey {
        /** The device supports setting the number of analog channels. */
        SR_CONF_NUM_ANALOG_CHANNELS,
 
-       /** Output voltage. */
+       /**
+        * Output voltage.
+        * @arg type: double
+        * @arg get: get output voltage
+        */
        SR_CONF_OUTPUT_VOLTAGE,
 
-       /** Maximum output voltage. */
+       /**
+        * Maximum output voltage.
+        * @arg type: double
+        * @arg get: get maximum output voltage limit
+        * @arg set: change output voltage limit
+        */
        SR_CONF_OUTPUT_VOLTAGE_MAX,
 
-       /** Output current. */
+       /**
+        * Output current.
+        * @arg type: double
+        * @arg get: get output current
+        */
        SR_CONF_OUTPUT_CURRENT,
 
-       /** Maximum output current. */
+       /**
+        * Maximum output current.
+        * @arg type: double
+        * @arg get: get maximum output voltage limit
+        * @arg set: change output voltage limit
+        */
        SR_CONF_OUTPUT_CURRENT_MAX,
 
-       /** Enabling/disabling output. */
+       /**
+        * Enabling/disabling output.
+        * @arg type: boolean
+        * @arg get: @b true if currently enabled
+        * @arg set: enable/disable
+        */
        SR_CONF_OUTPUT_ENABLED,
 
-       /** Channel output configuration. */
-       SR_CONF_OUTPUT_CHANNEL,
+       /**
+        * Output channel configuration.
+        * @arg type: string
+        * @arg get: get current setting
+        * @arg set: change current setting
+        * @arg list: array of possible values
+        */
+       SR_CONF_OUTPUT_CHANNEL_CONFIG,
+
+       /**
+        * Over-voltage protection (OVP) feature
+        * @arg type: boolean
+        * @arg get: @b true if currently enabled
+        * @arg set: enable/disable
+        */
+       SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED,
+
+       /**
+        * Over-voltage protection (OVP) active
+        * @arg type: boolean
+        * @arg get: @b true if device has activated OVP, i.e. the output voltage
+        *      exceeds the over-voltage protection threshold.
+        */
+       SR_CONF_OVER_VOLTAGE_PROTECTION_ACTIVE,
 
-       /** Over-voltage protection (OVP) */
-       SR_CONF_OVER_VOLTAGE_PROTECTION,
+       /**
+        * Over-voltage protection (OVP) threshold
+        * @arg type: double (voltage)
+        * @arg get: get current threshold
+        * @arg set: set new threshold
+        */
+       SR_CONF_OVER_VOLTAGE_PROTECTION_THRESHOLD,
 
-       /** Over-current protection (OCP) */
-       SR_CONF_OVER_CURRENT_PROTECTION,
+       /**
+        * Over-current protection (OCP) feature
+        * @arg type: boolean
+        * @arg get: @b true if currently enabled
+        * @arg set: enable/disable
+        */
+       SR_CONF_OVER_CURRENT_PROTECTION_ENABLED,
+
+       /**
+        * Over-current protection (OCP) active
+        * @arg type: boolean
+        * @arg get: @b true if device has activated OCP, i.e. the output current
+        *      exceeds the over-current protection threshold.
+        */
+       SR_CONF_OVER_CURRENT_PROTECTION_ACTIVE,
+
+       /**
+        * Over-current protection (OCP) threshold
+        * @arg type: double (current)
+        * @arg get: get current threshold
+        * @arg set: set new threshold
+        */
+       SR_CONF_OVER_CURRENT_PROTECTION_THRESHOLD,
 
        /** Choice of clock edge for external clock ("r" or "f"). */
        SR_CONF_CLOCK_EDGE,
@@ -691,6 +764,16 @@ enum sr_configkey {
        /** Amplitude of a source without strictly-defined MQ. */
        SR_CONF_AMPLITUDE,
 
+       /**
+        * Output channel regulation
+        * get: "CV", "CC" or "UR", denoting constant voltage, constant current
+        *      or unregulated.
+        */
+       SR_CONF_OUTPUT_REGULATION,
+
+       /** Over-temperature protection (OTP) */
+       SR_CONF_OVER_TEMPERATURE_PROTECTION,
+
        /*--- Special stuff -------------------------------------------------*/
 
        /** Scan options supported by the driver. */
@@ -847,12 +930,12 @@ struct sr_dev_driver {
        /** Query value of a configuration key in driver or given device instance.
         *  @see sr_config_get().
         */
-       int (*config_get) (int id, GVariant **data,
+       int (*config_get) (uint32_t key, GVariant **data,
                        const struct sr_dev_inst *sdi,
                        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,
+       int (*config_set) (uint32_t key, GVariant *data,
                        const struct sr_dev_inst *sdi,
                        const struct sr_channel_group *cg);
        /** Channel status change.
@@ -865,7 +948,7 @@ struct sr_dev_driver {
        /** List all possible values for a configuration key in a device instance.
         *  @see sr_config_list().
         */
-       int (*config_list) (int info_id, GVariant **data,
+       int (*config_list) (uint32_t key, GVariant **data,
                        const struct sr_dev_inst *sdi,
                        const struct sr_channel_group *cg);