X-Git-Url: https://sigrok.org/gitweb/?p=libsigrokdecode.git;a=blobdiff_plain;f=sigrokdecode.h;h=a6641d40092f5c7ff0865800bff882bcf72e6ea0;hp=88776112d4cf5306f6fa59fd49f0cfa8b96778c2;hb=47bd8ddead2ae35b209839255740e3f81ce4b8bc;hpb=871d21e2555c345350ec951f1639b4a75dbd4fea diff --git a/sigrokdecode.h b/sigrokdecode.h index 8877611..a6641d4 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 @@ -25,6 +26,10 @@ #include #include +#ifdef __cplusplus +extern "C" { +#endif + /* * Status/error codes returned by libsigrokdecode functions. * @@ -42,32 +47,152 @@ * or reused for different #defines later. You can only add new #defines and * return codes, but never remove or redefine existing ones. */ -#define SIGROKDECODE_OK 0 /* No error */ -#define SIGROKDECODE_ERR -1 /* Generic/unspecified error */ -#define SIGROKDECODE_ERR_MALLOC -2 /* Malloc/calloc/realloc error */ -#define SIGROKDECODE_ERR_ARGS -3 /* Function argument error */ -#define SIGROKDECODE_ERR_PYTHON -4 /* Python C API error */ -#define SIGROKDECODE_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. */ + +enum { + SRD_OUTPUT_ANNOTATION, + SRD_OUTPUT_PROTOCOL, + SRD_OUTPUT_BINARY, + /* When adding an output type, don't forget to expose it to PDs + * in controller.c:PyInit_sigrokdecode() + */ +}; + +#define SRD_MAX_NUM_PROBES 64 /* TODO: Documentation. */ -struct sigrokdecode_decoder { +struct srd_decoder { + /** The decoder ID. Must be non-NULL and unique for all decoders. */ char *id; + + /** The (short) decoder name. */ char *name; + + /** The (long) decoder name. May be NULL. */ + char *longname; + + /** 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; + /* List of NULL-terminated char[], containing descriptions of the + * supported annotation output. + */ + GSList *annotation; + + /** TODO */ PyObject *py_mod; - PyObject *py_func; + + /** Python object that performs the decoding */ + PyObject *py_decobj; }; -int sigrokdecode_init(void); -GSList *sigrokdecode_list_decoders(void); -int sigrokdecode_load_decoder(const char *name, struct sigrokdecode_decoder **dec); -int sigrokdecode_run_decoder(struct sigrokdecode_decoder *dec, - uint8_t *inbuf, uint64_t inbuflen, - uint8_t **outbuf, uint64_t *outbuflen); -int sigrokdecode_shutdown(void); +struct srd_decoder_instance { + struct srd_decoder *decoder; + PyObject *py_instance; + GSList *pd_output; + int num_probes; + int unitsize; + uint64_t samplerate; +}; + +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; + +struct srd_protocol_data { + uint64_t start_sample; + uint64_t end_sample; + struct srd_pd_output *pdo; + int annotation_type; + unsigned char **data; +}; + + + +/*--- 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_session_start(int num_probes, int unitsize, uint64_t samplerate); +int srd_run_decoder(uint64_t timeoffset, uint64_t duration, + struct srd_decoder_instance *dec, uint8_t *inbuf, uint64_t inbuflen); +int srd_session_feed(uint64_t timeoffset, uint64_t duration, uint8_t *inbuf, + uint64_t inbuflen); +int pd_output_new(struct srd_decoder_instance *di, int output_type, + char *output_id); +struct srd_decoder_instance *get_di_by_decobject(void *decobject); + +/*--- 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); + +/*--- util.c ----------------------------------------------------------------*/ +int h_str(PyObject *py_res, const char *key, 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); + +#ifdef __cplusplus +} +#endif #endif