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