X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=include%2Flibsigrok%2Flibsigrok.h;h=bb0b4fe7666d8340b030ad6b8c8cce37b02ab0fa;hb=43ff1110fb317fba796f942bbc73c37a95973b8b;hp=544bb08bfc8a36c74dd6f8ffc20fce1e48342d52;hpb=695dc859c15ba4190f5c1aa2e1a6e2dc6a6e5845;p=libsigrok.git diff --git a/include/libsigrok/libsigrok.h b/include/libsigrok/libsigrok.h index 544bb08b..bb0b4fe7 100644 --- a/include/libsigrok/libsigrok.h +++ b/include/libsigrok/libsigrok.h @@ -84,11 +84,11 @@ enum sr_error_code { /* 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 { @@ -162,8 +162,6 @@ enum sr_packettype { SR_DF_TRIGGER, /** Payload is struct sr_datafeed_logic. */ SR_DF_LOGIC, - /** DEPRECATED! Use SR_DF_ANALOG instead. */ - SR_DF_ANALOG_OLD, /** Beginning of frame. No payload. */ SR_DF_FRAME_BEGIN, /** End of frame. No payload. */ @@ -233,6 +231,8 @@ enum sr_mq { SR_MQ_APPARENT_POWER, /** Mass */ SR_MQ_MASS, + /** Harmonic ratio */ + SR_MQ_HARMONIC_RATIO, /* Update sr_key_info_mq[] (hwdriver.c) upon changes! */ }; @@ -265,7 +265,7 @@ enum sr_unit { 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). */ @@ -496,24 +496,6 @@ struct sr_datafeed_logic { void *data; }; -/** 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 */ - 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_ANALOG. */ struct sr_datafeed_analog { void *data; @@ -528,7 +510,12 @@ struct sr_analog_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; @@ -542,7 +529,13 @@ struct sr_analog_meaning { }; 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. */ @@ -657,11 +650,11 @@ struct sr_key_info { /** Configuration capabilities. */ enum sr_configcap { /** Value can be read. */ - SR_CONF_GET = (1 << 31), + SR_CONF_GET = (1UL << 31), /** Value can be written. */ - SR_CONF_SET = (1 << 30), + SR_CONF_SET = (1UL << 30), /** Possible values can be enumerated. */ - SR_CONF_LIST = (1 << 29), + SR_CONF_LIST = (1UL << 29), }; /** Configuration keys */ @@ -707,6 +700,12 @@ 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 -------------------------------------------*/ @@ -801,7 +800,7 @@ enum sr_configkey { /** Coupling. */ SR_CONF_COUPLING, - /** Trigger matches. */ + /** Trigger matches. */ SR_CONF_TRIGGER_MATCH, /** The device supports setting its sample interval, in ms. */ @@ -810,16 +809,16 @@ enum sr_configkey { /** 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. */ @@ -957,6 +956,8 @@ enum sr_configkey { * Channel regulation * get: "CV", "CC" or "UR", denoting constant voltage, constant current * or unregulated. + * "CC-" denotes a power supply in current sink mode (e.g. HP 66xxB). + * "" is used when there is no regulation, e.g. the output is disabled. */ SR_CONF_REGULATION, @@ -984,6 +985,21 @@ enum sr_configkey { /** Under-voltage condition active. */ SR_CONF_UNDER_VOLTAGE_CONDITION_ACTIVE, + /** Trigger level. */ + SR_CONF_TRIGGER_LEVEL, + + /** Under-voltage condition threshold. */ + SR_CONF_UNDER_VOLTAGE_CONDITION_THRESHOLD, + + /** + * Which external clock source to use if the device supports + * multiple external clock channels. + */ + SR_CONF_EXTERNAL_CLOCK_SOURCE, + + /** Offset of a source without strictly-defined MQ. */ + SR_CONF_OFFSET, + /* Update sr_key_info_config[] (hwdriver.c) upon changes! */ /*--- Special stuff -------------------------------------------------*/