Add SR_CONF keys for max/min hold modes

[libsigrok.git] / libsigrok.h

diff --git a/libsigrok.h b/libsigrok.h
index 73af2d9db3ec7baed572cc63ca495fc287100881..dbd0c594f0097461218ca713aa82fd8f6ef9becf 100644 (file)
--- a/libsigrok.h
+++ b/libsigrok.h
@@ -72,6 +72,7 @@ enum {
        SR_ERR_SAMPLERATE = -5, /**< Incorrect samplerate. */
        SR_ERR_NA         = -6, /**< Not applicable. */
        SR_ERR_DEV_CLOSED = -7, /**< Device is closed, but needs to be open. */
+       SR_ERR_TIMEOUT    = -8, /**< A timeout occurred. */
 
        /*
         * Note: When adding entries here, don't forget to also update the
@@ -454,7 +455,7 @@ struct sr_output_format {
         * <code>data_out</code> parameter, so the caller knows not to try
         * and g_free() it.
         *
-        * Note: This API call is obsolete, use recv() instead.
+        * Note: This API call is obsolete, use receive() instead.
         *
         * @param o Pointer to the respective 'struct sr_output'.
         * @param data_in Pointer to the input data buffer.
@@ -486,7 +487,7 @@ struct sr_output_format {
         * it stored in the <code>data_out</code> and <code>length_out</code>
         * parameters, or NULL if no output was generated.
         *
-        * Note: This API call is obsolete, use recv() instead.
+        * Note: This API call is obsolete, use receive() instead.
         *
         * @param o Pointer to the respective 'struct sr_output'.
         * @param event_type Type of event that occured.
@@ -496,11 +497,35 @@ struct sr_output_format {
         * @return SR_OK upon success, a negative error code otherwise.
         */
        int (*event) (struct sr_output *o, int event_type, uint8_t **data_out,
-                     uint64_t *length_out);
+                       uint64_t *length_out);
 
-       GString *(*recv) (struct sr_output *o, const struct sr_dev_inst *sdi,
-                       const struct sr_datafeed_packet *packet);
+       /**
+        * This function is passed a copy of every packed in the data feed.
+        * Any output generated by the output module in response to the
+        * packet should be returned in a newly allocated GString
+        * <code>out</code>, which will be freed by the caller.
+        *
+        * Packets not of interest to the output module can just be ignored,
+        * and the <code>out</code> parameter set to NULL.
+        *
+        * @param o Pointer to the respective 'struct sr_output'.
+        * @param sdi The device instance that generated the packet.
+        * @param packet The complete packet.
+        * @param out A pointer where a GString * should be stored if
+        * the module generates output, or NULL if not.
+        *
+        * @return SR_OK upon success, a negative error code otherwise.
+        */
+       int (*receive) (struct sr_output *o, const struct sr_dev_inst *sdi,
+                       const struct sr_datafeed_packet *packet, GString **out);
 
+       /**
+        * This function is called after the caller is finished using
+        * the output module, and can be used to free any internal
+        * resources the module may keep.
+        *
+        * @return SR_OK upon success, a negative error code otherwise.
+        */
        int (*cleanup) (struct sr_output *o);
 };
 
@@ -640,6 +665,18 @@ enum {
        /** Number of vertical divisions, as related to SR_CONF_VDIV.  */
        SR_CONF_NUM_VDIV,
 
+       /** Sound pressure level frequency weighting.  */
+       SR_CONF_SPL_WEIGHT_FREQ,
+
+       /** Sound pressure level time weighting.  */
+       SR_CONF_SPL_WEIGHT_TIME,
+
+       /** Max hold mode. */
+       SR_CONF_HOLD_MAX,
+
+       /** Min hold mode. */
+       SR_CONF_HOLD_MIN,
+
        /*--- Special stuff -------------------------------------------------*/
 
        /** Scan options supported by the driver. */