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