X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=strutil.c;h=014c2c2ce16538dbacc1d72bd7276fb73f9c04c1;hb=bf978d355345a7cc3ae7dc6199cc25952aaa182f;hp=cd2ab449ec75967bcdc1fe4a72e83a6d3952125d;hpb=66410a8617185da7abf4ca21da99e934b22351bb;p=libsigrok.git diff --git a/strutil.c b/strutil.c index cd2ab449..014c2c2c 100644 --- a/strutil.c +++ b/strutil.c @@ -27,33 +27,42 @@ /** * 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. - * @return A malloc()ed string representation of the samplerate value, - * or NULL upon errors. The caller is responsible to free() the memory. + * + * @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. */ -char *sr_samplerate_string(uint64_t samplerate) +SR_API char *sr_samplerate_string(uint64_t samplerate) { char *o; - int r; - - o = malloc(30 + 1); /* Enough for a uint64_t as string + " GHz". */ - if (!o) - return NULL; + uint64_t s = samplerate; - 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); - else - r = snprintf(o, 30, "%" PRIu64 " Hz", samplerate); + if ((s >= SR_GHZ(1)) && (s % SR_GHZ(1) == 0)) { + o = g_strdup_printf("%" PRIu64 " GHz", s / SR_GHZ(1)); + } else if ((s >= SR_GHZ(1)) && (s % SR_GHZ(1) != 0)) { + o = g_strdup_printf("%" PRIu64 ".%" PRIu64 " GHz", + s / SR_GHZ(1), s % SR_GHZ(1)); + } else if ((s >= SR_MHZ(1)) && (s % SR_MHZ(1) == 0)) { + o = g_strdup_printf("%" PRIu64 " MHz", s / SR_MHZ(1)); + } else if ((s >= SR_MHZ(1)) && (s % SR_MHZ(1) != 0)) { + o = g_strdup_printf("%" PRIu64 ".%" PRIu64 " MHz", + s / SR_MHZ(1), s % SR_MHZ(1)); + } else if ((s >= SR_KHZ(1)) && (s % SR_KHZ(1) == 0)) { + o = g_strdup_printf("%" PRIu64 " kHz", s / SR_KHZ(1)); + } else if ((s >= SR_KHZ(1)) && (s % SR_KHZ(1) != 0)) { + o = g_strdup_printf("%" PRIu64 ".%" PRIu64 " kHz", + s / SR_KHZ(1), s % SR_KHZ(1)); + } else { + o = g_strdup_printf("%" PRIu64 " Hz", s); + } - if (r < 0) { - /* Something went wrong... */ - free(o); + if (!o) { + sr_err("strutil: %s: Error creating samplerate string.", + __func__); return NULL; } @@ -67,17 +76,21 @@ char *sr_samplerate_string(uint64_t samplerate) * E.g. a value of 3000000 would be converted to "3 us", 20000 to "50 ms". * * @param frequency The frequency in Hz. - * @return A malloc()ed string representation of the frequency value, - * or NULL upon errors. The caller is responsible to free() the memory. + * + * @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. */ -char *sr_period_string(uint64_t frequency) +SR_API char *sr_period_string(uint64_t frequency) { char *o; int r; - o = malloc(30 + 1); /* Enough for a uint64_t as string + " ms". */ - if (!o) + /* Allocate enough for a uint64_t as string + " ms". */ + if (!(o = g_try_malloc0(30 + 1))) { + sr_err("strutil: %s: o malloc failed", __func__); return NULL; + } if (frequency >= SR_GHZ(1)) r = snprintf(o, 30, "%" PRIu64 " ns", frequency / 1000000000); @@ -90,7 +103,7 @@ char *sr_period_string(uint64_t frequency) if (r < 0) { /* Something went wrong... */ - free(o); + g_free(o); return NULL; } @@ -98,14 +111,28 @@ char *sr_period_string(uint64_t frequency) } /** - * TODO + * Parse a trigger specification string. * - * @param device TODO - * @param triggerstring TODO - * @return TODO + * @param dev The device for which the trigger specification is intended. + * @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 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). */ -char **sr_parse_triggerstring(struct sr_device *device, - const char *triggerstring) +SR_API char **sr_parse_triggerstring(struct sr_dev *dev, + const char *triggerstring) { GSList *l; struct sr_probe *probe; @@ -113,24 +140,28 @@ char **sr_parse_triggerstring(struct sr_device *device, char **tokens, **triggerlist, *trigger, *tc, *trigger_types; gboolean error; - max_probes = g_slist_length(device->probes); + max_probes = g_slist_length(dev->probes); error = FALSE; if (!(triggerlist = g_try_malloc0(max_probes * sizeof(char *)))) { - sr_err("session file: %s: metafile malloc failed", __func__); + sr_err("strutil: %s: triggerlist malloc failed", __func__); return NULL; } tokens = g_strsplit(triggerstring, ",", max_probes); - trigger_types = device->plugin->get_device_info(0, SR_DI_TRIGGER_TYPES); - if (trigger_types == NULL) + + trigger_types = dev->driver->dev_info_get(0, SR_DI_TRIGGER_TYPES); + if (!trigger_types) { + sr_err("strutil: %s: Device doesn't support any triggers.", + __func__); return NULL; + } for (i = 0; tokens[i]; i++) { if (tokens[i][0] < '0' || tokens[i][0] > '9') { /* Named probe */ probenum = 0; - for (l = device->probes; l; l = l->next) { + for (l = dev->probes; l; l = l->next) { probe = (struct sr_probe *)l->data; if (probe->enabled && !strncmp(probe->name, tokens[i], @@ -144,7 +175,7 @@ char **sr_parse_triggerstring(struct sr_device *device, } if (probenum < 1 || probenum > max_probes) { - sr_err("Invalid probe.\n"); + sr_err("strutil: Invalid probe (%d).\n", probenum); error = TRUE; break; } @@ -152,8 +183,8 @@ char **sr_parse_triggerstring(struct sr_device *device, 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("strutil: Unsupported trigger " + "type '%c'.\n", *tc); error = TRUE; break; } @@ -186,10 +217,10 @@ char **sr_parse_triggerstring(struct sr_device *device, * * @param sizestring A string containing a (decimal) size value. * @param size Pointer to uint64_t which will contain the string's size value. - * @return SR_OK or error code * + * @return SR_OK upon success, SR_ERR upon errors. */ -int sr_parse_sizestring(const char *sizestring, uint64_t *size) +SR_API int sr_parse_sizestring(const char *sizestring, uint64_t *size) { int multiplier, done; char *s; @@ -247,7 +278,7 @@ int sr_parse_sizestring(const char *sizestring, uint64_t *size) * TODO: picoseconds? * TODO: Allow both lower-case and upper-case. */ -uint64_t sr_parse_timestring(const char *timestring) +SR_API uint64_t sr_parse_timestring(const char *timestring) { uint64_t time_msec; char *s; @@ -270,15 +301,15 @@ uint64_t sr_parse_timestring(const char *timestring) return time_msec; } -gboolean sr_parse_boolstring(const char *boolstr) +SR_API gboolean sr_parse_boolstring(const char *boolstr) { if (!boolstr) return FALSE; - if (!g_strcasecmp(boolstr, "true") || + if (!g_strcasecmp(boolstr, "true") || !g_strcasecmp(boolstr, "yes") || !g_strcasecmp(boolstr, "on") || - !g_strcasecmp(boolstr, "1")) + !g_strcasecmp(boolstr, "1")) return TRUE; return FALSE;