X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=filter.c;h=7fd94991b8e8cdfd4422ecb4ae1606daf30e6bfa;hb=3a18cf625e6f611041554d81c178b29cec19b484;hp=0775765f276fbbdf5b6dedda9ec9c0f1771f196b;hpb=45c59c8bdd01954f9214fe7b869d92c55415d109;p=libsigrok.git

diff --git a/filter.c b/filter.c
index 0775765f..7fd94991 100644
--- a/filter.c
+++ b/filter.c
@@ -23,6 +23,29 @@
 #include "libsigrok.h"
 #include "libsigrok-internal.h"
 
+/* Message logging helpers with driver-specific prefix string. */
+#define DRIVER_LOG_DOMAIN "filter: "
+#define sr_log(l, s, args...) sr_log(l, DRIVER_LOG_DOMAIN s, ## args)
+#define sr_spew(s, args...) sr_spew(DRIVER_LOG_DOMAIN s, ## args)
+#define sr_dbg(s, args...) sr_dbg(DRIVER_LOG_DOMAIN s, ## args)
+#define sr_info(s, args...) sr_info(DRIVER_LOG_DOMAIN s, ## args)
+#define sr_warn(s, args...) sr_warn(DRIVER_LOG_DOMAIN s, ## args)
+#define sr_err(s, args...) sr_err(DRIVER_LOG_DOMAIN s, ## args)
+
+/**
+ * @file
+ *
+ * Helper functions to filter out unused probes from samples.
+ */
+
+/**
+ * @defgroup grp_filter Probe filter
+ *
+ * Helper functions to filter out unused probes from samples.
+ *
+ * @{
+ */
+
 /**
  * Remove unused probes from samples.
  *
@@ -56,9 +79,8 @@
  *                     The requested unit size must be big enough to hold as
  *                     much data as is specified by the number of enabled
  *                     probes in 'probelist'.
- * @param probelist Pointer to a list of integers (probe numbers). The probe
- *                  numbers in this list are 1-based, i.e. the first probe
- *                  is expected to be numbered 1 (not 0!). Must not be NULL.
+ * @param probelist Pointer to a list of probe numbers, numbered starting
+ *                  from 0. The list is terminated with -1.
  * @param data_in Pointer to the input data buffer. Must not be NULL.
  * @param length_in The input data length (>= 1), in number of bytes.
  * @param data_out Variable which will point to the newly allocated buffer
@@ -83,38 +105,38 @@ SR_API int sr_filter_probes(int in_unitsize, int out_unitsize,
 	uint64_t sample_in, sample_out;
 
 	if (!probelist) {
-		sr_err("filter: %s: probelist was NULL", __func__);
+		sr_err("%s: probelist was NULL", __func__);
 		return SR_ERR_ARG;
 	}
 
 	if (!data_in) {
-		sr_err("filter: %s: data_in was NULL", __func__);
+		sr_err("%s: data_in was NULL", __func__);
 		return SR_ERR_ARG;
 	}
 
 	if (!data_out) {
-		sr_err("filter: %s: data_out was NULL", __func__);
+		sr_err("%s: data_out was NULL", __func__);
 		return SR_ERR_ARG;
 	}
 
 	if (!length_out) {
-		sr_err("filter: %s: length_out was NULL", __func__);
+		sr_err("%s: length_out was NULL", __func__);
 		return SR_ERR_ARG;
 	}
 
 	num_enabled_probes = 0;
-	for (i = 0; probelist[i]; i++)
+	for (i = 0; probelist[i] != -1; i++)
 		num_enabled_probes++;
 
 	/* Are there more probes than the target unit size supports? */
 	if (num_enabled_probes > out_unitsize * 8) {
-		sr_err("filter: %s: too many probes (%d) for the target unit "
-		       "size (%d)", num_enabled_probes, out_unitsize, __func__);
+		sr_err("%s: too many probes (%d) for the target unit "
+		       "size (%d)", __func__, num_enabled_probes, out_unitsize);
 		return SR_ERR_ARG;
 	}
 
 	if (!(*data_out = g_try_malloc(length_in))) {
-		sr_err("filter: %s: data_out malloc failed", __func__);
+		sr_err("%s: data_out malloc failed", __func__);
 		return SR_ERR_MALLOC;
 	}
 
@@ -130,8 +152,8 @@ SR_API int sr_filter_probes(int in_unitsize, int out_unitsize,
 	while (in_offset <= length_in - in_unitsize) {
 		memcpy(&sample_in, data_in + in_offset, in_unitsize);
 		sample_out = out_bit = 0;
-		for (i = 0; probelist[i]; i++) {
-			if (sample_in & (1 << (probelist[i] - 1)))
+		for (i = 0; probelist[i] != -1; i++) {
+			if (sample_in & (1 << (probelist[i])))
 				sample_out |= (1 << out_bit);
 			out_bit++;
 		}
@@ -143,3 +165,5 @@ SR_API int sr_filter_probes(int in_unitsize, int out_unitsize,
 
 	return SR_OK;
 }
+
+/** @} */