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