/** 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;
};
};
typedef void (*srd_pd_output_callback_t)(struct srd_proto_data *pdata,
- void *user_data);
+ void *cb_data);
struct srd_pd_callback {
int output_type;
- srd_pd_output_callback_t callback;
- void *user_data;
+ srd_pd_output_callback_t cb;
+ void *cb_data;
};
-/* custom python types */
+/* Custom Python types: */
+
typedef struct {
PyObject_HEAD
} srd_Decoder;
/*--- controller.c ----------------------------------------------------------*/
-SRD_API int srd_init(void);
+SRD_API int srd_init(const char *path);
SRD_API int srd_exit(void);
-SRD_API int set_modulepath(void);
-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 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);
+ 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);
+ 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, uint8_t *inbuf,
+SRD_API int srd_session_send(uint64_t start_samplenum, const 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);
+ srd_pd_output_callback_t cb, void *cb_data);
/*--- decoder.c -------------------------------------------------------------*/
-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);
+SRD_API GSList *srd_decoder_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_decoder_load_all(void);
+SRD_API int srd_decoder_unload_all(void);
+SRD_API char *srd_decoder_doc(const struct srd_decoder *dec);
/*--- log.c -----------------------------------------------------------------*/
-typedef int (*srd_log_handler_t)(void *user_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);
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_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);
projects / libsigrokdecode.git / blobdiff