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
30 #ifdef HAVE_LIBUSB_1_0
33 #ifdef HAVE_LIBSERIALPORT
34 #include <libserialport.h>
43 * libsigrok private header file, only to be used internally.
46 /*--- Macros ----------------------------------------------------------------*/
49 #define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0]))
52 #ifndef ARRAY_AND_SIZE
53 #define ARRAY_AND_SIZE(a) (a), ARRAY_SIZE(a)
57 * Read a 8 bits unsigned integer out of memory.
58 * @param x a pointer to the input memory
59 * @return the corresponding unsigned integer
61 #define R8(x) ((unsigned)((const uint8_t*)(x))[0])
64 * Read a 16 bits big endian unsigned integer out of memory.
65 * @param x a pointer to the input memory
66 * @return the corresponding unsigned integer
68 #define RB16(x) (((unsigned)((const uint8_t*)(x))[0] << 8) | \
69 (unsigned)((const uint8_t*)(x))[1])
72 * Read a 16 bits little endian unsigned integer out of memory.
73 * @param x a pointer to the input memory
74 * @return the corresponding unsigned integer
76 #define RL16(x) (((unsigned)((const uint8_t*)(x))[1] << 8) | \
77 (unsigned)((const uint8_t*)(x))[0])
80 * Read a 16 bits little endian signed integer out of memory.
81 * @param x a pointer to the input memory
82 * @return the corresponding signed integer
84 #define RL16S(x) ((int16_t) \
85 (((unsigned)((const uint8_t*)(x))[1] << 8) | \
86 (unsigned)((const uint8_t*)(x))[0]))
89 * Read a 32 bits big endian unsigned integer out of memory.
90 * @param x a pointer to the input memory
91 * @return the corresponding unsigned integer
93 #define RB32(x) (((unsigned)((const uint8_t*)(x))[0] << 24) | \
94 ((unsigned)((const uint8_t*)(x))[1] << 16) | \
95 ((unsigned)((const uint8_t*)(x))[2] << 8) | \
96 (unsigned)((const uint8_t*)(x))[3])
99 * Read a 32 bits little endian unsigned integer out of memory.
100 * @param x a pointer to the input memory
101 * @return the corresponding unsigned integer
103 #define RL32(x) (((unsigned)((const uint8_t*)(x))[3] << 24) | \
104 ((unsigned)((const uint8_t*)(x))[2] << 16) | \
105 ((unsigned)((const uint8_t*)(x))[1] << 8) | \
106 (unsigned)((const uint8_t*)(x))[0])
109 * Read a 32 bits little endian signed integer out of memory.
110 * @param x a pointer to the input memory
111 * @return the corresponding signed integer
113 #define RL32S(x) ((int32_t) \
114 (((unsigned)((const uint8_t*)(x))[3] << 24) | \
115 ((unsigned)((const uint8_t*)(x))[2] << 16) | \
116 ((unsigned)((const uint8_t*)(x))[1] << 8) | \
117 (unsigned)((const uint8_t*)(x))[0]))
120 * Read a 64 bits big endian unsigned integer out of memory.
121 * @param x a pointer to the input memory
122 * @return the corresponding unsigned integer
124 #define RB64(x) (((uint64_t)((const uint8_t*)(x))[0] << 56) | \
125 ((uint64_t)((const uint8_t*)(x))[1] << 48) | \
126 ((uint64_t)((const uint8_t*)(x))[2] << 40) | \
127 ((uint64_t)((const uint8_t*)(x))[3] << 32) | \
128 ((uint64_t)((const uint8_t*)(x))[4] << 24) | \
129 ((uint64_t)((const uint8_t*)(x))[5] << 16) | \
130 ((uint64_t)((const uint8_t*)(x))[6] << 8) | \
131 (uint64_t)((const uint8_t*)(x))[7])
134 * Read a 32 bits big endian float out of memory.
135 * @param x a pointer to the input memory
136 * @return the corresponding float
138 #define RBFL(x) ((union { uint32_t u; float f; }) { .u = RB32(x) }.f)
141 * Read a 32 bits little endian float out of memory.
142 * @param x a pointer to the input memory
143 * @return the corresponding float
145 #define RLFL(x) ((union { uint32_t u; float f; }) { .u = RL32(x) }.f)
148 * Write a 8 bits unsigned integer to memory.
149 * @param p a pointer to the output memory
150 * @param x the input unsigned integer
152 #define W8(p, x) do { ((uint8_t*)(p))[0] = (uint8_t) (x); } while (0)
155 * Write a 16 bits unsigned integer to memory stored as big endian.
156 * @param p a pointer to the output memory
157 * @param x the input unsigned integer
159 #define WB16(p, x) do { ((uint8_t*)(p))[1] = (uint8_t) (x); \
160 ((uint8_t*)(p))[0] = (uint8_t)((x)>>8); } while (0)
163 * Write a 16 bits unsigned integer to memory stored as little endian.
164 * @param p a pointer to the output memory
165 * @param x the input unsigned integer
167 #define WL16(p, x) do { ((uint8_t*)(p))[0] = (uint8_t) (x); \
168 ((uint8_t*)(p))[1] = (uint8_t)((x)>>8); } while (0)
171 * Write a 32 bits unsigned integer to memory stored as big endian.
172 * @param p a pointer to the output memory
173 * @param x the input unsigned integer
175 #define WB32(p, x) do { ((uint8_t*)(p))[3] = (uint8_t) (x); \
176 ((uint8_t*)(p))[2] = (uint8_t)((x)>>8); \
177 ((uint8_t*)(p))[1] = (uint8_t)((x)>>16); \
178 ((uint8_t*)(p))[0] = (uint8_t)((x)>>24); } while (0)
181 * Write a 32 bits unsigned integer to memory stored as little endian.
182 * @param p a pointer to the output memory
183 * @param x the input unsigned integer
185 #define WL32(p, x) do { ((uint8_t*)(p))[0] = (uint8_t) (x); \
186 ((uint8_t*)(p))[1] = (uint8_t)((x)>>8); \
187 ((uint8_t*)(p))[2] = (uint8_t)((x)>>16); \
188 ((uint8_t*)(p))[3] = (uint8_t)((x)>>24); } while (0)
191 * Write a 32 bits float to memory stored as big endian.
192 * @param p a pointer to the output memory
193 * @param x the input float
195 #define WBFL(p, x) WB32(p, (union { uint32_t u; float f; }) { .f = x }.u)
198 * Write a 32 bits float to memory stored as little endian.
199 * @param p a pointer to the output memory
200 * @param x the input float
202 #define WLFL(p, x) WL32(p, (union { uint32_t u; float f; }) { .f = x }.u)
204 /* Portability fixes for FreeBSD. */
206 #define LIBUSB_CLASS_APPLICATION 0xfe
207 #define libusb_has_capability(x) 0
208 #define libusb_handle_events_timeout_completed(ctx, tv, c) \
209 libusb_handle_events_timeout(ctx, tv)
212 /* Static definitions of structs ending with an all-zero entry are a
213 * problem when compiling with -Wmissing-field-initializers: GCC
214 * suppresses the warning only with { 0 }, clang wants { } */
218 #define ALL_ZERO { 0 }
222 struct sr_dev_driver **driver_list;
223 #ifdef HAVE_LIBUSB_1_0
224 libusb_context *libusb_ctx;
226 sr_resource_open_callback resource_open_cb;
227 sr_resource_close_callback resource_close_cb;
228 sr_resource_read_callback resource_read_cb;
229 void *resource_cb_data;
232 /** Input module metadata keys. */
233 enum sr_input_meta_keys {
234 /** The input filename, if there is one. */
235 SR_INPUT_META_FILENAME = 0x01,
236 /** The input file's size in bytes. */
237 SR_INPUT_META_FILESIZE = 0x02,
238 /** The first 128 bytes of the file, provided as a GString. */
239 SR_INPUT_META_HEADER = 0x04,
241 /** The module cannot identify a file without this metadata. */
242 SR_INPUT_META_REQUIRED = 0x80,
245 /** Input (file) module struct. */
248 * A pointer to this input module's 'struct sr_input_module'.
250 const struct sr_input_module *module;
252 struct sr_dev_inst *sdi;
257 /** Input (file) module driver. */
258 struct sr_input_module {
260 * A unique ID for this input module, suitable for use in command-line
261 * clients, [a-z0-9-]. Must not be NULL.
266 * A unique name for this input module, suitable for use in GUI
267 * clients, can contain UTF-8. Must not be NULL.
272 * A short description of the input module. Must not be NULL.
274 * This can be displayed by frontends, e.g. when selecting the input
275 * module for saving a file.
280 * A NULL terminated array of strings containing a list of file name
281 * extensions typical for the input file format, or NULL if there is
282 * no typical extension for this file format.
284 const char *const *exts;
287 * Zero-terminated list of metadata items the module needs to be able
288 * to identify an input stream. Can be all-zero, if the module cannot
289 * identify streams at all, i.e. has to be forced into use.
291 * Each item is one of:
292 * SR_INPUT_META_FILENAME
293 * SR_INPUT_META_FILESIZE
294 * SR_INPUT_META_HEADER
296 * If the high bit (SR_INPUT META_REQUIRED) is set, the module cannot
297 * identify a stream without the given metadata.
299 const uint8_t metadata[8];
302 * Returns a NULL-terminated list of options this module can take.
303 * Can be NULL, if the module has no options.
305 const struct sr_option *(*options) (void);
308 * Check if this input module can load and parse the specified stream.
310 * @param[in] metadata Metadata the module can use to identify the stream.
312 * @retval SR_OK This module knows the format.
313 * @retval SR_ERR_NA There wasn't enough data for this module to
314 * positively identify the format.
315 * @retval SR_ERR_DATA This module knows the format, but cannot handle it.
316 * This means the stream is either corrupt, or indicates a feature
317 * that the module does not support.
318 * @retval SR_ERR This module does not know the format.
320 int (*format_match) (GHashTable *metadata);
323 * Initialize the input module.
325 * @retval SR_OK Success
326 * @retval other Negative error code.
328 int (*init) (struct sr_input *in, GHashTable *options);
331 * Send data to the specified input instance.
333 * When an input module instance is created with sr_input_new(), this
334 * function is used to feed data to the instance.
336 * As enough data gets fed into this function to completely populate
337 * the device instance associated with this input instance, this is
338 * guaranteed to return the moment it's ready. This gives the caller
339 * the chance to examine the device instance, attach session callbacks
342 * @retval SR_OK Success
343 * @retval other Negative error code.
345 int (*receive) (struct sr_input *in, GString *buf);
348 * Signal the input module no more data will come.
350 * This will cause the module to process any data it may have buffered.
351 * The SR_DF_END packet will also typically be sent at this time.
353 int (*end) (struct sr_input *in);
356 * This function is called after the caller is finished using
357 * the input module, and can be used to free any internal
358 * resources the module may keep.
360 * This function is optional.
362 * @retval SR_OK Success
363 * @retval other Negative error code.
365 void (*cleanup) (struct sr_input *in);
368 /** Output module instance. */
370 /** A pointer to this output's module. */
371 const struct sr_output_module *module;
374 * The device for which this output module is creating output. This
375 * can be used by the module to find out channel names and numbers.
377 const struct sr_dev_inst *sdi;
380 * The name of the file that the data should be written to.
382 const char *filename;
385 * A generic pointer which can be used by the module to keep internal
386 * state between calls into its callback functions.
388 * For example, the module might store a pointer to a chunk of output
389 * there, and only flush it when it reaches a certain size.
394 /** Output module driver. */
395 struct sr_output_module {
397 * A unique ID for this output module, suitable for use in command-line
398 * clients, [a-z0-9-]. Must not be NULL.
403 * A unique name for this output module, suitable for use in GUI
404 * clients, can contain UTF-8. Must not be NULL.
409 * A short description of the output module. Must not be NULL.
411 * This can be displayed by frontends, e.g. when selecting the output
412 * module for saving a file.
417 * A NULL terminated array of strings containing a list of file name
418 * extensions typical for the input file format, or NULL if there is
419 * no typical extension for this file format.
421 const char *const *exts;
424 * Bitfield containing flags that describe certain properties
425 * this output module may or may not have.
426 * @see sr_output_flags
428 const uint64_t flags;
431 * Returns a NULL-terminated list of options this module can take.
432 * Can be NULL, if the module has no options.
434 const struct sr_option *(*options) (void);
437 * This function is called once, at the beginning of an output stream.
439 * The device struct will be available in the output struct passed in,
440 * as well as the param field -- which may be NULL or an empty string,
441 * if no parameter was passed.
443 * The module can use this to initialize itself, create a struct for
444 * keeping state and storing it in the <code>internal</code> field.
446 * @param o Pointer to the respective 'struct sr_output'.
448 * @retval SR_OK Success
449 * @retval other Negative error code.
451 int (*init) (struct sr_output *o, GHashTable *options);
454 * This function is passed a copy of every packet in the data feed.
455 * Any output generated by the output module in response to the
456 * packet should be returned in a newly allocated GString
457 * <code>out</code>, which will be freed by the caller.
459 * Packets not of interest to the output module can just be ignored,
460 * and the <code>out</code> parameter set to NULL.
462 * @param o Pointer to the respective 'struct sr_output'.
463 * @param sdi The device instance that generated the packet.
464 * @param packet The complete packet.
465 * @param out A pointer where a GString * should be stored if
466 * the module generates output, or NULL if not.
468 * @retval SR_OK Success
469 * @retval other Negative error code.
471 int (*receive) (const struct sr_output *o,
472 const struct sr_datafeed_packet *packet, GString **out);
475 * This function is called after the caller is finished using
476 * the output module, and can be used to free any internal
477 * resources the module may keep.
479 * @retval SR_OK Success
480 * @retval other Negative error code.
482 int (*cleanup) (struct sr_output *o);
485 /** Transform module instance. */
486 struct sr_transform {
487 /** A pointer to this transform's module. */
488 const struct sr_transform_module *module;
491 * The device for which this transform module is used. This
492 * can be used by the module to find out channel names and numbers.
494 const struct sr_dev_inst *sdi;
497 * A generic pointer which can be used by the module to keep internal
498 * state between calls into its callback functions.
503 struct sr_transform_module {
505 * A unique ID for this transform module, suitable for use in
506 * command-line clients, [a-z0-9-]. Must not be NULL.
511 * A unique name for this transform module, suitable for use in GUI
512 * clients, can contain UTF-8. Must not be NULL.
517 * A short description of the transform module. Must not be NULL.
519 * This can be displayed by frontends, e.g. when selecting
520 * which transform module(s) to add.
525 * Returns a NULL-terminated list of options this transform module
526 * can take. Can be NULL, if the transform module has no options.
528 const struct sr_option *(*options) (void);
531 * This function is called once, at the beginning of a stream.
533 * @param t Pointer to the respective 'struct sr_transform'.
534 * @param options Hash table of options for this transform module.
535 * Can be NULL if no options are to be used.
537 * @retval SR_OK Success
538 * @retval other Negative error code.
540 int (*init) (struct sr_transform *t, GHashTable *options);
543 * This function is passed a pointer to every packet in the data feed.
545 * It can either return (in packet_out) a pointer to another packet
546 * (possibly the exact same packet it got as input), or NULL.
548 * @param t Pointer to the respective 'struct sr_transform'.
549 * @param packet_in Pointer to a datafeed packet.
550 * @param packet_out Pointer to the resulting datafeed packet after
551 * this function was run. If NULL, the transform
552 * module intentionally didn't output a new packet.
554 * @retval SR_OK Success
555 * @retval other Negative error code.
557 int (*receive) (const struct sr_transform *t,
558 struct sr_datafeed_packet *packet_in,
559 struct sr_datafeed_packet **packet_out);
562 * This function is called after the caller is finished using
563 * the transform module, and can be used to free any internal
564 * resources the module may keep.
566 * @retval SR_OK Success
567 * @retval other Negative error code.
569 int (*cleanup) (struct sr_transform *t);
572 #ifdef HAVE_LIBUSB_1_0
573 /** USB device instance */
574 struct sr_usb_dev_inst {
577 /** Device address on USB bus */
579 /** libusb device handle */
580 struct libusb_device_handle *devhdl;
584 #ifdef HAVE_LIBSERIALPORT
585 struct sr_serial_dev_inst {
586 /** Port name, e.g. '/dev/tty42'. */
588 /** Comm params for serial_set_paramstr(). */
590 /** libserialport port handle */
591 struct sp_port *data;
595 struct sr_usbtmc_dev_inst {
600 /* Private driver context. */
602 /** sigrok context */
603 struct sr_context *sr_ctx;
607 /*--- log.c -----------------------------------------------------------------*/
609 #if defined(G_OS_WIN32) && (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 4))
611 * On MinGW, we need to specify the gnu_printf format flavor or GCC
612 * will assume non-standard Microsoft printf syntax.
614 SR_PRIV int sr_log(int loglevel, const char *format, ...)
615 __attribute__((__format__ (__gnu_printf__, 2, 3)));
617 SR_PRIV int sr_log(int loglevel, const char *format, ...) G_GNUC_PRINTF(2, 3);
620 /* Message logging helpers with subsystem-specific prefix string. */
621 #define sr_spew(...) sr_log(SR_LOG_SPEW, LOG_PREFIX ": " __VA_ARGS__)
622 #define sr_dbg(...) sr_log(SR_LOG_DBG, LOG_PREFIX ": " __VA_ARGS__)
623 #define sr_info(...) sr_log(SR_LOG_INFO, LOG_PREFIX ": " __VA_ARGS__)
624 #define sr_warn(...) sr_log(SR_LOG_WARN, LOG_PREFIX ": " __VA_ARGS__)
625 #define sr_err(...) sr_log(SR_LOG_ERR, LOG_PREFIX ": " __VA_ARGS__)
627 /*--- device.c --------------------------------------------------------------*/
629 /** Values for the changes argument of sr_dev_driver.config_channel_set. */
631 /** The enabled state of the channel has been changed. */
632 SR_CHANNEL_SET_ENABLED = 1 << 0,
635 SR_PRIV struct sr_channel *sr_channel_new(struct sr_dev_inst *sdi,
636 int index, int type, gboolean enabled, const char *name);
637 SR_PRIV struct sr_channel *sr_next_enabled_channel(const struct sr_dev_inst *sdi,
638 struct sr_channel *cur_channel);
640 /** Device instance data */
642 /** Device driver. */
643 struct sr_dev_driver *driver;
644 /** Device instance status. SR_ST_NOT_FOUND, etc. */
646 /** Device instance type. SR_INST_USB, etc. */
648 /** Device vendor. */
652 /** Device version. */
654 /** Serial number. */
656 /** Connection string to uniquely identify devices. */
658 /** List of channels. */
660 /** List of sr_channel_group structs */
661 GSList *channel_groups;
662 /** Device instance connection data (used?) */
664 /** Device instance private data (used?) */
666 /** Session to which this device is currently assigned. */
667 struct sr_session *session;
670 /* Generic device instances */
671 SR_PRIV void sr_dev_inst_free(struct sr_dev_inst *sdi);
673 #ifdef HAVE_LIBUSB_1_0
674 /* USB-specific instances */
675 SR_PRIV struct sr_usb_dev_inst *sr_usb_dev_inst_new(uint8_t bus,
676 uint8_t address, struct libusb_device_handle *hdl);
677 SR_PRIV void sr_usb_dev_inst_free(struct sr_usb_dev_inst *usb);
680 #ifdef HAVE_LIBSERIALPORT
681 /* Serial-specific instances */
682 SR_PRIV struct sr_serial_dev_inst *sr_serial_dev_inst_new(const char *port,
683 const char *serialcomm);
684 SR_PRIV void sr_serial_dev_inst_free(struct sr_serial_dev_inst *serial);
687 /* USBTMC-specific instances */
688 SR_PRIV struct sr_usbtmc_dev_inst *sr_usbtmc_dev_inst_new(const char *device);
689 SR_PRIV void sr_usbtmc_dev_inst_free(struct sr_usbtmc_dev_inst *usbtmc);
691 /*--- hwdriver.c ------------------------------------------------------------*/
693 extern SR_PRIV struct sr_dev_driver **drivers_lists[];
695 SR_PRIV const GVariantType *sr_variant_type_get(int datatype);
696 SR_PRIV int sr_variant_type_check(uint32_t key, GVariant *data);
697 SR_PRIV void sr_hw_cleanup_all(const struct sr_context *ctx);
698 SR_PRIV struct sr_config *sr_config_new(uint32_t key, GVariant *data);
699 SR_PRIV void sr_config_free(struct sr_config *src);
701 /*--- session.c -------------------------------------------------------------*/
704 /** Context this session exists in. */
705 struct sr_context *ctx;
706 /** List of struct sr_dev_inst pointers. */
708 /** List of struct sr_dev_inst pointers owned by this session. */
710 /** List of struct datafeed_callback pointers. */
711 GSList *datafeed_callbacks;
713 struct sr_trigger *trigger;
715 /** Callback to invoke on session stop. */
716 sr_session_stopped_callback stopped_callback;
717 /** User data to be passed to the session stop callback. */
718 void *stopped_cb_data;
720 /** Mutex protecting the main context pointer. */
722 /** Context of the session main loop. */
723 GMainContext *main_context;
725 /** Registered event sources for this session. */
726 GHashTable *event_sources;
727 /** Session main loop. */
728 GMainLoop *main_loop;
729 /** ID of idle source for dispatching the session stop notification. */
730 unsigned int stop_check_id;
731 /** Whether the session has been started. */
735 SR_PRIV int sr_session_source_add_internal(struct sr_session *session,
736 void *key, GSource *source);
737 SR_PRIV int sr_session_source_remove_internal(struct sr_session *session,
739 SR_PRIV int sr_session_source_destroyed(struct sr_session *session,
740 void *key, GSource *source);
741 SR_PRIV int sr_session_fd_source_add(struct sr_session *session,
742 void *key, gintptr fd, int events, int timeout,
743 sr_receive_data_callback cb, void *cb_data);
745 SR_PRIV int sr_session_source_add(struct sr_session *session, int fd,
746 int events, int timeout, sr_receive_data_callback cb, void *cb_data);
747 SR_PRIV int sr_session_source_add_pollfd(struct sr_session *session,
748 GPollFD *pollfd, int timeout, sr_receive_data_callback cb,
750 SR_PRIV int sr_session_source_add_channel(struct sr_session *session,
751 GIOChannel *channel, int events, int timeout,
752 sr_receive_data_callback cb, void *cb_data);
753 SR_PRIV int sr_session_source_remove(struct sr_session *session, int fd);
754 SR_PRIV int sr_session_source_remove_pollfd(struct sr_session *session,
756 SR_PRIV int sr_session_source_remove_channel(struct sr_session *session,
757 GIOChannel *channel);
759 SR_PRIV int sr_session_send(const struct sr_dev_inst *sdi,
760 const struct sr_datafeed_packet *packet);
761 SR_PRIV int sr_sessionfile_check(const char *filename);
762 SR_PRIV int sr_packet_copy(const struct sr_datafeed_packet *packet,
763 struct sr_datafeed_packet **copy);
764 SR_PRIV void sr_packet_free(struct sr_datafeed_packet *packet);
766 /*--- session_file.c --------------------------------------------------------*/
768 #if !HAVE_ZIP_DISCARD
769 /* Replace zip_discard() if not available. */
770 #define zip_discard(zip) sr_zip_discard(zip)
771 SR_PRIV void sr_zip_discard(struct zip *archive);
774 SR_PRIV GKeyFile *sr_sessionfile_read_metadata(struct zip *archive,
775 const struct zip_stat *entry);
777 /*--- analog.c --------------------------------------------------------------*/
779 SR_PRIV int sr_analog_init(struct sr_datafeed_analog *analog,
780 struct sr_analog_encoding *encoding,
781 struct sr_analog_meaning *meaning,
782 struct sr_analog_spec *spec,
785 /*--- std.c -----------------------------------------------------------------*/
787 typedef int (*dev_close_callback)(struct sr_dev_inst *sdi);
788 typedef void (*std_dev_clear_callback)(void *priv);
790 SR_PRIV int std_init(struct sr_context *sr_ctx, struct sr_dev_driver *di,
792 #ifdef HAVE_LIBSERIALPORT
793 SR_PRIV int std_serial_dev_open(struct sr_dev_inst *sdi);
794 SR_PRIV int std_serial_dev_acquisition_stop(struct sr_dev_inst *sdi,
795 void *cb_data, dev_close_callback dev_close_fn,
796 struct sr_serial_dev_inst *serial, const char *prefix);
798 SR_PRIV int std_session_send_df_header(const struct sr_dev_inst *sdi,
800 SR_PRIV int std_dev_clear(const struct sr_dev_driver *driver,
801 std_dev_clear_callback clear_private);
802 SR_PRIV int std_serial_dev_close(struct sr_dev_inst *sdi);
804 /*--- resource.c ------------------------------------------------------------*/
806 SR_PRIV int64_t sr_file_get_size(FILE *file);
808 SR_PRIV int sr_resource_open(struct sr_context *ctx,
809 struct sr_resource *res, int type, const char *name)
810 G_GNUC_WARN_UNUSED_RESULT;
811 SR_PRIV int sr_resource_close(struct sr_context *ctx,
812 struct sr_resource *res);
813 SR_PRIV ssize_t sr_resource_read(struct sr_context *ctx,
814 const struct sr_resource *res, void *buf, size_t count)
815 G_GNUC_WARN_UNUSED_RESULT;
816 SR_PRIV void *sr_resource_load(struct sr_context *ctx, int type,
817 const char *name, size_t *size, size_t max_size)
818 G_GNUC_MALLOC G_GNUC_WARN_UNUSED_RESULT;
820 /*--- strutil.c -------------------------------------------------------------*/
822 SR_PRIV int sr_atol(const char *str, long *ret);
823 SR_PRIV int sr_atoi(const char *str, int *ret);
824 SR_PRIV int sr_atod(const char *str, double *ret);
825 SR_PRIV int sr_atof(const char *str, float *ret);
826 SR_PRIV int sr_atof_ascii(const char *str, float *ret);
828 /*--- soft-trigger.c --------------------------------------------------------*/
830 struct soft_trigger_logic {
831 const struct sr_dev_inst *sdi;
832 const struct sr_trigger *trigger;
836 uint8_t *prev_sample;
837 uint8_t *pre_trigger_buffer;
838 uint8_t *pre_trigger_head;
839 int pre_trigger_size;
840 int pre_trigger_fill;
843 SR_PRIV struct soft_trigger_logic *soft_trigger_logic_new(
844 const struct sr_dev_inst *sdi, struct sr_trigger *trigger,
845 int pre_trigger_samples);
846 SR_PRIV void soft_trigger_logic_free(struct soft_trigger_logic *st);
847 SR_PRIV int soft_trigger_logic_check(struct soft_trigger_logic *st, uint8_t *buf,
848 int len, int *pre_trigger_samples);
850 /*--- hardware/serial.c -----------------------------------------------------*/
852 #ifdef HAVE_LIBSERIALPORT
858 typedef gboolean (*packet_valid_callback)(const uint8_t *buf);
860 SR_PRIV int serial_open(struct sr_serial_dev_inst *serial, int flags);
861 SR_PRIV int serial_close(struct sr_serial_dev_inst *serial);
862 SR_PRIV int serial_flush(struct sr_serial_dev_inst *serial);
863 SR_PRIV int serial_drain(struct sr_serial_dev_inst *serial);
864 SR_PRIV int serial_write_blocking(struct sr_serial_dev_inst *serial,
865 const void *buf, size_t count, unsigned int timeout_ms);
866 SR_PRIV int serial_write_nonblocking(struct sr_serial_dev_inst *serial,
867 const void *buf, size_t count);
868 SR_PRIV int serial_read_blocking(struct sr_serial_dev_inst *serial, void *buf,
869 size_t count, unsigned int timeout_ms);
870 SR_PRIV int serial_read_nonblocking(struct sr_serial_dev_inst *serial, void *buf,
872 SR_PRIV int serial_set_params(struct sr_serial_dev_inst *serial, int baudrate,
873 int bits, int parity, int stopbits, int flowcontrol, int rts, int dtr);
874 SR_PRIV int serial_set_paramstr(struct sr_serial_dev_inst *serial,
875 const char *paramstr);
876 SR_PRIV int serial_readline(struct sr_serial_dev_inst *serial, char **buf,
877 int *buflen, gint64 timeout_ms);
878 SR_PRIV int serial_stream_detect(struct sr_serial_dev_inst *serial,
879 uint8_t *buf, size_t *buflen,
881 packet_valid_callback is_valid,
882 uint64_t timeout_ms, int baudrate);
883 SR_PRIV int sr_serial_extract_options(GSList *options, const char **serial_device,
884 const char **serial_options);
885 SR_PRIV int serial_source_add(struct sr_session *session,
886 struct sr_serial_dev_inst *serial, int events, int timeout,
887 sr_receive_data_callback cb, void *cb_data);
888 SR_PRIV int serial_source_remove(struct sr_session *session,
889 struct sr_serial_dev_inst *serial);
890 SR_PRIV GSList *sr_serial_find_usb(uint16_t vendor_id, uint16_t product_id);
891 SR_PRIV int serial_timeout(struct sr_serial_dev_inst *port, int num_bytes);
894 /*--- hardware/ezusb.c ------------------------------------------------------*/
896 #ifdef HAVE_LIBUSB_1_0
897 SR_PRIV int ezusb_reset(struct libusb_device_handle *hdl, int set_clear);
898 SR_PRIV int ezusb_install_firmware(struct sr_context *ctx, libusb_device_handle *hdl,
900 SR_PRIV int ezusb_upload_firmware(struct sr_context *ctx, libusb_device *dev,
901 int configuration, const char *name);
904 /*--- hardware/usb.c --------------------------------------------------------*/
906 #ifdef HAVE_LIBUSB_1_0
907 SR_PRIV GSList *sr_usb_find(libusb_context *usb_ctx, const char *conn);
908 SR_PRIV int sr_usb_open(libusb_context *usb_ctx, struct sr_usb_dev_inst *usb);
909 SR_PRIV void sr_usb_close(struct sr_usb_dev_inst *usb);
910 SR_PRIV int usb_source_add(struct sr_session *session, struct sr_context *ctx,
911 int timeout, sr_receive_data_callback cb, void *cb_data);
912 SR_PRIV int usb_source_remove(struct sr_session *session, struct sr_context *ctx);
913 SR_PRIV int usb_get_port_path(libusb_device *dev, char *path, int path_len);
917 /*--- modbus/modbus.c -------------------------------------------------------*/
919 struct sr_modbus_dev_inst {
923 GSList *(*scan)(int modbusaddr);
924 int (*dev_inst_new)(void *priv, const char *resource,
925 char **params, const char *serialcomm, int modbusaddr);
926 int (*open)(void *priv);
927 int (*source_add)(struct sr_session *session, void *priv, int events,
928 int timeout, sr_receive_data_callback cb, void *cb_data);
929 int (*source_remove)(struct sr_session *session, void *priv);
930 int (*send)(void *priv, const uint8_t *buffer, int buffer_size);
931 int (*read_begin)(void *priv, uint8_t *function_code);
932 int (*read_data)(void *priv, uint8_t *buf, int maxlen);
933 int (*read_end)(void *priv);
934 int (*close)(void *priv);
935 void (*free)(void *priv);
936 unsigned int read_timeout_ms;
940 SR_PRIV GSList *sr_modbus_scan(struct drv_context *drvc, GSList *options,
941 struct sr_dev_inst *(*probe_device)(struct sr_modbus_dev_inst *modbus));
942 SR_PRIV struct sr_modbus_dev_inst *modbus_dev_inst_new(const char *resource,
943 const char *serialcomm, int modbusaddr);
944 SR_PRIV int sr_modbus_open(struct sr_modbus_dev_inst *modbus);
945 SR_PRIV int sr_modbus_source_add(struct sr_session *session,
946 struct sr_modbus_dev_inst *modbus, int events, int timeout,
947 sr_receive_data_callback cb, void *cb_data);
948 SR_PRIV int sr_modbus_source_remove(struct sr_session *session,
949 struct sr_modbus_dev_inst *modbus);
950 SR_PRIV int sr_modbus_request(struct sr_modbus_dev_inst *modbus,
951 uint8_t *request, int request_size);
952 SR_PRIV int sr_modbus_reply(struct sr_modbus_dev_inst *modbus,
953 uint8_t *reply, int reply_size);
954 SR_PRIV int sr_modbus_request_reply(struct sr_modbus_dev_inst *modbus,
955 uint8_t *request, int request_size,
956 uint8_t *reply, int reply_size);
957 SR_PRIV int sr_modbus_read_coils(struct sr_modbus_dev_inst *modbus,
958 int address, int nb_coils, uint8_t *coils);
959 SR_PRIV int sr_modbus_read_holding_registers(struct sr_modbus_dev_inst *modbus,
960 int address, int nb_registers,
961 uint16_t *registers);
962 SR_PRIV int sr_modbus_write_coil(struct sr_modbus_dev_inst *modbus,
963 int address, int value);
964 SR_PRIV int sr_modbus_write_multiple_registers(struct sr_modbus_dev_inst*modbus,
965 int address, int nb_registers,
966 uint16_t *registers);
967 SR_PRIV int sr_modbus_close(struct sr_modbus_dev_inst *modbus);
968 SR_PRIV void sr_modbus_free(struct sr_modbus_dev_inst *modbus);
970 /*--- hardware/dmm/es519xx.c ------------------------------------------------*/
973 * All 11-byte es519xx chips repeat each block twice for each conversion cycle
974 * so always read 2 blocks at a time.
976 #define ES519XX_11B_PACKET_SIZE (11 * 2)
977 #define ES519XX_14B_PACKET_SIZE 14
979 struct es519xx_info {
980 gboolean is_judge, is_voltage, is_auto, is_micro, is_current;
981 gboolean is_milli, is_resistance, is_continuity, is_diode;
982 gboolean is_frequency, is_rpm, is_capacitance, is_duty_cycle;
983 gboolean is_temperature, is_celsius, is_fahrenheit;
984 gboolean is_adp0, is_adp1, is_adp2, is_adp3;
985 gboolean is_sign, is_batt, is_ol, is_pmax, is_pmin, is_apo;
986 gboolean is_dc, is_ac, is_vahz, is_min, is_max, is_rel, is_hold;
987 gboolean is_digit4, is_ul, is_vasel, is_vbar, is_lpf1, is_lpf0, is_rmr;
990 gboolean alt_functions, fivedigits, clampmeter, selectable_lpf;
993 SR_PRIV gboolean sr_es519xx_2400_11b_packet_valid(const uint8_t *buf);
994 SR_PRIV int sr_es519xx_2400_11b_parse(const uint8_t *buf, float *floatval,
995 struct sr_datafeed_analog_old *analog, void *info);
996 SR_PRIV gboolean sr_es519xx_2400_11b_altfn_packet_valid(const uint8_t *buf);
997 SR_PRIV int sr_es519xx_2400_11b_altfn_parse(const uint8_t *buf,
998 float *floatval, struct sr_datafeed_analog_old *analog, void *info);
999 SR_PRIV gboolean sr_es519xx_19200_11b_5digits_packet_valid(const uint8_t *buf);
1000 SR_PRIV int sr_es519xx_19200_11b_5digits_parse(const uint8_t *buf,
1001 float *floatval, struct sr_datafeed_analog_old *analog, void *info);
1002 SR_PRIV gboolean sr_es519xx_19200_11b_clamp_packet_valid(const uint8_t *buf);
1003 SR_PRIV int sr_es519xx_19200_11b_clamp_parse(const uint8_t *buf,
1004 float *floatval, struct sr_datafeed_analog_old *analog, void *info);
1005 SR_PRIV gboolean sr_es519xx_19200_11b_packet_valid(const uint8_t *buf);
1006 SR_PRIV int sr_es519xx_19200_11b_parse(const uint8_t *buf, float *floatval,
1007 struct sr_datafeed_analog_old *analog, void *info);
1008 SR_PRIV gboolean sr_es519xx_19200_14b_packet_valid(const uint8_t *buf);
1009 SR_PRIV int sr_es519xx_19200_14b_parse(const uint8_t *buf, float *floatval,
1010 struct sr_datafeed_analog_old *analog, void *info);
1011 SR_PRIV gboolean sr_es519xx_19200_14b_sel_lpf_packet_valid(const uint8_t *buf);
1012 SR_PRIV int sr_es519xx_19200_14b_sel_lpf_parse(const uint8_t *buf,
1013 float *floatval, struct sr_datafeed_analog_old *analog, void *info);
1015 /*--- hardware/dmm/fs9922.c -------------------------------------------------*/
1017 #define FS9922_PACKET_SIZE 14
1019 struct fs9922_info {
1020 gboolean is_auto, is_dc, is_ac, is_rel, is_hold, is_bpn, is_z1, is_z2;
1021 gboolean is_max, is_min, is_apo, is_bat, is_nano, is_z3, is_micro;
1022 gboolean is_milli, is_kilo, is_mega, is_beep, is_diode, is_percent;
1023 gboolean is_z4, is_volt, is_ampere, is_ohm, is_hfe, is_hertz, is_farad;
1024 gboolean is_celsius, is_fahrenheit;
1025 int bargraph_sign, bargraph_value;
1028 SR_PRIV gboolean sr_fs9922_packet_valid(const uint8_t *buf);
1029 SR_PRIV int sr_fs9922_parse(const uint8_t *buf, float *floatval,
1030 struct sr_datafeed_analog_old *analog, void *info);
1031 SR_PRIV void sr_fs9922_z1_diode(struct sr_datafeed_analog_old *analog, void *info);
1033 /*--- hardware/dmm/fs9721.c -------------------------------------------------*/
1035 #define FS9721_PACKET_SIZE 14
1037 struct fs9721_info {
1038 gboolean is_ac, is_dc, is_auto, is_rs232, is_micro, is_nano, is_kilo;
1039 gboolean is_diode, is_milli, is_percent, is_mega, is_beep, is_farad;
1040 gboolean is_ohm, is_rel, is_hold, is_ampere, is_volt, is_hz, is_bat;
1041 gboolean is_c2c1_11, is_c2c1_10, is_c2c1_01, is_c2c1_00, is_sign;
1044 SR_PRIV gboolean sr_fs9721_packet_valid(const uint8_t *buf);
1045 SR_PRIV int sr_fs9721_parse(const uint8_t *buf, float *floatval,
1046 struct sr_datafeed_analog_old *analog, void *info);
1047 SR_PRIV void sr_fs9721_00_temp_c(struct sr_datafeed_analog_old *analog, void *info);
1048 SR_PRIV void sr_fs9721_01_temp_c(struct sr_datafeed_analog_old *analog, void *info);
1049 SR_PRIV void sr_fs9721_10_temp_c(struct sr_datafeed_analog_old *analog, void *info);
1050 SR_PRIV void sr_fs9721_01_10_temp_f_c(struct sr_datafeed_analog_old *analog, void *info);
1051 SR_PRIV void sr_fs9721_max_c_min(struct sr_datafeed_analog_old *analog, void *info);
1053 /*--- hardware/dmm/dtm0660.c ------------------------------------------------*/
1055 #define DTM0660_PACKET_SIZE 15
1057 struct dtm0660_info {
1058 gboolean is_ac, is_dc, is_auto, is_rs232, is_micro, is_nano, is_kilo;
1059 gboolean is_diode, is_milli, is_percent, is_mega, is_beep, is_farad;
1060 gboolean is_ohm, is_rel, is_hold, is_ampere, is_volt, is_hz, is_bat;
1061 gboolean is_degf, is_degc, is_c2c1_01, is_c2c1_00, is_apo, is_min;
1062 gboolean is_minmax, is_max, is_sign;
1065 SR_PRIV gboolean sr_dtm0660_packet_valid(const uint8_t *buf);
1066 SR_PRIV int sr_dtm0660_parse(const uint8_t *buf, float *floatval,
1067 struct sr_datafeed_analog_old *analog, void *info);
1069 /*--- hardware/dmm/m2110.c --------------------------------------------------*/
1071 #define BBCGM_M2110_PACKET_SIZE 9
1073 SR_PRIV gboolean sr_m2110_packet_valid(const uint8_t *buf);
1074 SR_PRIV int sr_m2110_parse(const uint8_t *buf, float *floatval,
1075 struct sr_datafeed_analog_old *analog, void *info);
1077 /*--- hardware/dmm/metex14.c ------------------------------------------------*/
1079 #define METEX14_PACKET_SIZE 14
1081 struct metex14_info {
1082 gboolean is_ac, is_dc, is_resistance, is_capacity, is_temperature;
1083 gboolean is_diode, is_frequency, is_ampere, is_volt, is_farad;
1084 gboolean is_hertz, is_ohm, is_celsius, is_pico, is_nano, is_micro;
1085 gboolean is_milli, is_kilo, is_mega, is_gain, is_decibel, is_hfe;
1086 gboolean is_unitless, is_logic;
1089 #ifdef HAVE_LIBSERIALPORT
1090 SR_PRIV int sr_metex14_packet_request(struct sr_serial_dev_inst *serial);
1092 SR_PRIV gboolean sr_metex14_packet_valid(const uint8_t *buf);
1093 SR_PRIV int sr_metex14_parse(const uint8_t *buf, float *floatval,
1094 struct sr_datafeed_analog_old *analog, void *info);
1096 /*--- hardware/dmm/rs9lcd.c -------------------------------------------------*/
1098 #define RS9LCD_PACKET_SIZE 9
1100 /* Dummy info struct. The parser does not use it. */
1101 struct rs9lcd_info { int dummy; };
1103 SR_PRIV gboolean sr_rs9lcd_packet_valid(const uint8_t *buf);
1104 SR_PRIV int sr_rs9lcd_parse(const uint8_t *buf, float *floatval,
1105 struct sr_datafeed_analog_old *analog, void *info);
1107 /*--- hardware/dmm/bm25x.c --------------------------------------------------*/
1109 #define BRYMEN_BM25X_PACKET_SIZE 15
1111 /* Dummy info struct. The parser does not use it. */
1112 struct bm25x_info { int dummy; };
1114 SR_PRIV gboolean sr_brymen_bm25x_packet_valid(const uint8_t *buf);
1115 SR_PRIV int sr_brymen_bm25x_parse(const uint8_t *buf, float *floatval,
1116 struct sr_datafeed_analog_old *analog, void *info);
1118 /*--- hardware/dmm/ut71x.c --------------------------------------------------*/
1120 #define UT71X_PACKET_SIZE 11
1123 gboolean is_voltage, is_resistance, is_capacitance, is_temperature;
1124 gboolean is_celsius, is_fahrenheit, is_current, is_continuity;
1125 gboolean is_diode, is_frequency, is_duty_cycle, is_dc, is_ac;
1126 gboolean is_auto, is_manual, is_sign, is_power, is_loop_current;
1129 SR_PRIV gboolean sr_ut71x_packet_valid(const uint8_t *buf);
1130 SR_PRIV int sr_ut71x_parse(const uint8_t *buf, float *floatval,
1131 struct sr_datafeed_analog_old *analog, void *info);
1133 /*--- hardware/dmm/vc870.c --------------------------------------------------*/
1135 #define VC870_PACKET_SIZE 23
1138 gboolean is_voltage, is_dc, is_ac, is_temperature, is_resistance;
1139 gboolean is_continuity, is_capacitance, is_diode, is_loop_current;
1140 gboolean is_current, is_micro, is_milli, is_power;
1141 gboolean is_power_factor_freq, is_power_apparent_power, is_v_a_eff_value;
1142 gboolean is_sign2, is_sign1, is_batt, is_ol1, is_max, is_min;
1143 gboolean is_maxmin, is_rel, is_ol2, is_open, is_manu, is_hold;
1144 gboolean is_light, is_usb, is_warning, is_auto_power, is_misplug_warn;
1145 gboolean is_lo, is_hi, is_open2;
1147 gboolean is_frequency, is_dual_display, is_auto, is_rms;
1150 SR_PRIV gboolean sr_vc870_packet_valid(const uint8_t *buf);
1151 SR_PRIV int sr_vc870_parse(const uint8_t *buf, float *floatval,
1152 struct sr_datafeed_analog_old *analog, void *info);
1154 /*--- hardware/lcr/es51919.c ------------------------------------------------*/
1156 SR_PRIV void es51919_serial_clean(void *priv);
1157 SR_PRIV struct sr_dev_inst *es51919_serial_scan(GSList *options,
1160 SR_PRIV int es51919_serial_config_get(uint32_t key, GVariant **data,
1161 const struct sr_dev_inst *sdi,
1162 const struct sr_channel_group *cg);
1163 SR_PRIV int es51919_serial_config_set(uint32_t key, GVariant *data,
1164 const struct sr_dev_inst *sdi,
1165 const struct sr_channel_group *cg);
1166 SR_PRIV int es51919_serial_config_list(uint32_t key, GVariant **data,
1167 const struct sr_dev_inst *sdi,
1168 const struct sr_channel_group *cg);
1169 SR_PRIV int es51919_serial_acquisition_start(const struct sr_dev_inst *sdi,
1171 SR_PRIV int es51919_serial_acquisition_stop(struct sr_dev_inst *sdi,
1174 /*--- hardware/dmm/ut372.c --------------------------------------------------*/
1176 #define UT372_PACKET_SIZE 27
1182 SR_PRIV gboolean sr_ut372_packet_valid(const uint8_t *buf);
1183 SR_PRIV int sr_ut372_parse(const uint8_t *buf, float *floatval,
1184 struct sr_datafeed_analog_old *analog, void *info);
1186 /*--- hardware/scale/kern.c -------------------------------------------------*/
1189 gboolean is_gram, is_carat, is_ounce, is_pound, is_troy_ounce;
1190 gboolean is_pennyweight, is_grain, is_tael, is_momme, is_tola;
1191 gboolean is_percentage, is_piece, is_unstable, is_stable, is_error;
1195 SR_PRIV gboolean sr_kern_packet_valid(const uint8_t *buf);
1196 SR_PRIV int sr_kern_parse(const uint8_t *buf, float *floatval,
1197 struct sr_datafeed_analog_old *analog, void *info);