2 * This file is part of the libsigrok project.
4 * Copyright (C) 2013 Bert Vermeulen <bert@biot.com>
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.
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.
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/>.
24 #ifndef LIBSIGROK_LIBSIGROK_INTERNAL_H
25 #define LIBSIGROK_LIBSIGROK_INTERNAL_H
29 #include "config.h" /* Needed for HAVE_LIBUSB_1_0 and others. */
30 #ifdef HAVE_LIBUSB_1_0
33 #ifdef HAVE_LIBSERIALPORT
34 #include <libserialport.h>
40 * libsigrok private header file, only to be used internally.
43 /*--- Macros ----------------------------------------------------------------*/
46 #define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0]))
49 #ifndef ARRAY_AND_SIZE
50 #define ARRAY_AND_SIZE(a) (a), ARRAY_SIZE(a)
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
58 #define R8(x) ((unsigned)((const uint8_t*)(x))[0])
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
65 #define RB16(x) (((unsigned)((const uint8_t*)(x))[0] << 8) | \
66 (unsigned)((const uint8_t*)(x))[1])
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
73 #define RL16(x) (((unsigned)((const uint8_t*)(x))[1] << 8) | \
74 (unsigned)((const uint8_t*)(x))[0])
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
81 #define RL16S(x) ((int16_t) \
82 (((unsigned)((const uint8_t*)(x))[1] << 8) | \
83 (unsigned)((const uint8_t*)(x))[0]))
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
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])
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
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])
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
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]))
117 * Write a 8 bits unsigned integer to memory.
118 * @param p a pointer to the output memory
119 * @param x the input unsigned integer
121 #define W8(p, x) do { ((uint8_t*)(p))[0] = (uint8_t) (x); } while (0)
124 * Write a 16 bits unsigned integer to memory stored as big endian.
125 * @param p a pointer to the output memory
126 * @param x the input unsigned integer
128 #define WB16(p, x) do { ((uint8_t*)(p))[1] = (uint8_t) (x); \
129 ((uint8_t*)(p))[0] = (uint8_t)((x)>>8); } while (0)
132 * Write a 16 bits unsigned integer to memory stored as little endian.
133 * @param p a pointer to the output memory
134 * @param x the input unsigned integer
136 #define WL16(p, x) do { ((uint8_t*)(p))[0] = (uint8_t) (x); \
137 ((uint8_t*)(p))[1] = (uint8_t)((x)>>8); } while (0)
140 * Write a 32 bits unsigned integer to memory stored as big endian.
141 * @param p a pointer to the output memory
142 * @param x the input unsigned integer
144 #define WB32(p, x) do { ((uint8_t*)(p))[3] = (uint8_t) (x); \
145 ((uint8_t*)(p))[2] = (uint8_t)((x)>>8); \
146 ((uint8_t*)(p))[1] = (uint8_t)((x)>>16); \
147 ((uint8_t*)(p))[0] = (uint8_t)((x)>>24); } while (0)
150 * Write a 32 bits unsigned integer to memory stored as little endian.
151 * @param p a pointer to the output memory
152 * @param x the input unsigned integer
154 #define WL32(p, x) do { ((uint8_t*)(p))[0] = (uint8_t) (x); \
155 ((uint8_t*)(p))[1] = (uint8_t)((x)>>8); \
156 ((uint8_t*)(p))[2] = (uint8_t)((x)>>16); \
157 ((uint8_t*)(p))[3] = (uint8_t)((x)>>24); } while (0)
159 #define PI 3.1415926535897932384626433832795
161 /* Portability fixes for FreeBSD. */
163 #define LIBUSB_CLASS_APPLICATION 0xfe
164 #define libusb_has_capability(x) 0
165 #define libusb_handle_events_timeout_completed(ctx, tv, c) \
166 libusb_handle_events_timeout(ctx, tv)
169 /* Static definitions of structs ending with an all-zero entry are a
170 * problem when compiling with -Wmissing-field-initializers: GCC
171 * suppresses the warning only with { 0 }, clang wants { } */
175 #define ALL_ZERO { 0 }
179 struct sr_dev_driver **driver_list;
180 #ifdef HAVE_LIBUSB_1_0
181 libusb_context *libusb_ctx;
182 gboolean usb_source_present;
185 gboolean usb_thread_running;
186 HANDLE usb_wait_request_event;
187 HANDLE usb_wait_complete_event;
189 sr_receive_data_callback usb_cb;
195 /** Input module metadata keys. */
196 enum sr_input_meta_keys {
197 /** The input filename, if there is one. */
198 SR_INPUT_META_FILENAME = 0x01,
199 /** The input file's size in bytes. */
200 SR_INPUT_META_FILESIZE = 0x02,
201 /** The first 128 bytes of the file, provided as a GString. */
202 SR_INPUT_META_HEADER = 0x04,
203 /** The file's MIME type. */
204 SR_INPUT_META_MIMETYPE = 0x08,
206 /** The module cannot identify a file without this metadata. */
207 SR_INPUT_META_REQUIRED = 0x80,
210 /** Input (file) module struct. */
213 * A pointer to this input module's 'struct sr_input_module'.
215 const struct sr_input_module *module;
217 struct sr_dev_inst *sdi;
222 /** Input (file) module driver. */
223 struct sr_input_module {
225 * A unique ID for this input module, suitable for use in command-line
226 * clients, [a-z0-9-]. Must not be NULL.
231 * A unique name for this input module, suitable for use in GUI
232 * clients, can contain UTF-8. Must not be NULL.
237 * A short description of the input module. Must not be NULL.
239 * This can be displayed by frontends, e.g. when selecting the input
240 * module for saving a file.
245 * A NULL terminated array of strings containing a list of file name
246 * extensions typical for the input file format, or NULL if there is
247 * no typical extension for this file format.
249 const char *const *exts;
252 * Zero-terminated list of metadata items the module needs to be able
253 * to identify an input stream. Can be all-zero, if the module cannot
254 * identify streams at all, i.e. has to be forced into use.
256 * Each item is one of:
257 * SR_INPUT_META_FILENAME
258 * SR_INPUT_META_FILESIZE
259 * SR_INPUT_META_HEADER
260 * SR_INPUT_META_MIMETYPE
262 * If the high bit (SR_INPUT META_REQUIRED) is set, the module cannot
263 * identify a stream without the given metadata.
265 const uint8_t metadata[8];
268 * Returns a NULL-terminated list of options this module can take.
269 * Can be NULL, if the module has no options.
271 struct sr_option *(*options) (void);
274 * Check if this input module can load and parse the specified stream.
276 * @param[in] metadata Metadata the module can use to identify the stream.
278 * @retval SR_OK This module knows the format.
279 * @retval SR_ERR_NA There wasn't enough data for this module to
280 * positively identify the format.
281 * @retval SR_ERR_DATA This module knows the format, but cannot handle it.
282 * This means the stream is either corrupt, or indicates a feature
283 * that the module does not support.
284 * @retval SR_ERR This module does not know the format.
286 int (*format_match) (GHashTable *metadata);
289 * Initialize the input module.
291 * @retval SR_OK Success
292 * @retval other Negative error code.
294 int (*init) (struct sr_input *in, GHashTable *options);
297 * Send data to the specified input instance.
299 * When an input module instance is created with sr_input_new(), this
300 * function is used to feed data to the instance.
302 * As enough data gets fed into this function to completely populate
303 * the device instance associated with this input instance, this is
304 * guaranteed to return the moment it's ready. This gives the caller
305 * the chance to examine the device instance, attach session callbacks
308 * @retval SR_OK Success
309 * @retval other Negative error code.
311 int (*receive) (struct sr_input *in, GString *buf);
314 * Signal the input module no more data will come.
316 * This will cause the module to process any data it may have buffered.
317 * The SR_DF_END packet will also typically be sent at this time.
319 int (*end) (struct sr_input *in);
322 * This function is called after the caller is finished using
323 * the input module, and can be used to free any internal
324 * resources the module may keep.
326 * This function is optional.
328 * @retval SR_OK Success
329 * @retval other Negative error code.
331 void (*cleanup) (struct sr_input *in);
334 /** Output module instance. */
336 /** A pointer to this output's module. */
337 const struct sr_output_module *module;
340 * The device for which this output module is creating output. This
341 * can be used by the module to find out channel names and numbers.
343 const struct sr_dev_inst *sdi;
346 * A generic pointer which can be used by the module to keep internal
347 * state between calls into its callback functions.
349 * For example, the module might store a pointer to a chunk of output
350 * there, and only flush it when it reaches a certain size.
355 /** Output module driver. */
356 struct sr_output_module {
358 * A unique ID for this output module, suitable for use in command-line
359 * clients, [a-z0-9-]. Must not be NULL.
364 * A unique name for this output module, suitable for use in GUI
365 * clients, can contain UTF-8. Must not be NULL.
370 * A short description of the output module. Must not be NULL.
372 * This can be displayed by frontends, e.g. when selecting the output
373 * module for saving a file.
378 * A NULL terminated array of strings containing a list of file name
379 * extensions typical for the input file format, or NULL if there is
380 * no typical extension for this file format.
382 const char *const *exts;
385 * Returns a NULL-terminated list of options this module can take.
386 * Can be NULL, if the module has no options.
388 const struct sr_option *(*options) (void);
391 * This function is called once, at the beginning of an output stream.
393 * The device struct will be available in the output struct passed in,
394 * as well as the param field -- which may be NULL or an empty string,
395 * if no parameter was passed.
397 * The module can use this to initialize itself, create a struct for
398 * keeping state and storing it in the <code>internal</code> field.
400 * @param o Pointer to the respective 'struct sr_output'.
402 * @retval SR_OK Success
403 * @retval other Negative error code.
405 int (*init) (struct sr_output *o, GHashTable *options);
408 * This function is passed a copy of every packet in the data feed.
409 * Any output generated by the output module in response to the
410 * packet should be returned in a newly allocated GString
411 * <code>out</code>, which will be freed by the caller.
413 * Packets not of interest to the output module can just be ignored,
414 * and the <code>out</code> parameter set to NULL.
416 * @param o Pointer to the respective 'struct sr_output'.
417 * @param sdi The device instance that generated the packet.
418 * @param packet The complete packet.
419 * @param out A pointer where a GString * should be stored if
420 * the module generates output, or NULL if not.
422 * @retval SR_OK Success
423 * @retval other Negative error code.
425 int (*receive) (const struct sr_output *o,
426 const struct sr_datafeed_packet *packet, GString **out);
429 * This function is called after the caller is finished using
430 * the output module, and can be used to free any internal
431 * resources the module may keep.
433 * @retval SR_OK Success
434 * @retval other Negative error code.
436 int (*cleanup) (struct sr_output *o);
439 /** Transform module instance. */
440 struct sr_transform {
441 /** A pointer to this transform's module. */
442 const struct sr_transform_module *module;
445 * The device for which this transform module is used. This
446 * can be used by the module to find out channel names and numbers.
448 const struct sr_dev_inst *sdi;
451 * A generic pointer which can be used by the module to keep internal
452 * state between calls into its callback functions.
457 struct sr_transform_module {
459 * A unique ID for this transform module, suitable for use in
460 * command-line clients, [a-z0-9-]. Must not be NULL.
465 * A unique name for this transform module, suitable for use in GUI
466 * clients, can contain UTF-8. Must not be NULL.
471 * A short description of the transform module. Must not be NULL.
473 * This can be displayed by frontends, e.g. when selecting
474 * which transform module(s) to add.
479 * Returns a NULL-terminated list of options this transform module
480 * can take. Can be NULL, if the transform module has no options.
482 const struct sr_option *(*options) (void);
485 * This function is called once, at the beginning of a stream.
487 * @param t Pointer to the respective 'struct sr_transform'.
488 * @param options Hash table of options for this transform module.
489 * Can be NULL if no options are to be used.
491 * @retval SR_OK Success
492 * @retval other Negative error code.
494 int (*init) (struct sr_transform *t, GHashTable *options);
497 * This function is passed a pointer to every packet in the data feed.
499 * It can either return (in packet_out) a pointer to another packet
500 * (possibly the exact same packet it got as input), or NULL.
502 * @param t Pointer to the respective 'struct sr_transform'.
503 * @param packet_in Pointer to a datafeed packet.
504 * @param packet_out Pointer to the resulting datafeed packet after
505 * this function was run. If NULL, the transform
506 * module intentionally didn't output a new packet.
508 * @retval SR_OK Success
509 * @retval other Negative error code.
511 int (*receive) (const struct sr_transform *t,
512 struct sr_datafeed_packet *packet_in,
513 struct sr_datafeed_packet **packet_out);
516 * This function is called after the caller is finished using
517 * the transform module, and can be used to free any internal
518 * resources the module may keep.
520 * @retval SR_OK Success
521 * @retval other Negative error code.
523 int (*cleanup) (struct sr_transform *t);
526 #ifdef HAVE_LIBUSB_1_0
527 /** USB device instance */
528 struct sr_usb_dev_inst {
531 /** Device address on USB bus */
533 /** libusb device handle */
534 struct libusb_device_handle *devhdl;
538 #ifdef HAVE_LIBSERIALPORT
539 #define SERIAL_PARITY_NONE SP_PARITY_NONE
540 #define SERIAL_PARITY_EVEN SP_PARITY_EVEN
541 #define SERIAL_PARITY_ODD SP_PARITY_ODD
542 struct sr_serial_dev_inst {
543 /** Port name, e.g. '/dev/tty42'. */
545 /** Comm params for serial_set_paramstr(). */
547 /** libserialport port handle */
548 struct sp_port *data;
549 /** libserialport event set */
550 struct sp_event_set *event_set;
551 /** GPollFDs for event polling */
556 struct sr_usbtmc_dev_inst {
561 /* Private driver context. */
563 /** sigrok context */
564 struct sr_context *sr_ctx;
568 /*--- log.c -----------------------------------------------------------------*/
570 SR_PRIV int sr_log(int loglevel, const char *format, ...);
571 SR_PRIV int sr_spew(const char *format, ...);
572 SR_PRIV int sr_dbg(const char *format, ...);
573 SR_PRIV int sr_info(const char *format, ...);
574 SR_PRIV int sr_warn(const char *format, ...);
575 SR_PRIV int sr_err(const char *format, ...);
577 /* Message logging helpers with subsystem-specific prefix string. */
578 #ifndef NO_LOG_WRAPPERS
579 #define sr_log(l, s, args...) sr_log(l, "%s: " s, LOG_PREFIX, ## args)
580 #define sr_spew(s, args...) sr_spew("%s: " s, LOG_PREFIX, ## args)
581 #define sr_dbg(s, args...) sr_dbg("%s: " s, LOG_PREFIX, ## args)
582 #define sr_info(s, args...) sr_info("%s: " s, LOG_PREFIX, ## args)
583 #define sr_warn(s, args...) sr_warn("%s: " s, LOG_PREFIX, ## args)
584 #define sr_err(s, args...) sr_err("%s: " s, LOG_PREFIX, ## args)
587 /*--- device.c --------------------------------------------------------------*/
589 /** Values for the changes argument of sr_dev_driver.config_channel_set. */
591 /** The enabled state of the channel has been changed. */
592 SR_CHANNEL_SET_ENABLED = 1 << 0,
595 SR_PRIV struct sr_channel *sr_channel_new(struct sr_dev_inst *sdi,
596 int index, int type, gboolean enabled, const char *name);
598 /** Device instance data */
600 /** Device driver. */
601 struct sr_dev_driver *driver;
602 /** Device instance status. SR_ST_NOT_FOUND, etc. */
604 /** Device instance type. SR_INST_USB, etc. */
606 /** Device vendor. */
610 /** Device version. */
612 /** Serial number. */
614 /** Connection string to uniquely identify devices. */
616 /** List of channels. */
618 /** List of sr_channel_group structs */
619 GSList *channel_groups;
620 /** Device instance connection data (used?) */
622 /** Device instance private data (used?) */
624 /** Session to which this device is currently assigned. */
625 struct sr_session *session;
628 /* Generic device instances */
629 SR_PRIV void sr_dev_inst_free(struct sr_dev_inst *sdi);
631 #ifdef HAVE_LIBUSB_1_0
632 /* USB-specific instances */
633 SR_PRIV struct sr_usb_dev_inst *sr_usb_dev_inst_new(uint8_t bus,
634 uint8_t address, struct libusb_device_handle *hdl);
635 SR_PRIV void sr_usb_dev_inst_free(struct sr_usb_dev_inst *usb);
638 #ifdef HAVE_LIBSERIALPORT
639 /* Serial-specific instances */
640 SR_PRIV struct sr_serial_dev_inst *sr_serial_dev_inst_new(const char *port,
641 const char *serialcomm);
642 SR_PRIV void sr_serial_dev_inst_free(struct sr_serial_dev_inst *serial);
645 /* USBTMC-specific instances */
646 SR_PRIV struct sr_usbtmc_dev_inst *sr_usbtmc_dev_inst_new(const char *device);
647 SR_PRIV void sr_usbtmc_dev_inst_free(struct sr_usbtmc_dev_inst *usbtmc);
649 /*--- hwdriver.c ------------------------------------------------------------*/
651 extern SR_PRIV struct sr_dev_driver **drivers_lists[];
653 SR_PRIV const GVariantType *sr_variant_type_get(int datatype);
654 SR_PRIV int sr_variant_type_check(uint32_t key, GVariant *data);
655 SR_PRIV void sr_hw_cleanup_all(const struct sr_context *ctx);
656 SR_PRIV struct sr_config *sr_config_new(uint32_t key, GVariant *data);
657 SR_PRIV void sr_config_free(struct sr_config *src);
658 SR_PRIV int sr_source_remove(int fd);
659 SR_PRIV int sr_source_remove_pollfd(GPollFD *pollfd);
660 SR_PRIV int sr_source_remove_channel(GIOChannel *channel);
661 SR_PRIV int sr_source_add(int fd, int events, int timeout,
662 sr_receive_data_callback cb, void *cb_data);
663 SR_PRIV int sr_source_add_pollfd(GPollFD *pollfd, int timeout,
664 sr_receive_data_callback cb, void *cb_data);
665 SR_PRIV int sr_source_add_channel(GIOChannel *channel, int events, int timeout,
666 sr_receive_data_callback cb, void *cb_data);
668 /*--- session.c -------------------------------------------------------------*/
671 /** Context this session exists in. */
672 struct sr_context *ctx;
673 /** List of struct sr_dev_inst pointers. */
675 /** List of struct sr_dev_inst pointers owned by this session. */
677 /** List of struct datafeed_callback pointers. */
678 GSList *datafeed_callbacks;
680 struct sr_trigger *trigger;
684 unsigned int num_sources;
687 * Both "sources" and "pollfds" are of the same size and contain pairs
688 * of descriptor and callback function. We can not embed the GPollFD
689 * into the source struct since we want to be able to pass the array
690 * of all poll descriptors to g_poll().
692 struct source *sources;
697 * These are our synchronization primitives for stopping the session in
698 * an async fashion. We need to make sure the session is stopped from
699 * within the session thread itself.
701 /** Mutex protecting access to abort_session. */
703 /** Abort current session. See sr_session_stop(). */
704 gboolean abort_session;
707 SR_PRIV int sr_session_send(const struct sr_dev_inst *sdi,
708 const struct sr_datafeed_packet *packet);
709 SR_PRIV int sr_session_stop_sync(struct sr_session *session);
710 SR_PRIV int sr_sessionfile_check(const char *filename);
711 SR_PRIV int sr_packet_copy(const struct sr_datafeed_packet *packet,
712 struct sr_datafeed_packet **copy);
713 SR_PRIV void sr_packet_free(struct sr_datafeed_packet *packet);
715 /*--- analog.c --------------------------------------------------------------*/
717 SR_PRIV int sr_analog_init(struct sr_datafeed_analog2 *analog,
718 struct sr_analog_encoding *encoding,
719 struct sr_analog_meaning *meaning,
720 struct sr_analog_spec *spec,
723 /*--- std.c -----------------------------------------------------------------*/
725 typedef int (*dev_close_callback)(struct sr_dev_inst *sdi);
726 typedef void (*std_dev_clear_callback)(void *priv);
728 SR_PRIV int std_init(struct sr_context *sr_ctx, struct sr_dev_driver *di,
730 #ifdef HAVE_LIBSERIALPORT
731 SR_PRIV int std_serial_dev_open(struct sr_dev_inst *sdi);
732 SR_PRIV int std_serial_dev_acquisition_stop(struct sr_dev_inst *sdi,
733 void *cb_data, dev_close_callback dev_close_fn,
734 struct sr_serial_dev_inst *serial, const char *prefix);
736 SR_PRIV int std_session_send_df_header(const struct sr_dev_inst *sdi,
738 SR_PRIV int std_dev_clear(const struct sr_dev_driver *driver,
739 std_dev_clear_callback clear_private);
740 SR_PRIV int std_serial_dev_close(struct sr_dev_inst *sdi);
742 /*--- strutil.c -------------------------------------------------------------*/
744 SR_PRIV int sr_atol(const char *str, long *ret);
745 SR_PRIV int sr_atoi(const char *str, int *ret);
746 SR_PRIV int sr_atod(const char *str, double *ret);
747 SR_PRIV int sr_atof(const char *str, float *ret);
748 SR_PRIV int sr_atof_ascii(const char *str, float *ret);
750 /*--- soft-trigger.c --------------------------------------------------------*/
752 struct soft_trigger_logic {
753 const struct sr_dev_inst *sdi;
754 const struct sr_trigger *trigger;
758 uint8_t *prev_sample;
759 uint8_t *pre_trigger_buffer;
760 uint8_t *pre_trigger_head;
761 int pre_trigger_size;
762 int pre_trigger_fill;
765 SR_PRIV struct soft_trigger_logic *soft_trigger_logic_new(
766 const struct sr_dev_inst *sdi, struct sr_trigger *trigger,
767 int pre_trigger_samples);
768 SR_PRIV void soft_trigger_logic_free(struct soft_trigger_logic *st);
769 SR_PRIV int soft_trigger_logic_check(struct soft_trigger_logic *st, uint8_t *buf,
770 int len, int *pre_trigger_samples);
772 /*--- hardware/serial.c -----------------------------------------------------*/
774 #ifdef HAVE_LIBSERIALPORT
780 typedef gboolean (*packet_valid_callback)(const uint8_t *buf);
782 SR_PRIV int serial_open(struct sr_serial_dev_inst *serial, int flags);
783 SR_PRIV int serial_close(struct sr_serial_dev_inst *serial);
784 SR_PRIV int serial_flush(struct sr_serial_dev_inst *serial);
785 SR_PRIV int serial_drain(struct sr_serial_dev_inst *serial);
786 SR_PRIV int serial_write_blocking(struct sr_serial_dev_inst *serial,
787 const void *buf, size_t count, unsigned int timeout_ms);
788 SR_PRIV int serial_write_nonblocking(struct sr_serial_dev_inst *serial,
789 const void *buf, size_t count);
790 SR_PRIV int serial_read_blocking(struct sr_serial_dev_inst *serial, void *buf,
791 size_t count, unsigned int timeout_ms);
792 SR_PRIV int serial_read_nonblocking(struct sr_serial_dev_inst *serial, void *buf,
794 SR_PRIV int serial_set_params(struct sr_serial_dev_inst *serial, int baudrate,
795 int bits, int parity, int stopbits, int flowcontrol, int rts, int dtr);
796 SR_PRIV int serial_set_paramstr(struct sr_serial_dev_inst *serial,
797 const char *paramstr);
798 SR_PRIV int serial_readline(struct sr_serial_dev_inst *serial, char **buf,
799 int *buflen, gint64 timeout_ms);
800 SR_PRIV int serial_stream_detect(struct sr_serial_dev_inst *serial,
801 uint8_t *buf, size_t *buflen,
803 packet_valid_callback is_valid,
804 uint64_t timeout_ms, int baudrate);
805 SR_PRIV int sr_serial_extract_options(GSList *options, const char **serial_device,
806 const char **serial_options);
807 SR_PRIV int serial_source_add(struct sr_session *session,
808 struct sr_serial_dev_inst *serial, int events, int timeout,
809 sr_receive_data_callback cb, void *cb_data);
810 SR_PRIV int serial_source_remove(struct sr_session *session,
811 struct sr_serial_dev_inst *serial);
812 SR_PRIV GSList *sr_serial_find_usb(uint16_t vendor_id, uint16_t product_id);
813 SR_PRIV int serial_timeout(struct sr_serial_dev_inst *port, int num_bytes);
816 /*--- hardware/ezusb.c ------------------------------------------------------*/
818 #ifdef HAVE_LIBUSB_1_0
819 SR_PRIV int ezusb_reset(struct libusb_device_handle *hdl, int set_clear);
820 SR_PRIV int ezusb_install_firmware(libusb_device_handle *hdl,
821 const char *filename);
822 SR_PRIV int ezusb_upload_firmware(libusb_device *dev, int configuration,
823 const char *filename);
826 /*--- hardware/usb.c --------------------------------------------------------*/
828 #ifdef HAVE_LIBUSB_1_0
829 SR_PRIV GSList *sr_usb_find(libusb_context *usb_ctx, const char *conn);
830 SR_PRIV int sr_usb_open(libusb_context *usb_ctx, struct sr_usb_dev_inst *usb);
831 SR_PRIV int usb_source_add(struct sr_session *session, struct sr_context *ctx,
832 int timeout, sr_receive_data_callback cb, void *cb_data);
833 SR_PRIV int usb_source_remove(struct sr_session *session, struct sr_context *ctx);
834 SR_PRIV int usb_get_port_path(libusb_device *dev, char *path, int path_len);
837 /*--- hardware/scpi.c -------------------------------------------------------*/
839 #define SCPI_CMD_IDN "*IDN?"
840 #define SCPI_CMD_OPC "*OPC?"
843 SCPI_CMD_SET_TRIGGER_SOURCE,
844 SCPI_CMD_SET_TIMEBASE,
845 SCPI_CMD_SET_VERTICAL_DIV,
846 SCPI_CMD_SET_TRIGGER_SLOPE,
847 SCPI_CMD_SET_COUPLING,
848 SCPI_CMD_SET_HORIZ_TRIGGERPOS,
849 SCPI_CMD_GET_ANALOG_CHAN_STATE,
850 SCPI_CMD_GET_DIG_CHAN_STATE,
851 SCPI_CMD_GET_TIMEBASE,
852 SCPI_CMD_GET_VERTICAL_DIV,
853 SCPI_CMD_GET_VERTICAL_OFFSET,
854 SCPI_CMD_GET_TRIGGER_SOURCE,
855 SCPI_CMD_GET_HORIZ_TRIGGERPOS,
856 SCPI_CMD_GET_TRIGGER_SLOPE,
857 SCPI_CMD_GET_COUPLING,
858 SCPI_CMD_SET_ANALOG_CHAN_STATE,
859 SCPI_CMD_SET_DIG_CHAN_STATE,
860 SCPI_CMD_GET_DIG_POD_STATE,
861 SCPI_CMD_SET_DIG_POD_STATE,
862 SCPI_CMD_GET_ANALOG_DATA,
863 SCPI_CMD_GET_DIG_DATA,
864 SCPI_CMD_GET_SAMPLE_RATE,
865 SCPI_CMD_GET_SAMPLE_RATE_LIVE,
868 struct sr_scpi_hw_info {
872 char *firmware_version;
875 struct sr_scpi_dev_inst {
879 GSList *(*scan)(struct drv_context *drvc);
880 int (*dev_inst_new)(void *priv, struct drv_context *drvc,
881 const char *resource, char **params, const char *serialcomm);
882 int (*open)(void *priv);
883 int (*source_add)(struct sr_session *session, void *priv, int events,
884 int timeout, sr_receive_data_callback cb, void *cb_data);
885 int (*source_remove)(struct sr_session *session, void *priv);
886 int (*send)(void *priv, const char *command);
887 int (*read_begin)(void *priv);
888 int (*read_data)(void *priv, char *buf, int maxlen);
889 int (*read_complete)(void *priv);
890 int (*close)(void *priv);
891 void (*free)(void *priv);
892 unsigned int read_timeout_ms;
896 SR_PRIV GSList *sr_scpi_scan(struct drv_context *drvc, GSList *options,
897 struct sr_dev_inst *(*probe_device)(struct sr_scpi_dev_inst *scpi));
898 SR_PRIV struct sr_scpi_dev_inst *scpi_dev_inst_new(struct drv_context *drvc,
899 const char *resource, const char *serialcomm);
900 SR_PRIV int sr_scpi_open(struct sr_scpi_dev_inst *scpi);
901 SR_PRIV int sr_scpi_source_add(struct sr_session *session,
902 struct sr_scpi_dev_inst *scpi, int events, int timeout,
903 sr_receive_data_callback cb, void *cb_data);
904 SR_PRIV int sr_scpi_source_remove(struct sr_session *session,
905 struct sr_scpi_dev_inst *scpi);
906 SR_PRIV int sr_scpi_send(struct sr_scpi_dev_inst *scpi,
907 const char *format, ...);
908 SR_PRIV int sr_scpi_send_variadic(struct sr_scpi_dev_inst *scpi,
909 const char *format, va_list args);
910 SR_PRIV int sr_scpi_read_begin(struct sr_scpi_dev_inst *scpi);
911 SR_PRIV int sr_scpi_read_data(struct sr_scpi_dev_inst *scpi, char *buf, int maxlen);
912 SR_PRIV int sr_scpi_read_complete(struct sr_scpi_dev_inst *scpi);
913 SR_PRIV int sr_scpi_close(struct sr_scpi_dev_inst *scpi);
914 SR_PRIV void sr_scpi_free(struct sr_scpi_dev_inst *scpi);
916 SR_PRIV int sr_scpi_get_string(struct sr_scpi_dev_inst *scpi,
917 const char *command, char **scpi_response);
918 SR_PRIV int sr_scpi_get_bool(struct sr_scpi_dev_inst *scpi,
919 const char *command, gboolean *scpi_response);
920 SR_PRIV int sr_scpi_get_int(struct sr_scpi_dev_inst *scpi,
921 const char *command, int *scpi_response);
922 SR_PRIV int sr_scpi_get_float(struct sr_scpi_dev_inst *scpi,
923 const char *command, float *scpi_response);
924 SR_PRIV int sr_scpi_get_double(struct sr_scpi_dev_inst *scpi,
925 const char *command, double *scpi_response);
926 SR_PRIV int sr_scpi_get_opc(struct sr_scpi_dev_inst *scpi);
927 SR_PRIV int sr_scpi_get_floatv(struct sr_scpi_dev_inst *scpi,
928 const char *command, GArray **scpi_response);
929 SR_PRIV int sr_scpi_get_uint8v(struct sr_scpi_dev_inst *scpi,
930 const char *command, GArray **scpi_response);
931 SR_PRIV int sr_scpi_get_hw_id(struct sr_scpi_dev_inst *scpi,
932 struct sr_scpi_hw_info **scpi_response);
933 SR_PRIV void sr_scpi_hw_info_free(struct sr_scpi_hw_info *hw_info);
935 /*--- hardware/dmm/es519xx.c ------------------------------------------------*/
938 * All 11-byte es519xx chips repeat each block twice for each conversion cycle
939 * so always read 2 blocks at a time.
941 #define ES519XX_11B_PACKET_SIZE (11 * 2)
942 #define ES519XX_14B_PACKET_SIZE 14
944 struct es519xx_info {
945 gboolean is_judge, is_voltage, is_auto, is_micro, is_current;
946 gboolean is_milli, is_resistance, is_continuity, is_diode;
947 gboolean is_frequency, is_rpm, is_capacitance, is_duty_cycle;
948 gboolean is_temperature, is_celsius, is_fahrenheit;
949 gboolean is_adp0, is_adp1, is_adp2, is_adp3;
950 gboolean is_sign, is_batt, is_ol, is_pmax, is_pmin, is_apo;
951 gboolean is_dc, is_ac, is_vahz, is_min, is_max, is_rel, is_hold;
952 gboolean is_digit4, is_ul, is_vasel, is_vbar, is_lpf1, is_lpf0, is_rmr;
955 gboolean alt_functions, fivedigits, clampmeter, selectable_lpf;
958 SR_PRIV gboolean sr_es519xx_2400_11b_packet_valid(const uint8_t *buf);
959 SR_PRIV int sr_es519xx_2400_11b_parse(const uint8_t *buf, float *floatval,
960 struct sr_datafeed_analog *analog, void *info);
961 SR_PRIV gboolean sr_es519xx_2400_11b_altfn_packet_valid(const uint8_t *buf);
962 SR_PRIV int sr_es519xx_2400_11b_altfn_parse(const uint8_t *buf,
963 float *floatval, struct sr_datafeed_analog *analog, void *info);
964 SR_PRIV gboolean sr_es519xx_19200_11b_5digits_packet_valid(const uint8_t *buf);
965 SR_PRIV int sr_es519xx_19200_11b_5digits_parse(const uint8_t *buf,
966 float *floatval, struct sr_datafeed_analog *analog, void *info);
967 SR_PRIV gboolean sr_es519xx_19200_11b_clamp_packet_valid(const uint8_t *buf);
968 SR_PRIV int sr_es519xx_19200_11b_clamp_parse(const uint8_t *buf,
969 float *floatval, struct sr_datafeed_analog *analog, void *info);
970 SR_PRIV gboolean sr_es519xx_19200_11b_packet_valid(const uint8_t *buf);
971 SR_PRIV int sr_es519xx_19200_11b_parse(const uint8_t *buf, float *floatval,
972 struct sr_datafeed_analog *analog, void *info);
973 SR_PRIV gboolean sr_es519xx_19200_14b_packet_valid(const uint8_t *buf);
974 SR_PRIV int sr_es519xx_19200_14b_parse(const uint8_t *buf, float *floatval,
975 struct sr_datafeed_analog *analog, void *info);
976 SR_PRIV gboolean sr_es519xx_19200_14b_sel_lpf_packet_valid(const uint8_t *buf);
977 SR_PRIV int sr_es519xx_19200_14b_sel_lpf_parse(const uint8_t *buf,
978 float *floatval, struct sr_datafeed_analog *analog, void *info);
980 /*--- hardware/dmm/fs9922.c -------------------------------------------------*/
982 #define FS9922_PACKET_SIZE 14
985 gboolean is_auto, is_dc, is_ac, is_rel, is_hold, is_bpn, is_z1, is_z2;
986 gboolean is_max, is_min, is_apo, is_bat, is_nano, is_z3, is_micro;
987 gboolean is_milli, is_kilo, is_mega, is_beep, is_diode, is_percent;
988 gboolean is_z4, is_volt, is_ampere, is_ohm, is_hfe, is_hertz, is_farad;
989 gboolean is_celsius, is_fahrenheit;
990 int bargraph_sign, bargraph_value;
993 SR_PRIV gboolean sr_fs9922_packet_valid(const uint8_t *buf);
994 SR_PRIV int sr_fs9922_parse(const uint8_t *buf, float *floatval,
995 struct sr_datafeed_analog *analog, void *info);
996 SR_PRIV void sr_fs9922_z1_diode(struct sr_datafeed_analog *analog, void *info);
998 /*--- hardware/dmm/fs9721.c -------------------------------------------------*/
1000 #define FS9721_PACKET_SIZE 14
1002 struct fs9721_info {
1003 gboolean is_ac, is_dc, is_auto, is_rs232, is_micro, is_nano, is_kilo;
1004 gboolean is_diode, is_milli, is_percent, is_mega, is_beep, is_farad;
1005 gboolean is_ohm, is_rel, is_hold, is_ampere, is_volt, is_hz, is_bat;
1006 gboolean is_c2c1_11, is_c2c1_10, is_c2c1_01, is_c2c1_00, is_sign;
1009 SR_PRIV gboolean sr_fs9721_packet_valid(const uint8_t *buf);
1010 SR_PRIV int sr_fs9721_parse(const uint8_t *buf, float *floatval,
1011 struct sr_datafeed_analog *analog, void *info);
1012 SR_PRIV void sr_fs9721_00_temp_c(struct sr_datafeed_analog *analog, void *info);
1013 SR_PRIV void sr_fs9721_01_temp_c(struct sr_datafeed_analog *analog, void *info);
1014 SR_PRIV void sr_fs9721_10_temp_c(struct sr_datafeed_analog *analog, void *info);
1015 SR_PRIV void sr_fs9721_01_10_temp_f_c(struct sr_datafeed_analog *analog, void *info);
1016 SR_PRIV void sr_fs9721_max_c_min(struct sr_datafeed_analog *analog, void *info);
1018 /*--- hardware/dmm/m2110.c --------------------------------------------------*/
1020 #define BBCGM_M2110_PACKET_SIZE 9
1022 SR_PRIV gboolean sr_m2110_packet_valid(const uint8_t *buf);
1023 SR_PRIV int sr_m2110_parse(const uint8_t *buf, float *floatval,
1024 struct sr_datafeed_analog *analog, void *info);
1026 /*--- hardware/dmm/metex14.c ------------------------------------------------*/
1028 #define METEX14_PACKET_SIZE 14
1030 struct metex14_info {
1031 gboolean is_ac, is_dc, is_resistance, is_capacity, is_temperature;
1032 gboolean is_diode, is_frequency, is_ampere, is_volt, is_farad;
1033 gboolean is_hertz, is_ohm, is_celsius, is_pico, is_nano, is_micro;
1034 gboolean is_milli, is_kilo, is_mega, is_gain, is_decibel, is_hfe;
1035 gboolean is_unitless, is_logic;
1038 #ifdef HAVE_LIBSERIALPORT
1039 SR_PRIV int sr_metex14_packet_request(struct sr_serial_dev_inst *serial);
1041 SR_PRIV gboolean sr_metex14_packet_valid(const uint8_t *buf);
1042 SR_PRIV int sr_metex14_parse(const uint8_t *buf, float *floatval,
1043 struct sr_datafeed_analog *analog, void *info);
1045 /*--- hardware/dmm/rs9lcd.c -------------------------------------------------*/
1047 #define RS9LCD_PACKET_SIZE 9
1049 /* Dummy info struct. The parser does not use it. */
1050 struct rs9lcd_info { int dummy; };
1052 SR_PRIV gboolean sr_rs9lcd_packet_valid(const uint8_t *buf);
1053 SR_PRIV int sr_rs9lcd_parse(const uint8_t *buf, float *floatval,
1054 struct sr_datafeed_analog *analog, void *info);
1056 /*--- hardware/dmm/bm25x.c --------------------------------------------------*/
1058 #define BRYMEN_BM25X_PACKET_SIZE 15
1060 /* Dummy info struct. The parser does not use it. */
1061 struct bm25x_info { int dummy; };
1063 SR_PRIV gboolean sr_brymen_bm25x_packet_valid(const uint8_t *buf);
1064 SR_PRIV int sr_brymen_bm25x_parse(const uint8_t *buf, float *floatval,
1065 struct sr_datafeed_analog *analog, void *info);
1067 /*--- hardware/dmm/ut71x.c --------------------------------------------------*/
1069 #define UT71X_PACKET_SIZE 11
1072 gboolean is_voltage, is_resistance, is_capacitance, is_temperature;
1073 gboolean is_celsius, is_fahrenheit, is_current, is_continuity;
1074 gboolean is_diode, is_frequency, is_duty_cycle, is_dc, is_ac;
1075 gboolean is_auto, is_manual, is_sign, is_power, is_loop_current;
1078 SR_PRIV gboolean sr_ut71x_packet_valid(const uint8_t *buf);
1079 SR_PRIV int sr_ut71x_parse(const uint8_t *buf, float *floatval,
1080 struct sr_datafeed_analog *analog, void *info);
1082 /*--- hardware/dmm/vc870.c --------------------------------------------------*/
1084 #define VC870_PACKET_SIZE 23
1087 gboolean is_voltage, is_dc, is_ac, is_temperature, is_resistance;
1088 gboolean is_continuity, is_capacitance, is_diode, is_loop_current;
1089 gboolean is_current, is_micro, is_milli, is_power;
1090 gboolean is_power_factor_freq, is_power_apparent_power, is_v_a_eff_value;
1091 gboolean is_sign2, is_sign1, is_batt, is_ol1, is_max, is_min;
1092 gboolean is_maxmin, is_rel, is_ol2, is_open, is_manu, is_hold;
1093 gboolean is_light, is_usb, is_warning, is_auto_power, is_misplug_warn;
1094 gboolean is_lo, is_hi, is_open2;
1096 gboolean is_frequency, is_dual_display, is_auto, is_rms;
1099 SR_PRIV gboolean sr_vc870_packet_valid(const uint8_t *buf);
1100 SR_PRIV int sr_vc870_parse(const uint8_t *buf, float *floatval,
1101 struct sr_datafeed_analog *analog, void *info);
1103 /*--- hardware/lcr/es51919.c ------------------------------------------------*/
1105 SR_PRIV void es51919_serial_clean(void *priv);
1106 SR_PRIV struct sr_dev_inst *es51919_serial_scan(GSList *options,
1109 SR_PRIV int es51919_serial_config_get(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_config_set(uint32_t key, GVariant *data,
1113 const struct sr_dev_inst *sdi,
1114 const struct sr_channel_group *cg);
1115 SR_PRIV int es51919_serial_config_list(uint32_t key, GVariant **data,
1116 const struct sr_dev_inst *sdi,
1117 const struct sr_channel_group *cg);
1118 SR_PRIV int es51919_serial_acquisition_start(const struct sr_dev_inst *sdi,
1120 SR_PRIV int es51919_serial_acquisition_stop(struct sr_dev_inst *sdi,
1123 /*--- hardware/dmm/ut372.c --------------------------------------------------*/
1125 #define UT372_PACKET_SIZE 27
1131 SR_PRIV gboolean sr_ut372_packet_valid(const uint8_t *buf);
1132 SR_PRIV int sr_ut372_parse(const uint8_t *buf, float *floatval,
1133 struct sr_datafeed_analog *analog, void *info);