hardware/openbench-logic-sniffer/api.c

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