2 * This file is part of the libsigrok project.
4 * Copyright (C) 2013 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/>.
24 #ifndef LIBSIGROK_LIBSIGROK_INTERNAL_H
25 #define LIBSIGROK_LIBSIGROK_INTERNAL_H
29 #include "config.h" /* Needed for HAVE_LIBUSB_1_0 and others. */
30 #ifdef HAVE_LIBUSB_1_0
33 #ifdef HAVE_LIBSERIALPORT
34 #include <libserialport.h>
40 * libsigrok private header file, only to be used internally.
43 /*--- Macros ----------------------------------------------------------------*/
46 #define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0]))
49 #ifndef ARRAY_AND_SIZE
50 #define ARRAY_AND_SIZE(a) (a), ARRAY_SIZE(a)
54 * Read a 8 bits unsigned integer out of memory.
55 * @param x a pointer to the input memory
56 * @return the corresponding unsigned integer
58 #define R8(x) ((unsigned)((const uint8_t*)(x))[0])
61 * Read a 16 bits big endian unsigned integer out of memory.
62 * @param x a pointer to the input memory
63 * @return the corresponding unsigned integer
65 #define RB16(x) (((unsigned)((const uint8_t*)(x))[0] << 8) | \
66 (unsigned)((const uint8_t*)(x))[1])
69 * Read a 16 bits little endian unsigned integer out of memory.
70 * @param x a pointer to the input memory
71 * @return the corresponding unsigned integer
73 #define RL16(x) (((unsigned)((const uint8_t*)(x))[1] << 8) | \
74 (unsigned)((const uint8_t*)(x))[0])
77 * Read a 16 bits little endian signed integer out of memory.
78 * @param x a pointer to the input memory
79 * @return the corresponding signed integer
81 #define RL16S(x) ((int16_t) \
82 (((unsigned)((const uint8_t*)(x))[1] << 8) | \
83 (unsigned)((const uint8_t*)(x))[0]))
86 * Read a 32 bits big endian unsigned integer out of memory.
87 * @param x a pointer to the input memory
88 * @return the corresponding unsigned integer
90 #define RB32(x) (((unsigned)((const uint8_t*)(x))[0] << 24) | \
91 ((unsigned)((const uint8_t*)(x))[1] << 16) | \
92 ((unsigned)((const uint8_t*)(x))[2] << 8) | \
93 (unsigned)((const uint8_t*)(x))[3])
96 * Read a 32 bits little endian unsigned integer out of memory.
97 * @param x a pointer to the input memory
98 * @return the corresponding unsigned integer
100 #define RL32(x) (((unsigned)((const uint8_t*)(x))[3] << 24) | \
101 ((unsigned)((const uint8_t*)(x))[2] << 16) | \
102 ((unsigned)((const uint8_t*)(x))[1] << 8) | \
103 (unsigned)((const uint8_t*)(x))[0])
106 * Read a 32 bits little endian signed integer out of memory.
107 * @param x a pointer to the input memory
108 * @return the corresponding signed integer
110 #define RL32S(x) ((int32_t) \
111 (((unsigned)((const uint8_t*)(x))[3] << 24) | \
112 ((unsigned)((const uint8_t*)(x))[2] << 16) | \
113 ((unsigned)((const uint8_t*)(x))[1] << 8) | \
114 (unsigned)((const uint8_t*)(x))[0]))
117 * Read a 32 bits big endian float out of memory.
118 * @param x a pointer to the input memory
119 * @return the corresponding float
121 #define RBFL(x) ((union { uint32_t u; float f; }) { .u = RB32(x) }.f)
124 * Read a 32 bits little endian float out of memory.
125 * @param x a pointer to the input memory
126 * @return the corresponding float
128 #define RLFL(x) ((union { uint32_t u; float f; }) { .u = RL32(x) }.f)
131 * Write a 8 bits unsigned integer to memory.
132 * @param p a pointer to the output memory
133 * @param x the input unsigned integer
135 #define W8(p, x) do { ((uint8_t*)(p))[0] = (uint8_t) (x); } while (0)
138 * Write a 16 bits unsigned integer to memory stored as big endian.
139 * @param p a pointer to the output memory
140 * @param x the input unsigned integer
142 #define WB16(p, x) do { ((uint8_t*)(p))[1] = (uint8_t) (x); \
143 ((uint8_t*)(p))[0] = (uint8_t)((x)>>8); } while (0)
146 * Write a 16 bits unsigned integer to memory stored as little endian.
147 * @param p a pointer to the output memory
148 * @param x the input unsigned integer
150 #define WL16(p, x) do { ((uint8_t*)(p))[0] = (uint8_t) (x); \
151 ((uint8_t*)(p))[1] = (uint8_t)((x)>>8); } while (0)
154 * Write a 32 bits unsigned integer to memory stored as big endian.
155 * @param p a pointer to the output memory
156 * @param x the input unsigned integer
158 #define WB32(p, x) do { ((uint8_t*)(p))[3] = (uint8_t) (x); \
159 ((uint8_t*)(p))[2] = (uint8_t)((x)>>8); \
160 ((uint8_t*)(p))[1] = (uint8_t)((x)>>16); \
161 ((uint8_t*)(p))[0] = (uint8_t)((x)>>24); } while (0)
164 * Write a 32 bits unsigned integer to memory stored as little endian.
165 * @param p a pointer to the output memory
166 * @param x the input unsigned integer
168 #define WL32(p, x) do { ((uint8_t*)(p))[0] = (uint8_t) (x); \
169 ((uint8_t*)(p))[1] = (uint8_t)((x)>>8); \
170 ((uint8_t*)(p))[2] = (uint8_t)((x)>>16); \
171 ((uint8_t*)(p))[3] = (uint8_t)((x)>>24); } while (0)
174 * Write a 32 bits float to memory stored as big endian.
175 * @param p a pointer to the output memory
176 * @param x the input float
178 #define WBFL(p, x) WB32(p, (union { uint32_t u; float f; }) { .f = x }.u)
181 * Write a 32 bits float to memory stored as little endian.
182 * @param p a pointer to the output memory
183 * @param x the input float
185 #define WLFL(p, x) WL32(p, (union { uint32_t u; float f; }) { .f = x }.u)
187 /* Portability fixes for FreeBSD. */
189 #define LIBUSB_CLASS_APPLICATION 0xfe
190 #define libusb_has_capability(x) 0
191 #define libusb_handle_events_timeout_completed(ctx, tv, c) \
192 libusb_handle_events_timeout(ctx, tv)
195 /* Static definitions of structs ending with an all-zero entry are a
196 * problem when compiling with -Wmissing-field-initializers: GCC
197 * suppresses the warning only with { 0 }, clang wants { } */
201 #define ALL_ZERO { 0 }
205 struct sr_dev_driver **driver_list;
206 #ifdef HAVE_LIBUSB_1_0
207 libusb_context *libusb_ctx;
208 gboolean usb_source_present;
211 gboolean usb_thread_running;
212 HANDLE usb_wait_request_event;
213 HANDLE usb_wait_complete_event;
215 sr_receive_data_callback usb_cb;
221 /** Input module metadata keys. */
222 enum sr_input_meta_keys {
223 /** The input filename, if there is one. */
224 SR_INPUT_META_FILENAME = 0x01,
225 /** The input file's size in bytes. */
226 SR_INPUT_META_FILESIZE = 0x02,
227 /** The first 128 bytes of the file, provided as a GString. */
228 SR_INPUT_META_HEADER = 0x04,
229 /** The file's MIME type. */
230 SR_INPUT_META_MIMETYPE = 0x08,
232 /** The module cannot identify a file without this metadata. */
233 SR_INPUT_META_REQUIRED = 0x80,
236 /** Input (file) module struct. */
239 * A pointer to this input module's 'struct sr_input_module'.
241 const struct sr_input_module *module;
243 struct sr_dev_inst *sdi;
248 /** Input (file) module driver. */
249 struct sr_input_module {
251 * A unique ID for this input module, suitable for use in command-line
252 * clients, [a-z0-9-]. Must not be NULL.
257 * A unique name for this input module, suitable for use in GUI
258 * clients, can contain UTF-8. Must not be NULL.
263 * A short description of the input module. Must not be NULL.
265 * This can be displayed by frontends, e.g. when selecting the input
266 * module for saving a file.
271 * A NULL terminated array of strings containing a list of file name
272 * extensions typical for the input file format, or NULL if there is
273 * no typical extension for this file format.
275 const char *const *exts;
278 * Zero-terminated list of metadata items the module needs to be able
279 * to identify an input stream. Can be all-zero, if the module cannot
280 * identify streams at all, i.e. has to be forced into use.
282 * Each item is one of:
283 * SR_INPUT_META_FILENAME
284 * SR_INPUT_META_FILESIZE
285 * SR_INPUT_META_HEADER
286 * SR_INPUT_META_MIMETYPE
288 * If the high bit (SR_INPUT META_REQUIRED) is set, the module cannot
289 * identify a stream without the given metadata.
291 const uint8_t metadata[8];
294 * Returns a NULL-terminated list of options this module can take.
295 * Can be NULL, if the module has no options.
297 struct sr_option *(*options) (void);
300 * Check if this input module can load and parse the specified stream.
302 * @param[in] metadata Metadata the module can use to identify the stream.
304 * @retval SR_OK This module knows the format.
305 * @retval SR_ERR_NA There wasn't enough data for this module to
306 * positively identify the format.
307 * @retval SR_ERR_DATA This module knows the format, but cannot handle it.
308 * This means the stream is either corrupt, or indicates a feature
309 * that the module does not support.
310 * @retval SR_ERR This module does not know the format.
312 int (*format_match) (GHashTable *metadata);
315 * Initialize the input module.
317 * @retval SR_OK Success
318 * @retval other Negative error code.
320 int (*init) (struct sr_input *in, GHashTable *options);
323 * Send data to the specified input instance.
325 * When an input module instance is created with sr_input_new(), this
326 * function is used to feed data to the instance.
328 * As enough data gets fed into this function to completely populate
329 * the device instance associated with this input instance, this is
330 * guaranteed to return the moment it's ready. This gives the caller
331 * the chance to examine the device instance, attach session callbacks
334 * @retval SR_OK Success
335 * @retval other Negative error code.
337 int (*receive) (struct sr_input *in, GString *buf);
340 * Signal the input module no more data will come.
342 * This will cause the module to process any data it may have buffered.
343 * The SR_DF_END packet will also typically be sent at this time.
345 int (*end) (struct sr_input *in);
348 * This function is called after the caller is finished using
349 * the input module, and can be used to free any internal
350 * resources the module may keep.
352 * This function is optional.
354 * @retval SR_OK Success
355 * @retval other Negative error code.
357 void (*cleanup) (struct sr_input *in);
360 /** Output module instance. */
362 /** A pointer to this output's module. */
363 const struct sr_output_module *module;
366 * The device for which this output module is creating output. This
367 * can be used by the module to find out channel names and numbers.
369 const struct sr_dev_inst *sdi;
372 * The name of the file that the data should be written to.
374 const char *filename;
377 * A generic pointer which can be used by the module to keep internal
378 * state between calls into its callback functions.
380 * For example, the module might store a pointer to a chunk of output
381 * there, and only flush it when it reaches a certain size.
386 /** Output module driver. */
387 struct sr_output_module {
389 * A unique ID for this output module, suitable for use in command-line
390 * clients, [a-z0-9-]. Must not be NULL.
395 * A unique name for this output module, suitable for use in GUI
396 * clients, can contain UTF-8. Must not be NULL.
401 * A short description of the output module. Must not be NULL.
403 * This can be displayed by frontends, e.g. when selecting the output
404 * module for saving a file.
409 * A NULL terminated array of strings containing a list of file name
410 * extensions typical for the input file format, or NULL if there is
411 * no typical extension for this file format.
413 const char *const *exts;
416 * Returns a NULL-terminated list of options this module can take.
417 * Can be NULL, if the module has no options.
419 const struct sr_option *(*options) (void);
422 * This function is called once, at the beginning of an output stream.
424 * The device struct will be available in the output struct passed in,
425 * as well as the param field -- which may be NULL or an empty string,
426 * if no parameter was passed.
428 * The module can use this to initialize itself, create a struct for
429 * keeping state and storing it in the <code>internal</code> field.
431 * @param o Pointer to the respective 'struct sr_output'.
433 * @retval SR_OK Success
434 * @retval other Negative error code.
436 int (*init) (struct sr_output *o, GHashTable *options);
439 * This function is passed a copy of every packet in the data feed.
440 * Any output generated by the output module in response to the
441 * packet should be returned in a newly allocated GString
442 * <code>out</code>, which will be freed by the caller.
444 * Packets not of interest to the output module can just be ignored,
445 * and the <code>out</code> parameter set to NULL.
447 * @param o Pointer to the respective 'struct sr_output'.
448 * @param sdi The device instance that generated the packet.
449 * @param packet The complete packet.
450 * @param out A pointer where a GString * should be stored if
451 * the module generates output, or NULL if not.
453 * @retval SR_OK Success
454 * @retval other Negative error code.
456 int (*receive) (const struct sr_output *o,
457 const struct sr_datafeed_packet *packet, GString **out);
460 * This function is called after the caller is finished using
461 * the output module, and can be used to free any internal
462 * resources the module may keep.
464 * @retval SR_OK Success
465 * @retval other Negative error code.
467 int (*cleanup) (struct sr_output *o);
470 /** Transform module instance. */
471 struct sr_transform {
472 /** A pointer to this transform's module. */
473 const struct sr_transform_module *module;
476 * The device for which this transform module is used. This
477 * can be used by the module to find out channel names and numbers.
479 const struct sr_dev_inst *sdi;
482 * A generic pointer which can be used by the module to keep internal
483 * state between calls into its callback functions.
488 struct sr_transform_module {
490 * A unique ID for this transform module, suitable for use in
491 * command-line clients, [a-z0-9-]. Must not be NULL.
496 * A unique name for this transform module, suitable for use in GUI
497 * clients, can contain UTF-8. Must not be NULL.
502 * A short description of the transform module. Must not be NULL.
504 * This can be displayed by frontends, e.g. when selecting
505 * which transform module(s) to add.
510 * Returns a NULL-terminated list of options this transform module
511 * can take. Can be NULL, if the transform module has no options.
513 const struct sr_option *(*options) (void);
516 * This function is called once, at the beginning of a stream.
518 * @param t Pointer to the respective 'struct sr_transform'.
519 * @param options Hash table of options for this transform module.
520 * Can be NULL if no options are to be used.
522 * @retval SR_OK Success
523 * @retval other Negative error code.
525 int (*init) (struct sr_transform *t, GHashTable *options);
528 * This function is passed a pointer to every packet in the data feed.
530 * It can either return (in packet_out) a pointer to another packet
531 * (possibly the exact same packet it got as input), or NULL.
533 * @param t Pointer to the respective 'struct sr_transform'.
534 * @param packet_in Pointer to a datafeed packet.
535 * @param packet_out Pointer to the resulting datafeed packet after
536 * this function was run. If NULL, the transform
537 * module intentionally didn't output a new packet.
539 * @retval SR_OK Success
540 * @retval other Negative error code.
542 int (*receive) (const struct sr_transform *t,
543 struct sr_datafeed_packet *packet_in,
544 struct sr_datafeed_packet **packet_out);
547 * This function is called after the caller is finished using
548 * the transform module, and can be used to free any internal
549 * resources the module may keep.
551 * @retval SR_OK Success
552 * @retval other Negative error code.
554 int (*cleanup) (struct sr_transform *t);
557 #ifdef HAVE_LIBUSB_1_0
558 /** USB device instance */
559 struct sr_usb_dev_inst {
562 /** Device address on USB bus */
564 /** libusb device handle */
565 struct libusb_device_handle *devhdl;
569 #ifdef HAVE_LIBSERIALPORT
570 #define SERIAL_PARITY_NONE SP_PARITY_NONE
571 #define SERIAL_PARITY_EVEN SP_PARITY_EVEN
572 #define SERIAL_PARITY_ODD SP_PARITY_ODD
573 struct sr_serial_dev_inst {
574 /** Port name, e.g. '/dev/tty42'. */
576 /** Comm params for serial_set_paramstr(). */
578 /** libserialport port handle */
579 struct sp_port *data;
580 /** libserialport event set */
581 struct sp_event_set *event_set;
582 /** GPollFDs for event polling */
587 struct sr_usbtmc_dev_inst {
592 /* Private driver context. */
594 /** sigrok context */
595 struct sr_context *sr_ctx;
599 /*--- log.c -----------------------------------------------------------------*/
601 SR_PRIV int sr_log(int loglevel, const char *format, ...);
602 SR_PRIV int sr_spew(const char *format, ...);
603 SR_PRIV int sr_dbg(const char *format, ...);
604 SR_PRIV int sr_info(const char *format, ...);
605 SR_PRIV int sr_warn(const char *format, ...);
606 SR_PRIV int sr_err(const char *format, ...);
608 /* Message logging helpers with subsystem-specific prefix string. */
609 #ifndef NO_LOG_WRAPPERS
610 #define sr_log(l, s, args...) sr_log(l, "%s: " s, LOG_PREFIX, ## args)
611 #define sr_spew(s, args...) sr_spew("%s: " s, LOG_PREFIX, ## args)
612 #define sr_dbg(s, args...) sr_dbg("%s: " s, LOG_PREFIX, ## args)
613 #define sr_info(s, args...) sr_info("%s: " s, LOG_PREFIX, ## args)
614 #define sr_warn(s, args...) sr_warn("%s: " s, LOG_PREFIX, ## args)
615 #define sr_err(s, args...) sr_err("%s: " s, LOG_PREFIX, ## args)
618 /*--- device.c --------------------------------------------------------------*/
620 /** Values for the changes argument of sr_dev_driver.config_channel_set. */
622 /** The enabled state of the channel has been changed. */
623 SR_CHANNEL_SET_ENABLED = 1 << 0,
626 SR_PRIV struct sr_channel *sr_channel_new(struct sr_dev_inst *sdi,
627 int index, int type, gboolean enabled, const char *name);
629 /** Device instance data */
631 /** Device driver. */
632 struct sr_dev_driver *driver;
633 /** Device instance status. SR_ST_NOT_FOUND, etc. */
635 /** Device instance type. SR_INST_USB, etc. */
637 /** Device vendor. */
641 /** Device version. */
643 /** Serial number. */
645 /** Connection string to uniquely identify devices. */
647 /** List of channels. */
649 /** List of sr_channel_group structs */
650 GSList *channel_groups;
651 /** Device instance connection data (used?) */
653 /** Device instance private data (used?) */
655 /** Session to which this device is currently assigned. */
656 struct sr_session *session;
659 /* Generic device instances */
660 SR_PRIV void sr_dev_inst_free(struct sr_dev_inst *sdi);
662 #ifdef HAVE_LIBUSB_1_0
663 /* USB-specific instances */
664 SR_PRIV struct sr_usb_dev_inst *sr_usb_dev_inst_new(uint8_t bus,
665 uint8_t address, struct libusb_device_handle *hdl);
666 SR_PRIV void sr_usb_dev_inst_free(struct sr_usb_dev_inst *usb);
669 #ifdef HAVE_LIBSERIALPORT
670 /* Serial-specific instances */
671 SR_PRIV struct sr_serial_dev_inst *sr_serial_dev_inst_new(const char *port,
672 const char *serialcomm);
673 SR_PRIV void sr_serial_dev_inst_free(struct sr_serial_dev_inst *serial);
676 /* USBTMC-specific instances */
677 SR_PRIV struct sr_usbtmc_dev_inst *sr_usbtmc_dev_inst_new(const char *device);
678 SR_PRIV void sr_usbtmc_dev_inst_free(struct sr_usbtmc_dev_inst *usbtmc);
680 /*--- hwdriver.c ------------------------------------------------------------*/
682 extern SR_PRIV struct sr_dev_driver **drivers_lists[];
684 SR_PRIV const GVariantType *sr_variant_type_get(int datatype);
685 SR_PRIV int sr_variant_type_check(uint32_t key, GVariant *data);
686 SR_PRIV void sr_hw_cleanup_all(const struct sr_context *ctx);
687 SR_PRIV struct sr_config *sr_config_new(uint32_t key, GVariant *data);
688 SR_PRIV void sr_config_free(struct sr_config *src);
689 SR_PRIV int sr_source_remove(int fd);
690 SR_PRIV int sr_source_remove_pollfd(GPollFD *pollfd);
691 SR_PRIV int sr_source_remove_channel(GIOChannel *channel);
692 SR_PRIV int sr_source_add(int fd, int events, int timeout,
693 sr_receive_data_callback cb, void *cb_data);
694 SR_PRIV int sr_source_add_pollfd(GPollFD *pollfd, int timeout,
695 sr_receive_data_callback cb, void *cb_data);
696 SR_PRIV int sr_source_add_channel(GIOChannel *channel, int events, int timeout,
697 sr_receive_data_callback cb, void *cb_data);
699 /*--- session.c -------------------------------------------------------------*/
702 /** Context this session exists in. */
703 struct sr_context *ctx;
704 /** List of struct sr_dev_inst pointers. */
706 /** List of struct sr_dev_inst pointers owned by this session. */
708 /** List of struct datafeed_callback pointers. */
709 GSList *datafeed_callbacks;
711 struct sr_trigger *trigger;
715 unsigned int num_sources;
718 * Both "sources" and "pollfds" are of the same size and contain pairs
719 * of descriptor and callback function. We can not embed the GPollFD
720 * into the source struct since we want to be able to pass the array
721 * of all poll descriptors to g_poll().
723 struct source *sources;
728 * These are our synchronization primitives for stopping the session in
729 * an async fashion. We need to make sure the session is stopped from
730 * within the session thread itself.
732 /** Mutex protecting access to abort_session. */
734 /** Abort current session. See sr_session_stop(). */
735 gboolean abort_session;
738 SR_PRIV int sr_session_send(const struct sr_dev_inst *sdi,
739 const struct sr_datafeed_packet *packet);
740 SR_PRIV int sr_session_stop_sync(struct sr_session *session);
741 SR_PRIV int sr_sessionfile_check(const char *filename);
742 SR_PRIV int sr_packet_copy(const struct sr_datafeed_packet *packet,
743 struct sr_datafeed_packet **copy);
744 SR_PRIV void sr_packet_free(struct sr_datafeed_packet *packet);
746 /*--- analog.c --------------------------------------------------------------*/
748 SR_PRIV int sr_analog_init(struct sr_datafeed_analog2 *analog,
749 struct sr_analog_encoding *encoding,
750 struct sr_analog_meaning *meaning,
751 struct sr_analog_spec *spec,
754 /*--- std.c -----------------------------------------------------------------*/
756 typedef int (*dev_close_callback)(struct sr_dev_inst *sdi);
757 typedef void (*std_dev_clear_callback)(void *priv);
759 SR_PRIV int std_init(struct sr_context *sr_ctx, struct sr_dev_driver *di,
761 #ifdef HAVE_LIBSERIALPORT
762 SR_PRIV int std_serial_dev_open(struct sr_dev_inst *sdi);
763 SR_PRIV int std_serial_dev_acquisition_stop(struct sr_dev_inst *sdi,
764 void *cb_data, dev_close_callback dev_close_fn,
765 struct sr_serial_dev_inst *serial, const char *prefix);
767 SR_PRIV int std_session_send_df_header(const struct sr_dev_inst *sdi,
769 SR_PRIV int std_dev_clear(const struct sr_dev_driver *driver,
770 std_dev_clear_callback clear_private);
771 SR_PRIV int std_serial_dev_close(struct sr_dev_inst *sdi);
773 /*--- strutil.c -------------------------------------------------------------*/
775 SR_PRIV int sr_atol(const char *str, long *ret);
776 SR_PRIV int sr_atoi(const char *str, int *ret);
777 SR_PRIV int sr_atod(const char *str, double *ret);
778 SR_PRIV int sr_atof(const char *str, float *ret);
779 SR_PRIV int sr_atof_ascii(const char *str, float *ret);
781 /*--- soft-trigger.c --------------------------------------------------------*/
783 struct soft_trigger_logic {
784 const struct sr_dev_inst *sdi;
785 const struct sr_trigger *trigger;
789 uint8_t *prev_sample;
790 uint8_t *pre_trigger_buffer;
791 uint8_t *pre_trigger_head;
792 int pre_trigger_size;
793 int pre_trigger_fill;
796 SR_PRIV struct soft_trigger_logic *soft_trigger_logic_new(
797 const struct sr_dev_inst *sdi, struct sr_trigger *trigger,
798 int pre_trigger_samples);
799 SR_PRIV void soft_trigger_logic_free(struct soft_trigger_logic *st);
800 SR_PRIV int soft_trigger_logic_check(struct soft_trigger_logic *st, uint8_t *buf,
801 int len, int *pre_trigger_samples);
803 /*--- hardware/serial.c -----------------------------------------------------*/
805 #ifdef HAVE_LIBSERIALPORT
811 typedef gboolean (*packet_valid_callback)(const uint8_t *buf);
813 SR_PRIV int serial_open(struct sr_serial_dev_inst *serial, int flags);
814 SR_PRIV int serial_close(struct sr_serial_dev_inst *serial);
815 SR_PRIV int serial_flush(struct sr_serial_dev_inst *serial);
816 SR_PRIV int serial_drain(struct sr_serial_dev_inst *serial);
817 SR_PRIV int serial_write_blocking(struct sr_serial_dev_inst *serial,
818 const void *buf, size_t count, unsigned int timeout_ms);
819 SR_PRIV int serial_write_nonblocking(struct sr_serial_dev_inst *serial,
820 const void *buf, size_t count);
821 SR_PRIV int serial_read_blocking(struct sr_serial_dev_inst *serial, void *buf,
822 size_t count, unsigned int timeout_ms);
823 SR_PRIV int serial_read_nonblocking(struct sr_serial_dev_inst *serial, void *buf,
825 SR_PRIV int serial_set_params(struct sr_serial_dev_inst *serial, int baudrate,
826 int bits, int parity, int stopbits, int flowcontrol, int rts, int dtr);
827 SR_PRIV int serial_set_paramstr(struct sr_serial_dev_inst *serial,
828 const char *paramstr);
829 SR_PRIV int serial_readline(struct sr_serial_dev_inst *serial, char **buf,
830 int *buflen, gint64 timeout_ms);
831 SR_PRIV int serial_stream_detect(struct sr_serial_dev_inst *serial,
832 uint8_t *buf, size_t *buflen,
834 packet_valid_callback is_valid,
835 uint64_t timeout_ms, int baudrate);
836 SR_PRIV int sr_serial_extract_options(GSList *options, const char **serial_device,
837 const char **serial_options);
838 SR_PRIV int serial_source_add(struct sr_session *session,
839 struct sr_serial_dev_inst *serial, int events, int timeout,
840 sr_receive_data_callback cb, void *cb_data);
841 SR_PRIV int serial_source_remove(struct sr_session *session,
842 struct sr_serial_dev_inst *serial);
843 SR_PRIV GSList *sr_serial_find_usb(uint16_t vendor_id, uint16_t product_id);
844 SR_PRIV int serial_timeout(struct sr_serial_dev_inst *port, int num_bytes);
847 /*--- hardware/ezusb.c ------------------------------------------------------*/
849 #ifdef HAVE_LIBUSB_1_0
850 SR_PRIV int ezusb_reset(struct libusb_device_handle *hdl, int set_clear);
851 SR_PRIV int ezusb_install_firmware(libusb_device_handle *hdl,
852 const char *filename);
853 SR_PRIV int ezusb_upload_firmware(libusb_device *dev, int configuration,
854 const char *filename);
857 /*--- hardware/usb.c --------------------------------------------------------*/
859 #ifdef HAVE_LIBUSB_1_0
860 SR_PRIV GSList *sr_usb_find(libusb_context *usb_ctx, const char *conn);
861 SR_PRIV int sr_usb_open(libusb_context *usb_ctx, struct sr_usb_dev_inst *usb);
862 SR_PRIV int usb_source_add(struct sr_session *session, struct sr_context *ctx,
863 int timeout, sr_receive_data_callback cb, void *cb_data);
864 SR_PRIV int usb_source_remove(struct sr_session *session, struct sr_context *ctx);
865 SR_PRIV int usb_get_port_path(libusb_device *dev, char *path, int path_len);
868 /*--- hardware/scpi.c -------------------------------------------------------*/
870 #define SCPI_CMD_IDN "*IDN?"
871 #define SCPI_CMD_OPC "*OPC?"
874 SCPI_CMD_SET_TRIGGER_SOURCE,
875 SCPI_CMD_SET_TIMEBASE,
876 SCPI_CMD_SET_VERTICAL_DIV,
877 SCPI_CMD_SET_TRIGGER_SLOPE,
878 SCPI_CMD_SET_COUPLING,
879 SCPI_CMD_SET_HORIZ_TRIGGERPOS,
880 SCPI_CMD_GET_ANALOG_CHAN_STATE,
881 SCPI_CMD_GET_DIG_CHAN_STATE,
882 SCPI_CMD_GET_TIMEBASE,
883 SCPI_CMD_GET_VERTICAL_DIV,
884 SCPI_CMD_GET_VERTICAL_OFFSET,
885 SCPI_CMD_GET_TRIGGER_SOURCE,
886 SCPI_CMD_GET_HORIZ_TRIGGERPOS,
887 SCPI_CMD_GET_TRIGGER_SLOPE,
888 SCPI_CMD_GET_COUPLING,
889 SCPI_CMD_SET_ANALOG_CHAN_STATE,
890 SCPI_CMD_SET_DIG_CHAN_STATE,
891 SCPI_CMD_GET_DIG_POD_STATE,
892 SCPI_CMD_SET_DIG_POD_STATE,
893 SCPI_CMD_GET_ANALOG_DATA,
894 SCPI_CMD_GET_DIG_DATA,
895 SCPI_CMD_GET_SAMPLE_RATE,
896 SCPI_CMD_GET_SAMPLE_RATE_LIVE,
899 struct sr_scpi_hw_info {
903 char *firmware_version;
906 struct sr_scpi_dev_inst {
910 GSList *(*scan)(struct drv_context *drvc);
911 int (*dev_inst_new)(void *priv, struct drv_context *drvc,
912 const char *resource, char **params, const char *serialcomm);
913 int (*open)(void *priv);
914 int (*source_add)(struct sr_session *session, void *priv, int events,
915 int timeout, sr_receive_data_callback cb, void *cb_data);
916 int (*source_remove)(struct sr_session *session, void *priv);
917 int (*send)(void *priv, const char *command);
918 int (*read_begin)(void *priv);
919 int (*read_data)(void *priv, char *buf, int maxlen);
920 int (*read_complete)(void *priv);
921 int (*close)(void *priv);
922 void (*free)(void *priv);
923 unsigned int read_timeout_ms;
927 SR_PRIV GSList *sr_scpi_scan(struct drv_context *drvc, GSList *options,
928 struct sr_dev_inst *(*probe_device)(struct sr_scpi_dev_inst *scpi));
929 SR_PRIV struct sr_scpi_dev_inst *scpi_dev_inst_new(struct drv_context *drvc,
930 const char *resource, const char *serialcomm);
931 SR_PRIV int sr_scpi_open(struct sr_scpi_dev_inst *scpi);
932 SR_PRIV int sr_scpi_source_add(struct sr_session *session,
933 struct sr_scpi_dev_inst *scpi, int events, int timeout,
934 sr_receive_data_callback cb, void *cb_data);
935 SR_PRIV int sr_scpi_source_remove(struct sr_session *session,
936 struct sr_scpi_dev_inst *scpi);
937 SR_PRIV int sr_scpi_send(struct sr_scpi_dev_inst *scpi,
938 const char *format, ...);
939 SR_PRIV int sr_scpi_send_variadic(struct sr_scpi_dev_inst *scpi,
940 const char *format, va_list args);
941 SR_PRIV int sr_scpi_read_begin(struct sr_scpi_dev_inst *scpi);
942 SR_PRIV int sr_scpi_read_data(struct sr_scpi_dev_inst *scpi, char *buf, int maxlen);
943 SR_PRIV int sr_scpi_read_complete(struct sr_scpi_dev_inst *scpi);
944 SR_PRIV int sr_scpi_close(struct sr_scpi_dev_inst *scpi);
945 SR_PRIV void sr_scpi_free(struct sr_scpi_dev_inst *scpi);
947 SR_PRIV int sr_scpi_get_string(struct sr_scpi_dev_inst *scpi,
948 const char *command, char **scpi_response);
949 SR_PRIV int sr_scpi_get_bool(struct sr_scpi_dev_inst *scpi,
950 const char *command, gboolean *scpi_response);
951 SR_PRIV int sr_scpi_get_int(struct sr_scpi_dev_inst *scpi,
952 const char *command, int *scpi_response);
953 SR_PRIV int sr_scpi_get_float(struct sr_scpi_dev_inst *scpi,
954 const char *command, float *scpi_response);
955 SR_PRIV int sr_scpi_get_double(struct sr_scpi_dev_inst *scpi,
956 const char *command, double *scpi_response);
957 SR_PRIV int sr_scpi_get_opc(struct sr_scpi_dev_inst *scpi);
958 SR_PRIV int sr_scpi_get_floatv(struct sr_scpi_dev_inst *scpi,
959 const char *command, GArray **scpi_response);
960 SR_PRIV int sr_scpi_get_uint8v(struct sr_scpi_dev_inst *scpi,
961 const char *command, GArray **scpi_response);
962 SR_PRIV int sr_scpi_get_hw_id(struct sr_scpi_dev_inst *scpi,
963 struct sr_scpi_hw_info **scpi_response);
964 SR_PRIV void sr_scpi_hw_info_free(struct sr_scpi_hw_info *hw_info);
966 /*--- modbus/modbus.c -------------------------------------------------------*/
968 struct sr_modbus_dev_inst {
972 GSList *(*scan)(int modbusaddr);
973 int (*dev_inst_new)(void *priv, const char *resource,
974 char **params, const char *serialcomm, int modbusaddr);
975 int (*open)(void *priv);
976 int (*source_add)(struct sr_session *session, void *priv, int events,
977 int timeout, sr_receive_data_callback cb, void *cb_data);
978 int (*source_remove)(struct sr_session *session, void *priv);
979 int (*send)(void *priv, const uint8_t *buffer, int buffer_size);
980 int (*read_begin)(void *priv, uint8_t *function_code);
981 int (*read_data)(void *priv, uint8_t *buf, int maxlen);
982 int (*read_end)(void *priv);
983 int (*close)(void *priv);
984 void (*free)(void *priv);
985 unsigned int read_timeout_ms;
989 SR_PRIV GSList *sr_modbus_scan(struct drv_context *drvc, GSList *options,
990 struct sr_dev_inst *(*probe_device)(struct sr_modbus_dev_inst *modbus));
991 SR_PRIV struct sr_modbus_dev_inst *modbus_dev_inst_new(const char *resource,
992 const char *serialcomm, int modbusaddr);
993 SR_PRIV int sr_modbus_open(struct sr_modbus_dev_inst *modbus);
994 SR_PRIV int sr_modbus_source_add(struct sr_session *session,
995 struct sr_modbus_dev_inst *modbus, int events, int timeout,
996 sr_receive_data_callback cb, void *cb_data);
997 SR_PRIV int sr_modbus_source_remove(struct sr_session *session,
998 struct sr_modbus_dev_inst *modbus);
999 SR_PRIV int sr_modbus_request(struct sr_modbus_dev_inst *modbus,
1000 uint8_t *request, int request_size);
1001 SR_PRIV int sr_modbus_reply(struct sr_modbus_dev_inst *modbus,
1002 uint8_t *reply, int reply_size);
1003 SR_PRIV int sr_modbus_request_reply(struct sr_modbus_dev_inst *modbus,
1004 uint8_t *request, int request_size,
1005 uint8_t *reply, int reply_size);
1006 SR_PRIV int sr_modbus_read_coils(struct sr_modbus_dev_inst *modbus,
1007 int address, int nb_coils, uint8_t *coils);
1008 SR_PRIV int sr_modbus_read_holding_registers(struct sr_modbus_dev_inst *modbus,
1009 int address, int nb_registers,
1010 uint16_t *registers);
1011 SR_PRIV int sr_modbus_write_coil(struct sr_modbus_dev_inst *modbus,
1012 int address, int value);
1013 SR_PRIV int sr_modbus_write_multiple_registers(struct sr_modbus_dev_inst*modbus,
1014 int address, int nb_registers,
1015 uint16_t *registers);
1016 SR_PRIV int sr_modbus_close(struct sr_modbus_dev_inst *modbus);
1017 SR_PRIV void sr_modbus_free(struct sr_modbus_dev_inst *modbus);
1019 /*--- hardware/dmm/es519xx.c ------------------------------------------------*/
1022 * All 11-byte es519xx chips repeat each block twice for each conversion cycle
1023 * so always read 2 blocks at a time.
1025 #define ES519XX_11B_PACKET_SIZE (11 * 2)
1026 #define ES519XX_14B_PACKET_SIZE 14
1028 struct es519xx_info {
1029 gboolean is_judge, is_voltage, is_auto, is_micro, is_current;
1030 gboolean is_milli, is_resistance, is_continuity, is_diode;
1031 gboolean is_frequency, is_rpm, is_capacitance, is_duty_cycle;
1032 gboolean is_temperature, is_celsius, is_fahrenheit;
1033 gboolean is_adp0, is_adp1, is_adp2, is_adp3;
1034 gboolean is_sign, is_batt, is_ol, is_pmax, is_pmin, is_apo;
1035 gboolean is_dc, is_ac, is_vahz, is_min, is_max, is_rel, is_hold;
1036 gboolean is_digit4, is_ul, is_vasel, is_vbar, is_lpf1, is_lpf0, is_rmr;
1039 gboolean alt_functions, fivedigits, clampmeter, selectable_lpf;
1042 SR_PRIV gboolean sr_es519xx_2400_11b_packet_valid(const uint8_t *buf);
1043 SR_PRIV int sr_es519xx_2400_11b_parse(const uint8_t *buf, float *floatval,
1044 struct sr_datafeed_analog *analog, void *info);
1045 SR_PRIV gboolean sr_es519xx_2400_11b_altfn_packet_valid(const uint8_t *buf);
1046 SR_PRIV int sr_es519xx_2400_11b_altfn_parse(const uint8_t *buf,
1047 float *floatval, struct sr_datafeed_analog *analog, void *info);
1048 SR_PRIV gboolean sr_es519xx_19200_11b_5digits_packet_valid(const uint8_t *buf);
1049 SR_PRIV int sr_es519xx_19200_11b_5digits_parse(const uint8_t *buf,
1050 float *floatval, struct sr_datafeed_analog *analog, void *info);
1051 SR_PRIV gboolean sr_es519xx_19200_11b_clamp_packet_valid(const uint8_t *buf);
1052 SR_PRIV int sr_es519xx_19200_11b_clamp_parse(const uint8_t *buf,
1053 float *floatval, struct sr_datafeed_analog *analog, void *info);
1054 SR_PRIV gboolean sr_es519xx_19200_11b_packet_valid(const uint8_t *buf);
1055 SR_PRIV int sr_es519xx_19200_11b_parse(const uint8_t *buf, float *floatval,
1056 struct sr_datafeed_analog *analog, void *info);
1057 SR_PRIV gboolean sr_es519xx_19200_14b_packet_valid(const uint8_t *buf);
1058 SR_PRIV int sr_es519xx_19200_14b_parse(const uint8_t *buf, float *floatval,
1059 struct sr_datafeed_analog *analog, void *info);
1060 SR_PRIV gboolean sr_es519xx_19200_14b_sel_lpf_packet_valid(const uint8_t *buf);
1061 SR_PRIV int sr_es519xx_19200_14b_sel_lpf_parse(const uint8_t *buf,
1062 float *floatval, struct sr_datafeed_analog *analog, void *info);
1064 /*--- hardware/dmm/fs9922.c -------------------------------------------------*/
1066 #define FS9922_PACKET_SIZE 14
1068 struct fs9922_info {
1069 gboolean is_auto, is_dc, is_ac, is_rel, is_hold, is_bpn, is_z1, is_z2;
1070 gboolean is_max, is_min, is_apo, is_bat, is_nano, is_z3, is_micro;
1071 gboolean is_milli, is_kilo, is_mega, is_beep, is_diode, is_percent;
1072 gboolean is_z4, is_volt, is_ampere, is_ohm, is_hfe, is_hertz, is_farad;
1073 gboolean is_celsius, is_fahrenheit;
1074 int bargraph_sign, bargraph_value;
1077 SR_PRIV gboolean sr_fs9922_packet_valid(const uint8_t *buf);
1078 SR_PRIV int sr_fs9922_parse(const uint8_t *buf, float *floatval,
1079 struct sr_datafeed_analog *analog, void *info);
1080 SR_PRIV void sr_fs9922_z1_diode(struct sr_datafeed_analog *analog, void *info);
1082 /*--- hardware/dmm/fs9721.c -------------------------------------------------*/
1084 #define FS9721_PACKET_SIZE 14
1086 struct fs9721_info {
1087 gboolean is_ac, is_dc, is_auto, is_rs232, is_micro, is_nano, is_kilo;
1088 gboolean is_diode, is_milli, is_percent, is_mega, is_beep, is_farad;
1089 gboolean is_ohm, is_rel, is_hold, is_ampere, is_volt, is_hz, is_bat;
1090 gboolean is_c2c1_11, is_c2c1_10, is_c2c1_01, is_c2c1_00, is_sign;
1093 SR_PRIV gboolean sr_fs9721_packet_valid(const uint8_t *buf);
1094 SR_PRIV int sr_fs9721_parse(const uint8_t *buf, float *floatval,
1095 struct sr_datafeed_analog *analog, void *info);
1096 SR_PRIV void sr_fs9721_00_temp_c(struct sr_datafeed_analog *analog, void *info);
1097 SR_PRIV void sr_fs9721_01_temp_c(struct sr_datafeed_analog *analog, void *info);
1098 SR_PRIV void sr_fs9721_10_temp_c(struct sr_datafeed_analog *analog, void *info);
1099 SR_PRIV void sr_fs9721_01_10_temp_f_c(struct sr_datafeed_analog *analog, void *info);
1100 SR_PRIV void sr_fs9721_max_c_min(struct sr_datafeed_analog *analog, void *info);
1102 /*--- hardware/dmm/m2110.c --------------------------------------------------*/
1104 #define BBCGM_M2110_PACKET_SIZE 9
1106 SR_PRIV gboolean sr_m2110_packet_valid(const uint8_t *buf);
1107 SR_PRIV int sr_m2110_parse(const uint8_t *buf, float *floatval,
1108 struct sr_datafeed_analog *analog, void *info);
1110 /*--- hardware/dmm/metex14.c ------------------------------------------------*/
1112 #define METEX14_PACKET_SIZE 14
1114 struct metex14_info {
1115 gboolean is_ac, is_dc, is_resistance, is_capacity, is_temperature;
1116 gboolean is_diode, is_frequency, is_ampere, is_volt, is_farad;
1117 gboolean is_hertz, is_ohm, is_celsius, is_pico, is_nano, is_micro;
1118 gboolean is_milli, is_kilo, is_mega, is_gain, is_decibel, is_hfe;
1119 gboolean is_unitless, is_logic;
1122 #ifdef HAVE_LIBSERIALPORT
1123 SR_PRIV int sr_metex14_packet_request(struct sr_serial_dev_inst *serial);
1125 SR_PRIV gboolean sr_metex14_packet_valid(const uint8_t *buf);
1126 SR_PRIV int sr_metex14_parse(const uint8_t *buf, float *floatval,
1127 struct sr_datafeed_analog *analog, void *info);
1129 /*--- hardware/dmm/rs9lcd.c -------------------------------------------------*/
1131 #define RS9LCD_PACKET_SIZE 9
1133 /* Dummy info struct. The parser does not use it. */
1134 struct rs9lcd_info { int dummy; };
1136 SR_PRIV gboolean sr_rs9lcd_packet_valid(const uint8_t *buf);
1137 SR_PRIV int sr_rs9lcd_parse(const uint8_t *buf, float *floatval,
1138 struct sr_datafeed_analog *analog, void *info);
1140 /*--- hardware/dmm/bm25x.c --------------------------------------------------*/
1142 #define BRYMEN_BM25X_PACKET_SIZE 15
1144 /* Dummy info struct. The parser does not use it. */
1145 struct bm25x_info { int dummy; };
1147 SR_PRIV gboolean sr_brymen_bm25x_packet_valid(const uint8_t *buf);
1148 SR_PRIV int sr_brymen_bm25x_parse(const uint8_t *buf, float *floatval,
1149 struct sr_datafeed_analog *analog, void *info);
1151 /*--- hardware/dmm/ut71x.c --------------------------------------------------*/
1153 #define UT71X_PACKET_SIZE 11
1156 gboolean is_voltage, is_resistance, is_capacitance, is_temperature;
1157 gboolean is_celsius, is_fahrenheit, is_current, is_continuity;
1158 gboolean is_diode, is_frequency, is_duty_cycle, is_dc, is_ac;
1159 gboolean is_auto, is_manual, is_sign, is_power, is_loop_current;
1162 SR_PRIV gboolean sr_ut71x_packet_valid(const uint8_t *buf);
1163 SR_PRIV int sr_ut71x_parse(const uint8_t *buf, float *floatval,
1164 struct sr_datafeed_analog *analog, void *info);
1166 /*--- hardware/dmm/vc870.c --------------------------------------------------*/
1168 #define VC870_PACKET_SIZE 23
1171 gboolean is_voltage, is_dc, is_ac, is_temperature, is_resistance;
1172 gboolean is_continuity, is_capacitance, is_diode, is_loop_current;
1173 gboolean is_current, is_micro, is_milli, is_power;
1174 gboolean is_power_factor_freq, is_power_apparent_power, is_v_a_eff_value;
1175 gboolean is_sign2, is_sign1, is_batt, is_ol1, is_max, is_min;
1176 gboolean is_maxmin, is_rel, is_ol2, is_open, is_manu, is_hold;
1177 gboolean is_light, is_usb, is_warning, is_auto_power, is_misplug_warn;
1178 gboolean is_lo, is_hi, is_open2;
1180 gboolean is_frequency, is_dual_display, is_auto, is_rms;
1183 SR_PRIV gboolean sr_vc870_packet_valid(const uint8_t *buf);
1184 SR_PRIV int sr_vc870_parse(const uint8_t *buf, float *floatval,
1185 struct sr_datafeed_analog *analog, void *info);
1187 /*--- hardware/lcr/es51919.c ------------------------------------------------*/
1189 SR_PRIV void es51919_serial_clean(void *priv);
1190 SR_PRIV struct sr_dev_inst *es51919_serial_scan(GSList *options,
1193 SR_PRIV int es51919_serial_config_get(uint32_t key, GVariant **data,
1194 const struct sr_dev_inst *sdi,
1195 const struct sr_channel_group *cg);
1196 SR_PRIV int es51919_serial_config_set(uint32_t key, GVariant *data,
1197 const struct sr_dev_inst *sdi,
1198 const struct sr_channel_group *cg);
1199 SR_PRIV int es51919_serial_config_list(uint32_t key, GVariant **data,
1200 const struct sr_dev_inst *sdi,
1201 const struct sr_channel_group *cg);
1202 SR_PRIV int es51919_serial_acquisition_start(const struct sr_dev_inst *sdi,
1204 SR_PRIV int es51919_serial_acquisition_stop(struct sr_dev_inst *sdi,
1207 /*--- hardware/dmm/ut372.c --------------------------------------------------*/
1209 #define UT372_PACKET_SIZE 27
1215 SR_PRIV gboolean sr_ut372_packet_valid(const uint8_t *buf);
1216 SR_PRIV int sr_ut372_parse(const uint8_t *buf, float *floatval,
1217 struct sr_datafeed_analog *analog, void *info);