src/hardware/hantek-4032l/api.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 USB_INTERFACE 0
  26 #define NUM_CHANNELS 32
  27
  28 static const uint32_t scanopts[] = {
  29         SR_CONF_CONN,
  30 };
  31
  32 static const uint32_t drvopts[] = {
  33         SR_CONF_LOGIC_ANALYZER,
  34 };
  35
  36 static const uint32_t devopts[] = {
  37         SR_CONF_SAMPLERATE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
  38         SR_CONF_CAPTURE_RATIO | SR_CONF_GET | SR_CONF_SET,
  39         SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
  40         SR_CONF_TRIGGER_MATCH | SR_CONF_LIST,
  41         SR_CONF_CONN | SR_CONF_GET,
  42         SR_CONF_VOLTAGE_THRESHOLD | SR_CONF_SET | SR_CONF_LIST,
  43 };
  44
  45 static const int32_t trigger_matches[] = {
  46         SR_TRIGGER_ZERO,
  47         SR_TRIGGER_ONE,
  48         SR_TRIGGER_RISING,
  49         SR_TRIGGER_FALLING,
  50         SR_TRIGGER_EDGE,
  51 };
  52
  53 static const uint64_t samplerates[] = {
  54         SR_KHZ(1),
  55         SR_KHZ(2),
  56         SR_KHZ(4),
  57         SR_KHZ(8),
  58         SR_KHZ(16),
  59         SR_HZ(31250),
  60         SR_HZ(62500),
  61         SR_KHZ(125),
  62         SR_KHZ(250),
  63         SR_KHZ(500),
  64         SR_KHZ(625),
  65         SR_HZ(781250),
  66         SR_MHZ(1),
  67         SR_KHZ(1250),
  68         SR_HZ(1562500),
  69         SR_MHZ(2),
  70         SR_KHZ(2500),
  71         SR_KHZ(3125),
  72         SR_MHZ(4),
  73         SR_MHZ(5),
  74         SR_KHZ(6250),
  75         SR_MHZ(10),
  76         SR_KHZ(12500),
  77         SR_MHZ(20),
  78         SR_MHZ(25),
  79         SR_MHZ(40),
  80         SR_MHZ(50),
  81         SR_MHZ(80),
  82         SR_MHZ(100),
  83         SR_MHZ(160),
  84         SR_MHZ(200),
  85         SR_MHZ(320),
  86         SR_MHZ(400),
  87 };
  88
  89 static const uint64_t samplerates_hw[] = {
  90         SR_MHZ(100),
  91         SR_MHZ(50),
  92         SR_MHZ(25),
  93         SR_KHZ(12500),
  94         SR_KHZ(6250),
  95         SR_KHZ(3125),
  96         SR_HZ(1562500),
  97         SR_HZ(781250),
  98         SR_MHZ(80),
  99         SR_MHZ(40),
 100         SR_MHZ(20),
 101         SR_MHZ(10),
 102         SR_MHZ(5),
 103         SR_KHZ(2500),
 104         SR_KHZ(1250),
 105         SR_KHZ(625),
 106         SR_MHZ(4),
 107         SR_MHZ(2),
 108         SR_MHZ(1),
 109         SR_KHZ(500),
 110         SR_KHZ(250),
 111         SR_KHZ(125),
 112         SR_HZ(62500),
 113         SR_HZ(31250),
 114         SR_KHZ(16),
 115         SR_KHZ(8),
 116         SR_KHZ(4),
 117         SR_KHZ(2),
 118         SR_KHZ(1),
 119         0,
 120         0,
 121         0,
 122         SR_MHZ(200),
 123         SR_MHZ(160),
 124         SR_MHZ(400),
 125         SR_MHZ(320),
 126 };
 127
 128 SR_PRIV struct sr_dev_driver hantek_4032l_driver_info;
 129
 130 static GSList *scan(struct sr_dev_driver *di, GSList *options)
 131 {
 132         struct drv_context *drvc = di->context;
 133         GSList *l, *devices, *conn_devices;
 134         libusb_device **devlist;
 135         struct libusb_device_descriptor des;
 136         const char *conn;
 137         int i;
 138         char connection_id[64];
 139         struct sr_channel_group *cg;
 140         struct sr_dev_inst *sdi;
 141         struct sr_channel *ch;
 142
 143         devices = NULL;
 144         conn_devices = NULL;
 145         drvc->instances = NULL;
 146         conn = NULL;
 147
 148         for (l = options; l; l = l->next) {
 149                 struct sr_config *src = l->data;
 150                 if (src->key == SR_CONF_CONN) {
 151                         conn = g_variant_get_string(src->data, NULL);
 152                         break;
 153                 }
 154         }
 155
 156         if (conn)
 157                 conn_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, conn);
 158         else
 159                 conn_devices = NULL;
 160
 161         libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
 162         for (i = 0; devlist[i]; i++) {
 163                 if (conn) {
 164                         struct sr_usb_dev_inst *usb = NULL;
 165                         for (l = conn_devices; l; l = l->next) {
 166                                 usb = l->data;
 167                                 if (usb->bus == libusb_get_bus_number(devlist[i]) &&
 168                                     usb->address == libusb_get_device_address(devlist[i]))
 169                                         break;
 170                         }
 171                         if (!l)
 172                                 /* This device matched none of the ones that
 173                                  * matched the conn specification. */
 174                                 continue;
 175                 }
 176
 177                 libusb_get_device_descriptor(devlist[i], &des);
 178
 179                 if (des.idVendor != H4032L_USB_VENDOR ||
 180                     des.idProduct != H4032L_USB_PRODUCT)
 181                         continue;
 182
 183                 if (usb_get_port_path(devlist[i], connection_id, sizeof(connection_id)) < 0)
 184                         continue;
 185
 186                 sdi = g_malloc0(sizeof(struct sr_dev_inst));
 187                 sdi->driver = &hantek_4032l_driver_info;
 188                 sdi->vendor = g_strdup("Hantek");
 189                 sdi->model = g_strdup("4032L");
 190                 sdi->connection_id = g_strdup(connection_id);
 191
 192                 struct sr_channel_group *channel_groups[2];
 193                 for (int j = 0; j < 2; j++) {
 194                         cg = g_malloc0(sizeof(struct sr_channel_group));
 195                         cg->name = g_strdup_printf("%c", 'A' + j);
 196                         channel_groups[j] = cg;
 197                         sdi->channel_groups = g_slist_append(sdi->channel_groups, cg);
 198                 }
 199
 200                 /* Assemble channel list and add channel to channel groups. */
 201                 for (int j = 0; j < NUM_CHANNELS; j++) {
 202                         char channel_name[4];
 203                         sprintf(channel_name, "%c%d", 'A' + (j & 1), j / 2);
 204                         ch = sr_channel_new(sdi, j, SR_CHANNEL_LOGIC, TRUE, channel_name);
 205                         cg = channel_groups[j & 1];
 206                         cg->channels = g_slist_append(cg->channels, ch);
 207                 }
 208
 209                 struct dev_context *devc = g_malloc0(sizeof(struct dev_context));
 210
 211                 /* Initialize command packet. */
 212                 devc->cmd_pkt.magic = H4032L_CMD_PKT_MAGIC;
 213                 devc->cmd_pkt.pwm_a = h4032l_voltage2pwm(2.5);
 214                 devc->cmd_pkt.pwm_b = h4032l_voltage2pwm(2.5);
 215                 devc->cmd_pkt.sample_size = 16384;
 216                 devc->cmd_pkt.pre_trigger_size = 1024;
 217
 218                 devc->status = H4032L_STATUS_IDLE;
 219
 220                 devc->capture_ratio = 5;
 221
 222                 devc->usb_transfer = libusb_alloc_transfer(0);
 223
 224                 sdi->priv = devc;
 225                 devices = g_slist_append(devices, sdi);
 226
 227                 sdi->status = SR_ST_INACTIVE;
 228                 sdi->inst_type = SR_INST_USB;
 229                 sdi->conn = sr_usb_dev_inst_new(
 230                         libusb_get_bus_number(devlist[i]),
 231                         libusb_get_device_address(devlist[i]), NULL);
 232         }
 233
 234         g_slist_free_full(conn_devices, (GDestroyNotify)sr_usb_dev_inst_free);
 235         libusb_free_device_list(devlist, 1);
 236
 237         return std_scan_complete(di, devices);
 238 }
 239
 240 static int dev_open(struct sr_dev_inst *sdi)
 241 {
 242         struct sr_usb_dev_inst *usb = sdi->conn;
 243         int ret;
 244
 245         ret = h4032l_dev_open(sdi);
 246         if (ret != SR_OK) {
 247                 sr_err("Unable to open device.");
 248                 return SR_ERR;
 249         }
 250
 251         ret = libusb_claim_interface(usb->devhdl, USB_INTERFACE);
 252         if (ret != 0) {
 253                 switch (ret) {
 254                 case LIBUSB_ERROR_BUSY:
 255                         sr_err("Unable to claim USB interface. Another "
 256                                "program or driver has already claimed it.");
 257                         break;
 258                 case LIBUSB_ERROR_NO_DEVICE:
 259                         sr_err("Device has been disconnected.");
 260                         break;
 261                 default:
 262                         sr_err("Unable to claim interface: %s.",
 263                                libusb_error_name(ret));
 264                         break;
 265                 }
 266
 267                 return SR_ERR;
 268         }
 269
 270         return SR_OK;
 271 }
 272
 273 static int dev_close(struct sr_dev_inst *sdi)
 274 {
 275         struct sr_usb_dev_inst *usb;
 276
 277         usb = sdi->conn;
 278
 279         if (!usb->devhdl)
 280                 return SR_ERR_BUG;
 281
 282         sr_info("Closing device on %d.%d (logical) / %s (physical) interface %d.",
 283                 usb->bus, usb->address, sdi->connection_id, USB_INTERFACE);
 284         libusb_release_interface(usb->devhdl, USB_INTERFACE);
 285         libusb_close(usb->devhdl);
 286         usb->devhdl = NULL;
 287
 288         return SR_OK;
 289 }
 290
 291 static int config_get(uint32_t key, GVariant **data,
 292         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
 293 {
 294         struct dev_context *devc = sdi->priv;
 295         struct sr_usb_dev_inst *usb;
 296
 297         (void)cg;
 298
 299         switch (key) {
 300         case SR_CONF_SAMPLERATE:
 301                 *data = g_variant_new_uint64(samplerates_hw[devc->cmd_pkt.sample_rate]);
 302                 break;
 303         case SR_CONF_CAPTURE_RATIO:
 304                 *data = g_variant_new_uint64(devc->capture_ratio);
 305                 break;
 306         case SR_CONF_LIMIT_SAMPLES:
 307                 *data = g_variant_new_uint64(devc->cmd_pkt.sample_size);
 308                 break;
 309         case SR_CONF_CONN:
 310                 if (!sdi || !(usb = sdi->conn))
 311                         return SR_ERR_ARG;
 312                 *data = g_variant_new_printf("%d.%d", usb->bus, usb->address);
 313                 break;
 314         default:
 315                 return SR_ERR_NA;
 316         }
 317
 318         return SR_OK;
 319 }
 320
 321 static int config_set(uint32_t key, GVariant *data,
 322         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
 323 {
 324         struct dev_context *devc = sdi->priv;
 325         struct h4032l_cmd_pkt *cmd_pkt = &devc->cmd_pkt;
 326
 327         (void)cg;
 328
 329         switch (key) {
 330         case SR_CONF_SAMPLERATE: {
 331                         uint64_t sample_rate = g_variant_get_uint64(data);
 332                         uint8_t i = 0;
 333                         while (i < ARRAY_SIZE(samplerates_hw) && samplerates_hw[i] != sample_rate)
 334                                 i++;
 335
 336                         if (i == ARRAY_SIZE(samplerates_hw) || sample_rate == 0) {
 337                                 sr_err("Invalid sample rate.");
 338                                 return SR_ERR_SAMPLERATE;
 339                         }
 340                         cmd_pkt->sample_rate = i;
 341                         break;
 342                 }
 343         case SR_CONF_CAPTURE_RATIO:
 344                 devc->capture_ratio = g_variant_get_uint64(data);
 345                 break;
 346         case SR_CONF_LIMIT_SAMPLES: {
 347                         uint64_t number_samples = g_variant_get_uint64(data);
 348                         number_samples += 511;
 349                         number_samples &= 0xfffffe00;
 350                         if (number_samples < 2048 ||
 351                             number_samples > 64 * 1024 * 1024) {
 352                                 sr_err("Invalid sample range 2k...64M: %"
 353                                        PRIu64 ".", number_samples);
 354                                 return SR_ERR;
 355                         }
 356                         cmd_pkt->sample_size = number_samples;
 357                         break;
 358                 }
 359         case SR_CONF_VOLTAGE_THRESHOLD: {
 360                         double d1, d2;
 361                         g_variant_get(data, "(dd)", &d1, &d2);
 362                         devc->cmd_pkt.pwm_a = h4032l_voltage2pwm(d1);
 363                         devc->cmd_pkt.pwm_b = h4032l_voltage2pwm(d2);
 364                         break;
 365                 }
 366         default:
 367                 return SR_ERR_NA;
 368         }
 369
 370         return SR_OK;
 371 }
 372
 373 static int config_list(uint32_t key, GVariant **data,
 374         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
 375 {
 376         switch (key) {
 377         case SR_CONF_SCAN_OPTIONS:
 378         case SR_CONF_DEVICE_OPTIONS:
 379                 return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts);
 380         case SR_CONF_SAMPLERATE:
 381                 *data = std_gvar_samplerates(ARRAY_AND_SIZE(samplerates));
 382                 break;
 383         case SR_CONF_TRIGGER_MATCH:
 384                 *data = std_gvar_array_i32(ARRAY_AND_SIZE(trigger_matches));
 385                 break;
 386         case SR_CONF_VOLTAGE_THRESHOLD:
 387                 *data = std_gvar_tuple_double(2.5, 2.5);
 388                 break;
 389         default:
 390                 return SR_ERR_NA;
 391         }
 392
 393         return SR_OK;
 394 }
 395
 396 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
 397 {
 398         struct sr_dev_driver *di = sdi->driver;
 399         struct drv_context *drvc = di->context;
 400         struct dev_context *devc = sdi->priv;
 401         struct sr_trigger *trigger = sr_session_trigger_get(sdi->session);
 402         struct h4032l_cmd_pkt *cmd_pkt = &devc->cmd_pkt;
 403
 404         /* Initialize variables. */
 405         devc->acq_aborted = FALSE;
 406
 407         /* Calculate packet ratio. */
 408         cmd_pkt->pre_trigger_size = (cmd_pkt->sample_size * devc->capture_ratio) / 100;
 409
 410         cmd_pkt->trig_flags.enable_trigger1 = 0;
 411         cmd_pkt->trig_flags.enable_trigger2 = 0;
 412         cmd_pkt->trig_flags.trigger_and_logic = 0;
 413
 414         if (trigger && trigger->stages) {
 415                 GSList *stages = trigger->stages;
 416                 struct sr_trigger_stage *stage1 = stages->data;
 417                 if (stages->next) {
 418                         sr_err("Only one trigger stage supported for now.");
 419                         return SR_ERR;
 420                 }
 421                 cmd_pkt->trig_flags.enable_trigger1 = 1;
 422                 cmd_pkt->trigger[0].flags.edge_type = H4032L_TRIGGER_EDGE_TYPE_DISABLED;
 423                 cmd_pkt->trigger[0].flags.data_range_enabled = 0;
 424                 cmd_pkt->trigger[0].flags.time_range_enabled = 0;
 425                 cmd_pkt->trigger[0].flags.combined_enabled = 0;
 426                 cmd_pkt->trigger[0].flags.data_range_type = H4032L_TRIGGER_DATA_RANGE_TYPE_MAX;
 427                 cmd_pkt->trigger[0].data_range_mask = 0;
 428                 cmd_pkt->trigger[0].data_range_max = 0;
 429
 430                 /* Initialize range mask values. */
 431                 uint32_t range_mask = 0;
 432                 uint32_t range_value = 0;
 433
 434                 GSList *channel = stage1->matches;
 435                 while (channel) {
 436                         struct sr_trigger_match *match = channel->data;
 437
 438                         switch (match->match) {
 439                         case SR_TRIGGER_ZERO:
 440                                 range_mask |= (1 << match->channel->index);
 441                                 break;
 442                         case SR_TRIGGER_ONE:
 443                                 range_mask |= (1 << match->channel->index);
 444                                 range_value |= (1 << match->channel->index);
 445                                 break;
 446                         case SR_TRIGGER_RISING:
 447                                 if (cmd_pkt->trigger[0].flags.edge_type != H4032L_TRIGGER_EDGE_TYPE_DISABLED) {
 448                                         sr_err("Only one trigger signal with fall/rising/edge allowed.");
 449                                         return SR_ERR;
 450                                 }
 451                                 cmd_pkt->trigger[0].flags.edge_type = H4032L_TRIGGER_EDGE_TYPE_RISE;
 452                                 cmd_pkt->trigger[0].flags.edge_signal = match->channel->index;
 453                                 break;
 454                         case SR_TRIGGER_FALLING:
 455                                 if (cmd_pkt->trigger[0].flags.edge_type != H4032L_TRIGGER_EDGE_TYPE_DISABLED) {
 456                                         sr_err("Only one trigger signal with fall/rising/edge allowed.");
 457                                         return SR_ERR;
 458                                 }
 459                                 cmd_pkt->trigger[0].flags.edge_type = H4032L_TRIGGER_EDGE_TYPE_FALL;
 460                                 cmd_pkt->trigger[0].flags.edge_signal = match->channel->index;
 461                                 break;
 462                         case SR_TRIGGER_EDGE:
 463                                 if (cmd_pkt->trigger[0].flags.edge_type != H4032L_TRIGGER_EDGE_TYPE_DISABLED) {
 464                                         sr_err("Only one trigger signal with fall/rising/edge allowed.");
 465                                         return SR_ERR;
 466                                 }
 467                                 cmd_pkt->trigger[0].flags.edge_type = H4032L_TRIGGER_EDGE_TYPE_TOGGLE;
 468                                 cmd_pkt->trigger[0].flags.edge_signal = match->channel->index;
 469                                 break;
 470                         default:
 471                                 sr_err("Unknown trigger value.");
 472                                 return SR_ERR;
 473                         }
 474
 475                         channel = channel->next;
 476                 }
 477
 478                 /* Compress range mask value and apply range settings. */
 479                 if (range_mask) {
 480                         cmd_pkt->trigger[0].flags.data_range_enabled = 1;
 481                         cmd_pkt->trigger[0].data_range_mask |= (range_mask);
 482
 483                         uint32_t new_range_value = 0;
 484                         uint32_t bit_mask = 1;
 485                         while (range_mask) {
 486                                 if ((range_mask & 1) != 0) {
 487                                         new_range_value <<= 1;
 488                                         if ((range_value & 1) != 0)
 489                                                 new_range_value |= bit_mask;
 490                                         bit_mask <<= 1;
 491                                 }
 492                                 range_mask >>= 1;
 493                                 range_value >>= 1;
 494                         }
 495                         cmd_pkt->trigger[0].data_range_max |= range_value;
 496                 }
 497         }
 498
 499         usb_source_add(sdi->session, drvc->sr_ctx, 1000,
 500                 h4032l_receive_data, sdi->driver->context);
 501
 502         /* Start capturing. */
 503         return h4032l_start(sdi);
 504 }
 505
 506 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
 507 {
 508         struct dev_context *devc = sdi->priv;
 509
 510         devc->acq_aborted = TRUE;
 511         if (devc->usb_transfer)
 512                 libusb_cancel_transfer(devc->usb_transfer);
 513
 514         devc->status = H4032L_STATUS_IDLE;
 515
 516         return SR_OK;
 517 }
 518
 519 SR_PRIV struct sr_dev_driver hantek_4032l_driver_info = {
 520         .name = "hantek-4032l",
 521         .longname = "Hantek 4032L",
 522         .api_version = 1,
 523         .init = std_init,
 524         .cleanup = std_cleanup,
 525         .scan = scan,
 526         .dev_list = std_dev_list,
 527         .dev_clear = std_dev_clear,
 528         .config_get = config_get,
 529         .config_set = config_set,
 530         .config_list = config_list,
 531         .dev_open = dev_open,
 532         .dev_close = dev_close,
 533         .dev_acquisition_start = dev_acquisition_start,
 534         .dev_acquisition_stop = dev_acquisition_stop,
 535         .context = NULL,
 536 };
 537 SR_REGISTER_DEV_DRIVER(hantek_4032l_driver_info);