/** Status/error codes returned by libsigrok functions. */
enum sr_error_code {
- SR_OK_CONTINUE = 1, /**< Keep going. */
SR_OK = 0, /**< No error. */
SR_ERR = -1, /**< Generic/unspecified error. */
SR_ERR_MALLOC = -2, /**< Malloc/calloc/realloc error. */
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_strerror() and sr_strerror_name() functions in error.c.
- */
+ /* Update sr_strerror()/sr_strerror_name() (error.c) upon changes! */
};
#define SR_MAX_CHANNELNAME_LEN 32
/* Handy little macros */
#define SR_HZ(n) (n)
-#define SR_KHZ(n) ((n) * (uint64_t)(1000ULL))
-#define SR_MHZ(n) ((n) * (uint64_t)(1000000ULL))
-#define SR_GHZ(n) ((n) * (uint64_t)(1000000000ULL))
+#define SR_KHZ(n) ((n) * UINT64_C(1000))
+#define SR_MHZ(n) ((n) * UINT64_C(1000000))
+#define SR_GHZ(n) ((n) * UINT64_C(1000000000))
-#define SR_HZ_TO_NS(n) ((uint64_t)(1000000000ULL) / (n))
+#define SR_HZ_TO_NS(n) (UINT64_C(1000000000) / (n))
/** libsigrok loglevels. */
enum sr_loglevel {
SR_T_UINT64_RANGE,
SR_T_DOUBLE_RANGE,
SR_T_INT32,
- SR_T_MQLIST,
+ SR_T_MQ,
+
+ /* Update sr_variant_type_get() (hwdriver.c) upon changes! */
};
/** Value for sr_datafeed_packet.type. */
SR_DF_TRIGGER,
/** Payload is struct sr_datafeed_logic. */
SR_DF_LOGIC,
- /** Payload is struct sr_datafeed_analog. */
- SR_DF_ANALOG,
/** 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,
SR_MQ_APPARENT_POWER,
/** Mass */
SR_MQ_MASS,
+ /** Harmonic ratio */
+ SR_MQ_HARMONIC_RATIO,
+
+ /* 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,
SR_UNIT_SIEMENS,
/**
* An absolute measurement of power, in decibels, referenced to
- * 1 milliwatt (dBu).
+ * 1 milliwatt (dBm).
*/
SR_UNIT_DECIBEL_MW,
/** Voltage in decibel, referenced to 1 volt (dBV). */
SR_UNIT_TOLA,
/** Pieces (number of items). */
SR_UNIT_PIECE,
+
+ /*
+ * Update unit_strings[] (analog.c) and fancyprint() (output/analog.c)
+ * upon changes!
+ */
};
-/** 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,
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)
+ * upon changes!
+ */
};
enum sr_trigger_matches {
struct sr_rational {
/** Numerator of the rational number. */
- uint64_t p;
+ int64_t p;
/** Denominator of the rational number. */
uint64_t q;
};
/** Analog datafeed payload for type SR_DF_ANALOG. */
struct sr_datafeed_analog {
- /** The channels for which data is included in this packet. */
- GSList *channels;
- /** Number of samples in data */
- int num_samples;
- /** Measured quantity (voltage, current, temperature, and so on).
- * Use SR_MQ_VOLTAGE, ... */
- int mq;
- /** Unit in which the MQ is measured. Use SR_UNIT_VOLT, ... */
- int unit;
- /** Bitmap with extra information about the MQ. Use SR_MQFLAG_AC, ... */
- uint64_t mqflags;
- /** The analog value(s). The data is interleaved according to
- * the channels list. */
- 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;
gboolean is_signed;
gboolean is_float;
gboolean is_bigendian;
- uint8_t digits;
+ /**
+ * Number of significant digits after the decimal point if positive,
+ * or number of non-significant digits before the decimal point if
+ * negative (refers to the value we actually read on the wire).
+ */
+ int8_t digits;
gboolean is_digits_decimal;
struct sr_rational scale;
struct sr_rational offset;
};
struct sr_analog_spec {
- uint8_t spec_digits;
+ /**
+ * Number of significant digits after the decimal point if positive,
+ * or number of non-significant digits before the decimal point if
+ * negative (refers to vendor specifications/datasheet or actual
+ * device display).
+ */
+ int8_t spec_digits;
};
/** 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. */
GSList *values;
};
+/** Resource type.
+ * @since 0.4.0
+ */
+enum sr_resource_type {
+ SR_RESOURCE_FIRMWARE = 1,
+};
+
+/** Resource descriptor.
+ * @since 0.4.0
+ */
+struct sr_resource {
+ /** Size of resource in bytes; set by resource open callback. */
+ uint64_t size;
+ /** File handle or equivalent; set by resource open callback. */
+ void *handle;
+ /** Resource type (SR_RESOURCE_FIRMWARE, ...) */
+ int type;
+};
+
/** Output module flags. */
enum sr_output_flag {
/** If set, this output module writes the output itself. */
/** 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 {
/** The device can act as a scale. */
SR_CONF_SCALE,
+ /** The device can act as a function generator. */
+ SR_CONF_SIGNAL_GENERATOR,
+
+ /** The device can measure power. */
+ SR_CONF_POWERMETER,
+
+ /* Update sr_key_info_config[] (hwdriver.c) upon changes! */
+
/*--- Driver scan options -------------------------------------------*/
/**
*/
SR_CONF_MODBUSADDR,
+ /* Update sr_key_info_config[] (hwdriver.c) upon changes! */
+
/*--- Device (or channel group) configuration -----------------------*/
/** The device supports setting its samplerate, in Hz. */
/** Coupling. */
SR_CONF_COUPLING,
- /** Trigger matches. */
+ /** Trigger matches. */
SR_CONF_TRIGGER_MATCH,
/** The device supports setting its sample interval, in ms. */
/** Number of horizontal divisions, as related to SR_CONF_TIMEBASE. */
SR_CONF_NUM_HDIV,
- /** Number of vertical divisions, as related to SR_CONF_VDIV. */
+ /** Number of vertical divisions, as related to SR_CONF_VDIV. */
SR_CONF_NUM_VDIV,
- /** Sound pressure level frequency weighting. */
+ /** Sound pressure level frequency weighting. */
SR_CONF_SPL_WEIGHT_FREQ,
- /** Sound pressure level time weighting. */
+ /** Sound pressure level time weighting. */
SR_CONF_SPL_WEIGHT_TIME,
- /** Sound pressure level measurement range. */
+ /** Sound pressure level measurement range. */
SR_CONF_SPL_MEASUREMENT_RANGE,
/** Max hold mode. */
/** Measured quantity. */
SR_CONF_MEASURED_QUANTITY,
- /** Measured secondary quantity. */
- SR_CONF_MEASURED_2ND_QUANTITY,
-
/** Equivalent circuit model. */
SR_CONF_EQUIV_CIRCUIT_MODEL,
/** Over-temperature protection (OTP) active. */
SR_CONF_OVER_TEMPERATURE_PROTECTION_ACTIVE,
- /*--- Special stuff -------------------------------------------------*/
+ /** Under-voltage condition. */
+ SR_CONF_UNDER_VOLTAGE_CONDITION,
+
+ /** Under-voltage condition active. */
+ SR_CONF_UNDER_VOLTAGE_CONDITION_ACTIVE,
- /** Scan options supported by the driver. */
- SR_CONF_SCAN_OPTIONS = 40000,
+ /** Trigger level. */
+ SR_CONF_TRIGGER_LEVEL,
- /** Device options for a particular device. */
- SR_CONF_DEVICE_OPTIONS,
+ /** Under-voltage condition threshold. */
+ SR_CONF_UNDER_VOLTAGE_CONDITION_THRESHOLD,
+
+ /* Update sr_key_info_config[] (hwdriver.c) upon changes! */
+
+ /*--- Special stuff -------------------------------------------------*/
/** Session filename. */
- SR_CONF_SESSIONFILE,
+ SR_CONF_SESSIONFILE = 40000,
/** The device supports specifying a capturefile to inject. */
SR_CONF_CAPTUREFILE,
/** 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 ----------------------------*/
/**
/** Self test mode. */
SR_CONF_TEST_MODE,
+
+ /* Update sr_key_info_config[] (hwdriver.c) upon changes! */
};
/**
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. */
/** 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(). */
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. */
projects / libsigrok.git / blobdiff