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;
212 /** Input module metadata keys. */
213 enum sr_input_meta_keys {
214 /** The input filename, if there is one. */
215 SR_INPUT_META_FILENAME = 0x01,
216 /** The input file's size in bytes. */
217 SR_INPUT_META_FILESIZE = 0x02,
218 /** The first 128 bytes of the file, provided as a GString. */
219 SR_INPUT_META_HEADER = 0x04,
220 /** The file's MIME type. */
221 SR_INPUT_META_MIMETYPE = 0x08,
223 /** The module cannot identify a file without this metadata. */
224 SR_INPUT_META_REQUIRED = 0x80,
227 /** Input (file) module struct. */
230 * A pointer to this input module's 'struct sr_input_module'.
232 const struct sr_input_module *module;
234 struct sr_dev_inst *sdi;
239 /** Input (file) module driver. */
240 struct sr_input_module {
242 * A unique ID for this input module, suitable for use in command-line
243 * clients, [a-z0-9-]. Must not be NULL.
248 * A unique name for this input module, suitable for use in GUI
249 * clients, can contain UTF-8. Must not be NULL.
254 * A short description of the input module. Must not be NULL.
256 * This can be displayed by frontends, e.g. when selecting the input
257 * module for saving a file.
262 * A NULL terminated array of strings containing a list of file name
263 * extensions typical for the input file format, or NULL if there is
264 * no typical extension for this file format.
266 const char *const *exts;
269 * Zero-terminated list of metadata items the module needs to be able
270 * to identify an input stream. Can be all-zero, if the module cannot
271 * identify streams at all, i.e. has to be forced into use.
273 * Each item is one of:
274 * SR_INPUT_META_FILENAME
275 * SR_INPUT_META_FILESIZE
276 * SR_INPUT_META_HEADER
277 * SR_INPUT_META_MIMETYPE
279 * If the high bit (SR_INPUT META_REQUIRED) is set, the module cannot
280 * identify a stream without the given metadata.
282 const uint8_t metadata[8];
285 * Returns a NULL-terminated list of options this module can take.
286 * Can be NULL, if the module has no options.
288 struct sr_option *(*options) (void);
291 * Check if this input module can load and parse the specified stream.
293 * @param[in] metadata Metadata the module can use to identify the stream.
295 * @retval SR_OK This module knows the format.
296 * @retval SR_ERR_NA There wasn't enough data for this module to
297 * positively identify the format.
298 * @retval SR_ERR_DATA This module knows the format, but cannot handle it.
299 * This means the stream is either corrupt, or indicates a feature
300 * that the module does not support.
301 * @retval SR_ERR This module does not know the format.
303 int (*format_match) (GHashTable *metadata);
306 * Initialize the input module.
308 * @retval SR_OK Success
309 * @retval other Negative error code.
311 int (*init) (struct sr_input *in, GHashTable *options);
314 * Send data to the specified input instance.
316 * When an input module instance is created with sr_input_new(), this
317 * function is used to feed data to the instance.
319 * As enough data gets fed into this function to completely populate
320 * the device instance associated with this input instance, this is
321 * guaranteed to return the moment it's ready. This gives the caller
322 * the chance to examine the device instance, attach session callbacks
325 * @retval SR_OK Success
326 * @retval other Negative error code.
328 int (*receive) (struct sr_input *in, GString *buf);
331 * Signal the input module no more data will come.
333 * This will cause the module to process any data it may have buffered.
334 * The SR_DF_END packet will also typically be sent at this time.
336 int (*end) (struct sr_input *in);
339 * This function is called after the caller is finished using
340 * the input module, and can be used to free any internal
341 * resources the module may keep.
343 * This function is optional.
345 * @retval SR_OK Success
346 * @retval other Negative error code.
348 void (*cleanup) (struct sr_input *in);
351 /** Output module instance. */
353 /** A pointer to this output's module. */
354 const struct sr_output_module *module;
357 * The device for which this output module is creating output. This
358 * can be used by the module to find out channel names and numbers.
360 const struct sr_dev_inst *sdi;
363 * The name of the file that the data should be written to.
365 const char *filename;
368 * A generic pointer which can be used by the module to keep internal
369 * state between calls into its callback functions.
371 * For example, the module might store a pointer to a chunk of output
372 * there, and only flush it when it reaches a certain size.
377 /** Output module driver. */
378 struct sr_output_module {
380 * A unique ID for this output module, suitable for use in command-line
381 * clients, [a-z0-9-]. Must not be NULL.
386 * A unique name for this output module, suitable for use in GUI
387 * clients, can contain UTF-8. Must not be NULL.
392 * A short description of the output module. Must not be NULL.
394 * This can be displayed by frontends, e.g. when selecting the output
395 * module for saving a file.
400 * A NULL terminated array of strings containing a list of file name
401 * extensions typical for the input file format, or NULL if there is
402 * no typical extension for this file format.
404 const char *const *exts;
407 * Bitfield containing flags that describe certain properties
408 * this output module may or may not have.
409 * @see sr_output_flags
411 const uint64_t flags;
414 * Returns a NULL-terminated list of options this module can take.
415 * Can be NULL, if the module has no options.
417 const struct sr_option *(*options) (void);
420 * This function is called once, at the beginning of an output stream.
422 * The device struct will be available in the output struct passed in,
423 * as well as the param field -- which may be NULL or an empty string,
424 * if no parameter was passed.
426 * The module can use this to initialize itself, create a struct for
427 * keeping state and storing it in the <code>internal</code> field.
429 * @param o Pointer to the respective 'struct sr_output'.
431 * @retval SR_OK Success
432 * @retval other Negative error code.
434 int (*init) (struct sr_output *o, GHashTable *options);
437 * This function is passed a copy of every packet in the data feed.
438 * Any output generated by the output module in response to the
439 * packet should be returned in a newly allocated GString
440 * <code>out</code>, which will be freed by the caller.
442 * Packets not of interest to the output module can just be ignored,
443 * and the <code>out</code> parameter set to NULL.
445 * @param o Pointer to the respective 'struct sr_output'.
446 * @param sdi The device instance that generated the packet.
447 * @param packet The complete packet.
448 * @param out A pointer where a GString * should be stored if
449 * the module generates output, or NULL if not.
451 * @retval SR_OK Success
452 * @retval other Negative error code.
454 int (*receive) (const struct sr_output *o,
455 const struct sr_datafeed_packet *packet, GString **out);
458 * This function is called after the caller is finished using
459 * the output module, and can be used to free any internal
460 * resources the module may keep.
462 * @retval SR_OK Success
463 * @retval other Negative error code.
465 int (*cleanup) (struct sr_output *o);
468 /** Transform module instance. */
469 struct sr_transform {
470 /** A pointer to this transform's module. */
471 const struct sr_transform_module *module;
474 * The device for which this transform module is used. This
475 * can be used by the module to find out channel names and numbers.
477 const struct sr_dev_inst *sdi;
480 * A generic pointer which can be used by the module to keep internal
481 * state between calls into its callback functions.
486 struct sr_transform_module {
488 * A unique ID for this transform module, suitable for use in
489 * command-line clients, [a-z0-9-]. Must not be NULL.
494 * A unique name for this transform module, suitable for use in GUI
495 * clients, can contain UTF-8. Must not be NULL.
500 * A short description of the transform module. Must not be NULL.
502 * This can be displayed by frontends, e.g. when selecting
503 * which transform module(s) to add.
508 * Returns a NULL-terminated list of options this transform module
509 * can take. Can be NULL, if the transform module has no options.
511 const struct sr_option *(*options) (void);
514 * This function is called once, at the beginning of a stream.
516 * @param t Pointer to the respective 'struct sr_transform'.
517 * @param options Hash table of options for this transform module.
518 * Can be NULL if no options are to be used.
520 * @retval SR_OK Success
521 * @retval other Negative error code.
523 int (*init) (struct sr_transform *t, GHashTable *options);
526 * This function is passed a pointer to every packet in the data feed.
528 * It can either return (in packet_out) a pointer to another packet
529 * (possibly the exact same packet it got as input), or NULL.
531 * @param t Pointer to the respective 'struct sr_transform'.
532 * @param packet_in Pointer to a datafeed packet.
533 * @param packet_out Pointer to the resulting datafeed packet after
534 * this function was run. If NULL, the transform
535 * module intentionally didn't output a new packet.
537 * @retval SR_OK Success
538 * @retval other Negative error code.
540 int (*receive) (const struct sr_transform *t,
541 struct sr_datafeed_packet *packet_in,
542 struct sr_datafeed_packet **packet_out);
545 * This function is called after the caller is finished using
546 * the transform module, and can be used to free any internal
547 * resources the module may keep.
549 * @retval SR_OK Success
550 * @retval other Negative error code.
552 int (*cleanup) (struct sr_transform *t);
555 #ifdef HAVE_LIBUSB_1_0
556 /** USB device instance */
557 struct sr_usb_dev_inst {
560 /** Device address on USB bus */
562 /** libusb device handle */
563 struct libusb_device_handle *devhdl;
567 #ifdef HAVE_LIBSERIALPORT
568 #define SERIAL_PARITY_NONE SP_PARITY_NONE
569 #define SERIAL_PARITY_EVEN SP_PARITY_EVEN
570 #define SERIAL_PARITY_ODD SP_PARITY_ODD
571 struct sr_serial_dev_inst {
572 /** Port name, e.g. '/dev/tty42'. */
574 /** Comm params for serial_set_paramstr(). */
576 /** libserialport port handle */
577 struct sp_port *data;
578 /** libserialport event set */
579 struct sp_event_set *event_set;
580 /** GPollFDs for event polling */
585 struct sr_usbtmc_dev_inst {
590 /* Private driver context. */
592 /** sigrok context */
593 struct sr_context *sr_ctx;
597 /*--- log.c -----------------------------------------------------------------*/
599 SR_PRIV int sr_log(int loglevel, const char *format, ...);
600 SR_PRIV int sr_spew(const char *format, ...);
601 SR_PRIV int sr_dbg(const char *format, ...);
602 SR_PRIV int sr_info(const char *format, ...);
603 SR_PRIV int sr_warn(const char *format, ...);
604 SR_PRIV int sr_err(const char *format, ...);
606 /* Message logging helpers with subsystem-specific prefix string. */
607 #ifndef NO_LOG_WRAPPERS
608 #define sr_log(l, s, args...) sr_log(l, "%s: " s, LOG_PREFIX, ## args)
609 #define sr_spew(s, args...) sr_spew("%s: " s, LOG_PREFIX, ## args)
610 #define sr_dbg(s, args...) sr_dbg("%s: " s, LOG_PREFIX, ## args)
611 #define sr_info(s, args...) sr_info("%s: " s, LOG_PREFIX, ## args)
612 #define sr_warn(s, args...) sr_warn("%s: " s, LOG_PREFIX, ## args)
613 #define sr_err(s, args...) sr_err("%s: " s, LOG_PREFIX, ## args)
616 /*--- device.c --------------------------------------------------------------*/
618 /** Values for the changes argument of sr_dev_driver.config_channel_set. */
620 /** The enabled state of the channel has been changed. */
621 SR_CHANNEL_SET_ENABLED = 1 << 0,
624 SR_PRIV struct sr_channel *sr_channel_new(struct sr_dev_inst *sdi,
625 int index, int type, gboolean enabled, const char *name);
626 SR_PRIV struct sr_channel *sr_next_enabled_channel(const struct sr_dev_inst *sdi,
627 struct sr_channel *cur_channel);
629 /** Device instance data */
631 /** Device driver. */
632 struct sr_dev_driver *driver;
633 /** Device instance status. SR_ST_NOT_FOUND, etc. */
635 /** Device instance type. SR_INST_USB, etc. */
637 /** Device vendor. */
641 /** Device version. */
643 /** Serial number. */
645 /** Connection string to uniquely identify devices. */
647 /** List of channels. */
649 /** List of sr_channel_group structs */
650 GSList *channel_groups;
651 /** Device instance connection data (used?) */
653 /** Device instance private data (used?) */
655 /** Session to which this device is currently assigned. */
656 struct sr_session *session;
659 /* Generic device instances */
660 SR_PRIV void sr_dev_inst_free(struct sr_dev_inst *sdi);
662 #ifdef HAVE_LIBUSB_1_0
663 /* USB-specific instances */
664 SR_PRIV struct sr_usb_dev_inst *sr_usb_dev_inst_new(uint8_t bus,
665 uint8_t address, struct libusb_device_handle *hdl);
666 SR_PRIV void sr_usb_dev_inst_free(struct sr_usb_dev_inst *usb);
669 #ifdef HAVE_LIBSERIALPORT
670 /* Serial-specific instances */
671 SR_PRIV struct sr_serial_dev_inst *sr_serial_dev_inst_new(const char *port,
672 const char *serialcomm);
673 SR_PRIV void sr_serial_dev_inst_free(struct sr_serial_dev_inst *serial);
676 /* USBTMC-specific instances */
677 SR_PRIV struct sr_usbtmc_dev_inst *sr_usbtmc_dev_inst_new(const char *device);
678 SR_PRIV void sr_usbtmc_dev_inst_free(struct sr_usbtmc_dev_inst *usbtmc);
680 /*--- hwdriver.c ------------------------------------------------------------*/
682 extern SR_PRIV struct sr_dev_driver **drivers_lists[];
684 SR_PRIV const GVariantType *sr_variant_type_get(int datatype);
685 SR_PRIV int sr_variant_type_check(uint32_t key, GVariant *data);
686 SR_PRIV void sr_hw_cleanup_all(const struct sr_context *ctx);
687 SR_PRIV struct sr_config *sr_config_new(uint32_t key, GVariant *data);
688 SR_PRIV void sr_config_free(struct sr_config *src);
689 SR_PRIV int sr_source_remove(int fd);
690 SR_PRIV int sr_source_remove_pollfd(GPollFD *pollfd);
691 SR_PRIV int sr_source_remove_channel(GIOChannel *channel);
692 SR_PRIV int sr_source_add(int fd, int events, int timeout,
693 sr_receive_data_callback cb, void *cb_data);
694 SR_PRIV int sr_source_add_pollfd(GPollFD *pollfd, int timeout,
695 sr_receive_data_callback cb, void *cb_data);
696 SR_PRIV int sr_source_add_channel(GIOChannel *channel, int events, int timeout,
697 sr_receive_data_callback cb, void *cb_data);
699 /*--- session.c -------------------------------------------------------------*/
702 /** Context this session exists in. */
703 struct sr_context *ctx;
704 /** List of struct sr_dev_inst pointers. */
706 /** List of struct sr_dev_inst pointers owned by this session. */
708 /** List of struct datafeed_callback pointers. */
709 GSList *datafeed_callbacks;
711 struct sr_trigger *trigger;
716 * Event sources and poll FDs are stored in the same order in the
717 * the sources and pollfds arrays. However, each source may cover
718 * any number of associated poll FDs, so the indices do not match.
720 * We cannot embed the GPollFD into the source struct since we want
721 * to be able to pass the array of all poll descriptors to g_poll().
727 * These are our synchronization primitives for stopping the session in
728 * an async fashion. We need to make sure the session is stopped from
729 * within the session thread itself.
731 /** Mutex protecting access to abort_session. */
733 /** Abort current session. See sr_session_stop(). */
734 gboolean abort_session;
737 SR_PRIV int sr_session_source_add_internal(struct sr_session *session,
738 const GPollFD *pollfds, int num_fds, int timeout,
739 sr_receive_data_callback cb, void *cb_data,
740 gintptr poll_object);
741 SR_PRIV int sr_session_source_remove_internal(struct sr_session *session,
742 gintptr poll_object);
743 SR_PRIV int sr_session_send(const struct sr_dev_inst *sdi,
744 const struct sr_datafeed_packet *packet);
745 SR_PRIV int sr_session_stop_sync(struct sr_session *session);
746 SR_PRIV int sr_sessionfile_check(const char *filename);
747 SR_PRIV int sr_packet_copy(const struct sr_datafeed_packet *packet,
748 struct sr_datafeed_packet **copy);
749 SR_PRIV void sr_packet_free(struct sr_datafeed_packet *packet);
751 /*--- analog.c --------------------------------------------------------------*/
753 SR_PRIV int sr_analog_init(struct sr_datafeed_analog2 *analog,
754 struct sr_analog_encoding *encoding,
755 struct sr_analog_meaning *meaning,
756 struct sr_analog_spec *spec,
759 /*--- std.c -----------------------------------------------------------------*/
761 typedef int (*dev_close_callback)(struct sr_dev_inst *sdi);
762 typedef void (*std_dev_clear_callback)(void *priv);
764 SR_PRIV int std_init(struct sr_context *sr_ctx, struct sr_dev_driver *di,
766 #ifdef HAVE_LIBSERIALPORT
767 SR_PRIV int std_serial_dev_open(struct sr_dev_inst *sdi);
768 SR_PRIV int std_serial_dev_acquisition_stop(struct sr_dev_inst *sdi,
769 void *cb_data, dev_close_callback dev_close_fn,
770 struct sr_serial_dev_inst *serial, const char *prefix);
772 SR_PRIV int std_session_send_df_header(const struct sr_dev_inst *sdi,
774 SR_PRIV int std_dev_clear(const struct sr_dev_driver *driver,
775 std_dev_clear_callback clear_private);
776 SR_PRIV int std_serial_dev_close(struct sr_dev_inst *sdi);
778 /*--- strutil.c -------------------------------------------------------------*/
780 SR_PRIV int sr_atol(const char *str, long *ret);
781 SR_PRIV int sr_atoi(const char *str, int *ret);
782 SR_PRIV int sr_atod(const char *str, double *ret);
783 SR_PRIV int sr_atof(const char *str, float *ret);
784 SR_PRIV int sr_atof_ascii(const char *str, float *ret);
786 /*--- soft-trigger.c --------------------------------------------------------*/
788 struct soft_trigger_logic {
789 const struct sr_dev_inst *sdi;
790 const struct sr_trigger *trigger;
794 uint8_t *prev_sample;
795 uint8_t *pre_trigger_buffer;
796 uint8_t *pre_trigger_head;
797 int pre_trigger_size;
798 int pre_trigger_fill;
801 SR_PRIV struct soft_trigger_logic *soft_trigger_logic_new(
802 const struct sr_dev_inst *sdi, struct sr_trigger *trigger,
803 int pre_trigger_samples);
804 SR_PRIV void soft_trigger_logic_free(struct soft_trigger_logic *st);
805 SR_PRIV int soft_trigger_logic_check(struct soft_trigger_logic *st, uint8_t *buf,
806 int len, int *pre_trigger_samples);
808 /*--- hardware/serial.c -----------------------------------------------------*/
810 #ifdef HAVE_LIBSERIALPORT
816 typedef gboolean (*packet_valid_callback)(const uint8_t *buf);
818 SR_PRIV int serial_open(struct sr_serial_dev_inst *serial, int flags);
819 SR_PRIV int serial_close(struct sr_serial_dev_inst *serial);
820 SR_PRIV int serial_flush(struct sr_serial_dev_inst *serial);
821 SR_PRIV int serial_drain(struct sr_serial_dev_inst *serial);
822 SR_PRIV int serial_write_blocking(struct sr_serial_dev_inst *serial,
823 const void *buf, size_t count, unsigned int timeout_ms);
824 SR_PRIV int serial_write_nonblocking(struct sr_serial_dev_inst *serial,
825 const void *buf, size_t count);
826 SR_PRIV int serial_read_blocking(struct sr_serial_dev_inst *serial, void *buf,
827 size_t count, unsigned int timeout_ms);
828 SR_PRIV int serial_read_nonblocking(struct sr_serial_dev_inst *serial, void *buf,
830 SR_PRIV int serial_set_params(struct sr_serial_dev_inst *serial, int baudrate,
831 int bits, int parity, int stopbits, int flowcontrol, int rts, int dtr);
832 SR_PRIV int serial_set_paramstr(struct sr_serial_dev_inst *serial,
833 const char *paramstr);
834 SR_PRIV int serial_readline(struct sr_serial_dev_inst *serial, char **buf,
835 int *buflen, gint64 timeout_ms);
836 SR_PRIV int serial_stream_detect(struct sr_serial_dev_inst *serial,
837 uint8_t *buf, size_t *buflen,
839 packet_valid_callback is_valid,
840 uint64_t timeout_ms, int baudrate);
841 SR_PRIV int sr_serial_extract_options(GSList *options, const char **serial_device,
842 const char **serial_options);
843 SR_PRIV int serial_source_add(struct sr_session *session,
844 struct sr_serial_dev_inst *serial, int events, int timeout,
845 sr_receive_data_callback cb, void *cb_data);
846 SR_PRIV int serial_source_remove(struct sr_session *session,
847 struct sr_serial_dev_inst *serial);
848 SR_PRIV GSList *sr_serial_find_usb(uint16_t vendor_id, uint16_t product_id);
849 SR_PRIV int serial_timeout(struct sr_serial_dev_inst *port, int num_bytes);
852 /*--- hardware/ezusb.c ------------------------------------------------------*/
854 #ifdef HAVE_LIBUSB_1_0
855 SR_PRIV int ezusb_reset(struct libusb_device_handle *hdl, int set_clear);
856 SR_PRIV int ezusb_install_firmware(libusb_device_handle *hdl,
857 const char *filename);
858 SR_PRIV int ezusb_upload_firmware(libusb_device *dev, int configuration,
859 const char *filename);
862 /*--- hardware/usb.c --------------------------------------------------------*/
864 #ifdef HAVE_LIBUSB_1_0
865 SR_PRIV GSList *sr_usb_find(libusb_context *usb_ctx, const char *conn);
866 SR_PRIV int sr_usb_open(libusb_context *usb_ctx, struct sr_usb_dev_inst *usb);
867 SR_PRIV void sr_usb_close(struct sr_usb_dev_inst *usb);
868 SR_PRIV int usb_source_add(struct sr_session *session, struct sr_context *ctx,
869 int timeout, sr_receive_data_callback cb, void *cb_data);
870 SR_PRIV int usb_source_remove(struct sr_session *session, struct sr_context *ctx);
871 SR_PRIV int usb_get_port_path(libusb_device *dev, char *path, int path_len);
875 /*--- modbus/modbus.c -------------------------------------------------------*/
877 struct sr_modbus_dev_inst {
881 GSList *(*scan)(int modbusaddr);
882 int (*dev_inst_new)(void *priv, const char *resource,
883 char **params, const char *serialcomm, int modbusaddr);
884 int (*open)(void *priv);
885 int (*source_add)(struct sr_session *session, void *priv, int events,
886 int timeout, sr_receive_data_callback cb, void *cb_data);
887 int (*source_remove)(struct sr_session *session, void *priv);
888 int (*send)(void *priv, const uint8_t *buffer, int buffer_size);
889 int (*read_begin)(void *priv, uint8_t *function_code);
890 int (*read_data)(void *priv, uint8_t *buf, int maxlen);
891 int (*read_end)(void *priv);
892 int (*close)(void *priv);
893 void (*free)(void *priv);
894 unsigned int read_timeout_ms;
898 SR_PRIV GSList *sr_modbus_scan(struct drv_context *drvc, GSList *options,
899 struct sr_dev_inst *(*probe_device)(struct sr_modbus_dev_inst *modbus));
900 SR_PRIV struct sr_modbus_dev_inst *modbus_dev_inst_new(const char *resource,
901 const char *serialcomm, int modbusaddr);
902 SR_PRIV int sr_modbus_open(struct sr_modbus_dev_inst *modbus);
903 SR_PRIV int sr_modbus_source_add(struct sr_session *session,
904 struct sr_modbus_dev_inst *modbus, int events, int timeout,
905 sr_receive_data_callback cb, void *cb_data);
906 SR_PRIV int sr_modbus_source_remove(struct sr_session *session,
907 struct sr_modbus_dev_inst *modbus);
908 SR_PRIV int sr_modbus_request(struct sr_modbus_dev_inst *modbus,
909 uint8_t *request, int request_size);
910 SR_PRIV int sr_modbus_reply(struct sr_modbus_dev_inst *modbus,
911 uint8_t *reply, int reply_size);
912 SR_PRIV int sr_modbus_request_reply(struct sr_modbus_dev_inst *modbus,
913 uint8_t *request, int request_size,
914 uint8_t *reply, int reply_size);
915 SR_PRIV int sr_modbus_read_coils(struct sr_modbus_dev_inst *modbus,
916 int address, int nb_coils, uint8_t *coils);
917 SR_PRIV int sr_modbus_read_holding_registers(struct sr_modbus_dev_inst *modbus,
918 int address, int nb_registers,
919 uint16_t *registers);
920 SR_PRIV int sr_modbus_write_coil(struct sr_modbus_dev_inst *modbus,
921 int address, int value);
922 SR_PRIV int sr_modbus_write_multiple_registers(struct sr_modbus_dev_inst*modbus,
923 int address, int nb_registers,
924 uint16_t *registers);
925 SR_PRIV int sr_modbus_close(struct sr_modbus_dev_inst *modbus);
926 SR_PRIV void sr_modbus_free(struct sr_modbus_dev_inst *modbus);
928 /*--- hardware/dmm/es519xx.c ------------------------------------------------*/
931 * All 11-byte es519xx chips repeat each block twice for each conversion cycle
932 * so always read 2 blocks at a time.
934 #define ES519XX_11B_PACKET_SIZE (11 * 2)
935 #define ES519XX_14B_PACKET_SIZE 14
937 struct es519xx_info {
938 gboolean is_judge, is_voltage, is_auto, is_micro, is_current;
939 gboolean is_milli, is_resistance, is_continuity, is_diode;
940 gboolean is_frequency, is_rpm, is_capacitance, is_duty_cycle;
941 gboolean is_temperature, is_celsius, is_fahrenheit;
942 gboolean is_adp0, is_adp1, is_adp2, is_adp3;
943 gboolean is_sign, is_batt, is_ol, is_pmax, is_pmin, is_apo;
944 gboolean is_dc, is_ac, is_vahz, is_min, is_max, is_rel, is_hold;
945 gboolean is_digit4, is_ul, is_vasel, is_vbar, is_lpf1, is_lpf0, is_rmr;
948 gboolean alt_functions, fivedigits, clampmeter, selectable_lpf;
951 SR_PRIV gboolean sr_es519xx_2400_11b_packet_valid(const uint8_t *buf);
952 SR_PRIV int sr_es519xx_2400_11b_parse(const uint8_t *buf, float *floatval,
953 struct sr_datafeed_analog *analog, void *info);
954 SR_PRIV gboolean sr_es519xx_2400_11b_altfn_packet_valid(const uint8_t *buf);
955 SR_PRIV int sr_es519xx_2400_11b_altfn_parse(const uint8_t *buf,
956 float *floatval, struct sr_datafeed_analog *analog, void *info);
957 SR_PRIV gboolean sr_es519xx_19200_11b_5digits_packet_valid(const uint8_t *buf);
958 SR_PRIV int sr_es519xx_19200_11b_5digits_parse(const uint8_t *buf,
959 float *floatval, struct sr_datafeed_analog *analog, void *info);
960 SR_PRIV gboolean sr_es519xx_19200_11b_clamp_packet_valid(const uint8_t *buf);
961 SR_PRIV int sr_es519xx_19200_11b_clamp_parse(const uint8_t *buf,
962 float *floatval, struct sr_datafeed_analog *analog, void *info);
963 SR_PRIV gboolean sr_es519xx_19200_11b_packet_valid(const uint8_t *buf);
964 SR_PRIV int sr_es519xx_19200_11b_parse(const uint8_t *buf, float *floatval,
965 struct sr_datafeed_analog *analog, void *info);
966 SR_PRIV gboolean sr_es519xx_19200_14b_packet_valid(const uint8_t *buf);
967 SR_PRIV int sr_es519xx_19200_14b_parse(const uint8_t *buf, float *floatval,
968 struct sr_datafeed_analog *analog, void *info);
969 SR_PRIV gboolean sr_es519xx_19200_14b_sel_lpf_packet_valid(const uint8_t *buf);
970 SR_PRIV int sr_es519xx_19200_14b_sel_lpf_parse(const uint8_t *buf,
971 float *floatval, struct sr_datafeed_analog *analog, void *info);
973 /*--- hardware/dmm/fs9922.c -------------------------------------------------*/
975 #define FS9922_PACKET_SIZE 14
978 gboolean is_auto, is_dc, is_ac, is_rel, is_hold, is_bpn, is_z1, is_z2;
979 gboolean is_max, is_min, is_apo, is_bat, is_nano, is_z3, is_micro;
980 gboolean is_milli, is_kilo, is_mega, is_beep, is_diode, is_percent;
981 gboolean is_z4, is_volt, is_ampere, is_ohm, is_hfe, is_hertz, is_farad;
982 gboolean is_celsius, is_fahrenheit;
983 int bargraph_sign, bargraph_value;
986 SR_PRIV gboolean sr_fs9922_packet_valid(const uint8_t *buf);
987 SR_PRIV int sr_fs9922_parse(const uint8_t *buf, float *floatval,
988 struct sr_datafeed_analog *analog, void *info);
989 SR_PRIV void sr_fs9922_z1_diode(struct sr_datafeed_analog *analog, void *info);
991 /*--- hardware/dmm/fs9721.c -------------------------------------------------*/
993 #define FS9721_PACKET_SIZE 14
996 gboolean is_ac, is_dc, is_auto, is_rs232, is_micro, is_nano, is_kilo;
997 gboolean is_diode, is_milli, is_percent, is_mega, is_beep, is_farad;
998 gboolean is_ohm, is_rel, is_hold, is_ampere, is_volt, is_hz, is_bat;
999 gboolean is_c2c1_11, is_c2c1_10, is_c2c1_01, is_c2c1_00, is_sign;
1002 SR_PRIV gboolean sr_fs9721_packet_valid(const uint8_t *buf);
1003 SR_PRIV int sr_fs9721_parse(const uint8_t *buf, float *floatval,
1004 struct sr_datafeed_analog *analog, void *info);
1005 SR_PRIV void sr_fs9721_00_temp_c(struct sr_datafeed_analog *analog, void *info);
1006 SR_PRIV void sr_fs9721_01_temp_c(struct sr_datafeed_analog *analog, void *info);
1007 SR_PRIV void sr_fs9721_10_temp_c(struct sr_datafeed_analog *analog, void *info);
1008 SR_PRIV void sr_fs9721_01_10_temp_f_c(struct sr_datafeed_analog *analog, void *info);
1009 SR_PRIV void sr_fs9721_max_c_min(struct sr_datafeed_analog *analog, void *info);
1011 /*--- hardware/dmm/m2110.c --------------------------------------------------*/
1013 #define BBCGM_M2110_PACKET_SIZE 9
1015 SR_PRIV gboolean sr_m2110_packet_valid(const uint8_t *buf);
1016 SR_PRIV int sr_m2110_parse(const uint8_t *buf, float *floatval,
1017 struct sr_datafeed_analog *analog, void *info);
1019 /*--- hardware/dmm/metex14.c ------------------------------------------------*/
1021 #define METEX14_PACKET_SIZE 14
1023 struct metex14_info {
1024 gboolean is_ac, is_dc, is_resistance, is_capacity, is_temperature;
1025 gboolean is_diode, is_frequency, is_ampere, is_volt, is_farad;
1026 gboolean is_hertz, is_ohm, is_celsius, is_pico, is_nano, is_micro;
1027 gboolean is_milli, is_kilo, is_mega, is_gain, is_decibel, is_hfe;
1028 gboolean is_unitless, is_logic;
1031 #ifdef HAVE_LIBSERIALPORT
1032 SR_PRIV int sr_metex14_packet_request(struct sr_serial_dev_inst *serial);
1034 SR_PRIV gboolean sr_metex14_packet_valid(const uint8_t *buf);
1035 SR_PRIV int sr_metex14_parse(const uint8_t *buf, float *floatval,
1036 struct sr_datafeed_analog *analog, void *info);
1038 /*--- hardware/dmm/rs9lcd.c -------------------------------------------------*/
1040 #define RS9LCD_PACKET_SIZE 9
1042 /* Dummy info struct. The parser does not use it. */
1043 struct rs9lcd_info { int dummy; };
1045 SR_PRIV gboolean sr_rs9lcd_packet_valid(const uint8_t *buf);
1046 SR_PRIV int sr_rs9lcd_parse(const uint8_t *buf, float *floatval,
1047 struct sr_datafeed_analog *analog, void *info);
1049 /*--- hardware/dmm/bm25x.c --------------------------------------------------*/
1051 #define BRYMEN_BM25X_PACKET_SIZE 15
1053 /* Dummy info struct. The parser does not use it. */
1054 struct bm25x_info { int dummy; };
1056 SR_PRIV gboolean sr_brymen_bm25x_packet_valid(const uint8_t *buf);
1057 SR_PRIV int sr_brymen_bm25x_parse(const uint8_t *buf, float *floatval,
1058 struct sr_datafeed_analog *analog, void *info);
1060 /*--- hardware/dmm/ut71x.c --------------------------------------------------*/
1062 #define UT71X_PACKET_SIZE 11
1065 gboolean is_voltage, is_resistance, is_capacitance, is_temperature;
1066 gboolean is_celsius, is_fahrenheit, is_current, is_continuity;
1067 gboolean is_diode, is_frequency, is_duty_cycle, is_dc, is_ac;
1068 gboolean is_auto, is_manual, is_sign, is_power, is_loop_current;
1071 SR_PRIV gboolean sr_ut71x_packet_valid(const uint8_t *buf);
1072 SR_PRIV int sr_ut71x_parse(const uint8_t *buf, float *floatval,
1073 struct sr_datafeed_analog *analog, void *info);
1075 /*--- hardware/dmm/vc870.c --------------------------------------------------*/
1077 #define VC870_PACKET_SIZE 23
1080 gboolean is_voltage, is_dc, is_ac, is_temperature, is_resistance;
1081 gboolean is_continuity, is_capacitance, is_diode, is_loop_current;
1082 gboolean is_current, is_micro, is_milli, is_power;
1083 gboolean is_power_factor_freq, is_power_apparent_power, is_v_a_eff_value;
1084 gboolean is_sign2, is_sign1, is_batt, is_ol1, is_max, is_min;
1085 gboolean is_maxmin, is_rel, is_ol2, is_open, is_manu, is_hold;
1086 gboolean is_light, is_usb, is_warning, is_auto_power, is_misplug_warn;
1087 gboolean is_lo, is_hi, is_open2;
1089 gboolean is_frequency, is_dual_display, is_auto, is_rms;
1092 SR_PRIV gboolean sr_vc870_packet_valid(const uint8_t *buf);
1093 SR_PRIV int sr_vc870_parse(const uint8_t *buf, float *floatval,
1094 struct sr_datafeed_analog *analog, void *info);
1096 /*--- hardware/lcr/es51919.c ------------------------------------------------*/
1098 SR_PRIV void es51919_serial_clean(void *priv);
1099 SR_PRIV struct sr_dev_inst *es51919_serial_scan(GSList *options,
1102 SR_PRIV int es51919_serial_config_get(uint32_t key, GVariant **data,
1103 const struct sr_dev_inst *sdi,
1104 const struct sr_channel_group *cg);
1105 SR_PRIV int es51919_serial_config_set(uint32_t key, GVariant *data,
1106 const struct sr_dev_inst *sdi,
1107 const struct sr_channel_group *cg);
1108 SR_PRIV int es51919_serial_config_list(uint32_t key, GVariant **data,
1109 const struct sr_dev_inst *sdi,
1110 const struct sr_channel_group *cg);
1111 SR_PRIV int es51919_serial_acquisition_start(const struct sr_dev_inst *sdi,
1113 SR_PRIV int es51919_serial_acquisition_stop(struct sr_dev_inst *sdi,
1116 /*--- hardware/dmm/ut372.c --------------------------------------------------*/
1118 #define UT372_PACKET_SIZE 27
1124 SR_PRIV gboolean sr_ut372_packet_valid(const uint8_t *buf);
1125 SR_PRIV int sr_ut372_parse(const uint8_t *buf, float *floatval,
1126 struct sr_datafeed_analog *analog, void *info);
1128 /*--- hardware/scale/kern.c -------------------------------------------------*/
1131 gboolean is_gram, is_carat, is_ounce, is_pound, is_troy_ounce;
1132 gboolean is_pennyweight, is_grain, is_tael, is_momme, is_tola;
1133 gboolean is_percentage, is_piece, is_unstable, is_stable, is_error;
1137 SR_PRIV gboolean sr_kern_packet_valid(const uint8_t *buf);
1138 SR_PRIV int sr_kern_parse(const uint8_t *buf, float *floatval,
1139 struct sr_datafeed_analog *analog, void *info);