srd: Add SRD_ERR_BUG.

[libsigrokdecode.git] / sigrokdecode.h

diff --git a/sigrokdecode.h b/sigrokdecode.h
index 8c2ccd2271323bc587c7fa36cd93d67a3ac16910..a6641d40092f5c7ff0865800bff882bcf72e6ea0 100644 (file)
--- a/sigrokdecode.h
+++ b/sigrokdecode.h
@@ -50,9 +50,10 @@ extern "C" {
 #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_PYTHON        -4 /**< Python C API error */
-#define SRD_ERR_DECODERS_DIR  -5 /**< Protocol decoder path invalid */
+#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. */
@@ -63,9 +64,12 @@ extern "C" {
 #define SRD_LOG_SPEW   5 /**< Output very noisy debug messages. */
 
 enum {
-       SRD_OUTPUT_LOGIC = 1,
        SRD_OUTPUT_ANNOTATION,
        SRD_OUTPUT_PROTOCOL,
+       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
@@ -105,6 +109,11 @@ struct srd_decoder {
        /** TODO */
        GSList *outputformats;
 
+       /* List of NULL-terminated char[], containing descriptions of the
+        * supported annotation output.
+        */
+       GSList *annotation;
+
        /** TODO */
        PyObject *py_mod;
 
@@ -124,8 +133,8 @@ struct srd_decoder_instance {
 struct srd_pd_output {
        int pdo_id;
        int output_type;
+       struct srd_decoder *decoder;
        char *protocol_id;
-       char *description;
 };
 
 typedef struct {
@@ -137,6 +146,14 @@ typedef struct {
        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 ----------------------------------------------------------*/
@@ -153,7 +170,7 @@ int srd_run_decoder(uint64_t timeoffset, uint64_t duration,
 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, char *description);
+               char *output_id);
 struct srd_decoder_instance *get_di_by_decobject(void *decobject);
 
 /*--- decoder.c -------------------------------------------------------------*/
@@ -167,6 +184,7 @@ 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);
 
 /*--- log.c -----------------------------------------------------------------*/