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