X-Git-Url: https://sigrok.org/gitweb/?p=sigrok-cli.git;a=blobdiff_plain;f=session.c;h=f1542357ffc6a22605669cf5e1674bf3a3baf7c5;hp=aa30266f975e9447a72a8dafa4f7b21fcf05f42a;hb=HEAD;hpb=f0f54487c6a146af523d6eb19fcce63422e3f0f1 diff --git a/session.c b/session.c index aa30266..5f5ca8f 100644 --- a/session.c +++ b/session.c @@ -17,15 +17,15 @@ * along with this program. If not, see . */ -#include "sigrok-cli.h" +#include #include #include #include #include +#include "sigrok-cli.h" static uint64_t limit_samples = 0; static uint64_t limit_frames = 0; -static char *srzip_and_filename = NULL; #ifdef HAVE_SRD extern struct srd_session *srd_sess; @@ -45,15 +45,16 @@ static int set_limit_time(const struct sr_dev_inst *sdi) return SR_ERR; } - if (config_key_has_cap(driver, sdi, NULL, SR_CONF_LIMIT_MSEC, SR_CONF_SET)) { + if (sr_dev_config_capabilities_list(sdi, NULL, SR_CONF_LIMIT_MSEC) + & SR_CONF_SET) { gvar = g_variant_new_uint64(time_msec); if (sr_config_set(sdi, NULL, SR_CONF_LIMIT_MSEC, gvar) != SR_OK) { g_critical("Failed to configure time limit."); return SR_ERR; } - } else if (config_key_has_cap(driver, sdi, NULL, SR_CONF_SAMPLERATE, - SR_CONF_GET | SR_CONF_SET)) { - /* Convert to samples based on the samplerate. */ + } else if (sr_dev_config_capabilities_list(sdi, NULL, SR_CONF_SAMPLERATE) + & (SR_CONF_GET | SR_CONF_SET)) { + /* Convert to samples based on the samplerate. */ sr_config_get(driver, sdi, NULL, SR_CONF_SAMPLERATE, &gvar); samplerate = g_variant_get_uint64(gvar); g_variant_unref(gvar); @@ -75,27 +76,23 @@ static int set_limit_time(const struct sr_dev_inst *sdi) return SR_OK; } -const struct sr_output *setup_output_format(const struct sr_dev_inst *sdi) +const struct sr_output *setup_output_format(const struct sr_dev_inst *sdi, FILE **outfile) { const struct sr_output_module *omod; const struct sr_option **options; const struct sr_output *o; GHashTable *fmtargs, *fmtopts; - int size; char *fmtspec; if (!opt_output_format) { if (opt_output_file) { - size = strlen(opt_output_file) + 32; - srzip_and_filename = g_malloc(size); - snprintf(srzip_and_filename, size, "srzip:filename=%s", opt_output_file); - opt_output_format = srzip_and_filename; + opt_output_format = DEFAULT_OUTPUT_FORMAT_FILE; } else { - opt_output_format = DEFAULT_OUTPUT_FORMAT; + opt_output_format = DEFAULT_OUTPUT_FORMAT_NOFILE; } } - fmtargs = parse_generic_arg(opt_output_format, TRUE); + fmtargs = parse_generic_arg(opt_output_format, TRUE, NULL); fmtspec = g_hash_table_lookup(fmtargs, "sigrok_key"); if (!fmtspec) g_critical("Invalid output format."); @@ -104,10 +101,28 @@ const struct sr_output *setup_output_format(const struct sr_dev_inst *sdi) g_hash_table_remove(fmtargs, "sigrok_key"); if ((options = sr_output_options_get(omod))) { fmtopts = generic_arg_to_opt(options, fmtargs); + (void)warn_unknown_keys(options, fmtargs, NULL); sr_output_options_free(options); - } else + } else { fmtopts = NULL; - o = sr_output_new(omod, fmtopts, sdi); + } + o = sr_output_new(omod, fmtopts, sdi, opt_output_file); + + if (opt_output_file) { + if (!sr_output_test_flag(omod, SR_OUTPUT_INTERNAL_IO_HANDLING)) { + *outfile = g_fopen(opt_output_file, "wb"); + if (!*outfile) { + g_critical("Cannot write to output file '%s'.", + opt_output_file); + } + } else { + *outfile = NULL; + } + } else { + setup_binary_stdout(); + *outfile = stdout; + } + if (fmtopts) g_hash_table_destroy(fmtopts); g_hash_table_destroy(fmtargs); @@ -123,10 +138,7 @@ const struct sr_transform *setup_transform_module(const struct sr_dev_inst *sdi) GHashTable *fmtargs, *fmtopts; char *fmtspec; - if (!opt_transform_module) - opt_transform_module = "nop"; - - fmtargs = parse_generic_arg(opt_transform_module, TRUE); + fmtargs = parse_generic_arg(opt_transform_module, TRUE, NULL); fmtspec = g_hash_table_lookup(fmtargs, "sigrok_key"); if (!fmtspec) g_critical("Invalid transform module."); @@ -135,9 +147,11 @@ const struct sr_transform *setup_transform_module(const struct sr_dev_inst *sdi) g_hash_table_remove(fmtargs, "sigrok_key"); if ((options = sr_transform_options_get(tmod))) { fmtopts = generic_arg_to_opt(options, fmtargs); + (void)warn_unknown_keys(options, fmtargs, NULL); sr_transform_options_free(options); - } else + } else { fmtopts = NULL; + } t = sr_transform_new(tmod, fmtopts, sdi); if (fmtopts) g_hash_table_destroy(fmtopts); @@ -146,14 +160,99 @@ const struct sr_transform *setup_transform_module(const struct sr_dev_inst *sdi) return t; } +/* Get the input stream's list of channels and their types, once. */ +static void props_get_channels(struct df_arg_desc *args, + const struct sr_dev_inst *sdi) +{ + struct input_stream_props *props; + GSList *l; + const struct sr_channel *ch; + + if (!args) + return; + props = &args->props; + if (props->channels) + return; + + props->channels = g_slist_copy(sr_dev_inst_channels_get(sdi)); + if (!props->channels) + return; + for (l = props->channels; l; l = l->next) { + ch = l->data; + if (!ch->enabled) + continue; + if (ch->type != SR_CHANNEL_ANALOG) + continue; + props->first_analog_channel = ch; + break; + } +} + +static gboolean props_chk_1st_channel(struct df_arg_desc *args, + const struct sr_datafeed_analog *analog) +{ + struct sr_channel *ch; + + if (!args || !analog || !analog->meaning) + return FALSE; + ch = g_slist_nth_data(analog->meaning->channels, 0); + if (!ch) + return FALSE; + return ch == args->props.first_analog_channel; +} + +static void props_dump_details(struct df_arg_desc *args) +{ + struct input_stream_props *props; + size_t ch_count; + GSList *l; + const struct sr_channel *ch; + const char *type; + + if (!args) + return; + props = &args->props; + if (props->samplerate) + printf("Samplerate: %" PRIu64 "\n", props->samplerate); + if (props->channels) { + ch_count = g_slist_length(props->channels); + printf("Channels: %zu\n", ch_count); + for (l = props->channels; l; l = l->next) { + ch = l->data; + if (ch->type == SR_CHANNEL_ANALOG) + type = "analog"; + else + type = "logic"; + printf("- %s: %s\n", ch->name, type); + } + } + if (props->unitsize) + printf("Logic unitsize: %zu\n", props->unitsize); + if (props->sample_count_logic) + printf("Logic sample count: %" PRIu64 "\n", props->sample_count_logic); + if (props->sample_count_analog) + printf("Analog sample count: %" PRIu64 "\n", props->sample_count_analog); + if (props->frame_count) + printf("Frame count: %" PRIu64 "\n", props->frame_count); + if (props->triggered) + printf("Trigger count: %" PRIu64 "\n", props->triggered); +} + +static void props_cleanup(struct df_arg_desc *args) +{ + struct input_stream_props *props; + + if (!args) + return; + props = &args->props; + g_slist_free(props->channels); + props->channels = NULL; + props->first_analog_channel = NULL; +} + void datafeed_in(const struct sr_dev_inst *sdi, const struct sr_datafeed_packet *packet, void *cb_data) { - const struct sr_datafeed_meta *meta; - const struct sr_datafeed_logic *logic; - const struct sr_datafeed_analog *analog; - struct sr_session *session; - struct sr_config *src; static const struct sr_output *o = NULL; static const struct sr_output *oa = NULL; static uint64_t rcvd_samples_logic = 0; @@ -161,6 +260,15 @@ void datafeed_in(const struct sr_dev_inst *sdi, static uint64_t samplerate = 0; static int triggered = 0; static FILE *outfile = NULL; + + const struct sr_datafeed_meta *meta; + const struct sr_datafeed_logic *logic; + const struct sr_datafeed_analog *analog; + struct df_arg_desc *df_arg; + int do_props; + struct input_stream_props *props; + struct sr_session *session; + struct sr_config *src; GSList *l; GString *out; GVariant *gvar; @@ -168,34 +276,49 @@ void datafeed_in(const struct sr_dev_inst *sdi, uint64_t input_len; struct sr_dev_driver *driver; + /* Avoid warnings when building without decoder support. */ + (void)session; + (void)input_len; + driver = sr_dev_inst_driver_get(sdi); - /* If the first packet to come in isn't a header, don't even try. */ - if (packet->type != SR_DF_HEADER && o == NULL) + /* Skip all packets before the first header. */ + if (packet->type != SR_DF_HEADER && !o) return; - session = cb_data; + /* Prepare to either process data, or "just" gather properties. */ + df_arg = cb_data; + session = df_arg->session; + do_props = df_arg->do_props; + props = &df_arg->props; + switch (packet->type) { case SR_DF_HEADER: g_debug("cli: Received SR_DF_HEADER."); - if (!(o = setup_output_format(sdi))) - g_critical("Failed to initialize output module."); - - /* Set up backup analog output module. */ - oa = sr_output_new(sr_output_find("analog"), NULL, sdi); - - if (opt_output_file) - outfile = g_fopen(opt_output_file, "wb"); - else - outfile = stdout; - - rcvd_samples_logic = rcvd_samples_analog = 0; - if (maybe_config_get(driver, sdi, NULL, SR_CONF_SAMPLERATE, &gvar) == SR_OK) { samplerate = g_variant_get_uint64(gvar); g_variant_unref(gvar); } + if (do_props) { + /* Setup variables for maximum code path re-use. */ + o = (void *)-1; + limit_samples = 0; + /* Start collecting input stream properties. */ + memset(props, 0, sizeof(*props)); + props->samplerate = samplerate; + props_get_channels(df_arg, sdi); + break; + } + if (!(o = setup_output_format(sdi, &outfile))) + g_critical("Failed to initialize output module."); + + /* Set up backup analog output module. */ + if (outfile) + oa = sr_output_new(sr_output_find("analog"), NULL, + sdi, NULL); + + rcvd_samples_logic = rcvd_samples_analog = 0; #ifdef HAVE_SRD if (opt_pds) { @@ -205,6 +328,7 @@ void datafeed_in(const struct sr_dev_inst *sdi, g_critical("Failed to configure decode session."); break; } + pd_samplerate = samplerate; } if (srd_session_start(srd_sess) != SRD_OK) { g_critical("Failed to start decode session."); @@ -223,18 +347,27 @@ void datafeed_in(const struct sr_dev_inst *sdi, case SR_CONF_SAMPLERATE: samplerate = g_variant_get_uint64(src->data); g_debug("cli: Got samplerate %"PRIu64" Hz.", samplerate); + if (do_props) { + props->samplerate = samplerate; + break; + } #ifdef HAVE_SRD if (opt_pds) { if (srd_session_metadata_set(srd_sess, SRD_CONF_SAMPLERATE, g_variant_new_uint64(samplerate)) != SRD_OK) { g_critical("Failed to pass samplerate to decoder."); } + pd_samplerate = samplerate; } #endif break; case SR_CONF_SAMPLE_INTERVAL: samplerate = g_variant_get_uint64(src->data); g_debug("cli: Got sample interval %"PRIu64" ms.", samplerate); + if (do_props) { + props->samplerate = samplerate; + break; + } break; default: /* Unknown metadata is not an error. */ @@ -245,6 +378,10 @@ void datafeed_in(const struct sr_dev_inst *sdi, case SR_DF_TRIGGER: g_debug("cli: Received SR_DF_TRIGGER."); + if (do_props) { + props->triggered++; + break; + } triggered = 1; break; @@ -255,6 +392,13 @@ void datafeed_in(const struct sr_dev_inst *sdi, if (logic->length == 0) break; + if (do_props) { + props_get_channels(df_arg, sdi); + props->unitsize = logic->unitsize; + props->sample_count_logic += logic->length / logic->unitsize; + break; + } + /* Don't store any samples until triggered. */ if (opt_wait_trigger && !triggered) break; @@ -271,7 +415,7 @@ void datafeed_in(const struct sr_dev_inst *sdi, if (opt_pds) { #ifdef HAVE_SRD if (srd_session_send(srd_sess, rcvd_samples_logic, end_sample, - logic->data, input_len) != SRD_OK) + logic->data, input_len, logic->unitsize) != SRD_OK) sr_session_stop(session); #endif } @@ -285,6 +429,15 @@ void datafeed_in(const struct sr_dev_inst *sdi, if (analog->num_samples == 0) break; + if (do_props) { + /* Only count the first analog channel. */ + props_get_channels(df_arg, sdi); + if (!props_chk_1st_channel(df_arg, analog)) + break; + props->sample_count_analog += analog->num_samples; + break; + } + if (limit_samples && rcvd_samples_analog >= limit_samples) break; @@ -297,24 +450,26 @@ void datafeed_in(const struct sr_dev_inst *sdi, case SR_DF_FRAME_END: g_debug("cli: Received SR_DF_FRAME_END."); + if (do_props) { + props->frame_count++; + break; + } break; default: break; } - if (o && outfile && !opt_pds) { + if (!do_props && o && !opt_pds) { if (sr_output_send(o, packet, &out) == SR_OK) { - if (!out || (out->len == 0 - && !opt_output_format - && packet->type == SR_DF_ANALOG)) { + if (oa && !out) { /* * The user didn't specify an output module, * but needs to see this analog data. */ sr_output_send(oa, packet, &out); } - if (out && out->len > 0) { + if (outfile && out && out->len > 0) { fwrite(out->str, 1, out->len, outfile); fflush(outfile); } @@ -330,14 +485,22 @@ void datafeed_in(const struct sr_dev_inst *sdi, if (packet->type == SR_DF_END) { g_debug("cli: Received SR_DF_END."); - if (o) { - sr_output_free(o); - if (srzip_and_filename) - g_free(srzip_and_filename); +#if defined HAVE_SRD_SESSION_SEND_EOF && HAVE_SRD_SESSION_SEND_EOF + (void)srd_session_send_eof(srd_sess); +#endif + + if (do_props) { + props_dump_details(df_arg); + props_cleanup(df_arg); + o = NULL; } + + if (o) + sr_output_free(o); o = NULL; - sr_output_free(oa); + if (oa) + sr_output_free(oa); oa = NULL; if (outfile && outfile != stdout) @@ -357,22 +520,23 @@ void datafeed_in(const struct sr_dev_inst *sdi, int opt_to_gvar(char *key, char *value, struct sr_config *src) { - const struct sr_config_info *srci; + const struct sr_key_info *srci, *srmqi; double tmp_double, dlow, dhigh; - uint64_t tmp_u64, p, q, low, high; - GVariant *rational[2], *range[2]; + uint64_t tmp_u64, p, q, low, high, mqflags; + uint32_t mq; + GVariant *rational[2], *range[2], *gtup[2]; GVariantBuilder *vbl; gboolean tmp_bool; gchar **keyval; - int ret; + int ret, i; - if (!(srci = sr_config_info_name_get(key))) { + if (!(srci = sr_key_info_name_get(SR_KEY_CONFIG, key))) { g_critical("Unknown device option '%s'.", (char *) key); return -1; } src->key = srci->key; - if ((value == NULL || strlen(value) == 0) && + if ((!value || strlen(value) == 0) && (srci->datatype != SR_T_BOOL)) { g_critical("Option '%s' needs a value.", (char *)key); return -1; @@ -455,6 +619,33 @@ int opt_to_gvar(char *key, char *value, struct sr_config *src) g_strfreev(keyval); } break; + case SR_T_MQ: + /* + Argument is MQ id e.g. ("voltage") optionally followed by one + or more / e.g. "/ac". + */ + keyval = g_strsplit(value, "/", 0); + if (!keyval[0] || !(srmqi = sr_key_info_name_get(SR_KEY_MQ, keyval[0]))) { + g_strfreev(keyval); + ret = -1; + break; + } + mq = srmqi->key; + mqflags = 0; + for (i = 1; keyval[i]; i++) { + if (!(srmqi = sr_key_info_name_get(SR_KEY_MQFLAGS, keyval[i]))) { + ret = -1; + break; + } + mqflags |= srmqi->key; + } + g_strfreev(keyval); + if (ret != -1) { + gtup[0] = g_variant_new_uint32(mq); + gtup[1] = g_variant_new_uint64(mqflags); + src->data = g_variant_new_tuple(gtup, 2); + } + break; default: g_critical("Unknown data type specified for option '%s' " "(driver implementation bug?).", key); @@ -467,19 +658,51 @@ int opt_to_gvar(char *key, char *value, struct sr_config *src) return ret; } +int set_dev_options_array(struct sr_dev_inst *sdi, char **opts) +{ + size_t opt_idx; + const char *opt_text; + GHashTable *args; + int ret; + + for (opt_idx = 0; opts && opts[opt_idx]; opt_idx++) { + opt_text = opts[opt_idx]; + args = parse_generic_arg(opt_text, FALSE, "channel_group"); + if (!args) + continue; + ret = set_dev_options(sdi, args); + g_hash_table_destroy(args); + if (ret != SR_OK) + return ret; + } + + return SR_OK; +} + int set_dev_options(struct sr_dev_inst *sdi, GHashTable *args) { struct sr_config src; + const char *cg_name; struct sr_channel_group *cg; GHashTableIter iter; gpointer key, value; int ret; + /* + * Not finding the 'sigrok_key' key (optional user specified + * channel group name) in the current options group's hash table + * is perfectly fine. In that case the -g selection is used, + * which defaults to "the device" (global parameters). + */ + cg_name = g_hash_table_lookup(args, "sigrok_key"); + cg = lookup_channel_group(sdi, cg_name); + g_hash_table_iter_init(&iter, args); while (g_hash_table_iter_next(&iter, &key, &value)) { + if (g_ascii_strcasecmp(key, "sigrok_key") == 0) + continue; if ((ret = opt_to_gvar(key, value, &src)) != 0) return ret; - cg = select_channel_group(sdi); if ((ret = maybe_config_set(sr_dev_inst_driver_get(sdi), sdi, cg, src.key, src.data)) != SR_OK) { g_critical("Failed to set device option '%s': %s.", @@ -493,18 +716,22 @@ int set_dev_options(struct sr_dev_inst *sdi, GHashTable *args) void run_session(void) { + struct df_arg_desc df_arg; GSList *devices, *real_devices, *sd; - GHashTable *devargs; GVariant *gvar; struct sr_session *session; struct sr_trigger *trigger; struct sr_dev_inst *sdi; uint64_t min_samples, max_samples; - gsize n_elements, i; - const uint32_t *dev_opts; + GArray *drv_opts; + guint i; int is_demo_dev; struct sr_dev_driver *driver; const struct sr_transform *t; + GMainLoop *main_loop; + + memset(&df_arg, 0, sizeof(df_arg)); + df_arg.do_props = FALSE; devices = device_scan(); if (!devices) { @@ -518,20 +745,18 @@ void run_session(void) driver = sr_dev_inst_driver_get(sdi); - if (sr_config_list(driver, sdi, NULL, SR_CONF_DEVICE_OPTIONS, &gvar) != SR_OK) { - g_critical("Failed to query list device options."); + if (!(drv_opts = sr_dev_options(driver, NULL, NULL))) { + g_critical("Failed to query list of driver options."); return; } - dev_opts = g_variant_get_fixed_array(gvar, &n_elements, sizeof(uint32_t)); - is_demo_dev = 0; - for (i = 0; i < n_elements; i++) { - if (dev_opts[i] == SR_CONF_DEMO_DEV) + for (i = 0; i < drv_opts->len; i++) { + if (g_array_index(drv_opts, uint32_t, i) == SR_CONF_DEMO_DEV) is_demo_dev = 1; } - g_variant_unref(gvar); + g_array_free(drv_opts, TRUE); if (!is_demo_dev) real_devices = g_slist_append(real_devices, sdi); @@ -549,12 +774,20 @@ void run_session(void) } } + /* This is unlikely to happen but it makes static analyzers stop complaining. */ + if (!devices) { + g_critical("No real devices found."); + return; + } + sdi = devices->data; g_slist_free(devices); g_slist_free(real_devices); - sr_session_new(&session); - sr_session_datafeed_callback_add(session, datafeed_in, NULL); + sr_session_new(sr_ctx, &session); + df_arg.session = session; + sr_session_datafeed_callback_add(session, datafeed_in, &df_arg); + df_arg.session = NULL; if (sr_dev_open(sdi) != SR_OK) { g_critical("Failed to open device."); @@ -567,12 +800,9 @@ void run_session(void) return; } - if (opt_config) { - if ((devargs = parse_generic_arg(opt_config, FALSE))) { - if (set_dev_options(sdi, devargs) != SR_OK) - return; - g_hash_table_destroy(devargs); - } + if (opt_configs) { + if (set_dev_options_array(sdi, opt_configs) != SR_OK) + return; } if (select_channels(sdi) != SR_OK) { @@ -581,6 +811,7 @@ void run_session(void) return; } + trigger = NULL; if (opt_triggers) { if (!parse_triggerstring(sdi, opt_triggers, &trigger)) { sr_session_destroy(session); @@ -640,7 +871,7 @@ void run_session(void) if (opt_frames) { if ((sr_parse_sizestring(opt_frames, &limit_frames) != SR_OK)) { - g_critical("Invalid sample limit '%s'.", opt_samples); + g_critical("Invalid frame limit '%s'.", opt_frames); sr_session_destroy(session); return; } @@ -652,11 +883,19 @@ void run_session(void) } } - if (!(t = setup_transform_module(sdi))) - g_critical("Failed to initialize transform module."); + if (opt_transform_module) { + if (!(t = setup_transform_module(sdi))) + g_critical("Failed to initialize transform module."); + } + + main_loop = g_main_loop_new(NULL, FALSE); + + sr_session_stopped_callback_set(session, + (sr_session_stopped_callback)g_main_loop_quit, main_loop); if (sr_session_start(session) != SR_OK) { g_critical("Failed to start session."); + g_main_loop_unref(main_loop); sr_session_destroy(session); return; } @@ -664,12 +903,15 @@ void run_session(void) if (opt_continuous) add_anykey(session); - sr_session_run(session); + g_main_loop_run(main_loop); if (opt_continuous) clear_anykey(); + if (trigger) + sr_trigger_free(trigger); + sr_session_datafeed_callback_remove_all(session); + g_main_loop_unref(main_loop); sr_session_destroy(session); - }