VCD data parsing

[libsigrok.git] / libsigrok.h

diff --git a/libsigrok.h b/libsigrok.h
index 49d5aa8135722f897e759f9daa7c45d857b6e7ae..d7d31a33f131d9a46fa0e572945e5bd7e1c4824f 100644 (file)
--- a/libsigrok.h
+++ b/libsigrok.h
@@ -127,7 +127,7 @@ typedef int (*sr_receive_data_callback_t)(int fd, int revents, void *cb_data);
 
 /** Data types used by hardware drivers for dev_config_set(). */
 enum {
-       SR_T_UINT64,
+       SR_T_UINT64 = 10000,
        SR_T_CHAR,
        SR_T_BOOL,
        SR_T_FLOAT,
@@ -146,7 +146,7 @@ struct sr_rational {
 
 /** Value for sr_datafeed_packet.type. */
 enum {
-       SR_DF_HEADER,
+       SR_DF_HEADER = 10000,
        SR_DF_END,
        SR_DF_TRIGGER,
        SR_DF_LOGIC,
@@ -159,7 +159,7 @@ enum {
 
 /** Values for sr_datafeed_analog.mq. */
 enum {
-       SR_MQ_VOLTAGE,
+       SR_MQ_VOLTAGE = 10000,
        SR_MQ_CURRENT,
        SR_MQ_RESISTANCE,
        SR_MQ_CAPACITANCE,
@@ -173,11 +173,14 @@ enum {
        SR_MQ_POWER,
        /** Gain (a transistor's gain, or hFE, for example). */
        SR_MQ_GAIN,
+       /** Logarithmic representation of sound pressure relative to a
+        * reference value. */
+       SR_MQ_SOUND_PRESSURE_LEVEL,
 };
 
 /** Values for sr_datafeed_analog.unit. */
 enum {
-       SR_UNIT_VOLT,
+       SR_UNIT_VOLT = 10000,
        SR_UNIT_AMPERE,
        SR_UNIT_OHM,
        SR_UNIT_FARAD,
@@ -203,6 +206,8 @@ enum {
         * a unitless quantity, for example.
         */
        SR_UNIT_UNITLESS,
+       /** Sound pressure level relative so 20 micropascals. */
+       SR_UNIT_DECIBEL_SPL,
 };
 
 /** Values for sr_datafeed_analog.flags. */
@@ -225,6 +230,30 @@ enum {
        SR_MQFLAG_AUTORANGE = 0x80,
        /** Device is in relative mode. */
        SR_MQFLAG_RELATIVE = 0x100,
+       /** Sound pressure level is A-weighted in the frequency domain,
+        * according to IEC 61672:2003. */
+       SR_MQFLAG_SPL_FREQ_WEIGHT_A = 0x200,
+       /** Sound pressure level is C-weighted in the frequency domain,
+        * according to IEC 61672:2003. */
+       SR_MQFLAG_SPL_FREQ_WEIGHT_C = 0x400,
+       /** Sound pressure level is Z-weighted (i.e. not at all) in the
+        * frequency domain, according to IEC 61672:2003. */
+       SR_MQFLAG_SPL_FREQ_WEIGHT_Z = 0x800,
+       /** Sound pressure level is not weighted in the frequency domain,
+        * albeit without standards-defined low and high frequency limits. */
+       SR_MQFLAG_SPL_FREQ_WEIGHT_FLAT = 0x1000,
+       /** Sound pressure level measurement is S-weighted (1s) in the
+        * time domain. */
+       SR_MQFLAG_SPL_TIME_WEIGHT_S = 0x2000,
+       /** Sound pressure level measurement is F-weighted (125ms) in the
+        * time domain. */
+       SR_MQFLAG_SPL_TIME_WEIGHT_F = 0x4000,
+       /** Sound pressure level is time-averaged (LAT), also known as
+        * Equivalent Continuous A-weighted Sound Level (LEQ). */
+       SR_MQFLAG_SPL_LAT = 0x8000,
+       /** Sound pressure level represented as a percentage of measurements
+        * that were over a preset alarm level. */
+       SR_MQFLAG_SPL_PCT_OVER_ALARM = 0x10000,
 };
 
 struct sr_context;
@@ -328,7 +357,7 @@ struct sr_dev {
 };
 
 enum {
-       SR_PROBE_LOGIC,
+       SR_PROBE_LOGIC = 10000,
        SR_PROBE_ANALOG,
 };
 
@@ -347,14 +376,11 @@ struct sr_hwopt {
 
 /** Hardware driver options. */
 enum {
-       /** Used to terminate lists. */
-       SR_HWOPT_DUMMY = 0, /* Must be 0! */
-
        /**
         * Some drivers cannot detect the exact model they're talking to
         * (may be phased out).
         */
-       SR_HWOPT_MODEL,
+       SR_HWOPT_MODEL = 10000,
 
        /**
         * Specification on how to connect to a device.
@@ -383,13 +409,10 @@ enum {
 
 /** Hardware device capabilities. */
 enum {
-       /** Used to terminate lists. */
-       SR_HWCAP_DUMMY = 0, /* Must be 0! */
-
        /*--- Device classes ------------------------------------------------*/
 
        /** The device can act as logic analyzer. */
-       SR_HWCAP_LOGIC_ANALYZER,
+       SR_HWCAP_LOGIC_ANALYZER = 10000,
 
        /** The device can act as an oscilloscope. */
        SR_HWCAP_OSCILLOSCOPE,
@@ -400,11 +423,13 @@ enum {
        /** The device is a demo device. */
        SR_HWCAP_DEMO_DEV,
 
+       /** The device can act as a sound level meter. */
+       SR_HWCAP_SOUNDLEVELMETER,
 
        /*--- Device configuration ------------------------------------------*/
 
        /** The device supports setting/changing its samplerate. */
-       SR_HWCAP_SAMPLERATE,
+       SR_HWCAP_SAMPLERATE = 20000,
 
        /** The device supports setting a pre/post-trigger capture ratio. */
        SR_HWCAP_CAPTURE_RATIO,
@@ -440,11 +465,10 @@ enum {
        /** Coupling. */
        SR_HWCAP_COUPLING,
 
-
        /*--- Special stuff -------------------------------------------------*/
 
        /** Session filename. */
-       SR_HWCAP_SESSIONFILE,
+       SR_HWCAP_SESSIONFILE = 30000,
 
        /* TODO: Better description. */
        /** The device supports specifying a capturefile to inject. */
@@ -458,14 +482,13 @@ enum {
        /** The device supports setting the number of probes. */
        SR_HWCAP_CAPTURE_NUM_PROBES,
 
-
        /*--- Acquisition modes ---------------------------------------------*/
 
        /**
         * The device supports setting a sample time limit (how long
         * the sample acquisition should run, in ms).
         */
-       SR_HWCAP_LIMIT_MSEC,
+       SR_HWCAP_LIMIT_MSEC = 40000,
 
        /**
         * The device supports setting a sample number limit (how many
@@ -485,7 +508,6 @@ enum {
         * samples continuously, until explicitly stopped by a certain command.
         */
        SR_HWCAP_CONTINUOUS,
-
 };
 
 struct sr_hwcap_option {
@@ -510,7 +532,7 @@ struct sr_dev_inst {
 /** Types of device instances (sr_dev_inst). */
 enum {
        /** Device instance type for USB devices. */
-       SR_INST_USB,
+       SR_INST_USB = 10000,
        /** Device instance type for serial port devices. */
        SR_INST_SERIAL,
 };
@@ -518,13 +540,15 @@ enum {
 /** Device instance status. */
 enum {
        /** The device instance was not found. */
-       SR_ST_NOT_FOUND,
+       SR_ST_NOT_FOUND = 10000,
        /** The device instance was found, but is still booting. */
        SR_ST_INITIALIZING,
        /** The device instance is live, but not in use. */
        SR_ST_INACTIVE,
        /** The device instance is actively in use in a session. */
        SR_ST_ACTIVE,
+       /** The device is winding down its session. */
+       SR_ST_STOPPING,
 };
 
 /*
@@ -535,7 +559,7 @@ enum {
 /** Device info IDs. */
 enum {
        /** A list of options supported by the driver. */
-       SR_DI_HWOPTS,
+       SR_DI_HWOPTS = 10000,
        /** A list of capabilities supported by the device. */
        SR_DI_HWCAPS,
        /** The number of probes connected to this device. */
@@ -596,7 +620,7 @@ struct sr_dev_driver {
                        const void *value);
        int (*dev_acquisition_start) (const struct sr_dev_inst *sdi,
                        void *cb_data);
-       int (*dev_acquisition_stop) (const struct sr_dev_inst *sdi,
+       int (*dev_acquisition_stop) (struct sr_dev_inst *sdi,
                        void *cb_data);
 
        /* Dynamic */