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 /* Portability fixes for FreeBSD. */
161 #define LIBUSB_CLASS_APPLICATION 0xfe
162 #define libusb_has_capability(x) 0
163 #define libusb_handle_events_timeout_completed(ctx, tv, c) \
164 libusb_handle_events_timeout(ctx, tv)
167 /* Static definitions of structs ending with an all-zero entry are a
168 * problem when compiling with -Wmissing-field-initializers: GCC
169 * suppresses the warning only with { 0 }, clang wants { } */
173 #define ALL_ZERO { 0 }
177 #ifdef HAVE_LIBUSB_1_0
178 libusb_context *libusb_ctx;
179 gboolean usb_source_present;
182 gboolean usb_thread_running;
183 HANDLE usb_wait_request_event;
184 HANDLE usb_wait_complete_event;
186 sr_receive_data_callback usb_cb;
192 /** Input module metadata keys. */
193 enum sr_input_meta_keys {
194 /** The input filename, if there is one. */
195 SR_INPUT_META_FILENAME = 0x01,
196 /** The input file's size in bytes. */
197 SR_INPUT_META_FILESIZE = 0x02,
198 /** The first 128 bytes of the file, provided as a GString. */
199 SR_INPUT_META_HEADER = 0x04,
200 /** The file's MIME type. */
201 SR_INPUT_META_MIMETYPE = 0x08,
203 /** The module cannot identify a file without this metadata. */
204 SR_INPUT_META_REQUIRED = 0x80,
207 /** Input (file) module struct. */
210 * A pointer to this input module's 'struct sr_input_module'.
212 const struct sr_input_module *module;
214 struct sr_dev_inst *sdi;
219 /** Input (file) module driver. */
220 struct sr_input_module {
222 * A unique ID for this input module, suitable for use in command-line
223 * clients, [a-z0-9-]. Must not be NULL.
228 * A unique name for this input module, suitable for use in GUI
229 * clients, can contain UTF-8. Must not be NULL.
234 * A short description of the input module. Must not be NULL.
236 * This can be displayed by frontends, e.g. when selecting the input
237 * module for saving a file.
242 * A NULL terminated array of strings containing a list of file name
243 * extensions typical for the input file format, or NULL if there is
244 * no typical extension for this file format.
246 const char *const *exts;
249 * Zero-terminated list of metadata items the module needs to be able
250 * to identify an input stream. Can be all-zero, if the module cannot
251 * identify streams at all, i.e. has to be forced into use.
253 * Each item is one of:
254 * SR_INPUT_META_FILENAME
255 * SR_INPUT_META_FILESIZE
256 * SR_INPUT_META_HEADER
257 * SR_INPUT_META_MIMETYPE
259 * If the high bit (SR_INPUT META_REQUIRED) is set, the module cannot
260 * identify a stream without the given metadata.
262 const uint8_t metadata[8];
265 * Returns a NULL-terminated list of options this module can take.
266 * Can be NULL, if the module has no options.
268 struct sr_option *(*options) (void);
271 * Check if this input module can load and parse the specified stream.
273 * @param[in] metadata Metadata the module can use to identify the stream.
275 * @retval SR_OK This module knows the format.
276 * @retval SR_ERR_NA There wasn't enough data for this module to
277 * positively identify the format.
278 * @retval SR_ERR_DATA This module knows the format, but cannot handle it.
279 * This means the stream is either corrupt, or indicates a feature
280 * that the module does not support.
281 * @retval SR_ERR This module does not know the format.
283 int (*format_match) (GHashTable *metadata);
286 * Initialize the input module.
288 * @retval SR_OK Success
289 * @retval other Negative error code.
291 int (*init) (struct sr_input *in, GHashTable *options);
294 * Send data to the specified input instance.
296 * When an input module instance is created with sr_input_new(), this
297 * function is used to feed data to the instance.
299 * As enough data gets fed into this function to completely populate
300 * the device instance associated with this input instance, this is
301 * guaranteed to return the moment it's ready. This gives the caller
302 * the chance to examine the device instance, attach session callbacks
305 * @retval SR_OK Success
306 * @retval other Negative error code.
308 int (*receive) (struct sr_input *in, GString *buf);
311 * Signal the input module no more data will come.
313 * This will cause the module to process any data it may have buffered.
314 * The SR_DF_END packet will also typically be sent at this time.
316 int (*end) (struct sr_input *in);
319 * This function is called after the caller is finished using
320 * the input module, and can be used to free any internal
321 * resources the module may keep.
323 * This function is optional.
325 * @retval SR_OK Success
326 * @retval other Negative error code.
328 void (*cleanup) (struct sr_input *in);
331 /** Output module instance. */
333 /** A pointer to this output's module. */
334 const struct sr_output_module *module;
337 * The device for which this output module is creating output. This
338 * can be used by the module to find out channel names and numbers.
340 const struct sr_dev_inst *sdi;
343 * A generic pointer which can be used by the module to keep internal
344 * state between calls into its callback functions.
346 * For example, the module might store a pointer to a chunk of output
347 * there, and only flush it when it reaches a certain size.
352 /** Output module driver. */
353 struct sr_output_module {
355 * A unique ID for this output module, suitable for use in command-line
356 * clients, [a-z0-9-]. Must not be NULL.
361 * A unique name for this output module, suitable for use in GUI
362 * clients, can contain UTF-8. Must not be NULL.
367 * A short description of the output module. Must not be NULL.
369 * This can be displayed by frontends, e.g. when selecting the output
370 * module for saving a file.
375 * A NULL terminated array of strings containing a list of file name
376 * extensions typical for the input file format, or NULL if there is
377 * no typical extension for this file format.
379 const char *const *exts;
382 * Returns a NULL-terminated list of options this module can take.
383 * Can be NULL, if the module has no options.
385 const struct sr_option *(*options) (void);
388 * This function is called once, at the beginning of an output stream.
390 * The device struct will be available in the output struct passed in,
391 * as well as the param field -- which may be NULL or an empty string,
392 * if no parameter was passed.
394 * The module can use this to initialize itself, create a struct for
395 * keeping state and storing it in the <code>internal</code> field.
397 * @param o Pointer to the respective 'struct sr_output'.
399 * @retval SR_OK Success
400 * @retval other Negative error code.
402 int (*init) (struct sr_output *o, GHashTable *options);
405 * This function is passed a copy of every packet in the data feed.
406 * Any output generated by the output module in response to the
407 * packet should be returned in a newly allocated GString
408 * <code>out</code>, which will be freed by the caller.
410 * Packets not of interest to the output module can just be ignored,
411 * and the <code>out</code> parameter set to NULL.
413 * @param o Pointer to the respective 'struct sr_output'.
414 * @param sdi The device instance that generated the packet.
415 * @param packet The complete packet.
416 * @param out A pointer where a GString * should be stored if
417 * the module generates output, or NULL if not.
419 * @retval SR_OK Success
420 * @retval other Negative error code.
422 int (*receive) (const struct sr_output *o,
423 const struct sr_datafeed_packet *packet, GString **out);
426 * This function is called after the caller is finished using
427 * the output module, and can be used to free any internal
428 * resources the module may keep.
430 * @retval SR_OK Success
431 * @retval other Negative error code.
433 int (*cleanup) (struct sr_output *o);
436 /** Transform module instance. */
437 struct sr_transform {
438 /** A pointer to this transform's module. */
439 const struct sr_transform_module *module;
442 * The device for which this transform module is used. This
443 * can be used by the module to find out channel names and numbers.
445 const struct sr_dev_inst *sdi;
448 * A generic pointer which can be used by the module to keep internal
449 * state between calls into its callback functions.
454 struct sr_transform_module {
456 * A unique ID for this transform module, suitable for use in
457 * command-line clients, [a-z0-9-]. Must not be NULL.
462 * A unique name for this transform module, suitable for use in GUI
463 * clients, can contain UTF-8. Must not be NULL.
468 * A short description of the transform module. Must not be NULL.
470 * This can be displayed by frontends, e.g. when selecting
471 * which transform module(s) to add.
476 * Returns a NULL-terminated list of options this transform module
477 * can take. Can be NULL, if the transform module has no options.
479 const struct sr_option *(*options) (void);
482 * This function is called once, at the beginning of a stream.
484 * @param t Pointer to the respective 'struct sr_transform'.
485 * @param options Hash table of options for this transform module.
486 * Can be NULL if no options are to be used.
488 * @retval SR_OK Success
489 * @retval other Negative error code.
491 int (*init) (struct sr_transform *t, GHashTable *options);
494 * This function is passed a pointer to every packet in the data feed.
496 * It can either return (in packet_out) a pointer to another packet
497 * (possibly the exact same packet it got as input), or NULL.
499 * @param t Pointer to the respective 'struct sr_transform'.
500 * @param packet_in Pointer to a datafeed packet.
501 * @param packet_out Pointer to the resulting datafeed packet after
502 * this function was run. If NULL, the transform
503 * module intentionally didn't output a new packet.
505 * @retval SR_OK Success
506 * @retval other Negative error code.
508 int (*receive) (const struct sr_transform *t,
509 struct sr_datafeed_packet *packet_in,
510 struct sr_datafeed_packet **packet_out);
513 * This function is called after the caller is finished using
514 * the transform module, and can be used to free any internal
515 * resources the module may keep.
517 * @retval SR_OK Success
518 * @retval other Negative error code.
520 int (*cleanup) (struct sr_transform *t);
523 #ifdef HAVE_LIBUSB_1_0
524 /** USB device instance */
525 struct sr_usb_dev_inst {
528 /** Device address on USB bus */
530 /** libusb device handle */
531 struct libusb_device_handle *devhdl;
535 #ifdef HAVE_LIBSERIALPORT
536 #define SERIAL_PARITY_NONE SP_PARITY_NONE
537 #define SERIAL_PARITY_EVEN SP_PARITY_EVEN
538 #define SERIAL_PARITY_ODD SP_PARITY_ODD
539 struct sr_serial_dev_inst {
540 /** Port name, e.g. '/dev/tty42'. */
542 /** Comm params for serial_set_paramstr(). */
544 /** libserialport port handle */
545 struct sp_port *data;
546 /** libserialport event set */
547 struct sp_event_set *event_set;
548 /** GPollFDs for event polling */
553 struct sr_usbtmc_dev_inst {
558 /* Private driver context. */
560 /** sigrok context */
561 struct sr_context *sr_ctx;
565 /*--- log.c -----------------------------------------------------------------*/
567 SR_PRIV int sr_log(int loglevel, const char *format, ...);
568 SR_PRIV int sr_spew(const char *format, ...);
569 SR_PRIV int sr_dbg(const char *format, ...);
570 SR_PRIV int sr_info(const char *format, ...);
571 SR_PRIV int sr_warn(const char *format, ...);
572 SR_PRIV int sr_err(const char *format, ...);
574 /* Message logging helpers with subsystem-specific prefix string. */
575 #ifndef NO_LOG_WRAPPERS
576 #define sr_log(l, s, args...) sr_log(l, "%s: " s, LOG_PREFIX, ## args)
577 #define sr_spew(s, args...) sr_spew("%s: " s, LOG_PREFIX, ## args)
578 #define sr_dbg(s, args...) sr_dbg("%s: " s, LOG_PREFIX, ## args)
579 #define sr_info(s, args...) sr_info("%s: " s, LOG_PREFIX, ## args)
580 #define sr_warn(s, args...) sr_warn("%s: " s, LOG_PREFIX, ## args)
581 #define sr_err(s, args...) sr_err("%s: " s, LOG_PREFIX, ## args)
584 /*--- device.c --------------------------------------------------------------*/
586 /** Values for the changes argument of sr_dev_driver.config_channel_set. */
588 /** The enabled state of the channel has been changed. */
589 SR_CHANNEL_SET_ENABLED = 1 << 0,
592 SR_PRIV struct sr_channel *sr_channel_new(struct sr_dev_inst *sdi,
593 int index, int type, gboolean enabled, const char *name);
595 /** Device instance data */
597 /** Device driver. */
598 struct sr_dev_driver *driver;
599 /** Device instance status. SR_ST_NOT_FOUND, etc. */
601 /** Device instance type. SR_INST_USB, etc. */
603 /** Device vendor. */
607 /** Device version. */
609 /** Serial number. */
611 /** Connection string to uniquely identify devices. */
613 /** List of channels. */
615 /** List of sr_channel_group structs */
616 GSList *channel_groups;
617 /** Device instance connection data (used?) */
619 /** Device instance private data (used?) */
621 /** Session to which this device is currently assigned. */
622 struct sr_session *session;
625 /* Generic device instances */
626 SR_PRIV void sr_dev_inst_free(struct sr_dev_inst *sdi);
628 #ifdef HAVE_LIBUSB_1_0
629 /* USB-specific instances */
630 SR_PRIV struct sr_usb_dev_inst *sr_usb_dev_inst_new(uint8_t bus,
631 uint8_t address, struct libusb_device_handle *hdl);
632 SR_PRIV void sr_usb_dev_inst_free(struct sr_usb_dev_inst *usb);
635 #ifdef HAVE_LIBSERIALPORT
636 /* Serial-specific instances */
637 SR_PRIV struct sr_serial_dev_inst *sr_serial_dev_inst_new(const char *port,
638 const char *serialcomm);
639 SR_PRIV void sr_serial_dev_inst_free(struct sr_serial_dev_inst *serial);
642 /* USBTMC-specific instances */
643 SR_PRIV struct sr_usbtmc_dev_inst *sr_usbtmc_dev_inst_new(const char *device);
644 SR_PRIV void sr_usbtmc_dev_inst_free(struct sr_usbtmc_dev_inst *usbtmc);
646 /*--- hwdriver.c ------------------------------------------------------------*/
648 SR_PRIV const GVariantType *sr_variant_type_get(int datatype);
649 SR_PRIV int sr_variant_type_check(uint32_t key, GVariant *data);
650 SR_PRIV void sr_hw_cleanup_all(void);
651 SR_PRIV struct sr_config *sr_config_new(uint32_t key, GVariant *data);
652 SR_PRIV void sr_config_free(struct sr_config *src);
653 SR_PRIV int sr_source_remove(int fd);
654 SR_PRIV int sr_source_remove_pollfd(GPollFD *pollfd);
655 SR_PRIV int sr_source_remove_channel(GIOChannel *channel);
656 SR_PRIV int sr_source_add(int fd, int events, int timeout,
657 sr_receive_data_callback cb, void *cb_data);
658 SR_PRIV int sr_source_add_pollfd(GPollFD *pollfd, int timeout,
659 sr_receive_data_callback cb, void *cb_data);
660 SR_PRIV int sr_source_add_channel(GIOChannel *channel, int events, int timeout,
661 sr_receive_data_callback cb, void *cb_data);
663 /*--- session.c -------------------------------------------------------------*/
666 /** Context this session exists in. */
667 struct sr_context *ctx;
668 /** List of struct sr_dev_inst pointers. */
670 /** List of struct sr_dev_inst pointers owned by this session. */
672 /** List of struct datafeed_callback pointers. */
673 GSList *datafeed_callbacks;
675 struct sr_trigger *trigger;
679 unsigned int num_sources;
682 * Both "sources" and "pollfds" are of the same size and contain pairs
683 * of descriptor and callback function. We can not embed the GPollFD
684 * into the source struct since we want to be able to pass the array
685 * of all poll descriptors to g_poll().
687 struct source *sources;
692 * These are our synchronization primitives for stopping the session in
693 * an async fashion. We need to make sure the session is stopped from
694 * within the session thread itself.
696 /** Mutex protecting access to abort_session. */
698 /** Abort current session. See sr_session_stop(). */
699 gboolean abort_session;
702 SR_PRIV int sr_session_send(const struct sr_dev_inst *sdi,
703 const struct sr_datafeed_packet *packet);
704 SR_PRIV int sr_session_stop_sync(struct sr_session *session);
705 SR_PRIV int sr_sessionfile_check(const char *filename);
706 SR_PRIV int sr_packet_copy(const struct sr_datafeed_packet *packet,
707 struct sr_datafeed_packet **copy);
708 SR_PRIV void sr_packet_free(struct sr_datafeed_packet *packet);
710 /*--- analog.c --------------------------------------------------------------*/
712 SR_PRIV int sr_analog_init(struct sr_datafeed_analog2 *analog,
713 struct sr_analog_encoding *encoding,
714 struct sr_analog_meaning *meaning,
715 struct sr_analog_spec *spec,
718 /*--- std.c -----------------------------------------------------------------*/
720 typedef int (*dev_close_callback)(struct sr_dev_inst *sdi);
721 typedef void (*std_dev_clear_callback)(void *priv);
723 SR_PRIV int std_init(struct sr_context *sr_ctx, struct sr_dev_driver *di,
725 #ifdef HAVE_LIBSERIALPORT
726 SR_PRIV int std_serial_dev_open(struct sr_dev_inst *sdi);
727 SR_PRIV int std_serial_dev_acquisition_stop(struct sr_dev_inst *sdi,
728 void *cb_data, dev_close_callback dev_close_fn,
729 struct sr_serial_dev_inst *serial, const char *prefix);
731 SR_PRIV int std_session_send_df_header(const struct sr_dev_inst *sdi,
733 SR_PRIV int std_dev_clear(const struct sr_dev_driver *driver,
734 std_dev_clear_callback clear_private);
735 SR_PRIV int std_serial_dev_close(struct sr_dev_inst *sdi);
737 /*--- strutil.c -------------------------------------------------------------*/
739 SR_PRIV int sr_atol(const char *str, long *ret);
740 SR_PRIV int sr_atoi(const char *str, int *ret);
741 SR_PRIV int sr_atod(const char *str, double *ret);
742 SR_PRIV int sr_atof(const char *str, float *ret);
743 SR_PRIV int sr_atof_ascii(const char *str, float *ret);
745 /*--- soft-trigger.c --------------------------------------------------------*/
747 struct soft_trigger_logic {
748 const struct sr_dev_inst *sdi;
749 const struct sr_trigger *trigger;
753 uint8_t *prev_sample;
754 uint8_t *pre_trigger_buffer;
755 uint8_t *pre_trigger_head;
756 int pre_trigger_size;
757 int pre_trigger_fill;
760 SR_PRIV struct soft_trigger_logic *soft_trigger_logic_new(
761 const struct sr_dev_inst *sdi, struct sr_trigger *trigger,
762 int pre_trigger_samples);
763 SR_PRIV void soft_trigger_logic_free(struct soft_trigger_logic *st);
764 SR_PRIV int soft_trigger_logic_check(struct soft_trigger_logic *st, uint8_t *buf,
765 int len, int *pre_trigger_samples);
767 /*--- hardware/serial.c -----------------------------------------------------*/
769 #ifdef HAVE_LIBSERIALPORT
775 typedef gboolean (*packet_valid_callback)(const uint8_t *buf);
777 SR_PRIV int serial_open(struct sr_serial_dev_inst *serial, int flags);
778 SR_PRIV int serial_close(struct sr_serial_dev_inst *serial);
779 SR_PRIV int serial_flush(struct sr_serial_dev_inst *serial);
780 SR_PRIV int serial_drain(struct sr_serial_dev_inst *serial);
781 SR_PRIV int serial_write_blocking(struct sr_serial_dev_inst *serial,
782 const void *buf, size_t count, unsigned int timeout_ms);
783 SR_PRIV int serial_write_nonblocking(struct sr_serial_dev_inst *serial,
784 const void *buf, size_t count);
785 SR_PRIV int serial_read_blocking(struct sr_serial_dev_inst *serial, void *buf,
786 size_t count, unsigned int timeout_ms);
787 SR_PRIV int serial_read_nonblocking(struct sr_serial_dev_inst *serial, void *buf,
789 SR_PRIV int serial_set_params(struct sr_serial_dev_inst *serial, int baudrate,
790 int bits, int parity, int stopbits, int flowcontrol, int rts, int dtr);
791 SR_PRIV int serial_set_paramstr(struct sr_serial_dev_inst *serial,
792 const char *paramstr);
793 SR_PRIV int serial_readline(struct sr_serial_dev_inst *serial, char **buf,
794 int *buflen, gint64 timeout_ms);
795 SR_PRIV int serial_stream_detect(struct sr_serial_dev_inst *serial,
796 uint8_t *buf, size_t *buflen,
798 packet_valid_callback is_valid,
799 uint64_t timeout_ms, int baudrate);
800 SR_PRIV int sr_serial_extract_options(GSList *options, const char **serial_device,
801 const char **serial_options);
802 SR_PRIV int serial_source_add(struct sr_session *session,
803 struct sr_serial_dev_inst *serial, int events, int timeout,
804 sr_receive_data_callback cb, void *cb_data);
805 SR_PRIV int serial_source_remove(struct sr_session *session,
806 struct sr_serial_dev_inst *serial);
807 SR_PRIV GSList *sr_serial_find_usb(uint16_t vendor_id, uint16_t product_id);
808 SR_PRIV int serial_timeout(struct sr_serial_dev_inst *port, int num_bytes);
811 /*--- hardware/ezusb.c ------------------------------------------------------*/
813 #ifdef HAVE_LIBUSB_1_0
814 SR_PRIV int ezusb_reset(struct libusb_device_handle *hdl, int set_clear);
815 SR_PRIV int ezusb_install_firmware(libusb_device_handle *hdl,
816 const char *filename);
817 SR_PRIV int ezusb_upload_firmware(libusb_device *dev, int configuration,
818 const char *filename);
821 /*--- hardware/usb.c --------------------------------------------------------*/
823 #ifdef HAVE_LIBUSB_1_0
824 SR_PRIV GSList *sr_usb_find(libusb_context *usb_ctx, const char *conn);
825 SR_PRIV int sr_usb_open(libusb_context *usb_ctx, struct sr_usb_dev_inst *usb);
826 SR_PRIV int usb_source_add(struct sr_session *session, struct sr_context *ctx,
827 int timeout, sr_receive_data_callback cb, void *cb_data);
828 SR_PRIV int usb_source_remove(struct sr_session *session, struct sr_context *ctx);
829 SR_PRIV int usb_get_port_path(libusb_device *dev, char *path, int path_len);
832 /*--- hardware/scpi.c -------------------------------------------------------*/
834 #define SCPI_CMD_IDN "*IDN?"
835 #define SCPI_CMD_OPC "*OPC?"
838 SCPI_CMD_SET_TRIGGER_SOURCE,
839 SCPI_CMD_SET_TIMEBASE,
840 SCPI_CMD_SET_VERTICAL_DIV,
841 SCPI_CMD_SET_TRIGGER_SLOPE,
842 SCPI_CMD_SET_COUPLING,
843 SCPI_CMD_SET_HORIZ_TRIGGERPOS,
844 SCPI_CMD_GET_ANALOG_CHAN_STATE,
845 SCPI_CMD_GET_DIG_CHAN_STATE,
846 SCPI_CMD_GET_TIMEBASE,
847 SCPI_CMD_GET_VERTICAL_DIV,
848 SCPI_CMD_GET_VERTICAL_OFFSET,
849 SCPI_CMD_GET_TRIGGER_SOURCE,
850 SCPI_CMD_GET_HORIZ_TRIGGERPOS,
851 SCPI_CMD_GET_TRIGGER_SLOPE,
852 SCPI_CMD_GET_COUPLING,
853 SCPI_CMD_SET_ANALOG_CHAN_STATE,
854 SCPI_CMD_SET_DIG_CHAN_STATE,
855 SCPI_CMD_GET_DIG_POD_STATE,
856 SCPI_CMD_SET_DIG_POD_STATE,
857 SCPI_CMD_GET_ANALOG_DATA,
858 SCPI_CMD_GET_DIG_DATA,
859 SCPI_CMD_GET_SAMPLE_RATE,
860 SCPI_CMD_GET_SAMPLE_RATE_LIVE,
863 struct sr_scpi_hw_info {
867 char *firmware_version;
870 struct sr_scpi_dev_inst {
874 GSList *(*scan)(struct drv_context *drvc);
875 int (*dev_inst_new)(void *priv, struct drv_context *drvc,
876 const char *resource, char **params, const char *serialcomm);
877 int (*open)(void *priv);
878 int (*source_add)(struct sr_session *session, void *priv, int events,
879 int timeout, sr_receive_data_callback cb, void *cb_data);
880 int (*source_remove)(struct sr_session *session, void *priv);
881 int (*send)(void *priv, const char *command);
882 int (*read_begin)(void *priv);
883 int (*read_data)(void *priv, char *buf, int maxlen);
884 int (*read_complete)(void *priv);
885 int (*close)(void *priv);
886 void (*free)(void *priv);
887 unsigned int read_timeout_ms;
891 SR_PRIV GSList *sr_scpi_scan(struct drv_context *drvc, GSList *options,
892 struct sr_dev_inst *(*probe_device)(struct sr_scpi_dev_inst *scpi));
893 SR_PRIV struct sr_scpi_dev_inst *scpi_dev_inst_new(struct drv_context *drvc,
894 const char *resource, const char *serialcomm);
895 SR_PRIV int sr_scpi_open(struct sr_scpi_dev_inst *scpi);
896 SR_PRIV int sr_scpi_source_add(struct sr_session *session,
897 struct sr_scpi_dev_inst *scpi, int events, int timeout,
898 sr_receive_data_callback cb, void *cb_data);
899 SR_PRIV int sr_scpi_source_remove(struct sr_session *session,
900 struct sr_scpi_dev_inst *scpi);
901 SR_PRIV int sr_scpi_send(struct sr_scpi_dev_inst *scpi,
902 const char *format, ...);
903 SR_PRIV int sr_scpi_send_variadic(struct sr_scpi_dev_inst *scpi,
904 const char *format, va_list args);
905 SR_PRIV int sr_scpi_read_begin(struct sr_scpi_dev_inst *scpi);
906 SR_PRIV int sr_scpi_read_data(struct sr_scpi_dev_inst *scpi, char *buf, int maxlen);
907 SR_PRIV int sr_scpi_read_complete(struct sr_scpi_dev_inst *scpi);
908 SR_PRIV int sr_scpi_close(struct sr_scpi_dev_inst *scpi);
909 SR_PRIV void sr_scpi_free(struct sr_scpi_dev_inst *scpi);
911 SR_PRIV int sr_scpi_get_string(struct sr_scpi_dev_inst *scpi,
912 const char *command, char **scpi_response);
913 SR_PRIV int sr_scpi_get_bool(struct sr_scpi_dev_inst *scpi,
914 const char *command, gboolean *scpi_response);
915 SR_PRIV int sr_scpi_get_int(struct sr_scpi_dev_inst *scpi,
916 const char *command, int *scpi_response);
917 SR_PRIV int sr_scpi_get_float(struct sr_scpi_dev_inst *scpi,
918 const char *command, float *scpi_response);
919 SR_PRIV int sr_scpi_get_double(struct sr_scpi_dev_inst *scpi,
920 const char *command, double *scpi_response);
921 SR_PRIV int sr_scpi_get_opc(struct sr_scpi_dev_inst *scpi);
922 SR_PRIV int sr_scpi_get_floatv(struct sr_scpi_dev_inst *scpi,
923 const char *command, GArray **scpi_response);
924 SR_PRIV int sr_scpi_get_uint8v(struct sr_scpi_dev_inst *scpi,
925 const char *command, GArray **scpi_response);
926 SR_PRIV int sr_scpi_get_hw_id(struct sr_scpi_dev_inst *scpi,
927 struct sr_scpi_hw_info **scpi_response);
928 SR_PRIV void sr_scpi_hw_info_free(struct sr_scpi_hw_info *hw_info);
930 /*--- hardware/dmm/es519xx.c ------------------------------------------------*/
933 * All 11-byte es519xx chips repeat each block twice for each conversion cycle
934 * so always read 2 blocks at a time.
936 #define ES519XX_11B_PACKET_SIZE (11 * 2)
937 #define ES519XX_14B_PACKET_SIZE 14
939 struct es519xx_info {
940 gboolean is_judge, is_voltage, is_auto, is_micro, is_current;
941 gboolean is_milli, is_resistance, is_continuity, is_diode;
942 gboolean is_frequency, is_rpm, is_capacitance, is_duty_cycle;
943 gboolean is_temperature, is_celsius, is_fahrenheit;
944 gboolean is_adp0, is_adp1, is_adp2, is_adp3;
945 gboolean is_sign, is_batt, is_ol, is_pmax, is_pmin, is_apo;
946 gboolean is_dc, is_ac, is_vahz, is_min, is_max, is_rel, is_hold;
947 gboolean is_digit4, is_ul, is_vasel, is_vbar, is_lpf1, is_lpf0, is_rmr;
950 gboolean alt_functions, fivedigits, clampmeter, selectable_lpf;
953 SR_PRIV gboolean sr_es519xx_2400_11b_packet_valid(const uint8_t *buf);
954 SR_PRIV int sr_es519xx_2400_11b_parse(const uint8_t *buf, float *floatval,
955 struct sr_datafeed_analog *analog, void *info);
956 SR_PRIV gboolean sr_es519xx_2400_11b_altfn_packet_valid(const uint8_t *buf);
957 SR_PRIV int sr_es519xx_2400_11b_altfn_parse(const uint8_t *buf,
958 float *floatval, struct sr_datafeed_analog *analog, void *info);
959 SR_PRIV gboolean sr_es519xx_19200_11b_5digits_packet_valid(const uint8_t *buf);
960 SR_PRIV int sr_es519xx_19200_11b_5digits_parse(const uint8_t *buf,
961 float *floatval, struct sr_datafeed_analog *analog, void *info);
962 SR_PRIV gboolean sr_es519xx_19200_11b_clamp_packet_valid(const uint8_t *buf);
963 SR_PRIV int sr_es519xx_19200_11b_clamp_parse(const uint8_t *buf,
964 float *floatval, struct sr_datafeed_analog *analog, void *info);
965 SR_PRIV gboolean sr_es519xx_19200_11b_packet_valid(const uint8_t *buf);
966 SR_PRIV int sr_es519xx_19200_11b_parse(const uint8_t *buf, float *floatval,
967 struct sr_datafeed_analog *analog, void *info);
968 SR_PRIV gboolean sr_es519xx_19200_14b_packet_valid(const uint8_t *buf);
969 SR_PRIV int sr_es519xx_19200_14b_parse(const uint8_t *buf, float *floatval,
970 struct sr_datafeed_analog *analog, void *info);
971 SR_PRIV gboolean sr_es519xx_19200_14b_sel_lpf_packet_valid(const uint8_t *buf);
972 SR_PRIV int sr_es519xx_19200_14b_sel_lpf_parse(const uint8_t *buf,
973 float *floatval, struct sr_datafeed_analog *analog, void *info);
975 /*--- hardware/dmm/fs9922.c -------------------------------------------------*/
977 #define FS9922_PACKET_SIZE 14
980 gboolean is_auto, is_dc, is_ac, is_rel, is_hold, is_bpn, is_z1, is_z2;
981 gboolean is_max, is_min, is_apo, is_bat, is_nano, is_z3, is_micro;
982 gboolean is_milli, is_kilo, is_mega, is_beep, is_diode, is_percent;
983 gboolean is_z4, is_volt, is_ampere, is_ohm, is_hfe, is_hertz, is_farad;
984 gboolean is_celsius, is_fahrenheit;
985 int bargraph_sign, bargraph_value;
988 SR_PRIV gboolean sr_fs9922_packet_valid(const uint8_t *buf);
989 SR_PRIV int sr_fs9922_parse(const uint8_t *buf, float *floatval,
990 struct sr_datafeed_analog *analog, void *info);
991 SR_PRIV void sr_fs9922_z1_diode(struct sr_datafeed_analog *analog, void *info);
993 /*--- hardware/dmm/fs9721.c -------------------------------------------------*/
995 #define FS9721_PACKET_SIZE 14
998 gboolean is_ac, is_dc, is_auto, is_rs232, is_micro, is_nano, is_kilo;
999 gboolean is_diode, is_milli, is_percent, is_mega, is_beep, is_farad;
1000 gboolean is_ohm, is_rel, is_hold, is_ampere, is_volt, is_hz, is_bat;
1001 gboolean is_c2c1_11, is_c2c1_10, is_c2c1_01, is_c2c1_00, is_sign;
1004 SR_PRIV gboolean sr_fs9721_packet_valid(const uint8_t *buf);
1005 SR_PRIV int sr_fs9721_parse(const uint8_t *buf, float *floatval,
1006 struct sr_datafeed_analog *analog, void *info);
1007 SR_PRIV void sr_fs9721_00_temp_c(struct sr_datafeed_analog *analog, void *info);
1008 SR_PRIV void sr_fs9721_01_temp_c(struct sr_datafeed_analog *analog, void *info);
1009 SR_PRIV void sr_fs9721_10_temp_c(struct sr_datafeed_analog *analog, void *info);
1010 SR_PRIV void sr_fs9721_01_10_temp_f_c(struct sr_datafeed_analog *analog, void *info);
1011 SR_PRIV void sr_fs9721_max_c_min(struct sr_datafeed_analog *analog, void *info);
1013 /*--- hardware/dmm/m2110.c --------------------------------------------------*/
1015 #define BBCGM_M2110_PACKET_SIZE 9
1017 SR_PRIV gboolean sr_m2110_packet_valid(const uint8_t *buf);
1018 SR_PRIV int sr_m2110_parse(const uint8_t *buf, float *floatval,
1019 struct sr_datafeed_analog *analog, void *info);
1021 /*--- hardware/dmm/metex14.c ------------------------------------------------*/
1023 #define METEX14_PACKET_SIZE 14
1025 struct metex14_info {
1026 gboolean is_ac, is_dc, is_resistance, is_capacity, is_temperature;
1027 gboolean is_diode, is_frequency, is_ampere, is_volt, is_farad;
1028 gboolean is_hertz, is_ohm, is_celsius, is_pico, is_nano, is_micro;
1029 gboolean is_milli, is_kilo, is_mega, is_gain, is_decibel, is_hfe;
1030 gboolean is_unitless, is_logic;
1033 #ifdef HAVE_LIBSERIALPORT
1034 SR_PRIV int sr_metex14_packet_request(struct sr_serial_dev_inst *serial);
1036 SR_PRIV gboolean sr_metex14_packet_valid(const uint8_t *buf);
1037 SR_PRIV int sr_metex14_parse(const uint8_t *buf, float *floatval,
1038 struct sr_datafeed_analog *analog, void *info);
1040 /*--- hardware/dmm/rs9lcd.c -------------------------------------------------*/
1042 #define RS9LCD_PACKET_SIZE 9
1044 /* Dummy info struct. The parser does not use it. */
1045 struct rs9lcd_info { int dummy; };
1047 SR_PRIV gboolean sr_rs9lcd_packet_valid(const uint8_t *buf);
1048 SR_PRIV int sr_rs9lcd_parse(const uint8_t *buf, float *floatval,
1049 struct sr_datafeed_analog *analog, void *info);
1051 /*--- hardware/dmm/bm25x.c --------------------------------------------------*/
1053 #define BRYMEN_BM25X_PACKET_SIZE 15
1055 /* Dummy info struct. The parser does not use it. */
1056 struct bm25x_info { int dummy; };
1058 SR_PRIV gboolean sr_brymen_bm25x_packet_valid(const uint8_t *buf);
1059 SR_PRIV int sr_brymen_bm25x_parse(const uint8_t *buf, float *floatval,
1060 struct sr_datafeed_analog *analog, void *info);
1062 /*--- hardware/dmm/ut71x.c --------------------------------------------------*/
1064 #define UT71X_PACKET_SIZE 11
1067 gboolean is_voltage, is_resistance, is_capacitance, is_temperature;
1068 gboolean is_celsius, is_fahrenheit, is_current, is_continuity;
1069 gboolean is_diode, is_frequency, is_duty_cycle, is_dc, is_ac;
1070 gboolean is_auto, is_manual, is_sign, is_power, is_loop_current;
1073 SR_PRIV gboolean sr_ut71x_packet_valid(const uint8_t *buf);
1074 SR_PRIV int sr_ut71x_parse(const uint8_t *buf, float *floatval,
1075 struct sr_datafeed_analog *analog, void *info);
1077 /*--- hardware/dmm/vc870.c --------------------------------------------------*/
1079 #define VC870_PACKET_SIZE 23
1082 gboolean is_voltage, is_dc, is_ac, is_temperature, is_resistance;
1083 gboolean is_continuity, is_capacitance, is_diode, is_loop_current;
1084 gboolean is_current, is_micro, is_milli, is_power;
1085 gboolean is_power_factor_freq, is_power_apparent_power, is_v_a_eff_value;
1086 gboolean is_sign2, is_sign1, is_batt, is_ol1, is_max, is_min;
1087 gboolean is_maxmin, is_rel, is_ol2, is_open, is_manu, is_hold;
1088 gboolean is_light, is_usb, is_warning, is_auto_power, is_misplug_warn;
1089 gboolean is_lo, is_hi, is_open2;
1091 gboolean is_frequency, is_dual_display, is_auto, is_rms;
1094 SR_PRIV gboolean sr_vc870_packet_valid(const uint8_t *buf);
1095 SR_PRIV int sr_vc870_parse(const uint8_t *buf, float *floatval,
1096 struct sr_datafeed_analog *analog, void *info);
1098 /*--- hardware/lcr/es51919.c ------------------------------------------------*/
1100 SR_PRIV void es51919_serial_clean(void *priv);
1101 SR_PRIV struct sr_dev_inst *es51919_serial_scan(GSList *options,
1104 SR_PRIV int es51919_serial_config_get(uint32_t key, GVariant **data,
1105 const struct sr_dev_inst *sdi,
1106 const struct sr_channel_group *cg);
1107 SR_PRIV int es51919_serial_config_set(uint32_t key, GVariant *data,
1108 const struct sr_dev_inst *sdi,
1109 const struct sr_channel_group *cg);
1110 SR_PRIV int es51919_serial_config_list(uint32_t key, GVariant **data,
1111 const struct sr_dev_inst *sdi,
1112 const struct sr_channel_group *cg);
1113 SR_PRIV int es51919_serial_acquisition_start(const struct sr_dev_inst *sdi,
1115 SR_PRIV int es51919_serial_acquisition_stop(struct sr_dev_inst *sdi,
1118 /*--- hardware/dmm/ut372.c --------------------------------------------------*/
1120 #define UT372_PACKET_SIZE 27
1126 SR_PRIV gboolean sr_ut372_packet_valid(const uint8_t *buf);
1127 SR_PRIV int sr_ut372_parse(const uint8_t *buf, float *floatval,
1128 struct sr_datafeed_analog *analog, void *info);