2 * This file is part of the libsigrok project.
4 * Copyright (C) 2015 Soeren Apel <soeren@apelpie.net>
5 * Copyright (C) 2015 Bert Vermeulen <bert@biot.com>
7 * This program is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation, either version 3 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program. If not, see <http://www.gnu.org/licenses/>.
23 * This input module reads .ad files created using the
24 * following practice commands:
26 * I.SAVE <file> /NoCompress
27 * IPROBE.SAVE <file> /NoCompress
29 * It currently cannot make use of files that have been
30 * saved using /QuickCompress, /Compress or /ZIP.
31 * As a workaround you may load the file in PowerView
32 * using I.LOAD / IPROBE.LOAD and re-save using /NoCompress.
38 #include <sys/types.h>
43 #include <libsigrok/libsigrok.h>
44 #include "libsigrok-internal.h"
46 #define LOG_PREFIX "input/trace32_ad"
48 #define MAX_CHUNK_SIZE 4096
49 #define OUTBUF_FLUSH_SIZE 10240
50 #define MAX_POD_COUNT 12
51 #define HEADER_SIZE 80
53 #define TIMESTAMP_RESOLUTION ((double)0.000000000078125) /* 0.078125 ns */
56 * The resolution equals a sampling freq of 12.8 GHz. That's a bit high
57 * for inter-record sample generation, so we scale it down to 200 MHz
58 * for now. That way, the scaling factor becomes 32.
60 #define SAMPLING_FREQ 200000000
61 #define TIMESTAMP_SCALE ((1 / TIMESTAMP_RESOLUTION) / SAMPLING_FREQ)
64 AD_FORMAT_BINHDR = 1, /* Binary header, binary data, textual setup info */
65 AD_FORMAT_TXTHDR /* Textual header, binary data */
69 AD_DEVICE_PI = 1, /* Data recorded by LA-7940 PowerIntegrator or */
70 /* LA-394x PowerIntegrator II. */
71 AD_DEVICE_IPROBE /* Data recorded by LA-769x PowerTrace II IProbe. */
72 /* Missing file format info for LA-793x ICD PowerProbe */
73 /* Missing file format info for LA-4530 uTrace analog probe */
82 AD_COMPR_NONE = 0, /* File created with /NOCOMPRESS */
83 AD_COMPR_QCOMP = 6 /* File created with /COMPRESS or /QUICKCOMPRESS */
88 gboolean header_read, records_read;
89 char format, device, record_mode, compression;
90 char pod_status[MAX_POD_COUNT];
91 struct sr_channel *channels[MAX_POD_COUNT][17]; /* 16 + CLK */
92 uint64_t trigger_timestamp;
93 uint32_t record_size, record_count, cur_record;
98 static int process_header(GString *buf, struct context *inc);
99 static void create_channels(struct sr_input *in);
101 static char get_pod_name_from_id(int id)
117 sr_err("get_pod_name_from_id() called with invalid ID %d!", id);
122 static int init(struct sr_input *in, GHashTable *options)
128 in->sdi = g_malloc0(sizeof(struct sr_dev_inst));
129 in->priv = g_malloc0(sizeof(struct context));
133 /* Enable the pods the user chose to see. */
134 for (pod = 0; pod < MAX_POD_COUNT; pod++) {
135 g_snprintf(id, sizeof(id), "pod%c", get_pod_name_from_id(pod));
136 if (g_variant_get_boolean(g_hash_table_lookup(options, id)))
137 inc->pod_status[pod] = 1;
141 if (g_slist_length(in->sdi->channels) == 0) {
142 sr_err("No pods were selected and thus no channels created, aborting.");
148 inc->out_buf = g_string_sized_new(OUTBUF_FLUSH_SIZE);
153 static int format_match(GHashTable *metadata)
157 buf = g_hash_table_lookup(metadata, GINT_TO_POINTER(SR_INPUT_META_HEADER));
159 return process_header(buf, NULL);
162 static int process_header(GString *buf, struct context *inc)
164 char *format_name, *format_name_sig;
165 int i, record_size, device_id;
168 * 00-31 (0x00-1F) file format name
169 * 32-39 (0x20-27) trigger timestamp u64
170 * 40-47 (0x28-2F) unused
171 * 48 (0x30) compression
173 * 50 (0x32) 0x00 (PI), 0x01 (iprobe)
174 * 54 (0x36) 0x08 (PI 250/500), 0x0A (iprobe 250)
175 * 55 (0x37) 0x00 (250), 0x01 (500)
176 * 56 (0x38) record size u8
177 * 57-59 (0x39-3B) const 0x00
178 * 60-63 (0x3C-3F) number of records u32
179 * 64-67 (0x40-43) id of last record s32
181 * 71 (0x47) const 0x80=128
182 * 72 (0x48) const 0x01
186 /* Note: inc is off-limits until we check whether it's a valid pointer. */
188 format_name = g_strndup(buf->str, 32);
190 /* File format name ends on 0x20/0x1A, let's remove both. */
191 for (i = 1; i < 31; i++) {
192 if (format_name[i] == 0x1A) {
193 format_name[i - 1] = 0;
197 g_strchomp(format_name); /* This is for additional padding spaces. */
199 format_name_sig = g_strndup(format_name, 5);
201 /* Desired file formats either start with digit+space or "trace32". */
202 if (g_strcmp0(format_name_sig, "trace32")) {
204 inc->format = AD_FORMAT_BINHDR;
205 } else if (g_ascii_isdigit(format_name[0]) && (format_name[1] == 0x20)) {
207 inc->format = AD_FORMAT_TXTHDR;
208 g_free(format_name_sig);
210 sr_err("This format isn't implemented yet, aborting.");
213 g_free(format_name_sig);
215 sr_err("Don't know this file format, aborting.");
219 sr_dbg("File says it's \"%s\"", format_name);
221 record_size = R8(buf->str + 56);
224 if (g_strcmp0(format_name, "trace32 power integrator data") == 0) {
225 if (record_size == 28 || record_size == 45)
226 device_id = AD_DEVICE_PI;
227 } else if (g_strcmp0(format_name, "trace32 iprobe data") == 0) {
228 if (record_size == 11)
229 device_id = AD_DEVICE_IPROBE;
233 g_free(format_name_sig);
235 sr_err("Don't know how to handle this file with record size %d.",
240 g_free(format_name_sig);
243 /* Stop processing the header if we just want to identify the file. */
247 inc->device = device_id;
248 inc->trigger_timestamp = RL64(buf->str + 32);
249 inc->compression = R8(buf->str + 48); /* Maps to the enum. */
250 inc->record_mode = R8(buf->str + 55); /* Maps to the enum. */
251 inc->record_size = record_size;
252 inc->record_count = RL32(buf->str + 60);
253 inc->last_record = RL32S(buf->str + 64);
255 sr_dbg("Trigger occured at %lf s.",
256 inc->trigger_timestamp * TIMESTAMP_RESOLUTION);
257 sr_dbg("File contains %d records: first one is %d, last one is %d.",
258 inc->record_count, (inc->last_record - inc->record_count + 1),
261 /* Check if we can work with this compression. */
262 if (inc->compression != AD_COMPR_NONE) {
263 sr_err("File uses unsupported compression (0x%02X), can't continue.",
268 inc->header_read = TRUE;
273 static void create_channels(struct sr_input *in)
276 int pod, channel, chan_id;
282 for (pod = 0; pod < MAX_POD_COUNT; pod++) {
283 if (!inc->pod_status[pod])
286 for (channel = 0; channel < 16; channel++) {
287 snprintf(name, 8, "%c%d", get_pod_name_from_id(pod), channel);
288 inc->channels[pod][channel] =
289 sr_channel_new(in->sdi, chan_id, SR_CHANNEL_LOGIC, TRUE, name);
293 snprintf(name, 8, "CLK%c", get_pod_name_from_id(pod));
294 inc->channels[pod][16] =
295 sr_channel_new(in->sdi, chan_id, SR_CHANNEL_LOGIC, TRUE, name);
300 static void send_metadata(struct sr_input *in)
302 struct sr_datafeed_packet packet;
303 struct sr_datafeed_meta meta;
304 struct sr_config *src;
307 packet.type = SR_DF_META;
308 packet.payload = &meta;
309 src = sr_config_new(SR_CONF_SAMPLERATE, g_variant_new_uint64(SAMPLING_FREQ));
310 meta.config = g_slist_append(NULL, src);
311 sr_session_send(in->sdi, &packet);
312 g_slist_free(meta.config);
316 inc->meta_sent = TRUE;
319 static void flush_output_buffer(struct sr_input *in)
322 struct sr_datafeed_packet packet;
323 struct sr_datafeed_logic logic;
327 if (inc->out_buf->len) {
328 packet.type = SR_DF_LOGIC;
329 packet.payload = &logic;
330 logic.unitsize = (g_slist_length(in->sdi->channels) + 7) / 8;
331 logic.data = inc->out_buf->str;
332 logic.length = inc->out_buf->len;
333 sr_session_send(in->sdi, &packet);
335 g_string_truncate(inc->out_buf, 0);
339 static void process_record_pi(struct sr_input *in, gsize start)
341 struct sr_datafeed_packet packet;
343 uint64_t timestamp, next_timestamp;
345 char single_payload[12 * 3];
347 int i, pod_count, clk_offset, packet_count, pod;
348 int payload_bit, payload_len, value;
362 * 24-25 J15..0 Not present in 500MHz mode
363 * 26-27 K15..0 Not present in 500MHz mode
364 * 28-29 L15..0 Not present in 500MHz mode
365 * 30-31 M15..0 Not present in 500MHz mode
366 * 32-33 N15..0 Not present in 500MHz mode
367 * 34-35 O15..0 Not present in 500MHz mode
368 * 36-39 ?? Not present in 500MHz mode
369 * 40/24 CLKF..A (32=CLKF, .., 1=CLKA)
370 * 41 CLKO..J (32=CLKO, .., 1=CLKJ) Not present in 500MHz mode
376 timestamp = RL64(buf->str + start);
378 if (inc->record_mode == AD_MODE_500MHZ) {
388 single_payload[0] = 0;
390 for (pod = 0; pod < pod_count; pod++) {
391 if (!inc->pod_status[pod])
396 pod_data = RL16(buf->str + start + 8);
397 pod_data |= (RL16(buf->str + start + clk_offset) & 1) << 16;
400 pod_data = RL16(buf->str + start + 10);
401 pod_data |= (RL16(buf->str + start + clk_offset) & 2) << 15;
404 pod_data = RL16(buf->str + start + 12);
405 pod_data |= (RL16(buf->str + start + clk_offset) & 4) << 14;
408 pod_data = RL16(buf->str + start + 14);
409 pod_data |= (RL16(buf->str + start + clk_offset) & 8) << 13;
412 pod_data = RL16(buf->str + start + 16);
413 pod_data |= (RL16(buf->str + start + clk_offset) & 16) << 12;
416 pod_data = RL16(buf->str + start + 18);
417 pod_data |= (RL16(buf->str + start + clk_offset) & 32) << 11;
420 pod_data = RL16(buf->str + start + 24);
421 pod_data |= (RL16(buf->str + start + 41) & 1) << 16;
424 pod_data = RL16(buf->str + start + 26);
425 pod_data |= (RL16(buf->str + start + 41) & 2) << 15;
428 pod_data = RL16(buf->str + start + 28);
429 pod_data |= (RL16(buf->str + start + 41) & 4) << 14;
432 pod_data = RL16(buf->str + start + 30);
433 pod_data |= (RL16(buf->str + start + 41) & 8) << 13;
436 pod_data = RL16(buf->str + start + 32);
437 pod_data |= (RL16(buf->str + start + 41) & 16) << 12;
440 pod_data = RL16(buf->str + start + 34);
441 pod_data |= (RL16(buf->str + start + 41) & 32) << 11;
444 sr_err("Don't know how to obtain data for pod %d.", pod);
447 for (i = 0; i < 17; i++) {
448 value = (pod_data >> i) & 1;
449 single_payload[payload_len] |= value << payload_bit;
452 if (payload_bit > 7) {
455 single_payload[payload_len] = 0;
460 /* Make sure that payload_len accounts for any incomplete bytes used. */
464 i = (g_slist_length(in->sdi->channels) + 7) / 8;
465 if (payload_len != i) {
466 sr_err("Payload unit size is %d but should be %d!", payload_len, i);
470 if (timestamp == inc->trigger_timestamp) {
471 sr_dbg("Trigger @%lf s, record #%d.",
472 timestamp * TIMESTAMP_RESOLUTION, inc->cur_record);
474 packet.type = SR_DF_TRIGGER;
475 packet.payload = NULL;
476 sr_session_send(in->sdi, &packet);
479 /* Is this the last record in the file? */
480 if (inc->cur_record == inc->record_count - 1) {
481 /* It is, so send the last sample data only once. */
482 g_string_append_len(inc->out_buf, single_payload, payload_len);
484 /* It's not, so fill the time gap by sending lots of data. */
485 next_timestamp = RL64(buf->str + start + inc->record_size);
486 packet_count = (int)(next_timestamp - timestamp) / TIMESTAMP_SCALE;
488 /* Make sure we send at least one data set. */
489 if (packet_count == 0)
492 for (i = 0; i < packet_count; i++)
493 g_string_append_len(inc->out_buf, single_payload, payload_len);
496 if (inc->out_buf->len >= OUTBUF_FLUSH_SIZE)
497 flush_output_buffer(in);
500 static void process_record_iprobe(struct sr_input *in, gsize start)
502 struct sr_datafeed_packet packet;
504 uint64_t timestamp, next_timestamp;
505 char single_payload[3];
506 int i, payload_len, packet_count;
516 timestamp = RL64(in->buf->str + start);
517 single_payload[0] = R8(in->buf->str + start + 8);
518 single_payload[1] = R8(in->buf->str + start + 9);
519 single_payload[2] = R8(in->buf->str + start + 10) & 1;
522 if (timestamp == inc->trigger_timestamp) {
523 sr_dbg("Trigger @%lf s, record #%d.",
524 timestamp * TIMESTAMP_RESOLUTION, inc->cur_record);
526 packet.type = SR_DF_TRIGGER;
527 packet.payload = NULL;
528 sr_session_send(in->sdi, &packet);
531 /* Is this the last record in the file? */
532 if (inc->cur_record == inc->record_count - 1) {
533 /* It is, so send the last sample data only once. */
534 g_string_append_len(inc->out_buf, single_payload, payload_len);
536 /* It's not, so fill the time gap by sending lots of data. */
537 next_timestamp = RL64(in->buf->str + start + inc->record_size);
538 packet_count = (int)(next_timestamp - timestamp) / TIMESTAMP_SCALE;
540 /* Make sure we send at least one data set. */
541 if (packet_count == 0)
544 for (i = 0; i < packet_count; i++)
545 g_string_append_len(inc->out_buf, single_payload, payload_len);
548 if (inc->out_buf->len >= OUTBUF_FLUSH_SIZE)
549 flush_output_buffer(in);
552 static void process_practice_token(struct sr_input *in, char *cmd_token)
556 char chan_suffix[2], chan_name[33];
559 struct sr_channel *channel;
564 * Commands of interest (I may also be IPROBE):
569 * I.TYSNC.SELECT I.A0 HIGH
570 * NAME.SET <port.chan> <name> <+/-> ...
576 if (cmd_token[0] == 0)
579 tokens = g_strsplit(cmd_token, " ", 0);
584 if (g_strcmp0(tokens[0], "NAME.SET") == 0) {
585 /* Let the user know when the channel has been inverted. */
586 /* This *should* be token #3 but there's an additonal space, making it #4. */
590 if (tokens[4][0] == '-')
591 chan_suffix[0] = '-'; /* This is the way PowerView shows it. */
595 * Command is using structure "NAME.SET I.A00 I.XYZ" or
596 * "NAME.SET IP.00 IP.XYZ", depending on the device used.
597 * Let's get strings with the I./IP. from both tokens removed.
599 s1 = g_strstr_len(tokens[1], -1, ".") + 1;
600 s2 = g_strstr_len(tokens[2], -1, ".") + 1;
602 if (g_strcmp0(s1, "CLK") == 0) {
606 } else if ((strlen(s1) == 4) && g_ascii_isupper(s1[3])) {
607 /* CLKA/B/J/K for PowerIntegrator */
608 pod = s1[3] - (char)'A';
610 } else if (g_ascii_isupper(s1[0])) {
611 /* A00 for PowerIntegrator */
612 pod = s1[0] - (char)'A';
620 channel = inc->channels[pod][ch];
621 g_snprintf(chan_name, sizeof(chan_name), "%s%s", s2, chan_suffix);
623 sr_dbg("Changing channel name for %s to %s.", s1, chan_name);
624 sr_dev_channel_name_set(channel, chan_name);
630 static void process_practice(struct sr_input *in)
633 char **tokens, *token;
636 /* Gather all input data until we see the end marker. */
637 if (in->buf->str[in->buf->len - 1] != 0x29)
644 tokens = g_strsplit(in->buf->str, delimiter, 0);
646 /* Special case: first token contains the start marker, too. Skip it. */
648 for (i = 0; token[i]; i++) {
650 process_practice_token(in, token + i + 1);
653 for (i = 1; tokens[i]; i++)
654 process_practice_token(in, tokens[i]);
658 g_string_erase(in->buf, 0, in->buf->len);
661 static int process_buffer(struct sr_input *in)
664 int i, chunk_size, res;
668 if (!inc->header_read) {
669 res = process_header(in->buf, inc);
670 g_string_erase(in->buf, 0, HEADER_SIZE);
675 if (!inc->meta_sent) {
676 std_session_send_df_header(in->sdi, LOG_PREFIX);
680 if (!inc->records_read) {
681 /* Cut off at a multiple of the record size. */
682 chunk_size = ((in->buf->len) / inc->record_size) * inc->record_size;
684 /* There needs to be at least one more record process_record() can peek into. */
685 chunk_size -= inc->record_size;
687 for (i = 0; (i < chunk_size) && (!inc->records_read); i += inc->record_size) {
688 switch (inc->device) {
690 process_record_pi(in, i);
692 case AD_DEVICE_IPROBE:
693 process_record_iprobe(in, i);
696 sr_err("Trying to process records for unknown device!");
701 if (inc->cur_record == inc->record_count)
702 inc->records_read = TRUE;
705 g_string_erase(in->buf, 0, i);
708 if (inc->records_read) {
709 /* Read practice commands that configure the setup. */
710 process_practice(in);
716 static int receive(struct sr_input *in, GString *buf)
718 g_string_append_len(in->buf, buf->str, buf->len);
720 if (!in->sdi_ready) {
721 /* sdi is ready, notify frontend. */
722 in->sdi_ready = TRUE;
726 return process_buffer(in);
729 static int end(struct sr_input *in)
732 struct sr_datafeed_packet packet;
738 ret = process_buffer(in);
742 flush_output_buffer(in);
744 if (inc->meta_sent) {
745 packet.type = SR_DF_END;
746 sr_session_send(in->sdi, &packet);
752 static struct sr_option options[] = {
753 { "podA", "Import pod A / iprobe",
754 "Create channels and data for pod A / iprobe", NULL, NULL },
756 { "podB", "Import pod B", "Create channels and data for pod B", NULL, NULL },
757 { "podC", "Import pod C", "Create channels and data for pod C", NULL, NULL },
758 { "podD", "Import pod D", "Create channels and data for pod D", NULL, NULL },
759 { "podE", "Import pod E", "Create channels and data for pod E", NULL, NULL },
760 { "podF", "Import pod F", "Create channels and data for pod F", NULL, NULL },
761 { "podJ", "Import pod J", "Create channels and data for pod J", NULL, NULL },
762 { "podK", "Import pod K", "Create channels and data for pod K", NULL, NULL },
763 { "podL", "Import pod L", "Create channels and data for pod L", NULL, NULL },
764 { "podM", "Import pod M", "Create channels and data for pod M", NULL, NULL },
765 { "podN", "Import pod N", "Create channels and data for pod N", NULL, NULL },
766 { "podO", "Import pod O", "Create channels and data for pod O", NULL, NULL },
770 static const struct sr_option *get_options(void)
772 if (!options[0].def) {
773 options[0].def = g_variant_ref_sink(g_variant_new_boolean(TRUE));
774 options[1].def = g_variant_ref_sink(g_variant_new_boolean(FALSE));
775 options[2].def = g_variant_ref_sink(g_variant_new_boolean(FALSE));
776 options[3].def = g_variant_ref_sink(g_variant_new_boolean(FALSE));
777 options[4].def = g_variant_ref_sink(g_variant_new_boolean(FALSE));
778 options[5].def = g_variant_ref_sink(g_variant_new_boolean(FALSE));
779 options[6].def = g_variant_ref_sink(g_variant_new_boolean(FALSE));
780 options[7].def = g_variant_ref_sink(g_variant_new_boolean(FALSE));
781 options[8].def = g_variant_ref_sink(g_variant_new_boolean(FALSE));
782 options[9].def = g_variant_ref_sink(g_variant_new_boolean(FALSE));
783 options[10].def = g_variant_ref_sink(g_variant_new_boolean(FALSE));
784 options[11].def = g_variant_ref_sink(g_variant_new_boolean(FALSE));
790 SR_PRIV struct sr_input_module input_trace32_ad = {
792 .name = "Trace32_ad",
793 .desc = "Lauterbach Trace32 logic analyzer data",
794 .exts = (const char*[]){"ad", NULL},
795 .options = get_options,
796 .metadata = { SR_INPUT_META_HEADER | SR_INPUT_META_REQUIRED },
797 .format_match = format_match,