Drop nexus-osciprime skeleton for now.

[libsigrok.git] / libsigrok.h

diff --git a/libsigrok.h b/libsigrok.h
index 4212c59c4f046d77522b81a12b9a949568664123..2f7047a426119ef1a4a909792c8244e138e46cce 100644 (file)
--- a/libsigrok.h
+++ b/libsigrok.h
@@ -1,5 +1,5 @@
 /*
- * This file is part of the sigrok project.
+ * This file is part of the libsigrok project.
  *
  * Copyright (C) 2013 Bert Vermeulen <bert@biot.com>
  *
@@ -70,9 +70,16 @@ enum {
        SR_ERR_ARG        = -3, /**< Function argument error. */
        SR_ERR_BUG        = -4, /**< Errors hinting at internal bugs. */
        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
+        * sr_strerror() and sr_strerror_name() functions in error.c.
+        */
 };
 
-#define SR_MAX_NUM_PROBES    64 /* Limited by uint64_t. */
 #define SR_MAX_PROBENAME_LEN 32
 
 /* Handy little macros */
@@ -134,14 +141,7 @@ enum {
        SR_T_RATIONAL_PERIOD,
        SR_T_RATIONAL_VOLT,
        SR_T_KEYVALUE,
-};
-
-/** Rational number data type, containing numerator and denominator values. */
-struct sr_rational {
-       /** Numerator of the rational number. */
-       uint64_t p;
-       /** Denominator of the rational number. */
-       uint64_t q;
+       SR_T_UINT64_RANGE,
 };
 
 /** Value for sr_datafeed_packet.type. */
@@ -456,7 +456,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.
@@ -488,7 +488,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.
@@ -498,11 +498,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);
 };
 
@@ -642,6 +666,21 @@ 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,
+
+       /** Sound pressure level measurement range.  */
+       SR_CONF_SPL_MEASUREMENT_RANGE,
+
+       /** Max hold mode. */
+       SR_CONF_HOLD_MAX,
+
+       /** Min hold mode. */
+       SR_CONF_HOLD_MIN,
+
        /*--- Special stuff -------------------------------------------------*/
 
        /** Scan options supported by the driver. */
@@ -662,6 +701,21 @@ enum {
        /** The device supports setting the number of probes. */
        SR_CONF_CAPTURE_NUM_PROBES,
 
+       /** Power off the device. */
+       SR_CONF_POWER_OFF,
+
+       /** Data source for acquisition. If not present, acquisition from
+        * the device is always "live", i.e. acquisition starts when the
+        * frontend asks and the results are sent out as soon as possible.
+        *
+        * If present, it indicates that either the device has no live
+        * acquisition capability (for example a pure data logger), or
+        * there is a choice. sr_config_list() returns those choices.
+        *
+        * In any case if a device has live acquisition capabilities, it
+        * is always the default. */
+       SR_CONF_DATA_SOURCE,
+
        /*--- Acquisition modes ---------------------------------------------*/
 
        /**
@@ -703,6 +757,7 @@ struct sr_dev_inst {
        char *model;
        char *version;
        GSList *probes;
+       void *conn;
        void *priv;
 };
 
@@ -760,7 +815,7 @@ struct sr_dev_driver {
 struct sr_session {
        /** List of struct sr_dev pointers. */
        GSList *devs;
-       /** List of sr_receive_data_callback_t items. */
+       /** List of struct datafeed_callback pointers. */
        GSList *datafeed_callbacks;
        GTimeVal starttime;