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 * Read a 32 bits big endian float out of memory.
118 * @param x a pointer to the input memory
119 * @return the corresponding float
121 #define RBFL(x) ((union { uint32_t u; float f; }) { .u = RB32(x) }.f)
124 * Read a 32 bits little endian float out of memory.
125 * @param x a pointer to the input memory
126 * @return the corresponding float
128 #define RLFL(x) ((union { uint32_t u; float f; }) { .u = RL32(x) }.f)
131 * Write a 8 bits unsigned integer to memory.
132 * @param p a pointer to the output memory
133 * @param x the input unsigned integer
135 #define W8(p, x) do { ((uint8_t*)(p))[0] = (uint8_t) (x); } while (0)
138 * Write a 16 bits unsigned integer to memory stored as big endian.
139 * @param p a pointer to the output memory
140 * @param x the input unsigned integer
142 #define WB16(p, x) do { ((uint8_t*)(p))[1] = (uint8_t) (x); \
143 ((uint8_t*)(p))[0] = (uint8_t)((x)>>8); } while (0)
146 * Write a 16 bits unsigned integer to memory stored as little endian.
147 * @param p a pointer to the output memory
148 * @param x the input unsigned integer
150 #define WL16(p, x) do { ((uint8_t*)(p))[0] = (uint8_t) (x); \
151 ((uint8_t*)(p))[1] = (uint8_t)((x)>>8); } while (0)
154 * Write a 32 bits unsigned integer to memory stored as big endian.
155 * @param p a pointer to the output memory
156 * @param x the input unsigned integer
158 #define WB32(p, x) do { ((uint8_t*)(p))[3] = (uint8_t) (x); \
159 ((uint8_t*)(p))[2] = (uint8_t)((x)>>8); \
160 ((uint8_t*)(p))[1] = (uint8_t)((x)>>16); \
161 ((uint8_t*)(p))[0] = (uint8_t)((x)>>24); } while (0)
164 * Write a 32 bits unsigned integer to memory stored as little endian.
165 * @param p a pointer to the output memory
166 * @param x the input unsigned integer
168 #define WL32(p, x) do { ((uint8_t*)(p))[0] = (uint8_t) (x); \
169 ((uint8_t*)(p))[1] = (uint8_t)((x)>>8); \
170 ((uint8_t*)(p))[2] = (uint8_t)((x)>>16); \
171 ((uint8_t*)(p))[3] = (uint8_t)((x)>>24); } while (0)
174 * Write a 32 bits float to memory stored as big endian.
175 * @param p a pointer to the output memory
176 * @param x the input float
178 #define WBFL(p, x) WB32(p, (union { uint32_t u; float f; }) { .f = x }.u)
181 * Write a 32 bits float to memory stored as little endian.
182 * @param p a pointer to the output memory
183 * @param x the input float
185 #define WLFL(p, x) WL32(p, (union { uint32_t u; float f; }) { .f = x }.u)
187 /* Portability fixes for FreeBSD. */
189 #define LIBUSB_CLASS_APPLICATION 0xfe
190 #define libusb_has_capability(x) 0
191 #define libusb_handle_events_timeout_completed(ctx, tv, c) \
192 libusb_handle_events_timeout(ctx, tv)
195 /* Static definitions of structs ending with an all-zero entry are a
196 * problem when compiling with -Wmissing-field-initializers: GCC
197 * suppresses the warning only with { 0 }, clang wants { } */
201 #define ALL_ZERO { 0 }
205 struct sr_dev_driver **driver_list;
206 #ifdef HAVE_LIBUSB_1_0
207 libusb_context *libusb_ctx;
208 gboolean usb_source_present;
211 gboolean usb_thread_running;
212 HANDLE usb_wait_request_event;
213 HANDLE usb_wait_complete_event;
215 sr_receive_data_callback usb_cb;
221 /** Input module metadata keys. */
222 enum sr_input_meta_keys {
223 /** The input filename, if there is one. */
224 SR_INPUT_META_FILENAME = 0x01,
225 /** The input file's size in bytes. */
226 SR_INPUT_META_FILESIZE = 0x02,
227 /** The first 128 bytes of the file, provided as a GString. */
228 SR_INPUT_META_HEADER = 0x04,
229 /** The file's MIME type. */
230 SR_INPUT_META_MIMETYPE = 0x08,
232 /** The module cannot identify a file without this metadata. */
233 SR_INPUT_META_REQUIRED = 0x80,
236 /** Input (file) module struct. */
239 * A pointer to this input module's 'struct sr_input_module'.
241 const struct sr_input_module *module;
243 struct sr_dev_inst *sdi;
248 /** Input (file) module driver. */
249 struct sr_input_module {
251 * A unique ID for this input module, suitable for use in command-line
252 * clients, [a-z0-9-]. Must not be NULL.
257 * A unique name for this input module, suitable for use in GUI
258 * clients, can contain UTF-8. Must not be NULL.
263 * A short description of the input module. Must not be NULL.
265 * This can be displayed by frontends, e.g. when selecting the input
266 * module for saving a file.
271 * A NULL terminated array of strings containing a list of file name
272 * extensions typical for the input file format, or NULL if there is
273 * no typical extension for this file format.
275 const char *const *exts;
278 * Zero-terminated list of metadata items the module needs to be able
279 * to identify an input stream. Can be all-zero, if the module cannot
280 * identify streams at all, i.e. has to be forced into use.
282 * Each item is one of:
283 * SR_INPUT_META_FILENAME
284 * SR_INPUT_META_FILESIZE
285 * SR_INPUT_META_HEADER
286 * SR_INPUT_META_MIMETYPE
288 * If the high bit (SR_INPUT META_REQUIRED) is set, the module cannot
289 * identify a stream without the given metadata.
291 const uint8_t metadata[8];
294 * Returns a NULL-terminated list of options this module can take.
295 * Can be NULL, if the module has no options.
297 struct sr_option *(*options) (void);
300 * Check if this input module can load and parse the specified stream.
302 * @param[in] metadata Metadata the module can use to identify the stream.
304 * @retval SR_OK This module knows the format.
305 * @retval SR_ERR_NA There wasn't enough data for this module to
306 * positively identify the format.
307 * @retval SR_ERR_DATA This module knows the format, but cannot handle it.
308 * This means the stream is either corrupt, or indicates a feature
309 * that the module does not support.
310 * @retval SR_ERR This module does not know the format.
312 int (*format_match) (GHashTable *metadata);
315 * Initialize the input module.
317 * @retval SR_OK Success
318 * @retval other Negative error code.
320 int (*init) (struct sr_input *in, GHashTable *options);
323 * Send data to the specified input instance.
325 * When an input module instance is created with sr_input_new(), this
326 * function is used to feed data to the instance.
328 * As enough data gets fed into this function to completely populate
329 * the device instance associated with this input instance, this is
330 * guaranteed to return the moment it's ready. This gives the caller
331 * the chance to examine the device instance, attach session callbacks
334 * @retval SR_OK Success
335 * @retval other Negative error code.
337 int (*receive) (struct sr_input *in, GString *buf);
340 * Signal the input module no more data will come.
342 * This will cause the module to process any data it may have buffered.
343 * The SR_DF_END packet will also typically be sent at this time.
345 int (*end) (struct sr_input *in);
348 * This function is called after the caller is finished using
349 * the input module, and can be used to free any internal
350 * resources the module may keep.
352 * This function is optional.
354 * @retval SR_OK Success
355 * @retval other Negative error code.
357 void (*cleanup) (struct sr_input *in);
360 /** Output module instance. */
362 /** A pointer to this output's module. */
363 const struct sr_output_module *module;
366 * The device for which this output module is creating output. This
367 * can be used by the module to find out channel names and numbers.
369 const struct sr_dev_inst *sdi;
372 * A generic pointer which can be used by the module to keep internal
373 * state between calls into its callback functions.
375 * For example, the module might store a pointer to a chunk of output
376 * there, and only flush it when it reaches a certain size.
381 /** Output module driver. */
382 struct sr_output_module {
384 * A unique ID for this output module, suitable for use in command-line
385 * clients, [a-z0-9-]. Must not be NULL.
390 * A unique name for this output module, suitable for use in GUI
391 * clients, can contain UTF-8. Must not be NULL.
396 * A short description of the output module. Must not be NULL.
398 * This can be displayed by frontends, e.g. when selecting the output
399 * module for saving a file.
404 * A NULL terminated array of strings containing a list of file name
405 * extensions typical for the input file format, or NULL if there is
406 * no typical extension for this file format.
408 const char *const *exts;
411 * Returns a NULL-terminated list of options this module can take.
412 * Can be NULL, if the module has no options.
414 const struct sr_option *(*options) (void);
417 * This function is called once, at the beginning of an output stream.
419 * The device struct will be available in the output struct passed in,
420 * as well as the param field -- which may be NULL or an empty string,
421 * if no parameter was passed.
423 * The module can use this to initialize itself, create a struct for
424 * keeping state and storing it in the <code>internal</code> field.
426 * @param o Pointer to the respective 'struct sr_output'.
428 * @retval SR_OK Success
429 * @retval other Negative error code.
431 int (*init) (struct sr_output *o, GHashTable *options);
434 * This function is passed a copy of every packet in the data feed.
435 * Any output generated by the output module in response to the
436 * packet should be returned in a newly allocated GString
437 * <code>out</code>, which will be freed by the caller.
439 * Packets not of interest to the output module can just be ignored,
440 * and the <code>out</code> parameter set to NULL.
442 * @param o Pointer to the respective 'struct sr_output'.
443 * @param sdi The device instance that generated the packet.
444 * @param packet The complete packet.
445 * @param out A pointer where a GString * should be stored if
446 * the module generates output, or NULL if not.
448 * @retval SR_OK Success
449 * @retval other Negative error code.
451 int (*receive) (const struct sr_output *o,
452 const struct sr_datafeed_packet *packet, GString **out);
455 * This function is called after the caller is finished using
456 * the output module, and can be used to free any internal
457 * resources the module may keep.
459 * @retval SR_OK Success
460 * @retval other Negative error code.
462 int (*cleanup) (struct sr_output *o);
465 /** Transform module instance. */
466 struct sr_transform {
467 /** A pointer to this transform's module. */
468 const struct sr_transform_module *module;
471 * The device for which this transform module is used. This
472 * can be used by the module to find out channel names and numbers.
474 const struct sr_dev_inst *sdi;
477 * A generic pointer which can be used by the module to keep internal
478 * state between calls into its callback functions.
483 struct sr_transform_module {
485 * A unique ID for this transform module, suitable for use in
486 * command-line clients, [a-z0-9-]. Must not be NULL.
491 * A unique name for this transform module, suitable for use in GUI
492 * clients, can contain UTF-8. Must not be NULL.
497 * A short description of the transform module. Must not be NULL.
499 * This can be displayed by frontends, e.g. when selecting
500 * which transform module(s) to add.
505 * Returns a NULL-terminated list of options this transform module
506 * can take. Can be NULL, if the transform module has no options.
508 const struct sr_option *(*options) (void);
511 * This function is called once, at the beginning of a stream.
513 * @param t Pointer to the respective 'struct sr_transform'.
514 * @param options Hash table of options for this transform module.
515 * Can be NULL if no options are to be used.
517 * @retval SR_OK Success
518 * @retval other Negative error code.
520 int (*init) (struct sr_transform *t, GHashTable *options);
523 * This function is passed a pointer to every packet in the data feed.
525 * It can either return (in packet_out) a pointer to another packet
526 * (possibly the exact same packet it got as input), or NULL.
528 * @param t Pointer to the respective 'struct sr_transform'.
529 * @param packet_in Pointer to a datafeed packet.
530 * @param packet_out Pointer to the resulting datafeed packet after
531 * this function was run. If NULL, the transform
532 * module intentionally didn't output a new packet.
534 * @retval SR_OK Success
535 * @retval other Negative error code.
537 int (*receive) (const struct sr_transform *t,
538 struct sr_datafeed_packet *packet_in,
539 struct sr_datafeed_packet **packet_out);
542 * This function is called after the caller is finished using
543 * the transform module, and can be used to free any internal
544 * resources the module may keep.
546 * @retval SR_OK Success
547 * @retval other Negative error code.
549 int (*cleanup) (struct sr_transform *t);
552 #ifdef HAVE_LIBUSB_1_0
553 /** USB device instance */
554 struct sr_usb_dev_inst {
557 /** Device address on USB bus */
559 /** libusb device handle */
560 struct libusb_device_handle *devhdl;
564 #ifdef HAVE_LIBSERIALPORT
565 #define SERIAL_PARITY_NONE SP_PARITY_NONE
566 #define SERIAL_PARITY_EVEN SP_PARITY_EVEN
567 #define SERIAL_PARITY_ODD SP_PARITY_ODD
568 struct sr_serial_dev_inst {
569 /** Port name, e.g. '/dev/tty42'. */
571 /** Comm params for serial_set_paramstr(). */
573 /** libserialport port handle */
574 struct sp_port *data;
575 /** libserialport event set */
576 struct sp_event_set *event_set;
577 /** GPollFDs for event polling */
582 struct sr_usbtmc_dev_inst {
587 /* Private driver context. */
589 /** sigrok context */
590 struct sr_context *sr_ctx;
594 /*--- log.c -----------------------------------------------------------------*/
596 SR_PRIV int sr_log(int loglevel, const char *format, ...);
597 SR_PRIV int sr_spew(const char *format, ...);
598 SR_PRIV int sr_dbg(const char *format, ...);
599 SR_PRIV int sr_info(const char *format, ...);
600 SR_PRIV int sr_warn(const char *format, ...);
601 SR_PRIV int sr_err(const char *format, ...);
603 /* Message logging helpers with subsystem-specific prefix string. */
604 #ifndef NO_LOG_WRAPPERS
605 #define sr_log(l, s, args...) sr_log(l, "%s: " s, LOG_PREFIX, ## args)
606 #define sr_spew(s, args...) sr_spew("%s: " s, LOG_PREFIX, ## args)
607 #define sr_dbg(s, args...) sr_dbg("%s: " s, LOG_PREFIX, ## args)
608 #define sr_info(s, args...) sr_info("%s: " s, LOG_PREFIX, ## args)
609 #define sr_warn(s, args...) sr_warn("%s: " s, LOG_PREFIX, ## args)
610 #define sr_err(s, args...) sr_err("%s: " s, LOG_PREFIX, ## args)
613 /*--- device.c --------------------------------------------------------------*/
615 /** Values for the changes argument of sr_dev_driver.config_channel_set. */
617 /** The enabled state of the channel has been changed. */
618 SR_CHANNEL_SET_ENABLED = 1 << 0,
621 SR_PRIV struct sr_channel *sr_channel_new(struct sr_dev_inst *sdi,
622 int index, int type, gboolean enabled, const char *name);
624 /** Device instance data */
626 /** Device driver. */
627 struct sr_dev_driver *driver;
628 /** Device instance status. SR_ST_NOT_FOUND, etc. */
630 /** Device instance type. SR_INST_USB, etc. */
632 /** Device vendor. */
636 /** Device version. */
638 /** Serial number. */
640 /** Connection string to uniquely identify devices. */
642 /** List of channels. */
644 /** List of sr_channel_group structs */
645 GSList *channel_groups;
646 /** Device instance connection data (used?) */
648 /** Device instance private data (used?) */
650 /** Session to which this device is currently assigned. */
651 struct sr_session *session;
654 /* Generic device instances */
655 SR_PRIV void sr_dev_inst_free(struct sr_dev_inst *sdi);
657 #ifdef HAVE_LIBUSB_1_0
658 /* USB-specific instances */
659 SR_PRIV struct sr_usb_dev_inst *sr_usb_dev_inst_new(uint8_t bus,
660 uint8_t address, struct libusb_device_handle *hdl);
661 SR_PRIV void sr_usb_dev_inst_free(struct sr_usb_dev_inst *usb);
664 #ifdef HAVE_LIBSERIALPORT
665 /* Serial-specific instances */
666 SR_PRIV struct sr_serial_dev_inst *sr_serial_dev_inst_new(const char *port,
667 const char *serialcomm);
668 SR_PRIV void sr_serial_dev_inst_free(struct sr_serial_dev_inst *serial);
671 /* USBTMC-specific instances */
672 SR_PRIV struct sr_usbtmc_dev_inst *sr_usbtmc_dev_inst_new(const char *device);
673 SR_PRIV void sr_usbtmc_dev_inst_free(struct sr_usbtmc_dev_inst *usbtmc);
675 /*--- hwdriver.c ------------------------------------------------------------*/
677 extern SR_PRIV struct sr_dev_driver **drivers_lists[];
679 SR_PRIV const GVariantType *sr_variant_type_get(int datatype);
680 SR_PRIV int sr_variant_type_check(uint32_t key, GVariant *data);
681 SR_PRIV void sr_hw_cleanup_all(const struct sr_context *ctx);
682 SR_PRIV struct sr_config *sr_config_new(uint32_t key, GVariant *data);
683 SR_PRIV void sr_config_free(struct sr_config *src);
684 SR_PRIV int sr_source_remove(int fd);
685 SR_PRIV int sr_source_remove_pollfd(GPollFD *pollfd);
686 SR_PRIV int sr_source_remove_channel(GIOChannel *channel);
687 SR_PRIV int sr_source_add(int fd, int events, int timeout,
688 sr_receive_data_callback cb, void *cb_data);
689 SR_PRIV int sr_source_add_pollfd(GPollFD *pollfd, int timeout,
690 sr_receive_data_callback cb, void *cb_data);
691 SR_PRIV int sr_source_add_channel(GIOChannel *channel, int events, int timeout,
692 sr_receive_data_callback cb, void *cb_data);
694 /*--- session.c -------------------------------------------------------------*/
697 /** Context this session exists in. */
698 struct sr_context *ctx;
699 /** List of struct sr_dev_inst pointers. */
701 /** List of struct sr_dev_inst pointers owned by this session. */
703 /** List of struct datafeed_callback pointers. */
704 GSList *datafeed_callbacks;
706 struct sr_trigger *trigger;
710 unsigned int num_sources;
713 * Both "sources" and "pollfds" are of the same size and contain pairs
714 * of descriptor and callback function. We can not embed the GPollFD
715 * into the source struct since we want to be able to pass the array
716 * of all poll descriptors to g_poll().
718 struct source *sources;
723 * These are our synchronization primitives for stopping the session in
724 * an async fashion. We need to make sure the session is stopped from
725 * within the session thread itself.
727 /** Mutex protecting access to abort_session. */
729 /** Abort current session. See sr_session_stop(). */
730 gboolean abort_session;
733 SR_PRIV int sr_session_send(const struct sr_dev_inst *sdi,
734 const struct sr_datafeed_packet *packet);
735 SR_PRIV int sr_session_stop_sync(struct sr_session *session);
736 SR_PRIV int sr_sessionfile_check(const char *filename);
737 SR_PRIV int sr_packet_copy(const struct sr_datafeed_packet *packet,
738 struct sr_datafeed_packet **copy);
739 SR_PRIV void sr_packet_free(struct sr_datafeed_packet *packet);
741 /*--- analog.c --------------------------------------------------------------*/
743 SR_PRIV int sr_analog_init(struct sr_datafeed_analog2 *analog,
744 struct sr_analog_encoding *encoding,
745 struct sr_analog_meaning *meaning,
746 struct sr_analog_spec *spec,
749 /*--- std.c -----------------------------------------------------------------*/
751 typedef int (*dev_close_callback)(struct sr_dev_inst *sdi);
752 typedef void (*std_dev_clear_callback)(void *priv);
754 SR_PRIV int std_init(struct sr_context *sr_ctx, struct sr_dev_driver *di,
756 #ifdef HAVE_LIBSERIALPORT
757 SR_PRIV int std_serial_dev_open(struct sr_dev_inst *sdi);
758 SR_PRIV int std_serial_dev_acquisition_stop(struct sr_dev_inst *sdi,
759 void *cb_data, dev_close_callback dev_close_fn,
760 struct sr_serial_dev_inst *serial, const char *prefix);
762 SR_PRIV int std_session_send_df_header(const struct sr_dev_inst *sdi,
764 SR_PRIV int std_dev_clear(const struct sr_dev_driver *driver,
765 std_dev_clear_callback clear_private);
766 SR_PRIV int std_serial_dev_close(struct sr_dev_inst *sdi);
768 /*--- strutil.c -------------------------------------------------------------*/
770 SR_PRIV int sr_atol(const char *str, long *ret);
771 SR_PRIV int sr_atoi(const char *str, int *ret);
772 SR_PRIV int sr_atod(const char *str, double *ret);
773 SR_PRIV int sr_atof(const char *str, float *ret);
774 SR_PRIV int sr_atof_ascii(const char *str, float *ret);
776 /*--- soft-trigger.c --------------------------------------------------------*/
778 struct soft_trigger_logic {
779 const struct sr_dev_inst *sdi;
780 const struct sr_trigger *trigger;
784 uint8_t *prev_sample;
785 uint8_t *pre_trigger_buffer;
786 uint8_t *pre_trigger_head;
787 int pre_trigger_size;
788 int pre_trigger_fill;
791 SR_PRIV struct soft_trigger_logic *soft_trigger_logic_new(
792 const struct sr_dev_inst *sdi, struct sr_trigger *trigger,
793 int pre_trigger_samples);
794 SR_PRIV void soft_trigger_logic_free(struct soft_trigger_logic *st);
795 SR_PRIV int soft_trigger_logic_check(struct soft_trigger_logic *st, uint8_t *buf,
796 int len, int *pre_trigger_samples);
798 /*--- hardware/serial.c -----------------------------------------------------*/
800 #ifdef HAVE_LIBSERIALPORT
806 typedef gboolean (*packet_valid_callback)(const uint8_t *buf);
808 SR_PRIV int serial_open(struct sr_serial_dev_inst *serial, int flags);
809 SR_PRIV int serial_close(struct sr_serial_dev_inst *serial);
810 SR_PRIV int serial_flush(struct sr_serial_dev_inst *serial);
811 SR_PRIV int serial_drain(struct sr_serial_dev_inst *serial);
812 SR_PRIV int serial_write_blocking(struct sr_serial_dev_inst *serial,
813 const void *buf, size_t count, unsigned int timeout_ms);
814 SR_PRIV int serial_write_nonblocking(struct sr_serial_dev_inst *serial,
815 const void *buf, size_t count);
816 SR_PRIV int serial_read_blocking(struct sr_serial_dev_inst *serial, void *buf,
817 size_t count, unsigned int timeout_ms);
818 SR_PRIV int serial_read_nonblocking(struct sr_serial_dev_inst *serial, void *buf,
820 SR_PRIV int serial_set_params(struct sr_serial_dev_inst *serial, int baudrate,
821 int bits, int parity, int stopbits, int flowcontrol, int rts, int dtr);
822 SR_PRIV int serial_set_paramstr(struct sr_serial_dev_inst *serial,
823 const char *paramstr);
824 SR_PRIV int serial_readline(struct sr_serial_dev_inst *serial, char **buf,
825 int *buflen, gint64 timeout_ms);
826 SR_PRIV int serial_stream_detect(struct sr_serial_dev_inst *serial,
827 uint8_t *buf, size_t *buflen,
829 packet_valid_callback is_valid,
830 uint64_t timeout_ms, int baudrate);
831 SR_PRIV int sr_serial_extract_options(GSList *options, const char **serial_device,
832 const char **serial_options);
833 SR_PRIV int serial_source_add(struct sr_session *session,
834 struct sr_serial_dev_inst *serial, int events, int timeout,
835 sr_receive_data_callback cb, void *cb_data);
836 SR_PRIV int serial_source_remove(struct sr_session *session,
837 struct sr_serial_dev_inst *serial);
838 SR_PRIV GSList *sr_serial_find_usb(uint16_t vendor_id, uint16_t product_id);
839 SR_PRIV int serial_timeout(struct sr_serial_dev_inst *port, int num_bytes);
842 /*--- hardware/ezusb.c ------------------------------------------------------*/
844 #ifdef HAVE_LIBUSB_1_0
845 SR_PRIV int ezusb_reset(struct libusb_device_handle *hdl, int set_clear);
846 SR_PRIV int ezusb_install_firmware(libusb_device_handle *hdl,
847 const char *filename);
848 SR_PRIV int ezusb_upload_firmware(libusb_device *dev, int configuration,
849 const char *filename);
852 /*--- hardware/usb.c --------------------------------------------------------*/
854 #ifdef HAVE_LIBUSB_1_0
855 SR_PRIV GSList *sr_usb_find(libusb_context *usb_ctx, const char *conn);
856 SR_PRIV int sr_usb_open(libusb_context *usb_ctx, struct sr_usb_dev_inst *usb);
857 SR_PRIV int usb_source_add(struct sr_session *session, struct sr_context *ctx,
858 int timeout, sr_receive_data_callback cb, void *cb_data);
859 SR_PRIV int usb_source_remove(struct sr_session *session, struct sr_context *ctx);
860 SR_PRIV int usb_get_port_path(libusb_device *dev, char *path, int path_len);
863 /*--- hardware/scpi.c -------------------------------------------------------*/
865 #define SCPI_CMD_IDN "*IDN?"
866 #define SCPI_CMD_OPC "*OPC?"
869 SCPI_CMD_SET_TRIGGER_SOURCE,
870 SCPI_CMD_SET_TIMEBASE,
871 SCPI_CMD_SET_VERTICAL_DIV,
872 SCPI_CMD_SET_TRIGGER_SLOPE,
873 SCPI_CMD_SET_COUPLING,
874 SCPI_CMD_SET_HORIZ_TRIGGERPOS,
875 SCPI_CMD_GET_ANALOG_CHAN_STATE,
876 SCPI_CMD_GET_DIG_CHAN_STATE,
877 SCPI_CMD_GET_TIMEBASE,
878 SCPI_CMD_GET_VERTICAL_DIV,
879 SCPI_CMD_GET_VERTICAL_OFFSET,
880 SCPI_CMD_GET_TRIGGER_SOURCE,
881 SCPI_CMD_GET_HORIZ_TRIGGERPOS,
882 SCPI_CMD_GET_TRIGGER_SLOPE,
883 SCPI_CMD_GET_COUPLING,
884 SCPI_CMD_SET_ANALOG_CHAN_STATE,
885 SCPI_CMD_SET_DIG_CHAN_STATE,
886 SCPI_CMD_GET_DIG_POD_STATE,
887 SCPI_CMD_SET_DIG_POD_STATE,
888 SCPI_CMD_GET_ANALOG_DATA,
889 SCPI_CMD_GET_DIG_DATA,
890 SCPI_CMD_GET_SAMPLE_RATE,
891 SCPI_CMD_GET_SAMPLE_RATE_LIVE,
894 struct sr_scpi_hw_info {
898 char *firmware_version;
901 struct sr_scpi_dev_inst {
905 GSList *(*scan)(struct drv_context *drvc);
906 int (*dev_inst_new)(void *priv, struct drv_context *drvc,
907 const char *resource, char **params, const char *serialcomm);
908 int (*open)(void *priv);
909 int (*source_add)(struct sr_session *session, void *priv, int events,
910 int timeout, sr_receive_data_callback cb, void *cb_data);
911 int (*source_remove)(struct sr_session *session, void *priv);
912 int (*send)(void *priv, const char *command);
913 int (*read_begin)(void *priv);
914 int (*read_data)(void *priv, char *buf, int maxlen);
915 int (*read_complete)(void *priv);
916 int (*close)(void *priv);
917 void (*free)(void *priv);
918 unsigned int read_timeout_ms;
922 SR_PRIV GSList *sr_scpi_scan(struct drv_context *drvc, GSList *options,
923 struct sr_dev_inst *(*probe_device)(struct sr_scpi_dev_inst *scpi));
924 SR_PRIV struct sr_scpi_dev_inst *scpi_dev_inst_new(struct drv_context *drvc,
925 const char *resource, const char *serialcomm);
926 SR_PRIV int sr_scpi_open(struct sr_scpi_dev_inst *scpi);
927 SR_PRIV int sr_scpi_source_add(struct sr_session *session,
928 struct sr_scpi_dev_inst *scpi, int events, int timeout,
929 sr_receive_data_callback cb, void *cb_data);
930 SR_PRIV int sr_scpi_source_remove(struct sr_session *session,
931 struct sr_scpi_dev_inst *scpi);
932 SR_PRIV int sr_scpi_send(struct sr_scpi_dev_inst *scpi,
933 const char *format, ...);
934 SR_PRIV int sr_scpi_send_variadic(struct sr_scpi_dev_inst *scpi,
935 const char *format, va_list args);
936 SR_PRIV int sr_scpi_read_begin(struct sr_scpi_dev_inst *scpi);
937 SR_PRIV int sr_scpi_read_data(struct sr_scpi_dev_inst *scpi, char *buf, int maxlen);
938 SR_PRIV int sr_scpi_read_complete(struct sr_scpi_dev_inst *scpi);
939 SR_PRIV int sr_scpi_close(struct sr_scpi_dev_inst *scpi);
940 SR_PRIV void sr_scpi_free(struct sr_scpi_dev_inst *scpi);
942 SR_PRIV int sr_scpi_get_string(struct sr_scpi_dev_inst *scpi,
943 const char *command, char **scpi_response);
944 SR_PRIV int sr_scpi_get_bool(struct sr_scpi_dev_inst *scpi,
945 const char *command, gboolean *scpi_response);
946 SR_PRIV int sr_scpi_get_int(struct sr_scpi_dev_inst *scpi,
947 const char *command, int *scpi_response);
948 SR_PRIV int sr_scpi_get_float(struct sr_scpi_dev_inst *scpi,
949 const char *command, float *scpi_response);
950 SR_PRIV int sr_scpi_get_double(struct sr_scpi_dev_inst *scpi,
951 const char *command, double *scpi_response);
952 SR_PRIV int sr_scpi_get_opc(struct sr_scpi_dev_inst *scpi);
953 SR_PRIV int sr_scpi_get_floatv(struct sr_scpi_dev_inst *scpi,
954 const char *command, GArray **scpi_response);
955 SR_PRIV int sr_scpi_get_uint8v(struct sr_scpi_dev_inst *scpi,
956 const char *command, GArray **scpi_response);
957 SR_PRIV int sr_scpi_get_hw_id(struct sr_scpi_dev_inst *scpi,
958 struct sr_scpi_hw_info **scpi_response);
959 SR_PRIV void sr_scpi_hw_info_free(struct sr_scpi_hw_info *hw_info);
961 /*--- modbus/modbus.c -------------------------------------------------------*/
963 struct sr_modbus_dev_inst {
967 GSList *(*scan)(int modbusaddr);
968 int (*dev_inst_new)(void *priv, const char *resource,
969 char **params, const char *serialcomm, int modbusaddr);
970 int (*open)(void *priv);
971 int (*source_add)(struct sr_session *session, void *priv, int events,
972 int timeout, sr_receive_data_callback cb, void *cb_data);
973 int (*source_remove)(struct sr_session *session, void *priv);
974 int (*send)(void *priv, const uint8_t *buffer, int buffer_size);
975 int (*read_begin)(void *priv, uint8_t *function_code);
976 int (*read_data)(void *priv, uint8_t *buf, int maxlen);
977 int (*read_end)(void *priv);
978 int (*close)(void *priv);
979 void (*free)(void *priv);
980 unsigned int read_timeout_ms;
984 SR_PRIV GSList *sr_modbus_scan(struct drv_context *drvc, GSList *options,
985 struct sr_dev_inst *(*probe_device)(struct sr_modbus_dev_inst *modbus));
986 SR_PRIV struct sr_modbus_dev_inst *modbus_dev_inst_new(const char *resource,
987 const char *serialcomm, int modbusaddr);
988 SR_PRIV int sr_modbus_open(struct sr_modbus_dev_inst *modbus);
989 SR_PRIV int sr_modbus_source_add(struct sr_session *session,
990 struct sr_modbus_dev_inst *modbus, int events, int timeout,
991 sr_receive_data_callback cb, void *cb_data);
992 SR_PRIV int sr_modbus_source_remove(struct sr_session *session,
993 struct sr_modbus_dev_inst *modbus);
994 SR_PRIV int sr_modbus_request(struct sr_modbus_dev_inst *modbus,
995 uint8_t *request, int request_size);
996 SR_PRIV int sr_modbus_reply(struct sr_modbus_dev_inst *modbus,
997 uint8_t *reply, int reply_size);
998 SR_PRIV int sr_modbus_request_reply(struct sr_modbus_dev_inst *modbus,
999 uint8_t *request, int request_size,
1000 uint8_t *reply, int reply_size);
1001 SR_PRIV int sr_modbus_read_coils(struct sr_modbus_dev_inst *modbus,
1002 int address, int nb_coils, uint8_t *coils);
1003 SR_PRIV int sr_modbus_read_holding_registers(struct sr_modbus_dev_inst *modbus,
1004 int address, int nb_registers,
1005 uint16_t *registers);
1006 SR_PRIV int sr_modbus_write_coil(struct sr_modbus_dev_inst *modbus,
1007 int address, int value);
1008 SR_PRIV int sr_modbus_write_multiple_registers(struct sr_modbus_dev_inst*modbus,
1009 int address, int nb_registers,
1010 uint16_t *registers);
1011 SR_PRIV int sr_modbus_close(struct sr_modbus_dev_inst *modbus);
1012 SR_PRIV void sr_modbus_free(struct sr_modbus_dev_inst *modbus);
1014 /*--- hardware/dmm/es519xx.c ------------------------------------------------*/
1017 * All 11-byte es519xx chips repeat each block twice for each conversion cycle
1018 * so always read 2 blocks at a time.
1020 #define ES519XX_11B_PACKET_SIZE (11 * 2)
1021 #define ES519XX_14B_PACKET_SIZE 14
1023 struct es519xx_info {
1024 gboolean is_judge, is_voltage, is_auto, is_micro, is_current;
1025 gboolean is_milli, is_resistance, is_continuity, is_diode;
1026 gboolean is_frequency, is_rpm, is_capacitance, is_duty_cycle;
1027 gboolean is_temperature, is_celsius, is_fahrenheit;
1028 gboolean is_adp0, is_adp1, is_adp2, is_adp3;
1029 gboolean is_sign, is_batt, is_ol, is_pmax, is_pmin, is_apo;
1030 gboolean is_dc, is_ac, is_vahz, is_min, is_max, is_rel, is_hold;
1031 gboolean is_digit4, is_ul, is_vasel, is_vbar, is_lpf1, is_lpf0, is_rmr;
1034 gboolean alt_functions, fivedigits, clampmeter, selectable_lpf;
1037 SR_PRIV gboolean sr_es519xx_2400_11b_packet_valid(const uint8_t *buf);
1038 SR_PRIV int sr_es519xx_2400_11b_parse(const uint8_t *buf, float *floatval,
1039 struct sr_datafeed_analog *analog, void *info);
1040 SR_PRIV gboolean sr_es519xx_2400_11b_altfn_packet_valid(const uint8_t *buf);
1041 SR_PRIV int sr_es519xx_2400_11b_altfn_parse(const uint8_t *buf,
1042 float *floatval, struct sr_datafeed_analog *analog, void *info);
1043 SR_PRIV gboolean sr_es519xx_19200_11b_5digits_packet_valid(const uint8_t *buf);
1044 SR_PRIV int sr_es519xx_19200_11b_5digits_parse(const uint8_t *buf,
1045 float *floatval, struct sr_datafeed_analog *analog, void *info);
1046 SR_PRIV gboolean sr_es519xx_19200_11b_clamp_packet_valid(const uint8_t *buf);
1047 SR_PRIV int sr_es519xx_19200_11b_clamp_parse(const uint8_t *buf,
1048 float *floatval, struct sr_datafeed_analog *analog, void *info);
1049 SR_PRIV gboolean sr_es519xx_19200_11b_packet_valid(const uint8_t *buf);
1050 SR_PRIV int sr_es519xx_19200_11b_parse(const uint8_t *buf, float *floatval,
1051 struct sr_datafeed_analog *analog, void *info);
1052 SR_PRIV gboolean sr_es519xx_19200_14b_packet_valid(const uint8_t *buf);
1053 SR_PRIV int sr_es519xx_19200_14b_parse(const uint8_t *buf, float *floatval,
1054 struct sr_datafeed_analog *analog, void *info);
1055 SR_PRIV gboolean sr_es519xx_19200_14b_sel_lpf_packet_valid(const uint8_t *buf);
1056 SR_PRIV int sr_es519xx_19200_14b_sel_lpf_parse(const uint8_t *buf,
1057 float *floatval, struct sr_datafeed_analog *analog, void *info);
1059 /*--- hardware/dmm/fs9922.c -------------------------------------------------*/
1061 #define FS9922_PACKET_SIZE 14
1063 struct fs9922_info {
1064 gboolean is_auto, is_dc, is_ac, is_rel, is_hold, is_bpn, is_z1, is_z2;
1065 gboolean is_max, is_min, is_apo, is_bat, is_nano, is_z3, is_micro;
1066 gboolean is_milli, is_kilo, is_mega, is_beep, is_diode, is_percent;
1067 gboolean is_z4, is_volt, is_ampere, is_ohm, is_hfe, is_hertz, is_farad;
1068 gboolean is_celsius, is_fahrenheit;
1069 int bargraph_sign, bargraph_value;
1072 SR_PRIV gboolean sr_fs9922_packet_valid(const uint8_t *buf);
1073 SR_PRIV int sr_fs9922_parse(const uint8_t *buf, float *floatval,
1074 struct sr_datafeed_analog *analog, void *info);
1075 SR_PRIV void sr_fs9922_z1_diode(struct sr_datafeed_analog *analog, void *info);
1077 /*--- hardware/dmm/fs9721.c -------------------------------------------------*/
1079 #define FS9721_PACKET_SIZE 14
1081 struct fs9721_info {
1082 gboolean is_ac, is_dc, is_auto, is_rs232, is_micro, is_nano, is_kilo;
1083 gboolean is_diode, is_milli, is_percent, is_mega, is_beep, is_farad;
1084 gboolean is_ohm, is_rel, is_hold, is_ampere, is_volt, is_hz, is_bat;
1085 gboolean is_c2c1_11, is_c2c1_10, is_c2c1_01, is_c2c1_00, is_sign;
1088 SR_PRIV gboolean sr_fs9721_packet_valid(const uint8_t *buf);
1089 SR_PRIV int sr_fs9721_parse(const uint8_t *buf, float *floatval,
1090 struct sr_datafeed_analog *analog, void *info);
1091 SR_PRIV void sr_fs9721_00_temp_c(struct sr_datafeed_analog *analog, void *info);
1092 SR_PRIV void sr_fs9721_01_temp_c(struct sr_datafeed_analog *analog, void *info);
1093 SR_PRIV void sr_fs9721_10_temp_c(struct sr_datafeed_analog *analog, void *info);
1094 SR_PRIV void sr_fs9721_01_10_temp_f_c(struct sr_datafeed_analog *analog, void *info);
1095 SR_PRIV void sr_fs9721_max_c_min(struct sr_datafeed_analog *analog, void *info);
1097 /*--- hardware/dmm/m2110.c --------------------------------------------------*/
1099 #define BBCGM_M2110_PACKET_SIZE 9
1101 SR_PRIV gboolean sr_m2110_packet_valid(const uint8_t *buf);
1102 SR_PRIV int sr_m2110_parse(const uint8_t *buf, float *floatval,
1103 struct sr_datafeed_analog *analog, void *info);
1105 /*--- hardware/dmm/metex14.c ------------------------------------------------*/
1107 #define METEX14_PACKET_SIZE 14
1109 struct metex14_info {
1110 gboolean is_ac, is_dc, is_resistance, is_capacity, is_temperature;
1111 gboolean is_diode, is_frequency, is_ampere, is_volt, is_farad;
1112 gboolean is_hertz, is_ohm, is_celsius, is_pico, is_nano, is_micro;
1113 gboolean is_milli, is_kilo, is_mega, is_gain, is_decibel, is_hfe;
1114 gboolean is_unitless, is_logic;
1117 #ifdef HAVE_LIBSERIALPORT
1118 SR_PRIV int sr_metex14_packet_request(struct sr_serial_dev_inst *serial);
1120 SR_PRIV gboolean sr_metex14_packet_valid(const uint8_t *buf);
1121 SR_PRIV int sr_metex14_parse(const uint8_t *buf, float *floatval,
1122 struct sr_datafeed_analog *analog, void *info);
1124 /*--- hardware/dmm/rs9lcd.c -------------------------------------------------*/
1126 #define RS9LCD_PACKET_SIZE 9
1128 /* Dummy info struct. The parser does not use it. */
1129 struct rs9lcd_info { int dummy; };
1131 SR_PRIV gboolean sr_rs9lcd_packet_valid(const uint8_t *buf);
1132 SR_PRIV int sr_rs9lcd_parse(const uint8_t *buf, float *floatval,
1133 struct sr_datafeed_analog *analog, void *info);
1135 /*--- hardware/dmm/bm25x.c --------------------------------------------------*/
1137 #define BRYMEN_BM25X_PACKET_SIZE 15
1139 /* Dummy info struct. The parser does not use it. */
1140 struct bm25x_info { int dummy; };
1142 SR_PRIV gboolean sr_brymen_bm25x_packet_valid(const uint8_t *buf);
1143 SR_PRIV int sr_brymen_bm25x_parse(const uint8_t *buf, float *floatval,
1144 struct sr_datafeed_analog *analog, void *info);
1146 /*--- hardware/dmm/ut71x.c --------------------------------------------------*/
1148 #define UT71X_PACKET_SIZE 11
1151 gboolean is_voltage, is_resistance, is_capacitance, is_temperature;
1152 gboolean is_celsius, is_fahrenheit, is_current, is_continuity;
1153 gboolean is_diode, is_frequency, is_duty_cycle, is_dc, is_ac;
1154 gboolean is_auto, is_manual, is_sign, is_power, is_loop_current;
1157 SR_PRIV gboolean sr_ut71x_packet_valid(const uint8_t *buf);
1158 SR_PRIV int sr_ut71x_parse(const uint8_t *buf, float *floatval,
1159 struct sr_datafeed_analog *analog, void *info);
1161 /*--- hardware/dmm/vc870.c --------------------------------------------------*/
1163 #define VC870_PACKET_SIZE 23
1166 gboolean is_voltage, is_dc, is_ac, is_temperature, is_resistance;
1167 gboolean is_continuity, is_capacitance, is_diode, is_loop_current;
1168 gboolean is_current, is_micro, is_milli, is_power;
1169 gboolean is_power_factor_freq, is_power_apparent_power, is_v_a_eff_value;
1170 gboolean is_sign2, is_sign1, is_batt, is_ol1, is_max, is_min;
1171 gboolean is_maxmin, is_rel, is_ol2, is_open, is_manu, is_hold;
1172 gboolean is_light, is_usb, is_warning, is_auto_power, is_misplug_warn;
1173 gboolean is_lo, is_hi, is_open2;
1175 gboolean is_frequency, is_dual_display, is_auto, is_rms;
1178 SR_PRIV gboolean sr_vc870_packet_valid(const uint8_t *buf);
1179 SR_PRIV int sr_vc870_parse(const uint8_t *buf, float *floatval,
1180 struct sr_datafeed_analog *analog, void *info);
1182 /*--- hardware/lcr/es51919.c ------------------------------------------------*/
1184 SR_PRIV void es51919_serial_clean(void *priv);
1185 SR_PRIV struct sr_dev_inst *es51919_serial_scan(GSList *options,
1188 SR_PRIV int es51919_serial_config_get(uint32_t key, GVariant **data,
1189 const struct sr_dev_inst *sdi,
1190 const struct sr_channel_group *cg);
1191 SR_PRIV int es51919_serial_config_set(uint32_t key, GVariant *data,
1192 const struct sr_dev_inst *sdi,
1193 const struct sr_channel_group *cg);
1194 SR_PRIV int es51919_serial_config_list(uint32_t key, GVariant **data,
1195 const struct sr_dev_inst *sdi,
1196 const struct sr_channel_group *cg);
1197 SR_PRIV int es51919_serial_acquisition_start(const struct sr_dev_inst *sdi,
1199 SR_PRIV int es51919_serial_acquisition_stop(struct sr_dev_inst *sdi,
1202 /*--- hardware/dmm/ut372.c --------------------------------------------------*/
1204 #define UT372_PACKET_SIZE 27
1210 SR_PRIV gboolean sr_ut372_packet_valid(const uint8_t *buf);
1211 SR_PRIV int sr_ut372_parse(const uint8_t *buf, float *floatval,
1212 struct sr_datafeed_analog *analog, void *info);