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"
970 #if !defined SR_DRIVER_LIST_NOREORDER && defined __has_attribute
971 #if __has_attribute(no_reorder)
972 #define SR_DRIVER_LIST_NOREORDER __attribute__((no_reorder))
975 #if !defined SR_DRIVER_LIST_NOREORDER
976 #define SR_DRIVER_LIST_NOREORDER /* EMPTY */
980 * Register a list of hardware drivers.
982 * This macro can be used to register multiple hardware drivers to the library.
983 * This is useful when a driver supports multiple similar but slightly
984 * different devices that require different sr_dev_driver struct definitions.
986 * For registering only a single driver see SR_REGISTER_DEV_DRIVER().
990 * #define MY_DRIVER(_name) \
991 * &(struct sr_dev_driver){ \
996 * SR_REGISTER_DEV_DRIVER_LIST(my_driver_infos,
997 * MY_DRIVER("driver 1"),
998 * MY_DRIVER("driver 2"),
1003 * @param name Name to use for the driver list identifier.
1004 * @param ... Comma separated list of pointers to sr_dev_driver structs.
1006 #define SR_REGISTER_DEV_DRIVER_LIST(name, ...) \
1007 static const struct sr_dev_driver *name[] \
1008 SR_DRIVER_LIST_NOREORDER \
1009 __attribute__((section (SR_DRIVER_LIST_SECTION), used, \
1010 aligned(sizeof(struct sr_dev_driver *)))) \
1016 * Register a hardware driver.
1018 * This macro is used to register a hardware driver with the library. It has
1019 * to be used in order to make the driver accessible to applications using the
1022 * The macro invocation should be placed directly under the struct
1023 * sr_dev_driver definition.
1027 * static struct sr_dev_driver driver_info = {
1031 * SR_REGISTER_DEV_DRIVER(driver_info);
1034 * @param name Identifier name of sr_dev_driver struct to register.
1036 #define SR_REGISTER_DEV_DRIVER(name) \
1037 SR_REGISTER_DEV_DRIVER_LIST(name##_list, &name);
1039 SR_API void sr_drivers_init(struct sr_context *context);
1042 struct sr_dev_driver **driver_list;
1043 #ifdef HAVE_LIBUSB_1_0
1044 libusb_context *libusb_ctx;
1046 sr_resource_open_callback resource_open_cb;
1047 sr_resource_close_callback resource_close_cb;
1048 sr_resource_read_callback resource_read_cb;
1049 void *resource_cb_data;
1052 /** Input module metadata keys. */
1053 enum sr_input_meta_keys {
1054 /** The input filename, if there is one. */
1055 SR_INPUT_META_FILENAME = 0x01,
1056 /** The input file's size in bytes. */
1057 SR_INPUT_META_FILESIZE = 0x02,
1058 /** The first 128 bytes of the file, provided as a GString. */
1059 SR_INPUT_META_HEADER = 0x04,
1061 /** The module cannot identify a file without this metadata. */
1062 SR_INPUT_META_REQUIRED = 0x80,
1065 /** Input (file) module struct. */
1068 * A pointer to this input module's 'struct sr_input_module'.
1070 const struct sr_input_module *module;
1072 struct sr_dev_inst *sdi;
1077 /** Input (file) module driver. */
1078 struct sr_input_module {
1080 * A unique ID for this input module, suitable for use in command-line
1081 * clients, [a-z0-9-]. Must not be NULL.
1086 * A unique name for this input module, suitable for use in GUI
1087 * clients, can contain UTF-8. Must not be NULL.
1092 * A short description of the input module. Must not be NULL.
1094 * This can be displayed by frontends, e.g. when selecting the input
1095 * module for saving a file.
1100 * A NULL terminated array of strings containing a list of file name
1101 * extensions typical for the input file format, or NULL if there is
1102 * no typical extension for this file format.
1104 const char *const *exts;
1107 * Zero-terminated list of metadata items the module needs to be able
1108 * to identify an input stream. Can be all-zero, if the module cannot
1109 * identify streams at all, i.e. has to be forced into use.
1111 * Each item is one of:
1112 * SR_INPUT_META_FILENAME
1113 * SR_INPUT_META_FILESIZE
1114 * SR_INPUT_META_HEADER
1116 * If the high bit (SR_INPUT META_REQUIRED) is set, the module cannot
1117 * identify a stream without the given metadata.
1119 const uint8_t metadata[8];
1122 * Returns a NULL-terminated list of options this module can take.
1123 * Can be NULL, if the module has no options.
1125 const struct sr_option *(*options) (void);
1128 * Check if this input module can load and parse the specified stream.
1130 * @param[in] metadata Metadata the module can use to identify the stream.
1131 * @param[out] confidence "Strength" of the detection.
1132 * Specialized handlers can take precedence over generic/basic support.
1134 * @retval SR_OK This module knows the format.
1135 * @retval SR_ERR_NA There wasn't enough data for this module to
1136 * positively identify the format.
1137 * @retval SR_ERR_DATA This module knows the format, but cannot handle
1138 * it. This means the stream is either corrupt, or indicates a
1139 * feature that the module does not support.
1140 * @retval SR_ERR This module does not know the format.
1142 * Lower numeric values of 'confidence' mean that the input module
1143 * stronger believes in its capability to handle this specific format.
1144 * This way, multiple input modules can claim support for a format,
1145 * and the application can pick the best match, or try fallbacks
1146 * in case of errors. This approach also copes with formats that
1147 * are unreliable to detect in the absence of magic signatures.
1149 int (*format_match) (GHashTable *metadata, unsigned int *confidence);
1152 * Initialize the input module.
1154 * @retval SR_OK Success
1155 * @retval other Negative error code.
1157 int (*init) (struct sr_input *in, GHashTable *options);
1160 * Send data to the specified input instance.
1162 * When an input module instance is created with sr_input_new(), this
1163 * function is used to feed data to the instance.
1165 * As enough data gets fed into this function to completely populate
1166 * the device instance associated with this input instance, this is
1167 * guaranteed to return the moment it's ready. This gives the caller
1168 * the chance to examine the device instance, attach session callbacks
1171 * @retval SR_OK Success
1172 * @retval other Negative error code.
1174 int (*receive) (struct sr_input *in, GString *buf);
1177 * Signal the input module no more data will come.
1179 * This will cause the module to process any data it may have buffered.
1180 * The SR_DF_END packet will also typically be sent at this time.
1182 int (*end) (struct sr_input *in);
1185 * Reset the input module's input handling structures.
1187 * Causes the input module to reset its internal state so that we can
1188 * re-send the input data from the beginning without having to
1189 * re-create the entire input module.
1191 * @retval SR_OK Success.
1192 * @retval other Negative error code.
1194 int (*reset) (struct sr_input *in);
1197 * This function is called after the caller is finished using
1198 * the input module, and can be used to free any internal
1199 * resources the module may keep.
1201 * This function is optional.
1203 * @retval SR_OK Success
1204 * @retval other Negative error code.
1206 void (*cleanup) (struct sr_input *in);
1209 /** Output module instance. */
1211 /** A pointer to this output's module. */
1212 const struct sr_output_module *module;
1215 * The device for which this output module is creating output. This
1216 * can be used by the module to find out channel names and numbers.
1218 const struct sr_dev_inst *sdi;
1221 * The name of the file that the data should be written to.
1223 const char *filename;
1226 * A generic pointer which can be used by the module to keep internal
1227 * state between calls into its callback functions.
1229 * For example, the module might store a pointer to a chunk of output
1230 * there, and only flush it when it reaches a certain size.
1235 /** Output module driver. */
1236 struct sr_output_module {
1238 * A unique ID for this output module, suitable for use in command-line
1239 * clients, [a-z0-9-]. Must not be NULL.
1244 * A unique name for this output module, suitable for use in GUI
1245 * clients, can contain UTF-8. Must not be NULL.
1250 * A short description of the output module. Must not be NULL.
1252 * This can be displayed by frontends, e.g. when selecting the output
1253 * module for saving a file.
1258 * A NULL terminated array of strings containing a list of file name
1259 * extensions typical for the input file format, or NULL if there is
1260 * no typical extension for this file format.
1262 const char *const *exts;
1265 * Bitfield containing flags that describe certain properties
1266 * this output module may or may not have.
1267 * @see sr_output_flags
1269 const uint64_t flags;
1272 * Returns a NULL-terminated list of options this module can take.
1273 * Can be NULL, if the module has no options.
1275 const struct sr_option *(*options) (void);
1278 * This function is called once, at the beginning of an output stream.
1280 * The device struct will be available in the output struct passed in,
1281 * as well as the param field -- which may be NULL or an empty string,
1282 * if no parameter was passed.
1284 * The module can use this to initialize itself, create a struct for
1285 * keeping state and storing it in the <code>internal</code> field.
1287 * @param o Pointer to the respective 'struct sr_output'.
1289 * @retval SR_OK Success
1290 * @retval other Negative error code.
1292 int (*init) (struct sr_output *o, GHashTable *options);
1295 * This function is passed a copy of every packet in the data feed.
1296 * Any output generated by the output module in response to the
1297 * packet should be returned in a newly allocated GString
1298 * <code>out</code>, which will be freed by the caller.
1300 * Packets not of interest to the output module can just be ignored,
1301 * and the <code>out</code> parameter set to NULL.
1303 * @param o Pointer to the respective 'struct sr_output'.
1304 * @param sdi The device instance that generated the packet.
1305 * @param packet The complete packet.
1306 * @param out A pointer where a GString * should be stored if
1307 * the module generates output, or NULL if not.
1309 * @retval SR_OK Success
1310 * @retval other Negative error code.
1312 int (*receive) (const struct sr_output *o,
1313 const struct sr_datafeed_packet *packet, GString **out);
1316 * This function is called after the caller is finished using
1317 * the output module, and can be used to free any internal
1318 * resources the module may keep.
1320 * @retval SR_OK Success
1321 * @retval other Negative error code.
1323 int (*cleanup) (struct sr_output *o);
1326 /** Transform module instance. */
1327 struct sr_transform {
1328 /** A pointer to this transform's module. */
1329 const struct sr_transform_module *module;
1332 * The device for which this transform module is used. This
1333 * can be used by the module to find out channel names and numbers.
1335 const struct sr_dev_inst *sdi;
1338 * A generic pointer which can be used by the module to keep internal
1339 * state between calls into its callback functions.
1344 struct sr_transform_module {
1346 * A unique ID for this transform module, suitable for use in
1347 * command-line clients, [a-z0-9-]. Must not be NULL.
1352 * A unique name for this transform module, suitable for use in GUI
1353 * clients, can contain UTF-8. Must not be NULL.
1358 * A short description of the transform module. Must not be NULL.
1360 * This can be displayed by frontends, e.g. when selecting
1361 * which transform module(s) to add.
1366 * Returns a NULL-terminated list of options this transform module
1367 * can take. Can be NULL, if the transform module has no options.
1369 const struct sr_option *(*options) (void);
1372 * This function is called once, at the beginning of a stream.
1374 * @param t Pointer to the respective 'struct sr_transform'.
1375 * @param options Hash table of options for this transform module.
1376 * Can be NULL if no options are to be used.
1378 * @retval SR_OK Success
1379 * @retval other Negative error code.
1381 int (*init) (struct sr_transform *t, GHashTable *options);
1384 * This function is passed a pointer to every packet in the data feed.
1386 * It can either return (in packet_out) a pointer to another packet
1387 * (possibly the exact same packet it got as input), or NULL.
1389 * @param t Pointer to the respective 'struct sr_transform'.
1390 * @param packet_in Pointer to a datafeed packet.
1391 * @param packet_out Pointer to the resulting datafeed packet after
1392 * this function was run. If NULL, the transform
1393 * module intentionally didn't output a new packet.
1395 * @retval SR_OK Success
1396 * @retval other Negative error code.
1398 int (*receive) (const struct sr_transform *t,
1399 struct sr_datafeed_packet *packet_in,
1400 struct sr_datafeed_packet **packet_out);
1403 * This function is called after the caller is finished using
1404 * the transform module, and can be used to free any internal
1405 * resources the module may keep.
1407 * @retval SR_OK Success
1408 * @retval other Negative error code.
1410 int (*cleanup) (struct sr_transform *t);
1413 #ifdef HAVE_LIBUSB_1_0
1414 /** USB device instance */
1415 struct sr_usb_dev_inst {
1418 /** Device address on USB bus */
1420 /** libusb device handle */
1421 struct libusb_device_handle *devhdl;
1425 struct sr_serial_dev_inst;
1426 #ifdef HAVE_SERIAL_COMM
1427 struct ser_lib_functions;
1428 struct ser_hid_chip_functions;
1430 typedef void (*serial_rx_chunk_callback)(struct sr_serial_dev_inst *serial,
1431 void *cb_data, const void *buf, size_t count);
1432 struct sr_serial_dev_inst {
1433 /** Port name, e.g. '/dev/tty42'. */
1435 /** Comm params for serial_set_paramstr(). */
1437 struct ser_lib_functions *lib_funcs;
1444 GString *rcv_buffer;
1445 serial_rx_chunk_callback rx_chunk_cb_func;
1446 void *rx_chunk_cb_data;
1447 #ifdef HAVE_LIBSERIALPORT
1448 /** libserialport port handle */
1449 struct sp_port *sp_data;
1451 #ifdef HAVE_LIBHIDAPI
1452 enum ser_hid_chip_t {
1453 SER_HID_CHIP_UNKNOWN, /**!< place holder */
1454 SER_HID_CHIP_BTC_BU86X, /**!< Brymen BU86x */
1455 SER_HID_CHIP_SIL_CP2110, /**!< SiLabs CP2110 */
1456 SER_HID_CHIP_VICTOR_DMM, /**!< Victor 70/86 DMM cable */
1457 SER_HID_CHIP_WCH_CH9325, /**!< WCH CH9325 */
1458 SER_HID_CHIP_LAST, /**!< sentinel */
1460 struct ser_hid_chip_functions *hid_chip_funcs;
1463 const char *hid_path;
1464 hid_device *hid_dev;
1465 GSList *hid_source_args;
1467 #ifdef HAVE_BLUETOOTH
1468 enum ser_bt_conn_t {
1469 SER_BT_CONN_UNKNOWN, /**!< place holder */
1470 SER_BT_CONN_RFCOMM, /**!< BT classic, RFCOMM channel */
1471 SER_BT_CONN_BLE122, /**!< BLE, BLE122 module, indications */
1472 SER_BT_CONN_NRF51, /**!< BLE, Nordic nRF51, notifications */
1473 SER_BT_CONN_CC254x, /**!< BLE, TI CC254x, notifications */
1474 SER_BT_CONN_MAX, /**!< sentinel */
1476 char *bt_addr_local;
1477 char *bt_addr_remote;
1478 size_t bt_rfcomm_channel;
1479 uint16_t bt_notify_handle_read;
1480 uint16_t bt_notify_handle_write;
1481 uint16_t bt_notify_handle_cccd;
1482 uint16_t bt_notify_value_cccd;
1483 struct sr_bt_desc *bt_desc;
1484 GSList *bt_source_args;
1489 struct sr_usbtmc_dev_inst {
1494 /* Private driver context. */
1495 struct drv_context {
1496 /** sigrok context */
1497 struct sr_context *sr_ctx;
1501 /*--- log.c -----------------------------------------------------------------*/
1503 #if defined(_WIN32) && (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 4))
1505 * On MinGW, we need to specify the gnu_printf format flavor or GCC
1506 * will assume non-standard Microsoft printf syntax.
1508 SR_PRIV int sr_log(int loglevel, const char *format, ...)
1509 __attribute__((__format__ (__gnu_printf__, 2, 3)));
1511 SR_PRIV int sr_log(int loglevel, const char *format, ...) G_GNUC_PRINTF(2, 3);
1514 /* Message logging helpers with subsystem-specific prefix string. */
1515 #define sr_spew(...) sr_log(SR_LOG_SPEW, LOG_PREFIX ": " __VA_ARGS__)
1516 #define sr_dbg(...) sr_log(SR_LOG_DBG, LOG_PREFIX ": " __VA_ARGS__)
1517 #define sr_info(...) sr_log(SR_LOG_INFO, LOG_PREFIX ": " __VA_ARGS__)
1518 #define sr_warn(...) sr_log(SR_LOG_WARN, LOG_PREFIX ": " __VA_ARGS__)
1519 #define sr_err(...) sr_log(SR_LOG_ERR, LOG_PREFIX ": " __VA_ARGS__)
1521 /*--- device.c --------------------------------------------------------------*/
1523 /** Scan options supported by a driver. */
1524 #define SR_CONF_SCAN_OPTIONS 0x7FFF0000
1526 /** Device options for a particular device. */
1527 #define SR_CONF_DEVICE_OPTIONS 0x7FFF0001
1529 /** Mask for separating config keys from capabilities. */
1530 #define SR_CONF_MASK 0x1fffffff
1532 /** Values for the changes argument of sr_dev_driver.config_channel_set. */
1534 /** The enabled state of the channel has been changed. */
1535 SR_CHANNEL_SET_ENABLED = 1 << 0,
1538 SR_PRIV struct sr_channel *sr_channel_new(struct sr_dev_inst *sdi,
1539 int index, int type, gboolean enabled, const char *name);
1540 SR_PRIV void sr_channel_free(struct sr_channel *ch);
1541 SR_PRIV void sr_channel_free_cb(void *p);
1542 SR_PRIV struct sr_channel *sr_next_enabled_channel(const struct sr_dev_inst *sdi,
1543 struct sr_channel *cur_channel);
1544 SR_PRIV gboolean sr_channels_differ(struct sr_channel *ch1, struct sr_channel *ch2);
1545 SR_PRIV gboolean sr_channel_lists_differ(GSList *l1, GSList *l2);
1547 /** Device instance data */
1548 struct sr_dev_inst {
1549 /** Device driver. */
1550 struct sr_dev_driver *driver;
1551 /** Device instance status. SR_ST_NOT_FOUND, etc. */
1553 /** Device instance type. SR_INST_USB, etc. */
1555 /** Device vendor. */
1557 /** Device model. */
1559 /** Device version. */
1561 /** Serial number. */
1563 /** Connection string to uniquely identify devices. */
1564 char *connection_id;
1565 /** List of channels. */
1567 /** List of sr_channel_group structs */
1568 GSList *channel_groups;
1569 /** Device instance connection data (used?) */
1571 /** Device instance private data (used?) */
1573 /** Session to which this device is currently assigned. */
1574 struct sr_session *session;
1577 /* Generic device instances */
1578 SR_PRIV void sr_dev_inst_free(struct sr_dev_inst *sdi);
1580 #ifdef HAVE_LIBUSB_1_0
1581 /* USB-specific instances */
1582 SR_PRIV struct sr_usb_dev_inst *sr_usb_dev_inst_new(uint8_t bus,
1583 uint8_t address, struct libusb_device_handle *hdl);
1584 SR_PRIV void sr_usb_dev_inst_free(struct sr_usb_dev_inst *usb);
1587 #ifdef HAVE_SERIAL_COMM
1588 #ifndef HAVE_LIBSERIALPORT
1590 * Some identifiers which initially got provided by libserialport are
1591 * used internally within the libsigrok serial layer's implementation,
1592 * while libserialport no longer is the exclusive provider of serial
1593 * communication support. Declare the identifiers here so they remain
1594 * available across all build configurations.
1601 SP_PARITY_SPACE = 4,
1604 enum libsp_flowcontrol {
1605 SP_FLOWCONTROL_NONE = 0,
1606 SP_FLOWCONTROL_XONXOFF = 1,
1607 SP_FLOWCONTROL_RTSCTS = 2,
1608 SP_FLOWCONTROL_DTRDSR = 3,
1612 /* Serial-specific instances */
1613 SR_PRIV struct sr_serial_dev_inst *sr_serial_dev_inst_new(const char *port,
1614 const char *serialcomm);
1615 SR_PRIV void sr_serial_dev_inst_free(struct sr_serial_dev_inst *serial);
1618 /* USBTMC-specific instances */
1619 SR_PRIV struct sr_usbtmc_dev_inst *sr_usbtmc_dev_inst_new(const char *device);
1620 SR_PRIV void sr_usbtmc_dev_inst_free(struct sr_usbtmc_dev_inst *usbtmc);
1622 /*--- hwdriver.c ------------------------------------------------------------*/
1624 SR_PRIV const GVariantType *sr_variant_type_get(int datatype);
1625 SR_PRIV int sr_variant_type_check(uint32_t key, GVariant *data);
1626 SR_PRIV void sr_hw_cleanup_all(const struct sr_context *ctx);
1627 SR_PRIV struct sr_config *sr_config_new(uint32_t key, GVariant *data);
1628 SR_PRIV void sr_config_free(struct sr_config *src);
1629 SR_PRIV int sr_dev_acquisition_start(struct sr_dev_inst *sdi);
1630 SR_PRIV int sr_dev_acquisition_stop(struct sr_dev_inst *sdi);
1632 /*--- session.c -------------------------------------------------------------*/
1635 /** Context this session exists in. */
1636 struct sr_context *ctx;
1637 /** List of struct sr_dev_inst pointers. */
1639 /** List of struct sr_dev_inst pointers owned by this session. */
1641 /** List of struct datafeed_callback pointers. */
1642 GSList *datafeed_callbacks;
1644 struct sr_trigger *trigger;
1646 /** Callback to invoke on session stop. */
1647 sr_session_stopped_callback stopped_callback;
1648 /** User data to be passed to the session stop callback. */
1649 void *stopped_cb_data;
1651 /** Mutex protecting the main context pointer. */
1653 /** Context of the session main loop. */
1654 GMainContext *main_context;
1656 /** Registered event sources for this session. */
1657 GHashTable *event_sources;
1658 /** Session main loop. */
1659 GMainLoop *main_loop;
1660 /** ID of idle source for dispatching the session stop notification. */
1661 unsigned int stop_check_id;
1662 /** Whether the session has been started. */
1666 SR_PRIV int sr_session_source_add_internal(struct sr_session *session,
1667 void *key, GSource *source);
1668 SR_PRIV int sr_session_source_remove_internal(struct sr_session *session,
1670 SR_PRIV int sr_session_source_destroyed(struct sr_session *session,
1671 void *key, GSource *source);
1672 SR_PRIV int sr_session_fd_source_add(struct sr_session *session,
1673 void *key, gintptr fd, int events, int timeout,
1674 sr_receive_data_callback cb, void *cb_data);
1676 SR_PRIV int sr_session_source_add(struct sr_session *session, int fd,
1677 int events, int timeout, sr_receive_data_callback cb, void *cb_data);
1678 SR_PRIV int sr_session_source_add_pollfd(struct sr_session *session,
1679 GPollFD *pollfd, int timeout, sr_receive_data_callback cb,
1681 SR_PRIV int sr_session_source_add_channel(struct sr_session *session,
1682 GIOChannel *channel, int events, int timeout,
1683 sr_receive_data_callback cb, void *cb_data);
1684 SR_PRIV int sr_session_source_remove(struct sr_session *session, int fd);
1685 SR_PRIV int sr_session_source_remove_pollfd(struct sr_session *session,
1687 SR_PRIV int sr_session_source_remove_channel(struct sr_session *session,
1688 GIOChannel *channel);
1690 SR_PRIV int sr_session_send_meta(const struct sr_dev_inst *sdi,
1691 uint32_t key, GVariant *var);
1692 SR_PRIV int sr_session_send(const struct sr_dev_inst *sdi,
1693 const struct sr_datafeed_packet *packet);
1694 SR_PRIV int sr_sessionfile_check(const char *filename);
1695 SR_PRIV struct sr_dev_inst *sr_session_prepare_sdi(const char *filename,
1696 struct sr_session **session);
1698 /*--- session_file.c --------------------------------------------------------*/
1700 #if !HAVE_ZIP_DISCARD
1701 /* Replace zip_discard() if not available. */
1702 #define zip_discard(zip) sr_zip_discard(zip)
1703 SR_PRIV void sr_zip_discard(struct zip *archive);
1706 SR_PRIV GKeyFile *sr_sessionfile_read_metadata(struct zip *archive,
1707 const struct zip_stat *entry);
1709 /*--- analog.c --------------------------------------------------------------*/
1711 SR_PRIV int sr_analog_init(struct sr_datafeed_analog *analog,
1712 struct sr_analog_encoding *encoding,
1713 struct sr_analog_meaning *meaning,
1714 struct sr_analog_spec *spec,
1717 /*--- std.c -----------------------------------------------------------------*/
1719 typedef int (*dev_close_callback)(struct sr_dev_inst *sdi);
1720 typedef void (*std_dev_clear_callback)(void *priv);
1722 SR_PRIV int std_init(struct sr_dev_driver *di, struct sr_context *sr_ctx);
1723 SR_PRIV int std_cleanup(const struct sr_dev_driver *di);
1724 SR_PRIV int std_dummy_dev_open(struct sr_dev_inst *sdi);
1725 SR_PRIV int std_dummy_dev_close(struct sr_dev_inst *sdi);
1726 SR_PRIV int std_dummy_dev_acquisition_start(const struct sr_dev_inst *sdi);
1727 SR_PRIV int std_dummy_dev_acquisition_stop(struct sr_dev_inst *sdi);
1728 #ifdef HAVE_SERIAL_COMM
1729 SR_PRIV int std_serial_dev_open(struct sr_dev_inst *sdi);
1730 SR_PRIV int std_serial_dev_acquisition_stop(struct sr_dev_inst *sdi);
1732 SR_PRIV int std_session_send_df_header(const struct sr_dev_inst *sdi);
1733 SR_PRIV int std_session_send_df_end(const struct sr_dev_inst *sdi);
1734 SR_PRIV int std_session_send_df_trigger(const struct sr_dev_inst *sdi);
1735 SR_PRIV int std_session_send_df_frame_begin(const struct sr_dev_inst *sdi);
1736 SR_PRIV int std_session_send_df_frame_end(const struct sr_dev_inst *sdi);
1737 SR_PRIV int std_dev_clear_with_callback(const struct sr_dev_driver *driver,
1738 std_dev_clear_callback clear_private);
1739 SR_PRIV int std_dev_clear(const struct sr_dev_driver *driver);
1740 SR_PRIV GSList *std_dev_list(const struct sr_dev_driver *di);
1741 SR_PRIV int std_serial_dev_close(struct sr_dev_inst *sdi);
1742 SR_PRIV GSList *std_scan_complete(struct sr_dev_driver *di, GSList *devices);
1744 SR_PRIV int std_opts_config_list(uint32_t key, GVariant **data,
1745 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg,
1746 const uint32_t scanopts[], size_t scansize, const uint32_t drvopts[],
1747 size_t drvsize, const uint32_t devopts[], size_t devsize);
1749 extern SR_PRIV const uint32_t NO_OPTS[1];
1751 #define STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts) \
1752 std_opts_config_list(key, data, sdi, cg, ARRAY_AND_SIZE(scanopts), \
1753 ARRAY_AND_SIZE(drvopts), ARRAY_AND_SIZE(devopts))
1755 SR_PRIV GVariant *std_gvar_tuple_array(const uint64_t a[][2], unsigned int n);
1756 SR_PRIV GVariant *std_gvar_tuple_rational(const struct sr_rational *r, unsigned int n);
1757 SR_PRIV GVariant *std_gvar_samplerates(const uint64_t samplerates[], unsigned int n);
1758 SR_PRIV GVariant *std_gvar_samplerates_steps(const uint64_t samplerates[], unsigned int n);
1759 SR_PRIV GVariant *std_gvar_min_max_step(double min, double max, double step);
1760 SR_PRIV GVariant *std_gvar_min_max_step_array(const double a[3]);
1761 SR_PRIV GVariant *std_gvar_min_max_step_thresholds(const double dmin, const double dmax, const double dstep);
1763 SR_PRIV GVariant *std_gvar_tuple_u64(uint64_t low, uint64_t high);
1764 SR_PRIV GVariant *std_gvar_tuple_double(double low, double high);
1766 SR_PRIV GVariant *std_gvar_array_i32(const int32_t a[], unsigned int n);
1767 SR_PRIV GVariant *std_gvar_array_u32(const uint32_t a[], unsigned int n);
1768 SR_PRIV GVariant *std_gvar_array_u64(const uint64_t a[], unsigned int n);
1769 SR_PRIV GVariant *std_gvar_array_str(const char *a[], unsigned int n);
1771 SR_PRIV GVariant *std_gvar_thresholds(const double a[][2], unsigned int n);
1773 SR_PRIV int std_str_idx(GVariant *data, const char *a[], unsigned int n);
1774 SR_PRIV int std_u64_idx(GVariant *data, const uint64_t a[], unsigned int n);
1775 SR_PRIV int std_u8_idx(GVariant *data, const uint8_t a[], unsigned int n);
1777 SR_PRIV int std_str_idx_s(const char *s, const char *a[], unsigned int n);
1778 SR_PRIV int std_u8_idx_s(uint8_t b, const uint8_t a[], unsigned int n);
1780 SR_PRIV int std_u64_tuple_idx(GVariant *data, const uint64_t a[][2], unsigned int n);
1781 SR_PRIV int std_double_tuple_idx(GVariant *data, const double a[][2], unsigned int n);
1782 SR_PRIV int std_double_tuple_idx_d0(const double d, const double a[][2], unsigned int n);
1784 SR_PRIV int std_cg_idx(const struct sr_channel_group *cg, struct sr_channel_group *a[], unsigned int n);
1786 SR_PRIV int std_dummy_set_params(struct sr_serial_dev_inst *serial,
1787 int baudrate, int bits, int parity, int stopbits,
1788 int flowcontrol, int rts, int dtr);
1789 SR_PRIV int std_dummy_set_handshake(struct sr_serial_dev_inst *serial,
1792 /*--- resource.c ------------------------------------------------------------*/
1794 SR_PRIV int64_t sr_file_get_size(FILE *file);
1796 SR_PRIV int sr_resource_open(struct sr_context *ctx,
1797 struct sr_resource *res, int type, const char *name)
1798 G_GNUC_WARN_UNUSED_RESULT;
1799 SR_PRIV int sr_resource_close(struct sr_context *ctx,
1800 struct sr_resource *res);
1801 SR_PRIV gssize sr_resource_read(struct sr_context *ctx,
1802 const struct sr_resource *res, void *buf, size_t count)
1803 G_GNUC_WARN_UNUSED_RESULT;
1804 SR_PRIV void *sr_resource_load(struct sr_context *ctx, int type,
1805 const char *name, size_t *size, size_t max_size)
1806 G_GNUC_MALLOC G_GNUC_WARN_UNUSED_RESULT;
1808 /*--- strutil.c -------------------------------------------------------------*/
1810 SR_PRIV int sr_atol(const char *str, long *ret);
1811 SR_PRIV int sr_atol_base(const char *str, long *ret, char **end, int base);
1812 SR_PRIV int sr_atoul_base(const char *str, unsigned long *ret, char **end, int base);
1813 SR_PRIV int sr_atoi(const char *str, int *ret);
1814 SR_PRIV int sr_atod(const char *str, double *ret);
1815 SR_PRIV int sr_atof(const char *str, float *ret);
1816 SR_PRIV int sr_atod_ascii(const char *str, double *ret);
1817 SR_PRIV int sr_atod_ascii_digits(const char *str, double *ret, int *digits);
1818 SR_PRIV int sr_atof_ascii(const char *str, float *ret);
1820 SR_PRIV GString *sr_hexdump_new(const uint8_t *data, const size_t len);
1821 SR_PRIV void sr_hexdump_free(GString *s);
1823 /*--- soft-trigger.c --------------------------------------------------------*/
1825 struct soft_trigger_logic {
1826 const struct sr_dev_inst *sdi;
1827 const struct sr_trigger *trigger;
1831 uint8_t *prev_sample;
1832 uint8_t *pre_trigger_buffer;
1833 uint8_t *pre_trigger_head;
1834 int pre_trigger_size;
1835 int pre_trigger_fill;
1838 SR_PRIV int logic_channel_unitsize(GSList *channels);
1839 SR_PRIV struct soft_trigger_logic *soft_trigger_logic_new(
1840 const struct sr_dev_inst *sdi, struct sr_trigger *trigger,
1841 int pre_trigger_samples);
1842 SR_PRIV void soft_trigger_logic_free(struct soft_trigger_logic *st);
1843 SR_PRIV int soft_trigger_logic_check(struct soft_trigger_logic *st, uint8_t *buf,
1844 int len, int *pre_trigger_samples);
1846 /*--- serial.c --------------------------------------------------------------*/
1848 #ifdef HAVE_SERIAL_COMM
1854 typedef gboolean (*packet_valid_callback)(const uint8_t *buf);
1855 typedef int (*packet_valid_len_callback)(void *st,
1856 const uint8_t *p, size_t l, size_t *pl);
1858 typedef GSList *(*sr_ser_list_append_t)(GSList *devs, const char *name,
1860 typedef GSList *(*sr_ser_find_append_t)(GSList *devs, const char *name);
1862 SR_PRIV int serial_open(struct sr_serial_dev_inst *serial, int flags);
1863 SR_PRIV int serial_close(struct sr_serial_dev_inst *serial);
1864 SR_PRIV int serial_flush(struct sr_serial_dev_inst *serial);
1865 SR_PRIV int serial_drain(struct sr_serial_dev_inst *serial);
1866 SR_PRIV size_t serial_has_receive_data(struct sr_serial_dev_inst *serial);
1867 SR_PRIV int serial_write_blocking(struct sr_serial_dev_inst *serial,
1868 const void *buf, size_t count, unsigned int timeout_ms);
1869 SR_PRIV int serial_write_nonblocking(struct sr_serial_dev_inst *serial,
1870 const void *buf, size_t count);
1871 SR_PRIV int serial_read_blocking(struct sr_serial_dev_inst *serial, void *buf,
1872 size_t count, unsigned int timeout_ms);
1873 SR_PRIV int serial_read_nonblocking(struct sr_serial_dev_inst *serial, void *buf,
1875 SR_PRIV int serial_set_read_chunk_cb(struct sr_serial_dev_inst *serial,
1876 serial_rx_chunk_callback cb, void *cb_data);
1877 SR_PRIV int serial_set_params(struct sr_serial_dev_inst *serial, int baudrate,
1878 int bits, int parity, int stopbits, int flowcontrol, int rts, int dtr);
1879 SR_PRIV int serial_set_handshake(struct sr_serial_dev_inst *serial,
1881 SR_PRIV int serial_set_paramstr(struct sr_serial_dev_inst *serial,
1882 const char *paramstr);
1883 SR_PRIV int serial_readline(struct sr_serial_dev_inst *serial, char **buf,
1884 int *buflen, gint64 timeout_ms);
1885 SR_PRIV int serial_stream_detect(struct sr_serial_dev_inst *serial,
1886 uint8_t *buf, size_t *buflen,
1887 size_t packet_size, packet_valid_callback is_valid,
1888 packet_valid_len_callback is_valid_len, size_t *return_size,
1889 uint64_t timeout_ms);
1890 SR_PRIV int sr_serial_extract_options(GSList *options, const char **serial_device,
1891 const char **serial_options);
1892 SR_PRIV int serial_source_add(struct sr_session *session,
1893 struct sr_serial_dev_inst *serial, int events, int timeout,
1894 sr_receive_data_callback cb, void *cb_data);
1895 SR_PRIV int serial_source_remove(struct sr_session *session,
1896 struct sr_serial_dev_inst *serial);
1897 SR_PRIV GSList *sr_serial_find_usb(uint16_t vendor_id, uint16_t product_id);
1898 SR_PRIV int serial_timeout(struct sr_serial_dev_inst *port, int num_bytes);
1900 SR_PRIV void sr_ser_discard_queued_data(struct sr_serial_dev_inst *serial);
1901 SR_PRIV size_t sr_ser_has_queued_data(struct sr_serial_dev_inst *serial);
1902 SR_PRIV void sr_ser_queue_rx_data(struct sr_serial_dev_inst *serial,
1903 const uint8_t *data, size_t len);
1904 SR_PRIV size_t sr_ser_unqueue_rx_data(struct sr_serial_dev_inst *serial,
1905 uint8_t *data, size_t len);
1907 struct ser_lib_functions {
1908 int (*open)(struct sr_serial_dev_inst *serial, int flags);
1909 int (*close)(struct sr_serial_dev_inst *serial);
1910 int (*flush)(struct sr_serial_dev_inst *serial);
1911 int (*drain)(struct sr_serial_dev_inst *serial);
1912 int (*write)(struct sr_serial_dev_inst *serial,
1913 const void *buf, size_t count,
1914 int nonblocking, unsigned int timeout_ms);
1915 int (*read)(struct sr_serial_dev_inst *serial,
1916 void *buf, size_t count,
1917 int nonblocking, unsigned int timeout_ms);
1918 int (*set_params)(struct sr_serial_dev_inst *serial,
1919 int baudrate, int bits, int parity, int stopbits,
1920 int flowcontrol, int rts, int dtr);
1921 int (*set_handshake)(struct sr_serial_dev_inst *serial,
1923 int (*setup_source_add)(struct sr_session *session,
1924 struct sr_serial_dev_inst *serial,
1925 int events, int timeout,
1926 sr_receive_data_callback cb, void *cb_data);
1927 int (*setup_source_remove)(struct sr_session *session,
1928 struct sr_serial_dev_inst *serial);
1929 GSList *(*list)(GSList *list, sr_ser_list_append_t append);
1930 GSList *(*find_usb)(GSList *list, sr_ser_find_append_t append,
1931 uint16_t vendor_id, uint16_t product_id);
1932 int (*get_frame_format)(struct sr_serial_dev_inst *serial,
1933 int *baud, int *bits);
1934 size_t (*get_rx_avail)(struct sr_serial_dev_inst *serial);
1936 extern SR_PRIV struct ser_lib_functions *ser_lib_funcs_libsp;
1937 SR_PRIV int ser_name_is_hid(struct sr_serial_dev_inst *serial);
1938 extern SR_PRIV struct ser_lib_functions *ser_lib_funcs_hid;
1939 SR_PRIV int ser_name_is_bt(struct sr_serial_dev_inst *serial);
1940 extern SR_PRIV struct ser_lib_functions *ser_lib_funcs_bt;
1942 #ifdef HAVE_LIBHIDAPI
1943 struct vid_pid_item {
1947 struct ser_hid_chip_functions {
1948 const char *chipname;
1949 const char *chipdesc;
1950 const struct vid_pid_item *vid_pid_items;
1951 const int max_bytes_per_request;
1952 int (*set_params)(struct sr_serial_dev_inst *serial,
1953 int baudrate, int bits, int parity, int stopbits,
1954 int flowcontrol, int rts, int dtr);
1955 int (*read_bytes)(struct sr_serial_dev_inst *serial,
1956 uint8_t *data, int space, unsigned int timeout);
1957 int (*write_bytes)(struct sr_serial_dev_inst *serial,
1958 const uint8_t *data, int space);
1959 int (*flush)(struct sr_serial_dev_inst *serial);
1960 int (*drain)(struct sr_serial_dev_inst *serial);
1962 extern SR_PRIV struct ser_hid_chip_functions *ser_hid_chip_funcs_bu86x;
1963 extern SR_PRIV struct ser_hid_chip_functions *ser_hid_chip_funcs_ch9325;
1964 extern SR_PRIV struct ser_hid_chip_functions *ser_hid_chip_funcs_cp2110;
1965 extern SR_PRIV struct ser_hid_chip_functions *ser_hid_chip_funcs_victor;
1966 SR_PRIV const char *ser_hid_chip_find_name_vid_pid(uint16_t vid, uint16_t pid);
1970 /*--- bt/ API ---------------------------------------------------------------*/
1972 #ifdef HAVE_BLUETOOTH
1973 SR_PRIV const char *sr_bt_adapter_get_address(size_t idx);
1976 typedef void (*sr_bt_scan_cb)(void *cb_data, const char *addr, const char *name);
1977 typedef int (*sr_bt_data_cb)(void *cb_data, uint8_t *data, size_t dlen);
1979 SR_PRIV struct sr_bt_desc *sr_bt_desc_new(void);
1980 SR_PRIV void sr_bt_desc_free(struct sr_bt_desc *desc);
1982 SR_PRIV int sr_bt_config_cb_scan(struct sr_bt_desc *desc,
1983 sr_bt_scan_cb cb, void *cb_data);
1984 SR_PRIV int sr_bt_config_cb_data(struct sr_bt_desc *desc,
1985 sr_bt_data_cb cb, void *cb_data);
1986 SR_PRIV int sr_bt_config_addr_local(struct sr_bt_desc *desc, const char *addr);
1987 SR_PRIV int sr_bt_config_addr_remote(struct sr_bt_desc *desc, const char *addr);
1988 SR_PRIV int sr_bt_config_rfcomm(struct sr_bt_desc *desc, size_t channel);
1989 SR_PRIV int sr_bt_config_notify(struct sr_bt_desc *desc,
1990 uint16_t read_handle, uint16_t write_handle,
1991 uint16_t cccd_handle, uint16_t cccd_value);
1993 SR_PRIV int sr_bt_scan_le(struct sr_bt_desc *desc, int duration);
1994 SR_PRIV int sr_bt_scan_bt(struct sr_bt_desc *desc, int duration);
1996 SR_PRIV int sr_bt_connect_ble(struct sr_bt_desc *desc);
1997 SR_PRIV int sr_bt_connect_rfcomm(struct sr_bt_desc *desc);
1998 SR_PRIV void sr_bt_disconnect(struct sr_bt_desc *desc);
2000 SR_PRIV ssize_t sr_bt_read(struct sr_bt_desc *desc,
2001 void *data, size_t len);
2002 SR_PRIV ssize_t sr_bt_write(struct sr_bt_desc *desc,
2003 const void *data, size_t len);
2005 SR_PRIV int sr_bt_start_notify(struct sr_bt_desc *desc);
2006 SR_PRIV int sr_bt_check_notify(struct sr_bt_desc *desc);
2009 /*--- ezusb.c ---------------------------------------------------------------*/
2011 #ifdef HAVE_LIBUSB_1_0
2012 SR_PRIV int ezusb_reset(struct libusb_device_handle *hdl, int set_clear);
2013 SR_PRIV int ezusb_install_firmware(struct sr_context *ctx, libusb_device_handle *hdl,
2015 SR_PRIV int ezusb_upload_firmware(struct sr_context *ctx, libusb_device *dev,
2016 int configuration, const char *name);
2019 /*--- usb.c -----------------------------------------------------------------*/
2021 #ifdef HAVE_LIBUSB_1_0
2022 SR_PRIV GSList *sr_usb_find(libusb_context *usb_ctx, const char *conn);
2023 SR_PRIV int sr_usb_open(libusb_context *usb_ctx, struct sr_usb_dev_inst *usb);
2024 SR_PRIV void sr_usb_close(struct sr_usb_dev_inst *usb);
2025 SR_PRIV int usb_source_add(struct sr_session *session, struct sr_context *ctx,
2026 int timeout, sr_receive_data_callback cb, void *cb_data);
2027 SR_PRIV int usb_source_remove(struct sr_session *session, struct sr_context *ctx);
2028 SR_PRIV int usb_get_port_path(libusb_device *dev, char *path, int path_len);
2029 SR_PRIV gboolean usb_match_manuf_prod(libusb_device *dev,
2030 const char *manufacturer, const char *product);
2033 /*--- binary_helpers.c ------------------------------------------------------*/
2035 /** Binary value type */
2036 enum binary_value_type {
2038 BVT_BE_UINT8 = BVT_UINT8,
2039 BVT_LE_UINT8 = BVT_UINT8,
2052 /** Binary value specification */
2053 struct binary_value_spec {
2054 /** Offset into binary blob */
2056 /** Data type to decode */
2057 enum binary_value_type type;
2058 /** Scale factor to get native units */
2062 /** Binary channel definition */
2063 struct binary_analog_channel {
2066 /** Binary value in data stream */
2067 struct binary_value_spec spec;
2068 /** Significant digits */
2070 /** Measured quantity */
2072 /** Measured unit */
2077 * Read extract a value from a binary blob.
2079 * @param out Pointer to output buffer.
2080 * @param spec Binary value specification
2081 * @param data Pointer to binary blob
2082 * @param length Size of binary blob
2083 * @return SR_OK on success, SR_ERR_* error code on failure.
2085 SR_PRIV int bv_get_value(float *out, const struct binary_value_spec *spec, const void *data, size_t length);
2088 * Send an analog channel packet based on a binary analog channel
2091 * @param sdi Device instance
2092 * @param ch Sigrok channel
2093 * @param spec Channel specification
2094 * @param data Pointer to binary blob
2095 * @param length Size of binary blob
2096 * @return SR_OK on success, SR_ERR_* error code on failure.
2098 SR_PRIV int bv_send_analog_channel(const struct sr_dev_inst *sdi, struct sr_channel *ch,
2099 const struct binary_analog_channel *spec, const void *data, size_t length);
2101 /*--- crc.c -----------------------------------------------------------------*/
2103 #define SR_CRC16_DEFAULT_INIT 0xffffU
2106 * Calculate a CRC16 checksum using the 0x8005 polynomial.
2108 * This CRC16 flavor is also known as CRC16-ANSI or CRC16-MODBUS.
2110 * @param crc Initial value (typically 0xffff)
2111 * @param buffer Input buffer
2112 * @param len Buffer length
2115 SR_PRIV uint16_t sr_crc16(uint16_t crc, const uint8_t *buffer, int len);
2117 /*--- modbus/modbus.c -------------------------------------------------------*/
2119 struct sr_modbus_dev_inst {
2123 GSList *(*scan)(int modbusaddr);
2124 int (*dev_inst_new)(void *priv, const char *resource,
2125 char **params, const char *serialcomm, int modbusaddr);
2126 int (*open)(void *priv);
2127 int (*source_add)(struct sr_session *session, void *priv, int events,
2128 int timeout, sr_receive_data_callback cb, void *cb_data);
2129 int (*source_remove)(struct sr_session *session, void *priv);
2130 int (*send)(void *priv, const uint8_t *buffer, int buffer_size);
2131 int (*read_begin)(void *priv, uint8_t *function_code);
2132 int (*read_data)(void *priv, uint8_t *buf, int maxlen);
2133 int (*read_end)(void *priv);
2134 int (*close)(void *priv);
2135 void (*free)(void *priv);
2136 unsigned int read_timeout_ms;
2140 SR_PRIV GSList *sr_modbus_scan(struct drv_context *drvc, GSList *options,
2141 struct sr_dev_inst *(*probe_device)(struct sr_modbus_dev_inst *modbus));
2142 SR_PRIV struct sr_modbus_dev_inst *modbus_dev_inst_new(const char *resource,
2143 const char *serialcomm, int modbusaddr);
2144 SR_PRIV int sr_modbus_open(struct sr_modbus_dev_inst *modbus);
2145 SR_PRIV int sr_modbus_source_add(struct sr_session *session,
2146 struct sr_modbus_dev_inst *modbus, int events, int timeout,
2147 sr_receive_data_callback cb, void *cb_data);
2148 SR_PRIV int sr_modbus_source_remove(struct sr_session *session,
2149 struct sr_modbus_dev_inst *modbus);
2150 SR_PRIV int sr_modbus_request(struct sr_modbus_dev_inst *modbus,
2151 uint8_t *request, int request_size);
2152 SR_PRIV int sr_modbus_reply(struct sr_modbus_dev_inst *modbus,
2153 uint8_t *reply, int reply_size);
2154 SR_PRIV int sr_modbus_request_reply(struct sr_modbus_dev_inst *modbus,
2155 uint8_t *request, int request_size,
2156 uint8_t *reply, int reply_size);
2157 SR_PRIV int sr_modbus_read_coils(struct sr_modbus_dev_inst *modbus,
2158 int address, int nb_coils, uint8_t *coils);
2159 SR_PRIV int sr_modbus_read_holding_registers(struct sr_modbus_dev_inst *modbus,
2160 int address, int nb_registers,
2161 uint16_t *registers);
2162 SR_PRIV int sr_modbus_write_coil(struct sr_modbus_dev_inst *modbus,
2163 int address, int value);
2164 SR_PRIV int sr_modbus_write_multiple_registers(struct sr_modbus_dev_inst*modbus,
2165 int address, int nb_registers,
2166 uint16_t *registers);
2167 SR_PRIV int sr_modbus_close(struct sr_modbus_dev_inst *modbus);
2168 SR_PRIV void sr_modbus_free(struct sr_modbus_dev_inst *modbus);
2170 /*--- dmm/es519xx.c ---------------------------------------------------------*/
2173 * All 11-byte es519xx chips repeat each block twice for each conversion cycle
2174 * so always read 2 blocks at a time.
2176 #define ES519XX_11B_PACKET_SIZE (11 * 2)
2177 #define ES519XX_14B_PACKET_SIZE 14
2179 struct es519xx_info {
2180 gboolean is_judge, is_voltage, is_auto, is_micro, is_current;
2181 gboolean is_milli, is_resistance, is_continuity, is_diode;
2182 gboolean is_frequency, is_rpm, is_capacitance, is_duty_cycle;
2183 gboolean is_temperature, is_celsius, is_fahrenheit;
2184 gboolean is_adp0, is_adp1, is_adp2, is_adp3;
2185 gboolean is_sign, is_batt, is_ol, is_pmax, is_pmin, is_apo;
2186 gboolean is_dc, is_ac, is_vahz, is_min, is_max, is_rel, is_hold;
2187 gboolean is_digit4, is_ul, is_vasel, is_vbar, is_lpf1, is_lpf0, is_rmr;
2190 gboolean alt_functions, fivedigits, clampmeter, selectable_lpf;
2194 SR_PRIV gboolean sr_es519xx_2400_11b_packet_valid(const uint8_t *buf);
2195 SR_PRIV int sr_es519xx_2400_11b_parse(const uint8_t *buf, float *floatval,
2196 struct sr_datafeed_analog *analog, void *info);
2197 SR_PRIV gboolean sr_es519xx_2400_11b_altfn_packet_valid(const uint8_t *buf);
2198 SR_PRIV int sr_es519xx_2400_11b_altfn_parse(const uint8_t *buf,
2199 float *floatval, struct sr_datafeed_analog *analog, void *info);
2200 SR_PRIV gboolean sr_es519xx_19200_11b_5digits_packet_valid(const uint8_t *buf);
2201 SR_PRIV int sr_es519xx_19200_11b_5digits_parse(const uint8_t *buf,
2202 float *floatval, struct sr_datafeed_analog *analog, void *info);
2203 SR_PRIV gboolean sr_es519xx_19200_11b_clamp_packet_valid(const uint8_t *buf);
2204 SR_PRIV int sr_es519xx_19200_11b_clamp_parse(const uint8_t *buf,
2205 float *floatval, struct sr_datafeed_analog *analog, void *info);
2206 SR_PRIV gboolean sr_es519xx_19200_11b_packet_valid(const uint8_t *buf);
2207 SR_PRIV int sr_es519xx_19200_11b_parse(const uint8_t *buf, float *floatval,
2208 struct sr_datafeed_analog *analog, void *info);
2209 SR_PRIV gboolean sr_es519xx_19200_14b_packet_valid(const uint8_t *buf);
2210 SR_PRIV int sr_es519xx_19200_14b_parse(const uint8_t *buf, float *floatval,
2211 struct sr_datafeed_analog *analog, void *info);
2212 SR_PRIV gboolean sr_es519xx_19200_14b_sel_lpf_packet_valid(const uint8_t *buf);
2213 SR_PRIV int sr_es519xx_19200_14b_sel_lpf_parse(const uint8_t *buf,
2214 float *floatval, struct sr_datafeed_analog *analog, void *info);
2216 /*--- dmm/fs9922.c ----------------------------------------------------------*/
2218 #define FS9922_PACKET_SIZE 14
2220 struct fs9922_info {
2221 gboolean is_auto, is_dc, is_ac, is_rel, is_hold, is_bpn, is_z1, is_z2;
2222 gboolean is_max, is_min, is_apo, is_bat, is_nano, is_z3, is_micro;
2223 gboolean is_milli, is_kilo, is_mega, is_beep, is_diode, is_percent;
2224 gboolean is_z4, is_volt, is_ampere, is_ohm, is_hfe, is_hertz, is_farad;
2225 gboolean is_celsius, is_fahrenheit;
2226 int bargraph_sign, bargraph_value;
2229 SR_PRIV gboolean sr_fs9922_packet_valid(const uint8_t *buf);
2230 SR_PRIV int sr_fs9922_parse(const uint8_t *buf, float *floatval,
2231 struct sr_datafeed_analog *analog, void *info);
2232 SR_PRIV void sr_fs9922_z1_diode(struct sr_datafeed_analog *analog, void *info);
2234 /*--- dmm/fs9721.c ----------------------------------------------------------*/
2236 #define FS9721_PACKET_SIZE 14
2238 struct fs9721_info {
2239 gboolean is_ac, is_dc, is_auto, is_rs232, is_micro, is_nano, is_kilo;
2240 gboolean is_diode, is_milli, is_percent, is_mega, is_beep, is_farad;
2241 gboolean is_ohm, is_rel, is_hold, is_ampere, is_volt, is_hz, is_bat;
2242 gboolean is_c2c1_11, is_c2c1_10, is_c2c1_01, is_c2c1_00, is_sign;
2245 SR_PRIV gboolean sr_fs9721_packet_valid(const uint8_t *buf);
2246 SR_PRIV int sr_fs9721_parse(const uint8_t *buf, float *floatval,
2247 struct sr_datafeed_analog *analog, void *info);
2248 SR_PRIV void sr_fs9721_00_temp_c(struct sr_datafeed_analog *analog, void *info);
2249 SR_PRIV void sr_fs9721_01_temp_c(struct sr_datafeed_analog *analog, void *info);
2250 SR_PRIV void sr_fs9721_10_temp_c(struct sr_datafeed_analog *analog, void *info);
2251 SR_PRIV void sr_fs9721_01_10_temp_f_c(struct sr_datafeed_analog *analog, void *info);
2252 SR_PRIV void sr_fs9721_max_c_min(struct sr_datafeed_analog *analog, void *info);
2254 /*--- dmm/ms2115b.c ---------------------------------------------------------*/
2256 #define MS2115B_PACKET_SIZE 9
2258 enum ms2115b_display {
2259 MS2115B_DISPLAY_MAIN,
2260 MS2115B_DISPLAY_SUB,
2261 MS2115B_DISPLAY_COUNT,
2264 struct ms2115b_info {
2265 /* Selected channel. */
2267 gboolean is_ac, is_dc, is_auto;
2268 gboolean is_diode, is_beep, is_farad;
2269 gboolean is_ohm, is_ampere, is_volt, is_hz;
2270 gboolean is_duty_cycle, is_percent;
2273 extern SR_PRIV const char *ms2115b_channel_formats[];
2274 SR_PRIV gboolean sr_ms2115b_packet_valid(const uint8_t *buf);
2275 SR_PRIV int sr_ms2115b_parse(const uint8_t *buf, float *floatval,
2276 struct sr_datafeed_analog *analog, void *info);
2278 /*--- dmm/ms8250d.c ---------------------------------------------------------*/
2280 #define MS8250D_PACKET_SIZE 18
2282 struct ms8250d_info {
2283 gboolean is_ac, is_dc, is_auto, is_rs232, is_micro, is_nano, is_kilo;
2284 gboolean is_diode, is_milli, is_percent, is_mega, is_beep, is_farad;
2285 gboolean is_ohm, is_rel, is_hold, is_ampere, is_volt, is_hz, is_bat;
2286 gboolean is_ncv, is_min, is_max, is_sign, is_autotimer;
2289 SR_PRIV gboolean sr_ms8250d_packet_valid(const uint8_t *buf);
2290 SR_PRIV int sr_ms8250d_parse(const uint8_t *buf, float *floatval,
2291 struct sr_datafeed_analog *analog, void *info);
2293 /*--- dmm/dtm0660.c ---------------------------------------------------------*/
2295 #define DTM0660_PACKET_SIZE 15
2297 struct dtm0660_info {
2298 gboolean is_ac, is_dc, is_auto, is_rs232, is_micro, is_nano, is_kilo;
2299 gboolean is_diode, is_milli, is_percent, is_mega, is_beep, is_farad;
2300 gboolean is_ohm, is_rel, is_hold, is_ampere, is_volt, is_hz, is_bat;
2301 gboolean is_degf, is_degc, is_c2c1_01, is_c2c1_00, is_apo, is_min;
2302 gboolean is_minmax, is_max, is_sign;
2305 SR_PRIV gboolean sr_dtm0660_packet_valid(const uint8_t *buf);
2306 SR_PRIV int sr_dtm0660_parse(const uint8_t *buf, float *floatval,
2307 struct sr_datafeed_analog *analog, void *info);
2309 /*--- dmm/m2110.c -----------------------------------------------------------*/
2311 #define BBCGM_M2110_PACKET_SIZE 9
2313 /* Dummy info struct. The parser does not use it. */
2314 struct m2110_info { int dummy; };
2316 SR_PRIV gboolean sr_m2110_packet_valid(const uint8_t *buf);
2317 SR_PRIV int sr_m2110_parse(const uint8_t *buf, float *floatval,
2318 struct sr_datafeed_analog *analog, void *info);
2320 /*--- dmm/metex14.c ---------------------------------------------------------*/
2322 #define METEX14_PACKET_SIZE 14
2324 struct metex14_info {
2326 gboolean is_ac, is_dc, is_resistance, is_capacity, is_temperature;
2327 gboolean is_diode, is_frequency, is_ampere, is_volt, is_farad;
2328 gboolean is_hertz, is_ohm, is_celsius, is_fahrenheit, is_watt;
2329 gboolean is_pico, is_nano, is_micro, is_milli, is_kilo, is_mega;
2330 gboolean is_gain, is_decibel, is_power, is_decibel_mw, is_power_factor;
2331 gboolean is_hfe, is_unitless, is_logic, is_min, is_max, is_avg;
2334 #ifdef HAVE_SERIAL_COMM
2335 SR_PRIV int sr_metex14_packet_request(struct sr_serial_dev_inst *serial);
2337 SR_PRIV gboolean sr_metex14_packet_valid(const uint8_t *buf);
2338 SR_PRIV int sr_metex14_parse(const uint8_t *buf, float *floatval,
2339 struct sr_datafeed_analog *analog, void *info);
2340 SR_PRIV gboolean sr_metex14_4packets_valid(const uint8_t *buf);
2341 SR_PRIV int sr_metex14_4packets_parse(const uint8_t *buf, float *floatval,
2342 struct sr_datafeed_analog *analog, void *info);
2344 /*--- dmm/rs9lcd.c ----------------------------------------------------------*/
2346 #define RS9LCD_PACKET_SIZE 9
2348 /* Dummy info struct. The parser does not use it. */
2349 struct rs9lcd_info { int dummy; };
2351 SR_PRIV gboolean sr_rs9lcd_packet_valid(const uint8_t *buf);
2352 SR_PRIV int sr_rs9lcd_parse(const uint8_t *buf, float *floatval,
2353 struct sr_datafeed_analog *analog, void *info);
2355 /*--- dmm/bm25x.c -----------------------------------------------------------*/
2357 #define BRYMEN_BM25X_PACKET_SIZE 15
2359 /* Dummy info struct. The parser does not use it. */
2360 struct bm25x_info { int dummy; };
2362 SR_PRIV gboolean sr_brymen_bm25x_packet_valid(const uint8_t *buf);
2363 SR_PRIV int sr_brymen_bm25x_parse(const uint8_t *buf, float *floatval,
2364 struct sr_datafeed_analog *analog, void *info);
2366 /*--- dmm/bm52x.c -----------------------------------------------------------*/
2368 #define BRYMEN_BM52X_PACKET_SIZE 24
2369 #define BRYMEN_BM52X_DISPLAY_COUNT 2
2371 struct brymen_bm52x_info { size_t ch_idx; };
2373 #ifdef HAVE_SERIAL_COMM
2374 SR_PRIV int sr_brymen_bm52x_packet_request(struct sr_serial_dev_inst *serial);
2375 SR_PRIV int sr_brymen_bm82x_packet_request(struct sr_serial_dev_inst *serial);
2377 SR_PRIV gboolean sr_brymen_bm52x_packet_valid(const uint8_t *buf);
2378 SR_PRIV gboolean sr_brymen_bm82x_packet_valid(const uint8_t *buf);
2379 /* BM520s and BM820s protocols are similar, the parse routine is shared. */
2380 SR_PRIV int sr_brymen_bm52x_parse(const uint8_t *buf, float *floatval,
2381 struct sr_datafeed_analog *analog, void *info);
2383 struct brymen_bm52x_state;
2385 SR_PRIV void *brymen_bm52x_state_init(void);
2386 SR_PRIV void brymen_bm52x_state_free(void *state);
2387 SR_PRIV int brymen_bm52x_config_get(void *state, uint32_t key, GVariant **data,
2388 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg);
2389 SR_PRIV int brymen_bm52x_config_set(void *state, uint32_t key, GVariant *data,
2390 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg);
2391 SR_PRIV int brymen_bm52x_config_list(void *state, uint32_t key, GVariant **data,
2392 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg);
2393 SR_PRIV int brymen_bm52x_acquire_start(void *state,
2394 const struct sr_dev_inst *sdi,
2395 sr_receive_data_callback *cb, void **cb_data);
2397 /*--- dmm/bm85x.c -----------------------------------------------------------*/
2399 #define BRYMEN_BM85x_PACKET_SIZE_MIN 4
2401 struct brymen_bm85x_info { int dummy; };
2403 #ifdef HAVE_SERIAL_COMM
2404 SR_PRIV int brymen_bm85x_after_open(struct sr_serial_dev_inst *serial);
2405 SR_PRIV int brymen_bm85x_packet_request(struct sr_serial_dev_inst *serial);
2407 SR_PRIV gboolean brymen_bm85x_packet_valid(void *state,
2408 const uint8_t *buf, size_t len, size_t *pkt_len);
2409 SR_PRIV int brymen_bm85x_parse(void *state, const uint8_t *buf, size_t len,
2410 double *floatval, struct sr_datafeed_analog *analog, void *info);
2412 /*--- dmm/bm86x.c -----------------------------------------------------------*/
2414 #define BRYMEN_BM86X_PACKET_SIZE 24
2415 #define BRYMEN_BM86X_DISPLAY_COUNT 2
2417 struct brymen_bm86x_info { size_t ch_idx; };
2419 #ifdef HAVE_SERIAL_COMM
2420 SR_PRIV int sr_brymen_bm86x_packet_request(struct sr_serial_dev_inst *serial);
2422 SR_PRIV gboolean sr_brymen_bm86x_packet_valid(const uint8_t *buf);
2423 SR_PRIV int sr_brymen_bm86x_parse(const uint8_t *buf, float *floatval,
2424 struct sr_datafeed_analog *analog, void *info);
2426 /*--- dmm/ut71x.c -----------------------------------------------------------*/
2428 #define UT71X_PACKET_SIZE 11
2431 gboolean is_voltage, is_resistance, is_capacitance, is_temperature;
2432 gboolean is_celsius, is_fahrenheit, is_current, is_continuity;
2433 gboolean is_diode, is_frequency, is_duty_cycle, is_dc, is_ac;
2434 gboolean is_auto, is_manual, is_sign, is_power, is_loop_current;
2437 SR_PRIV gboolean sr_ut71x_packet_valid(const uint8_t *buf);
2438 SR_PRIV int sr_ut71x_parse(const uint8_t *buf, float *floatval,
2439 struct sr_datafeed_analog *analog, void *info);
2441 /*--- dmm/vc870.c -----------------------------------------------------------*/
2443 #define VC870_PACKET_SIZE 23
2446 gboolean is_voltage, is_dc, is_ac, is_temperature, is_resistance;
2447 gboolean is_continuity, is_capacitance, is_diode, is_loop_current;
2448 gboolean is_current, is_micro, is_milli, is_power;
2449 gboolean is_power_factor_freq, is_power_apparent_power, is_v_a_rms_value;
2450 gboolean is_sign2, is_sign1, is_batt, is_ol1, is_max, is_min;
2451 gboolean is_maxmin, is_rel, is_ol2, is_open, is_manu, is_hold;
2452 gboolean is_light, is_usb, is_warning, is_auto_power, is_misplug_warn;
2453 gboolean is_lo, is_hi, is_open2;
2455 gboolean is_frequency, is_dual_display, is_auto;
2458 SR_PRIV gboolean sr_vc870_packet_valid(const uint8_t *buf);
2459 SR_PRIV int sr_vc870_parse(const uint8_t *buf, float *floatval,
2460 struct sr_datafeed_analog *analog, void *info);
2462 /*--- dmm/vc96.c ------------------------------------------------------------*/
2464 #define VC96_PACKET_SIZE 13
2468 gboolean is_ac, is_dc, is_resistance, is_diode, is_ampere, is_volt;
2469 gboolean is_ohm, is_micro, is_milli, is_kilo, is_mega, is_hfe;
2470 gboolean is_unitless;
2473 SR_PRIV gboolean sr_vc96_packet_valid(const uint8_t *buf);
2474 SR_PRIV int sr_vc96_parse(const uint8_t *buf, float *floatval,
2475 struct sr_datafeed_analog *analog, void *info);
2477 /*--- lcr/es51919.c ---------------------------------------------------------*/
2479 /* Acquisition details which apply to all supported serial-lcr devices. */
2480 struct lcr_parse_info {
2482 uint64_t output_freq;
2483 const char *circuit_model;
2486 #define ES51919_PACKET_SIZE 17
2487 #define ES51919_CHANNEL_COUNT 2
2488 #define ES51919_COMM_PARAM "9600/8n1/rts=1/dtr=1"
2490 SR_PRIV int es51919_config_get(uint32_t key, GVariant **data,
2491 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg);
2492 SR_PRIV int es51919_config_set(uint32_t key, GVariant *data,
2493 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg);
2494 SR_PRIV int es51919_config_list(uint32_t key, GVariant **data,
2495 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg);
2496 SR_PRIV gboolean es51919_packet_valid(const uint8_t *pkt);
2497 SR_PRIV int es51919_packet_parse(const uint8_t *pkt, float *floatval,
2498 struct sr_datafeed_analog *analog, void *info);
2500 /*--- lcr/vc4080.c ----------------------------------------------------------*/
2502 /* Note: Also uses 'struct lcr_parse_info' from es51919 above. */
2504 #define VC4080_PACKET_SIZE 39
2505 #define VC4080_COMM_PARAM "1200/8n1"
2506 #define VC4080_WITH_DQ_CHANS 0 /* Enable separate D/Q channels? */
2508 enum vc4080_display {
2509 VC4080_DISPLAY_PRIMARY,
2510 VC4080_DISPLAY_SECONDARY,
2511 #if VC4080_WITH_DQ_CHANS
2512 VC4080_DISPLAY_D_VALUE,
2513 VC4080_DISPLAY_Q_VALUE,
2515 VC4080_CHANNEL_COUNT,
2518 extern SR_PRIV const char *vc4080_channel_formats[VC4080_CHANNEL_COUNT];
2520 SR_PRIV int vc4080_config_list(uint32_t key, GVariant **data,
2521 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg);
2522 SR_PRIV int vc4080_packet_request(struct sr_serial_dev_inst *serial);
2523 SR_PRIV gboolean vc4080_packet_valid(const uint8_t *pkt);
2524 SR_PRIV int vc4080_packet_parse(const uint8_t *pkt, float *floatval,
2525 struct sr_datafeed_analog *analog, void *info);
2527 /*--- dmm/ut372.c -----------------------------------------------------------*/
2529 #define UT372_PACKET_SIZE 27
2535 SR_PRIV gboolean sr_ut372_packet_valid(const uint8_t *buf);
2536 SR_PRIV int sr_ut372_parse(const uint8_t *buf, float *floatval,
2537 struct sr_datafeed_analog *analog, void *info);
2539 /*--- dmm/asycii.c ----------------------------------------------------------*/
2541 #define ASYCII_PACKET_SIZE 16
2543 struct asycii_info {
2544 gboolean is_ac, is_dc, is_ac_and_dc;
2545 gboolean is_resistance, is_capacitance, is_diode, is_gain;
2546 gboolean is_frequency, is_duty_cycle, is_duty_pos, is_duty_neg;
2547 gboolean is_pulse_width, is_period_pos, is_period_neg;
2548 gboolean is_pulse_count, is_count_pos, is_count_neg;
2549 gboolean is_ampere, is_volt, is_volt_ampere, is_farad, is_ohm;
2550 gboolean is_hertz, is_percent, is_seconds, is_decibel;
2551 gboolean is_pico, is_nano, is_micro, is_milli, is_kilo, is_mega;
2552 gboolean is_unitless;
2553 gboolean is_peak_min, is_peak_max;
2554 gboolean is_invalid;
2557 #ifdef HAVE_SERIAL_COMM
2558 SR_PRIV int sr_asycii_packet_request(struct sr_serial_dev_inst *serial);
2560 SR_PRIV gboolean sr_asycii_packet_valid(const uint8_t *buf);
2561 SR_PRIV int sr_asycii_parse(const uint8_t *buf, float *floatval,
2562 struct sr_datafeed_analog *analog, void *info);
2564 /*--- dmm/eev121gw.c --------------------------------------------------------*/
2566 #define EEV121GW_PACKET_SIZE 19
2568 enum eev121gw_display {
2569 EEV121GW_DISPLAY_MAIN,
2570 EEV121GW_DISPLAY_SUB,
2571 EEV121GW_DISPLAY_BAR,
2572 EEV121GW_DISPLAY_COUNT,
2575 struct eev121gw_info {
2576 /* Selected channel. */
2579 * Measured value, number and sign/overflow flags, scale factor
2580 * and significant digits.
2582 uint32_t uint_value;
2583 gboolean is_ofl, is_neg;
2585 /* Currently active mode (meter's function). */
2586 gboolean is_ac, is_dc, is_voltage, is_current, is_power, is_gain;
2587 gboolean is_resistance, is_capacitance, is_diode, is_temperature;
2588 gboolean is_continuity, is_frequency, is_period, is_duty_cycle;
2589 /* Quantities associated with mode/function. */
2590 gboolean is_ampere, is_volt, is_volt_ampere, is_dbm;
2591 gboolean is_ohm, is_farad, is_celsius, is_fahrenheit;
2592 gboolean is_hertz, is_seconds, is_percent, is_loop_current;
2593 gboolean is_unitless, is_logic;
2594 /* Other indicators. */
2595 gboolean is_min, is_max, is_avg, is_1ms_peak, is_rel, is_hold;
2596 gboolean is_low_pass, is_mem, is_bt, is_auto_range, is_test;
2597 gboolean is_auto_poweroff, is_low_batt;
2600 extern SR_PRIV const char *eev121gw_channel_formats[];
2601 SR_PRIV gboolean sr_eev121gw_packet_valid(const uint8_t *buf);
2602 SR_PRIV int sr_eev121gw_3displays_parse(const uint8_t *buf, float *floatval,
2603 struct sr_datafeed_analog *analog, void *info);
2605 /*--- scale/kern.c ----------------------------------------------------------*/
2608 gboolean is_gram, is_carat, is_ounce, is_pound, is_troy_ounce;
2609 gboolean is_pennyweight, is_grain, is_tael, is_momme, is_tola;
2610 gboolean is_percentage, is_piece, is_unstable, is_stable, is_error;
2614 SR_PRIV gboolean sr_kern_packet_valid(const uint8_t *buf);
2615 SR_PRIV int sr_kern_parse(const uint8_t *buf, float *floatval,
2616 struct sr_datafeed_analog *analog, void *info);
2618 /*--- sw_limits.c -----------------------------------------------------------*/
2620 struct sr_sw_limits {
2621 uint64_t limit_samples;
2622 uint64_t limit_frames;
2623 uint64_t limit_msec;
2624 uint64_t samples_read;
2625 uint64_t frames_read;
2626 uint64_t start_time;
2629 SR_PRIV int sr_sw_limits_config_get(const struct sr_sw_limits *limits, uint32_t key,
2631 SR_PRIV int sr_sw_limits_config_set(struct sr_sw_limits *limits, uint32_t key,
2633 SR_PRIV void sr_sw_limits_acquisition_start(struct sr_sw_limits *limits);
2634 SR_PRIV gboolean sr_sw_limits_check(struct sr_sw_limits *limits);
2635 SR_PRIV void sr_sw_limits_update_samples_read(struct sr_sw_limits *limits,
2636 uint64_t samples_read);
2637 SR_PRIV void sr_sw_limits_update_frames_read(struct sr_sw_limits *limits,
2638 uint64_t frames_read);
2639 SR_PRIV void sr_sw_limits_init(struct sr_sw_limits *limits);
2641 /*--- feed_queue.h ----------------------------------------------------------*/
2643 struct feed_queue_logic;
2644 struct feed_queue_analog;
2646 SR_API struct feed_queue_logic *feed_queue_logic_alloc(
2647 struct sr_dev_inst *sdi,
2648 size_t sample_count, size_t unit_size);
2649 SR_API int feed_queue_logic_submit(struct feed_queue_logic *q,
2650 const uint8_t *data, size_t count);
2651 SR_API int feed_queue_logic_flush(struct feed_queue_logic *q);
2652 SR_API void feed_queue_logic_free(struct feed_queue_logic *q);
2654 SR_API struct feed_queue_analog *feed_queue_analog_alloc(
2655 struct sr_dev_inst *sdi,
2656 size_t sample_count, int digits, struct sr_channel *ch);
2657 SR_API int feed_queue_analog_submit(struct feed_queue_analog *q,
2658 float data, size_t count);
2659 SR_API int feed_queue_analog_flush(struct feed_queue_analog *q);
2660 SR_API void feed_queue_analog_free(struct feed_queue_analog *q);