]> sigrok.org Git - libsigrok.git/blobdiff - libsigrok-internal.h
Make SCPI functions device independent, with separate serial backend.
[libsigrok.git] / libsigrok-internal.h
index c418c4e1dc53b1c1e6599e8adc3eb3226c4962d0..3df28fe2195b0727aa2ee8b9936e02b389076bab 100644 (file)
@@ -75,10 +75,16 @@ struct sr_serial_dev_inst {
        char *port;
        char *serialcomm;
        int fd;
+       int nonblocking;
        struct sp_port *data;
 };
 #endif
 
+struct sr_usbtmc_dev_inst {
+       char *device;
+       int fd;
+};
+
 /* Private driver context. */
 struct drv_context {
        struct sr_context *sr_ctx;
@@ -119,6 +125,9 @@ SR_PRIV struct sr_serial_dev_inst *sr_serial_dev_inst_new(const char *port,
 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 ------------------------------------------------------------*/
 
@@ -131,6 +140,35 @@ 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.
+        */
+       GMutex stop_mutex;
+       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);
@@ -153,6 +191,13 @@ SR_PRIV int std_session_send_df_header(const struct sr_dev_inst *sdi,
 SR_PRIV int std_dev_clear(const struct sr_dev_driver *driver,
                std_dev_clear_t clear_private);
 
+/*--- 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
@@ -181,6 +226,8 @@ 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);
 #endif
 
 /*--- hardware/common/ezusb.c -----------------------------------------------*/
@@ -200,6 +247,93 @@ 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);
 #endif
 
+/*--- hardware/common/scpi.c ------------------------------------------------*/
+
+#ifdef HAVE_LIBSERIALPORT
+
+#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 (*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 *command);
+SR_PRIV int sr_scpi_receive(struct sr_scpi_dev_inst *scpi,
+                       char **scpi_response);
+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);
+
+#endif
+
+/*--- hardware/common/scpi_serial.c -----------------------------------------*/
+
+SR_PRIV struct sr_scpi_dev_inst *scpi_serial_dev_inst_new(const char *port,
+                       const char *serialcomm);
+
 /*--- hardware/common/dmm/es51922.c -----------------------------------------*/
 
 #define ES51922_PACKET_SIZE 14