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