README: Document python3-coverage requirement for tests.

[libsigrokdecode.git] / libsigrokdecode.h

diff --git a/libsigrokdecode.h b/libsigrokdecode.h
index f07e1ee32da91542e506ec2b9ef3c81e234e4161..9d2dbd323acfd0308421ee3b8b7d4c4b8592ddcb 100644 (file)
--- a/libsigrokdecode.h
+++ b/libsigrokdecode.h
@@ -65,7 +65,7 @@ struct srd_session;
  */
 
 /** Status/error codes returned by libsigrokdecode functions. */
-enum {
+enum srd_error_code {
        SRD_OK               =  0, /**< No error */
        SRD_ERR              = -1, /**< Generic/unspecified error */
        SRD_ERR_MALLOC       = -2, /**< Malloc/calloc/realloc error */
@@ -81,7 +81,7 @@ enum {
 };
 
 /* libsigrokdecode loglevels. */
-enum {
+enum srd_loglevel {
        SRD_LOG_NONE = 0, /**< Output no messages at all. */
        SRD_LOG_ERR  = 1, /**< Output error messages. */
        SRD_LOG_WARN = 2, /**< Output warnings. */
@@ -126,14 +126,14 @@ enum {
  *   - add a check in module_sigrokdecode.c:Decoder_put()
  *   - add a debug string in type_decoder.c:OUTPUT_TYPES
  */
-enum {
+enum srd_output_type {
        SRD_OUTPUT_ANN,
        SRD_OUTPUT_PYTHON,
        SRD_OUTPUT_BINARY,
        SRD_OUTPUT_META,
 };
 
-enum {
+enum srd_configkey {
        SRD_CONF_SAMPLERATE = 10000,
 };
 
@@ -156,11 +156,11 @@ struct srd_decoder {
         */
        char *license;
 
-       /** List of probes required by this decoder. */
-       GSList *probes;
+       /** List of channels required by this decoder. */
+       GSList *channels;
 
-       /** List of optional probes for this decoder. */
-       GSList *opt_probes;
+       /** List of optional channels for this decoder. */
+       GSList *opt_channels;
 
        /**
         * List of NULL-terminated char[], containing descriptions of the
@@ -191,17 +191,17 @@ struct srd_decoder {
 };
 
 /**
- * Structure which contains information about one protocol decoder probe.
- * For example, I2C has two probes, SDA and SCL.
+ * Structure which contains information about one protocol decoder channel.
+ * For example, I2C has two channels, SDA and SCL.
  */
-struct srd_probe {
-       /** The ID of the probe. Must be non-NULL. */
+struct srd_channel {
+       /** The ID of the channel. Must be non-NULL. */
        char *id;
-       /** The name of the probe. Must not be NULL. */
+       /** The name of the channel. Must not be NULL. */
        char *name;
-       /** The description of the probe. Must not be NULL. */
+       /** The description of the channel. Must not be NULL. */
        char *desc;
-       /** The index of the probe, i.e. its order in the list of probes. */
+       /** The index of the channel, i.e. its order in the list of channels. */
        int order;
 };
 
@@ -224,10 +224,10 @@ struct srd_decoder_inst {
        PyObject *py_inst;
        char *inst_id;
        GSList *pd_output;
-       int dec_num_probes;
-       int *dec_probemap;
+       int dec_num_channels;
+       int *dec_channelmap;
        int data_unitsize;
-       uint8_t *probe_samples;
+       uint8_t *channel_samples;
        GSList *next_di;
 };
 
@@ -258,21 +258,17 @@ struct srd_proto_data_binary {
        const unsigned char *data;
 };
 
-typedef void (*srd_pd_output_callback_t)(struct srd_proto_data *pdata,
-                                        void *cb_data);
+typedef void (*srd_pd_output_callback)(struct srd_proto_data *pdata,
+                                       void *cb_data);
 
 struct srd_pd_callback {
        int output_type;
-       srd_pd_output_callback_t cb;
+       srd_pd_output_callback cb;
        void *cb_data;
 };
 
 /* Custom Python types: */
 
-typedef struct {
-       PyObject_HEAD
-} srd_Decoder;
-
 typedef struct {
        PyObject_HEAD
        struct srd_decoder_inst *di;
@@ -298,7 +294,7 @@ SRD_API int srd_session_send(struct srd_session *sess,
                const uint8_t *inbuf, uint64_t inbuflen);
 SRD_API int srd_session_destroy(struct srd_session *sess);
 SRD_API int srd_pd_output_callback_add(struct srd_session *sess,
-               int output_type, srd_pd_output_callback_t cb, void *cb_data);
+               int output_type, srd_pd_output_callback cb, void *cb_data);
 
 /* decoder.c */
 SRD_API const GSList *srd_decoder_list(void);
@@ -312,8 +308,8 @@ SRD_API int srd_decoder_unload_all(void);
 /* instance.c */
 SRD_API int srd_inst_option_set(struct srd_decoder_inst *di,
                GHashTable *options);
-SRD_API int srd_inst_probe_set_all(struct srd_decoder_inst *di,
-               GHashTable *probes, int unit_size);
+SRD_API int srd_inst_channel_set_all(struct srd_decoder_inst *di,
+               GHashTable *channels, int unit_size);
 SRD_API struct srd_decoder_inst *srd_inst_new(struct srd_session *sess,
                const char *id, GHashTable *options);
 SRD_API int srd_inst_stack(struct srd_session *sess,
@@ -322,11 +318,11 @@ SRD_API struct srd_decoder_inst *srd_inst_find_by_id(struct srd_session *sess,
                const char *inst_id);
 
 /* log.c */
-typedef int (*srd_log_callback_t)(void *cb_data, int loglevel,
+typedef int (*srd_log_callback)(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_callback_set(srd_log_callback_t cb, void *cb_data);
+SRD_API int srd_log_callback_set(srd_log_callback 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);