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
35 #ifdef HAVE_LIBSERIALPORT
36 #include <libserialport.h>
38 #ifdef HAVE_LIBUSB_1_0
52 * libsigrok private header file, only to be used internally.
55 /*--- Macros ----------------------------------------------------------------*/
58 #define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0]))
61 #ifndef ARRAY_AND_SIZE
62 #define ARRAY_AND_SIZE(a) (a), ARRAY_SIZE(a)
66 * Read a 8 bits unsigned integer out of memory.
67 * @param x a pointer to the input memory
68 * @return the corresponding unsigned integer
70 #define R8(x) ((unsigned)((const uint8_t*)(x))[0])
73 * Read a 16 bits big endian unsigned integer out of memory.
74 * @param x a pointer to the input memory
75 * @return the corresponding unsigned integer
77 #define RB16(x) (((unsigned)((const uint8_t*)(x))[0] << 8) | \
78 (unsigned)((const uint8_t*)(x))[1])
81 * Read a 16 bits little endian unsigned integer out of memory.
82 * @param x a pointer to the input memory
83 * @return the corresponding unsigned integer
85 #define RL16(x) (((unsigned)((const uint8_t*)(x))[1] << 8) | \
86 (unsigned)((const uint8_t*)(x))[0])
89 * Read a 16 bits big endian signed integer out of memory.
90 * @param x a pointer to the input memory
91 * @return the corresponding signed integer
93 #define RB16S(x) ((int16_t) \
94 (((unsigned)((const uint8_t*)(x))[0] << 8) | \
95 (unsigned)((const uint8_t*)(x))[1]))
98 * Read a 16 bits little endian signed integer out of memory.
99 * @param x a pointer to the input memory
100 * @return the corresponding signed integer
102 #define RL16S(x) ((int16_t) \
103 (((unsigned)((const uint8_t*)(x))[1] << 8) | \
104 (unsigned)((const uint8_t*)(x))[0]))
107 * Read a 32 bits big endian unsigned integer out of memory.
108 * @param x a pointer to the input memory
109 * @return the corresponding unsigned integer
111 #define RB32(x) (((unsigned)((const uint8_t*)(x))[0] << 24) | \
112 ((unsigned)((const uint8_t*)(x))[1] << 16) | \
113 ((unsigned)((const uint8_t*)(x))[2] << 8) | \
114 (unsigned)((const uint8_t*)(x))[3])
117 * Read a 32 bits little endian unsigned integer out of memory.
118 * @param x a pointer to the input memory
119 * @return the corresponding unsigned integer
121 #define RL32(x) (((unsigned)((const uint8_t*)(x))[3] << 24) | \
122 ((unsigned)((const uint8_t*)(x))[2] << 16) | \
123 ((unsigned)((const uint8_t*)(x))[1] << 8) | \
124 (unsigned)((const uint8_t*)(x))[0])
127 * Read a 32 bits big endian signed integer out of memory.
128 * @param x a pointer to the input memory
129 * @return the corresponding signed integer
131 #define RB32S(x) ((int32_t) \
132 (((unsigned)((const uint8_t*)(x))[0] << 24) | \
133 ((unsigned)((const uint8_t*)(x))[1] << 16) | \
134 ((unsigned)((const uint8_t*)(x))[2] << 8) | \
135 (unsigned)((const uint8_t*)(x))[3]))
138 * Read a 32 bits little endian signed integer out of memory.
139 * @param x a pointer to the input memory
140 * @return the corresponding signed integer
142 #define RL32S(x) ((int32_t) \
143 (((unsigned)((const uint8_t*)(x))[3] << 24) | \
144 ((unsigned)((const uint8_t*)(x))[2] << 16) | \
145 ((unsigned)((const uint8_t*)(x))[1] << 8) | \
146 (unsigned)((const uint8_t*)(x))[0]))
149 * Read a 64 bits big endian unsigned integer out of memory.
150 * @param x a pointer to the input memory
151 * @return the corresponding unsigned integer
153 #define RB64(x) (((uint64_t)((const uint8_t*)(x))[0] << 56) | \
154 ((uint64_t)((const uint8_t*)(x))[1] << 48) | \
155 ((uint64_t)((const uint8_t*)(x))[2] << 40) | \
156 ((uint64_t)((const uint8_t*)(x))[3] << 32) | \
157 ((uint64_t)((const uint8_t*)(x))[4] << 24) | \
158 ((uint64_t)((const uint8_t*)(x))[5] << 16) | \
159 ((uint64_t)((const uint8_t*)(x))[6] << 8) | \
160 (uint64_t)((const uint8_t*)(x))[7])
163 * Read a 64 bits little endian unsigned integer out of memory.
164 * @param x a pointer to the input memory
165 * @return the corresponding unsigned integer
167 #define RL64(x) (((uint64_t)((const uint8_t*)(x))[7] << 56) | \
168 ((uint64_t)((const uint8_t*)(x))[6] << 48) | \
169 ((uint64_t)((const uint8_t*)(x))[5] << 40) | \
170 ((uint64_t)((const uint8_t*)(x))[4] << 32) | \
171 ((uint64_t)((const uint8_t*)(x))[3] << 24) | \
172 ((uint64_t)((const uint8_t*)(x))[2] << 16) | \
173 ((uint64_t)((const uint8_t*)(x))[1] << 8) | \
174 (uint64_t)((const uint8_t*)(x))[0])
177 * Read a 64 bits little endian signed integer out of memory.
178 * @param x a pointer to the input memory
179 * @return the corresponding unsigned integer
181 #define RL64S(x) ((int64_t) \
182 (((uint64_t)((const uint8_t*)(x))[7] << 56) | \
183 ((uint64_t)((const uint8_t*)(x))[6] << 48) | \
184 ((uint64_t)((const uint8_t*)(x))[5] << 40) | \
185 ((uint64_t)((const uint8_t*)(x))[4] << 32) | \
186 ((uint64_t)((const uint8_t*)(x))[3] << 24) | \
187 ((uint64_t)((const uint8_t*)(x))[2] << 16) | \
188 ((uint64_t)((const uint8_t*)(x))[1] << 8) | \
189 (uint64_t)((const uint8_t*)(x))[0]))
192 * Read a 32 bits big endian float out of memory.
193 * @param x a pointer to the input memory
194 * @return the corresponding float
196 #define RBFL(x) ((union { uint32_t u; float f; }) { .u = RB32(x) }.f)
199 * Read a 32 bits little endian float out of memory.
200 * @param x a pointer to the input memory
201 * @return the corresponding float
203 #define RLFL(x) ((union { uint32_t u; float f; }) { .u = RL32(x) }.f)
206 * Write a 8 bits unsigned integer to memory.
207 * @param p a pointer to the output memory
208 * @param x the input unsigned integer
210 #define W8(p, x) do { ((uint8_t*)(p))[0] = (uint8_t) (x); } while (0)
213 * Write a 16 bits unsigned integer to memory stored as big endian.
214 * @param p a pointer to the output memory
215 * @param x the input unsigned integer
217 #define WB16(p, x) do { ((uint8_t*)(p))[1] = (uint8_t) (x); \
218 ((uint8_t*)(p))[0] = (uint8_t)((x)>>8); } while (0)
221 * Write a 16 bits unsigned integer to memory stored as little endian.
222 * @param p a pointer to the output memory
223 * @param x the input unsigned integer
225 #define WL16(p, x) do { ((uint8_t*)(p))[0] = (uint8_t) (x); \
226 ((uint8_t*)(p))[1] = (uint8_t)((x)>>8); } while (0)
229 * Write a 32 bits unsigned integer to memory stored as big endian.
230 * @param p a pointer to the output memory
231 * @param x the input unsigned integer
233 #define WB32(p, x) do { ((uint8_t*)(p))[3] = (uint8_t) (x); \
234 ((uint8_t*)(p))[2] = (uint8_t)((x)>>8); \
235 ((uint8_t*)(p))[1] = (uint8_t)((x)>>16); \
236 ((uint8_t*)(p))[0] = (uint8_t)((x)>>24); } while (0)
239 * Write a 32 bits unsigned integer to memory stored as little endian.
240 * @param p a pointer to the output memory
241 * @param x the input unsigned integer
243 #define WL32(p, x) do { ((uint8_t*)(p))[0] = (uint8_t) (x); \
244 ((uint8_t*)(p))[1] = (uint8_t)((x)>>8); \
245 ((uint8_t*)(p))[2] = (uint8_t)((x)>>16); \
246 ((uint8_t*)(p))[3] = (uint8_t)((x)>>24); } while (0)
249 * Write a 32 bits float to memory stored as big endian.
250 * @param p a pointer to the output memory
251 * @param x the input float
253 #define WBFL(p, x) WB32(p, (union { uint32_t u; float f; }) { .f = x }.u)
256 * Write a 32 bits float to memory stored as little endian.
257 * @param p a pointer to the output memory
258 * @param x the input float
260 #define WLFL(p, x) WL32(p, (union { uint32_t u; float f; }) { .f = x }.u)
262 /* Portability fixes for FreeBSD. */
264 #define LIBUSB_CLASS_APPLICATION 0xfe
265 #define libusb_has_capability(x) 0
266 #define libusb_handle_events_timeout_completed(ctx, tv, c) \
267 libusb_handle_events_timeout(ctx, tv)
270 /* Static definitions of structs ending with an all-zero entry are a
271 * problem when compiling with -Wmissing-field-initializers: GCC
272 * suppresses the warning only with { 0 }, clang wants { } */
276 #define ALL_ZERO { 0 }
280 #define SR_DRIVER_LIST_SECTION "__DATA,__sr_driver_list"
282 #define SR_DRIVER_LIST_SECTION "sr_driver_list"
286 * Register a list of hardware drivers.
288 * This macro can be used to register multiple hardware drivers to the library.
289 * This is useful when a driver supports multiple similar but slightly
290 * different devices that require different sr_dev_driver struct definitions.
292 * For registering only a single driver see SR_REGISTER_DEV_DRIVER().
296 * #define MY_DRIVER(_name) \
297 * &(struct sr_dev_driver){ \
302 * SR_REGISTER_DEV_DRIVER_LIST(my_driver_infos,
303 * MY_DRIVER("driver 1"),
304 * MY_DRIVER("driver 2"),
309 * @param name Name to use for the driver list identifier.
310 * @param ... Comma separated list of pointers to sr_dev_driver structs.
312 #define SR_REGISTER_DEV_DRIVER_LIST(name, ...) \
313 static const struct sr_dev_driver *name[] \
314 __attribute__((section (SR_DRIVER_LIST_SECTION), used, \
315 aligned(sizeof(struct sr_dev_driver *)))) \
321 * Register a hardware driver.
323 * This macro is used to register a hardware driver with the library. It has
324 * to be used in order to make the driver accessible to applications using the
327 * The macro invocation should be placed directly under the struct
328 * sr_dev_driver definition.
332 * static struct sr_dev_driver driver_info = {
336 * SR_REGISTER_DEV_DRIVER(driver_info);
339 * @param name Identifier name of sr_dev_driver struct to register.
341 #define SR_REGISTER_DEV_DRIVER(name) \
342 SR_REGISTER_DEV_DRIVER_LIST(name##_list, &name);
344 SR_API void sr_drivers_init(struct sr_context *context);
347 struct sr_dev_driver **driver_list;
348 #ifdef HAVE_LIBUSB_1_0
349 libusb_context *libusb_ctx;
351 sr_resource_open_callback resource_open_cb;
352 sr_resource_close_callback resource_close_cb;
353 sr_resource_read_callback resource_read_cb;
354 void *resource_cb_data;
357 /** Input module metadata keys. */
358 enum sr_input_meta_keys {
359 /** The input filename, if there is one. */
360 SR_INPUT_META_FILENAME = 0x01,
361 /** The input file's size in bytes. */
362 SR_INPUT_META_FILESIZE = 0x02,
363 /** The first 128 bytes of the file, provided as a GString. */
364 SR_INPUT_META_HEADER = 0x04,
366 /** The module cannot identify a file without this metadata. */
367 SR_INPUT_META_REQUIRED = 0x80,
370 /** Input (file) module struct. */
373 * A pointer to this input module's 'struct sr_input_module'.
375 const struct sr_input_module *module;
377 struct sr_dev_inst *sdi;
382 /** Input (file) module driver. */
383 struct sr_input_module {
385 * A unique ID for this input module, suitable for use in command-line
386 * clients, [a-z0-9-]. Must not be NULL.
391 * A unique name for this input module, suitable for use in GUI
392 * clients, can contain UTF-8. Must not be NULL.
397 * A short description of the input module. Must not be NULL.
399 * This can be displayed by frontends, e.g. when selecting the input
400 * module for saving a file.
405 * A NULL terminated array of strings containing a list of file name
406 * extensions typical for the input file format, or NULL if there is
407 * no typical extension for this file format.
409 const char *const *exts;
412 * Zero-terminated list of metadata items the module needs to be able
413 * to identify an input stream. Can be all-zero, if the module cannot
414 * identify streams at all, i.e. has to be forced into use.
416 * Each item is one of:
417 * SR_INPUT_META_FILENAME
418 * SR_INPUT_META_FILESIZE
419 * SR_INPUT_META_HEADER
421 * If the high bit (SR_INPUT META_REQUIRED) is set, the module cannot
422 * identify a stream without the given metadata.
424 const uint8_t metadata[8];
427 * Returns a NULL-terminated list of options this module can take.
428 * Can be NULL, if the module has no options.
430 const struct sr_option *(*options) (void);
433 * Check if this input module can load and parse the specified stream.
435 * @param[in] metadata Metadata the module can use to identify the stream.
436 * @param[out] confidence "Strength" of the detection.
437 * Specialized handlers can take precedence over generic/basic support.
439 * @retval SR_OK This module knows the format.
440 * @retval SR_ERR_NA There wasn't enough data for this module to
441 * positively identify the format.
442 * @retval SR_ERR_DATA This module knows the format, but cannot handle
443 * it. This means the stream is either corrupt, or indicates a
444 * feature that the module does not support.
445 * @retval SR_ERR This module does not know the format.
447 * Lower numeric values of 'confidence' mean that the input module
448 * stronger believes in its capability to handle this specific format.
449 * This way, multiple input modules can claim support for a format,
450 * and the application can pick the best match, or try fallbacks
451 * in case of errors. This approach also copes with formats that
452 * are unreliable to detect in the absence of magic signatures.
454 int (*format_match) (GHashTable *metadata, unsigned int *confidence);
457 * Initialize the input module.
459 * @retval SR_OK Success
460 * @retval other Negative error code.
462 int (*init) (struct sr_input *in, GHashTable *options);
465 * Send data to the specified input instance.
467 * When an input module instance is created with sr_input_new(), this
468 * function is used to feed data to the instance.
470 * As enough data gets fed into this function to completely populate
471 * the device instance associated with this input instance, this is
472 * guaranteed to return the moment it's ready. This gives the caller
473 * the chance to examine the device instance, attach session callbacks
476 * @retval SR_OK Success
477 * @retval other Negative error code.
479 int (*receive) (struct sr_input *in, GString *buf);
482 * Signal the input module no more data will come.
484 * This will cause the module to process any data it may have buffered.
485 * The SR_DF_END packet will also typically be sent at this time.
487 int (*end) (struct sr_input *in);
490 * Reset the input module's input handling structures.
492 * Causes the input module to reset its internal state so that we can
493 * re-send the input data from the beginning without having to
494 * re-create the entire input module.
496 * @retval SR_OK Success.
497 * @retval other Negative error code.
499 int (*reset) (struct sr_input *in);
502 * This function is called after the caller is finished using
503 * the input module, and can be used to free any internal
504 * resources the module may keep.
506 * This function is optional.
508 * @retval SR_OK Success
509 * @retval other Negative error code.
511 void (*cleanup) (struct sr_input *in);
514 /** Output module instance. */
516 /** A pointer to this output's module. */
517 const struct sr_output_module *module;
520 * The device for which this output module is creating output. This
521 * can be used by the module to find out channel names and numbers.
523 const struct sr_dev_inst *sdi;
526 * The name of the file that the data should be written to.
528 const char *filename;
531 * A generic pointer which can be used by the module to keep internal
532 * state between calls into its callback functions.
534 * For example, the module might store a pointer to a chunk of output
535 * there, and only flush it when it reaches a certain size.
540 /** Output module driver. */
541 struct sr_output_module {
543 * A unique ID for this output module, suitable for use in command-line
544 * clients, [a-z0-9-]. Must not be NULL.
549 * A unique name for this output module, suitable for use in GUI
550 * clients, can contain UTF-8. Must not be NULL.
555 * A short description of the output module. Must not be NULL.
557 * This can be displayed by frontends, e.g. when selecting the output
558 * module for saving a file.
563 * A NULL terminated array of strings containing a list of file name
564 * extensions typical for the input file format, or NULL if there is
565 * no typical extension for this file format.
567 const char *const *exts;
570 * Bitfield containing flags that describe certain properties
571 * this output module may or may not have.
572 * @see sr_output_flags
574 const uint64_t flags;
577 * Returns a NULL-terminated list of options this module can take.
578 * Can be NULL, if the module has no options.
580 const struct sr_option *(*options) (void);
583 * This function is called once, at the beginning of an output stream.
585 * The device struct will be available in the output struct passed in,
586 * as well as the param field -- which may be NULL or an empty string,
587 * if no parameter was passed.
589 * The module can use this to initialize itself, create a struct for
590 * keeping state and storing it in the <code>internal</code> field.
592 * @param o Pointer to the respective 'struct sr_output'.
594 * @retval SR_OK Success
595 * @retval other Negative error code.
597 int (*init) (struct sr_output *o, GHashTable *options);
600 * This function is passed a copy of every packet in the data feed.
601 * Any output generated by the output module in response to the
602 * packet should be returned in a newly allocated GString
603 * <code>out</code>, which will be freed by the caller.
605 * Packets not of interest to the output module can just be ignored,
606 * and the <code>out</code> parameter set to NULL.
608 * @param o Pointer to the respective 'struct sr_output'.
609 * @param sdi The device instance that generated the packet.
610 * @param packet The complete packet.
611 * @param out A pointer where a GString * should be stored if
612 * the module generates output, or NULL if not.
614 * @retval SR_OK Success
615 * @retval other Negative error code.
617 int (*receive) (const struct sr_output *o,
618 const struct sr_datafeed_packet *packet, GString **out);
621 * This function is called after the caller is finished using
622 * the output module, and can be used to free any internal
623 * resources the module may keep.
625 * @retval SR_OK Success
626 * @retval other Negative error code.
628 int (*cleanup) (struct sr_output *o);
631 /** Transform module instance. */
632 struct sr_transform {
633 /** A pointer to this transform's module. */
634 const struct sr_transform_module *module;
637 * The device for which this transform module is used. This
638 * can be used by the module to find out channel names and numbers.
640 const struct sr_dev_inst *sdi;
643 * A generic pointer which can be used by the module to keep internal
644 * state between calls into its callback functions.
649 struct sr_transform_module {
651 * A unique ID for this transform module, suitable for use in
652 * command-line clients, [a-z0-9-]. Must not be NULL.
657 * A unique name for this transform module, suitable for use in GUI
658 * clients, can contain UTF-8. Must not be NULL.
663 * A short description of the transform module. Must not be NULL.
665 * This can be displayed by frontends, e.g. when selecting
666 * which transform module(s) to add.
671 * Returns a NULL-terminated list of options this transform module
672 * can take. Can be NULL, if the transform module has no options.
674 const struct sr_option *(*options) (void);
677 * This function is called once, at the beginning of a stream.
679 * @param t Pointer to the respective 'struct sr_transform'.
680 * @param options Hash table of options for this transform module.
681 * Can be NULL if no options are to be used.
683 * @retval SR_OK Success
684 * @retval other Negative error code.
686 int (*init) (struct sr_transform *t, GHashTable *options);
689 * This function is passed a pointer to every packet in the data feed.
691 * It can either return (in packet_out) a pointer to another packet
692 * (possibly the exact same packet it got as input), or NULL.
694 * @param t Pointer to the respective 'struct sr_transform'.
695 * @param packet_in Pointer to a datafeed packet.
696 * @param packet_out Pointer to the resulting datafeed packet after
697 * this function was run. If NULL, the transform
698 * module intentionally didn't output a new packet.
700 * @retval SR_OK Success
701 * @retval other Negative error code.
703 int (*receive) (const struct sr_transform *t,
704 struct sr_datafeed_packet *packet_in,
705 struct sr_datafeed_packet **packet_out);
708 * This function is called after the caller is finished using
709 * the transform module, and can be used to free any internal
710 * resources the module may keep.
712 * @retval SR_OK Success
713 * @retval other Negative error code.
715 int (*cleanup) (struct sr_transform *t);
718 #ifdef HAVE_LIBUSB_1_0
719 /** USB device instance */
720 struct sr_usb_dev_inst {
723 /** Device address on USB bus */
725 /** libusb device handle */
726 struct libusb_device_handle *devhdl;
730 struct sr_serial_dev_inst;
731 #ifdef HAVE_SERIAL_COMM
732 struct ser_lib_functions;
733 struct ser_hid_chip_functions;
735 typedef void (*serial_rx_chunk_callback)(struct sr_serial_dev_inst *serial,
736 void *cb_data, const void *buf, size_t count);
737 struct sr_serial_dev_inst {
738 /** Port name, e.g. '/dev/tty42'. */
740 /** Comm params for serial_set_paramstr(). */
742 struct ser_lib_functions *lib_funcs;
750 serial_rx_chunk_callback rx_chunk_cb_func;
751 void *rx_chunk_cb_data;
752 #ifdef HAVE_LIBSERIALPORT
753 /** libserialport port handle */
754 struct sp_port *sp_data;
756 #ifdef HAVE_LIBHIDAPI
757 enum ser_hid_chip_t {
758 SER_HID_CHIP_UNKNOWN, /**!< place holder */
759 SER_HID_CHIP_SIL_CP2110, /**!< SiLabs CP2110 */
760 SER_HID_CHIP_WCH_CH9325, /**!< WCH CH9325 */
761 SER_HID_CHIP_LAST, /**!< sentinel */
763 struct ser_hid_chip_functions *hid_chip_funcs;
766 const char *hid_path;
768 GSList *hid_source_args;
770 #ifdef HAVE_BLUETOOTH
772 SER_BT_CONN_UNKNOWN, /**!< place holder */
773 SER_BT_CONN_RFCOMM, /**!< BT classic, RFCOMM channel */
774 SER_BT_CONN_BLE122, /**!< BLE, BLE122 module, indications */
775 SER_BT_CONN_NRF51, /**!< BLE, Nordic nRF51, notifications */
776 SER_BT_CONN_CC254x, /**!< BLE, TI CC254x, notifications */
777 SER_BT_CONN_MAX, /**!< sentinel */
780 char *bt_addr_remote;
781 size_t bt_rfcomm_channel;
782 uint16_t bt_notify_handle_read;
783 uint16_t bt_notify_handle_write;
784 uint16_t bt_notify_handle_cccd;
785 uint16_t bt_notify_value_cccd;
786 struct sr_bt_desc *bt_desc;
787 GSList *bt_source_args;
792 struct sr_usbtmc_dev_inst {
797 /* Private driver context. */
799 /** sigrok context */
800 struct sr_context *sr_ctx;
804 /*--- log.c -----------------------------------------------------------------*/
806 #if defined(_WIN32) && (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 4))
808 * On MinGW, we need to specify the gnu_printf format flavor or GCC
809 * will assume non-standard Microsoft printf syntax.
811 SR_PRIV int sr_log(int loglevel, const char *format, ...)
812 __attribute__((__format__ (__gnu_printf__, 2, 3)));
814 SR_PRIV int sr_log(int loglevel, const char *format, ...) G_GNUC_PRINTF(2, 3);
817 /* Message logging helpers with subsystem-specific prefix string. */
818 #define sr_spew(...) sr_log(SR_LOG_SPEW, LOG_PREFIX ": " __VA_ARGS__)
819 #define sr_dbg(...) sr_log(SR_LOG_DBG, LOG_PREFIX ": " __VA_ARGS__)
820 #define sr_info(...) sr_log(SR_LOG_INFO, LOG_PREFIX ": " __VA_ARGS__)
821 #define sr_warn(...) sr_log(SR_LOG_WARN, LOG_PREFIX ": " __VA_ARGS__)
822 #define sr_err(...) sr_log(SR_LOG_ERR, LOG_PREFIX ": " __VA_ARGS__)
824 /*--- device.c --------------------------------------------------------------*/
826 /** Scan options supported by a driver. */
827 #define SR_CONF_SCAN_OPTIONS 0x7FFF0000
829 /** Device options for a particular device. */
830 #define SR_CONF_DEVICE_OPTIONS 0x7FFF0001
832 /** Mask for separating config keys from capabilities. */
833 #define SR_CONF_MASK 0x1fffffff
835 /** Values for the changes argument of sr_dev_driver.config_channel_set. */
837 /** The enabled state of the channel has been changed. */
838 SR_CHANNEL_SET_ENABLED = 1 << 0,
841 SR_PRIV struct sr_channel *sr_channel_new(struct sr_dev_inst *sdi,
842 int index, int type, gboolean enabled, const char *name);
843 SR_PRIV void sr_channel_free(struct sr_channel *ch);
844 SR_PRIV void sr_channel_free_cb(void *p);
845 SR_PRIV struct sr_channel *sr_next_enabled_channel(const struct sr_dev_inst *sdi,
846 struct sr_channel *cur_channel);
847 SR_PRIV gboolean sr_channels_differ(struct sr_channel *ch1, struct sr_channel *ch2);
848 SR_PRIV gboolean sr_channel_lists_differ(GSList *l1, GSList *l2);
850 /** Device instance data */
852 /** Device driver. */
853 struct sr_dev_driver *driver;
854 /** Device instance status. SR_ST_NOT_FOUND, etc. */
856 /** Device instance type. SR_INST_USB, etc. */
858 /** Device vendor. */
862 /** Device version. */
864 /** Serial number. */
866 /** Connection string to uniquely identify devices. */
868 /** List of channels. */
870 /** List of sr_channel_group structs */
871 GSList *channel_groups;
872 /** Device instance connection data (used?) */
874 /** Device instance private data (used?) */
876 /** Session to which this device is currently assigned. */
877 struct sr_session *session;
880 /* Generic device instances */
881 SR_PRIV void sr_dev_inst_free(struct sr_dev_inst *sdi);
883 #ifdef HAVE_LIBUSB_1_0
884 /* USB-specific instances */
885 SR_PRIV struct sr_usb_dev_inst *sr_usb_dev_inst_new(uint8_t bus,
886 uint8_t address, struct libusb_device_handle *hdl);
887 SR_PRIV void sr_usb_dev_inst_free(struct sr_usb_dev_inst *usb);
890 #ifdef HAVE_SERIAL_COMM
891 #ifndef HAVE_LIBSERIALPORT
893 * Some identifiers which initially got provided by libserialport are
894 * used internally within the libsigrok serial layer's implementation,
895 * while libserialport no longer is the exclusive provider of serial
896 * communication support. Declare the identifiers here so they remain
897 * available across all build configurations.
907 enum libsp_flowcontrol {
908 SP_FLOWCONTROL_NONE = 0,
909 SP_FLOWCONTROL_XONXOFF = 1,
910 SP_FLOWCONTROL_RTSCTS = 2,
911 SP_FLOWCONTROL_DTRDSR = 3,
915 /* Serial-specific instances */
916 SR_PRIV struct sr_serial_dev_inst *sr_serial_dev_inst_new(const char *port,
917 const char *serialcomm);
918 SR_PRIV void sr_serial_dev_inst_free(struct sr_serial_dev_inst *serial);
921 /* USBTMC-specific instances */
922 SR_PRIV struct sr_usbtmc_dev_inst *sr_usbtmc_dev_inst_new(const char *device);
923 SR_PRIV void sr_usbtmc_dev_inst_free(struct sr_usbtmc_dev_inst *usbtmc);
925 /*--- hwdriver.c ------------------------------------------------------------*/
927 SR_PRIV const GVariantType *sr_variant_type_get(int datatype);
928 SR_PRIV int sr_variant_type_check(uint32_t key, GVariant *data);
929 SR_PRIV void sr_hw_cleanup_all(const struct sr_context *ctx);
930 SR_PRIV struct sr_config *sr_config_new(uint32_t key, GVariant *data);
931 SR_PRIV void sr_config_free(struct sr_config *src);
932 SR_PRIV int sr_dev_acquisition_start(struct sr_dev_inst *sdi);
933 SR_PRIV int sr_dev_acquisition_stop(struct sr_dev_inst *sdi);
935 /*--- session.c -------------------------------------------------------------*/
938 /** Context this session exists in. */
939 struct sr_context *ctx;
940 /** List of struct sr_dev_inst pointers. */
942 /** List of struct sr_dev_inst pointers owned by this session. */
944 /** List of struct datafeed_callback pointers. */
945 GSList *datafeed_callbacks;
947 struct sr_trigger *trigger;
949 /** Callback to invoke on session stop. */
950 sr_session_stopped_callback stopped_callback;
951 /** User data to be passed to the session stop callback. */
952 void *stopped_cb_data;
954 /** Mutex protecting the main context pointer. */
956 /** Context of the session main loop. */
957 GMainContext *main_context;
959 /** Registered event sources for this session. */
960 GHashTable *event_sources;
961 /** Session main loop. */
962 GMainLoop *main_loop;
963 /** ID of idle source for dispatching the session stop notification. */
964 unsigned int stop_check_id;
965 /** Whether the session has been started. */
969 SR_PRIV int sr_session_source_add_internal(struct sr_session *session,
970 void *key, GSource *source);
971 SR_PRIV int sr_session_source_remove_internal(struct sr_session *session,
973 SR_PRIV int sr_session_source_destroyed(struct sr_session *session,
974 void *key, GSource *source);
975 SR_PRIV int sr_session_fd_source_add(struct sr_session *session,
976 void *key, gintptr fd, int events, int timeout,
977 sr_receive_data_callback cb, void *cb_data);
979 SR_PRIV int sr_session_source_add(struct sr_session *session, int fd,
980 int events, int timeout, sr_receive_data_callback cb, void *cb_data);
981 SR_PRIV int sr_session_source_add_pollfd(struct sr_session *session,
982 GPollFD *pollfd, int timeout, sr_receive_data_callback cb,
984 SR_PRIV int sr_session_source_add_channel(struct sr_session *session,
985 GIOChannel *channel, int events, int timeout,
986 sr_receive_data_callback cb, void *cb_data);
987 SR_PRIV int sr_session_source_remove(struct sr_session *session, int fd);
988 SR_PRIV int sr_session_source_remove_pollfd(struct sr_session *session,
990 SR_PRIV int sr_session_source_remove_channel(struct sr_session *session,
991 GIOChannel *channel);
993 SR_PRIV int sr_session_send_meta(const struct sr_dev_inst *sdi,
994 uint32_t key, GVariant *var);
995 SR_PRIV int sr_session_send(const struct sr_dev_inst *sdi,
996 const struct sr_datafeed_packet *packet);
997 SR_PRIV int sr_sessionfile_check(const char *filename);
998 SR_PRIV struct sr_dev_inst *sr_session_prepare_sdi(const char *filename,
999 struct sr_session **session);
1001 /*--- session_file.c --------------------------------------------------------*/
1003 #if !HAVE_ZIP_DISCARD
1004 /* Replace zip_discard() if not available. */
1005 #define zip_discard(zip) sr_zip_discard(zip)
1006 SR_PRIV void sr_zip_discard(struct zip *archive);
1009 SR_PRIV GKeyFile *sr_sessionfile_read_metadata(struct zip *archive,
1010 const struct zip_stat *entry);
1012 /*--- analog.c --------------------------------------------------------------*/
1014 SR_PRIV int sr_analog_init(struct sr_datafeed_analog *analog,
1015 struct sr_analog_encoding *encoding,
1016 struct sr_analog_meaning *meaning,
1017 struct sr_analog_spec *spec,
1020 /*--- std.c -----------------------------------------------------------------*/
1022 typedef int (*dev_close_callback)(struct sr_dev_inst *sdi);
1023 typedef void (*std_dev_clear_callback)(void *priv);
1025 SR_PRIV int std_init(struct sr_dev_driver *di, struct sr_context *sr_ctx);
1026 SR_PRIV int std_cleanup(const struct sr_dev_driver *di);
1027 SR_PRIV int std_dummy_dev_open(struct sr_dev_inst *sdi);
1028 SR_PRIV int std_dummy_dev_close(struct sr_dev_inst *sdi);
1029 SR_PRIV int std_dummy_dev_acquisition_start(const struct sr_dev_inst *sdi);
1030 SR_PRIV int std_dummy_dev_acquisition_stop(struct sr_dev_inst *sdi);
1031 #ifdef HAVE_SERIAL_COMM
1032 SR_PRIV int std_serial_dev_open(struct sr_dev_inst *sdi);
1033 SR_PRIV int std_serial_dev_acquisition_stop(struct sr_dev_inst *sdi);
1035 SR_PRIV int std_session_send_df_header(const struct sr_dev_inst *sdi);
1036 SR_PRIV int std_session_send_df_end(const struct sr_dev_inst *sdi);
1037 SR_PRIV int std_session_send_frame_begin(const struct sr_dev_inst *sdi);
1038 SR_PRIV int std_session_send_frame_end(const struct sr_dev_inst *sdi);
1039 SR_PRIV int std_dev_clear_with_callback(const struct sr_dev_driver *driver,
1040 std_dev_clear_callback clear_private);
1041 SR_PRIV int std_dev_clear(const struct sr_dev_driver *driver);
1042 SR_PRIV GSList *std_dev_list(const struct sr_dev_driver *di);
1043 SR_PRIV int std_serial_dev_close(struct sr_dev_inst *sdi);
1044 SR_PRIV GSList *std_scan_complete(struct sr_dev_driver *di, GSList *devices);
1046 SR_PRIV int std_opts_config_list(uint32_t key, GVariant **data,
1047 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg,
1048 const uint32_t scanopts[], size_t scansize, const uint32_t drvopts[],
1049 size_t drvsize, const uint32_t devopts[], size_t devsize);
1051 extern SR_PRIV const uint32_t NO_OPTS[1];
1053 #define STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts) \
1054 std_opts_config_list(key, data, sdi, cg, ARRAY_AND_SIZE(scanopts), \
1055 ARRAY_AND_SIZE(drvopts), ARRAY_AND_SIZE(devopts))
1057 SR_PRIV GVariant *std_gvar_tuple_array(const uint64_t a[][2], unsigned int n);
1058 SR_PRIV GVariant *std_gvar_tuple_rational(const struct sr_rational *r, unsigned int n);
1059 SR_PRIV GVariant *std_gvar_samplerates(const uint64_t samplerates[], unsigned int n);
1060 SR_PRIV GVariant *std_gvar_samplerates_steps(const uint64_t samplerates[], unsigned int n);
1061 SR_PRIV GVariant *std_gvar_min_max_step(double min, double max, double step);
1062 SR_PRIV GVariant *std_gvar_min_max_step_array(const double a[3]);
1063 SR_PRIV GVariant *std_gvar_min_max_step_thresholds(const double dmin, const double dmax, const double dstep);
1065 SR_PRIV GVariant *std_gvar_tuple_u64(uint64_t low, uint64_t high);
1066 SR_PRIV GVariant *std_gvar_tuple_double(double low, double high);
1068 SR_PRIV GVariant *std_gvar_array_i32(const int32_t a[], unsigned int n);
1069 SR_PRIV GVariant *std_gvar_array_u32(const uint32_t a[], unsigned int n);
1070 SR_PRIV GVariant *std_gvar_array_u64(const uint64_t a[], unsigned int n);
1071 SR_PRIV GVariant *std_gvar_array_str(const char *a[], unsigned int n);
1073 SR_PRIV GVariant *std_gvar_thresholds(const double a[][2], unsigned int n);
1075 SR_PRIV int std_str_idx(GVariant *data, const char *a[], unsigned int n);
1076 SR_PRIV int std_u64_idx(GVariant *data, const uint64_t a[], unsigned int n);
1077 SR_PRIV int std_u8_idx(GVariant *data, const uint8_t a[], unsigned int n);
1079 SR_PRIV int std_str_idx_s(const char *s, const char *a[], unsigned int n);
1080 SR_PRIV int std_u8_idx_s(uint8_t b, const uint8_t a[], unsigned int n);
1082 SR_PRIV int std_u64_tuple_idx(GVariant *data, const uint64_t a[][2], unsigned int n);
1083 SR_PRIV int std_double_tuple_idx(GVariant *data, const double a[][2], unsigned int n);
1084 SR_PRIV int std_double_tuple_idx_d0(const double d, const double a[][2], unsigned int n);
1086 SR_PRIV int std_cg_idx(const struct sr_channel_group *cg, struct sr_channel_group *a[], unsigned int n);
1088 /*--- resource.c ------------------------------------------------------------*/
1090 SR_PRIV int64_t sr_file_get_size(FILE *file);
1092 SR_PRIV int sr_resource_open(struct sr_context *ctx,
1093 struct sr_resource *res, int type, const char *name)
1094 G_GNUC_WARN_UNUSED_RESULT;
1095 SR_PRIV int sr_resource_close(struct sr_context *ctx,
1096 struct sr_resource *res);
1097 SR_PRIV gssize sr_resource_read(struct sr_context *ctx,
1098 const struct sr_resource *res, void *buf, size_t count)
1099 G_GNUC_WARN_UNUSED_RESULT;
1100 SR_PRIV void *sr_resource_load(struct sr_context *ctx, int type,
1101 const char *name, size_t *size, size_t max_size)
1102 G_GNUC_MALLOC G_GNUC_WARN_UNUSED_RESULT;
1104 /*--- strutil.c -------------------------------------------------------------*/
1106 SR_PRIV int sr_atol(const char *str, long *ret);
1107 SR_PRIV int sr_atoi(const char *str, int *ret);
1108 SR_PRIV int sr_atod(const char *str, double *ret);
1109 SR_PRIV int sr_atof(const char *str, float *ret);
1110 SR_PRIV int sr_atod_ascii(const char *str, double *ret);
1111 SR_PRIV int sr_atof_ascii(const char *str, float *ret);
1113 SR_PRIV GString *sr_hexdump_new(const uint8_t *data, const size_t len);
1114 SR_PRIV void sr_hexdump_free(GString *s);
1116 /*--- soft-trigger.c --------------------------------------------------------*/
1118 struct soft_trigger_logic {
1119 const struct sr_dev_inst *sdi;
1120 const struct sr_trigger *trigger;
1124 uint8_t *prev_sample;
1125 uint8_t *pre_trigger_buffer;
1126 uint8_t *pre_trigger_head;
1127 int pre_trigger_size;
1128 int pre_trigger_fill;
1131 SR_PRIV int logic_channel_unitsize(GSList *channels);
1132 SR_PRIV struct soft_trigger_logic *soft_trigger_logic_new(
1133 const struct sr_dev_inst *sdi, struct sr_trigger *trigger,
1134 int pre_trigger_samples);
1135 SR_PRIV void soft_trigger_logic_free(struct soft_trigger_logic *st);
1136 SR_PRIV int soft_trigger_logic_check(struct soft_trigger_logic *st, uint8_t *buf,
1137 int len, int *pre_trigger_samples);
1139 /*--- serial.c --------------------------------------------------------------*/
1141 #ifdef HAVE_SERIAL_COMM
1147 typedef gboolean (*packet_valid_callback)(const uint8_t *buf);
1149 typedef GSList *(*sr_ser_list_append_t)(GSList *devs, const char *name,
1151 typedef GSList *(*sr_ser_find_append_t)(GSList *devs, const char *name);
1153 SR_PRIV int serial_open(struct sr_serial_dev_inst *serial, int flags);
1154 SR_PRIV int serial_close(struct sr_serial_dev_inst *serial);
1155 SR_PRIV int serial_flush(struct sr_serial_dev_inst *serial);
1156 SR_PRIV int serial_drain(struct sr_serial_dev_inst *serial);
1157 SR_PRIV size_t serial_has_receive_data(struct sr_serial_dev_inst *serial);
1158 SR_PRIV int serial_write_blocking(struct sr_serial_dev_inst *serial,
1159 const void *buf, size_t count, unsigned int timeout_ms);
1160 SR_PRIV int serial_write_nonblocking(struct sr_serial_dev_inst *serial,
1161 const void *buf, size_t count);
1162 SR_PRIV int serial_read_blocking(struct sr_serial_dev_inst *serial, void *buf,
1163 size_t count, unsigned int timeout_ms);
1164 SR_PRIV int serial_read_nonblocking(struct sr_serial_dev_inst *serial, void *buf,
1166 SR_PRIV int serial_set_read_chunk_cb(struct sr_serial_dev_inst *serial,
1167 serial_rx_chunk_callback cb, void *cb_data);
1168 SR_PRIV int serial_set_params(struct sr_serial_dev_inst *serial, int baudrate,
1169 int bits, int parity, int stopbits, int flowcontrol, int rts, int dtr);
1170 SR_PRIV int serial_set_paramstr(struct sr_serial_dev_inst *serial,
1171 const char *paramstr);
1172 SR_PRIV int serial_readline(struct sr_serial_dev_inst *serial, char **buf,
1173 int *buflen, gint64 timeout_ms);
1174 SR_PRIV int serial_stream_detect(struct sr_serial_dev_inst *serial,
1175 uint8_t *buf, size_t *buflen,
1177 packet_valid_callback is_valid,
1178 uint64_t timeout_ms);
1179 SR_PRIV int sr_serial_extract_options(GSList *options, const char **serial_device,
1180 const char **serial_options);
1181 SR_PRIV int serial_source_add(struct sr_session *session,
1182 struct sr_serial_dev_inst *serial, int events, int timeout,
1183 sr_receive_data_callback cb, void *cb_data);
1184 SR_PRIV int serial_source_remove(struct sr_session *session,
1185 struct sr_serial_dev_inst *serial);
1186 SR_PRIV GSList *sr_serial_find_usb(uint16_t vendor_id, uint16_t product_id);
1187 SR_PRIV int serial_timeout(struct sr_serial_dev_inst *port, int num_bytes);
1189 SR_PRIV void sr_ser_discard_queued_data(struct sr_serial_dev_inst *serial);
1190 SR_PRIV size_t sr_ser_has_queued_data(struct sr_serial_dev_inst *serial);
1191 SR_PRIV void sr_ser_queue_rx_data(struct sr_serial_dev_inst *serial,
1192 const uint8_t *data, size_t len);
1193 SR_PRIV size_t sr_ser_unqueue_rx_data(struct sr_serial_dev_inst *serial,
1194 uint8_t *data, size_t len);
1196 struct ser_lib_functions {
1197 int (*open)(struct sr_serial_dev_inst *serial, int flags);
1198 int (*close)(struct sr_serial_dev_inst *serial);
1199 int (*flush)(struct sr_serial_dev_inst *serial);
1200 int (*drain)(struct sr_serial_dev_inst *serial);
1201 int (*write)(struct sr_serial_dev_inst *serial,
1202 const void *buf, size_t count,
1203 int nonblocking, unsigned int timeout_ms);
1204 int (*read)(struct sr_serial_dev_inst *serial,
1205 void *buf, size_t count,
1206 int nonblocking, unsigned int timeout_ms);
1207 int (*set_params)(struct sr_serial_dev_inst *serial,
1208 int baudrate, int bits, int parity, int stopbits,
1209 int flowcontrol, int rts, int dtr);
1210 int (*setup_source_add)(struct sr_session *session,
1211 struct sr_serial_dev_inst *serial,
1212 int events, int timeout,
1213 sr_receive_data_callback cb, void *cb_data);
1214 int (*setup_source_remove)(struct sr_session *session,
1215 struct sr_serial_dev_inst *serial);
1216 GSList *(*list)(GSList *list, sr_ser_list_append_t append);
1217 GSList *(*find_usb)(GSList *list, sr_ser_find_append_t append,
1218 uint16_t vendor_id, uint16_t product_id);
1219 int (*get_frame_format)(struct sr_serial_dev_inst *serial,
1220 int *baud, int *bits);
1221 size_t (*get_rx_avail)(struct sr_serial_dev_inst *serial);
1223 extern SR_PRIV struct ser_lib_functions *ser_lib_funcs_libsp;
1224 SR_PRIV int ser_name_is_hid(struct sr_serial_dev_inst *serial);
1225 extern SR_PRIV struct ser_lib_functions *ser_lib_funcs_hid;
1226 SR_PRIV int ser_name_is_bt(struct sr_serial_dev_inst *serial);
1227 extern SR_PRIV struct ser_lib_functions *ser_lib_funcs_bt;
1229 #ifdef HAVE_LIBHIDAPI
1230 struct vid_pid_item {
1233 #define VID_PID_TERM ALL_ZERO
1235 struct ser_hid_chip_functions {
1236 const char *chipname;
1237 const char *chipdesc;
1238 const struct vid_pid_item *vid_pid_items;
1239 const int max_bytes_per_request;
1240 int (*set_params)(struct sr_serial_dev_inst *serial,
1241 int baudrate, int bits, int parity, int stopbits,
1242 int flowcontrol, int rts, int dtr);
1243 int (*read_bytes)(struct sr_serial_dev_inst *serial,
1244 uint8_t *data, int space, unsigned int timeout);
1245 int (*write_bytes)(struct sr_serial_dev_inst *serial,
1246 const uint8_t *data, int space);
1247 int (*flush)(struct sr_serial_dev_inst *serial);
1248 int (*drain)(struct sr_serial_dev_inst *serial);
1250 extern SR_PRIV struct ser_hid_chip_functions *ser_hid_chip_funcs_ch9325;
1251 extern SR_PRIV struct ser_hid_chip_functions *ser_hid_chip_funcs_cp2110;
1252 SR_PRIV const char *ser_hid_chip_find_name_vid_pid(uint16_t vid, uint16_t pid);
1256 /*--- bt/ API ---------------------------------------------------------------*/
1258 #ifdef HAVE_BLUETOOTH
1259 SR_PRIV const char *sr_bt_adapter_get_address(size_t idx);
1262 typedef void (*sr_bt_scan_cb)(void *cb_data, const char *addr, const char *name);
1263 typedef int (*sr_bt_data_cb)(void *cb_data, uint8_t *data, size_t dlen);
1265 SR_PRIV struct sr_bt_desc *sr_bt_desc_new(void);
1266 SR_PRIV void sr_bt_desc_free(struct sr_bt_desc *desc);
1268 SR_PRIV int sr_bt_config_cb_scan(struct sr_bt_desc *desc,
1269 sr_bt_scan_cb cb, void *cb_data);
1270 SR_PRIV int sr_bt_config_cb_data(struct sr_bt_desc *desc,
1271 sr_bt_data_cb cb, void *cb_data);
1272 SR_PRIV int sr_bt_config_addr_local(struct sr_bt_desc *desc, const char *addr);
1273 SR_PRIV int sr_bt_config_addr_remote(struct sr_bt_desc *desc, const char *addr);
1274 SR_PRIV int sr_bt_config_rfcomm(struct sr_bt_desc *desc, size_t channel);
1275 SR_PRIV int sr_bt_config_notify(struct sr_bt_desc *desc,
1276 uint16_t read_handle, uint16_t write_handle,
1277 uint16_t cccd_handle, uint16_t cccd_value);
1279 SR_PRIV int sr_bt_scan_le(struct sr_bt_desc *desc, int duration);
1280 SR_PRIV int sr_bt_scan_bt(struct sr_bt_desc *desc, int duration);
1282 SR_PRIV int sr_bt_connect_ble(struct sr_bt_desc *desc);
1283 SR_PRIV int sr_bt_connect_rfcomm(struct sr_bt_desc *desc);
1284 SR_PRIV void sr_bt_disconnect(struct sr_bt_desc *desc);
1286 SR_PRIV ssize_t sr_bt_read(struct sr_bt_desc *desc,
1287 void *data, size_t len);
1288 SR_PRIV ssize_t sr_bt_write(struct sr_bt_desc *desc,
1289 const void *data, size_t len);
1291 SR_PRIV int sr_bt_start_notify(struct sr_bt_desc *desc);
1292 SR_PRIV int sr_bt_check_notify(struct sr_bt_desc *desc);
1295 /*--- ezusb.c ---------------------------------------------------------------*/
1297 #ifdef HAVE_LIBUSB_1_0
1298 SR_PRIV int ezusb_reset(struct libusb_device_handle *hdl, int set_clear);
1299 SR_PRIV int ezusb_install_firmware(struct sr_context *ctx, libusb_device_handle *hdl,
1301 SR_PRIV int ezusb_upload_firmware(struct sr_context *ctx, libusb_device *dev,
1302 int configuration, const char *name);
1305 /*--- usb.c -----------------------------------------------------------------*/
1307 #ifdef HAVE_LIBUSB_1_0
1308 SR_PRIV GSList *sr_usb_find(libusb_context *usb_ctx, const char *conn);
1309 SR_PRIV int sr_usb_open(libusb_context *usb_ctx, struct sr_usb_dev_inst *usb);
1310 SR_PRIV void sr_usb_close(struct sr_usb_dev_inst *usb);
1311 SR_PRIV int usb_source_add(struct sr_session *session, struct sr_context *ctx,
1312 int timeout, sr_receive_data_callback cb, void *cb_data);
1313 SR_PRIV int usb_source_remove(struct sr_session *session, struct sr_context *ctx);
1314 SR_PRIV int usb_get_port_path(libusb_device *dev, char *path, int path_len);
1315 SR_PRIV gboolean usb_match_manuf_prod(libusb_device *dev,
1316 const char *manufacturer, const char *product);
1320 /*--- modbus/modbus.c -------------------------------------------------------*/
1322 struct sr_modbus_dev_inst {
1326 GSList *(*scan)(int modbusaddr);
1327 int (*dev_inst_new)(void *priv, const char *resource,
1328 char **params, const char *serialcomm, int modbusaddr);
1329 int (*open)(void *priv);
1330 int (*source_add)(struct sr_session *session, void *priv, int events,
1331 int timeout, sr_receive_data_callback cb, void *cb_data);
1332 int (*source_remove)(struct sr_session *session, void *priv);
1333 int (*send)(void *priv, const uint8_t *buffer, int buffer_size);
1334 int (*read_begin)(void *priv, uint8_t *function_code);
1335 int (*read_data)(void *priv, uint8_t *buf, int maxlen);
1336 int (*read_end)(void *priv);
1337 int (*close)(void *priv);
1338 void (*free)(void *priv);
1339 unsigned int read_timeout_ms;
1343 SR_PRIV GSList *sr_modbus_scan(struct drv_context *drvc, GSList *options,
1344 struct sr_dev_inst *(*probe_device)(struct sr_modbus_dev_inst *modbus));
1345 SR_PRIV struct sr_modbus_dev_inst *modbus_dev_inst_new(const char *resource,
1346 const char *serialcomm, int modbusaddr);
1347 SR_PRIV int sr_modbus_open(struct sr_modbus_dev_inst *modbus);
1348 SR_PRIV int sr_modbus_source_add(struct sr_session *session,
1349 struct sr_modbus_dev_inst *modbus, int events, int timeout,
1350 sr_receive_data_callback cb, void *cb_data);
1351 SR_PRIV int sr_modbus_source_remove(struct sr_session *session,
1352 struct sr_modbus_dev_inst *modbus);
1353 SR_PRIV int sr_modbus_request(struct sr_modbus_dev_inst *modbus,
1354 uint8_t *request, int request_size);
1355 SR_PRIV int sr_modbus_reply(struct sr_modbus_dev_inst *modbus,
1356 uint8_t *reply, int reply_size);
1357 SR_PRIV int sr_modbus_request_reply(struct sr_modbus_dev_inst *modbus,
1358 uint8_t *request, int request_size,
1359 uint8_t *reply, int reply_size);
1360 SR_PRIV int sr_modbus_read_coils(struct sr_modbus_dev_inst *modbus,
1361 int address, int nb_coils, uint8_t *coils);
1362 SR_PRIV int sr_modbus_read_holding_registers(struct sr_modbus_dev_inst *modbus,
1363 int address, int nb_registers,
1364 uint16_t *registers);
1365 SR_PRIV int sr_modbus_write_coil(struct sr_modbus_dev_inst *modbus,
1366 int address, int value);
1367 SR_PRIV int sr_modbus_write_multiple_registers(struct sr_modbus_dev_inst*modbus,
1368 int address, int nb_registers,
1369 uint16_t *registers);
1370 SR_PRIV int sr_modbus_close(struct sr_modbus_dev_inst *modbus);
1371 SR_PRIV void sr_modbus_free(struct sr_modbus_dev_inst *modbus);
1373 /*--- dmm/es519xx.c ---------------------------------------------------------*/
1376 * All 11-byte es519xx chips repeat each block twice for each conversion cycle
1377 * so always read 2 blocks at a time.
1379 #define ES519XX_11B_PACKET_SIZE (11 * 2)
1380 #define ES519XX_14B_PACKET_SIZE 14
1382 struct es519xx_info {
1383 gboolean is_judge, is_voltage, is_auto, is_micro, is_current;
1384 gboolean is_milli, is_resistance, is_continuity, is_diode;
1385 gboolean is_frequency, is_rpm, is_capacitance, is_duty_cycle;
1386 gboolean is_temperature, is_celsius, is_fahrenheit;
1387 gboolean is_adp0, is_adp1, is_adp2, is_adp3;
1388 gboolean is_sign, is_batt, is_ol, is_pmax, is_pmin, is_apo;
1389 gboolean is_dc, is_ac, is_vahz, is_min, is_max, is_rel, is_hold;
1390 gboolean is_digit4, is_ul, is_vasel, is_vbar, is_lpf1, is_lpf0, is_rmr;
1393 gboolean alt_functions, fivedigits, clampmeter, selectable_lpf;
1397 SR_PRIV gboolean sr_es519xx_2400_11b_packet_valid(const uint8_t *buf);
1398 SR_PRIV int sr_es519xx_2400_11b_parse(const uint8_t *buf, float *floatval,
1399 struct sr_datafeed_analog *analog, void *info);
1400 SR_PRIV gboolean sr_es519xx_2400_11b_altfn_packet_valid(const uint8_t *buf);
1401 SR_PRIV int sr_es519xx_2400_11b_altfn_parse(const uint8_t *buf,
1402 float *floatval, struct sr_datafeed_analog *analog, void *info);
1403 SR_PRIV gboolean sr_es519xx_19200_11b_5digits_packet_valid(const uint8_t *buf);
1404 SR_PRIV int sr_es519xx_19200_11b_5digits_parse(const uint8_t *buf,
1405 float *floatval, struct sr_datafeed_analog *analog, void *info);
1406 SR_PRIV gboolean sr_es519xx_19200_11b_clamp_packet_valid(const uint8_t *buf);
1407 SR_PRIV int sr_es519xx_19200_11b_clamp_parse(const uint8_t *buf,
1408 float *floatval, struct sr_datafeed_analog *analog, void *info);
1409 SR_PRIV gboolean sr_es519xx_19200_11b_packet_valid(const uint8_t *buf);
1410 SR_PRIV int sr_es519xx_19200_11b_parse(const uint8_t *buf, float *floatval,
1411 struct sr_datafeed_analog *analog, void *info);
1412 SR_PRIV gboolean sr_es519xx_19200_14b_packet_valid(const uint8_t *buf);
1413 SR_PRIV int sr_es519xx_19200_14b_parse(const uint8_t *buf, float *floatval,
1414 struct sr_datafeed_analog *analog, void *info);
1415 SR_PRIV gboolean sr_es519xx_19200_14b_sel_lpf_packet_valid(const uint8_t *buf);
1416 SR_PRIV int sr_es519xx_19200_14b_sel_lpf_parse(const uint8_t *buf,
1417 float *floatval, struct sr_datafeed_analog *analog, void *info);
1419 /*--- dmm/fs9922.c ----------------------------------------------------------*/
1421 #define FS9922_PACKET_SIZE 14
1423 struct fs9922_info {
1424 gboolean is_auto, is_dc, is_ac, is_rel, is_hold, is_bpn, is_z1, is_z2;
1425 gboolean is_max, is_min, is_apo, is_bat, is_nano, is_z3, is_micro;
1426 gboolean is_milli, is_kilo, is_mega, is_beep, is_diode, is_percent;
1427 gboolean is_z4, is_volt, is_ampere, is_ohm, is_hfe, is_hertz, is_farad;
1428 gboolean is_celsius, is_fahrenheit;
1429 int bargraph_sign, bargraph_value;
1432 SR_PRIV gboolean sr_fs9922_packet_valid(const uint8_t *buf);
1433 SR_PRIV int sr_fs9922_parse(const uint8_t *buf, float *floatval,
1434 struct sr_datafeed_analog *analog, void *info);
1435 SR_PRIV void sr_fs9922_z1_diode(struct sr_datafeed_analog *analog, void *info);
1437 /*--- dmm/fs9721.c ----------------------------------------------------------*/
1439 #define FS9721_PACKET_SIZE 14
1441 struct fs9721_info {
1442 gboolean is_ac, is_dc, is_auto, is_rs232, is_micro, is_nano, is_kilo;
1443 gboolean is_diode, is_milli, is_percent, is_mega, is_beep, is_farad;
1444 gboolean is_ohm, is_rel, is_hold, is_ampere, is_volt, is_hz, is_bat;
1445 gboolean is_c2c1_11, is_c2c1_10, is_c2c1_01, is_c2c1_00, is_sign;
1448 SR_PRIV gboolean sr_fs9721_packet_valid(const uint8_t *buf);
1449 SR_PRIV int sr_fs9721_parse(const uint8_t *buf, float *floatval,
1450 struct sr_datafeed_analog *analog, void *info);
1451 SR_PRIV void sr_fs9721_00_temp_c(struct sr_datafeed_analog *analog, void *info);
1452 SR_PRIV void sr_fs9721_01_temp_c(struct sr_datafeed_analog *analog, void *info);
1453 SR_PRIV void sr_fs9721_10_temp_c(struct sr_datafeed_analog *analog, void *info);
1454 SR_PRIV void sr_fs9721_01_10_temp_f_c(struct sr_datafeed_analog *analog, void *info);
1455 SR_PRIV void sr_fs9721_max_c_min(struct sr_datafeed_analog *analog, void *info);
1457 /*--- dmm/ms2115b.c ---------------------------------------------------------*/
1459 #define MS2115B_PACKET_SIZE 9
1461 enum ms2115b_display {
1462 MS2115B_DISPLAY_MAIN,
1463 MS2115B_DISPLAY_SUB,
1464 MS2115B_DISPLAY_COUNT,
1467 struct ms2115b_info {
1468 /* Selected channel. */
1470 gboolean is_ac, is_dc, is_auto;
1471 gboolean is_diode, is_beep, is_farad;
1472 gboolean is_ohm, is_ampere, is_volt, is_hz;
1473 gboolean is_duty_cycle, is_percent;
1476 extern SR_PRIV const char *ms2115b_channel_formats[];
1477 SR_PRIV gboolean sr_ms2115b_packet_valid(const uint8_t *buf);
1478 SR_PRIV int sr_ms2115b_parse(const uint8_t *buf, float *floatval,
1479 struct sr_datafeed_analog *analog, void *info);
1481 /*--- dmm/ms8250d.c ---------------------------------------------------------*/
1483 #define MS8250D_PACKET_SIZE 18
1485 struct ms8250d_info {
1486 gboolean is_ac, is_dc, is_auto, is_rs232, is_micro, is_nano, is_kilo;
1487 gboolean is_diode, is_milli, is_percent, is_mega, is_beep, is_farad;
1488 gboolean is_ohm, is_rel, is_hold, is_ampere, is_volt, is_hz, is_bat;
1489 gboolean is_ncv, is_min, is_max, is_sign, is_autotimer;
1492 SR_PRIV gboolean sr_ms8250d_packet_valid(const uint8_t *buf);
1493 SR_PRIV int sr_ms8250d_parse(const uint8_t *buf, float *floatval,
1494 struct sr_datafeed_analog *analog, void *info);
1496 /*--- dmm/dtm0660.c ---------------------------------------------------------*/
1498 #define DTM0660_PACKET_SIZE 15
1500 struct dtm0660_info {
1501 gboolean is_ac, is_dc, is_auto, is_rs232, is_micro, is_nano, is_kilo;
1502 gboolean is_diode, is_milli, is_percent, is_mega, is_beep, is_farad;
1503 gboolean is_ohm, is_rel, is_hold, is_ampere, is_volt, is_hz, is_bat;
1504 gboolean is_degf, is_degc, is_c2c1_01, is_c2c1_00, is_apo, is_min;
1505 gboolean is_minmax, is_max, is_sign;
1508 SR_PRIV gboolean sr_dtm0660_packet_valid(const uint8_t *buf);
1509 SR_PRIV int sr_dtm0660_parse(const uint8_t *buf, float *floatval,
1510 struct sr_datafeed_analog *analog, void *info);
1512 /*--- dmm/m2110.c -----------------------------------------------------------*/
1514 #define BBCGM_M2110_PACKET_SIZE 9
1516 /* Dummy info struct. The parser does not use it. */
1517 struct m2110_info { int dummy; };
1519 SR_PRIV gboolean sr_m2110_packet_valid(const uint8_t *buf);
1520 SR_PRIV int sr_m2110_parse(const uint8_t *buf, float *floatval,
1521 struct sr_datafeed_analog *analog, void *info);
1523 /*--- dmm/metex14.c ---------------------------------------------------------*/
1525 #define METEX14_PACKET_SIZE 14
1527 struct metex14_info {
1529 gboolean is_ac, is_dc, is_resistance, is_capacity, is_temperature;
1530 gboolean is_diode, is_frequency, is_ampere, is_volt, is_farad;
1531 gboolean is_hertz, is_ohm, is_celsius, is_fahrenheit, is_watt;
1532 gboolean is_pico, is_nano, is_micro, is_milli, is_kilo, is_mega;
1533 gboolean is_gain, is_decibel, is_power, is_decibel_mw, is_power_factor;
1534 gboolean is_hfe, is_unitless, is_logic, is_min, is_max, is_avg;
1537 #ifdef HAVE_SERIAL_COMM
1538 SR_PRIV int sr_metex14_packet_request(struct sr_serial_dev_inst *serial);
1540 SR_PRIV gboolean sr_metex14_packet_valid(const uint8_t *buf);
1541 SR_PRIV int sr_metex14_parse(const uint8_t *buf, float *floatval,
1542 struct sr_datafeed_analog *analog, void *info);
1543 SR_PRIV gboolean sr_metex14_4packets_valid(const uint8_t *buf);
1544 SR_PRIV int sr_metex14_4packets_parse(const uint8_t *buf, float *floatval,
1545 struct sr_datafeed_analog *analog, void *info);
1547 /*--- dmm/rs9lcd.c ----------------------------------------------------------*/
1549 #define RS9LCD_PACKET_SIZE 9
1551 /* Dummy info struct. The parser does not use it. */
1552 struct rs9lcd_info { int dummy; };
1554 SR_PRIV gboolean sr_rs9lcd_packet_valid(const uint8_t *buf);
1555 SR_PRIV int sr_rs9lcd_parse(const uint8_t *buf, float *floatval,
1556 struct sr_datafeed_analog *analog, void *info);
1558 /*--- dmm/bm25x.c -----------------------------------------------------------*/
1560 #define BRYMEN_BM25X_PACKET_SIZE 15
1562 /* Dummy info struct. The parser does not use it. */
1563 struct bm25x_info { int dummy; };
1565 SR_PRIV gboolean sr_brymen_bm25x_packet_valid(const uint8_t *buf);
1566 SR_PRIV int sr_brymen_bm25x_parse(const uint8_t *buf, float *floatval,
1567 struct sr_datafeed_analog *analog, void *info);
1569 /*--- dmm/ut71x.c -----------------------------------------------------------*/
1571 #define UT71X_PACKET_SIZE 11
1574 gboolean is_voltage, is_resistance, is_capacitance, is_temperature;
1575 gboolean is_celsius, is_fahrenheit, is_current, is_continuity;
1576 gboolean is_diode, is_frequency, is_duty_cycle, is_dc, is_ac;
1577 gboolean is_auto, is_manual, is_sign, is_power, is_loop_current;
1580 SR_PRIV gboolean sr_ut71x_packet_valid(const uint8_t *buf);
1581 SR_PRIV int sr_ut71x_parse(const uint8_t *buf, float *floatval,
1582 struct sr_datafeed_analog *analog, void *info);
1584 /*--- dmm/vc870.c -----------------------------------------------------------*/
1586 #define VC870_PACKET_SIZE 23
1589 gboolean is_voltage, is_dc, is_ac, is_temperature, is_resistance;
1590 gboolean is_continuity, is_capacitance, is_diode, is_loop_current;
1591 gboolean is_current, is_micro, is_milli, is_power;
1592 gboolean is_power_factor_freq, is_power_apparent_power, is_v_a_rms_value;
1593 gboolean is_sign2, is_sign1, is_batt, is_ol1, is_max, is_min;
1594 gboolean is_maxmin, is_rel, is_ol2, is_open, is_manu, is_hold;
1595 gboolean is_light, is_usb, is_warning, is_auto_power, is_misplug_warn;
1596 gboolean is_lo, is_hi, is_open2;
1598 gboolean is_frequency, is_dual_display, is_auto;
1601 SR_PRIV gboolean sr_vc870_packet_valid(const uint8_t *buf);
1602 SR_PRIV int sr_vc870_parse(const uint8_t *buf, float *floatval,
1603 struct sr_datafeed_analog *analog, void *info);
1605 /*--- dmm/vc96.c ------------------------------------------------------------*/
1607 #define VC96_PACKET_SIZE 13
1611 gboolean is_ac, is_dc, is_resistance, is_diode, is_ampere, is_volt;
1612 gboolean is_ohm, is_micro, is_milli, is_kilo, is_mega, is_hfe;
1613 gboolean is_unitless;
1616 SR_PRIV gboolean sr_vc96_packet_valid(const uint8_t *buf);
1617 SR_PRIV int sr_vc96_parse(const uint8_t *buf, float *floatval,
1618 struct sr_datafeed_analog *analog, void *info);
1620 /*--- lcr/es51919.c ---------------------------------------------------------*/
1622 SR_PRIV void es51919_serial_clean(void *priv);
1623 SR_PRIV struct sr_dev_inst *es51919_serial_scan(GSList *options,
1626 SR_PRIV int es51919_serial_config_get(uint32_t key, GVariant **data,
1627 const struct sr_dev_inst *sdi,
1628 const struct sr_channel_group *cg);
1629 SR_PRIV int es51919_serial_config_set(uint32_t key, GVariant *data,
1630 const struct sr_dev_inst *sdi,
1631 const struct sr_channel_group *cg);
1632 SR_PRIV int es51919_serial_config_list(uint32_t key, GVariant **data,
1633 const struct sr_dev_inst *sdi,
1634 const struct sr_channel_group *cg);
1635 SR_PRIV int es51919_serial_acquisition_start(const struct sr_dev_inst *sdi);
1636 SR_PRIV int es51919_serial_acquisition_stop(struct sr_dev_inst *sdi);
1638 /*--- dmm/ut372.c -----------------------------------------------------------*/
1640 #define UT372_PACKET_SIZE 27
1646 SR_PRIV gboolean sr_ut372_packet_valid(const uint8_t *buf);
1647 SR_PRIV int sr_ut372_parse(const uint8_t *buf, float *floatval,
1648 struct sr_datafeed_analog *analog, void *info);
1650 /*--- dmm/asycii.c ----------------------------------------------------------*/
1652 #define ASYCII_PACKET_SIZE 16
1654 struct asycii_info {
1655 gboolean is_ac, is_dc, is_ac_and_dc;
1656 gboolean is_resistance, is_capacitance, is_diode, is_gain;
1657 gboolean is_frequency, is_duty_cycle, is_duty_pos, is_duty_neg;
1658 gboolean is_pulse_width, is_period_pos, is_period_neg;
1659 gboolean is_pulse_count, is_count_pos, is_count_neg;
1660 gboolean is_ampere, is_volt, is_volt_ampere, is_farad, is_ohm;
1661 gboolean is_hertz, is_percent, is_seconds, is_decibel;
1662 gboolean is_pico, is_nano, is_micro, is_milli, is_kilo, is_mega;
1663 gboolean is_unitless;
1664 gboolean is_peak_min, is_peak_max;
1665 gboolean is_invalid;
1668 #ifdef HAVE_SERIAL_COMM
1669 SR_PRIV int sr_asycii_packet_request(struct sr_serial_dev_inst *serial);
1671 SR_PRIV gboolean sr_asycii_packet_valid(const uint8_t *buf);
1672 SR_PRIV int sr_asycii_parse(const uint8_t *buf, float *floatval,
1673 struct sr_datafeed_analog *analog, void *info);
1675 /*--- dmm/eev121gw.c --------------------------------------------------------*/
1677 #define EEV121GW_PACKET_SIZE 19
1679 enum eev121gw_display {
1680 EEV121GW_DISPLAY_MAIN,
1681 EEV121GW_DISPLAY_SUB,
1682 EEV121GW_DISPLAY_BAR,
1683 EEV121GW_DISPLAY_COUNT,
1686 struct eev121gw_info {
1687 /* Selected channel. */
1690 * Measured value, number and sign/overflow flags, scale factor
1691 * and significant digits.
1693 uint32_t uint_value;
1694 gboolean is_ofl, is_neg;
1696 /* Currently active mode (meter's function). */
1697 gboolean is_ac, is_dc, is_voltage, is_current, is_power, is_gain;
1698 gboolean is_resistance, is_capacitance, is_diode, is_temperature;
1699 gboolean is_continuity, is_frequency, is_period, is_duty_cycle;
1700 /* Quantities associated with mode/function. */
1701 gboolean is_ampere, is_volt, is_volt_ampere, is_dbm;
1702 gboolean is_ohm, is_farad, is_celsius, is_fahrenheit;
1703 gboolean is_hertz, is_seconds, is_percent, is_loop_current;
1704 gboolean is_unitless, is_logic;
1705 /* Other indicators. */
1706 gboolean is_min, is_max, is_avg, is_1ms_peak, is_rel, is_hold;
1707 gboolean is_low_pass, is_mem, is_bt, is_auto_range, is_test;
1708 gboolean is_auto_poweroff, is_low_batt;
1711 extern SR_PRIV const char *eev121gw_channel_formats[];
1712 SR_PRIV gboolean sr_eev121gw_packet_valid(const uint8_t *buf);
1713 SR_PRIV int sr_eev121gw_parse(const uint8_t *buf, float *floatval,
1714 struct sr_datafeed_analog *analog, void *info);
1715 SR_PRIV int sr_eev121gw_3displays_parse(const uint8_t *buf, float *floatval,
1716 struct sr_datafeed_analog *analog, void *info);
1718 /*--- scale/kern.c ----------------------------------------------------------*/
1721 gboolean is_gram, is_carat, is_ounce, is_pound, is_troy_ounce;
1722 gboolean is_pennyweight, is_grain, is_tael, is_momme, is_tola;
1723 gboolean is_percentage, is_piece, is_unstable, is_stable, is_error;
1727 SR_PRIV gboolean sr_kern_packet_valid(const uint8_t *buf);
1728 SR_PRIV int sr_kern_parse(const uint8_t *buf, float *floatval,
1729 struct sr_datafeed_analog *analog, void *info);
1731 /*--- sw_limits.c -----------------------------------------------------------*/
1733 struct sr_sw_limits {
1734 uint64_t limit_samples;
1735 uint64_t limit_frames;
1736 uint64_t limit_msec;
1737 uint64_t samples_read;
1738 uint64_t frames_read;
1739 uint64_t start_time;
1742 SR_PRIV int sr_sw_limits_config_get(struct sr_sw_limits *limits, uint32_t key,
1744 SR_PRIV int sr_sw_limits_config_set(struct sr_sw_limits *limits, uint32_t key,
1746 SR_PRIV void sr_sw_limits_acquisition_start(struct sr_sw_limits *limits);
1747 SR_PRIV gboolean sr_sw_limits_check(struct sr_sw_limits *limits);
1748 SR_PRIV void sr_sw_limits_update_samples_read(struct sr_sw_limits *limits,
1749 uint64_t samples_read);
1750 SR_PRIV void sr_sw_limits_update_frames_read(struct sr_sw_limits *limits,
1751 uint64_t frames_read);
1752 SR_PRIV void sr_sw_limits_init(struct sr_sw_limits *limits);