hantek-6xxx: Add ISDS205B support

[libsigrok.git] / src / hardware / hantek-6xxx / protocol.h

diff --git a/src/hardware/hantek-6xxx/protocol.h b/src/hardware/hantek-6xxx/protocol.h
index cdc1babf98e38a25f9bb9d8a0421f39fae263746..35d2a97f2ef242911d2e4ce461e131592dada1af 100644 (file)
--- a/src/hardware/hantek-6xxx/protocol.h
+++ b/src/hardware/hantek-6xxx/protocol.h
@@ -1,7 +1,7 @@
 /*
  * This file is part of the libsigrok project.
  *
- * Copyright (C) 2015 Chriter <christerekholm@gmail.com>
+ * Copyright (C) 2015 Christer Ekholm <christerekholm@gmail.com>
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -21,24 +21,144 @@
 #define LIBSIGROK_HARDWARE_HANTEK_6XXX_PROTOCOL_H
 
 #include <stdint.h>
+#include <string.h>
 #include <glib.h>
 #include <libsigrok/libsigrok.h>
 #include "libsigrok-internal.h"
 
 #define LOG_PREFIX "hantek-6xxx"
 
-/** Private, per-device-instance driver context. */
-struct dev_context {
-       /* Model-specific information */
+#define MAX_RENUM_DELAY_MS     3000
+
+#define DEFAULT_VOLTAGE                2
+#define DEFAULT_COUPLING       COUPLING_DC
+#define DEFAULT_SAMPLERATE     SR_MHZ(8)
+
+#define NUM_CHANNELS           2
+
+#define SAMPLERATE_VALUES \
+       SR_MHZ(48), SR_MHZ(30), SR_MHZ(24), \
+       SR_MHZ(16), SR_MHZ(8), SR_MHZ(4), \
+       SR_MHZ(1), SR_KHZ(500), SR_KHZ(200), \
+       SR_KHZ(100),
+
+#define SAMPLERATE_REGS \
+       48, 30, 24, 16, 8, 4, 1, 50, 20, 10,
+
+#define VDIV_VALUES \
+       { 1, 1 }, \
+       { 500, 1000 }, \
+       { 250, 1000 }, \
+       { 100, 1000 },
+
+#define VDIV_VALUES_INSTRUSTAR \
+       { 128, 100 }, \
+       { 705, 1000 }, \
+       { 288, 1000 }, \
+       { 140, 1000 }, \
+       { 576, 10000 }, \
+       { 176, 10000 },
+
+#define VDIV_REG \
+       1, 2, 5, 10, 11, 12, 13,
+
+#define VDIV_MULTIPLIER                10
+
+/* Weird flushing needed for filtering glitch away. */
+#define FLUSH_PACKET_SIZE      1024
+
+#define MIN_PACKET_SIZE                512
+#ifdef _WIN32
+#define MAX_PACKET_SIZE                (2 * 1024 * 1024)
+#else
+#define MAX_PACKET_SIZE                (12 * 1024 * 1024)
+#endif
 
-       /* Acquisition settings */
+#define HANTEK_EP_IN           0x86
+#define USB_INTERFACE          0
+#define USB_CONFIGURATION      1
 
-       /* Operational state */
+enum control_requests {
+       VDIV_CH1_REG   = 0xe0,
+       VDIV_CH2_REG   = 0xe1,
+       SAMPLERATE_REG = 0xe2,
+       TRIGGER_REG    = 0xe3,
+       CHANNELS_REG   = 0xe4,
+       COUPLING_REG   = 0xe5,
+};
+
+enum states {
+       IDLE,
+       FLUSH,
+       CAPTURE,
+       STOPPING,
+};
+
+enum couplings {
+       COUPLING_AC = 0,
+       COUPLING_DC,
+};
+
+struct hantek_6xxx_profile {
+       /* VID/PID after cold boot */
+       uint16_t orig_vid;
+       uint16_t orig_pid;
+       /* VID/PID after firmware upload */
+       uint16_t fw_vid;
+       uint16_t fw_pid;
+       uint16_t fw_prod_ver;
+       const char *vendor;
+       const char *model;
+       const char *firmware;
+       const char **coupling_vals;
+       uint8_t coupling_tab_size;
+       gboolean has_coupling;
+       const uint64_t (*vdivs)[2];
+       const uint32_t vdivs_size;
+};
+
+struct dev_context {
+       const struct hantek_6xxx_profile *profile;
+       GSList *enabled_channels;
+       /*
+        * 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.
+        */
+       int64_t fw_updated;
+       int dev_state;
+       uint64_t samp_received;
+       uint64_t aq_started;
 
-       /* Temporary state across callbacks */
+       uint64_t read_start_ts;
 
+       gboolean ch_enabled[NUM_CHANNELS];
+       int voltage[NUM_CHANNELS];
+       int coupling[NUM_CHANNELS];
+       const char **coupling_vals;
+       uint8_t coupling_tab_size;
+       gboolean has_coupling;
+       uint64_t samplerate;
+       const uint64_t (*vdivs)[2];
+       uint8_t vdivs_size;
+
+       uint64_t limit_msec;
+       uint64_t limit_samples;
 };
 
-SR_PRIV int hantek_6xxx_receive_data(int fd, int revents, void *cb_data);
+SR_PRIV int hantek_6xxx_open(struct sr_dev_inst *sdi);
+SR_PRIV void hantek_6xxx_close(struct sr_dev_inst *sdi);
+SR_PRIV int hantek_6xxx_get_channeldata(const struct sr_dev_inst *sdi,
+               libusb_transfer_cb_fn cb, uint32_t data_amount);
+
+SR_PRIV int hantek_6xxx_start_data_collecting(const struct sr_dev_inst *sdi);
+SR_PRIV int hantek_6xxx_stop_data_collecting(const struct sr_dev_inst *sdi);
+
+SR_PRIV int hantek_6xxx_update_coupling(const struct sr_dev_inst *sdi);
+SR_PRIV int hantek_6xxx_update_samplerate(const struct sr_dev_inst *sdi);
+SR_PRIV int hantek_6xxx_update_vdiv(const struct sr_dev_inst *sdi);
+SR_PRIV int hantek_6xxx_update_channels(const struct sr_dev_inst *sdi);
+SR_PRIV int hantek_6xxx_init(const struct sr_dev_inst *sdi);
 
 #endif