X-Git-Url: https://sigrok.org/gitweb/?p=libsigrokdecode.git;a=blobdiff_plain;f=libsigrokdecode.h;h=f043036e1809452703c45b9bbea664a1a2ff105d;hp=032d9447001e155c1e7c14c6be5c26d757e48711;hb=17475b09ef9504f91a28b0873b53cec329513077;hpb=2b628af1e5f816b96683a5a140642a97fe0ef8e1 diff --git a/libsigrokdecode.h b/libsigrokdecode.h index 032d944..f043036 100644 --- a/libsigrokdecode.h +++ b/libsigrokdecode.h @@ -133,8 +133,6 @@ enum { SRD_OUTPUT_META, }; -#define SRD_MAX_NUM_PROBES 64 - enum { SRD_CONF_SAMPLERATE = 10000, }; @@ -158,11 +156,11 @@ struct srd_decoder { */ char *license; - /** List of probes required by this decoder. */ - GSList *probes; + /** List of channels required by this decoder. */ + GSList *channels; - /** List of optional probes for this decoder. */ - GSList *opt_probes; + /** List of optional channels for this decoder. */ + GSList *opt_channels; /** * List of NULL-terminated char[], containing descriptions of the @@ -170,6 +168,12 @@ struct srd_decoder { */ GSList *annotations; + /** + * List of annotation rows (row items: id, description, and a list + * of annotation classes belonging to this row). + */ + GSList *annotation_rows; + /** * List of NULL-terminated char[], containing descriptions of the * supported binary output. @@ -187,17 +191,17 @@ struct srd_decoder { }; /** - * 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; }; @@ -205,6 +209,13 @@ struct srd_decoder_option { char *id; char *desc; GVariant *def; + GSList *values; +}; + +struct srd_decoder_annotation_row { + char *id; + char *desc; + GSList *ann_classes; }; struct srd_decoder_inst { @@ -213,9 +224,10 @@ struct srd_decoder_inst { PyObject *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 *channel_samples; GSList *next_di; }; @@ -246,21 +258,17 @@ 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; @@ -271,20 +279,12 @@ typedef struct { PyObject *sample; } srd_logic; -/*--- controller.c ----------------------------------------------------------*/ +/* srd.c */ SRD_API int srd_init(const char *path); SRD_API int srd_exit(void); -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 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); + +/* session.c */ SRD_API int srd_session_new(struct srd_session **sess); SRD_API int srd_session_start(struct srd_session *sess); SRD_API int srd_session_metadata_set(struct srd_session *sess, int key, @@ -294,47 +294,53 @@ SRD_API int srd_session_send(struct srd_session *sess, const uint8_t *inbuf, uint64_t inbuflen); 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); - -/*--- decoder.c -------------------------------------------------------------*/ + int output_type, srd_pd_output_callback cb, void *cb_data); +/* decoder.c */ SRD_API const GSList *srd_decoder_list(void); SRD_API struct srd_decoder *srd_decoder_get_by_id(const char *id); SRD_API int srd_decoder_load(const char *name); +SRD_API char *srd_decoder_doc_get(const struct srd_decoder *dec); SRD_API int srd_decoder_unload(struct srd_decoder *dec); SRD_API int srd_decoder_load_all(void); SRD_API int srd_decoder_unload_all(void); -SRD_API char *srd_decoder_doc_get(const struct srd_decoder *dec); -/*--- log.c -----------------------------------------------------------------*/ +/* instance.c */ +SRD_API int srd_inst_option_set(struct srd_decoder_inst *di, + GHashTable *options); +SRD_API int srd_inst_channel_set_all(struct srd_decoder_inst *di, + GHashTable *channels, int unit_size); +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); -typedef int (*srd_log_callback_t)(void *cb_data, int loglevel, +/* 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_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); -/*--- version.c -------------------------------------------------------------*/ +/* error.c */ +SRD_API const char *srd_strerror(int error_code); +SRD_API const char *srd_strerror_name(int error_code); +/* version.c */ SRD_API int srd_package_version_major_get(void); SRD_API int srd_package_version_minor_get(void); SRD_API int srd_package_version_micro_get(void); SRD_API const char *srd_package_version_string_get(void); - 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); -/*--- error.c ---------------------------------------------------------------*/ - -SRD_API const char *srd_strerror(int error_code); -SRD_API const char *srd_strerror_name(int error_code); - #include "version.h" #ifdef __cplusplus