hardware/chronovu-la8/api.c

   1 /*
   2  * This file is part of the sigrok project.
   3  *
   4  * Copyright (C) 2011-2012 Uwe Hermann <uwe@hermann-uwe.de>
   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 2 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, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  19  */
  20
  21 #include <ftdi.h>
  22 #include <glib.h>
  23 #include <string.h>
  24 #include "libsigrok.h"
  25 #include "libsigrok-internal.h"
  26 #include "protocol.h"
  27
  28 SR_PRIV struct sr_dev_driver chronovu_la8_driver_info;
  29 static struct sr_dev_driver *di = &chronovu_la8_driver_info;
  30
  31 /*
  32  * The ChronoVu LA8 can have multiple PIDs. Older versions shipped with
  33  * a standard FTDI USB VID/PID of 0403:6001, newer ones have 0403:8867.
  34  */
  35 static const uint16_t usb_pids[] = {
  36         0x6001,
  37         0x8867,
  38 };
  39
  40 /* Function prototypes. */
  41 static int hw_dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data);
  42
  43 static int clear_instances(void)
  44 {
  45         GSList *l;
  46         struct sr_dev_inst *sdi;
  47         struct drv_context *drvc;
  48         struct dev_context *devc;
  49
  50         drvc = di->priv;
  51
  52         /* Properly close all devices. */
  53         for (l = drvc->instances; l; l = l->next) {
  54                 if (!(sdi = l->data)) {
  55                         /* Log error, but continue cleaning up the rest. */
  56                         sr_err("%s: sdi was NULL, continuing.", __func__);
  57                         continue;
  58                 }
  59                 if (sdi->priv) {
  60                         devc = sdi->priv;
  61                         ftdi_free(devc->ftdic);
  62                 }
  63                 sr_dev_inst_free(sdi);
  64         }
  65         g_slist_free(drvc->instances);
  66         drvc->instances = NULL;
  67
  68         return SR_OK;
  69 }
  70
  71 static int hw_init(struct sr_context *sr_ctx)
  72 {
  73         struct drv_context *drvc;
  74
  75         if (!(drvc = g_try_malloc0(sizeof(struct drv_context)))) {
  76                 sr_err("Driver context malloc failed.");
  77                 return SR_ERR_MALLOC;
  78         }
  79
  80         drvc->sr_ctx = sr_ctx;
  81         di->priv = drvc;
  82
  83         return SR_OK;
  84 }
  85
  86 static GSList *hw_scan(GSList *options)
  87 {
  88         struct sr_dev_inst *sdi;
  89         struct sr_probe *probe;
  90         struct drv_context *drvc;
  91         struct dev_context *devc;
  92         GSList *devices;
  93         unsigned int i;
  94         int ret;
  95
  96         (void)options;
  97
  98         drvc = di->priv;
  99
 100         devices = NULL;
 101
 102         /* Allocate memory for our private device context. */
 103         if (!(devc = g_try_malloc(sizeof(struct dev_context)))) {
 104                 sr_err("Device context malloc failed.");
 105                 goto err_free_nothing;
 106         }
 107
 108         /* Set some sane defaults. */
 109         devc->ftdic = NULL;
 110         devc->cur_samplerate = SR_MHZ(100); /* 100MHz == max. samplerate */
 111         devc->limit_msec = 0;
 112         devc->limit_samples = 0;
 113         devc->session_dev_id = NULL;
 114         memset(devc->mangled_buf, 0, BS);
 115         devc->final_buf = NULL;
 116         devc->trigger_pattern = 0x00; /* Value irrelevant, see trigger_mask. */
 117         devc->trigger_mask = 0x00; /* All probes are "don't care". */
 118         devc->trigger_timeout = 10; /* Default to 10s trigger timeout. */
 119         devc->trigger_found = 0;
 120         devc->done = 0;
 121         devc->block_counter = 0;
 122         devc->divcount = 0; /* 10ns sample period == 100MHz samplerate */
 123         devc->usb_pid = 0;
 124
 125         /* Allocate memory where we'll store the de-mangled data. */
 126         if (!(devc->final_buf = g_try_malloc(SDRAM_SIZE))) {
 127                 sr_err("final_buf malloc failed.");
 128                 goto err_free_devc;
 129         }
 130
 131         /* Allocate memory for the FTDI context (ftdic) and initialize it. */
 132         if (!(devc->ftdic = ftdi_new())) {
 133                 sr_err("%s: ftdi_new failed.", __func__);
 134                 goto err_free_final_buf;
 135         }
 136
 137         /* Check for the device and temporarily open it. */
 138         for (i = 0; i < ARRAY_SIZE(usb_pids); i++) {
 139                 sr_dbg("Probing for VID/PID %04x:%04x.", USB_VENDOR_ID,
 140                        usb_pids[i]);
 141                 ret = ftdi_usb_open_desc(devc->ftdic, USB_VENDOR_ID,
 142                                          usb_pids[i], USB_DESCRIPTION, NULL);
 143                 if (ret == 0) {
 144                         sr_dbg("Found LA8 device (%04x:%04x).",
 145                                USB_VENDOR_ID, usb_pids[i]);
 146                         devc->usb_pid = usb_pids[i];
 147                 }
 148         }
 149
 150         if (devc->usb_pid == 0)
 151                 goto err_free_ftdic;
 152
 153         /* Register the device with libsigrok. */
 154         sdi = sr_dev_inst_new(0, SR_ST_INITIALIZING,
 155                         USB_VENDOR_NAME, USB_MODEL_NAME, USB_MODEL_VERSION);
 156         if (!sdi) {
 157                 sr_err("%s: sr_dev_inst_new failed.", __func__);
 158                 goto err_close_ftdic;
 159         }
 160         sdi->driver = di;
 161         sdi->priv = devc;
 162
 163         for (i = 0; probe_names[i]; i++) {
 164                 if (!(probe = sr_probe_new(i, SR_PROBE_LOGIC, TRUE,
 165                                            probe_names[i])))
 166                         return NULL;
 167                 sdi->probes = g_slist_append(sdi->probes, probe);
 168         }
 169
 170         devices = g_slist_append(devices, sdi);
 171         drvc->instances = g_slist_append(drvc->instances, sdi);
 172
 173         /* Close device. We'll reopen it again when we need it. */
 174         (void) la8_close(devc); /* Log, but ignore errors. */
 175
 176         return devices;
 177
 178 err_close_ftdic:
 179         (void) la8_close(devc); /* Log, but ignore errors. */
 180 err_free_ftdic:
 181         ftdi_free(devc->ftdic); /* NOT free() or g_free()! */
 182 err_free_final_buf:
 183         g_free(devc->final_buf);
 184 err_free_devc:
 185         g_free(devc);
 186 err_free_nothing:
 187
 188         return NULL;
 189 }
 190
 191 static GSList *hw_dev_list(void)
 192 {
 193         struct drv_context *drvc;
 194
 195         drvc = di->priv;
 196
 197         return drvc->instances;
 198 }
 199
 200 static int hw_dev_open(struct sr_dev_inst *sdi)
 201 {
 202         struct dev_context *devc;
 203         int ret;
 204
 205         if (!(devc = sdi->priv)) {
 206                 sr_err("%s: sdi->priv was NULL.", __func__);
 207                 return SR_ERR_BUG;
 208         }
 209
 210         sr_dbg("Opening LA8 device (%04x:%04x).", USB_VENDOR_ID,
 211                devc->usb_pid);
 212
 213         /* Open the device. */
 214         if ((ret = ftdi_usb_open_desc(devc->ftdic, USB_VENDOR_ID,
 215                         devc->usb_pid, USB_DESCRIPTION, NULL)) < 0) {
 216                 sr_err("%s: ftdi_usb_open_desc: (%d) %s",
 217                        __func__, ret, ftdi_get_error_string(devc->ftdic));
 218                 (void) la8_close_usb_reset_sequencer(devc); /* Ignore errors. */
 219                 return SR_ERR;
 220         }
 221         sr_dbg("Device opened successfully.");
 222
 223         /* Purge RX/TX buffers in the FTDI chip. */
 224         if ((ret = ftdi_usb_purge_buffers(devc->ftdic)) < 0) {
 225                 sr_err("%s: ftdi_usb_purge_buffers: (%d) %s",
 226                        __func__, ret, ftdi_get_error_string(devc->ftdic));
 227                 (void) la8_close_usb_reset_sequencer(devc); /* Ignore errors. */
 228                 goto err_dev_open_close_ftdic;
 229         }
 230         sr_dbg("FTDI buffers purged successfully.");
 231
 232         /* Enable flow control in the FTDI chip. */
 233         if ((ret = ftdi_setflowctrl(devc->ftdic, SIO_RTS_CTS_HS)) < 0) {
 234                 sr_err("%s: ftdi_setflowcontrol: (%d) %s",
 235                        __func__, ret, ftdi_get_error_string(devc->ftdic));
 236                 (void) la8_close_usb_reset_sequencer(devc); /* Ignore errors. */
 237                 goto err_dev_open_close_ftdic;
 238         }
 239         sr_dbg("FTDI flow control enabled successfully.");
 240
 241         /* Wait 100ms. */
 242         g_usleep(100 * 1000);
 243
 244         sdi->status = SR_ST_ACTIVE;
 245
 246         return SR_OK;
 247
 248 err_dev_open_close_ftdic:
 249         (void) la8_close(devc); /* Log, but ignore errors. */
 250         return SR_ERR;
 251 }
 252
 253 static int hw_dev_close(struct sr_dev_inst *sdi)
 254 {
 255         struct dev_context *devc;
 256
 257         if (!(devc = sdi->priv)) {
 258                 sr_err("%s: sdi->priv was NULL.", __func__);
 259                 return SR_ERR_BUG;
 260         }
 261
 262         sr_dbg("Closing device.");
 263
 264         if (sdi->status == SR_ST_ACTIVE) {
 265                 sr_dbg("Status ACTIVE, closing device.");
 266                 (void) la8_close_usb_reset_sequencer(devc); /* Ignore errors. */
 267         } else {
 268                 sr_spew("Status not ACTIVE, nothing to do.");
 269         }
 270
 271         sdi->status = SR_ST_INACTIVE;
 272
 273         sr_dbg("Freeing sample buffer.");
 274         g_free(devc->final_buf);
 275
 276         return SR_OK;
 277 }
 278
 279 static int hw_cleanup(void)
 280 {
 281         if (!di->priv)
 282                 /* Can get called on an unused driver, doesn't matter. */
 283                 return SR_OK;
 284
 285         clear_instances();
 286
 287         return SR_OK;
 288 }
 289
 290 static int config_get(int id, const void **data, const struct sr_dev_inst *sdi)
 291 {
 292         struct dev_context *devc;
 293
 294         switch (id) {
 295         case SR_CONF_SAMPLERATE:
 296                 if (sdi) {
 297                         devc = sdi->priv;
 298                         *data = &devc->cur_samplerate;
 299                         sr_spew("%s: Returning samplerate: %" PRIu64 "Hz.",
 300                                 __func__, devc->cur_samplerate);
 301                 } else
 302                         return SR_ERR;
 303                 break;
 304         default:
 305                 return SR_ERR_ARG;
 306         }
 307
 308         return SR_OK;
 309 }
 310
 311 static int config_set(int id, const void *value, const struct sr_dev_inst *sdi)
 312 {
 313         struct dev_context *devc;
 314
 315         if (!(devc = sdi->priv)) {
 316                 sr_err("%s: sdi->priv was NULL.", __func__);
 317                 return SR_ERR_BUG;
 318         }
 319
 320         switch (id) {
 321         case SR_CONF_SAMPLERATE:
 322                 if (set_samplerate(sdi, *(const uint64_t *)value) == SR_ERR) {
 323                         sr_err("%s: setting samplerate failed.", __func__);
 324                         return SR_ERR;
 325                 }
 326                 sr_dbg("SAMPLERATE = %" PRIu64, devc->cur_samplerate);
 327                 break;
 328         case SR_CONF_LIMIT_MSEC:
 329                 if (*(const uint64_t *)value == 0) {
 330                         sr_err("%s: LIMIT_MSEC can't be 0.", __func__);
 331                         return SR_ERR;
 332                 }
 333                 devc->limit_msec = *(const uint64_t *)value;
 334                 sr_dbg("LIMIT_MSEC = %" PRIu64, devc->limit_msec);
 335                 break;
 336         case SR_CONF_LIMIT_SAMPLES:
 337                 if (*(const uint64_t *)value < MIN_NUM_SAMPLES) {
 338                         sr_err("%s: LIMIT_SAMPLES too small.", __func__);
 339                         return SR_ERR;
 340                 }
 341                 devc->limit_samples = *(const uint64_t *)value;
 342                 sr_dbg("LIMIT_SAMPLES = %" PRIu64, devc->limit_samples);
 343                 break;
 344         default:
 345                 /* Unknown capability, return SR_ERR. */
 346                 sr_err("%s: Unknown capability: %d.", __func__, id);
 347                 return SR_ERR;
 348                 break;
 349         }
 350
 351         return SR_OK;
 352 }
 353
 354 static int config_list(int key, const void **data, const struct sr_dev_inst *sdi)
 355 {
 356
 357         (void)sdi;
 358
 359         switch (key) {
 360         case SR_CONF_DEVICE_OPTIONS:
 361                 *data = hwcaps;
 362                 break;
 363         case SR_CONF_SAMPLERATE:
 364                 fill_supported_samplerates_if_needed();
 365                 *data = &samplerates;
 366                 break;
 367         case SR_CONF_TRIGGER_TYPE:
 368                 *data = (char *)TRIGGER_TYPE;
 369                 break;
 370         default:
 371                 return SR_ERR_ARG;
 372         }
 373
 374         return SR_OK;
 375 }
 376
 377 static int receive_data(int fd, int revents, void *cb_data)
 378 {
 379         int i, ret;
 380         struct sr_dev_inst *sdi;
 381         struct dev_context *devc;
 382
 383         (void)fd;
 384         (void)revents;
 385
 386         if (!(sdi = cb_data)) {
 387                 sr_err("%s: cb_data was NULL.", __func__);
 388                 return FALSE;
 389         }
 390
 391         if (!(devc = sdi->priv)) {
 392                 sr_err("%s: sdi->priv was NULL.", __func__);
 393                 return FALSE;
 394         }
 395
 396         if (!devc->ftdic) {
 397                 sr_err("%s: devc->ftdic was NULL.", __func__);
 398                 return FALSE;
 399         }
 400
 401         /* Get one block of data. */
 402         if ((ret = la8_read_block(devc)) < 0) {
 403                 sr_err("%s: la8_read_block error: %d.", __func__, ret);
 404                 hw_dev_acquisition_stop(sdi, sdi);
 405                 return FALSE;
 406         }
 407
 408         /* We need to get exactly NUM_BLOCKS blocks (i.e. 8MB) of data. */
 409         if (devc->block_counter != (NUM_BLOCKS - 1)) {
 410                 devc->block_counter++;
 411                 return TRUE;
 412         }
 413
 414         sr_dbg("Sampling finished, sending data to session bus now.");
 415
 416         /* All data was received and demangled, send it to the session bus. */
 417         for (i = 0; i < NUM_BLOCKS; i++)
 418                 send_block_to_session_bus(devc, i);
 419
 420         hw_dev_acquisition_stop(sdi, sdi);
 421
 422         return TRUE;
 423 }
 424
 425 static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
 426                                     void *cb_data)
 427 {
 428         struct dev_context *devc;
 429         struct sr_datafeed_packet packet;
 430         struct sr_datafeed_header header;
 431         uint8_t buf[4];
 432         int bytes_written;
 433
 434         if (!(devc = sdi->priv)) {
 435                 sr_err("%s: sdi->priv was NULL.", __func__);
 436                 return SR_ERR_BUG;
 437         }
 438
 439         if (!devc->ftdic) {
 440                 sr_err("%s: devc->ftdic was NULL.", __func__);
 441                 return SR_ERR_BUG;
 442         }
 443
 444         devc->divcount = samplerate_to_divcount(devc->cur_samplerate);
 445         if (devc->divcount == 0xff) {
 446                 sr_err("%s: Invalid divcount/samplerate.", __func__);
 447                 return SR_ERR;
 448         }
 449
 450         if (configure_probes(sdi) != SR_OK) {
 451                 sr_err("Failed to configure probes.");
 452                 return SR_ERR;
 453         }
 454
 455         sr_dbg("Starting acquisition.");
 456
 457         /* Fill acquisition parameters into buf[]. */
 458         buf[0] = devc->divcount;
 459         buf[1] = 0xff; /* This byte must always be 0xff. */
 460         buf[2] = devc->trigger_pattern;
 461         buf[3] = devc->trigger_mask;
 462
 463         /* Start acquisition. */
 464         bytes_written = la8_write(devc, buf, 4);
 465
 466         if (bytes_written < 0) {
 467                 sr_err("Acquisition failed to start: %d.", bytes_written);
 468                 return SR_ERR;
 469         } else if (bytes_written != 4) {
 470                 sr_err("Acquisition failed to start: %d.", bytes_written);
 471                 return SR_ERR;
 472         }
 473
 474         sr_dbg("Acquisition started successfully.");
 475
 476         devc->session_dev_id = cb_data;
 477
 478         /* Send header packet to the session bus. */
 479         sr_dbg("Sending SR_DF_HEADER.");
 480         packet.type = SR_DF_HEADER;
 481         packet.payload = &header;
 482         header.feed_version = 1;
 483         gettimeofday(&header.starttime, NULL);
 484         sr_session_send(devc->session_dev_id, &packet);
 485
 486         /* Time when we should be done (for detecting trigger timeouts). */
 487         devc->done = (devc->divcount + 1) * 0.08388608 + time(NULL)
 488                         + devc->trigger_timeout;
 489         devc->block_counter = 0;
 490         devc->trigger_found = 0;
 491
 492         /* Hook up a dummy handler to receive data from the LA8. */
 493         sr_source_add(-1, G_IO_IN, 0, receive_data, (void *)sdi);
 494
 495         return SR_OK;
 496 }
 497
 498 static int hw_dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
 499 {
 500         struct sr_datafeed_packet packet;
 501
 502         (void)sdi;
 503
 504         sr_dbg("Stopping acquisition.");
 505         sr_source_remove(-1);
 506
 507         /* Send end packet to the session bus. */
 508         sr_dbg("Sending SR_DF_END.");
 509         packet.type = SR_DF_END;
 510         sr_session_send(cb_data, &packet);
 511
 512         return SR_OK;
 513 }
 514
 515 SR_PRIV struct sr_dev_driver chronovu_la8_driver_info = {
 516         .name = "chronovu-la8",
 517         .longname = "ChronoVu LA8",
 518         .api_version = 1,
 519         .init = hw_init,
 520         .cleanup = hw_cleanup,
 521         .scan = hw_scan,
 522         .dev_list = hw_dev_list,
 523         .dev_clear = clear_instances,
 524         .config_get = config_get,
 525         .config_set = config_set,
 526         .config_list = config_list,
 527         .dev_open = hw_dev_open,
 528         .dev_close = hw_dev_close,
 529         .dev_acquisition_start = hw_dev_acquisition_start,
 530         .dev_acquisition_stop = hw_dev_acquisition_stop,
 531         .priv = NULL,
 532 };