X-Git-Url: https://sigrok.org/gitweb/?p=libsigrokdecode.git;a=blobdiff_plain;f=libsigrokdecode.h;h=a26bce9a402ba720ac5e8c1141bccdd131b50966;hp=1603582a0cc5f80e8c2ce32ad10a32a97743672e;hb=821a21418cb64f77f444c440752ac09a8bc97fb6;hpb=1ce468178f581b6270e1f2862ab585e8a38aa056
diff --git a/libsigrokdecode.h b/libsigrokdecode.h
index 1603582..a26bce9 100644
--- a/libsigrokdecode.h
+++ b/libsigrokdecode.h
@@ -15,14 +15,12 @@
* 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 .
*/
-#ifndef LIBSIGROKDECODE_SIGROKDECODE_H
-#define LIBSIGROKDECODE_SIGROKDECODE_H
+#ifndef LIBSIGROKDECODE_LIBSIGROKDECODE_H
+#define LIBSIGROKDECODE_LIBSIGROKDECODE_H
-#include /* First, so we avoid a _POSIX_C_SOURCE warning. */
#include
#include
@@ -65,7 +63,7 @@ struct srd_session;
*/
/** Status/error codes returned by libsigrokdecode functions. */
-enum {
+enum srd_error_code {
SRD_OK = 0, /**< No error */
SRD_ERR = -1, /**< Generic/unspecified error */
SRD_ERR_MALLOC = -2, /**< Malloc/calloc/realloc error */
@@ -73,6 +71,7 @@ enum {
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
@@ -81,7 +80,7 @@ enum {
};
/* libsigrokdecode loglevels. */
-enum {
+enum srd_loglevel {
SRD_LOG_NONE = 0, /**< Output no messages at all. */
SRD_LOG_ERR = 1, /**< Output error messages. */
SRD_LOG_WARN = 2, /**< Output warnings. */
@@ -126,14 +125,14 @@ enum {
* - add a check in module_sigrokdecode.c:Decoder_put()
* - add a debug string in type_decoder.c:OUTPUT_TYPES
*/
-enum {
+enum srd_output_type {
SRD_OUTPUT_ANN,
SRD_OUTPUT_PYTHON,
SRD_OUTPUT_BINARY,
SRD_OUTPUT_META,
};
-enum {
+enum srd_configkey {
SRD_CONF_SAMPLERATE = 10000,
};
@@ -156,11 +155,17 @@ struct srd_decoder {
*/
char *license;
- /** List of probes required by this decoder. */
- GSList *probes;
+ /** List of possible decoder input IDs. */
+ GSList *inputs;
- /** List of optional probes for this decoder. */
- GSList *opt_probes;
+ /** List of possible decoder output IDs. */
+ GSList *outputs;
+
+ /** List of channels required by this decoder. */
+ GSList *channels;
+
+ /** List of optional channels for this decoder. */
+ GSList *opt_channels;
/**
* List of NULL-terminated char[], containing descriptions of the
@@ -180,28 +185,34 @@ struct srd_decoder {
*/
GSList *binary;
- /** List of decoder options. */
+ /** List of decoder options. */
GSList *options;
/** Python module. */
- PyObject *py_mod;
+ void *py_mod;
/** sigrokdecode.Decoder class. */
- PyObject *py_dec;
+ 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 probe.
- * For example, I2C has two probes, SDA and SCL.
+ * Structure which contains information about one protocol decoder channel.
+ * For example, I2C has two channels, SDA and SCL.
*/
-struct srd_probe {
- /** The ID of the probe. Must be non-NULL. */
+struct srd_channel {
+ /** The ID of the channel. Must be non-NULL. */
char *id;
- /** The name of the probe. Must not be NULL. */
+ /** The name of the channel. Must not be NULL. */
char *name;
- /** The description of the probe. Must not be NULL. */
+ /** The description of the channel. Must not be NULL. */
char *desc;
- /** The index of the probe, i.e. its order in the list of probes. */
+ /** The index of the channel, i.e. its order in the list of channels. */
int order;
};
@@ -209,6 +220,7 @@ struct srd_decoder_option {
char *id;
char *desc;
GVariant *def;
+ GSList *values;
};
struct srd_decoder_annotation_row {
@@ -220,14 +232,54 @@ struct srd_decoder_annotation_row {
struct srd_decoder_inst {
struct srd_decoder *decoder;
struct srd_session *sess;
- PyObject *py_inst;
+ void *py_inst;
char *inst_id;
GSList *pd_output;
- int dec_num_probes;
- int *dec_probemap;
+ int dec_num_channels;
+ int *dec_channelmap;
int data_unitsize;
- uint8_t *probe_samples;
+ uint8_t *channel_samples;
GSList *next_di;
+
+ /** List of conditions a PD wants to wait for. */
+ GSList *condition_list;
+
+ /** Array of booleans denoting which conditions matched. */
+ GArray *match_array;
+
+ /** Absolute start sample number. */
+ uint64_t abs_start_samplenum;
+
+ /** Absolute end sample number. */
+ uint64_t abs_end_samplenum;
+
+ /** Pointer to the buffer/chunk of input samples. */
+ const uint8_t *inbuf;
+
+ /** Length (in bytes) of the input sample buffer. */
+ uint64_t inbuflen;
+
+ /** Absolute current samplenumber. */
+ uint64_t abs_cur_samplenum;
+
+ /** Array of "old" (previous sample) pin values. */
+ GArray *old_pins_array;
+
+ /** Handle for this PD stack's worker thread. */
+ GThread *thread_handle;
+
+ /** Indicates whether new samples are available for processing. */
+ gboolean got_new_samples;
+
+ /** 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;
};
struct srd_pd_output {
@@ -248,7 +300,7 @@ struct srd_proto_data {
void *data;
};
struct srd_proto_data_annotation {
- int ann_format;
+ int ann_class;
char **ann_text;
};
struct srd_proto_data_binary {
@@ -257,35 +309,19 @@ struct srd_proto_data_binary {
const unsigned char *data;
};
-typedef void (*srd_pd_output_callback_t)(struct srd_proto_data *pdata,
- void *cb_data);
+typedef void (*srd_pd_output_callback)(struct srd_proto_data *pdata,
+ void *cb_data);
struct srd_pd_callback {
int output_type;
- srd_pd_output_callback_t cb;
+ srd_pd_output_callback cb;
void *cb_data;
};
-/* Custom Python types: */
-
-typedef struct {
- PyObject_HEAD
-} srd_Decoder;
-
-typedef struct {
- PyObject_HEAD
- struct srd_decoder_inst *di;
- uint64_t start_samplenum;
- unsigned int itercnt;
- uint8_t *inbuf;
- uint64_t inbuflen;
- PyObject *sample;
-} srd_logic;
-
-
/* 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);
@@ -293,11 +329,12 @@ 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,
- const uint8_t *inbuf, uint64_t inbuflen);
+ 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_t cb, void *cb_data);
+ int output_type, srd_pd_output_callback cb, void *cb_data);
/* decoder.c */
SRD_API const GSList *srd_decoder_list(void);
@@ -311,24 +348,24 @@ SRD_API int srd_decoder_unload_all(void);
/* instance.c */
SRD_API int srd_inst_option_set(struct srd_decoder_inst *di,
GHashTable *options);
-SRD_API int srd_inst_probe_set_all(struct srd_decoder_inst *di,
- GHashTable *probes);
+SRD_API int srd_inst_channel_set_all(struct srd_decoder_inst *di,
+ GHashTable *channels);
SRD_API struct srd_decoder_inst *srd_inst_new(struct srd_session *sess,
const char *id, GHashTable *options);
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_t)(void *cb_data, int loglevel,
+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_set(srd_log_callback_t 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);
-SRD_API int srd_log_logdomain_set(const char *logdomain);
-SRD_API char *srd_log_logdomain_get(void);
/* error.c */
SRD_API const char *srd_strerror(int error_code);
@@ -343,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"