X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=strutil.c;h=c5e7dce81ffeefc1e503955b8169d4cfc900041a;hb=a885ce3ee9ed770594d5b231f6dec0b740bba03b;hp=9a791e1950f7c05e7f029bb99d509866e6f23007;hpb=5097b0d0912165429aceddb5febbf68467b623f5;p=libsigrok.git diff --git a/strutil.c b/strutil.c index 9a791e19..c5e7dce8 100644 --- a/strutil.c +++ b/strutil.c @@ -21,13 +21,82 @@ #include #include #include -#include "sigrok.h" -#include "sigrok-internal.h" +#include "libsigrok.h" +#include "libsigrok-internal.h" + +/* Message logging helpers with driver-specific prefix string. */ +#define DRIVER_LOG_DOMAIN "strutil: " +#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 for handling or converting libsigrok-related strings. + */ + +/** + * @defgroup grp_strutil String utilities + * + * Helper functions for handling or converting libsigrok-related strings. + * + * @{ + */ + +/** + * Convert a numeric value value to its "natural" string representation. + * in SI units + * + * E.g. a value of 3000000, with units set to "W", would be converted + * to "3 MW", 20000 to "20 kW", 31500 would become "31.5 kW". + * + * @param x The value to convert. + * @param unit The unit to append to the string, or NULL if the string + * has no units. + * + * @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. + */ +SR_API char *sr_si_string_u64(uint64_t x, const char *unit) +{ + if (unit == NULL) + unit = ""; + + if ((x >= SR_GHZ(1)) && (x % SR_GHZ(1) == 0)) { + return g_strdup_printf("%" PRIu64 " G%s", x / SR_GHZ(1), unit); + } else if ((x >= SR_GHZ(1)) && (x % SR_GHZ(1) != 0)) { + return g_strdup_printf("%" PRIu64 ".%" PRIu64 " G%s", + x / SR_GHZ(1), x % SR_GHZ(1), unit); + } else if ((x >= SR_MHZ(1)) && (x % SR_MHZ(1) == 0)) { + return g_strdup_printf("%" PRIu64 " M%s", + x / SR_MHZ(1), unit); + } else if ((x >= SR_MHZ(1)) && (x % SR_MHZ(1) != 0)) { + return g_strdup_printf("%" PRIu64 ".%" PRIu64 " M%s", + x / SR_MHZ(1), x % SR_MHZ(1), unit); + } else if ((x >= SR_KHZ(1)) && (x % SR_KHZ(1) == 0)) { + return g_strdup_printf("%" PRIu64 " k%s", + x / SR_KHZ(1), unit); + } else if ((x >= SR_KHZ(1)) && (x % SR_KHZ(1) != 0)) { + return g_strdup_printf("%" PRIu64 ".%" PRIu64 " k%s", + x / SR_KHZ(1), x % SR_KHZ(1), unit); + } else { + return g_strdup_printf("%" PRIu64 " %s", x, unit); + } + + sr_err("%s: Error creating SI units string.", __func__); + return NULL; +} /** * Convert a numeric samplerate value to its "natural" string representation. * - * E.g. a value of 3000000 would be converted to "3 MHz", 20000 to "20 kHz". + * E.g. a value of 3000000 would be converted to "3 MHz", 20000 to "20 kHz", + * 31500 would become "31.5 kHz". * * @param samplerate The samplerate in Hz. * @@ -36,24 +105,41 @@ * memory. */ SR_API char *sr_samplerate_string(uint64_t samplerate) +{ + return sr_si_string_u64(samplerate, "Hz"); +} + +/** + * Convert a numeric frequency value to the "natural" string representation + * of its period. + * + * E.g. a value of 3000000 would be converted to "3 us", 20000 to "50 ms". + * + * @param frequency The frequency in Hz. + * + * @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. + */ +SR_API char *sr_period_string(uint64_t frequency) { char *o; int r; - /* Allocate enough for a uint64_t as string + " GHz". */ + /* Allocate enough for a uint64_t as string + " ms". */ if (!(o = g_try_malloc0(30 + 1))) { - sr_err("strutil: %s: o malloc failed", __func__); + sr_err("%s: o malloc failed", __func__); return NULL; } - if (samplerate >= SR_GHZ(1)) - r = snprintf(o, 30, "%" PRIu64 " GHz", samplerate / 1000000000); - else if (samplerate >= SR_MHZ(1)) - r = snprintf(o, 30, "%" PRIu64 " MHz", samplerate / 1000000); - else if (samplerate >= SR_KHZ(1)) - r = snprintf(o, 30, "%" PRIu64 " kHz", samplerate / 1000); + if (frequency >= SR_GHZ(1)) + r = snprintf(o, 30, "%" PRIu64 " ns", frequency / 1000000000); + else if (frequency >= SR_MHZ(1)) + r = snprintf(o, 30, "%" PRIu64 " us", frequency / 1000000); + else if (frequency >= SR_KHZ(1)) + r = snprintf(o, 30, "%" PRIu64 " ms", frequency / 1000); else - r = snprintf(o, 30, "%" PRIu64 " Hz", samplerate); + r = snprintf(o, 30, "%" PRIu64 " s", frequency); if (r < 0) { /* Something went wrong... */ @@ -66,35 +152,33 @@ SR_API char *sr_samplerate_string(uint64_t samplerate) /** * Convert a numeric frequency value to the "natural" string representation - * of its period. + * of its voltage value. * - * E.g. a value of 3000000 would be converted to "3 us", 20000 to "50 ms". + * E.g. a value of 300000 would be converted to "300mV", 2 to "2V". * - * @param frequency The frequency in Hz. + * @param voltage The voltage represented as a rational number, with the + * denominator a divisor of 1V. * - * @return A g_try_malloc()ed string representation of the frequency value, + * @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. */ -SR_API char *sr_period_string(uint64_t frequency) +SR_API char *sr_voltage_string(struct sr_rational *voltage) { char *o; int r; - /* Allocate enough for a uint64_t as string + " ms". */ if (!(o = g_try_malloc0(30 + 1))) { - sr_err("strutil: %s: o malloc failed", __func__); + sr_err("%s: o malloc failed", __func__); return NULL; } - if (frequency >= SR_GHZ(1)) - r = snprintf(o, 30, "%" PRIu64 " ns", frequency / 1000000000); - else if (frequency >= SR_MHZ(1)) - r = snprintf(o, 30, "%" PRIu64 " us", frequency / 1000000); - else if (frequency >= SR_KHZ(1)) - r = snprintf(o, 30, "%" PRIu64 " ms", frequency / 1000); + if (voltage->q == 1000) + r = snprintf(o, 30, "%" PRIu64 "mV", voltage->p); + else if (voltage->q == 1) + r = snprintf(o, 30, "%" PRIu64 "V", voltage->p); else - r = snprintf(o, 30, "%" PRIu64 " s", frequency); + r = -1; if (r < 0) { /* Something went wrong... */ @@ -106,54 +190,67 @@ SR_API char *sr_period_string(uint64_t frequency) } /** - * TODO + * Parse a trigger specification string. * - * @param dev TODO - * @param triggerstring TODO + * @param sdi The device instance for which the trigger specification is + * 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 + * comma-separated. Triggers are specified in the form key=value, + * where the key is a probe number (or probe 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). + * Example: "1=r,sck=f,miso=0,7=c" * - * @return TODO + * @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, + * 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). */ -SR_API char **sr_parse_triggerstring(struct sr_dev *dev, +SR_API char **sr_parse_triggerstring(const struct sr_dev_inst *sdi, const char *triggerstring) { GSList *l; struct sr_probe *probe; int max_probes, probenum, i; - char **tokens, **triggerlist, *trigger, *tc, *trigger_types; + char **tokens, **triggerlist, *trigger, *tc; + const char *trigger_types; gboolean error; - max_probes = g_slist_length(dev->probes); + max_probes = g_slist_length(sdi->probes); error = FALSE; if (!(triggerlist = g_try_malloc0(max_probes * sizeof(char *)))) { - sr_err("session file: %s: metafile malloc failed", __func__); + sr_err("%s: triggerlist malloc failed", __func__); return NULL; } - tokens = g_strsplit(triggerstring, ",", max_probes); - trigger_types = dev->plugin->dev_info_get(0, SR_DI_TRIGGER_TYPES); - if (trigger_types == NULL) + if (sdi->driver->info_get(SR_DI_TRIGGER_TYPES, + (const void **)&trigger_types, sdi) != SR_OK) { + sr_err("%s: Device doesn't support any triggers.", __func__); return NULL; + } + tokens = g_strsplit(triggerstring, ",", max_probes); for (i = 0; tokens[i]; i++) { - if (tokens[i][0] < '0' || tokens[i][0] > '9') { - /* Named probe */ - probenum = 0; - for (l = dev->probes; l; l = l->next) { - probe = (struct sr_probe *)l->data; - if (probe->enabled - && !strncmp(probe->name, tokens[i], - strlen(probe->name))) { - probenum = probe->index; - break; - } + probenum = -1; + for (l = sdi->probes; l; l = l->next) { + probe = (struct sr_probe *)l->data; + if (probe->enabled + && !strncmp(probe->name, tokens[i], + strlen(probe->name))) { + probenum = probe->index; + break; } - } else { - probenum = strtol(tokens[i], NULL, 10); } - if (probenum < 1 || probenum > max_probes) { - sr_err("Invalid probe.\n"); + if (probenum < 0 || probenum >= max_probes) { + sr_err("Invalid probe."); error = TRUE; break; } @@ -161,14 +258,14 @@ SR_API char **sr_parse_triggerstring(struct sr_dev *dev, if ((trigger = strchr(tokens[i], '='))) { for (tc = ++trigger; *tc; tc++) { if (strchr(trigger_types, *tc) == NULL) { - sr_err("Unsupported trigger type " - "'%c'\n", *tc); + sr_err("Unsupported trigger " + "type '%c'.", *tc); error = TRUE; break; } } if (!error) - triggerlist[probenum - 1] = g_strdup(trigger); + triggerlist[probenum] = g_strdup(trigger); } } g_strfreev(tokens); @@ -251,16 +348,17 @@ SR_API int sr_parse_sizestring(const char *sizestring, uint64_t *size) * @param timestring A string containing a (decimal) time value. * @return The string's time value as uint64_t, in milliseconds. * - * TODO: Error handling. - * TODO: Add support for "m" (minutes) and others. - * TODO: picoseconds? - * TODO: Allow both lower-case and upper-case. + * @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. */ SR_API uint64_t sr_parse_timestring(const char *timestring) { uint64_t time_msec; char *s; + /* TODO: Error handling, logging. */ + time_msec = strtoull(timestring, &s, 10); if (time_msec == 0 && s == timestring) return 0; @@ -284,11 +382,66 @@ SR_API gboolean sr_parse_boolstring(const char *boolstr) if (!boolstr) return FALSE; - if (!g_strcasecmp(boolstr, "true") || - !g_strcasecmp(boolstr, "yes") || - !g_strcasecmp(boolstr, "on") || - !g_strcasecmp(boolstr, "1")) + if (!g_ascii_strncasecmp(boolstr, "true", 4) || + !g_ascii_strncasecmp(boolstr, "yes", 3) || + !g_ascii_strncasecmp(boolstr, "on", 2) || + !g_ascii_strncasecmp(boolstr, "1", 1)) return TRUE; return FALSE; } + +SR_API int sr_parse_period(const char *periodstr, struct sr_rational *r) +{ + char *s; + + r->p = strtoull(periodstr, &s, 10); + if (r->p == 0 && s == periodstr) + /* No digits found. */ + return SR_ERR_ARG; + + if (s && *s) { + while (*s == ' ') + s++; + if (!strcmp(s, "ns")) + r->q = 1000000000L; + else if (!strcmp(s, "us")) + r->q = 1000000; + else if (!strcmp(s, "ms")) + r->q = 1000; + else if (!strcmp(s, "s")) + r->q = 1; + else + /* Must have a time suffix. */ + return SR_ERR_ARG; + } + + return SR_OK; +} + + +SR_API int sr_parse_voltage(const char *voltstr, struct sr_rational *r) +{ + char *s; + + r->p = strtoull(voltstr, &s, 10); + if (r->p == 0 && s == voltstr) + /* No digits found. */ + return SR_ERR_ARG; + + if (s && *s) { + while (*s == ' ') + s++; + if (!strcasecmp(s, "mv")) + r->q = 1000L; + else if (!strcasecmp(s, "v")) + r->q = 1; + else + /* Must have a base suffix. */ + return SR_ERR_ARG; + } + + return SR_OK; +} + +/** @} */