strutil: add method to get an sr_rational from a string

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

diff --git a/include/libsigrok/libsigrok.h b/include/libsigrok/libsigrok.h
index 69d88d19d7b8505bbc660dbdb904b68e4b8daf19..544bb08bfc8a36c74dd6f8ffc20fce1e48342d52 100644 (file)
--- a/include/libsigrok/libsigrok.h
+++ b/include/libsigrok/libsigrok.h
@@ -162,7 +162,7 @@ enum sr_packettype {
        SR_DF_TRIGGER,
        /** Payload is struct sr_datafeed_logic. */
        SR_DF_LOGIC,
-       /** Payload is struct sr_datafeed_analog_old. */
+       /** DEPRECATED! Use SR_DF_ANALOG instead. */
        SR_DF_ANALOG_OLD,
        /** Beginning of frame. No payload. */
        SR_DF_FRAME_BEGIN,
@@ -383,6 +383,8 @@ enum sr_mqflag {
        SR_MQFLAG_REFERENCE = 0x80000,
        /** Unstable value (hasn't settled yet). */
        SR_MQFLAG_UNSTABLE = 0x100000,
+       /** Measurement is four wire (e.g. Kelvin connection). */
+       SR_MQFLAG_FOUR_WIRE = 0x200000,
 
        /*
         * Update mq_strings[] (analog.c) and fancyprint() (output/analog.c)
@@ -546,11 +548,11 @@ struct sr_analog_spec {
 /** Generic option struct used by various subsystems. */
 struct sr_option {
        /* Short name suitable for commandline usage, [a-z0-9-]. */
-       char *id;
+       const char *id;
        /* Short name suitable for GUI usage, can contain UTF-8. */
-       char *name;
+       const char *name;
        /* Description of the option, in a sentence. */
-       char *desc;
+       const char *desc;
        /* Default value for this option. */
        GVariant *def;
        /* List of possible values, if this is an option with few values. */
@@ -645,17 +647,22 @@ struct sr_key_info {
        /** Data type like SR_T_STRING, etc if applicable. */
        int datatype;
        /** Short, lowercase ID string, e.g. "serialcomm", "voltage". */
-       char *id;
+       const char *id;
        /** Full capitalized name, e.g. "Serial communication". */
-       char *name;
+       const char *name;
        /** Verbose description (unused currently). */
-       char *description;
+       const char *description;
 };
 
-#define SR_CONF_GET  (1 << 31)
-#define SR_CONF_SET  (1 << 30)
-#define SR_CONF_LIST (1 << 29)
-#define SR_CONF_MASK 0x1fffffff
+/** Configuration capabilities. */
+enum sr_configcap {
+       /** Value can be read. */
+       SR_CONF_GET = (1 << 31),
+       /** Value can be written. */
+       SR_CONF_SET = (1 << 30),
+       /** Possible values can be enumerated. */
+       SR_CONF_LIST = (1 << 29),
+};
 
 /** Configuration keys */
 enum sr_configkey {
@@ -971,18 +978,18 @@ enum sr_configkey {
        /** Over-temperature protection (OTP) active. */
        SR_CONF_OVER_TEMPERATURE_PROTECTION_ACTIVE,
 
-       /* Update sr_key_info_config[] (hwdriver.c) upon changes! */
+       /** Under-voltage condition. */
+       SR_CONF_UNDER_VOLTAGE_CONDITION,
 
-       /*--- Special stuff -------------------------------------------------*/
+       /** Under-voltage condition active. */
+       SR_CONF_UNDER_VOLTAGE_CONDITION_ACTIVE,
 
-       /** Scan options supported by the driver. */
-       SR_CONF_SCAN_OPTIONS = 40000,
+       /* Update sr_key_info_config[] (hwdriver.c) upon changes! */
 
-       /** Device options for a particular device. */
-       SR_CONF_DEVICE_OPTIONS,
+       /*--- Special stuff -------------------------------------------------*/
 
        /** Session filename. */
-       SR_CONF_SESSIONFILE,
+       SR_CONF_SESSIONFILE = 40000,
 
        /** The device supports specifying a capturefile to inject. */
        SR_CONF_CAPTUREFILE,
@@ -1010,6 +1017,9 @@ enum sr_configkey {
        /** The device supports setting a probe factor. */
        SR_CONF_PROBE_FACTOR,
 
+       /** Number of powerline cycles for ADC integration time. */
+       SR_CONF_ADC_POWERLINE_CYCLES,
+
        /* Update sr_key_info_config[] (hwdriver.c) upon changes! */
 
        /*--- Acquisition modes, sample limiting ----------------------------*/
@@ -1091,9 +1101,9 @@ enum sr_dev_inst_status {
 struct sr_dev_driver {
        /* Driver-specific */
        /** Driver name. Lowercase a-z, 0-9 and dashes (-) only. */
-       char *name;
+       const char *name;
        /** Long name. Verbose driver name shown to user. */
-       char *longname;
+       const char *longname;
        /** API version (currently 1).  */
        int api_version;
        /** Called when driver is loaded, e.g. program startup. */
@@ -1146,11 +1156,9 @@ struct sr_dev_driver {
        /** Close device */
        int (*dev_close) (struct sr_dev_inst *sdi);
        /** Begin data acquisition on the specified device. */
-       int (*dev_acquisition_start) (const struct sr_dev_inst *sdi,
-                       void *cb_data);
+       int (*dev_acquisition_start) (const struct sr_dev_inst *sdi);
        /** End data acquisition on the specified device. */
-       int (*dev_acquisition_stop) (struct sr_dev_inst *sdi,
-                       void *cb_data);
+       int (*dev_acquisition_stop) (struct sr_dev_inst *sdi);
 
        /* Dynamic */
        /** Device driver context, considered private. Initialized by init(). */