]> sigrok.org Git - libsigrok.git/blob - src/libsigrok-internal.h
lcr/vc4080: introduce LCR packet parser for Voltcraft 4080 (and PeakTech 2165)
[libsigrok.git] / src / libsigrok-internal.h
1 /*
2  * This file is part of the libsigrok project.
3  *
4  * Copyright (C) 2013 Bert Vermeulen <bert@biot.com>
5  *
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.
10  *
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.
15  *
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/>.
18  */
19
20 /**
21  * @file
22  *
23  * @internal
24  */
25
26 #ifndef LIBSIGROK_LIBSIGROK_INTERNAL_H
27 #define LIBSIGROK_LIBSIGROK_INTERNAL_H
28
29 #include "config.h"
30
31 #include <glib.h>
32 #ifdef HAVE_LIBHIDAPI
33 #include <hidapi.h>
34 #endif
35 #ifdef HAVE_LIBSERIALPORT
36 #include <libserialport.h>
37 #endif
38 #ifdef HAVE_LIBUSB_1_0
39 #include <libusb.h>
40 #endif
41 #include <stdarg.h>
42 #include <stdint.h>
43 #include <stdio.h>
44 #include <stdlib.h>
45
46 struct zip;
47 struct zip_stat;
48
49 /**
50  * @file
51  *
52  * libsigrok private header file, only to be used internally.
53  */
54
55 /*--- Macros ----------------------------------------------------------------*/
56
57 #ifndef ARRAY_SIZE
58 #define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0]))
59 #endif
60
61 #ifndef ARRAY_AND_SIZE
62 #define ARRAY_AND_SIZE(a) (a), ARRAY_SIZE(a)
63 #endif
64
65 /**
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
69  */
70 #define R8(x)     ((unsigned)((const uint8_t*)(x))[0])
71
72 /**
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
76  */
77 #define RB16(x)  (((unsigned)((const uint8_t*)(x))[0] <<  8) | \
78                    (unsigned)((const uint8_t*)(x))[1])
79
80 /**
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
84  */
85 #define RL16(x)  (((unsigned)((const uint8_t*)(x))[1] <<  8) | \
86                    (unsigned)((const uint8_t*)(x))[0])
87
88 /**
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
92  */
93 #define RB16S(x)  ((int16_t) \
94                   (((unsigned)((const uint8_t*)(x))[0] <<  8) | \
95                     (unsigned)((const uint8_t*)(x))[1]))
96
97 /**
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
101  */
102 #define RL16S(x)  ((int16_t) \
103                   (((unsigned)((const uint8_t*)(x))[1] <<  8) | \
104                     (unsigned)((const uint8_t*)(x))[0]))
105
106 /**
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
110  */
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])
115
116 /**
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
120  */
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])
125
126 /**
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
130  */
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]))
136
137 /**
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
141  */
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]))
147
148 /**
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
152  */
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])
161
162 /**
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
166  */
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])
175
176 /**
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
180  */
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]))
190
191 /**
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
195  */
196 #define RBFL(x)  ((union { uint32_t u; float f; }) { .u = RB32(x) }.f)
197
198 /**
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
202  */
203 #define RLFL(x)  ((union { uint32_t u; float f; }) { .u = RL32(x) }.f)
204
205 /**
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
209  */
210 #define W8(p, x)    do { ((uint8_t*)(p))[0] = (uint8_t) (x);      } while (0)
211
212 /**
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
216  */
217 #define WB16(p, x)  do { ((uint8_t*)(p))[1] = (uint8_t) (x);      \
218                          ((uint8_t*)(p))[0] = (uint8_t)((x)>>8);  } while (0)
219
220 /**
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
224  */
225 #define WL16(p, x)  do { ((uint8_t*)(p))[0] = (uint8_t) (x);      \
226                          ((uint8_t*)(p))[1] = (uint8_t)((x)>>8);  } while (0)
227
228 /**
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
232  */
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)
237
238 /**
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
242  */
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)
247
248 /**
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
252  */
253 #define WBFL(p, x)  WB32(p, (union { uint32_t u; float f; }) { .f = x }.u)
254
255 /**
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
259  */
260 #define WLFL(p, x)  WL32(p, (union { uint32_t u; float f; }) { .f = x }.u)
261
262 /* Portability fixes for FreeBSD. */
263 #ifdef __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)
268 #endif
269
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 { } */
273 #ifdef __clang__
274 #define ALL_ZERO { }
275 #else
276 #define ALL_ZERO { 0 }
277 #endif
278
279 #ifdef __APPLE__
280 #define SR_DRIVER_LIST_SECTION "__DATA,__sr_driver_list"
281 #else
282 #define SR_DRIVER_LIST_SECTION "sr_driver_list"
283 #endif
284
285 /**
286  * Register a list of hardware drivers.
287  *
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.
291  *
292  * For registering only a single driver see SR_REGISTER_DEV_DRIVER().
293  *
294  * Example:
295  * @code{c}
296  * #define MY_DRIVER(_name) \
297  *     &(struct sr_dev_driver){ \
298  *         .name = _name, \
299  *         ...
300  *     };
301  *
302  * SR_REGISTER_DEV_DRIVER_LIST(my_driver_infos,
303  *     MY_DRIVER("driver 1"),
304  *     MY_DRIVER("driver 2"),
305  *     ...
306  * );
307  * @endcode
308  *
309  * @param name Name to use for the driver list identifier.
310  * @param ... Comma separated list of pointers to sr_dev_driver structs.
311  */
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 *)))) \
316                 = { \
317                         __VA_ARGS__ \
318                 };
319
320 /**
321  * Register a hardware driver.
322  *
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
325  * library.
326  *
327  * The macro invocation should be placed directly under the struct
328  * sr_dev_driver definition.
329  *
330  * Example:
331  * @code{c}
332  * static struct sr_dev_driver driver_info = {
333  *     .name = "driver",
334  *     ....
335  * };
336  * SR_REGISTER_DEV_DRIVER(driver_info);
337  * @endcode
338  *
339  * @param name Identifier name of sr_dev_driver struct to register.
340  */
341 #define SR_REGISTER_DEV_DRIVER(name) \
342         SR_REGISTER_DEV_DRIVER_LIST(name##_list, &name);
343
344 SR_API void sr_drivers_init(struct sr_context *context);
345
346 struct sr_context {
347         struct sr_dev_driver **driver_list;
348 #ifdef HAVE_LIBUSB_1_0
349         libusb_context *libusb_ctx;
350 #endif
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;
355 };
356
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,
365
366         /** The module cannot identify a file without this metadata. */
367         SR_INPUT_META_REQUIRED = 0x80,
368 };
369
370 /** Input (file) module struct. */
371 struct sr_input {
372         /**
373          * A pointer to this input module's 'struct sr_input_module'.
374          */
375         const struct sr_input_module *module;
376         GString *buf;
377         struct sr_dev_inst *sdi;
378         gboolean sdi_ready;
379         void *priv;
380 };
381
382 /** Input (file) module driver. */
383 struct sr_input_module {
384         /**
385          * A unique ID for this input module, suitable for use in command-line
386          * clients, [a-z0-9-]. Must not be NULL.
387          */
388         const char *id;
389
390         /**
391          * A unique name for this input module, suitable for use in GUI
392          * clients, can contain UTF-8. Must not be NULL.
393          */
394         const char *name;
395
396         /**
397          * A short description of the input module. Must not be NULL.
398          *
399          * This can be displayed by frontends, e.g. when selecting the input
400          * module for saving a file.
401          */
402         const char *desc;
403
404         /**
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.
408          */
409         const char *const *exts;
410
411         /**
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.
415          *
416          * Each item is one of:
417          *   SR_INPUT_META_FILENAME
418          *   SR_INPUT_META_FILESIZE
419          *   SR_INPUT_META_HEADER
420          *
421          * If the high bit (SR_INPUT META_REQUIRED) is set, the module cannot
422          * identify a stream without the given metadata.
423          */
424         const uint8_t metadata[8];
425
426         /**
427          * Returns a NULL-terminated list of options this module can take.
428          * Can be NULL, if the module has no options.
429          */
430         const struct sr_option *(*options) (void);
431
432         /**
433          * Check if this input module can load and parse the specified stream.
434          *
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.
438          *
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.
446          *
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.
453          */
454         int (*format_match) (GHashTable *metadata, unsigned int *confidence);
455
456         /**
457          * Initialize the input module.
458          *
459          * @retval SR_OK Success
460          * @retval other Negative error code.
461          */
462         int (*init) (struct sr_input *in, GHashTable *options);
463
464         /**
465          * Send data to the specified input instance.
466          *
467          * When an input module instance is created with sr_input_new(), this
468          * function is used to feed data to the instance.
469          *
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
474          * and so on.
475          *
476          * @retval SR_OK Success
477          * @retval other Negative error code.
478          */
479         int (*receive) (struct sr_input *in, GString *buf);
480
481         /**
482          * Signal the input module no more data will come.
483          *
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.
486          */
487         int (*end) (struct sr_input *in);
488
489         /**
490          * Reset the input module's input handling structures.
491          *
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.
495          *
496          * @retval SR_OK Success.
497          * @retval other Negative error code.
498          */
499         int (*reset) (struct sr_input *in);
500
501         /**
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.
505          *
506          * This function is optional.
507          *
508          * @retval SR_OK Success
509          * @retval other Negative error code.
510          */
511         void (*cleanup) (struct sr_input *in);
512 };
513
514 /** Output module instance. */
515 struct sr_output {
516         /** A pointer to this output's module. */
517         const struct sr_output_module *module;
518
519         /**
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.
522          */
523         const struct sr_dev_inst *sdi;
524
525         /**
526          * The name of the file that the data should be written to.
527          */
528         const char *filename;
529
530         /**
531          * A generic pointer which can be used by the module to keep internal
532          * state between calls into its callback functions.
533          *
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.
536          */
537         void *priv;
538 };
539
540 /** Output module driver. */
541 struct sr_output_module {
542         /**
543          * A unique ID for this output module, suitable for use in command-line
544          * clients, [a-z0-9-]. Must not be NULL.
545          */
546         const char *id;
547
548         /**
549          * A unique name for this output module, suitable for use in GUI
550          * clients, can contain UTF-8. Must not be NULL.
551          */
552         const char *name;
553
554         /**
555          * A short description of the output module. Must not be NULL.
556          *
557          * This can be displayed by frontends, e.g. when selecting the output
558          * module for saving a file.
559          */
560         const char *desc;
561
562         /**
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.
566          */
567         const char *const *exts;
568
569         /**
570          * Bitfield containing flags that describe certain properties
571          * this output module may or may not have.
572          * @see sr_output_flags
573          */
574         const uint64_t flags;
575
576         /**
577          * Returns a NULL-terminated list of options this module can take.
578          * Can be NULL, if the module has no options.
579          */
580         const struct sr_option *(*options) (void);
581
582         /**
583          * This function is called once, at the beginning of an output stream.
584          *
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.
588          *
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.
591          *
592          * @param o Pointer to the respective 'struct sr_output'.
593          *
594          * @retval SR_OK Success
595          * @retval other Negative error code.
596          */
597         int (*init) (struct sr_output *o, GHashTable *options);
598
599         /**
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.
604          *
605          * Packets not of interest to the output module can just be ignored,
606          * and the <code>out</code> parameter set to NULL.
607          *
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.
613          *
614          * @retval SR_OK Success
615          * @retval other Negative error code.
616          */
617         int (*receive) (const struct sr_output *o,
618                         const struct sr_datafeed_packet *packet, GString **out);
619
620         /**
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.
624          *
625          * @retval SR_OK Success
626          * @retval other Negative error code.
627          */
628         int (*cleanup) (struct sr_output *o);
629 };
630
631 /** Transform module instance. */
632 struct sr_transform {
633         /** A pointer to this transform's module. */
634         const struct sr_transform_module *module;
635
636         /**
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.
639          */
640         const struct sr_dev_inst *sdi;
641
642         /**
643          * A generic pointer which can be used by the module to keep internal
644          * state between calls into its callback functions.
645          */
646         void *priv;
647 };
648
649 struct sr_transform_module {
650         /**
651          * A unique ID for this transform module, suitable for use in
652          * command-line clients, [a-z0-9-]. Must not be NULL.
653          */
654         const char *id;
655
656         /**
657          * A unique name for this transform module, suitable for use in GUI
658          * clients, can contain UTF-8. Must not be NULL.
659          */
660         const char *name;
661
662         /**
663          * A short description of the transform module. Must not be NULL.
664          *
665          * This can be displayed by frontends, e.g. when selecting
666          * which transform module(s) to add.
667          */
668         const char *desc;
669
670         /**
671          * Returns a NULL-terminated list of options this transform module
672          * can take. Can be NULL, if the transform module has no options.
673          */
674         const struct sr_option *(*options) (void);
675
676         /**
677          * This function is called once, at the beginning of a stream.
678          *
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.
682          *
683          * @retval SR_OK Success
684          * @retval other Negative error code.
685          */
686         int (*init) (struct sr_transform *t, GHashTable *options);
687
688         /**
689          * This function is passed a pointer to every packet in the data feed.
690          *
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.
693          *
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.
699          *
700          * @retval SR_OK Success
701          * @retval other Negative error code.
702          */
703         int (*receive) (const struct sr_transform *t,
704                         struct sr_datafeed_packet *packet_in,
705                         struct sr_datafeed_packet **packet_out);
706
707         /**
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.
711          *
712          * @retval SR_OK Success
713          * @retval other Negative error code.
714          */
715         int (*cleanup) (struct sr_transform *t);
716 };
717
718 #ifdef HAVE_LIBUSB_1_0
719 /** USB device instance */
720 struct sr_usb_dev_inst {
721         /** USB bus */
722         uint8_t bus;
723         /** Device address on USB bus */
724         uint8_t address;
725         /** libusb device handle */
726         struct libusb_device_handle *devhdl;
727 };
728 #endif
729
730 struct sr_serial_dev_inst;
731 #ifdef HAVE_SERIAL_COMM
732 struct ser_lib_functions;
733 struct ser_hid_chip_functions;
734 struct sr_bt_desc;
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'. */
739         char *port;
740         /** Comm params for serial_set_paramstr(). */
741         char *serialcomm;
742         struct ser_lib_functions *lib_funcs;
743         struct {
744                 int bit_rate;
745                 int data_bits;
746                 int parity_bits;
747                 int stop_bits;
748         } comm_params;
749         GString *rcv_buffer;
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;
755 #endif
756 #ifdef HAVE_LIBHIDAPI
757         enum ser_hid_chip_t {
758                 SER_HID_CHIP_UNKNOWN,           /**!< place holder */
759                 SER_HID_CHIP_BTC_BU86X,         /**!< Brymen BU86x */
760                 SER_HID_CHIP_SIL_CP2110,        /**!< SiLabs CP2110 */
761                 SER_HID_CHIP_VICTOR_DMM,        /**!< Victor 70/86 DMM cable */
762                 SER_HID_CHIP_WCH_CH9325,        /**!< WCH CH9325 */
763                 SER_HID_CHIP_LAST,              /**!< sentinel */
764         } hid_chip;
765         struct ser_hid_chip_functions *hid_chip_funcs;
766         char *usb_path;
767         char *usb_serno;
768         const char *hid_path;
769         hid_device *hid_dev;
770         GSList *hid_source_args;
771 #endif
772 #ifdef HAVE_BLUETOOTH
773         enum ser_bt_conn_t {
774                 SER_BT_CONN_UNKNOWN,    /**!< place holder */
775                 SER_BT_CONN_RFCOMM,     /**!< BT classic, RFCOMM channel */
776                 SER_BT_CONN_BLE122,     /**!< BLE, BLE122 module, indications */
777                 SER_BT_CONN_NRF51,      /**!< BLE, Nordic nRF51, notifications */
778                 SER_BT_CONN_CC254x,     /**!< BLE, TI CC254x, notifications */
779                 SER_BT_CONN_MAX,        /**!< sentinel */
780         } bt_conn_type;
781         char *bt_addr_local;
782         char *bt_addr_remote;
783         size_t bt_rfcomm_channel;
784         uint16_t bt_notify_handle_read;
785         uint16_t bt_notify_handle_write;
786         uint16_t bt_notify_handle_cccd;
787         uint16_t bt_notify_value_cccd;
788         struct sr_bt_desc *bt_desc;
789         GSList *bt_source_args;
790 #endif
791 };
792 #endif
793
794 struct sr_usbtmc_dev_inst {
795         char *device;
796         int fd;
797 };
798
799 /* Private driver context. */
800 struct drv_context {
801         /** sigrok context */
802         struct sr_context *sr_ctx;
803         GSList *instances;
804 };
805
806 /*--- log.c -----------------------------------------------------------------*/
807
808 #if defined(_WIN32) && (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 4))
809 /*
810  * On MinGW, we need to specify the gnu_printf format flavor or GCC
811  * will assume non-standard Microsoft printf syntax.
812  */
813 SR_PRIV int sr_log(int loglevel, const char *format, ...)
814                 __attribute__((__format__ (__gnu_printf__, 2, 3)));
815 #else
816 SR_PRIV int sr_log(int loglevel, const char *format, ...) G_GNUC_PRINTF(2, 3);
817 #endif
818
819 /* Message logging helpers with subsystem-specific prefix string. */
820 #define sr_spew(...)    sr_log(SR_LOG_SPEW, LOG_PREFIX ": " __VA_ARGS__)
821 #define sr_dbg(...)     sr_log(SR_LOG_DBG,  LOG_PREFIX ": " __VA_ARGS__)
822 #define sr_info(...)    sr_log(SR_LOG_INFO, LOG_PREFIX ": " __VA_ARGS__)
823 #define sr_warn(...)    sr_log(SR_LOG_WARN, LOG_PREFIX ": " __VA_ARGS__)
824 #define sr_err(...)     sr_log(SR_LOG_ERR,  LOG_PREFIX ": " __VA_ARGS__)
825
826 /*--- device.c --------------------------------------------------------------*/
827
828 /** Scan options supported by a driver. */
829 #define SR_CONF_SCAN_OPTIONS 0x7FFF0000
830
831 /** Device options for a particular device. */
832 #define SR_CONF_DEVICE_OPTIONS 0x7FFF0001
833
834 /** Mask for separating config keys from capabilities. */
835 #define SR_CONF_MASK 0x1fffffff
836
837 /** Values for the changes argument of sr_dev_driver.config_channel_set. */
838 enum {
839         /** The enabled state of the channel has been changed. */
840         SR_CHANNEL_SET_ENABLED = 1 << 0,
841 };
842
843 SR_PRIV struct sr_channel *sr_channel_new(struct sr_dev_inst *sdi,
844                 int index, int type, gboolean enabled, const char *name);
845 SR_PRIV void sr_channel_free(struct sr_channel *ch);
846 SR_PRIV void sr_channel_free_cb(void *p);
847 SR_PRIV struct sr_channel *sr_next_enabled_channel(const struct sr_dev_inst *sdi,
848                 struct sr_channel *cur_channel);
849 SR_PRIV gboolean sr_channels_differ(struct sr_channel *ch1, struct sr_channel *ch2);
850 SR_PRIV gboolean sr_channel_lists_differ(GSList *l1, GSList *l2);
851
852 /** Device instance data */
853 struct sr_dev_inst {
854         /** Device driver. */
855         struct sr_dev_driver *driver;
856         /** Device instance status. SR_ST_NOT_FOUND, etc. */
857         int status;
858         /** Device instance type. SR_INST_USB, etc. */
859         int inst_type;
860         /** Device vendor. */
861         char *vendor;
862         /** Device model. */
863         char *model;
864         /** Device version. */
865         char *version;
866         /** Serial number. */
867         char *serial_num;
868         /** Connection string to uniquely identify devices. */
869         char *connection_id;
870         /** List of channels. */
871         GSList *channels;
872         /** List of sr_channel_group structs */
873         GSList *channel_groups;
874         /** Device instance connection data (used?) */
875         void *conn;
876         /** Device instance private data (used?) */
877         void *priv;
878         /** Session to which this device is currently assigned. */
879         struct sr_session *session;
880 };
881
882 /* Generic device instances */
883 SR_PRIV void sr_dev_inst_free(struct sr_dev_inst *sdi);
884
885 #ifdef HAVE_LIBUSB_1_0
886 /* USB-specific instances */
887 SR_PRIV struct sr_usb_dev_inst *sr_usb_dev_inst_new(uint8_t bus,
888                 uint8_t address, struct libusb_device_handle *hdl);
889 SR_PRIV void sr_usb_dev_inst_free(struct sr_usb_dev_inst *usb);
890 #endif
891
892 #ifdef HAVE_SERIAL_COMM
893 #ifndef HAVE_LIBSERIALPORT
894 /*
895  * Some identifiers which initially got provided by libserialport are
896  * used internally within the libsigrok serial layer's implementation,
897  * while libserialport no longer is the exclusive provider of serial
898  * communication support. Declare the identifiers here so they remain
899  * available across all build configurations.
900  */
901 enum libsp_parity {
902         SP_PARITY_NONE = 0,
903         SP_PARITY_ODD = 1,
904         SP_PARITY_EVEN = 2,
905         SP_PARITY_MARK = 3,
906         SP_PARITY_SPACE = 4,
907 };
908
909 enum libsp_flowcontrol {
910         SP_FLOWCONTROL_NONE = 0,
911         SP_FLOWCONTROL_XONXOFF = 1,
912         SP_FLOWCONTROL_RTSCTS = 2,
913         SP_FLOWCONTROL_DTRDSR = 3,
914 };
915 #endif
916
917 /* Serial-specific instances */
918 SR_PRIV struct sr_serial_dev_inst *sr_serial_dev_inst_new(const char *port,
919                 const char *serialcomm);
920 SR_PRIV void sr_serial_dev_inst_free(struct sr_serial_dev_inst *serial);
921 #endif
922
923 /* USBTMC-specific instances */
924 SR_PRIV struct sr_usbtmc_dev_inst *sr_usbtmc_dev_inst_new(const char *device);
925 SR_PRIV void sr_usbtmc_dev_inst_free(struct sr_usbtmc_dev_inst *usbtmc);
926
927 /*--- hwdriver.c ------------------------------------------------------------*/
928
929 SR_PRIV const GVariantType *sr_variant_type_get(int datatype);
930 SR_PRIV int sr_variant_type_check(uint32_t key, GVariant *data);
931 SR_PRIV void sr_hw_cleanup_all(const struct sr_context *ctx);
932 SR_PRIV struct sr_config *sr_config_new(uint32_t key, GVariant *data);
933 SR_PRIV void sr_config_free(struct sr_config *src);
934 SR_PRIV int sr_dev_acquisition_start(struct sr_dev_inst *sdi);
935 SR_PRIV int sr_dev_acquisition_stop(struct sr_dev_inst *sdi);
936
937 /*--- session.c -------------------------------------------------------------*/
938
939 struct sr_session {
940         /** Context this session exists in. */
941         struct sr_context *ctx;
942         /** List of struct sr_dev_inst pointers. */
943         GSList *devs;
944         /** List of struct sr_dev_inst pointers owned by this session. */
945         GSList *owned_devs;
946         /** List of struct datafeed_callback pointers. */
947         GSList *datafeed_callbacks;
948         GSList *transforms;
949         struct sr_trigger *trigger;
950
951         /** Callback to invoke on session stop. */
952         sr_session_stopped_callback stopped_callback;
953         /** User data to be passed to the session stop callback. */
954         void *stopped_cb_data;
955
956         /** Mutex protecting the main context pointer. */
957         GMutex main_mutex;
958         /** Context of the session main loop. */
959         GMainContext *main_context;
960
961         /** Registered event sources for this session. */
962         GHashTable *event_sources;
963         /** Session main loop. */
964         GMainLoop *main_loop;
965         /** ID of idle source for dispatching the session stop notification. */
966         unsigned int stop_check_id;
967         /** Whether the session has been started. */
968         gboolean running;
969 };
970
971 SR_PRIV int sr_session_source_add_internal(struct sr_session *session,
972                 void *key, GSource *source);
973 SR_PRIV int sr_session_source_remove_internal(struct sr_session *session,
974                 void *key);
975 SR_PRIV int sr_session_source_destroyed(struct sr_session *session,
976                 void *key, GSource *source);
977 SR_PRIV int sr_session_fd_source_add(struct sr_session *session,
978                 void *key, gintptr fd, int events, int timeout,
979                 sr_receive_data_callback cb, void *cb_data);
980
981 SR_PRIV int sr_session_source_add(struct sr_session *session, int fd,
982                 int events, int timeout, sr_receive_data_callback cb, void *cb_data);
983 SR_PRIV int sr_session_source_add_pollfd(struct sr_session *session,
984                 GPollFD *pollfd, int timeout, sr_receive_data_callback cb,
985                 void *cb_data);
986 SR_PRIV int sr_session_source_add_channel(struct sr_session *session,
987                 GIOChannel *channel, int events, int timeout,
988                 sr_receive_data_callback cb, void *cb_data);
989 SR_PRIV int sr_session_source_remove(struct sr_session *session, int fd);
990 SR_PRIV int sr_session_source_remove_pollfd(struct sr_session *session,
991                 GPollFD *pollfd);
992 SR_PRIV int sr_session_source_remove_channel(struct sr_session *session,
993                 GIOChannel *channel);
994
995 SR_PRIV int sr_session_send_meta(const struct sr_dev_inst *sdi,
996                 uint32_t key, GVariant *var);
997 SR_PRIV int sr_session_send(const struct sr_dev_inst *sdi,
998                 const struct sr_datafeed_packet *packet);
999 SR_PRIV int sr_sessionfile_check(const char *filename);
1000 SR_PRIV struct sr_dev_inst *sr_session_prepare_sdi(const char *filename,
1001                 struct sr_session **session);
1002
1003 /*--- session_file.c --------------------------------------------------------*/
1004
1005 #if !HAVE_ZIP_DISCARD
1006 /* Replace zip_discard() if not available. */
1007 #define zip_discard(zip) sr_zip_discard(zip)
1008 SR_PRIV void sr_zip_discard(struct zip *archive);
1009 #endif
1010
1011 SR_PRIV GKeyFile *sr_sessionfile_read_metadata(struct zip *archive,
1012                         const struct zip_stat *entry);
1013
1014 /*--- analog.c --------------------------------------------------------------*/
1015
1016 SR_PRIV int sr_analog_init(struct sr_datafeed_analog *analog,
1017                            struct sr_analog_encoding *encoding,
1018                            struct sr_analog_meaning *meaning,
1019                            struct sr_analog_spec *spec,
1020                            int digits);
1021
1022 /*--- std.c -----------------------------------------------------------------*/
1023
1024 typedef int (*dev_close_callback)(struct sr_dev_inst *sdi);
1025 typedef void (*std_dev_clear_callback)(void *priv);
1026
1027 SR_PRIV int std_init(struct sr_dev_driver *di, struct sr_context *sr_ctx);
1028 SR_PRIV int std_cleanup(const struct sr_dev_driver *di);
1029 SR_PRIV int std_dummy_dev_open(struct sr_dev_inst *sdi);
1030 SR_PRIV int std_dummy_dev_close(struct sr_dev_inst *sdi);
1031 SR_PRIV int std_dummy_dev_acquisition_start(const struct sr_dev_inst *sdi);
1032 SR_PRIV int std_dummy_dev_acquisition_stop(struct sr_dev_inst *sdi);
1033 #ifdef HAVE_SERIAL_COMM
1034 SR_PRIV int std_serial_dev_open(struct sr_dev_inst *sdi);
1035 SR_PRIV int std_serial_dev_acquisition_stop(struct sr_dev_inst *sdi);
1036 #endif
1037 SR_PRIV int std_session_send_df_header(const struct sr_dev_inst *sdi);
1038 SR_PRIV int std_session_send_df_end(const struct sr_dev_inst *sdi);
1039 SR_PRIV int std_session_send_frame_begin(const struct sr_dev_inst *sdi);
1040 SR_PRIV int std_session_send_frame_end(const struct sr_dev_inst *sdi);
1041 SR_PRIV int std_dev_clear_with_callback(const struct sr_dev_driver *driver,
1042                 std_dev_clear_callback clear_private);
1043 SR_PRIV int std_dev_clear(const struct sr_dev_driver *driver);
1044 SR_PRIV GSList *std_dev_list(const struct sr_dev_driver *di);
1045 SR_PRIV int std_serial_dev_close(struct sr_dev_inst *sdi);
1046 SR_PRIV GSList *std_scan_complete(struct sr_dev_driver *di, GSList *devices);
1047
1048 SR_PRIV int std_opts_config_list(uint32_t key, GVariant **data,
1049         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg,
1050         const uint32_t scanopts[], size_t scansize, const uint32_t drvopts[],
1051         size_t drvsize, const uint32_t devopts[], size_t devsize);
1052
1053 extern SR_PRIV const uint32_t NO_OPTS[1];
1054
1055 #define STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts) \
1056         std_opts_config_list(key, data, sdi, cg, ARRAY_AND_SIZE(scanopts), \
1057                 ARRAY_AND_SIZE(drvopts), ARRAY_AND_SIZE(devopts))
1058
1059 SR_PRIV GVariant *std_gvar_tuple_array(const uint64_t a[][2], unsigned int n);
1060 SR_PRIV GVariant *std_gvar_tuple_rational(const struct sr_rational *r, unsigned int n);
1061 SR_PRIV GVariant *std_gvar_samplerates(const uint64_t samplerates[], unsigned int n);
1062 SR_PRIV GVariant *std_gvar_samplerates_steps(const uint64_t samplerates[], unsigned int n);
1063 SR_PRIV GVariant *std_gvar_min_max_step(double min, double max, double step);
1064 SR_PRIV GVariant *std_gvar_min_max_step_array(const double a[3]);
1065 SR_PRIV GVariant *std_gvar_min_max_step_thresholds(const double dmin, const double dmax, const double dstep);
1066
1067 SR_PRIV GVariant *std_gvar_tuple_u64(uint64_t low, uint64_t high);
1068 SR_PRIV GVariant *std_gvar_tuple_double(double low, double high);
1069
1070 SR_PRIV GVariant *std_gvar_array_i32(const int32_t a[], unsigned int n);
1071 SR_PRIV GVariant *std_gvar_array_u32(const uint32_t a[], unsigned int n);
1072 SR_PRIV GVariant *std_gvar_array_u64(const uint64_t a[], unsigned int n);
1073 SR_PRIV GVariant *std_gvar_array_str(const char *a[], unsigned int n);
1074
1075 SR_PRIV GVariant *std_gvar_thresholds(const double a[][2], unsigned int n);
1076
1077 SR_PRIV int std_str_idx(GVariant *data, const char *a[], unsigned int n);
1078 SR_PRIV int std_u64_idx(GVariant *data, const uint64_t a[], unsigned int n);
1079 SR_PRIV int std_u8_idx(GVariant *data, const uint8_t a[], unsigned int n);
1080
1081 SR_PRIV int std_str_idx_s(const char *s, const char *a[], unsigned int n);
1082 SR_PRIV int std_u8_idx_s(uint8_t b, const uint8_t a[], unsigned int n);
1083
1084 SR_PRIV int std_u64_tuple_idx(GVariant *data, const uint64_t a[][2], unsigned int n);
1085 SR_PRIV int std_double_tuple_idx(GVariant *data, const double a[][2], unsigned int n);
1086 SR_PRIV int std_double_tuple_idx_d0(const double d, const double a[][2], unsigned int n);
1087
1088 SR_PRIV int std_cg_idx(const struct sr_channel_group *cg, struct sr_channel_group *a[], unsigned int n);
1089
1090 SR_PRIV int std_dummy_set_params(struct sr_serial_dev_inst *serial,
1091         int baudrate, int bits, int parity, int stopbits,
1092         int flowcontrol, int rts, int dtr);
1093
1094 /*--- resource.c ------------------------------------------------------------*/
1095
1096 SR_PRIV int64_t sr_file_get_size(FILE *file);
1097
1098 SR_PRIV int sr_resource_open(struct sr_context *ctx,
1099                 struct sr_resource *res, int type, const char *name)
1100                 G_GNUC_WARN_UNUSED_RESULT;
1101 SR_PRIV int sr_resource_close(struct sr_context *ctx,
1102                 struct sr_resource *res);
1103 SR_PRIV gssize sr_resource_read(struct sr_context *ctx,
1104                 const struct sr_resource *res, void *buf, size_t count)
1105                 G_GNUC_WARN_UNUSED_RESULT;
1106 SR_PRIV void *sr_resource_load(struct sr_context *ctx, int type,
1107                 const char *name, size_t *size, size_t max_size)
1108                 G_GNUC_MALLOC G_GNUC_WARN_UNUSED_RESULT;
1109
1110 /*--- strutil.c -------------------------------------------------------------*/
1111
1112 SR_PRIV int sr_atol(const char *str, long *ret);
1113 SR_PRIV int sr_atoi(const char *str, int *ret);
1114 SR_PRIV int sr_atod(const char *str, double *ret);
1115 SR_PRIV int sr_atof(const char *str, float *ret);
1116 SR_PRIV int sr_atod_ascii(const char *str, double *ret);
1117 SR_PRIV int sr_atof_ascii(const char *str, float *ret);
1118
1119 SR_PRIV GString *sr_hexdump_new(const uint8_t *data, const size_t len);
1120 SR_PRIV void sr_hexdump_free(GString *s);
1121
1122 /*--- soft-trigger.c --------------------------------------------------------*/
1123
1124 struct soft_trigger_logic {
1125         const struct sr_dev_inst *sdi;
1126         const struct sr_trigger *trigger;
1127         int count;
1128         int unitsize;
1129         int cur_stage;
1130         uint8_t *prev_sample;
1131         uint8_t *pre_trigger_buffer;
1132         uint8_t *pre_trigger_head;
1133         int pre_trigger_size;
1134         int pre_trigger_fill;
1135 };
1136
1137 SR_PRIV int logic_channel_unitsize(GSList *channels);
1138 SR_PRIV struct soft_trigger_logic *soft_trigger_logic_new(
1139                 const struct sr_dev_inst *sdi, struct sr_trigger *trigger,
1140                 int pre_trigger_samples);
1141 SR_PRIV void soft_trigger_logic_free(struct soft_trigger_logic *st);
1142 SR_PRIV int soft_trigger_logic_check(struct soft_trigger_logic *st, uint8_t *buf,
1143                 int len, int *pre_trigger_samples);
1144
1145 /*--- serial.c --------------------------------------------------------------*/
1146
1147 #ifdef HAVE_SERIAL_COMM
1148 enum {
1149         SERIAL_RDWR = 1,
1150         SERIAL_RDONLY = 2,
1151 };
1152
1153 typedef gboolean (*packet_valid_callback)(const uint8_t *buf);
1154
1155 typedef GSList *(*sr_ser_list_append_t)(GSList *devs, const char *name,
1156                 const char *desc);
1157 typedef GSList *(*sr_ser_find_append_t)(GSList *devs, const char *name);
1158
1159 SR_PRIV int serial_open(struct sr_serial_dev_inst *serial, int flags);
1160 SR_PRIV int serial_close(struct sr_serial_dev_inst *serial);
1161 SR_PRIV int serial_flush(struct sr_serial_dev_inst *serial);
1162 SR_PRIV int serial_drain(struct sr_serial_dev_inst *serial);
1163 SR_PRIV size_t serial_has_receive_data(struct sr_serial_dev_inst *serial);
1164 SR_PRIV int serial_write_blocking(struct sr_serial_dev_inst *serial,
1165                 const void *buf, size_t count, unsigned int timeout_ms);
1166 SR_PRIV int serial_write_nonblocking(struct sr_serial_dev_inst *serial,
1167                 const void *buf, size_t count);
1168 SR_PRIV int serial_read_blocking(struct sr_serial_dev_inst *serial, void *buf,
1169                 size_t count, unsigned int timeout_ms);
1170 SR_PRIV int serial_read_nonblocking(struct sr_serial_dev_inst *serial, void *buf,
1171                 size_t count);
1172 SR_PRIV int serial_set_read_chunk_cb(struct sr_serial_dev_inst *serial,
1173                 serial_rx_chunk_callback cb, void *cb_data);
1174 SR_PRIV int serial_set_params(struct sr_serial_dev_inst *serial, int baudrate,
1175                 int bits, int parity, int stopbits, int flowcontrol, int rts, int dtr);
1176 SR_PRIV int serial_set_paramstr(struct sr_serial_dev_inst *serial,
1177                 const char *paramstr);
1178 SR_PRIV int serial_readline(struct sr_serial_dev_inst *serial, char **buf,
1179                 int *buflen, gint64 timeout_ms);
1180 SR_PRIV int serial_stream_detect(struct sr_serial_dev_inst *serial,
1181                                  uint8_t *buf, size_t *buflen,
1182                                  size_t packet_size,
1183                                  packet_valid_callback is_valid,
1184                                  uint64_t timeout_ms);
1185 SR_PRIV int sr_serial_extract_options(GSList *options, const char **serial_device,
1186                                       const char **serial_options);
1187 SR_PRIV int serial_source_add(struct sr_session *session,
1188                 struct sr_serial_dev_inst *serial, int events, int timeout,
1189                 sr_receive_data_callback cb, void *cb_data);
1190 SR_PRIV int serial_source_remove(struct sr_session *session,
1191                 struct sr_serial_dev_inst *serial);
1192 SR_PRIV GSList *sr_serial_find_usb(uint16_t vendor_id, uint16_t product_id);
1193 SR_PRIV int serial_timeout(struct sr_serial_dev_inst *port, int num_bytes);
1194
1195 SR_PRIV void sr_ser_discard_queued_data(struct sr_serial_dev_inst *serial);
1196 SR_PRIV size_t sr_ser_has_queued_data(struct sr_serial_dev_inst *serial);
1197 SR_PRIV void sr_ser_queue_rx_data(struct sr_serial_dev_inst *serial,
1198                 const uint8_t *data, size_t len);
1199 SR_PRIV size_t sr_ser_unqueue_rx_data(struct sr_serial_dev_inst *serial,
1200                 uint8_t *data, size_t len);
1201
1202 struct ser_lib_functions {
1203         int (*open)(struct sr_serial_dev_inst *serial, int flags);
1204         int (*close)(struct sr_serial_dev_inst *serial);
1205         int (*flush)(struct sr_serial_dev_inst *serial);
1206         int (*drain)(struct sr_serial_dev_inst *serial);
1207         int (*write)(struct sr_serial_dev_inst *serial,
1208                         const void *buf, size_t count,
1209                         int nonblocking, unsigned int timeout_ms);
1210         int (*read)(struct sr_serial_dev_inst *serial,
1211                         void *buf, size_t count,
1212                         int nonblocking, unsigned int timeout_ms);
1213         int (*set_params)(struct sr_serial_dev_inst *serial,
1214                         int baudrate, int bits, int parity, int stopbits,
1215                         int flowcontrol, int rts, int dtr);
1216         int (*setup_source_add)(struct sr_session *session,
1217                         struct sr_serial_dev_inst *serial,
1218                         int events, int timeout,
1219                         sr_receive_data_callback cb, void *cb_data);
1220         int (*setup_source_remove)(struct sr_session *session,
1221                         struct sr_serial_dev_inst *serial);
1222         GSList *(*list)(GSList *list, sr_ser_list_append_t append);
1223         GSList *(*find_usb)(GSList *list, sr_ser_find_append_t append,
1224                         uint16_t vendor_id, uint16_t product_id);
1225         int (*get_frame_format)(struct sr_serial_dev_inst *serial,
1226                         int *baud, int *bits);
1227         size_t (*get_rx_avail)(struct sr_serial_dev_inst *serial);
1228 };
1229 extern SR_PRIV struct ser_lib_functions *ser_lib_funcs_libsp;
1230 SR_PRIV int ser_name_is_hid(struct sr_serial_dev_inst *serial);
1231 extern SR_PRIV struct ser_lib_functions *ser_lib_funcs_hid;
1232 SR_PRIV int ser_name_is_bt(struct sr_serial_dev_inst *serial);
1233 extern SR_PRIV struct ser_lib_functions *ser_lib_funcs_bt;
1234
1235 #ifdef HAVE_LIBHIDAPI
1236 struct vid_pid_item {
1237         uint16_t vid, pid;
1238 };
1239
1240 struct ser_hid_chip_functions {
1241         const char *chipname;
1242         const char *chipdesc;
1243         const struct vid_pid_item *vid_pid_items;
1244         const int max_bytes_per_request;
1245         int (*set_params)(struct sr_serial_dev_inst *serial,
1246                         int baudrate, int bits, int parity, int stopbits,
1247                         int flowcontrol, int rts, int dtr);
1248         int (*read_bytes)(struct sr_serial_dev_inst *serial,
1249                         uint8_t *data, int space, unsigned int timeout);
1250         int (*write_bytes)(struct sr_serial_dev_inst *serial,
1251                         const uint8_t *data, int space);
1252         int (*flush)(struct sr_serial_dev_inst *serial);
1253         int (*drain)(struct sr_serial_dev_inst *serial);
1254 };
1255 extern SR_PRIV struct ser_hid_chip_functions *ser_hid_chip_funcs_bu86x;
1256 extern SR_PRIV struct ser_hid_chip_functions *ser_hid_chip_funcs_ch9325;
1257 extern SR_PRIV struct ser_hid_chip_functions *ser_hid_chip_funcs_cp2110;
1258 extern SR_PRIV struct ser_hid_chip_functions *ser_hid_chip_funcs_victor;
1259 SR_PRIV const char *ser_hid_chip_find_name_vid_pid(uint16_t vid, uint16_t pid);
1260 #endif
1261 #endif
1262
1263 /*--- bt/ API ---------------------------------------------------------------*/
1264
1265 #ifdef HAVE_BLUETOOTH
1266 SR_PRIV const char *sr_bt_adapter_get_address(size_t idx);
1267
1268 struct sr_bt_desc;
1269 typedef void (*sr_bt_scan_cb)(void *cb_data, const char *addr, const char *name);
1270 typedef int (*sr_bt_data_cb)(void *cb_data, uint8_t *data, size_t dlen);
1271
1272 SR_PRIV struct sr_bt_desc *sr_bt_desc_new(void);
1273 SR_PRIV void sr_bt_desc_free(struct sr_bt_desc *desc);
1274
1275 SR_PRIV int sr_bt_config_cb_scan(struct sr_bt_desc *desc,
1276         sr_bt_scan_cb cb, void *cb_data);
1277 SR_PRIV int sr_bt_config_cb_data(struct sr_bt_desc *desc,
1278         sr_bt_data_cb cb, void *cb_data);
1279 SR_PRIV int sr_bt_config_addr_local(struct sr_bt_desc *desc, const char *addr);
1280 SR_PRIV int sr_bt_config_addr_remote(struct sr_bt_desc *desc, const char *addr);
1281 SR_PRIV int sr_bt_config_rfcomm(struct sr_bt_desc *desc, size_t channel);
1282 SR_PRIV int sr_bt_config_notify(struct sr_bt_desc *desc,
1283         uint16_t read_handle, uint16_t write_handle,
1284         uint16_t cccd_handle, uint16_t cccd_value);
1285
1286 SR_PRIV int sr_bt_scan_le(struct sr_bt_desc *desc, int duration);
1287 SR_PRIV int sr_bt_scan_bt(struct sr_bt_desc *desc, int duration);
1288
1289 SR_PRIV int sr_bt_connect_ble(struct sr_bt_desc *desc);
1290 SR_PRIV int sr_bt_connect_rfcomm(struct sr_bt_desc *desc);
1291 SR_PRIV void sr_bt_disconnect(struct sr_bt_desc *desc);
1292
1293 SR_PRIV ssize_t sr_bt_read(struct sr_bt_desc *desc,
1294         void *data, size_t len);
1295 SR_PRIV ssize_t sr_bt_write(struct sr_bt_desc *desc,
1296         const void *data, size_t len);
1297
1298 SR_PRIV int sr_bt_start_notify(struct sr_bt_desc *desc);
1299 SR_PRIV int sr_bt_check_notify(struct sr_bt_desc *desc);
1300 #endif
1301
1302 /*--- ezusb.c ---------------------------------------------------------------*/
1303
1304 #ifdef HAVE_LIBUSB_1_0
1305 SR_PRIV int ezusb_reset(struct libusb_device_handle *hdl, int set_clear);
1306 SR_PRIV int ezusb_install_firmware(struct sr_context *ctx, libusb_device_handle *hdl,
1307                                    const char *name);
1308 SR_PRIV int ezusb_upload_firmware(struct sr_context *ctx, libusb_device *dev,
1309                                   int configuration, const char *name);
1310 #endif
1311
1312 /*--- usb.c -----------------------------------------------------------------*/
1313
1314 #ifdef HAVE_LIBUSB_1_0
1315 SR_PRIV GSList *sr_usb_find(libusb_context *usb_ctx, const char *conn);
1316 SR_PRIV int sr_usb_open(libusb_context *usb_ctx, struct sr_usb_dev_inst *usb);
1317 SR_PRIV void sr_usb_close(struct sr_usb_dev_inst *usb);
1318 SR_PRIV int usb_source_add(struct sr_session *session, struct sr_context *ctx,
1319                 int timeout, sr_receive_data_callback cb, void *cb_data);
1320 SR_PRIV int usb_source_remove(struct sr_session *session, struct sr_context *ctx);
1321 SR_PRIV int usb_get_port_path(libusb_device *dev, char *path, int path_len);
1322 SR_PRIV gboolean usb_match_manuf_prod(libusb_device *dev,
1323                 const char *manufacturer, const char *product);
1324 #endif
1325
1326
1327 /*--- modbus/modbus.c -------------------------------------------------------*/
1328
1329 struct sr_modbus_dev_inst {
1330         const char *name;
1331         const char *prefix;
1332         int priv_size;
1333         GSList *(*scan)(int modbusaddr);
1334         int (*dev_inst_new)(void *priv, const char *resource,
1335                 char **params, const char *serialcomm, int modbusaddr);
1336         int (*open)(void *priv);
1337         int (*source_add)(struct sr_session *session, void *priv, int events,
1338                 int timeout, sr_receive_data_callback cb, void *cb_data);
1339         int (*source_remove)(struct sr_session *session, void *priv);
1340         int (*send)(void *priv, const uint8_t *buffer, int buffer_size);
1341         int (*read_begin)(void *priv, uint8_t *function_code);
1342         int (*read_data)(void *priv, uint8_t *buf, int maxlen);
1343         int (*read_end)(void *priv);
1344         int (*close)(void *priv);
1345         void (*free)(void *priv);
1346         unsigned int read_timeout_ms;
1347         void *priv;
1348 };
1349
1350 SR_PRIV GSList *sr_modbus_scan(struct drv_context *drvc, GSList *options,
1351                 struct sr_dev_inst *(*probe_device)(struct sr_modbus_dev_inst *modbus));
1352 SR_PRIV struct sr_modbus_dev_inst *modbus_dev_inst_new(const char *resource,
1353                 const char *serialcomm, int modbusaddr);
1354 SR_PRIV int sr_modbus_open(struct sr_modbus_dev_inst *modbus);
1355 SR_PRIV int sr_modbus_source_add(struct sr_session *session,
1356                 struct sr_modbus_dev_inst *modbus, int events, int timeout,
1357                 sr_receive_data_callback cb, void *cb_data);
1358 SR_PRIV int sr_modbus_source_remove(struct sr_session *session,
1359                 struct sr_modbus_dev_inst *modbus);
1360 SR_PRIV int sr_modbus_request(struct sr_modbus_dev_inst *modbus,
1361                               uint8_t *request, int request_size);
1362 SR_PRIV int sr_modbus_reply(struct sr_modbus_dev_inst *modbus,
1363                             uint8_t *reply, int reply_size);
1364 SR_PRIV int sr_modbus_request_reply(struct sr_modbus_dev_inst *modbus,
1365                                     uint8_t *request, int request_size,
1366                                     uint8_t *reply, int reply_size);
1367 SR_PRIV int sr_modbus_read_coils(struct sr_modbus_dev_inst *modbus,
1368                                  int address, int nb_coils, uint8_t *coils);
1369 SR_PRIV int sr_modbus_read_holding_registers(struct sr_modbus_dev_inst *modbus,
1370                                              int address, int nb_registers,
1371                                              uint16_t *registers);
1372 SR_PRIV int sr_modbus_write_coil(struct sr_modbus_dev_inst *modbus,
1373                                  int address, int value);
1374 SR_PRIV int sr_modbus_write_multiple_registers(struct sr_modbus_dev_inst*modbus,
1375                                                int address, int nb_registers,
1376                                                uint16_t *registers);
1377 SR_PRIV int sr_modbus_close(struct sr_modbus_dev_inst *modbus);
1378 SR_PRIV void sr_modbus_free(struct sr_modbus_dev_inst *modbus);
1379
1380 /*--- dmm/es519xx.c ---------------------------------------------------------*/
1381
1382 /**
1383  * All 11-byte es519xx chips repeat each block twice for each conversion cycle
1384  * so always read 2 blocks at a time.
1385  */
1386 #define ES519XX_11B_PACKET_SIZE (11 * 2)
1387 #define ES519XX_14B_PACKET_SIZE 14
1388
1389 struct es519xx_info {
1390         gboolean is_judge, is_voltage, is_auto, is_micro, is_current;
1391         gboolean is_milli, is_resistance, is_continuity, is_diode;
1392         gboolean is_frequency, is_rpm, is_capacitance, is_duty_cycle;
1393         gboolean is_temperature, is_celsius, is_fahrenheit;
1394         gboolean is_adp0, is_adp1, is_adp2, is_adp3;
1395         gboolean is_sign, is_batt, is_ol, is_pmax, is_pmin, is_apo;
1396         gboolean is_dc, is_ac, is_vahz, is_min, is_max, is_rel, is_hold;
1397         gboolean is_digit4, is_ul, is_vasel, is_vbar, is_lpf1, is_lpf0, is_rmr;
1398         uint32_t baudrate;
1399         int packet_size;
1400         gboolean alt_functions, fivedigits, clampmeter, selectable_lpf;
1401         int digits;
1402 };
1403
1404 SR_PRIV gboolean sr_es519xx_2400_11b_packet_valid(const uint8_t *buf);
1405 SR_PRIV int sr_es519xx_2400_11b_parse(const uint8_t *buf, float *floatval,
1406                 struct sr_datafeed_analog *analog, void *info);
1407 SR_PRIV gboolean sr_es519xx_2400_11b_altfn_packet_valid(const uint8_t *buf);
1408 SR_PRIV int sr_es519xx_2400_11b_altfn_parse(const uint8_t *buf,
1409                 float *floatval, struct sr_datafeed_analog *analog, void *info);
1410 SR_PRIV gboolean sr_es519xx_19200_11b_5digits_packet_valid(const uint8_t *buf);
1411 SR_PRIV int sr_es519xx_19200_11b_5digits_parse(const uint8_t *buf,
1412                 float *floatval, struct sr_datafeed_analog *analog, void *info);
1413 SR_PRIV gboolean sr_es519xx_19200_11b_clamp_packet_valid(const uint8_t *buf);
1414 SR_PRIV int sr_es519xx_19200_11b_clamp_parse(const uint8_t *buf,
1415                 float *floatval, struct sr_datafeed_analog *analog, void *info);
1416 SR_PRIV gboolean sr_es519xx_19200_11b_packet_valid(const uint8_t *buf);
1417 SR_PRIV int sr_es519xx_19200_11b_parse(const uint8_t *buf, float *floatval,
1418                 struct sr_datafeed_analog *analog, void *info);
1419 SR_PRIV gboolean sr_es519xx_19200_14b_packet_valid(const uint8_t *buf);
1420 SR_PRIV int sr_es519xx_19200_14b_parse(const uint8_t *buf, float *floatval,
1421                 struct sr_datafeed_analog *analog, void *info);
1422 SR_PRIV gboolean sr_es519xx_19200_14b_sel_lpf_packet_valid(const uint8_t *buf);
1423 SR_PRIV int sr_es519xx_19200_14b_sel_lpf_parse(const uint8_t *buf,
1424                 float *floatval, struct sr_datafeed_analog *analog, void *info);
1425
1426 /*--- dmm/fs9922.c ----------------------------------------------------------*/
1427
1428 #define FS9922_PACKET_SIZE 14
1429
1430 struct fs9922_info {
1431         gboolean is_auto, is_dc, is_ac, is_rel, is_hold, is_bpn, is_z1, is_z2;
1432         gboolean is_max, is_min, is_apo, is_bat, is_nano, is_z3, is_micro;
1433         gboolean is_milli, is_kilo, is_mega, is_beep, is_diode, is_percent;
1434         gboolean is_z4, is_volt, is_ampere, is_ohm, is_hfe, is_hertz, is_farad;
1435         gboolean is_celsius, is_fahrenheit;
1436         int bargraph_sign, bargraph_value;
1437 };
1438
1439 SR_PRIV gboolean sr_fs9922_packet_valid(const uint8_t *buf);
1440 SR_PRIV int sr_fs9922_parse(const uint8_t *buf, float *floatval,
1441                             struct sr_datafeed_analog *analog, void *info);
1442 SR_PRIV void sr_fs9922_z1_diode(struct sr_datafeed_analog *analog, void *info);
1443
1444 /*--- dmm/fs9721.c ----------------------------------------------------------*/
1445
1446 #define FS9721_PACKET_SIZE 14
1447
1448 struct fs9721_info {
1449         gboolean is_ac, is_dc, is_auto, is_rs232, is_micro, is_nano, is_kilo;
1450         gboolean is_diode, is_milli, is_percent, is_mega, is_beep, is_farad;
1451         gboolean is_ohm, is_rel, is_hold, is_ampere, is_volt, is_hz, is_bat;
1452         gboolean is_c2c1_11, is_c2c1_10, is_c2c1_01, is_c2c1_00, is_sign;
1453 };
1454
1455 SR_PRIV gboolean sr_fs9721_packet_valid(const uint8_t *buf);
1456 SR_PRIV int sr_fs9721_parse(const uint8_t *buf, float *floatval,
1457                             struct sr_datafeed_analog *analog, void *info);
1458 SR_PRIV void sr_fs9721_00_temp_c(struct sr_datafeed_analog *analog, void *info);
1459 SR_PRIV void sr_fs9721_01_temp_c(struct sr_datafeed_analog *analog, void *info);
1460 SR_PRIV void sr_fs9721_10_temp_c(struct sr_datafeed_analog *analog, void *info);
1461 SR_PRIV void sr_fs9721_01_10_temp_f_c(struct sr_datafeed_analog *analog, void *info);
1462 SR_PRIV void sr_fs9721_max_c_min(struct sr_datafeed_analog *analog, void *info);
1463
1464 /*--- dmm/ms2115b.c ---------------------------------------------------------*/
1465
1466 #define MS2115B_PACKET_SIZE 9
1467
1468 enum ms2115b_display {
1469         MS2115B_DISPLAY_MAIN,
1470         MS2115B_DISPLAY_SUB,
1471         MS2115B_DISPLAY_COUNT,
1472 };
1473
1474 struct ms2115b_info {
1475         /* Selected channel. */
1476         size_t ch_idx;
1477         gboolean is_ac, is_dc, is_auto;
1478         gboolean is_diode, is_beep, is_farad;
1479         gboolean is_ohm, is_ampere, is_volt, is_hz;
1480         gboolean is_duty_cycle, is_percent;
1481 };
1482
1483 extern SR_PRIV const char *ms2115b_channel_formats[];
1484 SR_PRIV gboolean sr_ms2115b_packet_valid(const uint8_t *buf);
1485 SR_PRIV int sr_ms2115b_parse(const uint8_t *buf, float *floatval,
1486         struct sr_datafeed_analog *analog, void *info);
1487
1488 /*--- dmm/ms8250d.c ---------------------------------------------------------*/
1489
1490 #define MS8250D_PACKET_SIZE 18
1491
1492 struct ms8250d_info {
1493         gboolean is_ac, is_dc, is_auto, is_rs232, is_micro, is_nano, is_kilo;
1494         gboolean is_diode, is_milli, is_percent, is_mega, is_beep, is_farad;
1495         gboolean is_ohm, is_rel, is_hold, is_ampere, is_volt, is_hz, is_bat;
1496         gboolean is_ncv, is_min, is_max, is_sign, is_autotimer;
1497 };
1498
1499 SR_PRIV gboolean sr_ms8250d_packet_valid(const uint8_t *buf);
1500 SR_PRIV int sr_ms8250d_parse(const uint8_t *buf, float *floatval,
1501                              struct sr_datafeed_analog *analog, void *info);
1502
1503 /*--- dmm/dtm0660.c ---------------------------------------------------------*/
1504
1505 #define DTM0660_PACKET_SIZE 15
1506
1507 struct dtm0660_info {
1508         gboolean is_ac, is_dc, is_auto, is_rs232, is_micro, is_nano, is_kilo;
1509         gboolean is_diode, is_milli, is_percent, is_mega, is_beep, is_farad;
1510         gboolean is_ohm, is_rel, is_hold, is_ampere, is_volt, is_hz, is_bat;
1511         gboolean is_degf, is_degc, is_c2c1_01, is_c2c1_00, is_apo, is_min;
1512         gboolean is_minmax, is_max, is_sign;
1513 };
1514
1515 SR_PRIV gboolean sr_dtm0660_packet_valid(const uint8_t *buf);
1516 SR_PRIV int sr_dtm0660_parse(const uint8_t *buf, float *floatval,
1517                         struct sr_datafeed_analog *analog, void *info);
1518
1519 /*--- dmm/m2110.c -----------------------------------------------------------*/
1520
1521 #define BBCGM_M2110_PACKET_SIZE 9
1522
1523 /* Dummy info struct. The parser does not use it. */
1524 struct m2110_info { int dummy; };
1525
1526 SR_PRIV gboolean sr_m2110_packet_valid(const uint8_t *buf);
1527 SR_PRIV int sr_m2110_parse(const uint8_t *buf, float *floatval,
1528                              struct sr_datafeed_analog *analog, void *info);
1529
1530 /*--- dmm/metex14.c ---------------------------------------------------------*/
1531
1532 #define METEX14_PACKET_SIZE 14
1533
1534 struct metex14_info {
1535         size_t ch_idx;
1536         gboolean is_ac, is_dc, is_resistance, is_capacity, is_temperature;
1537         gboolean is_diode, is_frequency, is_ampere, is_volt, is_farad;
1538         gboolean is_hertz, is_ohm, is_celsius, is_fahrenheit, is_watt;
1539         gboolean is_pico, is_nano, is_micro, is_milli, is_kilo, is_mega;
1540         gboolean is_gain, is_decibel, is_power, is_decibel_mw, is_power_factor;
1541         gboolean is_hfe, is_unitless, is_logic, is_min, is_max, is_avg;
1542 };
1543
1544 #ifdef HAVE_SERIAL_COMM
1545 SR_PRIV int sr_metex14_packet_request(struct sr_serial_dev_inst *serial);
1546 #endif
1547 SR_PRIV gboolean sr_metex14_packet_valid(const uint8_t *buf);
1548 SR_PRIV int sr_metex14_parse(const uint8_t *buf, float *floatval,
1549                              struct sr_datafeed_analog *analog, void *info);
1550 SR_PRIV gboolean sr_metex14_4packets_valid(const uint8_t *buf);
1551 SR_PRIV int sr_metex14_4packets_parse(const uint8_t *buf, float *floatval,
1552                              struct sr_datafeed_analog *analog, void *info);
1553
1554 /*--- dmm/rs9lcd.c ----------------------------------------------------------*/
1555
1556 #define RS9LCD_PACKET_SIZE 9
1557
1558 /* Dummy info struct. The parser does not use it. */
1559 struct rs9lcd_info { int dummy; };
1560
1561 SR_PRIV gboolean sr_rs9lcd_packet_valid(const uint8_t *buf);
1562 SR_PRIV int sr_rs9lcd_parse(const uint8_t *buf, float *floatval,
1563                             struct sr_datafeed_analog *analog, void *info);
1564
1565 /*--- dmm/bm25x.c -----------------------------------------------------------*/
1566
1567 #define BRYMEN_BM25X_PACKET_SIZE 15
1568
1569 /* Dummy info struct. The parser does not use it. */
1570 struct bm25x_info { int dummy; };
1571
1572 SR_PRIV gboolean sr_brymen_bm25x_packet_valid(const uint8_t *buf);
1573 SR_PRIV int sr_brymen_bm25x_parse(const uint8_t *buf, float *floatval,
1574                              struct sr_datafeed_analog *analog, void *info);
1575
1576 /*--- dmm/bm86x.c -----------------------------------------------------------*/
1577
1578 #define BRYMEN_BM86X_PACKET_SIZE 24
1579 #define BRYMEN_BM86X_DISPLAY_COUNT 2
1580
1581 struct brymen_bm86x_info { size_t ch_idx; };
1582
1583 #ifdef HAVE_SERIAL_COMM
1584 SR_PRIV int sr_brymen_bm86x_packet_request(struct sr_serial_dev_inst *serial);
1585 #endif
1586 SR_PRIV gboolean sr_brymen_bm86x_packet_valid(const uint8_t *buf);
1587 SR_PRIV int sr_brymen_bm86x_parse(const uint8_t *buf, float *floatval,
1588                 struct sr_datafeed_analog *analog, void *info);
1589
1590 /*--- dmm/ut71x.c -----------------------------------------------------------*/
1591
1592 #define UT71X_PACKET_SIZE 11
1593
1594 struct ut71x_info {
1595         gboolean is_voltage, is_resistance, is_capacitance, is_temperature;
1596         gboolean is_celsius, is_fahrenheit, is_current, is_continuity;
1597         gboolean is_diode, is_frequency, is_duty_cycle, is_dc, is_ac;
1598         gboolean is_auto, is_manual, is_sign, is_power, is_loop_current;
1599 };
1600
1601 SR_PRIV gboolean sr_ut71x_packet_valid(const uint8_t *buf);
1602 SR_PRIV int sr_ut71x_parse(const uint8_t *buf, float *floatval,
1603                 struct sr_datafeed_analog *analog, void *info);
1604
1605 /*--- dmm/vc870.c -----------------------------------------------------------*/
1606
1607 #define VC870_PACKET_SIZE 23
1608
1609 struct vc870_info {
1610         gboolean is_voltage, is_dc, is_ac, is_temperature, is_resistance;
1611         gboolean is_continuity, is_capacitance, is_diode, is_loop_current;
1612         gboolean is_current, is_micro, is_milli, is_power;
1613         gboolean is_power_factor_freq, is_power_apparent_power, is_v_a_rms_value;
1614         gboolean is_sign2, is_sign1, is_batt, is_ol1, is_max, is_min;
1615         gboolean is_maxmin, is_rel, is_ol2, is_open, is_manu, is_hold;
1616         gboolean is_light, is_usb, is_warning, is_auto_power, is_misplug_warn;
1617         gboolean is_lo, is_hi, is_open2;
1618
1619         gboolean is_frequency, is_dual_display, is_auto;
1620 };
1621
1622 SR_PRIV gboolean sr_vc870_packet_valid(const uint8_t *buf);
1623 SR_PRIV int sr_vc870_parse(const uint8_t *buf, float *floatval,
1624                 struct sr_datafeed_analog *analog, void *info);
1625
1626 /*--- dmm/vc96.c ------------------------------------------------------------*/
1627
1628 #define VC96_PACKET_SIZE 13
1629
1630 struct vc96_info {
1631         size_t ch_idx;
1632         gboolean is_ac, is_dc, is_resistance, is_diode, is_ampere, is_volt;
1633         gboolean is_ohm, is_micro, is_milli, is_kilo, is_mega, is_hfe;
1634         gboolean is_unitless;
1635 };
1636
1637 SR_PRIV gboolean sr_vc96_packet_valid(const uint8_t *buf);
1638 SR_PRIV int sr_vc96_parse(const uint8_t *buf, float *floatval,
1639                 struct sr_datafeed_analog *analog, void *info);
1640
1641 /*--- lcr/es51919.c ---------------------------------------------------------*/
1642
1643 /* Acquisition details which apply to all supported serial-lcr devices. */
1644 struct lcr_parse_info {
1645         size_t ch_idx;
1646         uint64_t output_freq;
1647         const char *circuit_model;
1648 };
1649
1650 #define ES51919_PACKET_SIZE     17
1651 #define ES51919_CHANNEL_COUNT   2
1652 #define ES51919_COMM_PARAM      "9600/8n1/rts=1/dtr=1"
1653
1654 SR_PRIV int es51919_config_get(uint32_t key, GVariant **data,
1655         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg);
1656 SR_PRIV int es51919_config_set(uint32_t key, GVariant *data,
1657         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg);
1658 SR_PRIV int es51919_config_list(uint32_t key, GVariant **data,
1659         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg);
1660 SR_PRIV gboolean es51919_packet_valid(const uint8_t *pkt);
1661 SR_PRIV int es51919_packet_parse(const uint8_t *pkt, float *floatval,
1662         struct sr_datafeed_analog *analog, void *info);
1663
1664 /*--- lcr/vc4080.c ----------------------------------------------------------*/
1665
1666 /* Note: Also uses 'struct lcr_parse_info' from es51919 above. */
1667
1668 #define VC4080_PACKET_SIZE      39
1669 #define VC4080_COMM_PARAM       "1200/8n1"
1670 #define VC4080_WITH_DQ_CHANS    0 /* Enable separate D/Q channels? */
1671
1672 enum vc4080_display {
1673         VC4080_DISPLAY_PRIMARY,
1674         VC4080_DISPLAY_SECONDARY,
1675 #if VC4080_WITH_DQ_CHANS
1676         VC4080_DISPLAY_D_VALUE,
1677         VC4080_DISPLAY_Q_VALUE,
1678 #endif
1679         VC4080_CHANNEL_COUNT,
1680 };
1681
1682 extern SR_PRIV const char *vc4080_channel_formats[VC4080_CHANNEL_COUNT];
1683
1684 SR_PRIV int vc4080_config_list(uint32_t key, GVariant **data,
1685         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg);
1686 SR_PRIV int vc4080_packet_request(struct sr_serial_dev_inst *serial);
1687 SR_PRIV gboolean vc4080_packet_valid(const uint8_t *pkt);
1688 SR_PRIV int vc4080_packet_parse(const uint8_t *pkt, float *floatval,
1689         struct sr_datafeed_analog *analog, void *info);
1690
1691 /*--- dmm/ut372.c -----------------------------------------------------------*/
1692
1693 #define UT372_PACKET_SIZE 27
1694
1695 struct ut372_info {
1696         int dummy;
1697 };
1698
1699 SR_PRIV gboolean sr_ut372_packet_valid(const uint8_t *buf);
1700 SR_PRIV int sr_ut372_parse(const uint8_t *buf, float *floatval,
1701                 struct sr_datafeed_analog *analog, void *info);
1702
1703 /*--- dmm/asycii.c ----------------------------------------------------------*/
1704
1705 #define ASYCII_PACKET_SIZE 16
1706
1707 struct asycii_info {
1708         gboolean is_ac, is_dc, is_ac_and_dc;
1709         gboolean is_resistance, is_capacitance, is_diode, is_gain;
1710         gboolean is_frequency, is_duty_cycle, is_duty_pos, is_duty_neg;
1711         gboolean is_pulse_width, is_period_pos, is_period_neg;
1712         gboolean is_pulse_count, is_count_pos, is_count_neg;
1713         gboolean is_ampere, is_volt, is_volt_ampere, is_farad, is_ohm;
1714         gboolean is_hertz, is_percent, is_seconds, is_decibel;
1715         gboolean is_pico, is_nano, is_micro, is_milli, is_kilo, is_mega;
1716         gboolean is_unitless;
1717         gboolean is_peak_min, is_peak_max;
1718         gboolean is_invalid;
1719 };
1720
1721 #ifdef HAVE_SERIAL_COMM
1722 SR_PRIV int sr_asycii_packet_request(struct sr_serial_dev_inst *serial);
1723 #endif
1724 SR_PRIV gboolean sr_asycii_packet_valid(const uint8_t *buf);
1725 SR_PRIV int sr_asycii_parse(const uint8_t *buf, float *floatval,
1726                             struct sr_datafeed_analog *analog, void *info);
1727
1728 /*--- dmm/eev121gw.c --------------------------------------------------------*/
1729
1730 #define EEV121GW_PACKET_SIZE 19
1731
1732 enum eev121gw_display {
1733         EEV121GW_DISPLAY_MAIN,
1734         EEV121GW_DISPLAY_SUB,
1735         EEV121GW_DISPLAY_BAR,
1736         EEV121GW_DISPLAY_COUNT,
1737 };
1738
1739 struct eev121gw_info {
1740         /* Selected channel. */
1741         size_t ch_idx;
1742         /*
1743          * Measured value, number and sign/overflow flags, scale factor
1744          * and significant digits.
1745          */
1746         uint32_t uint_value;
1747         gboolean is_ofl, is_neg;
1748         int factor, digits;
1749         /* Currently active mode (meter's function). */
1750         gboolean is_ac, is_dc, is_voltage, is_current, is_power, is_gain;
1751         gboolean is_resistance, is_capacitance, is_diode, is_temperature;
1752         gboolean is_continuity, is_frequency, is_period, is_duty_cycle;
1753         /* Quantities associated with mode/function. */
1754         gboolean is_ampere, is_volt, is_volt_ampere, is_dbm;
1755         gboolean is_ohm, is_farad, is_celsius, is_fahrenheit;
1756         gboolean is_hertz, is_seconds, is_percent, is_loop_current;
1757         gboolean is_unitless, is_logic;
1758         /* Other indicators. */
1759         gboolean is_min, is_max, is_avg, is_1ms_peak, is_rel, is_hold;
1760         gboolean is_low_pass, is_mem, is_bt, is_auto_range, is_test;
1761         gboolean is_auto_poweroff, is_low_batt;
1762 };
1763
1764 extern SR_PRIV const char *eev121gw_channel_formats[];
1765 SR_PRIV gboolean sr_eev121gw_packet_valid(const uint8_t *buf);
1766 SR_PRIV int sr_eev121gw_3displays_parse(const uint8_t *buf, float *floatval,
1767                 struct sr_datafeed_analog *analog, void *info);
1768
1769 /*--- scale/kern.c ----------------------------------------------------------*/
1770
1771 struct kern_info {
1772         gboolean is_gram, is_carat, is_ounce, is_pound, is_troy_ounce;
1773         gboolean is_pennyweight, is_grain, is_tael, is_momme, is_tola;
1774         gboolean is_percentage, is_piece, is_unstable, is_stable, is_error;
1775         int buflen;
1776 };
1777
1778 SR_PRIV gboolean sr_kern_packet_valid(const uint8_t *buf);
1779 SR_PRIV int sr_kern_parse(const uint8_t *buf, float *floatval,
1780                 struct sr_datafeed_analog *analog, void *info);
1781
1782 /*--- sw_limits.c -----------------------------------------------------------*/
1783
1784 struct sr_sw_limits {
1785         uint64_t limit_samples;
1786         uint64_t limit_frames;
1787         uint64_t limit_msec;
1788         uint64_t samples_read;
1789         uint64_t frames_read;
1790         uint64_t start_time;
1791 };
1792
1793 SR_PRIV int sr_sw_limits_config_get(struct sr_sw_limits *limits, uint32_t key,
1794         GVariant **data);
1795 SR_PRIV int sr_sw_limits_config_set(struct sr_sw_limits *limits, uint32_t key,
1796         GVariant *data);
1797 SR_PRIV void sr_sw_limits_acquisition_start(struct sr_sw_limits *limits);
1798 SR_PRIV gboolean sr_sw_limits_check(struct sr_sw_limits *limits);
1799 SR_PRIV void sr_sw_limits_update_samples_read(struct sr_sw_limits *limits,
1800         uint64_t samples_read);
1801 SR_PRIV void sr_sw_limits_update_frames_read(struct sr_sw_limits *limits,
1802         uint64_t frames_read);
1803 SR_PRIV void sr_sw_limits_init(struct sr_sw_limits *limits);
1804
1805 #endif