]> sigrok.org Git - libsigrok.git/blame - src/libsigrok-internal.h
brymen-bm86x: rename specific Brymen BM86x driver (libusb implementation)
[libsigrok.git] / src / libsigrok-internal.h
CommitLineData
1483577e 1/*
50985c20 2 * This file is part of the libsigrok project.
1483577e 3 *
13d8e03c 4 * Copyright (C) 2013 Bert Vermeulen <bert@biot.com>
1483577e
UH
5 *
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.
10 *
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.
15 *
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/>.
18 */
19
d9251a2c
UH
20/**
21 * @file
22 *
23 * @internal
24 */
04cb9157 25
a5827886
UH
26#ifndef LIBSIGROK_LIBSIGROK_INTERNAL_H
27#define LIBSIGROK_LIBSIGROK_INTERNAL_H
1483577e 28
1df81f4b
GS
29#include "config.h"
30
cc8a7d25 31#include <glib.h>
4417074c
GS
32#ifdef HAVE_LIBHIDAPI
33#include <hidapi.h>
34#endif
c4f2dfd0 35#ifdef HAVE_LIBSERIALPORT
dc991353 36#include <libserialport.h>
c4f2dfd0 37#endif
fdcdfe53
GS
38#ifdef HAVE_LIBUSB_1_0
39#include <libusb.h>
40#endif
41#include <stdarg.h>
ad5aa993 42#include <stdint.h>
fdcdfe53 43#include <stdio.h>
ae4c1fb6 44#include <stdlib.h>
b08024a8 45
98654c99
DE
46struct zip;
47struct zip_stat;
48
393fb9cb
UH
49/**
50 * @file
51 *
52 * libsigrok private header file, only to be used internally.
53 */
54
4cea9eb2
UH
55/*--- Macros ----------------------------------------------------------------*/
56
57#ifndef ARRAY_SIZE
58#define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0]))
59#endif
60
61#ifndef ARRAY_AND_SIZE
62#define ARRAY_AND_SIZE(a) (a), ARRAY_SIZE(a)
63#endif
64
a4f9c35b 65/**
5bf0dd6a 66 * Read a 8 bits unsigned integer out of memory.
a4f9c35b 67 * @param x a pointer to the input memory
5bf0dd6a 68 * @return the corresponding unsigned integer
a4f9c35b
AJ
69 */
70#define R8(x) ((unsigned)((const uint8_t*)(x))[0])
71
e28ef28a 72/**
5bf0dd6a 73 * Read a 16 bits big endian unsigned integer out of memory.
e28ef28a 74 * @param x a pointer to the input memory
5bf0dd6a 75 * @return the corresponding unsigned integer
e28ef28a 76 */
d01c4c56 77#define RB16(x) (((unsigned)((const uint8_t*)(x))[0] << 8) | \
79a1176b 78 (unsigned)((const uint8_t*)(x))[1])
e28ef28a
AJ
79
80/**
5bf0dd6a 81 * Read a 16 bits little endian unsigned integer out of memory.
e28ef28a 82 * @param x a pointer to the input memory
5bf0dd6a 83 * @return the corresponding unsigned integer
e28ef28a 84 */
79a1176b
AJ
85#define RL16(x) (((unsigned)((const uint8_t*)(x))[1] << 8) | \
86 (unsigned)((const uint8_t*)(x))[0])
e28ef28a 87
4d376e08
SB
88/**
89 * Read a 16 bits big endian signed integer out of memory.
90 * @param x a pointer to the input memory
91 * @return the corresponding signed integer
92 */
93#define RB16S(x) ((int16_t) \
94 (((unsigned)((const uint8_t*)(x))[0] << 8) | \
95 (unsigned)((const uint8_t*)(x))[1]))
96
e28ef28a 97/**
5bf0dd6a 98 * Read a 16 bits little endian signed integer out of memory.
e28ef28a 99 * @param x a pointer to the input memory
5bf0dd6a
BV
100 * @return the corresponding signed integer
101 */
102#define RL16S(x) ((int16_t) \
af945a66 103 (((unsigned)((const uint8_t*)(x))[1] << 8) | \
5bf0dd6a
BV
104 (unsigned)((const uint8_t*)(x))[0]))
105
106/**
107 * Read a 32 bits big endian unsigned integer out of memory.
108 * @param x a pointer to the input memory
109 * @return the corresponding unsigned integer
e28ef28a 110 */
79a1176b 111#define RB32(x) (((unsigned)((const uint8_t*)(x))[0] << 24) | \
d01c4c56
SA
112 ((unsigned)((const uint8_t*)(x))[1] << 16) | \
113 ((unsigned)((const uint8_t*)(x))[2] << 8) | \
79a1176b 114 (unsigned)((const uint8_t*)(x))[3])
e28ef28a
AJ
115
116/**
5bf0dd6a 117 * Read a 32 bits little endian unsigned integer out of memory.
e28ef28a 118 * @param x a pointer to the input memory
5bf0dd6a 119 * @return the corresponding unsigned integer
e28ef28a 120 */
79a1176b 121#define RL32(x) (((unsigned)((const uint8_t*)(x))[3] << 24) | \
d01c4c56
SA
122 ((unsigned)((const uint8_t*)(x))[2] << 16) | \
123 ((unsigned)((const uint8_t*)(x))[1] << 8) | \
79a1176b 124 (unsigned)((const uint8_t*)(x))[0])
e28ef28a 125
4d376e08
SB
126/**
127 * Read a 32 bits big endian signed integer out of memory.
128 * @param x a pointer to the input memory
129 * @return the corresponding signed integer
130 */
131#define RB32S(x) ((int32_t) \
132 (((unsigned)((const uint8_t*)(x))[0] << 24) | \
133 ((unsigned)((const uint8_t*)(x))[1] << 16) | \
134 ((unsigned)((const uint8_t*)(x))[2] << 8) | \
135 (unsigned)((const uint8_t*)(x))[3]))
136
ea2d6d99 137/**
5bf0dd6a
BV
138 * Read a 32 bits little endian signed integer out of memory.
139 * @param x a pointer to the input memory
140 * @return the corresponding signed integer
141 */
142#define RL32S(x) ((int32_t) \
143 (((unsigned)((const uint8_t*)(x))[3] << 24) | \
d01c4c56
SA
144 ((unsigned)((const uint8_t*)(x))[2] << 16) | \
145 ((unsigned)((const uint8_t*)(x))[1] << 8) | \
5bf0dd6a
BV
146 (unsigned)((const uint8_t*)(x))[0]))
147
17b93fd7
TS
148/**
149 * Read a 64 bits big endian unsigned integer out of memory.
150 * @param x a pointer to the input memory
151 * @return the corresponding unsigned integer
152 */
153#define RB64(x) (((uint64_t)((const uint8_t*)(x))[0] << 56) | \
d01c4c56
SA
154 ((uint64_t)((const uint8_t*)(x))[1] << 48) | \
155 ((uint64_t)((const uint8_t*)(x))[2] << 40) | \
156 ((uint64_t)((const uint8_t*)(x))[3] << 32) | \
157 ((uint64_t)((const uint8_t*)(x))[4] << 24) | \
158 ((uint64_t)((const uint8_t*)(x))[5] << 16) | \
159 ((uint64_t)((const uint8_t*)(x))[6] << 8) | \
17b93fd7
TS
160 (uint64_t)((const uint8_t*)(x))[7])
161
8a66b077
SA
162/**
163 * Read a 64 bits little endian unsigned integer out of memory.
164 * @param x a pointer to the input memory
165 * @return the corresponding unsigned integer
166 */
167#define RL64(x) (((uint64_t)((const uint8_t*)(x))[7] << 56) | \
168 ((uint64_t)((const uint8_t*)(x))[6] << 48) | \
169 ((uint64_t)((const uint8_t*)(x))[5] << 40) | \
170 ((uint64_t)((const uint8_t*)(x))[4] << 32) | \
171 ((uint64_t)((const uint8_t*)(x))[3] << 24) | \
172 ((uint64_t)((const uint8_t*)(x))[2] << 16) | \
173 ((uint64_t)((const uint8_t*)(x))[1] << 8) | \
174 (uint64_t)((const uint8_t*)(x))[0])
175
176/**
177 * Read a 64 bits little endian signed integer out of memory.
178 * @param x a pointer to the input memory
179 * @return the corresponding unsigned integer
180 */
181#define RL64S(x) ((int64_t) \
182 (((uint64_t)((const uint8_t*)(x))[7] << 56) | \
183 ((uint64_t)((const uint8_t*)(x))[6] << 48) | \
184 ((uint64_t)((const uint8_t*)(x))[5] << 40) | \
185 ((uint64_t)((const uint8_t*)(x))[4] << 32) | \
186 ((uint64_t)((const uint8_t*)(x))[3] << 24) | \
187 ((uint64_t)((const uint8_t*)(x))[2] << 16) | \
188 ((uint64_t)((const uint8_t*)(x))[1] << 8) | \
189 (uint64_t)((const uint8_t*)(x))[0]))
190
a2632bca
AJ
191/**
192 * Read a 32 bits big endian float out of memory.
193 * @param x a pointer to the input memory
194 * @return the corresponding float
195 */
196#define RBFL(x) ((union { uint32_t u; float f; }) { .u = RB32(x) }.f)
197
198/**
199 * Read a 32 bits little endian float out of memory.
200 * @param x a pointer to the input memory
201 * @return the corresponding float
202 */
203#define RLFL(x) ((union { uint32_t u; float f; }) { .u = RL32(x) }.f)
204
5bf0dd6a
BV
205/**
206 * Write a 8 bits unsigned integer to memory.
ea2d6d99 207 * @param p a pointer to the output memory
5bf0dd6a 208 * @param x the input unsigned integer
ea2d6d99 209 */
0c5f2abc 210#define W8(p, x) do { ((uint8_t*)(p))[0] = (uint8_t) (x); } while (0)
ea2d6d99
AJ
211
212/**
5bf0dd6a 213 * Write a 16 bits unsigned integer to memory stored as big endian.
ea2d6d99 214 * @param p a pointer to the output memory
5bf0dd6a 215 * @param x the input unsigned integer
ea2d6d99
AJ
216 */
217#define WB16(p, x) do { ((uint8_t*)(p))[1] = (uint8_t) (x); \
0c5f2abc 218 ((uint8_t*)(p))[0] = (uint8_t)((x)>>8); } while (0)
ea2d6d99
AJ
219
220/**
5bf0dd6a 221 * Write a 16 bits unsigned integer to memory stored as little endian.
ea2d6d99 222 * @param p a pointer to the output memory
5bf0dd6a 223 * @param x the input unsigned integer
ea2d6d99
AJ
224 */
225#define WL16(p, x) do { ((uint8_t*)(p))[0] = (uint8_t) (x); \
0c5f2abc 226 ((uint8_t*)(p))[1] = (uint8_t)((x)>>8); } while (0)
ea2d6d99
AJ
227
228/**
5bf0dd6a 229 * Write a 32 bits unsigned integer to memory stored as big endian.
ea2d6d99 230 * @param p a pointer to the output memory
5bf0dd6a 231 * @param x the input unsigned integer
ea2d6d99
AJ
232 */
233#define WB32(p, x) do { ((uint8_t*)(p))[3] = (uint8_t) (x); \
234 ((uint8_t*)(p))[2] = (uint8_t)((x)>>8); \
235 ((uint8_t*)(p))[1] = (uint8_t)((x)>>16); \
0c5f2abc 236 ((uint8_t*)(p))[0] = (uint8_t)((x)>>24); } while (0)
ea2d6d99
AJ
237
238/**
5bf0dd6a 239 * Write a 32 bits unsigned integer to memory stored as little endian.
ea2d6d99 240 * @param p a pointer to the output memory
5bf0dd6a 241 * @param x the input unsigned integer
ea2d6d99
AJ
242 */
243#define WL32(p, x) do { ((uint8_t*)(p))[0] = (uint8_t) (x); \
244 ((uint8_t*)(p))[1] = (uint8_t)((x)>>8); \
245 ((uint8_t*)(p))[2] = (uint8_t)((x)>>16); \
0c5f2abc 246 ((uint8_t*)(p))[3] = (uint8_t)((x)>>24); } while (0)
ea2d6d99 247
a2632bca
AJ
248/**
249 * Write a 32 bits float to memory stored as big endian.
250 * @param p a pointer to the output memory
251 * @param x the input float
252 */
253#define WBFL(p, x) WB32(p, (union { uint32_t u; float f; }) { .f = x }.u)
254
255/**
256 * Write a 32 bits float to memory stored as little endian.
257 * @param p a pointer to the output memory
258 * @param x the input float
259 */
260#define WLFL(p, x) WL32(p, (union { uint32_t u; float f; }) { .f = x }.u)
261
6bf4273e
UH
262/* Portability fixes for FreeBSD. */
263#ifdef __FreeBSD__
264#define LIBUSB_CLASS_APPLICATION 0xfe
15eea61a 265#define libusb_has_capability(x) 0
6bf4273e
UH
266#define libusb_handle_events_timeout_completed(ctx, tv, c) \
267 libusb_handle_events_timeout(ctx, tv)
268#endif
269
1685c276
BV
270/* Static definitions of structs ending with an all-zero entry are a
271 * problem when compiling with -Wmissing-field-initializers: GCC
272 * suppresses the warning only with { 0 }, clang wants { } */
273#ifdef __clang__
274#define ALL_ZERO { }
275#else
276#define ALL_ZERO { 0 }
277#endif
278
dd5c48a6
LPC
279#ifdef __APPLE__
280#define SR_DRIVER_LIST_SECTION "__DATA,__sr_driver_list"
281#else
282#define SR_DRIVER_LIST_SECTION "sr_driver_list"
283#endif
284
285/**
286 * Register a list of hardware drivers.
287 *
288 * This macro can be used to register multiple hardware drivers to the library.
289 * This is useful when a driver supports multiple similar but slightly
290 * different devices that require different sr_dev_driver struct definitions.
291 *
292 * For registering only a single driver see SR_REGISTER_DEV_DRIVER().
293 *
294 * Example:
295 * @code{c}
296 * #define MY_DRIVER(_name) \
297 * &(struct sr_dev_driver){ \
298 * .name = _name, \
299 * ...
300 * };
301 *
302 * SR_REGISTER_DEV_DRIVER_LIST(my_driver_infos,
303 * MY_DRIVER("driver 1"),
304 * MY_DRIVER("driver 2"),
305 * ...
306 * );
307 * @endcode
308 *
309 * @param name Name to use for the driver list identifier.
310 * @param ... Comma separated list of pointers to sr_dev_driver structs.
311 */
312#define SR_REGISTER_DEV_DRIVER_LIST(name, ...) \
313 static const struct sr_dev_driver *name[] \
314 __attribute__((section (SR_DRIVER_LIST_SECTION), used, \
315 aligned(sizeof(struct sr_dev_driver *)))) \
316 = { \
317 __VA_ARGS__ \
318 };
319
320/**
321 * Register a hardware driver.
322 *
323 * This macro is used to register a hardware driver with the library. It has
324 * to be used in order to make the driver accessible to applications using the
325 * library.
326 *
327 * The macro invocation should be placed directly under the struct
328 * sr_dev_driver definition.
329 *
330 * Example:
331 * @code{c}
332 * static struct sr_dev_driver driver_info = {
333 * .name = "driver",
334 * ....
335 * };
336 * SR_REGISTER_DEV_DRIVER(driver_info);
337 * @endcode
338 *
339 * @param name Identifier name of sr_dev_driver struct to register.
340 */
341#define SR_REGISTER_DEV_DRIVER(name) \
342 SR_REGISTER_DEV_DRIVER_LIST(name##_list, &name);
343
ced48274 344SR_API void sr_drivers_init(struct sr_context *context);
5d8b3913 345
b8072700 346struct sr_context {
032da34b 347 struct sr_dev_driver **driver_list;
785b9ff2
PS
348#ifdef HAVE_LIBUSB_1_0
349 libusb_context *libusb_ctx;
350#endif
bee24666
DE
351 sr_resource_open_callback resource_open_cb;
352 sr_resource_close_callback resource_close_cb;
353 sr_resource_read_callback resource_read_cb;
354 void *resource_cb_data;
b8072700
PS
355};
356
20e88821
BV
357/** Input module metadata keys. */
358enum sr_input_meta_keys {
359 /** The input filename, if there is one. */
360 SR_INPUT_META_FILENAME = 0x01,
361 /** The input file's size in bytes. */
362 SR_INPUT_META_FILESIZE = 0x02,
363 /** The first 128 bytes of the file, provided as a GString. */
364 SR_INPUT_META_HEADER = 0x04,
20e88821
BV
365
366 /** The module cannot identify a file without this metadata. */
367 SR_INPUT_META_REQUIRED = 0x80,
368};
369
d514d35d
BV
370/** Input (file) module struct. */
371struct sr_input {
372 /**
373 * A pointer to this input module's 'struct sr_input_module'.
d514d35d 374 */
17bfaca6
BV
375 const struct sr_input_module *module;
376 GString *buf;
d514d35d 377 struct sr_dev_inst *sdi;
d0181813 378 gboolean sdi_ready;
17bfaca6 379 void *priv;
d514d35d
BV
380};
381
382/** Input (file) module driver. */
383struct sr_input_module {
17bfaca6 384 /**
d65fcbcd 385 * A unique ID for this input module, suitable for use in command-line
17bfaca6
BV
386 * clients, [a-z0-9-]. Must not be NULL.
387 */
388 const char *id;
d514d35d
BV
389
390 /**
d65fcbcd 391 * A unique name for this input module, suitable for use in GUI
17bfaca6 392 * clients, can contain UTF-8. Must not be NULL.
d514d35d 393 */
17bfaca6 394 const char *name;
d514d35d
BV
395
396 /**
d65fcbcd 397 * A short description of the input module. Must not be NULL.
d514d35d 398 *
d65fcbcd 399 * This can be displayed by frontends, e.g. when selecting the input
17bfaca6
BV
400 * module for saving a file.
401 */
402 const char *desc;
403
c7bc82ff
JH
404 /**
405 * A NULL terminated array of strings containing a list of file name
406 * extensions typical for the input file format, or NULL if there is
407 * no typical extension for this file format.
408 */
409 const char *const *exts;
410
17bfaca6
BV
411 /**
412 * Zero-terminated list of metadata items the module needs to be able
413 * to identify an input stream. Can be all-zero, if the module cannot
414 * identify streams at all, i.e. has to be forced into use.
415 *
416 * Each item is one of:
417 * SR_INPUT_META_FILENAME
418 * SR_INPUT_META_FILESIZE
419 * SR_INPUT_META_HEADER
17bfaca6
BV
420 *
421 * If the high bit (SR_INPUT META_REQUIRED) is set, the module cannot
422 * identify a stream without the given metadata.
423 */
424 const uint8_t metadata[8];
425
426 /**
427 * Returns a NULL-terminated list of options this module can take.
428 * Can be NULL, if the module has no options.
429 */
2c240774 430 const struct sr_option *(*options) (void);
17bfaca6
BV
431
432 /**
433 * Check if this input module can load and parse the specified stream.
434 *
435 * @param[in] metadata Metadata the module can use to identify the stream.
54ee427d
GS
436 * @param[out] confidence "Strength" of the detection.
437 * Specialized handlers can take precedence over generic/basic support.
d514d35d 438 *
4f979115 439 * @retval SR_OK This module knows the format.
753793ef 440 * @retval SR_ERR_NA There wasn't enough data for this module to
4f979115 441 * positively identify the format.
d9251a2c
UH
442 * @retval SR_ERR_DATA This module knows the format, but cannot handle
443 * it. This means the stream is either corrupt, or indicates a
444 * feature that the module does not support.
4f979115 445 * @retval SR_ERR This module does not know the format.
54ee427d
GS
446 *
447 * Lower numeric values of 'confidence' mean that the input module
448 * stronger believes in its capability to handle this specific format.
449 * This way, multiple input modules can claim support for a format,
450 * and the application can pick the best match, or try fallbacks
451 * in case of errors. This approach also copes with formats that
452 * are unreliable to detect in the absence of magic signatures.
d514d35d 453 */
54ee427d 454 int (*format_match) (GHashTable *metadata, unsigned int *confidence);
d514d35d
BV
455
456 /**
457 * Initialize the input module.
458 *
d514d35d
BV
459 * @retval SR_OK Success
460 * @retval other Negative error code.
461 */
17bfaca6 462 int (*init) (struct sr_input *in, GHashTable *options);
d514d35d
BV
463
464 /**
753793ef 465 * Send data to the specified input instance.
d514d35d 466 *
753793ef
BV
467 * When an input module instance is created with sr_input_new(), this
468 * function is used to feed data to the instance.
d514d35d 469 *
753793ef
BV
470 * As enough data gets fed into this function to completely populate
471 * the device instance associated with this input instance, this is
472 * guaranteed to return the moment it's ready. This gives the caller
473 * the chance to examine the device instance, attach session callbacks
474 * and so on.
17bfaca6
BV
475 *
476 * @retval SR_OK Success
477 * @retval other Negative error code.
478 */
d0181813 479 int (*receive) (struct sr_input *in, GString *buf);
17bfaca6 480
753793ef
BV
481 /**
482 * Signal the input module no more data will come.
483 *
484 * This will cause the module to process any data it may have buffered.
485 * The SR_DF_END packet will also typically be sent at this time.
486 */
7066fd46
BV
487 int (*end) (struct sr_input *in);
488
d9251a2c
UH
489 /**
490 * Reset the input module's input handling structures.
491 *
492 * Causes the input module to reset its internal state so that we can
493 * re-send the input data from the beginning without having to
494 * re-create the entire input module.
495 *
496 * @retval SR_OK Success.
497 * @retval other Negative error code.
498 */
b6b4f03e
SA
499 int (*reset) (struct sr_input *in);
500
17bfaca6
BV
501 /**
502 * This function is called after the caller is finished using
503 * the input module, and can be used to free any internal
504 * resources the module may keep.
d514d35d 505 *
753793ef
BV
506 * This function is optional.
507 *
d514d35d
BV
508 * @retval SR_OK Success
509 * @retval other Negative error code.
510 */
d5cc282f 511 void (*cleanup) (struct sr_input *in);
d514d35d
BV
512};
513
a755b0e1
BV
514/** Output module instance. */
515struct sr_output {
d9251a2c 516 /** A pointer to this output's module. */
a755b0e1
BV
517 const struct sr_output_module *module;
518
519 /**
520 * The device for which this output module is creating output. This
521 * can be used by the module to find out channel names and numbers.
522 */
523 const struct sr_dev_inst *sdi;
524
81b3ce37
SA
525 /**
526 * The name of the file that the data should be written to.
527 */
528 const char *filename;
529
a755b0e1
BV
530 /**
531 * A generic pointer which can be used by the module to keep internal
532 * state between calls into its callback functions.
533 *
534 * For example, the module might store a pointer to a chunk of output
535 * there, and only flush it when it reaches a certain size.
536 */
d686c5ec 537 void *priv;
a755b0e1
BV
538};
539
540/** Output module driver. */
541struct sr_output_module {
542 /**
543 * A unique ID for this output module, suitable for use in command-line
544 * clients, [a-z0-9-]. Must not be NULL.
545 */
2c240774 546 const char *id;
a755b0e1
BV
547
548 /**
549 * A unique name for this output module, suitable for use in GUI
550 * clients, can contain UTF-8. Must not be NULL.
551 */
552 const char *name;
553
554 /**
555 * A short description of the output module. Must not be NULL.
556 *
557 * This can be displayed by frontends, e.g. when selecting the output
558 * module for saving a file.
559 */
2c240774 560 const char *desc;
a755b0e1 561
8a174d23
JH
562 /**
563 * A NULL terminated array of strings containing a list of file name
564 * extensions typical for the input file format, or NULL if there is
565 * no typical extension for this file format.
566 */
567 const char *const *exts;
568
3cd4b381
SA
569 /**
570 * Bitfield containing flags that describe certain properties
571 * this output module may or may not have.
572 * @see sr_output_flags
573 */
574 const uint64_t flags;
575
a755b0e1
BV
576 /**
577 * Returns a NULL-terminated list of options this module can take.
578 * Can be NULL, if the module has no options.
a755b0e1 579 */
af7d656d 580 const struct sr_option *(*options) (void);
a755b0e1
BV
581
582 /**
583 * This function is called once, at the beginning of an output stream.
584 *
585 * The device struct will be available in the output struct passed in,
586 * as well as the param field -- which may be NULL or an empty string,
587 * if no parameter was passed.
588 *
589 * The module can use this to initialize itself, create a struct for
590 * keeping state and storing it in the <code>internal</code> field.
591 *
592 * @param o Pointer to the respective 'struct sr_output'.
593 *
594 * @retval SR_OK Success
595 * @retval other Negative error code.
596 */
597 int (*init) (struct sr_output *o, GHashTable *options);
598
599 /**
f3f19d11 600 * This function is passed a copy of every packet in the data feed.
a755b0e1
BV
601 * Any output generated by the output module in response to the
602 * packet should be returned in a newly allocated GString
603 * <code>out</code>, which will be freed by the caller.
604 *
605 * Packets not of interest to the output module can just be ignored,
606 * and the <code>out</code> parameter set to NULL.
607 *
608 * @param o Pointer to the respective 'struct sr_output'.
609 * @param sdi The device instance that generated the packet.
610 * @param packet The complete packet.
611 * @param out A pointer where a GString * should be stored if
612 * the module generates output, or NULL if not.
613 *
614 * @retval SR_OK Success
615 * @retval other Negative error code.
616 */
617 int (*receive) (const struct sr_output *o,
618 const struct sr_datafeed_packet *packet, GString **out);
619
620 /**
621 * This function is called after the caller is finished using
622 * the output module, and can be used to free any internal
623 * resources the module may keep.
624 *
625 * @retval SR_OK Success
626 * @retval other Negative error code.
627 */
628 int (*cleanup) (struct sr_output *o);
629};
630
790320f6
UH
631/** Transform module instance. */
632struct sr_transform {
d9251a2c 633 /** A pointer to this transform's module. */
790320f6
UH
634 const struct sr_transform_module *module;
635
636 /**
637 * The device for which this transform module is used. This
638 * can be used by the module to find out channel names and numbers.
639 */
640 const struct sr_dev_inst *sdi;
641
642 /**
643 * A generic pointer which can be used by the module to keep internal
644 * state between calls into its callback functions.
645 */
646 void *priv;
647};
648
649struct sr_transform_module {
650 /**
651 * A unique ID for this transform module, suitable for use in
652 * command-line clients, [a-z0-9-]. Must not be NULL.
653 */
2c240774 654 const char *id;
790320f6
UH
655
656 /**
657 * A unique name for this transform module, suitable for use in GUI
658 * clients, can contain UTF-8. Must not be NULL.
659 */
660 const char *name;
661
662 /**
663 * A short description of the transform module. Must not be NULL.
664 *
665 * This can be displayed by frontends, e.g. when selecting
666 * which transform module(s) to add.
667 */
2c240774 668 const char *desc;
790320f6
UH
669
670 /**
671 * Returns a NULL-terminated list of options this transform module
672 * can take. Can be NULL, if the transform module has no options.
673 */
674 const struct sr_option *(*options) (void);
675
676 /**
677 * This function is called once, at the beginning of a stream.
678 *
679 * @param t Pointer to the respective 'struct sr_transform'.
680 * @param options Hash table of options for this transform module.
681 * Can be NULL if no options are to be used.
682 *
683 * @retval SR_OK Success
684 * @retval other Negative error code.
685 */
686 int (*init) (struct sr_transform *t, GHashTable *options);
687
688 /**
689 * This function is passed a pointer to every packet in the data feed.
690 *
691 * It can either return (in packet_out) a pointer to another packet
692 * (possibly the exact same packet it got as input), or NULL.
693 *
694 * @param t Pointer to the respective 'struct sr_transform'.
695 * @param packet_in Pointer to a datafeed packet.
696 * @param packet_out Pointer to the resulting datafeed packet after
697 * this function was run. If NULL, the transform
698 * module intentionally didn't output a new packet.
699 *
700 * @retval SR_OK Success
701 * @retval other Negative error code.
702 */
703 int (*receive) (const struct sr_transform *t,
704 struct sr_datafeed_packet *packet_in,
705 struct sr_datafeed_packet **packet_out);
706
707 /**
708 * This function is called after the caller is finished using
709 * the transform module, and can be used to free any internal
710 * resources the module may keep.
711 *
712 * @retval SR_OK Success
713 * @retval other Negative error code.
714 */
715 int (*cleanup) (struct sr_transform *t);
716};
717
69890f73 718#ifdef HAVE_LIBUSB_1_0
04cb9157 719/** USB device instance */
d68e2d1a 720struct sr_usb_dev_inst {
98582bf5
BV
721 /** USB bus */
722 uint8_t bus;
723 /** Device address on USB bus */
724 uint8_t address;
725 /** libusb device handle */
726 struct libusb_device_handle *devhdl;
69890f73
UH
727};
728#endif
729
1ac8c218 730struct sr_serial_dev_inst;
1df81f4b 731#ifdef HAVE_SERIAL_COMM
a7b8692e 732struct ser_lib_functions;
edec0436 733struct ser_hid_chip_functions;
b79c3422 734struct sr_bt_desc;
d4787248
GS
735typedef void (*serial_rx_chunk_callback)(struct sr_serial_dev_inst *serial,
736 void *cb_data, const void *buf, size_t count);
d68e2d1a 737struct sr_serial_dev_inst {
98582bf5
BV
738 /** Port name, e.g. '/dev/tty42'. */
739 char *port;
740 /** Comm params for serial_set_paramstr(). */
741 char *serialcomm;
a7b8692e 742 struct ser_lib_functions *lib_funcs;
639c6f61
GS
743 struct {
744 int bit_rate;
745 int data_bits;
746 int parity_bits;
747 int stop_bits;
748 } comm_params;
ad5aa993 749 GString *rcv_buffer;
d4787248
GS
750 serial_rx_chunk_callback rx_chunk_cb_func;
751 void *rx_chunk_cb_data;
a7b8692e 752#ifdef HAVE_LIBSERIALPORT
98582bf5 753 /** libserialport port handle */
271392d9 754 struct sp_port *sp_data;
a7b8692e 755#endif
4417074c 756#ifdef HAVE_LIBHIDAPI
edec0436
GS
757 enum ser_hid_chip_t {
758 SER_HID_CHIP_UNKNOWN, /**!< place holder */
a10284cd 759 SER_HID_CHIP_BTC_BU86X, /**!< Brymen BU86x */
616bc3a1 760 SER_HID_CHIP_SIL_CP2110, /**!< SiLabs CP2110 */
828eeea2 761 SER_HID_CHIP_WCH_CH9325, /**!< WCH CH9325 */
edec0436
GS
762 SER_HID_CHIP_LAST, /**!< sentinel */
763 } hid_chip;
764 struct ser_hid_chip_functions *hid_chip_funcs;
765 char *usb_path;
766 char *usb_serno;
767 const char *hid_path;
4417074c 768 hid_device *hid_dev;
edec0436 769 GSList *hid_source_args;
4417074c 770#endif
b79c3422
GS
771#ifdef HAVE_BLUETOOTH
772 enum ser_bt_conn_t {
773 SER_BT_CONN_UNKNOWN, /**!< place holder */
774 SER_BT_CONN_RFCOMM, /**!< BT classic, RFCOMM channel */
775 SER_BT_CONN_BLE122, /**!< BLE, BLE122 module, indications */
776 SER_BT_CONN_NRF51, /**!< BLE, Nordic nRF51, notifications */
777 SER_BT_CONN_CC254x, /**!< BLE, TI CC254x, notifications */
778 SER_BT_CONN_MAX, /**!< sentinel */
779 } bt_conn_type;
780 char *bt_addr_local;
781 char *bt_addr_remote;
782 size_t bt_rfcomm_channel;
783 uint16_t bt_notify_handle_read;
784 uint16_t bt_notify_handle_write;
785 uint16_t bt_notify_handle_cccd;
786 uint16_t bt_notify_value_cccd;
787 struct sr_bt_desc *bt_desc;
788 GSList *bt_source_args;
789#endif
69890f73 790};
c4f2dfd0 791#endif
69890f73 792
ae67644f
ML
793struct sr_usbtmc_dev_inst {
794 char *device;
795 int fd;
796};
797
026c822d
UH
798/* Private driver context. */
799struct drv_context {
98582bf5
BV
800 /** sigrok context */
801 struct sr_context *sr_ctx;
026c822d
UH
802 GSList *instances;
803};
804
48a486cd
BV
805/*--- log.c -----------------------------------------------------------------*/
806
00f0016c 807#if defined(_WIN32) && (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 4))
7419638d
DE
808/*
809 * On MinGW, we need to specify the gnu_printf format flavor or GCC
810 * will assume non-standard Microsoft printf syntax.
811 */
812SR_PRIV int sr_log(int loglevel, const char *format, ...)
813 __attribute__((__format__ (__gnu_printf__, 2, 3)));
814#else
be92d5b4 815SR_PRIV int sr_log(int loglevel, const char *format, ...) G_GNUC_PRINTF(2, 3);
7419638d 816#endif
48a486cd 817
3544f848 818/* Message logging helpers with subsystem-specific prefix string. */
be92d5b4
DE
819#define sr_spew(...) sr_log(SR_LOG_SPEW, LOG_PREFIX ": " __VA_ARGS__)
820#define sr_dbg(...) sr_log(SR_LOG_DBG, LOG_PREFIX ": " __VA_ARGS__)
821#define sr_info(...) sr_log(SR_LOG_INFO, LOG_PREFIX ": " __VA_ARGS__)
822#define sr_warn(...) sr_log(SR_LOG_WARN, LOG_PREFIX ": " __VA_ARGS__)
823#define sr_err(...) sr_log(SR_LOG_ERR, LOG_PREFIX ": " __VA_ARGS__)
3544f848 824
48a486cd
BV
825/*--- device.c --------------------------------------------------------------*/
826
cffdc3e6
ML
827/** Scan options supported by a driver. */
828#define SR_CONF_SCAN_OPTIONS 0x7FFF0000
829
830/** Device options for a particular device. */
831#define SR_CONF_DEVICE_OPTIONS 0x7FFF0001
832
e318f01b
ML
833/** Mask for separating config keys from capabilities. */
834#define SR_CONF_MASK 0x1fffffff
835
f3ca73ed 836/** Values for the changes argument of sr_dev_driver.config_channel_set. */
2a854d71 837enum {
fca75cbb 838 /** The enabled state of the channel has been changed. */
3f239f08 839 SR_CHANNEL_SET_ENABLED = 1 << 0,
2a854d71
DE
840};
841
5e23fcab
ML
842SR_PRIV struct sr_channel *sr_channel_new(struct sr_dev_inst *sdi,
843 int index, int type, gboolean enabled, const char *name);
fe71c7e4
GS
844SR_PRIV void sr_channel_free(struct sr_channel *ch);
845SR_PRIV void sr_channel_free_cb(void *p);
9c24d16a
BV
846SR_PRIV struct sr_channel *sr_next_enabled_channel(const struct sr_dev_inst *sdi,
847 struct sr_channel *cur_channel);
712f981d
GS
848SR_PRIV gboolean sr_channels_differ(struct sr_channel *ch1, struct sr_channel *ch2);
849SR_PRIV gboolean sr_channel_lists_differ(GSList *l1, GSList *l2);
48a486cd 850
96727ef0
UH
851/** Device instance data */
852struct sr_dev_inst {
853 /** Device driver. */
854 struct sr_dev_driver *driver;
855 /** Device instance status. SR_ST_NOT_FOUND, etc. */
856 int status;
857 /** Device instance type. SR_INST_USB, etc. */
858 int inst_type;
859 /** Device vendor. */
860 char *vendor;
861 /** Device model. */
862 char *model;
863 /** Device version. */
864 char *version;
865 /** Serial number. */
866 char *serial_num;
867 /** Connection string to uniquely identify devices. */
868 char *connection_id;
869 /** List of channels. */
870 GSList *channels;
871 /** List of sr_channel_group structs */
872 GSList *channel_groups;
873 /** Device instance connection data (used?) */
874 void *conn;
875 /** Device instance private data (used?) */
876 void *priv;
877 /** Session to which this device is currently assigned. */
878 struct sr_session *session;
879};
880
48a486cd 881/* Generic device instances */
48a486cd 882SR_PRIV void sr_dev_inst_free(struct sr_dev_inst *sdi);
48a486cd 883
545f9786 884#ifdef HAVE_LIBUSB_1_0
69890f73 885/* USB-specific instances */
d68e2d1a 886SR_PRIV struct sr_usb_dev_inst *sr_usb_dev_inst_new(uint8_t bus,
69890f73 887 uint8_t address, struct libusb_device_handle *hdl);
d68e2d1a 888SR_PRIV void sr_usb_dev_inst_free(struct sr_usb_dev_inst *usb);
69890f73
UH
889#endif
890
1df81f4b 891#ifdef HAVE_SERIAL_COMM
1ac8c218
GS
892#ifndef HAVE_LIBSERIALPORT
893/*
894 * Some identifiers which initially got provided by libserialport are
895 * used internally within the libsigrok serial layer's implementation,
896 * while libserialport no longer is the exclusive provider of serial
897 * communication support. Declare the identifiers here so they remain
898 * available across all build configurations.
899 */
900enum libsp_parity {
901 SP_PARITY_NONE = 0,
902 SP_PARITY_ODD = 1,
903 SP_PARITY_EVEN = 2,
904 SP_PARITY_MARK = 3,
905 SP_PARITY_SPACE = 4,
906};
907
908enum libsp_flowcontrol {
909 SP_FLOWCONTROL_NONE = 0,
910 SP_FLOWCONTROL_XONXOFF = 1,
911 SP_FLOWCONTROL_RTSCTS = 2,
912 SP_FLOWCONTROL_DTRDSR = 3,
913};
914#endif
915
69890f73 916/* Serial-specific instances */
299bdb24
BV
917SR_PRIV struct sr_serial_dev_inst *sr_serial_dev_inst_new(const char *port,
918 const char *serialcomm);
d68e2d1a 919SR_PRIV void sr_serial_dev_inst_free(struct sr_serial_dev_inst *serial);
c4f2dfd0 920#endif
69890f73 921
ae67644f
ML
922/* USBTMC-specific instances */
923SR_PRIV struct sr_usbtmc_dev_inst *sr_usbtmc_dev_inst_new(const char *device);
924SR_PRIV void sr_usbtmc_dev_inst_free(struct sr_usbtmc_dev_inst *usbtmc);
b08024a8 925
c09f0b57 926/*--- hwdriver.c ------------------------------------------------------------*/
996b0c72 927
13fef1ed 928SR_PRIV const GVariantType *sr_variant_type_get(int datatype);
584560f1 929SR_PRIV int sr_variant_type_check(uint32_t key, GVariant *data);
032da34b 930SR_PRIV void sr_hw_cleanup_all(const struct sr_context *ctx);
584560f1 931SR_PRIV struct sr_config *sr_config_new(uint32_t key, GVariant *data);
722db131 932SR_PRIV void sr_config_free(struct sr_config *src);
f670835f 933SR_PRIV int sr_dev_acquisition_start(struct sr_dev_inst *sdi);
d2f7c417 934SR_PRIV int sr_dev_acquisition_stop(struct sr_dev_inst *sdi);
996b0c72 935
a1645fcd
BV
936/*--- session.c -------------------------------------------------------------*/
937
e2b23821 938struct sr_session {
4ed5d21d
ML
939 /** Context this session exists in. */
940 struct sr_context *ctx;
c0e3ba4b 941 /** List of struct sr_dev_inst pointers. */
e2b23821 942 GSList *devs;
1de3cced
ML
943 /** List of struct sr_dev_inst pointers owned by this session. */
944 GSList *owned_devs;
e2b23821
UH
945 /** List of struct datafeed_callback pointers. */
946 GSList *datafeed_callbacks;
c0a1e532 947 GSList *transforms;
7b5e6d29 948 struct sr_trigger *trigger;
62d7945f 949
5de0fc55
DE
950 /** Callback to invoke on session stop. */
951 sr_session_stopped_callback stopped_callback;
952 /** User data to be passed to the session stop callback. */
953 void *stopped_cb_data;
954
2e5e3df4 955 /** Mutex protecting the main context pointer. */
c2bf5506
DE
956 GMutex main_mutex;
957 /** Context of the session main loop. */
958 GMainContext *main_context;
e2b23821 959
c2bf5506
DE
960 /** Registered event sources for this session. */
961 GHashTable *event_sources;
962 /** Session main loop. */
963 GMainLoop *main_loop;
5de0fc55
DE
964 /** ID of idle source for dispatching the session stop notification. */
965 unsigned int stop_check_id;
2e5e3df4
DE
966 /** Whether the session has been started. */
967 gboolean running;
e2b23821
UH
968};
969
62d7945f 970SR_PRIV int sr_session_source_add_internal(struct sr_session *session,
c2bf5506 971 void *key, GSource *source);
92248e78 972SR_PRIV int sr_session_source_remove_internal(struct sr_session *session,
c2bf5506
DE
973 void *key);
974SR_PRIV int sr_session_source_destroyed(struct sr_session *session,
975 void *key, GSource *source);
cbc1413f
DE
976SR_PRIV int sr_session_fd_source_add(struct sr_session *session,
977 void *key, gintptr fd, int events, int timeout,
978 sr_receive_data_callback cb, void *cb_data);
ee9953ef
DE
979
980SR_PRIV int sr_session_source_add(struct sr_session *session, int fd,
981 int events, int timeout, sr_receive_data_callback cb, void *cb_data);
982SR_PRIV int sr_session_source_add_pollfd(struct sr_session *session,
983 GPollFD *pollfd, int timeout, sr_receive_data_callback cb,
984 void *cb_data);
985SR_PRIV int sr_session_source_add_channel(struct sr_session *session,
986 GIOChannel *channel, int events, int timeout,
987 sr_receive_data_callback cb, void *cb_data);
988SR_PRIV int sr_session_source_remove(struct sr_session *session, int fd);
989SR_PRIV int sr_session_source_remove_pollfd(struct sr_session *session,
990 GPollFD *pollfd);
991SR_PRIV int sr_session_source_remove_channel(struct sr_session *session,
992 GIOChannel *channel);
993
7d1a4a52
FS
994SR_PRIV int sr_session_send_meta(const struct sr_dev_inst *sdi,
995 uint32_t key, GVariant *var);
de4d3f99 996SR_PRIV int sr_session_send(const struct sr_dev_inst *sdi,
ae5859ff 997 const struct sr_datafeed_packet *packet);
f438e0c9 998SR_PRIV int sr_sessionfile_check(const char *filename);
7c69b528
SA
999SR_PRIV struct sr_dev_inst *sr_session_prepare_sdi(const char *filename,
1000 struct sr_session **session);
a1645fcd 1001
98654c99
DE
1002/*--- session_file.c --------------------------------------------------------*/
1003
a6dc3dac
DE
1004#if !HAVE_ZIP_DISCARD
1005/* Replace zip_discard() if not available. */
1006#define zip_discard(zip) sr_zip_discard(zip)
1007SR_PRIV void sr_zip_discard(struct zip *archive);
1008#endif
1009
98654c99
DE
1010SR_PRIV GKeyFile *sr_sessionfile_read_metadata(struct zip *archive,
1011 const struct zip_stat *entry);
1012
41caa319
AJ
1013/*--- analog.c --------------------------------------------------------------*/
1014
edb691fc 1015SR_PRIV int sr_analog_init(struct sr_datafeed_analog *analog,
41caa319
AJ
1016 struct sr_analog_encoding *encoding,
1017 struct sr_analog_meaning *meaning,
1018 struct sr_analog_spec *spec,
1019 int digits);
1020
063e7aef
UH
1021/*--- std.c -----------------------------------------------------------------*/
1022
144f6660
UH
1023typedef int (*dev_close_callback)(struct sr_dev_inst *sdi);
1024typedef void (*std_dev_clear_callback)(void *priv);
cd2f0fe2 1025
c45c32ce 1026SR_PRIV int std_init(struct sr_dev_driver *di, struct sr_context *sr_ctx);
700d6b64 1027SR_PRIV int std_cleanup(const struct sr_dev_driver *di);
4d67b9d9
UH
1028SR_PRIV int std_dummy_dev_open(struct sr_dev_inst *sdi);
1029SR_PRIV int std_dummy_dev_close(struct sr_dev_inst *sdi);
1030SR_PRIV int std_dummy_dev_acquisition_start(const struct sr_dev_inst *sdi);
1031SR_PRIV int std_dummy_dev_acquisition_stop(struct sr_dev_inst *sdi);
1df81f4b 1032#ifdef HAVE_SERIAL_COMM
23dc6661 1033SR_PRIV int std_serial_dev_open(struct sr_dev_inst *sdi);
1b38775b 1034SR_PRIV int std_serial_dev_acquisition_stop(struct sr_dev_inst *sdi);
c4f2dfd0 1035#endif
bee2b016
LPC
1036SR_PRIV int std_session_send_df_header(const struct sr_dev_inst *sdi);
1037SR_PRIV int std_session_send_df_end(const struct sr_dev_inst *sdi);
b7602846
SA
1038SR_PRIV int std_session_send_frame_begin(const struct sr_dev_inst *sdi);
1039SR_PRIV int std_session_send_frame_end(const struct sr_dev_inst *sdi);
6e43c3d5 1040SR_PRIV int std_dev_clear_with_callback(const struct sr_dev_driver *driver,
144f6660 1041 std_dev_clear_callback clear_private);
f778bf02 1042SR_PRIV int std_dev_clear(const struct sr_dev_driver *driver);
c01bf34c 1043SR_PRIV GSList *std_dev_list(const struct sr_dev_driver *di);
043e899a 1044SR_PRIV int std_serial_dev_close(struct sr_dev_inst *sdi);
15a5bfe4 1045SR_PRIV GSList *std_scan_complete(struct sr_dev_driver *di, GSList *devices);
4afdfd46 1046
e66d1892
UH
1047SR_PRIV int std_opts_config_list(uint32_t key, GVariant **data,
1048 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg,
1049 const uint32_t scanopts[], size_t scansize, const uint32_t drvopts[],
1050 size_t drvsize, const uint32_t devopts[], size_t devsize);
1051
23772462
UH
1052extern SR_PRIV const uint32_t NO_OPTS[1];
1053
e66d1892
UH
1054#define STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts) \
1055 std_opts_config_list(key, data, sdi, cg, ARRAY_AND_SIZE(scanopts), \
1056 ARRAY_AND_SIZE(drvopts), ARRAY_AND_SIZE(devopts))
1057
58ffcf97 1058SR_PRIV GVariant *std_gvar_tuple_array(const uint64_t a[][2], unsigned int n);
db944f16 1059SR_PRIV GVariant *std_gvar_tuple_rational(const struct sr_rational *r, unsigned int n);
463160cb
UH
1060SR_PRIV GVariant *std_gvar_samplerates(const uint64_t samplerates[], unsigned int n);
1061SR_PRIV GVariant *std_gvar_samplerates_steps(const uint64_t samplerates[], unsigned int n);
54d471f4
UH
1062SR_PRIV GVariant *std_gvar_min_max_step(double min, double max, double step);
1063SR_PRIV GVariant *std_gvar_min_max_step_array(const double a[3]);
7bc3cfe6 1064SR_PRIV GVariant *std_gvar_min_max_step_thresholds(const double dmin, const double dmax, const double dstep);
db944f16 1065
a162eeb2 1066SR_PRIV GVariant *std_gvar_tuple_u64(uint64_t low, uint64_t high);
43995cda 1067SR_PRIV GVariant *std_gvar_tuple_double(double low, double high);
a162eeb2 1068
769561cb
UH
1069SR_PRIV GVariant *std_gvar_array_i32(const int32_t a[], unsigned int n);
1070SR_PRIV GVariant *std_gvar_array_u32(const uint32_t a[], unsigned int n);
1071SR_PRIV GVariant *std_gvar_array_u64(const uint64_t a[], unsigned int n);
70635036 1072SR_PRIV GVariant *std_gvar_array_str(const char *a[], unsigned int n);
db944f16 1073
94e64a0b 1074SR_PRIV GVariant *std_gvar_thresholds(const double a[][2], unsigned int n);
9fb9afb5 1075
697fb6dd
UH
1076SR_PRIV int std_str_idx(GVariant *data, const char *a[], unsigned int n);
1077SR_PRIV int std_u64_idx(GVariant *data, const uint64_t a[], unsigned int n);
1078SR_PRIV int std_u8_idx(GVariant *data, const uint8_t a[], unsigned int n);
1079
1080SR_PRIV int std_str_idx_s(const char *s, const char *a[], unsigned int n);
1081SR_PRIV int std_u8_idx_s(uint8_t b, const uint8_t a[], unsigned int n);
1082
1083SR_PRIV int std_u64_tuple_idx(GVariant *data, const uint64_t a[][2], unsigned int n);
1084SR_PRIV int std_double_tuple_idx(GVariant *data, const double a[][2], unsigned int n);
1085SR_PRIV int std_double_tuple_idx_d0(const double d, const double a[][2], unsigned int n);
1086
fcd6a8bd
UH
1087SR_PRIV int std_cg_idx(const struct sr_channel_group *cg, struct sr_channel_group *a[], unsigned int n);
1088
bee24666
DE
1089/*--- resource.c ------------------------------------------------------------*/
1090
7d89fd60
DE
1091SR_PRIV int64_t sr_file_get_size(FILE *file);
1092
bee24666
DE
1093SR_PRIV int sr_resource_open(struct sr_context *ctx,
1094 struct sr_resource *res, int type, const char *name)
1095 G_GNUC_WARN_UNUSED_RESULT;
1096SR_PRIV int sr_resource_close(struct sr_context *ctx,
1097 struct sr_resource *res);
32ba0d80 1098SR_PRIV gssize sr_resource_read(struct sr_context *ctx,
bee24666
DE
1099 const struct sr_resource *res, void *buf, size_t count)
1100 G_GNUC_WARN_UNUSED_RESULT;
1101SR_PRIV void *sr_resource_load(struct sr_context *ctx, int type,
1102 const char *name, size_t *size, size_t max_size)
1103 G_GNUC_MALLOC G_GNUC_WARN_UNUSED_RESULT;
1104
8d558c7a
UH
1105/*--- strutil.c -------------------------------------------------------------*/
1106
1107SR_PRIV int sr_atol(const char *str, long *ret);
1108SR_PRIV int sr_atoi(const char *str, int *ret);
1109SR_PRIV int sr_atod(const char *str, double *ret);
1110SR_PRIV int sr_atof(const char *str, float *ret);
4f0463a0 1111SR_PRIV int sr_atod_ascii(const char *str, double *ret);
9806c2d5 1112SR_PRIV int sr_atof_ascii(const char *str, float *ret);
8d558c7a 1113
d8bc7ca3
GS
1114SR_PRIV GString *sr_hexdump_new(const uint8_t *data, const size_t len);
1115SR_PRIV void sr_hexdump_free(GString *s);
1116
ac136b57
BV
1117/*--- soft-trigger.c --------------------------------------------------------*/
1118
1119struct soft_trigger_logic {
1120 const struct sr_dev_inst *sdi;
1121 const struct sr_trigger *trigger;
1122 int count;
1123 int unitsize;
1124 int cur_stage;
1125 uint8_t *prev_sample;
fe5a7355
AJ
1126 uint8_t *pre_trigger_buffer;
1127 uint8_t *pre_trigger_head;
1128 int pre_trigger_size;
1129 int pre_trigger_fill;
ac136b57
BV
1130};
1131
d1078180 1132SR_PRIV int logic_channel_unitsize(GSList *channels);
ac136b57 1133SR_PRIV struct soft_trigger_logic *soft_trigger_logic_new(
fe5a7355
AJ
1134 const struct sr_dev_inst *sdi, struct sr_trigger *trigger,
1135 int pre_trigger_samples);
ac136b57
BV
1136SR_PRIV void soft_trigger_logic_free(struct soft_trigger_logic *st);
1137SR_PRIV int soft_trigger_logic_check(struct soft_trigger_logic *st, uint8_t *buf,
fe5a7355 1138 int len, int *pre_trigger_samples);
ac136b57 1139
fcfa36fd 1140/*--- serial.c --------------------------------------------------------------*/
058b7035 1141
1df81f4b 1142#ifdef HAVE_SERIAL_COMM
a54dd31e
UH
1143enum {
1144 SERIAL_RDWR = 1,
1145 SERIAL_RDONLY = 2,
a54dd31e
UH
1146};
1147
144f6660 1148typedef gboolean (*packet_valid_callback)(const uint8_t *buf);
766456be 1149
ae4c1fb6
GS
1150typedef GSList *(*sr_ser_list_append_t)(GSList *devs, const char *name,
1151 const char *desc);
1152typedef GSList *(*sr_ser_find_append_t)(GSList *devs, const char *name);
1153
299bdb24
BV
1154SR_PRIV int serial_open(struct sr_serial_dev_inst *serial, int flags);
1155SR_PRIV int serial_close(struct sr_serial_dev_inst *serial);
1156SR_PRIV int serial_flush(struct sr_serial_dev_inst *serial);
bce75f94 1157SR_PRIV int serial_drain(struct sr_serial_dev_inst *serial);
8c3df6e5 1158SR_PRIV size_t serial_has_receive_data(struct sr_serial_dev_inst *serial);
9a474211 1159SR_PRIV int serial_write_blocking(struct sr_serial_dev_inst *serial,
eead2782 1160 const void *buf, size_t count, unsigned int timeout_ms);
9a474211
ML
1161SR_PRIV int serial_write_nonblocking(struct sr_serial_dev_inst *serial,
1162 const void *buf, size_t count);
9a474211 1163SR_PRIV int serial_read_blocking(struct sr_serial_dev_inst *serial, void *buf,
eead2782 1164 size_t count, unsigned int timeout_ms);
9a474211
ML
1165SR_PRIV int serial_read_nonblocking(struct sr_serial_dev_inst *serial, void *buf,
1166 size_t count);
d4787248
GS
1167SR_PRIV int serial_set_read_chunk_cb(struct sr_serial_dev_inst *serial,
1168 serial_rx_chunk_callback cb, void *cb_data);
299bdb24 1169SR_PRIV int serial_set_params(struct sr_serial_dev_inst *serial, int baudrate,
71caaad4 1170 int bits, int parity, int stopbits, int flowcontrol, int rts, int dtr);
299bdb24
BV
1171SR_PRIV int serial_set_paramstr(struct sr_serial_dev_inst *serial,
1172 const char *paramstr);
1173SR_PRIV int serial_readline(struct sr_serial_dev_inst *serial, char **buf,
1174 int *buflen, gint64 timeout_ms);
766456be
UH
1175SR_PRIV int serial_stream_detect(struct sr_serial_dev_inst *serial,
1176 uint8_t *buf, size_t *buflen,
144f6660
UH
1177 size_t packet_size,
1178 packet_valid_callback is_valid,
d03815a0 1179 uint64_t timeout_ms);
1bd9e678
DJ
1180SR_PRIV int sr_serial_extract_options(GSList *options, const char **serial_device,
1181 const char **serial_options);
102f1239
BV
1182SR_PRIV int serial_source_add(struct sr_session *session,
1183 struct sr_serial_dev_inst *serial, int events, int timeout,
1184 sr_receive_data_callback cb, void *cb_data);
1185SR_PRIV int serial_source_remove(struct sr_session *session,
1186 struct sr_serial_dev_inst *serial);
b541f837 1187SR_PRIV GSList *sr_serial_find_usb(uint16_t vendor_id, uint16_t product_id);
c5cfc735 1188SR_PRIV int serial_timeout(struct sr_serial_dev_inst *port, int num_bytes);
ae4c1fb6 1189
ad5aa993
GS
1190SR_PRIV void sr_ser_discard_queued_data(struct sr_serial_dev_inst *serial);
1191SR_PRIV size_t sr_ser_has_queued_data(struct sr_serial_dev_inst *serial);
1192SR_PRIV void sr_ser_queue_rx_data(struct sr_serial_dev_inst *serial,
1193 const uint8_t *data, size_t len);
1194SR_PRIV size_t sr_ser_unqueue_rx_data(struct sr_serial_dev_inst *serial,
1195 uint8_t *data, size_t len);
1196
a7b8692e
GS
1197struct ser_lib_functions {
1198 int (*open)(struct sr_serial_dev_inst *serial, int flags);
1199 int (*close)(struct sr_serial_dev_inst *serial);
1200 int (*flush)(struct sr_serial_dev_inst *serial);
1201 int (*drain)(struct sr_serial_dev_inst *serial);
1202 int (*write)(struct sr_serial_dev_inst *serial,
1203 const void *buf, size_t count,
1204 int nonblocking, unsigned int timeout_ms);
1205 int (*read)(struct sr_serial_dev_inst *serial,
1206 void *buf, size_t count,
1207 int nonblocking, unsigned int timeout_ms);
1208 int (*set_params)(struct sr_serial_dev_inst *serial,
1209 int baudrate, int bits, int parity, int stopbits,
1210 int flowcontrol, int rts, int dtr);
1211 int (*setup_source_add)(struct sr_session *session,
1212 struct sr_serial_dev_inst *serial,
1213 int events, int timeout,
1214 sr_receive_data_callback cb, void *cb_data);
1215 int (*setup_source_remove)(struct sr_session *session,
1216 struct sr_serial_dev_inst *serial);
1217 GSList *(*list)(GSList *list, sr_ser_list_append_t append);
1218 GSList *(*find_usb)(GSList *list, sr_ser_find_append_t append,
1219 uint16_t vendor_id, uint16_t product_id);
1220 int (*get_frame_format)(struct sr_serial_dev_inst *serial,
1221 int *baud, int *bits);
1222 size_t (*get_rx_avail)(struct sr_serial_dev_inst *serial);
1223};
1224extern SR_PRIV struct ser_lib_functions *ser_lib_funcs_libsp;
4417074c
GS
1225SR_PRIV int ser_name_is_hid(struct sr_serial_dev_inst *serial);
1226extern SR_PRIV struct ser_lib_functions *ser_lib_funcs_hid;
b79c3422
GS
1227SR_PRIV int ser_name_is_bt(struct sr_serial_dev_inst *serial);
1228extern SR_PRIV struct ser_lib_functions *ser_lib_funcs_bt;
edec0436
GS
1229
1230#ifdef HAVE_LIBHIDAPI
1231struct vid_pid_item {
1232 uint16_t vid, pid;
1233};
1234#define VID_PID_TERM ALL_ZERO
1235
1236struct ser_hid_chip_functions {
1237 const char *chipname;
1238 const char *chipdesc;
1239 const struct vid_pid_item *vid_pid_items;
1240 const int max_bytes_per_request;
1241 int (*set_params)(struct sr_serial_dev_inst *serial,
1242 int baudrate, int bits, int parity, int stopbits,
1243 int flowcontrol, int rts, int dtr);
1244 int (*read_bytes)(struct sr_serial_dev_inst *serial,
1245 uint8_t *data, int space, unsigned int timeout);
1246 int (*write_bytes)(struct sr_serial_dev_inst *serial,
1247 const uint8_t *data, int space);
1248 int (*flush)(struct sr_serial_dev_inst *serial);
1249 int (*drain)(struct sr_serial_dev_inst *serial);
1250};
a10284cd 1251extern SR_PRIV struct ser_hid_chip_functions *ser_hid_chip_funcs_bu86x;
828eeea2 1252extern SR_PRIV struct ser_hid_chip_functions *ser_hid_chip_funcs_ch9325;
616bc3a1 1253extern SR_PRIV struct ser_hid_chip_functions *ser_hid_chip_funcs_cp2110;
edec0436
GS
1254SR_PRIV const char *ser_hid_chip_find_name_vid_pid(uint16_t vid, uint16_t pid);
1255#endif
c4f2dfd0 1256#endif
1483577e 1257
7c8ae47d
GS
1258/*--- bt/ API ---------------------------------------------------------------*/
1259
1260#ifdef HAVE_BLUETOOTH
1261SR_PRIV const char *sr_bt_adapter_get_address(size_t idx);
1262
1263struct sr_bt_desc;
1264typedef void (*sr_bt_scan_cb)(void *cb_data, const char *addr, const char *name);
1265typedef int (*sr_bt_data_cb)(void *cb_data, uint8_t *data, size_t dlen);
1266
1267SR_PRIV struct sr_bt_desc *sr_bt_desc_new(void);
1268SR_PRIV void sr_bt_desc_free(struct sr_bt_desc *desc);
1269
1270SR_PRIV int sr_bt_config_cb_scan(struct sr_bt_desc *desc,
1271 sr_bt_scan_cb cb, void *cb_data);
1272SR_PRIV int sr_bt_config_cb_data(struct sr_bt_desc *desc,
1273 sr_bt_data_cb cb, void *cb_data);
1274SR_PRIV int sr_bt_config_addr_local(struct sr_bt_desc *desc, const char *addr);
1275SR_PRIV int sr_bt_config_addr_remote(struct sr_bt_desc *desc, const char *addr);
1276SR_PRIV int sr_bt_config_rfcomm(struct sr_bt_desc *desc, size_t channel);
1277SR_PRIV int sr_bt_config_notify(struct sr_bt_desc *desc,
1278 uint16_t read_handle, uint16_t write_handle,
1279 uint16_t cccd_handle, uint16_t cccd_value);
1280
1281SR_PRIV int sr_bt_scan_le(struct sr_bt_desc *desc, int duration);
1282SR_PRIV int sr_bt_scan_bt(struct sr_bt_desc *desc, int duration);
1283
1284SR_PRIV int sr_bt_connect_ble(struct sr_bt_desc *desc);
1285SR_PRIV int sr_bt_connect_rfcomm(struct sr_bt_desc *desc);
1286SR_PRIV void sr_bt_disconnect(struct sr_bt_desc *desc);
1287
1288SR_PRIV ssize_t sr_bt_read(struct sr_bt_desc *desc,
1289 void *data, size_t len);
1290SR_PRIV ssize_t sr_bt_write(struct sr_bt_desc *desc,
1291 const void *data, size_t len);
1292
1293SR_PRIV int sr_bt_start_notify(struct sr_bt_desc *desc);
1294SR_PRIV int sr_bt_check_notify(struct sr_bt_desc *desc);
1295#endif
1296
fcfa36fd 1297/*--- ezusb.c ---------------------------------------------------------------*/
058b7035 1298
22b02383 1299#ifdef HAVE_LIBUSB_1_0
1a081ca6 1300SR_PRIV int ezusb_reset(struct libusb_device_handle *hdl, int set_clear);
8e2d6c9d
DE
1301SR_PRIV int ezusb_install_firmware(struct sr_context *ctx, libusb_device_handle *hdl,
1302 const char *name);
1303SR_PRIV int ezusb_upload_firmware(struct sr_context *ctx, libusb_device *dev,
1304 int configuration, const char *name);
22b02383 1305#endif
058b7035 1306
fcfa36fd 1307/*--- usb.c -----------------------------------------------------------------*/
0c632d36
UH
1308
1309#ifdef HAVE_LIBUSB_1_0
7ae6a758 1310SR_PRIV GSList *sr_usb_find(libusb_context *usb_ctx, const char *conn);
0c632d36 1311SR_PRIV int sr_usb_open(libusb_context *usb_ctx, struct sr_usb_dev_inst *usb);
67e95ed3 1312SR_PRIV void sr_usb_close(struct sr_usb_dev_inst *usb);
102f1239
BV
1313SR_PRIV int usb_source_add(struct sr_session *session, struct sr_context *ctx,
1314 int timeout, sr_receive_data_callback cb, void *cb_data);
1315SR_PRIV int usb_source_remove(struct sr_session *session, struct sr_context *ctx);
76bc5f63 1316SR_PRIV int usb_get_port_path(libusb_device *dev, char *path, int path_len);
69f7d9b4
JH
1317SR_PRIV gboolean usb_match_manuf_prod(libusb_device *dev,
1318 const char *manufacturer, const char *product);
0c632d36
UH
1319#endif
1320
7b9d7320 1321
daa39012
AJ
1322/*--- modbus/modbus.c -------------------------------------------------------*/
1323
1324struct sr_modbus_dev_inst {
1325 const char *name;
1326 const char *prefix;
1327 int priv_size;
1328 GSList *(*scan)(int modbusaddr);
1329 int (*dev_inst_new)(void *priv, const char *resource,
1330 char **params, const char *serialcomm, int modbusaddr);
1331 int (*open)(void *priv);
1332 int (*source_add)(struct sr_session *session, void *priv, int events,
1333 int timeout, sr_receive_data_callback cb, void *cb_data);
1334 int (*source_remove)(struct sr_session *session, void *priv);
1335 int (*send)(void *priv, const uint8_t *buffer, int buffer_size);
1336 int (*read_begin)(void *priv, uint8_t *function_code);
1337 int (*read_data)(void *priv, uint8_t *buf, int maxlen);
1338 int (*read_end)(void *priv);
1339 int (*close)(void *priv);
1340 void (*free)(void *priv);
1341 unsigned int read_timeout_ms;
1342 void *priv;
1343};
1344
1345SR_PRIV GSList *sr_modbus_scan(struct drv_context *drvc, GSList *options,
1346 struct sr_dev_inst *(*probe_device)(struct sr_modbus_dev_inst *modbus));
1347SR_PRIV struct sr_modbus_dev_inst *modbus_dev_inst_new(const char *resource,
1348 const char *serialcomm, int modbusaddr);
1349SR_PRIV int sr_modbus_open(struct sr_modbus_dev_inst *modbus);
1350SR_PRIV int sr_modbus_source_add(struct sr_session *session,
1351 struct sr_modbus_dev_inst *modbus, int events, int timeout,
1352 sr_receive_data_callback cb, void *cb_data);
1353SR_PRIV int sr_modbus_source_remove(struct sr_session *session,
1354 struct sr_modbus_dev_inst *modbus);
1355SR_PRIV int sr_modbus_request(struct sr_modbus_dev_inst *modbus,
1356 uint8_t *request, int request_size);
1357SR_PRIV int sr_modbus_reply(struct sr_modbus_dev_inst *modbus,
1358 uint8_t *reply, int reply_size);
1359SR_PRIV int sr_modbus_request_reply(struct sr_modbus_dev_inst *modbus,
1360 uint8_t *request, int request_size,
1361 uint8_t *reply, int reply_size);
1362SR_PRIV int sr_modbus_read_coils(struct sr_modbus_dev_inst *modbus,
1363 int address, int nb_coils, uint8_t *coils);
1364SR_PRIV int sr_modbus_read_holding_registers(struct sr_modbus_dev_inst *modbus,
1365 int address, int nb_registers,
1366 uint16_t *registers);
1367SR_PRIV int sr_modbus_write_coil(struct sr_modbus_dev_inst *modbus,
1368 int address, int value);
1369SR_PRIV int sr_modbus_write_multiple_registers(struct sr_modbus_dev_inst*modbus,
1370 int address, int nb_registers,
1371 uint16_t *registers);
1372SR_PRIV int sr_modbus_close(struct sr_modbus_dev_inst *modbus);
1373SR_PRIV void sr_modbus_free(struct sr_modbus_dev_inst *modbus);
1374
fcfa36fd 1375/*--- dmm/es519xx.c ---------------------------------------------------------*/
c01bdebc 1376
bfb926c1
AJ
1377/**
1378 * All 11-byte es519xx chips repeat each block twice for each conversion cycle
1379 * so always read 2 blocks at a time.
1380 */
1381#define ES519XX_11B_PACKET_SIZE (11 * 2)
72e1672f 1382#define ES519XX_14B_PACKET_SIZE 14
c01bdebc
AJ
1383
1384struct es519xx_info {
1385 gboolean is_judge, is_voltage, is_auto, is_micro, is_current;
1386 gboolean is_milli, is_resistance, is_continuity, is_diode;
1387 gboolean is_frequency, is_rpm, is_capacitance, is_duty_cycle;
1388 gboolean is_temperature, is_celsius, is_fahrenheit;
1389 gboolean is_adp0, is_adp1, is_adp2, is_adp3;
1390 gboolean is_sign, is_batt, is_ol, is_pmax, is_pmin, is_apo;
1391 gboolean is_dc, is_ac, is_vahz, is_min, is_max, is_rel, is_hold;
1392 gboolean is_digit4, is_ul, is_vasel, is_vbar, is_lpf1, is_lpf0, is_rmr;
1393 uint32_t baudrate;
1394 int packet_size;
1395 gboolean alt_functions, fivedigits, clampmeter, selectable_lpf;
8cbf5627 1396 int digits;
c01bdebc
AJ
1397};
1398
72e1672f
UH
1399SR_PRIV gboolean sr_es519xx_2400_11b_packet_valid(const uint8_t *buf);
1400SR_PRIV int sr_es519xx_2400_11b_parse(const uint8_t *buf, float *floatval,
8c677240 1401 struct sr_datafeed_analog *analog, void *info);
2588e50c
AJ
1402SR_PRIV gboolean sr_es519xx_2400_11b_altfn_packet_valid(const uint8_t *buf);
1403SR_PRIV int sr_es519xx_2400_11b_altfn_parse(const uint8_t *buf,
8c677240 1404 float *floatval, struct sr_datafeed_analog *analog, void *info);
72e1672f 1405SR_PRIV gboolean sr_es519xx_19200_11b_5digits_packet_valid(const uint8_t *buf);
93d719cd 1406SR_PRIV int sr_es519xx_19200_11b_5digits_parse(const uint8_t *buf,
8c677240 1407 float *floatval, struct sr_datafeed_analog *analog, void *info);
72e1672f
UH
1408SR_PRIV gboolean sr_es519xx_19200_11b_clamp_packet_valid(const uint8_t *buf);
1409SR_PRIV int sr_es519xx_19200_11b_clamp_parse(const uint8_t *buf,
8c677240 1410 float *floatval, struct sr_datafeed_analog *analog, void *info);
72e1672f
UH
1411SR_PRIV gboolean sr_es519xx_19200_11b_packet_valid(const uint8_t *buf);
1412SR_PRIV int sr_es519xx_19200_11b_parse(const uint8_t *buf, float *floatval,
8c677240 1413 struct sr_datafeed_analog *analog, void *info);
72e1672f
UH
1414SR_PRIV gboolean sr_es519xx_19200_14b_packet_valid(const uint8_t *buf);
1415SR_PRIV int sr_es519xx_19200_14b_parse(const uint8_t *buf, float *floatval,
8c677240 1416 struct sr_datafeed_analog *analog, void *info);
72e1672f
UH
1417SR_PRIV gboolean sr_es519xx_19200_14b_sel_lpf_packet_valid(const uint8_t *buf);
1418SR_PRIV int sr_es519xx_19200_14b_sel_lpf_parse(const uint8_t *buf,
8c677240 1419 float *floatval, struct sr_datafeed_analog *analog, void *info);
c01bdebc 1420
fcfa36fd 1421/*--- dmm/fs9922.c ----------------------------------------------------------*/
79081ec8 1422
913abe83
UH
1423#define FS9922_PACKET_SIZE 14
1424
1425struct fs9922_info {
1426 gboolean is_auto, is_dc, is_ac, is_rel, is_hold, is_bpn, is_z1, is_z2;
1427 gboolean is_max, is_min, is_apo, is_bat, is_nano, is_z3, is_micro;
1428 gboolean is_milli, is_kilo, is_mega, is_beep, is_diode, is_percent;
1429 gboolean is_z4, is_volt, is_ampere, is_ohm, is_hfe, is_hertz, is_farad;
1430 gboolean is_celsius, is_fahrenheit;
1431 int bargraph_sign, bargraph_value;
1432};
1433
913abe83
UH
1434SR_PRIV gboolean sr_fs9922_packet_valid(const uint8_t *buf);
1435SR_PRIV int sr_fs9922_parse(const uint8_t *buf, float *floatval,
8c677240
UH
1436 struct sr_datafeed_analog *analog, void *info);
1437SR_PRIV void sr_fs9922_z1_diode(struct sr_datafeed_analog *analog, void *info);
79081ec8 1438
fcfa36fd 1439/*--- dmm/fs9721.c ----------------------------------------------------------*/
6c701476 1440
8c1adf37
UH
1441#define FS9721_PACKET_SIZE 14
1442
1443struct fs9721_info {
1444 gboolean is_ac, is_dc, is_auto, is_rs232, is_micro, is_nano, is_kilo;
1445 gboolean is_diode, is_milli, is_percent, is_mega, is_beep, is_farad;
1446 gboolean is_ohm, is_rel, is_hold, is_ampere, is_volt, is_hz, is_bat;
1447 gboolean is_c2c1_11, is_c2c1_10, is_c2c1_01, is_c2c1_00, is_sign;
1448};
1449
8c1adf37
UH
1450SR_PRIV gboolean sr_fs9721_packet_valid(const uint8_t *buf);
1451SR_PRIV int sr_fs9721_parse(const uint8_t *buf, float *floatval,
8c677240
UH
1452 struct sr_datafeed_analog *analog, void *info);
1453SR_PRIV void sr_fs9721_00_temp_c(struct sr_datafeed_analog *analog, void *info);
1454SR_PRIV void sr_fs9721_01_temp_c(struct sr_datafeed_analog *analog, void *info);
1455SR_PRIV void sr_fs9721_10_temp_c(struct sr_datafeed_analog *analog, void *info);
1456SR_PRIV void sr_fs9721_01_10_temp_f_c(struct sr_datafeed_analog *analog, void *info);
1457SR_PRIV void sr_fs9721_max_c_min(struct sr_datafeed_analog *analog, void *info);
dcd212f7
VV
1458
1459/*--- dmm/ms2115b.c ---------------------------------------------------------*/
1460
1461#define MS2115B_PACKET_SIZE 9
1462
1463enum ms2115b_display {
1464 MS2115B_DISPLAY_MAIN,
1465 MS2115B_DISPLAY_SUB,
1466 MS2115B_DISPLAY_COUNT,
1467};
1468
1469struct ms2115b_info {
1470 /* Selected channel. */
1471 size_t ch_idx;
1472 gboolean is_ac, is_dc, is_auto;
1473 gboolean is_diode, is_beep, is_farad;
1474 gboolean is_ohm, is_ampere, is_volt, is_hz;
1475 gboolean is_duty_cycle, is_percent;
1476};
1477
1478extern SR_PRIV const char *ms2115b_channel_formats[];
1479SR_PRIV gboolean sr_ms2115b_packet_valid(const uint8_t *buf);
1480SR_PRIV int sr_ms2115b_parse(const uint8_t *buf, float *floatval,
1481 struct sr_datafeed_analog *analog, void *info);
6c701476 1482
fcfa36fd 1483/*--- dmm/ms8250d.c ---------------------------------------------------------*/
67070942
M
1484
1485#define MS8250D_PACKET_SIZE 18
1486
1487struct ms8250d_info {
1488 gboolean is_ac, is_dc, is_auto, is_rs232, is_micro, is_nano, is_kilo;
1489 gboolean is_diode, is_milli, is_percent, is_mega, is_beep, is_farad;
1490 gboolean is_ohm, is_rel, is_hold, is_ampere, is_volt, is_hz, is_bat;
1491 gboolean is_ncv, is_min, is_max, is_sign, is_autotimer;
1492};
1493
1494SR_PRIV gboolean sr_ms8250d_packet_valid(const uint8_t *buf);
1495SR_PRIV int sr_ms8250d_parse(const uint8_t *buf, float *floatval,
1496 struct sr_datafeed_analog *analog, void *info);
1497
fcfa36fd 1498/*--- dmm/dtm0660.c ---------------------------------------------------------*/
eed3dec8
MG
1499
1500#define DTM0660_PACKET_SIZE 15
1501
1502struct dtm0660_info {
1503 gboolean is_ac, is_dc, is_auto, is_rs232, is_micro, is_nano, is_kilo;
1504 gboolean is_diode, is_milli, is_percent, is_mega, is_beep, is_farad;
1505 gboolean is_ohm, is_rel, is_hold, is_ampere, is_volt, is_hz, is_bat;
1506 gboolean is_degf, is_degc, is_c2c1_01, is_c2c1_00, is_apo, is_min;
1507 gboolean is_minmax, is_max, is_sign;
1508};
1509
1510SR_PRIV gboolean sr_dtm0660_packet_valid(const uint8_t *buf);
1511SR_PRIV int sr_dtm0660_parse(const uint8_t *buf, float *floatval,
8c677240 1512 struct sr_datafeed_analog *analog, void *info);
eed3dec8 1513
fcfa36fd 1514/*--- dmm/m2110.c -----------------------------------------------------------*/
825da8b2
MH
1515
1516#define BBCGM_M2110_PACKET_SIZE 9
1517
9d12555f
UH
1518/* Dummy info struct. The parser does not use it. */
1519struct m2110_info { int dummy; };
1520
825da8b2
MH
1521SR_PRIV gboolean sr_m2110_packet_valid(const uint8_t *buf);
1522SR_PRIV int sr_m2110_parse(const uint8_t *buf, float *floatval,
8c677240 1523 struct sr_datafeed_analog *analog, void *info);
825da8b2 1524
fcfa36fd 1525/*--- dmm/metex14.c ---------------------------------------------------------*/
ac913e5c
UH
1526
1527#define METEX14_PACKET_SIZE 14
1528
1529struct metex14_info {
556a926d 1530 size_t ch_idx;
ac913e5c
UH
1531 gboolean is_ac, is_dc, is_resistance, is_capacity, is_temperature;
1532 gboolean is_diode, is_frequency, is_ampere, is_volt, is_farad;
7fb4ff02
FS
1533 gboolean is_hertz, is_ohm, is_celsius, is_fahrenheit, is_watt;
1534 gboolean is_pico, is_nano, is_micro, is_milli, is_kilo, is_mega;
fd8dc1db 1535 gboolean is_gain, is_decibel, is_power, is_decibel_mw, is_power_factor;
7fb4ff02 1536 gboolean is_hfe, is_unitless, is_logic, is_min, is_max, is_avg;
ac913e5c
UH
1537};
1538
1df81f4b 1539#ifdef HAVE_SERIAL_COMM
ce3777ad 1540SR_PRIV int sr_metex14_packet_request(struct sr_serial_dev_inst *serial);
c4f2dfd0 1541#endif
ac913e5c
UH
1542SR_PRIV gboolean sr_metex14_packet_valid(const uint8_t *buf);
1543SR_PRIV int sr_metex14_parse(const uint8_t *buf, float *floatval,
8c677240 1544 struct sr_datafeed_analog *analog, void *info);
556a926d
GS
1545SR_PRIV gboolean sr_metex14_4packets_valid(const uint8_t *buf);
1546SR_PRIV int sr_metex14_4packets_parse(const uint8_t *buf, float *floatval,
1547 struct sr_datafeed_analog *analog, void *info);
ac913e5c 1548
fcfa36fd 1549/*--- dmm/rs9lcd.c ----------------------------------------------------------*/
05f134ab 1550
21829e67 1551#define RS9LCD_PACKET_SIZE 9
05f134ab 1552
e7ed87a4 1553/* Dummy info struct. The parser does not use it. */
bf6f8399 1554struct rs9lcd_info { int dummy; };
e7ed87a4 1555
05f134ab
AG
1556SR_PRIV gboolean sr_rs9lcd_packet_valid(const uint8_t *buf);
1557SR_PRIV int sr_rs9lcd_parse(const uint8_t *buf, float *floatval,
8c677240 1558 struct sr_datafeed_analog *analog, void *info);
05f134ab 1559
fcfa36fd 1560/*--- dmm/bm25x.c -----------------------------------------------------------*/
a24c3f4a
JH
1561
1562#define BRYMEN_BM25X_PACKET_SIZE 15
1563
1564/* Dummy info struct. The parser does not use it. */
1565struct bm25x_info { int dummy; };
1566
1567SR_PRIV gboolean sr_brymen_bm25x_packet_valid(const uint8_t *buf);
1568SR_PRIV int sr_brymen_bm25x_parse(const uint8_t *buf, float *floatval,
8c677240 1569 struct sr_datafeed_analog *analog, void *info);
a24c3f4a 1570
fcfa36fd 1571/*--- dmm/ut71x.c -----------------------------------------------------------*/
626027df
UH
1572
1573#define UT71X_PACKET_SIZE 11
1574
1575struct ut71x_info {
1576 gboolean is_voltage, is_resistance, is_capacitance, is_temperature;
1577 gboolean is_celsius, is_fahrenheit, is_current, is_continuity;
1578 gboolean is_diode, is_frequency, is_duty_cycle, is_dc, is_ac;
1579 gboolean is_auto, is_manual, is_sign, is_power, is_loop_current;
1580};
1581
1582SR_PRIV gboolean sr_ut71x_packet_valid(const uint8_t *buf);
1583SR_PRIV int sr_ut71x_parse(const uint8_t *buf, float *floatval,
8c677240 1584 struct sr_datafeed_analog *analog, void *info);
626027df 1585
fcfa36fd 1586/*--- dmm/vc870.c -----------------------------------------------------------*/
c36f78f7
UH
1587
1588#define VC870_PACKET_SIZE 23
1589
1590struct vc870_info {
1591 gboolean is_voltage, is_dc, is_ac, is_temperature, is_resistance;
1592 gboolean is_continuity, is_capacitance, is_diode, is_loop_current;
1593 gboolean is_current, is_micro, is_milli, is_power;
ee2e9be2 1594 gboolean is_power_factor_freq, is_power_apparent_power, is_v_a_rms_value;
c36f78f7
UH
1595 gboolean is_sign2, is_sign1, is_batt, is_ol1, is_max, is_min;
1596 gboolean is_maxmin, is_rel, is_ol2, is_open, is_manu, is_hold;
1597 gboolean is_light, is_usb, is_warning, is_auto_power, is_misplug_warn;
1598 gboolean is_lo, is_hi, is_open2;
1599
3591481e 1600 gboolean is_frequency, is_dual_display, is_auto;
c36f78f7
UH
1601};
1602
1603SR_PRIV gboolean sr_vc870_packet_valid(const uint8_t *buf);
1604SR_PRIV int sr_vc870_parse(const uint8_t *buf, float *floatval,
8c677240 1605 struct sr_datafeed_analog *analog, void *info);
c36f78f7 1606
fcfa36fd 1607/*--- dmm/vc96.c ------------------------------------------------------------*/
9456d636
MS
1608
1609#define VC96_PACKET_SIZE 13
1610
1611struct vc96_info {
1612 size_t ch_idx;
1613 gboolean is_ac, is_dc, is_resistance, is_diode, is_ampere, is_volt;
1614 gboolean is_ohm, is_micro, is_milli, is_kilo, is_mega, is_hfe;
1615 gboolean is_unitless;
1616};
1617
1618SR_PRIV gboolean sr_vc96_packet_valid(const uint8_t *buf);
1619SR_PRIV int sr_vc96_parse(const uint8_t *buf, float *floatval,
1620 struct sr_datafeed_analog *analog, void *info);
1621
fcfa36fd 1622/*--- lcr/es51919.c ---------------------------------------------------------*/
6bcb3ee8 1623
bf5c4d46
GS
1624/* Acquisition details which apply to all supported serial-lcr devices. */
1625struct lcr_parse_info {
1626 size_t ch_idx;
1627 uint64_t output_freq;
1628 const char *circuit_model;
1629};
1630
1631#define ES51919_PACKET_SIZE 17
1632#define ES51919_CHANNEL_COUNT 2
1633#define ES51919_COMM_PARAM "9600/8n1/rts=1/dtr=1"
1634
1635SR_PRIV int es51919_config_get(uint32_t key, GVariant **data,
1636 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg);
1637SR_PRIV int es51919_config_set(uint32_t key, GVariant *data,
1638 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg);
1639SR_PRIV int es51919_config_list(uint32_t key, GVariant **data,
1640 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg);
1641SR_PRIV gboolean es51919_packet_valid(const uint8_t *pkt);
1642SR_PRIV int es51919_packet_parse(const uint8_t *pkt, float *floatval,
1643 struct sr_datafeed_analog *analog, void *info);
6bcb3ee8 1644
fcfa36fd 1645/*--- dmm/ut372.c -----------------------------------------------------------*/
f3cde309
ML
1646
1647#define UT372_PACKET_SIZE 27
1648
1649struct ut372_info {
1650 int dummy;
1651};
1652
1653SR_PRIV gboolean sr_ut372_packet_valid(const uint8_t *buf);
1654SR_PRIV int sr_ut372_parse(const uint8_t *buf, float *floatval,
8c677240 1655 struct sr_datafeed_analog *analog, void *info);
f3cde309 1656
fcfa36fd 1657/*--- dmm/asycii.c ----------------------------------------------------------*/
4ba4d52a
GS
1658
1659#define ASYCII_PACKET_SIZE 16
1660
1661struct asycii_info {
1662 gboolean is_ac, is_dc, is_ac_and_dc;
1663 gboolean is_resistance, is_capacitance, is_diode, is_gain;
1664 gboolean is_frequency, is_duty_cycle, is_duty_pos, is_duty_neg;
1665 gboolean is_pulse_width, is_period_pos, is_period_neg;
1666 gboolean is_pulse_count, is_count_pos, is_count_neg;
1667 gboolean is_ampere, is_volt, is_volt_ampere, is_farad, is_ohm;
1668 gboolean is_hertz, is_percent, is_seconds, is_decibel;
1669 gboolean is_pico, is_nano, is_micro, is_milli, is_kilo, is_mega;
1670 gboolean is_unitless;
1671 gboolean is_peak_min, is_peak_max;
1672 gboolean is_invalid;
1673};
1674
1df81f4b 1675#ifdef HAVE_SERIAL_COMM
4ba4d52a
GS
1676SR_PRIV int sr_asycii_packet_request(struct sr_serial_dev_inst *serial);
1677#endif
1678SR_PRIV gboolean sr_asycii_packet_valid(const uint8_t *buf);
1679SR_PRIV int sr_asycii_parse(const uint8_t *buf, float *floatval,
1680 struct sr_datafeed_analog *analog, void *info);
1681
fcfa36fd 1682/*--- dmm/eev121gw.c --------------------------------------------------------*/
1c3098aa
GS
1683
1684#define EEV121GW_PACKET_SIZE 19
1685
1686enum eev121gw_display {
1687 EEV121GW_DISPLAY_MAIN,
1688 EEV121GW_DISPLAY_SUB,
1689 EEV121GW_DISPLAY_BAR,
1690 EEV121GW_DISPLAY_COUNT,
1691};
1692
1693struct eev121gw_info {
1694 /* Selected channel. */
1695 size_t ch_idx;
1696 /*
1697 * Measured value, number and sign/overflow flags, scale factor
1698 * and significant digits.
1699 */
1700 uint32_t uint_value;
1701 gboolean is_ofl, is_neg;
1702 int factor, digits;
1703 /* Currently active mode (meter's function). */
1704 gboolean is_ac, is_dc, is_voltage, is_current, is_power, is_gain;
1705 gboolean is_resistance, is_capacitance, is_diode, is_temperature;
1706 gboolean is_continuity, is_frequency, is_period, is_duty_cycle;
1707 /* Quantities associated with mode/function. */
1708 gboolean is_ampere, is_volt, is_volt_ampere, is_dbm;
1709 gboolean is_ohm, is_farad, is_celsius, is_fahrenheit;
1710 gboolean is_hertz, is_seconds, is_percent, is_loop_current;
1711 gboolean is_unitless, is_logic;
1712 /* Other indicators. */
1713 gboolean is_min, is_max, is_avg, is_1ms_peak, is_rel, is_hold;
1714 gboolean is_low_pass, is_mem, is_bt, is_auto_range, is_test;
1715 gboolean is_auto_poweroff, is_low_batt;
1716};
1717
015df4ae 1718extern SR_PRIV const char *eev121gw_channel_formats[];
1c3098aa
GS
1719SR_PRIV gboolean sr_eev121gw_packet_valid(const uint8_t *buf);
1720SR_PRIV int sr_eev121gw_parse(const uint8_t *buf, float *floatval,
1721 struct sr_datafeed_analog *analog, void *info);
1722SR_PRIV int sr_eev121gw_3displays_parse(const uint8_t *buf, float *floatval,
1723 struct sr_datafeed_analog *analog, void *info);
1724
fcfa36fd 1725/*--- scale/kern.c ----------------------------------------------------------*/
e5d953b5
UH
1726
1727struct kern_info {
1728 gboolean is_gram, is_carat, is_ounce, is_pound, is_troy_ounce;
1729 gboolean is_pennyweight, is_grain, is_tael, is_momme, is_tola;
1730 gboolean is_percentage, is_piece, is_unstable, is_stable, is_error;
1731 int buflen;
1732};
1733
1734SR_PRIV gboolean sr_kern_packet_valid(const uint8_t *buf);
1735SR_PRIV int sr_kern_parse(const uint8_t *buf, float *floatval,
563ba4a5 1736 struct sr_datafeed_analog *analog, void *info);
e5d953b5 1737
aea4e458
LPC
1738/*--- sw_limits.c -----------------------------------------------------------*/
1739
1740struct sr_sw_limits {
1741 uint64_t limit_samples;
67785f25 1742 uint64_t limit_frames;
aea4e458
LPC
1743 uint64_t limit_msec;
1744 uint64_t samples_read;
67785f25 1745 uint64_t frames_read;
aea4e458
LPC
1746 uint64_t start_time;
1747};
1748
1749SR_PRIV int sr_sw_limits_config_get(struct sr_sw_limits *limits, uint32_t key,
1750 GVariant **data);
1751SR_PRIV int sr_sw_limits_config_set(struct sr_sw_limits *limits, uint32_t key,
1752 GVariant *data);
1753SR_PRIV void sr_sw_limits_acquisition_start(struct sr_sw_limits *limits);
1754SR_PRIV gboolean sr_sw_limits_check(struct sr_sw_limits *limits);
1755SR_PRIV void sr_sw_limits_update_samples_read(struct sr_sw_limits *limits,
1756 uint64_t samples_read);
67785f25
GS
1757SR_PRIV void sr_sw_limits_update_frames_read(struct sr_sw_limits *limits,
1758 uint64_t frames_read);
aea4e458
LPC
1759SR_PRIV void sr_sw_limits_init(struct sr_sw_limits *limits);
1760
1483577e 1761#endif