#include "libsigrok.h"
#include "libsigrok-internal.h"
+/** @cond PRIVATE */
#define LOG_PREFIX "strutil"
+/** @endcond */
/**
* @file
* @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.
+ *
+ * @since 0.2.0
*/
SR_API char *sr_si_string_u64(uint64_t x, const char *unit)
{
* @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.
+ *
+ * @since 0.1.0
*/
SR_API char *sr_samplerate_string(uint64_t samplerate)
{
* @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.
+ *
+ * @since 0.1.0
*/
SR_API char *sr_period_string(uint64_t frequency)
{
* @return A g_try_malloc()ed string representation of the voltage value,
* or NULL upon errors. The caller is responsible to g_free() the
* memory.
+ *
+ * @since 0.2.0
*/
SR_API char *sr_voltage_string(uint64_t v_p, uint64_t v_q)
{
* intended. Must not be NULL. Also, sdi->driver and
* sdi->driver->info_get must not be NULL.
* @param triggerstring The string containing the trigger specification for
- * one or more probes of this device. Entries for multiple probes are
+ * one or more channels of this device. Entries for multiple channels 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
+ * where the key is a channel number (or channel 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).
*
* @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,
+ * respective device has channels (all physically available channels,
* 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).
+ * respective channel (e.g. "r", "c", and so on).
+ *
+ * @since 0.2.0
*/
SR_API char **sr_parse_triggerstring(const struct sr_dev_inst *sdi,
const char *triggerstring)
{
GSList *l;
GVariant *gvar;
- struct sr_channel *probe;
- int max_probes, probenum, i;
+ struct sr_channel *ch;
+ int max_channels, channelnum, i;
char **tokens, **triggerlist, *trigger, *tc;
const char *trigger_types;
gboolean error;
- max_probes = g_slist_length(sdi->probes);
+ max_channels = g_slist_length(sdi->channels);
error = FALSE;
- if (!(triggerlist = g_try_malloc0(max_probes * sizeof(char *)))) {
+ if (!(triggerlist = g_try_malloc0(max_channels * sizeof(char *)))) {
sr_err("%s: triggerlist malloc failed", __func__);
return NULL;
}
}
trigger_types = g_variant_get_string(gvar, NULL);
- tokens = g_strsplit(triggerstring, ",", max_probes);
+ tokens = g_strsplit(triggerstring, ",", max_channels);
for (i = 0; tokens[i]; i++) {
- probenum = -1;
- for (l = sdi->probes; l; l = l->next) {
- probe = (struct sr_channel *)l->data;
- if (probe->enabled
- && !strncmp(probe->name, tokens[i],
- strlen(probe->name))) {
- probenum = probe->index;
+ channelnum = -1;
+ for (l = sdi->channels; l; l = l->next) {
+ ch = (struct sr_channel *)l->data;
+ if (ch->enabled
+ && !strncmp(ch->name, tokens[i],
+ strlen(ch->name))) {
+ channelnum = ch->index;
break;
}
}
- if (probenum < 0 || probenum >= max_probes) {
- sr_err("Invalid probe.");
+ if (channelnum < 0 || channelnum >= max_channels) {
+ sr_err("Invalid channel.");
error = TRUE;
break;
}
}
}
if (!error)
- triggerlist[probenum] = g_strdup(trigger);
+ triggerlist[channelnum] = g_strdup(trigger);
}
}
g_strfreev(tokens);
g_variant_unref(gvar);
if (error) {
- for (i = 0; i < max_probes; i++)
+ for (i = 0; i < max_channels; i++)
g_free(triggerlist[i]);
g_free(triggerlist);
triggerlist = NULL;
* @param size Pointer to uint64_t which will contain the string's size value.
*
* @return SR_OK upon success, SR_ERR upon errors.
+ *
+ * @since 0.1.0
*/
SR_API int sr_parse_sizestring(const char *sizestring, uint64_t *size)
{
* @todo Add support for "m" (minutes) and others.
* @todo Add support for picoseconds?
* @todo Allow both lower-case and upper-case? If no, document it.
+ *
+ * @since 0.1.0
*/
SR_API uint64_t sr_parse_timestring(const char *timestring)
{
return time_msec;
}
+/** @since 0.1.0 */
SR_API gboolean sr_parse_boolstring(const char *boolstr)
{
if (!boolstr)
return FALSE;
}
+/** @since 0.2.0 */
SR_API int sr_parse_period(const char *periodstr, uint64_t *p, uint64_t *q)
{
char *s;
return SR_OK;
}
-
+/** @since 0.2.0 */
SR_API int sr_parse_voltage(const char *voltstr, uint64_t *p, uint64_t *q)
{
char *s;
projects / libsigrok.git / blobdiff