pca9571: Add initial OUTPUT_LOGIC support.

[libsigrokdecode.git] / libsigrokdecode.h

diff --git a/libsigrokdecode.h b/libsigrokdecode.h
index df1cb5c481192d95fbfe5fb9e491ee3e81965291..44402673479cd1af19d4599e7e9e5f3be5be7d52 100644 (file)
--- a/libsigrokdecode.h
+++ b/libsigrokdecode.h
@@ -71,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
@@ -120,14 +121,15 @@ enum srd_loglevel {
 
 /*
  * When adding an output type, don't forget to...
- *   - expose it to PDs in controller.c:PyInit_sigrokdecode()
- *   - add a check in module_sigrokdecode.c:Decoder_put()
- *   - add a debug string in type_decoder.c:OUTPUT_TYPES
+ *   - expose it to PDs in module_sigrokdecode.c:PyInit_sigrokdecode()
+ *   - add a check in type_decoder.c:Decoder_put()
+ *   - add a debug string in type_decoder.c:output_type_name()
  */
 enum srd_output_type {
        SRD_OUTPUT_ANN,
        SRD_OUTPUT_PYTHON,
        SRD_OUTPUT_BINARY,
+       SRD_OUTPUT_LOGIC,
        SRD_OUTPUT_META,
 };
 
@@ -160,6 +162,9 @@ struct srd_decoder {
        /** List of possible decoder output IDs. */
        GSList *outputs;
 
+       /** List of tags associated with this decoder. */
+       GSList *tags;
+
        /** List of channels required by this decoder. */
        GSList *channels;
 
@@ -167,8 +172,8 @@ struct srd_decoder {
        GSList *opt_channels;
 
        /**
-        * List of NULL-terminated char[], containing descriptions of the
-        * supported annotation output.
+        * List of annotation classes. Each list item is a GSList itself, with
+        * two NUL-terminated strings: name and description.
         */
        GSList *annotations;
 
@@ -179,11 +184,16 @@ struct srd_decoder {
        GSList *annotation_rows;
 
        /**
-        * List of NULL-terminated char[], containing descriptions of the
-        * supported binary output.
+        * List of binary classes. Each list item is a GSList itself, with
+        * two NUL-terminated strings: name and description.
         */
        GSList *binary;
 
+       /**
+        * List of logic output channels (item: id, description, samplerate).
+        */
+       GSList *logic_output_channels;
+
        /** List of decoder options. */
        GSList *options;
 
@@ -194,6 +204,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.
@@ -222,6 +238,12 @@ struct srd_decoder_annotation_row {
        GSList *ann_classes;
 };
 
+struct srd_decoder_logic_output_channel {
+       char *id;
+       char *desc;
+       uint64_t samplerate;
+};
+
 struct srd_decoder_inst {
        struct srd_decoder *decoder;
        struct srd_session *sess;
@@ -270,6 +292,9 @@ struct srd_decoder_inst {
        /** Requests termination of wait() and decode(). */
        gboolean want_wait_terminate;
 
+       /** Indicates the current state of the decoder stack. */
+       int decoder_state;
+
        GCond got_new_samples_cond;
        GCond handled_all_samples_cond;
        GMutex data_mutex;
@@ -293,11 +318,16 @@ struct srd_proto_data {
        void *data;
 };
 struct srd_proto_data_annotation {
-       int ann_class;
+       int ann_class; /* Index into "struct srd_decoder"->annotations. */
        char **ann_text;
 };
 struct srd_proto_data_binary {
-       int bin_class;
+       int bin_class; /* Index into "struct srd_decoder"->binary. */
+       uint64_t size;
+       const unsigned char *data;
+};
+struct srd_proto_data_logic {
+       int logic_class;
        uint64_t size;
        const unsigned char *data;
 };
@@ -314,6 +344,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);
@@ -323,6 +354,7 @@ SRD_API int srd_session_metadata_set(struct srd_session *sess, int key,
 SRD_API int srd_session_send(struct srd_session *sess,
                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);
@@ -347,12 +379,15 @@ 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,
                                  const char *format, va_list args);
 SRD_API int srd_log_loglevel_set(int loglevel);
 SRD_API int srd_log_loglevel_get(void);
+SRD_API int srd_log_callback_get(srd_log_callback *cb, void **cb_data);
 SRD_API int srd_log_callback_set(srd_log_callback cb, void *cb_data);
 SRD_API int srd_log_callback_set_default(void);