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                         if (usb_get_port_path(devlist[i], connection_id, sizeof(connection_id)) < 0)
  50                                 continue;
  51
  52                         if (strcmp(sdi->connection_id, connection_id))
  53                                 /* This is not the one. */
  54                                 continue;
  55                 }
  56
  57                 if (!(err = libusb_open(devlist[i], &usb->devhdl))) {
  58                         if (usb->address == 0xff) {
  59                                 /*
  60                                  * First time we touch this device after firmware upload,
  61                                  * so we don't know the address yet.
  62                                  */
  63                                 usb->address = libusb_get_device_address(devlist[i]);
  64                         }
  65
  66                         sr_info("Opened device on %d.%d (logical) / "
  67                                         "%s (physical) interface %d.",
  68                                 usb->bus, usb->address,
  69                                 sdi->connection_id, USB_INTERFACE);
  70
  71                         err = SR_OK;
  72                 } else {
  73                         sr_err("Failed to open device: %s.",
  74                                libusb_error_name(err));
  75                         err = SR_ERR;
  76                 }
  77
  78                 /* If we made it here, we handled the device (somehow). */
  79                 break;
  80         }
  81
  82         libusb_free_device_list(devlist, 1);
  83
  84         return err;
  85 }
  86
  87 SR_PRIV void hantek_6xxx_close(struct sr_dev_inst *sdi)
  88 {
  89         struct sr_usb_dev_inst *usb;
  90
  91         usb = sdi->conn;
  92
  93         if (!usb->devhdl)
  94                 return;
  95
  96         sr_info("Closing device on %d.%d (logical) / %s (physical) interface %d.",
  97                 usb->bus, usb->address, sdi->connection_id, USB_INTERFACE);
  98         libusb_release_interface(usb->devhdl, USB_INTERFACE);
  99         libusb_close(usb->devhdl);
 100         usb->devhdl = NULL;
 101         sdi->status = SR_ST_INACTIVE;
 102 }
 103
 104 SR_PRIV int hantek_6xxx_get_channeldata(const struct sr_dev_inst *sdi,
 105                 libusb_transfer_cb_fn cb, uint32_t data_amount)
 106 {
 107         struct sr_usb_dev_inst *usb;
 108         struct libusb_transfer *transfer;
 109         int ret;
 110         unsigned char *buf;
 111
 112         sr_dbg("Request channel data.");
 113
 114         usb = sdi->conn;
 115
 116         if (!(buf = g_try_malloc(data_amount))) {
 117                 sr_err("Failed to malloc USB endpoint buffer.");
 118                 return SR_ERR_MALLOC;
 119         }
 120         transfer = libusb_alloc_transfer(0);
 121         libusb_fill_bulk_transfer(transfer, usb->devhdl, HANTEK_EP_IN, buf,
 122                         data_amount, cb, (void *)sdi, 4000);
 123         if ((ret = libusb_submit_transfer(transfer)) < 0) {
 124                 sr_err("Failed to submit transfer: %s.",
 125                         libusb_error_name(ret));
 126                 /* TODO: Free them all. */
 127                 libusb_free_transfer(transfer);
 128                 g_free(buf);
 129                 return SR_ERR;
 130         }
 131
 132         return SR_OK;
 133 }
 134
 135 static uint8_t samplerate_to_reg(uint64_t samplerate)
 136 {
 137         const uint64_t samplerate_values[] = {SAMPLERATE_VALUES};
 138         const uint8_t samplerate_regs[] = {SAMPLERATE_REGS};
 139         uint32_t i;
 140
 141         for (i = 0; i < ARRAY_SIZE(samplerate_values); i++) {
 142                 if (samplerate_values[i] == samplerate)
 143                         return samplerate_regs[i];
 144         }
 145
 146         sr_err("Failed to convert samplerate: %" PRIu64 ".", samplerate);
 147
 148         return samplerate_regs[ARRAY_SIZE(samplerate_values) - 1];
 149 }
 150
 151 static uint8_t voltage_to_reg(uint8_t state)
 152 {
 153         const uint8_t vdiv_reg[] = {VDIV_REG};
 154
 155         if (state < ARRAY_SIZE(vdiv_reg)) {
 156                 return vdiv_reg[state];
 157         } else {
 158                 sr_err("Failed to convert vdiv: %d.", state);
 159                 return vdiv_reg[ARRAY_SIZE(vdiv_reg) - 1];
 160         }
 161 }
 162
 163 static int write_control(const struct sr_dev_inst *sdi,
 164                 enum control_requests reg, uint8_t value)
 165 {
 166         struct sr_usb_dev_inst *usb = sdi->conn;
 167         int ret;
 168
 169         sr_spew("hantek_6xxx_write_control: 0x%x 0x%x", reg, value);
 170
 171         if ((ret = libusb_control_transfer(usb->devhdl,
 172                         LIBUSB_REQUEST_TYPE_VENDOR, (uint8_t)reg,
 173                         0, 0, &value, 1, 100)) <= 0) {
 174                 sr_err("Failed to control transfer: 0x%x: %s.", reg,
 175                         libusb_error_name(ret));
 176                 return ret;
 177         }
 178
 179         return 0;
 180 }
 181
 182 SR_PRIV int hantek_6xxx_start_data_collecting(const struct sr_dev_inst *sdi)
 183 {
 184         sr_dbg("trigger");
 185         return write_control(sdi, TRIGGER_REG, 1);
 186 }
 187
 188 SR_PRIV int hantek_6xxx_stop_data_collecting(const struct sr_dev_inst *sdi)
 189 {
 190         return write_control(sdi, TRIGGER_REG, 0);
 191 }
 192
 193 SR_PRIV int hantek_6xxx_update_samplerate(const struct sr_dev_inst *sdi)
 194 {
 195         struct dev_context *devc = sdi->priv;
 196         sr_dbg("update samplerate %d", samplerate_to_reg(devc->samplerate));
 197
 198         return write_control(sdi, SAMPLERATE_REG, samplerate_to_reg(devc->samplerate));
 199 }
 200
 201 SR_PRIV int hantek_6xxx_update_vdiv(const struct sr_dev_inst *sdi)
 202 {
 203         struct dev_context *devc = sdi->priv;
 204         int ret1, ret2;
 205
 206         sr_dbg("update vdiv %d %d", voltage_to_reg(devc->voltage[0]),
 207                 voltage_to_reg(devc->voltage[1]));
 208
 209         ret1 = write_control(sdi, VDIV_CH1_REG, voltage_to_reg(devc->voltage[0]));
 210         ret2 = write_control(sdi, VDIV_CH2_REG, voltage_to_reg(devc->voltage[1]));
 211
 212         return MIN(ret1, ret2);
 213 }
 214
 215 SR_PRIV int hantek_6xxx_update_coupling(const struct sr_dev_inst *sdi)
 216 {
 217         struct dev_context *devc = sdi->priv;
 218         uint8_t coupling = 0xFF & ((devc->coupling[1] << 4) | devc->coupling[0]);
 219
 220         if (devc->has_coupling) {
 221                 sr_dbg("update coupling 0x%x", coupling);
 222                 return write_control(sdi, COUPLING_REG, coupling);
 223         } else {
 224                 sr_dbg("coupling not supported");
 225                 return SR_OK;
 226         }
 227 }
 228
 229 SR_PRIV int hantek_6xxx_update_channels(const struct sr_dev_inst *sdi)
 230 {
 231         struct dev_context *devc = sdi->priv;
 232         uint8_t chan = devc->ch_enabled[1] ? 2 : 1;
 233         sr_dbg("update channels amount %d", chan);
 234
 235         return write_control(sdi, CHANNELS_REG, chan);
 236 }
 237
 238 SR_PRIV int hantek_6xxx_init(const struct sr_dev_inst *sdi)
 239 {
 240         sr_dbg("Initializing");
 241
 242         hantek_6xxx_update_samplerate(sdi);
 243         hantek_6xxx_update_vdiv(sdi);
 244         hantek_6xxx_update_coupling(sdi);
 245         // hantek_6xxx_update_channels(sdi); /* Only 2 channel mode supported. */
 246
 247         return SR_OK;
 248 }