src/hardware/hantek-4032l/protocol.c

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2016 Andreas Zschunke <andreas.zschunke@gmx.net>
   5  * Copyright (C) 2017 Andrej Valek <andy@skyrain.eu>
   6  * Copyright (C) 2017 Uwe Hermann <uwe@hermann-uwe.de>
   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 #include <config.h>
  23 #include "protocol.h"
  24
  25 #define H4032L_USB_TIMEOUT 500
  26
  27 enum h4032l_cmd {
  28         CMD_RESET = 0x00b3, /* Also arms the logic analyzer. */
  29         CMD_CONFIGURE = 0x2b1a,
  30         CMD_STATUS = 0x4b3a,
  31         CMD_GET = 0x6b5a
  32 };
  33
  34 struct h4032l_status_packet {
  35         uint32_t magic;
  36         uint32_t values;
  37         uint32_t status;
  38         uint32_t usbxi_data;
  39         uint32_t fpga_version;
  40 };
  41
  42 static void finish_acquisition(struct sr_dev_inst *sdi)
  43 {
  44         struct drv_context *drvc = sdi->driver->context;
  45
  46         std_session_send_df_end(sdi);
  47         usb_source_remove(sdi->session, drvc->sr_ctx);
  48 }
  49
  50 static void free_transfer(struct libusb_transfer *transfer)
  51 {
  52         struct sr_dev_inst *sdi = transfer->user_data;
  53         struct dev_context *devc = sdi->priv;
  54
  55         transfer->buffer = NULL;
  56         libusb_free_transfer(transfer);
  57         devc->usb_transfer = NULL;
  58
  59         finish_acquisition(sdi);
  60 }
  61
  62 SR_PRIV int h4032l_receive_data(int fd, int revents, void *cb_data)
  63 {
  64         struct timeval tv;
  65         struct drv_context *drvc;
  66
  67         (void)fd;
  68         (void)revents;
  69
  70         drvc = (struct drv_context *)cb_data;
  71
  72         tv.tv_sec = tv.tv_usec = 0;
  73         libusb_handle_events_timeout(drvc->sr_ctx->libusb_ctx, &tv);
  74
  75         return TRUE;
  76 }
  77
  78 void LIBUSB_CALL h4032l_usb_callback(struct libusb_transfer *transfer)
  79 {
  80         const struct sr_dev_inst *sdi = transfer->user_data;
  81         struct dev_context *devc = sdi->priv;
  82         struct drv_context *drvc = sdi->driver->context;
  83         struct sr_usb_dev_inst *usb = sdi->conn;
  84         gboolean cmd = FALSE;
  85         uint32_t max_samples = 512 / sizeof(uint32_t);
  86         uint32_t *buffer;
  87         struct h4032l_status_packet *status;
  88         struct sr_datafeed_packet packet;
  89         struct sr_datafeed_logic logic;
  90         uint32_t number_samples;
  91         int ret;
  92
  93         /*
  94          * If acquisition has already ended, just free any queued up
  95          * transfers that come in.
  96          */
  97         if (devc->acq_aborted) {
  98                 free_transfer(transfer);
  99                 return;
 100         }
 101
 102         if (transfer->status != LIBUSB_TRANSFER_COMPLETED)
 103                 sr_dbg("%s error: %d.", __func__, transfer->status);
 104
 105         buffer = (uint32_t *)transfer->buffer;
 106
 107         switch (devc->status) {
 108         case H4032L_STATUS_IDLE:
 109                 sr_err("USB callback called in idle.");
 110                 break;
 111         case H4032L_STATUS_CMD_CONFIGURE:
 112                 /* Select status request as next. */
 113                 cmd = TRUE;
 114                 devc->cmd_pkt.cmd = CMD_STATUS;
 115                 devc->status = H4032L_STATUS_CMD_STATUS;
 116                 break;
 117         case H4032L_STATUS_CMD_STATUS:
 118                 /* Select status request as next. */
 119                 devc->status = H4032L_STATUS_RESPONSE_STATUS;
 120                 break;
 121         case H4032L_STATUS_RESPONSE_STATUS:
 122                 /*
 123                  * Check magic and if status is complete, then select
 124                  * First Transfer as next.
 125                  */
 126                 status = (struct h4032l_status_packet *)transfer->buffer;
 127                 sr_dbg("FPGA version: 0x%x.", status->fpga_version);
 128                 if (status->magic != H4032L_STATUS_PACKET_MAGIC) {
 129                         devc->status = H4032L_STATUS_RESPONSE_STATUS;
 130                 } else if (status->status == 2) {
 131                         devc->status = H4032L_STATUS_RESPONSE_STATUS_CONTINUE;
 132                 } else {
 133                         devc->status = H4032L_STATUS_RESPONSE_STATUS_RETRY;
 134                 }
 135                 break;
 136         case H4032L_STATUS_RESPONSE_STATUS_RETRY:
 137                 devc->status = H4032L_STATUS_CMD_STATUS;
 138                 devc->cmd_pkt.cmd = CMD_STATUS;
 139                 cmd = TRUE;
 140                 break;
 141         case H4032L_STATUS_RESPONSE_STATUS_CONTINUE:
 142                 devc->status = H4032L_STATUS_CMD_GET;
 143                 devc->cmd_pkt.cmd = CMD_GET;
 144                 cmd = TRUE;
 145                 break;
 146         case H4032L_STATUS_CMD_GET:
 147                 devc->status = H4032L_STATUS_FIRST_TRANSFER;
 148                 break;
 149         case H4032L_STATUS_FIRST_TRANSFER:
 150                 /* Drop packets until H4032L_START_PACKET_MAGIC. */
 151                 if (buffer[0] != H4032L_START_PACKET_MAGIC) {
 152                         sr_dbg("Mismatch magic number of start poll.");
 153                         break;
 154                 }
 155                 devc->status = H4032L_STATUS_TRANSFER;
 156                 max_samples--;
 157                 buffer++;
 158                 /* Fallthrough. */
 159         case H4032L_STATUS_TRANSFER:
 160                 number_samples = (devc->remaining_samples < max_samples) ? devc->remaining_samples : max_samples;
 161                 devc->remaining_samples -= number_samples;
 162                 packet.type = SR_DF_LOGIC;
 163                 packet.payload = &logic;
 164                 logic.length = number_samples * sizeof(uint32_t);
 165                 logic.unitsize = sizeof(uint32_t);
 166                 logic.data = buffer;
 167                 sr_session_send(sdi, &packet);
 168                 sr_dbg("Remaining: %d %08X %08X.", devc->remaining_samples,
 169                         buffer[0], buffer[1]);
 170                 if (devc->remaining_samples == 0) {
 171                         std_session_send_df_end(sdi);
 172                         usb_source_remove(sdi->session, drvc->sr_ctx);
 173                         devc->status = H4032L_STATUS_IDLE;
 174                         if (buffer[number_samples] != H4032L_END_PACKET_MAGIC)
 175                                 sr_err("Mismatch magic number of end poll.");
 176                 }
 177                 break;
 178         }
 179
 180         if (devc->status != H4032L_STATUS_IDLE) {
 181                 if (cmd) {
 182                         /* Setup new USB cmd packet, reuse transfer object. */
 183                         sr_dbg("New command: %d.", devc->status);
 184                         libusb_fill_bulk_transfer(transfer, usb->devhdl,
 185                                 2 | LIBUSB_ENDPOINT_OUT,
 186                                 (unsigned char *)&devc->cmd_pkt,
 187                                 sizeof(struct h4032l_cmd_pkt),
 188                                 h4032l_usb_callback, (void *)sdi,
 189                                 H4032L_USB_TIMEOUT);
 190                 } else {
 191                         /* Setup new USB poll packet, reuse transfer object. */
 192                         sr_dbg("Poll: %d.", devc->status);
 193                         libusb_fill_bulk_transfer(transfer, usb->devhdl,
 194                                 6 | LIBUSB_ENDPOINT_IN,
 195                                 devc->buffer, ARRAY_SIZE(devc->buffer),
 196                                 h4032l_usb_callback,
 197                                 (void *)sdi, H4032L_USB_TIMEOUT);
 198                 }
 199                 /* Send prepared USB packet. */
 200                 if ((ret = libusb_submit_transfer(transfer)) != 0) {
 201                         sr_err("Failed to submit transfer: %s.",
 202                                libusb_error_name(ret));
 203                         devc->status = H4032L_STATUS_IDLE;
 204                 }
 205         } else {
 206                 sr_dbg("Now idle.");
 207         }
 208
 209         if (devc->status == H4032L_STATUS_IDLE)
 210                 free_transfer(transfer);
 211 }
 212
 213 uint16_t h4032l_voltage2pwm(double voltage)
 214 {
 215         /*
 216          * word PwmA - channel A Vref PWM value, pseudocode:
 217          * -6V < ThresholdVoltage < +6V
 218          * Vref = 1.8 - ThresholdVoltage
 219          * if Vref > 10.0
 220          *      Vref = 10.0
 221          * if Vref < -5.0
 222          *      Vref = -5.0
 223          * pwm = ToInt((Vref + 5.0) / 15.0 * 4096.0)
 224          * if pwm > 4095
 225          *      pwm = 4095
 226          */
 227         voltage = 1.8 - voltage;
 228         if (voltage > 10.0)
 229                 voltage = 10.0;
 230         else if (voltage < -5.0)
 231                 voltage = -5.0;
 232
 233         return (uint16_t) ((voltage + 5.0) * (4096.0 / 15.0));
 234 }
 235
 236 SR_PRIV int h4032l_start(const struct sr_dev_inst *sdi)
 237 {
 238         struct dev_context *devc = sdi->priv;
 239         struct sr_usb_dev_inst *usb = sdi->conn;
 240         struct libusb_transfer *transfer;
 241         unsigned char buffer[] = {0x0f, 0x03, 0x03, 0x03, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00};
 242         int ret;
 243
 244         /* Send reset command to arm the logic analyzer. */
 245         if ((ret = libusb_control_transfer(usb->devhdl,
 246                 LIBUSB_REQUEST_TYPE_VENDOR | LIBUSB_ENDPOINT_OUT, CMD_RESET,
 247                 0x00, 0x00, buffer, ARRAY_SIZE(buffer), H4032L_USB_TIMEOUT)) < 0) {
 248                 sr_err("Failed to send vendor request %s.", libusb_error_name(ret));
 249                 return SR_ERR;
 250         }
 251
 252         /* Wait for reset vendor request. */
 253         g_usleep(20 * 1000);
 254
 255         /* Send configure command. */
 256         devc->cmd_pkt.cmd = CMD_CONFIGURE;
 257         devc->status = H4032L_STATUS_CMD_CONFIGURE;
 258         devc->remaining_samples = devc->cmd_pkt.sample_size;
 259
 260         transfer = libusb_alloc_transfer(0);
 261
 262         libusb_fill_bulk_transfer(transfer, usb->devhdl,
 263                 2 | LIBUSB_ENDPOINT_OUT, (unsigned char *)&devc->cmd_pkt,
 264                 sizeof(struct h4032l_cmd_pkt), h4032l_usb_callback,
 265                 (void *)sdi, H4032L_USB_TIMEOUT);
 266
 267         if ((ret = libusb_submit_transfer(transfer)) != 0) {
 268                 sr_err("Failed to submit transfer: %s.", libusb_error_name(ret));
 269                 libusb_free_transfer(transfer);
 270                 return SR_ERR;
 271         }
 272
 273         std_session_send_df_header(sdi);
 274
 275         return SR_OK;
 276 }
 277
 278 SR_PRIV int h4032l_dev_open(struct sr_dev_inst *sdi)
 279 {
 280         struct drv_context *drvc = sdi->driver->context;
 281         struct sr_usb_dev_inst *usb = sdi->conn;
 282         struct libusb_device_descriptor des;
 283         libusb_device **devlist;
 284         int ret = SR_ERR, i, device_count;
 285         char connection_id[64];
 286
 287         device_count = libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
 288         if (device_count < 0) {
 289                 sr_err("Failed to get device list: %s.",
 290                        libusb_error_name(device_count));
 291                 return SR_ERR;
 292         }
 293
 294         for (i = 0; i < device_count; i++) {
 295                 libusb_get_device_descriptor(devlist[i], &des);
 296
 297                 if (des.idVendor != H4032L_USB_VENDOR ||
 298                     des.idProduct != H4032L_USB_PRODUCT)
 299                         continue;
 300
 301                 if ((sdi->status == SR_ST_INITIALIZING) ||
 302                     (sdi->status == SR_ST_INACTIVE)) {
 303                         /* Check device by its physical USB bus/port address. */
 304                         usb_get_port_path(devlist[i], connection_id,
 305                                           sizeof(connection_id));
 306                         if (strcmp(sdi->connection_id, connection_id))
 307                                 /* This is not the one. */
 308                                 continue;
 309                 }
 310
 311                 if (!(ret = libusb_open(devlist[i], &usb->devhdl))) {
 312                         if (usb->address == 0xff)
 313                                 /*
 314                                  * First time we touch this device after FW
 315                                  * upload, so we don't know the address yet.
 316                                  */
 317                                 usb->address =
 318                                     libusb_get_device_address(devlist[i]);
 319                 } else {
 320                         sr_err("Failed to open device: %s.",
 321                                libusb_error_name(ret));
 322                         ret = SR_ERR;
 323                         break;
 324                 }
 325
 326                 ret = SR_OK;
 327                 break;
 328         }
 329
 330         libusb_free_device_list(devlist, 1);
 331         return ret;
 332 }