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 little endian.
480 * @param p a pointer to the output memory
481 * @param x the input unsigned integer
483 static inline void write_u64le(uint8_t *p, uint64_t x)
485 p[0] = x & 0xff; x >>= 8;
486 p[1] = x & 0xff; x >>= 8;
487 p[2] = x & 0xff; x >>= 8;
488 p[3] = x & 0xff; x >>= 8;
489 p[4] = x & 0xff; x >>= 8;
490 p[5] = x & 0xff; x >>= 8;
491 p[6] = x & 0xff; x >>= 8;
492 p[7] = x & 0xff; x >>= 8;
494 #define WL64(p, x) write_u64le((uint8_t *)(p), (uint64_t)(x))
497 * Write a 32 bits float to memory stored as big endian.
498 * @param p a pointer to the output memory
499 * @param x the input float
501 static inline void write_fltbe(uint8_t *p, float x)
503 union { uint32_t u; float f; } u;
507 #define WBFL(p, x) write_fltbe((uint8_t *)(p), (x))
510 * Write a 32 bits float to memory stored as little endian.
511 * @param p a pointer to the output memory
512 * @param x the input float
514 static inline void write_fltle(uint8_t *p, float x)
516 union { uint32_t u; float f; } u;
520 #define WLFL(p, x) write_fltle((uint8_t *)(p), float (x))
523 * Write a 64 bits float to memory stored as little endian.
524 * @param p a pointer to the output memory
525 * @param x the input floating point value
527 static inline void write_dblle(uint8_t *p, double x)
529 union { uint64_t u; double f; } u;
533 #define WLDB(p, x) write_dblle((uint8_t *)(p), float (x))
535 /* Endianess conversion helpers with read/write position increment. */
538 * Read unsigned 8bit integer from raw memory, increment read position.
539 * @param[in, out] p Pointer into byte stream.
540 * @return Retrieved integer value, unsigned.
542 static inline uint8_t read_u8_inc(const uint8_t **p)
555 * Read signed 8bit integer from raw memory, increment read position.
556 * @param[in, out] p Pointer into byte stream.
557 * @return Retrieved integer value, signed.
559 static inline int8_t read_i8_inc(const uint8_t **p)
572 * Read unsigned 16bit integer from raw memory (big endian format), increment read position.
573 * @param[in, out] p Pointer into byte stream.
574 * @return Retrieved integer value, unsigned.
576 static inline uint16_t read_u16be_inc(const uint8_t **p)
589 * Read unsigned 16bit integer from raw memory (little 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_u16le_inc(const uint8_t **p)
606 * Read signed 16bit integer from raw memory (big endian format), increment read position.
607 * @param[in, out] p Pointer into byte stream.
608 * @return Retrieved integer value, signed.
610 static inline int16_t read_i16be_inc(const uint8_t **p)
623 * Read signed 16bit integer from raw memory (little 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_i16le_inc(const uint8_t **p)
640 * Read unsigned 24bit integer from raw memory (little endian format), increment read position.
641 * @param[in, out] p Pointer into byte stream.
642 * @return Retrieved integer value, unsigned.
644 static inline uint32_t read_u24le_inc(const uint8_t **p)
651 *p += 3 * sizeof(uint8_t);
657 * Read unsigned 32bit integer from raw memory (big 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_u32be_inc(const uint8_t **p)
674 * Read unsigned 32bit integer from raw memory (little 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_u32le_inc(const uint8_t **p)
691 * Read signed 32bit integer from raw memory (big endian format), increment read position.
692 * @param[in, out] p Pointer into byte stream.
693 * @return Retrieved integer value, signed.
695 static inline int32_t read_i32be_inc(const uint8_t **p)
708 * Read signed 32bit integer from raw memory (little 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_i32le_inc(const uint8_t **p)
725 * Read unsigned 64bit integer from raw memory (big endian format), increment read position.
726 * @param[in, out] p Pointer into byte stream.
727 * @return Retrieved integer value, unsigned.
729 static inline uint64_t read_u64be_inc(const uint8_t **p)
742 * Read unsigned 64bit integer from raw memory (little 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_u64le_inc(const uint8_t **p)
759 * Read 32bit float from raw memory (big endian format), increment read position.
760 * @param[in, out] p Pointer into byte stream.
761 * @return Retrieved float value.
763 static inline float read_fltbe_inc(const uint8_t **p)
776 * Read 32bit float from raw memory (little endian format), increment read position.
777 * @param[in, out] p Pointer into byte stream.
778 * @return Retrieved float value.
780 static inline float read_fltle_inc(const uint8_t **p)
793 * Read 64bit float from raw memory (big endian format), increment read position.
794 * @param[in, out] p Pointer into byte stream.
795 * @return Retrieved float value.
797 static inline double read_dblbe_inc(const uint8_t **p)
810 * Read 64bit float from raw memory (little endian format), increment read position.
811 * @param[in, out] p Pointer into byte stream.
812 * @return Retrieved float value.
814 static inline double read_dblle_inc(const uint8_t **p)
827 * Write unsigned 8bit integer to raw memory, increment write position.
828 * @param[in, out] p Pointer into byte stream.
829 * @param[in] x Value to write.
831 static inline void write_u8_inc(uint8_t **p, uint8_t x)
840 * Write unsigned 16bit big endian integer to raw memory, increment write position.
841 * @param[in, out] p Pointer into byte stream.
842 * @param[in] x Value to write.
844 static inline void write_u16be_inc(uint8_t **p, uint16_t x)
853 * Write unsigned 16bit little endian integer to raw memory, increment write position.
854 * @param[in, out] p Pointer into byte stream.
855 * @param[in] x Value to write.
857 static inline void write_u16le_inc(uint8_t **p, uint16_t x)
866 * Write unsigned 32bit big endian integer to raw memory, increment write position.
867 * @param[in, out] p Pointer into byte stream.
868 * @param[in] x Value to write.
870 static inline void write_u32be_inc(uint8_t **p, uint32_t x)
879 * Write unsigned 32bit little endian integer to raw memory, increment write position.
880 * @param[in, out] p Pointer into byte stream.
881 * @param[in] x Value to write.
883 static inline void write_u32le_inc(uint8_t **p, uint32_t x)
892 * Write unsigned 64bit little endian integer to raw memory, increment write position.
893 * @param[in, out] p Pointer into byte stream.
894 * @param[in] x Value to write.
896 static inline void write_u64le_inc(uint8_t **p, uint64_t x)
905 * Write single precision little endian float to raw memory, increment write position.
906 * @param[in, out] p Pointer into byte stream.
907 * @param[in] x Value to write.
909 static inline void write_fltle_inc(uint8_t **p, float x)
918 * Write double precision little endian float to raw memory, increment write position.
919 * @param[in, out] p Pointer into byte stream.
920 * @param[in] x Value to write.
922 static inline void write_dblle_inc(uint8_t **p, double x)
930 /* Portability fixes for FreeBSD. */
932 #define LIBUSB_CLASS_APPLICATION 0xfe
933 #define libusb_has_capability(x) 0
934 #define libusb_handle_events_timeout_completed(ctx, tv, c) \
935 libusb_handle_events_timeout(ctx, tv)
938 /* Static definitions of structs ending with an all-zero entry are a
939 * problem when compiling with -Wmissing-field-initializers: GCC
940 * suppresses the warning only with { 0 }, clang wants { } */
944 #define ALL_ZERO { 0 }
948 #define SR_DRIVER_LIST_SECTION "__DATA,__sr_driver_list"
950 #define SR_DRIVER_LIST_SECTION "__sr_driver_list"
954 * Register a list of hardware drivers.
956 * This macro can be used to register multiple hardware drivers to the library.
957 * This is useful when a driver supports multiple similar but slightly
958 * different devices that require different sr_dev_driver struct definitions.
960 * For registering only a single driver see SR_REGISTER_DEV_DRIVER().
964 * #define MY_DRIVER(_name) \
965 * &(struct sr_dev_driver){ \
970 * SR_REGISTER_DEV_DRIVER_LIST(my_driver_infos,
971 * MY_DRIVER("driver 1"),
972 * MY_DRIVER("driver 2"),
977 * @param name Name to use for the driver list identifier.
978 * @param ... Comma separated list of pointers to sr_dev_driver structs.
980 #define SR_REGISTER_DEV_DRIVER_LIST(name, ...) \
981 static const struct sr_dev_driver *name[] \
982 __attribute__((section (SR_DRIVER_LIST_SECTION), used, \
983 aligned(sizeof(struct sr_dev_driver *)))) \
989 * Register a hardware driver.
991 * This macro is used to register a hardware driver with the library. It has
992 * to be used in order to make the driver accessible to applications using the
995 * The macro invocation should be placed directly under the struct
996 * sr_dev_driver definition.
1000 * static struct sr_dev_driver driver_info = {
1004 * SR_REGISTER_DEV_DRIVER(driver_info);
1007 * @param name Identifier name of sr_dev_driver struct to register.
1009 #define SR_REGISTER_DEV_DRIVER(name) \
1010 SR_REGISTER_DEV_DRIVER_LIST(name##_list, &name);
1012 SR_API void sr_drivers_init(struct sr_context *context);
1015 struct sr_dev_driver **driver_list;
1016 #ifdef HAVE_LIBUSB_1_0
1017 libusb_context *libusb_ctx;
1019 sr_resource_open_callback resource_open_cb;
1020 sr_resource_close_callback resource_close_cb;
1021 sr_resource_read_callback resource_read_cb;
1022 void *resource_cb_data;
1025 /** Input module metadata keys. */
1026 enum sr_input_meta_keys {
1027 /** The input filename, if there is one. */
1028 SR_INPUT_META_FILENAME = 0x01,
1029 /** The input file's size in bytes. */
1030 SR_INPUT_META_FILESIZE = 0x02,
1031 /** The first 128 bytes of the file, provided as a GString. */
1032 SR_INPUT_META_HEADER = 0x04,
1034 /** The module cannot identify a file without this metadata. */
1035 SR_INPUT_META_REQUIRED = 0x80,
1038 /** Input (file) module struct. */
1041 * A pointer to this input module's 'struct sr_input_module'.
1043 const struct sr_input_module *module;
1045 struct sr_dev_inst *sdi;
1050 /** Input (file) module driver. */
1051 struct sr_input_module {
1053 * A unique ID for this input module, suitable for use in command-line
1054 * clients, [a-z0-9-]. Must not be NULL.
1059 * A unique name for this input module, suitable for use in GUI
1060 * clients, can contain UTF-8. Must not be NULL.
1065 * A short description of the input module. Must not be NULL.
1067 * This can be displayed by frontends, e.g. when selecting the input
1068 * module for saving a file.
1073 * A NULL terminated array of strings containing a list of file name
1074 * extensions typical for the input file format, or NULL if there is
1075 * no typical extension for this file format.
1077 const char *const *exts;
1080 * Zero-terminated list of metadata items the module needs to be able
1081 * to identify an input stream. Can be all-zero, if the module cannot
1082 * identify streams at all, i.e. has to be forced into use.
1084 * Each item is one of:
1085 * SR_INPUT_META_FILENAME
1086 * SR_INPUT_META_FILESIZE
1087 * SR_INPUT_META_HEADER
1089 * If the high bit (SR_INPUT META_REQUIRED) is set, the module cannot
1090 * identify a stream without the given metadata.
1092 const uint8_t metadata[8];
1095 * Returns a NULL-terminated list of options this module can take.
1096 * Can be NULL, if the module has no options.
1098 const struct sr_option *(*options) (void);
1101 * Check if this input module can load and parse the specified stream.
1103 * @param[in] metadata Metadata the module can use to identify the stream.
1104 * @param[out] confidence "Strength" of the detection.
1105 * Specialized handlers can take precedence over generic/basic support.
1107 * @retval SR_OK This module knows the format.
1108 * @retval SR_ERR_NA There wasn't enough data for this module to
1109 * positively identify the format.
1110 * @retval SR_ERR_DATA This module knows the format, but cannot handle
1111 * it. This means the stream is either corrupt, or indicates a
1112 * feature that the module does not support.
1113 * @retval SR_ERR This module does not know the format.
1115 * Lower numeric values of 'confidence' mean that the input module
1116 * stronger believes in its capability to handle this specific format.
1117 * This way, multiple input modules can claim support for a format,
1118 * and the application can pick the best match, or try fallbacks
1119 * in case of errors. This approach also copes with formats that
1120 * are unreliable to detect in the absence of magic signatures.
1122 int (*format_match) (GHashTable *metadata, unsigned int *confidence);
1125 * Initialize the input module.
1127 * @retval SR_OK Success
1128 * @retval other Negative error code.
1130 int (*init) (struct sr_input *in, GHashTable *options);
1133 * Send data to the specified input instance.
1135 * When an input module instance is created with sr_input_new(), this
1136 * function is used to feed data to the instance.
1138 * As enough data gets fed into this function to completely populate
1139 * the device instance associated with this input instance, this is
1140 * guaranteed to return the moment it's ready. This gives the caller
1141 * the chance to examine the device instance, attach session callbacks
1144 * @retval SR_OK Success
1145 * @retval other Negative error code.
1147 int (*receive) (struct sr_input *in, GString *buf);
1150 * Signal the input module no more data will come.
1152 * This will cause the module to process any data it may have buffered.
1153 * The SR_DF_END packet will also typically be sent at this time.
1155 int (*end) (struct sr_input *in);
1158 * Reset the input module's input handling structures.
1160 * Causes the input module to reset its internal state so that we can
1161 * re-send the input data from the beginning without having to
1162 * re-create the entire input module.
1164 * @retval SR_OK Success.
1165 * @retval other Negative error code.
1167 int (*reset) (struct sr_input *in);
1170 * This function is called after the caller is finished using
1171 * the input module, and can be used to free any internal
1172 * resources the module may keep.
1174 * This function is optional.
1176 * @retval SR_OK Success
1177 * @retval other Negative error code.
1179 void (*cleanup) (struct sr_input *in);
1182 /** Output module instance. */
1184 /** A pointer to this output's module. */
1185 const struct sr_output_module *module;
1188 * The device for which this output module is creating output. This
1189 * can be used by the module to find out channel names and numbers.
1191 const struct sr_dev_inst *sdi;
1194 * The name of the file that the data should be written to.
1196 const char *filename;
1199 * A generic pointer which can be used by the module to keep internal
1200 * state between calls into its callback functions.
1202 * For example, the module might store a pointer to a chunk of output
1203 * there, and only flush it when it reaches a certain size.
1208 /** Output module driver. */
1209 struct sr_output_module {
1211 * A unique ID for this output module, suitable for use in command-line
1212 * clients, [a-z0-9-]. Must not be NULL.
1217 * A unique name for this output module, suitable for use in GUI
1218 * clients, can contain UTF-8. Must not be NULL.
1223 * A short description of the output module. Must not be NULL.
1225 * This can be displayed by frontends, e.g. when selecting the output
1226 * module for saving a file.
1231 * A NULL terminated array of strings containing a list of file name
1232 * extensions typical for the input file format, or NULL if there is
1233 * no typical extension for this file format.
1235 const char *const *exts;
1238 * Bitfield containing flags that describe certain properties
1239 * this output module may or may not have.
1240 * @see sr_output_flags
1242 const uint64_t flags;
1245 * Returns a NULL-terminated list of options this module can take.
1246 * Can be NULL, if the module has no options.
1248 const struct sr_option *(*options) (void);
1251 * This function is called once, at the beginning of an output stream.
1253 * The device struct will be available in the output struct passed in,
1254 * as well as the param field -- which may be NULL or an empty string,
1255 * if no parameter was passed.
1257 * The module can use this to initialize itself, create a struct for
1258 * keeping state and storing it in the <code>internal</code> field.
1260 * @param o Pointer to the respective 'struct sr_output'.
1262 * @retval SR_OK Success
1263 * @retval other Negative error code.
1265 int (*init) (struct sr_output *o, GHashTable *options);
1268 * This function is passed a copy of every packet in the data feed.
1269 * Any output generated by the output module in response to the
1270 * packet should be returned in a newly allocated GString
1271 * <code>out</code>, which will be freed by the caller.
1273 * Packets not of interest to the output module can just be ignored,
1274 * and the <code>out</code> parameter set to NULL.
1276 * @param o Pointer to the respective 'struct sr_output'.
1277 * @param sdi The device instance that generated the packet.
1278 * @param packet The complete packet.
1279 * @param out A pointer where a GString * should be stored if
1280 * the module generates output, or NULL if not.
1282 * @retval SR_OK Success
1283 * @retval other Negative error code.
1285 int (*receive) (const struct sr_output *o,
1286 const struct sr_datafeed_packet *packet, GString **out);
1289 * This function is called after the caller is finished using
1290 * the output module, and can be used to free any internal
1291 * resources the module may keep.
1293 * @retval SR_OK Success
1294 * @retval other Negative error code.
1296 int (*cleanup) (struct sr_output *o);
1299 /** Transform module instance. */
1300 struct sr_transform {
1301 /** A pointer to this transform's module. */
1302 const struct sr_transform_module *module;
1305 * The device for which this transform module is used. This
1306 * can be used by the module to find out channel names and numbers.
1308 const struct sr_dev_inst *sdi;
1311 * A generic pointer which can be used by the module to keep internal
1312 * state between calls into its callback functions.
1317 struct sr_transform_module {
1319 * A unique ID for this transform module, suitable for use in
1320 * command-line clients, [a-z0-9-]. Must not be NULL.
1325 * A unique name for this transform module, suitable for use in GUI
1326 * clients, can contain UTF-8. Must not be NULL.
1331 * A short description of the transform module. Must not be NULL.
1333 * This can be displayed by frontends, e.g. when selecting
1334 * which transform module(s) to add.
1339 * Returns a NULL-terminated list of options this transform module
1340 * can take. Can be NULL, if the transform module has no options.
1342 const struct sr_option *(*options) (void);
1345 * This function is called once, at the beginning of a stream.
1347 * @param t Pointer to the respective 'struct sr_transform'.
1348 * @param options Hash table of options for this transform module.
1349 * Can be NULL if no options are to be used.
1351 * @retval SR_OK Success
1352 * @retval other Negative error code.
1354 int (*init) (struct sr_transform *t, GHashTable *options);
1357 * This function is passed a pointer to every packet in the data feed.
1359 * It can either return (in packet_out) a pointer to another packet
1360 * (possibly the exact same packet it got as input), or NULL.
1362 * @param t Pointer to the respective 'struct sr_transform'.
1363 * @param packet_in Pointer to a datafeed packet.
1364 * @param packet_out Pointer to the resulting datafeed packet after
1365 * this function was run. If NULL, the transform
1366 * module intentionally didn't output a new packet.
1368 * @retval SR_OK Success
1369 * @retval other Negative error code.
1371 int (*receive) (const struct sr_transform *t,
1372 struct sr_datafeed_packet *packet_in,
1373 struct sr_datafeed_packet **packet_out);
1376 * This function is called after the caller is finished using
1377 * the transform module, and can be used to free any internal
1378 * resources the module may keep.
1380 * @retval SR_OK Success
1381 * @retval other Negative error code.
1383 int (*cleanup) (struct sr_transform *t);
1386 #ifdef HAVE_LIBUSB_1_0
1387 /** USB device instance */
1388 struct sr_usb_dev_inst {
1391 /** Device address on USB bus */
1393 /** libusb device handle */
1394 struct libusb_device_handle *devhdl;
1398 struct sr_serial_dev_inst;
1399 #ifdef HAVE_SERIAL_COMM
1400 struct ser_lib_functions;
1401 struct ser_hid_chip_functions;
1403 typedef void (*serial_rx_chunk_callback)(struct sr_serial_dev_inst *serial,
1404 void *cb_data, const void *buf, size_t count);
1405 struct sr_serial_dev_inst {
1406 /** Port name, e.g. '/dev/tty42'. */
1408 /** Comm params for serial_set_paramstr(). */
1410 struct ser_lib_functions *lib_funcs;
1417 GString *rcv_buffer;
1418 serial_rx_chunk_callback rx_chunk_cb_func;
1419 void *rx_chunk_cb_data;
1420 #ifdef HAVE_LIBSERIALPORT
1421 /** libserialport port handle */
1422 struct sp_port *sp_data;
1424 #ifdef HAVE_LIBHIDAPI
1425 enum ser_hid_chip_t {
1426 SER_HID_CHIP_UNKNOWN, /**!< place holder */
1427 SER_HID_CHIP_BTC_BU86X, /**!< Brymen BU86x */
1428 SER_HID_CHIP_SIL_CP2110, /**!< SiLabs CP2110 */
1429 SER_HID_CHIP_VICTOR_DMM, /**!< Victor 70/86 DMM cable */
1430 SER_HID_CHIP_WCH_CH9325, /**!< WCH CH9325 */
1431 SER_HID_CHIP_LAST, /**!< sentinel */
1433 struct ser_hid_chip_functions *hid_chip_funcs;
1436 const char *hid_path;
1437 hid_device *hid_dev;
1438 GSList *hid_source_args;
1440 #ifdef HAVE_BLUETOOTH
1441 enum ser_bt_conn_t {
1442 SER_BT_CONN_UNKNOWN, /**!< place holder */
1443 SER_BT_CONN_RFCOMM, /**!< BT classic, RFCOMM channel */
1444 SER_BT_CONN_BLE122, /**!< BLE, BLE122 module, indications */
1445 SER_BT_CONN_NRF51, /**!< BLE, Nordic nRF51, notifications */
1446 SER_BT_CONN_CC254x, /**!< BLE, TI CC254x, notifications */
1447 SER_BT_CONN_MAX, /**!< sentinel */
1449 char *bt_addr_local;
1450 char *bt_addr_remote;
1451 size_t bt_rfcomm_channel;
1452 uint16_t bt_notify_handle_read;
1453 uint16_t bt_notify_handle_write;
1454 uint16_t bt_notify_handle_cccd;
1455 uint16_t bt_notify_value_cccd;
1456 struct sr_bt_desc *bt_desc;
1457 GSList *bt_source_args;
1462 struct sr_usbtmc_dev_inst {
1467 /* Private driver context. */
1468 struct drv_context {
1469 /** sigrok context */
1470 struct sr_context *sr_ctx;
1474 /*--- log.c -----------------------------------------------------------------*/
1476 #if defined(_WIN32) && (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 4))
1478 * On MinGW, we need to specify the gnu_printf format flavor or GCC
1479 * will assume non-standard Microsoft printf syntax.
1481 SR_PRIV int sr_log(int loglevel, const char *format, ...)
1482 __attribute__((__format__ (__gnu_printf__, 2, 3)));
1484 SR_PRIV int sr_log(int loglevel, const char *format, ...) G_GNUC_PRINTF(2, 3);
1487 /* Message logging helpers with subsystem-specific prefix string. */
1488 #define sr_spew(...) sr_log(SR_LOG_SPEW, LOG_PREFIX ": " __VA_ARGS__)
1489 #define sr_dbg(...) sr_log(SR_LOG_DBG, LOG_PREFIX ": " __VA_ARGS__)
1490 #define sr_info(...) sr_log(SR_LOG_INFO, LOG_PREFIX ": " __VA_ARGS__)
1491 #define sr_warn(...) sr_log(SR_LOG_WARN, LOG_PREFIX ": " __VA_ARGS__)
1492 #define sr_err(...) sr_log(SR_LOG_ERR, LOG_PREFIX ": " __VA_ARGS__)
1494 /*--- device.c --------------------------------------------------------------*/
1496 /** Scan options supported by a driver. */
1497 #define SR_CONF_SCAN_OPTIONS 0x7FFF0000
1499 /** Device options for a particular device. */
1500 #define SR_CONF_DEVICE_OPTIONS 0x7FFF0001
1502 /** Mask for separating config keys from capabilities. */
1503 #define SR_CONF_MASK 0x1fffffff
1505 /** Values for the changes argument of sr_dev_driver.config_channel_set. */
1507 /** The enabled state of the channel has been changed. */
1508 SR_CHANNEL_SET_ENABLED = 1 << 0,
1511 SR_PRIV struct sr_channel *sr_channel_new(struct sr_dev_inst *sdi,
1512 int index, int type, gboolean enabled, const char *name);
1513 SR_PRIV void sr_channel_free(struct sr_channel *ch);
1514 SR_PRIV void sr_channel_free_cb(void *p);
1515 SR_PRIV struct sr_channel *sr_next_enabled_channel(const struct sr_dev_inst *sdi,
1516 struct sr_channel *cur_channel);
1517 SR_PRIV gboolean sr_channels_differ(struct sr_channel *ch1, struct sr_channel *ch2);
1518 SR_PRIV gboolean sr_channel_lists_differ(GSList *l1, GSList *l2);
1520 /** Device instance data */
1521 struct sr_dev_inst {
1522 /** Device driver. */
1523 struct sr_dev_driver *driver;
1524 /** Device instance status. SR_ST_NOT_FOUND, etc. */
1526 /** Device instance type. SR_INST_USB, etc. */
1528 /** Device vendor. */
1530 /** Device model. */
1532 /** Device version. */
1534 /** Serial number. */
1536 /** Connection string to uniquely identify devices. */
1537 char *connection_id;
1538 /** List of channels. */
1540 /** List of sr_channel_group structs */
1541 GSList *channel_groups;
1542 /** Device instance connection data (used?) */
1544 /** Device instance private data (used?) */
1546 /** Session to which this device is currently assigned. */
1547 struct sr_session *session;
1550 /* Generic device instances */
1551 SR_PRIV void sr_dev_inst_free(struct sr_dev_inst *sdi);
1553 #ifdef HAVE_LIBUSB_1_0
1554 /* USB-specific instances */
1555 SR_PRIV struct sr_usb_dev_inst *sr_usb_dev_inst_new(uint8_t bus,
1556 uint8_t address, struct libusb_device_handle *hdl);
1557 SR_PRIV void sr_usb_dev_inst_free(struct sr_usb_dev_inst *usb);
1560 #ifdef HAVE_SERIAL_COMM
1561 #ifndef HAVE_LIBSERIALPORT
1563 * Some identifiers which initially got provided by libserialport are
1564 * used internally within the libsigrok serial layer's implementation,
1565 * while libserialport no longer is the exclusive provider of serial
1566 * communication support. Declare the identifiers here so they remain
1567 * available across all build configurations.
1574 SP_PARITY_SPACE = 4,
1577 enum libsp_flowcontrol {
1578 SP_FLOWCONTROL_NONE = 0,
1579 SP_FLOWCONTROL_XONXOFF = 1,
1580 SP_FLOWCONTROL_RTSCTS = 2,
1581 SP_FLOWCONTROL_DTRDSR = 3,
1585 /* Serial-specific instances */
1586 SR_PRIV struct sr_serial_dev_inst *sr_serial_dev_inst_new(const char *port,
1587 const char *serialcomm);
1588 SR_PRIV void sr_serial_dev_inst_free(struct sr_serial_dev_inst *serial);
1591 /* USBTMC-specific instances */
1592 SR_PRIV struct sr_usbtmc_dev_inst *sr_usbtmc_dev_inst_new(const char *device);
1593 SR_PRIV void sr_usbtmc_dev_inst_free(struct sr_usbtmc_dev_inst *usbtmc);
1595 /*--- hwdriver.c ------------------------------------------------------------*/
1597 SR_PRIV const GVariantType *sr_variant_type_get(int datatype);
1598 SR_PRIV int sr_variant_type_check(uint32_t key, GVariant *data);
1599 SR_PRIV void sr_hw_cleanup_all(const struct sr_context *ctx);
1600 SR_PRIV struct sr_config *sr_config_new(uint32_t key, GVariant *data);
1601 SR_PRIV void sr_config_free(struct sr_config *src);
1602 SR_PRIV int sr_dev_acquisition_start(struct sr_dev_inst *sdi);
1603 SR_PRIV int sr_dev_acquisition_stop(struct sr_dev_inst *sdi);
1605 /*--- session.c -------------------------------------------------------------*/
1608 /** Context this session exists in. */
1609 struct sr_context *ctx;
1610 /** List of struct sr_dev_inst pointers. */
1612 /** List of struct sr_dev_inst pointers owned by this session. */
1614 /** List of struct datafeed_callback pointers. */
1615 GSList *datafeed_callbacks;
1617 struct sr_trigger *trigger;
1619 /** Callback to invoke on session stop. */
1620 sr_session_stopped_callback stopped_callback;
1621 /** User data to be passed to the session stop callback. */
1622 void *stopped_cb_data;
1624 /** Mutex protecting the main context pointer. */
1626 /** Context of the session main loop. */
1627 GMainContext *main_context;
1629 /** Registered event sources for this session. */
1630 GHashTable *event_sources;
1631 /** Session main loop. */
1632 GMainLoop *main_loop;
1633 /** ID of idle source for dispatching the session stop notification. */
1634 unsigned int stop_check_id;
1635 /** Whether the session has been started. */
1639 SR_PRIV int sr_session_source_add_internal(struct sr_session *session,
1640 void *key, GSource *source);
1641 SR_PRIV int sr_session_source_remove_internal(struct sr_session *session,
1643 SR_PRIV int sr_session_source_destroyed(struct sr_session *session,
1644 void *key, GSource *source);
1645 SR_PRIV int sr_session_fd_source_add(struct sr_session *session,
1646 void *key, gintptr fd, int events, int timeout,
1647 sr_receive_data_callback cb, void *cb_data);
1649 SR_PRIV int sr_session_source_add(struct sr_session *session, int fd,
1650 int events, int timeout, sr_receive_data_callback cb, void *cb_data);
1651 SR_PRIV int sr_session_source_add_pollfd(struct sr_session *session,
1652 GPollFD *pollfd, int timeout, sr_receive_data_callback cb,
1654 SR_PRIV int sr_session_source_add_channel(struct sr_session *session,
1655 GIOChannel *channel, int events, int timeout,
1656 sr_receive_data_callback cb, void *cb_data);
1657 SR_PRIV int sr_session_source_remove(struct sr_session *session, int fd);
1658 SR_PRIV int sr_session_source_remove_pollfd(struct sr_session *session,
1660 SR_PRIV int sr_session_source_remove_channel(struct sr_session *session,
1661 GIOChannel *channel);
1663 SR_PRIV int sr_session_send_meta(const struct sr_dev_inst *sdi,
1664 uint32_t key, GVariant *var);
1665 SR_PRIV int sr_session_send(const struct sr_dev_inst *sdi,
1666 const struct sr_datafeed_packet *packet);
1667 SR_PRIV int sr_sessionfile_check(const char *filename);
1668 SR_PRIV struct sr_dev_inst *sr_session_prepare_sdi(const char *filename,
1669 struct sr_session **session);
1671 /*--- session_file.c --------------------------------------------------------*/
1673 #if !HAVE_ZIP_DISCARD
1674 /* Replace zip_discard() if not available. */
1675 #define zip_discard(zip) sr_zip_discard(zip)
1676 SR_PRIV void sr_zip_discard(struct zip *archive);
1679 SR_PRIV GKeyFile *sr_sessionfile_read_metadata(struct zip *archive,
1680 const struct zip_stat *entry);
1682 /*--- analog.c --------------------------------------------------------------*/
1684 SR_PRIV int sr_analog_init(struct sr_datafeed_analog *analog,
1685 struct sr_analog_encoding *encoding,
1686 struct sr_analog_meaning *meaning,
1687 struct sr_analog_spec *spec,
1690 /*--- std.c -----------------------------------------------------------------*/
1692 typedef int (*dev_close_callback)(struct sr_dev_inst *sdi);
1693 typedef void (*std_dev_clear_callback)(void *priv);
1695 SR_PRIV int std_init(struct sr_dev_driver *di, struct sr_context *sr_ctx);
1696 SR_PRIV int std_cleanup(const struct sr_dev_driver *di);
1697 SR_PRIV int std_dummy_dev_open(struct sr_dev_inst *sdi);
1698 SR_PRIV int std_dummy_dev_close(struct sr_dev_inst *sdi);
1699 SR_PRIV int std_dummy_dev_acquisition_start(const struct sr_dev_inst *sdi);
1700 SR_PRIV int std_dummy_dev_acquisition_stop(struct sr_dev_inst *sdi);
1701 #ifdef HAVE_SERIAL_COMM
1702 SR_PRIV int std_serial_dev_open(struct sr_dev_inst *sdi);
1703 SR_PRIV int std_serial_dev_acquisition_stop(struct sr_dev_inst *sdi);
1705 SR_PRIV int std_session_send_df_header(const struct sr_dev_inst *sdi);
1706 SR_PRIV int std_session_send_df_end(const struct sr_dev_inst *sdi);
1707 SR_PRIV int std_session_send_df_trigger(const struct sr_dev_inst *sdi);
1708 SR_PRIV int std_session_send_df_frame_begin(const struct sr_dev_inst *sdi);
1709 SR_PRIV int std_session_send_df_frame_end(const struct sr_dev_inst *sdi);
1710 SR_PRIV int std_dev_clear_with_callback(const struct sr_dev_driver *driver,
1711 std_dev_clear_callback clear_private);
1712 SR_PRIV int std_dev_clear(const struct sr_dev_driver *driver);
1713 SR_PRIV GSList *std_dev_list(const struct sr_dev_driver *di);
1714 SR_PRIV int std_serial_dev_close(struct sr_dev_inst *sdi);
1715 SR_PRIV GSList *std_scan_complete(struct sr_dev_driver *di, GSList *devices);
1717 SR_PRIV int std_opts_config_list(uint32_t key, GVariant **data,
1718 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg,
1719 const uint32_t scanopts[], size_t scansize, const uint32_t drvopts[],
1720 size_t drvsize, const uint32_t devopts[], size_t devsize);
1722 extern SR_PRIV const uint32_t NO_OPTS[1];
1724 #define STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts) \
1725 std_opts_config_list(key, data, sdi, cg, ARRAY_AND_SIZE(scanopts), \
1726 ARRAY_AND_SIZE(drvopts), ARRAY_AND_SIZE(devopts))
1728 SR_PRIV GVariant *std_gvar_tuple_array(const uint64_t a[][2], unsigned int n);
1729 SR_PRIV GVariant *std_gvar_tuple_rational(const struct sr_rational *r, unsigned int n);
1730 SR_PRIV GVariant *std_gvar_samplerates(const uint64_t samplerates[], unsigned int n);
1731 SR_PRIV GVariant *std_gvar_samplerates_steps(const uint64_t samplerates[], unsigned int n);
1732 SR_PRIV GVariant *std_gvar_min_max_step(double min, double max, double step);
1733 SR_PRIV GVariant *std_gvar_min_max_step_array(const double a[3]);
1734 SR_PRIV GVariant *std_gvar_min_max_step_thresholds(const double dmin, const double dmax, const double dstep);
1736 SR_PRIV GVariant *std_gvar_tuple_u64(uint64_t low, uint64_t high);
1737 SR_PRIV GVariant *std_gvar_tuple_double(double low, double high);
1739 SR_PRIV GVariant *std_gvar_array_i32(const int32_t a[], unsigned int n);
1740 SR_PRIV GVariant *std_gvar_array_u32(const uint32_t a[], unsigned int n);
1741 SR_PRIV GVariant *std_gvar_array_u64(const uint64_t a[], unsigned int n);
1742 SR_PRIV GVariant *std_gvar_array_str(const char *a[], unsigned int n);
1744 SR_PRIV GVariant *std_gvar_thresholds(const double a[][2], unsigned int n);
1746 SR_PRIV int std_str_idx(GVariant *data, const char *a[], unsigned int n);
1747 SR_PRIV int std_u64_idx(GVariant *data, const uint64_t a[], unsigned int n);
1748 SR_PRIV int std_u8_idx(GVariant *data, const uint8_t a[], unsigned int n);
1750 SR_PRIV int std_str_idx_s(const char *s, const char *a[], unsigned int n);
1751 SR_PRIV int std_u8_idx_s(uint8_t b, const uint8_t a[], unsigned int n);
1753 SR_PRIV int std_u64_tuple_idx(GVariant *data, const uint64_t a[][2], unsigned int n);
1754 SR_PRIV int std_double_tuple_idx(GVariant *data, const double a[][2], unsigned int n);
1755 SR_PRIV int std_double_tuple_idx_d0(const double d, const double a[][2], unsigned int n);
1757 SR_PRIV int std_cg_idx(const struct sr_channel_group *cg, struct sr_channel_group *a[], unsigned int n);
1759 SR_PRIV int std_dummy_set_params(struct sr_serial_dev_inst *serial,
1760 int baudrate, int bits, int parity, int stopbits,
1761 int flowcontrol, int rts, int dtr);
1762 SR_PRIV int std_dummy_set_handshake(struct sr_serial_dev_inst *serial,
1765 /*--- resource.c ------------------------------------------------------------*/
1767 SR_PRIV int64_t sr_file_get_size(FILE *file);
1769 SR_PRIV int sr_resource_open(struct sr_context *ctx,
1770 struct sr_resource *res, int type, const char *name)
1771 G_GNUC_WARN_UNUSED_RESULT;
1772 SR_PRIV int sr_resource_close(struct sr_context *ctx,
1773 struct sr_resource *res);
1774 SR_PRIV gssize sr_resource_read(struct sr_context *ctx,
1775 const struct sr_resource *res, void *buf, size_t count)
1776 G_GNUC_WARN_UNUSED_RESULT;
1777 SR_PRIV void *sr_resource_load(struct sr_context *ctx, int type,
1778 const char *name, size_t *size, size_t max_size)
1779 G_GNUC_MALLOC G_GNUC_WARN_UNUSED_RESULT;
1781 /*--- strutil.c -------------------------------------------------------------*/
1783 SR_PRIV int sr_atol(const char *str, long *ret);
1784 SR_PRIV int sr_atol_base(const char *str, long *ret, char **end, int base);
1785 SR_PRIV int sr_atoi(const char *str, int *ret);
1786 SR_PRIV int sr_atod(const char *str, double *ret);
1787 SR_PRIV int sr_atof(const char *str, float *ret);
1788 SR_PRIV int sr_atod_ascii(const char *str, double *ret);
1789 SR_PRIV int sr_atof_ascii(const char *str, float *ret);
1791 SR_PRIV GString *sr_hexdump_new(const uint8_t *data, const size_t len);
1792 SR_PRIV void sr_hexdump_free(GString *s);
1794 /*--- soft-trigger.c --------------------------------------------------------*/
1796 struct soft_trigger_logic {
1797 const struct sr_dev_inst *sdi;
1798 const struct sr_trigger *trigger;
1802 uint8_t *prev_sample;
1803 uint8_t *pre_trigger_buffer;
1804 uint8_t *pre_trigger_head;
1805 int pre_trigger_size;
1806 int pre_trigger_fill;
1809 SR_PRIV int logic_channel_unitsize(GSList *channels);
1810 SR_PRIV struct soft_trigger_logic *soft_trigger_logic_new(
1811 const struct sr_dev_inst *sdi, struct sr_trigger *trigger,
1812 int pre_trigger_samples);
1813 SR_PRIV void soft_trigger_logic_free(struct soft_trigger_logic *st);
1814 SR_PRIV int soft_trigger_logic_check(struct soft_trigger_logic *st, uint8_t *buf,
1815 int len, int *pre_trigger_samples);
1817 /*--- serial.c --------------------------------------------------------------*/
1819 #ifdef HAVE_SERIAL_COMM
1825 typedef gboolean (*packet_valid_callback)(const uint8_t *buf);
1827 typedef GSList *(*sr_ser_list_append_t)(GSList *devs, const char *name,
1829 typedef GSList *(*sr_ser_find_append_t)(GSList *devs, const char *name);
1831 SR_PRIV int serial_open(struct sr_serial_dev_inst *serial, int flags);
1832 SR_PRIV int serial_close(struct sr_serial_dev_inst *serial);
1833 SR_PRIV int serial_flush(struct sr_serial_dev_inst *serial);
1834 SR_PRIV int serial_drain(struct sr_serial_dev_inst *serial);
1835 SR_PRIV size_t serial_has_receive_data(struct sr_serial_dev_inst *serial);
1836 SR_PRIV int serial_write_blocking(struct sr_serial_dev_inst *serial,
1837 const void *buf, size_t count, unsigned int timeout_ms);
1838 SR_PRIV int serial_write_nonblocking(struct sr_serial_dev_inst *serial,
1839 const void *buf, size_t count);
1840 SR_PRIV int serial_read_blocking(struct sr_serial_dev_inst *serial, void *buf,
1841 size_t count, unsigned int timeout_ms);
1842 SR_PRIV int serial_read_nonblocking(struct sr_serial_dev_inst *serial, void *buf,
1844 SR_PRIV int serial_set_read_chunk_cb(struct sr_serial_dev_inst *serial,
1845 serial_rx_chunk_callback cb, void *cb_data);
1846 SR_PRIV int serial_set_params(struct sr_serial_dev_inst *serial, int baudrate,
1847 int bits, int parity, int stopbits, int flowcontrol, int rts, int dtr);
1848 SR_PRIV int serial_set_handshake(struct sr_serial_dev_inst *serial,
1850 SR_PRIV int serial_set_paramstr(struct sr_serial_dev_inst *serial,
1851 const char *paramstr);
1852 SR_PRIV int serial_readline(struct sr_serial_dev_inst *serial, char **buf,
1853 int *buflen, gint64 timeout_ms);
1854 SR_PRIV int serial_stream_detect(struct sr_serial_dev_inst *serial,
1855 uint8_t *buf, size_t *buflen,
1857 packet_valid_callback is_valid,
1858 uint64_t timeout_ms);
1859 SR_PRIV int sr_serial_extract_options(GSList *options, const char **serial_device,
1860 const char **serial_options);
1861 SR_PRIV int serial_source_add(struct sr_session *session,
1862 struct sr_serial_dev_inst *serial, int events, int timeout,
1863 sr_receive_data_callback cb, void *cb_data);
1864 SR_PRIV int serial_source_remove(struct sr_session *session,
1865 struct sr_serial_dev_inst *serial);
1866 SR_PRIV GSList *sr_serial_find_usb(uint16_t vendor_id, uint16_t product_id);
1867 SR_PRIV int serial_timeout(struct sr_serial_dev_inst *port, int num_bytes);
1869 SR_PRIV void sr_ser_discard_queued_data(struct sr_serial_dev_inst *serial);
1870 SR_PRIV size_t sr_ser_has_queued_data(struct sr_serial_dev_inst *serial);
1871 SR_PRIV void sr_ser_queue_rx_data(struct sr_serial_dev_inst *serial,
1872 const uint8_t *data, size_t len);
1873 SR_PRIV size_t sr_ser_unqueue_rx_data(struct sr_serial_dev_inst *serial,
1874 uint8_t *data, size_t len);
1876 struct ser_lib_functions {
1877 int (*open)(struct sr_serial_dev_inst *serial, int flags);
1878 int (*close)(struct sr_serial_dev_inst *serial);
1879 int (*flush)(struct sr_serial_dev_inst *serial);
1880 int (*drain)(struct sr_serial_dev_inst *serial);
1881 int (*write)(struct sr_serial_dev_inst *serial,
1882 const void *buf, size_t count,
1883 int nonblocking, unsigned int timeout_ms);
1884 int (*read)(struct sr_serial_dev_inst *serial,
1885 void *buf, size_t count,
1886 int nonblocking, unsigned int timeout_ms);
1887 int (*set_params)(struct sr_serial_dev_inst *serial,
1888 int baudrate, int bits, int parity, int stopbits,
1889 int flowcontrol, int rts, int dtr);
1890 int (*set_handshake)(struct sr_serial_dev_inst *serial,
1892 int (*setup_source_add)(struct sr_session *session,
1893 struct sr_serial_dev_inst *serial,
1894 int events, int timeout,
1895 sr_receive_data_callback cb, void *cb_data);
1896 int (*setup_source_remove)(struct sr_session *session,
1897 struct sr_serial_dev_inst *serial);
1898 GSList *(*list)(GSList *list, sr_ser_list_append_t append);
1899 GSList *(*find_usb)(GSList *list, sr_ser_find_append_t append,
1900 uint16_t vendor_id, uint16_t product_id);
1901 int (*get_frame_format)(struct sr_serial_dev_inst *serial,
1902 int *baud, int *bits);
1903 size_t (*get_rx_avail)(struct sr_serial_dev_inst *serial);
1905 extern SR_PRIV struct ser_lib_functions *ser_lib_funcs_libsp;
1906 SR_PRIV int ser_name_is_hid(struct sr_serial_dev_inst *serial);
1907 extern SR_PRIV struct ser_lib_functions *ser_lib_funcs_hid;
1908 SR_PRIV int ser_name_is_bt(struct sr_serial_dev_inst *serial);
1909 extern SR_PRIV struct ser_lib_functions *ser_lib_funcs_bt;
1911 #ifdef HAVE_LIBHIDAPI
1912 struct vid_pid_item {
1916 struct ser_hid_chip_functions {
1917 const char *chipname;
1918 const char *chipdesc;
1919 const struct vid_pid_item *vid_pid_items;
1920 const int max_bytes_per_request;
1921 int (*set_params)(struct sr_serial_dev_inst *serial,
1922 int baudrate, int bits, int parity, int stopbits,
1923 int flowcontrol, int rts, int dtr);
1924 int (*read_bytes)(struct sr_serial_dev_inst *serial,
1925 uint8_t *data, int space, unsigned int timeout);
1926 int (*write_bytes)(struct sr_serial_dev_inst *serial,
1927 const uint8_t *data, int space);
1928 int (*flush)(struct sr_serial_dev_inst *serial);
1929 int (*drain)(struct sr_serial_dev_inst *serial);
1931 extern SR_PRIV struct ser_hid_chip_functions *ser_hid_chip_funcs_bu86x;
1932 extern SR_PRIV struct ser_hid_chip_functions *ser_hid_chip_funcs_ch9325;
1933 extern SR_PRIV struct ser_hid_chip_functions *ser_hid_chip_funcs_cp2110;
1934 extern SR_PRIV struct ser_hid_chip_functions *ser_hid_chip_funcs_victor;
1935 SR_PRIV const char *ser_hid_chip_find_name_vid_pid(uint16_t vid, uint16_t pid);
1939 /*--- bt/ API ---------------------------------------------------------------*/
1941 #ifdef HAVE_BLUETOOTH
1942 SR_PRIV const char *sr_bt_adapter_get_address(size_t idx);
1945 typedef void (*sr_bt_scan_cb)(void *cb_data, const char *addr, const char *name);
1946 typedef int (*sr_bt_data_cb)(void *cb_data, uint8_t *data, size_t dlen);
1948 SR_PRIV struct sr_bt_desc *sr_bt_desc_new(void);
1949 SR_PRIV void sr_bt_desc_free(struct sr_bt_desc *desc);
1951 SR_PRIV int sr_bt_config_cb_scan(struct sr_bt_desc *desc,
1952 sr_bt_scan_cb cb, void *cb_data);
1953 SR_PRIV int sr_bt_config_cb_data(struct sr_bt_desc *desc,
1954 sr_bt_data_cb cb, void *cb_data);
1955 SR_PRIV int sr_bt_config_addr_local(struct sr_bt_desc *desc, const char *addr);
1956 SR_PRIV int sr_bt_config_addr_remote(struct sr_bt_desc *desc, const char *addr);
1957 SR_PRIV int sr_bt_config_rfcomm(struct sr_bt_desc *desc, size_t channel);
1958 SR_PRIV int sr_bt_config_notify(struct sr_bt_desc *desc,
1959 uint16_t read_handle, uint16_t write_handle,
1960 uint16_t cccd_handle, uint16_t cccd_value);
1962 SR_PRIV int sr_bt_scan_le(struct sr_bt_desc *desc, int duration);
1963 SR_PRIV int sr_bt_scan_bt(struct sr_bt_desc *desc, int duration);
1965 SR_PRIV int sr_bt_connect_ble(struct sr_bt_desc *desc);
1966 SR_PRIV int sr_bt_connect_rfcomm(struct sr_bt_desc *desc);
1967 SR_PRIV void sr_bt_disconnect(struct sr_bt_desc *desc);
1969 SR_PRIV ssize_t sr_bt_read(struct sr_bt_desc *desc,
1970 void *data, size_t len);
1971 SR_PRIV ssize_t sr_bt_write(struct sr_bt_desc *desc,
1972 const void *data, size_t len);
1974 SR_PRIV int sr_bt_start_notify(struct sr_bt_desc *desc);
1975 SR_PRIV int sr_bt_check_notify(struct sr_bt_desc *desc);
1978 /*--- ezusb.c ---------------------------------------------------------------*/
1980 #ifdef HAVE_LIBUSB_1_0
1981 SR_PRIV int ezusb_reset(struct libusb_device_handle *hdl, int set_clear);
1982 SR_PRIV int ezusb_install_firmware(struct sr_context *ctx, libusb_device_handle *hdl,
1984 SR_PRIV int ezusb_upload_firmware(struct sr_context *ctx, libusb_device *dev,
1985 int configuration, const char *name);
1988 /*--- usb.c -----------------------------------------------------------------*/
1990 #ifdef HAVE_LIBUSB_1_0
1991 SR_PRIV GSList *sr_usb_find(libusb_context *usb_ctx, const char *conn);
1992 SR_PRIV int sr_usb_open(libusb_context *usb_ctx, struct sr_usb_dev_inst *usb);
1993 SR_PRIV void sr_usb_close(struct sr_usb_dev_inst *usb);
1994 SR_PRIV int usb_source_add(struct sr_session *session, struct sr_context *ctx,
1995 int timeout, sr_receive_data_callback cb, void *cb_data);
1996 SR_PRIV int usb_source_remove(struct sr_session *session, struct sr_context *ctx);
1997 SR_PRIV int usb_get_port_path(libusb_device *dev, char *path, int path_len);
1998 SR_PRIV gboolean usb_match_manuf_prod(libusb_device *dev,
1999 const char *manufacturer, const char *product);
2002 /*--- binary_helpers.c ------------------------------------------------------*/
2004 /** Binary value type */
2005 enum binary_value_type {
2007 BVT_BE_UINT8 = BVT_UINT8,
2008 BVT_LE_UINT8 = BVT_UINT8,
2021 /** Binary value specification */
2022 struct binary_value_spec {
2023 /** Offset into binary blob */
2025 /** Data type to decode */
2026 enum binary_value_type type;
2027 /** Scale factor to get native units */
2031 /** Binary channel definition */
2032 struct binary_analog_channel {
2035 /** Binary value in data stream */
2036 struct binary_value_spec spec;
2037 /** Significant digits */
2039 /** Measured quantity */
2041 /** Measured unit */
2046 * Read extract a value from a binary blob.
2048 * @param out Pointer to output buffer.
2049 * @param spec Binary value specification
2050 * @param data Pointer to binary blob
2051 * @param length Size of binary blob
2052 * @return SR_OK on success, SR_ERR_* error code on failure.
2054 SR_PRIV int bv_get_value(float *out, const struct binary_value_spec *spec, const void *data, size_t length);
2057 * Send an analog channel packet based on a binary analog channel
2060 * @param sdi Device instance
2061 * @param ch Sigrok channel
2062 * @param spec Channel specification
2063 * @param data Pointer to binary blob
2064 * @param length Size of binary blob
2065 * @return SR_OK on success, SR_ERR_* error code on failure.
2067 SR_PRIV int bv_send_analog_channel(const struct sr_dev_inst *sdi, struct sr_channel *ch,
2068 const struct binary_analog_channel *spec, const void *data, size_t length);
2070 /*--- crc.c -----------------------------------------------------------------*/
2072 #define SR_CRC16_DEFAULT_INIT 0xffffU
2075 * Calculate a CRC16 checksum using the 0x8005 polynomial.
2077 * This CRC16 flavor is also known as CRC16-ANSI or CRC16-MODBUS.
2079 * @param crc Initial value (typically 0xffff)
2080 * @param buffer Input buffer
2081 * @param len Buffer length
2084 SR_PRIV uint16_t sr_crc16(uint16_t crc, const uint8_t *buffer, int len);
2086 /*--- modbus/modbus.c -------------------------------------------------------*/
2088 struct sr_modbus_dev_inst {
2092 GSList *(*scan)(int modbusaddr);
2093 int (*dev_inst_new)(void *priv, const char *resource,
2094 char **params, const char *serialcomm, int modbusaddr);
2095 int (*open)(void *priv);
2096 int (*source_add)(struct sr_session *session, void *priv, int events,
2097 int timeout, sr_receive_data_callback cb, void *cb_data);
2098 int (*source_remove)(struct sr_session *session, void *priv);
2099 int (*send)(void *priv, const uint8_t *buffer, int buffer_size);
2100 int (*read_begin)(void *priv, uint8_t *function_code);
2101 int (*read_data)(void *priv, uint8_t *buf, int maxlen);
2102 int (*read_end)(void *priv);
2103 int (*close)(void *priv);
2104 void (*free)(void *priv);
2105 unsigned int read_timeout_ms;
2109 SR_PRIV GSList *sr_modbus_scan(struct drv_context *drvc, GSList *options,
2110 struct sr_dev_inst *(*probe_device)(struct sr_modbus_dev_inst *modbus));
2111 SR_PRIV struct sr_modbus_dev_inst *modbus_dev_inst_new(const char *resource,
2112 const char *serialcomm, int modbusaddr);
2113 SR_PRIV int sr_modbus_open(struct sr_modbus_dev_inst *modbus);
2114 SR_PRIV int sr_modbus_source_add(struct sr_session *session,
2115 struct sr_modbus_dev_inst *modbus, int events, int timeout,
2116 sr_receive_data_callback cb, void *cb_data);
2117 SR_PRIV int sr_modbus_source_remove(struct sr_session *session,
2118 struct sr_modbus_dev_inst *modbus);
2119 SR_PRIV int sr_modbus_request(struct sr_modbus_dev_inst *modbus,
2120 uint8_t *request, int request_size);
2121 SR_PRIV int sr_modbus_reply(struct sr_modbus_dev_inst *modbus,
2122 uint8_t *reply, int reply_size);
2123 SR_PRIV int sr_modbus_request_reply(struct sr_modbus_dev_inst *modbus,
2124 uint8_t *request, int request_size,
2125 uint8_t *reply, int reply_size);
2126 SR_PRIV int sr_modbus_read_coils(struct sr_modbus_dev_inst *modbus,
2127 int address, int nb_coils, uint8_t *coils);
2128 SR_PRIV int sr_modbus_read_holding_registers(struct sr_modbus_dev_inst *modbus,
2129 int address, int nb_registers,
2130 uint16_t *registers);
2131 SR_PRIV int sr_modbus_write_coil(struct sr_modbus_dev_inst *modbus,
2132 int address, int value);
2133 SR_PRIV int sr_modbus_write_multiple_registers(struct sr_modbus_dev_inst*modbus,
2134 int address, int nb_registers,
2135 uint16_t *registers);
2136 SR_PRIV int sr_modbus_close(struct sr_modbus_dev_inst *modbus);
2137 SR_PRIV void sr_modbus_free(struct sr_modbus_dev_inst *modbus);
2139 /*--- dmm/es519xx.c ---------------------------------------------------------*/
2142 * All 11-byte es519xx chips repeat each block twice for each conversion cycle
2143 * so always read 2 blocks at a time.
2145 #define ES519XX_11B_PACKET_SIZE (11 * 2)
2146 #define ES519XX_14B_PACKET_SIZE 14
2148 struct es519xx_info {
2149 gboolean is_judge, is_voltage, is_auto, is_micro, is_current;
2150 gboolean is_milli, is_resistance, is_continuity, is_diode;
2151 gboolean is_frequency, is_rpm, is_capacitance, is_duty_cycle;
2152 gboolean is_temperature, is_celsius, is_fahrenheit;
2153 gboolean is_adp0, is_adp1, is_adp2, is_adp3;
2154 gboolean is_sign, is_batt, is_ol, is_pmax, is_pmin, is_apo;
2155 gboolean is_dc, is_ac, is_vahz, is_min, is_max, is_rel, is_hold;
2156 gboolean is_digit4, is_ul, is_vasel, is_vbar, is_lpf1, is_lpf0, is_rmr;
2159 gboolean alt_functions, fivedigits, clampmeter, selectable_lpf;
2163 SR_PRIV gboolean sr_es519xx_2400_11b_packet_valid(const uint8_t *buf);
2164 SR_PRIV int sr_es519xx_2400_11b_parse(const uint8_t *buf, float *floatval,
2165 struct sr_datafeed_analog *analog, void *info);
2166 SR_PRIV gboolean sr_es519xx_2400_11b_altfn_packet_valid(const uint8_t *buf);
2167 SR_PRIV int sr_es519xx_2400_11b_altfn_parse(const uint8_t *buf,
2168 float *floatval, struct sr_datafeed_analog *analog, void *info);
2169 SR_PRIV gboolean sr_es519xx_19200_11b_5digits_packet_valid(const uint8_t *buf);
2170 SR_PRIV int sr_es519xx_19200_11b_5digits_parse(const uint8_t *buf,
2171 float *floatval, struct sr_datafeed_analog *analog, void *info);
2172 SR_PRIV gboolean sr_es519xx_19200_11b_clamp_packet_valid(const uint8_t *buf);
2173 SR_PRIV int sr_es519xx_19200_11b_clamp_parse(const uint8_t *buf,
2174 float *floatval, struct sr_datafeed_analog *analog, void *info);
2175 SR_PRIV gboolean sr_es519xx_19200_11b_packet_valid(const uint8_t *buf);
2176 SR_PRIV int sr_es519xx_19200_11b_parse(const uint8_t *buf, float *floatval,
2177 struct sr_datafeed_analog *analog, void *info);
2178 SR_PRIV gboolean sr_es519xx_19200_14b_packet_valid(const uint8_t *buf);
2179 SR_PRIV int sr_es519xx_19200_14b_parse(const uint8_t *buf, float *floatval,
2180 struct sr_datafeed_analog *analog, void *info);
2181 SR_PRIV gboolean sr_es519xx_19200_14b_sel_lpf_packet_valid(const uint8_t *buf);
2182 SR_PRIV int sr_es519xx_19200_14b_sel_lpf_parse(const uint8_t *buf,
2183 float *floatval, struct sr_datafeed_analog *analog, void *info);
2185 /*--- dmm/fs9922.c ----------------------------------------------------------*/
2187 #define FS9922_PACKET_SIZE 14
2189 struct fs9922_info {
2190 gboolean is_auto, is_dc, is_ac, is_rel, is_hold, is_bpn, is_z1, is_z2;
2191 gboolean is_max, is_min, is_apo, is_bat, is_nano, is_z3, is_micro;
2192 gboolean is_milli, is_kilo, is_mega, is_beep, is_diode, is_percent;
2193 gboolean is_z4, is_volt, is_ampere, is_ohm, is_hfe, is_hertz, is_farad;
2194 gboolean is_celsius, is_fahrenheit;
2195 int bargraph_sign, bargraph_value;
2198 SR_PRIV gboolean sr_fs9922_packet_valid(const uint8_t *buf);
2199 SR_PRIV int sr_fs9922_parse(const uint8_t *buf, float *floatval,
2200 struct sr_datafeed_analog *analog, void *info);
2201 SR_PRIV void sr_fs9922_z1_diode(struct sr_datafeed_analog *analog, void *info);
2203 /*--- dmm/fs9721.c ----------------------------------------------------------*/
2205 #define FS9721_PACKET_SIZE 14
2207 struct fs9721_info {
2208 gboolean is_ac, is_dc, is_auto, is_rs232, is_micro, is_nano, is_kilo;
2209 gboolean is_diode, is_milli, is_percent, is_mega, is_beep, is_farad;
2210 gboolean is_ohm, is_rel, is_hold, is_ampere, is_volt, is_hz, is_bat;
2211 gboolean is_c2c1_11, is_c2c1_10, is_c2c1_01, is_c2c1_00, is_sign;
2214 SR_PRIV gboolean sr_fs9721_packet_valid(const uint8_t *buf);
2215 SR_PRIV int sr_fs9721_parse(const uint8_t *buf, float *floatval,
2216 struct sr_datafeed_analog *analog, void *info);
2217 SR_PRIV void sr_fs9721_00_temp_c(struct sr_datafeed_analog *analog, void *info);
2218 SR_PRIV void sr_fs9721_01_temp_c(struct sr_datafeed_analog *analog, void *info);
2219 SR_PRIV void sr_fs9721_10_temp_c(struct sr_datafeed_analog *analog, void *info);
2220 SR_PRIV void sr_fs9721_01_10_temp_f_c(struct sr_datafeed_analog *analog, void *info);
2221 SR_PRIV void sr_fs9721_max_c_min(struct sr_datafeed_analog *analog, void *info);
2223 /*--- dmm/ms2115b.c ---------------------------------------------------------*/
2225 #define MS2115B_PACKET_SIZE 9
2227 enum ms2115b_display {
2228 MS2115B_DISPLAY_MAIN,
2229 MS2115B_DISPLAY_SUB,
2230 MS2115B_DISPLAY_COUNT,
2233 struct ms2115b_info {
2234 /* Selected channel. */
2236 gboolean is_ac, is_dc, is_auto;
2237 gboolean is_diode, is_beep, is_farad;
2238 gboolean is_ohm, is_ampere, is_volt, is_hz;
2239 gboolean is_duty_cycle, is_percent;
2242 extern SR_PRIV const char *ms2115b_channel_formats[];
2243 SR_PRIV gboolean sr_ms2115b_packet_valid(const uint8_t *buf);
2244 SR_PRIV int sr_ms2115b_parse(const uint8_t *buf, float *floatval,
2245 struct sr_datafeed_analog *analog, void *info);
2247 /*--- dmm/ms8250d.c ---------------------------------------------------------*/
2249 #define MS8250D_PACKET_SIZE 18
2251 struct ms8250d_info {
2252 gboolean is_ac, is_dc, is_auto, is_rs232, is_micro, is_nano, is_kilo;
2253 gboolean is_diode, is_milli, is_percent, is_mega, is_beep, is_farad;
2254 gboolean is_ohm, is_rel, is_hold, is_ampere, is_volt, is_hz, is_bat;
2255 gboolean is_ncv, is_min, is_max, is_sign, is_autotimer;
2258 SR_PRIV gboolean sr_ms8250d_packet_valid(const uint8_t *buf);
2259 SR_PRIV int sr_ms8250d_parse(const uint8_t *buf, float *floatval,
2260 struct sr_datafeed_analog *analog, void *info);
2262 /*--- dmm/dtm0660.c ---------------------------------------------------------*/
2264 #define DTM0660_PACKET_SIZE 15
2266 struct dtm0660_info {
2267 gboolean is_ac, is_dc, is_auto, is_rs232, is_micro, is_nano, is_kilo;
2268 gboolean is_diode, is_milli, is_percent, is_mega, is_beep, is_farad;
2269 gboolean is_ohm, is_rel, is_hold, is_ampere, is_volt, is_hz, is_bat;
2270 gboolean is_degf, is_degc, is_c2c1_01, is_c2c1_00, is_apo, is_min;
2271 gboolean is_minmax, is_max, is_sign;
2274 SR_PRIV gboolean sr_dtm0660_packet_valid(const uint8_t *buf);
2275 SR_PRIV int sr_dtm0660_parse(const uint8_t *buf, float *floatval,
2276 struct sr_datafeed_analog *analog, void *info);
2278 /*--- dmm/m2110.c -----------------------------------------------------------*/
2280 #define BBCGM_M2110_PACKET_SIZE 9
2282 /* Dummy info struct. The parser does not use it. */
2283 struct m2110_info { int dummy; };
2285 SR_PRIV gboolean sr_m2110_packet_valid(const uint8_t *buf);
2286 SR_PRIV int sr_m2110_parse(const uint8_t *buf, float *floatval,
2287 struct sr_datafeed_analog *analog, void *info);
2289 /*--- dmm/metex14.c ---------------------------------------------------------*/
2291 #define METEX14_PACKET_SIZE 14
2293 struct metex14_info {
2295 gboolean is_ac, is_dc, is_resistance, is_capacity, is_temperature;
2296 gboolean is_diode, is_frequency, is_ampere, is_volt, is_farad;
2297 gboolean is_hertz, is_ohm, is_celsius, is_fahrenheit, is_watt;
2298 gboolean is_pico, is_nano, is_micro, is_milli, is_kilo, is_mega;
2299 gboolean is_gain, is_decibel, is_power, is_decibel_mw, is_power_factor;
2300 gboolean is_hfe, is_unitless, is_logic, is_min, is_max, is_avg;
2303 #ifdef HAVE_SERIAL_COMM
2304 SR_PRIV int sr_metex14_packet_request(struct sr_serial_dev_inst *serial);
2306 SR_PRIV gboolean sr_metex14_packet_valid(const uint8_t *buf);
2307 SR_PRIV int sr_metex14_parse(const uint8_t *buf, float *floatval,
2308 struct sr_datafeed_analog *analog, void *info);
2309 SR_PRIV gboolean sr_metex14_4packets_valid(const uint8_t *buf);
2310 SR_PRIV int sr_metex14_4packets_parse(const uint8_t *buf, float *floatval,
2311 struct sr_datafeed_analog *analog, void *info);
2313 /*--- dmm/rs9lcd.c ----------------------------------------------------------*/
2315 #define RS9LCD_PACKET_SIZE 9
2317 /* Dummy info struct. The parser does not use it. */
2318 struct rs9lcd_info { int dummy; };
2320 SR_PRIV gboolean sr_rs9lcd_packet_valid(const uint8_t *buf);
2321 SR_PRIV int sr_rs9lcd_parse(const uint8_t *buf, float *floatval,
2322 struct sr_datafeed_analog *analog, void *info);
2324 /*--- dmm/bm25x.c -----------------------------------------------------------*/
2326 #define BRYMEN_BM25X_PACKET_SIZE 15
2328 /* Dummy info struct. The parser does not use it. */
2329 struct bm25x_info { int dummy; };
2331 SR_PRIV gboolean sr_brymen_bm25x_packet_valid(const uint8_t *buf);
2332 SR_PRIV int sr_brymen_bm25x_parse(const uint8_t *buf, float *floatval,
2333 struct sr_datafeed_analog *analog, void *info);
2335 /*--- dmm/bm52x.c -----------------------------------------------------------*/
2337 #define BRYMEN_BM52X_PACKET_SIZE 24
2338 #define BRYMEN_BM52X_DISPLAY_COUNT 2
2340 struct brymen_bm52x_info { size_t ch_idx; };
2342 #ifdef HAVE_SERIAL_COMM
2343 SR_PRIV int sr_brymen_bm52x_packet_request(struct sr_serial_dev_inst *serial);
2345 SR_PRIV gboolean sr_brymen_bm52x_packet_valid(const uint8_t *buf);
2346 SR_PRIV int sr_brymen_bm52x_parse(const uint8_t *buf, float *floatval,
2347 struct sr_datafeed_analog *analog, void *info);
2349 /*--- dmm/bm86x.c -----------------------------------------------------------*/
2351 #define BRYMEN_BM86X_PACKET_SIZE 24
2352 #define BRYMEN_BM86X_DISPLAY_COUNT 2
2354 struct brymen_bm86x_info { size_t ch_idx; };
2356 #ifdef HAVE_SERIAL_COMM
2357 SR_PRIV int sr_brymen_bm86x_packet_request(struct sr_serial_dev_inst *serial);
2359 SR_PRIV gboolean sr_brymen_bm86x_packet_valid(const uint8_t *buf);
2360 SR_PRIV int sr_brymen_bm86x_parse(const uint8_t *buf, float *floatval,
2361 struct sr_datafeed_analog *analog, void *info);
2363 /*--- dmm/ut71x.c -----------------------------------------------------------*/
2365 #define UT71X_PACKET_SIZE 11
2368 gboolean is_voltage, is_resistance, is_capacitance, is_temperature;
2369 gboolean is_celsius, is_fahrenheit, is_current, is_continuity;
2370 gboolean is_diode, is_frequency, is_duty_cycle, is_dc, is_ac;
2371 gboolean is_auto, is_manual, is_sign, is_power, is_loop_current;
2374 SR_PRIV gboolean sr_ut71x_packet_valid(const uint8_t *buf);
2375 SR_PRIV int sr_ut71x_parse(const uint8_t *buf, float *floatval,
2376 struct sr_datafeed_analog *analog, void *info);
2378 /*--- dmm/vc870.c -----------------------------------------------------------*/
2380 #define VC870_PACKET_SIZE 23
2383 gboolean is_voltage, is_dc, is_ac, is_temperature, is_resistance;
2384 gboolean is_continuity, is_capacitance, is_diode, is_loop_current;
2385 gboolean is_current, is_micro, is_milli, is_power;
2386 gboolean is_power_factor_freq, is_power_apparent_power, is_v_a_rms_value;
2387 gboolean is_sign2, is_sign1, is_batt, is_ol1, is_max, is_min;
2388 gboolean is_maxmin, is_rel, is_ol2, is_open, is_manu, is_hold;
2389 gboolean is_light, is_usb, is_warning, is_auto_power, is_misplug_warn;
2390 gboolean is_lo, is_hi, is_open2;
2392 gboolean is_frequency, is_dual_display, is_auto;
2395 SR_PRIV gboolean sr_vc870_packet_valid(const uint8_t *buf);
2396 SR_PRIV int sr_vc870_parse(const uint8_t *buf, float *floatval,
2397 struct sr_datafeed_analog *analog, void *info);
2399 /*--- dmm/vc96.c ------------------------------------------------------------*/
2401 #define VC96_PACKET_SIZE 13
2405 gboolean is_ac, is_dc, is_resistance, is_diode, is_ampere, is_volt;
2406 gboolean is_ohm, is_micro, is_milli, is_kilo, is_mega, is_hfe;
2407 gboolean is_unitless;
2410 SR_PRIV gboolean sr_vc96_packet_valid(const uint8_t *buf);
2411 SR_PRIV int sr_vc96_parse(const uint8_t *buf, float *floatval,
2412 struct sr_datafeed_analog *analog, void *info);
2414 /*--- lcr/es51919.c ---------------------------------------------------------*/
2416 /* Acquisition details which apply to all supported serial-lcr devices. */
2417 struct lcr_parse_info {
2419 uint64_t output_freq;
2420 const char *circuit_model;
2423 #define ES51919_PACKET_SIZE 17
2424 #define ES51919_CHANNEL_COUNT 2
2425 #define ES51919_COMM_PARAM "9600/8n1/rts=1/dtr=1"
2427 SR_PRIV int es51919_config_get(uint32_t key, GVariant **data,
2428 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg);
2429 SR_PRIV int es51919_config_set(uint32_t key, GVariant *data,
2430 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg);
2431 SR_PRIV int es51919_config_list(uint32_t key, GVariant **data,
2432 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg);
2433 SR_PRIV gboolean es51919_packet_valid(const uint8_t *pkt);
2434 SR_PRIV int es51919_packet_parse(const uint8_t *pkt, float *floatval,
2435 struct sr_datafeed_analog *analog, void *info);
2437 /*--- lcr/vc4080.c ----------------------------------------------------------*/
2439 /* Note: Also uses 'struct lcr_parse_info' from es51919 above. */
2441 #define VC4080_PACKET_SIZE 39
2442 #define VC4080_COMM_PARAM "1200/8n1"
2443 #define VC4080_WITH_DQ_CHANS 0 /* Enable separate D/Q channels? */
2445 enum vc4080_display {
2446 VC4080_DISPLAY_PRIMARY,
2447 VC4080_DISPLAY_SECONDARY,
2448 #if VC4080_WITH_DQ_CHANS
2449 VC4080_DISPLAY_D_VALUE,
2450 VC4080_DISPLAY_Q_VALUE,
2452 VC4080_CHANNEL_COUNT,
2455 extern SR_PRIV const char *vc4080_channel_formats[VC4080_CHANNEL_COUNT];
2457 SR_PRIV int vc4080_config_list(uint32_t key, GVariant **data,
2458 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg);
2459 SR_PRIV int vc4080_packet_request(struct sr_serial_dev_inst *serial);
2460 SR_PRIV gboolean vc4080_packet_valid(const uint8_t *pkt);
2461 SR_PRIV int vc4080_packet_parse(const uint8_t *pkt, float *floatval,
2462 struct sr_datafeed_analog *analog, void *info);
2464 /*--- dmm/ut372.c -----------------------------------------------------------*/
2466 #define UT372_PACKET_SIZE 27
2472 SR_PRIV gboolean sr_ut372_packet_valid(const uint8_t *buf);
2473 SR_PRIV int sr_ut372_parse(const uint8_t *buf, float *floatval,
2474 struct sr_datafeed_analog *analog, void *info);
2476 /*--- dmm/asycii.c ----------------------------------------------------------*/
2478 #define ASYCII_PACKET_SIZE 16
2480 struct asycii_info {
2481 gboolean is_ac, is_dc, is_ac_and_dc;
2482 gboolean is_resistance, is_capacitance, is_diode, is_gain;
2483 gboolean is_frequency, is_duty_cycle, is_duty_pos, is_duty_neg;
2484 gboolean is_pulse_width, is_period_pos, is_period_neg;
2485 gboolean is_pulse_count, is_count_pos, is_count_neg;
2486 gboolean is_ampere, is_volt, is_volt_ampere, is_farad, is_ohm;
2487 gboolean is_hertz, is_percent, is_seconds, is_decibel;
2488 gboolean is_pico, is_nano, is_micro, is_milli, is_kilo, is_mega;
2489 gboolean is_unitless;
2490 gboolean is_peak_min, is_peak_max;
2491 gboolean is_invalid;
2494 #ifdef HAVE_SERIAL_COMM
2495 SR_PRIV int sr_asycii_packet_request(struct sr_serial_dev_inst *serial);
2497 SR_PRIV gboolean sr_asycii_packet_valid(const uint8_t *buf);
2498 SR_PRIV int sr_asycii_parse(const uint8_t *buf, float *floatval,
2499 struct sr_datafeed_analog *analog, void *info);
2501 /*--- dmm/eev121gw.c --------------------------------------------------------*/
2503 #define EEV121GW_PACKET_SIZE 19
2505 enum eev121gw_display {
2506 EEV121GW_DISPLAY_MAIN,
2507 EEV121GW_DISPLAY_SUB,
2508 EEV121GW_DISPLAY_BAR,
2509 EEV121GW_DISPLAY_COUNT,
2512 struct eev121gw_info {
2513 /* Selected channel. */
2516 * Measured value, number and sign/overflow flags, scale factor
2517 * and significant digits.
2519 uint32_t uint_value;
2520 gboolean is_ofl, is_neg;
2522 /* Currently active mode (meter's function). */
2523 gboolean is_ac, is_dc, is_voltage, is_current, is_power, is_gain;
2524 gboolean is_resistance, is_capacitance, is_diode, is_temperature;
2525 gboolean is_continuity, is_frequency, is_period, is_duty_cycle;
2526 /* Quantities associated with mode/function. */
2527 gboolean is_ampere, is_volt, is_volt_ampere, is_dbm;
2528 gboolean is_ohm, is_farad, is_celsius, is_fahrenheit;
2529 gboolean is_hertz, is_seconds, is_percent, is_loop_current;
2530 gboolean is_unitless, is_logic;
2531 /* Other indicators. */
2532 gboolean is_min, is_max, is_avg, is_1ms_peak, is_rel, is_hold;
2533 gboolean is_low_pass, is_mem, is_bt, is_auto_range, is_test;
2534 gboolean is_auto_poweroff, is_low_batt;
2537 extern SR_PRIV const char *eev121gw_channel_formats[];
2538 SR_PRIV gboolean sr_eev121gw_packet_valid(const uint8_t *buf);
2539 SR_PRIV int sr_eev121gw_3displays_parse(const uint8_t *buf, float *floatval,
2540 struct sr_datafeed_analog *analog, void *info);
2542 /*--- scale/kern.c ----------------------------------------------------------*/
2545 gboolean is_gram, is_carat, is_ounce, is_pound, is_troy_ounce;
2546 gboolean is_pennyweight, is_grain, is_tael, is_momme, is_tola;
2547 gboolean is_percentage, is_piece, is_unstable, is_stable, is_error;
2551 SR_PRIV gboolean sr_kern_packet_valid(const uint8_t *buf);
2552 SR_PRIV int sr_kern_parse(const uint8_t *buf, float *floatval,
2553 struct sr_datafeed_analog *analog, void *info);
2555 /*--- sw_limits.c -----------------------------------------------------------*/
2557 struct sr_sw_limits {
2558 uint64_t limit_samples;
2559 uint64_t limit_frames;
2560 uint64_t limit_msec;
2561 uint64_t samples_read;
2562 uint64_t frames_read;
2563 uint64_t start_time;
2566 SR_PRIV int sr_sw_limits_config_get(const struct sr_sw_limits *limits, uint32_t key,
2568 SR_PRIV int sr_sw_limits_config_set(struct sr_sw_limits *limits, uint32_t key,
2570 SR_PRIV void sr_sw_limits_acquisition_start(struct sr_sw_limits *limits);
2571 SR_PRIV gboolean sr_sw_limits_check(struct sr_sw_limits *limits);
2572 SR_PRIV void sr_sw_limits_update_samples_read(struct sr_sw_limits *limits,
2573 uint64_t samples_read);
2574 SR_PRIV void sr_sw_limits_update_frames_read(struct sr_sw_limits *limits,
2575 uint64_t frames_read);
2576 SR_PRIV void sr_sw_limits_init(struct sr_sw_limits *limits);
2578 /*--- feed_queue.h ----------------------------------------------------------*/
2580 struct feed_queue_logic;
2581 struct feed_queue_analog;
2583 SR_API struct feed_queue_logic *feed_queue_logic_alloc(
2584 struct sr_dev_inst *sdi,
2585 size_t sample_count, size_t unit_size);
2586 SR_API int feed_queue_logic_submit(struct feed_queue_logic *q,
2587 const uint8_t *data, size_t count);
2588 SR_API int feed_queue_logic_flush(struct feed_queue_logic *q);
2589 SR_API void feed_queue_logic_free(struct feed_queue_logic *q);
2591 SR_API struct feed_queue_analog *feed_queue_analog_alloc(
2592 struct sr_dev_inst *sdi,
2593 size_t sample_count, int digits, struct sr_channel *ch);
2594 SR_API int feed_queue_analog_submit(struct feed_queue_analog *q,
2595 float data, size_t count);
2596 SR_API int feed_queue_analog_flush(struct feed_queue_analog *q);
2597 SR_API void feed_queue_analog_free(struct feed_queue_analog *q);