SR_ERR_TIMEOUT = -8, /**< A timeout occurred. */
SR_ERR_CHANNEL_GROUP = -9, /**< A channel group must be specified. */
SR_ERR_DATA =-10, /**< Data is invalid. */
+ SR_ERR_IO =-11, /**< Input/output error. */
/*
* Note: When adding entries here, don't forget to also update the
SR_DF_FRAME_BEGIN,
/** End of frame. No payload. */
SR_DF_FRAME_END,
+ /** Payload is struct sr_datafeed_analog2. */
+ SR_DF_ANALOG2,
};
/** Measured quantity, sr_datafeed_analog.mq. */
SR_MQ_WIND_SPEED,
/** Pressure */
SR_MQ_PRESSURE,
+ /** Parallel inductance (LCR meter model). */
+ SR_MQ_PARALLEL_INDUCTANCE,
+ /** Parallel capacitance (LCR meter model). */
+ SR_MQ_PARALLEL_CAPACITANCE,
+ /** Parallel resistance (LCR meter model). */
+ SR_MQ_PARALLEL_RESISTANCE,
+ /** Series inductance (LCR meter model). */
+ SR_MQ_SERIES_INDUCTANCE,
+ /** Series capacitance (LCR meter model). */
+ SR_MQ_SERIES_CAPACITANCE,
+ /** Series resistance (LCR meter model). */
+ SR_MQ_SERIES_RESISTANCE,
+ /** Dissipation factor. */
+ SR_MQ_DISSIPATION_FACTOR,
+ /** Quality factor. */
+ SR_MQ_QUALITY_FACTOR,
+ /** Phase angle. */
+ SR_MQ_PHASE_ANGLE,
+ /** Difference from reference value. */
+ SR_MQ_DIFFERENCE,
+ /** Count. */
+ SR_MQ_COUNT,
};
/** Unit of measured quantity, sr_datafeed_analog.unit. */
SR_UNIT_HECTOPASCAL,
/** Relative humidity assuming air temperature of 293 kelvin (%rF). */
SR_UNIT_HUMIDITY_293K,
+ /** Plane angle in 1/360th of a full circle. */
+ SR_UNIT_DEGREE,
+ /** Henry (inductance). */
+ SR_UNIT_HENRY,
};
/** Values for sr_datafeed_analog.flags. */
SR_MQFLAG_DURATION = 0x20000,
/** Device is in "avg" mode, averaging upon each new value. */
SR_MQFLAG_AVG = 0x40000,
+ /** Reference value shown. */
+ SR_MQFLAG_REFERENCE = 0x80000,
};
enum sr_trigger_matches {
*/
struct sr_session;
+struct sr_rational {
+ /** Numerator of the rational number. */
+ uint64_t p;
+ /** Denominator of the rational number. */
+ uint64_t q;
+};
+
/** Packet in a sigrok data feed. */
struct sr_datafeed_packet {
uint16_t type;
float *data;
};
+/** Analog datafeed payload for type SR_DF_ANALOG2. */
+struct sr_datafeed_analog2 {
+ void *data;
+ uint32_t num_samples;
+ struct sr_analog_encoding *encoding;
+ struct sr_analog_meaning *meaning;
+ struct sr_analog_spec *spec;
+};
+
+struct sr_analog_encoding {
+ uint8_t unitsize;
+ gboolean is_signed;
+ gboolean is_float;
+ gboolean is_bigendian;
+ uint8_t digits;
+ gboolean is_digits_decimal;
+ struct sr_rational scale;
+ struct sr_rational offset;
+};
+
+struct sr_analog_meaning {
+ enum sr_mq mq;
+ enum sr_unit unit;
+ enum sr_mqflag mqflags;
+ GSList *channels;
+};
+
+struct sr_analog_spec {
+ uint8_t spec_digits;
+};
+
/** Generic option struct used by various subsystems. */
struct sr_option {
/* Short name suitable for commandline usage, [a-z0-9-]. */
struct sr_input_module;
struct sr_output;
struct sr_output_module;
+struct sr_transform;
+struct sr_transform_module;
/** Constants for channel type. */
enum sr_channeltype {
gboolean enabled;
/** Name of channel. */
char *name;
+ /** Private data for driver use. */
+ void *priv;
};
/** Structure for groups of channels that have common properties. */
/** 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;
};
/** 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". */
char *description;
};
-/** Constants for device classes */
+#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 */
enum sr_configkey {
/*--- Device classes ------------------------------------------------*/
/** The device can measure energy consumption. */
SR_CONF_ENERGYMETER,
- /** The device can demodulate signals. */
+ /** The device can act as a signal demodulator. */
SR_CONF_DEMODULATOR,
- /** Programmable power supply. */
+ /** The device can act as a programmable power supply. */
SR_CONF_POWER_SUPPLY,
+ /** The device can act as an LCR meter. */
+ SR_CONF_LCRMETER,
+
/*--- Driver scan options -------------------------------------------*/
/**
*/
SR_CONF_SERIALCOMM,
- /*--- Device configuration ------------------------------------------*/
+ /*--- Device (or channel group) configuration -----------------------*/
/** The device supports setting its samplerate, in Hz. */
SR_CONF_SAMPLERATE = 30000,
/** The device supports setting a pattern (pattern generator mode). */
SR_CONF_PATTERN_MODE,
- /** The device supports Run Length Encoding. */
+ /** The device supports run-length encoding (RLE). */
SR_CONF_RLE,
/** The device supports setting trigger slope. */
SR_CONF_TRIGGER_SLOPE,
+ /** The device supports averaging. */
+ SR_CONF_AVERAGING,
+
+ /**
+ * The device supports setting number of samples to be
+ * averaged over.
+ */
+ SR_CONF_AVG_SAMPLES,
+
/** Trigger source. */
SR_CONF_TRIGGER_SOURCE,
/** The device supports setting its sample interval, in ms. */
SR_CONF_SAMPLE_INTERVAL,
- /** Number of timebases, as related to SR_CONF_TIMEBASE. */
- SR_CONF_NUM_TIMEBASE,
+ /** Number of horizontal divisions, as related to SR_CONF_TIMEBASE. */
+ SR_CONF_NUM_HDIV,
/** Number of vertical divisions, as related to SR_CONF_VDIV. */
SR_CONF_NUM_VDIV,
/** The device supports setting the number of analog channels. */
SR_CONF_NUM_ANALOG_CHANNELS,
- /** Output voltage. */
+ /**
+ * Output voltage.
+ * @arg type: double
+ * @arg get: get measured output voltage
+ */
SR_CONF_OUTPUT_VOLTAGE,
- /** Maximum output voltage. */
- SR_CONF_OUTPUT_VOLTAGE_MAX,
+ /**
+ * Maximum output voltage target.
+ * @arg type: double
+ * @arg get: get output voltage target
+ * @arg set: change output voltage target
+ */
+ SR_CONF_OUTPUT_VOLTAGE_TARGET,
- /** Output current. */
+ /**
+ * Output current.
+ * @arg type: double
+ * @arg get: get measured output current
+ */
SR_CONF_OUTPUT_CURRENT,
- /** Maximum output current. */
- SR_CONF_OUTPUT_CURRENT_MAX,
+ /**
+ * Output current limit.
+ * @arg type: double
+ * @arg get: get output current limit
+ * @arg set: change output current limit
+ */
+ SR_CONF_OUTPUT_CURRENT_LIMIT,
- /** 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,
/** 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,
+
+ /** Output frequency in Hz. */
+ SR_CONF_OUTPUT_FREQUENCY,
+
+ /** Measured quantity. */
+ SR_CONF_MEASURED_QUANTITY,
+
+ /** Measured secondary quantity. */
+ SR_CONF_MEASURED_2ND_QUANTITY,
+
+ /** Equivalent circuit model. */
+ SR_CONF_EQUIV_CIRCUIT_MODEL,
+
/*--- Special stuff -------------------------------------------------*/
/** Scan options supported by the driver. */
*/
SR_CONF_DATA_SOURCE,
- /*--- Acquisition modes ---------------------------------------------*/
+ /** The device supports setting a probe factor. */
+ SR_CONF_PROBE_FACTOR,
+
+ /*--- Acquisition modes, sample limiting ----------------------------*/
/**
* The device supports setting a sample time limit (how long
SR_CONF_TEST_MODE,
};
-/** Device instance data
+/**
+ * Opaque structure representing a libsigrok device instance.
+ *
+ * None of the fields of this structure are meant to be accessed directly.
*/
-struct sr_dev_inst {
- /** Device driver. */
- struct sr_dev_driver *driver;
- /** Index of device in driver. */
- int index;
- /** Device instance status. SR_ST_NOT_FOUND, etc. */
- int status;
- /** Device instance type. SR_INST_USB, etc. */
- int inst_type;
- /** Device vendor. */
- char *vendor;
- /** Device model. */
- char *model;
- /** Device version. */
- char *version;
- /** List of channels. */
- GSList *channels;
- /** List of sr_channel_group structs */
- GSList *channel_groups;
- /** Device instance connection data (used?) */
- void *conn;
- /** Device instance private data (used?) */
- void *priv;
- /** Session to which this device is currently assigned. */
- struct sr_session *session;
-};
+struct sr_dev_inst;
/** Types of device instance, struct sr_dev_inst.type */
enum sr_dev_inst_type {
SR_INST_SERIAL,
/** Device instance type for SCPI devices. */
SR_INST_SCPI,
+ /** Device-instance type for user-created "devices". */
+ SR_INST_USER,
};
/** Device instance status, struct sr_dev_inst.status */
/** Called when driver is loaded, e.g. program startup. */
int (*init) (struct sr_context *sr_ctx);
/** Called before driver is unloaded.
- * Driver must free all resouces held by it. */
+ * Driver must free all resources held by it. */
int (*cleanup) (void);
/** Scan for devices. Driver should do all initialisation required.
* Can be called several times, e.g. with different port options.
/** 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.
/** 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);
*/
struct sr_session;
+/** Serial port descriptor. */
+struct sr_serial_port {
+ /** The OS dependent name of the serial port. */
+ char *name;
+ /** An end user friendly description for the serial port. */
+ char *description;
+};
+
#include "proto.h"
#include "version.h"
projects / libsigrok.git / blobdiff