X-Git-Url: https://sigrok.org/gitweb/?p=libsigrokdecode.git;a=blobdiff_plain;f=sigrokdecode.h;h=2c9cb40128f7b19eb787b73c37f49e286b0f477f;hp=cf52264493052b5600aaa16719f28dfac13f3a44;hb=3a8b2e789262545fe409f95f69319b80e66aac13;hpb=7ce7775cb5a4e97264df62f43315d32504602072 diff --git a/sigrokdecode.h b/sigrokdecode.h index cf52264..2c9cb40 100644 --- a/sigrokdecode.h +++ b/sigrokdecode.h @@ -64,13 +64,13 @@ extern "C" { #define SRD_LOG_SPEW 5 /**< Output very noisy debug messages. */ enum { - SRD_OUTPUT_ANNOTATION, - SRD_OUTPUT_PROTOCOL, + SRD_OUTPUT_ANN, + SRD_OUTPUT_PROTO, SRD_OUTPUT_BINARY, - /* When adding an output type, don't forget to expose it to PDs in: - * controller.c:PyInit_sigrokdecode() - * and add a check in: - * module_sigrokdecode.c:Decoder_put() + /* 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 */ }; @@ -90,34 +90,38 @@ struct srd_decoder { /** A (short, one-line) description of the decoder. */ char *desc; - /** A (long, multi-line) description of the decoder. May be NULL. */ - char *longdesc; - - /** The author of the decoder. May be NULL. */ - char *author; - /** The license of the decoder. Valid values: "gplv2+", "gplv3+". */ char *license; - /** TODO */ - char *func; - /** TODO */ GSList *inputformats; /** TODO */ GSList *outputformats; + /** Probes */ + GSList *probes; + + /** Optional probes */ + GSList *extra_probes; + /* List of NULL-terminated char[], containing descriptions of the * supported annotation output. */ - GSList *annotation; + GSList *annotations; - /** TODO */ + /** Python module */ PyObject *py_mod; - /** Python object that performs the decoding */ - PyObject *py_decobj; + /** sigrokdecode.Decoder class */ + PyObject *py_dec; +}; + +struct srd_probe { + char *id; + char *name; + char *desc; + int order; }; struct srd_decoder_instance { @@ -125,83 +129,103 @@ struct srd_decoder_instance { PyObject *py_instance; char *instance_id; GSList *pd_output; - int num_probes; - int unitsize; - uint64_t samplerate; + int dec_num_probes; + int *dec_probemap; + int data_num_probes; + int data_unitsize; + uint64_t data_samplerate; GSList *next_di; }; struct srd_pd_output { int pdo_id; int output_type; - struct srd_decoder *decoder; - char *protocol_id; -}; - -typedef struct { - PyObject_HEAD struct srd_decoder_instance *di; - unsigned int itercnt; - uint8_t *inbuf; - uint64_t inbuflen; - PyObject *sample; -} srd_logic; + char *proto_id; +}; -struct srd_protocol_data { +struct srd_proto_data { uint64_t start_sample; uint64_t end_sample; struct srd_pd_output *pdo; - int annotation_format; + int ann_format; void *data; }; struct srd_pd_callback { int output_type; - void (*callback)(struct srd_protocol_data *); + void (*callback)(struct srd_proto_data *); }; -/*--- controller.c ----------------------------------------------------------*/ +/* custom python types */ +typedef struct { + PyObject_HEAD +} srd_Decoder; + +typedef struct { + PyObject_HEAD + struct srd_decoder_instance *di; + uint64_t start_samplenum; + unsigned int itercnt; + uint8_t *inbuf; + uint64_t inbuflen; + PyObject *sample; +} srd_logic; + +/*--- controller.c ----------------------------------------------------------*/ int srd_init(void); int srd_exit(void); int set_modulepath(void); +int srd_instance_set_options(struct srd_decoder_instance *di, + GHashTable *options); +int srd_instance_set_probes(struct srd_decoder_instance *di, + GHashTable *probes); struct srd_decoder_instance *srd_instance_new(const char *id, - const char *instance_id); + GHashTable *options); int srd_instance_stack(struct srd_decoder_instance *di_from, struct srd_decoder_instance *di_to); -int srd_instance_set_probe(struct srd_decoder_instance *di, - const char *probename, int num); -struct srd_decoder_instance *srd_instance_find(char *instance_id); +struct srd_decoder_instance *srd_instance_find_by_id(char *instance_id); +struct srd_decoder_instance *srd_instance_find_by_obj(GSList *stack, + PyObject *obj); int srd_instance_start(struct srd_decoder_instance *di, PyObject *args); -int srd_instance_decode(uint64_t timeoffset, uint64_t duration, +int srd_instance_decode(uint64_t start_samplenum, struct srd_decoder_instance *dec, uint8_t *inbuf, uint64_t inbuflen); int srd_session_start(int num_probes, int unitsize, uint64_t samplerate); -int srd_session_feed(uint64_t timeoffset, uint64_t duration, uint8_t *inbuf, - uint64_t inbuflen); -int pd_add(struct srd_decoder_instance *di, int output_type, - char *output_id); +int srd_session_feed(uint64_t start_samplenum, uint8_t *inbuf, uint64_t inbuflen); +int pd_add(struct srd_decoder_instance *di, int output_type, char *output_id); struct srd_decoder_instance *get_di_by_decobject(void *decobject); int srd_register_callback(int output_type, void *cb); void *srd_find_callback(int output_type); /*--- decoder.c -------------------------------------------------------------*/ - GSList *srd_list_decoders(void); struct srd_decoder *srd_get_decoder_by_id(const char *id); int srd_load_decoder(const char *name, struct srd_decoder **dec); int srd_unload_decoder(struct srd_decoder *dec); int srd_load_all_decoders(void); int srd_unload_all_decoders(void); +char *srd_decoder_doc(struct srd_decoder *dec); + +/*--- exception.c -----------------------------------------------------------*/ +void catch_exception(const char *format, ...); /*--- util.c ----------------------------------------------------------------*/ -int h_str(PyObject *py_res, const char *key, char **outstr); +int py_attr_as_str(PyObject *py_obj, const char *attr, char **outstr); +int py_dictitem_as_str(PyObject *py_obj, const char *key, char **outstr); +int py_str_as_str(PyObject *py_str, char **outstr); int py_strlist_to_char(PyObject *py_strlist, char ***outstr); /*--- log.c -----------------------------------------------------------------*/ - +typedef int (*srd_log_handler_t)(void *data, int loglevel, const char *format, + va_list args); int srd_set_loglevel(int loglevel); int srd_get_loglevel(void); +int srd_log_set_handler(srd_log_handler_t handler, void *data); +int srd_log_set_default_handler(void); +int srd_log_set_logdomain(const char *logdomain); +char *srd_log_get_logdomain(void); #ifdef __cplusplus }