src/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 <config.h>
  21 #include "protocol.h"
  22
  23 #define SERIALCOMM "115200/8n1"
  24
  25 static const uint32_t scanopts[] = {
  26         SR_CONF_CONN,
  27         SR_CONF_SERIALCOMM,
  28 };
  29
  30 static const uint32_t drvopts[] = {
  31         SR_CONF_LOGIC_ANALYZER,
  32 };
  33
  34 static const uint32_t devopts[] = {
  35         SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
  36         SR_CONF_SAMPLERATE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
  37         SR_CONF_TRIGGER_MATCH | SR_CONF_LIST,
  38         SR_CONF_CAPTURE_RATIO | SR_CONF_GET | SR_CONF_SET,
  39         SR_CONF_EXTERNAL_CLOCK | SR_CONF_SET,
  40         SR_CONF_PATTERN_MODE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
  41         SR_CONF_SWAP | SR_CONF_SET,
  42         SR_CONF_RLE | SR_CONF_GET | SR_CONF_SET,
  43 };
  44
  45 static const int32_t trigger_matches[] = {
  46         SR_TRIGGER_ZERO,
  47         SR_TRIGGER_ONE,
  48 };
  49
  50 #define STR_PATTERN_NONE     "None"
  51 #define STR_PATTERN_EXTERNAL "External"
  52 #define STR_PATTERN_INTERNAL "Internal"
  53
  54 /* Supported methods of test pattern outputs */
  55 enum {
  56         /**
  57          * Capture pins 31:16 (unbuffered wing) output a test pattern
  58          * that can captured on pins 0:15.
  59          */
  60         PATTERN_EXTERNAL,
  61
  62         /** Route test pattern internally to capture buffer. */
  63         PATTERN_INTERNAL,
  64 };
  65
  66 static const char *patterns[] = {
  67         STR_PATTERN_NONE,
  68         STR_PATTERN_EXTERNAL,
  69         STR_PATTERN_INTERNAL,
  70 };
  71
  72 /* Channels are numbered 0-31 (on the PCB silkscreen). */
  73 SR_PRIV const char *ols_channel_names[] = {
  74         "0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12",
  75         "13", "14", "15", "16", "17", "18", "19", "20", "21", "22", "23",
  76         "24", "25", "26", "27", "28", "29", "30", "31",
  77 };
  78
  79 /* Default supported samplerates, can be overridden by device metadata. */
  80 static const uint64_t samplerates[] = {
  81         SR_HZ(10),
  82         SR_MHZ(200),
  83         SR_HZ(1),
  84 };
  85
  86 #define RESPONSE_DELAY_US (10 * 1000)
  87
  88 static GSList *scan(struct sr_dev_driver *di, GSList *options)
  89 {
  90         struct sr_config *src;
  91         struct sr_dev_inst *sdi;
  92         struct sr_serial_dev_inst *serial;
  93         GSList *l;
  94         int ret;
  95         unsigned int i;
  96         const char *conn, *serialcomm;
  97         char buf[8];
  98
  99         conn = serialcomm = NULL;
 100         for (l = options; l; l = l->next) {
 101                 src = l->data;
 102                 switch (src->key) {
 103                 case SR_CONF_CONN:
 104                         conn = g_variant_get_string(src->data, NULL);
 105                         break;
 106                 case SR_CONF_SERIALCOMM:
 107                         serialcomm = g_variant_get_string(src->data, NULL);
 108                         break;
 109                 }
 110         }
 111         if (!conn)
 112                 return NULL;
 113
 114         if (!serialcomm)
 115                 serialcomm = SERIALCOMM;
 116
 117         serial = sr_serial_dev_inst_new(conn, serialcomm);
 118
 119         /* The discovery procedure is like this: first send the Reset
 120          * command (0x00) 5 times, since the device could be anywhere
 121          * in a 5-byte command. Then send the ID command (0x02).
 122          * If the device responds with 4 bytes ("OLS1" or "SLA1"), we
 123          * have a match.
 124          */
 125         sr_info("Probing %s.", conn);
 126         if (serial_open(serial, SERIAL_RDWR) != SR_OK)
 127                 return NULL;
 128
 129         if (ols_send_reset(serial) != SR_OK) {
 130                 serial_close(serial);
 131                 sr_err("Could not use port %s. Quitting.", conn);
 132                 return NULL;
 133         }
 134         send_shortcommand(serial, CMD_ID);
 135
 136         g_usleep(RESPONSE_DELAY_US);
 137
 138         if (sp_input_waiting(serial->data) == 0) {
 139                 sr_dbg("Didn't get any reply.");
 140                 return NULL;
 141         }
 142
 143         ret = serial_read_blocking(serial, buf, 4, serial_timeout(serial, 4));
 144         if (ret != 4) {
 145                 sr_err("Invalid reply (expected 4 bytes, got %d).", ret);
 146                 return NULL;
 147         }
 148
 149         if (strncmp(buf, "1SLO", 4) && strncmp(buf, "1ALS", 4)) {
 150                 sr_err("Invalid reply (expected '1SLO' or '1ALS', got "
 151                        "'%c%c%c%c').", buf[0], buf[1], buf[2], buf[3]);
 152                 return NULL;
 153         }
 154
 155         /* Definitely using the OLS protocol, check if it supports
 156          * the metadata command.
 157          */
 158         send_shortcommand(serial, CMD_METADATA);
 159
 160         g_usleep(RESPONSE_DELAY_US);
 161
 162         if (sp_input_waiting(serial->data) != 0) {
 163                 /* Got metadata. */
 164                 sdi = get_metadata(serial);
 165         } else {
 166                 /* Not an OLS -- some other board that uses the sump protocol. */
 167                 sr_info("Device does not support metadata.");
 168                 sdi = g_malloc0(sizeof(struct sr_dev_inst));
 169                 sdi->status = SR_ST_INACTIVE;
 170                 sdi->vendor = g_strdup("Sump");
 171                 sdi->model = g_strdup("Logic Analyzer");
 172                 sdi->version = g_strdup("v1.0");
 173                 for (i = 0; i < ARRAY_SIZE(ols_channel_names); i++)
 174                         sr_channel_new(sdi, i, SR_CHANNEL_LOGIC, TRUE,
 175                                         ols_channel_names[i]);
 176                 sdi->priv = ols_dev_new();
 177         }
 178         /* Configure samplerate and divider. */
 179         if (ols_set_samplerate(sdi, DEFAULT_SAMPLERATE) != SR_OK)
 180                 sr_dbg("Failed to set default samplerate (%"PRIu64").",
 181                                 DEFAULT_SAMPLERATE);
 182         sdi->inst_type = SR_INST_SERIAL;
 183         sdi->conn = serial;
 184
 185         serial_close(serial);
 186
 187         return std_scan_complete(di, g_slist_append(NULL, sdi));
 188 }
 189
 190 static int config_get(uint32_t key, GVariant **data,
 191         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
 192 {
 193         struct dev_context *devc;
 194
 195         (void)cg;
 196
 197         if (!sdi)
 198                 return SR_ERR_ARG;
 199
 200         devc = sdi->priv;
 201
 202         switch (key) {
 203         case SR_CONF_SAMPLERATE:
 204                 *data = g_variant_new_uint64(devc->cur_samplerate);
 205                 break;
 206         case SR_CONF_CAPTURE_RATIO:
 207                 *data = g_variant_new_uint64(devc->capture_ratio);
 208                 break;
 209         case SR_CONF_LIMIT_SAMPLES:
 210                 *data = g_variant_new_uint64(devc->limit_samples);
 211                 break;
 212         case SR_CONF_PATTERN_MODE:
 213                 if (devc->flag_reg & FLAG_EXTERNAL_TEST_MODE)
 214                         *data = g_variant_new_string(STR_PATTERN_EXTERNAL);
 215                 else if (devc->flag_reg & FLAG_INTERNAL_TEST_MODE)
 216                         *data = g_variant_new_string(STR_PATTERN_INTERNAL);
 217                 else
 218                         *data = g_variant_new_string(STR_PATTERN_NONE);
 219                 break;
 220         case SR_CONF_RLE:
 221                 *data = g_variant_new_boolean(devc->flag_reg & FLAG_RLE ? TRUE : FALSE);
 222                 break;
 223         default:
 224                 return SR_ERR_NA;
 225         }
 226
 227         return SR_OK;
 228 }
 229
 230 static int config_set(uint32_t key, GVariant *data,
 231         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
 232 {
 233         struct dev_context *devc;
 234         uint16_t flag;
 235         uint64_t tmp_u64;
 236         const char *stropt;
 237
 238         (void)cg;
 239
 240         devc = sdi->priv;
 241
 242         switch (key) {
 243         case SR_CONF_SAMPLERATE:
 244                 tmp_u64 = g_variant_get_uint64(data);
 245                 if (tmp_u64 < samplerates[0] || tmp_u64 > samplerates[1])
 246                         return SR_ERR_SAMPLERATE;
 247                 return ols_set_samplerate(sdi, g_variant_get_uint64(data));
 248         case SR_CONF_LIMIT_SAMPLES:
 249                 tmp_u64 = g_variant_get_uint64(data);
 250                 if (tmp_u64 < MIN_NUM_SAMPLES)
 251                         return SR_ERR;
 252                 devc->limit_samples = tmp_u64;
 253                 break;
 254         case SR_CONF_CAPTURE_RATIO:
 255                 devc->capture_ratio = g_variant_get_uint64(data);
 256                 break;
 257         case SR_CONF_EXTERNAL_CLOCK:
 258                 if (g_variant_get_boolean(data)) {
 259                         sr_info("Enabling external clock.");
 260                         devc->flag_reg |= FLAG_CLOCK_EXTERNAL;
 261                 } else {
 262                         sr_info("Disabled external clock.");
 263                         devc->flag_reg &= ~FLAG_CLOCK_EXTERNAL;
 264                 }
 265                 break;
 266         case SR_CONF_PATTERN_MODE:
 267                 stropt = g_variant_get_string(data, NULL);
 268                 flag = 0xffff;
 269                 if (!strcmp(stropt, STR_PATTERN_NONE)) {
 270                         sr_info("Disabling test modes.");
 271                         flag = 0x0000;
 272                 } else if (!strcmp(stropt, STR_PATTERN_INTERNAL)) {
 273                         sr_info("Enabling internal test mode.");
 274                         flag = FLAG_INTERNAL_TEST_MODE;
 275                 } else if (!strcmp(stropt, STR_PATTERN_EXTERNAL)) {
 276                         sr_info("Enabling external test mode.");
 277                         flag = FLAG_EXTERNAL_TEST_MODE;
 278                 } else {
 279                         return SR_ERR;
 280                 }
 281                 if (flag != 0xffff) {
 282                         devc->flag_reg &= ~(FLAG_INTERNAL_TEST_MODE | FLAG_EXTERNAL_TEST_MODE);
 283                         devc->flag_reg |= flag;
 284                 }
 285                 break;
 286         case SR_CONF_SWAP:
 287                 if (g_variant_get_boolean(data)) {
 288                         sr_info("Enabling channel swapping.");
 289                         devc->flag_reg |= FLAG_SWAP_CHANNELS;
 290                 } else {
 291                         sr_info("Disabling channel swapping.");
 292                         devc->flag_reg &= ~FLAG_SWAP_CHANNELS;
 293                 }
 294                 break;
 295         case SR_CONF_RLE:
 296                 if (g_variant_get_boolean(data)) {
 297                         sr_info("Enabling RLE.");
 298                         devc->flag_reg |= FLAG_RLE;
 299                 } else {
 300                         sr_info("Disabling RLE.");
 301                         devc->flag_reg &= ~FLAG_RLE;
 302                 }
 303                 break;
 304         default:
 305                 return SR_ERR_NA;
 306         }
 307
 308         return SR_OK;
 309 }
 310
 311 static int config_list(uint32_t key, GVariant **data,
 312         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
 313 {
 314         struct dev_context *devc;
 315         int num_ols_changrp, i;
 316
 317         switch (key) {
 318         case SR_CONF_SCAN_OPTIONS:
 319         case SR_CONF_DEVICE_OPTIONS:
 320                 return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts);
 321         case SR_CONF_SAMPLERATE:
 322                 *data = std_gvar_samplerates_steps(ARRAY_AND_SIZE(samplerates));
 323                 break;
 324         case SR_CONF_TRIGGER_MATCH:
 325                 *data = std_gvar_array_i32(ARRAY_AND_SIZE(trigger_matches));
 326                 break;
 327         case SR_CONF_PATTERN_MODE:
 328                 *data = g_variant_new_strv(ARRAY_AND_SIZE(patterns));
 329                 break;
 330         case SR_CONF_LIMIT_SAMPLES:
 331                 if (!sdi)
 332                         return SR_ERR_ARG;
 333                 devc = sdi->priv;
 334                 if (devc->flag_reg & FLAG_RLE)
 335                         return SR_ERR_NA;
 336                 if (devc->max_samples == 0)
 337                         /* Device didn't specify sample memory size in metadata. */
 338                         return SR_ERR_NA;
 339                 /*
 340                  * Channel groups are turned off if no channels in that group are
 341                  * enabled, making more room for samples for the enabled group.
 342                 */
 343                 ols_channel_mask(sdi);
 344                 num_ols_changrp = 0;
 345                 for (i = 0; i < 4; i++) {
 346                         if (devc->channel_mask & (0xff << (i * 8)))
 347                                 num_ols_changrp++;
 348                 }
 349
 350                 *data = std_gvar_tuple_u64(MIN_NUM_SAMPLES,
 351                         (num_ols_changrp) ? devc->max_samples / num_ols_changrp : MIN_NUM_SAMPLES);
 352                 break;
 353         default:
 354                 return SR_ERR_NA;
 355         }
 356
 357         return SR_OK;
 358 }
 359
 360 static int set_trigger(const struct sr_dev_inst *sdi, int stage)
 361 {
 362         struct dev_context *devc;
 363         struct sr_serial_dev_inst *serial;
 364         uint8_t cmd, arg[4];
 365
 366         devc = sdi->priv;
 367         serial = sdi->conn;
 368
 369         cmd = CMD_SET_TRIGGER_MASK + stage * 4;
 370         arg[0] = devc->trigger_mask[stage] & 0xff;
 371         arg[1] = (devc->trigger_mask[stage] >> 8) & 0xff;
 372         arg[2] = (devc->trigger_mask[stage] >> 16) & 0xff;
 373         arg[3] = (devc->trigger_mask[stage] >> 24) & 0xff;
 374         if (send_longcommand(serial, cmd, arg) != SR_OK)
 375                 return SR_ERR;
 376
 377         cmd = CMD_SET_TRIGGER_VALUE + stage * 4;
 378         arg[0] = devc->trigger_value[stage] & 0xff;
 379         arg[1] = (devc->trigger_value[stage] >> 8) & 0xff;
 380         arg[2] = (devc->trigger_value[stage] >> 16) & 0xff;
 381         arg[3] = (devc->trigger_value[stage] >> 24) & 0xff;
 382         if (send_longcommand(serial, cmd, arg) != SR_OK)
 383                 return SR_ERR;
 384
 385         cmd = CMD_SET_TRIGGER_CONFIG + stage * 4;
 386         arg[0] = arg[1] = arg[3] = 0x00;
 387         arg[2] = stage;
 388         if (stage == devc->num_stages)
 389                 /* Last stage, fire when this one matches. */
 390                 arg[3] |= TRIGGER_START;
 391         if (send_longcommand(serial, cmd, arg) != SR_OK)
 392                 return SR_ERR;
 393
 394         return SR_OK;
 395 }
 396
 397 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
 398 {
 399         struct dev_context *devc;
 400         struct sr_serial_dev_inst *serial;
 401         uint16_t samplecount, readcount, delaycount;
 402         uint8_t ols_changrp_mask, arg[4];
 403         int num_ols_changrp;
 404         int ret, i;
 405
 406         devc = sdi->priv;
 407         serial = sdi->conn;
 408
 409         ols_channel_mask(sdi);
 410
 411         num_ols_changrp = 0;
 412         ols_changrp_mask = 0;
 413         for (i = 0; i < 4; i++) {
 414                 if (devc->channel_mask & (0xff << (i * 8))) {
 415                         ols_changrp_mask |= (1 << i);
 416                         num_ols_changrp++;
 417                 }
 418         }
 419
 420         /*
 421          * Limit readcount to prevent reading past the end of the hardware
 422          * buffer.
 423          */
 424         samplecount = MIN(devc->max_samples / num_ols_changrp, devc->limit_samples);
 425         readcount = samplecount / 4;
 426
 427         /* Rather read too many samples than too few. */
 428         if (samplecount % 4 != 0)
 429                 readcount++;
 430
 431         /* Basic triggers. */
 432         if (ols_convert_trigger(sdi) != SR_OK) {
 433                 sr_err("Failed to configure channels.");
 434                 return SR_ERR;
 435         }
 436         if (devc->num_stages > 0) {
 437                 /*
 438                  * According to http://mygizmos.org/ols/Logic-Sniffer-FPGA-Spec.pdf
 439                  * reset command must be send prior each arm command
 440                  */
 441                 sr_dbg("Send reset command before trigger configure");
 442                 if (ols_send_reset(serial) != SR_OK)
 443                         return SR_ERR;
 444
 445                 delaycount = readcount * (1 - devc->capture_ratio / 100.0);
 446                 devc->trigger_at = (readcount - delaycount) * 4 - devc->num_stages;
 447                 for (i = 0; i <= devc->num_stages; i++) {
 448                         sr_dbg("Setting OLS stage %d trigger.", i);
 449                         if ((ret = set_trigger(sdi, i)) != SR_OK)
 450                                 return ret;
 451                 }
 452         } else {
 453                 /* No triggers configured, force trigger on first stage. */
 454                 sr_dbg("Forcing trigger at stage 0.");
 455                 if ((ret = set_trigger(sdi, 0)) != SR_OK)
 456                         return ret;
 457                 delaycount = readcount;
 458         }
 459
 460         /* Samplerate. */
 461         sr_dbg("Setting samplerate to %" PRIu64 "Hz (divider %u)",
 462                         devc->cur_samplerate, devc->cur_samplerate_divider);
 463         arg[0] = devc->cur_samplerate_divider & 0xff;
 464         arg[1] = (devc->cur_samplerate_divider & 0xff00) >> 8;
 465         arg[2] = (devc->cur_samplerate_divider & 0xff0000) >> 16;
 466         arg[3] = 0x00;
 467         if (send_longcommand(serial, CMD_SET_DIVIDER, arg) != SR_OK)
 468                 return SR_ERR;
 469
 470         /* Send sample limit and pre/post-trigger capture ratio. */
 471         sr_dbg("Setting sample limit %d, trigger point at %d",
 472                         (readcount - 1) * 4, (delaycount - 1) * 4);
 473         arg[0] = ((readcount - 1) & 0xff);
 474         arg[1] = ((readcount - 1) & 0xff00) >> 8;
 475         arg[2] = ((delaycount - 1) & 0xff);
 476         arg[3] = ((delaycount - 1) & 0xff00) >> 8;
 477         if (send_longcommand(serial, CMD_CAPTURE_SIZE, arg) != SR_OK)
 478                 return SR_ERR;
 479
 480         /* Flag register. */
 481         sr_dbg("Setting intpat %s, extpat %s, RLE %s, noise_filter %s, demux %s",
 482                         devc->flag_reg & FLAG_INTERNAL_TEST_MODE ? "on": "off",
 483                         devc->flag_reg & FLAG_EXTERNAL_TEST_MODE ? "on": "off",
 484                         devc->flag_reg & FLAG_RLE ? "on" : "off",
 485                         devc->flag_reg & FLAG_FILTER ? "on": "off",
 486                         devc->flag_reg & FLAG_DEMUX ? "on" : "off");
 487         /*
 488          * Enable/disable OLS channel groups in the flag register according
 489          * to the channel mask. 1 means "disable channel".
 490          */
 491         devc->flag_reg |= ~(ols_changrp_mask << 2) & 0x3c;
 492         arg[0] = devc->flag_reg & 0xff;
 493         arg[1] = devc->flag_reg >> 8;
 494         arg[2] = arg[3] = 0x00;
 495         if (send_longcommand(serial, CMD_SET_FLAGS, arg) != SR_OK)
 496                 return SR_ERR;
 497
 498         /* Start acquisition on the device. */
 499         if (send_shortcommand(serial, CMD_RUN) != SR_OK)
 500                 return SR_ERR;
 501
 502         /* Reset all operational states. */
 503         devc->rle_count = devc->num_transfers = 0;
 504         devc->num_samples = devc->num_bytes = 0;
 505         devc->cnt_bytes = devc->cnt_samples = devc->cnt_samples_rle = 0;
 506         memset(devc->sample, 0, 4);
 507
 508         std_session_send_df_header(sdi);
 509
 510         /* If the device stops sending for longer than it takes to send a byte,
 511          * that means it's finished. But wait at least 100 ms to be safe.
 512          */
 513         serial_source_add(sdi->session, serial, G_IO_IN, 100,
 514                         ols_receive_data, (struct sr_dev_inst *)sdi);
 515
 516         return SR_OK;
 517 }
 518
 519 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
 520 {
 521         abort_acquisition(sdi);
 522
 523         return SR_OK;
 524 }
 525
 526 static struct sr_dev_driver ols_driver_info = {
 527         .name = "ols",
 528         .longname = "Openbench Logic Sniffer",
 529         .api_version = 1,
 530         .init = std_init,
 531         .cleanup = std_cleanup,
 532         .scan = scan,
 533         .dev_list = std_dev_list,
 534         .dev_clear = std_dev_clear,
 535         .config_get = config_get,
 536         .config_set = config_set,
 537         .config_list = config_list,
 538         .dev_open = std_serial_dev_open,
 539         .dev_close = std_serial_dev_close,
 540         .dev_acquisition_start = dev_acquisition_start,
 541         .dev_acquisition_stop = dev_acquisition_stop,
 542         .context = NULL,
 543 };
 544 SR_REGISTER_DEV_DRIVER(ols_driver_info);