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