]>
Commit | Line | Data |
---|---|---|
25e7d9b1 UH |
1 | /* |
2 | * This file is part of the sigrok project. | |
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 UH |
26 | |
27 | /** | |
28 | * Convert a numeric samplerate value to its "natural" string representation. | |
29 | * | |
c69e35a7 UH |
30 | * E.g. a value of 3000000 would be converted to "3 MHz", 20000 to "20 kHz", |
31 | * 31500 would become "31.5 kHz". | |
25e7d9b1 UH |
32 | * |
33 | * @param samplerate The samplerate in Hz. | |
44dae539 | 34 | * |
133a37bf UH |
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 | |
37 | * memory. | |
25e7d9b1 | 38 | */ |
1a081ca6 | 39 | SR_API char *sr_samplerate_string(uint64_t samplerate) |
25e7d9b1 UH |
40 | { |
41 | char *o; | |
c69e35a7 | 42 | uint64_t s = samplerate; |
25e7d9b1 | 43 | |
c69e35a7 UH |
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)); | |
59 | } else { | |
60 | o = g_strdup_printf("%" PRIu64 " Hz", s); | |
133a37bf | 61 | } |
25e7d9b1 | 62 | |
c69e35a7 UH |
63 | if (!o) { |
64 | sr_err("strutil: %s: Error creating samplerate string.", | |
65 | __func__); | |
25e7d9b1 UH |
66 | return NULL; |
67 | } | |
68 | ||
69 | return o; | |
70 | } | |
2a3f9541 | 71 | |
2a3f9541 | 72 | /** |
dfcc0bf9 | 73 | * Convert a numeric frequency value to the "natural" string representation |
2a3f9541 BV |
74 | * of its period. |
75 | * | |
2507648e | 76 | * E.g. a value of 3000000 would be converted to "3 us", 20000 to "50 ms". |
2a3f9541 BV |
77 | * |
78 | * @param frequency The frequency in Hz. | |
44dae539 | 79 | * |
133a37bf UH |
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 | |
82 | * memory. | |
2a3f9541 | 83 | */ |
1a081ca6 | 84 | SR_API char *sr_period_string(uint64_t frequency) |
2a3f9541 BV |
85 | { |
86 | char *o; | |
87 | int r; | |
88 | ||
133a37bf UH |
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__); | |
2a3f9541 | 92 | return NULL; |
133a37bf | 93 | } |
2a3f9541 | 94 | |
59df0c77 | 95 | if (frequency >= SR_GHZ(1)) |
2a3f9541 | 96 | r = snprintf(o, 30, "%" PRIu64 " ns", frequency / 1000000000); |
59df0c77 | 97 | else if (frequency >= SR_MHZ(1)) |
2507648e | 98 | r = snprintf(o, 30, "%" PRIu64 " us", frequency / 1000000); |
59df0c77 | 99 | else if (frequency >= SR_KHZ(1)) |
2a3f9541 BV |
100 | r = snprintf(o, 30, "%" PRIu64 " ms", frequency / 1000); |
101 | else | |
102 | r = snprintf(o, 30, "%" PRIu64 " s", frequency); | |
103 | ||
104 | if (r < 0) { | |
105 | /* Something went wrong... */ | |
133a37bf | 106 | g_free(o); |
2a3f9541 BV |
107 | return NULL; |
108 | } | |
109 | ||
110 | return o; | |
111 | } | |
40f5ddac | 112 | |
79afc8ca BV |
113 | /** |
114 | * Convert a numeric frequency value to the "natural" string representation | |
115 | * of its voltage value. | |
116 | * | |
117 | * E.g. a value of 300000 would be converted to "300mV", 2 to "2V". | |
118 | * | |
119 | * @param voltage The voltage represented as a rational number, with the | |
120 | * denominator a divisor of 1V. | |
121 | * | |
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 | |
124 | * memory. | |
125 | */ | |
126 | SR_API char *sr_voltage_string(struct sr_rational *voltage) | |
127 | { | |
128 | char *o; | |
129 | int r; | |
130 | ||
131 | if (!(o = g_try_malloc0(30 + 1))) { | |
132 | sr_err("strutil: %s: o malloc failed", __func__); | |
133 | return NULL; | |
134 | } | |
135 | ||
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); | |
140 | else | |
141 | r = -1; | |
142 | ||
143 | if (r < 0) { | |
144 | /* Something went wrong... */ | |
145 | g_free(o); | |
146 | return NULL; | |
147 | } | |
148 | ||
149 | return o; | |
150 | } | |
151 | ||
dfcc0bf9 | 152 | /** |
bf978d35 | 153 | * Parse a trigger specification string. |
dfcc0bf9 | 154 | * |
bf978d35 UH |
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" | |
44dae539 | 164 | * |
bf978d35 UH |
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). | |
dfcc0bf9 | 172 | */ |
bb7ef793 | 173 | SR_API char **sr_parse_triggerstring(struct sr_dev *dev, |
1a081ca6 | 174 | const char *triggerstring) |
40f5ddac BV |
175 | { |
176 | GSList *l; | |
1afe8989 | 177 | struct sr_probe *probe; |
40f5ddac | 178 | int max_probes, probenum, i; |
b7f578be JH |
179 | char **tokens, **triggerlist, *trigger, *tc; |
180 | const char *trigger_types; | |
40f5ddac BV |
181 | gboolean error; |
182 | ||
bb7ef793 | 183 | max_probes = g_slist_length(dev->probes); |
40f5ddac | 184 | error = FALSE; |
b53738ba UH |
185 | |
186 | if (!(triggerlist = g_try_malloc0(max_probes * sizeof(char *)))) { | |
bf978d35 | 187 | sr_err("strutil: %s: triggerlist malloc failed", __func__); |
b53738ba UH |
188 | return NULL; |
189 | } | |
190 | ||
40f5ddac | 191 | tokens = g_strsplit(triggerstring, ",", max_probes); |
bf978d35 | 192 | |
c09f0b57 | 193 | trigger_types = dev->driver->dev_info_get(0, SR_DI_TRIGGER_TYPES); |
bf978d35 UH |
194 | if (!trigger_types) { |
195 | sr_err("strutil: %s: Device doesn't support any triggers.", | |
196 | __func__); | |
40f5ddac | 197 | return NULL; |
bf978d35 | 198 | } |
40f5ddac BV |
199 | |
200 | for (i = 0; tokens[i]; i++) { | |
201 | if (tokens[i][0] < '0' || tokens[i][0] > '9') { | |
202 | /* Named probe */ | |
203 | probenum = 0; | |
bb7ef793 | 204 | for (l = dev->probes; l; l = l->next) { |
1afe8989 | 205 | probe = (struct sr_probe *)l->data; |
40f5ddac BV |
206 | if (probe->enabled |
207 | && !strncmp(probe->name, tokens[i], | |
208 | strlen(probe->name))) { | |
209 | probenum = probe->index; | |
210 | break; | |
211 | } | |
212 | } | |
213 | } else { | |
214 | probenum = strtol(tokens[i], NULL, 10); | |
215 | } | |
216 | ||
217 | if (probenum < 1 || probenum > max_probes) { | |
0aeb0ccd | 218 | sr_err("strutil: Invalid probe (%d).", probenum); |
40f5ddac BV |
219 | error = TRUE; |
220 | break; | |
221 | } | |
222 | ||
223 | if ((trigger = strchr(tokens[i], '='))) { | |
224 | for (tc = ++trigger; *tc; tc++) { | |
225 | if (strchr(trigger_types, *tc) == NULL) { | |
bf978d35 | 226 | sr_err("strutil: Unsupported trigger " |
0aeb0ccd | 227 | "type '%c'.", *tc); |
40f5ddac BV |
228 | error = TRUE; |
229 | break; | |
230 | } | |
231 | } | |
232 | if (!error) | |
233 | triggerlist[probenum - 1] = g_strdup(trigger); | |
234 | } | |
235 | } | |
236 | g_strfreev(tokens); | |
237 | ||
238 | if (error) { | |
239 | for (i = 0; i < max_probes; i++) | |
66410a86 | 240 | g_free(triggerlist[i]); |
40f5ddac BV |
241 | g_free(triggerlist); |
242 | triggerlist = NULL; | |
243 | } | |
244 | ||
245 | return triggerlist; | |
246 | } | |
247 | ||
dfcc0bf9 UH |
248 | /** |
249 | * Convert a "natural" string representation of a size value to uint64_t. | |
250 | * | |
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. | |
253 | * | |
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. | |
257 | * | |
258 | * @param sizestring A string containing a (decimal) size value. | |
f64c1414 | 259 | * @param size Pointer to uint64_t which will contain the string's size value. |
dfcc0bf9 | 260 | * |
44dae539 | 261 | * @return SR_OK upon success, SR_ERR upon errors. |
dfcc0bf9 | 262 | */ |
1a081ca6 | 263 | SR_API int sr_parse_sizestring(const char *sizestring, uint64_t *size) |
40f5ddac | 264 | { |
f64c1414 | 265 | int multiplier, done; |
40f5ddac BV |
266 | char *s; |
267 | ||
f64c1414 | 268 | *size = strtoull(sizestring, &s, 10); |
40f5ddac | 269 | multiplier = 0; |
f64c1414 BV |
270 | done = FALSE; |
271 | while (s && *s && multiplier == 0 && !done) { | |
40f5ddac BV |
272 | switch (*s) { |
273 | case ' ': | |
274 | break; | |
275 | case 'k': | |
276 | case 'K': | |
59df0c77 | 277 | multiplier = SR_KHZ(1); |
40f5ddac BV |
278 | break; |
279 | case 'm': | |
280 | case 'M': | |
59df0c77 | 281 | multiplier = SR_MHZ(1); |
40f5ddac BV |
282 | break; |
283 | case 'g': | |
284 | case 'G': | |
59df0c77 | 285 | multiplier = SR_GHZ(1); |
40f5ddac BV |
286 | break; |
287 | default: | |
f64c1414 BV |
288 | done = TRUE; |
289 | s--; | |
40f5ddac BV |
290 | } |
291 | s++; | |
292 | } | |
293 | if (multiplier > 0) | |
f64c1414 | 294 | *size *= multiplier; |
40f5ddac | 295 | |
f64c1414 BV |
296 | if (*s && strcasecmp(s, "Hz")) |
297 | return SR_ERR; | |
298 | ||
299 | return SR_OK; | |
40f5ddac BV |
300 | } |
301 | ||
dfcc0bf9 UH |
302 | /** |
303 | * Convert a "natural" string representation of a time value to an | |
304 | * uint64_t value in milliseconds. | |
305 | * | |
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. | |
308 | * | |
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. | |
312 | * | |
313 | * @param timestring A string containing a (decimal) time value. | |
314 | * @return The string's time value as uint64_t, in milliseconds. | |
315 | * | |
316 | * TODO: Error handling. | |
317 | * TODO: Add support for "m" (minutes) and others. | |
318 | * TODO: picoseconds? | |
319 | * TODO: Allow both lower-case and upper-case. | |
320 | */ | |
1a081ca6 | 321 | SR_API uint64_t sr_parse_timestring(const char *timestring) |
40f5ddac BV |
322 | { |
323 | uint64_t time_msec; | |
324 | char *s; | |
325 | ||
326 | time_msec = strtoull(timestring, &s, 10); | |
327 | if (time_msec == 0 && s == timestring) | |
328 | return 0; | |
329 | ||
330 | if (s && *s) { | |
331 | while (*s == ' ') | |
332 | s++; | |
333 | if (!strcmp(s, "s")) | |
334 | time_msec *= 1000; | |
335 | else if (!strcmp(s, "ms")) | |
336 | ; /* redundant */ | |
337 | else | |
338 | return 0; | |
339 | } | |
340 | ||
341 | return time_msec; | |
342 | } | |
4d436e71 | 343 | |
1a081ca6 | 344 | SR_API gboolean sr_parse_boolstring(const char *boolstr) |
4d436e71 GM |
345 | { |
346 | if (!boolstr) | |
347 | return FALSE; | |
348 | ||
993526f8 BV |
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)) | |
4d436e71 GM |
353 | return TRUE; |
354 | ||
355 | return FALSE; | |
356 | } | |
76f4c610 BV |
357 | |
358 | SR_API int sr_parse_period(const char *periodstr, struct sr_rational *r) | |
359 | { | |
360 | char *s; | |
361 | ||
362 | r->p = strtoull(periodstr, &s, 10); | |
363 | if (r->p == 0 && s == periodstr) | |
364 | /* No digits found. */ | |
365 | return SR_ERR_ARG; | |
366 | ||
367 | if (s && *s) { | |
368 | while (*s == ' ') | |
369 | s++; | |
370 | if (!strcmp(s, "ns")) | |
371 | r->q = 1000000000L; | |
372 | else if (!strcmp(s, "us")) | |
373 | r->q = 1000000; | |
374 | else if (!strcmp(s, "ms")) | |
375 | r->q = 1000; | |
376 | else if (!strcmp(s, "s")) | |
377 | r->q = 1; | |
378 | else | |
379 | /* Must have a time suffix. */ | |
380 | return SR_ERR_ARG; | |
381 | } | |
382 | ||
383 | return SR_OK; | |
384 | } | |
385 | ||
386 | ||
79afc8ca BV |
387 | SR_API int sr_parse_voltage(const char *voltstr, struct sr_rational *r) |
388 | { | |
389 | char *s; | |
390 | ||
391 | r->p = strtoull(voltstr, &s, 10); | |
392 | if (r->p == 0 && s == voltstr) | |
393 | /* No digits found. */ | |
394 | return SR_ERR_ARG; | |
395 | ||
396 | if (s && *s) { | |
397 | while (*s == ' ') | |
398 | s++; | |
399 | if (!strcasecmp(s, "mv")) | |
400 | r->q = 1000L; | |
401 | else if (!strcasecmp(s, "v")) | |
402 | r->q = 1; | |
403 | else | |
404 | /* Must have a base suffix. */ | |
405 | return SR_ERR_ARG; | |
406 | } | |
407 | ||
408 | return SR_OK; | |
409 | } | |
410 | ||
411 |