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