X-Git-Url: https://sigrok.org/gitweb/?p=sigrok-cli.git;a=blobdiff_plain;f=session.c;h=6465055a1c00f05dc3186066b17728bbca1e819e;hp=a8a647a35079c9a0ad5223319df77b24377523e9;hb=d26a362ef5ffe2f2ff2c0a4668925d554e378787;hpb=ad54a1a630e6887204bc57a95075f403fd44aa6c diff --git a/session.c b/session.c index a8a647a..6465055 100644 --- a/session.c +++ b/session.c @@ -18,51 +18,19 @@ */ #include "sigrok-cli.h" -#include "config.h" #include #include +#include +#include -static struct sr_output_format *output_format = NULL; static int default_output_format = FALSE; -static char *output_format_param = NULL; -static GByteArray *savebuf; static uint64_t limit_samples = 0; static uint64_t limit_frames = 0; -extern gchar *opt_output_file; -extern gchar *opt_output_format; -extern gchar *opt_pds; -extern gboolean opt_wait_trigger; -extern gchar *opt_time; -extern gchar *opt_samples; -extern gchar *opt_frames; -extern gchar *opt_continuous; -extern gchar *opt_config; -extern gchar *opt_triggers; #ifdef HAVE_SRD extern struct srd_session *srd_sess; #endif - -static GArray *get_enabled_logic_probes(const struct sr_dev_inst *sdi) -{ - struct sr_probe *probe; - GArray *probes; - GSList *l; - - probes = g_array_new(FALSE, FALSE, sizeof(int)); - for (l = sdi->probes; l; l = l->next) { - probe = l->data; - if (probe->type != SR_PROBE_LOGIC) - continue; - if (probe->enabled != TRUE) - continue; - g_array_append_val(probes, probe->index); - } - - return probes; -} - static int set_limit_time(const struct sr_dev_inst *sdi) { GVariant *gvar; @@ -103,13 +71,37 @@ static int set_limit_time(const struct sr_dev_inst *sdi) return SR_OK; } -int setup_output_format(void) +GHashTable *generic_arg_to_opt(const struct sr_option *opts, GHashTable *genargs) { - GHashTable *fmtargs; - GHashTableIter iter; - gpointer key, value; - struct sr_output_format **outputs; - int i; + GHashTable *hash; + GVariant *gvar; + const struct sr_option *opt; + char *s; + + hash = g_hash_table_new_full(g_str_hash, g_str_equal, g_free, + (GDestroyNotify)g_variant_unref); + for (opt = opts; opt->id && opt->def; opt++) { + if (!(s = g_hash_table_lookup(genargs, opt->id))) + continue; + if (g_variant_is_of_type(opt->def, G_VARIANT_TYPE_UINT32)) { + gvar = g_variant_new_uint32(strtoul(s, NULL, 10)); + g_hash_table_insert(hash, g_strdup(opt->id), + g_variant_ref_sink(gvar)); + } else { + g_critical("Don't know how to convert option '%s' to %s!", + opt->id, g_variant_get_type_string(opt->def)); + } + } + + return hash; +} + +const struct sr_output *setup_output_format(const struct sr_dev_inst *sdi) +{ + const struct sr_output_module *omod; + const struct sr_option *opts; + const struct sr_output *o; + GHashTable *fmtargs, *fmtopts; char *fmtspec; if (opt_output_format && !strcmp(opt_output_format, "sigrok")) { @@ -129,32 +121,22 @@ int setup_output_format(void) fmtargs = parse_generic_arg(opt_output_format, TRUE); fmtspec = g_hash_table_lookup(fmtargs, "sigrok_key"); - if (!fmtspec) { + if (!fmtspec) g_critical("Invalid output format."); - return 1; - } - outputs = sr_output_list(); - for (i = 0; outputs[i]; i++) { - if (strcmp(outputs[i]->id, fmtspec)) - continue; - g_hash_table_remove(fmtargs, "sigrok_key"); - output_format = outputs[i]; - g_hash_table_iter_init(&iter, fmtargs); - while (g_hash_table_iter_next(&iter, &key, &value)) { - /* only supporting one parameter per output module - * for now, and only its value */ - output_format_param = g_strdup(value); - break; - } - break; - } - if (!output_format) { - g_critical("Invalid output format %s.", opt_output_format); - return 1; - } + if (!(omod = sr_output_find(fmtspec))) + g_critical("Unknown output format '%s'.", fmtspec); + g_hash_table_remove(fmtargs, "sigrok_key"); + if ((opts = sr_output_options_get(omod))) { + fmtopts = generic_arg_to_opt(opts, fmtargs); + sr_output_options_free(omod); + } else + fmtopts = NULL; + o = sr_output_new(omod, fmtopts, sdi); + if (fmtopts) + g_hash_table_destroy(fmtopts); g_hash_table_destroy(fmtargs); - return 0; + return o; } void datafeed_in(const struct sr_dev_inst *sdi, @@ -163,72 +145,59 @@ void datafeed_in(const struct sr_dev_inst *sdi, 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 struct sr_output *o = NULL; - static GArray *logic_probelist = NULL; - static uint64_t received_samples = 0; - static int unitsize = 0; + struct sr_channel *ch; + static const struct sr_output *o = NULL; + static const struct sr_output *oa = NULL; + static uint64_t rcvd_samples_logic = 0; + static uint64_t rcvd_samples_analog = 0; + static uint64_t samplerate = 0; static int triggered = 0; static FILE *outfile = NULL; GSList *l; GString *out; - int sample_size, ret; - uint64_t samplerate, output_len, filter_out_len, end_sample; - uint8_t *output_buf, *filter_out; - - (void) cb_data; + GVariant *gvar; + uint64_t end_sample; + uint64_t input_len; + int i; + char **channels; /* If the first packet to come in isn't a header, don't even try. */ if (packet->type != SR_DF_HEADER && o == NULL) return; - sample_size = -1; + session = cb_data; switch (packet->type) { case SR_DF_HEADER: - g_debug("cli: Received SR_DF_HEADER"); - /* Initialize the output module. */ - if (!(o = g_try_malloc(sizeof(struct sr_output)))) { - g_critical("Output module malloc failed."); - exit(1); - } - o->format = output_format; - o->sdi = (struct sr_dev_inst *)sdi; - o->param = output_format_param; - if (o->format->init) { - if (o->format->init(o) != SR_OK) { - g_critical("Output format initialization failed."); - exit(1); - } - } + g_debug("cli: Received SR_DF_HEADER."); + o = setup_output_format(sdi); + + /* Set up backup analog output module. */ + oa = sr_output_new(sr_output_find("analog"), NULL, sdi); /* Prepare non-stdout output. */ outfile = stdout; if (opt_output_file) { if (default_output_format) { - /* output file is in session format, so we'll - * keep a copy of everything as it comes in - * and save from there after the session. */ outfile = NULL; - savebuf = g_byte_array_new(); } else { /* saving to a file in whatever format was set * with --format, so all we need is a filehandle */ outfile = g_fopen(opt_output_file, "wb"); } } + rcvd_samples_logic = rcvd_samples_analog = 0; - /* Prepare for logic data. */ - logic_probelist = get_enabled_logic_probes(sdi); - /* How many bytes we need to store the packed samples. */ - unitsize = (logic_probelist->len + 7) / 8; + if (sr_config_get(sdi->driver, sdi, NULL, SR_CONF_SAMPLERATE, + &gvar) == SR_OK) { + samplerate = g_variant_get_uint64(gvar); + g_variant_unref(gvar); + } #ifdef HAVE_SRD - GVariant *gvar; - if (opt_pds && logic_probelist->len) { - if (sr_config_get(sdi->driver, sdi, NULL, SR_CONF_SAMPLERATE, - &gvar) == SR_OK) { - samplerate = g_variant_get_uint64(gvar); - g_variant_unref(gvar); + if (opt_pds) { + if (samplerate) { if (srd_session_metadata_set(srd_sess, SRD_CONF_SAMPLERATE, g_variant_new_uint64(samplerate)) != SRD_OK) { g_critical("Failed to configure decode session."); @@ -244,14 +213,14 @@ void datafeed_in(const struct sr_dev_inst *sdi, break; case SR_DF_META: - g_debug("cli: received SR_DF_META"); + g_debug("cli: Received SR_DF_META."); meta = packet->payload; for (l = meta->config; l; l = l->next) { src = l->data; switch (src->key) { case SR_CONF_SAMPLERATE: samplerate = g_variant_get_uint64(src->data); - g_debug("cli: got samplerate %"PRIu64" Hz", samplerate); + g_debug("cli: Got samplerate %"PRIu64" Hz.", samplerate); #ifdef HAVE_SRD if (opt_pds) { if (srd_session_metadata_set(srd_sess, SRD_CONF_SAMPLERATE, @@ -263,7 +232,7 @@ void datafeed_in(const struct sr_dev_inst *sdi, break; case SR_CONF_SAMPLE_INTERVAL: samplerate = g_variant_get_uint64(src->data); - g_debug("cli: got sample interval %"PRIu64" ms", samplerate); + g_debug("cli: Got sample interval %"PRIu64" ms.", samplerate); break; default: /* Unknown metadata is not an error. */ @@ -273,17 +242,14 @@ void datafeed_in(const struct sr_dev_inst *sdi, break; case SR_DF_TRIGGER: - g_debug("cli: received SR_DF_TRIGGER"); - if (o->format->event) - o->format->event(o, SR_DF_TRIGGER, &output_buf, - &output_len); + g_debug("cli: Received SR_DF_TRIGGER."); triggered = 1; break; case SR_DF_LOGIC: logic = packet->payload; - g_message("cli: received SR_DF_LOGIC, %"PRIu64" bytes", logic->length); - sample_size = logic->unitsize; + g_message("cli: Received SR_DF_LOGIC (%"PRIu64" bytes, unitsize = %d).", + logic->length, logic->unitsize); if (logic->length == 0) break; @@ -291,152 +257,111 @@ void datafeed_in(const struct sr_dev_inst *sdi, if (opt_wait_trigger && !triggered) break; - if (limit_samples && received_samples >= limit_samples) + if (limit_samples && rcvd_samples_logic >= limit_samples) break; - ret = sr_filter_probes(sample_size, unitsize, logic_probelist, - logic->data, logic->length, - &filter_out, &filter_out_len); - if (ret != SR_OK) - break; - - /* - * What comes out of the filter is guaranteed to be packed into the - * minimum size needed to support the number of samples at this sample - * size. however, the driver may have submitted too much. Cut off - * the buffer of the last packet according to the sample limit. - */ - if (limit_samples && (received_samples + logic->length / sample_size > - limit_samples * sample_size)) - filter_out_len = limit_samples * sample_size - received_samples; + end_sample = rcvd_samples_logic + logic->length / logic->unitsize; + /* Cut off last packet according to the sample limit. */ + if (limit_samples && end_sample > limit_samples) + end_sample = limit_samples; + input_len = (end_sample - rcvd_samples_logic) * logic->unitsize; if (opt_output_file && default_output_format) { /* Saving to a session file. */ - g_byte_array_append(savebuf, filter_out, filter_out_len); + if (rcvd_samples_logic == 0) { + /* First packet with logic data, init session file. */ + channels = g_malloc(sizeof(char *) * g_slist_length(sdi->channels)); + for (i = 0, l = sdi->channels; l; l = l->next) { + ch = l->data; + if (ch->enabled && ch->type == SR_CHANNEL_LOGIC) + channels[i++] = ch->name; + } + channels[i] = NULL; + sr_session_save_init(session, opt_output_file, + samplerate, channels); + g_free(channels); + } + save_chunk_logic(session, logic->data, input_len, logic->unitsize); } else { if (opt_pds) { #ifdef HAVE_SRD - end_sample = received_samples + filter_out_len / unitsize; - if (srd_session_send(srd_sess, received_samples, end_sample, - (uint8_t*)filter_out, filter_out_len) != SRD_OK) - sr_session_stop(); + if (srd_session_send(srd_sess, rcvd_samples_logic, end_sample, + logic->data, input_len) != SRD_OK) + sr_session_stop(session); #endif - } else { - output_len = 0; - if (o->format->data && packet->type == o->format->df_type) - o->format->data(o, filter_out, filter_out_len, - &output_buf, &output_len); - if (output_len) { - fwrite(output_buf, 1, output_len, outfile); - fflush(outfile); - g_free(output_buf); - } } } - g_free(filter_out); - received_samples += logic->length / sample_size; + rcvd_samples_logic = end_sample; break; case SR_DF_ANALOG: analog = packet->payload; - g_message("cli: received SR_DF_ANALOG, %d samples", analog->num_samples); + g_message("cli: Received SR_DF_ANALOG (%d samples).", analog->num_samples); if (analog->num_samples == 0) break; - if (limit_samples && received_samples >= limit_samples) + if (limit_samples && rcvd_samples_analog >= limit_samples) break; - if (o->format->data && packet->type == o->format->df_type) { - o->format->data(o, (const uint8_t *)analog->data, - analog->num_samples * sizeof(float), - &output_buf, &output_len); - if (output_buf) { - fwrite(output_buf, 1, output_len, outfile); - fflush(outfile); - g_free(output_buf); - } - } - - received_samples += analog->num_samples; + rcvd_samples_analog += analog->num_samples; break; case SR_DF_FRAME_BEGIN: - g_debug("cli: received SR_DF_FRAME_BEGIN"); - if (o->format->event) { - o->format->event(o, SR_DF_FRAME_BEGIN, &output_buf, - &output_len); - if (output_buf) { - fwrite(output_buf, 1, output_len, outfile); - fflush(outfile); - g_free(output_buf); - } - } + g_debug("cli: Received SR_DF_FRAME_BEGIN."); break; case SR_DF_FRAME_END: - g_debug("cli: received SR_DF_FRAME_END"); - if (o->format->event) { - o->format->event(o, SR_DF_FRAME_END, &output_buf, - &output_len); - if (output_buf) { - fwrite(output_buf, 1, output_len, outfile); - fflush(outfile); - g_free(output_buf); - } - } + g_debug("cli: Received SR_DF_FRAME_END."); break; default: break; } - if (o && o->format->receive) { - if (o->format->receive(o, sdi, packet, &out) == SR_OK && out) { - fwrite(out->str, 1, out->len, outfile); - fflush(outfile); - g_string_free(out, TRUE); + if (o && outfile && !opt_pds) { + if (sr_output_send(o, packet, &out) == SR_OK) { + if (!out || (out->len == 0 && default_output_format + && packet->type == SR_DF_ANALOG)) { + /* 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) { + fwrite(out->str, 1, out->len, outfile); + fflush(outfile); + } + if (out) + g_string_free(out, TRUE); } } /* SR_DF_END needs to be handled after the output module's receive() - * is called, so it can properly clean up that module etc. */ + * is called, so it can properly clean up that module. */ if (packet->type == SR_DF_END) { - g_debug("cli: Received SR_DF_END"); - - if (o->format->event) { - o->format->event(o, SR_DF_END, &output_buf, &output_len); - if (output_buf) { - if (outfile) - fwrite(output_buf, 1, output_len, outfile); - g_free(output_buf); - output_len = 0; - } - } - - if (limit_samples && received_samples < limit_samples) - g_warning("Device only sent %" PRIu64 " samples.", - received_samples); - - if (opt_continuous) - g_warning("Device stopped after %" PRIu64 " samples.", - received_samples); + g_debug("cli: Received SR_DF_END."); - g_array_free(logic_probelist, TRUE); - - if (o->format->cleanup) - o->format->cleanup(o); - g_free(o); + if (o) + sr_output_free(o); o = NULL; + sr_output_free(oa); + oa = NULL; + if (outfile && outfile != stdout) fclose(outfile); - if (opt_output_file && default_output_format && savebuf->len) { - if (sr_session_save(opt_output_file, sdi, savebuf->data, - unitsize, savebuf->len / unitsize) != SR_OK) - g_critical("Failed to save session."); - g_byte_array_free(savebuf, TRUE); + if (opt_output_file && default_output_format) + /* Flush whatever is left out to the session file. */ + save_chunk_logic(session, NULL, 0, 0); + + if (limit_samples) { + if (rcvd_samples_logic > 0 && rcvd_samples_logic < limit_samples) + g_warning("Device only sent %" PRIu64 " samples.", + rcvd_samples_logic); + else if (rcvd_samples_analog > 0 && rcvd_samples_analog < limit_samples) + g_warning("Device only sent %" PRIu64 " samples.", + rcvd_samples_analog); } } @@ -445,7 +370,7 @@ 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; - double tmp_double; + double tmp_double, dlow, dhigh; uint64_t tmp_u64, p, q, low, high; GVariant *rational[2], *range[2]; gboolean tmp_bool; @@ -477,7 +402,7 @@ int opt_to_gvar(char *key, char *value, struct sr_config *src) break; src->data = g_variant_new_int32(tmp_u64); break; - case SR_T_CHAR: + case SR_T_STRING: src->data = g_variant_new_string(value); break; case SR_T_BOOL: @@ -515,6 +440,16 @@ int opt_to_gvar(char *key, char *value, struct sr_config *src) src->data = g_variant_new_tuple(range, 2); } break; + case SR_T_DOUBLE_RANGE: + if (sscanf(value, "%lf-%lf", &dlow, &dhigh) != 2) { + ret = -1; + break; + } else { + range[0] = g_variant_new_double(dlow); + range[1] = g_variant_new_double(dhigh); + src->data = g_variant_new_tuple(range, 2); + } + break; default: ret = -1; } @@ -525,7 +460,7 @@ int opt_to_gvar(char *key, char *value, struct sr_config *src) int set_dev_options(struct sr_dev_inst *sdi, GHashTable *args) { struct sr_config src; - struct sr_probe_group *pg; + struct sr_channel_group *cg; GHashTableIter iter; gpointer key, value; int ret; @@ -534,8 +469,8 @@ int set_dev_options(struct sr_dev_inst *sdi, GHashTable *args) while (g_hash_table_iter_next(&iter, &key, &value)) { if ((ret = opt_to_gvar(key, value, &src)) != 0) return ret; - pg = select_probe_group(sdi); - ret = sr_config_set(sdi, pg, src.key, src.data); + cg = select_channel_group(sdi); + ret = sr_config_set(sdi, cg, src.key, src.data); if (ret != SR_OK) { g_critical("Failed to set device option '%s'.", (char *)key); return ret; @@ -550,9 +485,10 @@ void run_session(void) GSList *devices; GHashTable *devargs; GVariant *gvar; + struct sr_session *session; + struct sr_trigger *trigger; struct sr_dev_inst *sdi; - int max_probes, i; - char **triggerlist; + uint64_t min_samples, max_samples; devices = device_scan(); if (!devices) { @@ -561,21 +497,23 @@ void run_session(void) } if (g_slist_length(devices) > 1) { g_critical("sigrok-cli only supports one device for capturing."); + g_slist_free(devices); return; } sdi = devices->data; + g_slist_free(devices); - sr_session_new(); - sr_session_datafeed_callback_add(datafeed_in, NULL); + sr_session_new(&session); + sr_session_datafeed_callback_add(session, datafeed_in, NULL); if (sr_dev_open(sdi) != SR_OK) { g_critical("Failed to open device."); return; } - if (sr_session_dev_add(sdi) != SR_OK) { + if (sr_session_dev_add(session, sdi) != SR_OK) { g_critical("Failed to add device to session."); - sr_session_destroy(); + sr_session_destroy(session); return; } @@ -587,38 +525,34 @@ void run_session(void) } } - if (select_probes(sdi) != SR_OK) { - g_critical("Failed to set probes."); - sr_session_destroy(); + if (select_channels(sdi) != SR_OK) { + g_critical("Failed to set channels."); + sr_session_destroy(session); return; } if (opt_triggers) { - if (!(triggerlist = sr_parse_triggerstring(sdi, opt_triggers))) { - sr_session_destroy(); + if (!parse_triggerstring(sdi, opt_triggers, &trigger)) { + sr_session_destroy(session); return; } - max_probes = g_slist_length(sdi->probes); - for (i = 0; i < max_probes; i++) { - if (triggerlist[i]) { - sr_dev_trigger_set(sdi, i, triggerlist[i]); - g_free(triggerlist[i]); - } + if (sr_session_trigger_set(session, trigger) != SR_OK) { + sr_session_destroy(session); + return; } - g_free(triggerlist); } if (opt_continuous) { if (!sr_dev_has_option(sdi, SR_CONF_CONTINUOUS)) { g_critical("This device does not support continuous sampling."); - sr_session_destroy(); + sr_session_destroy(session); return; } } if (opt_time) { if (set_limit_time(sdi) != SR_OK) { - sr_session_destroy(); + sr_session_destroy(session); return; } } @@ -626,13 +560,28 @@ void run_session(void) if (opt_samples) { if ((sr_parse_sizestring(opt_samples, &limit_samples) != SR_OK)) { g_critical("Invalid sample limit '%s'.", opt_samples); - sr_session_destroy(); + sr_session_destroy(session); return; } + if (sr_config_list(sdi->driver, sdi, NULL, + SR_CONF_LIMIT_SAMPLES, &gvar) == SR_OK) { + /* The device has no compression, or compression is turned + * off, and publishes its sample memory size. */ + g_variant_get(gvar, "(tt)", &min_samples, &max_samples); + g_variant_unref(gvar); + if (limit_samples < min_samples) { + g_critical("The device stores at least %"PRIu64 + " samples with the current settings.", min_samples); + } + if (limit_samples > max_samples) { + g_critical("The device can store only %"PRIu64 + " samples with the current settings.", max_samples); + } + } gvar = g_variant_new_uint64(limit_samples); if (sr_config_set(sdi, NULL, SR_CONF_LIMIT_SAMPLES, gvar) != SR_OK) { g_critical("Failed to configure sample limit."); - sr_session_destroy(); + sr_session_destroy(session); return; } } @@ -640,34 +589,69 @@ 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); - sr_session_destroy(); + sr_session_destroy(session); return; } gvar = g_variant_new_uint64(limit_frames); if (sr_config_set(sdi, NULL, SR_CONF_LIMIT_FRAMES, gvar) != SR_OK) { g_critical("Failed to configure frame limit."); - sr_session_destroy(); + sr_session_destroy(session); return; } } - if (sr_session_start() != SR_OK) { + if (sr_session_start(session) != SR_OK) { g_critical("Failed to start session."); - sr_session_destroy(); + sr_session_destroy(session); return; } if (opt_continuous) - add_anykey(); + add_anykey(session); - sr_session_run(); + sr_session_run(session); if (opt_continuous) clear_anykey(); - sr_session_datafeed_callback_remove_all(); - sr_session_destroy(); - g_slist_free(devices); + sr_session_datafeed_callback_remove_all(session); + sr_session_destroy(session); } +void save_chunk_logic(struct sr_session *session, uint8_t *data, + uint64_t data_len, int unitsize) +{ + static uint8_t *buf = NULL; + static int buf_len = 0; + static int last_unitsize = 0; + int max; + + if (!buf) + buf = g_malloc(SAVE_CHUNK_SIZE); + + while (data_len > SAVE_CHUNK_SIZE) { + save_chunk_logic(session, data, SAVE_CHUNK_SIZE, unitsize); + data += SAVE_CHUNK_SIZE; + data_len -= SAVE_CHUNK_SIZE; + } + + if (buf_len + data_len > SAVE_CHUNK_SIZE) { + max = (SAVE_CHUNK_SIZE - buf_len) / unitsize * unitsize; + memcpy(buf + buf_len, data, max); + sr_session_append(session, opt_output_file, buf, unitsize, + (buf_len + max) / unitsize); + memcpy(buf, data + max, data_len - max); + buf_len = data_len - max; + } else if (data_len == 0 && last_unitsize != 0) { + /* End of data, flush the buffer out. */ + sr_session_append(session, opt_output_file, buf, last_unitsize, + buf_len / last_unitsize); + } else { + /* Buffer chunk. */ + memcpy(buf + buf_len, data, data_len); + buf_len += data_len; + } + last_unitsize = unitsize; + +}