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_handle_events_timeout_completed(ctx, tv, c) \
163 libusb_handle_events_timeout(ctx, tv)
166 /* Static definitions of structs ending with an all-zero entry are a
167 * problem when compiling with -Wmissing-field-initializers: GCC
168 * suppresses the warning only with { 0 }, clang wants { } */
172 #define ALL_ZERO { 0 }
176 #ifdef HAVE_LIBUSB_1_0
177 libusb_context *libusb_ctx;
178 gboolean usb_source_present;
181 gboolean usb_thread_running;
185 sr_receive_data_callback usb_cb;
191 /** Input module metadata keys. */
192 enum sr_input_meta_keys {
193 /** The input filename, if there is one. */
194 SR_INPUT_META_FILENAME = 0x01,
195 /** The input file's size in bytes. */
196 SR_INPUT_META_FILESIZE = 0x02,
197 /** The first 128 bytes of the file, provided as a GString. */
198 SR_INPUT_META_HEADER = 0x04,
199 /** The file's MIME type. */
200 SR_INPUT_META_MIMETYPE = 0x08,
202 /** The module cannot identify a file without this metadata. */
203 SR_INPUT_META_REQUIRED = 0x80,
206 /** Input (file) module struct. */
209 * A pointer to this input module's 'struct sr_input_module'.
211 const struct sr_input_module *module;
213 struct sr_dev_inst *sdi;
218 /** Input (file) module driver. */
219 struct sr_input_module {
221 * A unique ID for this input module, suitable for use in command-line
222 * clients, [a-z0-9-]. Must not be NULL.
227 * A unique name for this input module, suitable for use in GUI
228 * clients, can contain UTF-8. Must not be NULL.
233 * A short description of the input module. Must not be NULL.
235 * This can be displayed by frontends, e.g. when selecting the input
236 * module for saving a file.
241 * Zero-terminated list of metadata items the module needs to be able
242 * to identify an input stream. Can be all-zero, if the module cannot
243 * identify streams at all, i.e. has to be forced into use.
245 * Each item is one of:
246 * SR_INPUT_META_FILENAME
247 * SR_INPUT_META_FILESIZE
248 * SR_INPUT_META_HEADER
249 * SR_INPUT_META_MIMETYPE
251 * If the high bit (SR_INPUT META_REQUIRED) is set, the module cannot
252 * identify a stream without the given metadata.
254 const uint8_t metadata[8];
257 * Returns a NULL-terminated list of options this module can take.
258 * Can be NULL, if the module has no options.
260 struct sr_option *(*options) (void);
263 * Check if this input module can load and parse the specified stream.
265 * @param[in] metadata Metadata the module can use to identify the stream.
267 * @retval SR_OK This module knows the format.
268 * @retval SR_ERR_NA There wasn't enough data for this module to
269 * positively identify the format.
270 * @retval SR_ERR_DATA This module knows the format, but cannot handle it.
271 * This means the stream is either corrupt, or indicates a feature
272 * that the module does not support.
273 * @retval SR_ERR This module does not know the format.
275 int (*format_match) (GHashTable *metadata);
278 * Initialize the input module.
280 * @retval SR_OK Success
281 * @retval other Negative error code.
283 int (*init) (struct sr_input *in, GHashTable *options);
286 * Send data to the specified input instance.
288 * When an input module instance is created with sr_input_new(), this
289 * function is used to feed data to the instance.
291 * As enough data gets fed into this function to completely populate
292 * the device instance associated with this input instance, this is
293 * guaranteed to return the moment it's ready. This gives the caller
294 * the chance to examine the device instance, attach session callbacks
297 * @retval SR_OK Success
298 * @retval other Negative error code.
300 int (*receive) (struct sr_input *in, GString *buf);
303 * Signal the input module no more data will come.
305 * This will cause the module to process any data it may have buffered.
306 * The SR_DF_END packet will also typically be sent at this time.
308 int (*end) (struct sr_input *in);
311 * This function is called after the caller is finished using
312 * the input module, and can be used to free any internal
313 * resources the module may keep.
315 * This function is optional.
317 * @retval SR_OK Success
318 * @retval other Negative error code.
320 void (*cleanup) (struct sr_input *in);
323 /** Output module instance. */
325 /** A pointer to this output's module. */
326 const struct sr_output_module *module;
329 * The device for which this output module is creating output. This
330 * can be used by the module to find out channel names and numbers.
332 const struct sr_dev_inst *sdi;
335 * A generic pointer which can be used by the module to keep internal
336 * state between calls into its callback functions.
338 * For example, the module might store a pointer to a chunk of output
339 * there, and only flush it when it reaches a certain size.
344 /** Output module driver. */
345 struct sr_output_module {
347 * A unique ID for this output module, suitable for use in command-line
348 * clients, [a-z0-9-]. Must not be NULL.
353 * A unique name for this output module, suitable for use in GUI
354 * clients, can contain UTF-8. Must not be NULL.
359 * A short description of the output module. Must not be NULL.
361 * This can be displayed by frontends, e.g. when selecting the output
362 * module for saving a file.
367 * Returns a NULL-terminated list of options this module can take.
368 * Can be NULL, if the module has no options.
370 const struct sr_option *(*options) (void);
373 * This function is called once, at the beginning of an output stream.
375 * The device struct will be available in the output struct passed in,
376 * as well as the param field -- which may be NULL or an empty string,
377 * if no parameter was passed.
379 * The module can use this to initialize itself, create a struct for
380 * keeping state and storing it in the <code>internal</code> field.
382 * @param o Pointer to the respective 'struct sr_output'.
384 * @retval SR_OK Success
385 * @retval other Negative error code.
387 int (*init) (struct sr_output *o, GHashTable *options);
390 * This function is passed a copy of every packed in the data feed.
391 * Any output generated by the output module in response to the
392 * packet should be returned in a newly allocated GString
393 * <code>out</code>, which will be freed by the caller.
395 * Packets not of interest to the output module can just be ignored,
396 * and the <code>out</code> parameter set to NULL.
398 * @param o Pointer to the respective 'struct sr_output'.
399 * @param sdi The device instance that generated the packet.
400 * @param packet The complete packet.
401 * @param out A pointer where a GString * should be stored if
402 * the module generates output, or NULL if not.
404 * @retval SR_OK Success
405 * @retval other Negative error code.
407 int (*receive) (const struct sr_output *o,
408 const struct sr_datafeed_packet *packet, GString **out);
411 * This function is called after the caller is finished using
412 * the output module, and can be used to free any internal
413 * resources the module may keep.
415 * @retval SR_OK Success
416 * @retval other Negative error code.
418 int (*cleanup) (struct sr_output *o);
421 #ifdef HAVE_LIBUSB_1_0
422 /** USB device instance */
423 struct sr_usb_dev_inst {
426 /** Device address on USB bus */
428 /** libusb device handle */
429 struct libusb_device_handle *devhdl;
433 #ifdef HAVE_LIBSERIALPORT
434 #define SERIAL_PARITY_NONE SP_PARITY_NONE
435 #define SERIAL_PARITY_EVEN SP_PARITY_EVEN
436 #define SERIAL_PARITY_ODD SP_PARITY_ODD
437 struct sr_serial_dev_inst {
438 /** Port name, e.g. '/dev/tty42'. */
440 /** Comm params for serial_set_paramstr(). */
442 /** libserialport port handle */
443 struct sp_port *data;
444 /** libserialport event set */
445 struct sp_event_set *event_set;
446 /** GPollFDs for event polling */
451 struct sr_usbtmc_dev_inst {
456 /* Private driver context. */
458 /** sigrok context */
459 struct sr_context *sr_ctx;
463 /*--- log.c -----------------------------------------------------------------*/
465 SR_PRIV int sr_log(int loglevel, const char *format, ...);
466 SR_PRIV int sr_spew(const char *format, ...);
467 SR_PRIV int sr_dbg(const char *format, ...);
468 SR_PRIV int sr_info(const char *format, ...);
469 SR_PRIV int sr_warn(const char *format, ...);
470 SR_PRIV int sr_err(const char *format, ...);
472 /* Message logging helpers with subsystem-specific prefix string. */
473 #ifndef NO_LOG_WRAPPERS
474 #define sr_log(l, s, args...) sr_log(l, "%s: " s, LOG_PREFIX, ## args)
475 #define sr_spew(s, args...) sr_spew("%s: " s, LOG_PREFIX, ## args)
476 #define sr_dbg(s, args...) sr_dbg("%s: " s, LOG_PREFIX, ## args)
477 #define sr_info(s, args...) sr_info("%s: " s, LOG_PREFIX, ## args)
478 #define sr_warn(s, args...) sr_warn("%s: " s, LOG_PREFIX, ## args)
479 #define sr_err(s, args...) sr_err("%s: " s, LOG_PREFIX, ## args)
482 /*--- device.c --------------------------------------------------------------*/
484 /** Values for the changes argument of sr_dev_driver.config_channel_set. */
486 /** The enabled state of the channel has been changed. */
487 SR_CHANNEL_SET_ENABLED = 1 << 0,
490 SR_PRIV struct sr_channel *sr_channel_new(int index, int type,
491 gboolean enabled, const char *name);
493 /** Device instance data */
495 /** Device driver. */
496 struct sr_dev_driver *driver;
497 /** Device instance status. SR_ST_NOT_FOUND, etc. */
499 /** Device instance type. SR_INST_USB, etc. */
501 /** Device vendor. */
505 /** Device version. */
507 /** Serial number. */
509 /** Connection string to uniquely identify devices. */
511 /** List of channels. */
513 /** List of sr_channel_group structs */
514 GSList *channel_groups;
515 /** Device instance connection data (used?) */
517 /** Device instance private data (used?) */
519 /** Session to which this device is currently assigned. */
520 struct sr_session *session;
523 /* Generic device instances */
524 SR_PRIV struct sr_dev_inst *sr_dev_inst_new(void);
525 SR_PRIV void sr_dev_inst_free(struct sr_dev_inst *sdi);
527 #ifdef HAVE_LIBUSB_1_0
528 /* USB-specific instances */
529 SR_PRIV struct sr_usb_dev_inst *sr_usb_dev_inst_new(uint8_t bus,
530 uint8_t address, struct libusb_device_handle *hdl);
531 SR_PRIV void sr_usb_dev_inst_free(struct sr_usb_dev_inst *usb);
534 #ifdef HAVE_LIBSERIALPORT
535 /* Serial-specific instances */
536 SR_PRIV struct sr_serial_dev_inst *sr_serial_dev_inst_new(const char *port,
537 const char *serialcomm);
538 SR_PRIV void sr_serial_dev_inst_free(struct sr_serial_dev_inst *serial);
541 /* USBTMC-specific instances */
542 SR_PRIV struct sr_usbtmc_dev_inst *sr_usbtmc_dev_inst_new(const char *device);
543 SR_PRIV void sr_usbtmc_dev_inst_free(struct sr_usbtmc_dev_inst *usbtmc);
545 /*--- hwdriver.c ------------------------------------------------------------*/
547 SR_PRIV const GVariantType *sr_variant_type_get(int datatype);
548 SR_PRIV int sr_variant_type_check(uint32_t key, GVariant *data);
549 SR_PRIV void sr_hw_cleanup_all(void);
550 SR_PRIV struct sr_config *sr_config_new(uint32_t key, GVariant *data);
551 SR_PRIV void sr_config_free(struct sr_config *src);
552 SR_PRIV int sr_source_remove(int fd);
553 SR_PRIV int sr_source_remove_pollfd(GPollFD *pollfd);
554 SR_PRIV int sr_source_remove_channel(GIOChannel *channel);
555 SR_PRIV int sr_source_add(int fd, int events, int timeout,
556 sr_receive_data_callback cb, void *cb_data);
557 SR_PRIV int sr_source_add_pollfd(GPollFD *pollfd, int timeout,
558 sr_receive_data_callback cb, void *cb_data);
559 SR_PRIV int sr_source_add_channel(GIOChannel *channel, int events, int timeout,
560 sr_receive_data_callback cb, void *cb_data);
562 /*--- session.c -------------------------------------------------------------*/
565 /** List of struct sr_dev_inst pointers. */
567 /** List of struct sr_dev_inst pointers owned by this session. */
569 /** List of struct datafeed_callback pointers. */
570 GSList *datafeed_callbacks;
571 struct sr_trigger *trigger;
575 unsigned int num_sources;
578 * Both "sources" and "pollfds" are of the same size and contain pairs
579 * of descriptor and callback function. We can not embed the GPollFD
580 * into the source struct since we want to be able to pass the array
581 * of all poll descriptors to g_poll().
583 struct source *sources;
588 * These are our synchronization primitives for stopping the session in
589 * an async fashion. We need to make sure the session is stopped from
590 * within the session thread itself.
592 /** Mutex protecting access to abort_session. */
594 /** Abort current session. See sr_session_stop(). */
595 gboolean abort_session;
598 SR_PRIV int sr_session_send(const struct sr_dev_inst *sdi,
599 const struct sr_datafeed_packet *packet);
600 SR_PRIV int sr_session_stop_sync(struct sr_session *session);
601 SR_PRIV int sr_sessionfile_check(const char *filename);
602 SR_PRIV int sr_packet_copy(const struct sr_datafeed_packet *packet,
603 struct sr_datafeed_packet **copy);
604 SR_PRIV void sr_packet_free(struct sr_datafeed_packet *packet);
606 /*--- analog.c --------------------------------------------------------------*/
608 SR_PRIV int sr_analog_init(struct sr_datafeed_analog2 *analog,
609 struct sr_analog_encoding *encoding,
610 struct sr_analog_meaning *meaning,
611 struct sr_analog_spec *spec,
614 /*--- std.c -----------------------------------------------------------------*/
616 typedef int (*dev_close_callback)(struct sr_dev_inst *sdi);
617 typedef void (*std_dev_clear_callback)(void *priv);
619 SR_PRIV int std_init(struct sr_context *sr_ctx, struct sr_dev_driver *di,
621 #ifdef HAVE_LIBSERIALPORT
622 SR_PRIV int std_serial_dev_open(struct sr_dev_inst *sdi);
623 SR_PRIV int std_serial_dev_acquisition_stop(struct sr_dev_inst *sdi,
624 void *cb_data, dev_close_callback dev_close_fn,
625 struct sr_serial_dev_inst *serial, const char *prefix);
627 SR_PRIV int std_session_send_df_header(const struct sr_dev_inst *sdi,
629 SR_PRIV int std_dev_clear(const struct sr_dev_driver *driver,
630 std_dev_clear_callback clear_private);
631 SR_PRIV int std_serial_dev_close(struct sr_dev_inst *sdi);
633 /*--- strutil.c -------------------------------------------------------------*/
635 SR_PRIV int sr_atol(const char *str, long *ret);
636 SR_PRIV int sr_atoi(const char *str, int *ret);
637 SR_PRIV int sr_atod(const char *str, double *ret);
638 SR_PRIV int sr_atof(const char *str, float *ret);
639 SR_PRIV int sr_atof_ascii(const char *str, float *ret);
641 /*--- soft-trigger.c --------------------------------------------------------*/
643 struct soft_trigger_logic {
644 const struct sr_dev_inst *sdi;
645 const struct sr_trigger *trigger;
649 uint8_t *prev_sample;
652 SR_PRIV struct soft_trigger_logic *soft_trigger_logic_new(
653 const struct sr_dev_inst *sdi, struct sr_trigger *trigger);
654 SR_PRIV void soft_trigger_logic_free(struct soft_trigger_logic *st);
655 SR_PRIV int soft_trigger_logic_check(struct soft_trigger_logic *st, uint8_t *buf,
658 /*--- hardware/serial.c -----------------------------------------------------*/
660 #ifdef HAVE_LIBSERIALPORT
666 typedef gboolean (*packet_valid_callback)(const uint8_t *buf);
668 SR_PRIV int serial_open(struct sr_serial_dev_inst *serial, int flags);
669 SR_PRIV int serial_close(struct sr_serial_dev_inst *serial);
670 SR_PRIV int serial_flush(struct sr_serial_dev_inst *serial);
671 SR_PRIV int serial_drain(struct sr_serial_dev_inst *serial);
672 SR_PRIV int serial_write_blocking(struct sr_serial_dev_inst *serial,
673 const void *buf, size_t count, unsigned int timeout_ms);
674 SR_PRIV int serial_write_nonblocking(struct sr_serial_dev_inst *serial,
675 const void *buf, size_t count);
676 SR_PRIV int serial_read_blocking(struct sr_serial_dev_inst *serial, void *buf,
677 size_t count, unsigned int timeout_ms);
678 SR_PRIV int serial_read_nonblocking(struct sr_serial_dev_inst *serial, void *buf,
680 SR_PRIV int serial_set_params(struct sr_serial_dev_inst *serial, int baudrate,
681 int bits, int parity, int stopbits, int flowcontrol, int rts, int dtr);
682 SR_PRIV int serial_set_paramstr(struct sr_serial_dev_inst *serial,
683 const char *paramstr);
684 SR_PRIV int serial_readline(struct sr_serial_dev_inst *serial, char **buf,
685 int *buflen, gint64 timeout_ms);
686 SR_PRIV int serial_stream_detect(struct sr_serial_dev_inst *serial,
687 uint8_t *buf, size_t *buflen,
689 packet_valid_callback is_valid,
690 uint64_t timeout_ms, int baudrate);
691 SR_PRIV int sr_serial_extract_options(GSList *options, const char **serial_device,
692 const char **serial_options);
693 SR_PRIV int serial_source_add(struct sr_session *session,
694 struct sr_serial_dev_inst *serial, int events, int timeout,
695 sr_receive_data_callback cb, void *cb_data);
696 SR_PRIV int serial_source_remove(struct sr_session *session,
697 struct sr_serial_dev_inst *serial);
698 SR_PRIV GSList *sr_serial_find_usb(uint16_t vendor_id, uint16_t product_id);
699 SR_PRIV int serial_timeout(struct sr_serial_dev_inst *port, int num_bytes);
702 /*--- hardware/ezusb.c ------------------------------------------------------*/
704 #ifdef HAVE_LIBUSB_1_0
705 SR_PRIV int ezusb_reset(struct libusb_device_handle *hdl, int set_clear);
706 SR_PRIV int ezusb_install_firmware(libusb_device_handle *hdl,
707 const char *filename);
708 SR_PRIV int ezusb_upload_firmware(libusb_device *dev, int configuration,
709 const char *filename);
712 /*--- hardware/usb.c --------------------------------------------------------*/
714 #ifdef HAVE_LIBUSB_1_0
715 SR_PRIV GSList *sr_usb_find(libusb_context *usb_ctx, const char *conn);
716 SR_PRIV int sr_usb_open(libusb_context *usb_ctx, struct sr_usb_dev_inst *usb);
717 SR_PRIV int usb_source_add(struct sr_session *session, struct sr_context *ctx,
718 int timeout, sr_receive_data_callback cb, void *cb_data);
719 SR_PRIV int usb_source_remove(struct sr_session *session, struct sr_context *ctx);
720 SR_PRIV int usb_get_port_path(libusb_device *dev, char *path, int path_len);
723 /*--- hardware/scpi.c -------------------------------------------------------*/
725 #define SCPI_CMD_IDN "*IDN?"
726 #define SCPI_CMD_OPC "*OPC?"
729 SCPI_CMD_SET_TRIGGER_SOURCE,
730 SCPI_CMD_SET_TIMEBASE,
731 SCPI_CMD_SET_VERTICAL_DIV,
732 SCPI_CMD_SET_TRIGGER_SLOPE,
733 SCPI_CMD_SET_COUPLING,
734 SCPI_CMD_SET_HORIZ_TRIGGERPOS,
735 SCPI_CMD_GET_ANALOG_CHAN_STATE,
736 SCPI_CMD_GET_DIG_CHAN_STATE,
737 SCPI_CMD_GET_TIMEBASE,
738 SCPI_CMD_GET_VERTICAL_DIV,
739 SCPI_CMD_GET_VERTICAL_OFFSET,
740 SCPI_CMD_GET_TRIGGER_SOURCE,
741 SCPI_CMD_GET_HORIZ_TRIGGERPOS,
742 SCPI_CMD_GET_TRIGGER_SLOPE,
743 SCPI_CMD_GET_COUPLING,
744 SCPI_CMD_SET_ANALOG_CHAN_STATE,
745 SCPI_CMD_SET_DIG_CHAN_STATE,
746 SCPI_CMD_GET_DIG_POD_STATE,
747 SCPI_CMD_SET_DIG_POD_STATE,
748 SCPI_CMD_GET_ANALOG_DATA,
749 SCPI_CMD_GET_DIG_DATA,
750 SCPI_CMD_GET_SAMPLE_RATE,
751 SCPI_CMD_GET_SAMPLE_RATE_LIVE,
754 struct sr_scpi_hw_info {
758 char *firmware_version;
761 struct sr_scpi_dev_inst {
765 GSList *(*scan)(struct drv_context *drvc);
766 int (*dev_inst_new)(void *priv, struct drv_context *drvc,
767 const char *resource, char **params, const char *serialcomm);
768 int (*open)(void *priv);
769 int (*source_add)(struct sr_session *session, void *priv, int events,
770 int timeout, sr_receive_data_callback cb, void *cb_data);
771 int (*source_remove)(struct sr_session *session, void *priv);
772 int (*send)(void *priv, const char *command);
773 int (*read_begin)(void *priv);
774 int (*read_data)(void *priv, char *buf, int maxlen);
775 int (*read_complete)(void *priv);
776 int (*close)(void *priv);
777 void (*free)(void *priv);
778 unsigned int read_timeout_ms;
782 SR_PRIV GSList *sr_scpi_scan(struct drv_context *drvc, GSList *options,
783 struct sr_dev_inst *(*probe_device)(struct sr_scpi_dev_inst *scpi));
784 SR_PRIV struct sr_scpi_dev_inst *scpi_dev_inst_new(struct drv_context *drvc,
785 const char *resource, const char *serialcomm);
786 SR_PRIV int sr_scpi_open(struct sr_scpi_dev_inst *scpi);
787 SR_PRIV int sr_scpi_source_add(struct sr_session *session,
788 struct sr_scpi_dev_inst *scpi, int events, int timeout,
789 sr_receive_data_callback cb, void *cb_data);
790 SR_PRIV int sr_scpi_source_remove(struct sr_session *session,
791 struct sr_scpi_dev_inst *scpi);
792 SR_PRIV int sr_scpi_send(struct sr_scpi_dev_inst *scpi,
793 const char *format, ...);
794 SR_PRIV int sr_scpi_send_variadic(struct sr_scpi_dev_inst *scpi,
795 const char *format, va_list args);
796 SR_PRIV int sr_scpi_read_begin(struct sr_scpi_dev_inst *scpi);
797 SR_PRIV int sr_scpi_read_data(struct sr_scpi_dev_inst *scpi, char *buf, int maxlen);
798 SR_PRIV int sr_scpi_read_complete(struct sr_scpi_dev_inst *scpi);
799 SR_PRIV int sr_scpi_close(struct sr_scpi_dev_inst *scpi);
800 SR_PRIV void sr_scpi_free(struct sr_scpi_dev_inst *scpi);
802 SR_PRIV int sr_scpi_get_string(struct sr_scpi_dev_inst *scpi,
803 const char *command, char **scpi_response);
804 SR_PRIV int sr_scpi_get_bool(struct sr_scpi_dev_inst *scpi,
805 const char *command, gboolean *scpi_response);
806 SR_PRIV int sr_scpi_get_int(struct sr_scpi_dev_inst *scpi,
807 const char *command, int *scpi_response);
808 SR_PRIV int sr_scpi_get_float(struct sr_scpi_dev_inst *scpi,
809 const char *command, float *scpi_response);
810 SR_PRIV int sr_scpi_get_double(struct sr_scpi_dev_inst *scpi,
811 const char *command, double *scpi_response);
812 SR_PRIV int sr_scpi_get_opc(struct sr_scpi_dev_inst *scpi);
813 SR_PRIV int sr_scpi_get_floatv(struct sr_scpi_dev_inst *scpi,
814 const char *command, GArray **scpi_response);
815 SR_PRIV int sr_scpi_get_uint8v(struct sr_scpi_dev_inst *scpi,
816 const char *command, GArray **scpi_response);
817 SR_PRIV int sr_scpi_get_hw_id(struct sr_scpi_dev_inst *scpi,
818 struct sr_scpi_hw_info **scpi_response);
819 SR_PRIV void sr_scpi_hw_info_free(struct sr_scpi_hw_info *hw_info);
821 /*--- hardware/dmm/es519xx.c ------------------------------------------------*/
824 * All 11-byte es519xx chips repeat each block twice for each conversion cycle
825 * so always read 2 blocks at a time.
827 #define ES519XX_11B_PACKET_SIZE (11 * 2)
828 #define ES519XX_14B_PACKET_SIZE 14
830 struct es519xx_info {
831 gboolean is_judge, is_voltage, is_auto, is_micro, is_current;
832 gboolean is_milli, is_resistance, is_continuity, is_diode;
833 gboolean is_frequency, is_rpm, is_capacitance, is_duty_cycle;
834 gboolean is_temperature, is_celsius, is_fahrenheit;
835 gboolean is_adp0, is_adp1, is_adp2, is_adp3;
836 gboolean is_sign, is_batt, is_ol, is_pmax, is_pmin, is_apo;
837 gboolean is_dc, is_ac, is_vahz, is_min, is_max, is_rel, is_hold;
838 gboolean is_digit4, is_ul, is_vasel, is_vbar, is_lpf1, is_lpf0, is_rmr;
841 gboolean alt_functions, fivedigits, clampmeter, selectable_lpf;
844 SR_PRIV gboolean sr_es519xx_2400_11b_packet_valid(const uint8_t *buf);
845 SR_PRIV int sr_es519xx_2400_11b_parse(const uint8_t *buf, float *floatval,
846 struct sr_datafeed_analog *analog, void *info);
847 SR_PRIV gboolean sr_es519xx_2400_11b_altfn_packet_valid(const uint8_t *buf);
848 SR_PRIV int sr_es519xx_2400_11b_altfn_parse(const uint8_t *buf,
849 float *floatval, struct sr_datafeed_analog *analog, void *info);
850 SR_PRIV gboolean sr_es519xx_19200_11b_5digits_packet_valid(const uint8_t *buf);
851 SR_PRIV int sr_es519xx_19200_11b_5digits_parse(const uint8_t *buf,
852 float *floatval, struct sr_datafeed_analog *analog, void *info);
853 SR_PRIV gboolean sr_es519xx_19200_11b_clamp_packet_valid(const uint8_t *buf);
854 SR_PRIV int sr_es519xx_19200_11b_clamp_parse(const uint8_t *buf,
855 float *floatval, struct sr_datafeed_analog *analog, void *info);
856 SR_PRIV gboolean sr_es519xx_19200_11b_packet_valid(const uint8_t *buf);
857 SR_PRIV int sr_es519xx_19200_11b_parse(const uint8_t *buf, float *floatval,
858 struct sr_datafeed_analog *analog, void *info);
859 SR_PRIV gboolean sr_es519xx_19200_14b_packet_valid(const uint8_t *buf);
860 SR_PRIV int sr_es519xx_19200_14b_parse(const uint8_t *buf, float *floatval,
861 struct sr_datafeed_analog *analog, void *info);
862 SR_PRIV gboolean sr_es519xx_19200_14b_sel_lpf_packet_valid(const uint8_t *buf);
863 SR_PRIV int sr_es519xx_19200_14b_sel_lpf_parse(const uint8_t *buf,
864 float *floatval, struct sr_datafeed_analog *analog, void *info);
866 /*--- hardware/dmm/fs9922.c -------------------------------------------------*/
868 #define FS9922_PACKET_SIZE 14
871 gboolean is_auto, is_dc, is_ac, is_rel, is_hold, is_bpn, is_z1, is_z2;
872 gboolean is_max, is_min, is_apo, is_bat, is_nano, is_z3, is_micro;
873 gboolean is_milli, is_kilo, is_mega, is_beep, is_diode, is_percent;
874 gboolean is_z4, is_volt, is_ampere, is_ohm, is_hfe, is_hertz, is_farad;
875 gboolean is_celsius, is_fahrenheit;
876 int bargraph_sign, bargraph_value;
879 SR_PRIV gboolean sr_fs9922_packet_valid(const uint8_t *buf);
880 SR_PRIV int sr_fs9922_parse(const uint8_t *buf, float *floatval,
881 struct sr_datafeed_analog *analog, void *info);
882 SR_PRIV void sr_fs9922_z1_diode(struct sr_datafeed_analog *analog, void *info);
884 /*--- hardware/dmm/fs9721.c -------------------------------------------------*/
886 #define FS9721_PACKET_SIZE 14
889 gboolean is_ac, is_dc, is_auto, is_rs232, is_micro, is_nano, is_kilo;
890 gboolean is_diode, is_milli, is_percent, is_mega, is_beep, is_farad;
891 gboolean is_ohm, is_rel, is_hold, is_ampere, is_volt, is_hz, is_bat;
892 gboolean is_c2c1_11, is_c2c1_10, is_c2c1_01, is_c2c1_00, is_sign;
895 SR_PRIV gboolean sr_fs9721_packet_valid(const uint8_t *buf);
896 SR_PRIV int sr_fs9721_parse(const uint8_t *buf, float *floatval,
897 struct sr_datafeed_analog *analog, void *info);
898 SR_PRIV void sr_fs9721_00_temp_c(struct sr_datafeed_analog *analog, void *info);
899 SR_PRIV void sr_fs9721_01_temp_c(struct sr_datafeed_analog *analog, void *info);
900 SR_PRIV void sr_fs9721_10_temp_c(struct sr_datafeed_analog *analog, void *info);
901 SR_PRIV void sr_fs9721_01_10_temp_f_c(struct sr_datafeed_analog *analog, void *info);
902 SR_PRIV void sr_fs9721_max_c_min(struct sr_datafeed_analog *analog, void *info);
904 /*--- hardware/dmm/m2110.c --------------------------------------------------*/
906 #define BBCGM_M2110_PACKET_SIZE 9
908 SR_PRIV gboolean sr_m2110_packet_valid(const uint8_t *buf);
909 SR_PRIV int sr_m2110_parse(const uint8_t *buf, float *floatval,
910 struct sr_datafeed_analog *analog, void *info);
912 /*--- hardware/dmm/metex14.c ------------------------------------------------*/
914 #define METEX14_PACKET_SIZE 14
916 struct metex14_info {
917 gboolean is_ac, is_dc, is_resistance, is_capacity, is_temperature;
918 gboolean is_diode, is_frequency, is_ampere, is_volt, is_farad;
919 gboolean is_hertz, is_ohm, is_celsius, is_pico, is_nano, is_micro;
920 gboolean is_milli, is_kilo, is_mega, is_gain, is_decibel, is_hfe;
921 gboolean is_unitless, is_logic;
924 #ifdef HAVE_LIBSERIALPORT
925 SR_PRIV int sr_metex14_packet_request(struct sr_serial_dev_inst *serial);
927 SR_PRIV gboolean sr_metex14_packet_valid(const uint8_t *buf);
928 SR_PRIV int sr_metex14_parse(const uint8_t *buf, float *floatval,
929 struct sr_datafeed_analog *analog, void *info);
931 /*--- hardware/dmm/rs9lcd.c -------------------------------------------------*/
933 #define RS9LCD_PACKET_SIZE 9
935 /* Dummy info struct. The parser does not use it. */
936 struct rs9lcd_info { int dummy; };
938 SR_PRIV gboolean sr_rs9lcd_packet_valid(const uint8_t *buf);
939 SR_PRIV int sr_rs9lcd_parse(const uint8_t *buf, float *floatval,
940 struct sr_datafeed_analog *analog, void *info);
942 /*--- hardware/dmm/bm25x.c --------------------------------------------------*/
944 #define BRYMEN_BM25X_PACKET_SIZE 15
946 /* Dummy info struct. The parser does not use it. */
947 struct bm25x_info { int dummy; };
949 SR_PRIV gboolean sr_brymen_bm25x_packet_valid(const uint8_t *buf);
950 SR_PRIV int sr_brymen_bm25x_parse(const uint8_t *buf, float *floatval,
951 struct sr_datafeed_analog *analog, void *info);
953 /*--- hardware/dmm/ut71x.c --------------------------------------------------*/
955 #define UT71X_PACKET_SIZE 11
958 gboolean is_voltage, is_resistance, is_capacitance, is_temperature;
959 gboolean is_celsius, is_fahrenheit, is_current, is_continuity;
960 gboolean is_diode, is_frequency, is_duty_cycle, is_dc, is_ac;
961 gboolean is_auto, is_manual, is_sign, is_power, is_loop_current;
964 SR_PRIV gboolean sr_ut71x_packet_valid(const uint8_t *buf);
965 SR_PRIV int sr_ut71x_parse(const uint8_t *buf, float *floatval,
966 struct sr_datafeed_analog *analog, void *info);
968 /*--- hardware/lcr/es51919.c ------------------------------------------------*/
970 SR_PRIV void es51919_serial_clean(void *priv);
971 SR_PRIV struct sr_dev_inst *es51919_serial_scan(GSList *options,
974 SR_PRIV int es51919_serial_config_get(uint32_t key, GVariant **data,
975 const struct sr_dev_inst *sdi,
976 const struct sr_channel_group *cg);
977 SR_PRIV int es51919_serial_config_set(uint32_t key, GVariant *data,
978 const struct sr_dev_inst *sdi,
979 const struct sr_channel_group *cg);
980 SR_PRIV int es51919_serial_config_list(uint32_t key, GVariant **data,
981 const struct sr_dev_inst *sdi,
982 const struct sr_channel_group *cg);
983 SR_PRIV int es51919_serial_acquisition_start(const struct sr_dev_inst *sdi,
985 SR_PRIV int es51919_serial_acquisition_stop(struct sr_dev_inst *sdi,