X-Git-Url: https://sigrok.org/gitweb/?p=libsigrokdecode.git;a=blobdiff_plain;f=sigrokdecode.h;h=70652a4f8cdcbf444c6316e5508a99d6b48a9112;hp=f7d93accd39c564a1edb52186ec1156f2032d2f8;hb=f38ec2855ce41154bc1035dd7f1ab9a21f411f0d;hpb=43c0a640533331c45ed1b46725524773085de99e diff --git a/sigrokdecode.h b/sigrokdecode.h index f7d93ac..70652a4 100644 --- a/sigrokdecode.h +++ b/sigrokdecode.h @@ -2,6 +2,7 @@ * This file is part of the sigrok project. * * Copyright (C) 2010 Uwe Hermann + * Copyright (C) 2012 Bert Vermeulen * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by @@ -46,20 +47,34 @@ extern "C" { * or reused for different #defines later. You can only add new #defines and * return codes, but never remove or redefine existing ones. */ -#define SRD_OK 0 /**< No error */ -#define SRD_ERR -1 /**< Generic/unspecified error */ -#define SRD_ERR_MALLOC -2 /**< Malloc/calloc/realloc error */ -#define SRD_ERR_ARGS -3 /**< Function argument error */ -#define SRD_ERR_PYTHON -4 /**< Python C API error */ -#define SRD_ERR_DECODERS_DIR -5 /**< Protocol decoder path invalid */ +#define SRD_OK 0 /**< No error */ +#define SRD_ERR -1 /**< Generic/unspecified error */ +#define SRD_ERR_MALLOC -2 /**< Malloc/calloc/realloc error */ +#define SRD_ERR_ARG -3 /**< Function argument error */ +#define SRD_ERR_BUG -4 /**< Errors hinting at internal bugs */ +#define SRD_ERR_PYTHON -5 /**< Python C API error */ +#define SRD_ERR_DECODERS_DIR -6 /**< Protocol decoder path invalid */ /* libsigrokdecode loglevels. */ -#define SRD_LOG_NONE 0 /**< Output no messages at all. */ -#define SRD_LOG_ERR 1 /**< Output error messages. */ -#define SRD_LOG_WARN 2 /**< Output warnings. */ -#define SRD_LOG_INFO 3 /**< Output informational messages. */ -#define SRD_LOG_DBG 4 /**< Output debug messages. */ -#define SRD_LOG_SPEW 5 /**< Output very noisy debug messages. */ +#define SRD_LOG_NONE 0 /**< Output no messages at all. */ +#define SRD_LOG_ERR 1 /**< Output error messages. */ +#define SRD_LOG_WARN 2 /**< Output warnings. */ +#define SRD_LOG_INFO 3 /**< Output informational messages. */ +#define SRD_LOG_DBG 4 /**< Output debug messages. */ +#define SRD_LOG_SPEW 5 /**< Output very noisy debug messages. */ + +enum { + 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() + */ +}; + +#define SRD_MAX_NUM_PROBES 64 /* TODO: Documentation. */ struct srd_decoder { @@ -75,69 +90,129 @@ 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; - - /** An email address of the decoder's author. May be NULL. */ - char *email; - /** The license of the decoder. Valid values: "gplv2+", "gplv3+". */ char *license; - /** TODO */ - char *func; - /** TODO */ GSList *inputformats; /** TODO */ GSList *outputformats; - /** TODO */ + /** Probes */ + GSList *probes; + + /** Optional probes */ + GSList *extra_probes; + + /* List of NULL-terminated char[], containing descriptions of the + * supported annotation output. + */ + GSList *annotations; + + /** 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 { struct srd_decoder *decoder; PyObject *py_instance; + char *instance_id; GSList *pd_output; + 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 *proto_id; +}; + +struct srd_proto_data { + uint64_t start_sample; + uint64_t end_sample; + struct srd_pd_output *pdo; + int ann_format; + void *data; +}; + +struct srd_pd_callback { + int output_type; + 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); -struct srd_decoder_instance *srd_instance_new(const char *id); -int srd_instance_set_probe(struct srd_decoder_instance *di, - const char *probename, int num); -int srd_instance_start(struct srd_decoder_instance *di, - const char *driver, int unitsize, uint64_t starttime); -int srd_session_start(const char *driver, int unitsize, uint64_t starttime, - uint64_t samplerate); -int srd_session_feed(uint8_t *inbuf, uint64_t inbuflen); +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, + GHashTable *options); +int srd_instance_stack(struct srd_decoder_instance *di_from, + struct srd_decoder_instance *di_to); +struct srd_decoder_instance *srd_instance_find(char *instance_id); +int srd_instance_start(struct srd_decoder_instance *di, PyObject *args); +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 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); /*--- util.c ----------------------------------------------------------------*/ - -int h_str(PyObject *py_res, PyObject *py_mod, 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 -----------------------------------------------------------------*/ - int srd_set_loglevel(int loglevel); int srd_get_loglevel(void);