]>
Commit | Line | Data |
---|---|---|
25e7d9b1 | 1 | /* |
50985c20 | 2 | * This file is part of the libsigrok project. |
25e7d9b1 UH |
3 | * |
4 | * Copyright (C) 2010 Uwe Hermann <uwe@hermann-uwe.de> | |
5 | * | |
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. | |
10 | * | |
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. | |
15 | * | |
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 | |
19 | */ | |
20 | ||
21 | #include <stdint.h> | |
22 | #include <stdlib.h> | |
23 | #include <string.h> | |
45c59c8b BV |
24 | #include "libsigrok.h" |
25 | #include "libsigrok-internal.h" | |
25e7d9b1 | 26 | |
29a27196 UH |
27 | /* Message logging helpers with subsystem-specific prefix string. */ |
28 | #define LOG_PREFIX "strutil: " | |
29 | #define sr_log(l, s, args...) sr_log(l, LOG_PREFIX s, ## args) | |
30 | #define sr_spew(s, args...) sr_spew(LOG_PREFIX s, ## args) | |
31 | #define sr_dbg(s, args...) sr_dbg(LOG_PREFIX s, ## args) | |
32 | #define sr_info(s, args...) sr_info(LOG_PREFIX s, ## args) | |
33 | #define sr_warn(s, args...) sr_warn(LOG_PREFIX s, ## args) | |
34 | #define sr_err(s, args...) sr_err(LOG_PREFIX s, ## args) | |
a885ce3e | 35 | |
393fb9cb UH |
36 | /** |
37 | * @file | |
38 | * | |
39 | * Helper functions for handling or converting libsigrok-related strings. | |
40 | */ | |
41 | ||
7b870c38 UH |
42 | /** |
43 | * @defgroup grp_strutil String utilities | |
44 | * | |
45 | * Helper functions for handling or converting libsigrok-related strings. | |
46 | * | |
47 | * @{ | |
48 | */ | |
49 | ||
25e7d9b1 | 50 | /** |
b07b42f3 UH |
51 | * Convert a numeric value value to its "natural" string representation |
52 | * in SI units. | |
25e7d9b1 | 53 | * |
4cc9aea1 JH |
54 | * E.g. a value of 3000000, with units set to "W", would be converted |
55 | * to "3 MW", 20000 to "20 kW", 31500 would become "31.5 kW". | |
25e7d9b1 | 56 | * |
4cc9aea1 JH |
57 | * @param x The value to convert. |
58 | * @param unit The unit to append to the string, or NULL if the string | |
59 | * has no units. | |
44dae539 | 60 | * |
133a37bf UH |
61 | * @return A g_try_malloc()ed string representation of the samplerate value, |
62 | * or NULL upon errors. The caller is responsible to g_free() the | |
63 | * memory. | |
25e7d9b1 | 64 | */ |
4cc9aea1 | 65 | SR_API char *sr_si_string_u64(uint64_t x, const char *unit) |
25e7d9b1 | 66 | { |
094e6b81 PS |
67 | uint8_t i; |
68 | uint64_t quot, divisor[] = { | |
b07b42f3 UH |
69 | SR_HZ(1), SR_KHZ(1), SR_MHZ(1), SR_GHZ(1), |
70 | SR_GHZ(1000), SR_GHZ(1000 * 1000), SR_GHZ(1000 * 1000 * 1000), | |
094e6b81 PS |
71 | }; |
72 | const char *p, prefix[] = "\0kMGTPE"; | |
73 | char fmt[8], fract[20] = "", *f; | |
74 | ||
a885ce3e | 75 | if (unit == NULL) |
4cc9aea1 | 76 | unit = ""; |
25e7d9b1 | 77 | |
094e6b81 PS |
78 | for (i = 0; (quot = x / divisor[i]) >= 1000; i++); |
79 | ||
80 | if (i) { | |
81 | sprintf(fmt, ".%%0%dlu", i * 3); | |
82 | f = fract + sprintf(fract, fmt, x % divisor[i]) - 1; | |
83 | ||
84 | while (f >= fract && strchr("0.", *f)) | |
85 | *f-- = 0; | |
133a37bf | 86 | } |
25e7d9b1 | 87 | |
094e6b81 PS |
88 | p = prefix + i; |
89 | ||
90 | return g_strdup_printf("%" PRIu64 "%s %.1s%s", quot, fract, p, unit); | |
4cc9aea1 | 91 | } |
25e7d9b1 | 92 | |
4cc9aea1 JH |
93 | /** |
94 | * Convert a numeric samplerate value to its "natural" string representation. | |
95 | * | |
96 | * E.g. a value of 3000000 would be converted to "3 MHz", 20000 to "20 kHz", | |
97 | * 31500 would become "31.5 kHz". | |
98 | * | |
99 | * @param samplerate The samplerate in Hz. | |
100 | * | |
101 | * @return A g_try_malloc()ed string representation of the samplerate value, | |
102 | * or NULL upon errors. The caller is responsible to g_free() the | |
103 | * memory. | |
104 | */ | |
105 | SR_API char *sr_samplerate_string(uint64_t samplerate) | |
106 | { | |
107 | return sr_si_string_u64(samplerate, "Hz"); | |
25e7d9b1 | 108 | } |
2a3f9541 | 109 | |
2a3f9541 | 110 | /** |
dfcc0bf9 | 111 | * Convert a numeric frequency value to the "natural" string representation |
2a3f9541 BV |
112 | * of its period. |
113 | * | |
2507648e | 114 | * E.g. a value of 3000000 would be converted to "3 us", 20000 to "50 ms". |
2a3f9541 BV |
115 | * |
116 | * @param frequency The frequency in Hz. | |
44dae539 | 117 | * |
133a37bf UH |
118 | * @return A g_try_malloc()ed string representation of the frequency value, |
119 | * or NULL upon errors. The caller is responsible to g_free() the | |
120 | * memory. | |
2a3f9541 | 121 | */ |
1a081ca6 | 122 | SR_API char *sr_period_string(uint64_t frequency) |
2a3f9541 BV |
123 | { |
124 | char *o; | |
125 | int r; | |
126 | ||
133a37bf UH |
127 | /* Allocate enough for a uint64_t as string + " ms". */ |
128 | if (!(o = g_try_malloc0(30 + 1))) { | |
a885ce3e | 129 | sr_err("%s: o malloc failed", __func__); |
2a3f9541 | 130 | return NULL; |
133a37bf | 131 | } |
2a3f9541 | 132 | |
59df0c77 | 133 | if (frequency >= SR_GHZ(1)) |
2a3f9541 | 134 | r = snprintf(o, 30, "%" PRIu64 " ns", frequency / 1000000000); |
59df0c77 | 135 | else if (frequency >= SR_MHZ(1)) |
2507648e | 136 | r = snprintf(o, 30, "%" PRIu64 " us", frequency / 1000000); |
59df0c77 | 137 | else if (frequency >= SR_KHZ(1)) |
2a3f9541 BV |
138 | r = snprintf(o, 30, "%" PRIu64 " ms", frequency / 1000); |
139 | else | |
140 | r = snprintf(o, 30, "%" PRIu64 " s", frequency); | |
141 | ||
142 | if (r < 0) { | |
143 | /* Something went wrong... */ | |
133a37bf | 144 | g_free(o); |
2a3f9541 BV |
145 | return NULL; |
146 | } | |
147 | ||
148 | return o; | |
149 | } | |
40f5ddac | 150 | |
79afc8ca | 151 | /** |
e0e15067 BV |
152 | * Convert a numeric voltage value to the "natural" string representation |
153 | * of its voltage value. The voltage is specified as a rational number's | |
154 | * numerator and denominator. | |
79afc8ca BV |
155 | * |
156 | * E.g. a value of 300000 would be converted to "300mV", 2 to "2V". | |
157 | * | |
e0e15067 BV |
158 | * @param v_p The voltage numerator. |
159 | * @param v_q The voltage denominator. | |
79afc8ca BV |
160 | * |
161 | * @return A g_try_malloc()ed string representation of the voltage value, | |
162 | * or NULL upon errors. The caller is responsible to g_free() the | |
163 | * memory. | |
164 | */ | |
e0e15067 | 165 | SR_API char *sr_voltage_string(uint64_t v_p, uint64_t v_q) |
79afc8ca | 166 | { |
79afc8ca | 167 | int r; |
d5a669a9 | 168 | char *o; |
79afc8ca BV |
169 | |
170 | if (!(o = g_try_malloc0(30 + 1))) { | |
a885ce3e | 171 | sr_err("%s: o malloc failed", __func__); |
79afc8ca BV |
172 | return NULL; |
173 | } | |
174 | ||
e0e15067 BV |
175 | if (v_q == 1000) |
176 | r = snprintf(o, 30, "%" PRIu64 "mV", v_p); | |
177 | else if (v_q == 1) | |
178 | r = snprintf(o, 30, "%" PRIu64 "V", v_p); | |
79afc8ca | 179 | else |
e0e15067 | 180 | r = snprintf(o, 30, "%gV", (float)v_p / (float)v_q); |
79afc8ca BV |
181 | |
182 | if (r < 0) { | |
183 | /* Something went wrong... */ | |
184 | g_free(o); | |
185 | return NULL; | |
186 | } | |
187 | ||
188 | return o; | |
189 | } | |
190 | ||
dfcc0bf9 | 191 | /** |
bf978d35 | 192 | * Parse a trigger specification string. |
dfcc0bf9 | 193 | * |
9c5332d2 UH |
194 | * @param sdi The device instance for which the trigger specification is |
195 | * intended. Must not be NULL. Also, sdi->driver and | |
196 | * sdi->driver->info_get must not be NULL. | |
bf978d35 UH |
197 | * @param triggerstring The string containing the trigger specification for |
198 | * one or more probes of this device. Entries for multiple probes are | |
199 | * comma-separated. Triggers are specified in the form key=value, | |
200 | * where the key is a probe number (or probe name) and the value is | |
201 | * the requested trigger type. Valid trigger types currently | |
202 | * include 'r' (rising edge), 'f' (falling edge), 'c' (any pin value | |
203 | * change), '0' (low value), or '1' (high value). | |
204 | * Example: "1=r,sck=f,miso=0,7=c" | |
44dae539 | 205 | * |
bf978d35 UH |
206 | * @return Pointer to a list of trigger types (strings), or NULL upon errors. |
207 | * The pointer list (if non-NULL) has as many entries as the | |
208 | * respective device has probes (all physically available probes, | |
209 | * not just enabled ones). Entries of the list which don't have | |
210 | * a trigger value set in 'triggerstring' are NULL, the other entries | |
211 | * contain the respective trigger type which is requested for the | |
212 | * respective probe (e.g. "r", "c", and so on). | |
dfcc0bf9 | 213 | */ |
92ae7984 | 214 | SR_API char **sr_parse_triggerstring(const struct sr_dev_inst *sdi, |
1a081ca6 | 215 | const char *triggerstring) |
40f5ddac BV |
216 | { |
217 | GSList *l; | |
003595ac | 218 | GVariant *gvar; |
1afe8989 | 219 | struct sr_probe *probe; |
40f5ddac | 220 | int max_probes, probenum, i; |
b7f578be JH |
221 | char **tokens, **triggerlist, *trigger, *tc; |
222 | const char *trigger_types; | |
40f5ddac BV |
223 | gboolean error; |
224 | ||
92ae7984 | 225 | max_probes = g_slist_length(sdi->probes); |
40f5ddac | 226 | error = FALSE; |
b53738ba UH |
227 | |
228 | if (!(triggerlist = g_try_malloc0(max_probes * sizeof(char *)))) { | |
a885ce3e | 229 | sr_err("%s: triggerlist malloc failed", __func__); |
b53738ba UH |
230 | return NULL; |
231 | } | |
232 | ||
8f996b89 ML |
233 | if (sdi->driver->config_list(SR_CONF_TRIGGER_TYPE, |
234 | &gvar, sdi, NULL) != SR_OK) { | |
a885ce3e | 235 | sr_err("%s: Device doesn't support any triggers.", __func__); |
40f5ddac | 236 | return NULL; |
bf978d35 | 237 | } |
003595ac | 238 | trigger_types = g_variant_get_string(gvar, NULL); |
40f5ddac | 239 | |
31fc1fbc | 240 | tokens = g_strsplit(triggerstring, ",", max_probes); |
40f5ddac | 241 | for (i = 0; tokens[i]; i++) { |
17ff1124 BV |
242 | probenum = -1; |
243 | for (l = sdi->probes; l; l = l->next) { | |
244 | probe = (struct sr_probe *)l->data; | |
245 | if (probe->enabled | |
246 | && !strncmp(probe->name, tokens[i], | |
247 | strlen(probe->name))) { | |
248 | probenum = probe->index; | |
249 | break; | |
40f5ddac | 250 | } |
40f5ddac BV |
251 | } |
252 | ||
31fc1fbc | 253 | if (probenum < 0 || probenum >= max_probes) { |
a885ce3e | 254 | sr_err("Invalid probe."); |
40f5ddac BV |
255 | error = TRUE; |
256 | break; | |
257 | } | |
258 | ||
259 | if ((trigger = strchr(tokens[i], '='))) { | |
260 | for (tc = ++trigger; *tc; tc++) { | |
261 | if (strchr(trigger_types, *tc) == NULL) { | |
a885ce3e | 262 | sr_err("Unsupported trigger " |
0aeb0ccd | 263 | "type '%c'.", *tc); |
40f5ddac BV |
264 | error = TRUE; |
265 | break; | |
266 | } | |
267 | } | |
268 | if (!error) | |
31fc1fbc | 269 | triggerlist[probenum] = g_strdup(trigger); |
40f5ddac BV |
270 | } |
271 | } | |
272 | g_strfreev(tokens); | |
003595ac | 273 | g_variant_unref(gvar); |
40f5ddac BV |
274 | |
275 | if (error) { | |
276 | for (i = 0; i < max_probes; i++) | |
66410a86 | 277 | g_free(triggerlist[i]); |
40f5ddac BV |
278 | g_free(triggerlist); |
279 | triggerlist = NULL; | |
280 | } | |
281 | ||
282 | return triggerlist; | |
283 | } | |
284 | ||
dfcc0bf9 UH |
285 | /** |
286 | * Convert a "natural" string representation of a size value to uint64_t. | |
287 | * | |
288 | * E.g. a value of "3k" or "3 K" would be converted to 3000, a value | |
289 | * of "15M" would be converted to 15000000. | |
290 | * | |
291 | * Value representations other than decimal (such as hex or octal) are not | |
292 | * supported. Only 'k' (kilo), 'm' (mega), 'g' (giga) suffixes are supported. | |
293 | * Spaces (but not other whitespace) between value and suffix are allowed. | |
294 | * | |
295 | * @param sizestring A string containing a (decimal) size value. | |
f64c1414 | 296 | * @param size Pointer to uint64_t which will contain the string's size value. |
dfcc0bf9 | 297 | * |
44dae539 | 298 | * @return SR_OK upon success, SR_ERR upon errors. |
dfcc0bf9 | 299 | */ |
1a081ca6 | 300 | SR_API int sr_parse_sizestring(const char *sizestring, uint64_t *size) |
40f5ddac | 301 | { |
f64c1414 | 302 | int multiplier, done; |
40f5ddac BV |
303 | char *s; |
304 | ||
f64c1414 | 305 | *size = strtoull(sizestring, &s, 10); |
40f5ddac | 306 | multiplier = 0; |
f64c1414 BV |
307 | done = FALSE; |
308 | while (s && *s && multiplier == 0 && !done) { | |
40f5ddac BV |
309 | switch (*s) { |
310 | case ' ': | |
311 | break; | |
312 | case 'k': | |
313 | case 'K': | |
59df0c77 | 314 | multiplier = SR_KHZ(1); |
40f5ddac BV |
315 | break; |
316 | case 'm': | |
317 | case 'M': | |
59df0c77 | 318 | multiplier = SR_MHZ(1); |
40f5ddac BV |
319 | break; |
320 | case 'g': | |
321 | case 'G': | |
59df0c77 | 322 | multiplier = SR_GHZ(1); |
40f5ddac BV |
323 | break; |
324 | default: | |
f64c1414 BV |
325 | done = TRUE; |
326 | s--; | |
40f5ddac BV |
327 | } |
328 | s++; | |
329 | } | |
330 | if (multiplier > 0) | |
f64c1414 | 331 | *size *= multiplier; |
40f5ddac | 332 | |
f64c1414 BV |
333 | if (*s && strcasecmp(s, "Hz")) |
334 | return SR_ERR; | |
335 | ||
336 | return SR_OK; | |
40f5ddac BV |
337 | } |
338 | ||
dfcc0bf9 UH |
339 | /** |
340 | * Convert a "natural" string representation of a time value to an | |
341 | * uint64_t value in milliseconds. | |
342 | * | |
343 | * E.g. a value of "3s" or "3 s" would be converted to 3000, a value | |
344 | * of "15ms" would be converted to 15. | |
345 | * | |
346 | * Value representations other than decimal (such as hex or octal) are not | |
347 | * supported. Only lower-case "s" and "ms" time suffixes are supported. | |
348 | * Spaces (but not other whitespace) between value and suffix are allowed. | |
349 | * | |
350 | * @param timestring A string containing a (decimal) time value. | |
351 | * @return The string's time value as uint64_t, in milliseconds. | |
352 | * | |
6b2d8d3e UH |
353 | * @todo Add support for "m" (minutes) and others. |
354 | * @todo Add support for picoseconds? | |
355 | * @todo Allow both lower-case and upper-case? If no, document it. | |
dfcc0bf9 | 356 | */ |
1a081ca6 | 357 | SR_API uint64_t sr_parse_timestring(const char *timestring) |
40f5ddac BV |
358 | { |
359 | uint64_t time_msec; | |
360 | char *s; | |
361 | ||
6b2d8d3e UH |
362 | /* TODO: Error handling, logging. */ |
363 | ||
40f5ddac BV |
364 | time_msec = strtoull(timestring, &s, 10); |
365 | if (time_msec == 0 && s == timestring) | |
366 | return 0; | |
367 | ||
368 | if (s && *s) { | |
369 | while (*s == ' ') | |
370 | s++; | |
371 | if (!strcmp(s, "s")) | |
372 | time_msec *= 1000; | |
373 | else if (!strcmp(s, "ms")) | |
374 | ; /* redundant */ | |
375 | else | |
376 | return 0; | |
377 | } | |
378 | ||
379 | return time_msec; | |
380 | } | |
4d436e71 | 381 | |
1a081ca6 | 382 | SR_API gboolean sr_parse_boolstring(const char *boolstr) |
4d436e71 GM |
383 | { |
384 | if (!boolstr) | |
385 | return FALSE; | |
386 | ||
993526f8 BV |
387 | if (!g_ascii_strncasecmp(boolstr, "true", 4) || |
388 | !g_ascii_strncasecmp(boolstr, "yes", 3) || | |
389 | !g_ascii_strncasecmp(boolstr, "on", 2) || | |
390 | !g_ascii_strncasecmp(boolstr, "1", 1)) | |
4d436e71 GM |
391 | return TRUE; |
392 | ||
393 | return FALSE; | |
394 | } | |
76f4c610 | 395 | |
76e107d6 | 396 | SR_API int sr_parse_period(const char *periodstr, uint64_t *p, uint64_t *q) |
76f4c610 BV |
397 | { |
398 | char *s; | |
399 | ||
76e107d6 BV |
400 | *p = strtoull(periodstr, &s, 10); |
401 | if (*p == 0 && s == periodstr) | |
76f4c610 BV |
402 | /* No digits found. */ |
403 | return SR_ERR_ARG; | |
404 | ||
405 | if (s && *s) { | |
406 | while (*s == ' ') | |
407 | s++; | |
8c012adb | 408 | if (!strcmp(s, "fs")) |
76e107d6 | 409 | *q = 1000000000000000ULL; |
8c012adb | 410 | else if (!strcmp(s, "ps")) |
76e107d6 | 411 | *q = 1000000000000ULL; |
8c012adb | 412 | else if (!strcmp(s, "ns")) |
76e107d6 | 413 | *q = 1000000000ULL; |
76f4c610 | 414 | else if (!strcmp(s, "us")) |
76e107d6 | 415 | *q = 1000000; |
76f4c610 | 416 | else if (!strcmp(s, "ms")) |
76e107d6 | 417 | *q = 1000; |
76f4c610 | 418 | else if (!strcmp(s, "s")) |
76e107d6 | 419 | *q = 1; |
76f4c610 BV |
420 | else |
421 | /* Must have a time suffix. */ | |
422 | return SR_ERR_ARG; | |
423 | } | |
424 | ||
425 | return SR_OK; | |
426 | } | |
427 | ||
428 | ||
76e107d6 | 429 | SR_API int sr_parse_voltage(const char *voltstr, uint64_t *p, uint64_t *q) |
79afc8ca BV |
430 | { |
431 | char *s; | |
432 | ||
76e107d6 BV |
433 | *p = strtoull(voltstr, &s, 10); |
434 | if (*p == 0 && s == voltstr) | |
79afc8ca BV |
435 | /* No digits found. */ |
436 | return SR_ERR_ARG; | |
437 | ||
438 | if (s && *s) { | |
439 | while (*s == ' ') | |
440 | s++; | |
441 | if (!strcasecmp(s, "mv")) | |
76e107d6 | 442 | *q = 1000L; |
79afc8ca | 443 | else if (!strcasecmp(s, "v")) |
76e107d6 | 444 | *q = 1; |
79afc8ca BV |
445 | else |
446 | /* Must have a base suffix. */ | |
447 | return SR_ERR_ARG; | |
448 | } | |
449 | ||
450 | return SR_OK; | |
451 | } | |
452 | ||
7b870c38 | 453 | /** @} */ |