hardware/chronovu-la8/chronovu-la8.c

   1 /*
   2  * This file is part of the sigrok project.
   3  *
   4  * Copyright (C) 2011 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, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  19  */
  20
  21 #include <ftdi.h>
  22 #include <glib.h>
  23 #include <string.h>
  24 #include <stdlib.h>
  25 #include "sigrok.h"
  26 #include "sigrok-internal.h"
  27
  28 #define USB_VENDOR_ID                   0x0403
  29 #define USB_PRODUCT_ID                  0x6001
  30 #define USB_DESCRIPTION                 "ChronoVu LA8"
  31 #define USB_VENDOR_NAME                 "ChronoVu"
  32 #define USB_MODEL_NAME                  "LA8"
  33 #define USB_MODEL_VERSION               ""
  34
  35 #define NUM_PROBES                      8
  36 #define TRIGGER_TYPES                   "01"
  37 #define SDRAM_SIZE                      (8 * 1024 * 1024)
  38 #define MIN_NUM_SAMPLES                 1
  39
  40 #define BS                              4096 /* Block size */
  41 #define NUM_BLOCKS                      2048 /* Number of blocks */
  42
  43 static GSList *dev_insts = NULL;
  44
  45 static const char *probe_names[NUM_PROBES + 1] = {
  46         "0",
  47         "1",
  48         "2",
  49         "3",
  50         "4",
  51         "5",
  52         "6",
  53         "7",
  54         NULL,
  55 };
  56
  57 /* Private, per-device-instance driver context. */
  58 struct context {
  59         /** FTDI device context (used by libftdi). */
  60         struct ftdi_context *ftdic;
  61
  62         /** The currently configured samplerate of the device. */
  63         uint64_t cur_samplerate;
  64
  65         /** The current sampling limit (in ms). */
  66         uint64_t limit_msec;
  67
  68         /** The current sampling limit (in number of samples). */
  69         uint64_t limit_samples;
  70
  71         /** TODO */
  72         gpointer session_id;
  73
  74         /**
  75          * A buffer containing some (mangled) samples from the device.
  76          * Format: Pretty mangled-up (due to hardware reasons), see code.
  77          */
  78         uint8_t mangled_buf[BS];
  79
  80         /**
  81          * An 8MB buffer where we'll store the de-mangled samples.
  82          * Format: Each sample is 1 byte, MSB is channel 7, LSB is channel 0.
  83          */
  84         uint8_t *final_buf;
  85
  86         /**
  87          * Trigger pattern (MSB = channel 7, LSB = channel 0).
  88          * A 1 bit matches a high signal, 0 matches a low signal on a probe.
  89          * Only low/high triggers (but not e.g. rising/falling) are supported.
  90          */
  91         uint8_t trigger_pattern;
  92
  93         /**
  94          * Trigger mask (MSB = channel 7, LSB = channel 0).
  95          * A 1 bit means "must match trigger_pattern", 0 means "don't care".
  96          */
  97         uint8_t trigger_mask;
  98
  99         /** Time (in seconds) before the trigger times out. */
 100         uint64_t trigger_timeout;
 101
 102         /** Tells us whether an SR_DF_TRIGGER packet was already sent. */
 103         int trigger_found;
 104
 105         /** TODO */
 106         time_t done;
 107
 108         /** Counter/index for the data block to be read. */
 109         int block_counter;
 110
 111         /** The divcount value (determines the sample period) for the LA8. */
 112         uint8_t divcount;
 113 };
 114
 115 /* This will be initialized via hw_dev_info_get()/SR_DI_SAMPLERATES. */
 116 static uint64_t supported_samplerates[255 + 1] = { 0 };
 117
 118 /*
 119  * Min: 1 sample per 0.01us -> sample time is 0.084s, samplerate 100MHz
 120  * Max: 1 sample per 2.55us -> sample time is 21.391s, samplerate 392.15kHz
 121  */
 122 static struct sr_samplerates samplerates = {
 123         .low  = 0,
 124         .high = 0,
 125         .step = 0,
 126         .list = supported_samplerates,
 127 };
 128
 129 /* Note: Continuous sampling is not supported by the hardware. */
 130 static int hwcaps[] = {
 131         SR_HWCAP_LOGIC_ANALYZER,
 132         SR_HWCAP_SAMPLERATE,
 133         SR_HWCAP_LIMIT_MSEC, /* TODO: Not yet implemented. */
 134         SR_HWCAP_LIMIT_SAMPLES, /* TODO: Not yet implemented. */
 135         0,
 136 };
 137
 138 /* Function prototypes. */
 139 static int la8_close_usb_reset_sequencer(struct context *ctx);
 140 static int hw_dev_acquisition_stop(int dev_index, gpointer session_data);
 141 static int la8_reset(struct context *ctx);
 142
 143 static void fill_supported_samplerates_if_needed(void)
 144 {
 145         int i;
 146
 147         /* Do nothing if supported_samplerates[] is already filled. */
 148         if (supported_samplerates[0] != 0)
 149                 return;
 150
 151         /* Fill supported_samplerates[] with the proper values. */
 152         for (i = 0; i < 255; i++)
 153                 supported_samplerates[254 - i] = SR_MHZ(100) / (i + 1);
 154         supported_samplerates[255] = 0;
 155 }
 156
 157 /**
 158  * Check if the given samplerate is supported by the LA8 hardware.
 159  *
 160  * @param samplerate The samplerate (in Hz) to check.
 161  * @return 1 if the samplerate is supported/valid, 0 otherwise.
 162  */
 163 static int is_valid_samplerate(uint64_t samplerate)
 164 {
 165         int i;
 166
 167         fill_supported_samplerates_if_needed();
 168
 169         for (i = 0; i < 255; i++) {
 170                 if (supported_samplerates[i] == samplerate)
 171                         return 1;
 172         }
 173
 174         sr_err("la8: %s: invalid samplerate (%" PRIu64 "Hz)",
 175                __func__, samplerate);
 176
 177         return 0;
 178 }
 179
 180 /**
 181  * Convert a samplerate (in Hz) to the 'divcount' value the LA8 wants.
 182  *
 183  * LA8 hardware: sample period = (divcount + 1) * 10ns.
 184  * Min. value for divcount: 0x00 (10ns sample period, 100MHz samplerate).
 185  * Max. value for divcount: 0xfe (2550ns sample period, 392.15kHz samplerate).
 186  *
 187  * @param samplerate The samplerate in Hz.
 188  * @return The divcount value as needed by the hardware, or 0xff upon errors.
 189  */
 190 static uint8_t samplerate_to_divcount(uint64_t samplerate)
 191 {
 192         if (samplerate == 0) {
 193                 sr_err("la8: %s: samplerate was 0", __func__);
 194                 return 0xff;
 195         }
 196
 197         if (!is_valid_samplerate(samplerate)) {
 198                 sr_err("la8: %s: can't get divcount, samplerate invalid",
 199                        __func__);
 200                 return 0xff;
 201         }
 202
 203         return (SR_MHZ(100) / samplerate) - 1;
 204 }
 205
 206 /**
 207  * Write data of a certain length to the LA8's FTDI device.
 208  *
 209  * @param ctx The struct containing private per-device-instance data.
 210  * @param buf The buffer containing the data to write.
 211  * @param size The number of bytes to write.
 212  * @return The number of bytes written, or a negative value upon errors.
 213  */
 214 static int la8_write(struct context *ctx, uint8_t *buf, int size)
 215 {
 216         int bytes_written;
 217
 218         if (!ctx) {
 219                 sr_err("la8: %s: ctx was NULL", __func__);
 220                 return SR_ERR_ARG;
 221         }
 222
 223         if (!ctx->ftdic) {
 224                 sr_err("la8: %s: ctx->ftdic was NULL", __func__);
 225                 return SR_ERR_ARG;
 226         }
 227
 228         if (!buf) {
 229                 sr_err("la8: %s: buf was NULL", __func__);
 230                 return SR_ERR_ARG;
 231         }
 232
 233         if (size < 0) {
 234                 sr_err("la8: %s: size was < 0", __func__);
 235                 return SR_ERR_ARG;
 236         }
 237
 238         bytes_written = ftdi_write_data(ctx->ftdic, buf, size);
 239
 240         if (bytes_written < 0) {
 241                 sr_err("la8: %s: ftdi_write_data: (%d) %s", __func__,
 242                        bytes_written, ftdi_get_error_string(ctx->ftdic));
 243                 (void) la8_close_usb_reset_sequencer(ctx); /* Ignore errors. */
 244         } else if (bytes_written != size) {
 245                 sr_err("la8: %s: bytes to write: %d, bytes written: %d",
 246                        __func__, size, bytes_written);
 247                 (void) la8_close_usb_reset_sequencer(ctx); /* Ignore errors. */
 248         }
 249
 250         return bytes_written;
 251 }
 252
 253 /**
 254  * Read a certain amount of bytes from the LA8's FTDI device.
 255  *
 256  * @param ctx The struct containing private per-device-instance data.
 257  * @param buf The buffer where the received data will be stored.
 258  * @param size The number of bytes to read.
 259  * @return The number of bytes read, or a negative value upon errors.
 260  */
 261 static int la8_read(struct context *ctx, uint8_t *buf, int size)
 262 {
 263         int bytes_read;
 264
 265         if (!ctx) {
 266                 sr_err("la8: %s: ctx was NULL", __func__);
 267                 return SR_ERR_ARG;
 268         }
 269
 270         if (!ctx->ftdic) {
 271                 sr_err("la8: %s: ctx->ftdic was NULL", __func__);
 272                 return SR_ERR_ARG;
 273         }
 274
 275         if (!buf) {
 276                 sr_err("la8: %s: buf was NULL", __func__);
 277                 return SR_ERR_ARG;
 278         }
 279
 280         if (size <= 0) {
 281                 sr_err("la8: %s: size was <= 0", __func__);
 282                 return SR_ERR_ARG;
 283         }
 284
 285         bytes_read = ftdi_read_data(ctx->ftdic, buf, size);
 286
 287         if (bytes_read < 0) {
 288                 sr_err("la8: %s: ftdi_read_data: (%d) %s", __func__,
 289                        bytes_read, ftdi_get_error_string(ctx->ftdic));
 290         } else if (bytes_read != size) {
 291                 // sr_err("la8: %s: bytes to read: %d, bytes read: %d",
 292                 //        __func__, size, bytes_read);
 293         }
 294
 295         return bytes_read;
 296 }
 297
 298 static int la8_close(struct context *ctx)
 299 {
 300         int ret;
 301
 302         if (!ctx) {
 303                 sr_err("la8: %s: ctx was NULL", __func__);
 304                 return SR_ERR_ARG;
 305         }
 306
 307         if (!ctx->ftdic) {
 308                 sr_err("la8: %s: ctx->ftdic was NULL", __func__);
 309                 return SR_ERR_ARG;
 310         }
 311
 312         if ((ret = ftdi_usb_close(ctx->ftdic)) < 0) {
 313                 sr_err("la8: %s: ftdi_usb_close: (%d) %s",
 314                        __func__, ret, ftdi_get_error_string(ctx->ftdic));
 315         }
 316
 317         return ret;
 318 }
 319
 320 /**
 321  * Close the ChronoVu LA8 USB port and reset the LA8 sequencer logic.
 322  *
 323  * @param ctx The struct containing private per-device-instance data.
 324  * @return SR_OK upon success, SR_ERR upon failure.
 325  */
 326 static int la8_close_usb_reset_sequencer(struct context *ctx)
 327 {
 328         /* Magic sequence of bytes for resetting the LA8 sequencer logic. */
 329         uint8_t buf[8] = {0x01, 0x01, 0x01, 0x01, 0x01, 0x01, 0x01, 0x01};
 330         int ret;
 331
 332         if (!ctx) {
 333                 sr_err("la8: %s: ctx was NULL", __func__);
 334                 return SR_ERR_ARG;
 335         }
 336
 337         if (!ctx->ftdic) {
 338                 sr_err("la8: %s: ctx->ftdic was NULL", __func__);
 339                 return SR_ERR_ARG;
 340         }
 341
 342         if (ctx->ftdic->usb_dev) {
 343                 /* Reset the LA8 sequencer logic, then wait 100ms. */
 344                 sr_dbg("la8: resetting sequencer logic");
 345                 (void) la8_write(ctx, buf, 8); /* Ignore errors. */
 346                 g_usleep(100 * 1000);
 347
 348                 /* Purge FTDI buffers, then reset and close the FTDI device. */
 349                 sr_dbg("la8: purging buffers, resetting+closing FTDI device");
 350
 351                 /* Log errors, but ignore them (i.e., don't abort). */
 352                 if ((ret = ftdi_usb_purge_buffers(ctx->ftdic)) < 0)
 353                         sr_err("la8: %s: ftdi_usb_purge_buffers: (%d) %s",
 354                             __func__, ret, ftdi_get_error_string(ctx->ftdic));
 355                 if ((ret = ftdi_usb_reset(ctx->ftdic)) < 0)
 356                         sr_err("la8: %s: ftdi_usb_reset: (%d) %s", __func__,
 357                                ret, ftdi_get_error_string(ctx->ftdic));
 358                 if ((ret = ftdi_usb_close(ctx->ftdic)) < 0)
 359                         sr_err("la8: %s: ftdi_usb_close: (%d) %s", __func__,
 360                                ret, ftdi_get_error_string(ctx->ftdic));
 361         }
 362
 363         ftdi_free(ctx->ftdic); /* Returns void. */
 364         ctx->ftdic = NULL;
 365
 366         return SR_OK;
 367 }
 368
 369 /**
 370  * Reset the ChronoVu LA8.
 371  *
 372  * The LA8 must be reset after a failed read/write operation or upon timeouts.
 373  *
 374  * @param ctx The struct containing private per-device-instance data.
 375  * @return SR_OK upon success, SR_ERR upon failure.
 376  */
 377 static int la8_reset(struct context *ctx)
 378 {
 379         uint8_t buf[BS];
 380         time_t done, now;
 381         int bytes_read;
 382
 383         if (!ctx) {
 384                 sr_err("la8: %s: ctx was NULL", __func__);
 385                 return SR_ERR_ARG;
 386         }
 387
 388         if (!ctx->ftdic) {
 389                 sr_err("la8: %s: ctx->ftdic was NULL", __func__);
 390                 return SR_ERR_ARG;
 391         }
 392
 393         sr_dbg("la8: resetting the device");
 394
 395         /*
 396          * Purge pending read data from the FTDI hardware FIFO until
 397          * no more data is left, or a timeout occurs (after 20s).
 398          */
 399         done = 20 + time(NULL);
 400         do {
 401                 /* TODO: Ignore errors? Check for < 0 at least! */
 402                 bytes_read = la8_read(ctx, (uint8_t *)&buf, BS);
 403                 now = time(NULL);
 404         } while ((done > now) && (bytes_read > 0));
 405
 406         /* Reset the LA8 sequencer logic and close the USB port. */
 407         (void) la8_close_usb_reset_sequencer(ctx); /* Ignore errors. */
 408
 409         sr_dbg("la8: device reset finished");
 410
 411         return SR_OK;
 412 }
 413
 414 static int configure_probes(struct context *ctx, GSList *probes)
 415 {
 416         struct sr_probe *probe;
 417         GSList *l;
 418         uint8_t probe_bit;
 419         char *tc;
 420
 421         ctx->trigger_pattern = 0;
 422         ctx->trigger_mask = 0; /* Default to "don't care" for all probes. */
 423
 424         for (l = probes; l; l = l->next) {
 425                 probe = (struct sr_probe *)l->data;
 426
 427                 if (!probe) {
 428                         sr_err("la8: %s: probe was NULL", __func__);
 429                         return SR_ERR;
 430                 }
 431
 432                 /* Skip disabled probes. */
 433                 if (!probe->enabled)
 434                         continue;
 435
 436                 /* Skip (enabled) probes with no configured trigger. */
 437                 if (!probe->trigger)
 438                         continue;
 439
 440                 /* Note: Must only be run if probe->trigger != NULL. */
 441                 if (probe->index < 0 || probe->index > 7) {
 442                         sr_err("la8: %s: invalid probe index %d, must be "
 443                                "between 0 and 7", __func__, probe->index);
 444                         return SR_ERR;
 445                 }
 446
 447                 probe_bit = (1 << (probe->index - 1));
 448
 449                 /* Configure the probe's trigger mask and trigger pattern. */
 450                 for (tc = probe->trigger; tc && *tc; tc++) {
 451                         ctx->trigger_mask |= probe_bit;
 452
 453                         /* Sanity check, LA8 only supports low/high trigger. */
 454                         if (*tc != '0' && *tc != '1') {
 455                                 sr_err("la8: %s: invalid trigger '%c', only "
 456                                        "'0'/'1' supported", __func__, *tc);
 457                                 return SR_ERR;
 458                         }
 459
 460                         if (*tc == '1')
 461                                 ctx->trigger_pattern |= probe_bit;
 462                 }
 463         }
 464
 465         sr_dbg("la8: %s: trigger_mask = 0x%x, trigger_pattern = 0x%x",
 466                __func__, ctx->trigger_mask, ctx->trigger_pattern);
 467
 468         return SR_OK;
 469 }
 470
 471 static int hw_init(const char *devinfo)
 472 {
 473         int ret;
 474         struct sr_dev_inst *sdi;
 475         struct context *ctx;
 476
 477         /* Avoid compiler errors. */
 478         (void)devinfo;
 479
 480         /* Allocate memory for our private driver context. */
 481         if (!(ctx = g_try_malloc(sizeof(struct context)))) {
 482                 sr_err("la8: %s: struct context malloc failed", __func__);
 483                 goto err_free_nothing;
 484         }
 485
 486         /* Set some sane defaults. */
 487         ctx->ftdic = NULL;
 488         ctx->cur_samplerate = SR_MHZ(100); /* 100MHz == max. samplerate */
 489         ctx->limit_msec = 0;
 490         ctx->limit_samples = 0;
 491         ctx->session_id = NULL;
 492         memset(ctx->mangled_buf, 0, BS);
 493         ctx->final_buf = NULL;
 494         ctx->trigger_pattern = 0x00; /* Value irrelevant, see trigger_mask. */
 495         ctx->trigger_mask = 0x00; /* All probes are "don't care". */
 496         ctx->trigger_timeout = 10; /* Default to 10s trigger timeout. */
 497         ctx->trigger_found = 0;
 498         ctx->done = 0;
 499         ctx->block_counter = 0;
 500         ctx->divcount = 0; /* 10ns sample period == 100MHz samplerate */
 501
 502         /* Allocate memory where we'll store the de-mangled data. */
 503         if (!(ctx->final_buf = g_try_malloc(SDRAM_SIZE))) {
 504                 sr_err("la8: %s: final_buf malloc failed", __func__);
 505                 goto err_free_ctx;
 506         }
 507
 508         /* Allocate memory for the FTDI context (ftdic) and initialize it. */
 509         if (!(ctx->ftdic = ftdi_new())) {
 510                 sr_err("la8: %s: ftdi_new failed", __func__);
 511                 goto err_free_final_buf;
 512         }
 513
 514         /* Check for the device and temporarily open it. */
 515         if ((ret = ftdi_usb_open_desc(ctx->ftdic, USB_VENDOR_ID,
 516                         USB_PRODUCT_ID, USB_DESCRIPTION, NULL)) < 0) {
 517                 (void) la8_close_usb_reset_sequencer(ctx); /* Ignore errors. */
 518                 goto err_free_ftdic;
 519         }
 520         sr_dbg("la8: found device");
 521
 522         /* Register the device with libsigrok. */
 523         sdi = sr_dev_inst_new(0, SR_ST_INITIALIZING,
 524                         USB_VENDOR_NAME, USB_MODEL_NAME, USB_MODEL_VERSION);
 525         if (!sdi) {
 526                 sr_err("la8: %s: sr_dev_inst_new failed", __func__);
 527                 goto err_close_ftdic;
 528         }
 529
 530         sdi->priv = ctx;
 531
 532         dev_insts = g_slist_append(dev_insts, sdi);
 533
 534         sr_spew("la8: %s finished successfully", __func__);
 535
 536         /* Close device. We'll reopen it again when we need it. */
 537         (void) la8_close(ctx); /* Log, but ignore errors. */
 538
 539         return 1;
 540
 541 err_close_ftdic:
 542         (void) la8_close(ctx); /* Log, but ignore errors. */
 543 err_free_ftdic:
 544         free(ctx->ftdic); /* NOT g_free()! */
 545 err_free_final_buf:
 546         g_free(ctx->final_buf);
 547 err_free_ctx:
 548         g_free(ctx);
 549 err_free_nothing:
 550
 551         return 0;
 552 }
 553
 554 static int hw_dev_open(int dev_index)
 555 {
 556         int ret;
 557         struct sr_dev_inst *sdi;
 558         struct context *ctx;
 559
 560         if (!(sdi = sr_dev_inst_get(dev_insts, dev_index))) {
 561                 sr_err("la8: %s: sdi was NULL", __func__);
 562                 return SR_ERR; /* TODO: SR_ERR_ARG? */
 563         }
 564
 565         if (!(ctx = sdi->priv)) {
 566                 sr_err("la8: %s: sdi->priv was NULL", __func__);
 567                 return SR_ERR; /* TODO: SR_ERR_ARG? */
 568         }
 569
 570         sr_dbg("la8: opening device");
 571
 572         /* Open the device. */
 573         if ((ret = ftdi_usb_open_desc(ctx->ftdic, USB_VENDOR_ID,
 574                         USB_PRODUCT_ID, USB_DESCRIPTION, NULL)) < 0) {
 575                 sr_err("la8: %s: ftdi_usb_open_desc: (%d) %s",
 576                        __func__, ret, ftdi_get_error_string(ctx->ftdic));
 577                 (void) la8_close_usb_reset_sequencer(ctx); /* Ignore errors. */
 578                 return SR_ERR;
 579         }
 580         sr_dbg("la8: device opened successfully");
 581
 582         /* Purge RX/TX buffers in the FTDI chip. */
 583         if ((ret = ftdi_usb_purge_buffers(ctx->ftdic)) < 0) {
 584                 sr_err("la8: %s: ftdi_usb_purge_buffers: (%d) %s",
 585                        __func__, ret, ftdi_get_error_string(ctx->ftdic));
 586                 (void) la8_close_usb_reset_sequencer(ctx); /* Ignore errors. */
 587                 goto err_dev_open_close_ftdic;
 588         }
 589         sr_dbg("la8: FTDI buffers purged successfully");
 590
 591         /* Enable flow control in the FTDI chip. */
 592         if ((ret = ftdi_setflowctrl(ctx->ftdic, SIO_RTS_CTS_HS)) < 0) {
 593                 sr_err("la8: %s: ftdi_setflowcontrol: (%d) %s",
 594                        __func__, ret, ftdi_get_error_string(ctx->ftdic));
 595                 (void) la8_close_usb_reset_sequencer(ctx); /* Ignore errors. */
 596                 goto err_dev_open_close_ftdic;
 597         }
 598         sr_dbg("la8: FTDI flow control enabled successfully");
 599
 600         /* Wait 100ms. */
 601         g_usleep(100 * 1000);
 602
 603         sdi->status = SR_ST_ACTIVE;
 604
 605         return SR_OK;
 606
 607 err_dev_open_close_ftdic:
 608         (void) la8_close(ctx); /* Log, but ignore errors. */
 609         return SR_ERR;
 610 }
 611
 612 static int set_samplerate(struct sr_dev_inst *sdi, uint64_t samplerate)
 613 {
 614         struct context *ctx;
 615
 616         if (!sdi) {
 617                 sr_err("la8: %s: sdi was NULL", __func__);
 618                 return SR_ERR_ARG;
 619         }
 620
 621         if (!(ctx = sdi->priv)) {
 622                 sr_err("la8: %s: sdi->priv was NULL", __func__);
 623                 return SR_ERR_ARG;
 624         }
 625
 626         sr_spew("la8: setting samplerate");
 627
 628         fill_supported_samplerates_if_needed();
 629
 630         /* Check if this is a samplerate supported by the hardware. */
 631         if (!is_valid_samplerate(samplerate))
 632                 return SR_ERR;
 633
 634         /* Set the new samplerate. */
 635         ctx->cur_samplerate = samplerate;
 636
 637         sr_dbg("la8: samplerate set to %" PRIu64 "Hz", ctx->cur_samplerate);
 638
 639         return SR_OK;
 640 }
 641
 642 static int hw_dev_close(int dev_index)
 643 {
 644         struct sr_dev_inst *sdi;
 645         struct context *ctx;
 646
 647         if (!(sdi = sr_dev_inst_get(dev_insts, dev_index))) {
 648                 sr_err("la8: %s: sdi was NULL", __func__);
 649                 return SR_ERR; /* TODO: SR_ERR_ARG? */
 650         }
 651
 652         if (!(ctx = sdi->priv)) {
 653                 sr_err("la8: %s: sdi->priv was NULL", __func__);
 654                 return SR_ERR; /* TODO: SR_ERR_ARG? */
 655         }
 656
 657         sr_dbg("la8: closing device");
 658
 659         if (sdi->status == SR_ST_ACTIVE) {
 660                 sr_dbg("la8: %s: status ACTIVE, closing device", __func__);
 661                 /* TODO: Really ignore errors here, or return SR_ERR? */
 662                 (void) la8_close_usb_reset_sequencer(ctx); /* Ignore errors. */
 663         } else {
 664                 sr_spew("la8: %s: status not ACTIVE, nothing to do", __func__);
 665         }
 666
 667         sdi->status = SR_ST_INACTIVE;
 668
 669         sr_dbg("la8: %s: freeing sample buffers", __func__);
 670         g_free(ctx->final_buf);
 671
 672         return SR_OK;
 673 }
 674
 675 static int hw_cleanup(void)
 676 {
 677         GSList *l;
 678         struct sr_dev_inst *sdi;
 679         int ret = SR_OK;
 680
 681         /* Properly close all devices. */
 682         for (l = dev_insts; l; l = l->next) {
 683                 if (!(sdi = l->data)) {
 684                         /* Log error, but continue cleaning up the rest. */
 685                         sr_err("la8: %s: sdi was NULL, continuing", __func__);
 686                         ret = SR_ERR_BUG;
 687                         continue;
 688                 }
 689                 sr_dev_inst_free(sdi); /* Returns void. */
 690         }
 691         g_slist_free(dev_insts); /* Returns void. */
 692         dev_insts = NULL;
 693
 694         return ret;
 695 }
 696
 697 static void *hw_dev_info_get(int dev_index, int dev_info_id)
 698 {
 699         struct sr_dev_inst *sdi;
 700         struct context *ctx;
 701         void *info;
 702
 703         sr_spew("la8: entering %s", __func__);
 704
 705         if (!(sdi = sr_dev_inst_get(dev_insts, dev_index))) {
 706                 sr_err("la8: %s: sdi was NULL", __func__);
 707                 return NULL;
 708         }
 709
 710         if (!(ctx = sdi->priv)) {
 711                 sr_err("la8: %s: sdi->priv was NULL", __func__);
 712                 return NULL;
 713         }
 714
 715         switch (dev_info_id) {
 716         case SR_DI_INST:
 717                 info = sdi;
 718                 break;
 719         case SR_DI_NUM_PROBES:
 720                 info = GINT_TO_POINTER(NUM_PROBES);
 721                 break;
 722         case SR_DI_PROBE_NAMES:
 723                 info = probe_names;
 724                 break;
 725         case SR_DI_SAMPLERATES:
 726                 fill_supported_samplerates_if_needed();
 727                 info = &samplerates;
 728                 break;
 729         case SR_DI_TRIGGER_TYPES:
 730                 info = (char *)TRIGGER_TYPES;
 731                 break;
 732         case SR_DI_CUR_SAMPLERATE:
 733                 info = &ctx->cur_samplerate;
 734                 break;
 735         default:
 736                 /* Unknown device info ID, return NULL. */
 737                 sr_err("la8: %s: Unknown device info ID", __func__);
 738                 info = NULL;
 739                 break;
 740         }
 741
 742         return info;
 743 }
 744
 745 static int hw_dev_status_get(int dev_index)
 746 {
 747         struct sr_dev_inst *sdi;
 748
 749         if (!(sdi = sr_dev_inst_get(dev_insts, dev_index))) {
 750                 sr_err("la8: %s: sdi was NULL, device not found", __func__);
 751                 return SR_ST_NOT_FOUND;
 752         }
 753
 754         sr_dbg("la8: %s: returning status %d", __func__, sdi->status);
 755
 756         return sdi->status;
 757 }
 758
 759 static int *hw_hwcap_get_all(void)
 760 {
 761         sr_spew("la8: entering %s", __func__);
 762
 763         return hwcaps;
 764 }
 765
 766 static int hw_dev_config_set(int dev_index, int hwcap, void *value)
 767 {
 768         struct sr_dev_inst *sdi;
 769         struct context *ctx;
 770
 771         sr_spew("la8: entering %s", __func__);
 772
 773         if (!(sdi = sr_dev_inst_get(dev_insts, dev_index))) {
 774                 sr_err("la8: %s: sdi was NULL", __func__);
 775                 return SR_ERR; /* TODO: SR_ERR_ARG? */
 776         }
 777
 778         if (!(ctx = sdi->priv)) {
 779                 sr_err("la8: %s: sdi->priv was NULL", __func__);
 780                 return SR_ERR; /* TODO: SR_ERR_ARG? */
 781         }
 782
 783         switch (hwcap) {
 784         case SR_HWCAP_SAMPLERATE:
 785                 if (set_samplerate(sdi, *(uint64_t *)value) == SR_ERR)
 786                         return SR_ERR;
 787                 sr_dbg("la8: SAMPLERATE = %" PRIu64, ctx->cur_samplerate);
 788                 break;
 789         case SR_HWCAP_PROBECONFIG:
 790                 if (configure_probes(ctx, (GSList *)value) != SR_OK) {
 791                         sr_err("la8: %s: probe config failed", __func__);
 792                         return SR_ERR;
 793                 }
 794                 break;
 795         case SR_HWCAP_LIMIT_MSEC:
 796                 if (*(uint64_t *)value == 0) {
 797                         sr_err("la8: %s: LIMIT_MSEC can't be 0", __func__);
 798                         return SR_ERR;
 799                 }
 800                 ctx->limit_msec = *(uint64_t *)value;
 801                 sr_dbg("la8: LIMIT_MSEC = %" PRIu64, ctx->limit_msec);
 802                 break;
 803         case SR_HWCAP_LIMIT_SAMPLES:
 804                 if (*(uint64_t *)value < MIN_NUM_SAMPLES) {
 805                         sr_err("la8: %s: LIMIT_SAMPLES too small", __func__);
 806                         return SR_ERR;
 807                 }
 808                 ctx->limit_samples = *(uint64_t *)value;
 809                 sr_dbg("la8: LIMIT_SAMPLES = %" PRIu64, ctx->limit_samples);
 810                 break;
 811         default:
 812                 /* Unknown capability, return SR_ERR. */
 813                 sr_err("la8: %s: Unknown capability", __func__);
 814                 return SR_ERR;
 815                 break;
 816         }
 817
 818         return SR_OK;
 819 }
 820
 821 /**
 822  * Get a block of data from the LA8.
 823  *
 824  * @param ctx The struct containing private per-device-instance data.
 825  * @return SR_OK upon success, or SR_ERR upon errors.
 826  */
 827 static int la8_read_block(struct context *ctx)
 828 {
 829         int i, byte_offset, m, mi, p, index, bytes_read;
 830         time_t now;
 831
 832         if (!ctx) {
 833                 sr_err("la8: %s: ctx was NULL", __func__);
 834                 return SR_ERR_ARG;
 835         }
 836
 837         if (!ctx->ftdic) {
 838                 sr_err("la8: %s: ctx->ftdic was NULL", __func__);
 839                 return SR_ERR_ARG;
 840         }
 841
 842         sr_spew("la8: %s: reading block %d", __func__, ctx->block_counter);
 843
 844         bytes_read = la8_read(ctx, ctx->mangled_buf, BS);
 845
 846         /* If first block read got 0 bytes, retry until success or timeout. */
 847         if ((bytes_read == 0) && (ctx->block_counter == 0)) {
 848                 do {
 849                         sr_spew("la8: %s: reading block 0 again", __func__);
 850                         bytes_read = la8_read(ctx, ctx->mangled_buf, BS);
 851                         /* TODO: How to handle read errors here? */
 852                         now = time(NULL);
 853                 } while ((ctx->done > now) && (bytes_read == 0));
 854         }
 855
 856         /* Check if block read was successful or a timeout occured. */
 857         if (bytes_read != BS) {
 858                 sr_err("la8: %s: trigger timed out", __func__);
 859                 (void) la8_reset(ctx); /* Ignore errors. */
 860                 return SR_ERR;
 861         }
 862
 863         /* De-mangle the data. */
 864         sr_spew("la8: de-mangling samples of block %d", ctx->block_counter);
 865         byte_offset = ctx->block_counter * BS;
 866         m = byte_offset / (1024 * 1024);
 867         mi = m * (1024 * 1024);
 868         for (i = 0; i < BS; i++) {
 869                 p = i & (1 << 0);
 870                 index = m * 2 + (((byte_offset + i) - mi) / 2) * 16;
 871                 index += (ctx->divcount == 0) ? p : (1 - p);
 872                 ctx->final_buf[index] = ctx->mangled_buf[i];
 873         }
 874
 875         return SR_OK;
 876 }
 877
 878 static void send_block_to_session_bus(struct context *ctx, int block)
 879 {
 880         int i;
 881         uint8_t sample, expected_sample;
 882         struct sr_datafeed_packet packet;
 883         struct sr_datafeed_logic logic;
 884         int trigger_point; /* Relative trigger point (in this block). */
 885
 886         /* Note: No sanity checks on ctx/block, caller is responsible. */
 887
 888         /* Check if we can find the trigger condition in this block. */
 889         trigger_point = -1;
 890         expected_sample = ctx->trigger_pattern & ctx->trigger_mask;
 891         for (i = 0; i < BS; i++) {
 892                 /* Don't continue if the trigger was found previously. */
 893                 if (ctx->trigger_found)
 894                         break;
 895
 896                 /*
 897                  * Also, don't continue if triggers are "don't care", i.e. if
 898                  * no trigger conditions were specified by the user. In that
 899                  * case we don't want to send an SR_DF_TRIGGER packet at all.
 900                  */
 901                 if (ctx->trigger_mask == 0x00)
 902                         break;
 903
 904                 sample = *(ctx->final_buf + (block * BS) + i);
 905
 906                 if ((sample & ctx->trigger_mask) == expected_sample) {
 907                         trigger_point = i;
 908                         ctx->trigger_found = 1;
 909                         break;
 910                 }
 911         }
 912
 913         /* If no trigger was found, send one SR_DF_LOGIC packet. */
 914         if (trigger_point == -1) {
 915                 /* Send an SR_DF_LOGIC packet to the session bus. */
 916                 sr_spew("la8: sending SR_DF_LOGIC packet (%d bytes) for "
 917                         "block %d", BS, block);
 918                 packet.type = SR_DF_LOGIC;
 919                 packet.payload = &logic;
 920                 logic.length = BS;
 921                 logic.unitsize = 1;
 922                 logic.data = ctx->final_buf + (block * BS);
 923                 sr_session_bus(ctx->session_id, &packet);
 924                 return;
 925         }
 926
 927         /*
 928          * We found the trigger, so some special handling is needed. We have
 929          * to send an SR_DF_LOGIC packet with the samples before the trigger
 930          * (if any), then the SD_DF_TRIGGER packet itself, then another
 931          * SR_DF_LOGIC packet with the samples after the trigger (if any).
 932          */
 933
 934         /* TODO: Send SR_DF_TRIGGER packet before or after the actual sample? */
 935
 936         /* If at least one sample is located before the trigger... */
 937         if (trigger_point > 0) {
 938                 /* Send pre-trigger SR_DF_LOGIC packet to the session bus. */
 939                 sr_spew("la8: sending pre-trigger SR_DF_LOGIC packet, "
 940                         "start = %d, length = %d", block * BS, trigger_point);
 941                 packet.type = SR_DF_LOGIC;
 942                 packet.payload = &logic;
 943                 logic.length = trigger_point;
 944                 logic.unitsize = 1;
 945                 logic.data = ctx->final_buf + (block * BS);
 946                 sr_session_bus(ctx->session_id, &packet);
 947         }
 948
 949         /* Send the SR_DF_TRIGGER packet to the session bus. */
 950         sr_spew("la8: sending SR_DF_TRIGGER packet, sample = %d",
 951                 (block * BS) + trigger_point);
 952         packet.type = SR_DF_TRIGGER;
 953         packet.payload = NULL;
 954         sr_session_bus(ctx->session_id, &packet);
 955
 956         /* If at least one sample is located after the trigger... */
 957         if (trigger_point < (BS - 1)) {
 958                 /* Send post-trigger SR_DF_LOGIC packet to the session bus. */
 959                 sr_spew("la8: sending post-trigger SR_DF_LOGIC packet, "
 960                         "start = %d, length = %d",
 961                         (block * BS) + trigger_point, BS - trigger_point);
 962                 packet.type = SR_DF_LOGIC;
 963                 packet.payload = &logic;
 964                 logic.length = BS - trigger_point;
 965                 logic.unitsize = 1;
 966                 logic.data = ctx->final_buf + (block * BS) + trigger_point;
 967                 sr_session_bus(ctx->session_id, &packet);
 968         }
 969 }
 970
 971 static int receive_data(int fd, int revents, void *session_data)
 972 {
 973         int i, ret;
 974         struct sr_dev_inst *sdi;
 975         struct context *ctx;
 976
 977         /* Avoid compiler errors. */
 978         (void)fd;
 979         (void)revents;
 980
 981         if (!(sdi = session_data)) {
 982                 sr_err("la8: %s: session_data was NULL", __func__);
 983                 return FALSE;
 984         }
 985
 986         if (!(ctx = sdi->priv)) {
 987                 sr_err("la8: %s: sdi->priv was NULL", __func__);
 988                 return FALSE;
 989         }
 990
 991         /* Get one block of data. */
 992         if ((ret = la8_read_block(ctx)) < 0) {
 993                 sr_err("la8: %s: la8_read_block error: %d", __func__, ret);
 994                 hw_dev_acquisition_stop(sdi->index, session_data);
 995                 return FALSE;
 996         }
 997
 998         /* We need to get exactly NUM_BLOCKS blocks (i.e. 8MB) of data. */
 999         if (ctx->block_counter != (NUM_BLOCKS - 1)) {
1000                 ctx->block_counter++;
1001                 return TRUE;
1002         }
1003
1004         sr_dbg("la8: sampling finished, sending data to session bus now");
1005
1006         /* All data was received and demangled, send it to the session bus. */
1007         for (i = 0; i < NUM_BLOCKS; i++)
1008                 send_block_to_session_bus(ctx, i);
1009
1010         hw_dev_acquisition_stop(sdi->index, session_data);
1011
1012         // return FALSE; /* FIXME? */
1013         return TRUE;
1014 }
1015
1016 static int hw_dev_acquisition_start(int dev_index, gpointer session_data)
1017 {
1018         struct sr_dev_inst *sdi;
1019         struct context *ctx;
1020         struct sr_datafeed_packet packet;
1021         struct sr_datafeed_header header;
1022         uint8_t buf[4];
1023         int bytes_written;
1024
1025         sr_spew("la8: entering %s", __func__);
1026
1027         if (!(sdi = sr_dev_inst_get(dev_insts, dev_index))) {
1028                 sr_err("la8: %s: sdi was NULL", __func__);
1029                 return SR_ERR; /* TODO: SR_ERR_ARG? */
1030         }
1031
1032         if (!(ctx = sdi->priv)) {
1033                 sr_err("la8: %s: sdi->priv was NULL", __func__);
1034                 return SR_ERR; /* TODO: SR_ERR_ARG? */
1035         }
1036
1037         if (!ctx->ftdic) {
1038                 sr_err("la8: %s: ctx->ftdic was NULL", __func__);
1039                 return SR_ERR_ARG;
1040         }
1041
1042         ctx->divcount = samplerate_to_divcount(ctx->cur_samplerate);
1043         if (ctx->divcount == 0xff) {
1044                 sr_err("la8: %s: invalid divcount/samplerate", __func__);
1045                 return SR_ERR;
1046         }
1047
1048         /* Fill acquisition parameters into buf[]. */
1049         buf[0] = ctx->divcount;
1050         buf[1] = 0xff; /* This byte must always be 0xff. */
1051         buf[2] = ctx->trigger_pattern;
1052         buf[3] = ctx->trigger_mask;
1053
1054         /* Start acquisition. */
1055         bytes_written = la8_write(ctx, buf, 4);
1056
1057         if (bytes_written < 0) {
1058                 sr_err("la8: acquisition failed to start");
1059                 return SR_ERR;
1060         } else if (bytes_written != 4) {
1061                 sr_err("la8: acquisition failed to start");
1062                 return SR_ERR; /* TODO: Other error and return code? */
1063         }
1064
1065         sr_dbg("la8: acquisition started successfully");
1066
1067         ctx->session_id = session_data;
1068
1069         /* Send header packet to the session bus. */
1070         sr_dbg("la8: %s: sending SR_DF_HEADER", __func__);
1071         packet.type = SR_DF_HEADER;
1072         packet.payload = &header;
1073         header.feed_version = 1;
1074         gettimeofday(&header.starttime, NULL);
1075         header.samplerate = ctx->cur_samplerate;
1076         header.num_logic_probes = NUM_PROBES;
1077         sr_session_bus(session_data, &packet);
1078
1079         /* Time when we should be done (for detecting trigger timeouts). */
1080         ctx->done = (ctx->divcount + 1) * 0.08388608 + time(NULL)
1081                         + ctx->trigger_timeout;
1082         ctx->block_counter = 0;
1083         ctx->trigger_found = 0;
1084
1085         /* Hook up a dummy handler to receive data from the LA8. */
1086         sr_source_add(-1, G_IO_IN, 0, receive_data, sdi);
1087
1088         return SR_OK;
1089 }
1090
1091 static int hw_dev_acquisition_stop(int dev_index, gpointer session_data)
1092 {
1093         struct sr_dev_inst *sdi;
1094         struct context *ctx;
1095         struct sr_datafeed_packet packet;
1096
1097         sr_dbg("la8: stopping acquisition");
1098
1099         if (!(sdi = sr_dev_inst_get(dev_insts, dev_index))) {
1100                 sr_err("la8: %s: sdi was NULL", __func__);
1101                 return SR_ERR_BUG;
1102         }
1103
1104         if (!(ctx = sdi->priv)) {
1105                 sr_err("la8: %s: sdi->priv was NULL", __func__);
1106                 return SR_ERR_BUG;
1107         }
1108
1109         /* Send end packet to the session bus. */
1110         sr_dbg("la8: %s: sending SR_DF_END", __func__);
1111         packet.type = SR_DF_END;
1112         sr_session_bus(session_data, &packet);
1113
1114         return SR_OK;
1115 }
1116
1117 SR_PRIV struct sr_dev_plugin chronovu_la8_plugin_info = {
1118         .name = "chronovu-la8",
1119         .longname = "ChronoVu LA8",
1120         .api_version = 1,
1121         .init = hw_init,
1122         .cleanup = hw_cleanup,
1123         .dev_open = hw_dev_open,
1124         .dev_close = hw_dev_close,
1125         .dev_info_get = hw_dev_info_get,
1126         .dev_status_get = hw_dev_status_get,
1127         .hwcap_get_all = hw_hwcap_get_all,
1128         .dev_config_set = hw_dev_config_set,
1129         .dev_acquisition_start = hw_dev_acquisition_start,
1130         .dev_acquisition_stop = hw_dev_acquisition_stop,
1131 };