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 64 bits unsigned integer to memory stored as big endian.
480 * @param p a pointer to the output memory
481 * @param x the input unsigned integer
483 static inline void write_u64be(uint8_t *p, uint64_t x)
485 p[7] = x & 0xff; x >>= 8;
486 p[6] = x & 0xff; x >>= 8;
487 p[5] = x & 0xff; x >>= 8;
488 p[4] = x & 0xff; x >>= 8;
489 p[3] = x & 0xff; x >>= 8;
490 p[2] = x & 0xff; x >>= 8;
491 p[1] = x & 0xff; x >>= 8;
492 p[0] = x & 0xff; x >>= 8;
496 * Write a 64 bits unsigned integer to memory stored as little endian.
497 * @param p a pointer to the output memory
498 * @param x the input unsigned integer
500 static inline void write_u64le(uint8_t *p, uint64_t x)
502 p[0] = x & 0xff; x >>= 8;
503 p[1] = x & 0xff; x >>= 8;
504 p[2] = x & 0xff; x >>= 8;
505 p[3] = x & 0xff; x >>= 8;
506 p[4] = x & 0xff; x >>= 8;
507 p[5] = x & 0xff; x >>= 8;
508 p[6] = x & 0xff; x >>= 8;
509 p[7] = x & 0xff; x >>= 8;
511 #define WL64(p, x) write_u64le((uint8_t *)(p), (uint64_t)(x))
514 * Write a 32 bits float to memory stored as big endian.
515 * @param p a pointer to the output memory
516 * @param x the input float
518 static inline void write_fltbe(uint8_t *p, float x)
520 union { uint32_t u; float f; } u;
524 #define WBFL(p, x) write_fltbe((uint8_t *)(p), (x))
527 * Write a 32 bits float to memory stored as little endian.
528 * @param p a pointer to the output memory
529 * @param x the input float
531 static inline void write_fltle(uint8_t *p, float x)
533 union { uint32_t u; float f; } u;
537 #define WLFL(p, x) write_fltle((uint8_t *)(p), float (x))
540 * Write a 64 bits float to memory stored as little endian.
541 * @param p a pointer to the output memory
542 * @param x the input floating point value
544 static inline void write_dblle(uint8_t *p, double x)
546 union { uint64_t u; double f; } u;
550 #define WLDB(p, x) write_dblle((uint8_t *)(p), float (x))
552 /* Endianess conversion helpers with read/write position increment. */
555 * Read unsigned 8bit integer from raw memory, increment read position.
556 * @param[in, out] p Pointer into byte stream.
557 * @return Retrieved integer value, unsigned.
559 static inline uint8_t read_u8_inc(const uint8_t **p)
572 * Read signed 8bit integer from raw memory, increment read position.
573 * @param[in, out] p Pointer into byte stream.
574 * @return Retrieved integer value, signed.
576 static inline int8_t read_i8_inc(const uint8_t **p)
589 * Read unsigned 16bit integer from raw memory (big endian format), increment read position.
590 * @param[in, out] p Pointer into byte stream.
591 * @return Retrieved integer value, unsigned.
593 static inline uint16_t read_u16be_inc(const uint8_t **p)
606 * Read unsigned 16bit integer from raw memory (little endian format), increment read position.
607 * @param[in, out] p Pointer into byte stream.
608 * @return Retrieved integer value, unsigned.
610 static inline uint16_t read_u16le_inc(const uint8_t **p)
623 * Read signed 16bit integer from raw memory (big endian format), increment read position.
624 * @param[in, out] p Pointer into byte stream.
625 * @return Retrieved integer value, signed.
627 static inline int16_t read_i16be_inc(const uint8_t **p)
640 * Read signed 16bit integer from raw memory (little endian format), increment read position.
641 * @param[in, out] p Pointer into byte stream.
642 * @return Retrieved integer value, signed.
644 static inline int16_t read_i16le_inc(const uint8_t **p)
657 * Read unsigned 24bit integer from raw memory (little endian format), increment read position.
658 * @param[in, out] p Pointer into byte stream.
659 * @return Retrieved integer value, unsigned.
661 static inline uint32_t read_u24le_inc(const uint8_t **p)
668 *p += 3 * sizeof(uint8_t);
674 * Read unsigned 32bit integer from raw memory (big endian format), increment read position.
675 * @param[in, out] p Pointer into byte stream.
676 * @return Retrieved integer value, unsigned.
678 static inline uint32_t read_u32be_inc(const uint8_t **p)
691 * Read unsigned 32bit integer from raw memory (little endian format), increment read position.
692 * @param[in, out] p Pointer into byte stream.
693 * @return Retrieved integer value, unsigned.
695 static inline uint32_t read_u32le_inc(const uint8_t **p)
708 * Read signed 32bit integer from raw memory (big endian format), increment read position.
709 * @param[in, out] p Pointer into byte stream.
710 * @return Retrieved integer value, signed.
712 static inline int32_t read_i32be_inc(const uint8_t **p)
725 * Read signed 32bit integer from raw memory (little endian format), increment read position.
726 * @param[in, out] p Pointer into byte stream.
727 * @return Retrieved integer value, signed.
729 static inline int32_t read_i32le_inc(const uint8_t **p)
742 * Read unsigned 64bit integer from raw memory (big endian format), increment read position.
743 * @param[in, out] p Pointer into byte stream.
744 * @return Retrieved integer value, unsigned.
746 static inline uint64_t read_u64be_inc(const uint8_t **p)
759 * Read unsigned 64bit integer from raw memory (little endian format), increment read position.
760 * @param[in, out] p Pointer into byte stream.
761 * @return Retrieved integer value, unsigned.
763 static inline uint64_t read_u64le_inc(const uint8_t **p)
776 * Read 32bit float from raw memory (big endian format), increment read position.
777 * @param[in, out] p Pointer into byte stream.
778 * @return Retrieved float value.
780 static inline float read_fltbe_inc(const uint8_t **p)
793 * Read 32bit float from raw memory (little endian format), increment read position.
794 * @param[in, out] p Pointer into byte stream.
795 * @return Retrieved float value.
797 static inline float read_fltle_inc(const uint8_t **p)
810 * Read 64bit float from raw memory (big endian format), increment read position.
811 * @param[in, out] p Pointer into byte stream.
812 * @return Retrieved float value.
814 static inline double read_dblbe_inc(const uint8_t **p)
827 * Read 64bit float from raw memory (little endian format), increment read position.
828 * @param[in, out] p Pointer into byte stream.
829 * @return Retrieved float value.
831 static inline double read_dblle_inc(const uint8_t **p)
844 * Write unsigned 8bit integer to raw memory, increment write position.
845 * @param[in, out] p Pointer into byte stream.
846 * @param[in] x Value to write.
848 static inline void write_u8_inc(uint8_t **p, uint8_t x)
857 * Write unsigned 16bit big endian integer to raw memory, increment write position.
858 * @param[in, out] p Pointer into byte stream.
859 * @param[in] x Value to write.
861 static inline void write_u16be_inc(uint8_t **p, uint16_t x)
870 * Write unsigned 16bit little endian integer to raw memory, increment write position.
871 * @param[in, out] p Pointer into byte stream.
872 * @param[in] x Value to write.
874 static inline void write_u16le_inc(uint8_t **p, uint16_t x)
883 * Write unsigned 32bit big endian integer to raw memory, increment write position.
884 * @param[in, out] p Pointer into byte stream.
885 * @param[in] x Value to write.
887 static inline void write_u32be_inc(uint8_t **p, uint32_t x)
896 * Write unsigned 32bit little endian integer to raw memory, increment write position.
897 * @param[in, out] p Pointer into byte stream.
898 * @param[in] x Value to write.
900 static inline void write_u32le_inc(uint8_t **p, uint32_t x)
909 * Write unsigned 64bit little endian integer to raw memory, increment write position.
910 * @param[in, out] p Pointer into byte stream.
911 * @param[in] x Value to write.
913 static inline void write_u64le_inc(uint8_t **p, uint64_t x)
922 * Write single precision little endian float to raw memory, increment write position.
923 * @param[in, out] p Pointer into byte stream.
924 * @param[in] x Value to write.
926 static inline void write_fltle_inc(uint8_t **p, float x)
935 * Write double precision little endian float to raw memory, increment write position.
936 * @param[in, out] p Pointer into byte stream.
937 * @param[in] x Value to write.
939 static inline void write_dblle_inc(uint8_t **p, double x)
947 /* Portability fixes for FreeBSD. */
949 #define LIBUSB_CLASS_APPLICATION 0xfe
950 #define libusb_has_capability(x) 0
951 #define libusb_handle_events_timeout_completed(ctx, tv, c) \
952 libusb_handle_events_timeout(ctx, tv)
955 /* Static definitions of structs ending with an all-zero entry are a
956 * problem when compiling with -Wmissing-field-initializers: GCC
957 * suppresses the warning only with { 0 }, clang wants { } */
961 #define ALL_ZERO { 0 }
965 #define SR_DRIVER_LIST_SECTION "__DATA,__sr_driver_list"
967 #define SR_DRIVER_LIST_SECTION "__sr_driver_list"
971 * Register a list of hardware drivers.
973 * This macro can be used to register multiple hardware drivers to the library.
974 * This is useful when a driver supports multiple similar but slightly
975 * different devices that require different sr_dev_driver struct definitions.
977 * For registering only a single driver see SR_REGISTER_DEV_DRIVER().
981 * #define MY_DRIVER(_name) \
982 * &(struct sr_dev_driver){ \
987 * SR_REGISTER_DEV_DRIVER_LIST(my_driver_infos,
988 * MY_DRIVER("driver 1"),
989 * MY_DRIVER("driver 2"),
994 * @param name Name to use for the driver list identifier.
995 * @param ... Comma separated list of pointers to sr_dev_driver structs.
997 #define SR_REGISTER_DEV_DRIVER_LIST(name, ...) \
998 static const struct sr_dev_driver *name[] \
999 __attribute__((section (SR_DRIVER_LIST_SECTION), used, \
1000 aligned(sizeof(struct sr_dev_driver *)))) \
1006 * Register a hardware driver.
1008 * This macro is used to register a hardware driver with the library. It has
1009 * to be used in order to make the driver accessible to applications using the
1012 * The macro invocation should be placed directly under the struct
1013 * sr_dev_driver definition.
1017 * static struct sr_dev_driver driver_info = {
1021 * SR_REGISTER_DEV_DRIVER(driver_info);
1024 * @param name Identifier name of sr_dev_driver struct to register.
1026 #define SR_REGISTER_DEV_DRIVER(name) \
1027 SR_REGISTER_DEV_DRIVER_LIST(name##_list, &name);
1029 SR_API void sr_drivers_init(struct sr_context *context);
1032 struct sr_dev_driver **driver_list;
1033 #ifdef HAVE_LIBUSB_1_0
1034 libusb_context *libusb_ctx;
1036 sr_resource_open_callback resource_open_cb;
1037 sr_resource_close_callback resource_close_cb;
1038 sr_resource_read_callback resource_read_cb;
1039 void *resource_cb_data;
1042 /** Input module metadata keys. */
1043 enum sr_input_meta_keys {
1044 /** The input filename, if there is one. */
1045 SR_INPUT_META_FILENAME = 0x01,
1046 /** The input file's size in bytes. */
1047 SR_INPUT_META_FILESIZE = 0x02,
1048 /** The first 128 bytes of the file, provided as a GString. */
1049 SR_INPUT_META_HEADER = 0x04,
1051 /** The module cannot identify a file without this metadata. */
1052 SR_INPUT_META_REQUIRED = 0x80,
1055 /** Input (file) module struct. */
1058 * A pointer to this input module's 'struct sr_input_module'.
1060 const struct sr_input_module *module;
1062 struct sr_dev_inst *sdi;
1067 /** Input (file) module driver. */
1068 struct sr_input_module {
1070 * A unique ID for this input module, suitable for use in command-line
1071 * clients, [a-z0-9-]. Must not be NULL.
1076 * A unique name for this input module, suitable for use in GUI
1077 * clients, can contain UTF-8. Must not be NULL.
1082 * A short description of the input module. Must not be NULL.
1084 * This can be displayed by frontends, e.g. when selecting the input
1085 * module for saving a file.
1090 * A NULL terminated array of strings containing a list of file name
1091 * extensions typical for the input file format, or NULL if there is
1092 * no typical extension for this file format.
1094 const char *const *exts;
1097 * Zero-terminated list of metadata items the module needs to be able
1098 * to identify an input stream. Can be all-zero, if the module cannot
1099 * identify streams at all, i.e. has to be forced into use.
1101 * Each item is one of:
1102 * SR_INPUT_META_FILENAME
1103 * SR_INPUT_META_FILESIZE
1104 * SR_INPUT_META_HEADER
1106 * If the high bit (SR_INPUT META_REQUIRED) is set, the module cannot
1107 * identify a stream without the given metadata.
1109 const uint8_t metadata[8];
1112 * Returns a NULL-terminated list of options this module can take.
1113 * Can be NULL, if the module has no options.
1115 const struct sr_option *(*options) (void);
1118 * Check if this input module can load and parse the specified stream.
1120 * @param[in] metadata Metadata the module can use to identify the stream.
1121 * @param[out] confidence "Strength" of the detection.
1122 * Specialized handlers can take precedence over generic/basic support.
1124 * @retval SR_OK This module knows the format.
1125 * @retval SR_ERR_NA There wasn't enough data for this module to
1126 * positively identify the format.
1127 * @retval SR_ERR_DATA This module knows the format, but cannot handle
1128 * it. This means the stream is either corrupt, or indicates a
1129 * feature that the module does not support.
1130 * @retval SR_ERR This module does not know the format.
1132 * Lower numeric values of 'confidence' mean that the input module
1133 * stronger believes in its capability to handle this specific format.
1134 * This way, multiple input modules can claim support for a format,
1135 * and the application can pick the best match, or try fallbacks
1136 * in case of errors. This approach also copes with formats that
1137 * are unreliable to detect in the absence of magic signatures.
1139 int (*format_match) (GHashTable *metadata, unsigned int *confidence);
1142 * Initialize the input module.
1144 * @retval SR_OK Success
1145 * @retval other Negative error code.
1147 int (*init) (struct sr_input *in, GHashTable *options);
1150 * Send data to the specified input instance.
1152 * When an input module instance is created with sr_input_new(), this
1153 * function is used to feed data to the instance.
1155 * As enough data gets fed into this function to completely populate
1156 * the device instance associated with this input instance, this is
1157 * guaranteed to return the moment it's ready. This gives the caller
1158 * the chance to examine the device instance, attach session callbacks
1161 * @retval SR_OK Success
1162 * @retval other Negative error code.
1164 int (*receive) (struct sr_input *in, GString *buf);
1167 * Signal the input module no more data will come.
1169 * This will cause the module to process any data it may have buffered.
1170 * The SR_DF_END packet will also typically be sent at this time.
1172 int (*end) (struct sr_input *in);
1175 * Reset the input module's input handling structures.
1177 * Causes the input module to reset its internal state so that we can
1178 * re-send the input data from the beginning without having to
1179 * re-create the entire input module.
1181 * @retval SR_OK Success.
1182 * @retval other Negative error code.
1184 int (*reset) (struct sr_input *in);
1187 * This function is called after the caller is finished using
1188 * the input module, and can be used to free any internal
1189 * resources the module may keep.
1191 * This function is optional.
1193 * @retval SR_OK Success
1194 * @retval other Negative error code.
1196 void (*cleanup) (struct sr_input *in);
1199 /** Output module instance. */
1201 /** A pointer to this output's module. */
1202 const struct sr_output_module *module;
1205 * The device for which this output module is creating output. This
1206 * can be used by the module to find out channel names and numbers.
1208 const struct sr_dev_inst *sdi;
1211 * The name of the file that the data should be written to.
1213 const char *filename;
1216 * A generic pointer which can be used by the module to keep internal
1217 * state between calls into its callback functions.
1219 * For example, the module might store a pointer to a chunk of output
1220 * there, and only flush it when it reaches a certain size.
1225 /** Output module driver. */
1226 struct sr_output_module {
1228 * A unique ID for this output module, suitable for use in command-line
1229 * clients, [a-z0-9-]. Must not be NULL.
1234 * A unique name for this output module, suitable for use in GUI
1235 * clients, can contain UTF-8. Must not be NULL.
1240 * A short description of the output module. Must not be NULL.
1242 * This can be displayed by frontends, e.g. when selecting the output
1243 * module for saving a file.
1248 * A NULL terminated array of strings containing a list of file name
1249 * extensions typical for the input file format, or NULL if there is
1250 * no typical extension for this file format.
1252 const char *const *exts;
1255 * Bitfield containing flags that describe certain properties
1256 * this output module may or may not have.
1257 * @see sr_output_flags
1259 const uint64_t flags;
1262 * Returns a NULL-terminated list of options this module can take.
1263 * Can be NULL, if the module has no options.
1265 const struct sr_option *(*options) (void);
1268 * This function is called once, at the beginning of an output stream.
1270 * The device struct will be available in the output struct passed in,
1271 * as well as the param field -- which may be NULL or an empty string,
1272 * if no parameter was passed.
1274 * The module can use this to initialize itself, create a struct for
1275 * keeping state and storing it in the <code>internal</code> field.
1277 * @param o Pointer to the respective 'struct sr_output'.
1279 * @retval SR_OK Success
1280 * @retval other Negative error code.
1282 int (*init) (struct sr_output *o, GHashTable *options);
1285 * This function is passed a copy of every packet in the data feed.
1286 * Any output generated by the output module in response to the
1287 * packet should be returned in a newly allocated GString
1288 * <code>out</code>, which will be freed by the caller.
1290 * Packets not of interest to the output module can just be ignored,
1291 * and the <code>out</code> parameter set to NULL.
1293 * @param o Pointer to the respective 'struct sr_output'.
1294 * @param sdi The device instance that generated the packet.
1295 * @param packet The complete packet.
1296 * @param out A pointer where a GString * should be stored if
1297 * the module generates output, or NULL if not.
1299 * @retval SR_OK Success
1300 * @retval other Negative error code.
1302 int (*receive) (const struct sr_output *o,
1303 const struct sr_datafeed_packet *packet, GString **out);
1306 * This function is called after the caller is finished using
1307 * the output module, and can be used to free any internal
1308 * resources the module may keep.
1310 * @retval SR_OK Success
1311 * @retval other Negative error code.
1313 int (*cleanup) (struct sr_output *o);
1316 /** Transform module instance. */
1317 struct sr_transform {
1318 /** A pointer to this transform's module. */
1319 const struct sr_transform_module *module;
1322 * The device for which this transform module is used. This
1323 * can be used by the module to find out channel names and numbers.
1325 const struct sr_dev_inst *sdi;
1328 * A generic pointer which can be used by the module to keep internal
1329 * state between calls into its callback functions.
1334 struct sr_transform_module {
1336 * A unique ID for this transform module, suitable for use in
1337 * command-line clients, [a-z0-9-]. Must not be NULL.
1342 * A unique name for this transform module, suitable for use in GUI
1343 * clients, can contain UTF-8. Must not be NULL.
1348 * A short description of the transform module. Must not be NULL.
1350 * This can be displayed by frontends, e.g. when selecting
1351 * which transform module(s) to add.
1356 * Returns a NULL-terminated list of options this transform module
1357 * can take. Can be NULL, if the transform module has no options.
1359 const struct sr_option *(*options) (void);
1362 * This function is called once, at the beginning of a stream.
1364 * @param t Pointer to the respective 'struct sr_transform'.
1365 * @param options Hash table of options for this transform module.
1366 * Can be NULL if no options are to be used.
1368 * @retval SR_OK Success
1369 * @retval other Negative error code.
1371 int (*init) (struct sr_transform *t, GHashTable *options);
1374 * This function is passed a pointer to every packet in the data feed.
1376 * It can either return (in packet_out) a pointer to another packet
1377 * (possibly the exact same packet it got as input), or NULL.
1379 * @param t Pointer to the respective 'struct sr_transform'.
1380 * @param packet_in Pointer to a datafeed packet.
1381 * @param packet_out Pointer to the resulting datafeed packet after
1382 * this function was run. If NULL, the transform
1383 * module intentionally didn't output a new packet.
1385 * @retval SR_OK Success
1386 * @retval other Negative error code.
1388 int (*receive) (const struct sr_transform *t,
1389 struct sr_datafeed_packet *packet_in,
1390 struct sr_datafeed_packet **packet_out);
1393 * This function is called after the caller is finished using
1394 * the transform module, and can be used to free any internal
1395 * resources the module may keep.
1397 * @retval SR_OK Success
1398 * @retval other Negative error code.
1400 int (*cleanup) (struct sr_transform *t);
1403 #ifdef HAVE_LIBUSB_1_0
1404 /** USB device instance */
1405 struct sr_usb_dev_inst {
1408 /** Device address on USB bus */
1410 /** libusb device handle */
1411 struct libusb_device_handle *devhdl;
1415 struct sr_serial_dev_inst;
1416 #ifdef HAVE_SERIAL_COMM
1417 struct ser_lib_functions;
1418 struct ser_hid_chip_functions;
1420 typedef void (*serial_rx_chunk_callback)(struct sr_serial_dev_inst *serial,
1421 void *cb_data, const void *buf, size_t count);
1422 struct sr_serial_dev_inst {
1423 /** Port name, e.g. '/dev/tty42'. */
1425 /** Comm params for serial_set_paramstr(). */
1427 struct ser_lib_functions *lib_funcs;
1434 GString *rcv_buffer;
1435 serial_rx_chunk_callback rx_chunk_cb_func;
1436 void *rx_chunk_cb_data;
1437 #ifdef HAVE_LIBSERIALPORT
1438 /** libserialport port handle */
1439 struct sp_port *sp_data;
1441 #ifdef HAVE_LIBHIDAPI
1442 enum ser_hid_chip_t {
1443 SER_HID_CHIP_UNKNOWN, /**!< place holder */
1444 SER_HID_CHIP_BTC_BU86X, /**!< Brymen BU86x */
1445 SER_HID_CHIP_SIL_CP2110, /**!< SiLabs CP2110 */
1446 SER_HID_CHIP_VICTOR_DMM, /**!< Victor 70/86 DMM cable */
1447 SER_HID_CHIP_WCH_CH9325, /**!< WCH CH9325 */
1448 SER_HID_CHIP_LAST, /**!< sentinel */
1450 struct ser_hid_chip_functions *hid_chip_funcs;
1453 const char *hid_path;
1454 hid_device *hid_dev;
1455 GSList *hid_source_args;
1457 #ifdef HAVE_BLUETOOTH
1458 enum ser_bt_conn_t {
1459 SER_BT_CONN_UNKNOWN, /**!< place holder */
1460 SER_BT_CONN_RFCOMM, /**!< BT classic, RFCOMM channel */
1461 SER_BT_CONN_BLE122, /**!< BLE, BLE122 module, indications */
1462 SER_BT_CONN_NRF51, /**!< BLE, Nordic nRF51, notifications */
1463 SER_BT_CONN_CC254x, /**!< BLE, TI CC254x, notifications */
1464 SER_BT_CONN_MAX, /**!< sentinel */
1466 char *bt_addr_local;
1467 char *bt_addr_remote;
1468 size_t bt_rfcomm_channel;
1469 uint16_t bt_notify_handle_read;
1470 uint16_t bt_notify_handle_write;
1471 uint16_t bt_notify_handle_cccd;
1472 uint16_t bt_notify_value_cccd;
1473 struct sr_bt_desc *bt_desc;
1474 GSList *bt_source_args;
1479 struct sr_usbtmc_dev_inst {
1484 /* Private driver context. */
1485 struct drv_context {
1486 /** sigrok context */
1487 struct sr_context *sr_ctx;
1491 /*--- log.c -----------------------------------------------------------------*/
1493 #if defined(_WIN32) && (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 4))
1495 * On MinGW, we need to specify the gnu_printf format flavor or GCC
1496 * will assume non-standard Microsoft printf syntax.
1498 SR_PRIV int sr_log(int loglevel, const char *format, ...)
1499 __attribute__((__format__ (__gnu_printf__, 2, 3)));
1501 SR_PRIV int sr_log(int loglevel, const char *format, ...) G_GNUC_PRINTF(2, 3);
1504 /* Message logging helpers with subsystem-specific prefix string. */
1505 #define sr_spew(...) sr_log(SR_LOG_SPEW, LOG_PREFIX ": " __VA_ARGS__)
1506 #define sr_dbg(...) sr_log(SR_LOG_DBG, LOG_PREFIX ": " __VA_ARGS__)
1507 #define sr_info(...) sr_log(SR_LOG_INFO, LOG_PREFIX ": " __VA_ARGS__)
1508 #define sr_warn(...) sr_log(SR_LOG_WARN, LOG_PREFIX ": " __VA_ARGS__)
1509 #define sr_err(...) sr_log(SR_LOG_ERR, LOG_PREFIX ": " __VA_ARGS__)
1511 /*--- device.c --------------------------------------------------------------*/
1513 /** Scan options supported by a driver. */
1514 #define SR_CONF_SCAN_OPTIONS 0x7FFF0000
1516 /** Device options for a particular device. */
1517 #define SR_CONF_DEVICE_OPTIONS 0x7FFF0001
1519 /** Mask for separating config keys from capabilities. */
1520 #define SR_CONF_MASK 0x1fffffff
1522 /** Values for the changes argument of sr_dev_driver.config_channel_set. */
1524 /** The enabled state of the channel has been changed. */
1525 SR_CHANNEL_SET_ENABLED = 1 << 0,
1528 SR_PRIV struct sr_channel *sr_channel_new(struct sr_dev_inst *sdi,
1529 int index, int type, gboolean enabled, const char *name);
1530 SR_PRIV void sr_channel_free(struct sr_channel *ch);
1531 SR_PRIV void sr_channel_free_cb(void *p);
1532 SR_PRIV struct sr_channel *sr_next_enabled_channel(const struct sr_dev_inst *sdi,
1533 struct sr_channel *cur_channel);
1534 SR_PRIV gboolean sr_channels_differ(struct sr_channel *ch1, struct sr_channel *ch2);
1535 SR_PRIV gboolean sr_channel_lists_differ(GSList *l1, GSList *l2);
1537 /** Device instance data */
1538 struct sr_dev_inst {
1539 /** Device driver. */
1540 struct sr_dev_driver *driver;
1541 /** Device instance status. SR_ST_NOT_FOUND, etc. */
1543 /** Device instance type. SR_INST_USB, etc. */
1545 /** Device vendor. */
1547 /** Device model. */
1549 /** Device version. */
1551 /** Serial number. */
1553 /** Connection string to uniquely identify devices. */
1554 char *connection_id;
1555 /** List of channels. */
1557 /** List of sr_channel_group structs */
1558 GSList *channel_groups;
1559 /** Device instance connection data (used?) */
1561 /** Device instance private data (used?) */
1563 /** Session to which this device is currently assigned. */
1564 struct sr_session *session;
1567 /* Generic device instances */
1568 SR_PRIV void sr_dev_inst_free(struct sr_dev_inst *sdi);
1570 #ifdef HAVE_LIBUSB_1_0
1571 /* USB-specific instances */
1572 SR_PRIV struct sr_usb_dev_inst *sr_usb_dev_inst_new(uint8_t bus,
1573 uint8_t address, struct libusb_device_handle *hdl);
1574 SR_PRIV void sr_usb_dev_inst_free(struct sr_usb_dev_inst *usb);
1577 #ifdef HAVE_SERIAL_COMM
1578 #ifndef HAVE_LIBSERIALPORT
1580 * Some identifiers which initially got provided by libserialport are
1581 * used internally within the libsigrok serial layer's implementation,
1582 * while libserialport no longer is the exclusive provider of serial
1583 * communication support. Declare the identifiers here so they remain
1584 * available across all build configurations.
1591 SP_PARITY_SPACE = 4,
1594 enum libsp_flowcontrol {
1595 SP_FLOWCONTROL_NONE = 0,
1596 SP_FLOWCONTROL_XONXOFF = 1,
1597 SP_FLOWCONTROL_RTSCTS = 2,
1598 SP_FLOWCONTROL_DTRDSR = 3,
1602 /* Serial-specific instances */
1603 SR_PRIV struct sr_serial_dev_inst *sr_serial_dev_inst_new(const char *port,
1604 const char *serialcomm);
1605 SR_PRIV void sr_serial_dev_inst_free(struct sr_serial_dev_inst *serial);
1608 /* USBTMC-specific instances */
1609 SR_PRIV struct sr_usbtmc_dev_inst *sr_usbtmc_dev_inst_new(const char *device);
1610 SR_PRIV void sr_usbtmc_dev_inst_free(struct sr_usbtmc_dev_inst *usbtmc);
1612 /*--- hwdriver.c ------------------------------------------------------------*/
1614 SR_PRIV const GVariantType *sr_variant_type_get(int datatype);
1615 SR_PRIV int sr_variant_type_check(uint32_t key, GVariant *data);
1616 SR_PRIV void sr_hw_cleanup_all(const struct sr_context *ctx);
1617 SR_PRIV struct sr_config *sr_config_new(uint32_t key, GVariant *data);
1618 SR_PRIV void sr_config_free(struct sr_config *src);
1619 SR_PRIV int sr_dev_acquisition_start(struct sr_dev_inst *sdi);
1620 SR_PRIV int sr_dev_acquisition_stop(struct sr_dev_inst *sdi);
1622 /*--- session.c -------------------------------------------------------------*/
1625 /** Context this session exists in. */
1626 struct sr_context *ctx;
1627 /** List of struct sr_dev_inst pointers. */
1629 /** List of struct sr_dev_inst pointers owned by this session. */
1631 /** List of struct datafeed_callback pointers. */
1632 GSList *datafeed_callbacks;
1634 struct sr_trigger *trigger;
1636 /** Callback to invoke on session stop. */
1637 sr_session_stopped_callback stopped_callback;
1638 /** User data to be passed to the session stop callback. */
1639 void *stopped_cb_data;
1641 /** Mutex protecting the main context pointer. */
1643 /** Context of the session main loop. */
1644 GMainContext *main_context;
1646 /** Registered event sources for this session. */
1647 GHashTable *event_sources;
1648 /** Session main loop. */
1649 GMainLoop *main_loop;
1650 /** ID of idle source for dispatching the session stop notification. */
1651 unsigned int stop_check_id;
1652 /** Whether the session has been started. */
1656 SR_PRIV int sr_session_source_add_internal(struct sr_session *session,
1657 void *key, GSource *source);
1658 SR_PRIV int sr_session_source_remove_internal(struct sr_session *session,
1660 SR_PRIV int sr_session_source_destroyed(struct sr_session *session,
1661 void *key, GSource *source);
1662 SR_PRIV int sr_session_fd_source_add(struct sr_session *session,
1663 void *key, gintptr fd, int events, int timeout,
1664 sr_receive_data_callback cb, void *cb_data);
1666 SR_PRIV int sr_session_source_add(struct sr_session *session, int fd,
1667 int events, int timeout, sr_receive_data_callback cb, void *cb_data);
1668 SR_PRIV int sr_session_source_add_pollfd(struct sr_session *session,
1669 GPollFD *pollfd, int timeout, sr_receive_data_callback cb,
1671 SR_PRIV int sr_session_source_add_channel(struct sr_session *session,
1672 GIOChannel *channel, int events, int timeout,
1673 sr_receive_data_callback cb, void *cb_data);
1674 SR_PRIV int sr_session_source_remove(struct sr_session *session, int fd);
1675 SR_PRIV int sr_session_source_remove_pollfd(struct sr_session *session,
1677 SR_PRIV int sr_session_source_remove_channel(struct sr_session *session,
1678 GIOChannel *channel);
1680 SR_PRIV int sr_session_send_meta(const struct sr_dev_inst *sdi,
1681 uint32_t key, GVariant *var);
1682 SR_PRIV int sr_session_send(const struct sr_dev_inst *sdi,
1683 const struct sr_datafeed_packet *packet);
1684 SR_PRIV int sr_sessionfile_check(const char *filename);
1685 SR_PRIV struct sr_dev_inst *sr_session_prepare_sdi(const char *filename,
1686 struct sr_session **session);
1688 /*--- session_file.c --------------------------------------------------------*/
1690 #if !HAVE_ZIP_DISCARD
1691 /* Replace zip_discard() if not available. */
1692 #define zip_discard(zip) sr_zip_discard(zip)
1693 SR_PRIV void sr_zip_discard(struct zip *archive);
1696 SR_PRIV GKeyFile *sr_sessionfile_read_metadata(struct zip *archive,
1697 const struct zip_stat *entry);
1699 /*--- analog.c --------------------------------------------------------------*/
1701 SR_PRIV int sr_analog_init(struct sr_datafeed_analog *analog,
1702 struct sr_analog_encoding *encoding,
1703 struct sr_analog_meaning *meaning,
1704 struct sr_analog_spec *spec,
1707 /*--- std.c -----------------------------------------------------------------*/
1709 typedef int (*dev_close_callback)(struct sr_dev_inst *sdi);
1710 typedef void (*std_dev_clear_callback)(void *priv);
1712 SR_PRIV int std_init(struct sr_dev_driver *di, struct sr_context *sr_ctx);
1713 SR_PRIV int std_cleanup(const struct sr_dev_driver *di);
1714 SR_PRIV int std_dummy_dev_open(struct sr_dev_inst *sdi);
1715 SR_PRIV int std_dummy_dev_close(struct sr_dev_inst *sdi);
1716 SR_PRIV int std_dummy_dev_acquisition_start(const struct sr_dev_inst *sdi);
1717 SR_PRIV int std_dummy_dev_acquisition_stop(struct sr_dev_inst *sdi);
1718 #ifdef HAVE_SERIAL_COMM
1719 SR_PRIV int std_serial_dev_open(struct sr_dev_inst *sdi);
1720 SR_PRIV int std_serial_dev_acquisition_stop(struct sr_dev_inst *sdi);
1722 SR_PRIV int std_session_send_df_header(const struct sr_dev_inst *sdi);
1723 SR_PRIV int std_session_send_df_end(const struct sr_dev_inst *sdi);
1724 SR_PRIV int std_session_send_df_trigger(const struct sr_dev_inst *sdi);
1725 SR_PRIV int std_session_send_df_frame_begin(const struct sr_dev_inst *sdi);
1726 SR_PRIV int std_session_send_df_frame_end(const struct sr_dev_inst *sdi);
1727 SR_PRIV int std_dev_clear_with_callback(const struct sr_dev_driver *driver,
1728 std_dev_clear_callback clear_private);
1729 SR_PRIV int std_dev_clear(const struct sr_dev_driver *driver);
1730 SR_PRIV GSList *std_dev_list(const struct sr_dev_driver *di);
1731 SR_PRIV int std_serial_dev_close(struct sr_dev_inst *sdi);
1732 SR_PRIV GSList *std_scan_complete(struct sr_dev_driver *di, GSList *devices);
1734 SR_PRIV int std_opts_config_list(uint32_t key, GVariant **data,
1735 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg,
1736 const uint32_t scanopts[], size_t scansize, const uint32_t drvopts[],
1737 size_t drvsize, const uint32_t devopts[], size_t devsize);
1739 extern SR_PRIV const uint32_t NO_OPTS[1];
1741 #define STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts) \
1742 std_opts_config_list(key, data, sdi, cg, ARRAY_AND_SIZE(scanopts), \
1743 ARRAY_AND_SIZE(drvopts), ARRAY_AND_SIZE(devopts))
1745 SR_PRIV GVariant *std_gvar_tuple_array(const uint64_t a[][2], unsigned int n);
1746 SR_PRIV GVariant *std_gvar_tuple_rational(const struct sr_rational *r, unsigned int n);
1747 SR_PRIV GVariant *std_gvar_samplerates(const uint64_t samplerates[], unsigned int n);
1748 SR_PRIV GVariant *std_gvar_samplerates_steps(const uint64_t samplerates[], unsigned int n);
1749 SR_PRIV GVariant *std_gvar_min_max_step(double min, double max, double step);
1750 SR_PRIV GVariant *std_gvar_min_max_step_array(const double a[3]);
1751 SR_PRIV GVariant *std_gvar_min_max_step_thresholds(const double dmin, const double dmax, const double dstep);
1753 SR_PRIV GVariant *std_gvar_tuple_u64(uint64_t low, uint64_t high);
1754 SR_PRIV GVariant *std_gvar_tuple_double(double low, double high);
1756 SR_PRIV GVariant *std_gvar_array_i32(const int32_t a[], unsigned int n);
1757 SR_PRIV GVariant *std_gvar_array_u32(const uint32_t a[], unsigned int n);
1758 SR_PRIV GVariant *std_gvar_array_u64(const uint64_t a[], unsigned int n);
1759 SR_PRIV GVariant *std_gvar_array_str(const char *a[], unsigned int n);
1761 SR_PRIV GVariant *std_gvar_thresholds(const double a[][2], unsigned int n);
1763 SR_PRIV int std_str_idx(GVariant *data, const char *a[], unsigned int n);
1764 SR_PRIV int std_u64_idx(GVariant *data, const uint64_t a[], unsigned int n);
1765 SR_PRIV int std_u8_idx(GVariant *data, const uint8_t a[], unsigned int n);
1767 SR_PRIV int std_str_idx_s(const char *s, const char *a[], unsigned int n);
1768 SR_PRIV int std_u8_idx_s(uint8_t b, const uint8_t a[], unsigned int n);
1770 SR_PRIV int std_u64_tuple_idx(GVariant *data, const uint64_t a[][2], unsigned int n);
1771 SR_PRIV int std_double_tuple_idx(GVariant *data, const double a[][2], unsigned int n);
1772 SR_PRIV int std_double_tuple_idx_d0(const double d, const double a[][2], unsigned int n);
1774 SR_PRIV int std_cg_idx(const struct sr_channel_group *cg, struct sr_channel_group *a[], unsigned int n);
1776 SR_PRIV int std_dummy_set_params(struct sr_serial_dev_inst *serial,
1777 int baudrate, int bits, int parity, int stopbits,
1778 int flowcontrol, int rts, int dtr);
1779 SR_PRIV int std_dummy_set_handshake(struct sr_serial_dev_inst *serial,
1782 /*--- resource.c ------------------------------------------------------------*/
1784 SR_PRIV int64_t sr_file_get_size(FILE *file);
1786 SR_PRIV int sr_resource_open(struct sr_context *ctx,
1787 struct sr_resource *res, int type, const char *name)
1788 G_GNUC_WARN_UNUSED_RESULT;
1789 SR_PRIV int sr_resource_close(struct sr_context *ctx,
1790 struct sr_resource *res);
1791 SR_PRIV gssize sr_resource_read(struct sr_context *ctx,
1792 const struct sr_resource *res, void *buf, size_t count)
1793 G_GNUC_WARN_UNUSED_RESULT;
1794 SR_PRIV void *sr_resource_load(struct sr_context *ctx, int type,
1795 const char *name, size_t *size, size_t max_size)
1796 G_GNUC_MALLOC G_GNUC_WARN_UNUSED_RESULT;
1798 /*--- strutil.c -------------------------------------------------------------*/
1800 SR_PRIV int sr_atol(const char *str, long *ret);
1801 SR_PRIV int sr_atol_base(const char *str, long *ret, char **end, int base);
1802 SR_PRIV int sr_atoi(const char *str, int *ret);
1803 SR_PRIV int sr_atod(const char *str, double *ret);
1804 SR_PRIV int sr_atof(const char *str, float *ret);
1805 SR_PRIV int sr_atod_ascii(const char *str, double *ret);
1806 SR_PRIV int sr_atod_ascii_digits(const char *str, double *ret, int *digits);
1807 SR_PRIV int sr_atof_ascii(const char *str, float *ret);
1809 SR_PRIV GString *sr_hexdump_new(const uint8_t *data, const size_t len);
1810 SR_PRIV void sr_hexdump_free(GString *s);
1812 /*--- soft-trigger.c --------------------------------------------------------*/
1814 struct soft_trigger_logic {
1815 const struct sr_dev_inst *sdi;
1816 const struct sr_trigger *trigger;
1820 uint8_t *prev_sample;
1821 uint8_t *pre_trigger_buffer;
1822 uint8_t *pre_trigger_head;
1823 int pre_trigger_size;
1824 int pre_trigger_fill;
1827 SR_PRIV int logic_channel_unitsize(GSList *channels);
1828 SR_PRIV struct soft_trigger_logic *soft_trigger_logic_new(
1829 const struct sr_dev_inst *sdi, struct sr_trigger *trigger,
1830 int pre_trigger_samples);
1831 SR_PRIV void soft_trigger_logic_free(struct soft_trigger_logic *st);
1832 SR_PRIV int soft_trigger_logic_check(struct soft_trigger_logic *st, uint8_t *buf,
1833 int len, int *pre_trigger_samples);
1835 /*--- serial.c --------------------------------------------------------------*/
1837 #ifdef HAVE_SERIAL_COMM
1843 typedef gboolean (*packet_valid_callback)(const uint8_t *buf);
1844 typedef int (*packet_valid_len_callback)(void *st,
1845 const uint8_t *p, size_t l, size_t *pl);
1847 typedef GSList *(*sr_ser_list_append_t)(GSList *devs, const char *name,
1849 typedef GSList *(*sr_ser_find_append_t)(GSList *devs, const char *name);
1851 SR_PRIV int serial_open(struct sr_serial_dev_inst *serial, int flags);
1852 SR_PRIV int serial_close(struct sr_serial_dev_inst *serial);
1853 SR_PRIV int serial_flush(struct sr_serial_dev_inst *serial);
1854 SR_PRIV int serial_drain(struct sr_serial_dev_inst *serial);
1855 SR_PRIV size_t serial_has_receive_data(struct sr_serial_dev_inst *serial);
1856 SR_PRIV int serial_write_blocking(struct sr_serial_dev_inst *serial,
1857 const void *buf, size_t count, unsigned int timeout_ms);
1858 SR_PRIV int serial_write_nonblocking(struct sr_serial_dev_inst *serial,
1859 const void *buf, size_t count);
1860 SR_PRIV int serial_read_blocking(struct sr_serial_dev_inst *serial, void *buf,
1861 size_t count, unsigned int timeout_ms);
1862 SR_PRIV int serial_read_nonblocking(struct sr_serial_dev_inst *serial, void *buf,
1864 SR_PRIV int serial_set_read_chunk_cb(struct sr_serial_dev_inst *serial,
1865 serial_rx_chunk_callback cb, void *cb_data);
1866 SR_PRIV int serial_set_params(struct sr_serial_dev_inst *serial, int baudrate,
1867 int bits, int parity, int stopbits, int flowcontrol, int rts, int dtr);
1868 SR_PRIV int serial_set_handshake(struct sr_serial_dev_inst *serial,
1870 SR_PRIV int serial_set_paramstr(struct sr_serial_dev_inst *serial,
1871 const char *paramstr);
1872 SR_PRIV int serial_readline(struct sr_serial_dev_inst *serial, char **buf,
1873 int *buflen, gint64 timeout_ms);
1874 SR_PRIV int serial_stream_detect(struct sr_serial_dev_inst *serial,
1875 uint8_t *buf, size_t *buflen,
1876 size_t packet_size, packet_valid_callback is_valid,
1877 packet_valid_len_callback is_valid_len, size_t *return_size,
1878 uint64_t timeout_ms);
1879 SR_PRIV int sr_serial_extract_options(GSList *options, const char **serial_device,
1880 const char **serial_options);
1881 SR_PRIV int serial_source_add(struct sr_session *session,
1882 struct sr_serial_dev_inst *serial, int events, int timeout,
1883 sr_receive_data_callback cb, void *cb_data);
1884 SR_PRIV int serial_source_remove(struct sr_session *session,
1885 struct sr_serial_dev_inst *serial);
1886 SR_PRIV GSList *sr_serial_find_usb(uint16_t vendor_id, uint16_t product_id);
1887 SR_PRIV int serial_timeout(struct sr_serial_dev_inst *port, int num_bytes);
1889 SR_PRIV void sr_ser_discard_queued_data(struct sr_serial_dev_inst *serial);
1890 SR_PRIV size_t sr_ser_has_queued_data(struct sr_serial_dev_inst *serial);
1891 SR_PRIV void sr_ser_queue_rx_data(struct sr_serial_dev_inst *serial,
1892 const uint8_t *data, size_t len);
1893 SR_PRIV size_t sr_ser_unqueue_rx_data(struct sr_serial_dev_inst *serial,
1894 uint8_t *data, size_t len);
1896 struct ser_lib_functions {
1897 int (*open)(struct sr_serial_dev_inst *serial, int flags);
1898 int (*close)(struct sr_serial_dev_inst *serial);
1899 int (*flush)(struct sr_serial_dev_inst *serial);
1900 int (*drain)(struct sr_serial_dev_inst *serial);
1901 int (*write)(struct sr_serial_dev_inst *serial,
1902 const void *buf, size_t count,
1903 int nonblocking, unsigned int timeout_ms);
1904 int (*read)(struct sr_serial_dev_inst *serial,
1905 void *buf, size_t count,
1906 int nonblocking, unsigned int timeout_ms);
1907 int (*set_params)(struct sr_serial_dev_inst *serial,
1908 int baudrate, int bits, int parity, int stopbits,
1909 int flowcontrol, int rts, int dtr);
1910 int (*set_handshake)(struct sr_serial_dev_inst *serial,
1912 int (*setup_source_add)(struct sr_session *session,
1913 struct sr_serial_dev_inst *serial,
1914 int events, int timeout,
1915 sr_receive_data_callback cb, void *cb_data);
1916 int (*setup_source_remove)(struct sr_session *session,
1917 struct sr_serial_dev_inst *serial);
1918 GSList *(*list)(GSList *list, sr_ser_list_append_t append);
1919 GSList *(*find_usb)(GSList *list, sr_ser_find_append_t append,
1920 uint16_t vendor_id, uint16_t product_id);
1921 int (*get_frame_format)(struct sr_serial_dev_inst *serial,
1922 int *baud, int *bits);
1923 size_t (*get_rx_avail)(struct sr_serial_dev_inst *serial);
1925 extern SR_PRIV struct ser_lib_functions *ser_lib_funcs_libsp;
1926 SR_PRIV int ser_name_is_hid(struct sr_serial_dev_inst *serial);
1927 extern SR_PRIV struct ser_lib_functions *ser_lib_funcs_hid;
1928 SR_PRIV int ser_name_is_bt(struct sr_serial_dev_inst *serial);
1929 extern SR_PRIV struct ser_lib_functions *ser_lib_funcs_bt;
1931 #ifdef HAVE_LIBHIDAPI
1932 struct vid_pid_item {
1936 struct ser_hid_chip_functions {
1937 const char *chipname;
1938 const char *chipdesc;
1939 const struct vid_pid_item *vid_pid_items;
1940 const int max_bytes_per_request;
1941 int (*set_params)(struct sr_serial_dev_inst *serial,
1942 int baudrate, int bits, int parity, int stopbits,
1943 int flowcontrol, int rts, int dtr);
1944 int (*read_bytes)(struct sr_serial_dev_inst *serial,
1945 uint8_t *data, int space, unsigned int timeout);
1946 int (*write_bytes)(struct sr_serial_dev_inst *serial,
1947 const uint8_t *data, int space);
1948 int (*flush)(struct sr_serial_dev_inst *serial);
1949 int (*drain)(struct sr_serial_dev_inst *serial);
1951 extern SR_PRIV struct ser_hid_chip_functions *ser_hid_chip_funcs_bu86x;
1952 extern SR_PRIV struct ser_hid_chip_functions *ser_hid_chip_funcs_ch9325;
1953 extern SR_PRIV struct ser_hid_chip_functions *ser_hid_chip_funcs_cp2110;
1954 extern SR_PRIV struct ser_hid_chip_functions *ser_hid_chip_funcs_victor;
1955 SR_PRIV const char *ser_hid_chip_find_name_vid_pid(uint16_t vid, uint16_t pid);
1959 /*--- bt/ API ---------------------------------------------------------------*/
1961 #ifdef HAVE_BLUETOOTH
1962 SR_PRIV const char *sr_bt_adapter_get_address(size_t idx);
1965 typedef void (*sr_bt_scan_cb)(void *cb_data, const char *addr, const char *name);
1966 typedef int (*sr_bt_data_cb)(void *cb_data, uint8_t *data, size_t dlen);
1968 SR_PRIV struct sr_bt_desc *sr_bt_desc_new(void);
1969 SR_PRIV void sr_bt_desc_free(struct sr_bt_desc *desc);
1971 SR_PRIV int sr_bt_config_cb_scan(struct sr_bt_desc *desc,
1972 sr_bt_scan_cb cb, void *cb_data);
1973 SR_PRIV int sr_bt_config_cb_data(struct sr_bt_desc *desc,
1974 sr_bt_data_cb cb, void *cb_data);
1975 SR_PRIV int sr_bt_config_addr_local(struct sr_bt_desc *desc, const char *addr);
1976 SR_PRIV int sr_bt_config_addr_remote(struct sr_bt_desc *desc, const char *addr);
1977 SR_PRIV int sr_bt_config_rfcomm(struct sr_bt_desc *desc, size_t channel);
1978 SR_PRIV int sr_bt_config_notify(struct sr_bt_desc *desc,
1979 uint16_t read_handle, uint16_t write_handle,
1980 uint16_t cccd_handle, uint16_t cccd_value);
1982 SR_PRIV int sr_bt_scan_le(struct sr_bt_desc *desc, int duration);
1983 SR_PRIV int sr_bt_scan_bt(struct sr_bt_desc *desc, int duration);
1985 SR_PRIV int sr_bt_connect_ble(struct sr_bt_desc *desc);
1986 SR_PRIV int sr_bt_connect_rfcomm(struct sr_bt_desc *desc);
1987 SR_PRIV void sr_bt_disconnect(struct sr_bt_desc *desc);
1989 SR_PRIV ssize_t sr_bt_read(struct sr_bt_desc *desc,
1990 void *data, size_t len);
1991 SR_PRIV ssize_t sr_bt_write(struct sr_bt_desc *desc,
1992 const void *data, size_t len);
1994 SR_PRIV int sr_bt_start_notify(struct sr_bt_desc *desc);
1995 SR_PRIV int sr_bt_check_notify(struct sr_bt_desc *desc);
1998 /*--- ezusb.c ---------------------------------------------------------------*/
2000 #ifdef HAVE_LIBUSB_1_0
2001 SR_PRIV int ezusb_reset(struct libusb_device_handle *hdl, int set_clear);
2002 SR_PRIV int ezusb_install_firmware(struct sr_context *ctx, libusb_device_handle *hdl,
2004 SR_PRIV int ezusb_upload_firmware(struct sr_context *ctx, libusb_device *dev,
2005 int configuration, const char *name);
2008 /*--- usb.c -----------------------------------------------------------------*/
2010 #ifdef HAVE_LIBUSB_1_0
2011 SR_PRIV GSList *sr_usb_find(libusb_context *usb_ctx, const char *conn);
2012 SR_PRIV int sr_usb_open(libusb_context *usb_ctx, struct sr_usb_dev_inst *usb);
2013 SR_PRIV void sr_usb_close(struct sr_usb_dev_inst *usb);
2014 SR_PRIV int usb_source_add(struct sr_session *session, struct sr_context *ctx,
2015 int timeout, sr_receive_data_callback cb, void *cb_data);
2016 SR_PRIV int usb_source_remove(struct sr_session *session, struct sr_context *ctx);
2017 SR_PRIV int usb_get_port_path(libusb_device *dev, char *path, int path_len);
2018 SR_PRIV gboolean usb_match_manuf_prod(libusb_device *dev,
2019 const char *manufacturer, const char *product);
2022 /*--- binary_helpers.c ------------------------------------------------------*/
2024 /** Binary value type */
2025 enum binary_value_type {
2027 BVT_BE_UINT8 = BVT_UINT8,
2028 BVT_LE_UINT8 = BVT_UINT8,
2041 /** Binary value specification */
2042 struct binary_value_spec {
2043 /** Offset into binary blob */
2045 /** Data type to decode */
2046 enum binary_value_type type;
2047 /** Scale factor to get native units */
2051 /** Binary channel definition */
2052 struct binary_analog_channel {
2055 /** Binary value in data stream */
2056 struct binary_value_spec spec;
2057 /** Significant digits */
2059 /** Measured quantity */
2061 /** Measured unit */
2066 * Read extract a value from a binary blob.
2068 * @param out Pointer to output buffer.
2069 * @param spec Binary value specification
2070 * @param data Pointer to binary blob
2071 * @param length Size of binary blob
2072 * @return SR_OK on success, SR_ERR_* error code on failure.
2074 SR_PRIV int bv_get_value(float *out, const struct binary_value_spec *spec, const void *data, size_t length);
2077 * Send an analog channel packet based on a binary analog channel
2080 * @param sdi Device instance
2081 * @param ch Sigrok channel
2082 * @param spec Channel specification
2083 * @param data Pointer to binary blob
2084 * @param length Size of binary blob
2085 * @return SR_OK on success, SR_ERR_* error code on failure.
2087 SR_PRIV int bv_send_analog_channel(const struct sr_dev_inst *sdi, struct sr_channel *ch,
2088 const struct binary_analog_channel *spec, const void *data, size_t length);
2090 /*--- crc.c -----------------------------------------------------------------*/
2092 #define SR_CRC16_DEFAULT_INIT 0xffffU
2095 * Calculate a CRC16 checksum using the 0x8005 polynomial.
2097 * This CRC16 flavor is also known as CRC16-ANSI or CRC16-MODBUS.
2099 * @param crc Initial value (typically 0xffff)
2100 * @param buffer Input buffer
2101 * @param len Buffer length
2104 SR_PRIV uint16_t sr_crc16(uint16_t crc, const uint8_t *buffer, int len);
2106 /*--- modbus/modbus.c -------------------------------------------------------*/
2108 struct sr_modbus_dev_inst {
2112 GSList *(*scan)(int modbusaddr);
2113 int (*dev_inst_new)(void *priv, const char *resource,
2114 char **params, const char *serialcomm, int modbusaddr);
2115 int (*open)(void *priv);
2116 int (*source_add)(struct sr_session *session, void *priv, int events,
2117 int timeout, sr_receive_data_callback cb, void *cb_data);
2118 int (*source_remove)(struct sr_session *session, void *priv);
2119 int (*send)(void *priv, const uint8_t *buffer, int buffer_size);
2120 int (*read_begin)(void *priv, uint8_t *function_code);
2121 int (*read_data)(void *priv, uint8_t *buf, int maxlen);
2122 int (*read_end)(void *priv);
2123 int (*close)(void *priv);
2124 void (*free)(void *priv);
2125 unsigned int read_timeout_ms;
2129 SR_PRIV GSList *sr_modbus_scan(struct drv_context *drvc, GSList *options,
2130 struct sr_dev_inst *(*probe_device)(struct sr_modbus_dev_inst *modbus));
2131 SR_PRIV struct sr_modbus_dev_inst *modbus_dev_inst_new(const char *resource,
2132 const char *serialcomm, int modbusaddr);
2133 SR_PRIV int sr_modbus_open(struct sr_modbus_dev_inst *modbus);
2134 SR_PRIV int sr_modbus_source_add(struct sr_session *session,
2135 struct sr_modbus_dev_inst *modbus, int events, int timeout,
2136 sr_receive_data_callback cb, void *cb_data);
2137 SR_PRIV int sr_modbus_source_remove(struct sr_session *session,
2138 struct sr_modbus_dev_inst *modbus);
2139 SR_PRIV int sr_modbus_request(struct sr_modbus_dev_inst *modbus,
2140 uint8_t *request, int request_size);
2141 SR_PRIV int sr_modbus_reply(struct sr_modbus_dev_inst *modbus,
2142 uint8_t *reply, int reply_size);
2143 SR_PRIV int sr_modbus_request_reply(struct sr_modbus_dev_inst *modbus,
2144 uint8_t *request, int request_size,
2145 uint8_t *reply, int reply_size);
2146 SR_PRIV int sr_modbus_read_coils(struct sr_modbus_dev_inst *modbus,
2147 int address, int nb_coils, uint8_t *coils);
2148 SR_PRIV int sr_modbus_read_holding_registers(struct sr_modbus_dev_inst *modbus,
2149 int address, int nb_registers,
2150 uint16_t *registers);
2151 SR_PRIV int sr_modbus_write_coil(struct sr_modbus_dev_inst *modbus,
2152 int address, int value);
2153 SR_PRIV int sr_modbus_write_multiple_registers(struct sr_modbus_dev_inst*modbus,
2154 int address, int nb_registers,
2155 uint16_t *registers);
2156 SR_PRIV int sr_modbus_close(struct sr_modbus_dev_inst *modbus);
2157 SR_PRIV void sr_modbus_free(struct sr_modbus_dev_inst *modbus);
2159 /*--- dmm/es519xx.c ---------------------------------------------------------*/
2162 * All 11-byte es519xx chips repeat each block twice for each conversion cycle
2163 * so always read 2 blocks at a time.
2165 #define ES519XX_11B_PACKET_SIZE (11 * 2)
2166 #define ES519XX_14B_PACKET_SIZE 14
2168 struct es519xx_info {
2169 gboolean is_judge, is_voltage, is_auto, is_micro, is_current;
2170 gboolean is_milli, is_resistance, is_continuity, is_diode;
2171 gboolean is_frequency, is_rpm, is_capacitance, is_duty_cycle;
2172 gboolean is_temperature, is_celsius, is_fahrenheit;
2173 gboolean is_adp0, is_adp1, is_adp2, is_adp3;
2174 gboolean is_sign, is_batt, is_ol, is_pmax, is_pmin, is_apo;
2175 gboolean is_dc, is_ac, is_vahz, is_min, is_max, is_rel, is_hold;
2176 gboolean is_digit4, is_ul, is_vasel, is_vbar, is_lpf1, is_lpf0, is_rmr;
2179 gboolean alt_functions, fivedigits, clampmeter, selectable_lpf;
2183 SR_PRIV gboolean sr_es519xx_2400_11b_packet_valid(const uint8_t *buf);
2184 SR_PRIV int sr_es519xx_2400_11b_parse(const uint8_t *buf, float *floatval,
2185 struct sr_datafeed_analog *analog, void *info);
2186 SR_PRIV gboolean sr_es519xx_2400_11b_altfn_packet_valid(const uint8_t *buf);
2187 SR_PRIV int sr_es519xx_2400_11b_altfn_parse(const uint8_t *buf,
2188 float *floatval, struct sr_datafeed_analog *analog, void *info);
2189 SR_PRIV gboolean sr_es519xx_19200_11b_5digits_packet_valid(const uint8_t *buf);
2190 SR_PRIV int sr_es519xx_19200_11b_5digits_parse(const uint8_t *buf,
2191 float *floatval, struct sr_datafeed_analog *analog, void *info);
2192 SR_PRIV gboolean sr_es519xx_19200_11b_clamp_packet_valid(const uint8_t *buf);
2193 SR_PRIV int sr_es519xx_19200_11b_clamp_parse(const uint8_t *buf,
2194 float *floatval, struct sr_datafeed_analog *analog, void *info);
2195 SR_PRIV gboolean sr_es519xx_19200_11b_packet_valid(const uint8_t *buf);
2196 SR_PRIV int sr_es519xx_19200_11b_parse(const uint8_t *buf, float *floatval,
2197 struct sr_datafeed_analog *analog, void *info);
2198 SR_PRIV gboolean sr_es519xx_19200_14b_packet_valid(const uint8_t *buf);
2199 SR_PRIV int sr_es519xx_19200_14b_parse(const uint8_t *buf, float *floatval,
2200 struct sr_datafeed_analog *analog, void *info);
2201 SR_PRIV gboolean sr_es519xx_19200_14b_sel_lpf_packet_valid(const uint8_t *buf);
2202 SR_PRIV int sr_es519xx_19200_14b_sel_lpf_parse(const uint8_t *buf,
2203 float *floatval, struct sr_datafeed_analog *analog, void *info);
2205 /*--- dmm/fs9922.c ----------------------------------------------------------*/
2207 #define FS9922_PACKET_SIZE 14
2209 struct fs9922_info {
2210 gboolean is_auto, is_dc, is_ac, is_rel, is_hold, is_bpn, is_z1, is_z2;
2211 gboolean is_max, is_min, is_apo, is_bat, is_nano, is_z3, is_micro;
2212 gboolean is_milli, is_kilo, is_mega, is_beep, is_diode, is_percent;
2213 gboolean is_z4, is_volt, is_ampere, is_ohm, is_hfe, is_hertz, is_farad;
2214 gboolean is_celsius, is_fahrenheit;
2215 int bargraph_sign, bargraph_value;
2218 SR_PRIV gboolean sr_fs9922_packet_valid(const uint8_t *buf);
2219 SR_PRIV int sr_fs9922_parse(const uint8_t *buf, float *floatval,
2220 struct sr_datafeed_analog *analog, void *info);
2221 SR_PRIV void sr_fs9922_z1_diode(struct sr_datafeed_analog *analog, void *info);
2223 /*--- dmm/fs9721.c ----------------------------------------------------------*/
2225 #define FS9721_PACKET_SIZE 14
2227 struct fs9721_info {
2228 gboolean is_ac, is_dc, is_auto, is_rs232, is_micro, is_nano, is_kilo;
2229 gboolean is_diode, is_milli, is_percent, is_mega, is_beep, is_farad;
2230 gboolean is_ohm, is_rel, is_hold, is_ampere, is_volt, is_hz, is_bat;
2231 gboolean is_c2c1_11, is_c2c1_10, is_c2c1_01, is_c2c1_00, is_sign;
2234 SR_PRIV gboolean sr_fs9721_packet_valid(const uint8_t *buf);
2235 SR_PRIV int sr_fs9721_parse(const uint8_t *buf, float *floatval,
2236 struct sr_datafeed_analog *analog, void *info);
2237 SR_PRIV void sr_fs9721_00_temp_c(struct sr_datafeed_analog *analog, void *info);
2238 SR_PRIV void sr_fs9721_01_temp_c(struct sr_datafeed_analog *analog, void *info);
2239 SR_PRIV void sr_fs9721_10_temp_c(struct sr_datafeed_analog *analog, void *info);
2240 SR_PRIV void sr_fs9721_01_10_temp_f_c(struct sr_datafeed_analog *analog, void *info);
2241 SR_PRIV void sr_fs9721_max_c_min(struct sr_datafeed_analog *analog, void *info);
2243 /*--- dmm/ms2115b.c ---------------------------------------------------------*/
2245 #define MS2115B_PACKET_SIZE 9
2247 enum ms2115b_display {
2248 MS2115B_DISPLAY_MAIN,
2249 MS2115B_DISPLAY_SUB,
2250 MS2115B_DISPLAY_COUNT,
2253 struct ms2115b_info {
2254 /* Selected channel. */
2256 gboolean is_ac, is_dc, is_auto;
2257 gboolean is_diode, is_beep, is_farad;
2258 gboolean is_ohm, is_ampere, is_volt, is_hz;
2259 gboolean is_duty_cycle, is_percent;
2262 extern SR_PRIV const char *ms2115b_channel_formats[];
2263 SR_PRIV gboolean sr_ms2115b_packet_valid(const uint8_t *buf);
2264 SR_PRIV int sr_ms2115b_parse(const uint8_t *buf, float *floatval,
2265 struct sr_datafeed_analog *analog, void *info);
2267 /*--- dmm/ms8250d.c ---------------------------------------------------------*/
2269 #define MS8250D_PACKET_SIZE 18
2271 struct ms8250d_info {
2272 gboolean is_ac, is_dc, is_auto, is_rs232, is_micro, is_nano, is_kilo;
2273 gboolean is_diode, is_milli, is_percent, is_mega, is_beep, is_farad;
2274 gboolean is_ohm, is_rel, is_hold, is_ampere, is_volt, is_hz, is_bat;
2275 gboolean is_ncv, is_min, is_max, is_sign, is_autotimer;
2278 SR_PRIV gboolean sr_ms8250d_packet_valid(const uint8_t *buf);
2279 SR_PRIV int sr_ms8250d_parse(const uint8_t *buf, float *floatval,
2280 struct sr_datafeed_analog *analog, void *info);
2282 /*--- dmm/dtm0660.c ---------------------------------------------------------*/
2284 #define DTM0660_PACKET_SIZE 15
2286 struct dtm0660_info {
2287 gboolean is_ac, is_dc, is_auto, is_rs232, is_micro, is_nano, is_kilo;
2288 gboolean is_diode, is_milli, is_percent, is_mega, is_beep, is_farad;
2289 gboolean is_ohm, is_rel, is_hold, is_ampere, is_volt, is_hz, is_bat;
2290 gboolean is_degf, is_degc, is_c2c1_01, is_c2c1_00, is_apo, is_min;
2291 gboolean is_minmax, is_max, is_sign;
2294 SR_PRIV gboolean sr_dtm0660_packet_valid(const uint8_t *buf);
2295 SR_PRIV int sr_dtm0660_parse(const uint8_t *buf, float *floatval,
2296 struct sr_datafeed_analog *analog, void *info);
2298 /*--- dmm/m2110.c -----------------------------------------------------------*/
2300 #define BBCGM_M2110_PACKET_SIZE 9
2302 /* Dummy info struct. The parser does not use it. */
2303 struct m2110_info { int dummy; };
2305 SR_PRIV gboolean sr_m2110_packet_valid(const uint8_t *buf);
2306 SR_PRIV int sr_m2110_parse(const uint8_t *buf, float *floatval,
2307 struct sr_datafeed_analog *analog, void *info);
2309 /*--- dmm/metex14.c ---------------------------------------------------------*/
2311 #define METEX14_PACKET_SIZE 14
2313 struct metex14_info {
2315 gboolean is_ac, is_dc, is_resistance, is_capacity, is_temperature;
2316 gboolean is_diode, is_frequency, is_ampere, is_volt, is_farad;
2317 gboolean is_hertz, is_ohm, is_celsius, is_fahrenheit, is_watt;
2318 gboolean is_pico, is_nano, is_micro, is_milli, is_kilo, is_mega;
2319 gboolean is_gain, is_decibel, is_power, is_decibel_mw, is_power_factor;
2320 gboolean is_hfe, is_unitless, is_logic, is_min, is_max, is_avg;
2323 #ifdef HAVE_SERIAL_COMM
2324 SR_PRIV int sr_metex14_packet_request(struct sr_serial_dev_inst *serial);
2326 SR_PRIV gboolean sr_metex14_packet_valid(const uint8_t *buf);
2327 SR_PRIV int sr_metex14_parse(const uint8_t *buf, float *floatval,
2328 struct sr_datafeed_analog *analog, void *info);
2329 SR_PRIV gboolean sr_metex14_4packets_valid(const uint8_t *buf);
2330 SR_PRIV int sr_metex14_4packets_parse(const uint8_t *buf, float *floatval,
2331 struct sr_datafeed_analog *analog, void *info);
2333 /*--- dmm/rs9lcd.c ----------------------------------------------------------*/
2335 #define RS9LCD_PACKET_SIZE 9
2337 /* Dummy info struct. The parser does not use it. */
2338 struct rs9lcd_info { int dummy; };
2340 SR_PRIV gboolean sr_rs9lcd_packet_valid(const uint8_t *buf);
2341 SR_PRIV int sr_rs9lcd_parse(const uint8_t *buf, float *floatval,
2342 struct sr_datafeed_analog *analog, void *info);
2344 /*--- dmm/bm25x.c -----------------------------------------------------------*/
2346 #define BRYMEN_BM25X_PACKET_SIZE 15
2348 /* Dummy info struct. The parser does not use it. */
2349 struct bm25x_info { int dummy; };
2351 SR_PRIV gboolean sr_brymen_bm25x_packet_valid(const uint8_t *buf);
2352 SR_PRIV int sr_brymen_bm25x_parse(const uint8_t *buf, float *floatval,
2353 struct sr_datafeed_analog *analog, void *info);
2355 /*--- dmm/bm52x.c -----------------------------------------------------------*/
2357 #define BRYMEN_BM52X_PACKET_SIZE 24
2358 #define BRYMEN_BM52X_DISPLAY_COUNT 2
2360 struct brymen_bm52x_info { size_t ch_idx; };
2362 #ifdef HAVE_SERIAL_COMM
2363 SR_PRIV int sr_brymen_bm52x_packet_request(struct sr_serial_dev_inst *serial);
2364 SR_PRIV int sr_brymen_bm82x_packet_request(struct sr_serial_dev_inst *serial);
2366 SR_PRIV gboolean sr_brymen_bm52x_packet_valid(const uint8_t *buf);
2367 SR_PRIV gboolean sr_brymen_bm82x_packet_valid(const uint8_t *buf);
2368 /* BM520s and BM820s protocols are similar, the parse routine is shared. */
2369 SR_PRIV int sr_brymen_bm52x_parse(const uint8_t *buf, float *floatval,
2370 struct sr_datafeed_analog *analog, void *info);
2372 struct brymen_bm52x_state;
2374 SR_PRIV void *brymen_bm52x_state_init(void);
2375 SR_PRIV void brymen_bm52x_state_free(void *state);
2376 SR_PRIV int brymen_bm52x_config_get(void *state, uint32_t key, GVariant **data,
2377 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg);
2378 SR_PRIV int brymen_bm52x_config_set(void *state, uint32_t key, GVariant *data,
2379 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg);
2380 SR_PRIV int brymen_bm52x_config_list(void *state, uint32_t key, GVariant **data,
2381 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg);
2382 SR_PRIV int brymen_bm52x_acquire_start(void *state,
2383 const struct sr_dev_inst *sdi,
2384 sr_receive_data_callback *cb, void **cb_data);
2386 /*--- dmm/bm85x.c -----------------------------------------------------------*/
2388 #define BRYMEN_BM85x_PACKET_SIZE_MIN 4
2390 struct brymen_bm85x_info { int dummy; };
2392 #ifdef HAVE_SERIAL_COMM
2393 SR_PRIV int brymen_bm85x_after_open(struct sr_serial_dev_inst *serial);
2394 SR_PRIV int brymen_bm85x_packet_request(struct sr_serial_dev_inst *serial);
2396 SR_PRIV gboolean brymen_bm85x_packet_valid(void *state,
2397 const uint8_t *buf, size_t len, size_t *pkt_len);
2398 SR_PRIV int brymen_bm85x_parse(void *state, const uint8_t *buf, size_t len,
2399 double *floatval, struct sr_datafeed_analog *analog, void *info);
2401 /*--- dmm/bm86x.c -----------------------------------------------------------*/
2403 #define BRYMEN_BM86X_PACKET_SIZE 24
2404 #define BRYMEN_BM86X_DISPLAY_COUNT 2
2406 struct brymen_bm86x_info { size_t ch_idx; };
2408 #ifdef HAVE_SERIAL_COMM
2409 SR_PRIV int sr_brymen_bm86x_packet_request(struct sr_serial_dev_inst *serial);
2411 SR_PRIV gboolean sr_brymen_bm86x_packet_valid(const uint8_t *buf);
2412 SR_PRIV int sr_brymen_bm86x_parse(const uint8_t *buf, float *floatval,
2413 struct sr_datafeed_analog *analog, void *info);
2415 /*--- dmm/ut71x.c -----------------------------------------------------------*/
2417 #define UT71X_PACKET_SIZE 11
2420 gboolean is_voltage, is_resistance, is_capacitance, is_temperature;
2421 gboolean is_celsius, is_fahrenheit, is_current, is_continuity;
2422 gboolean is_diode, is_frequency, is_duty_cycle, is_dc, is_ac;
2423 gboolean is_auto, is_manual, is_sign, is_power, is_loop_current;
2426 SR_PRIV gboolean sr_ut71x_packet_valid(const uint8_t *buf);
2427 SR_PRIV int sr_ut71x_parse(const uint8_t *buf, float *floatval,
2428 struct sr_datafeed_analog *analog, void *info);
2430 /*--- dmm/vc870.c -----------------------------------------------------------*/
2432 #define VC870_PACKET_SIZE 23
2435 gboolean is_voltage, is_dc, is_ac, is_temperature, is_resistance;
2436 gboolean is_continuity, is_capacitance, is_diode, is_loop_current;
2437 gboolean is_current, is_micro, is_milli, is_power;
2438 gboolean is_power_factor_freq, is_power_apparent_power, is_v_a_rms_value;
2439 gboolean is_sign2, is_sign1, is_batt, is_ol1, is_max, is_min;
2440 gboolean is_maxmin, is_rel, is_ol2, is_open, is_manu, is_hold;
2441 gboolean is_light, is_usb, is_warning, is_auto_power, is_misplug_warn;
2442 gboolean is_lo, is_hi, is_open2;
2444 gboolean is_frequency, is_dual_display, is_auto;
2447 SR_PRIV gboolean sr_vc870_packet_valid(const uint8_t *buf);
2448 SR_PRIV int sr_vc870_parse(const uint8_t *buf, float *floatval,
2449 struct sr_datafeed_analog *analog, void *info);
2451 /*--- dmm/vc96.c ------------------------------------------------------------*/
2453 #define VC96_PACKET_SIZE 13
2457 gboolean is_ac, is_dc, is_resistance, is_diode, is_ampere, is_volt;
2458 gboolean is_ohm, is_micro, is_milli, is_kilo, is_mega, is_hfe;
2459 gboolean is_unitless;
2462 SR_PRIV gboolean sr_vc96_packet_valid(const uint8_t *buf);
2463 SR_PRIV int sr_vc96_parse(const uint8_t *buf, float *floatval,
2464 struct sr_datafeed_analog *analog, void *info);
2466 /*--- lcr/es51919.c ---------------------------------------------------------*/
2468 /* Acquisition details which apply to all supported serial-lcr devices. */
2469 struct lcr_parse_info {
2471 uint64_t output_freq;
2472 const char *circuit_model;
2475 #define ES51919_PACKET_SIZE 17
2476 #define ES51919_CHANNEL_COUNT 2
2477 #define ES51919_COMM_PARAM "9600/8n1/rts=1/dtr=1"
2479 SR_PRIV int es51919_config_get(uint32_t key, GVariant **data,
2480 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg);
2481 SR_PRIV int es51919_config_set(uint32_t key, GVariant *data,
2482 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg);
2483 SR_PRIV int es51919_config_list(uint32_t key, GVariant **data,
2484 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg);
2485 SR_PRIV gboolean es51919_packet_valid(const uint8_t *pkt);
2486 SR_PRIV int es51919_packet_parse(const uint8_t *pkt, float *floatval,
2487 struct sr_datafeed_analog *analog, void *info);
2489 /*--- lcr/vc4080.c ----------------------------------------------------------*/
2491 /* Note: Also uses 'struct lcr_parse_info' from es51919 above. */
2493 #define VC4080_PACKET_SIZE 39
2494 #define VC4080_COMM_PARAM "1200/8n1"
2495 #define VC4080_WITH_DQ_CHANS 0 /* Enable separate D/Q channels? */
2497 enum vc4080_display {
2498 VC4080_DISPLAY_PRIMARY,
2499 VC4080_DISPLAY_SECONDARY,
2500 #if VC4080_WITH_DQ_CHANS
2501 VC4080_DISPLAY_D_VALUE,
2502 VC4080_DISPLAY_Q_VALUE,
2504 VC4080_CHANNEL_COUNT,
2507 extern SR_PRIV const char *vc4080_channel_formats[VC4080_CHANNEL_COUNT];
2509 SR_PRIV int vc4080_config_list(uint32_t key, GVariant **data,
2510 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg);
2511 SR_PRIV int vc4080_packet_request(struct sr_serial_dev_inst *serial);
2512 SR_PRIV gboolean vc4080_packet_valid(const uint8_t *pkt);
2513 SR_PRIV int vc4080_packet_parse(const uint8_t *pkt, float *floatval,
2514 struct sr_datafeed_analog *analog, void *info);
2516 /*--- dmm/ut372.c -----------------------------------------------------------*/
2518 #define UT372_PACKET_SIZE 27
2524 SR_PRIV gboolean sr_ut372_packet_valid(const uint8_t *buf);
2525 SR_PRIV int sr_ut372_parse(const uint8_t *buf, float *floatval,
2526 struct sr_datafeed_analog *analog, void *info);
2528 /*--- dmm/asycii.c ----------------------------------------------------------*/
2530 #define ASYCII_PACKET_SIZE 16
2532 struct asycii_info {
2533 gboolean is_ac, is_dc, is_ac_and_dc;
2534 gboolean is_resistance, is_capacitance, is_diode, is_gain;
2535 gboolean is_frequency, is_duty_cycle, is_duty_pos, is_duty_neg;
2536 gboolean is_pulse_width, is_period_pos, is_period_neg;
2537 gboolean is_pulse_count, is_count_pos, is_count_neg;
2538 gboolean is_ampere, is_volt, is_volt_ampere, is_farad, is_ohm;
2539 gboolean is_hertz, is_percent, is_seconds, is_decibel;
2540 gboolean is_pico, is_nano, is_micro, is_milli, is_kilo, is_mega;
2541 gboolean is_unitless;
2542 gboolean is_peak_min, is_peak_max;
2543 gboolean is_invalid;
2546 #ifdef HAVE_SERIAL_COMM
2547 SR_PRIV int sr_asycii_packet_request(struct sr_serial_dev_inst *serial);
2549 SR_PRIV gboolean sr_asycii_packet_valid(const uint8_t *buf);
2550 SR_PRIV int sr_asycii_parse(const uint8_t *buf, float *floatval,
2551 struct sr_datafeed_analog *analog, void *info);
2553 /*--- dmm/eev121gw.c --------------------------------------------------------*/
2555 #define EEV121GW_PACKET_SIZE 19
2557 enum eev121gw_display {
2558 EEV121GW_DISPLAY_MAIN,
2559 EEV121GW_DISPLAY_SUB,
2560 EEV121GW_DISPLAY_BAR,
2561 EEV121GW_DISPLAY_COUNT,
2564 struct eev121gw_info {
2565 /* Selected channel. */
2568 * Measured value, number and sign/overflow flags, scale factor
2569 * and significant digits.
2571 uint32_t uint_value;
2572 gboolean is_ofl, is_neg;
2574 /* Currently active mode (meter's function). */
2575 gboolean is_ac, is_dc, is_voltage, is_current, is_power, is_gain;
2576 gboolean is_resistance, is_capacitance, is_diode, is_temperature;
2577 gboolean is_continuity, is_frequency, is_period, is_duty_cycle;
2578 /* Quantities associated with mode/function. */
2579 gboolean is_ampere, is_volt, is_volt_ampere, is_dbm;
2580 gboolean is_ohm, is_farad, is_celsius, is_fahrenheit;
2581 gboolean is_hertz, is_seconds, is_percent, is_loop_current;
2582 gboolean is_unitless, is_logic;
2583 /* Other indicators. */
2584 gboolean is_min, is_max, is_avg, is_1ms_peak, is_rel, is_hold;
2585 gboolean is_low_pass, is_mem, is_bt, is_auto_range, is_test;
2586 gboolean is_auto_poweroff, is_low_batt;
2589 extern SR_PRIV const char *eev121gw_channel_formats[];
2590 SR_PRIV gboolean sr_eev121gw_packet_valid(const uint8_t *buf);
2591 SR_PRIV int sr_eev121gw_3displays_parse(const uint8_t *buf, float *floatval,
2592 struct sr_datafeed_analog *analog, void *info);
2594 /*--- scale/kern.c ----------------------------------------------------------*/
2597 gboolean is_gram, is_carat, is_ounce, is_pound, is_troy_ounce;
2598 gboolean is_pennyweight, is_grain, is_tael, is_momme, is_tola;
2599 gboolean is_percentage, is_piece, is_unstable, is_stable, is_error;
2603 SR_PRIV gboolean sr_kern_packet_valid(const uint8_t *buf);
2604 SR_PRIV int sr_kern_parse(const uint8_t *buf, float *floatval,
2605 struct sr_datafeed_analog *analog, void *info);
2607 /*--- sw_limits.c -----------------------------------------------------------*/
2609 struct sr_sw_limits {
2610 uint64_t limit_samples;
2611 uint64_t limit_frames;
2612 uint64_t limit_msec;
2613 uint64_t samples_read;
2614 uint64_t frames_read;
2615 uint64_t start_time;
2618 SR_PRIV int sr_sw_limits_config_get(const struct sr_sw_limits *limits, uint32_t key,
2620 SR_PRIV int sr_sw_limits_config_set(struct sr_sw_limits *limits, uint32_t key,
2622 SR_PRIV void sr_sw_limits_acquisition_start(struct sr_sw_limits *limits);
2623 SR_PRIV gboolean sr_sw_limits_check(struct sr_sw_limits *limits);
2624 SR_PRIV void sr_sw_limits_update_samples_read(struct sr_sw_limits *limits,
2625 uint64_t samples_read);
2626 SR_PRIV void sr_sw_limits_update_frames_read(struct sr_sw_limits *limits,
2627 uint64_t frames_read);
2628 SR_PRIV void sr_sw_limits_init(struct sr_sw_limits *limits);
2630 /*--- feed_queue.h ----------------------------------------------------------*/
2632 struct feed_queue_logic;
2633 struct feed_queue_analog;
2635 SR_API struct feed_queue_logic *feed_queue_logic_alloc(
2636 struct sr_dev_inst *sdi,
2637 size_t sample_count, size_t unit_size);
2638 SR_API int feed_queue_logic_submit(struct feed_queue_logic *q,
2639 const uint8_t *data, size_t count);
2640 SR_API int feed_queue_logic_flush(struct feed_queue_logic *q);
2641 SR_API void feed_queue_logic_free(struct feed_queue_logic *q);
2643 SR_API struct feed_queue_analog *feed_queue_analog_alloc(
2644 struct sr_dev_inst *sdi,
2645 size_t sample_count, int digits, struct sr_channel *ch);
2646 SR_API int feed_queue_analog_submit(struct feed_queue_analog *q,
2647 float data, size_t count);
2648 SR_API int feed_queue_analog_flush(struct feed_queue_analog *q);
2649 SR_API void feed_queue_analog_free(struct feed_queue_analog *q);