ikalogic-scanalogic2: Initial driver skeleton.

[libsigrok.git] / libsigrok.h

diff --git a/libsigrok.h b/libsigrok.h
index 351bc0a4aa6466dbf5e622d81634c5045bd798de..6cda5543223d17cfceb225c0dce40ded25899feb 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,15 @@ 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. */
+
+       /*
+        * 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 */
@@ -136,14 +142,6 @@ enum {
        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;
-};
-
 /** Value for sr_datafeed_packet.type. */
 enum {
        SR_DF_HEADER = 10000,
@@ -456,7 +454,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 +486,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 +496,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);
 };
 
@@ -636,6 +658,12 @@ enum {
        /** The device supports setting its sample interval, in ms. */
        SR_CONF_SAMPLE_INTERVAL,
 
+       /** Number of timebases, as related to SR_CONF_TIMEBASE.  */
+       SR_CONF_NUM_TIMEBASE,
+
+       /** Number of vertical divisions, as related to SR_CONF_VDIV.  */
+       SR_CONF_NUM_VDIV,
+
        /*--- Special stuff -------------------------------------------------*/
 
        /** Scan options supported by the driver. */
@@ -697,6 +725,7 @@ struct sr_dev_inst {
        char *model;
        char *version;
        GSList *probes;
+       void *conn;
        void *priv;
 };
 
@@ -722,18 +751,6 @@ enum {
        SR_ST_STOPPING,
 };
 
-/*
- * A device supports either a range of samplerates with steps of a given
- * granularity, or is limited to a set of defined samplerates. Use either
- * step or list, but not both.
- */
-struct sr_samplerates {
-       uint64_t low;
-       uint64_t high;
-       uint64_t step;
-       const uint64_t *list;
-};
-
 struct sr_dev_driver {
        /* Driver-specific */
        char *name;
@@ -766,7 +783,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;
 
@@ -781,6 +798,14 @@ struct sr_session {
        struct source *sources;
        GPollFD *pollfds;
        int source_timeout;
+
+       /*
+        * These are our synchronization primitives for stopping the session in
+        * an async fashion. We need to make sure the session is stopped from
+        * within the session thread itself.
+        */
+       GMutex stop_mutex;
+       gboolean abort_session;
 };
 
 #include "proto.h"