]> sigrok.org Git - libsigrok.git/blobdiff - src/libsigrok-internal.h
scpi: Make helper functions from scpi-pps available library-wide.
[libsigrok.git] / src / libsigrok-internal.h
index 71fc79a9a6c69e9a710775f8854e57b7d3e54141..4b3daf441151c9d5ed1cfef08c83a4855febc77d 100644 (file)
                   ((unsigned)((const uint8_t*)(x))[1] <<  8) |  \
                    (unsigned)((const uint8_t*)(x))[0]))
 
+/**
+ * Read a 32 bits big endian float out of memory.
+ * @param x a pointer to the input memory
+ * @return the corresponding float
+ */
+#define RBFL(x)  ((union { uint32_t u; float f; }) { .u = RB32(x) }.f)
+
+/**
+ * Read a 32 bits little endian float out of memory.
+ * @param x a pointer to the input memory
+ * @return the corresponding float
+ */
+#define RLFL(x)  ((union { uint32_t u; float f; }) { .u = RL32(x) }.f)
+
 /**
  * Write a 8 bits unsigned integer to memory.
  * @param p a pointer to the output memory
                          ((uint8_t*)(p))[2] = (uint8_t)((x)>>16); \
                          ((uint8_t*)(p))[3] = (uint8_t)((x)>>24); } while (0)
 
+/**
+ * Write a 32 bits float to memory stored as big endian.
+ * @param p a pointer to the output memory
+ * @param x the input float
+ */
+#define WBFL(p, x)  WB32(p, (union { uint32_t u; float f; }) { .f = x }.u)
+
+/**
+ * Write a 32 bits float to memory stored as little endian.
+ * @param p a pointer to the output memory
+ * @param x the input float
+ */
+#define WLFL(p, x)  WL32(p, (union { uint32_t u; float f; }) { .f = x }.u)
+
 /* Portability fixes for FreeBSD. */
 #ifdef __FreeBSD__
 #define LIBUSB_CLASS_APPLICATION 0xfe
 #endif
 
 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;
-       GMutex usb_mutex;
-       HANDLE usb_event;
+       HANDLE usb_wait_request_event;
+       HANDLE usb_wait_complete_event;
        GPollFD usb_pollfd;
        sr_receive_data_callback usb_cb;
        void *usb_cb_data;
@@ -339,6 +368,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.
@@ -378,6 +412,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.
@@ -402,7 +443,7 @@ struct sr_output_module {
        int (*init) (struct sr_output *o, GHashTable *options);
 
        /**
-        * This function is passed a copy of every packed in the data feed.
+        * This function is passed a copy of every packet in the data feed.
         * Any output generated by the output module in response to the
         * packet should be returned in a newly allocated GString
         * <code>out</code>, which will be freed by the caller.
@@ -645,9 +686,11 @@ 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(void);
+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);
@@ -663,6 +706,8 @@ SR_PRIV int sr_source_add_channel(GIOChannel *channel, int events, int timeout,
 /*--- session.c -------------------------------------------------------------*/
 
 struct sr_session {
+       /** Context this session exists in. */
+       struct sr_context *ctx;
        /** List of struct sr_dev_inst pointers. */
        GSList *devs;
        /** List of struct sr_dev_inst pointers owned by this session. */
@@ -827,103 +872,59 @@ 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);
 #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;
-};
+/*--- modbus/modbus.c -------------------------------------------------------*/
 
-struct sr_scpi_dev_inst {
+struct sr_modbus_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);
+       GSList *(*scan)(int modbusaddr);
+       int (*dev_inst_new)(void *priv, const char *resource,
+               char **params, const char *serialcomm, int modbusaddr);
        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 (*send)(void *priv, const uint8_t *buffer, int buffer_size);
+       int (*read_begin)(void *priv, uint8_t *function_code);
+       int (*read_data)(void *priv, uint8_t *buf, int maxlen);
+       int (*read_end)(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_PRIV GSList *sr_modbus_scan(struct drv_context *drvc, GSList *options,
+               struct sr_dev_inst *(*probe_device)(struct sr_modbus_dev_inst *modbus));
+SR_PRIV struct sr_modbus_dev_inst *modbus_dev_inst_new(const char *resource,
+               const char *serialcomm, int modbusaddr);
+SR_PRIV int sr_modbus_open(struct sr_modbus_dev_inst *modbus);
+SR_PRIV int sr_modbus_source_add(struct sr_session *session,
+               struct sr_modbus_dev_inst *modbus, 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);
+SR_PRIV int sr_modbus_source_remove(struct sr_session *session,
+               struct sr_modbus_dev_inst *modbus);
+SR_PRIV int sr_modbus_request(struct sr_modbus_dev_inst *modbus,
+                              uint8_t *request, int request_size);
+SR_PRIV int sr_modbus_reply(struct sr_modbus_dev_inst *modbus,
+                            uint8_t *reply, int reply_size);
+SR_PRIV int sr_modbus_request_reply(struct sr_modbus_dev_inst *modbus,
+                                    uint8_t *request, int request_size,
+                                    uint8_t *reply, int reply_size);
+SR_PRIV int sr_modbus_read_coils(struct sr_modbus_dev_inst *modbus,
+                                 int address, int nb_coils, uint8_t *coils);
+SR_PRIV int sr_modbus_read_holding_registers(struct sr_modbus_dev_inst *modbus,
+                                             int address, int nb_registers,
+                                             uint16_t *registers);
+SR_PRIV int sr_modbus_write_coil(struct sr_modbus_dev_inst *modbus,
+                                 int address, int value);
+SR_PRIV int sr_modbus_write_multiple_registers(struct sr_modbus_dev_inst*modbus,
+                                               int address, int nb_registers,
+                                               uint16_t *registers);
+SR_PRIV int sr_modbus_close(struct sr_modbus_dev_inst *modbus);
+SR_PRIV void sr_modbus_free(struct sr_modbus_dev_inst *modbus);
 
 /*--- hardware/dmm/es519xx.c ------------------------------------------------*/