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