X-Git-Url: https://sigrok.org/gitweb/?p=libsigrokdecode.git;a=blobdiff_plain;f=controller.c;h=3ebf5a9e4c77a4bb313a32f4f074910c9be21d7e;hp=8b9f793750bc7c9658c5e7e3fd51fcdd0ea3d105;hb=ed2306a6f29bc4d85f5f248c83fff252b22c60a5;hpb=65e1c7d091956e42aa4d97d7b639e10076e6f8ff

diff --git a/controller.c b/controller.c
index 8b9f793..3ebf5a9 100644
--- 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.
@@ -94,17 +94,12 @@ SRD_API int srd_init(char *path)
 
 	/* Environment variable overrides everything, for debugging. */
 	if ((env_path = getenv("SIGROKDECODE_DIR"))) {
-		if ((ret = add_modulepath(path)) != SRD_OK) {
+		if ((ret = add_modulepath(env_path)) != SRD_OK) {
 			Py_Finalize();
 			return ret;
 		}
 	}
 
-	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);
@@ -332,9 +327,10 @@ static gint compare_probe_id(struct srd_probe *a, char *probe_id)
  * @param probes A GHashTable of probes to set. Key is probe name, value is
  *               the probe number. Samples passed to this instance will be
  *               arranged in this order.
+ *
  * @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;
@@ -403,6 +399,7 @@ SRD_API int srd_inst_set_probes(struct srd_decoder_inst *di,
  * @param id Decoder 'id' field.
  * @param options GHashtable of options which override the defaults set in
  *                the decoder class.
+ *
  * @return Pointer to a newly allocated struct srd_decoder_inst, or
  *         NULL in case of failure.
  */
@@ -416,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;
 	}
@@ -457,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;
@@ -469,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)
 {
@@ -489,11 +494,11 @@ SRD_API int srd_inst_stack(struct srd_decoder_inst *di_from,
 }
 
 /**
- * Finds a decoder instance by its instance id, but only in the bottom
+ * Finds a decoder instance by its instance ID, but only in the bottom
  * level of instances -- instances already stacked on top of another one
  * will not be found.
  *
- * @param inst_id The instance id to be found.
+ * @param inst_id The instance ID to be found.
  *
  * @return Pointer to struct srd_decoder_inst, or NULL if not found.
  */
@@ -526,7 +531,7 @@ SRD_API struct srd_decoder_inst *srd_inst_find_by_id(char *inst_id)
  *
  * @return Pointer to struct srd_decoder_inst, or NULL if not found.
  */
-SRD_API struct srd_decoder_inst *srd_inst_find_by_obj(GSList *stack,
+SRD_PRIV struct srd_decoder_inst *srd_inst_find_by_obj(GSList *stack,
 							      PyObject *obj)
 {
 	GSList *l;
@@ -544,7 +549,7 @@ SRD_API struct srd_decoder_inst *srd_inst_find_by_obj(GSList *stack,
 	return di;
 }
 
-SRD_API int srd_inst_start(struct srd_decoder_inst *di, PyObject *args)
+SRD_PRIV int srd_inst_start(struct srd_decoder_inst *di, PyObject *args)
 {
 	PyObject *py_name, *py_res;
 	GSList *l;
@@ -593,7 +598,7 @@ SRD_API int srd_inst_start(struct srd_decoder_inst *di, PyObject *args)
  *
  * @return SRD_OK upon success, a (negative) error code otherwise.
  */
-SRD_API int srd_inst_decode(uint64_t start_samplenum,
+SRD_PRIV int srd_inst_decode(uint64_t start_samplenum,
 				struct srd_decoder_inst *di,
 				uint8_t *inbuf, uint64_t inbuflen)
 {
@@ -645,7 +650,7 @@ SRD_API int srd_inst_decode(uint64_t start_samplenum,
 	return SRD_OK;
 }
 
-SRD_API void srd_inst_free(struct srd_decoder_inst *di)
+SRD_PRIV void srd_inst_free(struct srd_decoder_inst *di)
 {
 	GSList *l;
 	struct srd_pd_output *pdo;
@@ -664,7 +669,7 @@ SRD_API void srd_inst_free(struct srd_decoder_inst *di)
 	g_slist_free(di->pd_output);
 }
 
-SRD_API void srd_inst_free_all(GSList *stack)
+SRD_PRIV void srd_inst_free_all(GSList *stack)
 {
 	GSList *l;
 	struct srd_decoder_inst *di;
@@ -682,6 +687,17 @@ SRD_API 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;
@@ -715,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;
@@ -735,8 +759,20 @@ 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 cb_data Unused.
+ */
 SRD_API int srd_register_callback(int output_type,
-				  srd_pd_output_callback_t cb, void *user_data)
+				  srd_pd_output_callback_t cb, void *cb_data)
 {
 	struct srd_pd_callback *pd_cb;
 
@@ -748,14 +784,14 @@ SRD_API int srd_register_callback(int output_type,
 	}
 
 	pd_cb->output_type = output_type;
-	pd_cb->callback = cb;
-	pd_cb->user_data = user_data;
+	pd_cb->cb = cb;
+	pd_cb->cb_data = cb_data;
 	callbacks = g_slist_append(callbacks, pd_cb);
 
 	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;
@@ -765,7 +801,7 @@ SRD_API void *srd_find_callback(int output_type)
 	for (l = callbacks; l; l = l->next) {
 		pd_cb = l->data;
 		if (pd_cb->output_type == output_type) {
-			cb = pd_cb->callback;
+			cb = pd_cb->cb;
 			break;
 		}
 	}