X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=strutil.c;h=e63f12e18e9dfb8a4e8b6dd371c03c4453a6a4f2;hb=4711724141f9073af8b2493c3fc6a643d5c77cbe;hp=356f6f8384efcdf7a8303c153bf482fff9009705;hpb=91aea754aaed0f0f2a6fc4b2b875f0d0b7c01f8e;p=libsigrok.git

diff --git a/strutil.c b/strutil.c
index 356f6f83..e63f12e1 100644
--- a/strutil.c
+++ b/strutil.c
@@ -25,7 +25,9 @@
 #include "libsigrok.h"
 #include "libsigrok-internal.h"
 
+/** @cond PRIVATE */
 #define LOG_PREFIX "strutil"
+/** @endcond */
 
 /**
  * @file
@@ -226,6 +228,8 @@ SR_PRIV int sr_atof_ascii(const char *str, float *ret)
  * @return A g_try_malloc()ed string representation of the samplerate value,
  *         or NULL upon errors. The caller is responsible to g_free() the
  *         memory.
+ *
+ * @since 0.2.0
  */
 SR_API char *sr_si_string_u64(uint64_t x, const char *unit)
 {
@@ -266,6 +270,8 @@ SR_API char *sr_si_string_u64(uint64_t x, const char *unit)
  * @return A g_try_malloc()ed string representation of the samplerate value,
  *         or NULL upon errors. The caller is responsible to g_free() the
  *         memory.
+ *
+ * @since 0.1.0
  */
 SR_API char *sr_samplerate_string(uint64_t samplerate)
 {
@@ -283,6 +289,8 @@ SR_API char *sr_samplerate_string(uint64_t samplerate)
  * @return A g_try_malloc()ed string representation of the frequency value,
  *         or NULL upon errors. The caller is responsible to g_free() the
  *         memory.
+ *
+ * @since 0.1.0
  */
 SR_API char *sr_period_string(uint64_t frequency)
 {
@@ -326,6 +334,8 @@ SR_API char *sr_period_string(uint64_t frequency)
  * @return A g_try_malloc()ed string representation of the voltage value,
  *         or NULL upon errors. The caller is responsible to g_free() the
  *         memory.
+ *
+ * @since 0.2.0
  */
 SR_API char *sr_voltage_string(uint64_t v_p, uint64_t v_q)
 {
@@ -360,9 +370,9 @@ SR_API char *sr_voltage_string(uint64_t v_p, uint64_t v_q)
  *            intended. Must not be NULL. Also, sdi->driver and
  *            sdi->driver->info_get must not be NULL.
  * @param triggerstring The string containing the trigger specification for
- *        one or more probes of this device. Entries for multiple probes are
+ *        one or more channels of this device. Entries for multiple channels are
  *        comma-separated. Triggers are specified in the form key=value,
- *        where the key is a probe number (or probe name) and the value is
+ *        where the key is a channel number (or channel name) and the value is
  *        the requested trigger type. Valid trigger types currently
  *        include 'r' (rising edge), 'f' (falling edge), 'c' (any pin value
  *        change), '0' (low value), or '1' (high value).
@@ -370,27 +380,29 @@ SR_API char *sr_voltage_string(uint64_t v_p, uint64_t v_q)
  *
  * @return Pointer to a list of trigger types (strings), or NULL upon errors.
  *         The pointer list (if non-NULL) has as many entries as the
- *         respective device has probes (all physically available probes,
+ *         respective device has channels (all physically available channels,
  *         not just enabled ones). Entries of the list which don't have
  *         a trigger value set in 'triggerstring' are NULL, the other entries
  *         contain the respective trigger type which is requested for the
- *         respective probe (e.g. "r", "c", and so on).
+ *         respective channel (e.g. "r", "c", and so on).
+ *
+ * @since 0.2.0
  */
 SR_API char **sr_parse_triggerstring(const struct sr_dev_inst *sdi,
 				     const char *triggerstring)
 {
 	GSList *l;
 	GVariant *gvar;
-	struct sr_channel *probe;
-	int max_probes, probenum, i;
+	struct sr_channel *ch;
+	int max_channels, channelnum, i;
 	char **tokens, **triggerlist, *trigger, *tc;
 	const char *trigger_types;
 	gboolean error;
 
-	max_probes = g_slist_length(sdi->probes);
+	max_channels = g_slist_length(sdi->channels);
 	error = FALSE;
 
-	if (!(triggerlist = g_try_malloc0(max_probes * sizeof(char *)))) {
+	if (!(triggerlist = g_try_malloc0(max_channels * sizeof(char *)))) {
 		sr_err("%s: triggerlist malloc failed", __func__);
 		return NULL;
 	}
@@ -402,21 +414,21 @@ SR_API char **sr_parse_triggerstring(const struct sr_dev_inst *sdi,
 	}
 	trigger_types = g_variant_get_string(gvar, NULL);
 
-	tokens = g_strsplit(triggerstring, ",", max_probes);
+	tokens = g_strsplit(triggerstring, ",", max_channels);
 	for (i = 0; tokens[i]; i++) {
-		probenum = -1;
-		for (l = sdi->probes; l; l = l->next) {
-			probe = (struct sr_channel *)l->data;
-			if (probe->enabled
-				&& !strncmp(probe->name, tokens[i],
-					strlen(probe->name))) {
-				probenum = probe->index;
+		channelnum = -1;
+		for (l = sdi->channels; l; l = l->next) {
+			ch = (struct sr_channel *)l->data;
+			if (ch->enabled
+				&& !strncmp(ch->name, tokens[i],
+					strlen(ch->name))) {
+				channelnum = ch->index;
 				break;
 			}
 		}
 
-		if (probenum < 0 || probenum >= max_probes) {
-			sr_err("Invalid probe.");
+		if (channelnum < 0 || channelnum >= max_channels) {
+			sr_err("Invalid channel.");
 			error = TRUE;
 			break;
 		}
@@ -431,14 +443,14 @@ SR_API char **sr_parse_triggerstring(const struct sr_dev_inst *sdi,
 				}
 			}
 			if (!error)
-				triggerlist[probenum] = g_strdup(trigger);
+				triggerlist[channelnum] = g_strdup(trigger);
 		}
 	}
 	g_strfreev(tokens);
 	g_variant_unref(gvar);
 
 	if (error) {
-		for (i = 0; i < max_probes; i++)
+		for (i = 0; i < max_channels; i++)
 			g_free(triggerlist[i]);
 		g_free(triggerlist);
 		triggerlist = NULL;
@@ -461,6 +473,8 @@ SR_API char **sr_parse_triggerstring(const struct sr_dev_inst *sdi,
  * @param size Pointer to uint64_t which will contain the string's size value.
  *
  * @return SR_OK upon success, SR_ERR upon errors.
+ *
+ * @since 0.1.0
  */
 SR_API int sr_parse_sizestring(const char *sizestring, uint64_t *size)
 {
@@ -526,6 +540,8 @@ SR_API int sr_parse_sizestring(const char *sizestring, uint64_t *size)
  * @todo Add support for "m" (minutes) and others.
  * @todo Add support for picoseconds?
  * @todo Allow both lower-case and upper-case? If no, document it.
+ *
+ * @since 0.1.0
  */
 SR_API uint64_t sr_parse_timestring(const char *timestring)
 {
@@ -552,6 +568,7 @@ SR_API uint64_t sr_parse_timestring(const char *timestring)
 	return time_msec;
 }
 
+/** @since 0.1.0 */
 SR_API gboolean sr_parse_boolstring(const char *boolstr)
 {
 	if (!boolstr)
@@ -566,6 +583,7 @@ SR_API gboolean sr_parse_boolstring(const char *boolstr)
 	return FALSE;
 }
 
+/** @since 0.2.0 */
 SR_API int sr_parse_period(const char *periodstr, uint64_t *p, uint64_t *q)
 {
 	char *s;
@@ -598,7 +616,7 @@ SR_API int sr_parse_period(const char *periodstr, uint64_t *p, uint64_t *q)
 	return SR_OK;
 }
 
-
+/** @since 0.2.0 */
 SR_API int sr_parse_voltage(const char *voltstr, uint64_t *p, uint64_t *q)
 {
 	char *s;