]> sigrok.org Git - libsigrok.git/blame - src/libsigrok-internal.h
Add filename field to sr_output and make it accessible
[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>
cc8a7d25 28#include <glib.h>
1a081ca6 29#include "config.h" /* Needed for HAVE_LIBUSB_1_0 and others. */
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
393fb9cb
UH
37/**
38 * @file
39 *
40 * libsigrok private header file, only to be used internally.
41 */
42
4cea9eb2
UH
43/*--- Macros ----------------------------------------------------------------*/
44
45#ifndef ARRAY_SIZE
46#define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0]))
47#endif
48
49#ifndef ARRAY_AND_SIZE
50#define ARRAY_AND_SIZE(a) (a), ARRAY_SIZE(a)
51#endif
52
a4f9c35b 53/**
5bf0dd6a 54 * Read a 8 bits unsigned integer out of memory.
a4f9c35b 55 * @param x a pointer to the input memory
5bf0dd6a 56 * @return the corresponding unsigned integer
a4f9c35b
AJ
57 */
58#define R8(x) ((unsigned)((const uint8_t*)(x))[0])
59
e28ef28a 60/**
5bf0dd6a 61 * Read a 16 bits big endian unsigned integer out of memory.
e28ef28a 62 * @param x a pointer to the input memory
5bf0dd6a 63 * @return the corresponding unsigned integer
e28ef28a 64 */
79a1176b
AJ
65#define RB16(x) (((unsigned)((const uint8_t*)(x))[0] << 8) | \
66 (unsigned)((const uint8_t*)(x))[1])
e28ef28a
AJ
67
68/**
5bf0dd6a 69 * Read a 16 bits little endian unsigned integer out of memory.
e28ef28a 70 * @param x a pointer to the input memory
5bf0dd6a 71 * @return the corresponding unsigned integer
e28ef28a 72 */
79a1176b
AJ
73#define RL16(x) (((unsigned)((const uint8_t*)(x))[1] << 8) | \
74 (unsigned)((const uint8_t*)(x))[0])
e28ef28a
AJ
75
76/**
5bf0dd6a 77 * Read a 16 bits little endian signed integer out of memory.
e28ef28a 78 * @param x a pointer to the input memory
5bf0dd6a
BV
79 * @return the corresponding signed integer
80 */
81#define RL16S(x) ((int16_t) \
af945a66 82 (((unsigned)((const uint8_t*)(x))[1] << 8) | \
5bf0dd6a
BV
83 (unsigned)((const uint8_t*)(x))[0]))
84
85/**
86 * Read a 32 bits big endian unsigned integer out of memory.
87 * @param x a pointer to the input memory
88 * @return the corresponding unsigned integer
e28ef28a 89 */
79a1176b
AJ
90#define RB32(x) (((unsigned)((const uint8_t*)(x))[0] << 24) | \
91 ((unsigned)((const uint8_t*)(x))[1] << 16) | \
92 ((unsigned)((const uint8_t*)(x))[2] << 8) | \
93 (unsigned)((const uint8_t*)(x))[3])
e28ef28a
AJ
94
95/**
5bf0dd6a 96 * Read a 32 bits little endian unsigned integer out of memory.
e28ef28a 97 * @param x a pointer to the input memory
5bf0dd6a 98 * @return the corresponding unsigned integer
e28ef28a 99 */
79a1176b
AJ
100#define RL32(x) (((unsigned)((const uint8_t*)(x))[3] << 24) | \
101 ((unsigned)((const uint8_t*)(x))[2] << 16) | \
102 ((unsigned)((const uint8_t*)(x))[1] << 8) | \
103 (unsigned)((const uint8_t*)(x))[0])
e28ef28a 104
ea2d6d99 105/**
5bf0dd6a
BV
106 * Read a 32 bits little endian signed integer out of memory.
107 * @param x a pointer to the input memory
108 * @return the corresponding signed integer
109 */
110#define RL32S(x) ((int32_t) \
111 (((unsigned)((const uint8_t*)(x))[3] << 24) | \
112 ((unsigned)((const uint8_t*)(x))[2] << 16) | \
113 ((unsigned)((const uint8_t*)(x))[1] << 8) | \
114 (unsigned)((const uint8_t*)(x))[0]))
115
a2632bca
AJ
116/**
117 * Read a 32 bits big endian float out of memory.
118 * @param x a pointer to the input memory
119 * @return the corresponding float
120 */
121#define RBFL(x) ((union { uint32_t u; float f; }) { .u = RB32(x) }.f)
122
123/**
124 * Read a 32 bits little endian float out of memory.
125 * @param x a pointer to the input memory
126 * @return the corresponding float
127 */
128#define RLFL(x) ((union { uint32_t u; float f; }) { .u = RL32(x) }.f)
129
5bf0dd6a
BV
130/**
131 * Write a 8 bits unsigned integer to memory.
ea2d6d99 132 * @param p a pointer to the output memory
5bf0dd6a 133 * @param x the input unsigned integer
ea2d6d99 134 */
0c5f2abc 135#define W8(p, x) do { ((uint8_t*)(p))[0] = (uint8_t) (x); } while (0)
ea2d6d99
AJ
136
137/**
5bf0dd6a 138 * Write a 16 bits unsigned integer to memory stored as big endian.
ea2d6d99 139 * @param p a pointer to the output memory
5bf0dd6a 140 * @param x the input unsigned integer
ea2d6d99
AJ
141 */
142#define WB16(p, x) do { ((uint8_t*)(p))[1] = (uint8_t) (x); \
0c5f2abc 143 ((uint8_t*)(p))[0] = (uint8_t)((x)>>8); } while (0)
ea2d6d99
AJ
144
145/**
5bf0dd6a 146 * Write a 16 bits unsigned integer to memory stored as little endian.
ea2d6d99 147 * @param p a pointer to the output memory
5bf0dd6a 148 * @param x the input unsigned integer
ea2d6d99
AJ
149 */
150#define WL16(p, x) do { ((uint8_t*)(p))[0] = (uint8_t) (x); \
0c5f2abc 151 ((uint8_t*)(p))[1] = (uint8_t)((x)>>8); } while (0)
ea2d6d99
AJ
152
153/**
5bf0dd6a 154 * Write a 32 bits unsigned integer to memory stored as big endian.
ea2d6d99 155 * @param p a pointer to the output memory
5bf0dd6a 156 * @param x the input unsigned integer
ea2d6d99
AJ
157 */
158#define WB32(p, x) do { ((uint8_t*)(p))[3] = (uint8_t) (x); \
159 ((uint8_t*)(p))[2] = (uint8_t)((x)>>8); \
160 ((uint8_t*)(p))[1] = (uint8_t)((x)>>16); \
0c5f2abc 161 ((uint8_t*)(p))[0] = (uint8_t)((x)>>24); } while (0)
ea2d6d99
AJ
162
163/**
5bf0dd6a 164 * Write a 32 bits unsigned integer to memory stored as little endian.
ea2d6d99 165 * @param p a pointer to the output memory
5bf0dd6a 166 * @param x the input unsigned integer
ea2d6d99
AJ
167 */
168#define WL32(p, x) do { ((uint8_t*)(p))[0] = (uint8_t) (x); \
169 ((uint8_t*)(p))[1] = (uint8_t)((x)>>8); \
170 ((uint8_t*)(p))[2] = (uint8_t)((x)>>16); \
0c5f2abc 171 ((uint8_t*)(p))[3] = (uint8_t)((x)>>24); } while (0)
ea2d6d99 172
a2632bca
AJ
173/**
174 * Write a 32 bits float to memory stored as big endian.
175 * @param p a pointer to the output memory
176 * @param x the input float
177 */
178#define WBFL(p, x) WB32(p, (union { uint32_t u; float f; }) { .f = x }.u)
179
180/**
181 * Write a 32 bits float to memory stored as little endian.
182 * @param p a pointer to the output memory
183 * @param x the input float
184 */
185#define WLFL(p, x) WL32(p, (union { uint32_t u; float f; }) { .f = x }.u)
186
6bf4273e
UH
187/* Portability fixes for FreeBSD. */
188#ifdef __FreeBSD__
189#define LIBUSB_CLASS_APPLICATION 0xfe
15eea61a 190#define libusb_has_capability(x) 0
6bf4273e
UH
191#define libusb_handle_events_timeout_completed(ctx, tv, c) \
192 libusb_handle_events_timeout(ctx, tv)
193#endif
194
1685c276
BV
195/* Static definitions of structs ending with an all-zero entry are a
196 * problem when compiling with -Wmissing-field-initializers: GCC
197 * suppresses the warning only with { 0 }, clang wants { } */
198#ifdef __clang__
199#define ALL_ZERO { }
200#else
201#define ALL_ZERO { 0 }
202#endif
203
b8072700 204struct sr_context {
032da34b 205 struct sr_dev_driver **driver_list;
785b9ff2
PS
206#ifdef HAVE_LIBUSB_1_0
207 libusb_context *libusb_ctx;
6640324f 208 gboolean usb_source_present;
5321ac6b
ML
209#ifdef _WIN32
210 GThread *usb_thread;
211 gboolean usb_thread_running;
f6c30de4
ML
212 HANDLE usb_wait_request_event;
213 HANDLE usb_wait_complete_event;
5321ac6b 214 GPollFD usb_pollfd;
144f6660 215 sr_receive_data_callback usb_cb;
5321ac6b
ML
216 void *usb_cb_data;
217#endif
785b9ff2 218#endif
b8072700
PS
219};
220
20e88821
BV
221/** Input module metadata keys. */
222enum sr_input_meta_keys {
223 /** The input filename, if there is one. */
224 SR_INPUT_META_FILENAME = 0x01,
225 /** The input file's size in bytes. */
226 SR_INPUT_META_FILESIZE = 0x02,
227 /** The first 128 bytes of the file, provided as a GString. */
228 SR_INPUT_META_HEADER = 0x04,
229 /** The file's MIME type. */
230 SR_INPUT_META_MIMETYPE = 0x08,
231
232 /** The module cannot identify a file without this metadata. */
233 SR_INPUT_META_REQUIRED = 0x80,
234};
235
d514d35d
BV
236/** Input (file) module struct. */
237struct sr_input {
238 /**
239 * A pointer to this input module's 'struct sr_input_module'.
d514d35d 240 */
17bfaca6
BV
241 const struct sr_input_module *module;
242 GString *buf;
d514d35d 243 struct sr_dev_inst *sdi;
d0181813 244 gboolean sdi_ready;
17bfaca6 245 void *priv;
d514d35d
BV
246};
247
248/** Input (file) module driver. */
249struct sr_input_module {
17bfaca6 250 /**
d65fcbcd 251 * A unique ID for this input module, suitable for use in command-line
17bfaca6
BV
252 * clients, [a-z0-9-]. Must not be NULL.
253 */
254 const char *id;
d514d35d
BV
255
256 /**
d65fcbcd 257 * A unique name for this input module, suitable for use in GUI
17bfaca6 258 * clients, can contain UTF-8. Must not be NULL.
d514d35d 259 */
17bfaca6 260 const char *name;
d514d35d
BV
261
262 /**
d65fcbcd 263 * A short description of the input module. Must not be NULL.
d514d35d 264 *
d65fcbcd 265 * This can be displayed by frontends, e.g. when selecting the input
17bfaca6
BV
266 * module for saving a file.
267 */
268 const char *desc;
269
c7bc82ff
JH
270 /**
271 * A NULL terminated array of strings containing a list of file name
272 * extensions typical for the input file format, or NULL if there is
273 * no typical extension for this file format.
274 */
275 const char *const *exts;
276
17bfaca6
BV
277 /**
278 * Zero-terminated list of metadata items the module needs to be able
279 * to identify an input stream. Can be all-zero, if the module cannot
280 * identify streams at all, i.e. has to be forced into use.
281 *
282 * Each item is one of:
283 * SR_INPUT_META_FILENAME
284 * SR_INPUT_META_FILESIZE
285 * SR_INPUT_META_HEADER
286 * SR_INPUT_META_MIMETYPE
287 *
288 * If the high bit (SR_INPUT META_REQUIRED) is set, the module cannot
289 * identify a stream without the given metadata.
290 */
291 const uint8_t metadata[8];
292
293 /**
294 * Returns a NULL-terminated list of options this module can take.
295 * Can be NULL, if the module has no options.
296 */
297 struct sr_option *(*options) (void);
298
299 /**
300 * Check if this input module can load and parse the specified stream.
301 *
302 * @param[in] metadata Metadata the module can use to identify the stream.
d514d35d 303 *
4f979115 304 * @retval SR_OK This module knows the format.
753793ef 305 * @retval SR_ERR_NA There wasn't enough data for this module to
4f979115
BV
306 * positively identify the format.
307 * @retval SR_ERR_DATA This module knows the format, but cannot handle it.
308 * This means the stream is either corrupt, or indicates a feature
309 * that the module does not support.
310 * @retval SR_ERR This module does not know the format.
d514d35d 311 */
17bfaca6 312 int (*format_match) (GHashTable *metadata);
d514d35d
BV
313
314 /**
315 * Initialize the input module.
316 *
d514d35d
BV
317 * @retval SR_OK Success
318 * @retval other Negative error code.
319 */
17bfaca6 320 int (*init) (struct sr_input *in, GHashTable *options);
d514d35d
BV
321
322 /**
753793ef 323 * Send data to the specified input instance.
d514d35d 324 *
753793ef
BV
325 * When an input module instance is created with sr_input_new(), this
326 * function is used to feed data to the instance.
d514d35d 327 *
753793ef
BV
328 * As enough data gets fed into this function to completely populate
329 * the device instance associated with this input instance, this is
330 * guaranteed to return the moment it's ready. This gives the caller
331 * the chance to examine the device instance, attach session callbacks
332 * and so on.
17bfaca6
BV
333 *
334 * @retval SR_OK Success
335 * @retval other Negative error code.
336 */
d0181813 337 int (*receive) (struct sr_input *in, GString *buf);
17bfaca6 338
753793ef
BV
339 /**
340 * Signal the input module no more data will come.
341 *
342 * This will cause the module to process any data it may have buffered.
343 * The SR_DF_END packet will also typically be sent at this time.
344 */
7066fd46
BV
345 int (*end) (struct sr_input *in);
346
17bfaca6
BV
347 /**
348 * This function is called after the caller is finished using
349 * the input module, and can be used to free any internal
350 * resources the module may keep.
d514d35d 351 *
753793ef
BV
352 * This function is optional.
353 *
d514d35d
BV
354 * @retval SR_OK Success
355 * @retval other Negative error code.
356 */
d5cc282f 357 void (*cleanup) (struct sr_input *in);
d514d35d
BV
358};
359
a755b0e1
BV
360/** Output module instance. */
361struct sr_output {
362 /** A pointer to this output's module. */
363 const struct sr_output_module *module;
364
365 /**
366 * The device for which this output module is creating output. This
367 * can be used by the module to find out channel names and numbers.
368 */
369 const struct sr_dev_inst *sdi;
370
81b3ce37
SA
371 /**
372 * The name of the file that the data should be written to.
373 */
374 const char *filename;
375
a755b0e1
BV
376 /**
377 * A generic pointer which can be used by the module to keep internal
378 * state between calls into its callback functions.
379 *
380 * For example, the module might store a pointer to a chunk of output
381 * there, and only flush it when it reaches a certain size.
382 */
d686c5ec 383 void *priv;
a755b0e1
BV
384};
385
386/** Output module driver. */
387struct sr_output_module {
388 /**
389 * A unique ID for this output module, suitable for use in command-line
390 * clients, [a-z0-9-]. Must not be NULL.
391 */
392 char *id;
393
394 /**
395 * A unique name for this output module, suitable for use in GUI
396 * clients, can contain UTF-8. Must not be NULL.
397 */
398 const char *name;
399
400 /**
401 * A short description of the output module. Must not be NULL.
402 *
403 * This can be displayed by frontends, e.g. when selecting the output
404 * module for saving a file.
405 */
406 char *desc;
407
8a174d23
JH
408 /**
409 * A NULL terminated array of strings containing a list of file name
410 * extensions typical for the input file format, or NULL if there is
411 * no typical extension for this file format.
412 */
413 const char *const *exts;
414
a755b0e1
BV
415 /**
416 * Returns a NULL-terminated list of options this module can take.
417 * Can be NULL, if the module has no options.
a755b0e1 418 */
af7d656d 419 const struct sr_option *(*options) (void);
a755b0e1
BV
420
421 /**
422 * This function is called once, at the beginning of an output stream.
423 *
424 * The device struct will be available in the output struct passed in,
425 * as well as the param field -- which may be NULL or an empty string,
426 * if no parameter was passed.
427 *
428 * The module can use this to initialize itself, create a struct for
429 * keeping state and storing it in the <code>internal</code> field.
430 *
431 * @param o Pointer to the respective 'struct sr_output'.
432 *
433 * @retval SR_OK Success
434 * @retval other Negative error code.
435 */
436 int (*init) (struct sr_output *o, GHashTable *options);
437
438 /**
f3f19d11 439 * This function is passed a copy of every packet in the data feed.
a755b0e1
BV
440 * Any output generated by the output module in response to the
441 * packet should be returned in a newly allocated GString
442 * <code>out</code>, which will be freed by the caller.
443 *
444 * Packets not of interest to the output module can just be ignored,
445 * and the <code>out</code> parameter set to NULL.
446 *
447 * @param o Pointer to the respective 'struct sr_output'.
448 * @param sdi The device instance that generated the packet.
449 * @param packet The complete packet.
450 * @param out A pointer where a GString * should be stored if
451 * the module generates output, or NULL if not.
452 *
453 * @retval SR_OK Success
454 * @retval other Negative error code.
455 */
456 int (*receive) (const struct sr_output *o,
457 const struct sr_datafeed_packet *packet, GString **out);
458
459 /**
460 * This function is called after the caller is finished using
461 * the output module, and can be used to free any internal
462 * resources the module may keep.
463 *
464 * @retval SR_OK Success
465 * @retval other Negative error code.
466 */
467 int (*cleanup) (struct sr_output *o);
468};
469
790320f6
UH
470/** Transform module instance. */
471struct sr_transform {
472 /** A pointer to this transform's module. */
473 const struct sr_transform_module *module;
474
475 /**
476 * The device for which this transform module is used. This
477 * can be used by the module to find out channel names and numbers.
478 */
479 const struct sr_dev_inst *sdi;
480
481 /**
482 * A generic pointer which can be used by the module to keep internal
483 * state between calls into its callback functions.
484 */
485 void *priv;
486};
487
488struct sr_transform_module {
489 /**
490 * A unique ID for this transform module, suitable for use in
491 * command-line clients, [a-z0-9-]. Must not be NULL.
492 */
493 char *id;
494
495 /**
496 * A unique name for this transform module, suitable for use in GUI
497 * clients, can contain UTF-8. Must not be NULL.
498 */
499 const char *name;
500
501 /**
502 * A short description of the transform module. Must not be NULL.
503 *
504 * This can be displayed by frontends, e.g. when selecting
505 * which transform module(s) to add.
506 */
507 char *desc;
508
509 /**
510 * Returns a NULL-terminated list of options this transform module
511 * can take. Can be NULL, if the transform module has no options.
512 */
513 const struct sr_option *(*options) (void);
514
515 /**
516 * This function is called once, at the beginning of a stream.
517 *
518 * @param t Pointer to the respective 'struct sr_transform'.
519 * @param options Hash table of options for this transform module.
520 * Can be NULL if no options are to be used.
521 *
522 * @retval SR_OK Success
523 * @retval other Negative error code.
524 */
525 int (*init) (struct sr_transform *t, GHashTable *options);
526
527 /**
528 * This function is passed a pointer to every packet in the data feed.
529 *
530 * It can either return (in packet_out) a pointer to another packet
531 * (possibly the exact same packet it got as input), or NULL.
532 *
533 * @param t Pointer to the respective 'struct sr_transform'.
534 * @param packet_in Pointer to a datafeed packet.
535 * @param packet_out Pointer to the resulting datafeed packet after
536 * this function was run. If NULL, the transform
537 * module intentionally didn't output a new packet.
538 *
539 * @retval SR_OK Success
540 * @retval other Negative error code.
541 */
542 int (*receive) (const struct sr_transform *t,
543 struct sr_datafeed_packet *packet_in,
544 struct sr_datafeed_packet **packet_out);
545
546 /**
547 * This function is called after the caller is finished using
548 * the transform module, and can be used to free any internal
549 * resources the module may keep.
550 *
551 * @retval SR_OK Success
552 * @retval other Negative error code.
553 */
554 int (*cleanup) (struct sr_transform *t);
555};
556
69890f73 557#ifdef HAVE_LIBUSB_1_0
04cb9157 558/** USB device instance */
d68e2d1a 559struct sr_usb_dev_inst {
98582bf5
BV
560 /** USB bus */
561 uint8_t bus;
562 /** Device address on USB bus */
563 uint8_t address;
564 /** libusb device handle */
565 struct libusb_device_handle *devhdl;
69890f73
UH
566};
567#endif
568
c4f2dfd0 569#ifdef HAVE_LIBSERIALPORT
a9bce5a5
ML
570#define SERIAL_PARITY_NONE SP_PARITY_NONE
571#define SERIAL_PARITY_EVEN SP_PARITY_EVEN
572#define SERIAL_PARITY_ODD SP_PARITY_ODD
d68e2d1a 573struct sr_serial_dev_inst {
98582bf5
BV
574 /** Port name, e.g. '/dev/tty42'. */
575 char *port;
576 /** Comm params for serial_set_paramstr(). */
577 char *serialcomm;
98582bf5
BV
578 /** libserialport port handle */
579 struct sp_port *data;
ba1949f5
ML
580 /** libserialport event set */
581 struct sp_event_set *event_set;
582 /** GPollFDs for event polling */
583 GPollFD *pollfds;
69890f73 584};
c4f2dfd0 585#endif
69890f73 586
ae67644f
ML
587struct sr_usbtmc_dev_inst {
588 char *device;
589 int fd;
590};
591
026c822d
UH
592/* Private driver context. */
593struct drv_context {
98582bf5
BV
594 /** sigrok context */
595 struct sr_context *sr_ctx;
026c822d
UH
596 GSList *instances;
597};
598
48a486cd
BV
599/*--- log.c -----------------------------------------------------------------*/
600
601SR_PRIV int sr_log(int loglevel, const char *format, ...);
602SR_PRIV int sr_spew(const char *format, ...);
603SR_PRIV int sr_dbg(const char *format, ...);
604SR_PRIV int sr_info(const char *format, ...);
605SR_PRIV int sr_warn(const char *format, ...);
606SR_PRIV int sr_err(const char *format, ...);
607
3544f848
ML
608/* Message logging helpers with subsystem-specific prefix string. */
609#ifndef NO_LOG_WRAPPERS
610#define sr_log(l, s, args...) sr_log(l, "%s: " s, LOG_PREFIX, ## args)
611#define sr_spew(s, args...) sr_spew("%s: " s, LOG_PREFIX, ## args)
612#define sr_dbg(s, args...) sr_dbg("%s: " s, LOG_PREFIX, ## args)
613#define sr_info(s, args...) sr_info("%s: " s, LOG_PREFIX, ## args)
614#define sr_warn(s, args...) sr_warn("%s: " s, LOG_PREFIX, ## args)
615#define sr_err(s, args...) sr_err("%s: " s, LOG_PREFIX, ## args)
616#endif
617
48a486cd
BV
618/*--- device.c --------------------------------------------------------------*/
619
f3ca73ed 620/** Values for the changes argument of sr_dev_driver.config_channel_set. */
2a854d71 621enum {
fca75cbb 622 /** The enabled state of the channel has been changed. */
3f239f08 623 SR_CHANNEL_SET_ENABLED = 1 << 0,
2a854d71
DE
624};
625
5e23fcab
ML
626SR_PRIV struct sr_channel *sr_channel_new(struct sr_dev_inst *sdi,
627 int index, int type, gboolean enabled, const char *name);
48a486cd 628
96727ef0
UH
629/** Device instance data */
630struct sr_dev_inst {
631 /** Device driver. */
632 struct sr_dev_driver *driver;
633 /** Device instance status. SR_ST_NOT_FOUND, etc. */
634 int status;
635 /** Device instance type. SR_INST_USB, etc. */
636 int inst_type;
637 /** Device vendor. */
638 char *vendor;
639 /** Device model. */
640 char *model;
641 /** Device version. */
642 char *version;
643 /** Serial number. */
644 char *serial_num;
645 /** Connection string to uniquely identify devices. */
646 char *connection_id;
647 /** List of channels. */
648 GSList *channels;
649 /** List of sr_channel_group structs */
650 GSList *channel_groups;
651 /** Device instance connection data (used?) */
652 void *conn;
653 /** Device instance private data (used?) */
654 void *priv;
655 /** Session to which this device is currently assigned. */
656 struct sr_session *session;
657};
658
48a486cd 659/* Generic device instances */
48a486cd 660SR_PRIV void sr_dev_inst_free(struct sr_dev_inst *sdi);
48a486cd 661
545f9786 662#ifdef HAVE_LIBUSB_1_0
69890f73 663/* USB-specific instances */
d68e2d1a 664SR_PRIV struct sr_usb_dev_inst *sr_usb_dev_inst_new(uint8_t bus,
69890f73 665 uint8_t address, struct libusb_device_handle *hdl);
d68e2d1a 666SR_PRIV void sr_usb_dev_inst_free(struct sr_usb_dev_inst *usb);
69890f73
UH
667#endif
668
c4f2dfd0 669#ifdef HAVE_LIBSERIALPORT
69890f73 670/* Serial-specific instances */
299bdb24
BV
671SR_PRIV struct sr_serial_dev_inst *sr_serial_dev_inst_new(const char *port,
672 const char *serialcomm);
d68e2d1a 673SR_PRIV void sr_serial_dev_inst_free(struct sr_serial_dev_inst *serial);
c4f2dfd0 674#endif
69890f73 675
ae67644f
ML
676/* USBTMC-specific instances */
677SR_PRIV struct sr_usbtmc_dev_inst *sr_usbtmc_dev_inst_new(const char *device);
678SR_PRIV void sr_usbtmc_dev_inst_free(struct sr_usbtmc_dev_inst *usbtmc);
b08024a8 679
c09f0b57 680/*--- hwdriver.c ------------------------------------------------------------*/
996b0c72 681
032da34b
UH
682extern SR_PRIV struct sr_dev_driver **drivers_lists[];
683
13fef1ed 684SR_PRIV const GVariantType *sr_variant_type_get(int datatype);
584560f1 685SR_PRIV int sr_variant_type_check(uint32_t key, GVariant *data);
032da34b 686SR_PRIV void sr_hw_cleanup_all(const struct sr_context *ctx);
584560f1 687SR_PRIV struct sr_config *sr_config_new(uint32_t key, GVariant *data);
722db131 688SR_PRIV void sr_config_free(struct sr_config *src);
48a486cd 689SR_PRIV int sr_source_remove(int fd);
0812c40e
ML
690SR_PRIV int sr_source_remove_pollfd(GPollFD *pollfd);
691SR_PRIV int sr_source_remove_channel(GIOChannel *channel);
48a486cd 692SR_PRIV int sr_source_add(int fd, int events, int timeout,
144f6660 693 sr_receive_data_callback cb, void *cb_data);
0812c40e
ML
694SR_PRIV int sr_source_add_pollfd(GPollFD *pollfd, int timeout,
695 sr_receive_data_callback cb, void *cb_data);
696SR_PRIV int sr_source_add_channel(GIOChannel *channel, int events, int timeout,
697 sr_receive_data_callback cb, void *cb_data);
996b0c72 698
a1645fcd
BV
699/*--- session.c -------------------------------------------------------------*/
700
e2b23821 701struct sr_session {
4ed5d21d
ML
702 /** Context this session exists in. */
703 struct sr_context *ctx;
c0e3ba4b 704 /** List of struct sr_dev_inst pointers. */
e2b23821 705 GSList *devs;
1de3cced
ML
706 /** List of struct sr_dev_inst pointers owned by this session. */
707 GSList *owned_devs;
e2b23821
UH
708 /** List of struct datafeed_callback pointers. */
709 GSList *datafeed_callbacks;
c0a1e532 710 GSList *transforms;
7b5e6d29 711 struct sr_trigger *trigger;
e2b23821
UH
712 GTimeVal starttime;
713 gboolean running;
714
715 unsigned int num_sources;
716
717 /*
718 * Both "sources" and "pollfds" are of the same size and contain pairs
719 * of descriptor and callback function. We can not embed the GPollFD
720 * into the source struct since we want to be able to pass the array
721 * of all poll descriptors to g_poll().
722 */
723 struct source *sources;
724 GPollFD *pollfds;
725 int source_timeout;
726
727 /*
728 * These are our synchronization primitives for stopping the session in
729 * an async fashion. We need to make sure the session is stopped from
730 * within the session thread itself.
731 */
98582bf5
BV
732 /** Mutex protecting access to abort_session. */
733 GMutex stop_mutex;
734 /** Abort current session. See sr_session_stop(). */
e2b23821
UH
735 gboolean abort_session;
736};
737
de4d3f99 738SR_PRIV int sr_session_send(const struct sr_dev_inst *sdi,
ae5859ff 739 const struct sr_datafeed_packet *packet);
0812c40e 740SR_PRIV int sr_session_stop_sync(struct sr_session *session);
f438e0c9 741SR_PRIV int sr_sessionfile_check(const char *filename);
8143cfdc
BV
742SR_PRIV int sr_packet_copy(const struct sr_datafeed_packet *packet,
743 struct sr_datafeed_packet **copy);
744SR_PRIV void sr_packet_free(struct sr_datafeed_packet *packet);
a1645fcd 745
41caa319
AJ
746/*--- analog.c --------------------------------------------------------------*/
747
748SR_PRIV int sr_analog_init(struct sr_datafeed_analog2 *analog,
749 struct sr_analog_encoding *encoding,
750 struct sr_analog_meaning *meaning,
751 struct sr_analog_spec *spec,
752 int digits);
753
063e7aef
UH
754/*--- std.c -----------------------------------------------------------------*/
755
144f6660
UH
756typedef int (*dev_close_callback)(struct sr_dev_inst *sdi);
757typedef void (*std_dev_clear_callback)(void *priv);
cd2f0fe2 758
f6beaac5 759SR_PRIV int std_init(struct sr_context *sr_ctx, struct sr_dev_driver *di,
ae5859ff 760 const char *prefix);
c4f2dfd0 761#ifdef HAVE_LIBSERIALPORT
23dc6661 762SR_PRIV int std_serial_dev_open(struct sr_dev_inst *sdi);
d43b0908 763SR_PRIV int std_serial_dev_acquisition_stop(struct sr_dev_inst *sdi,
144f6660 764 void *cb_data, dev_close_callback dev_close_fn,
ae5859ff 765 struct sr_serial_dev_inst *serial, const char *prefix);
c4f2dfd0 766#endif
4afdfd46 767SR_PRIV int std_session_send_df_header(const struct sr_dev_inst *sdi,
ae5859ff
BV
768 const char *prefix);
769SR_PRIV int std_dev_clear(const struct sr_dev_driver *driver,
144f6660 770 std_dev_clear_callback clear_private);
043e899a 771SR_PRIV int std_serial_dev_close(struct sr_dev_inst *sdi);
4afdfd46 772
8d558c7a
UH
773/*--- strutil.c -------------------------------------------------------------*/
774
775SR_PRIV int sr_atol(const char *str, long *ret);
776SR_PRIV int sr_atoi(const char *str, int *ret);
777SR_PRIV int sr_atod(const char *str, double *ret);
778SR_PRIV int sr_atof(const char *str, float *ret);
9806c2d5 779SR_PRIV int sr_atof_ascii(const char *str, float *ret);
8d558c7a 780
ac136b57
BV
781/*--- soft-trigger.c --------------------------------------------------------*/
782
783struct soft_trigger_logic {
784 const struct sr_dev_inst *sdi;
785 const struct sr_trigger *trigger;
786 int count;
787 int unitsize;
788 int cur_stage;
789 uint8_t *prev_sample;
fe5a7355
AJ
790 uint8_t *pre_trigger_buffer;
791 uint8_t *pre_trigger_head;
792 int pre_trigger_size;
793 int pre_trigger_fill;
ac136b57
BV
794};
795
796SR_PRIV struct soft_trigger_logic *soft_trigger_logic_new(
fe5a7355
AJ
797 const struct sr_dev_inst *sdi, struct sr_trigger *trigger,
798 int pre_trigger_samples);
ac136b57
BV
799SR_PRIV void soft_trigger_logic_free(struct soft_trigger_logic *st);
800SR_PRIV int soft_trigger_logic_check(struct soft_trigger_logic *st, uint8_t *buf,
fe5a7355 801 int len, int *pre_trigger_samples);
ac136b57 802
3ea46116 803/*--- hardware/serial.c -----------------------------------------------------*/
058b7035 804
c4f2dfd0 805#ifdef HAVE_LIBSERIALPORT
a54dd31e
UH
806enum {
807 SERIAL_RDWR = 1,
808 SERIAL_RDONLY = 2,
a54dd31e
UH
809};
810
144f6660 811typedef gboolean (*packet_valid_callback)(const uint8_t *buf);
766456be 812
299bdb24
BV
813SR_PRIV int serial_open(struct sr_serial_dev_inst *serial, int flags);
814SR_PRIV int serial_close(struct sr_serial_dev_inst *serial);
815SR_PRIV int serial_flush(struct sr_serial_dev_inst *serial);
bce75f94 816SR_PRIV int serial_drain(struct sr_serial_dev_inst *serial);
9a474211 817SR_PRIV int serial_write_blocking(struct sr_serial_dev_inst *serial,
eead2782 818 const void *buf, size_t count, unsigned int timeout_ms);
9a474211
ML
819SR_PRIV int serial_write_nonblocking(struct sr_serial_dev_inst *serial,
820 const void *buf, size_t count);
9a474211 821SR_PRIV int serial_read_blocking(struct sr_serial_dev_inst *serial, void *buf,
eead2782 822 size_t count, unsigned int timeout_ms);
9a474211
ML
823SR_PRIV int serial_read_nonblocking(struct sr_serial_dev_inst *serial, void *buf,
824 size_t count);
299bdb24 825SR_PRIV int serial_set_params(struct sr_serial_dev_inst *serial, int baudrate,
71caaad4 826 int bits, int parity, int stopbits, int flowcontrol, int rts, int dtr);
299bdb24
BV
827SR_PRIV int serial_set_paramstr(struct sr_serial_dev_inst *serial,
828 const char *paramstr);
829SR_PRIV int serial_readline(struct sr_serial_dev_inst *serial, char **buf,
830 int *buflen, gint64 timeout_ms);
766456be
UH
831SR_PRIV int serial_stream_detect(struct sr_serial_dev_inst *serial,
832 uint8_t *buf, size_t *buflen,
144f6660
UH
833 size_t packet_size,
834 packet_valid_callback is_valid,
766456be 835 uint64_t timeout_ms, int baudrate);
1bd9e678
DJ
836SR_PRIV int sr_serial_extract_options(GSList *options, const char **serial_device,
837 const char **serial_options);
102f1239
BV
838SR_PRIV int serial_source_add(struct sr_session *session,
839 struct sr_serial_dev_inst *serial, int events, int timeout,
840 sr_receive_data_callback cb, void *cb_data);
841SR_PRIV int serial_source_remove(struct sr_session *session,
842 struct sr_serial_dev_inst *serial);
b541f837 843SR_PRIV GSList *sr_serial_find_usb(uint16_t vendor_id, uint16_t product_id);
c5cfc735 844SR_PRIV int serial_timeout(struct sr_serial_dev_inst *port, int num_bytes);
c4f2dfd0 845#endif
1483577e 846
3ea46116 847/*--- hardware/ezusb.c ------------------------------------------------------*/
058b7035 848
22b02383 849#ifdef HAVE_LIBUSB_1_0
1a081ca6
UH
850SR_PRIV int ezusb_reset(struct libusb_device_handle *hdl, int set_clear);
851SR_PRIV int ezusb_install_firmware(libusb_device_handle *hdl,
852 const char *filename);
853SR_PRIV int ezusb_upload_firmware(libusb_device *dev, int configuration,
854 const char *filename);
22b02383 855#endif
058b7035 856
3ea46116 857/*--- hardware/usb.c --------------------------------------------------------*/
0c632d36
UH
858
859#ifdef HAVE_LIBUSB_1_0
7ae6a758 860SR_PRIV GSList *sr_usb_find(libusb_context *usb_ctx, const char *conn);
0c632d36 861SR_PRIV int sr_usb_open(libusb_context *usb_ctx, struct sr_usb_dev_inst *usb);
102f1239
BV
862SR_PRIV int usb_source_add(struct sr_session *session, struct sr_context *ctx,
863 int timeout, sr_receive_data_callback cb, void *cb_data);
864SR_PRIV int usb_source_remove(struct sr_session *session, struct sr_context *ctx);
76bc5f63 865SR_PRIV int usb_get_port_path(libusb_device *dev, char *path, int path_len);
0c632d36
UH
866#endif
867
3ea46116 868/*--- hardware/scpi.c -------------------------------------------------------*/
7b9d7320 869
7b9d7320
DJ
870#define SCPI_CMD_IDN "*IDN?"
871#define SCPI_CMD_OPC "*OPC?"
872
873enum {
874 SCPI_CMD_SET_TRIGGER_SOURCE,
875 SCPI_CMD_SET_TIMEBASE,
876 SCPI_CMD_SET_VERTICAL_DIV,
877 SCPI_CMD_SET_TRIGGER_SLOPE,
878 SCPI_CMD_SET_COUPLING,
879 SCPI_CMD_SET_HORIZ_TRIGGERPOS,
880 SCPI_CMD_GET_ANALOG_CHAN_STATE,
881 SCPI_CMD_GET_DIG_CHAN_STATE,
882 SCPI_CMD_GET_TIMEBASE,
883 SCPI_CMD_GET_VERTICAL_DIV,
884 SCPI_CMD_GET_VERTICAL_OFFSET,
885 SCPI_CMD_GET_TRIGGER_SOURCE,
886 SCPI_CMD_GET_HORIZ_TRIGGERPOS,
887 SCPI_CMD_GET_TRIGGER_SLOPE,
888 SCPI_CMD_GET_COUPLING,
889 SCPI_CMD_SET_ANALOG_CHAN_STATE,
890 SCPI_CMD_SET_DIG_CHAN_STATE,
891 SCPI_CMD_GET_DIG_POD_STATE,
892 SCPI_CMD_SET_DIG_POD_STATE,
893 SCPI_CMD_GET_ANALOG_DATA,
894 SCPI_CMD_GET_DIG_DATA,
c09392d0
DJ
895 SCPI_CMD_GET_SAMPLE_RATE,
896 SCPI_CMD_GET_SAMPLE_RATE_LIVE,
7b9d7320
DJ
897};
898
899struct sr_scpi_hw_info {
900 char *manufacturer;
901 char *model;
902 char *serial_number;
903 char *firmware_version;
904};
905
23f43dff 906struct sr_scpi_dev_inst {
f754c146
AJ
907 const char *name;
908 const char *prefix;
909 int priv_size;
b541f837 910 GSList *(*scan)(struct drv_context *drvc);
17bdda58
AJ
911 int (*dev_inst_new)(void *priv, struct drv_context *drvc,
912 const char *resource, char **params, const char *serialcomm);
23f43dff 913 int (*open)(void *priv);
102f1239 914 int (*source_add)(struct sr_session *session, void *priv, int events,
144f6660 915 int timeout, sr_receive_data_callback cb, void *cb_data);
102f1239 916 int (*source_remove)(struct sr_session *session, void *priv);
23f43dff 917 int (*send)(void *priv, const char *command);
05c644ea
ML
918 int (*read_begin)(void *priv);
919 int (*read_data)(void *priv, char *buf, int maxlen);
920 int (*read_complete)(void *priv);
23f43dff
ML
921 int (*close)(void *priv);
922 void (*free)(void *priv);
9092e668 923 unsigned int read_timeout_ms;
23f43dff
ML
924 void *priv;
925};
926
b541f837
AJ
927SR_PRIV GSList *sr_scpi_scan(struct drv_context *drvc, GSList *options,
928 struct sr_dev_inst *(*probe_device)(struct sr_scpi_dev_inst *scpi));
17bdda58
AJ
929SR_PRIV struct sr_scpi_dev_inst *scpi_dev_inst_new(struct drv_context *drvc,
930 const char *resource, const char *serialcomm);
23f43dff 931SR_PRIV int sr_scpi_open(struct sr_scpi_dev_inst *scpi);
102f1239
BV
932SR_PRIV int sr_scpi_source_add(struct sr_session *session,
933 struct sr_scpi_dev_inst *scpi, int events, int timeout,
934 sr_receive_data_callback cb, void *cb_data);
935SR_PRIV int sr_scpi_source_remove(struct sr_session *session,
936 struct sr_scpi_dev_inst *scpi);
23f43dff 937SR_PRIV int sr_scpi_send(struct sr_scpi_dev_inst *scpi,
504f40a5 938 const char *format, ...);
87c41083
ML
939SR_PRIV int sr_scpi_send_variadic(struct sr_scpi_dev_inst *scpi,
940 const char *format, va_list args);
05c644ea
ML
941SR_PRIV int sr_scpi_read_begin(struct sr_scpi_dev_inst *scpi);
942SR_PRIV int sr_scpi_read_data(struct sr_scpi_dev_inst *scpi, char *buf, int maxlen);
943SR_PRIV int sr_scpi_read_complete(struct sr_scpi_dev_inst *scpi);
23f43dff
ML
944SR_PRIV int sr_scpi_close(struct sr_scpi_dev_inst *scpi);
945SR_PRIV void sr_scpi_free(struct sr_scpi_dev_inst *scpi);
946
947SR_PRIV int sr_scpi_get_string(struct sr_scpi_dev_inst *scpi,
948 const char *command, char **scpi_response);
949SR_PRIV int sr_scpi_get_bool(struct sr_scpi_dev_inst *scpi,
950 const char *command, gboolean *scpi_response);
951SR_PRIV int sr_scpi_get_int(struct sr_scpi_dev_inst *scpi,
952 const char *command, int *scpi_response);
953SR_PRIV int sr_scpi_get_float(struct sr_scpi_dev_inst *scpi,
954 const char *command, float *scpi_response);
955SR_PRIV int sr_scpi_get_double(struct sr_scpi_dev_inst *scpi,
956 const char *command, double *scpi_response);
957SR_PRIV int sr_scpi_get_opc(struct sr_scpi_dev_inst *scpi);
958SR_PRIV int sr_scpi_get_floatv(struct sr_scpi_dev_inst *scpi,
959 const char *command, GArray **scpi_response);
960SR_PRIV int sr_scpi_get_uint8v(struct sr_scpi_dev_inst *scpi,
961 const char *command, GArray **scpi_response);
962SR_PRIV int sr_scpi_get_hw_id(struct sr_scpi_dev_inst *scpi,
963 struct sr_scpi_hw_info **scpi_response);
7b9d7320
DJ
964SR_PRIV void sr_scpi_hw_info_free(struct sr_scpi_hw_info *hw_info);
965
daa39012
AJ
966/*--- modbus/modbus.c -------------------------------------------------------*/
967
968struct sr_modbus_dev_inst {
969 const char *name;
970 const char *prefix;
971 int priv_size;
972 GSList *(*scan)(int modbusaddr);
973 int (*dev_inst_new)(void *priv, const char *resource,
974 char **params, const char *serialcomm, int modbusaddr);
975 int (*open)(void *priv);
976 int (*source_add)(struct sr_session *session, void *priv, int events,
977 int timeout, sr_receive_data_callback cb, void *cb_data);
978 int (*source_remove)(struct sr_session *session, void *priv);
979 int (*send)(void *priv, const uint8_t *buffer, int buffer_size);
980 int (*read_begin)(void *priv, uint8_t *function_code);
981 int (*read_data)(void *priv, uint8_t *buf, int maxlen);
982 int (*read_end)(void *priv);
983 int (*close)(void *priv);
984 void (*free)(void *priv);
985 unsigned int read_timeout_ms;
986 void *priv;
987};
988
989SR_PRIV GSList *sr_modbus_scan(struct drv_context *drvc, GSList *options,
990 struct sr_dev_inst *(*probe_device)(struct sr_modbus_dev_inst *modbus));
991SR_PRIV struct sr_modbus_dev_inst *modbus_dev_inst_new(const char *resource,
992 const char *serialcomm, int modbusaddr);
993SR_PRIV int sr_modbus_open(struct sr_modbus_dev_inst *modbus);
994SR_PRIV int sr_modbus_source_add(struct sr_session *session,
995 struct sr_modbus_dev_inst *modbus, int events, int timeout,
996 sr_receive_data_callback cb, void *cb_data);
997SR_PRIV int sr_modbus_source_remove(struct sr_session *session,
998 struct sr_modbus_dev_inst *modbus);
999SR_PRIV int sr_modbus_request(struct sr_modbus_dev_inst *modbus,
1000 uint8_t *request, int request_size);
1001SR_PRIV int sr_modbus_reply(struct sr_modbus_dev_inst *modbus,
1002 uint8_t *reply, int reply_size);
1003SR_PRIV int sr_modbus_request_reply(struct sr_modbus_dev_inst *modbus,
1004 uint8_t *request, int request_size,
1005 uint8_t *reply, int reply_size);
1006SR_PRIV int sr_modbus_read_coils(struct sr_modbus_dev_inst *modbus,
1007 int address, int nb_coils, uint8_t *coils);
1008SR_PRIV int sr_modbus_read_holding_registers(struct sr_modbus_dev_inst *modbus,
1009 int address, int nb_registers,
1010 uint16_t *registers);
1011SR_PRIV int sr_modbus_write_coil(struct sr_modbus_dev_inst *modbus,
1012 int address, int value);
1013SR_PRIV int sr_modbus_write_multiple_registers(struct sr_modbus_dev_inst*modbus,
1014 int address, int nb_registers,
1015 uint16_t *registers);
1016SR_PRIV int sr_modbus_close(struct sr_modbus_dev_inst *modbus);
1017SR_PRIV void sr_modbus_free(struct sr_modbus_dev_inst *modbus);
1018
3ea46116 1019/*--- hardware/dmm/es519xx.c ------------------------------------------------*/
c01bdebc 1020
bfb926c1
AJ
1021/**
1022 * All 11-byte es519xx chips repeat each block twice for each conversion cycle
1023 * so always read 2 blocks at a time.
1024 */
1025#define ES519XX_11B_PACKET_SIZE (11 * 2)
72e1672f 1026#define ES519XX_14B_PACKET_SIZE 14
c01bdebc
AJ
1027
1028struct es519xx_info {
1029 gboolean is_judge, is_voltage, is_auto, is_micro, is_current;
1030 gboolean is_milli, is_resistance, is_continuity, is_diode;
1031 gboolean is_frequency, is_rpm, is_capacitance, is_duty_cycle;
1032 gboolean is_temperature, is_celsius, is_fahrenheit;
1033 gboolean is_adp0, is_adp1, is_adp2, is_adp3;
1034 gboolean is_sign, is_batt, is_ol, is_pmax, is_pmin, is_apo;
1035 gboolean is_dc, is_ac, is_vahz, is_min, is_max, is_rel, is_hold;
1036 gboolean is_digit4, is_ul, is_vasel, is_vbar, is_lpf1, is_lpf0, is_rmr;
1037 uint32_t baudrate;
1038 int packet_size;
1039 gboolean alt_functions, fivedigits, clampmeter, selectable_lpf;
1040};
1041
72e1672f
UH
1042SR_PRIV gboolean sr_es519xx_2400_11b_packet_valid(const uint8_t *buf);
1043SR_PRIV int sr_es519xx_2400_11b_parse(const uint8_t *buf, float *floatval,
1044 struct sr_datafeed_analog *analog, void *info);
2588e50c
AJ
1045SR_PRIV gboolean sr_es519xx_2400_11b_altfn_packet_valid(const uint8_t *buf);
1046SR_PRIV int sr_es519xx_2400_11b_altfn_parse(const uint8_t *buf,
1047 float *floatval, struct sr_datafeed_analog *analog, void *info);
72e1672f 1048SR_PRIV gboolean sr_es519xx_19200_11b_5digits_packet_valid(const uint8_t *buf);
93d719cd 1049SR_PRIV int sr_es519xx_19200_11b_5digits_parse(const uint8_t *buf,
72e1672f
UH
1050 float *floatval, struct sr_datafeed_analog *analog, void *info);
1051SR_PRIV gboolean sr_es519xx_19200_11b_clamp_packet_valid(const uint8_t *buf);
1052SR_PRIV int sr_es519xx_19200_11b_clamp_parse(const uint8_t *buf,
1053 float *floatval, struct sr_datafeed_analog *analog, void *info);
1054SR_PRIV gboolean sr_es519xx_19200_11b_packet_valid(const uint8_t *buf);
1055SR_PRIV int sr_es519xx_19200_11b_parse(const uint8_t *buf, float *floatval,
1056 struct sr_datafeed_analog *analog, void *info);
1057SR_PRIV gboolean sr_es519xx_19200_14b_packet_valid(const uint8_t *buf);
1058SR_PRIV int sr_es519xx_19200_14b_parse(const uint8_t *buf, float *floatval,
1059 struct sr_datafeed_analog *analog, void *info);
1060SR_PRIV gboolean sr_es519xx_19200_14b_sel_lpf_packet_valid(const uint8_t *buf);
1061SR_PRIV int sr_es519xx_19200_14b_sel_lpf_parse(const uint8_t *buf,
1062 float *floatval, struct sr_datafeed_analog *analog, void *info);
c01bdebc 1063
3ea46116 1064/*--- hardware/dmm/fs9922.c -------------------------------------------------*/
79081ec8 1065
913abe83
UH
1066#define FS9922_PACKET_SIZE 14
1067
1068struct fs9922_info {
1069 gboolean is_auto, is_dc, is_ac, is_rel, is_hold, is_bpn, is_z1, is_z2;
1070 gboolean is_max, is_min, is_apo, is_bat, is_nano, is_z3, is_micro;
1071 gboolean is_milli, is_kilo, is_mega, is_beep, is_diode, is_percent;
1072 gboolean is_z4, is_volt, is_ampere, is_ohm, is_hfe, is_hertz, is_farad;
1073 gboolean is_celsius, is_fahrenheit;
1074 int bargraph_sign, bargraph_value;
1075};
1076
913abe83
UH
1077SR_PRIV gboolean sr_fs9922_packet_valid(const uint8_t *buf);
1078SR_PRIV int sr_fs9922_parse(const uint8_t *buf, float *floatval,
1079 struct sr_datafeed_analog *analog, void *info);
e52bb9be 1080SR_PRIV void sr_fs9922_z1_diode(struct sr_datafeed_analog *analog, void *info);
79081ec8 1081
3ea46116 1082/*--- hardware/dmm/fs9721.c -------------------------------------------------*/
6c701476 1083
8c1adf37
UH
1084#define FS9721_PACKET_SIZE 14
1085
1086struct fs9721_info {
1087 gboolean is_ac, is_dc, is_auto, is_rs232, is_micro, is_nano, is_kilo;
1088 gboolean is_diode, is_milli, is_percent, is_mega, is_beep, is_farad;
1089 gboolean is_ohm, is_rel, is_hold, is_ampere, is_volt, is_hz, is_bat;
1090 gboolean is_c2c1_11, is_c2c1_10, is_c2c1_01, is_c2c1_00, is_sign;
1091};
1092
8c1adf37
UH
1093SR_PRIV gboolean sr_fs9721_packet_valid(const uint8_t *buf);
1094SR_PRIV int sr_fs9721_parse(const uint8_t *buf, float *floatval,
93357bc3 1095 struct sr_datafeed_analog *analog, void *info);
2451a20f
UH
1096SR_PRIV void sr_fs9721_00_temp_c(struct sr_datafeed_analog *analog, void *info);
1097SR_PRIV void sr_fs9721_01_temp_c(struct sr_datafeed_analog *analog, void *info);
1098SR_PRIV void sr_fs9721_10_temp_c(struct sr_datafeed_analog *analog, void *info);
1099SR_PRIV void sr_fs9721_01_10_temp_f_c(struct sr_datafeed_analog *analog, void *info);
d327972b 1100SR_PRIV void sr_fs9721_max_c_min(struct sr_datafeed_analog *analog, void *info);
6c701476 1101
3ea46116 1102/*--- hardware/dmm/m2110.c --------------------------------------------------*/
825da8b2
MH
1103
1104#define BBCGM_M2110_PACKET_SIZE 9
1105
1106SR_PRIV gboolean sr_m2110_packet_valid(const uint8_t *buf);
1107SR_PRIV int sr_m2110_parse(const uint8_t *buf, float *floatval,
1108 struct sr_datafeed_analog *analog, void *info);
1109
3ea46116 1110/*--- hardware/dmm/metex14.c ------------------------------------------------*/
ac913e5c
UH
1111
1112#define METEX14_PACKET_SIZE 14
1113
1114struct metex14_info {
1115 gboolean is_ac, is_dc, is_resistance, is_capacity, is_temperature;
1116 gboolean is_diode, is_frequency, is_ampere, is_volt, is_farad;
c02dc3e2
UH
1117 gboolean is_hertz, is_ohm, is_celsius, is_pico, is_nano, is_micro;
1118 gboolean is_milli, is_kilo, is_mega, is_gain, is_decibel, is_hfe;
e83437ae 1119 gboolean is_unitless, is_logic;
ac913e5c
UH
1120};
1121
c4f2dfd0 1122#ifdef HAVE_LIBSERIALPORT
ce3777ad 1123SR_PRIV int sr_metex14_packet_request(struct sr_serial_dev_inst *serial);
c4f2dfd0 1124#endif
ac913e5c
UH
1125SR_PRIV gboolean sr_metex14_packet_valid(const uint8_t *buf);
1126SR_PRIV int sr_metex14_parse(const uint8_t *buf, float *floatval,
1fbab466 1127 struct sr_datafeed_analog *analog, void *info);
ac913e5c 1128
3ea46116 1129/*--- hardware/dmm/rs9lcd.c -------------------------------------------------*/
05f134ab 1130
21829e67 1131#define RS9LCD_PACKET_SIZE 9
05f134ab 1132
e7ed87a4 1133/* Dummy info struct. The parser does not use it. */
bf6f8399 1134struct rs9lcd_info { int dummy; };
e7ed87a4 1135
05f134ab
AG
1136SR_PRIV gboolean sr_rs9lcd_packet_valid(const uint8_t *buf);
1137SR_PRIV int sr_rs9lcd_parse(const uint8_t *buf, float *floatval,
1138 struct sr_datafeed_analog *analog, void *info);
1139
3ea46116 1140/*--- hardware/dmm/bm25x.c --------------------------------------------------*/
a24c3f4a
JH
1141
1142#define BRYMEN_BM25X_PACKET_SIZE 15
1143
1144/* Dummy info struct. The parser does not use it. */
1145struct bm25x_info { int dummy; };
1146
1147SR_PRIV gboolean sr_brymen_bm25x_packet_valid(const uint8_t *buf);
1148SR_PRIV int sr_brymen_bm25x_parse(const uint8_t *buf, float *floatval,
1149 struct sr_datafeed_analog *analog, void *info);
1150
626027df
UH
1151/*--- hardware/dmm/ut71x.c --------------------------------------------------*/
1152
1153#define UT71X_PACKET_SIZE 11
1154
1155struct ut71x_info {
1156 gboolean is_voltage, is_resistance, is_capacitance, is_temperature;
1157 gboolean is_celsius, is_fahrenheit, is_current, is_continuity;
1158 gboolean is_diode, is_frequency, is_duty_cycle, is_dc, is_ac;
1159 gboolean is_auto, is_manual, is_sign, is_power, is_loop_current;
1160};
1161
1162SR_PRIV gboolean sr_ut71x_packet_valid(const uint8_t *buf);
1163SR_PRIV int sr_ut71x_parse(const uint8_t *buf, float *floatval,
1164 struct sr_datafeed_analog *analog, void *info);
1165
c36f78f7
UH
1166/*--- hardware/dmm/vc870.c --------------------------------------------------*/
1167
1168#define VC870_PACKET_SIZE 23
1169
1170struct vc870_info {
1171 gboolean is_voltage, is_dc, is_ac, is_temperature, is_resistance;
1172 gboolean is_continuity, is_capacitance, is_diode, is_loop_current;
1173 gboolean is_current, is_micro, is_milli, is_power;
1174 gboolean is_power_factor_freq, is_power_apparent_power, is_v_a_eff_value;
1175 gboolean is_sign2, is_sign1, is_batt, is_ol1, is_max, is_min;
1176 gboolean is_maxmin, is_rel, is_ol2, is_open, is_manu, is_hold;
1177 gboolean is_light, is_usb, is_warning, is_auto_power, is_misplug_warn;
1178 gboolean is_lo, is_hi, is_open2;
1179
1180 gboolean is_frequency, is_dual_display, is_auto, is_rms;
1181};
1182
1183SR_PRIV gboolean sr_vc870_packet_valid(const uint8_t *buf);
1184SR_PRIV int sr_vc870_parse(const uint8_t *buf, float *floatval,
1185 struct sr_datafeed_analog *analog, void *info);
1186
3ea46116 1187/*--- hardware/lcr/es51919.c ------------------------------------------------*/
6bcb3ee8
JH
1188
1189SR_PRIV void es51919_serial_clean(void *priv);
1190SR_PRIV struct sr_dev_inst *es51919_serial_scan(GSList *options,
1191 const char *vendor,
1192 const char *model);
1193SR_PRIV int es51919_serial_config_get(uint32_t key, GVariant **data,
1194 const struct sr_dev_inst *sdi,
1195 const struct sr_channel_group *cg);
1196SR_PRIV int es51919_serial_config_set(uint32_t key, GVariant *data,
1197 const struct sr_dev_inst *sdi,
1198 const struct sr_channel_group *cg);
1199SR_PRIV int es51919_serial_config_list(uint32_t key, GVariant **data,
1200 const struct sr_dev_inst *sdi,
1201 const struct sr_channel_group *cg);
1202SR_PRIV int es51919_serial_acquisition_start(const struct sr_dev_inst *sdi,
1203 void *cb_data);
1204SR_PRIV int es51919_serial_acquisition_stop(struct sr_dev_inst *sdi,
1205 void *cb_data);
1206
f3cde309
ML
1207/*--- hardware/dmm/ut372.c --------------------------------------------------*/
1208
1209#define UT372_PACKET_SIZE 27
1210
1211struct ut372_info {
1212 int dummy;
1213};
1214
1215SR_PRIV gboolean sr_ut372_packet_valid(const uint8_t *buf);
1216SR_PRIV int sr_ut372_parse(const uint8_t *buf, float *floatval,
1217 struct sr_datafeed_analog *analog, void *info);
1218
1483577e 1219#endif