srd: properly return status code

[libsigrokdecode.git] / controller.c

diff --git a/controller.c b/controller.c
index 2bc0a8c61866822e01253d5148fd419e5871c79a..e169a5164dbeee9f7a9432cf2b3f7fd059caeab6 100644 (file)
--- a/controller.c
+++ b/controller.c
@@ -49,7 +49,7 @@ extern SRD_PRIV PyTypeObject srd_logic_type;
  * Then, it searches for sigrok protocol decoder files (*.py) in the
  * "decoders" subdirectory of the the sigrok installation directory.
  * All decoders that are found are loaded into memory and added to an
- * internal list of decoders, which can be queried via srd_list_decoders().
+ * internal list of decoders, which can be queried via srd_decoders_list().
  *
  * The caller is responsible for calling the clean-up function srd_exit(),
  * which will properly shut down libsigrokdecode and free its allocated memory.
@@ -100,11 +100,6 @@ SRD_API int srd_init(char *path)
                }
        }
 
-       if ((ret = srd_load_all_decoders()) != SRD_OK) {
-               Py_Finalize();
-               return ret;
-       }
-
        return SRD_OK;
 }
 
@@ -124,7 +119,7 @@ SRD_API int srd_exit(void)
 {
        srd_dbg("Exiting libsigrokdecode.");
 
-       srd_unload_all_decoders();
+       srd_decoders_unload_all();
        g_slist_free(pd_list);
 
        /* Py_Finalize() returns void, any finalization errors are ignored. */
@@ -211,7 +206,7 @@ SRD_PRIV int add_modulepath(const char *path)
  *
  * @return SRD_OK upon success, a (negative) error code otherwise.
  */
-SRD_API int srd_inst_set_options(struct srd_decoder_inst *di,
+SRD_API int srd_inst_options_set(struct srd_decoder_inst *di,
                                     GHashTable *options)
 {
        PyObject *py_dec_options, *py_dec_optkeys, *py_di_options, *py_optval;
@@ -319,7 +314,7 @@ err_out:
        return ret;
 }
 
-/* Helper GComparefunc for g_slist_find_custom() in srd_inst_set_probes() */
+/* Helper GComparefunc for g_slist_find_custom() in srd_inst_probes_set() */
 static gint compare_probe_id(struct srd_probe *a, char *probe_id)
 {
        return strcmp(a->id, probe_id);
@@ -335,7 +330,7 @@ static gint compare_probe_id(struct srd_probe *a, char *probe_id)
  *
  * @return SRD_OK upon success, a (negative) error code otherwise.
  */
-SRD_API int srd_inst_set_probes(struct srd_decoder_inst *di,
+SRD_API int srd_inst_probes_set(struct srd_decoder_inst *di,
                                    GHashTable *new_probes)
 {
        GList *l;
@@ -418,7 +413,7 @@ SRD_API struct srd_decoder_inst *srd_inst_new(const char *decoder_id,
 
        srd_dbg("Creating new %s instance.", decoder_id);
 
-       if (!(dec = srd_get_decoder_by_id(decoder_id))) {
+       if (!(dec = srd_decoder_get_by_id(decoder_id))) {
                srd_err("Protocol decoder %s not found.", decoder_id);
                return NULL;
        }
@@ -459,7 +454,7 @@ SRD_API struct srd_decoder_inst *srd_inst_new(const char *decoder_id,
                return NULL;
        }
 
-       if (srd_inst_set_options(di, options) != SRD_OK) {
+       if (srd_inst_options_set(di, options) != SRD_OK) {
                g_free(di->dec_probemap);
                g_free(di);
                return NULL;
@@ -471,6 +466,14 @@ SRD_API struct srd_decoder_inst *srd_inst_new(const char *decoder_id,
        return di;
 }
 
+/**
+ * Stack a decoder instance on top of another.
+ *
+ * @param di_from The instance to move.
+ * @param di_to The instance on top of which di_from will be stacked.
+ *
+ * @return SRD_OK upon success, a (negative) error code otherwise.
+ */
 SRD_API int srd_inst_stack(struct srd_decoder_inst *di_from,
                               struct srd_decoder_inst *di_to)
 {
@@ -684,6 +687,17 @@ SRD_PRIV void srd_inst_free_all(GSList *stack)
        }
 }
 
+/**
+ * Start a decoding session.
+ *
+ * Decoders, instances and stack must have been prepared beforehand.
+ *
+ * @param num_probes The number of probes which the incoming feed will contain.
+ * @param unitsize The number of bytes per sample in the incoming feed.
+ * @param The samplerate of the incoming feed.
+ *
+ * @return SRD_OK upon success, a (negative) error code otherwise.
+ */
 SRD_API int srd_session_start(int num_probes, int unitsize, uint64_t samplerate)
 {
        PyObject *args;
@@ -717,8 +731,16 @@ SRD_API int srd_session_start(int num_probes, int unitsize, uint64_t samplerate)
        return ret;
 }
 
-/* Feed logic samples to decoder session. */
-SRD_API int srd_session_feed(uint64_t start_samplenum, uint8_t * inbuf,
+/**
+ * Feed a chunk of logic sample data to a running decoder session.
+ *
+ * @param start_samplenum The sample number of the first sample in this chunk.
+ * @param inbuf Pointer to sample data.
+ * @param inbuf Length in bytes of the buffer.
+ *
+ * @return SRD_OK upon success, a (negative) error code otherwise.
+ */
+SRD_API int srd_session_feed(uint64_t start_samplenum, uint8_t *inbuf,
                             uint64_t inbuflen)
 {
        GSList *d;
@@ -737,6 +759,18 @@ SRD_API int srd_session_feed(uint64_t start_samplenum, uint8_t * inbuf,
        return SRD_OK;
 }
 
+/**
+ * Register a decoder output callback function.
+ *
+ * The function will be called when a protocol decoder sends output back
+ * to the PD controller (except for Python objects, which only go up the
+ * stack).
+ *
+ * @param output_type The output type this callback will receive. Only one
+ * callback per output type can be registered.
+ * @param cb The function to call.
+ * @param user_data Unused.
+ */
 SRD_API int srd_register_callback(int output_type,
                                  srd_pd_output_callback_t cb, void *user_data)
 {
@@ -757,7 +791,7 @@ SRD_API int srd_register_callback(int output_type,
        return SRD_OK;
 }
 
-SRD_API void *srd_find_callback(int output_type)
+SRD_PRIV void *srd_find_callback(int output_type)
 {
        GSList *l;
        struct srd_pd_callback *pd_cb;