hardware/openbench-logic-sniffer/api.c

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2013 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 "protocol.h"
  21 #include <libserialport.h>
  22
  23 #define SERIALCOMM "115200/8n1"
  24
  25 static const int32_t hwopts[] = {
  26         SR_CONF_CONN,
  27         SR_CONF_SERIALCOMM,
  28 };
  29
  30 static const int32_t hwcaps[] = {
  31         SR_CONF_LOGIC_ANALYZER,
  32         SR_CONF_SAMPLERATE,
  33         SR_CONF_TRIGGER_TYPE,
  34         SR_CONF_CAPTURE_RATIO,
  35         SR_CONF_LIMIT_SAMPLES,
  36         SR_CONF_EXTERNAL_CLOCK,
  37         SR_CONF_PATTERN_MODE,
  38         SR_CONF_SWAP,
  39         SR_CONF_RLE,
  40 };
  41
  42 #define STR_PATTERN_NONE     "None"
  43 #define STR_PATTERN_EXTERNAL "External"
  44 #define STR_PATTERN_INTERNAL "Internal"
  45
  46 /* Supported methods of test pattern outputs */
  47 enum {
  48         /**
  49          * Capture pins 31:16 (unbuffered wing) output a test pattern
  50          * that can captured on pins 0:15.
  51          */
  52         PATTERN_EXTERNAL,
  53
  54         /** Route test pattern internally to capture buffer. */
  55         PATTERN_INTERNAL,
  56 };
  57
  58 static const char *patterns[] = {
  59         STR_PATTERN_NONE,
  60         STR_PATTERN_EXTERNAL,
  61         STR_PATTERN_INTERNAL,
  62 };
  63
  64 /* Probes are numbered 0-31 (on the PCB silkscreen). */
  65 SR_PRIV const char *ols_probe_names[NUM_PROBES + 1] = {
  66         "0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12",
  67         "13", "14", "15", "16", "17", "18", "19", "20", "21", "22", "23",
  68         "24", "25", "26", "27", "28", "29", "30", "31",
  69         NULL,
  70 };
  71
  72 /* Default supported samplerates, can be overridden by device metadata. */
  73 static const uint64_t samplerates[] = {
  74         SR_HZ(10),
  75         SR_MHZ(200),
  76         SR_HZ(1),
  77 };
  78
  79 SR_PRIV struct sr_dev_driver ols_driver_info;
  80 static struct sr_dev_driver *di = &ols_driver_info;
  81
  82 static int dev_clear(void)
  83 {
  84         return std_dev_clear(di, NULL);
  85 }
  86
  87 static int init(struct sr_context *sr_ctx)
  88 {
  89         return std_init(sr_ctx, di, LOG_PREFIX);
  90 }
  91
  92 static GSList *scan(GSList *options)
  93 {
  94         struct sr_config *src;
  95         struct sr_dev_inst *sdi;
  96         struct drv_context *drvc;
  97         struct dev_context *devc;
  98         struct sr_probe *probe;
  99         struct sr_serial_dev_inst *serial;
 100         GPollFD probefd;
 101         GSList *l, *devices;
 102         int ret, i;
 103         const char *conn, *serialcomm;
 104         char buf[8];
 105
 106         drvc = di->priv;
 107
 108         devices = NULL;
 109
 110         conn = serialcomm = NULL;
 111         for (l = options; l; l = l->next) {
 112                 src = l->data;
 113                 switch (src->key) {
 114                 case SR_CONF_CONN:
 115                         conn = g_variant_get_string(src->data, NULL);
 116                         break;
 117                 case SR_CONF_SERIALCOMM:
 118                         serialcomm = g_variant_get_string(src->data, NULL);
 119                         break;
 120                 }
 121         }
 122         if (!conn)
 123                 return NULL;
 124
 125         if (serialcomm == NULL)
 126                 serialcomm = SERIALCOMM;
 127
 128         if (!(serial = sr_serial_dev_inst_new(conn, serialcomm)))
 129                 return NULL;
 130
 131         /* The discovery procedure is like this: first send the Reset
 132          * command (0x00) 5 times, since the device could be anywhere
 133          * in a 5-byte command. Then send the ID command (0x02).
 134          * If the device responds with 4 bytes ("OLS1" or "SLA1"), we
 135          * have a match.
 136          */
 137         sr_info("Probing %s.", conn);
 138         if (serial_open(serial, SERIAL_RDWR | SERIAL_NONBLOCK) != SR_OK)
 139                 return NULL;
 140
 141         ret = SR_OK;
 142         for (i = 0; i < 5; i++) {
 143                 if ((ret = send_shortcommand(serial, CMD_RESET)) != SR_OK) {
 144                         sr_err("Port %s is not writable.", conn);
 145                         break;
 146                 }
 147         }
 148         if (ret != SR_OK) {
 149                 serial_close(serial);
 150                 sr_err("Could not use port %s. Quitting.", conn);
 151                 return NULL;
 152         }
 153         send_shortcommand(serial, CMD_ID);
 154
 155         /* Wait 10ms for a response. */
 156         g_usleep(10000);
 157
 158         sp_get_port_handle(serial->data, &probefd.fd);
 159         probefd.events = G_IO_IN;
 160         g_poll(&probefd, 1, 1);
 161
 162         if (probefd.revents != G_IO_IN)
 163                 return NULL;
 164         if (serial_read_blocking(serial, buf, 4) != 4)
 165                 return NULL;
 166         if (strncmp(buf, "1SLO", 4) && strncmp(buf, "1ALS", 4))
 167                 return NULL;
 168
 169         /* Definitely using the OLS protocol, check if it supports
 170          * the metadata command.
 171          */
 172         send_shortcommand(serial, CMD_METADATA);
 173         if (g_poll(&probefd, 1, 10) > 0) {
 174                 /* Got metadata. */
 175                 sdi = get_metadata(serial);
 176                 sdi->index = 0;
 177                 devc = sdi->priv;
 178         } else {
 179                 /* Not an OLS -- some other board that uses the sump protocol. */
 180                 sr_info("Device does not support metadata.");
 181                 sdi = sr_dev_inst_new(0, SR_ST_INACTIVE,
 182                                 "Sump", "Logic Analyzer", "v1.0");
 183                 sdi->driver = di;
 184                 for (i = 0; i < 32; i++) {
 185                         if (!(probe = sr_probe_new(i, SR_PROBE_LOGIC, TRUE,
 186                                         ols_probe_names[i])))
 187                                 return 0;
 188                         sdi->probes = g_slist_append(sdi->probes, probe);
 189                 }
 190                 devc = ols_dev_new();
 191                 sdi->priv = devc;
 192         }
 193         /* Configure samplerate and divider. */
 194         if (ols_set_samplerate(sdi, DEFAULT_SAMPLERATE) != SR_OK)
 195                 sr_dbg("Failed to set default samplerate (%"PRIu64").",
 196                                 DEFAULT_SAMPLERATE);
 197         /* Clear trigger masks, values and stages. */
 198         ols_configure_probes(sdi);
 199         sdi->inst_type = SR_INST_SERIAL;
 200         sdi->conn = serial;
 201
 202         drvc->instances = g_slist_append(drvc->instances, sdi);
 203         devices = g_slist_append(devices, sdi);
 204
 205         serial_close(serial);
 206
 207         return devices;
 208 }
 209
 210 static GSList *dev_list(void)
 211 {
 212         return ((struct drv_context *)(di->priv))->instances;
 213 }
 214
 215 static int cleanup(void)
 216 {
 217         return dev_clear();
 218 }
 219
 220 static int config_get(int id, GVariant **data, const struct sr_dev_inst *sdi,
 221                 const struct sr_probe_group *probe_group)
 222 {
 223         struct dev_context *devc;
 224
 225         (void)probe_group;
 226
 227         if (!sdi)
 228                 return SR_ERR_ARG;
 229
 230         devc = sdi->priv;
 231         switch (id) {
 232         case SR_CONF_SAMPLERATE:
 233                 *data = g_variant_new_uint64(devc->cur_samplerate);
 234                 break;
 235         case SR_CONF_CAPTURE_RATIO:
 236                 *data = g_variant_new_uint64(devc->capture_ratio);
 237                 break;
 238         case SR_CONF_LIMIT_SAMPLES:
 239                 *data = g_variant_new_uint64(devc->limit_samples);
 240                 break;
 241         case SR_CONF_PATTERN_MODE:
 242                 if (devc->flag_reg & FLAG_EXTERNAL_TEST_MODE)
 243                         *data = g_variant_new_string(STR_PATTERN_EXTERNAL);
 244                 else if (devc->flag_reg & FLAG_INTERNAL_TEST_MODE)
 245                         *data = g_variant_new_string(STR_PATTERN_INTERNAL);
 246                 else
 247                         *data = g_variant_new_string(STR_PATTERN_NONE);
 248                 break;
 249         case SR_CONF_RLE:
 250                 *data = g_variant_new_boolean(devc->flag_reg & FLAG_RLE ? TRUE : FALSE);
 251                 break;
 252         default:
 253                 return SR_ERR_NA;
 254         }
 255
 256         return SR_OK;
 257 }
 258
 259 static int config_set(int id, GVariant *data, const struct sr_dev_inst *sdi,
 260                 const struct sr_probe_group *probe_group)
 261 {
 262         struct dev_context *devc;
 263         uint16_t flag;
 264         uint64_t tmp_u64;
 265         int ret;
 266         const char *stropt;
 267
 268         (void)probe_group;
 269
 270         if (sdi->status != SR_ST_ACTIVE)
 271                 return SR_ERR_DEV_CLOSED;
 272
 273         devc = sdi->priv;
 274
 275         switch (id) {
 276         case SR_CONF_SAMPLERATE:
 277                 tmp_u64 = g_variant_get_uint64(data);
 278                 if (tmp_u64 < samplerates[0] || tmp_u64 > samplerates[1])
 279                         return SR_ERR_SAMPLERATE;
 280                 ret = ols_set_samplerate(sdi, g_variant_get_uint64(data));
 281                 break;
 282         case SR_CONF_LIMIT_SAMPLES:
 283                 tmp_u64 = g_variant_get_uint64(data);
 284                 if (tmp_u64 < MIN_NUM_SAMPLES)
 285                         return SR_ERR;
 286                 devc->limit_samples = tmp_u64;
 287                 ret = SR_OK;
 288                 break;
 289         case SR_CONF_CAPTURE_RATIO:
 290                 devc->capture_ratio = g_variant_get_uint64(data);
 291                 if (devc->capture_ratio < 0 || devc->capture_ratio > 100) {
 292                         devc->capture_ratio = 0;
 293                         ret = SR_ERR;
 294                 } else
 295                         ret = SR_OK;
 296                 break;
 297         case SR_CONF_EXTERNAL_CLOCK:
 298                 if (g_variant_get_boolean(data)) {
 299                         sr_info("Enabling external clock.");
 300                         devc->flag_reg |= FLAG_CLOCK_EXTERNAL;
 301                 } else {
 302                         sr_info("Disabled external clock.");
 303                         devc->flag_reg &= ~FLAG_CLOCK_EXTERNAL;
 304                 }
 305                 ret = SR_OK;
 306                 break;
 307         case SR_CONF_PATTERN_MODE:
 308                 stropt = g_variant_get_string(data, NULL);
 309                 ret = SR_OK;
 310                 flag = 0xffff;
 311                 if (!strcmp(stropt, STR_PATTERN_NONE)) {
 312                         sr_info("Disabling test modes.");
 313                         flag = 0x0000;
 314                 }else if (!strcmp(stropt, STR_PATTERN_INTERNAL)) {
 315                         sr_info("Enabling internal test mode.");
 316                         flag = FLAG_INTERNAL_TEST_MODE;
 317                 } else if (!strcmp(stropt, STR_PATTERN_EXTERNAL)) {
 318                         sr_info("Enabling external test mode.");
 319                         flag = FLAG_EXTERNAL_TEST_MODE;
 320                 } else {
 321                         ret = SR_ERR;
 322                 }
 323                 if (flag != 0xffff) {
 324                         devc->flag_reg &= ~(FLAG_INTERNAL_TEST_MODE | FLAG_EXTERNAL_TEST_MODE);
 325                         devc->flag_reg |= flag;
 326                 }
 327                 break;
 328         case SR_CONF_SWAP:
 329                 if (g_variant_get_boolean(data)) {
 330                         sr_info("Enabling channel swapping.");
 331                         devc->flag_reg |= FLAG_SWAP_PROBES;
 332                 } else {
 333                         sr_info("Disabling channel swapping.");
 334                         devc->flag_reg &= ~FLAG_SWAP_PROBES;
 335                 }
 336                 ret = SR_OK;
 337                 break;
 338
 339         case SR_CONF_RLE:
 340                 if (g_variant_get_boolean(data)) {
 341                         sr_info("Enabling RLE.");
 342                         devc->flag_reg |= FLAG_RLE;
 343                 } else {
 344                         sr_info("Disabling RLE.");
 345                         devc->flag_reg &= ~FLAG_RLE;
 346                 }
 347                 ret = SR_OK;
 348                 break;
 349         default:
 350                 ret = SR_ERR_NA;
 351         }
 352
 353         return ret;
 354 }
 355
 356 static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi,
 357                 const struct sr_probe_group *probe_group)
 358 {
 359         struct dev_context *devc;
 360         GVariant *gvar, *grange[2];
 361         GVariantBuilder gvb;
 362         int num_channels, i;
 363
 364         (void)probe_group;
 365
 366         switch (key) {
 367         case SR_CONF_SCAN_OPTIONS:
 368                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
 369                                 hwopts, ARRAY_SIZE(hwopts), sizeof(int32_t));
 370                 break;
 371         case SR_CONF_DEVICE_OPTIONS:
 372                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
 373                                 hwcaps, ARRAY_SIZE(hwcaps), sizeof(int32_t));
 374                 break;
 375         case SR_CONF_SAMPLERATE:
 376                 g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
 377                 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"), samplerates,
 378                                 ARRAY_SIZE(samplerates), sizeof(uint64_t));
 379                 g_variant_builder_add(&gvb, "{sv}", "samplerate-steps", gvar);
 380                 *data = g_variant_builder_end(&gvb);
 381                 break;
 382         case SR_CONF_TRIGGER_TYPE:
 383                 *data = g_variant_new_string(TRIGGER_TYPE);
 384                 break;
 385         case SR_CONF_PATTERN_MODE:
 386                 *data = g_variant_new_strv(patterns, ARRAY_SIZE(patterns));
 387                 break;
 388         case SR_CONF_LIMIT_SAMPLES:
 389                 if (!sdi)
 390                         return SR_ERR_ARG;
 391                 devc = sdi->priv;
 392                 if (devc->flag_reg & FLAG_RLE)
 393                         return SR_ERR_NA;
 394                 if (devc->max_samples == 0)
 395                         /* Device didn't specify sample memory size in metadata. */
 396                         return SR_ERR_NA;
 397                 /*
 398                  * Channel groups are turned off if no probes in that group are
 399                  * enabled, making more room for samples for the enabled group.
 400                 */
 401                 ols_configure_probes(sdi);
 402                 num_channels = 0;
 403                 for (i = 0; i < 4; i++) {
 404                         if (devc->probe_mask & (0xff << (i * 8)))
 405                                 num_channels++;
 406                 }
 407                 grange[0] = g_variant_new_uint64(MIN_NUM_SAMPLES);
 408                 grange[1] = g_variant_new_uint64(devc->max_samples / num_channels);
 409                 *data = g_variant_new_tuple(grange, 2);
 410                 break;
 411         default:
 412                 return SR_ERR_NA;
 413         }
 414
 415         return SR_OK;
 416 }
 417
 418 static int dev_acquisition_start(const struct sr_dev_inst *sdi,
 419                 void *cb_data)
 420 {
 421         struct dev_context *devc;
 422         struct sr_serial_dev_inst *serial;
 423         uint32_t trigger_config[4];
 424         uint32_t data;
 425         uint16_t samplecount, readcount, delaycount;
 426         uint8_t changrp_mask;
 427         int num_channels;
 428         int i;
 429
 430         if (sdi->status != SR_ST_ACTIVE)
 431                 return SR_ERR_DEV_CLOSED;
 432
 433         devc = sdi->priv;
 434         serial = sdi->conn;
 435
 436         if (ols_configure_probes(sdi) != SR_OK) {
 437                 sr_err("Failed to configure probes.");
 438                 return SR_ERR;
 439         }
 440
 441         /*
 442          * Enable/disable channel groups in the flag register according to the
 443          * probe mask. Calculate this here, because num_channels is needed
 444          * to limit readcount.
 445          */
 446         changrp_mask = 0;
 447         num_channels = 0;
 448         for (i = 0; i < 4; i++) {
 449                 if (devc->probe_mask & (0xff << (i * 8))) {
 450                         changrp_mask |= (1 << i);
 451                         num_channels++;
 452                 }
 453         }
 454
 455         /*
 456          * Limit readcount to prevent reading past the end of the hardware
 457          * buffer.
 458          */
 459         samplecount = MIN(devc->max_samples / num_channels, devc->limit_samples);
 460         readcount = samplecount / 4;
 461         if (samplecount % 4)
 462                 readcount++;
 463
 464         memset(trigger_config, 0, 16);
 465         trigger_config[devc->num_stages] |= 0x08;
 466         if (devc->trigger_mask[0]) {
 467                 delaycount = readcount * (1 - devc->capture_ratio / 100.0);
 468                 devc->trigger_at = (readcount - delaycount) * 4 - devc->num_stages;
 469
 470                 if (send_longcommand(serial, CMD_SET_TRIGGER_MASK_0,
 471                         reverse32(devc->trigger_mask[0])) != SR_OK)
 472                         return SR_ERR;
 473                 if (send_longcommand(serial, CMD_SET_TRIGGER_VALUE_0,
 474                         reverse32(devc->trigger_value[0])) != SR_OK)
 475                         return SR_ERR;
 476                 if (send_longcommand(serial, CMD_SET_TRIGGER_CONFIG_0,
 477                         trigger_config[0]) != SR_OK)
 478                         return SR_ERR;
 479
 480                 if (send_longcommand(serial, CMD_SET_TRIGGER_MASK_1,
 481                         reverse32(devc->trigger_mask[1])) != SR_OK)
 482                         return SR_ERR;
 483                 if (send_longcommand(serial, CMD_SET_TRIGGER_VALUE_1,
 484                         reverse32(devc->trigger_value[1])) != SR_OK)
 485                         return SR_ERR;
 486                 if (send_longcommand(serial, CMD_SET_TRIGGER_CONFIG_1,
 487                         trigger_config[1]) != SR_OK)
 488                         return SR_ERR;
 489
 490                 if (send_longcommand(serial, CMD_SET_TRIGGER_MASK_2,
 491                         reverse32(devc->trigger_mask[2])) != SR_OK)
 492                         return SR_ERR;
 493                 if (send_longcommand(serial, CMD_SET_TRIGGER_VALUE_2,
 494                         reverse32(devc->trigger_value[2])) != SR_OK)
 495                         return SR_ERR;
 496                 if (send_longcommand(serial, CMD_SET_TRIGGER_CONFIG_2,
 497                         trigger_config[2]) != SR_OK)
 498                         return SR_ERR;
 499
 500                 if (send_longcommand(serial, CMD_SET_TRIGGER_MASK_3,
 501                         reverse32(devc->trigger_mask[3])) != SR_OK)
 502                         return SR_ERR;
 503                 if (send_longcommand(serial, CMD_SET_TRIGGER_VALUE_3,
 504                         reverse32(devc->trigger_value[3])) != SR_OK)
 505                         return SR_ERR;
 506                 if (send_longcommand(serial, CMD_SET_TRIGGER_CONFIG_3,
 507                         trigger_config[3]) != SR_OK)
 508                         return SR_ERR;
 509         } else {
 510                 if (send_longcommand(serial, CMD_SET_TRIGGER_MASK_0,
 511                                 devc->trigger_mask[0]) != SR_OK)
 512                         return SR_ERR;
 513                 if (send_longcommand(serial, CMD_SET_TRIGGER_VALUE_0,
 514                                 devc->trigger_value[0]) != SR_OK)
 515                         return SR_ERR;
 516                 if (send_longcommand(serial, CMD_SET_TRIGGER_CONFIG_0,
 517                      0x00000008) != SR_OK)
 518                         return SR_ERR;
 519                 delaycount = readcount;
 520         }
 521
 522         /* Samplerate. */
 523         sr_info("Setting samplerate to %" PRIu64 "Hz (divider %u)",
 524                         devc->cur_samplerate, devc->cur_samplerate_divider);
 525         if (send_longcommand(serial, CMD_SET_DIVIDER,
 526                         reverse32(devc->cur_samplerate_divider)) != SR_OK)
 527                 return SR_ERR;
 528
 529         /* Send sample limit and pre/post-trigger capture ratio. */
 530         sr_info("Setting sample limit %d, trigger point at %d",
 531                         (readcount - 1) * 4, (delaycount - 1) * 4);
 532         data = ((readcount - 1) & 0xffff) << 16;
 533         data |= (delaycount - 1) & 0xffff;
 534         if (send_longcommand(serial, CMD_CAPTURE_SIZE, reverse16(data)) != SR_OK)
 535                 return SR_ERR;
 536
 537         /* Flag register. */
 538         sr_info("Setting demux %s, noise_filter %s, extpat %s, intpat %s",
 539                         devc->flag_reg & FLAG_DEMUX ? "on" : "off",
 540                         devc->flag_reg & FLAG_FILTER ? "on": "off",
 541                         devc->flag_reg & FLAG_EXTERNAL_TEST_MODE ? "on": "off",
 542                         devc->flag_reg & FLAG_INTERNAL_TEST_MODE ? "on": "off");
 543         /* 1 means "disable channel". */
 544         devc->flag_reg |= ~(changrp_mask << 2) & 0x3c;
 545         data = (devc->flag_reg << 24) | ((devc->flag_reg << 8) & 0xff0000);
 546         if (send_longcommand(serial, CMD_SET_FLAGS, data) != SR_OK)
 547                 return SR_ERR;
 548
 549         /* Start acquisition on the device. */
 550         if (send_shortcommand(serial, CMD_RUN) != SR_OK)
 551                 return SR_ERR;
 552
 553         /* Reset all operational states. */
 554         devc->rle_count = devc->num_transfers = 0;
 555         devc->num_samples = devc->num_bytes = 0;
 556         memset(devc->sample, 0, 4);
 557
 558         /* Send header packet to the session bus. */
 559         std_session_send_df_header(cb_data, LOG_PREFIX);
 560
 561         serial_source_add(serial, G_IO_IN, -1, ols_receive_data, cb_data);
 562
 563         return SR_OK;
 564 }
 565
 566 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
 567 {
 568         (void)cb_data;
 569
 570         abort_acquisition(sdi);
 571
 572         return SR_OK;
 573 }
 574
 575 SR_PRIV struct sr_dev_driver ols_driver_info = {
 576         .name = "ols",
 577         .longname = "Openbench Logic Sniffer",
 578         .api_version = 1,
 579         .init = init,
 580         .cleanup = cleanup,
 581         .scan = scan,
 582         .dev_list = dev_list,
 583         .dev_clear = dev_clear,
 584         .config_get = config_get,
 585         .config_set = config_set,
 586         .config_list = config_list,
 587         .dev_open = std_serial_dev_open,
 588         .dev_close = std_serial_dev_close,
 589         .dev_acquisition_start = dev_acquisition_start,
 590         .dev_acquisition_stop = dev_acquisition_stop,
 591         .priv = NULL,
 592 };