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/>.
26 #ifndef LIBSIGROK_LIBSIGROK_INTERNAL_H
27 #define LIBSIGROK_LIBSIGROK_INTERNAL_H
32 #ifdef HAVE_LIBSERIALPORT
33 #include <libserialport.h>
35 #ifdef HAVE_LIBUSB_1_0
48 * libsigrok private header file, only to be used internally.
51 /*--- Macros ----------------------------------------------------------------*/
54 #define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0]))
57 #ifndef ARRAY_AND_SIZE
58 #define ARRAY_AND_SIZE(a) (a), ARRAY_SIZE(a)
62 * Read a 8 bits unsigned integer out of memory.
63 * @param x a pointer to the input memory
64 * @return the corresponding unsigned integer
66 #define R8(x) ((unsigned)((const uint8_t*)(x))[0])
69 * Read a 16 bits big endian unsigned integer out of memory.
70 * @param x a pointer to the input memory
71 * @return the corresponding unsigned integer
73 #define RB16(x) (((unsigned)((const uint8_t*)(x))[0] << 8) | \
74 (unsigned)((const uint8_t*)(x))[1])
77 * Read a 16 bits little endian unsigned integer out of memory.
78 * @param x a pointer to the input memory
79 * @return the corresponding unsigned integer
81 #define RL16(x) (((unsigned)((const uint8_t*)(x))[1] << 8) | \
82 (unsigned)((const uint8_t*)(x))[0])
85 * Read a 16 bits big endian signed integer out of memory.
86 * @param x a pointer to the input memory
87 * @return the corresponding signed integer
89 #define RB16S(x) ((int16_t) \
90 (((unsigned)((const uint8_t*)(x))[0] << 8) | \
91 (unsigned)((const uint8_t*)(x))[1]))
94 * Read a 16 bits little endian signed integer out of memory.
95 * @param x a pointer to the input memory
96 * @return the corresponding signed integer
98 #define RL16S(x) ((int16_t) \
99 (((unsigned)((const uint8_t*)(x))[1] << 8) | \
100 (unsigned)((const uint8_t*)(x))[0]))
103 * Read a 32 bits big endian unsigned integer out of memory.
104 * @param x a pointer to the input memory
105 * @return the corresponding unsigned integer
107 #define RB32(x) (((unsigned)((const uint8_t*)(x))[0] << 24) | \
108 ((unsigned)((const uint8_t*)(x))[1] << 16) | \
109 ((unsigned)((const uint8_t*)(x))[2] << 8) | \
110 (unsigned)((const uint8_t*)(x))[3])
113 * Read a 32 bits little endian unsigned integer out of memory.
114 * @param x a pointer to the input memory
115 * @return the corresponding unsigned integer
117 #define RL32(x) (((unsigned)((const uint8_t*)(x))[3] << 24) | \
118 ((unsigned)((const uint8_t*)(x))[2] << 16) | \
119 ((unsigned)((const uint8_t*)(x))[1] << 8) | \
120 (unsigned)((const uint8_t*)(x))[0])
123 * Read a 32 bits big endian signed integer out of memory.
124 * @param x a pointer to the input memory
125 * @return the corresponding signed integer
127 #define RB32S(x) ((int32_t) \
128 (((unsigned)((const uint8_t*)(x))[0] << 24) | \
129 ((unsigned)((const uint8_t*)(x))[1] << 16) | \
130 ((unsigned)((const uint8_t*)(x))[2] << 8) | \
131 (unsigned)((const uint8_t*)(x))[3]))
134 * Read a 32 bits little endian signed integer out of memory.
135 * @param x a pointer to the input memory
136 * @return the corresponding signed integer
138 #define RL32S(x) ((int32_t) \
139 (((unsigned)((const uint8_t*)(x))[3] << 24) | \
140 ((unsigned)((const uint8_t*)(x))[2] << 16) | \
141 ((unsigned)((const uint8_t*)(x))[1] << 8) | \
142 (unsigned)((const uint8_t*)(x))[0]))
145 * Read a 64 bits big endian unsigned integer out of memory.
146 * @param x a pointer to the input memory
147 * @return the corresponding unsigned integer
149 #define RB64(x) (((uint64_t)((const uint8_t*)(x))[0] << 56) | \
150 ((uint64_t)((const uint8_t*)(x))[1] << 48) | \
151 ((uint64_t)((const uint8_t*)(x))[2] << 40) | \
152 ((uint64_t)((const uint8_t*)(x))[3] << 32) | \
153 ((uint64_t)((const uint8_t*)(x))[4] << 24) | \
154 ((uint64_t)((const uint8_t*)(x))[5] << 16) | \
155 ((uint64_t)((const uint8_t*)(x))[6] << 8) | \
156 (uint64_t)((const uint8_t*)(x))[7])
159 * Read a 64 bits little endian unsigned integer out of memory.
160 * @param x a pointer to the input memory
161 * @return the corresponding unsigned integer
163 #define RL64(x) (((uint64_t)((const uint8_t*)(x))[7] << 56) | \
164 ((uint64_t)((const uint8_t*)(x))[6] << 48) | \
165 ((uint64_t)((const uint8_t*)(x))[5] << 40) | \
166 ((uint64_t)((const uint8_t*)(x))[4] << 32) | \
167 ((uint64_t)((const uint8_t*)(x))[3] << 24) | \
168 ((uint64_t)((const uint8_t*)(x))[2] << 16) | \
169 ((uint64_t)((const uint8_t*)(x))[1] << 8) | \
170 (uint64_t)((const uint8_t*)(x))[0])
173 * Read a 64 bits little endian signed integer out of memory.
174 * @param x a pointer to the input memory
175 * @return the corresponding unsigned integer
177 #define RL64S(x) ((int64_t) \
178 (((uint64_t)((const uint8_t*)(x))[7] << 56) | \
179 ((uint64_t)((const uint8_t*)(x))[6] << 48) | \
180 ((uint64_t)((const uint8_t*)(x))[5] << 40) | \
181 ((uint64_t)((const uint8_t*)(x))[4] << 32) | \
182 ((uint64_t)((const uint8_t*)(x))[3] << 24) | \
183 ((uint64_t)((const uint8_t*)(x))[2] << 16) | \
184 ((uint64_t)((const uint8_t*)(x))[1] << 8) | \
185 (uint64_t)((const uint8_t*)(x))[0]))
188 * Read a 32 bits big endian float out of memory.
189 * @param x a pointer to the input memory
190 * @return the corresponding float
192 #define RBFL(x) ((union { uint32_t u; float f; }) { .u = RB32(x) }.f)
195 * Read a 32 bits little endian float out of memory.
196 * @param x a pointer to the input memory
197 * @return the corresponding float
199 #define RLFL(x) ((union { uint32_t u; float f; }) { .u = RL32(x) }.f)
202 * Write a 8 bits unsigned integer to memory.
203 * @param p a pointer to the output memory
204 * @param x the input unsigned integer
206 #define W8(p, x) do { ((uint8_t*)(p))[0] = (uint8_t) (x); } while (0)
209 * Write a 16 bits unsigned integer to memory stored as big endian.
210 * @param p a pointer to the output memory
211 * @param x the input unsigned integer
213 #define WB16(p, x) do { ((uint8_t*)(p))[1] = (uint8_t) (x); \
214 ((uint8_t*)(p))[0] = (uint8_t)((x)>>8); } while (0)
217 * Write a 16 bits unsigned integer to memory stored as little endian.
218 * @param p a pointer to the output memory
219 * @param x the input unsigned integer
221 #define WL16(p, x) do { ((uint8_t*)(p))[0] = (uint8_t) (x); \
222 ((uint8_t*)(p))[1] = (uint8_t)((x)>>8); } while (0)
225 * Write a 32 bits unsigned integer to memory stored as big endian.
226 * @param p a pointer to the output memory
227 * @param x the input unsigned integer
229 #define WB32(p, x) do { ((uint8_t*)(p))[3] = (uint8_t) (x); \
230 ((uint8_t*)(p))[2] = (uint8_t)((x)>>8); \
231 ((uint8_t*)(p))[1] = (uint8_t)((x)>>16); \
232 ((uint8_t*)(p))[0] = (uint8_t)((x)>>24); } while (0)
235 * Write a 32 bits unsigned integer to memory stored as little endian.
236 * @param p a pointer to the output memory
237 * @param x the input unsigned integer
239 #define WL32(p, x) do { ((uint8_t*)(p))[0] = (uint8_t) (x); \
240 ((uint8_t*)(p))[1] = (uint8_t)((x)>>8); \
241 ((uint8_t*)(p))[2] = (uint8_t)((x)>>16); \
242 ((uint8_t*)(p))[3] = (uint8_t)((x)>>24); } while (0)
245 * Write a 32 bits float to memory stored as big endian.
246 * @param p a pointer to the output memory
247 * @param x the input float
249 #define WBFL(p, x) WB32(p, (union { uint32_t u; float f; }) { .f = x }.u)
252 * Write a 32 bits float to memory stored as little endian.
253 * @param p a pointer to the output memory
254 * @param x the input float
256 #define WLFL(p, x) WL32(p, (union { uint32_t u; float f; }) { .f = x }.u)
258 /* Portability fixes for FreeBSD. */
260 #define LIBUSB_CLASS_APPLICATION 0xfe
261 #define libusb_has_capability(x) 0
262 #define libusb_handle_events_timeout_completed(ctx, tv, c) \
263 libusb_handle_events_timeout(ctx, tv)
266 /* Static definitions of structs ending with an all-zero entry are a
267 * problem when compiling with -Wmissing-field-initializers: GCC
268 * suppresses the warning only with { 0 }, clang wants { } */
272 #define ALL_ZERO { 0 }
276 #define SR_DRIVER_LIST_SECTION "__DATA,__sr_driver_list"
278 #define SR_DRIVER_LIST_SECTION "sr_driver_list"
282 * Register a list of hardware drivers.
284 * This macro can be used to register multiple hardware drivers to the library.
285 * This is useful when a driver supports multiple similar but slightly
286 * different devices that require different sr_dev_driver struct definitions.
288 * For registering only a single driver see SR_REGISTER_DEV_DRIVER().
292 * #define MY_DRIVER(_name) \
293 * &(struct sr_dev_driver){ \
298 * SR_REGISTER_DEV_DRIVER_LIST(my_driver_infos,
299 * MY_DRIVER("driver 1"),
300 * MY_DRIVER("driver 2"),
305 * @param name Name to use for the driver list identifier.
306 * @param ... Comma separated list of pointers to sr_dev_driver structs.
308 #define SR_REGISTER_DEV_DRIVER_LIST(name, ...) \
309 static const struct sr_dev_driver *name[] \
310 __attribute__((section (SR_DRIVER_LIST_SECTION), used, \
311 aligned(sizeof(struct sr_dev_driver *)))) \
317 * Register a hardware driver.
319 * This macro is used to register a hardware driver with the library. It has
320 * to be used in order to make the driver accessible to applications using the
323 * The macro invocation should be placed directly under the struct
324 * sr_dev_driver definition.
328 * static struct sr_dev_driver driver_info = {
332 * SR_REGISTER_DEV_DRIVER(driver_info);
335 * @param name Identifier name of sr_dev_driver struct to register.
337 #define SR_REGISTER_DEV_DRIVER(name) \
338 SR_REGISTER_DEV_DRIVER_LIST(name##_list, &name);
340 SR_API void sr_drivers_init(struct sr_context *context);
343 struct sr_dev_driver **driver_list;
344 #ifdef HAVE_LIBUSB_1_0
345 libusb_context *libusb_ctx;
347 sr_resource_open_callback resource_open_cb;
348 sr_resource_close_callback resource_close_cb;
349 sr_resource_read_callback resource_read_cb;
350 void *resource_cb_data;
353 /** Input module metadata keys. */
354 enum sr_input_meta_keys {
355 /** The input filename, if there is one. */
356 SR_INPUT_META_FILENAME = 0x01,
357 /** The input file's size in bytes. */
358 SR_INPUT_META_FILESIZE = 0x02,
359 /** The first 128 bytes of the file, provided as a GString. */
360 SR_INPUT_META_HEADER = 0x04,
362 /** The module cannot identify a file without this metadata. */
363 SR_INPUT_META_REQUIRED = 0x80,
366 /** Input (file) module struct. */
369 * A pointer to this input module's 'struct sr_input_module'.
371 const struct sr_input_module *module;
373 struct sr_dev_inst *sdi;
378 /** Input (file) module driver. */
379 struct sr_input_module {
381 * A unique ID for this input module, suitable for use in command-line
382 * clients, [a-z0-9-]. Must not be NULL.
387 * A unique name for this input module, suitable for use in GUI
388 * clients, can contain UTF-8. Must not be NULL.
393 * A short description of the input module. Must not be NULL.
395 * This can be displayed by frontends, e.g. when selecting the input
396 * module for saving a file.
401 * A NULL terminated array of strings containing a list of file name
402 * extensions typical for the input file format, or NULL if there is
403 * no typical extension for this file format.
405 const char *const *exts;
408 * Zero-terminated list of metadata items the module needs to be able
409 * to identify an input stream. Can be all-zero, if the module cannot
410 * identify streams at all, i.e. has to be forced into use.
412 * Each item is one of:
413 * SR_INPUT_META_FILENAME
414 * SR_INPUT_META_FILESIZE
415 * SR_INPUT_META_HEADER
417 * If the high bit (SR_INPUT META_REQUIRED) is set, the module cannot
418 * identify a stream without the given metadata.
420 const uint8_t metadata[8];
423 * Returns a NULL-terminated list of options this module can take.
424 * Can be NULL, if the module has no options.
426 const struct sr_option *(*options) (void);
429 * Check if this input module can load and parse the specified stream.
431 * @param[in] metadata Metadata the module can use to identify the stream.
432 * @param[out] confidence "Strength" of the detection.
433 * Specialized handlers can take precedence over generic/basic support.
435 * @retval SR_OK This module knows the format.
436 * @retval SR_ERR_NA There wasn't enough data for this module to
437 * positively identify the format.
438 * @retval SR_ERR_DATA This module knows the format, but cannot handle
439 * it. This means the stream is either corrupt, or indicates a
440 * feature that the module does not support.
441 * @retval SR_ERR This module does not know the format.
443 * Lower numeric values of 'confidence' mean that the input module
444 * stronger believes in its capability to handle this specific format.
445 * This way, multiple input modules can claim support for a format,
446 * and the application can pick the best match, or try fallbacks
447 * in case of errors. This approach also copes with formats that
448 * are unreliable to detect in the absence of magic signatures.
450 int (*format_match) (GHashTable *metadata, unsigned int *confidence);
453 * Initialize the input module.
455 * @retval SR_OK Success
456 * @retval other Negative error code.
458 int (*init) (struct sr_input *in, GHashTable *options);
461 * Send data to the specified input instance.
463 * When an input module instance is created with sr_input_new(), this
464 * function is used to feed data to the instance.
466 * As enough data gets fed into this function to completely populate
467 * the device instance associated with this input instance, this is
468 * guaranteed to return the moment it's ready. This gives the caller
469 * the chance to examine the device instance, attach session callbacks
472 * @retval SR_OK Success
473 * @retval other Negative error code.
475 int (*receive) (struct sr_input *in, GString *buf);
478 * Signal the input module no more data will come.
480 * This will cause the module to process any data it may have buffered.
481 * The SR_DF_END packet will also typically be sent at this time.
483 int (*end) (struct sr_input *in);
486 * Reset the input module's input handling structures.
488 * Causes the input module to reset its internal state so that we can
489 * re-send the input data from the beginning without having to
490 * re-create the entire input module.
492 * @retval SR_OK Success.
493 * @retval other Negative error code.
495 int (*reset) (struct sr_input *in);
498 * This function is called after the caller is finished using
499 * the input module, and can be used to free any internal
500 * resources the module may keep.
502 * This function is optional.
504 * @retval SR_OK Success
505 * @retval other Negative error code.
507 void (*cleanup) (struct sr_input *in);
510 /** Output module instance. */
512 /** A pointer to this output's module. */
513 const struct sr_output_module *module;
516 * The device for which this output module is creating output. This
517 * can be used by the module to find out channel names and numbers.
519 const struct sr_dev_inst *sdi;
522 * The name of the file that the data should be written to.
524 const char *filename;
527 * A generic pointer which can be used by the module to keep internal
528 * state between calls into its callback functions.
530 * For example, the module might store a pointer to a chunk of output
531 * there, and only flush it when it reaches a certain size.
536 /** Output module driver. */
537 struct sr_output_module {
539 * A unique ID for this output module, suitable for use in command-line
540 * clients, [a-z0-9-]. Must not be NULL.
545 * A unique name for this output module, suitable for use in GUI
546 * clients, can contain UTF-8. Must not be NULL.
551 * A short description of the output module. Must not be NULL.
553 * This can be displayed by frontends, e.g. when selecting the output
554 * module for saving a file.
559 * A NULL terminated array of strings containing a list of file name
560 * extensions typical for the input file format, or NULL if there is
561 * no typical extension for this file format.
563 const char *const *exts;
566 * Bitfield containing flags that describe certain properties
567 * this output module may or may not have.
568 * @see sr_output_flags
570 const uint64_t flags;
573 * Returns a NULL-terminated list of options this module can take.
574 * Can be NULL, if the module has no options.
576 const struct sr_option *(*options) (void);
579 * This function is called once, at the beginning of an output stream.
581 * The device struct will be available in the output struct passed in,
582 * as well as the param field -- which may be NULL or an empty string,
583 * if no parameter was passed.
585 * The module can use this to initialize itself, create a struct for
586 * keeping state and storing it in the <code>internal</code> field.
588 * @param o Pointer to the respective 'struct sr_output'.
590 * @retval SR_OK Success
591 * @retval other Negative error code.
593 int (*init) (struct sr_output *o, GHashTable *options);
596 * This function is passed a copy of every packet in the data feed.
597 * Any output generated by the output module in response to the
598 * packet should be returned in a newly allocated GString
599 * <code>out</code>, which will be freed by the caller.
601 * Packets not of interest to the output module can just be ignored,
602 * and the <code>out</code> parameter set to NULL.
604 * @param o Pointer to the respective 'struct sr_output'.
605 * @param sdi The device instance that generated the packet.
606 * @param packet The complete packet.
607 * @param out A pointer where a GString * should be stored if
608 * the module generates output, or NULL if not.
610 * @retval SR_OK Success
611 * @retval other Negative error code.
613 int (*receive) (const struct sr_output *o,
614 const struct sr_datafeed_packet *packet, GString **out);
617 * This function is called after the caller is finished using
618 * the output module, and can be used to free any internal
619 * resources the module may keep.
621 * @retval SR_OK Success
622 * @retval other Negative error code.
624 int (*cleanup) (struct sr_output *o);
627 /** Transform module instance. */
628 struct sr_transform {
629 /** A pointer to this transform's module. */
630 const struct sr_transform_module *module;
633 * The device for which this transform module is used. This
634 * can be used by the module to find out channel names and numbers.
636 const struct sr_dev_inst *sdi;
639 * A generic pointer which can be used by the module to keep internal
640 * state between calls into its callback functions.
645 struct sr_transform_module {
647 * A unique ID for this transform module, suitable for use in
648 * command-line clients, [a-z0-9-]. Must not be NULL.
653 * A unique name for this transform module, suitable for use in GUI
654 * clients, can contain UTF-8. Must not be NULL.
659 * A short description of the transform module. Must not be NULL.
661 * This can be displayed by frontends, e.g. when selecting
662 * which transform module(s) to add.
667 * Returns a NULL-terminated list of options this transform module
668 * can take. Can be NULL, if the transform module has no options.
670 const struct sr_option *(*options) (void);
673 * This function is called once, at the beginning of a stream.
675 * @param t Pointer to the respective 'struct sr_transform'.
676 * @param options Hash table of options for this transform module.
677 * Can be NULL if no options are to be used.
679 * @retval SR_OK Success
680 * @retval other Negative error code.
682 int (*init) (struct sr_transform *t, GHashTable *options);
685 * This function is passed a pointer to every packet in the data feed.
687 * It can either return (in packet_out) a pointer to another packet
688 * (possibly the exact same packet it got as input), or NULL.
690 * @param t Pointer to the respective 'struct sr_transform'.
691 * @param packet_in Pointer to a datafeed packet.
692 * @param packet_out Pointer to the resulting datafeed packet after
693 * this function was run. If NULL, the transform
694 * module intentionally didn't output a new packet.
696 * @retval SR_OK Success
697 * @retval other Negative error code.
699 int (*receive) (const struct sr_transform *t,
700 struct sr_datafeed_packet *packet_in,
701 struct sr_datafeed_packet **packet_out);
704 * This function is called after the caller is finished using
705 * the transform module, and can be used to free any internal
706 * resources the module may keep.
708 * @retval SR_OK Success
709 * @retval other Negative error code.
711 int (*cleanup) (struct sr_transform *t);
714 #ifdef HAVE_LIBUSB_1_0
715 /** USB device instance */
716 struct sr_usb_dev_inst {
719 /** Device address on USB bus */
721 /** libusb device handle */
722 struct libusb_device_handle *devhdl;
726 struct sr_serial_dev_inst;
727 #ifdef HAVE_SERIAL_COMM
728 struct ser_lib_functions;
729 struct sr_serial_dev_inst {
730 /** Port name, e.g. '/dev/tty42'. */
732 /** Comm params for serial_set_paramstr(). */
734 struct ser_lib_functions *lib_funcs;
741 #ifdef HAVE_LIBSERIALPORT
742 /** libserialport port handle */
743 struct sp_port *sp_data;
748 struct sr_usbtmc_dev_inst {
753 /* Private driver context. */
755 /** sigrok context */
756 struct sr_context *sr_ctx;
760 /*--- log.c -----------------------------------------------------------------*/
762 #if defined(_WIN32) && (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 4))
764 * On MinGW, we need to specify the gnu_printf format flavor or GCC
765 * will assume non-standard Microsoft printf syntax.
767 SR_PRIV int sr_log(int loglevel, const char *format, ...)
768 __attribute__((__format__ (__gnu_printf__, 2, 3)));
770 SR_PRIV int sr_log(int loglevel, const char *format, ...) G_GNUC_PRINTF(2, 3);
773 /* Message logging helpers with subsystem-specific prefix string. */
774 #define sr_spew(...) sr_log(SR_LOG_SPEW, LOG_PREFIX ": " __VA_ARGS__)
775 #define sr_dbg(...) sr_log(SR_LOG_DBG, LOG_PREFIX ": " __VA_ARGS__)
776 #define sr_info(...) sr_log(SR_LOG_INFO, LOG_PREFIX ": " __VA_ARGS__)
777 #define sr_warn(...) sr_log(SR_LOG_WARN, LOG_PREFIX ": " __VA_ARGS__)
778 #define sr_err(...) sr_log(SR_LOG_ERR, LOG_PREFIX ": " __VA_ARGS__)
780 /*--- device.c --------------------------------------------------------------*/
782 /** Scan options supported by a driver. */
783 #define SR_CONF_SCAN_OPTIONS 0x7FFF0000
785 /** Device options for a particular device. */
786 #define SR_CONF_DEVICE_OPTIONS 0x7FFF0001
788 /** Mask for separating config keys from capabilities. */
789 #define SR_CONF_MASK 0x1fffffff
791 /** Values for the changes argument of sr_dev_driver.config_channel_set. */
793 /** The enabled state of the channel has been changed. */
794 SR_CHANNEL_SET_ENABLED = 1 << 0,
797 SR_PRIV struct sr_channel *sr_channel_new(struct sr_dev_inst *sdi,
798 int index, int type, gboolean enabled, const char *name);
799 SR_PRIV void sr_channel_free(struct sr_channel *ch);
800 SR_PRIV void sr_channel_free_cb(void *p);
801 SR_PRIV struct sr_channel *sr_next_enabled_channel(const struct sr_dev_inst *sdi,
802 struct sr_channel *cur_channel);
803 SR_PRIV gboolean sr_channels_differ(struct sr_channel *ch1, struct sr_channel *ch2);
804 SR_PRIV gboolean sr_channel_lists_differ(GSList *l1, GSList *l2);
806 /** Device instance data */
808 /** Device driver. */
809 struct sr_dev_driver *driver;
810 /** Device instance status. SR_ST_NOT_FOUND, etc. */
812 /** Device instance type. SR_INST_USB, etc. */
814 /** Device vendor. */
818 /** Device version. */
820 /** Serial number. */
822 /** Connection string to uniquely identify devices. */
824 /** List of channels. */
826 /** List of sr_channel_group structs */
827 GSList *channel_groups;
828 /** Device instance connection data (used?) */
830 /** Device instance private data (used?) */
832 /** Session to which this device is currently assigned. */
833 struct sr_session *session;
836 /* Generic device instances */
837 SR_PRIV void sr_dev_inst_free(struct sr_dev_inst *sdi);
839 #ifdef HAVE_LIBUSB_1_0
840 /* USB-specific instances */
841 SR_PRIV struct sr_usb_dev_inst *sr_usb_dev_inst_new(uint8_t bus,
842 uint8_t address, struct libusb_device_handle *hdl);
843 SR_PRIV void sr_usb_dev_inst_free(struct sr_usb_dev_inst *usb);
846 #ifdef HAVE_SERIAL_COMM
847 #ifndef HAVE_LIBSERIALPORT
849 * Some identifiers which initially got provided by libserialport are
850 * used internally within the libsigrok serial layer's implementation,
851 * while libserialport no longer is the exclusive provider of serial
852 * communication support. Declare the identifiers here so they remain
853 * available across all build configurations.
863 enum libsp_flowcontrol {
864 SP_FLOWCONTROL_NONE = 0,
865 SP_FLOWCONTROL_XONXOFF = 1,
866 SP_FLOWCONTROL_RTSCTS = 2,
867 SP_FLOWCONTROL_DTRDSR = 3,
871 /* Serial-specific instances */
872 SR_PRIV struct sr_serial_dev_inst *sr_serial_dev_inst_new(const char *port,
873 const char *serialcomm);
874 SR_PRIV void sr_serial_dev_inst_free(struct sr_serial_dev_inst *serial);
877 /* USBTMC-specific instances */
878 SR_PRIV struct sr_usbtmc_dev_inst *sr_usbtmc_dev_inst_new(const char *device);
879 SR_PRIV void sr_usbtmc_dev_inst_free(struct sr_usbtmc_dev_inst *usbtmc);
881 /*--- hwdriver.c ------------------------------------------------------------*/
883 SR_PRIV const GVariantType *sr_variant_type_get(int datatype);
884 SR_PRIV int sr_variant_type_check(uint32_t key, GVariant *data);
885 SR_PRIV void sr_hw_cleanup_all(const struct sr_context *ctx);
886 SR_PRIV struct sr_config *sr_config_new(uint32_t key, GVariant *data);
887 SR_PRIV void sr_config_free(struct sr_config *src);
888 SR_PRIV int sr_dev_acquisition_start(struct sr_dev_inst *sdi);
889 SR_PRIV int sr_dev_acquisition_stop(struct sr_dev_inst *sdi);
891 /*--- session.c -------------------------------------------------------------*/
894 /** Context this session exists in. */
895 struct sr_context *ctx;
896 /** List of struct sr_dev_inst pointers. */
898 /** List of struct sr_dev_inst pointers owned by this session. */
900 /** List of struct datafeed_callback pointers. */
901 GSList *datafeed_callbacks;
903 struct sr_trigger *trigger;
905 /** Callback to invoke on session stop. */
906 sr_session_stopped_callback stopped_callback;
907 /** User data to be passed to the session stop callback. */
908 void *stopped_cb_data;
910 /** Mutex protecting the main context pointer. */
912 /** Context of the session main loop. */
913 GMainContext *main_context;
915 /** Registered event sources for this session. */
916 GHashTable *event_sources;
917 /** Session main loop. */
918 GMainLoop *main_loop;
919 /** ID of idle source for dispatching the session stop notification. */
920 unsigned int stop_check_id;
921 /** Whether the session has been started. */
925 SR_PRIV int sr_session_source_add_internal(struct sr_session *session,
926 void *key, GSource *source);
927 SR_PRIV int sr_session_source_remove_internal(struct sr_session *session,
929 SR_PRIV int sr_session_source_destroyed(struct sr_session *session,
930 void *key, GSource *source);
931 SR_PRIV int sr_session_fd_source_add(struct sr_session *session,
932 void *key, gintptr fd, int events, int timeout,
933 sr_receive_data_callback cb, void *cb_data);
935 SR_PRIV int sr_session_source_add(struct sr_session *session, int fd,
936 int events, int timeout, sr_receive_data_callback cb, void *cb_data);
937 SR_PRIV int sr_session_source_add_pollfd(struct sr_session *session,
938 GPollFD *pollfd, int timeout, sr_receive_data_callback cb,
940 SR_PRIV int sr_session_source_add_channel(struct sr_session *session,
941 GIOChannel *channel, int events, int timeout,
942 sr_receive_data_callback cb, void *cb_data);
943 SR_PRIV int sr_session_source_remove(struct sr_session *session, int fd);
944 SR_PRIV int sr_session_source_remove_pollfd(struct sr_session *session,
946 SR_PRIV int sr_session_source_remove_channel(struct sr_session *session,
947 GIOChannel *channel);
949 SR_PRIV int sr_session_send_meta(const struct sr_dev_inst *sdi,
950 uint32_t key, GVariant *var);
951 SR_PRIV int sr_session_send(const struct sr_dev_inst *sdi,
952 const struct sr_datafeed_packet *packet);
953 SR_PRIV int sr_sessionfile_check(const char *filename);
954 SR_PRIV struct sr_dev_inst *sr_session_prepare_sdi(const char *filename,
955 struct sr_session **session);
957 /*--- session_file.c --------------------------------------------------------*/
959 #if !HAVE_ZIP_DISCARD
960 /* Replace zip_discard() if not available. */
961 #define zip_discard(zip) sr_zip_discard(zip)
962 SR_PRIV void sr_zip_discard(struct zip *archive);
965 SR_PRIV GKeyFile *sr_sessionfile_read_metadata(struct zip *archive,
966 const struct zip_stat *entry);
968 /*--- analog.c --------------------------------------------------------------*/
970 SR_PRIV int sr_analog_init(struct sr_datafeed_analog *analog,
971 struct sr_analog_encoding *encoding,
972 struct sr_analog_meaning *meaning,
973 struct sr_analog_spec *spec,
976 /*--- std.c -----------------------------------------------------------------*/
978 typedef int (*dev_close_callback)(struct sr_dev_inst *sdi);
979 typedef void (*std_dev_clear_callback)(void *priv);
981 SR_PRIV int std_init(struct sr_dev_driver *di, struct sr_context *sr_ctx);
982 SR_PRIV int std_cleanup(const struct sr_dev_driver *di);
983 SR_PRIV int std_dummy_dev_open(struct sr_dev_inst *sdi);
984 SR_PRIV int std_dummy_dev_close(struct sr_dev_inst *sdi);
985 SR_PRIV int std_dummy_dev_acquisition_start(const struct sr_dev_inst *sdi);
986 SR_PRIV int std_dummy_dev_acquisition_stop(struct sr_dev_inst *sdi);
987 #ifdef HAVE_SERIAL_COMM
988 SR_PRIV int std_serial_dev_open(struct sr_dev_inst *sdi);
989 SR_PRIV int std_serial_dev_acquisition_stop(struct sr_dev_inst *sdi);
991 SR_PRIV int std_session_send_df_header(const struct sr_dev_inst *sdi);
992 SR_PRIV int std_session_send_df_end(const struct sr_dev_inst *sdi);
993 SR_PRIV int std_session_send_frame_begin(const struct sr_dev_inst *sdi);
994 SR_PRIV int std_session_send_frame_end(const struct sr_dev_inst *sdi);
995 SR_PRIV int std_dev_clear_with_callback(const struct sr_dev_driver *driver,
996 std_dev_clear_callback clear_private);
997 SR_PRIV int std_dev_clear(const struct sr_dev_driver *driver);
998 SR_PRIV GSList *std_dev_list(const struct sr_dev_driver *di);
999 SR_PRIV int std_serial_dev_close(struct sr_dev_inst *sdi);
1000 SR_PRIV GSList *std_scan_complete(struct sr_dev_driver *di, GSList *devices);
1002 SR_PRIV int std_opts_config_list(uint32_t key, GVariant **data,
1003 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg,
1004 const uint32_t scanopts[], size_t scansize, const uint32_t drvopts[],
1005 size_t drvsize, const uint32_t devopts[], size_t devsize);
1007 extern SR_PRIV const uint32_t NO_OPTS[1];
1009 #define STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts) \
1010 std_opts_config_list(key, data, sdi, cg, ARRAY_AND_SIZE(scanopts), \
1011 ARRAY_AND_SIZE(drvopts), ARRAY_AND_SIZE(devopts))
1013 SR_PRIV GVariant *std_gvar_tuple_array(const uint64_t a[][2], unsigned int n);
1014 SR_PRIV GVariant *std_gvar_tuple_rational(const struct sr_rational *r, unsigned int n);
1015 SR_PRIV GVariant *std_gvar_samplerates(const uint64_t samplerates[], unsigned int n);
1016 SR_PRIV GVariant *std_gvar_samplerates_steps(const uint64_t samplerates[], unsigned int n);
1017 SR_PRIV GVariant *std_gvar_min_max_step(double min, double max, double step);
1018 SR_PRIV GVariant *std_gvar_min_max_step_array(const double a[3]);
1019 SR_PRIV GVariant *std_gvar_min_max_step_thresholds(const double dmin, const double dmax, const double dstep);
1021 SR_PRIV GVariant *std_gvar_tuple_u64(uint64_t low, uint64_t high);
1022 SR_PRIV GVariant *std_gvar_tuple_double(double low, double high);
1024 SR_PRIV GVariant *std_gvar_array_i32(const int32_t a[], unsigned int n);
1025 SR_PRIV GVariant *std_gvar_array_u32(const uint32_t a[], unsigned int n);
1026 SR_PRIV GVariant *std_gvar_array_u64(const uint64_t a[], unsigned int n);
1027 SR_PRIV GVariant *std_gvar_array_str(const char *a[], unsigned int n);
1029 SR_PRIV GVariant *std_gvar_thresholds(const double a[][2], unsigned int n);
1031 SR_PRIV int std_str_idx(GVariant *data, const char *a[], unsigned int n);
1032 SR_PRIV int std_u64_idx(GVariant *data, const uint64_t a[], unsigned int n);
1033 SR_PRIV int std_u8_idx(GVariant *data, const uint8_t a[], unsigned int n);
1035 SR_PRIV int std_str_idx_s(const char *s, const char *a[], unsigned int n);
1036 SR_PRIV int std_u8_idx_s(uint8_t b, const uint8_t a[], unsigned int n);
1038 SR_PRIV int std_u64_tuple_idx(GVariant *data, const uint64_t a[][2], unsigned int n);
1039 SR_PRIV int std_double_tuple_idx(GVariant *data, const double a[][2], unsigned int n);
1040 SR_PRIV int std_double_tuple_idx_d0(const double d, const double a[][2], unsigned int n);
1042 SR_PRIV int std_cg_idx(const struct sr_channel_group *cg, struct sr_channel_group *a[], unsigned int n);
1044 /*--- resource.c ------------------------------------------------------------*/
1046 SR_PRIV int64_t sr_file_get_size(FILE *file);
1048 SR_PRIV int sr_resource_open(struct sr_context *ctx,
1049 struct sr_resource *res, int type, const char *name)
1050 G_GNUC_WARN_UNUSED_RESULT;
1051 SR_PRIV int sr_resource_close(struct sr_context *ctx,
1052 struct sr_resource *res);
1053 SR_PRIV gssize sr_resource_read(struct sr_context *ctx,
1054 const struct sr_resource *res, void *buf, size_t count)
1055 G_GNUC_WARN_UNUSED_RESULT;
1056 SR_PRIV void *sr_resource_load(struct sr_context *ctx, int type,
1057 const char *name, size_t *size, size_t max_size)
1058 G_GNUC_MALLOC G_GNUC_WARN_UNUSED_RESULT;
1060 /*--- strutil.c -------------------------------------------------------------*/
1062 SR_PRIV int sr_atol(const char *str, long *ret);
1063 SR_PRIV int sr_atoi(const char *str, int *ret);
1064 SR_PRIV int sr_atod(const char *str, double *ret);
1065 SR_PRIV int sr_atof(const char *str, float *ret);
1066 SR_PRIV int sr_atod_ascii(const char *str, double *ret);
1067 SR_PRIV int sr_atof_ascii(const char *str, float *ret);
1069 SR_PRIV GString *sr_hexdump_new(const uint8_t *data, const size_t len);
1070 SR_PRIV void sr_hexdump_free(GString *s);
1072 /*--- soft-trigger.c --------------------------------------------------------*/
1074 struct soft_trigger_logic {
1075 const struct sr_dev_inst *sdi;
1076 const struct sr_trigger *trigger;
1080 uint8_t *prev_sample;
1081 uint8_t *pre_trigger_buffer;
1082 uint8_t *pre_trigger_head;
1083 int pre_trigger_size;
1084 int pre_trigger_fill;
1087 SR_PRIV int logic_channel_unitsize(GSList *channels);
1088 SR_PRIV struct soft_trigger_logic *soft_trigger_logic_new(
1089 const struct sr_dev_inst *sdi, struct sr_trigger *trigger,
1090 int pre_trigger_samples);
1091 SR_PRIV void soft_trigger_logic_free(struct soft_trigger_logic *st);
1092 SR_PRIV int soft_trigger_logic_check(struct soft_trigger_logic *st, uint8_t *buf,
1093 int len, int *pre_trigger_samples);
1095 /*--- serial.c --------------------------------------------------------------*/
1097 #ifdef HAVE_SERIAL_COMM
1103 typedef gboolean (*packet_valid_callback)(const uint8_t *buf);
1105 typedef GSList *(*sr_ser_list_append_t)(GSList *devs, const char *name,
1107 typedef GSList *(*sr_ser_find_append_t)(GSList *devs, const char *name);
1109 SR_PRIV int serial_open(struct sr_serial_dev_inst *serial, int flags);
1110 SR_PRIV int serial_close(struct sr_serial_dev_inst *serial);
1111 SR_PRIV int serial_flush(struct sr_serial_dev_inst *serial);
1112 SR_PRIV int serial_drain(struct sr_serial_dev_inst *serial);
1113 SR_PRIV size_t serial_has_receive_data(struct sr_serial_dev_inst *serial);
1114 SR_PRIV int serial_write_blocking(struct sr_serial_dev_inst *serial,
1115 const void *buf, size_t count, unsigned int timeout_ms);
1116 SR_PRIV int serial_write_nonblocking(struct sr_serial_dev_inst *serial,
1117 const void *buf, size_t count);
1118 SR_PRIV int serial_read_blocking(struct sr_serial_dev_inst *serial, void *buf,
1119 size_t count, unsigned int timeout_ms);
1120 SR_PRIV int serial_read_nonblocking(struct sr_serial_dev_inst *serial, void *buf,
1122 SR_PRIV int serial_set_params(struct sr_serial_dev_inst *serial, int baudrate,
1123 int bits, int parity, int stopbits, int flowcontrol, int rts, int dtr);
1124 SR_PRIV int serial_set_paramstr(struct sr_serial_dev_inst *serial,
1125 const char *paramstr);
1126 SR_PRIV int serial_readline(struct sr_serial_dev_inst *serial, char **buf,
1127 int *buflen, gint64 timeout_ms);
1128 SR_PRIV int serial_stream_detect(struct sr_serial_dev_inst *serial,
1129 uint8_t *buf, size_t *buflen,
1131 packet_valid_callback is_valid,
1132 uint64_t timeout_ms, int baudrate);
1133 SR_PRIV int sr_serial_extract_options(GSList *options, const char **serial_device,
1134 const char **serial_options);
1135 SR_PRIV int serial_source_add(struct sr_session *session,
1136 struct sr_serial_dev_inst *serial, int events, int timeout,
1137 sr_receive_data_callback cb, void *cb_data);
1138 SR_PRIV int serial_source_remove(struct sr_session *session,
1139 struct sr_serial_dev_inst *serial);
1140 SR_PRIV GSList *sr_serial_find_usb(uint16_t vendor_id, uint16_t product_id);
1141 SR_PRIV int serial_timeout(struct sr_serial_dev_inst *port, int num_bytes);
1143 struct ser_lib_functions {
1144 int (*open)(struct sr_serial_dev_inst *serial, int flags);
1145 int (*close)(struct sr_serial_dev_inst *serial);
1146 int (*flush)(struct sr_serial_dev_inst *serial);
1147 int (*drain)(struct sr_serial_dev_inst *serial);
1148 int (*write)(struct sr_serial_dev_inst *serial,
1149 const void *buf, size_t count,
1150 int nonblocking, unsigned int timeout_ms);
1151 int (*read)(struct sr_serial_dev_inst *serial,
1152 void *buf, size_t count,
1153 int nonblocking, unsigned int timeout_ms);
1154 int (*set_params)(struct sr_serial_dev_inst *serial,
1155 int baudrate, int bits, int parity, int stopbits,
1156 int flowcontrol, int rts, int dtr);
1157 int (*setup_source_add)(struct sr_session *session,
1158 struct sr_serial_dev_inst *serial,
1159 int events, int timeout,
1160 sr_receive_data_callback cb, void *cb_data);
1161 int (*setup_source_remove)(struct sr_session *session,
1162 struct sr_serial_dev_inst *serial);
1163 GSList *(*list)(GSList *list, sr_ser_list_append_t append);
1164 GSList *(*find_usb)(GSList *list, sr_ser_find_append_t append,
1165 uint16_t vendor_id, uint16_t product_id);
1166 int (*get_frame_format)(struct sr_serial_dev_inst *serial,
1167 int *baud, int *bits);
1168 size_t (*get_rx_avail)(struct sr_serial_dev_inst *serial);
1170 extern SR_PRIV struct ser_lib_functions *ser_lib_funcs_libsp;
1173 /*--- ezusb.c ---------------------------------------------------------------*/
1175 #ifdef HAVE_LIBUSB_1_0
1176 SR_PRIV int ezusb_reset(struct libusb_device_handle *hdl, int set_clear);
1177 SR_PRIV int ezusb_install_firmware(struct sr_context *ctx, libusb_device_handle *hdl,
1179 SR_PRIV int ezusb_upload_firmware(struct sr_context *ctx, libusb_device *dev,
1180 int configuration, const char *name);
1183 /*--- usb.c -----------------------------------------------------------------*/
1185 #ifdef HAVE_LIBUSB_1_0
1186 SR_PRIV GSList *sr_usb_find(libusb_context *usb_ctx, const char *conn);
1187 SR_PRIV int sr_usb_open(libusb_context *usb_ctx, struct sr_usb_dev_inst *usb);
1188 SR_PRIV void sr_usb_close(struct sr_usb_dev_inst *usb);
1189 SR_PRIV int usb_source_add(struct sr_session *session, struct sr_context *ctx,
1190 int timeout, sr_receive_data_callback cb, void *cb_data);
1191 SR_PRIV int usb_source_remove(struct sr_session *session, struct sr_context *ctx);
1192 SR_PRIV int usb_get_port_path(libusb_device *dev, char *path, int path_len);
1193 SR_PRIV gboolean usb_match_manuf_prod(libusb_device *dev,
1194 const char *manufacturer, const char *product);
1198 /*--- modbus/modbus.c -------------------------------------------------------*/
1200 struct sr_modbus_dev_inst {
1204 GSList *(*scan)(int modbusaddr);
1205 int (*dev_inst_new)(void *priv, const char *resource,
1206 char **params, const char *serialcomm, int modbusaddr);
1207 int (*open)(void *priv);
1208 int (*source_add)(struct sr_session *session, void *priv, int events,
1209 int timeout, sr_receive_data_callback cb, void *cb_data);
1210 int (*source_remove)(struct sr_session *session, void *priv);
1211 int (*send)(void *priv, const uint8_t *buffer, int buffer_size);
1212 int (*read_begin)(void *priv, uint8_t *function_code);
1213 int (*read_data)(void *priv, uint8_t *buf, int maxlen);
1214 int (*read_end)(void *priv);
1215 int (*close)(void *priv);
1216 void (*free)(void *priv);
1217 unsigned int read_timeout_ms;
1221 SR_PRIV GSList *sr_modbus_scan(struct drv_context *drvc, GSList *options,
1222 struct sr_dev_inst *(*probe_device)(struct sr_modbus_dev_inst *modbus));
1223 SR_PRIV struct sr_modbus_dev_inst *modbus_dev_inst_new(const char *resource,
1224 const char *serialcomm, int modbusaddr);
1225 SR_PRIV int sr_modbus_open(struct sr_modbus_dev_inst *modbus);
1226 SR_PRIV int sr_modbus_source_add(struct sr_session *session,
1227 struct sr_modbus_dev_inst *modbus, int events, int timeout,
1228 sr_receive_data_callback cb, void *cb_data);
1229 SR_PRIV int sr_modbus_source_remove(struct sr_session *session,
1230 struct sr_modbus_dev_inst *modbus);
1231 SR_PRIV int sr_modbus_request(struct sr_modbus_dev_inst *modbus,
1232 uint8_t *request, int request_size);
1233 SR_PRIV int sr_modbus_reply(struct sr_modbus_dev_inst *modbus,
1234 uint8_t *reply, int reply_size);
1235 SR_PRIV int sr_modbus_request_reply(struct sr_modbus_dev_inst *modbus,
1236 uint8_t *request, int request_size,
1237 uint8_t *reply, int reply_size);
1238 SR_PRIV int sr_modbus_read_coils(struct sr_modbus_dev_inst *modbus,
1239 int address, int nb_coils, uint8_t *coils);
1240 SR_PRIV int sr_modbus_read_holding_registers(struct sr_modbus_dev_inst *modbus,
1241 int address, int nb_registers,
1242 uint16_t *registers);
1243 SR_PRIV int sr_modbus_write_coil(struct sr_modbus_dev_inst *modbus,
1244 int address, int value);
1245 SR_PRIV int sr_modbus_write_multiple_registers(struct sr_modbus_dev_inst*modbus,
1246 int address, int nb_registers,
1247 uint16_t *registers);
1248 SR_PRIV int sr_modbus_close(struct sr_modbus_dev_inst *modbus);
1249 SR_PRIV void sr_modbus_free(struct sr_modbus_dev_inst *modbus);
1251 /*--- dmm/es519xx.c ---------------------------------------------------------*/
1254 * All 11-byte es519xx chips repeat each block twice for each conversion cycle
1255 * so always read 2 blocks at a time.
1257 #define ES519XX_11B_PACKET_SIZE (11 * 2)
1258 #define ES519XX_14B_PACKET_SIZE 14
1260 struct es519xx_info {
1261 gboolean is_judge, is_voltage, is_auto, is_micro, is_current;
1262 gboolean is_milli, is_resistance, is_continuity, is_diode;
1263 gboolean is_frequency, is_rpm, is_capacitance, is_duty_cycle;
1264 gboolean is_temperature, is_celsius, is_fahrenheit;
1265 gboolean is_adp0, is_adp1, is_adp2, is_adp3;
1266 gboolean is_sign, is_batt, is_ol, is_pmax, is_pmin, is_apo;
1267 gboolean is_dc, is_ac, is_vahz, is_min, is_max, is_rel, is_hold;
1268 gboolean is_digit4, is_ul, is_vasel, is_vbar, is_lpf1, is_lpf0, is_rmr;
1271 gboolean alt_functions, fivedigits, clampmeter, selectable_lpf;
1275 SR_PRIV gboolean sr_es519xx_2400_11b_packet_valid(const uint8_t *buf);
1276 SR_PRIV int sr_es519xx_2400_11b_parse(const uint8_t *buf, float *floatval,
1277 struct sr_datafeed_analog *analog, void *info);
1278 SR_PRIV gboolean sr_es519xx_2400_11b_altfn_packet_valid(const uint8_t *buf);
1279 SR_PRIV int sr_es519xx_2400_11b_altfn_parse(const uint8_t *buf,
1280 float *floatval, struct sr_datafeed_analog *analog, void *info);
1281 SR_PRIV gboolean sr_es519xx_19200_11b_5digits_packet_valid(const uint8_t *buf);
1282 SR_PRIV int sr_es519xx_19200_11b_5digits_parse(const uint8_t *buf,
1283 float *floatval, struct sr_datafeed_analog *analog, void *info);
1284 SR_PRIV gboolean sr_es519xx_19200_11b_clamp_packet_valid(const uint8_t *buf);
1285 SR_PRIV int sr_es519xx_19200_11b_clamp_parse(const uint8_t *buf,
1286 float *floatval, struct sr_datafeed_analog *analog, void *info);
1287 SR_PRIV gboolean sr_es519xx_19200_11b_packet_valid(const uint8_t *buf);
1288 SR_PRIV int sr_es519xx_19200_11b_parse(const uint8_t *buf, float *floatval,
1289 struct sr_datafeed_analog *analog, void *info);
1290 SR_PRIV gboolean sr_es519xx_19200_14b_packet_valid(const uint8_t *buf);
1291 SR_PRIV int sr_es519xx_19200_14b_parse(const uint8_t *buf, float *floatval,
1292 struct sr_datafeed_analog *analog, void *info);
1293 SR_PRIV gboolean sr_es519xx_19200_14b_sel_lpf_packet_valid(const uint8_t *buf);
1294 SR_PRIV int sr_es519xx_19200_14b_sel_lpf_parse(const uint8_t *buf,
1295 float *floatval, struct sr_datafeed_analog *analog, void *info);
1297 /*--- dmm/fs9922.c ----------------------------------------------------------*/
1299 #define FS9922_PACKET_SIZE 14
1301 struct fs9922_info {
1302 gboolean is_auto, is_dc, is_ac, is_rel, is_hold, is_bpn, is_z1, is_z2;
1303 gboolean is_max, is_min, is_apo, is_bat, is_nano, is_z3, is_micro;
1304 gboolean is_milli, is_kilo, is_mega, is_beep, is_diode, is_percent;
1305 gboolean is_z4, is_volt, is_ampere, is_ohm, is_hfe, is_hertz, is_farad;
1306 gboolean is_celsius, is_fahrenheit;
1307 int bargraph_sign, bargraph_value;
1310 SR_PRIV gboolean sr_fs9922_packet_valid(const uint8_t *buf);
1311 SR_PRIV int sr_fs9922_parse(const uint8_t *buf, float *floatval,
1312 struct sr_datafeed_analog *analog, void *info);
1313 SR_PRIV void sr_fs9922_z1_diode(struct sr_datafeed_analog *analog, void *info);
1315 /*--- dmm/fs9721.c ----------------------------------------------------------*/
1317 #define FS9721_PACKET_SIZE 14
1319 struct fs9721_info {
1320 gboolean is_ac, is_dc, is_auto, is_rs232, is_micro, is_nano, is_kilo;
1321 gboolean is_diode, is_milli, is_percent, is_mega, is_beep, is_farad;
1322 gboolean is_ohm, is_rel, is_hold, is_ampere, is_volt, is_hz, is_bat;
1323 gboolean is_c2c1_11, is_c2c1_10, is_c2c1_01, is_c2c1_00, is_sign;
1326 SR_PRIV gboolean sr_fs9721_packet_valid(const uint8_t *buf);
1327 SR_PRIV int sr_fs9721_parse(const uint8_t *buf, float *floatval,
1328 struct sr_datafeed_analog *analog, void *info);
1329 SR_PRIV void sr_fs9721_00_temp_c(struct sr_datafeed_analog *analog, void *info);
1330 SR_PRIV void sr_fs9721_01_temp_c(struct sr_datafeed_analog *analog, void *info);
1331 SR_PRIV void sr_fs9721_10_temp_c(struct sr_datafeed_analog *analog, void *info);
1332 SR_PRIV void sr_fs9721_01_10_temp_f_c(struct sr_datafeed_analog *analog, void *info);
1333 SR_PRIV void sr_fs9721_max_c_min(struct sr_datafeed_analog *analog, void *info);
1335 /*--- dmm/ms2115b.c ---------------------------------------------------------*/
1337 #define MS2115B_PACKET_SIZE 9
1339 enum ms2115b_display {
1340 MS2115B_DISPLAY_MAIN,
1341 MS2115B_DISPLAY_SUB,
1342 MS2115B_DISPLAY_COUNT,
1345 struct ms2115b_info {
1346 /* Selected channel. */
1348 gboolean is_ac, is_dc, is_auto;
1349 gboolean is_diode, is_beep, is_farad;
1350 gboolean is_ohm, is_ampere, is_volt, is_hz;
1351 gboolean is_duty_cycle, is_percent;
1354 extern SR_PRIV const char *ms2115b_channel_formats[];
1355 SR_PRIV gboolean sr_ms2115b_packet_valid(const uint8_t *buf);
1356 SR_PRIV int sr_ms2115b_parse(const uint8_t *buf, float *floatval,
1357 struct sr_datafeed_analog *analog, void *info);
1359 /*--- dmm/ms8250d.c ---------------------------------------------------------*/
1361 #define MS8250D_PACKET_SIZE 18
1363 struct ms8250d_info {
1364 gboolean is_ac, is_dc, is_auto, is_rs232, is_micro, is_nano, is_kilo;
1365 gboolean is_diode, is_milli, is_percent, is_mega, is_beep, is_farad;
1366 gboolean is_ohm, is_rel, is_hold, is_ampere, is_volt, is_hz, is_bat;
1367 gboolean is_ncv, is_min, is_max, is_sign, is_autotimer;
1370 SR_PRIV gboolean sr_ms8250d_packet_valid(const uint8_t *buf);
1371 SR_PRIV int sr_ms8250d_parse(const uint8_t *buf, float *floatval,
1372 struct sr_datafeed_analog *analog, void *info);
1374 /*--- dmm/dtm0660.c ---------------------------------------------------------*/
1376 #define DTM0660_PACKET_SIZE 15
1378 struct dtm0660_info {
1379 gboolean is_ac, is_dc, is_auto, is_rs232, is_micro, is_nano, is_kilo;
1380 gboolean is_diode, is_milli, is_percent, is_mega, is_beep, is_farad;
1381 gboolean is_ohm, is_rel, is_hold, is_ampere, is_volt, is_hz, is_bat;
1382 gboolean is_degf, is_degc, is_c2c1_01, is_c2c1_00, is_apo, is_min;
1383 gboolean is_minmax, is_max, is_sign;
1386 SR_PRIV gboolean sr_dtm0660_packet_valid(const uint8_t *buf);
1387 SR_PRIV int sr_dtm0660_parse(const uint8_t *buf, float *floatval,
1388 struct sr_datafeed_analog *analog, void *info);
1390 /*--- dmm/m2110.c -----------------------------------------------------------*/
1392 #define BBCGM_M2110_PACKET_SIZE 9
1394 /* Dummy info struct. The parser does not use it. */
1395 struct m2110_info { int dummy; };
1397 SR_PRIV gboolean sr_m2110_packet_valid(const uint8_t *buf);
1398 SR_PRIV int sr_m2110_parse(const uint8_t *buf, float *floatval,
1399 struct sr_datafeed_analog *analog, void *info);
1401 /*--- dmm/metex14.c ---------------------------------------------------------*/
1403 #define METEX14_PACKET_SIZE 14
1405 struct metex14_info {
1407 gboolean is_ac, is_dc, is_resistance, is_capacity, is_temperature;
1408 gboolean is_diode, is_frequency, is_ampere, is_volt, is_farad;
1409 gboolean is_hertz, is_ohm, is_celsius, is_fahrenheit, is_watt;
1410 gboolean is_pico, is_nano, is_micro, is_milli, is_kilo, is_mega;
1411 gboolean is_gain, is_decibel, is_power, is_decibel_mw, is_power_factor;
1412 gboolean is_hfe, is_unitless, is_logic, is_min, is_max, is_avg;
1415 #ifdef HAVE_SERIAL_COMM
1416 SR_PRIV int sr_metex14_packet_request(struct sr_serial_dev_inst *serial);
1418 SR_PRIV gboolean sr_metex14_packet_valid(const uint8_t *buf);
1419 SR_PRIV int sr_metex14_parse(const uint8_t *buf, float *floatval,
1420 struct sr_datafeed_analog *analog, void *info);
1421 SR_PRIV gboolean sr_metex14_4packets_valid(const uint8_t *buf);
1422 SR_PRIV int sr_metex14_4packets_parse(const uint8_t *buf, float *floatval,
1423 struct sr_datafeed_analog *analog, void *info);
1425 /*--- dmm/rs9lcd.c ----------------------------------------------------------*/
1427 #define RS9LCD_PACKET_SIZE 9
1429 /* Dummy info struct. The parser does not use it. */
1430 struct rs9lcd_info { int dummy; };
1432 SR_PRIV gboolean sr_rs9lcd_packet_valid(const uint8_t *buf);
1433 SR_PRIV int sr_rs9lcd_parse(const uint8_t *buf, float *floatval,
1434 struct sr_datafeed_analog *analog, void *info);
1436 /*--- dmm/bm25x.c -----------------------------------------------------------*/
1438 #define BRYMEN_BM25X_PACKET_SIZE 15
1440 /* Dummy info struct. The parser does not use it. */
1441 struct bm25x_info { int dummy; };
1443 SR_PRIV gboolean sr_brymen_bm25x_packet_valid(const uint8_t *buf);
1444 SR_PRIV int sr_brymen_bm25x_parse(const uint8_t *buf, float *floatval,
1445 struct sr_datafeed_analog *analog, void *info);
1447 /*--- dmm/ut71x.c -----------------------------------------------------------*/
1449 #define UT71X_PACKET_SIZE 11
1452 gboolean is_voltage, is_resistance, is_capacitance, is_temperature;
1453 gboolean is_celsius, is_fahrenheit, is_current, is_continuity;
1454 gboolean is_diode, is_frequency, is_duty_cycle, is_dc, is_ac;
1455 gboolean is_auto, is_manual, is_sign, is_power, is_loop_current;
1458 SR_PRIV gboolean sr_ut71x_packet_valid(const uint8_t *buf);
1459 SR_PRIV int sr_ut71x_parse(const uint8_t *buf, float *floatval,
1460 struct sr_datafeed_analog *analog, void *info);
1462 /*--- dmm/vc870.c -----------------------------------------------------------*/
1464 #define VC870_PACKET_SIZE 23
1467 gboolean is_voltage, is_dc, is_ac, is_temperature, is_resistance;
1468 gboolean is_continuity, is_capacitance, is_diode, is_loop_current;
1469 gboolean is_current, is_micro, is_milli, is_power;
1470 gboolean is_power_factor_freq, is_power_apparent_power, is_v_a_rms_value;
1471 gboolean is_sign2, is_sign1, is_batt, is_ol1, is_max, is_min;
1472 gboolean is_maxmin, is_rel, is_ol2, is_open, is_manu, is_hold;
1473 gboolean is_light, is_usb, is_warning, is_auto_power, is_misplug_warn;
1474 gboolean is_lo, is_hi, is_open2;
1476 gboolean is_frequency, is_dual_display, is_auto;
1479 SR_PRIV gboolean sr_vc870_packet_valid(const uint8_t *buf);
1480 SR_PRIV int sr_vc870_parse(const uint8_t *buf, float *floatval,
1481 struct sr_datafeed_analog *analog, void *info);
1483 /*--- dmm/vc96.c ------------------------------------------------------------*/
1485 #define VC96_PACKET_SIZE 13
1489 gboolean is_ac, is_dc, is_resistance, is_diode, is_ampere, is_volt;
1490 gboolean is_ohm, is_micro, is_milli, is_kilo, is_mega, is_hfe;
1491 gboolean is_unitless;
1494 SR_PRIV gboolean sr_vc96_packet_valid(const uint8_t *buf);
1495 SR_PRIV int sr_vc96_parse(const uint8_t *buf, float *floatval,
1496 struct sr_datafeed_analog *analog, void *info);
1498 /*--- lcr/es51919.c ---------------------------------------------------------*/
1500 SR_PRIV void es51919_serial_clean(void *priv);
1501 SR_PRIV struct sr_dev_inst *es51919_serial_scan(GSList *options,
1504 SR_PRIV int es51919_serial_config_get(uint32_t key, GVariant **data,
1505 const struct sr_dev_inst *sdi,
1506 const struct sr_channel_group *cg);
1507 SR_PRIV int es51919_serial_config_set(uint32_t key, GVariant *data,
1508 const struct sr_dev_inst *sdi,
1509 const struct sr_channel_group *cg);
1510 SR_PRIV int es51919_serial_config_list(uint32_t key, GVariant **data,
1511 const struct sr_dev_inst *sdi,
1512 const struct sr_channel_group *cg);
1513 SR_PRIV int es51919_serial_acquisition_start(const struct sr_dev_inst *sdi);
1514 SR_PRIV int es51919_serial_acquisition_stop(struct sr_dev_inst *sdi);
1516 /*--- dmm/ut372.c -----------------------------------------------------------*/
1518 #define UT372_PACKET_SIZE 27
1524 SR_PRIV gboolean sr_ut372_packet_valid(const uint8_t *buf);
1525 SR_PRIV int sr_ut372_parse(const uint8_t *buf, float *floatval,
1526 struct sr_datafeed_analog *analog, void *info);
1528 /*--- dmm/asycii.c ----------------------------------------------------------*/
1530 #define ASYCII_PACKET_SIZE 16
1532 struct asycii_info {
1533 gboolean is_ac, is_dc, is_ac_and_dc;
1534 gboolean is_resistance, is_capacitance, is_diode, is_gain;
1535 gboolean is_frequency, is_duty_cycle, is_duty_pos, is_duty_neg;
1536 gboolean is_pulse_width, is_period_pos, is_period_neg;
1537 gboolean is_pulse_count, is_count_pos, is_count_neg;
1538 gboolean is_ampere, is_volt, is_volt_ampere, is_farad, is_ohm;
1539 gboolean is_hertz, is_percent, is_seconds, is_decibel;
1540 gboolean is_pico, is_nano, is_micro, is_milli, is_kilo, is_mega;
1541 gboolean is_unitless;
1542 gboolean is_peak_min, is_peak_max;
1543 gboolean is_invalid;
1546 #ifdef HAVE_SERIAL_COMM
1547 SR_PRIV int sr_asycii_packet_request(struct sr_serial_dev_inst *serial);
1549 SR_PRIV gboolean sr_asycii_packet_valid(const uint8_t *buf);
1550 SR_PRIV int sr_asycii_parse(const uint8_t *buf, float *floatval,
1551 struct sr_datafeed_analog *analog, void *info);
1553 /*--- dmm/eev121gw.c --------------------------------------------------------*/
1555 #define EEV121GW_PACKET_SIZE 19
1557 enum eev121gw_display {
1558 EEV121GW_DISPLAY_MAIN,
1559 EEV121GW_DISPLAY_SUB,
1560 EEV121GW_DISPLAY_BAR,
1561 EEV121GW_DISPLAY_COUNT,
1564 struct eev121gw_info {
1565 /* Selected channel. */
1568 * Measured value, number and sign/overflow flags, scale factor
1569 * and significant digits.
1571 uint32_t uint_value;
1572 gboolean is_ofl, is_neg;
1574 /* Currently active mode (meter's function). */
1575 gboolean is_ac, is_dc, is_voltage, is_current, is_power, is_gain;
1576 gboolean is_resistance, is_capacitance, is_diode, is_temperature;
1577 gboolean is_continuity, is_frequency, is_period, is_duty_cycle;
1578 /* Quantities associated with mode/function. */
1579 gboolean is_ampere, is_volt, is_volt_ampere, is_dbm;
1580 gboolean is_ohm, is_farad, is_celsius, is_fahrenheit;
1581 gboolean is_hertz, is_seconds, is_percent, is_loop_current;
1582 gboolean is_unitless, is_logic;
1583 /* Other indicators. */
1584 gboolean is_min, is_max, is_avg, is_1ms_peak, is_rel, is_hold;
1585 gboolean is_low_pass, is_mem, is_bt, is_auto_range, is_test;
1586 gboolean is_auto_poweroff, is_low_batt;
1589 extern SR_PRIV const char *eev121gw_channel_formats[];
1590 SR_PRIV gboolean sr_eev121gw_packet_valid(const uint8_t *buf);
1591 SR_PRIV int sr_eev121gw_parse(const uint8_t *buf, float *floatval,
1592 struct sr_datafeed_analog *analog, void *info);
1593 SR_PRIV int sr_eev121gw_3displays_parse(const uint8_t *buf, float *floatval,
1594 struct sr_datafeed_analog *analog, void *info);
1596 /*--- scale/kern.c ----------------------------------------------------------*/
1599 gboolean is_gram, is_carat, is_ounce, is_pound, is_troy_ounce;
1600 gboolean is_pennyweight, is_grain, is_tael, is_momme, is_tola;
1601 gboolean is_percentage, is_piece, is_unstable, is_stable, is_error;
1605 SR_PRIV gboolean sr_kern_packet_valid(const uint8_t *buf);
1606 SR_PRIV int sr_kern_parse(const uint8_t *buf, float *floatval,
1607 struct sr_datafeed_analog *analog, void *info);
1609 /*--- sw_limits.c -----------------------------------------------------------*/
1611 struct sr_sw_limits {
1612 uint64_t limit_samples;
1613 uint64_t limit_msec;
1614 uint64_t samples_read;
1615 uint64_t start_time;
1618 SR_PRIV int sr_sw_limits_config_get(struct sr_sw_limits *limits, uint32_t key,
1620 SR_PRIV int sr_sw_limits_config_set(struct sr_sw_limits *limits, uint32_t key,
1622 SR_PRIV void sr_sw_limits_acquisition_start(struct sr_sw_limits *limits);
1623 SR_PRIV gboolean sr_sw_limits_check(struct sr_sw_limits *limits);
1624 SR_PRIV void sr_sw_limits_update_samples_read(struct sr_sw_limits *limits,
1625 uint64_t samples_read);
1626 SR_PRIV void sr_sw_limits_init(struct sr_sw_limits *limits);