]> sigrok.org Git - libsigrok.git/blame_incremental - src/libsigrok-internal.h
serial-hid: add support for (scrambling) Victor DMM cables
[libsigrok.git] / src / libsigrok-internal.h
... / ...
CommitLineData
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
46struct zip;
47struct 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
344SR_API void sr_drivers_init(struct sr_context *context);
345
346struct 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. */
358enum 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. */
371struct 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. */
383struct 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. */
515struct 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. */
541struct 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. */
632struct 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
649struct 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 */
720struct 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
730struct sr_serial_dev_inst;
731#ifdef HAVE_SERIAL_COMM
732struct ser_lib_functions;
733struct ser_hid_chip_functions;
734struct sr_bt_desc;
735typedef void (*serial_rx_chunk_callback)(struct sr_serial_dev_inst *serial,
736 void *cb_data, const void *buf, size_t count);
737struct 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
794struct sr_usbtmc_dev_inst {
795 char *device;
796 int fd;
797};
798
799/* Private driver context. */
800struct 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 */
813SR_PRIV int sr_log(int loglevel, const char *format, ...)
814 __attribute__((__format__ (__gnu_printf__, 2, 3)));
815#else
816SR_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. */
838enum {
839 /** The enabled state of the channel has been changed. */
840 SR_CHANNEL_SET_ENABLED = 1 << 0,
841};
842
843SR_PRIV struct sr_channel *sr_channel_new(struct sr_dev_inst *sdi,
844 int index, int type, gboolean enabled, const char *name);
845SR_PRIV void sr_channel_free(struct sr_channel *ch);
846SR_PRIV void sr_channel_free_cb(void *p);
847SR_PRIV struct sr_channel *sr_next_enabled_channel(const struct sr_dev_inst *sdi,
848 struct sr_channel *cur_channel);
849SR_PRIV gboolean sr_channels_differ(struct sr_channel *ch1, struct sr_channel *ch2);
850SR_PRIV gboolean sr_channel_lists_differ(GSList *l1, GSList *l2);
851
852/** Device instance data */
853struct 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 */
883SR_PRIV void sr_dev_inst_free(struct sr_dev_inst *sdi);
884
885#ifdef HAVE_LIBUSB_1_0
886/* USB-specific instances */
887SR_PRIV struct sr_usb_dev_inst *sr_usb_dev_inst_new(uint8_t bus,
888 uint8_t address, struct libusb_device_handle *hdl);
889SR_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 */
901enum 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
909enum 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 */
918SR_PRIV struct sr_serial_dev_inst *sr_serial_dev_inst_new(const char *port,
919 const char *serialcomm);
920SR_PRIV void sr_serial_dev_inst_free(struct sr_serial_dev_inst *serial);
921#endif
922
923/* USBTMC-specific instances */
924SR_PRIV struct sr_usbtmc_dev_inst *sr_usbtmc_dev_inst_new(const char *device);
925SR_PRIV void sr_usbtmc_dev_inst_free(struct sr_usbtmc_dev_inst *usbtmc);
926
927/*--- hwdriver.c ------------------------------------------------------------*/
928
929SR_PRIV const GVariantType *sr_variant_type_get(int datatype);
930SR_PRIV int sr_variant_type_check(uint32_t key, GVariant *data);
931SR_PRIV void sr_hw_cleanup_all(const struct sr_context *ctx);
932SR_PRIV struct sr_config *sr_config_new(uint32_t key, GVariant *data);
933SR_PRIV void sr_config_free(struct sr_config *src);
934SR_PRIV int sr_dev_acquisition_start(struct sr_dev_inst *sdi);
935SR_PRIV int sr_dev_acquisition_stop(struct sr_dev_inst *sdi);
936
937/*--- session.c -------------------------------------------------------------*/
938
939struct 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
971SR_PRIV int sr_session_source_add_internal(struct sr_session *session,
972 void *key, GSource *source);
973SR_PRIV int sr_session_source_remove_internal(struct sr_session *session,
974 void *key);
975SR_PRIV int sr_session_source_destroyed(struct sr_session *session,
976 void *key, GSource *source);
977SR_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
981SR_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);
983SR_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);
986SR_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);
989SR_PRIV int sr_session_source_remove(struct sr_session *session, int fd);
990SR_PRIV int sr_session_source_remove_pollfd(struct sr_session *session,
991 GPollFD *pollfd);
992SR_PRIV int sr_session_source_remove_channel(struct sr_session *session,
993 GIOChannel *channel);
994
995SR_PRIV int sr_session_send_meta(const struct sr_dev_inst *sdi,
996 uint32_t key, GVariant *var);
997SR_PRIV int sr_session_send(const struct sr_dev_inst *sdi,
998 const struct sr_datafeed_packet *packet);
999SR_PRIV int sr_sessionfile_check(const char *filename);
1000SR_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)
1008SR_PRIV void sr_zip_discard(struct zip *archive);
1009#endif
1010
1011SR_PRIV GKeyFile *sr_sessionfile_read_metadata(struct zip *archive,
1012 const struct zip_stat *entry);
1013
1014/*--- analog.c --------------------------------------------------------------*/
1015
1016SR_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
1024typedef int (*dev_close_callback)(struct sr_dev_inst *sdi);
1025typedef void (*std_dev_clear_callback)(void *priv);
1026
1027SR_PRIV int std_init(struct sr_dev_driver *di, struct sr_context *sr_ctx);
1028SR_PRIV int std_cleanup(const struct sr_dev_driver *di);
1029SR_PRIV int std_dummy_dev_open(struct sr_dev_inst *sdi);
1030SR_PRIV int std_dummy_dev_close(struct sr_dev_inst *sdi);
1031SR_PRIV int std_dummy_dev_acquisition_start(const struct sr_dev_inst *sdi);
1032SR_PRIV int std_dummy_dev_acquisition_stop(struct sr_dev_inst *sdi);
1033#ifdef HAVE_SERIAL_COMM
1034SR_PRIV int std_serial_dev_open(struct sr_dev_inst *sdi);
1035SR_PRIV int std_serial_dev_acquisition_stop(struct sr_dev_inst *sdi);
1036#endif
1037SR_PRIV int std_session_send_df_header(const struct sr_dev_inst *sdi);
1038SR_PRIV int std_session_send_df_end(const struct sr_dev_inst *sdi);
1039SR_PRIV int std_session_send_frame_begin(const struct sr_dev_inst *sdi);
1040SR_PRIV int std_session_send_frame_end(const struct sr_dev_inst *sdi);
1041SR_PRIV int std_dev_clear_with_callback(const struct sr_dev_driver *driver,
1042 std_dev_clear_callback clear_private);
1043SR_PRIV int std_dev_clear(const struct sr_dev_driver *driver);
1044SR_PRIV GSList *std_dev_list(const struct sr_dev_driver *di);
1045SR_PRIV int std_serial_dev_close(struct sr_dev_inst *sdi);
1046SR_PRIV GSList *std_scan_complete(struct sr_dev_driver *di, GSList *devices);
1047
1048SR_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
1053extern 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
1059SR_PRIV GVariant *std_gvar_tuple_array(const uint64_t a[][2], unsigned int n);
1060SR_PRIV GVariant *std_gvar_tuple_rational(const struct sr_rational *r, unsigned int n);
1061SR_PRIV GVariant *std_gvar_samplerates(const uint64_t samplerates[], unsigned int n);
1062SR_PRIV GVariant *std_gvar_samplerates_steps(const uint64_t samplerates[], unsigned int n);
1063SR_PRIV GVariant *std_gvar_min_max_step(double min, double max, double step);
1064SR_PRIV GVariant *std_gvar_min_max_step_array(const double a[3]);
1065SR_PRIV GVariant *std_gvar_min_max_step_thresholds(const double dmin, const double dmax, const double dstep);
1066
1067SR_PRIV GVariant *std_gvar_tuple_u64(uint64_t low, uint64_t high);
1068SR_PRIV GVariant *std_gvar_tuple_double(double low, double high);
1069
1070SR_PRIV GVariant *std_gvar_array_i32(const int32_t a[], unsigned int n);
1071SR_PRIV GVariant *std_gvar_array_u32(const uint32_t a[], unsigned int n);
1072SR_PRIV GVariant *std_gvar_array_u64(const uint64_t a[], unsigned int n);
1073SR_PRIV GVariant *std_gvar_array_str(const char *a[], unsigned int n);
1074
1075SR_PRIV GVariant *std_gvar_thresholds(const double a[][2], unsigned int n);
1076
1077SR_PRIV int std_str_idx(GVariant *data, const char *a[], unsigned int n);
1078SR_PRIV int std_u64_idx(GVariant *data, const uint64_t a[], unsigned int n);
1079SR_PRIV int std_u8_idx(GVariant *data, const uint8_t a[], unsigned int n);
1080
1081SR_PRIV int std_str_idx_s(const char *s, const char *a[], unsigned int n);
1082SR_PRIV int std_u8_idx_s(uint8_t b, const uint8_t a[], unsigned int n);
1083
1084SR_PRIV int std_u64_tuple_idx(GVariant *data, const uint64_t a[][2], unsigned int n);
1085SR_PRIV int std_double_tuple_idx(GVariant *data, const double a[][2], unsigned int n);
1086SR_PRIV int std_double_tuple_idx_d0(const double d, const double a[][2], unsigned int n);
1087
1088SR_PRIV int std_cg_idx(const struct sr_channel_group *cg, struct sr_channel_group *a[], unsigned int n);
1089
1090/*--- resource.c ------------------------------------------------------------*/
1091
1092SR_PRIV int64_t sr_file_get_size(FILE *file);
1093
1094SR_PRIV int sr_resource_open(struct sr_context *ctx,
1095 struct sr_resource *res, int type, const char *name)
1096 G_GNUC_WARN_UNUSED_RESULT;
1097SR_PRIV int sr_resource_close(struct sr_context *ctx,
1098 struct sr_resource *res);
1099SR_PRIV gssize sr_resource_read(struct sr_context *ctx,
1100 const struct sr_resource *res, void *buf, size_t count)
1101 G_GNUC_WARN_UNUSED_RESULT;
1102SR_PRIV void *sr_resource_load(struct sr_context *ctx, int type,
1103 const char *name, size_t *size, size_t max_size)
1104 G_GNUC_MALLOC G_GNUC_WARN_UNUSED_RESULT;
1105
1106/*--- strutil.c -------------------------------------------------------------*/
1107
1108SR_PRIV int sr_atol(const char *str, long *ret);
1109SR_PRIV int sr_atoi(const char *str, int *ret);
1110SR_PRIV int sr_atod(const char *str, double *ret);
1111SR_PRIV int sr_atof(const char *str, float *ret);
1112SR_PRIV int sr_atod_ascii(const char *str, double *ret);
1113SR_PRIV int sr_atof_ascii(const char *str, float *ret);
1114
1115SR_PRIV GString *sr_hexdump_new(const uint8_t *data, const size_t len);
1116SR_PRIV void sr_hexdump_free(GString *s);
1117
1118/*--- soft-trigger.c --------------------------------------------------------*/
1119
1120struct soft_trigger_logic {
1121 const struct sr_dev_inst *sdi;
1122 const struct sr_trigger *trigger;
1123 int count;
1124 int unitsize;
1125 int cur_stage;
1126 uint8_t *prev_sample;
1127 uint8_t *pre_trigger_buffer;
1128 uint8_t *pre_trigger_head;
1129 int pre_trigger_size;
1130 int pre_trigger_fill;
1131};
1132
1133SR_PRIV int logic_channel_unitsize(GSList *channels);
1134SR_PRIV struct soft_trigger_logic *soft_trigger_logic_new(
1135 const struct sr_dev_inst *sdi, struct sr_trigger *trigger,
1136 int pre_trigger_samples);
1137SR_PRIV void soft_trigger_logic_free(struct soft_trigger_logic *st);
1138SR_PRIV int soft_trigger_logic_check(struct soft_trigger_logic *st, uint8_t *buf,
1139 int len, int *pre_trigger_samples);
1140
1141/*--- serial.c --------------------------------------------------------------*/
1142
1143#ifdef HAVE_SERIAL_COMM
1144enum {
1145 SERIAL_RDWR = 1,
1146 SERIAL_RDONLY = 2,
1147};
1148
1149typedef gboolean (*packet_valid_callback)(const uint8_t *buf);
1150
1151typedef GSList *(*sr_ser_list_append_t)(GSList *devs, const char *name,
1152 const char *desc);
1153typedef GSList *(*sr_ser_find_append_t)(GSList *devs, const char *name);
1154
1155SR_PRIV int serial_open(struct sr_serial_dev_inst *serial, int flags);
1156SR_PRIV int serial_close(struct sr_serial_dev_inst *serial);
1157SR_PRIV int serial_flush(struct sr_serial_dev_inst *serial);
1158SR_PRIV int serial_drain(struct sr_serial_dev_inst *serial);
1159SR_PRIV size_t serial_has_receive_data(struct sr_serial_dev_inst *serial);
1160SR_PRIV int serial_write_blocking(struct sr_serial_dev_inst *serial,
1161 const void *buf, size_t count, unsigned int timeout_ms);
1162SR_PRIV int serial_write_nonblocking(struct sr_serial_dev_inst *serial,
1163 const void *buf, size_t count);
1164SR_PRIV int serial_read_blocking(struct sr_serial_dev_inst *serial, void *buf,
1165 size_t count, unsigned int timeout_ms);
1166SR_PRIV int serial_read_nonblocking(struct sr_serial_dev_inst *serial, void *buf,
1167 size_t count);
1168SR_PRIV int serial_set_read_chunk_cb(struct sr_serial_dev_inst *serial,
1169 serial_rx_chunk_callback cb, void *cb_data);
1170SR_PRIV int serial_set_params(struct sr_serial_dev_inst *serial, int baudrate,
1171 int bits, int parity, int stopbits, int flowcontrol, int rts, int dtr);
1172SR_PRIV int serial_set_paramstr(struct sr_serial_dev_inst *serial,
1173 const char *paramstr);
1174SR_PRIV int serial_readline(struct sr_serial_dev_inst *serial, char **buf,
1175 int *buflen, gint64 timeout_ms);
1176SR_PRIV int serial_stream_detect(struct sr_serial_dev_inst *serial,
1177 uint8_t *buf, size_t *buflen,
1178 size_t packet_size,
1179 packet_valid_callback is_valid,
1180 uint64_t timeout_ms);
1181SR_PRIV int sr_serial_extract_options(GSList *options, const char **serial_device,
1182 const char **serial_options);
1183SR_PRIV int serial_source_add(struct sr_session *session,
1184 struct sr_serial_dev_inst *serial, int events, int timeout,
1185 sr_receive_data_callback cb, void *cb_data);
1186SR_PRIV int serial_source_remove(struct sr_session *session,
1187 struct sr_serial_dev_inst *serial);
1188SR_PRIV GSList *sr_serial_find_usb(uint16_t vendor_id, uint16_t product_id);
1189SR_PRIV int serial_timeout(struct sr_serial_dev_inst *port, int num_bytes);
1190
1191SR_PRIV void sr_ser_discard_queued_data(struct sr_serial_dev_inst *serial);
1192SR_PRIV size_t sr_ser_has_queued_data(struct sr_serial_dev_inst *serial);
1193SR_PRIV void sr_ser_queue_rx_data(struct sr_serial_dev_inst *serial,
1194 const uint8_t *data, size_t len);
1195SR_PRIV size_t sr_ser_unqueue_rx_data(struct sr_serial_dev_inst *serial,
1196 uint8_t *data, size_t len);
1197
1198struct ser_lib_functions {
1199 int (*open)(struct sr_serial_dev_inst *serial, int flags);
1200 int (*close)(struct sr_serial_dev_inst *serial);
1201 int (*flush)(struct sr_serial_dev_inst *serial);
1202 int (*drain)(struct sr_serial_dev_inst *serial);
1203 int (*write)(struct sr_serial_dev_inst *serial,
1204 const void *buf, size_t count,
1205 int nonblocking, unsigned int timeout_ms);
1206 int (*read)(struct sr_serial_dev_inst *serial,
1207 void *buf, size_t count,
1208 int nonblocking, unsigned int timeout_ms);
1209 int (*set_params)(struct sr_serial_dev_inst *serial,
1210 int baudrate, int bits, int parity, int stopbits,
1211 int flowcontrol, int rts, int dtr);
1212 int (*setup_source_add)(struct sr_session *session,
1213 struct sr_serial_dev_inst *serial,
1214 int events, int timeout,
1215 sr_receive_data_callback cb, void *cb_data);
1216 int (*setup_source_remove)(struct sr_session *session,
1217 struct sr_serial_dev_inst *serial);
1218 GSList *(*list)(GSList *list, sr_ser_list_append_t append);
1219 GSList *(*find_usb)(GSList *list, sr_ser_find_append_t append,
1220 uint16_t vendor_id, uint16_t product_id);
1221 int (*get_frame_format)(struct sr_serial_dev_inst *serial,
1222 int *baud, int *bits);
1223 size_t (*get_rx_avail)(struct sr_serial_dev_inst *serial);
1224};
1225extern SR_PRIV struct ser_lib_functions *ser_lib_funcs_libsp;
1226SR_PRIV int ser_name_is_hid(struct sr_serial_dev_inst *serial);
1227extern SR_PRIV struct ser_lib_functions *ser_lib_funcs_hid;
1228SR_PRIV int ser_name_is_bt(struct sr_serial_dev_inst *serial);
1229extern SR_PRIV struct ser_lib_functions *ser_lib_funcs_bt;
1230
1231#ifdef HAVE_LIBHIDAPI
1232struct vid_pid_item {
1233 uint16_t vid, pid;
1234};
1235#define VID_PID_TERM ALL_ZERO
1236
1237struct ser_hid_chip_functions {
1238 const char *chipname;
1239 const char *chipdesc;
1240 const struct vid_pid_item *vid_pid_items;
1241 const int max_bytes_per_request;
1242 int (*set_params)(struct sr_serial_dev_inst *serial,
1243 int baudrate, int bits, int parity, int stopbits,
1244 int flowcontrol, int rts, int dtr);
1245 int (*read_bytes)(struct sr_serial_dev_inst *serial,
1246 uint8_t *data, int space, unsigned int timeout);
1247 int (*write_bytes)(struct sr_serial_dev_inst *serial,
1248 const uint8_t *data, int space);
1249 int (*flush)(struct sr_serial_dev_inst *serial);
1250 int (*drain)(struct sr_serial_dev_inst *serial);
1251};
1252extern SR_PRIV struct ser_hid_chip_functions *ser_hid_chip_funcs_bu86x;
1253extern SR_PRIV struct ser_hid_chip_functions *ser_hid_chip_funcs_ch9325;
1254extern SR_PRIV struct ser_hid_chip_functions *ser_hid_chip_funcs_cp2110;
1255extern SR_PRIV struct ser_hid_chip_functions *ser_hid_chip_funcs_victor;
1256SR_PRIV const char *ser_hid_chip_find_name_vid_pid(uint16_t vid, uint16_t pid);
1257#endif
1258#endif
1259
1260/*--- bt/ API ---------------------------------------------------------------*/
1261
1262#ifdef HAVE_BLUETOOTH
1263SR_PRIV const char *sr_bt_adapter_get_address(size_t idx);
1264
1265struct sr_bt_desc;
1266typedef void (*sr_bt_scan_cb)(void *cb_data, const char *addr, const char *name);
1267typedef int (*sr_bt_data_cb)(void *cb_data, uint8_t *data, size_t dlen);
1268
1269SR_PRIV struct sr_bt_desc *sr_bt_desc_new(void);
1270SR_PRIV void sr_bt_desc_free(struct sr_bt_desc *desc);
1271
1272SR_PRIV int sr_bt_config_cb_scan(struct sr_bt_desc *desc,
1273 sr_bt_scan_cb cb, void *cb_data);
1274SR_PRIV int sr_bt_config_cb_data(struct sr_bt_desc *desc,
1275 sr_bt_data_cb cb, void *cb_data);
1276SR_PRIV int sr_bt_config_addr_local(struct sr_bt_desc *desc, const char *addr);
1277SR_PRIV int sr_bt_config_addr_remote(struct sr_bt_desc *desc, const char *addr);
1278SR_PRIV int sr_bt_config_rfcomm(struct sr_bt_desc *desc, size_t channel);
1279SR_PRIV int sr_bt_config_notify(struct sr_bt_desc *desc,
1280 uint16_t read_handle, uint16_t write_handle,
1281 uint16_t cccd_handle, uint16_t cccd_value);
1282
1283SR_PRIV int sr_bt_scan_le(struct sr_bt_desc *desc, int duration);
1284SR_PRIV int sr_bt_scan_bt(struct sr_bt_desc *desc, int duration);
1285
1286SR_PRIV int sr_bt_connect_ble(struct sr_bt_desc *desc);
1287SR_PRIV int sr_bt_connect_rfcomm(struct sr_bt_desc *desc);
1288SR_PRIV void sr_bt_disconnect(struct sr_bt_desc *desc);
1289
1290SR_PRIV ssize_t sr_bt_read(struct sr_bt_desc *desc,
1291 void *data, size_t len);
1292SR_PRIV ssize_t sr_bt_write(struct sr_bt_desc *desc,
1293 const void *data, size_t len);
1294
1295SR_PRIV int sr_bt_start_notify(struct sr_bt_desc *desc);
1296SR_PRIV int sr_bt_check_notify(struct sr_bt_desc *desc);
1297#endif
1298
1299/*--- ezusb.c ---------------------------------------------------------------*/
1300
1301#ifdef HAVE_LIBUSB_1_0
1302SR_PRIV int ezusb_reset(struct libusb_device_handle *hdl, int set_clear);
1303SR_PRIV int ezusb_install_firmware(struct sr_context *ctx, libusb_device_handle *hdl,
1304 const char *name);
1305SR_PRIV int ezusb_upload_firmware(struct sr_context *ctx, libusb_device *dev,
1306 int configuration, const char *name);
1307#endif
1308
1309/*--- usb.c -----------------------------------------------------------------*/
1310
1311#ifdef HAVE_LIBUSB_1_0
1312SR_PRIV GSList *sr_usb_find(libusb_context *usb_ctx, const char *conn);
1313SR_PRIV int sr_usb_open(libusb_context *usb_ctx, struct sr_usb_dev_inst *usb);
1314SR_PRIV void sr_usb_close(struct sr_usb_dev_inst *usb);
1315SR_PRIV int usb_source_add(struct sr_session *session, struct sr_context *ctx,
1316 int timeout, sr_receive_data_callback cb, void *cb_data);
1317SR_PRIV int usb_source_remove(struct sr_session *session, struct sr_context *ctx);
1318SR_PRIV int usb_get_port_path(libusb_device *dev, char *path, int path_len);
1319SR_PRIV gboolean usb_match_manuf_prod(libusb_device *dev,
1320 const char *manufacturer, const char *product);
1321#endif
1322
1323
1324/*--- modbus/modbus.c -------------------------------------------------------*/
1325
1326struct sr_modbus_dev_inst {
1327 const char *name;
1328 const char *prefix;
1329 int priv_size;
1330 GSList *(*scan)(int modbusaddr);
1331 int (*dev_inst_new)(void *priv, const char *resource,
1332 char **params, const char *serialcomm, int modbusaddr);
1333 int (*open)(void *priv);
1334 int (*source_add)(struct sr_session *session, void *priv, int events,
1335 int timeout, sr_receive_data_callback cb, void *cb_data);
1336 int (*source_remove)(struct sr_session *session, void *priv);
1337 int (*send)(void *priv, const uint8_t *buffer, int buffer_size);
1338 int (*read_begin)(void *priv, uint8_t *function_code);
1339 int (*read_data)(void *priv, uint8_t *buf, int maxlen);
1340 int (*read_end)(void *priv);
1341 int (*close)(void *priv);
1342 void (*free)(void *priv);
1343 unsigned int read_timeout_ms;
1344 void *priv;
1345};
1346
1347SR_PRIV GSList *sr_modbus_scan(struct drv_context *drvc, GSList *options,
1348 struct sr_dev_inst *(*probe_device)(struct sr_modbus_dev_inst *modbus));
1349SR_PRIV struct sr_modbus_dev_inst *modbus_dev_inst_new(const char *resource,
1350 const char *serialcomm, int modbusaddr);
1351SR_PRIV int sr_modbus_open(struct sr_modbus_dev_inst *modbus);
1352SR_PRIV int sr_modbus_source_add(struct sr_session *session,
1353 struct sr_modbus_dev_inst *modbus, int events, int timeout,
1354 sr_receive_data_callback cb, void *cb_data);
1355SR_PRIV int sr_modbus_source_remove(struct sr_session *session,
1356 struct sr_modbus_dev_inst *modbus);
1357SR_PRIV int sr_modbus_request(struct sr_modbus_dev_inst *modbus,
1358 uint8_t *request, int request_size);
1359SR_PRIV int sr_modbus_reply(struct sr_modbus_dev_inst *modbus,
1360 uint8_t *reply, int reply_size);
1361SR_PRIV int sr_modbus_request_reply(struct sr_modbus_dev_inst *modbus,
1362 uint8_t *request, int request_size,
1363 uint8_t *reply, int reply_size);
1364SR_PRIV int sr_modbus_read_coils(struct sr_modbus_dev_inst *modbus,
1365 int address, int nb_coils, uint8_t *coils);
1366SR_PRIV int sr_modbus_read_holding_registers(struct sr_modbus_dev_inst *modbus,
1367 int address, int nb_registers,
1368 uint16_t *registers);
1369SR_PRIV int sr_modbus_write_coil(struct sr_modbus_dev_inst *modbus,
1370 int address, int value);
1371SR_PRIV int sr_modbus_write_multiple_registers(struct sr_modbus_dev_inst*modbus,
1372 int address, int nb_registers,
1373 uint16_t *registers);
1374SR_PRIV int sr_modbus_close(struct sr_modbus_dev_inst *modbus);
1375SR_PRIV void sr_modbus_free(struct sr_modbus_dev_inst *modbus);
1376
1377/*--- dmm/es519xx.c ---------------------------------------------------------*/
1378
1379/**
1380 * All 11-byte es519xx chips repeat each block twice for each conversion cycle
1381 * so always read 2 blocks at a time.
1382 */
1383#define ES519XX_11B_PACKET_SIZE (11 * 2)
1384#define ES519XX_14B_PACKET_SIZE 14
1385
1386struct es519xx_info {
1387 gboolean is_judge, is_voltage, is_auto, is_micro, is_current;
1388 gboolean is_milli, is_resistance, is_continuity, is_diode;
1389 gboolean is_frequency, is_rpm, is_capacitance, is_duty_cycle;
1390 gboolean is_temperature, is_celsius, is_fahrenheit;
1391 gboolean is_adp0, is_adp1, is_adp2, is_adp3;
1392 gboolean is_sign, is_batt, is_ol, is_pmax, is_pmin, is_apo;
1393 gboolean is_dc, is_ac, is_vahz, is_min, is_max, is_rel, is_hold;
1394 gboolean is_digit4, is_ul, is_vasel, is_vbar, is_lpf1, is_lpf0, is_rmr;
1395 uint32_t baudrate;
1396 int packet_size;
1397 gboolean alt_functions, fivedigits, clampmeter, selectable_lpf;
1398 int digits;
1399};
1400
1401SR_PRIV gboolean sr_es519xx_2400_11b_packet_valid(const uint8_t *buf);
1402SR_PRIV int sr_es519xx_2400_11b_parse(const uint8_t *buf, float *floatval,
1403 struct sr_datafeed_analog *analog, void *info);
1404SR_PRIV gboolean sr_es519xx_2400_11b_altfn_packet_valid(const uint8_t *buf);
1405SR_PRIV int sr_es519xx_2400_11b_altfn_parse(const uint8_t *buf,
1406 float *floatval, struct sr_datafeed_analog *analog, void *info);
1407SR_PRIV gboolean sr_es519xx_19200_11b_5digits_packet_valid(const uint8_t *buf);
1408SR_PRIV int sr_es519xx_19200_11b_5digits_parse(const uint8_t *buf,
1409 float *floatval, struct sr_datafeed_analog *analog, void *info);
1410SR_PRIV gboolean sr_es519xx_19200_11b_clamp_packet_valid(const uint8_t *buf);
1411SR_PRIV int sr_es519xx_19200_11b_clamp_parse(const uint8_t *buf,
1412 float *floatval, struct sr_datafeed_analog *analog, void *info);
1413SR_PRIV gboolean sr_es519xx_19200_11b_packet_valid(const uint8_t *buf);
1414SR_PRIV int sr_es519xx_19200_11b_parse(const uint8_t *buf, float *floatval,
1415 struct sr_datafeed_analog *analog, void *info);
1416SR_PRIV gboolean sr_es519xx_19200_14b_packet_valid(const uint8_t *buf);
1417SR_PRIV int sr_es519xx_19200_14b_parse(const uint8_t *buf, float *floatval,
1418 struct sr_datafeed_analog *analog, void *info);
1419SR_PRIV gboolean sr_es519xx_19200_14b_sel_lpf_packet_valid(const uint8_t *buf);
1420SR_PRIV int sr_es519xx_19200_14b_sel_lpf_parse(const uint8_t *buf,
1421 float *floatval, struct sr_datafeed_analog *analog, void *info);
1422
1423/*--- dmm/fs9922.c ----------------------------------------------------------*/
1424
1425#define FS9922_PACKET_SIZE 14
1426
1427struct fs9922_info {
1428 gboolean is_auto, is_dc, is_ac, is_rel, is_hold, is_bpn, is_z1, is_z2;
1429 gboolean is_max, is_min, is_apo, is_bat, is_nano, is_z3, is_micro;
1430 gboolean is_milli, is_kilo, is_mega, is_beep, is_diode, is_percent;
1431 gboolean is_z4, is_volt, is_ampere, is_ohm, is_hfe, is_hertz, is_farad;
1432 gboolean is_celsius, is_fahrenheit;
1433 int bargraph_sign, bargraph_value;
1434};
1435
1436SR_PRIV gboolean sr_fs9922_packet_valid(const uint8_t *buf);
1437SR_PRIV int sr_fs9922_parse(const uint8_t *buf, float *floatval,
1438 struct sr_datafeed_analog *analog, void *info);
1439SR_PRIV void sr_fs9922_z1_diode(struct sr_datafeed_analog *analog, void *info);
1440
1441/*--- dmm/fs9721.c ----------------------------------------------------------*/
1442
1443#define FS9721_PACKET_SIZE 14
1444
1445struct fs9721_info {
1446 gboolean is_ac, is_dc, is_auto, is_rs232, is_micro, is_nano, is_kilo;
1447 gboolean is_diode, is_milli, is_percent, is_mega, is_beep, is_farad;
1448 gboolean is_ohm, is_rel, is_hold, is_ampere, is_volt, is_hz, is_bat;
1449 gboolean is_c2c1_11, is_c2c1_10, is_c2c1_01, is_c2c1_00, is_sign;
1450};
1451
1452SR_PRIV gboolean sr_fs9721_packet_valid(const uint8_t *buf);
1453SR_PRIV int sr_fs9721_parse(const uint8_t *buf, float *floatval,
1454 struct sr_datafeed_analog *analog, void *info);
1455SR_PRIV void sr_fs9721_00_temp_c(struct sr_datafeed_analog *analog, void *info);
1456SR_PRIV void sr_fs9721_01_temp_c(struct sr_datafeed_analog *analog, void *info);
1457SR_PRIV void sr_fs9721_10_temp_c(struct sr_datafeed_analog *analog, void *info);
1458SR_PRIV void sr_fs9721_01_10_temp_f_c(struct sr_datafeed_analog *analog, void *info);
1459SR_PRIV void sr_fs9721_max_c_min(struct sr_datafeed_analog *analog, void *info);
1460
1461/*--- dmm/ms2115b.c ---------------------------------------------------------*/
1462
1463#define MS2115B_PACKET_SIZE 9
1464
1465enum ms2115b_display {
1466 MS2115B_DISPLAY_MAIN,
1467 MS2115B_DISPLAY_SUB,
1468 MS2115B_DISPLAY_COUNT,
1469};
1470
1471struct ms2115b_info {
1472 /* Selected channel. */
1473 size_t ch_idx;
1474 gboolean is_ac, is_dc, is_auto;
1475 gboolean is_diode, is_beep, is_farad;
1476 gboolean is_ohm, is_ampere, is_volt, is_hz;
1477 gboolean is_duty_cycle, is_percent;
1478};
1479
1480extern SR_PRIV const char *ms2115b_channel_formats[];
1481SR_PRIV gboolean sr_ms2115b_packet_valid(const uint8_t *buf);
1482SR_PRIV int sr_ms2115b_parse(const uint8_t *buf, float *floatval,
1483 struct sr_datafeed_analog *analog, void *info);
1484
1485/*--- dmm/ms8250d.c ---------------------------------------------------------*/
1486
1487#define MS8250D_PACKET_SIZE 18
1488
1489struct ms8250d_info {
1490 gboolean is_ac, is_dc, is_auto, is_rs232, is_micro, is_nano, is_kilo;
1491 gboolean is_diode, is_milli, is_percent, is_mega, is_beep, is_farad;
1492 gboolean is_ohm, is_rel, is_hold, is_ampere, is_volt, is_hz, is_bat;
1493 gboolean is_ncv, is_min, is_max, is_sign, is_autotimer;
1494};
1495
1496SR_PRIV gboolean sr_ms8250d_packet_valid(const uint8_t *buf);
1497SR_PRIV int sr_ms8250d_parse(const uint8_t *buf, float *floatval,
1498 struct sr_datafeed_analog *analog, void *info);
1499
1500/*--- dmm/dtm0660.c ---------------------------------------------------------*/
1501
1502#define DTM0660_PACKET_SIZE 15
1503
1504struct dtm0660_info {
1505 gboolean is_ac, is_dc, is_auto, is_rs232, is_micro, is_nano, is_kilo;
1506 gboolean is_diode, is_milli, is_percent, is_mega, is_beep, is_farad;
1507 gboolean is_ohm, is_rel, is_hold, is_ampere, is_volt, is_hz, is_bat;
1508 gboolean is_degf, is_degc, is_c2c1_01, is_c2c1_00, is_apo, is_min;
1509 gboolean is_minmax, is_max, is_sign;
1510};
1511
1512SR_PRIV gboolean sr_dtm0660_packet_valid(const uint8_t *buf);
1513SR_PRIV int sr_dtm0660_parse(const uint8_t *buf, float *floatval,
1514 struct sr_datafeed_analog *analog, void *info);
1515
1516/*--- dmm/m2110.c -----------------------------------------------------------*/
1517
1518#define BBCGM_M2110_PACKET_SIZE 9
1519
1520/* Dummy info struct. The parser does not use it. */
1521struct m2110_info { int dummy; };
1522
1523SR_PRIV gboolean sr_m2110_packet_valid(const uint8_t *buf);
1524SR_PRIV int sr_m2110_parse(const uint8_t *buf, float *floatval,
1525 struct sr_datafeed_analog *analog, void *info);
1526
1527/*--- dmm/metex14.c ---------------------------------------------------------*/
1528
1529#define METEX14_PACKET_SIZE 14
1530
1531struct metex14_info {
1532 size_t ch_idx;
1533 gboolean is_ac, is_dc, is_resistance, is_capacity, is_temperature;
1534 gboolean is_diode, is_frequency, is_ampere, is_volt, is_farad;
1535 gboolean is_hertz, is_ohm, is_celsius, is_fahrenheit, is_watt;
1536 gboolean is_pico, is_nano, is_micro, is_milli, is_kilo, is_mega;
1537 gboolean is_gain, is_decibel, is_power, is_decibel_mw, is_power_factor;
1538 gboolean is_hfe, is_unitless, is_logic, is_min, is_max, is_avg;
1539};
1540
1541#ifdef HAVE_SERIAL_COMM
1542SR_PRIV int sr_metex14_packet_request(struct sr_serial_dev_inst *serial);
1543#endif
1544SR_PRIV gboolean sr_metex14_packet_valid(const uint8_t *buf);
1545SR_PRIV int sr_metex14_parse(const uint8_t *buf, float *floatval,
1546 struct sr_datafeed_analog *analog, void *info);
1547SR_PRIV gboolean sr_metex14_4packets_valid(const uint8_t *buf);
1548SR_PRIV int sr_metex14_4packets_parse(const uint8_t *buf, float *floatval,
1549 struct sr_datafeed_analog *analog, void *info);
1550
1551/*--- dmm/rs9lcd.c ----------------------------------------------------------*/
1552
1553#define RS9LCD_PACKET_SIZE 9
1554
1555/* Dummy info struct. The parser does not use it. */
1556struct rs9lcd_info { int dummy; };
1557
1558SR_PRIV gboolean sr_rs9lcd_packet_valid(const uint8_t *buf);
1559SR_PRIV int sr_rs9lcd_parse(const uint8_t *buf, float *floatval,
1560 struct sr_datafeed_analog *analog, void *info);
1561
1562/*--- dmm/bm25x.c -----------------------------------------------------------*/
1563
1564#define BRYMEN_BM25X_PACKET_SIZE 15
1565
1566/* Dummy info struct. The parser does not use it. */
1567struct bm25x_info { int dummy; };
1568
1569SR_PRIV gboolean sr_brymen_bm25x_packet_valid(const uint8_t *buf);
1570SR_PRIV int sr_brymen_bm25x_parse(const uint8_t *buf, float *floatval,
1571 struct sr_datafeed_analog *analog, void *info);
1572
1573/*--- dmm/bm86x.c -----------------------------------------------------------*/
1574
1575#define BRYMEN_BM86X_PACKET_SIZE 24
1576#define BRYMEN_BM86X_DISPLAY_COUNT 2
1577
1578struct brymen_bm86x_info { size_t ch_idx; };
1579
1580#ifdef HAVE_SERIAL_COMM
1581SR_PRIV int sr_brymen_bm86x_packet_request(struct sr_serial_dev_inst *serial);
1582#endif
1583SR_PRIV gboolean sr_brymen_bm86x_packet_valid(const uint8_t *buf);
1584SR_PRIV int sr_brymen_bm86x_parse(const uint8_t *buf, float *floatval,
1585 struct sr_datafeed_analog *analog, void *info);
1586
1587/*--- dmm/ut71x.c -----------------------------------------------------------*/
1588
1589#define UT71X_PACKET_SIZE 11
1590
1591struct ut71x_info {
1592 gboolean is_voltage, is_resistance, is_capacitance, is_temperature;
1593 gboolean is_celsius, is_fahrenheit, is_current, is_continuity;
1594 gboolean is_diode, is_frequency, is_duty_cycle, is_dc, is_ac;
1595 gboolean is_auto, is_manual, is_sign, is_power, is_loop_current;
1596};
1597
1598SR_PRIV gboolean sr_ut71x_packet_valid(const uint8_t *buf);
1599SR_PRIV int sr_ut71x_parse(const uint8_t *buf, float *floatval,
1600 struct sr_datafeed_analog *analog, void *info);
1601
1602/*--- dmm/vc870.c -----------------------------------------------------------*/
1603
1604#define VC870_PACKET_SIZE 23
1605
1606struct vc870_info {
1607 gboolean is_voltage, is_dc, is_ac, is_temperature, is_resistance;
1608 gboolean is_continuity, is_capacitance, is_diode, is_loop_current;
1609 gboolean is_current, is_micro, is_milli, is_power;
1610 gboolean is_power_factor_freq, is_power_apparent_power, is_v_a_rms_value;
1611 gboolean is_sign2, is_sign1, is_batt, is_ol1, is_max, is_min;
1612 gboolean is_maxmin, is_rel, is_ol2, is_open, is_manu, is_hold;
1613 gboolean is_light, is_usb, is_warning, is_auto_power, is_misplug_warn;
1614 gboolean is_lo, is_hi, is_open2;
1615
1616 gboolean is_frequency, is_dual_display, is_auto;
1617};
1618
1619SR_PRIV gboolean sr_vc870_packet_valid(const uint8_t *buf);
1620SR_PRIV int sr_vc870_parse(const uint8_t *buf, float *floatval,
1621 struct sr_datafeed_analog *analog, void *info);
1622
1623/*--- dmm/vc96.c ------------------------------------------------------------*/
1624
1625#define VC96_PACKET_SIZE 13
1626
1627struct vc96_info {
1628 size_t ch_idx;
1629 gboolean is_ac, is_dc, is_resistance, is_diode, is_ampere, is_volt;
1630 gboolean is_ohm, is_micro, is_milli, is_kilo, is_mega, is_hfe;
1631 gboolean is_unitless;
1632};
1633
1634SR_PRIV gboolean sr_vc96_packet_valid(const uint8_t *buf);
1635SR_PRIV int sr_vc96_parse(const uint8_t *buf, float *floatval,
1636 struct sr_datafeed_analog *analog, void *info);
1637
1638/*--- lcr/es51919.c ---------------------------------------------------------*/
1639
1640/* Acquisition details which apply to all supported serial-lcr devices. */
1641struct lcr_parse_info {
1642 size_t ch_idx;
1643 uint64_t output_freq;
1644 const char *circuit_model;
1645};
1646
1647#define ES51919_PACKET_SIZE 17
1648#define ES51919_CHANNEL_COUNT 2
1649#define ES51919_COMM_PARAM "9600/8n1/rts=1/dtr=1"
1650
1651SR_PRIV int es51919_config_get(uint32_t key, GVariant **data,
1652 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg);
1653SR_PRIV int es51919_config_set(uint32_t key, GVariant *data,
1654 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg);
1655SR_PRIV int es51919_config_list(uint32_t key, GVariant **data,
1656 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg);
1657SR_PRIV gboolean es51919_packet_valid(const uint8_t *pkt);
1658SR_PRIV int es51919_packet_parse(const uint8_t *pkt, float *floatval,
1659 struct sr_datafeed_analog *analog, void *info);
1660
1661/*--- dmm/ut372.c -----------------------------------------------------------*/
1662
1663#define UT372_PACKET_SIZE 27
1664
1665struct ut372_info {
1666 int dummy;
1667};
1668
1669SR_PRIV gboolean sr_ut372_packet_valid(const uint8_t *buf);
1670SR_PRIV int sr_ut372_parse(const uint8_t *buf, float *floatval,
1671 struct sr_datafeed_analog *analog, void *info);
1672
1673/*--- dmm/asycii.c ----------------------------------------------------------*/
1674
1675#define ASYCII_PACKET_SIZE 16
1676
1677struct asycii_info {
1678 gboolean is_ac, is_dc, is_ac_and_dc;
1679 gboolean is_resistance, is_capacitance, is_diode, is_gain;
1680 gboolean is_frequency, is_duty_cycle, is_duty_pos, is_duty_neg;
1681 gboolean is_pulse_width, is_period_pos, is_period_neg;
1682 gboolean is_pulse_count, is_count_pos, is_count_neg;
1683 gboolean is_ampere, is_volt, is_volt_ampere, is_farad, is_ohm;
1684 gboolean is_hertz, is_percent, is_seconds, is_decibel;
1685 gboolean is_pico, is_nano, is_micro, is_milli, is_kilo, is_mega;
1686 gboolean is_unitless;
1687 gboolean is_peak_min, is_peak_max;
1688 gboolean is_invalid;
1689};
1690
1691#ifdef HAVE_SERIAL_COMM
1692SR_PRIV int sr_asycii_packet_request(struct sr_serial_dev_inst *serial);
1693#endif
1694SR_PRIV gboolean sr_asycii_packet_valid(const uint8_t *buf);
1695SR_PRIV int sr_asycii_parse(const uint8_t *buf, float *floatval,
1696 struct sr_datafeed_analog *analog, void *info);
1697
1698/*--- dmm/eev121gw.c --------------------------------------------------------*/
1699
1700#define EEV121GW_PACKET_SIZE 19
1701
1702enum eev121gw_display {
1703 EEV121GW_DISPLAY_MAIN,
1704 EEV121GW_DISPLAY_SUB,
1705 EEV121GW_DISPLAY_BAR,
1706 EEV121GW_DISPLAY_COUNT,
1707};
1708
1709struct eev121gw_info {
1710 /* Selected channel. */
1711 size_t ch_idx;
1712 /*
1713 * Measured value, number and sign/overflow flags, scale factor
1714 * and significant digits.
1715 */
1716 uint32_t uint_value;
1717 gboolean is_ofl, is_neg;
1718 int factor, digits;
1719 /* Currently active mode (meter's function). */
1720 gboolean is_ac, is_dc, is_voltage, is_current, is_power, is_gain;
1721 gboolean is_resistance, is_capacitance, is_diode, is_temperature;
1722 gboolean is_continuity, is_frequency, is_period, is_duty_cycle;
1723 /* Quantities associated with mode/function. */
1724 gboolean is_ampere, is_volt, is_volt_ampere, is_dbm;
1725 gboolean is_ohm, is_farad, is_celsius, is_fahrenheit;
1726 gboolean is_hertz, is_seconds, is_percent, is_loop_current;
1727 gboolean is_unitless, is_logic;
1728 /* Other indicators. */
1729 gboolean is_min, is_max, is_avg, is_1ms_peak, is_rel, is_hold;
1730 gboolean is_low_pass, is_mem, is_bt, is_auto_range, is_test;
1731 gboolean is_auto_poweroff, is_low_batt;
1732};
1733
1734extern SR_PRIV const char *eev121gw_channel_formats[];
1735SR_PRIV gboolean sr_eev121gw_packet_valid(const uint8_t *buf);
1736SR_PRIV int sr_eev121gw_parse(const uint8_t *buf, float *floatval,
1737 struct sr_datafeed_analog *analog, void *info);
1738SR_PRIV int sr_eev121gw_3displays_parse(const uint8_t *buf, float *floatval,
1739 struct sr_datafeed_analog *analog, void *info);
1740
1741/*--- scale/kern.c ----------------------------------------------------------*/
1742
1743struct kern_info {
1744 gboolean is_gram, is_carat, is_ounce, is_pound, is_troy_ounce;
1745 gboolean is_pennyweight, is_grain, is_tael, is_momme, is_tola;
1746 gboolean is_percentage, is_piece, is_unstable, is_stable, is_error;
1747 int buflen;
1748};
1749
1750SR_PRIV gboolean sr_kern_packet_valid(const uint8_t *buf);
1751SR_PRIV int sr_kern_parse(const uint8_t *buf, float *floatval,
1752 struct sr_datafeed_analog *analog, void *info);
1753
1754/*--- sw_limits.c -----------------------------------------------------------*/
1755
1756struct sr_sw_limits {
1757 uint64_t limit_samples;
1758 uint64_t limit_frames;
1759 uint64_t limit_msec;
1760 uint64_t samples_read;
1761 uint64_t frames_read;
1762 uint64_t start_time;
1763};
1764
1765SR_PRIV int sr_sw_limits_config_get(struct sr_sw_limits *limits, uint32_t key,
1766 GVariant **data);
1767SR_PRIV int sr_sw_limits_config_set(struct sr_sw_limits *limits, uint32_t key,
1768 GVariant *data);
1769SR_PRIV void sr_sw_limits_acquisition_start(struct sr_sw_limits *limits);
1770SR_PRIV gboolean sr_sw_limits_check(struct sr_sw_limits *limits);
1771SR_PRIV void sr_sw_limits_update_samples_read(struct sr_sw_limits *limits,
1772 uint64_t samples_read);
1773SR_PRIV void sr_sw_limits_update_frames_read(struct sr_sw_limits *limits,
1774 uint64_t frames_read);
1775SR_PRIV void sr_sw_limits_init(struct sr_sw_limits *limits);
1776
1777#endif