hardware/hantek-dso/dso.h

   1 /*
   2  * This file is part of the sigrok 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_H
  23 #define LIBSIGROK_HARDWARE_HANTEK_DSO_H
  24
  25 #define USB_INTERFACE                   0
  26 #define USB_CONFIGURATION               1
  27 #define DSO_EP_IN                       0x86
  28 #define DSO_EP_OUT                      0x02
  29 #define NUM_PROBES                      2
  30
  31 /* FX2 renumeration delay in ms */
  32 #define MAX_RENUM_DELAY_MS              3000
  33
  34 #define MAX_CAPTURE_EMPTY               3
  35
  36 #define DEFAULT_VOLTAGE                 VDIV_500MV
  37 #define DEFAULT_FRAMESIZE               FRAMESIZE_SMALL
  38 #define DEFAULT_TIMEBASE                TIME_100us
  39 #define DEFAULT_TRIGGER_SOURCE          "CH1"
  40 #define DEFAULT_COUPLING                COUPLING_DC
  41 #define DEFAULT_HORIZ_TRIGGERPOS        0.5
  42 #define DEFAULT_VERT_OFFSET             0.5
  43 #define DEFAULT_VERT_TRIGGERPOS         0.5
  44
  45 #define MAX_VERT_TRIGGER                0xfe
  46
  47 /* Hantek DSO-specific protocol values */
  48 #define EEPROM_CHANNEL_OFFSETS          0x08
  49
  50 #define FRAMESIZE_SMALL                 10240
  51 #define FRAMESIZE_LARGE                 32768
  52
  53 enum control_requests {
  54         CTRL_READ_EEPROM = 0xa2,
  55         CTRL_GETSPEED = 0xb2,
  56         CTRL_BEGINCOMMAND = 0xb3,
  57         CTRL_SETOFFSET = 0xb4,
  58         CTRL_SETRELAYS = 0xb5,
  59 };
  60
  61 enum dso_commands {
  62         CMD_SET_FILTERS = 0,
  63         CMD_SET_TRIGGER_SAMPLERATE,
  64         CMD_FORCE_TRIGGER,
  65         CMD_CAPTURE_START,
  66         CMD_ENABLE_TRIGGER,
  67         CMD_GET_CHANNELDATA,
  68         CMD_GET_CAPTURESTATE,
  69         CMD_SET_VOLTAGE,
  70         /* unused */
  71         cmdSetLogicalData,
  72         cmdGetLogicalData,
  73 };
  74
  75 /* Must match the coupling table. */
  76 enum couplings {
  77         COUPLING_AC = 0,
  78         COUPLING_DC,
  79         /* TODO not used, how to enable? */
  80         COUPLING_GND,
  81 };
  82
  83 /* Must match the timebases table. */
  84 enum time_bases {
  85         TIME_10us = 0,
  86         TIME_20us,
  87         TIME_40us,
  88         TIME_100us,
  89         TIME_200us,
  90         TIME_400us,
  91         TIME_1ms,
  92         TIME_2ms,
  93         TIME_4ms,
  94         TIME_10ms,
  95         TIME_20ms,
  96         TIME_40ms,
  97         TIME_100ms,
  98         TIME_200ms,
  99         TIME_400ms,
 100 };
 101
 102 /* Must match the vdivs table. */
 103 enum {
 104         VDIV_10MV,
 105         VDIV_20MV,
 106         VDIV_50MV,
 107         VDIV_100MV,
 108         VDIV_200MV,
 109         VDIV_500MV,
 110         VDIV_1V,
 111         VDIV_2V,
 112         VDIV_5V,
 113 };
 114
 115 enum trigger_slopes {
 116         SLOPE_POSITIVE = 0,
 117         SLOPE_NEGATIVE,
 118 };
 119
 120 enum trigger_sources {
 121         TRIGGER_CH2 = 0,
 122         TRIGGER_CH1,
 123         TRIGGER_EXT,
 124 };
 125
 126 enum capturestates {
 127         CAPTURE_EMPTY = 0,
 128         CAPTURE_FILLING = 1,
 129         CAPTURE_READY_8BIT = 2,
 130         CAPTURE_READY_9BIT = 7,
 131         CAPTURE_TIMEOUT = 127,
 132         CAPTURE_UNKNOWN = 255,
 133 };
 134
 135 enum triggermodes {
 136         TRIGGERMODE_AUTO,
 137         TRIGGERMODE_NORMAL,
 138         TRIGGERMODE_SINGLE,
 139 };
 140
 141 enum states {
 142         IDLE,
 143         NEW_CAPTURE,
 144         CAPTURE,
 145         FETCH_DATA,
 146         STOPPING,
 147 };
 148
 149 struct dso_profile {
 150         /* VID/PID after cold boot */
 151         uint16_t orig_vid;
 152         uint16_t orig_pid;
 153         /* VID/PID after firmware upload */
 154         uint16_t fw_vid;
 155         uint16_t fw_pid;
 156         char *vendor;
 157         char *model;
 158         char *firmware;
 159 };
 160
 161 struct dev_context {
 162         const struct dso_profile *profile;
 163         struct sr_usb_dev_inst *usb;
 164         void *cb_data;
 165         uint64_t limit_frames;
 166         uint64_t num_frames;
 167         /* We can't keep track of an FX2-based device after upgrading
 168          * the firmware (it re-enumerates into a different device address
 169          * after the upgrade) this is like a global lock. No device will open
 170          * until a proper delay after the last device was upgraded.
 171          */
 172         int64_t fw_updated;
 173         int epin_maxpacketsize;
 174         int capture_empty_count;
 175         int dev_state;
 176
 177         /* Oscilloscope settings. */
 178         int timebase;
 179         gboolean ch1_enabled;
 180         gboolean ch2_enabled;
 181         int voltage_ch1;
 182         int voltage_ch2;
 183         int coupling_ch1;
 184         int coupling_ch2;
 185         // voltage offset (vertical position)
 186         float voffset_ch1;
 187         float voffset_ch2;
 188         float voffset_trigger;
 189         uint16_t channel_levels[2][9][2];
 190         unsigned int framesize;
 191         gboolean filter_ch1;
 192         gboolean filter_ch2;
 193         gboolean filter_trigger;
 194         int triggerslope;
 195         char *triggersource;
 196         float triggerposition;
 197         int triggermode;
 198
 199         /* Frame transfer */
 200         unsigned int samp_received;
 201         unsigned int samp_buffered;
 202         unsigned int trigger_offset;
 203         unsigned char *framebuf;
 204 };
 205
 206 SR_PRIV int dso_open(struct sr_dev_inst *sdi);
 207 SR_PRIV void dso_close(struct sr_dev_inst *sdi);
 208 SR_PRIV int dso_enable_trigger(struct dev_context *devc);
 209 SR_PRIV int dso_force_trigger(struct dev_context *devc);
 210 SR_PRIV int dso_init(struct dev_context *devc);
 211 SR_PRIV int dso_get_capturestate(struct dev_context *devc,
 212                 uint8_t *capturestate, uint32_t *trigger_offset);
 213 SR_PRIV int dso_capture_start(struct dev_context *devc);
 214 SR_PRIV int dso_get_channeldata(struct dev_context *devc,
 215                 libusb_transfer_cb_fn cb);
 216
 217 #endif