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".
32 * @param samplerate The samplerate in Hz.
34 * @return A g_try_malloc()ed string representation of the samplerate value,
35 * or NULL upon errors. The caller is responsible to g_free() the
38 SR_API char *sr_samplerate_string(uint64_t samplerate)
43 /* Allocate enough for a uint64_t as string + " GHz". */
44 if (!(o = g_try_malloc0(30 + 1))) {
45 sr_err("strutil: %s: o malloc failed", __func__);
49 if (samplerate >= SR_GHZ(1))
50 r = snprintf(o, 30, "%" PRIu64 " GHz", samplerate / 1000000000);
51 else if (samplerate >= SR_MHZ(1))
52 r = snprintf(o, 30, "%" PRIu64 " MHz", samplerate / 1000000);
53 else if (samplerate >= SR_KHZ(1))
54 r = snprintf(o, 30, "%" PRIu64 " kHz", samplerate / 1000);
56 r = snprintf(o, 30, "%" PRIu64 " Hz", samplerate);
59 /* Something went wrong... */
68 * Convert a numeric frequency value to the "natural" string representation
71 * E.g. a value of 3000000 would be converted to "3 us", 20000 to "50 ms".
73 * @param frequency The frequency in Hz.
75 * @return A g_try_malloc()ed string representation of the frequency value,
76 * or NULL upon errors. The caller is responsible to g_free() the
79 SR_API char *sr_period_string(uint64_t frequency)
84 /* Allocate enough for a uint64_t as string + " ms". */
85 if (!(o = g_try_malloc0(30 + 1))) {
86 sr_err("strutil: %s: o malloc failed", __func__);
90 if (frequency >= SR_GHZ(1))
91 r = snprintf(o, 30, "%" PRIu64 " ns", frequency / 1000000000);
92 else if (frequency >= SR_MHZ(1))
93 r = snprintf(o, 30, "%" PRIu64 " us", frequency / 1000000);
94 else if (frequency >= SR_KHZ(1))
95 r = snprintf(o, 30, "%" PRIu64 " ms", frequency / 1000);
97 r = snprintf(o, 30, "%" PRIu64 " s", frequency);
100 /* Something went wrong... */
112 * @param triggerstring TODO
116 SR_API char **sr_parse_triggerstring(struct sr_dev *dev,
117 const char *triggerstring)
120 struct sr_probe *probe;
121 int max_probes, probenum, i;
122 char **tokens, **triggerlist, *trigger, *tc, *trigger_types;
125 max_probes = g_slist_length(dev->probes);
128 if (!(triggerlist = g_try_malloc0(max_probes * sizeof(char *)))) {
129 sr_err("session file: %s: metafile malloc failed", __func__);
133 tokens = g_strsplit(triggerstring, ",", max_probes);
134 trigger_types = dev->plugin->get_dev_info(0, SR_DI_TRIGGER_TYPES);
135 if (trigger_types == NULL)
138 for (i = 0; tokens[i]; i++) {
139 if (tokens[i][0] < '0' || tokens[i][0] > '9') {
142 for (l = dev->probes; l; l = l->next) {
143 probe = (struct sr_probe *)l->data;
145 && !strncmp(probe->name, tokens[i],
146 strlen(probe->name))) {
147 probenum = probe->index;
152 probenum = strtol(tokens[i], NULL, 10);
155 if (probenum < 1 || probenum > max_probes) {
156 sr_err("Invalid probe.\n");
161 if ((trigger = strchr(tokens[i], '='))) {
162 for (tc = ++trigger; *tc; tc++) {
163 if (strchr(trigger_types, *tc) == NULL) {
164 sr_err("Unsupported trigger type "
171 triggerlist[probenum - 1] = g_strdup(trigger);
177 for (i = 0; i < max_probes; i++)
178 g_free(triggerlist[i]);
187 * Convert a "natural" string representation of a size value to uint64_t.
189 * E.g. a value of "3k" or "3 K" would be converted to 3000, a value
190 * of "15M" would be converted to 15000000.
192 * Value representations other than decimal (such as hex or octal) are not
193 * supported. Only 'k' (kilo), 'm' (mega), 'g' (giga) suffixes are supported.
194 * Spaces (but not other whitespace) between value and suffix are allowed.
196 * @param sizestring A string containing a (decimal) size value.
197 * @param size Pointer to uint64_t which will contain the string's size value.
199 * @return SR_OK upon success, SR_ERR upon errors.
201 SR_API int sr_parse_sizestring(const char *sizestring, uint64_t *size)
203 int multiplier, done;
206 *size = strtoull(sizestring, &s, 10);
209 while (s && *s && multiplier == 0 && !done) {
215 multiplier = SR_KHZ(1);
219 multiplier = SR_MHZ(1);
223 multiplier = SR_GHZ(1);
234 if (*s && strcasecmp(s, "Hz"))
241 * Convert a "natural" string representation of a time value to an
242 * uint64_t value in milliseconds.
244 * E.g. a value of "3s" or "3 s" would be converted to 3000, a value
245 * of "15ms" would be converted to 15.
247 * Value representations other than decimal (such as hex or octal) are not
248 * supported. Only lower-case "s" and "ms" time suffixes are supported.
249 * Spaces (but not other whitespace) between value and suffix are allowed.
251 * @param timestring A string containing a (decimal) time value.
252 * @return The string's time value as uint64_t, in milliseconds.
254 * TODO: Error handling.
255 * TODO: Add support for "m" (minutes) and others.
257 * TODO: Allow both lower-case and upper-case.
259 SR_API uint64_t sr_parse_timestring(const char *timestring)
264 time_msec = strtoull(timestring, &s, 10);
265 if (time_msec == 0 && s == timestring)
273 else if (!strcmp(s, "ms"))
282 SR_API gboolean sr_parse_boolstring(const char *boolstr)
287 if (!g_strcasecmp(boolstr, "true") ||
288 !g_strcasecmp(boolstr, "yes") ||
289 !g_strcasecmp(boolstr, "on") ||
290 !g_strcasecmp(boolstr, "1"))