2 * This file is part of the libsigrok project.
4 * Copyright (C) 2013 Bert Vermeulen <bert@biot.com>
6 * This program is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program. If not, see <http://www.gnu.org/licenses/>.
20 #ifndef LIBSIGROK_LIBSIGROK_INTERNAL_H
21 #define LIBSIGROK_LIBSIGROK_INTERNAL_H
29 #ifdef HAVE_LIBSERIALPORT
30 #include <libserialport.h>
32 #ifdef HAVE_LIBUSB_1_0
49 * libsigrok private header file, only to be used internally.
52 /*--- Macros ----------------------------------------------------------------*/
55 #define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0]))
58 #ifndef ARRAY_AND_SIZE
59 #define ARRAY_AND_SIZE(a) (a), ARRAY_SIZE(a)
63 #define G_SOURCE_FUNC(f) ((GSourceFunc) (void (*)(void)) (f)) /* Since 2.58. */
66 #define SR_RECEIVE_DATA_CALLBACK(f) \
67 ((sr_receive_data_callback) (void (*)(void)) (f))
70 * Read a 8 bits unsigned integer out of memory.
71 * @param x a pointer to the input memory
72 * @return the corresponding unsigned integer
74 static inline uint8_t read_u8(const uint8_t *p)
78 #define R8(x) read_u8((const uint8_t *)(x))
81 * Read an 8 bits signed integer out of memory.
82 * @param x a pointer to the input memory
83 * @return the corresponding signed integer
85 static inline int8_t read_i8(const uint8_t *p)
91 * Read a 16 bits big endian unsigned integer out of memory.
92 * @param x a pointer to the input memory
93 * @return the corresponding unsigned integer
95 static inline uint16_t read_u16be(const uint8_t *p)
105 #define RB16(x) read_u16be((const uint8_t *)(x))
108 * Read a 16 bits little endian unsigned integer out of memory.
109 * @param x a pointer to the input memory
110 * @return the corresponding unsigned integer
112 static inline uint16_t read_u16le(const uint8_t *p)
122 #define RL16(x) read_u16le((const uint8_t *)(x))
125 * Read a 16 bits big endian signed integer out of memory.
126 * @param x a pointer to the input memory
127 * @return the corresponding signed integer
129 static inline int16_t read_i16be(const uint8_t *p)
139 #define RB16S(x) read_i16be((const uint8_t *)(x))
142 * Read a 16 bits little endian signed integer out of memory.
143 * @param x a pointer to the input memory
144 * @return the corresponding signed integer
146 static inline int16_t read_i16le(const uint8_t *p)
156 #define RL16S(x) read_i16le((const uint8_t *)(x))
159 * Read a 24 bits little endian unsigned integer out of memory.
160 * @param x a pointer to the input memory
161 * @return the corresponding unsigned integer
163 static inline uint32_t read_u24le(const uint8_t *p)
176 * Read a 32 bits big endian unsigned integer out of memory.
177 * @param x a pointer to the input memory
178 * @return the corresponding unsigned integer
180 static inline uint32_t read_u32be(const uint8_t *p)
192 #define RB32(x) read_u32be((const uint8_t *)(x))
195 * Read a 32 bits little endian unsigned integer out of memory.
196 * @param x a pointer to the input memory
197 * @return the corresponding unsigned integer
199 static inline uint32_t read_u32le(const uint8_t *p)
211 #define RL32(x) read_u32le((const uint8_t *)(x))
214 * Read a 32 bits big endian signed integer out of memory.
215 * @param x a pointer to the input memory
216 * @return the corresponding signed integer
218 static inline int32_t read_i32be(const uint8_t *p)
228 #define RB32S(x) read_i32be((const uint8_t *)(x))
231 * Read a 32 bits little endian signed integer out of memory.
232 * @param x a pointer to the input memory
233 * @return the corresponding signed integer
235 static inline int32_t read_i32le(const uint8_t *p)
245 #define RL32S(x) read_i32le((const uint8_t *)(x))
248 * Read a 64 bits big endian unsigned integer out of memory.
249 * @param x a pointer to the input memory
250 * @return the corresponding unsigned integer
252 static inline uint64_t read_u64be(const uint8_t *p)
268 #define RB64(x) read_u64be((const uint8_t *)(x))
271 * Read a 64 bits little endian unsigned integer out of memory.
272 * @param x a pointer to the input memory
273 * @return the corresponding unsigned integer
275 static inline uint64_t read_u64le(const uint8_t *p)
291 #define RL64(x) read_u64le((const uint8_t *)(x))
294 * Read a 64 bits big endian signed integer out of memory.
295 * @param x a pointer to the input memory
296 * @return the corresponding unsigned integer
298 static inline int64_t read_i64be(const uint8_t *p)
308 #define RB64S(x) read_i64be((const uint8_t *)(x))
311 * Read a 64 bits little endian signed integer out of memory.
312 * @param x a pointer to the input memory
313 * @return the corresponding unsigned integer
315 static inline int64_t read_i64le(const uint8_t *p)
325 #define RL64S(x) read_i64le((const uint8_t *)(x))
328 * Read a 32 bits big endian float out of memory (single precision).
329 * @param x a pointer to the input memory
330 * @return the corresponding float
332 static inline float read_fltbe(const uint8_t *p)
335 * Implementor's note: Strictly speaking the "union" trick
336 * is not portable. But this phrase was found to work on the
337 * project's supported platforms, and serve well until a more
338 * appropriate phrase is found.
340 union { uint32_t u32; float flt; } u;
343 u.u32 = read_u32be(p);
348 #define RBFL(x) read_fltbe((const uint8_t *)(x))
351 * Read a 32 bits little endian float out of memory (single precision).
352 * @param x a pointer to the input memory
353 * @return the corresponding float
355 static inline float read_fltle(const uint8_t *p)
358 * Implementor's note: Strictly speaking the "union" trick
359 * is not portable. But this phrase was found to work on the
360 * project's supported platforms, and serve well until a more
361 * appropriate phrase is found.
363 union { uint32_t u32; float flt; } u;
366 u.u32 = read_u32le(p);
371 #define RLFL(x) read_fltle((const uint8_t *)(x))
374 * Read a 64 bits big endian float out of memory (double precision).
375 * @param x a pointer to the input memory
376 * @return the corresponding floating point value
378 static inline double read_dblbe(const uint8_t *p)
381 * Implementor's note: Strictly speaking the "union" trick
382 * is not portable. But this phrase was found to work on the
383 * project's supported platforms, and serve well until a more
384 * appropriate phrase is found.
386 union { uint64_t u64; double flt; } u;
389 u.u64 = read_u64be(p);
396 * Read a 64 bits little endian float out of memory (double precision).
397 * @param x a pointer to the input memory
398 * @return the corresponding floating point value
400 static inline double read_dblle(const uint8_t *p)
403 * Implementor's note: Strictly speaking the "union" trick
404 * is not portable. But this phrase was found to work on the
405 * project's supported platforms, and serve well until a more
406 * appropriate phrase is found.
408 union { uint64_t u64; double flt; } u;
411 u.u64 = read_u64le(p);
416 #define RLDB(x) read_dblle((const uint8_t *)(x))
419 * Write a 8 bits unsigned integer to memory.
420 * @param p a pointer to the output memory
421 * @param x the input unsigned integer
423 static inline void write_u8(uint8_t *p, uint8_t x)
427 #define W8(p, x) write_u8((uint8_t *)(p), (uint8_t)(x))
430 * Write a 16 bits unsigned integer to memory stored as big endian.
431 * @param p a pointer to the output memory
432 * @param x the input unsigned integer
434 static inline void write_u16be(uint8_t *p, uint16_t x)
436 p[1] = x & 0xff; x >>= 8;
437 p[0] = x & 0xff; x >>= 8;
439 #define WB16(p, x) write_u16be((uint8_t *)(p), (uint16_t)(x))
442 * Write a 16 bits unsigned integer to memory stored as little endian.
443 * @param p a pointer to the output memory
444 * @param x the input unsigned integer
446 static inline void write_u16le(uint8_t *p, uint16_t x)
448 p[0] = x & 0xff; x >>= 8;
449 p[1] = x & 0xff; x >>= 8;
451 #define WL16(p, x) write_u16le((uint8_t *)(p), (uint16_t)(x))
454 * Write a 24 bits unsigned integer to memory stored as little endian.
455 * @param p a pointer to the output memory
456 * @param x the input unsigned integer
458 static inline void write_u24le(uint8_t *p, uint32_t x)
460 p[0] = x & 0xff; x >>= 8;
461 p[1] = x & 0xff; x >>= 8;
462 p[2] = x & 0xff; x >>= 8;
464 #define WL24(p, x) write_u24le((uint8_t *)(p), (uint32_t)(x))
467 * Write a 32 bits unsigned integer to memory stored as big endian.
468 * @param p a pointer to the output memory
469 * @param x the input unsigned integer
471 static inline void write_u32be(uint8_t *p, uint32_t x)
473 p[3] = x & 0xff; x >>= 8;
474 p[2] = x & 0xff; x >>= 8;
475 p[1] = x & 0xff; x >>= 8;
476 p[0] = x & 0xff; x >>= 8;
478 #define WB32(p, x) write_u32be((uint8_t *)(p), (uint32_t)(x))
481 * Write a 32 bits unsigned integer to memory stored as little endian.
482 * @param p a pointer to the output memory
483 * @param x the input unsigned integer
485 static inline void write_u32le(uint8_t *p, uint32_t x)
487 p[0] = x & 0xff; x >>= 8;
488 p[1] = x & 0xff; x >>= 8;
489 p[2] = x & 0xff; x >>= 8;
490 p[3] = x & 0xff; x >>= 8;
492 #define WL32(p, x) write_u32le((uint8_t *)(p), (uint32_t)(x))
495 * Write a 40 bits unsigned integer to memory stored as little endian.
496 * @param p a pointer to the output memory
497 * @param x the input unsigned integer
499 static inline void write_u40le(uint8_t *p, uint64_t x)
501 p[0] = x & 0xff; x >>= 8;
502 p[1] = x & 0xff; x >>= 8;
503 p[2] = x & 0xff; x >>= 8;
504 p[3] = x & 0xff; x >>= 8;
505 p[4] = x & 0xff; x >>= 8;
507 #define WL40(p, x) write_u40le((uint8_t *)(p), (uint64_t)(x))
510 * Write a 48 bits unsigned integer to memory stored as little endian.
511 * @param p a pointer to the output memory
512 * @param x the input unsigned integer
514 static inline void write_u48le(uint8_t *p, uint64_t x)
516 p[0] = x & 0xff; x >>= 8;
517 p[1] = x & 0xff; x >>= 8;
518 p[2] = x & 0xff; x >>= 8;
519 p[3] = x & 0xff; x >>= 8;
520 p[4] = x & 0xff; x >>= 8;
521 p[5] = x & 0xff; x >>= 8;
523 #define WL48(p, x) write_u48le((uint8_t *)(p), (uint64_t)(x))
526 * Write a 64 bits unsigned integer to memory stored as big endian.
527 * @param p a pointer to the output memory
528 * @param x the input unsigned integer
530 static inline void write_u64be(uint8_t *p, uint64_t x)
532 p[7] = x & 0xff; x >>= 8;
533 p[6] = x & 0xff; x >>= 8;
534 p[5] = x & 0xff; x >>= 8;
535 p[4] = x & 0xff; x >>= 8;
536 p[3] = x & 0xff; x >>= 8;
537 p[2] = x & 0xff; x >>= 8;
538 p[1] = x & 0xff; x >>= 8;
539 p[0] = x & 0xff; x >>= 8;
543 * Write a 64 bits unsigned integer to memory stored as little endian.
544 * @param p a pointer to the output memory
545 * @param x the input unsigned integer
547 static inline void write_u64le(uint8_t *p, uint64_t x)
549 p[0] = x & 0xff; x >>= 8;
550 p[1] = x & 0xff; x >>= 8;
551 p[2] = x & 0xff; x >>= 8;
552 p[3] = x & 0xff; x >>= 8;
553 p[4] = x & 0xff; x >>= 8;
554 p[5] = x & 0xff; x >>= 8;
555 p[6] = x & 0xff; x >>= 8;
556 p[7] = x & 0xff; x >>= 8;
558 #define WL64(p, x) write_u64le((uint8_t *)(p), (uint64_t)(x))
561 * Write a 32 bits float to memory stored as big endian.
562 * @param p a pointer to the output memory
563 * @param x the input float
565 static inline void write_fltbe(uint8_t *p, float x)
567 union { uint32_t u; float f; } u;
571 #define WBFL(p, x) write_fltbe((uint8_t *)(p), (x))
574 * Write a 32 bits float to memory stored as little endian.
575 * @param p a pointer to the output memory
576 * @param x the input float
578 static inline void write_fltle(uint8_t *p, float x)
580 union { uint32_t u; float f; } u;
584 #define WLFL(p, x) write_fltle((uint8_t *)(p), float (x))
587 * Write a 64 bits float to memory stored as little endian.
588 * @param p a pointer to the output memory
589 * @param x the input floating point value
591 static inline void write_dblle(uint8_t *p, double x)
593 union { uint64_t u; double f; } u;
597 #define WLDB(p, x) write_dblle((uint8_t *)(p), float (x))
599 /* Endianess conversion helpers with read/write position increment. */
602 * Read unsigned 8bit integer from raw memory, increment read position.
603 * @param[in, out] p Pointer into byte stream.
604 * @return Retrieved integer value, unsigned.
606 static inline uint8_t read_u8_inc(const uint8_t **p)
619 * Read unsigned 8bit integer, check length, increment read position.
620 * @param[in, out] p Pointer into byte stream.
621 * @param[in, out] l Remaining input payload length.
622 * @return Retrieved integer value, unsigned.
624 static inline uint8_t read_u8_inc_len(const uint8_t **p, size_t *l)
630 if (l && *l < sizeof(v)) {
643 * Read signed 8bit integer from raw memory, increment read position.
644 * @param[in, out] p Pointer into byte stream.
645 * @return Retrieved integer value, signed.
647 static inline int8_t read_i8_inc(const uint8_t **p)
660 * Read unsigned 16bit integer from raw memory (big endian format), increment read position.
661 * @param[in, out] p Pointer into byte stream.
662 * @return Retrieved integer value, unsigned.
664 static inline uint16_t read_u16be_inc(const uint8_t **p)
677 * Read unsigned 16bit integer from raw memory (little endian format), increment read position.
678 * @param[in, out] p Pointer into byte stream.
679 * @return Retrieved integer value, unsigned.
681 static inline uint16_t read_u16le_inc(const uint8_t **p)
694 * Read unsigned 16bit integer (LE format), check length, increment position.
695 * @param[in, out] p Pointer into byte stream.
696 * @param[in, out] l Remaining input payload length.
697 * @return Retrieved integer value, unsigned.
699 static inline uint16_t read_u16le_inc_len(const uint8_t **p, size_t *l)
705 if (l && *l < sizeof(v)) {
718 * Read signed 16bit integer from raw memory (big endian format), increment read position.
719 * @param[in, out] p Pointer into byte stream.
720 * @return Retrieved integer value, signed.
722 static inline int16_t read_i16be_inc(const uint8_t **p)
735 * Read signed 16bit integer from raw memory (little endian format), increment read position.
736 * @param[in, out] p Pointer into byte stream.
737 * @return Retrieved integer value, signed.
739 static inline int16_t read_i16le_inc(const uint8_t **p)
752 * Read unsigned 24bit integer from raw memory (little endian format), increment read position.
753 * @param[in, out] p Pointer into byte stream.
754 * @return Retrieved integer value, unsigned.
756 static inline uint32_t read_u24le_inc(const uint8_t **p)
763 *p += 3 * sizeof(uint8_t);
769 * Read unsigned 32bit integer from raw memory (big endian format), increment read position.
770 * @param[in, out] p Pointer into byte stream.
771 * @return Retrieved integer value, unsigned.
773 static inline uint32_t read_u32be_inc(const uint8_t **p)
786 * Read unsigned 32bit integer from raw memory (little endian format), increment read position.
787 * @param[in, out] p Pointer into byte stream.
788 * @return Retrieved integer value, unsigned.
790 static inline uint32_t read_u32le_inc(const uint8_t **p)
803 * Read signed 32bit integer from raw memory (big endian format), increment read position.
804 * @param[in, out] p Pointer into byte stream.
805 * @return Retrieved integer value, signed.
807 static inline int32_t read_i32be_inc(const uint8_t **p)
820 * Read signed 32bit integer from raw memory (little endian format), increment read position.
821 * @param[in, out] p Pointer into byte stream.
822 * @return Retrieved integer value, signed.
824 static inline int32_t read_i32le_inc(const uint8_t **p)
837 * Read unsigned 64bit integer from raw memory (big endian format), increment read position.
838 * @param[in, out] p Pointer into byte stream.
839 * @return Retrieved integer value, unsigned.
841 static inline uint64_t read_u64be_inc(const uint8_t **p)
854 * Read unsigned 64bit integer from raw memory (little endian format), increment read position.
855 * @param[in, out] p Pointer into byte stream.
856 * @return Retrieved integer value, unsigned.
858 static inline uint64_t read_u64le_inc(const uint8_t **p)
871 * Read 32bit float from raw memory (big endian format), increment read position.
872 * @param[in, out] p Pointer into byte stream.
873 * @return Retrieved float value.
875 static inline float read_fltbe_inc(const uint8_t **p)
888 * Read 32bit float from raw memory (little endian format), increment read position.
889 * @param[in, out] p Pointer into byte stream.
890 * @return Retrieved float value.
892 static inline float read_fltle_inc(const uint8_t **p)
905 * Read 64bit float from raw memory (big endian format), increment read position.
906 * @param[in, out] p Pointer into byte stream.
907 * @return Retrieved float value.
909 static inline double read_dblbe_inc(const uint8_t **p)
922 * Read 64bit float from raw memory (little endian format), increment read position.
923 * @param[in, out] p Pointer into byte stream.
924 * @return Retrieved float value.
926 static inline double read_dblle_inc(const uint8_t **p)
939 * Write unsigned 8bit integer to raw memory, increment write position.
940 * @param[in, out] p Pointer into byte stream.
941 * @param[in] x Value to write.
943 static inline void write_u8_inc(uint8_t **p, uint8_t x)
952 * Write unsigned 16bit big endian integer to raw memory, increment write position.
953 * @param[in, out] p Pointer into byte stream.
954 * @param[in] x Value to write.
956 static inline void write_u16be_inc(uint8_t **p, uint16_t x)
965 * Write unsigned 16bit little endian integer to raw memory, increment write position.
966 * @param[in, out] p Pointer into byte stream.
967 * @param[in] x Value to write.
969 static inline void write_u16le_inc(uint8_t **p, uint16_t x)
978 * Write unsigned 24bit liggle endian integer to raw memory, increment write position.
979 * @param[in, out] p Pointer into byte stream.
980 * @param[in] x Value to write.
982 static inline void write_u24le_inc(uint8_t **p, uint32_t x)
987 *p += 3 * sizeof(uint8_t);
991 * Write unsigned 32bit big endian integer to raw memory, increment write position.
992 * @param[in, out] p Pointer into byte stream.
993 * @param[in] x Value to write.
995 static inline void write_u32be_inc(uint8_t **p, uint32_t x)
1004 * Write unsigned 32bit little endian integer to raw memory, increment write position.
1005 * @param[in, out] p Pointer into byte stream.
1006 * @param[in] x Value to write.
1008 static inline void write_u32le_inc(uint8_t **p, uint32_t x)
1017 * Write unsigned 40bit little endian integer to raw memory, increment write position.
1018 * @param[in, out] p Pointer into byte stream.
1019 * @param[in] x Value to write.
1021 static inline void write_u40le_inc(uint8_t **p, uint64_t x)
1026 *p += 5 * sizeof(uint8_t);
1030 * Write unsigned 48bit little endian integer to raw memory, increment write position.
1031 * @param[in, out] p Pointer into byte stream.
1032 * @param[in] x Value to write.
1034 static inline void write_u48le_inc(uint8_t **p, uint64_t x)
1039 *p += 48 / 8 * sizeof(uint8_t);
1043 * Write unsigned 64bit little endian integer to raw memory, increment write position.
1044 * @param[in, out] p Pointer into byte stream.
1045 * @param[in] x Value to write.
1047 static inline void write_u64le_inc(uint8_t **p, uint64_t x)
1056 * Write single precision little endian float to raw memory, increment write position.
1057 * @param[in, out] p Pointer into byte stream.
1058 * @param[in] x Value to write.
1060 static inline void write_fltle_inc(uint8_t **p, float x)
1069 * Write double precision little endian float to raw memory, increment write position.
1070 * @param[in, out] p Pointer into byte stream.
1071 * @param[in] x Value to write.
1073 static inline void write_dblle_inc(uint8_t **p, double x)
1081 /* Portability fixes for FreeBSD. */
1083 #define LIBUSB_CLASS_APPLICATION 0xfe
1084 #define libusb_has_capability(x) 0
1085 #define libusb_handle_events_timeout_completed(ctx, tv, c) \
1086 libusb_handle_events_timeout(ctx, tv)
1090 * Convenience for FTDI library version dependency.
1091 * - Version 1.5 introduced ftdi_tciflush(), ftdi_tcoflush(), and
1092 * ftdi_tcioflush() all within the same commit, and deprecated
1093 * ftdi_usb_purge_buffers() which suffered from inverse semantics.
1094 * The API is drop-in compatible (arguments count and data types are
1095 * identical). The libsigrok source code always flushes RX and TX at
1096 * the same time, never individually.
1098 #if defined HAVE_FTDI_TCIOFLUSH && HAVE_FTDI_TCIOFLUSH
1099 # define PURGE_FTDI_BOTH ftdi_tcioflush
1101 # define PURGE_FTDI_BOTH ftdi_usb_purge_buffers
1104 /* Static definitions of structs ending with an all-zero entry are a
1105 * problem when compiling with -Wmissing-field-initializers: GCC
1106 * suppresses the warning only with { 0 }, clang wants { } */
1108 #define ALL_ZERO { }
1110 #define ALL_ZERO { 0 }
1114 #define SR_DRIVER_LIST_SECTION "__DATA,__sr_driver_list"
1116 #define SR_DRIVER_LIST_SECTION "__sr_driver_list"
1119 #if !defined SR_DRIVER_LIST_NOREORDER && defined __has_attribute
1120 #if __has_attribute(no_reorder)
1121 #define SR_DRIVER_LIST_NOREORDER __attribute__((no_reorder))
1124 #if !defined SR_DRIVER_LIST_NOREORDER
1125 #define SR_DRIVER_LIST_NOREORDER /* EMPTY */
1129 * Register a list of hardware drivers.
1131 * This macro can be used to register multiple hardware drivers to the library.
1132 * This is useful when a driver supports multiple similar but slightly
1133 * different devices that require different sr_dev_driver struct definitions.
1135 * For registering only a single driver see SR_REGISTER_DEV_DRIVER().
1139 * #define MY_DRIVER(_name) \
1140 * &(struct sr_dev_driver){ \
1145 * SR_REGISTER_DEV_DRIVER_LIST(my_driver_infos,
1146 * MY_DRIVER("driver 1"),
1147 * MY_DRIVER("driver 2"),
1152 * @param name Name to use for the driver list identifier.
1153 * @param ... Comma separated list of pointers to sr_dev_driver structs.
1155 #define SR_REGISTER_DEV_DRIVER_LIST(name, ...) \
1156 static const struct sr_dev_driver *name[] \
1157 SR_DRIVER_LIST_NOREORDER \
1158 __attribute__((section (SR_DRIVER_LIST_SECTION), used, \
1159 aligned(sizeof(struct sr_dev_driver *)))) \
1165 * Register a hardware driver.
1167 * This macro is used to register a hardware driver with the library. It has
1168 * to be used in order to make the driver accessible to applications using the
1171 * The macro invocation should be placed directly under the struct
1172 * sr_dev_driver definition.
1176 * static struct sr_dev_driver driver_info = {
1180 * SR_REGISTER_DEV_DRIVER(driver_info);
1183 * @param name Identifier name of sr_dev_driver struct to register.
1185 #define SR_REGISTER_DEV_DRIVER(name) \
1186 SR_REGISTER_DEV_DRIVER_LIST(name##_list, &name);
1188 SR_API void sr_drivers_init(struct sr_context *context);
1191 struct sr_dev_driver **driver_list;
1192 #ifdef HAVE_LIBUSB_1_0
1193 libusb_context *libusb_ctx;
1195 sr_resource_open_callback resource_open_cb;
1196 sr_resource_close_callback resource_close_cb;
1197 sr_resource_read_callback resource_read_cb;
1198 void *resource_cb_data;
1201 /** Input module metadata keys. */
1202 enum sr_input_meta_keys {
1203 /** The input filename, if there is one. */
1204 SR_INPUT_META_FILENAME = 0x01,
1205 /** The input file's size in bytes. */
1206 SR_INPUT_META_FILESIZE = 0x02,
1207 /** The first 128 bytes of the file, provided as a GString. */
1208 SR_INPUT_META_HEADER = 0x04,
1210 /** The module cannot identify a file without this metadata. */
1211 SR_INPUT_META_REQUIRED = 0x80,
1214 /** Input (file) module struct. */
1217 * A pointer to this input module's 'struct sr_input_module'.
1219 const struct sr_input_module *module;
1221 struct sr_dev_inst *sdi;
1226 /** Input (file) module driver. */
1227 struct sr_input_module {
1229 * A unique ID for this input module, suitable for use in command-line
1230 * clients, [a-z0-9-]. Must not be NULL.
1235 * A unique name for this input module, suitable for use in GUI
1236 * clients, can contain UTF-8. Must not be NULL.
1241 * A short description of the input module. Must not be NULL.
1243 * This can be displayed by frontends, e.g. when selecting the input
1244 * module for saving a file.
1249 * A NULL terminated array of strings containing a list of file name
1250 * extensions typical for the input file format, or NULL if there is
1251 * no typical extension for this file format.
1253 const char *const *exts;
1256 * Zero-terminated list of metadata items the module needs to be able
1257 * to identify an input stream. Can be all-zero, if the module cannot
1258 * identify streams at all, i.e. has to be forced into use.
1260 * Each item is one of:
1261 * SR_INPUT_META_FILENAME
1262 * SR_INPUT_META_FILESIZE
1263 * SR_INPUT_META_HEADER
1265 * If the high bit (SR_INPUT META_REQUIRED) is set, the module cannot
1266 * identify a stream without the given metadata.
1268 const uint8_t metadata[8];
1271 * Returns a NULL-terminated list of options this module can take.
1272 * Can be NULL, if the module has no options.
1274 const struct sr_option *(*options) (void);
1277 * Check if this input module can load and parse the specified stream.
1279 * @param[in] metadata Metadata the module can use to identify the stream.
1280 * @param[out] confidence "Strength" of the detection.
1281 * Specialized handlers can take precedence over generic/basic support.
1283 * @retval SR_OK This module knows the format.
1284 * @retval SR_ERR_NA There wasn't enough data for this module to
1285 * positively identify the format.
1286 * @retval SR_ERR_DATA This module knows the format, but cannot handle
1287 * it. This means the stream is either corrupt, or indicates a
1288 * feature that the module does not support.
1289 * @retval SR_ERR This module does not know the format.
1291 * Lower numeric values of 'confidence' mean that the input module
1292 * stronger believes in its capability to handle this specific format.
1293 * This way, multiple input modules can claim support for a format,
1294 * and the application can pick the best match, or try fallbacks
1295 * in case of errors. This approach also copes with formats that
1296 * are unreliable to detect in the absence of magic signatures.
1298 int (*format_match) (GHashTable *metadata, unsigned int *confidence);
1301 * Initialize the input module.
1303 * @retval SR_OK Success
1304 * @retval other Negative error code.
1306 int (*init) (struct sr_input *in, GHashTable *options);
1309 * Send data to the specified input instance.
1311 * When an input module instance is created with sr_input_new(), this
1312 * function is used to feed data to the instance.
1314 * As enough data gets fed into this function to completely populate
1315 * the device instance associated with this input instance, this is
1316 * guaranteed to return the moment it's ready. This gives the caller
1317 * the chance to examine the device instance, attach session callbacks
1320 * @retval SR_OK Success
1321 * @retval other Negative error code.
1323 int (*receive) (struct sr_input *in, GString *buf);
1326 * Signal the input module no more data will come.
1328 * This will cause the module to process any data it may have buffered.
1329 * The SR_DF_END packet will also typically be sent at this time.
1331 int (*end) (struct sr_input *in);
1334 * Reset the input module's input handling structures.
1336 * Causes the input module to reset its internal state so that we can
1337 * re-send the input data from the beginning without having to
1338 * re-create the entire input module.
1340 * @retval SR_OK Success.
1341 * @retval other Negative error code.
1343 int (*reset) (struct sr_input *in);
1346 * This function is called after the caller is finished using
1347 * the input module, and can be used to free any internal
1348 * resources the module may keep.
1350 * This function is optional.
1352 * @retval SR_OK Success
1353 * @retval other Negative error code.
1355 void (*cleanup) (struct sr_input *in);
1358 /** Output module instance. */
1360 /** A pointer to this output's module. */
1361 const struct sr_output_module *module;
1364 * The device for which this output module is creating output. This
1365 * can be used by the module to find out channel names and numbers.
1367 const struct sr_dev_inst *sdi;
1370 * The name of the file that the data should be written to.
1372 const char *filename;
1375 * A generic pointer which can be used by the module to keep internal
1376 * state between calls into its callback functions.
1378 * For example, the module might store a pointer to a chunk of output
1379 * there, and only flush it when it reaches a certain size.
1384 /** Output module driver. */
1385 struct sr_output_module {
1387 * A unique ID for this output module, suitable for use in command-line
1388 * clients, [a-z0-9-]. Must not be NULL.
1393 * A unique name for this output module, suitable for use in GUI
1394 * clients, can contain UTF-8. Must not be NULL.
1399 * A short description of the output module. Must not be NULL.
1401 * This can be displayed by frontends, e.g. when selecting the output
1402 * module for saving a file.
1407 * A NULL terminated array of strings containing a list of file name
1408 * extensions typical for the input file format, or NULL if there is
1409 * no typical extension for this file format.
1411 const char *const *exts;
1414 * Bitfield containing flags that describe certain properties
1415 * this output module may or may not have.
1416 * @see sr_output_flags
1418 const uint64_t flags;
1421 * Returns a NULL-terminated list of options this module can take.
1422 * Can be NULL, if the module has no options.
1424 const struct sr_option *(*options) (void);
1427 * This function is called once, at the beginning of an output stream.
1429 * The device struct will be available in the output struct passed in,
1430 * as well as the param field -- which may be NULL or an empty string,
1431 * if no parameter was passed.
1433 * The module can use this to initialize itself, create a struct for
1434 * keeping state and storing it in the <code>internal</code> field.
1436 * @param o Pointer to the respective 'struct sr_output'.
1438 * @retval SR_OK Success
1439 * @retval other Negative error code.
1441 int (*init) (struct sr_output *o, GHashTable *options);
1444 * This function is passed a copy of every packet in the data feed.
1445 * Any output generated by the output module in response to the
1446 * packet should be returned in a newly allocated GString
1447 * <code>out</code>, which will be freed by the caller.
1449 * Packets not of interest to the output module can just be ignored,
1450 * and the <code>out</code> parameter set to NULL.
1452 * @param o Pointer to the respective 'struct sr_output'.
1453 * @param sdi The device instance that generated the packet.
1454 * @param packet The complete packet.
1455 * @param out A pointer where a GString * should be stored if
1456 * the module generates output, or NULL if not.
1458 * @retval SR_OK Success
1459 * @retval other Negative error code.
1461 int (*receive) (const struct sr_output *o,
1462 const struct sr_datafeed_packet *packet, GString **out);
1465 * This function is called after the caller is finished using
1466 * the output module, and can be used to free any internal
1467 * resources the module may keep.
1469 * @retval SR_OK Success
1470 * @retval other Negative error code.
1472 int (*cleanup) (struct sr_output *o);
1475 /** Transform module instance. */
1476 struct sr_transform {
1477 /** A pointer to this transform's module. */
1478 const struct sr_transform_module *module;
1481 * The device for which this transform module is used. This
1482 * can be used by the module to find out channel names and numbers.
1484 const struct sr_dev_inst *sdi;
1487 * A generic pointer which can be used by the module to keep internal
1488 * state between calls into its callback functions.
1493 struct sr_transform_module {
1495 * A unique ID for this transform module, suitable for use in
1496 * command-line clients, [a-z0-9-]. Must not be NULL.
1501 * A unique name for this transform module, suitable for use in GUI
1502 * clients, can contain UTF-8. Must not be NULL.
1507 * A short description of the transform module. Must not be NULL.
1509 * This can be displayed by frontends, e.g. when selecting
1510 * which transform module(s) to add.
1515 * Returns a NULL-terminated list of options this transform module
1516 * can take. Can be NULL, if the transform module has no options.
1518 const struct sr_option *(*options) (void);
1521 * This function is called once, at the beginning of a stream.
1523 * @param t Pointer to the respective 'struct sr_transform'.
1524 * @param options Hash table of options for this transform module.
1525 * Can be NULL if no options are to be used.
1527 * @retval SR_OK Success
1528 * @retval other Negative error code.
1530 int (*init) (struct sr_transform *t, GHashTable *options);
1533 * This function is passed a pointer to every packet in the data feed.
1535 * It can either return (in packet_out) a pointer to another packet
1536 * (possibly the exact same packet it got as input), or NULL.
1538 * @param t Pointer to the respective 'struct sr_transform'.
1539 * @param packet_in Pointer to a datafeed packet.
1540 * @param packet_out Pointer to the resulting datafeed packet after
1541 * this function was run. If NULL, the transform
1542 * module intentionally didn't output a new packet.
1544 * @retval SR_OK Success
1545 * @retval other Negative error code.
1547 int (*receive) (const struct sr_transform *t,
1548 struct sr_datafeed_packet *packet_in,
1549 struct sr_datafeed_packet **packet_out);
1552 * This function is called after the caller is finished using
1553 * the transform module, and can be used to free any internal
1554 * resources the module may keep.
1556 * @retval SR_OK Success
1557 * @retval other Negative error code.
1559 int (*cleanup) (struct sr_transform *t);
1562 #ifdef HAVE_LIBUSB_1_0
1563 /** USB device instance */
1564 struct sr_usb_dev_inst {
1567 /** Device address on USB bus */
1569 /** libusb device handle */
1570 struct libusb_device_handle *devhdl;
1574 struct sr_serial_dev_inst;
1575 #ifdef HAVE_SERIAL_COMM
1576 struct ser_lib_functions;
1577 struct ser_hid_chip_functions;
1579 typedef void (*serial_rx_chunk_callback)(struct sr_serial_dev_inst *serial,
1580 void *cb_data, const void *buf, size_t count);
1581 struct sr_serial_dev_inst {
1582 /** Port name, e.g. '/dev/tty42'. */
1584 /** Comm params for serial_set_paramstr(). */
1586 struct ser_lib_functions *lib_funcs;
1593 GString *rcv_buffer;
1594 serial_rx_chunk_callback rx_chunk_cb_func;
1595 void *rx_chunk_cb_data;
1596 #ifdef HAVE_LIBSERIALPORT
1597 /** libserialport port handle */
1598 struct sp_port *sp_data;
1600 #ifdef HAVE_LIBHIDAPI
1601 enum ser_hid_chip_t {
1602 SER_HID_CHIP_UNKNOWN, /**!< place holder */
1603 SER_HID_CHIP_BTC_BU86X, /**!< Brymen BU86x */
1604 SER_HID_CHIP_SIL_CP2110, /**!< SiLabs CP2110 */
1605 SER_HID_CHIP_VICTOR_DMM, /**!< Victor 70/86 DMM cable */
1606 SER_HID_CHIP_WCH_CH9325, /**!< WCH CH9325 */
1607 SER_HID_CHIP_LAST, /**!< sentinel */
1609 struct ser_hid_chip_functions *hid_chip_funcs;
1612 const char *hid_path;
1613 hid_device *hid_dev;
1614 GSList *hid_source_args;
1616 #ifdef HAVE_BLUETOOTH
1617 enum ser_bt_conn_t {
1618 SER_BT_CONN_UNKNOWN, /**!< place holder */
1619 SER_BT_CONN_RFCOMM, /**!< BT classic, RFCOMM channel */
1620 SER_BT_CONN_BLE122, /**!< BLE, BLE122 module, indications */
1621 SER_BT_CONN_NRF51, /**!< BLE, Nordic nRF51, notifications */
1622 SER_BT_CONN_CC254x, /**!< BLE, TI CC254x, notifications */
1623 SER_BT_CONN_AC6328, /**!< BLE, JL AC6328B, notifications */
1624 SER_BT_CONN_MAX, /**!< sentinel */
1626 char *bt_addr_local;
1627 char *bt_addr_remote;
1628 size_t bt_rfcomm_channel;
1629 uint16_t bt_notify_handle_read;
1630 uint16_t bt_notify_handle_write;
1631 uint16_t bt_notify_handle_cccd;
1632 uint16_t bt_notify_value_cccd;
1633 struct sr_bt_desc *bt_desc;
1634 GSList *bt_source_args;
1639 struct sr_usbtmc_dev_inst {
1644 /* Private driver context. */
1645 struct drv_context {
1646 /** sigrok context */
1647 struct sr_context *sr_ctx;
1651 /*--- log.c -----------------------------------------------------------------*/
1653 #if defined(_WIN32) && (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 4))
1655 * On MinGW, we need to specify the gnu_printf format flavor or GCC
1656 * will assume non-standard Microsoft printf syntax.
1658 SR_PRIV int sr_log(int loglevel, const char *format, ...)
1659 __attribute__((__format__ (__gnu_printf__, 2, 3)));
1661 SR_PRIV int sr_log(int loglevel, const char *format, ...) G_GNUC_PRINTF(2, 3);
1664 /* Message logging helpers with subsystem-specific prefix string. */
1665 #define sr_spew(...) sr_log(SR_LOG_SPEW, LOG_PREFIX ": " __VA_ARGS__)
1666 #define sr_dbg(...) sr_log(SR_LOG_DBG, LOG_PREFIX ": " __VA_ARGS__)
1667 #define sr_info(...) sr_log(SR_LOG_INFO, LOG_PREFIX ": " __VA_ARGS__)
1668 #define sr_warn(...) sr_log(SR_LOG_WARN, LOG_PREFIX ": " __VA_ARGS__)
1669 #define sr_err(...) sr_log(SR_LOG_ERR, LOG_PREFIX ": " __VA_ARGS__)
1671 /*--- device.c --------------------------------------------------------------*/
1673 /** Scan options supported by a driver. */
1674 #define SR_CONF_SCAN_OPTIONS 0x7FFF0000
1676 /** Device options for a particular device. */
1677 #define SR_CONF_DEVICE_OPTIONS 0x7FFF0001
1679 /** Mask for separating config keys from capabilities. */
1680 #define SR_CONF_MASK 0x1fffffff
1682 /** Values for the changes argument of sr_dev_driver.config_channel_set. */
1684 /** The enabled state of the channel has been changed. */
1685 SR_CHANNEL_SET_ENABLED = 1 << 0,
1688 SR_PRIV struct sr_channel *sr_channel_new(struct sr_dev_inst *sdi,
1689 int index, int type, gboolean enabled, const char *name);
1690 SR_PRIV void sr_channel_free(struct sr_channel *ch);
1691 SR_PRIV void sr_channel_free_cb(void *p);
1692 SR_PRIV struct sr_channel *sr_next_enabled_channel(const struct sr_dev_inst *sdi,
1693 struct sr_channel *cur_channel);
1694 SR_PRIV gboolean sr_channels_differ(struct sr_channel *ch1, struct sr_channel *ch2);
1695 SR_PRIV gboolean sr_channel_lists_differ(GSList *l1, GSList *l2);
1697 SR_PRIV struct sr_channel_group *sr_channel_group_new(struct sr_dev_inst *sdi,
1698 const char *name, void *priv);
1699 SR_PRIV void sr_channel_group_free(struct sr_channel_group *cg);
1700 SR_PRIV void sr_channel_group_free_cb(void *cg);
1702 /** Device instance data */
1703 struct sr_dev_inst {
1704 /** Device driver. */
1705 struct sr_dev_driver *driver;
1706 /** Device instance status. SR_ST_NOT_FOUND, etc. */
1708 /** Device instance type. SR_INST_USB, etc. */
1710 /** Device vendor. */
1712 /** Device model. */
1714 /** Device version. */
1716 /** Serial number. */
1718 /** Connection string to uniquely identify devices. */
1719 char *connection_id;
1720 /** List of channels. */
1722 /** List of sr_channel_group structs */
1723 GSList *channel_groups;
1724 /** Device instance connection data (used?) */
1726 /** Device instance private data (used?) */
1728 /** Session to which this device is currently assigned. */
1729 struct sr_session *session;
1732 /* Generic device instances */
1733 SR_PRIV void sr_dev_inst_free(struct sr_dev_inst *sdi);
1735 #ifdef HAVE_LIBUSB_1_0
1736 /* USB-specific instances */
1737 SR_PRIV struct sr_usb_dev_inst *sr_usb_dev_inst_new(uint8_t bus,
1738 uint8_t address, struct libusb_device_handle *hdl);
1739 SR_PRIV void sr_usb_dev_inst_free(struct sr_usb_dev_inst *usb);
1740 SR_PRIV void sr_usb_dev_inst_free_cb(gpointer p); /* Glib wrapper. */
1743 #ifdef HAVE_SERIAL_COMM
1744 #ifndef HAVE_LIBSERIALPORT
1746 * Some identifiers which initially got provided by libserialport are
1747 * used internally within the libsigrok serial layer's implementation,
1748 * while libserialport no longer is the exclusive provider of serial
1749 * communication support. Declare the identifiers here so they remain
1750 * available across all build configurations.
1757 SP_PARITY_SPACE = 4,
1760 enum libsp_flowcontrol {
1761 SP_FLOWCONTROL_NONE = 0,
1762 SP_FLOWCONTROL_XONXOFF = 1,
1763 SP_FLOWCONTROL_RTSCTS = 2,
1764 SP_FLOWCONTROL_DTRDSR = 3,
1768 /* Serial-specific instances */
1769 SR_PRIV struct sr_serial_dev_inst *sr_serial_dev_inst_new(const char *port,
1770 const char *serialcomm);
1771 SR_PRIV void sr_serial_dev_inst_free(struct sr_serial_dev_inst *serial);
1774 /* USBTMC-specific instances */
1775 SR_PRIV struct sr_usbtmc_dev_inst *sr_usbtmc_dev_inst_new(const char *device);
1776 SR_PRIV void sr_usbtmc_dev_inst_free(struct sr_usbtmc_dev_inst *usbtmc);
1778 /*--- hwdriver.c ------------------------------------------------------------*/
1780 SR_PRIV const GVariantType *sr_variant_type_get(int datatype);
1781 SR_PRIV int sr_variant_type_check(uint32_t key, GVariant *data);
1782 SR_PRIV void sr_hw_cleanup_all(const struct sr_context *ctx);
1783 SR_PRIV struct sr_config *sr_config_new(uint32_t key, GVariant *data);
1784 SR_PRIV void sr_config_free(struct sr_config *src);
1785 SR_PRIV int sr_dev_acquisition_start(struct sr_dev_inst *sdi);
1786 SR_PRIV int sr_dev_acquisition_stop(struct sr_dev_inst *sdi);
1788 /*--- session.c -------------------------------------------------------------*/
1791 /** Context this session exists in. */
1792 struct sr_context *ctx;
1793 /** List of struct sr_dev_inst pointers. */
1795 /** List of struct sr_dev_inst pointers owned by this session. */
1797 /** List of struct datafeed_callback pointers. */
1798 GSList *datafeed_callbacks;
1800 struct sr_trigger *trigger;
1802 /** Callback to invoke on session stop. */
1803 sr_session_stopped_callback stopped_callback;
1804 /** User data to be passed to the session stop callback. */
1805 void *stopped_cb_data;
1807 /** Mutex protecting the main context pointer. */
1809 /** Context of the session main loop. */
1810 GMainContext *main_context;
1812 /** Registered event sources for this session. */
1813 GHashTable *event_sources;
1814 /** Session main loop. */
1815 GMainLoop *main_loop;
1816 /** ID of idle source for dispatching the session stop notification. */
1817 unsigned int stop_check_id;
1818 /** Whether the session has been started. */
1822 SR_PRIV int sr_session_source_add_internal(struct sr_session *session,
1823 void *key, GSource *source);
1824 SR_PRIV int sr_session_source_remove_internal(struct sr_session *session,
1826 SR_PRIV int sr_session_source_destroyed(struct sr_session *session,
1827 void *key, GSource *source);
1828 SR_PRIV int sr_session_fd_source_add(struct sr_session *session,
1829 void *key, gintptr fd, int events, int timeout,
1830 sr_receive_data_callback cb, void *cb_data);
1832 SR_PRIV int sr_session_source_add(struct sr_session *session, int fd,
1833 int events, int timeout, sr_receive_data_callback cb, void *cb_data);
1834 SR_PRIV int sr_session_source_add_pollfd(struct sr_session *session,
1835 GPollFD *pollfd, int timeout, sr_receive_data_callback cb,
1837 SR_PRIV int sr_session_source_add_channel(struct sr_session *session,
1838 GIOChannel *channel, int events, int timeout,
1839 sr_receive_data_callback cb, void *cb_data);
1840 SR_PRIV int sr_session_source_remove(struct sr_session *session, int fd);
1841 SR_PRIV int sr_session_source_remove_pollfd(struct sr_session *session,
1843 SR_PRIV int sr_session_source_remove_channel(struct sr_session *session,
1844 GIOChannel *channel);
1846 SR_PRIV int sr_session_send_meta(const struct sr_dev_inst *sdi,
1847 uint32_t key, GVariant *var);
1848 SR_PRIV int sr_session_send(const struct sr_dev_inst *sdi,
1849 const struct sr_datafeed_packet *packet);
1850 SR_PRIV int sr_sessionfile_check(const char *filename);
1851 SR_PRIV struct sr_dev_inst *sr_session_prepare_sdi(const char *filename,
1852 struct sr_session **session);
1854 /*--- session_file.c --------------------------------------------------------*/
1856 #if !HAVE_ZIP_DISCARD
1857 /* Replace zip_discard() if not available. */
1858 #define zip_discard(zip) sr_zip_discard(zip)
1859 SR_PRIV void sr_zip_discard(struct zip *archive);
1862 SR_PRIV GKeyFile *sr_sessionfile_read_metadata(struct zip *archive,
1863 const struct zip_stat *entry);
1865 /*--- analog.c --------------------------------------------------------------*/
1867 SR_PRIV int sr_analog_init(struct sr_datafeed_analog *analog,
1868 struct sr_analog_encoding *encoding,
1869 struct sr_analog_meaning *meaning,
1870 struct sr_analog_spec *spec,
1873 /*--- std.c -----------------------------------------------------------------*/
1875 typedef int (*dev_close_callback)(struct sr_dev_inst *sdi);
1876 typedef void (*std_dev_clear_callback)(void *priv);
1878 SR_PRIV int std_init(struct sr_dev_driver *di, struct sr_context *sr_ctx);
1879 SR_PRIV int std_cleanup(const struct sr_dev_driver *di);
1880 SR_PRIV int std_dummy_dev_open(struct sr_dev_inst *sdi);
1881 SR_PRIV int std_dummy_dev_close(struct sr_dev_inst *sdi);
1882 SR_PRIV int std_dummy_dev_acquisition_start(const struct sr_dev_inst *sdi);
1883 SR_PRIV int std_dummy_dev_acquisition_stop(struct sr_dev_inst *sdi);
1884 #ifdef HAVE_SERIAL_COMM
1885 SR_PRIV int std_serial_dev_open(struct sr_dev_inst *sdi);
1886 SR_PRIV int std_serial_dev_acquisition_stop(struct sr_dev_inst *sdi);
1888 SR_PRIV int std_session_send_df_header(const struct sr_dev_inst *sdi);
1889 SR_PRIV int std_session_send_df_end(const struct sr_dev_inst *sdi);
1890 SR_PRIV int std_session_send_df_trigger(const struct sr_dev_inst *sdi);
1891 SR_PRIV int std_session_send_df_frame_begin(const struct sr_dev_inst *sdi);
1892 SR_PRIV int std_session_send_df_frame_end(const struct sr_dev_inst *sdi);
1893 SR_PRIV int std_dev_clear_with_callback(const struct sr_dev_driver *driver,
1894 std_dev_clear_callback clear_private);
1895 SR_PRIV int std_dev_clear(const struct sr_dev_driver *driver);
1896 SR_PRIV GSList *std_dev_list(const struct sr_dev_driver *di);
1897 SR_PRIV int std_serial_dev_close(struct sr_dev_inst *sdi);
1898 SR_PRIV GSList *std_scan_complete(struct sr_dev_driver *di, GSList *devices);
1900 SR_PRIV int std_opts_config_list(uint32_t key, GVariant **data,
1901 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg,
1902 const uint32_t scanopts[], size_t scansize, const uint32_t drvopts[],
1903 size_t drvsize, const uint32_t devopts[], size_t devsize);
1905 extern SR_PRIV const uint32_t NO_OPTS[1];
1907 #define STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts) \
1908 std_opts_config_list(key, data, sdi, cg, ARRAY_AND_SIZE(scanopts), \
1909 ARRAY_AND_SIZE(drvopts), ARRAY_AND_SIZE(devopts))
1911 SR_PRIV GVariant *std_gvar_tuple_array(const uint64_t a[][2], unsigned int n);
1912 SR_PRIV GVariant *std_gvar_tuple_rational(const struct sr_rational *r, unsigned int n);
1913 SR_PRIV GVariant *std_gvar_samplerates(const uint64_t samplerates[], unsigned int n);
1914 SR_PRIV GVariant *std_gvar_samplerates_steps(const uint64_t samplerates[], unsigned int n);
1915 SR_PRIV GVariant *std_gvar_min_max_step(double min, double max, double step);
1916 SR_PRIV GVariant *std_gvar_min_max_step_array(const double a[3]);
1917 SR_PRIV GVariant *std_gvar_min_max_step_thresholds(const double dmin, const double dmax, const double dstep);
1919 SR_PRIV GVariant *std_gvar_tuple_u64(uint64_t low, uint64_t high);
1920 SR_PRIV GVariant *std_gvar_tuple_double(double low, double high);
1922 SR_PRIV GVariant *std_gvar_array_i32(const int32_t a[], unsigned int n);
1923 SR_PRIV GVariant *std_gvar_array_u32(const uint32_t a[], unsigned int n);
1924 SR_PRIV GVariant *std_gvar_array_u64(const uint64_t a[], unsigned int n);
1925 SR_PRIV GVariant *std_gvar_array_str(const char *a[], unsigned int n);
1927 SR_PRIV GVariant *std_gvar_thresholds(const double a[][2], unsigned int n);
1929 SR_PRIV int std_str_idx(GVariant *data, const char *a[], unsigned int n);
1930 SR_PRIV int std_u64_idx(GVariant *data, const uint64_t a[], unsigned int n);
1931 SR_PRIV int std_u8_idx(GVariant *data, const uint8_t a[], unsigned int n);
1933 SR_PRIV int std_str_idx_s(const char *s, const char *a[], unsigned int n);
1934 SR_PRIV int std_u8_idx_s(uint8_t b, const uint8_t a[], unsigned int n);
1936 SR_PRIV int std_u64_tuple_idx(GVariant *data, const uint64_t a[][2], unsigned int n);
1937 SR_PRIV int std_double_tuple_idx(GVariant *data, const double a[][2], unsigned int n);
1938 SR_PRIV int std_double_tuple_idx_d0(const double d, const double a[][2], unsigned int n);
1940 SR_PRIV int std_cg_idx(const struct sr_channel_group *cg, struct sr_channel_group *a[], unsigned int n);
1942 SR_PRIV int std_dummy_set_params(struct sr_serial_dev_inst *serial,
1943 int baudrate, int bits, int parity, int stopbits,
1944 int flowcontrol, int rts, int dtr);
1945 SR_PRIV int std_dummy_set_handshake(struct sr_serial_dev_inst *serial,
1948 /*--- resource.c ------------------------------------------------------------*/
1950 SR_PRIV int64_t sr_file_get_size(FILE *file);
1952 SR_PRIV int sr_resource_open(struct sr_context *ctx,
1953 struct sr_resource *res, int type, const char *name)
1954 G_GNUC_WARN_UNUSED_RESULT;
1955 SR_PRIV int sr_resource_close(struct sr_context *ctx,
1956 struct sr_resource *res);
1957 SR_PRIV gssize sr_resource_read(struct sr_context *ctx,
1958 const struct sr_resource *res, void *buf, size_t count)
1959 G_GNUC_WARN_UNUSED_RESULT;
1960 SR_PRIV void *sr_resource_load(struct sr_context *ctx, int type,
1961 const char *name, size_t *size, size_t max_size)
1962 G_GNUC_MALLOC G_GNUC_WARN_UNUSED_RESULT;
1964 /*--- strutil.c -------------------------------------------------------------*/
1966 SR_PRIV int sr_atol(const char *str, long *ret);
1967 SR_PRIV int sr_atol_base(const char *str, long *ret, char **end, int base);
1968 SR_PRIV int sr_atoul_base(const char *str, unsigned long *ret, char **end, int base);
1969 SR_PRIV int sr_atoi(const char *str, int *ret);
1970 SR_PRIV int sr_atod(const char *str, double *ret);
1971 SR_PRIV int sr_atof(const char *str, float *ret);
1972 SR_PRIV int sr_atod_ascii(const char *str, double *ret);
1973 SR_PRIV int sr_atod_ascii_digits(const char *str, double *ret, int *digits);
1974 SR_PRIV int sr_atof_ascii(const char *str, float *ret);
1976 SR_PRIV GString *sr_hexdump_new(const uint8_t *data, const size_t len);
1977 SR_PRIV void sr_hexdump_free(GString *s);
1979 /*--- soft-trigger.c --------------------------------------------------------*/
1981 struct soft_trigger_logic {
1982 const struct sr_dev_inst *sdi;
1983 const struct sr_trigger *trigger;
1987 uint8_t *prev_sample;
1988 uint8_t *pre_trigger_buffer;
1989 uint8_t *pre_trigger_head;
1990 int pre_trigger_size;
1991 int pre_trigger_fill;
1994 SR_PRIV int logic_channel_unitsize(GSList *channels);
1995 SR_PRIV struct soft_trigger_logic *soft_trigger_logic_new(
1996 const struct sr_dev_inst *sdi, struct sr_trigger *trigger,
1997 int pre_trigger_samples);
1998 SR_PRIV void soft_trigger_logic_free(struct soft_trigger_logic *st);
1999 SR_PRIV int soft_trigger_logic_check(struct soft_trigger_logic *st, uint8_t *buf,
2000 int len, int *pre_trigger_samples);
2002 /*--- serial.c --------------------------------------------------------------*/
2004 #ifdef HAVE_SERIAL_COMM
2010 typedef gboolean (*packet_valid_callback)(const uint8_t *buf);
2011 typedef int (*packet_valid_len_callback)(void *st,
2012 const uint8_t *p, size_t l, size_t *pl);
2014 typedef GSList *(*sr_ser_list_append_t)(GSList *devs, const char *name,
2016 typedef GSList *(*sr_ser_find_append_t)(GSList *devs, const char *name);
2018 SR_PRIV int serial_open(struct sr_serial_dev_inst *serial, int flags);
2019 SR_PRIV int serial_close(struct sr_serial_dev_inst *serial);
2020 SR_PRIV int serial_flush(struct sr_serial_dev_inst *serial);
2021 SR_PRIV int serial_drain(struct sr_serial_dev_inst *serial);
2022 SR_PRIV size_t serial_has_receive_data(struct sr_serial_dev_inst *serial);
2023 SR_PRIV int serial_write_blocking(struct sr_serial_dev_inst *serial,
2024 const void *buf, size_t count, unsigned int timeout_ms);
2025 SR_PRIV int serial_write_nonblocking(struct sr_serial_dev_inst *serial,
2026 const void *buf, size_t count);
2027 SR_PRIV int serial_read_blocking(struct sr_serial_dev_inst *serial, void *buf,
2028 size_t count, unsigned int timeout_ms);
2029 SR_PRIV int serial_read_nonblocking(struct sr_serial_dev_inst *serial, void *buf,
2031 SR_PRIV int serial_set_read_chunk_cb(struct sr_serial_dev_inst *serial,
2032 serial_rx_chunk_callback cb, void *cb_data);
2033 SR_PRIV int serial_set_params(struct sr_serial_dev_inst *serial, int baudrate,
2034 int bits, int parity, int stopbits, int flowcontrol, int rts, int dtr);
2035 SR_PRIV int serial_set_handshake(struct sr_serial_dev_inst *serial,
2037 SR_PRIV int serial_set_paramstr(struct sr_serial_dev_inst *serial,
2038 const char *paramstr);
2039 SR_PRIV int serial_readline(struct sr_serial_dev_inst *serial, char **buf,
2040 int *buflen, gint64 timeout_ms);
2041 SR_PRIV int serial_stream_detect(struct sr_serial_dev_inst *serial,
2042 uint8_t *buf, size_t *buflen,
2043 size_t packet_size, packet_valid_callback is_valid,
2044 packet_valid_len_callback is_valid_len, size_t *return_size,
2045 uint64_t timeout_ms);
2046 SR_PRIV int serial_source_add(struct sr_session *session,
2047 struct sr_serial_dev_inst *serial, int events, int timeout,
2048 sr_receive_data_callback cb, void *cb_data);
2049 SR_PRIV int serial_source_remove(struct sr_session *session,
2050 struct sr_serial_dev_inst *serial);
2051 SR_PRIV GSList *sr_serial_find_usb(uint16_t vendor_id, uint16_t product_id);
2052 SR_PRIV int serial_timeout(struct sr_serial_dev_inst *port, int num_bytes);
2054 SR_PRIV void sr_ser_discard_queued_data(struct sr_serial_dev_inst *serial);
2055 SR_PRIV size_t sr_ser_has_queued_data(struct sr_serial_dev_inst *serial);
2056 SR_PRIV void sr_ser_queue_rx_data(struct sr_serial_dev_inst *serial,
2057 const uint8_t *data, size_t len);
2058 SR_PRIV size_t sr_ser_unqueue_rx_data(struct sr_serial_dev_inst *serial,
2059 uint8_t *data, size_t len);
2061 struct ser_lib_functions {
2062 int (*open)(struct sr_serial_dev_inst *serial, int flags);
2063 int (*close)(struct sr_serial_dev_inst *serial);
2064 int (*flush)(struct sr_serial_dev_inst *serial);
2065 int (*drain)(struct sr_serial_dev_inst *serial);
2066 int (*write)(struct sr_serial_dev_inst *serial,
2067 const void *buf, size_t count,
2068 int nonblocking, unsigned int timeout_ms);
2069 int (*read)(struct sr_serial_dev_inst *serial,
2070 void *buf, size_t count,
2071 int nonblocking, unsigned int timeout_ms);
2072 int (*set_params)(struct sr_serial_dev_inst *serial,
2073 int baudrate, int bits, int parity, int stopbits,
2074 int flowcontrol, int rts, int dtr);
2075 int (*set_handshake)(struct sr_serial_dev_inst *serial,
2077 int (*setup_source_add)(struct sr_session *session,
2078 struct sr_serial_dev_inst *serial,
2079 int events, int timeout,
2080 sr_receive_data_callback cb, void *cb_data);
2081 int (*setup_source_remove)(struct sr_session *session,
2082 struct sr_serial_dev_inst *serial);
2083 GSList *(*list)(GSList *list, sr_ser_list_append_t append);
2084 GSList *(*find_usb)(GSList *list, sr_ser_find_append_t append,
2085 uint16_t vendor_id, uint16_t product_id);
2086 int (*get_frame_format)(struct sr_serial_dev_inst *serial,
2087 int *baud, int *bits);
2088 size_t (*get_rx_avail)(struct sr_serial_dev_inst *serial);
2090 extern SR_PRIV struct ser_lib_functions *ser_lib_funcs_libsp;
2091 SR_PRIV int ser_name_is_hid(struct sr_serial_dev_inst *serial);
2092 extern SR_PRIV struct ser_lib_functions *ser_lib_funcs_hid;
2093 SR_PRIV int ser_name_is_bt(struct sr_serial_dev_inst *serial);
2094 extern SR_PRIV struct ser_lib_functions *ser_lib_funcs_bt;
2096 #ifdef HAVE_LIBHIDAPI
2097 struct vid_pid_item {
2101 struct ser_hid_chip_functions {
2102 const char *chipname;
2103 const char *chipdesc;
2104 const struct vid_pid_item *vid_pid_items;
2105 const int max_bytes_per_request;
2106 int (*set_params)(struct sr_serial_dev_inst *serial,
2107 int baudrate, int bits, int parity, int stopbits,
2108 int flowcontrol, int rts, int dtr);
2109 int (*read_bytes)(struct sr_serial_dev_inst *serial,
2110 uint8_t *data, int space, unsigned int timeout);
2111 int (*write_bytes)(struct sr_serial_dev_inst *serial,
2112 const uint8_t *data, int space);
2113 int (*flush)(struct sr_serial_dev_inst *serial);
2114 int (*drain)(struct sr_serial_dev_inst *serial);
2116 extern SR_PRIV struct ser_hid_chip_functions *ser_hid_chip_funcs_bu86x;
2117 extern SR_PRIV struct ser_hid_chip_functions *ser_hid_chip_funcs_ch9325;
2118 extern SR_PRIV struct ser_hid_chip_functions *ser_hid_chip_funcs_cp2110;
2119 extern SR_PRIV struct ser_hid_chip_functions *ser_hid_chip_funcs_victor;
2120 SR_PRIV const char *ser_hid_chip_find_name_vid_pid(uint16_t vid, uint16_t pid);
2124 SR_PRIV int sr_serial_extract_options(GSList *options,
2125 const char **serial_device, const char **serial_options);
2127 /*--- bt/ API ---------------------------------------------------------------*/
2129 #ifdef HAVE_BLUETOOTH
2130 SR_PRIV const char *sr_bt_adapter_get_address(size_t idx);
2133 typedef void (*sr_bt_scan_cb)(void *cb_data, const char *addr, const char *name);
2134 typedef int (*sr_bt_data_cb)(void *cb_data, uint8_t *data, size_t dlen);
2136 SR_PRIV struct sr_bt_desc *sr_bt_desc_new(void);
2137 SR_PRIV void sr_bt_desc_free(struct sr_bt_desc *desc);
2139 SR_PRIV int sr_bt_config_cb_scan(struct sr_bt_desc *desc,
2140 sr_bt_scan_cb cb, void *cb_data);
2141 SR_PRIV int sr_bt_config_cb_data(struct sr_bt_desc *desc,
2142 sr_bt_data_cb cb, void *cb_data);
2143 SR_PRIV int sr_bt_config_addr_local(struct sr_bt_desc *desc, const char *addr);
2144 SR_PRIV int sr_bt_config_addr_remote(struct sr_bt_desc *desc, const char *addr);
2145 SR_PRIV int sr_bt_config_rfcomm(struct sr_bt_desc *desc, size_t channel);
2146 SR_PRIV int sr_bt_config_notify(struct sr_bt_desc *desc,
2147 uint16_t read_handle, uint16_t write_handle,
2148 uint16_t cccd_handle, uint16_t cccd_value);
2150 SR_PRIV int sr_bt_scan_le(struct sr_bt_desc *desc, int duration);
2151 SR_PRIV int sr_bt_scan_bt(struct sr_bt_desc *desc, int duration);
2153 SR_PRIV int sr_bt_connect_ble(struct sr_bt_desc *desc);
2154 SR_PRIV int sr_bt_connect_rfcomm(struct sr_bt_desc *desc);
2155 SR_PRIV void sr_bt_disconnect(struct sr_bt_desc *desc);
2157 SR_PRIV ssize_t sr_bt_read(struct sr_bt_desc *desc,
2158 void *data, size_t len);
2159 SR_PRIV ssize_t sr_bt_write(struct sr_bt_desc *desc,
2160 const void *data, size_t len);
2162 SR_PRIV int sr_bt_start_notify(struct sr_bt_desc *desc);
2163 SR_PRIV int sr_bt_check_notify(struct sr_bt_desc *desc);
2166 /*--- ezusb.c ---------------------------------------------------------------*/
2168 #ifdef HAVE_LIBUSB_1_0
2169 SR_PRIV int ezusb_reset(struct libusb_device_handle *hdl, int set_clear);
2170 SR_PRIV int ezusb_install_firmware(struct sr_context *ctx, libusb_device_handle *hdl,
2172 SR_PRIV int ezusb_upload_firmware(struct sr_context *ctx, libusb_device *dev,
2173 int configuration, const char *name);
2176 /*--- usb.c -----------------------------------------------------------------*/
2178 SR_PRIV int sr_usb_split_conn(const char *conn,
2179 uint16_t *vid, uint16_t *pid, uint8_t *bus, uint8_t *addr);
2180 #ifdef HAVE_LIBUSB_1_0
2181 SR_PRIV GSList *sr_usb_find(libusb_context *usb_ctx, const char *conn);
2182 SR_PRIV int sr_usb_open(libusb_context *usb_ctx, struct sr_usb_dev_inst *usb);
2183 SR_PRIV void sr_usb_close(struct sr_usb_dev_inst *usb);
2184 SR_PRIV int usb_source_add(struct sr_session *session, struct sr_context *ctx,
2185 int timeout, sr_receive_data_callback cb, void *cb_data);
2186 SR_PRIV int usb_source_remove(struct sr_session *session, struct sr_context *ctx);
2187 SR_PRIV int usb_get_port_path(libusb_device *dev, char *path, int path_len);
2188 SR_PRIV gboolean usb_match_manuf_prod(libusb_device *dev,
2189 const char *manufacturer, const char *product);
2192 /*--- binary_helpers.c ------------------------------------------------------*/
2194 /** Binary value type */
2195 enum binary_value_type {
2199 BVT_BE_UINT8 = BVT_UINT8,
2200 BVT_LE_UINT8 = BVT_UINT8,
2213 /** Binary value specification */
2214 struct binary_value_spec {
2215 size_t offset; /**!< Offset into binary image */
2216 enum binary_value_type type; /**!< Data type to decode */
2217 float scale; /**!< Scale factor to native units */
2221 * Read extract a value from a binary data image.
2223 * @param[out] out Pointer to output buffer (conversion result)
2224 * @param[in] spec Binary value specification
2225 * @param[in] data Pointer to binary input data
2226 * @param[in] length Size of binary input data
2228 * @return SR_OK on success, SR_ERR_* error code on failure.
2230 SR_PRIV int bv_get_value(float *out, const struct binary_value_spec *spec,
2231 const void *data, size_t length);
2233 /*--- crc.c -----------------------------------------------------------------*/
2235 #define SR_CRC16_DEFAULT_INIT 0xffffU
2238 * Calculate a CRC16 checksum using the 0x8005 polynomial.
2240 * This CRC16 flavor is also known as CRC16-ANSI or CRC16-MODBUS.
2242 * @param crc Initial value (typically 0xffff)
2243 * @param buffer Input buffer
2244 * @param len Buffer length
2247 SR_PRIV uint16_t sr_crc16(uint16_t crc, const uint8_t *buffer, int len);
2249 /*--- modbus/modbus.c -------------------------------------------------------*/
2251 struct sr_modbus_dev_inst {
2255 GSList *(*scan)(int modbusaddr);
2256 int (*dev_inst_new)(void *priv, const char *resource,
2257 char **params, const char *serialcomm, int modbusaddr);
2258 int (*open)(void *priv);
2259 int (*source_add)(struct sr_session *session, void *priv, int events,
2260 int timeout, sr_receive_data_callback cb, void *cb_data);
2261 int (*source_remove)(struct sr_session *session, void *priv);
2262 int (*send)(void *priv, const uint8_t *buffer, int buffer_size);
2263 int (*read_begin)(void *priv, uint8_t *function_code);
2264 int (*read_data)(void *priv, uint8_t *buf, int maxlen);
2265 int (*read_end)(void *priv);
2266 int (*close)(void *priv);
2267 void (*free)(void *priv);
2268 unsigned int read_timeout_ms;
2272 SR_PRIV GSList *sr_modbus_scan(struct drv_context *drvc, GSList *options,
2273 struct sr_dev_inst *(*probe_device)(struct sr_modbus_dev_inst *modbus));
2274 SR_PRIV struct sr_modbus_dev_inst *modbus_dev_inst_new(const char *resource,
2275 const char *serialcomm, int modbusaddr);
2276 SR_PRIV int sr_modbus_open(struct sr_modbus_dev_inst *modbus);
2277 SR_PRIV int sr_modbus_source_add(struct sr_session *session,
2278 struct sr_modbus_dev_inst *modbus, int events, int timeout,
2279 sr_receive_data_callback cb, void *cb_data);
2280 SR_PRIV int sr_modbus_source_remove(struct sr_session *session,
2281 struct sr_modbus_dev_inst *modbus);
2282 SR_PRIV int sr_modbus_request(struct sr_modbus_dev_inst *modbus,
2283 uint8_t *request, int request_size);
2284 SR_PRIV int sr_modbus_reply(struct sr_modbus_dev_inst *modbus,
2285 uint8_t *reply, int reply_size);
2286 SR_PRIV int sr_modbus_request_reply(struct sr_modbus_dev_inst *modbus,
2287 uint8_t *request, int request_size,
2288 uint8_t *reply, int reply_size);
2289 SR_PRIV int sr_modbus_read_coils(struct sr_modbus_dev_inst *modbus,
2290 int address, int nb_coils, uint8_t *coils);
2291 SR_PRIV int sr_modbus_read_holding_registers(struct sr_modbus_dev_inst *modbus,
2292 int address, int nb_registers,
2293 uint16_t *registers);
2294 SR_PRIV int sr_modbus_write_coil(struct sr_modbus_dev_inst *modbus,
2295 int address, int value);
2296 SR_PRIV int sr_modbus_write_multiple_registers(struct sr_modbus_dev_inst*modbus,
2297 int address, int nb_registers,
2298 uint16_t *registers);
2299 SR_PRIV int sr_modbus_close(struct sr_modbus_dev_inst *modbus);
2300 SR_PRIV void sr_modbus_free(struct sr_modbus_dev_inst *modbus);
2302 /*--- dmm/es519xx.c ---------------------------------------------------------*/
2305 * All 11-byte es519xx chips repeat each block twice for each conversion cycle
2306 * so always read 2 blocks at a time.
2308 #define ES519XX_11B_PACKET_SIZE (11 * 2)
2309 #define ES519XX_14B_PACKET_SIZE 14
2311 struct es519xx_info {
2312 gboolean is_judge, is_voltage, is_auto, is_micro, is_current;
2313 gboolean is_milli, is_resistance, is_continuity, is_diode;
2314 gboolean is_frequency, is_rpm, is_capacitance, is_duty_cycle;
2315 gboolean is_temperature, is_celsius, is_fahrenheit;
2316 gboolean is_adp0, is_adp1, is_adp2, is_adp3;
2317 gboolean is_sign, is_batt, is_ol, is_pmax, is_pmin, is_apo;
2318 gboolean is_dc, is_ac, is_vahz, is_min, is_max, is_rel, is_hold;
2319 gboolean is_digit4, is_ul, is_vasel, is_vbar, is_lpf1, is_lpf0, is_rmr;
2322 gboolean alt_functions, fivedigits, clampmeter, selectable_lpf;
2326 SR_PRIV gboolean sr_es519xx_2400_11b_packet_valid(const uint8_t *buf);
2327 SR_PRIV int sr_es519xx_2400_11b_parse(const uint8_t *buf, float *floatval,
2328 struct sr_datafeed_analog *analog, void *info);
2329 SR_PRIV gboolean sr_es519xx_2400_11b_altfn_packet_valid(const uint8_t *buf);
2330 SR_PRIV int sr_es519xx_2400_11b_altfn_parse(const uint8_t *buf,
2331 float *floatval, struct sr_datafeed_analog *analog, void *info);
2332 SR_PRIV gboolean sr_es519xx_19200_11b_5digits_packet_valid(const uint8_t *buf);
2333 SR_PRIV int sr_es519xx_19200_11b_5digits_parse(const uint8_t *buf,
2334 float *floatval, struct sr_datafeed_analog *analog, void *info);
2335 SR_PRIV gboolean sr_es519xx_19200_11b_clamp_packet_valid(const uint8_t *buf);
2336 SR_PRIV int sr_es519xx_19200_11b_clamp_parse(const uint8_t *buf,
2337 float *floatval, struct sr_datafeed_analog *analog, void *info);
2338 SR_PRIV gboolean sr_es519xx_19200_11b_packet_valid(const uint8_t *buf);
2339 SR_PRIV int sr_es519xx_19200_11b_parse(const uint8_t *buf, float *floatval,
2340 struct sr_datafeed_analog *analog, void *info);
2341 SR_PRIV gboolean sr_es519xx_19200_14b_packet_valid(const uint8_t *buf);
2342 SR_PRIV int sr_es519xx_19200_14b_parse(const uint8_t *buf, float *floatval,
2343 struct sr_datafeed_analog *analog, void *info);
2344 SR_PRIV gboolean sr_es519xx_19200_14b_sel_lpf_packet_valid(const uint8_t *buf);
2345 SR_PRIV int sr_es519xx_19200_14b_sel_lpf_parse(const uint8_t *buf,
2346 float *floatval, struct sr_datafeed_analog *analog, void *info);
2348 /*--- dmm/fs9922.c ----------------------------------------------------------*/
2350 #define FS9922_PACKET_SIZE 14
2352 struct fs9922_info {
2353 gboolean is_auto, is_dc, is_ac, is_rel, is_hold, is_bpn, is_z1, is_z2;
2354 gboolean is_max, is_min, is_apo, is_bat, is_nano, is_z3, is_micro;
2355 gboolean is_milli, is_kilo, is_mega, is_beep, is_diode, is_percent;
2356 gboolean is_z4, is_volt, is_ampere, is_ohm, is_hfe, is_hertz, is_farad;
2357 gboolean is_celsius, is_fahrenheit;
2358 int bargraph_sign, bargraph_value;
2361 SR_PRIV gboolean sr_fs9922_packet_valid(const uint8_t *buf);
2362 SR_PRIV int sr_fs9922_parse(const uint8_t *buf, float *floatval,
2363 struct sr_datafeed_analog *analog, void *info);
2364 SR_PRIV void sr_fs9922_z1_diode(struct sr_datafeed_analog *analog, void *info);
2366 /*--- dmm/fs9721.c ----------------------------------------------------------*/
2368 #define FS9721_PACKET_SIZE 14
2370 struct fs9721_info {
2371 gboolean is_ac, is_dc, is_auto, is_rs232, is_micro, is_nano, is_kilo;
2372 gboolean is_diode, is_milli, is_percent, is_mega, is_beep, is_farad;
2373 gboolean is_ohm, is_rel, is_hold, is_ampere, is_volt, is_hz, is_bat;
2374 gboolean is_c2c1_11, is_c2c1_10, is_c2c1_01, is_c2c1_00, is_sign;
2377 SR_PRIV gboolean sr_fs9721_packet_valid(const uint8_t *buf);
2378 SR_PRIV int sr_fs9721_parse(const uint8_t *buf, float *floatval,
2379 struct sr_datafeed_analog *analog, void *info);
2380 SR_PRIV void sr_fs9721_00_temp_c(struct sr_datafeed_analog *analog, void *info);
2381 SR_PRIV void sr_fs9721_01_temp_c(struct sr_datafeed_analog *analog, void *info);
2382 SR_PRIV void sr_fs9721_10_temp_c(struct sr_datafeed_analog *analog, void *info);
2383 SR_PRIV void sr_fs9721_01_10_temp_f_c(struct sr_datafeed_analog *analog, void *info);
2384 SR_PRIV void sr_fs9721_max_c_min(struct sr_datafeed_analog *analog, void *info);
2386 /*--- dmm/mm38xr.c ---------------------------------------------------------*/
2388 #define METERMAN_38XR_PACKET_SIZE 15
2390 struct meterman_38xr_info { int dummy; };
2392 SR_PRIV gboolean meterman_38xr_packet_valid(const uint8_t *buf);
2393 SR_PRIV int meterman_38xr_parse(const uint8_t *buf, float *floatval,
2394 struct sr_datafeed_analog *analog, void *info);
2396 /*--- dmm/ms2115b.c ---------------------------------------------------------*/
2398 #define MS2115B_PACKET_SIZE 9
2400 enum ms2115b_display {
2401 MS2115B_DISPLAY_MAIN,
2402 MS2115B_DISPLAY_SUB,
2403 MS2115B_DISPLAY_COUNT,
2406 struct ms2115b_info {
2407 /* Selected channel. */
2409 gboolean is_ac, is_dc, is_auto;
2410 gboolean is_diode, is_beep, is_farad;
2411 gboolean is_ohm, is_ampere, is_volt, is_hz;
2412 gboolean is_duty_cycle, is_percent;
2415 extern SR_PRIV const char *ms2115b_channel_formats[];
2416 SR_PRIV gboolean sr_ms2115b_packet_valid(const uint8_t *buf);
2417 SR_PRIV int sr_ms2115b_parse(const uint8_t *buf, float *floatval,
2418 struct sr_datafeed_analog *analog, void *info);
2420 /*--- dmm/ms8250d.c ---------------------------------------------------------*/
2422 #define MS8250D_PACKET_SIZE 18
2424 struct ms8250d_info {
2425 gboolean is_ac, is_dc, is_auto, is_rs232, is_micro, is_nano, is_kilo;
2426 gboolean is_diode, is_milli, is_percent, is_mega, is_beep, is_farad;
2427 gboolean is_ohm, is_rel, is_hold, is_ampere, is_volt, is_hz, is_bat;
2428 gboolean is_ncv, is_min, is_max, is_sign, is_autotimer;
2431 SR_PRIV gboolean sr_ms8250d_packet_valid(const uint8_t *buf);
2432 SR_PRIV int sr_ms8250d_parse(const uint8_t *buf, float *floatval,
2433 struct sr_datafeed_analog *analog, void *info);
2435 /*--- dmm/dtm0660.c ---------------------------------------------------------*/
2437 #define DTM0660_PACKET_SIZE 15
2439 struct dtm0660_info {
2440 gboolean is_ac, is_dc, is_auto, is_rs232, is_micro, is_nano, is_kilo;
2441 gboolean is_diode, is_milli, is_percent, is_mega, is_beep, is_farad;
2442 gboolean is_ohm, is_rel, is_hold, is_ampere, is_volt, is_hz, is_bat;
2443 gboolean is_degf, is_degc, is_c2c1_01, is_c2c1_00, is_apo, is_min;
2444 gboolean is_minmax, is_max, is_sign;
2447 SR_PRIV gboolean sr_dtm0660_packet_valid(const uint8_t *buf);
2448 SR_PRIV int sr_dtm0660_parse(const uint8_t *buf, float *floatval,
2449 struct sr_datafeed_analog *analog, void *info);
2451 /*--- dmm/m2110.c -----------------------------------------------------------*/
2453 #define BBCGM_M2110_PACKET_SIZE 9
2455 /* Dummy info struct. The parser does not use it. */
2456 struct m2110_info { int dummy; };
2458 SR_PRIV gboolean sr_m2110_packet_valid(const uint8_t *buf);
2459 SR_PRIV int sr_m2110_parse(const uint8_t *buf, float *floatval,
2460 struct sr_datafeed_analog *analog, void *info);
2462 /*--- dmm/metex14.c ---------------------------------------------------------*/
2464 #define METEX14_PACKET_SIZE 14
2466 struct metex14_info {
2468 gboolean is_ac, is_dc, is_resistance, is_capacity, is_temperature;
2469 gboolean is_diode, is_frequency, is_ampere, is_volt, is_farad;
2470 gboolean is_hertz, is_ohm, is_celsius, is_fahrenheit, is_watt;
2471 gboolean is_pico, is_nano, is_micro, is_milli, is_kilo, is_mega;
2472 gboolean is_gain, is_decibel, is_power, is_decibel_mw, is_power_factor;
2473 gboolean is_hfe, is_unitless, is_logic, is_min, is_max, is_avg;
2476 #ifdef HAVE_SERIAL_COMM
2477 SR_PRIV int sr_metex14_packet_request(struct sr_serial_dev_inst *serial);
2479 SR_PRIV gboolean sr_metex14_packet_valid(const uint8_t *buf);
2480 SR_PRIV int sr_metex14_parse(const uint8_t *buf, float *floatval,
2481 struct sr_datafeed_analog *analog, void *info);
2482 SR_PRIV gboolean sr_metex14_4packets_valid(const uint8_t *buf);
2483 SR_PRIV int sr_metex14_4packets_parse(const uint8_t *buf, float *floatval,
2484 struct sr_datafeed_analog *analog, void *info);
2486 /*--- dmm/rs9lcd.c ----------------------------------------------------------*/
2488 #define RS9LCD_PACKET_SIZE 9
2490 /* Dummy info struct. The parser does not use it. */
2491 struct rs9lcd_info { int dummy; };
2493 SR_PRIV gboolean sr_rs9lcd_packet_valid(const uint8_t *buf);
2494 SR_PRIV int sr_rs9lcd_parse(const uint8_t *buf, float *floatval,
2495 struct sr_datafeed_analog *analog, void *info);
2497 /*--- dmm/bm25x.c -----------------------------------------------------------*/
2499 #define BRYMEN_BM25X_PACKET_SIZE 15
2501 /* Dummy info struct. The parser does not use it. */
2502 struct bm25x_info { int dummy; };
2504 SR_PRIV gboolean sr_brymen_bm25x_packet_valid(const uint8_t *buf);
2505 SR_PRIV int sr_brymen_bm25x_parse(const uint8_t *buf, float *floatval,
2506 struct sr_datafeed_analog *analog, void *info);
2508 /*--- dmm/bm52x.c -----------------------------------------------------------*/
2510 #define BRYMEN_BM52X_PACKET_SIZE 24
2511 #define BRYMEN_BM52X_DISPLAY_COUNT 2
2513 struct brymen_bm52x_info { size_t ch_idx; };
2515 #ifdef HAVE_SERIAL_COMM
2516 SR_PRIV int sr_brymen_bm52x_packet_request(struct sr_serial_dev_inst *serial);
2517 SR_PRIV int sr_brymen_bm82x_packet_request(struct sr_serial_dev_inst *serial);
2519 SR_PRIV gboolean sr_brymen_bm52x_packet_valid(const uint8_t *buf);
2520 SR_PRIV gboolean sr_brymen_bm82x_packet_valid(const uint8_t *buf);
2521 /* BM520s and BM820s protocols are similar, the parse routine is shared. */
2522 SR_PRIV int sr_brymen_bm52x_parse(const uint8_t *buf, float *floatval,
2523 struct sr_datafeed_analog *analog, void *info);
2525 struct brymen_bm52x_state;
2527 SR_PRIV void *brymen_bm52x_state_init(void);
2528 SR_PRIV void brymen_bm52x_state_free(void *state);
2529 SR_PRIV int brymen_bm52x_config_get(void *state, uint32_t key, GVariant **data,
2530 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg);
2531 SR_PRIV int brymen_bm52x_config_set(void *state, uint32_t key, GVariant *data,
2532 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg);
2533 SR_PRIV int brymen_bm52x_config_list(void *state, uint32_t key, GVariant **data,
2534 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg);
2535 SR_PRIV int brymen_bm52x_acquire_start(void *state,
2536 const struct sr_dev_inst *sdi,
2537 sr_receive_data_callback *cb, void **cb_data);
2539 /*--- dmm/bm85x.c -----------------------------------------------------------*/
2541 #define BRYMEN_BM85x_PACKET_SIZE_MIN 4
2543 struct brymen_bm85x_info { int dummy; };
2545 #ifdef HAVE_SERIAL_COMM
2546 SR_PRIV int brymen_bm85x_after_open(struct sr_serial_dev_inst *serial);
2547 SR_PRIV int brymen_bm85x_packet_request(struct sr_serial_dev_inst *serial);
2549 SR_PRIV gboolean brymen_bm85x_packet_valid(void *state,
2550 const uint8_t *buf, size_t len, size_t *pkt_len);
2551 SR_PRIV int brymen_bm85x_parse(void *state, const uint8_t *buf, size_t len,
2552 double *floatval, struct sr_datafeed_analog *analog, void *info);
2554 /*--- dmm/bm86x.c -----------------------------------------------------------*/
2556 #define BRYMEN_BM86X_PACKET_SIZE 24
2557 #define BRYMEN_BM86X_DISPLAY_COUNT 2
2559 struct brymen_bm86x_info { size_t ch_idx; };
2561 #ifdef HAVE_SERIAL_COMM
2562 SR_PRIV int sr_brymen_bm86x_packet_request(struct sr_serial_dev_inst *serial);
2564 SR_PRIV gboolean sr_brymen_bm86x_packet_valid(const uint8_t *buf);
2565 SR_PRIV int sr_brymen_bm86x_parse(const uint8_t *buf, float *floatval,
2566 struct sr_datafeed_analog *analog, void *info);
2568 /*--- dmm/ut71x.c -----------------------------------------------------------*/
2570 #define UT71X_PACKET_SIZE 11
2573 gboolean is_voltage, is_resistance, is_capacitance, is_temperature;
2574 gboolean is_celsius, is_fahrenheit, is_current, is_continuity;
2575 gboolean is_diode, is_frequency, is_duty_cycle, is_dc, is_ac;
2576 gboolean is_auto, is_manual, is_sign, is_power, is_loop_current;
2579 SR_PRIV gboolean sr_ut71x_packet_valid(const uint8_t *buf);
2580 SR_PRIV int sr_ut71x_parse(const uint8_t *buf, float *floatval,
2581 struct sr_datafeed_analog *analog, void *info);
2583 /*--- dmm/vc870.c -----------------------------------------------------------*/
2585 #define VC870_PACKET_SIZE 23
2588 gboolean is_voltage, is_dc, is_ac, is_temperature, is_resistance;
2589 gboolean is_continuity, is_capacitance, is_diode, is_loop_current;
2590 gboolean is_current, is_micro, is_milli, is_power;
2591 gboolean is_power_factor_freq, is_power_apparent_power, is_v_a_rms_value;
2592 gboolean is_sign2, is_sign1, is_batt, is_ol1, is_max, is_min;
2593 gboolean is_maxmin, is_rel, is_ol2, is_open, is_manu, is_hold;
2594 gboolean is_light, is_usb, is_warning, is_auto_power, is_misplug_warn;
2595 gboolean is_lo, is_hi, is_open2;
2597 gboolean is_frequency, is_dual_display, is_auto;
2600 SR_PRIV gboolean sr_vc870_packet_valid(const uint8_t *buf);
2601 SR_PRIV int sr_vc870_parse(const uint8_t *buf, float *floatval,
2602 struct sr_datafeed_analog *analog, void *info);
2604 /*--- dmm/vc96.c ------------------------------------------------------------*/
2606 #define VC96_PACKET_SIZE 13
2610 gboolean is_ac, is_dc, is_resistance, is_diode, is_ampere, is_volt;
2611 gboolean is_ohm, is_micro, is_milli, is_kilo, is_mega, is_hfe;
2612 gboolean is_unitless;
2615 SR_PRIV gboolean sr_vc96_packet_valid(const uint8_t *buf);
2616 SR_PRIV int sr_vc96_parse(const uint8_t *buf, float *floatval,
2617 struct sr_datafeed_analog *analog, void *info);
2619 /*--- lcr/es51919.c ---------------------------------------------------------*/
2621 /* Acquisition details which apply to all supported serial-lcr devices. */
2622 struct lcr_parse_info {
2624 uint64_t output_freq;
2625 const char *circuit_model;
2628 #define ES51919_PACKET_SIZE 17
2629 #define ES51919_CHANNEL_COUNT 2
2630 #define ES51919_COMM_PARAM "9600/8n1/rts=1/dtr=1"
2632 SR_PRIV int es51919_config_get(uint32_t key, GVariant **data,
2633 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg);
2634 SR_PRIV int es51919_config_set(uint32_t key, GVariant *data,
2635 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg);
2636 SR_PRIV int es51919_config_list(uint32_t key, GVariant **data,
2637 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg);
2638 SR_PRIV gboolean es51919_packet_valid(const uint8_t *pkt);
2639 SR_PRIV int es51919_packet_parse(const uint8_t *pkt, float *floatval,
2640 struct sr_datafeed_analog *analog, void *info);
2642 /*--- lcr/vc4080.c ----------------------------------------------------------*/
2644 /* Note: Also uses 'struct lcr_parse_info' from es51919 above. */
2646 #define VC4080_PACKET_SIZE 39
2647 #define VC4080_COMM_PARAM "1200/8n1"
2648 #define VC4080_WITH_DQ_CHANS 0 /* Enable separate D/Q channels? */
2650 enum vc4080_display {
2651 VC4080_DISPLAY_PRIMARY,
2652 VC4080_DISPLAY_SECONDARY,
2653 #if VC4080_WITH_DQ_CHANS
2654 VC4080_DISPLAY_D_VALUE,
2655 VC4080_DISPLAY_Q_VALUE,
2657 VC4080_CHANNEL_COUNT,
2660 extern SR_PRIV const char *vc4080_channel_formats[VC4080_CHANNEL_COUNT];
2662 SR_PRIV int vc4080_config_list(uint32_t key, GVariant **data,
2663 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg);
2664 SR_PRIV int vc4080_packet_request(struct sr_serial_dev_inst *serial);
2665 SR_PRIV gboolean vc4080_packet_valid(const uint8_t *pkt);
2666 SR_PRIV int vc4080_packet_parse(const uint8_t *pkt, float *floatval,
2667 struct sr_datafeed_analog *analog, void *info);
2669 /*--- dmm/ut372.c -----------------------------------------------------------*/
2671 #define UT372_PACKET_SIZE 27
2677 SR_PRIV gboolean sr_ut372_packet_valid(const uint8_t *buf);
2678 SR_PRIV int sr_ut372_parse(const uint8_t *buf, float *floatval,
2679 struct sr_datafeed_analog *analog, void *info);
2681 /*--- dmm/asycii.c ----------------------------------------------------------*/
2683 #define ASYCII_PACKET_SIZE 16
2685 struct asycii_info {
2686 gboolean is_ac, is_dc, is_ac_and_dc;
2687 gboolean is_resistance, is_capacitance, is_diode, is_gain;
2688 gboolean is_frequency, is_duty_cycle, is_duty_pos, is_duty_neg;
2689 gboolean is_pulse_width, is_period_pos, is_period_neg;
2690 gboolean is_pulse_count, is_count_pos, is_count_neg;
2691 gboolean is_ampere, is_volt, is_volt_ampere, is_farad, is_ohm;
2692 gboolean is_hertz, is_percent, is_seconds, is_decibel;
2693 gboolean is_pico, is_nano, is_micro, is_milli, is_kilo, is_mega;
2694 gboolean is_unitless;
2695 gboolean is_peak_min, is_peak_max;
2696 gboolean is_invalid;
2699 #ifdef HAVE_SERIAL_COMM
2700 SR_PRIV int sr_asycii_packet_request(struct sr_serial_dev_inst *serial);
2702 SR_PRIV gboolean sr_asycii_packet_valid(const uint8_t *buf);
2703 SR_PRIV int sr_asycii_parse(const uint8_t *buf, float *floatval,
2704 struct sr_datafeed_analog *analog, void *info);
2706 /*--- dmm/eev121gw.c --------------------------------------------------------*/
2708 #define EEV121GW_PACKET_SIZE 19
2710 enum eev121gw_display {
2711 EEV121GW_DISPLAY_MAIN,
2712 EEV121GW_DISPLAY_SUB,
2713 EEV121GW_DISPLAY_BAR,
2714 EEV121GW_DISPLAY_COUNT,
2717 struct eev121gw_info {
2718 /* Selected channel. */
2721 * Measured value, number and sign/overflow flags, scale factor
2722 * and significant digits.
2724 uint32_t uint_value;
2725 gboolean is_ofl, is_neg;
2727 /* Currently active mode (meter's function). */
2728 gboolean is_ac, is_dc, is_voltage, is_current, is_power, is_gain;
2729 gboolean is_resistance, is_capacitance, is_diode, is_temperature;
2730 gboolean is_continuity, is_frequency, is_period, is_duty_cycle;
2731 /* Quantities associated with mode/function. */
2732 gboolean is_ampere, is_volt, is_volt_ampere, is_dbm;
2733 gboolean is_ohm, is_farad, is_celsius, is_fahrenheit;
2734 gboolean is_hertz, is_seconds, is_percent, is_loop_current;
2735 gboolean is_unitless, is_logic;
2736 /* Other indicators. */
2737 gboolean is_min, is_max, is_avg, is_1ms_peak, is_rel, is_hold;
2738 gboolean is_low_pass, is_mem, is_bt, is_auto_range, is_test;
2739 gboolean is_auto_poweroff, is_low_batt;
2742 extern SR_PRIV const char *eev121gw_channel_formats[];
2743 SR_PRIV gboolean sr_eev121gw_packet_valid(const uint8_t *buf);
2744 SR_PRIV int sr_eev121gw_3displays_parse(const uint8_t *buf, float *floatval,
2745 struct sr_datafeed_analog *analog, void *info);
2747 /*--- scale/kern.c ----------------------------------------------------------*/
2750 gboolean is_gram, is_carat, is_ounce, is_pound, is_troy_ounce;
2751 gboolean is_pennyweight, is_grain, is_tael, is_momme, is_tola;
2752 gboolean is_percentage, is_piece, is_unstable, is_stable, is_error;
2756 SR_PRIV gboolean sr_kern_packet_valid(const uint8_t *buf);
2757 SR_PRIV int sr_kern_parse(const uint8_t *buf, float *floatval,
2758 struct sr_datafeed_analog *analog, void *info);
2760 /*--- sw_limits.c -----------------------------------------------------------*/
2762 struct sr_sw_limits {
2763 uint64_t limit_samples;
2764 uint64_t limit_frames;
2765 uint64_t limit_msec;
2766 uint64_t samples_read;
2767 uint64_t frames_read;
2768 uint64_t start_time;
2771 SR_PRIV int sr_sw_limits_config_get(const struct sr_sw_limits *limits, uint32_t key,
2773 SR_PRIV int sr_sw_limits_config_set(struct sr_sw_limits *limits, uint32_t key,
2775 SR_PRIV void sr_sw_limits_acquisition_start(struct sr_sw_limits *limits);
2776 SR_PRIV gboolean sr_sw_limits_check(struct sr_sw_limits *limits);
2777 SR_PRIV int sr_sw_limits_get_remain(const struct sr_sw_limits *limits,
2778 uint64_t *samples, uint64_t *frames, uint64_t *msecs,
2779 gboolean *exceeded);
2780 SR_PRIV void sr_sw_limits_update_samples_read(struct sr_sw_limits *limits,
2781 uint64_t samples_read);
2782 SR_PRIV void sr_sw_limits_update_frames_read(struct sr_sw_limits *limits,
2783 uint64_t frames_read);
2784 SR_PRIV void sr_sw_limits_init(struct sr_sw_limits *limits);
2786 /*--- feed_queue.h ----------------------------------------------------------*/
2788 struct feed_queue_logic;
2789 struct feed_queue_analog;
2791 SR_API struct feed_queue_logic *feed_queue_logic_alloc(
2792 const struct sr_dev_inst *sdi,
2793 size_t sample_count, size_t unit_size);
2794 SR_API int feed_queue_logic_submit(struct feed_queue_logic *q,
2795 const uint8_t *data, size_t count);
2796 SR_API int feed_queue_logic_flush(struct feed_queue_logic *q);
2797 SR_API int feed_queue_logic_send_trigger(struct feed_queue_logic *q);
2798 SR_API void feed_queue_logic_free(struct feed_queue_logic *q);
2800 SR_API struct feed_queue_analog *feed_queue_analog_alloc(
2801 const struct sr_dev_inst *sdi,
2802 size_t sample_count, int digits, struct sr_channel *ch);
2803 SR_API int feed_queue_analog_mq_unit(struct feed_queue_analog *q,
2804 enum sr_mq mq, enum sr_mqflag mq_flag, enum sr_unit unit);
2805 SR_API int feed_queue_analog_scale_offset(struct feed_queue_analog *q,
2806 const struct sr_rational *scale, const struct sr_rational *offset);
2807 SR_API int feed_queue_analog_submit(struct feed_queue_analog *q,
2808 float data, size_t count);
2809 SR_API int feed_queue_analog_flush(struct feed_queue_analog *q);
2810 SR_API void feed_queue_analog_free(struct feed_queue_analog *q);