]> sigrok.org Git - libsigrok.git/blob - src/libsigrok-internal.h
a045b57eada2d24da9d403439213567d7391e3eb
[libsigrok.git] / src / libsigrok-internal.h
1 /*
2  * This file is part of the libsigrok project.
3  *
4  * Copyright (C) 2013 Bert Vermeulen <bert@biot.com>
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
20 /** @file
21   * @internal
22   */
23
24 #ifndef LIBSIGROK_LIBSIGROK_INTERNAL_H
25 #define LIBSIGROK_LIBSIGROK_INTERNAL_H
26
27 #include <stdarg.h>
28 #include <stdio.h>
29 #include <glib.h>
30 #ifdef HAVE_LIBUSB_1_0
31 #include <libusb.h>
32 #endif
33 #ifdef HAVE_LIBSERIALPORT
34 #include <libserialport.h>
35 #endif
36
37 struct zip;
38 struct zip_stat;
39
40 /**
41  * @file
42  *
43  * libsigrok private header file, only to be used internally.
44  */
45
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
56 /**
57  * Read a 8 bits unsigned integer out of memory.
58  * @param x a pointer to the input memory
59  * @return the corresponding unsigned integer
60  */
61 #define R8(x)     ((unsigned)((const uint8_t*)(x))[0])
62
63 /**
64  * Read a 16 bits big endian unsigned integer out of memory.
65  * @param x a pointer to the input memory
66  * @return the corresponding unsigned integer
67  */
68 #define RB16(x)  (((unsigned)((const uint8_t*)(x))[0] <<  8) | \
69                    (unsigned)((const uint8_t*)(x))[1])
70
71 /**
72  * Read a 16 bits little endian unsigned integer out of memory.
73  * @param x a pointer to the input memory
74  * @return the corresponding unsigned integer
75  */
76 #define RL16(x)  (((unsigned)((const uint8_t*)(x))[1] <<  8) | \
77                    (unsigned)((const uint8_t*)(x))[0])
78
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
88 /**
89  * Read a 16 bits little endian signed integer out of memory.
90  * @param x a pointer to the input memory
91  * @return the corresponding signed integer
92  */
93 #define RL16S(x)  ((int16_t) \
94                   (((unsigned)((const uint8_t*)(x))[1] <<  8) | \
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
101  */
102 #define RB32(x)  (((unsigned)((const uint8_t*)(x))[0] << 24) | \
103                   ((unsigned)((const uint8_t*)(x))[1] << 16) | \
104                   ((unsigned)((const uint8_t*)(x))[2] <<  8) | \
105                    (unsigned)((const uint8_t*)(x))[3])
106
107 /**
108  * Read a 32 bits little endian unsigned integer out of memory.
109  * @param x a pointer to the input memory
110  * @return the corresponding unsigned integer
111  */
112 #define RL32(x)  (((unsigned)((const uint8_t*)(x))[3] << 24) | \
113                   ((unsigned)((const uint8_t*)(x))[2] << 16) | \
114                   ((unsigned)((const uint8_t*)(x))[1] <<  8) | \
115                    (unsigned)((const uint8_t*)(x))[0])
116
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
128 /**
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) | \
135                   ((unsigned)((const uint8_t*)(x))[2] << 16) | \
136                   ((unsigned)((const uint8_t*)(x))[1] <<  8) | \
137                    (unsigned)((const uint8_t*)(x))[0]))
138
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) | \
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) | \
151                    (uint64_t)((const uint8_t*)(x))[7])
152
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
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
196 /**
197  * Write a 8 bits unsigned integer to memory.
198  * @param p a pointer to the output memory
199  * @param x the input unsigned integer
200  */
201 #define W8(p, x)    do { ((uint8_t*)(p))[0] = (uint8_t) (x);      } while (0)
202
203 /**
204  * Write a 16 bits unsigned integer to memory stored as big endian.
205  * @param p a pointer to the output memory
206  * @param x the input unsigned integer
207  */
208 #define WB16(p, x)  do { ((uint8_t*)(p))[1] = (uint8_t) (x);      \
209                          ((uint8_t*)(p))[0] = (uint8_t)((x)>>8);  } while (0)
210
211 /**
212  * Write a 16 bits unsigned integer to memory stored as little endian.
213  * @param p a pointer to the output memory
214  * @param x the input unsigned integer
215  */
216 #define WL16(p, x)  do { ((uint8_t*)(p))[0] = (uint8_t) (x);      \
217                          ((uint8_t*)(p))[1] = (uint8_t)((x)>>8);  } while (0)
218
219 /**
220  * Write a 32 bits unsigned integer to memory stored as big endian.
221  * @param p a pointer to the output memory
222  * @param x the input unsigned integer
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); \
227                          ((uint8_t*)(p))[0] = (uint8_t)((x)>>24); } while (0)
228
229 /**
230  * Write a 32 bits unsigned integer to memory stored as little endian.
231  * @param p a pointer to the output memory
232  * @param x the input unsigned integer
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); \
237                          ((uint8_t*)(p))[3] = (uint8_t)((x)>>24); } while (0)
238
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
253 /* Portability fixes for FreeBSD. */
254 #ifdef __FreeBSD__
255 #define LIBUSB_CLASS_APPLICATION 0xfe
256 #define libusb_has_capability(x) 0
257 #define libusb_handle_events_timeout_completed(ctx, tv, c) \
258         libusb_handle_events_timeout(ctx, tv)
259 #endif
260
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
270 struct sr_context {
271         struct sr_dev_driver **driver_list;
272 #ifdef HAVE_LIBUSB_1_0
273         libusb_context *libusb_ctx;
274 #endif
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;
279 };
280
281 /** Input module metadata keys. */
282 enum 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,
289
290         /** The module cannot identify a file without this metadata. */
291         SR_INPUT_META_REQUIRED = 0x80,
292 };
293
294 /** Input (file) module struct. */
295 struct sr_input {
296         /**
297          * A pointer to this input module's 'struct sr_input_module'.
298          */
299         const struct sr_input_module *module;
300         GString *buf;
301         struct sr_dev_inst *sdi;
302         gboolean sdi_ready;
303         void *priv;
304 };
305
306 /** Input (file) module driver. */
307 struct sr_input_module {
308         /**
309          * A unique ID for this input module, suitable for use in command-line
310          * clients, [a-z0-9-]. Must not be NULL.
311          */
312         const char *id;
313
314         /**
315          * A unique name for this input module, suitable for use in GUI
316          * clients, can contain UTF-8. Must not be NULL.
317          */
318         const char *name;
319
320         /**
321          * A short description of the input module. Must not be NULL.
322          *
323          * This can be displayed by frontends, e.g. when selecting the input
324          * module for saving a file.
325          */
326         const char *desc;
327
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
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
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          */
354         const struct sr_option *(*options) (void);
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.
360          *
361          * @retval SR_OK This module knows the format.
362          * @retval SR_ERR_NA There wasn't enough data for this module to
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.
368          */
369         int (*format_match) (GHashTable *metadata);
370
371         /**
372          * Initialize the input module.
373          *
374          * @retval SR_OK Success
375          * @retval other Negative error code.
376          */
377         int (*init) (struct sr_input *in, GHashTable *options);
378
379         /**
380          * Send data to the specified input instance.
381          *
382          * When an input module instance is created with sr_input_new(), this
383          * function is used to feed data to the instance.
384          *
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.
390          *
391          * @retval SR_OK Success
392          * @retval other Negative error code.
393          */
394         int (*receive) (struct sr_input *in, GString *buf);
395
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          */
402         int (*end) (struct sr_input *in);
403
404         /**
405          * This function is called after the caller is finished using
406          * the input module, and can be used to free any internal
407          * resources the module may keep.
408          *
409          * This function is optional.
410          *
411          * @retval SR_OK Success
412          * @retval other Negative error code.
413          */
414         void (*cleanup) (struct sr_input *in);
415 };
416
417 /** Output module instance. */
418 struct sr_output {
419         /** A pointer to this output's module.  */
420         const struct sr_output_module *module;
421
422         /**
423          * The device for which this output module is creating output. This
424          * can be used by the module to find out channel names and numbers.
425          */
426         const struct sr_dev_inst *sdi;
427
428         /**
429          * The name of the file that the data should be written to.
430          */
431         const char *filename;
432
433         /**
434          * A generic pointer which can be used by the module to keep internal
435          * state between calls into its callback functions.
436          *
437          * For example, the module might store a pointer to a chunk of output
438          * there, and only flush it when it reaches a certain size.
439          */
440         void *priv;
441 };
442
443 /** Output module driver. */
444 struct sr_output_module {
445         /**
446          * A unique ID for this output module, suitable for use in command-line
447          * clients, [a-z0-9-]. Must not be NULL.
448          */
449         const char *id;
450
451         /**
452          * A unique name for this output module, suitable for use in GUI
453          * clients, can contain UTF-8. Must not be NULL.
454          */
455         const char *name;
456
457         /**
458          * A short description of the output module. Must not be NULL.
459          *
460          * This can be displayed by frontends, e.g. when selecting the output
461          * module for saving a file.
462          */
463         const char *desc;
464
465         /**
466          * A NULL terminated array of strings containing a list of file name
467          * extensions typical for the input file format, or NULL if there is
468          * no typical extension for this file format.
469          */
470         const char *const *exts;
471
472         /**
473          * Bitfield containing flags that describe certain properties
474          * this output module may or may not have.
475          * @see sr_output_flags
476          */
477         const uint64_t flags;
478
479         /**
480          * Returns a NULL-terminated list of options this module can take.
481          * Can be NULL, if the module has no options.
482          */
483         const struct sr_option *(*options) (void);
484
485         /**
486          * This function is called once, at the beginning of an output stream.
487          *
488          * The device struct will be available in the output struct passed in,
489          * as well as the param field -- which may be NULL or an empty string,
490          * if no parameter was passed.
491          *
492          * The module can use this to initialize itself, create a struct for
493          * keeping state and storing it in the <code>internal</code> field.
494          *
495          * @param o Pointer to the respective 'struct sr_output'.
496          *
497          * @retval SR_OK Success
498          * @retval other Negative error code.
499          */
500         int (*init) (struct sr_output *o, GHashTable *options);
501
502         /**
503          * This function is passed a copy of every packet in the data feed.
504          * Any output generated by the output module in response to the
505          * packet should be returned in a newly allocated GString
506          * <code>out</code>, which will be freed by the caller.
507          *
508          * Packets not of interest to the output module can just be ignored,
509          * and the <code>out</code> parameter set to NULL.
510          *
511          * @param o Pointer to the respective 'struct sr_output'.
512          * @param sdi The device instance that generated the packet.
513          * @param packet The complete packet.
514          * @param out A pointer where a GString * should be stored if
515          * the module generates output, or NULL if not.
516          *
517          * @retval SR_OK Success
518          * @retval other Negative error code.
519          */
520         int (*receive) (const struct sr_output *o,
521                         const struct sr_datafeed_packet *packet, GString **out);
522
523         /**
524          * This function is called after the caller is finished using
525          * the output module, and can be used to free any internal
526          * resources the module may keep.
527          *
528          * @retval SR_OK Success
529          * @retval other Negative error code.
530          */
531         int (*cleanup) (struct sr_output *o);
532 };
533
534 /** Transform module instance. */
535 struct sr_transform {
536         /** A pointer to this transform's module.  */
537         const struct sr_transform_module *module;
538
539         /**
540          * The device for which this transform module is used. This
541          * can be used by the module to find out channel names and numbers.
542          */
543         const struct sr_dev_inst *sdi;
544
545         /**
546          * A generic pointer which can be used by the module to keep internal
547          * state between calls into its callback functions.
548          */
549         void *priv;
550 };
551
552 struct sr_transform_module {
553         /**
554          * A unique ID for this transform module, suitable for use in
555          * command-line clients, [a-z0-9-]. Must not be NULL.
556          */
557         const char *id;
558
559         /**
560          * A unique name for this transform module, suitable for use in GUI
561          * clients, can contain UTF-8. Must not be NULL.
562          */
563         const char *name;
564
565         /**
566          * A short description of the transform module. Must not be NULL.
567          *
568          * This can be displayed by frontends, e.g. when selecting
569          * which transform module(s) to add.
570          */
571         const char *desc;
572
573         /**
574          * Returns a NULL-terminated list of options this transform module
575          * can take. Can be NULL, if the transform module has no options.
576          */
577         const struct sr_option *(*options) (void);
578
579         /**
580          * This function is called once, at the beginning of a stream.
581          *
582          * @param t Pointer to the respective 'struct sr_transform'.
583          * @param options Hash table of options for this transform module.
584          *                Can be NULL if no options are to be used.
585          *
586          * @retval SR_OK Success
587          * @retval other Negative error code.
588          */
589         int (*init) (struct sr_transform *t, GHashTable *options);
590
591         /**
592          * This function is passed a pointer to every packet in the data feed.
593          *
594          * It can either return (in packet_out) a pointer to another packet
595          * (possibly the exact same packet it got as input), or NULL.
596          *
597          * @param t Pointer to the respective 'struct sr_transform'.
598          * @param packet_in Pointer to a datafeed packet.
599          * @param packet_out Pointer to the resulting datafeed packet after
600          *                   this function was run. If NULL, the transform
601          *                   module intentionally didn't output a new packet.
602          *
603          * @retval SR_OK Success
604          * @retval other Negative error code.
605          */
606         int (*receive) (const struct sr_transform *t,
607                         struct sr_datafeed_packet *packet_in,
608                         struct sr_datafeed_packet **packet_out);
609
610         /**
611          * This function is called after the caller is finished using
612          * the transform module, and can be used to free any internal
613          * resources the module may keep.
614          *
615          * @retval SR_OK Success
616          * @retval other Negative error code.
617          */
618         int (*cleanup) (struct sr_transform *t);
619 };
620
621 #ifdef HAVE_LIBUSB_1_0
622 /** USB device instance */
623 struct sr_usb_dev_inst {
624         /** USB bus */
625         uint8_t bus;
626         /** Device address on USB bus */
627         uint8_t address;
628         /** libusb device handle */
629         struct libusb_device_handle *devhdl;
630 };
631 #endif
632
633 #ifdef HAVE_LIBSERIALPORT
634 struct sr_serial_dev_inst {
635         /** Port name, e.g. '/dev/tty42'. */
636         char *port;
637         /** Comm params for serial_set_paramstr(). */
638         char *serialcomm;
639         /** libserialport port handle */
640         struct sp_port *data;
641 };
642 #endif
643
644 struct sr_usbtmc_dev_inst {
645         char *device;
646         int fd;
647 };
648
649 /* Private driver context. */
650 struct drv_context {
651         /** sigrok context */
652         struct sr_context *sr_ctx;
653         GSList *instances;
654 };
655
656 /*--- log.c -----------------------------------------------------------------*/
657
658 #if defined(G_OS_WIN32) && (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 4))
659 /*
660  * On MinGW, we need to specify the gnu_printf format flavor or GCC
661  * will assume non-standard Microsoft printf syntax.
662  */
663 SR_PRIV int sr_log(int loglevel, const char *format, ...)
664                 __attribute__((__format__ (__gnu_printf__, 2, 3)));
665 #else
666 SR_PRIV int sr_log(int loglevel, const char *format, ...) G_GNUC_PRINTF(2, 3);
667 #endif
668
669 /* Message logging helpers with subsystem-specific prefix string. */
670 #define sr_spew(...)    sr_log(SR_LOG_SPEW, LOG_PREFIX ": " __VA_ARGS__)
671 #define sr_dbg(...)     sr_log(SR_LOG_DBG,  LOG_PREFIX ": " __VA_ARGS__)
672 #define sr_info(...)    sr_log(SR_LOG_INFO, LOG_PREFIX ": " __VA_ARGS__)
673 #define sr_warn(...)    sr_log(SR_LOG_WARN, LOG_PREFIX ": " __VA_ARGS__)
674 #define sr_err(...)     sr_log(SR_LOG_ERR,  LOG_PREFIX ": " __VA_ARGS__)
675
676 /*--- device.c --------------------------------------------------------------*/
677
678 /** Scan options supported by a driver. */
679 #define SR_CONF_SCAN_OPTIONS 0x7FFF0000
680
681 /** Device options for a particular device. */
682 #define SR_CONF_DEVICE_OPTIONS 0x7FFF0001
683
684 /** Mask for separating config keys from capabilities. */
685 #define SR_CONF_MASK 0x1fffffff
686
687 /** Values for the changes argument of sr_dev_driver.config_channel_set. */
688 enum {
689         /** The enabled state of the channel has been changed. */
690         SR_CHANNEL_SET_ENABLED = 1 << 0,
691 };
692
693 SR_PRIV struct sr_channel *sr_channel_new(struct sr_dev_inst *sdi,
694                 int index, int type, gboolean enabled, const char *name);
695 SR_PRIV struct sr_channel *sr_next_enabled_channel(const struct sr_dev_inst *sdi,
696                 struct sr_channel *cur_channel);
697
698 /** Device instance data */
699 struct sr_dev_inst {
700         /** Device driver. */
701         struct sr_dev_driver *driver;
702         /** Device instance status. SR_ST_NOT_FOUND, etc. */
703         int status;
704         /** Device instance type. SR_INST_USB, etc. */
705         int inst_type;
706         /** Device vendor. */
707         char *vendor;
708         /** Device model. */
709         char *model;
710         /** Device version. */
711         char *version;
712         /** Serial number. */
713         char *serial_num;
714         /** Connection string to uniquely identify devices. */
715         char *connection_id;
716         /** List of channels. */
717         GSList *channels;
718         /** List of sr_channel_group structs */
719         GSList *channel_groups;
720         /** Device instance connection data (used?) */
721         void *conn;
722         /** Device instance private data (used?) */
723         void *priv;
724         /** Session to which this device is currently assigned. */
725         struct sr_session *session;
726 };
727
728 /* Generic device instances */
729 SR_PRIV void sr_dev_inst_free(struct sr_dev_inst *sdi);
730
731 #ifdef HAVE_LIBUSB_1_0
732 /* USB-specific instances */
733 SR_PRIV struct sr_usb_dev_inst *sr_usb_dev_inst_new(uint8_t bus,
734                 uint8_t address, struct libusb_device_handle *hdl);
735 SR_PRIV void sr_usb_dev_inst_free(struct sr_usb_dev_inst *usb);
736 #endif
737
738 #ifdef HAVE_LIBSERIALPORT
739 /* Serial-specific instances */
740 SR_PRIV struct sr_serial_dev_inst *sr_serial_dev_inst_new(const char *port,
741                 const char *serialcomm);
742 SR_PRIV void sr_serial_dev_inst_free(struct sr_serial_dev_inst *serial);
743 #endif
744
745 /* USBTMC-specific instances */
746 SR_PRIV struct sr_usbtmc_dev_inst *sr_usbtmc_dev_inst_new(const char *device);
747 SR_PRIV void sr_usbtmc_dev_inst_free(struct sr_usbtmc_dev_inst *usbtmc);
748
749 /*--- hwdriver.c ------------------------------------------------------------*/
750
751 extern SR_PRIV struct sr_dev_driver **drivers_lists[];
752
753 SR_PRIV const GVariantType *sr_variant_type_get(int datatype);
754 SR_PRIV int sr_variant_type_check(uint32_t key, GVariant *data);
755 SR_PRIV void sr_hw_cleanup_all(const struct sr_context *ctx);
756 SR_PRIV struct sr_config *sr_config_new(uint32_t key, GVariant *data);
757 SR_PRIV void sr_config_free(struct sr_config *src);
758
759 /*--- session.c -------------------------------------------------------------*/
760
761 struct sr_session {
762         /** Context this session exists in. */
763         struct sr_context *ctx;
764         /** List of struct sr_dev_inst pointers. */
765         GSList *devs;
766         /** List of struct sr_dev_inst pointers owned by this session. */
767         GSList *owned_devs;
768         /** List of struct datafeed_callback pointers. */
769         GSList *datafeed_callbacks;
770         GSList *transforms;
771         struct sr_trigger *trigger;
772
773         /** Callback to invoke on session stop. */
774         sr_session_stopped_callback stopped_callback;
775         /** User data to be passed to the session stop callback. */
776         void *stopped_cb_data;
777
778         /** Mutex protecting the main context pointer. */
779         GMutex main_mutex;
780         /** Context of the session main loop. */
781         GMainContext *main_context;
782
783         /** Registered event sources for this session. */
784         GHashTable *event_sources;
785         /** Session main loop. */
786         GMainLoop *main_loop;
787         /** ID of idle source for dispatching the session stop notification. */
788         unsigned int stop_check_id;
789         /** Whether the session has been started. */
790         gboolean running;
791 };
792
793 SR_PRIV int sr_session_source_add_internal(struct sr_session *session,
794                 void *key, GSource *source);
795 SR_PRIV int sr_session_source_remove_internal(struct sr_session *session,
796                 void *key);
797 SR_PRIV int sr_session_source_destroyed(struct sr_session *session,
798                 void *key, GSource *source);
799 SR_PRIV int sr_session_fd_source_add(struct sr_session *session,
800                 void *key, gintptr fd, int events, int timeout,
801                 sr_receive_data_callback cb, void *cb_data);
802
803 SR_PRIV int sr_session_source_add(struct sr_session *session, int fd,
804                 int events, int timeout, sr_receive_data_callback cb, void *cb_data);
805 SR_PRIV int sr_session_source_add_pollfd(struct sr_session *session,
806                 GPollFD *pollfd, int timeout, sr_receive_data_callback cb,
807                 void *cb_data);
808 SR_PRIV int sr_session_source_add_channel(struct sr_session *session,
809                 GIOChannel *channel, int events, int timeout,
810                 sr_receive_data_callback cb, void *cb_data);
811 SR_PRIV int sr_session_source_remove(struct sr_session *session, int fd);
812 SR_PRIV int sr_session_source_remove_pollfd(struct sr_session *session,
813                 GPollFD *pollfd);
814 SR_PRIV int sr_session_source_remove_channel(struct sr_session *session,
815                 GIOChannel *channel);
816
817 SR_PRIV int sr_session_send(const struct sr_dev_inst *sdi,
818                 const struct sr_datafeed_packet *packet);
819 SR_PRIV int sr_sessionfile_check(const char *filename);
820 SR_PRIV int sr_packet_copy(const struct sr_datafeed_packet *packet,
821                 struct sr_datafeed_packet **copy);
822 SR_PRIV void sr_packet_free(struct sr_datafeed_packet *packet);
823
824 /*--- session_file.c --------------------------------------------------------*/
825
826 #if !HAVE_ZIP_DISCARD
827 /* Replace zip_discard() if not available. */
828 #define zip_discard(zip) sr_zip_discard(zip)
829 SR_PRIV void sr_zip_discard(struct zip *archive);
830 #endif
831
832 SR_PRIV GKeyFile *sr_sessionfile_read_metadata(struct zip *archive,
833                         const struct zip_stat *entry);
834
835 /*--- analog.c --------------------------------------------------------------*/
836
837 SR_PRIV int sr_analog_init(struct sr_datafeed_analog *analog,
838                            struct sr_analog_encoding *encoding,
839                            struct sr_analog_meaning *meaning,
840                            struct sr_analog_spec *spec,
841                            int digits);
842
843 /*--- std.c -----------------------------------------------------------------*/
844
845 typedef int (*dev_close_callback)(struct sr_dev_inst *sdi);
846 typedef void (*std_dev_clear_callback)(void *priv);
847
848 SR_PRIV int std_init(struct sr_context *sr_ctx, struct sr_dev_driver *di,
849                 const char *prefix);
850 #ifdef HAVE_LIBSERIALPORT
851 SR_PRIV int std_serial_dev_open(struct sr_dev_inst *sdi);
852 SR_PRIV int std_serial_dev_acquisition_stop(struct sr_dev_inst *sdi,
853                 void *cb_data, dev_close_callback dev_close_fn,
854                 struct sr_serial_dev_inst *serial, const char *prefix);
855 #endif
856 SR_PRIV int std_session_send_df_header(const struct sr_dev_inst *sdi,
857                 const char *prefix);
858 SR_PRIV int std_dev_clear(const struct sr_dev_driver *driver,
859                 std_dev_clear_callback clear_private);
860 SR_PRIV int std_serial_dev_close(struct sr_dev_inst *sdi);
861
862 /*--- resource.c ------------------------------------------------------------*/
863
864 SR_PRIV int64_t sr_file_get_size(FILE *file);
865
866 SR_PRIV int sr_resource_open(struct sr_context *ctx,
867                 struct sr_resource *res, int type, const char *name)
868                 G_GNUC_WARN_UNUSED_RESULT;
869 SR_PRIV int sr_resource_close(struct sr_context *ctx,
870                 struct sr_resource *res);
871 SR_PRIV ssize_t sr_resource_read(struct sr_context *ctx,
872                 const struct sr_resource *res, void *buf, size_t count)
873                 G_GNUC_WARN_UNUSED_RESULT;
874 SR_PRIV void *sr_resource_load(struct sr_context *ctx, int type,
875                 const char *name, size_t *size, size_t max_size)
876                 G_GNUC_MALLOC G_GNUC_WARN_UNUSED_RESULT;
877
878 /*--- strutil.c -------------------------------------------------------------*/
879
880 SR_PRIV int sr_atol(const char *str, long *ret);
881 SR_PRIV int sr_atoi(const char *str, int *ret);
882 SR_PRIV int sr_atod(const char *str, double *ret);
883 SR_PRIV int sr_atof(const char *str, float *ret);
884 SR_PRIV int sr_atof_ascii(const char *str, float *ret);
885
886 /*--- soft-trigger.c --------------------------------------------------------*/
887
888 struct soft_trigger_logic {
889         const struct sr_dev_inst *sdi;
890         const struct sr_trigger *trigger;
891         int count;
892         int unitsize;
893         int cur_stage;
894         uint8_t *prev_sample;
895         uint8_t *pre_trigger_buffer;
896         uint8_t *pre_trigger_head;
897         int pre_trigger_size;
898         int pre_trigger_fill;
899 };
900
901 SR_PRIV struct soft_trigger_logic *soft_trigger_logic_new(
902                 const struct sr_dev_inst *sdi, struct sr_trigger *trigger,
903                 int pre_trigger_samples);
904 SR_PRIV void soft_trigger_logic_free(struct soft_trigger_logic *st);
905 SR_PRIV int soft_trigger_logic_check(struct soft_trigger_logic *st, uint8_t *buf,
906                 int len, int *pre_trigger_samples);
907
908 /*--- hardware/serial.c -----------------------------------------------------*/
909
910 #ifdef HAVE_LIBSERIALPORT
911 enum {
912         SERIAL_RDWR = 1,
913         SERIAL_RDONLY = 2,
914 };
915
916 typedef gboolean (*packet_valid_callback)(const uint8_t *buf);
917
918 SR_PRIV int serial_open(struct sr_serial_dev_inst *serial, int flags);
919 SR_PRIV int serial_close(struct sr_serial_dev_inst *serial);
920 SR_PRIV int serial_flush(struct sr_serial_dev_inst *serial);
921 SR_PRIV int serial_drain(struct sr_serial_dev_inst *serial);
922 SR_PRIV int serial_write_blocking(struct sr_serial_dev_inst *serial,
923                 const void *buf, size_t count, unsigned int timeout_ms);
924 SR_PRIV int serial_write_nonblocking(struct sr_serial_dev_inst *serial,
925                 const void *buf, size_t count);
926 SR_PRIV int serial_read_blocking(struct sr_serial_dev_inst *serial, void *buf,
927                 size_t count, unsigned int timeout_ms);
928 SR_PRIV int serial_read_nonblocking(struct sr_serial_dev_inst *serial, void *buf,
929                 size_t count);
930 SR_PRIV int serial_set_params(struct sr_serial_dev_inst *serial, int baudrate,
931                 int bits, int parity, int stopbits, int flowcontrol, int rts, int dtr);
932 SR_PRIV int serial_set_paramstr(struct sr_serial_dev_inst *serial,
933                 const char *paramstr);
934 SR_PRIV int serial_readline(struct sr_serial_dev_inst *serial, char **buf,
935                 int *buflen, gint64 timeout_ms);
936 SR_PRIV int serial_stream_detect(struct sr_serial_dev_inst *serial,
937                                  uint8_t *buf, size_t *buflen,
938                                  size_t packet_size,
939                                  packet_valid_callback is_valid,
940                                  uint64_t timeout_ms, int baudrate);
941 SR_PRIV int sr_serial_extract_options(GSList *options, const char **serial_device,
942                                       const char **serial_options);
943 SR_PRIV int serial_source_add(struct sr_session *session,
944                 struct sr_serial_dev_inst *serial, int events, int timeout,
945                 sr_receive_data_callback cb, void *cb_data);
946 SR_PRIV int serial_source_remove(struct sr_session *session,
947                 struct sr_serial_dev_inst *serial);
948 SR_PRIV GSList *sr_serial_find_usb(uint16_t vendor_id, uint16_t product_id);
949 SR_PRIV int serial_timeout(struct sr_serial_dev_inst *port, int num_bytes);
950 #endif
951
952 /*--- hardware/ezusb.c ------------------------------------------------------*/
953
954 #ifdef HAVE_LIBUSB_1_0
955 SR_PRIV int ezusb_reset(struct libusb_device_handle *hdl, int set_clear);
956 SR_PRIV int ezusb_install_firmware(struct sr_context *ctx, libusb_device_handle *hdl,
957                                    const char *name);
958 SR_PRIV int ezusb_upload_firmware(struct sr_context *ctx, libusb_device *dev,
959                                   int configuration, const char *name);
960 #endif
961
962 /*--- hardware/usb.c --------------------------------------------------------*/
963
964 #ifdef HAVE_LIBUSB_1_0
965 SR_PRIV GSList *sr_usb_find(libusb_context *usb_ctx, const char *conn);
966 SR_PRIV int sr_usb_open(libusb_context *usb_ctx, struct sr_usb_dev_inst *usb);
967 SR_PRIV void sr_usb_close(struct sr_usb_dev_inst *usb);
968 SR_PRIV int usb_source_add(struct sr_session *session, struct sr_context *ctx,
969                 int timeout, sr_receive_data_callback cb, void *cb_data);
970 SR_PRIV int usb_source_remove(struct sr_session *session, struct sr_context *ctx);
971 SR_PRIV int usb_get_port_path(libusb_device *dev, char *path, int path_len);
972 #endif
973
974
975 /*--- modbus/modbus.c -------------------------------------------------------*/
976
977 struct sr_modbus_dev_inst {
978         const char *name;
979         const char *prefix;
980         int priv_size;
981         GSList *(*scan)(int modbusaddr);
982         int (*dev_inst_new)(void *priv, const char *resource,
983                 char **params, const char *serialcomm, int modbusaddr);
984         int (*open)(void *priv);
985         int (*source_add)(struct sr_session *session, void *priv, int events,
986                 int timeout, sr_receive_data_callback cb, void *cb_data);
987         int (*source_remove)(struct sr_session *session, void *priv);
988         int (*send)(void *priv, const uint8_t *buffer, int buffer_size);
989         int (*read_begin)(void *priv, uint8_t *function_code);
990         int (*read_data)(void *priv, uint8_t *buf, int maxlen);
991         int (*read_end)(void *priv);
992         int (*close)(void *priv);
993         void (*free)(void *priv);
994         unsigned int read_timeout_ms;
995         void *priv;
996 };
997
998 SR_PRIV GSList *sr_modbus_scan(struct drv_context *drvc, GSList *options,
999                 struct sr_dev_inst *(*probe_device)(struct sr_modbus_dev_inst *modbus));
1000 SR_PRIV struct sr_modbus_dev_inst *modbus_dev_inst_new(const char *resource,
1001                 const char *serialcomm, int modbusaddr);
1002 SR_PRIV int sr_modbus_open(struct sr_modbus_dev_inst *modbus);
1003 SR_PRIV int sr_modbus_source_add(struct sr_session *session,
1004                 struct sr_modbus_dev_inst *modbus, int events, int timeout,
1005                 sr_receive_data_callback cb, void *cb_data);
1006 SR_PRIV int sr_modbus_source_remove(struct sr_session *session,
1007                 struct sr_modbus_dev_inst *modbus);
1008 SR_PRIV int sr_modbus_request(struct sr_modbus_dev_inst *modbus,
1009                               uint8_t *request, int request_size);
1010 SR_PRIV int sr_modbus_reply(struct sr_modbus_dev_inst *modbus,
1011                             uint8_t *reply, int reply_size);
1012 SR_PRIV int sr_modbus_request_reply(struct sr_modbus_dev_inst *modbus,
1013                                     uint8_t *request, int request_size,
1014                                     uint8_t *reply, int reply_size);
1015 SR_PRIV int sr_modbus_read_coils(struct sr_modbus_dev_inst *modbus,
1016                                  int address, int nb_coils, uint8_t *coils);
1017 SR_PRIV int sr_modbus_read_holding_registers(struct sr_modbus_dev_inst *modbus,
1018                                              int address, int nb_registers,
1019                                              uint16_t *registers);
1020 SR_PRIV int sr_modbus_write_coil(struct sr_modbus_dev_inst *modbus,
1021                                  int address, int value);
1022 SR_PRIV int sr_modbus_write_multiple_registers(struct sr_modbus_dev_inst*modbus,
1023                                                int address, int nb_registers,
1024                                                uint16_t *registers);
1025 SR_PRIV int sr_modbus_close(struct sr_modbus_dev_inst *modbus);
1026 SR_PRIV void sr_modbus_free(struct sr_modbus_dev_inst *modbus);
1027
1028 /*--- hardware/dmm/es519xx.c ------------------------------------------------*/
1029
1030 /**
1031  * All 11-byte es519xx chips repeat each block twice for each conversion cycle
1032  * so always read 2 blocks at a time.
1033  */
1034 #define ES519XX_11B_PACKET_SIZE (11 * 2)
1035 #define ES519XX_14B_PACKET_SIZE 14
1036
1037 struct es519xx_info {
1038         gboolean is_judge, is_voltage, is_auto, is_micro, is_current;
1039         gboolean is_milli, is_resistance, is_continuity, is_diode;
1040         gboolean is_frequency, is_rpm, is_capacitance, is_duty_cycle;
1041         gboolean is_temperature, is_celsius, is_fahrenheit;
1042         gboolean is_adp0, is_adp1, is_adp2, is_adp3;
1043         gboolean is_sign, is_batt, is_ol, is_pmax, is_pmin, is_apo;
1044         gboolean is_dc, is_ac, is_vahz, is_min, is_max, is_rel, is_hold;
1045         gboolean is_digit4, is_ul, is_vasel, is_vbar, is_lpf1, is_lpf0, is_rmr;
1046         uint32_t baudrate;
1047         int packet_size;
1048         gboolean alt_functions, fivedigits, clampmeter, selectable_lpf;
1049 };
1050
1051 SR_PRIV gboolean sr_es519xx_2400_11b_packet_valid(const uint8_t *buf);
1052 SR_PRIV int sr_es519xx_2400_11b_parse(const uint8_t *buf, float *floatval,
1053                 struct sr_datafeed_analog_old *analog, void *info);
1054 SR_PRIV gboolean sr_es519xx_2400_11b_altfn_packet_valid(const uint8_t *buf);
1055 SR_PRIV int sr_es519xx_2400_11b_altfn_parse(const uint8_t *buf,
1056                 float *floatval, struct sr_datafeed_analog_old *analog, void *info);
1057 SR_PRIV gboolean sr_es519xx_19200_11b_5digits_packet_valid(const uint8_t *buf);
1058 SR_PRIV int sr_es519xx_19200_11b_5digits_parse(const uint8_t *buf,
1059                 float *floatval, struct sr_datafeed_analog_old *analog, void *info);
1060 SR_PRIV gboolean sr_es519xx_19200_11b_clamp_packet_valid(const uint8_t *buf);
1061 SR_PRIV int sr_es519xx_19200_11b_clamp_parse(const uint8_t *buf,
1062                 float *floatval, struct sr_datafeed_analog_old *analog, void *info);
1063 SR_PRIV gboolean sr_es519xx_19200_11b_packet_valid(const uint8_t *buf);
1064 SR_PRIV int sr_es519xx_19200_11b_parse(const uint8_t *buf, float *floatval,
1065                 struct sr_datafeed_analog_old *analog, void *info);
1066 SR_PRIV gboolean sr_es519xx_19200_14b_packet_valid(const uint8_t *buf);
1067 SR_PRIV int sr_es519xx_19200_14b_parse(const uint8_t *buf, float *floatval,
1068                 struct sr_datafeed_analog_old *analog, void *info);
1069 SR_PRIV gboolean sr_es519xx_19200_14b_sel_lpf_packet_valid(const uint8_t *buf);
1070 SR_PRIV int sr_es519xx_19200_14b_sel_lpf_parse(const uint8_t *buf,
1071                 float *floatval, struct sr_datafeed_analog_old *analog, void *info);
1072
1073 /*--- hardware/dmm/fs9922.c -------------------------------------------------*/
1074
1075 #define FS9922_PACKET_SIZE 14
1076
1077 struct fs9922_info {
1078         gboolean is_auto, is_dc, is_ac, is_rel, is_hold, is_bpn, is_z1, is_z2;
1079         gboolean is_max, is_min, is_apo, is_bat, is_nano, is_z3, is_micro;
1080         gboolean is_milli, is_kilo, is_mega, is_beep, is_diode, is_percent;
1081         gboolean is_z4, is_volt, is_ampere, is_ohm, is_hfe, is_hertz, is_farad;
1082         gboolean is_celsius, is_fahrenheit;
1083         int bargraph_sign, bargraph_value;
1084 };
1085
1086 SR_PRIV gboolean sr_fs9922_packet_valid(const uint8_t *buf);
1087 SR_PRIV int sr_fs9922_parse(const uint8_t *buf, float *floatval,
1088                             struct sr_datafeed_analog_old *analog, void *info);
1089 SR_PRIV void sr_fs9922_z1_diode(struct sr_datafeed_analog_old *analog, void *info);
1090
1091 /*--- hardware/dmm/fs9721.c -------------------------------------------------*/
1092
1093 #define FS9721_PACKET_SIZE 14
1094
1095 struct fs9721_info {
1096         gboolean is_ac, is_dc, is_auto, is_rs232, is_micro, is_nano, is_kilo;
1097         gboolean is_diode, is_milli, is_percent, is_mega, is_beep, is_farad;
1098         gboolean is_ohm, is_rel, is_hold, is_ampere, is_volt, is_hz, is_bat;
1099         gboolean is_c2c1_11, is_c2c1_10, is_c2c1_01, is_c2c1_00, is_sign;
1100 };
1101
1102 SR_PRIV gboolean sr_fs9721_packet_valid(const uint8_t *buf);
1103 SR_PRIV int sr_fs9721_parse(const uint8_t *buf, float *floatval,
1104                             struct sr_datafeed_analog_old *analog, void *info);
1105 SR_PRIV void sr_fs9721_00_temp_c(struct sr_datafeed_analog_old *analog, void *info);
1106 SR_PRIV void sr_fs9721_01_temp_c(struct sr_datafeed_analog_old *analog, void *info);
1107 SR_PRIV void sr_fs9721_10_temp_c(struct sr_datafeed_analog_old *analog, void *info);
1108 SR_PRIV void sr_fs9721_01_10_temp_f_c(struct sr_datafeed_analog_old *analog, void *info);
1109 SR_PRIV void sr_fs9721_max_c_min(struct sr_datafeed_analog_old *analog, void *info);
1110
1111 /*--- hardware/dmm/dtm0660.c ------------------------------------------------*/
1112
1113 #define DTM0660_PACKET_SIZE 15
1114
1115 struct dtm0660_info {
1116         gboolean is_ac, is_dc, is_auto, is_rs232, is_micro, is_nano, is_kilo;
1117         gboolean is_diode, is_milli, is_percent, is_mega, is_beep, is_farad;
1118         gboolean is_ohm, is_rel, is_hold, is_ampere, is_volt, is_hz, is_bat;
1119         gboolean is_degf, is_degc, is_c2c1_01, is_c2c1_00, is_apo, is_min;
1120         gboolean is_minmax, is_max, is_sign;
1121 };
1122
1123 SR_PRIV gboolean sr_dtm0660_packet_valid(const uint8_t *buf);
1124 SR_PRIV int sr_dtm0660_parse(const uint8_t *buf, float *floatval,
1125                         struct sr_datafeed_analog_old *analog, void *info);
1126
1127 /*--- hardware/dmm/m2110.c --------------------------------------------------*/
1128
1129 #define BBCGM_M2110_PACKET_SIZE 9
1130
1131 SR_PRIV gboolean sr_m2110_packet_valid(const uint8_t *buf);
1132 SR_PRIV int sr_m2110_parse(const uint8_t *buf, float *floatval,
1133                              struct sr_datafeed_analog_old *analog, void *info);
1134
1135 /*--- hardware/dmm/metex14.c ------------------------------------------------*/
1136
1137 #define METEX14_PACKET_SIZE 14
1138
1139 struct metex14_info {
1140         gboolean is_ac, is_dc, is_resistance, is_capacity, is_temperature;
1141         gboolean is_diode, is_frequency, is_ampere, is_volt, is_farad;
1142         gboolean is_hertz, is_ohm, is_celsius, is_pico, is_nano, is_micro;
1143         gboolean is_milli, is_kilo, is_mega, is_gain, is_decibel, is_hfe;
1144         gboolean is_unitless, is_logic;
1145 };
1146
1147 #ifdef HAVE_LIBSERIALPORT
1148 SR_PRIV int sr_metex14_packet_request(struct sr_serial_dev_inst *serial);
1149 #endif
1150 SR_PRIV gboolean sr_metex14_packet_valid(const uint8_t *buf);
1151 SR_PRIV int sr_metex14_parse(const uint8_t *buf, float *floatval,
1152                              struct sr_datafeed_analog_old *analog, void *info);
1153
1154 /*--- hardware/dmm/rs9lcd.c -------------------------------------------------*/
1155
1156 #define RS9LCD_PACKET_SIZE 9
1157
1158 /* Dummy info struct. The parser does not use it. */
1159 struct rs9lcd_info { int dummy; };
1160
1161 SR_PRIV gboolean sr_rs9lcd_packet_valid(const uint8_t *buf);
1162 SR_PRIV int sr_rs9lcd_parse(const uint8_t *buf, float *floatval,
1163                             struct sr_datafeed_analog_old *analog, void *info);
1164
1165 /*--- hardware/dmm/bm25x.c --------------------------------------------------*/
1166
1167 #define BRYMEN_BM25X_PACKET_SIZE 15
1168
1169 /* Dummy info struct. The parser does not use it. */
1170 struct bm25x_info { int dummy; };
1171
1172 SR_PRIV gboolean sr_brymen_bm25x_packet_valid(const uint8_t *buf);
1173 SR_PRIV int sr_brymen_bm25x_parse(const uint8_t *buf, float *floatval,
1174                              struct sr_datafeed_analog_old *analog, void *info);
1175
1176 /*--- hardware/dmm/ut71x.c --------------------------------------------------*/
1177
1178 #define UT71X_PACKET_SIZE 11
1179
1180 struct ut71x_info {
1181         gboolean is_voltage, is_resistance, is_capacitance, is_temperature;
1182         gboolean is_celsius, is_fahrenheit, is_current, is_continuity;
1183         gboolean is_diode, is_frequency, is_duty_cycle, is_dc, is_ac;
1184         gboolean is_auto, is_manual, is_sign, is_power, is_loop_current;
1185 };
1186
1187 SR_PRIV gboolean sr_ut71x_packet_valid(const uint8_t *buf);
1188 SR_PRIV int sr_ut71x_parse(const uint8_t *buf, float *floatval,
1189                 struct sr_datafeed_analog_old *analog, void *info);
1190
1191 /*--- hardware/dmm/vc870.c --------------------------------------------------*/
1192
1193 #define VC870_PACKET_SIZE 23
1194
1195 struct vc870_info {
1196         gboolean is_voltage, is_dc, is_ac, is_temperature, is_resistance;
1197         gboolean is_continuity, is_capacitance, is_diode, is_loop_current;
1198         gboolean is_current, is_micro, is_milli, is_power;
1199         gboolean is_power_factor_freq, is_power_apparent_power, is_v_a_eff_value;
1200         gboolean is_sign2, is_sign1, is_batt, is_ol1, is_max, is_min;
1201         gboolean is_maxmin, is_rel, is_ol2, is_open, is_manu, is_hold;
1202         gboolean is_light, is_usb, is_warning, is_auto_power, is_misplug_warn;
1203         gboolean is_lo, is_hi, is_open2;
1204
1205         gboolean is_frequency, is_dual_display, is_auto, is_rms;
1206 };
1207
1208 SR_PRIV gboolean sr_vc870_packet_valid(const uint8_t *buf);
1209 SR_PRIV int sr_vc870_parse(const uint8_t *buf, float *floatval,
1210                 struct sr_datafeed_analog_old *analog, void *info);
1211
1212 /*--- hardware/lcr/es51919.c ------------------------------------------------*/
1213
1214 SR_PRIV void es51919_serial_clean(void *priv);
1215 SR_PRIV struct sr_dev_inst *es51919_serial_scan(GSList *options,
1216                                                 const char *vendor,
1217                                                 const char *model);
1218 SR_PRIV int es51919_serial_config_get(uint32_t key, GVariant **data,
1219                                       const struct sr_dev_inst *sdi,
1220                                       const struct sr_channel_group *cg);
1221 SR_PRIV int es51919_serial_config_set(uint32_t key, GVariant *data,
1222                                       const struct sr_dev_inst *sdi,
1223                                       const struct sr_channel_group *cg);
1224 SR_PRIV int es51919_serial_config_list(uint32_t key, GVariant **data,
1225                                        const struct sr_dev_inst *sdi,
1226                                        const struct sr_channel_group *cg);
1227 SR_PRIV int es51919_serial_acquisition_start(const struct sr_dev_inst *sdi,
1228                                              void *cb_data);
1229 SR_PRIV int es51919_serial_acquisition_stop(struct sr_dev_inst *sdi,
1230                                             void *cb_data);
1231
1232 /*--- hardware/dmm/ut372.c --------------------------------------------------*/
1233
1234 #define UT372_PACKET_SIZE 27
1235
1236 struct ut372_info {
1237         int dummy;
1238 };
1239
1240 SR_PRIV gboolean sr_ut372_packet_valid(const uint8_t *buf);
1241 SR_PRIV int sr_ut372_parse(const uint8_t *buf, float *floatval,
1242                 struct sr_datafeed_analog_old *analog, void *info);
1243
1244 /*--- hardware/scale/kern.c -------------------------------------------------*/
1245
1246 struct kern_info {
1247         gboolean is_gram, is_carat, is_ounce, is_pound, is_troy_ounce;
1248         gboolean is_pennyweight, is_grain, is_tael, is_momme, is_tola;
1249         gboolean is_percentage, is_piece, is_unstable, is_stable, is_error;
1250         int buflen;
1251 };
1252
1253 SR_PRIV gboolean sr_kern_packet_valid(const uint8_t *buf);
1254 SR_PRIV int sr_kern_parse(const uint8_t *buf, float *floatval,
1255                 struct sr_datafeed_analog_old *analog, void *info);
1256
1257 #endif