]> sigrok.org Git - libsigrok.git/blob - src/libsigrok-internal.h
srzip: Avoid low-level FD-based I/O
[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 little endian signed integer out of memory.
81  * @param x a pointer to the input memory
82  * @return the corresponding signed integer
83  */
84 #define RL16S(x)  ((int16_t) \
85                   (((unsigned)((const uint8_t*)(x))[1] <<  8) | \
86                     (unsigned)((const uint8_t*)(x))[0]))
87
88 /**
89  * Read a 32 bits big endian unsigned integer out of memory.
90  * @param x a pointer to the input memory
91  * @return the corresponding unsigned integer
92  */
93 #define RB32(x)  (((unsigned)((const uint8_t*)(x))[0] << 24) | \
94                   ((unsigned)((const uint8_t*)(x))[1] << 16) |  \
95                   ((unsigned)((const uint8_t*)(x))[2] <<  8) |  \
96                    (unsigned)((const uint8_t*)(x))[3])
97
98 /**
99  * Read a 32 bits little endian unsigned integer out of memory.
100  * @param x a pointer to the input memory
101  * @return the corresponding unsigned integer
102  */
103 #define RL32(x)  (((unsigned)((const uint8_t*)(x))[3] << 24) | \
104                   ((unsigned)((const uint8_t*)(x))[2] << 16) |  \
105                   ((unsigned)((const uint8_t*)(x))[1] <<  8) |  \
106                    (unsigned)((const uint8_t*)(x))[0])
107
108 /**
109  * Read a 32 bits little endian signed integer out of memory.
110  * @param x a pointer to the input memory
111  * @return the corresponding signed integer
112  */
113 #define RL32S(x)  ((int32_t) \
114                  (((unsigned)((const uint8_t*)(x))[3] << 24) | \
115                   ((unsigned)((const uint8_t*)(x))[2] << 16) |  \
116                   ((unsigned)((const uint8_t*)(x))[1] <<  8) |  \
117                    (unsigned)((const uint8_t*)(x))[0]))
118
119 /**
120  * Read a 32 bits big endian float out of memory.
121  * @param x a pointer to the input memory
122  * @return the corresponding float
123  */
124 #define RBFL(x)  ((union { uint32_t u; float f; }) { .u = RB32(x) }.f)
125
126 /**
127  * Read a 32 bits little endian float out of memory.
128  * @param x a pointer to the input memory
129  * @return the corresponding float
130  */
131 #define RLFL(x)  ((union { uint32_t u; float f; }) { .u = RL32(x) }.f)
132
133 /**
134  * Write a 8 bits unsigned integer to memory.
135  * @param p a pointer to the output memory
136  * @param x the input unsigned integer
137  */
138 #define W8(p, x)    do { ((uint8_t*)(p))[0] = (uint8_t) (x);      } while (0)
139
140 /**
141  * Write a 16 bits unsigned integer to memory stored as big endian.
142  * @param p a pointer to the output memory
143  * @param x the input unsigned integer
144  */
145 #define WB16(p, x)  do { ((uint8_t*)(p))[1] = (uint8_t) (x);      \
146                          ((uint8_t*)(p))[0] = (uint8_t)((x)>>8);  } while (0)
147
148 /**
149  * Write a 16 bits unsigned integer to memory stored as little endian.
150  * @param p a pointer to the output memory
151  * @param x the input unsigned integer
152  */
153 #define WL16(p, x)  do { ((uint8_t*)(p))[0] = (uint8_t) (x);      \
154                          ((uint8_t*)(p))[1] = (uint8_t)((x)>>8);  } while (0)
155
156 /**
157  * Write a 32 bits unsigned integer to memory stored as big endian.
158  * @param p a pointer to the output memory
159  * @param x the input unsigned integer
160  */
161 #define WB32(p, x)  do { ((uint8_t*)(p))[3] = (uint8_t) (x);      \
162                          ((uint8_t*)(p))[2] = (uint8_t)((x)>>8);  \
163                          ((uint8_t*)(p))[1] = (uint8_t)((x)>>16); \
164                          ((uint8_t*)(p))[0] = (uint8_t)((x)>>24); } while (0)
165
166 /**
167  * Write a 32 bits unsigned integer to memory stored as little endian.
168  * @param p a pointer to the output memory
169  * @param x the input unsigned integer
170  */
171 #define WL32(p, x)  do { ((uint8_t*)(p))[0] = (uint8_t) (x);      \
172                          ((uint8_t*)(p))[1] = (uint8_t)((x)>>8);  \
173                          ((uint8_t*)(p))[2] = (uint8_t)((x)>>16); \
174                          ((uint8_t*)(p))[3] = (uint8_t)((x)>>24); } while (0)
175
176 /**
177  * Write a 32 bits float to memory stored as big endian.
178  * @param p a pointer to the output memory
179  * @param x the input float
180  */
181 #define WBFL(p, x)  WB32(p, (union { uint32_t u; float f; }) { .f = x }.u)
182
183 /**
184  * Write a 32 bits float to memory stored as little endian.
185  * @param p a pointer to the output memory
186  * @param x the input float
187  */
188 #define WLFL(p, x)  WL32(p, (union { uint32_t u; float f; }) { .f = x }.u)
189
190 /* Portability fixes for FreeBSD. */
191 #ifdef __FreeBSD__
192 #define LIBUSB_CLASS_APPLICATION 0xfe
193 #define libusb_has_capability(x) 0
194 #define libusb_handle_events_timeout_completed(ctx, tv, c) \
195         libusb_handle_events_timeout(ctx, tv)
196 #endif
197
198 /* Static definitions of structs ending with an all-zero entry are a
199  * problem when compiling with -Wmissing-field-initializers: GCC
200  * suppresses the warning only with { 0 }, clang wants { } */
201 #ifdef __clang__
202 #define ALL_ZERO { }
203 #else
204 #define ALL_ZERO { 0 }
205 #endif
206
207 struct sr_context {
208         struct sr_dev_driver **driver_list;
209 #ifdef HAVE_LIBUSB_1_0
210         libusb_context *libusb_ctx;
211 #endif
212 };
213
214 /** Input module metadata keys. */
215 enum sr_input_meta_keys {
216         /** The input filename, if there is one. */
217         SR_INPUT_META_FILENAME = 0x01,
218         /** The input file's size in bytes. */
219         SR_INPUT_META_FILESIZE = 0x02,
220         /** The first 128 bytes of the file, provided as a GString. */
221         SR_INPUT_META_HEADER = 0x04,
222         /** The file's MIME type. */
223         SR_INPUT_META_MIMETYPE = 0x08,
224
225         /** The module cannot identify a file without this metadata. */
226         SR_INPUT_META_REQUIRED = 0x80,
227 };
228
229 /** Input (file) module struct. */
230 struct sr_input {
231         /**
232          * A pointer to this input module's 'struct sr_input_module'.
233          */
234         const struct sr_input_module *module;
235         GString *buf;
236         struct sr_dev_inst *sdi;
237         gboolean sdi_ready;
238         void *priv;
239 };
240
241 /** Input (file) module driver. */
242 struct sr_input_module {
243         /**
244          * A unique ID for this input module, suitable for use in command-line
245          * clients, [a-z0-9-]. Must not be NULL.
246          */
247         const char *id;
248
249         /**
250          * A unique name for this input module, suitable for use in GUI
251          * clients, can contain UTF-8. Must not be NULL.
252          */
253         const char *name;
254
255         /**
256          * A short description of the input module. Must not be NULL.
257          *
258          * This can be displayed by frontends, e.g. when selecting the input
259          * module for saving a file.
260          */
261         const char *desc;
262
263         /**
264          * A NULL terminated array of strings containing a list of file name
265          * extensions typical for the input file format, or NULL if there is
266          * no typical extension for this file format.
267          */
268         const char *const *exts;
269
270         /**
271          * Zero-terminated list of metadata items the module needs to be able
272          * to identify an input stream. Can be all-zero, if the module cannot
273          * identify streams at all, i.e. has to be forced into use.
274          *
275          * Each item is one of:
276          *   SR_INPUT_META_FILENAME
277          *   SR_INPUT_META_FILESIZE
278          *   SR_INPUT_META_HEADER
279          *   SR_INPUT_META_MIMETYPE
280          *
281          * If the high bit (SR_INPUT META_REQUIRED) is set, the module cannot
282          * identify a stream without the given metadata.
283          */
284         const uint8_t metadata[8];
285
286         /**
287          * Returns a NULL-terminated list of options this module can take.
288          * Can be NULL, if the module has no options.
289          */
290         struct sr_option *(*options) (void);
291
292         /**
293          * Check if this input module can load and parse the specified stream.
294          *
295          * @param[in] metadata Metadata the module can use to identify the stream.
296          *
297          * @retval SR_OK This module knows the format.
298          * @retval SR_ERR_NA There wasn't enough data for this module to
299          *   positively identify the format.
300          * @retval SR_ERR_DATA This module knows the format, but cannot handle it.
301          *   This means the stream is either corrupt, or indicates a feature
302          *   that the module does not support.
303          * @retval SR_ERR This module does not know the format.
304          */
305         int (*format_match) (GHashTable *metadata);
306
307         /**
308          * Initialize the input module.
309          *
310          * @retval SR_OK Success
311          * @retval other Negative error code.
312          */
313         int (*init) (struct sr_input *in, GHashTable *options);
314
315         /**
316          * Send data to the specified input instance.
317          *
318          * When an input module instance is created with sr_input_new(), this
319          * function is used to feed data to the instance.
320          *
321          * As enough data gets fed into this function to completely populate
322          * the device instance associated with this input instance, this is
323          * guaranteed to return the moment it's ready. This gives the caller
324          * the chance to examine the device instance, attach session callbacks
325          * and so on.
326          *
327          * @retval SR_OK Success
328          * @retval other Negative error code.
329          */
330         int (*receive) (struct sr_input *in, GString *buf);
331
332         /**
333          * Signal the input module no more data will come.
334          *
335          * This will cause the module to process any data it may have buffered.
336          * The SR_DF_END packet will also typically be sent at this time.
337          */
338         int (*end) (struct sr_input *in);
339
340         /**
341          * This function is called after the caller is finished using
342          * the input module, and can be used to free any internal
343          * resources the module may keep.
344          *
345          * This function is optional.
346          *
347          * @retval SR_OK Success
348          * @retval other Negative error code.
349          */
350         void (*cleanup) (struct sr_input *in);
351 };
352
353 /** Output module instance. */
354 struct sr_output {
355         /** A pointer to this output's module.  */
356         const struct sr_output_module *module;
357
358         /**
359          * The device for which this output module is creating output. This
360          * can be used by the module to find out channel names and numbers.
361          */
362         const struct sr_dev_inst *sdi;
363
364         /**
365          * The name of the file that the data should be written to.
366          */
367         const char *filename;
368
369         /**
370          * A generic pointer which can be used by the module to keep internal
371          * state between calls into its callback functions.
372          *
373          * For example, the module might store a pointer to a chunk of output
374          * there, and only flush it when it reaches a certain size.
375          */
376         void *priv;
377 };
378
379 /** Output module driver. */
380 struct sr_output_module {
381         /**
382          * A unique ID for this output module, suitable for use in command-line
383          * clients, [a-z0-9-]. Must not be NULL.
384          */
385         char *id;
386
387         /**
388          * A unique name for this output module, suitable for use in GUI
389          * clients, can contain UTF-8. Must not be NULL.
390          */
391         const char *name;
392
393         /**
394          * A short description of the output module. Must not be NULL.
395          *
396          * This can be displayed by frontends, e.g. when selecting the output
397          * module for saving a file.
398          */
399         char *desc;
400
401         /**
402          * A NULL terminated array of strings containing a list of file name
403          * extensions typical for the input file format, or NULL if there is
404          * no typical extension for this file format.
405          */
406         const char *const *exts;
407
408         /**
409          * Bitfield containing flags that describe certain properties
410          * this output module may or may not have.
411          * @see sr_output_flags
412          */
413         const uint64_t flags;
414
415         /**
416          * Returns a NULL-terminated list of options this module can take.
417          * Can be NULL, if the module has no options.
418          */
419         const struct sr_option *(*options) (void);
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         /**
439          * This function is passed a copy of every packet in the data feed.
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
470 /** Transform module instance. */
471 struct 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
488 struct 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
557 #ifdef HAVE_LIBUSB_1_0
558 /** USB device instance */
559 struct sr_usb_dev_inst {
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;
566 };
567 #endif
568
569 #ifdef HAVE_LIBSERIALPORT
570 struct sr_serial_dev_inst {
571         /** Port name, e.g. '/dev/tty42'. */
572         char *port;
573         /** Comm params for serial_set_paramstr(). */
574         char *serialcomm;
575         /** libserialport port handle */
576         struct sp_port *data;
577 };
578 #endif
579
580 struct sr_usbtmc_dev_inst {
581         char *device;
582         int fd;
583 };
584
585 /* Private driver context. */
586 struct drv_context {
587         /** sigrok context */
588         struct sr_context *sr_ctx;
589         GSList *instances;
590 };
591
592 /*--- input/input.c ---------------------------------------------------------*/
593
594 SR_PRIV int64_t sr_file_get_size(FILE *file);
595
596 /*--- log.c -----------------------------------------------------------------*/
597
598 #if defined(G_OS_WIN32) && (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 4))
599 /*
600  * On MinGW, we need to specify the gnu_printf format flavor or GCC
601  * will assume non-standard Microsoft printf syntax.
602  */
603 SR_PRIV int sr_log(int loglevel, const char *format, ...)
604                 __attribute__((__format__ (__gnu_printf__, 2, 3)));
605 #else
606 SR_PRIV int sr_log(int loglevel, const char *format, ...) G_GNUC_PRINTF(2, 3);
607 #endif
608
609 /* Message logging helpers with subsystem-specific prefix string. */
610 #define sr_spew(...)    sr_log(SR_LOG_SPEW, LOG_PREFIX ": " __VA_ARGS__)
611 #define sr_dbg(...)     sr_log(SR_LOG_DBG,  LOG_PREFIX ": " __VA_ARGS__)
612 #define sr_info(...)    sr_log(SR_LOG_INFO, LOG_PREFIX ": " __VA_ARGS__)
613 #define sr_warn(...)    sr_log(SR_LOG_WARN, LOG_PREFIX ": " __VA_ARGS__)
614 #define sr_err(...)     sr_log(SR_LOG_ERR,  LOG_PREFIX ": " __VA_ARGS__)
615
616 /*--- device.c --------------------------------------------------------------*/
617
618 /** Values for the changes argument of sr_dev_driver.config_channel_set. */
619 enum {
620         /** The enabled state of the channel has been changed. */
621         SR_CHANNEL_SET_ENABLED = 1 << 0,
622 };
623
624 SR_PRIV struct sr_channel *sr_channel_new(struct sr_dev_inst *sdi,
625                 int index, int type, gboolean enabled, const char *name);
626 SR_PRIV struct sr_channel *sr_next_enabled_channel(const struct sr_dev_inst *sdi,
627                 struct sr_channel *cur_channel);
628
629 /** Device instance data */
630 struct 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
659 /* Generic device instances */
660 SR_PRIV void sr_dev_inst_free(struct sr_dev_inst *sdi);
661
662 #ifdef HAVE_LIBUSB_1_0
663 /* USB-specific instances */
664 SR_PRIV struct sr_usb_dev_inst *sr_usb_dev_inst_new(uint8_t bus,
665                 uint8_t address, struct libusb_device_handle *hdl);
666 SR_PRIV void sr_usb_dev_inst_free(struct sr_usb_dev_inst *usb);
667 #endif
668
669 #ifdef HAVE_LIBSERIALPORT
670 /* Serial-specific instances */
671 SR_PRIV struct sr_serial_dev_inst *sr_serial_dev_inst_new(const char *port,
672                 const char *serialcomm);
673 SR_PRIV void sr_serial_dev_inst_free(struct sr_serial_dev_inst *serial);
674 #endif
675
676 /* USBTMC-specific instances */
677 SR_PRIV struct sr_usbtmc_dev_inst *sr_usbtmc_dev_inst_new(const char *device);
678 SR_PRIV void sr_usbtmc_dev_inst_free(struct sr_usbtmc_dev_inst *usbtmc);
679
680 /*--- hwdriver.c ------------------------------------------------------------*/
681
682 extern SR_PRIV struct sr_dev_driver **drivers_lists[];
683
684 SR_PRIV const GVariantType *sr_variant_type_get(int datatype);
685 SR_PRIV int sr_variant_type_check(uint32_t key, GVariant *data);
686 SR_PRIV void sr_hw_cleanup_all(const struct sr_context *ctx);
687 SR_PRIV struct sr_config *sr_config_new(uint32_t key, GVariant *data);
688 SR_PRIV void sr_config_free(struct sr_config *src);
689
690 /*--- session.c -------------------------------------------------------------*/
691
692 struct sr_session {
693         /** Context this session exists in. */
694         struct sr_context *ctx;
695         /** List of struct sr_dev_inst pointers. */
696         GSList *devs;
697         /** List of struct sr_dev_inst pointers owned by this session. */
698         GSList *owned_devs;
699         /** List of struct datafeed_callback pointers. */
700         GSList *datafeed_callbacks;
701         GSList *transforms;
702         struct sr_trigger *trigger;
703
704         /** Mutex protecting the main context pointer and ownership flag. */
705         GMutex main_mutex;
706         /** Context of the session main loop. */
707         GMainContext *main_context;
708         /** Whether we are using the thread's default context. */
709         gboolean main_context_is_default;
710
711         /** Whether the session has been started. */
712         gboolean running;
713
714         /** Registered event sources for this session. */
715         GHashTable *event_sources;
716         /** Session main loop. */
717         GMainLoop *main_loop;
718 };
719
720 SR_PRIV int sr_session_source_add_internal(struct sr_session *session,
721                 void *key, GSource *source);
722 SR_PRIV int sr_session_source_remove_internal(struct sr_session *session,
723                 void *key);
724 SR_PRIV int sr_session_source_destroyed(struct sr_session *session,
725                 void *key, GSource *source);
726 SR_PRIV int sr_session_fd_source_add(struct sr_session *session,
727                 void *key, gintptr fd, int events, int timeout,
728                 sr_receive_data_callback cb, void *cb_data);
729 SR_PRIV int sr_session_send(const struct sr_dev_inst *sdi,
730                 const struct sr_datafeed_packet *packet);
731 SR_PRIV int sr_sessionfile_check(const char *filename);
732 SR_PRIV int sr_packet_copy(const struct sr_datafeed_packet *packet,
733                 struct sr_datafeed_packet **copy);
734 SR_PRIV void sr_packet_free(struct sr_datafeed_packet *packet);
735
736 /*--- session_file.c --------------------------------------------------------*/
737
738 SR_PRIV GKeyFile *sr_sessionfile_read_metadata(struct zip *archive,
739                         const struct zip_stat *entry);
740
741 /*--- analog.c --------------------------------------------------------------*/
742
743 SR_PRIV int sr_analog_init(struct sr_datafeed_analog2 *analog,
744                            struct sr_analog_encoding *encoding,
745                            struct sr_analog_meaning *meaning,
746                            struct sr_analog_spec *spec,
747                            int digits);
748
749 /*--- std.c -----------------------------------------------------------------*/
750
751 typedef int (*dev_close_callback)(struct sr_dev_inst *sdi);
752 typedef void (*std_dev_clear_callback)(void *priv);
753
754 SR_PRIV int std_init(struct sr_context *sr_ctx, struct sr_dev_driver *di,
755                 const char *prefix);
756 #ifdef HAVE_LIBSERIALPORT
757 SR_PRIV int std_serial_dev_open(struct sr_dev_inst *sdi);
758 SR_PRIV int std_serial_dev_acquisition_stop(struct sr_dev_inst *sdi,
759                 void *cb_data, dev_close_callback dev_close_fn,
760                 struct sr_serial_dev_inst *serial, const char *prefix);
761 #endif
762 SR_PRIV int std_session_send_df_header(const struct sr_dev_inst *sdi,
763                 const char *prefix);
764 SR_PRIV int std_dev_clear(const struct sr_dev_driver *driver,
765                 std_dev_clear_callback clear_private);
766 SR_PRIV int std_serial_dev_close(struct sr_dev_inst *sdi);
767
768 /*--- strutil.c -------------------------------------------------------------*/
769
770 SR_PRIV int sr_atol(const char *str, long *ret);
771 SR_PRIV int sr_atoi(const char *str, int *ret);
772 SR_PRIV int sr_atod(const char *str, double *ret);
773 SR_PRIV int sr_atof(const char *str, float *ret);
774 SR_PRIV int sr_atof_ascii(const char *str, float *ret);
775
776 /*--- soft-trigger.c --------------------------------------------------------*/
777
778 struct soft_trigger_logic {
779         const struct sr_dev_inst *sdi;
780         const struct sr_trigger *trigger;
781         int count;
782         int unitsize;
783         int cur_stage;
784         uint8_t *prev_sample;
785         uint8_t *pre_trigger_buffer;
786         uint8_t *pre_trigger_head;
787         int pre_trigger_size;
788         int pre_trigger_fill;
789 };
790
791 SR_PRIV struct soft_trigger_logic *soft_trigger_logic_new(
792                 const struct sr_dev_inst *sdi, struct sr_trigger *trigger,
793                 int pre_trigger_samples);
794 SR_PRIV void soft_trigger_logic_free(struct soft_trigger_logic *st);
795 SR_PRIV int soft_trigger_logic_check(struct soft_trigger_logic *st, uint8_t *buf,
796                 int len, int *pre_trigger_samples);
797
798 /*--- hardware/serial.c -----------------------------------------------------*/
799
800 #ifdef HAVE_LIBSERIALPORT
801 enum {
802         SERIAL_RDWR = 1,
803         SERIAL_RDONLY = 2,
804 };
805
806 typedef gboolean (*packet_valid_callback)(const uint8_t *buf);
807
808 SR_PRIV int serial_open(struct sr_serial_dev_inst *serial, int flags);
809 SR_PRIV int serial_close(struct sr_serial_dev_inst *serial);
810 SR_PRIV int serial_flush(struct sr_serial_dev_inst *serial);
811 SR_PRIV int serial_drain(struct sr_serial_dev_inst *serial);
812 SR_PRIV int serial_write_blocking(struct sr_serial_dev_inst *serial,
813                 const void *buf, size_t count, unsigned int timeout_ms);
814 SR_PRIV int serial_write_nonblocking(struct sr_serial_dev_inst *serial,
815                 const void *buf, size_t count);
816 SR_PRIV int serial_read_blocking(struct sr_serial_dev_inst *serial, void *buf,
817                 size_t count, unsigned int timeout_ms);
818 SR_PRIV int serial_read_nonblocking(struct sr_serial_dev_inst *serial, void *buf,
819                 size_t count);
820 SR_PRIV int serial_set_params(struct sr_serial_dev_inst *serial, int baudrate,
821                 int bits, int parity, int stopbits, int flowcontrol, int rts, int dtr);
822 SR_PRIV int serial_set_paramstr(struct sr_serial_dev_inst *serial,
823                 const char *paramstr);
824 SR_PRIV int serial_readline(struct sr_serial_dev_inst *serial, char **buf,
825                 int *buflen, gint64 timeout_ms);
826 SR_PRIV int serial_stream_detect(struct sr_serial_dev_inst *serial,
827                                  uint8_t *buf, size_t *buflen,
828                                  size_t packet_size,
829                                  packet_valid_callback is_valid,
830                                  uint64_t timeout_ms, int baudrate);
831 SR_PRIV int sr_serial_extract_options(GSList *options, const char **serial_device,
832                                       const char **serial_options);
833 SR_PRIV int serial_source_add(struct sr_session *session,
834                 struct sr_serial_dev_inst *serial, int events, int timeout,
835                 sr_receive_data_callback cb, void *cb_data);
836 SR_PRIV int serial_source_remove(struct sr_session *session,
837                 struct sr_serial_dev_inst *serial);
838 SR_PRIV GSList *sr_serial_find_usb(uint16_t vendor_id, uint16_t product_id);
839 SR_PRIV int serial_timeout(struct sr_serial_dev_inst *port, int num_bytes);
840 #endif
841
842 /*--- hardware/ezusb.c ------------------------------------------------------*/
843
844 #ifdef HAVE_LIBUSB_1_0
845 SR_PRIV int ezusb_reset(struct libusb_device_handle *hdl, int set_clear);
846 SR_PRIV int ezusb_install_firmware(libusb_device_handle *hdl,
847                                    const char *filename);
848 SR_PRIV int ezusb_upload_firmware(libusb_device *dev, int configuration,
849                                   const char *filename);
850 #endif
851
852 /*--- hardware/usb.c --------------------------------------------------------*/
853
854 #ifdef HAVE_LIBUSB_1_0
855 SR_PRIV GSList *sr_usb_find(libusb_context *usb_ctx, const char *conn);
856 SR_PRIV int sr_usb_open(libusb_context *usb_ctx, struct sr_usb_dev_inst *usb);
857 SR_PRIV void sr_usb_close(struct sr_usb_dev_inst *usb);
858 SR_PRIV int usb_source_add(struct sr_session *session, struct sr_context *ctx,
859                 int timeout, sr_receive_data_callback cb, void *cb_data);
860 SR_PRIV int usb_source_remove(struct sr_session *session, struct sr_context *ctx);
861 SR_PRIV int usb_get_port_path(libusb_device *dev, char *path, int path_len);
862 #endif
863
864
865 /*--- modbus/modbus.c -------------------------------------------------------*/
866
867 struct sr_modbus_dev_inst {
868         const char *name;
869         const char *prefix;
870         int priv_size;
871         GSList *(*scan)(int modbusaddr);
872         int (*dev_inst_new)(void *priv, const char *resource,
873                 char **params, const char *serialcomm, int modbusaddr);
874         int (*open)(void *priv);
875         int (*source_add)(struct sr_session *session, void *priv, int events,
876                 int timeout, sr_receive_data_callback cb, void *cb_data);
877         int (*source_remove)(struct sr_session *session, void *priv);
878         int (*send)(void *priv, const uint8_t *buffer, int buffer_size);
879         int (*read_begin)(void *priv, uint8_t *function_code);
880         int (*read_data)(void *priv, uint8_t *buf, int maxlen);
881         int (*read_end)(void *priv);
882         int (*close)(void *priv);
883         void (*free)(void *priv);
884         unsigned int read_timeout_ms;
885         void *priv;
886 };
887
888 SR_PRIV GSList *sr_modbus_scan(struct drv_context *drvc, GSList *options,
889                 struct sr_dev_inst *(*probe_device)(struct sr_modbus_dev_inst *modbus));
890 SR_PRIV struct sr_modbus_dev_inst *modbus_dev_inst_new(const char *resource,
891                 const char *serialcomm, int modbusaddr);
892 SR_PRIV int sr_modbus_open(struct sr_modbus_dev_inst *modbus);
893 SR_PRIV int sr_modbus_source_add(struct sr_session *session,
894                 struct sr_modbus_dev_inst *modbus, int events, int timeout,
895                 sr_receive_data_callback cb, void *cb_data);
896 SR_PRIV int sr_modbus_source_remove(struct sr_session *session,
897                 struct sr_modbus_dev_inst *modbus);
898 SR_PRIV int sr_modbus_request(struct sr_modbus_dev_inst *modbus,
899                               uint8_t *request, int request_size);
900 SR_PRIV int sr_modbus_reply(struct sr_modbus_dev_inst *modbus,
901                             uint8_t *reply, int reply_size);
902 SR_PRIV int sr_modbus_request_reply(struct sr_modbus_dev_inst *modbus,
903                                     uint8_t *request, int request_size,
904                                     uint8_t *reply, int reply_size);
905 SR_PRIV int sr_modbus_read_coils(struct sr_modbus_dev_inst *modbus,
906                                  int address, int nb_coils, uint8_t *coils);
907 SR_PRIV int sr_modbus_read_holding_registers(struct sr_modbus_dev_inst *modbus,
908                                              int address, int nb_registers,
909                                              uint16_t *registers);
910 SR_PRIV int sr_modbus_write_coil(struct sr_modbus_dev_inst *modbus,
911                                  int address, int value);
912 SR_PRIV int sr_modbus_write_multiple_registers(struct sr_modbus_dev_inst*modbus,
913                                                int address, int nb_registers,
914                                                uint16_t *registers);
915 SR_PRIV int sr_modbus_close(struct sr_modbus_dev_inst *modbus);
916 SR_PRIV void sr_modbus_free(struct sr_modbus_dev_inst *modbus);
917
918 /*--- hardware/dmm/es519xx.c ------------------------------------------------*/
919
920 /**
921  * All 11-byte es519xx chips repeat each block twice for each conversion cycle
922  * so always read 2 blocks at a time.
923  */
924 #define ES519XX_11B_PACKET_SIZE (11 * 2)
925 #define ES519XX_14B_PACKET_SIZE 14
926
927 struct es519xx_info {
928         gboolean is_judge, is_voltage, is_auto, is_micro, is_current;
929         gboolean is_milli, is_resistance, is_continuity, is_diode;
930         gboolean is_frequency, is_rpm, is_capacitance, is_duty_cycle;
931         gboolean is_temperature, is_celsius, is_fahrenheit;
932         gboolean is_adp0, is_adp1, is_adp2, is_adp3;
933         gboolean is_sign, is_batt, is_ol, is_pmax, is_pmin, is_apo;
934         gboolean is_dc, is_ac, is_vahz, is_min, is_max, is_rel, is_hold;
935         gboolean is_digit4, is_ul, is_vasel, is_vbar, is_lpf1, is_lpf0, is_rmr;
936         uint32_t baudrate;
937         int packet_size;
938         gboolean alt_functions, fivedigits, clampmeter, selectable_lpf;
939 };
940
941 SR_PRIV gboolean sr_es519xx_2400_11b_packet_valid(const uint8_t *buf);
942 SR_PRIV int sr_es519xx_2400_11b_parse(const uint8_t *buf, float *floatval,
943                 struct sr_datafeed_analog *analog, void *info);
944 SR_PRIV gboolean sr_es519xx_2400_11b_altfn_packet_valid(const uint8_t *buf);
945 SR_PRIV int sr_es519xx_2400_11b_altfn_parse(const uint8_t *buf,
946                 float *floatval, struct sr_datafeed_analog *analog, void *info);
947 SR_PRIV gboolean sr_es519xx_19200_11b_5digits_packet_valid(const uint8_t *buf);
948 SR_PRIV int sr_es519xx_19200_11b_5digits_parse(const uint8_t *buf,
949                 float *floatval, struct sr_datafeed_analog *analog, void *info);
950 SR_PRIV gboolean sr_es519xx_19200_11b_clamp_packet_valid(const uint8_t *buf);
951 SR_PRIV int sr_es519xx_19200_11b_clamp_parse(const uint8_t *buf,
952                 float *floatval, struct sr_datafeed_analog *analog, void *info);
953 SR_PRIV gboolean sr_es519xx_19200_11b_packet_valid(const uint8_t *buf);
954 SR_PRIV int sr_es519xx_19200_11b_parse(const uint8_t *buf, float *floatval,
955                 struct sr_datafeed_analog *analog, void *info);
956 SR_PRIV gboolean sr_es519xx_19200_14b_packet_valid(const uint8_t *buf);
957 SR_PRIV int sr_es519xx_19200_14b_parse(const uint8_t *buf, float *floatval,
958                 struct sr_datafeed_analog *analog, void *info);
959 SR_PRIV gboolean sr_es519xx_19200_14b_sel_lpf_packet_valid(const uint8_t *buf);
960 SR_PRIV int sr_es519xx_19200_14b_sel_lpf_parse(const uint8_t *buf,
961                 float *floatval, struct sr_datafeed_analog *analog, void *info);
962
963 /*--- hardware/dmm/fs9922.c -------------------------------------------------*/
964
965 #define FS9922_PACKET_SIZE 14
966
967 struct fs9922_info {
968         gboolean is_auto, is_dc, is_ac, is_rel, is_hold, is_bpn, is_z1, is_z2;
969         gboolean is_max, is_min, is_apo, is_bat, is_nano, is_z3, is_micro;
970         gboolean is_milli, is_kilo, is_mega, is_beep, is_diode, is_percent;
971         gboolean is_z4, is_volt, is_ampere, is_ohm, is_hfe, is_hertz, is_farad;
972         gboolean is_celsius, is_fahrenheit;
973         int bargraph_sign, bargraph_value;
974 };
975
976 SR_PRIV gboolean sr_fs9922_packet_valid(const uint8_t *buf);
977 SR_PRIV int sr_fs9922_parse(const uint8_t *buf, float *floatval,
978                             struct sr_datafeed_analog *analog, void *info);
979 SR_PRIV void sr_fs9922_z1_diode(struct sr_datafeed_analog *analog, void *info);
980
981 /*--- hardware/dmm/fs9721.c -------------------------------------------------*/
982
983 #define FS9721_PACKET_SIZE 14
984
985 struct fs9721_info {
986         gboolean is_ac, is_dc, is_auto, is_rs232, is_micro, is_nano, is_kilo;
987         gboolean is_diode, is_milli, is_percent, is_mega, is_beep, is_farad;
988         gboolean is_ohm, is_rel, is_hold, is_ampere, is_volt, is_hz, is_bat;
989         gboolean is_c2c1_11, is_c2c1_10, is_c2c1_01, is_c2c1_00, is_sign;
990 };
991
992 SR_PRIV gboolean sr_fs9721_packet_valid(const uint8_t *buf);
993 SR_PRIV int sr_fs9721_parse(const uint8_t *buf, float *floatval,
994                             struct sr_datafeed_analog *analog, void *info);
995 SR_PRIV void sr_fs9721_00_temp_c(struct sr_datafeed_analog *analog, void *info);
996 SR_PRIV void sr_fs9721_01_temp_c(struct sr_datafeed_analog *analog, void *info);
997 SR_PRIV void sr_fs9721_10_temp_c(struct sr_datafeed_analog *analog, void *info);
998 SR_PRIV void sr_fs9721_01_10_temp_f_c(struct sr_datafeed_analog *analog, void *info);
999 SR_PRIV void sr_fs9721_max_c_min(struct sr_datafeed_analog *analog, void *info);
1000
1001 /*--- hardware/dmm/m2110.c --------------------------------------------------*/
1002
1003 #define BBCGM_M2110_PACKET_SIZE 9
1004
1005 SR_PRIV gboolean sr_m2110_packet_valid(const uint8_t *buf);
1006 SR_PRIV int sr_m2110_parse(const uint8_t *buf, float *floatval,
1007                              struct sr_datafeed_analog *analog, void *info);
1008
1009 /*--- hardware/dmm/metex14.c ------------------------------------------------*/
1010
1011 #define METEX14_PACKET_SIZE 14
1012
1013 struct metex14_info {
1014         gboolean is_ac, is_dc, is_resistance, is_capacity, is_temperature;
1015         gboolean is_diode, is_frequency, is_ampere, is_volt, is_farad;
1016         gboolean is_hertz, is_ohm, is_celsius, is_pico, is_nano, is_micro;
1017         gboolean is_milli, is_kilo, is_mega, is_gain, is_decibel, is_hfe;
1018         gboolean is_unitless, is_logic;
1019 };
1020
1021 #ifdef HAVE_LIBSERIALPORT
1022 SR_PRIV int sr_metex14_packet_request(struct sr_serial_dev_inst *serial);
1023 #endif
1024 SR_PRIV gboolean sr_metex14_packet_valid(const uint8_t *buf);
1025 SR_PRIV int sr_metex14_parse(const uint8_t *buf, float *floatval,
1026                              struct sr_datafeed_analog *analog, void *info);
1027
1028 /*--- hardware/dmm/rs9lcd.c -------------------------------------------------*/
1029
1030 #define RS9LCD_PACKET_SIZE 9
1031
1032 /* Dummy info struct. The parser does not use it. */
1033 struct rs9lcd_info { int dummy; };
1034
1035 SR_PRIV gboolean sr_rs9lcd_packet_valid(const uint8_t *buf);
1036 SR_PRIV int sr_rs9lcd_parse(const uint8_t *buf, float *floatval,
1037                             struct sr_datafeed_analog *analog, void *info);
1038
1039 /*--- hardware/dmm/bm25x.c --------------------------------------------------*/
1040
1041 #define BRYMEN_BM25X_PACKET_SIZE 15
1042
1043 /* Dummy info struct. The parser does not use it. */
1044 struct bm25x_info { int dummy; };
1045
1046 SR_PRIV gboolean sr_brymen_bm25x_packet_valid(const uint8_t *buf);
1047 SR_PRIV int sr_brymen_bm25x_parse(const uint8_t *buf, float *floatval,
1048                              struct sr_datafeed_analog *analog, void *info);
1049
1050 /*--- hardware/dmm/ut71x.c --------------------------------------------------*/
1051
1052 #define UT71X_PACKET_SIZE 11
1053
1054 struct ut71x_info {
1055         gboolean is_voltage, is_resistance, is_capacitance, is_temperature;
1056         gboolean is_celsius, is_fahrenheit, is_current, is_continuity;
1057         gboolean is_diode, is_frequency, is_duty_cycle, is_dc, is_ac;
1058         gboolean is_auto, is_manual, is_sign, is_power, is_loop_current;
1059 };
1060
1061 SR_PRIV gboolean sr_ut71x_packet_valid(const uint8_t *buf);
1062 SR_PRIV int sr_ut71x_parse(const uint8_t *buf, float *floatval,
1063                 struct sr_datafeed_analog *analog, void *info);
1064
1065 /*--- hardware/dmm/vc870.c --------------------------------------------------*/
1066
1067 #define VC870_PACKET_SIZE 23
1068
1069 struct vc870_info {
1070         gboolean is_voltage, is_dc, is_ac, is_temperature, is_resistance;
1071         gboolean is_continuity, is_capacitance, is_diode, is_loop_current;
1072         gboolean is_current, is_micro, is_milli, is_power;
1073         gboolean is_power_factor_freq, is_power_apparent_power, is_v_a_eff_value;
1074         gboolean is_sign2, is_sign1, is_batt, is_ol1, is_max, is_min;
1075         gboolean is_maxmin, is_rel, is_ol2, is_open, is_manu, is_hold;
1076         gboolean is_light, is_usb, is_warning, is_auto_power, is_misplug_warn;
1077         gboolean is_lo, is_hi, is_open2;
1078
1079         gboolean is_frequency, is_dual_display, is_auto, is_rms;
1080 };
1081
1082 SR_PRIV gboolean sr_vc870_packet_valid(const uint8_t *buf);
1083 SR_PRIV int sr_vc870_parse(const uint8_t *buf, float *floatval,
1084                 struct sr_datafeed_analog *analog, void *info);
1085
1086 /*--- hardware/lcr/es51919.c ------------------------------------------------*/
1087
1088 SR_PRIV void es51919_serial_clean(void *priv);
1089 SR_PRIV struct sr_dev_inst *es51919_serial_scan(GSList *options,
1090                                                 const char *vendor,
1091                                                 const char *model);
1092 SR_PRIV int es51919_serial_config_get(uint32_t key, GVariant **data,
1093                                       const struct sr_dev_inst *sdi,
1094                                       const struct sr_channel_group *cg);
1095 SR_PRIV int es51919_serial_config_set(uint32_t key, GVariant *data,
1096                                       const struct sr_dev_inst *sdi,
1097                                       const struct sr_channel_group *cg);
1098 SR_PRIV int es51919_serial_config_list(uint32_t key, GVariant **data,
1099                                        const struct sr_dev_inst *sdi,
1100                                        const struct sr_channel_group *cg);
1101 SR_PRIV int es51919_serial_acquisition_start(const struct sr_dev_inst *sdi,
1102                                              void *cb_data);
1103 SR_PRIV int es51919_serial_acquisition_stop(struct sr_dev_inst *sdi,
1104                                             void *cb_data);
1105
1106 /*--- hardware/dmm/ut372.c --------------------------------------------------*/
1107
1108 #define UT372_PACKET_SIZE 27
1109
1110 struct ut372_info {
1111         int dummy;
1112 };
1113
1114 SR_PRIV gboolean sr_ut372_packet_valid(const uint8_t *buf);
1115 SR_PRIV int sr_ut372_parse(const uint8_t *buf, float *floatval,
1116                 struct sr_datafeed_analog *analog, void *info);
1117
1118 /*--- hardware/scale/kern.c -------------------------------------------------*/
1119
1120 struct kern_info {
1121         gboolean is_gram, is_carat, is_ounce, is_pound, is_troy_ounce;
1122         gboolean is_pennyweight, is_grain, is_tael, is_momme, is_tola;
1123         gboolean is_percentage, is_piece, is_unstable, is_stable, is_error;
1124         int buflen;
1125 };
1126
1127 SR_PRIV gboolean sr_kern_packet_valid(const uint8_t *buf);
1128 SR_PRIV int sr_kern_parse(const uint8_t *buf, float *floatval,
1129                 struct sr_datafeed_analog *analog, void *info);
1130
1131 #endif