src/hardware/hantek-dso/protocol.h

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2012 Bert Vermeulen <bert@biot.com>
   5  * With protocol information from the hantekdso project,
   6  * Copyright (C) 2008 Oleg Khudyakov <prcoder@gmail.com>
   7  *
   8  * This program is free software: you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation, either version 3 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  20  */
  21
  22 #ifndef LIBSIGROK_HARDWARE_HANTEK_DSO_PROTOCOL_H
  23 #define LIBSIGROK_HARDWARE_HANTEK_DSO_PROTOCOL_H
  24
  25 #define LOG_PREFIX "hantek-dso"
  26
  27 #define USB_INTERFACE           0
  28 #define USB_CONFIGURATION       1
  29 #define DSO_EP_IN               0x86
  30 #define DSO_EP_OUT              0x02
  31
  32 /* FX2 renumeration delay in ms */
  33 #define MAX_RENUM_DELAY_MS      3000
  34
  35 #define MAX_CAPTURE_EMPTY       3
  36
  37 #define DEFAULT_VOLTAGE         VDIV_500MV
  38 #define DEFAULT_FRAMESIZE       FRAMESIZE_SMALL
  39 #define DEFAULT_TIMEBASE        TIME_100us
  40 #define DEFAULT_TRIGGER_SOURCE  "CH1"
  41 #define DEFAULT_COUPLING        COUPLING_DC
  42 #define DEFAULT_HORIZ_TRIGGERPOS 0.5
  43 #define DEFAULT_VERT_OFFSET     0.5
  44 #define DEFAULT_VERT_TRIGGERPOS 0.5
  45
  46 #define MAX_VERT_TRIGGER        0xfe
  47
  48 /* Hantek DSO-specific protocol values */
  49 #define EEPROM_CHANNEL_OFFSETS  0x08
  50
  51 /* All models have this for their "fast" mode. */
  52 #define FRAMESIZE_SMALL         (10 * 1024)
  53
  54 #define NUM_CHANNELS            2
  55
  56 enum control_requests {
  57         CTRL_READ_EEPROM = 0xa2,
  58         CTRL_GETSPEED = 0xb2,
  59         CTRL_BEGINCOMMAND = 0xb3,
  60         CTRL_SETOFFSET = 0xb4,
  61         CTRL_SETRELAYS = 0xb5,
  62 };
  63
  64 enum dso_commands {
  65         CMD_SET_FILTERS                     = 0x0,
  66         CMD_SET_TRIGGER_SAMPLERATE          = 0x1,
  67         CMD_FORCE_TRIGGER                   = 0x2,
  68         CMD_CAPTURE_START                   = 0x3,
  69         CMD_ENABLE_TRIGGER                  = 0x4,
  70         CMD_GET_CHANNELDATA                 = 0x5,
  71         CMD_GET_CAPTURESTATE                = 0x6,
  72         CMD_SET_VOLTAGE                     = 0x7,
  73         /* unused */
  74         CMD_SET_LOGICALDATA                 = 0x8,
  75         CMD_GET_LOGICALDATA                 = 0x9,
  76         CMD__UNUSED1                        = 0xa,
  77         /* For the following and other specials please see
  78          * http://openhantek.sourceforge.net/doc/namespaceHantek.html#ac1cd181814cf3da74771c29800b39028 */
  79         CMD_2250_SET_CHANNELS               = 0xb,
  80         CMD_2250_SET_TRIGGERSOURCE          = 0xc,
  81         CMD_2250_SET_RECORD_LENGTH          = 0xd,
  82         CMD_2250_SET_SAMPLERATE             = 0xe,
  83         CMD_2250_SET_TRIGGERPOS_AND_BUFFER  = 0xf,
  84 };
  85
  86 /* Must match the coupling table. */
  87 enum couplings {
  88         COUPLING_AC = 0,
  89         COUPLING_DC,
  90         /* TODO not used, how to enable? */
  91         COUPLING_GND,
  92 };
  93
  94 /* Must match the timebases table. */
  95 enum time_bases {
  96         TIME_10us = 0,
  97         TIME_20us,
  98         TIME_40us,
  99         TIME_100us,
 100         TIME_200us,
 101         TIME_400us,
 102         TIME_1ms,
 103         TIME_2ms,
 104         TIME_4ms,
 105         TIME_10ms,
 106         TIME_20ms,
 107         TIME_40ms,
 108         TIME_100ms,
 109         TIME_200ms,
 110         TIME_400ms,
 111 };
 112
 113 /* Must match the vdivs table. */
 114 enum {
 115         VDIV_10MV,
 116         VDIV_20MV,
 117         VDIV_50MV,
 118         VDIV_100MV,
 119         VDIV_200MV,
 120         VDIV_500MV,
 121         VDIV_1V,
 122         VDIV_2V,
 123         VDIV_5V,
 124 };
 125
 126 enum trigger_slopes {
 127         SLOPE_POSITIVE = 0,
 128         SLOPE_NEGATIVE,
 129 };
 130
 131 enum trigger_sources {
 132         TRIGGER_CH2 = 0,
 133         TRIGGER_CH1,
 134         TRIGGER_EXT,
 135 };
 136
 137 enum capturestates {
 138         CAPTURE_EMPTY = 0,
 139         CAPTURE_FILLING = 1,
 140         CAPTURE_READY_8BIT = 2,
 141         CAPTURE_READY2250 = 3,
 142         CAPTURE_READY_9BIT = 7,
 143         CAPTURE_TIMEOUT = 127,
 144         CAPTURE_UNKNOWN = 255,
 145 };
 146
 147 enum triggermodes {
 148         TRIGGERMODE_AUTO,
 149         TRIGGERMODE_NORMAL,
 150         TRIGGERMODE_SINGLE,
 151 };
 152
 153 enum states {
 154         IDLE,
 155         NEW_CAPTURE,
 156         CAPTURE,
 157         FETCH_DATA,
 158         STOPPING,
 159 };
 160
 161 struct dso_profile {
 162         /* VID/PID after cold boot */
 163         uint16_t orig_vid;
 164         uint16_t orig_pid;
 165         /* VID/PID after firmware upload */
 166         uint16_t fw_vid;
 167         uint16_t fw_pid;
 168         const char *vendor;
 169         const char *model;
 170         const uint64_t *buffersizes;
 171         const char *firmware;
 172 };
 173
 174 struct dev_context {
 175         const struct dso_profile *profile;
 176         uint64_t limit_frames;
 177         uint64_t num_frames;
 178         GSList *enabled_channels;
 179         /* We can't keep track of an FX2-based device after upgrading
 180          * the firmware (it re-enumerates into a different device address
 181          * after the upgrade) this is like a global lock. No device will open
 182          * until a proper delay after the last device was upgraded.
 183          */
 184         int64_t fw_updated;
 185         int epin_maxpacketsize;
 186         int capture_empty_count;
 187         int dev_state;
 188
 189         /* Oscilloscope settings. */
 190         int timebase;
 191         gboolean ch_enabled[2];
 192         int voltage[2];
 193         int coupling[2];
 194         // voltage offset (vertical position)
 195         float voffset_ch1;
 196         float voffset_ch2;
 197         float voffset_trigger;
 198         uint16_t channel_levels[2][9][2];
 199         unsigned int framesize;
 200         gboolean filter[2];
 201         int triggerslope;
 202         char *triggersource;
 203         float triggerposition;
 204         int triggermode;
 205
 206         /* Frame transfer */
 207         unsigned int samp_received;
 208         unsigned int samp_buffered;
 209         unsigned int trigger_offset;
 210         unsigned char *framebuf;
 211 };
 212
 213 SR_PRIV int dso_open(struct sr_dev_inst *sdi);
 214 SR_PRIV void dso_close(struct sr_dev_inst *sdi);
 215 SR_PRIV int dso_enable_trigger(const struct sr_dev_inst *sdi);
 216 SR_PRIV int dso_force_trigger(const struct sr_dev_inst *sdi);
 217 SR_PRIV int dso_init(const struct sr_dev_inst *sdi);
 218 SR_PRIV int dso_get_capturestate(const struct sr_dev_inst *sdi,
 219                 uint8_t *capturestate, uint32_t *trigger_offset);
 220 SR_PRIV int dso_capture_start(const struct sr_dev_inst *sdi);
 221 SR_PRIV int dso_get_channeldata(const struct sr_dev_inst *sdi,
 222                 libusb_transfer_cb_fn cb);
 223
 224 #endif