X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=src%2Flibsigrok-internal.h;h=94056317eb12a236a1b8efea7f547bdef7adb88b;hb=697fb6ddfc2522b2e6d35511c7837e2c61d8ae73;hp=627e243cc8348652d5c321fd9664bf6e578b8708;hpb=daa39012054a10007986b2463ac61efe4cdd6ac8;p=libsigrok.git diff --git a/src/libsigrok-internal.h b/src/libsigrok-internal.h index 627e243c..94056317 100644 --- a/src/libsigrok-internal.h +++ b/src/libsigrok-internal.h @@ -17,16 +17,18 @@ * along with this program. If not, see . */ -/** @file - * @internal - */ +/** + * @file + * + * @internal + */ #ifndef LIBSIGROK_LIBSIGROK_INTERNAL_H #define LIBSIGROK_LIBSIGROK_INTERNAL_H #include +#include #include -#include "config.h" /* Needed for HAVE_LIBUSB_1_0 and others. */ #ifdef HAVE_LIBUSB_1_0 #include #endif @@ -34,6 +36,9 @@ #include #endif +struct zip; +struct zip_stat; + /** * @file * @@ -62,7 +67,7 @@ * @param x a pointer to the input memory * @return the corresponding unsigned integer */ -#define RB16(x) (((unsigned)((const uint8_t*)(x))[0] << 8) | \ +#define RB16(x) (((unsigned)((const uint8_t*)(x))[0] << 8) | \ (unsigned)((const uint8_t*)(x))[1]) /** @@ -73,6 +78,15 @@ #define RL16(x) (((unsigned)((const uint8_t*)(x))[1] << 8) | \ (unsigned)((const uint8_t*)(x))[0]) +/** + * Read a 16 bits big endian signed integer out of memory. + * @param x a pointer to the input memory + * @return the corresponding signed integer + */ +#define RB16S(x) ((int16_t) \ + (((unsigned)((const uint8_t*)(x))[0] << 8) | \ + (unsigned)((const uint8_t*)(x))[1])) + /** * Read a 16 bits little endian signed integer out of memory. * @param x a pointer to the input memory @@ -88,8 +102,8 @@ * @return the corresponding unsigned integer */ #define RB32(x) (((unsigned)((const uint8_t*)(x))[0] << 24) | \ - ((unsigned)((const uint8_t*)(x))[1] << 16) | \ - ((unsigned)((const uint8_t*)(x))[2] << 8) | \ + ((unsigned)((const uint8_t*)(x))[1] << 16) | \ + ((unsigned)((const uint8_t*)(x))[2] << 8) | \ (unsigned)((const uint8_t*)(x))[3]) /** @@ -98,10 +112,21 @@ * @return the corresponding unsigned integer */ #define RL32(x) (((unsigned)((const uint8_t*)(x))[3] << 24) | \ - ((unsigned)((const uint8_t*)(x))[2] << 16) | \ - ((unsigned)((const uint8_t*)(x))[1] << 8) | \ + ((unsigned)((const uint8_t*)(x))[2] << 16) | \ + ((unsigned)((const uint8_t*)(x))[1] << 8) | \ (unsigned)((const uint8_t*)(x))[0]) +/** + * Read a 32 bits big endian signed integer out of memory. + * @param x a pointer to the input memory + * @return the corresponding signed integer + */ +#define RB32S(x) ((int32_t) \ + (((unsigned)((const uint8_t*)(x))[0] << 24) | \ + ((unsigned)((const uint8_t*)(x))[1] << 16) | \ + ((unsigned)((const uint8_t*)(x))[2] << 8) | \ + (unsigned)((const uint8_t*)(x))[3])) + /** * Read a 32 bits little endian signed integer out of memory. * @param x a pointer to the input memory @@ -109,10 +134,53 @@ */ #define RL32S(x) ((int32_t) \ (((unsigned)((const uint8_t*)(x))[3] << 24) | \ - ((unsigned)((const uint8_t*)(x))[2] << 16) | \ - ((unsigned)((const uint8_t*)(x))[1] << 8) | \ + ((unsigned)((const uint8_t*)(x))[2] << 16) | \ + ((unsigned)((const uint8_t*)(x))[1] << 8) | \ (unsigned)((const uint8_t*)(x))[0])) +/** + * Read a 64 bits big endian unsigned integer out of memory. + * @param x a pointer to the input memory + * @return the corresponding unsigned integer + */ +#define RB64(x) (((uint64_t)((const uint8_t*)(x))[0] << 56) | \ + ((uint64_t)((const uint8_t*)(x))[1] << 48) | \ + ((uint64_t)((const uint8_t*)(x))[2] << 40) | \ + ((uint64_t)((const uint8_t*)(x))[3] << 32) | \ + ((uint64_t)((const uint8_t*)(x))[4] << 24) | \ + ((uint64_t)((const uint8_t*)(x))[5] << 16) | \ + ((uint64_t)((const uint8_t*)(x))[6] << 8) | \ + (uint64_t)((const uint8_t*)(x))[7]) + +/** + * Read a 64 bits little endian unsigned integer out of memory. + * @param x a pointer to the input memory + * @return the corresponding unsigned integer + */ +#define RL64(x) (((uint64_t)((const uint8_t*)(x))[7] << 56) | \ + ((uint64_t)((const uint8_t*)(x))[6] << 48) | \ + ((uint64_t)((const uint8_t*)(x))[5] << 40) | \ + ((uint64_t)((const uint8_t*)(x))[4] << 32) | \ + ((uint64_t)((const uint8_t*)(x))[3] << 24) | \ + ((uint64_t)((const uint8_t*)(x))[2] << 16) | \ + ((uint64_t)((const uint8_t*)(x))[1] << 8) | \ + (uint64_t)((const uint8_t*)(x))[0]) + +/** + * Read a 64 bits little endian signed integer out of memory. + * @param x a pointer to the input memory + * @return the corresponding unsigned integer + */ +#define RL64S(x) ((int64_t) \ + (((uint64_t)((const uint8_t*)(x))[7] << 56) | \ + ((uint64_t)((const uint8_t*)(x))[6] << 48) | \ + ((uint64_t)((const uint8_t*)(x))[5] << 40) | \ + ((uint64_t)((const uint8_t*)(x))[4] << 32) | \ + ((uint64_t)((const uint8_t*)(x))[3] << 24) | \ + ((uint64_t)((const uint8_t*)(x))[2] << 16) | \ + ((uint64_t)((const uint8_t*)(x))[1] << 8) | \ + (uint64_t)((const uint8_t*)(x))[0])) + /** * Read a 32 bits big endian float out of memory. * @param x a pointer to the input memory @@ -201,21 +269,82 @@ #define ALL_ZERO { 0 } #endif +#ifdef __APPLE__ +#define SR_DRIVER_LIST_SECTION "__DATA,__sr_driver_list" +#else +#define SR_DRIVER_LIST_SECTION "sr_driver_list" +#endif + +/** + * Register a list of hardware drivers. + * + * This macro can be used to register multiple hardware drivers to the library. + * This is useful when a driver supports multiple similar but slightly + * different devices that require different sr_dev_driver struct definitions. + * + * For registering only a single driver see SR_REGISTER_DEV_DRIVER(). + * + * Example: + * @code{c} + * #define MY_DRIVER(_name) \ + * &(struct sr_dev_driver){ \ + * .name = _name, \ + * ... + * }; + * + * SR_REGISTER_DEV_DRIVER_LIST(my_driver_infos, + * MY_DRIVER("driver 1"), + * MY_DRIVER("driver 2"), + * ... + * ); + * @endcode + * + * @param name Name to use for the driver list identifier. + * @param ... Comma separated list of pointers to sr_dev_driver structs. + */ +#define SR_REGISTER_DEV_DRIVER_LIST(name, ...) \ + static const struct sr_dev_driver *name[] \ + __attribute__((section (SR_DRIVER_LIST_SECTION), used, \ + aligned(sizeof(struct sr_dev_driver *)))) \ + = { \ + __VA_ARGS__ \ + }; + +/** + * Register a hardware driver. + * + * This macro is used to register a hardware driver with the library. It has + * to be used in order to make the driver accessible to applications using the + * library. + * + * The macro invocation should be placed directly under the struct + * sr_dev_driver definition. + * + * Example: + * @code{c} + * static struct sr_dev_driver driver_info = { + * .name = "driver", + * .... + * }; + * SR_REGISTER_DEV_DRIVER(driver_info); + * @endcode + * + * @param name Identifier name of sr_dev_driver struct to register. + */ +#define SR_REGISTER_DEV_DRIVER(name) \ + SR_REGISTER_DEV_DRIVER_LIST(name##_list, &name); + +SR_API void sr_drivers_init(struct sr_context *context); + struct sr_context { struct sr_dev_driver **driver_list; #ifdef HAVE_LIBUSB_1_0 libusb_context *libusb_ctx; - gboolean usb_source_present; -#ifdef _WIN32 - GThread *usb_thread; - gboolean usb_thread_running; - HANDLE usb_wait_request_event; - HANDLE usb_wait_complete_event; - GPollFD usb_pollfd; - sr_receive_data_callback usb_cb; - void *usb_cb_data; -#endif #endif + sr_resource_open_callback resource_open_cb; + sr_resource_close_callback resource_close_cb; + sr_resource_read_callback resource_read_cb; + void *resource_cb_data; }; /** Input module metadata keys. */ @@ -226,8 +355,6 @@ enum sr_input_meta_keys { SR_INPUT_META_FILESIZE = 0x02, /** The first 128 bytes of the file, provided as a GString. */ SR_INPUT_META_HEADER = 0x04, - /** The file's MIME type. */ - SR_INPUT_META_MIMETYPE = 0x08, /** The module cannot identify a file without this metadata. */ SR_INPUT_META_REQUIRED = 0x80, @@ -283,7 +410,6 @@ struct sr_input_module { * SR_INPUT_META_FILENAME * SR_INPUT_META_FILESIZE * SR_INPUT_META_HEADER - * SR_INPUT_META_MIMETYPE * * If the high bit (SR_INPUT META_REQUIRED) is set, the module cannot * identify a stream without the given metadata. @@ -294,7 +420,7 @@ struct sr_input_module { * Returns a NULL-terminated list of options this module can take. * Can be NULL, if the module has no options. */ - struct sr_option *(*options) (void); + const struct sr_option *(*options) (void); /** * Check if this input module can load and parse the specified stream. @@ -304,9 +430,9 @@ struct sr_input_module { * @retval SR_OK This module knows the format. * @retval SR_ERR_NA There wasn't enough data for this module to * positively identify the format. - * @retval SR_ERR_DATA This module knows the format, but cannot handle it. - * This means the stream is either corrupt, or indicates a feature - * that the module does not support. + * @retval SR_ERR_DATA This module knows the format, but cannot handle + * it. This means the stream is either corrupt, or indicates a + * feature that the module does not support. * @retval SR_ERR This module does not know the format. */ int (*format_match) (GHashTable *metadata); @@ -344,6 +470,18 @@ struct sr_input_module { */ int (*end) (struct sr_input *in); + /** + * Reset the input module's input handling structures. + * + * Causes the input module to reset its internal state so that we can + * re-send the input data from the beginning without having to + * re-create the entire input module. + * + * @retval SR_OK Success. + * @retval other Negative error code. + */ + int (*reset) (struct sr_input *in); + /** * This function is called after the caller is finished using * the input module, and can be used to free any internal @@ -359,7 +497,7 @@ struct sr_input_module { /** Output module instance. */ struct sr_output { - /** A pointer to this output's module. */ + /** A pointer to this output's module. */ const struct sr_output_module *module; /** @@ -368,6 +506,11 @@ struct sr_output { */ const struct sr_dev_inst *sdi; + /** + * The name of the file that the data should be written to. + */ + const char *filename; + /** * A generic pointer which can be used by the module to keep internal * state between calls into its callback functions. @@ -384,7 +527,7 @@ struct sr_output_module { * A unique ID for this output module, suitable for use in command-line * clients, [a-z0-9-]. Must not be NULL. */ - char *id; + const char *id; /** * A unique name for this output module, suitable for use in GUI @@ -398,7 +541,7 @@ struct sr_output_module { * This can be displayed by frontends, e.g. when selecting the output * module for saving a file. */ - char *desc; + const char *desc; /** * A NULL terminated array of strings containing a list of file name @@ -407,6 +550,13 @@ struct sr_output_module { */ const char *const *exts; + /** + * Bitfield containing flags that describe certain properties + * this output module may or may not have. + * @see sr_output_flags + */ + const uint64_t flags; + /** * Returns a NULL-terminated list of options this module can take. * Can be NULL, if the module has no options. @@ -464,7 +614,7 @@ struct sr_output_module { /** Transform module instance. */ struct sr_transform { - /** A pointer to this transform's module. */ + /** A pointer to this transform's module. */ const struct sr_transform_module *module; /** @@ -485,7 +635,7 @@ struct sr_transform_module { * A unique ID for this transform module, suitable for use in * command-line clients, [a-z0-9-]. Must not be NULL. */ - char *id; + const char *id; /** * A unique name for this transform module, suitable for use in GUI @@ -499,7 +649,7 @@ struct sr_transform_module { * This can be displayed by frontends, e.g. when selecting * which transform module(s) to add. */ - char *desc; + const char *desc; /** * Returns a NULL-terminated list of options this transform module @@ -562,9 +712,6 @@ struct sr_usb_dev_inst { #endif #ifdef HAVE_LIBSERIALPORT -#define SERIAL_PARITY_NONE SP_PARITY_NONE -#define SERIAL_PARITY_EVEN SP_PARITY_EVEN -#define SERIAL_PARITY_ODD SP_PARITY_ODD struct sr_serial_dev_inst { /** Port name, e.g. '/dev/tty42'. */ char *port; @@ -572,10 +719,6 @@ struct sr_serial_dev_inst { char *serialcomm; /** libserialport port handle */ struct sp_port *data; - /** libserialport event set */ - struct sp_event_set *event_set; - /** GPollFDs for event polling */ - GPollFD *pollfds; }; #endif @@ -593,25 +736,35 @@ struct drv_context { /*--- log.c -----------------------------------------------------------------*/ -SR_PRIV int sr_log(int loglevel, const char *format, ...); -SR_PRIV int sr_spew(const char *format, ...); -SR_PRIV int sr_dbg(const char *format, ...); -SR_PRIV int sr_info(const char *format, ...); -SR_PRIV int sr_warn(const char *format, ...); -SR_PRIV int sr_err(const char *format, ...); +#if defined(G_OS_WIN32) && (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 4)) +/* + * On MinGW, we need to specify the gnu_printf format flavor or GCC + * will assume non-standard Microsoft printf syntax. + */ +SR_PRIV int sr_log(int loglevel, const char *format, ...) + __attribute__((__format__ (__gnu_printf__, 2, 3))); +#else +SR_PRIV int sr_log(int loglevel, const char *format, ...) G_GNUC_PRINTF(2, 3); +#endif /* Message logging helpers with subsystem-specific prefix string. */ -#ifndef NO_LOG_WRAPPERS -#define sr_log(l, s, args...) sr_log(l, "%s: " s, LOG_PREFIX, ## args) -#define sr_spew(s, args...) sr_spew("%s: " s, LOG_PREFIX, ## args) -#define sr_dbg(s, args...) sr_dbg("%s: " s, LOG_PREFIX, ## args) -#define sr_info(s, args...) sr_info("%s: " s, LOG_PREFIX, ## args) -#define sr_warn(s, args...) sr_warn("%s: " s, LOG_PREFIX, ## args) -#define sr_err(s, args...) sr_err("%s: " s, LOG_PREFIX, ## args) -#endif +#define sr_spew(...) sr_log(SR_LOG_SPEW, LOG_PREFIX ": " __VA_ARGS__) +#define sr_dbg(...) sr_log(SR_LOG_DBG, LOG_PREFIX ": " __VA_ARGS__) +#define sr_info(...) sr_log(SR_LOG_INFO, LOG_PREFIX ": " __VA_ARGS__) +#define sr_warn(...) sr_log(SR_LOG_WARN, LOG_PREFIX ": " __VA_ARGS__) +#define sr_err(...) sr_log(SR_LOG_ERR, LOG_PREFIX ": " __VA_ARGS__) /*--- device.c --------------------------------------------------------------*/ +/** Scan options supported by a driver. */ +#define SR_CONF_SCAN_OPTIONS 0x7FFF0000 + +/** Device options for a particular device. */ +#define SR_CONF_DEVICE_OPTIONS 0x7FFF0001 + +/** Mask for separating config keys from capabilities. */ +#define SR_CONF_MASK 0x1fffffff + /** Values for the changes argument of sr_dev_driver.config_channel_set. */ enum { /** The enabled state of the channel has been changed. */ @@ -620,6 +773,8 @@ enum { SR_PRIV struct sr_channel *sr_channel_new(struct sr_dev_inst *sdi, int index, int type, gboolean enabled, const char *name); +SR_PRIV struct sr_channel *sr_next_enabled_channel(const struct sr_dev_inst *sdi, + struct sr_channel *cur_channel); /** Device instance data */ struct sr_dev_inst { @@ -674,22 +829,13 @@ SR_PRIV void sr_usbtmc_dev_inst_free(struct sr_usbtmc_dev_inst *usbtmc); /*--- hwdriver.c ------------------------------------------------------------*/ -extern SR_PRIV struct sr_dev_driver **drivers_lists[]; - SR_PRIV const GVariantType *sr_variant_type_get(int datatype); SR_PRIV int sr_variant_type_check(uint32_t key, GVariant *data); SR_PRIV void sr_hw_cleanup_all(const struct sr_context *ctx); SR_PRIV struct sr_config *sr_config_new(uint32_t key, GVariant *data); SR_PRIV void sr_config_free(struct sr_config *src); -SR_PRIV int sr_source_remove(int fd); -SR_PRIV int sr_source_remove_pollfd(GPollFD *pollfd); -SR_PRIV int sr_source_remove_channel(GIOChannel *channel); -SR_PRIV int sr_source_add(int fd, int events, int timeout, - sr_receive_data_callback cb, void *cb_data); -SR_PRIV int sr_source_add_pollfd(GPollFD *pollfd, int timeout, - sr_receive_data_callback cb, void *cb_data); -SR_PRIV int sr_source_add_channel(GIOChannel *channel, int events, int timeout, - sr_receive_data_callback cb, void *cb_data); +SR_PRIV int sr_dev_acquisition_start(struct sr_dev_inst *sdi); +SR_PRIV int sr_dev_acquisition_stop(struct sr_dev_inst *sdi); /*--- session.c -------------------------------------------------------------*/ @@ -704,43 +850,74 @@ struct sr_session { GSList *datafeed_callbacks; GSList *transforms; struct sr_trigger *trigger; - GTimeVal starttime; + + /** Callback to invoke on session stop. */ + sr_session_stopped_callback stopped_callback; + /** User data to be passed to the session stop callback. */ + void *stopped_cb_data; + + /** Mutex protecting the main context pointer. */ + GMutex main_mutex; + /** Context of the session main loop. */ + GMainContext *main_context; + + /** Registered event sources for this session. */ + GHashTable *event_sources; + /** Session main loop. */ + GMainLoop *main_loop; + /** ID of idle source for dispatching the session stop notification. */ + unsigned int stop_check_id; + /** Whether the session has been started. */ gboolean running; +}; - unsigned int num_sources; +SR_PRIV int sr_session_source_add_internal(struct sr_session *session, + void *key, GSource *source); +SR_PRIV int sr_session_source_remove_internal(struct sr_session *session, + void *key); +SR_PRIV int sr_session_source_destroyed(struct sr_session *session, + void *key, GSource *source); +SR_PRIV int sr_session_fd_source_add(struct sr_session *session, + void *key, gintptr fd, int events, int timeout, + sr_receive_data_callback cb, void *cb_data); - /* - * Both "sources" and "pollfds" are of the same size and contain pairs - * of descriptor and callback function. We can not embed the GPollFD - * into the source struct since we want to be able to pass the array - * of all poll descriptors to g_poll(). - */ - struct source *sources; - GPollFD *pollfds; - int source_timeout; - - /* - * These are our synchronization primitives for stopping the session in - * an async fashion. We need to make sure the session is stopped from - * within the session thread itself. - */ - /** Mutex protecting access to abort_session. */ - GMutex stop_mutex; - /** Abort current session. See sr_session_stop(). */ - gboolean abort_session; -}; +SR_PRIV int sr_session_source_add(struct sr_session *session, int fd, + int events, int timeout, sr_receive_data_callback cb, void *cb_data); +SR_PRIV int sr_session_source_add_pollfd(struct sr_session *session, + GPollFD *pollfd, int timeout, sr_receive_data_callback cb, + void *cb_data); +SR_PRIV int sr_session_source_add_channel(struct sr_session *session, + GIOChannel *channel, int events, int timeout, + sr_receive_data_callback cb, void *cb_data); +SR_PRIV int sr_session_source_remove(struct sr_session *session, int fd); +SR_PRIV int sr_session_source_remove_pollfd(struct sr_session *session, + GPollFD *pollfd); +SR_PRIV int sr_session_source_remove_channel(struct sr_session *session, + GIOChannel *channel); SR_PRIV int sr_session_send(const struct sr_dev_inst *sdi, const struct sr_datafeed_packet *packet); -SR_PRIV int sr_session_stop_sync(struct sr_session *session); SR_PRIV int sr_sessionfile_check(const char *filename); +SR_PRIV struct sr_dev_inst *sr_session_prepare_sdi(const char *filename, + struct sr_session **session); SR_PRIV int sr_packet_copy(const struct sr_datafeed_packet *packet, struct sr_datafeed_packet **copy); SR_PRIV void sr_packet_free(struct sr_datafeed_packet *packet); +/*--- session_file.c --------------------------------------------------------*/ + +#if !HAVE_ZIP_DISCARD +/* Replace zip_discard() if not available. */ +#define zip_discard(zip) sr_zip_discard(zip) +SR_PRIV void sr_zip_discard(struct zip *archive); +#endif + +SR_PRIV GKeyFile *sr_sessionfile_read_metadata(struct zip *archive, + const struct zip_stat *entry); + /*--- analog.c --------------------------------------------------------------*/ -SR_PRIV int sr_analog_init(struct sr_datafeed_analog2 *analog, +SR_PRIV int sr_analog_init(struct sr_datafeed_analog *analog, struct sr_analog_encoding *encoding, struct sr_analog_meaning *meaning, struct sr_analog_spec *spec, @@ -751,19 +928,77 @@ SR_PRIV int sr_analog_init(struct sr_datafeed_analog2 *analog, typedef int (*dev_close_callback)(struct sr_dev_inst *sdi); typedef void (*std_dev_clear_callback)(void *priv); -SR_PRIV int std_init(struct sr_context *sr_ctx, struct sr_dev_driver *di, - const char *prefix); +SR_PRIV int std_init(struct sr_dev_driver *di, struct sr_context *sr_ctx); +SR_PRIV int std_cleanup(const struct sr_dev_driver *di); +SR_PRIV int std_dummy_dev_open(struct sr_dev_inst *sdi); +SR_PRIV int std_dummy_dev_close(struct sr_dev_inst *sdi); +SR_PRIV int std_dummy_dev_acquisition_start(const struct sr_dev_inst *sdi); +SR_PRIV int std_dummy_dev_acquisition_stop(struct sr_dev_inst *sdi); #ifdef HAVE_LIBSERIALPORT SR_PRIV int std_serial_dev_open(struct sr_dev_inst *sdi); -SR_PRIV int std_serial_dev_acquisition_stop(struct sr_dev_inst *sdi, - void *cb_data, dev_close_callback dev_close_fn, - struct sr_serial_dev_inst *serial, const char *prefix); +SR_PRIV int std_serial_dev_acquisition_stop(struct sr_dev_inst *sdi); #endif -SR_PRIV int std_session_send_df_header(const struct sr_dev_inst *sdi, - const char *prefix); -SR_PRIV int std_dev_clear(const struct sr_dev_driver *driver, +SR_PRIV int std_session_send_df_header(const struct sr_dev_inst *sdi); +SR_PRIV int std_session_send_df_end(const struct sr_dev_inst *sdi); +SR_PRIV int std_dev_clear_with_callback(const struct sr_dev_driver *driver, std_dev_clear_callback clear_private); +SR_PRIV int std_dev_clear(const struct sr_dev_driver *driver); +SR_PRIV GSList *std_dev_list(const struct sr_dev_driver *di); SR_PRIV int std_serial_dev_close(struct sr_dev_inst *sdi); +SR_PRIV GSList *std_scan_complete(struct sr_dev_driver *di, GSList *devices); + +SR_PRIV int std_opts_config_list(uint32_t key, GVariant **data, + const struct sr_dev_inst *sdi, const struct sr_channel_group *cg, + const uint32_t scanopts[], size_t scansize, const uint32_t drvopts[], + size_t drvsize, const uint32_t devopts[], size_t devsize); + +#define STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts) \ + std_opts_config_list(key, data, sdi, cg, ARRAY_AND_SIZE(scanopts), \ + ARRAY_AND_SIZE(drvopts), ARRAY_AND_SIZE(devopts)) + +SR_PRIV GVariant *std_gvar_tuple_array(const uint64_t a[][2], unsigned int n); +SR_PRIV GVariant *std_gvar_tuple_rational(const struct sr_rational *r, unsigned int n); +SR_PRIV GVariant *std_gvar_samplerates(const uint64_t samplerates[], unsigned int n); +SR_PRIV GVariant *std_gvar_samplerates_steps(const uint64_t samplerates[], unsigned int n); +SR_PRIV GVariant *std_gvar_min_max_step(double min, double max, double step); +SR_PRIV GVariant *std_gvar_min_max_step_array(const double a[3]); +SR_PRIV GVariant *std_gvar_min_max_step_thresholds(const double dmin, const double dmax, const double dstep); + +SR_PRIV GVariant *std_gvar_tuple_u64(uint64_t low, uint64_t high); +SR_PRIV GVariant *std_gvar_tuple_double(double low, double high); + +SR_PRIV GVariant *std_gvar_array_i32(const int32_t *a, unsigned int n); +SR_PRIV GVariant *std_gvar_array_u32(const uint32_t *a, unsigned int n); +SR_PRIV GVariant *std_gvar_array_u64(const uint64_t *a, unsigned int n); + +SR_PRIV GVariant *std_gvar_thresholds(const double a[][2], unsigned int n); + +SR_PRIV int std_str_idx(GVariant *data, const char *a[], unsigned int n); +SR_PRIV int std_u64_idx(GVariant *data, const uint64_t a[], unsigned int n); +SR_PRIV int std_u8_idx(GVariant *data, const uint8_t a[], unsigned int n); + +SR_PRIV int std_str_idx_s(const char *s, const char *a[], unsigned int n); +SR_PRIV int std_u8_idx_s(uint8_t b, const uint8_t a[], unsigned int n); + +SR_PRIV int std_u64_tuple_idx(GVariant *data, const uint64_t a[][2], unsigned int n); +SR_PRIV int std_double_tuple_idx(GVariant *data, const double a[][2], unsigned int n); +SR_PRIV int std_double_tuple_idx_d0(const double d, const double a[][2], unsigned int n); + +/*--- resource.c ------------------------------------------------------------*/ + +SR_PRIV int64_t sr_file_get_size(FILE *file); + +SR_PRIV int sr_resource_open(struct sr_context *ctx, + struct sr_resource *res, int type, const char *name) + G_GNUC_WARN_UNUSED_RESULT; +SR_PRIV int sr_resource_close(struct sr_context *ctx, + struct sr_resource *res); +SR_PRIV gssize sr_resource_read(struct sr_context *ctx, + const struct sr_resource *res, void *buf, size_t count) + G_GNUC_WARN_UNUSED_RESULT; +SR_PRIV void *sr_resource_load(struct sr_context *ctx, int type, + const char *name, size_t *size, size_t max_size) + G_GNUC_MALLOC G_GNUC_WARN_UNUSED_RESULT; /*--- strutil.c -------------------------------------------------------------*/ @@ -843,10 +1078,10 @@ SR_PRIV int serial_timeout(struct sr_serial_dev_inst *port, int num_bytes); #ifdef HAVE_LIBUSB_1_0 SR_PRIV int ezusb_reset(struct libusb_device_handle *hdl, int set_clear); -SR_PRIV int ezusb_install_firmware(libusb_device_handle *hdl, - const char *filename); -SR_PRIV int ezusb_upload_firmware(libusb_device *dev, int configuration, - const char *filename); +SR_PRIV int ezusb_install_firmware(struct sr_context *ctx, libusb_device_handle *hdl, + const char *name); +SR_PRIV int ezusb_upload_firmware(struct sr_context *ctx, libusb_device *dev, + int configuration, const char *name); #endif /*--- hardware/usb.c --------------------------------------------------------*/ @@ -854,109 +1089,15 @@ SR_PRIV int ezusb_upload_firmware(libusb_device *dev, int configuration, #ifdef HAVE_LIBUSB_1_0 SR_PRIV GSList *sr_usb_find(libusb_context *usb_ctx, const char *conn); SR_PRIV int sr_usb_open(libusb_context *usb_ctx, struct sr_usb_dev_inst *usb); +SR_PRIV void sr_usb_close(struct sr_usb_dev_inst *usb); SR_PRIV int usb_source_add(struct sr_session *session, struct sr_context *ctx, int timeout, sr_receive_data_callback cb, void *cb_data); SR_PRIV int usb_source_remove(struct sr_session *session, struct sr_context *ctx); SR_PRIV int usb_get_port_path(libusb_device *dev, char *path, int path_len); +SR_PRIV gboolean usb_match_manuf_prod(libusb_device *dev, + const char *manufacturer, const char *product); #endif -/*--- hardware/scpi.c -------------------------------------------------------*/ - -#define SCPI_CMD_IDN "*IDN?" -#define SCPI_CMD_OPC "*OPC?" - -enum { - SCPI_CMD_SET_TRIGGER_SOURCE, - SCPI_CMD_SET_TIMEBASE, - SCPI_CMD_SET_VERTICAL_DIV, - SCPI_CMD_SET_TRIGGER_SLOPE, - SCPI_CMD_SET_COUPLING, - SCPI_CMD_SET_HORIZ_TRIGGERPOS, - SCPI_CMD_GET_ANALOG_CHAN_STATE, - SCPI_CMD_GET_DIG_CHAN_STATE, - SCPI_CMD_GET_TIMEBASE, - SCPI_CMD_GET_VERTICAL_DIV, - SCPI_CMD_GET_VERTICAL_OFFSET, - SCPI_CMD_GET_TRIGGER_SOURCE, - SCPI_CMD_GET_HORIZ_TRIGGERPOS, - SCPI_CMD_GET_TRIGGER_SLOPE, - SCPI_CMD_GET_COUPLING, - SCPI_CMD_SET_ANALOG_CHAN_STATE, - SCPI_CMD_SET_DIG_CHAN_STATE, - SCPI_CMD_GET_DIG_POD_STATE, - SCPI_CMD_SET_DIG_POD_STATE, - SCPI_CMD_GET_ANALOG_DATA, - SCPI_CMD_GET_DIG_DATA, - SCPI_CMD_GET_SAMPLE_RATE, - SCPI_CMD_GET_SAMPLE_RATE_LIVE, -}; - -struct sr_scpi_hw_info { - char *manufacturer; - char *model; - char *serial_number; - char *firmware_version; -}; - -struct sr_scpi_dev_inst { - const char *name; - const char *prefix; - int priv_size; - GSList *(*scan)(struct drv_context *drvc); - int (*dev_inst_new)(void *priv, struct drv_context *drvc, - const char *resource, char **params, const char *serialcomm); - int (*open)(void *priv); - int (*source_add)(struct sr_session *session, void *priv, int events, - int timeout, sr_receive_data_callback cb, void *cb_data); - int (*source_remove)(struct sr_session *session, void *priv); - int (*send)(void *priv, const char *command); - int (*read_begin)(void *priv); - int (*read_data)(void *priv, char *buf, int maxlen); - int (*read_complete)(void *priv); - int (*close)(void *priv); - void (*free)(void *priv); - unsigned int read_timeout_ms; - void *priv; -}; - -SR_PRIV GSList *sr_scpi_scan(struct drv_context *drvc, GSList *options, - struct sr_dev_inst *(*probe_device)(struct sr_scpi_dev_inst *scpi)); -SR_PRIV struct sr_scpi_dev_inst *scpi_dev_inst_new(struct drv_context *drvc, - const char *resource, const char *serialcomm); -SR_PRIV int sr_scpi_open(struct sr_scpi_dev_inst *scpi); -SR_PRIV int sr_scpi_source_add(struct sr_session *session, - struct sr_scpi_dev_inst *scpi, int events, int timeout, - sr_receive_data_callback cb, void *cb_data); -SR_PRIV int sr_scpi_source_remove(struct sr_session *session, - struct sr_scpi_dev_inst *scpi); -SR_PRIV int sr_scpi_send(struct sr_scpi_dev_inst *scpi, - const char *format, ...); -SR_PRIV int sr_scpi_send_variadic(struct sr_scpi_dev_inst *scpi, - const char *format, va_list args); -SR_PRIV int sr_scpi_read_begin(struct sr_scpi_dev_inst *scpi); -SR_PRIV int sr_scpi_read_data(struct sr_scpi_dev_inst *scpi, char *buf, int maxlen); -SR_PRIV int sr_scpi_read_complete(struct sr_scpi_dev_inst *scpi); -SR_PRIV int sr_scpi_close(struct sr_scpi_dev_inst *scpi); -SR_PRIV void sr_scpi_free(struct sr_scpi_dev_inst *scpi); - -SR_PRIV int sr_scpi_get_string(struct sr_scpi_dev_inst *scpi, - const char *command, char **scpi_response); -SR_PRIV int sr_scpi_get_bool(struct sr_scpi_dev_inst *scpi, - const char *command, gboolean *scpi_response); -SR_PRIV int sr_scpi_get_int(struct sr_scpi_dev_inst *scpi, - const char *command, int *scpi_response); -SR_PRIV int sr_scpi_get_float(struct sr_scpi_dev_inst *scpi, - const char *command, float *scpi_response); -SR_PRIV int sr_scpi_get_double(struct sr_scpi_dev_inst *scpi, - const char *command, double *scpi_response); -SR_PRIV int sr_scpi_get_opc(struct sr_scpi_dev_inst *scpi); -SR_PRIV int sr_scpi_get_floatv(struct sr_scpi_dev_inst *scpi, - const char *command, GArray **scpi_response); -SR_PRIV int sr_scpi_get_uint8v(struct sr_scpi_dev_inst *scpi, - const char *command, GArray **scpi_response); -SR_PRIV int sr_scpi_get_hw_id(struct sr_scpi_dev_inst *scpi, - struct sr_scpi_hw_info **scpi_response); -SR_PRIV void sr_scpi_hw_info_free(struct sr_scpi_hw_info *hw_info); /*--- modbus/modbus.c -------------------------------------------------------*/ @@ -1032,6 +1173,7 @@ struct es519xx_info { uint32_t baudrate; int packet_size; gboolean alt_functions, fivedigits, clampmeter, selectable_lpf; + int digits; }; SR_PRIV gboolean sr_es519xx_2400_11b_packet_valid(const uint8_t *buf); @@ -1094,10 +1236,29 @@ SR_PRIV void sr_fs9721_10_temp_c(struct sr_datafeed_analog *analog, void *info); SR_PRIV void sr_fs9721_01_10_temp_f_c(struct sr_datafeed_analog *analog, void *info); SR_PRIV void sr_fs9721_max_c_min(struct sr_datafeed_analog *analog, void *info); +/*--- hardware/dmm/dtm0660.c ------------------------------------------------*/ + +#define DTM0660_PACKET_SIZE 15 + +struct dtm0660_info { + gboolean is_ac, is_dc, is_auto, is_rs232, is_micro, is_nano, is_kilo; + gboolean is_diode, is_milli, is_percent, is_mega, is_beep, is_farad; + gboolean is_ohm, is_rel, is_hold, is_ampere, is_volt, is_hz, is_bat; + gboolean is_degf, is_degc, is_c2c1_01, is_c2c1_00, is_apo, is_min; + gboolean is_minmax, is_max, is_sign; +}; + +SR_PRIV gboolean sr_dtm0660_packet_valid(const uint8_t *buf); +SR_PRIV int sr_dtm0660_parse(const uint8_t *buf, float *floatval, + struct sr_datafeed_analog *analog, void *info); + /*--- hardware/dmm/m2110.c --------------------------------------------------*/ #define BBCGM_M2110_PACKET_SIZE 9 +/* Dummy info struct. The parser does not use it. */ +struct m2110_info { int dummy; }; + SR_PRIV gboolean sr_m2110_packet_valid(const uint8_t *buf); SR_PRIV int sr_m2110_parse(const uint8_t *buf, float *floatval, struct sr_datafeed_analog *analog, void *info); @@ -1166,13 +1327,13 @@ struct vc870_info { gboolean is_voltage, is_dc, is_ac, is_temperature, is_resistance; gboolean is_continuity, is_capacitance, is_diode, is_loop_current; gboolean is_current, is_micro, is_milli, is_power; - gboolean is_power_factor_freq, is_power_apparent_power, is_v_a_eff_value; + gboolean is_power_factor_freq, is_power_apparent_power, is_v_a_rms_value; gboolean is_sign2, is_sign1, is_batt, is_ol1, is_max, is_min; gboolean is_maxmin, is_rel, is_ol2, is_open, is_manu, is_hold; gboolean is_light, is_usb, is_warning, is_auto_power, is_misplug_warn; gboolean is_lo, is_hi, is_open2; - gboolean is_frequency, is_dual_display, is_auto, is_rms; + gboolean is_frequency, is_dual_display, is_auto; }; SR_PRIV gboolean sr_vc870_packet_valid(const uint8_t *buf); @@ -1194,10 +1355,8 @@ SR_PRIV int es51919_serial_config_set(uint32_t key, GVariant *data, SR_PRIV int es51919_serial_config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi, const struct sr_channel_group *cg); -SR_PRIV int es51919_serial_acquisition_start(const struct sr_dev_inst *sdi, - void *cb_data); -SR_PRIV int es51919_serial_acquisition_stop(struct sr_dev_inst *sdi, - void *cb_data); +SR_PRIV int es51919_serial_acquisition_start(const struct sr_dev_inst *sdi); +SR_PRIV int es51919_serial_acquisition_stop(struct sr_dev_inst *sdi); /*--- hardware/dmm/ut372.c --------------------------------------------------*/ @@ -1211,4 +1370,61 @@ SR_PRIV gboolean sr_ut372_packet_valid(const uint8_t *buf); SR_PRIV int sr_ut372_parse(const uint8_t *buf, float *floatval, struct sr_datafeed_analog *analog, void *info); +/*--- hardware/dmm/asycii.c -------------------------------------------------*/ + +#define ASYCII_PACKET_SIZE 16 + +struct asycii_info { + gboolean is_ac, is_dc, is_ac_and_dc; + gboolean is_resistance, is_capacitance, is_diode, is_gain; + gboolean is_frequency, is_duty_cycle, is_duty_pos, is_duty_neg; + gboolean is_pulse_width, is_period_pos, is_period_neg; + gboolean is_pulse_count, is_count_pos, is_count_neg; + gboolean is_ampere, is_volt, is_volt_ampere, is_farad, is_ohm; + gboolean is_hertz, is_percent, is_seconds, is_decibel; + gboolean is_pico, is_nano, is_micro, is_milli, is_kilo, is_mega; + gboolean is_unitless; + gboolean is_peak_min, is_peak_max; + gboolean is_invalid; +}; + +#ifdef HAVE_LIBSERIALPORT +SR_PRIV int sr_asycii_packet_request(struct sr_serial_dev_inst *serial); +#endif +SR_PRIV gboolean sr_asycii_packet_valid(const uint8_t *buf); +SR_PRIV int sr_asycii_parse(const uint8_t *buf, float *floatval, + struct sr_datafeed_analog *analog, void *info); + +/*--- hardware/scale/kern.c -------------------------------------------------*/ + +struct kern_info { + gboolean is_gram, is_carat, is_ounce, is_pound, is_troy_ounce; + gboolean is_pennyweight, is_grain, is_tael, is_momme, is_tola; + gboolean is_percentage, is_piece, is_unstable, is_stable, is_error; + int buflen; +}; + +SR_PRIV gboolean sr_kern_packet_valid(const uint8_t *buf); +SR_PRIV int sr_kern_parse(const uint8_t *buf, float *floatval, + struct sr_datafeed_analog *analog, void *info); + +/*--- sw_limits.c -----------------------------------------------------------*/ + +struct sr_sw_limits { + uint64_t limit_samples; + uint64_t limit_msec; + uint64_t samples_read; + uint64_t start_time; +}; + +SR_PRIV int sr_sw_limits_config_get(struct sr_sw_limits *limits, uint32_t key, + GVariant **data); +SR_PRIV int sr_sw_limits_config_set(struct sr_sw_limits *limits, uint32_t key, + GVariant *data); +SR_PRIV void sr_sw_limits_acquisition_start(struct sr_sw_limits *limits); +SR_PRIV gboolean sr_sw_limits_check(struct sr_sw_limits *limits); +SR_PRIV void sr_sw_limits_update_samples_read(struct sr_sw_limits *limits, + uint64_t samples_read); +SR_PRIV void sr_sw_limits_init(struct sr_sw_limits *limits); + #endif