]> sigrok.org Git - libsigrok.git/blobdiff - src/libsigrok-internal.h
Add initial Voltcraft VC-870 support.
[libsigrok.git] / src / libsigrok-internal.h
index 75b9d5a4761a2605623eedb8264d089dbe1db929..6617e7ae6fb167b63e99cc01702c385149980045 100644 (file)
 /* Portability fixes for FreeBSD. */
 #ifdef __FreeBSD__
 #define LIBUSB_CLASS_APPLICATION 0xfe
+#define libusb_has_capability(x) 0
 #define libusb_handle_events_timeout_completed(ctx, tv, c) \
        libusb_handle_events_timeout(ctx, tv)
 #endif
@@ -237,6 +238,13 @@ struct sr_input_module {
         */
        const char *desc;
 
+       /**
+        * A NULL terminated array of strings containing a list of file name
+        * extensions typical for the input file format, or NULL if there is
+        * no typical extension for this file format.
+        */
+       const char *const *exts;
+
        /**
         * Zero-terminated list of metadata items the module needs to be able
         * to identify an input stream. Can be all-zero, if the module cannot
@@ -363,6 +371,13 @@ struct sr_output_module {
         */
        char *desc;
 
+       /**
+        * A NULL terminated array of strings containing a list of file name
+        * extensions typical for the input file format, or NULL if there is
+        * no typical extension for this file format.
+        */
+       const char *const *exts;
+
        /**
         * Returns a NULL-terminated list of options this module can take.
         * Can be NULL, if the module has no options.
@@ -418,6 +433,93 @@ struct sr_output_module {
        int (*cleanup) (struct sr_output *o);
 };
 
+/** Transform module instance. */
+struct sr_transform {
+       /** A pointer to this transform's module.  */
+       const struct sr_transform_module *module;
+
+       /**
+        * The device for which this transform module is used. This
+        * can be used by the module to find out channel names and numbers.
+        */
+       const struct sr_dev_inst *sdi;
+
+       /**
+        * A generic pointer which can be used by the module to keep internal
+        * state between calls into its callback functions.
+        */
+       void *priv;
+};
+
+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;
+
+       /**
+        * A unique name for this transform module, suitable for use in GUI
+        * clients, can contain UTF-8. Must not be NULL.
+        */
+       const char *name;
+
+       /**
+        * A short description of the transform module. Must not be NULL.
+        *
+        * This can be displayed by frontends, e.g. when selecting
+        * which transform module(s) to add.
+        */
+       char *desc;
+
+       /**
+        * Returns a NULL-terminated list of options this transform module
+        * can take. Can be NULL, if the transform module has no options.
+        */
+       const struct sr_option *(*options) (void);
+
+       /**
+        * This function is called once, at the beginning of a stream.
+        *
+        * @param t Pointer to the respective 'struct sr_transform'.
+        * @param options Hash table of options for this transform module.
+        *                Can be NULL if no options are to be used.
+        *
+        * @retval SR_OK Success
+        * @retval other Negative error code.
+        */
+       int (*init) (struct sr_transform *t, GHashTable *options);
+
+       /**
+        * This function is passed a pointer to every packet in the data feed.
+        *
+        * It can either return (in packet_out) a pointer to another packet
+        * (possibly the exact same packet it got as input), or NULL.
+        *
+        * @param t Pointer to the respective 'struct sr_transform'.
+        * @param packet_in Pointer to a datafeed packet.
+        * @param packet_out Pointer to the resulting datafeed packet after
+        *                   this function was run. If NULL, the transform
+        *                   module intentionally didn't output a new packet.
+        *
+        * @retval SR_OK Success
+        * @retval other Negative error code.
+        */
+       int (*receive) (const struct sr_transform *t,
+                       struct sr_datafeed_packet *packet_in,
+                       struct sr_datafeed_packet **packet_out);
+
+       /**
+        * This function is called after the caller is finished using
+        * the transform module, and can be used to free any internal
+        * resources the module may keep.
+        *
+        * @retval SR_OK Success
+        * @retval other Negative error code.
+        */
+       int (*cleanup) (struct sr_transform *t);
+};
+
 #ifdef HAVE_LIBUSB_1_0
 /** USB device instance */
 struct sr_usb_dev_inst {
@@ -487,12 +589,40 @@ enum {
        SR_CHANNEL_SET_ENABLED = 1 << 0,
 };
 
-SR_PRIV struct sr_channel *sr_channel_new(int index, int type,
-               gboolean enabled, const char *name);
+SR_PRIV struct sr_channel *sr_channel_new(struct sr_dev_inst *sdi,
+               int index, int type, gboolean enabled, const char *name);
+
+/** Device instance data */
+struct sr_dev_inst {
+       /** Device driver. */
+       struct sr_dev_driver *driver;
+       /** Device instance status. SR_ST_NOT_FOUND, etc. */
+       int status;
+       /** Device instance type. SR_INST_USB, etc. */
+       int inst_type;
+       /** Device vendor. */
+       char *vendor;
+       /** Device model. */
+       char *model;
+       /** Device version. */
+       char *version;
+       /** Serial number. */
+       char *serial_num;
+       /** Connection string to uniquely identify devices. */
+       char *connection_id;
+       /** List of channels. */
+       GSList *channels;
+       /** List of sr_channel_group structs */
+       GSList *channel_groups;
+       /** Device instance connection data (used?) */
+       void *conn;
+       /** Device instance private data (used?) */
+       void *priv;
+       /** Session to which this device is currently assigned. */
+       struct sr_session *session;
+};
 
 /* Generic device instances */
-SR_PRIV struct sr_dev_inst *sr_dev_inst_new(int status,
-               const char *vendor, const char *model, const char *version);
 SR_PRIV void sr_dev_inst_free(struct sr_dev_inst *sdi);
 
 #ifdef HAVE_LIBUSB_1_0
@@ -533,10 +663,13 @@ SR_PRIV int sr_source_add_channel(GIOChannel *channel, int events, int timeout,
 /*--- session.c -------------------------------------------------------------*/
 
 struct sr_session {
-       /** List of struct sr_dev pointers. */
+       /** List of struct sr_dev_inst pointers. */
        GSList *devs;
+       /** List of struct sr_dev_inst pointers owned by this session. */
+       GSList *owned_devs;
        /** List of struct datafeed_callback pointers. */
        GSList *datafeed_callbacks;
+       GSList *transforms;
        struct sr_trigger *trigger;
        GTimeVal starttime;
        gboolean running;
@@ -572,6 +705,14 @@ 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);
 
+/*--- analog.c --------------------------------------------------------------*/
+
+SR_PRIV int sr_analog_init(struct sr_datafeed_analog2 *analog,
+                           struct sr_analog_encoding *encoding,
+                           struct sr_analog_meaning *meaning,
+                           struct sr_analog_spec *spec,
+                           int digits);
+
 /*--- std.c -----------------------------------------------------------------*/
 
 typedef int (*dev_close_callback)(struct sr_dev_inst *sdi);
@@ -608,15 +749,20 @@ struct soft_trigger_logic {
        int unitsize;
        int cur_stage;
        uint8_t *prev_sample;
+       uint8_t *pre_trigger_buffer;
+       uint8_t *pre_trigger_head;
+       int pre_trigger_size;
+       int pre_trigger_fill;
 };
 
 SR_PRIV struct soft_trigger_logic *soft_trigger_logic_new(
-               const struct sr_dev_inst *sdi, struct sr_trigger *trigger);
+               const struct sr_dev_inst *sdi, struct sr_trigger *trigger,
+               int pre_trigger_samples);
 SR_PRIV void soft_trigger_logic_free(struct soft_trigger_logic *st);
 SR_PRIV int soft_trigger_logic_check(struct soft_trigger_logic *st, uint8_t *buf,
-               int len);
+               int len, int *pre_trigger_samples);
 
