hardware/openbench-logic-sniffer/ols.c

   1 /*
   2  * This file is part of the sigrok project.
   3  *
   4  * Copyright (C) 2010-2012 Bert Vermeulen <bert@biot.com>
   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 3 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 <stdio.h>
  21 #include <stdint.h>
  22 #include <stdlib.h>
  23 #include <sys/types.h>
  24 #include <sys/stat.h>
  25 #include <fcntl.h>
  26 #include <unistd.h>
  27 #ifdef _WIN32
  28 #include <windows.h>
  29 #else
  30 #include <termios.h>
  31 #endif
  32 #include <string.h>
  33 #include <sys/time.h>
  34 #include <inttypes.h>
  35 #ifdef _WIN32
  36 /* TODO */
  37 #else
  38 #include <arpa/inet.h>
  39 #endif
  40 #include <glib.h>
  41 #include "libsigrok.h"
  42 #include "libsigrok-internal.h"
  43 #include "ols.h"
  44
  45 #ifdef _WIN32
  46 #define O_NONBLOCK FIONBIO
  47 #endif
  48
  49 static const int hwcaps[] = {
  50         SR_HWCAP_LOGIC_ANALYZER,
  51         SR_HWCAP_SAMPLERATE,
  52         SR_HWCAP_CAPTURE_RATIO,
  53         SR_HWCAP_LIMIT_SAMPLES,
  54         SR_HWCAP_RLE,
  55         0,
  56 };
  57
  58 /* Probes are numbered 0-31 (on the PCB silkscreen). */
  59 static const char *probe_names[NUM_PROBES + 1] = {
  60         "0",
  61         "1",
  62         "2",
  63         "3",
  64         "4",
  65         "5",
  66         "6",
  67         "7",
  68         "8",
  69         "9",
  70         "10",
  71         "11",
  72         "12",
  73         "13",
  74         "14",
  75         "15",
  76         "16",
  77         "17",
  78         "18",
  79         "19",
  80         "20",
  81         "21",
  82         "22",
  83         "23",
  84         "24",
  85         "25",
  86         "26",
  87         "27",
  88         "28",
  89         "29",
  90         "30",
  91         "31",
  92         NULL,
  93 };
  94
  95 /* default supported samplerates, can be overridden by device metadata */
  96 static const struct sr_samplerates samplerates = {
  97         SR_HZ(10),
  98         SR_MHZ(200),
  99         SR_HZ(1),
 100         NULL,
 101 };
 102
 103 SR_PRIV struct sr_dev_driver ols_driver_info;
 104 static struct sr_dev_driver *odi = &ols_driver_info;
 105
 106 static int send_shortcommand(int fd, uint8_t command)
 107 {
 108         char buf[1];
 109
 110         sr_dbg("ols: sending cmd 0x%.2x", command);
 111         buf[0] = command;
 112         if (serial_write(fd, buf, 1) != 1)
 113                 return SR_ERR;
 114
 115         return SR_OK;
 116 }
 117
 118 static int send_longcommand(int fd, uint8_t command, uint32_t data)
 119 {
 120         char buf[5];
 121
 122         sr_dbg("ols: sending cmd 0x%.2x data 0x%.8x", command, data);
 123         buf[0] = command;
 124         buf[1] = (data & 0xff000000) >> 24;
 125         buf[2] = (data & 0xff0000) >> 16;
 126         buf[3] = (data & 0xff00) >> 8;
 127         buf[4] = data & 0xff;
 128         if (serial_write(fd, buf, 5) != 5)
 129                 return SR_ERR;
 130
 131         return SR_OK;
 132 }
 133
 134 static int configure_probes(struct context *ctx, const GSList *probes)
 135 {
 136         const struct sr_probe *probe;
 137         const GSList *l;
 138         int probe_bit, stage, i;
 139         char *tc;
 140
 141         ctx->probe_mask = 0;
 142         for (i = 0; i < NUM_TRIGGER_STAGES; i++) {
 143                 ctx->trigger_mask[i] = 0;
 144                 ctx->trigger_value[i] = 0;
 145         }
 146
 147         ctx->num_stages = 0;
 148         for (l = probes; l; l = l->next) {
 149                 probe = (const struct sr_probe *)l->data;
 150                 if (!probe->enabled)
 151                         continue;
 152
 153                 /*
 154                  * Set up the probe mask for later configuration into the
 155                  * flag register.
 156                  */
 157                 probe_bit = 1 << (probe->index - 1);
 158                 ctx->probe_mask |= probe_bit;
 159
 160                 if (!probe->trigger)
 161                         continue;
 162
 163                 /* Configure trigger mask and value. */
 164                 stage = 0;
 165                 for (tc = probe->trigger; tc && *tc; tc++) {
 166                         ctx->trigger_mask[stage] |= probe_bit;
 167                         if (*tc == '1')
 168                                 ctx->trigger_value[stage] |= probe_bit;
 169                         stage++;
 170                         if (stage > 3)
 171                                 /*
 172                                  * TODO: Only supporting parallel mode, with
 173                                  * up to 4 stages.
 174                                  */
 175                                 return SR_ERR;
 176                 }
 177                 if (stage > ctx->num_stages)
 178                         ctx->num_stages = stage;
 179         }
 180
 181         return SR_OK;
 182 }
 183
 184 static uint32_t reverse16(uint32_t in)
 185 {
 186         uint32_t out;
 187
 188         out = (in & 0xff) << 8;
 189         out |= (in & 0xff00) >> 8;
 190         out |= (in & 0xff0000) << 8;
 191         out |= (in & 0xff000000) >> 8;
 192
 193         return out;
 194 }
 195
 196 static uint32_t reverse32(uint32_t in)
 197 {
 198         uint32_t out;
 199
 200         out = (in & 0xff) << 24;
 201         out |= (in & 0xff00) << 8;
 202         out |= (in & 0xff0000) >> 8;
 203         out |= (in & 0xff000000) >> 24;
 204
 205         return out;
 206 }
 207
 208 static struct context *ols_dev_new(void)
 209 {
 210         struct context *ctx;
 211
 212         /* TODO: Is 'ctx' ever g_free()'d? */
 213         if (!(ctx = g_try_malloc0(sizeof(struct context)))) {
 214                 sr_err("ols: %s: ctx malloc failed", __func__);
 215                 return NULL;
 216         }
 217
 218         ctx->trigger_at = -1;
 219         ctx->probe_mask = 0xffffffff;
 220         ctx->cur_samplerate = SR_KHZ(200);
 221         ctx->serial = NULL;
 222
 223         return ctx;
 224 }
 225
 226 static struct sr_dev_inst *get_metadata(int fd)
 227 {
 228         struct sr_dev_inst *sdi;
 229         struct context *ctx;
 230         struct sr_probe *probe;
 231         uint32_t tmp_int, ui;
 232         uint8_t key, type, token;
 233         GString *tmp_str, *devname, *version;
 234         guchar tmp_c;
 235
 236         sdi = sr_dev_inst_new(0, SR_ST_INACTIVE, NULL, NULL, NULL);
 237         ctx = ols_dev_new();
 238         sdi->priv = ctx;
 239
 240         devname = g_string_new("");
 241         version = g_string_new("");
 242
 243         key = 0xff;
 244         while (key) {
 245                 if (serial_read(fd, &key, 1) != 1 || key == 0x00)
 246                         break;
 247                 type = key >> 5;
 248                 token = key & 0x1f;
 249                 switch (type) {
 250                 case 0:
 251                         /* NULL-terminated string */
 252                         tmp_str = g_string_new("");
 253                         while (serial_read(fd, &tmp_c, 1) == 1 && tmp_c != '\0')
 254                                 g_string_append_c(tmp_str, tmp_c);
 255                         sr_dbg("ols: got metadata key 0x%.2x value '%s'",
 256                                key, tmp_str->str);
 257                         switch (token) {
 258                         case 0x01:
 259                                 /* Device name */
 260                                 devname = g_string_append(devname, tmp_str->str);
 261                                 break;
 262                         case 0x02:
 263                                 /* FPGA firmware version */
 264                                 if (version->len)
 265                                         g_string_append(version, ", ");
 266                                 g_string_append(version, "FPGA version ");
 267                                 g_string_append(version, tmp_str->str);
 268                                 break;
 269                         case 0x03:
 270                                 /* Ancillary version */
 271                                 if (version->len)
 272                                         g_string_append(version, ", ");
 273                                 g_string_append(version, "Ancillary version ");
 274                                 g_string_append(version, tmp_str->str);
 275                                 break;
 276                         default:
 277                                 sr_info("ols: unknown token 0x%.2x: '%s'",
 278                                         token, tmp_str->str);
 279                                 break;
 280                         }
 281                         g_string_free(tmp_str, TRUE);
 282                         break;
 283                 case 1:
 284                         /* 32-bit unsigned integer */
 285                         if (serial_read(fd, &tmp_int, 4) != 4)
 286                                 break;
 287                         tmp_int = reverse32(tmp_int);
 288                         sr_dbg("ols: got metadata key 0x%.2x value 0x%.8x",
 289                                key, tmp_int);
 290                         switch (token) {
 291                         case 0x00:
 292                                 /* Number of usable probes */
 293                                 for (ui = 0; ui < tmp_int; ui++) {
 294                                         if (!(probe = sr_probe_new(ui, SR_PROBE_LOGIC, TRUE,
 295                                                         probe_names[ui])))
 296                                                 return 0;
 297                                         sdi->probes = g_slist_append(sdi->probes, probe);
 298                                 }
 299                                 break;
 300                         case 0x01:
 301                                 /* Amount of sample memory available (bytes) */
 302                                 ctx->max_samples = tmp_int;
 303                                 break;
 304                         case 0x02:
 305                                 /* Amount of dynamic memory available (bytes) */
 306                                 /* what is this for? */
 307                                 break;
 308                         case 0x03:
 309                                 /* Maximum sample rate (hz) */
 310                                 ctx->max_samplerate = tmp_int;
 311                                 break;
 312                         case 0x04:
 313                                 /* protocol version */
 314                                 ctx->protocol_version = tmp_int;
 315                                 break;
 316                         default:
 317                                 sr_info("ols: unknown token 0x%.2x: 0x%.8x",
 318                                         token, tmp_int);
 319                                 break;
 320                         }
 321                         break;
 322                 case 2:
 323                         /* 8-bit unsigned integer */
 324                         if (serial_read(fd, &tmp_c, 1) != 1)
 325                                 break;
 326                         sr_dbg("ols: got metadata key 0x%.2x value 0x%.2x",
 327                                key, tmp_c);
 328                         switch (token) {
 329                         case 0x00:
 330                                 /* Number of usable probes */
 331                                 for (ui = 0; ui < tmp_c; ui++) {
 332                                         if (!(probe = sr_probe_new(ui, SR_PROBE_LOGIC, TRUE,
 333                                                         probe_names[ui])))
 334                                                 return 0;
 335                                         sdi->probes = g_slist_append(sdi->probes, probe);
 336                                 }
 337                                 break;
 338                         case 0x01:
 339                                 /* protocol version */
 340                                 ctx->protocol_version = tmp_c;
 341                                 break;
 342                         default:
 343                                 sr_info("ols: unknown token 0x%.2x: 0x%.2x",
 344                                         token, tmp_c);
 345                                 break;
 346                         }
 347                         break;
 348                 default:
 349                         /* unknown type */
 350                         break;
 351                 }
 352         }
 353
 354         sdi->model = devname->str;
 355         sdi->version = version->str;
 356         g_string_free(devname, FALSE);
 357         g_string_free(version, FALSE);
 358
 359         return sdi;
 360 }
 361
 362 static int hw_init(void)
 363 {
 364
 365         /* Nothing to do. */
 366
 367         return SR_OK;
 368 }
 369
 370 static GSList *hw_scan(GSList *options)
 371 {
 372         struct sr_dev_inst *sdi;
 373         struct context *ctx;
 374         struct sr_probe *probe;
 375         GSList *devices, *ports, *l;
 376         GPollFD *fds, probefd;
 377         int devcnt, final_devcnt, num_ports, fd, ret, i, j;
 378         char buf[8], **dev_names, **serial_params;
 379
 380         (void)options;
 381         final_devcnt = 0;
 382         devices = NULL;
 383
 384         /* Scan all serial ports. */
 385         ports = list_serial_ports();
 386         num_ports = g_slist_length(ports);
 387
 388         if (!(fds = g_try_malloc0(num_ports * sizeof(GPollFD)))) {
 389                 sr_err("ols: %s: fds malloc failed", __func__);
 390                 goto hw_init_free_ports; /* TODO: SR_ERR_MALLOC. */
 391         }
 392
 393         if (!(dev_names = g_try_malloc(num_ports * sizeof(char *)))) {
 394                 sr_err("ols: %s: dev_names malloc failed", __func__);
 395                 goto hw_init_free_fds; /* TODO: SR_ERR_MALLOC. */
 396         }
 397
 398         if (!(serial_params = g_try_malloc(num_ports * sizeof(char *)))) {
 399                 sr_err("ols: %s: serial_params malloc failed", __func__);
 400                 goto hw_init_free_dev_names; /* TODO: SR_ERR_MALLOC. */
 401         }
 402
 403         devcnt = 0;
 404         for (l = ports; l; l = l->next) {
 405                 /* The discovery procedure is like this: first send the Reset
 406                  * command (0x00) 5 times, since the device could be anywhere
 407                  * in a 5-byte command. Then send the ID command (0x02).
 408                  * If the device responds with 4 bytes ("OLS1" or "SLA1"), we
 409                  * have a match.
 410                  *
 411                  * Since it may take the device a while to respond at 115Kb/s,
 412                  * we do all the sending first, then wait for all of them to
 413                  * respond with g_poll().
 414                  */
 415                 sr_info("ols: probing %s...", (char *)l->data);
 416                 fd = serial_open(l->data, O_RDWR | O_NONBLOCK);
 417                 if (fd != -1) {
 418                         serial_params[devcnt] = serial_backup_params(fd);
 419                         serial_set_params(fd, 115200, 8, SERIAL_PARITY_NONE, 1, 2);
 420                         ret = SR_OK;
 421                         for (i = 0; i < 5; i++) {
 422                                 if ((ret = send_shortcommand(fd,
 423                                         CMD_RESET)) != SR_OK) {
 424                                         /* Serial port is not writable. */
 425                                         break;
 426                                 }
 427                         }
 428                         if (ret != SR_OK) {
 429                                 serial_restore_params(fd,
 430                                         serial_params[devcnt]);
 431                                 serial_close(fd);
 432                                 continue;
 433                         }
 434                         send_shortcommand(fd, CMD_ID);
 435                         fds[devcnt].fd = fd;
 436                         fds[devcnt].events = G_IO_IN;
 437                         dev_names[devcnt] = g_strdup(l->data);
 438                         devcnt++;
 439                 }
 440                 g_free(l->data);
 441         }
 442
 443         /* 2ms isn't enough for reliable transfer with pl2303, let's try 10 */
 444         usleep(10000);
 445
 446         g_poll(fds, devcnt, 1);
 447
 448         for (i = 0; i < devcnt; i++) {
 449                 if (fds[i].revents != G_IO_IN)
 450                         continue;
 451                 if (serial_read(fds[i].fd, buf, 4) != 4)
 452                         continue;
 453                 if (strncmp(buf, "1SLO", 4) && strncmp(buf, "1ALS", 4))
 454                         continue;
 455
 456                 /* definitely using the OLS protocol, check if it supports
 457                  * the metadata command
 458                  */
 459                 send_shortcommand(fds[i].fd, CMD_METADATA);
 460                 probefd.fd = fds[i].fd;
 461                 probefd.events = G_IO_IN;
 462                 if (g_poll(&probefd, 1, 10) > 0) {
 463                         /* got metadata */
 464                         sdi = get_metadata(fds[i].fd);
 465                         sdi->index = final_devcnt;
 466                         ctx = sdi->priv;
 467                 } else {
 468                         /* not an OLS -- some other board that uses the sump protocol */
 469                         sdi = sr_dev_inst_new(final_devcnt, SR_ST_INACTIVE,
 470                                         "Sump", "Logic Analyzer", "v1.0");
 471                         ctx = ols_dev_new();
 472                         for (j = 0; j < 32; j++) {
 473                                 if (!(probe = sr_probe_new(j, SR_PROBE_LOGIC, TRUE,
 474                                                 probe_names[j])))
 475                                         return 0;
 476                                 sdi->probes = g_slist_append(sdi->probes, probe);
 477                         }
 478                         sdi->priv = ctx;
 479                 }
 480                 ctx->serial = sr_serial_dev_inst_new(dev_names[i], -1);
 481                 odi->instances = g_slist_append(odi->instances, sdi);
 482                 devices = g_slist_append(devices, sdi);
 483
 484                 final_devcnt++;
 485                 serial_close(fds[i].fd);
 486                 fds[i].fd = 0;
 487         }
 488
 489         /* clean up after all the probing */
 490         for (i = 0; i < devcnt; i++) {
 491                 if (fds[i].fd != 0) {
 492                         serial_restore_params(fds[i].fd, serial_params[i]);
 493                         serial_close(fds[i].fd);
 494                 }
 495                 g_free(serial_params[i]);
 496                 g_free(dev_names[i]);
 497         }
 498
 499         g_free(serial_params);
 500 hw_init_free_dev_names:
 501         g_free(dev_names);
 502 hw_init_free_fds:
 503         g_free(fds);
 504 hw_init_free_ports:
 505         g_slist_free(ports);
 506
 507         return devices;
 508 }
 509
 510 static int hw_dev_open(int dev_index)
 511 {
 512         struct sr_dev_inst *sdi;
 513         struct context *ctx;
 514
 515         if (!(sdi = sr_dev_inst_get(odi->instances, dev_index)))
 516                 return SR_ERR;
 517
 518         ctx = sdi->priv;
 519
 520         ctx->serial->fd = serial_open(ctx->serial->port, O_RDWR);
 521         if (ctx->serial->fd == -1)
 522                 return SR_ERR;
 523
 524         sdi->status = SR_ST_ACTIVE;
 525
 526         return SR_OK;
 527 }
 528
 529 static int hw_dev_close(int dev_index)
 530 {
 531         struct sr_dev_inst *sdi;
 532         struct context *ctx;
 533
 534         if (!(sdi = sr_dev_inst_get(odi->instances, dev_index))) {
 535                 sr_err("ols: %s: sdi was NULL", __func__);
 536                 return SR_ERR_BUG;
 537         }
 538
 539         ctx = sdi->priv;
 540
 541         /* TODO */
 542         if (ctx->serial->fd != -1) {
 543                 serial_close(ctx->serial->fd);
 544                 ctx->serial->fd = -1;
 545                 sdi->status = SR_ST_INACTIVE;
 546         }
 547
 548         return SR_OK;
 549 }
 550
 551 static int hw_cleanup(void)
 552 {
 553         GSList *l;
 554         struct sr_dev_inst *sdi;
 555         struct context *ctx;
 556         int ret = SR_OK;
 557
 558         /* Properly close and free all devices. */
 559         for (l = odi->instances; l; l = l->next) {
 560                 if (!(sdi = l->data)) {
 561                         /* Log error, but continue cleaning up the rest. */
 562                         sr_err("ols: %s: sdi was NULL, continuing", __func__);
 563                         ret = SR_ERR_BUG;
 564                         continue;
 565                 }
 566                 if (!(ctx = sdi->priv)) {
 567                         /* Log error, but continue cleaning up the rest. */
 568                         sr_err("ols: %s: sdi->priv was NULL, continuing",
 569                                __func__);
 570                         ret = SR_ERR_BUG;
 571                         continue;
 572                 }
 573                 /* TODO: Check for serial != NULL. */
 574                 if (ctx->serial->fd != -1)
 575                         serial_close(ctx->serial->fd);
 576                 sr_serial_dev_inst_free(ctx->serial);
 577                 sr_dev_inst_free(sdi);
 578         }
 579         g_slist_free(odi->instances);
 580         odi->instances = NULL;
 581
 582         return ret;
 583 }
 584
 585 static int hw_info_get(int info_id, const void **data,
 586        const struct sr_dev_inst *sdi)
 587 {
 588         struct context *ctx;
 589
 590         switch (info_id) {
 591         case SR_DI_INST:
 592                 *data = sdi;
 593                 break;
 594         case SR_DI_NUM_PROBES:
 595                 *data = GINT_TO_POINTER(1);
 596                 break;
 597         case SR_DI_PROBE_NAMES:
 598                 *data = probe_names;
 599                 break;
 600         case SR_DI_SAMPLERATES:
 601                 *data = &samplerates;
 602                 break;
 603         case SR_DI_TRIGGER_TYPES:
 604                 *data = (char *)TRIGGER_TYPES;
 605                 break;
 606         case SR_DI_CUR_SAMPLERATE:
 607                 if (sdi) {
 608                         ctx = sdi->priv;
 609                         *data = &ctx->cur_samplerate;
 610                 } else
 611                         return SR_ERR;
 612                 break;
 613         default:
 614                 return SR_ERR_ARG;
 615         }
 616
 617         return SR_OK;
 618 }
 619
 620 static int hw_dev_status_get(int dev_index)
 621 {
 622         struct sr_dev_inst *sdi;
 623
 624         if (!(sdi = sr_dev_inst_get(odi->instances, dev_index)))
 625                 return SR_ST_NOT_FOUND;
 626
 627         return sdi->status;
 628 }
 629
 630 static int set_samplerate(struct sr_dev_inst *sdi, uint64_t samplerate)
 631 {
 632         struct context *ctx;
 633
 634         ctx = sdi->priv;
 635         if (ctx->max_samplerate) {
 636                 if (samplerate > ctx->max_samplerate)
 637                         return SR_ERR_SAMPLERATE;
 638         } else if (samplerate < samplerates.low || samplerate > samplerates.high)
 639                 return SR_ERR_SAMPLERATE;
 640
 641         if (samplerate > CLOCK_RATE) {
 642                 ctx->flag_reg |= FLAG_DEMUX;
 643                 ctx->cur_samplerate_divider = (CLOCK_RATE * 2 / samplerate) - 1;
 644         } else {
 645                 ctx->flag_reg &= ~FLAG_DEMUX;
 646                 ctx->cur_samplerate_divider = (CLOCK_RATE / samplerate) - 1;
 647         }
 648
 649         /* Calculate actual samplerate used and complain if it is different
 650          * from the requested.
 651          */
 652         ctx->cur_samplerate = CLOCK_RATE / (ctx->cur_samplerate_divider + 1);
 653         if (ctx->flag_reg & FLAG_DEMUX)
 654                 ctx->cur_samplerate *= 2;
 655         if (ctx->cur_samplerate != samplerate)
 656                 sr_err("ols: can't match samplerate %" PRIu64 ", using %"
 657                        PRIu64, samplerate, ctx->cur_samplerate);
 658
 659         return SR_OK;
 660 }
 661
 662 static int hw_dev_config_set(int dev_index, int hwcap, const void *value)
 663 {
 664         struct sr_dev_inst *sdi;
 665         struct context *ctx;
 666         int ret;
 667         const uint64_t *tmp_u64;
 668
 669         if (!(sdi = sr_dev_inst_get(odi->instances, dev_index)))
 670                 return SR_ERR;
 671         ctx = sdi->priv;
 672
 673         if (sdi->status != SR_ST_ACTIVE)
 674                 return SR_ERR;
 675
 676         switch (hwcap) {
 677         case SR_HWCAP_SAMPLERATE:
 678                 ret = set_samplerate(sdi, *(const uint64_t *)value);
 679                 break;
 680         case SR_HWCAP_PROBECONFIG:
 681                 ret = configure_probes(ctx, (const GSList *)value);
 682                 break;
 683         case SR_HWCAP_LIMIT_SAMPLES:
 684                 tmp_u64 = value;
 685                 if (*tmp_u64 < MIN_NUM_SAMPLES)
 686                         return SR_ERR;
 687                 if (*tmp_u64 > ctx->max_samples)
 688                         sr_err("ols: sample limit exceeds hw max");
 689                 ctx->limit_samples = *tmp_u64;
 690                 sr_info("ols: sample limit %" PRIu64, ctx->limit_samples);
 691                 ret = SR_OK;
 692                 break;
 693         case SR_HWCAP_CAPTURE_RATIO:
 694                 ctx->capture_ratio = *(const uint64_t *)value;
 695                 if (ctx->capture_ratio < 0 || ctx->capture_ratio > 100) {
 696                         ctx->capture_ratio = 0;
 697                         ret = SR_ERR;
 698                 } else
 699                         ret = SR_OK;
 700                 break;
 701         case SR_HWCAP_RLE:
 702                 if (GPOINTER_TO_INT(value)) {
 703                         sr_info("ols: enabling RLE");
 704                         ctx->flag_reg |= FLAG_RLE;
 705                 }
 706                 ret = SR_OK;
 707                 break;
 708         default:
 709                 ret = SR_ERR;
 710         }
 711
 712         return ret;
 713 }
 714
 715 static int receive_data(int fd, int revents, void *cb_data)
 716 {
 717         struct sr_datafeed_packet packet;
 718         struct sr_datafeed_logic logic;
 719         struct sr_dev_inst *sdi;
 720         struct context *ctx;
 721         GSList *l;
 722         int num_channels, offset, i, j;
 723         unsigned char byte;
 724
 725         /* Find this device's ctx struct by its fd. */
 726         ctx = NULL;
 727         for (l = odi->instances; l; l = l->next) {
 728                 sdi = l->data;
 729                 ctx = sdi->priv;
 730                 if (ctx->serial->fd == fd) {
 731                         break;
 732                 }
 733                 ctx = NULL;
 734         }
 735         if (!ctx)
 736                 /* Shouldn't happen. */
 737                 return TRUE;
 738
 739         if (ctx->num_transfers++ == 0) {
 740                 /*
 741                  * First time round, means the device started sending data,
 742                  * and will not stop until done. If it stops sending for
 743                  * longer than it takes to send a byte, that means it's
 744                  * finished. We'll double that to 30ms to be sure...
 745                  */
 746                 sr_source_remove(fd);
 747                 sr_source_add(fd, G_IO_IN, 30, receive_data, cb_data);
 748                 ctx->raw_sample_buf = g_try_malloc(ctx->limit_samples * 4);
 749                 if (!ctx->raw_sample_buf) {
 750                         sr_err("ols: %s: ctx->raw_sample_buf malloc failed",
 751                                __func__);
 752                         return FALSE;
 753                 }
 754                 /* fill with 1010... for debugging */
 755                 memset(ctx->raw_sample_buf, 0x82, ctx->limit_samples * 4);
 756         }
 757
 758         num_channels = 0;
 759         for (i = 0x20; i > 0x02; i /= 2) {
 760                 if ((ctx->flag_reg & i) == 0)
 761                         num_channels++;
 762         }
 763
 764         if (revents == G_IO_IN) {
 765                 if (serial_read(fd, &byte, 1) != 1)
 766                         return FALSE;
 767
 768                 /* Ignore it if we've read enough. */
 769                 if (ctx->num_samples >= ctx->limit_samples)
 770                         return TRUE;
 771
 772                 ctx->sample[ctx->num_bytes++] = byte;
 773                 sr_dbg("ols: received byte 0x%.2x", byte);
 774                 if (ctx->num_bytes == num_channels) {
 775                         /* Got a full sample. */
 776                         sr_dbg("ols: received sample 0x%.*x",
 777                                ctx->num_bytes * 2, *(int *)ctx->sample);
 778                         if (ctx->flag_reg & FLAG_RLE) {
 779                                 /*
 780                                  * In RLE mode -1 should never come in as a
 781                                  * sample, because bit 31 is the "count" flag.
 782                                  */
 783                                 if (ctx->sample[ctx->num_bytes - 1] & 0x80) {
 784                                         ctx->sample[ctx->num_bytes - 1] &= 0x7f;
 785                                         /*
 786                                          * FIXME: This will only work on
 787                                          * little-endian systems.
 788                                          */
 789                                         ctx->rle_count = *(int *)(ctx->sample);
 790                                         sr_dbg("ols: RLE count = %d", ctx->rle_count);
 791                                         ctx->num_bytes = 0;
 792                                         return TRUE;
 793                                 }
 794                         }
 795                         ctx->num_samples += ctx->rle_count + 1;
 796                         if (ctx->num_samples > ctx->limit_samples) {
 797                                 /* Save us from overrunning the buffer. */
 798                                 ctx->rle_count -= ctx->num_samples - ctx->limit_samples;
 799                                 ctx->num_samples = ctx->limit_samples;
 800                         }
 801
 802                         if (num_channels < 4) {
 803                                 /*
 804                                  * Some channel groups may have been turned
 805                                  * off, to speed up transfer between the
 806                                  * hardware and the PC. Expand that here before
 807                                  * submitting it over the session bus --
 808                                  * whatever is listening on the bus will be
 809                                  * expecting a full 32-bit sample, based on
 810                                  * the number of probes.
 811                                  */
 812                                 j = 0;
 813                                 memset(ctx->tmp_sample, 0, 4);
 814                                 for (i = 0; i < 4; i++) {
 815                                         if (((ctx->flag_reg >> 2) & (1 << i)) == 0) {
 816                                                 /*
 817                                                  * This channel group was
 818                                                  * enabled, copy from received
 819                                                  * sample.
 820                                                  */
 821                                                 ctx->tmp_sample[i] = ctx->sample[j++];
 822                                         }
 823                                 }
 824                                 memcpy(ctx->sample, ctx->tmp_sample, 4);
 825                                 sr_dbg("ols: full sample 0x%.8x", *(int *)ctx->sample);
 826                         }
 827
 828                         /* the OLS sends its sample buffer backwards.
 829                          * store it in reverse order here, so we can dump
 830                          * this on the session bus later.
 831                          */
 832                         offset = (ctx->limit_samples - ctx->num_samples) * 4;
 833                         for (i = 0; i <= ctx->rle_count; i++) {
 834                                 memcpy(ctx->raw_sample_buf + offset + (i * 4),
 835                                        ctx->sample, 4);
 836                         }
 837                         memset(ctx->sample, 0, 4);
 838                         ctx->num_bytes = 0;
 839                         ctx->rle_count = 0;
 840                 }
 841         } else {
 842                 /*
 843                  * This is the main loop telling us a timeout was reached, or
 844                  * we've acquired all the samples we asked for -- we're done.
 845                  * Send the (properly-ordered) buffer to the frontend.
 846                  */
 847                 if (ctx->trigger_at != -1) {
 848                         /* a trigger was set up, so we need to tell the frontend
 849                          * about it.
 850                          */
 851                         if (ctx->trigger_at > 0) {
 852                                 /* there are pre-trigger samples, send those first */
 853                                 packet.type = SR_DF_LOGIC;
 854                                 packet.payload = &logic;
 855                                 logic.length = ctx->trigger_at * 4;
 856                                 logic.unitsize = 4;
 857                                 logic.data = ctx->raw_sample_buf +
 858                                         (ctx->limit_samples - ctx->num_samples) * 4;
 859                                 sr_session_send(cb_data, &packet);
 860                         }
 861
 862                         /* send the trigger */
 863                         packet.type = SR_DF_TRIGGER;
 864                         sr_session_send(cb_data, &packet);
 865
 866                         /* send post-trigger samples */
 867                         packet.type = SR_DF_LOGIC;
 868                         packet.payload = &logic;
 869                         logic.length = (ctx->num_samples * 4) - (ctx->trigger_at * 4);
 870                         logic.unitsize = 4;
 871                         logic.data = ctx->raw_sample_buf + ctx->trigger_at * 4 +
 872                                 (ctx->limit_samples - ctx->num_samples) * 4;
 873                         sr_session_send(cb_data, &packet);
 874                 } else {
 875                         /* no trigger was used */
 876                         packet.type = SR_DF_LOGIC;
 877                         packet.payload = &logic;
 878                         logic.length = ctx->num_samples * 4;
 879                         logic.unitsize = 4;
 880                         logic.data = ctx->raw_sample_buf +
 881                                 (ctx->limit_samples - ctx->num_samples) * 4;
 882                         sr_session_send(cb_data, &packet);
 883                 }
 884                 g_free(ctx->raw_sample_buf);
 885
 886                 serial_flush(fd);
 887                 serial_close(fd);
 888                 packet.type = SR_DF_END;
 889                 sr_session_send(cb_data, &packet);
 890         }
 891
 892         return TRUE;
 893 }
 894
 895 static int hw_dev_acquisition_start(int dev_index, void *cb_data)
 896 {
 897         struct sr_datafeed_packet *packet;
 898         struct sr_datafeed_header *header;
 899         struct sr_datafeed_meta_logic meta;
 900         struct sr_dev_inst *sdi;
 901         struct context *ctx;
 902         uint32_t trigger_config[4];
 903         uint32_t data;
 904         uint16_t readcount, delaycount;
 905         uint8_t changrp_mask;
 906         int num_channels;
 907         int i;
 908
 909         if (!(sdi = sr_dev_inst_get(odi->instances, dev_index)))
 910                 return SR_ERR;
 911
 912         ctx = sdi->priv;
 913
 914         if (sdi->status != SR_ST_ACTIVE)
 915                 return SR_ERR;
 916
 917         /*
 918          * Enable/disable channel groups in the flag register according to the
 919          * probe mask. Calculate this here, because num_channels is needed
 920          * to limit readcount.
 921          */
 922         changrp_mask = 0;
 923         num_channels = 0;
 924         for (i = 0; i < 4; i++) {
 925                 if (ctx->probe_mask & (0xff << (i * 8))) {
 926                         changrp_mask |= (1 << i);
 927                         num_channels++;
 928                 }
 929         }
 930
 931         /*
 932          * Limit readcount to prevent reading past the end of the hardware
 933          * buffer.
 934          */
 935         readcount = MIN(ctx->max_samples / num_channels, ctx->limit_samples) / 4;
 936
 937         memset(trigger_config, 0, 16);
 938         trigger_config[ctx->num_stages - 1] |= 0x08;
 939         if (ctx->trigger_mask[0]) {
 940                 delaycount = readcount * (1 - ctx->capture_ratio / 100.0);
 941                 ctx->trigger_at = (readcount - delaycount) * 4 - ctx->num_stages;
 942
 943                 if (send_longcommand(ctx->serial->fd, CMD_SET_TRIGGER_MASK_0,
 944                         reverse32(ctx->trigger_mask[0])) != SR_OK)
 945                         return SR_ERR;
 946                 if (send_longcommand(ctx->serial->fd, CMD_SET_TRIGGER_VALUE_0,
 947                         reverse32(ctx->trigger_value[0])) != SR_OK)
 948                         return SR_ERR;
 949                 if (send_longcommand(ctx->serial->fd, CMD_SET_TRIGGER_CONFIG_0,
 950                         trigger_config[0]) != SR_OK)
 951                         return SR_ERR;
 952
 953                 if (send_longcommand(ctx->serial->fd, CMD_SET_TRIGGER_MASK_1,
 954                         reverse32(ctx->trigger_mask[1])) != SR_OK)
 955                         return SR_ERR;
 956                 if (send_longcommand(ctx->serial->fd, CMD_SET_TRIGGER_VALUE_1,
 957                         reverse32(ctx->trigger_value[1])) != SR_OK)
 958                         return SR_ERR;
 959                 if (send_longcommand(ctx->serial->fd, CMD_SET_TRIGGER_CONFIG_1,
 960                         trigger_config[1]) != SR_OK)
 961                         return SR_ERR;
 962
 963                 if (send_longcommand(ctx->serial->fd, CMD_SET_TRIGGER_MASK_2,
 964                         reverse32(ctx->trigger_mask[2])) != SR_OK)
 965                         return SR_ERR;
 966                 if (send_longcommand(ctx->serial->fd, CMD_SET_TRIGGER_VALUE_2,
 967                         reverse32(ctx->trigger_value[2])) != SR_OK)
 968                         return SR_ERR;
 969                 if (send_longcommand(ctx->serial->fd, CMD_SET_TRIGGER_CONFIG_2,
 970                         trigger_config[2]) != SR_OK)
 971                         return SR_ERR;
 972
 973                 if (send_longcommand(ctx->serial->fd, CMD_SET_TRIGGER_MASK_3,
 974                         reverse32(ctx->trigger_mask[3])) != SR_OK)
 975                         return SR_ERR;
 976                 if (send_longcommand(ctx->serial->fd, CMD_SET_TRIGGER_VALUE_3,
 977                         reverse32(ctx->trigger_value[3])) != SR_OK)
 978                         return SR_ERR;
 979                 if (send_longcommand(ctx->serial->fd, CMD_SET_TRIGGER_CONFIG_3,
 980                         trigger_config[3]) != SR_OK)
 981                         return SR_ERR;
 982         } else {
 983                 if (send_longcommand(ctx->serial->fd, CMD_SET_TRIGGER_MASK_0,
 984                                 ctx->trigger_mask[0]) != SR_OK)
 985                         return SR_ERR;
 986                 if (send_longcommand(ctx->serial->fd, CMD_SET_TRIGGER_VALUE_0,
 987                                 ctx->trigger_value[0]) != SR_OK)
 988                         return SR_ERR;
 989                 if (send_longcommand(ctx->serial->fd, CMD_SET_TRIGGER_CONFIG_0,
 990                      0x00000008) != SR_OK)
 991                         return SR_ERR;
 992                 delaycount = readcount;
 993         }
 994
 995         sr_info("ols: setting samplerate to %" PRIu64 " Hz (divider %u, "
 996                 "demux %s)", ctx->cur_samplerate, ctx->cur_samplerate_divider,
 997                 ctx->flag_reg & FLAG_DEMUX ? "on" : "off");
 998         if (send_longcommand(ctx->serial->fd, CMD_SET_DIVIDER,
 999                         reverse32(ctx->cur_samplerate_divider)) != SR_OK)
1000                 return SR_ERR;
1001
1002         /* Send sample limit and pre/post-trigger capture ratio. */
1003         data = ((readcount - 1) & 0xffff) << 16;
1004         data |= (delaycount - 1) & 0xffff;
1005         if (send_longcommand(ctx->serial->fd, CMD_CAPTURE_SIZE, reverse16(data)) != SR_OK)
1006                 return SR_ERR;
1007
1008         /* The flag register wants them here, and 1 means "disable channel". */
1009         ctx->flag_reg |= ~(changrp_mask << 2) & 0x3c;
1010         ctx->flag_reg |= FLAG_FILTER;
1011         ctx->rle_count = 0;
1012         data = (ctx->flag_reg << 24) | ((ctx->flag_reg << 8) & 0xff0000);
1013         if (send_longcommand(ctx->serial->fd, CMD_SET_FLAGS, data) != SR_OK)
1014                 return SR_ERR;
1015
1016         /* Start acquisition on the device. */
1017         if (send_shortcommand(ctx->serial->fd, CMD_RUN) != SR_OK)
1018                 return SR_ERR;
1019
1020         sr_source_add(ctx->serial->fd, G_IO_IN, -1, receive_data,
1021                       cb_data);
1022
1023         if (!(packet = g_try_malloc(sizeof(struct sr_datafeed_packet)))) {
1024                 sr_err("ols: %s: packet malloc failed", __func__);
1025                 return SR_ERR_MALLOC;
1026         }
1027
1028         if (!(header = g_try_malloc(sizeof(struct sr_datafeed_header)))) {
1029                 sr_err("ols: %s: header malloc failed", __func__);
1030                 g_free(packet);
1031                 return SR_ERR_MALLOC;
1032         }
1033
1034         /* Send header packet to the session bus. */
1035         packet->type = SR_DF_HEADER;
1036         packet->payload = (unsigned char *)header;
1037         header->feed_version = 1;
1038         gettimeofday(&header->starttime, NULL);
1039         sr_session_send(cb_data, packet);
1040
1041         /* Send metadata about the SR_DF_LOGIC packets to come. */
1042         packet->type = SR_DF_META_LOGIC;
1043         packet->payload = &meta;
1044         meta.samplerate = ctx->cur_samplerate;
1045         meta.num_probes = NUM_PROBES;
1046         sr_session_send(cb_data, packet);
1047
1048         g_free(header);
1049         g_free(packet);
1050
1051         return SR_OK;
1052 }
1053
1054 /* TODO: This stops acquisition on ALL devices, ignoring dev_index. */
1055 static int hw_dev_acquisition_stop(int dev_index, void *cb_data)
1056 {
1057         struct sr_datafeed_packet packet;
1058
1059         /* Avoid compiler warnings. */
1060         (void)dev_index;
1061
1062         packet.type = SR_DF_END;
1063         sr_session_send(cb_data, &packet);
1064
1065         return SR_OK;
1066 }
1067
1068 SR_PRIV struct sr_dev_driver ols_driver_info = {
1069         .name = "ols",
1070         .longname = "Openbench Logic Sniffer",
1071         .api_version = 1,
1072         .init = hw_init,
1073         .cleanup = hw_cleanup,
1074         .scan = hw_scan,
1075         .dev_open = hw_dev_open,
1076         .dev_close = hw_dev_close,
1077         .info_get = hw_info_get,
1078         .dev_status_get = hw_dev_status_get,
1079         .dev_config_set = hw_dev_config_set,
1080         .dev_acquisition_start = hw_dev_acquisition_start,
1081         .dev_acquisition_stop = hw_dev_acquisition_stop,
1082         .instances = NULL,
1083 };