#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()
SRD_OUTPUT_BINARY,
};
-#define SRD_MAX_NUM_PROBES 64
+#define SRD_MAX_NUM_PROBES 64
/* TODO: Documentation. */
struct srd_decoder {
/** The decoder ID. Must be non-NULL and unique for all decoders. */
char *id;
- /** The (short) decoder name. */
+ /** The (short) decoder name. Must be non-NULL. */
char *name;
/** The (long) decoder name. May be NULL. */
char *longname;
- /** A (short, one-line) description of the decoder. */
+ /** A (short, one-line) description of the decoder. Must be non-NULL. */
char *desc;
- /** The license of the decoder. Valid values: "gplv2+", "gplv3+". */
+ /**
+ * The license of the decoder. Valid values: "gplv2+", "gplv3+".
+ * Other values are currently not allowed. Must be non-NULL.
+ */
char *license;
/** TODO */
/** TODO */
GSList *outputformats;
- /** Probes */
+ /** List of probes required by this decoder. */
GSList *probes;
- /** Optional probes */
+ /** List of optional probes for this decoder. */
GSList *opt_probes;
- /*
+ /**
* List of NULL-terminated char[], containing descriptions of the
* supported annotation output.
*/
GSList *annotations;
- /** Python module */
+ /** Python module. */
PyObject *py_mod;
- /** sigrokdecode.Decoder class */
+ /** sigrokdecode.Decoder class. */
PyObject *py_dec;
};
+/**
+ * Structure which contains information about one protocol decoder probe.
+ * For example, I2C has two probes, SDA and SCL.
+ */
struct srd_probe {
+ /** The ID of the probe. Must be non-NULL. */
char *id;
+ /** The name of the probe. Must not be NULL. */
char *name;
+ /** The description of the probe. Must not be NULL. */
char *desc;
+ /** The index of the probe, i.e. its order in the list of probes. */
int order;
};
-struct srd_decoder_instance {
+struct srd_decoder_inst {
struct srd_decoder *decoder;
- PyObject *py_instance;
- char *instance_id;
+ PyObject *py_inst;
+ char *inst_id;
GSList *pd_output;
int dec_num_probes;
int *dec_probemap;
struct srd_pd_output {
int pdo_id;
int output_type;
- struct srd_decoder_instance *di;
+ struct srd_decoder_inst *di;
char *proto_id;
};
void *data;
};
+typedef void (*srd_pd_output_callback_t)(struct srd_proto_data *pdata,
+ void *cb_data);
+
struct srd_pd_callback {
int output_type;
- void (*callback)(struct srd_proto_data *);
+ srd_pd_output_callback_t cb;
+ void *cb_data;
};
-/* custom python types */
+/* Custom Python types: */
+
typedef struct {
PyObject_HEAD
} srd_Decoder;
typedef struct {
PyObject_HEAD
- struct srd_decoder_instance *di;
+ struct srd_decoder_inst *di;
uint64_t start_samplenum;
unsigned int itercnt;
uint8_t *inbuf;
/*--- 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,
+SRD_API int srd_init(const 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);
-int srd_instance_stack(struct srd_decoder_instance *di_from,
- struct srd_decoder_instance *di_to);
-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 start_samplenum,
- struct srd_decoder_instance *dec,
- uint8_t *inbuf, uint64_t inbuflen);
-void srd_instance_free(struct srd_decoder_instance *di);
-void srd_instance_free_all(GSList *stack);
-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);
-typedef void (*srd_pd_output_callback_t)(struct srd_proto_data *pdata);
-int srd_register_callback(int output_type, srd_pd_output_callback_t cb);
-void *srd_find_callback(int output_type);
+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(const 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, const uint8_t *inbuf,
+ uint64_t inbuflen);
+SRD_API int srd_register_callback(int output_type,
+ srd_pd_output_callback_t cb, void *cb_data);
/*--- 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 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);
+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(const struct srd_decoder *dec);
/*--- log.c -----------------------------------------------------------------*/
-typedef int (*srd_log_handler_t)(void *data, int loglevel, const char *format,
- va_list args);
+typedef int (*srd_log_callback_t)(void *cb_data, int loglevel,
+ const char *format, va_list args);
-int srd_log_loglevel_set(int loglevel);
-int srd_log_loglevel_get(void);
-int srd_log_handler_set(srd_log_handler_t handler, void *data);
-int srd_log_handler_set_default(void);
-int srd_log_logdomain_set(const char *logdomain);
-char *srd_log_logdomain_get(void);
+SRD_API int srd_log_loglevel_set(int loglevel);
+SRD_API int srd_log_loglevel_get(void);
+SRD_API int srd_log_callback_set(srd_log_callback_t cb, void *cb_data);
+SRD_API int srd_log_callback_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