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 32 bits big endian float out of memory.
121 * @param x a pointer to the input memory
122 * @return the corresponding float
124 #define RBFL(x) ((union { uint32_t u; float f; }) { .u = RB32(x) }.f)
127 * Read a 32 bits little endian float out of memory.
128 * @param x a pointer to the input memory
129 * @return the corresponding float
131 #define RLFL(x) ((union { uint32_t u; float f; }) { .u = RL32(x) }.f)
134 * Write a 8 bits unsigned integer to memory.
135 * @param p a pointer to the output memory
136 * @param x the input unsigned integer
138 #define W8(p, x) do { ((uint8_t*)(p))[0] = (uint8_t) (x); } while (0)
141 * Write a 16 bits unsigned integer to memory stored as big endian.
142 * @param p a pointer to the output memory
143 * @param x the input unsigned integer
145 #define WB16(p, x) do { ((uint8_t*)(p))[1] = (uint8_t) (x); \
146 ((uint8_t*)(p))[0] = (uint8_t)((x)>>8); } while (0)
149 * Write a 16 bits unsigned integer to memory stored as little endian.
150 * @param p a pointer to the output memory
151 * @param x the input unsigned integer
153 #define WL16(p, x) do { ((uint8_t*)(p))[0] = (uint8_t) (x); \
154 ((uint8_t*)(p))[1] = (uint8_t)((x)>>8); } while (0)
157 * Write a 32 bits unsigned integer to memory stored as big endian.
158 * @param p a pointer to the output memory
159 * @param x the input unsigned integer
161 #define WB32(p, x) do { ((uint8_t*)(p))[3] = (uint8_t) (x); \
162 ((uint8_t*)(p))[2] = (uint8_t)((x)>>8); \
163 ((uint8_t*)(p))[1] = (uint8_t)((x)>>16); \
164 ((uint8_t*)(p))[0] = (uint8_t)((x)>>24); } while (0)
167 * Write a 32 bits unsigned integer to memory stored as little endian.
168 * @param p a pointer to the output memory
169 * @param x the input unsigned integer
171 #define WL32(p, x) do { ((uint8_t*)(p))[0] = (uint8_t) (x); \
172 ((uint8_t*)(p))[1] = (uint8_t)((x)>>8); \
173 ((uint8_t*)(p))[2] = (uint8_t)((x)>>16); \
174 ((uint8_t*)(p))[3] = (uint8_t)((x)>>24); } while (0)
177 * Write a 32 bits float to memory stored as big endian.
178 * @param p a pointer to the output memory
179 * @param x the input float
181 #define WBFL(p, x) WB32(p, (union { uint32_t u; float f; }) { .f = x }.u)
184 * Write a 32 bits float to memory stored as little endian.
185 * @param p a pointer to the output memory
186 * @param x the input float
188 #define WLFL(p, x) WL32(p, (union { uint32_t u; float f; }) { .f = x }.u)
190 /* Portability fixes for FreeBSD. */
192 #define LIBUSB_CLASS_APPLICATION 0xfe
193 #define libusb_has_capability(x) 0
194 #define libusb_handle_events_timeout_completed(ctx, tv, c) \
195 libusb_handle_events_timeout(ctx, tv)
198 /* Static definitions of structs ending with an all-zero entry are a
199 * problem when compiling with -Wmissing-field-initializers: GCC
200 * suppresses the warning only with { 0 }, clang wants { } */
204 #define ALL_ZERO { 0 }
208 struct sr_dev_driver **driver_list;
209 #ifdef HAVE_LIBUSB_1_0
210 libusb_context *libusb_ctx;
212 sr_resource_open_callback resource_open_cb;
213 sr_resource_close_callback resource_close_cb;
214 sr_resource_read_callback resource_read_cb;
215 void *resource_cb_data;
218 /** Input module metadata keys. */
219 enum sr_input_meta_keys {
220 /** The input filename, if there is one. */
221 SR_INPUT_META_FILENAME = 0x01,
222 /** The input file's size in bytes. */
223 SR_INPUT_META_FILESIZE = 0x02,
224 /** The first 128 bytes of the file, provided as a GString. */
225 SR_INPUT_META_HEADER = 0x04,
226 /** The file's MIME type. */
227 SR_INPUT_META_MIMETYPE = 0x08,
229 /** The module cannot identify a file without this metadata. */
230 SR_INPUT_META_REQUIRED = 0x80,
233 /** Input (file) module struct. */
236 * A pointer to this input module's 'struct sr_input_module'.
238 const struct sr_input_module *module;
240 struct sr_dev_inst *sdi;
245 /** Input (file) module driver. */
246 struct sr_input_module {
248 * A unique ID for this input module, suitable for use in command-line
249 * clients, [a-z0-9-]. Must not be NULL.
254 * A unique name for this input module, suitable for use in GUI
255 * clients, can contain UTF-8. Must not be NULL.
260 * A short description of the input module. Must not be NULL.
262 * This can be displayed by frontends, e.g. when selecting the input
263 * module for saving a file.
268 * A NULL terminated array of strings containing a list of file name
269 * extensions typical for the input file format, or NULL if there is
270 * no typical extension for this file format.
272 const char *const *exts;
275 * Zero-terminated list of metadata items the module needs to be able
276 * to identify an input stream. Can be all-zero, if the module cannot
277 * identify streams at all, i.e. has to be forced into use.
279 * Each item is one of:
280 * SR_INPUT_META_FILENAME
281 * SR_INPUT_META_FILESIZE
282 * SR_INPUT_META_HEADER
283 * SR_INPUT_META_MIMETYPE
285 * If the high bit (SR_INPUT META_REQUIRED) is set, the module cannot
286 * identify a stream without the given metadata.
288 const uint8_t metadata[8];
291 * Returns a NULL-terminated list of options this module can take.
292 * Can be NULL, if the module has no options.
294 struct sr_option *(*options) (void);
297 * Check if this input module can load and parse the specified stream.
299 * @param[in] metadata Metadata the module can use to identify the stream.
301 * @retval SR_OK This module knows the format.
302 * @retval SR_ERR_NA There wasn't enough data for this module to
303 * positively identify the format.
304 * @retval SR_ERR_DATA This module knows the format, but cannot handle it.
305 * This means the stream is either corrupt, or indicates a feature
306 * that the module does not support.
307 * @retval SR_ERR This module does not know the format.
309 int (*format_match) (GHashTable *metadata);
312 * Initialize the input module.
314 * @retval SR_OK Success
315 * @retval other Negative error code.
317 int (*init) (struct sr_input *in, GHashTable *options);
320 * Send data to the specified input instance.
322 * When an input module instance is created with sr_input_new(), this
323 * function is used to feed data to the instance.
325 * As enough data gets fed into this function to completely populate
326 * the device instance associated with this input instance, this is
327 * guaranteed to return the moment it's ready. This gives the caller
328 * the chance to examine the device instance, attach session callbacks
331 * @retval SR_OK Success
332 * @retval other Negative error code.
334 int (*receive) (struct sr_input *in, GString *buf);
337 * Signal the input module no more data will come.
339 * This will cause the module to process any data it may have buffered.
340 * The SR_DF_END packet will also typically be sent at this time.
342 int (*end) (struct sr_input *in);
345 * This function is called after the caller is finished using
346 * the input module, and can be used to free any internal
347 * resources the module may keep.
349 * This function is optional.
351 * @retval SR_OK Success
352 * @retval other Negative error code.
354 void (*cleanup) (struct sr_input *in);
357 /** Output module instance. */
359 /** A pointer to this output's module. */
360 const struct sr_output_module *module;
363 * The device for which this output module is creating output. This
364 * can be used by the module to find out channel names and numbers.
366 const struct sr_dev_inst *sdi;
369 * The name of the file that the data should be written to.
371 const char *filename;
374 * A generic pointer which can be used by the module to keep internal
375 * state between calls into its callback functions.
377 * For example, the module might store a pointer to a chunk of output
378 * there, and only flush it when it reaches a certain size.
383 /** Output module driver. */
384 struct sr_output_module {
386 * A unique ID for this output module, suitable for use in command-line
387 * clients, [a-z0-9-]. Must not be NULL.
392 * A unique name for this output module, suitable for use in GUI
393 * clients, can contain UTF-8. Must not be NULL.
398 * A short description of the output module. Must not be NULL.
400 * This can be displayed by frontends, e.g. when selecting the output
401 * module for saving a file.
406 * A NULL terminated array of strings containing a list of file name
407 * extensions typical for the input file format, or NULL if there is
408 * no typical extension for this file format.
410 const char *const *exts;
413 * Bitfield containing flags that describe certain properties
414 * this output module may or may not have.
415 * @see sr_output_flags
417 const uint64_t flags;
420 * Returns a NULL-terminated list of options this module can take.
421 * Can be NULL, if the module has no options.
423 const struct sr_option *(*options) (void);
426 * This function is called once, at the beginning of an output stream.
428 * The device struct will be available in the output struct passed in,
429 * as well as the param field -- which may be NULL or an empty string,
430 * if no parameter was passed.
432 * The module can use this to initialize itself, create a struct for
433 * keeping state and storing it in the <code>internal</code> field.
435 * @param o Pointer to the respective 'struct sr_output'.
437 * @retval SR_OK Success
438 * @retval other Negative error code.
440 int (*init) (struct sr_output *o, GHashTable *options);
443 * This function is passed a copy of every packet in the data feed.
444 * Any output generated by the output module in response to the
445 * packet should be returned in a newly allocated GString
446 * <code>out</code>, which will be freed by the caller.
448 * Packets not of interest to the output module can just be ignored,
449 * and the <code>out</code> parameter set to NULL.
451 * @param o Pointer to the respective 'struct sr_output'.
452 * @param sdi The device instance that generated the packet.
453 * @param packet The complete packet.
454 * @param out A pointer where a GString * should be stored if
455 * the module generates output, or NULL if not.
457 * @retval SR_OK Success
458 * @retval other Negative error code.
460 int (*receive) (const struct sr_output *o,
461 const struct sr_datafeed_packet *packet, GString **out);
464 * This function is called after the caller is finished using
465 * the output module, and can be used to free any internal
466 * resources the module may keep.
468 * @retval SR_OK Success
469 * @retval other Negative error code.
471 int (*cleanup) (struct sr_output *o);
474 /** Transform module instance. */
475 struct sr_transform {
476 /** A pointer to this transform's module. */
477 const struct sr_transform_module *module;
480 * The device for which this transform module is used. This
481 * can be used by the module to find out channel names and numbers.
483 const struct sr_dev_inst *sdi;
486 * A generic pointer which can be used by the module to keep internal
487 * state between calls into its callback functions.
492 struct sr_transform_module {
494 * A unique ID for this transform module, suitable for use in
495 * command-line clients, [a-z0-9-]. Must not be NULL.
500 * A unique name for this transform module, suitable for use in GUI
501 * clients, can contain UTF-8. Must not be NULL.
506 * A short description of the transform module. Must not be NULL.
508 * This can be displayed by frontends, e.g. when selecting
509 * which transform module(s) to add.
514 * Returns a NULL-terminated list of options this transform module
515 * can take. Can be NULL, if the transform module has no options.
517 const struct sr_option *(*options) (void);
520 * This function is called once, at the beginning of a stream.
522 * @param t Pointer to the respective 'struct sr_transform'.
523 * @param options Hash table of options for this transform module.
524 * Can be NULL if no options are to be used.
526 * @retval SR_OK Success
527 * @retval other Negative error code.
529 int (*init) (struct sr_transform *t, GHashTable *options);
532 * This function is passed a pointer to every packet in the data feed.
534 * It can either return (in packet_out) a pointer to another packet
535 * (possibly the exact same packet it got as input), or NULL.
537 * @param t Pointer to the respective 'struct sr_transform'.
538 * @param packet_in Pointer to a datafeed packet.
539 * @param packet_out Pointer to the resulting datafeed packet after
540 * this function was run. If NULL, the transform
541 * module intentionally didn't output a new packet.
543 * @retval SR_OK Success
544 * @retval other Negative error code.
546 int (*receive) (const struct sr_transform *t,
547 struct sr_datafeed_packet *packet_in,
548 struct sr_datafeed_packet **packet_out);
551 * This function is called after the caller is finished using
552 * the transform module, and can be used to free any internal
553 * resources the module may keep.
555 * @retval SR_OK Success
556 * @retval other Negative error code.
558 int (*cleanup) (struct sr_transform *t);
561 #ifdef HAVE_LIBUSB_1_0
562 /** USB device instance */
563 struct sr_usb_dev_inst {
566 /** Device address on USB bus */
568 /** libusb device handle */
569 struct libusb_device_handle *devhdl;
573 #ifdef HAVE_LIBSERIALPORT
574 struct sr_serial_dev_inst {
575 /** Port name, e.g. '/dev/tty42'. */
577 /** Comm params for serial_set_paramstr(). */
579 /** libserialport port handle */
580 struct sp_port *data;
584 struct sr_usbtmc_dev_inst {
589 /* Private driver context. */
591 /** sigrok context */
592 struct sr_context *sr_ctx;
596 /*--- log.c -----------------------------------------------------------------*/
598 #if defined(G_OS_WIN32) && (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 4))
600 * On MinGW, we need to specify the gnu_printf format flavor or GCC
601 * will assume non-standard Microsoft printf syntax.
603 SR_PRIV int sr_log(int loglevel, const char *format, ...)
604 __attribute__((__format__ (__gnu_printf__, 2, 3)));
606 SR_PRIV int sr_log(int loglevel, const char *format, ...) G_GNUC_PRINTF(2, 3);
609 /* Message logging helpers with subsystem-specific prefix string. */
610 #define sr_spew(...) sr_log(SR_LOG_SPEW, LOG_PREFIX ": " __VA_ARGS__)
611 #define sr_dbg(...) sr_log(SR_LOG_DBG, LOG_PREFIX ": " __VA_ARGS__)
612 #define sr_info(...) sr_log(SR_LOG_INFO, LOG_PREFIX ": " __VA_ARGS__)
613 #define sr_warn(...) sr_log(SR_LOG_WARN, LOG_PREFIX ": " __VA_ARGS__)
614 #define sr_err(...) sr_log(SR_LOG_ERR, LOG_PREFIX ": " __VA_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);
690 /*--- session.c -------------------------------------------------------------*/
693 /** Context this session exists in. */
694 struct sr_context *ctx;
695 /** List of struct sr_dev_inst pointers. */
697 /** List of struct sr_dev_inst pointers owned by this session. */
699 /** List of struct datafeed_callback pointers. */
700 GSList *datafeed_callbacks;
702 struct sr_trigger *trigger;
704 /** Callback to invoke on session stop. */
705 sr_session_stopped_callback stopped_callback;
706 /** User data to be passed to the session stop callback. */
707 void *stopped_cb_data;
709 /** Mutex protecting the main context pointer and ownership flag. */
711 /** Context of the session main loop. */
712 GMainContext *main_context;
713 /** Whether we are using the thread's default context. */
714 gboolean main_context_is_default;
716 /** Whether the session has been started. */
719 /** Registered event sources for this session. */
720 GHashTable *event_sources;
721 /** Session main loop. */
722 GMainLoop *main_loop;
723 /** ID of idle source for dispatching the session stop notification. */
724 unsigned int stop_check_id;
727 SR_PRIV int sr_session_source_add_internal(struct sr_session *session,
728 void *key, GSource *source);
729 SR_PRIV int sr_session_source_remove_internal(struct sr_session *session,
731 SR_PRIV int sr_session_source_destroyed(struct sr_session *session,
732 void *key, GSource *source);
733 SR_PRIV int sr_session_fd_source_add(struct sr_session *session,
734 void *key, gintptr fd, int events, int timeout,
735 sr_receive_data_callback cb, void *cb_data);
736 SR_PRIV int sr_session_send(const struct sr_dev_inst *sdi,
737 const struct sr_datafeed_packet *packet);
738 SR_PRIV int sr_sessionfile_check(const char *filename);
739 SR_PRIV int sr_packet_copy(const struct sr_datafeed_packet *packet,
740 struct sr_datafeed_packet **copy);
741 SR_PRIV void sr_packet_free(struct sr_datafeed_packet *packet);
743 /*--- session_file.c --------------------------------------------------------*/
745 SR_PRIV GKeyFile *sr_sessionfile_read_metadata(struct zip *archive,
746 const struct zip_stat *entry);
748 /*--- analog.c --------------------------------------------------------------*/
750 SR_PRIV int sr_analog_init(struct sr_datafeed_analog2 *analog,
751 struct sr_analog_encoding *encoding,
752 struct sr_analog_meaning *meaning,
753 struct sr_analog_spec *spec,
756 /*--- std.c -----------------------------------------------------------------*/
758 typedef int (*dev_close_callback)(struct sr_dev_inst *sdi);
759 typedef void (*std_dev_clear_callback)(void *priv);
761 SR_PRIV int std_init(struct sr_context *sr_ctx, struct sr_dev_driver *di,
763 #ifdef HAVE_LIBSERIALPORT
764 SR_PRIV int std_serial_dev_open(struct sr_dev_inst *sdi);
765 SR_PRIV int std_serial_dev_acquisition_stop(struct sr_dev_inst *sdi,
766 void *cb_data, dev_close_callback dev_close_fn,
767 struct sr_serial_dev_inst *serial, const char *prefix);
769 SR_PRIV int std_session_send_df_header(const struct sr_dev_inst *sdi,
771 SR_PRIV int std_dev_clear(const struct sr_dev_driver *driver,
772 std_dev_clear_callback clear_private);
773 SR_PRIV int std_serial_dev_close(struct sr_dev_inst *sdi);
775 /*--- resource.c ------------------------------------------------------------*/
777 SR_PRIV int64_t sr_file_get_size(FILE *file);
779 SR_PRIV int sr_resource_open(struct sr_context *ctx,
780 struct sr_resource *res, int type, const char *name)
781 G_GNUC_WARN_UNUSED_RESULT;
782 SR_PRIV int sr_resource_close(struct sr_context *ctx,
783 struct sr_resource *res);
784 SR_PRIV ssize_t sr_resource_read(struct sr_context *ctx,
785 const struct sr_resource *res, void *buf, size_t count)
786 G_GNUC_WARN_UNUSED_RESULT;
787 SR_PRIV void *sr_resource_load(struct sr_context *ctx, int type,
788 const char *name, size_t *size, size_t max_size)
789 G_GNUC_MALLOC G_GNUC_WARN_UNUSED_RESULT;
791 /*--- strutil.c -------------------------------------------------------------*/
793 SR_PRIV int sr_atol(const char *str, long *ret);
794 SR_PRIV int sr_atoi(const char *str, int *ret);
795 SR_PRIV int sr_atod(const char *str, double *ret);
796 SR_PRIV int sr_atof(const char *str, float *ret);
797 SR_PRIV int sr_atof_ascii(const char *str, float *ret);
799 /*--- soft-trigger.c --------------------------------------------------------*/
801 struct soft_trigger_logic {
802 const struct sr_dev_inst *sdi;
803 const struct sr_trigger *trigger;
807 uint8_t *prev_sample;
808 uint8_t *pre_trigger_buffer;
809 uint8_t *pre_trigger_head;
810 int pre_trigger_size;
811 int pre_trigger_fill;
814 SR_PRIV struct soft_trigger_logic *soft_trigger_logic_new(
815 const struct sr_dev_inst *sdi, struct sr_trigger *trigger,
816 int pre_trigger_samples);
817 SR_PRIV void soft_trigger_logic_free(struct soft_trigger_logic *st);
818 SR_PRIV int soft_trigger_logic_check(struct soft_trigger_logic *st, uint8_t *buf,
819 int len, int *pre_trigger_samples);
821 /*--- hardware/serial.c -----------------------------------------------------*/
823 #ifdef HAVE_LIBSERIALPORT
829 typedef gboolean (*packet_valid_callback)(const uint8_t *buf);
831 SR_PRIV int serial_open(struct sr_serial_dev_inst *serial, int flags);
832 SR_PRIV int serial_close(struct sr_serial_dev_inst *serial);
833 SR_PRIV int serial_flush(struct sr_serial_dev_inst *serial);
834 SR_PRIV int serial_drain(struct sr_serial_dev_inst *serial);
835 SR_PRIV int serial_write_blocking(struct sr_serial_dev_inst *serial,
836 const void *buf, size_t count, unsigned int timeout_ms);
837 SR_PRIV int serial_write_nonblocking(struct sr_serial_dev_inst *serial,
838 const void *buf, size_t count);
839 SR_PRIV int serial_read_blocking(struct sr_serial_dev_inst *serial, void *buf,
840 size_t count, unsigned int timeout_ms);
841 SR_PRIV int serial_read_nonblocking(struct sr_serial_dev_inst *serial, void *buf,
843 SR_PRIV int serial_set_params(struct sr_serial_dev_inst *serial, int baudrate,
844 int bits, int parity, int stopbits, int flowcontrol, int rts, int dtr);
845 SR_PRIV int serial_set_paramstr(struct sr_serial_dev_inst *serial,
846 const char *paramstr);
847 SR_PRIV int serial_readline(struct sr_serial_dev_inst *serial, char **buf,
848 int *buflen, gint64 timeout_ms);
849 SR_PRIV int serial_stream_detect(struct sr_serial_dev_inst *serial,
850 uint8_t *buf, size_t *buflen,
852 packet_valid_callback is_valid,
853 uint64_t timeout_ms, int baudrate);
854 SR_PRIV int sr_serial_extract_options(GSList *options, const char **serial_device,
855 const char **serial_options);
856 SR_PRIV int serial_source_add(struct sr_session *session,
857 struct sr_serial_dev_inst *serial, int events, int timeout,
858 sr_receive_data_callback cb, void *cb_data);
859 SR_PRIV int serial_source_remove(struct sr_session *session,
860 struct sr_serial_dev_inst *serial);
861 SR_PRIV GSList *sr_serial_find_usb(uint16_t vendor_id, uint16_t product_id);
862 SR_PRIV int serial_timeout(struct sr_serial_dev_inst *port, int num_bytes);
865 /*--- hardware/ezusb.c ------------------------------------------------------*/
867 #ifdef HAVE_LIBUSB_1_0
868 SR_PRIV int ezusb_reset(struct libusb_device_handle *hdl, int set_clear);
869 SR_PRIV int ezusb_install_firmware(struct sr_context *ctx, libusb_device_handle *hdl,
871 SR_PRIV int ezusb_upload_firmware(struct sr_context *ctx, libusb_device *dev,
872 int configuration, const char *name);
875 /*--- hardware/usb.c --------------------------------------------------------*/
877 #ifdef HAVE_LIBUSB_1_0
878 SR_PRIV GSList *sr_usb_find(libusb_context *usb_ctx, const char *conn);
879 SR_PRIV int sr_usb_open(libusb_context *usb_ctx, struct sr_usb_dev_inst *usb);
880 SR_PRIV void sr_usb_close(struct sr_usb_dev_inst *usb);
881 SR_PRIV int usb_source_add(struct sr_session *session, struct sr_context *ctx,
882 int timeout, sr_receive_data_callback cb, void *cb_data);
883 SR_PRIV int usb_source_remove(struct sr_session *session, struct sr_context *ctx);
884 SR_PRIV int usb_get_port_path(libusb_device *dev, char *path, int path_len);
888 /*--- modbus/modbus.c -------------------------------------------------------*/
890 struct sr_modbus_dev_inst {
894 GSList *(*scan)(int modbusaddr);
895 int (*dev_inst_new)(void *priv, const char *resource,
896 char **params, const char *serialcomm, int modbusaddr);
897 int (*open)(void *priv);
898 int (*source_add)(struct sr_session *session, void *priv, int events,
899 int timeout, sr_receive_data_callback cb, void *cb_data);
900 int (*source_remove)(struct sr_session *session, void *priv);
901 int (*send)(void *priv, const uint8_t *buffer, int buffer_size);
902 int (*read_begin)(void *priv, uint8_t *function_code);
903 int (*read_data)(void *priv, uint8_t *buf, int maxlen);
904 int (*read_end)(void *priv);
905 int (*close)(void *priv);
906 void (*free)(void *priv);
907 unsigned int read_timeout_ms;
911 SR_PRIV GSList *sr_modbus_scan(struct drv_context *drvc, GSList *options,
912 struct sr_dev_inst *(*probe_device)(struct sr_modbus_dev_inst *modbus));
913 SR_PRIV struct sr_modbus_dev_inst *modbus_dev_inst_new(const char *resource,
914 const char *serialcomm, int modbusaddr);
915 SR_PRIV int sr_modbus_open(struct sr_modbus_dev_inst *modbus);
916 SR_PRIV int sr_modbus_source_add(struct sr_session *session,
917 struct sr_modbus_dev_inst *modbus, int events, int timeout,
918 sr_receive_data_callback cb, void *cb_data);
919 SR_PRIV int sr_modbus_source_remove(struct sr_session *session,
920 struct sr_modbus_dev_inst *modbus);
921 SR_PRIV int sr_modbus_request(struct sr_modbus_dev_inst *modbus,
922 uint8_t *request, int request_size);
923 SR_PRIV int sr_modbus_reply(struct sr_modbus_dev_inst *modbus,
924 uint8_t *reply, int reply_size);
925 SR_PRIV int sr_modbus_request_reply(struct sr_modbus_dev_inst *modbus,
926 uint8_t *request, int request_size,
927 uint8_t *reply, int reply_size);
928 SR_PRIV int sr_modbus_read_coils(struct sr_modbus_dev_inst *modbus,
929 int address, int nb_coils, uint8_t *coils);
930 SR_PRIV int sr_modbus_read_holding_registers(struct sr_modbus_dev_inst *modbus,
931 int address, int nb_registers,
932 uint16_t *registers);
933 SR_PRIV int sr_modbus_write_coil(struct sr_modbus_dev_inst *modbus,
934 int address, int value);
935 SR_PRIV int sr_modbus_write_multiple_registers(struct sr_modbus_dev_inst*modbus,
936 int address, int nb_registers,
937 uint16_t *registers);
938 SR_PRIV int sr_modbus_close(struct sr_modbus_dev_inst *modbus);
939 SR_PRIV void sr_modbus_free(struct sr_modbus_dev_inst *modbus);
941 /*--- hardware/dmm/es519xx.c ------------------------------------------------*/
944 * All 11-byte es519xx chips repeat each block twice for each conversion cycle
945 * so always read 2 blocks at a time.
947 #define ES519XX_11B_PACKET_SIZE (11 * 2)
948 #define ES519XX_14B_PACKET_SIZE 14
950 struct es519xx_info {
951 gboolean is_judge, is_voltage, is_auto, is_micro, is_current;
952 gboolean is_milli, is_resistance, is_continuity, is_diode;
953 gboolean is_frequency, is_rpm, is_capacitance, is_duty_cycle;
954 gboolean is_temperature, is_celsius, is_fahrenheit;
955 gboolean is_adp0, is_adp1, is_adp2, is_adp3;
956 gboolean is_sign, is_batt, is_ol, is_pmax, is_pmin, is_apo;
957 gboolean is_dc, is_ac, is_vahz, is_min, is_max, is_rel, is_hold;
958 gboolean is_digit4, is_ul, is_vasel, is_vbar, is_lpf1, is_lpf0, is_rmr;
961 gboolean alt_functions, fivedigits, clampmeter, selectable_lpf;
964 SR_PRIV gboolean sr_es519xx_2400_11b_packet_valid(const uint8_t *buf);
965 SR_PRIV int sr_es519xx_2400_11b_parse(const uint8_t *buf, float *floatval,
966 struct sr_datafeed_analog *analog, void *info);
967 SR_PRIV gboolean sr_es519xx_2400_11b_altfn_packet_valid(const uint8_t *buf);
968 SR_PRIV int sr_es519xx_2400_11b_altfn_parse(const uint8_t *buf,
969 float *floatval, struct sr_datafeed_analog *analog, void *info);
970 SR_PRIV gboolean sr_es519xx_19200_11b_5digits_packet_valid(const uint8_t *buf);
971 SR_PRIV int sr_es519xx_19200_11b_5digits_parse(const uint8_t *buf,
972 float *floatval, struct sr_datafeed_analog *analog, void *info);
973 SR_PRIV gboolean sr_es519xx_19200_11b_clamp_packet_valid(const uint8_t *buf);
974 SR_PRIV int sr_es519xx_19200_11b_clamp_parse(const uint8_t *buf,
975 float *floatval, struct sr_datafeed_analog *analog, void *info);
976 SR_PRIV gboolean sr_es519xx_19200_11b_packet_valid(const uint8_t *buf);
977 SR_PRIV int sr_es519xx_19200_11b_parse(const uint8_t *buf, float *floatval,
978 struct sr_datafeed_analog *analog, void *info);
979 SR_PRIV gboolean sr_es519xx_19200_14b_packet_valid(const uint8_t *buf);
980 SR_PRIV int sr_es519xx_19200_14b_parse(const uint8_t *buf, float *floatval,
981 struct sr_datafeed_analog *analog, void *info);
982 SR_PRIV gboolean sr_es519xx_19200_14b_sel_lpf_packet_valid(const uint8_t *buf);
983 SR_PRIV int sr_es519xx_19200_14b_sel_lpf_parse(const uint8_t *buf,
984 float *floatval, struct sr_datafeed_analog *analog, void *info);
986 /*--- hardware/dmm/fs9922.c -------------------------------------------------*/
988 #define FS9922_PACKET_SIZE 14
991 gboolean is_auto, is_dc, is_ac, is_rel, is_hold, is_bpn, is_z1, is_z2;
992 gboolean is_max, is_min, is_apo, is_bat, is_nano, is_z3, is_micro;
993 gboolean is_milli, is_kilo, is_mega, is_beep, is_diode, is_percent;
994 gboolean is_z4, is_volt, is_ampere, is_ohm, is_hfe, is_hertz, is_farad;
995 gboolean is_celsius, is_fahrenheit;
996 int bargraph_sign, bargraph_value;
999 SR_PRIV gboolean sr_fs9922_packet_valid(const uint8_t *buf);
1000 SR_PRIV int sr_fs9922_parse(const uint8_t *buf, float *floatval,
1001 struct sr_datafeed_analog *analog, void *info);
1002 SR_PRIV void sr_fs9922_z1_diode(struct sr_datafeed_analog *analog, void *info);
1004 /*--- hardware/dmm/fs9721.c -------------------------------------------------*/
1006 #define FS9721_PACKET_SIZE 14
1008 struct fs9721_info {
1009 gboolean is_ac, is_dc, is_auto, is_rs232, is_micro, is_nano, is_kilo;
1010 gboolean is_diode, is_milli, is_percent, is_mega, is_beep, is_farad;
1011 gboolean is_ohm, is_rel, is_hold, is_ampere, is_volt, is_hz, is_bat;
1012 gboolean is_c2c1_11, is_c2c1_10, is_c2c1_01, is_c2c1_00, is_sign;
1015 SR_PRIV gboolean sr_fs9721_packet_valid(const uint8_t *buf);
1016 SR_PRIV int sr_fs9721_parse(const uint8_t *buf, float *floatval,
1017 struct sr_datafeed_analog *analog, void *info);
1018 SR_PRIV void sr_fs9721_00_temp_c(struct sr_datafeed_analog *analog, void *info);
1019 SR_PRIV void sr_fs9721_01_temp_c(struct sr_datafeed_analog *analog, void *info);
1020 SR_PRIV void sr_fs9721_10_temp_c(struct sr_datafeed_analog *analog, void *info);
1021 SR_PRIV void sr_fs9721_01_10_temp_f_c(struct sr_datafeed_analog *analog, void *info);
1022 SR_PRIV void sr_fs9721_max_c_min(struct sr_datafeed_analog *analog, void *info);
1024 /*--- hardware/dmm/m2110.c --------------------------------------------------*/
1026 #define BBCGM_M2110_PACKET_SIZE 9
1028 SR_PRIV gboolean sr_m2110_packet_valid(const uint8_t *buf);
1029 SR_PRIV int sr_m2110_parse(const uint8_t *buf, float *floatval,
1030 struct sr_datafeed_analog *analog, void *info);
1032 /*--- hardware/dmm/metex14.c ------------------------------------------------*/
1034 #define METEX14_PACKET_SIZE 14
1036 struct metex14_info {
1037 gboolean is_ac, is_dc, is_resistance, is_capacity, is_temperature;
1038 gboolean is_diode, is_frequency, is_ampere, is_volt, is_farad;
1039 gboolean is_hertz, is_ohm, is_celsius, is_pico, is_nano, is_micro;
1040 gboolean is_milli, is_kilo, is_mega, is_gain, is_decibel, is_hfe;
1041 gboolean is_unitless, is_logic;
1044 #ifdef HAVE_LIBSERIALPORT
1045 SR_PRIV int sr_metex14_packet_request(struct sr_serial_dev_inst *serial);
1047 SR_PRIV gboolean sr_metex14_packet_valid(const uint8_t *buf);
1048 SR_PRIV int sr_metex14_parse(const uint8_t *buf, float *floatval,
1049 struct sr_datafeed_analog *analog, void *info);
1051 /*--- hardware/dmm/rs9lcd.c -------------------------------------------------*/
1053 #define RS9LCD_PACKET_SIZE 9
1055 /* Dummy info struct. The parser does not use it. */
1056 struct rs9lcd_info { int dummy; };
1058 SR_PRIV gboolean sr_rs9lcd_packet_valid(const uint8_t *buf);
1059 SR_PRIV int sr_rs9lcd_parse(const uint8_t *buf, float *floatval,
1060 struct sr_datafeed_analog *analog, void *info);
1062 /*--- hardware/dmm/bm25x.c --------------------------------------------------*/
1064 #define BRYMEN_BM25X_PACKET_SIZE 15
1066 /* Dummy info struct. The parser does not use it. */
1067 struct bm25x_info { int dummy; };
1069 SR_PRIV gboolean sr_brymen_bm25x_packet_valid(const uint8_t *buf);
1070 SR_PRIV int sr_brymen_bm25x_parse(const uint8_t *buf, float *floatval,
1071 struct sr_datafeed_analog *analog, void *info);
1073 /*--- hardware/dmm/ut71x.c --------------------------------------------------*/
1075 #define UT71X_PACKET_SIZE 11
1078 gboolean is_voltage, is_resistance, is_capacitance, is_temperature;
1079 gboolean is_celsius, is_fahrenheit, is_current, is_continuity;
1080 gboolean is_diode, is_frequency, is_duty_cycle, is_dc, is_ac;
1081 gboolean is_auto, is_manual, is_sign, is_power, is_loop_current;
1084 SR_PRIV gboolean sr_ut71x_packet_valid(const uint8_t *buf);
1085 SR_PRIV int sr_ut71x_parse(const uint8_t *buf, float *floatval,
1086 struct sr_datafeed_analog *analog, void *info);
1088 /*--- hardware/dmm/vc870.c --------------------------------------------------*/
1090 #define VC870_PACKET_SIZE 23
1093 gboolean is_voltage, is_dc, is_ac, is_temperature, is_resistance;
1094 gboolean is_continuity, is_capacitance, is_diode, is_loop_current;
1095 gboolean is_current, is_micro, is_milli, is_power;
1096 gboolean is_power_factor_freq, is_power_apparent_power, is_v_a_eff_value;
1097 gboolean is_sign2, is_sign1, is_batt, is_ol1, is_max, is_min;
1098 gboolean is_maxmin, is_rel, is_ol2, is_open, is_manu, is_hold;
1099 gboolean is_light, is_usb, is_warning, is_auto_power, is_misplug_warn;
1100 gboolean is_lo, is_hi, is_open2;
1102 gboolean is_frequency, is_dual_display, is_auto, is_rms;
1105 SR_PRIV gboolean sr_vc870_packet_valid(const uint8_t *buf);
1106 SR_PRIV int sr_vc870_parse(const uint8_t *buf, float *floatval,
1107 struct sr_datafeed_analog *analog, void *info);
1109 /*--- hardware/lcr/es51919.c ------------------------------------------------*/
1111 SR_PRIV void es51919_serial_clean(void *priv);
1112 SR_PRIV struct sr_dev_inst *es51919_serial_scan(GSList *options,
1115 SR_PRIV int es51919_serial_config_get(uint32_t key, GVariant **data,
1116 const struct sr_dev_inst *sdi,
1117 const struct sr_channel_group *cg);
1118 SR_PRIV int es51919_serial_config_set(uint32_t key, GVariant *data,
1119 const struct sr_dev_inst *sdi,
1120 const struct sr_channel_group *cg);
1121 SR_PRIV int es51919_serial_config_list(uint32_t key, GVariant **data,
1122 const struct sr_dev_inst *sdi,
1123 const struct sr_channel_group *cg);
1124 SR_PRIV int es51919_serial_acquisition_start(const struct sr_dev_inst *sdi,
1126 SR_PRIV int es51919_serial_acquisition_stop(struct sr_dev_inst *sdi,
1129 /*--- hardware/dmm/ut372.c --------------------------------------------------*/
1131 #define UT372_PACKET_SIZE 27
1137 SR_PRIV gboolean sr_ut372_packet_valid(const uint8_t *buf);
1138 SR_PRIV int sr_ut372_parse(const uint8_t *buf, float *floatval,
1139 struct sr_datafeed_analog *analog, void *info);
1141 /*--- hardware/scale/kern.c -------------------------------------------------*/
1144 gboolean is_gram, is_carat, is_ounce, is_pound, is_troy_ounce;
1145 gboolean is_pennyweight, is_grain, is_tael, is_momme, is_tola;
1146 gboolean is_percentage, is_piece, is_unstable, is_stable, is_error;
1150 SR_PRIV gboolean sr_kern_packet_valid(const uint8_t *buf);
1151 SR_PRIV int sr_kern_parse(const uint8_t *buf, float *floatval,
1152 struct sr_datafeed_analog *analog, void *info);