X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=include%2Flibsigrok%2Flibsigrok.h;h=a384f611d53cf687a1c52cac90b44d13df1dcf44;hb=7d7fd93c947dcaa94f3d90bfb6b0bf3ce01d774d;hp=6c67f570906da0f24680a504619f4e84651de8d7;hpb=bee246665b05a59f91ff7d51040cbaee614ab0c7;p=libsigrok.git diff --git a/include/libsigrok/libsigrok.h b/include/libsigrok/libsigrok.h index 6c67f570..a384f611 100644 --- a/include/libsigrok/libsigrok.h +++ b/include/libsigrok/libsigrok.h @@ -162,19 +162,19 @@ enum sr_packettype { SR_DF_TRIGGER, /** Payload is struct sr_datafeed_logic. */ SR_DF_LOGIC, - /** Payload is struct sr_datafeed_analog. */ - SR_DF_ANALOG, + /** DEPRECATED! Use SR_DF_ANALOG instead. */ + SR_DF_ANALOG_OLD, /** Beginning of frame. No payload. */ SR_DF_FRAME_BEGIN, /** End of frame. No payload. */ SR_DF_FRAME_END, - /** Payload is struct sr_datafeed_analog2. */ - SR_DF_ANALOG2, + /** Payload is struct sr_datafeed_analog. */ + SR_DF_ANALOG, /* Update datafeed_dump() (session.c) upon changes! */ }; -/** Measured quantity, sr_datafeed_analog.mq. */ +/** Measured quantity, sr_analog_meaning.mq. */ enum sr_mq { SR_MQ_VOLTAGE = 10000, SR_MQ_CURRENT, @@ -237,7 +237,7 @@ enum sr_mq { /* Update sr_key_info_mq[] (hwdriver.c) upon changes! */ }; -/** Unit of measured quantity, sr_datafeed_analog.unit. */ +/** Unit of measured quantity, sr_analog_meaning.unit. */ enum sr_unit { /** Volt */ SR_UNIT_VOLT = 10000, @@ -331,7 +331,7 @@ enum sr_unit { */ }; -/** Values for sr_datafeed_analog.flags. */ +/** Values for sr_analog_meaning.mqflags. */ enum sr_mqflag { /** Voltage measurement is alternating current (AC). */ SR_MQFLAG_AC = 0x01, @@ -494,8 +494,8 @@ struct sr_datafeed_logic { void *data; }; -/** Analog datafeed payload for type SR_DF_ANALOG. */ -struct sr_datafeed_analog { +/** Analog datafeed payload for type SR_DF_ANALOG_OLD. */ +struct sr_datafeed_analog_old { /** The channels for which data is included in this packet. */ GSList *channels; /** Number of samples in data */ @@ -512,8 +512,8 @@ struct sr_datafeed_analog { float *data; }; -/** Analog datafeed payload for type SR_DF_ANALOG2. */ -struct sr_datafeed_analog2 { +/** Analog datafeed payload for type SR_DF_ANALOG. */ +struct sr_datafeed_analog { void *data; uint32_t num_samples; struct sr_analog_encoding *encoding; @@ -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,17 +645,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 { @@ -975,14 +980,8 @@ enum sr_configkey { /*--- Special stuff -------------------------------------------------*/ - /** Scan options supported by the driver. */ - SR_CONF_SCAN_OPTIONS = 40000, - - /** Device options for a particular device. */ - SR_CONF_DEVICE_OPTIONS, - /** Session filename. */ - SR_CONF_SESSIONFILE, + SR_CONF_SESSIONFILE = 40000, /** The device supports specifying a capturefile to inject. */ SR_CONF_CAPTUREFILE, @@ -1091,9 +1090,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. */ @@ -1157,14 +1156,6 @@ struct sr_dev_driver { void *context; }; -/** - * @struct sr_session - * - * Opaque data structure representing a libsigrok session. None of the fields - * of this structure are meant to be accessed directly. - */ -struct sr_session; - /** Serial port descriptor. */ struct sr_serial_port { /** The OS dependent name of the serial port. */