atsha204a: Shorten a few more code chunks, add helpers.

[libsigrokdecode.git] / libsigrokdecode.h

diff --git a/libsigrokdecode.h b/libsigrokdecode.h
index a4d28d40b943db1a73da1e3e50a89643994a583f..a26bce9a402ba720ac5e8c1141bccdd131b50966 100644 (file)
--- a/libsigrokdecode.h
+++ b/libsigrokdecode.h
@@ -15,8 +15,7 @@
  * GNU General Public License for more details.
  *
  * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
+ * along with this program; if not, see <http://www.gnu.org/licenses/>.
  */
 
 #ifndef LIBSIGROKDECODE_LIBSIGROKDECODE_H
@@ -72,6 +71,7 @@ enum srd_error_code {
        SRD_ERR_BUG          = -4, /**< Errors hinting at internal bugs */
        SRD_ERR_PYTHON       = -5, /**< Python C API error */
        SRD_ERR_DECODERS_DIR = -6, /**< Protocol decoder path invalid */
+       SRD_ERR_TERM_REQ     = -7, /**< Termination requested */
 
        /*
         * Note: When adding entries here, don't forget to also update the
@@ -155,6 +155,12 @@ struct srd_decoder {
         */
        char *license;
 
+       /** List of possible decoder input IDs. */
+       GSList *inputs;
+
+       /** List of possible decoder output IDs. */
+       GSList *outputs;
+
        /** List of channels required by this decoder. */
        GSList *channels;
 
@@ -189,6 +195,12 @@ struct srd_decoder {
        void *py_dec;
 };
 
+enum srd_initial_pin {
+       SRD_INITIAL_PIN_LOW,
+       SRD_INITIAL_PIN_HIGH,
+       SRD_INITIAL_PIN_SAME_AS_SAMPLE0,
+};
+
 /**
  * Structure which contains information about one protocol decoder channel.
  * For example, I2C has two channels, SDA and SCL.
@@ -236,10 +248,10 @@ struct srd_decoder_inst {
        GArray *match_array;
 
        /** Absolute start sample number. */
-       uint64_t start_samplenum;
+       uint64_t abs_start_samplenum;
 
        /** Absolute end sample number. */
-       uint64_t end_samplenum;
+       uint64_t abs_end_samplenum;
 
        /** Pointer to the buffer/chunk of input samples. */
        const uint8_t *inbuf;
@@ -248,7 +260,7 @@ struct srd_decoder_inst {
        uint64_t inbuflen;
 
        /** Absolute current samplenumber. */
-       uint64_t cur_samplenum;
+       uint64_t abs_cur_samplenum;
 
        /** Array of "old" (previous sample) pin values. */
        GArray *old_pins_array;
@@ -262,6 +274,9 @@ struct srd_decoder_inst {
        /** Indicates whether the worker thread has handled all samples. */
        gboolean handled_all_samples;
 
+       /** Requests termination of wait() and decode(). */
+       gboolean want_wait_terminate;
+
        GCond got_new_samples_cond;
        GCond handled_all_samples_cond;
        GMutex data_mutex;
@@ -306,6 +321,7 @@ struct srd_pd_callback {
 /* srd.c */
 SRD_API int srd_init(const char *path);
 SRD_API int srd_exit(void);
+SRD_API GSList *srd_searchpaths_get(void);
 
 /* session.c */
 SRD_API int srd_session_new(struct srd_session **sess);
@@ -313,8 +329,9 @@ SRD_API int srd_session_start(struct srd_session *sess);
 SRD_API int srd_session_metadata_set(struct srd_session *sess, int key,
                GVariant *data);
 SRD_API int srd_session_send(struct srd_session *sess,
-               uint64_t start_samplenum, uint64_t end_samplenum,
+               uint64_t abs_start_samplenum, uint64_t abs_end_samplenum,
                const uint8_t *inbuf, uint64_t inbuflen, uint64_t unitsize);
+SRD_API int srd_session_terminate_reset(struct srd_session *sess);
 SRD_API int srd_session_destroy(struct srd_session *sess);
 SRD_API int srd_pd_output_callback_add(struct srd_session *sess,
                int output_type, srd_pd_output_callback cb, void *cb_data);
@@ -339,6 +356,8 @@ SRD_API int srd_inst_stack(struct srd_session *sess,
                struct srd_decoder_inst *di_from, struct srd_decoder_inst *di_to);
 SRD_API struct srd_decoder_inst *srd_inst_find_by_id(struct srd_session *sess,
                const char *inst_id);
+SRD_API int srd_inst_initial_pins_set_all(struct srd_decoder_inst *di,
+               GArray *initial_pins);
 
 /* log.c */
 typedef int (*srd_log_callback)(void *cb_data, int loglevel,
@@ -361,6 +380,8 @@ SRD_API int srd_lib_version_current_get(void);
 SRD_API int srd_lib_version_revision_get(void);
 SRD_API int srd_lib_version_age_get(void);
 SRD_API const char *srd_lib_version_string_get(void);
+SRD_API GSList *srd_buildinfo_libs_get(void);
+SRD_API char *srd_buildinfo_host_get(void);
 
 #include "version.h"