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 * The name of the file that the data should be written to.
374 const char *filename;
377 * A generic pointer which can be used by the module to keep internal
378 * state between calls into its callback functions.
380 * For example, the module might store a pointer to a chunk of output
381 * there, and only flush it when it reaches a certain size.
386 /** Output module driver. */
387 struct sr_output_module {
389 * A unique ID for this output module, suitable for use in command-line
390 * clients, [a-z0-9-]. Must not be NULL.
395 * A unique name for this output module, suitable for use in GUI
396 * clients, can contain UTF-8. Must not be NULL.
401 * A short description of the output module. Must not be NULL.
403 * This can be displayed by frontends, e.g. when selecting the output
404 * module for saving a file.
409 * A NULL terminated array of strings containing a list of file name
410 * extensions typical for the input file format, or NULL if there is
411 * no typical extension for this file format.
413 const char *const *exts;
416 * Bitfield containing flags that describe certain properties
417 * this output module may or may not have.
418 * @see sr_output_flags
420 const uint64_t flags;
423 * Returns a NULL-terminated list of options this module can take.
424 * Can be NULL, if the module has no options.
426 const struct sr_option *(*options) (void);
429 * This function is called once, at the beginning of an output stream.
431 * The device struct will be available in the output struct passed in,
432 * as well as the param field -- which may be NULL or an empty string,
433 * if no parameter was passed.
435 * The module can use this to initialize itself, create a struct for
436 * keeping state and storing it in the <code>internal</code> field.
438 * @param o Pointer to the respective 'struct sr_output'.
440 * @retval SR_OK Success
441 * @retval other Negative error code.
443 int (*init) (struct sr_output *o, GHashTable *options);
446 * This function is passed a copy of every packet in the data feed.
447 * Any output generated by the output module in response to the
448 * packet should be returned in a newly allocated GString
449 * <code>out</code>, which will be freed by the caller.
451 * Packets not of interest to the output module can just be ignored,
452 * and the <code>out</code> parameter set to NULL.
454 * @param o Pointer to the respective 'struct sr_output'.
455 * @param sdi The device instance that generated the packet.
456 * @param packet The complete packet.
457 * @param out A pointer where a GString * should be stored if
458 * the module generates output, or NULL if not.
460 * @retval SR_OK Success
461 * @retval other Negative error code.
463 int (*receive) (const struct sr_output *o,
464 const struct sr_datafeed_packet *packet, GString **out);
467 * This function is called after the caller is finished using
468 * the output module, and can be used to free any internal
469 * resources the module may keep.
471 * @retval SR_OK Success
472 * @retval other Negative error code.
474 int (*cleanup) (struct sr_output *o);
477 /** Transform module instance. */
478 struct sr_transform {
479 /** A pointer to this transform's module. */
480 const struct sr_transform_module *module;
483 * The device for which this transform module is used. This
484 * can be used by the module to find out channel names and numbers.
486 const struct sr_dev_inst *sdi;
489 * A generic pointer which can be used by the module to keep internal
490 * state between calls into its callback functions.
495 struct sr_transform_module {
497 * A unique ID for this transform module, suitable for use in
498 * command-line clients, [a-z0-9-]. Must not be NULL.
503 * A unique name for this transform module, suitable for use in GUI
504 * clients, can contain UTF-8. Must not be NULL.
509 * A short description of the transform module. Must not be NULL.
511 * This can be displayed by frontends, e.g. when selecting
512 * which transform module(s) to add.
517 * Returns a NULL-terminated list of options this transform module
518 * can take. Can be NULL, if the transform module has no options.
520 const struct sr_option *(*options) (void);
523 * This function is called once, at the beginning of a stream.
525 * @param t Pointer to the respective 'struct sr_transform'.
526 * @param options Hash table of options for this transform module.
527 * Can be NULL if no options are to be used.
529 * @retval SR_OK Success
530 * @retval other Negative error code.
532 int (*init) (struct sr_transform *t, GHashTable *options);
535 * This function is passed a pointer to every packet in the data feed.
537 * It can either return (in packet_out) a pointer to another packet
538 * (possibly the exact same packet it got as input), or NULL.
540 * @param t Pointer to the respective 'struct sr_transform'.
541 * @param packet_in Pointer to a datafeed packet.
542 * @param packet_out Pointer to the resulting datafeed packet after
543 * this function was run. If NULL, the transform
544 * module intentionally didn't output a new packet.
546 * @retval SR_OK Success
547 * @retval other Negative error code.
549 int (*receive) (const struct sr_transform *t,
550 struct sr_datafeed_packet *packet_in,
551 struct sr_datafeed_packet **packet_out);
554 * This function is called after the caller is finished using
555 * the transform module, and can be used to free any internal
556 * resources the module may keep.
558 * @retval SR_OK Success
559 * @retval other Negative error code.
561 int (*cleanup) (struct sr_transform *t);
564 #ifdef HAVE_LIBUSB_1_0
565 /** USB device instance */
566 struct sr_usb_dev_inst {
569 /** Device address on USB bus */
571 /** libusb device handle */
572 struct libusb_device_handle *devhdl;
576 #ifdef HAVE_LIBSERIALPORT
577 #define SERIAL_PARITY_NONE SP_PARITY_NONE
578 #define SERIAL_PARITY_EVEN SP_PARITY_EVEN
579 #define SERIAL_PARITY_ODD SP_PARITY_ODD
580 struct sr_serial_dev_inst {
581 /** Port name, e.g. '/dev/tty42'. */
583 /** Comm params for serial_set_paramstr(). */
585 /** libserialport port handle */
586 struct sp_port *data;
587 /** libserialport event set */
588 struct sp_event_set *event_set;
589 /** GPollFDs for event polling */
594 struct sr_usbtmc_dev_inst {
599 /* Private driver context. */
601 /** sigrok context */
602 struct sr_context *sr_ctx;
606 /*--- log.c -----------------------------------------------------------------*/
608 SR_PRIV int sr_log(int loglevel, const char *format, ...);
609 SR_PRIV int sr_spew(const char *format, ...);
610 SR_PRIV int sr_dbg(const char *format, ...);
611 SR_PRIV int sr_info(const char *format, ...);
612 SR_PRIV int sr_warn(const char *format, ...);
613 SR_PRIV int sr_err(const char *format, ...);
615 /* Message logging helpers with subsystem-specific prefix string. */
616 #ifndef NO_LOG_WRAPPERS
617 #define sr_log(l, s, args...) sr_log(l, "%s: " s, LOG_PREFIX, ## args)
618 #define sr_spew(s, args...) sr_spew("%s: " s, LOG_PREFIX, ## args)
619 #define sr_dbg(s, args...) sr_dbg("%s: " s, LOG_PREFIX, ## args)
620 #define sr_info(s, args...) sr_info("%s: " s, LOG_PREFIX, ## args)
621 #define sr_warn(s, args...) sr_warn("%s: " s, LOG_PREFIX, ## args)
622 #define sr_err(s, args...) sr_err("%s: " s, LOG_PREFIX, ## args)
625 /*--- device.c --------------------------------------------------------------*/
627 /** Values for the changes argument of sr_dev_driver.config_channel_set. */
629 /** The enabled state of the channel has been changed. */
630 SR_CHANNEL_SET_ENABLED = 1 << 0,
633 SR_PRIV struct sr_channel *sr_channel_new(struct sr_dev_inst *sdi,
634 int index, int type, gboolean enabled, const char *name);
635 SR_PRIV struct sr_channel *sr_next_enabled_channel(const struct sr_dev_inst *sdi,
636 struct sr_channel *cur_channel);
638 /** Device instance data */
640 /** Device driver. */
641 struct sr_dev_driver *driver;
642 /** Device instance status. SR_ST_NOT_FOUND, etc. */
644 /** Device instance type. SR_INST_USB, etc. */
646 /** Device vendor. */
650 /** Device version. */
652 /** Serial number. */
654 /** Connection string to uniquely identify devices. */
656 /** List of channels. */
658 /** List of sr_channel_group structs */
659 GSList *channel_groups;
660 /** Device instance connection data (used?) */
662 /** Device instance private data (used?) */
664 /** Session to which this device is currently assigned. */
665 struct sr_session *session;
668 /* Generic device instances */
669 SR_PRIV void sr_dev_inst_free(struct sr_dev_inst *sdi);
671 #ifdef HAVE_LIBUSB_1_0
672 /* USB-specific instances */
673 SR_PRIV struct sr_usb_dev_inst *sr_usb_dev_inst_new(uint8_t bus,
674 uint8_t address, struct libusb_device_handle *hdl);
675 SR_PRIV void sr_usb_dev_inst_free(struct sr_usb_dev_inst *usb);
678 #ifdef HAVE_LIBSERIALPORT
679 /* Serial-specific instances */
680 SR_PRIV struct sr_serial_dev_inst *sr_serial_dev_inst_new(const char *port,
681 const char *serialcomm);
682 SR_PRIV void sr_serial_dev_inst_free(struct sr_serial_dev_inst *serial);
685 /* USBTMC-specific instances */
686 SR_PRIV struct sr_usbtmc_dev_inst *sr_usbtmc_dev_inst_new(const char *device);
687 SR_PRIV void sr_usbtmc_dev_inst_free(struct sr_usbtmc_dev_inst *usbtmc);
689 /*--- hwdriver.c ------------------------------------------------------------*/
691 extern SR_PRIV struct sr_dev_driver **drivers_lists[];
693 SR_PRIV const GVariantType *sr_variant_type_get(int datatype);
694 SR_PRIV int sr_variant_type_check(uint32_t key, GVariant *data);
695 SR_PRIV void sr_hw_cleanup_all(const struct sr_context *ctx);
696 SR_PRIV struct sr_config *sr_config_new(uint32_t key, GVariant *data);
697 SR_PRIV void sr_config_free(struct sr_config *src);
698 SR_PRIV int sr_source_remove(int fd);
699 SR_PRIV int sr_source_remove_pollfd(GPollFD *pollfd);
700 SR_PRIV int sr_source_remove_channel(GIOChannel *channel);
701 SR_PRIV int sr_source_add(int fd, int events, int timeout,
702 sr_receive_data_callback cb, void *cb_data);
703 SR_PRIV int sr_source_add_pollfd(GPollFD *pollfd, int timeout,
704 sr_receive_data_callback cb, void *cb_data);
705 SR_PRIV int sr_source_add_channel(GIOChannel *channel, int events, int timeout,
706 sr_receive_data_callback cb, void *cb_data);
708 /*--- session.c -------------------------------------------------------------*/
711 /** Context this session exists in. */
712 struct sr_context *ctx;
713 /** List of struct sr_dev_inst pointers. */
715 /** List of struct sr_dev_inst pointers owned by this session. */
717 /** List of struct datafeed_callback pointers. */
718 GSList *datafeed_callbacks;
720 struct sr_trigger *trigger;
724 unsigned int num_sources;
727 * Both "sources" and "pollfds" are of the same size and contain pairs
728 * of descriptor and callback function. We can not embed the GPollFD
729 * into the source struct since we want to be able to pass the array
730 * of all poll descriptors to g_poll().
732 struct source *sources;
737 * These are our synchronization primitives for stopping the session in
738 * an async fashion. We need to make sure the session is stopped from
739 * within the session thread itself.
741 /** Mutex protecting access to abort_session. */
743 /** Abort current session. See sr_session_stop(). */
744 gboolean abort_session;
747 SR_PRIV int sr_session_send(const struct sr_dev_inst *sdi,
748 const struct sr_datafeed_packet *packet);
749 SR_PRIV int sr_session_stop_sync(struct sr_session *session);
750 SR_PRIV int sr_sessionfile_check(const char *filename);
751 SR_PRIV int sr_packet_copy(const struct sr_datafeed_packet *packet,
752 struct sr_datafeed_packet **copy);
753 SR_PRIV void sr_packet_free(struct sr_datafeed_packet *packet);
755 /*--- analog.c --------------------------------------------------------------*/
757 SR_PRIV int sr_analog_init(struct sr_datafeed_analog2 *analog,
758 struct sr_analog_encoding *encoding,
759 struct sr_analog_meaning *meaning,
760 struct sr_analog_spec *spec,
763 /*--- std.c -----------------------------------------------------------------*/
765 typedef int (*dev_close_callback)(struct sr_dev_inst *sdi);
766 typedef void (*std_dev_clear_callback)(void *priv);
768 SR_PRIV int std_init(struct sr_context *sr_ctx, struct sr_dev_driver *di,
770 #ifdef HAVE_LIBSERIALPORT
771 SR_PRIV int std_serial_dev_open(struct sr_dev_inst *sdi);
772 SR_PRIV int std_serial_dev_acquisition_stop(struct sr_dev_inst *sdi,
773 void *cb_data, dev_close_callback dev_close_fn,
774 struct sr_serial_dev_inst *serial, const char *prefix);
776 SR_PRIV int std_session_send_df_header(const struct sr_dev_inst *sdi,
778 SR_PRIV int std_dev_clear(const struct sr_dev_driver *driver,
779 std_dev_clear_callback clear_private);
780 SR_PRIV int std_serial_dev_close(struct sr_dev_inst *sdi);
782 /*--- strutil.c -------------------------------------------------------------*/
784 SR_PRIV int sr_atol(const char *str, long *ret);
785 SR_PRIV int sr_atoi(const char *str, int *ret);
786 SR_PRIV int sr_atod(const char *str, double *ret);
787 SR_PRIV int sr_atof(const char *str, float *ret);
788 SR_PRIV int sr_atof_ascii(const char *str, float *ret);
790 /*--- soft-trigger.c --------------------------------------------------------*/
792 struct soft_trigger_logic {
793 const struct sr_dev_inst *sdi;
794 const struct sr_trigger *trigger;
798 uint8_t *prev_sample;
799 uint8_t *pre_trigger_buffer;
800 uint8_t *pre_trigger_head;
801 int pre_trigger_size;
802 int pre_trigger_fill;
805 SR_PRIV struct soft_trigger_logic *soft_trigger_logic_new(
806 const struct sr_dev_inst *sdi, struct sr_trigger *trigger,
807 int pre_trigger_samples);
808 SR_PRIV void soft_trigger_logic_free(struct soft_trigger_logic *st);
809 SR_PRIV int soft_trigger_logic_check(struct soft_trigger_logic *st, uint8_t *buf,
810 int len, int *pre_trigger_samples);
812 /*--- hardware/serial.c -----------------------------------------------------*/
814 #ifdef HAVE_LIBSERIALPORT
820 typedef gboolean (*packet_valid_callback)(const uint8_t *buf);
822 SR_PRIV int serial_open(struct sr_serial_dev_inst *serial, int flags);
823 SR_PRIV int serial_close(struct sr_serial_dev_inst *serial);
824 SR_PRIV int serial_flush(struct sr_serial_dev_inst *serial);
825 SR_PRIV int serial_drain(struct sr_serial_dev_inst *serial);
826 SR_PRIV int serial_write_blocking(struct sr_serial_dev_inst *serial,
827 const void *buf, size_t count, unsigned int timeout_ms);
828 SR_PRIV int serial_write_nonblocking(struct sr_serial_dev_inst *serial,
829 const void *buf, size_t count);
830 SR_PRIV int serial_read_blocking(struct sr_serial_dev_inst *serial, void *buf,
831 size_t count, unsigned int timeout_ms);
832 SR_PRIV int serial_read_nonblocking(struct sr_serial_dev_inst *serial, void *buf,
834 SR_PRIV int serial_set_params(struct sr_serial_dev_inst *serial, int baudrate,
835 int bits, int parity, int stopbits, int flowcontrol, int rts, int dtr);
836 SR_PRIV int serial_set_paramstr(struct sr_serial_dev_inst *serial,
837 const char *paramstr);
838 SR_PRIV int serial_readline(struct sr_serial_dev_inst *serial, char **buf,
839 int *buflen, gint64 timeout_ms);
840 SR_PRIV int serial_stream_detect(struct sr_serial_dev_inst *serial,
841 uint8_t *buf, size_t *buflen,
843 packet_valid_callback is_valid,
844 uint64_t timeout_ms, int baudrate);
845 SR_PRIV int sr_serial_extract_options(GSList *options, const char **serial_device,
846 const char **serial_options);
847 SR_PRIV int serial_source_add(struct sr_session *session,
848 struct sr_serial_dev_inst *serial, int events, int timeout,
849 sr_receive_data_callback cb, void *cb_data);
850 SR_PRIV int serial_source_remove(struct sr_session *session,
851 struct sr_serial_dev_inst *serial);
852 SR_PRIV GSList *sr_serial_find_usb(uint16_t vendor_id, uint16_t product_id);
853 SR_PRIV int serial_timeout(struct sr_serial_dev_inst *port, int num_bytes);
856 /*--- hardware/ezusb.c ------------------------------------------------------*/
858 #ifdef HAVE_LIBUSB_1_0
859 SR_PRIV int ezusb_reset(struct libusb_device_handle *hdl, int set_clear);
860 SR_PRIV int ezusb_install_firmware(libusb_device_handle *hdl,
861 const char *filename);
862 SR_PRIV int ezusb_upload_firmware(libusb_device *dev, int configuration,
863 const char *filename);
866 /*--- hardware/usb.c --------------------------------------------------------*/
868 #ifdef HAVE_LIBUSB_1_0
869 SR_PRIV GSList *sr_usb_find(libusb_context *usb_ctx, const char *conn);
870 SR_PRIV int sr_usb_open(libusb_context *usb_ctx, struct sr_usb_dev_inst *usb);
871 SR_PRIV void sr_usb_close(struct sr_usb_dev_inst *usb);
872 SR_PRIV int usb_source_add(struct sr_session *session, struct sr_context *ctx,
873 int timeout, sr_receive_data_callback cb, void *cb_data);
874 SR_PRIV int usb_source_remove(struct sr_session *session, struct sr_context *ctx);
875 SR_PRIV int usb_get_port_path(libusb_device *dev, char *path, int path_len);
879 /*--- modbus/modbus.c -------------------------------------------------------*/
881 struct sr_modbus_dev_inst {
885 GSList *(*scan)(int modbusaddr);
886 int (*dev_inst_new)(void *priv, const char *resource,
887 char **params, const char *serialcomm, int modbusaddr);
888 int (*open)(void *priv);
889 int (*source_add)(struct sr_session *session, void *priv, int events,
890 int timeout, sr_receive_data_callback cb, void *cb_data);
891 int (*source_remove)(struct sr_session *session, void *priv);
892 int (*send)(void *priv, const uint8_t *buffer, int buffer_size);
893 int (*read_begin)(void *priv, uint8_t *function_code);
894 int (*read_data)(void *priv, uint8_t *buf, int maxlen);
895 int (*read_end)(void *priv);
896 int (*close)(void *priv);
897 void (*free)(void *priv);
898 unsigned int read_timeout_ms;
902 SR_PRIV GSList *sr_modbus_scan(struct drv_context *drvc, GSList *options,
903 struct sr_dev_inst *(*probe_device)(struct sr_modbus_dev_inst *modbus));
904 SR_PRIV struct sr_modbus_dev_inst *modbus_dev_inst_new(const char *resource,
905 const char *serialcomm, int modbusaddr);
906 SR_PRIV int sr_modbus_open(struct sr_modbus_dev_inst *modbus);
907 SR_PRIV int sr_modbus_source_add(struct sr_session *session,
908 struct sr_modbus_dev_inst *modbus, int events, int timeout,
909 sr_receive_data_callback cb, void *cb_data);
910 SR_PRIV int sr_modbus_source_remove(struct sr_session *session,
911 struct sr_modbus_dev_inst *modbus);
912 SR_PRIV int sr_modbus_request(struct sr_modbus_dev_inst *modbus,
913 uint8_t *request, int request_size);
914 SR_PRIV int sr_modbus_reply(struct sr_modbus_dev_inst *modbus,
915 uint8_t *reply, int reply_size);
916 SR_PRIV int sr_modbus_request_reply(struct sr_modbus_dev_inst *modbus,
917 uint8_t *request, int request_size,
918 uint8_t *reply, int reply_size);
919 SR_PRIV int sr_modbus_read_coils(struct sr_modbus_dev_inst *modbus,
920 int address, int nb_coils, uint8_t *coils);
921 SR_PRIV int sr_modbus_read_holding_registers(struct sr_modbus_dev_inst *modbus,
922 int address, int nb_registers,
923 uint16_t *registers);
924 SR_PRIV int sr_modbus_write_coil(struct sr_modbus_dev_inst *modbus,
925 int address, int value);
926 SR_PRIV int sr_modbus_write_multiple_registers(struct sr_modbus_dev_inst*modbus,
927 int address, int nb_registers,
928 uint16_t *registers);
929 SR_PRIV int sr_modbus_close(struct sr_modbus_dev_inst *modbus);
930 SR_PRIV void sr_modbus_free(struct sr_modbus_dev_inst *modbus);
932 /*--- hardware/dmm/es519xx.c ------------------------------------------------*/
935 * All 11-byte es519xx chips repeat each block twice for each conversion cycle
936 * so always read 2 blocks at a time.
938 #define ES519XX_11B_PACKET_SIZE (11 * 2)
939 #define ES519XX_14B_PACKET_SIZE 14
941 struct es519xx_info {
942 gboolean is_judge, is_voltage, is_auto, is_micro, is_current;
943 gboolean is_milli, is_resistance, is_continuity, is_diode;
944 gboolean is_frequency, is_rpm, is_capacitance, is_duty_cycle;
945 gboolean is_temperature, is_celsius, is_fahrenheit;
946 gboolean is_adp0, is_adp1, is_adp2, is_adp3;
947 gboolean is_sign, is_batt, is_ol, is_pmax, is_pmin, is_apo;
948 gboolean is_dc, is_ac, is_vahz, is_min, is_max, is_rel, is_hold;
949 gboolean is_digit4, is_ul, is_vasel, is_vbar, is_lpf1, is_lpf0, is_rmr;
952 gboolean alt_functions, fivedigits, clampmeter, selectable_lpf;
955 SR_PRIV gboolean sr_es519xx_2400_11b_packet_valid(const uint8_t *buf);
956 SR_PRIV int sr_es519xx_2400_11b_parse(const uint8_t *buf, float *floatval,
957 struct sr_datafeed_analog *analog, void *info);
958 SR_PRIV gboolean sr_es519xx_2400_11b_altfn_packet_valid(const uint8_t *buf);
959 SR_PRIV int sr_es519xx_2400_11b_altfn_parse(const uint8_t *buf,
960 float *floatval, struct sr_datafeed_analog *analog, void *info);
961 SR_PRIV gboolean sr_es519xx_19200_11b_5digits_packet_valid(const uint8_t *buf);
962 SR_PRIV int sr_es519xx_19200_11b_5digits_parse(const uint8_t *buf,
963 float *floatval, struct sr_datafeed_analog *analog, void *info);
964 SR_PRIV gboolean sr_es519xx_19200_11b_clamp_packet_valid(const uint8_t *buf);
965 SR_PRIV int sr_es519xx_19200_11b_clamp_parse(const uint8_t *buf,
966 float *floatval, struct sr_datafeed_analog *analog, void *info);
967 SR_PRIV gboolean sr_es519xx_19200_11b_packet_valid(const uint8_t *buf);
968 SR_PRIV int sr_es519xx_19200_11b_parse(const uint8_t *buf, float *floatval,
969 struct sr_datafeed_analog *analog, void *info);
970 SR_PRIV gboolean sr_es519xx_19200_14b_packet_valid(const uint8_t *buf);
971 SR_PRIV int sr_es519xx_19200_14b_parse(const uint8_t *buf, float *floatval,
972 struct sr_datafeed_analog *analog, void *info);
973 SR_PRIV gboolean sr_es519xx_19200_14b_sel_lpf_packet_valid(const uint8_t *buf);
974 SR_PRIV int sr_es519xx_19200_14b_sel_lpf_parse(const uint8_t *buf,
975 float *floatval, struct sr_datafeed_analog *analog, void *info);
977 /*--- hardware/dmm/fs9922.c -------------------------------------------------*/
979 #define FS9922_PACKET_SIZE 14
982 gboolean is_auto, is_dc, is_ac, is_rel, is_hold, is_bpn, is_z1, is_z2;
983 gboolean is_max, is_min, is_apo, is_bat, is_nano, is_z3, is_micro;
984 gboolean is_milli, is_kilo, is_mega, is_beep, is_diode, is_percent;
985 gboolean is_z4, is_volt, is_ampere, is_ohm, is_hfe, is_hertz, is_farad;
986 gboolean is_celsius, is_fahrenheit;
987 int bargraph_sign, bargraph_value;
990 SR_PRIV gboolean sr_fs9922_packet_valid(const uint8_t *buf);
991 SR_PRIV int sr_fs9922_parse(const uint8_t *buf, float *floatval,
992 struct sr_datafeed_analog *analog, void *info);
993 SR_PRIV void sr_fs9922_z1_diode(struct sr_datafeed_analog *analog, void *info);
995 /*--- hardware/dmm/fs9721.c -------------------------------------------------*/
997 #define FS9721_PACKET_SIZE 14
1000 gboolean is_ac, is_dc, is_auto, is_rs232, is_micro, is_nano, is_kilo;
1001 gboolean is_diode, is_milli, is_percent, is_mega, is_beep, is_farad;
1002 gboolean is_ohm, is_rel, is_hold, is_ampere, is_volt, is_hz, is_bat;
1003 gboolean is_c2c1_11, is_c2c1_10, is_c2c1_01, is_c2c1_00, is_sign;
1006 SR_PRIV gboolean sr_fs9721_packet_valid(const uint8_t *buf);
1007 SR_PRIV int sr_fs9721_parse(const uint8_t *buf, float *floatval,
1008 struct sr_datafeed_analog *analog, void *info);
1009 SR_PRIV void sr_fs9721_00_temp_c(struct sr_datafeed_analog *analog, void *info);
1010 SR_PRIV void sr_fs9721_01_temp_c(struct sr_datafeed_analog *analog, void *info);
1011 SR_PRIV void sr_fs9721_10_temp_c(struct sr_datafeed_analog *analog, void *info);
1012 SR_PRIV void sr_fs9721_01_10_temp_f_c(struct sr_datafeed_analog *analog, void *info);
1013 SR_PRIV void sr_fs9721_max_c_min(struct sr_datafeed_analog *analog, void *info);
1015 /*--- hardware/dmm/m2110.c --------------------------------------------------*/
1017 #define BBCGM_M2110_PACKET_SIZE 9
1019 SR_PRIV gboolean sr_m2110_packet_valid(const uint8_t *buf);
1020 SR_PRIV int sr_m2110_parse(const uint8_t *buf, float *floatval,
1021 struct sr_datafeed_analog *analog, void *info);
1023 /*--- hardware/dmm/metex14.c ------------------------------------------------*/
1025 #define METEX14_PACKET_SIZE 14
1027 struct metex14_info {
1028 gboolean is_ac, is_dc, is_resistance, is_capacity, is_temperature;
1029 gboolean is_diode, is_frequency, is_ampere, is_volt, is_farad;
1030 gboolean is_hertz, is_ohm, is_celsius, is_pico, is_nano, is_micro;
1031 gboolean is_milli, is_kilo, is_mega, is_gain, is_decibel, is_hfe;
1032 gboolean is_unitless, is_logic;
1035 #ifdef HAVE_LIBSERIALPORT
1036 SR_PRIV int sr_metex14_packet_request(struct sr_serial_dev_inst *serial);
1038 SR_PRIV gboolean sr_metex14_packet_valid(const uint8_t *buf);
1039 SR_PRIV int sr_metex14_parse(const uint8_t *buf, float *floatval,
1040 struct sr_datafeed_analog *analog, void *info);
1042 /*--- hardware/dmm/rs9lcd.c -------------------------------------------------*/
1044 #define RS9LCD_PACKET_SIZE 9
1046 /* Dummy info struct. The parser does not use it. */
1047 struct rs9lcd_info { int dummy; };
1049 SR_PRIV gboolean sr_rs9lcd_packet_valid(const uint8_t *buf);
1050 SR_PRIV int sr_rs9lcd_parse(const uint8_t *buf, float *floatval,
1051 struct sr_datafeed_analog *analog, void *info);
1053 /*--- hardware/dmm/bm25x.c --------------------------------------------------*/
1055 #define BRYMEN_BM25X_PACKET_SIZE 15
1057 /* Dummy info struct. The parser does not use it. */
1058 struct bm25x_info { int dummy; };
1060 SR_PRIV gboolean sr_brymen_bm25x_packet_valid(const uint8_t *buf);
1061 SR_PRIV int sr_brymen_bm25x_parse(const uint8_t *buf, float *floatval,
1062 struct sr_datafeed_analog *analog, void *info);
1064 /*--- hardware/dmm/ut71x.c --------------------------------------------------*/
1066 #define UT71X_PACKET_SIZE 11
1069 gboolean is_voltage, is_resistance, is_capacitance, is_temperature;
1070 gboolean is_celsius, is_fahrenheit, is_current, is_continuity;
1071 gboolean is_diode, is_frequency, is_duty_cycle, is_dc, is_ac;
1072 gboolean is_auto, is_manual, is_sign, is_power, is_loop_current;
1075 SR_PRIV gboolean sr_ut71x_packet_valid(const uint8_t *buf);
1076 SR_PRIV int sr_ut71x_parse(const uint8_t *buf, float *floatval,
1077 struct sr_datafeed_analog *analog, void *info);
1079 /*--- hardware/dmm/vc870.c --------------------------------------------------*/
1081 #define VC870_PACKET_SIZE 23
1084 gboolean is_voltage, is_dc, is_ac, is_temperature, is_resistance;
1085 gboolean is_continuity, is_capacitance, is_diode, is_loop_current;
1086 gboolean is_current, is_micro, is_milli, is_power;
1087 gboolean is_power_factor_freq, is_power_apparent_power, is_v_a_eff_value;
1088 gboolean is_sign2, is_sign1, is_batt, is_ol1, is_max, is_min;
1089 gboolean is_maxmin, is_rel, is_ol2, is_open, is_manu, is_hold;
1090 gboolean is_light, is_usb, is_warning, is_auto_power, is_misplug_warn;
1091 gboolean is_lo, is_hi, is_open2;
1093 gboolean is_frequency, is_dual_display, is_auto, is_rms;
1096 SR_PRIV gboolean sr_vc870_packet_valid(const uint8_t *buf);
1097 SR_PRIV int sr_vc870_parse(const uint8_t *buf, float *floatval,
1098 struct sr_datafeed_analog *analog, void *info);
1100 /*--- hardware/lcr/es51919.c ------------------------------------------------*/
1102 SR_PRIV void es51919_serial_clean(void *priv);
1103 SR_PRIV struct sr_dev_inst *es51919_serial_scan(GSList *options,
1106 SR_PRIV int es51919_serial_config_get(uint32_t key, GVariant **data,
1107 const struct sr_dev_inst *sdi,
1108 const struct sr_channel_group *cg);
1109 SR_PRIV int es51919_serial_config_set(uint32_t key, GVariant *data,
1110 const struct sr_dev_inst *sdi,
1111 const struct sr_channel_group *cg);
1112 SR_PRIV int es51919_serial_config_list(uint32_t key, GVariant **data,
1113 const struct sr_dev_inst *sdi,
1114 const struct sr_channel_group *cg);
1115 SR_PRIV int es51919_serial_acquisition_start(const struct sr_dev_inst *sdi,
1117 SR_PRIV int es51919_serial_acquisition_stop(struct sr_dev_inst *sdi,
1120 /*--- hardware/dmm/ut372.c --------------------------------------------------*/
1122 #define UT372_PACKET_SIZE 27
1128 SR_PRIV gboolean sr_ut372_packet_valid(const uint8_t *buf);
1129 SR_PRIV int sr_ut372_parse(const uint8_t *buf, float *floatval,
1130 struct sr_datafeed_analog *analog, void *info);