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