srd: Add SRD_ERR_BUG.

[libsigrokdecode.git] / sigrokdecode.h

diff --git a/sigrokdecode.h b/sigrokdecode.h
index d58aea271cc0f299dbe4553b9418255868768f5b..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. */
@@ -66,6 +67,9 @@ enum {
        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