Temporarily revert API changes in preparation of release.

The upcoming libsigrokdecode release should not contain any API changes
so it is compatible with existing released frontends (sigrok-cli 0.3.1).

4 files changed, 19 insertions, 70 deletions

diff --git a/controller.c b/controller.c
index c265ae7..5d19e7a 100644
--- a/controller.c
+++ b/controller.c
@@ -330,9 +330,9 @@ static gint compare_probe_id(const struct srd_probe *a, const char *probe_id)
  * it overwrites any probes that were already defined (if any).
  *
  * @param di Decoder instance.
- * @param new_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.
+ * @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.
  */
@@ -344,7 +344,6 @@ SRD_API int srd_inst_probe_set_all(struct srd_decoder_inst *di,
 	struct srd_probe *p;
 	int *new_probemap, new_probenum;
 	char *probe_id, *probenum_str;
-	int i, num_required_probes;
 
 	srd_dbg("set probes called for instance %s with list of %d probes",
 		di->inst_id, g_hash_table_size(new_probes));
@@ -367,13 +366,6 @@ SRD_API int srd_inst_probe_set_all(struct srd_decoder_inst *di,
 		return SRD_ERR_MALLOC;
 	}
 
-	/*
-	 * For now, map all indexes to probe -1 (can be overridden later).
-	 * This -1 is interpreted as an unspecified probe later.
-	 */
-	for (i = 0; i < di->dec_num_probes; i++)
-		new_probemap[i] = -1;
-
 	for (l = g_hash_table_get_keys(new_probes); l; l = l->next) {
 		probe_id = l->data;
 		probenum_str = g_hash_table_lookup(new_probes, probe_id);
@@ -398,17 +390,9 @@ SRD_API int srd_inst_probe_set_all(struct srd_decoder_inst *di,
 		}
 		p = sl->data;
 		new_probemap[p->order] = new_probenum;
-		srd_dbg("Setting probe mapping: %s (index %d) = probe %d.",
-			p->id, p->order, new_probenum);
-	}
-
-	srd_dbg("Final probe map:");
-	num_required_probes = g_slist_length(di->decoder->probes);
-	for (i = 0; i < di->dec_num_probes; i++) {
-		srd_dbg(" - index %d = probe %d (%s)", i, new_probemap[i],
-		        (i < num_required_probes) ? "required" : "optional");
+		srd_dbg("setting probe mapping for %d = probe %d", p->order,
+			new_probenum);
 	}
-
 	g_free(di->dec_probemap);
 	di->dec_probemap = new_probemap;
 
@@ -418,9 +402,9 @@ SRD_API int srd_inst_probe_set_all(struct srd_decoder_inst *di,
 /**
  * Create a new protocol decoder instance.
  *
- * @param decoder_id Decoder 'id' field.
+ * @param id Decoder 'id' field.
  * @param options GHashtable of options which override the defaults set in
- *                the decoder class. May be NULL.
+ *                the decoder class.
  *
  * @return Pointer to a newly allocated struct srd_decoder_inst, or
  *         NULL in case of failure.
@@ -445,13 +429,10 @@ SRD_API struct srd_decoder_inst *srd_inst_new(const char *decoder_id,
 		return NULL;
 	}
 
+	inst_id = g_hash_table_lookup(options, "id");
 	di->decoder = dec;
-	if (options) {
-		inst_id = g_hash_table_lookup(options, "id");
-		di->inst_id = g_strdup(inst_id ? inst_id : decoder_id);
-		g_hash_table_remove(options, "id");
-	} else
-		di->inst_id = g_strdup(decoder_id);
+	di->inst_id = g_strdup(inst_id ? inst_id : decoder_id);
+	g_hash_table_remove(options, "id");
 
 	/*
 	 * Prepare a default probe map, where samples come in the
@@ -480,7 +461,7 @@ SRD_API struct srd_decoder_inst *srd_inst_new(const char *decoder_id,
 		return NULL;
 	}
 
-	if (options && srd_inst_option_set(di, options) != SRD_OK) {
+	if (srd_inst_option_set(di, options) != SRD_OK) {
 		g_free(di->dec_probemap);
 		g_free(di);
 		return NULL;
@@ -736,8 +717,6 @@ SRD_API int srd_session_start(int num_probes, int unitsize, uint64_t samplerate)
 	struct srd_decoder_inst *di;
 	int ret;
 
-	ret = SRD_OK;
-
 	srd_dbg("Calling start() on all instances with %d probes, "
 		"unitsize %d samplerate %d.", num_probes, unitsize, samplerate);
 
@@ -756,7 +735,7 @@ SRD_API int srd_session_start(int num_probes, int unitsize, uint64_t samplerate)
 		di->data_num_probes = num_probes;
 		di->data_unitsize = unitsize;
 		di->data_samplerate = samplerate;
-		if ((ret = srd_inst_start(di, args)) != SRD_OK)
+		if ((ret = srd_inst_start(di, args) != SRD_OK))
 			break;
 	}
 
@@ -770,7 +749,7 @@ SRD_API int srd_session_start(int num_probes, int unitsize, uint64_t samplerate)
  *
  * @param start_samplenum The sample number of the first sample in this chunk.
  * @param inbuf Pointer to sample data.
- * @param inbuflen Length in bytes of the buffer.
+ * @param inbuf Length in bytes of the buffer.
  *
  * @return SRD_OK upon success, a (negative) error code otherwise.
  */
diff --git a/decoder.c b/decoder.c
index cbca0b8..6290add 100644
--- a/decoder.c
+++ b/decoder.c
@@ -36,7 +36,7 @@ extern SRD_PRIV PyObject *mod_sigrokdecode;
  *
  * @return List of decoders, NULL if none are supported or loaded.
  */
-SRD_API const GSList *srd_decoder_list(void)
+SRD_API GSList *srd_decoder_list(void)
 {
 	return pd_list;
 }
@@ -53,7 +53,7 @@ SRD_API struct srd_decoder *srd_decoder_get_by_id(const char *id)
 	GSList *l;
 	struct srd_decoder *dec;
 
-	for (l = pd_list; l; l = l->next) {
+	for (l = srd_decoder_list(); l; l = l->next) {
 		dec = l->data;
 		if (!strcmp(dec->id, id))
 			return dec;
@@ -124,7 +124,7 @@ err_out:
 /**
  * Load a protocol decoder module into the embedded Python interpreter.
  *
- * @param module_name The module name to be loaded.
+ * @param name The module name to be loaded.
  *
  * @return SRD_OK upon success, a (negative) error code otherwise.
  */
@@ -134,8 +134,6 @@ SRD_API int srd_decoder_load(const char *module_name)
 	struct srd_decoder *d;
 	int alen, ret, i;
 	char **ann;
-	struct srd_probe *p;
-	GSList *l;
 
 	srd_dbg("Loading protocol decoder '%s'.", module_name);
 
@@ -224,19 +222,6 @@ SRD_API int srd_decoder_load(const char *module_name)
 	if (get_probes(d, "optional_probes", &d->opt_probes) != SRD_OK)
 		goto err_out;
 
-	/*
-	 * Fix order numbers for the optional probes.
-	 *
-	 * Example:
-	 * Required probes: r1, r2, r3. Optional: o1, o2, o3, o4.
-	 * 'order' fields in the d->probes list = 0, 1, 2.
-	 * 'order' fields in the d->opt_probes list = 3, 4, 5, 6.
-	 */
-	for (l = d->opt_probes; l; l = l->next) {
-		p = l->data;
-		p->order += g_slist_length(d->probes);
-	}
-
 	/* Store required fields in newly allocated strings. */
 	if (py_attr_as_str(d->py_dec, "id", &(d->id)) != SRD_OK)
 		goto err_out;
@@ -415,7 +400,7 @@ SRD_API int srd_decoder_unload_all(void)
 	GSList *l;
 	struct srd_decoder *dec;
 
-	for (l = pd_list; l; l = l->next) {
+	for (l = srd_decoder_list(); l; l = l->next) {
 		dec = l->data;
 		srd_decoder_unload(dec);
 	}
diff --git a/sigrokdecode.h.in b/sigrokdecode.h.in
index 033e30e..470332f 100644
--- a/sigrokdecode.h.in
+++ b/sigrokdecode.h.in
@@ -268,7 +268,7 @@ SRD_API int srd_pd_output_callback_add(int output_type,
 
 /*--- decoder.c -------------------------------------------------------------*/
 
-SRD_API const GSList *srd_decoder_list(void);
+SRD_API GSList *srd_decoder_list(void);
 SRD_API struct srd_decoder *srd_decoder_get_by_id(const char *id);
 SRD_API int srd_decoder_load(const char *name);
 SRD_API int srd_decoder_unload(struct srd_decoder *dec);
diff --git a/type_logic.c b/type_logic.c
index 098e34d..b284ebf 100644
--- a/type_logic.c
+++ b/type_logic.c
@@ -45,26 +45,11 @@ static PyObject *srd_logic_iternext(PyObject *self)
 	 * Convert the bit-packed sample to an array of bytes, with only 0x01
 	 * and 0x00 values, so the PD doesn't need to do any bitshifting.
 	 */
-
-	/* Get probe bits into the 'sample' variable. */
 	memcpy(&sample,
 	       logic->inbuf + logic->itercnt * logic->di->data_unitsize,
 	       logic->di->data_unitsize);
-
-	/* All probe values (required + optional) are pre-set to 42. */
-	memset(probe_samples, 42, logic->di->dec_num_probes);
-	/* TODO: None or -1 in Python would be better. */
-
-	/*
-	 * Set probe values of specified/used probes to their resp. values.
-	 * Unused probe values (those not specified by the user) remain at 42.
-	 */
-	for (i = 0; i < logic->di->dec_num_probes; i++) {
-		/* A probemap value of -1 means "unused optional probe". */
-		if (logic->di->dec_probemap[i] == -1)
-			continue;
+	for (i = 0; i < logic->di->dec_num_probes; i++)
 		probe_samples[i] = sample & (1 << logic->di->dec_probemap[i]) ? 1 : 0;
-	}
 
 	/* Prepare the next samplenum/sample list in this iteration. */
 	py_samplenum =