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_LIBUSB_1_0
35 #ifdef HAVE_LIBSERIALPORT
36 #include <libserialport.h>
45 * libsigrok private header file, only to be used internally.
48 /*--- Macros ----------------------------------------------------------------*/
51 #define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0]))
54 #ifndef ARRAY_AND_SIZE
55 #define ARRAY_AND_SIZE(a) (a), ARRAY_SIZE(a)
59 * Read a 8 bits unsigned integer out of memory.
60 * @param x a pointer to the input memory
61 * @return the corresponding unsigned integer
63 #define R8(x) ((unsigned)((const uint8_t*)(x))[0])
66 * Read a 16 bits big endian unsigned integer out of memory.
67 * @param x a pointer to the input memory
68 * @return the corresponding unsigned integer
70 #define RB16(x) (((unsigned)((const uint8_t*)(x))[0] << 8) | \
71 (unsigned)((const uint8_t*)(x))[1])
74 * Read a 16 bits little endian unsigned integer out of memory.
75 * @param x a pointer to the input memory
76 * @return the corresponding unsigned integer
78 #define RL16(x) (((unsigned)((const uint8_t*)(x))[1] << 8) | \
79 (unsigned)((const uint8_t*)(x))[0])
82 * Read a 16 bits big endian signed integer out of memory.
83 * @param x a pointer to the input memory
84 * @return the corresponding signed integer
86 #define RB16S(x) ((int16_t) \
87 (((unsigned)((const uint8_t*)(x))[0] << 8) | \
88 (unsigned)((const uint8_t*)(x))[1]))
91 * Read a 16 bits little endian signed integer out of memory.
92 * @param x a pointer to the input memory
93 * @return the corresponding signed integer
95 #define RL16S(x) ((int16_t) \
96 (((unsigned)((const uint8_t*)(x))[1] << 8) | \
97 (unsigned)((const uint8_t*)(x))[0]))
100 * Read a 32 bits big endian unsigned integer out of memory.
101 * @param x a pointer to the input memory
102 * @return the corresponding unsigned integer
104 #define RB32(x) (((unsigned)((const uint8_t*)(x))[0] << 24) | \
105 ((unsigned)((const uint8_t*)(x))[1] << 16) | \
106 ((unsigned)((const uint8_t*)(x))[2] << 8) | \
107 (unsigned)((const uint8_t*)(x))[3])
110 * Read a 32 bits little endian unsigned integer out of memory.
111 * @param x a pointer to the input memory
112 * @return the corresponding unsigned integer
114 #define RL32(x) (((unsigned)((const uint8_t*)(x))[3] << 24) | \
115 ((unsigned)((const uint8_t*)(x))[2] << 16) | \
116 ((unsigned)((const uint8_t*)(x))[1] << 8) | \
117 (unsigned)((const uint8_t*)(x))[0])
120 * Read a 32 bits big endian signed integer out of memory.
121 * @param x a pointer to the input memory
122 * @return the corresponding signed integer
124 #define RB32S(x) ((int32_t) \
125 (((unsigned)((const uint8_t*)(x))[0] << 24) | \
126 ((unsigned)((const uint8_t*)(x))[1] << 16) | \
127 ((unsigned)((const uint8_t*)(x))[2] << 8) | \
128 (unsigned)((const uint8_t*)(x))[3]))
131 * Read a 32 bits little endian signed integer out of memory.
132 * @param x a pointer to the input memory
133 * @return the corresponding signed integer
135 #define RL32S(x) ((int32_t) \
136 (((unsigned)((const uint8_t*)(x))[3] << 24) | \
137 ((unsigned)((const uint8_t*)(x))[2] << 16) | \
138 ((unsigned)((const uint8_t*)(x))[1] << 8) | \
139 (unsigned)((const uint8_t*)(x))[0]))
142 * Read a 64 bits big endian unsigned integer out of memory.
143 * @param x a pointer to the input memory
144 * @return the corresponding unsigned integer
146 #define RB64(x) (((uint64_t)((const uint8_t*)(x))[0] << 56) | \
147 ((uint64_t)((const uint8_t*)(x))[1] << 48) | \
148 ((uint64_t)((const uint8_t*)(x))[2] << 40) | \
149 ((uint64_t)((const uint8_t*)(x))[3] << 32) | \
150 ((uint64_t)((const uint8_t*)(x))[4] << 24) | \
151 ((uint64_t)((const uint8_t*)(x))[5] << 16) | \
152 ((uint64_t)((const uint8_t*)(x))[6] << 8) | \
153 (uint64_t)((const uint8_t*)(x))[7])
156 * Read a 64 bits little endian unsigned integer out of memory.
157 * @param x a pointer to the input memory
158 * @return the corresponding unsigned integer
160 #define RL64(x) (((uint64_t)((const uint8_t*)(x))[7] << 56) | \
161 ((uint64_t)((const uint8_t*)(x))[6] << 48) | \
162 ((uint64_t)((const uint8_t*)(x))[5] << 40) | \
163 ((uint64_t)((const uint8_t*)(x))[4] << 32) | \
164 ((uint64_t)((const uint8_t*)(x))[3] << 24) | \
165 ((uint64_t)((const uint8_t*)(x))[2] << 16) | \
166 ((uint64_t)((const uint8_t*)(x))[1] << 8) | \
167 (uint64_t)((const uint8_t*)(x))[0])
170 * Read a 64 bits little endian signed integer out of memory.
171 * @param x a pointer to the input memory
172 * @return the corresponding unsigned integer
174 #define RL64S(x) ((int64_t) \
175 (((uint64_t)((const uint8_t*)(x))[7] << 56) | \
176 ((uint64_t)((const uint8_t*)(x))[6] << 48) | \
177 ((uint64_t)((const uint8_t*)(x))[5] << 40) | \
178 ((uint64_t)((const uint8_t*)(x))[4] << 32) | \
179 ((uint64_t)((const uint8_t*)(x))[3] << 24) | \
180 ((uint64_t)((const uint8_t*)(x))[2] << 16) | \
181 ((uint64_t)((const uint8_t*)(x))[1] << 8) | \
182 (uint64_t)((const uint8_t*)(x))[0]))
185 * Read a 32 bits big endian float out of memory.
186 * @param x a pointer to the input memory
187 * @return the corresponding float
189 #define RBFL(x) ((union { uint32_t u; float f; }) { .u = RB32(x) }.f)
192 * Read a 32 bits little endian float out of memory.
193 * @param x a pointer to the input memory
194 * @return the corresponding float
196 #define RLFL(x) ((union { uint32_t u; float f; }) { .u = RL32(x) }.f)
199 * Write a 8 bits unsigned integer to memory.
200 * @param p a pointer to the output memory
201 * @param x the input unsigned integer
203 #define W8(p, x) do { ((uint8_t*)(p))[0] = (uint8_t) (x); } while (0)
206 * Write a 16 bits unsigned integer to memory stored as big endian.
207 * @param p a pointer to the output memory
208 * @param x the input unsigned integer
210 #define WB16(p, x) do { ((uint8_t*)(p))[1] = (uint8_t) (x); \
211 ((uint8_t*)(p))[0] = (uint8_t)((x)>>8); } while (0)
214 * Write a 16 bits unsigned integer to memory stored as little endian.
215 * @param p a pointer to the output memory
216 * @param x the input unsigned integer
218 #define WL16(p, x) do { ((uint8_t*)(p))[0] = (uint8_t) (x); \
219 ((uint8_t*)(p))[1] = (uint8_t)((x)>>8); } while (0)
222 * Write a 32 bits unsigned integer to memory stored as big endian.
223 * @param p a pointer to the output memory
224 * @param x the input unsigned integer
226 #define WB32(p, x) do { ((uint8_t*)(p))[3] = (uint8_t) (x); \
227 ((uint8_t*)(p))[2] = (uint8_t)((x)>>8); \
228 ((uint8_t*)(p))[1] = (uint8_t)((x)>>16); \
229 ((uint8_t*)(p))[0] = (uint8_t)((x)>>24); } while (0)
232 * Write a 32 bits unsigned integer to memory stored as little endian.
233 * @param p a pointer to the output memory
234 * @param x the input unsigned integer
236 #define WL32(p, x) do { ((uint8_t*)(p))[0] = (uint8_t) (x); \
237 ((uint8_t*)(p))[1] = (uint8_t)((x)>>8); \
238 ((uint8_t*)(p))[2] = (uint8_t)((x)>>16); \
239 ((uint8_t*)(p))[3] = (uint8_t)((x)>>24); } while (0)
242 * Write a 32 bits float to memory stored as big endian.
243 * @param p a pointer to the output memory
244 * @param x the input float
246 #define WBFL(p, x) WB32(p, (union { uint32_t u; float f; }) { .f = x }.u)
249 * Write a 32 bits float to memory stored as little endian.
250 * @param p a pointer to the output memory
251 * @param x the input float
253 #define WLFL(p, x) WL32(p, (union { uint32_t u; float f; }) { .f = x }.u)
255 /* Portability fixes for FreeBSD. */
257 #define LIBUSB_CLASS_APPLICATION 0xfe
258 #define libusb_has_capability(x) 0
259 #define libusb_handle_events_timeout_completed(ctx, tv, c) \
260 libusb_handle_events_timeout(ctx, tv)
263 /* Static definitions of structs ending with an all-zero entry are a
264 * problem when compiling with -Wmissing-field-initializers: GCC
265 * suppresses the warning only with { 0 }, clang wants { } */
269 #define ALL_ZERO { 0 }
273 #define SR_DRIVER_LIST_SECTION "__DATA,__sr_driver_list"
275 #define SR_DRIVER_LIST_SECTION "sr_driver_list"
279 * Register a list of hardware drivers.
281 * This macro can be used to register multiple hardware drivers to the library.
282 * This is useful when a driver supports multiple similar but slightly
283 * different devices that require different sr_dev_driver struct definitions.
285 * For registering only a single driver see SR_REGISTER_DEV_DRIVER().
289 * #define MY_DRIVER(_name) \
290 * &(struct sr_dev_driver){ \
295 * SR_REGISTER_DEV_DRIVER_LIST(my_driver_infos,
296 * MY_DRIVER("driver 1"),
297 * MY_DRIVER("driver 2"),
302 * @param name Name to use for the driver list identifier.
303 * @param ... Comma separated list of pointers to sr_dev_driver structs.
305 #define SR_REGISTER_DEV_DRIVER_LIST(name, ...) \
306 static const struct sr_dev_driver *name[] \
307 __attribute__((section (SR_DRIVER_LIST_SECTION), used, \
308 aligned(sizeof(struct sr_dev_driver *)))) \
314 * Register a hardware driver.
316 * This macro is used to register a hardware driver with the library. It has
317 * to be used in order to make the driver accessible to applications using the
320 * The macro invocation should be placed directly under the struct
321 * sr_dev_driver definition.
325 * static struct sr_dev_driver driver_info = {
329 * SR_REGISTER_DEV_DRIVER(driver_info);
332 * @param name Identifier name of sr_dev_driver struct to register.
334 #define SR_REGISTER_DEV_DRIVER(name) \
335 SR_REGISTER_DEV_DRIVER_LIST(name##_list, &name);
337 SR_API void sr_drivers_init(struct sr_context *context);
340 struct sr_dev_driver **driver_list;
341 #ifdef HAVE_LIBUSB_1_0
342 libusb_context *libusb_ctx;
344 sr_resource_open_callback resource_open_cb;
345 sr_resource_close_callback resource_close_cb;
346 sr_resource_read_callback resource_read_cb;
347 void *resource_cb_data;
350 /** Input module metadata keys. */
351 enum sr_input_meta_keys {
352 /** The input filename, if there is one. */
353 SR_INPUT_META_FILENAME = 0x01,
354 /** The input file's size in bytes. */
355 SR_INPUT_META_FILESIZE = 0x02,
356 /** The first 128 bytes of the file, provided as a GString. */
357 SR_INPUT_META_HEADER = 0x04,
359 /** The module cannot identify a file without this metadata. */
360 SR_INPUT_META_REQUIRED = 0x80,
363 /** Input (file) module struct. */
366 * A pointer to this input module's 'struct sr_input_module'.
368 const struct sr_input_module *module;
370 struct sr_dev_inst *sdi;
375 /** Input (file) module driver. */
376 struct sr_input_module {
378 * A unique ID for this input module, suitable for use in command-line
379 * clients, [a-z0-9-]. Must not be NULL.
384 * A unique name for this input module, suitable for use in GUI
385 * clients, can contain UTF-8. Must not be NULL.
390 * A short description of the input module. Must not be NULL.
392 * This can be displayed by frontends, e.g. when selecting the input
393 * module for saving a file.
398 * A NULL terminated array of strings containing a list of file name
399 * extensions typical for the input file format, or NULL if there is
400 * no typical extension for this file format.
402 const char *const *exts;
405 * Zero-terminated list of metadata items the module needs to be able
406 * to identify an input stream. Can be all-zero, if the module cannot
407 * identify streams at all, i.e. has to be forced into use.
409 * Each item is one of:
410 * SR_INPUT_META_FILENAME
411 * SR_INPUT_META_FILESIZE
412 * SR_INPUT_META_HEADER
414 * If the high bit (SR_INPUT META_REQUIRED) is set, the module cannot
415 * identify a stream without the given metadata.
417 const uint8_t metadata[8];
420 * Returns a NULL-terminated list of options this module can take.
421 * Can be NULL, if the module has no options.
423 const struct sr_option *(*options) (void);
426 * Check if this input module can load and parse the specified stream.
428 * @param[in] metadata Metadata the module can use to identify the stream.
429 * @param[out] confidence "Strength" of the detection.
430 * Specialized handlers can take precedence over generic/basic support.
432 * @retval SR_OK This module knows the format.
433 * @retval SR_ERR_NA There wasn't enough data for this module to
434 * positively identify the format.
435 * @retval SR_ERR_DATA This module knows the format, but cannot handle
436 * it. This means the stream is either corrupt, or indicates a
437 * feature that the module does not support.
438 * @retval SR_ERR This module does not know the format.
440 * Lower numeric values of 'confidence' mean that the input module
441 * stronger believes in its capability to handle this specific format.
442 * This way, multiple input modules can claim support for a format,
443 * and the application can pick the best match, or try fallbacks
444 * in case of errors. This approach also copes with formats that
445 * are unreliable to detect in the absence of magic signatures.
447 int (*format_match) (GHashTable *metadata, unsigned int *confidence);
450 * Initialize the input module.
452 * @retval SR_OK Success
453 * @retval other Negative error code.
455 int (*init) (struct sr_input *in, GHashTable *options);
458 * Send data to the specified input instance.
460 * When an input module instance is created with sr_input_new(), this
461 * function is used to feed data to the instance.
463 * As enough data gets fed into this function to completely populate
464 * the device instance associated with this input instance, this is
465 * guaranteed to return the moment it's ready. This gives the caller
466 * the chance to examine the device instance, attach session callbacks
469 * @retval SR_OK Success
470 * @retval other Negative error code.
472 int (*receive) (struct sr_input *in, GString *buf);
475 * Signal the input module no more data will come.
477 * This will cause the module to process any data it may have buffered.
478 * The SR_DF_END packet will also typically be sent at this time.
480 int (*end) (struct sr_input *in);
483 * Reset the input module's input handling structures.
485 * Causes the input module to reset its internal state so that we can
486 * re-send the input data from the beginning without having to
487 * re-create the entire input module.
489 * @retval SR_OK Success.
490 * @retval other Negative error code.
492 int (*reset) (struct sr_input *in);
495 * This function is called after the caller is finished using
496 * the input module, and can be used to free any internal
497 * resources the module may keep.
499 * This function is optional.
501 * @retval SR_OK Success
502 * @retval other Negative error code.
504 void (*cleanup) (struct sr_input *in);
507 /** Output module instance. */
509 /** A pointer to this output's module. */
510 const struct sr_output_module *module;
513 * The device for which this output module is creating output. This
514 * can be used by the module to find out channel names and numbers.
516 const struct sr_dev_inst *sdi;
519 * The name of the file that the data should be written to.
521 const char *filename;
524 * A generic pointer which can be used by the module to keep internal
525 * state between calls into its callback functions.
527 * For example, the module might store a pointer to a chunk of output
528 * there, and only flush it when it reaches a certain size.
533 /** Output module driver. */
534 struct sr_output_module {
536 * A unique ID for this output module, suitable for use in command-line
537 * clients, [a-z0-9-]. Must not be NULL.
542 * A unique name for this output module, suitable for use in GUI
543 * clients, can contain UTF-8. Must not be NULL.
548 * A short description of the output module. Must not be NULL.
550 * This can be displayed by frontends, e.g. when selecting the output
551 * module for saving a file.
556 * A NULL terminated array of strings containing a list of file name
557 * extensions typical for the input file format, or NULL if there is
558 * no typical extension for this file format.
560 const char *const *exts;
563 * Bitfield containing flags that describe certain properties
564 * this output module may or may not have.
565 * @see sr_output_flags
567 const uint64_t flags;
570 * Returns a NULL-terminated list of options this module can take.
571 * Can be NULL, if the module has no options.
573 const struct sr_option *(*options) (void);
576 * This function is called once, at the beginning of an output stream.
578 * The device struct will be available in the output struct passed in,
579 * as well as the param field -- which may be NULL or an empty string,
580 * if no parameter was passed.
582 * The module can use this to initialize itself, create a struct for
583 * keeping state and storing it in the <code>internal</code> field.
585 * @param o Pointer to the respective 'struct sr_output'.
587 * @retval SR_OK Success
588 * @retval other Negative error code.
590 int (*init) (struct sr_output *o, GHashTable *options);
593 * This function is passed a copy of every packet in the data feed.
594 * Any output generated by the output module in response to the
595 * packet should be returned in a newly allocated GString
596 * <code>out</code>, which will be freed by the caller.
598 * Packets not of interest to the output module can just be ignored,
599 * and the <code>out</code> parameter set to NULL.
601 * @param o Pointer to the respective 'struct sr_output'.
602 * @param sdi The device instance that generated the packet.
603 * @param packet The complete packet.
604 * @param out A pointer where a GString * should be stored if
605 * the module generates output, or NULL if not.
607 * @retval SR_OK Success
608 * @retval other Negative error code.
610 int (*receive) (const struct sr_output *o,
611 const struct sr_datafeed_packet *packet, GString **out);
614 * This function is called after the caller is finished using
615 * the output module, and can be used to free any internal
616 * resources the module may keep.
618 * @retval SR_OK Success
619 * @retval other Negative error code.
621 int (*cleanup) (struct sr_output *o);
624 /** Transform module instance. */
625 struct sr_transform {
626 /** A pointer to this transform's module. */
627 const struct sr_transform_module *module;
630 * The device for which this transform module is used. This
631 * can be used by the module to find out channel names and numbers.
633 const struct sr_dev_inst *sdi;
636 * A generic pointer which can be used by the module to keep internal
637 * state between calls into its callback functions.
642 struct sr_transform_module {
644 * A unique ID for this transform module, suitable for use in
645 * command-line clients, [a-z0-9-]. Must not be NULL.
650 * A unique name for this transform module, suitable for use in GUI
651 * clients, can contain UTF-8. Must not be NULL.
656 * A short description of the transform module. Must not be NULL.
658 * This can be displayed by frontends, e.g. when selecting
659 * which transform module(s) to add.
664 * Returns a NULL-terminated list of options this transform module
665 * can take. Can be NULL, if the transform module has no options.
667 const struct sr_option *(*options) (void);
670 * This function is called once, at the beginning of a stream.
672 * @param t Pointer to the respective 'struct sr_transform'.
673 * @param options Hash table of options for this transform module.
674 * Can be NULL if no options are to be used.
676 * @retval SR_OK Success
677 * @retval other Negative error code.
679 int (*init) (struct sr_transform *t, GHashTable *options);
682 * This function is passed a pointer to every packet in the data feed.
684 * It can either return (in packet_out) a pointer to another packet
685 * (possibly the exact same packet it got as input), or NULL.
687 * @param t Pointer to the respective 'struct sr_transform'.
688 * @param packet_in Pointer to a datafeed packet.
689 * @param packet_out Pointer to the resulting datafeed packet after
690 * this function was run. If NULL, the transform
691 * module intentionally didn't output a new packet.
693 * @retval SR_OK Success
694 * @retval other Negative error code.
696 int (*receive) (const struct sr_transform *t,
697 struct sr_datafeed_packet *packet_in,
698 struct sr_datafeed_packet **packet_out);
701 * This function is called after the caller is finished using
702 * the transform module, and can be used to free any internal
703 * resources the module may keep.
705 * @retval SR_OK Success
706 * @retval other Negative error code.
708 int (*cleanup) (struct sr_transform *t);
711 #ifdef HAVE_LIBUSB_1_0
712 /** USB device instance */
713 struct sr_usb_dev_inst {
716 /** Device address on USB bus */
718 /** libusb device handle */
719 struct libusb_device_handle *devhdl;
723 #ifdef HAVE_LIBSERIALPORT
724 struct sr_serial_dev_inst {
725 /** Port name, e.g. '/dev/tty42'. */
727 /** Comm params for serial_set_paramstr(). */
729 /** libserialport port handle */
730 struct sp_port *data;
734 struct sr_usbtmc_dev_inst {
739 /* Private driver context. */
741 /** sigrok context */
742 struct sr_context *sr_ctx;
746 /*--- log.c -----------------------------------------------------------------*/
748 #if defined(G_OS_WIN32) && (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 4))
750 * On MinGW, we need to specify the gnu_printf format flavor or GCC
751 * will assume non-standard Microsoft printf syntax.
753 SR_PRIV int sr_log(int loglevel, const char *format, ...)
754 __attribute__((__format__ (__gnu_printf__, 2, 3)));
756 SR_PRIV int sr_log(int loglevel, const char *format, ...) G_GNUC_PRINTF(2, 3);
759 /* Message logging helpers with subsystem-specific prefix string. */
760 #define sr_spew(...) sr_log(SR_LOG_SPEW, LOG_PREFIX ": " __VA_ARGS__)
761 #define sr_dbg(...) sr_log(SR_LOG_DBG, LOG_PREFIX ": " __VA_ARGS__)
762 #define sr_info(...) sr_log(SR_LOG_INFO, LOG_PREFIX ": " __VA_ARGS__)
763 #define sr_warn(...) sr_log(SR_LOG_WARN, LOG_PREFIX ": " __VA_ARGS__)
764 #define sr_err(...) sr_log(SR_LOG_ERR, LOG_PREFIX ": " __VA_ARGS__)
766 /*--- device.c --------------------------------------------------------------*/
768 /** Scan options supported by a driver. */
769 #define SR_CONF_SCAN_OPTIONS 0x7FFF0000
771 /** Device options for a particular device. */
772 #define SR_CONF_DEVICE_OPTIONS 0x7FFF0001
774 /** Mask for separating config keys from capabilities. */
775 #define SR_CONF_MASK 0x1fffffff
777 /** Values for the changes argument of sr_dev_driver.config_channel_set. */
779 /** The enabled state of the channel has been changed. */
780 SR_CHANNEL_SET_ENABLED = 1 << 0,
783 SR_PRIV struct sr_channel *sr_channel_new(struct sr_dev_inst *sdi,
784 int index, int type, gboolean enabled, const char *name);
785 SR_PRIV struct sr_channel *sr_next_enabled_channel(const struct sr_dev_inst *sdi,
786 struct sr_channel *cur_channel);
788 /** Device instance data */
790 /** Device driver. */
791 struct sr_dev_driver *driver;
792 /** Device instance status. SR_ST_NOT_FOUND, etc. */
794 /** Device instance type. SR_INST_USB, etc. */
796 /** Device vendor. */
800 /** Device version. */
802 /** Serial number. */
804 /** Connection string to uniquely identify devices. */
806 /** List of channels. */
808 /** List of sr_channel_group structs */
809 GSList *channel_groups;
810 /** Device instance connection data (used?) */
812 /** Device instance private data (used?) */
814 /** Session to which this device is currently assigned. */
815 struct sr_session *session;
818 /* Generic device instances */
819 SR_PRIV void sr_dev_inst_free(struct sr_dev_inst *sdi);
821 #ifdef HAVE_LIBUSB_1_0
822 /* USB-specific instances */
823 SR_PRIV struct sr_usb_dev_inst *sr_usb_dev_inst_new(uint8_t bus,
824 uint8_t address, struct libusb_device_handle *hdl);
825 SR_PRIV void sr_usb_dev_inst_free(struct sr_usb_dev_inst *usb);
828 #ifdef HAVE_LIBSERIALPORT
829 /* Serial-specific instances */
830 SR_PRIV struct sr_serial_dev_inst *sr_serial_dev_inst_new(const char *port,
831 const char *serialcomm);
832 SR_PRIV void sr_serial_dev_inst_free(struct sr_serial_dev_inst *serial);
835 /* USBTMC-specific instances */
836 SR_PRIV struct sr_usbtmc_dev_inst *sr_usbtmc_dev_inst_new(const char *device);
837 SR_PRIV void sr_usbtmc_dev_inst_free(struct sr_usbtmc_dev_inst *usbtmc);
839 /*--- hwdriver.c ------------------------------------------------------------*/
841 SR_PRIV const GVariantType *sr_variant_type_get(int datatype);
842 SR_PRIV int sr_variant_type_check(uint32_t key, GVariant *data);
843 SR_PRIV void sr_hw_cleanup_all(const struct sr_context *ctx);
844 SR_PRIV struct sr_config *sr_config_new(uint32_t key, GVariant *data);
845 SR_PRIV void sr_config_free(struct sr_config *src);
846 SR_PRIV int sr_dev_acquisition_start(struct sr_dev_inst *sdi);
847 SR_PRIV int sr_dev_acquisition_stop(struct sr_dev_inst *sdi);
849 /*--- session.c -------------------------------------------------------------*/
852 /** Context this session exists in. */
853 struct sr_context *ctx;
854 /** List of struct sr_dev_inst pointers. */
856 /** List of struct sr_dev_inst pointers owned by this session. */
858 /** List of struct datafeed_callback pointers. */
859 GSList *datafeed_callbacks;
861 struct sr_trigger *trigger;
863 /** Callback to invoke on session stop. */
864 sr_session_stopped_callback stopped_callback;
865 /** User data to be passed to the session stop callback. */
866 void *stopped_cb_data;
868 /** Mutex protecting the main context pointer. */
870 /** Context of the session main loop. */
871 GMainContext *main_context;
873 /** Registered event sources for this session. */
874 GHashTable *event_sources;
875 /** Session main loop. */
876 GMainLoop *main_loop;
877 /** ID of idle source for dispatching the session stop notification. */
878 unsigned int stop_check_id;
879 /** Whether the session has been started. */
883 SR_PRIV int sr_session_source_add_internal(struct sr_session *session,
884 void *key, GSource *source);
885 SR_PRIV int sr_session_source_remove_internal(struct sr_session *session,
887 SR_PRIV int sr_session_source_destroyed(struct sr_session *session,
888 void *key, GSource *source);
889 SR_PRIV int sr_session_fd_source_add(struct sr_session *session,
890 void *key, gintptr fd, int events, int timeout,
891 sr_receive_data_callback cb, void *cb_data);
893 SR_PRIV int sr_session_source_add(struct sr_session *session, int fd,
894 int events, int timeout, sr_receive_data_callback cb, void *cb_data);
895 SR_PRIV int sr_session_source_add_pollfd(struct sr_session *session,
896 GPollFD *pollfd, int timeout, sr_receive_data_callback cb,
898 SR_PRIV int sr_session_source_add_channel(struct sr_session *session,
899 GIOChannel *channel, int events, int timeout,
900 sr_receive_data_callback cb, void *cb_data);
901 SR_PRIV int sr_session_source_remove(struct sr_session *session, int fd);
902 SR_PRIV int sr_session_source_remove_pollfd(struct sr_session *session,
904 SR_PRIV int sr_session_source_remove_channel(struct sr_session *session,
905 GIOChannel *channel);
907 SR_PRIV int sr_session_send(const struct sr_dev_inst *sdi,
908 const struct sr_datafeed_packet *packet);
909 SR_PRIV int sr_sessionfile_check(const char *filename);
910 SR_PRIV struct sr_dev_inst *sr_session_prepare_sdi(const char *filename,
911 struct sr_session **session);
912 SR_PRIV int sr_packet_copy(const struct sr_datafeed_packet *packet,
913 struct sr_datafeed_packet **copy);
914 SR_PRIV void sr_packet_free(struct sr_datafeed_packet *packet);
916 /*--- session_file.c --------------------------------------------------------*/
918 #if !HAVE_ZIP_DISCARD
919 /* Replace zip_discard() if not available. */
920 #define zip_discard(zip) sr_zip_discard(zip)
921 SR_PRIV void sr_zip_discard(struct zip *archive);
924 SR_PRIV GKeyFile *sr_sessionfile_read_metadata(struct zip *archive,
925 const struct zip_stat *entry);
927 /*--- analog.c --------------------------------------------------------------*/
929 SR_PRIV int sr_analog_init(struct sr_datafeed_analog *analog,
930 struct sr_analog_encoding *encoding,
931 struct sr_analog_meaning *meaning,
932 struct sr_analog_spec *spec,
935 /*--- std.c -----------------------------------------------------------------*/
937 typedef int (*dev_close_callback)(struct sr_dev_inst *sdi);
938 typedef void (*std_dev_clear_callback)(void *priv);
940 SR_PRIV int std_init(struct sr_dev_driver *di, struct sr_context *sr_ctx);
941 SR_PRIV int std_cleanup(const struct sr_dev_driver *di);
942 SR_PRIV int std_dummy_dev_open(struct sr_dev_inst *sdi);
943 SR_PRIV int std_dummy_dev_close(struct sr_dev_inst *sdi);
944 SR_PRIV int std_dummy_dev_acquisition_start(const struct sr_dev_inst *sdi);
945 SR_PRIV int std_dummy_dev_acquisition_stop(struct sr_dev_inst *sdi);
946 #ifdef HAVE_LIBSERIALPORT
947 SR_PRIV int std_serial_dev_open(struct sr_dev_inst *sdi);
948 SR_PRIV int std_serial_dev_acquisition_stop(struct sr_dev_inst *sdi);
950 SR_PRIV int std_session_send_df_header(const struct sr_dev_inst *sdi);
951 SR_PRIV int std_session_send_df_end(const struct sr_dev_inst *sdi);
952 SR_PRIV int std_session_send_frame_begin(const struct sr_dev_inst *sdi);
953 SR_PRIV int std_session_send_frame_end(const struct sr_dev_inst *sdi);
954 SR_PRIV int std_dev_clear_with_callback(const struct sr_dev_driver *driver,
955 std_dev_clear_callback clear_private);
956 SR_PRIV int std_dev_clear(const struct sr_dev_driver *driver);
957 SR_PRIV GSList *std_dev_list(const struct sr_dev_driver *di);
958 SR_PRIV int std_serial_dev_close(struct sr_dev_inst *sdi);
959 SR_PRIV GSList *std_scan_complete(struct sr_dev_driver *di, GSList *devices);
961 SR_PRIV int std_opts_config_list(uint32_t key, GVariant **data,
962 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg,
963 const uint32_t scanopts[], size_t scansize, const uint32_t drvopts[],
964 size_t drvsize, const uint32_t devopts[], size_t devsize);
966 #define STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts) \
967 std_opts_config_list(key, data, sdi, cg, ARRAY_AND_SIZE(scanopts), \
968 ARRAY_AND_SIZE(drvopts), ARRAY_AND_SIZE(devopts))
970 SR_PRIV GVariant *std_gvar_tuple_array(const uint64_t a[][2], unsigned int n);
971 SR_PRIV GVariant *std_gvar_tuple_rational(const struct sr_rational *r, unsigned int n);
972 SR_PRIV GVariant *std_gvar_samplerates(const uint64_t samplerates[], unsigned int n);
973 SR_PRIV GVariant *std_gvar_samplerates_steps(const uint64_t samplerates[], unsigned int n);
974 SR_PRIV GVariant *std_gvar_min_max_step(double min, double max, double step);
975 SR_PRIV GVariant *std_gvar_min_max_step_array(const double a[3]);
976 SR_PRIV GVariant *std_gvar_min_max_step_thresholds(const double dmin, const double dmax, const double dstep);
978 SR_PRIV GVariant *std_gvar_tuple_u64(uint64_t low, uint64_t high);
979 SR_PRIV GVariant *std_gvar_tuple_double(double low, double high);
981 SR_PRIV GVariant *std_gvar_array_i32(const int32_t *a, unsigned int n);
982 SR_PRIV GVariant *std_gvar_array_u32(const uint32_t *a, unsigned int n);
983 SR_PRIV GVariant *std_gvar_array_u64(const uint64_t *a, unsigned int n);
984 SR_PRIV GVariant *std_gvar_array_str(const char *a[], unsigned int n);
986 SR_PRIV GVariant *std_gvar_thresholds(const double a[][2], unsigned int n);
988 SR_PRIV int std_str_idx(GVariant *data, const char *a[], unsigned int n);
989 SR_PRIV int std_u64_idx(GVariant *data, const uint64_t a[], unsigned int n);
990 SR_PRIV int std_u8_idx(GVariant *data, const uint8_t a[], unsigned int n);
992 SR_PRIV int std_str_idx_s(const char *s, const char *a[], unsigned int n);
993 SR_PRIV int std_u8_idx_s(uint8_t b, const uint8_t a[], unsigned int n);
995 SR_PRIV int std_u64_tuple_idx(GVariant *data, const uint64_t a[][2], unsigned int n);
996 SR_PRIV int std_double_tuple_idx(GVariant *data, const double a[][2], unsigned int n);
997 SR_PRIV int std_double_tuple_idx_d0(const double d, const double a[][2], unsigned int n);
999 SR_PRIV int std_cg_idx(const struct sr_channel_group *cg, struct sr_channel_group *a[], unsigned int n);
1001 /*--- resource.c ------------------------------------------------------------*/
1003 SR_PRIV int64_t sr_file_get_size(FILE *file);
1005 SR_PRIV int sr_resource_open(struct sr_context *ctx,
1006 struct sr_resource *res, int type, const char *name)
1007 G_GNUC_WARN_UNUSED_RESULT;
1008 SR_PRIV int sr_resource_close(struct sr_context *ctx,
1009 struct sr_resource *res);
1010 SR_PRIV gssize sr_resource_read(struct sr_context *ctx,
1011 const struct sr_resource *res, void *buf, size_t count)
1012 G_GNUC_WARN_UNUSED_RESULT;
1013 SR_PRIV void *sr_resource_load(struct sr_context *ctx, int type,
1014 const char *name, size_t *size, size_t max_size)
1015 G_GNUC_MALLOC G_GNUC_WARN_UNUSED_RESULT;
1017 /*--- strutil.c -------------------------------------------------------------*/
1019 SR_PRIV int sr_atol(const char *str, long *ret);
1020 SR_PRIV int sr_atoi(const char *str, int *ret);
1021 SR_PRIV int sr_atod(const char *str, double *ret);
1022 SR_PRIV int sr_atof(const char *str, float *ret);
1023 SR_PRIV int sr_atod_ascii(const char *str, double *ret);
1024 SR_PRIV int sr_atof_ascii(const char *str, float *ret);
1026 /*--- soft-trigger.c --------------------------------------------------------*/
1028 struct soft_trigger_logic {
1029 const struct sr_dev_inst *sdi;
1030 const struct sr_trigger *trigger;
1034 uint8_t *prev_sample;
1035 uint8_t *pre_trigger_buffer;
1036 uint8_t *pre_trigger_head;
1037 int pre_trigger_size;
1038 int pre_trigger_fill;
1041 SR_PRIV struct soft_trigger_logic *soft_trigger_logic_new(
1042 const struct sr_dev_inst *sdi, struct sr_trigger *trigger,
1043 int pre_trigger_samples);
1044 SR_PRIV void soft_trigger_logic_free(struct soft_trigger_logic *st);
1045 SR_PRIV int soft_trigger_logic_check(struct soft_trigger_logic *st, uint8_t *buf,
1046 int len, int *pre_trigger_samples);
1048 /*--- hardware/serial.c -----------------------------------------------------*/
1050 #ifdef HAVE_LIBSERIALPORT
1056 typedef gboolean (*packet_valid_callback)(const uint8_t *buf);
1058 SR_PRIV int serial_open(struct sr_serial_dev_inst *serial, int flags);
1059 SR_PRIV int serial_close(struct sr_serial_dev_inst *serial);
1060 SR_PRIV int serial_flush(struct sr_serial_dev_inst *serial);
1061 SR_PRIV int serial_drain(struct sr_serial_dev_inst *serial);
1062 SR_PRIV int serial_write_blocking(struct sr_serial_dev_inst *serial,
1063 const void *buf, size_t count, unsigned int timeout_ms);
1064 SR_PRIV int serial_write_nonblocking(struct sr_serial_dev_inst *serial,
1065 const void *buf, size_t count);
1066 SR_PRIV int serial_read_blocking(struct sr_serial_dev_inst *serial, void *buf,
1067 size_t count, unsigned int timeout_ms);
1068 SR_PRIV int serial_read_nonblocking(struct sr_serial_dev_inst *serial, void *buf,
1070 SR_PRIV int serial_set_params(struct sr_serial_dev_inst *serial, int baudrate,
1071 int bits, int parity, int stopbits, int flowcontrol, int rts, int dtr);
1072 SR_PRIV int serial_set_paramstr(struct sr_serial_dev_inst *serial,
1073 const char *paramstr);
1074 SR_PRIV int serial_readline(struct sr_serial_dev_inst *serial, char **buf,
1075 int *buflen, gint64 timeout_ms);
1076 SR_PRIV int serial_stream_detect(struct sr_serial_dev_inst *serial,
1077 uint8_t *buf, size_t *buflen,
1079 packet_valid_callback is_valid,
1080 uint64_t timeout_ms, int baudrate);
1081 SR_PRIV int sr_serial_extract_options(GSList *options, const char **serial_device,
1082 const char **serial_options);
1083 SR_PRIV int serial_source_add(struct sr_session *session,
1084 struct sr_serial_dev_inst *serial, int events, int timeout,
1085 sr_receive_data_callback cb, void *cb_data);
1086 SR_PRIV int serial_source_remove(struct sr_session *session,
1087 struct sr_serial_dev_inst *serial);
1088 SR_PRIV GSList *sr_serial_find_usb(uint16_t vendor_id, uint16_t product_id);
1089 SR_PRIV int serial_timeout(struct sr_serial_dev_inst *port, int num_bytes);
1092 /*--- hardware/ezusb.c ------------------------------------------------------*/
1094 #ifdef HAVE_LIBUSB_1_0
1095 SR_PRIV int ezusb_reset(struct libusb_device_handle *hdl, int set_clear);
1096 SR_PRIV int ezusb_install_firmware(struct sr_context *ctx, libusb_device_handle *hdl,
1098 SR_PRIV int ezusb_upload_firmware(struct sr_context *ctx, libusb_device *dev,
1099 int configuration, const char *name);
1102 /*--- hardware/usb.c --------------------------------------------------------*/
1104 #ifdef HAVE_LIBUSB_1_0
1105 SR_PRIV GSList *sr_usb_find(libusb_context *usb_ctx, const char *conn);
1106 SR_PRIV int sr_usb_open(libusb_context *usb_ctx, struct sr_usb_dev_inst *usb);
1107 SR_PRIV void sr_usb_close(struct sr_usb_dev_inst *usb);
1108 SR_PRIV int usb_source_add(struct sr_session *session, struct sr_context *ctx,
1109 int timeout, sr_receive_data_callback cb, void *cb_data);
1110 SR_PRIV int usb_source_remove(struct sr_session *session, struct sr_context *ctx);
1111 SR_PRIV int usb_get_port_path(libusb_device *dev, char *path, int path_len);
1112 SR_PRIV gboolean usb_match_manuf_prod(libusb_device *dev,
1113 const char *manufacturer, const char *product);
1117 /*--- modbus/modbus.c -------------------------------------------------------*/
1119 struct sr_modbus_dev_inst {
1123 GSList *(*scan)(int modbusaddr);
1124 int (*dev_inst_new)(void *priv, const char *resource,
1125 char **params, const char *serialcomm, int modbusaddr);
1126 int (*open)(void *priv);
1127 int (*source_add)(struct sr_session *session, void *priv, int events,
1128 int timeout, sr_receive_data_callback cb, void *cb_data);
1129 int (*source_remove)(struct sr_session *session, void *priv);
1130 int (*send)(void *priv, const uint8_t *buffer, int buffer_size);
1131 int (*read_begin)(void *priv, uint8_t *function_code);
1132 int (*read_data)(void *priv, uint8_t *buf, int maxlen);
1133 int (*read_end)(void *priv);
1134 int (*close)(void *priv);
1135 void (*free)(void *priv);
1136 unsigned int read_timeout_ms;
1140 SR_PRIV GSList *sr_modbus_scan(struct drv_context *drvc, GSList *options,
1141 struct sr_dev_inst *(*probe_device)(struct sr_modbus_dev_inst *modbus));
1142 SR_PRIV struct sr_modbus_dev_inst *modbus_dev_inst_new(const char *resource,
1143 const char *serialcomm, int modbusaddr);
1144 SR_PRIV int sr_modbus_open(struct sr_modbus_dev_inst *modbus);
1145 SR_PRIV int sr_modbus_source_add(struct sr_session *session,
1146 struct sr_modbus_dev_inst *modbus, int events, int timeout,
1147 sr_receive_data_callback cb, void *cb_data);
1148 SR_PRIV int sr_modbus_source_remove(struct sr_session *session,
1149 struct sr_modbus_dev_inst *modbus);
1150 SR_PRIV int sr_modbus_request(struct sr_modbus_dev_inst *modbus,
1151 uint8_t *request, int request_size);
1152 SR_PRIV int sr_modbus_reply(struct sr_modbus_dev_inst *modbus,
1153 uint8_t *reply, int reply_size);
1154 SR_PRIV int sr_modbus_request_reply(struct sr_modbus_dev_inst *modbus,
1155 uint8_t *request, int request_size,
1156 uint8_t *reply, int reply_size);
1157 SR_PRIV int sr_modbus_read_coils(struct sr_modbus_dev_inst *modbus,
1158 int address, int nb_coils, uint8_t *coils);
1159 SR_PRIV int sr_modbus_read_holding_registers(struct sr_modbus_dev_inst *modbus,
1160 int address, int nb_registers,
1161 uint16_t *registers);
1162 SR_PRIV int sr_modbus_write_coil(struct sr_modbus_dev_inst *modbus,
1163 int address, int value);
1164 SR_PRIV int sr_modbus_write_multiple_registers(struct sr_modbus_dev_inst*modbus,
1165 int address, int nb_registers,
1166 uint16_t *registers);
1167 SR_PRIV int sr_modbus_close(struct sr_modbus_dev_inst *modbus);
1168 SR_PRIV void sr_modbus_free(struct sr_modbus_dev_inst *modbus);
1170 /*--- hardware/dmm/es519xx.c ------------------------------------------------*/
1173 * All 11-byte es519xx chips repeat each block twice for each conversion cycle
1174 * so always read 2 blocks at a time.
1176 #define ES519XX_11B_PACKET_SIZE (11 * 2)
1177 #define ES519XX_14B_PACKET_SIZE 14
1179 struct es519xx_info {
1180 gboolean is_judge, is_voltage, is_auto, is_micro, is_current;
1181 gboolean is_milli, is_resistance, is_continuity, is_diode;
1182 gboolean is_frequency, is_rpm, is_capacitance, is_duty_cycle;
1183 gboolean is_temperature, is_celsius, is_fahrenheit;
1184 gboolean is_adp0, is_adp1, is_adp2, is_adp3;
1185 gboolean is_sign, is_batt, is_ol, is_pmax, is_pmin, is_apo;
1186 gboolean is_dc, is_ac, is_vahz, is_min, is_max, is_rel, is_hold;
1187 gboolean is_digit4, is_ul, is_vasel, is_vbar, is_lpf1, is_lpf0, is_rmr;
1190 gboolean alt_functions, fivedigits, clampmeter, selectable_lpf;
1194 SR_PRIV gboolean sr_es519xx_2400_11b_packet_valid(const uint8_t *buf);
1195 SR_PRIV int sr_es519xx_2400_11b_parse(const uint8_t *buf, float *floatval,
1196 struct sr_datafeed_analog *analog, void *info);
1197 SR_PRIV gboolean sr_es519xx_2400_11b_altfn_packet_valid(const uint8_t *buf);
1198 SR_PRIV int sr_es519xx_2400_11b_altfn_parse(const uint8_t *buf,
1199 float *floatval, struct sr_datafeed_analog *analog, void *info);
1200 SR_PRIV gboolean sr_es519xx_19200_11b_5digits_packet_valid(const uint8_t *buf);
1201 SR_PRIV int sr_es519xx_19200_11b_5digits_parse(const uint8_t *buf,
1202 float *floatval, struct sr_datafeed_analog *analog, void *info);
1203 SR_PRIV gboolean sr_es519xx_19200_11b_clamp_packet_valid(const uint8_t *buf);
1204 SR_PRIV int sr_es519xx_19200_11b_clamp_parse(const uint8_t *buf,
1205 float *floatval, struct sr_datafeed_analog *analog, void *info);
1206 SR_PRIV gboolean sr_es519xx_19200_11b_packet_valid(const uint8_t *buf);
1207 SR_PRIV int sr_es519xx_19200_11b_parse(const uint8_t *buf, float *floatval,
1208 struct sr_datafeed_analog *analog, void *info);
1209 SR_PRIV gboolean sr_es519xx_19200_14b_packet_valid(const uint8_t *buf);
1210 SR_PRIV int sr_es519xx_19200_14b_parse(const uint8_t *buf, float *floatval,
1211 struct sr_datafeed_analog *analog, void *info);
1212 SR_PRIV gboolean sr_es519xx_19200_14b_sel_lpf_packet_valid(const uint8_t *buf);
1213 SR_PRIV int sr_es519xx_19200_14b_sel_lpf_parse(const uint8_t *buf,
1214 float *floatval, struct sr_datafeed_analog *analog, void *info);
1216 /*--- hardware/dmm/fs9922.c -------------------------------------------------*/
1218 #define FS9922_PACKET_SIZE 14
1220 struct fs9922_info {
1221 gboolean is_auto, is_dc, is_ac, is_rel, is_hold, is_bpn, is_z1, is_z2;
1222 gboolean is_max, is_min, is_apo, is_bat, is_nano, is_z3, is_micro;
1223 gboolean is_milli, is_kilo, is_mega, is_beep, is_diode, is_percent;
1224 gboolean is_z4, is_volt, is_ampere, is_ohm, is_hfe, is_hertz, is_farad;
1225 gboolean is_celsius, is_fahrenheit;
1226 int bargraph_sign, bargraph_value;
1229 SR_PRIV gboolean sr_fs9922_packet_valid(const uint8_t *buf);
1230 SR_PRIV int sr_fs9922_parse(const uint8_t *buf, float *floatval,
1231 struct sr_datafeed_analog *analog, void *info);
1232 SR_PRIV void sr_fs9922_z1_diode(struct sr_datafeed_analog *analog, void *info);
1234 /*--- hardware/dmm/fs9721.c -------------------------------------------------*/
1236 #define FS9721_PACKET_SIZE 14
1238 struct fs9721_info {
1239 gboolean is_ac, is_dc, is_auto, is_rs232, is_micro, is_nano, is_kilo;
1240 gboolean is_diode, is_milli, is_percent, is_mega, is_beep, is_farad;
1241 gboolean is_ohm, is_rel, is_hold, is_ampere, is_volt, is_hz, is_bat;
1242 gboolean is_c2c1_11, is_c2c1_10, is_c2c1_01, is_c2c1_00, is_sign;
1245 SR_PRIV gboolean sr_fs9721_packet_valid(const uint8_t *buf);
1246 SR_PRIV int sr_fs9721_parse(const uint8_t *buf, float *floatval,
1247 struct sr_datafeed_analog *analog, void *info);
1248 SR_PRIV void sr_fs9721_00_temp_c(struct sr_datafeed_analog *analog, void *info);
1249 SR_PRIV void sr_fs9721_01_temp_c(struct sr_datafeed_analog *analog, void *info);
1250 SR_PRIV void sr_fs9721_10_temp_c(struct sr_datafeed_analog *analog, void *info);
1251 SR_PRIV void sr_fs9721_01_10_temp_f_c(struct sr_datafeed_analog *analog, void *info);
1252 SR_PRIV void sr_fs9721_max_c_min(struct sr_datafeed_analog *analog, void *info);
1254 /*--- hardware/dmm/ms8250d.c ------------------------------------------------*/
1256 #define MS8250D_PACKET_SIZE 18
1258 struct ms8250d_info {
1259 gboolean is_ac, is_dc, is_auto, is_rs232, is_micro, is_nano, is_kilo;
1260 gboolean is_diode, is_milli, is_percent, is_mega, is_beep, is_farad;
1261 gboolean is_ohm, is_rel, is_hold, is_ampere, is_volt, is_hz, is_bat;
1262 gboolean is_ncv, is_min, is_max, is_sign, is_autotimer;
1265 SR_PRIV gboolean sr_ms8250d_packet_valid(const uint8_t *buf);
1266 SR_PRIV int sr_ms8250d_parse(const uint8_t *buf, float *floatval,
1267 struct sr_datafeed_analog *analog, void *info);
1269 /*--- hardware/dmm/dtm0660.c ------------------------------------------------*/
1271 #define DTM0660_PACKET_SIZE 15
1273 struct dtm0660_info {
1274 gboolean is_ac, is_dc, is_auto, is_rs232, is_micro, is_nano, is_kilo;
1275 gboolean is_diode, is_milli, is_percent, is_mega, is_beep, is_farad;
1276 gboolean is_ohm, is_rel, is_hold, is_ampere, is_volt, is_hz, is_bat;
1277 gboolean is_degf, is_degc, is_c2c1_01, is_c2c1_00, is_apo, is_min;
1278 gboolean is_minmax, is_max, is_sign;
1281 SR_PRIV gboolean sr_dtm0660_packet_valid(const uint8_t *buf);
1282 SR_PRIV int sr_dtm0660_parse(const uint8_t *buf, float *floatval,
1283 struct sr_datafeed_analog *analog, void *info);
1285 /*--- hardware/dmm/m2110.c --------------------------------------------------*/
1287 #define BBCGM_M2110_PACKET_SIZE 9
1289 /* Dummy info struct. The parser does not use it. */
1290 struct m2110_info { int dummy; };
1292 SR_PRIV gboolean sr_m2110_packet_valid(const uint8_t *buf);
1293 SR_PRIV int sr_m2110_parse(const uint8_t *buf, float *floatval,
1294 struct sr_datafeed_analog *analog, void *info);
1296 /*--- hardware/dmm/metex14.c ------------------------------------------------*/
1298 #define METEX14_PACKET_SIZE 14
1300 struct metex14_info {
1302 gboolean is_ac, is_dc, is_resistance, is_capacity, is_temperature;
1303 gboolean is_diode, is_frequency, is_ampere, is_volt, is_farad;
1304 gboolean is_hertz, is_ohm, is_celsius, is_fahrenheit, is_watt;
1305 gboolean is_pico, is_nano, is_micro, is_milli, is_kilo, is_mega;
1306 gboolean is_gain, is_decibel, is_power, is_decibel_mw, is_power_factor;
1307 gboolean is_hfe, is_unitless, is_logic, is_min, is_max, is_avg;
1310 #ifdef HAVE_LIBSERIALPORT
1311 SR_PRIV int sr_metex14_packet_request(struct sr_serial_dev_inst *serial);
1313 SR_PRIV gboolean sr_metex14_packet_valid(const uint8_t *buf);
1314 SR_PRIV int sr_metex14_parse(const uint8_t *buf, float *floatval,
1315 struct sr_datafeed_analog *analog, void *info);
1316 SR_PRIV gboolean sr_metex14_4packets_valid(const uint8_t *buf);
1317 SR_PRIV int sr_metex14_4packets_parse(const uint8_t *buf, float *floatval,
1318 struct sr_datafeed_analog *analog, void *info);
1320 /*--- hardware/dmm/rs9lcd.c -------------------------------------------------*/
1322 #define RS9LCD_PACKET_SIZE 9
1324 /* Dummy info struct. The parser does not use it. */
1325 struct rs9lcd_info { int dummy; };
1327 SR_PRIV gboolean sr_rs9lcd_packet_valid(const uint8_t *buf);
1328 SR_PRIV int sr_rs9lcd_parse(const uint8_t *buf, float *floatval,
1329 struct sr_datafeed_analog *analog, void *info);
1331 /*--- hardware/dmm/bm25x.c --------------------------------------------------*/
1333 #define BRYMEN_BM25X_PACKET_SIZE 15
1335 /* Dummy info struct. The parser does not use it. */
1336 struct bm25x_info { int dummy; };
1338 SR_PRIV gboolean sr_brymen_bm25x_packet_valid(const uint8_t *buf);
1339 SR_PRIV int sr_brymen_bm25x_parse(const uint8_t *buf, float *floatval,
1340 struct sr_datafeed_analog *analog, void *info);
1342 /*--- hardware/dmm/ut71x.c --------------------------------------------------*/
1344 #define UT71X_PACKET_SIZE 11
1347 gboolean is_voltage, is_resistance, is_capacitance, is_temperature;
1348 gboolean is_celsius, is_fahrenheit, is_current, is_continuity;
1349 gboolean is_diode, is_frequency, is_duty_cycle, is_dc, is_ac;
1350 gboolean is_auto, is_manual, is_sign, is_power, is_loop_current;
1353 SR_PRIV gboolean sr_ut71x_packet_valid(const uint8_t *buf);
1354 SR_PRIV int sr_ut71x_parse(const uint8_t *buf, float *floatval,
1355 struct sr_datafeed_analog *analog, void *info);
1357 /*--- hardware/dmm/vc870.c --------------------------------------------------*/
1359 #define VC870_PACKET_SIZE 23
1362 gboolean is_voltage, is_dc, is_ac, is_temperature, is_resistance;
1363 gboolean is_continuity, is_capacitance, is_diode, is_loop_current;
1364 gboolean is_current, is_micro, is_milli, is_power;
1365 gboolean is_power_factor_freq, is_power_apparent_power, is_v_a_rms_value;
1366 gboolean is_sign2, is_sign1, is_batt, is_ol1, is_max, is_min;
1367 gboolean is_maxmin, is_rel, is_ol2, is_open, is_manu, is_hold;
1368 gboolean is_light, is_usb, is_warning, is_auto_power, is_misplug_warn;
1369 gboolean is_lo, is_hi, is_open2;
1371 gboolean is_frequency, is_dual_display, is_auto;
1374 SR_PRIV gboolean sr_vc870_packet_valid(const uint8_t *buf);
1375 SR_PRIV int sr_vc870_parse(const uint8_t *buf, float *floatval,
1376 struct sr_datafeed_analog *analog, void *info);
1378 /*--- hardware/dmm/vc96.c ---------------------------------------------------*/
1380 #define VC96_PACKET_SIZE 13
1384 gboolean is_ac, is_dc, is_resistance, is_diode, is_ampere, is_volt;
1385 gboolean is_ohm, is_micro, is_milli, is_kilo, is_mega, is_hfe;
1386 gboolean is_unitless;
1389 SR_PRIV gboolean sr_vc96_packet_valid(const uint8_t *buf);
1390 SR_PRIV int sr_vc96_parse(const uint8_t *buf, float *floatval,
1391 struct sr_datafeed_analog *analog, void *info);
1393 /*--- hardware/lcr/es51919.c ------------------------------------------------*/
1395 SR_PRIV void es51919_serial_clean(void *priv);
1396 SR_PRIV struct sr_dev_inst *es51919_serial_scan(GSList *options,
1399 SR_PRIV int es51919_serial_config_get(uint32_t key, GVariant **data,
1400 const struct sr_dev_inst *sdi,
1401 const struct sr_channel_group *cg);
1402 SR_PRIV int es51919_serial_config_set(uint32_t key, GVariant *data,
1403 const struct sr_dev_inst *sdi,
1404 const struct sr_channel_group *cg);
1405 SR_PRIV int es51919_serial_config_list(uint32_t key, GVariant **data,
1406 const struct sr_dev_inst *sdi,
1407 const struct sr_channel_group *cg);
1408 SR_PRIV int es51919_serial_acquisition_start(const struct sr_dev_inst *sdi);
1409 SR_PRIV int es51919_serial_acquisition_stop(struct sr_dev_inst *sdi);
1411 /*--- hardware/dmm/ut372.c --------------------------------------------------*/
1413 #define UT372_PACKET_SIZE 27
1419 SR_PRIV gboolean sr_ut372_packet_valid(const uint8_t *buf);
1420 SR_PRIV int sr_ut372_parse(const uint8_t *buf, float *floatval,
1421 struct sr_datafeed_analog *analog, void *info);
1423 /*--- hardware/dmm/asycii.c -------------------------------------------------*/
1425 #define ASYCII_PACKET_SIZE 16
1427 struct asycii_info {
1428 gboolean is_ac, is_dc, is_ac_and_dc;
1429 gboolean is_resistance, is_capacitance, is_diode, is_gain;
1430 gboolean is_frequency, is_duty_cycle, is_duty_pos, is_duty_neg;
1431 gboolean is_pulse_width, is_period_pos, is_period_neg;
1432 gboolean is_pulse_count, is_count_pos, is_count_neg;
1433 gboolean is_ampere, is_volt, is_volt_ampere, is_farad, is_ohm;
1434 gboolean is_hertz, is_percent, is_seconds, is_decibel;
1435 gboolean is_pico, is_nano, is_micro, is_milli, is_kilo, is_mega;
1436 gboolean is_unitless;
1437 gboolean is_peak_min, is_peak_max;
1438 gboolean is_invalid;
1441 #ifdef HAVE_LIBSERIALPORT
1442 SR_PRIV int sr_asycii_packet_request(struct sr_serial_dev_inst *serial);
1444 SR_PRIV gboolean sr_asycii_packet_valid(const uint8_t *buf);
1445 SR_PRIV int sr_asycii_parse(const uint8_t *buf, float *floatval,
1446 struct sr_datafeed_analog *analog, void *info);
1448 /*--- hardware/scale/kern.c -------------------------------------------------*/
1451 gboolean is_gram, is_carat, is_ounce, is_pound, is_troy_ounce;
1452 gboolean is_pennyweight, is_grain, is_tael, is_momme, is_tola;
1453 gboolean is_percentage, is_piece, is_unstable, is_stable, is_error;
1457 SR_PRIV gboolean sr_kern_packet_valid(const uint8_t *buf);
1458 SR_PRIV int sr_kern_parse(const uint8_t *buf, float *floatval,
1459 struct sr_datafeed_analog *analog, void *info);
1461 /*--- sw_limits.c -----------------------------------------------------------*/
1463 struct sr_sw_limits {
1464 uint64_t limit_samples;
1465 uint64_t limit_msec;
1466 uint64_t samples_read;
1467 uint64_t start_time;
1470 SR_PRIV int sr_sw_limits_config_get(struct sr_sw_limits *limits, uint32_t key,
1472 SR_PRIV int sr_sw_limits_config_set(struct sr_sw_limits *limits, uint32_t key,
1474 SR_PRIV void sr_sw_limits_acquisition_start(struct sr_sw_limits *limits);
1475 SR_PRIV gboolean sr_sw_limits_check(struct sr_sw_limits *limits);
1476 SR_PRIV void sr_sw_limits_update_samples_read(struct sr_sw_limits *limits,
1477 uint64_t samples_read);
1478 SR_PRIV void sr_sw_limits_init(struct sr_sw_limits *limits);