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