src/hardware/chronovu-la/api.c

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2011-2015 Uwe Hermann <uwe@hermann-uwe.de>
   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 2 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 static const uint32_t drvopts[] = {
  24         SR_CONF_LOGIC_ANALYZER,
  25 };
  26
  27 static const uint32_t scanopts[] = {
  28         SR_CONF_CONN,
  29 };
  30
  31 static const uint32_t devopts[] = {
  32         SR_CONF_LIMIT_MSEC | SR_CONF_SET,
  33         SR_CONF_LIMIT_SAMPLES | SR_CONF_SET | SR_CONF_LIST,
  34         SR_CONF_CONN | SR_CONF_GET,
  35         SR_CONF_SAMPLERATE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
  36         SR_CONF_TRIGGER_MATCH | SR_CONF_LIST,
  37 };
  38
  39 static const int32_t trigger_matches[] = {
  40         SR_TRIGGER_ZERO,
  41         SR_TRIGGER_ONE,
  42         SR_TRIGGER_RISING,
  43         SR_TRIGGER_FALLING,
  44 };
  45
  46 static void clear_helper(void *priv)
  47 {
  48         struct dev_context *devc;
  49
  50         devc = priv;
  51
  52         ftdi_free(devc->ftdic);
  53         g_free(devc->final_buf);
  54 }
  55
  56 static int dev_clear(const struct sr_dev_driver *di)
  57 {
  58         return std_dev_clear_with_callback(di, clear_helper);
  59 }
  60
  61 static int add_device(int model, struct libusb_device_descriptor *des,
  62         const char *serial_num, const char *connection_id, libusb_device *usbdev,
  63         GSList **devices)
  64 {
  65         int ret;
  66         unsigned int i;
  67         struct sr_dev_inst *sdi;
  68         struct dev_context *devc;
  69
  70         ret = SR_OK;
  71
  72         /* Allocate memory for our private device context. */
  73         devc = g_malloc0(sizeof(struct dev_context));
  74
  75         /* Set some sane defaults. */
  76         devc->prof = &cv_profiles[model];
  77         devc->ftdic = NULL; /* Will be set in the open() API call. */
  78         devc->cur_samplerate = 0; /* Set later (different for LA8/LA16). */
  79         devc->limit_msec = 0;
  80         devc->limit_samples = 0;
  81         memset(devc->mangled_buf, 0, BS);
  82         devc->final_buf = NULL;
  83         devc->trigger_pattern = 0x0000; /* Irrelevant, see trigger_mask. */
  84         devc->trigger_mask = 0x0000; /* All channels: "don't care". */
  85         devc->trigger_edgemask = 0x0000; /* All channels: "state triggered". */
  86         devc->trigger_found = 0;
  87         devc->done = 0;
  88         devc->block_counter = 0;
  89         devc->divcount = 0;
  90         devc->usb_vid = des->idVendor;
  91         devc->usb_pid = des->idProduct;
  92         memset(devc->samplerates, 0, sizeof(uint64_t) * 255);
  93
  94         /* Allocate memory where we'll store the de-mangled data. */
  95         if (!(devc->final_buf = g_try_malloc(SDRAM_SIZE))) {
  96                 sr_err("Failed to allocate memory for sample buffer.");
  97                 ret = SR_ERR_MALLOC;
  98                 goto err_free_devc;
  99         }
 100
 101         /* We now know the device, set its max. samplerate as default. */
 102         devc->cur_samplerate = devc->prof->max_samplerate;
 103
 104         /* Register the device with libsigrok. */
 105         sdi = g_malloc0(sizeof(struct sr_dev_inst));
 106         sdi->status = SR_ST_INACTIVE;
 107         sdi->vendor = g_strdup("ChronoVu");
 108         sdi->model = g_strdup(devc->prof->modelname);
 109         sdi->serial_num = g_strdup(serial_num);
 110         sdi->connection_id = g_strdup(connection_id);
 111         sdi->conn = sr_usb_dev_inst_new(libusb_get_bus_number(usbdev),
 112                 libusb_get_device_address(usbdev), NULL);
 113         sdi->priv = devc;
 114
 115         for (i = 0; i < devc->prof->num_channels; i++)
 116                 sr_channel_new(sdi, i, SR_CHANNEL_LOGIC, TRUE,
 117                                 cv_channel_names[i]);
 118
 119         *devices = g_slist_append(*devices, sdi);
 120
 121         if (ret == SR_OK)
 122                 return SR_OK;
 123
 124 err_free_devc:
 125         g_free(devc);
 126
 127         return ret;
 128 }
 129
 130 static GSList *scan(struct sr_dev_driver *di, GSList *options)
 131 {
 132         int i, ret, model;
 133         struct drv_context *drvc;
 134         GSList *devices, *conn_devices, *l;
 135         struct sr_usb_dev_inst *usb;
 136         struct sr_config *src;
 137         struct libusb_device_descriptor des;
 138         libusb_device **devlist;
 139         struct libusb_device_handle *hdl;
 140         const char *conn;
 141         char product[64], serial_num[64], connection_id[64];
 142
 143         drvc = di->context;
 144
 145         conn = NULL;
 146         for (l = options; l; l = l->next) {
 147                 src = l->data;
 148                 switch (src->key) {
 149                 case SR_CONF_CONN:
 150                         conn = g_variant_get_string(src->data, NULL);
 151                         break;
 152                 }
 153         }
 154         if (conn)
 155                 conn_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, conn);
 156         else
 157                 conn_devices = NULL;
 158
 159         devices = NULL;
 160         libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
 161
 162         for (i = 0; devlist[i]; i++) {
 163                 if (conn) {
 164                         for (l = conn_devices; l; l = l->next) {
 165                                 usb = l->data;
 166                                 if (usb->bus == libusb_get_bus_number(devlist[i])
 167                                         && usb->address == libusb_get_device_address(devlist[i]))
 168                                         break;
 169                         }
 170                         if (!l)
 171                                 /* This device matched none of the ones that
 172                                  * matched the conn specification. */
 173                                 continue;
 174                 }
 175
 176                 libusb_get_device_descriptor(devlist[i], &des);
 177
 178                 if ((ret = libusb_open(devlist[i], &hdl)) < 0)
 179                         continue;
 180
 181                 if (des.iProduct == 0) {
 182                         product[0] = '\0';
 183                 } else if ((ret = libusb_get_string_descriptor_ascii(hdl,
 184                                 des.iProduct, (unsigned char *)product,
 185                                 sizeof(product))) < 0) {
 186                         sr_warn("Failed to get product string descriptor: %s.",
 187                                 libusb_error_name(ret));
 188                         continue;
 189                 }
 190
 191                 if (des.iSerialNumber == 0) {
 192                         serial_num[0] = '\0';
 193                 } else if ((ret = libusb_get_string_descriptor_ascii(hdl,
 194                                 des.iSerialNumber, (unsigned char *)serial_num,
 195                                 sizeof(serial_num))) < 0) {
 196                         sr_warn("Failed to get serial number string descriptor: %s.",
 197                                 libusb_error_name(ret));
 198                         continue;
 199                 }
 200
 201                 usb_get_port_path(devlist[i], connection_id, sizeof(connection_id));
 202
 203                 libusb_close(hdl);
 204
 205                 if (!strcmp(product, "ChronoVu LA8")) {
 206                         model = 0;
 207                 } else if (!strcmp(product, "ChronoVu LA16")) {
 208                         model = 1;
 209                 } else {
 210                         sr_spew("Unknown iProduct string '%s'.", product);
 211                         continue;
 212                 }
 213
 214                 sr_dbg("Found %s (%04x:%04x, %d.%d, %s).",
 215                        product, des.idVendor, des.idProduct,
 216                        libusb_get_bus_number(devlist[i]),
 217                        libusb_get_device_address(devlist[i]), connection_id);
 218
 219                 if ((ret = add_device(model, &des, serial_num, connection_id,
 220                                         devlist[i], &devices)) < 0) {
 221                         sr_dbg("Failed to add device: %d.", ret);
 222                 }
 223         }
 224
 225         libusb_free_device_list(devlist, 1);
 226         g_slist_free_full(conn_devices, (GDestroyNotify)sr_usb_dev_inst_free);
 227
 228         return std_scan_complete(di, devices);
 229 }
 230
 231 static int dev_open(struct sr_dev_inst *sdi)
 232 {
 233         struct dev_context *devc;
 234         int ret;
 235
 236         devc = sdi->priv;
 237
 238         /* Allocate memory for the FTDI context and initialize it. */
 239         if (!(devc->ftdic = ftdi_new())) {
 240                 sr_err("Failed to initialize libftdi.");
 241                 return SR_ERR;
 242         }
 243
 244         sr_dbg("Opening %s device (%04x:%04x).", devc->prof->modelname,
 245                devc->usb_vid, devc->usb_pid);
 246
 247         /* Open the device. */
 248         if ((ret = ftdi_usb_open_desc(devc->ftdic, devc->usb_vid,
 249                         devc->usb_pid, devc->prof->iproduct, NULL)) < 0) {
 250                 sr_err("Failed to open FTDI device (%d): %s.",
 251                        ret, ftdi_get_error_string(devc->ftdic));
 252                 goto err_ftdi_free;
 253         }
 254
 255         /* Purge RX/TX buffers in the FTDI chip. */
 256         if ((ret = ftdi_usb_purge_buffers(devc->ftdic)) < 0) {
 257                 sr_err("Failed to purge FTDI buffers (%d): %s.",
 258                        ret, ftdi_get_error_string(devc->ftdic));
 259                 goto err_ftdi_free;
 260         }
 261
 262         /* Enable flow control in the FTDI chip. */
 263         if ((ret = ftdi_setflowctrl(devc->ftdic, SIO_RTS_CTS_HS)) < 0) {
 264                 sr_err("Failed to enable FTDI flow control (%d): %s.",
 265                        ret, ftdi_get_error_string(devc->ftdic));
 266                 goto err_ftdi_free;
 267         }
 268
 269         /* Wait 100ms. */
 270         g_usleep(100 * 1000);
 271
 272         return SR_OK;
 273
 274 err_ftdi_free:
 275         ftdi_free(devc->ftdic); /* Close device (if open), free FTDI context. */
 276         devc->ftdic = NULL;
 277         return SR_ERR;
 278 }
 279
 280 static int dev_close(struct sr_dev_inst *sdi)
 281 {
 282         int ret;
 283         struct dev_context *devc;
 284
 285         devc = sdi->priv;
 286
 287         if (!devc->ftdic)
 288                 return SR_ERR_BUG;
 289
 290         if ((ret = ftdi_usb_close(devc->ftdic)) < 0)
 291                 sr_err("Failed to close FTDI device (%d): %s.",
 292                        ret, ftdi_get_error_string(devc->ftdic));
 293
 294         return (ret == 0) ? SR_OK : SR_ERR;
 295 }
 296
 297 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
 298                 const struct sr_channel_group *cg)
 299 {
 300         struct dev_context *devc;
 301         struct sr_usb_dev_inst *usb;
 302         char str[128];
 303
 304         (void)cg;
 305
 306         switch (key) {
 307         case SR_CONF_CONN:
 308                 if (!sdi || !(usb = sdi->conn))
 309                         return SR_ERR_ARG;
 310                 snprintf(str, 128, "%d.%d", usb->bus, usb->address);
 311                 *data = g_variant_new_string(str);
 312                 break;
 313         case SR_CONF_SAMPLERATE:
 314                 if (!sdi)
 315                         return SR_ERR_BUG;
 316                 devc = sdi->priv;
 317                 *data = g_variant_new_uint64(devc->cur_samplerate);
 318                 break;
 319         default:
 320                 return SR_ERR_NA;
 321         }
 322
 323         return SR_OK;
 324 }
 325
 326 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
 327                 const struct sr_channel_group *cg)
 328 {
 329         struct dev_context *devc;
 330
 331         (void)cg;
 332
 333         devc = sdi->priv;
 334
 335         switch (key) {
 336         case SR_CONF_SAMPLERATE:
 337                 if (cv_set_samplerate(sdi, g_variant_get_uint64(data)) < 0)
 338                         return SR_ERR;
 339                 break;
 340         case SR_CONF_LIMIT_MSEC:
 341                 if (g_variant_get_uint64(data) == 0)
 342                         return SR_ERR_ARG;
 343                 devc->limit_msec = g_variant_get_uint64(data);
 344                 break;
 345         case SR_CONF_LIMIT_SAMPLES:
 346                 if (g_variant_get_uint64(data) == 0)
 347                         return SR_ERR_ARG;
 348                 devc->limit_samples = g_variant_get_uint64(data);
 349                 break;
 350         default:
 351                 return SR_ERR_NA;
 352         }
 353
 354         return SR_OK;
 355 }
 356
 357 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
 358                 const struct sr_channel_group *cg)
 359 {
 360         GVariant *gvar, *grange[2];
 361         GVariantBuilder gvb;
 362         struct dev_context *devc;
 363
 364         (void)cg;
 365
 366         switch (key) {
 367         case SR_CONF_SCAN_OPTIONS:
 368                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 369                                 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
 370                 break;
 371         case SR_CONF_DEVICE_OPTIONS:
 372                 if (!sdi)
 373                         *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 374                                         drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t));
 375                 else
 376                         *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 377                                         devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
 378                 break;
 379         case SR_CONF_SAMPLERATE:
 380                 if (!sdi)
 381                         return SR_ERR_BUG;
 382                 devc = sdi->priv;
 383                 cv_fill_samplerates_if_needed(sdi);
 384                 g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
 385                 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"),
 386                                 devc->samplerates,
 387                                 ARRAY_SIZE(devc->samplerates),
 388                                 sizeof(uint64_t));
 389                 g_variant_builder_add(&gvb, "{sv}", "samplerates", gvar);
 390                 *data = g_variant_builder_end(&gvb);
 391                 break;
 392         case SR_CONF_LIMIT_SAMPLES:
 393                 if (!sdi || !sdi->priv || !(devc = sdi->priv) || !devc->prof)
 394                         return SR_ERR_BUG;
 395                 grange[0] = g_variant_new_uint64(0);
 396                 if (devc->prof->model == CHRONOVU_LA8)
 397                         grange[1] = g_variant_new_uint64(MAX_NUM_SAMPLES);
 398                 else
 399                         grange[1] = g_variant_new_uint64(MAX_NUM_SAMPLES / 2);
 400                 *data = g_variant_new_tuple(grange, 2);
 401                 break;
 402         case SR_CONF_TRIGGER_MATCH:
 403                 if (!sdi || !sdi->priv || !(devc = sdi->priv) || !devc->prof)
 404                         return SR_ERR_BUG;
 405                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
 406                                 trigger_matches, devc->prof->num_trigger_matches,
 407                                 sizeof(int32_t));
 408                 break;
 409         default:
 410                 return SR_ERR_NA;
 411         }
 412
 413         return SR_OK;
 414 }
 415
 416 static int receive_data(int fd, int revents, void *cb_data)
 417 {
 418         int i, ret;
 419         struct sr_dev_inst *sdi;
 420         struct dev_context *devc;
 421
 422         (void)fd;
 423         (void)revents;
 424
 425         if (!(sdi = cb_data)) {
 426                 sr_err("cb_data was NULL.");
 427                 return FALSE;
 428         }
 429
 430         if (!(devc = sdi->priv)) {
 431                 sr_err("sdi->priv was NULL.");
 432                 return FALSE;
 433         }
 434
 435         if (!devc->ftdic) {
 436                 sr_err("devc->ftdic was NULL.");
 437                 return FALSE;
 438         }
 439
 440         /* Get one block of data. */
 441         if ((ret = cv_read_block(devc)) < 0) {
 442                 sr_err("Failed to read data block: %d.", ret);
 443                 sr_dev_acquisition_stop(sdi);
 444                 return FALSE;
 445         }
 446
 447         /* We need to get exactly NUM_BLOCKS blocks (i.e. 8MB) of data. */
 448         if (devc->block_counter != (NUM_BLOCKS - 1)) {
 449                 devc->block_counter++;
 450                 return TRUE;
 451         }
 452
 453         sr_dbg("Sampling finished, sending data to session bus now.");
 454
 455         /*
 456          * All data was received and demangled, send it to the session bus.
 457          *
 458          * Note: Due to the method how data is spread across the 8MByte of
 459          * SDRAM, we can _not_ send it to the session bus in a streaming
 460          * manner while we receive it. We have to receive and de-mangle the
 461          * full 8MByte first, only then the whole buffer contains valid data.
 462          */
 463         for (i = 0; i < NUM_BLOCKS; i++)
 464                 cv_send_block_to_session_bus(sdi, i);
 465
 466         sr_dev_acquisition_stop(sdi);
 467
 468         return TRUE;
 469 }
 470
 471 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
 472 {
 473         struct dev_context *devc;
 474         uint8_t buf[8];
 475         int bytes_to_write, bytes_written;
 476
 477         devc = sdi->priv;
 478
 479         if (!devc->ftdic) {
 480                 sr_err("devc->ftdic was NULL.");
 481                 return SR_ERR_BUG;
 482         }
 483
 484         devc->divcount = cv_samplerate_to_divcount(sdi, devc->cur_samplerate);
 485         if (devc->divcount == 0xff) {
 486                 sr_err("Invalid divcount/samplerate.");
 487                 return SR_ERR;
 488         }
 489
 490         if (cv_convert_trigger(sdi) != SR_OK) {
 491                 sr_err("Failed to configure trigger.");
 492                 return SR_ERR;
 493         }
 494
 495         /* Fill acquisition parameters into buf[]. */
 496         if (devc->prof->model == CHRONOVU_LA8) {
 497                 buf[0] = devc->divcount;
 498                 buf[1] = 0xff; /* This byte must always be 0xff. */
 499                 buf[2] = devc->trigger_pattern & 0xff;
 500                 buf[3] = devc->trigger_mask & 0xff;
 501                 bytes_to_write = 4;
 502         } else {
 503                 buf[0] = devc->divcount;
 504                 buf[1] = 0xff; /* This byte must always be 0xff. */
 505                 buf[2] = (devc->trigger_pattern & 0xff00) >> 8;  /* LSB */
 506                 buf[3] = (devc->trigger_pattern & 0x00ff) >> 0;  /* MSB */
 507                 buf[4] = (devc->trigger_mask & 0xff00) >> 8;     /* LSB */
 508                 buf[5] = (devc->trigger_mask & 0x00ff) >> 0;     /* MSB */
 509                 buf[6] = (devc->trigger_edgemask & 0xff00) >> 8; /* LSB */
 510                 buf[7] = (devc->trigger_edgemask & 0x00ff) >> 0; /* MSB */
 511                 bytes_to_write = 8;
 512         }
 513
 514         /* Start acquisition. */
 515         bytes_written = cv_write(devc, buf, bytes_to_write);
 516
 517         if (bytes_written < 0 || bytes_written != bytes_to_write) {
 518                 sr_err("Acquisition failed to start.");
 519                 return SR_ERR;
 520         }
 521
 522         std_session_send_df_header(sdi);
 523
 524         /* Time when we should be done (for detecting trigger timeouts). */
 525         devc->done = (devc->divcount + 1) * devc->prof->trigger_constant +
 526                         g_get_monotonic_time() + (10 * G_TIME_SPAN_SECOND);
 527         devc->block_counter = 0;
 528         devc->trigger_found = 0;
 529
 530         /* Hook up a dummy handler to receive data from the device. */
 531         sr_session_source_add(sdi->session, -1, 0, 0, receive_data, (void *)sdi);
 532
 533         return SR_OK;
 534 }
 535
 536 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
 537 {
 538         sr_session_source_remove(sdi->session, -1);
 539         std_session_send_df_end(sdi);
 540
 541         return SR_OK;
 542 }
 543
 544 static struct sr_dev_driver chronovu_la_driver_info = {
 545         .name = "chronovu-la",
 546         .longname = "ChronoVu LA8/LA16",
 547         .api_version = 1,
 548         .init = std_init,
 549         .cleanup = std_cleanup,
 550         .scan = scan,
 551         .dev_list = std_dev_list,
 552         .dev_clear = dev_clear,
 553         .config_get = config_get,
 554         .config_set = config_set,
 555         .config_list = config_list,
 556         .dev_open = dev_open,
 557         .dev_close = dev_close,
 558         .dev_acquisition_start = dev_acquisition_start,
 559         .dev_acquisition_stop = dev_acquisition_stop,
 560         .context = NULL,
 561 };
 562 SR_REGISTER_DEV_DRIVER(chronovu_la_driver_info);