]> sigrok.org Git - libsigrok.git/blobdiff - hardware/hantek-dso/dso.h
GPL headers: Use correct project name.
[libsigrok.git] / hardware / hantek-dso / dso.h
index 145f584bae6034893bf04cf629751f66447a1570..eaa37e788f95b2a0241a98157f8b2e9e3aac645b 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * This file is part of the sigrok project.
+ * This file is part of the libsigrok project.
  *
  * Copyright (C) 2012 Bert Vermeulen <bert@biot.com>
  * With protocol information from the hantekdso project,
 #ifndef LIBSIGROK_HARDWARE_HANTEK_DSO_H
 #define LIBSIGROK_HARDWARE_HANTEK_DSO_H
 
-#define USB_INTERFACE          0
-#define USB_CONFIGURATION      1
-#define DSO_EP_IN              0x86
-#define DSO_EP_OUT             0x02
+/* Message logging helpers with driver-specific prefix string. */
+#define DRIVER_LOG_DOMAIN "hantek-dso: "
+#define sr_log(l, s, args...) sr_log(l, DRIVER_LOG_DOMAIN s, ## args)
+#define sr_spew(s, args...) sr_spew(DRIVER_LOG_DOMAIN s, ## args)
+#define sr_dbg(s, args...) sr_dbg(DRIVER_LOG_DOMAIN s, ## args)
+#define sr_info(s, args...) sr_info(DRIVER_LOG_DOMAIN s, ## args)
+#define sr_warn(s, args...) sr_warn(DRIVER_LOG_DOMAIN s, ## args)
+#define sr_err(s, args...) sr_err(DRIVER_LOG_DOMAIN s, ## args)
+
+#define USB_INTERFACE           0
+#define USB_CONFIGURATION       1
+#define DSO_EP_IN               0x86
+#define DSO_EP_OUT              0x02
 
 /* FX2 renumeration delay in ms */
-#define MAX_RENUM_DELAY        3000
+#define MAX_RENUM_DELAY_MS      3000
 
-#define MAX_CAPTURE_EMPTY      3
+#define MAX_CAPTURE_EMPTY       3
 
-#define DEFAULT_VOLTAGE            VDIV_500MV
-#define DEFAULT_FRAMESIZE          FRAMESIZE_SMALL
-#define DEFAULT_TIMEBASE           TIME_100us
-#define DEFAULT_TRIGGER_SOURCE     "CH1"
-#define DEFAULT_COUPLING           COUPLING_AC
-#define DEFAULT_HORIZ_TRIGGERPOS   0.5
-#define DEFAULT_VERT_OFFSET        0.5
-#define DEFAULT_VERT_TRIGGERPOS    0.0
+#define DEFAULT_VOLTAGE         VDIV_500MV
+#define DEFAULT_FRAMESIZE       FRAMESIZE_SMALL
+#define DEFAULT_TIMEBASE        TIME_100us
+#define DEFAULT_TRIGGER_SOURCE  "CH1"
+#define DEFAULT_COUPLING        COUPLING_DC
+#define DEFAULT_HORIZ_TRIGGERPOS 0.5
+#define DEFAULT_VERT_OFFSET     0.5
+#define DEFAULT_VERT_TRIGGERPOS 0.5
 
-#define MAX_VERT_TRIGGER           0xfe
+#define MAX_VERT_TRIGGER        0xfe
 
 /* Hantek DSO-specific protocol values */
-#define EEPROM_CHANNEL_OFFSETS     0x08
-
-#define FRAMESIZE_SMALL        10240
-#define FRAMESIZE_LARGE        32768
+#define EEPROM_CHANNEL_OFFSETS  0x08
 
