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 big endian signed integer out of memory.
81 * @param x a pointer to the input memory
82 * @return the corresponding signed integer
84 #define RB16S(x) ((int16_t) \
85 (((unsigned)((const uint8_t*)(x))[0] << 8) | \
86 (unsigned)((const uint8_t*)(x))[1]))
89 * Read a 16 bits little endian signed integer out of memory.
90 * @param x a pointer to the input memory
91 * @return the corresponding signed integer
93 #define RL16S(x) ((int16_t) \
94 (((unsigned)((const uint8_t*)(x))[1] << 8) | \
95 (unsigned)((const uint8_t*)(x))[0]))
98 * Read a 32 bits big endian unsigned integer out of memory.
99 * @param x a pointer to the input memory
100 * @return the corresponding unsigned integer
102 #define RB32(x) (((unsigned)((const uint8_t*)(x))[0] << 24) | \
103 ((unsigned)((const uint8_t*)(x))[1] << 16) | \
104 ((unsigned)((const uint8_t*)(x))[2] << 8) | \
105 (unsigned)((const uint8_t*)(x))[3])
108 * Read a 32 bits little endian unsigned integer out of memory.
109 * @param x a pointer to the input memory
110 * @return the corresponding unsigned integer
112 #define RL32(x) (((unsigned)((const uint8_t*)(x))[3] << 24) | \
113 ((unsigned)((const uint8_t*)(x))[2] << 16) | \
114 ((unsigned)((const uint8_t*)(x))[1] << 8) | \
115 (unsigned)((const uint8_t*)(x))[0])
118 * Read a 32 bits big endian signed integer out of memory.
119 * @param x a pointer to the input memory
120 * @return the corresponding signed integer
122 #define RB32S(x) ((int32_t) \
123 (((unsigned)((const uint8_t*)(x))[0] << 24) | \
124 ((unsigned)((const uint8_t*)(x))[1] << 16) | \
125 ((unsigned)((const uint8_t*)(x))[2] << 8) | \
126 (unsigned)((const uint8_t*)(x))[3]))
129 * Read a 32 bits little endian signed integer out of memory.
130 * @param x a pointer to the input memory
131 * @return the corresponding signed integer
133 #define RL32S(x) ((int32_t) \
134 (((unsigned)((const uint8_t*)(x))[3] << 24) | \
135 ((unsigned)((const uint8_t*)(x))[2] << 16) | \
136 ((unsigned)((const uint8_t*)(x))[1] << 8) | \
137 (unsigned)((const uint8_t*)(x))[0]))
140 * Read a 64 bits big endian unsigned integer out of memory.
141 * @param x a pointer to the input memory
142 * @return the corresponding unsigned integer
144 #define RB64(x) (((uint64_t)((const uint8_t*)(x))[0] << 56) | \
145 ((uint64_t)((const uint8_t*)(x))[1] << 48) | \
146 ((uint64_t)((const uint8_t*)(x))[2] << 40) | \
147 ((uint64_t)((const uint8_t*)(x))[3] << 32) | \
148 ((uint64_t)((const uint8_t*)(x))[4] << 24) | \
149 ((uint64_t)((const uint8_t*)(x))[5] << 16) | \
150 ((uint64_t)((const uint8_t*)(x))[6] << 8) | \
151 (uint64_t)((const uint8_t*)(x))[7])
154 * Read a 32 bits big endian float out of memory.
155 * @param x a pointer to the input memory
156 * @return the corresponding float
158 #define RBFL(x) ((union { uint32_t u; float f; }) { .u = RB32(x) }.f)
161 * Read a 32 bits little endian float out of memory.
162 * @param x a pointer to the input memory
163 * @return the corresponding float
165 #define RLFL(x) ((union { uint32_t u; float f; }) { .u = RL32(x) }.f)
168 * Write a 8 bits unsigned integer to memory.
169 * @param p a pointer to the output memory
170 * @param x the input unsigned integer
172 #define W8(p, x) do { ((uint8_t*)(p))[0] = (uint8_t) (x); } while (0)
175 * Write a 16 bits unsigned integer to memory stored as big endian.
176 * @param p a pointer to the output memory
177 * @param x the input unsigned integer
179 #define WB16(p, x) do { ((uint8_t*)(p))[1] = (uint8_t) (x); \
180 ((uint8_t*)(p))[0] = (uint8_t)((x)>>8); } while (0)
183 * Write a 16 bits unsigned integer to memory stored as little endian.
184 * @param p a pointer to the output memory
185 * @param x the input unsigned integer
187 #define WL16(p, x) do { ((uint8_t*)(p))[0] = (uint8_t) (x); \
188 ((uint8_t*)(p))[1] = (uint8_t)((x)>>8); } while (0)
191 * Write a 32 bits unsigned integer to memory stored as big endian.
192 * @param p a pointer to the output memory
193 * @param x the input unsigned integer
195 #define WB32(p, x) do { ((uint8_t*)(p))[3] = (uint8_t) (x); \
196 ((uint8_t*)(p))[2] = (uint8_t)((x)>>8); \
197 ((uint8_t*)(p))[1] = (uint8_t)((x)>>16); \
198 ((uint8_t*)(p))[0] = (uint8_t)((x)>>24); } while (0)
201 * Write a 32 bits unsigned integer to memory stored as little endian.
202 * @param p a pointer to the output memory
203 * @param x the input unsigned integer
205 #define WL32(p, x) do { ((uint8_t*)(p))[0] = (uint8_t) (x); \
206 ((uint8_t*)(p))[1] = (uint8_t)((x)>>8); \
207 ((uint8_t*)(p))[2] = (uint8_t)((x)>>16); \
208 ((uint8_t*)(p))[3] = (uint8_t)((x)>>24); } while (0)
211 * Write a 32 bits float to memory stored as big endian.
212 * @param p a pointer to the output memory
213 * @param x the input float
215 #define WBFL(p, x) WB32(p, (union { uint32_t u; float f; }) { .f = x }.u)
218 * Write a 32 bits float to memory stored as little endian.
219 * @param p a pointer to the output memory
220 * @param x the input float
222 #define WLFL(p, x) WL32(p, (union { uint32_t u; float f; }) { .f = x }.u)
224 /* Portability fixes for FreeBSD. */
226 #define LIBUSB_CLASS_APPLICATION 0xfe
227 #define libusb_has_capability(x) 0
228 #define libusb_handle_events_timeout_completed(ctx, tv, c) \
229 libusb_handle_events_timeout(ctx, tv)
232 /* Static definitions of structs ending with an all-zero entry are a
233 * problem when compiling with -Wmissing-field-initializers: GCC
234 * suppresses the warning only with { 0 }, clang wants { } */
238 #define ALL_ZERO { 0 }
242 struct sr_dev_driver **driver_list;
243 #ifdef HAVE_LIBUSB_1_0
244 libusb_context *libusb_ctx;
246 sr_resource_open_callback resource_open_cb;
247 sr_resource_close_callback resource_close_cb;
248 sr_resource_read_callback resource_read_cb;
249 void *resource_cb_data;
252 /** Input module metadata keys. */
253 enum sr_input_meta_keys {
254 /** The input filename, if there is one. */
255 SR_INPUT_META_FILENAME = 0x01,
256 /** The input file's size in bytes. */
257 SR_INPUT_META_FILESIZE = 0x02,
258 /** The first 128 bytes of the file, provided as a GString. */
259 SR_INPUT_META_HEADER = 0x04,
261 /** The module cannot identify a file without this metadata. */
262 SR_INPUT_META_REQUIRED = 0x80,
265 /** Input (file) module struct. */
268 * A pointer to this input module's 'struct sr_input_module'.
270 const struct sr_input_module *module;
272 struct sr_dev_inst *sdi;
277 /** Input (file) module driver. */
278 struct sr_input_module {
280 * A unique ID for this input module, suitable for use in command-line
281 * clients, [a-z0-9-]. Must not be NULL.
286 * A unique name for this input module, suitable for use in GUI
287 * clients, can contain UTF-8. Must not be NULL.
292 * A short description of the input module. Must not be NULL.
294 * This can be displayed by frontends, e.g. when selecting the input
295 * module for saving a file.
300 * A NULL terminated array of strings containing a list of file name
301 * extensions typical for the input file format, or NULL if there is
302 * no typical extension for this file format.
304 const char *const *exts;
307 * Zero-terminated list of metadata items the module needs to be able
308 * to identify an input stream. Can be all-zero, if the module cannot
309 * identify streams at all, i.e. has to be forced into use.
311 * Each item is one of:
312 * SR_INPUT_META_FILENAME
313 * SR_INPUT_META_FILESIZE
314 * SR_INPUT_META_HEADER
316 * If the high bit (SR_INPUT META_REQUIRED) is set, the module cannot
317 * identify a stream without the given metadata.
319 const uint8_t metadata[8];
322 * Returns a NULL-terminated list of options this module can take.
323 * Can be NULL, if the module has no options.
325 const struct sr_option *(*options) (void);
328 * Check if this input module can load and parse the specified stream.
330 * @param[in] metadata Metadata the module can use to identify the stream.
332 * @retval SR_OK This module knows the format.
333 * @retval SR_ERR_NA There wasn't enough data for this module to
334 * positively identify the format.
335 * @retval SR_ERR_DATA This module knows the format, but cannot handle it.
336 * This means the stream is either corrupt, or indicates a feature
337 * that the module does not support.
338 * @retval SR_ERR This module does not know the format.
340 int (*format_match) (GHashTable *metadata);
343 * Initialize the input module.
345 * @retval SR_OK Success
346 * @retval other Negative error code.
348 int (*init) (struct sr_input *in, GHashTable *options);
351 * Send data to the specified input instance.
353 * When an input module instance is created with sr_input_new(), this
354 * function is used to feed data to the instance.
356 * As enough data gets fed into this function to completely populate
357 * the device instance associated with this input instance, this is
358 * guaranteed to return the moment it's ready. This gives the caller
359 * the chance to examine the device instance, attach session callbacks
362 * @retval SR_OK Success
363 * @retval other Negative error code.
365 int (*receive) (struct sr_input *in, GString *buf);
368 * Signal the input module no more data will come.
370 * This will cause the module to process any data it may have buffered.
371 * The SR_DF_END packet will also typically be sent at this time.
373 int (*end) (struct sr_input *in);
376 * This function is called after the caller is finished using
377 * the input module, and can be used to free any internal
378 * resources the module may keep.
380 * This function is optional.
382 * @retval SR_OK Success
383 * @retval other Negative error code.
385 void (*cleanup) (struct sr_input *in);
388 /** Output module instance. */
390 /** A pointer to this output's module. */
391 const struct sr_output_module *module;
394 * The device for which this output module is creating output. This
395 * can be used by the module to find out channel names and numbers.
397 const struct sr_dev_inst *sdi;
400 * The name of the file that the data should be written to.
402 const char *filename;
405 * A generic pointer which can be used by the module to keep internal
406 * state between calls into its callback functions.
408 * For example, the module might store a pointer to a chunk of output
409 * there, and only flush it when it reaches a certain size.
414 /** Output module driver. */
415 struct sr_output_module {
417 * A unique ID for this output module, suitable for use in command-line
418 * clients, [a-z0-9-]. Must not be NULL.
423 * A unique name for this output module, suitable for use in GUI
424 * clients, can contain UTF-8. Must not be NULL.
429 * A short description of the output module. Must not be NULL.
431 * This can be displayed by frontends, e.g. when selecting the output
432 * module for saving a file.
437 * A NULL terminated array of strings containing a list of file name
438 * extensions typical for the input file format, or NULL if there is
439 * no typical extension for this file format.
441 const char *const *exts;
444 * Bitfield containing flags that describe certain properties
445 * this output module may or may not have.
446 * @see sr_output_flags
448 const uint64_t flags;
451 * Returns a NULL-terminated list of options this module can take.
452 * Can be NULL, if the module has no options.
454 const struct sr_option *(*options) (void);
457 * This function is called once, at the beginning of an output stream.
459 * The device struct will be available in the output struct passed in,
460 * as well as the param field -- which may be NULL or an empty string,
461 * if no parameter was passed.
463 * The module can use this to initialize itself, create a struct for
464 * keeping state and storing it in the <code>internal</code> field.
466 * @param o Pointer to the respective 'struct sr_output'.
468 * @retval SR_OK Success
469 * @retval other Negative error code.
471 int (*init) (struct sr_output *o, GHashTable *options);
474 * This function is passed a copy of every packet in the data feed.
475 * Any output generated by the output module in response to the
476 * packet should be returned in a newly allocated GString
477 * <code>out</code>, which will be freed by the caller.
479 * Packets not of interest to the output module can just be ignored,
480 * and the <code>out</code> parameter set to NULL.
482 * @param o Pointer to the respective 'struct sr_output'.
483 * @param sdi The device instance that generated the packet.
484 * @param packet The complete packet.
485 * @param out A pointer where a GString * should be stored if
486 * the module generates output, or NULL if not.
488 * @retval SR_OK Success
489 * @retval other Negative error code.
491 int (*receive) (const struct sr_output *o,
492 const struct sr_datafeed_packet *packet, GString **out);
495 * This function is called after the caller is finished using
496 * the output module, and can be used to free any internal
497 * resources the module may keep.
499 * @retval SR_OK Success
500 * @retval other Negative error code.
502 int (*cleanup) (struct sr_output *o);
505 /** Transform module instance. */
506 struct sr_transform {
507 /** A pointer to this transform's module. */
508 const struct sr_transform_module *module;
511 * The device for which this transform module is used. This
512 * can be used by the module to find out channel names and numbers.
514 const struct sr_dev_inst *sdi;
517 * A generic pointer which can be used by the module to keep internal
518 * state between calls into its callback functions.
523 struct sr_transform_module {
525 * A unique ID for this transform module, suitable for use in
526 * command-line clients, [a-z0-9-]. Must not be NULL.
531 * A unique name for this transform module, suitable for use in GUI
532 * clients, can contain UTF-8. Must not be NULL.
537 * A short description of the transform module. Must not be NULL.
539 * This can be displayed by frontends, e.g. when selecting
540 * which transform module(s) to add.
545 * Returns a NULL-terminated list of options this transform module
546 * can take. Can be NULL, if the transform module has no options.
548 const struct sr_option *(*options) (void);
551 * This function is called once, at the beginning of a stream.
553 * @param t Pointer to the respective 'struct sr_transform'.
554 * @param options Hash table of options for this transform module.
555 * Can be NULL if no options are to be used.
557 * @retval SR_OK Success
558 * @retval other Negative error code.
560 int (*init) (struct sr_transform *t, GHashTable *options);
563 * This function is passed a pointer to every packet in the data feed.
565 * It can either return (in packet_out) a pointer to another packet
566 * (possibly the exact same packet it got as input), or NULL.
568 * @param t Pointer to the respective 'struct sr_transform'.
569 * @param packet_in Pointer to a datafeed packet.
570 * @param packet_out Pointer to the resulting datafeed packet after
571 * this function was run. If NULL, the transform
572 * module intentionally didn't output a new packet.
574 * @retval SR_OK Success
575 * @retval other Negative error code.
577 int (*receive) (const struct sr_transform *t,
578 struct sr_datafeed_packet *packet_in,
579 struct sr_datafeed_packet **packet_out);
582 * This function is called after the caller is finished using
583 * the transform module, and can be used to free any internal
584 * resources the module may keep.
586 * @retval SR_OK Success
587 * @retval other Negative error code.
589 int (*cleanup) (struct sr_transform *t);
592 #ifdef HAVE_LIBUSB_1_0
593 /** USB device instance */
594 struct sr_usb_dev_inst {
597 /** Device address on USB bus */
599 /** libusb device handle */
600 struct libusb_device_handle *devhdl;
604 #ifdef HAVE_LIBSERIALPORT
605 struct sr_serial_dev_inst {
606 /** Port name, e.g. '/dev/tty42'. */
608 /** Comm params for serial_set_paramstr(). */
610 /** libserialport port handle */
611 struct sp_port *data;
615 struct sr_usbtmc_dev_inst {
620 /* Private driver context. */
622 /** sigrok context */
623 struct sr_context *sr_ctx;
627 /*--- log.c -----------------------------------------------------------------*/
629 #if defined(G_OS_WIN32) && (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 4))
631 * On MinGW, we need to specify the gnu_printf format flavor or GCC
632 * will assume non-standard Microsoft printf syntax.
634 SR_PRIV int sr_log(int loglevel, const char *format, ...)
635 __attribute__((__format__ (__gnu_printf__, 2, 3)));
637 SR_PRIV int sr_log(int loglevel, const char *format, ...) G_GNUC_PRINTF(2, 3);
640 /* Message logging helpers with subsystem-specific prefix string. */
641 #define sr_spew(...) sr_log(SR_LOG_SPEW, LOG_PREFIX ": " __VA_ARGS__)
642 #define sr_dbg(...) sr_log(SR_LOG_DBG, LOG_PREFIX ": " __VA_ARGS__)
643 #define sr_info(...) sr_log(SR_LOG_INFO, LOG_PREFIX ": " __VA_ARGS__)
644 #define sr_warn(...) sr_log(SR_LOG_WARN, LOG_PREFIX ": " __VA_ARGS__)
645 #define sr_err(...) sr_log(SR_LOG_ERR, LOG_PREFIX ": " __VA_ARGS__)
647 /*--- device.c --------------------------------------------------------------*/
649 /** Values for the changes argument of sr_dev_driver.config_channel_set. */
651 /** The enabled state of the channel has been changed. */
652 SR_CHANNEL_SET_ENABLED = 1 << 0,
655 SR_PRIV struct sr_channel *sr_channel_new(struct sr_dev_inst *sdi,
656 int index, int type, gboolean enabled, const char *name);
657 SR_PRIV struct sr_channel *sr_next_enabled_channel(const struct sr_dev_inst *sdi,
658 struct sr_channel *cur_channel);
660 /** Device instance data */
662 /** Device driver. */
663 struct sr_dev_driver *driver;
664 /** Device instance status. SR_ST_NOT_FOUND, etc. */
666 /** Device instance type. SR_INST_USB, etc. */
668 /** Device vendor. */
672 /** Device version. */
674 /** Serial number. */
676 /** Connection string to uniquely identify devices. */
678 /** List of channels. */
680 /** List of sr_channel_group structs */
681 GSList *channel_groups;
682 /** Device instance connection data (used?) */
684 /** Device instance private data (used?) */
686 /** Session to which this device is currently assigned. */
687 struct sr_session *session;
690 /* Generic device instances */
691 SR_PRIV void sr_dev_inst_free(struct sr_dev_inst *sdi);
693 #ifdef HAVE_LIBUSB_1_0
694 /* USB-specific instances */
695 SR_PRIV struct sr_usb_dev_inst *sr_usb_dev_inst_new(uint8_t bus,
696 uint8_t address, struct libusb_device_handle *hdl);
697 SR_PRIV void sr_usb_dev_inst_free(struct sr_usb_dev_inst *usb);
700 #ifdef HAVE_LIBSERIALPORT
701 /* Serial-specific instances */
702 SR_PRIV struct sr_serial_dev_inst *sr_serial_dev_inst_new(const char *port,
703 const char *serialcomm);
704 SR_PRIV void sr_serial_dev_inst_free(struct sr_serial_dev_inst *serial);
707 /* USBTMC-specific instances */
708 SR_PRIV struct sr_usbtmc_dev_inst *sr_usbtmc_dev_inst_new(const char *device);
709 SR_PRIV void sr_usbtmc_dev_inst_free(struct sr_usbtmc_dev_inst *usbtmc);
711 /*--- hwdriver.c ------------------------------------------------------------*/
713 extern SR_PRIV struct sr_dev_driver **drivers_lists[];
715 SR_PRIV const GVariantType *sr_variant_type_get(int datatype);
716 SR_PRIV int sr_variant_type_check(uint32_t key, GVariant *data);
717 SR_PRIV void sr_hw_cleanup_all(const struct sr_context *ctx);
718 SR_PRIV struct sr_config *sr_config_new(uint32_t key, GVariant *data);
719 SR_PRIV void sr_config_free(struct sr_config *src);
721 /*--- session.c -------------------------------------------------------------*/
724 /** Context this session exists in. */
725 struct sr_context *ctx;
726 /** List of struct sr_dev_inst pointers. */
728 /** List of struct sr_dev_inst pointers owned by this session. */
730 /** List of struct datafeed_callback pointers. */
731 GSList *datafeed_callbacks;
733 struct sr_trigger *trigger;
735 /** Callback to invoke on session stop. */
736 sr_session_stopped_callback stopped_callback;
737 /** User data to be passed to the session stop callback. */
738 void *stopped_cb_data;
740 /** Mutex protecting the main context pointer. */
742 /** Context of the session main loop. */
743 GMainContext *main_context;
745 /** Registered event sources for this session. */
746 GHashTable *event_sources;
747 /** Session main loop. */
748 GMainLoop *main_loop;
749 /** ID of idle source for dispatching the session stop notification. */
750 unsigned int stop_check_id;
751 /** Whether the session has been started. */
755 SR_PRIV int sr_session_source_add_internal(struct sr_session *session,
756 void *key, GSource *source);
757 SR_PRIV int sr_session_source_remove_internal(struct sr_session *session,
759 SR_PRIV int sr_session_source_destroyed(struct sr_session *session,
760 void *key, GSource *source);
761 SR_PRIV int sr_session_fd_source_add(struct sr_session *session,
762 void *key, gintptr fd, int events, int timeout,
763 sr_receive_data_callback cb, void *cb_data);
765 SR_PRIV int sr_session_source_add(struct sr_session *session, int fd,
766 int events, int timeout, sr_receive_data_callback cb, void *cb_data);
767 SR_PRIV int sr_session_source_add_pollfd(struct sr_session *session,
768 GPollFD *pollfd, int timeout, sr_receive_data_callback cb,
770 SR_PRIV int sr_session_source_add_channel(struct sr_session *session,
771 GIOChannel *channel, int events, int timeout,
772 sr_receive_data_callback cb, void *cb_data);
773 SR_PRIV int sr_session_source_remove(struct sr_session *session, int fd);
774 SR_PRIV int sr_session_source_remove_pollfd(struct sr_session *session,
776 SR_PRIV int sr_session_source_remove_channel(struct sr_session *session,
777 GIOChannel *channel);
779 SR_PRIV int sr_session_send(const struct sr_dev_inst *sdi,
780 const struct sr_datafeed_packet *packet);
781 SR_PRIV int sr_sessionfile_check(const char *filename);
782 SR_PRIV int sr_packet_copy(const struct sr_datafeed_packet *packet,
783 struct sr_datafeed_packet **copy);
784 SR_PRIV void sr_packet_free(struct sr_datafeed_packet *packet);
786 /*--- session_file.c --------------------------------------------------------*/
788 #if !HAVE_ZIP_DISCARD
789 /* Replace zip_discard() if not available. */
790 #define zip_discard(zip) sr_zip_discard(zip)
791 SR_PRIV void sr_zip_discard(struct zip *archive);
794 SR_PRIV GKeyFile *sr_sessionfile_read_metadata(struct zip *archive,
795 const struct zip_stat *entry);
797 /*--- analog.c --------------------------------------------------------------*/
799 SR_PRIV int sr_analog_init(struct sr_datafeed_analog *analog,
800 struct sr_analog_encoding *encoding,
801 struct sr_analog_meaning *meaning,
802 struct sr_analog_spec *spec,
805 /*--- std.c -----------------------------------------------------------------*/
807 typedef int (*dev_close_callback)(struct sr_dev_inst *sdi);
808 typedef void (*std_dev_clear_callback)(void *priv);
810 SR_PRIV int std_init(struct sr_context *sr_ctx, struct sr_dev_driver *di,
812 #ifdef HAVE_LIBSERIALPORT
813 SR_PRIV int std_serial_dev_open(struct sr_dev_inst *sdi);
814 SR_PRIV int std_serial_dev_acquisition_stop(struct sr_dev_inst *sdi,
815 void *cb_data, dev_close_callback dev_close_fn,
816 struct sr_serial_dev_inst *serial, const char *prefix);
818 SR_PRIV int std_session_send_df_header(const struct sr_dev_inst *sdi,
820 SR_PRIV int std_dev_clear(const struct sr_dev_driver *driver,
821 std_dev_clear_callback clear_private);
822 SR_PRIV int std_serial_dev_close(struct sr_dev_inst *sdi);
824 /*--- resource.c ------------------------------------------------------------*/
826 SR_PRIV int64_t sr_file_get_size(FILE *file);
828 SR_PRIV int sr_resource_open(struct sr_context *ctx,
829 struct sr_resource *res, int type, const char *name)
830 G_GNUC_WARN_UNUSED_RESULT;
831 SR_PRIV int sr_resource_close(struct sr_context *ctx,
832 struct sr_resource *res);
833 SR_PRIV ssize_t sr_resource_read(struct sr_context *ctx,
834 const struct sr_resource *res, void *buf, size_t count)
835 G_GNUC_WARN_UNUSED_RESULT;
836 SR_PRIV void *sr_resource_load(struct sr_context *ctx, int type,
837 const char *name, size_t *size, size_t max_size)
838 G_GNUC_MALLOC G_GNUC_WARN_UNUSED_RESULT;
840 /*--- strutil.c -------------------------------------------------------------*/
842 SR_PRIV int sr_atol(const char *str, long *ret);
843 SR_PRIV int sr_atoi(const char *str, int *ret);
844 SR_PRIV int sr_atod(const char *str, double *ret);
845 SR_PRIV int sr_atof(const char *str, float *ret);
846 SR_PRIV int sr_atof_ascii(const char *str, float *ret);
848 /*--- soft-trigger.c --------------------------------------------------------*/
850 struct soft_trigger_logic {
851 const struct sr_dev_inst *sdi;
852 const struct sr_trigger *trigger;
856 uint8_t *prev_sample;
857 uint8_t *pre_trigger_buffer;
858 uint8_t *pre_trigger_head;
859 int pre_trigger_size;
860 int pre_trigger_fill;
863 SR_PRIV struct soft_trigger_logic *soft_trigger_logic_new(
864 const struct sr_dev_inst *sdi, struct sr_trigger *trigger,
865 int pre_trigger_samples);
866 SR_PRIV void soft_trigger_logic_free(struct soft_trigger_logic *st);
867 SR_PRIV int soft_trigger_logic_check(struct soft_trigger_logic *st, uint8_t *buf,
868 int len, int *pre_trigger_samples);
870 /*--- hardware/serial.c -----------------------------------------------------*/
872 #ifdef HAVE_LIBSERIALPORT
878 typedef gboolean (*packet_valid_callback)(const uint8_t *buf);
880 SR_PRIV int serial_open(struct sr_serial_dev_inst *serial, int flags);
881 SR_PRIV int serial_close(struct sr_serial_dev_inst *serial);
882 SR_PRIV int serial_flush(struct sr_serial_dev_inst *serial);
883 SR_PRIV int serial_drain(struct sr_serial_dev_inst *serial);
884 SR_PRIV int serial_write_blocking(struct sr_serial_dev_inst *serial,
885 const void *buf, size_t count, unsigned int timeout_ms);
886 SR_PRIV int serial_write_nonblocking(struct sr_serial_dev_inst *serial,
887 const void *buf, size_t count);
888 SR_PRIV int serial_read_blocking(struct sr_serial_dev_inst *serial, void *buf,
889 size_t count, unsigned int timeout_ms);
890 SR_PRIV int serial_read_nonblocking(struct sr_serial_dev_inst *serial, void *buf,
892 SR_PRIV int serial_set_params(struct sr_serial_dev_inst *serial, int baudrate,
893 int bits, int parity, int stopbits, int flowcontrol, int rts, int dtr);
894 SR_PRIV int serial_set_paramstr(struct sr_serial_dev_inst *serial,
895 const char *paramstr);
896 SR_PRIV int serial_readline(struct sr_serial_dev_inst *serial, char **buf,
897 int *buflen, gint64 timeout_ms);
898 SR_PRIV int serial_stream_detect(struct sr_serial_dev_inst *serial,
899 uint8_t *buf, size_t *buflen,
901 packet_valid_callback is_valid,
902 uint64_t timeout_ms, int baudrate);
903 SR_PRIV int sr_serial_extract_options(GSList *options, const char **serial_device,
904 const char **serial_options);
905 SR_PRIV int serial_source_add(struct sr_session *session,
906 struct sr_serial_dev_inst *serial, int events, int timeout,
907 sr_receive_data_callback cb, void *cb_data);
908 SR_PRIV int serial_source_remove(struct sr_session *session,
909 struct sr_serial_dev_inst *serial);
910 SR_PRIV GSList *sr_serial_find_usb(uint16_t vendor_id, uint16_t product_id);
911 SR_PRIV int serial_timeout(struct sr_serial_dev_inst *port, int num_bytes);
914 /*--- hardware/ezusb.c ------------------------------------------------------*/
916 #ifdef HAVE_LIBUSB_1_0
917 SR_PRIV int ezusb_reset(struct libusb_device_handle *hdl, int set_clear);
918 SR_PRIV int ezusb_install_firmware(struct sr_context *ctx, libusb_device_handle *hdl,
920 SR_PRIV int ezusb_upload_firmware(struct sr_context *ctx, libusb_device *dev,
921 int configuration, const char *name);
924 /*--- hardware/usb.c --------------------------------------------------------*/
926 #ifdef HAVE_LIBUSB_1_0
927 SR_PRIV GSList *sr_usb_find(libusb_context *usb_ctx, const char *conn);
928 SR_PRIV int sr_usb_open(libusb_context *usb_ctx, struct sr_usb_dev_inst *usb);
929 SR_PRIV void sr_usb_close(struct sr_usb_dev_inst *usb);
930 SR_PRIV int usb_source_add(struct sr_session *session, struct sr_context *ctx,
931 int timeout, sr_receive_data_callback cb, void *cb_data);
932 SR_PRIV int usb_source_remove(struct sr_session *session, struct sr_context *ctx);
933 SR_PRIV int usb_get_port_path(libusb_device *dev, char *path, int path_len);
937 /*--- modbus/modbus.c -------------------------------------------------------*/
939 struct sr_modbus_dev_inst {
943 GSList *(*scan)(int modbusaddr);
944 int (*dev_inst_new)(void *priv, const char *resource,
945 char **params, const char *serialcomm, int modbusaddr);
946 int (*open)(void *priv);
947 int (*source_add)(struct sr_session *session, void *priv, int events,
948 int timeout, sr_receive_data_callback cb, void *cb_data);
949 int (*source_remove)(struct sr_session *session, void *priv);
950 int (*send)(void *priv, const uint8_t *buffer, int buffer_size);
951 int (*read_begin)(void *priv, uint8_t *function_code);
952 int (*read_data)(void *priv, uint8_t *buf, int maxlen);
953 int (*read_end)(void *priv);
954 int (*close)(void *priv);
955 void (*free)(void *priv);
956 unsigned int read_timeout_ms;
960 SR_PRIV GSList *sr_modbus_scan(struct drv_context *drvc, GSList *options,
961 struct sr_dev_inst *(*probe_device)(struct sr_modbus_dev_inst *modbus));
962 SR_PRIV struct sr_modbus_dev_inst *modbus_dev_inst_new(const char *resource,
963 const char *serialcomm, int modbusaddr);
964 SR_PRIV int sr_modbus_open(struct sr_modbus_dev_inst *modbus);
965 SR_PRIV int sr_modbus_source_add(struct sr_session *session,
966 struct sr_modbus_dev_inst *modbus, int events, int timeout,
967 sr_receive_data_callback cb, void *cb_data);
968 SR_PRIV int sr_modbus_source_remove(struct sr_session *session,
969 struct sr_modbus_dev_inst *modbus);
970 SR_PRIV int sr_modbus_request(struct sr_modbus_dev_inst *modbus,
971 uint8_t *request, int request_size);
972 SR_PRIV int sr_modbus_reply(struct sr_modbus_dev_inst *modbus,
973 uint8_t *reply, int reply_size);
974 SR_PRIV int sr_modbus_request_reply(struct sr_modbus_dev_inst *modbus,
975 uint8_t *request, int request_size,
976 uint8_t *reply, int reply_size);
977 SR_PRIV int sr_modbus_read_coils(struct sr_modbus_dev_inst *modbus,
978 int address, int nb_coils, uint8_t *coils);
979 SR_PRIV int sr_modbus_read_holding_registers(struct sr_modbus_dev_inst *modbus,
980 int address, int nb_registers,
981 uint16_t *registers);
982 SR_PRIV int sr_modbus_write_coil(struct sr_modbus_dev_inst *modbus,
983 int address, int value);
984 SR_PRIV int sr_modbus_write_multiple_registers(struct sr_modbus_dev_inst*modbus,
985 int address, int nb_registers,
986 uint16_t *registers);
987 SR_PRIV int sr_modbus_close(struct sr_modbus_dev_inst *modbus);
988 SR_PRIV void sr_modbus_free(struct sr_modbus_dev_inst *modbus);
990 /*--- hardware/dmm/es519xx.c ------------------------------------------------*/
993 * All 11-byte es519xx chips repeat each block twice for each conversion cycle
994 * so always read 2 blocks at a time.
996 #define ES519XX_11B_PACKET_SIZE (11 * 2)
997 #define ES519XX_14B_PACKET_SIZE 14
999 struct es519xx_info {
1000 gboolean is_judge, is_voltage, is_auto, is_micro, is_current;
1001 gboolean is_milli, is_resistance, is_continuity, is_diode;
1002 gboolean is_frequency, is_rpm, is_capacitance, is_duty_cycle;
1003 gboolean is_temperature, is_celsius, is_fahrenheit;
1004 gboolean is_adp0, is_adp1, is_adp2, is_adp3;
1005 gboolean is_sign, is_batt, is_ol, is_pmax, is_pmin, is_apo;
1006 gboolean is_dc, is_ac, is_vahz, is_min, is_max, is_rel, is_hold;
1007 gboolean is_digit4, is_ul, is_vasel, is_vbar, is_lpf1, is_lpf0, is_rmr;
1010 gboolean alt_functions, fivedigits, clampmeter, selectable_lpf;
1013 SR_PRIV gboolean sr_es519xx_2400_11b_packet_valid(const uint8_t *buf);
1014 SR_PRIV int sr_es519xx_2400_11b_parse(const uint8_t *buf, float *floatval,
1015 struct sr_datafeed_analog_old *analog, void *info);
1016 SR_PRIV gboolean sr_es519xx_2400_11b_altfn_packet_valid(const uint8_t *buf);
1017 SR_PRIV int sr_es519xx_2400_11b_altfn_parse(const uint8_t *buf,
1018 float *floatval, struct sr_datafeed_analog_old *analog, void *info);
1019 SR_PRIV gboolean sr_es519xx_19200_11b_5digits_packet_valid(const uint8_t *buf);
1020 SR_PRIV int sr_es519xx_19200_11b_5digits_parse(const uint8_t *buf,
1021 float *floatval, struct sr_datafeed_analog_old *analog, void *info);
1022 SR_PRIV gboolean sr_es519xx_19200_11b_clamp_packet_valid(const uint8_t *buf);
1023 SR_PRIV int sr_es519xx_19200_11b_clamp_parse(const uint8_t *buf,
1024 float *floatval, struct sr_datafeed_analog_old *analog, void *info);
1025 SR_PRIV gboolean sr_es519xx_19200_11b_packet_valid(const uint8_t *buf);
1026 SR_PRIV int sr_es519xx_19200_11b_parse(const uint8_t *buf, float *floatval,
1027 struct sr_datafeed_analog_old *analog, void *info);
1028 SR_PRIV gboolean sr_es519xx_19200_14b_packet_valid(const uint8_t *buf);
1029 SR_PRIV int sr_es519xx_19200_14b_parse(const uint8_t *buf, float *floatval,
1030 struct sr_datafeed_analog_old *analog, void *info);
1031 SR_PRIV gboolean sr_es519xx_19200_14b_sel_lpf_packet_valid(const uint8_t *buf);
1032 SR_PRIV int sr_es519xx_19200_14b_sel_lpf_parse(const uint8_t *buf,
1033 float *floatval, struct sr_datafeed_analog_old *analog, void *info);
1035 /*--- hardware/dmm/fs9922.c -------------------------------------------------*/
1037 #define FS9922_PACKET_SIZE 14
1039 struct fs9922_info {
1040 gboolean is_auto, is_dc, is_ac, is_rel, is_hold, is_bpn, is_z1, is_z2;
1041 gboolean is_max, is_min, is_apo, is_bat, is_nano, is_z3, is_micro;
1042 gboolean is_milli, is_kilo, is_mega, is_beep, is_diode, is_percent;
1043 gboolean is_z4, is_volt, is_ampere, is_ohm, is_hfe, is_hertz, is_farad;
1044 gboolean is_celsius, is_fahrenheit;
1045 int bargraph_sign, bargraph_value;
1048 SR_PRIV gboolean sr_fs9922_packet_valid(const uint8_t *buf);
1049 SR_PRIV int sr_fs9922_parse(const uint8_t *buf, float *floatval,
1050 struct sr_datafeed_analog_old *analog, void *info);
1051 SR_PRIV void sr_fs9922_z1_diode(struct sr_datafeed_analog_old *analog, void *info);
1053 /*--- hardware/dmm/fs9721.c -------------------------------------------------*/
1055 #define FS9721_PACKET_SIZE 14
1057 struct fs9721_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_c2c1_11, is_c2c1_10, is_c2c1_01, is_c2c1_00, is_sign;
1064 SR_PRIV gboolean sr_fs9721_packet_valid(const uint8_t *buf);
1065 SR_PRIV int sr_fs9721_parse(const uint8_t *buf, float *floatval,
1066 struct sr_datafeed_analog_old *analog, void *info);
1067 SR_PRIV void sr_fs9721_00_temp_c(struct sr_datafeed_analog_old *analog, void *info);
1068 SR_PRIV void sr_fs9721_01_temp_c(struct sr_datafeed_analog_old *analog, void *info);
1069 SR_PRIV void sr_fs9721_10_temp_c(struct sr_datafeed_analog_old *analog, void *info);
1070 SR_PRIV void sr_fs9721_01_10_temp_f_c(struct sr_datafeed_analog_old *analog, void *info);
1071 SR_PRIV void sr_fs9721_max_c_min(struct sr_datafeed_analog_old *analog, void *info);
1073 /*--- hardware/dmm/dtm0660.c ------------------------------------------------*/
1075 #define DTM0660_PACKET_SIZE 15
1077 struct dtm0660_info {
1078 gboolean is_ac, is_dc, is_auto, is_rs232, is_micro, is_nano, is_kilo;
1079 gboolean is_diode, is_milli, is_percent, is_mega, is_beep, is_farad;
1080 gboolean is_ohm, is_rel, is_hold, is_ampere, is_volt, is_hz, is_bat;
1081 gboolean is_degf, is_degc, is_c2c1_01, is_c2c1_00, is_apo, is_min;
1082 gboolean is_minmax, is_max, is_sign;
1085 SR_PRIV gboolean sr_dtm0660_packet_valid(const uint8_t *buf);
1086 SR_PRIV int sr_dtm0660_parse(const uint8_t *buf, float *floatval,
1087 struct sr_datafeed_analog_old *analog, void *info);
1089 /*--- hardware/dmm/m2110.c --------------------------------------------------*/
1091 #define BBCGM_M2110_PACKET_SIZE 9
1093 SR_PRIV gboolean sr_m2110_packet_valid(const uint8_t *buf);
1094 SR_PRIV int sr_m2110_parse(const uint8_t *buf, float *floatval,
1095 struct sr_datafeed_analog_old *analog, void *info);
1097 /*--- hardware/dmm/metex14.c ------------------------------------------------*/
1099 #define METEX14_PACKET_SIZE 14
1101 struct metex14_info {
1102 gboolean is_ac, is_dc, is_resistance, is_capacity, is_temperature;
1103 gboolean is_diode, is_frequency, is_ampere, is_volt, is_farad;
1104 gboolean is_hertz, is_ohm, is_celsius, is_pico, is_nano, is_micro;
1105 gboolean is_milli, is_kilo, is_mega, is_gain, is_decibel, is_hfe;
1106 gboolean is_unitless, is_logic;
1109 #ifdef HAVE_LIBSERIALPORT
1110 SR_PRIV int sr_metex14_packet_request(struct sr_serial_dev_inst *serial);
1112 SR_PRIV gboolean sr_metex14_packet_valid(const uint8_t *buf);
1113 SR_PRIV int sr_metex14_parse(const uint8_t *buf, float *floatval,
1114 struct sr_datafeed_analog_old *analog, void *info);
1116 /*--- hardware/dmm/rs9lcd.c -------------------------------------------------*/
1118 #define RS9LCD_PACKET_SIZE 9
1120 /* Dummy info struct. The parser does not use it. */
1121 struct rs9lcd_info { int dummy; };
1123 SR_PRIV gboolean sr_rs9lcd_packet_valid(const uint8_t *buf);
1124 SR_PRIV int sr_rs9lcd_parse(const uint8_t *buf, float *floatval,
1125 struct sr_datafeed_analog_old *analog, void *info);
1127 /*--- hardware/dmm/bm25x.c --------------------------------------------------*/
1129 #define BRYMEN_BM25X_PACKET_SIZE 15
1131 /* Dummy info struct. The parser does not use it. */
1132 struct bm25x_info { int dummy; };
1134 SR_PRIV gboolean sr_brymen_bm25x_packet_valid(const uint8_t *buf);
1135 SR_PRIV int sr_brymen_bm25x_parse(const uint8_t *buf, float *floatval,
1136 struct sr_datafeed_analog_old *analog, void *info);
1138 /*--- hardware/dmm/ut71x.c --------------------------------------------------*/
1140 #define UT71X_PACKET_SIZE 11
1143 gboolean is_voltage, is_resistance, is_capacitance, is_temperature;
1144 gboolean is_celsius, is_fahrenheit, is_current, is_continuity;
1145 gboolean is_diode, is_frequency, is_duty_cycle, is_dc, is_ac;
1146 gboolean is_auto, is_manual, is_sign, is_power, is_loop_current;
1149 SR_PRIV gboolean sr_ut71x_packet_valid(const uint8_t *buf);
1150 SR_PRIV int sr_ut71x_parse(const uint8_t *buf, float *floatval,
1151 struct sr_datafeed_analog_old *analog, void *info);
1153 /*--- hardware/dmm/vc870.c --------------------------------------------------*/
1155 #define VC870_PACKET_SIZE 23
1158 gboolean is_voltage, is_dc, is_ac, is_temperature, is_resistance;
1159 gboolean is_continuity, is_capacitance, is_diode, is_loop_current;
1160 gboolean is_current, is_micro, is_milli, is_power;
1161 gboolean is_power_factor_freq, is_power_apparent_power, is_v_a_eff_value;
1162 gboolean is_sign2, is_sign1, is_batt, is_ol1, is_max, is_min;
1163 gboolean is_maxmin, is_rel, is_ol2, is_open, is_manu, is_hold;
1164 gboolean is_light, is_usb, is_warning, is_auto_power, is_misplug_warn;
1165 gboolean is_lo, is_hi, is_open2;
1167 gboolean is_frequency, is_dual_display, is_auto, is_rms;
1170 SR_PRIV gboolean sr_vc870_packet_valid(const uint8_t *buf);
1171 SR_PRIV int sr_vc870_parse(const uint8_t *buf, float *floatval,
1172 struct sr_datafeed_analog_old *analog, void *info);
1174 /*--- hardware/lcr/es51919.c ------------------------------------------------*/
1176 SR_PRIV void es51919_serial_clean(void *priv);
1177 SR_PRIV struct sr_dev_inst *es51919_serial_scan(GSList *options,
1180 SR_PRIV int es51919_serial_config_get(uint32_t key, GVariant **data,
1181 const struct sr_dev_inst *sdi,
1182 const struct sr_channel_group *cg);
1183 SR_PRIV int es51919_serial_config_set(uint32_t key, GVariant *data,
1184 const struct sr_dev_inst *sdi,
1185 const struct sr_channel_group *cg);
1186 SR_PRIV int es51919_serial_config_list(uint32_t key, GVariant **data,
1187 const struct sr_dev_inst *sdi,
1188 const struct sr_channel_group *cg);
1189 SR_PRIV int es51919_serial_acquisition_start(const struct sr_dev_inst *sdi,
1191 SR_PRIV int es51919_serial_acquisition_stop(struct sr_dev_inst *sdi,
1194 /*--- hardware/dmm/ut372.c --------------------------------------------------*/
1196 #define UT372_PACKET_SIZE 27
1202 SR_PRIV gboolean sr_ut372_packet_valid(const uint8_t *buf);
1203 SR_PRIV int sr_ut372_parse(const uint8_t *buf, float *floatval,
1204 struct sr_datafeed_analog_old *analog, void *info);
1206 /*--- hardware/scale/kern.c -------------------------------------------------*/
1209 gboolean is_gram, is_carat, is_ounce, is_pound, is_troy_ounce;
1210 gboolean is_pennyweight, is_grain, is_tael, is_momme, is_tola;
1211 gboolean is_percentage, is_piece, is_unstable, is_stable, is_error;
1215 SR_PRIV gboolean sr_kern_packet_valid(const uint8_t *buf);
1216 SR_PRIV int sr_kern_parse(const uint8_t *buf, float *floatval,
1217 struct sr_datafeed_analog_old *analog, void *info);