Doxygen: Initial groups and topic short descriptions.

[libsigrok.git] / libsigrok.h

diff --git a/libsigrok.h b/libsigrok.h
index bdc07230bd45d8f19a290fd05c670288318433e8..8a51f728dd615612d3ada75eac9d1a80d1c2f7fb 100644 (file)
--- a/libsigrok.h
+++ b/libsigrok.h
@@ -146,6 +146,12 @@ enum {
        SR_MQ_FREQUENCY,
        SR_MQ_DUTY_CYCLE,
        SR_MQ_CONTINUITY,
+       SR_MQ_PULSE_WIDTH,
+       SR_MQ_CONDUCTANCE,
+       /** For a measurement of electrical power, usually in W, or dBm */
+       SR_MQ_POWER,
+       /** Usually for measuring a transistor's gain, or h_FE*/
+       SR_MQ_GAIN,
 };
 
 /* sr_datafeed_analog.unit values */
@@ -160,6 +166,18 @@ enum {
        SR_UNIT_HERTZ,
        SR_UNIT_PERCENTAGE,
        SR_UNIT_BOOLEAN,
+       SR_UNIT_SECOND,
+       /** Unit of conductance, the inverse of resistance.  */
+       SR_UNIT_SIEMENS,
+       /** An absolute measurement of power, in decibels, referenced to
+        * 1 milliwatt (dBu). */
+       SR_UNIT_DECIBEL_MW,
+       /** Voltage in decibel, referenced to 1 volt (dBV). */
+       SR_UNIT_DECIBEL_VOLT,
+       /** Measurements that intrinsically do not have units attached, such
+        * as ratios, gains, etc. Specifically, a transistor's gain (hFE) is
+        * a unitless quantity. */
+       SR_UNIT_UNITLESS,
 };
 
 /** sr_datafeed_analog.flags values */
@@ -184,6 +202,8 @@ enum {
        SR_MQFLAG_RELATIVE = 0x100,
 };
 
+struct sr_context;
+
 struct sr_datafeed_packet {
        uint16_t type;
        void *payload;
@@ -303,13 +323,22 @@ struct sr_hwopt {
 enum {
        SR_HWOPT_DUMMY = 0, /* Used to terminate lists. Must be 0! */
 
-       /** Some drivers cannot detect the exact model they're talking to. */
+       /** Some drivers cannot detect the exact model they're talking to
+        * (may be phased out). */
        SR_HWOPT_MODEL,
 
-       /** Specification on how to connect to a device */
+       /** Specification on how to connect to a device. In combination
+        * with SR_HWOPT_SERIALCOMM, this is a serial port in the form
+        * which makes sense to the operating system (/dev/ttyS0).
+        * Otherwise this specifies a USB device, either in the form of
+        * <bus>.<address> (decimal, e.g. 1.65) or <vendorid>.<productid>
+        * (hexadecimal, e.g. 1d6b.0001). */
        SR_HWOPT_CONN,
 
-       /** Serial communication spec: <data bits><parity><stop bit> e.g. 8n1 */
+       /** Serial communication specification, in the form:
+        *   <speed>/<data bits><parity><stop bit> e.g.9600/ 8n1
+        * This is always an optional parameter, since a driver typically
+        * knows the speed at which the device wants to communicate */
        SR_HWOPT_SERIALCOMM,
 };