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;
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 * Returns a NULL-terminated list of options this module can take.
376 * Can be NULL, if the module has no options.
378 const struct sr_option *(*options) (void);
381 * This function is called once, at the beginning of an output stream.
383 * The device struct will be available in the output struct passed in,
384 * as well as the param field -- which may be NULL or an empty string,
385 * if no parameter was passed.
387 * The module can use this to initialize itself, create a struct for
388 * keeping state and storing it in the <code>internal</code> field.
390 * @param o Pointer to the respective 'struct sr_output'.
392 * @retval SR_OK Success
393 * @retval other Negative error code.
395 int (*init) (struct sr_output *o, GHashTable *options);
398 * This function is passed a copy of every packed in the data feed.
399 * Any output generated by the output module in response to the
400 * packet should be returned in a newly allocated GString
401 * <code>out</code>, which will be freed by the caller.
403 * Packets not of interest to the output module can just be ignored,
404 * and the <code>out</code> parameter set to NULL.
406 * @param o Pointer to the respective 'struct sr_output'.
407 * @param sdi The device instance that generated the packet.
408 * @param packet The complete packet.
409 * @param out A pointer where a GString * should be stored if
410 * the module generates output, or NULL if not.
412 * @retval SR_OK Success
413 * @retval other Negative error code.
415 int (*receive) (const struct sr_output *o,
416 const struct sr_datafeed_packet *packet, GString **out);
419 * This function is called after the caller is finished using
420 * the output module, and can be used to free any internal
421 * resources the module may keep.
423 * @retval SR_OK Success
424 * @retval other Negative error code.
426 int (*cleanup) (struct sr_output *o);
429 #ifdef HAVE_LIBUSB_1_0
430 /** USB device instance */
431 struct sr_usb_dev_inst {
434 /** Device address on USB bus */
436 /** libusb device handle */
437 struct libusb_device_handle *devhdl;
441 #ifdef HAVE_LIBSERIALPORT
442 #define SERIAL_PARITY_NONE SP_PARITY_NONE
443 #define SERIAL_PARITY_EVEN SP_PARITY_EVEN
444 #define SERIAL_PARITY_ODD SP_PARITY_ODD
445 struct sr_serial_dev_inst {
446 /** Port name, e.g. '/dev/tty42'. */
448 /** Comm params for serial_set_paramstr(). */
450 /** libserialport port handle */
451 struct sp_port *data;
452 /** libserialport event set */
453 struct sp_event_set *event_set;
454 /** GPollFDs for event polling */
459 struct sr_usbtmc_dev_inst {
464 /* Private driver context. */
466 /** sigrok context */
467 struct sr_context *sr_ctx;
471 /*--- log.c -----------------------------------------------------------------*/
473 SR_PRIV int sr_log(int loglevel, const char *format, ...);
474 SR_PRIV int sr_spew(const char *format, ...);
475 SR_PRIV int sr_dbg(const char *format, ...);
476 SR_PRIV int sr_info(const char *format, ...);
477 SR_PRIV int sr_warn(const char *format, ...);
478 SR_PRIV int sr_err(const char *format, ...);
480 /* Message logging helpers with subsystem-specific prefix string. */
481 #ifndef NO_LOG_WRAPPERS
482 #define sr_log(l, s, args...) sr_log(l, "%s: " s, LOG_PREFIX, ## args)
483 #define sr_spew(s, args...) sr_spew("%s: " s, LOG_PREFIX, ## args)
484 #define sr_dbg(s, args...) sr_dbg("%s: " s, LOG_PREFIX, ## args)
485 #define sr_info(s, args...) sr_info("%s: " s, LOG_PREFIX, ## args)
486 #define sr_warn(s, args...) sr_warn("%s: " s, LOG_PREFIX, ## args)
487 #define sr_err(s, args...) sr_err("%s: " s, LOG_PREFIX, ## args)
490 /*--- device.c --------------------------------------------------------------*/
492 /** Values for the changes argument of sr_dev_driver.config_channel_set. */
494 /** The enabled state of the channel has been changed. */
495 SR_CHANNEL_SET_ENABLED = 1 << 0,
498 SR_PRIV struct sr_channel *sr_channel_new(int index, int type,
499 gboolean enabled, const char *name);
501 /** Device instance data */
503 /** Device driver. */
504 struct sr_dev_driver *driver;
505 /** Device instance status. SR_ST_NOT_FOUND, etc. */
507 /** Device instance type. SR_INST_USB, etc. */
509 /** Device vendor. */
513 /** Device version. */
515 /** Serial number. */
517 /** Connection string to uniquely identify devices. */
519 /** List of channels. */
521 /** List of sr_channel_group structs */
522 GSList *channel_groups;
523 /** Device instance connection data (used?) */
525 /** Device instance private data (used?) */
527 /** Session to which this device is currently assigned. */
528 struct sr_session *session;
531 /* Generic device instances */
532 SR_PRIV void sr_dev_inst_free(struct sr_dev_inst *sdi);
534 #ifdef HAVE_LIBUSB_1_0
535 /* USB-specific instances */
536 SR_PRIV struct sr_usb_dev_inst *sr_usb_dev_inst_new(uint8_t bus,
537 uint8_t address, struct libusb_device_handle *hdl);
538 SR_PRIV void sr_usb_dev_inst_free(struct sr_usb_dev_inst *usb);
541 #ifdef HAVE_LIBSERIALPORT
542 /* Serial-specific instances */
543 SR_PRIV struct sr_serial_dev_inst *sr_serial_dev_inst_new(const char *port,
544 const char *serialcomm);
545 SR_PRIV void sr_serial_dev_inst_free(struct sr_serial_dev_inst *serial);
548 /* USBTMC-specific instances */
549 SR_PRIV struct sr_usbtmc_dev_inst *sr_usbtmc_dev_inst_new(const char *device);
550 SR_PRIV void sr_usbtmc_dev_inst_free(struct sr_usbtmc_dev_inst *usbtmc);
552 /*--- hwdriver.c ------------------------------------------------------------*/
554 SR_PRIV const GVariantType *sr_variant_type_get(int datatype);
555 SR_PRIV int sr_variant_type_check(uint32_t key, GVariant *data);
556 SR_PRIV void sr_hw_cleanup_all(void);
557 SR_PRIV struct sr_config *sr_config_new(uint32_t key, GVariant *data);
558 SR_PRIV void sr_config_free(struct sr_config *src);
559 SR_PRIV int sr_source_remove(int fd);
560 SR_PRIV int sr_source_remove_pollfd(GPollFD *pollfd);
561 SR_PRIV int sr_source_remove_channel(GIOChannel *channel);
562 SR_PRIV int sr_source_add(int fd, int events, int timeout,
563 sr_receive_data_callback cb, void *cb_data);
564 SR_PRIV int sr_source_add_pollfd(GPollFD *pollfd, int timeout,
565 sr_receive_data_callback cb, void *cb_data);
566 SR_PRIV int sr_source_add_channel(GIOChannel *channel, int events, int timeout,
567 sr_receive_data_callback cb, void *cb_data);
569 /*--- session.c -------------------------------------------------------------*/
572 /** List of struct sr_dev_inst pointers. */
574 /** List of struct sr_dev_inst pointers owned by this session. */
576 /** List of struct datafeed_callback pointers. */
577 GSList *datafeed_callbacks;
578 struct sr_trigger *trigger;
582 unsigned int num_sources;
585 * Both "sources" and "pollfds" are of the same size and contain pairs
586 * of descriptor and callback function. We can not embed the GPollFD
587 * into the source struct since we want to be able to pass the array
588 * of all poll descriptors to g_poll().
590 struct source *sources;
595 * These are our synchronization primitives for stopping the session in
596 * an async fashion. We need to make sure the session is stopped from
597 * within the session thread itself.
599 /** Mutex protecting access to abort_session. */
601 /** Abort current session. See sr_session_stop(). */
602 gboolean abort_session;
605 SR_PRIV int sr_session_send(const struct sr_dev_inst *sdi,
606 const struct sr_datafeed_packet *packet);
607 SR_PRIV int sr_session_stop_sync(struct sr_session *session);
608 SR_PRIV int sr_sessionfile_check(const char *filename);
609 SR_PRIV int sr_packet_copy(const struct sr_datafeed_packet *packet,
610 struct sr_datafeed_packet **copy);
611 SR_PRIV void sr_packet_free(struct sr_datafeed_packet *packet);
613 /*--- analog.c --------------------------------------------------------------*/
615 SR_PRIV int sr_analog_init(struct sr_datafeed_analog2 *analog,
616 struct sr_analog_encoding *encoding,
617 struct sr_analog_meaning *meaning,
618 struct sr_analog_spec *spec,
621 /*--- std.c -----------------------------------------------------------------*/
623 typedef int (*dev_close_callback)(struct sr_dev_inst *sdi);
624 typedef void (*std_dev_clear_callback)(void *priv);
626 SR_PRIV int std_init(struct sr_context *sr_ctx, struct sr_dev_driver *di,
628 #ifdef HAVE_LIBSERIALPORT
629 SR_PRIV int std_serial_dev_open(struct sr_dev_inst *sdi);
630 SR_PRIV int std_serial_dev_acquisition_stop(struct sr_dev_inst *sdi,
631 void *cb_data, dev_close_callback dev_close_fn,
632 struct sr_serial_dev_inst *serial, const char *prefix);
634 SR_PRIV int std_session_send_df_header(const struct sr_dev_inst *sdi,
636 SR_PRIV int std_dev_clear(const struct sr_dev_driver *driver,
637 std_dev_clear_callback clear_private);
638 SR_PRIV int std_serial_dev_close(struct sr_dev_inst *sdi);
640 /*--- strutil.c -------------------------------------------------------------*/
642 SR_PRIV int sr_atol(const char *str, long *ret);
643 SR_PRIV int sr_atoi(const char *str, int *ret);
644 SR_PRIV int sr_atod(const char *str, double *ret);
645 SR_PRIV int sr_atof(const char *str, float *ret);
646 SR_PRIV int sr_atof_ascii(const char *str, float *ret);
648 /*--- soft-trigger.c --------------------------------------------------------*/
650 struct soft_trigger_logic {
651 const struct sr_dev_inst *sdi;
652 const struct sr_trigger *trigger;
656 uint8_t *prev_sample;
657 uint8_t *pre_trigger_buffer;
658 uint8_t *pre_trigger_head;
659 int pre_trigger_size;
660 int pre_trigger_fill;
663 SR_PRIV struct soft_trigger_logic *soft_trigger_logic_new(
664 const struct sr_dev_inst *sdi, struct sr_trigger *trigger,
665 int pre_trigger_samples);
666 SR_PRIV void soft_trigger_logic_free(struct soft_trigger_logic *st);
667 SR_PRIV int soft_trigger_logic_check(struct soft_trigger_logic *st, uint8_t *buf,
668 int len, int *pre_trigger_samples);
670 /*--- hardware/serial.c -----------------------------------------------------*/
672 #ifdef HAVE_LIBSERIALPORT
678 typedef gboolean (*packet_valid_callback)(const uint8_t *buf);
680 SR_PRIV int serial_open(struct sr_serial_dev_inst *serial, int flags);
681 SR_PRIV int serial_close(struct sr_serial_dev_inst *serial);
682 SR_PRIV int serial_flush(struct sr_serial_dev_inst *serial);
683 SR_PRIV int serial_drain(struct sr_serial_dev_inst *serial);
684 SR_PRIV int serial_write_blocking(struct sr_serial_dev_inst *serial,
685 const void *buf, size_t count, unsigned int timeout_ms);
686 SR_PRIV int serial_write_nonblocking(struct sr_serial_dev_inst *serial,
687 const void *buf, size_t count);
688 SR_PRIV int serial_read_blocking(struct sr_serial_dev_inst *serial, void *buf,
689 size_t count, unsigned int timeout_ms);
690 SR_PRIV int serial_read_nonblocking(struct sr_serial_dev_inst *serial, void *buf,
692 SR_PRIV int serial_set_params(struct sr_serial_dev_inst *serial, int baudrate,
693 int bits, int parity, int stopbits, int flowcontrol, int rts, int dtr);
694 SR_PRIV int serial_set_paramstr(struct sr_serial_dev_inst *serial,
695 const char *paramstr);
696 SR_PRIV int serial_readline(struct sr_serial_dev_inst *serial, char **buf,
697 int *buflen, gint64 timeout_ms);
698 SR_PRIV int serial_stream_detect(struct sr_serial_dev_inst *serial,
699 uint8_t *buf, size_t *buflen,
701 packet_valid_callback is_valid,
702 uint64_t timeout_ms, int baudrate);
703 SR_PRIV int sr_serial_extract_options(GSList *options, const char **serial_device,
704 const char **serial_options);
705 SR_PRIV int serial_source_add(struct sr_session *session,
706 struct sr_serial_dev_inst *serial, int events, int timeout,
707 sr_receive_data_callback cb, void *cb_data);
708 SR_PRIV int serial_source_remove(struct sr_session *session,
709 struct sr_serial_dev_inst *serial);
710 SR_PRIV GSList *sr_serial_find_usb(uint16_t vendor_id, uint16_t product_id);
711 SR_PRIV int serial_timeout(struct sr_serial_dev_inst *port, int num_bytes);
714 /*--- hardware/ezusb.c ------------------------------------------------------*/
716 #ifdef HAVE_LIBUSB_1_0
717 SR_PRIV int ezusb_reset(struct libusb_device_handle *hdl, int set_clear);
718 SR_PRIV int ezusb_install_firmware(libusb_device_handle *hdl,
719 const char *filename);
720 SR_PRIV int ezusb_upload_firmware(libusb_device *dev, int configuration,
721 const char *filename);
724 /*--- hardware/usb.c --------------------------------------------------------*/
726 #ifdef HAVE_LIBUSB_1_0
727 SR_PRIV GSList *sr_usb_find(libusb_context *usb_ctx, const char *conn);
728 SR_PRIV int sr_usb_open(libusb_context *usb_ctx, struct sr_usb_dev_inst *usb);
729 SR_PRIV int usb_source_add(struct sr_session *session, struct sr_context *ctx,
730 int timeout, sr_receive_data_callback cb, void *cb_data);
731 SR_PRIV int usb_source_remove(struct sr_session *session, struct sr_context *ctx);
732 SR_PRIV int usb_get_port_path(libusb_device *dev, char *path, int path_len);
735 /*--- hardware/scpi.c -------------------------------------------------------*/
737 #define SCPI_CMD_IDN "*IDN?"
738 #define SCPI_CMD_OPC "*OPC?"
741 SCPI_CMD_SET_TRIGGER_SOURCE,
742 SCPI_CMD_SET_TIMEBASE,
743 SCPI_CMD_SET_VERTICAL_DIV,
744 SCPI_CMD_SET_TRIGGER_SLOPE,
745 SCPI_CMD_SET_COUPLING,
746 SCPI_CMD_SET_HORIZ_TRIGGERPOS,
747 SCPI_CMD_GET_ANALOG_CHAN_STATE,
748 SCPI_CMD_GET_DIG_CHAN_STATE,
749 SCPI_CMD_GET_TIMEBASE,
750 SCPI_CMD_GET_VERTICAL_DIV,
751 SCPI_CMD_GET_VERTICAL_OFFSET,
752 SCPI_CMD_GET_TRIGGER_SOURCE,
753 SCPI_CMD_GET_HORIZ_TRIGGERPOS,
754 SCPI_CMD_GET_TRIGGER_SLOPE,
755 SCPI_CMD_GET_COUPLING,
756 SCPI_CMD_SET_ANALOG_CHAN_STATE,
757 SCPI_CMD_SET_DIG_CHAN_STATE,
758 SCPI_CMD_GET_DIG_POD_STATE,
759 SCPI_CMD_SET_DIG_POD_STATE,
760 SCPI_CMD_GET_ANALOG_DATA,
761 SCPI_CMD_GET_DIG_DATA,
762 SCPI_CMD_GET_SAMPLE_RATE,
763 SCPI_CMD_GET_SAMPLE_RATE_LIVE,
766 struct sr_scpi_hw_info {
770 char *firmware_version;
773 struct sr_scpi_dev_inst {
777 GSList *(*scan)(struct drv_context *drvc);
778 int (*dev_inst_new)(void *priv, struct drv_context *drvc,
779 const char *resource, char **params, const char *serialcomm);
780 int (*open)(void *priv);
781 int (*source_add)(struct sr_session *session, void *priv, int events,
782 int timeout, sr_receive_data_callback cb, void *cb_data);
783 int (*source_remove)(struct sr_session *session, void *priv);
784 int (*send)(void *priv, const char *command);
785 int (*read_begin)(void *priv);
786 int (*read_data)(void *priv, char *buf, int maxlen);
787 int (*read_complete)(void *priv);
788 int (*close)(void *priv);
789 void (*free)(void *priv);
790 unsigned int read_timeout_ms;
794 SR_PRIV GSList *sr_scpi_scan(struct drv_context *drvc, GSList *options,
795 struct sr_dev_inst *(*probe_device)(struct sr_scpi_dev_inst *scpi));
796 SR_PRIV struct sr_scpi_dev_inst *scpi_dev_inst_new(struct drv_context *drvc,
797 const char *resource, const char *serialcomm);
798 SR_PRIV int sr_scpi_open(struct sr_scpi_dev_inst *scpi);
799 SR_PRIV int sr_scpi_source_add(struct sr_session *session,
800 struct sr_scpi_dev_inst *scpi, int events, int timeout,
801 sr_receive_data_callback cb, void *cb_data);
802 SR_PRIV int sr_scpi_source_remove(struct sr_session *session,
803 struct sr_scpi_dev_inst *scpi);
804 SR_PRIV int sr_scpi_send(struct sr_scpi_dev_inst *scpi,
805 const char *format, ...);
806 SR_PRIV int sr_scpi_send_variadic(struct sr_scpi_dev_inst *scpi,
807 const char *format, va_list args);
808 SR_PRIV int sr_scpi_read_begin(struct sr_scpi_dev_inst *scpi);
809 SR_PRIV int sr_scpi_read_data(struct sr_scpi_dev_inst *scpi, char *buf, int maxlen);
810 SR_PRIV int sr_scpi_read_complete(struct sr_scpi_dev_inst *scpi);
811 SR_PRIV int sr_scpi_close(struct sr_scpi_dev_inst *scpi);
812 SR_PRIV void sr_scpi_free(struct sr_scpi_dev_inst *scpi);
814 SR_PRIV int sr_scpi_get_string(struct sr_scpi_dev_inst *scpi,
815 const char *command, char **scpi_response);
816 SR_PRIV int sr_scpi_get_bool(struct sr_scpi_dev_inst *scpi,
817 const char *command, gboolean *scpi_response);
818 SR_PRIV int sr_scpi_get_int(struct sr_scpi_dev_inst *scpi,
819 const char *command, int *scpi_response);
820 SR_PRIV int sr_scpi_get_float(struct sr_scpi_dev_inst *scpi,
821 const char *command, float *scpi_response);
822 SR_PRIV int sr_scpi_get_double(struct sr_scpi_dev_inst *scpi,
823 const char *command, double *scpi_response);
824 SR_PRIV int sr_scpi_get_opc(struct sr_scpi_dev_inst *scpi);
825 SR_PRIV int sr_scpi_get_floatv(struct sr_scpi_dev_inst *scpi,
826 const char *command, GArray **scpi_response);
827 SR_PRIV int sr_scpi_get_uint8v(struct sr_scpi_dev_inst *scpi,
828 const char *command, GArray **scpi_response);
829 SR_PRIV int sr_scpi_get_hw_id(struct sr_scpi_dev_inst *scpi,
830 struct sr_scpi_hw_info **scpi_response);
831 SR_PRIV void sr_scpi_hw_info_free(struct sr_scpi_hw_info *hw_info);
833 /*--- hardware/dmm/es519xx.c ------------------------------------------------*/
836 * All 11-byte es519xx chips repeat each block twice for each conversion cycle
837 * so always read 2 blocks at a time.
839 #define ES519XX_11B_PACKET_SIZE (11 * 2)
840 #define ES519XX_14B_PACKET_SIZE 14
842 struct es519xx_info {
843 gboolean is_judge, is_voltage, is_auto, is_micro, is_current;
844 gboolean is_milli, is_resistance, is_continuity, is_diode;
845 gboolean is_frequency, is_rpm, is_capacitance, is_duty_cycle;
846 gboolean is_temperature, is_celsius, is_fahrenheit;
847 gboolean is_adp0, is_adp1, is_adp2, is_adp3;
848 gboolean is_sign, is_batt, is_ol, is_pmax, is_pmin, is_apo;
849 gboolean is_dc, is_ac, is_vahz, is_min, is_max, is_rel, is_hold;
850 gboolean is_digit4, is_ul, is_vasel, is_vbar, is_lpf1, is_lpf0, is_rmr;
853 gboolean alt_functions, fivedigits, clampmeter, selectable_lpf;
856 SR_PRIV gboolean sr_es519xx_2400_11b_packet_valid(const uint8_t *buf);
857 SR_PRIV int sr_es519xx_2400_11b_parse(const uint8_t *buf, float *floatval,
858 struct sr_datafeed_analog *analog, void *info);
859 SR_PRIV gboolean sr_es519xx_2400_11b_altfn_packet_valid(const uint8_t *buf);
860 SR_PRIV int sr_es519xx_2400_11b_altfn_parse(const uint8_t *buf,
861 float *floatval, struct sr_datafeed_analog *analog, void *info);
862 SR_PRIV gboolean sr_es519xx_19200_11b_5digits_packet_valid(const uint8_t *buf);
863 SR_PRIV int sr_es519xx_19200_11b_5digits_parse(const uint8_t *buf,
864 float *floatval, struct sr_datafeed_analog *analog, void *info);
865 SR_PRIV gboolean sr_es519xx_19200_11b_clamp_packet_valid(const uint8_t *buf);
866 SR_PRIV int sr_es519xx_19200_11b_clamp_parse(const uint8_t *buf,
867 float *floatval, struct sr_datafeed_analog *analog, void *info);
868 SR_PRIV gboolean sr_es519xx_19200_11b_packet_valid(const uint8_t *buf);
869 SR_PRIV int sr_es519xx_19200_11b_parse(const uint8_t *buf, float *floatval,
870 struct sr_datafeed_analog *analog, void *info);
871 SR_PRIV gboolean sr_es519xx_19200_14b_packet_valid(const uint8_t *buf);
872 SR_PRIV int sr_es519xx_19200_14b_parse(const uint8_t *buf, float *floatval,
873 struct sr_datafeed_analog *analog, void *info);
874 SR_PRIV gboolean sr_es519xx_19200_14b_sel_lpf_packet_valid(const uint8_t *buf);
875 SR_PRIV int sr_es519xx_19200_14b_sel_lpf_parse(const uint8_t *buf,
876 float *floatval, struct sr_datafeed_analog *analog, void *info);
878 /*--- hardware/dmm/fs9922.c -------------------------------------------------*/
880 #define FS9922_PACKET_SIZE 14
883 gboolean is_auto, is_dc, is_ac, is_rel, is_hold, is_bpn, is_z1, is_z2;
884 gboolean is_max, is_min, is_apo, is_bat, is_nano, is_z3, is_micro;
885 gboolean is_milli, is_kilo, is_mega, is_beep, is_diode, is_percent;
886 gboolean is_z4, is_volt, is_ampere, is_ohm, is_hfe, is_hertz, is_farad;
887 gboolean is_celsius, is_fahrenheit;
888 int bargraph_sign, bargraph_value;
891 SR_PRIV gboolean sr_fs9922_packet_valid(const uint8_t *buf);
892 SR_PRIV int sr_fs9922_parse(const uint8_t *buf, float *floatval,
893 struct sr_datafeed_analog *analog, void *info);
894 SR_PRIV void sr_fs9922_z1_diode(struct sr_datafeed_analog *analog, void *info);
896 /*--- hardware/dmm/fs9721.c -------------------------------------------------*/
898 #define FS9721_PACKET_SIZE 14
901 gboolean is_ac, is_dc, is_auto, is_rs232, is_micro, is_nano, is_kilo;
902 gboolean is_diode, is_milli, is_percent, is_mega, is_beep, is_farad;
903 gboolean is_ohm, is_rel, is_hold, is_ampere, is_volt, is_hz, is_bat;
904 gboolean is_c2c1_11, is_c2c1_10, is_c2c1_01, is_c2c1_00, is_sign;
907 SR_PRIV gboolean sr_fs9721_packet_valid(const uint8_t *buf);
908 SR_PRIV int sr_fs9721_parse(const uint8_t *buf, float *floatval,
909 struct sr_datafeed_analog *analog, void *info);
910 SR_PRIV void sr_fs9721_00_temp_c(struct sr_datafeed_analog *analog, void *info);
911 SR_PRIV void sr_fs9721_01_temp_c(struct sr_datafeed_analog *analog, void *info);
912 SR_PRIV void sr_fs9721_10_temp_c(struct sr_datafeed_analog *analog, void *info);
913 SR_PRIV void sr_fs9721_01_10_temp_f_c(struct sr_datafeed_analog *analog, void *info);
914 SR_PRIV void sr_fs9721_max_c_min(struct sr_datafeed_analog *analog, void *info);
916 /*--- hardware/dmm/m2110.c --------------------------------------------------*/
918 #define BBCGM_M2110_PACKET_SIZE 9
920 SR_PRIV gboolean sr_m2110_packet_valid(const uint8_t *buf);
921 SR_PRIV int sr_m2110_parse(const uint8_t *buf, float *floatval,
922 struct sr_datafeed_analog *analog, void *info);
924 /*--- hardware/dmm/metex14.c ------------------------------------------------*/
926 #define METEX14_PACKET_SIZE 14
928 struct metex14_info {
929 gboolean is_ac, is_dc, is_resistance, is_capacity, is_temperature;
930 gboolean is_diode, is_frequency, is_ampere, is_volt, is_farad;
931 gboolean is_hertz, is_ohm, is_celsius, is_pico, is_nano, is_micro;
932 gboolean is_milli, is_kilo, is_mega, is_gain, is_decibel, is_hfe;
933 gboolean is_unitless, is_logic;
936 #ifdef HAVE_LIBSERIALPORT
937 SR_PRIV int sr_metex14_packet_request(struct sr_serial_dev_inst *serial);
939 SR_PRIV gboolean sr_metex14_packet_valid(const uint8_t *buf);
940 SR_PRIV int sr_metex14_parse(const uint8_t *buf, float *floatval,
941 struct sr_datafeed_analog *analog, void *info);
943 /*--- hardware/dmm/rs9lcd.c -------------------------------------------------*/
945 #define RS9LCD_PACKET_SIZE 9
947 /* Dummy info struct. The parser does not use it. */
948 struct rs9lcd_info { int dummy; };
950 SR_PRIV gboolean sr_rs9lcd_packet_valid(const uint8_t *buf);
951 SR_PRIV int sr_rs9lcd_parse(const uint8_t *buf, float *floatval,
952 struct sr_datafeed_analog *analog, void *info);
954 /*--- hardware/dmm/bm25x.c --------------------------------------------------*/
956 #define BRYMEN_BM25X_PACKET_SIZE 15
958 /* Dummy info struct. The parser does not use it. */
959 struct bm25x_info { int dummy; };
961 SR_PRIV gboolean sr_brymen_bm25x_packet_valid(const uint8_t *buf);
962 SR_PRIV int sr_brymen_bm25x_parse(const uint8_t *buf, float *floatval,
963 struct sr_datafeed_analog *analog, void *info);
965 /*--- hardware/dmm/ut71x.c --------------------------------------------------*/
967 #define UT71X_PACKET_SIZE 11
970 gboolean is_voltage, is_resistance, is_capacitance, is_temperature;
971 gboolean is_celsius, is_fahrenheit, is_current, is_continuity;
972 gboolean is_diode, is_frequency, is_duty_cycle, is_dc, is_ac;
973 gboolean is_auto, is_manual, is_sign, is_power, is_loop_current;
976 SR_PRIV gboolean sr_ut71x_packet_valid(const uint8_t *buf);
977 SR_PRIV int sr_ut71x_parse(const uint8_t *buf, float *floatval,
978 struct sr_datafeed_analog *analog, void *info);
980 /*--- hardware/lcr/es51919.c ------------------------------------------------*/
982 SR_PRIV void es51919_serial_clean(void *priv);
983 SR_PRIV struct sr_dev_inst *es51919_serial_scan(GSList *options,
986 SR_PRIV int es51919_serial_config_get(uint32_t key, GVariant **data,
987 const struct sr_dev_inst *sdi,
988 const struct sr_channel_group *cg);
989 SR_PRIV int es51919_serial_config_set(uint32_t key, GVariant *data,
990 const struct sr_dev_inst *sdi,
991 const struct sr_channel_group *cg);
992 SR_PRIV int es51919_serial_config_list(uint32_t key, GVariant **data,
993 const struct sr_dev_inst *sdi,
994 const struct sr_channel_group *cg);
995 SR_PRIV int es51919_serial_acquisition_start(const struct sr_dev_inst *sdi,
997 SR_PRIV int es51919_serial_acquisition_stop(struct sr_dev_inst *sdi,