2 * This file is part of the sigrok project.
4 * Copyright (C) 2012 Bert Vermeulen <bert@biot.com>
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 3 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, see <http://www.gnu.org/licenses/>.
20 #include <sigrokdecode.h> /* First, so we avoid a _POSIX_C_SOURCE warning. */
28 #include <sys/types.h>
32 #include <glib/gstdio.h>
33 #include <libsigrok/libsigrok.h>
34 #include "sigrok-cli.h"
37 #define DEFAULT_OUTPUT_FORMAT "bits:width=64"
39 static struct sr_context
*sr_ctx
= NULL
;
41 static uint64_t limit_samples
= 0;
42 static uint64_t limit_frames
= 0;
43 static struct sr_output_format
*output_format
= NULL
;
44 static int default_output_format
= FALSE
;
45 static char *output_format_param
= NULL
;
46 static GHashTable
*pd_ann_visible
= NULL
;
47 static GByteArray
*savebuf
;
49 static gboolean opt_version
= FALSE
;
50 static gint opt_loglevel
= SR_LOG_WARN
; /* Show errors+warnings per default. */
51 static gboolean opt_list_devs
= FALSE
;
52 static gboolean opt_wait_trigger
= FALSE
;
53 static gchar
*opt_input_file
= NULL
;
54 static gchar
*opt_output_file
= NULL
;
55 static gchar
*opt_drv
= NULL
;
56 static gchar
*opt_dev
= NULL
;
57 static gchar
*opt_probes
= NULL
;
58 static gchar
*opt_triggers
= NULL
;
59 static gchar
*opt_pds
= NULL
;
60 static gchar
*opt_pd_stack
= NULL
;
61 static gchar
*opt_pd_annotations
= NULL
;
62 static gchar
*opt_input_format
= NULL
;
63 static gchar
*opt_output_format
= NULL
;
64 static gchar
*opt_show
= NULL
;
65 static gchar
*opt_time
= NULL
;
66 static gchar
*opt_samples
= NULL
;
67 static gchar
*opt_frames
= NULL
;
68 static gchar
*opt_continuous
= NULL
;
70 static GOptionEntry optargs
[] = {
71 {"version", 'V', 0, G_OPTION_ARG_NONE
, &opt_version
,
72 "Show version and support list", NULL
},
73 {"loglevel", 'l', 0, G_OPTION_ARG_INT
, &opt_loglevel
,
74 "Set libsigrok/libsigrokdecode loglevel", NULL
},
75 {"list-devices", 'D', 0, G_OPTION_ARG_NONE
, &opt_list_devs
,
76 "Scan for devices", NULL
},
77 {"driver", 0, 0, G_OPTION_ARG_STRING
, &opt_drv
,
78 "Use only this driver", NULL
},
79 {"device", 'd', 0, G_OPTION_ARG_STRING
, &opt_dev
,
80 "Use specified device", NULL
},
81 {"input-file", 'i', 0, G_OPTION_ARG_FILENAME
, &opt_input_file
,
82 "Load input from file", NULL
},
83 {"input-format", 'I', 0, G_OPTION_ARG_STRING
, &opt_input_format
,
84 "Input format", NULL
},
85 {"output-file", 'o', 0, G_OPTION_ARG_FILENAME
, &opt_output_file
,
86 "Save output to file", NULL
},
87 {"output-format", 'O', 0, G_OPTION_ARG_STRING
, &opt_output_format
,
88 "Output format", NULL
},
89 {"probes", 'p', 0, G_OPTION_ARG_STRING
, &opt_probes
,
90 "Probes to use", NULL
},
91 {"triggers", 't', 0, G_OPTION_ARG_STRING
, &opt_triggers
,
92 "Trigger configuration", NULL
},
93 {"wait-trigger", 'w', 0, G_OPTION_ARG_NONE
, &opt_wait_trigger
,
94 "Wait for trigger", NULL
},
95 {"protocol-decoders", 'a', 0, G_OPTION_ARG_STRING
, &opt_pds
,
96 "Protocol decoders to run", NULL
},
97 {"protocol-decoder-stack", 's', 0, G_OPTION_ARG_STRING
, &opt_pd_stack
,
98 "Protocol decoder stack", NULL
},
99 {"protocol-decoder-annotations", 'A', 0, G_OPTION_ARG_STRING
, &opt_pd_annotations
,
100 "Protocol decoder annotation(s) to show", NULL
},
101 {"show", 0, 0, G_OPTION_ARG_NONE
, &opt_show
,
102 "Show device detail", NULL
},
103 {"time", 0, 0, G_OPTION_ARG_STRING
, &opt_time
,
104 "How long to sample (ms)", NULL
},
105 {"samples", 0, 0, G_OPTION_ARG_STRING
, &opt_samples
,
106 "Number of samples to acquire", NULL
},
107 {"frames", 0, 0, G_OPTION_ARG_STRING
, &opt_frames
,
108 "Number of frames to acquire", NULL
},
109 {"continuous", 0, 0, G_OPTION_ARG_NONE
, &opt_continuous
,
110 "Sample continuously", NULL
},
111 {NULL
, 0, 0, 0, NULL
, NULL
, NULL
}
115 /* Convert driver options hash to GSList of struct sr_hwopt. */
116 static GSList
*hash_to_hwopt(GHashTable
*hash
)
118 const struct sr_hwcap_option
*hwo
;
119 struct sr_hwopt
*hwopt
;
124 keys
= g_hash_table_get_keys(hash
);
126 for (gl
= keys
; gl
; gl
= gl
->next
) {
128 if (!(hwo
= sr_drvopt_name_get(key
))) {
129 g_critical("Unknown option %s", key
);
132 hwopt
= g_try_malloc(sizeof(struct sr_hwopt
));
133 hwopt
->hwopt
= hwo
->hwcap
;
134 value
= g_hash_table_lookup(hash
, key
);
135 hwopt
->value
= g_strdup(value
);
136 opts
= g_slist_append(opts
, hwopt
);
143 static void free_hwopt(struct sr_hwopt
*hwopt
)
145 g_free((void *)hwopt
->value
);
149 static GSList
*device_scan(void)
151 struct sr_dev_driver
**drivers
, *driver
;
153 GSList
*drvopts
, *devices
, *tmpdevs
, *l
;
158 drvargs
= parse_generic_arg(opt_drv
, TRUE
);
159 drvname
= g_strdup(g_hash_table_lookup(drvargs
, "sigrok_key"));
160 g_hash_table_remove(drvargs
, "sigrok_key");
162 drivers
= sr_driver_list();
163 for (i
= 0; drivers
[i
]; i
++) {
164 if (strcmp(drivers
[i
]->name
, drvname
))
169 g_critical("Driver %s not found.", drvname
);
173 if (sr_driver_init(sr_ctx
, driver
) != SR_OK
) {
174 g_critical("Failed to initialize driver.");
178 if (g_hash_table_size(drvargs
) > 0)
179 if (!(drvopts
= hash_to_hwopt(drvargs
)))
180 /* Unknown options, already logged. */
182 devices
= sr_driver_scan(driver
, drvopts
);
183 g_slist_free_full(drvopts
, (GDestroyNotify
)free_hwopt
);
185 /* No driver specified, let them all scan on their own. */
187 drivers
= sr_driver_list();
188 for (i
= 0; drivers
[i
]; i
++) {
190 if (sr_driver_init(sr_ctx
, driver
) != SR_OK
) {
191 g_critical("Failed to initialize driver.");
194 tmpdevs
= sr_driver_scan(driver
, NULL
);
195 for (l
= tmpdevs
; l
; l
= l
->next
)
196 devices
= g_slist_append(devices
, l
->data
);
197 g_slist_free(tmpdevs
);
204 static void show_version(void)
207 struct sr_dev_driver
**drivers
;
208 struct sr_input_format
**inputs
;
209 struct sr_output_format
**outputs
;
210 struct srd_decoder
*dec
;
213 printf("sigrok-cli %s\n\n", VERSION
);
215 printf("Using libsigrok %s (lib version %s).\n",
216 sr_package_version_string_get(), sr_lib_version_string_get());
217 printf("Using libsigrokdecode %s (lib version %s).\n\n",
218 srd_package_version_string_get(), srd_lib_version_string_get());
220 printf("Supported hardware drivers:\n");
221 drivers
= sr_driver_list();
222 for (i
= 0; drivers
[i
]; i
++) {
223 printf(" %-20s %s\n", drivers
[i
]->name
, drivers
[i
]->longname
);
227 printf("Supported input formats:\n");
228 inputs
= sr_input_list();
229 for (i
= 0; inputs
[i
]; i
++)
230 printf(" %-20s %s\n", inputs
[i
]->id
, inputs
[i
]->description
);
233 printf("Supported output formats:\n");
234 outputs
= sr_output_list();
235 for (i
= 0; outputs
[i
]; i
++)
236 printf(" %-20s %s\n", outputs
[i
]->id
, outputs
[i
]->description
);
239 if (srd_init(NULL
) == SRD_OK
) {
240 printf("Supported protocol decoders:\n");
241 srd_decoder_load_all();
242 for (l
= srd_decoder_list(); l
; l
= l
->next
) {
244 printf(" %-20s %s\n", dec
->id
, dec
->longname
);
245 /* Print protocol description upon "-l 3" or higher. */
246 if (opt_loglevel
>= SR_LOG_INFO
)
247 printf(" %-20s %s\n", "", dec
->desc
);
254 static void print_dev_line(const struct sr_dev_inst
*sdi
)
256 struct sr_probe
*probe
;
259 if (sdi
->vendor
&& sdi
->vendor
[0])
260 printf("%s ", sdi
->vendor
);
261 if (sdi
->model
&& sdi
->model
[0])
262 printf("%s ", sdi
->model
);
263 if (sdi
->version
&& sdi
->version
[0])
264 printf("%s ", sdi
->version
);
266 if (g_slist_length(sdi
->probes
) == 1) {
267 probe
= sdi
->probes
->data
;
268 printf("with 1 probe: %s", probe
->name
);
270 printf("with %d probes:", g_slist_length(sdi
->probes
));
271 for (l
= sdi
->probes
; l
; l
= l
->next
) {
273 printf(" %s", probe
->name
);
280 static void show_dev_list(void)
282 struct sr_dev_inst
*sdi
;
285 if (!(devices
= device_scan()))
288 printf("The following devices were found:\n");
289 for (l
= devices
; l
; l
= l
->next
) {
293 g_slist_free(devices
);
297 static void show_dev_detail(void)
299 struct sr_dev_inst
*sdi
;
300 const struct sr_hwcap_option
*hwo
;
301 const struct sr_samplerates
*samplerates
;
302 struct sr_rational
*rationals
;
305 const int *hwopts
, *hwcaps
;
306 int cap
, num_devices
, n
, i
;
308 const char *charopts
, **stropts
;
310 if (!(devices
= device_scan())) {
311 g_critical("No devices found.");
315 num_devices
= g_slist_length(devices
);
316 if (num_devices
> 1) {
318 g_critical("%d devices found. Use --list-devices to show them, "
319 "and --device to select one.", num_devices
);
322 /* opt_dev is NULL if not specified, which is fine. */
323 n
= strtol(opt_dev
, NULL
, 10);
324 if (n
>= num_devices
) {
325 g_critical("%d devices found, numbered starting from 0.",
329 sdi
= g_slist_nth_data(devices
, n
);
331 sdi
= g_slist_nth_data(devices
, 0);
335 if (sr_info_get(sdi
->driver
, SR_DI_TRIGGER_TYPES
, (const void **)&charopts
,
336 sdi
) == SR_OK
&& charopts
) {
337 printf("Supported triggers: ");
339 printf("%c ", *charopts
);
345 if ((sr_info_get(sdi
->driver
, SR_DI_HWOPTS
, (const void **)&hwopts
,
346 NULL
) == SR_OK
) && hwopts
) {
347 printf("Supported driver options:\n");
348 for (i
= 0; hwopts
[i
]; i
++) {
349 if (!(hwo
= sr_drvopt_get(hwopts
[i
])))
351 printf(" %s\n", hwo
->shortname
);
355 title
= "Supported device options:\n";
356 if ((sr_info_get(sdi
->driver
, SR_DI_HWCAPS
, (const void **)&hwcaps
,
357 NULL
) != SR_OK
) || !hwcaps
)
358 /* Driver supports no device instance options. */
361 for (cap
= 0; hwcaps
[cap
]; cap
++) {
362 if (!(hwo
= sr_devopt_get(hwcaps
[cap
])))
370 if (hwo
->hwcap
== SR_HWCAP_PATTERN_MODE
) {
371 /* Pattern generator modes */
372 printf(" %s", hwo
->shortname
);
373 if (sr_info_get(sdi
->driver
, SR_DI_PATTERNS
,
374 (const void **)&stropts
, sdi
) == SR_OK
) {
375 printf(" - supported patterns:\n");
376 for (i
= 0; stropts
[i
]; i
++)
377 printf(" %s\n", stropts
[i
]);
382 } else if (hwo
->hwcap
== SR_HWCAP_SAMPLERATE
) {
383 /* Supported samplerates */
384 printf(" %s", hwo
->shortname
);
385 if (sr_info_get(sdi
->driver
, SR_DI_SAMPLERATES
,
386 (const void **)&samplerates
, sdi
) != SR_OK
) {
390 if (samplerates
->step
) {
392 if (!(s
= sr_samplerate_string(samplerates
->low
)))
397 if (!(s
= sr_samplerate_string(samplerates
->high
)))
402 if (!(s
= sr_samplerate_string(samplerates
->step
)))
404 printf(" in steps of %s)\n", s
);
407 printf(" - supported samplerates:\n");
408 for (i
= 0; samplerates
->list
[i
]; i
++)
409 printf(" %s\n", sr_samplerate_string(samplerates
->list
[i
]));
412 } else if (hwo
->hwcap
== SR_HWCAP_BUFFERSIZE
) {
413 /* Supported buffer sizes */
414 printf(" %s", hwo
->shortname
);
415 if (sr_info_get(sdi
->driver
, SR_DI_BUFFERSIZES
,
416 (const void **)&integers
, sdi
) != SR_OK
) {
420 printf(" - supported buffer sizes:\n");
421 for (i
= 0; integers
[i
]; i
++)
422 printf(" %"PRIu64
"\n", integers
[i
]);
424 } else if (hwo
->hwcap
== SR_HWCAP_TIMEBASE
) {
425 /* Supported time bases */
426 printf(" %s", hwo
->shortname
);
427 if (sr_info_get(sdi
->driver
, SR_DI_TIMEBASES
,
428 (const void **)&rationals
, sdi
) != SR_OK
) {
432 printf(" - supported time bases:\n");
433 for (i
= 0; rationals
[i
].p
&& rationals
[i
].q
; i
++)
434 printf(" %s\n", sr_period_string(
435 rationals
[i
].p
* rationals
[i
].q
));
437 } else if (hwo
->hwcap
== SR_HWCAP_TRIGGER_SOURCE
) {
438 /* Supported trigger sources */
439 printf(" %s", hwo
->shortname
);
440 if (sr_info_get(sdi
->driver
, SR_DI_TRIGGER_SOURCES
,
441 (const void **)&stropts
, sdi
) != SR_OK
) {
445 printf(" - supported trigger sources:\n");
446 for (i
= 0; stropts
[i
]; i
++)
447 printf(" %s\n", stropts
[i
]);
449 } else if (hwo
->hwcap
== SR_HWCAP_FILTER
) {
450 /* Supported filters */
451 printf(" %s", hwo
->shortname
);
452 if (sr_info_get(sdi
->driver
, SR_DI_FILTERS
,
453 (const void **)&stropts
, sdi
) != SR_OK
) {
457 printf(" - supported filter targets:\n");
458 for (i
= 0; stropts
[i
]; i
++)
459 printf(" %s\n", stropts
[i
]);
461 } else if (hwo
->hwcap
== SR_HWCAP_VDIV
) {
462 /* Supported volts/div values */
463 printf(" %s", hwo
->shortname
);
464 if (sr_info_get(sdi
->driver
, SR_DI_VDIVS
,
465 (const void **)&rationals
, sdi
) != SR_OK
) {
469 printf(" - supported volts/div:\n");
470 for (i
= 0; rationals
[i
].p
&& rationals
[i
].q
; i
++)
471 printf(" %s\n", sr_voltage_string( &rationals
[i
]));
473 } else if (hwo
->hwcap
== SR_HWCAP_COUPLING
) {
474 /* Supported coupling settings */
475 printf(" %s", hwo
->shortname
);
476 if (sr_info_get(sdi
->driver
, SR_DI_COUPLING
,
477 (const void **)&stropts
, sdi
) != SR_OK
) {
481 printf(" - supported coupling options:\n");
482 for (i
= 0; stropts
[i
]; i
++)
483 printf(" %s\n", stropts
[i
]);
486 /* Everything else */
487 printf(" %s\n", hwo
->shortname
);
493 static void show_pd_detail(void)
496 struct srd_decoder
*dec
;
497 char **pdtokens
, **pdtok
, **ann
, *doc
;
500 pdtokens
= g_strsplit(opt_pds
, ",", -1);
501 for (pdtok
= pdtokens
; *pdtok
; pdtok
++) {
502 if (!(dec
= srd_decoder_get_by_id(*pdtok
))) {
503 g_critical("Protocol decoder %s not found.", *pdtok
);
506 printf("ID: %s\nName: %s\nLong name: %s\nDescription: %s\n",
507 dec
->id
, dec
->name
, dec
->longname
, dec
->desc
);
508 printf("License: %s\n", dec
->license
);
509 printf("Annotations:\n");
510 if (dec
->annotations
) {
511 for (l
= dec
->annotations
; l
; l
= l
->next
) {
513 printf("- %s\n %s\n", ann
[0], ann
[1]);
518 /* TODO: Print supported decoder options. */
519 printf("Required probes:\n");
521 for (l
= dec
->probes
; l
; l
= l
->next
) {
523 printf("- %s (%s): %s\n",
524 p
->name
, p
->id
, p
->desc
);
529 printf("Optional probes:\n");
530 if (dec
->opt_probes
) {
531 for (l
= dec
->opt_probes
; l
; l
= l
->next
) {
533 printf("- %s (%s): %s\n",
534 p
->name
, p
->id
, p
->desc
);
539 if ((doc
= srd_decoder_doc_get(dec
))) {
540 printf("Documentation:\n%s\n",
541 doc
[0] == '\n' ? doc
+ 1 : doc
);
546 g_strfreev(pdtokens
);
549 static GArray
*get_enabled_logic_probes(const struct sr_dev_inst
*sdi
)
551 struct sr_probe
*probe
;
555 probes
= g_array_new(FALSE
, FALSE
, sizeof(int));
556 for (l
= sdi
->probes
; l
; l
= l
->next
) {
558 if (probe
->type
!= SR_PROBE_LOGIC
)
560 if (probe
->enabled
!= TRUE
)
562 g_array_append_val(probes
, probe
->index
);
568 static void datafeed_in(const struct sr_dev_inst
*sdi
,
569 const struct sr_datafeed_packet
*packet
)
571 const struct sr_datafeed_logic
*logic
;
572 const struct sr_datafeed_analog
*analog
;
573 static struct sr_output
*o
= NULL
;
574 static GArray
*logic_probelist
= NULL
;
575 static uint64_t received_samples
= 0;
576 static int unitsize
= 0;
577 static int triggered
= 0;
578 static FILE *outfile
= NULL
;
579 int sample_size
, ret
;
580 uint64_t *samplerate
, output_len
, filter_out_len
;
581 uint8_t *output_buf
, *filter_out
;
584 /* If the first packet to come in isn't a header, don't even try. */
585 if (packet
->type
!= SR_DF_HEADER
&& o
== NULL
)
589 switch (packet
->type
) {
591 g_debug("cli: Received SR_DF_HEADER");
592 /* Initialize the output module. */
593 if (!(o
= g_try_malloc(sizeof(struct sr_output
)))) {
594 g_critical("Output module malloc failed.");
597 o
->format
= output_format
;
598 o
->sdi
= (struct sr_dev_inst
*)sdi
;
599 o
->param
= output_format_param
;
600 if (o
->format
->init
) {
601 if (o
->format
->init(o
) != SR_OK
) {
602 g_critical("Output format initialization failed.");
607 /* Prepare non-stdout output. */
609 if (opt_output_file
) {
610 if (default_output_format
) {
611 /* output file is in session format, so we'll
612 * keep a copy of everything as it comes in
613 * and save from there after the session. */
615 savebuf
= g_byte_array_new();
617 /* saving to a file in whatever format was set
618 * with --format, so all we need is a filehandle */
619 outfile
= g_fopen(opt_output_file
, "wb");
623 /* Prepare for logic data. */
624 logic_probelist
= get_enabled_logic_probes(sdi
);
625 /* How many bytes we need to store the packed samples. */
626 unitsize
= (logic_probelist
->len
+ 7) / 8;
628 if (opt_pds
&& logic_probelist
->len
) {
629 if (sr_info_get(sdi
->driver
, SR_DI_CUR_SAMPLERATE
,
630 (const void **)&samplerate
, sdi
) != SR_OK
) {
631 g_critical("Unable to initialize protocol "
632 "decoders: no samplerate found.");
635 srd_session_start(logic_probelist
->len
, unitsize
,
641 g_debug("cli: Received SR_DF_END");
643 g_debug("cli: double end!");
646 if (o
->format
->event
) {
647 o
->format
->event(o
, SR_DF_END
, &output_buf
, &output_len
);
650 fwrite(output_buf
, 1, output_len
, outfile
);
655 if (limit_samples
&& received_samples
< limit_samples
)
656 g_warning("Device only sent %" PRIu64
" samples.",
659 g_warning("Device stopped after %" PRIu64
" samples.",
662 if (outfile
&& outfile
!= stdout
)
665 if (opt_output_file
&& default_output_format
) {
666 if (sr_session_save(opt_output_file
, sdi
, savebuf
->data
,
667 unitsize
, savebuf
->len
/ unitsize
) != SR_OK
)
668 g_critical("Failed to save session.");
669 g_byte_array_free(savebuf
, FALSE
);
672 g_array_free(logic_probelist
, TRUE
);
673 if (o
->format
->cleanup
)
674 o
->format
->cleanup(o
);
680 g_debug("cli: received SR_DF_TRIGGER");
681 if (o
->format
->event
)
682 o
->format
->event(o
, SR_DF_TRIGGER
, &output_buf
,
688 logic
= packet
->payload
;
689 g_message("cli: received SR_DF_LOGIC, %"PRIu64
" bytes", logic
->length
);
690 sample_size
= logic
->unitsize
;
691 if (logic
->length
== 0)
694 /* Don't store any samples until triggered. */
695 if (opt_wait_trigger
&& !triggered
)
698 if (limit_samples
&& received_samples
>= limit_samples
)
701 ret
= sr_filter_probes(sample_size
, unitsize
, logic_probelist
,
702 logic
->data
, logic
->length
,
703 &filter_out
, &filter_out_len
);
707 /* What comes out of the filter is guaranteed to be packed into the
708 * minimum size needed to support the number of samples at this sample
709 * size. however, the driver may have submitted too much -- cut off
710 * the buffer of the last packet according to the sample limit.
712 if (limit_samples
&& (received_samples
+ logic
->length
/ sample_size
>
713 limit_samples
* sample_size
))
714 filter_out_len
= limit_samples
* sample_size
- received_samples
;
716 if (opt_output_file
&& default_output_format
) {
717 /* Saving to a session file. */
718 g_byte_array_append(savebuf
, filter_out
, filter_out_len
);
721 if (srd_session_send(received_samples
, (uint8_t*)filter_out
,
722 filter_out_len
) != SRD_OK
)
726 if (o
->format
->data
&& packet
->type
== o
->format
->df_type
)
727 o
->format
->data(o
, filter_out
, filter_out_len
,
728 &output_buf
, &output_len
);
730 fwrite(output_buf
, 1, output_len
, outfile
);
738 received_samples
+= logic
->length
/ sample_size
;
742 analog
= packet
->payload
;
743 g_message("cli: received SR_DF_ANALOG, %d samples", analog
->num_samples
);
744 if (analog
->num_samples
== 0)
747 if (limit_samples
&& received_samples
>= limit_samples
)
750 if (o
->format
->data
&& packet
->type
== o
->format
->df_type
) {
751 o
->format
->data(o
, (const uint8_t *)analog
->data
,
752 analog
->num_samples
* sizeof(float),
753 &output_buf
, &output_len
);
755 fwrite(output_buf
, 1, output_len
, outfile
);
761 received_samples
+= analog
->num_samples
;
764 case SR_DF_FRAME_BEGIN
:
765 g_debug("cli: received SR_DF_FRAME_BEGIN");
766 if (o
->format
->event
) {
767 o
->format
->event(o
, SR_DF_FRAME_BEGIN
, &output_buf
,
770 fwrite(output_buf
, 1, output_len
, outfile
);
777 case SR_DF_FRAME_END
:
778 g_debug("cli: received SR_DF_FRAME_END");
779 if (o
->format
->event
) {
780 o
->format
->event(o
, SR_DF_FRAME_END
, &output_buf
,
783 fwrite(output_buf
, 1, output_len
, outfile
);
794 if (o
&& o
->format
->recv
) {
795 out
= o
->format
->recv(o
, sdi
, packet
);
796 if (out
&& out
->len
) {
797 fwrite(out
->str
, 1, out
->len
, outfile
);
804 /* Register the given PDs for this session.
805 * Accepts a string of the form: "spi:sck=3:sdata=4,spi:sck=3:sdata=5"
806 * That will instantiate two SPI decoders on the clock but different data
809 static int register_pds(struct sr_dev
*dev
, const char *pdstring
)
811 GHashTable
*pd_opthash
;
812 struct srd_decoder_inst
*di
;
814 char **pdtokens
, **pdtok
, *pd_name
;
819 pd_ann_visible
= g_hash_table_new_full(g_str_hash
, g_int_equal
,
823 pdtokens
= g_strsplit(pdstring
, ",", 0);
824 for (pdtok
= pdtokens
; *pdtok
; pdtok
++) {
825 if (!(pd_opthash
= parse_generic_arg(*pdtok
, TRUE
))) {
826 g_critical("Invalid protocol decoder option '%s'.", *pdtok
);
830 pd_name
= g_strdup(g_hash_table_lookup(pd_opthash
, "sigrok_key"));
831 g_hash_table_remove(pd_opthash
, "sigrok_key");
832 if (srd_decoder_load(pd_name
) != SRD_OK
) {
833 g_critical("Failed to load protocol decoder %s.", pd_name
);
837 if (!(di
= srd_inst_new(pd_name
, pd_opthash
))) {
838 g_critical("Failed to instantiate protocol decoder %s.", pd_name
);
843 /* If no annotation list was specified, add them all in now.
844 * This will be pared down later to leave only the last PD
847 if (!opt_pd_annotations
)
848 g_hash_table_insert(pd_ann_visible
,
849 g_strdup(di
->inst_id
), NULL
);
851 /* Any keys left in the options hash are probes, where the key
852 * is the probe name as specified in the decoder class, and the
853 * value is the probe number i.e. the order in which the PD's
854 * incoming samples are arranged. */
855 if (srd_inst_probe_set_all(di
, pd_opthash
) != SRD_OK
) {
859 g_hash_table_destroy(pd_opthash
);
864 g_strfreev(pdtokens
);
866 g_hash_table_destroy(pd_opthash
);
873 int setup_pd_stack(void)
875 struct srd_decoder_inst
*di_from
, *di_to
;
879 /* Set up the protocol decoder stack. */
880 pds
= g_strsplit(opt_pds
, ",", 0);
881 if (g_strv_length(pds
) > 1) {
883 /* A stack setup was specified, use that. */
885 pds
= g_strsplit(opt_pd_stack
, ",", 0);
886 if (g_strv_length(pds
) < 2) {
888 g_critical("Specify at least two protocol decoders to stack.");
893 /* First PD goes at the bottom of the stack. */
894 ids
= g_strsplit(pds
[0], ":", 0);
895 if (!(di_from
= srd_inst_find_by_id(ids
[0]))) {
897 g_critical("Cannot stack protocol decoder '%s': "
898 "instance not found.", pds
[0]);
903 /* Every subsequent PD goes on top. */
904 for (i
= 1; pds
[i
]; i
++) {
905 ids
= g_strsplit(pds
[i
], ":", 0);
906 if (!(di_to
= srd_inst_find_by_id(ids
[0]))) {
908 g_critical("Cannot stack protocol decoder '%s': "
909 "instance not found.", pds
[i
]);
913 if ((ret
= srd_inst_stack(di_from
, di_to
)) != SRD_OK
)
916 /* Don't show annotation from this PD. Only the last PD in
917 * the stack will be left on the annotation list (unless
918 * the annotation list was specifically provided).
920 if (!opt_pd_annotations
)
921 g_hash_table_remove(pd_ann_visible
,
932 int setup_pd_annotations(void)
935 struct srd_decoder
*dec
;
937 char **pds
, **pdtok
, **keyval
, **ann_descr
;
939 /* Set up custom list of PDs and annotations to show. */
940 if (opt_pd_annotations
) {
941 pds
= g_strsplit(opt_pd_annotations
, ",", 0);
942 for (pdtok
= pds
; *pdtok
&& **pdtok
; pdtok
++) {
944 keyval
= g_strsplit(*pdtok
, "=", 0);
945 if (!(dec
= srd_decoder_get_by_id(keyval
[0]))) {
946 g_critical("Protocol decoder '%s' not found.", keyval
[0]);
949 if (!dec
->annotations
) {
950 g_critical("Protocol decoder '%s' has no annotations.", keyval
[0]);
953 if (g_strv_length(keyval
) == 2) {
954 for (l
= dec
->annotations
; l
; l
= l
->next
, ann
++) {
956 if (!canon_cmp(ann_descr
[0], keyval
[1]))
961 g_critical("Annotation '%s' not found "
962 "for protocol decoder '%s'.", keyval
[1], keyval
[0]);
966 g_debug("cli: showing protocol decoder annotation %d from '%s'", ann
, keyval
[0]);
967 g_hash_table_insert(pd_ann_visible
, g_strdup(keyval
[0]), GINT_TO_POINTER(ann
));
976 int setup_output_format(void)
981 struct sr_output_format
**outputs
;
985 if (!opt_output_format
) {
986 opt_output_format
= DEFAULT_OUTPUT_FORMAT
;
987 /* we'll need to remember this so when saving to a file
988 * later, sigrok session format will be used.
990 default_output_format
= TRUE
;
993 fmtargs
= parse_generic_arg(opt_output_format
, TRUE
);
994 fmtspec
= g_hash_table_lookup(fmtargs
, "sigrok_key");
996 g_critical("Invalid output format.");
999 outputs
= sr_output_list();
1000 for (i
= 0; outputs
[i
]; i
++) {
1001 if (strcmp(outputs
[i
]->id
, fmtspec
))
1003 g_hash_table_remove(fmtargs
, "sigrok_key");
1004 output_format
= outputs
[i
];
1005 g_hash_table_iter_init(&iter
, fmtargs
);
1006 while (g_hash_table_iter_next(&iter
, &key
, &value
)) {
1007 /* only supporting one parameter per output module
1008 * for now, and only its value */
1009 output_format_param
= g_strdup(value
);
1014 if (!output_format
) {
1015 g_critical("Invalid output format %s.", opt_output_format
);
1018 g_hash_table_destroy(fmtargs
);
1023 void show_pd_annotations(struct srd_proto_data
*pdata
, void *cb_data
)
1027 gpointer ann_format
;
1029 /* 'cb_data' is not used in this specific callback. */
1032 if (!pd_ann_visible
)
1035 if (!g_hash_table_lookup_extended(pd_ann_visible
, pdata
->pdo
->di
->inst_id
,
1037 /* Not in the list of PDs whose annotations we're showing. */
1040 if (pdata
->ann_format
!= GPOINTER_TO_INT(ann_format
))
1041 /* We don't want this particular format from the PD. */
1044 annotations
= pdata
->data
;
1045 if (opt_loglevel
> SR_LOG_WARN
)
1046 printf("%"PRIu64
"-%"PRIu64
" ", pdata
->start_sample
, pdata
->end_sample
);
1047 printf("%s: ", pdata
->pdo
->proto_id
);
1048 for (i
= 0; annotations
[i
]; i
++)
1049 printf("\"%s\" ", annotations
[i
]);
1054 static int select_probes(struct sr_dev_inst
*sdi
)
1056 struct sr_probe
*probe
;
1057 GSList
*selected_probes
, *l
;
1062 if (!(selected_probes
= parse_probestring(sdi
, opt_probes
)))
1065 for (l
= sdi
->probes
; l
; l
= l
->next
) {
1067 if (g_slist_find(selected_probes
, probe
))
1068 probe
->enabled
= TRUE
;
1070 probe
->enabled
= FALSE
;
1072 g_slist_free(selected_probes
);
1078 * Return the input file format which the CLI tool should use.
1080 * If the user specified -I / --input-format, use that one. Otherwise, try to
1081 * autodetect the format as good as possible. Failing that, return NULL.
1083 * @param filename The filename of the input file. Must not be NULL.
1084 * @param opt The -I / --input-file option the user specified (or NULL).
1086 * @return A pointer to the 'struct sr_input_format' that should be used,
1087 * or NULL if no input format was selected or auto-detected.
1089 static struct sr_input_format
*determine_input_file_format(
1090 const char *filename
, const char *opt
)
1093 struct sr_input_format
**inputs
;
1095 /* If there are no input formats, return NULL right away. */
1096 inputs
= sr_input_list();
1098 g_critical("No supported input formats available.");
1102 /* If the user specified -I / --input-format, use that one. */
1104 for (i
= 0; inputs
[i
]; i
++) {
1105 if (strcasecmp(inputs
[i
]->id
, opt
))
1107 g_debug("Using user-specified input file format '%s'.",
1112 /* The user specified an unknown input format, return NULL. */
1113 g_critical("Error: specified input file format '%s' is "
1118 /* Otherwise, try to find an input module that can handle this file. */
1119 for (i
= 0; inputs
[i
]; i
++) {
1120 if (inputs
[i
]->format_match(filename
))
1124 /* Return NULL if no input module wanted to touch this. */
1126 g_critical("Error: no matching input module found.");
1130 g_debug("cli: Autodetected '%s' input format for file '%s'.",
1131 inputs
[i
]->id
, filename
);
1136 static void load_input_file_format(void)
1138 GHashTable
*fmtargs
= NULL
;
1140 struct sr_input
*in
;
1141 struct sr_input_format
*input_format
;
1142 char *fmtspec
= NULL
;
1144 if (opt_input_format
) {
1145 fmtargs
= parse_generic_arg(opt_input_format
, TRUE
);
1146 fmtspec
= g_hash_table_lookup(fmtargs
, "sigrok_key");
1149 if (!(input_format
= determine_input_file_format(opt_input_file
,
1151 /* The exact cause was already logged. */
1156 g_hash_table_remove(fmtargs
, "sigrok_key");
1158 if (stat(opt_input_file
, &st
) == -1) {
1159 g_critical("Failed to load %s: %s", opt_input_file
,
1164 /* Initialize the input module. */
1165 if (!(in
= g_try_malloc(sizeof(struct sr_input
)))) {
1166 g_critical("Failed to allocate input module.");
1169 in
->format
= input_format
;
1170 in
->param
= fmtargs
;
1171 if (in
->format
->init
) {
1172 if (in
->format
->init(in
) != SR_OK
) {
1173 g_critical("Input format init failed.");
1178 if (select_probes(in
->sdi
) > 0)
1182 sr_session_datafeed_callback_add(datafeed_in
);
1183 if (sr_session_dev_add(in
->sdi
) != SR_OK
) {
1184 g_critical("Failed to use device.");
1185 sr_session_destroy();
1189 input_format
->loadfile(in
, opt_input_file
);
1191 sr_session_destroy();
1194 g_hash_table_destroy(fmtargs
);
1197 static void load_input_file(void)
1200 if (sr_session_load(opt_input_file
) == SR_OK
) {
1201 /* sigrok session file */
1202 sr_session_datafeed_callback_add(datafeed_in
);
1208 /* fall back on input modules */
1209 load_input_file_format();
1213 static int set_dev_options(struct sr_dev_inst
*sdi
, GHashTable
*args
)
1215 const struct sr_hwcap_option
*hwo
;
1216 GHashTableIter iter
;
1217 gpointer key
, value
;
1221 struct sr_rational tmp_rat
;
1225 g_hash_table_iter_init(&iter
, args
);
1226 while (g_hash_table_iter_next(&iter
, &key
, &value
)) {
1227 if (!(hwo
= sr_devopt_name_get(key
))) {
1228 g_critical("Unknown device option '%s'.", (char *) key
);
1232 if ((value
== NULL
) &&
1233 (hwo
->type
!= SR_T_BOOL
)) {
1234 g_critical("Option '%s' needs a value.", (char *)key
);
1238 switch (hwo
->type
) {
1240 ret
= sr_parse_sizestring(value
, &tmp_u64
);
1252 tmp_bool
= sr_parse_boolstring(value
);
1256 tmp_float
= strtof(value
, NULL
);
1259 case SR_T_RATIONAL_PERIOD
:
1260 if ((ret
= sr_parse_period(value
, &tmp_rat
)) != SR_OK
)
1264 case SR_T_RATIONAL_VOLT
:
1265 if ((ret
= sr_parse_voltage(value
, &tmp_rat
)) != SR_OK
)
1273 ret
= sr_dev_config_set(sdi
, hwo
->hwcap
, val
);
1275 g_critical("Failed to set device option '%s'.", (char *)key
);
1283 static int set_limit_time(const struct sr_dev_inst
*sdi
)
1286 uint64_t *samplerate
;
1288 time_msec
= sr_parse_timestring(opt_time
);
1289 if (time_msec
== 0) {
1290 g_critical("Invalid time '%s'", opt_time
);
1291 sr_session_destroy();
1295 if (sr_driver_hwcap_exists(sdi
->driver
, SR_HWCAP_LIMIT_MSEC
)) {
1296 if (sr_dev_config_set(sdi
, SR_HWCAP_LIMIT_MSEC
, &time_msec
) != SR_OK
) {
1297 g_critical("Failed to configure time limit.");
1298 sr_session_destroy();
1303 /* time limit set, but device doesn't support this...
1304 * convert to samples based on the samplerate.
1307 if (sr_dev_has_hwcap(sdi
, SR_HWCAP_SAMPLERATE
)) {
1308 sr_info_get(sdi
->driver
, SR_DI_CUR_SAMPLERATE
,
1309 (const void **)&samplerate
, sdi
);
1310 limit_samples
= (*samplerate
) * time_msec
/ (uint64_t)1000;
1312 if (limit_samples
== 0) {
1313 g_critical("Not enough time at this samplerate.");
1314 sr_session_destroy();
1318 if (sr_dev_config_set(sdi
, SR_HWCAP_LIMIT_SAMPLES
,
1319 &limit_samples
) != SR_OK
) {
1320 g_critical("Failed to configure time-based sample limit.");
1321 sr_session_destroy();
1329 static void run_session(void)
1332 GHashTable
*devargs
;
1333 struct sr_dev_inst
*sdi
;
1337 devices
= device_scan();
1339 g_critical("No devices found.");
1342 if (g_slist_length(devices
) > 1) {
1343 g_critical("sigrok-cli only supports one device for capturing.");
1346 sdi
= devices
->data
;
1349 sr_session_datafeed_callback_add(datafeed_in
);
1351 if (sr_session_dev_add(sdi
) != SR_OK
) {
1352 g_critical("Failed to use device.");
1353 sr_session_destroy();
1358 if ((devargs
= parse_generic_arg(opt_dev
, FALSE
))) {
1359 if (set_dev_options(sdi
, devargs
) != SR_OK
)
1361 g_hash_table_destroy(devargs
);
1365 if (select_probes(sdi
) != SR_OK
) {
1366 g_critical("Failed to set probes.");
1367 sr_session_destroy();
1372 if (!(triggerlist
= sr_parse_triggerstring(sdi
, opt_triggers
))) {
1373 sr_session_destroy();
1376 max_probes
= g_slist_length(sdi
->probes
);
1377 for (i
= 0; i
< max_probes
; i
++) {
1378 if (triggerlist
[i
]) {
1379 sr_dev_trigger_set(sdi
, i
, triggerlist
[i
]);
1380 g_free(triggerlist
[i
]);
1383 g_free(triggerlist
);
1386 if (opt_continuous
) {
1387 if (!sr_driver_hwcap_exists(sdi
->driver
, SR_HWCAP_CONTINUOUS
)) {
1388 g_critical("This device does not support continuous sampling.");
1389 sr_session_destroy();
1395 if (set_limit_time(sdi
) != SR_OK
) {
1396 sr_session_destroy();
1402 if ((sr_parse_sizestring(opt_samples
, &limit_samples
) != SR_OK
)
1403 || (sr_dev_config_set(sdi
, SR_HWCAP_LIMIT_SAMPLES
,
1404 &limit_samples
) != SR_OK
)) {
1405 g_critical("Failed to configure sample limit.");
1406 sr_session_destroy();
1412 if ((sr_parse_sizestring(opt_frames
, &limit_frames
) != SR_OK
)
1413 || (sr_dev_config_set(sdi
, SR_HWCAP_LIMIT_FRAMES
,
1414 &limit_frames
) != SR_OK
)) {
1415 g_critical("Failed to configure frame limit.");
1416 sr_session_destroy();
1421 if (sr_session_start() != SR_OK
) {
1422 g_critical("Failed to start session.");
1423 sr_session_destroy();
1435 sr_session_destroy();
1436 g_slist_free(devices
);
1440 static void logger(const gchar
*log_domain
, GLogLevelFlags log_level
,
1441 const gchar
*message
, gpointer cb_data
)
1447 * All messages, warnings, errors etc. go to stderr (not stdout) in
1448 * order to not mess up the CLI tool data output, e.g. VCD output.
1450 if (log_level
& (G_LOG_LEVEL_ERROR
| G_LOG_LEVEL_CRITICAL
| G_LOG_LEVEL_WARNING
)
1451 || opt_loglevel
> SR_LOG_WARN
) {
1452 fprintf(stderr
, "%s\n", message
);
1457 int main(int argc
, char **argv
)
1460 GOptionContext
*context
;
1463 g_log_set_default_handler(logger
, NULL
);
1466 context
= g_option_context_new(NULL
);
1467 g_option_context_add_main_entries(context
, optargs
, NULL
);
1469 if (!g_option_context_parse(context
, &argc
, &argv
, &error
)) {
1470 g_critical("%s", error
->message
);
1474 /* Set the loglevel (amount of messages to output) for libsigrok. */
1475 if (sr_log_loglevel_set(opt_loglevel
) != SR_OK
)
1478 /* Set the loglevel (amount of messages to output) for libsigrokdecode. */
1479 if (srd_log_loglevel_set(opt_loglevel
) != SRD_OK
)
1482 if (sr_init(&sr_ctx
) != SR_OK
)
1486 if (srd_init(NULL
) != SRD_OK
)
1488 if (register_pds(NULL
, opt_pds
) != 0)
1490 if (srd_pd_output_callback_add(SRD_OUTPUT_ANN
,
1491 show_pd_annotations
, NULL
) != SRD_OK
)
1493 if (setup_pd_stack() != 0)
1495 if (setup_pd_annotations() != 0)
1499 if (setup_output_format() != 0)
1504 else if (opt_list_devs
)
1506 else if (opt_pds
&& opt_show
)
1510 else if (opt_input_file
)
1512 else if (opt_samples
|| opt_time
|| opt_frames
|| opt_continuous
)
1515 printf("%s", g_option_context_get_help(context
, TRUE
, NULL
));
1526 g_option_context_free(context
);