2 * This file is part of the sigrok project.
4 * Copyright (C) 2010 Uwe Hermann <uwe@hermann-uwe.de>
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
25 #include "sigrok-internal.h"
28 * Convert a numeric samplerate value to its "natural" string representation.
30 * E.g. a value of 3000000 would be converted to "3 MHz", 20000 to "20 kHz",
31 * 31500 would become "31.5 kHz".
33 * @param samplerate The samplerate in Hz.
35 * @return A g_try_malloc()ed string representation of the samplerate value,
36 * or NULL upon errors. The caller is responsible to g_free() the
39 SR_API char *sr_samplerate_string(uint64_t samplerate)
42 uint64_t s = samplerate;
44 if ((s >= SR_GHZ(1)) && (s % SR_GHZ(1) == 0)) {
45 o = g_strdup_printf("%" PRIu64 " GHz", s / SR_GHZ(1));
46 } else if ((s >= SR_GHZ(1)) && (s % SR_GHZ(1) != 0)) {
47 o = g_strdup_printf("%" PRIu64 ".%" PRIu64 " GHz",
48 s / SR_GHZ(1), s % SR_GHZ(1));
49 } else if ((s >= SR_MHZ(1)) && (s % SR_MHZ(1) == 0)) {
50 o = g_strdup_printf("%" PRIu64 " MHz", s / SR_MHZ(1));
51 } else if ((s >= SR_MHZ(1)) && (s % SR_MHZ(1) != 0)) {
52 o = g_strdup_printf("%" PRIu64 ".%" PRIu64 " MHz",
53 s / SR_MHZ(1), s % SR_MHZ(1));
54 } else if ((s >= SR_KHZ(1)) && (s % SR_KHZ(1) == 0)) {
55 o = g_strdup_printf("%" PRIu64 " kHz", s / SR_KHZ(1));
56 } else if ((s >= SR_KHZ(1)) && (s % SR_KHZ(1) != 0)) {
57 o = g_strdup_printf("%" PRIu64 ".%" PRIu64 " kHz",
58 s / SR_KHZ(1), s % SR_KHZ(1));
60 o = g_strdup_printf("%" PRIu64 " Hz", s);
64 sr_err("strutil: %s: Error creating samplerate string.",
73 * Convert a numeric frequency value to the "natural" string representation
76 * E.g. a value of 3000000 would be converted to "3 us", 20000 to "50 ms".
78 * @param frequency The frequency in Hz.
80 * @return A g_try_malloc()ed string representation of the frequency value,
81 * or NULL upon errors. The caller is responsible to g_free() the
84 SR_API char *sr_period_string(uint64_t frequency)
89 /* Allocate enough for a uint64_t as string + " ms". */
90 if (!(o = g_try_malloc0(30 + 1))) {
91 sr_err("strutil: %s: o malloc failed", __func__);
95 if (frequency >= SR_GHZ(1))
96 r = snprintf(o, 30, "%" PRIu64 " ns", frequency / 1000000000);
97 else if (frequency >= SR_MHZ(1))
98 r = snprintf(o, 30, "%" PRIu64 " us", frequency / 1000000);
99 else if (frequency >= SR_KHZ(1))
100 r = snprintf(o, 30, "%" PRIu64 " ms", frequency / 1000);
102 r = snprintf(o, 30, "%" PRIu64 " s", frequency);
105 /* Something went wrong... */
114 * Convert a numeric frequency value to the "natural" string representation
115 * of its voltage value.
117 * E.g. a value of 300000 would be converted to "300mV", 2 to "2V".
119 * @param voltage The voltage represented as a rational number, with the
120 * denominator a divisor of 1V.
122 * @return A g_try_malloc()ed string representation of the voltage value,
123 * or NULL upon errors. The caller is responsible to g_free() the
126 SR_API char *sr_voltage_string(struct sr_rational *voltage)
131 if (!(o = g_try_malloc0(30 + 1))) {
132 sr_err("strutil: %s: o malloc failed", __func__);
136 if (voltage->q == 1000)
137 r = snprintf(o, 30, "%" PRIu64 "mV", voltage->p);
138 else if (voltage->q == 1)
139 r = snprintf(o, 30, "%" PRIu64 "V", voltage->p);
144 /* Something went wrong... */
153 * Parse a trigger specification string.
155 * @param dev The device for which the trigger specification is intended.
156 * @param triggerstring The string containing the trigger specification for
157 * one or more probes of this device. Entries for multiple probes are
158 * comma-separated. Triggers are specified in the form key=value,
159 * where the key is a probe number (or probe name) and the value is
160 * the requested trigger type. Valid trigger types currently
161 * include 'r' (rising edge), 'f' (falling edge), 'c' (any pin value
162 * change), '0' (low value), or '1' (high value).
163 * Example: "1=r,sck=f,miso=0,7=c"
165 * @return Pointer to a list of trigger types (strings), or NULL upon errors.
166 * The pointer list (if non-NULL) has as many entries as the
167 * respective device has probes (all physically available probes,
168 * not just enabled ones). Entries of the list which don't have
169 * a trigger value set in 'triggerstring' are NULL, the other entries
170 * contain the respective trigger type which is requested for the
171 * respective probe (e.g. "r", "c", and so on).
173 SR_API char **sr_parse_triggerstring(struct sr_dev *dev,
174 const char *triggerstring)
177 struct sr_probe *probe;
178 int max_probes, probenum, i;
179 char **tokens, **triggerlist, *trigger, *tc;
180 const char *trigger_types;
183 max_probes = g_slist_length(dev->probes);
186 if (!(triggerlist = g_try_malloc0(max_probes * sizeof(char *)))) {
187 sr_err("strutil: %s: triggerlist malloc failed", __func__);
191 tokens = g_strsplit(triggerstring, ",", max_probes);
193 trigger_types = dev->driver->dev_info_get(0, SR_DI_TRIGGER_TYPES);
194 if (!trigger_types) {
195 sr_err("strutil: %s: Device doesn't support any triggers.",
200 for (i = 0; tokens[i]; i++) {
201 if (tokens[i][0] < '0' || tokens[i][0] > '9') {
204 for (l = dev->probes; l; l = l->next) {
205 probe = (struct sr_probe *)l->data;
207 && !strncmp(probe->name, tokens[i],
208 strlen(probe->name))) {
209 probenum = probe->index;
214 probenum = strtol(tokens[i], NULL, 10);
217 if (probenum < 1 || probenum > max_probes) {
218 sr_err("strutil: Invalid probe (%d).", probenum);
223 if ((trigger = strchr(tokens[i], '='))) {
224 for (tc = ++trigger; *tc; tc++) {
225 if (strchr(trigger_types, *tc) == NULL) {
226 sr_err("strutil: Unsupported trigger "
233 triggerlist[probenum - 1] = g_strdup(trigger);
239 for (i = 0; i < max_probes; i++)
240 g_free(triggerlist[i]);
249 * Convert a "natural" string representation of a size value to uint64_t.
251 * E.g. a value of "3k" or "3 K" would be converted to 3000, a value
252 * of "15M" would be converted to 15000000.
254 * Value representations other than decimal (such as hex or octal) are not
255 * supported. Only 'k' (kilo), 'm' (mega), 'g' (giga) suffixes are supported.
256 * Spaces (but not other whitespace) between value and suffix are allowed.
258 * @param sizestring A string containing a (decimal) size value.
259 * @param size Pointer to uint64_t which will contain the string's size value.
261 * @return SR_OK upon success, SR_ERR upon errors.
263 SR_API int sr_parse_sizestring(const char *sizestring, uint64_t *size)
265 int multiplier, done;
268 *size = strtoull(sizestring, &s, 10);
271 while (s && *s && multiplier == 0 && !done) {
277 multiplier = SR_KHZ(1);
281 multiplier = SR_MHZ(1);
285 multiplier = SR_GHZ(1);
296 if (*s && strcasecmp(s, "Hz"))
303 * Convert a "natural" string representation of a time value to an
304 * uint64_t value in milliseconds.
306 * E.g. a value of "3s" or "3 s" would be converted to 3000, a value
307 * of "15ms" would be converted to 15.
309 * Value representations other than decimal (such as hex or octal) are not
310 * supported. Only lower-case "s" and "ms" time suffixes are supported.
311 * Spaces (but not other whitespace) between value and suffix are allowed.
313 * @param timestring A string containing a (decimal) time value.
314 * @return The string's time value as uint64_t, in milliseconds.
316 * TODO: Error handling.
317 * TODO: Add support for "m" (minutes) and others.
319 * TODO: Allow both lower-case and upper-case.
321 SR_API uint64_t sr_parse_timestring(const char *timestring)
326 time_msec = strtoull(timestring, &s, 10);
327 if (time_msec == 0 && s == timestring)
335 else if (!strcmp(s, "ms"))
344 SR_API gboolean sr_parse_boolstring(const char *boolstr)
349 if (!g_ascii_strncasecmp(boolstr, "true", 4) ||
350 !g_ascii_strncasecmp(boolstr, "yes", 3) ||
351 !g_ascii_strncasecmp(boolstr, "on", 2) ||
352 !g_ascii_strncasecmp(boolstr, "1", 1))
358 SR_API int sr_parse_period(const char *periodstr, struct sr_rational *r)
362 r->p = strtoull(periodstr, &s, 10);
363 if (r->p == 0 && s == periodstr)
364 /* No digits found. */
370 if (!strcmp(s, "ns"))
372 else if (!strcmp(s, "us"))
374 else if (!strcmp(s, "ms"))
376 else if (!strcmp(s, "s"))
379 /* Must have a time suffix. */
387 SR_API int sr_parse_voltage(const char *voltstr, struct sr_rational *r)
391 r->p = strtoull(voltstr, &s, 10);
392 if (r->p == 0 && s == voltstr)
393 /* No digits found. */
399 if (!strcasecmp(s, "mv"))
401 else if (!strcasecmp(s, "v"))
404 /* Must have a base suffix. */