+/* All models have this for their "fast" mode. */
+#define FRAMESIZE_SMALL         10240
 
 enum control_requests {
        CTRL_READ_EEPROM = 0xa2,
        CTRL_GETSPEED = 0xb2,
        CTRL_BEGINCOMMAND = 0xb3,
        CTRL_SETOFFSET = 0xb4,
-       CTRL_SETRELAYS = 0xb5
+       CTRL_SETRELAYS = 0xb5,
 };
 
 enum dso_commands {
@@ -69,14 +77,15 @@ enum dso_commands {
        CMD_SET_VOLTAGE,
        /* unused */
        cmdSetLogicalData,
-       cmdGetLogicalData
+       cmdGetLogicalData,
 };
 
 /* Must match the coupling table. */
 enum couplings {
        COUPLING_AC = 0,
        COUPLING_DC,
-       COUPLING_GND
+       /* TODO not used, how to enable? */
+       COUPLING_GND,
 };
 
 /* Must match the timebases table. */
@@ -95,7 +104,7 @@ enum time_bases {
        TIME_40ms,
        TIME_100ms,
        TIME_200ms,
-       TIME_400ms
+       TIME_400ms,
 };
 
 /* Must match the vdivs table. */
@@ -113,7 +122,7 @@ enum {
 
 enum trigger_slopes {
        SLOPE_POSITIVE = 0,
-       SLOPE_NEGATIVE
+       SLOPE_NEGATIVE,
 };
 
 enum trigger_sources {
@@ -128,20 +137,21 @@ enum capturestates {
        CAPTURE_READY_8BIT = 2,
        CAPTURE_READY_9BIT = 7,
        CAPTURE_TIMEOUT = 127,
-       CAPTURE_UNKNOWN = 255
+       CAPTURE_UNKNOWN = 255,
 };
 
 enum triggermodes {
        TRIGGERMODE_AUTO,
        TRIGGERMODE_NORMAL,
-       TRIGGERMODE_SINGLE
+       TRIGGERMODE_SINGLE,
 };
 
 enum states {
        IDLE,
        NEW_CAPTURE,
        CAPTURE,
-       FETCH_DATA
+       FETCH_DATA,
+       STOPPING,
 };
 
 struct dso_profile {
@@ -153,28 +163,27 @@ struct dso_profile {
        uint16_t fw_pid;
        char *vendor;
        char *model;
-       char *model_version;
-       int num_probes;
+       const uint64_t *buffersizes;
        char *firmware;
 };
 
-struct context {
-       struct dso_profile *profile;
-       struct sr_usb_dev_inst *usb;
+struct dev_context {
+       const struct dso_profile *profile;
        void *cb_data;
        uint64_t limit_frames;
        uint64_t num_frames;
+       GSList *enabled_probes;
        /* We can't keep track of an FX2-based device after upgrading
         * the firmware (it re-enumerates into a different device address
         * after the upgrade) this is like a global lock. No device will open
         * until a proper delay after the last device was upgraded.
         */
-       GTimeVal fw_updated;
+       int64_t fw_updated;
        int epin_maxpacketsize;
        int capture_empty_count;
-       int current_transfer;
        int dev_state;
 
+       /* Oscilloscope settings. */
        int timebase;
        gboolean ch1_enabled;
        gboolean ch2_enabled;
@@ -187,7 +196,7 @@ struct context {
        float voffset_ch2;
        float voffset_trigger;
        uint16_t channel_levels[2][9][2];
-       int framesize;
+       unsigned int framesize;
        gboolean filter_ch1;
        gboolean filter_ch2;
        gboolean filter_trigger;
@@ -195,15 +204,23 @@ struct context {
        char *triggersource;
        float triggerposition;
        int triggermode;
+
+       /* Frame transfer */
+       unsigned int samp_received;
+       unsigned int samp_buffered;
+       unsigned int trigger_offset;
+       unsigned char *framebuf;
 };
 
-SR_PRIV int dso_open(int dev_index);
+SR_PRIV int dso_open(struct sr_dev_inst *sdi);
 SR_PRIV void dso_close(struct sr_dev_inst *sdi);
-SR_PRIV int dso_enable_trigger(struct context *ctx);
-SR_PRIV int dso_force_trigger(struct context *ctx);
-SR_PRIV int dso_init(struct context *ctx);
-SR_PRIV uint8_t dso_get_capturestate(struct context *ctx);
-SR_PRIV uint8_t dso_capture_start(struct context *ctx);
-SR_PRIV int dso_get_channeldata(struct context *ctx, libusb_transfer_cb_fn cb);
+SR_PRIV int dso_enable_trigger(const struct sr_dev_inst *sdi);
+SR_PRIV int dso_force_trigger(const struct sr_dev_inst *sdi);
+SR_PRIV int dso_init(const struct sr_dev_inst *sdi);
+SR_PRIV int dso_get_capturestate(const struct sr_dev_inst *sdi,
+               uint8_t *capturestate, uint32_t *trigger_offset);
+SR_PRIV int dso_capture_start(const struct sr_dev_inst *sdi);
+SR_PRIV int dso_get_channeldata(const struct sr_dev_inst *sdi,
+               libusb_transfer_cb_fn cb);
 
 #endif