]> sigrok.org Git - libsigrok.git/blame - src/libsigrok-internal.h
Add VID/PID for the CWAV USBee ZX.
[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
04cb9157
MH
20/** @file
21 * @internal
22 */
23
a5827886
UH
24#ifndef LIBSIGROK_LIBSIGROK_INTERNAL_H
25#define LIBSIGROK_LIBSIGROK_INTERNAL_H
1483577e 26
b08024a8 27#include <stdarg.h>
4619fab4 28#include <stdio.h>
cc8a7d25 29#include <glib.h>
69890f73
UH
30#ifdef HAVE_LIBUSB_1_0
31#include <libusb.h>
32#endif
c4f2dfd0 33#ifdef HAVE_LIBSERIALPORT
dc991353 34#include <libserialport.h>
c4f2dfd0 35#endif
b08024a8 36
98654c99
DE
37struct zip;
38struct zip_stat;
39
393fb9cb
UH
40/**
41 * @file
42 *
43 * libsigrok private header file, only to be used internally.
44 */
45
4cea9eb2
UH
46/*--- Macros ----------------------------------------------------------------*/
47
48#ifndef ARRAY_SIZE
49#define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0]))
50#endif
51
52#ifndef ARRAY_AND_SIZE
53#define ARRAY_AND_SIZE(a) (a), ARRAY_SIZE(a)
54#endif
55
a4f9c35b 56/**
5bf0dd6a 57 * Read a 8 bits unsigned integer out of memory.
a4f9c35b 58 * @param x a pointer to the input memory
5bf0dd6a 59 * @return the corresponding unsigned integer
a4f9c35b
AJ
60 */
61#define R8(x) ((unsigned)((const uint8_t*)(x))[0])
62
e28ef28a 63/**
5bf0dd6a 64 * Read a 16 bits big endian unsigned integer out of memory.
e28ef28a 65 * @param x a pointer to the input memory
5bf0dd6a 66 * @return the corresponding unsigned integer
e28ef28a 67 */
d01c4c56 68#define RB16(x) (((unsigned)((const uint8_t*)(x))[0] << 8) | \
79a1176b 69 (unsigned)((const uint8_t*)(x))[1])
e28ef28a
AJ
70
71/**
5bf0dd6a 72 * Read a 16 bits little endian unsigned integer out of memory.
e28ef28a 73 * @param x a pointer to the input memory
5bf0dd6a 74 * @return the corresponding unsigned integer
e28ef28a 75 */
79a1176b
AJ
76#define RL16(x) (((unsigned)((const uint8_t*)(x))[1] << 8) | \
77 (unsigned)((const uint8_t*)(x))[0])
e28ef28a 78
4d376e08
SB
79/**
80 * Read a 16 bits big endian signed integer out of memory.
81 * @param x a pointer to the input memory
82 * @return the corresponding signed integer
83 */
84#define RB16S(x) ((int16_t) \
85 (((unsigned)((const uint8_t*)(x))[0] << 8) | \
86 (unsigned)((const uint8_t*)(x))[1]))
87
e28ef28a 88/**
5bf0dd6a 89 * Read a 16 bits little endian signed integer out of memory.
e28ef28a 90 * @param x a pointer to the input memory
5bf0dd6a
BV
91 * @return the corresponding signed integer
92 */
93#define RL16S(x) ((int16_t) \
af945a66 94 (((unsigned)((const uint8_t*)(x))[1] << 8) | \
5bf0dd6a
BV
95 (unsigned)((const uint8_t*)(x))[0]))
96
97/**
98 * Read a 32 bits big endian unsigned integer out of memory.
99 * @param x a pointer to the input memory
100 * @return the corresponding unsigned integer
e28ef28a 101 */
79a1176b 102#define RB32(x) (((unsigned)((const uint8_t*)(x))[0] << 24) | \
d01c4c56
SA
103 ((unsigned)((const uint8_t*)(x))[1] << 16) | \
104 ((unsigned)((const uint8_t*)(x))[2] << 8) | \
79a1176b 105 (unsigned)((const uint8_t*)(x))[3])
e28ef28a
AJ
106
107/**
5bf0dd6a 108 * Read a 32 bits little endian unsigned integer out of memory.
e28ef28a 109 * @param x a pointer to the input memory
5bf0dd6a 110 * @return the corresponding unsigned integer
e28ef28a 111 */
79a1176b 112#define RL32(x) (((unsigned)((const uint8_t*)(x))[3] << 24) | \
d01c4c56
SA
113 ((unsigned)((const uint8_t*)(x))[2] << 16) | \
114 ((unsigned)((const uint8_t*)(x))[1] << 8) | \
79a1176b 115 (unsigned)((const uint8_t*)(x))[0])
e28ef28a 116
4d376e08
SB
117/**
118 * Read a 32 bits big endian signed integer out of memory.
119 * @param x a pointer to the input memory
120 * @return the corresponding signed integer
121 */
122#define RB32S(x) ((int32_t) \
123 (((unsigned)((const uint8_t*)(x))[0] << 24) | \
124 ((unsigned)((const uint8_t*)(x))[1] << 16) | \
125 ((unsigned)((const uint8_t*)(x))[2] << 8) | \
126 (unsigned)((const uint8_t*)(x))[3]))
127
ea2d6d99 128/**
5bf0dd6a
BV
129 * Read a 32 bits little endian signed integer out of memory.
130 * @param x a pointer to the input memory
131 * @return the corresponding signed integer
132 */
133#define RL32S(x) ((int32_t) \
134 (((unsigned)((const uint8_t*)(x))[3] << 24) | \
d01c4c56
SA
135 ((unsigned)((const uint8_t*)(x))[2] << 16) | \
136 ((unsigned)((const uint8_t*)(x))[1] << 8) | \
5bf0dd6a
BV
137 (unsigned)((const uint8_t*)(x))[0]))
138
17b93fd7
TS
139/**
140 * Read a 64 bits big endian unsigned integer out of memory.
141 * @param x a pointer to the input memory
142 * @return the corresponding unsigned integer
143 */
144#define RB64(x) (((uint64_t)((const uint8_t*)(x))[0] << 56) | \
d01c4c56
SA
145 ((uint64_t)((const uint8_t*)(x))[1] << 48) | \
146 ((uint64_t)((const uint8_t*)(x))[2] << 40) | \
147 ((uint64_t)((const uint8_t*)(x))[3] << 32) | \
148 ((uint64_t)((const uint8_t*)(x))[4] << 24) | \
149 ((uint64_t)((const uint8_t*)(x))[5] << 16) | \
150 ((uint64_t)((const uint8_t*)(x))[6] << 8) | \
17b93fd7
TS
151 (uint64_t)((const uint8_t*)(x))[7])
152
8a66b077
SA
153/**
154 * Read a 64 bits little endian unsigned integer out of memory.
155 * @param x a pointer to the input memory
156 * @return the corresponding unsigned integer
157 */
158#define RL64(x) (((uint64_t)((const uint8_t*)(x))[7] << 56) | \
159 ((uint64_t)((const uint8_t*)(x))[6] << 48) | \
160 ((uint64_t)((const uint8_t*)(x))[5] << 40) | \
161 ((uint64_t)((const uint8_t*)(x))[4] << 32) | \
162 ((uint64_t)((const uint8_t*)(x))[3] << 24) | \
163 ((uint64_t)((const uint8_t*)(x))[2] << 16) | \
164 ((uint64_t)((const uint8_t*)(x))[1] << 8) | \
165 (uint64_t)((const uint8_t*)(x))[0])
166
167/**
168 * Read a 64 bits little endian signed integer out of memory.
169 * @param x a pointer to the input memory
170 * @return the corresponding unsigned integer
171 */
172#define RL64S(x) ((int64_t) \
173 (((uint64_t)((const uint8_t*)(x))[7] << 56) | \
174 ((uint64_t)((const uint8_t*)(x))[6] << 48) | \
175 ((uint64_t)((const uint8_t*)(x))[5] << 40) | \
176 ((uint64_t)((const uint8_t*)(x))[4] << 32) | \
177 ((uint64_t)((const uint8_t*)(x))[3] << 24) | \
178 ((uint64_t)((const uint8_t*)(x))[2] << 16) | \
179 ((uint64_t)((const uint8_t*)(x))[1] << 8) | \
180 (uint64_t)((const uint8_t*)(x))[0]))
181
a2632bca
AJ
182/**
183 * Read a 32 bits big endian float out of memory.
184 * @param x a pointer to the input memory
185 * @return the corresponding float
186 */
187#define RBFL(x) ((union { uint32_t u; float f; }) { .u = RB32(x) }.f)
188
189/**
190 * Read a 32 bits little endian float out of memory.
191 * @param x a pointer to the input memory
192 * @return the corresponding float
193 */
194#define RLFL(x) ((union { uint32_t u; float f; }) { .u = RL32(x) }.f)
195
5bf0dd6a
BV
196/**
197 * Write a 8 bits unsigned integer to memory.
ea2d6d99 198 * @param p a pointer to the output memory
5bf0dd6a 199 * @param x the input unsigned integer
ea2d6d99 200 */
0c5f2abc 201#define W8(p, x) do { ((uint8_t*)(p))[0] = (uint8_t) (x); } while (0)
ea2d6d99
AJ
202
203/**
5bf0dd6a 204 * Write a 16 bits unsigned integer to memory stored as big endian.
ea2d6d99 205 * @param p a pointer to the output memory
5bf0dd6a 206 * @param x the input unsigned integer
ea2d6d99
AJ
207 */
208#define WB16(p, x) do { ((uint8_t*)(p))[1] = (uint8_t) (x); \
0c5f2abc 209 ((uint8_t*)(p))[0] = (uint8_t)((x)>>8); } while (0)
ea2d6d99
AJ
210
211/**
5bf0dd6a 212 * Write a 16 bits unsigned integer to memory stored as little endian.
ea2d6d99 213 * @param p a pointer to the output memory
5bf0dd6a 214 * @param x the input unsigned integer
ea2d6d99
AJ
215 */
216#define WL16(p, x) do { ((uint8_t*)(p))[0] = (uint8_t) (x); \
0c5f2abc 217 ((uint8_t*)(p))[1] = (uint8_t)((x)>>8); } while (0)
ea2d6d99
AJ
218
219/**
5bf0dd6a 220 * Write a 32 bits unsigned integer to memory stored as big endian.
ea2d6d99 221 * @param p a pointer to the output memory
5bf0dd6a 222 * @param x the input unsigned integer
ea2d6d99
AJ
223 */
224#define WB32(p, x) do { ((uint8_t*)(p))[3] = (uint8_t) (x); \
225 ((uint8_t*)(p))[2] = (uint8_t)((x)>>8); \
226 ((uint8_t*)(p))[1] = (uint8_t)((x)>>16); \
0c5f2abc 227 ((uint8_t*)(p))[0] = (uint8_t)((x)>>24); } while (0)
ea2d6d99
AJ
228
229/**
5bf0dd6a 230 * Write a 32 bits unsigned integer to memory stored as little endian.
ea2d6d99 231 * @param p a pointer to the output memory
5bf0dd6a 232 * @param x the input unsigned integer
ea2d6d99
AJ
233 */
234#define WL32(p, x) do { ((uint8_t*)(p))[0] = (uint8_t) (x); \
235 ((uint8_t*)(p))[1] = (uint8_t)((x)>>8); \
236 ((uint8_t*)(p))[2] = (uint8_t)((x)>>16); \
0c5f2abc 237 ((uint8_t*)(p))[3] = (uint8_t)((x)>>24); } while (0)
ea2d6d99 238
a2632bca
AJ
239/**
240 * Write a 32 bits float to memory stored as big endian.
241 * @param p a pointer to the output memory
242 * @param x the input float
243 */
244#define WBFL(p, x) WB32(p, (union { uint32_t u; float f; }) { .f = x }.u)
245
246/**
247 * Write a 32 bits float to memory stored as little endian.
248 * @param p a pointer to the output memory
249 * @param x the input float
250 */
251#define WLFL(p, x) WL32(p, (union { uint32_t u; float f; }) { .f = x }.u)
252
6bf4273e
UH
253/* Portability fixes for FreeBSD. */
254#ifdef __FreeBSD__
255#define LIBUSB_CLASS_APPLICATION 0xfe
15eea61a 256#define libusb_has_capability(x) 0
6bf4273e
UH
257#define libusb_handle_events_timeout_completed(ctx, tv, c) \
258 libusb_handle_events_timeout(ctx, tv)
259#endif
260
1685c276
BV
261/* Static definitions of structs ending with an all-zero entry are a
262 * problem when compiling with -Wmissing-field-initializers: GCC
263 * suppresses the warning only with { 0 }, clang wants { } */
264#ifdef __clang__
265#define ALL_ZERO { }
266#else
267#define ALL_ZERO { 0 }
268#endif
269
dd5c48a6
LPC
270#ifdef __APPLE__
271#define SR_DRIVER_LIST_SECTION "__DATA,__sr_driver_list"
272#else
273#define SR_DRIVER_LIST_SECTION "sr_driver_list"
274#endif
275
276/**
277 * Register a list of hardware drivers.
278 *
279 * This macro can be used to register multiple hardware drivers to the library.
280 * This is useful when a driver supports multiple similar but slightly
281 * different devices that require different sr_dev_driver struct definitions.
282 *
283 * For registering only a single driver see SR_REGISTER_DEV_DRIVER().
284 *
285 * Example:
286 * @code{c}
287 * #define MY_DRIVER(_name) \
288 * &(struct sr_dev_driver){ \
289 * .name = _name, \
290 * ...
291 * };
292 *
293 * SR_REGISTER_DEV_DRIVER_LIST(my_driver_infos,
294 * MY_DRIVER("driver 1"),
295 * MY_DRIVER("driver 2"),
296 * ...
297 * );
298 * @endcode
299 *
300 * @param name Name to use for the driver list identifier.
301 * @param ... Comma separated list of pointers to sr_dev_driver structs.
302 */
303#define SR_REGISTER_DEV_DRIVER_LIST(name, ...) \
304 static const struct sr_dev_driver *name[] \
305 __attribute__((section (SR_DRIVER_LIST_SECTION), used, \
306 aligned(sizeof(struct sr_dev_driver *)))) \
307 = { \
308 __VA_ARGS__ \
309 };
310
311/**
312 * Register a hardware driver.
313 *
314 * This macro is used to register a hardware driver with the library. It has
315 * to be used in order to make the driver accessible to applications using the
316 * library.
317 *
318 * The macro invocation should be placed directly under the struct
319 * sr_dev_driver definition.
320 *
321 * Example:
322 * @code{c}
323 * static struct sr_dev_driver driver_info = {
324 * .name = "driver",
325 * ....
326 * };
327 * SR_REGISTER_DEV_DRIVER(driver_info);
328 * @endcode
329 *
330 * @param name Identifier name of sr_dev_driver struct to register.
331 */
332#define SR_REGISTER_DEV_DRIVER(name) \
333 SR_REGISTER_DEV_DRIVER_LIST(name##_list, &name);
334
5d8b3913
AJ
335SR_PRIV void sr_drivers_init(struct sr_context *context);
336
b8072700 337struct sr_context {
032da34b 338 struct sr_dev_driver **driver_list;
785b9ff2
PS
339#ifdef HAVE_LIBUSB_1_0
340 libusb_context *libusb_ctx;
341#endif
bee24666
DE
342 sr_resource_open_callback resource_open_cb;
343 sr_resource_close_callback resource_close_cb;
344 sr_resource_read_callback resource_read_cb;
345 void *resource_cb_data;
b8072700
PS
346};
347
20e88821
BV
348/** Input module metadata keys. */
349enum sr_input_meta_keys {
350 /** The input filename, if there is one. */
351 SR_INPUT_META_FILENAME = 0x01,
352 /** The input file's size in bytes. */
353 SR_INPUT_META_FILESIZE = 0x02,
354 /** The first 128 bytes of the file, provided as a GString. */
355 SR_INPUT_META_HEADER = 0x04,
20e88821
BV
356
357 /** The module cannot identify a file without this metadata. */
358 SR_INPUT_META_REQUIRED = 0x80,
359};
360
d514d35d
BV
361/** Input (file) module struct. */
362struct sr_input {
363 /**
364 * A pointer to this input module's 'struct sr_input_module'.
d514d35d 365 */
17bfaca6
BV
366 const struct sr_input_module *module;
367 GString *buf;
d514d35d 368 struct sr_dev_inst *sdi;
d0181813 369 gboolean sdi_ready;
17bfaca6 370 void *priv;
d514d35d
BV
371};
372
373/** Input (file) module driver. */
374struct sr_input_module {
17bfaca6 375 /**
d65fcbcd 376 * A unique ID for this input module, suitable for use in command-line
17bfaca6
BV
377 * clients, [a-z0-9-]. Must not be NULL.
378 */
379 const char *id;
d514d35d
BV
380
381 /**
d65fcbcd 382 * A unique name for this input module, suitable for use in GUI
17bfaca6 383 * clients, can contain UTF-8. Must not be NULL.
d514d35d 384 */
17bfaca6 385 const char *name;
d514d35d
BV
386
387 /**
d65fcbcd 388 * A short description of the input module. Must not be NULL.
d514d35d 389 *
d65fcbcd 390 * This can be displayed by frontends, e.g. when selecting the input
17bfaca6
BV
391 * module for saving a file.
392 */
393 const char *desc;
394
c7bc82ff
JH
395 /**
396 * A NULL terminated array of strings containing a list of file name
397 * extensions typical for the input file format, or NULL if there is
398 * no typical extension for this file format.
399 */
400 const char *const *exts;
401
17bfaca6
BV
402 /**
403 * Zero-terminated list of metadata items the module needs to be able
404 * to identify an input stream. Can be all-zero, if the module cannot
405 * identify streams at all, i.e. has to be forced into use.
406 *
407 * Each item is one of:
408 * SR_INPUT_META_FILENAME
409 * SR_INPUT_META_FILESIZE
410 * SR_INPUT_META_HEADER
17bfaca6
BV
411 *
412 * If the high bit (SR_INPUT META_REQUIRED) is set, the module cannot
413 * identify a stream without the given metadata.
414 */
415 const uint8_t metadata[8];
416
417 /**
418 * Returns a NULL-terminated list of options this module can take.
419 * Can be NULL, if the module has no options.
420 */
2c240774 421 const struct sr_option *(*options) (void);
17bfaca6
BV
422
423 /**
424 * Check if this input module can load and parse the specified stream.
425 *
426 * @param[in] metadata Metadata the module can use to identify the stream.
d514d35d 427 *
4f979115 428 * @retval SR_OK This module knows the format.
753793ef 429 * @retval SR_ERR_NA There wasn't enough data for this module to
4f979115
BV
430 * positively identify the format.
431 * @retval SR_ERR_DATA This module knows the format, but cannot handle it.
432 * This means the stream is either corrupt, or indicates a feature
433 * that the module does not support.
434 * @retval SR_ERR This module does not know the format.
d514d35d 435 */
17bfaca6 436 int (*format_match) (GHashTable *metadata);
d514d35d
BV
437
438 /**
439 * Initialize the input module.
440 *
d514d35d
BV
441 * @retval SR_OK Success
442 * @retval other Negative error code.
443 */
17bfaca6 444 int (*init) (struct sr_input *in, GHashTable *options);
d514d35d
BV
445
446 /**
753793ef 447 * Send data to the specified input instance.
d514d35d 448 *
753793ef
BV
449 * When an input module instance is created with sr_input_new(), this
450 * function is used to feed data to the instance.
d514d35d 451 *
753793ef
BV
452 * As enough data gets fed into this function to completely populate
453 * the device instance associated with this input instance, this is
454 * guaranteed to return the moment it's ready. This gives the caller
455 * the chance to examine the device instance, attach session callbacks
456 * and so on.
17bfaca6
BV
457 *
458 * @retval SR_OK Success
459 * @retval other Negative error code.
460 */
d0181813 461 int (*receive) (struct sr_input *in, GString *buf);
17bfaca6 462
753793ef
BV
463 /**
464 * Signal the input module no more data will come.
465 *
466 * This will cause the module to process any data it may have buffered.
467 * The SR_DF_END packet will also typically be sent at this time.
468 */
7066fd46
BV
469 int (*end) (struct sr_input *in);
470
b6b4f03e
SA
471 /**
472 * Reset the input module's input handling structures.
473 *
474 * Causes the input module to reset its internal state so that we can
475 * re-send the input data from the beginning without having to
476 * re-create the entire input module.
477 *
478 * @retval SR_OK Success.
479 * @retval other Negative error code.
480 */
481 int (*reset) (struct sr_input *in);
482
17bfaca6
BV
483 /**
484 * This function is called after the caller is finished using
485 * the input module, and can be used to free any internal
486 * resources the module may keep.
d514d35d 487 *
753793ef
BV
488 * This function is optional.
489 *
d514d35d
BV
490 * @retval SR_OK Success
491 * @retval other Negative error code.
492 */
d5cc282f 493 void (*cleanup) (struct sr_input *in);
d514d35d
BV
494};
495
a755b0e1
BV
496/** Output module instance. */
497struct sr_output {
498 /** A pointer to this output's module. */
499 const struct sr_output_module *module;
500
501 /**
502 * The device for which this output module is creating output. This
503 * can be used by the module to find out channel names and numbers.
504 */
505 const struct sr_dev_inst *sdi;
506
81b3ce37
SA
507 /**
508 * The name of the file that the data should be written to.
509 */
510 const char *filename;
511
a755b0e1
BV
512 /**
513 * A generic pointer which can be used by the module to keep internal
514 * state between calls into its callback functions.
515 *
516 * For example, the module might store a pointer to a chunk of output
517 * there, and only flush it when it reaches a certain size.
518 */
d686c5ec 519 void *priv;
a755b0e1
BV
520};
521
522/** Output module driver. */
523struct sr_output_module {
524 /**
525 * A unique ID for this output module, suitable for use in command-line
526 * clients, [a-z0-9-]. Must not be NULL.
527 */
2c240774 528 const char *id;
a755b0e1
BV
529
530 /**
531 * A unique name for this output module, suitable for use in GUI
532 * clients, can contain UTF-8. Must not be NULL.
533 */
534 const char *name;
535
536 /**
537 * A short description of the output module. Must not be NULL.
538 *
539 * This can be displayed by frontends, e.g. when selecting the output
540 * module for saving a file.
541 */
2c240774 542 const char *desc;
a755b0e1 543
8a174d23
JH
544 /**
545 * A NULL terminated array of strings containing a list of file name
546 * extensions typical for the input file format, or NULL if there is
547 * no typical extension for this file format.
548 */
549 const char *const *exts;
550
3cd4b381
SA
551 /**
552 * Bitfield containing flags that describe certain properties
553 * this output module may or may not have.
554 * @see sr_output_flags
555 */
556 const uint64_t flags;
557
a755b0e1
BV
558 /**
559 * Returns a NULL-terminated list of options this module can take.
560 * Can be NULL, if the module has no options.
a755b0e1 561 */
af7d656d 562 const struct sr_option *(*options) (void);
a755b0e1
BV
563
564 /**
565 * This function is called once, at the beginning of an output stream.
566 *
567 * The device struct will be available in the output struct passed in,
568 * as well as the param field -- which may be NULL or an empty string,
569 * if no parameter was passed.
570 *
571 * The module can use this to initialize itself, create a struct for
572 * keeping state and storing it in the <code>internal</code> field.
573 *
574 * @param o Pointer to the respective 'struct sr_output'.
575 *
576 * @retval SR_OK Success
577 * @retval other Negative error code.
578 */
579 int (*init) (struct sr_output *o, GHashTable *options);
580
581 /**
f3f19d11 582 * This function is passed a copy of every packet in the data feed.
a755b0e1
BV
583 * Any output generated by the output module in response to the
584 * packet should be returned in a newly allocated GString
585 * <code>out</code>, which will be freed by the caller.
586 *
587 * Packets not of interest to the output module can just be ignored,
588 * and the <code>out</code> parameter set to NULL.
589 *
590 * @param o Pointer to the respective 'struct sr_output'.
591 * @param sdi The device instance that generated the packet.
592 * @param packet The complete packet.
593 * @param out A pointer where a GString * should be stored if
594 * the module generates output, or NULL if not.
595 *
596 * @retval SR_OK Success
597 * @retval other Negative error code.
598 */
599 int (*receive) (const struct sr_output *o,
600 const struct sr_datafeed_packet *packet, GString **out);
601
602 /**
603 * This function is called after the caller is finished using
604 * the output module, and can be used to free any internal
605 * resources the module may keep.
606 *
607 * @retval SR_OK Success
608 * @retval other Negative error code.
609 */
610 int (*cleanup) (struct sr_output *o);
611};
612
790320f6
UH
613/** Transform module instance. */
614struct sr_transform {
615 /** A pointer to this transform's module. */
616 const struct sr_transform_module *module;
617
618 /**
619 * The device for which this transform module is used. This
620 * can be used by the module to find out channel names and numbers.
621 */
622 const struct sr_dev_inst *sdi;
623
624 /**
625 * A generic pointer which can be used by the module to keep internal
626 * state between calls into its callback functions.
627 */
628 void *priv;
629};
630
631struct sr_transform_module {
632 /**
633 * A unique ID for this transform module, suitable for use in
634 * command-line clients, [a-z0-9-]. Must not be NULL.
635 */
2c240774 636 const char *id;
790320f6
UH
637
638 /**
639 * A unique name for this transform module, suitable for use in GUI
640 * clients, can contain UTF-8. Must not be NULL.
641 */
642 const char *name;
643
644 /**
645 * A short description of the transform module. Must not be NULL.
646 *
647 * This can be displayed by frontends, e.g. when selecting
648 * which transform module(s) to add.
649 */
2c240774 650 const char *desc;
790320f6
UH
651
652 /**
653 * Returns a NULL-terminated list of options this transform module
654 * can take. Can be NULL, if the transform module has no options.
655 */
656 const struct sr_option *(*options) (void);
657
658 /**
659 * This function is called once, at the beginning of a stream.
660 *
661 * @param t Pointer to the respective 'struct sr_transform'.
662 * @param options Hash table of options for this transform module.
663 * Can be NULL if no options are to be used.
664 *
665 * @retval SR_OK Success
666 * @retval other Negative error code.
667 */
668 int (*init) (struct sr_transform *t, GHashTable *options);
669
670 /**
671 * This function is passed a pointer to every packet in the data feed.
672 *
673 * It can either return (in packet_out) a pointer to another packet
674 * (possibly the exact same packet it got as input), or NULL.
675 *
676 * @param t Pointer to the respective 'struct sr_transform'.
677 * @param packet_in Pointer to a datafeed packet.
678 * @param packet_out Pointer to the resulting datafeed packet after
679 * this function was run. If NULL, the transform
680 * module intentionally didn't output a new packet.
681 *
682 * @retval SR_OK Success
683 * @retval other Negative error code.
684 */
685 int (*receive) (const struct sr_transform *t,
686 struct sr_datafeed_packet *packet_in,
687 struct sr_datafeed_packet **packet_out);
688
689 /**
690 * This function is called after the caller is finished using
691 * the transform module, and can be used to free any internal
692 * resources the module may keep.
693 *
694 * @retval SR_OK Success
695 * @retval other Negative error code.
696 */
697 int (*cleanup) (struct sr_transform *t);
698};
699
69890f73 700#ifdef HAVE_LIBUSB_1_0
04cb9157 701/** USB device instance */
d68e2d1a 702struct sr_usb_dev_inst {
98582bf5
BV
703 /** USB bus */
704 uint8_t bus;
705 /** Device address on USB bus */
706 uint8_t address;
707 /** libusb device handle */
708 struct libusb_device_handle *devhdl;
69890f73
UH
709};
710#endif
711
c4f2dfd0 712#ifdef HAVE_LIBSERIALPORT
d68e2d1a 713struct sr_serial_dev_inst {
98582bf5
BV
714 /** Port name, e.g. '/dev/tty42'. */
715 char *port;
716 /** Comm params for serial_set_paramstr(). */
717 char *serialcomm;
98582bf5
BV
718 /** libserialport port handle */
719 struct sp_port *data;
69890f73 720};
c4f2dfd0 721#endif
69890f73 722
ae67644f
ML
723struct sr_usbtmc_dev_inst {
724 char *device;
725 int fd;
726};
727
026c822d
UH
728/* Private driver context. */
729struct drv_context {
98582bf5
BV
730 /** sigrok context */
731 struct sr_context *sr_ctx;
026c822d
UH
732 GSList *instances;
733};
734
48a486cd
BV
735/*--- log.c -----------------------------------------------------------------*/
736
7419638d
DE
737#if defined(G_OS_WIN32) && (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 4))
738/*
739 * On MinGW, we need to specify the gnu_printf format flavor or GCC
740 * will assume non-standard Microsoft printf syntax.
741 */
742SR_PRIV int sr_log(int loglevel, const char *format, ...)
743 __attribute__((__format__ (__gnu_printf__, 2, 3)));
744#else
be92d5b4 745SR_PRIV int sr_log(int loglevel, const char *format, ...) G_GNUC_PRINTF(2, 3);
7419638d 746#endif
48a486cd 747
3544f848 748/* Message logging helpers with subsystem-specific prefix string. */
be92d5b4
DE
749#define sr_spew(...) sr_log(SR_LOG_SPEW, LOG_PREFIX ": " __VA_ARGS__)
750#define sr_dbg(...) sr_log(SR_LOG_DBG, LOG_PREFIX ": " __VA_ARGS__)
751#define sr_info(...) sr_log(SR_LOG_INFO, LOG_PREFIX ": " __VA_ARGS__)
752#define sr_warn(...) sr_log(SR_LOG_WARN, LOG_PREFIX ": " __VA_ARGS__)
753#define sr_err(...) sr_log(SR_LOG_ERR, LOG_PREFIX ": " __VA_ARGS__)
3544f848 754
48a486cd
BV
755/*--- device.c --------------------------------------------------------------*/
756
cffdc3e6
ML
757/** Scan options supported by a driver. */
758#define SR_CONF_SCAN_OPTIONS 0x7FFF0000
759
760/** Device options for a particular device. */
761#define SR_CONF_DEVICE_OPTIONS 0x7FFF0001
762
e318f01b
ML
763/** Mask for separating config keys from capabilities. */
764#define SR_CONF_MASK 0x1fffffff
765
f3ca73ed 766/** Values for the changes argument of sr_dev_driver.config_channel_set. */
2a854d71 767enum {
fca75cbb 768 /** The enabled state of the channel has been changed. */
3f239f08 769 SR_CHANNEL_SET_ENABLED = 1 << 0,
2a854d71
DE
770};
771
5e23fcab
ML
772SR_PRIV struct sr_channel *sr_channel_new(struct sr_dev_inst *sdi,
773 int index, int type, gboolean enabled, const char *name);
9c24d16a
BV
774SR_PRIV struct sr_channel *sr_next_enabled_channel(const struct sr_dev_inst *sdi,
775 struct sr_channel *cur_channel);
48a486cd 776
96727ef0
UH
777/** Device instance data */
778struct sr_dev_inst {
779 /** Device driver. */
780 struct sr_dev_driver *driver;
781 /** Device instance status. SR_ST_NOT_FOUND, etc. */
782 int status;
783 /** Device instance type. SR_INST_USB, etc. */
784 int inst_type;
785 /** Device vendor. */
786 char *vendor;
787 /** Device model. */
788 char *model;
789 /** Device version. */
790 char *version;
791 /** Serial number. */
792 char *serial_num;
793 /** Connection string to uniquely identify devices. */
794 char *connection_id;
795 /** List of channels. */
796 GSList *channels;
797 /** List of sr_channel_group structs */
798 GSList *channel_groups;
799 /** Device instance connection data (used?) */
800 void *conn;
801 /** Device instance private data (used?) */
802 void *priv;
803 /** Session to which this device is currently assigned. */
804 struct sr_session *session;
805};
806
48a486cd 807/* Generic device instances */
48a486cd 808SR_PRIV void sr_dev_inst_free(struct sr_dev_inst *sdi);
48a486cd 809
545f9786 810#ifdef HAVE_LIBUSB_1_0
69890f73 811/* USB-specific instances */
d68e2d1a 812SR_PRIV struct sr_usb_dev_inst *sr_usb_dev_inst_new(uint8_t bus,
69890f73 813 uint8_t address, struct libusb_device_handle *hdl);
d68e2d1a 814SR_PRIV void sr_usb_dev_inst_free(struct sr_usb_dev_inst *usb);
69890f73
UH
815#endif
816
c4f2dfd0 817#ifdef HAVE_LIBSERIALPORT
69890f73 818/* Serial-specific instances */
299bdb24
BV
819SR_PRIV struct sr_serial_dev_inst *sr_serial_dev_inst_new(const char *port,
820 const char *serialcomm);
d68e2d1a 821SR_PRIV void sr_serial_dev_inst_free(struct sr_serial_dev_inst *serial);
c4f2dfd0 822#endif
69890f73 823
ae67644f
ML
824/* USBTMC-specific instances */
825SR_PRIV struct sr_usbtmc_dev_inst *sr_usbtmc_dev_inst_new(const char *device);
826SR_PRIV void sr_usbtmc_dev_inst_free(struct sr_usbtmc_dev_inst *usbtmc);
b08024a8 827
c09f0b57 828/*--- hwdriver.c ------------------------------------------------------------*/
996b0c72 829
13fef1ed 830SR_PRIV const GVariantType *sr_variant_type_get(int datatype);
584560f1 831SR_PRIV int sr_variant_type_check(uint32_t key, GVariant *data);
032da34b 832SR_PRIV void sr_hw_cleanup_all(const struct sr_context *ctx);
584560f1 833SR_PRIV struct sr_config *sr_config_new(uint32_t key, GVariant *data);
722db131 834SR_PRIV void sr_config_free(struct sr_config *src);
996b0c72 835
a1645fcd
BV
836/*--- session.c -------------------------------------------------------------*/
837
e2b23821 838struct sr_session {
4ed5d21d
ML
839 /** Context this session exists in. */
840 struct sr_context *ctx;
c0e3ba4b 841 /** List of struct sr_dev_inst pointers. */
e2b23821 842 GSList *devs;
1de3cced
ML
843 /** List of struct sr_dev_inst pointers owned by this session. */
844 GSList *owned_devs;
e2b23821
UH
845 /** List of struct datafeed_callback pointers. */
846 GSList *datafeed_callbacks;
c0a1e532 847 GSList *transforms;
7b5e6d29 848 struct sr_trigger *trigger;
62d7945f 849
5de0fc55
DE
850 /** Callback to invoke on session stop. */
851 sr_session_stopped_callback stopped_callback;
852 /** User data to be passed to the session stop callback. */
853 void *stopped_cb_data;
854
2e5e3df4 855 /** Mutex protecting the main context pointer. */
c2bf5506
DE
856 GMutex main_mutex;
857 /** Context of the session main loop. */
858 GMainContext *main_context;
e2b23821 859
c2bf5506
DE
860 /** Registered event sources for this session. */
861 GHashTable *event_sources;
862 /** Session main loop. */
863 GMainLoop *main_loop;
5de0fc55
DE
864 /** ID of idle source for dispatching the session stop notification. */
865 unsigned int stop_check_id;
2e5e3df4
DE
866 /** Whether the session has been started. */
867 gboolean running;
e2b23821
UH
868};
869
62d7945f 870SR_PRIV int sr_session_source_add_internal(struct sr_session *session,
c2bf5506 871 void *key, GSource *source);
92248e78 872SR_PRIV int sr_session_source_remove_internal(struct sr_session *session,
c2bf5506
DE
873 void *key);
874SR_PRIV int sr_session_source_destroyed(struct sr_session *session,
875 void *key, GSource *source);
cbc1413f
DE
876SR_PRIV int sr_session_fd_source_add(struct sr_session *session,
877 void *key, gintptr fd, int events, int timeout,
878 sr_receive_data_callback cb, void *cb_data);
ee9953ef
DE
879
880SR_PRIV int sr_session_source_add(struct sr_session *session, int fd,
881 int events, int timeout, sr_receive_data_callback cb, void *cb_data);
882SR_PRIV int sr_session_source_add_pollfd(struct sr_session *session,
883 GPollFD *pollfd, int timeout, sr_receive_data_callback cb,
884 void *cb_data);
885SR_PRIV int sr_session_source_add_channel(struct sr_session *session,
886 GIOChannel *channel, int events, int timeout,
887 sr_receive_data_callback cb, void *cb_data);
888SR_PRIV int sr_session_source_remove(struct sr_session *session, int fd);
889SR_PRIV int sr_session_source_remove_pollfd(struct sr_session *session,
890 GPollFD *pollfd);
891SR_PRIV int sr_session_source_remove_channel(struct sr_session *session,
892 GIOChannel *channel);
893
de4d3f99 894SR_PRIV int sr_session_send(const struct sr_dev_inst *sdi,
ae5859ff 895 const struct sr_datafeed_packet *packet);
f438e0c9 896SR_PRIV int sr_sessionfile_check(const char *filename);
7c69b528
SA
897SR_PRIV struct sr_dev_inst *sr_session_prepare_sdi(const char *filename,
898 struct sr_session **session);
8143cfdc
BV
899SR_PRIV int sr_packet_copy(const struct sr_datafeed_packet *packet,
900 struct sr_datafeed_packet **copy);
901SR_PRIV void sr_packet_free(struct sr_datafeed_packet *packet);
a1645fcd 902
98654c99
DE
903/*--- session_file.c --------------------------------------------------------*/
904
a6dc3dac
DE
905#if !HAVE_ZIP_DISCARD
906/* Replace zip_discard() if not available. */
907#define zip_discard(zip) sr_zip_discard(zip)
908SR_PRIV void sr_zip_discard(struct zip *archive);
909#endif
910
98654c99
DE
911SR_PRIV GKeyFile *sr_sessionfile_read_metadata(struct zip *archive,
912 const struct zip_stat *entry);
913
41caa319
AJ
914/*--- analog.c --------------------------------------------------------------*/
915
edb691fc 916SR_PRIV int sr_analog_init(struct sr_datafeed_analog *analog,
41caa319
AJ
917 struct sr_analog_encoding *encoding,
918 struct sr_analog_meaning *meaning,
919 struct sr_analog_spec *spec,
920 int digits);
921
063e7aef
UH
922/*--- std.c -----------------------------------------------------------------*/
923
144f6660
UH
924typedef int (*dev_close_callback)(struct sr_dev_inst *sdi);
925typedef void (*std_dev_clear_callback)(void *priv);
cd2f0fe2 926
c45c32ce 927SR_PRIV int std_init(struct sr_dev_driver *di, struct sr_context *sr_ctx);
700d6b64 928SR_PRIV int std_cleanup(const struct sr_dev_driver *di);
c4f2dfd0 929#ifdef HAVE_LIBSERIALPORT
23dc6661 930SR_PRIV int std_serial_dev_open(struct sr_dev_inst *sdi);
1b38775b 931SR_PRIV int std_serial_dev_acquisition_stop(struct sr_dev_inst *sdi);
c4f2dfd0 932#endif
bee2b016
LPC
933SR_PRIV int std_session_send_df_header(const struct sr_dev_inst *sdi);
934SR_PRIV int std_session_send_df_end(const struct sr_dev_inst *sdi);
ae5859ff 935SR_PRIV int std_dev_clear(const struct sr_dev_driver *driver,
144f6660 936 std_dev_clear_callback clear_private);
c01bf34c 937SR_PRIV GSList *std_dev_list(const struct sr_dev_driver *di);
043e899a 938SR_PRIV int std_serial_dev_close(struct sr_dev_inst *sdi);
15a5bfe4 939SR_PRIV GSList *std_scan_complete(struct sr_dev_driver *di, GSList *devices);
4afdfd46 940
bee24666
DE
941/*--- resource.c ------------------------------------------------------------*/
942
7d89fd60
DE
943SR_PRIV int64_t sr_file_get_size(FILE *file);
944
bee24666
DE
945SR_PRIV int sr_resource_open(struct sr_context *ctx,
946 struct sr_resource *res, int type, const char *name)
947 G_GNUC_WARN_UNUSED_RESULT;
948SR_PRIV int sr_resource_close(struct sr_context *ctx,
949 struct sr_resource *res);
32ba0d80 950SR_PRIV gssize sr_resource_read(struct sr_context *ctx,
bee24666
DE
951 const struct sr_resource *res, void *buf, size_t count)
952 G_GNUC_WARN_UNUSED_RESULT;
953SR_PRIV void *sr_resource_load(struct sr_context *ctx, int type,
954 const char *name, size_t *size, size_t max_size)
955 G_GNUC_MALLOC G_GNUC_WARN_UNUSED_RESULT;
956
8d558c7a
UH
957/*--- strutil.c -------------------------------------------------------------*/
958
959SR_PRIV int sr_atol(const char *str, long *ret);
960SR_PRIV int sr_atoi(const char *str, int *ret);
961SR_PRIV int sr_atod(const char *str, double *ret);
962SR_PRIV int sr_atof(const char *str, float *ret);
9806c2d5 963SR_PRIV int sr_atof_ascii(const char *str, float *ret);
8d558c7a 964
ac136b57
BV
965/*--- soft-trigger.c --------------------------------------------------------*/
966
967struct soft_trigger_logic {
968 const struct sr_dev_inst *sdi;
969 const struct sr_trigger *trigger;
970 int count;
971 int unitsize;
972 int cur_stage;
973 uint8_t *prev_sample;
fe5a7355
AJ
974 uint8_t *pre_trigger_buffer;
975 uint8_t *pre_trigger_head;
976 int pre_trigger_size;
977 int pre_trigger_fill;
ac136b57
BV
978};
979
980SR_PRIV struct soft_trigger_logic *soft_trigger_logic_new(
fe5a7355
AJ
981 const struct sr_dev_inst *sdi, struct sr_trigger *trigger,
982 int pre_trigger_samples);
ac136b57
BV
983SR_PRIV void soft_trigger_logic_free(struct soft_trigger_logic *st);
984SR_PRIV int soft_trigger_logic_check(struct soft_trigger_logic *st, uint8_t *buf,
fe5a7355 985 int len, int *pre_trigger_samples);
ac136b57 986
3ea46116 987/*--- hardware/serial.c -----------------------------------------------------*/
058b7035 988
c4f2dfd0 989#ifdef HAVE_LIBSERIALPORT
a54dd31e
UH
990enum {
991 SERIAL_RDWR = 1,
992 SERIAL_RDONLY = 2,
a54dd31e
UH
993};
994
144f6660 995typedef gboolean (*packet_valid_callback)(const uint8_t *buf);
766456be 996
299bdb24
BV
997SR_PRIV int serial_open(struct sr_serial_dev_inst *serial, int flags);
998SR_PRIV int serial_close(struct sr_serial_dev_inst *serial);
999SR_PRIV int serial_flush(struct sr_serial_dev_inst *serial);
bce75f94 1000SR_PRIV int serial_drain(struct sr_serial_dev_inst *serial);
9a474211 1001SR_PRIV int serial_write_blocking(struct sr_serial_dev_inst *serial,
eead2782 1002 const void *buf, size_t count, unsigned int timeout_ms);
9a474211
ML
1003SR_PRIV int serial_write_nonblocking(struct sr_serial_dev_inst *serial,
1004 const void *buf, size_t count);
9a474211 1005SR_PRIV int serial_read_blocking(struct sr_serial_dev_inst *serial, void *buf,
eead2782 1006 size_t count, unsigned int timeout_ms);
9a474211
ML
1007SR_PRIV int serial_read_nonblocking(struct sr_serial_dev_inst *serial, void *buf,
1008 size_t count);
299bdb24 1009SR_PRIV int serial_set_params(struct sr_serial_dev_inst *serial, int baudrate,
71caaad4 1010 int bits, int parity, int stopbits, int flowcontrol, int rts, int dtr);
299bdb24
BV
1011SR_PRIV int serial_set_paramstr(struct sr_serial_dev_inst *serial,
1012 const char *paramstr);
1013SR_PRIV int serial_readline(struct sr_serial_dev_inst *serial, char **buf,
1014 int *buflen, gint64 timeout_ms);
766456be
UH
1015SR_PRIV int serial_stream_detect(struct sr_serial_dev_inst *serial,
1016 uint8_t *buf, size_t *buflen,
144f6660
UH
1017 size_t packet_size,
1018 packet_valid_callback is_valid,
766456be 1019 uint64_t timeout_ms, int baudrate);
1bd9e678
DJ
1020SR_PRIV int sr_serial_extract_options(GSList *options, const char **serial_device,
1021 const char **serial_options);
102f1239
BV
1022SR_PRIV int serial_source_add(struct sr_session *session,
1023 struct sr_serial_dev_inst *serial, int events, int timeout,
1024 sr_receive_data_callback cb, void *cb_data);
1025SR_PRIV int serial_source_remove(struct sr_session *session,
1026 struct sr_serial_dev_inst *serial);
b541f837 1027SR_PRIV GSList *sr_serial_find_usb(uint16_t vendor_id, uint16_t product_id);
c5cfc735 1028SR_PRIV int serial_timeout(struct sr_serial_dev_inst *port, int num_bytes);
c4f2dfd0 1029#endif
1483577e 1030
3ea46116 1031/*--- hardware/ezusb.c ------------------------------------------------------*/
058b7035 1032
22b02383 1033#ifdef HAVE_LIBUSB_1_0
1a081ca6 1034SR_PRIV int ezusb_reset(struct libusb_device_handle *hdl, int set_clear);
8e2d6c9d
DE
1035SR_PRIV int ezusb_install_firmware(struct sr_context *ctx, libusb_device_handle *hdl,
1036 const char *name);
1037SR_PRIV int ezusb_upload_firmware(struct sr_context *ctx, libusb_device *dev,
1038 int configuration, const char *name);
22b02383 1039#endif
058b7035 1040
3ea46116 1041/*--- hardware/usb.c --------------------------------------------------------*/
0c632d36
UH
1042
1043#ifdef HAVE_LIBUSB_1_0
7ae6a758 1044SR_PRIV GSList *sr_usb_find(libusb_context *usb_ctx, const char *conn);
0c632d36 1045SR_PRIV int sr_usb_open(libusb_context *usb_ctx, struct sr_usb_dev_inst *usb);
67e95ed3 1046SR_PRIV void sr_usb_close(struct sr_usb_dev_inst *usb);
102f1239
BV
1047SR_PRIV int usb_source_add(struct sr_session *session, struct sr_context *ctx,
1048 int timeout, sr_receive_data_callback cb, void *cb_data);
1049SR_PRIV int usb_source_remove(struct sr_session *session, struct sr_context *ctx);
76bc5f63 1050SR_PRIV int usb_get_port_path(libusb_device *dev, char *path, int path_len);
0c632d36
UH
1051#endif
1052
7b9d7320 1053
daa39012
AJ
1054/*--- modbus/modbus.c -------------------------------------------------------*/
1055
1056struct sr_modbus_dev_inst {
1057 const char *name;
1058 const char *prefix;
1059 int priv_size;
1060 GSList *(*scan)(int modbusaddr);
1061 int (*dev_inst_new)(void *priv, const char *resource,
1062 char **params, const char *serialcomm, int modbusaddr);
1063 int (*open)(void *priv);
1064 int (*source_add)(struct sr_session *session, void *priv, int events,
1065 int timeout, sr_receive_data_callback cb, void *cb_data);
1066 int (*source_remove)(struct sr_session *session, void *priv);
1067 int (*send)(void *priv, const uint8_t *buffer, int buffer_size);
1068 int (*read_begin)(void *priv, uint8_t *function_code);
1069 int (*read_data)(void *priv, uint8_t *buf, int maxlen);
1070 int (*read_end)(void *priv);
1071 int (*close)(void *priv);
1072 void (*free)(void *priv);
1073 unsigned int read_timeout_ms;
1074 void *priv;
1075};
1076
1077SR_PRIV GSList *sr_modbus_scan(struct drv_context *drvc, GSList *options,
1078 struct sr_dev_inst *(*probe_device)(struct sr_modbus_dev_inst *modbus));
1079SR_PRIV struct sr_modbus_dev_inst *modbus_dev_inst_new(const char *resource,
1080 const char *serialcomm, int modbusaddr);
1081SR_PRIV int sr_modbus_open(struct sr_modbus_dev_inst *modbus);
1082SR_PRIV int sr_modbus_source_add(struct sr_session *session,
1083 struct sr_modbus_dev_inst *modbus, int events, int timeout,
1084 sr_receive_data_callback cb, void *cb_data);
1085SR_PRIV int sr_modbus_source_remove(struct sr_session *session,
1086 struct sr_modbus_dev_inst *modbus);
1087SR_PRIV int sr_modbus_request(struct sr_modbus_dev_inst *modbus,
1088 uint8_t *request, int request_size);
1089SR_PRIV int sr_modbus_reply(struct sr_modbus_dev_inst *modbus,
1090 uint8_t *reply, int reply_size);
1091SR_PRIV int sr_modbus_request_reply(struct sr_modbus_dev_inst *modbus,
1092 uint8_t *request, int request_size,
1093 uint8_t *reply, int reply_size);
1094SR_PRIV int sr_modbus_read_coils(struct sr_modbus_dev_inst *modbus,
1095 int address, int nb_coils, uint8_t *coils);
1096SR_PRIV int sr_modbus_read_holding_registers(struct sr_modbus_dev_inst *modbus,
1097 int address, int nb_registers,
1098 uint16_t *registers);
1099SR_PRIV int sr_modbus_write_coil(struct sr_modbus_dev_inst *modbus,
1100 int address, int value);
1101SR_PRIV int sr_modbus_write_multiple_registers(struct sr_modbus_dev_inst*modbus,
1102 int address, int nb_registers,
1103 uint16_t *registers);
1104SR_PRIV int sr_modbus_close(struct sr_modbus_dev_inst *modbus);
1105SR_PRIV void sr_modbus_free(struct sr_modbus_dev_inst *modbus);
1106
3ea46116 1107/*--- hardware/dmm/es519xx.c ------------------------------------------------*/
c01bdebc 1108
bfb926c1
AJ
1109/**
1110 * All 11-byte es519xx chips repeat each block twice for each conversion cycle
1111 * so always read 2 blocks at a time.
1112 */
1113#define ES519XX_11B_PACKET_SIZE (11 * 2)
72e1672f 1114#define ES519XX_14B_PACKET_SIZE 14
c01bdebc
AJ
1115
1116struct es519xx_info {
1117 gboolean is_judge, is_voltage, is_auto, is_micro, is_current;
1118 gboolean is_milli, is_resistance, is_continuity, is_diode;
1119 gboolean is_frequency, is_rpm, is_capacitance, is_duty_cycle;
1120 gboolean is_temperature, is_celsius, is_fahrenheit;
1121 gboolean is_adp0, is_adp1, is_adp2, is_adp3;
1122 gboolean is_sign, is_batt, is_ol, is_pmax, is_pmin, is_apo;
1123 gboolean is_dc, is_ac, is_vahz, is_min, is_max, is_rel, is_hold;
1124 gboolean is_digit4, is_ul, is_vasel, is_vbar, is_lpf1, is_lpf0, is_rmr;
1125 uint32_t baudrate;
1126 int packet_size;
1127 gboolean alt_functions, fivedigits, clampmeter, selectable_lpf;
1128};
1129
72e1672f
UH
1130SR_PRIV gboolean sr_es519xx_2400_11b_packet_valid(const uint8_t *buf);
1131SR_PRIV int sr_es519xx_2400_11b_parse(const uint8_t *buf, float *floatval,
8c677240 1132 struct sr_datafeed_analog *analog, void *info);
2588e50c
AJ
1133SR_PRIV gboolean sr_es519xx_2400_11b_altfn_packet_valid(const uint8_t *buf);
1134SR_PRIV int sr_es519xx_2400_11b_altfn_parse(const uint8_t *buf,
8c677240 1135 float *floatval, struct sr_datafeed_analog *analog, void *info);
72e1672f 1136SR_PRIV gboolean sr_es519xx_19200_11b_5digits_packet_valid(const uint8_t *buf);
93d719cd 1137SR_PRIV int sr_es519xx_19200_11b_5digits_parse(const uint8_t *buf,
8c677240 1138 float *floatval, struct sr_datafeed_analog *analog, void *info);
72e1672f
UH
1139SR_PRIV gboolean sr_es519xx_19200_11b_clamp_packet_valid(const uint8_t *buf);
1140SR_PRIV int sr_es519xx_19200_11b_clamp_parse(const uint8_t *buf,
8c677240 1141 float *floatval, struct sr_datafeed_analog *analog, void *info);
72e1672f
UH
1142SR_PRIV gboolean sr_es519xx_19200_11b_packet_valid(const uint8_t *buf);
1143SR_PRIV int sr_es519xx_19200_11b_parse(const uint8_t *buf, float *floatval,
8c677240 1144 struct sr_datafeed_analog *analog, void *info);
72e1672f
UH
1145SR_PRIV gboolean sr_es519xx_19200_14b_packet_valid(const uint8_t *buf);
1146SR_PRIV int sr_es519xx_19200_14b_parse(const uint8_t *buf, float *floatval,
8c677240 1147 struct sr_datafeed_analog *analog, void *info);
72e1672f
UH
1148SR_PRIV gboolean sr_es519xx_19200_14b_sel_lpf_packet_valid(const uint8_t *buf);
1149SR_PRIV int sr_es519xx_19200_14b_sel_lpf_parse(const uint8_t *buf,
8c677240 1150 float *floatval, struct sr_datafeed_analog *analog, void *info);
c01bdebc 1151
3ea46116 1152/*--- hardware/dmm/fs9922.c -------------------------------------------------*/
79081ec8 1153
913abe83
UH
1154#define FS9922_PACKET_SIZE 14
1155
1156struct fs9922_info {
1157 gboolean is_auto, is_dc, is_ac, is_rel, is_hold, is_bpn, is_z1, is_z2;
1158 gboolean is_max, is_min, is_apo, is_bat, is_nano, is_z3, is_micro;
1159 gboolean is_milli, is_kilo, is_mega, is_beep, is_diode, is_percent;
1160 gboolean is_z4, is_volt, is_ampere, is_ohm, is_hfe, is_hertz, is_farad;
1161 gboolean is_celsius, is_fahrenheit;
1162 int bargraph_sign, bargraph_value;
1163};
1164
913abe83
UH
1165SR_PRIV gboolean sr_fs9922_packet_valid(const uint8_t *buf);
1166SR_PRIV int sr_fs9922_parse(const uint8_t *buf, float *floatval,
8c677240
UH
1167 struct sr_datafeed_analog *analog, void *info);
1168SR_PRIV void sr_fs9922_z1_diode(struct sr_datafeed_analog *analog, void *info);
79081ec8 1169
3ea46116 1170/*--- hardware/dmm/fs9721.c -------------------------------------------------*/
6c701476 1171
8c1adf37
UH
1172#define FS9721_PACKET_SIZE 14
1173
1174struct fs9721_info {
1175 gboolean is_ac, is_dc, is_auto, is_rs232, is_micro, is_nano, is_kilo;
1176 gboolean is_diode, is_milli, is_percent, is_mega, is_beep, is_farad;
1177 gboolean is_ohm, is_rel, is_hold, is_ampere, is_volt, is_hz, is_bat;
1178 gboolean is_c2c1_11, is_c2c1_10, is_c2c1_01, is_c2c1_00, is_sign;
1179};
1180
8c1adf37
UH
1181SR_PRIV gboolean sr_fs9721_packet_valid(const uint8_t *buf);
1182SR_PRIV int sr_fs9721_parse(const uint8_t *buf, float *floatval,
8c677240
UH
1183 struct sr_datafeed_analog *analog, void *info);
1184SR_PRIV void sr_fs9721_00_temp_c(struct sr_datafeed_analog *analog, void *info);
1185SR_PRIV void sr_fs9721_01_temp_c(struct sr_datafeed_analog *analog, void *info);
1186SR_PRIV void sr_fs9721_10_temp_c(struct sr_datafeed_analog *analog, void *info);
1187SR_PRIV void sr_fs9721_01_10_temp_f_c(struct sr_datafeed_analog *analog, void *info);
1188SR_PRIV void sr_fs9721_max_c_min(struct sr_datafeed_analog *analog, void *info);
6c701476 1189
eed3dec8
MG
1190/*--- hardware/dmm/dtm0660.c ------------------------------------------------*/
1191
1192#define DTM0660_PACKET_SIZE 15
1193
1194struct dtm0660_info {
1195 gboolean is_ac, is_dc, is_auto, is_rs232, is_micro, is_nano, is_kilo;
1196 gboolean is_diode, is_milli, is_percent, is_mega, is_beep, is_farad;
1197 gboolean is_ohm, is_rel, is_hold, is_ampere, is_volt, is_hz, is_bat;
1198 gboolean is_degf, is_degc, is_c2c1_01, is_c2c1_00, is_apo, is_min;
1199 gboolean is_minmax, is_max, is_sign;
1200};
1201
1202SR_PRIV gboolean sr_dtm0660_packet_valid(const uint8_t *buf);
1203SR_PRIV int sr_dtm0660_parse(const uint8_t *buf, float *floatval,
8c677240 1204 struct sr_datafeed_analog *analog, void *info);
eed3dec8 1205
3ea46116 1206/*--- hardware/dmm/m2110.c --------------------------------------------------*/
825da8b2
MH
1207
1208#define BBCGM_M2110_PACKET_SIZE 9
1209
1210SR_PRIV gboolean sr_m2110_packet_valid(const uint8_t *buf);
1211SR_PRIV int sr_m2110_parse(const uint8_t *buf, float *floatval,
8c677240 1212 struct sr_datafeed_analog *analog, void *info);
825da8b2 1213
3ea46116 1214/*--- hardware/dmm/metex14.c ------------------------------------------------*/
ac913e5c
UH
1215
1216#define METEX14_PACKET_SIZE 14
1217
1218struct metex14_info {
1219 gboolean is_ac, is_dc, is_resistance, is_capacity, is_temperature;
1220 gboolean is_diode, is_frequency, is_ampere, is_volt, is_farad;
c02dc3e2
UH
1221 gboolean is_hertz, is_ohm, is_celsius, is_pico, is_nano, is_micro;
1222 gboolean is_milli, is_kilo, is_mega, is_gain, is_decibel, is_hfe;
e83437ae 1223 gboolean is_unitless, is_logic;
ac913e5c
UH
1224};
1225
c4f2dfd0 1226#ifdef HAVE_LIBSERIALPORT
ce3777ad 1227SR_PRIV int sr_metex14_packet_request(struct sr_serial_dev_inst *serial);
c4f2dfd0 1228#endif
ac913e5c
UH
1229SR_PRIV gboolean sr_metex14_packet_valid(const uint8_t *buf);
1230SR_PRIV int sr_metex14_parse(const uint8_t *buf, float *floatval,
8c677240 1231 struct sr_datafeed_analog *analog, void *info);
ac913e5c 1232
3ea46116 1233/*--- hardware/dmm/rs9lcd.c -------------------------------------------------*/
05f134ab 1234
21829e67 1235#define RS9LCD_PACKET_SIZE 9
05f134ab 1236
e7ed87a4 1237/* Dummy info struct. The parser does not use it. */
bf6f8399 1238struct rs9lcd_info { int dummy; };
e7ed87a4 1239
05f134ab
AG
1240SR_PRIV gboolean sr_rs9lcd_packet_valid(const uint8_t *buf);
1241SR_PRIV int sr_rs9lcd_parse(const uint8_t *buf, float *floatval,
8c677240 1242 struct sr_datafeed_analog *analog, void *info);
05f134ab 1243
3ea46116 1244/*--- hardware/dmm/bm25x.c --------------------------------------------------*/
a24c3f4a
JH
1245
1246#define BRYMEN_BM25X_PACKET_SIZE 15
1247
1248/* Dummy info struct. The parser does not use it. */
1249struct bm25x_info { int dummy; };
1250
1251SR_PRIV gboolean sr_brymen_bm25x_packet_valid(const uint8_t *buf);
1252SR_PRIV int sr_brymen_bm25x_parse(const uint8_t *buf, float *floatval,
8c677240 1253 struct sr_datafeed_analog *analog, void *info);
a24c3f4a 1254
626027df
UH
1255/*--- hardware/dmm/ut71x.c --------------------------------------------------*/
1256
1257#define UT71X_PACKET_SIZE 11
1258
1259struct ut71x_info {
1260 gboolean is_voltage, is_resistance, is_capacitance, is_temperature;
1261 gboolean is_celsius, is_fahrenheit, is_current, is_continuity;
1262 gboolean is_diode, is_frequency, is_duty_cycle, is_dc, is_ac;
1263 gboolean is_auto, is_manual, is_sign, is_power, is_loop_current;
1264};
1265
1266SR_PRIV gboolean sr_ut71x_packet_valid(const uint8_t *buf);
1267SR_PRIV int sr_ut71x_parse(const uint8_t *buf, float *floatval,
8c677240 1268 struct sr_datafeed_analog *analog, void *info);
626027df 1269
c36f78f7
UH
1270/*--- hardware/dmm/vc870.c --------------------------------------------------*/
1271
1272#define VC870_PACKET_SIZE 23
1273
1274struct vc870_info {
1275 gboolean is_voltage, is_dc, is_ac, is_temperature, is_resistance;
1276 gboolean is_continuity, is_capacitance, is_diode, is_loop_current;
1277 gboolean is_current, is_micro, is_milli, is_power;
ee2e9be2 1278 gboolean is_power_factor_freq, is_power_apparent_power, is_v_a_rms_value;
c36f78f7
UH
1279 gboolean is_sign2, is_sign1, is_batt, is_ol1, is_max, is_min;
1280 gboolean is_maxmin, is_rel, is_ol2, is_open, is_manu, is_hold;
1281 gboolean is_light, is_usb, is_warning, is_auto_power, is_misplug_warn;
1282 gboolean is_lo, is_hi, is_open2;
1283
3591481e 1284 gboolean is_frequency, is_dual_display, is_auto;
c36f78f7
UH
1285};
1286
1287SR_PRIV gboolean sr_vc870_packet_valid(const uint8_t *buf);
1288SR_PRIV int sr_vc870_parse(const uint8_t *buf, float *floatval,
8c677240 1289 struct sr_datafeed_analog *analog, void *info);
c36f78f7 1290
3ea46116 1291/*--- hardware/lcr/es51919.c ------------------------------------------------*/
6bcb3ee8
JH
1292
1293SR_PRIV void es51919_serial_clean(void *priv);
1294SR_PRIV struct sr_dev_inst *es51919_serial_scan(GSList *options,
1295 const char *vendor,
1296 const char *model);
1297SR_PRIV int es51919_serial_config_get(uint32_t key, GVariant **data,
1298 const struct sr_dev_inst *sdi,
1299 const struct sr_channel_group *cg);
1300SR_PRIV int es51919_serial_config_set(uint32_t key, GVariant *data,
1301 const struct sr_dev_inst *sdi,
1302 const struct sr_channel_group *cg);
1303SR_PRIV int es51919_serial_config_list(uint32_t key, GVariant **data,
1304 const struct sr_dev_inst *sdi,
1305 const struct sr_channel_group *cg);
695dc859
UH
1306SR_PRIV int es51919_serial_acquisition_start(const struct sr_dev_inst *sdi);
1307SR_PRIV int es51919_serial_acquisition_stop(struct sr_dev_inst *sdi);
6bcb3ee8 1308
f3cde309
ML
1309/*--- hardware/dmm/ut372.c --------------------------------------------------*/
1310
1311#define UT372_PACKET_SIZE 27
1312
1313struct ut372_info {
1314 int dummy;
1315};
1316
1317SR_PRIV gboolean sr_ut372_packet_valid(const uint8_t *buf);
1318SR_PRIV int sr_ut372_parse(const uint8_t *buf, float *floatval,
8c677240 1319 struct sr_datafeed_analog *analog, void *info);
f3cde309 1320
e5d953b5
UH
1321/*--- hardware/scale/kern.c -------------------------------------------------*/
1322
1323struct kern_info {
1324 gboolean is_gram, is_carat, is_ounce, is_pound, is_troy_ounce;
1325 gboolean is_pennyweight, is_grain, is_tael, is_momme, is_tola;
1326 gboolean is_percentage, is_piece, is_unstable, is_stable, is_error;
1327 int buflen;
1328};
1329
1330SR_PRIV gboolean sr_kern_packet_valid(const uint8_t *buf);
1331SR_PRIV int sr_kern_parse(const uint8_t *buf, float *floatval,
563ba4a5 1332 struct sr_datafeed_analog *analog, void *info);
e5d953b5 1333
aea4e458
LPC
1334/*--- sw_limits.c -----------------------------------------------------------*/
1335
1336struct sr_sw_limits {
1337 uint64_t limit_samples;
1338 uint64_t limit_msec;
1339 uint64_t samples_read;
1340 uint64_t start_time;
1341};
1342
1343SR_PRIV int sr_sw_limits_config_get(struct sr_sw_limits *limits, uint32_t key,
1344 GVariant **data);
1345SR_PRIV int sr_sw_limits_config_set(struct sr_sw_limits *limits, uint32_t key,
1346 GVariant *data);
1347SR_PRIV void sr_sw_limits_acquisition_start(struct sr_sw_limits *limits);
1348SR_PRIV gboolean sr_sw_limits_check(struct sr_sw_limits *limits);
1349SR_PRIV void sr_sw_limits_update_samples_read(struct sr_sw_limits *limits,
1350 uint64_t samples_read);
1351SR_PRIV void sr_sw_limits_init(struct sr_sw_limits *limits);
1352
1483577e 1353#endif