X-Git-Url: http://sigrok.org/gitweb/?a=blobdiff_plain;f=libsigrok-internal.h;h=61978c297911b73a91c4f7bce4f98058d06eadf6;hb=3544f848e0d7f67af8e11ce7ec344b34cd797df3;hp=a2d9a5a19dbf7c6d7db688b01ad030e25a4e31f2;hpb=c02dc3e26141a13554828be9a4ffa2def857d2b3;p=libsigrok.git
diff --git a/libsigrok-internal.h b/libsigrok-internal.h
index a2d9a5a1..61978c29 100644
--- a/libsigrok-internal.h
+++ b/libsigrok-internal.h
@@ -17,8 +17,12 @@
* along with this program. If not, see .
*/
-#ifndef LIBSIGROK_SIGROK_INTERNAL_H
-#define LIBSIGROK_SIGROK_INTERNAL_H
+/** @file
+ * @internal
+ */
+
+#ifndef LIBSIGROK_LIBSIGROK_INTERNAL_H
+#define LIBSIGROK_LIBSIGROK_INTERNAL_H
#include
#include
@@ -26,6 +30,9 @@
#ifdef HAVE_LIBUSB_1_0
#include
#endif
+#ifdef HAVE_LIBSERIALPORT
+#include
+#endif
/**
* @file
@@ -43,31 +50,105 @@
#define ARRAY_AND_SIZE(a) (a), ARRAY_SIZE(a)
#endif
+/**
+ * Read a 16 bits big endian integer out of memory.
+ * @param x a pointer to the input memory
+ * @return the corresponding integer
+ */
+#define RB16(x) ((((const uint8_t*)(x))[0] << 8) | \
+ ((const uint8_t*)(x))[1])
+
+/**
+ * Read a 16 bits little endian integer out of memory.
+ * @param x a pointer to the input memory
+ * @return the corresponding integer
+ */
+#define RL16(x) ((((const uint8_t*)(x))[1] << 8) | \
+ ((const uint8_t*)(x))[0])
+
+/**
+ * Read a 32 bits big endian integer out of memory.
+ * @param x a pointer to the input memory
+ * @return the corresponding integer
+ */
+#define RB32(x) ((((const uint8_t*)(x))[0] << 24) | \
+ (((const uint8_t*)(x))[1] << 16) | \
+ (((const uint8_t*)(x))[2] << 8) | \
+ ((const uint8_t*)(x))[3])
+
+/**
+ * Read a 32 bits little endian integer out of memory.
+ * @param x a pointer to the input memory
+ * @return the corresponding integer
+ */
+#define RL32(x) ((((const uint8_t*)(x))[3] << 24) | \
+ (((const uint8_t*)(x))[2] << 16) | \
+ (((const uint8_t*)(x))[1] << 8) | \
+ ((const uint8_t*)(x))[0])
+
+/* Portability fixes for FreeBSD. */
+#ifdef __FreeBSD__
+#define LIBUSB_CLASS_APPLICATION 0xfe
+#define libusb_handle_events_timeout_completed(ctx, tv, c) \
+ libusb_handle_events_timeout(ctx, tv)
+#endif
+
struct sr_context {
#ifdef HAVE_LIBUSB_1_0
libusb_context *libusb_ctx;
+ gboolean usb_source_present;
+#ifdef _WIN32
+ GThread *usb_thread;
+ gboolean usb_thread_running;
+ GMutex usb_mutex;
+ HANDLE usb_event;
+ GPollFD usb_pollfd;
+ sr_receive_data_callback_t usb_cb;
+ void *usb_cb_data;
+#endif
#endif
};
#ifdef HAVE_LIBUSB_1_0
+/** USB device instance */
struct sr_usb_dev_inst {
+ /** USB bus */
uint8_t bus;
+ /** Device address on USB bus */
uint8_t address;
+ /** libusb device handle */
struct libusb_device_handle *devhdl;
};
#endif
-#define SERIAL_PARITY_NONE 0
-#define SERIAL_PARITY_EVEN 1
-#define SERIAL_PARITY_ODD 2
+#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;
+ /** Comm params for serial_set_paramstr(). */
char *serialcomm;
+ /** Port is non-blocking. */
+ int nonblocking;
+ /** libserialport port handle */
+ struct sp_port *data;
+ /** libserialport event set */
+ struct sp_event_set *event_set;
+ /** GPollFDs for event polling */
+ GPollFD *pollfds;
+};
+#endif
+
+struct sr_usbtmc_dev_inst {
+ char *device;
int fd;
};
/* Private driver context. */
struct drv_context {
+ /** sigrok context */
struct sr_context *sr_ctx;
GSList *instances;
};
@@ -81,6 +162,16 @@ SR_PRIV int sr_info(const char *format, ...);
SR_PRIV int sr_warn(const char *format, ...);
SR_PRIV int sr_err(const char *format, ...);
+/* 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
+
/*--- device.c --------------------------------------------------------------*/
SR_PRIV struct sr_probe *sr_probe_new(int index, int type,
@@ -99,11 +190,16 @@ SR_PRIV GSList *sr_usb_find_usbtmc(libusb_context *usb_ctx);
SR_PRIV void sr_usb_dev_inst_free(struct sr_usb_dev_inst *usb);
#endif
+#ifdef HAVE_LIBSERIALPORT
/* Serial-specific instances */
SR_PRIV struct sr_serial_dev_inst *sr_serial_dev_inst_new(const char *port,
const char *serialcomm);
SR_PRIV void sr_serial_dev_inst_free(struct sr_serial_dev_inst *serial);
+#endif
+/* USBTMC-specific instances */
+SR_PRIV struct sr_usbtmc_dev_inst *sr_usbtmc_dev_inst_new(const char *device);
+SR_PRIV void sr_usbtmc_dev_inst_free(struct sr_usbtmc_dev_inst *usbtmc);
/*--- hwdriver.c ------------------------------------------------------------*/
@@ -116,6 +212,37 @@ SR_PRIV int sr_source_add(int fd, int events, int timeout,
/*--- session.c -------------------------------------------------------------*/
+struct sr_session {
+ /** List of struct sr_dev pointers. */
+ GSList *devs;
+ /** List of struct datafeed_callback pointers. */
+ GSList *datafeed_callbacks;
+ GTimeVal starttime;
+ gboolean running;
+
+ unsigned int num_sources;
+
+ /*
+ * 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_send(const struct sr_dev_inst *sdi,
const struct sr_datafeed_packet *packet);
SR_PRIV int sr_session_stop_sync(void);
@@ -128,16 +255,28 @@ typedef void (*std_dev_clear_t)(void *priv);
SR_PRIV int std_init(struct sr_context *sr_ctx, struct sr_dev_driver *di,
const char *prefix);
-SR_PRIV int std_dev_acquisition_stop_serial(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_t dev_close_fn,
struct sr_serial_dev_inst *serial, const char *prefix);
+#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,
std_dev_clear_t clear_private);
+SR_PRIV int std_serial_dev_close(struct sr_dev_inst *sdi);
+
+/*--- strutil.c -------------------------------------------------------------*/
+
+SR_PRIV int sr_atol(const char *str, long *ret);
+SR_PRIV int sr_atoi(const char *str, int *ret);
+SR_PRIV int sr_atod(const char *str, double *ret);
+SR_PRIV int sr_atof(const char *str, float *ret);
/*--- hardware/common/serial.c ----------------------------------------------*/
+#ifdef HAVE_LIBSERIALPORT
enum {
SERIAL_RDWR = 1,
SERIAL_RDONLY = 2,
@@ -163,6 +302,12 @@ SR_PRIV int serial_stream_detect(struct sr_serial_dev_inst *serial,
uint8_t *buf, size_t *buflen,
size_t packet_size, packet_valid_t is_valid,
uint64_t timeout_ms, int baudrate);
+SR_PRIV int sr_serial_extract_options(GSList *options, const char **serial_device,
+ const char **serial_options);
+SR_PRIV int serial_source_add(struct sr_serial_dev_inst *serial, int events,
+ int timeout, sr_receive_data_callback_t cb, void *cb_data);
+SR_PRIV int serial_source_remove(struct sr_serial_dev_inst *serial);
+#endif
/*--- hardware/common/ezusb.c -----------------------------------------------*/
@@ -179,8 +324,109 @@ 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 int usb_source_add(struct sr_context *ctx, int timeout,
+ sr_receive_data_callback_t cb, void *cb_data);
+SR_PRIV int usb_source_remove(struct sr_context *ctx);
+#endif
+
+/*--- hardware/common/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,
+};
+
+struct sr_scpi_hw_info {
+ char *manufacturer;
+ char *model;
+ char *serial_number;
+ char *firmware_version;
+};
+
+struct sr_scpi_dev_inst {
+ int (*open)(void *priv);
+ int (*source_add)(void *priv, int events,
+ int timeout, sr_receive_data_callback_t cb, void *cb_data);
+ int (*source_remove)(void *priv);
+ int (*send)(void *priv, const char *command);
+ int (*receive)(void *priv, char **scpi_response);
+ int (*read)(void *priv, char *buf, int maxlen);
+ int (*close)(void *priv);
+ void (*free)(void *priv);
+ void *priv;
+};
+
+SR_PRIV int sr_scpi_open(struct sr_scpi_dev_inst *scpi);
+SR_PRIV int sr_scpi_source_add(struct sr_scpi_dev_inst *scpi, int events,
+ int timeout, sr_receive_data_callback_t cb, void *cb_data);
+SR_PRIV int sr_scpi_source_remove(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_receive(struct sr_scpi_dev_inst *scpi,
+ char **scpi_response);
+SR_PRIV int sr_scpi_read(struct sr_scpi_dev_inst *scpi, char *buf, int maxlen);
+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);
+
+/*--- hardware/common/scpi_serial.c -----------------------------------------*/
+
+#ifdef HAVE_LIBSERIALPORT
+SR_PRIV struct sr_scpi_dev_inst *scpi_serial_dev_inst_new(const char *port,
+ const char *serialcomm);
#endif
+/*--- hardware/common/scpi_tcp.c --------------------------------------------*/
+
+SR_PRIV struct sr_scpi_dev_inst *scpi_tcp_dev_inst_new(const char *address,
+ const char *port);
+
+/*--- hardware/common/scpi_usbtmc.c -----------------------------------------*/
+
+SR_PRIV struct sr_scpi_dev_inst *scpi_usbtmc_dev_inst_new(const char *device);
+
/*--- hardware/common/dmm/es51922.c -----------------------------------------*/
#define ES51922_PACKET_SIZE 14
@@ -277,6 +523,14 @@ SR_PRIV void sr_fs9721_01_temp_c(struct sr_datafeed_analog *analog, void *info);
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);
+/*--- hardware/common/dmm/m2110.c -----------------------------------------*/
+
+#define BBCGM_M2110_PACKET_SIZE 9
+
+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);
+
/*--- hardware/common/dmm/metex14.c -----------------------------------------*/
#define METEX14_PACKET_SIZE 14
@@ -289,7 +543,9 @@ struct metex14_info {
gboolean is_unitless;
};
+#ifdef HAVE_LIBSERIALPORT
SR_PRIV int sr_metex14_packet_request(struct sr_serial_dev_inst *serial);
+#endif
SR_PRIV gboolean sr_metex14_packet_valid(const uint8_t *buf);
SR_PRIV int sr_metex14_parse(const uint8_t *buf, float *floatval,
struct sr_datafeed_analog *analog, void *info);