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