X-Git-Url: https://sigrok.org/gitweb/?p=libsigrokdecode.git;a=blobdiff_plain;f=sigrokdecode.h;h=649cdc63e299ef76077c9e67418562fedbcad907;hp=be3ab98e05d9929bf2b2864c29f5508557c40f57;hb=9d122fd5d66aa178547ec4222ab5f526f8a14cf7;hpb=31b82285e5ca1fbd6a33eaaaa95bf83862b69eb1 diff --git a/sigrokdecode.h b/sigrokdecode.h index be3ab98..649cdc6 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 @@ -18,11 +19,16 @@ * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA */ -#ifndef SIGROKDECODE_SIGROKDECODE_H -#define SIGROKDECODE_SIGROKDECODE_H +#ifndef LIBSIGROKDECODE_SIGROKDECODE_H +#define LIBSIGROKDECODE_SIGROKDECODE_H #include /* First, so we avoid a _POSIX_C_SOURCE warning. */ #include +#include + +#ifdef __cplusplus +extern "C" { +#endif /* * Status/error codes returned by libsigrokdecode functions. @@ -41,25 +47,200 @@ * 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 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. */ + +/* + * Use SRD_API to mark public API symbols, and SRD_PRIV for private symbols. + * + * Variables and functions marked 'static' are private already and don't + * need SR_PRIV. However, functions which are not static (because they need + * to be used in other libsigrokdecode-internal files) but are also not + * meant to be part of the public libsigrokdecode API, must use SRD_PRIV. + * + * This uses the 'visibility' feature of gcc (requires gcc >= 4.0). + * + * Details: http://gcc.gnu.org/wiki/Visibility + */ + +/* Marks public libsigrokdecode API symbols. */ +#define SRD_API __attribute__((visibility("default"))) + +/* Marks private, non-public libsigrokdecode symbols (not part of the API). */ +#define SRD_PRIV __attribute__((visibility("hidden"))) + +/* + * 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 + */ +enum { + SRD_OUTPUT_ANN, + SRD_OUTPUT_PROTO, + SRD_OUTPUT_BINARY, +}; + +#define SRD_MAX_NUM_PROBES 64 /* TODO: Documentation. */ -struct sigrokdecode_decoder_info { +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; + + /** The license of the decoder. Valid values: "gplv2+", "gplv3+". */ + char *license; + + /** TODO */ + GSList *inputformats; + + /** TODO */ + GSList *outputformats; + + /** Probes */ + GSList *probes; + + /** Optional probes */ + GSList *opt_probes; + + /* + * List of NULL-terminated char[], containing descriptions of the + * supported annotation output. + */ + GSList *annotations; + + /** Python module */ + PyObject *py_mod; + + /** sigrokdecode.Decoder class */ + PyObject *py_dec; +}; + +struct srd_probe { char *id; char *name; - char *description; - char *function; - char *inputformats; /* FIXME: Should be a list. */ - char *outputformats; /* FIXME: Should be a list. */ + char *desc; + int order; }; -int sigrokdecode_init(void); -int sigrokdecode_load_decoder_file(const char *name); -int sigrokdecode_run_decoder(const char *modulename, const char *decodername, - uint8_t *inbuf, uint64_t inbuflen, - uint8_t **outbuf, uint64_t *outbuflen); -int sigrokdecode_shutdown(void); +struct srd_decoder_inst { + struct srd_decoder *decoder; + PyObject *py_inst; + char *inst_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_inst *di; + 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; +}; + +typedef void (*srd_pd_output_callback_t)(struct srd_proto_data *pdata, + void *user_data); + +struct srd_pd_callback { + int output_type; + srd_pd_output_callback_t callback; + void *user_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; + +/*--- controller.c ----------------------------------------------------------*/ + +SRD_API int srd_init(char *path); +SRD_API int srd_exit(void); +SRD_API int srd_inst_options_set(struct srd_decoder_inst *di, + GHashTable *options); +SRD_API int srd_inst_probes_set(struct srd_decoder_inst *di, + GHashTable *probes); +SRD_API struct srd_decoder_inst *srd_inst_new(const char *id, + GHashTable *options); +SRD_API int srd_inst_stack(struct srd_decoder_inst *di_from, + struct srd_decoder_inst *di_to); +SRD_API struct srd_decoder_inst *srd_inst_find_by_id(char *inst_id); +SRD_API int srd_session_start(int num_probes, int unitsize, + uint64_t samplerate); +SRD_API int srd_session_feed(uint64_t start_samplenum, uint8_t *inbuf, + uint64_t inbuflen); +SRD_API int srd_register_callback(int output_type, + srd_pd_output_callback_t cb, void *user_data); + +/*--- decoder.c -------------------------------------------------------------*/ + +SRD_API GSList *srd_decoders_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 int srd_decoder_unload(struct srd_decoder *dec); +SRD_API int srd_decoders_load_all(void); +SRD_API int srd_decoders_unload_all(void); +SRD_API char *srd_decoder_doc(struct srd_decoder *dec); + +/*--- log.c -----------------------------------------------------------------*/ + +typedef int (*srd_log_handler_t)(void *user_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_handler_set(srd_log_handler_t handler, void *user_data); +SRD_API int srd_log_handler_set_default(void); +SRD_API int srd_log_logdomain_set(const char *logdomain); +SRD_API char *srd_log_logdomain_get(void); + +#ifdef __cplusplus +} +#endif #endif