Add new sr_dev_options() helper function.

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

diff --git a/include/libsigrok/libsigrok.h b/include/libsigrok/libsigrok.h
index 69d88d19d7b8505bbc660dbdb904b68e4b8daf19..de3136b94dbfb77fca4167cb52c4893e678a8f94 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,
@@ -546,11 +546,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,16 +645,23 @@ 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;
+};
+
+/** 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),
 };
 
-#define SR_CONF_GET  (1 << 31)
-#define SR_CONF_SET  (1 << 30)
-#define SR_CONF_LIST (1 << 29)
 #define SR_CONF_MASK 0x1fffffff
 
 /** Configuration keys */
@@ -1091,9 +1098,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. */