* 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 <Python.h> /* First, so we avoid a _POSIX_C_SOURCE warning. */
#include <stdint.h>
#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_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()
- */
};
-#define SRD_MAX_NUM_PROBES 64
+#define SRD_MAX_NUM_PROBES 64
/* TODO: Documentation. */
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;
- /* List of NULL-terminated char[], containing descriptions of the
+ /** Probes */
+ GSList *probes;
+
+ /** Optional probes */
+ GSList *opt_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 {
+struct srd_decoder_inst {
struct srd_decoder *decoder;
- PyObject *py_instance;
+ PyObject *py_inst;
+ char *inst_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;
+ 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
- struct srd_decoder_instance *di;
+} 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;
-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);
+SRD_API int srd_init(char *path);
+SRD_API int srd_exit(void);
+SRD_PRIV int add_modulepath(const char *path);
+SRD_API int srd_inst_set_options(struct srd_decoder_inst *di,
+ GHashTable *options);
+SRD_API int srd_inst_set_probes(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 struct srd_decoder_inst *srd_inst_find_by_obj(GSList *stack,
+ PyObject *obj);
+SRD_API int srd_inst_start(struct srd_decoder_inst *di, PyObject *args);
+SRD_API int srd_inst_decode(uint64_t start_samplenum,
+ struct srd_decoder_inst *dec,
+ uint8_t *inbuf, uint64_t inbuflen);
+SRD_API void srd_inst_free(struct srd_decoder_inst *di);
+SRD_API void srd_inst_free_all(GSList *stack);
+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 struct srd_decoder_inst *get_di_by_decobject(void *decobject);
+SRD_API int srd_register_callback(int output_type,
+ srd_pd_output_callback_t cb, void *user_data);
+SRD_API 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);
-
-/*--- util.c ----------------------------------------------------------------*/
-int h_str(PyObject *py_res, const char *key, char **outstr);
-int py_strlist_to_char(PyObject *py_strlist, char ***outstr);
+SRD_API GSList *srd_list_decoders(void);
+SRD_API struct srd_decoder *srd_get_decoder_by_id(const char *id);
+SRD_API int srd_load_decoder(const char *name, struct srd_decoder **dec);
+SRD_API int srd_unload_decoder(struct srd_decoder *dec);
+SRD_API int srd_load_all_decoders(void);
+SRD_API int srd_unload_all_decoders(void);
+SRD_API char *srd_decoder_doc(struct srd_decoder *dec);
/*--- log.c -----------------------------------------------------------------*/
-int srd_set_loglevel(int loglevel);
-int srd_get_loglevel(void);
+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
}
projects / libsigrokdecode.git / blobdiff