-/*--- hardware/common/serial.c ----------------------------------------------*/
+/*--- hardware/serial.c -----------------------------------------------------*/
 
 #ifdef HAVE_LIBSERIALPORT
 enum {
@@ -629,6 +775,7 @@ typedef gboolean (*packet_valid_callback)(const uint8_t *buf);
 SR_PRIV int serial_open(struct sr_serial_dev_inst *serial, int flags);
 SR_PRIV int serial_close(struct sr_serial_dev_inst *serial);
 SR_PRIV int serial_flush(struct sr_serial_dev_inst *serial);
+SR_PRIV int serial_drain(struct sr_serial_dev_inst *serial);
 SR_PRIV int serial_write_blocking(struct sr_serial_dev_inst *serial,
                const void *buf, size_t count, unsigned int timeout_ms);
 SR_PRIV int serial_write_nonblocking(struct sr_serial_dev_inst *serial,
@@ -659,7 +806,7 @@ SR_PRIV GSList *sr_serial_find_usb(uint16_t vendor_id, uint16_t product_id);
 SR_PRIV int serial_timeout(struct sr_serial_dev_inst *port, int num_bytes);
 #endif
 
-/*--- hardware/common/ezusb.c -----------------------------------------------*/
+/*--- hardware/ezusb.c ------------------------------------------------------*/
 
 #ifdef HAVE_LIBUSB_1_0
 SR_PRIV int ezusb_reset(struct libusb_device_handle *hdl, int set_clear);
@@ -669,7 +816,7 @@ SR_PRIV int ezusb_upload_firmware(libusb_device *dev, int configuration,
                                  const char *filename);
 #endif
 
-/*--- hardware/common/usb.c -------------------------------------------------*/
+/*--- hardware/usb.c --------------------------------------------------------*/
 
 #ifdef HAVE_LIBUSB_1_0
 SR_PRIV GSList *sr_usb_find(libusb_context *usb_ctx, const char *conn);
@@ -680,7 +827,7 @@ 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/common/scpi.c ------------------------------------------------*/
+/*--- hardware/scpi.c -------------------------------------------------------*/
 
 #define SCPI_CMD_IDN "*IDN?"
 #define SCPI_CMD_OPC "*OPC?"
@@ -778,7 +925,7 @@ 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/dmm/es519xx.c -----------------------------------------*/
+/*--- hardware/dmm/es519xx.c ------------------------------------------------*/
 
 /**
  * All 11-byte es519xx chips repeat each block twice for each conversion cycle
@@ -823,7 +970,7 @@ SR_PRIV gboolean sr_es519xx_19200_14b_sel_lpf_packet_valid(const uint8_t *buf);
 SR_PRIV int sr_es519xx_19200_14b_sel_lpf_parse(const uint8_t *buf,
                float *floatval, struct sr_datafeed_analog *analog, void *info);
 
-/*--- hardware/common/dmm/fs9922.c ------------------------------------------*/
+/*--- hardware/dmm/fs9922.c -------------------------------------------------*/
 
 #define FS9922_PACKET_SIZE 14
 
@@ -841,7 +988,7 @@ SR_PRIV int sr_fs9922_parse(const uint8_t *buf, float *floatval,
                            struct sr_datafeed_analog *analog, void *info);
 SR_PRIV void sr_fs9922_z1_diode(struct sr_datafeed_analog *analog, void *info);
 
-/*--- hardware/common/dmm/fs9721.c ------------------------------------------*/
+/*--- hardware/dmm/fs9721.c -------------------------------------------------*/
 
 #define FS9721_PACKET_SIZE 14
 
@@ -861,7 +1008,7 @@ 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/common/dmm/m2110.c -----------------------------------------*/
+/*--- hardware/dmm/m2110.c --------------------------------------------------*/
 
 #define BBCGM_M2110_PACKET_SIZE 9
 
@@ -869,7 +1016,7 @@ 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 -----------------------------------------*/
+/*--- hardware/dmm/metex14.c ------------------------------------------------*/
 
 #define METEX14_PACKET_SIZE 14
 
@@ -888,7 +1035,7 @@ 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);
 
-/*--- hardware/common/dmm/rs9lcd.c ------------------------------------------*/
+/*--- hardware/dmm/rs9lcd.c -------------------------------------------------*/
 
 #define RS9LCD_PACKET_SIZE 9
 
@@ -899,7 +1046,7 @@ SR_PRIV gboolean sr_rs9lcd_packet_valid(const uint8_t *buf);
 SR_PRIV int sr_rs9lcd_parse(const uint8_t *buf, float *floatval,
                            struct sr_datafeed_analog *analog, void *info);
 
-/*--- hardware/common/dmm/bm25x.c -----------------------------------------*/
+/*--- hardware/dmm/bm25x.c --------------------------------------------------*/
 
 #define BRYMEN_BM25X_PACKET_SIZE 15
 
@@ -910,7 +1057,43 @@ SR_PRIV gboolean sr_brymen_bm25x_packet_valid(const uint8_t *buf);
 SR_PRIV int sr_brymen_bm25x_parse(const uint8_t *buf, float *floatval,
                             struct sr_datafeed_analog *analog, void *info);
 
-/*--- hardware/common/lcr/es51919.c ---------------------------------------*/
+/*--- hardware/dmm/ut71x.c --------------------------------------------------*/
+
+#define UT71X_PACKET_SIZE 11
+
+struct ut71x_info {
+       gboolean is_voltage, is_resistance, is_capacitance, is_temperature;
+       gboolean is_celsius, is_fahrenheit, is_current, is_continuity;
+       gboolean is_diode, is_frequency, is_duty_cycle, is_dc, is_ac;
+       gboolean is_auto, is_manual, is_sign, is_power, is_loop_current;
+};
+
+SR_PRIV gboolean sr_ut71x_packet_valid(const uint8_t *buf);
+SR_PRIV int sr_ut71x_parse(const uint8_t *buf, float *floatval,
+               struct sr_datafeed_analog *analog, void *info);
+
+/*--- hardware/dmm/vc870.c --------------------------------------------------*/
+
+#define VC870_PACKET_SIZE 23
+
+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_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;
+};
+
+SR_PRIV gboolean sr_vc870_packet_valid(const uint8_t *buf);
+SR_PRIV int sr_vc870_parse(const uint8_t *buf, float *floatval,
+               struct sr_datafeed_analog *analog, void *info);
+
+/*--- hardware/lcr/es51919.c ------------------------------------------------*/
 
 SR_PRIV void es51919_serial_clean(void *priv);
 SR_PRIV struct sr_dev_inst *es51919_serial_scan(GSList *options,
@@ -930,4 +1113,16 @@ 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,
                                            void *cb_data);
 
+/*--- hardware/dmm/ut372.c --------------------------------------------------*/
+
+#define UT372_PACKET_SIZE 27
+
+struct ut372_info {
+       int dummy;
+};
+
+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);
+
 #endif