libsigrok.h: Add SR_MQ_HARMONIC_RATIO.

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

diff --git a/include/libsigrok/libsigrok.h b/include/libsigrok/libsigrok.h
index 7d9260edabf714cc404b529fde981ac4c738afd1..e03fedc5573dbc3abb56f2f2619411e180044b82 100644 (file)
--- a/include/libsigrok/libsigrok.h
+++ b/include/libsigrok/libsigrok.h
@@ -231,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! */
 };
@@ -263,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). */
@@ -508,6 +510,11 @@ struct sr_analog_encoding {
        gboolean is_signed;
        gboolean is_float;
        gboolean is_bigendian;
+       /**
+        * 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;
@@ -522,6 +529,12 @@ struct sr_analog_meaning {
 };
 
 struct sr_analog_spec {
+       /**
+        * 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;
 };