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
46 * libsigrok private header file, only to be used internally.
49 /*--- Macros ----------------------------------------------------------------*/
52 #define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0]))
55 #ifndef ARRAY_AND_SIZE
56 #define ARRAY_AND_SIZE(a) (a), ARRAY_SIZE(a)
60 #define G_SOURCE_FUNC(f) ((GSourceFunc) (void (*)(void)) (f)) /* Since 2.58. */
63 #define SR_RECEIVE_DATA_CALLBACK(f) \
64 ((sr_receive_data_callback) (void (*)(void)) (f))
67 * Read a 8 bits unsigned integer out of memory.
68 * @param x a pointer to the input memory
69 * @return the corresponding unsigned integer
71 static inline uint8_t read_u8(const uint8_t *p)
75 #define R8(x) read_u8((const uint8_t *)(x))
78 * Read an 8 bits signed integer out of memory.
79 * @param x a pointer to the input memory
80 * @return the corresponding signed integer
82 static inline int8_t read_i8(const uint8_t *p)
88 * Read a 16 bits big endian unsigned integer out of memory.
89 * @param x a pointer to the input memory
90 * @return the corresponding unsigned integer
92 static inline uint16_t read_u16be(const uint8_t *p)
102 #define RB16(x) read_u16be((const uint8_t *)(x))
105 * Read a 16 bits little endian unsigned integer out of memory.
106 * @param x a pointer to the input memory
107 * @return the corresponding unsigned integer
109 static inline uint16_t read_u16le(const uint8_t *p)
119 #define RL16(x) read_u16le((const uint8_t *)(x))
122 * Read a 16 bits big endian signed integer out of memory.
123 * @param x a pointer to the input memory
124 * @return the corresponding signed integer
126 static inline int16_t read_i16be(const uint8_t *p)
136 #define RB16S(x) read_i16be((const uint8_t *)(x))
139 * Read a 16 bits little endian signed integer out of memory.
140 * @param x a pointer to the input memory
141 * @return the corresponding signed integer
143 static inline int16_t read_i16le(const uint8_t *p)
153 #define RL16S(x) read_i16le((const uint8_t *)(x))
156 * Read a 24 bits little endian unsigned integer out of memory.
157 * @param x a pointer to the input memory
158 * @return the corresponding unsigned integer
160 static inline uint32_t read_u24le(const uint8_t *p)
173 * Read a 32 bits big endian unsigned integer out of memory.
174 * @param x a pointer to the input memory
175 * @return the corresponding unsigned integer
177 static inline uint32_t read_u32be(const uint8_t *p)
189 #define RB32(x) read_u32be((const uint8_t *)(x))
192 * Read a 32 bits little endian unsigned integer out of memory.
193 * @param x a pointer to the input memory
194 * @return the corresponding unsigned integer
196 static inline uint32_t read_u32le(const uint8_t *p)
208 #define RL32(x) read_u32le((const uint8_t *)(x))
211 * Read a 32 bits big endian signed integer out of memory.
212 * @param x a pointer to the input memory
213 * @return the corresponding signed integer
215 static inline int32_t read_i32be(const uint8_t *p)
225 #define RB32S(x) read_i32be((const uint8_t *)(x))
228 * Read a 32 bits little endian signed integer out of memory.
229 * @param x a pointer to the input memory
230 * @return the corresponding signed integer
232 static inline int32_t read_i32le(const uint8_t *p)
242 #define RL32S(x) read_i32le((const uint8_t *)(x))
245 * Read a 64 bits big endian unsigned integer out of memory.
246 * @param x a pointer to the input memory
247 * @return the corresponding unsigned integer
249 static inline uint64_t read_u64be(const uint8_t *p)
265 #define RB64(x) read_u64be((const uint8_t *)(x))
268 * Read a 64 bits little endian unsigned integer out of memory.
269 * @param x a pointer to the input memory
270 * @return the corresponding unsigned integer
272 static inline uint64_t read_u64le(const uint8_t *p)
288 #define RL64(x) read_u64le((const uint8_t *)(x))
291 * Read a 64 bits big endian signed integer out of memory.
292 * @param x a pointer to the input memory
293 * @return the corresponding unsigned integer
295 static inline int64_t read_i64be(const uint8_t *p)
305 #define RB64S(x) read_i64be((const uint8_t *)(x))
308 * Read a 64 bits little endian signed integer out of memory.
309 * @param x a pointer to the input memory
310 * @return the corresponding unsigned integer
312 static inline int64_t read_i64le(const uint8_t *p)
322 #define RL64S(x) read_i64le((const uint8_t *)(x))
325 * Read a 32 bits big endian float out of memory (single precision).
326 * @param x a pointer to the input memory
327 * @return the corresponding float
329 static inline float read_fltbe(const uint8_t *p)
332 * Implementor's note: Strictly speaking the "union" trick
333 * is not portable. But this phrase was found to work on the
334 * project's supported platforms, and serve well until a more
335 * appropriate phrase is found.
337 union { uint32_t u32; float flt; } u;
340 u.u32 = read_u32be(p);
345 #define RBFL(x) read_fltbe((const uint8_t *)(x))
348 * Read a 32 bits little endian float out of memory (single precision).
349 * @param x a pointer to the input memory
350 * @return the corresponding float
352 static inline float read_fltle(const uint8_t *p)
355 * Implementor's note: Strictly speaking the "union" trick
356 * is not portable. But this phrase was found to work on the
357 * project's supported platforms, and serve well until a more
358 * appropriate phrase is found.
360 union { uint32_t u32; float flt; } u;
363 u.u32 = read_u32le(p);
368 #define RLFL(x) read_fltle((const uint8_t *)(x))
371 * Read a 64 bits big endian float out of memory (double precision).
372 * @param x a pointer to the input memory
373 * @return the corresponding floating point value
375 static inline double read_dblbe(const uint8_t *p)
378 * Implementor's note: Strictly speaking the "union" trick
379 * is not portable. But this phrase was found to work on the
380 * project's supported platforms, and serve well until a more
381 * appropriate phrase is found.
383 union { uint64_t u64; double flt; } u;
386 u.u64 = read_u64be(p);
393 * Read a 64 bits little endian float out of memory (double precision).
394 * @param x a pointer to the input memory
395 * @return the corresponding floating point value
397 static inline double read_dblle(const uint8_t *p)
400 * Implementor's note: Strictly speaking the "union" trick
401 * is not portable. But this phrase was found to work on the
402 * project's supported platforms, and serve well until a more
403 * appropriate phrase is found.
405 union { uint64_t u64; double flt; } u;
408 u.u64 = read_u64le(p);
413 #define RLDB(x) read_dblle((const uint8_t *)(x))
416 * Write a 8 bits unsigned integer to memory.
417 * @param p a pointer to the output memory
418 * @param x the input unsigned integer
420 static inline void write_u8(uint8_t *p, uint8_t x)
424 #define W8(p, x) write_u8((uint8_t *)(p), (uint8_t)(x))
427 * Write a 16 bits unsigned integer to memory stored as big endian.
428 * @param p a pointer to the output memory
429 * @param x the input unsigned integer
431 static inline void write_u16be(uint8_t *p, uint16_t x)
433 p[1] = x & 0xff; x >>= 8;
434 p[0] = x & 0xff; x >>= 8;
436 #define WB16(p, x) write_u16be((uint8_t *)(p), (uint16_t)(x))
439 * Write a 16 bits unsigned integer to memory stored as little endian.
440 * @param p a pointer to the output memory
441 * @param x the input unsigned integer
443 static inline void write_u16le(uint8_t *p, uint16_t x)
445 p[0] = x & 0xff; x >>= 8;
446 p[1] = x & 0xff; x >>= 8;
448 #define WL16(p, x) write_u16le((uint8_t *)(p), (uint16_t)(x))
451 * Write a 32 bits unsigned integer to memory stored as big endian.
452 * @param p a pointer to the output memory
453 * @param x the input unsigned integer
455 static inline void write_u32be(uint8_t *p, uint32_t x)
457 p[3] = x & 0xff; x >>= 8;
458 p[2] = x & 0xff; x >>= 8;
459 p[1] = x & 0xff; x >>= 8;
460 p[0] = x & 0xff; x >>= 8;
462 #define WB32(p, x) write_u32be((uint8_t *)(p), (uint32_t)(x))
465 * Write a 32 bits unsigned integer to memory stored as little endian.
466 * @param p a pointer to the output memory
467 * @param x the input unsigned integer
469 static inline void write_u32le(uint8_t *p, uint32_t x)
471 p[0] = x & 0xff; x >>= 8;
472 p[1] = x & 0xff; x >>= 8;
473 p[2] = x & 0xff; x >>= 8;
474 p[3] = x & 0xff; x >>= 8;
476 #define WL32(p, x) write_u32le((uint8_t *)(p), (uint32_t)(x))
479 * Write a 48 bits unsigned integer to memory stored as little endian.
480 * @param p a pointer to the output memory
481 * @param x the input unsigned integer
483 static inline void write_u48le(uint8_t *p, uint64_t x)
485 p[0] = x & 0xff; x >>= 8;
486 p[1] = x & 0xff; x >>= 8;
487 p[2] = x & 0xff; x >>= 8;
488 p[3] = x & 0xff; x >>= 8;
489 p[4] = x & 0xff; x >>= 8;
490 p[5] = x & 0xff; x >>= 8;
492 #define WL48(p, x) write_u48le((uint8_t *)(p), (uint64_t)(x))
495 * Write a 64 bits unsigned integer to memory stored as big endian.
496 * @param p a pointer to the output memory
497 * @param x the input unsigned integer
499 static inline void write_u64be(uint8_t *p, uint64_t x)
501 p[7] = x & 0xff; x >>= 8;
502 p[6] = x & 0xff; x >>= 8;
503 p[5] = x & 0xff; x >>= 8;
504 p[4] = x & 0xff; x >>= 8;
505 p[3] = x & 0xff; x >>= 8;
506 p[2] = x & 0xff; x >>= 8;
507 p[1] = x & 0xff; x >>= 8;
508 p[0] = x & 0xff; x >>= 8;
512 * Write a 64 bits unsigned integer to memory stored as little endian.
513 * @param p a pointer to the output memory
514 * @param x the input unsigned integer
516 static inline void write_u64le(uint8_t *p, uint64_t x)
518 p[0] = x & 0xff; x >>= 8;
519 p[1] = x & 0xff; x >>= 8;
520 p[2] = x & 0xff; x >>= 8;
521 p[3] = x & 0xff; x >>= 8;
522 p[4] = x & 0xff; x >>= 8;
523 p[5] = x & 0xff; x >>= 8;
524 p[6] = x & 0xff; x >>= 8;
525 p[7] = x & 0xff; x >>= 8;
527 #define WL64(p, x) write_u64le((uint8_t *)(p), (uint64_t)(x))
530 * Write a 32 bits float to memory stored as big endian.
531 * @param p a pointer to the output memory
532 * @param x the input float
534 static inline void write_fltbe(uint8_t *p, float x)
536 union { uint32_t u; float f; } u;
540 #define WBFL(p, x) write_fltbe((uint8_t *)(p), (x))
543 * Write a 32 bits float to memory stored as little endian.
544 * @param p a pointer to the output memory
545 * @param x the input float
547 static inline void write_fltle(uint8_t *p, float x)
549 union { uint32_t u; float f; } u;
553 #define WLFL(p, x) write_fltle((uint8_t *)(p), float (x))
556 * Write a 64 bits float to memory stored as little endian.
557 * @param p a pointer to the output memory
558 * @param x the input floating point value
560 static inline void write_dblle(uint8_t *p, double x)
562 union { uint64_t u; double f; } u;
566 #define WLDB(p, x) write_dblle((uint8_t *)(p), float (x))
568 /* Endianess conversion helpers with read/write position increment. */
571 * Read unsigned 8bit integer from raw memory, increment read position.
572 * @param[in, out] p Pointer into byte stream.
573 * @return Retrieved integer value, unsigned.
575 static inline uint8_t read_u8_inc(const uint8_t **p)
588 * Read signed 8bit integer from raw memory, increment read position.
589 * @param[in, out] p Pointer into byte stream.
590 * @return Retrieved integer value, signed.
592 static inline int8_t read_i8_inc(const uint8_t **p)
605 * Read unsigned 16bit integer from raw memory (big endian format), increment read position.
606 * @param[in, out] p Pointer into byte stream.
607 * @return Retrieved integer value, unsigned.
609 static inline uint16_t read_u16be_inc(const uint8_t **p)
622 * Read unsigned 16bit integer from raw memory (little endian format), increment read position.
623 * @param[in, out] p Pointer into byte stream.
624 * @return Retrieved integer value, unsigned.
626 static inline uint16_t read_u16le_inc(const uint8_t **p)
639 * Read signed 16bit integer from raw memory (big endian format), increment read position.
640 * @param[in, out] p Pointer into byte stream.
641 * @return Retrieved integer value, signed.
643 static inline int16_t read_i16be_inc(const uint8_t **p)
656 * Read signed 16bit integer from raw memory (little endian format), increment read position.
657 * @param[in, out] p Pointer into byte stream.
658 * @return Retrieved integer value, signed.
660 static inline int16_t read_i16le_inc(const uint8_t **p)
673 * Read unsigned 24bit integer from raw memory (little endian format), increment read position.
674 * @param[in, out] p Pointer into byte stream.
675 * @return Retrieved integer value, unsigned.
677 static inline uint32_t read_u24le_inc(const uint8_t **p)
684 *p += 3 * sizeof(uint8_t);
690 * Read unsigned 32bit integer from raw memory (big endian format), increment read position.
691 * @param[in, out] p Pointer into byte stream.
692 * @return Retrieved integer value, unsigned.
694 static inline uint32_t read_u32be_inc(const uint8_t **p)
707 * Read unsigned 32bit integer from raw memory (little endian format), increment read position.
708 * @param[in, out] p Pointer into byte stream.
709 * @return Retrieved integer value, unsigned.
711 static inline uint32_t read_u32le_inc(const uint8_t **p)
724 * Read signed 32bit integer from raw memory (big endian format), increment read position.
725 * @param[in, out] p Pointer into byte stream.
726 * @return Retrieved integer value, signed.
728 static inline int32_t read_i32be_inc(const uint8_t **p)
741 * Read signed 32bit integer from raw memory (little endian format), increment read position.
742 * @param[in, out] p Pointer into byte stream.
743 * @return Retrieved integer value, signed.
745 static inline int32_t read_i32le_inc(const uint8_t **p)
758 * Read unsigned 64bit integer from raw memory (big endian format), increment read position.
759 * @param[in, out] p Pointer into byte stream.
760 * @return Retrieved integer value, unsigned.
762 static inline uint64_t read_u64be_inc(const uint8_t **p)
775 * Read unsigned 64bit integer from raw memory (little endian format), increment read position.
776 * @param[in, out] p Pointer into byte stream.
777 * @return Retrieved integer value, unsigned.
779 static inline uint64_t read_u64le_inc(const uint8_t **p)
792 * Read 32bit float from raw memory (big endian format), increment read position.
793 * @param[in, out] p Pointer into byte stream.
794 * @return Retrieved float value.
796 static inline float read_fltbe_inc(const uint8_t **p)
809 * Read 32bit float from raw memory (little endian format), increment read position.
810 * @param[in, out] p Pointer into byte stream.
811 * @return Retrieved float value.
813 static inline float read_fltle_inc(const uint8_t **p)
826 * Read 64bit float from raw memory (big endian format), increment read position.
827 * @param[in, out] p Pointer into byte stream.
828 * @return Retrieved float value.
830 static inline double read_dblbe_inc(const uint8_t **p)
843 * Read 64bit float from raw memory (little endian format), increment read position.
844 * @param[in, out] p Pointer into byte stream.
845 * @return Retrieved float value.
847 static inline double read_dblle_inc(const uint8_t **p)
860 * Write unsigned 8bit integer to raw memory, increment write position.
861 * @param[in, out] p Pointer into byte stream.
862 * @param[in] x Value to write.
864 static inline void write_u8_inc(uint8_t **p, uint8_t x)
873 * Write unsigned 16bit big endian integer to raw memory, increment write position.
874 * @param[in, out] p Pointer into byte stream.
875 * @param[in] x Value to write.
877 static inline void write_u16be_inc(uint8_t **p, uint16_t x)
886 * Write unsigned 16bit little endian integer to raw memory, increment write position.
887 * @param[in, out] p Pointer into byte stream.
888 * @param[in] x Value to write.
890 static inline void write_u16le_inc(uint8_t **p, uint16_t x)
899 * Write unsigned 32bit big endian integer to raw memory, increment write position.
900 * @param[in, out] p Pointer into byte stream.
901 * @param[in] x Value to write.
903 static inline void write_u32be_inc(uint8_t **p, uint32_t x)
912 * Write unsigned 32bit little endian integer to raw memory, increment write position.
913 * @param[in, out] p Pointer into byte stream.
914 * @param[in] x Value to write.
916 static inline void write_u32le_inc(uint8_t **p, uint32_t x)
925 * Write unsigned 48bit little endian integer to raw memory, increment write position.
926 * @param[in, out] p Pointer into byte stream.
927 * @param[in] x Value to write.
929 static inline void write_u48le_inc(uint8_t **p, uint64_t x)
934 *p += 48 / 8 * sizeof(uint8_t);
938 * Write unsigned 64bit little endian integer to raw memory, increment write position.
939 * @param[in, out] p Pointer into byte stream.
940 * @param[in] x Value to write.
942 static inline void write_u64le_inc(uint8_t **p, uint64_t x)
951 * Write single precision little endian float to raw memory, increment write position.
952 * @param[in, out] p Pointer into byte stream.
953 * @param[in] x Value to write.
955 static inline void write_fltle_inc(uint8_t **p, float x)
964 * Write double precision little endian float to raw memory, increment write position.
965 * @param[in, out] p Pointer into byte stream.
966 * @param[in] x Value to write.
968 static inline void write_dblle_inc(uint8_t **p, double x)
976 /* Portability fixes for FreeBSD. */
978 #define LIBUSB_CLASS_APPLICATION 0xfe
979 #define libusb_has_capability(x) 0
980 #define libusb_handle_events_timeout_completed(ctx, tv, c) \
981 libusb_handle_events_timeout(ctx, tv)
984 /* Static definitions of structs ending with an all-zero entry are a
985 * problem when compiling with -Wmissing-field-initializers: GCC
986 * suppresses the warning only with { 0 }, clang wants { } */
990 #define ALL_ZERO { 0 }
994 #define SR_DRIVER_LIST_SECTION "__DATA,__sr_driver_list"
996 #define SR_DRIVER_LIST_SECTION "__sr_driver_list"
999 #if !defined SR_DRIVER_LIST_NOREORDER && defined __has_attribute
1000 #if __has_attribute(no_reorder)
1001 #define SR_DRIVER_LIST_NOREORDER __attribute__((no_reorder))
1004 #if !defined SR_DRIVER_LIST_NOREORDER
1005 #define SR_DRIVER_LIST_NOREORDER /* EMPTY */
1009 * Register a list of hardware drivers.
1011 * This macro can be used to register multiple hardware drivers to the library.
1012 * This is useful when a driver supports multiple similar but slightly
1013 * different devices that require different sr_dev_driver struct definitions.
1015 * For registering only a single driver see SR_REGISTER_DEV_DRIVER().
1019 * #define MY_DRIVER(_name) \
1020 * &(struct sr_dev_driver){ \
1025 * SR_REGISTER_DEV_DRIVER_LIST(my_driver_infos,
1026 * MY_DRIVER("driver 1"),
1027 * MY_DRIVER("driver 2"),
1032 * @param name Name to use for the driver list identifier.
1033 * @param ... Comma separated list of pointers to sr_dev_driver structs.
1035 #define SR_REGISTER_DEV_DRIVER_LIST(name, ...) \
1036 static const struct sr_dev_driver *name[] \
1037 SR_DRIVER_LIST_NOREORDER \
1038 __attribute__((section (SR_DRIVER_LIST_SECTION), used, \
1039 aligned(sizeof(struct sr_dev_driver *)))) \
1045 * Register a hardware driver.
1047 * This macro is used to register a hardware driver with the library. It has
1048 * to be used in order to make the driver accessible to applications using the
1051 * The macro invocation should be placed directly under the struct
1052 * sr_dev_driver definition.
1056 * static struct sr_dev_driver driver_info = {
1060 * SR_REGISTER_DEV_DRIVER(driver_info);
1063 * @param name Identifier name of sr_dev_driver struct to register.
1065 #define SR_REGISTER_DEV_DRIVER(name) \
1066 SR_REGISTER_DEV_DRIVER_LIST(name##_list, &name);
1068 SR_API void sr_drivers_init(struct sr_context *context);
1071 struct sr_dev_driver **driver_list;
1072 #ifdef HAVE_LIBUSB_1_0
1073 libusb_context *libusb_ctx;
1075 sr_resource_open_callback resource_open_cb;
1076 sr_resource_close_callback resource_close_cb;
1077 sr_resource_read_callback resource_read_cb;
1078 void *resource_cb_data;
1081 /** Input module metadata keys. */
1082 enum sr_input_meta_keys {
1083 /** The input filename, if there is one. */
1084 SR_INPUT_META_FILENAME = 0x01,
1085 /** The input file's size in bytes. */
1086 SR_INPUT_META_FILESIZE = 0x02,
1087 /** The first 128 bytes of the file, provided as a GString. */
1088 SR_INPUT_META_HEADER = 0x04,
1090 /** The module cannot identify a file without this metadata. */
1091 SR_INPUT_META_REQUIRED = 0x80,
1094 /** Input (file) module struct. */
1097 * A pointer to this input module's 'struct sr_input_module'.
1099 const struct sr_input_module *module;
1101 struct sr_dev_inst *sdi;
1106 /** Input (file) module driver. */
1107 struct sr_input_module {
1109 * A unique ID for this input module, suitable for use in command-line
1110 * clients, [a-z0-9-]. Must not be NULL.
1115 * A unique name for this input module, suitable for use in GUI
1116 * clients, can contain UTF-8. Must not be NULL.
1121 * A short description of the input module. Must not be NULL.
1123 * This can be displayed by frontends, e.g. when selecting the input
1124 * module for saving a file.
1129 * A NULL terminated array of strings containing a list of file name
1130 * extensions typical for the input file format, or NULL if there is
1131 * no typical extension for this file format.
1133 const char *const *exts;
1136 * Zero-terminated list of metadata items the module needs to be able
1137 * to identify an input stream. Can be all-zero, if the module cannot
1138 * identify streams at all, i.e. has to be forced into use.
1140 * Each item is one of:
1141 * SR_INPUT_META_FILENAME
1142 * SR_INPUT_META_FILESIZE
1143 * SR_INPUT_META_HEADER
1145 * If the high bit (SR_INPUT META_REQUIRED) is set, the module cannot
1146 * identify a stream without the given metadata.
1148 const uint8_t metadata[8];
1151 * Returns a NULL-terminated list of options this module can take.
1152 * Can be NULL, if the module has no options.
1154 const struct sr_option *(*options) (void);
1157 * Check if this input module can load and parse the specified stream.
1159 * @param[in] metadata Metadata the module can use to identify the stream.
1160 * @param[out] confidence "Strength" of the detection.
1161 * Specialized handlers can take precedence over generic/basic support.
1163 * @retval SR_OK This module knows the format.
1164 * @retval SR_ERR_NA There wasn't enough data for this module to
1165 * positively identify the format.
1166 * @retval SR_ERR_DATA This module knows the format, but cannot handle
1167 * it. This means the stream is either corrupt, or indicates a
1168 * feature that the module does not support.
1169 * @retval SR_ERR This module does not know the format.
1171 * Lower numeric values of 'confidence' mean that the input module
1172 * stronger believes in its capability to handle this specific format.
1173 * This way, multiple input modules can claim support for a format,
1174 * and the application can pick the best match, or try fallbacks
1175 * in case of errors. This approach also copes with formats that
1176 * are unreliable to detect in the absence of magic signatures.
1178 int (*format_match) (GHashTable *metadata, unsigned int *confidence);
1181 * Initialize the input module.
1183 * @retval SR_OK Success
1184 * @retval other Negative error code.
1186 int (*init) (struct sr_input *in, GHashTable *options);
1189 * Send data to the specified input instance.
1191 * When an input module instance is created with sr_input_new(), this
1192 * function is used to feed data to the instance.
1194 * As enough data gets fed into this function to completely populate
1195 * the device instance associated with this input instance, this is
1196 * guaranteed to return the moment it's ready. This gives the caller
1197 * the chance to examine the device instance, attach session callbacks
1200 * @retval SR_OK Success
1201 * @retval other Negative error code.
1203 int (*receive) (struct sr_input *in, GString *buf);
1206 * Signal the input module no more data will come.
1208 * This will cause the module to process any data it may have buffered.
1209 * The SR_DF_END packet will also typically be sent at this time.
1211 int (*end) (struct sr_input *in);
1214 * Reset the input module's input handling structures.
1216 * Causes the input module to reset its internal state so that we can
1217 * re-send the input data from the beginning without having to
1218 * re-create the entire input module.
1220 * @retval SR_OK Success.
1221 * @retval other Negative error code.
1223 int (*reset) (struct sr_input *in);
1226 * This function is called after the caller is finished using
1227 * the input module, and can be used to free any internal
1228 * resources the module may keep.
1230 * This function is optional.
1232 * @retval SR_OK Success
1233 * @retval other Negative error code.
1235 void (*cleanup) (struct sr_input *in);
1238 /** Output module instance. */
1240 /** A pointer to this output's module. */
1241 const struct sr_output_module *module;
1244 * The device for which this output module is creating output. This
1245 * can be used by the module to find out channel names and numbers.
1247 const struct sr_dev_inst *sdi;
1250 * The name of the file that the data should be written to.
1252 const char *filename;
1255 * A generic pointer which can be used by the module to keep internal
1256 * state between calls into its callback functions.
1258 * For example, the module might store a pointer to a chunk of output
1259 * there, and only flush it when it reaches a certain size.
1264 /** Output module driver. */
1265 struct sr_output_module {
1267 * A unique ID for this output module, suitable for use in command-line
1268 * clients, [a-z0-9-]. Must not be NULL.
1273 * A unique name for this output module, suitable for use in GUI
1274 * clients, can contain UTF-8. Must not be NULL.
1279 * A short description of the output module. Must not be NULL.
1281 * This can be displayed by frontends, e.g. when selecting the output
1282 * module for saving a file.
1287 * A NULL terminated array of strings containing a list of file name
1288 * extensions typical for the input file format, or NULL if there is
1289 * no typical extension for this file format.
1291 const char *const *exts;
1294 * Bitfield containing flags that describe certain properties
1295 * this output module may or may not have.
1296 * @see sr_output_flags
1298 const uint64_t flags;
1301 * Returns a NULL-terminated list of options this module can take.
1302 * Can be NULL, if the module has no options.
1304 const struct sr_option *(*options) (void);
1307 * This function is called once, at the beginning of an output stream.
1309 * The device struct will be available in the output struct passed in,
1310 * as well as the param field -- which may be NULL or an empty string,
1311 * if no parameter was passed.
1313 * The module can use this to initialize itself, create a struct for
1314 * keeping state and storing it in the <code>internal</code> field.
1316 * @param o Pointer to the respective 'struct sr_output'.
1318 * @retval SR_OK Success
1319 * @retval other Negative error code.
1321 int (*init) (struct sr_output *o, GHashTable *options);
1324 * This function is passed a copy of every packet in the data feed.
1325 * Any output generated by the output module in response to the
1326 * packet should be returned in a newly allocated GString
1327 * <code>out</code>, which will be freed by the caller.
1329 * Packets not of interest to the output module can just be ignored,
1330 * and the <code>out</code> parameter set to NULL.
1332 * @param o Pointer to the respective 'struct sr_output'.
1333 * @param sdi The device instance that generated the packet.
1334 * @param packet The complete packet.
1335 * @param out A pointer where a GString * should be stored if
1336 * the module generates output, or NULL if not.
1338 * @retval SR_OK Success
1339 * @retval other Negative error code.
1341 int (*receive) (const struct sr_output *o,
1342 const struct sr_datafeed_packet *packet, GString **out);
1345 * This function is called after the caller is finished using
1346 * the output module, and can be used to free any internal
1347 * resources the module may keep.
1349 * @retval SR_OK Success
1350 * @retval other Negative error code.
1352 int (*cleanup) (struct sr_output *o);
1355 /** Transform module instance. */
1356 struct sr_transform {
1357 /** A pointer to this transform's module. */
1358 const struct sr_transform_module *module;
1361 * The device for which this transform module is used. This
1362 * can be used by the module to find out channel names and numbers.
1364 const struct sr_dev_inst *sdi;
1367 * A generic pointer which can be used by the module to keep internal
1368 * state between calls into its callback functions.
1373 struct sr_transform_module {
1375 * A unique ID for this transform module, suitable for use in
1376 * command-line clients, [a-z0-9-]. Must not be NULL.
1381 * A unique name for this transform module, suitable for use in GUI
1382 * clients, can contain UTF-8. Must not be NULL.
1387 * A short description of the transform module. Must not be NULL.
1389 * This can be displayed by frontends, e.g. when selecting
1390 * which transform module(s) to add.
1395 * Returns a NULL-terminated list of options this transform module
1396 * can take. Can be NULL, if the transform module has no options.
1398 const struct sr_option *(*options) (void);
1401 * This function is called once, at the beginning of a stream.
1403 * @param t Pointer to the respective 'struct sr_transform'.
1404 * @param options Hash table of options for this transform module.
1405 * Can be NULL if no options are to be used.
1407 * @retval SR_OK Success
1408 * @retval other Negative error code.
1410 int (*init) (struct sr_transform *t, GHashTable *options);
1413 * This function is passed a pointer to every packet in the data feed.
1415 * It can either return (in packet_out) a pointer to another packet
1416 * (possibly the exact same packet it got as input), or NULL.
1418 * @param t Pointer to the respective 'struct sr_transform'.
1419 * @param packet_in Pointer to a datafeed packet.
1420 * @param packet_out Pointer to the resulting datafeed packet after
1421 * this function was run. If NULL, the transform
1422 * module intentionally didn't output a new packet.
1424 * @retval SR_OK Success
1425 * @retval other Negative error code.
1427 int (*receive) (const struct sr_transform *t,
1428 struct sr_datafeed_packet *packet_in,
1429 struct sr_datafeed_packet **packet_out);
1432 * This function is called after the caller is finished using
1433 * the transform module, and can be used to free any internal
1434 * resources the module may keep.
1436 * @retval SR_OK Success
1437 * @retval other Negative error code.
1439 int (*cleanup) (struct sr_transform *t);
1442 #ifdef HAVE_LIBUSB_1_0
1443 /** USB device instance */
1444 struct sr_usb_dev_inst {
1447 /** Device address on USB bus */
1449 /** libusb device handle */
1450 struct libusb_device_handle *devhdl;
1454 struct sr_serial_dev_inst;
1455 #ifdef HAVE_SERIAL_COMM
1456 struct ser_lib_functions;
1457 struct ser_hid_chip_functions;
1459 typedef void (*serial_rx_chunk_callback)(struct sr_serial_dev_inst *serial,
1460 void *cb_data, const void *buf, size_t count);
1461 struct sr_serial_dev_inst {
1462 /** Port name, e.g. '/dev/tty42'. */
1464 /** Comm params for serial_set_paramstr(). */
1466 struct ser_lib_functions *lib_funcs;
1473 GString *rcv_buffer;
1474 serial_rx_chunk_callback rx_chunk_cb_func;
1475 void *rx_chunk_cb_data;
1476 #ifdef HAVE_LIBSERIALPORT
1477 /** libserialport port handle */
1478 struct sp_port *sp_data;
1480 #ifdef HAVE_LIBHIDAPI
1481 enum ser_hid_chip_t {
1482 SER_HID_CHIP_UNKNOWN, /**!< place holder */
1483 SER_HID_CHIP_BTC_BU86X, /**!< Brymen BU86x */
1484 SER_HID_CHIP_SIL_CP2110, /**!< SiLabs CP2110 */
1485 SER_HID_CHIP_VICTOR_DMM, /**!< Victor 70/86 DMM cable */
1486 SER_HID_CHIP_WCH_CH9325, /**!< WCH CH9325 */
1487 SER_HID_CHIP_LAST, /**!< sentinel */
1489 struct ser_hid_chip_functions *hid_chip_funcs;
1492 const char *hid_path;
1493 hid_device *hid_dev;
1494 GSList *hid_source_args;
1496 #ifdef HAVE_BLUETOOTH
1497 enum ser_bt_conn_t {
1498 SER_BT_CONN_UNKNOWN, /**!< place holder */
1499 SER_BT_CONN_RFCOMM, /**!< BT classic, RFCOMM channel */
1500 SER_BT_CONN_BLE122, /**!< BLE, BLE122 module, indications */
1501 SER_BT_CONN_NRF51, /**!< BLE, Nordic nRF51, notifications */
1502 SER_BT_CONN_CC254x, /**!< BLE, TI CC254x, notifications */
1503 SER_BT_CONN_MAX, /**!< sentinel */
1505 char *bt_addr_local;
1506 char *bt_addr_remote;
1507 size_t bt_rfcomm_channel;
1508 uint16_t bt_notify_handle_read;
1509 uint16_t bt_notify_handle_write;
1510 uint16_t bt_notify_handle_cccd;
1511 uint16_t bt_notify_value_cccd;
1512 struct sr_bt_desc *bt_desc;
1513 GSList *bt_source_args;
1518 struct sr_usbtmc_dev_inst {
1523 /* Private driver context. */
1524 struct drv_context {
1525 /** sigrok context */
1526 struct sr_context *sr_ctx;
1530 /*--- log.c -----------------------------------------------------------------*/
1532 #if defined(_WIN32) && (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 4))
1534 * On MinGW, we need to specify the gnu_printf format flavor or GCC
1535 * will assume non-standard Microsoft printf syntax.
1537 SR_PRIV int sr_log(int loglevel, const char *format, ...)
1538 __attribute__((__format__ (__gnu_printf__, 2, 3)));
1540 SR_PRIV int sr_log(int loglevel, const char *format, ...) G_GNUC_PRINTF(2, 3);
1543 /* Message logging helpers with subsystem-specific prefix string. */
1544 #define sr_spew(...) sr_log(SR_LOG_SPEW, LOG_PREFIX ": " __VA_ARGS__)
1545 #define sr_dbg(...) sr_log(SR_LOG_DBG, LOG_PREFIX ": " __VA_ARGS__)
1546 #define sr_info(...) sr_log(SR_LOG_INFO, LOG_PREFIX ": " __VA_ARGS__)
1547 #define sr_warn(...) sr_log(SR_LOG_WARN, LOG_PREFIX ": " __VA_ARGS__)
1548 #define sr_err(...) sr_log(SR_LOG_ERR, LOG_PREFIX ": " __VA_ARGS__)
1550 /*--- device.c --------------------------------------------------------------*/
1552 /** Scan options supported by a driver. */
1553 #define SR_CONF_SCAN_OPTIONS 0x7FFF0000
1555 /** Device options for a particular device. */
1556 #define SR_CONF_DEVICE_OPTIONS 0x7FFF0001
1558 /** Mask for separating config keys from capabilities. */
1559 #define SR_CONF_MASK 0x1fffffff
1561 /** Values for the changes argument of sr_dev_driver.config_channel_set. */
1563 /** The enabled state of the channel has been changed. */
1564 SR_CHANNEL_SET_ENABLED = 1 << 0,
1567 SR_PRIV struct sr_channel *sr_channel_new(struct sr_dev_inst *sdi,
1568 int index, int type, gboolean enabled, const char *name);
1569 SR_PRIV void sr_channel_free(struct sr_channel *ch);
1570 SR_PRIV void sr_channel_free_cb(void *p);
1571 SR_PRIV struct sr_channel *sr_next_enabled_channel(const struct sr_dev_inst *sdi,
1572 struct sr_channel *cur_channel);
1573 SR_PRIV gboolean sr_channels_differ(struct sr_channel *ch1, struct sr_channel *ch2);
1574 SR_PRIV gboolean sr_channel_lists_differ(GSList *l1, GSList *l2);
1576 /** Device instance data */
1577 struct sr_dev_inst {
1578 /** Device driver. */
1579 struct sr_dev_driver *driver;
1580 /** Device instance status. SR_ST_NOT_FOUND, etc. */
1582 /** Device instance type. SR_INST_USB, etc. */
1584 /** Device vendor. */
1586 /** Device model. */
1588 /** Device version. */
1590 /** Serial number. */
1592 /** Connection string to uniquely identify devices. */
1593 char *connection_id;
1594 /** List of channels. */
1596 /** List of sr_channel_group structs */
1597 GSList *channel_groups;
1598 /** Device instance connection data (used?) */
1600 /** Device instance private data (used?) */
1602 /** Session to which this device is currently assigned. */
1603 struct sr_session *session;
1606 /* Generic device instances */
1607 SR_PRIV void sr_dev_inst_free(struct sr_dev_inst *sdi);
1609 #ifdef HAVE_LIBUSB_1_0
1610 /* USB-specific instances */
1611 SR_PRIV struct sr_usb_dev_inst *sr_usb_dev_inst_new(uint8_t bus,
1612 uint8_t address, struct libusb_device_handle *hdl);
1613 SR_PRIV void sr_usb_dev_inst_free(struct sr_usb_dev_inst *usb);
1616 #ifdef HAVE_SERIAL_COMM
1617 #ifndef HAVE_LIBSERIALPORT
1619 * Some identifiers which initially got provided by libserialport are
1620 * used internally within the libsigrok serial layer's implementation,
1621 * while libserialport no longer is the exclusive provider of serial
1622 * communication support. Declare the identifiers here so they remain
1623 * available across all build configurations.
1630 SP_PARITY_SPACE = 4,
1633 enum libsp_flowcontrol {
1634 SP_FLOWCONTROL_NONE = 0,
1635 SP_FLOWCONTROL_XONXOFF = 1,
1636 SP_FLOWCONTROL_RTSCTS = 2,
1637 SP_FLOWCONTROL_DTRDSR = 3,
1641 /* Serial-specific instances */
1642 SR_PRIV struct sr_serial_dev_inst *sr_serial_dev_inst_new(const char *port,
1643 const char *serialcomm);
1644 SR_PRIV void sr_serial_dev_inst_free(struct sr_serial_dev_inst *serial);
1647 /* USBTMC-specific instances */
1648 SR_PRIV struct sr_usbtmc_dev_inst *sr_usbtmc_dev_inst_new(const char *device);
1649 SR_PRIV void sr_usbtmc_dev_inst_free(struct sr_usbtmc_dev_inst *usbtmc);
1651 /*--- hwdriver.c ------------------------------------------------------------*/
1653 SR_PRIV const GVariantType *sr_variant_type_get(int datatype);
1654 SR_PRIV int sr_variant_type_check(uint32_t key, GVariant *data);
1655 SR_PRIV void sr_hw_cleanup_all(const struct sr_context *ctx);
1656 SR_PRIV struct sr_config *sr_config_new(uint32_t key, GVariant *data);
1657 SR_PRIV void sr_config_free(struct sr_config *src);
1658 SR_PRIV int sr_dev_acquisition_start(struct sr_dev_inst *sdi);
1659 SR_PRIV int sr_dev_acquisition_stop(struct sr_dev_inst *sdi);
1661 /*--- session.c -------------------------------------------------------------*/
1664 /** Context this session exists in. */
1665 struct sr_context *ctx;
1666 /** List of struct sr_dev_inst pointers. */
1668 /** List of struct sr_dev_inst pointers owned by this session. */
1670 /** List of struct datafeed_callback pointers. */
1671 GSList *datafeed_callbacks;
1673 struct sr_trigger *trigger;
1675 /** Callback to invoke on session stop. */
1676 sr_session_stopped_callback stopped_callback;
1677 /** User data to be passed to the session stop callback. */
1678 void *stopped_cb_data;
1680 /** Mutex protecting the main context pointer. */
1682 /** Context of the session main loop. */
1683 GMainContext *main_context;
1685 /** Registered event sources for this session. */
1686 GHashTable *event_sources;
1687 /** Session main loop. */
1688 GMainLoop *main_loop;
1689 /** ID of idle source for dispatching the session stop notification. */
1690 unsigned int stop_check_id;
1691 /** Whether the session has been started. */
1695 SR_PRIV int sr_session_source_add_internal(struct sr_session *session,
1696 void *key, GSource *source);
1697 SR_PRIV int sr_session_source_remove_internal(struct sr_session *session,
1699 SR_PRIV int sr_session_source_destroyed(struct sr_session *session,
1700 void *key, GSource *source);
1701 SR_PRIV int sr_session_fd_source_add(struct sr_session *session,
1702 void *key, gintptr fd, int events, int timeout,
1703 sr_receive_data_callback cb, void *cb_data);
1705 SR_PRIV int sr_session_source_add(struct sr_session *session, int fd,
1706 int events, int timeout, sr_receive_data_callback cb, void *cb_data);
1707 SR_PRIV int sr_session_source_add_pollfd(struct sr_session *session,
1708 GPollFD *pollfd, int timeout, sr_receive_data_callback cb,
1710 SR_PRIV int sr_session_source_add_channel(struct sr_session *session,
1711 GIOChannel *channel, int events, int timeout,
1712 sr_receive_data_callback cb, void *cb_data);
1713 SR_PRIV int sr_session_source_remove(struct sr_session *session, int fd);
1714 SR_PRIV int sr_session_source_remove_pollfd(struct sr_session *session,
1716 SR_PRIV int sr_session_source_remove_channel(struct sr_session *session,
1717 GIOChannel *channel);
1719 SR_PRIV int sr_session_send_meta(const struct sr_dev_inst *sdi,
1720 uint32_t key, GVariant *var);
1721 SR_PRIV int sr_session_send(const struct sr_dev_inst *sdi,
1722 const struct sr_datafeed_packet *packet);
1723 SR_PRIV int sr_sessionfile_check(const char *filename);
1724 SR_PRIV struct sr_dev_inst *sr_session_prepare_sdi(const char *filename,
1725 struct sr_session **session);
1727 /*--- session_file.c --------------------------------------------------------*/
1729 #if !HAVE_ZIP_DISCARD
1730 /* Replace zip_discard() if not available. */
1731 #define zip_discard(zip) sr_zip_discard(zip)
1732 SR_PRIV void sr_zip_discard(struct zip *archive);
1735 SR_PRIV GKeyFile *sr_sessionfile_read_metadata(struct zip *archive,
1736 const struct zip_stat *entry);
1738 /*--- analog.c --------------------------------------------------------------*/
1740 SR_PRIV int sr_analog_init(struct sr_datafeed_analog *analog,
1741 struct sr_analog_encoding *encoding,
1742 struct sr_analog_meaning *meaning,
1743 struct sr_analog_spec *spec,
1746 /*--- std.c -----------------------------------------------------------------*/
1748 typedef int (*dev_close_callback)(struct sr_dev_inst *sdi);
1749 typedef void (*std_dev_clear_callback)(void *priv);
1751 SR_PRIV int std_init(struct sr_dev_driver *di, struct sr_context *sr_ctx);
1752 SR_PRIV int std_cleanup(const struct sr_dev_driver *di);
1753 SR_PRIV int std_dummy_dev_open(struct sr_dev_inst *sdi);
1754 SR_PRIV int std_dummy_dev_close(struct sr_dev_inst *sdi);
1755 SR_PRIV int std_dummy_dev_acquisition_start(const struct sr_dev_inst *sdi);
1756 SR_PRIV int std_dummy_dev_acquisition_stop(struct sr_dev_inst *sdi);
1757 #ifdef HAVE_SERIAL_COMM
1758 SR_PRIV int std_serial_dev_open(struct sr_dev_inst *sdi);
1759 SR_PRIV int std_serial_dev_acquisition_stop(struct sr_dev_inst *sdi);
1761 SR_PRIV int std_session_send_df_header(const struct sr_dev_inst *sdi);
1762 SR_PRIV int std_session_send_df_end(const struct sr_dev_inst *sdi);
1763 SR_PRIV int std_session_send_df_trigger(const struct sr_dev_inst *sdi);
1764 SR_PRIV int std_session_send_df_frame_begin(const struct sr_dev_inst *sdi);
1765 SR_PRIV int std_session_send_df_frame_end(const struct sr_dev_inst *sdi);
1766 SR_PRIV int std_dev_clear_with_callback(const struct sr_dev_driver *driver,
1767 std_dev_clear_callback clear_private);
1768 SR_PRIV int std_dev_clear(const struct sr_dev_driver *driver);
1769 SR_PRIV GSList *std_dev_list(const struct sr_dev_driver *di);
1770 SR_PRIV int std_serial_dev_close(struct sr_dev_inst *sdi);
1771 SR_PRIV GSList *std_scan_complete(struct sr_dev_driver *di, GSList *devices);
1773 SR_PRIV int std_opts_config_list(uint32_t key, GVariant **data,
1774 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg,
1775 const uint32_t scanopts[], size_t scansize, const uint32_t drvopts[],
1776 size_t drvsize, const uint32_t devopts[], size_t devsize);
1778 extern SR_PRIV const uint32_t NO_OPTS[1];
1780 #define STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts) \
1781 std_opts_config_list(key, data, sdi, cg, ARRAY_AND_SIZE(scanopts), \
1782 ARRAY_AND_SIZE(drvopts), ARRAY_AND_SIZE(devopts))
1784 SR_PRIV GVariant *std_gvar_tuple_array(const uint64_t a[][2], unsigned int n);
1785 SR_PRIV GVariant *std_gvar_tuple_rational(const struct sr_rational *r, unsigned int n);
1786 SR_PRIV GVariant *std_gvar_samplerates(const uint64_t samplerates[], unsigned int n);
1787 SR_PRIV GVariant *std_gvar_samplerates_steps(const uint64_t samplerates[], unsigned int n);
1788 SR_PRIV GVariant *std_gvar_min_max_step(double min, double max, double step);
1789 SR_PRIV GVariant *std_gvar_min_max_step_array(const double a[3]);
1790 SR_PRIV GVariant *std_gvar_min_max_step_thresholds(const double dmin, const double dmax, const double dstep);
1792 SR_PRIV GVariant *std_gvar_tuple_u64(uint64_t low, uint64_t high);
1793 SR_PRIV GVariant *std_gvar_tuple_double(double low, double high);
1795 SR_PRIV GVariant *std_gvar_array_i32(const int32_t a[], unsigned int n);
1796 SR_PRIV GVariant *std_gvar_array_u32(const uint32_t a[], unsigned int n);
1797 SR_PRIV GVariant *std_gvar_array_u64(const uint64_t a[], unsigned int n);
1798 SR_PRIV GVariant *std_gvar_array_str(const char *a[], unsigned int n);
1800 SR_PRIV GVariant *std_gvar_thresholds(const double a[][2], unsigned int n);
1802 SR_PRIV int std_str_idx(GVariant *data, const char *a[], unsigned int n);
1803 SR_PRIV int std_u64_idx(GVariant *data, const uint64_t a[], unsigned int n);
1804 SR_PRIV int std_u8_idx(GVariant *data, const uint8_t a[], unsigned int n);
1806 SR_PRIV int std_str_idx_s(const char *s, const char *a[], unsigned int n);
1807 SR_PRIV int std_u8_idx_s(uint8_t b, const uint8_t a[], unsigned int n);
1809 SR_PRIV int std_u64_tuple_idx(GVariant *data, const uint64_t a[][2], unsigned int n);
1810 SR_PRIV int std_double_tuple_idx(GVariant *data, const double a[][2], unsigned int n);
1811 SR_PRIV int std_double_tuple_idx_d0(const double d, const double a[][2], unsigned int n);
1813 SR_PRIV int std_cg_idx(const struct sr_channel_group *cg, struct sr_channel_group *a[], unsigned int n);
1815 SR_PRIV int std_dummy_set_params(struct sr_serial_dev_inst *serial,
1816 int baudrate, int bits, int parity, int stopbits,
1817 int flowcontrol, int rts, int dtr);
1818 SR_PRIV int std_dummy_set_handshake(struct sr_serial_dev_inst *serial,
1821 /*--- resource.c ------------------------------------------------------------*/
1823 SR_PRIV int64_t sr_file_get_size(FILE *file);
1825 SR_PRIV int sr_resource_open(struct sr_context *ctx,
1826 struct sr_resource *res, int type, const char *name)
1827 G_GNUC_WARN_UNUSED_RESULT;
1828 SR_PRIV int sr_resource_close(struct sr_context *ctx,
1829 struct sr_resource *res);
1830 SR_PRIV gssize sr_resource_read(struct sr_context *ctx,
1831 const struct sr_resource *res, void *buf, size_t count)
1832 G_GNUC_WARN_UNUSED_RESULT;
1833 SR_PRIV void *sr_resource_load(struct sr_context *ctx, int type,
1834 const char *name, size_t *size, size_t max_size)
1835 G_GNUC_MALLOC G_GNUC_WARN_UNUSED_RESULT;
1837 /*--- strutil.c -------------------------------------------------------------*/
1839 SR_PRIV int sr_atol(const char *str, long *ret);
1840 SR_PRIV int sr_atol_base(const char *str, long *ret, char **end, int base);
1841 SR_PRIV int sr_atoul_base(const char *str, unsigned long *ret, char **end, int base);
1842 SR_PRIV int sr_atoi(const char *str, int *ret);
1843 SR_PRIV int sr_atod(const char *str, double *ret);
1844 SR_PRIV int sr_atof(const char *str, float *ret);
1845 SR_PRIV int sr_atod_ascii(const char *str, double *ret);
1846 SR_PRIV int sr_atod_ascii_digits(const char *str, double *ret, int *digits);
1847 SR_PRIV int sr_atof_ascii(const char *str, float *ret);
1849 SR_PRIV GString *sr_hexdump_new(const uint8_t *data, const size_t len);
1850 SR_PRIV void sr_hexdump_free(GString *s);
1852 /*--- soft-trigger.c --------------------------------------------------------*/
1854 struct soft_trigger_logic {
1855 const struct sr_dev_inst *sdi;
1856 const struct sr_trigger *trigger;
1860 uint8_t *prev_sample;
1861 uint8_t *pre_trigger_buffer;
1862 uint8_t *pre_trigger_head;
1863 int pre_trigger_size;
1864 int pre_trigger_fill;
1867 SR_PRIV int logic_channel_unitsize(GSList *channels);
1868 SR_PRIV struct soft_trigger_logic *soft_trigger_logic_new(
1869 const struct sr_dev_inst *sdi, struct sr_trigger *trigger,
1870 int pre_trigger_samples);
1871 SR_PRIV void soft_trigger_logic_free(struct soft_trigger_logic *st);
1872 SR_PRIV int soft_trigger_logic_check(struct soft_trigger_logic *st, uint8_t *buf,
1873 int len, int *pre_trigger_samples);
1875 /*--- serial.c --------------------------------------------------------------*/
1877 #ifdef HAVE_SERIAL_COMM
1883 typedef gboolean (*packet_valid_callback)(const uint8_t *buf);
1884 typedef int (*packet_valid_len_callback)(void *st,
1885 const uint8_t *p, size_t l, size_t *pl);
1887 typedef GSList *(*sr_ser_list_append_t)(GSList *devs, const char *name,
1889 typedef GSList *(*sr_ser_find_append_t)(GSList *devs, const char *name);
1891 SR_PRIV int serial_open(struct sr_serial_dev_inst *serial, int flags);
1892 SR_PRIV int serial_close(struct sr_serial_dev_inst *serial);
1893 SR_PRIV int serial_flush(struct sr_serial_dev_inst *serial);
1894 SR_PRIV int serial_drain(struct sr_serial_dev_inst *serial);
1895 SR_PRIV size_t serial_has_receive_data(struct sr_serial_dev_inst *serial);
1896 SR_PRIV int serial_write_blocking(struct sr_serial_dev_inst *serial,
1897 const void *buf, size_t count, unsigned int timeout_ms);
1898 SR_PRIV int serial_write_nonblocking(struct sr_serial_dev_inst *serial,
1899 const void *buf, size_t count);
1900 SR_PRIV int serial_read_blocking(struct sr_serial_dev_inst *serial, void *buf,
1901 size_t count, unsigned int timeout_ms);
1902 SR_PRIV int serial_read_nonblocking(struct sr_serial_dev_inst *serial, void *buf,
1904 SR_PRIV int serial_set_read_chunk_cb(struct sr_serial_dev_inst *serial,
1905 serial_rx_chunk_callback cb, void *cb_data);
1906 SR_PRIV int serial_set_params(struct sr_serial_dev_inst *serial, int baudrate,
1907 int bits, int parity, int stopbits, int flowcontrol, int rts, int dtr);
1908 SR_PRIV int serial_set_handshake(struct sr_serial_dev_inst *serial,
1910 SR_PRIV int serial_set_paramstr(struct sr_serial_dev_inst *serial,
1911 const char *paramstr);
1912 SR_PRIV int serial_readline(struct sr_serial_dev_inst *serial, char **buf,
1913 int *buflen, gint64 timeout_ms);
1914 SR_PRIV int serial_stream_detect(struct sr_serial_dev_inst *serial,
1915 uint8_t *buf, size_t *buflen,
1916 size_t packet_size, packet_valid_callback is_valid,
1917 packet_valid_len_callback is_valid_len, size_t *return_size,
1918 uint64_t timeout_ms);
1919 SR_PRIV int sr_serial_extract_options(GSList *options, const char **serial_device,
1920 const char **serial_options);
1921 SR_PRIV int serial_source_add(struct sr_session *session,
1922 struct sr_serial_dev_inst *serial, int events, int timeout,
1923 sr_receive_data_callback cb, void *cb_data);
1924 SR_PRIV int serial_source_remove(struct sr_session *session,
1925 struct sr_serial_dev_inst *serial);
1926 SR_PRIV GSList *sr_serial_find_usb(uint16_t vendor_id, uint16_t product_id);
1927 SR_PRIV int serial_timeout(struct sr_serial_dev_inst *port, int num_bytes);
1929 SR_PRIV void sr_ser_discard_queued_data(struct sr_serial_dev_inst *serial);
1930 SR_PRIV size_t sr_ser_has_queued_data(struct sr_serial_dev_inst *serial);
1931 SR_PRIV void sr_ser_queue_rx_data(struct sr_serial_dev_inst *serial,
1932 const uint8_t *data, size_t len);
1933 SR_PRIV size_t sr_ser_unqueue_rx_data(struct sr_serial_dev_inst *serial,
1934 uint8_t *data, size_t len);
1936 struct ser_lib_functions {
1937 int (*open)(struct sr_serial_dev_inst *serial, int flags);
1938 int (*close)(struct sr_serial_dev_inst *serial);
1939 int (*flush)(struct sr_serial_dev_inst *serial);
1940 int (*drain)(struct sr_serial_dev_inst *serial);
1941 int (*write)(struct sr_serial_dev_inst *serial,
1942 const void *buf, size_t count,
1943 int nonblocking, unsigned int timeout_ms);
1944 int (*read)(struct sr_serial_dev_inst *serial,
1945 void *buf, size_t count,
1946 int nonblocking, unsigned int timeout_ms);
1947 int (*set_params)(struct sr_serial_dev_inst *serial,
1948 int baudrate, int bits, int parity, int stopbits,
1949 int flowcontrol, int rts, int dtr);
1950 int (*set_handshake)(struct sr_serial_dev_inst *serial,
1952 int (*setup_source_add)(struct sr_session *session,
1953 struct sr_serial_dev_inst *serial,
1954 int events, int timeout,
1955 sr_receive_data_callback cb, void *cb_data);
1956 int (*setup_source_remove)(struct sr_session *session,
1957 struct sr_serial_dev_inst *serial);
1958 GSList *(*list)(GSList *list, sr_ser_list_append_t append);
1959 GSList *(*find_usb)(GSList *list, sr_ser_find_append_t append,
1960 uint16_t vendor_id, uint16_t product_id);
1961 int (*get_frame_format)(struct sr_serial_dev_inst *serial,
1962 int *baud, int *bits);
1963 size_t (*get_rx_avail)(struct sr_serial_dev_inst *serial);
1965 extern SR_PRIV struct ser_lib_functions *ser_lib_funcs_libsp;
1966 SR_PRIV int ser_name_is_hid(struct sr_serial_dev_inst *serial);
1967 extern SR_PRIV struct ser_lib_functions *ser_lib_funcs_hid;
1968 SR_PRIV int ser_name_is_bt(struct sr_serial_dev_inst *serial);
1969 extern SR_PRIV struct ser_lib_functions *ser_lib_funcs_bt;
1971 #ifdef HAVE_LIBHIDAPI
1972 struct vid_pid_item {
1976 struct ser_hid_chip_functions {
1977 const char *chipname;
1978 const char *chipdesc;
1979 const struct vid_pid_item *vid_pid_items;
1980 const int max_bytes_per_request;
1981 int (*set_params)(struct sr_serial_dev_inst *serial,
1982 int baudrate, int bits, int parity, int stopbits,
1983 int flowcontrol, int rts, int dtr);
1984 int (*read_bytes)(struct sr_serial_dev_inst *serial,
1985 uint8_t *data, int space, unsigned int timeout);
1986 int (*write_bytes)(struct sr_serial_dev_inst *serial,
1987 const uint8_t *data, int space);
1988 int (*flush)(struct sr_serial_dev_inst *serial);
1989 int (*drain)(struct sr_serial_dev_inst *serial);
1991 extern SR_PRIV struct ser_hid_chip_functions *ser_hid_chip_funcs_bu86x;
1992 extern SR_PRIV struct ser_hid_chip_functions *ser_hid_chip_funcs_ch9325;
1993 extern SR_PRIV struct ser_hid_chip_functions *ser_hid_chip_funcs_cp2110;
1994 extern SR_PRIV struct ser_hid_chip_functions *ser_hid_chip_funcs_victor;
1995 SR_PRIV const char *ser_hid_chip_find_name_vid_pid(uint16_t vid, uint16_t pid);
1999 /*--- bt/ API ---------------------------------------------------------------*/
2001 #ifdef HAVE_BLUETOOTH
2002 SR_PRIV const char *sr_bt_adapter_get_address(size_t idx);
2005 typedef void (*sr_bt_scan_cb)(void *cb_data, const char *addr, const char *name);
2006 typedef int (*sr_bt_data_cb)(void *cb_data, uint8_t *data, size_t dlen);
2008 SR_PRIV struct sr_bt_desc *sr_bt_desc_new(void);
2009 SR_PRIV void sr_bt_desc_free(struct sr_bt_desc *desc);
2011 SR_PRIV int sr_bt_config_cb_scan(struct sr_bt_desc *desc,
2012 sr_bt_scan_cb cb, void *cb_data);
2013 SR_PRIV int sr_bt_config_cb_data(struct sr_bt_desc *desc,
2014 sr_bt_data_cb cb, void *cb_data);
2015 SR_PRIV int sr_bt_config_addr_local(struct sr_bt_desc *desc, const char *addr);
2016 SR_PRIV int sr_bt_config_addr_remote(struct sr_bt_desc *desc, const char *addr);
2017 SR_PRIV int sr_bt_config_rfcomm(struct sr_bt_desc *desc, size_t channel);
2018 SR_PRIV int sr_bt_config_notify(struct sr_bt_desc *desc,
2019 uint16_t read_handle, uint16_t write_handle,
2020 uint16_t cccd_handle, uint16_t cccd_value);
2022 SR_PRIV int sr_bt_scan_le(struct sr_bt_desc *desc, int duration);
2023 SR_PRIV int sr_bt_scan_bt(struct sr_bt_desc *desc, int duration);
2025 SR_PRIV int sr_bt_connect_ble(struct sr_bt_desc *desc);
2026 SR_PRIV int sr_bt_connect_rfcomm(struct sr_bt_desc *desc);
2027 SR_PRIV void sr_bt_disconnect(struct sr_bt_desc *desc);
2029 SR_PRIV ssize_t sr_bt_read(struct sr_bt_desc *desc,
2030 void *data, size_t len);
2031 SR_PRIV ssize_t sr_bt_write(struct sr_bt_desc *desc,
2032 const void *data, size_t len);
2034 SR_PRIV int sr_bt_start_notify(struct sr_bt_desc *desc);
2035 SR_PRIV int sr_bt_check_notify(struct sr_bt_desc *desc);
2038 /*--- ezusb.c ---------------------------------------------------------------*/
2040 #ifdef HAVE_LIBUSB_1_0
2041 SR_PRIV int ezusb_reset(struct libusb_device_handle *hdl, int set_clear);
2042 SR_PRIV int ezusb_install_firmware(struct sr_context *ctx, libusb_device_handle *hdl,
2044 SR_PRIV int ezusb_upload_firmware(struct sr_context *ctx, libusb_device *dev,
2045 int configuration, const char *name);
2048 /*--- usb.c -----------------------------------------------------------------*/
2050 #ifdef HAVE_LIBUSB_1_0
2051 SR_PRIV GSList *sr_usb_find(libusb_context *usb_ctx, const char *conn);
2052 SR_PRIV int sr_usb_open(libusb_context *usb_ctx, struct sr_usb_dev_inst *usb);
2053 SR_PRIV void sr_usb_close(struct sr_usb_dev_inst *usb);
2054 SR_PRIV int usb_source_add(struct sr_session *session, struct sr_context *ctx,
2055 int timeout, sr_receive_data_callback cb, void *cb_data);
2056 SR_PRIV int usb_source_remove(struct sr_session *session, struct sr_context *ctx);
2057 SR_PRIV int usb_get_port_path(libusb_device *dev, char *path, int path_len);
2058 SR_PRIV gboolean usb_match_manuf_prod(libusb_device *dev,
2059 const char *manufacturer, const char *product);
2062 /*--- binary_helpers.c ------------------------------------------------------*/
2064 /** Binary value type */
2065 enum binary_value_type {
2067 BVT_BE_UINT8 = BVT_UINT8,
2068 BVT_LE_UINT8 = BVT_UINT8,
2081 /** Binary value specification */
2082 struct binary_value_spec {
2083 /** Offset into binary blob */
2085 /** Data type to decode */
2086 enum binary_value_type type;
2087 /** Scale factor to get native units */
2091 /** Binary channel definition */
2092 struct binary_analog_channel {
2095 /** Binary value in data stream */
2096 struct binary_value_spec spec;
2097 /** Significant digits */
2099 /** Measured quantity */
2101 /** Measured unit */
2106 * Read extract a value from a binary blob.
2108 * @param out Pointer to output buffer.
2109 * @param spec Binary value specification
2110 * @param data Pointer to binary blob
2111 * @param length Size of binary blob
2112 * @return SR_OK on success, SR_ERR_* error code on failure.
2114 SR_PRIV int bv_get_value(float *out, const struct binary_value_spec *spec, const void *data, size_t length);
2117 * Send an analog channel packet based on a binary analog channel
2120 * @param sdi Device instance
2121 * @param ch Sigrok channel
2122 * @param spec Channel specification
2123 * @param data Pointer to binary blob
2124 * @param length Size of binary blob
2125 * @return SR_OK on success, SR_ERR_* error code on failure.
2127 SR_PRIV int bv_send_analog_channel(const struct sr_dev_inst *sdi, struct sr_channel *ch,
2128 const struct binary_analog_channel *spec, const void *data, size_t length);
2130 /*--- crc.c -----------------------------------------------------------------*/
2132 #define SR_CRC16_DEFAULT_INIT 0xffffU
2135 * Calculate a CRC16 checksum using the 0x8005 polynomial.
2137 * This CRC16 flavor is also known as CRC16-ANSI or CRC16-MODBUS.
2139 * @param crc Initial value (typically 0xffff)
2140 * @param buffer Input buffer
2141 * @param len Buffer length
2144 SR_PRIV uint16_t sr_crc16(uint16_t crc, const uint8_t *buffer, int len);
2146 /*--- modbus/modbus.c -------------------------------------------------------*/
2148 struct sr_modbus_dev_inst {
2152 GSList *(*scan)(int modbusaddr);
2153 int (*dev_inst_new)(void *priv, const char *resource,
2154 char **params, const char *serialcomm, int modbusaddr);
2155 int (*open)(void *priv);
2156 int (*source_add)(struct sr_session *session, void *priv, int events,
2157 int timeout, sr_receive_data_callback cb, void *cb_data);
2158 int (*source_remove)(struct sr_session *session, void *priv);
2159 int (*send)(void *priv, const uint8_t *buffer, int buffer_size);
2160 int (*read_begin)(void *priv, uint8_t *function_code);
2161 int (*read_data)(void *priv, uint8_t *buf, int maxlen);
2162 int (*read_end)(void *priv);
2163 int (*close)(void *priv);
2164 void (*free)(void *priv);
2165 unsigned int read_timeout_ms;
2169 SR_PRIV GSList *sr_modbus_scan(struct drv_context *drvc, GSList *options,
2170 struct sr_dev_inst *(*probe_device)(struct sr_modbus_dev_inst *modbus));
2171 SR_PRIV struct sr_modbus_dev_inst *modbus_dev_inst_new(const char *resource,
2172 const char *serialcomm, int modbusaddr);
2173 SR_PRIV int sr_modbus_open(struct sr_modbus_dev_inst *modbus);
2174 SR_PRIV int sr_modbus_source_add(struct sr_session *session,
2175 struct sr_modbus_dev_inst *modbus, int events, int timeout,
2176 sr_receive_data_callback cb, void *cb_data);
2177 SR_PRIV int sr_modbus_source_remove(struct sr_session *session,
2178 struct sr_modbus_dev_inst *modbus);
2179 SR_PRIV int sr_modbus_request(struct sr_modbus_dev_inst *modbus,
2180 uint8_t *request, int request_size);
2181 SR_PRIV int sr_modbus_reply(struct sr_modbus_dev_inst *modbus,
2182 uint8_t *reply, int reply_size);
2183 SR_PRIV int sr_modbus_request_reply(struct sr_modbus_dev_inst *modbus,
2184 uint8_t *request, int request_size,
2185 uint8_t *reply, int reply_size);
2186 SR_PRIV int sr_modbus_read_coils(struct sr_modbus_dev_inst *modbus,
2187 int address, int nb_coils, uint8_t *coils);
2188 SR_PRIV int sr_modbus_read_holding_registers(struct sr_modbus_dev_inst *modbus,
2189 int address, int nb_registers,
2190 uint16_t *registers);
2191 SR_PRIV int sr_modbus_write_coil(struct sr_modbus_dev_inst *modbus,
2192 int address, int value);
2193 SR_PRIV int sr_modbus_write_multiple_registers(struct sr_modbus_dev_inst*modbus,
2194 int address, int nb_registers,
2195 uint16_t *registers);
2196 SR_PRIV int sr_modbus_close(struct sr_modbus_dev_inst *modbus);
2197 SR_PRIV void sr_modbus_free(struct sr_modbus_dev_inst *modbus);
2199 /*--- dmm/es519xx.c ---------------------------------------------------------*/
2202 * All 11-byte es519xx chips repeat each block twice for each conversion cycle
2203 * so always read 2 blocks at a time.
2205 #define ES519XX_11B_PACKET_SIZE (11 * 2)
2206 #define ES519XX_14B_PACKET_SIZE 14
2208 struct es519xx_info {
2209 gboolean is_judge, is_voltage, is_auto, is_micro, is_current;
2210 gboolean is_milli, is_resistance, is_continuity, is_diode;
2211 gboolean is_frequency, is_rpm, is_capacitance, is_duty_cycle;
2212 gboolean is_temperature, is_celsius, is_fahrenheit;
2213 gboolean is_adp0, is_adp1, is_adp2, is_adp3;
2214 gboolean is_sign, is_batt, is_ol, is_pmax, is_pmin, is_apo;
2215 gboolean is_dc, is_ac, is_vahz, is_min, is_max, is_rel, is_hold;
2216 gboolean is_digit4, is_ul, is_vasel, is_vbar, is_lpf1, is_lpf0, is_rmr;
2219 gboolean alt_functions, fivedigits, clampmeter, selectable_lpf;
2223 SR_PRIV gboolean sr_es519xx_2400_11b_packet_valid(const uint8_t *buf);
2224 SR_PRIV int sr_es519xx_2400_11b_parse(const uint8_t *buf, float *floatval,
2225 struct sr_datafeed_analog *analog, void *info);
2226 SR_PRIV gboolean sr_es519xx_2400_11b_altfn_packet_valid(const uint8_t *buf);
2227 SR_PRIV int sr_es519xx_2400_11b_altfn_parse(const uint8_t *buf,
2228 float *floatval, struct sr_datafeed_analog *analog, void *info);
2229 SR_PRIV gboolean sr_es519xx_19200_11b_5digits_packet_valid(const uint8_t *buf);
2230 SR_PRIV int sr_es519xx_19200_11b_5digits_parse(const uint8_t *buf,
2231 float *floatval, struct sr_datafeed_analog *analog, void *info);
2232 SR_PRIV gboolean sr_es519xx_19200_11b_clamp_packet_valid(const uint8_t *buf);
2233 SR_PRIV int sr_es519xx_19200_11b_clamp_parse(const uint8_t *buf,
2234 float *floatval, struct sr_datafeed_analog *analog, void *info);
2235 SR_PRIV gboolean sr_es519xx_19200_11b_packet_valid(const uint8_t *buf);
2236 SR_PRIV int sr_es519xx_19200_11b_parse(const uint8_t *buf, float *floatval,
2237 struct sr_datafeed_analog *analog, void *info);
2238 SR_PRIV gboolean sr_es519xx_19200_14b_packet_valid(const uint8_t *buf);
2239 SR_PRIV int sr_es519xx_19200_14b_parse(const uint8_t *buf, float *floatval,
2240 struct sr_datafeed_analog *analog, void *info);
2241 SR_PRIV gboolean sr_es519xx_19200_14b_sel_lpf_packet_valid(const uint8_t *buf);
2242 SR_PRIV int sr_es519xx_19200_14b_sel_lpf_parse(const uint8_t *buf,
2243 float *floatval, struct sr_datafeed_analog *analog, void *info);
2245 /*--- dmm/fs9922.c ----------------------------------------------------------*/
2247 #define FS9922_PACKET_SIZE 14
2249 struct fs9922_info {
2250 gboolean is_auto, is_dc, is_ac, is_rel, is_hold, is_bpn, is_z1, is_z2;
2251 gboolean is_max, is_min, is_apo, is_bat, is_nano, is_z3, is_micro;
2252 gboolean is_milli, is_kilo, is_mega, is_beep, is_diode, is_percent;
2253 gboolean is_z4, is_volt, is_ampere, is_ohm, is_hfe, is_hertz, is_farad;
2254 gboolean is_celsius, is_fahrenheit;
2255 int bargraph_sign, bargraph_value;
2258 SR_PRIV gboolean sr_fs9922_packet_valid(const uint8_t *buf);
2259 SR_PRIV int sr_fs9922_parse(const uint8_t *buf, float *floatval,
2260 struct sr_datafeed_analog *analog, void *info);
2261 SR_PRIV void sr_fs9922_z1_diode(struct sr_datafeed_analog *analog, void *info);
2263 /*--- dmm/fs9721.c ----------------------------------------------------------*/
2265 #define FS9721_PACKET_SIZE 14
2267 struct fs9721_info {
2268 gboolean is_ac, is_dc, is_auto, is_rs232, is_micro, is_nano, is_kilo;
2269 gboolean is_diode, is_milli, is_percent, is_mega, is_beep, is_farad;
2270 gboolean is_ohm, is_rel, is_hold, is_ampere, is_volt, is_hz, is_bat;
2271 gboolean is_c2c1_11, is_c2c1_10, is_c2c1_01, is_c2c1_00, is_sign;
2274 SR_PRIV gboolean sr_fs9721_packet_valid(const uint8_t *buf);
2275 SR_PRIV int sr_fs9721_parse(const uint8_t *buf, float *floatval,
2276 struct sr_datafeed_analog *analog, void *info);
2277 SR_PRIV void sr_fs9721_00_temp_c(struct sr_datafeed_analog *analog, void *info);
2278 SR_PRIV void sr_fs9721_01_temp_c(struct sr_datafeed_analog *analog, void *info);
2279 SR_PRIV void sr_fs9721_10_temp_c(struct sr_datafeed_analog *analog, void *info);
2280 SR_PRIV void sr_fs9721_01_10_temp_f_c(struct sr_datafeed_analog *analog, void *info);
2281 SR_PRIV void sr_fs9721_max_c_min(struct sr_datafeed_analog *analog, void *info);
2283 /*--- dmm/mm38xr.c ---------------------------------------------------------*/
2285 #define METERMAN_38XR_PACKET_SIZE 15
2287 struct meterman_38xr_info { int dummy; };
2289 SR_PRIV gboolean meterman_38xr_packet_valid(const uint8_t *buf);
2290 SR_PRIV int meterman_38xr_parse(const uint8_t *buf, float *floatval,
2291 struct sr_datafeed_analog *analog, void *info);
2293 /*--- dmm/ms2115b.c ---------------------------------------------------------*/
2295 #define MS2115B_PACKET_SIZE 9
2297 enum ms2115b_display {
2298 MS2115B_DISPLAY_MAIN,
2299 MS2115B_DISPLAY_SUB,
2300 MS2115B_DISPLAY_COUNT,
2303 struct ms2115b_info {
2304 /* Selected channel. */
2306 gboolean is_ac, is_dc, is_auto;
2307 gboolean is_diode, is_beep, is_farad;
2308 gboolean is_ohm, is_ampere, is_volt, is_hz;
2309 gboolean is_duty_cycle, is_percent;
2312 extern SR_PRIV const char *ms2115b_channel_formats[];
2313 SR_PRIV gboolean sr_ms2115b_packet_valid(const uint8_t *buf);
2314 SR_PRIV int sr_ms2115b_parse(const uint8_t *buf, float *floatval,
2315 struct sr_datafeed_analog *analog, void *info);
2317 /*--- dmm/ms8250d.c ---------------------------------------------------------*/
2319 #define MS8250D_PACKET_SIZE 18
2321 struct ms8250d_info {
2322 gboolean is_ac, is_dc, is_auto, is_rs232, is_micro, is_nano, is_kilo;
2323 gboolean is_diode, is_milli, is_percent, is_mega, is_beep, is_farad;
2324 gboolean is_ohm, is_rel, is_hold, is_ampere, is_volt, is_hz, is_bat;
2325 gboolean is_ncv, is_min, is_max, is_sign, is_autotimer;
2328 SR_PRIV gboolean sr_ms8250d_packet_valid(const uint8_t *buf);
2329 SR_PRIV int sr_ms8250d_parse(const uint8_t *buf, float *floatval,
2330 struct sr_datafeed_analog *analog, void *info);
2332 /*--- dmm/dtm0660.c ---------------------------------------------------------*/
2334 #define DTM0660_PACKET_SIZE 15
2336 struct dtm0660_info {
2337 gboolean is_ac, is_dc, is_auto, is_rs232, is_micro, is_nano, is_kilo;
2338 gboolean is_diode, is_milli, is_percent, is_mega, is_beep, is_farad;
2339 gboolean is_ohm, is_rel, is_hold, is_ampere, is_volt, is_hz, is_bat;
2340 gboolean is_degf, is_degc, is_c2c1_01, is_c2c1_00, is_apo, is_min;
2341 gboolean is_minmax, is_max, is_sign;
2344 SR_PRIV gboolean sr_dtm0660_packet_valid(const uint8_t *buf);
2345 SR_PRIV int sr_dtm0660_parse(const uint8_t *buf, float *floatval,
2346 struct sr_datafeed_analog *analog, void *info);
2348 /*--- dmm/m2110.c -----------------------------------------------------------*/
2350 #define BBCGM_M2110_PACKET_SIZE 9
2352 /* Dummy info struct. The parser does not use it. */
2353 struct m2110_info { int dummy; };
2355 SR_PRIV gboolean sr_m2110_packet_valid(const uint8_t *buf);
2356 SR_PRIV int sr_m2110_parse(const uint8_t *buf, float *floatval,
2357 struct sr_datafeed_analog *analog, void *info);
2359 /*--- dmm/metex14.c ---------------------------------------------------------*/
2361 #define METEX14_PACKET_SIZE 14
2363 struct metex14_info {
2365 gboolean is_ac, is_dc, is_resistance, is_capacity, is_temperature;
2366 gboolean is_diode, is_frequency, is_ampere, is_volt, is_farad;
2367 gboolean is_hertz, is_ohm, is_celsius, is_fahrenheit, is_watt;
2368 gboolean is_pico, is_nano, is_micro, is_milli, is_kilo, is_mega;
2369 gboolean is_gain, is_decibel, is_power, is_decibel_mw, is_power_factor;
2370 gboolean is_hfe, is_unitless, is_logic, is_min, is_max, is_avg;
2373 #ifdef HAVE_SERIAL_COMM
2374 SR_PRIV int sr_metex14_packet_request(struct sr_serial_dev_inst *serial);
2376 SR_PRIV gboolean sr_metex14_packet_valid(const uint8_t *buf);
2377 SR_PRIV int sr_metex14_parse(const uint8_t *buf, float *floatval,
2378 struct sr_datafeed_analog *analog, void *info);
2379 SR_PRIV gboolean sr_metex14_4packets_valid(const uint8_t *buf);
2380 SR_PRIV int sr_metex14_4packets_parse(const uint8_t *buf, float *floatval,
2381 struct sr_datafeed_analog *analog, void *info);
2383 /*--- dmm/rs9lcd.c ----------------------------------------------------------*/
2385 #define RS9LCD_PACKET_SIZE 9
2387 /* Dummy info struct. The parser does not use it. */
2388 struct rs9lcd_info { int dummy; };
2390 SR_PRIV gboolean sr_rs9lcd_packet_valid(const uint8_t *buf);
2391 SR_PRIV int sr_rs9lcd_parse(const uint8_t *buf, float *floatval,
2392 struct sr_datafeed_analog *analog, void *info);
2394 /*--- dmm/bm25x.c -----------------------------------------------------------*/
2396 #define BRYMEN_BM25X_PACKET_SIZE 15
2398 /* Dummy info struct. The parser does not use it. */
2399 struct bm25x_info { int dummy; };
2401 SR_PRIV gboolean sr_brymen_bm25x_packet_valid(const uint8_t *buf);
2402 SR_PRIV int sr_brymen_bm25x_parse(const uint8_t *buf, float *floatval,
2403 struct sr_datafeed_analog *analog, void *info);
2405 /*--- dmm/bm52x.c -----------------------------------------------------------*/
2407 #define BRYMEN_BM52X_PACKET_SIZE 24
2408 #define BRYMEN_BM52X_DISPLAY_COUNT 2
2410 struct brymen_bm52x_info { size_t ch_idx; };
2412 #ifdef HAVE_SERIAL_COMM
2413 SR_PRIV int sr_brymen_bm52x_packet_request(struct sr_serial_dev_inst *serial);
2414 SR_PRIV int sr_brymen_bm82x_packet_request(struct sr_serial_dev_inst *serial);
2416 SR_PRIV gboolean sr_brymen_bm52x_packet_valid(const uint8_t *buf);
2417 SR_PRIV gboolean sr_brymen_bm82x_packet_valid(const uint8_t *buf);
2418 /* BM520s and BM820s protocols are similar, the parse routine is shared. */
2419 SR_PRIV int sr_brymen_bm52x_parse(const uint8_t *buf, float *floatval,
2420 struct sr_datafeed_analog *analog, void *info);
2422 struct brymen_bm52x_state;
2424 SR_PRIV void *brymen_bm52x_state_init(void);
2425 SR_PRIV void brymen_bm52x_state_free(void *state);
2426 SR_PRIV int brymen_bm52x_config_get(void *state, uint32_t key, GVariant **data,
2427 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg);
2428 SR_PRIV int brymen_bm52x_config_set(void *state, uint32_t key, GVariant *data,
2429 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg);
2430 SR_PRIV int brymen_bm52x_config_list(void *state, uint32_t key, GVariant **data,
2431 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg);
2432 SR_PRIV int brymen_bm52x_acquire_start(void *state,
2433 const struct sr_dev_inst *sdi,
2434 sr_receive_data_callback *cb, void **cb_data);
2436 /*--- dmm/bm85x.c -----------------------------------------------------------*/
2438 #define BRYMEN_BM85x_PACKET_SIZE_MIN 4
2440 struct brymen_bm85x_info { int dummy; };
2442 #ifdef HAVE_SERIAL_COMM
2443 SR_PRIV int brymen_bm85x_after_open(struct sr_serial_dev_inst *serial);
2444 SR_PRIV int brymen_bm85x_packet_request(struct sr_serial_dev_inst *serial);
2446 SR_PRIV gboolean brymen_bm85x_packet_valid(void *state,
2447 const uint8_t *buf, size_t len, size_t *pkt_len);
2448 SR_PRIV int brymen_bm85x_parse(void *state, const uint8_t *buf, size_t len,
2449 double *floatval, struct sr_datafeed_analog *analog, void *info);
2451 /*--- dmm/bm86x.c -----------------------------------------------------------*/
2453 #define BRYMEN_BM86X_PACKET_SIZE 24
2454 #define BRYMEN_BM86X_DISPLAY_COUNT 2
2456 struct brymen_bm86x_info { size_t ch_idx; };
2458 #ifdef HAVE_SERIAL_COMM
2459 SR_PRIV int sr_brymen_bm86x_packet_request(struct sr_serial_dev_inst *serial);
2461 SR_PRIV gboolean sr_brymen_bm86x_packet_valid(const uint8_t *buf);
2462 SR_PRIV int sr_brymen_bm86x_parse(const uint8_t *buf, float *floatval,
2463 struct sr_datafeed_analog *analog, void *info);
2465 /*--- dmm/ut71x.c -----------------------------------------------------------*/
2467 #define UT71X_PACKET_SIZE 11
2470 gboolean is_voltage, is_resistance, is_capacitance, is_temperature;
2471 gboolean is_celsius, is_fahrenheit, is_current, is_continuity;
2472 gboolean is_diode, is_frequency, is_duty_cycle, is_dc, is_ac;
2473 gboolean is_auto, is_manual, is_sign, is_power, is_loop_current;
2476 SR_PRIV gboolean sr_ut71x_packet_valid(const uint8_t *buf);
2477 SR_PRIV int sr_ut71x_parse(const uint8_t *buf, float *floatval,
2478 struct sr_datafeed_analog *analog, void *info);
2480 /*--- dmm/vc870.c -----------------------------------------------------------*/
2482 #define VC870_PACKET_SIZE 23
2485 gboolean is_voltage, is_dc, is_ac, is_temperature, is_resistance;
2486 gboolean is_continuity, is_capacitance, is_diode, is_loop_current;
2487 gboolean is_current, is_micro, is_milli, is_power;
2488 gboolean is_power_factor_freq, is_power_apparent_power, is_v_a_rms_value;
2489 gboolean is_sign2, is_sign1, is_batt, is_ol1, is_max, is_min;
2490 gboolean is_maxmin, is_rel, is_ol2, is_open, is_manu, is_hold;
2491 gboolean is_light, is_usb, is_warning, is_auto_power, is_misplug_warn;
2492 gboolean is_lo, is_hi, is_open2;
2494 gboolean is_frequency, is_dual_display, is_auto;
2497 SR_PRIV gboolean sr_vc870_packet_valid(const uint8_t *buf);
2498 SR_PRIV int sr_vc870_parse(const uint8_t *buf, float *floatval,
2499 struct sr_datafeed_analog *analog, void *info);
2501 /*--- dmm/vc96.c ------------------------------------------------------------*/
2503 #define VC96_PACKET_SIZE 13
2507 gboolean is_ac, is_dc, is_resistance, is_diode, is_ampere, is_volt;
2508 gboolean is_ohm, is_micro, is_milli, is_kilo, is_mega, is_hfe;
2509 gboolean is_unitless;
2512 SR_PRIV gboolean sr_vc96_packet_valid(const uint8_t *buf);
2513 SR_PRIV int sr_vc96_parse(const uint8_t *buf, float *floatval,
2514 struct sr_datafeed_analog *analog, void *info);
2516 /*--- lcr/es51919.c ---------------------------------------------------------*/
2518 /* Acquisition details which apply to all supported serial-lcr devices. */
2519 struct lcr_parse_info {
2521 uint64_t output_freq;
2522 const char *circuit_model;
2525 #define ES51919_PACKET_SIZE 17
2526 #define ES51919_CHANNEL_COUNT 2
2527 #define ES51919_COMM_PARAM "9600/8n1/rts=1/dtr=1"
2529 SR_PRIV int es51919_config_get(uint32_t key, GVariant **data,
2530 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg);
2531 SR_PRIV int es51919_config_set(uint32_t key, GVariant *data,
2532 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg);
2533 SR_PRIV int es51919_config_list(uint32_t key, GVariant **data,
2534 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg);
2535 SR_PRIV gboolean es51919_packet_valid(const uint8_t *pkt);
2536 SR_PRIV int es51919_packet_parse(const uint8_t *pkt, float *floatval,
2537 struct sr_datafeed_analog *analog, void *info);
2539 /*--- lcr/vc4080.c ----------------------------------------------------------*/
2541 /* Note: Also uses 'struct lcr_parse_info' from es51919 above. */
2543 #define VC4080_PACKET_SIZE 39
2544 #define VC4080_COMM_PARAM "1200/8n1"
2545 #define VC4080_WITH_DQ_CHANS 0 /* Enable separate D/Q channels? */
2547 enum vc4080_display {
2548 VC4080_DISPLAY_PRIMARY,
2549 VC4080_DISPLAY_SECONDARY,
2550 #if VC4080_WITH_DQ_CHANS
2551 VC4080_DISPLAY_D_VALUE,
2552 VC4080_DISPLAY_Q_VALUE,
2554 VC4080_CHANNEL_COUNT,
2557 extern SR_PRIV const char *vc4080_channel_formats[VC4080_CHANNEL_COUNT];
2559 SR_PRIV int vc4080_config_list(uint32_t key, GVariant **data,
2560 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg);
2561 SR_PRIV int vc4080_packet_request(struct sr_serial_dev_inst *serial);
2562 SR_PRIV gboolean vc4080_packet_valid(const uint8_t *pkt);
2563 SR_PRIV int vc4080_packet_parse(const uint8_t *pkt, float *floatval,
2564 struct sr_datafeed_analog *analog, void *info);
2566 /*--- dmm/ut372.c -----------------------------------------------------------*/
2568 #define UT372_PACKET_SIZE 27
2574 SR_PRIV gboolean sr_ut372_packet_valid(const uint8_t *buf);
2575 SR_PRIV int sr_ut372_parse(const uint8_t *buf, float *floatval,
2576 struct sr_datafeed_analog *analog, void *info);
2578 /*--- dmm/asycii.c ----------------------------------------------------------*/
2580 #define ASYCII_PACKET_SIZE 16
2582 struct asycii_info {
2583 gboolean is_ac, is_dc, is_ac_and_dc;
2584 gboolean is_resistance, is_capacitance, is_diode, is_gain;
2585 gboolean is_frequency, is_duty_cycle, is_duty_pos, is_duty_neg;
2586 gboolean is_pulse_width, is_period_pos, is_period_neg;
2587 gboolean is_pulse_count, is_count_pos, is_count_neg;
2588 gboolean is_ampere, is_volt, is_volt_ampere, is_farad, is_ohm;
2589 gboolean is_hertz, is_percent, is_seconds, is_decibel;
2590 gboolean is_pico, is_nano, is_micro, is_milli, is_kilo, is_mega;
2591 gboolean is_unitless;
2592 gboolean is_peak_min, is_peak_max;
2593 gboolean is_invalid;
2596 #ifdef HAVE_SERIAL_COMM
2597 SR_PRIV int sr_asycii_packet_request(struct sr_serial_dev_inst *serial);
2599 SR_PRIV gboolean sr_asycii_packet_valid(const uint8_t *buf);
2600 SR_PRIV int sr_asycii_parse(const uint8_t *buf, float *floatval,
2601 struct sr_datafeed_analog *analog, void *info);
2603 /*--- dmm/eev121gw.c --------------------------------------------------------*/
2605 #define EEV121GW_PACKET_SIZE 19
2607 enum eev121gw_display {
2608 EEV121GW_DISPLAY_MAIN,
2609 EEV121GW_DISPLAY_SUB,
2610 EEV121GW_DISPLAY_BAR,
2611 EEV121GW_DISPLAY_COUNT,
2614 struct eev121gw_info {
2615 /* Selected channel. */
2618 * Measured value, number and sign/overflow flags, scale factor
2619 * and significant digits.
2621 uint32_t uint_value;
2622 gboolean is_ofl, is_neg;
2624 /* Currently active mode (meter's function). */
2625 gboolean is_ac, is_dc, is_voltage, is_current, is_power, is_gain;
2626 gboolean is_resistance, is_capacitance, is_diode, is_temperature;
2627 gboolean is_continuity, is_frequency, is_period, is_duty_cycle;
2628 /* Quantities associated with mode/function. */
2629 gboolean is_ampere, is_volt, is_volt_ampere, is_dbm;
2630 gboolean is_ohm, is_farad, is_celsius, is_fahrenheit;
2631 gboolean is_hertz, is_seconds, is_percent, is_loop_current;
2632 gboolean is_unitless, is_logic;
2633 /* Other indicators. */
2634 gboolean is_min, is_max, is_avg, is_1ms_peak, is_rel, is_hold;
2635 gboolean is_low_pass, is_mem, is_bt, is_auto_range, is_test;
2636 gboolean is_auto_poweroff, is_low_batt;
2639 extern SR_PRIV const char *eev121gw_channel_formats[];
2640 SR_PRIV gboolean sr_eev121gw_packet_valid(const uint8_t *buf);
2641 SR_PRIV int sr_eev121gw_3displays_parse(const uint8_t *buf, float *floatval,
2642 struct sr_datafeed_analog *analog, void *info);
2644 /*--- scale/kern.c ----------------------------------------------------------*/
2647 gboolean is_gram, is_carat, is_ounce, is_pound, is_troy_ounce;
2648 gboolean is_pennyweight, is_grain, is_tael, is_momme, is_tola;
2649 gboolean is_percentage, is_piece, is_unstable, is_stable, is_error;
2653 SR_PRIV gboolean sr_kern_packet_valid(const uint8_t *buf);
2654 SR_PRIV int sr_kern_parse(const uint8_t *buf, float *floatval,
2655 struct sr_datafeed_analog *analog, void *info);
2657 /*--- sw_limits.c -----------------------------------------------------------*/
2659 struct sr_sw_limits {
2660 uint64_t limit_samples;
2661 uint64_t limit_frames;
2662 uint64_t limit_msec;
2663 uint64_t samples_read;
2664 uint64_t frames_read;
2665 uint64_t start_time;
2668 SR_PRIV int sr_sw_limits_config_get(const struct sr_sw_limits *limits, uint32_t key,
2670 SR_PRIV int sr_sw_limits_config_set(struct sr_sw_limits *limits, uint32_t key,
2672 SR_PRIV void sr_sw_limits_acquisition_start(struct sr_sw_limits *limits);
2673 SR_PRIV gboolean sr_sw_limits_check(struct sr_sw_limits *limits);
2674 SR_PRIV void sr_sw_limits_update_samples_read(struct sr_sw_limits *limits,
2675 uint64_t samples_read);
2676 SR_PRIV void sr_sw_limits_update_frames_read(struct sr_sw_limits *limits,
2677 uint64_t frames_read);
2678 SR_PRIV void sr_sw_limits_init(struct sr_sw_limits *limits);
2680 /*--- feed_queue.h ----------------------------------------------------------*/
2682 struct feed_queue_logic;
2683 struct feed_queue_analog;
2685 SR_API struct feed_queue_logic *feed_queue_logic_alloc(
2686 struct sr_dev_inst *sdi,
2687 size_t sample_count, size_t unit_size);
2688 SR_API int feed_queue_logic_submit(struct feed_queue_logic *q,
2689 const uint8_t *data, size_t count);
2690 SR_API int feed_queue_logic_flush(struct feed_queue_logic *q);
2691 SR_API void feed_queue_logic_free(struct feed_queue_logic *q);
2693 SR_API struct feed_queue_analog *feed_queue_analog_alloc(
2694 struct sr_dev_inst *sdi,
2695 size_t sample_count, int digits, struct sr_channel *ch);
2696 SR_API int feed_queue_analog_submit(struct feed_queue_analog *q,
2697 float data, size_t count);
2698 SR_API int feed_queue_analog_flush(struct feed_queue_analog *q);
2699 SR_API void feed_queue_analog_free(struct feed_queue_analog *q);