src/hardware/hantek-6xxx/protocol.c

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2015 Christer Ekholm <christerekholm@gmail.com>
   5  *
   6  * This program is free software: you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation, either version 3 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 #include <config.h>
  21 #include "protocol.h"
  22
  23 SR_PRIV int hantek_6xxx_open(struct sr_dev_inst *sdi)
  24 {
  25         struct dev_context *devc;
  26         struct drv_context *drvc = sdi->driver->context;
  27         struct sr_usb_dev_inst *usb;
  28         struct libusb_device_descriptor des;
  29         libusb_device **devlist;
  30         int err = SR_ERR, i;
  31         char connection_id[64];
  32
  33         devc = sdi->priv;
  34         usb = sdi->conn;
  35
  36         libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
  37         for (i = 0; devlist[i]; i++) {
  38                 libusb_get_device_descriptor(devlist[i], &des);
  39
  40                 if (des.idVendor != devc->profile->fw_vid
  41                     || des.idProduct != devc->profile->fw_pid)
  42                         continue;
  43
  44                 if ((sdi->status == SR_ST_INITIALIZING) ||
  45                                 (sdi->status == SR_ST_INACTIVE)) {
  46                         /*
  47                          * Check device by its physical USB bus/port address.
  48                          */
  49                         usb_get_port_path(devlist[i], connection_id, sizeof(connection_id));
  50                         if (strcmp(sdi->connection_id, connection_id))
  51                                 /* This is not the one. */
  52                                 continue;
  53                 }
  54
  55                 if (!(err = libusb_open(devlist[i], &usb->devhdl))) {
  56                         if (usb->address == 0xff) {
  57                                 /*
  58                                  * First time we touch this device after firmware upload,
  59                                  * so we don't know the address yet.
  60                                  */
  61                                 usb->address = libusb_get_device_address(devlist[i]);
  62                         }
  63
  64                         sr_info("Opened device on %d.%d (logical) / "
  65                                         "%s (physical) interface %d.",
  66                                 usb->bus, usb->address,
  67                                 sdi->connection_id, USB_INTERFACE);
  68
  69                         err = SR_OK;
  70                 } else {
  71                         sr_err("Failed to open device: %s.",
  72                                libusb_error_name(err));
  73                         err = SR_ERR;
  74                 }
  75
  76                 /* If we made it here, we handled the device (somehow). */
  77                 break;
  78         }
  79
  80         libusb_free_device_list(devlist, 1);
  81
  82         return err;
  83 }
  84
  85 SR_PRIV void hantek_6xxx_close(struct sr_dev_inst *sdi)
  86 {
  87         struct sr_usb_dev_inst *usb;
  88
  89         usb = sdi->conn;
  90
  91         if (!usb->devhdl)
  92                 return;
  93
  94         sr_info("Closing device on %d.%d (logical) / %s (physical) interface %d.",
  95                 usb->bus, usb->address, sdi->connection_id, USB_INTERFACE);
  96         libusb_release_interface(usb->devhdl, USB_INTERFACE);
  97         libusb_close(usb->devhdl);
  98         usb->devhdl = NULL;
  99         sdi->status = SR_ST_INACTIVE;
 100 }
 101
 102 SR_PRIV int hantek_6xxx_get_channeldata(const struct sr_dev_inst *sdi,
 103                 libusb_transfer_cb_fn cb, uint32_t data_amount)
 104 {
 105         struct sr_usb_dev_inst *usb;
 106         struct libusb_transfer *transfer;
 107         int ret;
 108         unsigned char *buf;
 109
 110         sr_dbg("Request channel data.");
 111
 112         usb = sdi->conn;
 113
 114         if (!(buf = g_try_malloc(data_amount))) {
 115                 sr_err("Failed to malloc USB endpoint buffer.");
 116                 return SR_ERR_MALLOC;
 117         }
 118         transfer = libusb_alloc_transfer(0);
 119         libusb_fill_bulk_transfer(transfer, usb->devhdl, HANTEK_EP_IN, buf,
 120                         data_amount, cb, (void *)sdi, 4000);
 121         if ((ret = libusb_submit_transfer(transfer)) < 0) {
 122                 sr_err("Failed to submit transfer: %s.",
 123                         libusb_error_name(ret));
 124                 /* TODO: Free them all. */
 125                 libusb_free_transfer(transfer);
 126                 g_free(buf);
 127                 return SR_ERR;
 128         }
 129
 130         return SR_OK;
 131 }
 132
 133 static uint8_t samplerate_to_reg(uint64_t samplerate)
 134 {
 135         const uint64_t samplerate_values[] = {SAMPLERATE_VALUES};
 136         const uint8_t samplerate_regs[] = {SAMPLERATE_REGS};
 137         uint32_t i;
 138
 139         for (i = 0; i < ARRAY_SIZE(samplerate_values); i++) {
 140                 if (samplerate_values[i] == samplerate)
 141                         return samplerate_regs[i];
 142         }
 143
 144         sr_err("Failed to convert samplerate: %" PRIu64 ".", samplerate);
 145
 146         return samplerate_regs[ARRAY_SIZE(samplerate_values) - 1];
 147 }
 148
 149 static uint8_t voltage_to_reg(uint8_t state)
 150 {
 151         const uint8_t vdiv_reg[] = {VDIV_REG};
 152
 153         if (state < ARRAY_SIZE(vdiv_reg)) {
 154                 return vdiv_reg[state];
 155         } else {
 156                 sr_err("Failed to convert vdiv: %d.", state);
 157                 return vdiv_reg[ARRAY_SIZE(vdiv_reg) - 1];
 158         }
 159 }
 160
 161 static int write_control(const struct sr_dev_inst *sdi,
 162                 enum control_requests reg, uint8_t value)
 163 {
 164         struct sr_usb_dev_inst *usb = sdi->conn;
 165         int ret;
 166
 167         sr_spew("hantek_6xxx_write_control: 0x%x 0x%x", reg, value);
 168
 169         if ((ret = libusb_control_transfer(usb->devhdl,
 170                         LIBUSB_REQUEST_TYPE_VENDOR, (uint8_t)reg,
 171                         0, 0, &value, 1, 100)) <= 0) {
 172                 sr_err("Failed to control transfer: 0x%x: %s.", reg,
 173                         libusb_error_name(ret));
 174                 return ret;
 175         }
 176
 177         return 0;
 178 }
 179
 180 SR_PRIV int hantek_6xxx_start_data_collecting(const struct sr_dev_inst *sdi)
 181 {
 182         sr_dbg("trigger");
 183         return write_control(sdi, TRIGGER_REG, 1);
 184 }
 185
 186 SR_PRIV int hantek_6xxx_stop_data_collecting(const struct sr_dev_inst *sdi)
 187 {
 188         return write_control(sdi, TRIGGER_REG, 0);
 189 }
 190
 191 SR_PRIV int hantek_6xxx_update_samplerate(const struct sr_dev_inst *sdi)
 192 {
 193         struct dev_context *devc = sdi->priv;
 194         sr_dbg("update samplerate %d", samplerate_to_reg(devc->samplerate));
 195
 196         return write_control(sdi, SAMPLERATE_REG, samplerate_to_reg(devc->samplerate));
 197 }
 198
 199 SR_PRIV int hantek_6xxx_update_vdiv(const struct sr_dev_inst *sdi)
 200 {
 201         struct dev_context *devc = sdi->priv;
 202         int ret1, ret2;
 203
 204         sr_dbg("update vdiv %d %d", voltage_to_reg(devc->voltage[0]),
 205                 voltage_to_reg(devc->voltage[1]));
 206
 207         ret1 = write_control(sdi, VDIV_CH1_REG, voltage_to_reg(devc->voltage[0]));
 208         ret2 = write_control(sdi, VDIV_CH2_REG, voltage_to_reg(devc->voltage[1]));
 209
 210         return MIN(ret1, ret2);
 211 }
 212
 213 SR_PRIV int hantek_6xxx_update_coupling(const struct sr_dev_inst *sdi)
 214 {
 215         struct dev_context *devc = sdi->priv;
 216         uint8_t coupling = 0xFF & ((devc->coupling[1] << 4) | devc->coupling[0]);
 217
 218         if (devc->has_coupling) {
 219                 sr_dbg("update coupling 0x%x", coupling);
 220                 return write_control(sdi, COUPLING_REG, coupling);
 221         } else {
 222                 sr_dbg("coupling not supported");
 223                 return SR_OK;
 224         }
 225 }
 226
 227 SR_PRIV int hantek_6xxx_update_channels(const struct sr_dev_inst *sdi)
 228 {
 229         struct dev_context *devc = sdi->priv;
 230         uint8_t chan = devc->ch_enabled[1] ? 2 : 1;
 231         sr_dbg("update channels amount %d", chan);
 232
 233         return write_control(sdi, CHANNELS_REG, chan);
 234 }
 235
 236 SR_PRIV int hantek_6xxx_init(const struct sr_dev_inst *sdi)
 237 {
 238         sr_dbg("Initializing");
 239
 240         hantek_6xxx_update_samplerate(sdi);
 241         hantek_6xxx_update_vdiv(sdi);
 242         hantek_6xxx_update_coupling(sdi);
 243         // hantek_6xxx_update_channels(sdi); /* Only 2 channel mode supported. */
 244
 245         return SR_OK;
 246 }